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 */
50 # include <sys/select.h>
54 #ifdef USE_C_BACKTRACE
58 # undef USE_BFD /* BFD is useless in OS X. */
68 # include <execinfo.h>
72 #ifdef PERL_DEBUG_READONLY_COW
73 # include <sys/mman.h>
78 /* NOTE: Do not call the next three routines directly. Use the macros
79 * in handy.h, so that we can easily redefine everything to do tracking of
80 * allocated hunks back to the original New to track down any memory leaks.
81 * XXX This advice seems to be widely ignored :-( --AD August 1996.
84 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
85 # define ALWAYS_NEED_THX
88 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
90 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
93 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
94 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
95 header, header->size, errno);
99 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
102 && mprotect(header, header->size, PROT_READ))
103 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
104 header, header->size, errno);
106 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
107 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
109 # define maybe_protect_rw(foo) NOOP
110 # define maybe_protect_ro(foo) NOOP
113 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
114 /* Use memory_debug_header */
116 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
117 || defined(PERL_DEBUG_READONLY_COW)
118 # define MDH_HAS_SIZE
122 /* paranoid version of system's malloc() */
125 Perl_safesysmalloc(MEM_SIZE size)
127 #ifdef ALWAYS_NEED_THX
131 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
133 if ((SSize_t)size < 0)
134 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
136 if (!size) size = 1; /* malloc(0) is NASTY on our system */
137 #ifdef PERL_DEBUG_READONLY_COW
138 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
139 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
140 perror("mmap failed");
144 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
146 PERL_ALLOC_CHECK(ptr);
149 struct perl_memory_debug_header *const header
150 = (struct perl_memory_debug_header *)ptr;
154 PoisonNew(((char *)ptr), size, char);
157 #ifdef PERL_TRACK_MEMPOOL
158 header->interpreter = aTHX;
159 /* Link us into the list. */
160 header->prev = &PL_memory_debug_header;
161 header->next = PL_memory_debug_header.next;
162 PL_memory_debug_header.next = header;
163 maybe_protect_rw(header->next);
164 header->next->prev = header;
165 maybe_protect_ro(header->next);
166 # ifdef PERL_DEBUG_READONLY_COW
167 header->readonly = 0;
173 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
174 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
178 #ifndef ALWAYS_NEED_THX
190 /* paranoid version of system's realloc() */
193 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
195 #ifdef ALWAYS_NEED_THX
199 #ifdef PERL_DEBUG_READONLY_COW
200 const MEM_SIZE oldsize = where
201 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
204 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
205 Malloc_t PerlMem_realloc();
206 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
214 return safesysmalloc(size);
216 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
217 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
219 struct perl_memory_debug_header *const header
220 = (struct perl_memory_debug_header *)where;
222 # ifdef PERL_TRACK_MEMPOOL
223 if (header->interpreter != aTHX) {
224 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
225 header->interpreter, aTHX);
227 assert(header->next->prev == header);
228 assert(header->prev->next == header);
230 if (header->size > size) {
231 const MEM_SIZE freed_up = header->size - size;
232 char *start_of_freed = ((char *)where) + size;
233 PoisonFree(start_of_freed, freed_up, char);
243 if ((SSize_t)size < 0)
244 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
246 #ifdef PERL_DEBUG_READONLY_COW
247 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
248 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
249 perror("mmap failed");
252 Copy(where,ptr,oldsize < size ? oldsize : size,char);
253 if (munmap(where, oldsize)) {
254 perror("munmap failed");
258 ptr = (Malloc_t)PerlMem_realloc(where,size);
260 PERL_ALLOC_CHECK(ptr);
262 /* MUST do this fixup first, before doing ANYTHING else, as anything else
263 might allocate memory/free/move memory, and until we do the fixup, it
264 may well be chasing (and writing to) free memory. */
266 #ifdef PERL_TRACK_MEMPOOL
267 struct perl_memory_debug_header *const header
268 = (struct perl_memory_debug_header *)ptr;
271 if (header->size < size) {
272 const MEM_SIZE fresh = size - header->size;
273 char *start_of_fresh = ((char *)ptr) + size;
274 PoisonNew(start_of_fresh, fresh, char);
278 maybe_protect_rw(header->next);
279 header->next->prev = header;
280 maybe_protect_ro(header->next);
281 maybe_protect_rw(header->prev);
282 header->prev->next = header;
283 maybe_protect_ro(header->prev);
285 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
288 /* In particular, must do that fixup above before logging anything via
289 *printf(), as it can reallocate memory, which can cause SEGVs. */
291 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
292 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
299 #ifndef ALWAYS_NEED_THX
311 /* safe version of system's free() */
314 Perl_safesysfree(Malloc_t where)
316 #ifdef ALWAYS_NEED_THX
319 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
322 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
324 struct perl_memory_debug_header *const header
325 = (struct perl_memory_debug_header *)where;
328 const MEM_SIZE size = header->size;
330 # ifdef PERL_TRACK_MEMPOOL
331 if (header->interpreter != aTHX) {
332 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
333 header->interpreter, aTHX);
336 Perl_croak_nocontext("panic: duplicate free");
339 Perl_croak_nocontext("panic: bad free, header->next==NULL");
340 if (header->next->prev != header || header->prev->next != header) {
341 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
342 "header=%p, ->prev->next=%p",
343 header->next->prev, header,
346 /* Unlink us from the chain. */
347 maybe_protect_rw(header->next);
348 header->next->prev = header->prev;
349 maybe_protect_ro(header->next);
350 maybe_protect_rw(header->prev);
351 header->prev->next = header->next;
352 maybe_protect_ro(header->prev);
353 maybe_protect_rw(header);
355 PoisonNew(where, size, char);
357 /* Trigger the duplicate free warning. */
360 # ifdef PERL_DEBUG_READONLY_COW
361 if (munmap(where, size)) {
362 perror("munmap failed");
368 #ifndef PERL_DEBUG_READONLY_COW
374 /* safe version of system's calloc() */
377 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
379 #ifdef ALWAYS_NEED_THX
383 #if defined(USE_MDH) || defined(DEBUGGING)
384 MEM_SIZE total_size = 0;
387 /* Even though calloc() for zero bytes is strange, be robust. */
388 if (size && (count <= MEM_SIZE_MAX / size)) {
389 #if defined(USE_MDH) || defined(DEBUGGING)
390 total_size = size * count;
396 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
397 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
402 if ((SSize_t)size < 0 || (SSize_t)count < 0)
403 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
404 (UV)size, (UV)count);
406 #ifdef PERL_DEBUG_READONLY_COW
407 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
408 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
409 perror("mmap failed");
412 #elif defined(PERL_TRACK_MEMPOOL)
413 /* Have to use malloc() because we've added some space for our tracking
415 /* malloc(0) is non-portable. */
416 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
418 /* Use calloc() because it might save a memset() if the memory is fresh
419 and clean from the OS. */
421 ptr = (Malloc_t)PerlMem_calloc(count, size);
422 else /* calloc(0) is non-portable. */
423 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
425 PERL_ALLOC_CHECK(ptr);
426 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));
430 struct perl_memory_debug_header *const header
431 = (struct perl_memory_debug_header *)ptr;
433 # ifndef PERL_DEBUG_READONLY_COW
434 memset((void*)ptr, 0, total_size);
436 # ifdef PERL_TRACK_MEMPOOL
437 header->interpreter = aTHX;
438 /* Link us into the list. */
439 header->prev = &PL_memory_debug_header;
440 header->next = PL_memory_debug_header.next;
441 PL_memory_debug_header.next = header;
442 maybe_protect_rw(header->next);
443 header->next->prev = header;
444 maybe_protect_ro(header->next);
445 # ifdef PERL_DEBUG_READONLY_COW
446 header->readonly = 0;
450 header->size = total_size;
452 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
458 #ifndef ALWAYS_NEED_THX
467 /* These must be defined when not using Perl's malloc for binary
472 Malloc_t Perl_malloc (MEM_SIZE nbytes)
474 #ifdef PERL_IMPLICIT_SYS
477 return (Malloc_t)PerlMem_malloc(nbytes);
480 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
482 #ifdef PERL_IMPLICIT_SYS
485 return (Malloc_t)PerlMem_calloc(elements, size);
488 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
490 #ifdef PERL_IMPLICIT_SYS
493 return (Malloc_t)PerlMem_realloc(where, nbytes);
496 Free_t Perl_mfree (Malloc_t where)
498 #ifdef PERL_IMPLICIT_SYS
506 /* copy a string up to some (non-backslashed) delimiter, if any */
509 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
513 PERL_ARGS_ASSERT_DELIMCPY;
515 for (tolen = 0; from < fromend; from++, tolen++) {
517 if (from[1] != delim) {
524 else if (*from == delim)
535 /* return ptr to little string in big string, NULL if not found */
536 /* This routine was donated by Corey Satten. */
539 Perl_instr(const char *big, const char *little)
542 PERL_ARGS_ASSERT_INSTR;
544 /* libc prior to 4.6.27 (late 1994) did not work properly on a NULL
548 return strstr((char*)big, (char*)little);
551 /* same as instr but allow embedded nulls. The end pointers point to 1 beyond
552 * the final character desired to be checked */
555 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
557 PERL_ARGS_ASSERT_NINSTR;
561 const char first = *little;
563 bigend -= lend - little++;
565 while (big <= bigend) {
566 if (*big++ == first) {
567 for (x=big,s=little; s < lend; x++,s++) {
571 return (char*)(big-1);
578 /* reverse of the above--find last substring */
581 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
584 const I32 first = *little;
585 const char * const littleend = lend;
587 PERL_ARGS_ASSERT_RNINSTR;
589 if (little >= littleend)
590 return (char*)bigend;
592 big = bigend - (littleend - little++);
593 while (big >= bigbeg) {
597 for (x=big+2,s=little; s < littleend; /**/ ) {
606 return (char*)(big+1);
611 /* As a space optimization, we do not compile tables for strings of length
612 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
613 special-cased in fbm_instr().
615 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
618 =head1 Miscellaneous Functions
620 =for apidoc fbm_compile
622 Analyses the string in order to make fast searches on it using fbm_instr()
623 -- the Boyer-Moore algorithm.
629 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
636 PERL_DEB( STRLEN rarest = 0 );
638 PERL_ARGS_ASSERT_FBM_COMPILE;
640 if (isGV_with_GP(sv) || SvROK(sv))
646 if (flags & FBMcf_TAIL) {
647 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
648 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
649 if (mg && mg->mg_len >= 0)
652 if (!SvPOK(sv) || SvNIOKp(sv))
653 s = (U8*)SvPV_force_mutable(sv, len);
654 else s = (U8 *)SvPV_mutable(sv, len);
655 if (len == 0) /* TAIL might be on a zero-length string. */
657 SvUPGRADE(sv, SVt_PVMG);
662 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
663 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
664 to call SvVALID_off() if the scalar was assigned to.
666 The comment itself (and "deeper magic" below) date back to
667 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
669 where the magic (presumably) was that the scalar had a BM table hidden
672 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
673 the table instead of the previous (somewhat hacky) approach of co-opting
674 the string buffer and storing it after the string. */
676 assert(!mg_find(sv, PERL_MAGIC_bm));
677 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
681 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
683 const U8 mlen = (len>255) ? 255 : (U8)len;
684 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
687 Newx(table, 256, U8);
688 memset((void*)table, mlen, 256);
689 mg->mg_ptr = (char *)table;
692 s += len - 1; /* last char */
695 if (table[*s] == mlen)
701 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
702 for (i = 0; i < len; i++) {
703 if (PL_freq[s[i]] < frequency) {
704 PERL_DEB( rarest = i );
705 frequency = PL_freq[s[i]];
708 BmUSEFUL(sv) = 100; /* Initial value */
709 if (flags & FBMcf_TAIL)
711 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
712 s[rarest], (UV)rarest));
715 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
716 /* If SvTAIL is actually due to \Z or \z, this gives false positives
720 =for apidoc fbm_instr
722 Returns the location of the SV in the string delimited by C<big> and
723 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
724 does not have to be fbm_compiled, but the search will not be as fast
731 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
735 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
736 STRLEN littlelen = l;
737 const I32 multiline = flags & FBMrf_MULTILINE;
739 PERL_ARGS_ASSERT_FBM_INSTR;
741 if ((STRLEN)(bigend - big) < littlelen) {
742 if ( SvTAIL(littlestr)
743 && ((STRLEN)(bigend - big) == littlelen - 1)
745 || (*big == *little &&
746 memEQ((char *)big, (char *)little, littlelen - 1))))
751 switch (littlelen) { /* Special cases for 0, 1 and 2 */
753 return (char*)big; /* Cannot be SvTAIL! */
755 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
756 /* Know that bigend != big. */
757 if (bigend[-1] == '\n')
758 return (char *)(bigend - 1);
759 return (char *) bigend;
767 if (SvTAIL(littlestr))
768 return (char *) bigend;
771 if (SvTAIL(littlestr) && !multiline) {
772 if (bigend[-1] == '\n' && bigend[-2] == *little)
773 return (char*)bigend - 2;
774 if (bigend[-1] == *little)
775 return (char*)bigend - 1;
779 /* This should be better than FBM if c1 == c2, and almost
780 as good otherwise: maybe better since we do less indirection.
781 And we save a lot of memory by caching no table. */
782 const unsigned char c1 = little[0];
783 const unsigned char c2 = little[1];
788 while (s <= bigend) {
798 goto check_1char_anchor;
809 goto check_1char_anchor;
812 while (s <= bigend) {
817 goto check_1char_anchor;
826 check_1char_anchor: /* One char and anchor! */
827 if (SvTAIL(littlestr) && (*bigend == *little))
828 return (char *)bigend; /* bigend is already decremented. */
831 break; /* Only lengths 0 1 and 2 have special-case code. */
834 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
835 s = bigend - littlelen;
836 if (s >= big && bigend[-1] == '\n' && *s == *little
837 /* Automatically of length > 2 */
838 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
840 return (char*)s; /* how sweet it is */
843 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
845 return (char*)s + 1; /* how sweet it is */
849 if (!SvVALID(littlestr)) {
850 char * const b = ninstr((char*)big,(char*)bigend,
851 (char*)little, (char*)little + littlelen);
853 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
854 /* Chop \n from littlestr: */
855 s = bigend - littlelen + 1;
857 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
867 if (littlelen > (STRLEN)(bigend - big))
871 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
872 const unsigned char *oldlittle;
876 --littlelen; /* Last char found by table lookup */
879 little += littlelen; /* last char */
882 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
886 if ((tmp = table[*s])) {
887 if ((s += tmp) < bigend)
891 else { /* less expensive than calling strncmp() */
892 unsigned char * const olds = s;
897 if (*--s == *--little)
899 s = olds + 1; /* here we pay the price for failure */
901 if (s < bigend) /* fake up continue to outer loop */
911 && memEQ((char *)(bigend - littlelen),
912 (char *)(oldlittle - littlelen), littlelen) )
913 return (char*)bigend - littlelen;
919 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
921 PERL_ARGS_ASSERT_SCREAMINSTR;
922 PERL_UNUSED_ARG(bigstr);
923 PERL_UNUSED_ARG(littlestr);
924 PERL_UNUSED_ARG(start_shift);
925 PERL_UNUSED_ARG(end_shift);
926 PERL_UNUSED_ARG(old_posp);
927 PERL_UNUSED_ARG(last);
929 /* This function must only ever be called on a scalar with study magic,
930 but those do not happen any more. */
931 Perl_croak(aTHX_ "panic: screaminstr");
932 NORETURN_FUNCTION_END;
938 Returns true if the leading len bytes of the strings s1 and s2 are the same
939 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
940 match themselves and their opposite case counterparts. Non-cased and non-ASCII
941 range bytes match only themselves.
948 Perl_foldEQ(const char *s1, const char *s2, I32 len)
950 const U8 *a = (const U8 *)s1;
951 const U8 *b = (const U8 *)s2;
953 PERL_ARGS_ASSERT_FOLDEQ;
958 if (*a != *b && *a != PL_fold[*b])
965 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
967 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
968 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
969 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
970 * does it check that the strings each have at least 'len' characters */
972 const U8 *a = (const U8 *)s1;
973 const U8 *b = (const U8 *)s2;
975 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
980 if (*a != *b && *a != PL_fold_latin1[*b]) {
989 =for apidoc foldEQ_locale
991 Returns true if the leading len bytes of the strings s1 and s2 are the same
992 case-insensitively in the current locale; false otherwise.
998 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
1001 const U8 *a = (const U8 *)s1;
1002 const U8 *b = (const U8 *)s2;
1004 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1009 if (*a != *b && *a != PL_fold_locale[*b])
1016 /* copy a string to a safe spot */
1019 =head1 Memory Management
1023 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1024 string which is a duplicate of C<pv>. The size of the string is
1025 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1026 characters and must have a trailing C<NUL>. The memory allocated for the new
1027 string can be freed with the C<Safefree()> function.
1029 On some platforms, Windows for example, all allocated memory owned by a thread
1030 is deallocated when that thread ends. So if you need that not to happen, you
1031 need to use the shared memory functions, such as C<L</savesharedpv>>.
1037 Perl_savepv(pTHX_ const char *pv)
1039 PERL_UNUSED_CONTEXT;
1044 const STRLEN pvlen = strlen(pv)+1;
1045 Newx(newaddr, pvlen, char);
1046 return (char*)memcpy(newaddr, pv, pvlen);
1050 /* same thing but with a known length */
1055 Perl's version of what C<strndup()> would be if it existed. Returns a
1056 pointer to a newly allocated string which is a duplicate of the first
1057 C<len> bytes from C<pv>, plus a trailing
1058 C<NUL> byte. The memory allocated for
1059 the new string can be freed with the C<Safefree()> function.
1061 On some platforms, Windows for example, all allocated memory owned by a thread
1062 is deallocated when that thread ends. So if you need that not to happen, you
1063 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1069 Perl_savepvn(pTHX_ const char *pv, I32 len)
1072 PERL_UNUSED_CONTEXT;
1076 Newx(newaddr,len+1,char);
1077 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1079 /* might not be null terminated */
1080 newaddr[len] = '\0';
1081 return (char *) CopyD(pv,newaddr,len,char);
1084 return (char *) ZeroD(newaddr,len+1,char);
1089 =for apidoc savesharedpv
1091 A version of C<savepv()> which allocates the duplicate string in memory
1092 which is shared between threads.
1097 Perl_savesharedpv(pTHX_ const char *pv)
1102 PERL_UNUSED_CONTEXT;
1107 pvlen = strlen(pv)+1;
1108 newaddr = (char*)PerlMemShared_malloc(pvlen);
1112 return (char*)memcpy(newaddr, pv, pvlen);
1116 =for apidoc savesharedpvn
1118 A version of C<savepvn()> which allocates the duplicate string in memory
1119 which is shared between threads. (With the specific difference that a NULL
1120 pointer is not acceptable)
1125 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1127 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1129 PERL_UNUSED_CONTEXT;
1130 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1135 newaddr[len] = '\0';
1136 return (char*)memcpy(newaddr, pv, len);
1140 =for apidoc savesvpv
1142 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1143 the passed in SV using C<SvPV()>
1145 On some platforms, Windows for example, all allocated memory owned by a thread
1146 is deallocated when that thread ends. So if you need that not to happen, you
1147 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1153 Perl_savesvpv(pTHX_ SV *sv)
1156 const char * const pv = SvPV_const(sv, len);
1159 PERL_ARGS_ASSERT_SAVESVPV;
1162 Newx(newaddr,len,char);
1163 return (char *) CopyD(pv,newaddr,len,char);
1167 =for apidoc savesharedsvpv
1169 A version of C<savesharedpv()> which allocates the duplicate string in
1170 memory which is shared between threads.
1176 Perl_savesharedsvpv(pTHX_ SV *sv)
1179 const char * const pv = SvPV_const(sv, len);
1181 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1183 return savesharedpvn(pv, len);
1186 /* the SV for Perl_form() and mess() is not kept in an arena */
1194 if (PL_phase != PERL_PHASE_DESTRUCT)
1195 return newSVpvs_flags("", SVs_TEMP);
1200 /* Create as PVMG now, to avoid any upgrading later */
1202 Newxz(any, 1, XPVMG);
1203 SvFLAGS(sv) = SVt_PVMG;
1204 SvANY(sv) = (void*)any;
1206 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1211 #if defined(PERL_IMPLICIT_CONTEXT)
1213 Perl_form_nocontext(const char* pat, ...)
1218 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1219 va_start(args, pat);
1220 retval = vform(pat, &args);
1224 #endif /* PERL_IMPLICIT_CONTEXT */
1227 =head1 Miscellaneous Functions
1230 Takes a sprintf-style format pattern and conventional
1231 (non-SV) arguments and returns the formatted string.
1233 (char *) Perl_form(pTHX_ const char* pat, ...)
1235 can be used any place a string (char *) is required:
1237 char * s = Perl_form("%d.%d",major,minor);
1239 Uses a single private buffer so if you want to format several strings you
1240 must explicitly copy the earlier strings away (and free the copies when you
1247 Perl_form(pTHX_ const char* pat, ...)
1251 PERL_ARGS_ASSERT_FORM;
1252 va_start(args, pat);
1253 retval = vform(pat, &args);
1259 Perl_vform(pTHX_ const char *pat, va_list *args)
1261 SV * const sv = mess_alloc();
1262 PERL_ARGS_ASSERT_VFORM;
1263 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1268 =for apidoc Am|SV *|mess|const char *pat|...
1270 Take a sprintf-style format pattern and argument list. These are used to
1271 generate a string message. If the message does not end with a newline,
1272 then it will be extended with some indication of the current location
1273 in the code, as described for L</mess_sv>.
1275 Normally, the resulting message is returned in a new mortal SV.
1276 During global destruction a single SV may be shared between uses of
1282 #if defined(PERL_IMPLICIT_CONTEXT)
1284 Perl_mess_nocontext(const char *pat, ...)
1289 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1290 va_start(args, pat);
1291 retval = vmess(pat, &args);
1295 #endif /* PERL_IMPLICIT_CONTEXT */
1298 Perl_mess(pTHX_ const char *pat, ...)
1302 PERL_ARGS_ASSERT_MESS;
1303 va_start(args, pat);
1304 retval = vmess(pat, &args);
1310 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1313 /* Look for curop starting from o. cop is the last COP we've seen. */
1314 /* opnext means that curop is actually the ->op_next of the op we are
1317 PERL_ARGS_ASSERT_CLOSEST_COP;
1319 if (!o || !curop || (
1320 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1324 if (o->op_flags & OPf_KIDS) {
1326 for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid)) {
1329 /* If the OP_NEXTSTATE has been optimised away we can still use it
1330 * the get the file and line number. */
1332 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1333 cop = (const COP *)kid;
1335 /* Keep searching, and return when we've found something. */
1337 new_cop = closest_cop(cop, kid, curop, opnext);
1343 /* Nothing found. */
1349 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1351 Expands a message, intended for the user, to include an indication of
1352 the current location in the code, if the message does not already appear
1355 C<basemsg> is the initial message or object. If it is a reference, it
1356 will be used as-is and will be the result of this function. Otherwise it
1357 is used as a string, and if it already ends with a newline, it is taken
1358 to be complete, and the result of this function will be the same string.
1359 If the message does not end with a newline, then a segment such as C<at
1360 foo.pl line 37> will be appended, and possibly other clauses indicating
1361 the current state of execution. The resulting message will end with a
1364 Normally, the resulting message is returned in a new mortal SV.
1365 During global destruction a single SV may be shared between uses of this
1366 function. If C<consume> is true, then the function is permitted (but not
1367 required) to modify and return C<basemsg> instead of allocating a new SV.
1373 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1377 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1381 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1382 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR")) &&
1383 (wi = grok_atou(ws, NULL)) > 0) {
1384 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, wi, 1);
1389 PERL_ARGS_ASSERT_MESS_SV;
1391 if (SvROK(basemsg)) {
1397 sv_setsv(sv, basemsg);
1402 if (SvPOK(basemsg) && consume) {
1407 sv_copypv(sv, basemsg);
1410 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1412 * Try and find the file and line for PL_op. This will usually be
1413 * PL_curcop, but it might be a cop that has been optimised away. We
1414 * can try to find such a cop by searching through the optree starting
1415 * from the sibling of PL_curcop.
1419 closest_cop(PL_curcop, OP_SIBLING(PL_curcop), PL_op, FALSE);
1424 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1425 OutCopFILE(cop), (IV)CopLINE(cop));
1426 /* Seems that GvIO() can be untrustworthy during global destruction. */
1427 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1428 && IoLINES(GvIOp(PL_last_in_gv)))
1431 const bool line_mode = (RsSIMPLE(PL_rs) &&
1432 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1433 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1434 SVfARG(PL_last_in_gv == PL_argvgv
1436 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1437 line_mode ? "line" : "chunk",
1438 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1440 if (PL_phase == PERL_PHASE_DESTRUCT)
1441 sv_catpvs(sv, " during global destruction");
1442 sv_catpvs(sv, ".\n");
1448 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1450 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1451 argument list. These are used to generate a string message. If the
1452 message does not end with a newline, then it will be extended with
1453 some indication of the current location in the code, as described for
1456 Normally, the resulting message is returned in a new mortal SV.
1457 During global destruction a single SV may be shared between uses of
1464 Perl_vmess(pTHX_ const char *pat, va_list *args)
1466 SV * const sv = mess_alloc();
1468 PERL_ARGS_ASSERT_VMESS;
1470 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1471 return mess_sv(sv, 1);
1475 Perl_write_to_stderr(pTHX_ SV* msv)
1480 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1482 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1483 && (io = GvIO(PL_stderrgv))
1484 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1485 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1486 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1488 PerlIO * const serr = Perl_error_log;
1490 do_print(msv, serr);
1491 (void)PerlIO_flush(serr);
1496 =head1 Warning and Dieing
1499 /* Common code used in dieing and warning */
1502 S_with_queued_errors(pTHX_ SV *ex)
1504 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1505 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1506 sv_catsv(PL_errors, ex);
1507 ex = sv_mortalcopy(PL_errors);
1508 SvCUR_set(PL_errors, 0);
1514 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1519 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1520 /* sv_2cv might call Perl_croak() or Perl_warner() */
1521 SV * const oldhook = *hook;
1529 cv = sv_2cv(oldhook, &stash, &gv, 0);
1531 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1541 exarg = newSVsv(ex);
1542 SvREADONLY_on(exarg);
1545 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1549 call_sv(MUTABLE_SV(cv), G_DISCARD);
1558 =for apidoc Am|OP *|die_sv|SV *baseex
1560 Behaves the same as L</croak_sv>, except for the return type.
1561 It should be used only where the C<OP *> return type is required.
1562 The function never actually returns.
1568 Perl_die_sv(pTHX_ SV *baseex)
1570 PERL_ARGS_ASSERT_DIE_SV;
1572 assert(0); /* NOTREACHED */
1573 NORETURN_FUNCTION_END;
1577 =for apidoc Am|OP *|die|const char *pat|...
1579 Behaves the same as L</croak>, except for the return type.
1580 It should be used only where the C<OP *> return type is required.
1581 The function never actually returns.
1586 #if defined(PERL_IMPLICIT_CONTEXT)
1588 Perl_die_nocontext(const char* pat, ...)
1592 va_start(args, pat);
1594 assert(0); /* NOTREACHED */
1596 NORETURN_FUNCTION_END;
1598 #endif /* PERL_IMPLICIT_CONTEXT */
1601 Perl_die(pTHX_ const char* pat, ...)
1604 va_start(args, pat);
1606 assert(0); /* NOTREACHED */
1608 NORETURN_FUNCTION_END;
1612 =for apidoc Am|void|croak_sv|SV *baseex
1614 This is an XS interface to Perl's C<die> function.
1616 C<baseex> is the error message or object. If it is a reference, it
1617 will be used as-is. Otherwise it is used as a string, and if it does
1618 not end with a newline then it will be extended with some indication of
1619 the current location in the code, as described for L</mess_sv>.
1621 The error message or object will be used as an exception, by default
1622 returning control to the nearest enclosing C<eval>, but subject to
1623 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1624 function never returns normally.
1626 To die with a simple string message, the L</croak> function may be
1633 Perl_croak_sv(pTHX_ SV *baseex)
1635 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1636 PERL_ARGS_ASSERT_CROAK_SV;
1637 invoke_exception_hook(ex, FALSE);
1642 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1644 This is an XS interface to Perl's C<die> function.
1646 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1647 argument list. These are used to generate a string message. If the
1648 message does not end with a newline, then it will be extended with
1649 some indication of the current location in the code, as described for
1652 The error message will be used as an exception, by default
1653 returning control to the nearest enclosing C<eval>, but subject to
1654 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1655 function never returns normally.
1657 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1658 (C<$@>) will be used as an error message or object instead of building an
1659 error message from arguments. If you want to throw a non-string object,
1660 or build an error message in an SV yourself, it is preferable to use
1661 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1667 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1669 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1670 invoke_exception_hook(ex, FALSE);
1675 =for apidoc Am|void|croak|const char *pat|...
1677 This is an XS interface to Perl's C<die> function.
1679 Take a sprintf-style format pattern and argument list. These are used to
1680 generate a string message. If the message does not end with a newline,
1681 then it will be extended with some indication of the current location
1682 in the code, as described for L</mess_sv>.
1684 The error message will be used as an exception, by default
1685 returning control to the nearest enclosing C<eval>, but subject to
1686 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1687 function never returns normally.
1689 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1690 (C<$@>) will be used as an error message or object instead of building an
1691 error message from arguments. If you want to throw a non-string object,
1692 or build an error message in an SV yourself, it is preferable to use
1693 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1698 #if defined(PERL_IMPLICIT_CONTEXT)
1700 Perl_croak_nocontext(const char *pat, ...)
1704 va_start(args, pat);
1706 assert(0); /* NOTREACHED */
1709 #endif /* PERL_IMPLICIT_CONTEXT */
1712 Perl_croak(pTHX_ const char *pat, ...)
1715 va_start(args, pat);
1717 assert(0); /* NOTREACHED */
1722 =for apidoc Am|void|croak_no_modify
1724 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1725 terser object code than using C<Perl_croak>. Less code used on exception code
1726 paths reduces CPU cache pressure.
1732 Perl_croak_no_modify(void)
1734 Perl_croak_nocontext( "%s", PL_no_modify);
1737 /* does not return, used in util.c perlio.c and win32.c
1738 This is typically called when malloc returns NULL.
1741 Perl_croak_no_mem(void)
1745 int fd = PerlIO_fileno(Perl_error_log);
1747 SETERRNO(EBADF,RMS_IFI);
1749 /* Can't use PerlIO to write as it allocates memory */
1750 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1755 /* does not return, used only in POPSTACK */
1757 Perl_croak_popstack(void)
1760 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1765 =for apidoc Am|void|warn_sv|SV *baseex
1767 This is an XS interface to Perl's C<warn> function.
1769 C<baseex> is the error message or object. If it is a reference, it
1770 will be used as-is. Otherwise it is used as a string, and if it does
1771 not end with a newline then it will be extended with some indication of
1772 the current location in the code, as described for L</mess_sv>.
1774 The error message or object will by default be written to standard error,
1775 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1777 To warn with a simple string message, the L</warn> function may be
1784 Perl_warn_sv(pTHX_ SV *baseex)
1786 SV *ex = mess_sv(baseex, 0);
1787 PERL_ARGS_ASSERT_WARN_SV;
1788 if (!invoke_exception_hook(ex, TRUE))
1789 write_to_stderr(ex);
1793 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1795 This is an XS interface to Perl's C<warn> function.
1797 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1798 argument list. These are used to generate a string message. If the
1799 message does not end with a newline, then it will be extended with
1800 some indication of the current location in the code, as described for
1803 The error message or object will by default be written to standard error,
1804 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1806 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1812 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1814 SV *ex = vmess(pat, args);
1815 PERL_ARGS_ASSERT_VWARN;
1816 if (!invoke_exception_hook(ex, TRUE))
1817 write_to_stderr(ex);
1821 =for apidoc Am|void|warn|const char *pat|...
1823 This is an XS interface to Perl's C<warn> function.
1825 Take a sprintf-style format pattern and argument list. These are used to
1826 generate a string message. If the message does not end with a newline,
1827 then it will be extended with some indication of the current location
1828 in the code, as described for L</mess_sv>.
1830 The error message or object will by default be written to standard error,
1831 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1833 Unlike with L</croak>, C<pat> is not permitted to be null.
1838 #if defined(PERL_IMPLICIT_CONTEXT)
1840 Perl_warn_nocontext(const char *pat, ...)
1844 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1845 va_start(args, pat);
1849 #endif /* PERL_IMPLICIT_CONTEXT */
1852 Perl_warn(pTHX_ const char *pat, ...)
1855 PERL_ARGS_ASSERT_WARN;
1856 va_start(args, pat);
1861 #if defined(PERL_IMPLICIT_CONTEXT)
1863 Perl_warner_nocontext(U32 err, const char *pat, ...)
1867 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1868 va_start(args, pat);
1869 vwarner(err, pat, &args);
1872 #endif /* PERL_IMPLICIT_CONTEXT */
1875 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1877 PERL_ARGS_ASSERT_CK_WARNER_D;
1879 if (Perl_ckwarn_d(aTHX_ err)) {
1881 va_start(args, pat);
1882 vwarner(err, pat, &args);
1888 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1890 PERL_ARGS_ASSERT_CK_WARNER;
1892 if (Perl_ckwarn(aTHX_ err)) {
1894 va_start(args, pat);
1895 vwarner(err, pat, &args);
1901 Perl_warner(pTHX_ U32 err, const char* pat,...)
1904 PERL_ARGS_ASSERT_WARNER;
1905 va_start(args, pat);
1906 vwarner(err, pat, &args);
1911 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1914 PERL_ARGS_ASSERT_VWARNER;
1915 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1916 SV * const msv = vmess(pat, args);
1918 invoke_exception_hook(msv, FALSE);
1922 Perl_vwarn(aTHX_ pat, args);
1926 /* implements the ckWARN? macros */
1929 Perl_ckwarn(pTHX_ U32 w)
1931 /* If lexical warnings have not been set, use $^W. */
1933 return PL_dowarn & G_WARN_ON;
1935 return ckwarn_common(w);
1938 /* implements the ckWARN?_d macro */
1941 Perl_ckwarn_d(pTHX_ U32 w)
1943 /* If lexical warnings have not been set then default classes warn. */
1947 return ckwarn_common(w);
1951 S_ckwarn_common(pTHX_ U32 w)
1953 if (PL_curcop->cop_warnings == pWARN_ALL)
1956 if (PL_curcop->cop_warnings == pWARN_NONE)
1959 /* Check the assumption that at least the first slot is non-zero. */
1960 assert(unpackWARN1(w));
1962 /* Check the assumption that it is valid to stop as soon as a zero slot is
1964 if (!unpackWARN2(w)) {
1965 assert(!unpackWARN3(w));
1966 assert(!unpackWARN4(w));
1967 } else if (!unpackWARN3(w)) {
1968 assert(!unpackWARN4(w));
1971 /* Right, dealt with all the special cases, which are implemented as non-
1972 pointers, so there is a pointer to a real warnings mask. */
1974 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1976 } while (w >>= WARNshift);
1981 /* Set buffer=NULL to get a new one. */
1983 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1985 const MEM_SIZE len_wanted =
1986 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
1987 PERL_UNUSED_CONTEXT;
1988 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1991 (specialWARN(buffer) ?
1992 PerlMemShared_malloc(len_wanted) :
1993 PerlMemShared_realloc(buffer, len_wanted));
1995 Copy(bits, (buffer + 1), size, char);
1996 if (size < WARNsize)
1997 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2001 /* since we've already done strlen() for both nam and val
2002 * we can use that info to make things faster than
2003 * sprintf(s, "%s=%s", nam, val)
2005 #define my_setenv_format(s, nam, nlen, val, vlen) \
2006 Copy(nam, s, nlen, char); \
2008 Copy(val, s+(nlen+1), vlen, char); \
2009 *(s+(nlen+1+vlen)) = '\0'
2011 #ifdef USE_ENVIRON_ARRAY
2012 /* VMS' my_setenv() is in vms.c */
2013 #if !defined(WIN32) && !defined(NETWARE)
2015 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2019 /* only parent thread can modify process environment */
2020 if (PL_curinterp == aTHX)
2023 #ifndef PERL_USE_SAFE_PUTENV
2024 if (!PL_use_safe_putenv) {
2025 /* most putenv()s leak, so we manipulate environ directly */
2027 const I32 len = strlen(nam);
2030 /* where does it go? */
2031 for (i = 0; environ[i]; i++) {
2032 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2036 if (environ == PL_origenviron) { /* need we copy environment? */
2042 while (environ[max])
2044 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2045 for (j=0; j<max; j++) { /* copy environment */
2046 const int len = strlen(environ[j]);
2047 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2048 Copy(environ[j], tmpenv[j], len+1, char);
2051 environ = tmpenv; /* tell exec where it is now */
2054 safesysfree(environ[i]);
2055 while (environ[i]) {
2056 environ[i] = environ[i+1];
2061 if (!environ[i]) { /* does not exist yet */
2062 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2063 environ[i+1] = NULL; /* make sure it's null terminated */
2066 safesysfree(environ[i]);
2070 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2071 /* all that work just for this */
2072 my_setenv_format(environ[i], nam, nlen, val, vlen);
2075 /* This next branch should only be called #if defined(HAS_SETENV), but
2076 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2077 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2079 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV))
2080 # if defined(HAS_UNSETENV)
2082 (void)unsetenv(nam);
2084 (void)setenv(nam, val, 1);
2086 # else /* ! HAS_UNSETENV */
2087 (void)setenv(nam, val, 1);
2088 # endif /* HAS_UNSETENV */
2090 # if defined(HAS_UNSETENV)
2092 if (environ) /* old glibc can crash with null environ */
2093 (void)unsetenv(nam);
2095 const int nlen = strlen(nam);
2096 const int vlen = strlen(val);
2097 char * const new_env =
2098 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2099 my_setenv_format(new_env, nam, nlen, val, vlen);
2100 (void)putenv(new_env);
2102 # else /* ! HAS_UNSETENV */
2104 const int nlen = strlen(nam);
2110 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2111 /* all that work just for this */
2112 my_setenv_format(new_env, nam, nlen, val, vlen);
2113 (void)putenv(new_env);
2114 # endif /* HAS_UNSETENV */
2115 # endif /* __CYGWIN__ */
2116 #ifndef PERL_USE_SAFE_PUTENV
2122 #else /* WIN32 || NETWARE */
2125 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2129 const int nlen = strlen(nam);
2136 Newx(envstr, nlen+vlen+2, char);
2137 my_setenv_format(envstr, nam, nlen, val, vlen);
2138 (void)PerlEnv_putenv(envstr);
2142 #endif /* WIN32 || NETWARE */
2146 #ifdef UNLINK_ALL_VERSIONS
2148 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2152 PERL_ARGS_ASSERT_UNLNK;
2154 while (PerlLIO_unlink(f) >= 0)
2156 return retries ? 0 : -1;
2160 /* this is a drop-in replacement for bcopy() */
2161 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2163 Perl_my_bcopy(const char *from, char *to, I32 len)
2165 char * const retval = to;
2167 PERL_ARGS_ASSERT_MY_BCOPY;
2171 if (from - to >= 0) {
2179 *(--to) = *(--from);
2185 /* this is a drop-in replacement for memset() */
2188 Perl_my_memset(char *loc, I32 ch, I32 len)
2190 char * const retval = loc;
2192 PERL_ARGS_ASSERT_MY_MEMSET;
2202 /* this is a drop-in replacement for bzero() */
2203 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2205 Perl_my_bzero(char *loc, I32 len)
2207 char * const retval = loc;
2209 PERL_ARGS_ASSERT_MY_BZERO;
2219 /* this is a drop-in replacement for memcmp() */
2220 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2222 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2224 const U8 *a = (const U8 *)s1;
2225 const U8 *b = (const U8 *)s2;
2228 PERL_ARGS_ASSERT_MY_MEMCMP;
2233 if ((tmp = *a++ - *b++))
2238 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2241 /* This vsprintf replacement should generally never get used, since
2242 vsprintf was available in both System V and BSD 2.11. (There may
2243 be some cross-compilation or embedded set-ups where it is needed,
2246 If you encounter a problem in this function, it's probably a symptom
2247 that Configure failed to detect your system's vprintf() function.
2248 See the section on "item vsprintf" in the INSTALL file.
2250 This version may compile on systems with BSD-ish <stdio.h>,
2251 but probably won't on others.
2254 #ifdef USE_CHAR_VSPRINTF
2259 vsprintf(char *dest, const char *pat, void *args)
2263 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2264 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2265 FILE_cnt(&fakebuf) = 32767;
2267 /* These probably won't compile -- If you really need
2268 this, you'll have to figure out some other method. */
2269 fakebuf._ptr = dest;
2270 fakebuf._cnt = 32767;
2275 fakebuf._flag = _IOWRT|_IOSTRG;
2276 _doprnt(pat, args, &fakebuf); /* what a kludge */
2277 #if defined(STDIO_PTR_LVALUE)
2278 *(FILE_ptr(&fakebuf)++) = '\0';
2280 /* PerlIO has probably #defined away fputc, but we want it here. */
2282 # undef fputc /* XXX Should really restore it later */
2284 (void)fputc('\0', &fakebuf);
2286 #ifdef USE_CHAR_VSPRINTF
2289 return 0; /* perl doesn't use return value */
2293 #endif /* HAS_VPRINTF */
2296 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2298 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2306 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2308 PERL_FLUSHALL_FOR_CHILD;
2309 This = (*mode == 'w');
2313 taint_proper("Insecure %s%s", "EXEC");
2315 if (PerlProc_pipe(p) < 0)
2317 /* Try for another pipe pair for error return */
2318 if (PerlProc_pipe(pp) >= 0)
2320 while ((pid = PerlProc_fork()) < 0) {
2321 if (errno != EAGAIN) {
2322 PerlLIO_close(p[This]);
2323 PerlLIO_close(p[that]);
2325 PerlLIO_close(pp[0]);
2326 PerlLIO_close(pp[1]);
2330 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2339 /* Close parent's end of error status pipe (if any) */
2341 PerlLIO_close(pp[0]);
2342 #if defined(HAS_FCNTL) && defined(F_SETFD)
2343 /* Close error pipe automatically if exec works */
2344 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2348 /* Now dup our end of _the_ pipe to right position */
2349 if (p[THIS] != (*mode == 'r')) {
2350 PerlLIO_dup2(p[THIS], *mode == 'r');
2351 PerlLIO_close(p[THIS]);
2352 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2353 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2356 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2357 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2358 /* No automatic close - do it by hand */
2365 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2371 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2377 do_execfree(); /* free any memory malloced by child on fork */
2379 PerlLIO_close(pp[1]);
2380 /* Keep the lower of the two fd numbers */
2381 if (p[that] < p[This]) {
2382 PerlLIO_dup2(p[This], p[that]);
2383 PerlLIO_close(p[This]);
2387 PerlLIO_close(p[that]); /* close child's end of pipe */
2389 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2390 SvUPGRADE(sv,SVt_IV);
2392 PL_forkprocess = pid;
2393 /* If we managed to get status pipe check for exec fail */
2394 if (did_pipes && pid > 0) {
2399 while (n < sizeof(int)) {
2400 n1 = PerlLIO_read(pp[0],
2401 (void*)(((char*)&errkid)+n),
2407 PerlLIO_close(pp[0]);
2409 if (n) { /* Error */
2411 PerlLIO_close(p[This]);
2412 if (n != sizeof(int))
2413 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2415 pid2 = wait4pid(pid, &status, 0);
2416 } while (pid2 == -1 && errno == EINTR);
2417 errno = errkid; /* Propagate errno from kid */
2422 PerlLIO_close(pp[0]);
2423 return PerlIO_fdopen(p[This], mode);
2425 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2426 return my_syspopen4(aTHX_ NULL, mode, n, args);
2428 Perl_croak(aTHX_ "List form of piped open not implemented");
2429 return (PerlIO *) NULL;
2434 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2435 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2437 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2443 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2447 PERL_ARGS_ASSERT_MY_POPEN;
2449 PERL_FLUSHALL_FOR_CHILD;
2452 return my_syspopen(aTHX_ cmd,mode);
2455 This = (*mode == 'w');
2457 if (doexec && TAINTING_get) {
2459 taint_proper("Insecure %s%s", "EXEC");
2461 if (PerlProc_pipe(p) < 0)
2463 if (doexec && PerlProc_pipe(pp) >= 0)
2465 while ((pid = PerlProc_fork()) < 0) {
2466 if (errno != EAGAIN) {
2467 PerlLIO_close(p[This]);
2468 PerlLIO_close(p[that]);
2470 PerlLIO_close(pp[0]);
2471 PerlLIO_close(pp[1]);
2474 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2477 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2487 PerlLIO_close(pp[0]);
2488 #if defined(HAS_FCNTL) && defined(F_SETFD)
2489 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2493 if (p[THIS] != (*mode == 'r')) {
2494 PerlLIO_dup2(p[THIS], *mode == 'r');
2495 PerlLIO_close(p[THIS]);
2496 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2497 PerlLIO_close(p[THAT]);
2500 PerlLIO_close(p[THAT]);
2503 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2510 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2515 /* may or may not use the shell */
2516 do_exec3(cmd, pp[1], did_pipes);
2519 #endif /* defined OS2 */
2521 #ifdef PERLIO_USING_CRLF
2522 /* Since we circumvent IO layers when we manipulate low-level
2523 filedescriptors directly, need to manually switch to the
2524 default, binary, low-level mode; see PerlIOBuf_open(). */
2525 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2528 #ifdef PERL_USES_PL_PIDSTATUS
2529 hv_clear(PL_pidstatus); /* we have no children */
2535 do_execfree(); /* free any memory malloced by child on vfork */
2537 PerlLIO_close(pp[1]);
2538 if (p[that] < p[This]) {
2539 PerlLIO_dup2(p[This], p[that]);
2540 PerlLIO_close(p[This]);
2544 PerlLIO_close(p[that]);
2546 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2547 SvUPGRADE(sv,SVt_IV);
2549 PL_forkprocess = pid;
2550 if (did_pipes && pid > 0) {
2555 while (n < sizeof(int)) {
2556 n1 = PerlLIO_read(pp[0],
2557 (void*)(((char*)&errkid)+n),
2563 PerlLIO_close(pp[0]);
2565 if (n) { /* Error */
2567 PerlLIO_close(p[This]);
2568 if (n != sizeof(int))
2569 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2571 pid2 = wait4pid(pid, &status, 0);
2572 } while (pid2 == -1 && errno == EINTR);
2573 errno = errkid; /* Propagate errno from kid */
2578 PerlLIO_close(pp[0]);
2579 return PerlIO_fdopen(p[This], mode);
2583 FILE *djgpp_popen();
2585 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2587 PERL_FLUSHALL_FOR_CHILD;
2588 /* Call system's popen() to get a FILE *, then import it.
2589 used 0 for 2nd parameter to PerlIO_importFILE;
2592 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2595 #if defined(__LIBCATAMOUNT__)
2597 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2604 #endif /* !DOSISH */
2606 /* this is called in parent before the fork() */
2608 Perl_atfork_lock(void)
2610 #if defined(USE_ITHREADS)
2612 /* locks must be held in locking order (if any) */
2614 MUTEX_LOCK(&PL_perlio_mutex);
2617 MUTEX_LOCK(&PL_malloc_mutex);
2623 /* this is called in both parent and child after the fork() */
2625 Perl_atfork_unlock(void)
2627 #if defined(USE_ITHREADS)
2629 /* locks must be released in same order as in atfork_lock() */
2631 MUTEX_UNLOCK(&PL_perlio_mutex);
2634 MUTEX_UNLOCK(&PL_malloc_mutex);
2643 #if defined(HAS_FORK)
2645 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2650 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2651 * handlers elsewhere in the code */
2656 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2657 Perl_croak_nocontext("fork() not available");
2659 #endif /* HAS_FORK */
2664 dup2(int oldfd, int newfd)
2666 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2669 PerlLIO_close(newfd);
2670 return fcntl(oldfd, F_DUPFD, newfd);
2672 #define DUP2_MAX_FDS 256
2673 int fdtmp[DUP2_MAX_FDS];
2679 PerlLIO_close(newfd);
2680 /* good enough for low fd's... */
2681 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2682 if (fdx >= DUP2_MAX_FDS) {
2690 PerlLIO_close(fdtmp[--fdx]);
2697 #ifdef HAS_SIGACTION
2700 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2702 struct sigaction act, oact;
2706 /* only "parent" interpreter can diddle signals */
2707 if (PL_curinterp != aTHX)
2708 return (Sighandler_t) SIG_ERR;
2711 act.sa_handler = (void(*)(int))handler;
2712 sigemptyset(&act.sa_mask);
2715 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2716 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2718 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2719 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2720 act.sa_flags |= SA_NOCLDWAIT;
2722 if (sigaction(signo, &act, &oact) == -1)
2723 return (Sighandler_t) SIG_ERR;
2725 return (Sighandler_t) oact.sa_handler;
2729 Perl_rsignal_state(pTHX_ int signo)
2731 struct sigaction oact;
2732 PERL_UNUSED_CONTEXT;
2734 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2735 return (Sighandler_t) SIG_ERR;
2737 return (Sighandler_t) oact.sa_handler;
2741 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2746 struct sigaction act;
2748 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2751 /* only "parent" interpreter can diddle signals */
2752 if (PL_curinterp != aTHX)
2756 act.sa_handler = (void(*)(int))handler;
2757 sigemptyset(&act.sa_mask);
2760 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2761 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2763 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2764 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2765 act.sa_flags |= SA_NOCLDWAIT;
2767 return sigaction(signo, &act, save);
2771 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2776 PERL_UNUSED_CONTEXT;
2778 /* only "parent" interpreter can diddle signals */
2779 if (PL_curinterp != aTHX)
2783 return sigaction(signo, save, (struct sigaction *)NULL);
2786 #else /* !HAS_SIGACTION */
2789 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2791 #if defined(USE_ITHREADS) && !defined(WIN32)
2792 /* only "parent" interpreter can diddle signals */
2793 if (PL_curinterp != aTHX)
2794 return (Sighandler_t) SIG_ERR;
2797 return PerlProc_signal(signo, handler);
2808 Perl_rsignal_state(pTHX_ int signo)
2811 Sighandler_t oldsig;
2813 #if defined(USE_ITHREADS) && !defined(WIN32)
2814 /* only "parent" interpreter can diddle signals */
2815 if (PL_curinterp != aTHX)
2816 return (Sighandler_t) SIG_ERR;
2820 oldsig = PerlProc_signal(signo, sig_trap);
2821 PerlProc_signal(signo, oldsig);
2823 PerlProc_kill(PerlProc_getpid(), signo);
2828 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2830 #if defined(USE_ITHREADS) && !defined(WIN32)
2831 /* only "parent" interpreter can diddle signals */
2832 if (PL_curinterp != aTHX)
2835 *save = PerlProc_signal(signo, handler);
2836 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2840 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2842 #if defined(USE_ITHREADS) && !defined(WIN32)
2843 /* only "parent" interpreter can diddle signals */
2844 if (PL_curinterp != aTHX)
2847 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2850 #endif /* !HAS_SIGACTION */
2851 #endif /* !PERL_MICRO */
2853 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2854 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2856 Perl_my_pclose(pTHX_ PerlIO *ptr)
2864 const int fd = PerlIO_fileno(ptr);
2867 svp = av_fetch(PL_fdpid,fd,TRUE);
2868 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2872 #if defined(USE_PERLIO)
2873 /* Find out whether the refcount is low enough for us to wait for the
2874 child proc without blocking. */
2875 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2877 should_wait = pid > 0;
2881 if (pid == -1) { /* Opened by popen. */
2882 return my_syspclose(ptr);
2885 close_failed = (PerlIO_close(ptr) == EOF);
2887 if (should_wait) do {
2888 pid2 = wait4pid(pid, &status, 0);
2889 } while (pid2 == -1 && errno == EINTR);
2896 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2901 #if defined(__LIBCATAMOUNT__)
2903 Perl_my_pclose(pTHX_ PerlIO *ptr)
2908 #endif /* !DOSISH */
2910 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2912 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2915 PERL_ARGS_ASSERT_WAIT4PID;
2916 #ifdef PERL_USES_PL_PIDSTATUS
2918 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2919 waitpid() nor wait4() is available, or on OS/2, which
2920 doesn't appear to support waiting for a progress group
2921 member, so we can only treat a 0 pid as an unknown child.
2928 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2929 pid, rather than a string form. */
2930 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2931 if (svp && *svp != &PL_sv_undef) {
2932 *statusp = SvIVX(*svp);
2933 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2941 hv_iterinit(PL_pidstatus);
2942 if ((entry = hv_iternext(PL_pidstatus))) {
2943 SV * const sv = hv_iterval(PL_pidstatus,entry);
2945 const char * const spid = hv_iterkey(entry,&len);
2947 assert (len == sizeof(Pid_t));
2948 memcpy((char *)&pid, spid, len);
2949 *statusp = SvIVX(sv);
2950 /* The hash iterator is currently on this entry, so simply
2951 calling hv_delete would trigger the lazy delete, which on
2952 aggregate does more work, beacuse next call to hv_iterinit()
2953 would spot the flag, and have to call the delete routine,
2954 while in the meantime any new entries can't re-use that
2956 hv_iterinit(PL_pidstatus);
2957 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2964 # ifdef HAS_WAITPID_RUNTIME
2965 if (!HAS_WAITPID_RUNTIME)
2968 result = PerlProc_waitpid(pid,statusp,flags);
2971 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2972 result = wait4(pid,statusp,flags,NULL);
2975 #ifdef PERL_USES_PL_PIDSTATUS
2976 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2981 Perl_croak(aTHX_ "Can't do waitpid with flags");
2983 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2984 pidgone(result,*statusp);
2990 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2993 if (result < 0 && errno == EINTR) {
2995 errno = EINTR; /* reset in case a signal handler changed $! */
2999 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3001 #ifdef PERL_USES_PL_PIDSTATUS
3003 S_pidgone(pTHX_ Pid_t pid, int status)
3007 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3008 SvUPGRADE(sv,SVt_IV);
3009 SvIV_set(sv, status);
3017 int /* Cannot prototype with I32
3019 my_syspclose(PerlIO *ptr)
3022 Perl_my_pclose(pTHX_ PerlIO *ptr)
3025 /* Needs work for PerlIO ! */
3026 FILE * const f = PerlIO_findFILE(ptr);
3027 const I32 result = pclose(f);
3028 PerlIO_releaseFILE(ptr,f);
3036 Perl_my_pclose(pTHX_ PerlIO *ptr)
3038 /* Needs work for PerlIO ! */
3039 FILE * const f = PerlIO_findFILE(ptr);
3040 I32 result = djgpp_pclose(f);
3041 result = (result << 8) & 0xff00;
3042 PerlIO_releaseFILE(ptr,f);
3047 #define PERL_REPEATCPY_LINEAR 4
3049 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3051 PERL_ARGS_ASSERT_REPEATCPY;
3056 croak_memory_wrap();
3059 memset(to, *from, count);
3062 IV items, linear, half;
3064 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3065 for (items = 0; items < linear; ++items) {
3066 const char *q = from;
3068 for (todo = len; todo > 0; todo--)
3073 while (items <= half) {
3074 IV size = items * len;
3075 memcpy(p, to, size);
3081 memcpy(p, to, (count - items) * len);
3087 Perl_same_dirent(pTHX_ const char *a, const char *b)
3089 char *fa = strrchr(a,'/');
3090 char *fb = strrchr(b,'/');
3093 SV * const tmpsv = sv_newmortal();
3095 PERL_ARGS_ASSERT_SAME_DIRENT;
3108 sv_setpvs(tmpsv, ".");
3110 sv_setpvn(tmpsv, a, fa - a);
3111 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3114 sv_setpvs(tmpsv, ".");
3116 sv_setpvn(tmpsv, b, fb - b);
3117 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3119 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3120 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3122 #endif /* !HAS_RENAME */
3125 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3126 const char *const *const search_ext, I32 flags)
3128 const char *xfound = NULL;
3129 char *xfailed = NULL;
3130 char tmpbuf[MAXPATHLEN];
3135 #if defined(DOSISH) && !defined(OS2)
3136 # define SEARCH_EXTS ".bat", ".cmd", NULL
3137 # define MAX_EXT_LEN 4
3140 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3141 # define MAX_EXT_LEN 4
3144 # define SEARCH_EXTS ".pl", ".com", NULL
3145 # define MAX_EXT_LEN 4
3147 /* additional extensions to try in each dir if scriptname not found */
3149 static const char *const exts[] = { SEARCH_EXTS };
3150 const char *const *const ext = search_ext ? search_ext : exts;
3151 int extidx = 0, i = 0;
3152 const char *curext = NULL;
3154 PERL_UNUSED_ARG(search_ext);
3155 # define MAX_EXT_LEN 0
3158 PERL_ARGS_ASSERT_FIND_SCRIPT;
3161 * If dosearch is true and if scriptname does not contain path
3162 * delimiters, search the PATH for scriptname.
3164 * If SEARCH_EXTS is also defined, will look for each
3165 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3166 * while searching the PATH.
3168 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3169 * proceeds as follows:
3170 * If DOSISH or VMSISH:
3171 * + look for ./scriptname{,.foo,.bar}
3172 * + search the PATH for scriptname{,.foo,.bar}
3175 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3176 * this will not look in '.' if it's not in the PATH)
3181 # ifdef ALWAYS_DEFTYPES
3182 len = strlen(scriptname);
3183 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3184 int idx = 0, deftypes = 1;
3187 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3190 int idx = 0, deftypes = 1;
3193 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3195 /* The first time through, just add SEARCH_EXTS to whatever we
3196 * already have, so we can check for default file types. */
3198 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3204 if ((strlen(tmpbuf) + strlen(scriptname)
3205 + MAX_EXT_LEN) >= sizeof tmpbuf)
3206 continue; /* don't search dir with too-long name */
3207 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3211 if (strEQ(scriptname, "-"))
3213 if (dosearch) { /* Look in '.' first. */
3214 const char *cur = scriptname;
3216 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3218 if (strEQ(ext[i++],curext)) {
3219 extidx = -1; /* already has an ext */
3224 DEBUG_p(PerlIO_printf(Perl_debug_log,
3225 "Looking for %s\n",cur));
3226 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3227 && !S_ISDIR(PL_statbuf.st_mode)) {
3235 if (cur == scriptname) {
3236 len = strlen(scriptname);
3237 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3239 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3242 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3243 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3248 if (dosearch && !strchr(scriptname, '/')
3250 && !strchr(scriptname, '\\')
3252 && (s = PerlEnv_getenv("PATH")))
3256 bufend = s + strlen(s);
3257 while (s < bufend) {
3260 && *s != ';'; len++, s++) {
3261 if (len < sizeof tmpbuf)
3264 if (len < sizeof tmpbuf)
3267 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3273 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3274 continue; /* don't search dir with too-long name */
3277 && tmpbuf[len - 1] != '/'
3278 && tmpbuf[len - 1] != '\\'
3281 tmpbuf[len++] = '/';
3282 if (len == 2 && tmpbuf[0] == '.')
3284 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3288 len = strlen(tmpbuf);
3289 if (extidx > 0) /* reset after previous loop */
3293 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3294 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3295 if (S_ISDIR(PL_statbuf.st_mode)) {
3299 } while ( retval < 0 /* not there */
3300 && extidx>=0 && ext[extidx] /* try an extension? */
3301 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3306 if (S_ISREG(PL_statbuf.st_mode)
3307 && cando(S_IRUSR,TRUE,&PL_statbuf)
3308 #if !defined(DOSISH)
3309 && cando(S_IXUSR,TRUE,&PL_statbuf)
3313 xfound = tmpbuf; /* bingo! */
3317 xfailed = savepv(tmpbuf);
3320 if (!xfound && !seen_dot && !xfailed &&
3321 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3322 || S_ISDIR(PL_statbuf.st_mode)))
3324 seen_dot = 1; /* Disable message. */
3326 if (flags & 1) { /* do or die? */
3327 /* diag_listed_as: Can't execute %s */
3328 Perl_croak(aTHX_ "Can't %s %s%s%s",
3329 (xfailed ? "execute" : "find"),
3330 (xfailed ? xfailed : scriptname),
3331 (xfailed ? "" : " on PATH"),
3332 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3337 scriptname = xfound;
3339 return (scriptname ? savepv(scriptname) : NULL);
3342 #ifndef PERL_GET_CONTEXT_DEFINED
3345 Perl_get_context(void)
3347 #if defined(USE_ITHREADS)
3349 # ifdef OLD_PTHREADS_API
3351 int error = pthread_getspecific(PL_thr_key, &t)
3353 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3356 # ifdef I_MACH_CTHREADS
3357 return (void*)cthread_data(cthread_self());
3359 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3368 Perl_set_context(void *t)
3370 #if defined(USE_ITHREADS)
3373 PERL_ARGS_ASSERT_SET_CONTEXT;
3374 #if defined(USE_ITHREADS)
3375 # ifdef I_MACH_CTHREADS
3376 cthread_set_data(cthread_self(), t);
3379 const int error = pthread_setspecific(PL_thr_key, t);
3381 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3389 #endif /* !PERL_GET_CONTEXT_DEFINED */
3391 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3395 PERL_UNUSED_CONTEXT;
3401 Perl_get_op_names(pTHX)
3403 PERL_UNUSED_CONTEXT;
3404 return (char **)PL_op_name;
3408 Perl_get_op_descs(pTHX)
3410 PERL_UNUSED_CONTEXT;
3411 return (char **)PL_op_desc;
3415 Perl_get_no_modify(pTHX)
3417 PERL_UNUSED_CONTEXT;
3418 return PL_no_modify;
3422 Perl_get_opargs(pTHX)
3424 PERL_UNUSED_CONTEXT;
3425 return (U32 *)PL_opargs;
3429 Perl_get_ppaddr(pTHX)
3432 PERL_UNUSED_CONTEXT;
3433 return (PPADDR_t*)PL_ppaddr;
3436 #ifndef HAS_GETENV_LEN
3438 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3440 char * const env_trans = PerlEnv_getenv(env_elem);
3441 PERL_UNUSED_CONTEXT;
3442 PERL_ARGS_ASSERT_GETENV_LEN;
3444 *len = strlen(env_trans);
3451 Perl_get_vtbl(pTHX_ int vtbl_id)
3453 PERL_UNUSED_CONTEXT;
3455 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3456 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3460 Perl_my_fflush_all(pTHX)
3462 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3463 return PerlIO_flush(NULL);
3465 # if defined(HAS__FWALK)
3466 extern int fflush(FILE *);
3467 /* undocumented, unprototyped, but very useful BSDism */
3468 extern void _fwalk(int (*)(FILE *));
3472 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3474 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3475 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3477 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3478 open_max = sysconf(_SC_OPEN_MAX);
3481 open_max = FOPEN_MAX;
3484 open_max = OPEN_MAX;
3495 for (i = 0; i < open_max; i++)
3496 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3497 STDIO_STREAM_ARRAY[i]._file < open_max &&
3498 STDIO_STREAM_ARRAY[i]._flag)
3499 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3503 SETERRNO(EBADF,RMS_IFI);
3510 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3512 if (ckWARN(WARN_IO)) {
3514 = gv && (isGV_with_GP(gv))
3517 const char * const direction = have == '>' ? "out" : "in";
3519 if (name && HEK_LEN(name))
3520 Perl_warner(aTHX_ packWARN(WARN_IO),
3521 "Filehandle %"HEKf" opened only for %sput",
3522 HEKfARG(name), direction);
3524 Perl_warner(aTHX_ packWARN(WARN_IO),
3525 "Filehandle opened only for %sput", direction);
3530 Perl_report_evil_fh(pTHX_ const GV *gv)
3532 const IO *io = gv ? GvIO(gv) : NULL;
3533 const PERL_BITFIELD16 op = PL_op->op_type;
3537 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3539 warn_type = WARN_CLOSED;
3543 warn_type = WARN_UNOPENED;
3546 if (ckWARN(warn_type)) {
3548 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3549 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3550 const char * const pars =
3551 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3552 const char * const func =
3554 (op == OP_READLINE || op == OP_RCATLINE
3555 ? "readline" : /* "<HANDLE>" not nice */
3556 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3558 const char * const type =
3560 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3561 ? "socket" : "filehandle");
3562 const bool have_name = name && SvCUR(name);
3563 Perl_warner(aTHX_ packWARN(warn_type),
3564 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3565 have_name ? " " : "",
3566 SVfARG(have_name ? name : &PL_sv_no));
3567 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3569 aTHX_ packWARN(warn_type),
3570 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3571 func, pars, have_name ? " " : "",
3572 SVfARG(have_name ? name : &PL_sv_no)
3577 /* To workaround core dumps from the uninitialised tm_zone we get the
3578 * system to give us a reasonable struct to copy. This fix means that
3579 * strftime uses the tm_zone and tm_gmtoff values returned by
3580 * localtime(time()). That should give the desired result most of the
3581 * time. But probably not always!
3583 * This does not address tzname aspects of NETaa14816.
3588 # ifndef STRUCT_TM_HASZONE
3589 # define STRUCT_TM_HASZONE
3593 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3594 # ifndef HAS_TM_TM_ZONE
3595 # define HAS_TM_TM_ZONE
3600 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3602 #ifdef HAS_TM_TM_ZONE
3604 const struct tm* my_tm;
3605 PERL_UNUSED_CONTEXT;
3606 PERL_ARGS_ASSERT_INIT_TM;
3608 my_tm = localtime(&now);
3610 Copy(my_tm, ptm, 1, struct tm);
3612 PERL_UNUSED_CONTEXT;
3613 PERL_ARGS_ASSERT_INIT_TM;
3614 PERL_UNUSED_ARG(ptm);
3619 * mini_mktime - normalise struct tm values without the localtime()
3620 * semantics (and overhead) of mktime().
3623 Perl_mini_mktime(struct tm *ptm)
3627 int month, mday, year, jday;
3628 int odd_cent, odd_year;
3630 PERL_ARGS_ASSERT_MINI_MKTIME;
3632 #define DAYS_PER_YEAR 365
3633 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3634 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3635 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3636 #define SECS_PER_HOUR (60*60)
3637 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3638 /* parentheses deliberately absent on these two, otherwise they don't work */
3639 #define MONTH_TO_DAYS 153/5
3640 #define DAYS_TO_MONTH 5/153
3641 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3642 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3643 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3644 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3647 * Year/day algorithm notes:
3649 * With a suitable offset for numeric value of the month, one can find
3650 * an offset into the year by considering months to have 30.6 (153/5) days,
3651 * using integer arithmetic (i.e., with truncation). To avoid too much
3652 * messing about with leap days, we consider January and February to be
3653 * the 13th and 14th month of the previous year. After that transformation,
3654 * we need the month index we use to be high by 1 from 'normal human' usage,
3655 * so the month index values we use run from 4 through 15.
3657 * Given that, and the rules for the Gregorian calendar (leap years are those
3658 * divisible by 4 unless also divisible by 100, when they must be divisible
3659 * by 400 instead), we can simply calculate the number of days since some
3660 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3661 * the days we derive from our month index, and adding in the day of the
3662 * month. The value used here is not adjusted for the actual origin which
3663 * it normally would use (1 January A.D. 1), since we're not exposing it.
3664 * We're only building the value so we can turn around and get the
3665 * normalised values for the year, month, day-of-month, and day-of-year.
3667 * For going backward, we need to bias the value we're using so that we find
3668 * the right year value. (Basically, we don't want the contribution of
3669 * March 1st to the number to apply while deriving the year). Having done
3670 * that, we 'count up' the contribution to the year number by accounting for
3671 * full quadracenturies (400-year periods) with their extra leap days, plus
3672 * the contribution from full centuries (to avoid counting in the lost leap
3673 * days), plus the contribution from full quad-years (to count in the normal
3674 * leap days), plus the leftover contribution from any non-leap years.
3675 * At this point, if we were working with an actual leap day, we'll have 0
3676 * days left over. This is also true for March 1st, however. So, we have
3677 * to special-case that result, and (earlier) keep track of the 'odd'
3678 * century and year contributions. If we got 4 extra centuries in a qcent,
3679 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3680 * Otherwise, we add back in the earlier bias we removed (the 123 from
3681 * figuring in March 1st), find the month index (integer division by 30.6),
3682 * and the remainder is the day-of-month. We then have to convert back to
3683 * 'real' months (including fixing January and February from being 14/15 in
3684 * the previous year to being in the proper year). After that, to get
3685 * tm_yday, we work with the normalised year and get a new yearday value for
3686 * January 1st, which we subtract from the yearday value we had earlier,
3687 * representing the date we've re-built. This is done from January 1
3688 * because tm_yday is 0-origin.
3690 * Since POSIX time routines are only guaranteed to work for times since the
3691 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3692 * applies Gregorian calendar rules even to dates before the 16th century
3693 * doesn't bother me. Besides, you'd need cultural context for a given
3694 * date to know whether it was Julian or Gregorian calendar, and that's
3695 * outside the scope for this routine. Since we convert back based on the
3696 * same rules we used to build the yearday, you'll only get strange results
3697 * for input which needed normalising, or for the 'odd' century years which
3698 * were leap years in the Julian calendar but not in the Gregorian one.
3699 * I can live with that.
3701 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3702 * that's still outside the scope for POSIX time manipulation, so I don't
3706 year = 1900 + ptm->tm_year;
3707 month = ptm->tm_mon;
3708 mday = ptm->tm_mday;
3714 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3715 yearday += month*MONTH_TO_DAYS + mday + jday;
3717 * Note that we don't know when leap-seconds were or will be,
3718 * so we have to trust the user if we get something which looks
3719 * like a sensible leap-second. Wild values for seconds will
3720 * be rationalised, however.
3722 if ((unsigned) ptm->tm_sec <= 60) {
3729 secs += 60 * ptm->tm_min;
3730 secs += SECS_PER_HOUR * ptm->tm_hour;
3732 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3733 /* got negative remainder, but need positive time */
3734 /* back off an extra day to compensate */
3735 yearday += (secs/SECS_PER_DAY)-1;
3736 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3739 yearday += (secs/SECS_PER_DAY);
3740 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3743 else if (secs >= SECS_PER_DAY) {
3744 yearday += (secs/SECS_PER_DAY);
3745 secs %= SECS_PER_DAY;
3747 ptm->tm_hour = secs/SECS_PER_HOUR;
3748 secs %= SECS_PER_HOUR;
3749 ptm->tm_min = secs/60;
3751 ptm->tm_sec += secs;
3752 /* done with time of day effects */
3754 * The algorithm for yearday has (so far) left it high by 428.
3755 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3756 * bias it by 123 while trying to figure out what year it
3757 * really represents. Even with this tweak, the reverse
3758 * translation fails for years before A.D. 0001.
3759 * It would still fail for Feb 29, but we catch that one below.
3761 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3762 yearday -= YEAR_ADJUST;
3763 year = (yearday / DAYS_PER_QCENT) * 400;
3764 yearday %= DAYS_PER_QCENT;
3765 odd_cent = yearday / DAYS_PER_CENT;
3766 year += odd_cent * 100;
3767 yearday %= DAYS_PER_CENT;
3768 year += (yearday / DAYS_PER_QYEAR) * 4;
3769 yearday %= DAYS_PER_QYEAR;
3770 odd_year = yearday / DAYS_PER_YEAR;
3772 yearday %= DAYS_PER_YEAR;
3773 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3778 yearday += YEAR_ADJUST; /* recover March 1st crock */
3779 month = yearday*DAYS_TO_MONTH;
3780 yearday -= month*MONTH_TO_DAYS;
3781 /* recover other leap-year adjustment */
3790 ptm->tm_year = year - 1900;
3792 ptm->tm_mday = yearday;
3793 ptm->tm_mon = month;
3797 ptm->tm_mon = month - 1;
3799 /* re-build yearday based on Jan 1 to get tm_yday */
3801 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3802 yearday += 14*MONTH_TO_DAYS + 1;
3803 ptm->tm_yday = jday - yearday;
3804 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3808 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)
3812 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3819 PERL_ARGS_ASSERT_MY_STRFTIME;
3821 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3824 mytm.tm_hour = hour;
3825 mytm.tm_mday = mday;
3827 mytm.tm_year = year;
3828 mytm.tm_wday = wday;
3829 mytm.tm_yday = yday;
3830 mytm.tm_isdst = isdst;
3832 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3833 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3838 #ifdef HAS_TM_TM_GMTOFF
3839 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3841 #ifdef HAS_TM_TM_ZONE
3842 mytm.tm_zone = mytm2.tm_zone;
3847 Newx(buf, buflen, char);
3849 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3850 len = strftime(buf, buflen, fmt, &mytm);
3854 ** The following is needed to handle to the situation where
3855 ** tmpbuf overflows. Basically we want to allocate a buffer
3856 ** and try repeatedly. The reason why it is so complicated
3857 ** is that getting a return value of 0 from strftime can indicate
3858 ** one of the following:
3859 ** 1. buffer overflowed,
3860 ** 2. illegal conversion specifier, or
3861 ** 3. the format string specifies nothing to be returned(not
3862 ** an error). This could be because format is an empty string
3863 ** or it specifies %p that yields an empty string in some locale.
3864 ** If there is a better way to make it portable, go ahead by
3867 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3870 /* Possibly buf overflowed - try again with a bigger buf */
3871 const int fmtlen = strlen(fmt);
3872 int bufsize = fmtlen + buflen;
3874 Renew(buf, bufsize, char);
3877 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3878 buflen = strftime(buf, bufsize, fmt, &mytm);
3881 if (buflen > 0 && buflen < bufsize)
3883 /* heuristic to prevent out-of-memory errors */
3884 if (bufsize > 100*fmtlen) {
3890 Renew(buf, bufsize, char);
3895 Perl_croak(aTHX_ "panic: no strftime");
3901 #define SV_CWD_RETURN_UNDEF \
3902 sv_setsv(sv, &PL_sv_undef); \
3905 #define SV_CWD_ISDOT(dp) \
3906 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3907 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3910 =head1 Miscellaneous Functions
3912 =for apidoc getcwd_sv
3914 Fill the sv with current working directory
3919 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3920 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3921 * getcwd(3) if available
3922 * Comments from the orignal:
3923 * This is a faster version of getcwd. It's also more dangerous
3924 * because you might chdir out of a directory that you can't chdir
3928 Perl_getcwd_sv(pTHX_ SV *sv)
3933 PERL_ARGS_ASSERT_GETCWD_SV;
3937 char buf[MAXPATHLEN];
3939 /* Some getcwd()s automatically allocate a buffer of the given
3940 * size from the heap if they are given a NULL buffer pointer.
3941 * The problem is that this behaviour is not portable. */
3942 if (getcwd(buf, sizeof(buf) - 1)) {
3947 sv_setsv(sv, &PL_sv_undef);
3955 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3959 SvUPGRADE(sv, SVt_PV);
3961 if (PerlLIO_lstat(".", &statbuf) < 0) {
3962 SV_CWD_RETURN_UNDEF;
3965 orig_cdev = statbuf.st_dev;
3966 orig_cino = statbuf.st_ino;
3976 if (PerlDir_chdir("..") < 0) {
3977 SV_CWD_RETURN_UNDEF;
3979 if (PerlLIO_stat(".", &statbuf) < 0) {
3980 SV_CWD_RETURN_UNDEF;
3983 cdev = statbuf.st_dev;
3984 cino = statbuf.st_ino;
3986 if (odev == cdev && oino == cino) {
3989 if (!(dir = PerlDir_open("."))) {
3990 SV_CWD_RETURN_UNDEF;
3993 while ((dp = PerlDir_read(dir)) != NULL) {
3995 namelen = dp->d_namlen;
3997 namelen = strlen(dp->d_name);
4000 if (SV_CWD_ISDOT(dp)) {
4004 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4005 SV_CWD_RETURN_UNDEF;
4008 tdev = statbuf.st_dev;
4009 tino = statbuf.st_ino;
4010 if (tino == oino && tdev == odev) {
4016 SV_CWD_RETURN_UNDEF;
4019 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4020 SV_CWD_RETURN_UNDEF;
4023 SvGROW(sv, pathlen + namelen + 1);
4027 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4030 /* prepend current directory to the front */
4032 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4033 pathlen += (namelen + 1);
4035 #ifdef VOID_CLOSEDIR
4038 if (PerlDir_close(dir) < 0) {
4039 SV_CWD_RETURN_UNDEF;
4045 SvCUR_set(sv, pathlen);
4049 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4050 SV_CWD_RETURN_UNDEF;
4053 if (PerlLIO_stat(".", &statbuf) < 0) {
4054 SV_CWD_RETURN_UNDEF;
4057 cdev = statbuf.st_dev;
4058 cino = statbuf.st_ino;
4060 if (cdev != orig_cdev || cino != orig_cino) {
4061 Perl_croak(aTHX_ "Unstable directory path, "
4062 "current directory changed unexpectedly");
4075 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4076 # define EMULATE_SOCKETPAIR_UDP
4079 #ifdef EMULATE_SOCKETPAIR_UDP
4081 S_socketpair_udp (int fd[2]) {
4083 /* Fake a datagram socketpair using UDP to localhost. */
4084 int sockets[2] = {-1, -1};
4085 struct sockaddr_in addresses[2];
4087 Sock_size_t size = sizeof(struct sockaddr_in);
4088 unsigned short port;
4091 memset(&addresses, 0, sizeof(addresses));
4094 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4095 if (sockets[i] == -1)
4096 goto tidy_up_and_fail;
4098 addresses[i].sin_family = AF_INET;
4099 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4100 addresses[i].sin_port = 0; /* kernel choses port. */
4101 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4102 sizeof(struct sockaddr_in)) == -1)
4103 goto tidy_up_and_fail;
4106 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4107 for each connect the other socket to it. */
4110 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4112 goto tidy_up_and_fail;
4113 if (size != sizeof(struct sockaddr_in))
4114 goto abort_tidy_up_and_fail;
4115 /* !1 is 0, !0 is 1 */
4116 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4117 sizeof(struct sockaddr_in)) == -1)
4118 goto tidy_up_and_fail;
4121 /* Now we have 2 sockets connected to each other. I don't trust some other
4122 process not to have already sent a packet to us (by random) so send
4123 a packet from each to the other. */
4126 /* I'm going to send my own port number. As a short.
4127 (Who knows if someone somewhere has sin_port as a bitfield and needs
4128 this routine. (I'm assuming crays have socketpair)) */
4129 port = addresses[i].sin_port;
4130 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4131 if (got != sizeof(port)) {
4133 goto tidy_up_and_fail;
4134 goto abort_tidy_up_and_fail;
4138 /* Packets sent. I don't trust them to have arrived though.
4139 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4140 connect to localhost will use a second kernel thread. In 2.6 the
4141 first thread running the connect() returns before the second completes,
4142 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4143 returns 0. Poor programs have tripped up. One poor program's authors'
4144 had a 50-1 reverse stock split. Not sure how connected these were.)
4145 So I don't trust someone not to have an unpredictable UDP stack.
4149 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4150 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4154 FD_SET((unsigned int)sockets[0], &rset);
4155 FD_SET((unsigned int)sockets[1], &rset);
4157 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4158 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4159 || !FD_ISSET(sockets[1], &rset)) {
4160 /* I hope this is portable and appropriate. */
4162 goto tidy_up_and_fail;
4163 goto abort_tidy_up_and_fail;
4167 /* And the paranoia department even now doesn't trust it to have arrive
4168 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4170 struct sockaddr_in readfrom;
4171 unsigned short buffer[2];
4176 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4177 sizeof(buffer), MSG_DONTWAIT,
4178 (struct sockaddr *) &readfrom, &size);
4180 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4182 (struct sockaddr *) &readfrom, &size);
4186 goto tidy_up_and_fail;
4187 if (got != sizeof(port)
4188 || size != sizeof(struct sockaddr_in)
4189 /* Check other socket sent us its port. */
4190 || buffer[0] != (unsigned short) addresses[!i].sin_port
4191 /* Check kernel says we got the datagram from that socket */
4192 || readfrom.sin_family != addresses[!i].sin_family
4193 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4194 || readfrom.sin_port != addresses[!i].sin_port)
4195 goto abort_tidy_up_and_fail;
4198 /* My caller (my_socketpair) has validated that this is non-NULL */
4201 /* I hereby declare this connection open. May God bless all who cross
4205 abort_tidy_up_and_fail:
4206 errno = ECONNABORTED;
4210 if (sockets[0] != -1)
4211 PerlLIO_close(sockets[0]);
4212 if (sockets[1] != -1)
4213 PerlLIO_close(sockets[1]);
4218 #endif /* EMULATE_SOCKETPAIR_UDP */
4220 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4222 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4223 /* Stevens says that family must be AF_LOCAL, protocol 0.
4224 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4229 struct sockaddr_in listen_addr;
4230 struct sockaddr_in connect_addr;
4235 || family != AF_UNIX
4238 errno = EAFNOSUPPORT;
4246 #ifdef EMULATE_SOCKETPAIR_UDP
4247 if (type == SOCK_DGRAM)
4248 return S_socketpair_udp(fd);
4251 aTHXa(PERL_GET_THX);
4252 listener = PerlSock_socket(AF_INET, type, 0);
4255 memset(&listen_addr, 0, sizeof(listen_addr));
4256 listen_addr.sin_family = AF_INET;
4257 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4258 listen_addr.sin_port = 0; /* kernel choses port. */
4259 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4260 sizeof(listen_addr)) == -1)
4261 goto tidy_up_and_fail;
4262 if (PerlSock_listen(listener, 1) == -1)
4263 goto tidy_up_and_fail;
4265 connector = PerlSock_socket(AF_INET, type, 0);
4266 if (connector == -1)
4267 goto tidy_up_and_fail;
4268 /* We want to find out the port number to connect to. */
4269 size = sizeof(connect_addr);
4270 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4272 goto tidy_up_and_fail;
4273 if (size != sizeof(connect_addr))
4274 goto abort_tidy_up_and_fail;
4275 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4276 sizeof(connect_addr)) == -1)
4277 goto tidy_up_and_fail;
4279 size = sizeof(listen_addr);
4280 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4283 goto tidy_up_and_fail;
4284 if (size != sizeof(listen_addr))
4285 goto abort_tidy_up_and_fail;
4286 PerlLIO_close(listener);
4287 /* Now check we are talking to ourself by matching port and host on the
4289 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4291 goto tidy_up_and_fail;
4292 if (size != sizeof(connect_addr)
4293 || listen_addr.sin_family != connect_addr.sin_family
4294 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4295 || listen_addr.sin_port != connect_addr.sin_port) {
4296 goto abort_tidy_up_and_fail;
4302 abort_tidy_up_and_fail:
4304 errno = ECONNABORTED; /* This would be the standard thing to do. */
4306 # ifdef ECONNREFUSED
4307 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4309 errno = ETIMEDOUT; /* Desperation time. */
4316 PerlLIO_close(listener);
4317 if (connector != -1)
4318 PerlLIO_close(connector);
4320 PerlLIO_close(acceptor);
4326 /* In any case have a stub so that there's code corresponding
4327 * to the my_socketpair in embed.fnc. */
4329 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4330 #ifdef HAS_SOCKETPAIR
4331 return socketpair(family, type, protocol, fd);
4340 =for apidoc sv_nosharing
4342 Dummy routine which "shares" an SV when there is no sharing module present.
4343 Or "locks" it. Or "unlocks" it. In other
4344 words, ignores its single SV argument.
4345 Exists to avoid test for a NULL function pointer and because it could
4346 potentially warn under some level of strict-ness.
4352 Perl_sv_nosharing(pTHX_ SV *sv)
4354 PERL_UNUSED_CONTEXT;
4355 PERL_UNUSED_ARG(sv);
4360 =for apidoc sv_destroyable
4362 Dummy routine which reports that object can be destroyed when there is no
4363 sharing module present. It ignores its single SV argument, and returns
4364 'true'. Exists to avoid test for a NULL function pointer and because it
4365 could potentially warn under some level of strict-ness.
4371 Perl_sv_destroyable(pTHX_ SV *sv)
4373 PERL_UNUSED_CONTEXT;
4374 PERL_UNUSED_ARG(sv);
4379 Perl_parse_unicode_opts(pTHX_ const char **popt)
4381 const char *p = *popt;
4384 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4389 opt = (U32) grok_atou(p, &endptr);
4391 if (*p && *p != '\n' && *p != '\r') {
4392 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4394 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4400 case PERL_UNICODE_STDIN:
4401 opt |= PERL_UNICODE_STDIN_FLAG; break;
4402 case PERL_UNICODE_STDOUT:
4403 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4404 case PERL_UNICODE_STDERR:
4405 opt |= PERL_UNICODE_STDERR_FLAG; break;
4406 case PERL_UNICODE_STD:
4407 opt |= PERL_UNICODE_STD_FLAG; break;
4408 case PERL_UNICODE_IN:
4409 opt |= PERL_UNICODE_IN_FLAG; break;
4410 case PERL_UNICODE_OUT:
4411 opt |= PERL_UNICODE_OUT_FLAG; break;
4412 case PERL_UNICODE_INOUT:
4413 opt |= PERL_UNICODE_INOUT_FLAG; break;
4414 case PERL_UNICODE_LOCALE:
4415 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4416 case PERL_UNICODE_ARGV:
4417 opt |= PERL_UNICODE_ARGV_FLAG; break;
4418 case PERL_UNICODE_UTF8CACHEASSERT:
4419 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4421 if (*p != '\n' && *p != '\r') {
4422 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4425 "Unknown Unicode option letter '%c'", *p);
4432 opt = PERL_UNICODE_DEFAULT_FLAGS;
4434 the_end_of_the_opts_parser:
4436 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4437 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
4438 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4446 # include <starlet.h>
4453 * This is really just a quick hack which grabs various garbage
4454 * values. It really should be a real hash algorithm which
4455 * spreads the effect of every input bit onto every output bit,
4456 * if someone who knows about such things would bother to write it.
4457 * Might be a good idea to add that function to CORE as well.
4458 * No numbers below come from careful analysis or anything here,
4459 * except they are primes and SEED_C1 > 1E6 to get a full-width
4460 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4461 * probably be bigger too.
4464 # define SEED_C1 1000003
4465 #define SEED_C4 73819
4467 # define SEED_C1 25747
4468 #define SEED_C4 20639
4472 #define SEED_C5 26107
4474 #ifndef PERL_NO_DEV_RANDOM
4479 /* when[] = (low 32 bits, high 32 bits) of time since epoch
4480 * in 100-ns units, typically incremented ever 10 ms. */
4481 unsigned int when[2];
4483 # ifdef HAS_GETTIMEOFDAY
4484 struct timeval when;
4490 /* This test is an escape hatch, this symbol isn't set by Configure. */
4491 #ifndef PERL_NO_DEV_RANDOM
4492 #ifndef PERL_RANDOM_DEVICE
4493 /* /dev/random isn't used by default because reads from it will block
4494 * if there isn't enough entropy available. You can compile with
4495 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4496 * is enough real entropy to fill the seed. */
4497 # define PERL_RANDOM_DEVICE "/dev/urandom"
4499 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4501 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4510 _ckvmssts(sys$gettim(when));
4511 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
4513 # ifdef HAS_GETTIMEOFDAY
4514 PerlProc_gettimeofday(&when,NULL);
4515 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4518 u = (U32)SEED_C1 * when;
4521 u += SEED_C3 * (U32)PerlProc_getpid();
4522 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4523 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4524 u += SEED_C5 * (U32)PTR2UV(&when);
4530 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4535 PERL_ARGS_ASSERT_GET_HASH_SEED;
4537 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4540 #ifndef USE_HASH_SEED_EXPLICIT
4542 /* ignore leading spaces */
4543 while (isSPACE(*env_pv))
4545 #ifdef USE_PERL_PERTURB_KEYS
4546 /* if they set it to "0" we disable key traversal randomization completely */
4547 if (strEQ(env_pv,"0")) {
4548 PL_hash_rand_bits_enabled= 0;
4550 /* otherwise switch to deterministic mode */
4551 PL_hash_rand_bits_enabled= 2;
4554 /* ignore a leading 0x... if it is there */
4555 if (env_pv[0] == '0' && env_pv[1] == 'x')
4558 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4559 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4560 if ( isXDIGIT(*env_pv)) {
4561 seed_buffer[i] |= READ_XDIGIT(env_pv);
4564 while (isSPACE(*env_pv))
4567 if (*env_pv && !isXDIGIT(*env_pv)) {
4568 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4570 /* should we check for unparsed crap? */
4571 /* should we warn about unused hex? */
4572 /* should we warn about insufficient hex? */
4577 (void)seedDrand01((Rand_seed_t)seed());
4579 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4580 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4583 #ifdef USE_PERL_PERTURB_KEYS
4584 { /* initialize PL_hash_rand_bits from the hash seed.
4585 * This value is highly volatile, it is updated every
4586 * hash insert, and is used as part of hash bucket chain
4587 * randomization and hash iterator randomization. */
4588 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4589 for( i = 0; i < sizeof(UV) ; i++ ) {
4590 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4591 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4594 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4596 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4597 PL_hash_rand_bits_enabled= 0;
4598 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4599 PL_hash_rand_bits_enabled= 1;
4600 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4601 PL_hash_rand_bits_enabled= 2;
4603 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4609 #ifdef PERL_GLOBAL_STRUCT
4611 #define PERL_GLOBAL_STRUCT_INIT
4612 #include "opcode.h" /* the ppaddr and check */
4615 Perl_init_global_struct(pTHX)
4617 struct perl_vars *plvarsp = NULL;
4618 # ifdef PERL_GLOBAL_STRUCT
4619 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4620 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4621 PERL_UNUSED_CONTEXT;
4622 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4623 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4624 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4628 plvarsp = PL_VarsPtr;
4629 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4634 # define PERLVAR(prefix,var,type) /**/
4635 # define PERLVARA(prefix,var,n,type) /**/
4636 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4637 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4638 # include "perlvars.h"
4643 # ifdef PERL_GLOBAL_STRUCT
4646 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4647 if (!plvarsp->Gppaddr)
4651 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4652 if (!plvarsp->Gcheck)
4654 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4655 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4657 # ifdef PERL_SET_VARS
4658 PERL_SET_VARS(plvarsp);
4660 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4661 plvarsp->Gsv_placeholder.sv_flags = 0;
4662 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4664 # undef PERL_GLOBAL_STRUCT_INIT
4669 #endif /* PERL_GLOBAL_STRUCT */
4671 #ifdef PERL_GLOBAL_STRUCT
4674 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4676 int veto = plvarsp->Gveto_cleanup;
4678 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4679 PERL_UNUSED_CONTEXT;
4680 # ifdef PERL_GLOBAL_STRUCT
4681 # ifdef PERL_UNSET_VARS
4682 PERL_UNSET_VARS(plvarsp);
4686 free(plvarsp->Gppaddr);
4687 free(plvarsp->Gcheck);
4688 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4694 #endif /* PERL_GLOBAL_STRUCT */
4698 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
4699 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4700 * given, and you supply your own implementation.
4702 * The default implementation reads a single env var, PERL_MEM_LOG,
4703 * expecting one or more of the following:
4705 * \d+ - fd fd to write to : must be 1st (grok_atou)
4706 * 'm' - memlog was PERL_MEM_LOG=1
4707 * 's' - svlog was PERL_SV_LOG=1
4708 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4710 * This makes the logger controllable enough that it can reasonably be
4711 * added to the system perl.
4714 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4715 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4717 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4719 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4720 * writes to. In the default logger, this is settable at runtime.
4722 #ifndef PERL_MEM_LOG_FD
4723 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4726 #ifndef PERL_MEM_LOG_NOIMPL
4728 # ifdef DEBUG_LEAKING_SCALARS
4729 # define SV_LOG_SERIAL_FMT " [%lu]"
4730 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4732 # define SV_LOG_SERIAL_FMT
4733 # define _SV_LOG_SERIAL_ARG(sv)
4737 S_mem_log_common(enum mem_log_type mlt, const UV n,
4738 const UV typesize, const char *type_name, const SV *sv,
4739 Malloc_t oldalloc, Malloc_t newalloc,
4740 const char *filename, const int linenumber,
4741 const char *funcname)
4745 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4747 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4750 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4752 /* We can't use SVs or PerlIO for obvious reasons,
4753 * so we'll use stdio and low-level IO instead. */
4754 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4756 # ifdef HAS_GETTIMEOFDAY
4757 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4758 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4760 gettimeofday(&tv, 0);
4762 # define MEM_LOG_TIME_FMT "%10d: "
4763 # define MEM_LOG_TIME_ARG (int)when
4767 /* If there are other OS specific ways of hires time than
4768 * gettimeofday() (see ext/Time-HiRes), the easiest way is
4769 * probably that they would be used to fill in the struct
4774 int fd = grok_atou(pmlenv, &endptr); /* Ignore endptr. */
4776 fd = PERL_MEM_LOG_FD;
4778 if (strchr(pmlenv, 't')) {
4779 len = my_snprintf(buf, sizeof(buf),
4780 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4781 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4785 len = my_snprintf(buf, sizeof(buf),
4786 "alloc: %s:%d:%s: %"IVdf" %"UVuf
4787 " %s = %"IVdf": %"UVxf"\n",
4788 filename, linenumber, funcname, n, typesize,
4789 type_name, n * typesize, PTR2UV(newalloc));
4792 len = my_snprintf(buf, sizeof(buf),
4793 "realloc: %s:%d:%s: %"IVdf" %"UVuf
4794 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
4795 filename, linenumber, funcname, n, typesize,
4796 type_name, n * typesize, PTR2UV(oldalloc),
4800 len = my_snprintf(buf, sizeof(buf),
4801 "free: %s:%d:%s: %"UVxf"\n",
4802 filename, linenumber, funcname,
4807 len = my_snprintf(buf, sizeof(buf),
4808 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
4809 mlt == MLT_NEW_SV ? "new" : "del",
4810 filename, linenumber, funcname,
4811 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4816 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4820 #endif /* !PERL_MEM_LOG_NOIMPL */
4822 #ifndef PERL_MEM_LOG_NOIMPL
4824 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4825 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4827 /* this is suboptimal, but bug compatible. User is providing their
4828 own implementation, but is getting these functions anyway, and they
4829 do nothing. But _NOIMPL users should be able to cope or fix */
4831 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4832 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4836 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4838 const char *filename, const int linenumber,
4839 const char *funcname)
4841 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4842 NULL, NULL, newalloc,
4843 filename, linenumber, funcname);
4848 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4849 Malloc_t oldalloc, Malloc_t newalloc,
4850 const char *filename, const int linenumber,
4851 const char *funcname)
4853 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4854 NULL, oldalloc, newalloc,
4855 filename, linenumber, funcname);
4860 Perl_mem_log_free(Malloc_t oldalloc,
4861 const char *filename, const int linenumber,
4862 const char *funcname)
4864 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4865 filename, linenumber, funcname);
4870 Perl_mem_log_new_sv(const SV *sv,
4871 const char *filename, const int linenumber,
4872 const char *funcname)
4874 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4875 filename, linenumber, funcname);
4879 Perl_mem_log_del_sv(const SV *sv,
4880 const char *filename, const int linenumber,
4881 const char *funcname)
4883 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4884 filename, linenumber, funcname);
4887 #endif /* PERL_MEM_LOG */
4890 =for apidoc my_sprintf
4892 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
4893 the length of the string written to the buffer. Only rare pre-ANSI systems
4894 need the wrapper function - usually this is a direct call to C<sprintf>.
4898 #ifndef SPRINTF_RETURNS_STRLEN
4900 Perl_my_sprintf(char *buffer, const char* pat, ...)
4903 PERL_ARGS_ASSERT_MY_SPRINTF;
4904 va_start(args, pat);
4905 vsprintf(buffer, pat, args);
4907 return strlen(buffer);
4912 =for apidoc my_snprintf
4914 The C library C<snprintf> functionality, if available and
4915 standards-compliant (uses C<vsnprintf>, actually). However, if the
4916 C<vsnprintf> is not available, will unfortunately use the unsafe
4917 C<vsprintf> which can overrun the buffer (there is an overrun check,
4918 but that may be too late). Consider using C<sv_vcatpvf> instead, or
4919 getting C<vsnprintf>.
4924 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
4928 PERL_ARGS_ASSERT_MY_SNPRINTF;
4929 #ifndef HAS_VSNPRINTF
4930 PERL_UNUSED_VAR(len);
4932 va_start(ap, format);
4933 #ifdef HAS_VSNPRINTF
4934 retval = vsnprintf(buffer, len, format, ap);
4936 retval = vsprintf(buffer, format, ap);
4939 /* vsprintf() shows failure with < 0 */
4941 #ifdef HAS_VSNPRINTF
4942 /* vsnprintf() shows failure with >= len */
4944 (len > 0 && (Size_t)retval >= len)
4947 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
4952 =for apidoc my_vsnprintf
4954 The C library C<vsnprintf> if available and standards-compliant.
4955 However, if if the C<vsnprintf> is not available, will unfortunately
4956 use the unsafe C<vsprintf> which can overrun the buffer (there is an
4957 overrun check, but that may be too late). Consider using
4958 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
4963 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
4969 PERL_ARGS_ASSERT_MY_VSNPRINTF;
4970 #ifndef HAS_VSNPRINTF
4971 PERL_UNUSED_VAR(len);
4973 Perl_va_copy(ap, apc);
4974 # ifdef HAS_VSNPRINTF
4975 retval = vsnprintf(buffer, len, format, apc);
4977 retval = vsprintf(buffer, format, apc);
4981 # ifdef HAS_VSNPRINTF
4982 retval = vsnprintf(buffer, len, format, ap);
4984 retval = vsprintf(buffer, format, ap);
4986 #endif /* #ifdef NEED_VA_COPY */
4987 /* vsprintf() shows failure with < 0 */
4989 #ifdef HAS_VSNPRINTF
4990 /* vsnprintf() shows failure with >= len */
4992 (len > 0 && (Size_t)retval >= len)
4995 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5000 Perl_my_clearenv(pTHX)
5003 #if ! defined(PERL_MICRO)
5004 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5006 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5007 # if defined(USE_ENVIRON_ARRAY)
5008 # if defined(USE_ITHREADS)
5009 /* only the parent thread can clobber the process environment */
5010 if (PL_curinterp == aTHX)
5011 # endif /* USE_ITHREADS */
5013 # if ! defined(PERL_USE_SAFE_PUTENV)
5014 if ( !PL_use_safe_putenv) {
5016 if (environ == PL_origenviron)
5017 environ = (char**)safesysmalloc(sizeof(char*));
5019 for (i = 0; environ[i]; i++)
5020 (void)safesysfree(environ[i]);
5023 # else /* PERL_USE_SAFE_PUTENV */
5024 # if defined(HAS_CLEARENV)
5026 # elif defined(HAS_UNSETENV)
5027 int bsiz = 80; /* Most envvar names will be shorter than this. */
5028 char *buf = (char*)safesysmalloc(bsiz);
5029 while (*environ != NULL) {
5030 char *e = strchr(*environ, '=');
5031 int l = e ? e - *environ : (int)strlen(*environ);
5033 (void)safesysfree(buf);
5034 bsiz = l + 1; /* + 1 for the \0. */
5035 buf = (char*)safesysmalloc(bsiz);
5037 memcpy(buf, *environ, l);
5039 (void)unsetenv(buf);
5041 (void)safesysfree(buf);
5042 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5043 /* Just null environ and accept the leakage. */
5045 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5046 # endif /* ! PERL_USE_SAFE_PUTENV */
5048 # endif /* USE_ENVIRON_ARRAY */
5049 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5050 #endif /* PERL_MICRO */
5053 #ifdef PERL_IMPLICIT_CONTEXT
5055 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5056 the global PL_my_cxt_index is incremented, and that value is assigned to
5057 that module's static my_cxt_index (who's address is passed as an arg).
5058 Then, for each interpreter this function is called for, it makes sure a
5059 void* slot is available to hang the static data off, by allocating or
5060 extending the interpreter's PL_my_cxt_list array */
5062 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5064 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5068 PERL_ARGS_ASSERT_MY_CXT_INIT;
5070 /* this module hasn't been allocated an index yet */
5071 #if defined(USE_ITHREADS)
5072 MUTEX_LOCK(&PL_my_ctx_mutex);
5074 *index = PL_my_cxt_index++;
5075 #if defined(USE_ITHREADS)
5076 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5080 /* make sure the array is big enough */
5081 if (PL_my_cxt_size <= *index) {
5082 if (PL_my_cxt_size) {
5083 while (PL_my_cxt_size <= *index)
5084 PL_my_cxt_size *= 2;
5085 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5088 PL_my_cxt_size = 16;
5089 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5092 /* newSV() allocates one more than needed */
5093 p = (void*)SvPVX(newSV(size-1));
5094 PL_my_cxt_list[*index] = p;
5095 Zero(p, size, char);
5099 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5102 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5107 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5109 for (index = 0; index < PL_my_cxt_index; index++) {
5110 const char *key = PL_my_cxt_keys[index];
5111 /* try direct pointer compare first - there are chances to success,
5112 * and it's much faster.
5114 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5121 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5127 PERL_ARGS_ASSERT_MY_CXT_INIT;
5129 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5131 /* this module hasn't been allocated an index yet */
5132 #if defined(USE_ITHREADS)
5133 MUTEX_LOCK(&PL_my_ctx_mutex);
5135 index = PL_my_cxt_index++;
5136 #if defined(USE_ITHREADS)
5137 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5141 /* make sure the array is big enough */
5142 if (PL_my_cxt_size <= index) {
5143 int old_size = PL_my_cxt_size;
5145 if (PL_my_cxt_size) {
5146 while (PL_my_cxt_size <= index)
5147 PL_my_cxt_size *= 2;
5148 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5149 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5152 PL_my_cxt_size = 16;
5153 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5154 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5156 for (i = old_size; i < PL_my_cxt_size; i++) {
5157 PL_my_cxt_keys[i] = 0;
5158 PL_my_cxt_list[i] = 0;
5161 PL_my_cxt_keys[index] = my_cxt_key;
5162 /* newSV() allocates one more than needed */
5163 p = (void*)SvPVX(newSV(size-1));
5164 PL_my_cxt_list[index] = p;
5165 Zero(p, size, char);
5168 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5169 #endif /* PERL_IMPLICIT_CONTEXT */
5172 Perl_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5176 const char *vn = NULL;
5177 SV *const module = PL_stack_base[ax];
5179 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5181 if (items >= 2) /* version supplied as bootstrap arg */
5182 sv = PL_stack_base[ax + 1];
5184 /* XXX GV_ADDWARN */
5186 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5187 if (!sv || !SvOK(sv)) {
5189 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5193 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5194 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5195 ? sv : sv_2mortal(new_version(sv));
5196 xssv = upg_version(xssv, 0);
5197 if ( vcmp(pmsv,xssv) ) {
5198 SV *string = vstringify(xssv);
5199 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5200 " does not match ", SVfARG(module), SVfARG(string));
5202 SvREFCNT_dec(string);
5203 string = vstringify(pmsv);
5206 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, SVfARG(module), vn,
5209 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, SVfARG(string));
5211 SvREFCNT_dec(string);
5213 Perl_sv_2mortal(aTHX_ xpt);
5214 Perl_croak_sv(aTHX_ xpt);
5220 Perl_xs_apiversion_bootcheck(pTHX_ SV *module, const char *api_p,
5224 SV *compver = Perl_newSVpvn_flags(aTHX_ api_p, api_len, SVs_TEMP);
5227 PERL_ARGS_ASSERT_XS_APIVERSION_BOOTCHECK;
5229 /* This might croak */
5230 compver = upg_version(compver, 0);
5231 /* This should never croak */
5232 runver = new_version(PL_apiversion);
5233 if (vcmp(compver, runver)) {
5234 SV *compver_string = vstringify(compver);
5235 SV *runver_string = vstringify(runver);
5236 xpt = Perl_newSVpvf(aTHX_ "Perl API version %"SVf
5237 " of %"SVf" does not match %"SVf,
5238 SVfARG(compver_string), SVfARG(module),
5239 SVfARG(runver_string));
5240 Perl_sv_2mortal(aTHX_ xpt);
5242 SvREFCNT_dec(compver_string);
5243 SvREFCNT_dec(runver_string);
5245 SvREFCNT_dec(runver);
5247 Perl_croak_sv(aTHX_ xpt);
5251 =for apidoc my_strlcat
5253 The C library C<strlcat> if available, or a Perl implementation of it.
5254 This operates on C C<NUL>-terminated strings.
5256 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5257 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5258 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5259 practice this should not happen as it means that either C<size> is incorrect or
5260 that C<dst> is not a proper C<NUL>-terminated string).
5262 Note that C<size> is the full size of the destination buffer and
5263 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5264 room for the C<NUL> should be included in C<size>.
5268 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcat
5272 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5274 Size_t used, length, copy;
5277 length = strlen(src);
5278 if (size > 0 && used < size - 1) {
5279 copy = (length >= size - used) ? size - used - 1 : length;
5280 memcpy(dst + used, src, copy);
5281 dst[used + copy] = '\0';
5283 return used + length;
5289 =for apidoc my_strlcpy
5291 The C library C<strlcpy> if available, or a Perl implementation of it.
5292 This operates on C C<NUL>-terminated strings.
5294 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5295 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5299 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy
5303 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5305 Size_t length, copy;
5307 length = strlen(src);
5309 copy = (length >= size) ? size - 1 : length;
5310 memcpy(dst, src, copy);
5317 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5318 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5319 long _ftol( double ); /* Defined by VC6 C libs. */
5320 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5323 PERL_STATIC_INLINE bool
5324 S_gv_has_usable_name(pTHX_ GV *gv)
5328 && HvENAME(GvSTASH(gv))
5329 && (gvp = (GV **)hv_fetchhek(
5330 GvSTASH(gv), GvNAME_HEK(gv), 0
5336 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5338 SV * const dbsv = GvSVn(PL_DBsub);
5339 const bool save_taint = TAINT_get;
5341 /* When we are called from pp_goto (svp is null),
5342 * we do not care about using dbsv to call CV;
5343 * it's for informational purposes only.
5346 PERL_ARGS_ASSERT_GET_DB_SUB;
5350 if (!PERLDB_SUB_NN) {
5354 gv_efullname3(dbsv, gv, NULL);
5356 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || !gv
5357 || strEQ(GvNAME(gv), "END")
5358 || ( /* Could be imported, and old sub redefined. */
5359 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5361 !( (SvTYPE(*svp) == SVt_PVGV)
5362 && (GvCV((const GV *)*svp) == cv)
5363 /* Use GV from the stack as a fallback. */
5364 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5368 /* GV is potentially non-unique, or contain different CV. */
5369 SV * const tmp = newRV(MUTABLE_SV(cv));
5370 sv_setsv(dbsv, tmp);
5374 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5375 sv_catpvs(dbsv, "::");
5377 dbsv, GvNAME(gv), GvNAMELEN(gv),
5378 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
5383 const int type = SvTYPE(dbsv);
5384 if (type < SVt_PVIV && type != SVt_IV)
5385 sv_upgrade(dbsv, SVt_PVIV);
5386 (void)SvIOK_on(dbsv);
5387 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5390 TAINT_IF(save_taint);
5391 #ifdef NO_TAINT_SUPPORT
5392 PERL_UNUSED_VAR(save_taint);
5397 Perl_my_dirfd(DIR * dir) {
5399 /* Most dirfd implementations have problems when passed NULL. */
5404 #elif defined(HAS_DIR_DD_FD)
5407 Perl_croak_nocontext(PL_no_func, "dirfd");
5408 assert(0); /* NOT REACHED */
5414 Perl_get_re_arg(pTHX_ SV *sv) {
5420 sv = MUTABLE_SV(SvRV(sv));
5421 if (SvTYPE(sv) == SVt_REGEXP)
5422 return (REGEXP*) sv;
5429 * This code is derived from drand48() implementation from FreeBSD,
5430 * found in lib/libc/gen/_rand48.c.
5432 * The U64 implementation is original, based on the POSIX
5433 * specification for drand48().
5437 * Copyright (c) 1993 Martin Birgmeier
5438 * All rights reserved.
5440 * You may redistribute unmodified or modified versions of this source
5441 * code provided that the above copyright notice and this and the
5442 * following conditions are retained.
5444 * This software is provided ``as is'', and comes with no warranties
5445 * of any kind. I shall in no event be liable for anything that happens
5446 * to anyone/anything when using this software.
5449 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5451 #ifdef PERL_DRAND48_QUAD
5453 #define DRAND48_MULT U64_CONST(0x5deece66d)
5454 #define DRAND48_ADD 0xb
5455 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5459 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5460 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5461 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5462 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5463 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5464 #define FREEBSD_DRAND48_ADD (0x000b)
5466 const unsigned short _rand48_mult[3] = {
5467 FREEBSD_DRAND48_MULT_0,
5468 FREEBSD_DRAND48_MULT_1,
5469 FREEBSD_DRAND48_MULT_2
5471 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5476 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5478 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5480 #ifdef PERL_DRAND48_QUAD
5481 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64TYPE)seed << 16);
5483 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5484 random_state->seed[1] = (U16) seed;
5485 random_state->seed[2] = (U16) (seed >> 16);
5490 Perl_drand48_r(perl_drand48_t *random_state)
5492 PERL_ARGS_ASSERT_DRAND48_R;
5494 #ifdef PERL_DRAND48_QUAD
5495 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5498 return ldexp((double)*random_state, -48);
5504 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5505 + (U32) _rand48_add;
5506 temp[0] = (U16) accu; /* lower 16 bits */
5507 accu >>= sizeof(U16) * 8;
5508 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5509 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5510 temp[1] = (U16) accu; /* middle 16 bits */
5511 accu >>= sizeof(U16) * 8;
5512 accu += _rand48_mult[0] * random_state->seed[2]
5513 + _rand48_mult[1] * random_state->seed[1]
5514 + _rand48_mult[2] * random_state->seed[0];
5515 random_state->seed[0] = temp[0];
5516 random_state->seed[1] = temp[1];
5517 random_state->seed[2] = (U16) accu;
5519 return ldexp((double) random_state->seed[0], -48) +
5520 ldexp((double) random_state->seed[1], -32) +
5521 ldexp((double) random_state->seed[2], -16);
5526 #ifdef USE_C_BACKTRACE
5528 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5533 /* abfd is the BFD handle. */
5535 /* bfd_syms is the BFD symbol table. */
5537 /* bfd_text is handle to the the ".text" section of the object file. */
5539 /* Since opening the executable and scanning its symbols is quite
5540 * heavy operation, we remember the filename we used the last time,
5541 * and do the opening and scanning only if the filename changes.
5542 * This removes most (but not all) open+scan cycles. */
5543 const char* fname_prev;
5546 /* Given a dl_info, update the BFD context if necessary. */
5547 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5549 /* BFD open and scan only if the filename changed. */
5550 if (ctx->fname_prev == NULL ||
5551 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5552 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5554 if (bfd_check_format(ctx->abfd, bfd_object)) {
5555 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5556 if (symbol_size > 0) {
5557 Safefree(ctx->bfd_syms);
5558 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5560 bfd_get_section_by_name(ctx->abfd, ".text");
5568 ctx->fname_prev = dl_info->dli_fname;
5572 /* Given a raw frame, try to symbolize it and store
5573 * symbol information (source file, line number) away. */
5574 static void bfd_symbolize(bfd_context* ctx,
5577 STRLEN* symbol_name_size,
5579 STRLEN* source_name_size,
5580 STRLEN* source_line)
5582 *symbol_name = NULL;
5583 *symbol_name_size = 0;
5585 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5587 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5590 unsigned int line = 0;
5591 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5592 ctx->bfd_syms, offset,
5593 &file, &func, &line) &&
5594 file && func && line > 0) {
5595 /* Size and copy the source file, use only
5596 * the basename of the source file.
5598 * NOTE: the basenames are fine for the
5599 * Perl source files, but may not always
5600 * be the best idea for XS files. */
5601 const char *p, *b = NULL;
5602 /* Look for the last slash. */
5603 for (p = file; *p; p++) {
5607 if (b == NULL || *b == 0) {
5610 *source_name_size = p - b + 1;
5611 Newx(*source_name, *source_name_size + 1, char);
5612 Copy(b, *source_name, *source_name_size + 1, char);
5614 *symbol_name_size = strlen(func);
5615 Newx(*symbol_name, *symbol_name_size + 1, char);
5616 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5618 *source_line = line;
5624 #endif /* #ifdef USE_BFD */
5628 /* OS X has no public API for for 'symbolicating' (Apple official term)
5629 * stack addresses to {function_name, source_file, line_number}.
5630 * Good news: there is command line utility atos(1) which does that.
5631 * Bad news 1: it's a command line utility.
5632 * Bad news 2: one needs to have the Developer Tools installed.
5633 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5635 * To recap: we need to open a pipe for reading for a utility which
5636 * might not exist, or exists in different locations, and then parse
5637 * the output. And since this is all for a low-level API, we cannot
5638 * use high-level stuff. Thanks, Apple. */
5641 /* tool is set to the absolute pathname of the tool to use:
5644 /* format is set to a printf format string used for building
5645 * the external command to run. */
5647 /* unavail is set if e.g. xcrun cannot be found, or something
5648 * else happens that makes getting the backtrace dubious. Note,
5649 * however, that the context isn't persistent, the next call to
5650 * get_c_backtrace() will start from scratch. */
5652 /* fname is the current object file name. */
5654 /* object_base_addr is the base address of the shared object. */
5655 void* object_base_addr;
5658 /* Given |dl_info|, updates the context. If the context has been
5659 * marked unavailable, return immediately. If not but the tool has
5660 * not been set, set it to either "xcrun atos" or "atos" (also set the
5661 * format to use for creating commands for piping), or if neither is
5662 * unavailable (one needs the Developer Tools installed), mark the context
5663 * an unavailable. Finally, update the filename (object name),
5664 * and its base address. */
5666 static void atos_update(atos_context* ctx,
5671 if (ctx->tool == NULL) {
5672 const char* tools[] = {
5676 const char* formats[] = {
5677 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5678 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5682 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5683 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5684 ctx->tool = tools[i];
5685 ctx->format = formats[i];
5689 if (ctx->tool == NULL) {
5690 ctx->unavail = TRUE;
5694 if (ctx->fname == NULL ||
5695 strNE(dl_info->dli_fname, ctx->fname)) {
5696 ctx->fname = dl_info->dli_fname;
5697 ctx->object_base_addr = dl_info->dli_fbase;
5701 /* Given an output buffer end |p| and its |start|, matches
5702 * for the atos output, extracting the source code location
5703 * and returning non-NULL if possible, returning NULL otherwise. */
5704 static const char* atos_parse(const char* p,
5706 STRLEN* source_name_size,
5707 STRLEN* source_line) {
5708 /* atos() output is something like:
5709 * perl_parse (in miniperl) (perl.c:2314)\n\n".
5710 * We cannot use Perl regular expressions, because we need to
5711 * stay low-level. Therefore here we have a rolled-out version
5712 * of a state machine which matches _backwards_from_the_end_ and
5713 * if there's a success, returns the starts of the filename,
5714 * also setting the filename size and the source line number.
5715 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
5716 const char* source_number_start;
5717 const char* source_name_end;
5718 const char* source_line_end;
5719 const char* close_paren;
5720 /* Skip trailing whitespace. */
5721 while (p > start && isspace(*p)) p--;
5722 /* Now we should be at the close paren. */
5723 if (p == start || *p != ')')
5727 /* Now we should be in the line number. */
5728 if (p == start || !isdigit(*p))
5730 /* Skip over the digits. */
5731 while (p > start && isdigit(*p))
5733 /* Now we should be at the colon. */
5734 if (p == start || *p != ':')
5736 source_number_start = p + 1;
5737 source_name_end = p; /* Just beyond the end. */
5739 /* Look for the open paren. */
5740 while (p > start && *p != '(')
5745 *source_name_size = source_name_end - p;
5746 *source_line = grok_atou(source_number_start, &source_line_end);
5747 if (source_line_end != close_paren)
5752 /* Given a raw frame, read a pipe from the symbolicator (that's the
5753 * technical term) atos, reads the result, and parses the source code
5754 * location. We must stay low-level, so we use snprintf(), pipe(),
5755 * and fread(), and then also parse the output ourselves. */
5756 static void atos_symbolize(atos_context* ctx,
5759 STRLEN* source_name_size,
5760 STRLEN* source_line)
5768 /* Simple security measure: if there's any funny business with
5769 * the object name (used as "-o '%s'" ), leave since at least
5770 * partially the user controls it. */
5771 for (p = ctx->fname; *p; p++) {
5772 if (*p == '\'' || iscntrl(*p)) {
5773 ctx->unavail = TRUE;
5777 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
5778 ctx->fname, ctx->object_base_addr, raw_frame);
5779 if (cnt < sizeof(cmd)) {
5780 /* Undo nostdio.h #defines that disable stdio.
5781 * This is somewhat naughty, but is used elsewhere
5782 * in the core, and affects only OS X. */
5787 FILE* fp = popen(cmd, "r");
5788 /* At the moment we open a new pipe for each stack frame.
5789 * This is naturally somewhat slow, but hopefully generating
5790 * stack traces is never going to in a performance critical path.
5792 * We could play tricks with atos by batching the stack
5793 * addresses to be resolved: atos can either take multiple
5794 * addresses from the command line, or read addresses from
5795 * a file (though the mess of creating temporary files would
5796 * probably negate much of any possible speedup).
5798 * Normally there are only two objects present in the backtrace:
5799 * perl itself, and the libdyld.dylib. (Note that the object
5800 * filenames contain the full pathname, so perl may not always
5801 * be in the same place.) Whenever the object in the
5802 * backtrace changes, the base address also changes.
5804 * The problem with batching the addresses, though, would be
5805 * matching the results with the addresses: the parsing of
5806 * the results is already painful enough with a single address. */
5809 UV cnt = fread(out, 1, sizeof(out), fp);
5810 if (cnt < sizeof(out)) {
5811 const char* p = atos_parse(out + cnt, out,
5816 *source_name_size + 1, char);
5817 Copy(p, *source_name,
5818 *source_name_size + 1, char);
5826 #endif /* #ifdef PERL_DARWIN */
5829 =for apidoc get_c_backtrace
5831 Collects the backtrace (aka "stacktrace") into a single linear
5832 malloced buffer, which the caller B<must> Perl_free_c_backtrace().
5834 Scans the frames back by depth + skip, then drops the skip innermost,
5835 returning at most depth frames.
5841 Perl_get_c_backtrace(pTHX_ int depth, int skip)
5843 /* Note that here we must stay as low-level as possible: Newx(),
5844 * Copy(), Safefree(); since we may be called from anywhere,
5845 * so we should avoid higher level constructs like SVs or AVs.
5847 * Since we are using safesysmalloc() via Newx(), don't try
5848 * getting backtrace() there, unless you like deep recursion. */
5850 /* Currently only implemented with backtrace() and dladdr(),
5851 * for other platforms NULL is returned. */
5853 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
5854 /* backtrace() is available via <execinfo.h> in glibc and in most
5855 * modern BSDs; dladdr() is available via <dlfcn.h>. */
5857 /* We try fetching this many frames total, but then discard
5858 * the |skip| first ones. For the remaining ones we will try
5859 * retrieving more information with dladdr(). */
5860 int try_depth = skip + depth;
5862 /* The addresses (program counters) returned by backtrace(). */
5865 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
5868 /* Sizes _including_ the terminating \0 of the object name
5869 * and symbol name strings. */
5870 STRLEN* object_name_sizes;
5871 STRLEN* symbol_name_sizes;
5874 /* The symbol names comes either from dli_sname,
5875 * or if using BFD, they can come from BFD. */
5876 char** symbol_names;
5879 /* The source code location information. Dug out with e.g. BFD. */
5880 char** source_names;
5881 STRLEN* source_name_sizes;
5882 STRLEN* source_lines;
5884 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
5885 int got_depth; /* How many frames were returned from backtrace(). */
5886 UV frame_count = 0; /* How many frames we return. */
5887 UV total_bytes = 0; /* The size of the whole returned backtrace. */
5890 bfd_context bfd_ctx;
5893 atos_context atos_ctx;
5896 /* Here are probably possibilities for optimizing. We could for
5897 * example have a struct that contains most of these and then
5898 * allocate |try_depth| of them, saving a bunch of malloc calls.
5899 * Note, however, that |frames| could not be part of that struct
5900 * because backtrace() will want an array of just them. Also be
5901 * careful about the name strings. */
5902 Newx(raw_frames, try_depth, void*);
5903 Newx(dl_infos, try_depth, Dl_info);
5904 Newx(object_name_sizes, try_depth, STRLEN);
5905 Newx(symbol_name_sizes, try_depth, STRLEN);
5906 Newx(source_names, try_depth, char*);
5907 Newx(source_name_sizes, try_depth, STRLEN);
5908 Newx(source_lines, try_depth, STRLEN);
5910 Newx(symbol_names, try_depth, char*);
5913 /* Get the raw frames. */
5914 got_depth = (int)backtrace(raw_frames, try_depth);
5916 /* We use dladdr() instead of backtrace_symbols() because we want
5917 * the full details instead of opaque strings. This is useful for
5918 * two reasons: () the details are needed for further symbolic
5919 * digging, for example in OS X (2) by having the details we fully
5920 * control the output, which in turn is useful when more platforms
5921 * are added: we can keep out output "portable". */
5923 /* We want a single linear allocation, which can then be freed
5924 * with a single swoop. We will do the usual trick of first
5925 * walking over the structure and seeing how much we need to
5926 * allocate, then allocating, and then walking over the structure
5927 * the second time and populating it. */
5929 /* First we must compute the total size of the buffer. */
5930 total_bytes = sizeof(Perl_c_backtrace_header);
5931 if (got_depth > skip) {
5934 bfd_init(); /* Is this safe to call multiple times? */
5935 Zero(&bfd_ctx, 1, bfd_context);
5938 Zero(&atos_ctx, 1, atos_context);
5940 for (i = skip; i < try_depth; i++) {
5941 Dl_info* dl_info = &dl_infos[i];
5943 total_bytes += sizeof(Perl_c_backtrace_frame);
5945 source_names[i] = NULL;
5946 source_name_sizes[i] = 0;
5947 source_lines[i] = 0;
5949 /* Yes, zero from dladdr() is failure. */
5950 if (dladdr(raw_frames[i], dl_info)) {
5951 object_name_sizes[i] =
5952 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
5953 symbol_name_sizes[i] =
5954 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
5956 bfd_update(&bfd_ctx, dl_info);
5957 bfd_symbolize(&bfd_ctx, raw_frames[i],
5959 &symbol_name_sizes[i],
5961 &source_name_sizes[i],
5965 atos_update(&atos_ctx, dl_info);
5966 atos_symbolize(&atos_ctx,
5969 &source_name_sizes[i],
5973 /* Plus ones for the terminating \0. */
5974 total_bytes += object_name_sizes[i] + 1;
5975 total_bytes += symbol_name_sizes[i] + 1;
5976 total_bytes += source_name_sizes[i] + 1;
5984 Safefree(bfd_ctx.bfd_syms);
5988 /* Now we can allocate and populate the result buffer. */
5989 Newxc(bt, total_bytes, char, Perl_c_backtrace);
5990 Zero(bt, total_bytes, char);
5991 bt->header.frame_count = frame_count;
5992 bt->header.total_bytes = total_bytes;
5993 if (frame_count > 0) {
5994 Perl_c_backtrace_frame* frame = bt->frame_info;
5995 char* name_base = (char *)(frame + frame_count);
5996 char* name_curr = name_base; /* Outputting the name strings here. */
5998 for (i = skip; i < skip + frame_count; i++) {
5999 Dl_info* dl_info = &dl_infos[i];
6001 frame->addr = raw_frames[i];
6002 frame->object_base_addr = dl_info->dli_fbase;
6003 frame->symbol_addr = dl_info->dli_saddr;
6005 /* Copies a string, including the \0, and advances the name_curr.
6006 * Also copies the start and the size to the frame. */
6007 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6009 Copy(src, name_curr, size, char); \
6010 frame->doffset = name_curr - (char*)bt; \
6011 frame->dsize = size; \
6012 name_curr += size; \
6015 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6017 object_name_size, object_name_sizes[i]);
6020 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6022 symbol_name_size, symbol_name_sizes[i]);
6023 Safefree(symbol_names[i]);
6025 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6027 symbol_name_size, symbol_name_sizes[i]);
6030 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6032 source_name_size, source_name_sizes[i]);
6033 Safefree(source_names[i]);
6035 #undef PERL_C_BACKTRACE_STRCPY
6037 frame->source_line_number = source_lines[i];
6041 assert(total_bytes ==
6042 (UV)(sizeof(Perl_c_backtrace_header) +
6043 frame_count * sizeof(Perl_c_backtrace_frame) +
6044 name_curr - name_base));
6047 Safefree(symbol_names);
6049 Safefree(source_lines);
6050 Safefree(source_name_sizes);
6051 Safefree(source_names);
6052 Safefree(symbol_name_sizes);
6053 Safefree(object_name_sizes);
6054 /* Assuming the strings returned by dladdr() are pointers
6055 * to read-only static memory (the object file), so that
6056 * they do not need freeing (and cannot be). */
6058 Safefree(raw_frames);
6061 PERL_UNUSED_ARGV(depth);
6062 PERL_UNUSED_ARGV(skip);
6068 =for apidoc free_c_backtrace
6070 Deallocates a backtrace received from get_c_bracktrace.
6076 =for apidoc get_c_backtrace_dump
6078 Returns a SV a dump of |depth| frames of the call stack, skipping
6079 the |skip| innermost ones. depth of 20 is usually enough.
6081 The appended output looks like:
6084 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6085 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6088 The fields are tab-separated. The first column is the depth (zero
6089 being the innermost non-skipped frame). In the hex:offset, the hex is
6090 where the program counter was in S_parse_body, and the :offset (might
6091 be missing) tells how much inside the S_parse_body the program counter was.
6093 The util.c:1716 is the source code file and line number.
6095 The /usr/bin/perl is obvious (hopefully).
6097 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6098 if the platform doesn't support retrieving the information;
6099 if the binary is missing the debug information;
6100 if the optimizer has transformed the code by for example inlining.
6106 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6108 Perl_c_backtrace* bt;
6110 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6112 Perl_c_backtrace_frame* frame;
6113 SV* dsv = newSVpvs("");
6115 for (i = 0, frame = bt->frame_info;
6116 i < bt->header.frame_count; i++, frame++) {
6117 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6118 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6119 /* Symbol (function) names might disappear without debug info.
6121 * The source code location might disappear in case of the
6122 * optimizer inlining or otherwise rearranging the code. */
6123 if (frame->symbol_addr) {
6124 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6126 ((char*)frame->addr - (char*)frame->symbol_addr));
6128 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6129 frame->symbol_name_size &&
6130 frame->symbol_name_offset ?
6131 (char*)bt + frame->symbol_name_offset : "-");
6132 if (frame->source_name_size &&
6133 frame->source_name_offset &&
6134 frame->source_line_number) {
6135 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%"UVuf,
6136 (char*)bt + frame->source_name_offset,
6137 (UV)frame->source_line_number);
6139 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6141 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6142 frame->object_name_size &&
6143 frame->object_name_offset ?
6144 (char*)bt + frame->object_name_offset : "-");
6145 /* The frame->object_base_addr is not output,
6146 * but it is used for symbolizing/symbolicating. */
6147 sv_catpvs(dsv, "\n");
6150 Perl_free_c_backtrace(aTHX_ bt);
6159 =for apidoc dump_c_backtrace
6161 Dumps the C backtrace to the given fp.
6163 Returns true if a backtrace could be retrieved, false if not.
6169 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6173 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6175 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6178 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6184 #endif /* #ifdef USE_C_BACKTRACE */
6188 * c-indentation-style: bsd
6190 * indent-tabs-mode: nil
6193 * ex: set ts=8 sts=4 sw=4 et: