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
133 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
135 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
138 if ((SSize_t)size < 0)
139 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
141 if (!size) size = 1; /* malloc(0) is NASTY on our system */
142 #ifdef PERL_DEBUG_READONLY_COW
143 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
144 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
145 perror("mmap failed");
149 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
151 PERL_ALLOC_CHECK(ptr);
154 struct perl_memory_debug_header *const header
155 = (struct perl_memory_debug_header *)ptr;
159 PoisonNew(((char *)ptr), size, char);
162 #ifdef PERL_TRACK_MEMPOOL
163 header->interpreter = aTHX;
164 /* Link us into the list. */
165 header->prev = &PL_memory_debug_header;
166 header->next = PL_memory_debug_header.next;
167 PL_memory_debug_header.next = header;
168 maybe_protect_rw(header->next);
169 header->next->prev = header;
170 maybe_protect_ro(header->next);
171 # ifdef PERL_DEBUG_READONLY_COW
172 header->readonly = 0;
178 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
179 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
187 #ifndef ALWAYS_NEED_THX
199 /* paranoid version of system's realloc() */
202 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
204 #ifdef ALWAYS_NEED_THX
208 #ifdef PERL_DEBUG_READONLY_COW
209 const MEM_SIZE oldsize = where
210 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
213 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
214 Malloc_t PerlMem_realloc();
215 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
222 ptr = safesysmalloc(size);
226 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
227 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
229 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
231 struct perl_memory_debug_header *const header
232 = (struct perl_memory_debug_header *)where;
234 # ifdef PERL_TRACK_MEMPOOL
235 if (header->interpreter != aTHX) {
236 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
237 header->interpreter, aTHX);
239 assert(header->next->prev == header);
240 assert(header->prev->next == header);
242 if (header->size > size) {
243 const MEM_SIZE freed_up = header->size - size;
244 char *start_of_freed = ((char *)where) + size;
245 PoisonFree(start_of_freed, freed_up, char);
255 if ((SSize_t)size < 0)
256 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
258 #ifdef PERL_DEBUG_READONLY_COW
259 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
260 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
261 perror("mmap failed");
264 Copy(where,ptr,oldsize < size ? oldsize : size,char);
265 if (munmap(where, oldsize)) {
266 perror("munmap failed");
270 ptr = (Malloc_t)PerlMem_realloc(where,size);
272 PERL_ALLOC_CHECK(ptr);
274 /* MUST do this fixup first, before doing ANYTHING else, as anything else
275 might allocate memory/free/move memory, and until we do the fixup, it
276 may well be chasing (and writing to) free memory. */
278 #ifdef PERL_TRACK_MEMPOOL
279 struct perl_memory_debug_header *const header
280 = (struct perl_memory_debug_header *)ptr;
283 if (header->size < size) {
284 const MEM_SIZE fresh = size - header->size;
285 char *start_of_fresh = ((char *)ptr) + size;
286 PoisonNew(start_of_fresh, fresh, char);
290 maybe_protect_rw(header->next);
291 header->next->prev = header;
292 maybe_protect_ro(header->next);
293 maybe_protect_rw(header->prev);
294 header->prev->next = header;
295 maybe_protect_ro(header->prev);
297 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
300 /* In particular, must do that fixup above before logging anything via
301 *printf(), as it can reallocate memory, which can cause SEGVs. */
303 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
304 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
311 #ifndef ALWAYS_NEED_THX
324 /* safe version of system's free() */
327 Perl_safesysfree(Malloc_t where)
329 #ifdef ALWAYS_NEED_THX
332 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
335 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
337 struct perl_memory_debug_header *const header
338 = (struct perl_memory_debug_header *)where_intrn;
341 const MEM_SIZE size = header->size;
343 # ifdef PERL_TRACK_MEMPOOL
344 if (header->interpreter != aTHX) {
345 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
346 header->interpreter, aTHX);
349 Perl_croak_nocontext("panic: duplicate free");
352 Perl_croak_nocontext("panic: bad free, header->next==NULL");
353 if (header->next->prev != header || header->prev->next != header) {
354 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
355 "header=%p, ->prev->next=%p",
356 header->next->prev, header,
359 /* Unlink us from the chain. */
360 maybe_protect_rw(header->next);
361 header->next->prev = header->prev;
362 maybe_protect_ro(header->next);
363 maybe_protect_rw(header->prev);
364 header->prev->next = header->next;
365 maybe_protect_ro(header->prev);
366 maybe_protect_rw(header);
368 PoisonNew(where_intrn, size, char);
370 /* Trigger the duplicate free warning. */
373 # ifdef PERL_DEBUG_READONLY_COW
374 if (munmap(where_intrn, size)) {
375 perror("munmap failed");
381 Malloc_t where_intrn = where;
383 #ifndef PERL_DEBUG_READONLY_COW
384 PerlMem_free(where_intrn);
389 /* safe version of system's calloc() */
392 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
394 #ifdef ALWAYS_NEED_THX
398 #if defined(USE_MDH) || defined(DEBUGGING)
399 MEM_SIZE total_size = 0;
402 /* Even though calloc() for zero bytes is strange, be robust. */
403 if (size && (count <= MEM_SIZE_MAX / size)) {
404 #if defined(USE_MDH) || defined(DEBUGGING)
405 total_size = size * count;
411 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
412 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
417 if ((SSize_t)size < 0 || (SSize_t)count < 0)
418 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
419 (UV)size, (UV)count);
421 #ifdef PERL_DEBUG_READONLY_COW
422 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
423 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
424 perror("mmap failed");
427 #elif defined(PERL_TRACK_MEMPOOL)
428 /* Have to use malloc() because we've added some space for our tracking
430 /* malloc(0) is non-portable. */
431 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
433 /* Use calloc() because it might save a memset() if the memory is fresh
434 and clean from the OS. */
436 ptr = (Malloc_t)PerlMem_calloc(count, size);
437 else /* calloc(0) is non-portable. */
438 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
440 PERL_ALLOC_CHECK(ptr);
441 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));
445 struct perl_memory_debug_header *const header
446 = (struct perl_memory_debug_header *)ptr;
448 # ifndef PERL_DEBUG_READONLY_COW
449 memset((void*)ptr, 0, total_size);
451 # ifdef PERL_TRACK_MEMPOOL
452 header->interpreter = aTHX;
453 /* Link us into the list. */
454 header->prev = &PL_memory_debug_header;
455 header->next = PL_memory_debug_header.next;
456 PL_memory_debug_header.next = header;
457 maybe_protect_rw(header->next);
458 header->next->prev = header;
459 maybe_protect_ro(header->next);
460 # ifdef PERL_DEBUG_READONLY_COW
461 header->readonly = 0;
465 header->size = total_size;
467 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
473 #ifndef ALWAYS_NEED_THX
482 /* These must be defined when not using Perl's malloc for binary
487 Malloc_t Perl_malloc (MEM_SIZE nbytes)
489 #ifdef PERL_IMPLICIT_SYS
492 return (Malloc_t)PerlMem_malloc(nbytes);
495 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
497 #ifdef PERL_IMPLICIT_SYS
500 return (Malloc_t)PerlMem_calloc(elements, size);
503 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
505 #ifdef PERL_IMPLICIT_SYS
508 return (Malloc_t)PerlMem_realloc(where, nbytes);
511 Free_t Perl_mfree (Malloc_t where)
513 #ifdef PERL_IMPLICIT_SYS
521 /* copy a string up to some (non-backslashed) delimiter, if any */
524 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
528 PERL_ARGS_ASSERT_DELIMCPY;
530 for (tolen = 0; from < fromend; from++, tolen++) {
532 if (from[1] != delim) {
539 else if (*from == delim)
550 /* return ptr to little string in big string, NULL if not found */
551 /* This routine was donated by Corey Satten. */
554 Perl_instr(const char *big, const char *little)
557 PERL_ARGS_ASSERT_INSTR;
559 return strstr((char*)big, (char*)little);
562 /* same as instr but allow embedded nulls. The end pointers point to 1 beyond
563 * the final character desired to be checked */
566 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
568 PERL_ARGS_ASSERT_NINSTR;
572 const char first = *little;
574 bigend -= lend - little++;
576 while (big <= bigend) {
577 if (*big++ == first) {
578 for (x=big,s=little; s < lend; x++,s++) {
582 return (char*)(big-1);
589 /* reverse of the above--find last substring */
592 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
595 const I32 first = *little;
596 const char * const littleend = lend;
598 PERL_ARGS_ASSERT_RNINSTR;
600 if (little >= littleend)
601 return (char*)bigend;
603 big = bigend - (littleend - little++);
604 while (big >= bigbeg) {
608 for (x=big+2,s=little; s < littleend; /**/ ) {
617 return (char*)(big+1);
622 /* As a space optimization, we do not compile tables for strings of length
623 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
624 special-cased in fbm_instr().
626 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
629 =head1 Miscellaneous Functions
631 =for apidoc fbm_compile
633 Analyses the string in order to make fast searches on it using fbm_instr()
634 -- the Boyer-Moore algorithm.
640 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
647 PERL_DEB( STRLEN rarest = 0 );
649 PERL_ARGS_ASSERT_FBM_COMPILE;
651 if (isGV_with_GP(sv) || SvROK(sv))
657 if (flags & FBMcf_TAIL) {
658 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
659 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
660 if (mg && mg->mg_len >= 0)
663 if (!SvPOK(sv) || SvNIOKp(sv))
664 s = (U8*)SvPV_force_mutable(sv, len);
665 else s = (U8 *)SvPV_mutable(sv, len);
666 if (len == 0) /* TAIL might be on a zero-length string. */
668 SvUPGRADE(sv, SVt_PVMG);
673 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
674 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
675 to call SvVALID_off() if the scalar was assigned to.
677 The comment itself (and "deeper magic" below) date back to
678 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
680 where the magic (presumably) was that the scalar had a BM table hidden
683 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
684 the table instead of the previous (somewhat hacky) approach of co-opting
685 the string buffer and storing it after the string. */
687 assert(!mg_find(sv, PERL_MAGIC_bm));
688 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
692 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
694 const U8 mlen = (len>255) ? 255 : (U8)len;
695 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
698 Newx(table, 256, U8);
699 memset((void*)table, mlen, 256);
700 mg->mg_ptr = (char *)table;
703 s += len - 1; /* last char */
706 if (table[*s] == mlen)
712 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
713 for (i = 0; i < len; i++) {
714 if (PL_freq[s[i]] < frequency) {
715 PERL_DEB( rarest = i );
716 frequency = PL_freq[s[i]];
719 BmUSEFUL(sv) = 100; /* Initial value */
720 if (flags & FBMcf_TAIL)
722 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
723 s[rarest], (UV)rarest));
726 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
727 /* If SvTAIL is actually due to \Z or \z, this gives false positives
731 =for apidoc fbm_instr
733 Returns the location of the SV in the string delimited by C<big> and
734 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
735 does not have to be fbm_compiled, but the search will not be as fast
742 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
746 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
747 STRLEN littlelen = l;
748 const I32 multiline = flags & FBMrf_MULTILINE;
750 PERL_ARGS_ASSERT_FBM_INSTR;
752 if ((STRLEN)(bigend - big) < littlelen) {
753 if ( SvTAIL(littlestr)
754 && ((STRLEN)(bigend - big) == littlelen - 1)
756 || (*big == *little &&
757 memEQ((char *)big, (char *)little, littlelen - 1))))
762 switch (littlelen) { /* Special cases for 0, 1 and 2 */
764 return (char*)big; /* Cannot be SvTAIL! */
766 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
767 /* Know that bigend != big. */
768 if (bigend[-1] == '\n')
769 return (char *)(bigend - 1);
770 return (char *) bigend;
778 if (SvTAIL(littlestr))
779 return (char *) bigend;
782 if (SvTAIL(littlestr) && !multiline) {
783 if (bigend[-1] == '\n' && bigend[-2] == *little)
784 return (char*)bigend - 2;
785 if (bigend[-1] == *little)
786 return (char*)bigend - 1;
790 /* This should be better than FBM if c1 == c2, and almost
791 as good otherwise: maybe better since we do less indirection.
792 And we save a lot of memory by caching no table. */
793 const unsigned char c1 = little[0];
794 const unsigned char c2 = little[1];
799 while (s <= bigend) {
809 goto check_1char_anchor;
820 goto check_1char_anchor;
823 while (s <= bigend) {
828 goto check_1char_anchor;
837 check_1char_anchor: /* One char and anchor! */
838 if (SvTAIL(littlestr) && (*bigend == *little))
839 return (char *)bigend; /* bigend is already decremented. */
842 break; /* Only lengths 0 1 and 2 have special-case code. */
845 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
846 s = bigend - littlelen;
847 if (s >= big && bigend[-1] == '\n' && *s == *little
848 /* Automatically of length > 2 */
849 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
851 return (char*)s; /* how sweet it is */
854 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
856 return (char*)s + 1; /* how sweet it is */
860 if (!SvVALID(littlestr)) {
861 char * const b = ninstr((char*)big,(char*)bigend,
862 (char*)little, (char*)little + littlelen);
864 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
865 /* Chop \n from littlestr: */
866 s = bigend - littlelen + 1;
868 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
878 if (littlelen > (STRLEN)(bigend - big))
882 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
883 const unsigned char *oldlittle;
887 --littlelen; /* Last char found by table lookup */
890 little += littlelen; /* last char */
893 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
897 if ((tmp = table[*s])) {
898 if ((s += tmp) < bigend)
902 else { /* less expensive than calling strncmp() */
903 unsigned char * const olds = s;
908 if (*--s == *--little)
910 s = olds + 1; /* here we pay the price for failure */
912 if (s < bigend) /* fake up continue to outer loop */
922 && memEQ((char *)(bigend - littlelen),
923 (char *)(oldlittle - littlelen), littlelen) )
924 return (char*)bigend - littlelen;
932 Returns true if the leading len bytes of the strings s1 and s2 are the same
933 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
934 match themselves and their opposite case counterparts. Non-cased and non-ASCII
935 range bytes match only themselves.
942 Perl_foldEQ(const char *s1, const char *s2, I32 len)
944 const U8 *a = (const U8 *)s1;
945 const U8 *b = (const U8 *)s2;
947 PERL_ARGS_ASSERT_FOLDEQ;
952 if (*a != *b && *a != PL_fold[*b])
959 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
961 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
962 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
963 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
964 * does it check that the strings each have at least 'len' characters */
966 const U8 *a = (const U8 *)s1;
967 const U8 *b = (const U8 *)s2;
969 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
974 if (*a != *b && *a != PL_fold_latin1[*b]) {
983 =for apidoc foldEQ_locale
985 Returns true if the leading len bytes of the strings s1 and s2 are the same
986 case-insensitively in the current locale; false otherwise.
992 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
995 const U8 *a = (const U8 *)s1;
996 const U8 *b = (const U8 *)s2;
998 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1003 if (*a != *b && *a != PL_fold_locale[*b])
1010 /* copy a string to a safe spot */
1013 =head1 Memory Management
1017 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1018 string which is a duplicate of C<pv>. The size of the string is
1019 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1020 characters and must have a trailing C<NUL>. The memory allocated for the new
1021 string can be freed with the C<Safefree()> function.
1023 On some platforms, Windows for example, all allocated memory owned by a thread
1024 is deallocated when that thread ends. So if you need that not to happen, you
1025 need to use the shared memory functions, such as C<L</savesharedpv>>.
1031 Perl_savepv(pTHX_ const char *pv)
1033 PERL_UNUSED_CONTEXT;
1038 const STRLEN pvlen = strlen(pv)+1;
1039 Newx(newaddr, pvlen, char);
1040 return (char*)memcpy(newaddr, pv, pvlen);
1044 /* same thing but with a known length */
1049 Perl's version of what C<strndup()> would be if it existed. Returns a
1050 pointer to a newly allocated string which is a duplicate of the first
1051 C<len> bytes from C<pv>, plus a trailing
1052 C<NUL> byte. The memory allocated for
1053 the new string can be freed with the C<Safefree()> function.
1055 On some platforms, Windows for example, all allocated memory owned by a thread
1056 is deallocated when that thread ends. So if you need that not to happen, you
1057 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1063 Perl_savepvn(pTHX_ const char *pv, I32 len)
1066 PERL_UNUSED_CONTEXT;
1070 Newx(newaddr,len+1,char);
1071 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1073 /* might not be null terminated */
1074 newaddr[len] = '\0';
1075 return (char *) CopyD(pv,newaddr,len,char);
1078 return (char *) ZeroD(newaddr,len+1,char);
1083 =for apidoc savesharedpv
1085 A version of C<savepv()> which allocates the duplicate string in memory
1086 which is shared between threads.
1091 Perl_savesharedpv(pTHX_ const char *pv)
1096 PERL_UNUSED_CONTEXT;
1101 pvlen = strlen(pv)+1;
1102 newaddr = (char*)PerlMemShared_malloc(pvlen);
1106 return (char*)memcpy(newaddr, pv, pvlen);
1110 =for apidoc savesharedpvn
1112 A version of C<savepvn()> which allocates the duplicate string in memory
1113 which is shared between threads. (With the specific difference that a NULL
1114 pointer is not acceptable)
1119 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1121 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1123 PERL_UNUSED_CONTEXT;
1124 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1129 newaddr[len] = '\0';
1130 return (char*)memcpy(newaddr, pv, len);
1134 =for apidoc savesvpv
1136 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1137 the passed in SV using C<SvPV()>
1139 On some platforms, Windows for example, all allocated memory owned by a thread
1140 is deallocated when that thread ends. So if you need that not to happen, you
1141 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1147 Perl_savesvpv(pTHX_ SV *sv)
1150 const char * const pv = SvPV_const(sv, len);
1153 PERL_ARGS_ASSERT_SAVESVPV;
1156 Newx(newaddr,len,char);
1157 return (char *) CopyD(pv,newaddr,len,char);
1161 =for apidoc savesharedsvpv
1163 A version of C<savesharedpv()> which allocates the duplicate string in
1164 memory which is shared between threads.
1170 Perl_savesharedsvpv(pTHX_ SV *sv)
1173 const char * const pv = SvPV_const(sv, len);
1175 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1177 return savesharedpvn(pv, len);
1180 /* the SV for Perl_form() and mess() is not kept in an arena */
1188 if (PL_phase != PERL_PHASE_DESTRUCT)
1189 return newSVpvs_flags("", SVs_TEMP);
1194 /* Create as PVMG now, to avoid any upgrading later */
1196 Newxz(any, 1, XPVMG);
1197 SvFLAGS(sv) = SVt_PVMG;
1198 SvANY(sv) = (void*)any;
1200 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1205 #if defined(PERL_IMPLICIT_CONTEXT)
1207 Perl_form_nocontext(const char* pat, ...)
1212 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1213 va_start(args, pat);
1214 retval = vform(pat, &args);
1218 #endif /* PERL_IMPLICIT_CONTEXT */
1221 =head1 Miscellaneous Functions
1224 Takes a sprintf-style format pattern and conventional
1225 (non-SV) arguments and returns the formatted string.
1227 (char *) Perl_form(pTHX_ const char* pat, ...)
1229 can be used any place a string (char *) is required:
1231 char * s = Perl_form("%d.%d",major,minor);
1233 Uses a single private buffer so if you want to format several strings you
1234 must explicitly copy the earlier strings away (and free the copies when you
1241 Perl_form(pTHX_ const char* pat, ...)
1245 PERL_ARGS_ASSERT_FORM;
1246 va_start(args, pat);
1247 retval = vform(pat, &args);
1253 Perl_vform(pTHX_ const char *pat, va_list *args)
1255 SV * const sv = mess_alloc();
1256 PERL_ARGS_ASSERT_VFORM;
1257 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1262 =for apidoc Am|SV *|mess|const char *pat|...
1264 Take a sprintf-style format pattern and argument list. These are used to
1265 generate a string message. If the message does not end with a newline,
1266 then it will be extended with some indication of the current location
1267 in the code, as described for L</mess_sv>.
1269 Normally, the resulting message is returned in a new mortal SV.
1270 During global destruction a single SV may be shared between uses of
1276 #if defined(PERL_IMPLICIT_CONTEXT)
1278 Perl_mess_nocontext(const char *pat, ...)
1283 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1284 va_start(args, pat);
1285 retval = vmess(pat, &args);
1289 #endif /* PERL_IMPLICIT_CONTEXT */
1292 Perl_mess(pTHX_ const char *pat, ...)
1296 PERL_ARGS_ASSERT_MESS;
1297 va_start(args, pat);
1298 retval = vmess(pat, &args);
1304 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1307 /* Look for curop starting from o. cop is the last COP we've seen. */
1308 /* opnext means that curop is actually the ->op_next of the op we are
1311 PERL_ARGS_ASSERT_CLOSEST_COP;
1313 if (!o || !curop || (
1314 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1318 if (o->op_flags & OPf_KIDS) {
1320 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1323 /* If the OP_NEXTSTATE has been optimised away we can still use it
1324 * the get the file and line number. */
1326 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1327 cop = (const COP *)kid;
1329 /* Keep searching, and return when we've found something. */
1331 new_cop = closest_cop(cop, kid, curop, opnext);
1337 /* Nothing found. */
1343 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1345 Expands a message, intended for the user, to include an indication of
1346 the current location in the code, if the message does not already appear
1349 C<basemsg> is the initial message or object. If it is a reference, it
1350 will be used as-is and will be the result of this function. Otherwise it
1351 is used as a string, and if it already ends with a newline, it is taken
1352 to be complete, and the result of this function will be the same string.
1353 If the message does not end with a newline, then a segment such as C<at
1354 foo.pl line 37> will be appended, and possibly other clauses indicating
1355 the current state of execution. The resulting message will end with a
1358 Normally, the resulting message is returned in a new mortal SV.
1359 During global destruction a single SV may be shared between uses of this
1360 function. If C<consume> is true, then the function is permitted (but not
1361 required) to modify and return C<basemsg> instead of allocating a new SV.
1367 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1371 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1375 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1376 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1377 && grok_atoUV(ws, &wi, NULL)
1378 && wi <= PERL_INT_MAX
1380 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1385 PERL_ARGS_ASSERT_MESS_SV;
1387 if (SvROK(basemsg)) {
1393 sv_setsv(sv, basemsg);
1398 if (SvPOK(basemsg) && consume) {
1403 sv_copypv(sv, basemsg);
1406 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1408 * Try and find the file and line for PL_op. This will usually be
1409 * PL_curcop, but it might be a cop that has been optimised away. We
1410 * can try to find such a cop by searching through the optree starting
1411 * from the sibling of PL_curcop.
1415 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1420 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1421 OutCopFILE(cop), (IV)CopLINE(cop));
1422 /* Seems that GvIO() can be untrustworthy during global destruction. */
1423 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1424 && IoLINES(GvIOp(PL_last_in_gv)))
1427 const bool line_mode = (RsSIMPLE(PL_rs) &&
1428 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1429 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1430 SVfARG(PL_last_in_gv == PL_argvgv
1432 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1433 line_mode ? "line" : "chunk",
1434 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1436 if (PL_phase == PERL_PHASE_DESTRUCT)
1437 sv_catpvs(sv, " during global destruction");
1438 sv_catpvs(sv, ".\n");
1444 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1446 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1447 argument list. These are used to generate a string message. If the
1448 message does not end with a newline, then it will be extended with
1449 some indication of the current location in the code, as described for
1452 Normally, the resulting message is returned in a new mortal SV.
1453 During global destruction a single SV may be shared between uses of
1460 Perl_vmess(pTHX_ const char *pat, va_list *args)
1462 SV * const sv = mess_alloc();
1464 PERL_ARGS_ASSERT_VMESS;
1466 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1467 return mess_sv(sv, 1);
1471 Perl_write_to_stderr(pTHX_ SV* msv)
1476 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1478 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1479 && (io = GvIO(PL_stderrgv))
1480 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1481 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1482 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1484 PerlIO * const serr = Perl_error_log;
1486 do_print(msv, serr);
1487 (void)PerlIO_flush(serr);
1492 =head1 Warning and Dieing
1495 /* Common code used in dieing and warning */
1498 S_with_queued_errors(pTHX_ SV *ex)
1500 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1501 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1502 sv_catsv(PL_errors, ex);
1503 ex = sv_mortalcopy(PL_errors);
1504 SvCUR_set(PL_errors, 0);
1510 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1515 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1516 /* sv_2cv might call Perl_croak() or Perl_warner() */
1517 SV * const oldhook = *hook;
1525 cv = sv_2cv(oldhook, &stash, &gv, 0);
1527 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1537 exarg = newSVsv(ex);
1538 SvREADONLY_on(exarg);
1541 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1545 call_sv(MUTABLE_SV(cv), G_DISCARD);
1554 =for apidoc Am|OP *|die_sv|SV *baseex
1556 Behaves the same as L</croak_sv>, except for the return type.
1557 It should be used only where the C<OP *> return type is required.
1558 The function never actually returns.
1564 # pragma warning( push )
1565 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1566 __declspec(noreturn) has non-void return type */
1567 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1568 __declspec(noreturn) has a return statement */
1571 Perl_die_sv(pTHX_ SV *baseex)
1573 PERL_ARGS_ASSERT_DIE_SV;
1576 NORETURN_FUNCTION_END;
1579 # pragma warning( pop )
1583 =for apidoc Am|OP *|die|const char *pat|...
1585 Behaves the same as L</croak>, except for the return type.
1586 It should be used only where the C<OP *> return type is required.
1587 The function never actually returns.
1592 #if defined(PERL_IMPLICIT_CONTEXT)
1594 # pragma warning( push )
1595 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1596 __declspec(noreturn) has non-void return type */
1597 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1598 __declspec(noreturn) has a return statement */
1601 Perl_die_nocontext(const char* pat, ...)
1605 va_start(args, pat);
1607 NOT_REACHED; /* NOTREACHED */
1609 NORETURN_FUNCTION_END;
1612 # pragma warning( pop )
1614 #endif /* PERL_IMPLICIT_CONTEXT */
1617 # pragma warning( push )
1618 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1619 __declspec(noreturn) has non-void return type */
1620 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1621 __declspec(noreturn) has a return statement */
1624 Perl_die(pTHX_ const char* pat, ...)
1627 va_start(args, pat);
1629 NOT_REACHED; /* NOTREACHED */
1631 NORETURN_FUNCTION_END;
1634 # pragma warning( pop )
1638 =for apidoc Am|void|croak_sv|SV *baseex
1640 This is an XS interface to Perl's C<die> function.
1642 C<baseex> is the error message or object. If it is a reference, it
1643 will be used as-is. Otherwise it is used as a string, and if it does
1644 not end with a newline then it will be extended with some indication of
1645 the current location in the code, as described for L</mess_sv>.
1647 The error message or object will be used as an exception, by default
1648 returning control to the nearest enclosing C<eval>, but subject to
1649 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1650 function never returns normally.
1652 To die with a simple string message, the L</croak> function may be
1659 Perl_croak_sv(pTHX_ SV *baseex)
1661 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1662 PERL_ARGS_ASSERT_CROAK_SV;
1663 invoke_exception_hook(ex, FALSE);
1668 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1670 This is an XS interface to Perl's C<die> function.
1672 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1673 argument list. These are used to generate a string message. If the
1674 message does not end with a newline, then it will be extended with
1675 some indication of the current location in the code, as described for
1678 The error message will be used as an exception, by default
1679 returning control to the nearest enclosing C<eval>, but subject to
1680 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1681 function never returns normally.
1683 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1684 (C<$@>) will be used as an error message or object instead of building an
1685 error message from arguments. If you want to throw a non-string object,
1686 or build an error message in an SV yourself, it is preferable to use
1687 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1693 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1695 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1696 invoke_exception_hook(ex, FALSE);
1701 =for apidoc Am|void|croak|const char *pat|...
1703 This is an XS interface to Perl's C<die> function.
1705 Take a sprintf-style format pattern and argument list. These are used to
1706 generate a string message. If the message does not end with a newline,
1707 then it will be extended with some indication of the current location
1708 in the code, as described for L</mess_sv>.
1710 The error message will be used as an exception, by default
1711 returning control to the nearest enclosing C<eval>, but subject to
1712 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1713 function never returns normally.
1715 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1716 (C<$@>) will be used as an error message or object instead of building an
1717 error message from arguments. If you want to throw a non-string object,
1718 or build an error message in an SV yourself, it is preferable to use
1719 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1724 #if defined(PERL_IMPLICIT_CONTEXT)
1726 Perl_croak_nocontext(const char *pat, ...)
1730 va_start(args, pat);
1732 NOT_REACHED; /* NOTREACHED */
1735 #endif /* PERL_IMPLICIT_CONTEXT */
1738 Perl_croak(pTHX_ const char *pat, ...)
1741 va_start(args, pat);
1743 NOT_REACHED; /* NOTREACHED */
1748 =for apidoc Am|void|croak_no_modify
1750 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1751 terser object code than using C<Perl_croak>. Less code used on exception code
1752 paths reduces CPU cache pressure.
1758 Perl_croak_no_modify(void)
1760 Perl_croak_nocontext( "%s", PL_no_modify);
1763 /* does not return, used in util.c perlio.c and win32.c
1764 This is typically called when malloc returns NULL.
1767 Perl_croak_no_mem(void)
1771 int fd = PerlIO_fileno(Perl_error_log);
1773 SETERRNO(EBADF,RMS_IFI);
1775 /* Can't use PerlIO to write as it allocates memory */
1776 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1781 /* does not return, used only in POPSTACK */
1783 Perl_croak_popstack(void)
1786 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1791 =for apidoc Am|void|warn_sv|SV *baseex
1793 This is an XS interface to Perl's C<warn> function.
1795 C<baseex> is the error message or object. If it is a reference, it
1796 will be used as-is. Otherwise it is used as a string, and if it does
1797 not end with a newline then it will be extended with some indication of
1798 the current location in the code, as described for L</mess_sv>.
1800 The error message or object will by default be written to standard error,
1801 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1803 To warn with a simple string message, the L</warn> function may be
1810 Perl_warn_sv(pTHX_ SV *baseex)
1812 SV *ex = mess_sv(baseex, 0);
1813 PERL_ARGS_ASSERT_WARN_SV;
1814 if (!invoke_exception_hook(ex, TRUE))
1815 write_to_stderr(ex);
1819 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1821 This is an XS interface to Perl's C<warn> function.
1823 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1824 argument list. These are used to generate a string message. If the
1825 message does not end with a newline, then it will be extended with
1826 some indication of the current location in the code, as described for
1829 The error message or object will by default be written to standard error,
1830 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1832 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1838 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1840 SV *ex = vmess(pat, args);
1841 PERL_ARGS_ASSERT_VWARN;
1842 if (!invoke_exception_hook(ex, TRUE))
1843 write_to_stderr(ex);
1847 =for apidoc Am|void|warn|const char *pat|...
1849 This is an XS interface to Perl's C<warn> function.
1851 Take a sprintf-style format pattern and argument list. These are used to
1852 generate a string message. If the message does not end with a newline,
1853 then it will be extended with some indication of the current location
1854 in the code, as described for L</mess_sv>.
1856 The error message or object will by default be written to standard error,
1857 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1859 Unlike with L</croak>, C<pat> is not permitted to be null.
1864 #if defined(PERL_IMPLICIT_CONTEXT)
1866 Perl_warn_nocontext(const char *pat, ...)
1870 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1871 va_start(args, pat);
1875 #endif /* PERL_IMPLICIT_CONTEXT */
1878 Perl_warn(pTHX_ const char *pat, ...)
1881 PERL_ARGS_ASSERT_WARN;
1882 va_start(args, pat);
1887 #if defined(PERL_IMPLICIT_CONTEXT)
1889 Perl_warner_nocontext(U32 err, const char *pat, ...)
1893 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1894 va_start(args, pat);
1895 vwarner(err, pat, &args);
1898 #endif /* PERL_IMPLICIT_CONTEXT */
1901 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1903 PERL_ARGS_ASSERT_CK_WARNER_D;
1905 if (Perl_ckwarn_d(aTHX_ err)) {
1907 va_start(args, pat);
1908 vwarner(err, pat, &args);
1914 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1916 PERL_ARGS_ASSERT_CK_WARNER;
1918 if (Perl_ckwarn(aTHX_ err)) {
1920 va_start(args, pat);
1921 vwarner(err, pat, &args);
1927 Perl_warner(pTHX_ U32 err, const char* pat,...)
1930 PERL_ARGS_ASSERT_WARNER;
1931 va_start(args, pat);
1932 vwarner(err, pat, &args);
1937 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1940 PERL_ARGS_ASSERT_VWARNER;
1941 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1942 SV * const msv = vmess(pat, args);
1944 if (PL_parser && PL_parser->error_count) {
1948 invoke_exception_hook(msv, FALSE);
1953 Perl_vwarn(aTHX_ pat, args);
1957 /* implements the ckWARN? macros */
1960 Perl_ckwarn(pTHX_ U32 w)
1962 /* If lexical warnings have not been set, use $^W. */
1964 return PL_dowarn & G_WARN_ON;
1966 return ckwarn_common(w);
1969 /* implements the ckWARN?_d macro */
1972 Perl_ckwarn_d(pTHX_ U32 w)
1974 /* If lexical warnings have not been set then default classes warn. */
1978 return ckwarn_common(w);
1982 S_ckwarn_common(pTHX_ U32 w)
1984 if (PL_curcop->cop_warnings == pWARN_ALL)
1987 if (PL_curcop->cop_warnings == pWARN_NONE)
1990 /* Check the assumption that at least the first slot is non-zero. */
1991 assert(unpackWARN1(w));
1993 /* Check the assumption that it is valid to stop as soon as a zero slot is
1995 if (!unpackWARN2(w)) {
1996 assert(!unpackWARN3(w));
1997 assert(!unpackWARN4(w));
1998 } else if (!unpackWARN3(w)) {
1999 assert(!unpackWARN4(w));
2002 /* Right, dealt with all the special cases, which are implemented as non-
2003 pointers, so there is a pointer to a real warnings mask. */
2005 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2007 } while (w >>= WARNshift);
2012 /* Set buffer=NULL to get a new one. */
2014 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2016 const MEM_SIZE len_wanted =
2017 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2018 PERL_UNUSED_CONTEXT;
2019 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2022 (specialWARN(buffer) ?
2023 PerlMemShared_malloc(len_wanted) :
2024 PerlMemShared_realloc(buffer, len_wanted));
2026 Copy(bits, (buffer + 1), size, char);
2027 if (size < WARNsize)
2028 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2032 /* since we've already done strlen() for both nam and val
2033 * we can use that info to make things faster than
2034 * sprintf(s, "%s=%s", nam, val)
2036 #define my_setenv_format(s, nam, nlen, val, vlen) \
2037 Copy(nam, s, nlen, char); \
2039 Copy(val, s+(nlen+1), vlen, char); \
2040 *(s+(nlen+1+vlen)) = '\0'
2042 #ifdef USE_ENVIRON_ARRAY
2043 /* VMS' my_setenv() is in vms.c */
2044 #if !defined(WIN32) && !defined(NETWARE)
2046 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2050 /* only parent thread can modify process environment */
2051 if (PL_curinterp == aTHX)
2054 #ifndef PERL_USE_SAFE_PUTENV
2055 if (!PL_use_safe_putenv) {
2056 /* most putenv()s leak, so we manipulate environ directly */
2058 const I32 len = strlen(nam);
2061 /* where does it go? */
2062 for (i = 0; environ[i]; i++) {
2063 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2067 if (environ == PL_origenviron) { /* need we copy environment? */
2073 while (environ[max])
2075 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2076 for (j=0; j<max; j++) { /* copy environment */
2077 const int len = strlen(environ[j]);
2078 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2079 Copy(environ[j], tmpenv[j], len+1, char);
2082 environ = tmpenv; /* tell exec where it is now */
2085 safesysfree(environ[i]);
2086 while (environ[i]) {
2087 environ[i] = environ[i+1];
2092 if (!environ[i]) { /* does not exist yet */
2093 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2094 environ[i+1] = NULL; /* make sure it's null terminated */
2097 safesysfree(environ[i]);
2101 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2102 /* all that work just for this */
2103 my_setenv_format(environ[i], nam, nlen, val, vlen);
2106 /* This next branch should only be called #if defined(HAS_SETENV), but
2107 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2108 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2110 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV))
2111 # if defined(HAS_UNSETENV)
2113 (void)unsetenv(nam);
2115 (void)setenv(nam, val, 1);
2117 # else /* ! HAS_UNSETENV */
2118 (void)setenv(nam, val, 1);
2119 # endif /* HAS_UNSETENV */
2121 # if defined(HAS_UNSETENV)
2123 if (environ) /* old glibc can crash with null environ */
2124 (void)unsetenv(nam);
2126 const int nlen = strlen(nam);
2127 const int vlen = strlen(val);
2128 char * const new_env =
2129 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2130 my_setenv_format(new_env, nam, nlen, val, vlen);
2131 (void)putenv(new_env);
2133 # else /* ! HAS_UNSETENV */
2135 const int nlen = strlen(nam);
2141 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2142 /* all that work just for this */
2143 my_setenv_format(new_env, nam, nlen, val, vlen);
2144 (void)putenv(new_env);
2145 # endif /* HAS_UNSETENV */
2146 # endif /* __CYGWIN__ */
2147 #ifndef PERL_USE_SAFE_PUTENV
2153 #else /* WIN32 || NETWARE */
2156 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2160 const int nlen = strlen(nam);
2167 Newx(envstr, nlen+vlen+2, char);
2168 my_setenv_format(envstr, nam, nlen, val, vlen);
2169 (void)PerlEnv_putenv(envstr);
2173 #endif /* WIN32 || NETWARE */
2177 #ifdef UNLINK_ALL_VERSIONS
2179 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2183 PERL_ARGS_ASSERT_UNLNK;
2185 while (PerlLIO_unlink(f) >= 0)
2187 return retries ? 0 : -1;
2191 /* this is a drop-in replacement for bcopy() */
2192 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2194 Perl_my_bcopy(const char *from, char *to, I32 len)
2196 char * const retval = to;
2198 PERL_ARGS_ASSERT_MY_BCOPY;
2202 if (from - to >= 0) {
2210 *(--to) = *(--from);
2216 /* this is a drop-in replacement for memset() */
2219 Perl_my_memset(char *loc, I32 ch, I32 len)
2221 char * const retval = loc;
2223 PERL_ARGS_ASSERT_MY_MEMSET;
2233 /* this is a drop-in replacement for bzero() */
2234 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2236 Perl_my_bzero(char *loc, I32 len)
2238 char * const retval = loc;
2240 PERL_ARGS_ASSERT_MY_BZERO;
2250 /* this is a drop-in replacement for memcmp() */
2251 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2253 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2255 const U8 *a = (const U8 *)s1;
2256 const U8 *b = (const U8 *)s2;
2259 PERL_ARGS_ASSERT_MY_MEMCMP;
2264 if ((tmp = *a++ - *b++))
2269 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2272 /* This vsprintf replacement should generally never get used, since
2273 vsprintf was available in both System V and BSD 2.11. (There may
2274 be some cross-compilation or embedded set-ups where it is needed,
2277 If you encounter a problem in this function, it's probably a symptom
2278 that Configure failed to detect your system's vprintf() function.
2279 See the section on "item vsprintf" in the INSTALL file.
2281 This version may compile on systems with BSD-ish <stdio.h>,
2282 but probably won't on others.
2285 #ifdef USE_CHAR_VSPRINTF
2290 vsprintf(char *dest, const char *pat, void *args)
2294 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2295 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2296 FILE_cnt(&fakebuf) = 32767;
2298 /* These probably won't compile -- If you really need
2299 this, you'll have to figure out some other method. */
2300 fakebuf._ptr = dest;
2301 fakebuf._cnt = 32767;
2306 fakebuf._flag = _IOWRT|_IOSTRG;
2307 _doprnt(pat, args, &fakebuf); /* what a kludge */
2308 #if defined(STDIO_PTR_LVALUE)
2309 *(FILE_ptr(&fakebuf)++) = '\0';
2311 /* PerlIO has probably #defined away fputc, but we want it here. */
2313 # undef fputc /* XXX Should really restore it later */
2315 (void)fputc('\0', &fakebuf);
2317 #ifdef USE_CHAR_VSPRINTF
2320 return 0; /* perl doesn't use return value */
2324 #endif /* HAS_VPRINTF */
2327 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2329 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2337 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2339 PERL_FLUSHALL_FOR_CHILD;
2340 This = (*mode == 'w');
2344 taint_proper("Insecure %s%s", "EXEC");
2346 if (PerlProc_pipe(p) < 0)
2348 /* Try for another pipe pair for error return */
2349 if (PerlProc_pipe(pp) >= 0)
2351 while ((pid = PerlProc_fork()) < 0) {
2352 if (errno != EAGAIN) {
2353 PerlLIO_close(p[This]);
2354 PerlLIO_close(p[that]);
2356 PerlLIO_close(pp[0]);
2357 PerlLIO_close(pp[1]);
2361 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2370 /* Close parent's end of error status pipe (if any) */
2372 PerlLIO_close(pp[0]);
2373 #if defined(HAS_FCNTL) && defined(F_SETFD)
2374 /* Close error pipe automatically if exec works */
2375 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2379 /* Now dup our end of _the_ pipe to right position */
2380 if (p[THIS] != (*mode == 'r')) {
2381 PerlLIO_dup2(p[THIS], *mode == 'r');
2382 PerlLIO_close(p[THIS]);
2383 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2384 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2387 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2388 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2389 /* No automatic close - do it by hand */
2396 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2402 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2408 do_execfree(); /* free any memory malloced by child on fork */
2410 PerlLIO_close(pp[1]);
2411 /* Keep the lower of the two fd numbers */
2412 if (p[that] < p[This]) {
2413 PerlLIO_dup2(p[This], p[that]);
2414 PerlLIO_close(p[This]);
2418 PerlLIO_close(p[that]); /* close child's end of pipe */
2420 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2421 SvUPGRADE(sv,SVt_IV);
2423 PL_forkprocess = pid;
2424 /* If we managed to get status pipe check for exec fail */
2425 if (did_pipes && pid > 0) {
2430 while (n < sizeof(int)) {
2431 n1 = PerlLIO_read(pp[0],
2432 (void*)(((char*)&errkid)+n),
2438 PerlLIO_close(pp[0]);
2440 if (n) { /* Error */
2442 PerlLIO_close(p[This]);
2443 if (n != sizeof(int))
2444 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2446 pid2 = wait4pid(pid, &status, 0);
2447 } while (pid2 == -1 && errno == EINTR);
2448 errno = errkid; /* Propagate errno from kid */
2453 PerlLIO_close(pp[0]);
2454 return PerlIO_fdopen(p[This], mode);
2456 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2457 return my_syspopen4(aTHX_ NULL, mode, n, args);
2458 # elif defined(WIN32)
2459 return win32_popenlist(mode, n, args);
2461 Perl_croak(aTHX_ "List form of piped open not implemented");
2462 return (PerlIO *) NULL;
2467 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2468 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2470 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2476 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2480 PERL_ARGS_ASSERT_MY_POPEN;
2482 PERL_FLUSHALL_FOR_CHILD;
2485 return my_syspopen(aTHX_ cmd,mode);
2488 This = (*mode == 'w');
2490 if (doexec && TAINTING_get) {
2492 taint_proper("Insecure %s%s", "EXEC");
2494 if (PerlProc_pipe(p) < 0)
2496 if (doexec && PerlProc_pipe(pp) >= 0)
2498 while ((pid = PerlProc_fork()) < 0) {
2499 if (errno != EAGAIN) {
2500 PerlLIO_close(p[This]);
2501 PerlLIO_close(p[that]);
2503 PerlLIO_close(pp[0]);
2504 PerlLIO_close(pp[1]);
2507 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2510 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2520 PerlLIO_close(pp[0]);
2521 #if defined(HAS_FCNTL) && defined(F_SETFD)
2522 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2526 if (p[THIS] != (*mode == 'r')) {
2527 PerlLIO_dup2(p[THIS], *mode == 'r');
2528 PerlLIO_close(p[THIS]);
2529 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2530 PerlLIO_close(p[THAT]);
2533 PerlLIO_close(p[THAT]);
2536 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2543 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2548 /* may or may not use the shell */
2549 do_exec3(cmd, pp[1], did_pipes);
2552 #endif /* defined OS2 */
2554 #ifdef PERLIO_USING_CRLF
2555 /* Since we circumvent IO layers when we manipulate low-level
2556 filedescriptors directly, need to manually switch to the
2557 default, binary, low-level mode; see PerlIOBuf_open(). */
2558 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2561 #ifdef PERL_USES_PL_PIDSTATUS
2562 hv_clear(PL_pidstatus); /* we have no children */
2568 do_execfree(); /* free any memory malloced by child on vfork */
2570 PerlLIO_close(pp[1]);
2571 if (p[that] < p[This]) {
2572 PerlLIO_dup2(p[This], p[that]);
2573 PerlLIO_close(p[This]);
2577 PerlLIO_close(p[that]);
2579 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2580 SvUPGRADE(sv,SVt_IV);
2582 PL_forkprocess = pid;
2583 if (did_pipes && pid > 0) {
2588 while (n < sizeof(int)) {
2589 n1 = PerlLIO_read(pp[0],
2590 (void*)(((char*)&errkid)+n),
2596 PerlLIO_close(pp[0]);
2598 if (n) { /* Error */
2600 PerlLIO_close(p[This]);
2601 if (n != sizeof(int))
2602 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2604 pid2 = wait4pid(pid, &status, 0);
2605 } while (pid2 == -1 && errno == EINTR);
2606 errno = errkid; /* Propagate errno from kid */
2611 PerlLIO_close(pp[0]);
2612 return PerlIO_fdopen(p[This], mode);
2616 FILE *djgpp_popen();
2618 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2620 PERL_FLUSHALL_FOR_CHILD;
2621 /* Call system's popen() to get a FILE *, then import it.
2622 used 0 for 2nd parameter to PerlIO_importFILE;
2625 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2628 #if defined(__LIBCATAMOUNT__)
2630 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2637 #endif /* !DOSISH */
2639 /* this is called in parent before the fork() */
2641 Perl_atfork_lock(void)
2643 #if defined(USE_ITHREADS)
2645 /* locks must be held in locking order (if any) */
2647 MUTEX_LOCK(&PL_perlio_mutex);
2650 MUTEX_LOCK(&PL_malloc_mutex);
2656 /* this is called in both parent and child after the fork() */
2658 Perl_atfork_unlock(void)
2660 #if defined(USE_ITHREADS)
2662 /* locks must be released in same order as in atfork_lock() */
2664 MUTEX_UNLOCK(&PL_perlio_mutex);
2667 MUTEX_UNLOCK(&PL_malloc_mutex);
2676 #if defined(HAS_FORK)
2678 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2683 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2684 * handlers elsewhere in the code */
2689 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2690 Perl_croak_nocontext("fork() not available");
2692 #endif /* HAS_FORK */
2697 dup2(int oldfd, int newfd)
2699 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2702 PerlLIO_close(newfd);
2703 return fcntl(oldfd, F_DUPFD, newfd);
2705 #define DUP2_MAX_FDS 256
2706 int fdtmp[DUP2_MAX_FDS];
2712 PerlLIO_close(newfd);
2713 /* good enough for low fd's... */
2714 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2715 if (fdx >= DUP2_MAX_FDS) {
2723 PerlLIO_close(fdtmp[--fdx]);
2730 #ifdef HAS_SIGACTION
2733 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2735 struct sigaction act, oact;
2739 /* only "parent" interpreter can diddle signals */
2740 if (PL_curinterp != aTHX)
2741 return (Sighandler_t) SIG_ERR;
2744 act.sa_handler = (void(*)(int))handler;
2745 sigemptyset(&act.sa_mask);
2748 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2749 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2751 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2752 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2753 act.sa_flags |= SA_NOCLDWAIT;
2755 if (sigaction(signo, &act, &oact) == -1)
2756 return (Sighandler_t) SIG_ERR;
2758 return (Sighandler_t) oact.sa_handler;
2762 Perl_rsignal_state(pTHX_ int signo)
2764 struct sigaction oact;
2765 PERL_UNUSED_CONTEXT;
2767 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2768 return (Sighandler_t) SIG_ERR;
2770 return (Sighandler_t) oact.sa_handler;
2774 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2779 struct sigaction act;
2781 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2784 /* only "parent" interpreter can diddle signals */
2785 if (PL_curinterp != aTHX)
2789 act.sa_handler = (void(*)(int))handler;
2790 sigemptyset(&act.sa_mask);
2793 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2794 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2796 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2797 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2798 act.sa_flags |= SA_NOCLDWAIT;
2800 return sigaction(signo, &act, save);
2804 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2809 PERL_UNUSED_CONTEXT;
2811 /* only "parent" interpreter can diddle signals */
2812 if (PL_curinterp != aTHX)
2816 return sigaction(signo, save, (struct sigaction *)NULL);
2819 #else /* !HAS_SIGACTION */
2822 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2824 #if defined(USE_ITHREADS) && !defined(WIN32)
2825 /* only "parent" interpreter can diddle signals */
2826 if (PL_curinterp != aTHX)
2827 return (Sighandler_t) SIG_ERR;
2830 return PerlProc_signal(signo, handler);
2841 Perl_rsignal_state(pTHX_ int signo)
2844 Sighandler_t oldsig;
2846 #if defined(USE_ITHREADS) && !defined(WIN32)
2847 /* only "parent" interpreter can diddle signals */
2848 if (PL_curinterp != aTHX)
2849 return (Sighandler_t) SIG_ERR;
2853 oldsig = PerlProc_signal(signo, sig_trap);
2854 PerlProc_signal(signo, oldsig);
2856 PerlProc_kill(PerlProc_getpid(), signo);
2861 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2863 #if defined(USE_ITHREADS) && !defined(WIN32)
2864 /* only "parent" interpreter can diddle signals */
2865 if (PL_curinterp != aTHX)
2868 *save = PerlProc_signal(signo, handler);
2869 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2873 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2875 #if defined(USE_ITHREADS) && !defined(WIN32)
2876 /* only "parent" interpreter can diddle signals */
2877 if (PL_curinterp != aTHX)
2880 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2883 #endif /* !HAS_SIGACTION */
2884 #endif /* !PERL_MICRO */
2886 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2887 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2889 Perl_my_pclose(pTHX_ PerlIO *ptr)
2897 const int fd = PerlIO_fileno(ptr);
2900 svp = av_fetch(PL_fdpid,fd,TRUE);
2901 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2905 #if defined(USE_PERLIO)
2906 /* Find out whether the refcount is low enough for us to wait for the
2907 child proc without blocking. */
2908 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2910 should_wait = pid > 0;
2914 if (pid == -1) { /* Opened by popen. */
2915 return my_syspclose(ptr);
2918 close_failed = (PerlIO_close(ptr) == EOF);
2920 if (should_wait) do {
2921 pid2 = wait4pid(pid, &status, 0);
2922 } while (pid2 == -1 && errno == EINTR);
2929 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2934 #if defined(__LIBCATAMOUNT__)
2936 Perl_my_pclose(pTHX_ PerlIO *ptr)
2941 #endif /* !DOSISH */
2943 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2945 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2948 PERL_ARGS_ASSERT_WAIT4PID;
2949 #ifdef PERL_USES_PL_PIDSTATUS
2951 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2952 waitpid() nor wait4() is available, or on OS/2, which
2953 doesn't appear to support waiting for a progress group
2954 member, so we can only treat a 0 pid as an unknown child.
2961 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2962 pid, rather than a string form. */
2963 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2964 if (svp && *svp != &PL_sv_undef) {
2965 *statusp = SvIVX(*svp);
2966 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2974 hv_iterinit(PL_pidstatus);
2975 if ((entry = hv_iternext(PL_pidstatus))) {
2976 SV * const sv = hv_iterval(PL_pidstatus,entry);
2978 const char * const spid = hv_iterkey(entry,&len);
2980 assert (len == sizeof(Pid_t));
2981 memcpy((char *)&pid, spid, len);
2982 *statusp = SvIVX(sv);
2983 /* The hash iterator is currently on this entry, so simply
2984 calling hv_delete would trigger the lazy delete, which on
2985 aggregate does more work, because next call to hv_iterinit()
2986 would spot the flag, and have to call the delete routine,
2987 while in the meantime any new entries can't re-use that
2989 hv_iterinit(PL_pidstatus);
2990 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2997 # ifdef HAS_WAITPID_RUNTIME
2998 if (!HAS_WAITPID_RUNTIME)
3001 result = PerlProc_waitpid(pid,statusp,flags);
3004 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3005 result = wait4(pid,statusp,flags,NULL);
3008 #ifdef PERL_USES_PL_PIDSTATUS
3009 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3014 Perl_croak(aTHX_ "Can't do waitpid with flags");
3016 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3017 pidgone(result,*statusp);
3023 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3026 if (result < 0 && errno == EINTR) {
3028 errno = EINTR; /* reset in case a signal handler changed $! */
3032 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3034 #ifdef PERL_USES_PL_PIDSTATUS
3036 S_pidgone(pTHX_ Pid_t pid, int status)
3040 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3041 SvUPGRADE(sv,SVt_IV);
3042 SvIV_set(sv, status);
3050 int /* Cannot prototype with I32
3052 my_syspclose(PerlIO *ptr)
3055 Perl_my_pclose(pTHX_ PerlIO *ptr)
3058 /* Needs work for PerlIO ! */
3059 FILE * const f = PerlIO_findFILE(ptr);
3060 const I32 result = pclose(f);
3061 PerlIO_releaseFILE(ptr,f);
3069 Perl_my_pclose(pTHX_ PerlIO *ptr)
3071 /* Needs work for PerlIO ! */
3072 FILE * const f = PerlIO_findFILE(ptr);
3073 I32 result = djgpp_pclose(f);
3074 result = (result << 8) & 0xff00;
3075 PerlIO_releaseFILE(ptr,f);
3080 #define PERL_REPEATCPY_LINEAR 4
3082 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3084 PERL_ARGS_ASSERT_REPEATCPY;
3089 croak_memory_wrap();
3092 memset(to, *from, count);
3095 IV items, linear, half;
3097 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3098 for (items = 0; items < linear; ++items) {
3099 const char *q = from;
3101 for (todo = len; todo > 0; todo--)
3106 while (items <= half) {
3107 IV size = items * len;
3108 memcpy(p, to, size);
3114 memcpy(p, to, (count - items) * len);
3120 Perl_same_dirent(pTHX_ const char *a, const char *b)
3122 char *fa = strrchr(a,'/');
3123 char *fb = strrchr(b,'/');
3126 SV * const tmpsv = sv_newmortal();
3128 PERL_ARGS_ASSERT_SAME_DIRENT;
3141 sv_setpvs(tmpsv, ".");
3143 sv_setpvn(tmpsv, a, fa - a);
3144 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3147 sv_setpvs(tmpsv, ".");
3149 sv_setpvn(tmpsv, b, fb - b);
3150 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3152 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3153 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3155 #endif /* !HAS_RENAME */
3158 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3159 const char *const *const search_ext, I32 flags)
3161 const char *xfound = NULL;
3162 char *xfailed = NULL;
3163 char tmpbuf[MAXPATHLEN];
3168 #if defined(DOSISH) && !defined(OS2)
3169 # define SEARCH_EXTS ".bat", ".cmd", NULL
3170 # define MAX_EXT_LEN 4
3173 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3174 # define MAX_EXT_LEN 4
3177 # define SEARCH_EXTS ".pl", ".com", NULL
3178 # define MAX_EXT_LEN 4
3180 /* additional extensions to try in each dir if scriptname not found */
3182 static const char *const exts[] = { SEARCH_EXTS };
3183 const char *const *const ext = search_ext ? search_ext : exts;
3184 int extidx = 0, i = 0;
3185 const char *curext = NULL;
3187 PERL_UNUSED_ARG(search_ext);
3188 # define MAX_EXT_LEN 0
3191 PERL_ARGS_ASSERT_FIND_SCRIPT;
3194 * If dosearch is true and if scriptname does not contain path
3195 * delimiters, search the PATH for scriptname.
3197 * If SEARCH_EXTS is also defined, will look for each
3198 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3199 * while searching the PATH.
3201 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3202 * proceeds as follows:
3203 * If DOSISH or VMSISH:
3204 * + look for ./scriptname{,.foo,.bar}
3205 * + search the PATH for scriptname{,.foo,.bar}
3208 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3209 * this will not look in '.' if it's not in the PATH)
3214 # ifdef ALWAYS_DEFTYPES
3215 len = strlen(scriptname);
3216 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3217 int idx = 0, deftypes = 1;
3220 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3223 int idx = 0, deftypes = 1;
3226 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3228 /* The first time through, just add SEARCH_EXTS to whatever we
3229 * already have, so we can check for default file types. */
3231 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3237 if ((strlen(tmpbuf) + strlen(scriptname)
3238 + MAX_EXT_LEN) >= sizeof tmpbuf)
3239 continue; /* don't search dir with too-long name */
3240 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3244 if (strEQ(scriptname, "-"))
3246 if (dosearch) { /* Look in '.' first. */
3247 const char *cur = scriptname;
3249 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3251 if (strEQ(ext[i++],curext)) {
3252 extidx = -1; /* already has an ext */
3257 DEBUG_p(PerlIO_printf(Perl_debug_log,
3258 "Looking for %s\n",cur));
3259 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3260 && !S_ISDIR(PL_statbuf.st_mode)) {
3268 if (cur == scriptname) {
3269 len = strlen(scriptname);
3270 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3272 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3275 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3276 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3281 if (dosearch && !strchr(scriptname, '/')
3283 && !strchr(scriptname, '\\')
3285 && (s = PerlEnv_getenv("PATH")))
3289 bufend = s + strlen(s);
3290 while (s < bufend) {
3293 && *s != ';'; len++, s++) {
3294 if (len < sizeof tmpbuf)
3297 if (len < sizeof tmpbuf)
3300 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3306 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3307 continue; /* don't search dir with too-long name */
3310 && tmpbuf[len - 1] != '/'
3311 && tmpbuf[len - 1] != '\\'
3314 tmpbuf[len++] = '/';
3315 if (len == 2 && tmpbuf[0] == '.')
3317 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3321 len = strlen(tmpbuf);
3322 if (extidx > 0) /* reset after previous loop */
3326 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3327 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3328 if (S_ISDIR(PL_statbuf.st_mode)) {
3332 } while ( retval < 0 /* not there */
3333 && extidx>=0 && ext[extidx] /* try an extension? */
3334 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3339 if (S_ISREG(PL_statbuf.st_mode)
3340 && cando(S_IRUSR,TRUE,&PL_statbuf)
3341 #if !defined(DOSISH)
3342 && cando(S_IXUSR,TRUE,&PL_statbuf)
3346 xfound = tmpbuf; /* bingo! */
3350 xfailed = savepv(tmpbuf);
3353 if (!xfound && !seen_dot && !xfailed &&
3354 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3355 || S_ISDIR(PL_statbuf.st_mode)))
3357 seen_dot = 1; /* Disable message. */
3359 if (flags & 1) { /* do or die? */
3360 /* diag_listed_as: Can't execute %s */
3361 Perl_croak(aTHX_ "Can't %s %s%s%s",
3362 (xfailed ? "execute" : "find"),
3363 (xfailed ? xfailed : scriptname),
3364 (xfailed ? "" : " on PATH"),
3365 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3370 scriptname = xfound;
3372 return (scriptname ? savepv(scriptname) : NULL);
3375 #ifndef PERL_GET_CONTEXT_DEFINED
3378 Perl_get_context(void)
3380 #if defined(USE_ITHREADS)
3382 # ifdef OLD_PTHREADS_API
3384 int error = pthread_getspecific(PL_thr_key, &t)
3386 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3389 # ifdef I_MACH_CTHREADS
3390 return (void*)cthread_data(cthread_self());
3392 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3401 Perl_set_context(void *t)
3403 #if defined(USE_ITHREADS)
3406 PERL_ARGS_ASSERT_SET_CONTEXT;
3407 #if defined(USE_ITHREADS)
3408 # ifdef I_MACH_CTHREADS
3409 cthread_set_data(cthread_self(), t);
3412 const int error = pthread_setspecific(PL_thr_key, t);
3414 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3422 #endif /* !PERL_GET_CONTEXT_DEFINED */
3424 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3428 PERL_UNUSED_CONTEXT;
3434 Perl_get_op_names(pTHX)
3436 PERL_UNUSED_CONTEXT;
3437 return (char **)PL_op_name;
3441 Perl_get_op_descs(pTHX)
3443 PERL_UNUSED_CONTEXT;
3444 return (char **)PL_op_desc;
3448 Perl_get_no_modify(pTHX)
3450 PERL_UNUSED_CONTEXT;
3451 return PL_no_modify;
3455 Perl_get_opargs(pTHX)
3457 PERL_UNUSED_CONTEXT;
3458 return (U32 *)PL_opargs;
3462 Perl_get_ppaddr(pTHX)
3465 PERL_UNUSED_CONTEXT;
3466 return (PPADDR_t*)PL_ppaddr;
3469 #ifndef HAS_GETENV_LEN
3471 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3473 char * const env_trans = PerlEnv_getenv(env_elem);
3474 PERL_UNUSED_CONTEXT;
3475 PERL_ARGS_ASSERT_GETENV_LEN;
3477 *len = strlen(env_trans);
3484 Perl_get_vtbl(pTHX_ int vtbl_id)
3486 PERL_UNUSED_CONTEXT;
3488 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3489 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3493 Perl_my_fflush_all(pTHX)
3495 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3496 return PerlIO_flush(NULL);
3498 # if defined(HAS__FWALK)
3499 extern int fflush(FILE *);
3500 /* undocumented, unprototyped, but very useful BSDism */
3501 extern void _fwalk(int (*)(FILE *));
3505 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3507 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3508 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3510 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3511 open_max = sysconf(_SC_OPEN_MAX);
3514 open_max = FOPEN_MAX;
3517 open_max = OPEN_MAX;
3528 for (i = 0; i < open_max; i++)
3529 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3530 STDIO_STREAM_ARRAY[i]._file < open_max &&
3531 STDIO_STREAM_ARRAY[i]._flag)
3532 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3536 SETERRNO(EBADF,RMS_IFI);
3543 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3545 if (ckWARN(WARN_IO)) {
3547 = gv && (isGV_with_GP(gv))
3550 const char * const direction = have == '>' ? "out" : "in";
3552 if (name && HEK_LEN(name))
3553 Perl_warner(aTHX_ packWARN(WARN_IO),
3554 "Filehandle %"HEKf" opened only for %sput",
3555 HEKfARG(name), direction);
3557 Perl_warner(aTHX_ packWARN(WARN_IO),
3558 "Filehandle opened only for %sput", direction);
3563 Perl_report_evil_fh(pTHX_ const GV *gv)
3565 const IO *io = gv ? GvIO(gv) : NULL;
3566 const PERL_BITFIELD16 op = PL_op->op_type;
3570 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3572 warn_type = WARN_CLOSED;
3576 warn_type = WARN_UNOPENED;
3579 if (ckWARN(warn_type)) {
3581 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3582 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3583 const char * const pars =
3584 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3585 const char * const func =
3587 (op == OP_READLINE || op == OP_RCATLINE
3588 ? "readline" : /* "<HANDLE>" not nice */
3589 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3591 const char * const type =
3593 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3594 ? "socket" : "filehandle");
3595 const bool have_name = name && SvCUR(name);
3596 Perl_warner(aTHX_ packWARN(warn_type),
3597 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3598 have_name ? " " : "",
3599 SVfARG(have_name ? name : &PL_sv_no));
3600 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3602 aTHX_ packWARN(warn_type),
3603 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3604 func, pars, have_name ? " " : "",
3605 SVfARG(have_name ? name : &PL_sv_no)
3610 /* To workaround core dumps from the uninitialised tm_zone we get the
3611 * system to give us a reasonable struct to copy. This fix means that
3612 * strftime uses the tm_zone and tm_gmtoff values returned by
3613 * localtime(time()). That should give the desired result most of the
3614 * time. But probably not always!
3616 * This does not address tzname aspects of NETaa14816.
3621 # ifndef STRUCT_TM_HASZONE
3622 # define STRUCT_TM_HASZONE
3626 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3627 # ifndef HAS_TM_TM_ZONE
3628 # define HAS_TM_TM_ZONE
3633 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3635 #ifdef HAS_TM_TM_ZONE
3637 const struct tm* my_tm;
3638 PERL_UNUSED_CONTEXT;
3639 PERL_ARGS_ASSERT_INIT_TM;
3641 my_tm = localtime(&now);
3643 Copy(my_tm, ptm, 1, struct tm);
3645 PERL_UNUSED_CONTEXT;
3646 PERL_ARGS_ASSERT_INIT_TM;
3647 PERL_UNUSED_ARG(ptm);
3652 * mini_mktime - normalise struct tm values without the localtime()
3653 * semantics (and overhead) of mktime().
3656 Perl_mini_mktime(struct tm *ptm)
3660 int month, mday, year, jday;
3661 int odd_cent, odd_year;
3663 PERL_ARGS_ASSERT_MINI_MKTIME;
3665 #define DAYS_PER_YEAR 365
3666 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3667 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3668 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3669 #define SECS_PER_HOUR (60*60)
3670 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3671 /* parentheses deliberately absent on these two, otherwise they don't work */
3672 #define MONTH_TO_DAYS 153/5
3673 #define DAYS_TO_MONTH 5/153
3674 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3675 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3676 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3677 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3680 * Year/day algorithm notes:
3682 * With a suitable offset for numeric value of the month, one can find
3683 * an offset into the year by considering months to have 30.6 (153/5) days,
3684 * using integer arithmetic (i.e., with truncation). To avoid too much
3685 * messing about with leap days, we consider January and February to be
3686 * the 13th and 14th month of the previous year. After that transformation,
3687 * we need the month index we use to be high by 1 from 'normal human' usage,
3688 * so the month index values we use run from 4 through 15.
3690 * Given that, and the rules for the Gregorian calendar (leap years are those
3691 * divisible by 4 unless also divisible by 100, when they must be divisible
3692 * by 400 instead), we can simply calculate the number of days since some
3693 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3694 * the days we derive from our month index, and adding in the day of the
3695 * month. The value used here is not adjusted for the actual origin which
3696 * it normally would use (1 January A.D. 1), since we're not exposing it.
3697 * We're only building the value so we can turn around and get the
3698 * normalised values for the year, month, day-of-month, and day-of-year.
3700 * For going backward, we need to bias the value we're using so that we find
3701 * the right year value. (Basically, we don't want the contribution of
3702 * March 1st to the number to apply while deriving the year). Having done
3703 * that, we 'count up' the contribution to the year number by accounting for
3704 * full quadracenturies (400-year periods) with their extra leap days, plus
3705 * the contribution from full centuries (to avoid counting in the lost leap
3706 * days), plus the contribution from full quad-years (to count in the normal
3707 * leap days), plus the leftover contribution from any non-leap years.
3708 * At this point, if we were working with an actual leap day, we'll have 0
3709 * days left over. This is also true for March 1st, however. So, we have
3710 * to special-case that result, and (earlier) keep track of the 'odd'
3711 * century and year contributions. If we got 4 extra centuries in a qcent,
3712 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3713 * Otherwise, we add back in the earlier bias we removed (the 123 from
3714 * figuring in March 1st), find the month index (integer division by 30.6),
3715 * and the remainder is the day-of-month. We then have to convert back to
3716 * 'real' months (including fixing January and February from being 14/15 in
3717 * the previous year to being in the proper year). After that, to get
3718 * tm_yday, we work with the normalised year and get a new yearday value for
3719 * January 1st, which we subtract from the yearday value we had earlier,
3720 * representing the date we've re-built. This is done from January 1
3721 * because tm_yday is 0-origin.
3723 * Since POSIX time routines are only guaranteed to work for times since the
3724 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3725 * applies Gregorian calendar rules even to dates before the 16th century
3726 * doesn't bother me. Besides, you'd need cultural context for a given
3727 * date to know whether it was Julian or Gregorian calendar, and that's
3728 * outside the scope for this routine. Since we convert back based on the
3729 * same rules we used to build the yearday, you'll only get strange results
3730 * for input which needed normalising, or for the 'odd' century years which
3731 * were leap years in the Julian calendar but not in the Gregorian one.
3732 * I can live with that.
3734 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3735 * that's still outside the scope for POSIX time manipulation, so I don't
3739 year = 1900 + ptm->tm_year;
3740 month = ptm->tm_mon;
3741 mday = ptm->tm_mday;
3747 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3748 yearday += month*MONTH_TO_DAYS + mday + jday;
3750 * Note that we don't know when leap-seconds were or will be,
3751 * so we have to trust the user if we get something which looks
3752 * like a sensible leap-second. Wild values for seconds will
3753 * be rationalised, however.
3755 if ((unsigned) ptm->tm_sec <= 60) {
3762 secs += 60 * ptm->tm_min;
3763 secs += SECS_PER_HOUR * ptm->tm_hour;
3765 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3766 /* got negative remainder, but need positive time */
3767 /* back off an extra day to compensate */
3768 yearday += (secs/SECS_PER_DAY)-1;
3769 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3772 yearday += (secs/SECS_PER_DAY);
3773 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3776 else if (secs >= SECS_PER_DAY) {
3777 yearday += (secs/SECS_PER_DAY);
3778 secs %= SECS_PER_DAY;
3780 ptm->tm_hour = secs/SECS_PER_HOUR;
3781 secs %= SECS_PER_HOUR;
3782 ptm->tm_min = secs/60;
3784 ptm->tm_sec += secs;
3785 /* done with time of day effects */
3787 * The algorithm for yearday has (so far) left it high by 428.
3788 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3789 * bias it by 123 while trying to figure out what year it
3790 * really represents. Even with this tweak, the reverse
3791 * translation fails for years before A.D. 0001.
3792 * It would still fail for Feb 29, but we catch that one below.
3794 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3795 yearday -= YEAR_ADJUST;
3796 year = (yearday / DAYS_PER_QCENT) * 400;
3797 yearday %= DAYS_PER_QCENT;
3798 odd_cent = yearday / DAYS_PER_CENT;
3799 year += odd_cent * 100;
3800 yearday %= DAYS_PER_CENT;
3801 year += (yearday / DAYS_PER_QYEAR) * 4;
3802 yearday %= DAYS_PER_QYEAR;
3803 odd_year = yearday / DAYS_PER_YEAR;
3805 yearday %= DAYS_PER_YEAR;
3806 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3811 yearday += YEAR_ADJUST; /* recover March 1st crock */
3812 month = yearday*DAYS_TO_MONTH;
3813 yearday -= month*MONTH_TO_DAYS;
3814 /* recover other leap-year adjustment */
3823 ptm->tm_year = year - 1900;
3825 ptm->tm_mday = yearday;
3826 ptm->tm_mon = month;
3830 ptm->tm_mon = month - 1;
3832 /* re-build yearday based on Jan 1 to get tm_yday */
3834 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3835 yearday += 14*MONTH_TO_DAYS + 1;
3836 ptm->tm_yday = jday - yearday;
3837 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3841 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)
3845 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3852 PERL_ARGS_ASSERT_MY_STRFTIME;
3854 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3857 mytm.tm_hour = hour;
3858 mytm.tm_mday = mday;
3860 mytm.tm_year = year;
3861 mytm.tm_wday = wday;
3862 mytm.tm_yday = yday;
3863 mytm.tm_isdst = isdst;
3865 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3866 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3871 #ifdef HAS_TM_TM_GMTOFF
3872 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3874 #ifdef HAS_TM_TM_ZONE
3875 mytm.tm_zone = mytm2.tm_zone;
3880 Newx(buf, buflen, char);
3882 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3883 len = strftime(buf, buflen, fmt, &mytm);
3887 ** The following is needed to handle to the situation where
3888 ** tmpbuf overflows. Basically we want to allocate a buffer
3889 ** and try repeatedly. The reason why it is so complicated
3890 ** is that getting a return value of 0 from strftime can indicate
3891 ** one of the following:
3892 ** 1. buffer overflowed,
3893 ** 2. illegal conversion specifier, or
3894 ** 3. the format string specifies nothing to be returned(not
3895 ** an error). This could be because format is an empty string
3896 ** or it specifies %p that yields an empty string in some locale.
3897 ** If there is a better way to make it portable, go ahead by
3900 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3903 /* Possibly buf overflowed - try again with a bigger buf */
3904 const int fmtlen = strlen(fmt);
3905 int bufsize = fmtlen + buflen;
3907 Renew(buf, bufsize, char);
3910 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3911 buflen = strftime(buf, bufsize, fmt, &mytm);
3914 if (buflen > 0 && buflen < bufsize)
3916 /* heuristic to prevent out-of-memory errors */
3917 if (bufsize > 100*fmtlen) {
3923 Renew(buf, bufsize, char);
3928 Perl_croak(aTHX_ "panic: no strftime");
3934 #define SV_CWD_RETURN_UNDEF \
3935 sv_setsv(sv, &PL_sv_undef); \
3938 #define SV_CWD_ISDOT(dp) \
3939 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3940 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3943 =head1 Miscellaneous Functions
3945 =for apidoc getcwd_sv
3947 Fill the sv with current working directory
3952 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3953 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3954 * getcwd(3) if available
3955 * Comments from the original:
3956 * This is a faster version of getcwd. It's also more dangerous
3957 * because you might chdir out of a directory that you can't chdir
3961 Perl_getcwd_sv(pTHX_ SV *sv)
3966 PERL_ARGS_ASSERT_GETCWD_SV;
3970 char buf[MAXPATHLEN];
3972 /* Some getcwd()s automatically allocate a buffer of the given
3973 * size from the heap if they are given a NULL buffer pointer.
3974 * The problem is that this behaviour is not portable. */
3975 if (getcwd(buf, sizeof(buf) - 1)) {
3980 sv_setsv(sv, &PL_sv_undef);
3988 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3992 SvUPGRADE(sv, SVt_PV);
3994 if (PerlLIO_lstat(".", &statbuf) < 0) {
3995 SV_CWD_RETURN_UNDEF;
3998 orig_cdev = statbuf.st_dev;
3999 orig_cino = statbuf.st_ino;
4009 if (PerlDir_chdir("..") < 0) {
4010 SV_CWD_RETURN_UNDEF;
4012 if (PerlLIO_stat(".", &statbuf) < 0) {
4013 SV_CWD_RETURN_UNDEF;
4016 cdev = statbuf.st_dev;
4017 cino = statbuf.st_ino;
4019 if (odev == cdev && oino == cino) {
4022 if (!(dir = PerlDir_open("."))) {
4023 SV_CWD_RETURN_UNDEF;
4026 while ((dp = PerlDir_read(dir)) != NULL) {
4028 namelen = dp->d_namlen;
4030 namelen = strlen(dp->d_name);
4033 if (SV_CWD_ISDOT(dp)) {
4037 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4038 SV_CWD_RETURN_UNDEF;
4041 tdev = statbuf.st_dev;
4042 tino = statbuf.st_ino;
4043 if (tino == oino && tdev == odev) {
4049 SV_CWD_RETURN_UNDEF;
4052 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4053 SV_CWD_RETURN_UNDEF;
4056 SvGROW(sv, pathlen + namelen + 1);
4060 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4063 /* prepend current directory to the front */
4065 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4066 pathlen += (namelen + 1);
4068 #ifdef VOID_CLOSEDIR
4071 if (PerlDir_close(dir) < 0) {
4072 SV_CWD_RETURN_UNDEF;
4078 SvCUR_set(sv, pathlen);
4082 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4083 SV_CWD_RETURN_UNDEF;
4086 if (PerlLIO_stat(".", &statbuf) < 0) {
4087 SV_CWD_RETURN_UNDEF;
4090 cdev = statbuf.st_dev;
4091 cino = statbuf.st_ino;
4093 if (cdev != orig_cdev || cino != orig_cino) {
4094 Perl_croak(aTHX_ "Unstable directory path, "
4095 "current directory changed unexpectedly");
4108 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4109 # define EMULATE_SOCKETPAIR_UDP
4112 #ifdef EMULATE_SOCKETPAIR_UDP
4114 S_socketpair_udp (int fd[2]) {
4116 /* Fake a datagram socketpair using UDP to localhost. */
4117 int sockets[2] = {-1, -1};
4118 struct sockaddr_in addresses[2];
4120 Sock_size_t size = sizeof(struct sockaddr_in);
4121 unsigned short port;
4124 memset(&addresses, 0, sizeof(addresses));
4127 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4128 if (sockets[i] == -1)
4129 goto tidy_up_and_fail;
4131 addresses[i].sin_family = AF_INET;
4132 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4133 addresses[i].sin_port = 0; /* kernel choses port. */
4134 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4135 sizeof(struct sockaddr_in)) == -1)
4136 goto tidy_up_and_fail;
4139 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4140 for each connect the other socket to it. */
4143 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4145 goto tidy_up_and_fail;
4146 if (size != sizeof(struct sockaddr_in))
4147 goto abort_tidy_up_and_fail;
4148 /* !1 is 0, !0 is 1 */
4149 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4150 sizeof(struct sockaddr_in)) == -1)
4151 goto tidy_up_and_fail;
4154 /* Now we have 2 sockets connected to each other. I don't trust some other
4155 process not to have already sent a packet to us (by random) so send
4156 a packet from each to the other. */
4159 /* I'm going to send my own port number. As a short.
4160 (Who knows if someone somewhere has sin_port as a bitfield and needs
4161 this routine. (I'm assuming crays have socketpair)) */
4162 port = addresses[i].sin_port;
4163 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4164 if (got != sizeof(port)) {
4166 goto tidy_up_and_fail;
4167 goto abort_tidy_up_and_fail;
4171 /* Packets sent. I don't trust them to have arrived though.
4172 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4173 connect to localhost will use a second kernel thread. In 2.6 the
4174 first thread running the connect() returns before the second completes,
4175 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4176 returns 0. Poor programs have tripped up. One poor program's authors'
4177 had a 50-1 reverse stock split. Not sure how connected these were.)
4178 So I don't trust someone not to have an unpredictable UDP stack.
4182 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4183 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4187 FD_SET((unsigned int)sockets[0], &rset);
4188 FD_SET((unsigned int)sockets[1], &rset);
4190 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4191 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4192 || !FD_ISSET(sockets[1], &rset)) {
4193 /* I hope this is portable and appropriate. */
4195 goto tidy_up_and_fail;
4196 goto abort_tidy_up_and_fail;
4200 /* And the paranoia department even now doesn't trust it to have arrive
4201 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4203 struct sockaddr_in readfrom;
4204 unsigned short buffer[2];
4209 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4210 sizeof(buffer), MSG_DONTWAIT,
4211 (struct sockaddr *) &readfrom, &size);
4213 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4215 (struct sockaddr *) &readfrom, &size);
4219 goto tidy_up_and_fail;
4220 if (got != sizeof(port)
4221 || size != sizeof(struct sockaddr_in)
4222 /* Check other socket sent us its port. */
4223 || buffer[0] != (unsigned short) addresses[!i].sin_port
4224 /* Check kernel says we got the datagram from that socket */
4225 || readfrom.sin_family != addresses[!i].sin_family
4226 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4227 || readfrom.sin_port != addresses[!i].sin_port)
4228 goto abort_tidy_up_and_fail;
4231 /* My caller (my_socketpair) has validated that this is non-NULL */
4234 /* I hereby declare this connection open. May God bless all who cross
4238 abort_tidy_up_and_fail:
4239 errno = ECONNABORTED;
4243 if (sockets[0] != -1)
4244 PerlLIO_close(sockets[0]);
4245 if (sockets[1] != -1)
4246 PerlLIO_close(sockets[1]);
4251 #endif /* EMULATE_SOCKETPAIR_UDP */
4253 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4255 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4256 /* Stevens says that family must be AF_LOCAL, protocol 0.
4257 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4262 struct sockaddr_in listen_addr;
4263 struct sockaddr_in connect_addr;
4268 || family != AF_UNIX
4271 errno = EAFNOSUPPORT;
4279 #ifdef EMULATE_SOCKETPAIR_UDP
4280 if (type == SOCK_DGRAM)
4281 return S_socketpair_udp(fd);
4284 aTHXa(PERL_GET_THX);
4285 listener = PerlSock_socket(AF_INET, type, 0);
4288 memset(&listen_addr, 0, sizeof(listen_addr));
4289 listen_addr.sin_family = AF_INET;
4290 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4291 listen_addr.sin_port = 0; /* kernel choses port. */
4292 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4293 sizeof(listen_addr)) == -1)
4294 goto tidy_up_and_fail;
4295 if (PerlSock_listen(listener, 1) == -1)
4296 goto tidy_up_and_fail;
4298 connector = PerlSock_socket(AF_INET, type, 0);
4299 if (connector == -1)
4300 goto tidy_up_and_fail;
4301 /* We want to find out the port number to connect to. */
4302 size = sizeof(connect_addr);
4303 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4305 goto tidy_up_and_fail;
4306 if (size != sizeof(connect_addr))
4307 goto abort_tidy_up_and_fail;
4308 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4309 sizeof(connect_addr)) == -1)
4310 goto tidy_up_and_fail;
4312 size = sizeof(listen_addr);
4313 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4316 goto tidy_up_and_fail;
4317 if (size != sizeof(listen_addr))
4318 goto abort_tidy_up_and_fail;
4319 PerlLIO_close(listener);
4320 /* Now check we are talking to ourself by matching port and host on the
4322 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4324 goto tidy_up_and_fail;
4325 if (size != sizeof(connect_addr)
4326 || listen_addr.sin_family != connect_addr.sin_family
4327 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4328 || listen_addr.sin_port != connect_addr.sin_port) {
4329 goto abort_tidy_up_and_fail;
4335 abort_tidy_up_and_fail:
4337 errno = ECONNABORTED; /* This would be the standard thing to do. */
4339 # ifdef ECONNREFUSED
4340 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4342 errno = ETIMEDOUT; /* Desperation time. */
4349 PerlLIO_close(listener);
4350 if (connector != -1)
4351 PerlLIO_close(connector);
4353 PerlLIO_close(acceptor);
4359 /* In any case have a stub so that there's code corresponding
4360 * to the my_socketpair in embed.fnc. */
4362 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4363 #ifdef HAS_SOCKETPAIR
4364 return socketpair(family, type, protocol, fd);
4373 =for apidoc sv_nosharing
4375 Dummy routine which "shares" an SV when there is no sharing module present.
4376 Or "locks" it. Or "unlocks" it. In other
4377 words, ignores its single SV argument.
4378 Exists to avoid test for a NULL function pointer and because it could
4379 potentially warn under some level of strict-ness.
4385 Perl_sv_nosharing(pTHX_ SV *sv)
4387 PERL_UNUSED_CONTEXT;
4388 PERL_UNUSED_ARG(sv);
4393 =for apidoc sv_destroyable
4395 Dummy routine which reports that object can be destroyed when there is no
4396 sharing module present. It ignores its single SV argument, and returns
4397 'true'. Exists to avoid test for a NULL function pointer and because it
4398 could potentially warn under some level of strict-ness.
4404 Perl_sv_destroyable(pTHX_ SV *sv)
4406 PERL_UNUSED_CONTEXT;
4407 PERL_UNUSED_ARG(sv);
4412 Perl_parse_unicode_opts(pTHX_ const char **popt)
4414 const char *p = *popt;
4417 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4423 if (grok_atoUV(p, &uv, &endptr)
4426 && *p && *p != '\n' && *p != '\r'
4430 goto the_end_of_the_opts_parser;
4432 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4438 case PERL_UNICODE_STDIN:
4439 opt |= PERL_UNICODE_STDIN_FLAG; break;
4440 case PERL_UNICODE_STDOUT:
4441 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4442 case PERL_UNICODE_STDERR:
4443 opt |= PERL_UNICODE_STDERR_FLAG; break;
4444 case PERL_UNICODE_STD:
4445 opt |= PERL_UNICODE_STD_FLAG; break;
4446 case PERL_UNICODE_IN:
4447 opt |= PERL_UNICODE_IN_FLAG; break;
4448 case PERL_UNICODE_OUT:
4449 opt |= PERL_UNICODE_OUT_FLAG; break;
4450 case PERL_UNICODE_INOUT:
4451 opt |= PERL_UNICODE_INOUT_FLAG; break;
4452 case PERL_UNICODE_LOCALE:
4453 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4454 case PERL_UNICODE_ARGV:
4455 opt |= PERL_UNICODE_ARGV_FLAG; break;
4456 case PERL_UNICODE_UTF8CACHEASSERT:
4457 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4459 if (*p != '\n' && *p != '\r') {
4460 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4463 "Unknown Unicode option letter '%c'", *p);
4470 opt = PERL_UNICODE_DEFAULT_FLAGS;
4472 the_end_of_the_opts_parser:
4474 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4475 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
4476 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4484 # include <starlet.h>
4491 * This is really just a quick hack which grabs various garbage
4492 * values. It really should be a real hash algorithm which
4493 * spreads the effect of every input bit onto every output bit,
4494 * if someone who knows about such things would bother to write it.
4495 * Might be a good idea to add that function to CORE as well.
4496 * No numbers below come from careful analysis or anything here,
4497 * except they are primes and SEED_C1 > 1E6 to get a full-width
4498 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4499 * probably be bigger too.
4502 # define SEED_C1 1000003
4503 #define SEED_C4 73819
4505 # define SEED_C1 25747
4506 #define SEED_C4 20639
4510 #define SEED_C5 26107
4512 #ifndef PERL_NO_DEV_RANDOM
4517 /* when[] = (low 32 bits, high 32 bits) of time since epoch
4518 * in 100-ns units, typically incremented ever 10 ms. */
4519 unsigned int when[2];
4521 # ifdef HAS_GETTIMEOFDAY
4522 struct timeval when;
4528 /* This test is an escape hatch, this symbol isn't set by Configure. */
4529 #ifndef PERL_NO_DEV_RANDOM
4530 #ifndef PERL_RANDOM_DEVICE
4531 /* /dev/random isn't used by default because reads from it will block
4532 * if there isn't enough entropy available. You can compile with
4533 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4534 * is enough real entropy to fill the seed. */
4535 # define PERL_RANDOM_DEVICE "/dev/urandom"
4537 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4539 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4548 _ckvmssts(sys$gettim(when));
4549 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
4551 # ifdef HAS_GETTIMEOFDAY
4552 PerlProc_gettimeofday(&when,NULL);
4553 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4556 u = (U32)SEED_C1 * when;
4559 u += SEED_C3 * (U32)PerlProc_getpid();
4560 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4561 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4562 u += SEED_C5 * (U32)PTR2UV(&when);
4568 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4573 PERL_ARGS_ASSERT_GET_HASH_SEED;
4575 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4578 #ifndef USE_HASH_SEED_EXPLICIT
4580 /* ignore leading spaces */
4581 while (isSPACE(*env_pv))
4583 #ifdef USE_PERL_PERTURB_KEYS
4584 /* if they set it to "0" we disable key traversal randomization completely */
4585 if (strEQ(env_pv,"0")) {
4586 PL_hash_rand_bits_enabled= 0;
4588 /* otherwise switch to deterministic mode */
4589 PL_hash_rand_bits_enabled= 2;
4592 /* ignore a leading 0x... if it is there */
4593 if (env_pv[0] == '0' && env_pv[1] == 'x')
4596 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4597 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4598 if ( isXDIGIT(*env_pv)) {
4599 seed_buffer[i] |= READ_XDIGIT(env_pv);
4602 while (isSPACE(*env_pv))
4605 if (*env_pv && !isXDIGIT(*env_pv)) {
4606 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4608 /* should we check for unparsed crap? */
4609 /* should we warn about unused hex? */
4610 /* should we warn about insufficient hex? */
4615 (void)seedDrand01((Rand_seed_t)seed());
4617 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4618 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4621 #ifdef USE_PERL_PERTURB_KEYS
4622 { /* initialize PL_hash_rand_bits from the hash seed.
4623 * This value is highly volatile, it is updated every
4624 * hash insert, and is used as part of hash bucket chain
4625 * randomization and hash iterator randomization. */
4626 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4627 for( i = 0; i < sizeof(UV) ; i++ ) {
4628 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4629 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4632 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4634 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4635 PL_hash_rand_bits_enabled= 0;
4636 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4637 PL_hash_rand_bits_enabled= 1;
4638 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4639 PL_hash_rand_bits_enabled= 2;
4641 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4647 #ifdef PERL_GLOBAL_STRUCT
4649 #define PERL_GLOBAL_STRUCT_INIT
4650 #include "opcode.h" /* the ppaddr and check */
4653 Perl_init_global_struct(pTHX)
4655 struct perl_vars *plvarsp = NULL;
4656 # ifdef PERL_GLOBAL_STRUCT
4657 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4658 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4659 PERL_UNUSED_CONTEXT;
4660 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4661 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4662 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4666 plvarsp = PL_VarsPtr;
4667 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4672 # define PERLVAR(prefix,var,type) /**/
4673 # define PERLVARA(prefix,var,n,type) /**/
4674 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4675 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4676 # include "perlvars.h"
4681 # ifdef PERL_GLOBAL_STRUCT
4684 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4685 if (!plvarsp->Gppaddr)
4689 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4690 if (!plvarsp->Gcheck)
4692 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4693 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4695 # ifdef PERL_SET_VARS
4696 PERL_SET_VARS(plvarsp);
4698 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4699 plvarsp->Gsv_placeholder.sv_flags = 0;
4700 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4702 # undef PERL_GLOBAL_STRUCT_INIT
4707 #endif /* PERL_GLOBAL_STRUCT */
4709 #ifdef PERL_GLOBAL_STRUCT
4712 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4714 int veto = plvarsp->Gveto_cleanup;
4716 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4717 PERL_UNUSED_CONTEXT;
4718 # ifdef PERL_GLOBAL_STRUCT
4719 # ifdef PERL_UNSET_VARS
4720 PERL_UNSET_VARS(plvarsp);
4724 free(plvarsp->Gppaddr);
4725 free(plvarsp->Gcheck);
4726 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4732 #endif /* PERL_GLOBAL_STRUCT */
4736 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4737 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4738 * given, and you supply your own implementation.
4740 * The default implementation reads a single env var, PERL_MEM_LOG,
4741 * expecting one or more of the following:
4743 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4744 * 'm' - memlog was PERL_MEM_LOG=1
4745 * 's' - svlog was PERL_SV_LOG=1
4746 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4748 * This makes the logger controllable enough that it can reasonably be
4749 * added to the system perl.
4752 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4753 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4755 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4757 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4758 * writes to. In the default logger, this is settable at runtime.
4760 #ifndef PERL_MEM_LOG_FD
4761 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4764 #ifndef PERL_MEM_LOG_NOIMPL
4766 # ifdef DEBUG_LEAKING_SCALARS
4767 # define SV_LOG_SERIAL_FMT " [%lu]"
4768 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4770 # define SV_LOG_SERIAL_FMT
4771 # define _SV_LOG_SERIAL_ARG(sv)
4775 S_mem_log_common(enum mem_log_type mlt, const UV n,
4776 const UV typesize, const char *type_name, const SV *sv,
4777 Malloc_t oldalloc, Malloc_t newalloc,
4778 const char *filename, const int linenumber,
4779 const char *funcname)
4783 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4785 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4788 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4790 /* We can't use SVs or PerlIO for obvious reasons,
4791 * so we'll use stdio and low-level IO instead. */
4792 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4794 # ifdef HAS_GETTIMEOFDAY
4795 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4796 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4798 gettimeofday(&tv, 0);
4800 # define MEM_LOG_TIME_FMT "%10d: "
4801 # define MEM_LOG_TIME_ARG (int)when
4805 /* If there are other OS specific ways of hires time than
4806 * gettimeofday() (see ext/Time-HiRes), the easiest way is
4807 * probably that they would be used to fill in the struct
4814 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4815 && uv && uv <= PERL_INT_MAX
4819 fd = PERL_MEM_LOG_FD;
4822 if (strchr(pmlenv, 't')) {
4823 len = my_snprintf(buf, sizeof(buf),
4824 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4825 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4829 len = my_snprintf(buf, sizeof(buf),
4830 "alloc: %s:%d:%s: %"IVdf" %"UVuf
4831 " %s = %"IVdf": %"UVxf"\n",
4832 filename, linenumber, funcname, n, typesize,
4833 type_name, n * typesize, PTR2UV(newalloc));
4836 len = my_snprintf(buf, sizeof(buf),
4837 "realloc: %s:%d:%s: %"IVdf" %"UVuf
4838 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
4839 filename, linenumber, funcname, n, typesize,
4840 type_name, n * typesize, PTR2UV(oldalloc),
4844 len = my_snprintf(buf, sizeof(buf),
4845 "free: %s:%d:%s: %"UVxf"\n",
4846 filename, linenumber, funcname,
4851 len = my_snprintf(buf, sizeof(buf),
4852 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
4853 mlt == MLT_NEW_SV ? "new" : "del",
4854 filename, linenumber, funcname,
4855 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4860 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4864 #endif /* !PERL_MEM_LOG_NOIMPL */
4866 #ifndef PERL_MEM_LOG_NOIMPL
4868 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4869 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4871 /* this is suboptimal, but bug compatible. User is providing their
4872 own implementation, but is getting these functions anyway, and they
4873 do nothing. But _NOIMPL users should be able to cope or fix */
4875 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4876 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4880 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4882 const char *filename, const int linenumber,
4883 const char *funcname)
4885 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4886 NULL, NULL, newalloc,
4887 filename, linenumber, funcname);
4892 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4893 Malloc_t oldalloc, Malloc_t newalloc,
4894 const char *filename, const int linenumber,
4895 const char *funcname)
4897 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4898 NULL, oldalloc, newalloc,
4899 filename, linenumber, funcname);
4904 Perl_mem_log_free(Malloc_t oldalloc,
4905 const char *filename, const int linenumber,
4906 const char *funcname)
4908 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4909 filename, linenumber, funcname);
4914 Perl_mem_log_new_sv(const SV *sv,
4915 const char *filename, const int linenumber,
4916 const char *funcname)
4918 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4919 filename, linenumber, funcname);
4923 Perl_mem_log_del_sv(const SV *sv,
4924 const char *filename, const int linenumber,
4925 const char *funcname)
4927 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4928 filename, linenumber, funcname);
4931 #endif /* PERL_MEM_LOG */
4934 =for apidoc my_sprintf
4936 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
4937 the length of the string written to the buffer. Only rare pre-ANSI systems
4938 need the wrapper function - usually this is a direct call to C<sprintf>.
4942 #ifndef SPRINTF_RETURNS_STRLEN
4944 Perl_my_sprintf(char *buffer, const char* pat, ...)
4947 PERL_ARGS_ASSERT_MY_SPRINTF;
4948 va_start(args, pat);
4949 vsprintf(buffer, pat, args);
4951 return strlen(buffer);
4956 =for apidoc quadmath_format_single
4958 quadmath_snprintf() is very strict about its format string and will
4959 fail, returning -1, if the format is invalid. It acccepts exactly
4962 quadmath_format_single() checks that the intended single spec looks
4963 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4964 and has C<Q> before it. This is not a full "printf syntax check",
4967 Returns the format if it is valid, NULL if not.
4969 quadmath_format_single() can and will actually patch in the missing
4970 C<Q>, if necessary. In this case it will return the modified copy of
4971 the format, B<which the caller will need to free.>
4973 See also L</quadmath_format_needed>.
4979 Perl_quadmath_format_single(const char* format)
4983 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4985 if (format[0] != '%' || strchr(format + 1, '%'))
4987 len = strlen(format);
4988 /* minimum length three: %Qg */
4989 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4991 if (format[len - 2] != 'Q') {
4993 Newx(fixed, len + 1, char);
4994 memcpy(fixed, format, len - 1);
4995 fixed[len - 1] = 'Q';
4996 fixed[len ] = format[len - 1];
4998 return (const char*)fixed;
5005 =for apidoc quadmath_format_needed
5007 quadmath_format_needed() returns true if the format string seems to
5008 contain at least one non-Q-prefixed %[efgaEFGA] format specifier,
5009 or returns false otherwise.
5011 The format specifier detection is not complete printf-syntax detection,
5012 but it should catch most common cases.
5014 If true is returned, those arguments B<should> in theory be processed
5015 with quadmath_snprintf(), but in case there is more than one such
5016 format specifier (see L</quadmath_format_single>), and if there is
5017 anything else beyond that one (even just a single byte), they
5018 B<cannot> be processed because quadmath_snprintf() is very strict,
5019 accepting only one format spec, and nothing else.
5020 In this case, the code should probably fail.
5026 Perl_quadmath_format_needed(const char* format)
5028 const char *p = format;
5031 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5033 while ((q = strchr(p, '%'))) {
5035 if (*q == '+') /* plus */
5037 if (*q == '#') /* alt */
5039 if (*q == '*') /* width */
5043 while (isDIGIT(*q)) q++;
5046 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5051 while (isDIGIT(*q)) q++;
5053 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5062 =for apidoc my_snprintf
5064 The C library C<snprintf> functionality, if available and
5065 standards-compliant (uses C<vsnprintf>, actually). However, if the
5066 C<vsnprintf> is not available, will unfortunately use the unsafe
5067 C<vsprintf> which can overrun the buffer (there is an overrun check,
5068 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5069 getting C<vsnprintf>.
5074 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5078 PERL_ARGS_ASSERT_MY_SNPRINTF;
5079 #ifndef HAS_VSNPRINTF
5080 PERL_UNUSED_VAR(len);
5082 va_start(ap, format);
5085 const char* qfmt = quadmath_format_single(format);
5086 bool quadmath_valid = FALSE;
5088 /* If the format looked promising, use it as quadmath. */
5089 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5091 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5092 quadmath_valid = TRUE;
5097 assert(qfmt == NULL);
5098 /* quadmath_format_single() will return false for example for
5099 * "foo = %g", or simply "%g". We could handle the %g by
5100 * using quadmath for the NV args. More complex cases of
5101 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5102 * quadmath-valid but has stuff in front).
5104 * Handling the "Q-less" cases right would require walking
5105 * through the va_list and rewriting the format, calling
5106 * quadmath for the NVs, building a new va_list, and then
5107 * letting vsnprintf/vsprintf to take care of the other
5108 * arguments. This may be doable.
5110 * We do not attempt that now. But for paranoia, we here try
5111 * to detect some common (but not all) cases where the
5112 * "Q-less" %[efgaEFGA] formats are present, and die if
5113 * detected. This doesn't fix the problem, but it stops the
5114 * vsnprintf/vsprintf pulling doubles off the va_list when
5115 * __float128 NVs should be pulled off instead.
5117 * If quadmath_format_needed() returns false, we are reasonably
5118 * certain that we can call vnsprintf() or vsprintf() safely. */
5119 if (!quadmath_valid && quadmath_format_needed(format))
5120 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5125 #ifdef HAS_VSNPRINTF
5126 retval = vsnprintf(buffer, len, format, ap);
5128 retval = vsprintf(buffer, format, ap);
5131 /* vsprintf() shows failure with < 0 */
5133 #ifdef HAS_VSNPRINTF
5134 /* vsnprintf() shows failure with >= len */
5136 (len > 0 && (Size_t)retval >= len)
5139 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5144 =for apidoc my_vsnprintf
5146 The C library C<vsnprintf> if available and standards-compliant.
5147 However, if if the C<vsnprintf> is not available, will unfortunately
5148 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5149 overrun check, but that may be too late). Consider using
5150 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5155 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5158 PERL_UNUSED_ARG(buffer);
5159 PERL_UNUSED_ARG(len);
5160 PERL_UNUSED_ARG(format);
5161 PERL_UNUSED_ARG(ap);
5162 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5169 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5170 #ifndef HAS_VSNPRINTF
5171 PERL_UNUSED_VAR(len);
5173 Perl_va_copy(ap, apc);
5174 # ifdef HAS_VSNPRINTF
5175 retval = vsnprintf(buffer, len, format, apc);
5177 retval = vsprintf(buffer, format, apc);
5181 # ifdef HAS_VSNPRINTF
5182 retval = vsnprintf(buffer, len, format, ap);
5184 retval = vsprintf(buffer, format, ap);
5186 #endif /* #ifdef NEED_VA_COPY */
5187 /* vsprintf() shows failure with < 0 */
5189 #ifdef HAS_VSNPRINTF
5190 /* vsnprintf() shows failure with >= len */
5192 (len > 0 && (Size_t)retval >= len)
5195 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5201 Perl_my_clearenv(pTHX)
5204 #if ! defined(PERL_MICRO)
5205 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5207 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5208 # if defined(USE_ENVIRON_ARRAY)
5209 # if defined(USE_ITHREADS)
5210 /* only the parent thread can clobber the process environment */
5211 if (PL_curinterp == aTHX)
5212 # endif /* USE_ITHREADS */
5214 # if ! defined(PERL_USE_SAFE_PUTENV)
5215 if ( !PL_use_safe_putenv) {
5217 if (environ == PL_origenviron)
5218 environ = (char**)safesysmalloc(sizeof(char*));
5220 for (i = 0; environ[i]; i++)
5221 (void)safesysfree(environ[i]);
5224 # else /* PERL_USE_SAFE_PUTENV */
5225 # if defined(HAS_CLEARENV)
5227 # elif defined(HAS_UNSETENV)
5228 int bsiz = 80; /* Most envvar names will be shorter than this. */
5229 char *buf = (char*)safesysmalloc(bsiz);
5230 while (*environ != NULL) {
5231 char *e = strchr(*environ, '=');
5232 int l = e ? e - *environ : (int)strlen(*environ);
5234 (void)safesysfree(buf);
5235 bsiz = l + 1; /* + 1 for the \0. */
5236 buf = (char*)safesysmalloc(bsiz);
5238 memcpy(buf, *environ, l);
5240 (void)unsetenv(buf);
5242 (void)safesysfree(buf);
5243 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5244 /* Just null environ and accept the leakage. */
5246 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5247 # endif /* ! PERL_USE_SAFE_PUTENV */
5249 # endif /* USE_ENVIRON_ARRAY */
5250 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5251 #endif /* PERL_MICRO */
5254 #ifdef PERL_IMPLICIT_CONTEXT
5256 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5257 the global PL_my_cxt_index is incremented, and that value is assigned to
5258 that module's static my_cxt_index (who's address is passed as an arg).
5259 Then, for each interpreter this function is called for, it makes sure a
5260 void* slot is available to hang the static data off, by allocating or
5261 extending the interpreter's PL_my_cxt_list array */
5263 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5265 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5269 PERL_ARGS_ASSERT_MY_CXT_INIT;
5271 /* this module hasn't been allocated an index yet */
5272 #if defined(USE_ITHREADS)
5273 MUTEX_LOCK(&PL_my_ctx_mutex);
5275 *index = PL_my_cxt_index++;
5276 #if defined(USE_ITHREADS)
5277 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5281 /* make sure the array is big enough */
5282 if (PL_my_cxt_size <= *index) {
5283 if (PL_my_cxt_size) {
5284 while (PL_my_cxt_size <= *index)
5285 PL_my_cxt_size *= 2;
5286 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5289 PL_my_cxt_size = 16;
5290 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5293 /* newSV() allocates one more than needed */
5294 p = (void*)SvPVX(newSV(size-1));
5295 PL_my_cxt_list[*index] = p;
5296 Zero(p, size, char);
5300 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5303 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5308 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5310 for (index = 0; index < PL_my_cxt_index; index++) {
5311 const char *key = PL_my_cxt_keys[index];
5312 /* try direct pointer compare first - there are chances to success,
5313 * and it's much faster.
5315 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5322 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5328 PERL_ARGS_ASSERT_MY_CXT_INIT;
5330 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5332 /* this module hasn't been allocated an index yet */
5333 #if defined(USE_ITHREADS)
5334 MUTEX_LOCK(&PL_my_ctx_mutex);
5336 index = PL_my_cxt_index++;
5337 #if defined(USE_ITHREADS)
5338 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5342 /* make sure the array is big enough */
5343 if (PL_my_cxt_size <= index) {
5344 int old_size = PL_my_cxt_size;
5346 if (PL_my_cxt_size) {
5347 while (PL_my_cxt_size <= index)
5348 PL_my_cxt_size *= 2;
5349 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5350 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5353 PL_my_cxt_size = 16;
5354 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5355 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5357 for (i = old_size; i < PL_my_cxt_size; i++) {
5358 PL_my_cxt_keys[i] = 0;
5359 PL_my_cxt_list[i] = 0;
5362 PL_my_cxt_keys[index] = my_cxt_key;
5363 /* newSV() allocates one more than needed */
5364 p = (void*)SvPVX(newSV(size-1));
5365 PL_my_cxt_list[index] = p;
5366 Zero(p, size, char);
5369 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5370 #endif /* PERL_IMPLICIT_CONTEXT */
5373 /* Perl_xs_handshake():
5374 implement the various XS_*_BOOTCHECK macros, which are added to .c
5375 files by ExtUtils::ParseXS, to check that the perl the module was built
5376 with is binary compatible with the running perl.
5379 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5380 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5382 The meaning of the varargs is determined the U32 key arg (which is not
5383 a format string). The fields of key are assembled by using HS_KEY().
5385 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5386 "PerlInterpreter *" and represents the callers context; otherwise it is
5387 of type "CV *", and is the boot xsub's CV.
5389 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5390 for example, and IO.dll was linked with threaded perl524.dll, and both
5391 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5392 successfully can load IO.dll into the process but simultaneously it
5393 loaded an interpreter of a different version into the process, and XS
5394 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5395 use through perl526.dll's my_perl->Istack_base.
5397 v_my_perl cannot be the first arg, since then 'key' will be out of
5398 place in a threaded vs non-threaded mixup; and analyzing the key
5399 number's bitfields won't reveal the problem, since it will be a valid
5400 key (unthreaded perl) on interp side, but croak will report the XS mod's
5401 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5402 it's a threaded perl and an unthreaded XS module, threaded perl will
5403 look at an uninit C stack or an uninit register to get 'key'
5404 (remember that it assumes that the 1st arg is the interp cxt).
5406 'file' is the source filename of the caller.
5410 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5416 #ifdef PERL_IMPLICIT_CONTEXT
5423 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5424 va_start(args, file);
5426 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5427 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5428 if (UNLIKELY(got != need))
5430 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5431 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5432 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5433 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5434 passed to the XS DLL */
5435 #ifdef PERL_IMPLICIT_CONTEXT
5436 xs_interp = (tTHX)v_my_perl;
5440 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5441 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5442 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5443 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5444 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5445 location in the unthreaded perl binary) stored in CV * to figure out if this
5446 Perl_xs_handshake was called by the same pp_entersub */
5447 cv = (CV*)v_my_perl;
5448 xs_spp = (SV***)CvHSCXT(cv);
5450 need = &PL_stack_sp;
5452 if(UNLIKELY(got != need)) {
5453 bad_handshake:/* recycle branch and string from above */
5454 if(got != (void *)HSf_NOCHK)
5455 noperl_die("%s: loadable library and perl binaries are mismatched"
5456 " (got handshake key %p, needed %p)\n",
5460 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5461 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5462 PL_xsubfilename = file; /* so the old name must be restored for
5463 additional XSUBs to register themselves */
5464 (void)gv_fetchfile(file);
5467 if(key & HSf_POPMARK) {
5469 { SV **mark = PL_stack_base + ax++;
5471 items = (I32)(SP - MARK);
5475 items = va_arg(args, U32);
5476 ax = va_arg(args, U32);
5480 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5481 if((apiverlen = HS_GETAPIVERLEN(key))) {
5482 char * api_p = va_arg(args, char*);
5483 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5484 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5485 sizeof("v" PERL_API_VERSION_STRING)-1))
5486 Perl_croak_nocontext("Perl API version %s of %"SVf" does not match %s",
5487 api_p, SVfARG(PL_stack_base[ax + 0]),
5488 "v" PERL_API_VERSION_STRING);
5493 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5494 if((xsverlen = HS_GETXSVERLEN(key)))
5495 S_xs_version_bootcheck(aTHX_
5496 items, ax, va_arg(args, char*), xsverlen);
5504 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5508 const char *vn = NULL;
5509 SV *const module = PL_stack_base[ax];
5511 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5513 if (items >= 2) /* version supplied as bootstrap arg */
5514 sv = PL_stack_base[ax + 1];
5516 /* XXX GV_ADDWARN */
5518 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5519 if (!sv || !SvOK(sv)) {
5521 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5525 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5526 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5527 ? sv : sv_2mortal(new_version(sv));
5528 xssv = upg_version(xssv, 0);
5529 if ( vcmp(pmsv,xssv) ) {
5530 SV *string = vstringify(xssv);
5531 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5532 " does not match ", SVfARG(module), SVfARG(string));
5534 SvREFCNT_dec(string);
5535 string = vstringify(pmsv);
5538 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, SVfARG(module), vn,
5541 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, SVfARG(string));
5543 SvREFCNT_dec(string);
5545 Perl_sv_2mortal(aTHX_ xpt);
5546 Perl_croak_sv(aTHX_ xpt);
5552 =for apidoc my_strlcat
5554 The C library C<strlcat> if available, or a Perl implementation of it.
5555 This operates on C C<NUL>-terminated strings.
5557 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5558 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5559 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5560 practice this should not happen as it means that either C<size> is incorrect or
5561 that C<dst> is not a proper C<NUL>-terminated string).
5563 Note that C<size> is the full size of the destination buffer and
5564 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5565 room for the C<NUL> should be included in C<size>.
5569 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcat
5573 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5575 Size_t used, length, copy;
5578 length = strlen(src);
5579 if (size > 0 && used < size - 1) {
5580 copy = (length >= size - used) ? size - used - 1 : length;
5581 memcpy(dst + used, src, copy);
5582 dst[used + copy] = '\0';
5584 return used + length;
5590 =for apidoc my_strlcpy
5592 The C library C<strlcpy> if available, or a Perl implementation of it.
5593 This operates on C C<NUL>-terminated strings.
5595 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5596 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5600 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy
5604 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5606 Size_t length, copy;
5608 length = strlen(src);
5610 copy = (length >= size) ? size - 1 : length;
5611 memcpy(dst, src, copy);
5618 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5619 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5620 long _ftol( double ); /* Defined by VC6 C libs. */
5621 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5624 PERL_STATIC_INLINE bool
5625 S_gv_has_usable_name(pTHX_ GV *gv)
5629 && HvENAME(GvSTASH(gv))
5630 && (gvp = (GV **)hv_fetchhek(
5631 GvSTASH(gv), GvNAME_HEK(gv), 0
5637 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5639 SV * const dbsv = GvSVn(PL_DBsub);
5640 const bool save_taint = TAINT_get;
5642 /* When we are called from pp_goto (svp is null),
5643 * we do not care about using dbsv to call CV;
5644 * it's for informational purposes only.
5647 PERL_ARGS_ASSERT_GET_DB_SUB;
5651 if (!PERLDB_SUB_NN) {
5654 if (!svp && !CvLEXICAL(cv)) {
5655 gv_efullname3(dbsv, gv, NULL);
5657 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5658 || strEQ(GvNAME(gv), "END")
5659 || ( /* Could be imported, and old sub redefined. */
5660 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5662 !( (SvTYPE(*svp) == SVt_PVGV)
5663 && (GvCV((const GV *)*svp) == cv)
5664 /* Use GV from the stack as a fallback. */
5665 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5669 /* GV is potentially non-unique, or contain different CV. */
5670 SV * const tmp = newRV(MUTABLE_SV(cv));
5671 sv_setsv(dbsv, tmp);
5675 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5676 sv_catpvs(dbsv, "::");
5677 sv_cathek(dbsv, GvNAME_HEK(gv));
5681 const int type = SvTYPE(dbsv);
5682 if (type < SVt_PVIV && type != SVt_IV)
5683 sv_upgrade(dbsv, SVt_PVIV);
5684 (void)SvIOK_on(dbsv);
5685 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5688 TAINT_IF(save_taint);
5689 #ifdef NO_TAINT_SUPPORT
5690 PERL_UNUSED_VAR(save_taint);
5695 Perl_my_dirfd(DIR * dir) {
5697 /* Most dirfd implementations have problems when passed NULL. */
5702 #elif defined(HAS_DIR_DD_FD)
5705 Perl_croak_nocontext(PL_no_func, "dirfd");
5706 NOT_REACHED; /* NOTREACHED */
5712 Perl_get_re_arg(pTHX_ SV *sv) {
5718 sv = MUTABLE_SV(SvRV(sv));
5719 if (SvTYPE(sv) == SVt_REGEXP)
5720 return (REGEXP*) sv;
5727 * This code is derived from drand48() implementation from FreeBSD,
5728 * found in lib/libc/gen/_rand48.c.
5730 * The U64 implementation is original, based on the POSIX
5731 * specification for drand48().
5735 * Copyright (c) 1993 Martin Birgmeier
5736 * All rights reserved.
5738 * You may redistribute unmodified or modified versions of this source
5739 * code provided that the above copyright notice and this and the
5740 * following conditions are retained.
5742 * This software is provided ``as is'', and comes with no warranties
5743 * of any kind. I shall in no event be liable for anything that happens
5744 * to anyone/anything when using this software.
5747 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5749 #ifdef PERL_DRAND48_QUAD
5751 #define DRAND48_MULT U64_CONST(0x5deece66d)
5752 #define DRAND48_ADD 0xb
5753 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5757 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5758 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5759 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5760 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5761 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5762 #define FREEBSD_DRAND48_ADD (0x000b)
5764 const unsigned short _rand48_mult[3] = {
5765 FREEBSD_DRAND48_MULT_0,
5766 FREEBSD_DRAND48_MULT_1,
5767 FREEBSD_DRAND48_MULT_2
5769 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5774 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5776 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5778 #ifdef PERL_DRAND48_QUAD
5779 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64TYPE)seed << 16);
5781 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5782 random_state->seed[1] = (U16) seed;
5783 random_state->seed[2] = (U16) (seed >> 16);
5788 Perl_drand48_r(perl_drand48_t *random_state)
5790 PERL_ARGS_ASSERT_DRAND48_R;
5792 #ifdef PERL_DRAND48_QUAD
5793 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5796 return ldexp((double)*random_state, -48);
5802 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5803 + (U32) _rand48_add;
5804 temp[0] = (U16) accu; /* lower 16 bits */
5805 accu >>= sizeof(U16) * 8;
5806 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5807 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5808 temp[1] = (U16) accu; /* middle 16 bits */
5809 accu >>= sizeof(U16) * 8;
5810 accu += _rand48_mult[0] * random_state->seed[2]
5811 + _rand48_mult[1] * random_state->seed[1]
5812 + _rand48_mult[2] * random_state->seed[0];
5813 random_state->seed[0] = temp[0];
5814 random_state->seed[1] = temp[1];
5815 random_state->seed[2] = (U16) accu;
5817 return ldexp((double) random_state->seed[0], -48) +
5818 ldexp((double) random_state->seed[1], -32) +
5819 ldexp((double) random_state->seed[2], -16);
5824 #ifdef USE_C_BACKTRACE
5826 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5831 /* abfd is the BFD handle. */
5833 /* bfd_syms is the BFD symbol table. */
5835 /* bfd_text is handle to the the ".text" section of the object file. */
5837 /* Since opening the executable and scanning its symbols is quite
5838 * heavy operation, we remember the filename we used the last time,
5839 * and do the opening and scanning only if the filename changes.
5840 * This removes most (but not all) open+scan cycles. */
5841 const char* fname_prev;
5844 /* Given a dl_info, update the BFD context if necessary. */
5845 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5847 /* BFD open and scan only if the filename changed. */
5848 if (ctx->fname_prev == NULL ||
5849 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5851 bfd_close(ctx->abfd);
5853 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5855 if (bfd_check_format(ctx->abfd, bfd_object)) {
5856 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5857 if (symbol_size > 0) {
5858 Safefree(ctx->bfd_syms);
5859 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5861 bfd_get_section_by_name(ctx->abfd, ".text");
5869 ctx->fname_prev = dl_info->dli_fname;
5873 /* Given a raw frame, try to symbolize it and store
5874 * symbol information (source file, line number) away. */
5875 static void bfd_symbolize(bfd_context* ctx,
5878 STRLEN* symbol_name_size,
5880 STRLEN* source_name_size,
5881 STRLEN* source_line)
5883 *symbol_name = NULL;
5884 *symbol_name_size = 0;
5886 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5888 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5891 unsigned int line = 0;
5892 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5893 ctx->bfd_syms, offset,
5894 &file, &func, &line) &&
5895 file && func && line > 0) {
5896 /* Size and copy the source file, use only
5897 * the basename of the source file.
5899 * NOTE: the basenames are fine for the
5900 * Perl source files, but may not always
5901 * be the best idea for XS files. */
5902 const char *p, *b = NULL;
5903 /* Look for the last slash. */
5904 for (p = file; *p; p++) {
5908 if (b == NULL || *b == 0) {
5911 *source_name_size = p - b + 1;
5912 Newx(*source_name, *source_name_size + 1, char);
5913 Copy(b, *source_name, *source_name_size + 1, char);
5915 *symbol_name_size = strlen(func);
5916 Newx(*symbol_name, *symbol_name_size + 1, char);
5917 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5919 *source_line = line;
5925 #endif /* #ifdef USE_BFD */
5929 /* OS X has no public API for for 'symbolicating' (Apple official term)
5930 * stack addresses to {function_name, source_file, line_number}.
5931 * Good news: there is command line utility atos(1) which does that.
5932 * Bad news 1: it's a command line utility.
5933 * Bad news 2: one needs to have the Developer Tools installed.
5934 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5936 * To recap: we need to open a pipe for reading for a utility which
5937 * might not exist, or exists in different locations, and then parse
5938 * the output. And since this is all for a low-level API, we cannot
5939 * use high-level stuff. Thanks, Apple. */
5942 /* tool is set to the absolute pathname of the tool to use:
5945 /* format is set to a printf format string used for building
5946 * the external command to run. */
5948 /* unavail is set if e.g. xcrun cannot be found, or something
5949 * else happens that makes getting the backtrace dubious. Note,
5950 * however, that the context isn't persistent, the next call to
5951 * get_c_backtrace() will start from scratch. */
5953 /* fname is the current object file name. */
5955 /* object_base_addr is the base address of the shared object. */
5956 void* object_base_addr;
5959 /* Given |dl_info|, updates the context. If the context has been
5960 * marked unavailable, return immediately. If not but the tool has
5961 * not been set, set it to either "xcrun atos" or "atos" (also set the
5962 * format to use for creating commands for piping), or if neither is
5963 * unavailable (one needs the Developer Tools installed), mark the context
5964 * an unavailable. Finally, update the filename (object name),
5965 * and its base address. */
5967 static void atos_update(atos_context* ctx,
5972 if (ctx->tool == NULL) {
5973 const char* tools[] = {
5977 const char* formats[] = {
5978 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5979 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5983 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5984 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5985 ctx->tool = tools[i];
5986 ctx->format = formats[i];
5990 if (ctx->tool == NULL) {
5991 ctx->unavail = TRUE;
5995 if (ctx->fname == NULL ||
5996 strNE(dl_info->dli_fname, ctx->fname)) {
5997 ctx->fname = dl_info->dli_fname;
5998 ctx->object_base_addr = dl_info->dli_fbase;
6002 /* Given an output buffer end |p| and its |start|, matches
6003 * for the atos output, extracting the source code location
6004 * and returning non-NULL if possible, returning NULL otherwise. */
6005 static const char* atos_parse(const char* p,
6007 STRLEN* source_name_size,
6008 STRLEN* source_line) {
6009 /* atos() output is something like:
6010 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6011 * We cannot use Perl regular expressions, because we need to
6012 * stay low-level. Therefore here we have a rolled-out version
6013 * of a state machine which matches _backwards_from_the_end_ and
6014 * if there's a success, returns the starts of the filename,
6015 * also setting the filename size and the source line number.
6016 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6017 const char* source_number_start;
6018 const char* source_name_end;
6019 const char* source_line_end;
6020 const char* close_paren;
6023 /* Skip trailing whitespace. */
6024 while (p > start && isspace(*p)) p--;
6025 /* Now we should be at the close paren. */
6026 if (p == start || *p != ')')
6030 /* Now we should be in the line number. */
6031 if (p == start || !isdigit(*p))
6033 /* Skip over the digits. */
6034 while (p > start && isdigit(*p))
6036 /* Now we should be at the colon. */
6037 if (p == start || *p != ':')
6039 source_number_start = p + 1;
6040 source_name_end = p; /* Just beyond the end. */
6042 /* Look for the open paren. */
6043 while (p > start && *p != '(')
6048 *source_name_size = source_name_end - p;
6049 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6050 && source_line_end == close_paren
6053 *source_line = (STRLEN)uv;
6059 /* Given a raw frame, read a pipe from the symbolicator (that's the
6060 * technical term) atos, reads the result, and parses the source code
6061 * location. We must stay low-level, so we use snprintf(), pipe(),
6062 * and fread(), and then also parse the output ourselves. */
6063 static void atos_symbolize(atos_context* ctx,
6066 STRLEN* source_name_size,
6067 STRLEN* source_line)
6075 /* Simple security measure: if there's any funny business with
6076 * the object name (used as "-o '%s'" ), leave since at least
6077 * partially the user controls it. */
6078 for (p = ctx->fname; *p; p++) {
6079 if (*p == '\'' || iscntrl(*p)) {
6080 ctx->unavail = TRUE;
6084 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6085 ctx->fname, ctx->object_base_addr, raw_frame);
6086 if (cnt < sizeof(cmd)) {
6087 /* Undo nostdio.h #defines that disable stdio.
6088 * This is somewhat naughty, but is used elsewhere
6089 * in the core, and affects only OS X. */
6094 FILE* fp = popen(cmd, "r");
6095 /* At the moment we open a new pipe for each stack frame.
6096 * This is naturally somewhat slow, but hopefully generating
6097 * stack traces is never going to in a performance critical path.
6099 * We could play tricks with atos by batching the stack
6100 * addresses to be resolved: atos can either take multiple
6101 * addresses from the command line, or read addresses from
6102 * a file (though the mess of creating temporary files would
6103 * probably negate much of any possible speedup).
6105 * Normally there are only two objects present in the backtrace:
6106 * perl itself, and the libdyld.dylib. (Note that the object
6107 * filenames contain the full pathname, so perl may not always
6108 * be in the same place.) Whenever the object in the
6109 * backtrace changes, the base address also changes.
6111 * The problem with batching the addresses, though, would be
6112 * matching the results with the addresses: the parsing of
6113 * the results is already painful enough with a single address. */
6116 UV cnt = fread(out, 1, sizeof(out), fp);
6117 if (cnt < sizeof(out)) {
6118 const char* p = atos_parse(out + cnt, out,
6123 *source_name_size + 1, char);
6124 Copy(p, *source_name,
6125 *source_name_size + 1, char);
6133 #endif /* #ifdef PERL_DARWIN */
6136 =for apidoc get_c_backtrace
6138 Collects the backtrace (aka "stacktrace") into a single linear
6139 malloced buffer, which the caller B<must> Perl_free_c_backtrace().
6141 Scans the frames back by depth + skip, then drops the skip innermost,
6142 returning at most depth frames.
6148 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6150 /* Note that here we must stay as low-level as possible: Newx(),
6151 * Copy(), Safefree(); since we may be called from anywhere,
6152 * so we should avoid higher level constructs like SVs or AVs.
6154 * Since we are using safesysmalloc() via Newx(), don't try
6155 * getting backtrace() there, unless you like deep recursion. */
6157 /* Currently only implemented with backtrace() and dladdr(),
6158 * for other platforms NULL is returned. */
6160 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6161 /* backtrace() is available via <execinfo.h> in glibc and in most
6162 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6164 /* We try fetching this many frames total, but then discard
6165 * the |skip| first ones. For the remaining ones we will try
6166 * retrieving more information with dladdr(). */
6167 int try_depth = skip + depth;
6169 /* The addresses (program counters) returned by backtrace(). */
6172 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6175 /* Sizes _including_ the terminating \0 of the object name
6176 * and symbol name strings. */
6177 STRLEN* object_name_sizes;
6178 STRLEN* symbol_name_sizes;
6181 /* The symbol names comes either from dli_sname,
6182 * or if using BFD, they can come from BFD. */
6183 char** symbol_names;
6186 /* The source code location information. Dug out with e.g. BFD. */
6187 char** source_names;
6188 STRLEN* source_name_sizes;
6189 STRLEN* source_lines;
6191 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6192 int got_depth; /* How many frames were returned from backtrace(). */
6193 UV frame_count = 0; /* How many frames we return. */
6194 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6197 bfd_context bfd_ctx;
6200 atos_context atos_ctx;
6203 /* Here are probably possibilities for optimizing. We could for
6204 * example have a struct that contains most of these and then
6205 * allocate |try_depth| of them, saving a bunch of malloc calls.
6206 * Note, however, that |frames| could not be part of that struct
6207 * because backtrace() will want an array of just them. Also be
6208 * careful about the name strings. */
6209 Newx(raw_frames, try_depth, void*);
6210 Newx(dl_infos, try_depth, Dl_info);
6211 Newx(object_name_sizes, try_depth, STRLEN);
6212 Newx(symbol_name_sizes, try_depth, STRLEN);
6213 Newx(source_names, try_depth, char*);
6214 Newx(source_name_sizes, try_depth, STRLEN);
6215 Newx(source_lines, try_depth, STRLEN);
6217 Newx(symbol_names, try_depth, char*);
6220 /* Get the raw frames. */
6221 got_depth = (int)backtrace(raw_frames, try_depth);
6223 /* We use dladdr() instead of backtrace_symbols() because we want
6224 * the full details instead of opaque strings. This is useful for
6225 * two reasons: () the details are needed for further symbolic
6226 * digging, for example in OS X (2) by having the details we fully
6227 * control the output, which in turn is useful when more platforms
6228 * are added: we can keep out output "portable". */
6230 /* We want a single linear allocation, which can then be freed
6231 * with a single swoop. We will do the usual trick of first
6232 * walking over the structure and seeing how much we need to
6233 * allocate, then allocating, and then walking over the structure
6234 * the second time and populating it. */
6236 /* First we must compute the total size of the buffer. */
6237 total_bytes = sizeof(Perl_c_backtrace_header);
6238 if (got_depth > skip) {
6241 bfd_init(); /* Is this safe to call multiple times? */
6242 Zero(&bfd_ctx, 1, bfd_context);
6245 Zero(&atos_ctx, 1, atos_context);
6247 for (i = skip; i < try_depth; i++) {
6248 Dl_info* dl_info = &dl_infos[i];
6250 total_bytes += sizeof(Perl_c_backtrace_frame);
6252 source_names[i] = NULL;
6253 source_name_sizes[i] = 0;
6254 source_lines[i] = 0;
6256 /* Yes, zero from dladdr() is failure. */
6257 if (dladdr(raw_frames[i], dl_info)) {
6258 object_name_sizes[i] =
6259 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6260 symbol_name_sizes[i] =
6261 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6263 bfd_update(&bfd_ctx, dl_info);
6264 bfd_symbolize(&bfd_ctx, raw_frames[i],
6266 &symbol_name_sizes[i],
6268 &source_name_sizes[i],
6272 atos_update(&atos_ctx, dl_info);
6273 atos_symbolize(&atos_ctx,
6276 &source_name_sizes[i],
6280 /* Plus ones for the terminating \0. */
6281 total_bytes += object_name_sizes[i] + 1;
6282 total_bytes += symbol_name_sizes[i] + 1;
6283 total_bytes += source_name_sizes[i] + 1;
6291 Safefree(bfd_ctx.bfd_syms);
6295 /* Now we can allocate and populate the result buffer. */
6296 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6297 Zero(bt, total_bytes, char);
6298 bt->header.frame_count = frame_count;
6299 bt->header.total_bytes = total_bytes;
6300 if (frame_count > 0) {
6301 Perl_c_backtrace_frame* frame = bt->frame_info;
6302 char* name_base = (char *)(frame + frame_count);
6303 char* name_curr = name_base; /* Outputting the name strings here. */
6305 for (i = skip; i < skip + frame_count; i++) {
6306 Dl_info* dl_info = &dl_infos[i];
6308 frame->addr = raw_frames[i];
6309 frame->object_base_addr = dl_info->dli_fbase;
6310 frame->symbol_addr = dl_info->dli_saddr;
6312 /* Copies a string, including the \0, and advances the name_curr.
6313 * Also copies the start and the size to the frame. */
6314 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6316 Copy(src, name_curr, size, char); \
6317 frame->doffset = name_curr - (char*)bt; \
6318 frame->dsize = size; \
6319 name_curr += size; \
6322 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6324 object_name_size, object_name_sizes[i]);
6327 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6329 symbol_name_size, symbol_name_sizes[i]);
6330 Safefree(symbol_names[i]);
6332 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6334 symbol_name_size, symbol_name_sizes[i]);
6337 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6339 source_name_size, source_name_sizes[i]);
6340 Safefree(source_names[i]);
6342 #undef PERL_C_BACKTRACE_STRCPY
6344 frame->source_line_number = source_lines[i];
6348 assert(total_bytes ==
6349 (UV)(sizeof(Perl_c_backtrace_header) +
6350 frame_count * sizeof(Perl_c_backtrace_frame) +
6351 name_curr - name_base));
6354 Safefree(symbol_names);
6356 bfd_close(bfd_ctx.abfd);
6359 Safefree(source_lines);
6360 Safefree(source_name_sizes);
6361 Safefree(source_names);
6362 Safefree(symbol_name_sizes);
6363 Safefree(object_name_sizes);
6364 /* Assuming the strings returned by dladdr() are pointers
6365 * to read-only static memory (the object file), so that
6366 * they do not need freeing (and cannot be). */
6368 Safefree(raw_frames);
6371 PERL_UNUSED_ARGV(depth);
6372 PERL_UNUSED_ARGV(skip);
6378 =for apidoc free_c_backtrace
6380 Deallocates a backtrace received from get_c_bracktrace.
6386 =for apidoc get_c_backtrace_dump
6388 Returns a SV a dump of |depth| frames of the call stack, skipping
6389 the |skip| innermost ones. depth of 20 is usually enough.
6391 The appended output looks like:
6394 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6395 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6398 The fields are tab-separated. The first column is the depth (zero
6399 being the innermost non-skipped frame). In the hex:offset, the hex is
6400 where the program counter was in S_parse_body, and the :offset (might
6401 be missing) tells how much inside the S_parse_body the program counter was.
6403 The util.c:1716 is the source code file and line number.
6405 The /usr/bin/perl is obvious (hopefully).
6407 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6408 if the platform doesn't support retrieving the information;
6409 if the binary is missing the debug information;
6410 if the optimizer has transformed the code by for example inlining.
6416 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6418 Perl_c_backtrace* bt;
6420 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6422 Perl_c_backtrace_frame* frame;
6423 SV* dsv = newSVpvs("");
6425 for (i = 0, frame = bt->frame_info;
6426 i < bt->header.frame_count; i++, frame++) {
6427 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6428 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6429 /* Symbol (function) names might disappear without debug info.
6431 * The source code location might disappear in case of the
6432 * optimizer inlining or otherwise rearranging the code. */
6433 if (frame->symbol_addr) {
6434 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6436 ((char*)frame->addr - (char*)frame->symbol_addr));
6438 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6439 frame->symbol_name_size &&
6440 frame->symbol_name_offset ?
6441 (char*)bt + frame->symbol_name_offset : "-");
6442 if (frame->source_name_size &&
6443 frame->source_name_offset &&
6444 frame->source_line_number) {
6445 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%"UVuf,
6446 (char*)bt + frame->source_name_offset,
6447 (UV)frame->source_line_number);
6449 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6451 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6452 frame->object_name_size &&
6453 frame->object_name_offset ?
6454 (char*)bt + frame->object_name_offset : "-");
6455 /* The frame->object_base_addr is not output,
6456 * but it is used for symbolizing/symbolicating. */
6457 sv_catpvs(dsv, "\n");
6460 Perl_free_c_backtrace(aTHX_ bt);
6469 =for apidoc dump_c_backtrace
6471 Dumps the C backtrace to the given fp.
6473 Returns true if a backtrace could be retrieved, false if not.
6479 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6483 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6485 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6488 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6494 #endif /* #ifdef USE_C_BACKTRACE */
6497 * ex: set ts=8 sts=4 sw=4 et: