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
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
41 /* Missing protos on LynxOS */
47 # include <sys/select.h>
53 #if defined(HAS_FCNTL) && defined(F_SETFD) && !defined(FD_CLOEXEC)
54 # define FD_CLOEXEC 1 /* NeXT needs this */
57 /* NOTE: Do not call the next three routines directly. Use the macros
58 * in handy.h, so that we can easily redefine everything to do tracking of
59 * allocated hunks back to the original New to track down any memory leaks.
60 * XXX This advice seems to be widely ignored :-( --AD August 1996.
63 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
64 # define ALWAYS_NEED_THX
67 /* paranoid version of system's malloc() */
70 Perl_safesysmalloc(MEM_SIZE size)
72 #ifdef ALWAYS_NEED_THX
78 PerlIO_printf(Perl_error_log,
79 "Allocation too large: %lx\n", size) FLUSH;
82 #endif /* HAS_64K_LIMIT */
83 #ifdef PERL_TRACK_MEMPOOL
87 if ((SSize_t)size < 0)
88 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
90 ptr = (Malloc_t)PerlMem_malloc(size?size:1); /* malloc(0) is NASTY on our system */
91 PERL_ALLOC_CHECK(ptr);
93 #ifdef PERL_TRACK_MEMPOOL
94 struct perl_memory_debug_header *const header
95 = (struct perl_memory_debug_header *)ptr;
99 PoisonNew(((char *)ptr), size, char);
102 #ifdef PERL_TRACK_MEMPOOL
103 header->interpreter = aTHX;
104 /* Link us into the list. */
105 header->prev = &PL_memory_debug_header;
106 header->next = PL_memory_debug_header.next;
107 PL_memory_debug_header.next = header;
108 header->next->prev = header;
112 ptr = (Malloc_t)((char*)ptr+sTHX);
114 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
118 #ifndef ALWAYS_NEED_THX
130 /* paranoid version of system's realloc() */
133 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
135 #ifdef ALWAYS_NEED_THX
139 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
140 Malloc_t PerlMem_realloc();
141 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
145 PerlIO_printf(Perl_error_log,
146 "Reallocation too large: %lx\n", size) FLUSH;
149 #endif /* HAS_64K_LIMIT */
156 return safesysmalloc(size);
157 #ifdef PERL_TRACK_MEMPOOL
158 where = (Malloc_t)((char*)where-sTHX);
161 struct perl_memory_debug_header *const header
162 = (struct perl_memory_debug_header *)where;
164 if (header->interpreter != aTHX) {
165 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
166 header->interpreter, aTHX);
168 assert(header->next->prev == header);
169 assert(header->prev->next == header);
171 if (header->size > size) {
172 const MEM_SIZE freed_up = header->size - size;
173 char *start_of_freed = ((char *)where) + size;
174 PoisonFree(start_of_freed, freed_up, char);
181 if ((SSize_t)size < 0)
182 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
184 ptr = (Malloc_t)PerlMem_realloc(where,size);
185 PERL_ALLOC_CHECK(ptr);
187 /* MUST do this fixup first, before doing ANYTHING else, as anything else
188 might allocate memory/free/move memory, and until we do the fixup, it
189 may well be chasing (and writing to) free memory. */
190 #ifdef PERL_TRACK_MEMPOOL
192 struct perl_memory_debug_header *const header
193 = (struct perl_memory_debug_header *)ptr;
196 if (header->size < size) {
197 const MEM_SIZE fresh = size - header->size;
198 char *start_of_fresh = ((char *)ptr) + size;
199 PoisonNew(start_of_fresh, fresh, char);
203 header->next->prev = header;
204 header->prev->next = header;
206 ptr = (Malloc_t)((char*)ptr+sTHX);
210 /* In particular, must do that fixup above before logging anything via
211 *printf(), as it can reallocate memory, which can cause SEGVs. */
213 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
214 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
221 #ifndef ALWAYS_NEED_THX
233 /* safe version of system's free() */
236 Perl_safesysfree(Malloc_t where)
238 #ifdef ALWAYS_NEED_THX
243 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
245 #ifdef PERL_TRACK_MEMPOOL
246 where = (Malloc_t)((char*)where-sTHX);
248 struct perl_memory_debug_header *const header
249 = (struct perl_memory_debug_header *)where;
251 if (header->interpreter != aTHX) {
252 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
253 header->interpreter, aTHX);
256 Perl_croak_nocontext("panic: duplicate free");
259 Perl_croak_nocontext("panic: bad free, header->next==NULL");
260 if (header->next->prev != header || header->prev->next != header) {
261 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
262 "header=%p, ->prev->next=%p",
263 header->next->prev, header,
266 /* Unlink us from the chain. */
267 header->next->prev = header->prev;
268 header->prev->next = header->next;
270 PoisonNew(where, header->size, char);
272 /* Trigger the duplicate free warning. */
280 /* safe version of system's calloc() */
283 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
285 #ifdef ALWAYS_NEED_THX
289 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
290 MEM_SIZE total_size = 0;
293 /* Even though calloc() for zero bytes is strange, be robust. */
294 if (size && (count <= MEM_SIZE_MAX / size)) {
295 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
296 total_size = size * count;
301 #ifdef PERL_TRACK_MEMPOOL
302 if (sTHX <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
308 if (total_size > 0xffff) {
309 PerlIO_printf(Perl_error_log,
310 "Allocation too large: %lx\n", total_size) FLUSH;
313 #endif /* HAS_64K_LIMIT */
315 if ((SSize_t)size < 0 || (SSize_t)count < 0)
316 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
317 (UV)size, (UV)count);
319 #ifdef PERL_TRACK_MEMPOOL
320 /* Have to use malloc() because we've added some space for our tracking
322 /* malloc(0) is non-portable. */
323 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
325 /* Use calloc() because it might save a memset() if the memory is fresh
326 and clean from the OS. */
328 ptr = (Malloc_t)PerlMem_calloc(count, size);
329 else /* calloc(0) is non-portable. */
330 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
332 PERL_ALLOC_CHECK(ptr);
333 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));
335 #ifdef PERL_TRACK_MEMPOOL
337 struct perl_memory_debug_header *const header
338 = (struct perl_memory_debug_header *)ptr;
340 memset((void*)ptr, 0, total_size);
341 header->interpreter = aTHX;
342 /* Link us into the list. */
343 header->prev = &PL_memory_debug_header;
344 header->next = PL_memory_debug_header.next;
345 PL_memory_debug_header.next = header;
346 header->next->prev = header;
348 header->size = total_size;
350 ptr = (Malloc_t)((char*)ptr+sTHX);
356 #ifndef ALWAYS_NEED_THX
365 /* These must be defined when not using Perl's malloc for binary
370 Malloc_t Perl_malloc (MEM_SIZE nbytes)
373 return (Malloc_t)PerlMem_malloc(nbytes);
376 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
379 return (Malloc_t)PerlMem_calloc(elements, size);
382 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
385 return (Malloc_t)PerlMem_realloc(where, nbytes);
388 Free_t Perl_mfree (Malloc_t where)
396 /* copy a string up to some (non-backslashed) delimiter, if any */
399 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
403 PERL_ARGS_ASSERT_DELIMCPY;
405 for (tolen = 0; from < fromend; from++, tolen++) {
407 if (from[1] != delim) {
414 else if (*from == delim)
425 /* return ptr to little string in big string, NULL if not found */
426 /* This routine was donated by Corey Satten. */
429 Perl_instr(const char *big, const char *little)
433 PERL_ARGS_ASSERT_INSTR;
444 for (x=big,s=little; *s; /**/ ) {
455 return (char*)(big-1);
460 /* same as instr but allow embedded nulls. The end pointers point to 1 beyond
461 * the final character desired to be checked */
464 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
466 PERL_ARGS_ASSERT_NINSTR;
470 const char first = *little;
472 bigend -= lend - little++;
474 while (big <= bigend) {
475 if (*big++ == first) {
476 for (x=big,s=little; s < lend; x++,s++) {
480 return (char*)(big-1);
487 /* reverse of the above--find last substring */
490 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
493 const I32 first = *little;
494 const char * const littleend = lend;
496 PERL_ARGS_ASSERT_RNINSTR;
498 if (little >= littleend)
499 return (char*)bigend;
501 big = bigend - (littleend - little++);
502 while (big >= bigbeg) {
506 for (x=big+2,s=little; s < littleend; /**/ ) {
515 return (char*)(big+1);
520 /* As a space optimization, we do not compile tables for strings of length
521 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
522 special-cased in fbm_instr().
524 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
527 =head1 Miscellaneous Functions
529 =for apidoc fbm_compile
531 Analyses the string in order to make fast searches on it using fbm_instr()
532 -- the Boyer-Moore algorithm.
538 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
548 PERL_ARGS_ASSERT_FBM_COMPILE;
550 if (isGV_with_GP(sv))
556 if (flags & FBMcf_TAIL) {
557 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
558 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
559 if (mg && mg->mg_len >= 0)
562 s = (U8*)SvPV_force_mutable(sv, len);
563 if (len == 0) /* TAIL might be on a zero-length string. */
565 SvUPGRADE(sv, SVt_PVMG);
570 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
571 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
572 to call SvVALID_off() if the scalar was assigned to.
574 The comment itself (and "deeper magic" below) date back to
575 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
577 where the magic (presumably) was that the scalar had a BM table hidden
580 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
581 the table instead of the previous (somewhat hacky) approach of co-opting
582 the string buffer and storing it after the string. */
584 assert(!mg_find(sv, PERL_MAGIC_bm));
585 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
589 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
591 const U8 mlen = (len>255) ? 255 : (U8)len;
592 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
595 Newx(table, 256, U8);
596 memset((void*)table, mlen, 256);
597 mg->mg_ptr = (char *)table;
600 s += len - 1; /* last char */
603 if (table[*s] == mlen)
609 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
610 for (i = 0; i < len; i++) {
611 if (PL_freq[s[i]] < frequency) {
613 frequency = PL_freq[s[i]];
616 BmRARE(sv) = s[rarest];
617 BmPREVIOUS(sv) = rarest;
618 BmUSEFUL(sv) = 100; /* Initial value */
619 if (flags & FBMcf_TAIL)
621 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
622 BmRARE(sv), BmPREVIOUS(sv)));
625 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
626 /* If SvTAIL is actually due to \Z or \z, this gives false positives
630 =for apidoc fbm_instr
632 Returns the location of the SV in the string delimited by C<big> and
633 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
634 does not have to be fbm_compiled, but the search will not be as fast
641 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
645 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
646 STRLEN littlelen = l;
647 const I32 multiline = flags & FBMrf_MULTILINE;
649 PERL_ARGS_ASSERT_FBM_INSTR;
651 if ((STRLEN)(bigend - big) < littlelen) {
652 if ( SvTAIL(littlestr)
653 && ((STRLEN)(bigend - big) == littlelen - 1)
655 || (*big == *little &&
656 memEQ((char *)big, (char *)little, littlelen - 1))))
661 switch (littlelen) { /* Special cases for 0, 1 and 2 */
663 return (char*)big; /* Cannot be SvTAIL! */
665 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
666 /* Know that bigend != big. */
667 if (bigend[-1] == '\n')
668 return (char *)(bigend - 1);
669 return (char *) bigend;
677 if (SvTAIL(littlestr))
678 return (char *) bigend;
681 if (SvTAIL(littlestr) && !multiline) {
682 if (bigend[-1] == '\n' && bigend[-2] == *little)
683 return (char*)bigend - 2;
684 if (bigend[-1] == *little)
685 return (char*)bigend - 1;
689 /* This should be better than FBM if c1 == c2, and almost
690 as good otherwise: maybe better since we do less indirection.
691 And we save a lot of memory by caching no table. */
692 const unsigned char c1 = little[0];
693 const unsigned char c2 = little[1];
698 while (s <= bigend) {
708 goto check_1char_anchor;
719 goto check_1char_anchor;
722 while (s <= bigend) {
727 goto check_1char_anchor;
736 check_1char_anchor: /* One char and anchor! */
737 if (SvTAIL(littlestr) && (*bigend == *little))
738 return (char *)bigend; /* bigend is already decremented. */
741 break; /* Only lengths 0 1 and 2 have special-case code. */
744 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
745 s = bigend - littlelen;
746 if (s >= big && bigend[-1] == '\n' && *s == *little
747 /* Automatically of length > 2 */
748 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
750 return (char*)s; /* how sweet it is */
753 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
755 return (char*)s + 1; /* how sweet it is */
759 if (!SvVALID(littlestr)) {
760 char * const b = ninstr((char*)big,(char*)bigend,
761 (char*)little, (char*)little + littlelen);
763 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
764 /* Chop \n from littlestr: */
765 s = bigend - littlelen + 1;
767 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
777 if (littlelen > (STRLEN)(bigend - big))
781 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
782 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
783 const unsigned char *oldlittle;
785 --littlelen; /* Last char found by table lookup */
788 little += littlelen; /* last char */
794 if ((tmp = table[*s])) {
795 if ((s += tmp) < bigend)
799 else { /* less expensive than calling strncmp() */
800 unsigned char * const olds = s;
805 if (*--s == *--little)
807 s = olds + 1; /* here we pay the price for failure */
809 if (s < bigend) /* fake up continue to outer loop */
819 && memEQ((char *)(bigend - littlelen),
820 (char *)(oldlittle - littlelen), littlelen) )
821 return (char*)bigend - littlelen;
827 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
830 PERL_ARGS_ASSERT_SCREAMINSTR;
831 PERL_UNUSED_ARG(bigstr);
832 PERL_UNUSED_ARG(littlestr);
833 PERL_UNUSED_ARG(start_shift);
834 PERL_UNUSED_ARG(end_shift);
835 PERL_UNUSED_ARG(old_posp);
836 PERL_UNUSED_ARG(last);
838 /* This function must only ever be called on a scalar with study magic,
839 but those do not happen any more. */
840 Perl_croak(aTHX_ "panic: screaminstr");
847 Returns true if the leading len bytes of the strings s1 and s2 are the same
848 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
849 match themselves and their opposite case counterparts. Non-cased and non-ASCII
850 range bytes match only themselves.
857 Perl_foldEQ(const char *s1, const char *s2, I32 len)
859 const U8 *a = (const U8 *)s1;
860 const U8 *b = (const U8 *)s2;
862 PERL_ARGS_ASSERT_FOLDEQ;
867 if (*a != *b && *a != PL_fold[*b])
874 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
876 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
877 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
878 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
879 * does it check that the strings each have at least 'len' characters */
881 const U8 *a = (const U8 *)s1;
882 const U8 *b = (const U8 *)s2;
884 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
889 if (*a != *b && *a != PL_fold_latin1[*b]) {
898 =for apidoc foldEQ_locale
900 Returns true if the leading len bytes of the strings s1 and s2 are the same
901 case-insensitively in the current locale; false otherwise.
907 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
910 const U8 *a = (const U8 *)s1;
911 const U8 *b = (const U8 *)s2;
913 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
918 if (*a != *b && *a != PL_fold_locale[*b])
925 /* copy a string to a safe spot */
928 =head1 Memory Management
932 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
933 string which is a duplicate of C<pv>. The size of the string is
934 determined by C<strlen()>. The memory allocated for the new string can
935 be freed with the C<Safefree()> function.
941 Perl_savepv(pTHX_ const char *pv)
948 const STRLEN pvlen = strlen(pv)+1;
949 Newx(newaddr, pvlen, char);
950 return (char*)memcpy(newaddr, pv, pvlen);
954 /* same thing but with a known length */
959 Perl's version of what C<strndup()> would be if it existed. Returns a
960 pointer to a newly allocated string which is a duplicate of the first
961 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
962 the new string can be freed with the C<Safefree()> function.
968 Perl_savepvn(pTHX_ const char *pv, I32 len)
975 Newx(newaddr,len+1,char);
976 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
978 /* might not be null terminated */
980 return (char *) CopyD(pv,newaddr,len,char);
983 return (char *) ZeroD(newaddr,len+1,char);
988 =for apidoc savesharedpv
990 A version of C<savepv()> which allocates the duplicate string in memory
991 which is shared between threads.
996 Perl_savesharedpv(pTHX_ const char *pv)
1003 pvlen = strlen(pv)+1;
1004 newaddr = (char*)PerlMemShared_malloc(pvlen);
1008 return (char*)memcpy(newaddr, pv, pvlen);
1012 =for apidoc savesharedpvn
1014 A version of C<savepvn()> which allocates the duplicate string in memory
1015 which is shared between threads. (With the specific difference that a NULL
1016 pointer is not acceptable)
1021 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1023 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1025 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1030 newaddr[len] = '\0';
1031 return (char*)memcpy(newaddr, pv, len);
1035 =for apidoc savesvpv
1037 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1038 the passed in SV using C<SvPV()>
1044 Perl_savesvpv(pTHX_ SV *sv)
1047 const char * const pv = SvPV_const(sv, len);
1050 PERL_ARGS_ASSERT_SAVESVPV;
1053 Newx(newaddr,len,char);
1054 return (char *) CopyD(pv,newaddr,len,char);
1058 =for apidoc savesharedsvpv
1060 A version of C<savesharedpv()> which allocates the duplicate string in
1061 memory which is shared between threads.
1067 Perl_savesharedsvpv(pTHX_ SV *sv)
1070 const char * const pv = SvPV_const(sv, len);
1072 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1074 return savesharedpvn(pv, len);
1077 /* the SV for Perl_form() and mess() is not kept in an arena */
1086 if (PL_phase != PERL_PHASE_DESTRUCT)
1087 return newSVpvs_flags("", SVs_TEMP);
1092 /* Create as PVMG now, to avoid any upgrading later */
1094 Newxz(any, 1, XPVMG);
1095 SvFLAGS(sv) = SVt_PVMG;
1096 SvANY(sv) = (void*)any;
1098 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1103 #if defined(PERL_IMPLICIT_CONTEXT)
1105 Perl_form_nocontext(const char* pat, ...)
1110 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1111 va_start(args, pat);
1112 retval = vform(pat, &args);
1116 #endif /* PERL_IMPLICIT_CONTEXT */
1119 =head1 Miscellaneous Functions
1122 Takes a sprintf-style format pattern and conventional
1123 (non-SV) arguments and returns the formatted string.
1125 (char *) Perl_form(pTHX_ const char* pat, ...)
1127 can be used any place a string (char *) is required:
1129 char * s = Perl_form("%d.%d",major,minor);
1131 Uses a single private buffer so if you want to format several strings you
1132 must explicitly copy the earlier strings away (and free the copies when you
1139 Perl_form(pTHX_ const char* pat, ...)
1143 PERL_ARGS_ASSERT_FORM;
1144 va_start(args, pat);
1145 retval = vform(pat, &args);
1151 Perl_vform(pTHX_ const char *pat, va_list *args)
1153 SV * const sv = mess_alloc();
1154 PERL_ARGS_ASSERT_VFORM;
1155 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1160 =for apidoc Am|SV *|mess|const char *pat|...
1162 Take a sprintf-style format pattern and argument list. These are used to
1163 generate a string message. If the message does not end with a newline,
1164 then it will be extended with some indication of the current location
1165 in the code, as described for L</mess_sv>.
1167 Normally, the resulting message is returned in a new mortal SV.
1168 During global destruction a single SV may be shared between uses of
1174 #if defined(PERL_IMPLICIT_CONTEXT)
1176 Perl_mess_nocontext(const char *pat, ...)
1181 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1182 va_start(args, pat);
1183 retval = vmess(pat, &args);
1187 #endif /* PERL_IMPLICIT_CONTEXT */
1190 Perl_mess(pTHX_ const char *pat, ...)
1194 PERL_ARGS_ASSERT_MESS;
1195 va_start(args, pat);
1196 retval = vmess(pat, &args);
1202 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1205 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1207 PERL_ARGS_ASSERT_CLOSEST_COP;
1209 if (!o || o == PL_op)
1212 if (o->op_flags & OPf_KIDS) {
1214 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1217 /* If the OP_NEXTSTATE has been optimised away we can still use it
1218 * the get the file and line number. */
1220 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1221 cop = (const COP *)kid;
1223 /* Keep searching, and return when we've found something. */
1225 new_cop = closest_cop(cop, kid);
1231 /* Nothing found. */
1237 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1239 Expands a message, intended for the user, to include an indication of
1240 the current location in the code, if the message does not already appear
1243 C<basemsg> is the initial message or object. If it is a reference, it
1244 will be used as-is and will be the result of this function. Otherwise it
1245 is used as a string, and if it already ends with a newline, it is taken
1246 to be complete, and the result of this function will be the same string.
1247 If the message does not end with a newline, then a segment such as C<at
1248 foo.pl line 37> will be appended, and possibly other clauses indicating
1249 the current state of execution. The resulting message will end with a
1252 Normally, the resulting message is returned in a new mortal SV.
1253 During global destruction a single SV may be shared between uses of this
1254 function. If C<consume> is true, then the function is permitted (but not
1255 required) to modify and return C<basemsg> instead of allocating a new SV.
1261 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1266 PERL_ARGS_ASSERT_MESS_SV;
1268 if (SvROK(basemsg)) {
1274 sv_setsv(sv, basemsg);
1279 if (SvPOK(basemsg) && consume) {
1284 sv_copypv(sv, basemsg);
1287 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1289 * Try and find the file and line for PL_op. This will usually be
1290 * PL_curcop, but it might be a cop that has been optimised away. We
1291 * can try to find such a cop by searching through the optree starting
1292 * from the sibling of PL_curcop.
1295 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1300 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1301 OutCopFILE(cop), (IV)CopLINE(cop));
1302 /* Seems that GvIO() can be untrustworthy during global destruction. */
1303 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1304 && IoLINES(GvIOp(PL_last_in_gv)))
1307 const bool line_mode = (RsSIMPLE(PL_rs) &&
1308 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1309 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1310 SVfARG(PL_last_in_gv == PL_argvgv
1312 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1313 line_mode ? "line" : "chunk",
1314 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1316 if (PL_phase == PERL_PHASE_DESTRUCT)
1317 sv_catpvs(sv, " during global destruction");
1318 sv_catpvs(sv, ".\n");
1324 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1326 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1327 argument list. These are used to generate a string message. If the
1328 message does not end with a newline, then it will be extended with
1329 some indication of the current location in the code, as described for
1332 Normally, the resulting message is returned in a new mortal SV.
1333 During global destruction a single SV may be shared between uses of
1340 Perl_vmess(pTHX_ const char *pat, va_list *args)
1343 SV * const sv = mess_alloc();
1345 PERL_ARGS_ASSERT_VMESS;
1347 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1348 return mess_sv(sv, 1);
1352 Perl_write_to_stderr(pTHX_ SV* msv)
1358 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1360 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1361 && (io = GvIO(PL_stderrgv))
1362 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1363 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, "PRINT",
1364 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1367 /* SFIO can really mess with your errno */
1370 PerlIO * const serr = Perl_error_log;
1372 do_print(msv, serr);
1373 (void)PerlIO_flush(serr);
1381 =head1 Warning and Dieing
1384 /* Common code used in dieing and warning */
1387 S_with_queued_errors(pTHX_ SV *ex)
1389 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1390 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1391 sv_catsv(PL_errors, ex);
1392 ex = sv_mortalcopy(PL_errors);
1393 SvCUR_set(PL_errors, 0);
1399 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1405 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1406 /* sv_2cv might call Perl_croak() or Perl_warner() */
1407 SV * const oldhook = *hook;
1415 cv = sv_2cv(oldhook, &stash, &gv, 0);
1417 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1427 exarg = newSVsv(ex);
1428 SvREADONLY_on(exarg);
1431 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1435 call_sv(MUTABLE_SV(cv), G_DISCARD);
1444 =for apidoc Am|OP *|die_sv|SV *baseex
1446 Behaves the same as L</croak_sv>, except for the return type.
1447 It should be used only where the C<OP *> return type is required.
1448 The function never actually returns.
1454 Perl_die_sv(pTHX_ SV *baseex)
1456 PERL_ARGS_ASSERT_DIE_SV;
1458 assert(0); /* NOTREACHED */
1463 =for apidoc Am|OP *|die|const char *pat|...
1465 Behaves the same as L</croak>, except for the return type.
1466 It should be used only where the C<OP *> return type is required.
1467 The function never actually returns.
1472 #if defined(PERL_IMPLICIT_CONTEXT)
1474 Perl_die_nocontext(const char* pat, ...)
1478 va_start(args, pat);
1480 assert(0); /* NOTREACHED */
1484 #endif /* PERL_IMPLICIT_CONTEXT */
1487 Perl_die(pTHX_ const char* pat, ...)
1490 va_start(args, pat);
1492 assert(0); /* NOTREACHED */
1498 =for apidoc Am|void|croak_sv|SV *baseex
1500 This is an XS interface to Perl's C<die> function.
1502 C<baseex> is the error message or object. If it is a reference, it
1503 will be used as-is. Otherwise it is used as a string, and if it does
1504 not end with a newline then it will be extended with some indication of
1505 the current location in the code, as described for L</mess_sv>.
1507 The error message or object will be used as an exception, by default
1508 returning control to the nearest enclosing C<eval>, but subject to
1509 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1510 function never returns normally.
1512 To die with a simple string message, the L</croak> function may be
1519 Perl_croak_sv(pTHX_ SV *baseex)
1521 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1522 PERL_ARGS_ASSERT_CROAK_SV;
1523 invoke_exception_hook(ex, FALSE);
1528 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1530 This is an XS interface to Perl's C<die> function.
1532 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1533 argument list. These are used to generate a string message. If the
1534 message does not end with a newline, then it will be extended with
1535 some indication of the current location in the code, as described for
1538 The error message will be used as an exception, by default
1539 returning control to the nearest enclosing C<eval>, but subject to
1540 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1541 function never returns normally.
1543 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1544 (C<$@>) will be used as an error message or object instead of building an
1545 error message from arguments. If you want to throw a non-string object,
1546 or build an error message in an SV yourself, it is preferable to use
1547 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1553 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1555 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1556 invoke_exception_hook(ex, FALSE);
1561 =for apidoc Am|void|croak|const char *pat|...
1563 This is an XS interface to Perl's C<die> function.
1565 Take a sprintf-style format pattern and argument list. These are used to
1566 generate a string message. If the message does not end with a newline,
1567 then it will be extended with some indication of the current location
1568 in the code, as described for L</mess_sv>.
1570 The error message will be used as an exception, by default
1571 returning control to the nearest enclosing C<eval>, but subject to
1572 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1573 function never returns normally.
1575 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1576 (C<$@>) will be used as an error message or object instead of building an
1577 error message from arguments. If you want to throw a non-string object,
1578 or build an error message in an SV yourself, it is preferable to use
1579 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1584 #if defined(PERL_IMPLICIT_CONTEXT)
1586 Perl_croak_nocontext(const char *pat, ...)
1590 va_start(args, pat);
1592 assert(0); /* NOTREACHED */
1595 #endif /* PERL_IMPLICIT_CONTEXT */
1598 Perl_croak(pTHX_ const char *pat, ...)
1601 va_start(args, pat);
1603 assert(0); /* NOTREACHED */
1608 =for apidoc Am|void|croak_no_modify
1610 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1611 terser object code than using C<Perl_croak>. Less code used on exception code
1612 paths reduces CPU cache pressure.
1618 Perl_croak_no_modify()
1620 Perl_croak_nocontext( "%s", PL_no_modify);
1623 /* does not return, used in util.c perlio.c and win32.c
1624 This is typically called when malloc returns NULL.
1631 /* Can't use PerlIO to write as it allocates memory */
1632 PerlLIO_write(PerlIO_fileno(Perl_error_log),
1633 PL_no_mem, sizeof(PL_no_mem)-1);
1638 =for apidoc Am|void|warn_sv|SV *baseex
1640 This is an XS interface to Perl's C<warn> function.
1642 C<baseex> is the error message or object. If it is a reference, it
1643 will be used as-is. Otherwise it is used as a string, and if it does
1644 not end with a newline then it will be extended with some indication of
1645 the current location in the code, as described for L</mess_sv>.
1647 The error message or object will by default be written to standard error,
1648 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1650 To warn with a simple string message, the L</warn> function may be
1657 Perl_warn_sv(pTHX_ SV *baseex)
1659 SV *ex = mess_sv(baseex, 0);
1660 PERL_ARGS_ASSERT_WARN_SV;
1661 if (!invoke_exception_hook(ex, TRUE))
1662 write_to_stderr(ex);
1666 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1668 This is an XS interface to Perl's C<warn> function.
1670 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1671 argument list. These are used to generate a string message. If the
1672 message does not end with a newline, then it will be extended with
1673 some indication of the current location in the code, as described for
1676 The error message or object will by default be written to standard error,
1677 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1679 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1685 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1687 SV *ex = vmess(pat, args);
1688 PERL_ARGS_ASSERT_VWARN;
1689 if (!invoke_exception_hook(ex, TRUE))
1690 write_to_stderr(ex);
1694 =for apidoc Am|void|warn|const char *pat|...
1696 This is an XS interface to Perl's C<warn> function.
1698 Take a sprintf-style format pattern and argument list. These are used to
1699 generate a string message. If the message does not end with a newline,
1700 then it will be extended with some indication of the current location
1701 in the code, as described for L</mess_sv>.
1703 The error message or object will by default be written to standard error,
1704 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1706 Unlike with L</croak>, C<pat> is not permitted to be null.
1711 #if defined(PERL_IMPLICIT_CONTEXT)
1713 Perl_warn_nocontext(const char *pat, ...)
1717 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1718 va_start(args, pat);
1722 #endif /* PERL_IMPLICIT_CONTEXT */
1725 Perl_warn(pTHX_ const char *pat, ...)
1728 PERL_ARGS_ASSERT_WARN;
1729 va_start(args, pat);
1734 #if defined(PERL_IMPLICIT_CONTEXT)
1736 Perl_warner_nocontext(U32 err, const char *pat, ...)
1740 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1741 va_start(args, pat);
1742 vwarner(err, pat, &args);
1745 #endif /* PERL_IMPLICIT_CONTEXT */
1748 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1750 PERL_ARGS_ASSERT_CK_WARNER_D;
1752 if (Perl_ckwarn_d(aTHX_ err)) {
1754 va_start(args, pat);
1755 vwarner(err, pat, &args);
1761 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1763 PERL_ARGS_ASSERT_CK_WARNER;
1765 if (Perl_ckwarn(aTHX_ err)) {
1767 va_start(args, pat);
1768 vwarner(err, pat, &args);
1774 Perl_warner(pTHX_ U32 err, const char* pat,...)
1777 PERL_ARGS_ASSERT_WARNER;
1778 va_start(args, pat);
1779 vwarner(err, pat, &args);
1784 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1787 PERL_ARGS_ASSERT_VWARNER;
1788 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1789 SV * const msv = vmess(pat, args);
1791 invoke_exception_hook(msv, FALSE);
1795 Perl_vwarn(aTHX_ pat, args);
1799 /* implements the ckWARN? macros */
1802 Perl_ckwarn(pTHX_ U32 w)
1805 /* If lexical warnings have not been set, use $^W. */
1807 return PL_dowarn & G_WARN_ON;
1809 return ckwarn_common(w);
1812 /* implements the ckWARN?_d macro */
1815 Perl_ckwarn_d(pTHX_ U32 w)
1818 /* If lexical warnings have not been set then default classes warn. */
1822 return ckwarn_common(w);
1826 S_ckwarn_common(pTHX_ U32 w)
1828 if (PL_curcop->cop_warnings == pWARN_ALL)
1831 if (PL_curcop->cop_warnings == pWARN_NONE)
1834 /* Check the assumption that at least the first slot is non-zero. */
1835 assert(unpackWARN1(w));
1837 /* Check the assumption that it is valid to stop as soon as a zero slot is
1839 if (!unpackWARN2(w)) {
1840 assert(!unpackWARN3(w));
1841 assert(!unpackWARN4(w));
1842 } else if (!unpackWARN3(w)) {
1843 assert(!unpackWARN4(w));
1846 /* Right, dealt with all the special cases, which are implemented as non-
1847 pointers, so there is a pointer to a real warnings mask. */
1849 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1851 } while (w >>= WARNshift);
1856 /* Set buffer=NULL to get a new one. */
1858 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1860 const MEM_SIZE len_wanted =
1861 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
1862 PERL_UNUSED_CONTEXT;
1863 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1866 (specialWARN(buffer) ?
1867 PerlMemShared_malloc(len_wanted) :
1868 PerlMemShared_realloc(buffer, len_wanted));
1870 Copy(bits, (buffer + 1), size, char);
1871 if (size < WARNsize)
1872 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
1876 /* since we've already done strlen() for both nam and val
1877 * we can use that info to make things faster than
1878 * sprintf(s, "%s=%s", nam, val)
1880 #define my_setenv_format(s, nam, nlen, val, vlen) \
1881 Copy(nam, s, nlen, char); \
1883 Copy(val, s+(nlen+1), vlen, char); \
1884 *(s+(nlen+1+vlen)) = '\0'
1886 #ifdef USE_ENVIRON_ARRAY
1887 /* VMS' my_setenv() is in vms.c */
1888 #if !defined(WIN32) && !defined(NETWARE)
1890 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1894 /* only parent thread can modify process environment */
1895 if (PL_curinterp == aTHX)
1898 #ifndef PERL_USE_SAFE_PUTENV
1899 if (!PL_use_safe_putenv) {
1900 /* most putenv()s leak, so we manipulate environ directly */
1902 const I32 len = strlen(nam);
1905 /* where does it go? */
1906 for (i = 0; environ[i]; i++) {
1907 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1911 if (environ == PL_origenviron) { /* need we copy environment? */
1917 while (environ[max])
1919 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1920 for (j=0; j<max; j++) { /* copy environment */
1921 const int len = strlen(environ[j]);
1922 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1923 Copy(environ[j], tmpenv[j], len+1, char);
1926 environ = tmpenv; /* tell exec where it is now */
1929 safesysfree(environ[i]);
1930 while (environ[i]) {
1931 environ[i] = environ[i+1];
1936 if (!environ[i]) { /* does not exist yet */
1937 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1938 environ[i+1] = NULL; /* make sure it's null terminated */
1941 safesysfree(environ[i]);
1945 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1946 /* all that work just for this */
1947 my_setenv_format(environ[i], nam, nlen, val, vlen);
1950 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__)
1951 # if defined(HAS_UNSETENV)
1953 (void)unsetenv(nam);
1955 (void)setenv(nam, val, 1);
1957 # else /* ! HAS_UNSETENV */
1958 (void)setenv(nam, val, 1);
1959 # endif /* HAS_UNSETENV */
1961 # if defined(HAS_UNSETENV)
1963 (void)unsetenv(nam);
1965 const int nlen = strlen(nam);
1966 const int vlen = strlen(val);
1967 char * const new_env =
1968 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1969 my_setenv_format(new_env, nam, nlen, val, vlen);
1970 (void)putenv(new_env);
1972 # else /* ! HAS_UNSETENV */
1974 const int nlen = strlen(nam);
1980 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1981 /* all that work just for this */
1982 my_setenv_format(new_env, nam, nlen, val, vlen);
1983 (void)putenv(new_env);
1984 # endif /* HAS_UNSETENV */
1985 # endif /* __CYGWIN__ */
1986 #ifndef PERL_USE_SAFE_PUTENV
1992 #else /* WIN32 || NETWARE */
1995 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1999 const int nlen = strlen(nam);
2006 Newx(envstr, nlen+vlen+2, char);
2007 my_setenv_format(envstr, nam, nlen, val, vlen);
2008 (void)PerlEnv_putenv(envstr);
2012 #endif /* WIN32 || NETWARE */
2016 #ifdef UNLINK_ALL_VERSIONS
2018 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2022 PERL_ARGS_ASSERT_UNLNK;
2024 while (PerlLIO_unlink(f) >= 0)
2026 return retries ? 0 : -1;
2030 /* this is a drop-in replacement for bcopy() */
2031 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2033 Perl_my_bcopy(const char *from, char *to, I32 len)
2035 char * const retval = to;
2037 PERL_ARGS_ASSERT_MY_BCOPY;
2041 if (from - to >= 0) {
2049 *(--to) = *(--from);
2055 /* this is a drop-in replacement for memset() */
2058 Perl_my_memset(char *loc, I32 ch, I32 len)
2060 char * const retval = loc;
2062 PERL_ARGS_ASSERT_MY_MEMSET;
2072 /* this is a drop-in replacement for bzero() */
2073 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2075 Perl_my_bzero(char *loc, I32 len)
2077 char * const retval = loc;
2079 PERL_ARGS_ASSERT_MY_BZERO;
2089 /* this is a drop-in replacement for memcmp() */
2090 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2092 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2094 const U8 *a = (const U8 *)s1;
2095 const U8 *b = (const U8 *)s2;
2098 PERL_ARGS_ASSERT_MY_MEMCMP;
2103 if ((tmp = *a++ - *b++))
2108 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2111 /* This vsprintf replacement should generally never get used, since
2112 vsprintf was available in both System V and BSD 2.11. (There may
2113 be some cross-compilation or embedded set-ups where it is needed,
2116 If you encounter a problem in this function, it's probably a symptom
2117 that Configure failed to detect your system's vprintf() function.
2118 See the section on "item vsprintf" in the INSTALL file.
2120 This version may compile on systems with BSD-ish <stdio.h>,
2121 but probably won't on others.
2124 #ifdef USE_CHAR_VSPRINTF
2129 vsprintf(char *dest, const char *pat, void *args)
2133 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2134 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2135 FILE_cnt(&fakebuf) = 32767;
2137 /* These probably won't compile -- If you really need
2138 this, you'll have to figure out some other method. */
2139 fakebuf._ptr = dest;
2140 fakebuf._cnt = 32767;
2145 fakebuf._flag = _IOWRT|_IOSTRG;
2146 _doprnt(pat, args, &fakebuf); /* what a kludge */
2147 #if defined(STDIO_PTR_LVALUE)
2148 *(FILE_ptr(&fakebuf)++) = '\0';
2150 /* PerlIO has probably #defined away fputc, but we want it here. */
2152 # undef fputc /* XXX Should really restore it later */
2154 (void)fputc('\0', &fakebuf);
2156 #ifdef USE_CHAR_VSPRINTF
2159 return 0; /* perl doesn't use return value */
2163 #endif /* HAS_VPRINTF */
2166 #if BYTEORDER != 0x4321
2168 Perl_my_swap(pTHX_ short s)
2170 #if (BYTEORDER & 1) == 0
2173 result = ((s & 255) << 8) + ((s >> 8) & 255);
2181 Perl_my_htonl(pTHX_ long l)
2185 char c[sizeof(long)];
2188 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
2189 #if BYTEORDER == 0x12345678
2192 u.c[0] = (l >> 24) & 255;
2193 u.c[1] = (l >> 16) & 255;
2194 u.c[2] = (l >> 8) & 255;
2198 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2199 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2204 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2205 u.c[o & 0xf] = (l >> s) & 255;
2213 Perl_my_ntohl(pTHX_ long l)
2217 char c[sizeof(long)];
2220 #if BYTEORDER == 0x1234
2221 u.c[0] = (l >> 24) & 255;
2222 u.c[1] = (l >> 16) & 255;
2223 u.c[2] = (l >> 8) & 255;
2227 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2228 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2235 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2236 l |= (u.c[o & 0xf] & 255) << s;
2243 #endif /* BYTEORDER != 0x4321 */
2247 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2248 * If these functions are defined,
2249 * the BYTEORDER is neither 0x1234 nor 0x4321.
2250 * However, this is not assumed.
2254 #define HTOLE(name,type) \
2260 char c[sizeof(type)]; \
2264 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2265 u.c[i] = (n >> s) & 0xFF; \
2270 #define LETOH(name,type) \
2276 char c[sizeof(type)]; \
2282 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2283 n |= ((type)(u.c[i] & 0xFF)) << s; \
2289 * Big-endian byte order functions.
2292 #define HTOBE(name,type) \
2298 char c[sizeof(type)]; \
2301 U32 s = 8*(sizeof(u.c)-1); \
2302 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2303 u.c[i] = (n >> s) & 0xFF; \
2308 #define BETOH(name,type) \
2314 char c[sizeof(type)]; \
2317 U32 s = 8*(sizeof(u.c)-1); \
2320 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2321 n |= ((type)(u.c[i] & 0xFF)) << s; \
2327 * If we just can't do it...
2330 #define NOT_AVAIL(name,type) \
2334 Perl_croak_nocontext(#name "() not available"); \
2335 return n; /* not reached */ \
2339 #if defined(HAS_HTOVS) && !defined(htovs)
2342 #if defined(HAS_HTOVL) && !defined(htovl)
2345 #if defined(HAS_VTOHS) && !defined(vtohs)
2348 #if defined(HAS_VTOHL) && !defined(vtohl)
2352 #ifdef PERL_NEED_MY_HTOLE16
2354 HTOLE(Perl_my_htole16,U16)
2356 NOT_AVAIL(Perl_my_htole16,U16)
2359 #ifdef PERL_NEED_MY_LETOH16
2361 LETOH(Perl_my_letoh16,U16)
2363 NOT_AVAIL(Perl_my_letoh16,U16)
2366 #ifdef PERL_NEED_MY_HTOBE16
2368 HTOBE(Perl_my_htobe16,U16)
2370 NOT_AVAIL(Perl_my_htobe16,U16)
2373 #ifdef PERL_NEED_MY_BETOH16
2375 BETOH(Perl_my_betoh16,U16)
2377 NOT_AVAIL(Perl_my_betoh16,U16)
2381 #ifdef PERL_NEED_MY_HTOLE32
2383 HTOLE(Perl_my_htole32,U32)
2385 NOT_AVAIL(Perl_my_htole32,U32)
2388 #ifdef PERL_NEED_MY_LETOH32
2390 LETOH(Perl_my_letoh32,U32)
2392 NOT_AVAIL(Perl_my_letoh32,U32)
2395 #ifdef PERL_NEED_MY_HTOBE32
2397 HTOBE(Perl_my_htobe32,U32)
2399 NOT_AVAIL(Perl_my_htobe32,U32)
2402 #ifdef PERL_NEED_MY_BETOH32
2404 BETOH(Perl_my_betoh32,U32)
2406 NOT_AVAIL(Perl_my_betoh32,U32)
2410 #ifdef PERL_NEED_MY_HTOLE64
2412 HTOLE(Perl_my_htole64,U64)
2414 NOT_AVAIL(Perl_my_htole64,U64)
2417 #ifdef PERL_NEED_MY_LETOH64
2419 LETOH(Perl_my_letoh64,U64)
2421 NOT_AVAIL(Perl_my_letoh64,U64)
2424 #ifdef PERL_NEED_MY_HTOBE64
2426 HTOBE(Perl_my_htobe64,U64)
2428 NOT_AVAIL(Perl_my_htobe64,U64)
2431 #ifdef PERL_NEED_MY_BETOH64
2433 BETOH(Perl_my_betoh64,U64)
2435 NOT_AVAIL(Perl_my_betoh64,U64)
2439 #ifdef PERL_NEED_MY_HTOLES
2440 HTOLE(Perl_my_htoles,short)
2442 #ifdef PERL_NEED_MY_LETOHS
2443 LETOH(Perl_my_letohs,short)
2445 #ifdef PERL_NEED_MY_HTOBES
2446 HTOBE(Perl_my_htobes,short)
2448 #ifdef PERL_NEED_MY_BETOHS
2449 BETOH(Perl_my_betohs,short)
2452 #ifdef PERL_NEED_MY_HTOLEI
2453 HTOLE(Perl_my_htolei,int)
2455 #ifdef PERL_NEED_MY_LETOHI
2456 LETOH(Perl_my_letohi,int)
2458 #ifdef PERL_NEED_MY_HTOBEI
2459 HTOBE(Perl_my_htobei,int)
2461 #ifdef PERL_NEED_MY_BETOHI
2462 BETOH(Perl_my_betohi,int)
2465 #ifdef PERL_NEED_MY_HTOLEL
2466 HTOLE(Perl_my_htolel,long)
2468 #ifdef PERL_NEED_MY_LETOHL
2469 LETOH(Perl_my_letohl,long)
2471 #ifdef PERL_NEED_MY_HTOBEL
2472 HTOBE(Perl_my_htobel,long)
2474 #ifdef PERL_NEED_MY_BETOHL
2475 BETOH(Perl_my_betohl,long)
2479 Perl_my_swabn(void *ptr, int n)
2481 char *s = (char *)ptr;
2482 char *e = s + (n-1);
2485 PERL_ARGS_ASSERT_MY_SWABN;
2487 for (n /= 2; n > 0; s++, e--, n--) {
2495 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2497 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2506 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2508 PERL_FLUSHALL_FOR_CHILD;
2509 This = (*mode == 'w');
2513 taint_proper("Insecure %s%s", "EXEC");
2515 if (PerlProc_pipe(p) < 0)
2517 /* Try for another pipe pair for error return */
2518 if (PerlProc_pipe(pp) >= 0)
2520 while ((pid = PerlProc_fork()) < 0) {
2521 if (errno != EAGAIN) {
2522 PerlLIO_close(p[This]);
2523 PerlLIO_close(p[that]);
2525 PerlLIO_close(pp[0]);
2526 PerlLIO_close(pp[1]);
2530 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2539 /* Close parent's end of error status pipe (if any) */
2541 PerlLIO_close(pp[0]);
2542 #if defined(HAS_FCNTL) && defined(F_SETFD)
2543 /* Close error pipe automatically if exec works */
2544 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2547 /* Now dup our end of _the_ pipe to right position */
2548 if (p[THIS] != (*mode == 'r')) {
2549 PerlLIO_dup2(p[THIS], *mode == 'r');
2550 PerlLIO_close(p[THIS]);
2551 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2552 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2555 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2556 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2557 /* No automatic close - do it by hand */
2564 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2570 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2576 do_execfree(); /* free any memory malloced by child on fork */
2578 PerlLIO_close(pp[1]);
2579 /* Keep the lower of the two fd numbers */
2580 if (p[that] < p[This]) {
2581 PerlLIO_dup2(p[This], p[that]);
2582 PerlLIO_close(p[This]);
2586 PerlLIO_close(p[that]); /* close child's end of pipe */
2588 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2589 SvUPGRADE(sv,SVt_IV);
2591 PL_forkprocess = pid;
2592 /* If we managed to get status pipe check for exec fail */
2593 if (did_pipes && pid > 0) {
2598 while (n < sizeof(int)) {
2599 n1 = PerlLIO_read(pp[0],
2600 (void*)(((char*)&errkid)+n),
2606 PerlLIO_close(pp[0]);
2608 if (n) { /* Error */
2610 PerlLIO_close(p[This]);
2611 if (n != sizeof(int))
2612 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2614 pid2 = wait4pid(pid, &status, 0);
2615 } while (pid2 == -1 && errno == EINTR);
2616 errno = errkid; /* Propagate errno from kid */
2621 PerlLIO_close(pp[0]);
2622 return PerlIO_fdopen(p[This], mode);
2624 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2625 return my_syspopen4(aTHX_ NULL, mode, n, args);
2627 Perl_croak(aTHX_ "List form of piped open not implemented");
2628 return (PerlIO *) NULL;
2633 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2634 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2636 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2643 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2647 PERL_ARGS_ASSERT_MY_POPEN;
2649 PERL_FLUSHALL_FOR_CHILD;
2652 return my_syspopen(aTHX_ cmd,mode);
2655 This = (*mode == 'w');
2657 if (doexec && TAINTING_get) {
2659 taint_proper("Insecure %s%s", "EXEC");
2661 if (PerlProc_pipe(p) < 0)
2663 if (doexec && PerlProc_pipe(pp) >= 0)
2665 while ((pid = PerlProc_fork()) < 0) {
2666 if (errno != EAGAIN) {
2667 PerlLIO_close(p[This]);
2668 PerlLIO_close(p[that]);
2670 PerlLIO_close(pp[0]);
2671 PerlLIO_close(pp[1]);
2674 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2677 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2687 PerlLIO_close(pp[0]);
2688 #if defined(HAS_FCNTL) && defined(F_SETFD)
2689 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2692 if (p[THIS] != (*mode == 'r')) {
2693 PerlLIO_dup2(p[THIS], *mode == 'r');
2694 PerlLIO_close(p[THIS]);
2695 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2696 PerlLIO_close(p[THAT]);
2699 PerlLIO_close(p[THAT]);
2702 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2709 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2714 /* may or may not use the shell */
2715 do_exec3(cmd, pp[1], did_pipes);
2718 #endif /* defined OS2 */
2720 #ifdef PERLIO_USING_CRLF
2721 /* Since we circumvent IO layers when we manipulate low-level
2722 filedescriptors directly, need to manually switch to the
2723 default, binary, low-level mode; see PerlIOBuf_open(). */
2724 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2727 #ifdef PERL_USES_PL_PIDSTATUS
2728 hv_clear(PL_pidstatus); /* we have no children */
2734 do_execfree(); /* free any memory malloced by child on vfork */
2736 PerlLIO_close(pp[1]);
2737 if (p[that] < p[This]) {
2738 PerlLIO_dup2(p[This], p[that]);
2739 PerlLIO_close(p[This]);
2743 PerlLIO_close(p[that]);
2745 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2746 SvUPGRADE(sv,SVt_IV);
2748 PL_forkprocess = pid;
2749 if (did_pipes && pid > 0) {
2754 while (n < sizeof(int)) {
2755 n1 = PerlLIO_read(pp[0],
2756 (void*)(((char*)&errkid)+n),
2762 PerlLIO_close(pp[0]);
2764 if (n) { /* Error */
2766 PerlLIO_close(p[This]);
2767 if (n != sizeof(int))
2768 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2770 pid2 = wait4pid(pid, &status, 0);
2771 } while (pid2 == -1 && errno == EINTR);
2772 errno = errkid; /* Propagate errno from kid */
2777 PerlLIO_close(pp[0]);
2778 return PerlIO_fdopen(p[This], mode);
2782 FILE *djgpp_popen();
2784 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2786 PERL_FLUSHALL_FOR_CHILD;
2787 /* Call system's popen() to get a FILE *, then import it.
2788 used 0 for 2nd parameter to PerlIO_importFILE;
2791 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2794 #if defined(__LIBCATAMOUNT__)
2796 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2803 #endif /* !DOSISH */
2805 /* this is called in parent before the fork() */
2807 Perl_atfork_lock(void)
2810 #if defined(USE_ITHREADS)
2811 /* locks must be held in locking order (if any) */
2813 MUTEX_LOCK(&PL_malloc_mutex);
2819 /* this is called in both parent and child after the fork() */
2821 Perl_atfork_unlock(void)
2824 #if defined(USE_ITHREADS)
2825 /* locks must be released in same order as in atfork_lock() */
2827 MUTEX_UNLOCK(&PL_malloc_mutex);
2836 #if defined(HAS_FORK)
2838 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2843 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2844 * handlers elsewhere in the code */
2849 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2850 Perl_croak_nocontext("fork() not available");
2852 #endif /* HAS_FORK */
2857 Perl_dump_fds(pTHX_ const char *const s)
2862 PERL_ARGS_ASSERT_DUMP_FDS;
2864 PerlIO_printf(Perl_debug_log,"%s", s);
2865 for (fd = 0; fd < 32; fd++) {
2866 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2867 PerlIO_printf(Perl_debug_log," %d",fd);
2869 PerlIO_printf(Perl_debug_log,"\n");
2872 #endif /* DUMP_FDS */
2876 dup2(int oldfd, int newfd)
2878 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2881 PerlLIO_close(newfd);
2882 return fcntl(oldfd, F_DUPFD, newfd);
2884 #define DUP2_MAX_FDS 256
2885 int fdtmp[DUP2_MAX_FDS];
2891 PerlLIO_close(newfd);
2892 /* good enough for low fd's... */
2893 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2894 if (fdx >= DUP2_MAX_FDS) {
2902 PerlLIO_close(fdtmp[--fdx]);
2909 #ifdef HAS_SIGACTION
2912 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2915 struct sigaction act, oact;
2918 /* only "parent" interpreter can diddle signals */
2919 if (PL_curinterp != aTHX)
2920 return (Sighandler_t) SIG_ERR;
2923 act.sa_handler = (void(*)(int))handler;
2924 sigemptyset(&act.sa_mask);
2927 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2928 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2930 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2931 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2932 act.sa_flags |= SA_NOCLDWAIT;
2934 if (sigaction(signo, &act, &oact) == -1)
2935 return (Sighandler_t) SIG_ERR;
2937 return (Sighandler_t) oact.sa_handler;
2941 Perl_rsignal_state(pTHX_ int signo)
2943 struct sigaction oact;
2944 PERL_UNUSED_CONTEXT;
2946 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2947 return (Sighandler_t) SIG_ERR;
2949 return (Sighandler_t) oact.sa_handler;
2953 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2956 struct sigaction act;
2958 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2961 /* only "parent" interpreter can diddle signals */
2962 if (PL_curinterp != aTHX)
2966 act.sa_handler = (void(*)(int))handler;
2967 sigemptyset(&act.sa_mask);
2970 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2971 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2973 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2974 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2975 act.sa_flags |= SA_NOCLDWAIT;
2977 return sigaction(signo, &act, save);
2981 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2985 /* only "parent" interpreter can diddle signals */
2986 if (PL_curinterp != aTHX)
2990 return sigaction(signo, save, (struct sigaction *)NULL);
2993 #else /* !HAS_SIGACTION */
2996 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2998 #if defined(USE_ITHREADS) && !defined(WIN32)
2999 /* only "parent" interpreter can diddle signals */
3000 if (PL_curinterp != aTHX)
3001 return (Sighandler_t) SIG_ERR;
3004 return PerlProc_signal(signo, handler);
3015 Perl_rsignal_state(pTHX_ int signo)
3018 Sighandler_t oldsig;
3020 #if defined(USE_ITHREADS) && !defined(WIN32)
3021 /* only "parent" interpreter can diddle signals */
3022 if (PL_curinterp != aTHX)
3023 return (Sighandler_t) SIG_ERR;
3027 oldsig = PerlProc_signal(signo, sig_trap);
3028 PerlProc_signal(signo, oldsig);
3030 PerlProc_kill(PerlProc_getpid(), signo);
3035 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3037 #if defined(USE_ITHREADS) && !defined(WIN32)
3038 /* only "parent" interpreter can diddle signals */
3039 if (PL_curinterp != aTHX)
3042 *save = PerlProc_signal(signo, handler);
3043 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3047 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3049 #if defined(USE_ITHREADS) && !defined(WIN32)
3050 /* only "parent" interpreter can diddle signals */
3051 if (PL_curinterp != aTHX)
3054 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3057 #endif /* !HAS_SIGACTION */
3058 #endif /* !PERL_MICRO */
3060 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3061 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
3063 Perl_my_pclose(pTHX_ PerlIO *ptr)
3066 Sigsave_t hstat, istat, qstat;
3073 const int fd = PerlIO_fileno(ptr);
3076 /* Find out whether the refcount is low enough for us to wait for the
3077 child proc without blocking. */
3078 const bool should_wait = PerlIOUnix_refcnt(fd) == 1;
3080 const bool should_wait = 1;
3083 svp = av_fetch(PL_fdpid,fd,TRUE);
3084 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3086 *svp = &PL_sv_undef;
3088 if (pid == -1) { /* Opened by popen. */
3089 return my_syspclose(ptr);
3092 close_failed = (PerlIO_close(ptr) == EOF);
3095 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3096 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3097 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3099 if (should_wait) do {
3100 pid2 = wait4pid(pid, &status, 0);
3101 } while (pid2 == -1 && errno == EINTR);
3103 rsignal_restore(SIGHUP, &hstat);
3104 rsignal_restore(SIGINT, &istat);
3105 rsignal_restore(SIGQUIT, &qstat);
3113 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3118 #if defined(__LIBCATAMOUNT__)
3120 Perl_my_pclose(pTHX_ PerlIO *ptr)
3125 #endif /* !DOSISH */
3127 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3129 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3133 PERL_ARGS_ASSERT_WAIT4PID;
3136 #ifdef PERL_USES_PL_PIDSTATUS
3139 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3140 pid, rather than a string form. */
3141 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3142 if (svp && *svp != &PL_sv_undef) {
3143 *statusp = SvIVX(*svp);
3144 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3152 hv_iterinit(PL_pidstatus);
3153 if ((entry = hv_iternext(PL_pidstatus))) {
3154 SV * const sv = hv_iterval(PL_pidstatus,entry);
3156 const char * const spid = hv_iterkey(entry,&len);
3158 assert (len == sizeof(Pid_t));
3159 memcpy((char *)&pid, spid, len);
3160 *statusp = SvIVX(sv);
3161 /* The hash iterator is currently on this entry, so simply
3162 calling hv_delete would trigger the lazy delete, which on
3163 aggregate does more work, beacuse next call to hv_iterinit()
3164 would spot the flag, and have to call the delete routine,
3165 while in the meantime any new entries can't re-use that
3167 hv_iterinit(PL_pidstatus);
3168 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3175 # ifdef HAS_WAITPID_RUNTIME
3176 if (!HAS_WAITPID_RUNTIME)
3179 result = PerlProc_waitpid(pid,statusp,flags);
3182 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3183 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3186 #ifdef PERL_USES_PL_PIDSTATUS
3187 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3192 Perl_croak(aTHX_ "Can't do waitpid with flags");
3194 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3195 pidgone(result,*statusp);
3201 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3204 if (result < 0 && errno == EINTR) {
3206 errno = EINTR; /* reset in case a signal handler changed $! */
3210 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3212 #ifdef PERL_USES_PL_PIDSTATUS
3214 S_pidgone(pTHX_ Pid_t pid, int status)
3218 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3219 SvUPGRADE(sv,SVt_IV);
3220 SvIV_set(sv, status);
3228 int /* Cannot prototype with I32
3230 my_syspclose(PerlIO *ptr)
3233 Perl_my_pclose(pTHX_ PerlIO *ptr)
3236 /* Needs work for PerlIO ! */
3237 FILE * const f = PerlIO_findFILE(ptr);
3238 const I32 result = pclose(f);
3239 PerlIO_releaseFILE(ptr,f);
3247 Perl_my_pclose(pTHX_ PerlIO *ptr)
3249 /* Needs work for PerlIO ! */
3250 FILE * const f = PerlIO_findFILE(ptr);
3251 I32 result = djgpp_pclose(f);
3252 result = (result << 8) & 0xff00;
3253 PerlIO_releaseFILE(ptr,f);
3258 #define PERL_REPEATCPY_LINEAR 4
3260 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3262 PERL_ARGS_ASSERT_REPEATCPY;
3267 croak_memory_wrap();
3270 memset(to, *from, count);
3273 IV items, linear, half;
3275 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3276 for (items = 0; items < linear; ++items) {
3277 const char *q = from;
3279 for (todo = len; todo > 0; todo--)
3284 while (items <= half) {
3285 IV size = items * len;
3286 memcpy(p, to, size);
3292 memcpy(p, to, (count - items) * len);
3298 Perl_same_dirent(pTHX_ const char *a, const char *b)
3300 char *fa = strrchr(a,'/');
3301 char *fb = strrchr(b,'/');
3304 SV * const tmpsv = sv_newmortal();
3306 PERL_ARGS_ASSERT_SAME_DIRENT;
3319 sv_setpvs(tmpsv, ".");
3321 sv_setpvn(tmpsv, a, fa - a);
3322 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3325 sv_setpvs(tmpsv, ".");
3327 sv_setpvn(tmpsv, b, fb - b);
3328 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3330 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3331 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3333 #endif /* !HAS_RENAME */
3336 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3337 const char *const *const search_ext, I32 flags)
3340 const char *xfound = NULL;
3341 char *xfailed = NULL;
3342 char tmpbuf[MAXPATHLEN];
3347 #if defined(DOSISH) && !defined(OS2)
3348 # define SEARCH_EXTS ".bat", ".cmd", NULL
3349 # define MAX_EXT_LEN 4
3352 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3353 # define MAX_EXT_LEN 4
3356 # define SEARCH_EXTS ".pl", ".com", NULL
3357 # define MAX_EXT_LEN 4
3359 /* additional extensions to try in each dir if scriptname not found */
3361 static const char *const exts[] = { SEARCH_EXTS };
3362 const char *const *const ext = search_ext ? search_ext : exts;
3363 int extidx = 0, i = 0;
3364 const char *curext = NULL;
3366 PERL_UNUSED_ARG(search_ext);
3367 # define MAX_EXT_LEN 0
3370 PERL_ARGS_ASSERT_FIND_SCRIPT;
3373 * If dosearch is true and if scriptname does not contain path
3374 * delimiters, search the PATH for scriptname.
3376 * If SEARCH_EXTS is also defined, will look for each
3377 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3378 * while searching the PATH.
3380 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3381 * proceeds as follows:
3382 * If DOSISH or VMSISH:
3383 * + look for ./scriptname{,.foo,.bar}
3384 * + search the PATH for scriptname{,.foo,.bar}
3387 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3388 * this will not look in '.' if it's not in the PATH)
3393 # ifdef ALWAYS_DEFTYPES
3394 len = strlen(scriptname);
3395 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3396 int idx = 0, deftypes = 1;
3399 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3402 int idx = 0, deftypes = 1;
3405 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3407 /* The first time through, just add SEARCH_EXTS to whatever we
3408 * already have, so we can check for default file types. */
3410 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3416 if ((strlen(tmpbuf) + strlen(scriptname)
3417 + MAX_EXT_LEN) >= sizeof tmpbuf)
3418 continue; /* don't search dir with too-long name */
3419 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3423 if (strEQ(scriptname, "-"))
3425 if (dosearch) { /* Look in '.' first. */
3426 const char *cur = scriptname;
3428 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3430 if (strEQ(ext[i++],curext)) {
3431 extidx = -1; /* already has an ext */
3436 DEBUG_p(PerlIO_printf(Perl_debug_log,
3437 "Looking for %s\n",cur));
3438 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3439 && !S_ISDIR(PL_statbuf.st_mode)) {
3447 if (cur == scriptname) {
3448 len = strlen(scriptname);
3449 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3451 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3454 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3455 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3460 if (dosearch && !strchr(scriptname, '/')
3462 && !strchr(scriptname, '\\')
3464 && (s = PerlEnv_getenv("PATH")))
3468 bufend = s + strlen(s);
3469 while (s < bufend) {
3472 && *s != ';'; len++, s++) {
3473 if (len < sizeof tmpbuf)
3476 if (len < sizeof tmpbuf)
3479 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3485 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3486 continue; /* don't search dir with too-long name */
3489 && tmpbuf[len - 1] != '/'
3490 && tmpbuf[len - 1] != '\\'
3493 tmpbuf[len++] = '/';
3494 if (len == 2 && tmpbuf[0] == '.')
3496 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3500 len = strlen(tmpbuf);
3501 if (extidx > 0) /* reset after previous loop */
3505 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3506 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3507 if (S_ISDIR(PL_statbuf.st_mode)) {
3511 } while ( retval < 0 /* not there */
3512 && extidx>=0 && ext[extidx] /* try an extension? */
3513 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3518 if (S_ISREG(PL_statbuf.st_mode)
3519 && cando(S_IRUSR,TRUE,&PL_statbuf)
3520 #if !defined(DOSISH)
3521 && cando(S_IXUSR,TRUE,&PL_statbuf)
3525 xfound = tmpbuf; /* bingo! */
3529 xfailed = savepv(tmpbuf);
3532 if (!xfound && !seen_dot && !xfailed &&
3533 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3534 || S_ISDIR(PL_statbuf.st_mode)))
3536 seen_dot = 1; /* Disable message. */
3538 if (flags & 1) { /* do or die? */
3539 /* diag_listed_as: Can't execute %s */
3540 Perl_croak(aTHX_ "Can't %s %s%s%s",
3541 (xfailed ? "execute" : "find"),
3542 (xfailed ? xfailed : scriptname),
3543 (xfailed ? "" : " on PATH"),
3544 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3549 scriptname = xfound;
3551 return (scriptname ? savepv(scriptname) : NULL);
3554 #ifndef PERL_GET_CONTEXT_DEFINED
3557 Perl_get_context(void)
3560 #if defined(USE_ITHREADS)
3561 # ifdef OLD_PTHREADS_API
3563 int error = pthread_getspecific(PL_thr_key, &t)
3565 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3568 # ifdef I_MACH_CTHREADS
3569 return (void*)cthread_data(cthread_self());
3571 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3580 Perl_set_context(void *t)
3583 PERL_ARGS_ASSERT_SET_CONTEXT;
3584 #if defined(USE_ITHREADS)
3585 # ifdef I_MACH_CTHREADS
3586 cthread_set_data(cthread_self(), t);
3589 const int error = pthread_setspecific(PL_thr_key, t);
3591 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3599 #endif /* !PERL_GET_CONTEXT_DEFINED */
3601 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3610 Perl_get_op_names(pTHX)
3612 PERL_UNUSED_CONTEXT;
3613 return (char **)PL_op_name;
3617 Perl_get_op_descs(pTHX)
3619 PERL_UNUSED_CONTEXT;
3620 return (char **)PL_op_desc;
3624 Perl_get_no_modify(pTHX)
3626 PERL_UNUSED_CONTEXT;
3627 return PL_no_modify;
3631 Perl_get_opargs(pTHX)
3633 PERL_UNUSED_CONTEXT;
3634 return (U32 *)PL_opargs;
3638 Perl_get_ppaddr(pTHX)
3641 PERL_UNUSED_CONTEXT;
3642 return (PPADDR_t*)PL_ppaddr;
3645 #ifndef HAS_GETENV_LEN
3647 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3649 char * const env_trans = PerlEnv_getenv(env_elem);
3650 PERL_UNUSED_CONTEXT;
3651 PERL_ARGS_ASSERT_GETENV_LEN;
3653 *len = strlen(env_trans);
3660 Perl_get_vtbl(pTHX_ int vtbl_id)
3662 PERL_UNUSED_CONTEXT;
3664 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3665 ? NULL : PL_magic_vtables + vtbl_id;
3669 Perl_my_fflush_all(pTHX)
3671 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3672 return PerlIO_flush(NULL);
3674 # if defined(HAS__FWALK)
3675 extern int fflush(FILE *);
3676 /* undocumented, unprototyped, but very useful BSDism */
3677 extern void _fwalk(int (*)(FILE *));
3681 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3683 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3684 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3686 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3687 open_max = sysconf(_SC_OPEN_MAX);
3690 open_max = FOPEN_MAX;
3693 open_max = OPEN_MAX;
3704 for (i = 0; i < open_max; i++)
3705 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3706 STDIO_STREAM_ARRAY[i]._file < open_max &&
3707 STDIO_STREAM_ARRAY[i]._flag)
3708 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3712 SETERRNO(EBADF,RMS_IFI);
3719 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3721 if (ckWARN(WARN_IO)) {
3723 = gv && (isGV_with_GP(gv))
3726 const char * const direction = have == '>' ? "out" : "in";
3728 if (name && HEK_LEN(name))
3729 Perl_warner(aTHX_ packWARN(WARN_IO),
3730 "Filehandle %"HEKf" opened only for %sput",
3733 Perl_warner(aTHX_ packWARN(WARN_IO),
3734 "Filehandle opened only for %sput", direction);
3739 Perl_report_evil_fh(pTHX_ const GV *gv)
3741 const IO *io = gv ? GvIO(gv) : NULL;
3742 const PERL_BITFIELD16 op = PL_op->op_type;
3746 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3748 warn_type = WARN_CLOSED;
3752 warn_type = WARN_UNOPENED;
3755 if (ckWARN(warn_type)) {
3757 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3758 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3759 const char * const pars =
3760 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3761 const char * const func =
3763 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3764 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3766 const char * const type =
3768 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3769 ? "socket" : "filehandle");
3770 const bool have_name = name && SvCUR(name);
3771 Perl_warner(aTHX_ packWARN(warn_type),
3772 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3773 have_name ? " " : "",
3774 SVfARG(have_name ? name : &PL_sv_no));
3775 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3777 aTHX_ packWARN(warn_type),
3778 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3779 func, pars, have_name ? " " : "",
3780 SVfARG(have_name ? name : &PL_sv_no)
3785 /* To workaround core dumps from the uninitialised tm_zone we get the
3786 * system to give us a reasonable struct to copy. This fix means that
3787 * strftime uses the tm_zone and tm_gmtoff values returned by
3788 * localtime(time()). That should give the desired result most of the
3789 * time. But probably not always!
3791 * This does not address tzname aspects of NETaa14816.
3796 # ifndef STRUCT_TM_HASZONE
3797 # define STRUCT_TM_HASZONE
3801 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3802 # ifndef HAS_TM_TM_ZONE
3803 # define HAS_TM_TM_ZONE
3808 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3810 #ifdef HAS_TM_TM_ZONE
3812 const struct tm* my_tm;
3813 PERL_ARGS_ASSERT_INIT_TM;
3815 my_tm = localtime(&now);
3817 Copy(my_tm, ptm, 1, struct tm);
3819 PERL_ARGS_ASSERT_INIT_TM;
3820 PERL_UNUSED_ARG(ptm);
3825 * mini_mktime - normalise struct tm values without the localtime()
3826 * semantics (and overhead) of mktime().
3829 Perl_mini_mktime(pTHX_ struct tm *ptm)
3833 int month, mday, year, jday;
3834 int odd_cent, odd_year;
3835 PERL_UNUSED_CONTEXT;
3837 PERL_ARGS_ASSERT_MINI_MKTIME;
3839 #define DAYS_PER_YEAR 365
3840 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3841 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3842 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3843 #define SECS_PER_HOUR (60*60)
3844 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3845 /* parentheses deliberately absent on these two, otherwise they don't work */
3846 #define MONTH_TO_DAYS 153/5
3847 #define DAYS_TO_MONTH 5/153
3848 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3849 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3850 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3851 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3854 * Year/day algorithm notes:
3856 * With a suitable offset for numeric value of the month, one can find
3857 * an offset into the year by considering months to have 30.6 (153/5) days,
3858 * using integer arithmetic (i.e., with truncation). To avoid too much
3859 * messing about with leap days, we consider January and February to be
3860 * the 13th and 14th month of the previous year. After that transformation,
3861 * we need the month index we use to be high by 1 from 'normal human' usage,
3862 * so the month index values we use run from 4 through 15.
3864 * Given that, and the rules for the Gregorian calendar (leap years are those
3865 * divisible by 4 unless also divisible by 100, when they must be divisible
3866 * by 400 instead), we can simply calculate the number of days since some
3867 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3868 * the days we derive from our month index, and adding in the day of the
3869 * month. The value used here is not adjusted for the actual origin which
3870 * it normally would use (1 January A.D. 1), since we're not exposing it.
3871 * We're only building the value so we can turn around and get the
3872 * normalised values for the year, month, day-of-month, and day-of-year.
3874 * For going backward, we need to bias the value we're using so that we find
3875 * the right year value. (Basically, we don't want the contribution of
3876 * March 1st to the number to apply while deriving the year). Having done
3877 * that, we 'count up' the contribution to the year number by accounting for
3878 * full quadracenturies (400-year periods) with their extra leap days, plus
3879 * the contribution from full centuries (to avoid counting in the lost leap
3880 * days), plus the contribution from full quad-years (to count in the normal
3881 * leap days), plus the leftover contribution from any non-leap years.
3882 * At this point, if we were working with an actual leap day, we'll have 0
3883 * days left over. This is also true for March 1st, however. So, we have
3884 * to special-case that result, and (earlier) keep track of the 'odd'
3885 * century and year contributions. If we got 4 extra centuries in a qcent,
3886 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3887 * Otherwise, we add back in the earlier bias we removed (the 123 from
3888 * figuring in March 1st), find the month index (integer division by 30.6),
3889 * and the remainder is the day-of-month. We then have to convert back to
3890 * 'real' months (including fixing January and February from being 14/15 in
3891 * the previous year to being in the proper year). After that, to get
3892 * tm_yday, we work with the normalised year and get a new yearday value for
3893 * January 1st, which we subtract from the yearday value we had earlier,
3894 * representing the date we've re-built. This is done from January 1
3895 * because tm_yday is 0-origin.
3897 * Since POSIX time routines are only guaranteed to work for times since the
3898 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3899 * applies Gregorian calendar rules even to dates before the 16th century
3900 * doesn't bother me. Besides, you'd need cultural context for a given
3901 * date to know whether it was Julian or Gregorian calendar, and that's
3902 * outside the scope for this routine. Since we convert back based on the
3903 * same rules we used to build the yearday, you'll only get strange results
3904 * for input which needed normalising, or for the 'odd' century years which
3905 * were leap years in the Julian calendar but not in the Gregorian one.
3906 * I can live with that.
3908 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3909 * that's still outside the scope for POSIX time manipulation, so I don't
3913 year = 1900 + ptm->tm_year;
3914 month = ptm->tm_mon;
3915 mday = ptm->tm_mday;
3921 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3922 yearday += month*MONTH_TO_DAYS + mday + jday;
3924 * Note that we don't know when leap-seconds were or will be,
3925 * so we have to trust the user if we get something which looks
3926 * like a sensible leap-second. Wild values for seconds will
3927 * be rationalised, however.
3929 if ((unsigned) ptm->tm_sec <= 60) {
3936 secs += 60 * ptm->tm_min;
3937 secs += SECS_PER_HOUR * ptm->tm_hour;
3939 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3940 /* got negative remainder, but need positive time */
3941 /* back off an extra day to compensate */
3942 yearday += (secs/SECS_PER_DAY)-1;
3943 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3946 yearday += (secs/SECS_PER_DAY);
3947 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3950 else if (secs >= SECS_PER_DAY) {
3951 yearday += (secs/SECS_PER_DAY);
3952 secs %= SECS_PER_DAY;
3954 ptm->tm_hour = secs/SECS_PER_HOUR;
3955 secs %= SECS_PER_HOUR;
3956 ptm->tm_min = secs/60;
3958 ptm->tm_sec += secs;
3959 /* done with time of day effects */
3961 * The algorithm for yearday has (so far) left it high by 428.
3962 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3963 * bias it by 123 while trying to figure out what year it
3964 * really represents. Even with this tweak, the reverse
3965 * translation fails for years before A.D. 0001.
3966 * It would still fail for Feb 29, but we catch that one below.
3968 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3969 yearday -= YEAR_ADJUST;
3970 year = (yearday / DAYS_PER_QCENT) * 400;
3971 yearday %= DAYS_PER_QCENT;
3972 odd_cent = yearday / DAYS_PER_CENT;
3973 year += odd_cent * 100;
3974 yearday %= DAYS_PER_CENT;
3975 year += (yearday / DAYS_PER_QYEAR) * 4;
3976 yearday %= DAYS_PER_QYEAR;
3977 odd_year = yearday / DAYS_PER_YEAR;
3979 yearday %= DAYS_PER_YEAR;
3980 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3985 yearday += YEAR_ADJUST; /* recover March 1st crock */
3986 month = yearday*DAYS_TO_MONTH;
3987 yearday -= month*MONTH_TO_DAYS;
3988 /* recover other leap-year adjustment */
3997 ptm->tm_year = year - 1900;
3999 ptm->tm_mday = yearday;
4000 ptm->tm_mon = month;
4004 ptm->tm_mon = month - 1;
4006 /* re-build yearday based on Jan 1 to get tm_yday */
4008 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4009 yearday += 14*MONTH_TO_DAYS + 1;
4010 ptm->tm_yday = jday - yearday;
4011 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4015 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)
4023 PERL_ARGS_ASSERT_MY_STRFTIME;
4025 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4028 mytm.tm_hour = hour;
4029 mytm.tm_mday = mday;
4031 mytm.tm_year = year;
4032 mytm.tm_wday = wday;
4033 mytm.tm_yday = yday;
4034 mytm.tm_isdst = isdst;
4036 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4037 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4042 #ifdef HAS_TM_TM_GMTOFF
4043 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4045 #ifdef HAS_TM_TM_ZONE
4046 mytm.tm_zone = mytm2.tm_zone;
4051 Newx(buf, buflen, char);
4052 len = strftime(buf, buflen, fmt, &mytm);
4054 ** The following is needed to handle to the situation where
4055 ** tmpbuf overflows. Basically we want to allocate a buffer
4056 ** and try repeatedly. The reason why it is so complicated
4057 ** is that getting a return value of 0 from strftime can indicate
4058 ** one of the following:
4059 ** 1. buffer overflowed,
4060 ** 2. illegal conversion specifier, or
4061 ** 3. the format string specifies nothing to be returned(not
4062 ** an error). This could be because format is an empty string
4063 ** or it specifies %p that yields an empty string in some locale.
4064 ** If there is a better way to make it portable, go ahead by
4067 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4070 /* Possibly buf overflowed - try again with a bigger buf */
4071 const int fmtlen = strlen(fmt);
4072 int bufsize = fmtlen + buflen;
4074 Renew(buf, bufsize, char);
4076 buflen = strftime(buf, bufsize, fmt, &mytm);
4077 if (buflen > 0 && buflen < bufsize)
4079 /* heuristic to prevent out-of-memory errors */
4080 if (bufsize > 100*fmtlen) {
4086 Renew(buf, bufsize, char);
4091 Perl_croak(aTHX_ "panic: no strftime");
4097 #define SV_CWD_RETURN_UNDEF \
4098 sv_setsv(sv, &PL_sv_undef); \
4101 #define SV_CWD_ISDOT(dp) \
4102 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4103 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4106 =head1 Miscellaneous Functions
4108 =for apidoc getcwd_sv
4110 Fill the sv with current working directory
4115 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4116 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4117 * getcwd(3) if available
4118 * Comments from the orignal:
4119 * This is a faster version of getcwd. It's also more dangerous
4120 * because you might chdir out of a directory that you can't chdir
4124 Perl_getcwd_sv(pTHX_ SV *sv)
4128 #ifndef INCOMPLETE_TAINTS
4132 PERL_ARGS_ASSERT_GETCWD_SV;
4136 char buf[MAXPATHLEN];
4138 /* Some getcwd()s automatically allocate a buffer of the given
4139 * size from the heap if they are given a NULL buffer pointer.
4140 * The problem is that this behaviour is not portable. */
4141 if (getcwd(buf, sizeof(buf) - 1)) {
4146 sv_setsv(sv, &PL_sv_undef);
4154 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4158 SvUPGRADE(sv, SVt_PV);
4160 if (PerlLIO_lstat(".", &statbuf) < 0) {
4161 SV_CWD_RETURN_UNDEF;
4164 orig_cdev = statbuf.st_dev;
4165 orig_cino = statbuf.st_ino;
4175 if (PerlDir_chdir("..") < 0) {
4176 SV_CWD_RETURN_UNDEF;
4178 if (PerlLIO_stat(".", &statbuf) < 0) {
4179 SV_CWD_RETURN_UNDEF;
4182 cdev = statbuf.st_dev;
4183 cino = statbuf.st_ino;
4185 if (odev == cdev && oino == cino) {
4188 if (!(dir = PerlDir_open("."))) {
4189 SV_CWD_RETURN_UNDEF;
4192 while ((dp = PerlDir_read(dir)) != NULL) {
4194 namelen = dp->d_namlen;
4196 namelen = strlen(dp->d_name);
4199 if (SV_CWD_ISDOT(dp)) {
4203 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4204 SV_CWD_RETURN_UNDEF;
4207 tdev = statbuf.st_dev;
4208 tino = statbuf.st_ino;
4209 if (tino == oino && tdev == odev) {
4215 SV_CWD_RETURN_UNDEF;
4218 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4219 SV_CWD_RETURN_UNDEF;
4222 SvGROW(sv, pathlen + namelen + 1);
4226 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4229 /* prepend current directory to the front */
4231 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4232 pathlen += (namelen + 1);
4234 #ifdef VOID_CLOSEDIR
4237 if (PerlDir_close(dir) < 0) {
4238 SV_CWD_RETURN_UNDEF;
4244 SvCUR_set(sv, pathlen);
4248 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4249 SV_CWD_RETURN_UNDEF;
4252 if (PerlLIO_stat(".", &statbuf) < 0) {
4253 SV_CWD_RETURN_UNDEF;
4256 cdev = statbuf.st_dev;
4257 cino = statbuf.st_ino;
4259 if (cdev != orig_cdev || cino != orig_cino) {
4260 Perl_croak(aTHX_ "Unstable directory path, "
4261 "current directory changed unexpectedly");
4272 #define VERSION_MAX 0x7FFFFFFF
4275 =for apidoc prescan_version
4277 Validate that a given string can be parsed as a version object, but doesn't
4278 actually perform the parsing. Can use either strict or lax validation rules.
4279 Can optionally set a number of hint variables to save the parsing code
4280 some time when tokenizing.
4285 Perl_prescan_version(pTHX_ const char *s, bool strict,
4286 const char **errstr,
4287 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4288 bool qv = (sqv ? *sqv : FALSE);
4290 int saw_decimal = 0;
4294 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4296 if (qv && isDIGIT(*d))
4297 goto dotted_decimal_version;
4299 if (*d == 'v') { /* explicit v-string */
4304 else { /* degenerate v-string */
4305 /* requires v1.2.3 */
4306 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4309 dotted_decimal_version:
4310 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4311 /* no leading zeros allowed */
4312 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4315 while (isDIGIT(*d)) /* integer part */
4321 d++; /* decimal point */
4326 /* require v1.2.3 */
4327 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4330 goto version_prescan_finish;
4337 while (isDIGIT(*d)) { /* just keep reading */
4339 while (isDIGIT(*d)) {
4341 /* maximum 3 digits between decimal */
4342 if (strict && j > 3) {
4343 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4348 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4351 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4356 else if (*d == '.') {
4358 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4363 else if (!isDIGIT(*d)) {
4369 if (strict && i < 2) {
4370 /* requires v1.2.3 */
4371 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4374 } /* end if dotted-decimal */
4376 { /* decimal versions */
4377 int j = 0; /* may need this later */
4378 /* special strict case for leading '.' or '0' */
4381 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4383 if (*d == '0' && isDIGIT(d[1])) {
4384 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4388 /* and we never support negative versions */
4390 BADVERSION(s,errstr,"Invalid version format (negative version number)");
4393 /* consume all of the integer part */
4397 /* look for a fractional part */
4399 /* we found it, so consume it */
4403 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4406 BADVERSION(s,errstr,"Invalid version format (version required)");
4408 /* found just an integer */
4409 goto version_prescan_finish;
4411 else if ( d == s ) {
4412 /* didn't find either integer or period */
4413 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4415 else if (*d == '_') {
4416 /* underscore can't come after integer part */
4418 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4420 else if (isDIGIT(d[1])) {
4421 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4424 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4428 /* anything else after integer part is just invalid data */
4429 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4432 /* scan the fractional part after the decimal point*/
4434 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4435 /* strict or lax-but-not-the-end */
4436 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4439 while (isDIGIT(*d)) {
4441 if (*d == '.' && isDIGIT(d[-1])) {
4443 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4446 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4448 d = (char *)s; /* start all over again */
4450 goto dotted_decimal_version;
4454 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4457 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4459 if ( ! isDIGIT(d[1]) ) {
4460 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4469 version_prescan_finish:
4473 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4474 /* trailing non-numeric data */
4475 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4483 *ssaw_decimal = saw_decimal;
4490 =for apidoc scan_version
4492 Returns a pointer to the next character after the parsed
4493 version string, as well as upgrading the passed in SV to
4496 Function must be called with an already existing SV like
4499 s = scan_version(s, SV *sv, bool qv);
4501 Performs some preprocessing to the string to ensure that
4502 it has the correct characteristics of a version. Flags the
4503 object if it contains an underscore (which denotes this
4504 is an alpha version). The boolean qv denotes that the version
4505 should be interpreted as if it had multiple decimals, even if
4512 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4517 const char *errstr = NULL;
4518 int saw_decimal = 0;
4522 AV * const av = newAV();
4523 SV * const hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4525 PERL_ARGS_ASSERT_SCAN_VERSION;
4527 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4529 #ifndef NODEFAULT_SHAREKEYS
4530 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4533 while (isSPACE(*s)) /* leading whitespace is OK */
4536 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4538 /* "undef" is a special case and not an error */
4539 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4540 Perl_croak(aTHX_ "%s", errstr);
4550 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4552 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4553 if ( !qv && width < 3 )
4554 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4556 while (isDIGIT(*pos))
4558 if (!isALPHA(*pos)) {
4564 /* this is atoi() that delimits on underscores */
4565 const char *end = pos;
4569 /* the following if() will only be true after the decimal
4570 * point of a version originally created with a bare
4571 * floating point number, i.e. not quoted in any way
4573 if ( !qv && s > start && saw_decimal == 1 ) {
4577 rev += (*s - '0') * mult;
4579 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4580 || (PERL_ABS(rev) > VERSION_MAX )) {
4581 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4582 "Integer overflow in version %d",VERSION_MAX);
4593 while (--end >= s) {
4595 rev += (*end - '0') * mult;
4597 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4598 || (PERL_ABS(rev) > VERSION_MAX )) {
4599 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4600 "Integer overflow in version");
4609 /* Append revision */
4610 av_push(av, newSViv(rev));
4615 else if ( *pos == '.' )
4617 else if ( *pos == '_' && isDIGIT(pos[1]) )
4619 else if ( *pos == ',' && isDIGIT(pos[1]) )
4621 else if ( isDIGIT(*pos) )
4628 while ( isDIGIT(*pos) )
4633 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4641 if ( qv ) { /* quoted versions always get at least three terms*/
4642 I32 len = av_len(av);
4643 /* This for loop appears to trigger a compiler bug on OS X, as it
4644 loops infinitely. Yes, len is negative. No, it makes no sense.
4645 Compiler in question is:
4646 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4647 for ( len = 2 - len; len > 0; len-- )
4648 av_push(MUTABLE_AV(sv), newSViv(0));
4652 av_push(av, newSViv(0));
4655 /* need to save off the current version string for later */
4657 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4658 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4659 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4661 else if ( s > start ) {
4662 SV * orig = newSVpvn(start,s-start);
4663 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4664 /* need to insert a v to be consistent */
4665 sv_insert(orig, 0, 0, "v", 1);
4667 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4670 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4671 av_push(av, newSViv(0));
4674 /* And finally, store the AV in the hash */
4675 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4677 /* fix RT#19517 - special case 'undef' as string */
4678 if ( *s == 'u' && strEQ(s,"undef") ) {
4686 =for apidoc new_version
4688 Returns a new version object based on the passed in SV:
4690 SV *sv = new_version(SV *ver);
4692 Does not alter the passed in ver SV. See "upg_version" if you
4693 want to upgrade the SV.
4699 Perl_new_version(pTHX_ SV *ver)
4702 SV * const rv = newSV(0);
4703 PERL_ARGS_ASSERT_NEW_VERSION;
4704 if ( sv_isobject(ver) && sv_derived_from(ver, "version") )
4705 /* can just copy directly */
4708 AV * const av = newAV();
4710 /* This will get reblessed later if a derived class*/
4711 SV * const hv = newSVrv(rv, "version");
4712 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4713 #ifndef NODEFAULT_SHAREKEYS
4714 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4720 /* Begin copying all of the elements */
4721 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4722 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4724 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4725 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4727 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4729 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4730 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4733 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4735 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4736 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4739 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4740 /* This will get reblessed later if a derived class*/
4741 for ( key = 0; key <= av_len(sav); key++ )
4743 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4744 av_push(av, newSViv(rev));
4747 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4752 const MAGIC* const mg = SvVSTRING_mg(ver);
4753 if ( mg ) { /* already a v-string */
4754 const STRLEN len = mg->mg_len;
4755 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4756 sv_setpvn(rv,version,len);
4757 /* this is for consistency with the pure Perl class */
4758 if ( isDIGIT(*version) )
4759 sv_insert(rv, 0, 0, "v", 1);
4764 sv_setsv(rv,ver); /* make a duplicate */
4769 return upg_version(rv, FALSE);
4773 =for apidoc upg_version
4775 In-place upgrade of the supplied SV to a version object.
4777 SV *sv = upg_version(SV *sv, bool qv);
4779 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4780 to force this SV to be interpreted as an "extended" version.
4786 Perl_upg_version(pTHX_ SV *ver, bool qv)
4788 const char *version, *s;
4793 PERL_ARGS_ASSERT_UPG_VERSION;
4795 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4799 /* may get too much accuracy */
4801 SV *sv = SvNVX(ver) > 10e50 ? newSV(64) : 0;
4803 #ifdef USE_LOCALE_NUMERIC
4804 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
4805 setlocale(LC_NUMERIC, "C");
4808 Perl_sv_setpvf(aTHX_ sv, "%.9"NVff, SvNVX(ver));
4809 buf = SvPV(sv, len);
4812 len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4815 #ifdef USE_LOCALE_NUMERIC
4816 setlocale(LC_NUMERIC, loc);
4819 while (buf[len-1] == '0' && len > 0) len--;
4820 if ( buf[len-1] == '.' ) len--; /* eat the trailing decimal */
4821 version = savepvn(buf, len);
4825 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4826 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4830 else /* must be a string or something like a string */
4833 version = savepv(SvPV(ver,len));
4835 # if PERL_VERSION > 5
4836 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4837 if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
4838 /* may be a v-string */
4839 char *testv = (char *)version;
4841 for (tlen=0; tlen < len; tlen++, testv++) {
4842 /* if one of the characters is non-text assume v-string */
4843 if (testv[0] < ' ') {
4844 SV * const nsv = sv_newmortal();
4847 int saw_decimal = 0;
4848 sv_setpvf(nsv,"v%vd",ver);
4849 pos = nver = savepv(SvPV_nolen(nsv));
4851 /* scan the resulting formatted string */
4852 pos++; /* skip the leading 'v' */
4853 while ( *pos == '.' || isDIGIT(*pos) ) {
4859 /* is definitely a v-string */
4860 if ( saw_decimal >= 2 ) {
4872 s = scan_version(version, ver, qv);
4874 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4875 "Version string '%s' contains invalid data; "
4876 "ignoring: '%s'", version, s);
4884 Validates that the SV contains valid internal structure for a version object.
4885 It may be passed either the version object (RV) or the hash itself (HV). If
4886 the structure is valid, it returns the HV. If the structure is invalid,
4889 SV *hv = vverify(sv);
4891 Note that it only confirms the bare minimum structure (so as not to get
4892 confused by derived classes which may contain additional hash entries):
4896 =item * The SV is an HV or a reference to an HV
4898 =item * The hash contains a "version" key
4900 =item * The "version" key has a reference to an AV as its value
4908 Perl_vverify(pTHX_ SV *vs)
4912 PERL_ARGS_ASSERT_VVERIFY;
4917 /* see if the appropriate elements exist */
4918 if ( SvTYPE(vs) == SVt_PVHV
4919 && hv_exists(MUTABLE_HV(vs), "version", 7)
4920 && (sv = SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)))
4921 && SvTYPE(sv) == SVt_PVAV )
4930 Accepts a version object and returns the normalized floating
4931 point representation. Call like:
4935 NOTE: you can pass either the object directly or the SV
4936 contained within the RV.
4938 The SV returned has a refcount of 1.
4944 Perl_vnumify(pTHX_ SV *vs)
4952 PERL_ARGS_ASSERT_VNUMIFY;
4954 /* extract the HV from the object */
4957 Perl_croak(aTHX_ "Invalid version object");
4959 /* see if various flags exist */
4960 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
4962 if ( hv_exists(MUTABLE_HV(vs), "width", 5 ) )
4963 width = SvIV(*hv_fetchs(MUTABLE_HV(vs), "width", FALSE));
4968 /* attempt to retrieve the version array */
4969 if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
4970 return newSVpvs("0");
4976 return newSVpvs("0");
4979 digit = SvIV(*av_fetch(av, 0, 0));
4980 sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
4981 for ( i = 1 ; i < len ; i++ )
4983 digit = SvIV(*av_fetch(av, i, 0));
4985 const int denom = (width == 2 ? 10 : 100);
4986 const div_t term = div((int)PERL_ABS(digit),denom);
4987 Perl_sv_catpvf(aTHX_ sv, "%0*d_%d", width, term.quot, term.rem);
4990 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
4996 digit = SvIV(*av_fetch(av, len, 0));
4997 if ( alpha && width == 3 ) /* alpha version */
4999 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
5003 sv_catpvs(sv, "000");
5011 Accepts a version object and returns the normalized string
5012 representation. Call like:
5016 NOTE: you can pass either the object directly or the SV
5017 contained within the RV.
5019 The SV returned has a refcount of 1.
5025 Perl_vnormal(pTHX_ SV *vs)
5032 PERL_ARGS_ASSERT_VNORMAL;
5034 /* extract the HV from the object */
5037 Perl_croak(aTHX_ "Invalid version object");
5039 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
5041 av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
5046 return newSVpvs("");
5048 digit = SvIV(*av_fetch(av, 0, 0));
5049 sv = Perl_newSVpvf(aTHX_ "v%"IVdf, (IV)digit);
5050 for ( i = 1 ; i < len ; i++ ) {
5051 digit = SvIV(*av_fetch(av, i, 0));
5052 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5057 /* handle last digit specially */
5058 digit = SvIV(*av_fetch(av, len, 0));
5060 Perl_sv_catpvf(aTHX_ sv, "_%"IVdf, (IV)digit);
5062 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5065 if ( len <= 2 ) { /* short version, must be at least three */
5066 for ( len = 2 - len; len != 0; len-- )
5073 =for apidoc vstringify
5075 In order to maintain maximum compatibility with earlier versions
5076 of Perl, this function will return either the floating point
5077 notation or the multiple dotted notation, depending on whether
5078 the original version contained 1 or more dots, respectively.
5080 The SV returned has a refcount of 1.
5086 Perl_vstringify(pTHX_ SV *vs)
5088 PERL_ARGS_ASSERT_VSTRINGIFY;
5090 /* extract the HV from the object */
5093 Perl_croak(aTHX_ "Invalid version object");
5095 if (hv_exists(MUTABLE_HV(vs), "original", sizeof("original") - 1)) {
5097 pv = *hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
5101 return &PL_sv_undef;
5104 if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
5114 Version object aware cmp. Both operands must already have been
5115 converted into version objects.
5121 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
5124 bool lalpha = FALSE;
5125 bool ralpha = FALSE;
5130 PERL_ARGS_ASSERT_VCMP;
5132 /* extract the HVs from the objects */
5135 if ( ! ( lhv && rhv ) )
5136 Perl_croak(aTHX_ "Invalid version object");
5138 /* get the left hand term */
5139 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
5140 if ( hv_exists(MUTABLE_HV(lhv), "alpha", 5 ) )
5143 /* and the right hand term */
5144 rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
5145 if ( hv_exists(MUTABLE_HV(rhv), "alpha", 5 ) )
5153 while ( i <= m && retval == 0 )
5155 left = SvIV(*av_fetch(lav,i,0));
5156 right = SvIV(*av_fetch(rav,i,0));
5164 /* tiebreaker for alpha with identical terms */
5165 if ( retval == 0 && l == r && left == right && ( lalpha || ralpha ) )
5167 if ( lalpha && !ralpha )
5171 else if ( ralpha && !lalpha)
5177 if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
5181 while ( i <= r && retval == 0 )
5183 if ( SvIV(*av_fetch(rav,i,0)) != 0 )
5184 retval = -1; /* not a match after all */
5190 while ( i <= l && retval == 0 )
5192 if ( SvIV(*av_fetch(lav,i,0)) != 0 )
5193 retval = +1; /* not a match after all */
5201 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
5202 # define EMULATE_SOCKETPAIR_UDP
5205 #ifdef EMULATE_SOCKETPAIR_UDP
5207 S_socketpair_udp (int fd[2]) {
5209 /* Fake a datagram socketpair using UDP to localhost. */
5210 int sockets[2] = {-1, -1};
5211 struct sockaddr_in addresses[2];
5213 Sock_size_t size = sizeof(struct sockaddr_in);
5214 unsigned short port;
5217 memset(&addresses, 0, sizeof(addresses));
5220 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
5221 if (sockets[i] == -1)
5222 goto tidy_up_and_fail;
5224 addresses[i].sin_family = AF_INET;
5225 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5226 addresses[i].sin_port = 0; /* kernel choses port. */
5227 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
5228 sizeof(struct sockaddr_in)) == -1)
5229 goto tidy_up_and_fail;
5232 /* Now have 2 UDP sockets. Find out which port each is connected to, and
5233 for each connect the other socket to it. */
5236 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
5238 goto tidy_up_and_fail;
5239 if (size != sizeof(struct sockaddr_in))
5240 goto abort_tidy_up_and_fail;
5241 /* !1 is 0, !0 is 1 */
5242 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
5243 sizeof(struct sockaddr_in)) == -1)
5244 goto tidy_up_and_fail;
5247 /* Now we have 2 sockets connected to each other. I don't trust some other
5248 process not to have already sent a packet to us (by random) so send
5249 a packet from each to the other. */
5252 /* I'm going to send my own port number. As a short.
5253 (Who knows if someone somewhere has sin_port as a bitfield and needs
5254 this routine. (I'm assuming crays have socketpair)) */
5255 port = addresses[i].sin_port;
5256 got = PerlLIO_write(sockets[i], &port, sizeof(port));
5257 if (got != sizeof(port)) {
5259 goto tidy_up_and_fail;
5260 goto abort_tidy_up_and_fail;
5264 /* Packets sent. I don't trust them to have arrived though.
5265 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
5266 connect to localhost will use a second kernel thread. In 2.6 the
5267 first thread running the connect() returns before the second completes,
5268 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
5269 returns 0. Poor programs have tripped up. One poor program's authors'
5270 had a 50-1 reverse stock split. Not sure how connected these were.)
5271 So I don't trust someone not to have an unpredictable UDP stack.
5275 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
5276 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
5280 FD_SET((unsigned int)sockets[0], &rset);
5281 FD_SET((unsigned int)sockets[1], &rset);
5283 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
5284 if (got != 2 || !FD_ISSET(sockets[0], &rset)
5285 || !FD_ISSET(sockets[1], &rset)) {
5286 /* I hope this is portable and appropriate. */
5288 goto tidy_up_and_fail;
5289 goto abort_tidy_up_and_fail;
5293 /* And the paranoia department even now doesn't trust it to have arrive
5294 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
5296 struct sockaddr_in readfrom;
5297 unsigned short buffer[2];
5302 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5303 sizeof(buffer), MSG_DONTWAIT,
5304 (struct sockaddr *) &readfrom, &size);
5306 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5308 (struct sockaddr *) &readfrom, &size);
5312 goto tidy_up_and_fail;
5313 if (got != sizeof(port)
5314 || size != sizeof(struct sockaddr_in)
5315 /* Check other socket sent us its port. */
5316 || buffer[0] != (unsigned short) addresses[!i].sin_port
5317 /* Check kernel says we got the datagram from that socket */
5318 || readfrom.sin_family != addresses[!i].sin_family
5319 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
5320 || readfrom.sin_port != addresses[!i].sin_port)
5321 goto abort_tidy_up_and_fail;
5324 /* My caller (my_socketpair) has validated that this is non-NULL */
5327 /* I hereby declare this connection open. May God bless all who cross
5331 abort_tidy_up_and_fail:
5332 errno = ECONNABORTED;
5336 if (sockets[0] != -1)
5337 PerlLIO_close(sockets[0]);
5338 if (sockets[1] != -1)
5339 PerlLIO_close(sockets[1]);
5344 #endif /* EMULATE_SOCKETPAIR_UDP */
5346 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
5348 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5349 /* Stevens says that family must be AF_LOCAL, protocol 0.
5350 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
5355 struct sockaddr_in listen_addr;
5356 struct sockaddr_in connect_addr;
5361 || family != AF_UNIX
5364 errno = EAFNOSUPPORT;
5372 #ifdef EMULATE_SOCKETPAIR_UDP
5373 if (type == SOCK_DGRAM)
5374 return S_socketpair_udp(fd);
5377 aTHXa(PERL_GET_THX);
5378 listener = PerlSock_socket(AF_INET, type, 0);
5381 memset(&listen_addr, 0, sizeof(listen_addr));
5382 listen_addr.sin_family = AF_INET;
5383 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5384 listen_addr.sin_port = 0; /* kernel choses port. */
5385 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
5386 sizeof(listen_addr)) == -1)
5387 goto tidy_up_and_fail;
5388 if (PerlSock_listen(listener, 1) == -1)
5389 goto tidy_up_and_fail;
5391 connector = PerlSock_socket(AF_INET, type, 0);
5392 if (connector == -1)
5393 goto tidy_up_and_fail;
5394 /* We want to find out the port number to connect to. */
5395 size = sizeof(connect_addr);
5396 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
5398 goto tidy_up_and_fail;
5399 if (size != sizeof(connect_addr))
5400 goto abort_tidy_up_and_fail;
5401 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
5402 sizeof(connect_addr)) == -1)
5403 goto tidy_up_and_fail;
5405 size = sizeof(listen_addr);
5406 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
5409 goto tidy_up_and_fail;
5410 if (size != sizeof(listen_addr))
5411 goto abort_tidy_up_and_fail;
5412 PerlLIO_close(listener);
5413 /* Now check we are talking to ourself by matching port and host on the
5415 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
5417 goto tidy_up_and_fail;
5418 if (size != sizeof(connect_addr)
5419 || listen_addr.sin_family != connect_addr.sin_family
5420 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
5421 || listen_addr.sin_port != connect_addr.sin_port) {
5422 goto abort_tidy_up_and_fail;
5428 abort_tidy_up_and_fail:
5430 errno = ECONNABORTED; /* This would be the standard thing to do. */
5432 # ifdef ECONNREFUSED
5433 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
5435 errno = ETIMEDOUT; /* Desperation time. */
5442 PerlLIO_close(listener);
5443 if (connector != -1)
5444 PerlLIO_close(connector);
5446 PerlLIO_close(acceptor);
5452 /* In any case have a stub so that there's code corresponding
5453 * to the my_socketpair in embed.fnc. */
5455 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5456 #ifdef HAS_SOCKETPAIR
5457 return socketpair(family, type, protocol, fd);
5466 =for apidoc sv_nosharing
5468 Dummy routine which "shares" an SV when there is no sharing module present.
5469 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
5470 Exists to avoid test for a NULL function pointer and because it could
5471 potentially warn under some level of strict-ness.
5477 Perl_sv_nosharing(pTHX_ SV *sv)
5479 PERL_UNUSED_CONTEXT;
5480 PERL_UNUSED_ARG(sv);
5485 =for apidoc sv_destroyable
5487 Dummy routine which reports that object can be destroyed when there is no
5488 sharing module present. It ignores its single SV argument, and returns
5489 'true'. Exists to avoid test for a NULL function pointer and because it
5490 could potentially warn under some level of strict-ness.
5496 Perl_sv_destroyable(pTHX_ SV *sv)
5498 PERL_UNUSED_CONTEXT;
5499 PERL_UNUSED_ARG(sv);
5504 Perl_parse_unicode_opts(pTHX_ const char **popt)
5506 const char *p = *popt;
5509 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
5513 opt = (U32) atoi(p);
5516 if (*p && *p != '\n' && *p != '\r') {
5517 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5519 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
5525 case PERL_UNICODE_STDIN:
5526 opt |= PERL_UNICODE_STDIN_FLAG; break;
5527 case PERL_UNICODE_STDOUT:
5528 opt |= PERL_UNICODE_STDOUT_FLAG; break;
5529 case PERL_UNICODE_STDERR:
5530 opt |= PERL_UNICODE_STDERR_FLAG; break;
5531 case PERL_UNICODE_STD:
5532 opt |= PERL_UNICODE_STD_FLAG; break;
5533 case PERL_UNICODE_IN:
5534 opt |= PERL_UNICODE_IN_FLAG; break;
5535 case PERL_UNICODE_OUT:
5536 opt |= PERL_UNICODE_OUT_FLAG; break;
5537 case PERL_UNICODE_INOUT:
5538 opt |= PERL_UNICODE_INOUT_FLAG; break;
5539 case PERL_UNICODE_LOCALE:
5540 opt |= PERL_UNICODE_LOCALE_FLAG; break;
5541 case PERL_UNICODE_ARGV:
5542 opt |= PERL_UNICODE_ARGV_FLAG; break;
5543 case PERL_UNICODE_UTF8CACHEASSERT:
5544 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
5546 if (*p != '\n' && *p != '\r') {
5547 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5550 "Unknown Unicode option letter '%c'", *p);
5557 opt = PERL_UNICODE_DEFAULT_FLAGS;
5559 the_end_of_the_opts_parser:
5561 if (opt & ~PERL_UNICODE_ALL_FLAGS)
5562 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
5563 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
5571 # include <starlet.h>
5579 * This is really just a quick hack which grabs various garbage
5580 * values. It really should be a real hash algorithm which
5581 * spreads the effect of every input bit onto every output bit,
5582 * if someone who knows about such things would bother to write it.
5583 * Might be a good idea to add that function to CORE as well.
5584 * No numbers below come from careful analysis or anything here,
5585 * except they are primes and SEED_C1 > 1E6 to get a full-width
5586 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
5587 * probably be bigger too.
5590 # define SEED_C1 1000003
5591 #define SEED_C4 73819
5593 # define SEED_C1 25747
5594 #define SEED_C4 20639
5598 #define SEED_C5 26107
5600 #ifndef PERL_NO_DEV_RANDOM
5605 /* when[] = (low 32 bits, high 32 bits) of time since epoch
5606 * in 100-ns units, typically incremented ever 10 ms. */
5607 unsigned int when[2];
5609 # ifdef HAS_GETTIMEOFDAY
5610 struct timeval when;
5616 /* This test is an escape hatch, this symbol isn't set by Configure. */
5617 #ifndef PERL_NO_DEV_RANDOM
5618 #ifndef PERL_RANDOM_DEVICE
5619 /* /dev/random isn't used by default because reads from it will block
5620 * if there isn't enough entropy available. You can compile with
5621 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
5622 * is enough real entropy to fill the seed. */
5623 # define PERL_RANDOM_DEVICE "/dev/urandom"
5625 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
5627 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
5636 _ckvmssts(sys$gettim(when));
5637 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
5639 # ifdef HAS_GETTIMEOFDAY
5640 PerlProc_gettimeofday(&when,NULL);
5641 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
5644 u = (U32)SEED_C1 * when;
5647 u += SEED_C3 * (U32)PerlProc_getpid();
5648 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
5649 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
5650 u += SEED_C5 * (U32)PTR2UV(&when);
5656 Perl_get_hash_seed(pTHX_ unsigned char *seed_buffer)
5660 const unsigned char * const end= seed_buffer + PERL_HASH_SEED_BYTES;
5662 PERL_ARGS_ASSERT_GET_HASH_SEED;
5664 s= PerlEnv_getenv("PERL_HASH_SEED");
5667 #ifndef USE_HASH_SEED_EXPLICIT
5671 if (s[0] == '0' && s[1] == 'x')
5674 while (isXDIGIT(*s) && seed_buffer < end) {
5675 *seed_buffer = READ_XDIGIT(s) << 4;
5677 *seed_buffer |= READ_XDIGIT(s);
5683 if (*s && !isXDIGIT(*s)) {
5684 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
5686 /* should we check for unparsed crap? */
5691 (void)seedDrand01((Rand_seed_t)seed());
5693 while (seed_buffer < end) {
5694 *seed_buffer++ = (unsigned char)(Drand01() * (U8_MAX+1));
5699 #ifdef PERL_GLOBAL_STRUCT
5701 #define PERL_GLOBAL_STRUCT_INIT
5702 #include "opcode.h" /* the ppaddr and check */
5705 Perl_init_global_struct(pTHX)
5707 struct perl_vars *plvarsp = NULL;
5708 # ifdef PERL_GLOBAL_STRUCT
5709 const IV nppaddr = sizeof(Gppaddr)/sizeof(Perl_ppaddr_t);
5710 const IV ncheck = sizeof(Gcheck) /sizeof(Perl_check_t);
5711 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5712 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
5713 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
5717 plvarsp = PL_VarsPtr;
5718 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
5723 # define PERLVAR(prefix,var,type) /**/
5724 # define PERLVARA(prefix,var,n,type) /**/
5725 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
5726 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
5727 # include "perlvars.h"
5732 # ifdef PERL_GLOBAL_STRUCT
5735 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
5736 if (!plvarsp->Gppaddr)
5740 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
5741 if (!plvarsp->Gcheck)
5743 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
5744 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
5746 # ifdef PERL_SET_VARS
5747 PERL_SET_VARS(plvarsp);
5749 # undef PERL_GLOBAL_STRUCT_INIT
5754 #endif /* PERL_GLOBAL_STRUCT */
5756 #ifdef PERL_GLOBAL_STRUCT
5759 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
5761 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
5762 # ifdef PERL_GLOBAL_STRUCT
5763 # ifdef PERL_UNSET_VARS
5764 PERL_UNSET_VARS(plvarsp);
5766 free(plvarsp->Gppaddr);
5767 free(plvarsp->Gcheck);
5768 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5774 #endif /* PERL_GLOBAL_STRUCT */
5778 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
5779 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5780 * given, and you supply your own implementation.
5782 * The default implementation reads a single env var, PERL_MEM_LOG,
5783 * expecting one or more of the following:
5785 * \d+ - fd fd to write to : must be 1st (atoi)
5786 * 'm' - memlog was PERL_MEM_LOG=1
5787 * 's' - svlog was PERL_SV_LOG=1
5788 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5790 * This makes the logger controllable enough that it can reasonably be
5791 * added to the system perl.
5794 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5795 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5797 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
5799 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5800 * writes to. In the default logger, this is settable at runtime.
5802 #ifndef PERL_MEM_LOG_FD
5803 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5806 #ifndef PERL_MEM_LOG_NOIMPL
5808 # ifdef DEBUG_LEAKING_SCALARS
5809 # define SV_LOG_SERIAL_FMT " [%lu]"
5810 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5812 # define SV_LOG_SERIAL_FMT
5813 # define _SV_LOG_SERIAL_ARG(sv)
5817 S_mem_log_common(enum mem_log_type mlt, const UV n,
5818 const UV typesize, const char *type_name, const SV *sv,
5819 Malloc_t oldalloc, Malloc_t newalloc,
5820 const char *filename, const int linenumber,
5821 const char *funcname)
5825 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5827 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5830 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5832 /* We can't use SVs or PerlIO for obvious reasons,
5833 * so we'll use stdio and low-level IO instead. */
5834 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5836 # ifdef HAS_GETTIMEOFDAY
5837 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5838 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5840 gettimeofday(&tv, 0);
5842 # define MEM_LOG_TIME_FMT "%10d: "
5843 # define MEM_LOG_TIME_ARG (int)when
5847 /* If there are other OS specific ways of hires time than
5848 * gettimeofday() (see ext/Time-HiRes), the easiest way is
5849 * probably that they would be used to fill in the struct
5853 int fd = atoi(pmlenv);
5855 fd = PERL_MEM_LOG_FD;
5857 if (strchr(pmlenv, 't')) {
5858 len = my_snprintf(buf, sizeof(buf),
5859 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5860 PerlLIO_write(fd, buf, len);
5864 len = my_snprintf(buf, sizeof(buf),
5865 "alloc: %s:%d:%s: %"IVdf" %"UVuf
5866 " %s = %"IVdf": %"UVxf"\n",
5867 filename, linenumber, funcname, n, typesize,
5868 type_name, n * typesize, PTR2UV(newalloc));
5871 len = my_snprintf(buf, sizeof(buf),
5872 "realloc: %s:%d:%s: %"IVdf" %"UVuf
5873 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
5874 filename, linenumber, funcname, n, typesize,
5875 type_name, n * typesize, PTR2UV(oldalloc),
5879 len = my_snprintf(buf, sizeof(buf),
5880 "free: %s:%d:%s: %"UVxf"\n",
5881 filename, linenumber, funcname,
5886 len = my_snprintf(buf, sizeof(buf),
5887 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
5888 mlt == MLT_NEW_SV ? "new" : "del",
5889 filename, linenumber, funcname,
5890 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5895 PerlLIO_write(fd, buf, len);
5899 #endif /* !PERL_MEM_LOG_NOIMPL */
5901 #ifndef PERL_MEM_LOG_NOIMPL
5903 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5904 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5906 /* this is suboptimal, but bug compatible. User is providing their
5907 own implementation, but is getting these functions anyway, and they
5908 do nothing. But _NOIMPL users should be able to cope or fix */
5910 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5911 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5915 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5917 const char *filename, const int linenumber,
5918 const char *funcname)
5920 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5921 NULL, NULL, newalloc,
5922 filename, linenumber, funcname);
5927 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5928 Malloc_t oldalloc, Malloc_t newalloc,
5929 const char *filename, const int linenumber,
5930 const char *funcname)
5932 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5933 NULL, oldalloc, newalloc,
5934 filename, linenumber, funcname);
5939 Perl_mem_log_free(Malloc_t oldalloc,
5940 const char *filename, const int linenumber,
5941 const char *funcname)
5943 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5944 filename, linenumber, funcname);
5949 Perl_mem_log_new_sv(const SV *sv,
5950 const char *filename, const int linenumber,
5951 const char *funcname)
5953 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5954 filename, linenumber, funcname);
5958 Perl_mem_log_del_sv(const SV *sv,
5959 const char *filename, const int linenumber,
5960 const char *funcname)
5962 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5963 filename, linenumber, funcname);
5966 #endif /* PERL_MEM_LOG */
5969 =for apidoc my_sprintf
5971 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5972 the length of the string written to the buffer. Only rare pre-ANSI systems
5973 need the wrapper function - usually this is a direct call to C<sprintf>.
5977 #ifndef SPRINTF_RETURNS_STRLEN
5979 Perl_my_sprintf(char *buffer, const char* pat, ...)
5982 PERL_ARGS_ASSERT_MY_SPRINTF;
5983 va_start(args, pat);
5984 vsprintf(buffer, pat, args);
5986 return strlen(buffer);
5991 =for apidoc my_snprintf
5993 The C library C<snprintf> functionality, if available and
5994 standards-compliant (uses C<vsnprintf>, actually). However, if the
5995 C<vsnprintf> is not available, will unfortunately use the unsafe
5996 C<vsprintf> which can overrun the buffer (there is an overrun check,
5997 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5998 getting C<vsnprintf>.
6003 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
6007 PERL_ARGS_ASSERT_MY_SNPRINTF;
6008 va_start(ap, format);
6009 #ifdef HAS_VSNPRINTF
6010 retval = vsnprintf(buffer, len, format, ap);
6012 retval = vsprintf(buffer, format, ap);
6015 /* vsprintf() shows failure with < 0 */
6017 #ifdef HAS_VSNPRINTF
6018 /* vsnprintf() shows failure with >= len */
6020 (len > 0 && (Size_t)retval >= len)
6023 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
6028 =for apidoc my_vsnprintf
6030 The C library C<vsnprintf> if available and standards-compliant.
6031 However, if if the C<vsnprintf> is not available, will unfortunately
6032 use the unsafe C<vsprintf> which can overrun the buffer (there is an
6033 overrun check, but that may be too late). Consider using
6034 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
6039 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
6045 PERL_ARGS_ASSERT_MY_VSNPRINTF;
6047 Perl_va_copy(ap, apc);
6048 # ifdef HAS_VSNPRINTF
6049 retval = vsnprintf(buffer, len, format, apc);
6051 retval = vsprintf(buffer, format, apc);
6054 # ifdef HAS_VSNPRINTF
6055 retval = vsnprintf(buffer, len, format, ap);
6057 retval = vsprintf(buffer, format, ap);
6059 #endif /* #ifdef NEED_VA_COPY */
6060 /* vsprintf() shows failure with < 0 */
6062 #ifdef HAS_VSNPRINTF
6063 /* vsnprintf() shows failure with >= len */
6065 (len > 0 && (Size_t)retval >= len)
6068 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
6073 Perl_my_clearenv(pTHX)
6076 #if ! defined(PERL_MICRO)
6077 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
6079 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
6080 # if defined(USE_ENVIRON_ARRAY)
6081 # if defined(USE_ITHREADS)
6082 /* only the parent thread can clobber the process environment */
6083 if (PL_curinterp == aTHX)
6084 # endif /* USE_ITHREADS */
6086 # if ! defined(PERL_USE_SAFE_PUTENV)
6087 if ( !PL_use_safe_putenv) {
6089 if (environ == PL_origenviron)
6090 environ = (char**)safesysmalloc(sizeof(char*));
6092 for (i = 0; environ[i]; i++)
6093 (void)safesysfree(environ[i]);
6096 # else /* PERL_USE_SAFE_PUTENV */
6097 # if defined(HAS_CLEARENV)
6099 # elif defined(HAS_UNSETENV)
6100 int bsiz = 80; /* Most envvar names will be shorter than this. */
6101 int bufsiz = bsiz * sizeof(char); /* sizeof(char) paranoid? */
6102 char *buf = (char*)safesysmalloc(bufsiz);
6103 while (*environ != NULL) {
6104 char *e = strchr(*environ, '=');
6105 int l = e ? e - *environ : (int)strlen(*environ);
6107 (void)safesysfree(buf);
6108 bsiz = l + 1; /* + 1 for the \0. */
6109 buf = (char*)safesysmalloc(bufsiz);
6111 memcpy(buf, *environ, l);
6113 (void)unsetenv(buf);
6115 (void)safesysfree(buf);
6116 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
6117 /* Just null environ and accept the leakage. */
6119 # endif /* HAS_CLEARENV || HAS_UNSETENV */
6120 # endif /* ! PERL_USE_SAFE_PUTENV */
6122 # endif /* USE_ENVIRON_ARRAY */
6123 # endif /* PERL_IMPLICIT_SYS || WIN32 */
6124 #endif /* PERL_MICRO */
6127 #ifdef PERL_IMPLICIT_CONTEXT
6129 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
6130 the global PL_my_cxt_index is incremented, and that value is assigned to
6131 that module's static my_cxt_index (who's address is passed as an arg).
6132 Then, for each interpreter this function is called for, it makes sure a
6133 void* slot is available to hang the static data off, by allocating or
6134 extending the interpreter's PL_my_cxt_list array */
6136 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
6138 Perl_my_cxt_init(pTHX_ int *index, size_t size)
6142 PERL_ARGS_ASSERT_MY_CXT_INIT;
6144 /* this module hasn't been allocated an index yet */
6145 #if defined(USE_ITHREADS)
6146 MUTEX_LOCK(&PL_my_ctx_mutex);
6148 *index = PL_my_cxt_index++;
6149 #if defined(USE_ITHREADS)
6150 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6154 /* make sure the array is big enough */
6155 if (PL_my_cxt_size <= *index) {
6156 if (PL_my_cxt_size) {
6157 while (PL_my_cxt_size <= *index)
6158 PL_my_cxt_size *= 2;
6159 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6162 PL_my_cxt_size = 16;
6163 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6166 /* newSV() allocates one more than needed */
6167 p = (void*)SvPVX(newSV(size-1));
6168 PL_my_cxt_list[*index] = p;
6169 Zero(p, size, char);
6173 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6176 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
6181 PERL_ARGS_ASSERT_MY_CXT_INDEX;
6183 for (index = 0; index < PL_my_cxt_index; index++) {
6184 const char *key = PL_my_cxt_keys[index];
6185 /* try direct pointer compare first - there are chances to success,
6186 * and it's much faster.
6188 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
6195 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
6201 PERL_ARGS_ASSERT_MY_CXT_INIT;
6203 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
6205 /* this module hasn't been allocated an index yet */
6206 #if defined(USE_ITHREADS)
6207 MUTEX_LOCK(&PL_my_ctx_mutex);
6209 index = PL_my_cxt_index++;
6210 #if defined(USE_ITHREADS)
6211 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6215 /* make sure the array is big enough */
6216 if (PL_my_cxt_size <= index) {
6217 int old_size = PL_my_cxt_size;
6219 if (PL_my_cxt_size) {
6220 while (PL_my_cxt_size <= index)
6221 PL_my_cxt_size *= 2;
6222 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6223 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6226 PL_my_cxt_size = 16;
6227 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6228 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6230 for (i = old_size; i < PL_my_cxt_size; i++) {
6231 PL_my_cxt_keys[i] = 0;
6232 PL_my_cxt_list[i] = 0;
6235 PL_my_cxt_keys[index] = my_cxt_key;
6236 /* newSV() allocates one more than needed */
6237 p = (void*)SvPVX(newSV(size-1));
6238 PL_my_cxt_list[index] = p;
6239 Zero(p, size, char);
6242 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6243 #endif /* PERL_IMPLICIT_CONTEXT */
6246 Perl_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
6250 const char *vn = NULL;
6251 SV *const module = PL_stack_base[ax];
6253 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
6255 if (items >= 2) /* version supplied as bootstrap arg */
6256 sv = PL_stack_base[ax + 1];
6258 /* XXX GV_ADDWARN */
6260 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
6261 if (!sv || !SvOK(sv)) {
6263 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
6267 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
6268 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
6269 ? sv : sv_2mortal(new_version(sv));
6270 xssv = upg_version(xssv, 0);
6271 if ( vcmp(pmsv,xssv) ) {
6272 SV *string = vstringify(xssv);
6273 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
6274 " does not match ", module, string);
6276 SvREFCNT_dec(string);
6277 string = vstringify(pmsv);
6280 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, module, vn,
6283 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, string);
6285 SvREFCNT_dec(string);
6287 Perl_sv_2mortal(aTHX_ xpt);
6288 Perl_croak_sv(aTHX_ xpt);
6294 Perl_xs_apiversion_bootcheck(pTHX_ SV *module, const char *api_p,
6298 SV *compver = Perl_newSVpvn_flags(aTHX_ api_p, api_len, SVs_TEMP);
6301 PERL_ARGS_ASSERT_XS_APIVERSION_BOOTCHECK;
6303 /* This might croak */
6304 compver = upg_version(compver, 0);
6305 /* This should never croak */
6306 runver = new_version(PL_apiversion);
6307 if (vcmp(compver, runver)) {
6308 SV *compver_string = vstringify(compver);
6309 SV *runver_string = vstringify(runver);
6310 xpt = Perl_newSVpvf(aTHX_ "Perl API version %"SVf
6311 " of %"SVf" does not match %"SVf,
6312 compver_string, module, runver_string);
6313 Perl_sv_2mortal(aTHX_ xpt);
6315 SvREFCNT_dec(compver_string);
6316 SvREFCNT_dec(runver_string);
6318 SvREFCNT_dec(runver);
6320 Perl_croak_sv(aTHX_ xpt);
6325 Perl_my_strlcat(char *dst, const char *src, Size_t size)
6327 Size_t used, length, copy;
6330 length = strlen(src);
6331 if (size > 0 && used < size - 1) {
6332 copy = (length >= size - used) ? size - used - 1 : length;
6333 memcpy(dst + used, src, copy);
6334 dst[used + copy] = '\0';
6336 return used + length;
6342 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
6344 Size_t length, copy;
6346 length = strlen(src);
6348 copy = (length >= size) ? size - 1 : length;
6349 memcpy(dst, src, copy);
6356 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
6357 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
6358 long _ftol( double ); /* Defined by VC6 C libs. */
6359 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
6362 PERL_STATIC_INLINE bool
6363 S_gv_has_usable_name(pTHX_ GV *gv)
6367 && HvENAME(GvSTASH(gv))
6368 && (gvp = (GV **)hv_fetch(
6369 GvSTASH(gv), GvNAME(gv),
6370 GvNAMEUTF8(gv) ? -GvNAMELEN(gv) : GvNAMELEN(gv), 0
6376 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
6379 SV * const dbsv = GvSVn(PL_DBsub);
6380 const bool save_taint = TAINT_get; /* Accepted unused var warning under NO_TAINT_SUPPORT */
6382 /* When we are called from pp_goto (svp is null),
6383 * we do not care about using dbsv to call CV;
6384 * it's for informational purposes only.
6387 PERL_ARGS_ASSERT_GET_DB_SUB;
6391 if (!PERLDB_SUB_NN) {
6395 gv_efullname3(dbsv, gv, NULL);
6397 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED))
6398 || strEQ(GvNAME(gv), "END")
6399 || ( /* Could be imported, and old sub redefined. */
6400 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
6402 !( (SvTYPE(*svp) == SVt_PVGV)
6403 && (GvCV((const GV *)*svp) == cv)
6404 /* Use GV from the stack as a fallback. */
6405 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
6409 /* GV is potentially non-unique, or contain different CV. */
6410 SV * const tmp = newRV(MUTABLE_SV(cv));
6411 sv_setsv(dbsv, tmp);
6415 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
6416 sv_catpvs(dbsv, "::");
6418 dbsv, GvNAME(gv), GvNAMELEN(gv),
6419 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
6424 const int type = SvTYPE(dbsv);
6425 if (type < SVt_PVIV && type != SVt_IV)
6426 sv_upgrade(dbsv, SVt_PVIV);
6427 (void)SvIOK_on(dbsv);
6428 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
6430 TAINT_IF(save_taint);
6434 Perl_my_dirfd(pTHX_ DIR * dir) {
6436 /* Most dirfd implementations have problems when passed NULL. */
6441 #elif defined(HAS_DIR_DD_FD)
6444 Perl_die(aTHX_ PL_no_func, "dirfd");
6445 assert(0); /* NOT REACHED */
6451 Perl_get_re_arg(pTHX_ SV *sv) {
6457 sv = MUTABLE_SV(SvRV(sv));
6458 if (SvTYPE(sv) == SVt_REGEXP)
6459 return (REGEXP*) sv;
6467 * c-indentation-style: bsd
6469 * indent-tabs-mode: nil
6472 * ex: set ts=8 sts=4 sw=4 et: