3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #if defined(USE_PERLIO)
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
44 /* Missing protos on LynxOS */
49 # include "amigaos4/amigaio.h"
54 # include <sys/select.h>
58 #ifdef USE_C_BACKTRACE
62 # undef USE_BFD /* BFD is useless in OS X. */
72 # include <execinfo.h>
76 #ifdef PERL_DEBUG_READONLY_COW
77 # include <sys/mman.h>
82 /* NOTE: Do not call the next three routines directly. Use the macros
83 * in handy.h, so that we can easily redefine everything to do tracking of
84 * allocated hunks back to the original New to track down any memory leaks.
85 * XXX This advice seems to be widely ignored :-( --AD August 1996.
88 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
89 # define ALWAYS_NEED_THX
92 #if defined(PERL_TRACK_MEMPOOL) && defined(PERL_DEBUG_READONLY_COW)
94 S_maybe_protect_rw(pTHX_ struct perl_memory_debug_header *header)
97 && mprotect(header, header->size, PROT_READ|PROT_WRITE))
98 Perl_warn(aTHX_ "mprotect for COW string %p %lu failed with %d",
99 header, header->size, errno);
103 S_maybe_protect_ro(pTHX_ struct perl_memory_debug_header *header)
106 && mprotect(header, header->size, PROT_READ))
107 Perl_warn(aTHX_ "mprotect RW for COW string %p %lu failed with %d",
108 header, header->size, errno);
110 # define maybe_protect_rw(foo) S_maybe_protect_rw(aTHX_ foo)
111 # define maybe_protect_ro(foo) S_maybe_protect_ro(aTHX_ foo)
113 # define maybe_protect_rw(foo) NOOP
114 # define maybe_protect_ro(foo) NOOP
117 #if defined(PERL_TRACK_MEMPOOL) || defined(PERL_DEBUG_READONLY_COW)
118 /* Use memory_debug_header */
120 # if (defined(PERL_POISON) && defined(PERL_TRACK_MEMPOOL)) \
121 || defined(PERL_DEBUG_READONLY_COW)
122 # define MDH_HAS_SIZE
126 /* paranoid version of system's malloc() */
129 Perl_safesysmalloc(MEM_SIZE size)
131 #ifdef ALWAYS_NEED_THX
137 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
139 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
142 if ((SSize_t)size < 0)
143 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
145 if (!size) size = 1; /* malloc(0) is NASTY on our system */
146 #ifdef PERL_DEBUG_READONLY_COW
147 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
148 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
149 perror("mmap failed");
153 ptr = (Malloc_t)PerlMem_malloc(size?size:1);
155 PERL_ALLOC_CHECK(ptr);
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)ptr;
163 PoisonNew(((char *)ptr), size, char);
166 #ifdef PERL_TRACK_MEMPOOL
167 header->interpreter = aTHX;
168 /* Link us into the list. */
169 header->prev = &PL_memory_debug_header;
170 header->next = PL_memory_debug_header.next;
171 PL_memory_debug_header.next = header;
172 maybe_protect_rw(header->next);
173 header->next->prev = header;
174 maybe_protect_ro(header->next);
175 # ifdef PERL_DEBUG_READONLY_COW
176 header->readonly = 0;
182 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
183 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
191 #ifndef ALWAYS_NEED_THX
203 /* paranoid version of system's realloc() */
206 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
208 #ifdef ALWAYS_NEED_THX
212 #ifdef PERL_DEBUG_READONLY_COW
213 const MEM_SIZE oldsize = where
214 ? ((struct perl_memory_debug_header *)((char *)where - PERL_MEMORY_DEBUG_HEADER_SIZE))->size
217 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
218 Malloc_t PerlMem_realloc();
219 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
226 ptr = safesysmalloc(size);
230 where = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
231 if (size + PERL_MEMORY_DEBUG_HEADER_SIZE < size)
233 size += PERL_MEMORY_DEBUG_HEADER_SIZE;
235 struct perl_memory_debug_header *const header
236 = (struct perl_memory_debug_header *)where;
238 # ifdef PERL_TRACK_MEMPOOL
239 if (header->interpreter != aTHX) {
240 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
241 header->interpreter, aTHX);
243 assert(header->next->prev == header);
244 assert(header->prev->next == header);
246 if (header->size > size) {
247 const MEM_SIZE freed_up = header->size - size;
248 char *start_of_freed = ((char *)where) + size;
249 PoisonFree(start_of_freed, freed_up, char);
259 if ((SSize_t)size < 0)
260 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
262 #ifdef PERL_DEBUG_READONLY_COW
263 if ((ptr = mmap(0, size, PROT_READ|PROT_WRITE,
264 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
265 perror("mmap failed");
268 Copy(where,ptr,oldsize < size ? oldsize : size,char);
269 if (munmap(where, oldsize)) {
270 perror("munmap failed");
274 ptr = (Malloc_t)PerlMem_realloc(where,size);
276 PERL_ALLOC_CHECK(ptr);
278 /* MUST do this fixup first, before doing ANYTHING else, as anything else
279 might allocate memory/free/move memory, and until we do the fixup, it
280 may well be chasing (and writing to) free memory. */
282 #ifdef PERL_TRACK_MEMPOOL
283 struct perl_memory_debug_header *const header
284 = (struct perl_memory_debug_header *)ptr;
287 if (header->size < size) {
288 const MEM_SIZE fresh = size - header->size;
289 char *start_of_fresh = ((char *)ptr) + size;
290 PoisonNew(start_of_fresh, fresh, char);
294 maybe_protect_rw(header->next);
295 header->next->prev = header;
296 maybe_protect_ro(header->next);
297 maybe_protect_rw(header->prev);
298 header->prev->next = header;
299 maybe_protect_ro(header->prev);
301 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
304 /* In particular, must do that fixup above before logging anything via
305 *printf(), as it can reallocate memory, which can cause SEGVs. */
307 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
308 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
315 #ifndef ALWAYS_NEED_THX
328 /* safe version of system's free() */
331 Perl_safesysfree(Malloc_t where)
333 #ifdef ALWAYS_NEED_THX
336 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
339 Malloc_t where_intrn = (Malloc_t)((char*)where-PERL_MEMORY_DEBUG_HEADER_SIZE);
341 struct perl_memory_debug_header *const header
342 = (struct perl_memory_debug_header *)where_intrn;
345 const MEM_SIZE size = header->size;
347 # ifdef PERL_TRACK_MEMPOOL
348 if (header->interpreter != aTHX) {
349 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
350 header->interpreter, aTHX);
353 Perl_croak_nocontext("panic: duplicate free");
356 Perl_croak_nocontext("panic: bad free, header->next==NULL");
357 if (header->next->prev != header || header->prev->next != header) {
358 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
359 "header=%p, ->prev->next=%p",
360 header->next->prev, header,
363 /* Unlink us from the chain. */
364 maybe_protect_rw(header->next);
365 header->next->prev = header->prev;
366 maybe_protect_ro(header->next);
367 maybe_protect_rw(header->prev);
368 header->prev->next = header->next;
369 maybe_protect_ro(header->prev);
370 maybe_protect_rw(header);
372 PoisonNew(where_intrn, size, char);
374 /* Trigger the duplicate free warning. */
377 # ifdef PERL_DEBUG_READONLY_COW
378 if (munmap(where_intrn, size)) {
379 perror("munmap failed");
385 Malloc_t where_intrn = where;
387 #ifndef PERL_DEBUG_READONLY_COW
388 PerlMem_free(where_intrn);
393 /* safe version of system's calloc() */
396 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
398 #ifdef ALWAYS_NEED_THX
402 #if defined(USE_MDH) || defined(DEBUGGING)
403 MEM_SIZE total_size = 0;
406 /* Even though calloc() for zero bytes is strange, be robust. */
407 if (size && (count <= MEM_SIZE_MAX / size)) {
408 #if defined(USE_MDH) || defined(DEBUGGING)
409 total_size = size * count;
415 if (PERL_MEMORY_DEBUG_HEADER_SIZE <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
416 total_size += PERL_MEMORY_DEBUG_HEADER_SIZE;
421 if ((SSize_t)size < 0 || (SSize_t)count < 0)
422 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
423 (UV)size, (UV)count);
425 #ifdef PERL_DEBUG_READONLY_COW
426 if ((ptr = mmap(0, total_size ? total_size : 1, PROT_READ|PROT_WRITE,
427 MAP_ANON|MAP_PRIVATE, -1, 0)) == MAP_FAILED) {
428 perror("mmap failed");
431 #elif defined(PERL_TRACK_MEMPOOL)
432 /* Have to use malloc() because we've added some space for our tracking
434 /* malloc(0) is non-portable. */
435 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
437 /* Use calloc() because it might save a memset() if the memory is fresh
438 and clean from the OS. */
440 ptr = (Malloc_t)PerlMem_calloc(count, size);
441 else /* calloc(0) is non-portable. */
442 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
444 PERL_ALLOC_CHECK(ptr);
445 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
449 struct perl_memory_debug_header *const header
450 = (struct perl_memory_debug_header *)ptr;
452 # ifndef PERL_DEBUG_READONLY_COW
453 memset((void*)ptr, 0, total_size);
455 # ifdef PERL_TRACK_MEMPOOL
456 header->interpreter = aTHX;
457 /* Link us into the list. */
458 header->prev = &PL_memory_debug_header;
459 header->next = PL_memory_debug_header.next;
460 PL_memory_debug_header.next = header;
461 maybe_protect_rw(header->next);
462 header->next->prev = header;
463 maybe_protect_ro(header->next);
464 # ifdef PERL_DEBUG_READONLY_COW
465 header->readonly = 0;
469 header->size = total_size;
471 ptr = (Malloc_t)((char*)ptr+PERL_MEMORY_DEBUG_HEADER_SIZE);
477 #ifndef ALWAYS_NEED_THX
486 /* These must be defined when not using Perl's malloc for binary
491 Malloc_t Perl_malloc (MEM_SIZE nbytes)
493 #ifdef PERL_IMPLICIT_SYS
496 return (Malloc_t)PerlMem_malloc(nbytes);
499 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
501 #ifdef PERL_IMPLICIT_SYS
504 return (Malloc_t)PerlMem_calloc(elements, size);
507 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
509 #ifdef PERL_IMPLICIT_SYS
512 return (Malloc_t)PerlMem_realloc(where, nbytes);
515 Free_t Perl_mfree (Malloc_t where)
517 #ifdef PERL_IMPLICIT_SYS
525 /* copy a string up to some (non-backslashed) delimiter, if any */
528 S_delimcpy(char *to, const char *toend, const char *from,
529 const char *fromend, int delim, I32 *retlen,
530 const bool allow_escape)
534 PERL_ARGS_ASSERT_DELIMCPY;
536 for (tolen = 0; from < fromend; from++, tolen++) {
537 if (allow_escape && *from == '\\') {
538 if (from[1] != delim) {
545 else if (*from == delim)
557 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
559 PERL_ARGS_ASSERT_DELIMCPY;
561 return S_delimcpy(to, toend, from, fromend, delim, retlen, 1);
565 Perl_delimcpy_no_escape(char *to, const char *toend, const char *from,
566 const char *fromend, int delim, I32 *retlen)
568 PERL_ARGS_ASSERT_DELIMCPY_NO_ESCAPE;
570 return S_delimcpy(to, toend, from, fromend, delim, retlen, 0);
574 =head1 Miscellaneous Functions
576 =for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end
578 Find the first (leftmost) occurrence of a sequence of bytes within another
579 sequence. This is the Perl version of C<strstr()>, extended to handle
580 arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
581 is what the initial C<n> in the function name stands for; some systems have an
582 equivalent, C<memmem()>, but with a somewhat different API).
584 Another way of thinking about this function is finding a needle in a haystack.
585 C<big> points to the first byte in the haystack. C<big_end> points to one byte
586 beyond the final byte in the haystack. C<little> points to the first byte in
587 the needle. C<little_end> points to one byte beyond the final byte in the
588 needle. All the parameters must be non-C<NULL>.
590 The function returns C<NULL> if there is no occurrence of C<little> within
591 C<big>. If C<little> is the empty string, C<big> is returned.
593 Because this function operates at the byte level, and because of the inherent
594 characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
595 needle and the haystack are strings with the same UTF-8ness, but not if the
603 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
605 PERL_ARGS_ASSERT_NINSTR;
608 return ninstr(big, bigend, little, lend);
614 const char first = *little;
616 bigend -= lend - little++;
618 while (big <= bigend) {
619 if (*big++ == first) {
620 for (x=big,s=little; s < lend; x++,s++) {
624 return (char*)(big-1);
635 =head1 Miscellaneous Functions
637 =for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end
639 Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
640 sequence of bytes within another sequence, returning C<NULL> if there is no
648 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
651 const I32 first = *little;
652 const char * const littleend = lend;
654 PERL_ARGS_ASSERT_RNINSTR;
656 if (little >= littleend)
657 return (char*)bigend;
659 big = bigend - (littleend - little++);
660 while (big >= bigbeg) {
664 for (x=big+2,s=little; s < littleend; /**/ ) {
673 return (char*)(big+1);
678 /* As a space optimization, we do not compile tables for strings of length
679 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
680 special-cased in fbm_instr().
682 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
685 =head1 Miscellaneous Functions
687 =for apidoc fbm_compile
689 Analyses the string in order to make fast searches on it using C<fbm_instr()>
690 -- the Boyer-Moore algorithm.
696 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
703 PERL_DEB( STRLEN rarest = 0 );
705 PERL_ARGS_ASSERT_FBM_COMPILE;
707 if (isGV_with_GP(sv) || SvROK(sv))
713 if (flags & FBMcf_TAIL) {
714 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
715 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
716 if (mg && mg->mg_len >= 0)
719 if (!SvPOK(sv) || SvNIOKp(sv))
720 s = (U8*)SvPV_force_mutable(sv, len);
721 else s = (U8 *)SvPV_mutable(sv, len);
722 if (len == 0) /* TAIL might be on a zero-length string. */
724 SvUPGRADE(sv, SVt_PVMG);
729 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
730 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
731 to call SvVALID_off() if the scalar was assigned to.
733 The comment itself (and "deeper magic" below) date back to
734 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
736 where the magic (presumably) was that the scalar had a BM table hidden
739 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
740 the table instead of the previous (somewhat hacky) approach of co-opting
741 the string buffer and storing it after the string. */
743 assert(!mg_find(sv, PERL_MAGIC_bm));
744 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
748 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
750 const U8 mlen = (len>255) ? 255 : (U8)len;
751 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
754 Newx(table, 256, U8);
755 memset((void*)table, mlen, 256);
756 mg->mg_ptr = (char *)table;
759 s += len - 1; /* last char */
762 if (table[*s] == mlen)
768 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
769 for (i = 0; i < len; i++) {
770 if (PL_freq[s[i]] < frequency) {
771 PERL_DEB( rarest = i );
772 frequency = PL_freq[s[i]];
775 BmUSEFUL(sv) = 100; /* Initial value */
776 if (flags & FBMcf_TAIL)
778 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
779 s[rarest], (UV)rarest));
784 =for apidoc fbm_instr
786 Returns the location of the SV in the string delimited by C<big> and
787 C<bigend> (C<bigend>) is the char following the last char).
788 It returns C<NULL> if the string can't be found. The C<sv>
789 does not have to be C<fbm_compiled>, but the search will not be as fast
794 If SvTAIL(littlestr) is true, a fake "\n" was appended to to the string
795 during FBM compilation due to FBMcf_TAIL in flags. It indicates that
796 the littlestr must be anchored to the end of bigstr (or to any \n if
799 E.g. The regex compiler would compile /abc/ to a littlestr of "abc",
800 while /abc$/ compiles to "abc\n" with SvTAIL() true.
802 A littlestr of "abc", !SvTAIL matches as /abc/;
803 a littlestr of "ab\n", SvTAIL matches as:
804 without FBMrf_MULTILINE: /ab\n?\z/
805 with FBMrf_MULTILINE: /ab\n/ || /ab\z/;
807 (According to Ilya from 1999; I don't know if this is still true, DAPM 2015):
808 "If SvTAIL is actually due to \Z or \z, this gives false positives
814 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
818 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
819 STRLEN littlelen = l;
820 const I32 multiline = flags & FBMrf_MULTILINE;
822 PERL_ARGS_ASSERT_FBM_INSTR;
824 if ((STRLEN)(bigend - big) < littlelen) {
825 if ( SvTAIL(littlestr)
826 && ((STRLEN)(bigend - big) == littlelen - 1)
828 || (*big == *little &&
829 memEQ((char *)big, (char *)little, littlelen - 1))))
834 switch (littlelen) { /* Special cases for 0, 1 and 2 */
836 return (char*)big; /* Cannot be SvTAIL! */
839 if (SvTAIL(littlestr) && !multiline) /* Anchor only! */
840 /* [-1] is safe because we know that bigend != big. */
841 return (char *) (bigend - (bigend[-1] == '\n'));
843 s = (unsigned char *)memchr((void*)big, *little, bigend-big);
846 if (SvTAIL(littlestr))
847 return (char *) bigend;
851 if (SvTAIL(littlestr) && !multiline) {
852 /* a littlestr with SvTAIL must be of the form "X\n" (where X
853 * is a single char). It is anchored, and can only match
854 * "....X\n" or "....X" */
855 if (bigend[-2] == *little && bigend[-1] == '\n')
856 return (char*)bigend - 2;
857 if (bigend[-1] == *little)
858 return (char*)bigend - 1;
863 /* memchr() is likely to be very fast, possibly using whatever
864 * hardware support is available, such as checking a whole
865 * cache line in one instruction.
866 * So for a 2 char pattern, calling memchr() is likely to be
867 * faster than running FBM, or rolling our own. The previous
868 * version of this code was roll-your-own which typically
869 * only needed to read every 2nd char, which was good back in
870 * the day, but no longer.
872 unsigned char c1 = little[0];
873 unsigned char c2 = little[1];
875 /* *** for all this case, bigend points to the last char,
876 * not the trailing \0: this makes the conditions slightly
882 /* do a quick test for c1 before calling memchr();
883 * this avoids the expensive fn call overhead when
884 * there are lots of c1's */
885 if (LIKELY(*s != c1)) {
887 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
894 /* failed; try searching for c2 this time; that way
895 * we don't go pathologically slow when the string
896 * consists mostly of c1's or vice versa.
901 s = (unsigned char *)memchr((void*)s, c2, bigend - s + 1);
909 /* c1, c2 the same */
919 s = (unsigned char *)memchr((void*)s, c1, bigend - s);
920 if (!s || s >= bigend)
927 /* failed to find 2 chars; try anchored match at end without
929 if (SvTAIL(littlestr) && bigend[0] == little[0])
930 return (char *)bigend;
935 break; /* Only lengths 0 1 and 2 have special-case code. */
938 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
939 s = bigend - littlelen;
940 if (s >= big && bigend[-1] == '\n' && *s == *little
941 /* Automatically of length > 2 */
942 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
944 return (char*)s; /* how sweet it is */
947 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
949 return (char*)s + 1; /* how sweet it is */
954 if (!SvVALID(littlestr)) {
955 /* not compiled; use Perl_ninstr() instead */
956 char * const b = ninstr((char*)big,(char*)bigend,
957 (char*)little, (char*)little + littlelen);
959 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
960 /* Chop \n from littlestr: */
961 s = bigend - littlelen + 1;
963 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
973 if (littlelen > (STRLEN)(bigend - big))
977 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
978 const unsigned char *oldlittle;
982 --littlelen; /* Last char found by table lookup */
985 little += littlelen; /* last char */
988 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
989 const unsigned char lastc = *little;
993 if ((tmp = table[*s])) {
994 /* *s != lastc; earliest position it could match now is
995 * tmp slots further on */
996 if ((s += tmp) >= bigend)
998 if (LIKELY(*s != lastc)) {
1000 s = (unsigned char *)memchr((void*)s, lastc, bigend - s);
1010 /* hand-rolled strncmp(): less expensive than calling the
1011 * real function (maybe???) */
1013 unsigned char * const olds = s;
1018 if (*--s == *--little)
1020 s = olds + 1; /* here we pay the price for failure */
1022 if (s < bigend) /* fake up continue to outer loop */
1031 && SvTAIL(littlestr)
1032 && memEQ((char *)(bigend - littlelen),
1033 (char *)(oldlittle - littlelen), littlelen) )
1034 return (char*)bigend - littlelen;
1043 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1045 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
1046 match themselves and their opposite case counterparts. Non-cased and non-ASCII
1047 range bytes match only themselves.
1054 Perl_foldEQ(const char *s1, const char *s2, I32 len)
1056 const U8 *a = (const U8 *)s1;
1057 const U8 *b = (const U8 *)s2;
1059 PERL_ARGS_ASSERT_FOLDEQ;
1064 if (*a != *b && *a != PL_fold[*b])
1071 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
1073 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
1074 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
1075 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
1076 * does it check that the strings each have at least 'len' characters */
1078 const U8 *a = (const U8 *)s1;
1079 const U8 *b = (const U8 *)s2;
1081 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
1086 if (*a != *b && *a != PL_fold_latin1[*b]) {
1095 =for apidoc foldEQ_locale
1097 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
1098 same case-insensitively in the current locale; false otherwise.
1104 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
1107 const U8 *a = (const U8 *)s1;
1108 const U8 *b = (const U8 *)s2;
1110 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
1115 if (*a != *b && *a != PL_fold_locale[*b])
1122 /* copy a string to a safe spot */
1125 =head1 Memory Management
1129 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1130 string which is a duplicate of C<pv>. The size of the string is
1131 determined by C<strlen()>, which means it may not contain embedded C<NUL>
1132 characters and must have a trailing C<NUL>. The memory allocated for the new
1133 string can be freed with the C<Safefree()> function.
1135 On some platforms, Windows for example, all allocated memory owned by a thread
1136 is deallocated when that thread ends. So if you need that not to happen, you
1137 need to use the shared memory functions, such as C<L</savesharedpv>>.
1143 Perl_savepv(pTHX_ const char *pv)
1145 PERL_UNUSED_CONTEXT;
1150 const STRLEN pvlen = strlen(pv)+1;
1151 Newx(newaddr, pvlen, char);
1152 return (char*)memcpy(newaddr, pv, pvlen);
1156 /* same thing but with a known length */
1161 Perl's version of what C<strndup()> would be if it existed. Returns a
1162 pointer to a newly allocated string which is a duplicate of the first
1163 C<len> bytes from C<pv>, plus a trailing
1164 C<NUL> byte. The memory allocated for
1165 the new string can be freed with the C<Safefree()> function.
1167 On some platforms, Windows for example, all allocated memory owned by a thread
1168 is deallocated when that thread ends. So if you need that not to happen, you
1169 need to use the shared memory functions, such as C<L</savesharedpvn>>.
1175 Perl_savepvn(pTHX_ const char *pv, I32 len)
1178 PERL_UNUSED_CONTEXT;
1182 Newx(newaddr,len+1,char);
1183 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1185 /* might not be null terminated */
1186 newaddr[len] = '\0';
1187 return (char *) CopyD(pv,newaddr,len,char);
1190 return (char *) ZeroD(newaddr,len+1,char);
1195 =for apidoc savesharedpv
1197 A version of C<savepv()> which allocates the duplicate string in memory
1198 which is shared between threads.
1203 Perl_savesharedpv(pTHX_ const char *pv)
1208 PERL_UNUSED_CONTEXT;
1213 pvlen = strlen(pv)+1;
1214 newaddr = (char*)PerlMemShared_malloc(pvlen);
1218 return (char*)memcpy(newaddr, pv, pvlen);
1222 =for apidoc savesharedpvn
1224 A version of C<savepvn()> which allocates the duplicate string in memory
1225 which is shared between threads. (With the specific difference that a C<NULL>
1226 pointer is not acceptable)
1231 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1233 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1235 PERL_UNUSED_CONTEXT;
1236 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1241 newaddr[len] = '\0';
1242 return (char*)memcpy(newaddr, pv, len);
1246 =for apidoc savesvpv
1248 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1249 the passed in SV using C<SvPV()>
1251 On some platforms, Windows for example, all allocated memory owned by a thread
1252 is deallocated when that thread ends. So if you need that not to happen, you
1253 need to use the shared memory functions, such as C<L</savesharedsvpv>>.
1259 Perl_savesvpv(pTHX_ SV *sv)
1262 const char * const pv = SvPV_const(sv, len);
1265 PERL_ARGS_ASSERT_SAVESVPV;
1268 Newx(newaddr,len,char);
1269 return (char *) CopyD(pv,newaddr,len,char);
1273 =for apidoc savesharedsvpv
1275 A version of C<savesharedpv()> which allocates the duplicate string in
1276 memory which is shared between threads.
1282 Perl_savesharedsvpv(pTHX_ SV *sv)
1285 const char * const pv = SvPV_const(sv, len);
1287 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1289 return savesharedpvn(pv, len);
1292 /* the SV for Perl_form() and mess() is not kept in an arena */
1300 if (PL_phase != PERL_PHASE_DESTRUCT)
1301 return newSVpvs_flags("", SVs_TEMP);
1306 /* Create as PVMG now, to avoid any upgrading later */
1308 Newxz(any, 1, XPVMG);
1309 SvFLAGS(sv) = SVt_PVMG;
1310 SvANY(sv) = (void*)any;
1312 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1317 #if defined(PERL_IMPLICIT_CONTEXT)
1319 Perl_form_nocontext(const char* pat, ...)
1324 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1325 va_start(args, pat);
1326 retval = vform(pat, &args);
1330 #endif /* PERL_IMPLICIT_CONTEXT */
1333 =head1 Miscellaneous Functions
1336 Takes a sprintf-style format pattern and conventional
1337 (non-SV) arguments and returns the formatted string.
1339 (char *) Perl_form(pTHX_ const char* pat, ...)
1341 can be used any place a string (char *) is required:
1343 char * s = Perl_form("%d.%d",major,minor);
1345 Uses a single private buffer so if you want to format several strings you
1346 must explicitly copy the earlier strings away (and free the copies when you
1353 Perl_form(pTHX_ const char* pat, ...)
1357 PERL_ARGS_ASSERT_FORM;
1358 va_start(args, pat);
1359 retval = vform(pat, &args);
1365 Perl_vform(pTHX_ const char *pat, va_list *args)
1367 SV * const sv = mess_alloc();
1368 PERL_ARGS_ASSERT_VFORM;
1369 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1374 =for apidoc Am|SV *|mess|const char *pat|...
1376 Take a sprintf-style format pattern and argument list. These are used to
1377 generate a string message. If the message does not end with a newline,
1378 then it will be extended with some indication of the current location
1379 in the code, as described for L</mess_sv>.
1381 Normally, the resulting message is returned in a new mortal SV.
1382 During global destruction a single SV may be shared between uses of
1388 #if defined(PERL_IMPLICIT_CONTEXT)
1390 Perl_mess_nocontext(const char *pat, ...)
1395 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1396 va_start(args, pat);
1397 retval = vmess(pat, &args);
1401 #endif /* PERL_IMPLICIT_CONTEXT */
1404 Perl_mess(pTHX_ const char *pat, ...)
1408 PERL_ARGS_ASSERT_MESS;
1409 va_start(args, pat);
1410 retval = vmess(pat, &args);
1416 Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop,
1419 /* Look for curop starting from o. cop is the last COP we've seen. */
1420 /* opnext means that curop is actually the ->op_next of the op we are
1423 PERL_ARGS_ASSERT_CLOSEST_COP;
1425 if (!o || !curop || (
1426 opnext ? o->op_next == curop && o->op_type != OP_SCOPE : o == curop
1430 if (o->op_flags & OPf_KIDS) {
1432 for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
1435 /* If the OP_NEXTSTATE has been optimised away we can still use it
1436 * the get the file and line number. */
1438 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1439 cop = (const COP *)kid;
1441 /* Keep searching, and return when we've found something. */
1443 new_cop = closest_cop(cop, kid, curop, opnext);
1449 /* Nothing found. */
1455 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1457 Expands a message, intended for the user, to include an indication of
1458 the current location in the code, if the message does not already appear
1461 C<basemsg> is the initial message or object. If it is a reference, it
1462 will be used as-is and will be the result of this function. Otherwise it
1463 is used as a string, and if it already ends with a newline, it is taken
1464 to be complete, and the result of this function will be the same string.
1465 If the message does not end with a newline, then a segment such as C<at
1466 foo.pl line 37> will be appended, and possibly other clauses indicating
1467 the current state of execution. The resulting message will end with a
1470 Normally, the resulting message is returned in a new mortal SV.
1471 During global destruction a single SV may be shared between uses of this
1472 function. If C<consume> is true, then the function is permitted (but not
1473 required) to modify and return C<basemsg> instead of allocating a new SV.
1479 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1483 #if defined(USE_C_BACKTRACE) && defined(USE_C_BACKTRACE_ON_ERROR)
1487 /* The PERL_C_BACKTRACE_ON_WARN must be an integer of one or more. */
1488 if ((ws = PerlEnv_getenv("PERL_C_BACKTRACE_ON_ERROR"))
1489 && grok_atoUV(ws, &wi, NULL)
1490 && wi <= PERL_INT_MAX
1492 Perl_dump_c_backtrace(aTHX_ Perl_debug_log, (int)wi, 1);
1497 PERL_ARGS_ASSERT_MESS_SV;
1499 if (SvROK(basemsg)) {
1505 sv_setsv(sv, basemsg);
1510 if (SvPOK(basemsg) && consume) {
1515 sv_copypv(sv, basemsg);
1518 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1520 * Try and find the file and line for PL_op. This will usually be
1521 * PL_curcop, but it might be a cop that has been optimised away. We
1522 * can try to find such a cop by searching through the optree starting
1523 * from the sibling of PL_curcop.
1527 closest_cop(PL_curcop, OpSIBLING(PL_curcop), PL_op, FALSE);
1532 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1533 OutCopFILE(cop), (IV)CopLINE(cop));
1534 /* Seems that GvIO() can be untrustworthy during global destruction. */
1535 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1536 && IoLINES(GvIOp(PL_last_in_gv)))
1539 const bool line_mode = (RsSIMPLE(PL_rs) &&
1540 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1541 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1542 SVfARG(PL_last_in_gv == PL_argvgv
1544 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1545 line_mode ? "line" : "chunk",
1546 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1548 if (PL_phase == PERL_PHASE_DESTRUCT)
1549 sv_catpvs(sv, " during global destruction");
1550 sv_catpvs(sv, ".\n");
1556 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1558 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1559 argument list, respectively. These are used to generate a string message. If
1561 message does not end with a newline, then it will be extended with
1562 some indication of the current location in the code, as described for
1565 Normally, the resulting message is returned in a new mortal SV.
1566 During global destruction a single SV may be shared between uses of
1573 Perl_vmess(pTHX_ const char *pat, va_list *args)
1575 SV * const sv = mess_alloc();
1577 PERL_ARGS_ASSERT_VMESS;
1579 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1580 return mess_sv(sv, 1);
1584 Perl_write_to_stderr(pTHX_ SV* msv)
1589 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1591 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1592 && (io = GvIO(PL_stderrgv))
1593 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1594 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, SV_CONST(PRINT),
1595 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1597 PerlIO * const serr = Perl_error_log;
1599 do_print(msv, serr);
1600 (void)PerlIO_flush(serr);
1605 =head1 Warning and Dieing
1608 /* Common code used in dieing and warning */
1611 S_with_queued_errors(pTHX_ SV *ex)
1613 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1614 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1615 sv_catsv(PL_errors, ex);
1616 ex = sv_mortalcopy(PL_errors);
1617 SvCUR_set(PL_errors, 0);
1623 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1628 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1629 /* sv_2cv might call Perl_croak() or Perl_warner() */
1630 SV * const oldhook = *hook;
1638 cv = sv_2cv(oldhook, &stash, &gv, 0);
1640 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1650 exarg = newSVsv(ex);
1651 SvREADONLY_on(exarg);
1654 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1658 call_sv(MUTABLE_SV(cv), G_DISCARD);
1667 =for apidoc Am|OP *|die_sv|SV *baseex
1669 Behaves the same as L</croak_sv>, except for the return type.
1670 It should be used only where the C<OP *> return type is required.
1671 The function never actually returns.
1677 # pragma warning( push )
1678 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1679 __declspec(noreturn) has non-void return type */
1680 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1681 __declspec(noreturn) has a return statement */
1684 Perl_die_sv(pTHX_ SV *baseex)
1686 PERL_ARGS_ASSERT_DIE_SV;
1689 NORETURN_FUNCTION_END;
1692 # pragma warning( pop )
1696 =for apidoc Am|OP *|die|const char *pat|...
1698 Behaves the same as L</croak>, except for the return type.
1699 It should be used only where the C<OP *> return type is required.
1700 The function never actually returns.
1705 #if defined(PERL_IMPLICIT_CONTEXT)
1707 # pragma warning( push )
1708 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1709 __declspec(noreturn) has non-void return type */
1710 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1711 __declspec(noreturn) has a return statement */
1714 Perl_die_nocontext(const char* pat, ...)
1718 va_start(args, pat);
1720 NOT_REACHED; /* NOTREACHED */
1722 NORETURN_FUNCTION_END;
1725 # pragma warning( pop )
1727 #endif /* PERL_IMPLICIT_CONTEXT */
1730 # pragma warning( push )
1731 # pragma warning( disable : 4646 ) /* warning C4646: function declared with
1732 __declspec(noreturn) has non-void return type */
1733 # pragma warning( disable : 4645 ) /* warning C4645: function declared with
1734 __declspec(noreturn) has a return statement */
1737 Perl_die(pTHX_ const char* pat, ...)
1740 va_start(args, pat);
1742 NOT_REACHED; /* NOTREACHED */
1744 NORETURN_FUNCTION_END;
1747 # pragma warning( pop )
1751 =for apidoc Am|void|croak_sv|SV *baseex
1753 This is an XS interface to Perl's C<die> function.
1755 C<baseex> is the error message or object. If it is a reference, it
1756 will be used as-is. Otherwise it is used as a string, and if it does
1757 not end with a newline then it will be extended with some indication of
1758 the current location in the code, as described for L</mess_sv>.
1760 The error message or object will be used as an exception, by default
1761 returning control to the nearest enclosing C<eval>, but subject to
1762 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1763 function never returns normally.
1765 To die with a simple string message, the L</croak> function may be
1772 Perl_croak_sv(pTHX_ SV *baseex)
1774 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1775 PERL_ARGS_ASSERT_CROAK_SV;
1776 invoke_exception_hook(ex, FALSE);
1781 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1783 This is an XS interface to Perl's C<die> function.
1785 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1786 argument list. These are used to generate a string message. If the
1787 message does not end with a newline, then it will be extended with
1788 some indication of the current location in the code, as described for
1791 The error message will be used as an exception, by default
1792 returning control to the nearest enclosing C<eval>, but subject to
1793 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1794 function never returns normally.
1796 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1797 (C<$@>) will be used as an error message or object instead of building an
1798 error message from arguments. If you want to throw a non-string object,
1799 or build an error message in an SV yourself, it is preferable to use
1800 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1806 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1808 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1809 invoke_exception_hook(ex, FALSE);
1814 =for apidoc Am|void|croak|const char *pat|...
1816 This is an XS interface to Perl's C<die> function.
1818 Take a sprintf-style format pattern and argument list. These are used to
1819 generate a string message. If the message does not end with a newline,
1820 then it will be extended with some indication of the current location
1821 in the code, as described for L</mess_sv>.
1823 The error message will be used as an exception, by default
1824 returning control to the nearest enclosing C<eval>, but subject to
1825 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1826 function never returns normally.
1828 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1829 (C<$@>) will be used as an error message or object instead of building an
1830 error message from arguments. If you want to throw a non-string object,
1831 or build an error message in an SV yourself, it is preferable to use
1832 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1837 #if defined(PERL_IMPLICIT_CONTEXT)
1839 Perl_croak_nocontext(const char *pat, ...)
1843 va_start(args, pat);
1845 NOT_REACHED; /* NOTREACHED */
1848 #endif /* PERL_IMPLICIT_CONTEXT */
1851 Perl_croak(pTHX_ const char *pat, ...)
1854 va_start(args, pat);
1856 NOT_REACHED; /* NOTREACHED */
1861 =for apidoc Am|void|croak_no_modify
1863 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1864 terser object code than using C<Perl_croak>. Less code used on exception code
1865 paths reduces CPU cache pressure.
1871 Perl_croak_no_modify(void)
1873 Perl_croak_nocontext( "%s", PL_no_modify);
1876 /* does not return, used in util.c perlio.c and win32.c
1877 This is typically called when malloc returns NULL.
1880 Perl_croak_no_mem(void)
1884 int fd = PerlIO_fileno(Perl_error_log);
1886 SETERRNO(EBADF,RMS_IFI);
1888 /* Can't use PerlIO to write as it allocates memory */
1889 PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, sizeof(PL_no_mem)-1));
1894 /* does not return, used only in POPSTACK */
1896 Perl_croak_popstack(void)
1899 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1904 =for apidoc Am|void|warn_sv|SV *baseex
1906 This is an XS interface to Perl's C<warn> function.
1908 C<baseex> is the error message or object. If it is a reference, it
1909 will be used as-is. Otherwise it is used as a string, and if it does
1910 not end with a newline then it will be extended with some indication of
1911 the current location in the code, as described for L</mess_sv>.
1913 The error message or object will by default be written to standard error,
1914 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1916 To warn with a simple string message, the L</warn> function may be
1923 Perl_warn_sv(pTHX_ SV *baseex)
1925 SV *ex = mess_sv(baseex, 0);
1926 PERL_ARGS_ASSERT_WARN_SV;
1927 if (!invoke_exception_hook(ex, TRUE))
1928 write_to_stderr(ex);
1932 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1934 This is an XS interface to Perl's C<warn> function.
1936 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1937 argument list. These are used to generate a string message. If the
1938 message does not end with a newline, then it will be extended with
1939 some indication of the current location in the code, as described for
1942 The error message or object will by default be written to standard error,
1943 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1945 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1951 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1953 SV *ex = vmess(pat, args);
1954 PERL_ARGS_ASSERT_VWARN;
1955 if (!invoke_exception_hook(ex, TRUE))
1956 write_to_stderr(ex);
1960 =for apidoc Am|void|warn|const char *pat|...
1962 This is an XS interface to Perl's C<warn> function.
1964 Take a sprintf-style format pattern and argument list. These are used to
1965 generate a string message. If the message does not end with a newline,
1966 then it will be extended with some indication of the current location
1967 in the code, as described for L</mess_sv>.
1969 The error message or object will by default be written to standard error,
1970 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1972 Unlike with L</croak>, C<pat> is not permitted to be null.
1977 #if defined(PERL_IMPLICIT_CONTEXT)
1979 Perl_warn_nocontext(const char *pat, ...)
1983 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1984 va_start(args, pat);
1988 #endif /* PERL_IMPLICIT_CONTEXT */
1991 Perl_warn(pTHX_ const char *pat, ...)
1994 PERL_ARGS_ASSERT_WARN;
1995 va_start(args, pat);
2000 #if defined(PERL_IMPLICIT_CONTEXT)
2002 Perl_warner_nocontext(U32 err, const char *pat, ...)
2006 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
2007 va_start(args, pat);
2008 vwarner(err, pat, &args);
2011 #endif /* PERL_IMPLICIT_CONTEXT */
2014 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
2016 PERL_ARGS_ASSERT_CK_WARNER_D;
2018 if (Perl_ckwarn_d(aTHX_ err)) {
2020 va_start(args, pat);
2021 vwarner(err, pat, &args);
2027 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
2029 PERL_ARGS_ASSERT_CK_WARNER;
2031 if (Perl_ckwarn(aTHX_ err)) {
2033 va_start(args, pat);
2034 vwarner(err, pat, &args);
2040 Perl_warner(pTHX_ U32 err, const char* pat,...)
2043 PERL_ARGS_ASSERT_WARNER;
2044 va_start(args, pat);
2045 vwarner(err, pat, &args);
2050 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
2053 PERL_ARGS_ASSERT_VWARNER;
2055 (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) &&
2056 !(PL_in_eval & EVAL_KEEPERR)
2058 SV * const msv = vmess(pat, args);
2060 if (PL_parser && PL_parser->error_count) {
2064 invoke_exception_hook(msv, FALSE);
2069 Perl_vwarn(aTHX_ pat, args);
2073 /* implements the ckWARN? macros */
2076 Perl_ckwarn(pTHX_ U32 w)
2078 /* If lexical warnings have not been set, use $^W. */
2080 return PL_dowarn & G_WARN_ON;
2082 return ckwarn_common(w);
2085 /* implements the ckWARN?_d macro */
2088 Perl_ckwarn_d(pTHX_ U32 w)
2090 /* If lexical warnings have not been set then default classes warn. */
2094 return ckwarn_common(w);
2098 S_ckwarn_common(pTHX_ U32 w)
2100 if (PL_curcop->cop_warnings == pWARN_ALL)
2103 if (PL_curcop->cop_warnings == pWARN_NONE)
2106 /* Check the assumption that at least the first slot is non-zero. */
2107 assert(unpackWARN1(w));
2109 /* Check the assumption that it is valid to stop as soon as a zero slot is
2111 if (!unpackWARN2(w)) {
2112 assert(!unpackWARN3(w));
2113 assert(!unpackWARN4(w));
2114 } else if (!unpackWARN3(w)) {
2115 assert(!unpackWARN4(w));
2118 /* Right, dealt with all the special cases, which are implemented as non-
2119 pointers, so there is a pointer to a real warnings mask. */
2121 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
2123 } while (w >>= WARNshift);
2128 /* Set buffer=NULL to get a new one. */
2130 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
2132 const MEM_SIZE len_wanted =
2133 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
2134 PERL_UNUSED_CONTEXT;
2135 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
2138 (specialWARN(buffer) ?
2139 PerlMemShared_malloc(len_wanted) :
2140 PerlMemShared_realloc(buffer, len_wanted));
2142 Copy(bits, (buffer + 1), size, char);
2143 if (size < WARNsize)
2144 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
2148 /* since we've already done strlen() for both nam and val
2149 * we can use that info to make things faster than
2150 * sprintf(s, "%s=%s", nam, val)
2152 #define my_setenv_format(s, nam, nlen, val, vlen) \
2153 Copy(nam, s, nlen, char); \
2155 Copy(val, s+(nlen+1), vlen, char); \
2156 *(s+(nlen+1+vlen)) = '\0'
2158 #ifdef USE_ENVIRON_ARRAY
2159 /* VMS' my_setenv() is in vms.c */
2160 #if !defined(WIN32) && !defined(NETWARE)
2162 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2166 amigaos4_obtain_environ(__FUNCTION__);
2169 /* only parent thread can modify process environment */
2170 if (PL_curinterp == aTHX)
2173 #ifndef PERL_USE_SAFE_PUTENV
2174 if (!PL_use_safe_putenv) {
2175 /* most putenv()s leak, so we manipulate environ directly */
2177 const I32 len = strlen(nam);
2180 /* where does it go? */
2181 for (i = 0; environ[i]; i++) {
2182 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
2186 if (environ == PL_origenviron) { /* need we copy environment? */
2192 while (environ[max])
2194 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
2195 for (j=0; j<max; j++) { /* copy environment */
2196 const int len = strlen(environ[j]);
2197 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
2198 Copy(environ[j], tmpenv[j], len+1, char);
2201 environ = tmpenv; /* tell exec where it is now */
2204 safesysfree(environ[i]);
2205 while (environ[i]) {
2206 environ[i] = environ[i+1];
2215 if (!environ[i]) { /* does not exist yet */
2216 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
2217 environ[i+1] = NULL; /* make sure it's null terminated */
2220 safesysfree(environ[i]);
2224 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
2225 /* all that work just for this */
2226 my_setenv_format(environ[i], nam, nlen, val, vlen);
2229 /* This next branch should only be called #if defined(HAS_SETENV), but
2230 Configure doesn't test for that yet. For Solaris, setenv() and unsetenv()
2231 were introduced in Solaris 9, so testing for HAS UNSETENV is sufficient.
2233 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__) || (defined(__sun) && defined(HAS_UNSETENV)) || defined(PERL_DARWIN)
2234 # if defined(HAS_UNSETENV)
2236 (void)unsetenv(nam);
2238 (void)setenv(nam, val, 1);
2240 # else /* ! HAS_UNSETENV */
2241 (void)setenv(nam, val, 1);
2242 # endif /* HAS_UNSETENV */
2244 # if defined(HAS_UNSETENV)
2246 if (environ) /* old glibc can crash with null environ */
2247 (void)unsetenv(nam);
2249 const int nlen = strlen(nam);
2250 const int vlen = strlen(val);
2251 char * const new_env =
2252 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2253 my_setenv_format(new_env, nam, nlen, val, vlen);
2254 (void)putenv(new_env);
2256 # else /* ! HAS_UNSETENV */
2258 const int nlen = strlen(nam);
2264 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2265 /* all that work just for this */
2266 my_setenv_format(new_env, nam, nlen, val, vlen);
2267 (void)putenv(new_env);
2268 # endif /* HAS_UNSETENV */
2269 # endif /* __CYGWIN__ */
2270 #ifndef PERL_USE_SAFE_PUTENV
2276 amigaos4_release_environ(__FUNCTION__);
2280 #else /* WIN32 || NETWARE */
2283 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2287 const int nlen = strlen(nam);
2294 Newx(envstr, nlen+vlen+2, char);
2295 my_setenv_format(envstr, nam, nlen, val, vlen);
2296 (void)PerlEnv_putenv(envstr);
2300 #endif /* WIN32 || NETWARE */
2304 #ifdef UNLINK_ALL_VERSIONS
2306 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2310 PERL_ARGS_ASSERT_UNLNK;
2312 while (PerlLIO_unlink(f) >= 0)
2314 return retries ? 0 : -1;
2318 /* this is a drop-in replacement for bcopy(), except for the return
2319 * value, which we need to be able to emulate memcpy() */
2320 #if !defined(HAS_MEMCPY) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY))
2322 Perl_my_bcopy(const void *vfrom, void *vto, size_t len)
2324 #if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
2325 bcopy(vfrom, vto, len);
2327 const unsigned char *from = (const unsigned char *)vfrom;
2328 unsigned char *to = (unsigned char *)vto;
2330 PERL_ARGS_ASSERT_MY_BCOPY;
2332 if (from - to >= 0) {
2340 *(--to) = *(--from);
2348 /* this is a drop-in replacement for memset() */
2351 Perl_my_memset(void *vloc, int ch, size_t len)
2353 unsigned char *loc = (unsigned char *)vloc;
2355 PERL_ARGS_ASSERT_MY_MEMSET;
2363 /* this is a drop-in replacement for bzero() */
2364 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2366 Perl_my_bzero(void *vloc, size_t len)
2368 unsigned char *loc = (unsigned char *)vloc;
2370 PERL_ARGS_ASSERT_MY_BZERO;
2378 /* this is a drop-in replacement for memcmp() */
2379 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2381 Perl_my_memcmp(const void *vs1, const void *vs2, size_t len)
2383 const U8 *a = (const U8 *)vs1;
2384 const U8 *b = (const U8 *)vs2;
2387 PERL_ARGS_ASSERT_MY_MEMCMP;
2390 if ((tmp = *a++ - *b++))
2395 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2398 /* This vsprintf replacement should generally never get used, since
2399 vsprintf was available in both System V and BSD 2.11. (There may
2400 be some cross-compilation or embedded set-ups where it is needed,
2403 If you encounter a problem in this function, it's probably a symptom
2404 that Configure failed to detect your system's vprintf() function.
2405 See the section on "item vsprintf" in the INSTALL file.
2407 This version may compile on systems with BSD-ish <stdio.h>,
2408 but probably won't on others.
2411 #ifdef USE_CHAR_VSPRINTF
2416 vsprintf(char *dest, const char *pat, void *args)
2420 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2421 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2422 FILE_cnt(&fakebuf) = 32767;
2424 /* These probably won't compile -- If you really need
2425 this, you'll have to figure out some other method. */
2426 fakebuf._ptr = dest;
2427 fakebuf._cnt = 32767;
2432 fakebuf._flag = _IOWRT|_IOSTRG;
2433 _doprnt(pat, args, &fakebuf); /* what a kludge */
2434 #if defined(STDIO_PTR_LVALUE)
2435 *(FILE_ptr(&fakebuf)++) = '\0';
2437 /* PerlIO has probably #defined away fputc, but we want it here. */
2439 # undef fputc /* XXX Should really restore it later */
2441 (void)fputc('\0', &fakebuf);
2443 #ifdef USE_CHAR_VSPRINTF
2446 return 0; /* perl doesn't use return value */
2450 #endif /* HAS_VPRINTF */
2453 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2455 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2463 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2465 PERL_FLUSHALL_FOR_CHILD;
2466 This = (*mode == 'w');
2470 taint_proper("Insecure %s%s", "EXEC");
2472 if (PerlProc_pipe(p) < 0)
2474 /* Try for another pipe pair for error return */
2475 if (PerlProc_pipe(pp) >= 0)
2477 while ((pid = PerlProc_fork()) < 0) {
2478 if (errno != EAGAIN) {
2479 PerlLIO_close(p[This]);
2480 PerlLIO_close(p[that]);
2482 PerlLIO_close(pp[0]);
2483 PerlLIO_close(pp[1]);
2487 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2496 /* Close parent's end of error status pipe (if any) */
2498 PerlLIO_close(pp[0]);
2499 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
2500 /* Close error pipe automatically if exec works */
2501 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2505 /* Now dup our end of _the_ pipe to right position */
2506 if (p[THIS] != (*mode == 'r')) {
2507 PerlLIO_dup2(p[THIS], *mode == 'r');
2508 PerlLIO_close(p[THIS]);
2509 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2510 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2513 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2514 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2515 /* No automatic close - do it by hand */
2522 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2528 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2534 do_execfree(); /* free any memory malloced by child on fork */
2536 PerlLIO_close(pp[1]);
2537 /* Keep the lower of the two fd numbers */
2538 if (p[that] < p[This]) {
2539 PerlLIO_dup2(p[This], p[that]);
2540 PerlLIO_close(p[This]);
2544 PerlLIO_close(p[that]); /* close child's end of pipe */
2546 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2547 SvUPGRADE(sv,SVt_IV);
2549 PL_forkprocess = pid;
2550 /* If we managed to get status pipe check for exec fail */
2551 if (did_pipes && pid > 0) {
2556 while (n < sizeof(int)) {
2557 n1 = PerlLIO_read(pp[0],
2558 (void*)(((char*)&errkid)+n),
2564 PerlLIO_close(pp[0]);
2566 if (n) { /* Error */
2568 PerlLIO_close(p[This]);
2569 if (n != sizeof(int))
2570 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2572 pid2 = wait4pid(pid, &status, 0);
2573 } while (pid2 == -1 && errno == EINTR);
2574 errno = errkid; /* Propagate errno from kid */
2579 PerlLIO_close(pp[0]);
2580 return PerlIO_fdopen(p[This], mode);
2582 # if defined(OS2) /* Same, without fork()ing and all extra overhead... */
2583 return my_syspopen4(aTHX_ NULL, mode, n, args);
2584 # elif defined(WIN32)
2585 return win32_popenlist(mode, n, args);
2587 Perl_croak(aTHX_ "List form of piped open not implemented");
2588 return (PerlIO *) NULL;
2593 /* VMS' my_popen() is in VMS.c, same with OS/2 and AmigaOS 4. */
2594 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
2596 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2602 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2606 PERL_ARGS_ASSERT_MY_POPEN;
2608 PERL_FLUSHALL_FOR_CHILD;
2611 return my_syspopen(aTHX_ cmd,mode);
2614 This = (*mode == 'w');
2616 if (doexec && TAINTING_get) {
2618 taint_proper("Insecure %s%s", "EXEC");
2620 if (PerlProc_pipe(p) < 0)
2622 if (doexec && PerlProc_pipe(pp) >= 0)
2624 while ((pid = PerlProc_fork()) < 0) {
2625 if (errno != EAGAIN) {
2626 PerlLIO_close(p[This]);
2627 PerlLIO_close(p[that]);
2629 PerlLIO_close(pp[0]);
2630 PerlLIO_close(pp[1]);
2633 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2636 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2646 PerlLIO_close(pp[0]);
2647 #if defined(HAS_FCNTL) && defined(F_SETFD)
2648 if (fcntl(pp[1], F_SETFD, FD_CLOEXEC) < 0)
2652 if (p[THIS] != (*mode == 'r')) {
2653 PerlLIO_dup2(p[THIS], *mode == 'r');
2654 PerlLIO_close(p[THIS]);
2655 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2656 PerlLIO_close(p[THAT]);
2659 PerlLIO_close(p[THAT]);
2662 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2669 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2674 /* may or may not use the shell */
2675 do_exec3(cmd, pp[1], did_pipes);
2678 #endif /* defined OS2 */
2680 #ifdef PERLIO_USING_CRLF
2681 /* Since we circumvent IO layers when we manipulate low-level
2682 filedescriptors directly, need to manually switch to the
2683 default, binary, low-level mode; see PerlIOBuf_open(). */
2684 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2687 #ifdef PERL_USES_PL_PIDSTATUS
2688 hv_clear(PL_pidstatus); /* we have no children */
2694 do_execfree(); /* free any memory malloced by child on vfork */
2696 PerlLIO_close(pp[1]);
2697 if (p[that] < p[This]) {
2698 PerlLIO_dup2(p[This], p[that]);
2699 PerlLIO_close(p[This]);
2703 PerlLIO_close(p[that]);
2705 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2706 SvUPGRADE(sv,SVt_IV);
2708 PL_forkprocess = pid;
2709 if (did_pipes && pid > 0) {
2714 while (n < sizeof(int)) {
2715 n1 = PerlLIO_read(pp[0],
2716 (void*)(((char*)&errkid)+n),
2722 PerlLIO_close(pp[0]);
2724 if (n) { /* Error */
2726 PerlLIO_close(p[This]);
2727 if (n != sizeof(int))
2728 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2730 pid2 = wait4pid(pid, &status, 0);
2731 } while (pid2 == -1 && errno == EINTR);
2732 errno = errkid; /* Propagate errno from kid */
2737 PerlLIO_close(pp[0]);
2738 return PerlIO_fdopen(p[This], mode);
2742 FILE *djgpp_popen();
2744 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2746 PERL_FLUSHALL_FOR_CHILD;
2747 /* Call system's popen() to get a FILE *, then import it.
2748 used 0 for 2nd parameter to PerlIO_importFILE;
2751 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2754 #if defined(__LIBCATAMOUNT__)
2756 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2763 #endif /* !DOSISH */
2765 /* this is called in parent before the fork() */
2767 Perl_atfork_lock(void)
2768 #if defined(USE_ITHREADS)
2770 PERL_TSA_ACQUIRE(PL_perlio_mutex)
2773 PERL_TSA_ACQUIRE(PL_malloc_mutex)
2775 PERL_TSA_ACQUIRE(PL_op_mutex)
2778 #if defined(USE_ITHREADS)
2780 /* locks must be held in locking order (if any) */
2782 MUTEX_LOCK(&PL_perlio_mutex);
2785 MUTEX_LOCK(&PL_malloc_mutex);
2791 /* this is called in both parent and child after the fork() */
2793 Perl_atfork_unlock(void)
2794 #if defined(USE_ITHREADS)
2796 PERL_TSA_RELEASE(PL_perlio_mutex)
2799 PERL_TSA_RELEASE(PL_malloc_mutex)
2801 PERL_TSA_RELEASE(PL_op_mutex)
2804 #if defined(USE_ITHREADS)
2806 /* locks must be released in same order as in atfork_lock() */
2808 MUTEX_UNLOCK(&PL_perlio_mutex);
2811 MUTEX_UNLOCK(&PL_malloc_mutex);
2820 #if defined(HAS_FORK)
2822 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2827 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2828 * handlers elsewhere in the code */
2832 #elif defined(__amigaos4__)
2833 return amigaos_fork();
2835 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2836 Perl_croak_nocontext("fork() not available");
2838 #endif /* HAS_FORK */
2843 dup2(int oldfd, int newfd)
2845 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2848 PerlLIO_close(newfd);
2849 return fcntl(oldfd, F_DUPFD, newfd);
2851 #define DUP2_MAX_FDS 256
2852 int fdtmp[DUP2_MAX_FDS];
2858 PerlLIO_close(newfd);
2859 /* good enough for low fd's... */
2860 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2861 if (fdx >= DUP2_MAX_FDS) {
2869 PerlLIO_close(fdtmp[--fdx]);
2876 #ifdef HAS_SIGACTION
2879 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2881 struct sigaction act, oact;
2885 /* only "parent" interpreter can diddle signals */
2886 if (PL_curinterp != aTHX)
2887 return (Sighandler_t) SIG_ERR;
2890 act.sa_handler = (void(*)(int))handler;
2891 sigemptyset(&act.sa_mask);
2894 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2895 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2897 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2898 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2899 act.sa_flags |= SA_NOCLDWAIT;
2901 if (sigaction(signo, &act, &oact) == -1)
2902 return (Sighandler_t) SIG_ERR;
2904 return (Sighandler_t) oact.sa_handler;
2908 Perl_rsignal_state(pTHX_ int signo)
2910 struct sigaction oact;
2911 PERL_UNUSED_CONTEXT;
2913 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2914 return (Sighandler_t) SIG_ERR;
2916 return (Sighandler_t) oact.sa_handler;
2920 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2925 struct sigaction act;
2927 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2930 /* only "parent" interpreter can diddle signals */
2931 if (PL_curinterp != aTHX)
2935 act.sa_handler = (void(*)(int))handler;
2936 sigemptyset(&act.sa_mask);
2939 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2940 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2942 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2943 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2944 act.sa_flags |= SA_NOCLDWAIT;
2946 return sigaction(signo, &act, save);
2950 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2955 PERL_UNUSED_CONTEXT;
2957 /* only "parent" interpreter can diddle signals */
2958 if (PL_curinterp != aTHX)
2962 return sigaction(signo, save, (struct sigaction *)NULL);
2965 #else /* !HAS_SIGACTION */
2968 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2970 #if defined(USE_ITHREADS) && !defined(WIN32)
2971 /* only "parent" interpreter can diddle signals */
2972 if (PL_curinterp != aTHX)
2973 return (Sighandler_t) SIG_ERR;
2976 return PerlProc_signal(signo, handler);
2987 Perl_rsignal_state(pTHX_ int signo)
2990 Sighandler_t oldsig;
2992 #if defined(USE_ITHREADS) && !defined(WIN32)
2993 /* only "parent" interpreter can diddle signals */
2994 if (PL_curinterp != aTHX)
2995 return (Sighandler_t) SIG_ERR;
2999 oldsig = PerlProc_signal(signo, sig_trap);
3000 PerlProc_signal(signo, oldsig);
3002 PerlProc_kill(PerlProc_getpid(), signo);
3007 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3009 #if defined(USE_ITHREADS) && !defined(WIN32)
3010 /* only "parent" interpreter can diddle signals */
3011 if (PL_curinterp != aTHX)
3014 *save = PerlProc_signal(signo, handler);
3015 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3019 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3021 #if defined(USE_ITHREADS) && !defined(WIN32)
3022 /* only "parent" interpreter can diddle signals */
3023 if (PL_curinterp != aTHX)
3026 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3029 #endif /* !HAS_SIGACTION */
3030 #endif /* !PERL_MICRO */
3032 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3033 #if (!defined(DOSISH) || defined(HAS_FORK)) && !defined(VMS) && !defined(__LIBCATAMOUNT__) && !defined(__amigaos4__)
3035 Perl_my_pclose(pTHX_ PerlIO *ptr)
3043 const int fd = PerlIO_fileno(ptr);
3046 svp = av_fetch(PL_fdpid,fd,TRUE);
3047 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3051 #if defined(USE_PERLIO)
3052 /* Find out whether the refcount is low enough for us to wait for the
3053 child proc without blocking. */
3054 should_wait = PerlIOUnix_refcnt(fd) == 1 && pid > 0;
3056 should_wait = pid > 0;
3060 if (pid == -1) { /* Opened by popen. */
3061 return my_syspclose(ptr);
3064 close_failed = (PerlIO_close(ptr) == EOF);
3066 if (should_wait) do {
3067 pid2 = wait4pid(pid, &status, 0);
3068 } while (pid2 == -1 && errno == EINTR);
3075 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3080 #if defined(__LIBCATAMOUNT__)
3082 Perl_my_pclose(pTHX_ PerlIO *ptr)
3087 #endif /* !DOSISH */
3089 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3091 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3094 PERL_ARGS_ASSERT_WAIT4PID;
3095 #ifdef PERL_USES_PL_PIDSTATUS
3097 /* PERL_USES_PL_PIDSTATUS is only defined when neither
3098 waitpid() nor wait4() is available, or on OS/2, which
3099 doesn't appear to support waiting for a progress group
3100 member, so we can only treat a 0 pid as an unknown child.
3107 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3108 pid, rather than a string form. */
3109 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3110 if (svp && *svp != &PL_sv_undef) {
3111 *statusp = SvIVX(*svp);
3112 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3120 hv_iterinit(PL_pidstatus);
3121 if ((entry = hv_iternext(PL_pidstatus))) {
3122 SV * const sv = hv_iterval(PL_pidstatus,entry);
3124 const char * const spid = hv_iterkey(entry,&len);
3126 assert (len == sizeof(Pid_t));
3127 memcpy((char *)&pid, spid, len);
3128 *statusp = SvIVX(sv);
3129 /* The hash iterator is currently on this entry, so simply
3130 calling hv_delete would trigger the lazy delete, which on
3131 aggregate does more work, because next call to hv_iterinit()
3132 would spot the flag, and have to call the delete routine,
3133 while in the meantime any new entries can't re-use that
3135 hv_iterinit(PL_pidstatus);
3136 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3143 # ifdef HAS_WAITPID_RUNTIME
3144 if (!HAS_WAITPID_RUNTIME)
3147 result = PerlProc_waitpid(pid,statusp,flags);
3150 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3151 result = wait4(pid,statusp,flags,NULL);
3154 #ifdef PERL_USES_PL_PIDSTATUS
3155 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3160 Perl_croak(aTHX_ "Can't do waitpid with flags");
3162 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3163 pidgone(result,*statusp);
3169 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3172 if (result < 0 && errno == EINTR) {
3174 errno = EINTR; /* reset in case a signal handler changed $! */
3178 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3180 #ifdef PERL_USES_PL_PIDSTATUS
3182 S_pidgone(pTHX_ Pid_t pid, int status)
3186 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3187 SvUPGRADE(sv,SVt_IV);
3188 SvIV_set(sv, status);
3196 int /* Cannot prototype with I32
3198 my_syspclose(PerlIO *ptr)
3201 Perl_my_pclose(pTHX_ PerlIO *ptr)
3204 /* Needs work for PerlIO ! */
3205 FILE * const f = PerlIO_findFILE(ptr);
3206 const I32 result = pclose(f);
3207 PerlIO_releaseFILE(ptr,f);
3215 Perl_my_pclose(pTHX_ PerlIO *ptr)
3217 /* Needs work for PerlIO ! */
3218 FILE * const f = PerlIO_findFILE(ptr);
3219 I32 result = djgpp_pclose(f);
3220 result = (result << 8) & 0xff00;
3221 PerlIO_releaseFILE(ptr,f);
3226 #define PERL_REPEATCPY_LINEAR 4
3228 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3230 PERL_ARGS_ASSERT_REPEATCPY;
3235 croak_memory_wrap();
3238 memset(to, *from, count);
3241 IV items, linear, half;
3243 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3244 for (items = 0; items < linear; ++items) {
3245 const char *q = from;
3247 for (todo = len; todo > 0; todo--)
3252 while (items <= half) {
3253 IV size = items * len;
3254 memcpy(p, to, size);
3260 memcpy(p, to, (count - items) * len);
3266 Perl_same_dirent(pTHX_ const char *a, const char *b)
3268 char *fa = strrchr(a,'/');
3269 char *fb = strrchr(b,'/');
3272 SV * const tmpsv = sv_newmortal();
3274 PERL_ARGS_ASSERT_SAME_DIRENT;
3287 sv_setpvs(tmpsv, ".");
3289 sv_setpvn(tmpsv, a, fa - a);
3290 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3293 sv_setpvs(tmpsv, ".");
3295 sv_setpvn(tmpsv, b, fb - b);
3296 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3298 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3299 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3301 #endif /* !HAS_RENAME */
3304 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3305 const char *const *const search_ext, I32 flags)
3307 const char *xfound = NULL;
3308 char *xfailed = NULL;
3309 char tmpbuf[MAXPATHLEN];
3314 #if defined(DOSISH) && !defined(OS2)
3315 # define SEARCH_EXTS ".bat", ".cmd", NULL
3316 # define MAX_EXT_LEN 4
3319 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3320 # define MAX_EXT_LEN 4
3323 # define SEARCH_EXTS ".pl", ".com", NULL
3324 # define MAX_EXT_LEN 4
3326 /* additional extensions to try in each dir if scriptname not found */
3328 static const char *const exts[] = { SEARCH_EXTS };
3329 const char *const *const ext = search_ext ? search_ext : exts;
3330 int extidx = 0, i = 0;
3331 const char *curext = NULL;
3333 PERL_UNUSED_ARG(search_ext);
3334 # define MAX_EXT_LEN 0
3337 PERL_ARGS_ASSERT_FIND_SCRIPT;
3340 * If dosearch is true and if scriptname does not contain path
3341 * delimiters, search the PATH for scriptname.
3343 * If SEARCH_EXTS is also defined, will look for each
3344 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3345 * while searching the PATH.
3347 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3348 * proceeds as follows:
3349 * If DOSISH or VMSISH:
3350 * + look for ./scriptname{,.foo,.bar}
3351 * + search the PATH for scriptname{,.foo,.bar}
3354 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3355 * this will not look in '.' if it's not in the PATH)
3360 # ifdef ALWAYS_DEFTYPES
3361 len = strlen(scriptname);
3362 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3363 int idx = 0, deftypes = 1;
3366 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3369 int idx = 0, deftypes = 1;
3372 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3374 /* The first time through, just add SEARCH_EXTS to whatever we
3375 * already have, so we can check for default file types. */
3377 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3384 if ((strlen(tmpbuf) + strlen(scriptname)
3385 + MAX_EXT_LEN) >= sizeof tmpbuf)
3386 continue; /* don't search dir with too-long name */
3387 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3391 if (strEQ(scriptname, "-"))
3393 if (dosearch) { /* Look in '.' first. */
3394 const char *cur = scriptname;
3396 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3398 if (strEQ(ext[i++],curext)) {
3399 extidx = -1; /* already has an ext */
3404 DEBUG_p(PerlIO_printf(Perl_debug_log,
3405 "Looking for %s\n",cur));
3408 if (PerlLIO_stat(cur,&statbuf) >= 0
3409 && !S_ISDIR(statbuf.st_mode)) {
3418 if (cur == scriptname) {
3419 len = strlen(scriptname);
3420 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3422 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3425 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3426 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3431 if (dosearch && !strchr(scriptname, '/')
3433 && !strchr(scriptname, '\\')
3435 && (s = PerlEnv_getenv("PATH")))
3439 bufend = s + strlen(s);
3440 while (s < bufend) {
3444 && *s != ';'; len++, s++) {
3445 if (len < sizeof tmpbuf)
3448 if (len < sizeof tmpbuf)
3451 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3457 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3458 continue; /* don't search dir with too-long name */
3461 && tmpbuf[len - 1] != '/'
3462 && tmpbuf[len - 1] != '\\'
3465 tmpbuf[len++] = '/';
3466 if (len == 2 && tmpbuf[0] == '.')
3468 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3472 len = strlen(tmpbuf);
3473 if (extidx > 0) /* reset after previous loop */
3477 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3478 retval = PerlLIO_stat(tmpbuf,&statbuf);
3479 if (S_ISDIR(statbuf.st_mode)) {
3483 } while ( retval < 0 /* not there */
3484 && extidx>=0 && ext[extidx] /* try an extension? */
3485 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3490 if (S_ISREG(statbuf.st_mode)
3491 && cando(S_IRUSR,TRUE,&statbuf)
3492 #if !defined(DOSISH)
3493 && cando(S_IXUSR,TRUE,&statbuf)
3497 xfound = tmpbuf; /* bingo! */
3501 xfailed = savepv(tmpbuf);
3506 if (!xfound && !seen_dot && !xfailed &&
3507 (PerlLIO_stat(scriptname,&statbuf) < 0
3508 || S_ISDIR(statbuf.st_mode)))
3510 seen_dot = 1; /* Disable message. */
3515 if (flags & 1) { /* do or die? */
3516 /* diag_listed_as: Can't execute %s */
3517 Perl_croak(aTHX_ "Can't %s %s%s%s",
3518 (xfailed ? "execute" : "find"),
3519 (xfailed ? xfailed : scriptname),
3520 (xfailed ? "" : " on PATH"),
3521 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3526 scriptname = xfound;
3528 return (scriptname ? savepv(scriptname) : NULL);
3531 #ifndef PERL_GET_CONTEXT_DEFINED
3534 Perl_get_context(void)
3536 #if defined(USE_ITHREADS)
3538 # ifdef OLD_PTHREADS_API
3540 int error = pthread_getspecific(PL_thr_key, &t)
3542 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3545 # ifdef I_MACH_CTHREADS
3546 return (void*)cthread_data(cthread_self());
3548 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3557 Perl_set_context(void *t)
3559 #if defined(USE_ITHREADS)
3562 PERL_ARGS_ASSERT_SET_CONTEXT;
3563 #if defined(USE_ITHREADS)
3564 # ifdef I_MACH_CTHREADS
3565 cthread_set_data(cthread_self(), t);
3568 const int error = pthread_setspecific(PL_thr_key, t);
3570 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3578 #endif /* !PERL_GET_CONTEXT_DEFINED */
3580 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3584 PERL_UNUSED_CONTEXT;
3590 Perl_get_op_names(pTHX)
3592 PERL_UNUSED_CONTEXT;
3593 return (char **)PL_op_name;
3597 Perl_get_op_descs(pTHX)
3599 PERL_UNUSED_CONTEXT;
3600 return (char **)PL_op_desc;
3604 Perl_get_no_modify(pTHX)
3606 PERL_UNUSED_CONTEXT;
3607 return PL_no_modify;
3611 Perl_get_opargs(pTHX)
3613 PERL_UNUSED_CONTEXT;
3614 return (U32 *)PL_opargs;
3618 Perl_get_ppaddr(pTHX)
3621 PERL_UNUSED_CONTEXT;
3622 return (PPADDR_t*)PL_ppaddr;
3625 #ifndef HAS_GETENV_LEN
3627 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3629 char * const env_trans = PerlEnv_getenv(env_elem);
3630 PERL_UNUSED_CONTEXT;
3631 PERL_ARGS_ASSERT_GETENV_LEN;
3633 *len = strlen(env_trans);
3640 Perl_get_vtbl(pTHX_ int vtbl_id)
3642 PERL_UNUSED_CONTEXT;
3644 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3645 ? NULL : (MGVTBL*)PL_magic_vtables + vtbl_id;
3649 Perl_my_fflush_all(pTHX)
3651 #if defined(USE_PERLIO) || defined(FFLUSH_NULL)
3652 return PerlIO_flush(NULL);
3654 # if defined(HAS__FWALK)
3655 extern int fflush(FILE *);
3656 /* undocumented, unprototyped, but very useful BSDism */
3657 extern void _fwalk(int (*)(FILE *));
3661 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3663 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3664 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3666 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3667 open_max = sysconf(_SC_OPEN_MAX);
3670 open_max = FOPEN_MAX;
3673 open_max = OPEN_MAX;
3684 for (i = 0; i < open_max; i++)
3685 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3686 STDIO_STREAM_ARRAY[i]._file < open_max &&
3687 STDIO_STREAM_ARRAY[i]._flag)
3688 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3692 SETERRNO(EBADF,RMS_IFI);
3699 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3701 if (ckWARN(WARN_IO)) {
3703 = gv && (isGV_with_GP(gv))
3706 const char * const direction = have == '>' ? "out" : "in";
3708 if (name && HEK_LEN(name))
3709 Perl_warner(aTHX_ packWARN(WARN_IO),
3710 "Filehandle %"HEKf" opened only for %sput",
3711 HEKfARG(name), direction);
3713 Perl_warner(aTHX_ packWARN(WARN_IO),
3714 "Filehandle opened only for %sput", direction);
3719 Perl_report_evil_fh(pTHX_ const GV *gv)
3721 const IO *io = gv ? GvIO(gv) : NULL;
3722 const PERL_BITFIELD16 op = PL_op->op_type;
3726 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3728 warn_type = WARN_CLOSED;
3732 warn_type = WARN_UNOPENED;
3735 if (ckWARN(warn_type)) {
3737 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3738 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3739 const char * const pars =
3740 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3741 const char * const func =
3743 (op == OP_READLINE || op == OP_RCATLINE
3744 ? "readline" : /* "<HANDLE>" not nice */
3745 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3747 const char * const type =
3749 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3750 ? "socket" : "filehandle");
3751 const bool have_name = name && SvCUR(name);
3752 Perl_warner(aTHX_ packWARN(warn_type),
3753 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3754 have_name ? " " : "",
3755 SVfARG(have_name ? name : &PL_sv_no));
3756 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3758 aTHX_ packWARN(warn_type),
3759 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3760 func, pars, have_name ? " " : "",
3761 SVfARG(have_name ? name : &PL_sv_no)
3766 /* To workaround core dumps from the uninitialised tm_zone we get the
3767 * system to give us a reasonable struct to copy. This fix means that
3768 * strftime uses the tm_zone and tm_gmtoff values returned by
3769 * localtime(time()). That should give the desired result most of the
3770 * time. But probably not always!
3772 * This does not address tzname aspects of NETaa14816.
3777 # ifndef STRUCT_TM_HASZONE
3778 # define STRUCT_TM_HASZONE
3782 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3783 # ifndef HAS_TM_TM_ZONE
3784 # define HAS_TM_TM_ZONE
3789 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3791 #ifdef HAS_TM_TM_ZONE
3793 const struct tm* my_tm;
3794 PERL_UNUSED_CONTEXT;
3795 PERL_ARGS_ASSERT_INIT_TM;
3797 my_tm = localtime(&now);
3799 Copy(my_tm, ptm, 1, struct tm);
3801 PERL_UNUSED_CONTEXT;
3802 PERL_ARGS_ASSERT_INIT_TM;
3803 PERL_UNUSED_ARG(ptm);
3808 * mini_mktime - normalise struct tm values without the localtime()
3809 * semantics (and overhead) of mktime().
3812 Perl_mini_mktime(struct tm *ptm)
3816 int month, mday, year, jday;
3817 int odd_cent, odd_year;
3819 PERL_ARGS_ASSERT_MINI_MKTIME;
3821 #define DAYS_PER_YEAR 365
3822 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3823 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3824 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3825 #define SECS_PER_HOUR (60*60)
3826 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3827 /* parentheses deliberately absent on these two, otherwise they don't work */
3828 #define MONTH_TO_DAYS 153/5
3829 #define DAYS_TO_MONTH 5/153
3830 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3831 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3832 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3833 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3836 * Year/day algorithm notes:
3838 * With a suitable offset for numeric value of the month, one can find
3839 * an offset into the year by considering months to have 30.6 (153/5) days,
3840 * using integer arithmetic (i.e., with truncation). To avoid too much
3841 * messing about with leap days, we consider January and February to be
3842 * the 13th and 14th month of the previous year. After that transformation,
3843 * we need the month index we use to be high by 1 from 'normal human' usage,
3844 * so the month index values we use run from 4 through 15.
3846 * Given that, and the rules for the Gregorian calendar (leap years are those
3847 * divisible by 4 unless also divisible by 100, when they must be divisible
3848 * by 400 instead), we can simply calculate the number of days since some
3849 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3850 * the days we derive from our month index, and adding in the day of the
3851 * month. The value used here is not adjusted for the actual origin which
3852 * it normally would use (1 January A.D. 1), since we're not exposing it.
3853 * We're only building the value so we can turn around and get the
3854 * normalised values for the year, month, day-of-month, and day-of-year.
3856 * For going backward, we need to bias the value we're using so that we find
3857 * the right year value. (Basically, we don't want the contribution of
3858 * March 1st to the number to apply while deriving the year). Having done
3859 * that, we 'count up' the contribution to the year number by accounting for
3860 * full quadracenturies (400-year periods) with their extra leap days, plus
3861 * the contribution from full centuries (to avoid counting in the lost leap
3862 * days), plus the contribution from full quad-years (to count in the normal
3863 * leap days), plus the leftover contribution from any non-leap years.
3864 * At this point, if we were working with an actual leap day, we'll have 0
3865 * days left over. This is also true for March 1st, however. So, we have
3866 * to special-case that result, and (earlier) keep track of the 'odd'
3867 * century and year contributions. If we got 4 extra centuries in a qcent,
3868 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3869 * Otherwise, we add back in the earlier bias we removed (the 123 from
3870 * figuring in March 1st), find the month index (integer division by 30.6),
3871 * and the remainder is the day-of-month. We then have to convert back to
3872 * 'real' months (including fixing January and February from being 14/15 in
3873 * the previous year to being in the proper year). After that, to get
3874 * tm_yday, we work with the normalised year and get a new yearday value for
3875 * January 1st, which we subtract from the yearday value we had earlier,
3876 * representing the date we've re-built. This is done from January 1
3877 * because tm_yday is 0-origin.
3879 * Since POSIX time routines are only guaranteed to work for times since the
3880 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3881 * applies Gregorian calendar rules even to dates before the 16th century
3882 * doesn't bother me. Besides, you'd need cultural context for a given
3883 * date to know whether it was Julian or Gregorian calendar, and that's
3884 * outside the scope for this routine. Since we convert back based on the
3885 * same rules we used to build the yearday, you'll only get strange results
3886 * for input which needed normalising, or for the 'odd' century years which
3887 * were leap years in the Julian calendar but not in the Gregorian one.
3888 * I can live with that.
3890 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3891 * that's still outside the scope for POSIX time manipulation, so I don't
3895 year = 1900 + ptm->tm_year;
3896 month = ptm->tm_mon;
3897 mday = ptm->tm_mday;
3903 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3904 yearday += month*MONTH_TO_DAYS + mday + jday;
3906 * Note that we don't know when leap-seconds were or will be,
3907 * so we have to trust the user if we get something which looks
3908 * like a sensible leap-second. Wild values for seconds will
3909 * be rationalised, however.
3911 if ((unsigned) ptm->tm_sec <= 60) {
3918 secs += 60 * ptm->tm_min;
3919 secs += SECS_PER_HOUR * ptm->tm_hour;
3921 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3922 /* got negative remainder, but need positive time */
3923 /* back off an extra day to compensate */
3924 yearday += (secs/SECS_PER_DAY)-1;
3925 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3928 yearday += (secs/SECS_PER_DAY);
3929 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3932 else if (secs >= SECS_PER_DAY) {
3933 yearday += (secs/SECS_PER_DAY);
3934 secs %= SECS_PER_DAY;
3936 ptm->tm_hour = secs/SECS_PER_HOUR;
3937 secs %= SECS_PER_HOUR;
3938 ptm->tm_min = secs/60;
3940 ptm->tm_sec += secs;
3941 /* done with time of day effects */
3943 * The algorithm for yearday has (so far) left it high by 428.
3944 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3945 * bias it by 123 while trying to figure out what year it
3946 * really represents. Even with this tweak, the reverse
3947 * translation fails for years before A.D. 0001.
3948 * It would still fail for Feb 29, but we catch that one below.
3950 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3951 yearday -= YEAR_ADJUST;
3952 year = (yearday / DAYS_PER_QCENT) * 400;
3953 yearday %= DAYS_PER_QCENT;
3954 odd_cent = yearday / DAYS_PER_CENT;
3955 year += odd_cent * 100;
3956 yearday %= DAYS_PER_CENT;
3957 year += (yearday / DAYS_PER_QYEAR) * 4;
3958 yearday %= DAYS_PER_QYEAR;
3959 odd_year = yearday / DAYS_PER_YEAR;
3961 yearday %= DAYS_PER_YEAR;
3962 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3967 yearday += YEAR_ADJUST; /* recover March 1st crock */
3968 month = yearday*DAYS_TO_MONTH;
3969 yearday -= month*MONTH_TO_DAYS;
3970 /* recover other leap-year adjustment */
3979 ptm->tm_year = year - 1900;
3981 ptm->tm_mday = yearday;
3982 ptm->tm_mon = month;
3986 ptm->tm_mon = month - 1;
3988 /* re-build yearday based on Jan 1 to get tm_yday */
3990 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3991 yearday += 14*MONTH_TO_DAYS + 1;
3992 ptm->tm_yday = jday - yearday;
3993 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3997 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)
4001 /* Note that yday and wday effectively are ignored by this function, as mini_mktime() overwrites them */
4008 PERL_ARGS_ASSERT_MY_STRFTIME;
4010 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4013 mytm.tm_hour = hour;
4014 mytm.tm_mday = mday;
4016 mytm.tm_year = year;
4017 mytm.tm_wday = wday;
4018 mytm.tm_yday = yday;
4019 mytm.tm_isdst = isdst;
4021 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4022 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4027 #ifdef HAS_TM_TM_GMTOFF
4028 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4030 #ifdef HAS_TM_TM_ZONE
4031 mytm.tm_zone = mytm2.tm_zone;
4036 Newx(buf, buflen, char);
4038 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4039 len = strftime(buf, buflen, fmt, &mytm);
4043 ** The following is needed to handle to the situation where
4044 ** tmpbuf overflows. Basically we want to allocate a buffer
4045 ** and try repeatedly. The reason why it is so complicated
4046 ** is that getting a return value of 0 from strftime can indicate
4047 ** one of the following:
4048 ** 1. buffer overflowed,
4049 ** 2. illegal conversion specifier, or
4050 ** 3. the format string specifies nothing to be returned(not
4051 ** an error). This could be because format is an empty string
4052 ** or it specifies %p that yields an empty string in some locale.
4053 ** If there is a better way to make it portable, go ahead by
4056 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4059 /* Possibly buf overflowed - try again with a bigger buf */
4060 const int fmtlen = strlen(fmt);
4061 int bufsize = fmtlen + buflen;
4063 Renew(buf, bufsize, char);
4066 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
4067 buflen = strftime(buf, bufsize, fmt, &mytm);
4070 if (buflen > 0 && buflen < bufsize)
4072 /* heuristic to prevent out-of-memory errors */
4073 if (bufsize > 100*fmtlen) {
4079 Renew(buf, bufsize, char);
4084 Perl_croak(aTHX_ "panic: no strftime");
4090 #define SV_CWD_RETURN_UNDEF \
4091 sv_setsv(sv, &PL_sv_undef); \
4094 #define SV_CWD_ISDOT(dp) \
4095 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4096 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4099 =head1 Miscellaneous Functions
4101 =for apidoc getcwd_sv
4103 Fill C<sv> with current working directory
4108 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4109 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4110 * getcwd(3) if available
4111 * Comments from the original:
4112 * This is a faster version of getcwd. It's also more dangerous
4113 * because you might chdir out of a directory that you can't chdir
4117 Perl_getcwd_sv(pTHX_ SV *sv)
4122 PERL_ARGS_ASSERT_GETCWD_SV;
4126 char buf[MAXPATHLEN];
4128 /* Some getcwd()s automatically allocate a buffer of the given
4129 * size from the heap if they are given a NULL buffer pointer.
4130 * The problem is that this behaviour is not portable. */
4131 if (getcwd(buf, sizeof(buf) - 1)) {
4136 sv_setsv(sv, &PL_sv_undef);
4144 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4148 SvUPGRADE(sv, SVt_PV);
4150 if (PerlLIO_lstat(".", &statbuf) < 0) {
4151 SV_CWD_RETURN_UNDEF;
4154 orig_cdev = statbuf.st_dev;
4155 orig_cino = statbuf.st_ino;
4165 if (PerlDir_chdir("..") < 0) {
4166 SV_CWD_RETURN_UNDEF;
4168 if (PerlLIO_stat(".", &statbuf) < 0) {
4169 SV_CWD_RETURN_UNDEF;
4172 cdev = statbuf.st_dev;
4173 cino = statbuf.st_ino;
4175 if (odev == cdev && oino == cino) {
4178 if (!(dir = PerlDir_open("."))) {
4179 SV_CWD_RETURN_UNDEF;
4182 while ((dp = PerlDir_read(dir)) != NULL) {
4184 namelen = dp->d_namlen;
4186 namelen = strlen(dp->d_name);
4189 if (SV_CWD_ISDOT(dp)) {
4193 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4194 SV_CWD_RETURN_UNDEF;
4197 tdev = statbuf.st_dev;
4198 tino = statbuf.st_ino;
4199 if (tino == oino && tdev == odev) {
4205 SV_CWD_RETURN_UNDEF;
4208 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4209 SV_CWD_RETURN_UNDEF;
4212 SvGROW(sv, pathlen + namelen + 1);
4216 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4219 /* prepend current directory to the front */
4221 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4222 pathlen += (namelen + 1);
4224 #ifdef VOID_CLOSEDIR
4227 if (PerlDir_close(dir) < 0) {
4228 SV_CWD_RETURN_UNDEF;
4234 SvCUR_set(sv, pathlen);
4238 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4239 SV_CWD_RETURN_UNDEF;
4242 if (PerlLIO_stat(".", &statbuf) < 0) {
4243 SV_CWD_RETURN_UNDEF;
4246 cdev = statbuf.st_dev;
4247 cino = statbuf.st_ino;
4249 if (cdev != orig_cdev || cino != orig_cino) {
4250 Perl_croak(aTHX_ "Unstable directory path, "
4251 "current directory changed unexpectedly");
4264 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4265 # define EMULATE_SOCKETPAIR_UDP
4268 #ifdef EMULATE_SOCKETPAIR_UDP
4270 S_socketpair_udp (int fd[2]) {
4272 /* Fake a datagram socketpair using UDP to localhost. */
4273 int sockets[2] = {-1, -1};
4274 struct sockaddr_in addresses[2];
4276 Sock_size_t size = sizeof(struct sockaddr_in);
4277 unsigned short port;
4280 memset(&addresses, 0, sizeof(addresses));
4283 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4284 if (sockets[i] == -1)
4285 goto tidy_up_and_fail;
4287 addresses[i].sin_family = AF_INET;
4288 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4289 addresses[i].sin_port = 0; /* kernel choses port. */
4290 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4291 sizeof(struct sockaddr_in)) == -1)
4292 goto tidy_up_and_fail;
4295 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4296 for each connect the other socket to it. */
4299 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4301 goto tidy_up_and_fail;
4302 if (size != sizeof(struct sockaddr_in))
4303 goto abort_tidy_up_and_fail;
4304 /* !1 is 0, !0 is 1 */
4305 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4306 sizeof(struct sockaddr_in)) == -1)
4307 goto tidy_up_and_fail;
4310 /* Now we have 2 sockets connected to each other. I don't trust some other
4311 process not to have already sent a packet to us (by random) so send
4312 a packet from each to the other. */
4315 /* I'm going to send my own port number. As a short.
4316 (Who knows if someone somewhere has sin_port as a bitfield and needs
4317 this routine. (I'm assuming crays have socketpair)) */
4318 port = addresses[i].sin_port;
4319 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4320 if (got != sizeof(port)) {
4322 goto tidy_up_and_fail;
4323 goto abort_tidy_up_and_fail;
4327 /* Packets sent. I don't trust them to have arrived though.
4328 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4329 connect to localhost will use a second kernel thread. In 2.6 the
4330 first thread running the connect() returns before the second completes,
4331 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4332 returns 0. Poor programs have tripped up. One poor program's authors'
4333 had a 50-1 reverse stock split. Not sure how connected these were.)
4334 So I don't trust someone not to have an unpredictable UDP stack.
4338 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4339 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4343 FD_SET((unsigned int)sockets[0], &rset);
4344 FD_SET((unsigned int)sockets[1], &rset);
4346 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4347 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4348 || !FD_ISSET(sockets[1], &rset)) {
4349 /* I hope this is portable and appropriate. */
4351 goto tidy_up_and_fail;
4352 goto abort_tidy_up_and_fail;
4356 /* And the paranoia department even now doesn't trust it to have arrive
4357 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4359 struct sockaddr_in readfrom;
4360 unsigned short buffer[2];
4365 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4366 sizeof(buffer), MSG_DONTWAIT,
4367 (struct sockaddr *) &readfrom, &size);
4369 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4371 (struct sockaddr *) &readfrom, &size);
4375 goto tidy_up_and_fail;
4376 if (got != sizeof(port)
4377 || size != sizeof(struct sockaddr_in)
4378 /* Check other socket sent us its port. */
4379 || buffer[0] != (unsigned short) addresses[!i].sin_port
4380 /* Check kernel says we got the datagram from that socket */
4381 || readfrom.sin_family != addresses[!i].sin_family
4382 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4383 || readfrom.sin_port != addresses[!i].sin_port)
4384 goto abort_tidy_up_and_fail;
4387 /* My caller (my_socketpair) has validated that this is non-NULL */
4390 /* I hereby declare this connection open. May God bless all who cross
4394 abort_tidy_up_and_fail:
4395 errno = ECONNABORTED;
4399 if (sockets[0] != -1)
4400 PerlLIO_close(sockets[0]);
4401 if (sockets[1] != -1)
4402 PerlLIO_close(sockets[1]);
4407 #endif /* EMULATE_SOCKETPAIR_UDP */
4409 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
4411 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4412 /* Stevens says that family must be AF_LOCAL, protocol 0.
4413 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
4418 struct sockaddr_in listen_addr;
4419 struct sockaddr_in connect_addr;
4424 || family != AF_UNIX
4427 errno = EAFNOSUPPORT;
4435 #ifdef EMULATE_SOCKETPAIR_UDP
4436 if (type == SOCK_DGRAM)
4437 return S_socketpair_udp(fd);
4440 aTHXa(PERL_GET_THX);
4441 listener = PerlSock_socket(AF_INET, type, 0);
4444 memset(&listen_addr, 0, sizeof(listen_addr));
4445 listen_addr.sin_family = AF_INET;
4446 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4447 listen_addr.sin_port = 0; /* kernel choses port. */
4448 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
4449 sizeof(listen_addr)) == -1)
4450 goto tidy_up_and_fail;
4451 if (PerlSock_listen(listener, 1) == -1)
4452 goto tidy_up_and_fail;
4454 connector = PerlSock_socket(AF_INET, type, 0);
4455 if (connector == -1)
4456 goto tidy_up_and_fail;
4457 /* We want to find out the port number to connect to. */
4458 size = sizeof(connect_addr);
4459 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
4461 goto tidy_up_and_fail;
4462 if (size != sizeof(connect_addr))
4463 goto abort_tidy_up_and_fail;
4464 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
4465 sizeof(connect_addr)) == -1)
4466 goto tidy_up_and_fail;
4468 size = sizeof(listen_addr);
4469 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
4472 goto tidy_up_and_fail;
4473 if (size != sizeof(listen_addr))
4474 goto abort_tidy_up_and_fail;
4475 PerlLIO_close(listener);
4476 /* Now check we are talking to ourself by matching port and host on the
4478 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
4480 goto tidy_up_and_fail;
4481 if (size != sizeof(connect_addr)
4482 || listen_addr.sin_family != connect_addr.sin_family
4483 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
4484 || listen_addr.sin_port != connect_addr.sin_port) {
4485 goto abort_tidy_up_and_fail;
4491 abort_tidy_up_and_fail:
4493 errno = ECONNABORTED; /* This would be the standard thing to do. */
4495 # ifdef ECONNREFUSED
4496 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
4498 errno = ETIMEDOUT; /* Desperation time. */
4505 PerlLIO_close(listener);
4506 if (connector != -1)
4507 PerlLIO_close(connector);
4509 PerlLIO_close(acceptor);
4515 /* In any case have a stub so that there's code corresponding
4516 * to the my_socketpair in embed.fnc. */
4518 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
4519 #ifdef HAS_SOCKETPAIR
4520 return socketpair(family, type, protocol, fd);
4529 =for apidoc sv_nosharing
4531 Dummy routine which "shares" an SV when there is no sharing module present.
4532 Or "locks" it. Or "unlocks" it. In other
4533 words, ignores its single SV argument.
4534 Exists to avoid test for a C<NULL> function pointer and because it could
4535 potentially warn under some level of strict-ness.
4541 Perl_sv_nosharing(pTHX_ SV *sv)
4543 PERL_UNUSED_CONTEXT;
4544 PERL_UNUSED_ARG(sv);
4549 =for apidoc sv_destroyable
4551 Dummy routine which reports that object can be destroyed when there is no
4552 sharing module present. It ignores its single SV argument, and returns
4553 'true'. Exists to avoid test for a C<NULL> function pointer and because it
4554 could potentially warn under some level of strict-ness.
4560 Perl_sv_destroyable(pTHX_ SV *sv)
4562 PERL_UNUSED_CONTEXT;
4563 PERL_UNUSED_ARG(sv);
4568 Perl_parse_unicode_opts(pTHX_ const char **popt)
4570 const char *p = *popt;
4573 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
4579 if (grok_atoUV(p, &uv, &endptr) && uv <= U32_MAX) {
4582 if (p && *p && *p != '\n' && *p != '\r') {
4584 goto the_end_of_the_opts_parser;
4586 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
4590 Perl_croak(aTHX_ "Invalid number '%s' for -C option.\n", p);
4596 case PERL_UNICODE_STDIN:
4597 opt |= PERL_UNICODE_STDIN_FLAG; break;
4598 case PERL_UNICODE_STDOUT:
4599 opt |= PERL_UNICODE_STDOUT_FLAG; break;
4600 case PERL_UNICODE_STDERR:
4601 opt |= PERL_UNICODE_STDERR_FLAG; break;
4602 case PERL_UNICODE_STD:
4603 opt |= PERL_UNICODE_STD_FLAG; break;
4604 case PERL_UNICODE_IN:
4605 opt |= PERL_UNICODE_IN_FLAG; break;
4606 case PERL_UNICODE_OUT:
4607 opt |= PERL_UNICODE_OUT_FLAG; break;
4608 case PERL_UNICODE_INOUT:
4609 opt |= PERL_UNICODE_INOUT_FLAG; break;
4610 case PERL_UNICODE_LOCALE:
4611 opt |= PERL_UNICODE_LOCALE_FLAG; break;
4612 case PERL_UNICODE_ARGV:
4613 opt |= PERL_UNICODE_ARGV_FLAG; break;
4614 case PERL_UNICODE_UTF8CACHEASSERT:
4615 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
4617 if (*p != '\n' && *p != '\r') {
4618 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
4621 "Unknown Unicode option letter '%c'", *p);
4628 opt = PERL_UNICODE_DEFAULT_FLAGS;
4630 the_end_of_the_opts_parser:
4632 if (opt & ~PERL_UNICODE_ALL_FLAGS)
4633 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
4634 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
4642 # include <starlet.h>
4649 * This is really just a quick hack which grabs various garbage
4650 * values. It really should be a real hash algorithm which
4651 * spreads the effect of every input bit onto every output bit,
4652 * if someone who knows about such things would bother to write it.
4653 * Might be a good idea to add that function to CORE as well.
4654 * No numbers below come from careful analysis or anything here,
4655 * except they are primes and SEED_C1 > 1E6 to get a full-width
4656 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
4657 * probably be bigger too.
4660 # define SEED_C1 1000003
4661 #define SEED_C4 73819
4663 # define SEED_C1 25747
4664 #define SEED_C4 20639
4668 #define SEED_C5 26107
4670 #ifndef PERL_NO_DEV_RANDOM
4674 #ifdef HAS_GETTIMEOFDAY
4675 struct timeval when;
4680 /* This test is an escape hatch, this symbol isn't set by Configure. */
4681 #ifndef PERL_NO_DEV_RANDOM
4682 #ifndef PERL_RANDOM_DEVICE
4683 /* /dev/random isn't used by default because reads from it will block
4684 * if there isn't enough entropy available. You can compile with
4685 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
4686 * is enough real entropy to fill the seed. */
4687 # ifdef __amigaos4__
4688 # define PERL_RANDOM_DEVICE "RANDOM:SIZE=4"
4690 # define PERL_RANDOM_DEVICE "/dev/urandom"
4693 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
4695 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
4703 #ifdef HAS_GETTIMEOFDAY
4704 PerlProc_gettimeofday(&when,NULL);
4705 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
4708 u = (U32)SEED_C1 * when;
4710 u += SEED_C3 * (U32)PerlProc_getpid();
4711 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
4712 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
4713 u += SEED_C5 * (U32)PTR2UV(&when);
4719 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
4724 PERL_ARGS_ASSERT_GET_HASH_SEED;
4726 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
4729 #ifndef USE_HASH_SEED_EXPLICIT
4731 /* ignore leading spaces */
4732 while (isSPACE(*env_pv))
4734 #ifdef USE_PERL_PERTURB_KEYS
4735 /* if they set it to "0" we disable key traversal randomization completely */
4736 if (strEQ(env_pv,"0")) {
4737 PL_hash_rand_bits_enabled= 0;
4739 /* otherwise switch to deterministic mode */
4740 PL_hash_rand_bits_enabled= 2;
4743 /* ignore a leading 0x... if it is there */
4744 if (env_pv[0] == '0' && env_pv[1] == 'x')
4747 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
4748 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
4749 if ( isXDIGIT(*env_pv)) {
4750 seed_buffer[i] |= READ_XDIGIT(env_pv);
4753 while (isSPACE(*env_pv))
4756 if (*env_pv && !isXDIGIT(*env_pv)) {
4757 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
4759 /* should we check for unparsed crap? */
4760 /* should we warn about unused hex? */
4761 /* should we warn about insufficient hex? */
4766 (void)seedDrand01((Rand_seed_t)seed());
4768 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
4769 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
4772 #ifdef USE_PERL_PERTURB_KEYS
4773 { /* initialize PL_hash_rand_bits from the hash seed.
4774 * This value is highly volatile, it is updated every
4775 * hash insert, and is used as part of hash bucket chain
4776 * randomization and hash iterator randomization. */
4777 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
4778 for( i = 0; i < sizeof(UV) ; i++ ) {
4779 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
4780 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
4783 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
4785 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
4786 PL_hash_rand_bits_enabled= 0;
4787 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
4788 PL_hash_rand_bits_enabled= 1;
4789 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
4790 PL_hash_rand_bits_enabled= 2;
4792 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
4798 #ifdef PERL_GLOBAL_STRUCT
4800 #define PERL_GLOBAL_STRUCT_INIT
4801 #include "opcode.h" /* the ppaddr and check */
4804 Perl_init_global_struct(pTHX)
4806 struct perl_vars *plvarsp = NULL;
4807 # ifdef PERL_GLOBAL_STRUCT
4808 const IV nppaddr = C_ARRAY_LENGTH(Gppaddr);
4809 const IV ncheck = C_ARRAY_LENGTH(Gcheck);
4810 PERL_UNUSED_CONTEXT;
4811 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4812 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
4813 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
4817 plvarsp = PL_VarsPtr;
4818 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
4823 # define PERLVAR(prefix,var,type) /**/
4824 # define PERLVARA(prefix,var,n,type) /**/
4825 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
4826 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
4827 # include "perlvars.h"
4832 # ifdef PERL_GLOBAL_STRUCT
4835 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
4836 if (!plvarsp->Gppaddr)
4840 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
4841 if (!plvarsp->Gcheck)
4843 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
4844 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
4846 # ifdef PERL_SET_VARS
4847 PERL_SET_VARS(plvarsp);
4849 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4850 plvarsp->Gsv_placeholder.sv_flags = 0;
4851 memset(plvarsp->Ghash_seed, 0, sizeof(plvarsp->Ghash_seed));
4853 # undef PERL_GLOBAL_STRUCT_INIT
4858 #endif /* PERL_GLOBAL_STRUCT */
4860 #ifdef PERL_GLOBAL_STRUCT
4863 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
4865 int veto = plvarsp->Gveto_cleanup;
4867 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
4868 PERL_UNUSED_CONTEXT;
4869 # ifdef PERL_GLOBAL_STRUCT
4870 # ifdef PERL_UNSET_VARS
4871 PERL_UNSET_VARS(plvarsp);
4875 free(plvarsp->Gppaddr);
4876 free(plvarsp->Gcheck);
4877 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
4883 #endif /* PERL_GLOBAL_STRUCT */
4887 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including
4888 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
4889 * given, and you supply your own implementation.
4891 * The default implementation reads a single env var, PERL_MEM_LOG,
4892 * expecting one or more of the following:
4894 * \d+ - fd fd to write to : must be 1st (grok_atoUV)
4895 * 'm' - memlog was PERL_MEM_LOG=1
4896 * 's' - svlog was PERL_SV_LOG=1
4897 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
4899 * This makes the logger controllable enough that it can reasonably be
4900 * added to the system perl.
4903 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
4904 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
4906 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
4908 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
4909 * writes to. In the default logger, this is settable at runtime.
4911 #ifndef PERL_MEM_LOG_FD
4912 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
4915 #ifndef PERL_MEM_LOG_NOIMPL
4917 # ifdef DEBUG_LEAKING_SCALARS
4918 # define SV_LOG_SERIAL_FMT " [%lu]"
4919 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
4921 # define SV_LOG_SERIAL_FMT
4922 # define _SV_LOG_SERIAL_ARG(sv)
4926 S_mem_log_common(enum mem_log_type mlt, const UV n,
4927 const UV typesize, const char *type_name, const SV *sv,
4928 Malloc_t oldalloc, Malloc_t newalloc,
4929 const char *filename, const int linenumber,
4930 const char *funcname)
4934 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
4936 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
4939 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
4941 /* We can't use SVs or PerlIO for obvious reasons,
4942 * so we'll use stdio and low-level IO instead. */
4943 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
4945 # ifdef HAS_GETTIMEOFDAY
4946 # define MEM_LOG_TIME_FMT "%10d.%06d: "
4947 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
4949 gettimeofday(&tv, 0);
4951 # define MEM_LOG_TIME_FMT "%10d: "
4952 # define MEM_LOG_TIME_ARG (int)when
4956 /* If there are other OS specific ways of hires time than
4957 * gettimeofday() (see dist/Time-HiRes), the easiest way is
4958 * probably that they would be used to fill in the struct
4965 if (grok_atoUV(pmlenv, &uv, &endptr) /* Ignore endptr. */
4966 && uv && uv <= PERL_INT_MAX
4970 fd = PERL_MEM_LOG_FD;
4973 if (strchr(pmlenv, 't')) {
4974 len = my_snprintf(buf, sizeof(buf),
4975 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
4976 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
4980 len = my_snprintf(buf, sizeof(buf),
4981 "alloc: %s:%d:%s: %"IVdf" %"UVuf
4982 " %s = %"IVdf": %"UVxf"\n",
4983 filename, linenumber, funcname, n, typesize,
4984 type_name, n * typesize, PTR2UV(newalloc));
4987 len = my_snprintf(buf, sizeof(buf),
4988 "realloc: %s:%d:%s: %"IVdf" %"UVuf
4989 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
4990 filename, linenumber, funcname, n, typesize,
4991 type_name, n * typesize, PTR2UV(oldalloc),
4995 len = my_snprintf(buf, sizeof(buf),
4996 "free: %s:%d:%s: %"UVxf"\n",
4997 filename, linenumber, funcname,
5002 len = my_snprintf(buf, sizeof(buf),
5003 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
5004 mlt == MLT_NEW_SV ? "new" : "del",
5005 filename, linenumber, funcname,
5006 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5011 PERL_UNUSED_RESULT(PerlLIO_write(fd, buf, len));
5015 #endif /* !PERL_MEM_LOG_NOIMPL */
5017 #ifndef PERL_MEM_LOG_NOIMPL
5019 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5020 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5022 /* this is suboptimal, but bug compatible. User is providing their
5023 own implementation, but is getting these functions anyway, and they
5024 do nothing. But _NOIMPL users should be able to cope or fix */
5026 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5027 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5031 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5033 const char *filename, const int linenumber,
5034 const char *funcname)
5036 PERL_ARGS_ASSERT_MEM_LOG_ALLOC;
5038 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5039 NULL, NULL, newalloc,
5040 filename, linenumber, funcname);
5045 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5046 Malloc_t oldalloc, Malloc_t newalloc,
5047 const char *filename, const int linenumber,
5048 const char *funcname)
5050 PERL_ARGS_ASSERT_MEM_LOG_REALLOC;
5052 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5053 NULL, oldalloc, newalloc,
5054 filename, linenumber, funcname);
5059 Perl_mem_log_free(Malloc_t oldalloc,
5060 const char *filename, const int linenumber,
5061 const char *funcname)
5063 PERL_ARGS_ASSERT_MEM_LOG_FREE;
5065 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5066 filename, linenumber, funcname);
5071 Perl_mem_log_new_sv(const SV *sv,
5072 const char *filename, const int linenumber,
5073 const char *funcname)
5075 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5076 filename, linenumber, funcname);
5080 Perl_mem_log_del_sv(const SV *sv,
5081 const char *filename, const int linenumber,
5082 const char *funcname)
5084 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5085 filename, linenumber, funcname);
5088 #endif /* PERL_MEM_LOG */
5091 =for apidoc my_sprintf
5093 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5094 the length of the string written to the buffer. Only rare pre-ANSI systems
5095 need the wrapper function - usually this is a direct call to C<sprintf>.
5099 #ifndef SPRINTF_RETURNS_STRLEN
5101 Perl_my_sprintf(char *buffer, const char* pat, ...)
5104 PERL_ARGS_ASSERT_MY_SPRINTF;
5105 va_start(args, pat);
5106 vsprintf(buffer, pat, args);
5108 return strlen(buffer);
5113 =for apidoc quadmath_format_single
5115 C<quadmath_snprintf()> is very strict about its C<format> string and will
5116 fail, returning -1, if the format is invalid. It accepts exactly
5119 C<quadmath_format_single()> checks that the intended single spec looks
5120 sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
5121 and has C<Q> before it. This is not a full "printf syntax check",
5124 Returns the format if it is valid, NULL if not.
5126 C<quadmath_format_single()> can and will actually patch in the missing
5127 C<Q>, if necessary. In this case it will return the modified copy of
5128 the format, B<which the caller will need to free.>
5130 See also L</quadmath_format_needed>.
5136 Perl_quadmath_format_single(const char* format)
5140 PERL_ARGS_ASSERT_QUADMATH_FORMAT_SINGLE;
5142 if (format[0] != '%' || strchr(format + 1, '%'))
5144 len = strlen(format);
5145 /* minimum length three: %Qg */
5146 if (len < 3 || strchr("efgaEFGA", format[len - 1]) == NULL)
5148 if (format[len - 2] != 'Q') {
5150 Newx(fixed, len + 1, char);
5151 memcpy(fixed, format, len - 1);
5152 fixed[len - 1] = 'Q';
5153 fixed[len ] = format[len - 1];
5155 return (const char*)fixed;
5162 =for apidoc quadmath_format_needed
5164 C<quadmath_format_needed()> returns true if the C<format> string seems to
5165 contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
5166 or returns false otherwise.
5168 The format specifier detection is not complete printf-syntax detection,
5169 but it should catch most common cases.
5171 If true is returned, those arguments B<should> in theory be processed
5172 with C<quadmath_snprintf()>, but in case there is more than one such
5173 format specifier (see L</quadmath_format_single>), and if there is
5174 anything else beyond that one (even just a single byte), they
5175 B<cannot> be processed because C<quadmath_snprintf()> is very strict,
5176 accepting only one format spec, and nothing else.
5177 In this case, the code should probably fail.
5183 Perl_quadmath_format_needed(const char* format)
5185 const char *p = format;
5188 PERL_ARGS_ASSERT_QUADMATH_FORMAT_NEEDED;
5190 while ((q = strchr(p, '%'))) {
5192 if (*q == '+') /* plus */
5194 if (*q == '#') /* alt */
5196 if (*q == '*') /* width */
5200 while (isDIGIT(*q)) q++;
5203 if (*q == '.' && (q[1] == '*' || isDIGIT(q[1]))) { /* prec */
5208 while (isDIGIT(*q)) q++;
5210 if (strchr("efgaEFGA", *q)) /* Would have needed 'Q' in front. */
5219 =for apidoc my_snprintf
5221 The C library C<snprintf> functionality, if available and
5222 standards-compliant (uses C<vsnprintf>, actually). However, if the
5223 C<vsnprintf> is not available, will unfortunately use the unsafe
5224 C<vsprintf> which can overrun the buffer (there is an overrun check,
5225 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5226 getting C<vsnprintf>.
5231 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5235 PERL_ARGS_ASSERT_MY_SNPRINTF;
5236 #ifndef HAS_VSNPRINTF
5237 PERL_UNUSED_VAR(len);
5239 va_start(ap, format);
5242 const char* qfmt = quadmath_format_single(format);
5243 bool quadmath_valid = FALSE;
5245 /* If the format looked promising, use it as quadmath. */
5246 retval = quadmath_snprintf(buffer, len, qfmt, va_arg(ap, NV));
5248 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
5249 quadmath_valid = TRUE;
5254 assert(qfmt == NULL);
5255 /* quadmath_format_single() will return false for example for
5256 * "foo = %g", or simply "%g". We could handle the %g by
5257 * using quadmath for the NV args. More complex cases of
5258 * course exist: "foo = %g, bar = %g", or "foo=%Qg" (otherwise
5259 * quadmath-valid but has stuff in front).
5261 * Handling the "Q-less" cases right would require walking
5262 * through the va_list and rewriting the format, calling
5263 * quadmath for the NVs, building a new va_list, and then
5264 * letting vsnprintf/vsprintf to take care of the other
5265 * arguments. This may be doable.
5267 * We do not attempt that now. But for paranoia, we here try
5268 * to detect some common (but not all) cases where the
5269 * "Q-less" %[efgaEFGA] formats are present, and die if
5270 * detected. This doesn't fix the problem, but it stops the
5271 * vsnprintf/vsprintf pulling doubles off the va_list when
5272 * __float128 NVs should be pulled off instead.
5274 * If quadmath_format_needed() returns false, we are reasonably
5275 * certain that we can call vnsprintf() or vsprintf() safely. */
5276 if (!quadmath_valid && quadmath_format_needed(format))
5277 Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", format);
5282 #ifdef HAS_VSNPRINTF
5283 retval = vsnprintf(buffer, len, format, ap);
5285 retval = vsprintf(buffer, format, ap);
5288 /* vsprintf() shows failure with < 0 */
5290 #ifdef HAS_VSNPRINTF
5291 /* vsnprintf() shows failure with >= len */
5293 (len > 0 && (Size_t)retval >= len)
5296 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5301 =for apidoc my_vsnprintf
5303 The C library C<vsnprintf> if available and standards-compliant.
5304 However, if if the C<vsnprintf> is not available, will unfortunately
5305 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5306 overrun check, but that may be too late). Consider using
5307 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5312 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5315 PERL_UNUSED_ARG(buffer);
5316 PERL_UNUSED_ARG(len);
5317 PERL_UNUSED_ARG(format);
5318 /* the cast is to avoid gcc -Wsizeof-array-argument complaining */
5319 PERL_UNUSED_ARG((void*)ap);
5320 Perl_croak_nocontext("panic: my_vsnprintf not available with quadmath");
5327 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5328 Perl_va_copy(ap, apc);
5329 # ifdef HAS_VSNPRINTF
5330 retval = vsnprintf(buffer, len, format, apc);
5332 PERL_UNUSED_ARG(len);
5333 retval = vsprintf(buffer, format, apc);
5337 # ifdef HAS_VSNPRINTF
5338 retval = vsnprintf(buffer, len, format, ap);
5340 PERL_UNUSED_ARG(len);
5341 retval = vsprintf(buffer, format, ap);
5343 #endif /* #ifdef NEED_VA_COPY */
5344 /* vsprintf() shows failure with < 0 */
5346 #ifdef HAS_VSNPRINTF
5347 /* vsnprintf() shows failure with >= len */
5349 (len > 0 && (Size_t)retval >= len)
5352 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5358 Perl_my_clearenv(pTHX)
5361 #if ! defined(PERL_MICRO)
5362 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5364 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5365 # if defined(USE_ENVIRON_ARRAY)
5366 # if defined(USE_ITHREADS)
5367 /* only the parent thread can clobber the process environment */
5368 if (PL_curinterp == aTHX)
5369 # endif /* USE_ITHREADS */
5371 # if ! defined(PERL_USE_SAFE_PUTENV)
5372 if ( !PL_use_safe_putenv) {
5374 if (environ == PL_origenviron)
5375 environ = (char**)safesysmalloc(sizeof(char*));
5377 for (i = 0; environ[i]; i++)
5378 (void)safesysfree(environ[i]);
5381 # else /* PERL_USE_SAFE_PUTENV */
5382 # if defined(HAS_CLEARENV)
5384 # elif defined(HAS_UNSETENV)
5385 int bsiz = 80; /* Most envvar names will be shorter than this. */
5386 char *buf = (char*)safesysmalloc(bsiz);
5387 while (*environ != NULL) {
5388 char *e = strchr(*environ, '=');
5389 int l = e ? e - *environ : (int)strlen(*environ);
5391 (void)safesysfree(buf);
5392 bsiz = l + 1; /* + 1 for the \0. */
5393 buf = (char*)safesysmalloc(bsiz);
5395 memcpy(buf, *environ, l);
5397 (void)unsetenv(buf);
5399 (void)safesysfree(buf);
5400 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5401 /* Just null environ and accept the leakage. */
5403 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5404 # endif /* ! PERL_USE_SAFE_PUTENV */
5406 # endif /* USE_ENVIRON_ARRAY */
5407 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5408 #endif /* PERL_MICRO */
5411 #ifdef PERL_IMPLICIT_CONTEXT
5413 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5414 the global PL_my_cxt_index is incremented, and that value is assigned to
5415 that module's static my_cxt_index (who's address is passed as an arg).
5416 Then, for each interpreter this function is called for, it makes sure a
5417 void* slot is available to hang the static data off, by allocating or
5418 extending the interpreter's PL_my_cxt_list array */
5420 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5422 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5426 PERL_ARGS_ASSERT_MY_CXT_INIT;
5428 /* this module hasn't been allocated an index yet */
5429 #if defined(USE_ITHREADS)
5430 MUTEX_LOCK(&PL_my_ctx_mutex);
5432 *index = PL_my_cxt_index++;
5433 #if defined(USE_ITHREADS)
5434 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5438 /* make sure the array is big enough */
5439 if (PL_my_cxt_size <= *index) {
5440 if (PL_my_cxt_size) {
5441 while (PL_my_cxt_size <= *index)
5442 PL_my_cxt_size *= 2;
5443 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5446 PL_my_cxt_size = 16;
5447 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5450 /* newSV() allocates one more than needed */
5451 p = (void*)SvPVX(newSV(size-1));
5452 PL_my_cxt_list[*index] = p;
5453 Zero(p, size, char);
5457 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5460 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5465 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5467 for (index = 0; index < PL_my_cxt_index; index++) {
5468 const char *key = PL_my_cxt_keys[index];
5469 /* try direct pointer compare first - there are chances to success,
5470 * and it's much faster.
5472 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5479 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5485 PERL_ARGS_ASSERT_MY_CXT_INIT;
5487 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5489 /* this module hasn't been allocated an index yet */
5490 #if defined(USE_ITHREADS)
5491 MUTEX_LOCK(&PL_my_ctx_mutex);
5493 index = PL_my_cxt_index++;
5494 #if defined(USE_ITHREADS)
5495 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5499 /* make sure the array is big enough */
5500 if (PL_my_cxt_size <= index) {
5501 int old_size = PL_my_cxt_size;
5503 if (PL_my_cxt_size) {
5504 while (PL_my_cxt_size <= index)
5505 PL_my_cxt_size *= 2;
5506 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5507 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5510 PL_my_cxt_size = 16;
5511 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5512 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5514 for (i = old_size; i < PL_my_cxt_size; i++) {
5515 PL_my_cxt_keys[i] = 0;
5516 PL_my_cxt_list[i] = 0;
5519 PL_my_cxt_keys[index] = my_cxt_key;
5520 /* newSV() allocates one more than needed */
5521 p = (void*)SvPVX(newSV(size-1));
5522 PL_my_cxt_list[index] = p;
5523 Zero(p, size, char);
5526 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5527 #endif /* PERL_IMPLICIT_CONTEXT */
5530 /* Perl_xs_handshake():
5531 implement the various XS_*_BOOTCHECK macros, which are added to .c
5532 files by ExtUtils::ParseXS, to check that the perl the module was built
5533 with is binary compatible with the running perl.
5536 Perl_xs_handshake(U32 key, void * v_my_perl, const char * file,
5537 [U32 items, U32 ax], [char * api_version], [char * xs_version])
5539 The meaning of the varargs is determined the U32 key arg (which is not
5540 a format string). The fields of key are assembled by using HS_KEY().
5542 Under PERL_IMPLICIT_CONTEX, the v_my_perl arg is of type
5543 "PerlInterpreter *" and represents the callers context; otherwise it is
5544 of type "CV *", and is the boot xsub's CV.
5546 v_my_perl will catch where a threaded future perl526.dll calling IO.dll
5547 for example, and IO.dll was linked with threaded perl524.dll, and both
5548 perl526.dll and perl524.dll are in %PATH and the Win32 DLL loader
5549 successfully can load IO.dll into the process but simultaneously it
5550 loaded an interpreter of a different version into the process, and XS
5551 code will naturally pass SV*s created by perl524.dll for perl526.dll to
5552 use through perl526.dll's my_perl->Istack_base.
5554 v_my_perl cannot be the first arg, since then 'key' will be out of
5555 place in a threaded vs non-threaded mixup; and analyzing the key
5556 number's bitfields won't reveal the problem, since it will be a valid
5557 key (unthreaded perl) on interp side, but croak will report the XS mod's
5558 key as gibberish (it is really a my_perl ptr) (threaded XS mod); or if
5559 it's a threaded perl and an unthreaded XS module, threaded perl will
5560 look at an uninit C stack or an uninit register to get 'key'
5561 (remember that it assumes that the 1st arg is the interp cxt).
5563 'file' is the source filename of the caller.
5567 Perl_xs_handshake(const U32 key, void * v_my_perl, const char * file, ...)
5573 #ifdef PERL_IMPLICIT_CONTEXT
5580 PERL_ARGS_ASSERT_XS_HANDSHAKE;
5581 va_start(args, file);
5583 got = INT2PTR(void*, (UV)(key & HSm_KEY_MATCH));
5584 need = (void *)(HS_KEY(FALSE, FALSE, "", "") & HSm_KEY_MATCH);
5585 if (UNLIKELY(got != need))
5587 /* try to catch where a 2nd threaded perl interp DLL is loaded into a process
5588 by a XS DLL compiled against the wrong interl DLL b/c of bad @INC, and the
5589 2nd threaded perl interp DLL never initialized its TLS/PERL_SYS_INIT3 so
5590 dTHX call from 2nd interp DLL can't return the my_perl that pp_entersub
5591 passed to the XS DLL */
5592 #ifdef PERL_IMPLICIT_CONTEXT
5593 xs_interp = (tTHX)v_my_perl;
5597 /* try to catch where an unthreaded perl interp DLL (for ex. perl522.dll) is
5598 loaded into a process by a XS DLL built by an unthreaded perl522.dll perl,
5599 but the DynaLoder/Perl that started the process and loaded the XS DLL is
5600 unthreaded perl524.dll, since unthreadeds don't pass my_perl (a unique *)
5601 through pp_entersub, use a unique value (which is a pointer to PL_stack_sp's
5602 location in the unthreaded perl binary) stored in CV * to figure out if this
5603 Perl_xs_handshake was called by the same pp_entersub */
5604 cv = (CV*)v_my_perl;
5605 xs_spp = (SV***)CvHSCXT(cv);
5607 need = &PL_stack_sp;
5609 if(UNLIKELY(got != need)) {
5610 bad_handshake:/* recycle branch and string from above */
5611 if(got != (void *)HSf_NOCHK)
5612 noperl_die("%s: loadable library and perl binaries are mismatched"
5613 " (got handshake key %p, needed %p)\n",
5617 if(key & HSf_SETXSUBFN) { /* this might be called from a module bootstrap */
5618 SAVEPPTR(PL_xsubfilename);/* which was require'd from a XSUB BEGIN */
5619 PL_xsubfilename = file; /* so the old name must be restored for
5620 additional XSUBs to register themselves */
5621 /* XSUBs can't be perl lang/perl5db.pl debugged
5622 if (PERLDB_LINE_OR_SAVESRC)
5623 (void)gv_fetchfile(file); */
5626 if(key & HSf_POPMARK) {
5628 { SV **mark = PL_stack_base + ax++;
5630 items = (I32)(SP - MARK);
5634 items = va_arg(args, U32);
5635 ax = va_arg(args, U32);
5639 assert(HS_GETAPIVERLEN(key) <= UCHAR_MAX);
5640 if((apiverlen = HS_GETAPIVERLEN(key))) {
5641 char * api_p = va_arg(args, char*);
5642 if(apiverlen != sizeof("v" PERL_API_VERSION_STRING)-1
5643 || memNE(api_p, "v" PERL_API_VERSION_STRING,
5644 sizeof("v" PERL_API_VERSION_STRING)-1))
5645 Perl_croak_nocontext("Perl API version %s of %"SVf" does not match %s",
5646 api_p, SVfARG(PL_stack_base[ax + 0]),
5647 "v" PERL_API_VERSION_STRING);
5652 assert(HS_GETXSVERLEN(key) <= UCHAR_MAX && HS_GETXSVERLEN(key) <= HS_APIVERLEN_MAX);
5653 if((xsverlen = HS_GETXSVERLEN(key)))
5654 S_xs_version_bootcheck(aTHX_
5655 items, ax, va_arg(args, char*), xsverlen);
5663 S_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5667 const char *vn = NULL;
5668 SV *const module = PL_stack_base[ax];
5670 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5672 if (items >= 2) /* version supplied as bootstrap arg */
5673 sv = PL_stack_base[ax + 1];
5675 /* XXX GV_ADDWARN */
5677 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5678 if (!sv || !SvOK(sv)) {
5680 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", SVfARG(module), vn), 0);
5684 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5685 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5686 ? sv : sv_2mortal(new_version(sv));
5687 xssv = upg_version(xssv, 0);
5688 if ( vcmp(pmsv,xssv) ) {
5689 SV *string = vstringify(xssv);
5690 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5691 " does not match ", SVfARG(module), SVfARG(string));
5693 SvREFCNT_dec(string);
5694 string = vstringify(pmsv);
5697 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, SVfARG(module), vn,
5700 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, SVfARG(string));
5702 SvREFCNT_dec(string);
5704 Perl_sv_2mortal(aTHX_ xpt);
5705 Perl_croak_sv(aTHX_ xpt);
5711 =for apidoc my_strlcat
5713 The C library C<strlcat> if available, or a Perl implementation of it.
5714 This operates on C C<NUL>-terminated strings.
5716 C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
5717 most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
5718 unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
5719 practice this should not happen as it means that either C<size> is incorrect or
5720 that C<dst> is not a proper C<NUL>-terminated string).
5722 Note that C<size> is the full size of the destination buffer and
5723 the result is guaranteed to be C<NUL>-terminated if there is room. Note that
5724 room for the C<NUL> should be included in C<size>.
5726 The return value is the total length that C<dst> would have if C<size> is
5727 sufficiently large. Thus it is the initial length of C<dst> plus the length of
5728 C<src>. If C<size> is smaller than the return, the excess was not appended.
5732 Description stolen from http://man.openbsd.org/strlcat.3
5736 Perl_my_strlcat(char *dst, const char *src, Size_t size)
5738 Size_t used, length, copy;
5741 length = strlen(src);
5742 if (size > 0 && used < size - 1) {
5743 copy = (length >= size - used) ? size - used - 1 : length;
5744 memcpy(dst + used, src, copy);
5745 dst[used + copy] = '\0';
5747 return used + length;
5753 =for apidoc my_strlcpy
5755 The C library C<strlcpy> if available, or a Perl implementation of it.
5756 This operates on C C<NUL>-terminated strings.
5758 C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
5759 to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
5761 The return value is the total length C<src> would be if the copy completely
5762 succeeded. If it is larger than C<size>, the excess was not copied.
5766 Description stolen from http://man.openbsd.org/strlcpy.3
5770 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
5772 Size_t length, copy;
5774 length = strlen(src);
5776 copy = (length >= size) ? size - 1 : length;
5777 memcpy(dst, src, copy);
5784 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
5785 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
5786 long _ftol( double ); /* Defined by VC6 C libs. */
5787 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
5790 PERL_STATIC_INLINE bool
5791 S_gv_has_usable_name(pTHX_ GV *gv)
5795 && HvENAME(GvSTASH(gv))
5796 && (gvp = (GV **)hv_fetchhek(
5797 GvSTASH(gv), GvNAME_HEK(gv), 0
5803 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
5805 SV * const dbsv = GvSVn(PL_DBsub);
5806 const bool save_taint = TAINT_get;
5808 /* When we are called from pp_goto (svp is null),
5809 * we do not care about using dbsv to call CV;
5810 * it's for informational purposes only.
5813 PERL_ARGS_ASSERT_GET_DB_SUB;
5817 if (!PERLDB_SUB_NN) {
5820 if (!svp && !CvLEXICAL(cv)) {
5821 gv_efullname3(dbsv, gv, NULL);
5823 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED)) || CvLEXICAL(cv)
5824 || strEQ(GvNAME(gv), "END")
5825 || ( /* Could be imported, and old sub redefined. */
5826 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
5828 !( (SvTYPE(*svp) == SVt_PVGV)
5829 && (GvCV((const GV *)*svp) == cv)
5830 /* Use GV from the stack as a fallback. */
5831 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
5835 /* GV is potentially non-unique, or contain different CV. */
5836 SV * const tmp = newRV(MUTABLE_SV(cv));
5837 sv_setsv(dbsv, tmp);
5841 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
5842 sv_catpvs(dbsv, "::");
5843 sv_cathek(dbsv, GvNAME_HEK(gv));
5847 const int type = SvTYPE(dbsv);
5848 if (type < SVt_PVIV && type != SVt_IV)
5849 sv_upgrade(dbsv, SVt_PVIV);
5850 (void)SvIOK_on(dbsv);
5851 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
5854 TAINT_IF(save_taint);
5855 #ifdef NO_TAINT_SUPPORT
5856 PERL_UNUSED_VAR(save_taint);
5861 Perl_my_dirfd(DIR * dir) {
5863 /* Most dirfd implementations have problems when passed NULL. */
5868 #elif defined(HAS_DIR_DD_FD)
5871 Perl_croak_nocontext(PL_no_func, "dirfd");
5872 NOT_REACHED; /* NOTREACHED */
5878 Perl_get_re_arg(pTHX_ SV *sv) {
5884 sv = MUTABLE_SV(SvRV(sv));
5885 if (SvTYPE(sv) == SVt_REGEXP)
5886 return (REGEXP*) sv;
5893 * This code is derived from drand48() implementation from FreeBSD,
5894 * found in lib/libc/gen/_rand48.c.
5896 * The U64 implementation is original, based on the POSIX
5897 * specification for drand48().
5901 * Copyright (c) 1993 Martin Birgmeier
5902 * All rights reserved.
5904 * You may redistribute unmodified or modified versions of this source
5905 * code provided that the above copyright notice and this and the
5906 * following conditions are retained.
5908 * This software is provided ``as is'', and comes with no warranties
5909 * of any kind. I shall in no event be liable for anything that happens
5910 * to anyone/anything when using this software.
5913 #define FREEBSD_DRAND48_SEED_0 (0x330e)
5915 #ifdef PERL_DRAND48_QUAD
5917 #define DRAND48_MULT U64_CONST(0x5deece66d)
5918 #define DRAND48_ADD 0xb
5919 #define DRAND48_MASK U64_CONST(0xffffffffffff)
5923 #define FREEBSD_DRAND48_SEED_1 (0xabcd)
5924 #define FREEBSD_DRAND48_SEED_2 (0x1234)
5925 #define FREEBSD_DRAND48_MULT_0 (0xe66d)
5926 #define FREEBSD_DRAND48_MULT_1 (0xdeec)
5927 #define FREEBSD_DRAND48_MULT_2 (0x0005)
5928 #define FREEBSD_DRAND48_ADD (0x000b)
5930 const unsigned short _rand48_mult[3] = {
5931 FREEBSD_DRAND48_MULT_0,
5932 FREEBSD_DRAND48_MULT_1,
5933 FREEBSD_DRAND48_MULT_2
5935 const unsigned short _rand48_add = FREEBSD_DRAND48_ADD;
5940 Perl_drand48_init_r(perl_drand48_t *random_state, U32 seed)
5942 PERL_ARGS_ASSERT_DRAND48_INIT_R;
5944 #ifdef PERL_DRAND48_QUAD
5945 *random_state = FREEBSD_DRAND48_SEED_0 + ((U64)seed << 16);
5947 random_state->seed[0] = FREEBSD_DRAND48_SEED_0;
5948 random_state->seed[1] = (U16) seed;
5949 random_state->seed[2] = (U16) (seed >> 16);
5954 Perl_drand48_r(perl_drand48_t *random_state)
5956 PERL_ARGS_ASSERT_DRAND48_R;
5958 #ifdef PERL_DRAND48_QUAD
5959 *random_state = (*random_state * DRAND48_MULT + DRAND48_ADD)
5962 return ldexp((double)*random_state, -48);
5968 accu = (U32) _rand48_mult[0] * (U32) random_state->seed[0]
5969 + (U32) _rand48_add;
5970 temp[0] = (U16) accu; /* lower 16 bits */
5971 accu >>= sizeof(U16) * 8;
5972 accu += (U32) _rand48_mult[0] * (U32) random_state->seed[1]
5973 + (U32) _rand48_mult[1] * (U32) random_state->seed[0];
5974 temp[1] = (U16) accu; /* middle 16 bits */
5975 accu >>= sizeof(U16) * 8;
5976 accu += _rand48_mult[0] * random_state->seed[2]
5977 + _rand48_mult[1] * random_state->seed[1]
5978 + _rand48_mult[2] * random_state->seed[0];
5979 random_state->seed[0] = temp[0];
5980 random_state->seed[1] = temp[1];
5981 random_state->seed[2] = (U16) accu;
5983 return ldexp((double) random_state->seed[0], -48) +
5984 ldexp((double) random_state->seed[1], -32) +
5985 ldexp((double) random_state->seed[2], -16);
5990 #ifdef USE_C_BACKTRACE
5992 /* Possibly move all this USE_C_BACKTRACE code into a new file. */
5997 /* abfd is the BFD handle. */
5999 /* bfd_syms is the BFD symbol table. */
6001 /* bfd_text is handle to the the ".text" section of the object file. */
6003 /* Since opening the executable and scanning its symbols is quite
6004 * heavy operation, we remember the filename we used the last time,
6005 * and do the opening and scanning only if the filename changes.
6006 * This removes most (but not all) open+scan cycles. */
6007 const char* fname_prev;
6010 /* Given a dl_info, update the BFD context if necessary. */
6011 static void bfd_update(bfd_context* ctx, Dl_info* dl_info)
6013 /* BFD open and scan only if the filename changed. */
6014 if (ctx->fname_prev == NULL ||
6015 strNE(dl_info->dli_fname, ctx->fname_prev)) {
6017 bfd_close(ctx->abfd);
6019 ctx->abfd = bfd_openr(dl_info->dli_fname, 0);
6021 if (bfd_check_format(ctx->abfd, bfd_object)) {
6022 IV symbol_size = bfd_get_symtab_upper_bound(ctx->abfd);
6023 if (symbol_size > 0) {
6024 Safefree(ctx->bfd_syms);
6025 Newx(ctx->bfd_syms, symbol_size, asymbol*);
6027 bfd_get_section_by_name(ctx->abfd, ".text");
6035 ctx->fname_prev = dl_info->dli_fname;
6039 /* Given a raw frame, try to symbolize it and store
6040 * symbol information (source file, line number) away. */
6041 static void bfd_symbolize(bfd_context* ctx,
6044 STRLEN* symbol_name_size,
6046 STRLEN* source_name_size,
6047 STRLEN* source_line)
6049 *symbol_name = NULL;
6050 *symbol_name_size = 0;
6052 IV offset = PTR2IV(raw_frame) - PTR2IV(ctx->bfd_text->vma);
6054 bfd_canonicalize_symtab(ctx->abfd, ctx->bfd_syms) > 0) {
6057 unsigned int line = 0;
6058 if (bfd_find_nearest_line(ctx->abfd, ctx->bfd_text,
6059 ctx->bfd_syms, offset,
6060 &file, &func, &line) &&
6061 file && func && line > 0) {
6062 /* Size and copy the source file, use only
6063 * the basename of the source file.
6065 * NOTE: the basenames are fine for the
6066 * Perl source files, but may not always
6067 * be the best idea for XS files. */
6068 const char *p, *b = NULL;
6069 /* Look for the last slash. */
6070 for (p = file; *p; p++) {
6074 if (b == NULL || *b == 0) {
6077 *source_name_size = p - b + 1;
6078 Newx(*source_name, *source_name_size + 1, char);
6079 Copy(b, *source_name, *source_name_size + 1, char);
6081 *symbol_name_size = strlen(func);
6082 Newx(*symbol_name, *symbol_name_size + 1, char);
6083 Copy(func, *symbol_name, *symbol_name_size + 1, char);
6085 *source_line = line;
6091 #endif /* #ifdef USE_BFD */
6095 /* OS X has no public API for for 'symbolicating' (Apple official term)
6096 * stack addresses to {function_name, source_file, line_number}.
6097 * Good news: there is command line utility atos(1) which does that.
6098 * Bad news 1: it's a command line utility.
6099 * Bad news 2: one needs to have the Developer Tools installed.
6100 * Bad news 3: in newer releases it needs to be run as 'xcrun atos'.
6102 * To recap: we need to open a pipe for reading for a utility which
6103 * might not exist, or exists in different locations, and then parse
6104 * the output. And since this is all for a low-level API, we cannot
6105 * use high-level stuff. Thanks, Apple. */
6108 /* tool is set to the absolute pathname of the tool to use:
6111 /* format is set to a printf format string used for building
6112 * the external command to run. */
6114 /* unavail is set if e.g. xcrun cannot be found, or something
6115 * else happens that makes getting the backtrace dubious. Note,
6116 * however, that the context isn't persistent, the next call to
6117 * get_c_backtrace() will start from scratch. */
6119 /* fname is the current object file name. */
6121 /* object_base_addr is the base address of the shared object. */
6122 void* object_base_addr;
6125 /* Given |dl_info|, updates the context. If the context has been
6126 * marked unavailable, return immediately. If not but the tool has
6127 * not been set, set it to either "xcrun atos" or "atos" (also set the
6128 * format to use for creating commands for piping), or if neither is
6129 * unavailable (one needs the Developer Tools installed), mark the context
6130 * an unavailable. Finally, update the filename (object name),
6131 * and its base address. */
6133 static void atos_update(atos_context* ctx,
6138 if (ctx->tool == NULL) {
6139 const char* tools[] = {
6143 const char* formats[] = {
6144 "/usr/bin/xcrun atos -o '%s' -l %08x %08x 2>&1",
6145 "/usr/bin/atos -d -o '%s' -l %08x %08x 2>&1"
6149 for (i = 0; i < C_ARRAY_LENGTH(tools); i++) {
6150 if (stat(tools[i], &st) == 0 && S_ISREG(st.st_mode)) {
6151 ctx->tool = tools[i];
6152 ctx->format = formats[i];
6156 if (ctx->tool == NULL) {
6157 ctx->unavail = TRUE;
6161 if (ctx->fname == NULL ||
6162 strNE(dl_info->dli_fname, ctx->fname)) {
6163 ctx->fname = dl_info->dli_fname;
6164 ctx->object_base_addr = dl_info->dli_fbase;
6168 /* Given an output buffer end |p| and its |start|, matches
6169 * for the atos output, extracting the source code location
6170 * and returning non-NULL if possible, returning NULL otherwise. */
6171 static const char* atos_parse(const char* p,
6173 STRLEN* source_name_size,
6174 STRLEN* source_line) {
6175 /* atos() output is something like:
6176 * perl_parse (in miniperl) (perl.c:2314)\n\n".
6177 * We cannot use Perl regular expressions, because we need to
6178 * stay low-level. Therefore here we have a rolled-out version
6179 * of a state machine which matches _backwards_from_the_end_ and
6180 * if there's a success, returns the starts of the filename,
6181 * also setting the filename size and the source line number.
6182 * The matched regular expression is roughly "\(.*:\d+\)\s*$" */
6183 const char* source_number_start;
6184 const char* source_name_end;
6185 const char* source_line_end;
6186 const char* close_paren;
6189 /* Skip trailing whitespace. */
6190 while (p > start && isspace(*p)) p--;
6191 /* Now we should be at the close paren. */
6192 if (p == start || *p != ')')
6196 /* Now we should be in the line number. */
6197 if (p == start || !isdigit(*p))
6199 /* Skip over the digits. */
6200 while (p > start && isdigit(*p))
6202 /* Now we should be at the colon. */
6203 if (p == start || *p != ':')
6205 source_number_start = p + 1;
6206 source_name_end = p; /* Just beyond the end. */
6208 /* Look for the open paren. */
6209 while (p > start && *p != '(')
6214 *source_name_size = source_name_end - p;
6215 if (grok_atoUV(source_number_start, &uv, &source_line_end)
6216 && source_line_end == close_paren
6217 && uv <= PERL_INT_MAX
6219 *source_line = (STRLEN)uv;
6225 /* Given a raw frame, read a pipe from the symbolicator (that's the
6226 * technical term) atos, reads the result, and parses the source code
6227 * location. We must stay low-level, so we use snprintf(), pipe(),
6228 * and fread(), and then also parse the output ourselves. */
6229 static void atos_symbolize(atos_context* ctx,
6232 STRLEN* source_name_size,
6233 STRLEN* source_line)
6241 /* Simple security measure: if there's any funny business with
6242 * the object name (used as "-o '%s'" ), leave since at least
6243 * partially the user controls it. */
6244 for (p = ctx->fname; *p; p++) {
6245 if (*p == '\'' || iscntrl(*p)) {
6246 ctx->unavail = TRUE;
6250 cnt = snprintf(cmd, sizeof(cmd), ctx->format,
6251 ctx->fname, ctx->object_base_addr, raw_frame);
6252 if (cnt < sizeof(cmd)) {
6253 /* Undo nostdio.h #defines that disable stdio.
6254 * This is somewhat naughty, but is used elsewhere
6255 * in the core, and affects only OS X. */
6260 FILE* fp = popen(cmd, "r");
6261 /* At the moment we open a new pipe for each stack frame.
6262 * This is naturally somewhat slow, but hopefully generating
6263 * stack traces is never going to in a performance critical path.
6265 * We could play tricks with atos by batching the stack
6266 * addresses to be resolved: atos can either take multiple
6267 * addresses from the command line, or read addresses from
6268 * a file (though the mess of creating temporary files would
6269 * probably negate much of any possible speedup).
6271 * Normally there are only two objects present in the backtrace:
6272 * perl itself, and the libdyld.dylib. (Note that the object
6273 * filenames contain the full pathname, so perl may not always
6274 * be in the same place.) Whenever the object in the
6275 * backtrace changes, the base address also changes.
6277 * The problem with batching the addresses, though, would be
6278 * matching the results with the addresses: the parsing of
6279 * the results is already painful enough with a single address. */
6282 UV cnt = fread(out, 1, sizeof(out), fp);
6283 if (cnt < sizeof(out)) {
6284 const char* p = atos_parse(out + cnt - 1, out,
6289 *source_name_size, char);
6290 Copy(p, *source_name,
6291 *source_name_size, char);
6299 #endif /* #ifdef PERL_DARWIN */
6302 =for apidoc get_c_backtrace
6304 Collects the backtrace (aka "stacktrace") into a single linear
6305 malloced buffer, which the caller B<must> C<Perl_free_c_backtrace()>.
6307 Scans the frames back by S<C<depth + skip>>, then drops the C<skip> innermost,
6308 returning at most C<depth> frames.
6314 Perl_get_c_backtrace(pTHX_ int depth, int skip)
6316 /* Note that here we must stay as low-level as possible: Newx(),
6317 * Copy(), Safefree(); since we may be called from anywhere,
6318 * so we should avoid higher level constructs like SVs or AVs.
6320 * Since we are using safesysmalloc() via Newx(), don't try
6321 * getting backtrace() there, unless you like deep recursion. */
6323 /* Currently only implemented with backtrace() and dladdr(),
6324 * for other platforms NULL is returned. */
6326 #if defined(HAS_BACKTRACE) && defined(HAS_DLADDR)
6327 /* backtrace() is available via <execinfo.h> in glibc and in most
6328 * modern BSDs; dladdr() is available via <dlfcn.h>. */
6330 /* We try fetching this many frames total, but then discard
6331 * the |skip| first ones. For the remaining ones we will try
6332 * retrieving more information with dladdr(). */
6333 int try_depth = skip + depth;
6335 /* The addresses (program counters) returned by backtrace(). */
6338 /* Retrieved with dladdr() from the addresses returned by backtrace(). */
6341 /* Sizes _including_ the terminating \0 of the object name
6342 * and symbol name strings. */
6343 STRLEN* object_name_sizes;
6344 STRLEN* symbol_name_sizes;
6347 /* The symbol names comes either from dli_sname,
6348 * or if using BFD, they can come from BFD. */
6349 char** symbol_names;
6352 /* The source code location information. Dug out with e.g. BFD. */
6353 char** source_names;
6354 STRLEN* source_name_sizes;
6355 STRLEN* source_lines;
6357 Perl_c_backtrace* bt = NULL; /* This is what will be returned. */
6358 int got_depth; /* How many frames were returned from backtrace(). */
6359 UV frame_count = 0; /* How many frames we return. */
6360 UV total_bytes = 0; /* The size of the whole returned backtrace. */
6363 bfd_context bfd_ctx;
6366 atos_context atos_ctx;
6369 /* Here are probably possibilities for optimizing. We could for
6370 * example have a struct that contains most of these and then
6371 * allocate |try_depth| of them, saving a bunch of malloc calls.
6372 * Note, however, that |frames| could not be part of that struct
6373 * because backtrace() will want an array of just them. Also be
6374 * careful about the name strings. */
6375 Newx(raw_frames, try_depth, void*);
6376 Newx(dl_infos, try_depth, Dl_info);
6377 Newx(object_name_sizes, try_depth, STRLEN);
6378 Newx(symbol_name_sizes, try_depth, STRLEN);
6379 Newx(source_names, try_depth, char*);
6380 Newx(source_name_sizes, try_depth, STRLEN);
6381 Newx(source_lines, try_depth, STRLEN);
6383 Newx(symbol_names, try_depth, char*);
6386 /* Get the raw frames. */
6387 got_depth = (int)backtrace(raw_frames, try_depth);
6389 /* We use dladdr() instead of backtrace_symbols() because we want
6390 * the full details instead of opaque strings. This is useful for
6391 * two reasons: () the details are needed for further symbolic
6392 * digging, for example in OS X (2) by having the details we fully
6393 * control the output, which in turn is useful when more platforms
6394 * are added: we can keep out output "portable". */
6396 /* We want a single linear allocation, which can then be freed
6397 * with a single swoop. We will do the usual trick of first
6398 * walking over the structure and seeing how much we need to
6399 * allocate, then allocating, and then walking over the structure
6400 * the second time and populating it. */
6402 /* First we must compute the total size of the buffer. */
6403 total_bytes = sizeof(Perl_c_backtrace_header);
6404 if (got_depth > skip) {
6407 bfd_init(); /* Is this safe to call multiple times? */
6408 Zero(&bfd_ctx, 1, bfd_context);
6411 Zero(&atos_ctx, 1, atos_context);
6413 for (i = skip; i < try_depth; i++) {
6414 Dl_info* dl_info = &dl_infos[i];
6416 object_name_sizes[i] = 0;
6417 source_names[i] = NULL;
6418 source_name_sizes[i] = 0;
6419 source_lines[i] = 0;
6421 /* Yes, zero from dladdr() is failure. */
6422 if (dladdr(raw_frames[i], dl_info)) {
6423 total_bytes += sizeof(Perl_c_backtrace_frame);
6425 object_name_sizes[i] =
6426 dl_info->dli_fname ? strlen(dl_info->dli_fname) : 0;
6427 symbol_name_sizes[i] =
6428 dl_info->dli_sname ? strlen(dl_info->dli_sname) : 0;
6430 bfd_update(&bfd_ctx, dl_info);
6431 bfd_symbolize(&bfd_ctx, raw_frames[i],
6433 &symbol_name_sizes[i],
6435 &source_name_sizes[i],
6439 atos_update(&atos_ctx, dl_info);
6440 atos_symbolize(&atos_ctx,
6443 &source_name_sizes[i],
6447 /* Plus ones for the terminating \0. */
6448 total_bytes += object_name_sizes[i] + 1;
6449 total_bytes += symbol_name_sizes[i] + 1;
6450 total_bytes += source_name_sizes[i] + 1;
6458 Safefree(bfd_ctx.bfd_syms);
6462 /* Now we can allocate and populate the result buffer. */
6463 Newxc(bt, total_bytes, char, Perl_c_backtrace);
6464 Zero(bt, total_bytes, char);
6465 bt->header.frame_count = frame_count;
6466 bt->header.total_bytes = total_bytes;
6467 if (frame_count > 0) {
6468 Perl_c_backtrace_frame* frame = bt->frame_info;
6469 char* name_base = (char *)(frame + frame_count);
6470 char* name_curr = name_base; /* Outputting the name strings here. */
6472 for (i = skip; i < skip + frame_count; i++) {
6473 Dl_info* dl_info = &dl_infos[i];
6475 frame->addr = raw_frames[i];
6476 frame->object_base_addr = dl_info->dli_fbase;
6477 frame->symbol_addr = dl_info->dli_saddr;
6479 /* Copies a string, including the \0, and advances the name_curr.
6480 * Also copies the start and the size to the frame. */
6481 #define PERL_C_BACKTRACE_STRCPY(frame, doffset, src, dsize, size) \
6483 Copy(src, name_curr, size, char); \
6484 frame->doffset = name_curr - (char*)bt; \
6485 frame->dsize = size; \
6486 name_curr += size; \
6489 PERL_C_BACKTRACE_STRCPY(frame, object_name_offset,
6491 object_name_size, object_name_sizes[i]);
6494 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6496 symbol_name_size, symbol_name_sizes[i]);
6497 Safefree(symbol_names[i]);
6499 PERL_C_BACKTRACE_STRCPY(frame, symbol_name_offset,
6501 symbol_name_size, symbol_name_sizes[i]);
6504 PERL_C_BACKTRACE_STRCPY(frame, source_name_offset,
6506 source_name_size, source_name_sizes[i]);
6507 Safefree(source_names[i]);
6509 #undef PERL_C_BACKTRACE_STRCPY
6511 frame->source_line_number = source_lines[i];
6515 assert(total_bytes ==
6516 (UV)(sizeof(Perl_c_backtrace_header) +
6517 frame_count * sizeof(Perl_c_backtrace_frame) +
6518 name_curr - name_base));
6521 Safefree(symbol_names);
6523 bfd_close(bfd_ctx.abfd);
6526 Safefree(source_lines);
6527 Safefree(source_name_sizes);
6528 Safefree(source_names);
6529 Safefree(symbol_name_sizes);
6530 Safefree(object_name_sizes);
6531 /* Assuming the strings returned by dladdr() are pointers
6532 * to read-only static memory (the object file), so that
6533 * they do not need freeing (and cannot be). */
6535 Safefree(raw_frames);
6538 PERL_UNUSED_ARGV(depth);
6539 PERL_UNUSED_ARGV(skip);
6545 =for apidoc free_c_backtrace
6547 Deallocates a backtrace received from get_c_bracktrace.
6553 =for apidoc get_c_backtrace_dump
6555 Returns a SV containing a dump of C<depth> frames of the call stack, skipping
6556 the C<skip> innermost ones. C<depth> of 20 is usually enough.
6558 The appended output looks like:
6561 1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
6562 2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
6565 The fields are tab-separated. The first column is the depth (zero
6566 being the innermost non-skipped frame). In the hex:offset, the hex is
6567 where the program counter was in C<S_parse_body>, and the :offset (might
6568 be missing) tells how much inside the C<S_parse_body> the program counter was.
6570 The C<util.c:1716> is the source code file and line number.
6572 The F</usr/bin/perl> is obvious (hopefully).
6574 Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
6575 if the platform doesn't support retrieving the information;
6576 if the binary is missing the debug information;
6577 if the optimizer has transformed the code by for example inlining.
6583 Perl_get_c_backtrace_dump(pTHX_ int depth, int skip)
6585 Perl_c_backtrace* bt;
6587 bt = get_c_backtrace(depth, skip + 1 /* Hide ourselves. */);
6589 Perl_c_backtrace_frame* frame;
6590 SV* dsv = newSVpvs("");
6592 for (i = 0, frame = bt->frame_info;
6593 i < bt->header.frame_count; i++, frame++) {
6594 Perl_sv_catpvf(aTHX_ dsv, "%d", (int)i);
6595 Perl_sv_catpvf(aTHX_ dsv, "\t%p", frame->addr ? frame->addr : "-");
6596 /* Symbol (function) names might disappear without debug info.
6598 * The source code location might disappear in case of the
6599 * optimizer inlining or otherwise rearranging the code. */
6600 if (frame->symbol_addr) {
6601 Perl_sv_catpvf(aTHX_ dsv, ":%04x",
6603 ((char*)frame->addr - (char*)frame->symbol_addr));
6605 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6606 frame->symbol_name_size &&
6607 frame->symbol_name_offset ?
6608 (char*)bt + frame->symbol_name_offset : "-");
6609 if (frame->source_name_size &&
6610 frame->source_name_offset &&
6611 frame->source_line_number) {
6612 Perl_sv_catpvf(aTHX_ dsv, "\t%s:%"UVuf,
6613 (char*)bt + frame->source_name_offset,
6614 (UV)frame->source_line_number);
6616 Perl_sv_catpvf(aTHX_ dsv, "\t-");
6618 Perl_sv_catpvf(aTHX_ dsv, "\t%s",
6619 frame->object_name_size &&
6620 frame->object_name_offset ?
6621 (char*)bt + frame->object_name_offset : "-");
6622 /* The frame->object_base_addr is not output,
6623 * but it is used for symbolizing/symbolicating. */
6624 sv_catpvs(dsv, "\n");
6627 Perl_free_c_backtrace(aTHX_ bt);
6636 =for apidoc dump_c_backtrace
6638 Dumps the C backtrace to the given C<fp>.
6640 Returns true if a backtrace could be retrieved, false if not.
6646 Perl_dump_c_backtrace(pTHX_ PerlIO* fp, int depth, int skip)
6650 PERL_ARGS_ASSERT_DUMP_C_BACKTRACE;
6652 sv = Perl_get_c_backtrace_dump(aTHX_ depth, skip);
6655 PerlIO_printf(fp, "%s", SvPV_nolen(sv));
6661 #endif /* #ifdef USE_C_BACKTRACE */
6663 #ifdef PERL_TSA_ACTIVE
6665 /* pthread_mutex_t and perl_mutex are typedef equivalent
6666 * so casting the pointers is fine. */
6668 int perl_tsa_mutex_lock(perl_mutex* mutex)
6670 return pthread_mutex_lock((pthread_mutex_t *) mutex);
6673 int perl_tsa_mutex_unlock(perl_mutex* mutex)
6675 return pthread_mutex_unlock((pthread_mutex_t *) mutex);
6678 int perl_tsa_mutex_destroy(perl_mutex* mutex)
6680 return pthread_mutex_destroy((pthread_mutex_t *) mutex);
6688 /* log a sub call or return */
6691 Perl_dtrace_probe_call(pTHX_ CV *cv, bool is_call)
6699 PERL_ARGS_ASSERT_DTRACE_PROBE_CALL;
6702 HEK *hek = CvNAME_HEK(cv);
6703 func = HEK_KEY(hek);
6709 start = (const COP *)CvSTART(cv);
6710 file = CopFILE(start);
6711 line = CopLINE(start);
6712 stash = CopSTASHPV(start);
6715 PERL_SUB_ENTRY(func, file, line, stash);
6718 PERL_SUB_RETURN(func, file, line, stash);
6723 /* log a require file loading/loaded */
6726 Perl_dtrace_probe_load(pTHX_ const char *name, bool is_loading)
6728 PERL_ARGS_ASSERT_DTRACE_PROBE_LOAD;
6731 PERL_LOADING_FILE(name);
6734 PERL_LOADED_FILE(name);
6739 /* log an op execution */
6742 Perl_dtrace_probe_op(pTHX_ const OP *op)
6744 PERL_ARGS_ASSERT_DTRACE_PROBE_OP;
6746 PERL_OP_ENTRY(OP_NAME(op));
6750 /* log a compile/run phase change */
6753 Perl_dtrace_probe_phase(pTHX_ enum perl_phase phase)
6755 const char *ph_old = PL_phase_names[PL_phase];
6756 const char *ph_new = PL_phase_names[phase];
6758 PERL_PHASE_CHANGE(ph_new, ph_old);
6764 * ex: set ts=8 sts=4 sw=4 et: