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 if (!b && tail) { /* Automatically multiline! */
955 /* Chop \n from littlestr: */
956 s = bigend - littlelen + 1;
958 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
968 if (littlelen > (STRLEN)(bigend - big))
972 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
973 const unsigned char *oldlittle;
977 --littlelen; /* Last char found by table lookup */
980 little += littlelen; /* last char */
983 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
984 const unsigned char lastc = *little;
988 if ((tmp = table[*s])) {
989 /* *s != lastc; earliest position it could match now is
990 * tmp slots further on */
991 if ((s += tmp) >= bigend)
993 if (LIKELY(*s != lastc)) {
995 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1005 /* hand-rolled strncmp(): less expensive than calling the
1006 * real function (maybe???) */
1008 unsigned char * const olds = s;
1013 if (*--s == *--little)
1015 s = olds + 1; /* here we pay the price for failure */
1017 if (s < bigend) /* fake up continue to outer loop */
1027 && memEQ((char *)(bigend - littlelen),
1028 (char *)(oldlittle - littlelen), littlelen) )
1029 return (char*)bigend - littlelen;
1038 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1040 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
1041 match themselves and their opposite case counterparts. Non-cased and non-ASCII
1042 range bytes match only themselves.
1049 Perl_foldEQ(const char *s1, const char *s2, I32 len)
1051 const U8 *a = (const U8 *)s1;
1052 const U8 *b = (const U8 *)s2;
1054 PERL_ARGS_ASSERT_FOLDEQ;
1059 if (*a != *b && *a != PL_fold[*b])
1066 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
1068 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
1069 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
1070 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
1071 * does it check that the strings each have at least 'len' characters */
1073 const U8 *a = (const U8 *)s1;
1074 const U8 *b = (const U8 *)s2;
1076 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
1081 if (*a != *b && *a != PL_fold_latin1[*b]) {
1090 =for apidoc foldEQ_locale
1092 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1093 same case-insensitively in the current locale; false otherwise.
1099 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
1102 const U8 *a = (const U8 *)s1;
1103 const U8 *b = (const U8 *)s2;
1105 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1110 if (*a != *b && *a != PL_fold_locale[*b])
1117 /* copy a string to a safe spot */
1120 =head1 Memory Management
1124 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1125 string which is a duplicate of C<pv>. The size of the string is
1126 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1127 characters and must have a trailing C<NUL>. The memory allocated for the new
1128 string can be freed with the C<Safefree()> function.
1130 On some platforms, Windows for example, all allocated memory owned by a thread
1131 is deallocated when that thread ends. So if you need that not to happen, you
1132 need to use the shared memory functions, such as C<L</savesharedpv>>.
1138 Perl_savepv(pTHX_ const char *pv)
1140 PERL_UNUSED_CONTEXT;
1145 const STRLEN pvlen = strlen(pv)+1;
1146 Newx(newaddr, pvlen, char);
1147 return (char*)memcpy(newaddr, pv, pvlen);
1151 /* same thing but with a known length */
1156 Perl's version of what C<strndup()> would be if it existed. Returns a
1157 pointer to a newly allocated string which is a duplicate of the first
1158 C<len> bytes from C<pv>, plus a trailing
1159 C<NUL> byte. The memory allocated for
1160 the new string can be freed with the C<Safefree()> function.
1162 On some platforms, Windows for example, all allocated memory owned by a thread
1163 is deallocated when that thread ends. So if you need that not to happen, you
1164 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1170 Perl_savepvn(pTHX_ const char *pv, I32 len)
1173 PERL_UNUSED_CONTEXT;
1177 Newx(newaddr,len+1,char);
1178 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1180 /* might not be null terminated */
1181 newaddr[len] = '\0';
1182 return (char *) CopyD(pv,newaddr,len,char);
1185 return (char *) ZeroD(newaddr,len+1,char);
1190 =for apidoc savesharedpv
1192 A version of C<savepv()> which allocates the duplicate string in memory
1193 which is shared between threads.
1198 Perl_savesharedpv(pTHX_ const char *pv)
1203 PERL_UNUSED_CONTEXT;
1208 pvlen = strlen(pv)+1;
1209 newaddr = (char*)PerlMemShared_malloc(pvlen);
1213 return (char*)memcpy(newaddr, pv, pvlen);
1217 =for apidoc savesharedpvn
1219 A version of C<savepvn()> which allocates the duplicate string in memory
1220 which is shared between threads. (With the specific difference that a C<NULL>
1221 pointer is not acceptable)
1226 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1228 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1230 PERL_UNUSED_CONTEXT;
1231 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1236 newaddr[len] = '\0';
1237 return (char*)memcpy(newaddr, pv, len);
1241 =for apidoc savesvpv
1243 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1244 the passed in SV using C<SvPV()>
1246 On some platforms, Windows for example, all allocated memory owned by a thread
1247 is deallocated when that thread ends. So if you need that not to happen, you
1248 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1254 Perl_savesvpv(pTHX_ SV *sv)
1257 const char * const pv = SvPV_const(sv, len);
1260 PERL_ARGS_ASSERT_SAVESVPV;
1263 Newx(newaddr,len,char);
1264 return (char *) CopyD(pv,newaddr,len,char);
1268 =for apidoc savesharedsvpv
1270 A version of C<savesharedpv()> which allocates the duplicate string in
1271 memory which is shared between threads.
1277 Perl_savesharedsvpv(pTHX_ SV *sv)
1280 const char * const pv = SvPV_const(sv, len);
1282 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1284 return savesharedpvn(pv, len);
1287 /* the SV for Perl_form() and mess() is not kept in an arena */
1295 if (PL_phase != PERL_PHASE_DESTRUCT)
1296 return newSVpvs_flags("", SVs_TEMP);
1301 /* Create as PVMG now, to avoid any upgrading later */
1303 Newxz(any, 1, XPVMG);
1304 SvFLAGS(sv) = SVt_PVMG;
1305 SvANY(sv) = (void*)any;
1307 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1312 #if defined(PERL_IMPLICIT_CONTEXT)
1314 Perl_form_nocontext(const char* pat, ...)
1319 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1320 va_start(args, pat);
1321 retval = vform(pat, &args);
1325 #endif /* PERL_IMPLICIT_CONTEXT */
1328 =head1 Miscellaneous Functions
1331 Takes a sprintf-style format pattern and conventional
1332 (non-SV) arguments and returns the formatted string.
1334 (char *) Perl_form(pTHX_ const char* pat, ...)
1336 can be used any place a string (char *) is required:
1338 char * s = Perl_form("%d.%d",major,minor);
1340 Uses a single private buffer so if you want to format several strings you
1341 must explicitly copy the earlier strings away (and free the copies when you
1348 Perl_form(pTHX_ const char* pat, ...)
1352 PERL_ARGS_ASSERT_FORM;
1353 va_start(args, pat);
1354 retval = vform(pat, &args);
1360 Perl_vform(pTHX_ const char *pat, va_list *args)
1362 SV * const sv = mess_alloc();
1363 PERL_ARGS_ASSERT_VFORM;
1364 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1369 =for apidoc Am|SV *|mess|const char *pat|...
1371 Take a sprintf-style format pattern and argument list. These are used to
1372 generate a string message. If the message does not end with a newline,
1373 then it will be extended with some indication of the current location
1374 in the code, as described for L</mess_sv>.
1376 Normally, the resulting message is returned in a new mortal SV.
1377 During global destruction a single SV may be shared between uses of
1383 #if defined(PERL_IMPLICIT_CONTEXT)
1385 Perl_mess_nocontext(const char *pat, ...)
1390 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1391 va_start(args, pat);
1392 retval = vmess(pat, &args);
1396 #endif /* PERL_IMPLICIT_CONTEXT */
1399 Perl_mess(pTHX_ const char *pat, ...)
1403 PERL_ARGS_ASSERT_MESS;
1404 va_start(args, pat);
1405 retval = vmess(pat, &args);
1411 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1414 /* Look for curop starting from o. cop is the last COP we've seen. */
1415 /* opnext means that curop is actually the ->op_next of the op we are
1418 PERL_ARGS_ASSERT_CLOSEST_COP;
1420 if (!o || !curop || (
1421 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1425 if (o->op_flags & OPf_KIDS) {
1427 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1430 /* If the OP_NEXTSTATE has been optimised away we can still use it
1431 * the get the file and line number. */
1433 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1434 cop = (const COP *)kid;
1436 /* Keep searching, and return when we've found something. */
1438 new_cop = closest_cop(cop, kid, curop, opnext);
1444 /* Nothing found. */
1450 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1452 Expands a message, intended for the user, to include an indication of
1453 the current location in the code, if the message does not already appear
1456 C<basemsg> is the initial message or object. If it is a reference, it
1457 will be used as-is and will be the result of this function. Otherwise it
1458 is used as a string, and if it already ends with a newline, it is taken
1459 to be complete, and the result of this function will be the same string.
1460 If the message does not end with a newline, then a segment such as C<at
1461 foo.pl line 37> will be appended, and possibly other clauses indicating
1462 the current state of execution. The resulting message will end with a
1465 Normally, the resulting message is returned in a new mortal SV.
1466 During global destruction a single SV may be shared between uses of this
1467 function. If C<consume> is true, then the function is permitted (but not
1468 required) to modify and return C<basemsg> instead of allocating a new SV.
1474 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1478 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1482 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1483 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1484 && grok_atoUV(ws, &wi, NULL)
1485 && wi <= PERL_INT_MAX
1487 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1492 PERL_ARGS_ASSERT_MESS_SV;
1494 if (SvROK(basemsg)) {
1500 sv_setsv(sv, basemsg);
1505 if (SvPOK(basemsg) && consume) {
1510 sv_copypv(sv, basemsg);
1513 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1515 * Try and find the file and line for PL_op. This will usually be
1516 * PL_curcop, but it might be a cop that has been optimised away. We
1517 * can try to find such a cop by searching through the optree starting
1518 * from the sibling of PL_curcop.
1523 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1528 Perl_sv_catpvf(aTHX_ sv, " at %s line %" IVdf,
1529 OutCopFILE(cop), (IV)CopLINE(cop));
1532 /* Seems that GvIO() can be untrustworthy during global destruction. */
1533 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1534 && IoLINES(GvIOp(PL_last_in_gv)))
1537 const bool line_mode = (RsSIMPLE(PL_rs) &&
1538 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1539 Perl_sv_catpvf(aTHX_ sv, ", <%" SVf "> %s %" IVdf,
1540 SVfARG(PL_last_in_gv == PL_argvgv
1542 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1543 line_mode ? "line" : "chunk",
1544 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1546 if (PL_phase == PERL_PHASE_DESTRUCT)
1547 sv_catpvs(sv, " during global destruction");
1548 sv_catpvs(sv, ".\n");
1554 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1556 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1557 argument list, respectively. These are used to generate a string message. If
1559 message does not end with a newline, then it will be extended with
1560 some indication of the current location in the code, as described for
1563 Normally, the resulting message is returned in a new mortal SV.
1564 During global destruction a single SV may be shared between uses of
1571 Perl_vmess(pTHX_ const char *pat, va_list *args)
1573 SV * const sv = mess_alloc();
1575 PERL_ARGS_ASSERT_VMESS;
1577 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1578 return mess_sv(sv, 1);
1582 Perl_write_to_stderr(pTHX_ SV* msv)
1587 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1589 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1590 && (io = GvIO(PL_stderrgv))
1591 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1592 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1593 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1595 PerlIO * const serr = Perl_error_log;
1597 do_print(msv, serr);
1598 (void)PerlIO_flush(serr);
1603 =head1 Warning and Dieing
1606 /* Common code used in dieing and warning */
1609 S_with_queued_errors(pTHX_ SV *ex)
1611 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1612 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1613 sv_catsv(PL_errors, ex);
1614 ex = sv_mortalcopy(PL_errors);
1615 SvCUR_set(PL_errors, 0);
1621 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1626 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1627 /* sv_2cv might call Perl_croak() or Perl_warner() */
1628 SV * const oldhook = *hook;
1636 cv = sv_2cv(oldhook, &stash, &gv, 0);
1638 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1648 exarg = newSVsv(ex);
1649 SvREADONLY_on(exarg);
1652 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1656 call_sv(MUTABLE_SV(cv), G_DISCARD);
1665 =for apidoc Am|OP *|die_sv|SV *baseex
1667 Behaves the same as L</croak_sv>, except for the return type.
1668 It should be used only where the C<OP *> return type is required.
1669 The function never actually returns.
1675 # pragma warning( push )
1676 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1677 __declspec(noreturn) has non-void return type */
1678 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1679 __declspec(noreturn) has a return statement */
1682 Perl_die_sv(pTHX_ SV *baseex)
1684 PERL_ARGS_ASSERT_DIE_SV;
1687 NORETURN_FUNCTION_END;
1690 # pragma warning( pop )
1694 =for apidoc Am|OP *|die|const char *pat|...
1696 Behaves the same as L</croak>, except for the return type.
1697 It should be used only where the C<OP *> return type is required.
1698 The function never actually returns.
1703 #if defined(PERL_IMPLICIT_CONTEXT)
1705 # pragma warning( push )
1706 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1707 __declspec(noreturn) has non-void return type */
1708 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1709 __declspec(noreturn) has a return statement */
1712 Perl_die_nocontext(const char* pat, ...)
1716 va_start(args, pat);
1718 NOT_REACHED; /* NOTREACHED */
1720 NORETURN_FUNCTION_END;
1723 # pragma warning( pop )
1725 #endif /* PERL_IMPLICIT_CONTEXT */
1728 # pragma warning( push )
1729 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1730 __declspec(noreturn) has non-void return type */
1731 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1732 __declspec(noreturn) has a return statement */
1735 Perl_die(pTHX_ const char* pat, ...)
1738 va_start(args, pat);
1740 NOT_REACHED; /* NOTREACHED */
1742 NORETURN_FUNCTION_END;
1745 # pragma warning( pop )
1749 =for apidoc Am|void|croak_sv|SV *baseex
1751 This is an XS interface to Perl's C<die> function.
1753 C<baseex> is the error message or object. If it is a reference, it
1754 will be used as-is. Otherwise it is used as a string, and if it does
1755 not end with a newline then it will be extended with some indication of
1756 the current location in the code, as described for L</mess_sv>.
1758 The error message or object will be used as an exception, by default
1759 returning control to the nearest enclosing C<eval>, but subject to
1760 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1761 function never returns normally.
1763 To die with a simple string message, the L</croak> function may be
1770 Perl_croak_sv(pTHX_ SV *baseex)
1772 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1773 PERL_ARGS_ASSERT_CROAK_SV;
1774 invoke_exception_hook(ex, FALSE);
1779 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1781 This is an XS interface to Perl's C<die> function.
1783 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1784 argument list. These are used to generate a string message. If the
1785 message does not end with a newline, then it will be extended with
1786 some indication of the current location in the code, as described for
1789 The error message will be used as an exception, by default
1790 returning control to the nearest enclosing C<eval>, but subject to
1791 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1792 function never returns normally.
1794 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1795 (C<$@>) will be used as an error message or object instead of building an
1796 error message from arguments. If you want to throw a non-string object,
1797 or build an error message in an SV yourself, it is preferable to use
1798 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1804 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1806 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1807 invoke_exception_hook(ex, FALSE);
1812 =for apidoc Am|void|croak|const char *pat|...
1814 This is an XS interface to Perl's C<die> function.
1816 Take a sprintf-style format pattern and argument list. These are used to
1817 generate a string message. If the message does not end with a newline,
1818 then it will be extended with some indication of the current location
1819 in the code, as described for L</mess_sv>.
1821 The error message will be used as an exception, by default
1822 returning control to the nearest enclosing C<eval>, but subject to
1823 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1824 function never returns normally.
1826 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1827 (C<$@>) will be used as an error message or object instead of building an
1828 error message from arguments. If you want to throw a non-string object,
1829 or build an error message in an SV yourself, it is preferable to use
1830 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1835 #if defined(PERL_IMPLICIT_CONTEXT)
1837 Perl_croak_nocontext(const char *pat, ...)
1841 va_start(args, pat);
1843 NOT_REACHED; /* NOTREACHED */
1846 #endif /* PERL_IMPLICIT_CONTEXT */
1849 Perl_croak(pTHX_ const char *pat, ...)
1852 va_start(args, pat);
1854 NOT_REACHED; /* NOTREACHED */
1859 =for apidoc Am|void|croak_no_modify
1861 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1862 terser object code than using C<Perl_croak>. Less code used on exception code
1863 paths reduces CPU cache pressure.
1869 Perl_croak_no_modify(void)
1871 Perl_croak_nocontext( "%s", PL_no_modify);
1874 /* does not return, used in util.c perlio.c and win32.c
1875 This is typically called when malloc returns NULL.
1878 Perl_croak_no_mem(void)
1882 int fd = PerlIO_fileno(Perl_error_log);
1884 SETERRNO(EBADF,RMS_IFI);
1886 /* Can't use PerlIO to write as it allocates memory */
1887 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1892 /* does not return, used only in POPSTACK */
1894 Perl_croak_popstack(void)
1897 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1902 =for apidoc Am|void|warn_sv|SV *baseex
1904 This is an XS interface to Perl's C<warn> function.
1906 C<baseex> is the error message or object. If it is a reference, it
1907 will be used as-is. Otherwise it is used as a string, and if it does
1908 not end with a newline then it will be extended with some indication of
1909 the current location in the code, as described for L</mess_sv>.
1911 The error message or object will by default be written to standard error,
1912 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1914 To warn with a simple string message, the L</warn> function may be
1921 Perl_warn_sv(pTHX_ SV *baseex)
1923 SV *ex = mess_sv(baseex, 0);
1924 PERL_ARGS_ASSERT_WARN_SV;
1925 if (!invoke_exception_hook(ex, TRUE))
1926 write_to_stderr(ex);
1930 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1932 This is an XS interface to Perl's C<warn> function.
1934 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1935 argument list. These are used to generate a string message. If the
1936 message does not end with a newline, then it will be extended with
1937 some indication of the current location in the code, as described for
1940 The error message or object will by default be written to standard error,
1941 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1943 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1949 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1951 SV *ex = vmess(pat, args);
1952 PERL_ARGS_ASSERT_VWARN;
1953 if (!invoke_exception_hook(ex, TRUE))
1954 write_to_stderr(ex);
1958 =for apidoc Am|void|warn|const char *pat|...
1960 This is an XS interface to Perl's C<warn> function.
1962 Take a sprintf-style format pattern and argument list. These are used to
1963 generate a string message. If the message does not end with a newline,
1964 then it will be extended with some indication of the current location
1965 in the code, as described for L</mess_sv>.
1967 The error message or object will by default be written to standard error,
1968 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1970 Unlike with L</croak>, C<pat> is not permitted to be null.
1975 #if defined(PERL_IMPLICIT_CONTEXT)
1977 Perl_warn_nocontext(const char *pat, ...)
1981 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1982 va_start(args, pat);
1986 #endif /* PERL_IMPLICIT_CONTEXT */
1989 Perl_warn(pTHX_ const char *pat, ...)
1992 PERL_ARGS_ASSERT_WARN;
1993 va_start(args, pat);
1998 #if defined(PERL_IMPLICIT_CONTEXT)
2000 Perl_warner_nocontext(U32 err, const char *pat, ...)
2004 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2005 va_start(args, pat);
2006 vwarner(err, pat, &args);
2009 #endif /* PERL_IMPLICIT_CONTEXT */
2012 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2014 PERL_ARGS_ASSERT_CK_WARNER_D;
2016 if (Perl_ckwarn_d(aTHX_ err)) {
2018 va_start(args, pat);
2019 vwarner(err, pat, &args);
2025 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2027 PERL_ARGS_ASSERT_CK_WARNER;
2029 if (Perl_ckwarn(aTHX_ err)) {
2031 va_start(args, pat);
2032 vwarner(err, pat, &args);
2038 Perl_warner(pTHX_ U32 err, const char* pat,...)
2041 PERL_ARGS_ASSERT_WARNER;
2042 va_start(args, pat);
2043 vwarner(err, pat, &args);
2048 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2051 PERL_ARGS_ASSERT_VWARNER;
2053 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2054 !(PL_in_eval & EVAL_KEEPERR)
2056 SV * const msv = vmess(pat, args);
2058 if (PL_parser && PL_parser->error_count) {
2062 invoke_exception_hook(msv, FALSE);
2067 Perl_vwarn(aTHX_ pat, args);
2071 /* implements the ckWARN? macros */
2074 Perl_ckwarn(pTHX_ U32 w)
2076 /* If lexical warnings have not been set, use $^W. */
2078 return PL_dowarn & G_WARN_ON;
2080 return ckwarn_common(w);
2083 /* implements the ckWARN?_d macro */
2086 Perl_ckwarn_d(pTHX_ U32 w)
2088 /* If lexical warnings have not been set then default classes warn. */
2092 return ckwarn_common(w);
2096 S_ckwarn_common(pTHX_ U32 w)
2098 if (PL_curcop->cop_warnings == pWARN_ALL)
2101 if (PL_curcop->cop_warnings == pWARN_NONE)
2104 /* Check the assumption that at least the first slot is non-zero. */
2105 assert(unpackWARN1(w));
2107 /* Check the assumption that it is valid to stop as soon as a zero slot is
2109 if (!unpackWARN2(w)) {
2110 assert(!unpackWARN3(w));
2111 assert(!unpackWARN4(w));
2112 } else if (!unpackWARN3(w)) {
2113 assert(!unpackWARN4(w));
2116 /* Right, dealt with all the special cases, which are implemented as non-
2117 pointers, so there is a pointer to a real warnings mask. */
2119 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2121 } while (w >>= WARNshift);
2126 /* Set buffer=NULL to get a new one. */
2128 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2130 const MEM_SIZE len_wanted =
2131 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2132 PERL_UNUSED_CONTEXT;
2133 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2136 (specialWARN(buffer) ?
2137 PerlMemShared_malloc(len_wanted) :
2138 PerlMemShared_realloc(buffer, len_wanted));
2140 Copy(bits, (buffer + 1), size, char);
2141 if (size < WARNsize)
2142 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2146 /* since we've already done strlen() for both nam and val
2147 * we can use that info to make things faster than
2148 * sprintf(s, "%s=%s", nam, val)
2150 #define my_setenv_format(s, nam, nlen, val, vlen) \
2151 Copy(nam, s, nlen, char); \
2153 Copy(val, s+(nlen+1), vlen, char); \
2154 *(s+(nlen+1+vlen)) = '\0'
2156 #ifdef USE_ENVIRON_ARRAY
2157 /* VMS' my_setenv() is in vms.c */
2158 #if !defined(WIN32) && !defined(NETWARE)
2160 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2164 amigaos4_obtain_environ(__FUNCTION__);
2167 /* only parent thread can modify process environment */
2168 if (PL_curinterp == aTHX)
2171 #ifndef PERL_USE_SAFE_PUTENV
2172 if (!PL_use_safe_putenv) {
2173 /* most putenv()s leak, so we manipulate environ directly */
2175 const I32 len = strlen(nam);
2178 /* where does it go? */
2179 for (i = 0; environ[i]; i++) {
2180 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2184 if (environ == PL_origenviron) { /* need we copy environment? */
2190 while (environ[max])
2192 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2193 for (j=0; j<max; j++) { /* copy environment */
2194 const int len = strlen(environ[j]);
2195 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2196 Copy(environ[j], tmpenv[j], len+1, char);
2199 environ = tmpenv; /* tell exec where it is now */
2202 safesysfree(environ[i]);
2203 while (environ[i]) {
2204 environ[i] = environ[i+1];
2213 if (!environ[i]) { /* does not exist yet */
2214 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2215 environ[i+1] = NULL; /* make sure it's null terminated */
2218 safesysfree(environ[i]);
2222 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2223 /* all that work just for this */
2224 my_setenv_format(environ[i], nam, nlen, val, vlen);
2227 /* This next branch should only be called #if defined(HAS_SETENV), but
2228 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2229 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2231 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2232 # if defined(HAS_UNSETENV)
2234 (void)unsetenv(nam);
2236 (void)setenv(nam, val, 1);
2238 # else /* ! HAS_UNSETENV */
2239 (void)setenv(nam, val, 1);
2240 # endif /* HAS_UNSETENV */
2242 # if defined(HAS_UNSETENV)
2244 if (environ) /* old glibc can crash with null environ */
2245 (void)unsetenv(nam);
2247 const int nlen = strlen(nam);
2248 const int vlen = strlen(val);
2249 char * const new_env =
2250 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2251 my_setenv_format(new_env, nam, nlen, val, vlen);
2252 (void)putenv(new_env);
2254 # else /* ! HAS_UNSETENV */
2256 const int nlen = strlen(nam);
2262 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2263 /* all that work just for this */
2264 my_setenv_format(new_env, nam, nlen, val, vlen);
2265 (void)putenv(new_env);
2266 # endif /* HAS_UNSETENV */
2267 # endif /* __CYGWIN__ */
2268 #ifndef PERL_USE_SAFE_PUTENV
2274 amigaos4_release_environ(__FUNCTION__);
2278 #else /* WIN32 || NETWARE */
2281 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2285 const int nlen = strlen(nam);
2292 Newx(envstr, nlen+vlen+2, char);
2293 my_setenv_format(envstr, nam, nlen, val, vlen);
2294 (void)PerlEnv_putenv(envstr);
2298 #endif /* WIN32 || NETWARE */
2302 #ifdef UNLINK_ALL_VERSIONS
2304 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2308 PERL_ARGS_ASSERT_UNLNK;
2310 while (PerlLIO_unlink(f) >= 0)
2312 return retries ? 0 : -1;
2316 /* this is a drop-in replacement for bcopy(), except for the return
2317 * value, which we need to be able to emulate memcpy() */
2318 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2320 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2322 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2323 bcopy(vfrom, vto, len);
2325 const unsigned char *from = (const unsigned char *)vfrom;
2326 unsigned char *to = (unsigned char *)vto;
2328 PERL_ARGS_ASSERT_MY_BCOPY;
2330 if (from - to >= 0) {
2338 *(--to) = *(--from);
2346 /* this is a drop-in replacement for memset() */
2349 Perl_my_memset(void *vloc, int ch, size_t len)
2351 unsigned char *loc = (unsigned char *)vloc;
2353 PERL_ARGS_ASSERT_MY_MEMSET;
2361 /* this is a drop-in replacement for bzero() */
2362 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2364 Perl_my_bzero(void *vloc, size_t len)
2366 unsigned char *loc = (unsigned char *)vloc;
2368 PERL_ARGS_ASSERT_MY_BZERO;
2376 /* this is a drop-in replacement for memcmp() */
2377 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2379 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2381 const U8 *a = (const U8 *)vs1;
2382 const U8 *b = (const U8 *)vs2;
2385 PERL_ARGS_ASSERT_MY_MEMCMP;
2388 if ((tmp = *a++ - *b++))
2393 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2396 /* This vsprintf replacement should generally never get used, since
2397 vsprintf was available in both System V and BSD 2.11. (There may
2398 be some cross-compilation or embedded set-ups where it is needed,
2401 If you encounter a problem in this function, it's probably a symptom
2402 that Configure failed to detect your system's vprintf() function.
2403 See the section on "item vsprintf" in the INSTALL file.
2405 This version may compile on systems with BSD-ish <stdio.h>,
2406 but probably won't on others.
2409 #ifdef USE_CHAR_VSPRINTF
2414 vsprintf(char *dest, const char *pat, void *args)
2418 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2419 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2420 FILE_cnt(&fakebuf) = 32767;
2422 /* These probably won't compile -- If you really need
2423 this, you'll have to figure out some other method. */
2424 fakebuf._ptr = dest;
2425 fakebuf._cnt = 32767;
2430 fakebuf._flag = _IOWRT|_IOSTRG;
2431 _doprnt(pat, args, &fakebuf); /* what a kludge */
2432 #if defined(STDIO_PTR_LVALUE)
2433 *(FILE_ptr(&fakebuf)++) = '\0';
2435 /* PerlIO has probably #defined away fputc, but we want it here. */
2437 # undef fputc /* XXX Should really restore it later */
2439 (void)fputc('\0', &fakebuf);
2441 #ifdef USE_CHAR_VSPRINTF
2444 return 0; /* perl doesn't use return value */
2448 #endif /* HAS_VPRINTF */
2451 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2453 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2461 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2463 PERL_FLUSHALL_FOR_CHILD;
2464 This = (*mode == 'w');
2468 taint_proper("Insecure %s%s", "EXEC");
2470 if (PerlProc_pipe(p) < 0)
2472 /* Try for another pipe pair for error return */
2473 if (PerlProc_pipe(pp) >= 0)
2475 while ((pid = PerlProc_fork()) < 0) {
2476 if (errno != EAGAIN) {
2477 PerlLIO_close(p[This]);
2478 PerlLIO_close(p[that]);
2480 PerlLIO_close(pp[0]);
2481 PerlLIO_close(pp[1]);
2485 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2494 /* Close parent's end of error status pipe (if any) */
2496 PerlLIO_close(pp[0]);
2497 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2498 /* Close error pipe automatically if exec works */
2499 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2503 /* Now dup our end of _the_ pipe to right position */
2504 if (p[THIS] != (*mode == 'r')) {
2505 PerlLIO_dup2(p[THIS], *mode == 'r');
2506 PerlLIO_close(p[THIS]);
2507 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2508 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2511 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2512 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2513 /* No automatic close - do it by hand */
2520 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2526 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2532 do_execfree(); /* free any memory malloced by child on fork */
2534 PerlLIO_close(pp[1]);
2535 /* Keep the lower of the two fd numbers */
2536 if (p[that] < p[This]) {
2537 PerlLIO_dup2(p[This], p[that]);
2538 PerlLIO_close(p[This]);
2542 PerlLIO_close(p[that]); /* close child's end of pipe */
2544 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2545 SvUPGRADE(sv,SVt_IV);
2547 PL_forkprocess = pid;
2548 /* If we managed to get status pipe check for exec fail */
2549 if (did_pipes && pid > 0) {
2554 while (n < sizeof(int)) {
2555 n1 = PerlLIO_read(pp[0],
2556 (void*)(((char*)&errkid)+n),
2562 PerlLIO_close(pp[0]);
2564 if (n) { /* Error */
2566 PerlLIO_close(p[This]);
2567 if (n != sizeof(int))
2568 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2570 pid2 = wait4pid(pid, &status, 0);
2571 } while (pid2 == -1 && errno == EINTR);
2572 errno = errkid; /* Propagate errno from kid */
2577 PerlLIO_close(pp[0]);
2578 return PerlIO_fdopen(p[This], mode);
2580 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2581 return my_syspopen4(aTHX_ NULL, mode, n, args);
2582 # elif defined(WIN32)
2583 return win32_popenlist(mode, n, args);
2585 Perl_croak(aTHX_ "List form of piped open not implemented");
2586 return (PerlIO *) NULL;
2591 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2592 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2594 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2600 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2604 PERL_ARGS_ASSERT_MY_POPEN;
2606 PERL_FLUSHALL_FOR_CHILD;
2609 return my_syspopen(aTHX_ cmd,mode);
2612 This = (*mode == 'w');
2614 if (doexec && TAINTING_get) {
2616 taint_proper("Insecure %s%s", "EXEC");
2618 if (PerlProc_pipe(p) < 0)
2620 if (doexec && PerlProc_pipe(pp) >= 0)
2622 while ((pid = PerlProc_fork()) < 0) {
2623 if (errno != EAGAIN) {
2624 PerlLIO_close(p[This]);
2625 PerlLIO_close(p[that]);
2627 PerlLIO_close(pp[0]);
2628 PerlLIO_close(pp[1]);
2631 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2634 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2644 PerlLIO_close(pp[0]);
2645 #if defined(HAS_FCNTL) && defined(F_SETFD)
2646 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2650 if (p[THIS] != (*mode == 'r')) {
2651 PerlLIO_dup2(p[THIS], *mode == 'r');
2652 PerlLIO_close(p[THIS]);
2653 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2654 PerlLIO_close(p[THAT]);
2657 PerlLIO_close(p[THAT]);
2660 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2667 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2672 /* may or may not use the shell */
2673 do_exec3(cmd, pp[1], did_pipes);
2676 #endif /* defined OS2 */
2678 #ifdef PERLIO_USING_CRLF
2679 /* Since we circumvent IO layers when we manipulate low-level
2680 filedescriptors directly, need to manually switch to the
2681 default, binary, low-level mode; see PerlIOBuf_open(). */
2682 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2685 #ifdef PERL_USES_PL_PIDSTATUS
2686 hv_clear(PL_pidstatus); /* we have no children */
2692 do_execfree(); /* free any memory malloced by child on vfork */
2694 PerlLIO_close(pp[1]);
2695 if (p[that] < p[This]) {
2696 PerlLIO_dup2(p[This], p[that]);
2697 PerlLIO_close(p[This]);
2701 PerlLIO_close(p[that]);
2703 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2704 SvUPGRADE(sv,SVt_IV);
2706 PL_forkprocess = pid;
2707 if (did_pipes && pid > 0) {
2712 while (n < sizeof(int)) {
2713 n1 = PerlLIO_read(pp[0],
2714 (void*)(((char*)&errkid)+n),
2720 PerlLIO_close(pp[0]);
2722 if (n) { /* Error */
2724 PerlLIO_close(p[This]);
2725 if (n != sizeof(int))
2726 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2728 pid2 = wait4pid(pid, &status, 0);
2729 } while (pid2 == -1 && errno == EINTR);
2730 errno = errkid; /* Propagate errno from kid */
2735 PerlLIO_close(pp[0]);
2736 return PerlIO_fdopen(p[This], mode);
2740 FILE *djgpp_popen();
2742 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2744 PERL_FLUSHALL_FOR_CHILD;
2745 /* Call system's popen() to get a FILE *, then import it.
2746 used 0 for 2nd parameter to PerlIO_importFILE;
2749 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2752 #if defined(__LIBCATAMOUNT__)
2754 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2761 #endif /* !DOSISH */
2763 /* this is called in parent before the fork() */
2765 Perl_atfork_lock(void)
2766 #if defined(USE_ITHREADS)
2768 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2771 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2773 PERL_TSA_ACQUIRE(PL_op_mutex)
2776 #if defined(USE_ITHREADS)
2778 /* locks must be held in locking order (if any) */
2780 MUTEX_LOCK(&PL_perlio_mutex);
2783 MUTEX_LOCK(&PL_malloc_mutex);
2789 /* this is called in both parent and child after the fork() */
2791 Perl_atfork_unlock(void)
2792 #if defined(USE_ITHREADS)
2794 PERL_TSA_RELEASE(PL_perlio_mutex)
2797 PERL_TSA_RELEASE(PL_malloc_mutex)
2799 PERL_TSA_RELEASE(PL_op_mutex)
2802 #if defined(USE_ITHREADS)
2804 /* locks must be released in same order as in atfork_lock() */
2806 MUTEX_UNLOCK(&PL_perlio_mutex);
2809 MUTEX_UNLOCK(&PL_malloc_mutex);
2818 #if defined(HAS_FORK)
2820 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2825 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2826 * handlers elsewhere in the code */
2830 #elif defined(__amigaos4__)
2831 return amigaos_fork();
2833 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2834 Perl_croak_nocontext("fork() not available");
2836 #endif /* HAS_FORK */
2841 dup2(int oldfd, int newfd)
2843 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2846 PerlLIO_close(newfd);
2847 return fcntl(oldfd, F_DUPFD, newfd);
2849 #define DUP2_MAX_FDS 256
2850 int fdtmp[DUP2_MAX_FDS];
2856 PerlLIO_close(newfd);
2857 /* good enough for low fd's... */
2858 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2859 if (fdx >= DUP2_MAX_FDS) {
2867 PerlLIO_close(fdtmp[--fdx]);
2874 #ifdef HAS_SIGACTION
2877 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2879 struct sigaction act, oact;
2883 /* only "parent" interpreter can diddle signals */
2884 if (PL_curinterp != aTHX)
2885 return (Sighandler_t) SIG_ERR;
2888 act.sa_handler = (void(*)(int))handler;
2889 sigemptyset(&act.sa_mask);
2892 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2893 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2895 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2896 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2897 act.sa_flags |= SA_NOCLDWAIT;
2899 if (sigaction(signo, &act, &oact) == -1)
2900 return (Sighandler_t) SIG_ERR;
2902 return (Sighandler_t) oact.sa_handler;
2906 Perl_rsignal_state(pTHX_ int signo)
2908 struct sigaction oact;
2909 PERL_UNUSED_CONTEXT;
2911 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2912 return (Sighandler_t) SIG_ERR;
2914 return (Sighandler_t) oact.sa_handler;
2918 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2923 struct sigaction act;
2925 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2928 /* only "parent" interpreter can diddle signals */
2929 if (PL_curinterp != aTHX)
2933 act.sa_handler = (void(*)(int))handler;
2934 sigemptyset(&act.sa_mask);
2937 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2938 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2940 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2941 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2942 act.sa_flags |= SA_NOCLDWAIT;
2944 return sigaction(signo, &act, save);
2948 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2953 PERL_UNUSED_CONTEXT;
2955 /* only "parent" interpreter can diddle signals */
2956 if (PL_curinterp != aTHX)
2960 return sigaction(signo, save, (struct sigaction *)NULL);
2963 #else /* !HAS_SIGACTION */
2966 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2968 #if defined(USE_ITHREADS) && !defined(WIN32)
2969 /* only "parent" interpreter can diddle signals */
2970 if (PL_curinterp != aTHX)
2971 return (Sighandler_t) SIG_ERR;
2974 return PerlProc_signal(signo, handler);
2985 Perl_rsignal_state(pTHX_ int signo)
2988 Sighandler_t oldsig;
2990 #if defined(USE_ITHREADS) && !defined(WIN32)
2991 /* only "parent" interpreter can diddle signals */
2992 if (PL_curinterp != aTHX)
2993 return (Sighandler_t) SIG_ERR;
2997 oldsig = PerlProc_signal(signo, sig_trap);
2998 PerlProc_signal(signo, oldsig);
3000 PerlProc_kill(PerlProc_getpid(), signo);
3005 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3007 #if defined(USE_ITHREADS) && !defined(WIN32)
3008 /* only "parent" interpreter can diddle signals */
3009 if (PL_curinterp != aTHX)
3012 *save = PerlProc_signal(signo, handler);
3013 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3017 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3019 #if defined(USE_ITHREADS) && !defined(WIN32)
3020 /* only "parent" interpreter can diddle signals */
3021 if (PL_curinterp != aTHX)
3024 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3027 #endif /* !HAS_SIGACTION */
3028 #endif /* !PERL_MICRO */
3030 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3031 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3033 Perl_my_pclose(pTHX_ PerlIO *ptr)
3041 const int fd = PerlIO_fileno(ptr);
3044 svp = av_fetch(PL_fdpid,fd,TRUE);
3045 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3049 #if defined(USE_PERLIO)
3050 /* Find out whether the refcount is low enough for us to wait for the
3051 child proc without blocking. */
3052 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3054 should_wait = pid > 0;
3058 if (pid == -1) { /* Opened by popen. */
3059 return my_syspclose(ptr);
3062 close_failed = (PerlIO_close(ptr) == EOF);
3064 if (should_wait) do {
3065 pid2 = wait4pid(pid, &status, 0);
3066 } while (pid2 == -1 && errno == EINTR);
3073 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3078 #if defined(__LIBCATAMOUNT__)
3080 Perl_my_pclose(pTHX_ PerlIO *ptr)
3085 #endif /* !DOSISH */
3087 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3089 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3092 PERL_ARGS_ASSERT_WAIT4PID;
3093 #ifdef PERL_USES_PL_PIDSTATUS
3095 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3096 waitpid() nor wait4() is available, or on OS/2, which
3097 doesn't appear to support waiting for a progress group
3098 member, so we can only treat a 0 pid as an unknown child.
3105 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3106 pid, rather than a string form. */
3107 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3108 if (svp && *svp != &PL_sv_undef) {
3109 *statusp = SvIVX(*svp);
3110 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3118 hv_iterinit(PL_pidstatus);
3119 if ((entry = hv_iternext(PL_pidstatus))) {
3120 SV * const sv = hv_iterval(PL_pidstatus,entry);
3122 const char * const spid = hv_iterkey(entry,&len);
3124 assert (len == sizeof(Pid_t));
3125 memcpy((char *)&pid, spid, len);
3126 *statusp = SvIVX(sv);
3127 /* The hash iterator is currently on this entry, so simply
3128 calling hv_delete would trigger the lazy delete, which on
3129 aggregate does more work, because next call to hv_iterinit()
3130 would spot the flag, and have to call the delete routine,
3131 while in the meantime any new entries can't re-use that
3133 hv_iterinit(PL_pidstatus);
3134 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3141 # ifdef HAS_WAITPID_RUNTIME
3142 if (!HAS_WAITPID_RUNTIME)
3145 result = PerlProc_waitpid(pid,statusp,flags);
3148 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3149 result = wait4(pid,statusp,flags,NULL);
3152 #ifdef PERL_USES_PL_PIDSTATUS
3153 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3158 Perl_croak(aTHX_ "Can't do waitpid with flags");
3160 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3161 pidgone(result,*statusp);
3167 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3170 if (result < 0 && errno == EINTR) {
3172 errno = EINTR; /* reset in case a signal handler changed $! */
3176 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3178 #ifdef PERL_USES_PL_PIDSTATUS
3180 S_pidgone(pTHX_ Pid_t pid, int status)
3184 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3185 SvUPGRADE(sv,SVt_IV);
3186 SvIV_set(sv, status);
3194 int /* Cannot prototype with I32
3196 my_syspclose(PerlIO *ptr)
3199 Perl_my_pclose(pTHX_ PerlIO *ptr)
3202 /* Needs work for PerlIO ! */
3203 FILE * const f = PerlIO_findFILE(ptr);
3204 const I32 result = pclose(f);
3205 PerlIO_releaseFILE(ptr,f);
3213 Perl_my_pclose(pTHX_ PerlIO *ptr)
3215 /* Needs work for PerlIO ! */
3216 FILE * const f = PerlIO_findFILE(ptr);
3217 I32 result = djgpp_pclose(f);
3218 result = (result << 8) & 0xff00;
3219 PerlIO_releaseFILE(ptr,f);
3224 #define PERL_REPEATCPY_LINEAR 4
3226 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3228 PERL_ARGS_ASSERT_REPEATCPY;
3233 croak_memory_wrap();
3236 memset(to, *from, count);
3239 IV items, linear, half;
3241 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3242 for (items = 0; items < linear; ++items) {
3243 const char *q = from;
3245 for (todo = len; todo > 0; todo--)
3250 while (items <= half) {
3251 IV size = items * len;
3252 memcpy(p, to, size);
3258 memcpy(p, to, (count - items) * len);
3264 Perl_same_dirent(pTHX_ const char *a, const char *b)
3266 char *fa = strrchr(a,'/');
3267 char *fb = strrchr(b,'/');
3270 SV * const tmpsv = sv_newmortal();
3272 PERL_ARGS_ASSERT_SAME_DIRENT;
3285 sv_setpvs(tmpsv, ".");
3287 sv_setpvn(tmpsv, a, fa - a);
3288 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3291 sv_setpvs(tmpsv, ".");
3293 sv_setpvn(tmpsv, b, fb - b);
3294 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3296 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3297 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3299 #endif /* !HAS_RENAME */
3302 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3303 const char *const *const search_ext, I32 flags)
3305 const char *xfound = NULL;
3306 char *xfailed = NULL;
3307 char tmpbuf[MAXPATHLEN];
3312 #if defined(DOSISH) && !defined(OS2)
3313 # define SEARCH_EXTS ".bat", ".cmd", NULL
3314 # define MAX_EXT_LEN 4
3317 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3318 # define MAX_EXT_LEN 4
3321 # define SEARCH_EXTS ".pl", ".com", NULL
3322 # define MAX_EXT_LEN 4
3324 /* additional extensions to try in each dir if scriptname not found */
3326 static const char *const exts[] = { SEARCH_EXTS };
3327 const char *const *const ext = search_ext ? search_ext : exts;
3328 int extidx = 0, i = 0;
3329 const char *curext = NULL;
3331 PERL_UNUSED_ARG(search_ext);
3332 # define MAX_EXT_LEN 0
3335 PERL_ARGS_ASSERT_FIND_SCRIPT;
3338 * If dosearch is true and if scriptname does not contain path
3339 * delimiters, search the PATH for scriptname.
3341 * If SEARCH_EXTS is also defined, will look for each
3342 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3343 * while searching the PATH.
3345 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3346 * proceeds as follows:
3347 * If DOSISH or VMSISH:
3348 * + look for ./scriptname{,.foo,.bar}
3349 * + search the PATH for scriptname{,.foo,.bar}
3352 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3353 * this will not look in '.' if it's not in the PATH)
3358 # ifdef ALWAYS_DEFTYPES
3359 len = strlen(scriptname);
3360 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3361 int idx = 0, deftypes = 1;
3364 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3367 int idx = 0, deftypes = 1;
3370 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3372 /* The first time through, just add SEARCH_EXTS to whatever we
3373 * already have, so we can check for default file types. */
3375 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3382 if ((strlen(tmpbuf) + strlen(scriptname)
3383 + MAX_EXT_LEN) >= sizeof tmpbuf)
3384 continue; /* don't search dir with too-long name */
3385 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3389 if (strEQ(scriptname, "-"))
3391 if (dosearch) { /* Look in '.' first. */
3392 const char *cur = scriptname;
3394 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3396 if (strEQ(ext[i++],curext)) {
3397 extidx = -1; /* already has an ext */
3402 DEBUG_p(PerlIO_printf(Perl_debug_log,
3403 "Looking for %s\n",cur));
3406 if (PerlLIO_stat(cur,&statbuf) >= 0
3407 && !S_ISDIR(statbuf.st_mode)) {
3416 if (cur == scriptname) {
3417 len = strlen(scriptname);
3418 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3420 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3423 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3424 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3429 if (dosearch && !strchr(scriptname, '/')
3431 && !strchr(scriptname, '\\')
3433 && (s = PerlEnv_getenv("PATH")))
3437 bufend = s + strlen(s);
3438 while (s < bufend) {
3442 && *s != ';'; len++, s++) {
3443 if (len < sizeof tmpbuf)
3446 if (len < sizeof tmpbuf)
3449 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3455 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3456 continue; /* don't search dir with too-long name */
3459 && tmpbuf[len - 1] != '/'
3460 && tmpbuf[len - 1] != '\\'
3463 tmpbuf[len++] = '/';
3464 if (len == 2 && tmpbuf[0] == '.')
3466 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3470 len = strlen(tmpbuf);
3471 if (extidx > 0) /* reset after previous loop */
3475 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3476 retval = PerlLIO_stat(tmpbuf,&statbuf);
3477 if (S_ISDIR(statbuf.st_mode)) {
3481 } while ( retval < 0 /* not there */
3482 && extidx>=0 && ext[extidx] /* try an extension? */
3483 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3488 if (S_ISREG(statbuf.st_mode)
3489 && cando(S_IRUSR,TRUE,&statbuf)
3490 #if !defined(DOSISH)
3491 && cando(S_IXUSR,TRUE,&statbuf)
3495 xfound = tmpbuf; /* bingo! */
3499 xfailed = savepv(tmpbuf);
3504 if (!xfound && !seen_dot && !xfailed &&
3505 (PerlLIO_stat(scriptname,&statbuf) < 0
3506 || S_ISDIR(statbuf.st_mode)))
3508 seen_dot = 1; /* Disable message. */
3513 if (flags & 1) { /* do or die? */
3514 /* diag_listed_as: Can't execute %s */
3515 Perl_croak(aTHX_ "Can't %s %s%s%s",
3516 (xfailed ? "execute" : "find"),
3517 (xfailed ? xfailed : scriptname),
3518 (xfailed ? "" : " on PATH"),
3519 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3524 scriptname = xfound;
3526 return (scriptname ? savepv(scriptname) : NULL);
3529 #ifndef PERL_GET_CONTEXT_DEFINED
3532 Perl_get_context(void)
3534 #if defined(USE_ITHREADS)
3536 # ifdef OLD_PTHREADS_API
3538 int error = pthread_getspecific(PL_thr_key, &t)
3540 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3543 # ifdef I_MACH_CTHREADS
3544 return (void*)cthread_data(cthread_self());
3546 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3555 Perl_set_context(void *t)
3557 #if defined(USE_ITHREADS)
3560 PERL_ARGS_ASSERT_SET_CONTEXT;
3561 #if defined(USE_ITHREADS)
3562 # ifdef I_MACH_CTHREADS
3563 cthread_set_data(cthread_self(), t);
3566 const int error = pthread_setspecific(PL_thr_key, t);
3568 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3576 #endif /* !PERL_GET_CONTEXT_DEFINED */
3578 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3582 PERL_UNUSED_CONTEXT;
3588 Perl_get_op_names(pTHX)
3590 PERL_UNUSED_CONTEXT;
3591 return (char **)PL_op_name;
3595 Perl_get_op_descs(pTHX)
3597 PERL_UNUSED_CONTEXT;
3598 return (char **)PL_op_desc;
3602 Perl_get_no_modify(pTHX)
3604 PERL_UNUSED_CONTEXT;
3605 return PL_no_modify;
3609 Perl_get_opargs(pTHX)
3611 PERL_UNUSED_CONTEXT;
3612 return (U32 *)PL_opargs;
3616 Perl_get_ppaddr(pTHX)
3619 PERL_UNUSED_CONTEXT;
3620 return (PPADDR_t*)PL_ppaddr;
3623 #ifndef HAS_GETENV_LEN
3625 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3627 char * const env_trans = PerlEnv_getenv(env_elem);
3628 PERL_UNUSED_CONTEXT;
3629 PERL_ARGS_ASSERT_GETENV_LEN;
3631 *len = strlen(env_trans);
3638 Perl_get_vtbl(pTHX_ int vtbl_id)
3640 PERL_UNUSED_CONTEXT;
3642 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3643 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3647 Perl_my_fflush_all(pTHX)
3649 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3650 return PerlIO_flush(NULL);
3652 # if defined(HAS__FWALK)
3653 extern int fflush(FILE *);
3654 /* undocumented, unprototyped, but very useful BSDism */
3655 extern void _fwalk(int (*)(FILE *));
3659 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3661 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3662 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3664 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3665 open_max = sysconf(_SC_OPEN_MAX);
3668 open_max = FOPEN_MAX;
3671 open_max = OPEN_MAX;
3682 for (i = 0; i < open_max; i++)
3683 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3684 STDIO_STREAM_ARRAY[i]._file < open_max &&
3685 STDIO_STREAM_ARRAY[i]._flag)
3686 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3690 SETERRNO(EBADF,RMS_IFI);
3697 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3699 if (ckWARN(WARN_IO)) {
3701 = gv && (isGV_with_GP(gv))
3704 const char * const direction = have == '>' ? "out" : "in";
3706 if (name && HEK_LEN(name))
3707 Perl_warner(aTHX_ packWARN(WARN_IO),
3708 "Filehandle %" HEKf " opened only for %sput",
3709 HEKfARG(name), direction);
3711 Perl_warner(aTHX_ packWARN(WARN_IO),
3712 "Filehandle opened only for %sput", direction);
3717 Perl_report_evil_fh(pTHX_ const GV *gv)
3719 const IO *io = gv ? GvIO(gv) : NULL;
3720 const PERL_BITFIELD16 op = PL_op->op_type;
3724 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3726 warn_type = WARN_CLOSED;
3730 warn_type = WARN_UNOPENED;
3733 if (ckWARN(warn_type)) {
3735 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3736 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3737 const char * const pars =
3738 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3739 const char * const func =
3741 (op == OP_READLINE || op == OP_RCATLINE
3742 ? "readline" : /* "<HANDLE>" not nice */
3743 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3745 const char * const type =
3747 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3748 ? "socket" : "filehandle");
3749 const bool have_name = name && SvCUR(name);
3750 Perl_warner(aTHX_ packWARN(warn_type),
3751 "%s%s on %s %s%s%" SVf, func, pars, vile, type,
3752 have_name ? " " : "",
3753 SVfARG(have_name ? name : &PL_sv_no));
3754 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3756 aTHX_ packWARN(warn_type),
3757 "\t(Are you trying to call %s%s on dirhandle%s%" SVf "?)\n",
3758 func, pars, have_name ? " " : "",
3759 SVfARG(have_name ? name : &PL_sv_no)
3764 /* To workaround core dumps from the uninitialised tm_zone we get the
3765 * system to give us a reasonable struct to copy. This fix means that
3766 * strftime uses the tm_zone and tm_gmtoff values returned by
3767 * localtime(time()). That should give the desired result most of the
3768 * time. But probably not always!
3770 * This does not address tzname aspects of NETaa14816.
3775 # ifndef STRUCT_TM_HASZONE
3776 # define STRUCT_TM_HASZONE
3780 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3781 # ifndef HAS_TM_TM_ZONE
3782 # define HAS_TM_TM_ZONE
3787 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3789 #ifdef HAS_TM_TM_ZONE
3791 const struct tm* my_tm;
3792 PERL_UNUSED_CONTEXT;
3793 PERL_ARGS_ASSERT_INIT_TM;
3795 my_tm = localtime(&now);
3797 Copy(my_tm, ptm, 1, struct tm);
3799 PERL_UNUSED_CONTEXT;
3800 PERL_ARGS_ASSERT_INIT_TM;
3801 PERL_UNUSED_ARG(ptm);
3806 * mini_mktime - normalise struct tm values without the localtime()
3807 * semantics (and overhead) of mktime().
3810 Perl_mini_mktime(struct tm *ptm)
3814 int month, mday, year, jday;
3815 int odd_cent, odd_year;
3817 PERL_ARGS_ASSERT_MINI_MKTIME;
3819 #define DAYS_PER_YEAR 365
3820 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3821 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3822 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3823 #define SECS_PER_HOUR (60*60)
3824 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3825 /* parentheses deliberately absent on these two, otherwise they don't work */
3826 #define MONTH_TO_DAYS 153/5
3827 #define DAYS_TO_MONTH 5/153
3828 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3829 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3830 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3831 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3834 * Year/day algorithm notes:
3836 * With a suitable offset for numeric value of the month, one can find
3837 * an offset into the year by considering months to have 30.6 (153/5) days,
3838 * using integer arithmetic (i.e., with truncation). To avoid too much
3839 * messing about with leap days, we consider January and February to be
3840 * the 13th and 14th month of the previous year. After that transformation,
3841 * we need the month index we use to be high by 1 from 'normal human' usage,
3842 * so the month index values we use run from 4 through 15.
3844 * Given that, and the rules for the Gregorian calendar (leap years are those
3845 * divisible by 4 unless also divisible by 100, when they must be divisible
3846 * by 400 instead), we can simply calculate the number of days since some
3847 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3848 * the days we derive from our month index, and adding in the day of the
3849 * month. The value used here is not adjusted for the actual origin which
3850 * it normally would use (1 January A.D. 1), since we're not exposing it.
3851 * We're only building the value so we can turn around and get the
3852 * normalised values for the year, month, day-of-month, and day-of-year.
3854 * For going backward, we need to bias the value we're using so that we find
3855 * the right year value. (Basically, we don't want the contribution of
3856 * March 1st to the number to apply while deriving the year). Having done
3857 * that, we 'count up' the contribution to the year number by accounting for
3858 * full quadracenturies (400-year periods) with their extra leap days, plus
3859 * the contribution from full centuries (to avoid counting in the lost leap
3860 * days), plus the contribution from full quad-years (to count in the normal
3861 * leap days), plus the leftover contribution from any non-leap years.
3862 * At this point, if we were working with an actual leap day, we'll have 0
3863 * days left over. This is also true for March 1st, however. So, we have
3864 * to special-case that result, and (earlier) keep track of the 'odd'
3865 * century and year contributions. If we got 4 extra centuries in a qcent,
3866 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3867 * Otherwise, we add back in the earlier bias we removed (the 123 from
3868 * figuring in March 1st), find the month index (integer division by 30.6),
3869 * and the remainder is the day-of-month. We then have to convert back to
3870 * 'real' months (including fixing January and February from being 14/15 in
3871 * the previous year to being in the proper year). After that, to get
3872 * tm_yday, we work with the normalised year and get a new yearday value for
3873 * January 1st, which we subtract from the yearday value we had earlier,
3874 * representing the date we've re-built. This is done from January 1
3875 * because tm_yday is 0-origin.
3877 * Since POSIX time routines are only guaranteed to work for times since the
3878 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3879 * applies Gregorian calendar rules even to dates before the 16th century
3880 * doesn't bother me. Besides, you'd need cultural context for a given
3881 * date to know whether it was Julian or Gregorian calendar, and that's
3882 * outside the scope for this routine. Since we convert back based on the
3883 * same rules we used to build the yearday, you'll only get strange results
3884 * for input which needed normalising, or for the 'odd' century years which
3885 * were leap years in the Julian calendar but not in the Gregorian one.
3886 * I can live with that.
3888 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3889 * that's still outside the scope for POSIX time manipulation, so I don't
3893 year = 1900 + ptm->tm_year;
3894 month = ptm->tm_mon;
3895 mday = ptm->tm_mday;
3901 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3902 yearday += month*MONTH_TO_DAYS + mday + jday;
3904 * Note that we don't know when leap-seconds were or will be,
3905 * so we have to trust the user if we get something which looks
3906 * like a sensible leap-second. Wild values for seconds will
3907 * be rationalised, however.
3909 if ((unsigned) ptm->tm_sec <= 60) {
3916 secs += 60 * ptm->tm_min;
3917 secs += SECS_PER_HOUR * ptm->tm_hour;
3919 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3920 /* got negative remainder, but need positive time */
3921 /* back off an extra day to compensate */
3922 yearday += (secs/SECS_PER_DAY)-1;
3923 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3926 yearday += (secs/SECS_PER_DAY);
3927 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3930 else if (secs >= SECS_PER_DAY) {
3931 yearday += (secs/SECS_PER_DAY);
3932 secs %= SECS_PER_DAY;
3934 ptm->tm_hour = secs/SECS_PER_HOUR;
3935 secs %= SECS_PER_HOUR;
3936 ptm->tm_min = secs/60;
3938 ptm->tm_sec += secs;
3939 /* done with time of day effects */
3941 * The algorithm for yearday has (so far) left it high by 428.
3942 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3943 * bias it by 123 while trying to figure out what year it
3944 * really represents. Even with this tweak, the reverse
3945 * translation fails for years before A.D. 0001.
3946 * It would still fail for Feb 29, but we catch that one below.
3948 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3949 yearday -= YEAR_ADJUST;
3950 year = (yearday / DAYS_PER_QCENT) * 400;
3951 yearday %= DAYS_PER_QCENT;
3952 odd_cent = yearday / DAYS_PER_CENT;
3953 year += odd_cent * 100;
3954 yearday %= DAYS_PER_CENT;
3955 year += (yearday / DAYS_PER_QYEAR) * 4;
3956 yearday %= DAYS_PER_QYEAR;
3957 odd_year = yearday / DAYS_PER_YEAR;
3959 yearday %= DAYS_PER_YEAR;
3960 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3965 yearday += YEAR_ADJUST; /* recover March 1st crock */
3966 month = yearday*DAYS_TO_MONTH;
3967 yearday -= month*MONTH_TO_DAYS;
3968 /* recover other leap-year adjustment */
3977 ptm->tm_year = year - 1900;
3979 ptm->tm_mday = yearday;
3980 ptm->tm_mon = month;
3984 ptm->tm_mon = month - 1;
3986 /* re-build yearday based on Jan 1 to get tm_yday */
3988 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3989 yearday += 14*MONTH_TO_DAYS + 1;
3990 ptm->tm_yday = jday - yearday;
3991 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3995 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)
3999 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
4006 PERL_ARGS_ASSERT_MY_STRFTIME;
4008 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4011 mytm.tm_hour = hour;
4012 mytm.tm_mday = mday;
4014 mytm.tm_year = year;
4015 mytm.tm_wday = wday;
4016 mytm.tm_yday = yday;
4017 mytm.tm_isdst = isdst;
4019 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4020 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4025 #ifdef HAS_TM_TM_GMTOFF
4026 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4028 #ifdef HAS_TM_TM_ZONE
4029 mytm.tm_zone = mytm2.tm_zone;
4034 Newx(buf, buflen, char);
4036 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4037 len = strftime(buf, buflen, fmt, &mytm);
4041 ** The following is needed to handle to the situation where
4042 ** tmpbuf overflows. Basically we want to allocate a buffer
4043 ** and try repeatedly. The reason why it is so complicated
4044 ** is that getting a return value of 0 from strftime can indicate
4045 ** one of the following:
4046 ** 1. buffer overflowed,
4047 ** 2. illegal conversion specifier, or
4048 ** 3. the format string specifies nothing to be returned(not
4049 ** an error). This could be because format is an empty string
4050 ** or it specifies %p that yields an empty string in some locale.
4051 ** If there is a better way to make it portable, go ahead by
4054 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4057 /* Possibly buf overflowed - try again with a bigger buf */
4058 const int fmtlen = strlen(fmt);
4059 int bufsize = fmtlen + buflen;
4061 Renew(buf, bufsize, char);
4064 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4065 buflen = strftime(buf, bufsize, fmt, &mytm);
4068 if (buflen > 0 && buflen < bufsize)
4070 /* heuristic to prevent out-of-memory errors */
4071 if (bufsize > 100*fmtlen) {
4077 Renew(buf, bufsize, char);
4082 Perl_croak(aTHX_ "panic: no strftime");
4088 #define SV_CWD_RETURN_UNDEF \
4092 #define SV_CWD_ISDOT(dp) \
4093 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4094 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4097 =head1 Miscellaneous Functions
4099 =for apidoc getcwd_sv
4101 Fill C<sv> with current working directory
4106 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4107 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4108 * getcwd(3) if available
4109 * Comments from the original:
4110 * This is a faster version of getcwd. It's also more dangerous
4111 * because you might chdir out of a directory that you can't chdir
4115 Perl_getcwd_sv(pTHX_ SV *sv)
4120 PERL_ARGS_ASSERT_GETCWD_SV;
4124 char buf[MAXPATHLEN];
4126 /* Some getcwd()s automatically allocate a buffer of the given
4127 * size from the heap if they are given a NULL buffer pointer.
4128 * The problem is that this behaviour is not portable. */
4129 if (getcwd(buf, sizeof(buf) - 1)) {
4134 SV_CWD_RETURN_UNDEF;
4141 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4145 SvUPGRADE(sv, SVt_PV);
4147 if (PerlLIO_lstat(".", &statbuf) < 0) {
4148 SV_CWD_RETURN_UNDEF;
4151 orig_cdev = statbuf.st_dev;
4152 orig_cino = statbuf.st_ino;
4162 if (PerlDir_chdir("..") < 0) {
4163 SV_CWD_RETURN_UNDEF;
4165 if (PerlLIO_stat(".", &statbuf) < 0) {
4166 SV_CWD_RETURN_UNDEF;
4169 cdev = statbuf.st_dev;
4170 cino = statbuf.st_ino;
4172 if (odev == cdev && oino == cino) {
4175 if (!(dir = PerlDir_open("."))) {
4176 SV_CWD_RETURN_UNDEF;
4179 while ((dp = PerlDir_read(dir)) != NULL) {
4181 namelen = dp->d_namlen;
4183 namelen = strlen(dp->d_name);
4186 if (SV_CWD_ISDOT(dp)) {
4190 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4191 SV_CWD_RETURN_UNDEF;
4194 tdev = statbuf.st_dev;
4195 tino = statbuf.st_ino;
4196 if (tino == oino && tdev == odev) {
4202 SV_CWD_RETURN_UNDEF;
4205 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4206 SV_CWD_RETURN_UNDEF;
4209 SvGROW(sv, pathlen + namelen + 1);
4213 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4216 /* prepend current directory to the front */
4218 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4219 pathlen += (namelen + 1);
4221 #ifdef VOID_CLOSEDIR
4224 if (PerlDir_close(dir) < 0) {
4225 SV_CWD_RETURN_UNDEF;
4231 SvCUR_set(sv, pathlen);
4235 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4236 SV_CWD_RETURN_UNDEF;
4239 if (PerlLIO_stat(".", &statbuf) < 0) {
4240 SV_CWD_RETURN_UNDEF;
4243 cdev = statbuf.st_dev;
4244 cino = statbuf.st_ino;
4246 if (cdev != orig_cdev || cino != orig_cino) {
4247 Perl_croak(aTHX_ "Unstable directory path, "
4248 "current directory changed unexpectedly");
4261 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4262 # define EMULATE_SOCKETPAIR_UDP
4265 #ifdef EMULATE_SOCKETPAIR_UDP
4267 S_socketpair_udp (int fd[2]) {
4269 /* Fake a datagram socketpair using UDP to localhost. */
4270 int sockets[2] = {-1, -1};
4271 struct sockaddr_in addresses[2];
4273 Sock_size_t size = sizeof(struct sockaddr_in);
4274 unsigned short port;
4277 memset(&addresses, 0, sizeof(addresses));
4280 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4281 if (sockets[i] == -1)
4282 goto tidy_up_and_fail;
4284 addresses[i].sin_family = AF_INET;
4285 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4286 addresses[i].sin_port = 0; /* kernel choses port. */
4287 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4288 sizeof(struct sockaddr_in)) == -1)
4289 goto tidy_up_and_fail;
4292 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4293 for each connect the other socket to it. */
4296 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4298 goto tidy_up_and_fail;
4299 if (size != sizeof(struct sockaddr_in))
4300 goto abort_tidy_up_and_fail;
4301 /* !1 is 0, !0 is 1 */
4302 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4303 sizeof(struct sockaddr_in)) == -1)
4304 goto tidy_up_and_fail;
4307 /* Now we have 2 sockets connected to each other. I don't trust some other
4308 process not to have already sent a packet to us (by random) so send
4309 a packet from each to the other. */
4312 /* I'm going to send my own port number. As a short.
4313 (Who knows if someone somewhere has sin_port as a bitfield and needs
4314 this routine. (I'm assuming crays have socketpair)) */
4315 port = addresses[i].sin_port;
4316 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4317 if (got != sizeof(port)) {
4319 goto tidy_up_and_fail;
4320 goto abort_tidy_up_and_fail;
4324 /* Packets sent. I don't trust them to have arrived though.
4325 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4326 connect to localhost will use a second kernel thread. In 2.6 the
4327 first thread running the connect() returns before the second completes,
4328 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4329 returns 0. Poor programs have tripped up. One poor program's authors'
4330 had a 50-1 reverse stock split. Not sure how connected these were.)
4331 So I don't trust someone not to have an unpredictable UDP stack.
4335 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4336 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4340 FD_SET((unsigned int)sockets[0], &rset);
4341 FD_SET((unsigned int)sockets[1], &rset);
4343 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4344 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4345 || !FD_ISSET(sockets[1], &rset)) {
4346 /* I hope this is portable and appropriate. */
4348 goto tidy_up_and_fail;
4349 goto abort_tidy_up_and_fail;
4353 /* And the paranoia department even now doesn't trust it to have arrive
4354 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4356 struct sockaddr_in readfrom;
4357 unsigned short buffer[2];
4362 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4363 sizeof(buffer), MSG_DONTWAIT,
4364 (struct sockaddr *) &readfrom, &size);
4366 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4368 (struct sockaddr *) &readfrom, &size);
4372 goto tidy_up_and_fail;
4373 if (got != sizeof(port)
4374 || size != sizeof(struct sockaddr_in)
4375 /* Check other socket sent us its port. */
4376 || buffer[0] != (unsigned short) addresses[!i].sin_port
4377 /* Check kernel says we got the datagram from that socket */
4378 || readfrom.sin_family != addresses[!i].sin_family
4379 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4380 || readfrom.sin_port != addresses[!i].sin_port)
4381 goto abort_tidy_up_and_fail;
4384 /* My caller (my_socketpair) has validated that this is non-NULL */
4387 /* I hereby declare this connection open. May God bless all who cross
4391 abort_tidy_up_and_fail:
4392 errno = ECONNABORTED;
4396 if (sockets[0] != -1)
4397 PerlLIO_close(sockets[0]);
4398 if (sockets[1] != -1)
4399 PerlLIO_close(sockets[1]);
4404 #endif /* EMULATE_SOCKETPAIR_UDP */
4406 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4408 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4409 /* Stevens says that family must be AF_LOCAL, protocol 0.
4410 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4415 struct sockaddr_in listen_addr;
4416 struct sockaddr_in connect_addr;
4421 || family != AF_UNIX
4424 errno = EAFNOSUPPORT;
4432 #ifdef EMULATE_SOCKETPAIR_UDP
4433 if (type == SOCK_DGRAM)
4434 return S_socketpair_udp(fd);
4437 aTHXa(PERL_GET_THX);
4438 listener = PerlSock_socket(AF_INET, type, 0);
4441 memset(&listen_addr, 0, sizeof(listen_addr));
4442 listen_addr.sin_family = AF_INET;
4443 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4444 listen_addr.sin_port = 0; /* kernel choses port. */
4445 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4446 sizeof(listen_addr)) == -1)
4447 goto tidy_up_and_fail;
4448 if (PerlSock_listen(listener, 1) == -1)
4449 goto tidy_up_and_fail;
4451 connector = PerlSock_socket(AF_INET, type, 0);
4452 if (connector == -1)
4453 goto tidy_up_and_fail;
4454 /* We want to find out the port number to connect to. */
4455 size = sizeof(connect_addr);
4456 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4458 goto tidy_up_and_fail;
4459 if (size != sizeof(connect_addr))
4460 goto abort_tidy_up_and_fail;
4461 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4462 sizeof(connect_addr)) == -1)
4463 goto tidy_up_and_fail;
4465 size = sizeof(listen_addr);
4466 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4469 goto tidy_up_and_fail;
4470 if (size != sizeof(listen_addr))
4471 goto abort_tidy_up_and_fail;
4472 PerlLIO_close(listener);
4473 /* Now check we are talking to ourself by matching port and host on the
4475 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4477 goto tidy_up_and_fail;
4478 if (size != sizeof(connect_addr)
4479 || listen_addr.sin_family != connect_addr.sin_family
4480 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4481 || listen_addr.sin_port != connect_addr.sin_port) {
4482 goto abort_tidy_up_and_fail;
4488 abort_tidy_up_and_fail:
4490 errno = ECONNABORTED; /* This would be the standard thing to do. */
4492 # ifdef ECONNREFUSED
4493 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4495 errno = ETIMEDOUT; /* Desperation time. */
4502 PerlLIO_close(listener);
4503 if (connector != -1)
4504 PerlLIO_close(connector);
4506 PerlLIO_close(acceptor);
4512 /* In any case have a stub so that there's code corresponding
4513 * to the my_socketpair in embed.fnc. */
4515 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4516 #ifdef HAS_SOCKETPAIR
4517 return socketpair(family, type, protocol, fd);
4526 =for apidoc sv_nosharing
4528 Dummy routine which "shares" an SV when there is no sharing module present.
4529 Or "locks" it. Or "unlocks" it. In other
4530 words, ignores its single SV argument.
4531 Exists to avoid test for a C<NULL> function pointer and because it could
4532 potentially warn under some level of strict-ness.
4538 Perl_sv_nosharing(pTHX_ SV *sv)
4540 PERL_UNUSED_CONTEXT;
4541 PERL_UNUSED_ARG(sv);
4546 =for apidoc sv_destroyable
4548 Dummy routine which reports that object can be destroyed when there is no
4549 sharing module present. It ignores its single SV argument, and returns
4550 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4551 could potentially warn under some level of strict-ness.
4557 Perl_sv_destroyable(pTHX_ SV *sv)
4559 PERL_UNUSED_CONTEXT;
4560 PERL_UNUSED_ARG(sv);
4565 Perl_parse_unicode_opts(pTHX_ const char **popt)
4567 const char *p = *popt;
4570 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4576 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4579 if (p && *p && *p != '\n' && *p != '\r') {
4581 goto the_end_of_the_opts_parser;
4583 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4587 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4593 case PERL_UNICODE_STDIN:
4594 opt |= PERL_UNICODE_STDIN_FLAG; break;
4595 case PERL_UNICODE_STDOUT:
4596 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4597 case PERL_UNICODE_STDERR:
4598 opt |= PERL_UNICODE_STDERR_FLAG; break;
4599 case PERL_UNICODE_STD:
4600 opt |= PERL_UNICODE_STD_FLAG; break;
4601 case PERL_UNICODE_IN:
4602 opt |= PERL_UNICODE_IN_FLAG; break;
4603 case PERL_UNICODE_OUT:
4604 opt |= PERL_UNICODE_OUT_FLAG; break;
4605 case PERL_UNICODE_INOUT:
4606 opt |= PERL_UNICODE_INOUT_FLAG; break;
4607 case PERL_UNICODE_LOCALE:
4608 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4609 case PERL_UNICODE_ARGV:
4610 opt |= PERL_UNICODE_ARGV_FLAG; break;
4611 case PERL_UNICODE_UTF8CACHEASSERT:
4612 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4614 if (*p != '\n' && *p != '\r') {
4615 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4618 "Unknown Unicode option letter '%c'", *p);
4625 opt = PERL_UNICODE_DEFAULT_FLAGS;
4627 the_end_of_the_opts_parser:
4629 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4630 Perl_croak(aTHX_ "Unknown Unicode option value %" UVuf,
4631 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4639 # include <starlet.h>
4646 * This is really just a quick hack which grabs various garbage
4647 * values. It really should be a real hash algorithm which
4648 * spreads the effect of every input bit onto every output bit,
4649 * if someone who knows about such things would bother to write it.
4650 * Might be a good idea to add that function to CORE as well.
4651 * No numbers below come from careful analysis or anything here,
4652 * except they are primes and SEED_C1 > 1E6 to get a full-width
4653 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4654 * probably be bigger too.
4657 # define SEED_C1 1000003
4658 #define SEED_C4 73819
4660 # define SEED_C1 25747
4661 #define SEED_C4 20639
4665 #define SEED_C5 26107
4667 #ifndef PERL_NO_DEV_RANDOM
4671 #ifdef HAS_GETTIMEOFDAY
4672 struct timeval when;
4677 /* This test is an escape hatch, this symbol isn't set by Configure. */
4678 #ifndef PERL_NO_DEV_RANDOM
4679 #ifndef PERL_RANDOM_DEVICE
4680 /* /dev/random isn't used by default because reads from it will block
4681 * if there isn't enough entropy available. You can compile with
4682 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4683 * is enough real entropy to fill the seed. */
4684 # ifdef __amigaos4__
4685 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4687 # define PERL_RANDOM_DEVICE "/dev/urandom"
4690 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4692 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4700 #ifdef HAS_GETTIMEOFDAY
4701 PerlProc_gettimeofday(&when,NULL);
4702 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4705 u = (U32)SEED_C1 * when;
4707 u += SEED_C3 * (U32)PerlProc_getpid();
4708 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4709 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4710 u += SEED_C5 * (U32)PTR2UV(&when);
4716 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4718 #ifndef NO_PERL_HASH_ENV
4723 PERL_ARGS_ASSERT_GET_HASH_SEED;
4725 #ifndef NO_PERL_HASH_ENV
4726 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4729 # ifndef USE_HASH_SEED_EXPLICIT
4731 /* ignore leading spaces */
4732 while (isSPACE(*env_pv))
4734 # ifdef USE_PERL_PERTURB_KEYS
4735 /* if they set it to "0" we disable key traversal randomization completely */
4736 if (strEQ(env_pv,"0")) {
4737 PL_hash_rand_bits_enabled= 0;
4739 /* otherwise switch to deterministic mode */
4740 PL_hash_rand_bits_enabled= 2;
4743 /* ignore a leading 0x... if it is there */
4744 if (env_pv[0] == '0' && env_pv[1] == 'x')
4747 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4748 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4749 if ( isXDIGIT(*env_pv)) {
4750 seed_buffer[i] |= READ_XDIGIT(env_pv);
4753 while (isSPACE(*env_pv))
4756 if (*env_pv && !isXDIGIT(*env_pv)) {
4757 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4759 /* should we check for unparsed crap? */
4760 /* should we warn about unused hex? */
4761 /* should we warn about insufficient hex? */
4767 (void)seedDrand01((Rand_seed_t)seed());
4769 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4770 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4773 #ifdef USE_PERL_PERTURB_KEYS
4774 { /* initialize PL_hash_rand_bits from the hash seed.
4775 * This value is highly volatile, it is updated every
4776 * hash insert, and is used as part of hash bucket chain
4777 * randomization and hash iterator randomization. */
4778 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4779 for( i = 0; i < sizeof(UV) ; i++ ) {
4780 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4781 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4784 # ifndef NO_PERL_HASH_ENV
4785 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4787 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4788 PL_hash_rand_bits_enabled= 0;
4789 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4790 PL_hash_rand_bits_enabled= 1;
4791 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4792 PL_hash_rand_bits_enabled= 2;
4794 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4801 #ifdef PERL_GLOBAL_STRUCT
4803 #define PERL_GLOBAL_STRUCT_INIT
4804 #include "opcode.h" /* the ppaddr and check */
4807 Perl_init_global_struct(pTHX)
4809 struct perl_vars *plvarsp = NULL;
4810 # ifdef PERL_GLOBAL_STRUCT
4811 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4812 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4813 PERL_UNUSED_CONTEXT;
4814 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4815 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4816 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4820 plvarsp = PL_VarsPtr;
4821 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4826 # define PERLVAR(prefix,var,type) /**/
4827 # define PERLVARA(prefix,var,n,type) /**/
4828 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4829 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4830 # include "perlvars.h"
4835 # ifdef PERL_GLOBAL_STRUCT
4838 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4839 if (!plvarsp->Gppaddr)
4843 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4844 if (!plvarsp->Gcheck)
4846 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4847 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4849 # ifdef PERL_SET_VARS
4850 PERL_SET_VARS(plvarsp);
4852 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4853 plvarsp->Gsv_placeholder.sv_flags = 0;
4854 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4856 # undef PERL_GLOBAL_STRUCT_INIT
4861 #endif /* PERL_GLOBAL_STRUCT */
4863 #ifdef PERL_GLOBAL_STRUCT
4866 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4868 int veto = plvarsp->Gveto_cleanup;
4870 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4871 PERL_UNUSED_CONTEXT;
4872 # ifdef PERL_GLOBAL_STRUCT
4873 # ifdef PERL_UNSET_VARS
4874 PERL_UNSET_VARS(plvarsp);
4878 free(plvarsp->Gppaddr);
4879 free(plvarsp->Gcheck);
4880 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4886 #endif /* PERL_GLOBAL_STRUCT */
4890 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4891 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4892 * given, and you supply your own implementation.
4894 * The default implementation reads a single env var, PERL_MEM_LOG,
4895 * expecting one or more of the following:
4897 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4898 * 'm' - memlog was PERL_MEM_LOG=1
4899 * 's' - svlog was PERL_SV_LOG=1
4900 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4902 * This makes the logger controllable enough that it can reasonably be
4903 * added to the system perl.
4906 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4907 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4909 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4911 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4912 * writes to. In the default logger, this is settable at runtime.
4914 #ifndef PERL_MEM_LOG_FD
4915 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4918 #ifndef PERL_MEM_LOG_NOIMPL
4920 # ifdef DEBUG_LEAKING_SCALARS
4921 # define SV_LOG_SERIAL_FMT " [%lu]"
4922 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4924 # define SV_LOG_SERIAL_FMT
4925 # define _SV_LOG_SERIAL_ARG(sv)
4929 S_mem_log_common(enum mem_log_type mlt, const UV n,
4930 const UV typesize, const char *type_name, const SV *sv,
4931 Malloc_t oldalloc, Malloc_t newalloc,
4932 const char *filename, const int linenumber,
4933 const char *funcname)
4937 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4939 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4942 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4944 /* We can't use SVs or PerlIO for obvious reasons,
4945 * so we'll use stdio and low-level IO instead. */
4946 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4948 # ifdef HAS_GETTIMEOFDAY
4949 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4950 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4952 gettimeofday(&tv, 0);
4954 # define MEM_LOG_TIME_FMT "%10d: "
4955 # define MEM_LOG_TIME_ARG (int)when
4959 /* If there are other OS specific ways of hires time than
4960 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4961 * probably that they would be used to fill in the struct
4968 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4969 && uv && uv <= PERL_INT_MAX
4973 fd = PERL_MEM_LOG_FD;
4976 if (strchr(pmlenv, 't')) {
4977 len = my_snprintf(buf, sizeof(buf),
4978 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4979 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4983 len = my_snprintf(buf, sizeof(buf),
4984 "alloc: %s:%d:%s: %" IVdf " %" UVuf
4985 " %s = %" IVdf ": %" UVxf "\n",
4986 filename, linenumber, funcname, n, typesize,
4987 type_name, n * typesize, PTR2UV(newalloc));
4990 len = my_snprintf(buf, sizeof(buf),
4991 "realloc: %s:%d:%s: %" IVdf " %" UVuf
4992 " %s = %" IVdf ": %" UVxf " -> %" UVxf "\n",
4993 filename, linenumber, funcname, n, typesize,
4994 type_name, n * typesize, PTR2UV(oldalloc),
4998 len = my_snprintf(buf, sizeof(buf),
4999 "free: %s:%d:%s: %" UVxf "\n",
5000 filename, linenumber, funcname,
5005 len = my_snprintf(buf, sizeof(buf),
5006 "%s_SV: %s:%d:%s: %" UVxf SV_LOG_SERIAL_FMT "\n",
5007 mlt == MLT_NEW_SV ? "new" : "del",
5008 filename, linenumber, funcname,
5009 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5014 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5018 #endif /* !PERL_MEM_LOG_NOIMPL */
5020 #ifndef PERL_MEM_LOG_NOIMPL
5022 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5023 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5025 /* this is suboptimal, but bug compatible. User is providing their
5026 own implementation, but is getting these functions anyway, and they
5027 do nothing. But _NOIMPL users should be able to cope or fix */
5029 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5030 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5034 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5036 const char *filename, const int linenumber,
5037 const char *funcname)
5039 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5041 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5042 NULL, NULL, newalloc,
5043 filename, linenumber, funcname);
5048 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5049 Malloc_t oldalloc, Malloc_t newalloc,
5050 const char *filename, const int linenumber,
5051 const char *funcname)
5053 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5055 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5056 NULL, oldalloc, newalloc,
5057 filename, linenumber, funcname);
5062 Perl_mem_log_free(Malloc_t oldalloc,
5063 const char *filename, const int linenumber,
5064 const char *funcname)
5066 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5068 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5069 filename, linenumber, funcname);
5074 Perl_mem_log_new_sv(const SV *sv,
5075 const char *filename, const int linenumber,
5076 const char *funcname)
5078 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5079 filename, linenumber, funcname);
5083 Perl_mem_log_del_sv(const SV *sv,
5084 const char *filename, const int linenumber,
5085 const char *funcname)
5087 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5088 filename, linenumber, funcname);
5091 #endif /* PERL_MEM_LOG */
5094 =for apidoc my_sprintf
5096 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5097 the length of the string written to the buffer. Only rare pre-ANSI systems
5098 need the wrapper function - usually this is a direct call to C<sprintf>.
5102 #ifndef SPRINTF_RETURNS_STRLEN
5104 Perl_my_sprintf(char *buffer, const char* pat, ...)
5107 PERL_ARGS_ASSERT_MY_SPRINTF;
5108 va_start(args, pat);
5109 vsprintf(buffer, pat, args);
5111 return strlen(buffer);
5116 =for apidoc quadmath_format_single
5118 C<quadmath_snprintf()> is very strict about its C<format> string and will
5119 fail, returning -1, if the format is invalid. It accepts exactly
5122 C<quadmath_format_single()> checks that the intended single spec looks
5123 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5124 and has C<Q> before it. This is not a full "printf syntax check",
5127 Returns the format if it is valid, NULL if not.
5129 C<quadmath_format_single()> can and will actually patch in the missing
5130 C<Q>, if necessary. In this case it will return the modified copy of
5131 the format, B<which the caller will need to free.>
5133 See also L</quadmath_format_needed>.
5139 Perl_quadmath_format_single(const char* format)
5143 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5145 if (format[0] != '%' || strchr(format + 1, '%'))
5147 len = strlen(format);
5148 /* minimum length three: %Qg */
5149 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5151 if (format[len - 2] != 'Q') {
5153 Newx(fixed, len + 1, char);
5154 memcpy(fixed, format, len - 1);
5155 fixed[len - 1] = 'Q';
5156 fixed[len ] = format[len - 1];
5158 return (const char*)fixed;
5165 =for apidoc quadmath_format_needed
5167 C<quadmath_format_needed()> returns true if the C<format> string seems to
5168 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5169 or returns false otherwise.
5171 The format specifier detection is not complete printf-syntax detection,
5172 but it should catch most common cases.
5174 If true is returned, those arguments B<should> in theory be processed
5175 with C<quadmath_snprintf()>, but in case there is more than one such
5176 format specifier (see L</quadmath_format_single>), and if there is
5177 anything else beyond that one (even just a single byte), they
5178 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5179 accepting only one format spec, and nothing else.
5180 In this case, the code should probably fail.
5186 Perl_quadmath_format_needed(const char* format)
5188 const char *p = format;
5191 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5193 while ((q = strchr(p, '%'))) {
5195 if (*q == '+') /* plus */
5197 if (*q == '#') /* alt */
5199 if (*q == '*') /* width */
5203 while (isDIGIT(*q)) q++;
5206 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5211 while (isDIGIT(*q)) q++;
5213 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5222 =for apidoc my_snprintf
5224 The C library C<snprintf> functionality, if available and
5225 standards-compliant (uses C<vsnprintf>, actually). However, if the
5226 C<vsnprintf> is not available, will unfortunately use the unsafe
5227 C<vsprintf> which can overrun the buffer (there is an overrun check,
5228 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5229 getting C<vsnprintf>.
5234 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5238 PERL_ARGS_ASSERT_MY_SNPRINTF;
5239 #ifndef HAS_VSNPRINTF
5240 PERL_UNUSED_VAR(len);
5242 va_start(ap, format);
5245 const char* qfmt = quadmath_format_single(format);
5246 bool quadmath_valid = FALSE;
5248 /* If the format looked promising, use it as quadmath. */
5249 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5251 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5252 quadmath_valid = TRUE;
5257 assert(qfmt == NULL);
5258 /* quadmath_format_single() will return false for example for
5259 * "foo = %g", or simply "%g". We could handle the %g by
5260 * using quadmath for the NV args. More complex cases of
5261 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5262 * quadmath-valid but has stuff in front).
5264 * Handling the "Q-less" cases right would require walking
5265 * through the va_list and rewriting the format, calling
5266 * quadmath for the NVs, building a new va_list, and then
5267 * letting vsnprintf/vsprintf to take care of the other
5268 * arguments. This may be doable.
5270 * We do not attempt that now. But for paranoia, we here try
5271 * to detect some common (but not all) cases where the
5272 * "Q-less" %[efgaEFGA] formats are present, and die if
5273 * detected. This doesn't fix the problem, but it stops the
5274 * vsnprintf/vsprintf pulling doubles off the va_list when
5275 * __float128 NVs should be pulled off instead.
5277 * If quadmath_format_needed() returns false, we are reasonably
5278 * certain that we can call vnsprintf() or vsprintf() safely. */
5279 if (!quadmath_valid && quadmath_format_needed(format))
5280 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5285 #ifdef HAS_VSNPRINTF
5286 retval = vsnprintf(buffer, len, format, ap);
5288 retval = vsprintf(buffer, format, ap);
5291 /* vsprintf() shows failure with < 0 */
5293 #ifdef HAS_VSNPRINTF
5294 /* vsnprintf() shows failure with >= len */
5296 (len > 0 && (Size_t)retval >= len)
5299 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5304 =for apidoc my_vsnprintf
5306 The C library C<vsnprintf> if available and standards-compliant.
5307 However, if if the C<vsnprintf> is not available, will unfortunately
5308 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5309 overrun check, but that may be too late). Consider using
5310 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5315 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5318 PERL_UNUSED_ARG(buffer);
5319 PERL_UNUSED_ARG(len);
5320 PERL_UNUSED_ARG(format);
5321 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5322 PERL_UNUSED_ARG((void*)ap);
5323 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5330 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5331 Perl_va_copy(ap, apc);
5332 # ifdef HAS_VSNPRINTF
5333 retval = vsnprintf(buffer, len, format, apc);
5335 PERL_UNUSED_ARG(len);
5336 retval = vsprintf(buffer, format, apc);
5340 # ifdef HAS_VSNPRINTF
5341 retval = vsnprintf(buffer, len, format, ap);
5343 PERL_UNUSED_ARG(len);
5344 retval = vsprintf(buffer, format, ap);
5346 #endif /* #ifdef NEED_VA_COPY */
5347 /* vsprintf() shows failure with < 0 */
5349 #ifdef HAS_VSNPRINTF
5350 /* vsnprintf() shows failure with >= len */
5352 (len > 0 && (Size_t)retval >= len)
5355 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5361 Perl_my_clearenv(pTHX)
5364 #if ! defined(PERL_MICRO)
5365 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5367 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5368 # if defined(USE_ENVIRON_ARRAY)
5369 # if defined(USE_ITHREADS)
5370 /* only the parent thread can clobber the process environment */
5371 if (PL_curinterp == aTHX)
5372 # endif /* USE_ITHREADS */
5374 # if ! defined(PERL_USE_SAFE_PUTENV)
5375 if ( !PL_use_safe_putenv) {
5377 if (environ == PL_origenviron)
5378 environ = (char**)safesysmalloc(sizeof(char*));
5380 for (i = 0; environ[i]; i++)
5381 (void)safesysfree(environ[i]);
5384 # else /* PERL_USE_SAFE_PUTENV */
5385 # if defined(HAS_CLEARENV)
5387 # elif defined(HAS_UNSETENV)
5388 int bsiz = 80; /* Most envvar names will be shorter than this. */
5389 char *buf = (char*)safesysmalloc(bsiz);
5390 while (*environ != NULL) {
5391 char *e = strchr(*environ, '=');
5392 int l = e ? e - *environ : (int)strlen(*environ);
5394 (void)safesysfree(buf);
5395 bsiz = l + 1; /* + 1 for the \0. */
5396 buf = (char*)safesysmalloc(bsiz);
5398 memcpy(buf, *environ, l);
5400 (void)unsetenv(buf);
5402 (void)safesysfree(buf);
5403 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5404 /* Just null environ and accept the leakage. */
5406 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5407 # endif /* ! PERL_USE_SAFE_PUTENV */
5409 # endif /* USE_ENVIRON_ARRAY */
5410 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5411 #endif /* PERL_MICRO */
5414 #ifdef PERL_IMPLICIT_CONTEXT
5416 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5417 the global PL_my_cxt_index is incremented, and that value is assigned to
5418 that module's static my_cxt_index (who's address is passed as an arg).
5419 Then, for each interpreter this function is called for, it makes sure a
5420 void* slot is available to hang the static data off, by allocating or
5421 extending the interpreter's PL_my_cxt_list array */
5423 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5425 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5429 PERL_ARGS_ASSERT_MY_CXT_INIT;
5431 /* this module hasn't been allocated an index yet */
5432 #if defined(USE_ITHREADS)
5433 MUTEX_LOCK(&PL_my_ctx_mutex);
5435 *index = PL_my_cxt_index++;
5436 #if defined(USE_ITHREADS)
5437 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5441 /* make sure the array is big enough */
5442 if (PL_my_cxt_size <= *index) {
5443 if (PL_my_cxt_size) {
5444 while (PL_my_cxt_size <= *index)
5445 PL_my_cxt_size *= 2;
5446 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5449 PL_my_cxt_size = 16;
5450 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5453 /* newSV() allocates one more than needed */
5454 p = (void*)SvPVX(newSV(size-1));
5455 PL_my_cxt_list[*index] = p;
5456 Zero(p, size, char);
5460 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5463 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5468 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5470 for (index = 0; index < PL_my_cxt_index; index++) {
5471 const char *key = PL_my_cxt_keys[index];
5472 /* try direct pointer compare first - there are chances to success,
5473 * and it's much faster.
5475 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5482 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5488 PERL_ARGS_ASSERT_MY_CXT_INIT;
5490 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5492 /* this module hasn't been allocated an index yet */
5493 #if defined(USE_ITHREADS)
5494 MUTEX_LOCK(&PL_my_ctx_mutex);
5496 index = PL_my_cxt_index++;
5497 #if defined(USE_ITHREADS)
5498 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5502 /* make sure the array is big enough */
5503 if (PL_my_cxt_size <= index) {
5504 int old_size = PL_my_cxt_size;
5506 if (PL_my_cxt_size) {
5507 while (PL_my_cxt_size <= index)
5508 PL_my_cxt_size *= 2;
5509 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5510 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5513 PL_my_cxt_size = 16;
5514 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5515 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5517 for (i = old_size; i < PL_my_cxt_size; i++) {
5518 PL_my_cxt_keys[i] = 0;
5519 PL_my_cxt_list[i] = 0;
5522 PL_my_cxt_keys[index] = my_cxt_key;
5523 /* newSV() allocates one more than needed */
5524 p = (void*)SvPVX(newSV(size-1));
5525 PL_my_cxt_list[index] = p;
5526 Zero(p, size, char);
5529 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5530 #endif /* PERL_IMPLICIT_CONTEXT */
5533 /* Perl_xs_handshake():
5534 implement the various XS_*_BOOTCHECK macros, which are added to .c
5535 files by ExtUtils::ParseXS, to check that the perl the module was built
5536 with is binary compatible with the running perl.
5539 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5540 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5542 The meaning of the varargs is determined the U32 key arg (which is not
5543 a format string). The fields of key are assembled by using HS_KEY().
5545 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5546 "PerlInterpreter *" and represents the callers context; otherwise it is
5547 of type "CV *", and is the boot xsub's CV.
5549 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5550 for example, and IO.dll was linked with threaded perl524.dll, and both
5551 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5552 successfully can load IO.dll into the process but simultaneously it
5553 loaded an interpreter of a different version into the process, and XS
5554 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5555 use through perl526.dll's my_perl->Istack_base.
5557 v_my_perl cannot be the first arg, since then 'key' will be out of
5558 place in a threaded vs non-threaded mixup; and analyzing the key
5559 number's bitfields won't reveal the problem, since it will be a valid
5560 key (unthreaded perl) on interp side, but croak will report the XS mod's
5561 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5562 it's a threaded perl and an unthreaded XS module, threaded perl will
5563 look at an uninit C stack or an uninit register to get 'key'
5564 (remember that it assumes that the 1st arg is the interp cxt).
5566 'file' is the source filename of the caller.
5570 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5576 #ifdef PERL_IMPLICIT_CONTEXT
5583 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5584 va_start(args, file);
5586 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5587 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5588 if (UNLIKELY(got != need))
5590 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5591 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5592 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5593 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5594 passed to the XS DLL */
5595 #ifdef PERL_IMPLICIT_CONTEXT
5596 xs_interp = (tTHX)v_my_perl;
5600 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5601 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5602 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5603 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5604 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5605 location in the unthreaded perl binary) stored in CV * to figure out if this
5606 Perl_xs_handshake was called by the same pp_entersub */
5607 cv = (CV*)v_my_perl;
5608 xs_spp = (SV***)CvHSCXT(cv);
5610 need = &PL_stack_sp;
5612 if(UNLIKELY(got != need)) {
5613 bad_handshake:/* recycle branch and string from above */
5614 if(got != (void *)HSf_NOCHK)
5615 noperl_die("%s: loadable library and perl binaries are mismatched"
5616 " (got handshake key %p, needed %p)\n",
5620 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5621 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5622 PL_xsubfilename = file; /* so the old name must be restored for
5623 additional XSUBs to register themselves */
5624 /* XSUBs can't be perl lang/perl5db.pl debugged
5625 if (PERLDB_LINE_OR_SAVESRC)
5626 (void)gv_fetchfile(file); */
5629 if(key & HSf_POPMARK) {
5631 { SV **mark = PL_stack_base + ax++;
5633 items = (I32)(SP - MARK);
5637 items = va_arg(args, U32);
5638 ax = va_arg(args, U32);
5642 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5643 if((apiverlen = HS_GETAPIVERLEN(key))) {
5644 char * api_p = va_arg(args, char*);
5645 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5646 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5647 sizeof("v" PERL_API_VERSION_STRING)-1))
5648 Perl_croak_nocontext("Perl API version %s of %" SVf " does not match %s",
5649 api_p, SVfARG(PL_stack_base[ax + 0]),
5650 "v" PERL_API_VERSION_STRING);
5655 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5656 if((xsverlen = HS_GETXSVERLEN(key)))
5657 S_xs_version_bootcheck(aTHX_
5658 items, ax, va_arg(args, char*), xsverlen);
5666 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5670 const char *vn = NULL;
5671 SV *const module = PL_stack_base[ax];
5673 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5675 if (items >= 2) /* version supplied as bootstrap arg */
5676 sv = PL_stack_base[ax + 1];
5678 /* XXX GV_ADDWARN */
5680 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5681 if (!sv || !SvOK(sv)) {
5683 sv = get_sv(Perl_form(aTHX_ "%" SVf "::%s", SVfARG(module), vn), 0);
5687 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5688 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5689 ? sv : sv_2mortal(new_version(sv));
5690 xssv = upg_version(xssv, 0);
5691 if ( vcmp(pmsv,xssv) ) {
5692 SV *string = vstringify(xssv);
5693 SV *xpt = Perl_newSVpvf(aTHX_ "%" SVf " object version %" SVf
5694 " does not match ", SVfARG(module), SVfARG(string));
5696 SvREFCNT_dec(string);
5697 string = vstringify(pmsv);
5700 Perl_sv_catpvf(aTHX_ xpt, "$%" SVf "::%s %" SVf, SVfARG(module), vn,
5703 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %" SVf, SVfARG(string));
5705 SvREFCNT_dec(string);
5707 Perl_sv_2mortal(aTHX_ xpt);
5708 Perl_croak_sv(aTHX_ xpt);
5714 =for apidoc my_strlcat
5716 The C library C<strlcat> if available, or a Perl implementation of it.
5717 This operates on C C<NUL>-terminated strings.
5719 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5720 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5721 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5722 practice this should not happen as it means that either C<size> is incorrect or
5723 that C<dst> is not a proper C<NUL>-terminated string).
5725 Note that C<size> is the full size of the destination buffer and
5726 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5727 room for the C<NUL> should be included in C<size>.
5729 The return value is the total length that C<dst> would have if C<size> is
5730 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5731 C<src>. If C<size> is smaller than the return, the excess was not appended.
5735 Description stolen from http://man.openbsd.org/strlcat.3
5739 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5741 Size_t used, length, copy;
5744 length = strlen(src);
5745 if (size > 0 && used < size - 1) {
5746 copy = (length >= size - used) ? size - used - 1 : length;
5747 memcpy(dst + used, src, copy);
5748 dst[used + copy] = '\0';
5750 return used + length;
5756 =for apidoc my_strlcpy
5758 The C library C<strlcpy> if available, or a Perl implementation of it.
5759 This operates on C C<NUL>-terminated strings.
5761 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5762 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5764 The return value is the total length C<src> would be if the copy completely
5765 succeeded. If it is larger than C<size>, the excess was not copied.
5769 Description stolen from http://man.openbsd.org/strlcpy.3
5773 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5775 Size_t length, copy;
5777 length = strlen(src);
5779 copy = (length >= size) ? size - 1 : length;
5780 memcpy(dst, src, copy);
5787 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5788 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5789 long _ftol( double ); /* Defined by VC6 C libs. */
5790 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5793 PERL_STATIC_INLINE bool
5794 S_gv_has_usable_name(pTHX_ GV *gv)
5798 && HvENAME(GvSTASH(gv))
5799 && (gvp = (GV **)hv_fetchhek(
5800 GvSTASH(gv), GvNAME_HEK(gv), 0
5806 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5808 SV * const dbsv = GvSVn(PL_DBsub);
5809 const bool save_taint = TAINT_get;
5811 /* When we are called from pp_goto (svp is null),
5812 * we do not care about using dbsv to call CV;
5813 * it's for informational purposes only.
5816 PERL_ARGS_ASSERT_GET_DB_SUB;
5820 if (!PERLDB_SUB_NN) {
5823 if (!svp && !CvLEXICAL(cv)) {
5824 gv_efullname3(dbsv, gv, NULL);
5826 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5827 || strEQ(GvNAME(gv), "END")
5828 || ( /* Could be imported, and old sub redefined. */
5829 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5831 !( (SvTYPE(*svp) == SVt_PVGV)
5832 && (GvCV((const GV *)*svp) == cv)
5833 /* Use GV from the stack as a fallback. */
5834 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5838 /* GV is potentially non-unique, or contain different CV. */
5839 SV * const tmp = newRV(MUTABLE_SV(cv));
5840 sv_setsv(dbsv, tmp);
5844 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5845 sv_catpvs(dbsv, "::");
5846 sv_cathek(dbsv, GvNAME_HEK(gv));
5850 const int type = SvTYPE(dbsv);
5851 if (type < SVt_PVIV && type != SVt_IV)
5852 sv_upgrade(dbsv, SVt_PVIV);
5853 (void)SvIOK_on(dbsv);
5854 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5857 TAINT_IF(save_taint);
5858 #ifdef NO_TAINT_SUPPORT
5859 PERL_UNUSED_VAR(save_taint);
5864 Perl_my_dirfd(DIR * dir) {
5866 /* Most dirfd implementations have problems when passed NULL. */
5871 #elif defined(HAS_DIR_DD_FD)
5874 Perl_croak_nocontext(PL_no_func, "dirfd");
5875 NOT_REACHED; /* NOTREACHED */
5881 Perl_get_re_arg(pTHX_ SV *sv) {
5887 sv = MUTABLE_SV(SvRV(sv));
5888 if (SvTYPE(sv) == SVt_REGEXP)
5889 return (REGEXP*) sv;
5896 * This code is derived from drand48() implementation from FreeBSD,
5897 * found in lib/libc/gen/_rand48.c.
5899 * The U64 implementation is original, based on the POSIX
5900 * specification for drand48().
5904 * Copyright (c) 1993 Martin Birgmeier
5905 * All rights reserved.
5907 * You may redistribute unmodified or modified versions of this source
5908 * code provided that the above copyright notice and this and the
5909 * following conditions are retained.
5911 * This software is provided ``as is'', and comes with no warranties
5912 * of any kind. I shall in no event be liable for anything that happens
5913 * to anyone/anything when using this software.
5916 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5918 #ifdef PERL_DRAND48_QUAD
5920 #define DRAND48_MULT U64_CONST(0x5deece66d)
5921 #define DRAND48_ADD 0xb
5922 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5926 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5927 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5928 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5929 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5930 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5931 #define FREEBSD_DRAND48_ADD (0x000b)
5933 const unsigned short _rand48_mult[3] = {
5934 FREEBSD_DRAND48_MULT_0,
5935 FREEBSD_DRAND48_MULT_1,
5936 FREEBSD_DRAND48_MULT_2
5938 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5943 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5945 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5947 #ifdef PERL_DRAND48_QUAD
5948 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5950 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5951 random_state->seed[1] = (U16) seed;
5952 random_state->seed[2] = (U16) (seed >> 16);
5957 Perl_drand48_r(perl_drand48_t *random_state)
5959 PERL_ARGS_ASSERT_DRAND48_R;
5961 #ifdef PERL_DRAND48_QUAD
5962 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5965 return ldexp((double)*random_state, -48);
5971 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5972 + (U32) _rand48_add;
5973 temp[0] = (U16) accu; /* lower 16 bits */
5974 accu >>= sizeof(U16) * 8;
5975 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5976 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5977 temp[1] = (U16) accu; /* middle 16 bits */
5978 accu >>= sizeof(U16) * 8;
5979 accu += _rand48_mult[0] * random_state->seed[2]
5980 + _rand48_mult[1] * random_state->seed[1]
5981 + _rand48_mult[2] * random_state->seed[0];
5982 random_state->seed[0] = temp[0];
5983 random_state->seed[1] = temp[1];
5984 random_state->seed[2] = (U16) accu;
5986 return ldexp((double) random_state->seed[0], -48) +
5987 ldexp((double) random_state->seed[1], -32) +
5988 ldexp((double) random_state->seed[2], -16);
5993 #ifdef USE_C_BACKTRACE
5995 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
6000 /* abfd is the BFD handle. */
6002 /* bfd_syms is the BFD symbol table. */
6004 /* bfd_text is handle to the the ".text" section of the object file. */
6006 /* Since opening the executable and scanning its symbols is quite
6007 * heavy operation, we remember the filename we used the last time,
6008 * and do the opening and scanning only if the filename changes.
6009 * This removes most (but not all) open+scan cycles. */
6010 const char* fname_prev;
6013 /* Given a dl_info, update the BFD context if necessary. */
6014 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
6016 /* BFD open and scan only if the filename changed. */
6017 if (ctx->fname_prev == NULL ||
6018 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6020 bfd_close(ctx->abfd);
6022 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6024 if (bfd_check_format(ctx->abfd, bfd_object)) {
6025 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6026 if (symbol_size > 0) {
6027 Safefree(ctx->bfd_syms);
6028 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6030 bfd_get_section_by_name(ctx->abfd, ".text");
6038 ctx->fname_prev = dl_info->dli_fname;
6042 /* Given a raw frame, try to symbolize it and store
6043 * symbol information (source file, line number) away. */
6044 static void bfd_symbolize(bfd_context* ctx,
6047 STRLEN* symbol_name_size,
6049 STRLEN* source_name_size,
6050 STRLEN* source_line)
6052 *symbol_name = NULL;
6053 *symbol_name_size = 0;
6055 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6057 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6060 unsigned int line = 0;
6061 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6062 ctx->bfd_syms, offset,
6063 &file, &func, &line) &&
6064 file && func && line > 0) {
6065 /* Size and copy the source file, use only
6066 * the basename of the source file.
6068 * NOTE: the basenames are fine for the
6069 * Perl source files, but may not always
6070 * be the best idea for XS files. */
6071 const char *p, *b = NULL;
6072 /* Look for the last slash. */
6073 for (p = file; *p; p++) {
6077 if (b == NULL || *b == 0) {
6080 *source_name_size = p - b + 1;
6081 Newx(*source_name, *source_name_size + 1, char);
6082 Copy(b, *source_name, *source_name_size + 1, char);
6084 *symbol_name_size = strlen(func);
6085 Newx(*symbol_name, *symbol_name_size + 1, char);
6086 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6088 *source_line = line;
6094 #endif /* #ifdef USE_BFD */
6098 /* OS X has no public API for for 'symbolicating' (Apple official term)
6099 * stack addresses to {function_name, source_file, line_number}.
6100 * Good news: there is command line utility atos(1) which does that.
6101 * Bad news 1: it's a command line utility.
6102 * Bad news 2: one needs to have the Developer Tools installed.
6103 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6105 * To recap: we need to open a pipe for reading for a utility which
6106 * might not exist, or exists in different locations, and then parse
6107 * the output. And since this is all for a low-level API, we cannot
6108 * use high-level stuff. Thanks, Apple. */
6111 /* tool is set to the absolute pathname of the tool to use:
6114 /* format is set to a printf format string used for building
6115 * the external command to run. */
6117 /* unavail is set if e.g. xcrun cannot be found, or something
6118 * else happens that makes getting the backtrace dubious. Note,
6119 * however, that the context isn't persistent, the next call to
6120 * get_c_backtrace() will start from scratch. */
6122 /* fname is the current object file name. */
6124 /* object_base_addr is the base address of the shared object. */
6125 void* object_base_addr;
6128 /* Given |dl_info|, updates the context. If the context has been
6129 * marked unavailable, return immediately. If not but the tool has
6130 * not been set, set it to either "xcrun atos" or "atos" (also set the
6131 * format to use for creating commands for piping), or if neither is
6132 * unavailable (one needs the Developer Tools installed), mark the context
6133 * an unavailable. Finally, update the filename (object name),
6134 * and its base address. */
6136 static void atos_update(atos_context* ctx,
6141 if (ctx->tool == NULL) {
6142 const char* tools[] = {
6146 const char* formats[] = {
6147 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6148 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6152 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6153 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6154 ctx->tool = tools[i];
6155 ctx->format = formats[i];
6159 if (ctx->tool == NULL) {
6160 ctx->unavail = TRUE;
6164 if (ctx->fname == NULL ||
6165 strNE(dl_info->dli_fname, ctx->fname)) {
6166 ctx->fname = dl_info->dli_fname;
6167 ctx->object_base_addr = dl_info->dli_fbase;
6171 /* Given an output buffer end |p| and its |start|, matches
6172 * for the atos output, extracting the source code location
6173 * and returning non-NULL if possible, returning NULL otherwise. */
6174 static const char* atos_parse(const char* p,
6176 STRLEN* source_name_size,
6177 STRLEN* source_line) {
6178 /* atos() output is something like:
6179 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6180 * We cannot use Perl regular expressions, because we need to
6181 * stay low-level. Therefore here we have a rolled-out version
6182 * of a state machine which matches _backwards_from_the_end_ and
6183 * if there's a success, returns the starts of the filename,
6184 * also setting the filename size and the source line number.
6185 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6186 const char* source_number_start;
6187 const char* source_name_end;
6188 const char* source_line_end;
6189 const char* close_paren;
6192 /* Skip trailing whitespace. */
6193 while (p > start && isspace(*p)) p--;
6194 /* Now we should be at the close paren. */
6195 if (p == start || *p != ')')
6199 /* Now we should be in the line number. */
6200 if (p == start || !isdigit(*p))
6202 /* Skip over the digits. */
6203 while (p > start && isdigit(*p))
6205 /* Now we should be at the colon. */
6206 if (p == start || *p != ':')
6208 source_number_start = p + 1;
6209 source_name_end = p; /* Just beyond the end. */
6211 /* Look for the open paren. */
6212 while (p > start && *p != '(')
6217 *source_name_size = source_name_end - p;
6218 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6219 && source_line_end == close_paren
6220 && uv <= PERL_INT_MAX
6222 *source_line = (STRLEN)uv;
6228 /* Given a raw frame, read a pipe from the symbolicator (that's the
6229 * technical term) atos, reads the result, and parses the source code
6230 * location. We must stay low-level, so we use snprintf(), pipe(),
6231 * and fread(), and then also parse the output ourselves. */
6232 static void atos_symbolize(atos_context* ctx,
6235 STRLEN* source_name_size,
6236 STRLEN* source_line)
6244 /* Simple security measure: if there's any funny business with
6245 * the object name (used as "-o '%s'" ), leave since at least
6246 * partially the user controls it. */
6247 for (p = ctx->fname; *p; p++) {
6248 if (*p == '\'' || iscntrl(*p)) {
6249 ctx->unavail = TRUE;
6253 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6254 ctx->fname, ctx->object_base_addr, raw_frame);
6255 if (cnt < sizeof(cmd)) {
6256 /* Undo nostdio.h #defines that disable stdio.
6257 * This is somewhat naughty, but is used elsewhere
6258 * in the core, and affects only OS X. */
6263 FILE* fp = popen(cmd, "r");
6264 /* At the moment we open a new pipe for each stack frame.
6265 * This is naturally somewhat slow, but hopefully generating
6266 * stack traces is never going to in a performance critical path.
6268 * We could play tricks with atos by batching the stack
6269 * addresses to be resolved: atos can either take multiple
6270 * addresses from the command line, or read addresses from
6271 * a file (though the mess of creating temporary files would
6272 * probably negate much of any possible speedup).
6274 * Normally there are only two objects present in the backtrace:
6275 * perl itself, and the libdyld.dylib. (Note that the object
6276 * filenames contain the full pathname, so perl may not always
6277 * be in the same place.) Whenever the object in the
6278 * backtrace changes, the base address also changes.
6280 * The problem with batching the addresses, though, would be
6281 * matching the results with the addresses: the parsing of
6282 * the results is already painful enough with a single address. */
6285 UV cnt = fread(out, 1, sizeof(out), fp);
6286 if (cnt < sizeof(out)) {
6287 const char* p = atos_parse(out + cnt - 1, out,
6292 *source_name_size, char);
6293 Copy(p, *source_name,
6294 *source_name_size, char);
6302 #endif /* #ifdef PERL_DARWIN */
6305 =for apidoc get_c_backtrace
6307 Collects the backtrace (aka "stacktrace") into a single linear
6308 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6310 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6311 returning at most C<depth> frames.
6317 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6319 /* Note that here we must stay as low-level as possible: Newx(),
6320 * Copy(), Safefree(); since we may be called from anywhere,
6321 * so we should avoid higher level constructs like SVs or AVs.
6323 * Since we are using safesysmalloc() via Newx(), don't try
6324 * getting backtrace() there, unless you like deep recursion. */
6326 /* Currently only implemented with backtrace() and dladdr(),
6327 * for other platforms NULL is returned. */
6329 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6330 /* backtrace() is available via <execinfo.h> in glibc and in most
6331 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6333 /* We try fetching this many frames total, but then discard
6334 * the |skip| first ones. For the remaining ones we will try
6335 * retrieving more information with dladdr(). */
6336 int try_depth = skip + depth;
6338 /* The addresses (program counters) returned by backtrace(). */
6341 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6344 /* Sizes _including_ the terminating \0 of the object name
6345 * and symbol name strings. */
6346 STRLEN* object_name_sizes;
6347 STRLEN* symbol_name_sizes;
6350 /* The symbol names comes either from dli_sname,
6351 * or if using BFD, they can come from BFD. */
6352 char** symbol_names;
6355 /* The source code location information. Dug out with e.g. BFD. */
6356 char** source_names;
6357 STRLEN* source_name_sizes;
6358 STRLEN* source_lines;
6360 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6361 int got_depth; /* How many frames were returned from backtrace(). */
6362 UV frame_count = 0; /* How many frames we return. */
6363 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6366 bfd_context bfd_ctx;
6369 atos_context atos_ctx;
6372 /* Here are probably possibilities for optimizing. We could for
6373 * example have a struct that contains most of these and then
6374 * allocate |try_depth| of them, saving a bunch of malloc calls.
6375 * Note, however, that |frames| could not be part of that struct
6376 * because backtrace() will want an array of just them. Also be
6377 * careful about the name strings. */
6378 Newx(raw_frames, try_depth, void*);
6379 Newx(dl_infos, try_depth, Dl_info);
6380 Newx(object_name_sizes, try_depth, STRLEN);
6381 Newx(symbol_name_sizes, try_depth, STRLEN);
6382 Newx(source_names, try_depth, char*);
6383 Newx(source_name_sizes, try_depth, STRLEN);
6384 Newx(source_lines, try_depth, STRLEN);
6386 Newx(symbol_names, try_depth, char*);
6389 /* Get the raw frames. */
6390 got_depth = (int)backtrace(raw_frames, try_depth);
6392 /* We use dladdr() instead of backtrace_symbols() because we want
6393 * the full details instead of opaque strings. This is useful for
6394 * two reasons: () the details are needed for further symbolic
6395 * digging, for example in OS X (2) by having the details we fully
6396 * control the output, which in turn is useful when more platforms
6397 * are added: we can keep out output "portable". */
6399 /* We want a single linear allocation, which can then be freed
6400 * with a single swoop. We will do the usual trick of first
6401 * walking over the structure and seeing how much we need to
6402 * allocate, then allocating, and then walking over the structure
6403 * the second time and populating it. */
6405 /* First we must compute the total size of the buffer. */
6406 total_bytes = sizeof(Perl_c_backtrace_header);
6407 if (got_depth > skip) {
6410 bfd_init(); /* Is this safe to call multiple times? */
6411 Zero(&bfd_ctx, 1, bfd_context);
6414 Zero(&atos_ctx, 1, atos_context);
6416 for (i = skip; i < try_depth; i++) {
6417 Dl_info* dl_info = &dl_infos[i];
6419 object_name_sizes[i] = 0;
6420 source_names[i] = NULL;
6421 source_name_sizes[i] = 0;
6422 source_lines[i] = 0;
6424 /* Yes, zero from dladdr() is failure. */
6425 if (dladdr(raw_frames[i], dl_info)) {
6426 total_bytes += sizeof(Perl_c_backtrace_frame);
6428 object_name_sizes[i] =
6429 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6430 symbol_name_sizes[i] =
6431 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6433 bfd_update(&bfd_ctx, dl_info);
6434 bfd_symbolize(&bfd_ctx, raw_frames[i],
6436 &symbol_name_sizes[i],
6438 &source_name_sizes[i],
6442 atos_update(&atos_ctx, dl_info);
6443 atos_symbolize(&atos_ctx,
6446 &source_name_sizes[i],
6450 /* Plus ones for the terminating \0. */
6451 total_bytes += object_name_sizes[i] + 1;
6452 total_bytes += symbol_name_sizes[i] + 1;
6453 total_bytes += source_name_sizes[i] + 1;
6461 Safefree(bfd_ctx.bfd_syms);
6465 /* Now we can allocate and populate the result buffer. */
6466 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6467 Zero(bt, total_bytes, char);
6468 bt->header.frame_count = frame_count;
6469 bt->header.total_bytes = total_bytes;
6470 if (frame_count > 0) {
6471 Perl_c_backtrace_frame* frame = bt->frame_info;
6472 char* name_base = (char *)(frame + frame_count);
6473 char* name_curr = name_base; /* Outputting the name strings here. */
6475 for (i = skip; i < skip + frame_count; i++) {
6476 Dl_info* dl_info = &dl_infos[i];
6478 frame->addr = raw_frames[i];
6479 frame->object_base_addr = dl_info->dli_fbase;
6480 frame->symbol_addr = dl_info->dli_saddr;
6482 /* Copies a string, including the \0, and advances the name_curr.
6483 * Also copies the start and the size to the frame. */
6484 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6486 Copy(src, name_curr, size, char); \
6487 frame->doffset = name_curr - (char*)bt; \
6488 frame->dsize = size; \
6489 name_curr += size; \
6492 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6494 object_name_size, object_name_sizes[i]);
6497 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6499 symbol_name_size, symbol_name_sizes[i]);
6500 Safefree(symbol_names[i]);
6502 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6504 symbol_name_size, symbol_name_sizes[i]);
6507 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6509 source_name_size, source_name_sizes[i]);
6510 Safefree(source_names[i]);
6512 #undef PERL_C_BACKTRACE_STRCPY
6514 frame->source_line_number = source_lines[i];
6518 assert(total_bytes ==
6519 (UV)(sizeof(Perl_c_backtrace_header) +
6520 frame_count * sizeof(Perl_c_backtrace_frame) +
6521 name_curr - name_base));
6524 Safefree(symbol_names);
6526 bfd_close(bfd_ctx.abfd);
6529 Safefree(source_lines);
6530 Safefree(source_name_sizes);
6531 Safefree(source_names);
6532 Safefree(symbol_name_sizes);
6533 Safefree(object_name_sizes);
6534 /* Assuming the strings returned by dladdr() are pointers
6535 * to read-only static memory (the object file), so that
6536 * they do not need freeing (and cannot be). */
6538 Safefree(raw_frames);
6541 PERL_UNUSED_ARGV(depth);
6542 PERL_UNUSED_ARGV(skip);
6548 =for apidoc free_c_backtrace
6550 Deallocates a backtrace received from get_c_bracktrace.
6556 =for apidoc get_c_backtrace_dump
6558 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6559 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6561 The appended output looks like:
6564 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6565 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6568 The fields are tab-separated. The first column is the depth (zero
6569 being the innermost non-skipped frame). In the hex:offset, the hex is
6570 where the program counter was in C<S_parse_body>, and the :offset (might
6571 be missing) tells how much inside the C<S_parse_body> the program counter was.
6573 The C<util.c:1716> is the source code file and line number.
6575 The F</usr/bin/perl> is obvious (hopefully).
6577 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6578 if the platform doesn't support retrieving the information;
6579 if the binary is missing the debug information;
6580 if the optimizer has transformed the code by for example inlining.
6586 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6588 Perl_c_backtrace* bt;
6590 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6592 Perl_c_backtrace_frame* frame;
6593 SV* dsv = newSVpvs("");
6595 for (i = 0, frame = bt->frame_info;
6596 i < bt->header.frame_count; i++, frame++) {
6597 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6598 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6599 /* Symbol (function) names might disappear without debug info.
6601 * The source code location might disappear in case of the
6602 * optimizer inlining or otherwise rearranging the code. */
6603 if (frame->symbol_addr) {
6604 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6606 ((char*)frame->addr - (char*)frame->symbol_addr));
6608 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6609 frame->symbol_name_size &&
6610 frame->symbol_name_offset ?
6611 (char*)bt + frame->symbol_name_offset : "-");
6612 if (frame->source_name_size &&
6613 frame->source_name_offset &&
6614 frame->source_line_number) {
6615 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%" UVuf,
6616 (char*)bt + frame->source_name_offset,
6617 (UV)frame->source_line_number);
6619 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6621 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6622 frame->object_name_size &&
6623 frame->object_name_offset ?
6624 (char*)bt + frame->object_name_offset : "-");
6625 /* The frame->object_base_addr is not output,
6626 * but it is used for symbolizing/symbolicating. */
6627 sv_catpvs(dsv, "\n");
6630 Perl_free_c_backtrace(bt);
6639 =for apidoc dump_c_backtrace
6641 Dumps the C backtrace to the given C<fp>.
6643 Returns true if a backtrace could be retrieved, false if not.
6649 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6653 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6655 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6658 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6664 #endif /* #ifdef USE_C_BACKTRACE */
6666 #ifdef PERL_TSA_ACTIVE
6668 /* pthread_mutex_t and perl_mutex are typedef equivalent
6669 * so casting the pointers is fine. */
6671 int perl_tsa_mutex_lock(perl_mutex* mutex)
6673 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6676 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6678 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6681 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6683 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6691 /* log a sub call or return */
6694 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6702 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6705 HEK *hek = CvNAME_HEK(cv);
6706 func = HEK_KEY(hek);
6712 start = (const COP *)CvSTART(cv);
6713 file = CopFILE(start);
6714 line = CopLINE(start);
6715 stash = CopSTASHPV(start);
6718 PERL_SUB_ENTRY(func, file, line, stash);
6721 PERL_SUB_RETURN(func, file, line, stash);
6726 /* log a require file loading/loaded */
6729 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6731 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6734 PERL_LOADING_FILE(name);
6737 PERL_LOADED_FILE(name);
6742 /* log an op execution */
6745 Perl_dtrace_probe_op(pTHX_ const OP *op)
6747 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6749 PERL_OP_ENTRY(OP_NAME(op));
6753 /* log a compile/run phase change */
6756 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6758 const char *ph_old = PL_phase_names[PL_phase];
6759 const char *ph_new = PL_phase_names[phase];
6761 PERL_PHASE_CHANGE(ph_new, ph_old);
6767 * ex: set ts=8 sts=4 sw=4 et: