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
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
142 if ((SSize_t)size < 0)
143 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146 #ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
155 PERL_ALLOC_CHECK(ptr);
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
163 PoisonNew(((char *)ptr), size, char);
166 #ifdef PERL_TRACK_MEMPOOL
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
172 maybe_protect_rw(header->next);
173 header->next->prev = header;
174 maybe_protect_ro(header->next);
175 # ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
191 #ifndef ALWAYS_NEED_THX
203 /* paranoid version of system's realloc() */
206 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
208 #ifdef ALWAYS_NEED_THX
212 #ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
217 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
218 Malloc_t PerlMem_realloc();
219 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
226 ptr = safesysmalloc(size);
230 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
231 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
233 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
235 struct perl_memory_debug_header *const header
236 = (struct perl_memory_debug_header *)where;
238 # ifdef PERL_TRACK_MEMPOOL
239 if (header->interpreter != aTHX) {
240 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
241 header->interpreter, aTHX);
243 assert(header->next->prev == header);
244 assert(header->prev->next == header);
246 if (header->size > size) {
247 const MEM_SIZE freed_up = header->size - size;
248 char *start_of_freed = ((char *)where) + size;
249 PoisonFree(start_of_freed, freed_up, char);
259 if ((SSize_t)size < 0)
260 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
262 #ifdef PERL_DEBUG_READONLY_COW
263 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
264 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
265 perror("mmap failed");
268 Copy(where,ptr,oldsize < size ? oldsize : size,char);
269 if (munmap(where, oldsize)) {
270 perror("munmap failed");
274 ptr = (Malloc_t)PerlMem_realloc(where,size);
276 PERL_ALLOC_CHECK(ptr);
278 /* MUST do this fixup first, before doing ANYTHING else, as anything else
279 might allocate memory/free/move memory, and until we do the fixup, it
280 may well be chasing (and writing to) free memory. */
282 #ifdef PERL_TRACK_MEMPOOL
283 struct perl_memory_debug_header *const header
284 = (struct perl_memory_debug_header *)ptr;
287 if (header->size < size) {
288 const MEM_SIZE fresh = size - header->size;
289 char *start_of_fresh = ((char *)ptr) + size;
290 PoisonNew(start_of_fresh, fresh, char);
294 maybe_protect_rw(header->next);
295 header->next->prev = header;
296 maybe_protect_ro(header->next);
297 maybe_protect_rw(header->prev);
298 header->prev->next = header;
299 maybe_protect_ro(header->prev);
301 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
304 /* In particular, must do that fixup above before logging anything via
305 *printf(), as it can reallocate memory, which can cause SEGVs. */
307 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
308 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
315 #ifndef ALWAYS_NEED_THX
328 /* safe version of system's free() */
331 Perl_safesysfree(Malloc_t where)
333 #ifdef ALWAYS_NEED_THX
336 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
339 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
341 struct perl_memory_debug_header *const header
342 = (struct perl_memory_debug_header *)where_intrn;
345 const MEM_SIZE size = header->size;
347 # ifdef PERL_TRACK_MEMPOOL
348 if (header->interpreter != aTHX) {
349 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
350 header->interpreter, aTHX);
353 Perl_croak_nocontext("panic: duplicate free");
356 Perl_croak_nocontext("panic: bad free, header->next==NULL");
357 if (header->next->prev != header || header->prev->next != header) {
358 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
359 "header=%p, ->prev->next=%p",
360 header->next->prev, header,
363 /* Unlink us from the chain. */
364 maybe_protect_rw(header->next);
365 header->next->prev = header->prev;
366 maybe_protect_ro(header->next);
367 maybe_protect_rw(header->prev);
368 header->prev->next = header->next;
369 maybe_protect_ro(header->prev);
370 maybe_protect_rw(header);
372 PoisonNew(where_intrn, size, char);
374 /* Trigger the duplicate free warning. */
377 # ifdef PERL_DEBUG_READONLY_COW
378 if (munmap(where_intrn, size)) {
379 perror("munmap failed");
385 Malloc_t where_intrn = where;
387 #ifndef PERL_DEBUG_READONLY_COW
388 PerlMem_free(where_intrn);
393 /* safe version of system's calloc() */
396 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
398 #ifdef ALWAYS_NEED_THX
402 #if defined(USE_MDH) || defined(DEBUGGING)
403 MEM_SIZE total_size = 0;
406 /* Even though calloc() for zero bytes is strange, be robust. */
407 if (size && (count <= MEM_SIZE_MAX / size)) {
408 #if defined(USE_MDH) || defined(DEBUGGING)
409 total_size = size * count;
415 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
416 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
421 if ((SSize_t)size < 0 || (SSize_t)count < 0)
422 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
423 (UV)size, (UV)count);
425 #ifdef PERL_DEBUG_READONLY_COW
426 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
427 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
428 perror("mmap failed");
431 #elif defined(PERL_TRACK_MEMPOOL)
432 /* Have to use malloc() because we've added some space for our tracking
434 /* malloc(0) is non-portable. */
435 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
437 /* Use calloc() because it might save a memset() if the memory is fresh
438 and clean from the OS. */
440 ptr = (Malloc_t)PerlMem_calloc(count, size);
441 else /* calloc(0) is non-portable. */
442 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
444 PERL_ALLOC_CHECK(ptr);
445 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
449 struct perl_memory_debug_header *const header
450 = (struct perl_memory_debug_header *)ptr;
452 # ifndef PERL_DEBUG_READONLY_COW
453 memset((void*)ptr, 0, total_size);
455 # ifdef PERL_TRACK_MEMPOOL
456 header->interpreter = aTHX;
457 /* Link us into the list. */
458 header->prev = &PL_memory_debug_header;
459 header->next = PL_memory_debug_header.next;
460 PL_memory_debug_header.next = header;
461 maybe_protect_rw(header->next);
462 header->next->prev = header;
463 maybe_protect_ro(header->next);
464 # ifdef PERL_DEBUG_READONLY_COW
465 header->readonly = 0;
469 header->size = total_size;
471 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
477 #ifndef ALWAYS_NEED_THX
486 /* These must be defined when not using Perl's malloc for binary
491 Malloc_t Perl_malloc (MEM_SIZE nbytes)
493 #ifdef PERL_IMPLICIT_SYS
496 return (Malloc_t)PerlMem_malloc(nbytes);
499 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
501 #ifdef PERL_IMPLICIT_SYS
504 return (Malloc_t)PerlMem_calloc(elements, size);
507 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
509 #ifdef PERL_IMPLICIT_SYS
512 return (Malloc_t)PerlMem_realloc(where, nbytes);
515 Free_t Perl_mfree (Malloc_t where)
517 #ifdef PERL_IMPLICIT_SYS
525 /* copy a string up to some (non-backslashed) delimiter, if any */
528 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
532 PERL_ARGS_ASSERT_DELIMCPY;
534 for (tolen = 0; from < fromend; from++, tolen++) {
536 if (from[1] != delim) {
543 else if (*from == delim)
555 =head1 Miscellaneous Functions
557 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
559 Find the first (leftmost) occurrence of a sequence of bytes within another
560 sequence. This is the Perl version of C<strstr()>, extended to handle
561 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
562 is what the initial C<n> in the function name stands for; some systems have an
563 equivalent, C<memmem()>, but with a somewhat different API).
565 Another way of thinking about this function is finding a needle in a haystack.
566 C<big> points to the first byte in the haystack. C<big_end> points to one byte
567 beyond the final byte in the haystack. C<little> points to the first byte in
568 the needle. C<little_end> points to one byte beyond the final byte in the
569 needle. All the parameters must be non-C<NULL>.
571 The function returns C<NULL> if there is no occurrence of C<little> within
572 C<big>. If C<little> is the empty string, C<big> is returned.
574 Because this function operates at the byte level, and because of the inherent
575 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
576 needle and the haystack are strings with the same UTF-8ness, but not if the
584 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
586 PERL_ARGS_ASSERT_NINSTR;
589 return ninstr(big, bigend, little, lend);
595 const char first = *little;
597 bigend -= lend - little++;
599 while (big <= bigend) {
600 if (*big++ == first) {
601 for (x=big,s=little; s < lend; x++,s++) {
605 return (char*)(big-1);
616 =head1 Miscellaneous Functions
618 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
620 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
621 sequence of bytes within another sequence, returning C<NULL> if there is no
629 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
632 const I32 first = *little;
633 const char * const littleend = lend;
635 PERL_ARGS_ASSERT_RNINSTR;
637 if (little >= littleend)
638 return (char*)bigend;
640 big = bigend - (littleend - little++);
641 while (big >= bigbeg) {
645 for (x=big+2,s=little; s < littleend; /**/ ) {
654 return (char*)(big+1);
659 /* As a space optimization, we do not compile tables for strings of length
660 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
661 special-cased in fbm_instr().
663 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
666 =head1 Miscellaneous Functions
668 =for apidoc fbm_compile
670 Analyses the string in order to make fast searches on it using C<fbm_instr()>
671 -- the Boyer-Moore algorithm.
677 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
684 PERL_DEB( STRLEN rarest = 0 );
686 PERL_ARGS_ASSERT_FBM_COMPILE;
688 if (isGV_with_GP(sv) || SvROK(sv))
694 if (flags & FBMcf_TAIL) {
695 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
696 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
697 if (mg && mg->mg_len >= 0)
700 if (!SvPOK(sv) || SvNIOKp(sv))
701 s = (U8*)SvPV_force_mutable(sv, len);
702 else s = (U8 *)SvPV_mutable(sv, len);
703 if (len == 0) /* TAIL might be on a zero-length string. */
705 SvUPGRADE(sv, SVt_PVMG);
710 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
711 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
712 to call SvVALID_off() if the scalar was assigned to.
714 The comment itself (and "deeper magic" below) date back to
715 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
717 where the magic (presumably) was that the scalar had a BM table hidden
720 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
721 the table instead of the previous (somewhat hacky) approach of co-opting
722 the string buffer and storing it after the string. */
724 assert(!mg_find(sv, PERL_MAGIC_bm));
725 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
729 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
731 const U8 mlen = (len>255) ? 255 : (U8)len;
732 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
735 Newx(table, 256, U8);
736 memset((void*)table, mlen, 256);
737 mg->mg_ptr = (char *)table;
740 s += len - 1; /* last char */
743 if (table[*s] == mlen)
749 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
750 for (i = 0; i < len; i++) {
751 if (PL_freq[s[i]] < frequency) {
752 PERL_DEB( rarest = i );
753 frequency = PL_freq[s[i]];
756 BmUSEFUL(sv) = 100; /* Initial value */
757 if (flags & FBMcf_TAIL)
759 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
760 s[rarest], (UV)rarest));
765 =for apidoc fbm_instr
767 Returns the location of the SV in the string delimited by C<big> and
768 C<bigend> (C<bigend>) is the char following the last char).
769 It returns C<NULL> if the string can't be found. The C<sv>
770 does not have to be C<fbm_compiled>, but the search will not be as fast
775 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
776 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
777 the littlestr must be anchored to the end of bigstr (or to any \n if
780 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
781 while /abc$/ compiles to "abc\n" with SvTAIL() true.
783 A littlestr of "abc", !SvTAIL matches as /abc/;
784 a littlestr of "ab\n", SvTAIL matches as:
785 without FBMrf_MULTILINE: /ab\n?\z/
786 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
788 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
789 "If SvTAIL is actually due to \Z or \z, this gives false positives
795 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
799 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
800 STRLEN littlelen = l;
801 const I32 multiline = flags & FBMrf_MULTILINE;
803 PERL_ARGS_ASSERT_FBM_INSTR;
805 if ((STRLEN)(bigend - big) < littlelen) {
806 if ( SvTAIL(littlestr)
807 && ((STRLEN)(bigend - big) == littlelen - 1)
809 || (*big == *little &&
810 memEQ((char *)big, (char *)little, littlelen - 1))))
815 switch (littlelen) { /* Special cases for 0, 1 and 2 */
817 return (char*)big; /* Cannot be SvTAIL! */
820 if (SvTAIL(littlestr) && !multiline) /* Anchor only! */
821 /* [-1] is safe because we know that bigend != big. */
822 return (char *) (bigend - (bigend[-1] == '\n'));
824 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
827 if (SvTAIL(littlestr))
828 return (char *) bigend;
832 if (SvTAIL(littlestr) && !multiline) {
833 /* a littlestr with SvTAIL must be of the form "X\n" (where X
834 * is a single char). It is anchored, and can only match
835 * "....X\n" or "....X" */
836 if (bigend[-2] == *little && bigend[-1] == '\n')
837 return (char*)bigend - 2;
838 if (bigend[-1] == *little)
839 return (char*)bigend - 1;
844 /* memchr() is likely to be very fast, possibly using whatever
845 * hardware support is available, such as checking a whole
846 * cache line in one instruction.
847 * So for a 2 char pattern, calling memchr() is likely to be
848 * faster than running FBM, or rolling our own. The previous
849 * version of this code was roll-your-own which typically
850 * only needed to read every 2nd char, which was good back in
851 * the day, but no longer.
853 unsigned char c1 = little[0];
854 unsigned char c2 = little[1];
856 /* *** for all this case, bigend points to the last char,
857 * not the trailing \0: this makes the conditions slightly
863 /* do a quick test for c1 before calling memchr();
864 * this avoids the expensive fn call overhead when
865 * there are lots of c1's */
866 if (LIKELY(*s != c1)) {
868 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
875 /* failed; try searching for c2 this time; that way
876 * we don't go pathologically slow when the string
877 * consists mostly of c1's or vice versa.
882 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
890 /* c1, c2 the same */
900 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
901 if (!s || s >= bigend)
908 /* failed to find 2 chars; try anchored match at end without
910 if (SvTAIL(littlestr) && bigend[0] == little[0])
911 return (char *)bigend;
916 break; /* Only lengths 0 1 and 2 have special-case code. */
919 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
920 s = bigend - littlelen;
921 if (s >= big && bigend[-1] == '\n' && *s == *little
922 /* Automatically of length > 2 */
923 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
925 return (char*)s; /* how sweet it is */
928 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
930 return (char*)s + 1; /* how sweet it is */
935 if (!SvVALID(littlestr)) {
936 /* not compiled; use Perl_ninstr() instead */
937 char * const b = ninstr((char*)big,(char*)bigend,
938 (char*)little, (char*)little + littlelen);
940 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
941 /* Chop \n from littlestr: */
942 s = bigend - littlelen + 1;
944 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
954 if (littlelen > (STRLEN)(bigend - big))
958 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
959 const unsigned char *oldlittle;
963 --littlelen; /* Last char found by table lookup */
966 little += littlelen; /* last char */
969 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
970 const unsigned char lastc = *little;
974 if ((tmp = table[*s])) {
975 /* *s != lastc; earliest position it could match now is
976 * tmp slots further on */
977 if ((s += tmp) >= bigend)
979 if (LIKELY(*s != lastc)) {
981 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
991 /* hand-rolled strncmp(): less expensive than calling the
992 * real function (maybe???) */
994 unsigned char * const olds = s;
999 if (*--s == *--little)
1001 s = olds + 1; /* here we pay the price for failure */
1003 if (s < bigend) /* fake up continue to outer loop */
1012 && SvTAIL(littlestr)
1013 && memEQ((char *)(bigend - littlelen),
1014 (char *)(oldlittle - littlelen), littlelen) )
1015 return (char*)bigend - littlelen;
1024 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1026 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
1027 match themselves and their opposite case counterparts. Non-cased and non-ASCII
1028 range bytes match only themselves.
1035 Perl_foldEQ(const char *s1, const char *s2, I32 len)
1037 const U8 *a = (const U8 *)s1;
1038 const U8 *b = (const U8 *)s2;
1040 PERL_ARGS_ASSERT_FOLDEQ;
1045 if (*a != *b && *a != PL_fold[*b])
1052 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
1054 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
1055 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
1056 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
1057 * does it check that the strings each have at least 'len' characters */
1059 const U8 *a = (const U8 *)s1;
1060 const U8 *b = (const U8 *)s2;
1062 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
1067 if (*a != *b && *a != PL_fold_latin1[*b]) {
1076 =for apidoc foldEQ_locale
1078 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1079 same case-insensitively in the current locale; false otherwise.
1085 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
1088 const U8 *a = (const U8 *)s1;
1089 const U8 *b = (const U8 *)s2;
1091 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1096 if (*a != *b && *a != PL_fold_locale[*b])
1103 /* copy a string to a safe spot */
1106 =head1 Memory Management
1110 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1111 string which is a duplicate of C<pv>. The size of the string is
1112 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1113 characters and must have a trailing C<NUL>. The memory allocated for the new
1114 string can be freed with the C<Safefree()> function.
1116 On some platforms, Windows for example, all allocated memory owned by a thread
1117 is deallocated when that thread ends. So if you need that not to happen, you
1118 need to use the shared memory functions, such as C<L</savesharedpv>>.
1124 Perl_savepv(pTHX_ const char *pv)
1126 PERL_UNUSED_CONTEXT;
1131 const STRLEN pvlen = strlen(pv)+1;
1132 Newx(newaddr, pvlen, char);
1133 return (char*)memcpy(newaddr, pv, pvlen);
1137 /* same thing but with a known length */
1142 Perl's version of what C<strndup()> would be if it existed. Returns a
1143 pointer to a newly allocated string which is a duplicate of the first
1144 C<len> bytes from C<pv>, plus a trailing
1145 C<NUL> byte. The memory allocated for
1146 the new string can be freed with the C<Safefree()> function.
1148 On some platforms, Windows for example, all allocated memory owned by a thread
1149 is deallocated when that thread ends. So if you need that not to happen, you
1150 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1156 Perl_savepvn(pTHX_ const char *pv, I32 len)
1159 PERL_UNUSED_CONTEXT;
1163 Newx(newaddr,len+1,char);
1164 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1166 /* might not be null terminated */
1167 newaddr[len] = '\0';
1168 return (char *) CopyD(pv,newaddr,len,char);
1171 return (char *) ZeroD(newaddr,len+1,char);
1176 =for apidoc savesharedpv
1178 A version of C<savepv()> which allocates the duplicate string in memory
1179 which is shared between threads.
1184 Perl_savesharedpv(pTHX_ const char *pv)
1189 PERL_UNUSED_CONTEXT;
1194 pvlen = strlen(pv)+1;
1195 newaddr = (char*)PerlMemShared_malloc(pvlen);
1199 return (char*)memcpy(newaddr, pv, pvlen);
1203 =for apidoc savesharedpvn
1205 A version of C<savepvn()> which allocates the duplicate string in memory
1206 which is shared between threads. (With the specific difference that a C<NULL>
1207 pointer is not acceptable)
1212 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1214 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1216 PERL_UNUSED_CONTEXT;
1217 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1222 newaddr[len] = '\0';
1223 return (char*)memcpy(newaddr, pv, len);
1227 =for apidoc savesvpv
1229 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1230 the passed in SV using C<SvPV()>
1232 On some platforms, Windows for example, all allocated memory owned by a thread
1233 is deallocated when that thread ends. So if you need that not to happen, you
1234 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1240 Perl_savesvpv(pTHX_ SV *sv)
1243 const char * const pv = SvPV_const(sv, len);
1246 PERL_ARGS_ASSERT_SAVESVPV;
1249 Newx(newaddr,len,char);
1250 return (char *) CopyD(pv,newaddr,len,char);
1254 =for apidoc savesharedsvpv
1256 A version of C<savesharedpv()> which allocates the duplicate string in
1257 memory which is shared between threads.
1263 Perl_savesharedsvpv(pTHX_ SV *sv)
1266 const char * const pv = SvPV_const(sv, len);
1268 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1270 return savesharedpvn(pv, len);
1273 /* the SV for Perl_form() and mess() is not kept in an arena */
1281 if (PL_phase != PERL_PHASE_DESTRUCT)
1282 return newSVpvs_flags("", SVs_TEMP);
1287 /* Create as PVMG now, to avoid any upgrading later */
1289 Newxz(any, 1, XPVMG);
1290 SvFLAGS(sv) = SVt_PVMG;
1291 SvANY(sv) = (void*)any;
1293 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1298 #if defined(PERL_IMPLICIT_CONTEXT)
1300 Perl_form_nocontext(const char* pat, ...)
1305 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1306 va_start(args, pat);
1307 retval = vform(pat, &args);
1311 #endif /* PERL_IMPLICIT_CONTEXT */
1314 =head1 Miscellaneous Functions
1317 Takes a sprintf-style format pattern and conventional
1318 (non-SV) arguments and returns the formatted string.
1320 (char *) Perl_form(pTHX_ const char* pat, ...)
1322 can be used any place a string (char *) is required:
1324 char * s = Perl_form("%d.%d",major,minor);
1326 Uses a single private buffer so if you want to format several strings you
1327 must explicitly copy the earlier strings away (and free the copies when you
1334 Perl_form(pTHX_ const char* pat, ...)
1338 PERL_ARGS_ASSERT_FORM;
1339 va_start(args, pat);
1340 retval = vform(pat, &args);
1346 Perl_vform(pTHX_ const char *pat, va_list *args)
1348 SV * const sv = mess_alloc();
1349 PERL_ARGS_ASSERT_VFORM;
1350 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1355 =for apidoc Am|SV *|mess|const char *pat|...
1357 Take a sprintf-style format pattern and argument list. These are used to
1358 generate a string message. If the message does not end with a newline,
1359 then it will be extended with some indication of the current location
1360 in the code, as described for L</mess_sv>.
1362 Normally, the resulting message is returned in a new mortal SV.
1363 During global destruction a single SV may be shared between uses of
1369 #if defined(PERL_IMPLICIT_CONTEXT)
1371 Perl_mess_nocontext(const char *pat, ...)
1376 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1377 va_start(args, pat);
1378 retval = vmess(pat, &args);
1382 #endif /* PERL_IMPLICIT_CONTEXT */
1385 Perl_mess(pTHX_ const char *pat, ...)
1389 PERL_ARGS_ASSERT_MESS;
1390 va_start(args, pat);
1391 retval = vmess(pat, &args);
1397 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1400 /* Look for curop starting from o. cop is the last COP we've seen. */
1401 /* opnext means that curop is actually the ->op_next of the op we are
1404 PERL_ARGS_ASSERT_CLOSEST_COP;
1406 if (!o || !curop || (
1407 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1411 if (o->op_flags & OPf_KIDS) {
1413 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1416 /* If the OP_NEXTSTATE has been optimised away we can still use it
1417 * the get the file and line number. */
1419 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1420 cop = (const COP *)kid;
1422 /* Keep searching, and return when we've found something. */
1424 new_cop = closest_cop(cop, kid, curop, opnext);
1430 /* Nothing found. */
1436 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1438 Expands a message, intended for the user, to include an indication of
1439 the current location in the code, if the message does not already appear
1442 C<basemsg> is the initial message or object. If it is a reference, it
1443 will be used as-is and will be the result of this function. Otherwise it
1444 is used as a string, and if it already ends with a newline, it is taken
1445 to be complete, and the result of this function will be the same string.
1446 If the message does not end with a newline, then a segment such as C<at
1447 foo.pl line 37> will be appended, and possibly other clauses indicating
1448 the current state of execution. The resulting message will end with a
1451 Normally, the resulting message is returned in a new mortal SV.
1452 During global destruction a single SV may be shared between uses of this
1453 function. If C<consume> is true, then the function is permitted (but not
1454 required) to modify and return C<basemsg> instead of allocating a new SV.
1460 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1464 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1468 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1469 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1470 && grok_atoUV(ws, &wi, NULL)
1471 && wi <= PERL_INT_MAX
1473 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1478 PERL_ARGS_ASSERT_MESS_SV;
1480 if (SvROK(basemsg)) {
1486 sv_setsv(sv, basemsg);
1491 if (SvPOK(basemsg) && consume) {
1496 sv_copypv(sv, basemsg);
1499 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1501 * Try and find the file and line for PL_op. This will usually be
1502 * PL_curcop, but it might be a cop that has been optimised away. We
1503 * can try to find such a cop by searching through the optree starting
1504 * from the sibling of PL_curcop.
1508 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1513 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1514 OutCopFILE(cop), (IV)CopLINE(cop));
1515 /* Seems that GvIO() can be untrustworthy during global destruction. */
1516 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1517 && IoLINES(GvIOp(PL_last_in_gv)))
1520 const bool line_mode = (RsSIMPLE(PL_rs) &&
1521 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1522 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1523 SVfARG(PL_last_in_gv == PL_argvgv
1525 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1526 line_mode ? "line" : "chunk",
1527 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1529 if (PL_phase == PERL_PHASE_DESTRUCT)
1530 sv_catpvs(sv, " during global destruction");
1531 sv_catpvs(sv, ".\n");
1537 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1539 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1540 argument list, respectively. These are used to generate a string message. If
1542 message does not end with a newline, then it will be extended with
1543 some indication of the current location in the code, as described for
1546 Normally, the resulting message is returned in a new mortal SV.
1547 During global destruction a single SV may be shared between uses of
1554 Perl_vmess(pTHX_ const char *pat, va_list *args)
1556 SV * const sv = mess_alloc();
1558 PERL_ARGS_ASSERT_VMESS;
1560 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1561 return mess_sv(sv, 1);
1565 Perl_write_to_stderr(pTHX_ SV* msv)
1570 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1572 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1573 && (io = GvIO(PL_stderrgv))
1574 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1575 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1576 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1578 PerlIO * const serr = Perl_error_log;
1580 do_print(msv, serr);
1581 (void)PerlIO_flush(serr);
1586 =head1 Warning and Dieing
1589 /* Common code used in dieing and warning */
1592 S_with_queued_errors(pTHX_ SV *ex)
1594 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1595 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1596 sv_catsv(PL_errors, ex);
1597 ex = sv_mortalcopy(PL_errors);
1598 SvCUR_set(PL_errors, 0);
1604 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1609 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1610 /* sv_2cv might call Perl_croak() or Perl_warner() */
1611 SV * const oldhook = *hook;
1619 cv = sv_2cv(oldhook, &stash, &gv, 0);
1621 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1631 exarg = newSVsv(ex);
1632 SvREADONLY_on(exarg);
1635 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1639 call_sv(MUTABLE_SV(cv), G_DISCARD);
1648 =for apidoc Am|OP *|die_sv|SV *baseex
1650 Behaves the same as L</croak_sv>, except for the return type.
1651 It should be used only where the C<OP *> return type is required.
1652 The function never actually returns.
1658 # pragma warning( push )
1659 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1660 __declspec(noreturn) has non-void return type */
1661 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1662 __declspec(noreturn) has a return statement */
1665 Perl_die_sv(pTHX_ SV *baseex)
1667 PERL_ARGS_ASSERT_DIE_SV;
1670 NORETURN_FUNCTION_END;
1673 # pragma warning( pop )
1677 =for apidoc Am|OP *|die|const char *pat|...
1679 Behaves the same as L</croak>, except for the return type.
1680 It should be used only where the C<OP *> return type is required.
1681 The function never actually returns.
1686 #if defined(PERL_IMPLICIT_CONTEXT)
1688 # pragma warning( push )
1689 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1690 __declspec(noreturn) has non-void return type */
1691 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1692 __declspec(noreturn) has a return statement */
1695 Perl_die_nocontext(const char* pat, ...)
1699 va_start(args, pat);
1701 NOT_REACHED; /* NOTREACHED */
1703 NORETURN_FUNCTION_END;
1706 # pragma warning( pop )
1708 #endif /* PERL_IMPLICIT_CONTEXT */
1711 # pragma warning( push )
1712 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1713 __declspec(noreturn) has non-void return type */
1714 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1715 __declspec(noreturn) has a return statement */
1718 Perl_die(pTHX_ const char* pat, ...)
1721 va_start(args, pat);
1723 NOT_REACHED; /* NOTREACHED */
1725 NORETURN_FUNCTION_END;
1728 # pragma warning( pop )
1732 =for apidoc Am|void|croak_sv|SV *baseex
1734 This is an XS interface to Perl's C<die> function.
1736 C<baseex> is the error message or object. If it is a reference, it
1737 will be used as-is. Otherwise it is used as a string, and if it does
1738 not end with a newline then it will be extended with some indication of
1739 the current location in the code, as described for L</mess_sv>.
1741 The error message or object will be used as an exception, by default
1742 returning control to the nearest enclosing C<eval>, but subject to
1743 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1744 function never returns normally.
1746 To die with a simple string message, the L</croak> function may be
1753 Perl_croak_sv(pTHX_ SV *baseex)
1755 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1756 PERL_ARGS_ASSERT_CROAK_SV;
1757 invoke_exception_hook(ex, FALSE);
1762 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1764 This is an XS interface to Perl's C<die> function.
1766 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1767 argument list. These are used to generate a string message. If the
1768 message does not end with a newline, then it will be extended with
1769 some indication of the current location in the code, as described for
1772 The error message will be used as an exception, by default
1773 returning control to the nearest enclosing C<eval>, but subject to
1774 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1775 function never returns normally.
1777 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1778 (C<$@>) will be used as an error message or object instead of building an
1779 error message from arguments. If you want to throw a non-string object,
1780 or build an error message in an SV yourself, it is preferable to use
1781 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1787 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1789 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1790 invoke_exception_hook(ex, FALSE);
1795 =for apidoc Am|void|croak|const char *pat|...
1797 This is an XS interface to Perl's C<die> function.
1799 Take a sprintf-style format pattern and argument list. These are used to
1800 generate a string message. If the message does not end with a newline,
1801 then it will be extended with some indication of the current location
1802 in the code, as described for L</mess_sv>.
1804 The error message will be used as an exception, by default
1805 returning control to the nearest enclosing C<eval>, but subject to
1806 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1807 function never returns normally.
1809 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1810 (C<$@>) will be used as an error message or object instead of building an
1811 error message from arguments. If you want to throw a non-string object,
1812 or build an error message in an SV yourself, it is preferable to use
1813 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1818 #if defined(PERL_IMPLICIT_CONTEXT)
1820 Perl_croak_nocontext(const char *pat, ...)
1824 va_start(args, pat);
1826 NOT_REACHED; /* NOTREACHED */
1829 #endif /* PERL_IMPLICIT_CONTEXT */
1832 Perl_croak(pTHX_ const char *pat, ...)
1835 va_start(args, pat);
1837 NOT_REACHED; /* NOTREACHED */
1842 =for apidoc Am|void|croak_no_modify
1844 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1845 terser object code than using C<Perl_croak>. Less code used on exception code
1846 paths reduces CPU cache pressure.
1852 Perl_croak_no_modify(void)
1854 Perl_croak_nocontext( "%s", PL_no_modify);
1857 /* does not return, used in util.c perlio.c and win32.c
1858 This is typically called when malloc returns NULL.
1861 Perl_croak_no_mem(void)
1865 int fd = PerlIO_fileno(Perl_error_log);
1867 SETERRNO(EBADF,RMS_IFI);
1869 /* Can't use PerlIO to write as it allocates memory */
1870 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1875 /* does not return, used only in POPSTACK */
1877 Perl_croak_popstack(void)
1880 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1885 =for apidoc Am|void|warn_sv|SV *baseex
1887 This is an XS interface to Perl's C<warn> function.
1889 C<baseex> is the error message or object. If it is a reference, it
1890 will be used as-is. Otherwise it is used as a string, and if it does
1891 not end with a newline then it will be extended with some indication of
1892 the current location in the code, as described for L</mess_sv>.
1894 The error message or object will by default be written to standard error,
1895 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1897 To warn with a simple string message, the L</warn> function may be
1904 Perl_warn_sv(pTHX_ SV *baseex)
1906 SV *ex = mess_sv(baseex, 0);
1907 PERL_ARGS_ASSERT_WARN_SV;
1908 if (!invoke_exception_hook(ex, TRUE))
1909 write_to_stderr(ex);
1913 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1915 This is an XS interface to Perl's C<warn> function.
1917 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1918 argument list. These are used to generate a string message. If the
1919 message does not end with a newline, then it will be extended with
1920 some indication of the current location in the code, as described for
1923 The error message or object will by default be written to standard error,
1924 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1926 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1932 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1934 SV *ex = vmess(pat, args);
1935 PERL_ARGS_ASSERT_VWARN;
1936 if (!invoke_exception_hook(ex, TRUE))
1937 write_to_stderr(ex);
1941 =for apidoc Am|void|warn|const char *pat|...
1943 This is an XS interface to Perl's C<warn> function.
1945 Take a sprintf-style format pattern and argument list. These are used to
1946 generate a string message. If the message does not end with a newline,
1947 then it will be extended with some indication of the current location
1948 in the code, as described for L</mess_sv>.
1950 The error message or object will by default be written to standard error,
1951 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1953 Unlike with L</croak>, C<pat> is not permitted to be null.
1958 #if defined(PERL_IMPLICIT_CONTEXT)
1960 Perl_warn_nocontext(const char *pat, ...)
1964 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1965 va_start(args, pat);
1969 #endif /* PERL_IMPLICIT_CONTEXT */
1972 Perl_warn(pTHX_ const char *pat, ...)
1975 PERL_ARGS_ASSERT_WARN;
1976 va_start(args, pat);
1981 #if defined(PERL_IMPLICIT_CONTEXT)
1983 Perl_warner_nocontext(U32 err, const char *pat, ...)
1987 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1988 va_start(args, pat);
1989 vwarner(err, pat, &args);
1992 #endif /* PERL_IMPLICIT_CONTEXT */
1995 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1997 PERL_ARGS_ASSERT_CK_WARNER_D;
1999 if (Perl_ckwarn_d(aTHX_ err)) {
2001 va_start(args, pat);
2002 vwarner(err, pat, &args);
2008 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2010 PERL_ARGS_ASSERT_CK_WARNER;
2012 if (Perl_ckwarn(aTHX_ err)) {
2014 va_start(args, pat);
2015 vwarner(err, pat, &args);
2021 Perl_warner(pTHX_ U32 err, const char* pat,...)
2024 PERL_ARGS_ASSERT_WARNER;
2025 va_start(args, pat);
2026 vwarner(err, pat, &args);
2031 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2034 PERL_ARGS_ASSERT_VWARNER;
2036 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2037 !(PL_in_eval & EVAL_KEEPERR)
2039 SV * const msv = vmess(pat, args);
2041 if (PL_parser && PL_parser->error_count) {
2045 invoke_exception_hook(msv, FALSE);
2050 Perl_vwarn(aTHX_ pat, args);
2054 /* implements the ckWARN? macros */
2057 Perl_ckwarn(pTHX_ U32 w)
2059 /* If lexical warnings have not been set, use $^W. */
2061 return PL_dowarn & G_WARN_ON;
2063 return ckwarn_common(w);
2066 /* implements the ckWARN?_d macro */
2069 Perl_ckwarn_d(pTHX_ U32 w)
2071 /* If lexical warnings have not been set then default classes warn. */
2075 return ckwarn_common(w);
2079 S_ckwarn_common(pTHX_ U32 w)
2081 if (PL_curcop->cop_warnings == pWARN_ALL)
2084 if (PL_curcop->cop_warnings == pWARN_NONE)
2087 /* Check the assumption that at least the first slot is non-zero. */
2088 assert(unpackWARN1(w));
2090 /* Check the assumption that it is valid to stop as soon as a zero slot is
2092 if (!unpackWARN2(w)) {
2093 assert(!unpackWARN3(w));
2094 assert(!unpackWARN4(w));
2095 } else if (!unpackWARN3(w)) {
2096 assert(!unpackWARN4(w));
2099 /* Right, dealt with all the special cases, which are implemented as non-
2100 pointers, so there is a pointer to a real warnings mask. */
2102 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2104 } while (w >>= WARNshift);
2109 /* Set buffer=NULL to get a new one. */
2111 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2113 const MEM_SIZE len_wanted =
2114 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2115 PERL_UNUSED_CONTEXT;
2116 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2119 (specialWARN(buffer) ?
2120 PerlMemShared_malloc(len_wanted) :
2121 PerlMemShared_realloc(buffer, len_wanted));
2123 Copy(bits, (buffer + 1), size, char);
2124 if (size < WARNsize)
2125 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2129 /* since we've already done strlen() for both nam and val
2130 * we can use that info to make things faster than
2131 * sprintf(s, "%s=%s", nam, val)
2133 #define my_setenv_format(s, nam, nlen, val, vlen) \
2134 Copy(nam, s, nlen, char); \
2136 Copy(val, s+(nlen+1), vlen, char); \
2137 *(s+(nlen+1+vlen)) = '\0'
2139 #ifdef USE_ENVIRON_ARRAY
2140 /* VMS' my_setenv() is in vms.c */
2141 #if !defined(WIN32) && !defined(NETWARE)
2143 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2147 amigaos4_obtain_environ(__FUNCTION__);
2150 /* only parent thread can modify process environment */
2151 if (PL_curinterp == aTHX)
2154 #ifndef PERL_USE_SAFE_PUTENV
2155 if (!PL_use_safe_putenv) {
2156 /* most putenv()s leak, so we manipulate environ directly */
2158 const I32 len = strlen(nam);
2161 /* where does it go? */
2162 for (i = 0; environ[i]; i++) {
2163 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2167 if (environ == PL_origenviron) { /* need we copy environment? */
2173 while (environ[max])
2175 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2176 for (j=0; j<max; j++) { /* copy environment */
2177 const int len = strlen(environ[j]);
2178 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2179 Copy(environ[j], tmpenv[j], len+1, char);
2182 environ = tmpenv; /* tell exec where it is now */
2185 safesysfree(environ[i]);
2186 while (environ[i]) {
2187 environ[i] = environ[i+1];
2196 if (!environ[i]) { /* does not exist yet */
2197 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2198 environ[i+1] = NULL; /* make sure it's null terminated */
2201 safesysfree(environ[i]);
2205 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2206 /* all that work just for this */
2207 my_setenv_format(environ[i], nam, nlen, val, vlen);
2210 /* This next branch should only be called #if defined(HAS_SETENV), but
2211 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2212 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2214 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2215 # if defined(HAS_UNSETENV)
2217 (void)unsetenv(nam);
2219 (void)setenv(nam, val, 1);
2221 # else /* ! HAS_UNSETENV */
2222 (void)setenv(nam, val, 1);
2223 # endif /* HAS_UNSETENV */
2225 # if defined(HAS_UNSETENV)
2227 if (environ) /* old glibc can crash with null environ */
2228 (void)unsetenv(nam);
2230 const int nlen = strlen(nam);
2231 const int vlen = strlen(val);
2232 char * const new_env =
2233 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2234 my_setenv_format(new_env, nam, nlen, val, vlen);
2235 (void)putenv(new_env);
2237 # else /* ! HAS_UNSETENV */
2239 const int nlen = strlen(nam);
2245 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2246 /* all that work just for this */
2247 my_setenv_format(new_env, nam, nlen, val, vlen);
2248 (void)putenv(new_env);
2249 # endif /* HAS_UNSETENV */
2250 # endif /* __CYGWIN__ */
2251 #ifndef PERL_USE_SAFE_PUTENV
2257 amigaos4_release_environ(__FUNCTION__);
2261 #else /* WIN32 || NETWARE */
2264 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2268 const int nlen = strlen(nam);
2275 Newx(envstr, nlen+vlen+2, char);
2276 my_setenv_format(envstr, nam, nlen, val, vlen);
2277 (void)PerlEnv_putenv(envstr);
2281 #endif /* WIN32 || NETWARE */
2285 #ifdef UNLINK_ALL_VERSIONS
2287 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2291 PERL_ARGS_ASSERT_UNLNK;
2293 while (PerlLIO_unlink(f) >= 0)
2295 return retries ? 0 : -1;
2299 /* this is a drop-in replacement for bcopy(), except for the return
2300 * value, which we need to be able to emulate memcpy() */
2301 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2303 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2305 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2306 bcopy(vfrom, vto, len);
2308 const unsigned char *from = (const unsigned char *)vfrom;
2309 unsigned char *to = (unsigned char *)vto;
2311 PERL_ARGS_ASSERT_MY_BCOPY;
2313 if (from - to >= 0) {
2321 *(--to) = *(--from);
2329 /* this is a drop-in replacement for memset() */
2332 Perl_my_memset(void *vloc, int ch, size_t len)
2334 unsigned char *loc = (unsigned char *)vloc;
2336 PERL_ARGS_ASSERT_MY_MEMSET;
2344 /* this is a drop-in replacement for bzero() */
2345 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2347 Perl_my_bzero(void *vloc, size_t len)
2349 unsigned char *loc = (unsigned char *)vloc;
2351 PERL_ARGS_ASSERT_MY_BZERO;
2359 /* this is a drop-in replacement for memcmp() */
2360 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2362 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2364 const U8 *a = (const U8 *)vs1;
2365 const U8 *b = (const U8 *)vs2;
2368 PERL_ARGS_ASSERT_MY_MEMCMP;
2371 if ((tmp = *a++ - *b++))
2376 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2379 /* This vsprintf replacement should generally never get used, since
2380 vsprintf was available in both System V and BSD 2.11. (There may
2381 be some cross-compilation or embedded set-ups where it is needed,
2384 If you encounter a problem in this function, it's probably a symptom
2385 that Configure failed to detect your system's vprintf() function.
2386 See the section on "item vsprintf" in the INSTALL file.
2388 This version may compile on systems with BSD-ish <stdio.h>,
2389 but probably won't on others.
2392 #ifdef USE_CHAR_VSPRINTF
2397 vsprintf(char *dest, const char *pat, void *args)
2401 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2402 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2403 FILE_cnt(&fakebuf) = 32767;
2405 /* These probably won't compile -- If you really need
2406 this, you'll have to figure out some other method. */
2407 fakebuf._ptr = dest;
2408 fakebuf._cnt = 32767;
2413 fakebuf._flag = _IOWRT|_IOSTRG;
2414 _doprnt(pat, args, &fakebuf); /* what a kludge */
2415 #if defined(STDIO_PTR_LVALUE)
2416 *(FILE_ptr(&fakebuf)++) = '\0';
2418 /* PerlIO has probably #defined away fputc, but we want it here. */
2420 # undef fputc /* XXX Should really restore it later */
2422 (void)fputc('\0', &fakebuf);
2424 #ifdef USE_CHAR_VSPRINTF
2427 return 0; /* perl doesn't use return value */
2431 #endif /* HAS_VPRINTF */
2434 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2436 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2444 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2446 PERL_FLUSHALL_FOR_CHILD;
2447 This = (*mode == 'w');
2451 taint_proper("Insecure %s%s", "EXEC");
2453 if (PerlProc_pipe(p) < 0)
2455 /* Try for another pipe pair for error return */
2456 if (PerlProc_pipe(pp) >= 0)
2458 while ((pid = PerlProc_fork()) < 0) {
2459 if (errno != EAGAIN) {
2460 PerlLIO_close(p[This]);
2461 PerlLIO_close(p[that]);
2463 PerlLIO_close(pp[0]);
2464 PerlLIO_close(pp[1]);
2468 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2477 /* Close parent's end of error status pipe (if any) */
2479 PerlLIO_close(pp[0]);
2480 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2481 /* Close error pipe automatically if exec works */
2482 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2486 /* Now dup our end of _the_ pipe to right position */
2487 if (p[THIS] != (*mode == 'r')) {
2488 PerlLIO_dup2(p[THIS], *mode == 'r');
2489 PerlLIO_close(p[THIS]);
2490 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2491 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2494 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2495 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2496 /* No automatic close - do it by hand */
2503 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2509 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2515 do_execfree(); /* free any memory malloced by child on fork */
2517 PerlLIO_close(pp[1]);
2518 /* Keep the lower of the two fd numbers */
2519 if (p[that] < p[This]) {
2520 PerlLIO_dup2(p[This], p[that]);
2521 PerlLIO_close(p[This]);
2525 PerlLIO_close(p[that]); /* close child's end of pipe */
2527 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2528 SvUPGRADE(sv,SVt_IV);
2530 PL_forkprocess = pid;
2531 /* If we managed to get status pipe check for exec fail */
2532 if (did_pipes && pid > 0) {
2537 while (n < sizeof(int)) {
2538 n1 = PerlLIO_read(pp[0],
2539 (void*)(((char*)&errkid)+n),
2545 PerlLIO_close(pp[0]);
2547 if (n) { /* Error */
2549 PerlLIO_close(p[This]);
2550 if (n != sizeof(int))
2551 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2553 pid2 = wait4pid(pid, &status, 0);
2554 } while (pid2 == -1 && errno == EINTR);
2555 errno = errkid; /* Propagate errno from kid */
2560 PerlLIO_close(pp[0]);
2561 return PerlIO_fdopen(p[This], mode);
2563 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2564 return my_syspopen4(aTHX_ NULL, mode, n, args);
2565 # elif defined(WIN32)
2566 return win32_popenlist(mode, n, args);
2568 Perl_croak(aTHX_ "List form of piped open not implemented");
2569 return (PerlIO *) NULL;
2574 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2575 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2577 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2583 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2587 PERL_ARGS_ASSERT_MY_POPEN;
2589 PERL_FLUSHALL_FOR_CHILD;
2592 return my_syspopen(aTHX_ cmd,mode);
2595 This = (*mode == 'w');
2597 if (doexec && TAINTING_get) {
2599 taint_proper("Insecure %s%s", "EXEC");
2601 if (PerlProc_pipe(p) < 0)
2603 if (doexec && PerlProc_pipe(pp) >= 0)
2605 while ((pid = PerlProc_fork()) < 0) {
2606 if (errno != EAGAIN) {
2607 PerlLIO_close(p[This]);
2608 PerlLIO_close(p[that]);
2610 PerlLIO_close(pp[0]);
2611 PerlLIO_close(pp[1]);
2614 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2617 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2627 PerlLIO_close(pp[0]);
2628 #if defined(HAS_FCNTL) && defined(F_SETFD)
2629 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2633 if (p[THIS] != (*mode == 'r')) {
2634 PerlLIO_dup2(p[THIS], *mode == 'r');
2635 PerlLIO_close(p[THIS]);
2636 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2637 PerlLIO_close(p[THAT]);
2640 PerlLIO_close(p[THAT]);
2643 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2650 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2655 /* may or may not use the shell */
2656 do_exec3(cmd, pp[1], did_pipes);
2659 #endif /* defined OS2 */
2661 #ifdef PERLIO_USING_CRLF
2662 /* Since we circumvent IO layers when we manipulate low-level
2663 filedescriptors directly, need to manually switch to the
2664 default, binary, low-level mode; see PerlIOBuf_open(). */
2665 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2668 #ifdef PERL_USES_PL_PIDSTATUS
2669 hv_clear(PL_pidstatus); /* we have no children */
2675 do_execfree(); /* free any memory malloced by child on vfork */
2677 PerlLIO_close(pp[1]);
2678 if (p[that] < p[This]) {
2679 PerlLIO_dup2(p[This], p[that]);
2680 PerlLIO_close(p[This]);
2684 PerlLIO_close(p[that]);
2686 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2687 SvUPGRADE(sv,SVt_IV);
2689 PL_forkprocess = pid;
2690 if (did_pipes && pid > 0) {
2695 while (n < sizeof(int)) {
2696 n1 = PerlLIO_read(pp[0],
2697 (void*)(((char*)&errkid)+n),
2703 PerlLIO_close(pp[0]);
2705 if (n) { /* Error */
2707 PerlLIO_close(p[This]);
2708 if (n != sizeof(int))
2709 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2711 pid2 = wait4pid(pid, &status, 0);
2712 } while (pid2 == -1 && errno == EINTR);
2713 errno = errkid; /* Propagate errno from kid */
2718 PerlLIO_close(pp[0]);
2719 return PerlIO_fdopen(p[This], mode);
2723 FILE *djgpp_popen();
2725 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2727 PERL_FLUSHALL_FOR_CHILD;
2728 /* Call system's popen() to get a FILE *, then import it.
2729 used 0 for 2nd parameter to PerlIO_importFILE;
2732 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2735 #if defined(__LIBCATAMOUNT__)
2737 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2744 #endif /* !DOSISH */
2746 /* this is called in parent before the fork() */
2748 Perl_atfork_lock(void)
2749 #if defined(USE_ITHREADS)
2751 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2754 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2756 PERL_TSA_ACQUIRE(PL_op_mutex)
2759 #if defined(USE_ITHREADS)
2761 /* locks must be held in locking order (if any) */
2763 MUTEX_LOCK(&PL_perlio_mutex);
2766 MUTEX_LOCK(&PL_malloc_mutex);
2772 /* this is called in both parent and child after the fork() */
2774 Perl_atfork_unlock(void)
2775 #if defined(USE_ITHREADS)
2777 PERL_TSA_RELEASE(PL_perlio_mutex)
2780 PERL_TSA_RELEASE(PL_malloc_mutex)
2782 PERL_TSA_RELEASE(PL_op_mutex)
2785 #if defined(USE_ITHREADS)
2787 /* locks must be released in same order as in atfork_lock() */
2789 MUTEX_UNLOCK(&PL_perlio_mutex);
2792 MUTEX_UNLOCK(&PL_malloc_mutex);
2801 #if defined(HAS_FORK)
2803 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2808 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2809 * handlers elsewhere in the code */
2813 #elif defined(__amigaos4__)
2814 return amigaos_fork();
2816 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2817 Perl_croak_nocontext("fork() not available");
2819 #endif /* HAS_FORK */
2824 dup2(int oldfd, int newfd)
2826 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2829 PerlLIO_close(newfd);
2830 return fcntl(oldfd, F_DUPFD, newfd);
2832 #define DUP2_MAX_FDS 256
2833 int fdtmp[DUP2_MAX_FDS];
2839 PerlLIO_close(newfd);
2840 /* good enough for low fd's... */
2841 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2842 if (fdx >= DUP2_MAX_FDS) {
2850 PerlLIO_close(fdtmp[--fdx]);
2857 #ifdef HAS_SIGACTION
2860 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2862 struct sigaction act, oact;
2866 /* only "parent" interpreter can diddle signals */
2867 if (PL_curinterp != aTHX)
2868 return (Sighandler_t) SIG_ERR;
2871 act.sa_handler = (void(*)(int))handler;
2872 sigemptyset(&act.sa_mask);
2875 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2876 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2878 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2879 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2880 act.sa_flags |= SA_NOCLDWAIT;
2882 if (sigaction(signo, &act, &oact) == -1)
2883 return (Sighandler_t) SIG_ERR;
2885 return (Sighandler_t) oact.sa_handler;
2889 Perl_rsignal_state(pTHX_ int signo)
2891 struct sigaction oact;
2892 PERL_UNUSED_CONTEXT;
2894 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2895 return (Sighandler_t) SIG_ERR;
2897 return (Sighandler_t) oact.sa_handler;
2901 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2906 struct sigaction act;
2908 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2911 /* only "parent" interpreter can diddle signals */
2912 if (PL_curinterp != aTHX)
2916 act.sa_handler = (void(*)(int))handler;
2917 sigemptyset(&act.sa_mask);
2920 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2921 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2923 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2924 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2925 act.sa_flags |= SA_NOCLDWAIT;
2927 return sigaction(signo, &act, save);
2931 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2936 PERL_UNUSED_CONTEXT;
2938 /* only "parent" interpreter can diddle signals */
2939 if (PL_curinterp != aTHX)
2943 return sigaction(signo, save, (struct sigaction *)NULL);
2946 #else /* !HAS_SIGACTION */
2949 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2951 #if defined(USE_ITHREADS) && !defined(WIN32)
2952 /* only "parent" interpreter can diddle signals */
2953 if (PL_curinterp != aTHX)
2954 return (Sighandler_t) SIG_ERR;
2957 return PerlProc_signal(signo, handler);
2968 Perl_rsignal_state(pTHX_ int signo)
2971 Sighandler_t oldsig;
2973 #if defined(USE_ITHREADS) && !defined(WIN32)
2974 /* only "parent" interpreter can diddle signals */
2975 if (PL_curinterp != aTHX)
2976 return (Sighandler_t) SIG_ERR;
2980 oldsig = PerlProc_signal(signo, sig_trap);
2981 PerlProc_signal(signo, oldsig);
2983 PerlProc_kill(PerlProc_getpid(), signo);
2988 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2990 #if defined(USE_ITHREADS) && !defined(WIN32)
2991 /* only "parent" interpreter can diddle signals */
2992 if (PL_curinterp != aTHX)
2995 *save = PerlProc_signal(signo, handler);
2996 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3000 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3002 #if defined(USE_ITHREADS) && !defined(WIN32)
3003 /* only "parent" interpreter can diddle signals */
3004 if (PL_curinterp != aTHX)
3007 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3010 #endif /* !HAS_SIGACTION */
3011 #endif /* !PERL_MICRO */
3013 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3014 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3016 Perl_my_pclose(pTHX_ PerlIO *ptr)
3024 const int fd = PerlIO_fileno(ptr);
3027 svp = av_fetch(PL_fdpid,fd,TRUE);
3028 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3032 #if defined(USE_PERLIO)
3033 /* Find out whether the refcount is low enough for us to wait for the
3034 child proc without blocking. */
3035 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3037 should_wait = pid > 0;
3041 if (pid == -1) { /* Opened by popen. */
3042 return my_syspclose(ptr);
3045 close_failed = (PerlIO_close(ptr) == EOF);
3047 if (should_wait) do {
3048 pid2 = wait4pid(pid, &status, 0);
3049 } while (pid2 == -1 && errno == EINTR);
3056 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3061 #if defined(__LIBCATAMOUNT__)
3063 Perl_my_pclose(pTHX_ PerlIO *ptr)
3068 #endif /* !DOSISH */
3070 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3072 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3075 PERL_ARGS_ASSERT_WAIT4PID;
3076 #ifdef PERL_USES_PL_PIDSTATUS
3078 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3079 waitpid() nor wait4() is available, or on OS/2, which
3080 doesn't appear to support waiting for a progress group
3081 member, so we can only treat a 0 pid as an unknown child.
3088 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3089 pid, rather than a string form. */
3090 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3091 if (svp && *svp != &PL_sv_undef) {
3092 *statusp = SvIVX(*svp);
3093 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3101 hv_iterinit(PL_pidstatus);
3102 if ((entry = hv_iternext(PL_pidstatus))) {
3103 SV * const sv = hv_iterval(PL_pidstatus,entry);
3105 const char * const spid = hv_iterkey(entry,&len);
3107 assert (len == sizeof(Pid_t));
3108 memcpy((char *)&pid, spid, len);
3109 *statusp = SvIVX(sv);
3110 /* The hash iterator is currently on this entry, so simply
3111 calling hv_delete would trigger the lazy delete, which on
3112 aggregate does more work, because next call to hv_iterinit()
3113 would spot the flag, and have to call the delete routine,
3114 while in the meantime any new entries can't re-use that
3116 hv_iterinit(PL_pidstatus);
3117 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3124 # ifdef HAS_WAITPID_RUNTIME
3125 if (!HAS_WAITPID_RUNTIME)
3128 result = PerlProc_waitpid(pid,statusp,flags);
3131 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3132 result = wait4(pid,statusp,flags,NULL);
3135 #ifdef PERL_USES_PL_PIDSTATUS
3136 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3141 Perl_croak(aTHX_ "Can't do waitpid with flags");
3143 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3144 pidgone(result,*statusp);
3150 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3153 if (result < 0 && errno == EINTR) {
3155 errno = EINTR; /* reset in case a signal handler changed $! */
3159 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3161 #ifdef PERL_USES_PL_PIDSTATUS
3163 S_pidgone(pTHX_ Pid_t pid, int status)
3167 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3168 SvUPGRADE(sv,SVt_IV);
3169 SvIV_set(sv, status);
3177 int /* Cannot prototype with I32
3179 my_syspclose(PerlIO *ptr)
3182 Perl_my_pclose(pTHX_ PerlIO *ptr)
3185 /* Needs work for PerlIO ! */
3186 FILE * const f = PerlIO_findFILE(ptr);
3187 const I32 result = pclose(f);
3188 PerlIO_releaseFILE(ptr,f);
3196 Perl_my_pclose(pTHX_ PerlIO *ptr)
3198 /* Needs work for PerlIO ! */
3199 FILE * const f = PerlIO_findFILE(ptr);
3200 I32 result = djgpp_pclose(f);
3201 result = (result << 8) & 0xff00;
3202 PerlIO_releaseFILE(ptr,f);
3207 #define PERL_REPEATCPY_LINEAR 4
3209 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3211 PERL_ARGS_ASSERT_REPEATCPY;
3216 croak_memory_wrap();
3219 memset(to, *from, count);
3222 IV items, linear, half;
3224 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3225 for (items = 0; items < linear; ++items) {
3226 const char *q = from;
3228 for (todo = len; todo > 0; todo--)
3233 while (items <= half) {
3234 IV size = items * len;
3235 memcpy(p, to, size);
3241 memcpy(p, to, (count - items) * len);
3247 Perl_same_dirent(pTHX_ const char *a, const char *b)
3249 char *fa = strrchr(a,'/');
3250 char *fb = strrchr(b,'/');
3253 SV * const tmpsv = sv_newmortal();
3255 PERL_ARGS_ASSERT_SAME_DIRENT;
3268 sv_setpvs(tmpsv, ".");
3270 sv_setpvn(tmpsv, a, fa - a);
3271 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3274 sv_setpvs(tmpsv, ".");
3276 sv_setpvn(tmpsv, b, fb - b);
3277 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3279 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3280 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3282 #endif /* !HAS_RENAME */
3285 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3286 const char *const *const search_ext, I32 flags)
3288 const char *xfound = NULL;
3289 char *xfailed = NULL;
3290 char tmpbuf[MAXPATHLEN];
3295 #if defined(DOSISH) && !defined(OS2)
3296 # define SEARCH_EXTS ".bat", ".cmd", NULL
3297 # define MAX_EXT_LEN 4
3300 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3301 # define MAX_EXT_LEN 4
3304 # define SEARCH_EXTS ".pl", ".com", NULL
3305 # define MAX_EXT_LEN 4
3307 /* additional extensions to try in each dir if scriptname not found */
3309 static const char *const exts[] = { SEARCH_EXTS };
3310 const char *const *const ext = search_ext ? search_ext : exts;
3311 int extidx = 0, i = 0;
3312 const char *curext = NULL;
3314 PERL_UNUSED_ARG(search_ext);
3315 # define MAX_EXT_LEN 0
3318 PERL_ARGS_ASSERT_FIND_SCRIPT;
3321 * If dosearch is true and if scriptname does not contain path
3322 * delimiters, search the PATH for scriptname.
3324 * If SEARCH_EXTS is also defined, will look for each
3325 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3326 * while searching the PATH.
3328 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3329 * proceeds as follows:
3330 * If DOSISH or VMSISH:
3331 * + look for ./scriptname{,.foo,.bar}
3332 * + search the PATH for scriptname{,.foo,.bar}
3335 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3336 * this will not look in '.' if it's not in the PATH)
3341 # ifdef ALWAYS_DEFTYPES
3342 len = strlen(scriptname);
3343 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3344 int idx = 0, deftypes = 1;
3347 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3350 int idx = 0, deftypes = 1;
3353 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3355 /* The first time through, just add SEARCH_EXTS to whatever we
3356 * already have, so we can check for default file types. */
3358 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3365 if ((strlen(tmpbuf) + strlen(scriptname)
3366 + MAX_EXT_LEN) >= sizeof tmpbuf)
3367 continue; /* don't search dir with too-long name */
3368 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3372 if (strEQ(scriptname, "-"))
3374 if (dosearch) { /* Look in '.' first. */
3375 const char *cur = scriptname;
3377 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3379 if (strEQ(ext[i++],curext)) {
3380 extidx = -1; /* already has an ext */
3385 DEBUG_p(PerlIO_printf(Perl_debug_log,
3386 "Looking for %s\n",cur));
3389 if (PerlLIO_stat(cur,&statbuf) >= 0
3390 && !S_ISDIR(statbuf.st_mode)) {
3399 if (cur == scriptname) {
3400 len = strlen(scriptname);
3401 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3403 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3406 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3407 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3412 if (dosearch && !strchr(scriptname, '/')
3414 && !strchr(scriptname, '\\')
3416 && (s = PerlEnv_getenv("PATH")))
3420 bufend = s + strlen(s);
3421 while (s < bufend) {
3425 && *s != ';'; len++, s++) {
3426 if (len < sizeof tmpbuf)
3429 if (len < sizeof tmpbuf)
3432 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3438 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3439 continue; /* don't search dir with too-long name */
3442 && tmpbuf[len - 1] != '/'
3443 && tmpbuf[len - 1] != '\\'
3446 tmpbuf[len++] = '/';
3447 if (len == 2 && tmpbuf[0] == '.')
3449 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3453 len = strlen(tmpbuf);
3454 if (extidx > 0) /* reset after previous loop */
3458 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3459 retval = PerlLIO_stat(tmpbuf,&statbuf);
3460 if (S_ISDIR(statbuf.st_mode)) {
3464 } while ( retval < 0 /* not there */
3465 && extidx>=0 && ext[extidx] /* try an extension? */
3466 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3471 if (S_ISREG(statbuf.st_mode)
3472 && cando(S_IRUSR,TRUE,&statbuf)
3473 #if !defined(DOSISH)
3474 && cando(S_IXUSR,TRUE,&statbuf)
3478 xfound = tmpbuf; /* bingo! */
3482 xfailed = savepv(tmpbuf);
3487 if (!xfound && !seen_dot && !xfailed &&
3488 (PerlLIO_stat(scriptname,&statbuf) < 0
3489 || S_ISDIR(statbuf.st_mode)))
3491 seen_dot = 1; /* Disable message. */
3496 if (flags & 1) { /* do or die? */
3497 /* diag_listed_as: Can't execute %s */
3498 Perl_croak(aTHX_ "Can't %s %s%s%s",
3499 (xfailed ? "execute" : "find"),
3500 (xfailed ? xfailed : scriptname),
3501 (xfailed ? "" : " on PATH"),
3502 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3507 scriptname = xfound;
3509 return (scriptname ? savepv(scriptname) : NULL);
3512 #ifndef PERL_GET_CONTEXT_DEFINED
3515 Perl_get_context(void)
3517 #if defined(USE_ITHREADS)
3519 # ifdef OLD_PTHREADS_API
3521 int error = pthread_getspecific(PL_thr_key, &t)
3523 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3526 # ifdef I_MACH_CTHREADS
3527 return (void*)cthread_data(cthread_self());
3529 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3538 Perl_set_context(void *t)
3540 #if defined(USE_ITHREADS)
3543 PERL_ARGS_ASSERT_SET_CONTEXT;
3544 #if defined(USE_ITHREADS)
3545 # ifdef I_MACH_CTHREADS
3546 cthread_set_data(cthread_self(), t);
3549 const int error = pthread_setspecific(PL_thr_key, t);
3551 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3559 #endif /* !PERL_GET_CONTEXT_DEFINED */
3561 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3565 PERL_UNUSED_CONTEXT;
3571 Perl_get_op_names(pTHX)
3573 PERL_UNUSED_CONTEXT;
3574 return (char **)PL_op_name;
3578 Perl_get_op_descs(pTHX)
3580 PERL_UNUSED_CONTEXT;
3581 return (char **)PL_op_desc;
3585 Perl_get_no_modify(pTHX)
3587 PERL_UNUSED_CONTEXT;
3588 return PL_no_modify;
3592 Perl_get_opargs(pTHX)
3594 PERL_UNUSED_CONTEXT;
3595 return (U32 *)PL_opargs;
3599 Perl_get_ppaddr(pTHX)
3602 PERL_UNUSED_CONTEXT;
3603 return (PPADDR_t*)PL_ppaddr;
3606 #ifndef HAS_GETENV_LEN
3608 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3610 char * const env_trans = PerlEnv_getenv(env_elem);
3611 PERL_UNUSED_CONTEXT;
3612 PERL_ARGS_ASSERT_GETENV_LEN;
3614 *len = strlen(env_trans);
3621 Perl_get_vtbl(pTHX_ int vtbl_id)
3623 PERL_UNUSED_CONTEXT;
3625 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3626 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3630 Perl_my_fflush_all(pTHX)
3632 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3633 return PerlIO_flush(NULL);
3635 # if defined(HAS__FWALK)
3636 extern int fflush(FILE *);
3637 /* undocumented, unprototyped, but very useful BSDism */
3638 extern void _fwalk(int (*)(FILE *));
3642 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3644 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3645 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3647 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3648 open_max = sysconf(_SC_OPEN_MAX);
3651 open_max = FOPEN_MAX;
3654 open_max = OPEN_MAX;
3665 for (i = 0; i < open_max; i++)
3666 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3667 STDIO_STREAM_ARRAY[i]._file < open_max &&
3668 STDIO_STREAM_ARRAY[i]._flag)
3669 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3673 SETERRNO(EBADF,RMS_IFI);
3680 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3682 if (ckWARN(WARN_IO)) {
3684 = gv && (isGV_with_GP(gv))
3687 const char * const direction = have == '>' ? "out" : "in";
3689 if (name && HEK_LEN(name))
3690 Perl_warner(aTHX_ packWARN(WARN_IO),
3691 "Filehandle %"HEKf" opened only for %sput",
3692 HEKfARG(name), direction);
3694 Perl_warner(aTHX_ packWARN(WARN_IO),
3695 "Filehandle opened only for %sput", direction);
3700 Perl_report_evil_fh(pTHX_ const GV *gv)
3702 const IO *io = gv ? GvIO(gv) : NULL;
3703 const PERL_BITFIELD16 op = PL_op->op_type;
3707 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3709 warn_type = WARN_CLOSED;
3713 warn_type = WARN_UNOPENED;
3716 if (ckWARN(warn_type)) {
3718 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3719 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3720 const char * const pars =
3721 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3722 const char * const func =
3724 (op == OP_READLINE || op == OP_RCATLINE
3725 ? "readline" : /* "<HANDLE>" not nice */
3726 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3728 const char * const type =
3730 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3731 ? "socket" : "filehandle");
3732 const bool have_name = name && SvCUR(name);
3733 Perl_warner(aTHX_ packWARN(warn_type),
3734 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3735 have_name ? " " : "",
3736 SVfARG(have_name ? name : &PL_sv_no));
3737 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3739 aTHX_ packWARN(warn_type),
3740 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3741 func, pars, have_name ? " " : "",
3742 SVfARG(have_name ? name : &PL_sv_no)
3747 /* To workaround core dumps from the uninitialised tm_zone we get the
3748 * system to give us a reasonable struct to copy. This fix means that
3749 * strftime uses the tm_zone and tm_gmtoff values returned by
3750 * localtime(time()). That should give the desired result most of the
3751 * time. But probably not always!
3753 * This does not address tzname aspects of NETaa14816.
3758 # ifndef STRUCT_TM_HASZONE
3759 # define STRUCT_TM_HASZONE
3763 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3764 # ifndef HAS_TM_TM_ZONE
3765 # define HAS_TM_TM_ZONE
3770 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3772 #ifdef HAS_TM_TM_ZONE
3774 const struct tm* my_tm;
3775 PERL_UNUSED_CONTEXT;
3776 PERL_ARGS_ASSERT_INIT_TM;
3778 my_tm = localtime(&now);
3780 Copy(my_tm, ptm, 1, struct tm);
3782 PERL_UNUSED_CONTEXT;
3783 PERL_ARGS_ASSERT_INIT_TM;
3784 PERL_UNUSED_ARG(ptm);
3789 * mini_mktime - normalise struct tm values without the localtime()
3790 * semantics (and overhead) of mktime().
3793 Perl_mini_mktime(struct tm *ptm)
3797 int month, mday, year, jday;
3798 int odd_cent, odd_year;
3800 PERL_ARGS_ASSERT_MINI_MKTIME;
3802 #define DAYS_PER_YEAR 365
3803 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3804 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3805 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3806 #define SECS_PER_HOUR (60*60)
3807 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3808 /* parentheses deliberately absent on these two, otherwise they don't work */
3809 #define MONTH_TO_DAYS 153/5
3810 #define DAYS_TO_MONTH 5/153
3811 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3812 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3813 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3814 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3817 * Year/day algorithm notes:
3819 * With a suitable offset for numeric value of the month, one can find
3820 * an offset into the year by considering months to have 30.6 (153/5) days,
3821 * using integer arithmetic (i.e., with truncation). To avoid too much
3822 * messing about with leap days, we consider January and February to be
3823 * the 13th and 14th month of the previous year. After that transformation,
3824 * we need the month index we use to be high by 1 from 'normal human' usage,
3825 * so the month index values we use run from 4 through 15.
3827 * Given that, and the rules for the Gregorian calendar (leap years are those
3828 * divisible by 4 unless also divisible by 100, when they must be divisible
3829 * by 400 instead), we can simply calculate the number of days since some
3830 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3831 * the days we derive from our month index, and adding in the day of the
3832 * month. The value used here is not adjusted for the actual origin which
3833 * it normally would use (1 January A.D. 1), since we're not exposing it.
3834 * We're only building the value so we can turn around and get the
3835 * normalised values for the year, month, day-of-month, and day-of-year.
3837 * For going backward, we need to bias the value we're using so that we find
3838 * the right year value. (Basically, we don't want the contribution of
3839 * March 1st to the number to apply while deriving the year). Having done
3840 * that, we 'count up' the contribution to the year number by accounting for
3841 * full quadracenturies (400-year periods) with their extra leap days, plus
3842 * the contribution from full centuries (to avoid counting in the lost leap
3843 * days), plus the contribution from full quad-years (to count in the normal
3844 * leap days), plus the leftover contribution from any non-leap years.
3845 * At this point, if we were working with an actual leap day, we'll have 0
3846 * days left over. This is also true for March 1st, however. So, we have
3847 * to special-case that result, and (earlier) keep track of the 'odd'
3848 * century and year contributions. If we got 4 extra centuries in a qcent,
3849 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3850 * Otherwise, we add back in the earlier bias we removed (the 123 from
3851 * figuring in March 1st), find the month index (integer division by 30.6),
3852 * and the remainder is the day-of-month. We then have to convert back to
3853 * 'real' months (including fixing January and February from being 14/15 in
3854 * the previous year to being in the proper year). After that, to get
3855 * tm_yday, we work with the normalised year and get a new yearday value for
3856 * January 1st, which we subtract from the yearday value we had earlier,
3857 * representing the date we've re-built. This is done from January 1
3858 * because tm_yday is 0-origin.
3860 * Since POSIX time routines are only guaranteed to work for times since the
3861 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3862 * applies Gregorian calendar rules even to dates before the 16th century
3863 * doesn't bother me. Besides, you'd need cultural context for a given
3864 * date to know whether it was Julian or Gregorian calendar, and that's
3865 * outside the scope for this routine. Since we convert back based on the
3866 * same rules we used to build the yearday, you'll only get strange results
3867 * for input which needed normalising, or for the 'odd' century years which
3868 * were leap years in the Julian calendar but not in the Gregorian one.
3869 * I can live with that.
3871 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3872 * that's still outside the scope for POSIX time manipulation, so I don't
3876 year = 1900 + ptm->tm_year;
3877 month = ptm->tm_mon;
3878 mday = ptm->tm_mday;
3884 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3885 yearday += month*MONTH_TO_DAYS + mday + jday;
3887 * Note that we don't know when leap-seconds were or will be,
3888 * so we have to trust the user if we get something which looks
3889 * like a sensible leap-second. Wild values for seconds will
3890 * be rationalised, however.
3892 if ((unsigned) ptm->tm_sec <= 60) {
3899 secs += 60 * ptm->tm_min;
3900 secs += SECS_PER_HOUR * ptm->tm_hour;
3902 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3903 /* got negative remainder, but need positive time */
3904 /* back off an extra day to compensate */
3905 yearday += (secs/SECS_PER_DAY)-1;
3906 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3909 yearday += (secs/SECS_PER_DAY);
3910 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3913 else if (secs >= SECS_PER_DAY) {
3914 yearday += (secs/SECS_PER_DAY);
3915 secs %= SECS_PER_DAY;
3917 ptm->tm_hour = secs/SECS_PER_HOUR;
3918 secs %= SECS_PER_HOUR;
3919 ptm->tm_min = secs/60;
3921 ptm->tm_sec += secs;
3922 /* done with time of day effects */
3924 * The algorithm for yearday has (so far) left it high by 428.
3925 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3926 * bias it by 123 while trying to figure out what year it
3927 * really represents. Even with this tweak, the reverse
3928 * translation fails for years before A.D. 0001.
3929 * It would still fail for Feb 29, but we catch that one below.
3931 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3932 yearday -= YEAR_ADJUST;
3933 year = (yearday / DAYS_PER_QCENT) * 400;
3934 yearday %= DAYS_PER_QCENT;
3935 odd_cent = yearday / DAYS_PER_CENT;
3936 year += odd_cent * 100;
3937 yearday %= DAYS_PER_CENT;
3938 year += (yearday / DAYS_PER_QYEAR) * 4;
3939 yearday %= DAYS_PER_QYEAR;
3940 odd_year = yearday / DAYS_PER_YEAR;
3942 yearday %= DAYS_PER_YEAR;
3943 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3948 yearday += YEAR_ADJUST; /* recover March 1st crock */
3949 month = yearday*DAYS_TO_MONTH;
3950 yearday -= month*MONTH_TO_DAYS;
3951 /* recover other leap-year adjustment */
3960 ptm->tm_year = year - 1900;
3962 ptm->tm_mday = yearday;
3963 ptm->tm_mon = month;
3967 ptm->tm_mon = month - 1;
3969 /* re-build yearday based on Jan 1 to get tm_yday */
3971 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3972 yearday += 14*MONTH_TO_DAYS + 1;
3973 ptm->tm_yday = jday - yearday;
3974 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3978 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)
3982 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3989 PERL_ARGS_ASSERT_MY_STRFTIME;
3991 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3994 mytm.tm_hour = hour;
3995 mytm.tm_mday = mday;
3997 mytm.tm_year = year;
3998 mytm.tm_wday = wday;
3999 mytm.tm_yday = yday;
4000 mytm.tm_isdst = isdst;
4002 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4003 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4008 #ifdef HAS_TM_TM_GMTOFF
4009 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4011 #ifdef HAS_TM_TM_ZONE
4012 mytm.tm_zone = mytm2.tm_zone;
4017 Newx(buf, buflen, char);
4019 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4020 len = strftime(buf, buflen, fmt, &mytm);
4024 ** The following is needed to handle to the situation where
4025 ** tmpbuf overflows. Basically we want to allocate a buffer
4026 ** and try repeatedly. The reason why it is so complicated
4027 ** is that getting a return value of 0 from strftime can indicate
4028 ** one of the following:
4029 ** 1. buffer overflowed,
4030 ** 2. illegal conversion specifier, or
4031 ** 3. the format string specifies nothing to be returned(not
4032 ** an error). This could be because format is an empty string
4033 ** or it specifies %p that yields an empty string in some locale.
4034 ** If there is a better way to make it portable, go ahead by
4037 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4040 /* Possibly buf overflowed - try again with a bigger buf */
4041 const int fmtlen = strlen(fmt);
4042 int bufsize = fmtlen + buflen;
4044 Renew(buf, bufsize, char);
4047 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4048 buflen = strftime(buf, bufsize, fmt, &mytm);
4051 if (buflen > 0 && buflen < bufsize)
4053 /* heuristic to prevent out-of-memory errors */
4054 if (bufsize > 100*fmtlen) {
4060 Renew(buf, bufsize, char);
4065 Perl_croak(aTHX_ "panic: no strftime");
4071 #define SV_CWD_RETURN_UNDEF \
4072 sv_setsv(sv, &PL_sv_undef); \
4075 #define SV_CWD_ISDOT(dp) \
4076 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4077 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4080 =head1 Miscellaneous Functions
4082 =for apidoc getcwd_sv
4084 Fill C<sv> with current working directory
4089 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4090 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4091 * getcwd(3) if available
4092 * Comments from the original:
4093 * This is a faster version of getcwd. It's also more dangerous
4094 * because you might chdir out of a directory that you can't chdir
4098 Perl_getcwd_sv(pTHX_ SV *sv)
4103 PERL_ARGS_ASSERT_GETCWD_SV;
4107 char buf[MAXPATHLEN];
4109 /* Some getcwd()s automatically allocate a buffer of the given
4110 * size from the heap if they are given a NULL buffer pointer.
4111 * The problem is that this behaviour is not portable. */
4112 if (getcwd(buf, sizeof(buf) - 1)) {
4117 sv_setsv(sv, &PL_sv_undef);
4125 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4129 SvUPGRADE(sv, SVt_PV);
4131 if (PerlLIO_lstat(".", &statbuf) < 0) {
4132 SV_CWD_RETURN_UNDEF;
4135 orig_cdev = statbuf.st_dev;
4136 orig_cino = statbuf.st_ino;
4146 if (PerlDir_chdir("..") < 0) {
4147 SV_CWD_RETURN_UNDEF;
4149 if (PerlLIO_stat(".", &statbuf) < 0) {
4150 SV_CWD_RETURN_UNDEF;
4153 cdev = statbuf.st_dev;
4154 cino = statbuf.st_ino;
4156 if (odev == cdev && oino == cino) {
4159 if (!(dir = PerlDir_open("."))) {
4160 SV_CWD_RETURN_UNDEF;
4163 while ((dp = PerlDir_read(dir)) != NULL) {
4165 namelen = dp->d_namlen;
4167 namelen = strlen(dp->d_name);
4170 if (SV_CWD_ISDOT(dp)) {
4174 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4175 SV_CWD_RETURN_UNDEF;
4178 tdev = statbuf.st_dev;
4179 tino = statbuf.st_ino;
4180 if (tino == oino && tdev == odev) {
4186 SV_CWD_RETURN_UNDEF;
4189 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4190 SV_CWD_RETURN_UNDEF;
4193 SvGROW(sv, pathlen + namelen + 1);
4197 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4200 /* prepend current directory to the front */
4202 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4203 pathlen += (namelen + 1);
4205 #ifdef VOID_CLOSEDIR
4208 if (PerlDir_close(dir) < 0) {
4209 SV_CWD_RETURN_UNDEF;
4215 SvCUR_set(sv, pathlen);
4219 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4220 SV_CWD_RETURN_UNDEF;
4223 if (PerlLIO_stat(".", &statbuf) < 0) {
4224 SV_CWD_RETURN_UNDEF;
4227 cdev = statbuf.st_dev;
4228 cino = statbuf.st_ino;
4230 if (cdev != orig_cdev || cino != orig_cino) {
4231 Perl_croak(aTHX_ "Unstable directory path, "
4232 "current directory changed unexpectedly");
4245 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4246 # define EMULATE_SOCKETPAIR_UDP
4249 #ifdef EMULATE_SOCKETPAIR_UDP
4251 S_socketpair_udp (int fd[2]) {
4253 /* Fake a datagram socketpair using UDP to localhost. */
4254 int sockets[2] = {-1, -1};
4255 struct sockaddr_in addresses[2];
4257 Sock_size_t size = sizeof(struct sockaddr_in);
4258 unsigned short port;
4261 memset(&addresses, 0, sizeof(addresses));
4264 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4265 if (sockets[i] == -1)
4266 goto tidy_up_and_fail;
4268 addresses[i].sin_family = AF_INET;
4269 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4270 addresses[i].sin_port = 0; /* kernel choses port. */
4271 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4272 sizeof(struct sockaddr_in)) == -1)
4273 goto tidy_up_and_fail;
4276 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4277 for each connect the other socket to it. */
4280 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4282 goto tidy_up_and_fail;
4283 if (size != sizeof(struct sockaddr_in))
4284 goto abort_tidy_up_and_fail;
4285 /* !1 is 0, !0 is 1 */
4286 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4287 sizeof(struct sockaddr_in)) == -1)
4288 goto tidy_up_and_fail;
4291 /* Now we have 2 sockets connected to each other. I don't trust some other
4292 process not to have already sent a packet to us (by random) so send
4293 a packet from each to the other. */
4296 /* I'm going to send my own port number. As a short.
4297 (Who knows if someone somewhere has sin_port as a bitfield and needs
4298 this routine. (I'm assuming crays have socketpair)) */
4299 port = addresses[i].sin_port;
4300 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4301 if (got != sizeof(port)) {
4303 goto tidy_up_and_fail;
4304 goto abort_tidy_up_and_fail;
4308 /* Packets sent. I don't trust them to have arrived though.
4309 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4310 connect to localhost will use a second kernel thread. In 2.6 the
4311 first thread running the connect() returns before the second completes,
4312 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4313 returns 0. Poor programs have tripped up. One poor program's authors'
4314 had a 50-1 reverse stock split. Not sure how connected these were.)
4315 So I don't trust someone not to have an unpredictable UDP stack.
4319 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4320 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4324 FD_SET((unsigned int)sockets[0], &rset);
4325 FD_SET((unsigned int)sockets[1], &rset);
4327 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4328 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4329 || !FD_ISSET(sockets[1], &rset)) {
4330 /* I hope this is portable and appropriate. */
4332 goto tidy_up_and_fail;
4333 goto abort_tidy_up_and_fail;
4337 /* And the paranoia department even now doesn't trust it to have arrive
4338 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4340 struct sockaddr_in readfrom;
4341 unsigned short buffer[2];
4346 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4347 sizeof(buffer), MSG_DONTWAIT,
4348 (struct sockaddr *) &readfrom, &size);
4350 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4352 (struct sockaddr *) &readfrom, &size);
4356 goto tidy_up_and_fail;
4357 if (got != sizeof(port)
4358 || size != sizeof(struct sockaddr_in)
4359 /* Check other socket sent us its port. */
4360 || buffer[0] != (unsigned short) addresses[!i].sin_port
4361 /* Check kernel says we got the datagram from that socket */
4362 || readfrom.sin_family != addresses[!i].sin_family
4363 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4364 || readfrom.sin_port != addresses[!i].sin_port)
4365 goto abort_tidy_up_and_fail;
4368 /* My caller (my_socketpair) has validated that this is non-NULL */
4371 /* I hereby declare this connection open. May God bless all who cross
4375 abort_tidy_up_and_fail:
4376 errno = ECONNABORTED;
4380 if (sockets[0] != -1)
4381 PerlLIO_close(sockets[0]);
4382 if (sockets[1] != -1)
4383 PerlLIO_close(sockets[1]);
4388 #endif /* EMULATE_SOCKETPAIR_UDP */
4390 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4392 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4393 /* Stevens says that family must be AF_LOCAL, protocol 0.
4394 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4399 struct sockaddr_in listen_addr;
4400 struct sockaddr_in connect_addr;
4405 || family != AF_UNIX
4408 errno = EAFNOSUPPORT;
4416 #ifdef EMULATE_SOCKETPAIR_UDP
4417 if (type == SOCK_DGRAM)
4418 return S_socketpair_udp(fd);
4421 aTHXa(PERL_GET_THX);
4422 listener = PerlSock_socket(AF_INET, type, 0);
4425 memset(&listen_addr, 0, sizeof(listen_addr));
4426 listen_addr.sin_family = AF_INET;
4427 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4428 listen_addr.sin_port = 0; /* kernel choses port. */
4429 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4430 sizeof(listen_addr)) == -1)
4431 goto tidy_up_and_fail;
4432 if (PerlSock_listen(listener, 1) == -1)
4433 goto tidy_up_and_fail;
4435 connector = PerlSock_socket(AF_INET, type, 0);
4436 if (connector == -1)
4437 goto tidy_up_and_fail;
4438 /* We want to find out the port number to connect to. */
4439 size = sizeof(connect_addr);
4440 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4442 goto tidy_up_and_fail;
4443 if (size != sizeof(connect_addr))
4444 goto abort_tidy_up_and_fail;
4445 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4446 sizeof(connect_addr)) == -1)
4447 goto tidy_up_and_fail;
4449 size = sizeof(listen_addr);
4450 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4453 goto tidy_up_and_fail;
4454 if (size != sizeof(listen_addr))
4455 goto abort_tidy_up_and_fail;
4456 PerlLIO_close(listener);
4457 /* Now check we are talking to ourself by matching port and host on the
4459 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4461 goto tidy_up_and_fail;
4462 if (size != sizeof(connect_addr)
4463 || listen_addr.sin_family != connect_addr.sin_family
4464 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4465 || listen_addr.sin_port != connect_addr.sin_port) {
4466 goto abort_tidy_up_and_fail;
4472 abort_tidy_up_and_fail:
4474 errno = ECONNABORTED; /* This would be the standard thing to do. */
4476 # ifdef ECONNREFUSED
4477 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4479 errno = ETIMEDOUT; /* Desperation time. */
4486 PerlLIO_close(listener);
4487 if (connector != -1)
4488 PerlLIO_close(connector);
4490 PerlLIO_close(acceptor);
4496 /* In any case have a stub so that there's code corresponding
4497 * to the my_socketpair in embed.fnc. */
4499 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4500 #ifdef HAS_SOCKETPAIR
4501 return socketpair(family, type, protocol, fd);
4510 =for apidoc sv_nosharing
4512 Dummy routine which "shares" an SV when there is no sharing module present.
4513 Or "locks" it. Or "unlocks" it. In other
4514 words, ignores its single SV argument.
4515 Exists to avoid test for a C<NULL> function pointer and because it could
4516 potentially warn under some level of strict-ness.
4522 Perl_sv_nosharing(pTHX_ SV *sv)
4524 PERL_UNUSED_CONTEXT;
4525 PERL_UNUSED_ARG(sv);
4530 =for apidoc sv_destroyable
4532 Dummy routine which reports that object can be destroyed when there is no
4533 sharing module present. It ignores its single SV argument, and returns
4534 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4535 could potentially warn under some level of strict-ness.
4541 Perl_sv_destroyable(pTHX_ SV *sv)
4543 PERL_UNUSED_CONTEXT;
4544 PERL_UNUSED_ARG(sv);
4549 Perl_parse_unicode_opts(pTHX_ const char **popt)
4551 const char *p = *popt;
4554 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4560 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4563 if (p && *p && *p != '\n' && *p != '\r') {
4565 goto the_end_of_the_opts_parser;
4567 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4571 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4577 case PERL_UNICODE_STDIN:
4578 opt |= PERL_UNICODE_STDIN_FLAG; break;
4579 case PERL_UNICODE_STDOUT:
4580 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4581 case PERL_UNICODE_STDERR:
4582 opt |= PERL_UNICODE_STDERR_FLAG; break;
4583 case PERL_UNICODE_STD:
4584 opt |= PERL_UNICODE_STD_FLAG; break;
4585 case PERL_UNICODE_IN:
4586 opt |= PERL_UNICODE_IN_FLAG; break;
4587 case PERL_UNICODE_OUT:
4588 opt |= PERL_UNICODE_OUT_FLAG; break;
4589 case PERL_UNICODE_INOUT:
4590 opt |= PERL_UNICODE_INOUT_FLAG; break;
4591 case PERL_UNICODE_LOCALE:
4592 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4593 case PERL_UNICODE_ARGV:
4594 opt |= PERL_UNICODE_ARGV_FLAG; break;
4595 case PERL_UNICODE_UTF8CACHEASSERT:
4596 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4598 if (*p != '\n' && *p != '\r') {
4599 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4602 "Unknown Unicode option letter '%c'", *p);
4609 opt = PERL_UNICODE_DEFAULT_FLAGS;
4611 the_end_of_the_opts_parser:
4613 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4614 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
4615 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4623 # include <starlet.h>
4630 * This is really just a quick hack which grabs various garbage
4631 * values. It really should be a real hash algorithm which
4632 * spreads the effect of every input bit onto every output bit,
4633 * if someone who knows about such things would bother to write it.
4634 * Might be a good idea to add that function to CORE as well.
4635 * No numbers below come from careful analysis or anything here,
4636 * except they are primes and SEED_C1 > 1E6 to get a full-width
4637 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4638 * probably be bigger too.
4641 # define SEED_C1 1000003
4642 #define SEED_C4 73819
4644 # define SEED_C1 25747
4645 #define SEED_C4 20639
4649 #define SEED_C5 26107
4651 #ifndef PERL_NO_DEV_RANDOM
4655 #ifdef HAS_GETTIMEOFDAY
4656 struct timeval when;
4661 /* This test is an escape hatch, this symbol isn't set by Configure. */
4662 #ifndef PERL_NO_DEV_RANDOM
4663 #ifndef PERL_RANDOM_DEVICE
4664 /* /dev/random isn't used by default because reads from it will block
4665 * if there isn't enough entropy available. You can compile with
4666 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4667 * is enough real entropy to fill the seed. */
4668 # ifdef __amigaos4__
4669 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4671 # define PERL_RANDOM_DEVICE "/dev/urandom"
4674 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4676 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4684 #ifdef HAS_GETTIMEOFDAY
4685 PerlProc_gettimeofday(&when,NULL);
4686 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4689 u = (U32)SEED_C1 * when;
4691 u += SEED_C3 * (U32)PerlProc_getpid();
4692 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4693 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4694 u += SEED_C5 * (U32)PTR2UV(&when);
4700 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4705 PERL_ARGS_ASSERT_GET_HASH_SEED;
4707 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4710 #ifndef USE_HASH_SEED_EXPLICIT
4712 /* ignore leading spaces */
4713 while (isSPACE(*env_pv))
4715 #ifdef USE_PERL_PERTURB_KEYS
4716 /* if they set it to "0" we disable key traversal randomization completely */
4717 if (strEQ(env_pv,"0")) {
4718 PL_hash_rand_bits_enabled= 0;
4720 /* otherwise switch to deterministic mode */
4721 PL_hash_rand_bits_enabled= 2;
4724 /* ignore a leading 0x... if it is there */
4725 if (env_pv[0] == '0' && env_pv[1] == 'x')
4728 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4729 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4730 if ( isXDIGIT(*env_pv)) {
4731 seed_buffer[i] |= READ_XDIGIT(env_pv);
4734 while (isSPACE(*env_pv))
4737 if (*env_pv && !isXDIGIT(*env_pv)) {
4738 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4740 /* should we check for unparsed crap? */
4741 /* should we warn about unused hex? */
4742 /* should we warn about insufficient hex? */
4747 (void)seedDrand01((Rand_seed_t)seed());
4749 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4750 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4753 #ifdef USE_PERL_PERTURB_KEYS
4754 { /* initialize PL_hash_rand_bits from the hash seed.
4755 * This value is highly volatile, it is updated every
4756 * hash insert, and is used as part of hash bucket chain
4757 * randomization and hash iterator randomization. */
4758 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4759 for( i = 0; i < sizeof(UV) ; i++ ) {
4760 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4761 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4764 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4766 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4767 PL_hash_rand_bits_enabled= 0;
4768 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4769 PL_hash_rand_bits_enabled= 1;
4770 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4771 PL_hash_rand_bits_enabled= 2;
4773 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4779 #ifdef PERL_GLOBAL_STRUCT
4781 #define PERL_GLOBAL_STRUCT_INIT
4782 #include "opcode.h" /* the ppaddr and check */
4785 Perl_init_global_struct(pTHX)
4787 struct perl_vars *plvarsp = NULL;
4788 # ifdef PERL_GLOBAL_STRUCT
4789 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4790 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4791 PERL_UNUSED_CONTEXT;
4792 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4793 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4794 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4798 plvarsp = PL_VarsPtr;
4799 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4804 # define PERLVAR(prefix,var,type) /**/
4805 # define PERLVARA(prefix,var,n,type) /**/
4806 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4807 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4808 # include "perlvars.h"
4813 # ifdef PERL_GLOBAL_STRUCT
4816 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4817 if (!plvarsp->Gppaddr)
4821 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4822 if (!plvarsp->Gcheck)
4824 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4825 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4827 # ifdef PERL_SET_VARS
4828 PERL_SET_VARS(plvarsp);
4830 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4831 plvarsp->Gsv_placeholder.sv_flags = 0;
4832 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4834 # undef PERL_GLOBAL_STRUCT_INIT
4839 #endif /* PERL_GLOBAL_STRUCT */
4841 #ifdef PERL_GLOBAL_STRUCT
4844 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4846 int veto = plvarsp->Gveto_cleanup;
4848 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4849 PERL_UNUSED_CONTEXT;
4850 # ifdef PERL_GLOBAL_STRUCT
4851 # ifdef PERL_UNSET_VARS
4852 PERL_UNSET_VARS(plvarsp);
4856 free(plvarsp->Gppaddr);
4857 free(plvarsp->Gcheck);
4858 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4864 #endif /* PERL_GLOBAL_STRUCT */
4868 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4869 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4870 * given, and you supply your own implementation.
4872 * The default implementation reads a single env var, PERL_MEM_LOG,
4873 * expecting one or more of the following:
4875 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4876 * 'm' - memlog was PERL_MEM_LOG=1
4877 * 's' - svlog was PERL_SV_LOG=1
4878 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4880 * This makes the logger controllable enough that it can reasonably be
4881 * added to the system perl.
4884 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4885 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4887 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4889 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4890 * writes to. In the default logger, this is settable at runtime.
4892 #ifndef PERL_MEM_LOG_FD
4893 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4896 #ifndef PERL_MEM_LOG_NOIMPL
4898 # ifdef DEBUG_LEAKING_SCALARS
4899 # define SV_LOG_SERIAL_FMT " [%lu]"
4900 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4902 # define SV_LOG_SERIAL_FMT
4903 # define _SV_LOG_SERIAL_ARG(sv)
4907 S_mem_log_common(enum mem_log_type mlt, const UV n,
4908 const UV typesize, const char *type_name, const SV *sv,
4909 Malloc_t oldalloc, Malloc_t newalloc,
4910 const char *filename, const int linenumber,
4911 const char *funcname)
4915 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4917 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4920 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4922 /* We can't use SVs or PerlIO for obvious reasons,
4923 * so we'll use stdio and low-level IO instead. */
4924 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4926 # ifdef HAS_GETTIMEOFDAY
4927 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4928 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4930 gettimeofday(&tv, 0);
4932 # define MEM_LOG_TIME_FMT "%10d: "
4933 # define MEM_LOG_TIME_ARG (int)when
4937 /* If there are other OS specific ways of hires time than
4938 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4939 * probably that they would be used to fill in the struct
4946 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4947 && uv && uv <= PERL_INT_MAX
4951 fd = PERL_MEM_LOG_FD;
4954 if (strchr(pmlenv, 't')) {
4955 len = my_snprintf(buf, sizeof(buf),
4956 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4957 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4961 len = my_snprintf(buf, sizeof(buf),
4962 "alloc: %s:%d:%s: %"IVdf" %"UVuf
4963 " %s = %"IVdf": %"UVxf"\n",
4964 filename, linenumber, funcname, n, typesize,
4965 type_name, n * typesize, PTR2UV(newalloc));
4968 len = my_snprintf(buf, sizeof(buf),
4969 "realloc: %s:%d:%s: %"IVdf" %"UVuf
4970 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
4971 filename, linenumber, funcname, n, typesize,
4972 type_name, n * typesize, PTR2UV(oldalloc),
4976 len = my_snprintf(buf, sizeof(buf),
4977 "free: %s:%d:%s: %"UVxf"\n",
4978 filename, linenumber, funcname,
4983 len = my_snprintf(buf, sizeof(buf),
4984 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
4985 mlt == MLT_NEW_SV ? "new" : "del",
4986 filename, linenumber, funcname,
4987 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4992 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4996 #endif /* !PERL_MEM_LOG_NOIMPL */
4998 #ifndef PERL_MEM_LOG_NOIMPL
5000 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5001 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5003 /* this is suboptimal, but bug compatible. User is providing their
5004 own implementation, but is getting these functions anyway, and they
5005 do nothing. But _NOIMPL users should be able to cope or fix */
5007 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5008 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5012 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5014 const char *filename, const int linenumber,
5015 const char *funcname)
5017 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5019 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5020 NULL, NULL, newalloc,
5021 filename, linenumber, funcname);
5026 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5027 Malloc_t oldalloc, Malloc_t newalloc,
5028 const char *filename, const int linenumber,
5029 const char *funcname)
5031 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5033 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5034 NULL, oldalloc, newalloc,
5035 filename, linenumber, funcname);
5040 Perl_mem_log_free(Malloc_t oldalloc,
5041 const char *filename, const int linenumber,
5042 const char *funcname)
5044 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5046 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5047 filename, linenumber, funcname);
5052 Perl_mem_log_new_sv(const SV *sv,
5053 const char *filename, const int linenumber,
5054 const char *funcname)
5056 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5057 filename, linenumber, funcname);
5061 Perl_mem_log_del_sv(const SV *sv,
5062 const char *filename, const int linenumber,
5063 const char *funcname)
5065 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5066 filename, linenumber, funcname);
5069 #endif /* PERL_MEM_LOG */
5072 =for apidoc my_sprintf
5074 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5075 the length of the string written to the buffer. Only rare pre-ANSI systems
5076 need the wrapper function - usually this is a direct call to C<sprintf>.
5080 #ifndef SPRINTF_RETURNS_STRLEN
5082 Perl_my_sprintf(char *buffer, const char* pat, ...)
5085 PERL_ARGS_ASSERT_MY_SPRINTF;
5086 va_start(args, pat);
5087 vsprintf(buffer, pat, args);
5089 return strlen(buffer);
5094 =for apidoc quadmath_format_single
5096 C<quadmath_snprintf()> is very strict about its C<format> string and will
5097 fail, returning -1, if the format is invalid. It accepts exactly
5100 C<quadmath_format_single()> checks that the intended single spec looks
5101 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5102 and has C<Q> before it. This is not a full "printf syntax check",
5105 Returns the format if it is valid, NULL if not.
5107 C<quadmath_format_single()> can and will actually patch in the missing
5108 C<Q>, if necessary. In this case it will return the modified copy of
5109 the format, B<which the caller will need to free.>
5111 See also L</quadmath_format_needed>.
5117 Perl_quadmath_format_single(const char* format)
5121 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5123 if (format[0] != '%' || strchr(format + 1, '%'))
5125 len = strlen(format);
5126 /* minimum length three: %Qg */
5127 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5129 if (format[len - 2] != 'Q') {
5131 Newx(fixed, len + 1, char);
5132 memcpy(fixed, format, len - 1);
5133 fixed[len - 1] = 'Q';
5134 fixed[len ] = format[len - 1];
5136 return (const char*)fixed;
5143 =for apidoc quadmath_format_needed
5145 C<quadmath_format_needed()> returns true if the C<format> string seems to
5146 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5147 or returns false otherwise.
5149 The format specifier detection is not complete printf-syntax detection,
5150 but it should catch most common cases.
5152 If true is returned, those arguments B<should> in theory be processed
5153 with C<quadmath_snprintf()>, but in case there is more than one such
5154 format specifier (see L</quadmath_format_single>), and if there is
5155 anything else beyond that one (even just a single byte), they
5156 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5157 accepting only one format spec, and nothing else.
5158 In this case, the code should probably fail.
5164 Perl_quadmath_format_needed(const char* format)
5166 const char *p = format;
5169 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5171 while ((q = strchr(p, '%'))) {
5173 if (*q == '+') /* plus */
5175 if (*q == '#') /* alt */
5177 if (*q == '*') /* width */
5181 while (isDIGIT(*q)) q++;
5184 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5189 while (isDIGIT(*q)) q++;
5191 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5200 =for apidoc my_snprintf
5202 The C library C<snprintf> functionality, if available and
5203 standards-compliant (uses C<vsnprintf>, actually). However, if the
5204 C<vsnprintf> is not available, will unfortunately use the unsafe
5205 C<vsprintf> which can overrun the buffer (there is an overrun check,
5206 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5207 getting C<vsnprintf>.
5212 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5216 PERL_ARGS_ASSERT_MY_SNPRINTF;
5217 #ifndef HAS_VSNPRINTF
5218 PERL_UNUSED_VAR(len);
5220 va_start(ap, format);
5223 const char* qfmt = quadmath_format_single(format);
5224 bool quadmath_valid = FALSE;
5226 /* If the format looked promising, use it as quadmath. */
5227 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5229 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5230 quadmath_valid = TRUE;
5235 assert(qfmt == NULL);
5236 /* quadmath_format_single() will return false for example for
5237 * "foo = %g", or simply "%g". We could handle the %g by
5238 * using quadmath for the NV args. More complex cases of
5239 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5240 * quadmath-valid but has stuff in front).
5242 * Handling the "Q-less" cases right would require walking
5243 * through the va_list and rewriting the format, calling
5244 * quadmath for the NVs, building a new va_list, and then
5245 * letting vsnprintf/vsprintf to take care of the other
5246 * arguments. This may be doable.
5248 * We do not attempt that now. But for paranoia, we here try
5249 * to detect some common (but not all) cases where the
5250 * "Q-less" %[efgaEFGA] formats are present, and die if
5251 * detected. This doesn't fix the problem, but it stops the
5252 * vsnprintf/vsprintf pulling doubles off the va_list when
5253 * __float128 NVs should be pulled off instead.
5255 * If quadmath_format_needed() returns false, we are reasonably
5256 * certain that we can call vnsprintf() or vsprintf() safely. */
5257 if (!quadmath_valid && quadmath_format_needed(format))
5258 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5263 #ifdef HAS_VSNPRINTF
5264 retval = vsnprintf(buffer, len, format, ap);
5266 retval = vsprintf(buffer, format, ap);
5269 /* vsprintf() shows failure with < 0 */
5271 #ifdef HAS_VSNPRINTF
5272 /* vsnprintf() shows failure with >= len */
5274 (len > 0 && (Size_t)retval >= len)
5277 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5282 =for apidoc my_vsnprintf
5284 The C library C<vsnprintf> if available and standards-compliant.
5285 However, if if the C<vsnprintf> is not available, will unfortunately
5286 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5287 overrun check, but that may be too late). Consider using
5288 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5293 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5296 PERL_UNUSED_ARG(buffer);
5297 PERL_UNUSED_ARG(len);
5298 PERL_UNUSED_ARG(format);
5299 PERL_UNUSED_ARG(ap);
5300 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5307 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5308 Perl_va_copy(ap, apc);
5309 # ifdef HAS_VSNPRINTF
5310 retval = vsnprintf(buffer, len, format, apc);
5312 PERL_UNUSED_ARG(len);
5313 retval = vsprintf(buffer, format, apc);
5317 # ifdef HAS_VSNPRINTF
5318 retval = vsnprintf(buffer, len, format, ap);
5320 PERL_UNUSED_ARG(len);
5321 retval = vsprintf(buffer, format, ap);
5323 #endif /* #ifdef NEED_VA_COPY */
5324 /* vsprintf() shows failure with < 0 */
5326 #ifdef HAS_VSNPRINTF
5327 /* vsnprintf() shows failure with >= len */
5329 (len > 0 && (Size_t)retval >= len)
5332 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5338 Perl_my_clearenv(pTHX)
5341 #if ! defined(PERL_MICRO)
5342 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5344 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5345 # if defined(USE_ENVIRON_ARRAY)
5346 # if defined(USE_ITHREADS)
5347 /* only the parent thread can clobber the process environment */
5348 if (PL_curinterp == aTHX)
5349 # endif /* USE_ITHREADS */
5351 # if ! defined(PERL_USE_SAFE_PUTENV)
5352 if ( !PL_use_safe_putenv) {
5354 if (environ == PL_origenviron)
5355 environ = (char**)safesysmalloc(sizeof(char*));
5357 for (i = 0; environ[i]; i++)
5358 (void)safesysfree(environ[i]);
5361 # else /* PERL_USE_SAFE_PUTENV */
5362 # if defined(HAS_CLEARENV)
5364 # elif defined(HAS_UNSETENV)
5365 int bsiz = 80; /* Most envvar names will be shorter than this. */
5366 char *buf = (char*)safesysmalloc(bsiz);
5367 while (*environ != NULL) {
5368 char *e = strchr(*environ, '=');
5369 int l = e ? e - *environ : (int)strlen(*environ);
5371 (void)safesysfree(buf);
5372 bsiz = l + 1; /* + 1 for the \0. */
5373 buf = (char*)safesysmalloc(bsiz);
5375 memcpy(buf, *environ, l);
5377 (void)unsetenv(buf);
5379 (void)safesysfree(buf);
5380 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5381 /* Just null environ and accept the leakage. */
5383 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5384 # endif /* ! PERL_USE_SAFE_PUTENV */
5386 # endif /* USE_ENVIRON_ARRAY */
5387 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5388 #endif /* PERL_MICRO */
5391 #ifdef PERL_IMPLICIT_CONTEXT
5393 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5394 the global PL_my_cxt_index is incremented, and that value is assigned to
5395 that module's static my_cxt_index (who's address is passed as an arg).
5396 Then, for each interpreter this function is called for, it makes sure a
5397 void* slot is available to hang the static data off, by allocating or
5398 extending the interpreter's PL_my_cxt_list array */
5400 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5402 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5406 PERL_ARGS_ASSERT_MY_CXT_INIT;
5408 /* this module hasn't been allocated an index yet */
5409 #if defined(USE_ITHREADS)
5410 MUTEX_LOCK(&PL_my_ctx_mutex);
5412 *index = PL_my_cxt_index++;
5413 #if defined(USE_ITHREADS)
5414 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5418 /* make sure the array is big enough */
5419 if (PL_my_cxt_size <= *index) {
5420 if (PL_my_cxt_size) {
5421 while (PL_my_cxt_size <= *index)
5422 PL_my_cxt_size *= 2;
5423 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5426 PL_my_cxt_size = 16;
5427 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5430 /* newSV() allocates one more than needed */
5431 p = (void*)SvPVX(newSV(size-1));
5432 PL_my_cxt_list[*index] = p;
5433 Zero(p, size, char);
5437 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5440 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5445 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5447 for (index = 0; index < PL_my_cxt_index; index++) {
5448 const char *key = PL_my_cxt_keys[index];
5449 /* try direct pointer compare first - there are chances to success,
5450 * and it's much faster.
5452 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5459 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5465 PERL_ARGS_ASSERT_MY_CXT_INIT;
5467 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5469 /* this module hasn't been allocated an index yet */
5470 #if defined(USE_ITHREADS)
5471 MUTEX_LOCK(&PL_my_ctx_mutex);
5473 index = PL_my_cxt_index++;
5474 #if defined(USE_ITHREADS)
5475 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5479 /* make sure the array is big enough */
5480 if (PL_my_cxt_size <= index) {
5481 int old_size = PL_my_cxt_size;
5483 if (PL_my_cxt_size) {
5484 while (PL_my_cxt_size <= index)
5485 PL_my_cxt_size *= 2;
5486 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5487 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5490 PL_my_cxt_size = 16;
5491 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5492 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5494 for (i = old_size; i < PL_my_cxt_size; i++) {
5495 PL_my_cxt_keys[i] = 0;
5496 PL_my_cxt_list[i] = 0;
5499 PL_my_cxt_keys[index] = my_cxt_key;
5500 /* newSV() allocates one more than needed */
5501 p = (void*)SvPVX(newSV(size-1));
5502 PL_my_cxt_list[index] = p;
5503 Zero(p, size, char);
5506 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5507 #endif /* PERL_IMPLICIT_CONTEXT */
5510 /* Perl_xs_handshake():
5511 implement the various XS_*_BOOTCHECK macros, which are added to .c
5512 files by ExtUtils::ParseXS, to check that the perl the module was built
5513 with is binary compatible with the running perl.
5516 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5517 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5519 The meaning of the varargs is determined the U32 key arg (which is not
5520 a format string). The fields of key are assembled by using HS_KEY().
5522 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5523 "PerlInterpreter *" and represents the callers context; otherwise it is
5524 of type "CV *", and is the boot xsub's CV.
5526 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5527 for example, and IO.dll was linked with threaded perl524.dll, and both
5528 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5529 successfully can load IO.dll into the process but simultaneously it
5530 loaded an interpreter of a different version into the process, and XS
5531 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5532 use through perl526.dll's my_perl->Istack_base.
5534 v_my_perl cannot be the first arg, since then 'key' will be out of
5535 place in a threaded vs non-threaded mixup; and analyzing the key
5536 number's bitfields won't reveal the problem, since it will be a valid
5537 key (unthreaded perl) on interp side, but croak will report the XS mod's
5538 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5539 it's a threaded perl and an unthreaded XS module, threaded perl will
5540 look at an uninit C stack or an uninit register to get 'key'
5541 (remember that it assumes that the 1st arg is the interp cxt).
5543 'file' is the source filename of the caller.
5547 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5553 #ifdef PERL_IMPLICIT_CONTEXT
5560 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5561 va_start(args, file);
5563 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5564 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5565 if (UNLIKELY(got != need))
5567 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5568 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5569 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5570 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5571 passed to the XS DLL */
5572 #ifdef PERL_IMPLICIT_CONTEXT
5573 xs_interp = (tTHX)v_my_perl;
5577 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5578 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5579 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5580 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5581 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5582 location in the unthreaded perl binary) stored in CV * to figure out if this
5583 Perl_xs_handshake was called by the same pp_entersub */
5584 cv = (CV*)v_my_perl;
5585 xs_spp = (SV***)CvHSCXT(cv);
5587 need = &PL_stack_sp;
5589 if(UNLIKELY(got != need)) {
5590 bad_handshake:/* recycle branch and string from above */
5591 if(got != (void *)HSf_NOCHK)
5592 noperl_die("%s: loadable library and perl binaries are mismatched"
5593 " (got handshake key %p, needed %p)\n",
5597 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5598 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5599 PL_xsubfilename = file; /* so the old name must be restored for
5600 additional XSUBs to register themselves */
5601 /* XSUBs can't be perl lang/perl5db.pl debugged
5602 if (PERLDB_LINE_OR_SAVESRC)
5603 (void)gv_fetchfile(file); */
5606 if(key & HSf_POPMARK) {
5608 { SV **mark = PL_stack_base + ax++;
5610 items = (I32)(SP - MARK);
5614 items = va_arg(args, U32);
5615 ax = va_arg(args, U32);
5619 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5620 if((apiverlen = HS_GETAPIVERLEN(key))) {
5621 char * api_p = va_arg(args, char*);
5622 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5623 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5624 sizeof("v" PERL_API_VERSION_STRING)-1))
5625 Perl_croak_nocontext("Perl API version %s of %"SVf" does not match %s",
5626 api_p, SVfARG(PL_stack_base[ax + 0]),
5627 "v" PERL_API_VERSION_STRING);
5632 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5633 if((xsverlen = HS_GETXSVERLEN(key)))
5634 S_xs_version_bootcheck(aTHX_
5635 items, ax, va_arg(args, char*), xsverlen);
5643 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5647 const char *vn = NULL;
5648 SV *const module = PL_stack_base[ax];
5650 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5652 if (items >= 2) /* version supplied as bootstrap arg */
5653 sv = PL_stack_base[ax + 1];
5655 /* XXX GV_ADDWARN */
5657 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5658 if (!sv || !SvOK(sv)) {
5660 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5664 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5665 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5666 ? sv : sv_2mortal(new_version(sv));
5667 xssv = upg_version(xssv, 0);
5668 if ( vcmp(pmsv,xssv) ) {
5669 SV *string = vstringify(xssv);
5670 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5671 " does not match ", SVfARG(module), SVfARG(string));
5673 SvREFCNT_dec(string);
5674 string = vstringify(pmsv);
5677 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, SVfARG(module), vn,
5680 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, SVfARG(string));
5682 SvREFCNT_dec(string);
5684 Perl_sv_2mortal(aTHX_ xpt);
5685 Perl_croak_sv(aTHX_ xpt);
5691 =for apidoc my_strlcat
5693 The C library C<strlcat> if available, or a Perl implementation of it.
5694 This operates on C C<NUL>-terminated strings.
5696 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5697 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5698 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5699 practice this should not happen as it means that either C<size> is incorrect or
5700 that C<dst> is not a proper C<NUL>-terminated string).
5702 Note that C<size> is the full size of the destination buffer and
5703 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5704 room for the C<NUL> should be included in C<size>.
5708 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcat
5712 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5714 Size_t used, length, copy;
5717 length = strlen(src);
5718 if (size > 0 && used < size - 1) {
5719 copy = (length >= size - used) ? size - used - 1 : length;
5720 memcpy(dst + used, src, copy);
5721 dst[used + copy] = '\0';
5723 return used + length;
5729 =for apidoc my_strlcpy
5731 The C library C<strlcpy> if available, or a Perl implementation of it.
5732 This operates on C C<NUL>-terminated strings.
5734 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5735 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5739 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy
5743 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5745 Size_t length, copy;
5747 length = strlen(src);
5749 copy = (length >= size) ? size - 1 : length;
5750 memcpy(dst, src, copy);
5757 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5758 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5759 long _ftol( double ); /* Defined by VC6 C libs. */
5760 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5763 PERL_STATIC_INLINE bool
5764 S_gv_has_usable_name(pTHX_ GV *gv)
5768 && HvENAME(GvSTASH(gv))
5769 && (gvp = (GV **)hv_fetchhek(
5770 GvSTASH(gv), GvNAME_HEK(gv), 0
5776 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5778 SV * const dbsv = GvSVn(PL_DBsub);
5779 const bool save_taint = TAINT_get;
5781 /* When we are called from pp_goto (svp is null),
5782 * we do not care about using dbsv to call CV;
5783 * it's for informational purposes only.
5786 PERL_ARGS_ASSERT_GET_DB_SUB;
5790 if (!PERLDB_SUB_NN) {
5793 if (!svp && !CvLEXICAL(cv)) {
5794 gv_efullname3(dbsv, gv, NULL);
5796 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5797 || strEQ(GvNAME(gv), "END")
5798 || ( /* Could be imported, and old sub redefined. */
5799 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5801 !( (SvTYPE(*svp) == SVt_PVGV)
5802 && (GvCV((const GV *)*svp) == cv)
5803 /* Use GV from the stack as a fallback. */
5804 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5808 /* GV is potentially non-unique, or contain different CV. */
5809 SV * const tmp = newRV(MUTABLE_SV(cv));
5810 sv_setsv(dbsv, tmp);
5814 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5815 sv_catpvs(dbsv, "::");
5816 sv_cathek(dbsv, GvNAME_HEK(gv));
5820 const int type = SvTYPE(dbsv);
5821 if (type < SVt_PVIV && type != SVt_IV)
5822 sv_upgrade(dbsv, SVt_PVIV);
5823 (void)SvIOK_on(dbsv);
5824 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5827 TAINT_IF(save_taint);
5828 #ifdef NO_TAINT_SUPPORT
5829 PERL_UNUSED_VAR(save_taint);
5834 Perl_my_dirfd(DIR * dir) {
5836 /* Most dirfd implementations have problems when passed NULL. */
5841 #elif defined(HAS_DIR_DD_FD)
5844 Perl_croak_nocontext(PL_no_func, "dirfd");
5845 NOT_REACHED; /* NOTREACHED */
5851 Perl_get_re_arg(pTHX_ SV *sv) {
5857 sv = MUTABLE_SV(SvRV(sv));
5858 if (SvTYPE(sv) == SVt_REGEXP)
5859 return (REGEXP*) sv;
5866 * This code is derived from drand48() implementation from FreeBSD,
5867 * found in lib/libc/gen/_rand48.c.
5869 * The U64 implementation is original, based on the POSIX
5870 * specification for drand48().
5874 * Copyright (c) 1993 Martin Birgmeier
5875 * All rights reserved.
5877 * You may redistribute unmodified or modified versions of this source
5878 * code provided that the above copyright notice and this and the
5879 * following conditions are retained.
5881 * This software is provided ``as is'', and comes with no warranties
5882 * of any kind. I shall in no event be liable for anything that happens
5883 * to anyone/anything when using this software.
5886 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5888 #ifdef PERL_DRAND48_QUAD
5890 #define DRAND48_MULT U64_CONST(0x5deece66d)
5891 #define DRAND48_ADD 0xb
5892 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5896 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5897 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5898 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5899 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5900 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5901 #define FREEBSD_DRAND48_ADD (0x000b)
5903 const unsigned short _rand48_mult[3] = {
5904 FREEBSD_DRAND48_MULT_0,
5905 FREEBSD_DRAND48_MULT_1,
5906 FREEBSD_DRAND48_MULT_2
5908 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5913 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5915 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5917 #ifdef PERL_DRAND48_QUAD
5918 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5920 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5921 random_state->seed[1] = (U16) seed;
5922 random_state->seed[2] = (U16) (seed >> 16);
5927 Perl_drand48_r(perl_drand48_t *random_state)
5929 PERL_ARGS_ASSERT_DRAND48_R;
5931 #ifdef PERL_DRAND48_QUAD
5932 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5935 return ldexp((double)*random_state, -48);
5941 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5942 + (U32) _rand48_add;
5943 temp[0] = (U16) accu; /* lower 16 bits */
5944 accu >>= sizeof(U16) * 8;
5945 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5946 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5947 temp[1] = (U16) accu; /* middle 16 bits */
5948 accu >>= sizeof(U16) * 8;
5949 accu += _rand48_mult[0] * random_state->seed[2]
5950 + _rand48_mult[1] * random_state->seed[1]
5951 + _rand48_mult[2] * random_state->seed[0];
5952 random_state->seed[0] = temp[0];
5953 random_state->seed[1] = temp[1];
5954 random_state->seed[2] = (U16) accu;
5956 return ldexp((double) random_state->seed[0], -48) +
5957 ldexp((double) random_state->seed[1], -32) +
5958 ldexp((double) random_state->seed[2], -16);
5963 #ifdef USE_C_BACKTRACE
5965 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5970 /* abfd is the BFD handle. */
5972 /* bfd_syms is the BFD symbol table. */
5974 /* bfd_text is handle to the the ".text" section of the object file. */
5976 /* Since opening the executable and scanning its symbols is quite
5977 * heavy operation, we remember the filename we used the last time,
5978 * and do the opening and scanning only if the filename changes.
5979 * This removes most (but not all) open+scan cycles. */
5980 const char* fname_prev;
5983 /* Given a dl_info, update the BFD context if necessary. */
5984 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5986 /* BFD open and scan only if the filename changed. */
5987 if (ctx->fname_prev == NULL ||
5988 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5990 bfd_close(ctx->abfd);
5992 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5994 if (bfd_check_format(ctx->abfd, bfd_object)) {
5995 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5996 if (symbol_size > 0) {
5997 Safefree(ctx->bfd_syms);
5998 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6000 bfd_get_section_by_name(ctx->abfd, ".text");
6008 ctx->fname_prev = dl_info->dli_fname;
6012 /* Given a raw frame, try to symbolize it and store
6013 * symbol information (source file, line number) away. */
6014 static void bfd_symbolize(bfd_context* ctx,
6017 STRLEN* symbol_name_size,
6019 STRLEN* source_name_size,
6020 STRLEN* source_line)
6022 *symbol_name = NULL;
6023 *symbol_name_size = 0;
6025 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6027 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6030 unsigned int line = 0;
6031 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6032 ctx->bfd_syms, offset,
6033 &file, &func, &line) &&
6034 file && func && line > 0) {
6035 /* Size and copy the source file, use only
6036 * the basename of the source file.
6038 * NOTE: the basenames are fine for the
6039 * Perl source files, but may not always
6040 * be the best idea for XS files. */
6041 const char *p, *b = NULL;
6042 /* Look for the last slash. */
6043 for (p = file; *p; p++) {
6047 if (b == NULL || *b == 0) {
6050 *source_name_size = p - b + 1;
6051 Newx(*source_name, *source_name_size + 1, char);
6052 Copy(b, *source_name, *source_name_size + 1, char);
6054 *symbol_name_size = strlen(func);
6055 Newx(*symbol_name, *symbol_name_size + 1, char);
6056 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6058 *source_line = line;
6064 #endif /* #ifdef USE_BFD */
6068 /* OS X has no public API for for 'symbolicating' (Apple official term)
6069 * stack addresses to {function_name, source_file, line_number}.
6070 * Good news: there is command line utility atos(1) which does that.
6071 * Bad news 1: it's a command line utility.
6072 * Bad news 2: one needs to have the Developer Tools installed.
6073 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6075 * To recap: we need to open a pipe for reading for a utility which
6076 * might not exist, or exists in different locations, and then parse
6077 * the output. And since this is all for a low-level API, we cannot
6078 * use high-level stuff. Thanks, Apple. */
6081 /* tool is set to the absolute pathname of the tool to use:
6084 /* format is set to a printf format string used for building
6085 * the external command to run. */
6087 /* unavail is set if e.g. xcrun cannot be found, or something
6088 * else happens that makes getting the backtrace dubious. Note,
6089 * however, that the context isn't persistent, the next call to
6090 * get_c_backtrace() will start from scratch. */
6092 /* fname is the current object file name. */
6094 /* object_base_addr is the base address of the shared object. */
6095 void* object_base_addr;
6098 /* Given |dl_info|, updates the context. If the context has been
6099 * marked unavailable, return immediately. If not but the tool has
6100 * not been set, set it to either "xcrun atos" or "atos" (also set the
6101 * format to use for creating commands for piping), or if neither is
6102 * unavailable (one needs the Developer Tools installed), mark the context
6103 * an unavailable. Finally, update the filename (object name),
6104 * and its base address. */
6106 static void atos_update(atos_context* ctx,
6111 if (ctx->tool == NULL) {
6112 const char* tools[] = {
6116 const char* formats[] = {
6117 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6118 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6122 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6123 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6124 ctx->tool = tools[i];
6125 ctx->format = formats[i];
6129 if (ctx->tool == NULL) {
6130 ctx->unavail = TRUE;
6134 if (ctx->fname == NULL ||
6135 strNE(dl_info->dli_fname, ctx->fname)) {
6136 ctx->fname = dl_info->dli_fname;
6137 ctx->object_base_addr = dl_info->dli_fbase;
6141 /* Given an output buffer end |p| and its |start|, matches
6142 * for the atos output, extracting the source code location
6143 * and returning non-NULL if possible, returning NULL otherwise. */
6144 static const char* atos_parse(const char* p,
6146 STRLEN* source_name_size,
6147 STRLEN* source_line) {
6148 /* atos() output is something like:
6149 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6150 * We cannot use Perl regular expressions, because we need to
6151 * stay low-level. Therefore here we have a rolled-out version
6152 * of a state machine which matches _backwards_from_the_end_ and
6153 * if there's a success, returns the starts of the filename,
6154 * also setting the filename size and the source line number.
6155 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6156 const char* source_number_start;
6157 const char* source_name_end;
6158 const char* source_line_end;
6159 const char* close_paren;
6162 /* Skip trailing whitespace. */
6163 while (p > start && isspace(*p)) p--;
6164 /* Now we should be at the close paren. */
6165 if (p == start || *p != ')')
6169 /* Now we should be in the line number. */
6170 if (p == start || !isdigit(*p))
6172 /* Skip over the digits. */
6173 while (p > start && isdigit(*p))
6175 /* Now we should be at the colon. */
6176 if (p == start || *p != ':')
6178 source_number_start = p + 1;
6179 source_name_end = p; /* Just beyond the end. */
6181 /* Look for the open paren. */
6182 while (p > start && *p != '(')
6187 *source_name_size = source_name_end - p;
6188 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6189 && source_line_end == close_paren
6190 && uv <= PERL_INT_MAX
6192 *source_line = (STRLEN)uv;
6198 /* Given a raw frame, read a pipe from the symbolicator (that's the
6199 * technical term) atos, reads the result, and parses the source code
6200 * location. We must stay low-level, so we use snprintf(), pipe(),
6201 * and fread(), and then also parse the output ourselves. */
6202 static void atos_symbolize(atos_context* ctx,
6205 STRLEN* source_name_size,
6206 STRLEN* source_line)
6214 /* Simple security measure: if there's any funny business with
6215 * the object name (used as "-o '%s'" ), leave since at least
6216 * partially the user controls it. */
6217 for (p = ctx->fname; *p; p++) {
6218 if (*p == '\'' || iscntrl(*p)) {
6219 ctx->unavail = TRUE;
6223 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6224 ctx->fname, ctx->object_base_addr, raw_frame);
6225 if (cnt < sizeof(cmd)) {
6226 /* Undo nostdio.h #defines that disable stdio.
6227 * This is somewhat naughty, but is used elsewhere
6228 * in the core, and affects only OS X. */
6233 FILE* fp = popen(cmd, "r");
6234 /* At the moment we open a new pipe for each stack frame.
6235 * This is naturally somewhat slow, but hopefully generating
6236 * stack traces is never going to in a performance critical path.
6238 * We could play tricks with atos by batching the stack
6239 * addresses to be resolved: atos can either take multiple
6240 * addresses from the command line, or read addresses from
6241 * a file (though the mess of creating temporary files would
6242 * probably negate much of any possible speedup).
6244 * Normally there are only two objects present in the backtrace:
6245 * perl itself, and the libdyld.dylib. (Note that the object
6246 * filenames contain the full pathname, so perl may not always
6247 * be in the same place.) Whenever the object in the
6248 * backtrace changes, the base address also changes.
6250 * The problem with batching the addresses, though, would be
6251 * matching the results with the addresses: the parsing of
6252 * the results is already painful enough with a single address. */
6255 UV cnt = fread(out, 1, sizeof(out), fp);
6256 if (cnt < sizeof(out)) {
6257 const char* p = atos_parse(out + cnt - 1, out,
6262 *source_name_size, char);
6263 Copy(p, *source_name,
6264 *source_name_size, char);
6272 #endif /* #ifdef PERL_DARWIN */
6275 =for apidoc get_c_backtrace
6277 Collects the backtrace (aka "stacktrace") into a single linear
6278 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6280 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6281 returning at most C<depth> frames.
6287 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6289 /* Note that here we must stay as low-level as possible: Newx(),
6290 * Copy(), Safefree(); since we may be called from anywhere,
6291 * so we should avoid higher level constructs like SVs or AVs.
6293 * Since we are using safesysmalloc() via Newx(), don't try
6294 * getting backtrace() there, unless you like deep recursion. */
6296 /* Currently only implemented with backtrace() and dladdr(),
6297 * for other platforms NULL is returned. */
6299 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6300 /* backtrace() is available via <execinfo.h> in glibc and in most
6301 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6303 /* We try fetching this many frames total, but then discard
6304 * the |skip| first ones. For the remaining ones we will try
6305 * retrieving more information with dladdr(). */
6306 int try_depth = skip + depth;
6308 /* The addresses (program counters) returned by backtrace(). */
6311 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6314 /* Sizes _including_ the terminating \0 of the object name
6315 * and symbol name strings. */
6316 STRLEN* object_name_sizes;
6317 STRLEN* symbol_name_sizes;
6320 /* The symbol names comes either from dli_sname,
6321 * or if using BFD, they can come from BFD. */
6322 char** symbol_names;
6325 /* The source code location information. Dug out with e.g. BFD. */
6326 char** source_names;
6327 STRLEN* source_name_sizes;
6328 STRLEN* source_lines;
6330 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6331 int got_depth; /* How many frames were returned from backtrace(). */
6332 UV frame_count = 0; /* How many frames we return. */
6333 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6336 bfd_context bfd_ctx;
6339 atos_context atos_ctx;
6342 /* Here are probably possibilities for optimizing. We could for
6343 * example have a struct that contains most of these and then
6344 * allocate |try_depth| of them, saving a bunch of malloc calls.
6345 * Note, however, that |frames| could not be part of that struct
6346 * because backtrace() will want an array of just them. Also be
6347 * careful about the name strings. */
6348 Newx(raw_frames, try_depth, void*);
6349 Newx(dl_infos, try_depth, Dl_info);
6350 Newx(object_name_sizes, try_depth, STRLEN);
6351 Newx(symbol_name_sizes, try_depth, STRLEN);
6352 Newx(source_names, try_depth, char*);
6353 Newx(source_name_sizes, try_depth, STRLEN);
6354 Newx(source_lines, try_depth, STRLEN);
6356 Newx(symbol_names, try_depth, char*);
6359 /* Get the raw frames. */
6360 got_depth = (int)backtrace(raw_frames, try_depth);
6362 /* We use dladdr() instead of backtrace_symbols() because we want
6363 * the full details instead of opaque strings. This is useful for
6364 * two reasons: () the details are needed for further symbolic
6365 * digging, for example in OS X (2) by having the details we fully
6366 * control the output, which in turn is useful when more platforms
6367 * are added: we can keep out output "portable". */
6369 /* We want a single linear allocation, which can then be freed
6370 * with a single swoop. We will do the usual trick of first
6371 * walking over the structure and seeing how much we need to
6372 * allocate, then allocating, and then walking over the structure
6373 * the second time and populating it. */
6375 /* First we must compute the total size of the buffer. */
6376 total_bytes = sizeof(Perl_c_backtrace_header);
6377 if (got_depth > skip) {
6380 bfd_init(); /* Is this safe to call multiple times? */
6381 Zero(&bfd_ctx, 1, bfd_context);
6384 Zero(&atos_ctx, 1, atos_context);
6386 for (i = skip; i < try_depth; i++) {
6387 Dl_info* dl_info = &dl_infos[i];
6389 object_name_sizes[i] = 0;
6390 source_names[i] = NULL;
6391 source_name_sizes[i] = 0;
6392 source_lines[i] = 0;
6394 /* Yes, zero from dladdr() is failure. */
6395 if (dladdr(raw_frames[i], dl_info)) {
6396 total_bytes += sizeof(Perl_c_backtrace_frame);
6398 object_name_sizes[i] =
6399 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6400 symbol_name_sizes[i] =
6401 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6403 bfd_update(&bfd_ctx, dl_info);
6404 bfd_symbolize(&bfd_ctx, raw_frames[i],
6406 &symbol_name_sizes[i],
6408 &source_name_sizes[i],
6412 atos_update(&atos_ctx, dl_info);
6413 atos_symbolize(&atos_ctx,
6416 &source_name_sizes[i],
6420 /* Plus ones for the terminating \0. */
6421 total_bytes += object_name_sizes[i] + 1;
6422 total_bytes += symbol_name_sizes[i] + 1;
6423 total_bytes += source_name_sizes[i] + 1;
6431 Safefree(bfd_ctx.bfd_syms);
6435 /* Now we can allocate and populate the result buffer. */
6436 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6437 Zero(bt, total_bytes, char);
6438 bt->header.frame_count = frame_count;
6439 bt->header.total_bytes = total_bytes;
6440 if (frame_count > 0) {
6441 Perl_c_backtrace_frame* frame = bt->frame_info;
6442 char* name_base = (char *)(frame + frame_count);
6443 char* name_curr = name_base; /* Outputting the name strings here. */
6445 for (i = skip; i < skip + frame_count; i++) {
6446 Dl_info* dl_info = &dl_infos[i];
6448 frame->addr = raw_frames[i];
6449 frame->object_base_addr = dl_info->dli_fbase;
6450 frame->symbol_addr = dl_info->dli_saddr;
6452 /* Copies a string, including the \0, and advances the name_curr.
6453 * Also copies the start and the size to the frame. */
6454 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6456 Copy(src, name_curr, size, char); \
6457 frame->doffset = name_curr - (char*)bt; \
6458 frame->dsize = size; \
6459 name_curr += size; \
6462 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6464 object_name_size, object_name_sizes[i]);
6467 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6469 symbol_name_size, symbol_name_sizes[i]);
6470 Safefree(symbol_names[i]);
6472 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6474 symbol_name_size, symbol_name_sizes[i]);
6477 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6479 source_name_size, source_name_sizes[i]);
6480 Safefree(source_names[i]);
6482 #undef PERL_C_BACKTRACE_STRCPY
6484 frame->source_line_number = source_lines[i];
6488 assert(total_bytes ==
6489 (UV)(sizeof(Perl_c_backtrace_header) +
6490 frame_count * sizeof(Perl_c_backtrace_frame) +
6491 name_curr - name_base));
6494 Safefree(symbol_names);
6496 bfd_close(bfd_ctx.abfd);
6499 Safefree(source_lines);
6500 Safefree(source_name_sizes);
6501 Safefree(source_names);
6502 Safefree(symbol_name_sizes);
6503 Safefree(object_name_sizes);
6504 /* Assuming the strings returned by dladdr() are pointers
6505 * to read-only static memory (the object file), so that
6506 * they do not need freeing (and cannot be). */
6508 Safefree(raw_frames);
6511 PERL_UNUSED_ARGV(depth);
6512 PERL_UNUSED_ARGV(skip);
6518 =for apidoc free_c_backtrace
6520 Deallocates a backtrace received from get_c_bracktrace.
6526 =for apidoc get_c_backtrace_dump
6528 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6529 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6531 The appended output looks like:
6534 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6535 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6538 The fields are tab-separated. The first column is the depth (zero
6539 being the innermost non-skipped frame). In the hex:offset, the hex is
6540 where the program counter was in C<S_parse_body>, and the :offset (might
6541 be missing) tells how much inside the C<S_parse_body> the program counter was.
6543 The C<util.c:1716> is the source code file and line number.
6545 The F</usr/bin/perl> is obvious (hopefully).
6547 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6548 if the platform doesn't support retrieving the information;
6549 if the binary is missing the debug information;
6550 if the optimizer has transformed the code by for example inlining.
6556 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6558 Perl_c_backtrace* bt;
6560 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6562 Perl_c_backtrace_frame* frame;
6563 SV* dsv = newSVpvs("");
6565 for (i = 0, frame = bt->frame_info;
6566 i < bt->header.frame_count; i++, frame++) {
6567 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6568 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6569 /* Symbol (function) names might disappear without debug info.
6571 * The source code location might disappear in case of the
6572 * optimizer inlining or otherwise rearranging the code. */
6573 if (frame->symbol_addr) {
6574 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6576 ((char*)frame->addr - (char*)frame->symbol_addr));
6578 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6579 frame->symbol_name_size &&
6580 frame->symbol_name_offset ?
6581 (char*)bt + frame->symbol_name_offset : "-");
6582 if (frame->source_name_size &&
6583 frame->source_name_offset &&
6584 frame->source_line_number) {
6585 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%"UVuf,
6586 (char*)bt + frame->source_name_offset,
6587 (UV)frame->source_line_number);
6589 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6591 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6592 frame->object_name_size &&
6593 frame->object_name_offset ?
6594 (char*)bt + frame->object_name_offset : "-");
6595 /* The frame->object_base_addr is not output,
6596 * but it is used for symbolizing/symbolicating. */
6597 sv_catpvs(dsv, "\n");
6600 Perl_free_c_backtrace(aTHX_ bt);
6609 =for apidoc dump_c_backtrace
6611 Dumps the C backtrace to the given C<fp>.
6613 Returns true if a backtrace could be retrieved, false if not.
6619 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6623 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6625 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6628 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6634 #endif /* #ifdef USE_C_BACKTRACE */
6636 #ifdef PERL_TSA_ACTIVE
6638 /* pthread_mutex_t and perl_mutex are typedef equivalent
6639 * so casting the pointers is fine. */
6641 int perl_tsa_mutex_lock(perl_mutex* mutex)
6643 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6646 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6648 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6651 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6653 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6661 /* log a sub call or return */
6664 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6672 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6675 HEK *hek = CvNAME_HEK(cv);
6676 func = HEK_KEY(hek);
6682 start = (const COP *)CvSTART(cv);
6683 file = CopFILE(start);
6684 line = CopLINE(start);
6685 stash = CopSTASHPV(start);
6688 PERL_SUB_ENTRY(func, file, line, stash);
6691 PERL_SUB_RETURN(func, file, line, stash);
6696 /* log a require file loading/loaded */
6699 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6701 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6704 PERL_LOADING_FILE(name);
6707 PERL_LOADED_FILE(name);
6712 /* log an op execution */
6715 Perl_dtrace_probe_op(pTHX_ const OP *op)
6717 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6719 PERL_OP_ENTRY(OP_NAME(op));
6723 /* log a compile/run phase change */
6726 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6728 const char *ph_old = PL_phase_names[PL_phase];
6729 const char *ph_new = PL_phase_names[phase];
6731 PERL_PHASE_CHANGE(ph_new, ph_old);
6737 * ex: set ts=8 sts=4 sw=4 et: