3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
50 # include <sys/select.h>
54 #ifdef USE_C_BACKTRACE
58 # undef USE_BFD /* BFD is useless in OS X. */
68 # include <execinfo.h>
72 #ifdef PERL_DEBUG_READONLY_COW
73 # include <sys/mman.h>
78 /* NOTE: Do not call the next three routines directly. Use the macros
79 * in handy.h, so that we can easily redefine everything to do tracking of
80 * allocated hunks back to the original New to track down any memory leaks.
81 * XXX This advice seems to be widely ignored :-( --AD August 1996.
84 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
85 # define ALWAYS_NEED_THX
88 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
90 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
93 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
94 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
95 header, header->size, errno);
99 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
102 && mprotect(header, header->size, PROT_READ))
103 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
104 header, header->size, errno);
106 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
107 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
109 # define maybe_protect_rw(foo) NOOP
110 # define maybe_protect_ro(foo) NOOP
113 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
114 /* Use memory_debug_header */
116 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
117 || defined(PERL_DEBUG_READONLY_COW)
118 # define MDH_HAS_SIZE
122 /* paranoid version of system's malloc() */
125 Perl_safesysmalloc(MEM_SIZE size)
127 #ifdef ALWAYS_NEED_THX
131 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
133 if ((SSize_t)size < 0)
134 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
136 if (!size) size = 1; /* malloc(0) is NASTY on our system */
137 #ifdef PERL_DEBUG_READONLY_COW
138 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
139 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
140 perror("mmap failed");
144 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
146 PERL_ALLOC_CHECK(ptr);
149 struct perl_memory_debug_header *const header
150 = (struct perl_memory_debug_header *)ptr;
154 PoisonNew(((char *)ptr), size, char);
157 #ifdef PERL_TRACK_MEMPOOL
158 header->interpreter = aTHX;
159 /* Link us into the list. */
160 header->prev = &PL_memory_debug_header;
161 header->next = PL_memory_debug_header.next;
162 PL_memory_debug_header.next = header;
163 maybe_protect_rw(header->next);
164 header->next->prev = header;
165 maybe_protect_ro(header->next);
166 # ifdef PERL_DEBUG_READONLY_COW
167 header->readonly = 0;
173 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
174 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
178 #ifndef ALWAYS_NEED_THX
189 /* paranoid version of system's realloc() */
192 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
194 #ifdef ALWAYS_NEED_THX
198 #ifdef PERL_DEBUG_READONLY_COW
199 const MEM_SIZE oldsize = where
200 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
203 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
204 Malloc_t PerlMem_realloc();
205 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
212 ptr = safesysmalloc(size);
216 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
217 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
219 struct perl_memory_debug_header *const header
220 = (struct perl_memory_debug_header *)where;
222 # ifdef PERL_TRACK_MEMPOOL
223 if (header->interpreter != aTHX) {
224 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
225 header->interpreter, aTHX);
227 assert(header->next->prev == header);
228 assert(header->prev->next == header);
230 if (header->size > size) {
231 const MEM_SIZE freed_up = header->size - size;
232 char *start_of_freed = ((char *)where) + size;
233 PoisonFree(start_of_freed, freed_up, char);
243 if ((SSize_t)size < 0)
244 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
246 #ifdef PERL_DEBUG_READONLY_COW
247 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
248 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
249 perror("mmap failed");
252 Copy(where,ptr,oldsize < size ? oldsize : size,char);
253 if (munmap(where, oldsize)) {
254 perror("munmap failed");
258 ptr = (Malloc_t)PerlMem_realloc(where,size);
260 PERL_ALLOC_CHECK(ptr);
262 /* MUST do this fixup first, before doing ANYTHING else, as anything else
263 might allocate memory/free/move memory, and until we do the fixup, it
264 may well be chasing (and writing to) free memory. */
266 #ifdef PERL_TRACK_MEMPOOL
267 struct perl_memory_debug_header *const header
268 = (struct perl_memory_debug_header *)ptr;
271 if (header->size < size) {
272 const MEM_SIZE fresh = size - header->size;
273 char *start_of_fresh = ((char *)ptr) + size;
274 PoisonNew(start_of_fresh, fresh, char);
278 maybe_protect_rw(header->next);
279 header->next->prev = header;
280 maybe_protect_ro(header->next);
281 maybe_protect_rw(header->prev);
282 header->prev->next = header;
283 maybe_protect_ro(header->prev);
285 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
288 /* In particular, must do that fixup above before logging anything via
289 *printf(), as it can reallocate memory, which can cause SEGVs. */
291 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
292 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
295 #ifndef ALWAYS_NEED_THX
307 /* safe version of system's free() */
310 Perl_safesysfree(Malloc_t where)
312 #ifdef ALWAYS_NEED_THX
315 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
318 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
320 struct perl_memory_debug_header *const header
321 = (struct perl_memory_debug_header *)where_intrn;
324 const MEM_SIZE size = header->size;
326 # ifdef PERL_TRACK_MEMPOOL
327 if (header->interpreter != aTHX) {
328 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
329 header->interpreter, aTHX);
332 Perl_croak_nocontext("panic: duplicate free");
335 Perl_croak_nocontext("panic: bad free, header->next==NULL");
336 if (header->next->prev != header || header->prev->next != header) {
337 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
338 "header=%p, ->prev->next=%p",
339 header->next->prev, header,
342 /* Unlink us from the chain. */
343 maybe_protect_rw(header->next);
344 header->next->prev = header->prev;
345 maybe_protect_ro(header->next);
346 maybe_protect_rw(header->prev);
347 header->prev->next = header->next;
348 maybe_protect_ro(header->prev);
349 maybe_protect_rw(header);
351 PoisonNew(where_intrn, size, char);
353 /* Trigger the duplicate free warning. */
356 # ifdef PERL_DEBUG_READONLY_COW
357 if (munmap(where_intrn, size)) {
358 perror("munmap failed");
364 Malloc_t where_intrn = where;
366 #ifndef PERL_DEBUG_READONLY_COW
367 PerlMem_free(where_intrn);
372 /* safe version of system's calloc() */
375 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
377 #ifdef ALWAYS_NEED_THX
381 #if defined(USE_MDH) || defined(DEBUGGING)
382 MEM_SIZE total_size = 0;
385 /* Even though calloc() for zero bytes is strange, be robust. */
386 if (size && (count <= MEM_SIZE_MAX / size)) {
387 #if defined(USE_MDH) || defined(DEBUGGING)
388 total_size = size * count;
394 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
395 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
400 if ((SSize_t)size < 0 || (SSize_t)count < 0)
401 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
402 (UV)size, (UV)count);
404 #ifdef PERL_DEBUG_READONLY_COW
405 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
406 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
407 perror("mmap failed");
410 #elif defined(PERL_TRACK_MEMPOOL)
411 /* Have to use malloc() because we've added some space for our tracking
413 /* malloc(0) is non-portable. */
414 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
416 /* Use calloc() because it might save a memset() if the memory is fresh
417 and clean from the OS. */
419 ptr = (Malloc_t)PerlMem_calloc(count, size);
420 else /* calloc(0) is non-portable. */
421 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
423 PERL_ALLOC_CHECK(ptr);
424 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));
428 struct perl_memory_debug_header *const header
429 = (struct perl_memory_debug_header *)ptr;
431 # ifndef PERL_DEBUG_READONLY_COW
432 memset((void*)ptr, 0, total_size);
434 # ifdef PERL_TRACK_MEMPOOL
435 header->interpreter = aTHX;
436 /* Link us into the list. */
437 header->prev = &PL_memory_debug_header;
438 header->next = PL_memory_debug_header.next;
439 PL_memory_debug_header.next = header;
440 maybe_protect_rw(header->next);
441 header->next->prev = header;
442 maybe_protect_ro(header->next);
443 # ifdef PERL_DEBUG_READONLY_COW
444 header->readonly = 0;
448 header->size = total_size;
450 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
456 #ifndef ALWAYS_NEED_THX
465 /* These must be defined when not using Perl's malloc for binary
470 Malloc_t Perl_malloc (MEM_SIZE nbytes)
472 #ifdef PERL_IMPLICIT_SYS
475 return (Malloc_t)PerlMem_malloc(nbytes);
478 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
480 #ifdef PERL_IMPLICIT_SYS
483 return (Malloc_t)PerlMem_calloc(elements, size);
486 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
488 #ifdef PERL_IMPLICIT_SYS
491 return (Malloc_t)PerlMem_realloc(where, nbytes);
494 Free_t Perl_mfree (Malloc_t where)
496 #ifdef PERL_IMPLICIT_SYS
504 /* copy a string up to some (non-backslashed) delimiter, if any */
507 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
511 PERL_ARGS_ASSERT_DELIMCPY;
513 for (tolen = 0; from < fromend; from++, tolen++) {
515 if (from[1] != delim) {
522 else if (*from == delim)
533 /* return ptr to little string in big string, NULL if not found */
534 /* This routine was donated by Corey Satten. */
537 Perl_instr(const char *big, const char *little)
540 PERL_ARGS_ASSERT_INSTR;
542 /* libc prior to 4.6.27 (late 1994) did not work properly on a NULL
546 return strstr((char*)big, (char*)little);
549 /* same as instr but allow embedded nulls. The end pointers point to 1 beyond
550 * the final character desired to be checked */
553 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
555 PERL_ARGS_ASSERT_NINSTR;
559 const char first = *little;
561 bigend -= lend - little++;
563 while (big <= bigend) {
564 if (*big++ == first) {
565 for (x=big,s=little; s < lend; x++,s++) {
569 return (char*)(big-1);
576 /* reverse of the above--find last substring */
579 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
582 const I32 first = *little;
583 const char * const littleend = lend;
585 PERL_ARGS_ASSERT_RNINSTR;
587 if (little >= littleend)
588 return (char*)bigend;
590 big = bigend - (littleend - little++);
591 while (big >= bigbeg) {
595 for (x=big+2,s=little; s < littleend; /**/ ) {
604 return (char*)(big+1);
609 /* As a space optimization, we do not compile tables for strings of length
610 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
611 special-cased in fbm_instr().
613 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
616 =head1 Miscellaneous Functions
618 =for apidoc fbm_compile
620 Analyses the string in order to make fast searches on it using fbm_instr()
621 -- the Boyer-Moore algorithm.
627 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
634 PERL_DEB( STRLEN rarest = 0 );
636 PERL_ARGS_ASSERT_FBM_COMPILE;
638 if (isGV_with_GP(sv) || SvROK(sv))
644 if (flags & FBMcf_TAIL) {
645 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
646 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
647 if (mg && mg->mg_len >= 0)
650 if (!SvPOK(sv) || SvNIOKp(sv))
651 s = (U8*)SvPV_force_mutable(sv, len);
652 else s = (U8 *)SvPV_mutable(sv, len);
653 if (len == 0) /* TAIL might be on a zero-length string. */
655 SvUPGRADE(sv, SVt_PVMG);
660 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
661 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
662 to call SvVALID_off() if the scalar was assigned to.
664 The comment itself (and "deeper magic" below) date back to
665 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
667 where the magic (presumably) was that the scalar had a BM table hidden
670 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
671 the table instead of the previous (somewhat hacky) approach of co-opting
672 the string buffer and storing it after the string. */
674 assert(!mg_find(sv, PERL_MAGIC_bm));
675 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
679 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
681 const U8 mlen = (len>255) ? 255 : (U8)len;
682 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
685 Newx(table, 256, U8);
686 memset((void*)table, mlen, 256);
687 mg->mg_ptr = (char *)table;
690 s += len - 1; /* last char */
693 if (table[*s] == mlen)
699 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
700 for (i = 0; i < len; i++) {
701 if (PL_freq[s[i]] < frequency) {
702 PERL_DEB( rarest = i );
703 frequency = PL_freq[s[i]];
706 BmUSEFUL(sv) = 100; /* Initial value */
707 if (flags & FBMcf_TAIL)
709 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
710 s[rarest], (UV)rarest));
713 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
714 /* If SvTAIL is actually due to \Z or \z, this gives false positives
718 =for apidoc fbm_instr
720 Returns the location of the SV in the string delimited by C<big> and
721 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
722 does not have to be fbm_compiled, but the search will not be as fast
729 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
733 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
734 STRLEN littlelen = l;
735 const I32 multiline = flags & FBMrf_MULTILINE;
737 PERL_ARGS_ASSERT_FBM_INSTR;
739 if ((STRLEN)(bigend - big) < littlelen) {
740 if ( SvTAIL(littlestr)
741 && ((STRLEN)(bigend - big) == littlelen - 1)
743 || (*big == *little &&
744 memEQ((char *)big, (char *)little, littlelen - 1))))
749 switch (littlelen) { /* Special cases for 0, 1 and 2 */
751 return (char*)big; /* Cannot be SvTAIL! */
753 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
754 /* Know that bigend != big. */
755 if (bigend[-1] == '\n')
756 return (char *)(bigend - 1);
757 return (char *) bigend;
765 if (SvTAIL(littlestr))
766 return (char *) bigend;
769 if (SvTAIL(littlestr) && !multiline) {
770 if (bigend[-1] == '\n' && bigend[-2] == *little)
771 return (char*)bigend - 2;
772 if (bigend[-1] == *little)
773 return (char*)bigend - 1;
777 /* This should be better than FBM if c1 == c2, and almost
778 as good otherwise: maybe better since we do less indirection.
779 And we save a lot of memory by caching no table. */
780 const unsigned char c1 = little[0];
781 const unsigned char c2 = little[1];
786 while (s <= bigend) {
796 goto check_1char_anchor;
807 goto check_1char_anchor;
810 while (s <= bigend) {
815 goto check_1char_anchor;
824 check_1char_anchor: /* One char and anchor! */
825 if (SvTAIL(littlestr) && (*bigend == *little))
826 return (char *)bigend; /* bigend is already decremented. */
829 break; /* Only lengths 0 1 and 2 have special-case code. */
832 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
833 s = bigend - littlelen;
834 if (s >= big && bigend[-1] == '\n' && *s == *little
835 /* Automatically of length > 2 */
836 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
838 return (char*)s; /* how sweet it is */
841 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
843 return (char*)s + 1; /* how sweet it is */
847 if (!SvVALID(littlestr)) {
848 char * const b = ninstr((char*)big,(char*)bigend,
849 (char*)little, (char*)little + littlelen);
851 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
852 /* Chop \n from littlestr: */
853 s = bigend - littlelen + 1;
855 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
865 if (littlelen > (STRLEN)(bigend - big))
869 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
870 const unsigned char *oldlittle;
874 --littlelen; /* Last char found by table lookup */
877 little += littlelen; /* last char */
880 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
884 if ((tmp = table[*s])) {
885 if ((s += tmp) < bigend)
889 else { /* less expensive than calling strncmp() */
890 unsigned char * const olds = s;
895 if (*--s == *--little)
897 s = olds + 1; /* here we pay the price for failure */
899 if (s < bigend) /* fake up continue to outer loop */
909 && memEQ((char *)(bigend - littlelen),
910 (char *)(oldlittle - littlelen), littlelen) )
911 return (char*)bigend - littlelen;
919 Returns true if the leading len bytes of the strings s1 and s2 are the same
920 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
921 match themselves and their opposite case counterparts. Non-cased and non-ASCII
922 range bytes match only themselves.
929 Perl_foldEQ(const char *s1, const char *s2, I32 len)
931 const U8 *a = (const U8 *)s1;
932 const U8 *b = (const U8 *)s2;
934 PERL_ARGS_ASSERT_FOLDEQ;
939 if (*a != *b && *a != PL_fold[*b])
946 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
948 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
949 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
950 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
951 * does it check that the strings each have at least 'len' characters */
953 const U8 *a = (const U8 *)s1;
954 const U8 *b = (const U8 *)s2;
956 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
961 if (*a != *b && *a != PL_fold_latin1[*b]) {
970 =for apidoc foldEQ_locale
972 Returns true if the leading len bytes of the strings s1 and s2 are the same
973 case-insensitively in the current locale; false otherwise.
979 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
982 const U8 *a = (const U8 *)s1;
983 const U8 *b = (const U8 *)s2;
985 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
990 if (*a != *b && *a != PL_fold_locale[*b])
997 /* copy a string to a safe spot */
1000 =head1 Memory Management
1004 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1005 string which is a duplicate of C<pv>. The size of the string is
1006 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1007 characters and must have a trailing C<NUL>. The memory allocated for the new
1008 string can be freed with the C<Safefree()> function.
1010 On some platforms, Windows for example, all allocated memory owned by a thread
1011 is deallocated when that thread ends. So if you need that not to happen, you
1012 need to use the shared memory functions, such as C<L</savesharedpv>>.
1018 Perl_savepv(pTHX_ const char *pv)
1020 PERL_UNUSED_CONTEXT;
1025 const STRLEN pvlen = strlen(pv)+1;
1026 Newx(newaddr, pvlen, char);
1027 return (char*)memcpy(newaddr, pv, pvlen);
1031 /* same thing but with a known length */
1036 Perl's version of what C<strndup()> would be if it existed. Returns a
1037 pointer to a newly allocated string which is a duplicate of the first
1038 C<len> bytes from C<pv>, plus a trailing
1039 C<NUL> byte. The memory allocated for
1040 the new string can be freed with the C<Safefree()> function.
1042 On some platforms, Windows for example, all allocated memory owned by a thread
1043 is deallocated when that thread ends. So if you need that not to happen, you
1044 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1050 Perl_savepvn(pTHX_ const char *pv, I32 len)
1053 PERL_UNUSED_CONTEXT;
1057 Newx(newaddr,len+1,char);
1058 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1060 /* might not be null terminated */
1061 newaddr[len] = '\0';
1062 return (char *) CopyD(pv,newaddr,len,char);
1065 return (char *) ZeroD(newaddr,len+1,char);
1070 =for apidoc savesharedpv
1072 A version of C<savepv()> which allocates the duplicate string in memory
1073 which is shared between threads.
1078 Perl_savesharedpv(pTHX_ const char *pv)
1083 PERL_UNUSED_CONTEXT;
1088 pvlen = strlen(pv)+1;
1089 newaddr = (char*)PerlMemShared_malloc(pvlen);
1093 return (char*)memcpy(newaddr, pv, pvlen);
1097 =for apidoc savesharedpvn
1099 A version of C<savepvn()> which allocates the duplicate string in memory
1100 which is shared between threads. (With the specific difference that a NULL
1101 pointer is not acceptable)
1106 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1108 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1110 PERL_UNUSED_CONTEXT;
1111 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1116 newaddr[len] = '\0';
1117 return (char*)memcpy(newaddr, pv, len);
1121 =for apidoc savesvpv
1123 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1124 the passed in SV using C<SvPV()>
1126 On some platforms, Windows for example, all allocated memory owned by a thread
1127 is deallocated when that thread ends. So if you need that not to happen, you
1128 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1134 Perl_savesvpv(pTHX_ SV *sv)
1137 const char * const pv = SvPV_const(sv, len);
1140 PERL_ARGS_ASSERT_SAVESVPV;
1143 Newx(newaddr,len,char);
1144 return (char *) CopyD(pv,newaddr,len,char);
1148 =for apidoc savesharedsvpv
1150 A version of C<savesharedpv()> which allocates the duplicate string in
1151 memory which is shared between threads.
1157 Perl_savesharedsvpv(pTHX_ SV *sv)
1160 const char * const pv = SvPV_const(sv, len);
1162 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1164 return savesharedpvn(pv, len);
1167 /* the SV for Perl_form() and mess() is not kept in an arena */
1175 if (PL_phase != PERL_PHASE_DESTRUCT)
1176 return newSVpvs_flags("", SVs_TEMP);
1181 /* Create as PVMG now, to avoid any upgrading later */
1183 Newxz(any, 1, XPVMG);
1184 SvFLAGS(sv) = SVt_PVMG;
1185 SvANY(sv) = (void*)any;
1187 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1192 #if defined(PERL_IMPLICIT_CONTEXT)
1194 Perl_form_nocontext(const char* pat, ...)
1199 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1200 va_start(args, pat);
1201 retval = vform(pat, &args);
1205 #endif /* PERL_IMPLICIT_CONTEXT */
1208 =head1 Miscellaneous Functions
1211 Takes a sprintf-style format pattern and conventional
1212 (non-SV) arguments and returns the formatted string.
1214 (char *) Perl_form(pTHX_ const char* pat, ...)
1216 can be used any place a string (char *) is required:
1218 char * s = Perl_form("%d.%d",major,minor);
1220 Uses a single private buffer so if you want to format several strings you
1221 must explicitly copy the earlier strings away (and free the copies when you
1228 Perl_form(pTHX_ const char* pat, ...)
1232 PERL_ARGS_ASSERT_FORM;
1233 va_start(args, pat);
1234 retval = vform(pat, &args);
1240 Perl_vform(pTHX_ const char *pat, va_list *args)
1242 SV * const sv = mess_alloc();
1243 PERL_ARGS_ASSERT_VFORM;
1244 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1249 =for apidoc Am|SV *|mess|const char *pat|...
1251 Take a sprintf-style format pattern and argument list. These are used to
1252 generate a string message. If the message does not end with a newline,
1253 then it will be extended with some indication of the current location
1254 in the code, as described for L</mess_sv>.
1256 Normally, the resulting message is returned in a new mortal SV.
1257 During global destruction a single SV may be shared between uses of
1263 #if defined(PERL_IMPLICIT_CONTEXT)
1265 Perl_mess_nocontext(const char *pat, ...)
1270 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1271 va_start(args, pat);
1272 retval = vmess(pat, &args);
1276 #endif /* PERL_IMPLICIT_CONTEXT */
1279 Perl_mess(pTHX_ const char *pat, ...)
1283 PERL_ARGS_ASSERT_MESS;
1284 va_start(args, pat);
1285 retval = vmess(pat, &args);
1291 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1294 /* Look for curop starting from o. cop is the last COP we've seen. */
1295 /* opnext means that curop is actually the ->op_next of the op we are
1298 PERL_ARGS_ASSERT_CLOSEST_COP;
1300 if (!o || !curop || (
1301 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1305 if (o->op_flags & OPf_KIDS) {
1307 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1310 /* If the OP_NEXTSTATE has been optimised away we can still use it
1311 * the get the file and line number. */
1313 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1314 cop = (const COP *)kid;
1316 /* Keep searching, and return when we've found something. */
1318 new_cop = closest_cop(cop, kid, curop, opnext);
1324 /* Nothing found. */
1330 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1332 Expands a message, intended for the user, to include an indication of
1333 the current location in the code, if the message does not already appear
1336 C<basemsg> is the initial message or object. If it is a reference, it
1337 will be used as-is and will be the result of this function. Otherwise it
1338 is used as a string, and if it already ends with a newline, it is taken
1339 to be complete, and the result of this function will be the same string.
1340 If the message does not end with a newline, then a segment such as C<at
1341 foo.pl line 37> will be appended, and possibly other clauses indicating
1342 the current state of execution. The resulting message will end with a
1345 Normally, the resulting message is returned in a new mortal SV.
1346 During global destruction a single SV may be shared between uses of this
1347 function. If C<consume> is true, then the function is permitted (but not
1348 required) to modify and return C<basemsg> instead of allocating a new SV.
1354 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1358 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1362 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1363 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR")) &&
1364 (wi = grok_atou(ws, NULL)) > 0) {
1365 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, wi, 1);
1370 PERL_ARGS_ASSERT_MESS_SV;
1372 if (SvROK(basemsg)) {
1378 sv_setsv(sv, basemsg);
1383 if (SvPOK(basemsg) && consume) {
1388 sv_copypv(sv, basemsg);
1391 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1393 * Try and find the file and line for PL_op. This will usually be
1394 * PL_curcop, but it might be a cop that has been optimised away. We
1395 * can try to find such a cop by searching through the optree starting
1396 * from the sibling of PL_curcop.
1400 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1405 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1406 OutCopFILE(cop), (IV)CopLINE(cop));
1407 /* Seems that GvIO() can be untrustworthy during global destruction. */
1408 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1409 && IoLINES(GvIOp(PL_last_in_gv)))
1412 const bool line_mode = (RsSIMPLE(PL_rs) &&
1413 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1414 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1415 SVfARG(PL_last_in_gv == PL_argvgv
1417 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1418 line_mode ? "line" : "chunk",
1419 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1421 if (PL_phase == PERL_PHASE_DESTRUCT)
1422 sv_catpvs(sv, " during global destruction");
1423 sv_catpvs(sv, ".\n");
1429 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1431 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1432 argument list. These are used to generate a string message. If the
1433 message does not end with a newline, then it will be extended with
1434 some indication of the current location in the code, as described for
1437 Normally, the resulting message is returned in a new mortal SV.
1438 During global destruction a single SV may be shared between uses of
1445 Perl_vmess(pTHX_ const char *pat, va_list *args)
1447 SV * const sv = mess_alloc();
1449 PERL_ARGS_ASSERT_VMESS;
1451 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1452 return mess_sv(sv, 1);
1456 Perl_write_to_stderr(pTHX_ SV* msv)
1461 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1463 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1464 && (io = GvIO(PL_stderrgv))
1465 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1466 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1467 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1469 PerlIO * const serr = Perl_error_log;
1471 do_print(msv, serr);
1472 (void)PerlIO_flush(serr);
1477 =head1 Warning and Dieing
1480 /* Common code used in dieing and warning */
1483 S_with_queued_errors(pTHX_ SV *ex)
1485 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1486 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1487 sv_catsv(PL_errors, ex);
1488 ex = sv_mortalcopy(PL_errors);
1489 SvCUR_set(PL_errors, 0);
1495 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1500 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1501 /* sv_2cv might call Perl_croak() or Perl_warner() */
1502 SV * const oldhook = *hook;
1510 cv = sv_2cv(oldhook, &stash, &gv, 0);
1512 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1521 exarg = newSVsv(ex);
1522 SvREADONLY_on(exarg);
1525 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1529 call_sv(MUTABLE_SV(cv), G_DISCARD);
1538 =for apidoc Am|OP *|die_sv|SV *baseex
1540 Behaves the same as L</croak_sv>, except for the return type.
1541 It should be used only where the C<OP *> return type is required.
1542 The function never actually returns.
1548 # pragma warning( push )
1549 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1550 __declspec(noreturn) has non-void return type */
1551 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1552 __declspec(noreturn) has a return statement */
1555 Perl_die_sv(pTHX_ SV *baseex)
1557 PERL_ARGS_ASSERT_DIE_SV;
1560 NORETURN_FUNCTION_END;
1563 # pragma warning( pop )
1567 =for apidoc Am|OP *|die|const char *pat|...
1569 Behaves the same as L</croak>, except for the return type.
1570 It should be used only where the C<OP *> return type is required.
1571 The function never actually returns.
1576 #if defined(PERL_IMPLICIT_CONTEXT)
1578 # pragma warning( push )
1579 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1580 __declspec(noreturn) has non-void return type */
1581 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1582 __declspec(noreturn) has a return statement */
1585 Perl_die_nocontext(const char* pat, ...)
1589 va_start(args, pat);
1591 NOT_REACHED; /* NOTREACHED */
1593 NORETURN_FUNCTION_END;
1596 # pragma warning( pop )
1598 #endif /* PERL_IMPLICIT_CONTEXT */
1601 # pragma warning( push )
1602 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1603 __declspec(noreturn) has non-void return type */
1604 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1605 __declspec(noreturn) has a return statement */
1608 Perl_die(pTHX_ const char* pat, ...)
1611 va_start(args, pat);
1613 NOT_REACHED; /* NOTREACHED */
1615 NORETURN_FUNCTION_END;
1618 # pragma warning( pop )
1622 =for apidoc Am|void|croak_sv|SV *baseex
1624 This is an XS interface to Perl's C<die> function.
1626 C<baseex> is the error message or object. If it is a reference, it
1627 will be used as-is. Otherwise it is used as a string, and if it does
1628 not end with a newline then it will be extended with some indication of
1629 the current location in the code, as described for L</mess_sv>.
1631 The error message or object will be used as an exception, by default
1632 returning control to the nearest enclosing C<eval>, but subject to
1633 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1634 function never returns normally.
1636 To die with a simple string message, the L</croak> function may be
1643 Perl_croak_sv(pTHX_ SV *baseex)
1645 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1646 PERL_ARGS_ASSERT_CROAK_SV;
1647 invoke_exception_hook(ex, FALSE);
1652 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1654 This is an XS interface to Perl's C<die> function.
1656 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1657 argument list. These are used to generate a string message. If the
1658 message does not end with a newline, then it will be extended with
1659 some indication of the current location in the code, as described for
1662 The error message will be used as an exception, by default
1663 returning control to the nearest enclosing C<eval>, but subject to
1664 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1665 function never returns normally.
1667 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1668 (C<$@>) will be used as an error message or object instead of building an
1669 error message from arguments. If you want to throw a non-string object,
1670 or build an error message in an SV yourself, it is preferable to use
1671 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1677 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1679 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1680 invoke_exception_hook(ex, FALSE);
1685 =for apidoc Am|void|croak|const char *pat|...
1687 This is an XS interface to Perl's C<die> function.
1689 Take a sprintf-style format pattern and argument list. These are used to
1690 generate a string message. If the message does not end with a newline,
1691 then it will be extended with some indication of the current location
1692 in the code, as described for L</mess_sv>.
1694 The error message will be used as an exception, by default
1695 returning control to the nearest enclosing C<eval>, but subject to
1696 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1697 function never returns normally.
1699 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1700 (C<$@>) will be used as an error message or object instead of building an
1701 error message from arguments. If you want to throw a non-string object,
1702 or build an error message in an SV yourself, it is preferable to use
1703 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1708 #if defined(PERL_IMPLICIT_CONTEXT)
1710 Perl_croak_nocontext(const char *pat, ...)
1714 va_start(args, pat);
1716 NOT_REACHED; /* NOTREACHED */
1719 #endif /* PERL_IMPLICIT_CONTEXT */
1722 Perl_croak(pTHX_ const char *pat, ...)
1725 va_start(args, pat);
1727 NOT_REACHED; /* NOTREACHED */
1732 =for apidoc Am|void|croak_no_modify
1734 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1735 terser object code than using C<Perl_croak>. Less code used on exception code
1736 paths reduces CPU cache pressure.
1742 Perl_croak_no_modify(void)
1744 Perl_croak_nocontext( "%s", PL_no_modify);
1747 /* does not return, used in util.c perlio.c and win32.c
1748 This is typically called when malloc returns NULL.
1751 Perl_croak_no_mem(void)
1755 int fd = PerlIO_fileno(Perl_error_log);
1757 SETERRNO(EBADF,RMS_IFI);
1759 /* Can't use PerlIO to write as it allocates memory */
1760 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1765 /* does not return, used only in POPSTACK */
1767 Perl_croak_popstack(void)
1770 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1775 =for apidoc Am|void|warn_sv|SV *baseex
1777 This is an XS interface to Perl's C<warn> function.
1779 C<baseex> is the error message or object. If it is a reference, it
1780 will be used as-is. Otherwise it is used as a string, and if it does
1781 not end with a newline then it will be extended with some indication of
1782 the current location in the code, as described for L</mess_sv>.
1784 The error message or object will by default be written to standard error,
1785 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1787 To warn with a simple string message, the L</warn> function may be
1794 Perl_warn_sv(pTHX_ SV *baseex)
1796 SV *ex = mess_sv(baseex, 0);
1797 PERL_ARGS_ASSERT_WARN_SV;
1798 if (!invoke_exception_hook(ex, TRUE))
1799 write_to_stderr(ex);
1803 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1805 This is an XS interface to Perl's C<warn> function.
1807 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1808 argument list. These are used to generate a string message. If the
1809 message does not end with a newline, then it will be extended with
1810 some indication of the current location in the code, as described for
1813 The error message or object will by default be written to standard error,
1814 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1816 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1822 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1824 SV *ex = vmess(pat, args);
1825 PERL_ARGS_ASSERT_VWARN;
1826 if (!invoke_exception_hook(ex, TRUE))
1827 write_to_stderr(ex);
1831 =for apidoc Am|void|warn|const char *pat|...
1833 This is an XS interface to Perl's C<warn> function.
1835 Take a sprintf-style format pattern and argument list. These are used to
1836 generate a string message. If the message does not end with a newline,
1837 then it will be extended with some indication of the current location
1838 in the code, as described for L</mess_sv>.
1840 The error message or object will by default be written to standard error,
1841 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1843 Unlike with L</croak>, C<pat> is not permitted to be null.
1848 #if defined(PERL_IMPLICIT_CONTEXT)
1850 Perl_warn_nocontext(const char *pat, ...)
1854 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1855 va_start(args, pat);
1859 #endif /* PERL_IMPLICIT_CONTEXT */
1862 Perl_warn(pTHX_ const char *pat, ...)
1865 PERL_ARGS_ASSERT_WARN;
1866 va_start(args, pat);
1871 #if defined(PERL_IMPLICIT_CONTEXT)
1873 Perl_warner_nocontext(U32 err, const char *pat, ...)
1877 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1878 va_start(args, pat);
1879 vwarner(err, pat, &args);
1882 #endif /* PERL_IMPLICIT_CONTEXT */
1885 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1887 PERL_ARGS_ASSERT_CK_WARNER_D;
1889 if (Perl_ckwarn_d(aTHX_ err)) {
1891 va_start(args, pat);
1892 vwarner(err, pat, &args);
1898 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1900 PERL_ARGS_ASSERT_CK_WARNER;
1902 if (Perl_ckwarn(aTHX_ err)) {
1904 va_start(args, pat);
1905 vwarner(err, pat, &args);
1911 Perl_warner(pTHX_ U32 err, const char* pat,...)
1914 PERL_ARGS_ASSERT_WARNER;
1915 va_start(args, pat);
1916 vwarner(err, pat, &args);
1921 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1924 PERL_ARGS_ASSERT_VWARNER;
1925 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1926 SV * const msv = vmess(pat, args);
1928 if (PL_parser && PL_parser->error_count) {
1932 invoke_exception_hook(msv, FALSE);
1937 Perl_vwarn(aTHX_ pat, args);
1941 /* implements the ckWARN? macros */
1944 Perl_ckwarn(pTHX_ U32 w)
1946 /* If lexical warnings have not been set, use $^W. */
1947 if (isLEXWARN_off) {
1948 /* TODO: Hardcoding this here sucks, see the commit that added this */
1949 if (w == WARN_VOID_UNUSUAL)
1952 return PL_dowarn & G_WARN_ON;
1955 return ckwarn_common(w);
1958 /* implements the ckWARN?_d macro */
1961 Perl_ckwarn_d(pTHX_ U32 w)
1963 /* If lexical warnings have not been set then default classes warn. */
1964 if (isLEXWARN_off) {
1965 /* TODO: Hardcoding this here sucks, see the commit that added this */
1966 if (w == WARN_VOID_UNUSUAL)
1972 return ckwarn_common(w);
1976 S_ckwarn_common(pTHX_ U32 w)
1978 if (PL_curcop->cop_warnings == pWARN_ALL) {
1979 /* TODO: Hardcoding this here sucks, see the commit that added this */
1980 if (w == WARN_VOID_UNUSUAL)
1986 if (PL_curcop->cop_warnings == pWARN_NONE)
1989 /* Check the assumption that at least the first slot is non-zero. */
1990 assert(unpackWARN1(w));
1992 /* Check the assumption that it is valid to stop as soon as a zero slot is
1994 if (!unpackWARN2(w)) {
1995 assert(!unpackWARN3(w));
1996 assert(!unpackWARN4(w));
1997 } else if (!unpackWARN3(w)) {
1998 assert(!unpackWARN4(w));
2001 /* Right, dealt with all the special cases, which are implemented as non-
2002 pointers, so there is a pointer to a real warnings mask. */
2004 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2006 } while (w >>= WARNshift);
2011 /* Set buffer=NULL to get a new one. */
2013 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2015 const MEM_SIZE len_wanted =
2016 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2017 PERL_UNUSED_CONTEXT;
2018 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2021 (specialWARN(buffer) ?
2022 PerlMemShared_malloc(len_wanted) :
2023 PerlMemShared_realloc(buffer, len_wanted));
2025 Copy(bits, (buffer + 1), size, char);
2026 if (size < WARNsize)
2027 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2031 /* since we've already done strlen() for both nam and val
2032 * we can use that info to make things faster than
2033 * sprintf(s, "%s=%s", nam, val)
2035 #define my_setenv_format(s, nam, nlen, val, vlen) \
2036 Copy(nam, s, nlen, char); \
2038 Copy(val, s+(nlen+1), vlen, char); \
2039 *(s+(nlen+1+vlen)) = '\0'
2041 #ifdef USE_ENVIRON_ARRAY
2042 /* VMS' my_setenv() is in vms.c */
2043 #if !defined(WIN32) && !defined(NETWARE)
2045 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2049 /* only parent thread can modify process environment */
2050 if (PL_curinterp == aTHX)
2053 #ifndef PERL_USE_SAFE_PUTENV
2054 if (!PL_use_safe_putenv) {
2055 /* most putenv()s leak, so we manipulate environ directly */
2057 const I32 len = strlen(nam);
2060 /* where does it go? */
2061 for (i = 0; environ[i]; i++) {
2062 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2066 if (environ == PL_origenviron) { /* need we copy environment? */
2072 while (environ[max])
2074 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2075 for (j=0; j<max; j++) { /* copy environment */
2076 const int len = strlen(environ[j]);
2077 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2078 Copy(environ[j], tmpenv[j], len+1, char);
2081 environ = tmpenv; /* tell exec where it is now */
2084 safesysfree(environ[i]);
2085 while (environ[i]) {
2086 environ[i] = environ[i+1];
2091 if (!environ[i]) { /* does not exist yet */
2092 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2093 environ[i+1] = NULL; /* make sure it's null terminated */
2096 safesysfree(environ[i]);
2100 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2101 /* all that work just for this */
2102 my_setenv_format(environ[i], nam, nlen, val, vlen);
2105 /* This next branch should only be called #if defined(HAS_SETENV), but
2106 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2107 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2109 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV))
2110 # if defined(HAS_UNSETENV)
2112 (void)unsetenv(nam);
2114 (void)setenv(nam, val, 1);
2116 # else /* ! HAS_UNSETENV */
2117 (void)setenv(nam, val, 1);
2118 # endif /* HAS_UNSETENV */
2120 # if defined(HAS_UNSETENV)
2122 if (environ) /* old glibc can crash with null environ */
2123 (void)unsetenv(nam);
2125 const int nlen = strlen(nam);
2126 const int vlen = strlen(val);
2127 char * const new_env =
2128 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2129 my_setenv_format(new_env, nam, nlen, val, vlen);
2130 (void)putenv(new_env);
2132 # else /* ! HAS_UNSETENV */
2134 const int nlen = strlen(nam);
2140 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2141 /* all that work just for this */
2142 my_setenv_format(new_env, nam, nlen, val, vlen);
2143 (void)putenv(new_env);
2144 # endif /* HAS_UNSETENV */
2145 # endif /* __CYGWIN__ */
2146 #ifndef PERL_USE_SAFE_PUTENV
2152 #else /* WIN32 || NETWARE */
2155 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2159 const int nlen = strlen(nam);
2166 Newx(envstr, nlen+vlen+2, char);
2167 my_setenv_format(envstr, nam, nlen, val, vlen);
2168 (void)PerlEnv_putenv(envstr);
2172 #endif /* WIN32 || NETWARE */
2176 #ifdef UNLINK_ALL_VERSIONS
2178 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2182 PERL_ARGS_ASSERT_UNLNK;
2184 while (PerlLIO_unlink(f) >= 0)
2186 return retries ? 0 : -1;
2190 /* this is a drop-in replacement for bcopy() */
2191 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2193 Perl_my_bcopy(const char *from, char *to, I32 len)
2195 char * const retval = to;
2197 PERL_ARGS_ASSERT_MY_BCOPY;
2201 if (from - to >= 0) {
2209 *(--to) = *(--from);
2215 /* this is a drop-in replacement for memset() */
2218 Perl_my_memset(char *loc, I32 ch, I32 len)
2220 char * const retval = loc;
2222 PERL_ARGS_ASSERT_MY_MEMSET;
2232 /* this is a drop-in replacement for bzero() */
2233 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2235 Perl_my_bzero(char *loc, I32 len)
2237 char * const retval = loc;
2239 PERL_ARGS_ASSERT_MY_BZERO;
2249 /* this is a drop-in replacement for memcmp() */
2250 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2252 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2254 const U8 *a = (const U8 *)s1;
2255 const U8 *b = (const U8 *)s2;
2258 PERL_ARGS_ASSERT_MY_MEMCMP;
2263 if ((tmp = *a++ - *b++))
2268 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2271 /* This vsprintf replacement should generally never get used, since
2272 vsprintf was available in both System V and BSD 2.11. (There may
2273 be some cross-compilation or embedded set-ups where it is needed,
2276 If you encounter a problem in this function, it's probably a symptom
2277 that Configure failed to detect your system's vprintf() function.
2278 See the section on "item vsprintf" in the INSTALL file.
2280 This version may compile on systems with BSD-ish <stdio.h>,
2281 but probably won't on others.
2284 #ifdef USE_CHAR_VSPRINTF
2289 vsprintf(char *dest, const char *pat, void *args)
2293 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2294 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2295 FILE_cnt(&fakebuf) = 32767;
2297 /* These probably won't compile -- If you really need
2298 this, you'll have to figure out some other method. */
2299 fakebuf._ptr = dest;
2300 fakebuf._cnt = 32767;
2305 fakebuf._flag = _IOWRT|_IOSTRG;
2306 _doprnt(pat, args, &fakebuf); /* what a kludge */
2307 #if defined(STDIO_PTR_LVALUE)
2308 *(FILE_ptr(&fakebuf)++) = '\0';
2310 /* PerlIO has probably #defined away fputc, but we want it here. */
2312 # undef fputc /* XXX Should really restore it later */
2314 (void)fputc('\0', &fakebuf);
2316 #ifdef USE_CHAR_VSPRINTF
2319 return 0; /* perl doesn't use return value */
2323 #endif /* HAS_VPRINTF */
2326 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2328 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2336 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2338 PERL_FLUSHALL_FOR_CHILD;
2339 This = (*mode == 'w');
2343 taint_proper("Insecure %s%s", "EXEC");
2345 if (PerlProc_pipe(p) < 0)
2347 /* Try for another pipe pair for error return */
2348 if (PerlProc_pipe(pp) >= 0)
2350 while ((pid = PerlProc_fork()) < 0) {
2351 if (errno != EAGAIN) {
2352 PerlLIO_close(p[This]);
2353 PerlLIO_close(p[that]);
2355 PerlLIO_close(pp[0]);
2356 PerlLIO_close(pp[1]);
2360 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2369 /* Close parent's end of error status pipe (if any) */
2371 PerlLIO_close(pp[0]);
2372 #if defined(HAS_FCNTL) && defined(F_SETFD)
2373 /* Close error pipe automatically if exec works */
2374 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2378 /* Now dup our end of _the_ pipe to right position */
2379 if (p[THIS] != (*mode == 'r')) {
2380 PerlLIO_dup2(p[THIS], *mode == 'r');
2381 PerlLIO_close(p[THIS]);
2382 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2383 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2386 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2387 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2388 /* No automatic close - do it by hand */
2395 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2401 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2407 do_execfree(); /* free any memory malloced by child on fork */
2409 PerlLIO_close(pp[1]);
2410 /* Keep the lower of the two fd numbers */
2411 if (p[that] < p[This]) {
2412 PerlLIO_dup2(p[This], p[that]);
2413 PerlLIO_close(p[This]);
2417 PerlLIO_close(p[that]); /* close child's end of pipe */
2419 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2420 SvUPGRADE(sv,SVt_IV);
2422 PL_forkprocess = pid;
2423 /* If we managed to get status pipe check for exec fail */
2424 if (did_pipes && pid > 0) {
2429 while (n < sizeof(int)) {
2430 n1 = PerlLIO_read(pp[0],
2431 (void*)(((char*)&errkid)+n),
2437 PerlLIO_close(pp[0]);
2439 if (n) { /* Error */
2441 PerlLIO_close(p[This]);
2442 if (n != sizeof(int))
2443 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2445 pid2 = wait4pid(pid, &status, 0);
2446 } while (pid2 == -1 && errno == EINTR);
2447 errno = errkid; /* Propagate errno from kid */
2452 PerlLIO_close(pp[0]);
2453 return PerlIO_fdopen(p[This], mode);
2455 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2456 return my_syspopen4(aTHX_ NULL, mode, n, args);
2457 # elif defined(WIN32)
2458 return win32_popenlist(mode, n, args);
2460 Perl_croak(aTHX_ "List form of piped open not implemented");
2461 return (PerlIO *) NULL;
2466 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2467 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2469 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2475 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2479 PERL_ARGS_ASSERT_MY_POPEN;
2481 PERL_FLUSHALL_FOR_CHILD;
2484 return my_syspopen(aTHX_ cmd,mode);
2487 This = (*mode == 'w');
2489 if (doexec && TAINTING_get) {
2491 taint_proper("Insecure %s%s", "EXEC");
2493 if (PerlProc_pipe(p) < 0)
2495 if (doexec && PerlProc_pipe(pp) >= 0)
2497 while ((pid = PerlProc_fork()) < 0) {
2498 if (errno != EAGAIN) {
2499 PerlLIO_close(p[This]);
2500 PerlLIO_close(p[that]);
2502 PerlLIO_close(pp[0]);
2503 PerlLIO_close(pp[1]);
2506 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2509 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2519 PerlLIO_close(pp[0]);
2520 #if defined(HAS_FCNTL) && defined(F_SETFD)
2521 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2525 if (p[THIS] != (*mode == 'r')) {
2526 PerlLIO_dup2(p[THIS], *mode == 'r');
2527 PerlLIO_close(p[THIS]);
2528 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2529 PerlLIO_close(p[THAT]);
2532 PerlLIO_close(p[THAT]);
2535 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2542 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2547 /* may or may not use the shell */
2548 do_exec3(cmd, pp[1], did_pipes);
2551 #endif /* defined OS2 */
2553 #ifdef PERLIO_USING_CRLF
2554 /* Since we circumvent IO layers when we manipulate low-level
2555 filedescriptors directly, need to manually switch to the
2556 default, binary, low-level mode; see PerlIOBuf_open(). */
2557 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2560 #ifdef PERL_USES_PL_PIDSTATUS
2561 hv_clear(PL_pidstatus); /* we have no children */
2567 do_execfree(); /* free any memory malloced by child on vfork */
2569 PerlLIO_close(pp[1]);
2570 if (p[that] < p[This]) {
2571 PerlLIO_dup2(p[This], p[that]);
2572 PerlLIO_close(p[This]);
2576 PerlLIO_close(p[that]);
2578 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2579 SvUPGRADE(sv,SVt_IV);
2581 PL_forkprocess = pid;
2582 if (did_pipes && pid > 0) {
2587 while (n < sizeof(int)) {
2588 n1 = PerlLIO_read(pp[0],
2589 (void*)(((char*)&errkid)+n),
2595 PerlLIO_close(pp[0]);
2597 if (n) { /* Error */
2599 PerlLIO_close(p[This]);
2600 if (n != sizeof(int))
2601 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2603 pid2 = wait4pid(pid, &status, 0);
2604 } while (pid2 == -1 && errno == EINTR);
2605 errno = errkid; /* Propagate errno from kid */
2610 PerlLIO_close(pp[0]);
2611 return PerlIO_fdopen(p[This], mode);
2615 FILE *djgpp_popen();
2617 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2619 PERL_FLUSHALL_FOR_CHILD;
2620 /* Call system's popen() to get a FILE *, then import it.
2621 used 0 for 2nd parameter to PerlIO_importFILE;
2624 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2627 #if defined(__LIBCATAMOUNT__)
2629 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2636 #endif /* !DOSISH */
2638 /* this is called in parent before the fork() */
2640 Perl_atfork_lock(void)
2642 #if defined(USE_ITHREADS)
2644 /* locks must be held in locking order (if any) */
2646 MUTEX_LOCK(&PL_perlio_mutex);
2649 MUTEX_LOCK(&PL_malloc_mutex);
2655 /* this is called in both parent and child after the fork() */
2657 Perl_atfork_unlock(void)
2659 #if defined(USE_ITHREADS)
2661 /* locks must be released in same order as in atfork_lock() */
2663 MUTEX_UNLOCK(&PL_perlio_mutex);
2666 MUTEX_UNLOCK(&PL_malloc_mutex);
2675 #if defined(HAS_FORK)
2677 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2682 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2683 * handlers elsewhere in the code */
2688 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2689 Perl_croak_nocontext("fork() not available");
2691 #endif /* HAS_FORK */
2696 dup2(int oldfd, int newfd)
2698 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2701 PerlLIO_close(newfd);
2702 return fcntl(oldfd, F_DUPFD, newfd);
2704 #define DUP2_MAX_FDS 256
2705 int fdtmp[DUP2_MAX_FDS];
2711 PerlLIO_close(newfd);
2712 /* good enough for low fd's... */
2713 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2714 if (fdx >= DUP2_MAX_FDS) {
2722 PerlLIO_close(fdtmp[--fdx]);
2729 #ifdef HAS_SIGACTION
2732 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2734 struct sigaction act, oact;
2738 /* only "parent" interpreter can diddle signals */
2739 if (PL_curinterp != aTHX)
2740 return (Sighandler_t) SIG_ERR;
2743 act.sa_handler = (void(*)(int))handler;
2744 sigemptyset(&act.sa_mask);
2747 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2748 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2750 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2751 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2752 act.sa_flags |= SA_NOCLDWAIT;
2754 if (sigaction(signo, &act, &oact) == -1)
2755 return (Sighandler_t) SIG_ERR;
2757 return (Sighandler_t) oact.sa_handler;
2761 Perl_rsignal_state(pTHX_ int signo)
2763 struct sigaction oact;
2764 PERL_UNUSED_CONTEXT;
2766 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2767 return (Sighandler_t) SIG_ERR;
2769 return (Sighandler_t) oact.sa_handler;
2773 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2778 struct sigaction act;
2780 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2783 /* only "parent" interpreter can diddle signals */
2784 if (PL_curinterp != aTHX)
2788 act.sa_handler = (void(*)(int))handler;
2789 sigemptyset(&act.sa_mask);
2792 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2793 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2795 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2796 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2797 act.sa_flags |= SA_NOCLDWAIT;
2799 return sigaction(signo, &act, save);
2803 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2808 PERL_UNUSED_CONTEXT;
2810 /* only "parent" interpreter can diddle signals */
2811 if (PL_curinterp != aTHX)
2815 return sigaction(signo, save, (struct sigaction *)NULL);
2818 #else /* !HAS_SIGACTION */
2821 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2823 #if defined(USE_ITHREADS) && !defined(WIN32)
2824 /* only "parent" interpreter can diddle signals */
2825 if (PL_curinterp != aTHX)
2826 return (Sighandler_t) SIG_ERR;
2829 return PerlProc_signal(signo, handler);
2840 Perl_rsignal_state(pTHX_ int signo)
2843 Sighandler_t oldsig;
2845 #if defined(USE_ITHREADS) && !defined(WIN32)
2846 /* only "parent" interpreter can diddle signals */
2847 if (PL_curinterp != aTHX)
2848 return (Sighandler_t) SIG_ERR;
2852 oldsig = PerlProc_signal(signo, sig_trap);
2853 PerlProc_signal(signo, oldsig);
2855 PerlProc_kill(PerlProc_getpid(), signo);
2860 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2862 #if defined(USE_ITHREADS) && !defined(WIN32)
2863 /* only "parent" interpreter can diddle signals */
2864 if (PL_curinterp != aTHX)
2867 *save = PerlProc_signal(signo, handler);
2868 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2872 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2874 #if defined(USE_ITHREADS) && !defined(WIN32)
2875 /* only "parent" interpreter can diddle signals */
2876 if (PL_curinterp != aTHX)
2879 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2882 #endif /* !HAS_SIGACTION */
2883 #endif /* !PERL_MICRO */
2885 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2886 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2888 Perl_my_pclose(pTHX_ PerlIO *ptr)
2896 const int fd = PerlIO_fileno(ptr);
2899 svp = av_fetch(PL_fdpid,fd,TRUE);
2900 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2904 #if defined(USE_PERLIO)
2905 /* Find out whether the refcount is low enough for us to wait for the
2906 child proc without blocking. */
2907 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
2909 should_wait = pid > 0;
2913 if (pid == -1) { /* Opened by popen. */
2914 return my_syspclose(ptr);
2917 close_failed = (PerlIO_close(ptr) == EOF);
2919 if (should_wait) do {
2920 pid2 = wait4pid(pid, &status, 0);
2921 } while (pid2 == -1 && errno == EINTR);
2928 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2933 #if defined(__LIBCATAMOUNT__)
2935 Perl_my_pclose(pTHX_ PerlIO *ptr)
2940 #endif /* !DOSISH */
2942 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2944 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2947 PERL_ARGS_ASSERT_WAIT4PID;
2948 #ifdef PERL_USES_PL_PIDSTATUS
2950 /* PERL_USES_PL_PIDSTATUS is only defined when neither
2951 waitpid() nor wait4() is available, or on OS/2, which
2952 doesn't appear to support waiting for a progress group
2953 member, so we can only treat a 0 pid as an unknown child.
2960 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2961 pid, rather than a string form. */
2962 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2963 if (svp && *svp != &PL_sv_undef) {
2964 *statusp = SvIVX(*svp);
2965 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2973 hv_iterinit(PL_pidstatus);
2974 if ((entry = hv_iternext(PL_pidstatus))) {
2975 SV * const sv = hv_iterval(PL_pidstatus,entry);
2977 const char * const spid = hv_iterkey(entry,&len);
2979 assert (len == sizeof(Pid_t));
2980 memcpy((char *)&pid, spid, len);
2981 *statusp = SvIVX(sv);
2982 /* The hash iterator is currently on this entry, so simply
2983 calling hv_delete would trigger the lazy delete, which on
2984 aggregate does more work, beacuse next call to hv_iterinit()
2985 would spot the flag, and have to call the delete routine,
2986 while in the meantime any new entries can't re-use that
2988 hv_iterinit(PL_pidstatus);
2989 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2996 # ifdef HAS_WAITPID_RUNTIME
2997 if (!HAS_WAITPID_RUNTIME)
3000 result = PerlProc_waitpid(pid,statusp,flags);
3003 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3004 result = wait4(pid,statusp,flags,NULL);
3007 #ifdef PERL_USES_PL_PIDSTATUS
3008 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3013 Perl_croak(aTHX_ "Can't do waitpid with flags");
3015 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3016 pidgone(result,*statusp);
3022 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3025 if (result < 0 && errno == EINTR) {
3027 errno = EINTR; /* reset in case a signal handler changed $! */
3031 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3033 #ifdef PERL_USES_PL_PIDSTATUS
3035 S_pidgone(pTHX_ Pid_t pid, int status)
3039 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3040 SvUPGRADE(sv,SVt_IV);
3041 SvIV_set(sv, status);
3049 int /* Cannot prototype with I32
3051 my_syspclose(PerlIO *ptr)
3054 Perl_my_pclose(pTHX_ PerlIO *ptr)
3057 /* Needs work for PerlIO ! */
3058 FILE * const f = PerlIO_findFILE(ptr);
3059 const I32 result = pclose(f);
3060 PerlIO_releaseFILE(ptr,f);
3068 Perl_my_pclose(pTHX_ PerlIO *ptr)
3070 /* Needs work for PerlIO ! */
3071 FILE * const f = PerlIO_findFILE(ptr);
3072 I32 result = djgpp_pclose(f);
3073 result = (result << 8) & 0xff00;
3074 PerlIO_releaseFILE(ptr,f);
3079 #define PERL_REPEATCPY_LINEAR 4
3081 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3083 PERL_ARGS_ASSERT_REPEATCPY;
3088 croak_memory_wrap();
3091 memset(to, *from, count);
3094 IV items, linear, half;
3096 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3097 for (items = 0; items < linear; ++items) {
3098 const char *q = from;
3100 for (todo = len; todo > 0; todo--)
3105 while (items <= half) {
3106 IV size = items * len;
3107 memcpy(p, to, size);
3113 memcpy(p, to, (count - items) * len);
3119 Perl_same_dirent(pTHX_ const char *a, const char *b)
3121 char *fa = strrchr(a,'/');
3122 char *fb = strrchr(b,'/');
3125 SV * const tmpsv = sv_newmortal();
3127 PERL_ARGS_ASSERT_SAME_DIRENT;
3140 sv_setpvs(tmpsv, ".");
3142 sv_setpvn(tmpsv, a, fa - a);
3143 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3146 sv_setpvs(tmpsv, ".");
3148 sv_setpvn(tmpsv, b, fb - b);
3149 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3151 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3152 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3154 #endif /* !HAS_RENAME */
3157 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3158 const char *const *const search_ext, I32 flags)
3160 const char *xfound = NULL;
3161 char *xfailed = NULL;
3162 char tmpbuf[MAXPATHLEN];
3167 #if defined(DOSISH) && !defined(OS2)
3168 # define SEARCH_EXTS ".bat", ".cmd", NULL
3169 # define MAX_EXT_LEN 4
3172 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3173 # define MAX_EXT_LEN 4
3176 # define SEARCH_EXTS ".pl", ".com", NULL
3177 # define MAX_EXT_LEN 4
3179 /* additional extensions to try in each dir if scriptname not found */
3181 static const char *const exts[] = { SEARCH_EXTS };
3182 const char *const *const ext = search_ext ? search_ext : exts;
3183 int extidx = 0, i = 0;
3184 const char *curext = NULL;
3186 PERL_UNUSED_ARG(search_ext);
3187 # define MAX_EXT_LEN 0
3190 PERL_ARGS_ASSERT_FIND_SCRIPT;
3193 * If dosearch is true and if scriptname does not contain path
3194 * delimiters, search the PATH for scriptname.
3196 * If SEARCH_EXTS is also defined, will look for each
3197 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3198 * while searching the PATH.
3200 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3201 * proceeds as follows:
3202 * If DOSISH or VMSISH:
3203 * + look for ./scriptname{,.foo,.bar}
3204 * + search the PATH for scriptname{,.foo,.bar}
3207 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3208 * this will not look in '.' if it's not in the PATH)
3213 # ifdef ALWAYS_DEFTYPES
3214 len = strlen(scriptname);
3215 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3216 int idx = 0, deftypes = 1;
3219 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3222 int idx = 0, deftypes = 1;
3225 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3227 /* The first time through, just add SEARCH_EXTS to whatever we
3228 * already have, so we can check for default file types. */
3230 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3236 if ((strlen(tmpbuf) + strlen(scriptname)
3237 + MAX_EXT_LEN) >= sizeof tmpbuf)
3238 continue; /* don't search dir with too-long name */
3239 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3243 if (strEQ(scriptname, "-"))
3245 if (dosearch) { /* Look in '.' first. */
3246 const char *cur = scriptname;
3248 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3250 if (strEQ(ext[i++],curext)) {
3251 extidx = -1; /* already has an ext */
3256 DEBUG_p(PerlIO_printf(Perl_debug_log,
3257 "Looking for %s\n",cur));
3258 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3259 && !S_ISDIR(PL_statbuf.st_mode)) {
3267 if (cur == scriptname) {
3268 len = strlen(scriptname);
3269 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3271 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3274 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3275 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3280 if (dosearch && !strchr(scriptname, '/')
3282 && !strchr(scriptname, '\\')
3284 && (s = PerlEnv_getenv("PATH")))
3288 bufend = s + strlen(s);
3289 while (s < bufend) {
3292 && *s != ';'; len++, s++) {
3293 if (len < sizeof tmpbuf)
3296 if (len < sizeof tmpbuf)
3299 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3305 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3306 continue; /* don't search dir with too-long name */
3309 && tmpbuf[len - 1] != '/'
3310 && tmpbuf[len - 1] != '\\'
3313 tmpbuf[len++] = '/';
3314 if (len == 2 && tmpbuf[0] == '.')
3316 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3320 len = strlen(tmpbuf);
3321 if (extidx > 0) /* reset after previous loop */
3325 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3326 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3327 if (S_ISDIR(PL_statbuf.st_mode)) {
3331 } while ( retval < 0 /* not there */
3332 && extidx>=0 && ext[extidx] /* try an extension? */
3333 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3338 if (S_ISREG(PL_statbuf.st_mode)
3339 && cando(S_IRUSR,TRUE,&PL_statbuf)
3340 #if !defined(DOSISH)
3341 && cando(S_IXUSR,TRUE,&PL_statbuf)
3345 xfound = tmpbuf; /* bingo! */
3349 xfailed = savepv(tmpbuf);
3352 if (!xfound && !seen_dot && !xfailed &&
3353 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3354 || S_ISDIR(PL_statbuf.st_mode)))
3356 seen_dot = 1; /* Disable message. */
3358 if (flags & 1) { /* do or die? */
3359 /* diag_listed_as: Can't execute %s */
3360 Perl_croak(aTHX_ "Can't %s %s%s%s",
3361 (xfailed ? "execute" : "find"),
3362 (xfailed ? xfailed : scriptname),
3363 (xfailed ? "" : " on PATH"),
3364 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3369 scriptname = xfound;
3371 return (scriptname ? savepv(scriptname) : NULL);
3374 #ifndef PERL_GET_CONTEXT_DEFINED
3377 Perl_get_context(void)
3379 #if defined(USE_ITHREADS)
3381 # ifdef OLD_PTHREADS_API
3383 int error = pthread_getspecific(PL_thr_key, &t)
3385 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3388 # ifdef I_MACH_CTHREADS
3389 return (void*)cthread_data(cthread_self());
3391 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3400 Perl_set_context(void *t)
3402 #if defined(USE_ITHREADS)
3405 PERL_ARGS_ASSERT_SET_CONTEXT;
3406 #if defined(USE_ITHREADS)
3407 # ifdef I_MACH_CTHREADS
3408 cthread_set_data(cthread_self(), t);
3411 const int error = pthread_setspecific(PL_thr_key, t);
3413 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3421 #endif /* !PERL_GET_CONTEXT_DEFINED */
3423 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3427 PERL_UNUSED_CONTEXT;
3433 Perl_get_op_names(pTHX)
3435 PERL_UNUSED_CONTEXT;
3436 return (char **)PL_op_name;
3440 Perl_get_op_descs(pTHX)
3442 PERL_UNUSED_CONTEXT;
3443 return (char **)PL_op_desc;
3447 Perl_get_no_modify(pTHX)
3449 PERL_UNUSED_CONTEXT;
3450 return PL_no_modify;
3454 Perl_get_opargs(pTHX)
3456 PERL_UNUSED_CONTEXT;
3457 return (U32 *)PL_opargs;
3461 Perl_get_ppaddr(pTHX)
3464 PERL_UNUSED_CONTEXT;
3465 return (PPADDR_t*)PL_ppaddr;
3468 #ifndef HAS_GETENV_LEN
3470 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3472 char * const env_trans = PerlEnv_getenv(env_elem);
3473 PERL_UNUSED_CONTEXT;
3474 PERL_ARGS_ASSERT_GETENV_LEN;
3476 *len = strlen(env_trans);
3483 Perl_get_vtbl(pTHX_ int vtbl_id)
3485 PERL_UNUSED_CONTEXT;
3487 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3488 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3492 Perl_my_fflush_all(pTHX)
3494 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3495 return PerlIO_flush(NULL);
3497 # if defined(HAS__FWALK)
3498 extern int fflush(FILE *);
3499 /* undocumented, unprototyped, but very useful BSDism */
3500 extern void _fwalk(int (*)(FILE *));
3504 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3506 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3507 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3509 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3510 open_max = sysconf(_SC_OPEN_MAX);
3513 open_max = FOPEN_MAX;
3516 open_max = OPEN_MAX;
3527 for (i = 0; i < open_max; i++)
3528 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3529 STDIO_STREAM_ARRAY[i]._file < open_max &&
3530 STDIO_STREAM_ARRAY[i]._flag)
3531 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3535 SETERRNO(EBADF,RMS_IFI);
3542 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3544 if (ckWARN(WARN_IO)) {
3546 = gv && (isGV_with_GP(gv))
3549 const char * const direction = have == '>' ? "out" : "in";
3551 if (name && HEK_LEN(name))
3552 Perl_warner(aTHX_ packWARN(WARN_IO),
3553 "Filehandle %"HEKf" opened only for %sput",
3554 HEKfARG(name), direction);
3556 Perl_warner(aTHX_ packWARN(WARN_IO),
3557 "Filehandle opened only for %sput", direction);
3562 Perl_report_evil_fh(pTHX_ const GV *gv)
3564 const IO *io = gv ? GvIO(gv) : NULL;
3565 const PERL_BITFIELD16 op = PL_op->op_type;
3569 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3571 warn_type = WARN_CLOSED;
3575 warn_type = WARN_UNOPENED;
3578 if (ckWARN(warn_type)) {
3580 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3581 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3582 const char * const pars =
3583 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3584 const char * const func =
3586 (op == OP_READLINE || op == OP_RCATLINE
3587 ? "readline" : /* "<HANDLE>" not nice */
3588 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3590 const char * const type =
3592 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3593 ? "socket" : "filehandle");
3594 const bool have_name = name && SvCUR(name);
3595 Perl_warner(aTHX_ packWARN(warn_type),
3596 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3597 have_name ? " " : "",
3598 SVfARG(have_name ? name : &PL_sv_no));
3599 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3601 aTHX_ packWARN(warn_type),
3602 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3603 func, pars, have_name ? " " : "",
3604 SVfARG(have_name ? name : &PL_sv_no)
3609 /* To workaround core dumps from the uninitialised tm_zone we get the
3610 * system to give us a reasonable struct to copy. This fix means that
3611 * strftime uses the tm_zone and tm_gmtoff values returned by
3612 * localtime(time()). That should give the desired result most of the
3613 * time. But probably not always!
3615 * This does not address tzname aspects of NETaa14816.
3620 # ifndef STRUCT_TM_HASZONE
3621 # define STRUCT_TM_HASZONE
3625 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3626 # ifndef HAS_TM_TM_ZONE
3627 # define HAS_TM_TM_ZONE
3632 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3634 #ifdef HAS_TM_TM_ZONE
3636 const struct tm* my_tm;
3637 PERL_UNUSED_CONTEXT;
3638 PERL_ARGS_ASSERT_INIT_TM;
3640 my_tm = localtime(&now);
3642 Copy(my_tm, ptm, 1, struct tm);
3644 PERL_UNUSED_CONTEXT;
3645 PERL_ARGS_ASSERT_INIT_TM;
3646 PERL_UNUSED_ARG(ptm);
3651 * mini_mktime - normalise struct tm values without the localtime()
3652 * semantics (and overhead) of mktime().
3655 Perl_mini_mktime(struct tm *ptm)
3659 int month, mday, year, jday;
3660 int odd_cent, odd_year;
3662 PERL_ARGS_ASSERT_MINI_MKTIME;
3664 #define DAYS_PER_YEAR 365
3665 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3666 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3667 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3668 #define SECS_PER_HOUR (60*60)
3669 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3670 /* parentheses deliberately absent on these two, otherwise they don't work */
3671 #define MONTH_TO_DAYS 153/5
3672 #define DAYS_TO_MONTH 5/153
3673 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3674 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3675 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3676 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3679 * Year/day algorithm notes:
3681 * With a suitable offset for numeric value of the month, one can find
3682 * an offset into the year by considering months to have 30.6 (153/5) days,
3683 * using integer arithmetic (i.e., with truncation). To avoid too much
3684 * messing about with leap days, we consider January and February to be
3685 * the 13th and 14th month of the previous year. After that transformation,
3686 * we need the month index we use to be high by 1 from 'normal human' usage,
3687 * so the month index values we use run from 4 through 15.
3689 * Given that, and the rules for the Gregorian calendar (leap years are those
3690 * divisible by 4 unless also divisible by 100, when they must be divisible
3691 * by 400 instead), we can simply calculate the number of days since some
3692 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3693 * the days we derive from our month index, and adding in the day of the
3694 * month. The value used here is not adjusted for the actual origin which
3695 * it normally would use (1 January A.D. 1), since we're not exposing it.
3696 * We're only building the value so we can turn around and get the
3697 * normalised values for the year, month, day-of-month, and day-of-year.
3699 * For going backward, we need to bias the value we're using so that we find
3700 * the right year value. (Basically, we don't want the contribution of
3701 * March 1st to the number to apply while deriving the year). Having done
3702 * that, we 'count up' the contribution to the year number by accounting for
3703 * full quadracenturies (400-year periods) with their extra leap days, plus
3704 * the contribution from full centuries (to avoid counting in the lost leap
3705 * days), plus the contribution from full quad-years (to count in the normal
3706 * leap days), plus the leftover contribution from any non-leap years.
3707 * At this point, if we were working with an actual leap day, we'll have 0
3708 * days left over. This is also true for March 1st, however. So, we have
3709 * to special-case that result, and (earlier) keep track of the 'odd'
3710 * century and year contributions. If we got 4 extra centuries in a qcent,
3711 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3712 * Otherwise, we add back in the earlier bias we removed (the 123 from
3713 * figuring in March 1st), find the month index (integer division by 30.6),
3714 * and the remainder is the day-of-month. We then have to convert back to
3715 * 'real' months (including fixing January and February from being 14/15 in
3716 * the previous year to being in the proper year). After that, to get
3717 * tm_yday, we work with the normalised year and get a new yearday value for
3718 * January 1st, which we subtract from the yearday value we had earlier,
3719 * representing the date we've re-built. This is done from January 1
3720 * because tm_yday is 0-origin.
3722 * Since POSIX time routines are only guaranteed to work for times since the
3723 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3724 * applies Gregorian calendar rules even to dates before the 16th century
3725 * doesn't bother me. Besides, you'd need cultural context for a given
3726 * date to know whether it was Julian or Gregorian calendar, and that's
3727 * outside the scope for this routine. Since we convert back based on the
3728 * same rules we used to build the yearday, you'll only get strange results
3729 * for input which needed normalising, or for the 'odd' century years which
3730 * were leap years in the Julian calendar but not in the Gregorian one.
3731 * I can live with that.
3733 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3734 * that's still outside the scope for POSIX time manipulation, so I don't
3738 year = 1900 + ptm->tm_year;
3739 month = ptm->tm_mon;
3740 mday = ptm->tm_mday;
3746 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3747 yearday += month*MONTH_TO_DAYS + mday + jday;
3749 * Note that we don't know when leap-seconds were or will be,
3750 * so we have to trust the user if we get something which looks
3751 * like a sensible leap-second. Wild values for seconds will
3752 * be rationalised, however.
3754 if ((unsigned) ptm->tm_sec <= 60) {
3761 secs += 60 * ptm->tm_min;
3762 secs += SECS_PER_HOUR * ptm->tm_hour;
3764 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3765 /* got negative remainder, but need positive time */
3766 /* back off an extra day to compensate */
3767 yearday += (secs/SECS_PER_DAY)-1;
3768 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3771 yearday += (secs/SECS_PER_DAY);
3772 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3775 else if (secs >= SECS_PER_DAY) {
3776 yearday += (secs/SECS_PER_DAY);
3777 secs %= SECS_PER_DAY;
3779 ptm->tm_hour = secs/SECS_PER_HOUR;
3780 secs %= SECS_PER_HOUR;
3781 ptm->tm_min = secs/60;
3783 ptm->tm_sec += secs;
3784 /* done with time of day effects */
3786 * The algorithm for yearday has (so far) left it high by 428.
3787 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3788 * bias it by 123 while trying to figure out what year it
3789 * really represents. Even with this tweak, the reverse
3790 * translation fails for years before A.D. 0001.
3791 * It would still fail for Feb 29, but we catch that one below.
3793 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3794 yearday -= YEAR_ADJUST;
3795 year = (yearday / DAYS_PER_QCENT) * 400;
3796 yearday %= DAYS_PER_QCENT;
3797 odd_cent = yearday / DAYS_PER_CENT;
3798 year += odd_cent * 100;
3799 yearday %= DAYS_PER_CENT;
3800 year += (yearday / DAYS_PER_QYEAR) * 4;
3801 yearday %= DAYS_PER_QYEAR;
3802 odd_year = yearday / DAYS_PER_YEAR;
3804 yearday %= DAYS_PER_YEAR;
3805 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3810 yearday += YEAR_ADJUST; /* recover March 1st crock */
3811 month = yearday*DAYS_TO_MONTH;
3812 yearday -= month*MONTH_TO_DAYS;
3813 /* recover other leap-year adjustment */
3822 ptm->tm_year = year - 1900;
3824 ptm->tm_mday = yearday;
3825 ptm->tm_mon = month;
3829 ptm->tm_mon = month - 1;
3831 /* re-build yearday based on Jan 1 to get tm_yday */
3833 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3834 yearday += 14*MONTH_TO_DAYS + 1;
3835 ptm->tm_yday = jday - yearday;
3836 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3840 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)
3844 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
3851 PERL_ARGS_ASSERT_MY_STRFTIME;
3853 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3856 mytm.tm_hour = hour;
3857 mytm.tm_mday = mday;
3859 mytm.tm_year = year;
3860 mytm.tm_wday = wday;
3861 mytm.tm_yday = yday;
3862 mytm.tm_isdst = isdst;
3864 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3865 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3870 #ifdef HAS_TM_TM_GMTOFF
3871 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3873 #ifdef HAS_TM_TM_ZONE
3874 mytm.tm_zone = mytm2.tm_zone;
3879 Newx(buf, buflen, char);
3881 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3882 len = strftime(buf, buflen, fmt, &mytm);
3886 ** The following is needed to handle to the situation where
3887 ** tmpbuf overflows. Basically we want to allocate a buffer
3888 ** and try repeatedly. The reason why it is so complicated
3889 ** is that getting a return value of 0 from strftime can indicate
3890 ** one of the following:
3891 ** 1. buffer overflowed,
3892 ** 2. illegal conversion specifier, or
3893 ** 3. the format string specifies nothing to be returned(not
3894 ** an error). This could be because format is an empty string
3895 ** or it specifies %p that yields an empty string in some locale.
3896 ** If there is a better way to make it portable, go ahead by
3899 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3902 /* Possibly buf overflowed - try again with a bigger buf */
3903 const int fmtlen = strlen(fmt);
3904 int bufsize = fmtlen + buflen;
3906 Renew(buf, bufsize, char);
3909 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
3910 buflen = strftime(buf, bufsize, fmt, &mytm);
3913 if (buflen > 0 && buflen < bufsize)
3915 /* heuristic to prevent out-of-memory errors */
3916 if (bufsize > 100*fmtlen) {
3922 Renew(buf, bufsize, char);
3927 Perl_croak(aTHX_ "panic: no strftime");
3933 #define SV_CWD_RETURN_UNDEF \
3934 sv_setsv(sv, &PL_sv_undef); \
3937 #define SV_CWD_ISDOT(dp) \
3938 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3939 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3942 =head1 Miscellaneous Functions
3944 =for apidoc getcwd_sv
3946 Fill the sv with current working directory
3951 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3952 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3953 * getcwd(3) if available
3954 * Comments from the orignal:
3955 * This is a faster version of getcwd. It's also more dangerous
3956 * because you might chdir out of a directory that you can't chdir
3960 Perl_getcwd_sv(pTHX_ SV *sv)
3965 PERL_ARGS_ASSERT_GETCWD_SV;
3969 char buf[MAXPATHLEN];
3971 /* Some getcwd()s automatically allocate a buffer of the given
3972 * size from the heap if they are given a NULL buffer pointer.
3973 * The problem is that this behaviour is not portable. */
3974 if (getcwd(buf, sizeof(buf) - 1)) {
3979 sv_setsv(sv, &PL_sv_undef);
3987 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3991 SvUPGRADE(sv, SVt_PV);
3993 if (PerlLIO_lstat(".", &statbuf) < 0) {
3994 SV_CWD_RETURN_UNDEF;
3997 orig_cdev = statbuf.st_dev;
3998 orig_cino = statbuf.st_ino;
4008 if (PerlDir_chdir("..") < 0) {
4009 SV_CWD_RETURN_UNDEF;
4011 if (PerlLIO_stat(".", &statbuf) < 0) {
4012 SV_CWD_RETURN_UNDEF;
4015 cdev = statbuf.st_dev;
4016 cino = statbuf.st_ino;
4018 if (odev == cdev && oino == cino) {
4021 if (!(dir = PerlDir_open("."))) {
4022 SV_CWD_RETURN_UNDEF;
4025 while ((dp = PerlDir_read(dir)) != NULL) {
4027 namelen = dp->d_namlen;
4029 namelen = strlen(dp->d_name);
4032 if (SV_CWD_ISDOT(dp)) {
4036 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4037 SV_CWD_RETURN_UNDEF;
4040 tdev = statbuf.st_dev;
4041 tino = statbuf.st_ino;
4042 if (tino == oino && tdev == odev) {
4048 SV_CWD_RETURN_UNDEF;
4051 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4052 SV_CWD_RETURN_UNDEF;
4055 SvGROW(sv, pathlen + namelen + 1);
4059 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4062 /* prepend current directory to the front */
4064 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4065 pathlen += (namelen + 1);
4067 #ifdef VOID_CLOSEDIR
4070 if (PerlDir_close(dir) < 0) {
4071 SV_CWD_RETURN_UNDEF;
4077 SvCUR_set(sv, pathlen);
4081 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4082 SV_CWD_RETURN_UNDEF;
4085 if (PerlLIO_stat(".", &statbuf) < 0) {
4086 SV_CWD_RETURN_UNDEF;
4089 cdev = statbuf.st_dev;
4090 cino = statbuf.st_ino;
4092 if (cdev != orig_cdev || cino != orig_cino) {
4093 Perl_croak(aTHX_ "Unstable directory path, "
4094 "current directory changed unexpectedly");
4107 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4108 # define EMULATE_SOCKETPAIR_UDP
4111 #ifdef EMULATE_SOCKETPAIR_UDP
4113 S_socketpair_udp (int fd[2]) {
4115 /* Fake a datagram socketpair using UDP to localhost. */
4116 int sockets[2] = {-1, -1};
4117 struct sockaddr_in addresses[2];
4119 Sock_size_t size = sizeof(struct sockaddr_in);
4120 unsigned short port;
4123 memset(&addresses, 0, sizeof(addresses));
4126 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4127 if (sockets[i] == -1)
4128 goto tidy_up_and_fail;
4130 addresses[i].sin_family = AF_INET;
4131 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4132 addresses[i].sin_port = 0; /* kernel choses port. */
4133 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4134 sizeof(struct sockaddr_in)) == -1)
4135 goto tidy_up_and_fail;
4138 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4139 for each connect the other socket to it. */
4142 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4144 goto tidy_up_and_fail;
4145 if (size != sizeof(struct sockaddr_in))
4146 goto abort_tidy_up_and_fail;
4147 /* !1 is 0, !0 is 1 */
4148 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4149 sizeof(struct sockaddr_in)) == -1)
4150 goto tidy_up_and_fail;
4153 /* Now we have 2 sockets connected to each other. I don't trust some other
4154 process not to have already sent a packet to us (by random) so send
4155 a packet from each to the other. */
4158 /* I'm going to send my own port number. As a short.
4159 (Who knows if someone somewhere has sin_port as a bitfield and needs
4160 this routine. (I'm assuming crays have socketpair)) */
4161 port = addresses[i].sin_port;
4162 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4163 if (got != sizeof(port)) {
4165 goto tidy_up_and_fail;
4166 goto abort_tidy_up_and_fail;
4170 /* Packets sent. I don't trust them to have arrived though.
4171 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4172 connect to localhost will use a second kernel thread. In 2.6 the
4173 first thread running the connect() returns before the second completes,
4174 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4175 returns 0. Poor programs have tripped up. One poor program's authors'
4176 had a 50-1 reverse stock split. Not sure how connected these were.)
4177 So I don't trust someone not to have an unpredictable UDP stack.
4181 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4182 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4186 FD_SET((unsigned int)sockets[0], &rset);
4187 FD_SET((unsigned int)sockets[1], &rset);
4189 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4190 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4191 || !FD_ISSET(sockets[1], &rset)) {
4192 /* I hope this is portable and appropriate. */
4194 goto tidy_up_and_fail;
4195 goto abort_tidy_up_and_fail;
4199 /* And the paranoia department even now doesn't trust it to have arrive
4200 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4202 struct sockaddr_in readfrom;
4203 unsigned short buffer[2];
4208 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4209 sizeof(buffer), MSG_DONTWAIT,
4210 (struct sockaddr *) &readfrom, &size);
4212 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4214 (struct sockaddr *) &readfrom, &size);
4218 goto tidy_up_and_fail;
4219 if (got != sizeof(port)
4220 || size != sizeof(struct sockaddr_in)
4221 /* Check other socket sent us its port. */
4222 || buffer[0] != (unsigned short) addresses[!i].sin_port
4223 /* Check kernel says we got the datagram from that socket */
4224 || readfrom.sin_family != addresses[!i].sin_family
4225 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4226 || readfrom.sin_port != addresses[!i].sin_port)
4227 goto abort_tidy_up_and_fail;
4230 /* My caller (my_socketpair) has validated that this is non-NULL */
4233 /* I hereby declare this connection open. May God bless all who cross
4237 abort_tidy_up_and_fail:
4238 errno = ECONNABORTED;
4242 if (sockets[0] != -1)
4243 PerlLIO_close(sockets[0]);
4244 if (sockets[1] != -1)
4245 PerlLIO_close(sockets[1]);
4250 #endif /* EMULATE_SOCKETPAIR_UDP */
4252 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4254 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4255 /* Stevens says that family must be AF_LOCAL, protocol 0.
4256 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4261 struct sockaddr_in listen_addr;
4262 struct sockaddr_in connect_addr;
4267 || family != AF_UNIX
4270 errno = EAFNOSUPPORT;
4278 #ifdef EMULATE_SOCKETPAIR_UDP
4279 if (type == SOCK_DGRAM)
4280 return S_socketpair_udp(fd);
4283 aTHXa(PERL_GET_THX);
4284 listener = PerlSock_socket(AF_INET, type, 0);
4287 memset(&listen_addr, 0, sizeof(listen_addr));
4288 listen_addr.sin_family = AF_INET;
4289 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4290 listen_addr.sin_port = 0; /* kernel choses port. */
4291 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4292 sizeof(listen_addr)) == -1)
4293 goto tidy_up_and_fail;
4294 if (PerlSock_listen(listener, 1) == -1)
4295 goto tidy_up_and_fail;
4297 connector = PerlSock_socket(AF_INET, type, 0);
4298 if (connector == -1)
4299 goto tidy_up_and_fail;
4300 /* We want to find out the port number to connect to. */
4301 size = sizeof(connect_addr);
4302 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4304 goto tidy_up_and_fail;
4305 if (size != sizeof(connect_addr))
4306 goto abort_tidy_up_and_fail;
4307 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4308 sizeof(connect_addr)) == -1)
4309 goto tidy_up_and_fail;
4311 size = sizeof(listen_addr);
4312 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4315 goto tidy_up_and_fail;
4316 if (size != sizeof(listen_addr))
4317 goto abort_tidy_up_and_fail;
4318 PerlLIO_close(listener);
4319 /* Now check we are talking to ourself by matching port and host on the
4321 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4323 goto tidy_up_and_fail;
4324 if (size != sizeof(connect_addr)
4325 || listen_addr.sin_family != connect_addr.sin_family
4326 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4327 || listen_addr.sin_port != connect_addr.sin_port) {
4328 goto abort_tidy_up_and_fail;
4334 abort_tidy_up_and_fail:
4336 errno = ECONNABORTED; /* This would be the standard thing to do. */
4338 # ifdef ECONNREFUSED
4339 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4341 errno = ETIMEDOUT; /* Desperation time. */
4348 PerlLIO_close(listener);
4349 if (connector != -1)
4350 PerlLIO_close(connector);
4352 PerlLIO_close(acceptor);
4358 /* In any case have a stub so that there's code corresponding
4359 * to the my_socketpair in embed.fnc. */
4361 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4362 #ifdef HAS_SOCKETPAIR
4363 return socketpair(family, type, protocol, fd);
4372 =for apidoc sv_nosharing
4374 Dummy routine which "shares" an SV when there is no sharing module present.
4375 Or "locks" it. Or "unlocks" it. In other
4376 words, ignores its single SV argument.
4377 Exists to avoid test for a NULL function pointer and because it could
4378 potentially warn under some level of strict-ness.
4384 Perl_sv_nosharing(pTHX_ SV *sv)
4386 PERL_UNUSED_CONTEXT;
4387 PERL_UNUSED_ARG(sv);
4392 =for apidoc sv_destroyable
4394 Dummy routine which reports that object can be destroyed when there is no
4395 sharing module present. It ignores its single SV argument, and returns
4396 'true'. Exists to avoid test for a NULL function pointer and because it
4397 could potentially warn under some level of strict-ness.
4403 Perl_sv_destroyable(pTHX_ SV *sv)
4405 PERL_UNUSED_CONTEXT;
4406 PERL_UNUSED_ARG(sv);
4411 Perl_parse_unicode_opts(pTHX_ const char **popt)
4413 const char *p = *popt;
4416 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4421 opt = (U32) grok_atou(p, &endptr);
4423 if (*p && *p != '\n' && *p != '\r') {
4424 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4426 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4432 case PERL_UNICODE_STDIN:
4433 opt |= PERL_UNICODE_STDIN_FLAG; break;
4434 case PERL_UNICODE_STDOUT:
4435 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4436 case PERL_UNICODE_STDERR:
4437 opt |= PERL_UNICODE_STDERR_FLAG; break;
4438 case PERL_UNICODE_STD:
4439 opt |= PERL_UNICODE_STD_FLAG; break;
4440 case PERL_UNICODE_IN:
4441 opt |= PERL_UNICODE_IN_FLAG; break;
4442 case PERL_UNICODE_OUT:
4443 opt |= PERL_UNICODE_OUT_FLAG; break;
4444 case PERL_UNICODE_INOUT:
4445 opt |= PERL_UNICODE_INOUT_FLAG; break;
4446 case PERL_UNICODE_LOCALE:
4447 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4448 case PERL_UNICODE_ARGV:
4449 opt |= PERL_UNICODE_ARGV_FLAG; break;
4450 case PERL_UNICODE_UTF8CACHEASSERT:
4451 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4453 if (*p != '\n' && *p != '\r') {
4454 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4457 "Unknown Unicode option letter '%c'", *p);
4464 opt = PERL_UNICODE_DEFAULT_FLAGS;
4466 the_end_of_the_opts_parser:
4468 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4469 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
4470 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4478 # include <starlet.h>
4485 * This is really just a quick hack which grabs various garbage
4486 * values. It really should be a real hash algorithm which
4487 * spreads the effect of every input bit onto every output bit,
4488 * if someone who knows about such things would bother to write it.
4489 * Might be a good idea to add that function to CORE as well.
4490 * No numbers below come from careful analysis or anything here,
4491 * except they are primes and SEED_C1 > 1E6 to get a full-width
4492 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4493 * probably be bigger too.
4496 # define SEED_C1 1000003
4497 #define SEED_C4 73819
4499 # define SEED_C1 25747
4500 #define SEED_C4 20639
4504 #define SEED_C5 26107
4506 #ifndef PERL_NO_DEV_RANDOM
4511 /* when[] = (low 32 bits, high 32 bits) of time since epoch
4512 * in 100-ns units, typically incremented ever 10 ms. */
4513 unsigned int when[2];
4515 # ifdef HAS_GETTIMEOFDAY
4516 struct timeval when;
4522 /* This test is an escape hatch, this symbol isn't set by Configure. */
4523 #ifndef PERL_NO_DEV_RANDOM
4524 #ifndef PERL_RANDOM_DEVICE
4525 /* /dev/random isn't used by default because reads from it will block
4526 * if there isn't enough entropy available. You can compile with
4527 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4528 * is enough real entropy to fill the seed. */
4529 # define PERL_RANDOM_DEVICE "/dev/urandom"
4531 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4533 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4542 _ckvmssts(sys$gettim(when));
4543 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
4545 # ifdef HAS_GETTIMEOFDAY
4546 PerlProc_gettimeofday(&when,NULL);
4547 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4550 u = (U32)SEED_C1 * when;
4553 u += SEED_C3 * (U32)PerlProc_getpid();
4554 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4555 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4556 u += SEED_C5 * (U32)PTR2UV(&when);
4562 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4567 PERL_ARGS_ASSERT_GET_HASH_SEED;
4569 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4572 #ifndef USE_HASH_SEED_EXPLICIT
4574 /* ignore leading spaces */
4575 while (isSPACE(*env_pv))
4577 #ifdef USE_PERL_PERTURB_KEYS
4578 /* if they set it to "0" we disable key traversal randomization completely */
4579 if (strEQ(env_pv,"0")) {
4580 PL_hash_rand_bits_enabled= 0;
4582 /* otherwise switch to deterministic mode */
4583 PL_hash_rand_bits_enabled= 2;
4586 /* ignore a leading 0x... if it is there */
4587 if (env_pv[0] == '0' && env_pv[1] == 'x')
4590 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4591 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4592 if ( isXDIGIT(*env_pv)) {
4593 seed_buffer[i] |= READ_XDIGIT(env_pv);
4596 while (isSPACE(*env_pv))
4599 if (*env_pv && !isXDIGIT(*env_pv)) {
4600 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4602 /* should we check for unparsed crap? */
4603 /* should we warn about unused hex? */
4604 /* should we warn about insufficient hex? */
4609 (void)seedDrand01((Rand_seed_t)seed());
4611 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4612 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4615 #ifdef USE_PERL_PERTURB_KEYS
4616 { /* initialize PL_hash_rand_bits from the hash seed.
4617 * This value is highly volatile, it is updated every
4618 * hash insert, and is used as part of hash bucket chain
4619 * randomization and hash iterator randomization. */
4620 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4621 for( i = 0; i < sizeof(UV) ; i++ ) {
4622 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4623 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4626 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4628 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4629 PL_hash_rand_bits_enabled= 0;
4630 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4631 PL_hash_rand_bits_enabled= 1;
4632 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4633 PL_hash_rand_bits_enabled= 2;
4635 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4641 #ifdef PERL_GLOBAL_STRUCT
4643 #define PERL_GLOBAL_STRUCT_INIT
4644 #include "opcode.h" /* the ppaddr and check */
4647 Perl_init_global_struct(pTHX)
4649 struct perl_vars *plvarsp = NULL;
4650 # ifdef PERL_GLOBAL_STRUCT
4651 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4652 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4653 PERL_UNUSED_CONTEXT;
4654 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4655 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4656 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4660 plvarsp = PL_VarsPtr;
4661 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4666 # define PERLVAR(prefix,var,type) /**/
4667 # define PERLVARA(prefix,var,n,type) /**/
4668 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4669 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4670 # include "perlvars.h"
4675 # ifdef PERL_GLOBAL_STRUCT
4678 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4679 if (!plvarsp->Gppaddr)
4683 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4684 if (!plvarsp->Gcheck)
4686 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4687 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4689 # ifdef PERL_SET_VARS
4690 PERL_SET_VARS(plvarsp);
4692 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4693 plvarsp->Gsv_placeholder.sv_flags = 0;
4694 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4696 # undef PERL_GLOBAL_STRUCT_INIT
4701 #endif /* PERL_GLOBAL_STRUCT */
4703 #ifdef PERL_GLOBAL_STRUCT
4706 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4708 int veto = plvarsp->Gveto_cleanup;
4710 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4711 PERL_UNUSED_CONTEXT;
4712 # ifdef PERL_GLOBAL_STRUCT
4713 # ifdef PERL_UNSET_VARS
4714 PERL_UNSET_VARS(plvarsp);
4718 free(plvarsp->Gppaddr);
4719 free(plvarsp->Gcheck);
4720 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4726 #endif /* PERL_GLOBAL_STRUCT */
4730 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
4731 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4732 * given, and you supply your own implementation.
4734 * The default implementation reads a single env var, PERL_MEM_LOG,
4735 * expecting one or more of the following:
4737 * \d+ - fd fd to write to : must be 1st (grok_atou)
4738 * 'm' - memlog was PERL_MEM_LOG=1
4739 * 's' - svlog was PERL_SV_LOG=1
4740 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4742 * This makes the logger controllable enough that it can reasonably be
4743 * added to the system perl.
4746 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4747 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4749 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4751 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4752 * writes to. In the default logger, this is settable at runtime.
4754 #ifndef PERL_MEM_LOG_FD
4755 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4758 #ifndef PERL_MEM_LOG_NOIMPL
4760 # ifdef DEBUG_LEAKING_SCALARS
4761 # define SV_LOG_SERIAL_FMT " [%lu]"
4762 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4764 # define SV_LOG_SERIAL_FMT
4765 # define _SV_LOG_SERIAL_ARG(sv)
4769 S_mem_log_common(enum mem_log_type mlt, const UV n,
4770 const UV typesize, const char *type_name, const SV *sv,
4771 Malloc_t oldalloc, Malloc_t newalloc,
4772 const char *filename, const int linenumber,
4773 const char *funcname)
4777 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4779 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4782 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4784 /* We can't use SVs or PerlIO for obvious reasons,
4785 * so we'll use stdio and low-level IO instead. */
4786 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4788 # ifdef HAS_GETTIMEOFDAY
4789 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4790 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4792 gettimeofday(&tv, 0);
4794 # define MEM_LOG_TIME_FMT "%10d: "
4795 # define MEM_LOG_TIME_ARG (int)when
4799 /* If there are other OS specific ways of hires time than
4800 * gettimeofday() (see ext/Time-HiRes), the easiest way is
4801 * probably that they would be used to fill in the struct
4806 int fd = grok_atou(pmlenv, &endptr); /* Ignore endptr. */
4808 fd = PERL_MEM_LOG_FD;
4810 if (strchr(pmlenv, 't')) {
4811 len = my_snprintf(buf, sizeof(buf),
4812 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4813 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4817 len = my_snprintf(buf, sizeof(buf),
4818 "alloc: %s:%d:%s: %"IVdf" %"UVuf
4819 " %s = %"IVdf": %"UVxf"\n",
4820 filename, linenumber, funcname, n, typesize,
4821 type_name, n * typesize, PTR2UV(newalloc));
4824 len = my_snprintf(buf, sizeof(buf),
4825 "realloc: %s:%d:%s: %"IVdf" %"UVuf
4826 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
4827 filename, linenumber, funcname, n, typesize,
4828 type_name, n * typesize, PTR2UV(oldalloc),
4832 len = my_snprintf(buf, sizeof(buf),
4833 "free: %s:%d:%s: %"UVxf"\n",
4834 filename, linenumber, funcname,
4839 len = my_snprintf(buf, sizeof(buf),
4840 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
4841 mlt == MLT_NEW_SV ? "new" : "del",
4842 filename, linenumber, funcname,
4843 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
4848 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4852 #endif /* !PERL_MEM_LOG_NOIMPL */
4854 #ifndef PERL_MEM_LOG_NOIMPL
4856 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
4857 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
4859 /* this is suboptimal, but bug compatible. User is providing their
4860 own implementation, but is getting these functions anyway, and they
4861 do nothing. But _NOIMPL users should be able to cope or fix */
4863 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
4864 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
4868 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
4870 const char *filename, const int linenumber,
4871 const char *funcname)
4873 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
4874 NULL, NULL, newalloc,
4875 filename, linenumber, funcname);
4880 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
4881 Malloc_t oldalloc, Malloc_t newalloc,
4882 const char *filename, const int linenumber,
4883 const char *funcname)
4885 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
4886 NULL, oldalloc, newalloc,
4887 filename, linenumber, funcname);
4892 Perl_mem_log_free(Malloc_t oldalloc,
4893 const char *filename, const int linenumber,
4894 const char *funcname)
4896 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
4897 filename, linenumber, funcname);
4902 Perl_mem_log_new_sv(const SV *sv,
4903 const char *filename, const int linenumber,
4904 const char *funcname)
4906 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
4907 filename, linenumber, funcname);
4911 Perl_mem_log_del_sv(const SV *sv,
4912 const char *filename, const int linenumber,
4913 const char *funcname)
4915 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
4916 filename, linenumber, funcname);
4919 #endif /* PERL_MEM_LOG */
4922 =for apidoc my_sprintf
4924 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
4925 the length of the string written to the buffer. Only rare pre-ANSI systems
4926 need the wrapper function - usually this is a direct call to C<sprintf>.
4930 #ifndef SPRINTF_RETURNS_STRLEN
4932 Perl_my_sprintf(char *buffer, const char* pat, ...)
4935 PERL_ARGS_ASSERT_MY_SPRINTF;
4936 va_start(args, pat);
4937 vsprintf(buffer, pat, args);
4939 return strlen(buffer);
4944 =for apidoc quadmath_format_single
4946 quadmath_snprintf() is very strict about its format string and will
4947 fail, returning -1, if the format is invalid. It acccepts exactly
4950 quadmath_format_single() checks that the intended single spec looks
4951 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
4952 and has C<Q> before it. This is not a full "printf syntax check",
4955 Returns the format if it is valid, NULL if not.
4957 quadmath_format_single() can and will actually patch in the missing
4958 C<Q>, if necessary. In this case it will return the modified copy of
4959 the format, B<which the caller will need to free.>
4961 See also L</quadmath_format_needed>.
4967 Perl_quadmath_format_single(const char* format)
4971 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
4973 if (format[0] != '%' || strchr(format + 1, '%'))
4975 len = strlen(format);
4976 /* minimum length three: %Qg */
4977 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
4979 if (format[len - 2] != 'Q') {
4981 Newx(fixed, len + 1, char);
4982 memcpy(fixed, format, len - 1);
4983 fixed[len - 1] = 'Q';
4984 fixed[len ] = format[len - 1];
4986 return (const char*)fixed;
4993 =for apidoc quadmath_format_needed
4995 quadmath_format_needed() returns true if the format string seems to
4996 contain at least one non-Q-prefixed %[efgaEFGA] format specifier,
4997 or returns false otherwise.
4999 The format specifier detection is not complete printf-syntax detection,
5000 but it should catch most common cases.
5002 If true is returned, those arguments B<should> in theory be processed
5003 with quadmath_snprintf(), but in case there is more than one such
5004 format specifier (see L</quadmath_format_single>), and if there is
5005 anything else beyond that one (even just a single byte), they
5006 B<cannot> be processed because quadmath_snprintf() is very strict,
5007 accepting only one format spec, and nothing else.
5008 In this case, the code should probably fail.
5014 Perl_quadmath_format_needed(const char* format)
5016 const char *p = format;
5019 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5021 while ((q = strchr(p, '%'))) {
5023 if (*q == '+') /* plus */
5025 if (*q == '#') /* alt */
5027 if (*q == '*') /* width */
5031 while (isDIGIT(*q)) q++;
5034 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5039 while (isDIGIT(*q)) q++;
5041 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5050 =for apidoc my_snprintf
5052 The C library C<snprintf> functionality, if available and
5053 standards-compliant (uses C<vsnprintf>, actually). However, if the
5054 C<vsnprintf> is not available, will unfortunately use the unsafe
5055 C<vsprintf> which can overrun the buffer (there is an overrun check,
5056 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5057 getting C<vsnprintf>.
5062 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5066 PERL_ARGS_ASSERT_MY_SNPRINTF;
5067 #ifndef HAS_VSNPRINTF
5068 PERL_UNUSED_VAR(len);
5070 va_start(ap, format);
5073 const char* qfmt = quadmath_format_single(format);
5074 bool quadmath_valid = FALSE;
5076 /* If the format looked promising, use it as quadmath. */
5077 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5079 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5080 quadmath_valid = TRUE;
5085 assert(qfmt == NULL);
5086 /* quadmath_format_single() will return false for example for
5087 * "foo = %g", or simply "%g". We could handle the %g by
5088 * using quadmath for the NV args. More complex cases of
5089 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5090 * quadmath-valid but has stuff in front).
5092 * Handling the "Q-less" cases right would require walking
5093 * through the va_list and rewriting the format, calling
5094 * quadmath for the NVs, building a new va_list, and then
5095 * letting vsnprintf/vsprintf to take care of the other
5096 * arguments. This may be doable.
5098 * We do not attempt that now. But for paranoia, we here try
5099 * to detect some common (but not all) cases where the
5100 * "Q-less" %[efgaEFGA] formats are present, and die if
5101 * detected. This doesn't fix the problem, but it stops the
5102 * vsnprintf/vsprintf pulling doubles off the va_list when
5103 * __float128 NVs should be pulled off instead.
5105 * If quadmath_format_needed() returns false, we are reasonably
5106 * certain that we can call vnsprintf() or vsprintf() safely. */
5107 if (!quadmath_valid && quadmath_format_needed(format))
5108 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5113 #ifdef HAS_VSNPRINTF
5114 retval = vsnprintf(buffer, len, format, ap);
5116 retval = vsprintf(buffer, format, ap);
5119 /* vsprintf() shows failure with < 0 */
5121 #ifdef HAS_VSNPRINTF
5122 /* vsnprintf() shows failure with >= len */
5124 (len > 0 && (Size_t)retval >= len)
5127 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5132 =for apidoc my_vsnprintf
5134 The C library C<vsnprintf> if available and standards-compliant.
5135 However, if if the C<vsnprintf> is not available, will unfortunately
5136 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5137 overrun check, but that may be too late). Consider using
5138 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5143 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5146 PERL_UNUSED_ARG(buffer);
5147 PERL_UNUSED_ARG(len);
5148 PERL_UNUSED_ARG(format);
5149 PERL_UNUSED_ARG(ap);
5150 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5157 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5158 #ifndef HAS_VSNPRINTF
5159 PERL_UNUSED_VAR(len);
5161 Perl_va_copy(ap, apc);
5162 # ifdef HAS_VSNPRINTF
5163 retval = vsnprintf(buffer, len, format, apc);
5165 retval = vsprintf(buffer, format, apc);
5169 # ifdef HAS_VSNPRINTF
5170 retval = vsnprintf(buffer, len, format, ap);
5172 retval = vsprintf(buffer, format, ap);
5174 #endif /* #ifdef NEED_VA_COPY */
5175 /* vsprintf() shows failure with < 0 */
5177 #ifdef HAS_VSNPRINTF
5178 /* vsnprintf() shows failure with >= len */
5180 (len > 0 && (Size_t)retval >= len)
5183 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5189 Perl_my_clearenv(pTHX)
5192 #if ! defined(PERL_MICRO)
5193 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5195 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5196 # if defined(USE_ENVIRON_ARRAY)
5197 # if defined(USE_ITHREADS)
5198 /* only the parent thread can clobber the process environment */
5199 if (PL_curinterp == aTHX)
5200 # endif /* USE_ITHREADS */
5202 # if ! defined(PERL_USE_SAFE_PUTENV)
5203 if ( !PL_use_safe_putenv) {
5205 if (environ == PL_origenviron)
5206 environ = (char**)safesysmalloc(sizeof(char*));
5208 for (i = 0; environ[i]; i++)
5209 (void)safesysfree(environ[i]);
5212 # else /* PERL_USE_SAFE_PUTENV */
5213 # if defined(HAS_CLEARENV)
5215 # elif defined(HAS_UNSETENV)
5216 int bsiz = 80; /* Most envvar names will be shorter than this. */
5217 char *buf = (char*)safesysmalloc(bsiz);
5218 while (*environ != NULL) {
5219 char *e = strchr(*environ, '=');
5220 int l = e ? e - *environ : (int)strlen(*environ);
5222 (void)safesysfree(buf);
5223 bsiz = l + 1; /* + 1 for the \0. */
5224 buf = (char*)safesysmalloc(bsiz);
5226 memcpy(buf, *environ, l);
5228 (void)unsetenv(buf);
5230 (void)safesysfree(buf);
5231 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5232 /* Just null environ and accept the leakage. */
5234 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5235 # endif /* ! PERL_USE_SAFE_PUTENV */
5237 # endif /* USE_ENVIRON_ARRAY */
5238 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5239 #endif /* PERL_MICRO */
5242 #ifdef PERL_IMPLICIT_CONTEXT
5244 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5245 the global PL_my_cxt_index is incremented, and that value is assigned to
5246 that module's static my_cxt_index (who's address is passed as an arg).
5247 Then, for each interpreter this function is called for, it makes sure a
5248 void* slot is available to hang the static data off, by allocating or
5249 extending the interpreter's PL_my_cxt_list array */
5251 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5253 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5257 PERL_ARGS_ASSERT_MY_CXT_INIT;
5259 /* this module hasn't been allocated an index yet */
5260 #if defined(USE_ITHREADS)
5261 MUTEX_LOCK(&PL_my_ctx_mutex);
5263 *index = PL_my_cxt_index++;
5264 #if defined(USE_ITHREADS)
5265 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5269 /* make sure the array is big enough */
5270 if (PL_my_cxt_size <= *index) {
5271 if (PL_my_cxt_size) {
5272 while (PL_my_cxt_size <= *index)
5273 PL_my_cxt_size *= 2;
5274 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5277 PL_my_cxt_size = 16;
5278 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5281 /* newSV() allocates one more than needed */
5282 p = (void*)SvPVX(newSV(size-1));
5283 PL_my_cxt_list[*index] = p;
5284 Zero(p, size, char);
5288 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5291 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5296 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5298 for (index = 0; index < PL_my_cxt_index; index++) {
5299 const char *key = PL_my_cxt_keys[index];
5300 /* try direct pointer compare first - there are chances to success,
5301 * and it's much faster.
5303 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5310 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5316 PERL_ARGS_ASSERT_MY_CXT_INIT;
5318 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5320 /* this module hasn't been allocated an index yet */
5321 #if defined(USE_ITHREADS)
5322 MUTEX_LOCK(&PL_my_ctx_mutex);
5324 index = PL_my_cxt_index++;
5325 #if defined(USE_ITHREADS)
5326 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5330 /* make sure the array is big enough */
5331 if (PL_my_cxt_size <= index) {
5332 int old_size = PL_my_cxt_size;
5334 if (PL_my_cxt_size) {
5335 while (PL_my_cxt_size <= index)
5336 PL_my_cxt_size *= 2;
5337 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5338 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5341 PL_my_cxt_size = 16;
5342 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5343 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5345 for (i = old_size; i < PL_my_cxt_size; i++) {
5346 PL_my_cxt_keys[i] = 0;
5347 PL_my_cxt_list[i] = 0;
5350 PL_my_cxt_keys[index] = my_cxt_key;
5351 /* newSV() allocates one more than needed */
5352 p = (void*)SvPVX(newSV(size-1));
5353 PL_my_cxt_list[index] = p;
5354 Zero(p, size, char);
5357 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5358 #endif /* PERL_IMPLICIT_CONTEXT */
5361 /* Perl_xs_handshake():
5362 implement the various XS_*_BOOTCHECK macros, which are added to .c
5363 files by ExtUtils::ParseXS, to check that the perl the module was built
5364 with is binary compatible with the running perl.
5367 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5368 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5370 The meaning of the varargs is determined the U32 key arg (which is not
5371 a format string). The fields of key are assembled by using HS_KEY().
5373 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5374 "PerlInterpreter *" and represents the callers context; otherwise it is
5375 of type "CV *", and is the boot xsub's CV.
5377 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5378 for example, and IO.dll was linked with threaded perl524.dll, and both
5379 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5380 successfully can load IO.dll into the process but simultaneously it
5381 loaded an interpreter of a different version into the process, and XS
5382 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5383 use through perl526.dll's my_perl->Istack_base.
5385 v_my_perl cannot be the first arg, since then 'key' will be out of
5386 place in a threaded vs non-threaded mixup; and analyzing the key
5387 number's bitfields won't reveal the problem, since it will be a valid
5388 key (unthreaded perl) on interp side, but croak will report the XS mod's
5389 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5390 it's a threaded perl and an unthreaded XS module, threaded perl will
5391 look at an uninit C stack or an uninit register to get 'key'
5392 (remember that it assumes that the 1st arg is the interp cxt).
5394 'file' is the source filename of the caller.
5398 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5404 #ifdef PERL_IMPLICIT_CONTEXT
5411 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5412 va_start(args, file);
5414 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5415 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5416 if (UNLIKELY(got != need))
5418 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5419 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5420 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5421 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5422 passed to the XS DLL */
5423 #ifdef PERL_IMPLICIT_CONTEXT
5424 xs_interp = (tTHX)v_my_perl;
5428 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5429 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5430 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5431 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5432 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5433 location in the unthreaded perl binary) stored in CV * to figure out if this
5434 Perl_xs_handshake was called by the same pp_entersub */
5435 cv = (CV*)v_my_perl;
5436 xs_spp = (SV***)CvHSCXT(cv);
5438 need = &PL_stack_sp;
5440 if(UNLIKELY(got != need)) {
5441 bad_handshake:/* recycle branch and string from above */
5442 if(got != (void *)HSf_NOCHK)
5443 noperl_die("%s: loadable library and perl binaries are mismatched"
5444 " (got handshake key %p, needed %p)\n",
5448 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5449 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5450 PL_xsubfilename = file; /* so the old name must be restored for
5451 additional XSUBs to register themselves */
5452 (void)gv_fetchfile(file);
5455 if(key & HSf_POPMARK) {
5457 { SV **mark = PL_stack_base + ax++;
5459 items = (I32)(SP - MARK);
5463 items = va_arg(args, U32);
5464 ax = va_arg(args, U32);
5468 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5469 if((apiverlen = HS_GETAPIVERLEN(key))) {
5470 char * api_p = va_arg(args, char*);
5471 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5472 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5473 sizeof("v" PERL_API_VERSION_STRING)-1))
5474 Perl_croak_nocontext("Perl API version %s of %"SVf" does not match %s",
5475 api_p, SVfARG(PL_stack_base[ax + 0]),
5476 "v" PERL_API_VERSION_STRING);
5481 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5482 if((xsverlen = HS_GETXSVERLEN(key)))
5483 S_xs_version_bootcheck(aTHX_
5484 items, ax, va_arg(args, char*), xsverlen);
5492 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5496 const char *vn = NULL;
5497 SV *const module = PL_stack_base[ax];
5499 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5501 if (items >= 2) /* version supplied as bootstrap arg */
5502 sv = PL_stack_base[ax + 1];
5504 /* XXX GV_ADDWARN */
5506 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5507 if (!sv || !SvOK(sv)) {
5509 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5513 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5514 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5515 ? sv : sv_2mortal(new_version(sv));
5516 xssv = upg_version(xssv, 0);
5517 if ( vcmp(pmsv,xssv) ) {
5518 SV *string = vstringify(xssv);
5519 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5520 " does not match ", SVfARG(module), SVfARG(string));
5522 SvREFCNT_dec(string);
5523 string = vstringify(pmsv);
5526 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, SVfARG(module), vn,
5529 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, SVfARG(string));
5531 SvREFCNT_dec(string);
5533 Perl_sv_2mortal(aTHX_ xpt);
5534 Perl_croak_sv(aTHX_ xpt);
5540 =for apidoc my_strlcat
5542 The C library C<strlcat> if available, or a Perl implementation of it.
5543 This operates on C C<NUL>-terminated strings.
5545 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5546 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5547 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5548 practice this should not happen as it means that either C<size> is incorrect or
5549 that C<dst> is not a proper C<NUL>-terminated string).
5551 Note that C<size> is the full size of the destination buffer and
5552 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5553 room for the C<NUL> should be included in C<size>.
5557 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcat
5561 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5563 Size_t used, length, copy;
5566 length = strlen(src);
5567 if (size > 0 && used < size - 1) {
5568 copy = (length >= size - used) ? size - used - 1 : length;
5569 memcpy(dst + used, src, copy);
5570 dst[used + copy] = '\0';
5572 return used + length;
5578 =for apidoc my_strlcpy
5580 The C library C<strlcpy> if available, or a Perl implementation of it.
5581 This operates on C C<NUL>-terminated strings.
5583 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5584 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5588 Description stolen from http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy
5592 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5594 Size_t length, copy;
5596 length = strlen(src);
5598 copy = (length >= size) ? size - 1 : length;
5599 memcpy(dst, src, copy);
5606 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5607 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5608 long _ftol( double ); /* Defined by VC6 C libs. */
5609 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5612 PERL_STATIC_INLINE bool
5613 S_gv_has_usable_name(pTHX_ GV *gv)
5617 && HvENAME(GvSTASH(gv))
5618 && (gvp = (GV **)hv_fetchhek(
5619 GvSTASH(gv), GvNAME_HEK(gv), 0
5625 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5627 SV * const dbsv = GvSVn(PL_DBsub);
5628 const bool save_taint = TAINT_get;
5630 /* When we are called from pp_goto (svp is null),
5631 * we do not care about using dbsv to call CV;
5632 * it's for informational purposes only.
5635 PERL_ARGS_ASSERT_GET_DB_SUB;
5639 if (!PERLDB_SUB_NN) {
5642 if (!svp && !CvLEXICAL(cv)) {
5643 gv_efullname3(dbsv, gv, NULL);
5645 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5646 || strEQ(GvNAME(gv), "END")
5647 || ( /* Could be imported, and old sub redefined. */
5648 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5650 !( (SvTYPE(*svp) == SVt_PVGV)
5651 && (GvCV((const GV *)*svp) == cv)
5652 /* Use GV from the stack as a fallback. */
5653 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5657 /* GV is potentially non-unique, or contain different CV. */
5658 SV * const tmp = newRV(MUTABLE_SV(cv));
5659 sv_setsv(dbsv, tmp);
5663 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5664 sv_catpvs(dbsv, "::");
5665 sv_cathek(dbsv, GvNAME_HEK(gv));
5669 const int type = SvTYPE(dbsv);
5670 if (type < SVt_PVIV && type != SVt_IV)
5671 sv_upgrade(dbsv, SVt_PVIV);
5672 (void)SvIOK_on(dbsv);
5673 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5676 TAINT_IF(save_taint);
5677 #ifdef NO_TAINT_SUPPORT
5678 PERL_UNUSED_VAR(save_taint);
5683 Perl_my_dirfd(DIR * dir) {
5685 /* Most dirfd implementations have problems when passed NULL. */
5690 #elif defined(HAS_DIR_DD_FD)
5693 Perl_croak_nocontext(PL_no_func, "dirfd");
5694 NOT_REACHED; /* NOT REACHED */
5700 Perl_get_re_arg(pTHX_ SV *sv) {
5706 sv = MUTABLE_SV(SvRV(sv));
5707 if (SvTYPE(sv) == SVt_REGEXP)
5708 return (REGEXP*) sv;
5715 * This code is derived from drand48() implementation from FreeBSD,
5716 * found in lib/libc/gen/_rand48.c.
5718 * The U64 implementation is original, based on the POSIX
5719 * specification for drand48().
5723 * Copyright (c) 1993 Martin Birgmeier
5724 * All rights reserved.
5726 * You may redistribute unmodified or modified versions of this source
5727 * code provided that the above copyright notice and this and the
5728 * following conditions are retained.
5730 * This software is provided ``as is'', and comes with no warranties
5731 * of any kind. I shall in no event be liable for anything that happens
5732 * to anyone/anything when using this software.
5735 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5737 #ifdef PERL_DRAND48_QUAD
5739 #define DRAND48_MULT U64_CONST(0x5deece66d)
5740 #define DRAND48_ADD 0xb
5741 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5745 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5746 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5747 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5748 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5749 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5750 #define FREEBSD_DRAND48_ADD (0x000b)
5752 const unsigned short _rand48_mult[3] = {
5753 FREEBSD_DRAND48_MULT_0,
5754 FREEBSD_DRAND48_MULT_1,
5755 FREEBSD_DRAND48_MULT_2
5757 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5762 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5764 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5766 #ifdef PERL_DRAND48_QUAD
5767 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64TYPE)seed << 16);
5769 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5770 random_state->seed[1] = (U16) seed;
5771 random_state->seed[2] = (U16) (seed >> 16);
5776 Perl_drand48_r(perl_drand48_t *random_state)
5778 PERL_ARGS_ASSERT_DRAND48_R;
5780 #ifdef PERL_DRAND48_QUAD
5781 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5784 return ldexp((double)*random_state, -48);
5790 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5791 + (U32) _rand48_add;
5792 temp[0] = (U16) accu; /* lower 16 bits */
5793 accu >>= sizeof(U16) * 8;
5794 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5795 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5796 temp[1] = (U16) accu; /* middle 16 bits */
5797 accu >>= sizeof(U16) * 8;
5798 accu += _rand48_mult[0] * random_state->seed[2]
5799 + _rand48_mult[1] * random_state->seed[1]
5800 + _rand48_mult[2] * random_state->seed[0];
5801 random_state->seed[0] = temp[0];
5802 random_state->seed[1] = temp[1];
5803 random_state->seed[2] = (U16) accu;
5805 return ldexp((double) random_state->seed[0], -48) +
5806 ldexp((double) random_state->seed[1], -32) +
5807 ldexp((double) random_state->seed[2], -16);
5812 #ifdef USE_C_BACKTRACE
5814 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5819 /* abfd is the BFD handle. */
5821 /* bfd_syms is the BFD symbol table. */
5823 /* bfd_text is handle to the the ".text" section of the object file. */
5825 /* Since opening the executable and scanning its symbols is quite
5826 * heavy operation, we remember the filename we used the last time,
5827 * and do the opening and scanning only if the filename changes.
5828 * This removes most (but not all) open+scan cycles. */
5829 const char* fname_prev;
5832 /* Given a dl_info, update the BFD context if necessary. */
5833 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
5835 /* BFD open and scan only if the filename changed. */
5836 if (ctx->fname_prev == NULL ||
5837 strNE(dl_info->dli_fname, ctx->fname_prev)) {
5838 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
5840 if (bfd_check_format(ctx->abfd, bfd_object)) {
5841 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
5842 if (symbol_size > 0) {
5843 Safefree(ctx->bfd_syms);
5844 Newx(ctx->bfd_syms, symbol_size, asymbol*);
5846 bfd_get_section_by_name(ctx->abfd, ".text");
5854 ctx->fname_prev = dl_info->dli_fname;
5858 /* Given a raw frame, try to symbolize it and store
5859 * symbol information (source file, line number) away. */
5860 static void bfd_symbolize(bfd_context* ctx,
5863 STRLEN* symbol_name_size,
5865 STRLEN* source_name_size,
5866 STRLEN* source_line)
5868 *symbol_name = NULL;
5869 *symbol_name_size = 0;
5871 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
5873 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
5876 unsigned int line = 0;
5877 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
5878 ctx->bfd_syms, offset,
5879 &file, &func, &line) &&
5880 file && func && line > 0) {
5881 /* Size and copy the source file, use only
5882 * the basename of the source file.
5884 * NOTE: the basenames are fine for the
5885 * Perl source files, but may not always
5886 * be the best idea for XS files. */
5887 const char *p, *b = NULL;
5888 /* Look for the last slash. */
5889 for (p = file; *p; p++) {
5893 if (b == NULL || *b == 0) {
5896 *source_name_size = p - b + 1;
5897 Newx(*source_name, *source_name_size + 1, char);
5898 Copy(b, *source_name, *source_name_size + 1, char);
5900 *symbol_name_size = strlen(func);
5901 Newx(*symbol_name, *symbol_name_size + 1, char);
5902 Copy(func, *symbol_name, *symbol_name_size + 1, char);
5904 *source_line = line;
5910 #endif /* #ifdef USE_BFD */
5914 /* OS X has no public API for for 'symbolicating' (Apple official term)
5915 * stack addresses to {function_name, source_file, line_number}.
5916 * Good news: there is command line utility atos(1) which does that.
5917 * Bad news 1: it's a command line utility.
5918 * Bad news 2: one needs to have the Developer Tools installed.
5919 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
5921 * To recap: we need to open a pipe for reading for a utility which
5922 * might not exist, or exists in different locations, and then parse
5923 * the output. And since this is all for a low-level API, we cannot
5924 * use high-level stuff. Thanks, Apple. */
5927 /* tool is set to the absolute pathname of the tool to use:
5930 /* format is set to a printf format string used for building
5931 * the external command to run. */
5933 /* unavail is set if e.g. xcrun cannot be found, or something
5934 * else happens that makes getting the backtrace dubious. Note,
5935 * however, that the context isn't persistent, the next call to
5936 * get_c_backtrace() will start from scratch. */
5938 /* fname is the current object file name. */
5940 /* object_base_addr is the base address of the shared object. */
5941 void* object_base_addr;
5944 /* Given |dl_info|, updates the context. If the context has been
5945 * marked unavailable, return immediately. If not but the tool has
5946 * not been set, set it to either "xcrun atos" or "atos" (also set the
5947 * format to use for creating commands for piping), or if neither is
5948 * unavailable (one needs the Developer Tools installed), mark the context
5949 * an unavailable. Finally, update the filename (object name),
5950 * and its base address. */
5952 static void atos_update(atos_context* ctx,
5957 if (ctx->tool == NULL) {
5958 const char* tools[] = {
5962 const char* formats[] = {
5963 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
5964 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
5968 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
5969 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
5970 ctx->tool = tools[i];
5971 ctx->format = formats[i];
5975 if (ctx->tool == NULL) {
5976 ctx->unavail = TRUE;
5980 if (ctx->fname == NULL ||
5981 strNE(dl_info->dli_fname, ctx->fname)) {
5982 ctx->fname = dl_info->dli_fname;
5983 ctx->object_base_addr = dl_info->dli_fbase;
5987 /* Given an output buffer end |p| and its |start|, matches
5988 * for the atos output, extracting the source code location
5989 * and returning non-NULL if possible, returning NULL otherwise. */
5990 static const char* atos_parse(const char* p,
5992 STRLEN* source_name_size,
5993 STRLEN* source_line) {
5994 /* atos() output is something like:
5995 * perl_parse (in miniperl) (perl.c:2314)\n\n".
5996 * We cannot use Perl regular expressions, because we need to
5997 * stay low-level. Therefore here we have a rolled-out version
5998 * of a state machine which matches _backwards_from_the_end_ and
5999 * if there's a success, returns the starts of the filename,
6000 * also setting the filename size and the source line number.
6001 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6002 const char* source_number_start;
6003 const char* source_name_end;
6004 const char* source_line_end;
6005 const char* close_paren;
6006 /* Skip trailing whitespace. */
6007 while (p > start && isspace(*p)) p--;
6008 /* Now we should be at the close paren. */
6009 if (p == start || *p != ')')
6013 /* Now we should be in the line number. */
6014 if (p == start || !isdigit(*p))
6016 /* Skip over the digits. */
6017 while (p > start && isdigit(*p))
6019 /* Now we should be at the colon. */
6020 if (p == start || *p != ':')
6022 source_number_start = p + 1;
6023 source_name_end = p; /* Just beyond the end. */
6025 /* Look for the open paren. */
6026 while (p > start && *p != '(')
6031 *source_name_size = source_name_end - p;
6032 *source_line = grok_atou(source_number_start, &source_line_end);
6033 if (source_line_end != close_paren)
6038 /* Given a raw frame, read a pipe from the symbolicator (that's the
6039 * technical term) atos, reads the result, and parses the source code
6040 * location. We must stay low-level, so we use snprintf(), pipe(),
6041 * and fread(), and then also parse the output ourselves. */
6042 static void atos_symbolize(atos_context* ctx,
6045 STRLEN* source_name_size,
6046 STRLEN* source_line)
6054 /* Simple security measure: if there's any funny business with
6055 * the object name (used as "-o '%s'" ), leave since at least
6056 * partially the user controls it. */
6057 for (p = ctx->fname; *p; p++) {
6058 if (*p == '\'' || iscntrl(*p)) {
6059 ctx->unavail = TRUE;
6063 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6064 ctx->fname, ctx->object_base_addr, raw_frame);
6065 if (cnt < sizeof(cmd)) {
6066 /* Undo nostdio.h #defines that disable stdio.
6067 * This is somewhat naughty, but is used elsewhere
6068 * in the core, and affects only OS X. */
6073 FILE* fp = popen(cmd, "r");
6074 /* At the moment we open a new pipe for each stack frame.
6075 * This is naturally somewhat slow, but hopefully generating
6076 * stack traces is never going to in a performance critical path.
6078 * We could play tricks with atos by batching the stack
6079 * addresses to be resolved: atos can either take multiple
6080 * addresses from the command line, or read addresses from
6081 * a file (though the mess of creating temporary files would
6082 * probably negate much of any possible speedup).
6084 * Normally there are only two objects present in the backtrace:
6085 * perl itself, and the libdyld.dylib. (Note that the object
6086 * filenames contain the full pathname, so perl may not always
6087 * be in the same place.) Whenever the object in the
6088 * backtrace changes, the base address also changes.
6090 * The problem with batching the addresses, though, would be
6091 * matching the results with the addresses: the parsing of
6092 * the results is already painful enough with a single address. */
6095 UV cnt = fread(out, 1, sizeof(out), fp);
6096 if (cnt < sizeof(out)) {
6097 const char* p = atos_parse(out + cnt, out,
6102 *source_name_size + 1, char);
6103 Copy(p, *source_name,
6104 *source_name_size + 1, char);
6112 #endif /* #ifdef PERL_DARWIN */
6115 =for apidoc get_c_backtrace
6117 Collects the backtrace (aka "stacktrace") into a single linear
6118 malloced buffer, which the caller B<must> Perl_free_c_backtrace().
6120 Scans the frames back by depth + skip, then drops the skip innermost,
6121 returning at most depth frames.
6127 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6129 /* Note that here we must stay as low-level as possible: Newx(),
6130 * Copy(), Safefree(); since we may be called from anywhere,
6131 * so we should avoid higher level constructs like SVs or AVs.
6133 * Since we are using safesysmalloc() via Newx(), don't try
6134 * getting backtrace() there, unless you like deep recursion. */
6136 /* Currently only implemented with backtrace() and dladdr(),
6137 * for other platforms NULL is returned. */
6139 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6140 /* backtrace() is available via <execinfo.h> in glibc and in most
6141 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6143 /* We try fetching this many frames total, but then discard
6144 * the |skip| first ones. For the remaining ones we will try
6145 * retrieving more information with dladdr(). */
6146 int try_depth = skip + depth;
6148 /* The addresses (program counters) returned by backtrace(). */
6151 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6154 /* Sizes _including_ the terminating \0 of the object name
6155 * and symbol name strings. */
6156 STRLEN* object_name_sizes;
6157 STRLEN* symbol_name_sizes;
6160 /* The symbol names comes either from dli_sname,
6161 * or if using BFD, they can come from BFD. */
6162 char** symbol_names;
6165 /* The source code location information. Dug out with e.g. BFD. */
6166 char** source_names;
6167 STRLEN* source_name_sizes;
6168 STRLEN* source_lines;
6170 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6171 int got_depth; /* How many frames were returned from backtrace(). */
6172 UV frame_count = 0; /* How many frames we return. */
6173 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6176 bfd_context bfd_ctx;
6179 atos_context atos_ctx;
6182 /* Here are probably possibilities for optimizing. We could for
6183 * example have a struct that contains most of these and then
6184 * allocate |try_depth| of them, saving a bunch of malloc calls.
6185 * Note, however, that |frames| could not be part of that struct
6186 * because backtrace() will want an array of just them. Also be
6187 * careful about the name strings. */
6188 Newx(raw_frames, try_depth, void*);
6189 Newx(dl_infos, try_depth, Dl_info);
6190 Newx(object_name_sizes, try_depth, STRLEN);
6191 Newx(symbol_name_sizes, try_depth, STRLEN);
6192 Newx(source_names, try_depth, char*);
6193 Newx(source_name_sizes, try_depth, STRLEN);
6194 Newx(source_lines, try_depth, STRLEN);
6196 Newx(symbol_names, try_depth, char*);
6199 /* Get the raw frames. */
6200 got_depth = (int)backtrace(raw_frames, try_depth);
6202 /* We use dladdr() instead of backtrace_symbols() because we want
6203 * the full details instead of opaque strings. This is useful for
6204 * two reasons: () the details are needed for further symbolic
6205 * digging, for example in OS X (2) by having the details we fully
6206 * control the output, which in turn is useful when more platforms
6207 * are added: we can keep out output "portable". */
6209 /* We want a single linear allocation, which can then be freed
6210 * with a single swoop. We will do the usual trick of first
6211 * walking over the structure and seeing how much we need to
6212 * allocate, then allocating, and then walking over the structure
6213 * the second time and populating it. */
6215 /* First we must compute the total size of the buffer. */
6216 total_bytes = sizeof(Perl_c_backtrace_header);
6217 if (got_depth > skip) {
6220 bfd_init(); /* Is this safe to call multiple times? */
6221 Zero(&bfd_ctx, 1, bfd_context);
6224 Zero(&atos_ctx, 1, atos_context);
6226 for (i = skip; i < try_depth; i++) {
6227 Dl_info* dl_info = &dl_infos[i];
6229 total_bytes += sizeof(Perl_c_backtrace_frame);
6231 source_names[i] = NULL;
6232 source_name_sizes[i] = 0;
6233 source_lines[i] = 0;
6235 /* Yes, zero from dladdr() is failure. */
6236 if (dladdr(raw_frames[i], dl_info)) {
6237 object_name_sizes[i] =
6238 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6239 symbol_name_sizes[i] =
6240 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6242 bfd_update(&bfd_ctx, dl_info);
6243 bfd_symbolize(&bfd_ctx, raw_frames[i],
6245 &symbol_name_sizes[i],
6247 &source_name_sizes[i],
6251 atos_update(&atos_ctx, dl_info);
6252 atos_symbolize(&atos_ctx,
6255 &source_name_sizes[i],
6259 /* Plus ones for the terminating \0. */
6260 total_bytes += object_name_sizes[i] + 1;
6261 total_bytes += symbol_name_sizes[i] + 1;
6262 total_bytes += source_name_sizes[i] + 1;
6270 Safefree(bfd_ctx.bfd_syms);
6274 /* Now we can allocate and populate the result buffer. */
6275 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6276 Zero(bt, total_bytes, char);
6277 bt->header.frame_count = frame_count;
6278 bt->header.total_bytes = total_bytes;
6279 if (frame_count > 0) {
6280 Perl_c_backtrace_frame* frame = bt->frame_info;
6281 char* name_base = (char *)(frame + frame_count);
6282 char* name_curr = name_base; /* Outputting the name strings here. */
6284 for (i = skip; i < skip + frame_count; i++) {
6285 Dl_info* dl_info = &dl_infos[i];
6287 frame->addr = raw_frames[i];
6288 frame->object_base_addr = dl_info->dli_fbase;
6289 frame->symbol_addr = dl_info->dli_saddr;
6291 /* Copies a string, including the \0, and advances the name_curr.
6292 * Also copies the start and the size to the frame. */
6293 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6295 Copy(src, name_curr, size, char); \
6296 frame->doffset = name_curr - (char*)bt; \
6297 frame->dsize = size; \
6298 name_curr += size; \
6301 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6303 object_name_size, object_name_sizes[i]);
6306 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6308 symbol_name_size, symbol_name_sizes[i]);
6309 Safefree(symbol_names[i]);
6311 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6313 symbol_name_size, symbol_name_sizes[i]);
6316 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6318 source_name_size, source_name_sizes[i]);
6319 Safefree(source_names[i]);
6321 #undef PERL_C_BACKTRACE_STRCPY
6323 frame->source_line_number = source_lines[i];
6327 assert(total_bytes ==
6328 (UV)(sizeof(Perl_c_backtrace_header) +
6329 frame_count * sizeof(Perl_c_backtrace_frame) +
6330 name_curr - name_base));
6333 Safefree(symbol_names);
6335 Safefree(source_lines);
6336 Safefree(source_name_sizes);
6337 Safefree(source_names);
6338 Safefree(symbol_name_sizes);
6339 Safefree(object_name_sizes);
6340 /* Assuming the strings returned by dladdr() are pointers
6341 * to read-only static memory (the object file), so that
6342 * they do not need freeing (and cannot be). */
6344 Safefree(raw_frames);
6347 PERL_UNUSED_ARGV(depth);
6348 PERL_UNUSED_ARGV(skip);
6354 =for apidoc free_c_backtrace
6356 Deallocates a backtrace received from get_c_bracktrace.
6362 =for apidoc get_c_backtrace_dump
6364 Returns a SV a dump of |depth| frames of the call stack, skipping
6365 the |skip| innermost ones. depth of 20 is usually enough.
6367 The appended output looks like:
6370 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6371 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6374 The fields are tab-separated. The first column is the depth (zero
6375 being the innermost non-skipped frame). In the hex:offset, the hex is
6376 where the program counter was in S_parse_body, and the :offset (might
6377 be missing) tells how much inside the S_parse_body the program counter was.
6379 The util.c:1716 is the source code file and line number.
6381 The /usr/bin/perl is obvious (hopefully).
6383 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6384 if the platform doesn't support retrieving the information;
6385 if the binary is missing the debug information;
6386 if the optimizer has transformed the code by for example inlining.
6392 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6394 Perl_c_backtrace* bt;
6396 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6398 Perl_c_backtrace_frame* frame;
6399 SV* dsv = newSVpvs("");
6401 for (i = 0, frame = bt->frame_info;
6402 i < bt->header.frame_count; i++, frame++) {
6403 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6404 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6405 /* Symbol (function) names might disappear without debug info.
6407 * The source code location might disappear in case of the
6408 * optimizer inlining or otherwise rearranging the code. */
6409 if (frame->symbol_addr) {
6410 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6412 ((char*)frame->addr - (char*)frame->symbol_addr));
6414 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6415 frame->symbol_name_size &&
6416 frame->symbol_name_offset ?
6417 (char*)bt + frame->symbol_name_offset : "-");
6418 if (frame->source_name_size &&
6419 frame->source_name_offset &&
6420 frame->source_line_number) {
6421 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%"UVuf,
6422 (char*)bt + frame->source_name_offset,
6423 (UV)frame->source_line_number);
6425 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6427 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6428 frame->object_name_size &&
6429 frame->object_name_offset ?
6430 (char*)bt + frame->object_name_offset : "-");
6431 /* The frame->object_base_addr is not output,
6432 * but it is used for symbolizing/symbolicating. */
6433 sv_catpvs(dsv, "\n");
6436 Perl_free_c_backtrace(aTHX_ bt);
6445 =for apidoc dump_c_backtrace
6447 Dumps the C backtrace to the given fp.
6449 Returns true if a backtrace could be retrieved, false if not.
6455 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6459 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6461 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6464 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6470 #endif /* #ifdef USE_C_BACKTRACE */
6474 * c-indentation-style: bsd
6476 * indent-tabs-mode: nil
6479 * ex: set ts=8 sts=4 sw=4 et: