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.
526 * With allow_escape, converts \<delimiter> to <delimiter>, while leaves
527 * \<non-delimiter> as-is.
528 * Returns the position in the src string of the closing delimiter, if
529 * any, or returns fromend otherwise.
530 * This is the internal implementation for Perl_delimcpy and
531 * Perl_delimcpy_no_escape.
535 S_delimcpy_intern(char *to, const char *toend, const char *from,
536 const char *fromend, int delim, I32 *retlen,
537 const bool allow_escape)
541 PERL_ARGS_ASSERT_DELIMCPY;
543 for (tolen = 0; from < fromend; from++, tolen++) {
544 if (allow_escape && *from == '\\' && from + 1 < fromend) {
545 if (from[1] != delim) {
552 else if (*from == delim)
564 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
566 PERL_ARGS_ASSERT_DELIMCPY;
568 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 1);
572 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
573 const char *fromend, int delim, I32 *retlen)
575 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
577 return S_delimcpy_intern(to, toend, from, fromend, delim, retlen, 0);
581 =head1 Miscellaneous Functions
583 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
585 Find the first (leftmost) occurrence of a sequence of bytes within another
586 sequence. This is the Perl version of C<strstr()>, extended to handle
587 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
588 is what the initial C<n> in the function name stands for; some systems have an
589 equivalent, C<memmem()>, but with a somewhat different API).
591 Another way of thinking about this function is finding a needle in a haystack.
592 C<big> points to the first byte in the haystack. C<big_end> points to one byte
593 beyond the final byte in the haystack. C<little> points to the first byte in
594 the needle. C<little_end> points to one byte beyond the final byte in the
595 needle. All the parameters must be non-C<NULL>.
597 The function returns C<NULL> if there is no occurrence of C<little> within
598 C<big>. If C<little> is the empty string, C<big> is returned.
600 Because this function operates at the byte level, and because of the inherent
601 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
602 needle and the haystack are strings with the same UTF-8ness, but not if the
610 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
612 PERL_ARGS_ASSERT_NINSTR;
615 return ninstr(big, bigend, little, lend);
621 const char first = *little;
623 bigend -= lend - little++;
625 while (big <= bigend) {
626 if (*big++ == first) {
627 for (x=big,s=little; s < lend; x++,s++) {
631 return (char*)(big-1);
642 =head1 Miscellaneous Functions
644 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
646 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
647 sequence of bytes within another sequence, returning C<NULL> if there is no
655 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
658 const I32 first = *little;
659 const char * const littleend = lend;
661 PERL_ARGS_ASSERT_RNINSTR;
663 if (little >= littleend)
664 return (char*)bigend;
666 big = bigend - (littleend - little++);
667 while (big >= bigbeg) {
671 for (x=big+2,s=little; s < littleend; /**/ ) {
680 return (char*)(big+1);
685 /* As a space optimization, we do not compile tables for strings of length
686 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
687 special-cased in fbm_instr().
689 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
692 =head1 Miscellaneous Functions
694 =for apidoc fbm_compile
696 Analyses the string in order to make fast searches on it using C<fbm_instr()>
697 -- the Boyer-Moore algorithm.
703 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
710 PERL_DEB( STRLEN rarest = 0 );
712 PERL_ARGS_ASSERT_FBM_COMPILE;
714 if (isGV_with_GP(sv) || SvROK(sv))
720 if (flags & FBMcf_TAIL) {
721 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
722 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
723 if (mg && mg->mg_len >= 0)
726 if (!SvPOK(sv) || SvNIOKp(sv))
727 s = (U8*)SvPV_force_mutable(sv, len);
728 else s = (U8 *)SvPV_mutable(sv, len);
729 if (len == 0) /* TAIL might be on a zero-length string. */
731 SvUPGRADE(sv, SVt_PVMG);
735 /* add PERL_MAGIC_bm magic holding the FBM lookup table */
737 assert(!mg_find(sv, PERL_MAGIC_bm));
738 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
742 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
744 const U8 mlen = (len>255) ? 255 : (U8)len;
745 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
748 Newx(table, 256, U8);
749 memset((void*)table, mlen, 256);
750 mg->mg_ptr = (char *)table;
753 s += len - 1; /* last char */
756 if (table[*s] == mlen)
762 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
763 for (i = 0; i < len; i++) {
764 if (PL_freq[s[i]] < frequency) {
765 PERL_DEB( rarest = i );
766 frequency = PL_freq[s[i]];
769 BmUSEFUL(sv) = 100; /* Initial value */
770 ((XPVNV*)SvANY(sv))->xnv_u.xnv_bm_tail = cBOOL(flags & FBMcf_TAIL);
771 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %" UVuf "\n",
772 s[rarest], (UV)rarest));
777 =for apidoc fbm_instr
779 Returns the location of the SV in the string delimited by C<big> and
780 C<bigend> (C<bigend>) is the char following the last char).
781 It returns C<NULL> if the string can't be found. The C<sv>
782 does not have to be C<fbm_compiled>, but the search will not be as fast
787 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
788 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
789 the littlestr must be anchored to the end of bigstr (or to any \n if
792 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
793 while /abc$/ compiles to "abc\n" with SvTAIL() true.
795 A littlestr of "abc", !SvTAIL matches as /abc/;
796 a littlestr of "ab\n", SvTAIL matches as:
797 without FBMrf_MULTILINE: /ab\n?\z/
798 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
800 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
801 "If SvTAIL is actually due to \Z or \z, this gives false positives
807 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
811 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
812 STRLEN littlelen = l;
813 const I32 multiline = flags & FBMrf_MULTILINE;
814 bool valid = SvVALID(littlestr);
815 bool tail = valid ? cBOOL(SvTAIL(littlestr)) : FALSE;
817 PERL_ARGS_ASSERT_FBM_INSTR;
819 if ((STRLEN)(bigend - big) < littlelen) {
821 && ((STRLEN)(bigend - big) == littlelen - 1)
823 || (*big == *little &&
824 memEQ((char *)big, (char *)little, littlelen - 1))))
829 switch (littlelen) { /* Special cases for 0, 1 and 2 */
831 return (char*)big; /* Cannot be SvTAIL! */
834 if (tail && !multiline) /* Anchor only! */
835 /* [-1] is safe because we know that bigend != big. */
836 return (char *) (bigend - (bigend[-1] == '\n'));
838 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
842 return (char *) bigend;
846 if (tail && !multiline) {
847 /* a littlestr with SvTAIL must be of the form "X\n" (where X
848 * is a single char). It is anchored, and can only match
849 * "....X\n" or "....X" */
850 if (bigend[-2] == *little && bigend[-1] == '\n')
851 return (char*)bigend - 2;
852 if (bigend[-1] == *little)
853 return (char*)bigend - 1;
858 /* memchr() is likely to be very fast, possibly using whatever
859 * hardware support is available, such as checking a whole
860 * cache line in one instruction.
861 * So for a 2 char pattern, calling memchr() is likely to be
862 * faster than running FBM, or rolling our own. The previous
863 * version of this code was roll-your-own which typically
864 * only needed to read every 2nd char, which was good back in
865 * the day, but no longer.
867 unsigned char c1 = little[0];
868 unsigned char c2 = little[1];
870 /* *** for all this case, bigend points to the last char,
871 * not the trailing \0: this makes the conditions slightly
877 /* do a quick test for c1 before calling memchr();
878 * this avoids the expensive fn call overhead when
879 * there are lots of c1's */
880 if (LIKELY(*s != c1)) {
882 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
889 /* failed; try searching for c2 this time; that way
890 * we don't go pathologically slow when the string
891 * consists mostly of c1's or vice versa.
896 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
904 /* c1, c2 the same */
914 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
915 if (!s || s >= bigend)
922 /* failed to find 2 chars; try anchored match at end without
924 if (tail && bigend[0] == little[0])
925 return (char *)bigend;
930 break; /* Only lengths 0 1 and 2 have special-case code. */
933 if (tail && !multiline) { /* tail anchored? */
934 s = bigend - littlelen;
935 if (s >= big && bigend[-1] == '\n' && *s == *little
936 /* Automatically of length > 2 */
937 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
939 return (char*)s; /* how sweet it is */
942 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
944 return (char*)s + 1; /* how sweet it is */
950 /* not compiled; use Perl_ninstr() instead */
951 char * const b = ninstr((char*)big,(char*)bigend,
952 (char*)little, (char*)little + littlelen);
954 assert(!tail); /* valid => FBM; tail only set on SvVALID SVs */
959 if (littlelen > (STRLEN)(bigend - big))
963 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
964 const unsigned char *oldlittle;
968 --littlelen; /* Last char found by table lookup */
971 little += littlelen; /* last char */
974 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
975 const unsigned char lastc = *little;
979 if ((tmp = table[*s])) {
980 /* *s != lastc; earliest position it could match now is
981 * tmp slots further on */
982 if ((s += tmp) >= bigend)
984 if (LIKELY(*s != lastc)) {
986 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
996 /* hand-rolled strncmp(): less expensive than calling the
997 * real function (maybe???) */
999 unsigned char * const olds = s;
1004 if (*--s == *--little)
1006 s = olds + 1; /* here we pay the price for failure */
1008 if (s < bigend) /* fake up continue to outer loop */
1018 && memEQ((char *)(bigend - littlelen),
1019 (char *)(oldlittle - littlelen), littlelen) )
1020 return (char*)bigend - littlelen;
1029 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1031 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
1032 match themselves and their opposite case counterparts. Non-cased and non-ASCII
1033 range bytes match only themselves.
1040 Perl_foldEQ(const char *s1, const char *s2, I32 len)
1042 const U8 *a = (const U8 *)s1;
1043 const U8 *b = (const U8 *)s2;
1045 PERL_ARGS_ASSERT_FOLDEQ;
1050 if (*a != *b && *a != PL_fold[*b])
1057 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
1059 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
1060 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
1061 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
1062 * does it check that the strings each have at least 'len' characters */
1064 const U8 *a = (const U8 *)s1;
1065 const U8 *b = (const U8 *)s2;
1067 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
1072 if (*a != *b && *a != PL_fold_latin1[*b]) {
1081 =for apidoc foldEQ_locale
1083 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1084 same case-insensitively in the current locale; false otherwise.
1090 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
1093 const U8 *a = (const U8 *)s1;
1094 const U8 *b = (const U8 *)s2;
1096 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1101 if (*a != *b && *a != PL_fold_locale[*b])
1108 /* copy a string to a safe spot */
1111 =head1 Memory Management
1115 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1116 string which is a duplicate of C<pv>. The size of the string is
1117 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1118 characters and must have a trailing C<NUL>. The memory allocated for the new
1119 string can be freed with the C<Safefree()> function.
1121 On some platforms, Windows for example, all allocated memory owned by a thread
1122 is deallocated when that thread ends. So if you need that not to happen, you
1123 need to use the shared memory functions, such as C<L</savesharedpv>>.
1129 Perl_savepv(pTHX_ const char *pv)
1131 PERL_UNUSED_CONTEXT;
1136 const STRLEN pvlen = strlen(pv)+1;
1137 Newx(newaddr, pvlen, char);
1138 return (char*)memcpy(newaddr, pv, pvlen);
1142 /* same thing but with a known length */
1147 Perl's version of what C<strndup()> would be if it existed. Returns a
1148 pointer to a newly allocated string which is a duplicate of the first
1149 C<len> bytes from C<pv>, plus a trailing
1150 C<NUL> byte. The memory allocated for
1151 the new string can be freed with the C<Safefree()> function.
1153 On some platforms, Windows for example, all allocated memory owned by a thread
1154 is deallocated when that thread ends. So if you need that not to happen, you
1155 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1161 Perl_savepvn(pTHX_ const char *pv, I32 len)
1164 PERL_UNUSED_CONTEXT;
1168 Newx(newaddr,len+1,char);
1169 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1171 /* might not be null terminated */
1172 newaddr[len] = '\0';
1173 return (char *) CopyD(pv,newaddr,len,char);
1176 return (char *) ZeroD(newaddr,len+1,char);
1181 =for apidoc savesharedpv
1183 A version of C<savepv()> which allocates the duplicate string in memory
1184 which is shared between threads.
1189 Perl_savesharedpv(pTHX_ const char *pv)
1194 PERL_UNUSED_CONTEXT;
1199 pvlen = strlen(pv)+1;
1200 newaddr = (char*)PerlMemShared_malloc(pvlen);
1204 return (char*)memcpy(newaddr, pv, pvlen);
1208 =for apidoc savesharedpvn
1210 A version of C<savepvn()> which allocates the duplicate string in memory
1211 which is shared between threads. (With the specific difference that a C<NULL>
1212 pointer is not acceptable)
1217 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1219 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1221 PERL_UNUSED_CONTEXT;
1222 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1227 newaddr[len] = '\0';
1228 return (char*)memcpy(newaddr, pv, len);
1232 =for apidoc savesvpv
1234 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1235 the passed in SV using C<SvPV()>
1237 On some platforms, Windows for example, all allocated memory owned by a thread
1238 is deallocated when that thread ends. So if you need that not to happen, you
1239 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1245 Perl_savesvpv(pTHX_ SV *sv)
1248 const char * const pv = SvPV_const(sv, len);
1251 PERL_ARGS_ASSERT_SAVESVPV;
1254 Newx(newaddr,len,char);
1255 return (char *) CopyD(pv,newaddr,len,char);
1259 =for apidoc savesharedsvpv
1261 A version of C<savesharedpv()> which allocates the duplicate string in
1262 memory which is shared between threads.
1268 Perl_savesharedsvpv(pTHX_ SV *sv)
1271 const char * const pv = SvPV_const(sv, len);
1273 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1275 return savesharedpvn(pv, len);
1278 /* the SV for Perl_form() and mess() is not kept in an arena */
1286 if (PL_phase != PERL_PHASE_DESTRUCT)
1287 return newSVpvs_flags("", SVs_TEMP);
1292 /* Create as PVMG now, to avoid any upgrading later */
1294 Newxz(any, 1, XPVMG);
1295 SvFLAGS(sv) = SVt_PVMG;
1296 SvANY(sv) = (void*)any;
1298 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1303 #if defined(PERL_IMPLICIT_CONTEXT)
1305 Perl_form_nocontext(const char* pat, ...)
1310 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1311 va_start(args, pat);
1312 retval = vform(pat, &args);
1316 #endif /* PERL_IMPLICIT_CONTEXT */
1319 =head1 Miscellaneous Functions
1322 Takes a sprintf-style format pattern and conventional
1323 (non-SV) arguments and returns the formatted string.
1325 (char *) Perl_form(pTHX_ const char* pat, ...)
1327 can be used any place a string (char *) is required:
1329 char * s = Perl_form("%d.%d",major,minor);
1331 Uses a single private buffer so if you want to format several strings you
1332 must explicitly copy the earlier strings away (and free the copies when you
1339 Perl_form(pTHX_ const char* pat, ...)
1343 PERL_ARGS_ASSERT_FORM;
1344 va_start(args, pat);
1345 retval = vform(pat, &args);
1351 Perl_vform(pTHX_ const char *pat, va_list *args)
1353 SV * const sv = mess_alloc();
1354 PERL_ARGS_ASSERT_VFORM;
1355 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1360 =for apidoc Am|SV *|mess|const char *pat|...
1362 Take a sprintf-style format pattern and argument list. These are used to
1363 generate a string message. If the message does not end with a newline,
1364 then it will be extended with some indication of the current location
1365 in the code, as described for L</mess_sv>.
1367 Normally, the resulting message is returned in a new mortal SV.
1368 During global destruction a single SV may be shared between uses of
1374 #if defined(PERL_IMPLICIT_CONTEXT)
1376 Perl_mess_nocontext(const char *pat, ...)
1381 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1382 va_start(args, pat);
1383 retval = vmess(pat, &args);
1387 #endif /* PERL_IMPLICIT_CONTEXT */
1390 Perl_mess(pTHX_ const char *pat, ...)
1394 PERL_ARGS_ASSERT_MESS;
1395 va_start(args, pat);
1396 retval = vmess(pat, &args);
1402 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1405 /* Look for curop starting from o. cop is the last COP we've seen. */
1406 /* opnext means that curop is actually the ->op_next of the op we are
1409 PERL_ARGS_ASSERT_CLOSEST_COP;
1411 if (!o || !curop || (
1412 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1416 if (o->op_flags & OPf_KIDS) {
1418 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1421 /* If the OP_NEXTSTATE has been optimised away we can still use it
1422 * the get the file and line number. */
1424 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1425 cop = (const COP *)kid;
1427 /* Keep searching, and return when we've found something. */
1429 new_cop = closest_cop(cop, kid, curop, opnext);
1435 /* Nothing found. */
1441 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1443 Expands a message, intended for the user, to include an indication of
1444 the current location in the code, if the message does not already appear
1447 C<basemsg> is the initial message or object. If it is a reference, it
1448 will be used as-is and will be the result of this function. Otherwise it
1449 is used as a string, and if it already ends with a newline, it is taken
1450 to be complete, and the result of this function will be the same string.
1451 If the message does not end with a newline, then a segment such as C<at
1452 foo.pl line 37> will be appended, and possibly other clauses indicating
1453 the current state of execution. The resulting message will end with a
1456 Normally, the resulting message is returned in a new mortal SV.
1457 During global destruction a single SV may be shared between uses of this
1458 function. If C<consume> is true, then the function is permitted (but not
1459 required) to modify and return C<basemsg> instead of allocating a new SV.
1465 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1469 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1473 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1474 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1475 && grok_atoUV(ws, &wi, NULL)
1476 && wi <= PERL_INT_MAX
1478 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1483 PERL_ARGS_ASSERT_MESS_SV;
1485 if (SvROK(basemsg)) {
1491 sv_setsv(sv, basemsg);
1496 if (SvPOK(basemsg) && consume) {
1501 sv_copypv(sv, basemsg);
1504 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1506 * Try and find the file and line for PL_op. This will usually be
1507 * PL_curcop, but it might be a cop that has been optimised away. We
1508 * can try to find such a cop by searching through the optree starting
1509 * from the sibling of PL_curcop.
1514 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1519 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1520 OutCopFILE(cop), (IV)CopLINE(cop));
1523 /* Seems that GvIO() can be untrustworthy during global destruction. */
1524 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1525 && IoLINES(GvIOp(PL_last_in_gv)))
1528 const bool line_mode = (RsSIMPLE(PL_rs) &&
1529 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1530 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1531 SVfARG(PL_last_in_gv == PL_argvgv
1533 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1534 line_mode ? "line" : "chunk",
1535 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1537 if (PL_phase == PERL_PHASE_DESTRUCT)
1538 sv_catpvs(sv, " during global destruction");
1539 sv_catpvs(sv, ".\n");
1545 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1547 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1548 argument list, respectively. These are used to generate a string message. If
1550 message does not end with a newline, then it will be extended with
1551 some indication of the current location in the code, as described for
1554 Normally, the resulting message is returned in a new mortal SV.
1555 During global destruction a single SV may be shared between uses of
1562 Perl_vmess(pTHX_ const char *pat, va_list *args)
1564 SV * const sv = mess_alloc();
1566 PERL_ARGS_ASSERT_VMESS;
1568 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1569 return mess_sv(sv, 1);
1573 Perl_write_to_stderr(pTHX_ SV* msv)
1578 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1580 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1581 && (io = GvIO(PL_stderrgv))
1582 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1583 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1584 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1586 PerlIO * const serr = Perl_error_log;
1588 do_print(msv, serr);
1589 (void)PerlIO_flush(serr);
1594 =head1 Warning and Dieing
1597 /* Common code used in dieing and warning */
1600 S_with_queued_errors(pTHX_ SV *ex)
1602 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1603 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1604 sv_catsv(PL_errors, ex);
1605 ex = sv_mortalcopy(PL_errors);
1606 SvCUR_set(PL_errors, 0);
1612 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1617 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1618 /* sv_2cv might call Perl_croak() or Perl_warner() */
1619 SV * const oldhook = *hook;
1627 cv = sv_2cv(oldhook, &stash, &gv, 0);
1629 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1639 exarg = newSVsv(ex);
1640 SvREADONLY_on(exarg);
1643 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1647 call_sv(MUTABLE_SV(cv), G_DISCARD);
1656 =for apidoc Am|OP *|die_sv|SV *baseex
1658 Behaves the same as L</croak_sv>, except for the return type.
1659 It should be used only where the C<OP *> return type is required.
1660 The function never actually returns.
1666 # pragma warning( push )
1667 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1668 __declspec(noreturn) has non-void return type */
1669 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1670 __declspec(noreturn) has a return statement */
1673 Perl_die_sv(pTHX_ SV *baseex)
1675 PERL_ARGS_ASSERT_DIE_SV;
1678 NORETURN_FUNCTION_END;
1681 # pragma warning( pop )
1685 =for apidoc Am|OP *|die|const char *pat|...
1687 Behaves the same as L</croak>, except for the return type.
1688 It should be used only where the C<OP *> return type is required.
1689 The function never actually returns.
1694 #if defined(PERL_IMPLICIT_CONTEXT)
1696 # pragma warning( push )
1697 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1698 __declspec(noreturn) has non-void return type */
1699 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1700 __declspec(noreturn) has a return statement */
1703 Perl_die_nocontext(const char* pat, ...)
1707 va_start(args, pat);
1709 NOT_REACHED; /* NOTREACHED */
1711 NORETURN_FUNCTION_END;
1714 # pragma warning( pop )
1716 #endif /* PERL_IMPLICIT_CONTEXT */
1719 # pragma warning( push )
1720 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1721 __declspec(noreturn) has non-void return type */
1722 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1723 __declspec(noreturn) has a return statement */
1726 Perl_die(pTHX_ const char* pat, ...)
1729 va_start(args, pat);
1731 NOT_REACHED; /* NOTREACHED */
1733 NORETURN_FUNCTION_END;
1736 # pragma warning( pop )
1740 =for apidoc Am|void|croak_sv|SV *baseex
1742 This is an XS interface to Perl's C<die> function.
1744 C<baseex> is the error message or object. If it is a reference, it
1745 will be used as-is. Otherwise it is used as a string, and if it does
1746 not end with a newline then it will be extended with some indication of
1747 the current location in the code, as described for L</mess_sv>.
1749 The error message or object will be used as an exception, by default
1750 returning control to the nearest enclosing C<eval>, but subject to
1751 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1752 function never returns normally.
1754 To die with a simple string message, the L</croak> function may be
1761 Perl_croak_sv(pTHX_ SV *baseex)
1763 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1764 PERL_ARGS_ASSERT_CROAK_SV;
1765 invoke_exception_hook(ex, FALSE);
1770 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1772 This is an XS interface to Perl's C<die> function.
1774 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1775 argument list. These are used to generate a string message. If the
1776 message does not end with a newline, then it will be extended with
1777 some indication of the current location in the code, as described for
1780 The error message will be used as an exception, by default
1781 returning control to the nearest enclosing C<eval>, but subject to
1782 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1783 function never returns normally.
1785 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1786 (C<$@>) will be used as an error message or object instead of building an
1787 error message from arguments. If you want to throw a non-string object,
1788 or build an error message in an SV yourself, it is preferable to use
1789 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1795 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1797 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1798 invoke_exception_hook(ex, FALSE);
1803 =for apidoc Am|void|croak|const char *pat|...
1805 This is an XS interface to Perl's C<die> function.
1807 Take a sprintf-style format pattern and argument list. These are used to
1808 generate a string message. If the message does not end with a newline,
1809 then it will be extended with some indication of the current location
1810 in the code, as described for L</mess_sv>.
1812 The error message will be used as an exception, by default
1813 returning control to the nearest enclosing C<eval>, but subject to
1814 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1815 function never returns normally.
1817 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1818 (C<$@>) will be used as an error message or object instead of building an
1819 error message from arguments. If you want to throw a non-string object,
1820 or build an error message in an SV yourself, it is preferable to use
1821 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1826 #if defined(PERL_IMPLICIT_CONTEXT)
1828 Perl_croak_nocontext(const char *pat, ...)
1832 va_start(args, pat);
1834 NOT_REACHED; /* NOTREACHED */
1837 #endif /* PERL_IMPLICIT_CONTEXT */
1840 Perl_croak(pTHX_ const char *pat, ...)
1843 va_start(args, pat);
1845 NOT_REACHED; /* NOTREACHED */
1850 =for apidoc Am|void|croak_no_modify
1852 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1853 terser object code than using C<Perl_croak>. Less code used on exception code
1854 paths reduces CPU cache pressure.
1860 Perl_croak_no_modify(void)
1862 Perl_croak_nocontext( "%s", PL_no_modify);
1865 /* does not return, used in util.c perlio.c and win32.c
1866 This is typically called when malloc returns NULL.
1869 Perl_croak_no_mem(void)
1873 int fd = PerlIO_fileno(Perl_error_log);
1875 SETERRNO(EBADF,RMS_IFI);
1877 /* Can't use PerlIO to write as it allocates memory */
1878 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1883 /* does not return, used only in POPSTACK */
1885 Perl_croak_popstack(void)
1888 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1893 =for apidoc Am|void|warn_sv|SV *baseex
1895 This is an XS interface to Perl's C<warn> function.
1897 C<baseex> is the error message or object. If it is a reference, it
1898 will be used as-is. Otherwise it is used as a string, and if it does
1899 not end with a newline then it will be extended with some indication of
1900 the current location in the code, as described for L</mess_sv>.
1902 The error message or object will by default be written to standard error,
1903 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1905 To warn with a simple string message, the L</warn> function may be
1912 Perl_warn_sv(pTHX_ SV *baseex)
1914 SV *ex = mess_sv(baseex, 0);
1915 PERL_ARGS_ASSERT_WARN_SV;
1916 if (!invoke_exception_hook(ex, TRUE))
1917 write_to_stderr(ex);
1921 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1923 This is an XS interface to Perl's C<warn> function.
1925 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1926 argument list. These are used to generate a string message. If the
1927 message does not end with a newline, then it will be extended with
1928 some indication of the current location in the code, as described for
1931 The error message or object will by default be written to standard error,
1932 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1934 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1940 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1942 SV *ex = vmess(pat, args);
1943 PERL_ARGS_ASSERT_VWARN;
1944 if (!invoke_exception_hook(ex, TRUE))
1945 write_to_stderr(ex);
1949 =for apidoc Am|void|warn|const char *pat|...
1951 This is an XS interface to Perl's C<warn> function.
1953 Take a sprintf-style format pattern and argument list. These are used to
1954 generate a string message. If the message does not end with a newline,
1955 then it will be extended with some indication of the current location
1956 in the code, as described for L</mess_sv>.
1958 The error message or object will by default be written to standard error,
1959 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1961 Unlike with L</croak>, C<pat> is not permitted to be null.
1966 #if defined(PERL_IMPLICIT_CONTEXT)
1968 Perl_warn_nocontext(const char *pat, ...)
1972 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1973 va_start(args, pat);
1977 #endif /* PERL_IMPLICIT_CONTEXT */
1980 Perl_warn(pTHX_ const char *pat, ...)
1983 PERL_ARGS_ASSERT_WARN;
1984 va_start(args, pat);
1989 #if defined(PERL_IMPLICIT_CONTEXT)
1991 Perl_warner_nocontext(U32 err, const char *pat, ...)
1995 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1996 va_start(args, pat);
1997 vwarner(err, pat, &args);
2000 #endif /* PERL_IMPLICIT_CONTEXT */
2003 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2005 PERL_ARGS_ASSERT_CK_WARNER_D;
2007 if (Perl_ckwarn_d(aTHX_ err)) {
2009 va_start(args, pat);
2010 vwarner(err, pat, &args);
2016 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2018 PERL_ARGS_ASSERT_CK_WARNER;
2020 if (Perl_ckwarn(aTHX_ err)) {
2022 va_start(args, pat);
2023 vwarner(err, pat, &args);
2029 Perl_warner(pTHX_ U32 err, const char* pat,...)
2032 PERL_ARGS_ASSERT_WARNER;
2033 va_start(args, pat);
2034 vwarner(err, pat, &args);
2039 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2042 PERL_ARGS_ASSERT_VWARNER;
2044 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2045 !(PL_in_eval & EVAL_KEEPERR)
2047 SV * const msv = vmess(pat, args);
2049 if (PL_parser && PL_parser->error_count) {
2053 invoke_exception_hook(msv, FALSE);
2058 Perl_vwarn(aTHX_ pat, args);
2062 /* implements the ckWARN? macros */
2065 Perl_ckwarn(pTHX_ U32 w)
2067 /* If lexical warnings have not been set, use $^W. */
2069 return PL_dowarn & G_WARN_ON;
2071 return ckwarn_common(w);
2074 /* implements the ckWARN?_d macro */
2077 Perl_ckwarn_d(pTHX_ U32 w)
2079 /* If lexical warnings have not been set then default classes warn. */
2083 return ckwarn_common(w);
2087 S_ckwarn_common(pTHX_ U32 w)
2089 if (PL_curcop->cop_warnings == pWARN_ALL)
2092 if (PL_curcop->cop_warnings == pWARN_NONE)
2095 /* Check the assumption that at least the first slot is non-zero. */
2096 assert(unpackWARN1(w));
2098 /* Check the assumption that it is valid to stop as soon as a zero slot is
2100 if (!unpackWARN2(w)) {
2101 assert(!unpackWARN3(w));
2102 assert(!unpackWARN4(w));
2103 } else if (!unpackWARN3(w)) {
2104 assert(!unpackWARN4(w));
2107 /* Right, dealt with all the special cases, which are implemented as non-
2108 pointers, so there is a pointer to a real warnings mask. */
2110 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2112 } while (w >>= WARNshift);
2117 /* Set buffer=NULL to get a new one. */
2119 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2121 const MEM_SIZE len_wanted =
2122 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2123 PERL_UNUSED_CONTEXT;
2124 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2127 (specialWARN(buffer) ?
2128 PerlMemShared_malloc(len_wanted) :
2129 PerlMemShared_realloc(buffer, len_wanted));
2131 Copy(bits, (buffer + 1), size, char);
2132 if (size < WARNsize)
2133 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2137 /* since we've already done strlen() for both nam and val
2138 * we can use that info to make things faster than
2139 * sprintf(s, "%s=%s", nam, val)
2141 #define my_setenv_format(s, nam, nlen, val, vlen) \
2142 Copy(nam, s, nlen, char); \
2144 Copy(val, s+(nlen+1), vlen, char); \
2145 *(s+(nlen+1+vlen)) = '\0'
2147 #ifdef USE_ENVIRON_ARRAY
2148 /* VMS' my_setenv() is in vms.c */
2149 #if !defined(WIN32) && !defined(NETWARE)
2151 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2155 amigaos4_obtain_environ(__FUNCTION__);
2158 /* only parent thread can modify process environment */
2159 if (PL_curinterp == aTHX)
2162 #ifndef PERL_USE_SAFE_PUTENV
2163 if (!PL_use_safe_putenv) {
2164 /* most putenv()s leak, so we manipulate environ directly */
2166 const I32 len = strlen(nam);
2169 /* where does it go? */
2170 for (i = 0; environ[i]; i++) {
2171 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2175 if (environ == PL_origenviron) { /* need we copy environment? */
2181 while (environ[max])
2183 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2184 for (j=0; j<max; j++) { /* copy environment */
2185 const int len = strlen(environ[j]);
2186 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2187 Copy(environ[j], tmpenv[j], len+1, char);
2190 environ = tmpenv; /* tell exec where it is now */
2193 safesysfree(environ[i]);
2194 while (environ[i]) {
2195 environ[i] = environ[i+1];
2204 if (!environ[i]) { /* does not exist yet */
2205 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2206 environ[i+1] = NULL; /* make sure it's null terminated */
2209 safesysfree(environ[i]);
2213 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2214 /* all that work just for this */
2215 my_setenv_format(environ[i], nam, nlen, val, vlen);
2218 /* This next branch should only be called #if defined(HAS_SETENV), but
2219 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2220 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2222 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2223 # if defined(HAS_UNSETENV)
2225 (void)unsetenv(nam);
2227 (void)setenv(nam, val, 1);
2229 # else /* ! HAS_UNSETENV */
2230 (void)setenv(nam, val, 1);
2231 # endif /* HAS_UNSETENV */
2233 # if defined(HAS_UNSETENV)
2235 if (environ) /* old glibc can crash with null environ */
2236 (void)unsetenv(nam);
2238 const int nlen = strlen(nam);
2239 const int vlen = strlen(val);
2240 char * const new_env =
2241 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2242 my_setenv_format(new_env, nam, nlen, val, vlen);
2243 (void)putenv(new_env);
2245 # else /* ! HAS_UNSETENV */
2247 const int nlen = strlen(nam);
2253 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2254 /* all that work just for this */
2255 my_setenv_format(new_env, nam, nlen, val, vlen);
2256 (void)putenv(new_env);
2257 # endif /* HAS_UNSETENV */
2258 # endif /* __CYGWIN__ */
2259 #ifndef PERL_USE_SAFE_PUTENV
2265 amigaos4_release_environ(__FUNCTION__);
2269 #else /* WIN32 || NETWARE */
2272 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2276 const int nlen = strlen(nam);
2283 Newx(envstr, nlen+vlen+2, char);
2284 my_setenv_format(envstr, nam, nlen, val, vlen);
2285 (void)PerlEnv_putenv(envstr);
2289 #endif /* WIN32 || NETWARE */
2293 #ifdef UNLINK_ALL_VERSIONS
2295 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2299 PERL_ARGS_ASSERT_UNLNK;
2301 while (PerlLIO_unlink(f) >= 0)
2303 return retries ? 0 : -1;
2307 /* this is a drop-in replacement for bcopy(), except for the return
2308 * value, which we need to be able to emulate memcpy() */
2309 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2311 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2313 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2314 bcopy(vfrom, vto, len);
2316 const unsigned char *from = (const unsigned char *)vfrom;
2317 unsigned char *to = (unsigned char *)vto;
2319 PERL_ARGS_ASSERT_MY_BCOPY;
2321 if (from - to >= 0) {
2329 *(--to) = *(--from);
2337 /* this is a drop-in replacement for memset() */
2340 Perl_my_memset(void *vloc, int ch, size_t len)
2342 unsigned char *loc = (unsigned char *)vloc;
2344 PERL_ARGS_ASSERT_MY_MEMSET;
2352 /* this is a drop-in replacement for bzero() */
2353 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2355 Perl_my_bzero(void *vloc, size_t len)
2357 unsigned char *loc = (unsigned char *)vloc;
2359 PERL_ARGS_ASSERT_MY_BZERO;
2367 /* this is a drop-in replacement for memcmp() */
2368 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2370 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2372 const U8 *a = (const U8 *)vs1;
2373 const U8 *b = (const U8 *)vs2;
2376 PERL_ARGS_ASSERT_MY_MEMCMP;
2379 if ((tmp = *a++ - *b++))
2384 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2387 /* This vsprintf replacement should generally never get used, since
2388 vsprintf was available in both System V and BSD 2.11. (There may
2389 be some cross-compilation or embedded set-ups where it is needed,
2392 If you encounter a problem in this function, it's probably a symptom
2393 that Configure failed to detect your system's vprintf() function.
2394 See the section on "item vsprintf" in the INSTALL file.
2396 This version may compile on systems with BSD-ish <stdio.h>,
2397 but probably won't on others.
2400 #ifdef USE_CHAR_VSPRINTF
2405 vsprintf(char *dest, const char *pat, void *args)
2409 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2410 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2411 FILE_cnt(&fakebuf) = 32767;
2413 /* These probably won't compile -- If you really need
2414 this, you'll have to figure out some other method. */
2415 fakebuf._ptr = dest;
2416 fakebuf._cnt = 32767;
2421 fakebuf._flag = _IOWRT|_IOSTRG;
2422 _doprnt(pat, args, &fakebuf); /* what a kludge */
2423 #if defined(STDIO_PTR_LVALUE)
2424 *(FILE_ptr(&fakebuf)++) = '\0';
2426 /* PerlIO has probably #defined away fputc, but we want it here. */
2428 # undef fputc /* XXX Should really restore it later */
2430 (void)fputc('\0', &fakebuf);
2432 #ifdef USE_CHAR_VSPRINTF
2435 return 0; /* perl doesn't use return value */
2439 #endif /* HAS_VPRINTF */
2442 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2444 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2452 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2454 PERL_FLUSHALL_FOR_CHILD;
2455 This = (*mode == 'w');
2459 taint_proper("Insecure %s%s", "EXEC");
2461 if (PerlProc_pipe(p) < 0)
2463 /* Try for another pipe pair for error return */
2464 if (PerlProc_pipe(pp) >= 0)
2466 while ((pid = PerlProc_fork()) < 0) {
2467 if (errno != EAGAIN) {
2468 PerlLIO_close(p[This]);
2469 PerlLIO_close(p[that]);
2471 PerlLIO_close(pp[0]);
2472 PerlLIO_close(pp[1]);
2476 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2485 /* Close parent's end of error status pipe (if any) */
2487 PerlLIO_close(pp[0]);
2488 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2489 /* Close error pipe automatically if exec works */
2490 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2494 /* Now dup our end of _the_ pipe to right position */
2495 if (p[THIS] != (*mode == 'r')) {
2496 PerlLIO_dup2(p[THIS], *mode == 'r');
2497 PerlLIO_close(p[THIS]);
2498 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2499 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2502 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2503 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2504 /* No automatic close - do it by hand */
2511 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2517 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2523 do_execfree(); /* free any memory malloced by child on fork */
2525 PerlLIO_close(pp[1]);
2526 /* Keep the lower of the two fd numbers */
2527 if (p[that] < p[This]) {
2528 PerlLIO_dup2(p[This], p[that]);
2529 PerlLIO_close(p[This]);
2533 PerlLIO_close(p[that]); /* close child's end of pipe */
2535 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2536 SvUPGRADE(sv,SVt_IV);
2538 PL_forkprocess = pid;
2539 /* If we managed to get status pipe check for exec fail */
2540 if (did_pipes && pid > 0) {
2545 while (n < sizeof(int)) {
2546 n1 = PerlLIO_read(pp[0],
2547 (void*)(((char*)&errkid)+n),
2553 PerlLIO_close(pp[0]);
2555 if (n) { /* Error */
2557 PerlLIO_close(p[This]);
2558 if (n != sizeof(int))
2559 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2561 pid2 = wait4pid(pid, &status, 0);
2562 } while (pid2 == -1 && errno == EINTR);
2563 errno = errkid; /* Propagate errno from kid */
2568 PerlLIO_close(pp[0]);
2569 return PerlIO_fdopen(p[This], mode);
2571 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2572 return my_syspopen4(aTHX_ NULL, mode, n, args);
2573 # elif defined(WIN32)
2574 return win32_popenlist(mode, n, args);
2576 Perl_croak(aTHX_ "List form of piped open not implemented");
2577 return (PerlIO *) NULL;
2582 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2583 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2585 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2591 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2595 PERL_ARGS_ASSERT_MY_POPEN;
2597 PERL_FLUSHALL_FOR_CHILD;
2600 return my_syspopen(aTHX_ cmd,mode);
2603 This = (*mode == 'w');
2605 if (doexec && TAINTING_get) {
2607 taint_proper("Insecure %s%s", "EXEC");
2609 if (PerlProc_pipe(p) < 0)
2611 if (doexec && PerlProc_pipe(pp) >= 0)
2613 while ((pid = PerlProc_fork()) < 0) {
2614 if (errno != EAGAIN) {
2615 PerlLIO_close(p[This]);
2616 PerlLIO_close(p[that]);
2618 PerlLIO_close(pp[0]);
2619 PerlLIO_close(pp[1]);
2622 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2625 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2635 PerlLIO_close(pp[0]);
2636 #if defined(HAS_FCNTL) && defined(F_SETFD)
2637 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2641 if (p[THIS] != (*mode == 'r')) {
2642 PerlLIO_dup2(p[THIS], *mode == 'r');
2643 PerlLIO_close(p[THIS]);
2644 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2645 PerlLIO_close(p[THAT]);
2648 PerlLIO_close(p[THAT]);
2651 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2658 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2663 /* may or may not use the shell */
2664 do_exec3(cmd, pp[1], did_pipes);
2667 #endif /* defined OS2 */
2669 #ifdef PERLIO_USING_CRLF
2670 /* Since we circumvent IO layers when we manipulate low-level
2671 filedescriptors directly, need to manually switch to the
2672 default, binary, low-level mode; see PerlIOBuf_open(). */
2673 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2676 #ifdef PERL_USES_PL_PIDSTATUS
2677 hv_clear(PL_pidstatus); /* we have no children */
2683 do_execfree(); /* free any memory malloced by child on vfork */
2685 PerlLIO_close(pp[1]);
2686 if (p[that] < p[This]) {
2687 PerlLIO_dup2(p[This], p[that]);
2688 PerlLIO_close(p[This]);
2692 PerlLIO_close(p[that]);
2694 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2695 SvUPGRADE(sv,SVt_IV);
2697 PL_forkprocess = pid;
2698 if (did_pipes && pid > 0) {
2703 while (n < sizeof(int)) {
2704 n1 = PerlLIO_read(pp[0],
2705 (void*)(((char*)&errkid)+n),
2711 PerlLIO_close(pp[0]);
2713 if (n) { /* Error */
2715 PerlLIO_close(p[This]);
2716 if (n != sizeof(int))
2717 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2719 pid2 = wait4pid(pid, &status, 0);
2720 } while (pid2 == -1 && errno == EINTR);
2721 errno = errkid; /* Propagate errno from kid */
2726 PerlLIO_close(pp[0]);
2727 return PerlIO_fdopen(p[This], mode);
2731 FILE *djgpp_popen();
2733 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2735 PERL_FLUSHALL_FOR_CHILD;
2736 /* Call system's popen() to get a FILE *, then import it.
2737 used 0 for 2nd parameter to PerlIO_importFILE;
2740 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2743 #if defined(__LIBCATAMOUNT__)
2745 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2752 #endif /* !DOSISH */
2754 /* this is called in parent before the fork() */
2756 Perl_atfork_lock(void)
2757 #if defined(USE_ITHREADS)
2759 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2762 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2764 PERL_TSA_ACQUIRE(PL_op_mutex)
2767 #if defined(USE_ITHREADS)
2769 /* locks must be held in locking order (if any) */
2771 MUTEX_LOCK(&PL_perlio_mutex);
2774 MUTEX_LOCK(&PL_malloc_mutex);
2780 /* this is called in both parent and child after the fork() */
2782 Perl_atfork_unlock(void)
2783 #if defined(USE_ITHREADS)
2785 PERL_TSA_RELEASE(PL_perlio_mutex)
2788 PERL_TSA_RELEASE(PL_malloc_mutex)
2790 PERL_TSA_RELEASE(PL_op_mutex)
2793 #if defined(USE_ITHREADS)
2795 /* locks must be released in same order as in atfork_lock() */
2797 MUTEX_UNLOCK(&PL_perlio_mutex);
2800 MUTEX_UNLOCK(&PL_malloc_mutex);
2809 #if defined(HAS_FORK)
2811 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2816 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2817 * handlers elsewhere in the code */
2821 #elif defined(__amigaos4__)
2822 return amigaos_fork();
2824 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2825 Perl_croak_nocontext("fork() not available");
2827 #endif /* HAS_FORK */
2832 dup2(int oldfd, int newfd)
2834 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2837 PerlLIO_close(newfd);
2838 return fcntl(oldfd, F_DUPFD, newfd);
2840 #define DUP2_MAX_FDS 256
2841 int fdtmp[DUP2_MAX_FDS];
2847 PerlLIO_close(newfd);
2848 /* good enough for low fd's... */
2849 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2850 if (fdx >= DUP2_MAX_FDS) {
2858 PerlLIO_close(fdtmp[--fdx]);
2865 #ifdef HAS_SIGACTION
2868 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2870 struct sigaction act, oact;
2874 /* only "parent" interpreter can diddle signals */
2875 if (PL_curinterp != aTHX)
2876 return (Sighandler_t) SIG_ERR;
2879 act.sa_handler = (void(*)(int))handler;
2880 sigemptyset(&act.sa_mask);
2883 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2884 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2886 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2887 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2888 act.sa_flags |= SA_NOCLDWAIT;
2890 if (sigaction(signo, &act, &oact) == -1)
2891 return (Sighandler_t) SIG_ERR;
2893 return (Sighandler_t) oact.sa_handler;
2897 Perl_rsignal_state(pTHX_ int signo)
2899 struct sigaction oact;
2900 PERL_UNUSED_CONTEXT;
2902 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2903 return (Sighandler_t) SIG_ERR;
2905 return (Sighandler_t) oact.sa_handler;
2909 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2914 struct sigaction act;
2916 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2919 /* only "parent" interpreter can diddle signals */
2920 if (PL_curinterp != aTHX)
2924 act.sa_handler = (void(*)(int))handler;
2925 sigemptyset(&act.sa_mask);
2928 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2929 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2931 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2932 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2933 act.sa_flags |= SA_NOCLDWAIT;
2935 return sigaction(signo, &act, save);
2939 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2944 PERL_UNUSED_CONTEXT;
2946 /* only "parent" interpreter can diddle signals */
2947 if (PL_curinterp != aTHX)
2951 return sigaction(signo, save, (struct sigaction *)NULL);
2954 #else /* !HAS_SIGACTION */
2957 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2959 #if defined(USE_ITHREADS) && !defined(WIN32)
2960 /* only "parent" interpreter can diddle signals */
2961 if (PL_curinterp != aTHX)
2962 return (Sighandler_t) SIG_ERR;
2965 return PerlProc_signal(signo, handler);
2976 Perl_rsignal_state(pTHX_ int signo)
2979 Sighandler_t oldsig;
2981 #if defined(USE_ITHREADS) && !defined(WIN32)
2982 /* only "parent" interpreter can diddle signals */
2983 if (PL_curinterp != aTHX)
2984 return (Sighandler_t) SIG_ERR;
2988 oldsig = PerlProc_signal(signo, sig_trap);
2989 PerlProc_signal(signo, oldsig);
2991 PerlProc_kill(PerlProc_getpid(), signo);
2996 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2998 #if defined(USE_ITHREADS) && !defined(WIN32)
2999 /* only "parent" interpreter can diddle signals */
3000 if (PL_curinterp != aTHX)
3003 *save = PerlProc_signal(signo, handler);
3004 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3008 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3010 #if defined(USE_ITHREADS) && !defined(WIN32)
3011 /* only "parent" interpreter can diddle signals */
3012 if (PL_curinterp != aTHX)
3015 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3018 #endif /* !HAS_SIGACTION */
3019 #endif /* !PERL_MICRO */
3021 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3022 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3024 Perl_my_pclose(pTHX_ PerlIO *ptr)
3032 const int fd = PerlIO_fileno(ptr);
3035 svp = av_fetch(PL_fdpid,fd,TRUE);
3036 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3040 #if defined(USE_PERLIO)
3041 /* Find out whether the refcount is low enough for us to wait for the
3042 child proc without blocking. */
3043 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3045 should_wait = pid > 0;
3049 if (pid == -1) { /* Opened by popen. */
3050 return my_syspclose(ptr);
3053 close_failed = (PerlIO_close(ptr) == EOF);
3055 if (should_wait) do {
3056 pid2 = wait4pid(pid, &status, 0);
3057 } while (pid2 == -1 && errno == EINTR);
3064 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3069 #if defined(__LIBCATAMOUNT__)
3071 Perl_my_pclose(pTHX_ PerlIO *ptr)
3076 #endif /* !DOSISH */
3078 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3080 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3083 PERL_ARGS_ASSERT_WAIT4PID;
3084 #ifdef PERL_USES_PL_PIDSTATUS
3086 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3087 waitpid() nor wait4() is available, or on OS/2, which
3088 doesn't appear to support waiting for a progress group
3089 member, so we can only treat a 0 pid as an unknown child.
3096 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3097 pid, rather than a string form. */
3098 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3099 if (svp && *svp != &PL_sv_undef) {
3100 *statusp = SvIVX(*svp);
3101 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3109 hv_iterinit(PL_pidstatus);
3110 if ((entry = hv_iternext(PL_pidstatus))) {
3111 SV * const sv = hv_iterval(PL_pidstatus,entry);
3113 const char * const spid = hv_iterkey(entry,&len);
3115 assert (len == sizeof(Pid_t));
3116 memcpy((char *)&pid, spid, len);
3117 *statusp = SvIVX(sv);
3118 /* The hash iterator is currently on this entry, so simply
3119 calling hv_delete would trigger the lazy delete, which on
3120 aggregate does more work, because next call to hv_iterinit()
3121 would spot the flag, and have to call the delete routine,
3122 while in the meantime any new entries can't re-use that
3124 hv_iterinit(PL_pidstatus);
3125 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3132 # ifdef HAS_WAITPID_RUNTIME
3133 if (!HAS_WAITPID_RUNTIME)
3136 result = PerlProc_waitpid(pid,statusp,flags);
3139 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3140 result = wait4(pid,statusp,flags,NULL);
3143 #ifdef PERL_USES_PL_PIDSTATUS
3144 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3149 Perl_croak(aTHX_ "Can't do waitpid with flags");
3151 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3152 pidgone(result,*statusp);
3158 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3161 if (result < 0 && errno == EINTR) {
3163 errno = EINTR; /* reset in case a signal handler changed $! */
3167 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3169 #ifdef PERL_USES_PL_PIDSTATUS
3171 S_pidgone(pTHX_ Pid_t pid, int status)
3175 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3176 SvUPGRADE(sv,SVt_IV);
3177 SvIV_set(sv, status);
3185 int /* Cannot prototype with I32
3187 my_syspclose(PerlIO *ptr)
3190 Perl_my_pclose(pTHX_ PerlIO *ptr)
3193 /* Needs work for PerlIO ! */
3194 FILE * const f = PerlIO_findFILE(ptr);
3195 const I32 result = pclose(f);
3196 PerlIO_releaseFILE(ptr,f);
3204 Perl_my_pclose(pTHX_ PerlIO *ptr)
3206 /* Needs work for PerlIO ! */
3207 FILE * const f = PerlIO_findFILE(ptr);
3208 I32 result = djgpp_pclose(f);
3209 result = (result << 8) & 0xff00;
3210 PerlIO_releaseFILE(ptr,f);
3215 #define PERL_REPEATCPY_LINEAR 4
3217 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3219 PERL_ARGS_ASSERT_REPEATCPY;
3224 croak_memory_wrap();
3227 memset(to, *from, count);
3230 IV items, linear, half;
3232 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3233 for (items = 0; items < linear; ++items) {
3234 const char *q = from;
3236 for (todo = len; todo > 0; todo--)
3241 while (items <= half) {
3242 IV size = items * len;
3243 memcpy(p, to, size);
3249 memcpy(p, to, (count - items) * len);
3255 Perl_same_dirent(pTHX_ const char *a, const char *b)
3257 char *fa = strrchr(a,'/');
3258 char *fb = strrchr(b,'/');
3261 SV * const tmpsv = sv_newmortal();
3263 PERL_ARGS_ASSERT_SAME_DIRENT;
3276 sv_setpvs(tmpsv, ".");
3278 sv_setpvn(tmpsv, a, fa - a);
3279 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3282 sv_setpvs(tmpsv, ".");
3284 sv_setpvn(tmpsv, b, fb - b);
3285 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3287 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3288 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3290 #endif /* !HAS_RENAME */
3293 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3294 const char *const *const search_ext, I32 flags)
3296 const char *xfound = NULL;
3297 char *xfailed = NULL;
3298 char tmpbuf[MAXPATHLEN];
3303 #if defined(DOSISH) && !defined(OS2)
3304 # define SEARCH_EXTS ".bat", ".cmd", NULL
3305 # define MAX_EXT_LEN 4
3308 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3309 # define MAX_EXT_LEN 4
3312 # define SEARCH_EXTS ".pl", ".com", NULL
3313 # define MAX_EXT_LEN 4
3315 /* additional extensions to try in each dir if scriptname not found */
3317 static const char *const exts[] = { SEARCH_EXTS };
3318 const char *const *const ext = search_ext ? search_ext : exts;
3319 int extidx = 0, i = 0;
3320 const char *curext = NULL;
3322 PERL_UNUSED_ARG(search_ext);
3323 # define MAX_EXT_LEN 0
3326 PERL_ARGS_ASSERT_FIND_SCRIPT;
3329 * If dosearch is true and if scriptname does not contain path
3330 * delimiters, search the PATH for scriptname.
3332 * If SEARCH_EXTS is also defined, will look for each
3333 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3334 * while searching the PATH.
3336 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3337 * proceeds as follows:
3338 * If DOSISH or VMSISH:
3339 * + look for ./scriptname{,.foo,.bar}
3340 * + search the PATH for scriptname{,.foo,.bar}
3343 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3344 * this will not look in '.' if it's not in the PATH)
3349 # ifdef ALWAYS_DEFTYPES
3350 len = strlen(scriptname);
3351 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3352 int idx = 0, deftypes = 1;
3355 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3358 int idx = 0, deftypes = 1;
3361 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3363 /* The first time through, just add SEARCH_EXTS to whatever we
3364 * already have, so we can check for default file types. */
3366 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3373 if ((strlen(tmpbuf) + strlen(scriptname)
3374 + MAX_EXT_LEN) >= sizeof tmpbuf)
3375 continue; /* don't search dir with too-long name */
3376 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3380 if (strEQ(scriptname, "-"))
3382 if (dosearch) { /* Look in '.' first. */
3383 const char *cur = scriptname;
3385 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3387 if (strEQ(ext[i++],curext)) {
3388 extidx = -1; /* already has an ext */
3393 DEBUG_p(PerlIO_printf(Perl_debug_log,
3394 "Looking for %s\n",cur));
3397 if (PerlLIO_stat(cur,&statbuf) >= 0
3398 && !S_ISDIR(statbuf.st_mode)) {
3407 if (cur == scriptname) {
3408 len = strlen(scriptname);
3409 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3411 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3414 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3415 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3420 if (dosearch && !strchr(scriptname, '/')
3422 && !strchr(scriptname, '\\')
3424 && (s = PerlEnv_getenv("PATH")))
3428 bufend = s + strlen(s);
3429 while (s < bufend) {
3433 && *s != ';'; len++, s++) {
3434 if (len < sizeof tmpbuf)
3437 if (len < sizeof tmpbuf)
3440 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3446 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3447 continue; /* don't search dir with too-long name */
3450 && tmpbuf[len - 1] != '/'
3451 && tmpbuf[len - 1] != '\\'
3454 tmpbuf[len++] = '/';
3455 if (len == 2 && tmpbuf[0] == '.')
3457 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3461 len = strlen(tmpbuf);
3462 if (extidx > 0) /* reset after previous loop */
3466 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3467 retval = PerlLIO_stat(tmpbuf,&statbuf);
3468 if (S_ISDIR(statbuf.st_mode)) {
3472 } while ( retval < 0 /* not there */
3473 && extidx>=0 && ext[extidx] /* try an extension? */
3474 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3479 if (S_ISREG(statbuf.st_mode)
3480 && cando(S_IRUSR,TRUE,&statbuf)
3481 #if !defined(DOSISH)
3482 && cando(S_IXUSR,TRUE,&statbuf)
3486 xfound = tmpbuf; /* bingo! */
3490 xfailed = savepv(tmpbuf);
3495 if (!xfound && !seen_dot && !xfailed &&
3496 (PerlLIO_stat(scriptname,&statbuf) < 0
3497 || S_ISDIR(statbuf.st_mode)))
3499 seen_dot = 1; /* Disable message. */
3504 if (flags & 1) { /* do or die? */
3505 /* diag_listed_as: Can't execute %s */
3506 Perl_croak(aTHX_ "Can't %s %s%s%s",
3507 (xfailed ? "execute" : "find"),
3508 (xfailed ? xfailed : scriptname),
3509 (xfailed ? "" : " on PATH"),
3510 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3515 scriptname = xfound;
3517 return (scriptname ? savepv(scriptname) : NULL);
3520 #ifndef PERL_GET_CONTEXT_DEFINED
3523 Perl_get_context(void)
3525 #if defined(USE_ITHREADS)
3527 # ifdef OLD_PTHREADS_API
3529 int error = pthread_getspecific(PL_thr_key, &t)
3531 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3534 # ifdef I_MACH_CTHREADS
3535 return (void*)cthread_data(cthread_self());
3537 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3546 Perl_set_context(void *t)
3548 #if defined(USE_ITHREADS)
3551 PERL_ARGS_ASSERT_SET_CONTEXT;
3552 #if defined(USE_ITHREADS)
3553 # ifdef I_MACH_CTHREADS
3554 cthread_set_data(cthread_self(), t);
3557 const int error = pthread_setspecific(PL_thr_key, t);
3559 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3567 #endif /* !PERL_GET_CONTEXT_DEFINED */
3569 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3573 PERL_UNUSED_CONTEXT;
3579 Perl_get_op_names(pTHX)
3581 PERL_UNUSED_CONTEXT;
3582 return (char **)PL_op_name;
3586 Perl_get_op_descs(pTHX)
3588 PERL_UNUSED_CONTEXT;
3589 return (char **)PL_op_desc;
3593 Perl_get_no_modify(pTHX)
3595 PERL_UNUSED_CONTEXT;
3596 return PL_no_modify;
3600 Perl_get_opargs(pTHX)
3602 PERL_UNUSED_CONTEXT;
3603 return (U32 *)PL_opargs;
3607 Perl_get_ppaddr(pTHX)
3610 PERL_UNUSED_CONTEXT;
3611 return (PPADDR_t*)PL_ppaddr;
3614 #ifndef HAS_GETENV_LEN
3616 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3618 char * const env_trans = PerlEnv_getenv(env_elem);
3619 PERL_UNUSED_CONTEXT;
3620 PERL_ARGS_ASSERT_GETENV_LEN;
3622 *len = strlen(env_trans);
3629 Perl_get_vtbl(pTHX_ int vtbl_id)
3631 PERL_UNUSED_CONTEXT;
3633 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3634 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3638 Perl_my_fflush_all(pTHX)
3640 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3641 return PerlIO_flush(NULL);
3643 # if defined(HAS__FWALK)
3644 extern int fflush(FILE *);
3645 /* undocumented, unprototyped, but very useful BSDism */
3646 extern void _fwalk(int (*)(FILE *));
3650 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3652 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3653 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3655 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3656 open_max = sysconf(_SC_OPEN_MAX);
3659 open_max = FOPEN_MAX;
3662 open_max = OPEN_MAX;
3673 for (i = 0; i < open_max; i++)
3674 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3675 STDIO_STREAM_ARRAY[i]._file < open_max &&
3676 STDIO_STREAM_ARRAY[i]._flag)
3677 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3681 SETERRNO(EBADF,RMS_IFI);
3688 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3690 if (ckWARN(WARN_IO)) {
3692 = gv && (isGV_with_GP(gv))
3695 const char * const direction = have == '>' ? "out" : "in";
3697 if (name && HEK_LEN(name))
3698 Perl_warner(aTHX_ packWARN(WARN_IO),
3699 "Filehandle %" HEKf " opened only for %sput",
3700 HEKfARG(name), direction);
3702 Perl_warner(aTHX_ packWARN(WARN_IO),
3703 "Filehandle opened only for %sput", direction);
3708 Perl_report_evil_fh(pTHX_ const GV *gv)
3710 const IO *io = gv ? GvIO(gv) : NULL;
3711 const PERL_BITFIELD16 op = PL_op->op_type;
3715 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3717 warn_type = WARN_CLOSED;
3721 warn_type = WARN_UNOPENED;
3724 if (ckWARN(warn_type)) {
3726 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3727 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3728 const char * const pars =
3729 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3730 const char * const func =
3732 (op == OP_READLINE || op == OP_RCATLINE
3733 ? "readline" : /* "<HANDLE>" not nice */
3734 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3736 const char * const type =
3738 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3739 ? "socket" : "filehandle");
3740 const bool have_name = name && SvCUR(name);
3741 Perl_warner(aTHX_ packWARN(warn_type),
3742 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3743 have_name ? " " : "",
3744 SVfARG(have_name ? name : &PL_sv_no));
3745 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3747 aTHX_ packWARN(warn_type),
3748 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3749 func, pars, have_name ? " " : "",
3750 SVfARG(have_name ? name : &PL_sv_no)
3755 /* To workaround core dumps from the uninitialised tm_zone we get the
3756 * system to give us a reasonable struct to copy. This fix means that
3757 * strftime uses the tm_zone and tm_gmtoff values returned by
3758 * localtime(time()). That should give the desired result most of the
3759 * time. But probably not always!
3761 * This does not address tzname aspects of NETaa14816.
3766 # ifndef STRUCT_TM_HASZONE
3767 # define STRUCT_TM_HASZONE
3771 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3772 # ifndef HAS_TM_TM_ZONE
3773 # define HAS_TM_TM_ZONE
3778 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3780 #ifdef HAS_TM_TM_ZONE
3782 const struct tm* my_tm;
3783 PERL_UNUSED_CONTEXT;
3784 PERL_ARGS_ASSERT_INIT_TM;
3786 my_tm = localtime(&now);
3788 Copy(my_tm, ptm, 1, struct tm);
3790 PERL_UNUSED_CONTEXT;
3791 PERL_ARGS_ASSERT_INIT_TM;
3792 PERL_UNUSED_ARG(ptm);
3797 * mini_mktime - normalise struct tm values without the localtime()
3798 * semantics (and overhead) of mktime().
3801 Perl_mini_mktime(struct tm *ptm)
3805 int month, mday, year, jday;
3806 int odd_cent, odd_year;
3808 PERL_ARGS_ASSERT_MINI_MKTIME;
3810 #define DAYS_PER_YEAR 365
3811 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3812 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3813 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3814 #define SECS_PER_HOUR (60*60)
3815 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3816 /* parentheses deliberately absent on these two, otherwise they don't work */
3817 #define MONTH_TO_DAYS 153/5
3818 #define DAYS_TO_MONTH 5/153
3819 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3820 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3821 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3822 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3825 * Year/day algorithm notes:
3827 * With a suitable offset for numeric value of the month, one can find
3828 * an offset into the year by considering months to have 30.6 (153/5) days,
3829 * using integer arithmetic (i.e., with truncation). To avoid too much
3830 * messing about with leap days, we consider January and February to be
3831 * the 13th and 14th month of the previous year. After that transformation,
3832 * we need the month index we use to be high by 1 from 'normal human' usage,
3833 * so the month index values we use run from 4 through 15.
3835 * Given that, and the rules for the Gregorian calendar (leap years are those
3836 * divisible by 4 unless also divisible by 100, when they must be divisible
3837 * by 400 instead), we can simply calculate the number of days since some
3838 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3839 * the days we derive from our month index, and adding in the day of the
3840 * month. The value used here is not adjusted for the actual origin which
3841 * it normally would use (1 January A.D. 1), since we're not exposing it.
3842 * We're only building the value so we can turn around and get the
3843 * normalised values for the year, month, day-of-month, and day-of-year.
3845 * For going backward, we need to bias the value we're using so that we find
3846 * the right year value. (Basically, we don't want the contribution of
3847 * March 1st to the number to apply while deriving the year). Having done
3848 * that, we 'count up' the contribution to the year number by accounting for
3849 * full quadracenturies (400-year periods) with their extra leap days, plus
3850 * the contribution from full centuries (to avoid counting in the lost leap
3851 * days), plus the contribution from full quad-years (to count in the normal
3852 * leap days), plus the leftover contribution from any non-leap years.
3853 * At this point, if we were working with an actual leap day, we'll have 0
3854 * days left over. This is also true for March 1st, however. So, we have
3855 * to special-case that result, and (earlier) keep track of the 'odd'
3856 * century and year contributions. If we got 4 extra centuries in a qcent,
3857 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3858 * Otherwise, we add back in the earlier bias we removed (the 123 from
3859 * figuring in March 1st), find the month index (integer division by 30.6),
3860 * and the remainder is the day-of-month. We then have to convert back to
3861 * 'real' months (including fixing January and February from being 14/15 in
3862 * the previous year to being in the proper year). After that, to get
3863 * tm_yday, we work with the normalised year and get a new yearday value for
3864 * January 1st, which we subtract from the yearday value we had earlier,
3865 * representing the date we've re-built. This is done from January 1
3866 * because tm_yday is 0-origin.
3868 * Since POSIX time routines are only guaranteed to work for times since the
3869 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3870 * applies Gregorian calendar rules even to dates before the 16th century
3871 * doesn't bother me. Besides, you'd need cultural context for a given
3872 * date to know whether it was Julian or Gregorian calendar, and that's
3873 * outside the scope for this routine. Since we convert back based on the
3874 * same rules we used to build the yearday, you'll only get strange results
3875 * for input which needed normalising, or for the 'odd' century years which
3876 * were leap years in the Julian calendar but not in the Gregorian one.
3877 * I can live with that.
3879 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3880 * that's still outside the scope for POSIX time manipulation, so I don't
3884 year = 1900 + ptm->tm_year;
3885 month = ptm->tm_mon;
3886 mday = ptm->tm_mday;
3892 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3893 yearday += month*MONTH_TO_DAYS + mday + jday;
3895 * Note that we don't know when leap-seconds were or will be,
3896 * so we have to trust the user if we get something which looks
3897 * like a sensible leap-second. Wild values for seconds will
3898 * be rationalised, however.
3900 if ((unsigned) ptm->tm_sec <= 60) {
3907 secs += 60 * ptm->tm_min;
3908 secs += SECS_PER_HOUR * ptm->tm_hour;
3910 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3911 /* got negative remainder, but need positive time */
3912 /* back off an extra day to compensate */
3913 yearday += (secs/SECS_PER_DAY)-1;
3914 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3917 yearday += (secs/SECS_PER_DAY);
3918 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3921 else if (secs >= SECS_PER_DAY) {
3922 yearday += (secs/SECS_PER_DAY);
3923 secs %= SECS_PER_DAY;
3925 ptm->tm_hour = secs/SECS_PER_HOUR;
3926 secs %= SECS_PER_HOUR;
3927 ptm->tm_min = secs/60;
3929 ptm->tm_sec += secs;
3930 /* done with time of day effects */
3932 * The algorithm for yearday has (so far) left it high by 428.
3933 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3934 * bias it by 123 while trying to figure out what year it
3935 * really represents. Even with this tweak, the reverse
3936 * translation fails for years before A.D. 0001.
3937 * It would still fail for Feb 29, but we catch that one below.
3939 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3940 yearday -= YEAR_ADJUST;
3941 year = (yearday / DAYS_PER_QCENT) * 400;
3942 yearday %= DAYS_PER_QCENT;
3943 odd_cent = yearday / DAYS_PER_CENT;
3944 year += odd_cent * 100;
3945 yearday %= DAYS_PER_CENT;
3946 year += (yearday / DAYS_PER_QYEAR) * 4;
3947 yearday %= DAYS_PER_QYEAR;
3948 odd_year = yearday / DAYS_PER_YEAR;
3950 yearday %= DAYS_PER_YEAR;
3951 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3956 yearday += YEAR_ADJUST; /* recover March 1st crock */
3957 month = yearday*DAYS_TO_MONTH;
3958 yearday -= month*MONTH_TO_DAYS;
3959 /* recover other leap-year adjustment */
3968 ptm->tm_year = year - 1900;
3970 ptm->tm_mday = yearday;
3971 ptm->tm_mon = month;
3975 ptm->tm_mon = month - 1;
3977 /* re-build yearday based on Jan 1 to get tm_yday */
3979 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3980 yearday += 14*MONTH_TO_DAYS + 1;
3981 ptm->tm_yday = jday - yearday;
3982 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3986 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)
3990 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3997 PERL_ARGS_ASSERT_MY_STRFTIME;
3999 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4002 mytm.tm_hour = hour;
4003 mytm.tm_mday = mday;
4005 mytm.tm_year = year;
4006 mytm.tm_wday = wday;
4007 mytm.tm_yday = yday;
4008 mytm.tm_isdst = isdst;
4010 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4011 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4016 #ifdef HAS_TM_TM_GMTOFF
4017 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4019 #ifdef HAS_TM_TM_ZONE
4020 mytm.tm_zone = mytm2.tm_zone;
4025 Newx(buf, buflen, char);
4027 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4028 len = strftime(buf, buflen, fmt, &mytm);
4032 ** The following is needed to handle to the situation where
4033 ** tmpbuf overflows. Basically we want to allocate a buffer
4034 ** and try repeatedly. The reason why it is so complicated
4035 ** is that getting a return value of 0 from strftime can indicate
4036 ** one of the following:
4037 ** 1. buffer overflowed,
4038 ** 2. illegal conversion specifier, or
4039 ** 3. the format string specifies nothing to be returned(not
4040 ** an error). This could be because format is an empty string
4041 ** or it specifies %p that yields an empty string in some locale.
4042 ** If there is a better way to make it portable, go ahead by
4045 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4048 /* Possibly buf overflowed - try again with a bigger buf */
4049 const int fmtlen = strlen(fmt);
4050 int bufsize = fmtlen + buflen;
4052 Renew(buf, bufsize, char);
4055 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4056 buflen = strftime(buf, bufsize, fmt, &mytm);
4059 if (buflen > 0 && buflen < bufsize)
4061 /* heuristic to prevent out-of-memory errors */
4062 if (bufsize > 100*fmtlen) {
4068 Renew(buf, bufsize, char);
4073 Perl_croak(aTHX_ "panic: no strftime");
4079 #define SV_CWD_RETURN_UNDEF \
4083 #define SV_CWD_ISDOT(dp) \
4084 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4085 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4088 =head1 Miscellaneous Functions
4090 =for apidoc getcwd_sv
4092 Fill C<sv> with current working directory
4097 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4098 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4099 * getcwd(3) if available
4100 * Comments from the original:
4101 * This is a faster version of getcwd. It's also more dangerous
4102 * because you might chdir out of a directory that you can't chdir
4106 Perl_getcwd_sv(pTHX_ SV *sv)
4111 PERL_ARGS_ASSERT_GETCWD_SV;
4115 char buf[MAXPATHLEN];
4117 /* Some getcwd()s automatically allocate a buffer of the given
4118 * size from the heap if they are given a NULL buffer pointer.
4119 * The problem is that this behaviour is not portable. */
4120 if (getcwd(buf, sizeof(buf) - 1)) {
4125 SV_CWD_RETURN_UNDEF;
4132 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4136 SvUPGRADE(sv, SVt_PV);
4138 if (PerlLIO_lstat(".", &statbuf) < 0) {
4139 SV_CWD_RETURN_UNDEF;
4142 orig_cdev = statbuf.st_dev;
4143 orig_cino = statbuf.st_ino;
4153 if (PerlDir_chdir("..") < 0) {
4154 SV_CWD_RETURN_UNDEF;
4156 if (PerlLIO_stat(".", &statbuf) < 0) {
4157 SV_CWD_RETURN_UNDEF;
4160 cdev = statbuf.st_dev;
4161 cino = statbuf.st_ino;
4163 if (odev == cdev && oino == cino) {
4166 if (!(dir = PerlDir_open("."))) {
4167 SV_CWD_RETURN_UNDEF;
4170 while ((dp = PerlDir_read(dir)) != NULL) {
4172 namelen = dp->d_namlen;
4174 namelen = strlen(dp->d_name);
4177 if (SV_CWD_ISDOT(dp)) {
4181 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4182 SV_CWD_RETURN_UNDEF;
4185 tdev = statbuf.st_dev;
4186 tino = statbuf.st_ino;
4187 if (tino == oino && tdev == odev) {
4193 SV_CWD_RETURN_UNDEF;
4196 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4197 SV_CWD_RETURN_UNDEF;
4200 SvGROW(sv, pathlen + namelen + 1);
4204 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4207 /* prepend current directory to the front */
4209 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4210 pathlen += (namelen + 1);
4212 #ifdef VOID_CLOSEDIR
4215 if (PerlDir_close(dir) < 0) {
4216 SV_CWD_RETURN_UNDEF;
4222 SvCUR_set(sv, pathlen);
4226 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4227 SV_CWD_RETURN_UNDEF;
4230 if (PerlLIO_stat(".", &statbuf) < 0) {
4231 SV_CWD_RETURN_UNDEF;
4234 cdev = statbuf.st_dev;
4235 cino = statbuf.st_ino;
4237 if (cdev != orig_cdev || cino != orig_cino) {
4238 Perl_croak(aTHX_ "Unstable directory path, "
4239 "current directory changed unexpectedly");
4252 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4253 # define EMULATE_SOCKETPAIR_UDP
4256 #ifdef EMULATE_SOCKETPAIR_UDP
4258 S_socketpair_udp (int fd[2]) {
4260 /* Fake a datagram socketpair using UDP to localhost. */
4261 int sockets[2] = {-1, -1};
4262 struct sockaddr_in addresses[2];
4264 Sock_size_t size = sizeof(struct sockaddr_in);
4265 unsigned short port;
4268 memset(&addresses, 0, sizeof(addresses));
4271 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4272 if (sockets[i] == -1)
4273 goto tidy_up_and_fail;
4275 addresses[i].sin_family = AF_INET;
4276 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4277 addresses[i].sin_port = 0; /* kernel choses port. */
4278 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4279 sizeof(struct sockaddr_in)) == -1)
4280 goto tidy_up_and_fail;
4283 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4284 for each connect the other socket to it. */
4287 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4289 goto tidy_up_and_fail;
4290 if (size != sizeof(struct sockaddr_in))
4291 goto abort_tidy_up_and_fail;
4292 /* !1 is 0, !0 is 1 */
4293 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4294 sizeof(struct sockaddr_in)) == -1)
4295 goto tidy_up_and_fail;
4298 /* Now we have 2 sockets connected to each other. I don't trust some other
4299 process not to have already sent a packet to us (by random) so send
4300 a packet from each to the other. */
4303 /* I'm going to send my own port number. As a short.
4304 (Who knows if someone somewhere has sin_port as a bitfield and needs
4305 this routine. (I'm assuming crays have socketpair)) */
4306 port = addresses[i].sin_port;
4307 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4308 if (got != sizeof(port)) {
4310 goto tidy_up_and_fail;
4311 goto abort_tidy_up_and_fail;
4315 /* Packets sent. I don't trust them to have arrived though.
4316 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4317 connect to localhost will use a second kernel thread. In 2.6 the
4318 first thread running the connect() returns before the second completes,
4319 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4320 returns 0. Poor programs have tripped up. One poor program's authors'
4321 had a 50-1 reverse stock split. Not sure how connected these were.)
4322 So I don't trust someone not to have an unpredictable UDP stack.
4326 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4327 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4331 FD_SET((unsigned int)sockets[0], &rset);
4332 FD_SET((unsigned int)sockets[1], &rset);
4334 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4335 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4336 || !FD_ISSET(sockets[1], &rset)) {
4337 /* I hope this is portable and appropriate. */
4339 goto tidy_up_and_fail;
4340 goto abort_tidy_up_and_fail;
4344 /* And the paranoia department even now doesn't trust it to have arrive
4345 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4347 struct sockaddr_in readfrom;
4348 unsigned short buffer[2];
4353 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4354 sizeof(buffer), MSG_DONTWAIT,
4355 (struct sockaddr *) &readfrom, &size);
4357 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4359 (struct sockaddr *) &readfrom, &size);
4363 goto tidy_up_and_fail;
4364 if (got != sizeof(port)
4365 || size != sizeof(struct sockaddr_in)
4366 /* Check other socket sent us its port. */
4367 || buffer[0] != (unsigned short) addresses[!i].sin_port
4368 /* Check kernel says we got the datagram from that socket */
4369 || readfrom.sin_family != addresses[!i].sin_family
4370 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4371 || readfrom.sin_port != addresses[!i].sin_port)
4372 goto abort_tidy_up_and_fail;
4375 /* My caller (my_socketpair) has validated that this is non-NULL */
4378 /* I hereby declare this connection open. May God bless all who cross
4382 abort_tidy_up_and_fail:
4383 errno = ECONNABORTED;
4387 if (sockets[0] != -1)
4388 PerlLIO_close(sockets[0]);
4389 if (sockets[1] != -1)
4390 PerlLIO_close(sockets[1]);
4395 #endif /* EMULATE_SOCKETPAIR_UDP */
4397 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4399 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4400 /* Stevens says that family must be AF_LOCAL, protocol 0.
4401 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4406 struct sockaddr_in listen_addr;
4407 struct sockaddr_in connect_addr;
4412 || family != AF_UNIX
4415 errno = EAFNOSUPPORT;
4423 #ifdef EMULATE_SOCKETPAIR_UDP
4424 if (type == SOCK_DGRAM)
4425 return S_socketpair_udp(fd);
4428 aTHXa(PERL_GET_THX);
4429 listener = PerlSock_socket(AF_INET, type, 0);
4432 memset(&listen_addr, 0, sizeof(listen_addr));
4433 listen_addr.sin_family = AF_INET;
4434 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4435 listen_addr.sin_port = 0; /* kernel choses port. */
4436 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4437 sizeof(listen_addr)) == -1)
4438 goto tidy_up_and_fail;
4439 if (PerlSock_listen(listener, 1) == -1)
4440 goto tidy_up_and_fail;
4442 connector = PerlSock_socket(AF_INET, type, 0);
4443 if (connector == -1)
4444 goto tidy_up_and_fail;
4445 /* We want to find out the port number to connect to. */
4446 size = sizeof(connect_addr);
4447 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4449 goto tidy_up_and_fail;
4450 if (size != sizeof(connect_addr))
4451 goto abort_tidy_up_and_fail;
4452 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4453 sizeof(connect_addr)) == -1)
4454 goto tidy_up_and_fail;
4456 size = sizeof(listen_addr);
4457 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4460 goto tidy_up_and_fail;
4461 if (size != sizeof(listen_addr))
4462 goto abort_tidy_up_and_fail;
4463 PerlLIO_close(listener);
4464 /* Now check we are talking to ourself by matching port and host on the
4466 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4468 goto tidy_up_and_fail;
4469 if (size != sizeof(connect_addr)
4470 || listen_addr.sin_family != connect_addr.sin_family
4471 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4472 || listen_addr.sin_port != connect_addr.sin_port) {
4473 goto abort_tidy_up_and_fail;
4479 abort_tidy_up_and_fail:
4481 errno = ECONNABORTED; /* This would be the standard thing to do. */
4483 # ifdef ECONNREFUSED
4484 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4486 errno = ETIMEDOUT; /* Desperation time. */
4493 PerlLIO_close(listener);
4494 if (connector != -1)
4495 PerlLIO_close(connector);
4497 PerlLIO_close(acceptor);
4503 /* In any case have a stub so that there's code corresponding
4504 * to the my_socketpair in embed.fnc. */
4506 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4507 #ifdef HAS_SOCKETPAIR
4508 return socketpair(family, type, protocol, fd);
4517 =for apidoc sv_nosharing
4519 Dummy routine which "shares" an SV when there is no sharing module present.
4520 Or "locks" it. Or "unlocks" it. In other
4521 words, ignores its single SV argument.
4522 Exists to avoid test for a C<NULL> function pointer and because it could
4523 potentially warn under some level of strict-ness.
4529 Perl_sv_nosharing(pTHX_ SV *sv)
4531 PERL_UNUSED_CONTEXT;
4532 PERL_UNUSED_ARG(sv);
4537 =for apidoc sv_destroyable
4539 Dummy routine which reports that object can be destroyed when there is no
4540 sharing module present. It ignores its single SV argument, and returns
4541 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4542 could potentially warn under some level of strict-ness.
4548 Perl_sv_destroyable(pTHX_ SV *sv)
4550 PERL_UNUSED_CONTEXT;
4551 PERL_UNUSED_ARG(sv);
4556 Perl_parse_unicode_opts(pTHX_ const char **popt)
4558 const char *p = *popt;
4561 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4567 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4570 if (p && *p && *p != '\n' && *p != '\r') {
4572 goto the_end_of_the_opts_parser;
4574 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4578 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4584 case PERL_UNICODE_STDIN:
4585 opt |= PERL_UNICODE_STDIN_FLAG; break;
4586 case PERL_UNICODE_STDOUT:
4587 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4588 case PERL_UNICODE_STDERR:
4589 opt |= PERL_UNICODE_STDERR_FLAG; break;
4590 case PERL_UNICODE_STD:
4591 opt |= PERL_UNICODE_STD_FLAG; break;
4592 case PERL_UNICODE_IN:
4593 opt |= PERL_UNICODE_IN_FLAG; break;
4594 case PERL_UNICODE_OUT:
4595 opt |= PERL_UNICODE_OUT_FLAG; break;
4596 case PERL_UNICODE_INOUT:
4597 opt |= PERL_UNICODE_INOUT_FLAG; break;
4598 case PERL_UNICODE_LOCALE:
4599 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4600 case PERL_UNICODE_ARGV:
4601 opt |= PERL_UNICODE_ARGV_FLAG; break;
4602 case PERL_UNICODE_UTF8CACHEASSERT:
4603 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4605 if (*p != '\n' && *p != '\r') {
4606 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4609 "Unknown Unicode option letter '%c'", *p);
4616 opt = PERL_UNICODE_DEFAULT_FLAGS;
4618 the_end_of_the_opts_parser:
4620 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4621 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4622 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4630 # include <starlet.h>
4637 * This is really just a quick hack which grabs various garbage
4638 * values. It really should be a real hash algorithm which
4639 * spreads the effect of every input bit onto every output bit,
4640 * if someone who knows about such things would bother to write it.
4641 * Might be a good idea to add that function to CORE as well.
4642 * No numbers below come from careful analysis or anything here,
4643 * except they are primes and SEED_C1 > 1E6 to get a full-width
4644 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4645 * probably be bigger too.
4648 # define SEED_C1 1000003
4649 #define SEED_C4 73819
4651 # define SEED_C1 25747
4652 #define SEED_C4 20639
4656 #define SEED_C5 26107
4658 #ifndef PERL_NO_DEV_RANDOM
4662 #ifdef HAS_GETTIMEOFDAY
4663 struct timeval when;
4668 /* This test is an escape hatch, this symbol isn't set by Configure. */
4669 #ifndef PERL_NO_DEV_RANDOM
4670 #ifndef PERL_RANDOM_DEVICE
4671 /* /dev/random isn't used by default because reads from it will block
4672 * if there isn't enough entropy available. You can compile with
4673 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4674 * is enough real entropy to fill the seed. */
4675 # ifdef __amigaos4__
4676 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4678 # define PERL_RANDOM_DEVICE "/dev/urandom"
4681 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4683 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4691 #ifdef HAS_GETTIMEOFDAY
4692 PerlProc_gettimeofday(&when,NULL);
4693 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4696 u = (U32)SEED_C1 * when;
4698 u += SEED_C3 * (U32)PerlProc_getpid();
4699 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4700 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4701 u += SEED_C5 * (U32)PTR2UV(&when);
4707 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4709 #ifndef NO_PERL_HASH_ENV
4714 PERL_ARGS_ASSERT_GET_HASH_SEED;
4716 #ifndef NO_PERL_HASH_ENV
4717 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4720 # ifndef USE_HASH_SEED_EXPLICIT
4722 /* ignore leading spaces */
4723 while (isSPACE(*env_pv))
4725 # ifdef USE_PERL_PERTURB_KEYS
4726 /* if they set it to "0" we disable key traversal randomization completely */
4727 if (strEQ(env_pv,"0")) {
4728 PL_hash_rand_bits_enabled= 0;
4730 /* otherwise switch to deterministic mode */
4731 PL_hash_rand_bits_enabled= 2;
4734 /* ignore a leading 0x... if it is there */
4735 if (env_pv[0] == '0' && env_pv[1] == 'x')
4738 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4739 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4740 if ( isXDIGIT(*env_pv)) {
4741 seed_buffer[i] |= READ_XDIGIT(env_pv);
4744 while (isSPACE(*env_pv))
4747 if (*env_pv && !isXDIGIT(*env_pv)) {
4748 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4750 /* should we check for unparsed crap? */
4751 /* should we warn about unused hex? */
4752 /* should we warn about insufficient hex? */
4758 (void)seedDrand01((Rand_seed_t)seed());
4760 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4761 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4764 #ifdef USE_PERL_PERTURB_KEYS
4765 { /* initialize PL_hash_rand_bits from the hash seed.
4766 * This value is highly volatile, it is updated every
4767 * hash insert, and is used as part of hash bucket chain
4768 * randomization and hash iterator randomization. */
4769 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4770 for( i = 0; i < sizeof(UV) ; i++ ) {
4771 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4772 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4775 # ifndef NO_PERL_HASH_ENV
4776 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4778 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4779 PL_hash_rand_bits_enabled= 0;
4780 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4781 PL_hash_rand_bits_enabled= 1;
4782 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4783 PL_hash_rand_bits_enabled= 2;
4785 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4792 #ifdef PERL_GLOBAL_STRUCT
4794 #define PERL_GLOBAL_STRUCT_INIT
4795 #include "opcode.h" /* the ppaddr and check */
4798 Perl_init_global_struct(pTHX)
4800 struct perl_vars *plvarsp = NULL;
4801 # ifdef PERL_GLOBAL_STRUCT
4802 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4803 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4804 PERL_UNUSED_CONTEXT;
4805 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4806 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4807 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4811 plvarsp = PL_VarsPtr;
4812 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4817 # define PERLVAR(prefix,var,type) /**/
4818 # define PERLVARA(prefix,var,n,type) /**/
4819 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4820 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4821 # include "perlvars.h"
4826 # ifdef PERL_GLOBAL_STRUCT
4829 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4830 if (!plvarsp->Gppaddr)
4834 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4835 if (!plvarsp->Gcheck)
4837 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4838 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4840 # ifdef PERL_SET_VARS
4841 PERL_SET_VARS(plvarsp);
4843 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4844 plvarsp->Gsv_placeholder.sv_flags = 0;
4845 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4847 # undef PERL_GLOBAL_STRUCT_INIT
4852 #endif /* PERL_GLOBAL_STRUCT */
4854 #ifdef PERL_GLOBAL_STRUCT
4857 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4859 int veto = plvarsp->Gveto_cleanup;
4861 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4862 PERL_UNUSED_CONTEXT;
4863 # ifdef PERL_GLOBAL_STRUCT
4864 # ifdef PERL_UNSET_VARS
4865 PERL_UNSET_VARS(plvarsp);
4869 free(plvarsp->Gppaddr);
4870 free(plvarsp->Gcheck);
4871 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4877 #endif /* PERL_GLOBAL_STRUCT */
4881 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4882 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4883 * given, and you supply your own implementation.
4885 * The default implementation reads a single env var, PERL_MEM_LOG,
4886 * expecting one or more of the following:
4888 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4889 * 'm' - memlog was PERL_MEM_LOG=1
4890 * 's' - svlog was PERL_SV_LOG=1
4891 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4893 * This makes the logger controllable enough that it can reasonably be
4894 * added to the system perl.
4897 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4898 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4900 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4902 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4903 * writes to. In the default logger, this is settable at runtime.
4905 #ifndef PERL_MEM_LOG_FD
4906 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4909 #ifndef PERL_MEM_LOG_NOIMPL
4911 # ifdef DEBUG_LEAKING_SCALARS
4912 # define SV_LOG_SERIAL_FMT " [%lu]"
4913 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4915 # define SV_LOG_SERIAL_FMT
4916 # define _SV_LOG_SERIAL_ARG(sv)
4920 S_mem_log_common(enum mem_log_type mlt, const UV n,
4921 const UV typesize, const char *type_name, const SV *sv,
4922 Malloc_t oldalloc, Malloc_t newalloc,
4923 const char *filename, const int linenumber,
4924 const char *funcname)
4928 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4930 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4933 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4935 /* We can't use SVs or PerlIO for obvious reasons,
4936 * so we'll use stdio and low-level IO instead. */
4937 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4939 # ifdef HAS_GETTIMEOFDAY
4940 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4941 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4943 gettimeofday(&tv, 0);
4945 # define MEM_LOG_TIME_FMT "%10d: "
4946 # define MEM_LOG_TIME_ARG (int)when
4950 /* If there are other OS specific ways of hires time than
4951 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4952 * probably that they would be used to fill in the struct
4959 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4960 && uv && uv <= PERL_INT_MAX
4964 fd = PERL_MEM_LOG_FD;
4967 if (strchr(pmlenv, 't')) {
4968 len = my_snprintf(buf, sizeof(buf),
4969 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4970 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4974 len = my_snprintf(buf, sizeof(buf),
4975 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4976 " %s = %" IVdf ": %" UVxf "\n",
4977 filename, linenumber, funcname, n, typesize,
4978 type_name, n * typesize, PTR2UV(newalloc));
4981 len = my_snprintf(buf, sizeof(buf),
4982 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4983 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4984 filename, linenumber, funcname, n, typesize,
4985 type_name, n * typesize, PTR2UV(oldalloc),
4989 len = my_snprintf(buf, sizeof(buf),
4990 "free: %s:%d:%s: %" UVxf "\n",
4991 filename, linenumber, funcname,
4996 len = my_snprintf(buf, sizeof(buf),
4997 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
4998 mlt == MLT_NEW_SV ? "new" : "del",
4999 filename, linenumber, funcname,
5000 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5005 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5009 #endif /* !PERL_MEM_LOG_NOIMPL */
5011 #ifndef PERL_MEM_LOG_NOIMPL
5013 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5014 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5016 /* this is suboptimal, but bug compatible. User is providing their
5017 own implementation, but is getting these functions anyway, and they
5018 do nothing. But _NOIMPL users should be able to cope or fix */
5020 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5021 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5025 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5027 const char *filename, const int linenumber,
5028 const char *funcname)
5030 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5032 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5033 NULL, NULL, newalloc,
5034 filename, linenumber, funcname);
5039 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5040 Malloc_t oldalloc, Malloc_t newalloc,
5041 const char *filename, const int linenumber,
5042 const char *funcname)
5044 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5046 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5047 NULL, oldalloc, newalloc,
5048 filename, linenumber, funcname);
5053 Perl_mem_log_free(Malloc_t oldalloc,
5054 const char *filename, const int linenumber,
5055 const char *funcname)
5057 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5059 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5060 filename, linenumber, funcname);
5065 Perl_mem_log_new_sv(const SV *sv,
5066 const char *filename, const int linenumber,
5067 const char *funcname)
5069 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5070 filename, linenumber, funcname);
5074 Perl_mem_log_del_sv(const SV *sv,
5075 const char *filename, const int linenumber,
5076 const char *funcname)
5078 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5079 filename, linenumber, funcname);
5082 #endif /* PERL_MEM_LOG */
5085 =for apidoc my_sprintf
5087 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5088 the length of the string written to the buffer. Only rare pre-ANSI systems
5089 need the wrapper function - usually this is a direct call to C<sprintf>.
5093 #ifndef SPRINTF_RETURNS_STRLEN
5095 Perl_my_sprintf(char *buffer, const char* pat, ...)
5098 PERL_ARGS_ASSERT_MY_SPRINTF;
5099 va_start(args, pat);
5100 vsprintf(buffer, pat, args);
5102 return strlen(buffer);
5107 =for apidoc quadmath_format_single
5109 C<quadmath_snprintf()> is very strict about its C<format> string and will
5110 fail, returning -1, if the format is invalid. It accepts exactly
5113 C<quadmath_format_single()> checks that the intended single spec looks
5114 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5115 and has C<Q> before it. This is not a full "printf syntax check",
5118 Returns the format if it is valid, NULL if not.
5120 C<quadmath_format_single()> can and will actually patch in the missing
5121 C<Q>, if necessary. In this case it will return the modified copy of
5122 the format, B<which the caller will need to free.>
5124 See also L</quadmath_format_needed>.
5130 Perl_quadmath_format_single(const char* format)
5134 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5136 if (format[0] != '%' || strchr(format + 1, '%'))
5138 len = strlen(format);
5139 /* minimum length three: %Qg */
5140 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5142 if (format[len - 2] != 'Q') {
5144 Newx(fixed, len + 1, char);
5145 memcpy(fixed, format, len - 1);
5146 fixed[len - 1] = 'Q';
5147 fixed[len ] = format[len - 1];
5149 return (const char*)fixed;
5156 =for apidoc quadmath_format_needed
5158 C<quadmath_format_needed()> returns true if the C<format> string seems to
5159 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5160 or returns false otherwise.
5162 The format specifier detection is not complete printf-syntax detection,
5163 but it should catch most common cases.
5165 If true is returned, those arguments B<should> in theory be processed
5166 with C<quadmath_snprintf()>, but in case there is more than one such
5167 format specifier (see L</quadmath_format_single>), and if there is
5168 anything else beyond that one (even just a single byte), they
5169 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5170 accepting only one format spec, and nothing else.
5171 In this case, the code should probably fail.
5177 Perl_quadmath_format_needed(const char* format)
5179 const char *p = format;
5182 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5184 while ((q = strchr(p, '%'))) {
5186 if (*q == '+') /* plus */
5188 if (*q == '#') /* alt */
5190 if (*q == '*') /* width */
5194 while (isDIGIT(*q)) q++;
5197 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5202 while (isDIGIT(*q)) q++;
5204 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5213 =for apidoc my_snprintf
5215 The C library C<snprintf> functionality, if available and
5216 standards-compliant (uses C<vsnprintf>, actually). However, if the
5217 C<vsnprintf> is not available, will unfortunately use the unsafe
5218 C<vsprintf> which can overrun the buffer (there is an overrun check,
5219 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5220 getting C<vsnprintf>.
5225 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5229 PERL_ARGS_ASSERT_MY_SNPRINTF;
5230 #ifndef HAS_VSNPRINTF
5231 PERL_UNUSED_VAR(len);
5233 va_start(ap, format);
5236 const char* qfmt = quadmath_format_single(format);
5237 bool quadmath_valid = FALSE;
5239 /* If the format looked promising, use it as quadmath. */
5240 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5242 if (qfmt != format) {
5246 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5248 quadmath_valid = TRUE;
5253 assert(qfmt == NULL);
5254 /* quadmath_format_single() will return false for example for
5255 * "foo = %g", or simply "%g". We could handle the %g by
5256 * using quadmath for the NV args. More complex cases of
5257 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5258 * quadmath-valid but has stuff in front).
5260 * Handling the "Q-less" cases right would require walking
5261 * through the va_list and rewriting the format, calling
5262 * quadmath for the NVs, building a new va_list, and then
5263 * letting vsnprintf/vsprintf to take care of the other
5264 * arguments. This may be doable.
5266 * We do not attempt that now. But for paranoia, we here try
5267 * to detect some common (but not all) cases where the
5268 * "Q-less" %[efgaEFGA] formats are present, and die if
5269 * detected. This doesn't fix the problem, but it stops the
5270 * vsnprintf/vsprintf pulling doubles off the va_list when
5271 * __float128 NVs should be pulled off instead.
5273 * If quadmath_format_needed() returns false, we are reasonably
5274 * certain that we can call vnsprintf() or vsprintf() safely. */
5275 if (!quadmath_valid && quadmath_format_needed(format))
5276 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5281 #ifdef HAS_VSNPRINTF
5282 retval = vsnprintf(buffer, len, format, ap);
5284 retval = vsprintf(buffer, format, ap);
5287 /* vsprintf() shows failure with < 0 */
5289 #ifdef HAS_VSNPRINTF
5290 /* vsnprintf() shows failure with >= len */
5292 (len > 0 && (Size_t)retval >= len)
5295 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5300 =for apidoc my_vsnprintf
5302 The C library C<vsnprintf> if available and standards-compliant.
5303 However, if if the C<vsnprintf> is not available, will unfortunately
5304 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5305 overrun check, but that may be too late). Consider using
5306 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5311 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5314 PERL_UNUSED_ARG(buffer);
5315 PERL_UNUSED_ARG(len);
5316 PERL_UNUSED_ARG(format);
5317 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5318 PERL_UNUSED_ARG((void*)ap);
5319 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5326 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5327 Perl_va_copy(ap, apc);
5328 # ifdef HAS_VSNPRINTF
5329 retval = vsnprintf(buffer, len, format, apc);
5331 PERL_UNUSED_ARG(len);
5332 retval = vsprintf(buffer, format, apc);
5336 # ifdef HAS_VSNPRINTF
5337 retval = vsnprintf(buffer, len, format, ap);
5339 PERL_UNUSED_ARG(len);
5340 retval = vsprintf(buffer, format, ap);
5342 #endif /* #ifdef NEED_VA_COPY */
5343 /* vsprintf() shows failure with < 0 */
5345 #ifdef HAS_VSNPRINTF
5346 /* vsnprintf() shows failure with >= len */
5348 (len > 0 && (Size_t)retval >= len)
5351 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5357 Perl_my_clearenv(pTHX)
5360 #if ! defined(PERL_MICRO)
5361 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5363 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5364 # if defined(USE_ENVIRON_ARRAY)
5365 # if defined(USE_ITHREADS)
5366 /* only the parent thread can clobber the process environment */
5367 if (PL_curinterp == aTHX)
5368 # endif /* USE_ITHREADS */
5370 # if ! defined(PERL_USE_SAFE_PUTENV)
5371 if ( !PL_use_safe_putenv) {
5373 if (environ == PL_origenviron)
5374 environ = (char**)safesysmalloc(sizeof(char*));
5376 for (i = 0; environ[i]; i++)
5377 (void)safesysfree(environ[i]);
5380 # else /* PERL_USE_SAFE_PUTENV */
5381 # if defined(HAS_CLEARENV)
5383 # elif defined(HAS_UNSETENV)
5384 int bsiz = 80; /* Most envvar names will be shorter than this. */
5385 char *buf = (char*)safesysmalloc(bsiz);
5386 while (*environ != NULL) {
5387 char *e = strchr(*environ, '=');
5388 int l = e ? e - *environ : (int)strlen(*environ);
5390 (void)safesysfree(buf);
5391 bsiz = l + 1; /* + 1 for the \0. */
5392 buf = (char*)safesysmalloc(bsiz);
5394 memcpy(buf, *environ, l);
5396 (void)unsetenv(buf);
5398 (void)safesysfree(buf);
5399 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5400 /* Just null environ and accept the leakage. */
5402 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5403 # endif /* ! PERL_USE_SAFE_PUTENV */
5405 # endif /* USE_ENVIRON_ARRAY */
5406 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5407 #endif /* PERL_MICRO */
5410 #ifdef PERL_IMPLICIT_CONTEXT
5412 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5413 the global PL_my_cxt_index is incremented, and that value is assigned to
5414 that module's static my_cxt_index (who's address is passed as an arg).
5415 Then, for each interpreter this function is called for, it makes sure a
5416 void* slot is available to hang the static data off, by allocating or
5417 extending the interpreter's PL_my_cxt_list array */
5419 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5421 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5425 PERL_ARGS_ASSERT_MY_CXT_INIT;
5427 /* this module hasn't been allocated an index yet */
5428 #if defined(USE_ITHREADS)
5429 MUTEX_LOCK(&PL_my_ctx_mutex);
5431 *index = PL_my_cxt_index++;
5432 #if defined(USE_ITHREADS)
5433 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5437 /* make sure the array is big enough */
5438 if (PL_my_cxt_size <= *index) {
5439 if (PL_my_cxt_size) {
5440 while (PL_my_cxt_size <= *index)
5441 PL_my_cxt_size *= 2;
5442 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5445 PL_my_cxt_size = 16;
5446 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5449 /* newSV() allocates one more than needed */
5450 p = (void*)SvPVX(newSV(size-1));
5451 PL_my_cxt_list[*index] = p;
5452 Zero(p, size, char);
5456 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5459 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5464 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5466 for (index = 0; index < PL_my_cxt_index; index++) {
5467 const char *key = PL_my_cxt_keys[index];
5468 /* try direct pointer compare first - there are chances to success,
5469 * and it's much faster.
5471 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5478 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5484 PERL_ARGS_ASSERT_MY_CXT_INIT;
5486 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5488 /* this module hasn't been allocated an index yet */
5489 #if defined(USE_ITHREADS)
5490 MUTEX_LOCK(&PL_my_ctx_mutex);
5492 index = PL_my_cxt_index++;
5493 #if defined(USE_ITHREADS)
5494 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5498 /* make sure the array is big enough */
5499 if (PL_my_cxt_size <= index) {
5500 int old_size = PL_my_cxt_size;
5502 if (PL_my_cxt_size) {
5503 while (PL_my_cxt_size <= index)
5504 PL_my_cxt_size *= 2;
5505 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5506 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5509 PL_my_cxt_size = 16;
5510 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5511 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5513 for (i = old_size; i < PL_my_cxt_size; i++) {
5514 PL_my_cxt_keys[i] = 0;
5515 PL_my_cxt_list[i] = 0;
5518 PL_my_cxt_keys[index] = my_cxt_key;
5519 /* newSV() allocates one more than needed */
5520 p = (void*)SvPVX(newSV(size-1));
5521 PL_my_cxt_list[index] = p;
5522 Zero(p, size, char);
5525 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5526 #endif /* PERL_IMPLICIT_CONTEXT */
5529 /* Perl_xs_handshake():
5530 implement the various XS_*_BOOTCHECK macros, which are added to .c
5531 files by ExtUtils::ParseXS, to check that the perl the module was built
5532 with is binary compatible with the running perl.
5535 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5536 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5538 The meaning of the varargs is determined the U32 key arg (which is not
5539 a format string). The fields of key are assembled by using HS_KEY().
5541 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5542 "PerlInterpreter *" and represents the callers context; otherwise it is
5543 of type "CV *", and is the boot xsub's CV.
5545 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5546 for example, and IO.dll was linked with threaded perl524.dll, and both
5547 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5548 successfully can load IO.dll into the process but simultaneously it
5549 loaded an interpreter of a different version into the process, and XS
5550 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5551 use through perl526.dll's my_perl->Istack_base.
5553 v_my_perl cannot be the first arg, since then 'key' will be out of
5554 place in a threaded vs non-threaded mixup; and analyzing the key
5555 number's bitfields won't reveal the problem, since it will be a valid
5556 key (unthreaded perl) on interp side, but croak will report the XS mod's
5557 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5558 it's a threaded perl and an unthreaded XS module, threaded perl will
5559 look at an uninit C stack or an uninit register to get 'key'
5560 (remember that it assumes that the 1st arg is the interp cxt).
5562 'file' is the source filename of the caller.
5566 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5572 #ifdef PERL_IMPLICIT_CONTEXT
5579 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5580 va_start(args, file);
5582 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5583 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5584 if (UNLIKELY(got != need))
5586 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5587 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5588 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5589 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5590 passed to the XS DLL */
5591 #ifdef PERL_IMPLICIT_CONTEXT
5592 xs_interp = (tTHX)v_my_perl;
5596 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5597 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5598 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5599 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5600 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5601 location in the unthreaded perl binary) stored in CV * to figure out if this
5602 Perl_xs_handshake was called by the same pp_entersub */
5603 cv = (CV*)v_my_perl;
5604 xs_spp = (SV***)CvHSCXT(cv);
5606 need = &PL_stack_sp;
5608 if(UNLIKELY(got != need)) {
5609 bad_handshake:/* recycle branch and string from above */
5610 if(got != (void *)HSf_NOCHK)
5611 noperl_die("%s: loadable library and perl binaries are mismatched"
5612 " (got handshake key %p, needed %p)\n",
5616 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5617 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5618 PL_xsubfilename = file; /* so the old name must be restored for
5619 additional XSUBs to register themselves */
5620 /* XSUBs can't be perl lang/perl5db.pl debugged
5621 if (PERLDB_LINE_OR_SAVESRC)
5622 (void)gv_fetchfile(file); */
5625 if(key & HSf_POPMARK) {
5627 { SV **mark = PL_stack_base + ax++;
5629 items = (I32)(SP - MARK);
5633 items = va_arg(args, U32);
5634 ax = va_arg(args, U32);
5638 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5639 if((apiverlen = HS_GETAPIVERLEN(key))) {
5640 char * api_p = va_arg(args, char*);
5641 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5642 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5643 sizeof("v" PERL_API_VERSION_STRING)-1))
5644 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5645 api_p, SVfARG(PL_stack_base[ax + 0]),
5646 "v" PERL_API_VERSION_STRING);
5651 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5652 if((xsverlen = HS_GETXSVERLEN(key)))
5653 S_xs_version_bootcheck(aTHX_
5654 items, ax, va_arg(args, char*), xsverlen);
5662 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5666 const char *vn = NULL;
5667 SV *const module = PL_stack_base[ax];
5669 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5671 if (items >= 2) /* version supplied as bootstrap arg */
5672 sv = PL_stack_base[ax + 1];
5674 /* XXX GV_ADDWARN */
5676 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5677 if (!sv || !SvOK(sv)) {
5679 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5683 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5684 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5685 ? sv : sv_2mortal(new_version(sv));
5686 xssv = upg_version(xssv, 0);
5687 if ( vcmp(pmsv,xssv) ) {
5688 SV *string = vstringify(xssv);
5689 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5690 " does not match ", SVfARG(module), SVfARG(string));
5692 SvREFCNT_dec(string);
5693 string = vstringify(pmsv);
5696 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5699 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5701 SvREFCNT_dec(string);
5703 Perl_sv_2mortal(aTHX_ xpt);
5704 Perl_croak_sv(aTHX_ xpt);
5710 =for apidoc my_strlcat
5712 The C library C<strlcat> if available, or a Perl implementation of it.
5713 This operates on C C<NUL>-terminated strings.
5715 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5716 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5717 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5718 practice this should not happen as it means that either C<size> is incorrect or
5719 that C<dst> is not a proper C<NUL>-terminated string).
5721 Note that C<size> is the full size of the destination buffer and
5722 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5723 room for the C<NUL> should be included in C<size>.
5725 The return value is the total length that C<dst> would have if C<size> is
5726 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5727 C<src>. If C<size> is smaller than the return, the excess was not appended.
5731 Description stolen from http://man.openbsd.org/strlcat.3
5735 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5737 Size_t used, length, copy;
5740 length = strlen(src);
5741 if (size > 0 && used < size - 1) {
5742 copy = (length >= size - used) ? size - used - 1 : length;
5743 memcpy(dst + used, src, copy);
5744 dst[used + copy] = '\0';
5746 return used + length;
5752 =for apidoc my_strlcpy
5754 The C library C<strlcpy> if available, or a Perl implementation of it.
5755 This operates on C C<NUL>-terminated strings.
5757 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5758 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5760 The return value is the total length C<src> would be if the copy completely
5761 succeeded. If it is larger than C<size>, the excess was not copied.
5765 Description stolen from http://man.openbsd.org/strlcpy.3
5769 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5771 Size_t length, copy;
5773 length = strlen(src);
5775 copy = (length >= size) ? size - 1 : length;
5776 memcpy(dst, src, copy);
5783 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5784 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5785 long _ftol( double ); /* Defined by VC6 C libs. */
5786 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5789 PERL_STATIC_INLINE bool
5790 S_gv_has_usable_name(pTHX_ GV *gv)
5794 && HvENAME(GvSTASH(gv))
5795 && (gvp = (GV **)hv_fetchhek(
5796 GvSTASH(gv), GvNAME_HEK(gv), 0
5802 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5804 SV * const dbsv = GvSVn(PL_DBsub);
5805 const bool save_taint = TAINT_get;
5807 /* When we are called from pp_goto (svp is null),
5808 * we do not care about using dbsv to call CV;
5809 * it's for informational purposes only.
5812 PERL_ARGS_ASSERT_GET_DB_SUB;
5816 if (!PERLDB_SUB_NN) {
5819 if (!svp && !CvLEXICAL(cv)) {
5820 gv_efullname3(dbsv, gv, NULL);
5822 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5823 || strEQ(GvNAME(gv), "END")
5824 || ( /* Could be imported, and old sub redefined. */
5825 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5827 !( (SvTYPE(*svp) == SVt_PVGV)
5828 && (GvCV((const GV *)*svp) == cv)
5829 /* Use GV from the stack as a fallback. */
5830 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5834 /* GV is potentially non-unique, or contain different CV. */
5835 SV * const tmp = newRV(MUTABLE_SV(cv));
5836 sv_setsv(dbsv, tmp);
5840 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5841 sv_catpvs(dbsv, "::");
5842 sv_cathek(dbsv, GvNAME_HEK(gv));
5846 const int type = SvTYPE(dbsv);
5847 if (type < SVt_PVIV && type != SVt_IV)
5848 sv_upgrade(dbsv, SVt_PVIV);
5849 (void)SvIOK_on(dbsv);
5850 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5853 TAINT_IF(save_taint);
5854 #ifdef NO_TAINT_SUPPORT
5855 PERL_UNUSED_VAR(save_taint);
5860 Perl_my_dirfd(DIR * dir) {
5862 /* Most dirfd implementations have problems when passed NULL. */
5867 #elif defined(HAS_DIR_DD_FD)
5870 Perl_croak_nocontext(PL_no_func, "dirfd");
5871 NOT_REACHED; /* NOTREACHED */
5877 Perl_get_re_arg(pTHX_ SV *sv) {
5883 sv = MUTABLE_SV(SvRV(sv));
5884 if (SvTYPE(sv) == SVt_REGEXP)
5885 return (REGEXP*) sv;
5892 * This code is derived from drand48() implementation from FreeBSD,
5893 * found in lib/libc/gen/_rand48.c.
5895 * The U64 implementation is original, based on the POSIX
5896 * specification for drand48().
5900 * Copyright (c) 1993 Martin Birgmeier
5901 * All rights reserved.
5903 * You may redistribute unmodified or modified versions of this source
5904 * code provided that the above copyright notice and this and the
5905 * following conditions are retained.
5907 * This software is provided ``as is'', and comes with no warranties
5908 * of any kind. I shall in no event be liable for anything that happens
5909 * to anyone/anything when using this software.
5912 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5914 #ifdef PERL_DRAND48_QUAD
5916 #define DRAND48_MULT U64_CONST(0x5deece66d)
5917 #define DRAND48_ADD 0xb
5918 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5922 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5923 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5924 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5925 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5926 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5927 #define FREEBSD_DRAND48_ADD (0x000b)
5929 const unsigned short _rand48_mult[3] = {
5930 FREEBSD_DRAND48_MULT_0,
5931 FREEBSD_DRAND48_MULT_1,
5932 FREEBSD_DRAND48_MULT_2
5934 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5939 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5941 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5943 #ifdef PERL_DRAND48_QUAD
5944 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5946 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5947 random_state->seed[1] = (U16) seed;
5948 random_state->seed[2] = (U16) (seed >> 16);
5953 Perl_drand48_r(perl_drand48_t *random_state)
5955 PERL_ARGS_ASSERT_DRAND48_R;
5957 #ifdef PERL_DRAND48_QUAD
5958 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5961 return ldexp((double)*random_state, -48);
5967 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5968 + (U32) _rand48_add;
5969 temp[0] = (U16) accu; /* lower 16 bits */
5970 accu >>= sizeof(U16) * 8;
5971 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5972 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5973 temp[1] = (U16) accu; /* middle 16 bits */
5974 accu >>= sizeof(U16) * 8;
5975 accu += _rand48_mult[0] * random_state->seed[2]
5976 + _rand48_mult[1] * random_state->seed[1]
5977 + _rand48_mult[2] * random_state->seed[0];
5978 random_state->seed[0] = temp[0];
5979 random_state->seed[1] = temp[1];
5980 random_state->seed[2] = (U16) accu;
5982 return ldexp((double) random_state->seed[0], -48) +
5983 ldexp((double) random_state->seed[1], -32) +
5984 ldexp((double) random_state->seed[2], -16);
5989 #ifdef USE_C_BACKTRACE
5991 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5996 /* abfd is the BFD handle. */
5998 /* bfd_syms is the BFD symbol table. */
6000 /* bfd_text is handle to the the ".text" section of the object file. */
6002 /* Since opening the executable and scanning its symbols is quite
6003 * heavy operation, we remember the filename we used the last time,
6004 * and do the opening and scanning only if the filename changes.
6005 * This removes most (but not all) open+scan cycles. */
6006 const char* fname_prev;
6009 /* Given a dl_info, update the BFD context if necessary. */
6010 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
6012 /* BFD open and scan only if the filename changed. */
6013 if (ctx->fname_prev == NULL ||
6014 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6016 bfd_close(ctx->abfd);
6018 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6020 if (bfd_check_format(ctx->abfd, bfd_object)) {
6021 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6022 if (symbol_size > 0) {
6023 Safefree(ctx->bfd_syms);
6024 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6026 bfd_get_section_by_name(ctx->abfd, ".text");
6034 ctx->fname_prev = dl_info->dli_fname;
6038 /* Given a raw frame, try to symbolize it and store
6039 * symbol information (source file, line number) away. */
6040 static void bfd_symbolize(bfd_context* ctx,
6043 STRLEN* symbol_name_size,
6045 STRLEN* source_name_size,
6046 STRLEN* source_line)
6048 *symbol_name = NULL;
6049 *symbol_name_size = 0;
6051 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6053 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6056 unsigned int line = 0;
6057 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6058 ctx->bfd_syms, offset,
6059 &file, &func, &line) &&
6060 file && func && line > 0) {
6061 /* Size and copy the source file, use only
6062 * the basename of the source file.
6064 * NOTE: the basenames are fine for the
6065 * Perl source files, but may not always
6066 * be the best idea for XS files. */
6067 const char *p, *b = NULL;
6068 /* Look for the last slash. */
6069 for (p = file; *p; p++) {
6073 if (b == NULL || *b == 0) {
6076 *source_name_size = p - b + 1;
6077 Newx(*source_name, *source_name_size + 1, char);
6078 Copy(b, *source_name, *source_name_size + 1, char);
6080 *symbol_name_size = strlen(func);
6081 Newx(*symbol_name, *symbol_name_size + 1, char);
6082 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6084 *source_line = line;
6090 #endif /* #ifdef USE_BFD */
6094 /* OS X has no public API for for 'symbolicating' (Apple official term)
6095 * stack addresses to {function_name, source_file, line_number}.
6096 * Good news: there is command line utility atos(1) which does that.
6097 * Bad news 1: it's a command line utility.
6098 * Bad news 2: one needs to have the Developer Tools installed.
6099 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6101 * To recap: we need to open a pipe for reading for a utility which
6102 * might not exist, or exists in different locations, and then parse
6103 * the output. And since this is all for a low-level API, we cannot
6104 * use high-level stuff. Thanks, Apple. */
6107 /* tool is set to the absolute pathname of the tool to use:
6110 /* format is set to a printf format string used for building
6111 * the external command to run. */
6113 /* unavail is set if e.g. xcrun cannot be found, or something
6114 * else happens that makes getting the backtrace dubious. Note,
6115 * however, that the context isn't persistent, the next call to
6116 * get_c_backtrace() will start from scratch. */
6118 /* fname is the current object file name. */
6120 /* object_base_addr is the base address of the shared object. */
6121 void* object_base_addr;
6124 /* Given |dl_info|, updates the context. If the context has been
6125 * marked unavailable, return immediately. If not but the tool has
6126 * not been set, set it to either "xcrun atos" or "atos" (also set the
6127 * format to use for creating commands for piping), or if neither is
6128 * unavailable (one needs the Developer Tools installed), mark the context
6129 * an unavailable. Finally, update the filename (object name),
6130 * and its base address. */
6132 static void atos_update(atos_context* ctx,
6137 if (ctx->tool == NULL) {
6138 const char* tools[] = {
6142 const char* formats[] = {
6143 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6144 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6148 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6149 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6150 ctx->tool = tools[i];
6151 ctx->format = formats[i];
6155 if (ctx->tool == NULL) {
6156 ctx->unavail = TRUE;
6160 if (ctx->fname == NULL ||
6161 strNE(dl_info->dli_fname, ctx->fname)) {
6162 ctx->fname = dl_info->dli_fname;
6163 ctx->object_base_addr = dl_info->dli_fbase;
6167 /* Given an output buffer end |p| and its |start|, matches
6168 * for the atos output, extracting the source code location
6169 * and returning non-NULL if possible, returning NULL otherwise. */
6170 static const char* atos_parse(const char* p,
6172 STRLEN* source_name_size,
6173 STRLEN* source_line) {
6174 /* atos() output is something like:
6175 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6176 * We cannot use Perl regular expressions, because we need to
6177 * stay low-level. Therefore here we have a rolled-out version
6178 * of a state machine which matches _backwards_from_the_end_ and
6179 * if there's a success, returns the starts of the filename,
6180 * also setting the filename size and the source line number.
6181 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6182 const char* source_number_start;
6183 const char* source_name_end;
6184 const char* source_line_end;
6185 const char* close_paren;
6188 /* Skip trailing whitespace. */
6189 while (p > start && isspace(*p)) p--;
6190 /* Now we should be at the close paren. */
6191 if (p == start || *p != ')')
6195 /* Now we should be in the line number. */
6196 if (p == start || !isdigit(*p))
6198 /* Skip over the digits. */
6199 while (p > start && isdigit(*p))
6201 /* Now we should be at the colon. */
6202 if (p == start || *p != ':')
6204 source_number_start = p + 1;
6205 source_name_end = p; /* Just beyond the end. */
6207 /* Look for the open paren. */
6208 while (p > start && *p != '(')
6213 *source_name_size = source_name_end - p;
6214 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6215 && source_line_end == close_paren
6216 && uv <= PERL_INT_MAX
6218 *source_line = (STRLEN)uv;
6224 /* Given a raw frame, read a pipe from the symbolicator (that's the
6225 * technical term) atos, reads the result, and parses the source code
6226 * location. We must stay low-level, so we use snprintf(), pipe(),
6227 * and fread(), and then also parse the output ourselves. */
6228 static void atos_symbolize(atos_context* ctx,
6231 STRLEN* source_name_size,
6232 STRLEN* source_line)
6240 /* Simple security measure: if there's any funny business with
6241 * the object name (used as "-o '%s'" ), leave since at least
6242 * partially the user controls it. */
6243 for (p = ctx->fname; *p; p++) {
6244 if (*p == '\'' || iscntrl(*p)) {
6245 ctx->unavail = TRUE;
6249 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6250 ctx->fname, ctx->object_base_addr, raw_frame);
6251 if (cnt < sizeof(cmd)) {
6252 /* Undo nostdio.h #defines that disable stdio.
6253 * This is somewhat naughty, but is used elsewhere
6254 * in the core, and affects only OS X. */
6259 FILE* fp = popen(cmd, "r");
6260 /* At the moment we open a new pipe for each stack frame.
6261 * This is naturally somewhat slow, but hopefully generating
6262 * stack traces is never going to in a performance critical path.
6264 * We could play tricks with atos by batching the stack
6265 * addresses to be resolved: atos can either take multiple
6266 * addresses from the command line, or read addresses from
6267 * a file (though the mess of creating temporary files would
6268 * probably negate much of any possible speedup).
6270 * Normally there are only two objects present in the backtrace:
6271 * perl itself, and the libdyld.dylib. (Note that the object
6272 * filenames contain the full pathname, so perl may not always
6273 * be in the same place.) Whenever the object in the
6274 * backtrace changes, the base address also changes.
6276 * The problem with batching the addresses, though, would be
6277 * matching the results with the addresses: the parsing of
6278 * the results is already painful enough with a single address. */
6281 UV cnt = fread(out, 1, sizeof(out), fp);
6282 if (cnt < sizeof(out)) {
6283 const char* p = atos_parse(out + cnt - 1, out,
6288 *source_name_size, char);
6289 Copy(p, *source_name,
6290 *source_name_size, char);
6298 #endif /* #ifdef PERL_DARWIN */
6301 =for apidoc get_c_backtrace
6303 Collects the backtrace (aka "stacktrace") into a single linear
6304 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6306 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6307 returning at most C<depth> frames.
6313 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6315 /* Note that here we must stay as low-level as possible: Newx(),
6316 * Copy(), Safefree(); since we may be called from anywhere,
6317 * so we should avoid higher level constructs like SVs or AVs.
6319 * Since we are using safesysmalloc() via Newx(), don't try
6320 * getting backtrace() there, unless you like deep recursion. */
6322 /* Currently only implemented with backtrace() and dladdr(),
6323 * for other platforms NULL is returned. */
6325 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6326 /* backtrace() is available via <execinfo.h> in glibc and in most
6327 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6329 /* We try fetching this many frames total, but then discard
6330 * the |skip| first ones. For the remaining ones we will try
6331 * retrieving more information with dladdr(). */
6332 int try_depth = skip + depth;
6334 /* The addresses (program counters) returned by backtrace(). */
6337 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6340 /* Sizes _including_ the terminating \0 of the object name
6341 * and symbol name strings. */
6342 STRLEN* object_name_sizes;
6343 STRLEN* symbol_name_sizes;
6346 /* The symbol names comes either from dli_sname,
6347 * or if using BFD, they can come from BFD. */
6348 char** symbol_names;
6351 /* The source code location information. Dug out with e.g. BFD. */
6352 char** source_names;
6353 STRLEN* source_name_sizes;
6354 STRLEN* source_lines;
6356 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6357 int got_depth; /* How many frames were returned from backtrace(). */
6358 UV frame_count = 0; /* How many frames we return. */
6359 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6362 bfd_context bfd_ctx;
6365 atos_context atos_ctx;
6368 /* Here are probably possibilities for optimizing. We could for
6369 * example have a struct that contains most of these and then
6370 * allocate |try_depth| of them, saving a bunch of malloc calls.
6371 * Note, however, that |frames| could not be part of that struct
6372 * because backtrace() will want an array of just them. Also be
6373 * careful about the name strings. */
6374 Newx(raw_frames, try_depth, void*);
6375 Newx(dl_infos, try_depth, Dl_info);
6376 Newx(object_name_sizes, try_depth, STRLEN);
6377 Newx(symbol_name_sizes, try_depth, STRLEN);
6378 Newx(source_names, try_depth, char*);
6379 Newx(source_name_sizes, try_depth, STRLEN);
6380 Newx(source_lines, try_depth, STRLEN);
6382 Newx(symbol_names, try_depth, char*);
6385 /* Get the raw frames. */
6386 got_depth = (int)backtrace(raw_frames, try_depth);
6388 /* We use dladdr() instead of backtrace_symbols() because we want
6389 * the full details instead of opaque strings. This is useful for
6390 * two reasons: () the details are needed for further symbolic
6391 * digging, for example in OS X (2) by having the details we fully
6392 * control the output, which in turn is useful when more platforms
6393 * are added: we can keep out output "portable". */
6395 /* We want a single linear allocation, which can then be freed
6396 * with a single swoop. We will do the usual trick of first
6397 * walking over the structure and seeing how much we need to
6398 * allocate, then allocating, and then walking over the structure
6399 * the second time and populating it. */
6401 /* First we must compute the total size of the buffer. */
6402 total_bytes = sizeof(Perl_c_backtrace_header);
6403 if (got_depth > skip) {
6406 bfd_init(); /* Is this safe to call multiple times? */
6407 Zero(&bfd_ctx, 1, bfd_context);
6410 Zero(&atos_ctx, 1, atos_context);
6412 for (i = skip; i < try_depth; i++) {
6413 Dl_info* dl_info = &dl_infos[i];
6415 object_name_sizes[i] = 0;
6416 source_names[i] = NULL;
6417 source_name_sizes[i] = 0;
6418 source_lines[i] = 0;
6420 /* Yes, zero from dladdr() is failure. */
6421 if (dladdr(raw_frames[i], dl_info)) {
6422 total_bytes += sizeof(Perl_c_backtrace_frame);
6424 object_name_sizes[i] =
6425 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6426 symbol_name_sizes[i] =
6427 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6429 bfd_update(&bfd_ctx, dl_info);
6430 bfd_symbolize(&bfd_ctx, raw_frames[i],
6432 &symbol_name_sizes[i],
6434 &source_name_sizes[i],
6438 atos_update(&atos_ctx, dl_info);
6439 atos_symbolize(&atos_ctx,
6442 &source_name_sizes[i],
6446 /* Plus ones for the terminating \0. */
6447 total_bytes += object_name_sizes[i] + 1;
6448 total_bytes += symbol_name_sizes[i] + 1;
6449 total_bytes += source_name_sizes[i] + 1;
6457 Safefree(bfd_ctx.bfd_syms);
6461 /* Now we can allocate and populate the result buffer. */
6462 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6463 Zero(bt, total_bytes, char);
6464 bt->header.frame_count = frame_count;
6465 bt->header.total_bytes = total_bytes;
6466 if (frame_count > 0) {
6467 Perl_c_backtrace_frame* frame = bt->frame_info;
6468 char* name_base = (char *)(frame + frame_count);
6469 char* name_curr = name_base; /* Outputting the name strings here. */
6471 for (i = skip; i < skip + frame_count; i++) {
6472 Dl_info* dl_info = &dl_infos[i];
6474 frame->addr = raw_frames[i];
6475 frame->object_base_addr = dl_info->dli_fbase;
6476 frame->symbol_addr = dl_info->dli_saddr;
6478 /* Copies a string, including the \0, and advances the name_curr.
6479 * Also copies the start and the size to the frame. */
6480 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6482 Copy(src, name_curr, size, char); \
6483 frame->doffset = name_curr - (char*)bt; \
6484 frame->dsize = size; \
6485 name_curr += size; \
6488 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6490 object_name_size, object_name_sizes[i]);
6493 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6495 symbol_name_size, symbol_name_sizes[i]);
6496 Safefree(symbol_names[i]);
6498 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6500 symbol_name_size, symbol_name_sizes[i]);
6503 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6505 source_name_size, source_name_sizes[i]);
6506 Safefree(source_names[i]);
6508 #undef PERL_C_BACKTRACE_STRCPY
6510 frame->source_line_number = source_lines[i];
6514 assert(total_bytes ==
6515 (UV)(sizeof(Perl_c_backtrace_header) +
6516 frame_count * sizeof(Perl_c_backtrace_frame) +
6517 name_curr - name_base));
6520 Safefree(symbol_names);
6522 bfd_close(bfd_ctx.abfd);
6525 Safefree(source_lines);
6526 Safefree(source_name_sizes);
6527 Safefree(source_names);
6528 Safefree(symbol_name_sizes);
6529 Safefree(object_name_sizes);
6530 /* Assuming the strings returned by dladdr() are pointers
6531 * to read-only static memory (the object file), so that
6532 * they do not need freeing (and cannot be). */
6534 Safefree(raw_frames);
6537 PERL_UNUSED_ARGV(depth);
6538 PERL_UNUSED_ARGV(skip);
6544 =for apidoc free_c_backtrace
6546 Deallocates a backtrace received from get_c_bracktrace.
6552 =for apidoc get_c_backtrace_dump
6554 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6555 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6557 The appended output looks like:
6560 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6561 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6564 The fields are tab-separated. The first column is the depth (zero
6565 being the innermost non-skipped frame). In the hex:offset, the hex is
6566 where the program counter was in C<S_parse_body>, and the :offset (might
6567 be missing) tells how much inside the C<S_parse_body> the program counter was.
6569 The C<util.c:1716> is the source code file and line number.
6571 The F</usr/bin/perl> is obvious (hopefully).
6573 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6574 if the platform doesn't support retrieving the information;
6575 if the binary is missing the debug information;
6576 if the optimizer has transformed the code by for example inlining.
6582 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6584 Perl_c_backtrace* bt;
6586 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6588 Perl_c_backtrace_frame* frame;
6589 SV* dsv = newSVpvs("");
6591 for (i = 0, frame = bt->frame_info;
6592 i < bt->header.frame_count; i++, frame++) {
6593 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6594 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6595 /* Symbol (function) names might disappear without debug info.
6597 * The source code location might disappear in case of the
6598 * optimizer inlining or otherwise rearranging the code. */
6599 if (frame->symbol_addr) {
6600 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6602 ((char*)frame->addr - (char*)frame->symbol_addr));
6604 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6605 frame->symbol_name_size &&
6606 frame->symbol_name_offset ?
6607 (char*)bt + frame->symbol_name_offset : "-");
6608 if (frame->source_name_size &&
6609 frame->source_name_offset &&
6610 frame->source_line_number) {
6611 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6612 (char*)bt + frame->source_name_offset,
6613 (UV)frame->source_line_number);
6615 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6617 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6618 frame->object_name_size &&
6619 frame->object_name_offset ?
6620 (char*)bt + frame->object_name_offset : "-");
6621 /* The frame->object_base_addr is not output,
6622 * but it is used for symbolizing/symbolicating. */
6623 sv_catpvs(dsv, "\n");
6626 Perl_free_c_backtrace(bt);
6635 =for apidoc dump_c_backtrace
6637 Dumps the C backtrace to the given C<fp>.
6639 Returns true if a backtrace could be retrieved, false if not.
6645 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6649 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6651 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6654 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6660 #endif /* #ifdef USE_C_BACKTRACE */
6662 #ifdef PERL_TSA_ACTIVE
6664 /* pthread_mutex_t and perl_mutex are typedef equivalent
6665 * so casting the pointers is fine. */
6667 int perl_tsa_mutex_lock(perl_mutex* mutex)
6669 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6672 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6674 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6677 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6679 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6687 /* log a sub call or return */
6690 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6698 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6701 HEK *hek = CvNAME_HEK(cv);
6702 func = HEK_KEY(hek);
6708 start = (const COP *)CvSTART(cv);
6709 file = CopFILE(start);
6710 line = CopLINE(start);
6711 stash = CopSTASHPV(start);
6714 PERL_SUB_ENTRY(func, file, line, stash);
6717 PERL_SUB_RETURN(func, file, line, stash);
6722 /* log a require file loading/loaded */
6725 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6727 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6730 PERL_LOADING_FILE(name);
6733 PERL_LOADED_FILE(name);
6738 /* log an op execution */
6741 Perl_dtrace_probe_op(pTHX_ const OP *op)
6743 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6745 PERL_OP_ENTRY(OP_NAME(op));
6749 /* log a compile/run phase change */
6752 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6754 const char *ph_old = PL_phase_names[PL_phase];
6755 const char *ph_new = PL_phase_names[phase];
6757 PERL_PHASE_CHANGE(ph_new, ph_old);
6763 * ex: set ts=8 sts=4 sw=4 et: