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
31 # define SIG_ERR ((Sighandler_t) -1)
36 /* Missing protos on LynxOS */
41 # include <sys/wait.h>
46 # include <sys/select.h>
52 #if defined(HAS_FCNTL) && defined(F_SETFD) && !defined(FD_CLOEXEC)
53 # define FD_CLOEXEC 1 /* NeXT needs this */
56 /* NOTE: Do not call the next three routines directly. Use the macros
57 * in handy.h, so that we can easily redefine everything to do tracking of
58 * allocated hunks back to the original New to track down any memory leaks.
59 * XXX This advice seems to be widely ignored :-( --AD August 1996.
66 /* Can't use PerlIO to write as it allocates memory */
67 PerlLIO_write(PerlIO_fileno(Perl_error_log),
68 PL_no_mem, strlen(PL_no_mem));
70 NORETURN_FUNCTION_END;
73 /* paranoid version of system's malloc() */
76 Perl_safesysmalloc(MEM_SIZE size)
84 PerlIO_printf(Perl_error_log,
85 "Allocation too large: %lx\n", size) FLUSH;
88 #endif /* HAS_64K_LIMIT */
89 #ifdef PERL_TRACK_MEMPOOL
94 Perl_croak_nocontext("panic: malloc");
96 ptr = (Malloc_t)PerlMem_malloc(size?size:1); /* malloc(0) is NASTY on our system */
97 PERL_ALLOC_CHECK(ptr);
98 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
100 #ifdef PERL_TRACK_MEMPOOL
101 struct perl_memory_debug_header *const header
102 = (struct perl_memory_debug_header *)ptr;
106 PoisonNew(((char *)ptr), size, char);
109 #ifdef PERL_TRACK_MEMPOOL
110 header->interpreter = aTHX;
111 /* Link us into the list. */
112 header->prev = &PL_memory_debug_header;
113 header->next = PL_memory_debug_header.next;
114 PL_memory_debug_header.next = header;
115 header->next->prev = header;
119 ptr = (Malloc_t)((char*)ptr+sTHX);
130 return write_no_mem();
136 /* paranoid version of system's realloc() */
139 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
145 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
146 Malloc_t PerlMem_realloc();
147 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
151 PerlIO_printf(Perl_error_log,
152 "Reallocation too large: %lx\n", size) FLUSH;
155 #endif /* HAS_64K_LIMIT */
162 return safesysmalloc(size);
163 #ifdef PERL_TRACK_MEMPOOL
164 where = (Malloc_t)((char*)where-sTHX);
167 struct perl_memory_debug_header *const header
168 = (struct perl_memory_debug_header *)where;
170 if (header->interpreter != aTHX) {
171 Perl_croak_nocontext("panic: realloc from wrong pool");
173 assert(header->next->prev == header);
174 assert(header->prev->next == header);
176 if (header->size > size) {
177 const MEM_SIZE freed_up = header->size - size;
178 char *start_of_freed = ((char *)where) + size;
179 PoisonFree(start_of_freed, freed_up, char);
187 Perl_croak_nocontext("panic: realloc");
189 ptr = (Malloc_t)PerlMem_realloc(where,size);
190 PERL_ALLOC_CHECK(ptr);
192 /* MUST do this fixup first, before doing ANYTHING else, as anything else
193 might allocate memory/free/move memory, and until we do the fixup, it
194 may well be chasing (and writing to) free memory. */
195 #ifdef PERL_TRACK_MEMPOOL
197 struct perl_memory_debug_header *const header
198 = (struct perl_memory_debug_header *)ptr;
201 if (header->size < size) {
202 const MEM_SIZE fresh = size - header->size;
203 char *start_of_fresh = ((char *)ptr) + size;
204 PoisonNew(start_of_fresh, fresh, char);
208 header->next->prev = header;
209 header->prev->next = header;
211 ptr = (Malloc_t)((char*)ptr+sTHX);
215 /* In particular, must do that fixup above before logging anything via
216 *printf(), as it can reallocate memory, which can cause SEGVs. */
218 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
219 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
232 return write_no_mem();
238 /* safe version of system's free() */
241 Perl_safesysfree(Malloc_t where)
243 #if defined(DEBUGGING) && (defined(PERL_IMPLICIT_SYS) || defined(PERL_TRACK_MEMPOOL))
248 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
250 #ifdef PERL_TRACK_MEMPOOL
251 where = (Malloc_t)((char*)where-sTHX);
253 struct perl_memory_debug_header *const header
254 = (struct perl_memory_debug_header *)where;
256 if (header->interpreter != aTHX) {
257 Perl_croak_nocontext("panic: free from wrong pool");
260 Perl_croak_nocontext("panic: duplicate free");
262 if (!(header->next) || header->next->prev != header
263 || header->prev->next != header) {
264 Perl_croak_nocontext("panic: bad free");
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)
289 MEM_SIZE total_size = 0;
291 /* Even though calloc() for zero bytes is strange, be robust. */
292 if (size && (count <= MEM_SIZE_MAX / size))
293 total_size = size * count;
295 Perl_croak_nocontext("%s", PL_memory_wrap);
296 #ifdef PERL_TRACK_MEMPOOL
297 if (sTHX <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
300 Perl_croak_nocontext("%s", PL_memory_wrap);
303 if (total_size > 0xffff) {
304 PerlIO_printf(Perl_error_log,
305 "Allocation too large: %lx\n", total_size) FLUSH;
308 #endif /* HAS_64K_LIMIT */
310 if ((long)size < 0 || (long)count < 0)
311 Perl_croak_nocontext("panic: calloc");
313 #ifdef PERL_TRACK_MEMPOOL
314 /* Have to use malloc() because we've added some space for our tracking
316 /* malloc(0) is non-portable. */
317 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
319 /* Use calloc() because it might save a memset() if the memory is fresh
320 and clean from the OS. */
322 ptr = (Malloc_t)PerlMem_calloc(count, size);
323 else /* calloc(0) is non-portable. */
324 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
326 PERL_ALLOC_CHECK(ptr);
327 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));
329 #ifdef PERL_TRACK_MEMPOOL
331 struct perl_memory_debug_header *const header
332 = (struct perl_memory_debug_header *)ptr;
334 memset((void*)ptr, 0, total_size);
335 header->interpreter = aTHX;
336 /* Link us into the list. */
337 header->prev = &PL_memory_debug_header;
338 header->next = PL_memory_debug_header.next;
339 PL_memory_debug_header.next = header;
340 header->next->prev = header;
342 header->size = total_size;
344 ptr = (Malloc_t)((char*)ptr+sTHX);
355 return write_no_mem();
359 /* These must be defined when not using Perl's malloc for binary
364 Malloc_t Perl_malloc (MEM_SIZE nbytes)
367 return (Malloc_t)PerlMem_malloc(nbytes);
370 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
373 return (Malloc_t)PerlMem_calloc(elements, size);
376 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
379 return (Malloc_t)PerlMem_realloc(where, nbytes);
382 Free_t Perl_mfree (Malloc_t where)
390 /* copy a string up to some (non-backslashed) delimiter, if any */
393 Perl_delimcpy(register char *to, register const char *toend, register const char *from, register const char *fromend, register int delim, I32 *retlen)
397 PERL_ARGS_ASSERT_DELIMCPY;
399 for (tolen = 0; from < fromend; from++, tolen++) {
401 if (from[1] != delim) {
408 else if (*from == delim)
419 /* return ptr to little string in big string, NULL if not found */
420 /* This routine was donated by Corey Satten. */
423 Perl_instr(register const char *big, register const char *little)
427 PERL_ARGS_ASSERT_INSTR;
435 register const char *s, *x;
438 for (x=big,s=little; *s; /**/ ) {
449 return (char*)(big-1);
454 /* same as instr but allow embedded nulls */
457 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
459 PERL_ARGS_ASSERT_NINSTR;
463 const char first = *little;
465 bigend -= lend - little++;
467 while (big <= bigend) {
468 if (*big++ == first) {
469 for (x=big,s=little; s < lend; x++,s++) {
473 return (char*)(big-1);
480 /* reverse of the above--find last substring */
483 Perl_rninstr(register const char *big, const char *bigend, const char *little, const char *lend)
485 register const char *bigbeg;
486 register const I32 first = *little;
487 register const char * const littleend = lend;
489 PERL_ARGS_ASSERT_RNINSTR;
491 if (little >= littleend)
492 return (char*)bigend;
494 big = bigend - (littleend - little++);
495 while (big >= bigbeg) {
496 register const char *s, *x;
499 for (x=big+2,s=little; s < littleend; /**/ ) {
508 return (char*)(big+1);
513 /* As a space optimization, we do not compile tables for strings of length
514 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
515 special-cased in fbm_instr().
517 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
520 =head1 Miscellaneous Functions
522 =for apidoc fbm_compile
524 Analyses the string in order to make fast searches on it using fbm_instr()
525 -- the Boyer-Moore algorithm.
531 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
534 register const U8 *s;
540 PERL_ARGS_ASSERT_FBM_COMPILE;
542 if (flags & FBMcf_TAIL) {
543 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
544 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
545 if (mg && mg->mg_len >= 0)
548 s = (U8*)SvPV_force_mutable(sv, len);
549 if (len == 0) /* TAIL might be on a zero-length string. */
551 SvUPGRADE(sv, SVt_PVGV);
556 const unsigned char *sb;
557 const U8 mlen = (len>255) ? 255 : (U8)len;
560 Sv_Grow(sv, len + 256 + PERL_FBM_TABLE_OFFSET);
562 = (unsigned char*)(SvPVX_mutable(sv) + len + PERL_FBM_TABLE_OFFSET);
563 s = table - 1 - PERL_FBM_TABLE_OFFSET; /* last char */
564 memset((void*)table, mlen, 256);
566 sb = s - mlen + 1; /* first char (maybe) */
568 if (table[*s] == mlen)
573 Sv_Grow(sv, len + PERL_FBM_TABLE_OFFSET);
575 sv_magic(sv, NULL, PERL_MAGIC_bm, NULL, 0); /* deep magic */
577 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
578 for (i = 0; i < len; i++) {
579 if (PL_freq[s[i]] < frequency) {
581 frequency = PL_freq[s[i]];
584 BmFLAGS(sv) = (U8)flags;
585 BmRARE(sv) = s[rarest];
586 BmPREVIOUS(sv) = rarest;
587 BmUSEFUL(sv) = 100; /* Initial value */
588 if (flags & FBMcf_TAIL)
590 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %lu\n",
591 BmRARE(sv),(unsigned long)BmPREVIOUS(sv)));
594 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
595 /* If SvTAIL is actually due to \Z or \z, this gives false positives
599 =for apidoc fbm_instr
601 Returns the location of the SV in the string delimited by C<str> and
602 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
603 does not have to be fbm_compiled, but the search will not be as fast
610 Perl_fbm_instr(pTHX_ unsigned char *big, register unsigned char *bigend, SV *littlestr, U32 flags)
612 register unsigned char *s;
614 register const unsigned char *little
615 = (const unsigned char *)SvPV_const(littlestr,l);
616 register STRLEN littlelen = l;
617 register const I32 multiline = flags & FBMrf_MULTILINE;
619 PERL_ARGS_ASSERT_FBM_INSTR;
621 if ((STRLEN)(bigend - big) < littlelen) {
622 if ( SvTAIL(littlestr)
623 && ((STRLEN)(bigend - big) == littlelen - 1)
625 || (*big == *little &&
626 memEQ((char *)big, (char *)little, littlelen - 1))))
631 if (littlelen <= 2) { /* Special-cased */
633 if (littlelen == 1) {
634 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
635 /* Know that bigend != big. */
636 if (bigend[-1] == '\n')
637 return (char *)(bigend - 1);
638 return (char *) bigend;
646 if (SvTAIL(littlestr))
647 return (char *) bigend;
651 return (char*)big; /* Cannot be SvTAIL! */
654 if (SvTAIL(littlestr) && !multiline) {
655 if (bigend[-1] == '\n' && bigend[-2] == *little)
656 return (char*)bigend - 2;
657 if (bigend[-1] == *little)
658 return (char*)bigend - 1;
662 /* This should be better than FBM if c1 == c2, and almost
663 as good otherwise: maybe better since we do less indirection.
664 And we save a lot of memory by caching no table. */
665 const unsigned char c1 = little[0];
666 const unsigned char c2 = little[1];
671 while (s <= bigend) {
681 goto check_1char_anchor;
692 goto check_1char_anchor;
695 while (s <= bigend) {
700 goto check_1char_anchor;
709 check_1char_anchor: /* One char and anchor! */
710 if (SvTAIL(littlestr) && (*bigend == *little))
711 return (char *)bigend; /* bigend is already decremented. */
714 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
715 s = bigend - littlelen;
716 if (s >= big && bigend[-1] == '\n' && *s == *little
717 /* Automatically of length > 2 */
718 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
720 return (char*)s; /* how sweet it is */
723 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
725 return (char*)s + 1; /* how sweet it is */
729 if (!SvVALID(littlestr)) {
730 char * const b = ninstr((char*)big,(char*)bigend,
731 (char*)little, (char*)little + littlelen);
733 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
734 /* Chop \n from littlestr: */
735 s = bigend - littlelen + 1;
737 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
747 if (littlelen > (STRLEN)(bigend - big))
751 register const unsigned char * const table
752 = little + littlelen + PERL_FBM_TABLE_OFFSET;
753 register const unsigned char *oldlittle;
755 --littlelen; /* Last char found by table lookup */
758 little += littlelen; /* last char */
764 if ((tmp = table[*s])) {
765 if ((s += tmp) < bigend)
769 else { /* less expensive than calling strncmp() */
770 register unsigned char * const olds = s;
775 if (*--s == *--little)
777 s = olds + 1; /* here we pay the price for failure */
779 if (s < bigend) /* fake up continue to outer loop */
788 && (BmFLAGS(littlestr) & FBMcf_TAIL)
789 && memEQ((char *)(bigend - littlelen),
790 (char *)(oldlittle - littlelen), littlelen) )
791 return (char*)bigend - littlelen;
796 /* start_shift, end_shift are positive quantities which give offsets
797 of ends of some substring of bigstr.
798 If "last" we want the last occurrence.
799 old_posp is the way of communication between consequent calls if
800 the next call needs to find the .
801 The initial *old_posp should be -1.
803 Note that we take into account SvTAIL, so one can get extra
804 optimizations if _ALL flag is set.
807 /* If SvTAIL is actually due to \Z or \z, this gives false positives
808 if PL_multiline. In fact if !PL_multiline the authoritative answer
809 is not supported yet. */
812 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
815 register const unsigned char *big;
817 register I32 previous;
819 register const unsigned char *little;
820 register I32 stop_pos;
821 register const unsigned char *littleend;
824 PERL_ARGS_ASSERT_SCREAMINSTR;
826 assert(SvTYPE(littlestr) == SVt_PVGV);
827 assert(SvVALID(littlestr));
830 ? (pos = PL_screamfirst[BmRARE(littlestr)]) < 0
831 : (((pos = *old_posp), pos += PL_screamnext[pos]) == 0)) {
833 if ( BmRARE(littlestr) == '\n'
834 && BmPREVIOUS(littlestr) == SvCUR(littlestr) - 1) {
835 little = (const unsigned char *)(SvPVX_const(littlestr));
836 littleend = little + SvCUR(littlestr);
843 little = (const unsigned char *)(SvPVX_const(littlestr));
844 littleend = little + SvCUR(littlestr);
846 /* The value of pos we can start at: */
847 previous = BmPREVIOUS(littlestr);
848 big = (const unsigned char *)(SvPVX_const(bigstr));
849 /* The value of pos we can stop at: */
850 stop_pos = SvCUR(bigstr) - end_shift - (SvCUR(littlestr) - 1 - previous);
851 if (previous + start_shift > stop_pos) {
853 stop_pos does not include SvTAIL in the count, so this check is incorrect
854 (I think) - see [ID 20010618.006] and t/op/study.t. HVDS 2001/06/19
857 if (previous + start_shift == stop_pos + 1) /* A fake '\n'? */
862 while (pos < previous + start_shift) {
863 if (!(pos += PL_screamnext[pos]))
868 register const unsigned char *s, *x;
869 if (pos >= stop_pos) break;
870 if (big[pos] != first)
872 for (x=big+pos+1,s=little; s < littleend; /**/ ) {
878 if (s == littleend) {
880 if (!last) return (char *)(big+pos);
883 } while ( pos += PL_screamnext[pos] );
885 return (char *)(big+(*old_posp));
887 if (!SvTAIL(littlestr) || (end_shift > 0))
889 /* Ignore the trailing "\n". This code is not microoptimized */
890 big = (const unsigned char *)(SvPVX_const(bigstr) + SvCUR(bigstr));
891 stop_pos = littleend - little; /* Actual littlestr len */
896 && ((stop_pos == 1) ||
897 memEQ((char *)(big + 1), (char *)little, stop_pos - 1)))
905 Returns true if the leading len bytes of the strings s1 and s2 are the same
906 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
907 match themselves and their opposite case counterparts. Non-cased and non-ASCII
908 range bytes match only themselves.
915 Perl_foldEQ(const char *s1, const char *s2, register I32 len)
917 register const U8 *a = (const U8 *)s1;
918 register const U8 *b = (const U8 *)s2;
920 PERL_ARGS_ASSERT_FOLDEQ;
923 if (*a != *b && *a != PL_fold[*b])
931 =for apidoc foldEQ_locale
933 Returns true if the leading len bytes of the strings s1 and s2 are the same
934 case-insensitively in the current locale; false otherwise.
940 Perl_foldEQ_locale(const char *s1, const char *s2, register I32 len)
943 register const U8 *a = (const U8 *)s1;
944 register const U8 *b = (const U8 *)s2;
946 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
949 if (*a != *b && *a != PL_fold_locale[*b])
956 /* copy a string to a safe spot */
959 =head1 Memory Management
963 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
964 string which is a duplicate of C<pv>. The size of the string is
965 determined by C<strlen()>. The memory allocated for the new string can
966 be freed with the C<Safefree()> function.
972 Perl_savepv(pTHX_ const char *pv)
979 const STRLEN pvlen = strlen(pv)+1;
980 Newx(newaddr, pvlen, char);
981 return (char*)memcpy(newaddr, pv, pvlen);
985 /* same thing but with a known length */
990 Perl's version of what C<strndup()> would be if it existed. Returns a
991 pointer to a newly allocated string which is a duplicate of the first
992 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
993 the new string can be freed with the C<Safefree()> function.
999 Perl_savepvn(pTHX_ const char *pv, register I32 len)
1001 register char *newaddr;
1002 PERL_UNUSED_CONTEXT;
1004 Newx(newaddr,len+1,char);
1005 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1007 /* might not be null terminated */
1008 newaddr[len] = '\0';
1009 return (char *) CopyD(pv,newaddr,len,char);
1012 return (char *) ZeroD(newaddr,len+1,char);
1017 =for apidoc savesharedpv
1019 A version of C<savepv()> which allocates the duplicate string in memory
1020 which is shared between threads.
1025 Perl_savesharedpv(pTHX_ const char *pv)
1027 register char *newaddr;
1032 pvlen = strlen(pv)+1;
1033 newaddr = (char*)PerlMemShared_malloc(pvlen);
1035 return write_no_mem();
1037 return (char*)memcpy(newaddr, pv, pvlen);
1041 =for apidoc savesharedpvn
1043 A version of C<savepvn()> which allocates the duplicate string in memory
1044 which is shared between threads. (With the specific difference that a NULL
1045 pointer is not acceptable)
1050 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1052 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1054 PERL_ARGS_ASSERT_SAVESHAREDPVN;
1057 return write_no_mem();
1059 newaddr[len] = '\0';
1060 return (char*)memcpy(newaddr, pv, len);
1064 =for apidoc savesvpv
1066 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1067 the passed in SV using C<SvPV()>
1073 Perl_savesvpv(pTHX_ SV *sv)
1076 const char * const pv = SvPV_const(sv, len);
1077 register char *newaddr;
1079 PERL_ARGS_ASSERT_SAVESVPV;
1082 Newx(newaddr,len,char);
1083 return (char *) CopyD(pv,newaddr,len,char);
1087 /* the SV for Perl_form() and mess() is not kept in an arena */
1097 return newSVpvs_flags("", SVs_TEMP);
1102 /* Create as PVMG now, to avoid any upgrading later */
1104 Newxz(any, 1, XPVMG);
1105 SvFLAGS(sv) = SVt_PVMG;
1106 SvANY(sv) = (void*)any;
1108 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1113 #if defined(PERL_IMPLICIT_CONTEXT)
1115 Perl_form_nocontext(const char* pat, ...)
1120 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1121 va_start(args, pat);
1122 retval = vform(pat, &args);
1126 #endif /* PERL_IMPLICIT_CONTEXT */
1129 =head1 Miscellaneous Functions
1132 Takes a sprintf-style format pattern and conventional
1133 (non-SV) arguments and returns the formatted string.
1135 (char *) Perl_form(pTHX_ const char* pat, ...)
1137 can be used any place a string (char *) is required:
1139 char * s = Perl_form("%d.%d",major,minor);
1141 Uses a single private buffer so if you want to format several strings you
1142 must explicitly copy the earlier strings away (and free the copies when you
1149 Perl_form(pTHX_ const char* pat, ...)
1153 PERL_ARGS_ASSERT_FORM;
1154 va_start(args, pat);
1155 retval = vform(pat, &args);
1161 Perl_vform(pTHX_ const char *pat, va_list *args)
1163 SV * const sv = mess_alloc();
1164 PERL_ARGS_ASSERT_VFORM;
1165 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1170 =for apidoc Am|SV *|mess|const char *pat|...
1172 Take a sprintf-style format pattern and argument list. These are used to
1173 generate a string message. If the message does not end with a newline,
1174 then it will be extended with some indication of the current location
1175 in the code, as described for L</mess_sv>.
1177 Normally, the resulting message is returned in a new mortal SV.
1178 During global destruction a single SV may be shared between uses of
1184 #if defined(PERL_IMPLICIT_CONTEXT)
1186 Perl_mess_nocontext(const char *pat, ...)
1191 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1192 va_start(args, pat);
1193 retval = vmess(pat, &args);
1197 #endif /* PERL_IMPLICIT_CONTEXT */
1200 Perl_mess(pTHX_ const char *pat, ...)
1204 PERL_ARGS_ASSERT_MESS;
1205 va_start(args, pat);
1206 retval = vmess(pat, &args);
1212 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1215 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1217 PERL_ARGS_ASSERT_CLOSEST_COP;
1219 if (!o || o == PL_op)
1222 if (o->op_flags & OPf_KIDS) {
1224 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1227 /* If the OP_NEXTSTATE has been optimised away we can still use it
1228 * the get the file and line number. */
1230 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1231 cop = (const COP *)kid;
1233 /* Keep searching, and return when we've found something. */
1235 new_cop = closest_cop(cop, kid);
1241 /* Nothing found. */
1247 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1249 Expands a message, intended for the user, to include an indication of
1250 the current location in the code, if the message does not already appear
1253 C<basemsg> is the initial message or object. If it is a reference, it
1254 will be used as-is and will be the result of this function. Otherwise it
1255 is used as a string, and if it already ends with a newline, it is taken
1256 to be complete, and the result of this function will be the same string.
1257 If the message does not end with a newline, then a segment such as C<at
1258 foo.pl line 37> will be appended, and possibly other clauses indicating
1259 the current state of execution. The resulting message will end with a
1262 Normally, the resulting message is returned in a new mortal SV.
1263 During global destruction a single SV may be shared between uses of this
1264 function. If C<consume> is true, then the function is permitted (but not
1265 required) to modify and return C<basemsg> instead of allocating a new SV.
1271 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1276 PERL_ARGS_ASSERT_MESS_SV;
1278 if (SvROK(basemsg)) {
1284 sv_setsv(sv, basemsg);
1289 if (SvPOK(basemsg) && consume) {
1294 sv_copypv(sv, basemsg);
1297 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1299 * Try and find the file and line for PL_op. This will usually be
1300 * PL_curcop, but it might be a cop that has been optimised away. We
1301 * can try to find such a cop by searching through the optree starting
1302 * from the sibling of PL_curcop.
1305 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1310 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1311 OutCopFILE(cop), (IV)CopLINE(cop));
1312 /* Seems that GvIO() can be untrustworthy during global destruction. */
1313 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1314 && IoLINES(GvIOp(PL_last_in_gv)))
1316 const bool line_mode = (RsSIMPLE(PL_rs) &&
1317 SvCUR(PL_rs) == 1 && *SvPVX_const(PL_rs) == '\n');
1318 Perl_sv_catpvf(aTHX_ sv, ", <%s> %s %"IVdf,
1319 PL_last_in_gv == PL_argvgv ? "" : GvNAME(PL_last_in_gv),
1320 line_mode ? "line" : "chunk",
1321 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1324 sv_catpvs(sv, " during global destruction");
1325 sv_catpvs(sv, ".\n");
1331 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1333 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1334 argument list. These are used to generate a string message. If the
1335 message does not end with a newline, then it will be extended with
1336 some indication of the current location in the code, as described for
1339 Normally, the resulting message is returned in a new mortal SV.
1340 During global destruction a single SV may be shared between uses of
1347 Perl_vmess(pTHX_ const char *pat, va_list *args)
1350 SV * const sv = mess_alloc();
1352 PERL_ARGS_ASSERT_VMESS;
1354 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1355 return mess_sv(sv, 1);
1359 Perl_write_to_stderr(pTHX_ SV* msv)
1365 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1367 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1368 && (io = GvIO(PL_stderrgv))
1369 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1376 SAVESPTR(PL_stderrgv);
1379 PUSHSTACKi(PERLSI_MAGIC);
1383 PUSHs(SvTIED_obj(MUTABLE_SV(io), mg));
1386 call_method("PRINT", G_SCALAR);
1394 /* SFIO can really mess with your errno */
1397 PerlIO * const serr = Perl_error_log;
1399 const char* message = SvPVx_const(msv, msglen);
1401 PERL_WRITE_MSG_TO_CONSOLE(serr, message, msglen);
1402 (void)PerlIO_flush(serr);
1410 =head1 Warning and Dieing
1413 /* Common code used in dieing and warning */
1416 S_with_queued_errors(pTHX_ SV *ex)
1418 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1419 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1420 sv_catsv(PL_errors, ex);
1421 ex = sv_mortalcopy(PL_errors);
1422 SvCUR_set(PL_errors, 0);
1428 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1434 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1435 /* sv_2cv might call Perl_croak() or Perl_warner() */
1436 SV * const oldhook = *hook;
1444 cv = sv_2cv(oldhook, &stash, &gv, 0);
1446 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1456 exarg = newSVsv(ex);
1457 SvREADONLY_on(exarg);
1460 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1464 call_sv(MUTABLE_SV(cv), G_DISCARD);
1473 =for apidoc Am|OP *|die_sv|SV *baseex
1475 Behaves the same as L</croak_sv>, except for the return type.
1476 It should be used only where the C<OP *> return type is required.
1477 The function never actually returns.
1483 Perl_die_sv(pTHX_ SV *baseex)
1485 PERL_ARGS_ASSERT_DIE_SV;
1492 =for apidoc Am|OP *|die|const char *pat|...
1494 Behaves the same as L</croak>, except for the return type.
1495 It should be used only where the C<OP *> return type is required.
1496 The function never actually returns.
1501 #if defined(PERL_IMPLICIT_CONTEXT)
1503 Perl_die_nocontext(const char* pat, ...)
1507 va_start(args, pat);
1513 #endif /* PERL_IMPLICIT_CONTEXT */
1516 Perl_die(pTHX_ const char* pat, ...)
1519 va_start(args, pat);
1527 =for apidoc Am|void|croak_sv|SV *baseex
1529 This is an XS interface to Perl's C<die> function.
1531 C<baseex> is the error message or object. If it is a reference, it
1532 will be used as-is. Otherwise it is used as a string, and if it does
1533 not end with a newline then it will be extended with some indication of
1534 the current location in the code, as described for L</mess_sv>.
1536 The error message or object will be used as an exception, by default
1537 returning control to the nearest enclosing C<eval>, but subject to
1538 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1539 function never returns normally.
1541 To die with a simple string message, the L</croak> function may be
1548 Perl_croak_sv(pTHX_ SV *baseex)
1550 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1551 PERL_ARGS_ASSERT_CROAK_SV;
1552 invoke_exception_hook(ex, FALSE);
1557 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1559 This is an XS interface to Perl's C<die> function.
1561 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1562 argument list. These are used to generate a string message. If the
1563 message does not end with a newline, then it will be extended with
1564 some indication of the current location in the code, as described for
1567 The error message will be used as an exception, by default
1568 returning control to the nearest enclosing C<eval>, but subject to
1569 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1570 function never returns normally.
1572 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1573 (C<$@>) will be used as an error message or object instead of building an
1574 error message from arguments. If you want to throw a non-string object,
1575 or build an error message in an SV yourself, it is preferable to use
1576 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1582 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1584 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1585 invoke_exception_hook(ex, FALSE);
1590 =for apidoc Am|void|croak|const char *pat|...
1592 This is an XS interface to Perl's C<die> function.
1594 Take a sprintf-style format pattern and argument list. These are used to
1595 generate a string message. If the message does not end with a newline,
1596 then it will be extended with some indication of the current location
1597 in the code, as described for L</mess_sv>.
1599 The error message will be used as an exception, by default
1600 returning control to the nearest enclosing C<eval>, but subject to
1601 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1602 function never returns normally.
1604 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1605 (C<$@>) will be used as an error message or object instead of building an
1606 error message from arguments. If you want to throw a non-string object,
1607 or build an error message in an SV yourself, it is preferable to use
1608 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1613 #if defined(PERL_IMPLICIT_CONTEXT)
1615 Perl_croak_nocontext(const char *pat, ...)
1619 va_start(args, pat);
1624 #endif /* PERL_IMPLICIT_CONTEXT */
1627 Perl_croak(pTHX_ const char *pat, ...)
1630 va_start(args, pat);
1637 =for apidoc Am|void|warn_sv|SV *baseex
1639 This is an XS interface to Perl's C<warn> function.
1641 C<baseex> is the error message or object. If it is a reference, it
1642 will be used as-is. Otherwise it is used as a string, and if it does
1643 not end with a newline then it will be extended with some indication of
1644 the current location in the code, as described for L</mess_sv>.
1646 The error message or object will by default be written to standard error,
1647 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1649 To warn with a simple string message, the L</warn> function may be
1656 Perl_warn_sv(pTHX_ SV *baseex)
1658 SV *ex = mess_sv(baseex, 0);
1659 PERL_ARGS_ASSERT_WARN_SV;
1660 if (!invoke_exception_hook(ex, TRUE))
1661 write_to_stderr(ex);
1665 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1667 This is an XS interface to Perl's C<warn> function.
1669 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1670 argument list. These are used to generate a string message. If the
1671 message does not end with a newline, then it will be extended with
1672 some indication of the current location in the code, as described for
1675 The error message or object will by default be written to standard error,
1676 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1678 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1684 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1686 SV *ex = vmess(pat, args);
1687 PERL_ARGS_ASSERT_VWARN;
1688 if (!invoke_exception_hook(ex, TRUE))
1689 write_to_stderr(ex);
1693 =for apidoc Am|void|warn|const char *pat|...
1695 This is an XS interface to Perl's C<warn> function.
1697 Take a sprintf-style format pattern and argument list. These are used to
1698 generate a string message. If the message does not end with a newline,
1699 then it will be extended with some indication of the current location
1700 in the code, as described for L</mess_sv>.
1702 The error message or object will by default be written to standard error,
1703 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1705 Unlike with L</croak>, C<pat> is not permitted to be null.
1710 #if defined(PERL_IMPLICIT_CONTEXT)
1712 Perl_warn_nocontext(const char *pat, ...)
1716 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1717 va_start(args, pat);
1721 #endif /* PERL_IMPLICIT_CONTEXT */
1724 Perl_warn(pTHX_ const char *pat, ...)
1727 PERL_ARGS_ASSERT_WARN;
1728 va_start(args, pat);
1733 #if defined(PERL_IMPLICIT_CONTEXT)
1735 Perl_warner_nocontext(U32 err, const char *pat, ...)
1739 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1740 va_start(args, pat);
1741 vwarner(err, pat, &args);
1744 #endif /* PERL_IMPLICIT_CONTEXT */
1747 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1749 PERL_ARGS_ASSERT_CK_WARNER_D;
1751 if (Perl_ckwarn_d(aTHX_ err)) {
1753 va_start(args, pat);
1754 vwarner(err, pat, &args);
1760 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1762 PERL_ARGS_ASSERT_CK_WARNER;
1764 if (Perl_ckwarn(aTHX_ err)) {
1766 va_start(args, pat);
1767 vwarner(err, pat, &args);
1773 Perl_warner(pTHX_ U32 err, const char* pat,...)
1776 PERL_ARGS_ASSERT_WARNER;
1777 va_start(args, pat);
1778 vwarner(err, pat, &args);
1783 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1786 PERL_ARGS_ASSERT_VWARNER;
1787 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1788 SV * const msv = vmess(pat, args);
1790 invoke_exception_hook(msv, FALSE);
1794 Perl_vwarn(aTHX_ pat, args);
1798 /* implements the ckWARN? macros */
1801 Perl_ckwarn(pTHX_ U32 w)
1804 /* If lexical warnings have not been set, use $^W. */
1806 return PL_dowarn & G_WARN_ON;
1808 return ckwarn_common(w);
1811 /* implements the ckWARN?_d macro */
1814 Perl_ckwarn_d(pTHX_ U32 w)
1817 /* If lexical warnings have not been set then default classes warn. */
1821 return ckwarn_common(w);
1825 S_ckwarn_common(pTHX_ U32 w)
1827 if (PL_curcop->cop_warnings == pWARN_ALL)
1830 if (PL_curcop->cop_warnings == pWARN_NONE)
1833 /* Check the assumption that at least the first slot is non-zero. */
1834 assert(unpackWARN1(w));
1836 /* Check the assumption that it is valid to stop as soon as a zero slot is
1838 if (!unpackWARN2(w)) {
1839 assert(!unpackWARN3(w));
1840 assert(!unpackWARN4(w));
1841 } else if (!unpackWARN3(w)) {
1842 assert(!unpackWARN4(w));
1845 /* Right, dealt with all the special cases, which are implemented as non-
1846 pointers, so there is a pointer to a real warnings mask. */
1848 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1850 } while (w >>= WARNshift);
1855 /* Set buffer=NULL to get a new one. */
1857 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1859 const MEM_SIZE len_wanted = sizeof(STRLEN) + size;
1860 PERL_UNUSED_CONTEXT;
1861 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1864 (specialWARN(buffer) ?
1865 PerlMemShared_malloc(len_wanted) :
1866 PerlMemShared_realloc(buffer, len_wanted));
1868 Copy(bits, (buffer + 1), size, char);
1872 /* since we've already done strlen() for both nam and val
1873 * we can use that info to make things faster than
1874 * sprintf(s, "%s=%s", nam, val)
1876 #define my_setenv_format(s, nam, nlen, val, vlen) \
1877 Copy(nam, s, nlen, char); \
1879 Copy(val, s+(nlen+1), vlen, char); \
1880 *(s+(nlen+1+vlen)) = '\0'
1882 #ifdef USE_ENVIRON_ARRAY
1883 /* VMS' my_setenv() is in vms.c */
1884 #if !defined(WIN32) && !defined(NETWARE)
1886 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1890 /* only parent thread can modify process environment */
1891 if (PL_curinterp == aTHX)
1894 #ifndef PERL_USE_SAFE_PUTENV
1895 if (!PL_use_safe_putenv) {
1896 /* most putenv()s leak, so we manipulate environ directly */
1898 register const I32 len = strlen(nam);
1901 /* where does it go? */
1902 for (i = 0; environ[i]; i++) {
1903 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1907 if (environ == PL_origenviron) { /* need we copy environment? */
1913 while (environ[max])
1915 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1916 for (j=0; j<max; j++) { /* copy environment */
1917 const int len = strlen(environ[j]);
1918 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1919 Copy(environ[j], tmpenv[j], len+1, char);
1922 environ = tmpenv; /* tell exec where it is now */
1925 safesysfree(environ[i]);
1926 while (environ[i]) {
1927 environ[i] = environ[i+1];
1932 if (!environ[i]) { /* does not exist yet */
1933 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1934 environ[i+1] = NULL; /* make sure it's null terminated */
1937 safesysfree(environ[i]);
1941 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1942 /* all that work just for this */
1943 my_setenv_format(environ[i], nam, nlen, val, vlen);
1946 # if defined(__CYGWIN__) || defined(EPOC) || defined(__SYMBIAN32__) || defined(__riscos__)
1947 # if defined(HAS_UNSETENV)
1949 (void)unsetenv(nam);
1951 (void)setenv(nam, val, 1);
1953 # else /* ! HAS_UNSETENV */
1954 (void)setenv(nam, val, 1);
1955 # endif /* HAS_UNSETENV */
1957 # if defined(HAS_UNSETENV)
1959 (void)unsetenv(nam);
1961 const int nlen = strlen(nam);
1962 const int vlen = strlen(val);
1963 char * const new_env =
1964 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1965 my_setenv_format(new_env, nam, nlen, val, vlen);
1966 (void)putenv(new_env);
1968 # else /* ! HAS_UNSETENV */
1970 const int nlen = strlen(nam);
1976 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1977 /* all that work just for this */
1978 my_setenv_format(new_env, nam, nlen, val, vlen);
1979 (void)putenv(new_env);
1980 # endif /* HAS_UNSETENV */
1981 # endif /* __CYGWIN__ */
1982 #ifndef PERL_USE_SAFE_PUTENV
1988 #else /* WIN32 || NETWARE */
1991 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1994 register char *envstr;
1995 const int nlen = strlen(nam);
2002 Newx(envstr, nlen+vlen+2, char);
2003 my_setenv_format(envstr, nam, nlen, val, vlen);
2004 (void)PerlEnv_putenv(envstr);
2008 #endif /* WIN32 || NETWARE */
2010 #endif /* !VMS && !EPOC*/
2012 #ifdef UNLINK_ALL_VERSIONS
2014 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2018 PERL_ARGS_ASSERT_UNLNK;
2020 while (PerlLIO_unlink(f) >= 0)
2022 return retries ? 0 : -1;
2026 /* this is a drop-in replacement for bcopy() */
2027 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2029 Perl_my_bcopy(register const char *from,register char *to,register I32 len)
2031 char * const retval = to;
2033 PERL_ARGS_ASSERT_MY_BCOPY;
2035 if (from - to >= 0) {
2043 *(--to) = *(--from);
2049 /* this is a drop-in replacement for memset() */
2052 Perl_my_memset(register char *loc, register I32 ch, register I32 len)
2054 char * const retval = loc;
2056 PERL_ARGS_ASSERT_MY_MEMSET;
2064 /* this is a drop-in replacement for bzero() */
2065 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2067 Perl_my_bzero(register char *loc, register I32 len)
2069 char * const retval = loc;
2071 PERL_ARGS_ASSERT_MY_BZERO;
2079 /* this is a drop-in replacement for memcmp() */
2080 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2082 Perl_my_memcmp(const char *s1, const char *s2, register I32 len)
2084 register const U8 *a = (const U8 *)s1;
2085 register const U8 *b = (const U8 *)s2;
2088 PERL_ARGS_ASSERT_MY_MEMCMP;
2091 if ((tmp = *a++ - *b++))
2096 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2099 /* This vsprintf replacement should generally never get used, since
2100 vsprintf was available in both System V and BSD 2.11. (There may
2101 be some cross-compilation or embedded set-ups where it is needed,
2104 If you encounter a problem in this function, it's probably a symptom
2105 that Configure failed to detect your system's vprintf() function.
2106 See the section on "item vsprintf" in the INSTALL file.
2108 This version may compile on systems with BSD-ish <stdio.h>,
2109 but probably won't on others.
2112 #ifdef USE_CHAR_VSPRINTF
2117 vsprintf(char *dest, const char *pat, void *args)
2121 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2122 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2123 FILE_cnt(&fakebuf) = 32767;
2125 /* These probably won't compile -- If you really need
2126 this, you'll have to figure out some other method. */
2127 fakebuf._ptr = dest;
2128 fakebuf._cnt = 32767;
2133 fakebuf._flag = _IOWRT|_IOSTRG;
2134 _doprnt(pat, args, &fakebuf); /* what a kludge */
2135 #if defined(STDIO_PTR_LVALUE)
2136 *(FILE_ptr(&fakebuf)++) = '\0';
2138 /* PerlIO has probably #defined away fputc, but we want it here. */
2140 # undef fputc /* XXX Should really restore it later */
2142 (void)fputc('\0', &fakebuf);
2144 #ifdef USE_CHAR_VSPRINTF
2147 return 0; /* perl doesn't use return value */
2151 #endif /* HAS_VPRINTF */
2154 #if BYTEORDER != 0x4321
2156 Perl_my_swap(pTHX_ short s)
2158 #if (BYTEORDER & 1) == 0
2161 result = ((s & 255) << 8) + ((s >> 8) & 255);
2169 Perl_my_htonl(pTHX_ long l)
2173 char c[sizeof(long)];
2176 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
2177 #if BYTEORDER == 0x12345678
2180 u.c[0] = (l >> 24) & 255;
2181 u.c[1] = (l >> 16) & 255;
2182 u.c[2] = (l >> 8) & 255;
2186 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2187 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2192 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2193 u.c[o & 0xf] = (l >> s) & 255;
2201 Perl_my_ntohl(pTHX_ long l)
2205 char c[sizeof(long)];
2208 #if BYTEORDER == 0x1234
2209 u.c[0] = (l >> 24) & 255;
2210 u.c[1] = (l >> 16) & 255;
2211 u.c[2] = (l >> 8) & 255;
2215 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2216 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2223 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2224 l |= (u.c[o & 0xf] & 255) << s;
2231 #endif /* BYTEORDER != 0x4321 */
2235 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2236 * If these functions are defined,
2237 * the BYTEORDER is neither 0x1234 nor 0x4321.
2238 * However, this is not assumed.
2242 #define HTOLE(name,type) \
2244 name (register type n) \
2248 char c[sizeof(type)]; \
2251 register U32 s = 0; \
2252 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2253 u.c[i] = (n >> s) & 0xFF; \
2258 #define LETOH(name,type) \
2260 name (register type n) \
2264 char c[sizeof(type)]; \
2267 register U32 s = 0; \
2270 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2271 n |= ((type)(u.c[i] & 0xFF)) << s; \
2277 * Big-endian byte order functions.
2280 #define HTOBE(name,type) \
2282 name (register type n) \
2286 char c[sizeof(type)]; \
2289 register U32 s = 8*(sizeof(u.c)-1); \
2290 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2291 u.c[i] = (n >> s) & 0xFF; \
2296 #define BETOH(name,type) \
2298 name (register type n) \
2302 char c[sizeof(type)]; \
2305 register U32 s = 8*(sizeof(u.c)-1); \
2308 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2309 n |= ((type)(u.c[i] & 0xFF)) << s; \
2315 * If we just can't do it...
2318 #define NOT_AVAIL(name,type) \
2320 name (register type n) \
2322 Perl_croak_nocontext(#name "() not available"); \
2323 return n; /* not reached */ \
2327 #if defined(HAS_HTOVS) && !defined(htovs)
2330 #if defined(HAS_HTOVL) && !defined(htovl)
2333 #if defined(HAS_VTOHS) && !defined(vtohs)
2336 #if defined(HAS_VTOHL) && !defined(vtohl)
2340 #ifdef PERL_NEED_MY_HTOLE16
2342 HTOLE(Perl_my_htole16,U16)
2344 NOT_AVAIL(Perl_my_htole16,U16)
2347 #ifdef PERL_NEED_MY_LETOH16
2349 LETOH(Perl_my_letoh16,U16)
2351 NOT_AVAIL(Perl_my_letoh16,U16)
2354 #ifdef PERL_NEED_MY_HTOBE16
2356 HTOBE(Perl_my_htobe16,U16)
2358 NOT_AVAIL(Perl_my_htobe16,U16)
2361 #ifdef PERL_NEED_MY_BETOH16
2363 BETOH(Perl_my_betoh16,U16)
2365 NOT_AVAIL(Perl_my_betoh16,U16)
2369 #ifdef PERL_NEED_MY_HTOLE32
2371 HTOLE(Perl_my_htole32,U32)
2373 NOT_AVAIL(Perl_my_htole32,U32)
2376 #ifdef PERL_NEED_MY_LETOH32
2378 LETOH(Perl_my_letoh32,U32)
2380 NOT_AVAIL(Perl_my_letoh32,U32)
2383 #ifdef PERL_NEED_MY_HTOBE32
2385 HTOBE(Perl_my_htobe32,U32)
2387 NOT_AVAIL(Perl_my_htobe32,U32)
2390 #ifdef PERL_NEED_MY_BETOH32
2392 BETOH(Perl_my_betoh32,U32)
2394 NOT_AVAIL(Perl_my_betoh32,U32)
2398 #ifdef PERL_NEED_MY_HTOLE64
2400 HTOLE(Perl_my_htole64,U64)
2402 NOT_AVAIL(Perl_my_htole64,U64)
2405 #ifdef PERL_NEED_MY_LETOH64
2407 LETOH(Perl_my_letoh64,U64)
2409 NOT_AVAIL(Perl_my_letoh64,U64)
2412 #ifdef PERL_NEED_MY_HTOBE64
2414 HTOBE(Perl_my_htobe64,U64)
2416 NOT_AVAIL(Perl_my_htobe64,U64)
2419 #ifdef PERL_NEED_MY_BETOH64
2421 BETOH(Perl_my_betoh64,U64)
2423 NOT_AVAIL(Perl_my_betoh64,U64)
2427 #ifdef PERL_NEED_MY_HTOLES
2428 HTOLE(Perl_my_htoles,short)
2430 #ifdef PERL_NEED_MY_LETOHS
2431 LETOH(Perl_my_letohs,short)
2433 #ifdef PERL_NEED_MY_HTOBES
2434 HTOBE(Perl_my_htobes,short)
2436 #ifdef PERL_NEED_MY_BETOHS
2437 BETOH(Perl_my_betohs,short)
2440 #ifdef PERL_NEED_MY_HTOLEI
2441 HTOLE(Perl_my_htolei,int)
2443 #ifdef PERL_NEED_MY_LETOHI
2444 LETOH(Perl_my_letohi,int)
2446 #ifdef PERL_NEED_MY_HTOBEI
2447 HTOBE(Perl_my_htobei,int)
2449 #ifdef PERL_NEED_MY_BETOHI
2450 BETOH(Perl_my_betohi,int)
2453 #ifdef PERL_NEED_MY_HTOLEL
2454 HTOLE(Perl_my_htolel,long)
2456 #ifdef PERL_NEED_MY_LETOHL
2457 LETOH(Perl_my_letohl,long)
2459 #ifdef PERL_NEED_MY_HTOBEL
2460 HTOBE(Perl_my_htobel,long)
2462 #ifdef PERL_NEED_MY_BETOHL
2463 BETOH(Perl_my_betohl,long)
2467 Perl_my_swabn(void *ptr, int n)
2469 register char *s = (char *)ptr;
2470 register char *e = s + (n-1);
2473 PERL_ARGS_ASSERT_MY_SWABN;
2475 for (n /= 2; n > 0; s++, e--, n--) {
2483 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2485 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2488 register I32 This, that;
2494 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2496 PERL_FLUSHALL_FOR_CHILD;
2497 This = (*mode == 'w');
2501 taint_proper("Insecure %s%s", "EXEC");
2503 if (PerlProc_pipe(p) < 0)
2505 /* Try for another pipe pair for error return */
2506 if (PerlProc_pipe(pp) >= 0)
2508 while ((pid = PerlProc_fork()) < 0) {
2509 if (errno != EAGAIN) {
2510 PerlLIO_close(p[This]);
2511 PerlLIO_close(p[that]);
2513 PerlLIO_close(pp[0]);
2514 PerlLIO_close(pp[1]);
2518 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2527 /* Close parent's end of error status pipe (if any) */
2529 PerlLIO_close(pp[0]);
2530 #if defined(HAS_FCNTL) && defined(F_SETFD)
2531 /* Close error pipe automatically if exec works */
2532 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2535 /* Now dup our end of _the_ pipe to right position */
2536 if (p[THIS] != (*mode == 'r')) {
2537 PerlLIO_dup2(p[THIS], *mode == 'r');
2538 PerlLIO_close(p[THIS]);
2539 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2540 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2543 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2544 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2545 /* No automatic close - do it by hand */
2552 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2558 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2564 do_execfree(); /* free any memory malloced by child on fork */
2566 PerlLIO_close(pp[1]);
2567 /* Keep the lower of the two fd numbers */
2568 if (p[that] < p[This]) {
2569 PerlLIO_dup2(p[This], p[that]);
2570 PerlLIO_close(p[This]);
2574 PerlLIO_close(p[that]); /* close child's end of pipe */
2576 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2577 SvUPGRADE(sv,SVt_IV);
2579 PL_forkprocess = pid;
2580 /* If we managed to get status pipe check for exec fail */
2581 if (did_pipes && pid > 0) {
2586 while (n < sizeof(int)) {
2587 n1 = PerlLIO_read(pp[0],
2588 (void*)(((char*)&errkid)+n),
2594 PerlLIO_close(pp[0]);
2596 if (n) { /* Error */
2598 PerlLIO_close(p[This]);
2599 if (n != sizeof(int))
2600 Perl_croak(aTHX_ "panic: kid popen errno read");
2602 pid2 = wait4pid(pid, &status, 0);
2603 } while (pid2 == -1 && errno == EINTR);
2604 errno = errkid; /* Propagate errno from kid */
2609 PerlLIO_close(pp[0]);
2610 return PerlIO_fdopen(p[This], mode);
2612 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2613 return my_syspopen4(aTHX_ NULL, mode, n, args);
2615 Perl_croak(aTHX_ "List form of piped open not implemented");
2616 return (PerlIO *) NULL;
2621 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2622 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
2624 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2628 register I32 This, that;
2631 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2635 PERL_ARGS_ASSERT_MY_POPEN;
2637 PERL_FLUSHALL_FOR_CHILD;
2640 return my_syspopen(aTHX_ cmd,mode);
2643 This = (*mode == 'w');
2645 if (doexec && PL_tainting) {
2647 taint_proper("Insecure %s%s", "EXEC");
2649 if (PerlProc_pipe(p) < 0)
2651 if (doexec && PerlProc_pipe(pp) >= 0)
2653 while ((pid = PerlProc_fork()) < 0) {
2654 if (errno != EAGAIN) {
2655 PerlLIO_close(p[This]);
2656 PerlLIO_close(p[that]);
2658 PerlLIO_close(pp[0]);
2659 PerlLIO_close(pp[1]);
2662 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2665 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2676 PerlLIO_close(pp[0]);
2677 #if defined(HAS_FCNTL) && defined(F_SETFD)
2678 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2681 if (p[THIS] != (*mode == 'r')) {
2682 PerlLIO_dup2(p[THIS], *mode == 'r');
2683 PerlLIO_close(p[THIS]);
2684 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2685 PerlLIO_close(p[THAT]);
2688 PerlLIO_close(p[THAT]);
2691 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2698 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2703 /* may or may not use the shell */
2704 do_exec3(cmd, pp[1], did_pipes);
2707 #endif /* defined OS2 */
2709 #ifdef PERLIO_USING_CRLF
2710 /* Since we circumvent IO layers when we manipulate low-level
2711 filedescriptors directly, need to manually switch to the
2712 default, binary, low-level mode; see PerlIOBuf_open(). */
2713 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2716 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
2717 SvREADONLY_off(GvSV(tmpgv));
2718 sv_setiv(GvSV(tmpgv), PerlProc_getpid());
2719 SvREADONLY_on(GvSV(tmpgv));
2721 #ifdef THREADS_HAVE_PIDS
2722 PL_ppid = (IV)getppid();
2725 #ifdef PERL_USES_PL_PIDSTATUS
2726 hv_clear(PL_pidstatus); /* we have no children */
2732 do_execfree(); /* free any memory malloced by child on vfork */
2734 PerlLIO_close(pp[1]);
2735 if (p[that] < p[This]) {
2736 PerlLIO_dup2(p[This], p[that]);
2737 PerlLIO_close(p[This]);
2741 PerlLIO_close(p[that]);
2743 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2744 SvUPGRADE(sv,SVt_IV);
2746 PL_forkprocess = pid;
2747 if (did_pipes && pid > 0) {
2752 while (n < sizeof(int)) {
2753 n1 = PerlLIO_read(pp[0],
2754 (void*)(((char*)&errkid)+n),
2760 PerlLIO_close(pp[0]);
2762 if (n) { /* Error */
2764 PerlLIO_close(p[This]);
2765 if (n != sizeof(int))
2766 Perl_croak(aTHX_ "panic: kid popen errno read");
2768 pid2 = wait4pid(pid, &status, 0);
2769 } while (pid2 == -1 && errno == EINTR);
2770 errno = errkid; /* Propagate errno from kid */
2775 PerlLIO_close(pp[0]);
2776 return PerlIO_fdopen(p[This], mode);
2779 #if defined(atarist) || defined(EPOC)
2782 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2784 PERL_ARGS_ASSERT_MY_POPEN;
2785 PERL_FLUSHALL_FOR_CHILD;
2786 /* Call system's popen() to get a FILE *, then import it.
2787 used 0 for 2nd parameter to PerlIO_importFILE;
2790 return PerlIO_importFILE(popen(cmd, mode), 0);
2794 FILE *djgpp_popen();
2796 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2798 PERL_FLUSHALL_FOR_CHILD;
2799 /* Call system's popen() to get a FILE *, then import it.
2800 used 0 for 2nd parameter to PerlIO_importFILE;
2803 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2806 #if defined(__LIBCATAMOUNT__)
2808 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2816 #endif /* !DOSISH */
2818 /* this is called in parent before the fork() */
2820 Perl_atfork_lock(void)
2823 #if defined(USE_ITHREADS)
2824 /* locks must be held in locking order (if any) */
2826 MUTEX_LOCK(&PL_malloc_mutex);
2832 /* this is called in both parent and child after the fork() */
2834 Perl_atfork_unlock(void)
2837 #if defined(USE_ITHREADS)
2838 /* locks must be released in same order as in atfork_lock() */
2840 MUTEX_UNLOCK(&PL_malloc_mutex);
2849 #if defined(HAS_FORK)
2851 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2856 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2857 * handlers elsewhere in the code */
2862 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2863 Perl_croak_nocontext("fork() not available");
2865 #endif /* HAS_FORK */
2870 Perl_dump_fds(pTHX_ const char *const s)
2875 PERL_ARGS_ASSERT_DUMP_FDS;
2877 PerlIO_printf(Perl_debug_log,"%s", s);
2878 for (fd = 0; fd < 32; fd++) {
2879 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2880 PerlIO_printf(Perl_debug_log," %d",fd);
2882 PerlIO_printf(Perl_debug_log,"\n");
2885 #endif /* DUMP_FDS */
2889 dup2(int oldfd, int newfd)
2891 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2894 PerlLIO_close(newfd);
2895 return fcntl(oldfd, F_DUPFD, newfd);
2897 #define DUP2_MAX_FDS 256
2898 int fdtmp[DUP2_MAX_FDS];
2904 PerlLIO_close(newfd);
2905 /* good enough for low fd's... */
2906 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2907 if (fdx >= DUP2_MAX_FDS) {
2915 PerlLIO_close(fdtmp[--fdx]);
2922 #ifdef HAS_SIGACTION
2925 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2928 struct sigaction act, oact;
2931 /* only "parent" interpreter can diddle signals */
2932 if (PL_curinterp != aTHX)
2933 return (Sighandler_t) SIG_ERR;
2936 act.sa_handler = (void(*)(int))handler;
2937 sigemptyset(&act.sa_mask);
2940 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2941 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2943 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2944 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2945 act.sa_flags |= SA_NOCLDWAIT;
2947 if (sigaction(signo, &act, &oact) == -1)
2948 return (Sighandler_t) SIG_ERR;
2950 return (Sighandler_t) oact.sa_handler;
2954 Perl_rsignal_state(pTHX_ int signo)
2956 struct sigaction oact;
2957 PERL_UNUSED_CONTEXT;
2959 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2960 return (Sighandler_t) SIG_ERR;
2962 return (Sighandler_t) oact.sa_handler;
2966 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2969 struct sigaction act;
2971 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2974 /* only "parent" interpreter can diddle signals */
2975 if (PL_curinterp != aTHX)
2979 act.sa_handler = (void(*)(int))handler;
2980 sigemptyset(&act.sa_mask);
2983 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2984 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2986 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2987 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2988 act.sa_flags |= SA_NOCLDWAIT;
2990 return sigaction(signo, &act, save);
2994 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2998 /* only "parent" interpreter can diddle signals */
2999 if (PL_curinterp != aTHX)
3003 return sigaction(signo, save, (struct sigaction *)NULL);
3006 #else /* !HAS_SIGACTION */
3009 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3011 #if defined(USE_ITHREADS) && !defined(WIN32)
3012 /* only "parent" interpreter can diddle signals */
3013 if (PL_curinterp != aTHX)
3014 return (Sighandler_t) SIG_ERR;
3017 return PerlProc_signal(signo, handler);
3028 Perl_rsignal_state(pTHX_ int signo)
3031 Sighandler_t oldsig;
3033 #if defined(USE_ITHREADS) && !defined(WIN32)
3034 /* only "parent" interpreter can diddle signals */
3035 if (PL_curinterp != aTHX)
3036 return (Sighandler_t) SIG_ERR;
3040 oldsig = PerlProc_signal(signo, sig_trap);
3041 PerlProc_signal(signo, oldsig);
3043 PerlProc_kill(PerlProc_getpid(), signo);
3048 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3050 #if defined(USE_ITHREADS) && !defined(WIN32)
3051 /* only "parent" interpreter can diddle signals */
3052 if (PL_curinterp != aTHX)
3055 *save = PerlProc_signal(signo, handler);
3056 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3060 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3062 #if defined(USE_ITHREADS) && !defined(WIN32)
3063 /* only "parent" interpreter can diddle signals */
3064 if (PL_curinterp != aTHX)
3067 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3070 #endif /* !HAS_SIGACTION */
3071 #endif /* !PERL_MICRO */
3073 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3074 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
3076 Perl_my_pclose(pTHX_ PerlIO *ptr)
3079 Sigsave_t hstat, istat, qstat;
3087 svp = av_fetch(PL_fdpid,PerlIO_fileno(ptr),TRUE);
3088 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3090 *svp = &PL_sv_undef;
3092 if (pid == -1) { /* Opened by popen. */
3093 return my_syspclose(ptr);
3096 close_failed = (PerlIO_close(ptr) == EOF);
3099 if(PerlProc_kill(pid, 0) < 0) { return(pid); } /* HOM 12/23/91 */
3102 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3103 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3104 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3107 pid2 = wait4pid(pid, &status, 0);
3108 } while (pid2 == -1 && errno == EINTR);
3110 rsignal_restore(SIGHUP, &hstat);
3111 rsignal_restore(SIGINT, &istat);
3112 rsignal_restore(SIGQUIT, &qstat);
3118 return(pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status));
3121 #if defined(__LIBCATAMOUNT__)
3123 Perl_my_pclose(pTHX_ PerlIO *ptr)
3128 #endif /* !DOSISH */
3130 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3132 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3136 PERL_ARGS_ASSERT_WAIT4PID;
3139 #ifdef PERL_USES_PL_PIDSTATUS
3142 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3143 pid, rather than a string form. */
3144 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3145 if (svp && *svp != &PL_sv_undef) {
3146 *statusp = SvIVX(*svp);
3147 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3155 hv_iterinit(PL_pidstatus);
3156 if ((entry = hv_iternext(PL_pidstatus))) {
3157 SV * const sv = hv_iterval(PL_pidstatus,entry);
3159 const char * const spid = hv_iterkey(entry,&len);
3161 assert (len == sizeof(Pid_t));
3162 memcpy((char *)&pid, spid, len);
3163 *statusp = SvIVX(sv);
3164 /* The hash iterator is currently on this entry, so simply
3165 calling hv_delete would trigger the lazy delete, which on
3166 aggregate does more work, beacuse next call to hv_iterinit()
3167 would spot the flag, and have to call the delete routine,
3168 while in the meantime any new entries can't re-use that
3170 hv_iterinit(PL_pidstatus);
3171 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3178 # ifdef HAS_WAITPID_RUNTIME
3179 if (!HAS_WAITPID_RUNTIME)
3182 result = PerlProc_waitpid(pid,statusp,flags);
3185 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3186 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3189 #ifdef PERL_USES_PL_PIDSTATUS
3190 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3195 Perl_croak(aTHX_ "Can't do waitpid with flags");
3197 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3198 pidgone(result,*statusp);
3204 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3207 if (result < 0 && errno == EINTR) {
3209 errno = EINTR; /* reset in case a signal handler changed $! */
3213 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3215 #ifdef PERL_USES_PL_PIDSTATUS
3217 S_pidgone(pTHX_ Pid_t pid, int status)
3221 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3222 SvUPGRADE(sv,SVt_IV);
3223 SvIV_set(sv, status);
3228 #if defined(atarist) || defined(OS2) || defined(EPOC)
3231 int /* Cannot prototype with I32
3233 my_syspclose(PerlIO *ptr)
3236 Perl_my_pclose(pTHX_ PerlIO *ptr)
3239 /* Needs work for PerlIO ! */
3240 FILE * const f = PerlIO_findFILE(ptr);
3241 const I32 result = pclose(f);
3242 PerlIO_releaseFILE(ptr,f);
3250 Perl_my_pclose(pTHX_ PerlIO *ptr)
3252 /* Needs work for PerlIO ! */
3253 FILE * const f = PerlIO_findFILE(ptr);
3254 I32 result = djgpp_pclose(f);
3255 result = (result << 8) & 0xff00;
3256 PerlIO_releaseFILE(ptr,f);
3261 #define PERL_REPEATCPY_LINEAR 4
3263 Perl_repeatcpy(register char *to, register const char *from, I32 len, register I32 count)
3265 PERL_ARGS_ASSERT_REPEATCPY;
3268 memset(to, *from, count);
3270 register char *p = to;
3271 I32 items, linear, half;
3273 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3274 for (items = 0; items < linear; ++items) {
3275 register const char *q = from;
3277 for (todo = len; todo > 0; todo--)
3282 while (items <= half) {
3283 I32 size = items * len;
3284 memcpy(p, to, size);
3290 memcpy(p, to, (count - items) * len);
3296 Perl_same_dirent(pTHX_ const char *a, const char *b)
3298 char *fa = strrchr(a,'/');
3299 char *fb = strrchr(b,'/');
3302 SV * const tmpsv = sv_newmortal();
3304 PERL_ARGS_ASSERT_SAME_DIRENT;
3317 sv_setpvs(tmpsv, ".");
3319 sv_setpvn(tmpsv, a, fa - a);
3320 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3323 sv_setpvs(tmpsv, ".");
3325 sv_setpvn(tmpsv, b, fb - b);
3326 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3328 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3329 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3331 #endif /* !HAS_RENAME */
3334 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3335 const char *const *const search_ext, I32 flags)
3338 const char *xfound = NULL;
3339 char *xfailed = NULL;
3340 char tmpbuf[MAXPATHLEN];
3345 #if defined(DOSISH) && !defined(OS2) && !defined(atarist)
3346 # define SEARCH_EXTS ".bat", ".cmd", NULL
3347 # define MAX_EXT_LEN 4
3350 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3351 # define MAX_EXT_LEN 4
3354 # define SEARCH_EXTS ".pl", ".com", NULL
3355 # define MAX_EXT_LEN 4
3357 /* additional extensions to try in each dir if scriptname not found */
3359 static const char *const exts[] = { SEARCH_EXTS };
3360 const char *const *const ext = search_ext ? search_ext : exts;
3361 int extidx = 0, i = 0;
3362 const char *curext = NULL;
3364 PERL_UNUSED_ARG(search_ext);
3365 # define MAX_EXT_LEN 0
3368 PERL_ARGS_ASSERT_FIND_SCRIPT;
3371 * If dosearch is true and if scriptname does not contain path
3372 * delimiters, search the PATH for scriptname.
3374 * If SEARCH_EXTS is also defined, will look for each
3375 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3376 * while searching the PATH.
3378 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3379 * proceeds as follows:
3380 * If DOSISH or VMSISH:
3381 * + look for ./scriptname{,.foo,.bar}
3382 * + search the PATH for scriptname{,.foo,.bar}
3385 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3386 * this will not look in '.' if it's not in the PATH)
3391 # ifdef ALWAYS_DEFTYPES
3392 len = strlen(scriptname);
3393 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3394 int idx = 0, deftypes = 1;
3397 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3400 int idx = 0, deftypes = 1;
3403 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3405 /* The first time through, just add SEARCH_EXTS to whatever we
3406 * already have, so we can check for default file types. */
3408 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3414 if ((strlen(tmpbuf) + strlen(scriptname)
3415 + MAX_EXT_LEN) >= sizeof tmpbuf)
3416 continue; /* don't search dir with too-long name */
3417 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3421 if (strEQ(scriptname, "-"))
3423 if (dosearch) { /* Look in '.' first. */
3424 const char *cur = scriptname;
3426 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3428 if (strEQ(ext[i++],curext)) {
3429 extidx = -1; /* already has an ext */
3434 DEBUG_p(PerlIO_printf(Perl_debug_log,
3435 "Looking for %s\n",cur));
3436 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3437 && !S_ISDIR(PL_statbuf.st_mode)) {
3445 if (cur == scriptname) {
3446 len = strlen(scriptname);
3447 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3449 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3452 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3453 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3458 if (dosearch && !strchr(scriptname, '/')
3460 && !strchr(scriptname, '\\')
3462 && (s = PerlEnv_getenv("PATH")))
3466 bufend = s + strlen(s);
3467 while (s < bufend) {
3468 #if defined(atarist) || defined(DOSISH)
3473 && *s != ';'; len++, s++) {
3474 if (len < sizeof tmpbuf)
3477 if (len < sizeof tmpbuf)
3479 #else /* ! (atarist || DOSISH) */
3480 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3483 #endif /* ! (atarist || DOSISH) */
3486 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3487 continue; /* don't search dir with too-long name */
3489 # if defined(atarist) || defined(DOSISH)
3490 && tmpbuf[len - 1] != '/'
3491 && tmpbuf[len - 1] != '\\'
3494 tmpbuf[len++] = '/';
3495 if (len == 2 && tmpbuf[0] == '.')
3497 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3501 len = strlen(tmpbuf);
3502 if (extidx > 0) /* reset after previous loop */
3506 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3507 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3508 if (S_ISDIR(PL_statbuf.st_mode)) {
3512 } while ( retval < 0 /* not there */
3513 && extidx>=0 && ext[extidx] /* try an extension? */
3514 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3519 if (S_ISREG(PL_statbuf.st_mode)
3520 && cando(S_IRUSR,TRUE,&PL_statbuf)
3521 #if !defined(DOSISH)
3522 && cando(S_IXUSR,TRUE,&PL_statbuf)
3526 xfound = tmpbuf; /* bingo! */
3530 xfailed = savepv(tmpbuf);
3533 if (!xfound && !seen_dot && !xfailed &&
3534 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3535 || S_ISDIR(PL_statbuf.st_mode)))
3537 seen_dot = 1; /* Disable message. */
3539 if (flags & 1) { /* do or die? */
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 if (pthread_getspecific(PL_thr_key, &t))
3564 Perl_croak_nocontext("panic: pthread_getspecific");
3567 # ifdef I_MACH_CTHREADS
3568 return (void*)cthread_data(cthread_self());
3570 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3579 Perl_set_context(void *t)
3582 PERL_ARGS_ASSERT_SET_CONTEXT;
3583 #if defined(USE_ITHREADS)
3584 # ifdef I_MACH_CTHREADS
3585 cthread_set_data(cthread_self(), t);
3587 if (pthread_setspecific(PL_thr_key, t))
3588 Perl_croak_nocontext("panic: pthread_setspecific");
3595 #endif /* !PERL_GET_CONTEXT_DEFINED */
3597 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3606 Perl_get_op_names(pTHX)
3608 PERL_UNUSED_CONTEXT;
3609 return (char **)PL_op_name;
3613 Perl_get_op_descs(pTHX)
3615 PERL_UNUSED_CONTEXT;
3616 return (char **)PL_op_desc;
3620 Perl_get_no_modify(pTHX)
3622 PERL_UNUSED_CONTEXT;
3623 return PL_no_modify;
3627 Perl_get_opargs(pTHX)
3629 PERL_UNUSED_CONTEXT;
3630 return (U32 *)PL_opargs;
3634 Perl_get_ppaddr(pTHX)
3637 PERL_UNUSED_CONTEXT;
3638 return (PPADDR_t*)PL_ppaddr;
3641 #ifndef HAS_GETENV_LEN
3643 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3645 char * const env_trans = PerlEnv_getenv(env_elem);
3646 PERL_UNUSED_CONTEXT;
3647 PERL_ARGS_ASSERT_GETENV_LEN;
3649 *len = strlen(env_trans);
3656 Perl_get_vtbl(pTHX_ int vtbl_id)
3658 const MGVTBL* result;
3659 PERL_UNUSED_CONTEXT;
3663 result = &PL_vtbl_sv;
3666 result = &PL_vtbl_env;
3668 case want_vtbl_envelem:
3669 result = &PL_vtbl_envelem;
3672 result = &PL_vtbl_sig;
3674 case want_vtbl_sigelem:
3675 result = &PL_vtbl_sigelem;
3677 case want_vtbl_pack:
3678 result = &PL_vtbl_pack;
3680 case want_vtbl_packelem:
3681 result = &PL_vtbl_packelem;
3683 case want_vtbl_dbline:
3684 result = &PL_vtbl_dbline;
3687 result = &PL_vtbl_isa;
3689 case want_vtbl_isaelem:
3690 result = &PL_vtbl_isaelem;
3692 case want_vtbl_arylen:
3693 result = &PL_vtbl_arylen;
3695 case want_vtbl_mglob:
3696 result = &PL_vtbl_mglob;
3698 case want_vtbl_nkeys:
3699 result = &PL_vtbl_nkeys;
3701 case want_vtbl_taint:
3702 result = &PL_vtbl_taint;
3704 case want_vtbl_substr:
3705 result = &PL_vtbl_substr;
3708 result = &PL_vtbl_vec;
3711 result = &PL_vtbl_pos;
3714 result = &PL_vtbl_bm;
3717 result = &PL_vtbl_fm;
3719 case want_vtbl_uvar:
3720 result = &PL_vtbl_uvar;
3722 case want_vtbl_defelem:
3723 result = &PL_vtbl_defelem;
3725 case want_vtbl_regexp:
3726 result = &PL_vtbl_regexp;
3728 case want_vtbl_regdata:
3729 result = &PL_vtbl_regdata;
3731 case want_vtbl_regdatum:
3732 result = &PL_vtbl_regdatum;
3734 #ifdef USE_LOCALE_COLLATE
3735 case want_vtbl_collxfrm:
3736 result = &PL_vtbl_collxfrm;
3739 case want_vtbl_amagic:
3740 result = &PL_vtbl_amagic;
3742 case want_vtbl_amagicelem:
3743 result = &PL_vtbl_amagicelem;
3745 case want_vtbl_backref:
3746 result = &PL_vtbl_backref;
3748 case want_vtbl_utf8:
3749 result = &PL_vtbl_utf8;
3755 return (MGVTBL*)result;
3759 Perl_my_fflush_all(pTHX)
3761 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3762 return PerlIO_flush(NULL);
3764 # if defined(HAS__FWALK)
3765 extern int fflush(FILE *);
3766 /* undocumented, unprototyped, but very useful BSDism */
3767 extern void _fwalk(int (*)(FILE *));
3771 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3773 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3774 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3776 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3777 open_max = sysconf(_SC_OPEN_MAX);
3780 open_max = FOPEN_MAX;
3783 open_max = OPEN_MAX;
3794 for (i = 0; i < open_max; i++)
3795 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3796 STDIO_STREAM_ARRAY[i]._file < open_max &&
3797 STDIO_STREAM_ARRAY[i]._flag)
3798 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3802 SETERRNO(EBADF,RMS_IFI);
3809 Perl_report_evil_fh(pTHX_ const GV *gv, const IO *io, I32 op)
3811 const char * const name = gv && isGV(gv) ? GvENAME(gv) : NULL;
3813 if (op == OP_phoney_OUTPUT_ONLY || op == OP_phoney_INPUT_ONLY) {
3814 if (ckWARN(WARN_IO)) {
3815 const char * const direction =
3816 (const char *)((op == OP_phoney_INPUT_ONLY) ? "in" : "out");
3818 Perl_warner(aTHX_ packWARN(WARN_IO),
3819 "Filehandle %s opened only for %sput",
3822 Perl_warner(aTHX_ packWARN(WARN_IO),
3823 "Filehandle opened only for %sput", direction);
3830 if (gv && io && IoTYPE(io) == IoTYPE_CLOSED) {
3832 warn_type = WARN_CLOSED;
3836 warn_type = WARN_UNOPENED;
3839 if (ckWARN(warn_type)) {
3840 const char * const pars =
3841 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3842 const char * const func =
3844 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3845 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3846 op < 0 ? "" : /* handle phoney cases */
3848 const char * const type =
3850 (OP_IS_SOCKET(op) ||
3851 (gv && io && IoTYPE(io) == IoTYPE_SOCKET) ?
3852 "socket" : "filehandle");
3853 if (name && *name) {
3854 Perl_warner(aTHX_ packWARN(warn_type),
3855 "%s%s on %s %s %s", func, pars, vile, type, name);
3856 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3858 aTHX_ packWARN(warn_type),
3859 "\t(Are you trying to call %s%s on dirhandle %s?)\n",
3864 Perl_warner(aTHX_ packWARN(warn_type),
3865 "%s%s on %s %s", func, pars, vile, type);
3866 if (gv && io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3868 aTHX_ packWARN(warn_type),
3869 "\t(Are you trying to call %s%s on dirhandle?)\n",
3877 /* XXX Add documentation after final interface and behavior is decided */
3878 /* May want to show context for error, so would pass Perl_bslash_c(pTHX_ const char* current, const char* start, const bool output_warning)
3879 U8 source = *current;
3881 May want to add eg, WARN_REGEX
3885 Perl_grok_bslash_c(pTHX_ const char source, const bool output_warning)
3890 if (! isASCII(source)) {
3891 Perl_croak(aTHX_ "Character following \"\\c\" must be ASCII");
3894 result = toCTRL(source);
3895 if (! isCNTRL(result)) {
3896 if (source == '{') {
3897 Perl_croak(aTHX_ "It is proposed that \"\\c{\" no longer be valid. It has historically evaluated to\n \";\". If you disagree with this proposal, send email to perl5-porters@perl.org\nOtherwise, or in the meantime, you can work around this failure by changing\n\"\\c{\" to \";\"");
3899 else if (output_warning) {
3902 if (! isALNUM(result)) {
3903 clearer[i++] = '\\';
3905 clearer[i++] = result;
3906 clearer[i++] = '\0';
3908 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
3909 "\"\\c%c\" more clearly written simply as \"%s\"",
3918 /* To workaround core dumps from the uninitialised tm_zone we get the
3919 * system to give us a reasonable struct to copy. This fix means that
3920 * strftime uses the tm_zone and tm_gmtoff values returned by
3921 * localtime(time()). That should give the desired result most of the
3922 * time. But probably not always!
3924 * This does not address tzname aspects of NETaa14816.
3929 # ifndef STRUCT_TM_HASZONE
3930 # define STRUCT_TM_HASZONE
3934 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3935 # ifndef HAS_TM_TM_ZONE
3936 # define HAS_TM_TM_ZONE
3941 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3943 #ifdef HAS_TM_TM_ZONE
3945 const struct tm* my_tm;
3946 PERL_ARGS_ASSERT_INIT_TM;
3948 my_tm = localtime(&now);
3950 Copy(my_tm, ptm, 1, struct tm);
3952 PERL_ARGS_ASSERT_INIT_TM;
3953 PERL_UNUSED_ARG(ptm);
3958 * mini_mktime - normalise struct tm values without the localtime()
3959 * semantics (and overhead) of mktime().
3962 Perl_mini_mktime(pTHX_ struct tm *ptm)
3966 int month, mday, year, jday;
3967 int odd_cent, odd_year;
3968 PERL_UNUSED_CONTEXT;
3970 PERL_ARGS_ASSERT_MINI_MKTIME;
3972 #define DAYS_PER_YEAR 365
3973 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3974 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3975 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3976 #define SECS_PER_HOUR (60*60)
3977 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3978 /* parentheses deliberately absent on these two, otherwise they don't work */
3979 #define MONTH_TO_DAYS 153/5
3980 #define DAYS_TO_MONTH 5/153
3981 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3982 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3983 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3984 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3987 * Year/day algorithm notes:
3989 * With a suitable offset for numeric value of the month, one can find
3990 * an offset into the year by considering months to have 30.6 (153/5) days,
3991 * using integer arithmetic (i.e., with truncation). To avoid too much
3992 * messing about with leap days, we consider January and February to be
3993 * the 13th and 14th month of the previous year. After that transformation,
3994 * we need the month index we use to be high by 1 from 'normal human' usage,
3995 * so the month index values we use run from 4 through 15.
3997 * Given that, and the rules for the Gregorian calendar (leap years are those
3998 * divisible by 4 unless also divisible by 100, when they must be divisible
3999 * by 400 instead), we can simply calculate the number of days since some
4000 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
4001 * the days we derive from our month index, and adding in the day of the
4002 * month. The value used here is not adjusted for the actual origin which
4003 * it normally would use (1 January A.D. 1), since we're not exposing it.
4004 * We're only building the value so we can turn around and get the
4005 * normalised values for the year, month, day-of-month, and day-of-year.
4007 * For going backward, we need to bias the value we're using so that we find
4008 * the right year value. (Basically, we don't want the contribution of
4009 * March 1st to the number to apply while deriving the year). Having done
4010 * that, we 'count up' the contribution to the year number by accounting for
4011 * full quadracenturies (400-year periods) with their extra leap days, plus
4012 * the contribution from full centuries (to avoid counting in the lost leap
4013 * days), plus the contribution from full quad-years (to count in the normal
4014 * leap days), plus the leftover contribution from any non-leap years.
4015 * At this point, if we were working with an actual leap day, we'll have 0
4016 * days left over. This is also true for March 1st, however. So, we have
4017 * to special-case that result, and (earlier) keep track of the 'odd'
4018 * century and year contributions. If we got 4 extra centuries in a qcent,
4019 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
4020 * Otherwise, we add back in the earlier bias we removed (the 123 from
4021 * figuring in March 1st), find the month index (integer division by 30.6),
4022 * and the remainder is the day-of-month. We then have to convert back to
4023 * 'real' months (including fixing January and February from being 14/15 in
4024 * the previous year to being in the proper year). After that, to get
4025 * tm_yday, we work with the normalised year and get a new yearday value for
4026 * January 1st, which we subtract from the yearday value we had earlier,
4027 * representing the date we've re-built. This is done from January 1
4028 * because tm_yday is 0-origin.
4030 * Since POSIX time routines are only guaranteed to work for times since the
4031 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
4032 * applies Gregorian calendar rules even to dates before the 16th century
4033 * doesn't bother me. Besides, you'd need cultural context for a given
4034 * date to know whether it was Julian or Gregorian calendar, and that's
4035 * outside the scope for this routine. Since we convert back based on the
4036 * same rules we used to build the yearday, you'll only get strange results
4037 * for input which needed normalising, or for the 'odd' century years which
4038 * were leap years in the Julian calander but not in the Gregorian one.
4039 * I can live with that.
4041 * This algorithm also fails to handle years before A.D. 1 gracefully, but
4042 * that's still outside the scope for POSIX time manipulation, so I don't
4046 year = 1900 + ptm->tm_year;
4047 month = ptm->tm_mon;
4048 mday = ptm->tm_mday;
4049 /* allow given yday with no month & mday to dominate the result */
4050 if (ptm->tm_yday >= 0 && mday <= 0 && month <= 0) {
4053 jday = 1 + ptm->tm_yday;
4062 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4063 yearday += month*MONTH_TO_DAYS + mday + jday;
4065 * Note that we don't know when leap-seconds were or will be,
4066 * so we have to trust the user if we get something which looks
4067 * like a sensible leap-second. Wild values for seconds will
4068 * be rationalised, however.
4070 if ((unsigned) ptm->tm_sec <= 60) {
4077 secs += 60 * ptm->tm_min;
4078 secs += SECS_PER_HOUR * ptm->tm_hour;
4080 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4081 /* got negative remainder, but need positive time */
4082 /* back off an extra day to compensate */
4083 yearday += (secs/SECS_PER_DAY)-1;
4084 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4087 yearday += (secs/SECS_PER_DAY);
4088 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4091 else if (secs >= SECS_PER_DAY) {
4092 yearday += (secs/SECS_PER_DAY);
4093 secs %= SECS_PER_DAY;
4095 ptm->tm_hour = secs/SECS_PER_HOUR;
4096 secs %= SECS_PER_HOUR;
4097 ptm->tm_min = secs/60;
4099 ptm->tm_sec += secs;
4100 /* done with time of day effects */
4102 * The algorithm for yearday has (so far) left it high by 428.
4103 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4104 * bias it by 123 while trying to figure out what year it
4105 * really represents. Even with this tweak, the reverse
4106 * translation fails for years before A.D. 0001.
4107 * It would still fail for Feb 29, but we catch that one below.
4109 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4110 yearday -= YEAR_ADJUST;
4111 year = (yearday / DAYS_PER_QCENT) * 400;
4112 yearday %= DAYS_PER_QCENT;
4113 odd_cent = yearday / DAYS_PER_CENT;
4114 year += odd_cent * 100;
4115 yearday %= DAYS_PER_CENT;
4116 year += (yearday / DAYS_PER_QYEAR) * 4;
4117 yearday %= DAYS_PER_QYEAR;
4118 odd_year = yearday / DAYS_PER_YEAR;
4120 yearday %= DAYS_PER_YEAR;
4121 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4126 yearday += YEAR_ADJUST; /* recover March 1st crock */
4127 month = yearday*DAYS_TO_MONTH;
4128 yearday -= month*MONTH_TO_DAYS;
4129 /* recover other leap-year adjustment */
4138 ptm->tm_year = year - 1900;
4140 ptm->tm_mday = yearday;
4141 ptm->tm_mon = month;
4145 ptm->tm_mon = month - 1;
4147 /* re-build yearday based on Jan 1 to get tm_yday */
4149 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4150 yearday += 14*MONTH_TO_DAYS + 1;
4151 ptm->tm_yday = jday - yearday;
4152 /* fix tm_wday if not overridden by caller */
4153 if ((unsigned)ptm->tm_wday > 6)
4154 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4158 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)
4166 PERL_ARGS_ASSERT_MY_STRFTIME;
4168 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4171 mytm.tm_hour = hour;
4172 mytm.tm_mday = mday;
4174 mytm.tm_year = year;
4175 mytm.tm_wday = wday;
4176 mytm.tm_yday = yday;
4177 mytm.tm_isdst = isdst;
4179 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4180 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4185 #ifdef HAS_TM_TM_GMTOFF
4186 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4188 #ifdef HAS_TM_TM_ZONE
4189 mytm.tm_zone = mytm2.tm_zone;
4194 Newx(buf, buflen, char);
4195 len = strftime(buf, buflen, fmt, &mytm);
4197 ** The following is needed to handle to the situation where
4198 ** tmpbuf overflows. Basically we want to allocate a buffer
4199 ** and try repeatedly. The reason why it is so complicated
4200 ** is that getting a return value of 0 from strftime can indicate
4201 ** one of the following:
4202 ** 1. buffer overflowed,
4203 ** 2. illegal conversion specifier, or
4204 ** 3. the format string specifies nothing to be returned(not
4205 ** an error). This could be because format is an empty string
4206 ** or it specifies %p that yields an empty string in some locale.
4207 ** If there is a better way to make it portable, go ahead by
4210 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4213 /* Possibly buf overflowed - try again with a bigger buf */
4214 const int fmtlen = strlen(fmt);
4215 int bufsize = fmtlen + buflen;
4217 Newx(buf, bufsize, char);
4219 buflen = strftime(buf, bufsize, fmt, &mytm);
4220 if (buflen > 0 && buflen < bufsize)
4222 /* heuristic to prevent out-of-memory errors */
4223 if (bufsize > 100*fmtlen) {
4229 Renew(buf, bufsize, char);
4234 Perl_croak(aTHX_ "panic: no strftime");
4240 #define SV_CWD_RETURN_UNDEF \
4241 sv_setsv(sv, &PL_sv_undef); \
4244 #define SV_CWD_ISDOT(dp) \
4245 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4246 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4249 =head1 Miscellaneous Functions
4251 =for apidoc getcwd_sv
4253 Fill the sv with current working directory
4258 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4259 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4260 * getcwd(3) if available
4261 * Comments from the orignal:
4262 * This is a faster version of getcwd. It's also more dangerous
4263 * because you might chdir out of a directory that you can't chdir
4267 Perl_getcwd_sv(pTHX_ register SV *sv)
4271 #ifndef INCOMPLETE_TAINTS
4275 PERL_ARGS_ASSERT_GETCWD_SV;
4279 char buf[MAXPATHLEN];
4281 /* Some getcwd()s automatically allocate a buffer of the given
4282 * size from the heap if they are given a NULL buffer pointer.
4283 * The problem is that this behaviour is not portable. */
4284 if (getcwd(buf, sizeof(buf) - 1)) {
4289 sv_setsv(sv, &PL_sv_undef);
4297 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4301 SvUPGRADE(sv, SVt_PV);
4303 if (PerlLIO_lstat(".", &statbuf) < 0) {
4304 SV_CWD_RETURN_UNDEF;
4307 orig_cdev = statbuf.st_dev;
4308 orig_cino = statbuf.st_ino;
4318 if (PerlDir_chdir("..") < 0) {
4319 SV_CWD_RETURN_UNDEF;
4321 if (PerlLIO_stat(".", &statbuf) < 0) {
4322 SV_CWD_RETURN_UNDEF;
4325 cdev = statbuf.st_dev;
4326 cino = statbuf.st_ino;
4328 if (odev == cdev && oino == cino) {
4331 if (!(dir = PerlDir_open("."))) {
4332 SV_CWD_RETURN_UNDEF;
4335 while ((dp = PerlDir_read(dir)) != NULL) {
4337 namelen = dp->d_namlen;
4339 namelen = strlen(dp->d_name);
4342 if (SV_CWD_ISDOT(dp)) {
4346 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4347 SV_CWD_RETURN_UNDEF;
4350 tdev = statbuf.st_dev;
4351 tino = statbuf.st_ino;
4352 if (tino == oino && tdev == odev) {
4358 SV_CWD_RETURN_UNDEF;
4361 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4362 SV_CWD_RETURN_UNDEF;
4365 SvGROW(sv, pathlen + namelen + 1);
4369 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4372 /* prepend current directory to the front */
4374 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4375 pathlen += (namelen + 1);
4377 #ifdef VOID_CLOSEDIR
4380 if (PerlDir_close(dir) < 0) {
4381 SV_CWD_RETURN_UNDEF;
4387 SvCUR_set(sv, pathlen);
4391 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4392 SV_CWD_RETURN_UNDEF;
4395 if (PerlLIO_stat(".", &statbuf) < 0) {
4396 SV_CWD_RETURN_UNDEF;
4399 cdev = statbuf.st_dev;
4400 cino = statbuf.st_ino;
4402 if (cdev != orig_cdev || cino != orig_cino) {
4403 Perl_croak(aTHX_ "Unstable directory path, "
4404 "current directory changed unexpectedly");
4415 #define VERSION_MAX 0x7FFFFFFF
4418 =for apidoc prescan_version
4423 Perl_prescan_version(pTHX_ const char *s, bool strict,
4424 const char **errstr,
4425 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4426 bool qv = (sqv ? *sqv : FALSE);
4428 int saw_decimal = 0;
4432 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4434 if (qv && isDIGIT(*d))
4435 goto dotted_decimal_version;
4437 if (*d == 'v') { /* explicit v-string */
4442 else { /* degenerate v-string */
4443 /* requires v1.2.3 */
4444 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4447 dotted_decimal_version:
4448 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4449 /* no leading zeros allowed */
4450 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4453 while (isDIGIT(*d)) /* integer part */
4459 d++; /* decimal point */
4464 /* require v1.2.3 */
4465 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4468 goto version_prescan_finish;
4475 while (isDIGIT(*d)) { /* just keep reading */
4477 while (isDIGIT(*d)) {
4479 /* maximum 3 digits between decimal */
4480 if (strict && j > 3) {
4481 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4486 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4489 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4494 else if (*d == '.') {
4496 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4501 else if (!isDIGIT(*d)) {
4507 if (strict && i < 2) {
4508 /* requires v1.2.3 */
4509 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4512 } /* end if dotted-decimal */
4514 { /* decimal versions */
4515 /* special strict case for leading '.' or '0' */
4518 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4520 if (*d == '0' && isDIGIT(d[1])) {
4521 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4525 /* consume all of the integer part */
4529 /* look for a fractional part */
4531 /* we found it, so consume it */
4535 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4538 BADVERSION(s,errstr,"Invalid version format (version required)");
4540 /* found just an integer */
4541 goto version_prescan_finish;
4543 else if ( d == s ) {
4544 /* didn't find either integer or period */
4545 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4547 else if (*d == '_') {
4548 /* underscore can't come after integer part */
4550 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4552 else if (isDIGIT(d[1])) {
4553 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4556 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4560 /* anything else after integer part is just invalid data */
4561 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4564 /* scan the fractional part after the decimal point*/
4566 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4567 /* strict or lax-but-not-the-end */
4568 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4571 while (isDIGIT(*d)) {
4573 if (*d == '.' && isDIGIT(d[-1])) {
4575 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4578 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4580 d = (char *)s; /* start all over again */
4582 goto dotted_decimal_version;
4586 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4589 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4591 if ( ! isDIGIT(d[1]) ) {
4592 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4600 version_prescan_finish:
4604 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4605 /* trailing non-numeric data */
4606 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4614 *ssaw_decimal = saw_decimal;
4621 =for apidoc scan_version
4623 Returns a pointer to the next character after the parsed
4624 version string, as well as upgrading the passed in SV to
4627 Function must be called with an already existing SV like
4630 s = scan_version(s, SV *sv, bool qv);
4632 Performs some preprocessing to the string to ensure that
4633 it has the correct characteristics of a version. Flags the
4634 object if it contains an underscore (which denotes this
4635 is an alpha version). The boolean qv denotes that the version
4636 should be interpreted as if it had multiple decimals, even if
4643 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4648 const char *errstr = NULL;
4649 int saw_decimal = 0;
4653 AV * const av = newAV();
4654 SV * const hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4656 PERL_ARGS_ASSERT_SCAN_VERSION;
4658 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4660 #ifndef NODEFAULT_SHAREKEYS
4661 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4664 while (isSPACE(*s)) /* leading whitespace is OK */
4667 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4669 /* "undef" is a special case and not an error */
4670 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4671 Perl_croak(aTHX_ "%s", errstr);
4681 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4683 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4684 if ( !qv && width < 3 )
4685 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4687 while (isDIGIT(*pos))
4689 if (!isALPHA(*pos)) {
4695 /* this is atoi() that delimits on underscores */
4696 const char *end = pos;
4700 /* the following if() will only be true after the decimal
4701 * point of a version originally created with a bare
4702 * floating point number, i.e. not quoted in any way
4704 if ( !qv && s > start && saw_decimal == 1 ) {
4708 rev += (*s - '0') * mult;
4710 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4711 || (PERL_ABS(rev) > VERSION_MAX )) {
4712 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4713 "Integer overflow in version %d",VERSION_MAX);
4724 while (--end >= s) {
4726 rev += (*end - '0') * mult;
4728 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4729 || (PERL_ABS(rev) > VERSION_MAX )) {
4730 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4731 "Integer overflow in version");
4740 /* Append revision */
4741 av_push(av, newSViv(rev));
4746 else if ( *pos == '.' )
4748 else if ( *pos == '_' && isDIGIT(pos[1]) )
4750 else if ( *pos == ',' && isDIGIT(pos[1]) )
4752 else if ( isDIGIT(*pos) )
4759 while ( isDIGIT(*pos) )
4764 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4772 if ( qv ) { /* quoted versions always get at least three terms*/
4773 I32 len = av_len(av);
4774 /* This for loop appears to trigger a compiler bug on OS X, as it
4775 loops infinitely. Yes, len is negative. No, it makes no sense.
4776 Compiler in question is:
4777 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4778 for ( len = 2 - len; len > 0; len-- )
4779 av_push(MUTABLE_AV(sv), newSViv(0));
4783 av_push(av, newSViv(0));
4786 /* need to save off the current version string for later */
4788 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4789 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4790 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4792 else if ( s > start ) {
4793 SV * orig = newSVpvn(start,s-start);
4794 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4795 /* need to insert a v to be consistent */
4796 sv_insert(orig, 0, 0, "v", 1);
4798 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4801 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4802 av_push(av, newSViv(0));
4805 /* And finally, store the AV in the hash */
4806 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4808 /* fix RT#19517 - special case 'undef' as string */
4809 if ( *s == 'u' && strEQ(s,"undef") ) {
4817 =for apidoc new_version
4819 Returns a new version object based on the passed in SV:
4821 SV *sv = new_version(SV *ver);
4823 Does not alter the passed in ver SV. See "upg_version" if you
4824 want to upgrade the SV.
4830 Perl_new_version(pTHX_ SV *ver)
4833 SV * const rv = newSV(0);
4834 PERL_ARGS_ASSERT_NEW_VERSION;
4835 if ( sv_derived_from(ver,"version") ) /* can just copy directly */
4838 AV * const av = newAV();
4840 /* This will get reblessed later if a derived class*/
4841 SV * const hv = newSVrv(rv, "version");
4842 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4843 #ifndef NODEFAULT_SHAREKEYS
4844 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4850 /* Begin copying all of the elements */
4851 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4852 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4854 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4855 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4857 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4859 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4860 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4863 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4865 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4866 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4869 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4870 /* This will get reblessed later if a derived class*/
4871 for ( key = 0; key <= av_len(sav); key++ )
4873 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4874 av_push(av, newSViv(rev));
4877 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4882 const MAGIC* const mg = SvVSTRING_mg(ver);
4883 if ( mg ) { /* already a v-string */
4884 const STRLEN len = mg->mg_len;
4885 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4886 sv_setpvn(rv,version,len);
4887 /* this is for consistency with the pure Perl class */
4888 if ( isDIGIT(*version) )
4889 sv_insert(rv, 0, 0, "v", 1);
4894 sv_setsv(rv,ver); /* make a duplicate */
4899 return upg_version(rv, FALSE);
4903 =for apidoc upg_version
4905 In-place upgrade of the supplied SV to a version object.
4907 SV *sv = upg_version(SV *sv, bool qv);
4909 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4910 to force this SV to be interpreted as an "extended" version.
4916 Perl_upg_version(pTHX_ SV *ver, bool qv)
4918 const char *version, *s;
4923 PERL_ARGS_ASSERT_UPG_VERSION;
4925 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4927 /* may get too much accuracy */
4929 #ifdef USE_LOCALE_NUMERIC
4930 char *loc = setlocale(LC_NUMERIC, "C");
4932 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4933 #ifdef USE_LOCALE_NUMERIC
4934 setlocale(LC_NUMERIC, loc);
4936 while (tbuf[len-1] == '0' && len > 0) len--;
4937 if ( tbuf[len-1] == '.' ) len--; /* eat the trailing decimal */
4938 version = savepvn(tbuf, len);
4941 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4942 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4946 else /* must be a string or something like a string */
4949 version = savepv(SvPV(ver,len));
4951 # if PERL_VERSION > 5
4952 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4953 if ( len >= 3 && !instr(version,".") && !instr(version,"_")
4954 && !(*version == 'u' && strEQ(version, "undef"))
4955 && (*version < '0' || *version > '9') ) {
4956 /* may be a v-string */
4957 SV * const nsv = sv_newmortal();
4960 int saw_decimal = 0;
4961 sv_setpvf(nsv,"v%vd",ver);
4962 pos = nver = savepv(SvPV_nolen(nsv));
4964 /* scan the resulting formatted string */
4965 pos++; /* skip the leading 'v' */
4966 while ( *pos == '.' || isDIGIT(*pos) ) {
4972 /* is definitely a v-string */
4973 if ( saw_decimal >= 2 ) {
4982 s = scan_version(version, ver, qv);
4984 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4985 "Version string '%s' contains invalid data; "
4986 "ignoring: '%s'", version, s);
4994 Validates that the SV contains a valid version object.
4996 bool vverify(SV *vobj);
4998 Note that it only confirms the bare minimum structure (so as not to get
4999 confused by derived classes which may contain additional hash entries):
5003 =item * The SV contains a [reference to a] hash
5005 =item * The hash contains a "version" key
5007 =item * The "version" key has [a reference to] an AV as its value
5015 Perl_vverify(pTHX_ SV *vs)
5019 PERL_ARGS_ASSERT_VVERIFY;
5024 /* see if the appropriate elements exist */
5025 if ( SvTYPE(vs) == SVt_PVHV
5026 && hv_exists(MUTABLE_HV(vs), "version", 7)
5027 && (sv = SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)))
5028 && SvTYPE(sv) == SVt_PVAV )
5037 Accepts a version object and returns the normalized floating
5038 point representation. Call like:
5042 NOTE: you can pass either the object directly or the SV
5043 contained within the RV.
5049 Perl_vnumify(pTHX_ SV *vs)
5057 PERL_ARGS_ASSERT_VNUMIFY;
5063 Perl_croak(aTHX_ "Invalid version object");
5065 /* see if various flags exist */
5066 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
5068 if ( hv_exists(MUTABLE_HV(vs), "width", 5 ) )
5069 width = SvIV(*hv_fetchs(MUTABLE_HV(vs), "width", FALSE));
5074 /* attempt to retrieve the version array */
5075 if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
5076 return newSVpvs("0");
5082 return newSVpvs("0");
5085 digit = SvIV(*av_fetch(av, 0, 0));
5086 sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
5087 for ( i = 1 ; i < len ; i++ )
5089 digit = SvIV(*av_fetch(av, i, 0));
5091 const int denom = (width == 2 ? 10 : 100);
5092 const div_t term = div((int)PERL_ABS(digit),denom);
5093 Perl_sv_catpvf(aTHX_ sv, "%0*d_%d", width, term.quot, term.rem);
5096 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
5102 digit = SvIV(*av_fetch(av, len, 0));
5103 if ( alpha && width == 3 ) /* alpha version */
5105 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
5109 sv_catpvs(sv, "000");
5117 Accepts a version object and returns the normalized string
5118 representation. Call like:
5122 NOTE: you can pass either the object directly or the SV
5123 contained within the RV.
5129 Perl_vnormal(pTHX_ SV *vs)
5136 PERL_ARGS_ASSERT_VNORMAL;
5142 Perl_croak(aTHX_ "Invalid version object");
5144 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
5146 av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
5151 return newSVpvs("");
5153 digit = SvIV(*av_fetch(av, 0, 0));
5154 sv = Perl_newSVpvf(aTHX_ "v%"IVdf, (IV)digit);
5155 for ( i = 1 ; i < len ; i++ ) {
5156 digit = SvIV(*av_fetch(av, i, 0));
5157 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5162 /* handle last digit specially */
5163 digit = SvIV(*av_fetch(av, len, 0));
5165 Perl_sv_catpvf(aTHX_ sv, "_%"IVdf, (IV)digit);
5167 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5170 if ( len <= 2 ) { /* short version, must be at least three */
5171 for ( len = 2 - len; len != 0; len-- )
5178 =for apidoc vstringify
5180 In order to maintain maximum compatibility with earlier versions
5181 of Perl, this function will return either the floating point
5182 notation or the multiple dotted notation, depending on whether
5183 the original version contained 1 or more dots, respectively
5189 Perl_vstringify(pTHX_ SV *vs)
5191 PERL_ARGS_ASSERT_VSTRINGIFY;
5197 Perl_croak(aTHX_ "Invalid version object");
5199 if (hv_exists(MUTABLE_HV(vs), "original", sizeof("original") - 1)) {
5201 pv = *hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
5205 return &PL_sv_undef;
5208 if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
5218 Version object aware cmp. Both operands must already have been
5219 converted into version objects.
5225 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
5228 bool lalpha = FALSE;
5229 bool ralpha = FALSE;
5234 PERL_ARGS_ASSERT_VCMP;
5241 if ( !vverify(lhv) )
5242 Perl_croak(aTHX_ "Invalid version object");
5244 if ( !vverify(rhv) )
5245 Perl_croak(aTHX_ "Invalid version object");
5247 /* get the left hand term */
5248 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
5249 if ( hv_exists(MUTABLE_HV(lhv), "alpha", 5 ) )
5252 /* and the right hand term */
5253 rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
5254 if ( hv_exists(MUTABLE_HV(rhv), "alpha", 5 ) )
5262 while ( i <= m && retval == 0 )
5264 left = SvIV(*av_fetch(lav,i,0));
5265 right = SvIV(*av_fetch(rav,i,0));
5273 /* tiebreaker for alpha with identical terms */
5274 if ( retval == 0 && l == r && left == right && ( lalpha || ralpha ) )
5276 if ( lalpha && !ralpha )
5280 else if ( ralpha && !lalpha)
5286 if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
5290 while ( i <= r && retval == 0 )
5292 if ( SvIV(*av_fetch(rav,i,0)) != 0 )
5293 retval = -1; /* not a match after all */
5299 while ( i <= l && retval == 0 )
5301 if ( SvIV(*av_fetch(lav,i,0)) != 0 )
5302 retval = +1; /* not a match after all */
5310 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
5311 # define EMULATE_SOCKETPAIR_UDP
5314 #ifdef EMULATE_SOCKETPAIR_UDP
5316 S_socketpair_udp (int fd[2]) {
5318 /* Fake a datagram socketpair using UDP to localhost. */
5319 int sockets[2] = {-1, -1};
5320 struct sockaddr_in addresses[2];
5322 Sock_size_t size = sizeof(struct sockaddr_in);
5323 unsigned short port;
5326 memset(&addresses, 0, sizeof(addresses));
5329 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
5330 if (sockets[i] == -1)
5331 goto tidy_up_and_fail;
5333 addresses[i].sin_family = AF_INET;
5334 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5335 addresses[i].sin_port = 0; /* kernel choses port. */
5336 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
5337 sizeof(struct sockaddr_in)) == -1)
5338 goto tidy_up_and_fail;
5341 /* Now have 2 UDP sockets. Find out which port each is connected to, and
5342 for each connect the other socket to it. */
5345 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
5347 goto tidy_up_and_fail;
5348 if (size != sizeof(struct sockaddr_in))
5349 goto abort_tidy_up_and_fail;
5350 /* !1 is 0, !0 is 1 */
5351 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
5352 sizeof(struct sockaddr_in)) == -1)
5353 goto tidy_up_and_fail;
5356 /* Now we have 2 sockets connected to each other. I don't trust some other
5357 process not to have already sent a packet to us (by random) so send
5358 a packet from each to the other. */
5361 /* I'm going to send my own port number. As a short.
5362 (Who knows if someone somewhere has sin_port as a bitfield and needs
5363 this routine. (I'm assuming crays have socketpair)) */
5364 port = addresses[i].sin_port;
5365 got = PerlLIO_write(sockets[i], &port, sizeof(port));
5366 if (got != sizeof(port)) {
5368 goto tidy_up_and_fail;
5369 goto abort_tidy_up_and_fail;
5373 /* Packets sent. I don't trust them to have arrived though.
5374 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
5375 connect to localhost will use a second kernel thread. In 2.6 the
5376 first thread running the connect() returns before the second completes,
5377 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
5378 returns 0. Poor programs have tripped up. One poor program's authors'
5379 had a 50-1 reverse stock split. Not sure how connected these were.)
5380 So I don't trust someone not to have an unpredictable UDP stack.
5384 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
5385 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
5389 FD_SET((unsigned int)sockets[0], &rset);
5390 FD_SET((unsigned int)sockets[1], &rset);
5392 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
5393 if (got != 2 || !FD_ISSET(sockets[0], &rset)
5394 || !FD_ISSET(sockets[1], &rset)) {
5395 /* I hope this is portable and appropriate. */
5397 goto tidy_up_and_fail;
5398 goto abort_tidy_up_and_fail;
5402 /* And the paranoia department even now doesn't trust it to have arrive
5403 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
5405 struct sockaddr_in readfrom;
5406 unsigned short buffer[2];
5411 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5412 sizeof(buffer), MSG_DONTWAIT,
5413 (struct sockaddr *) &readfrom, &size);
5415 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5417 (struct sockaddr *) &readfrom, &size);
5421 goto tidy_up_and_fail;
5422 if (got != sizeof(port)
5423 || size != sizeof(struct sockaddr_in)
5424 /* Check other socket sent us its port. */
5425 || buffer[0] != (unsigned short) addresses[!i].sin_port
5426 /* Check kernel says we got the datagram from that socket */
5427 || readfrom.sin_family != addresses[!i].sin_family
5428 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
5429 || readfrom.sin_port != addresses[!i].sin_port)
5430 goto abort_tidy_up_and_fail;
5433 /* My caller (my_socketpair) has validated that this is non-NULL */
5436 /* I hereby declare this connection open. May God bless all who cross
5440 abort_tidy_up_and_fail:
5441 errno = ECONNABORTED;
5445 if (sockets[0] != -1)
5446 PerlLIO_close(sockets[0]);
5447 if (sockets[1] != -1)
5448 PerlLIO_close(sockets[1]);
5453 #endif /* EMULATE_SOCKETPAIR_UDP */
5455 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
5457 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5458 /* Stevens says that family must be AF_LOCAL, protocol 0.
5459 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
5464 struct sockaddr_in listen_addr;
5465 struct sockaddr_in connect_addr;
5470 || family != AF_UNIX
5473 errno = EAFNOSUPPORT;
5481 #ifdef EMULATE_SOCKETPAIR_UDP
5482 if (type == SOCK_DGRAM)
5483 return S_socketpair_udp(fd);
5486 listener = PerlSock_socket(AF_INET, type, 0);
5489 memset(&listen_addr, 0, sizeof(listen_addr));
5490 listen_addr.sin_family = AF_INET;
5491 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5492 listen_addr.sin_port = 0; /* kernel choses port. */
5493 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
5494 sizeof(listen_addr)) == -1)
5495 goto tidy_up_and_fail;
5496 if (PerlSock_listen(listener, 1) == -1)
5497 goto tidy_up_and_fail;
5499 connector = PerlSock_socket(AF_INET, type, 0);
5500 if (connector == -1)
5501 goto tidy_up_and_fail;
5502 /* We want to find out the port number to connect to. */
5503 size = sizeof(connect_addr);
5504 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
5506 goto tidy_up_and_fail;
5507 if (size != sizeof(connect_addr))
5508 goto abort_tidy_up_and_fail;
5509 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
5510 sizeof(connect_addr)) == -1)
5511 goto tidy_up_and_fail;
5513 size = sizeof(listen_addr);
5514 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
5517 goto tidy_up_and_fail;
5518 if (size != sizeof(listen_addr))
5519 goto abort_tidy_up_and_fail;
5520 PerlLIO_close(listener);
5521 /* Now check we are talking to ourself by matching port and host on the
5523 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
5525 goto tidy_up_and_fail;
5526 if (size != sizeof(connect_addr)
5527 || listen_addr.sin_family != connect_addr.sin_family
5528 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
5529 || listen_addr.sin_port != connect_addr.sin_port) {
5530 goto abort_tidy_up_and_fail;
5536 abort_tidy_up_and_fail:
5538 errno = ECONNABORTED; /* This would be the standard thing to do. */
5540 # ifdef ECONNREFUSED
5541 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
5543 errno = ETIMEDOUT; /* Desperation time. */
5550 PerlLIO_close(listener);
5551 if (connector != -1)
5552 PerlLIO_close(connector);
5554 PerlLIO_close(acceptor);
5560 /* In any case have a stub so that there's code corresponding
5561 * to the my_socketpair in global.sym. */
5563 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5564 #ifdef HAS_SOCKETPAIR
5565 return socketpair(family, type, protocol, fd);
5574 =for apidoc sv_nosharing
5576 Dummy routine which "shares" an SV when there is no sharing module present.
5577 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
5578 Exists to avoid test for a NULL function pointer and because it could
5579 potentially warn under some level of strict-ness.
5585 Perl_sv_nosharing(pTHX_ SV *sv)
5587 PERL_UNUSED_CONTEXT;
5588 PERL_UNUSED_ARG(sv);
5593 =for apidoc sv_destroyable
5595 Dummy routine which reports that object can be destroyed when there is no
5596 sharing module present. It ignores its single SV argument, and returns
5597 'true'. Exists to avoid test for a NULL function pointer and because it
5598 could potentially warn under some level of strict-ness.
5604 Perl_sv_destroyable(pTHX_ SV *sv)
5606 PERL_UNUSED_CONTEXT;
5607 PERL_UNUSED_ARG(sv);
5612 Perl_parse_unicode_opts(pTHX_ const char **popt)
5614 const char *p = *popt;
5617 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
5621 opt = (U32) atoi(p);
5624 if (*p && *p != '\n' && *p != '\r')
5625 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
5630 case PERL_UNICODE_STDIN:
5631 opt |= PERL_UNICODE_STDIN_FLAG; break;
5632 case PERL_UNICODE_STDOUT:
5633 opt |= PERL_UNICODE_STDOUT_FLAG; break;
5634 case PERL_UNICODE_STDERR:
5635 opt |= PERL_UNICODE_STDERR_FLAG; break;
5636 case PERL_UNICODE_STD:
5637 opt |= PERL_UNICODE_STD_FLAG; break;
5638 case PERL_UNICODE_IN:
5639 opt |= PERL_UNICODE_IN_FLAG; break;
5640 case PERL_UNICODE_OUT:
5641 opt |= PERL_UNICODE_OUT_FLAG; break;
5642 case PERL_UNICODE_INOUT:
5643 opt |= PERL_UNICODE_INOUT_FLAG; break;
5644 case PERL_UNICODE_LOCALE:
5645 opt |= PERL_UNICODE_LOCALE_FLAG; break;
5646 case PERL_UNICODE_ARGV:
5647 opt |= PERL_UNICODE_ARGV_FLAG; break;
5648 case PERL_UNICODE_UTF8CACHEASSERT:
5649 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
5651 if (*p != '\n' && *p != '\r')
5653 "Unknown Unicode option letter '%c'", *p);
5659 opt = PERL_UNICODE_DEFAULT_FLAGS;
5661 if (opt & ~PERL_UNICODE_ALL_FLAGS)
5662 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
5663 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
5675 * This is really just a quick hack which grabs various garbage
5676 * values. It really should be a real hash algorithm which
5677 * spreads the effect of every input bit onto every output bit,
5678 * if someone who knows about such things would bother to write it.
5679 * Might be a good idea to add that function to CORE as well.
5680 * No numbers below come from careful analysis or anything here,
5681 * except they are primes and SEED_C1 > 1E6 to get a full-width
5682 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
5683 * probably be bigger too.
5686 # define SEED_C1 1000003
5687 #define SEED_C4 73819
5689 # define SEED_C1 25747
5690 #define SEED_C4 20639
5694 #define SEED_C5 26107
5696 #ifndef PERL_NO_DEV_RANDOM
5701 # include <starlet.h>
5702 /* when[] = (low 32 bits, high 32 bits) of time since epoch
5703 * in 100-ns units, typically incremented ever 10 ms. */
5704 unsigned int when[2];
5706 # ifdef HAS_GETTIMEOFDAY
5707 struct timeval when;
5713 /* This test is an escape hatch, this symbol isn't set by Configure. */
5714 #ifndef PERL_NO_DEV_RANDOM
5715 #ifndef PERL_RANDOM_DEVICE
5716 /* /dev/random isn't used by default because reads from it will block
5717 * if there isn't enough entropy available. You can compile with
5718 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
5719 * is enough real entropy to fill the seed. */
5720 # define PERL_RANDOM_DEVICE "/dev/urandom"
5722 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
5724 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
5733 _ckvmssts(sys$gettim(when));
5734 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
5736 # ifdef HAS_GETTIMEOFDAY
5737 PerlProc_gettimeofday(&when,NULL);
5738 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
5741 u = (U32)SEED_C1 * when;
5744 u += SEED_C3 * (U32)PerlProc_getpid();
5745 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
5746 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
5747 u += SEED_C5 * (U32)PTR2UV(&when);
5753 Perl_get_hash_seed(pTHX)
5756 const char *s = PerlEnv_getenv("PERL_HASH_SEED");
5762 if (s && isDIGIT(*s))
5763 myseed = (UV)Atoul(s);
5765 #ifdef USE_HASH_SEED_EXPLICIT
5769 /* Compute a random seed */
5770 (void)seedDrand01((Rand_seed_t)seed());
5771 myseed = (UV)(Drand01() * (NV)UV_MAX);
5772 #if RANDBITS < (UVSIZE * 8)
5773 /* Since there are not enough randbits to to reach all
5774 * the bits of a UV, the low bits might need extra
5775 * help. Sum in another random number that will
5776 * fill in the low bits. */
5778 (UV)(Drand01() * (NV)((((UV)1) << ((UVSIZE * 8 - RANDBITS))) - 1));
5779 #endif /* RANDBITS < (UVSIZE * 8) */
5780 if (myseed == 0) { /* Superparanoia. */
5781 myseed = (UV)(Drand01() * (NV)UV_MAX); /* One more chance. */
5783 Perl_croak(aTHX_ "Your random numbers are not that random");
5786 PL_rehash_seed_set = TRUE;
5793 Perl_stashpv_hvname_match(pTHX_ const COP *c, const HV *hv)
5795 const char * const stashpv = CopSTASHPV(c);
5796 const char * const name = HvNAME_get(hv);
5797 PERL_UNUSED_CONTEXT;
5798 PERL_ARGS_ASSERT_STASHPV_HVNAME_MATCH;
5800 if (stashpv == name)
5802 if (stashpv && name)
5803 if (strEQ(stashpv, name))
5810 #ifdef PERL_GLOBAL_STRUCT
5812 #define PERL_GLOBAL_STRUCT_INIT
5813 #include "opcode.h" /* the ppaddr and check */
5816 Perl_init_global_struct(pTHX)
5818 struct perl_vars *plvarsp = NULL;
5819 # ifdef PERL_GLOBAL_STRUCT
5820 const IV nppaddr = sizeof(Gppaddr)/sizeof(Perl_ppaddr_t);
5821 const IV ncheck = sizeof(Gcheck) /sizeof(Perl_check_t);
5822 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5823 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
5824 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
5828 plvarsp = PL_VarsPtr;
5829 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
5835 # define PERLVAR(var,type) /**/
5836 # define PERLVARA(var,n,type) /**/
5837 # define PERLVARI(var,type,init) plvarsp->var = init;
5838 # define PERLVARIC(var,type,init) plvarsp->var = init;
5839 # define PERLVARISC(var,init) Copy(init, plvarsp->var, sizeof(init), char);
5840 # include "perlvars.h"
5846 # ifdef PERL_GLOBAL_STRUCT
5849 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
5850 if (!plvarsp->Gppaddr)
5854 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
5855 if (!plvarsp->Gcheck)
5857 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
5858 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
5860 # ifdef PERL_SET_VARS
5861 PERL_SET_VARS(plvarsp);
5863 # undef PERL_GLOBAL_STRUCT_INIT
5868 #endif /* PERL_GLOBAL_STRUCT */
5870 #ifdef PERL_GLOBAL_STRUCT
5873 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
5875 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
5876 # ifdef PERL_GLOBAL_STRUCT
5877 # ifdef PERL_UNSET_VARS
5878 PERL_UNSET_VARS(plvarsp);
5880 free(plvarsp->Gppaddr);
5881 free(plvarsp->Gcheck);
5882 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5888 #endif /* PERL_GLOBAL_STRUCT */
5892 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
5893 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5894 * given, and you supply your own implementation.
5896 * The default implementation reads a single env var, PERL_MEM_LOG,
5897 * expecting one or more of the following:
5899 * \d+ - fd fd to write to : must be 1st (atoi)
5900 * 'm' - memlog was PERL_MEM_LOG=1
5901 * 's' - svlog was PERL_SV_LOG=1
5902 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5904 * This makes the logger controllable enough that it can reasonably be
5905 * added to the system perl.
5908 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5909 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5911 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
5913 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5914 * writes to. In the default logger, this is settable at runtime.
5916 #ifndef PERL_MEM_LOG_FD
5917 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5920 #ifndef PERL_MEM_LOG_NOIMPL
5922 # ifdef DEBUG_LEAKING_SCALARS
5923 # define SV_LOG_SERIAL_FMT " [%lu]"
5924 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5926 # define SV_LOG_SERIAL_FMT
5927 # define _SV_LOG_SERIAL_ARG(sv)
5931 S_mem_log_common(enum mem_log_type mlt, const UV n,
5932 const UV typesize, const char *type_name, const SV *sv,
5933 Malloc_t oldalloc, Malloc_t newalloc,
5934 const char *filename, const int linenumber,
5935 const char *funcname)
5939 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5941 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5944 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5946 /* We can't use SVs or PerlIO for obvious reasons,
5947 * so we'll use stdio and low-level IO instead. */
5948 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5950 # ifdef HAS_GETTIMEOFDAY
5951 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5952 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5954 gettimeofday(&tv, 0);
5956 # define MEM_LOG_TIME_FMT "%10d: "
5957 # define MEM_LOG_TIME_ARG (int)when
5961 /* If there are other OS specific ways of hires time than
5962 * gettimeofday() (see ext/Time-HiRes), the easiest way is
5963 * probably that they would be used to fill in the struct
5967 int fd = atoi(pmlenv);
5969 fd = PERL_MEM_LOG_FD;
5971 if (strchr(pmlenv, 't')) {
5972 len = my_snprintf(buf, sizeof(buf),
5973 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5974 PerlLIO_write(fd, buf, len);
5978 len = my_snprintf(buf, sizeof(buf),
5979 "alloc: %s:%d:%s: %"IVdf" %"UVuf
5980 " %s = %"IVdf": %"UVxf"\n",
5981 filename, linenumber, funcname, n, typesize,
5982 type_name, n * typesize, PTR2UV(newalloc));
5985 len = my_snprintf(buf, sizeof(buf),
5986 "realloc: %s:%d:%s: %"IVdf" %"UVuf
5987 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
5988 filename, linenumber, funcname, n, typesize,
5989 type_name, n * typesize, PTR2UV(oldalloc),
5993 len = my_snprintf(buf, sizeof(buf),
5994 "free: %s:%d:%s: %"UVxf"\n",
5995 filename, linenumber, funcname,
6000 len = my_snprintf(buf, sizeof(buf),
6001 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
6002 mlt == MLT_NEW_SV ? "new" : "del",
6003 filename, linenumber, funcname,
6004 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
6009 PerlLIO_write(fd, buf, len);
6013 #endif /* !PERL_MEM_LOG_NOIMPL */
6015 #ifndef PERL_MEM_LOG_NOIMPL
6017 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
6018 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
6020 /* this is suboptimal, but bug compatible. User is providing their
6021 own implemenation, but is getting these functions anyway, and they
6022 do nothing. But _NOIMPL users should be able to cope or fix */
6024 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
6025 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
6029 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
6031 const char *filename, const int linenumber,
6032 const char *funcname)
6034 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
6035 NULL, NULL, newalloc,
6036 filename, linenumber, funcname);
6041 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
6042 Malloc_t oldalloc, Malloc_t newalloc,
6043 const char *filename, const int linenumber,
6044 const char *funcname)
6046 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
6047 NULL, oldalloc, newalloc,
6048 filename, linenumber, funcname);
6053 Perl_mem_log_free(Malloc_t oldalloc,
6054 const char *filename, const int linenumber,
6055 const char *funcname)
6057 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
6058 filename, linenumber, funcname);
6063 Perl_mem_log_new_sv(const SV *sv,
6064 const char *filename, const int linenumber,
6065 const char *funcname)
6067 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
6068 filename, linenumber, funcname);
6072 Perl_mem_log_del_sv(const SV *sv,
6073 const char *filename, const int linenumber,
6074 const char *funcname)
6076 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
6077 filename, linenumber, funcname);
6080 #endif /* PERL_MEM_LOG */
6083 =for apidoc my_sprintf
6085 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
6086 the length of the string written to the buffer. Only rare pre-ANSI systems
6087 need the wrapper function - usually this is a direct call to C<sprintf>.
6091 #ifndef SPRINTF_RETURNS_STRLEN
6093 Perl_my_sprintf(char *buffer, const char* pat, ...)
6096 PERL_ARGS_ASSERT_MY_SPRINTF;
6097 va_start(args, pat);
6098 vsprintf(buffer, pat, args);
6100 return strlen(buffer);
6105 =for apidoc my_snprintf
6107 The C library C<snprintf> functionality, if available and
6108 standards-compliant (uses C<vsnprintf>, actually). However, if the
6109 C<vsnprintf> is not available, will unfortunately use the unsafe
6110 C<vsprintf> which can overrun the buffer (there is an overrun check,
6111 but that may be too late). Consider using C<sv_vcatpvf> instead, or
6112 getting C<vsnprintf>.
6117 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
6122 PERL_ARGS_ASSERT_MY_SNPRINTF;
6123 va_start(ap, format);
6124 #ifdef HAS_VSNPRINTF
6125 retval = vsnprintf(buffer, len, format, ap);
6127 retval = vsprintf(buffer, format, ap);
6130 /* vsnprintf() shows failure with >= len, vsprintf() with < 0 */
6131 if (retval < 0 || (len > 0 && (Size_t)retval >= len))
6132 Perl_croak(aTHX_ "panic: my_snprintf buffer overflow");
6137 =for apidoc my_vsnprintf
6139 The C library C<vsnprintf> if available and standards-compliant.
6140 However, if if the C<vsnprintf> is not available, will unfortunately
6141 use the unsafe C<vsprintf> which can overrun the buffer (there is an
6142 overrun check, but that may be too late). Consider using
6143 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
6148 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
6155 PERL_ARGS_ASSERT_MY_VSNPRINTF;
6157 Perl_va_copy(ap, apc);
6158 # ifdef HAS_VSNPRINTF
6159 retval = vsnprintf(buffer, len, format, apc);
6161 retval = vsprintf(buffer, format, apc);
6164 # ifdef HAS_VSNPRINTF
6165 retval = vsnprintf(buffer, len, format, ap);
6167 retval = vsprintf(buffer, format, ap);
6169 #endif /* #ifdef NEED_VA_COPY */
6170 /* vsnprintf() shows failure with >= len, vsprintf() with < 0 */
6171 if (retval < 0 || (len > 0 && (Size_t)retval >= len))
6172 Perl_croak(aTHX_ "panic: my_vsnprintf buffer overflow");
6177 Perl_my_clearenv(pTHX)
6180 #if ! defined(PERL_MICRO)
6181 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
6183 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
6184 # if defined(USE_ENVIRON_ARRAY)
6185 # if defined(USE_ITHREADS)
6186 /* only the parent thread can clobber the process environment */
6187 if (PL_curinterp == aTHX)
6188 # endif /* USE_ITHREADS */
6190 # if ! defined(PERL_USE_SAFE_PUTENV)
6191 if ( !PL_use_safe_putenv) {
6193 if (environ == PL_origenviron)
6194 environ = (char**)safesysmalloc(sizeof(char*));
6196 for (i = 0; environ[i]; i++)
6197 (void)safesysfree(environ[i]);
6200 # else /* PERL_USE_SAFE_PUTENV */
6201 # if defined(HAS_CLEARENV)
6203 # elif defined(HAS_UNSETENV)
6204 int bsiz = 80; /* Most envvar names will be shorter than this. */
6205 int bufsiz = bsiz * sizeof(char); /* sizeof(char) paranoid? */
6206 char *buf = (char*)safesysmalloc(bufsiz);
6207 while (*environ != NULL) {
6208 char *e = strchr(*environ, '=');
6209 int l = e ? e - *environ : (int)strlen(*environ);
6211 (void)safesysfree(buf);
6212 bsiz = l + 1; /* + 1 for the \0. */
6213 buf = (char*)safesysmalloc(bufsiz);
6215 memcpy(buf, *environ, l);
6217 (void)unsetenv(buf);
6219 (void)safesysfree(buf);
6220 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
6221 /* Just null environ and accept the leakage. */
6223 # endif /* HAS_CLEARENV || HAS_UNSETENV */
6224 # endif /* ! PERL_USE_SAFE_PUTENV */
6226 # endif /* USE_ENVIRON_ARRAY */
6227 # endif /* PERL_IMPLICIT_SYS || WIN32 */
6228 #endif /* PERL_MICRO */
6231 #ifdef PERL_IMPLICIT_CONTEXT
6233 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
6234 the global PL_my_cxt_index is incremented, and that value is assigned to
6235 that module's static my_cxt_index (who's address is passed as an arg).
6236 Then, for each interpreter this function is called for, it makes sure a
6237 void* slot is available to hang the static data off, by allocating or
6238 extending the interpreter's PL_my_cxt_list array */
6240 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
6242 Perl_my_cxt_init(pTHX_ int *index, size_t size)
6246 PERL_ARGS_ASSERT_MY_CXT_INIT;
6248 /* this module hasn't been allocated an index yet */
6249 #if defined(USE_ITHREADS)
6250 MUTEX_LOCK(&PL_my_ctx_mutex);
6252 *index = PL_my_cxt_index++;
6253 #if defined(USE_ITHREADS)
6254 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6258 /* make sure the array is big enough */
6259 if (PL_my_cxt_size <= *index) {
6260 if (PL_my_cxt_size) {
6261 while (PL_my_cxt_size <= *index)
6262 PL_my_cxt_size *= 2;
6263 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6266 PL_my_cxt_size = 16;
6267 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6270 /* newSV() allocates one more than needed */
6271 p = (void*)SvPVX(newSV(size-1));
6272 PL_my_cxt_list[*index] = p;
6273 Zero(p, size, char);
6277 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6280 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
6285 PERL_ARGS_ASSERT_MY_CXT_INDEX;
6287 for (index = 0; index < PL_my_cxt_index; index++) {
6288 const char *key = PL_my_cxt_keys[index];
6289 /* try direct pointer compare first - there are chances to success,
6290 * and it's much faster.
6292 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
6299 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
6305 PERL_ARGS_ASSERT_MY_CXT_INIT;
6307 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
6309 /* this module hasn't been allocated an index yet */
6310 #if defined(USE_ITHREADS)
6311 MUTEX_LOCK(&PL_my_ctx_mutex);
6313 index = PL_my_cxt_index++;
6314 #if defined(USE_ITHREADS)
6315 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6319 /* make sure the array is big enough */
6320 if (PL_my_cxt_size <= index) {
6321 int old_size = PL_my_cxt_size;
6323 if (PL_my_cxt_size) {
6324 while (PL_my_cxt_size <= index)
6325 PL_my_cxt_size *= 2;
6326 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6327 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6330 PL_my_cxt_size = 16;
6331 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6332 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6334 for (i = old_size; i < PL_my_cxt_size; i++) {
6335 PL_my_cxt_keys[i] = 0;
6336 PL_my_cxt_list[i] = 0;
6339 PL_my_cxt_keys[index] = my_cxt_key;
6340 /* newSV() allocates one more than needed */
6341 p = (void*)SvPVX(newSV(size-1));
6342 PL_my_cxt_list[index] = p;
6343 Zero(p, size, char);
6346 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6347 #endif /* PERL_IMPLICIT_CONTEXT */
6351 Perl_my_strlcat(char *dst, const char *src, Size_t size)
6353 Size_t used, length, copy;
6356 length = strlen(src);
6357 if (size > 0 && used < size - 1) {
6358 copy = (length >= size - used) ? size - used - 1 : length;
6359 memcpy(dst + used, src, copy);
6360 dst[used + copy] = '\0';
6362 return used + length;
6368 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
6370 Size_t length, copy;
6372 length = strlen(src);
6374 copy = (length >= size) ? size - 1 : length;
6375 memcpy(dst, src, copy);
6382 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
6383 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
6384 long _ftol( double ); /* Defined by VC6 C libs. */
6385 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
6389 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
6392 SV * const dbsv = GvSVn(PL_DBsub);
6393 /* We do not care about using sv to call CV;
6394 * it's for informational purposes only.
6397 PERL_ARGS_ASSERT_GET_DB_SUB;
6400 if (!PERLDB_SUB_NN) {
6401 GV * const gv = CvGV(cv);
6403 if ( svp && ((CvFLAGS(cv) & (CVf_ANON | CVf_CLONED))
6404 || strEQ(GvNAME(gv), "END")
6405 || ((GvCV(gv) != cv) && /* Could be imported, and old sub redefined. */
6406 !( (SvTYPE(*svp) == SVt_PVGV)
6407 && (GvCV((const GV *)*svp) == cv) )))) {
6408 /* Use GV from the stack as a fallback. */
6409 /* GV is potentially non-unique, or contain different CV. */
6410 SV * const tmp = newRV(MUTABLE_SV(cv));
6411 sv_setsv(dbsv, tmp);
6415 gv_efullname3(dbsv, gv, NULL);
6419 const int type = SvTYPE(dbsv);
6420 if (type < SVt_PVIV && type != SVt_IV)
6421 sv_upgrade(dbsv, SVt_PVIV);
6422 (void)SvIOK_on(dbsv);
6423 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
6428 Perl_my_dirfd(pTHX_ DIR * dir) {
6430 /* Most dirfd implementations have problems when passed NULL. */
6435 #elif defined(HAS_DIR_DD_FD)
6438 Perl_die(aTHX_ PL_no_func, "dirfd");
6445 Perl_get_re_arg(pTHX_ SV *sv) {
6451 sv = MUTABLE_SV(SvRV(sv));
6452 if (SvTYPE(sv) == SVt_REGEXP)
6453 return (REGEXP*) sv;
6461 * c-indentation-style: bsd
6463 * indent-tabs-mode: t
6466 * ex: set ts=8 sts=4 sw=4 noet: