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)
82 PerlIO_printf(Perl_error_log,
83 "Allocation too large: %lx\n", size) FLUSH;
86 #endif /* HAS_64K_LIMIT */
87 #ifdef PERL_TRACK_MEMPOOL
92 Perl_croak_nocontext("panic: malloc");
94 ptr = (Malloc_t)PerlMem_malloc(size?size:1); /* malloc(0) is NASTY on our system */
95 PERL_ALLOC_CHECK(ptr);
96 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
98 #ifdef PERL_TRACK_MEMPOOL
99 struct perl_memory_debug_header *const header
100 = (struct perl_memory_debug_header *)ptr;
104 PoisonNew(((char *)ptr), size, char);
107 #ifdef PERL_TRACK_MEMPOOL
108 header->interpreter = aTHX;
109 /* Link us into the list. */
110 header->prev = &PL_memory_debug_header;
111 header->next = PL_memory_debug_header.next;
112 PL_memory_debug_header.next = header;
113 header->next->prev = header;
117 ptr = (Malloc_t)((char*)ptr+sTHX);
124 return write_no_mem();
129 /* paranoid version of system's realloc() */
132 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
136 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
137 Malloc_t PerlMem_realloc();
138 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
142 PerlIO_printf(Perl_error_log,
143 "Reallocation too large: %lx\n", size) FLUSH;
146 #endif /* HAS_64K_LIMIT */
153 return safesysmalloc(size);
154 #ifdef PERL_TRACK_MEMPOOL
155 where = (Malloc_t)((char*)where-sTHX);
158 struct perl_memory_debug_header *const header
159 = (struct perl_memory_debug_header *)where;
161 if (header->interpreter != aTHX) {
162 Perl_croak_nocontext("panic: realloc from wrong pool");
164 assert(header->next->prev == header);
165 assert(header->prev->next == header);
167 if (header->size > size) {
168 const MEM_SIZE freed_up = header->size - size;
169 char *start_of_freed = ((char *)where) + size;
170 PoisonFree(start_of_freed, freed_up, char);
178 Perl_croak_nocontext("panic: realloc");
180 ptr = (Malloc_t)PerlMem_realloc(where,size);
181 PERL_ALLOC_CHECK(ptr);
183 /* MUST do this fixup first, before doing ANYTHING else, as anything else
184 might allocate memory/free/move memory, and until we do the fixup, it
185 may well be chasing (and writing to) free memory. */
186 #ifdef PERL_TRACK_MEMPOOL
188 struct perl_memory_debug_header *const header
189 = (struct perl_memory_debug_header *)ptr;
192 if (header->size < size) {
193 const MEM_SIZE fresh = size - header->size;
194 char *start_of_fresh = ((char *)ptr) + size;
195 PoisonNew(start_of_fresh, fresh, char);
199 header->next->prev = header;
200 header->prev->next = header;
202 ptr = (Malloc_t)((char*)ptr+sTHX);
206 /* In particular, must do that fixup above before logging anything via
207 *printf(), as it can reallocate memory, which can cause SEGVs. */
209 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
210 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
219 return write_no_mem();
224 /* safe version of system's free() */
227 Perl_safesysfree(Malloc_t where)
229 #if defined(PERL_IMPLICIT_SYS) || defined(PERL_TRACK_MEMPOOL)
234 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
236 #ifdef PERL_TRACK_MEMPOOL
237 where = (Malloc_t)((char*)where-sTHX);
239 struct perl_memory_debug_header *const header
240 = (struct perl_memory_debug_header *)where;
242 if (header->interpreter != aTHX) {
243 Perl_croak_nocontext("panic: free from wrong pool");
246 Perl_croak_nocontext("panic: duplicate free");
248 if (!(header->next) || header->next->prev != header
249 || header->prev->next != header) {
250 Perl_croak_nocontext("panic: bad free");
252 /* Unlink us from the chain. */
253 header->next->prev = header->prev;
254 header->prev->next = header->next;
256 PoisonNew(where, header->size, char);
258 /* Trigger the duplicate free warning. */
266 /* safe version of system's calloc() */
269 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
273 MEM_SIZE total_size = 0;
275 /* Even though calloc() for zero bytes is strange, be robust. */
276 if (size && (count <= MEM_SIZE_MAX / size))
277 total_size = size * count;
279 Perl_croak_nocontext("%s", PL_memory_wrap);
280 #ifdef PERL_TRACK_MEMPOOL
281 if (sTHX <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
284 Perl_croak_nocontext("%s", PL_memory_wrap);
287 if (total_size > 0xffff) {
288 PerlIO_printf(Perl_error_log,
289 "Allocation too large: %lx\n", total_size) FLUSH;
292 #endif /* HAS_64K_LIMIT */
294 if ((long)size < 0 || (long)count < 0)
295 Perl_croak_nocontext("panic: calloc");
297 #ifdef PERL_TRACK_MEMPOOL
298 /* Have to use malloc() because we've added some space for our tracking
300 /* malloc(0) is non-portable. */
301 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
303 /* Use calloc() because it might save a memset() if the memory is fresh
304 and clean from the OS. */
306 ptr = (Malloc_t)PerlMem_calloc(count, size);
307 else /* calloc(0) is non-portable. */
308 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
310 PERL_ALLOC_CHECK(ptr);
311 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));
313 #ifdef PERL_TRACK_MEMPOOL
315 struct perl_memory_debug_header *const header
316 = (struct perl_memory_debug_header *)ptr;
318 memset((void*)ptr, 0, total_size);
319 header->interpreter = aTHX;
320 /* Link us into the list. */
321 header->prev = &PL_memory_debug_header;
322 header->next = PL_memory_debug_header.next;
323 PL_memory_debug_header.next = header;
324 header->next->prev = header;
326 header->size = total_size;
328 ptr = (Malloc_t)((char*)ptr+sTHX);
335 return write_no_mem();
338 /* These must be defined when not using Perl's malloc for binary
343 Malloc_t Perl_malloc (MEM_SIZE nbytes)
346 return (Malloc_t)PerlMem_malloc(nbytes);
349 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
352 return (Malloc_t)PerlMem_calloc(elements, size);
355 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
358 return (Malloc_t)PerlMem_realloc(where, nbytes);
361 Free_t Perl_mfree (Malloc_t where)
369 /* copy a string up to some (non-backslashed) delimiter, if any */
372 Perl_delimcpy(register char *to, register const char *toend, register const char *from, register const char *fromend, register int delim, I32 *retlen)
376 PERL_ARGS_ASSERT_DELIMCPY;
378 for (tolen = 0; from < fromend; from++, tolen++) {
380 if (from[1] != delim) {
387 else if (*from == delim)
398 /* return ptr to little string in big string, NULL if not found */
399 /* This routine was donated by Corey Satten. */
402 Perl_instr(register const char *big, register const char *little)
406 PERL_ARGS_ASSERT_INSTR;
414 register const char *s, *x;
417 for (x=big,s=little; *s; /**/ ) {
428 return (char*)(big-1);
433 /* same as instr but allow embedded nulls */
436 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
438 PERL_ARGS_ASSERT_NINSTR;
442 const char first = *little;
444 bigend -= lend - little++;
446 while (big <= bigend) {
447 if (*big++ == first) {
448 for (x=big,s=little; s < lend; x++,s++) {
452 return (char*)(big-1);
459 /* reverse of the above--find last substring */
462 Perl_rninstr(register const char *big, const char *bigend, const char *little, const char *lend)
464 register const char *bigbeg;
465 register const I32 first = *little;
466 register const char * const littleend = lend;
468 PERL_ARGS_ASSERT_RNINSTR;
470 if (little >= littleend)
471 return (char*)bigend;
473 big = bigend - (littleend - little++);
474 while (big >= bigbeg) {
475 register const char *s, *x;
478 for (x=big+2,s=little; s < littleend; /**/ ) {
487 return (char*)(big+1);
492 /* As a space optimization, we do not compile tables for strings of length
493 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
494 special-cased in fbm_instr().
496 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
499 =head1 Miscellaneous Functions
501 =for apidoc fbm_compile
503 Analyses the string in order to make fast searches on it using fbm_instr()
504 -- the Boyer-Moore algorithm.
510 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
513 register const U8 *s;
519 PERL_ARGS_ASSERT_FBM_COMPILE;
521 if (flags & FBMcf_TAIL) {
522 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
523 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
524 if (mg && mg->mg_len >= 0)
527 s = (U8*)SvPV_force_mutable(sv, len);
528 if (len == 0) /* TAIL might be on a zero-length string. */
530 SvUPGRADE(sv, SVt_PVGV);
535 const unsigned char *sb;
536 const U8 mlen = (len>255) ? 255 : (U8)len;
539 Sv_Grow(sv, len + 256 + PERL_FBM_TABLE_OFFSET);
541 = (unsigned char*)(SvPVX_mutable(sv) + len + PERL_FBM_TABLE_OFFSET);
542 s = table - 1 - PERL_FBM_TABLE_OFFSET; /* last char */
543 memset((void*)table, mlen, 256);
545 sb = s - mlen + 1; /* first char (maybe) */
547 if (table[*s] == mlen)
552 Sv_Grow(sv, len + PERL_FBM_TABLE_OFFSET);
554 sv_magic(sv, NULL, PERL_MAGIC_bm, NULL, 0); /* deep magic */
556 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
557 for (i = 0; i < len; i++) {
558 if (PL_freq[s[i]] < frequency) {
560 frequency = PL_freq[s[i]];
563 BmFLAGS(sv) = (U8)flags;
564 BmRARE(sv) = s[rarest];
565 BmPREVIOUS(sv) = rarest;
566 BmUSEFUL(sv) = 100; /* Initial value */
567 if (flags & FBMcf_TAIL)
569 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %lu\n",
570 BmRARE(sv),(unsigned long)BmPREVIOUS(sv)));
573 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
574 /* If SvTAIL is actually due to \Z or \z, this gives false positives
578 =for apidoc fbm_instr
580 Returns the location of the SV in the string delimited by C<str> and
581 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
582 does not have to be fbm_compiled, but the search will not be as fast
589 Perl_fbm_instr(pTHX_ unsigned char *big, register unsigned char *bigend, SV *littlestr, U32 flags)
591 register unsigned char *s;
593 register const unsigned char *little
594 = (const unsigned char *)SvPV_const(littlestr,l);
595 register STRLEN littlelen = l;
596 register const I32 multiline = flags & FBMrf_MULTILINE;
598 PERL_ARGS_ASSERT_FBM_INSTR;
600 if ((STRLEN)(bigend - big) < littlelen) {
601 if ( SvTAIL(littlestr)
602 && ((STRLEN)(bigend - big) == littlelen - 1)
604 || (*big == *little &&
605 memEQ((char *)big, (char *)little, littlelen - 1))))
610 if (littlelen <= 2) { /* Special-cased */
612 if (littlelen == 1) {
613 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
614 /* Know that bigend != big. */
615 if (bigend[-1] == '\n')
616 return (char *)(bigend - 1);
617 return (char *) bigend;
625 if (SvTAIL(littlestr))
626 return (char *) bigend;
630 return (char*)big; /* Cannot be SvTAIL! */
633 if (SvTAIL(littlestr) && !multiline) {
634 if (bigend[-1] == '\n' && bigend[-2] == *little)
635 return (char*)bigend - 2;
636 if (bigend[-1] == *little)
637 return (char*)bigend - 1;
641 /* This should be better than FBM if c1 == c2, and almost
642 as good otherwise: maybe better since we do less indirection.
643 And we save a lot of memory by caching no table. */
644 const unsigned char c1 = little[0];
645 const unsigned char c2 = little[1];
650 while (s <= bigend) {
660 goto check_1char_anchor;
671 goto check_1char_anchor;
674 while (s <= bigend) {
679 goto check_1char_anchor;
688 check_1char_anchor: /* One char and anchor! */
689 if (SvTAIL(littlestr) && (*bigend == *little))
690 return (char *)bigend; /* bigend is already decremented. */
693 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
694 s = bigend - littlelen;
695 if (s >= big && bigend[-1] == '\n' && *s == *little
696 /* Automatically of length > 2 */
697 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
699 return (char*)s; /* how sweet it is */
702 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
704 return (char*)s + 1; /* how sweet it is */
708 if (!SvVALID(littlestr)) {
709 char * const b = ninstr((char*)big,(char*)bigend,
710 (char*)little, (char*)little + littlelen);
712 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
713 /* Chop \n from littlestr: */
714 s = bigend - littlelen + 1;
716 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
726 if (littlelen > (STRLEN)(bigend - big))
730 register const unsigned char * const table
731 = little + littlelen + PERL_FBM_TABLE_OFFSET;
732 register const unsigned char *oldlittle;
734 --littlelen; /* Last char found by table lookup */
737 little += littlelen; /* last char */
743 if ((tmp = table[*s])) {
744 if ((s += tmp) < bigend)
748 else { /* less expensive than calling strncmp() */
749 register unsigned char * const olds = s;
754 if (*--s == *--little)
756 s = olds + 1; /* here we pay the price for failure */
758 if (s < bigend) /* fake up continue to outer loop */
767 && (BmFLAGS(littlestr) & FBMcf_TAIL)
768 && memEQ((char *)(bigend - littlelen),
769 (char *)(oldlittle - littlelen), littlelen) )
770 return (char*)bigend - littlelen;
775 /* start_shift, end_shift are positive quantities which give offsets
776 of ends of some substring of bigstr.
777 If "last" we want the last occurrence.
778 old_posp is the way of communication between consequent calls if
779 the next call needs to find the .
780 The initial *old_posp should be -1.
782 Note that we take into account SvTAIL, so one can get extra
783 optimizations if _ALL flag is set.
786 /* If SvTAIL is actually due to \Z or \z, this gives false positives
787 if PL_multiline. In fact if !PL_multiline the authoritative answer
788 is not supported yet. */
791 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
794 register const unsigned char *big;
796 register I32 previous;
798 register const unsigned char *little;
799 register I32 stop_pos;
800 register const unsigned char *littleend;
803 PERL_ARGS_ASSERT_SCREAMINSTR;
805 assert(SvTYPE(littlestr) == SVt_PVGV);
806 assert(SvVALID(littlestr));
809 ? (pos = PL_screamfirst[BmRARE(littlestr)]) < 0
810 : (((pos = *old_posp), pos += PL_screamnext[pos]) == 0)) {
812 if ( BmRARE(littlestr) == '\n'
813 && BmPREVIOUS(littlestr) == SvCUR(littlestr) - 1) {
814 little = (const unsigned char *)(SvPVX_const(littlestr));
815 littleend = little + SvCUR(littlestr);
822 little = (const unsigned char *)(SvPVX_const(littlestr));
823 littleend = little + SvCUR(littlestr);
825 /* The value of pos we can start at: */
826 previous = BmPREVIOUS(littlestr);
827 big = (const unsigned char *)(SvPVX_const(bigstr));
828 /* The value of pos we can stop at: */
829 stop_pos = SvCUR(bigstr) - end_shift - (SvCUR(littlestr) - 1 - previous);
830 if (previous + start_shift > stop_pos) {
832 stop_pos does not include SvTAIL in the count, so this check is incorrect
833 (I think) - see [ID 20010618.006] and t/op/study.t. HVDS 2001/06/19
836 if (previous + start_shift == stop_pos + 1) /* A fake '\n'? */
841 while (pos < previous + start_shift) {
842 if (!(pos += PL_screamnext[pos]))
847 register const unsigned char *s, *x;
848 if (pos >= stop_pos) break;
849 if (big[pos] != first)
851 for (x=big+pos+1,s=little; s < littleend; /**/ ) {
857 if (s == littleend) {
859 if (!last) return (char *)(big+pos);
862 } while ( pos += PL_screamnext[pos] );
864 return (char *)(big+(*old_posp));
866 if (!SvTAIL(littlestr) || (end_shift > 0))
868 /* Ignore the trailing "\n". This code is not microoptimized */
869 big = (const unsigned char *)(SvPVX_const(bigstr) + SvCUR(bigstr));
870 stop_pos = littleend - little; /* Actual littlestr len */
875 && ((stop_pos == 1) ||
876 memEQ((char *)(big + 1), (char *)little, stop_pos - 1)))
882 Perl_ibcmp(const char *s1, const char *s2, register I32 len)
884 register const U8 *a = (const U8 *)s1;
885 register const U8 *b = (const U8 *)s2;
887 PERL_ARGS_ASSERT_IBCMP;
890 if (*a != *b && *a != PL_fold[*b])
898 Perl_ibcmp_locale(const char *s1, const char *s2, register I32 len)
901 register const U8 *a = (const U8 *)s1;
902 register const U8 *b = (const U8 *)s2;
904 PERL_ARGS_ASSERT_IBCMP_LOCALE;
907 if (*a != *b && *a != PL_fold_locale[*b])
914 /* copy a string to a safe spot */
917 =head1 Memory Management
921 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
922 string which is a duplicate of C<pv>. The size of the string is
923 determined by C<strlen()>. The memory allocated for the new string can
924 be freed with the C<Safefree()> function.
930 Perl_savepv(pTHX_ const char *pv)
937 const STRLEN pvlen = strlen(pv)+1;
938 Newx(newaddr, pvlen, char);
939 return (char*)memcpy(newaddr, pv, pvlen);
943 /* same thing but with a known length */
948 Perl's version of what C<strndup()> would be if it existed. Returns a
949 pointer to a newly allocated string which is a duplicate of the first
950 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
951 the new string can be freed with the C<Safefree()> function.
957 Perl_savepvn(pTHX_ const char *pv, register I32 len)
959 register char *newaddr;
962 Newx(newaddr,len+1,char);
963 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
965 /* might not be null terminated */
967 return (char *) CopyD(pv,newaddr,len,char);
970 return (char *) ZeroD(newaddr,len+1,char);
975 =for apidoc savesharedpv
977 A version of C<savepv()> which allocates the duplicate string in memory
978 which is shared between threads.
983 Perl_savesharedpv(pTHX_ const char *pv)
985 register char *newaddr;
990 pvlen = strlen(pv)+1;
991 newaddr = (char*)PerlMemShared_malloc(pvlen);
993 return write_no_mem();
995 return (char*)memcpy(newaddr, pv, pvlen);
999 =for apidoc savesharedpvn
1001 A version of C<savepvn()> which allocates the duplicate string in memory
1002 which is shared between threads. (With the specific difference that a NULL
1003 pointer is not acceptable)
1008 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1010 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1012 PERL_ARGS_ASSERT_SAVESHAREDPVN;
1015 return write_no_mem();
1017 newaddr[len] = '\0';
1018 return (char*)memcpy(newaddr, pv, len);
1022 =for apidoc savesvpv
1024 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1025 the passed in SV using C<SvPV()>
1031 Perl_savesvpv(pTHX_ SV *sv)
1034 const char * const pv = SvPV_const(sv, len);
1035 register char *newaddr;
1037 PERL_ARGS_ASSERT_SAVESVPV;
1040 Newx(newaddr,len,char);
1041 return (char *) CopyD(pv,newaddr,len,char);
1045 /* the SV for Perl_form() and mess() is not kept in an arena */
1055 return newSVpvs_flags("", SVs_TEMP);
1060 /* Create as PVMG now, to avoid any upgrading later */
1062 Newxz(any, 1, XPVMG);
1063 SvFLAGS(sv) = SVt_PVMG;
1064 SvANY(sv) = (void*)any;
1066 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1071 #if defined(PERL_IMPLICIT_CONTEXT)
1073 Perl_form_nocontext(const char* pat, ...)
1078 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1079 va_start(args, pat);
1080 retval = vform(pat, &args);
1084 #endif /* PERL_IMPLICIT_CONTEXT */
1087 =head1 Miscellaneous Functions
1090 Takes a sprintf-style format pattern and conventional
1091 (non-SV) arguments and returns the formatted string.
1093 (char *) Perl_form(pTHX_ const char* pat, ...)
1095 can be used any place a string (char *) is required:
1097 char * s = Perl_form("%d.%d",major,minor);
1099 Uses a single private buffer so if you want to format several strings you
1100 must explicitly copy the earlier strings away (and free the copies when you
1107 Perl_form(pTHX_ const char* pat, ...)
1111 PERL_ARGS_ASSERT_FORM;
1112 va_start(args, pat);
1113 retval = vform(pat, &args);
1119 Perl_vform(pTHX_ const char *pat, va_list *args)
1121 SV * const sv = mess_alloc();
1122 PERL_ARGS_ASSERT_VFORM;
1123 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1128 =for apidoc Am|SV *|mess|const char *pat|...
1130 Take a sprintf-style format pattern and argument list. These are used to
1131 generate a string message. If the message does not end with a newline,
1132 then it will be extended with some indication of the current location
1133 in the code, as described for L</mess_sv>.
1135 Normally, the resulting message is returned in a new mortal SV.
1136 During global destruction a single SV may be shared between uses of
1142 #if defined(PERL_IMPLICIT_CONTEXT)
1144 Perl_mess_nocontext(const char *pat, ...)
1149 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1150 va_start(args, pat);
1151 retval = vmess(pat, &args);
1155 #endif /* PERL_IMPLICIT_CONTEXT */
1158 Perl_mess(pTHX_ const char *pat, ...)
1162 PERL_ARGS_ASSERT_MESS;
1163 va_start(args, pat);
1164 retval = vmess(pat, &args);
1170 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1173 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1175 PERL_ARGS_ASSERT_CLOSEST_COP;
1177 if (!o || o == PL_op)
1180 if (o->op_flags & OPf_KIDS) {
1182 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1185 /* If the OP_NEXTSTATE has been optimised away we can still use it
1186 * the get the file and line number. */
1188 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1189 cop = (const COP *)kid;
1191 /* Keep searching, and return when we've found something. */
1193 new_cop = closest_cop(cop, kid);
1199 /* Nothing found. */
1205 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1207 Expands a message, intended for the user, to include an indication of
1208 the current location in the code, if the message does not already appear
1211 C<basemsg> is the initial message or object. If it is a reference, it
1212 will be used as-is and will be the result of this function. Otherwise it
1213 is used as a string, and if it already ends with a newline, it is taken
1214 to be complete, and the result of this function will be the same string.
1215 If the message does not end with a newline, then a segment such as C<at
1216 foo.pl line 37> will be appended, and possibly other clauses indicating
1217 the current state of execution. The resulting message will end with a
1220 Normally, the resulting message is returned in a new mortal SV.
1221 During global destruction a single SV may be shared between uses of this
1222 function. If C<consume> is true, then the function is permitted (but not
1223 required) to modify and return C<basemsg> instead of allocating a new SV.
1229 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1234 PERL_ARGS_ASSERT_MESS_SV;
1236 if (SvROK(basemsg)) {
1242 sv_setsv(sv, basemsg);
1247 if (SvPOK(basemsg) && consume) {
1252 sv_copypv(sv, basemsg);
1255 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1257 * Try and find the file and line for PL_op. This will usually be
1258 * PL_curcop, but it might be a cop that has been optimised away. We
1259 * can try to find such a cop by searching through the optree starting
1260 * from the sibling of PL_curcop.
1263 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1268 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1269 OutCopFILE(cop), (IV)CopLINE(cop));
1270 /* Seems that GvIO() can be untrustworthy during global destruction. */
1271 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1272 && IoLINES(GvIOp(PL_last_in_gv)))
1274 const bool line_mode = (RsSIMPLE(PL_rs) &&
1275 SvCUR(PL_rs) == 1 && *SvPVX_const(PL_rs) == '\n');
1276 Perl_sv_catpvf(aTHX_ sv, ", <%s> %s %"IVdf,
1277 PL_last_in_gv == PL_argvgv ? "" : GvNAME(PL_last_in_gv),
1278 line_mode ? "line" : "chunk",
1279 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1282 sv_catpvs(sv, " during global destruction");
1283 sv_catpvs(sv, ".\n");
1289 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1291 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1292 argument list. These are used to generate a string message. If the
1293 message does not end with a newline, then it will be extended with
1294 some indication of the current location in the code, as described for
1297 Normally, the resulting message is returned in a new mortal SV.
1298 During global destruction a single SV may be shared between uses of
1305 Perl_vmess(pTHX_ const char *pat, va_list *args)
1308 SV * const sv = mess_alloc();
1310 PERL_ARGS_ASSERT_VMESS;
1312 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1313 return mess_sv(sv, 1);
1317 Perl_write_to_stderr(pTHX_ SV* msv)
1323 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1325 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1326 && (io = GvIO(PL_stderrgv))
1327 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1334 SAVESPTR(PL_stderrgv);
1337 PUSHSTACKi(PERLSI_MAGIC);
1341 PUSHs(SvTIED_obj(MUTABLE_SV(io), mg));
1344 call_method("PRINT", G_SCALAR);
1352 /* SFIO can really mess with your errno */
1355 PerlIO * const serr = Perl_error_log;
1357 const char* message = SvPVx_const(msv, msglen);
1359 PERL_WRITE_MSG_TO_CONSOLE(serr, message, msglen);
1360 (void)PerlIO_flush(serr);
1368 =head1 Warning and Dieing
1371 /* Common code used in dieing and warning */
1374 S_with_queued_errors(pTHX_ SV *ex)
1376 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1377 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1378 sv_catsv(PL_errors, ex);
1379 ex = sv_mortalcopy(PL_errors);
1380 SvCUR_set(PL_errors, 0);
1386 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1392 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1393 /* sv_2cv might call Perl_croak() or Perl_warner() */
1394 SV * const oldhook = *hook;
1402 cv = sv_2cv(oldhook, &stash, &gv, 0);
1404 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1414 exarg = newSVsv(ex);
1415 SvREADONLY_on(exarg);
1418 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1422 call_sv(MUTABLE_SV(cv), G_DISCARD);
1431 =for apidoc Am|OP *|die_sv|SV *baseex
1433 Behaves the same as L</croak_sv>, except for the return type.
1434 It should be used only where the C<OP *> return type is required.
1435 The function never actually returns.
1441 Perl_die_sv(pTHX_ SV *baseex)
1443 PERL_ARGS_ASSERT_DIE_SV;
1450 =for apidoc Am|OP *|die|const char *pat|...
1452 Behaves the same as L</croak>, except for the return type.
1453 It should be used only where the C<OP *> return type is required.
1454 The function never actually returns.
1459 #if defined(PERL_IMPLICIT_CONTEXT)
1461 Perl_die_nocontext(const char* pat, ...)
1465 va_start(args, pat);
1471 #endif /* PERL_IMPLICIT_CONTEXT */
1474 Perl_die(pTHX_ const char* pat, ...)
1477 va_start(args, pat);
1485 =for apidoc Am|void|croak_sv|SV *baseex
1487 This is an XS interface to Perl's C<die> function.
1489 C<baseex> is the error message or object. If it is a reference, it
1490 will be used as-is. Otherwise it is used as a string, and if it does
1491 not end with a newline then it will be extended with some indication of
1492 the current location in the code, as described for L</mess_sv>.
1494 The error message or object will be used as an exception, by default
1495 returning control to the nearest enclosing C<eval>, but subject to
1496 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1497 function never returns normally.
1499 To die with a simple string message, the L</croak> function may be
1506 Perl_croak_sv(pTHX_ SV *baseex)
1508 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1509 PERL_ARGS_ASSERT_CROAK_SV;
1510 invoke_exception_hook(ex, FALSE);
1515 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1517 This is an XS interface to Perl's C<die> function.
1519 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1520 argument list. These are used to generate a string message. If the
1521 message does not end with a newline, then it will be extended with
1522 some indication of the current location in the code, as described for
1525 The error message will be used as an exception, by default
1526 returning control to the nearest enclosing C<eval>, but subject to
1527 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1528 function never returns normally.
1530 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1531 (C<$@>) will be used as an error message or object instead of building an
1532 error message from arguments. If you want to throw a non-string object,
1533 or build an error message in an SV yourself, it is preferable to use
1534 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1540 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1542 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1543 invoke_exception_hook(ex, FALSE);
1548 =for apidoc Am|void|croak|const char *pat|...
1550 This is an XS interface to Perl's C<die> function.
1552 Take a sprintf-style format pattern and argument list. These are used to
1553 generate a string message. If the message does not end with a newline,
1554 then it will be extended with some indication of the current location
1555 in the code, as described for L</mess_sv>.
1557 The error message will be used as an exception, by default
1558 returning control to the nearest enclosing C<eval>, but subject to
1559 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1560 function never returns normally.
1562 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1563 (C<$@>) will be used as an error message or object instead of building an
1564 error message from arguments. If you want to throw a non-string object,
1565 or build an error message in an SV yourself, it is preferable to use
1566 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1571 #if defined(PERL_IMPLICIT_CONTEXT)
1573 Perl_croak_nocontext(const char *pat, ...)
1577 va_start(args, pat);
1582 #endif /* PERL_IMPLICIT_CONTEXT */
1585 Perl_croak(pTHX_ const char *pat, ...)
1588 va_start(args, pat);
1595 =for apidoc Am|void|warn_sv|SV *baseex
1597 This is an XS interface to Perl's C<warn> function.
1599 C<baseex> is the error message or object. If it is a reference, it
1600 will be used as-is. Otherwise it is used as a string, and if it does
1601 not end with a newline then it will be extended with some indication of
1602 the current location in the code, as described for L</mess_sv>.
1604 The error message or object will by default be written to standard error,
1605 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1607 To warn with a simple string message, the L</warn> function may be
1614 Perl_warn_sv(pTHX_ SV *baseex)
1616 SV *ex = mess_sv(baseex, 0);
1617 PERL_ARGS_ASSERT_WARN_SV;
1618 if (!invoke_exception_hook(ex, TRUE))
1619 write_to_stderr(ex);
1623 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1625 This is an XS interface to Perl's C<warn> function.
1627 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1628 argument list. These are used to generate a string message. If the
1629 message does not end with a newline, then it will be extended with
1630 some indication of the current location in the code, as described for
1633 The error message or object will by default be written to standard error,
1634 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1636 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1642 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1644 SV *ex = vmess(pat, args);
1645 PERL_ARGS_ASSERT_VWARN;
1646 if (!invoke_exception_hook(ex, TRUE))
1647 write_to_stderr(ex);
1651 =for apidoc Am|void|warn|const char *pat|...
1653 This is an XS interface to Perl's C<warn> function.
1655 Take a sprintf-style format pattern and argument list. These are used to
1656 generate a string message. If the message does not end with a newline,
1657 then it will be extended with some indication of the current location
1658 in the code, as described for L</mess_sv>.
1660 The error message or object will by default be written to standard error,
1661 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1663 Unlike with L</croak>, C<pat> is not permitted to be null.
1668 #if defined(PERL_IMPLICIT_CONTEXT)
1670 Perl_warn_nocontext(const char *pat, ...)
1674 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1675 va_start(args, pat);
1679 #endif /* PERL_IMPLICIT_CONTEXT */
1682 Perl_warn(pTHX_ const char *pat, ...)
1685 PERL_ARGS_ASSERT_WARN;
1686 va_start(args, pat);
1691 #if defined(PERL_IMPLICIT_CONTEXT)
1693 Perl_warner_nocontext(U32 err, const char *pat, ...)
1697 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1698 va_start(args, pat);
1699 vwarner(err, pat, &args);
1702 #endif /* PERL_IMPLICIT_CONTEXT */
1705 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1707 PERL_ARGS_ASSERT_CK_WARNER_D;
1709 if (Perl_ckwarn_d(aTHX_ err)) {
1711 va_start(args, pat);
1712 vwarner(err, pat, &args);
1718 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1720 PERL_ARGS_ASSERT_CK_WARNER;
1722 if (Perl_ckwarn(aTHX_ err)) {
1724 va_start(args, pat);
1725 vwarner(err, pat, &args);
1731 Perl_warner(pTHX_ U32 err, const char* pat,...)
1734 PERL_ARGS_ASSERT_WARNER;
1735 va_start(args, pat);
1736 vwarner(err, pat, &args);
1741 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1744 PERL_ARGS_ASSERT_VWARNER;
1745 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1746 SV * const msv = vmess(pat, args);
1748 invoke_exception_hook(msv, FALSE);
1752 Perl_vwarn(aTHX_ pat, args);
1756 /* implements the ckWARN? macros */
1759 Perl_ckwarn(pTHX_ U32 w)
1762 /* If lexical warnings have not been set, use $^W. */
1764 return PL_dowarn & G_WARN_ON;
1766 return ckwarn_common(w);
1769 /* implements the ckWARN?_d macro */
1772 Perl_ckwarn_d(pTHX_ U32 w)
1775 /* If lexical warnings have not been set then default classes warn. */
1779 return ckwarn_common(w);
1783 S_ckwarn_common(pTHX_ U32 w)
1785 if (PL_curcop->cop_warnings == pWARN_ALL)
1788 if (PL_curcop->cop_warnings == pWARN_NONE)
1791 /* Check the assumption that at least the first slot is non-zero. */
1792 assert(unpackWARN1(w));
1794 /* Check the assumption that it is valid to stop as soon as a zero slot is
1796 if (!unpackWARN2(w)) {
1797 assert(!unpackWARN3(w));
1798 assert(!unpackWARN4(w));
1799 } else if (!unpackWARN3(w)) {
1800 assert(!unpackWARN4(w));
1803 /* Right, dealt with all the special cases, which are implemented as non-
1804 pointers, so there is a pointer to a real warnings mask. */
1806 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1808 } while (w >>= WARNshift);
1813 /* Set buffer=NULL to get a new one. */
1815 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1817 const MEM_SIZE len_wanted = sizeof(STRLEN) + size;
1818 PERL_UNUSED_CONTEXT;
1819 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1822 (specialWARN(buffer) ?
1823 PerlMemShared_malloc(len_wanted) :
1824 PerlMemShared_realloc(buffer, len_wanted));
1826 Copy(bits, (buffer + 1), size, char);
1830 /* since we've already done strlen() for both nam and val
1831 * we can use that info to make things faster than
1832 * sprintf(s, "%s=%s", nam, val)
1834 #define my_setenv_format(s, nam, nlen, val, vlen) \
1835 Copy(nam, s, nlen, char); \
1837 Copy(val, s+(nlen+1), vlen, char); \
1838 *(s+(nlen+1+vlen)) = '\0'
1840 #ifdef USE_ENVIRON_ARRAY
1841 /* VMS' my_setenv() is in vms.c */
1842 #if !defined(WIN32) && !defined(NETWARE)
1844 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1848 /* only parent thread can modify process environment */
1849 if (PL_curinterp == aTHX)
1852 #ifndef PERL_USE_SAFE_PUTENV
1853 if (!PL_use_safe_putenv) {
1854 /* most putenv()s leak, so we manipulate environ directly */
1856 register const I32 len = strlen(nam);
1859 /* where does it go? */
1860 for (i = 0; environ[i]; i++) {
1861 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1865 if (environ == PL_origenviron) { /* need we copy environment? */
1871 while (environ[max])
1873 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1874 for (j=0; j<max; j++) { /* copy environment */
1875 const int len = strlen(environ[j]);
1876 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1877 Copy(environ[j], tmpenv[j], len+1, char);
1880 environ = tmpenv; /* tell exec where it is now */
1883 safesysfree(environ[i]);
1884 while (environ[i]) {
1885 environ[i] = environ[i+1];
1890 if (!environ[i]) { /* does not exist yet */
1891 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1892 environ[i+1] = NULL; /* make sure it's null terminated */
1895 safesysfree(environ[i]);
1899 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1900 /* all that work just for this */
1901 my_setenv_format(environ[i], nam, nlen, val, vlen);
1904 # if defined(__CYGWIN__) || defined(EPOC) || defined(__SYMBIAN32__) || defined(__riscos__)
1905 # if defined(HAS_UNSETENV)
1907 (void)unsetenv(nam);
1909 (void)setenv(nam, val, 1);
1911 # else /* ! HAS_UNSETENV */
1912 (void)setenv(nam, val, 1);
1913 # endif /* HAS_UNSETENV */
1915 # if defined(HAS_UNSETENV)
1917 (void)unsetenv(nam);
1919 const int nlen = strlen(nam);
1920 const int vlen = strlen(val);
1921 char * const new_env =
1922 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1923 my_setenv_format(new_env, nam, nlen, val, vlen);
1924 (void)putenv(new_env);
1926 # else /* ! HAS_UNSETENV */
1928 const int nlen = strlen(nam);
1934 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1935 /* all that work just for this */
1936 my_setenv_format(new_env, nam, nlen, val, vlen);
1937 (void)putenv(new_env);
1938 # endif /* HAS_UNSETENV */
1939 # endif /* __CYGWIN__ */
1940 #ifndef PERL_USE_SAFE_PUTENV
1946 #else /* WIN32 || NETWARE */
1949 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1952 register char *envstr;
1953 const int nlen = strlen(nam);
1960 Newx(envstr, nlen+vlen+2, char);
1961 my_setenv_format(envstr, nam, nlen, val, vlen);
1962 (void)PerlEnv_putenv(envstr);
1966 #endif /* WIN32 || NETWARE */
1968 #endif /* !VMS && !EPOC*/
1970 #ifdef UNLINK_ALL_VERSIONS
1972 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
1976 PERL_ARGS_ASSERT_UNLNK;
1978 while (PerlLIO_unlink(f) >= 0)
1980 return retries ? 0 : -1;
1984 /* this is a drop-in replacement for bcopy() */
1985 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
1987 Perl_my_bcopy(register const char *from,register char *to,register I32 len)
1989 char * const retval = to;
1991 PERL_ARGS_ASSERT_MY_BCOPY;
1993 if (from - to >= 0) {
2001 *(--to) = *(--from);
2007 /* this is a drop-in replacement for memset() */
2010 Perl_my_memset(register char *loc, register I32 ch, register I32 len)
2012 char * const retval = loc;
2014 PERL_ARGS_ASSERT_MY_MEMSET;
2022 /* this is a drop-in replacement for bzero() */
2023 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2025 Perl_my_bzero(register char *loc, register I32 len)
2027 char * const retval = loc;
2029 PERL_ARGS_ASSERT_MY_BZERO;
2037 /* this is a drop-in replacement for memcmp() */
2038 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2040 Perl_my_memcmp(const char *s1, const char *s2, register I32 len)
2042 register const U8 *a = (const U8 *)s1;
2043 register const U8 *b = (const U8 *)s2;
2046 PERL_ARGS_ASSERT_MY_MEMCMP;
2049 if ((tmp = *a++ - *b++))
2054 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2057 /* This vsprintf replacement should generally never get used, since
2058 vsprintf was available in both System V and BSD 2.11. (There may
2059 be some cross-compilation or embedded set-ups where it is needed,
2062 If you encounter a problem in this function, it's probably a symptom
2063 that Configure failed to detect your system's vprintf() function.
2064 See the section on "item vsprintf" in the INSTALL file.
2066 This version may compile on systems with BSD-ish <stdio.h>,
2067 but probably won't on others.
2070 #ifdef USE_CHAR_VSPRINTF
2075 vsprintf(char *dest, const char *pat, void *args)
2079 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2080 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2081 FILE_cnt(&fakebuf) = 32767;
2083 /* These probably won't compile -- If you really need
2084 this, you'll have to figure out some other method. */
2085 fakebuf._ptr = dest;
2086 fakebuf._cnt = 32767;
2091 fakebuf._flag = _IOWRT|_IOSTRG;
2092 _doprnt(pat, args, &fakebuf); /* what a kludge */
2093 #if defined(STDIO_PTR_LVALUE)
2094 *(FILE_ptr(&fakebuf)++) = '\0';
2096 /* PerlIO has probably #defined away fputc, but we want it here. */
2098 # undef fputc /* XXX Should really restore it later */
2100 (void)fputc('\0', &fakebuf);
2102 #ifdef USE_CHAR_VSPRINTF
2105 return 0; /* perl doesn't use return value */
2109 #endif /* HAS_VPRINTF */
2112 #if BYTEORDER != 0x4321
2114 Perl_my_swap(pTHX_ short s)
2116 #if (BYTEORDER & 1) == 0
2119 result = ((s & 255) << 8) + ((s >> 8) & 255);
2127 Perl_my_htonl(pTHX_ long l)
2131 char c[sizeof(long)];
2134 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
2135 #if BYTEORDER == 0x12345678
2138 u.c[0] = (l >> 24) & 255;
2139 u.c[1] = (l >> 16) & 255;
2140 u.c[2] = (l >> 8) & 255;
2144 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2145 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2150 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2151 u.c[o & 0xf] = (l >> s) & 255;
2159 Perl_my_ntohl(pTHX_ long l)
2163 char c[sizeof(long)];
2166 #if BYTEORDER == 0x1234
2167 u.c[0] = (l >> 24) & 255;
2168 u.c[1] = (l >> 16) & 255;
2169 u.c[2] = (l >> 8) & 255;
2173 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2174 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2181 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2182 l |= (u.c[o & 0xf] & 255) << s;
2189 #endif /* BYTEORDER != 0x4321 */
2193 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2194 * If these functions are defined,
2195 * the BYTEORDER is neither 0x1234 nor 0x4321.
2196 * However, this is not assumed.
2200 #define HTOLE(name,type) \
2202 name (register type n) \
2206 char c[sizeof(type)]; \
2209 register U32 s = 0; \
2210 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2211 u.c[i] = (n >> s) & 0xFF; \
2216 #define LETOH(name,type) \
2218 name (register type n) \
2222 char c[sizeof(type)]; \
2225 register U32 s = 0; \
2228 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2229 n |= ((type)(u.c[i] & 0xFF)) << s; \
2235 * Big-endian byte order functions.
2238 #define HTOBE(name,type) \
2240 name (register type n) \
2244 char c[sizeof(type)]; \
2247 register U32 s = 8*(sizeof(u.c)-1); \
2248 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2249 u.c[i] = (n >> s) & 0xFF; \
2254 #define BETOH(name,type) \
2256 name (register type n) \
2260 char c[sizeof(type)]; \
2263 register U32 s = 8*(sizeof(u.c)-1); \
2266 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2267 n |= ((type)(u.c[i] & 0xFF)) << s; \
2273 * If we just can't do it...
2276 #define NOT_AVAIL(name,type) \
2278 name (register type n) \
2280 Perl_croak_nocontext(#name "() not available"); \
2281 return n; /* not reached */ \
2285 #if defined(HAS_HTOVS) && !defined(htovs)
2288 #if defined(HAS_HTOVL) && !defined(htovl)
2291 #if defined(HAS_VTOHS) && !defined(vtohs)
2294 #if defined(HAS_VTOHL) && !defined(vtohl)
2298 #ifdef PERL_NEED_MY_HTOLE16
2300 HTOLE(Perl_my_htole16,U16)
2302 NOT_AVAIL(Perl_my_htole16,U16)
2305 #ifdef PERL_NEED_MY_LETOH16
2307 LETOH(Perl_my_letoh16,U16)
2309 NOT_AVAIL(Perl_my_letoh16,U16)
2312 #ifdef PERL_NEED_MY_HTOBE16
2314 HTOBE(Perl_my_htobe16,U16)
2316 NOT_AVAIL(Perl_my_htobe16,U16)
2319 #ifdef PERL_NEED_MY_BETOH16
2321 BETOH(Perl_my_betoh16,U16)
2323 NOT_AVAIL(Perl_my_betoh16,U16)
2327 #ifdef PERL_NEED_MY_HTOLE32
2329 HTOLE(Perl_my_htole32,U32)
2331 NOT_AVAIL(Perl_my_htole32,U32)
2334 #ifdef PERL_NEED_MY_LETOH32
2336 LETOH(Perl_my_letoh32,U32)
2338 NOT_AVAIL(Perl_my_letoh32,U32)
2341 #ifdef PERL_NEED_MY_HTOBE32
2343 HTOBE(Perl_my_htobe32,U32)
2345 NOT_AVAIL(Perl_my_htobe32,U32)
2348 #ifdef PERL_NEED_MY_BETOH32
2350 BETOH(Perl_my_betoh32,U32)
2352 NOT_AVAIL(Perl_my_betoh32,U32)
2356 #ifdef PERL_NEED_MY_HTOLE64
2358 HTOLE(Perl_my_htole64,U64)
2360 NOT_AVAIL(Perl_my_htole64,U64)
2363 #ifdef PERL_NEED_MY_LETOH64
2365 LETOH(Perl_my_letoh64,U64)
2367 NOT_AVAIL(Perl_my_letoh64,U64)
2370 #ifdef PERL_NEED_MY_HTOBE64
2372 HTOBE(Perl_my_htobe64,U64)
2374 NOT_AVAIL(Perl_my_htobe64,U64)
2377 #ifdef PERL_NEED_MY_BETOH64
2379 BETOH(Perl_my_betoh64,U64)
2381 NOT_AVAIL(Perl_my_betoh64,U64)
2385 #ifdef PERL_NEED_MY_HTOLES
2386 HTOLE(Perl_my_htoles,short)
2388 #ifdef PERL_NEED_MY_LETOHS
2389 LETOH(Perl_my_letohs,short)
2391 #ifdef PERL_NEED_MY_HTOBES
2392 HTOBE(Perl_my_htobes,short)
2394 #ifdef PERL_NEED_MY_BETOHS
2395 BETOH(Perl_my_betohs,short)
2398 #ifdef PERL_NEED_MY_HTOLEI
2399 HTOLE(Perl_my_htolei,int)
2401 #ifdef PERL_NEED_MY_LETOHI
2402 LETOH(Perl_my_letohi,int)
2404 #ifdef PERL_NEED_MY_HTOBEI
2405 HTOBE(Perl_my_htobei,int)
2407 #ifdef PERL_NEED_MY_BETOHI
2408 BETOH(Perl_my_betohi,int)
2411 #ifdef PERL_NEED_MY_HTOLEL
2412 HTOLE(Perl_my_htolel,long)
2414 #ifdef PERL_NEED_MY_LETOHL
2415 LETOH(Perl_my_letohl,long)
2417 #ifdef PERL_NEED_MY_HTOBEL
2418 HTOBE(Perl_my_htobel,long)
2420 #ifdef PERL_NEED_MY_BETOHL
2421 BETOH(Perl_my_betohl,long)
2425 Perl_my_swabn(void *ptr, int n)
2427 register char *s = (char *)ptr;
2428 register char *e = s + (n-1);
2431 PERL_ARGS_ASSERT_MY_SWABN;
2433 for (n /= 2; n > 0; s++, e--, n--) {
2441 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2443 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2446 register I32 This, that;
2452 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2454 PERL_FLUSHALL_FOR_CHILD;
2455 This = (*mode == 'w');
2459 taint_proper("Insecure %s%s", "EXEC");
2461 if (PerlProc_pipe(p) < 0)
2463 /* Try for another pipe pair for error return */
2464 if (PerlProc_pipe(pp) >= 0)
2466 while ((pid = PerlProc_fork()) < 0) {
2467 if (errno != EAGAIN) {
2468 PerlLIO_close(p[This]);
2469 PerlLIO_close(p[that]);
2471 PerlLIO_close(pp[0]);
2472 PerlLIO_close(pp[1]);
2476 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2485 /* Close parent's end of error status pipe (if any) */
2487 PerlLIO_close(pp[0]);
2488 #if defined(HAS_FCNTL) && defined(F_SETFD)
2489 /* Close error pipe automatically if exec works */
2490 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2493 /* Now dup our end of _the_ pipe to right position */
2494 if (p[THIS] != (*mode == 'r')) {
2495 PerlLIO_dup2(p[THIS], *mode == 'r');
2496 PerlLIO_close(p[THIS]);
2497 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2498 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2501 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2502 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2503 /* No automatic close - do it by hand */
2510 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2516 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2522 do_execfree(); /* free any memory malloced by child on fork */
2524 PerlLIO_close(pp[1]);
2525 /* Keep the lower of the two fd numbers */
2526 if (p[that] < p[This]) {
2527 PerlLIO_dup2(p[This], p[that]);
2528 PerlLIO_close(p[This]);
2532 PerlLIO_close(p[that]); /* close child's end of pipe */
2534 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2535 SvUPGRADE(sv,SVt_IV);
2537 PL_forkprocess = pid;
2538 /* If we managed to get status pipe check for exec fail */
2539 if (did_pipes && pid > 0) {
2544 while (n < sizeof(int)) {
2545 n1 = PerlLIO_read(pp[0],
2546 (void*)(((char*)&errkid)+n),
2552 PerlLIO_close(pp[0]);
2554 if (n) { /* Error */
2556 PerlLIO_close(p[This]);
2557 if (n != sizeof(int))
2558 Perl_croak(aTHX_ "panic: kid popen errno read");
2560 pid2 = wait4pid(pid, &status, 0);
2561 } while (pid2 == -1 && errno == EINTR);
2562 errno = errkid; /* Propagate errno from kid */
2567 PerlLIO_close(pp[0]);
2568 return PerlIO_fdopen(p[This], mode);
2570 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2571 return my_syspopen4(aTHX_ NULL, mode, n, args);
2573 Perl_croak(aTHX_ "List form of piped open not implemented");
2574 return (PerlIO *) NULL;
2579 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2580 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
2582 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2586 register I32 This, that;
2589 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2593 PERL_ARGS_ASSERT_MY_POPEN;
2595 PERL_FLUSHALL_FOR_CHILD;
2598 return my_syspopen(aTHX_ cmd,mode);
2601 This = (*mode == 'w');
2603 if (doexec && PL_tainting) {
2605 taint_proper("Insecure %s%s", "EXEC");
2607 if (PerlProc_pipe(p) < 0)
2609 if (doexec && PerlProc_pipe(pp) >= 0)
2611 while ((pid = PerlProc_fork()) < 0) {
2612 if (errno != EAGAIN) {
2613 PerlLIO_close(p[This]);
2614 PerlLIO_close(p[that]);
2616 PerlLIO_close(pp[0]);
2617 PerlLIO_close(pp[1]);
2620 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2623 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2634 PerlLIO_close(pp[0]);
2635 #if defined(HAS_FCNTL) && defined(F_SETFD)
2636 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2639 if (p[THIS] != (*mode == 'r')) {
2640 PerlLIO_dup2(p[THIS], *mode == 'r');
2641 PerlLIO_close(p[THIS]);
2642 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2643 PerlLIO_close(p[THAT]);
2646 PerlLIO_close(p[THAT]);
2649 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2656 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2661 /* may or may not use the shell */
2662 do_exec3(cmd, pp[1], did_pipes);
2665 #endif /* defined OS2 */
2667 #ifdef PERLIO_USING_CRLF
2668 /* Since we circumvent IO layers when we manipulate low-level
2669 filedescriptors directly, need to manually switch to the
2670 default, binary, low-level mode; see PerlIOBuf_open(). */
2671 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2674 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
2675 SvREADONLY_off(GvSV(tmpgv));
2676 sv_setiv(GvSV(tmpgv), PerlProc_getpid());
2677 SvREADONLY_on(GvSV(tmpgv));
2679 #ifdef THREADS_HAVE_PIDS
2680 PL_ppid = (IV)getppid();
2683 #ifdef PERL_USES_PL_PIDSTATUS
2684 hv_clear(PL_pidstatus); /* we have no children */
2690 do_execfree(); /* free any memory malloced by child on vfork */
2692 PerlLIO_close(pp[1]);
2693 if (p[that] < p[This]) {
2694 PerlLIO_dup2(p[This], p[that]);
2695 PerlLIO_close(p[This]);
2699 PerlLIO_close(p[that]);
2701 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2702 SvUPGRADE(sv,SVt_IV);
2704 PL_forkprocess = pid;
2705 if (did_pipes && pid > 0) {
2710 while (n < sizeof(int)) {
2711 n1 = PerlLIO_read(pp[0],
2712 (void*)(((char*)&errkid)+n),
2718 PerlLIO_close(pp[0]);
2720 if (n) { /* Error */
2722 PerlLIO_close(p[This]);
2723 if (n != sizeof(int))
2724 Perl_croak(aTHX_ "panic: kid popen errno read");
2726 pid2 = wait4pid(pid, &status, 0);
2727 } while (pid2 == -1 && errno == EINTR);
2728 errno = errkid; /* Propagate errno from kid */
2733 PerlLIO_close(pp[0]);
2734 return PerlIO_fdopen(p[This], mode);
2737 #if defined(atarist) || defined(EPOC)
2740 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2742 PERL_ARGS_ASSERT_MY_POPEN;
2743 PERL_FLUSHALL_FOR_CHILD;
2744 /* Call system's popen() to get a FILE *, then import it.
2745 used 0 for 2nd parameter to PerlIO_importFILE;
2748 return PerlIO_importFILE(popen(cmd, mode), 0);
2752 FILE *djgpp_popen();
2754 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2756 PERL_FLUSHALL_FOR_CHILD;
2757 /* Call system's popen() to get a FILE *, then import it.
2758 used 0 for 2nd parameter to PerlIO_importFILE;
2761 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2764 #if defined(__LIBCATAMOUNT__)
2766 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2774 #endif /* !DOSISH */
2776 /* this is called in parent before the fork() */
2778 Perl_atfork_lock(void)
2781 #if defined(USE_ITHREADS)
2782 /* locks must be held in locking order (if any) */
2784 MUTEX_LOCK(&PL_malloc_mutex);
2790 /* this is called in both parent and child after the fork() */
2792 Perl_atfork_unlock(void)
2795 #if defined(USE_ITHREADS)
2796 /* locks must be released in same order as in atfork_lock() */
2798 MUTEX_UNLOCK(&PL_malloc_mutex);
2807 #if defined(HAS_FORK)
2809 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2814 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2815 * handlers elsewhere in the code */
2820 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2821 Perl_croak_nocontext("fork() not available");
2823 #endif /* HAS_FORK */
2828 Perl_dump_fds(pTHX_ const char *const s)
2833 PERL_ARGS_ASSERT_DUMP_FDS;
2835 PerlIO_printf(Perl_debug_log,"%s", s);
2836 for (fd = 0; fd < 32; fd++) {
2837 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2838 PerlIO_printf(Perl_debug_log," %d",fd);
2840 PerlIO_printf(Perl_debug_log,"\n");
2843 #endif /* DUMP_FDS */
2847 dup2(int oldfd, int newfd)
2849 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2852 PerlLIO_close(newfd);
2853 return fcntl(oldfd, F_DUPFD, newfd);
2855 #define DUP2_MAX_FDS 256
2856 int fdtmp[DUP2_MAX_FDS];
2862 PerlLIO_close(newfd);
2863 /* good enough for low fd's... */
2864 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2865 if (fdx >= DUP2_MAX_FDS) {
2873 PerlLIO_close(fdtmp[--fdx]);
2880 #ifdef HAS_SIGACTION
2883 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2886 struct sigaction act, oact;
2889 /* only "parent" interpreter can diddle signals */
2890 if (PL_curinterp != aTHX)
2891 return (Sighandler_t) SIG_ERR;
2894 act.sa_handler = (void(*)(int))handler;
2895 sigemptyset(&act.sa_mask);
2898 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2899 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2901 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2902 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2903 act.sa_flags |= SA_NOCLDWAIT;
2905 if (sigaction(signo, &act, &oact) == -1)
2906 return (Sighandler_t) SIG_ERR;
2908 return (Sighandler_t) oact.sa_handler;
2912 Perl_rsignal_state(pTHX_ int signo)
2914 struct sigaction oact;
2915 PERL_UNUSED_CONTEXT;
2917 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2918 return (Sighandler_t) SIG_ERR;
2920 return (Sighandler_t) oact.sa_handler;
2924 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2927 struct sigaction act;
2929 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2932 /* only "parent" interpreter can diddle signals */
2933 if (PL_curinterp != aTHX)
2937 act.sa_handler = (void(*)(int))handler;
2938 sigemptyset(&act.sa_mask);
2941 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2942 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2944 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2945 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2946 act.sa_flags |= SA_NOCLDWAIT;
2948 return sigaction(signo, &act, save);
2952 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2956 /* only "parent" interpreter can diddle signals */
2957 if (PL_curinterp != aTHX)
2961 return sigaction(signo, save, (struct sigaction *)NULL);
2964 #else /* !HAS_SIGACTION */
2967 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2969 #if defined(USE_ITHREADS) && !defined(WIN32)
2970 /* only "parent" interpreter can diddle signals */
2971 if (PL_curinterp != aTHX)
2972 return (Sighandler_t) SIG_ERR;
2975 return PerlProc_signal(signo, handler);
2986 Perl_rsignal_state(pTHX_ int signo)
2989 Sighandler_t oldsig;
2991 #if defined(USE_ITHREADS) && !defined(WIN32)
2992 /* only "parent" interpreter can diddle signals */
2993 if (PL_curinterp != aTHX)
2994 return (Sighandler_t) SIG_ERR;
2998 oldsig = PerlProc_signal(signo, sig_trap);
2999 PerlProc_signal(signo, oldsig);
3001 PerlProc_kill(PerlProc_getpid(), signo);
3006 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3008 #if defined(USE_ITHREADS) && !defined(WIN32)
3009 /* only "parent" interpreter can diddle signals */
3010 if (PL_curinterp != aTHX)
3013 *save = PerlProc_signal(signo, handler);
3014 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3018 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3020 #if defined(USE_ITHREADS) && !defined(WIN32)
3021 /* only "parent" interpreter can diddle signals */
3022 if (PL_curinterp != aTHX)
3025 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3028 #endif /* !HAS_SIGACTION */
3029 #endif /* !PERL_MICRO */
3031 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3032 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
3034 Perl_my_pclose(pTHX_ PerlIO *ptr)
3037 Sigsave_t hstat, istat, qstat;
3045 svp = av_fetch(PL_fdpid,PerlIO_fileno(ptr),TRUE);
3046 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3048 *svp = &PL_sv_undef;
3050 if (pid == -1) { /* Opened by popen. */
3051 return my_syspclose(ptr);
3054 close_failed = (PerlIO_close(ptr) == EOF);
3057 if(PerlProc_kill(pid, 0) < 0) { return(pid); } /* HOM 12/23/91 */
3060 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3061 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3062 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3065 pid2 = wait4pid(pid, &status, 0);
3066 } while (pid2 == -1 && errno == EINTR);
3068 rsignal_restore(SIGHUP, &hstat);
3069 rsignal_restore(SIGINT, &istat);
3070 rsignal_restore(SIGQUIT, &qstat);
3076 return(pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status));
3079 #if defined(__LIBCATAMOUNT__)
3081 Perl_my_pclose(pTHX_ PerlIO *ptr)
3086 #endif /* !DOSISH */
3088 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3090 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3094 PERL_ARGS_ASSERT_WAIT4PID;
3097 #ifdef PERL_USES_PL_PIDSTATUS
3100 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3101 pid, rather than a string form. */
3102 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3103 if (svp && *svp != &PL_sv_undef) {
3104 *statusp = SvIVX(*svp);
3105 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3113 hv_iterinit(PL_pidstatus);
3114 if ((entry = hv_iternext(PL_pidstatus))) {
3115 SV * const sv = hv_iterval(PL_pidstatus,entry);
3117 const char * const spid = hv_iterkey(entry,&len);
3119 assert (len == sizeof(Pid_t));
3120 memcpy((char *)&pid, spid, len);
3121 *statusp = SvIVX(sv);
3122 /* The hash iterator is currently on this entry, so simply
3123 calling hv_delete would trigger the lazy delete, which on
3124 aggregate does more work, beacuse next call to hv_iterinit()
3125 would spot the flag, and have to call the delete routine,
3126 while in the meantime any new entries can't re-use that
3128 hv_iterinit(PL_pidstatus);
3129 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3136 # ifdef HAS_WAITPID_RUNTIME
3137 if (!HAS_WAITPID_RUNTIME)
3140 result = PerlProc_waitpid(pid,statusp,flags);
3143 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3144 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3147 #ifdef PERL_USES_PL_PIDSTATUS
3148 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3153 Perl_croak(aTHX_ "Can't do waitpid with flags");
3155 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3156 pidgone(result,*statusp);
3162 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3165 if (result < 0 && errno == EINTR) {
3167 errno = EINTR; /* reset in case a signal handler changed $! */
3171 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3173 #ifdef PERL_USES_PL_PIDSTATUS
3175 S_pidgone(pTHX_ Pid_t pid, int status)
3179 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3180 SvUPGRADE(sv,SVt_IV);
3181 SvIV_set(sv, status);
3186 #if defined(atarist) || defined(OS2) || defined(EPOC)
3189 int /* Cannot prototype with I32
3191 my_syspclose(PerlIO *ptr)
3194 Perl_my_pclose(pTHX_ PerlIO *ptr)
3197 /* Needs work for PerlIO ! */
3198 FILE * const f = PerlIO_findFILE(ptr);
3199 const I32 result = pclose(f);
3200 PerlIO_releaseFILE(ptr,f);
3208 Perl_my_pclose(pTHX_ PerlIO *ptr)
3210 /* Needs work for PerlIO ! */
3211 FILE * const f = PerlIO_findFILE(ptr);
3212 I32 result = djgpp_pclose(f);
3213 result = (result << 8) & 0xff00;
3214 PerlIO_releaseFILE(ptr,f);
3219 #define PERL_REPEATCPY_LINEAR 4
3221 Perl_repeatcpy(register char *to, register const char *from, I32 len, register I32 count)
3223 PERL_ARGS_ASSERT_REPEATCPY;
3226 memset(to, *from, count);
3228 register char *p = to;
3229 I32 items, linear, half;
3231 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3232 for (items = 0; items < linear; ++items) {
3233 register const char *q = from;
3235 for (todo = len; todo > 0; todo--)
3240 while (items <= half) {
3241 I32 size = items * len;
3242 memcpy(p, to, size);
3248 memcpy(p, to, (count - items) * len);
3254 Perl_same_dirent(pTHX_ const char *a, const char *b)
3256 char *fa = strrchr(a,'/');
3257 char *fb = strrchr(b,'/');
3260 SV * const tmpsv = sv_newmortal();
3262 PERL_ARGS_ASSERT_SAME_DIRENT;
3275 sv_setpvs(tmpsv, ".");
3277 sv_setpvn(tmpsv, a, fa - a);
3278 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3281 sv_setpvs(tmpsv, ".");
3283 sv_setpvn(tmpsv, b, fb - b);
3284 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3286 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3287 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3289 #endif /* !HAS_RENAME */
3292 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3293 const char *const *const search_ext, I32 flags)
3296 const char *xfound = NULL;
3297 char *xfailed = NULL;
3298 char tmpbuf[MAXPATHLEN];
3303 #if defined(DOSISH) && !defined(OS2) && !defined(atarist)
3304 # define SEARCH_EXTS ".bat", ".cmd", NULL
3305 # define MAX_EXT_LEN 4
3308 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3309 # define MAX_EXT_LEN 4
3312 # define SEARCH_EXTS ".pl", ".com", NULL
3313 # define MAX_EXT_LEN 4
3315 /* additional extensions to try in each dir if scriptname not found */
3317 static const char *const exts[] = { SEARCH_EXTS };
3318 const char *const *const ext = search_ext ? search_ext : exts;
3319 int extidx = 0, i = 0;
3320 const char *curext = NULL;
3322 PERL_UNUSED_ARG(search_ext);
3323 # define MAX_EXT_LEN 0
3326 PERL_ARGS_ASSERT_FIND_SCRIPT;
3329 * If dosearch is true and if scriptname does not contain path
3330 * delimiters, search the PATH for scriptname.
3332 * If SEARCH_EXTS is also defined, will look for each
3333 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3334 * while searching the PATH.
3336 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3337 * proceeds as follows:
3338 * If DOSISH or VMSISH:
3339 * + look for ./scriptname{,.foo,.bar}
3340 * + search the PATH for scriptname{,.foo,.bar}
3343 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3344 * this will not look in '.' if it's not in the PATH)
3349 # ifdef ALWAYS_DEFTYPES
3350 len = strlen(scriptname);
3351 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3352 int idx = 0, deftypes = 1;
3355 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3358 int idx = 0, deftypes = 1;
3361 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3363 /* The first time through, just add SEARCH_EXTS to whatever we
3364 * already have, so we can check for default file types. */
3366 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3372 if ((strlen(tmpbuf) + strlen(scriptname)
3373 + MAX_EXT_LEN) >= sizeof tmpbuf)
3374 continue; /* don't search dir with too-long name */
3375 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3379 if (strEQ(scriptname, "-"))
3381 if (dosearch) { /* Look in '.' first. */
3382 const char *cur = scriptname;
3384 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3386 if (strEQ(ext[i++],curext)) {
3387 extidx = -1; /* already has an ext */
3392 DEBUG_p(PerlIO_printf(Perl_debug_log,
3393 "Looking for %s\n",cur));
3394 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3395 && !S_ISDIR(PL_statbuf.st_mode)) {
3403 if (cur == scriptname) {
3404 len = strlen(scriptname);
3405 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3407 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3410 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3411 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3416 if (dosearch && !strchr(scriptname, '/')
3418 && !strchr(scriptname, '\\')
3420 && (s = PerlEnv_getenv("PATH")))
3424 bufend = s + strlen(s);
3425 while (s < bufend) {
3426 #if defined(atarist) || defined(DOSISH)
3431 && *s != ';'; len++, s++) {
3432 if (len < sizeof tmpbuf)
3435 if (len < sizeof tmpbuf)
3437 #else /* ! (atarist || DOSISH) */
3438 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3441 #endif /* ! (atarist || DOSISH) */
3444 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3445 continue; /* don't search dir with too-long name */
3447 # if defined(atarist) || defined(DOSISH)
3448 && tmpbuf[len - 1] != '/'
3449 && tmpbuf[len - 1] != '\\'
3452 tmpbuf[len++] = '/';
3453 if (len == 2 && tmpbuf[0] == '.')
3455 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3459 len = strlen(tmpbuf);
3460 if (extidx > 0) /* reset after previous loop */
3464 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3465 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3466 if (S_ISDIR(PL_statbuf.st_mode)) {
3470 } while ( retval < 0 /* not there */
3471 && extidx>=0 && ext[extidx] /* try an extension? */
3472 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3477 if (S_ISREG(PL_statbuf.st_mode)
3478 && cando(S_IRUSR,TRUE,&PL_statbuf)
3479 #if !defined(DOSISH)
3480 && cando(S_IXUSR,TRUE,&PL_statbuf)
3484 xfound = tmpbuf; /* bingo! */
3488 xfailed = savepv(tmpbuf);
3491 if (!xfound && !seen_dot && !xfailed &&
3492 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3493 || S_ISDIR(PL_statbuf.st_mode)))
3495 seen_dot = 1; /* Disable message. */
3497 if (flags & 1) { /* do or die? */
3498 Perl_croak(aTHX_ "Can't %s %s%s%s",
3499 (xfailed ? "execute" : "find"),
3500 (xfailed ? xfailed : scriptname),
3501 (xfailed ? "" : " on PATH"),
3502 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3507 scriptname = xfound;
3509 return (scriptname ? savepv(scriptname) : NULL);
3512 #ifndef PERL_GET_CONTEXT_DEFINED
3515 Perl_get_context(void)
3518 #if defined(USE_ITHREADS)
3519 # ifdef OLD_PTHREADS_API
3521 if (pthread_getspecific(PL_thr_key, &t))
3522 Perl_croak_nocontext("panic: pthread_getspecific");
3525 # ifdef I_MACH_CTHREADS
3526 return (void*)cthread_data(cthread_self());
3528 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3537 Perl_set_context(void *t)
3540 PERL_ARGS_ASSERT_SET_CONTEXT;
3541 #if defined(USE_ITHREADS)
3542 # ifdef I_MACH_CTHREADS
3543 cthread_set_data(cthread_self(), t);
3545 if (pthread_setspecific(PL_thr_key, t))
3546 Perl_croak_nocontext("panic: pthread_setspecific");
3553 #endif /* !PERL_GET_CONTEXT_DEFINED */
3555 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3564 Perl_get_op_names(pTHX)
3566 PERL_UNUSED_CONTEXT;
3567 return (char **)PL_op_name;
3571 Perl_get_op_descs(pTHX)
3573 PERL_UNUSED_CONTEXT;
3574 return (char **)PL_op_desc;
3578 Perl_get_no_modify(pTHX)
3580 PERL_UNUSED_CONTEXT;
3581 return PL_no_modify;
3585 Perl_get_opargs(pTHX)
3587 PERL_UNUSED_CONTEXT;
3588 return (U32 *)PL_opargs;
3592 Perl_get_ppaddr(pTHX)
3595 PERL_UNUSED_CONTEXT;
3596 return (PPADDR_t*)PL_ppaddr;
3599 #ifndef HAS_GETENV_LEN
3601 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3603 char * const env_trans = PerlEnv_getenv(env_elem);
3604 PERL_UNUSED_CONTEXT;
3605 PERL_ARGS_ASSERT_GETENV_LEN;
3607 *len = strlen(env_trans);
3614 Perl_get_vtbl(pTHX_ int vtbl_id)
3616 const MGVTBL* result;
3617 PERL_UNUSED_CONTEXT;
3621 result = &PL_vtbl_sv;
3624 result = &PL_vtbl_env;
3626 case want_vtbl_envelem:
3627 result = &PL_vtbl_envelem;
3630 result = &PL_vtbl_sig;
3632 case want_vtbl_sigelem:
3633 result = &PL_vtbl_sigelem;
3635 case want_vtbl_pack:
3636 result = &PL_vtbl_pack;
3638 case want_vtbl_packelem:
3639 result = &PL_vtbl_packelem;
3641 case want_vtbl_dbline:
3642 result = &PL_vtbl_dbline;
3645 result = &PL_vtbl_isa;
3647 case want_vtbl_isaelem:
3648 result = &PL_vtbl_isaelem;
3650 case want_vtbl_arylen:
3651 result = &PL_vtbl_arylen;
3653 case want_vtbl_mglob:
3654 result = &PL_vtbl_mglob;
3656 case want_vtbl_nkeys:
3657 result = &PL_vtbl_nkeys;
3659 case want_vtbl_taint:
3660 result = &PL_vtbl_taint;
3662 case want_vtbl_substr:
3663 result = &PL_vtbl_substr;
3666 result = &PL_vtbl_vec;
3669 result = &PL_vtbl_pos;
3672 result = &PL_vtbl_bm;
3675 result = &PL_vtbl_fm;
3677 case want_vtbl_uvar:
3678 result = &PL_vtbl_uvar;
3680 case want_vtbl_defelem:
3681 result = &PL_vtbl_defelem;
3683 case want_vtbl_regexp:
3684 result = &PL_vtbl_regexp;
3686 case want_vtbl_regdata:
3687 result = &PL_vtbl_regdata;
3689 case want_vtbl_regdatum:
3690 result = &PL_vtbl_regdatum;
3692 #ifdef USE_LOCALE_COLLATE
3693 case want_vtbl_collxfrm:
3694 result = &PL_vtbl_collxfrm;
3697 case want_vtbl_amagic:
3698 result = &PL_vtbl_amagic;
3700 case want_vtbl_amagicelem:
3701 result = &PL_vtbl_amagicelem;
3703 case want_vtbl_backref:
3704 result = &PL_vtbl_backref;
3706 case want_vtbl_utf8:
3707 result = &PL_vtbl_utf8;
3713 return (MGVTBL*)result;
3717 Perl_my_fflush_all(pTHX)
3719 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3720 return PerlIO_flush(NULL);
3722 # if defined(HAS__FWALK)
3723 extern int fflush(FILE *);
3724 /* undocumented, unprototyped, but very useful BSDism */
3725 extern void _fwalk(int (*)(FILE *));
3729 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3731 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3732 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3734 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3735 open_max = sysconf(_SC_OPEN_MAX);
3738 open_max = FOPEN_MAX;
3741 open_max = OPEN_MAX;
3752 for (i = 0; i < open_max; i++)
3753 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3754 STDIO_STREAM_ARRAY[i]._file < open_max &&
3755 STDIO_STREAM_ARRAY[i]._flag)
3756 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3760 SETERRNO(EBADF,RMS_IFI);
3767 Perl_report_evil_fh(pTHX_ const GV *gv, const IO *io, I32 op)
3769 const char * const name = gv && isGV(gv) ? GvENAME(gv) : NULL;
3771 if (op == OP_phoney_OUTPUT_ONLY || op == OP_phoney_INPUT_ONLY) {
3772 if (ckWARN(WARN_IO)) {
3773 const char * const direction =
3774 (const char *)((op == OP_phoney_INPUT_ONLY) ? "in" : "out");
3776 Perl_warner(aTHX_ packWARN(WARN_IO),
3777 "Filehandle %s opened only for %sput",
3780 Perl_warner(aTHX_ packWARN(WARN_IO),
3781 "Filehandle opened only for %sput", direction);
3788 if (gv && io && IoTYPE(io) == IoTYPE_CLOSED) {
3790 warn_type = WARN_CLOSED;
3794 warn_type = WARN_UNOPENED;
3797 if (ckWARN(warn_type)) {
3798 const char * const pars =
3799 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3800 const char * const func =
3802 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3803 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3804 op < 0 ? "" : /* handle phoney cases */
3806 const char * const type =
3808 (OP_IS_SOCKET(op) ||
3809 (gv && io && IoTYPE(io) == IoTYPE_SOCKET) ?
3810 "socket" : "filehandle");
3811 if (name && *name) {
3812 Perl_warner(aTHX_ packWARN(warn_type),
3813 "%s%s on %s %s %s", func, pars, vile, type, name);
3814 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3816 aTHX_ packWARN(warn_type),
3817 "\t(Are you trying to call %s%s on dirhandle %s?)\n",
3822 Perl_warner(aTHX_ packWARN(warn_type),
3823 "%s%s on %s %s", func, pars, vile, type);
3824 if (gv && io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3826 aTHX_ packWARN(warn_type),
3827 "\t(Are you trying to call %s%s on dirhandle?)\n",
3835 /* XXX Add documentation after final interface and behavior is decided */
3836 /* May want to show context for error, so would pass Perl_bslash_c(pTHX_ const char* current, const char* start, const bool output_warning)
3837 U8 source = *current;
3839 May want to add eg, WARN_REGEX
3843 Perl_grok_bslash_c(pTHX_ const char source, const bool output_warning)
3848 if (! isASCII(source)) {
3849 Perl_croak(aTHX_ "Character following \"\\c\" must be ASCII");
3852 result = toCTRL(source);
3853 if (! isCNTRL(result)) {
3854 if (source == '{') {
3855 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 \";\"");
3857 else if (output_warning) {
3858 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
3859 "\"\\c%c\" more clearly written simply as \"%c\"",
3868 /* To workaround core dumps from the uninitialised tm_zone we get the
3869 * system to give us a reasonable struct to copy. This fix means that
3870 * strftime uses the tm_zone and tm_gmtoff values returned by
3871 * localtime(time()). That should give the desired result most of the
3872 * time. But probably not always!
3874 * This does not address tzname aspects of NETaa14816.
3879 # ifndef STRUCT_TM_HASZONE
3880 # define STRUCT_TM_HASZONE
3884 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3885 # ifndef HAS_TM_TM_ZONE
3886 # define HAS_TM_TM_ZONE
3891 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3893 #ifdef HAS_TM_TM_ZONE
3895 const struct tm* my_tm;
3896 PERL_ARGS_ASSERT_INIT_TM;
3898 my_tm = localtime(&now);
3900 Copy(my_tm, ptm, 1, struct tm);
3902 PERL_ARGS_ASSERT_INIT_TM;
3903 PERL_UNUSED_ARG(ptm);
3908 * mini_mktime - normalise struct tm values without the localtime()
3909 * semantics (and overhead) of mktime().
3912 Perl_mini_mktime(pTHX_ struct tm *ptm)
3916 int month, mday, year, jday;
3917 int odd_cent, odd_year;
3918 PERL_UNUSED_CONTEXT;
3920 PERL_ARGS_ASSERT_MINI_MKTIME;
3922 #define DAYS_PER_YEAR 365
3923 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3924 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3925 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3926 #define SECS_PER_HOUR (60*60)
3927 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3928 /* parentheses deliberately absent on these two, otherwise they don't work */
3929 #define MONTH_TO_DAYS 153/5
3930 #define DAYS_TO_MONTH 5/153
3931 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3932 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3933 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3934 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3937 * Year/day algorithm notes:
3939 * With a suitable offset for numeric value of the month, one can find
3940 * an offset into the year by considering months to have 30.6 (153/5) days,
3941 * using integer arithmetic (i.e., with truncation). To avoid too much
3942 * messing about with leap days, we consider January and February to be
3943 * the 13th and 14th month of the previous year. After that transformation,
3944 * we need the month index we use to be high by 1 from 'normal human' usage,
3945 * so the month index values we use run from 4 through 15.
3947 * Given that, and the rules for the Gregorian calendar (leap years are those
3948 * divisible by 4 unless also divisible by 100, when they must be divisible
3949 * by 400 instead), we can simply calculate the number of days since some
3950 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3951 * the days we derive from our month index, and adding in the day of the
3952 * month. The value used here is not adjusted for the actual origin which
3953 * it normally would use (1 January A.D. 1), since we're not exposing it.
3954 * We're only building the value so we can turn around and get the
3955 * normalised values for the year, month, day-of-month, and day-of-year.
3957 * For going backward, we need to bias the value we're using so that we find
3958 * the right year value. (Basically, we don't want the contribution of
3959 * March 1st to the number to apply while deriving the year). Having done
3960 * that, we 'count up' the contribution to the year number by accounting for
3961 * full quadracenturies (400-year periods) with their extra leap days, plus
3962 * the contribution from full centuries (to avoid counting in the lost leap
3963 * days), plus the contribution from full quad-years (to count in the normal
3964 * leap days), plus the leftover contribution from any non-leap years.
3965 * At this point, if we were working with an actual leap day, we'll have 0
3966 * days left over. This is also true for March 1st, however. So, we have
3967 * to special-case that result, and (earlier) keep track of the 'odd'
3968 * century and year contributions. If we got 4 extra centuries in a qcent,
3969 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3970 * Otherwise, we add back in the earlier bias we removed (the 123 from
3971 * figuring in March 1st), find the month index (integer division by 30.6),
3972 * and the remainder is the day-of-month. We then have to convert back to
3973 * 'real' months (including fixing January and February from being 14/15 in
3974 * the previous year to being in the proper year). After that, to get
3975 * tm_yday, we work with the normalised year and get a new yearday value for
3976 * January 1st, which we subtract from the yearday value we had earlier,
3977 * representing the date we've re-built. This is done from January 1
3978 * because tm_yday is 0-origin.
3980 * Since POSIX time routines are only guaranteed to work for times since the
3981 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3982 * applies Gregorian calendar rules even to dates before the 16th century
3983 * doesn't bother me. Besides, you'd need cultural context for a given
3984 * date to know whether it was Julian or Gregorian calendar, and that's
3985 * outside the scope for this routine. Since we convert back based on the
3986 * same rules we used to build the yearday, you'll only get strange results
3987 * for input which needed normalising, or for the 'odd' century years which
3988 * were leap years in the Julian calander but not in the Gregorian one.
3989 * I can live with that.
3991 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3992 * that's still outside the scope for POSIX time manipulation, so I don't
3996 year = 1900 + ptm->tm_year;
3997 month = ptm->tm_mon;
3998 mday = ptm->tm_mday;
3999 /* allow given yday with no month & mday to dominate the result */
4000 if (ptm->tm_yday >= 0 && mday <= 0 && month <= 0) {
4003 jday = 1 + ptm->tm_yday;
4012 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4013 yearday += month*MONTH_TO_DAYS + mday + jday;
4015 * Note that we don't know when leap-seconds were or will be,
4016 * so we have to trust the user if we get something which looks
4017 * like a sensible leap-second. Wild values for seconds will
4018 * be rationalised, however.
4020 if ((unsigned) ptm->tm_sec <= 60) {
4027 secs += 60 * ptm->tm_min;
4028 secs += SECS_PER_HOUR * ptm->tm_hour;
4030 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4031 /* got negative remainder, but need positive time */
4032 /* back off an extra day to compensate */
4033 yearday += (secs/SECS_PER_DAY)-1;
4034 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4037 yearday += (secs/SECS_PER_DAY);
4038 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4041 else if (secs >= SECS_PER_DAY) {
4042 yearday += (secs/SECS_PER_DAY);
4043 secs %= SECS_PER_DAY;
4045 ptm->tm_hour = secs/SECS_PER_HOUR;
4046 secs %= SECS_PER_HOUR;
4047 ptm->tm_min = secs/60;
4049 ptm->tm_sec += secs;
4050 /* done with time of day effects */
4052 * The algorithm for yearday has (so far) left it high by 428.
4053 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4054 * bias it by 123 while trying to figure out what year it
4055 * really represents. Even with this tweak, the reverse
4056 * translation fails for years before A.D. 0001.
4057 * It would still fail for Feb 29, but we catch that one below.
4059 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4060 yearday -= YEAR_ADJUST;
4061 year = (yearday / DAYS_PER_QCENT) * 400;
4062 yearday %= DAYS_PER_QCENT;
4063 odd_cent = yearday / DAYS_PER_CENT;
4064 year += odd_cent * 100;
4065 yearday %= DAYS_PER_CENT;
4066 year += (yearday / DAYS_PER_QYEAR) * 4;
4067 yearday %= DAYS_PER_QYEAR;
4068 odd_year = yearday / DAYS_PER_YEAR;
4070 yearday %= DAYS_PER_YEAR;
4071 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4076 yearday += YEAR_ADJUST; /* recover March 1st crock */
4077 month = yearday*DAYS_TO_MONTH;
4078 yearday -= month*MONTH_TO_DAYS;
4079 /* recover other leap-year adjustment */
4088 ptm->tm_year = year - 1900;
4090 ptm->tm_mday = yearday;
4091 ptm->tm_mon = month;
4095 ptm->tm_mon = month - 1;
4097 /* re-build yearday based on Jan 1 to get tm_yday */
4099 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4100 yearday += 14*MONTH_TO_DAYS + 1;
4101 ptm->tm_yday = jday - yearday;
4102 /* fix tm_wday if not overridden by caller */
4103 if ((unsigned)ptm->tm_wday > 6)
4104 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4108 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)
4116 PERL_ARGS_ASSERT_MY_STRFTIME;
4118 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4121 mytm.tm_hour = hour;
4122 mytm.tm_mday = mday;
4124 mytm.tm_year = year;
4125 mytm.tm_wday = wday;
4126 mytm.tm_yday = yday;
4127 mytm.tm_isdst = isdst;
4129 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4130 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4135 #ifdef HAS_TM_TM_GMTOFF
4136 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4138 #ifdef HAS_TM_TM_ZONE
4139 mytm.tm_zone = mytm2.tm_zone;
4144 Newx(buf, buflen, char);
4145 len = strftime(buf, buflen, fmt, &mytm);
4147 ** The following is needed to handle to the situation where
4148 ** tmpbuf overflows. Basically we want to allocate a buffer
4149 ** and try repeatedly. The reason why it is so complicated
4150 ** is that getting a return value of 0 from strftime can indicate
4151 ** one of the following:
4152 ** 1. buffer overflowed,
4153 ** 2. illegal conversion specifier, or
4154 ** 3. the format string specifies nothing to be returned(not
4155 ** an error). This could be because format is an empty string
4156 ** or it specifies %p that yields an empty string in some locale.
4157 ** If there is a better way to make it portable, go ahead by
4160 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4163 /* Possibly buf overflowed - try again with a bigger buf */
4164 const int fmtlen = strlen(fmt);
4165 int bufsize = fmtlen + buflen;
4167 Newx(buf, bufsize, char);
4169 buflen = strftime(buf, bufsize, fmt, &mytm);
4170 if (buflen > 0 && buflen < bufsize)
4172 /* heuristic to prevent out-of-memory errors */
4173 if (bufsize > 100*fmtlen) {
4179 Renew(buf, bufsize, char);
4184 Perl_croak(aTHX_ "panic: no strftime");
4190 #define SV_CWD_RETURN_UNDEF \
4191 sv_setsv(sv, &PL_sv_undef); \
4194 #define SV_CWD_ISDOT(dp) \
4195 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4196 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4199 =head1 Miscellaneous Functions
4201 =for apidoc getcwd_sv
4203 Fill the sv with current working directory
4208 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4209 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4210 * getcwd(3) if available
4211 * Comments from the orignal:
4212 * This is a faster version of getcwd. It's also more dangerous
4213 * because you might chdir out of a directory that you can't chdir
4217 Perl_getcwd_sv(pTHX_ register SV *sv)
4221 #ifndef INCOMPLETE_TAINTS
4225 PERL_ARGS_ASSERT_GETCWD_SV;
4229 char buf[MAXPATHLEN];
4231 /* Some getcwd()s automatically allocate a buffer of the given
4232 * size from the heap if they are given a NULL buffer pointer.
4233 * The problem is that this behaviour is not portable. */
4234 if (getcwd(buf, sizeof(buf) - 1)) {
4239 sv_setsv(sv, &PL_sv_undef);
4247 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4251 SvUPGRADE(sv, SVt_PV);
4253 if (PerlLIO_lstat(".", &statbuf) < 0) {
4254 SV_CWD_RETURN_UNDEF;
4257 orig_cdev = statbuf.st_dev;
4258 orig_cino = statbuf.st_ino;
4268 if (PerlDir_chdir("..") < 0) {
4269 SV_CWD_RETURN_UNDEF;
4271 if (PerlLIO_stat(".", &statbuf) < 0) {
4272 SV_CWD_RETURN_UNDEF;
4275 cdev = statbuf.st_dev;
4276 cino = statbuf.st_ino;
4278 if (odev == cdev && oino == cino) {
4281 if (!(dir = PerlDir_open("."))) {
4282 SV_CWD_RETURN_UNDEF;
4285 while ((dp = PerlDir_read(dir)) != NULL) {
4287 namelen = dp->d_namlen;
4289 namelen = strlen(dp->d_name);
4292 if (SV_CWD_ISDOT(dp)) {
4296 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4297 SV_CWD_RETURN_UNDEF;
4300 tdev = statbuf.st_dev;
4301 tino = statbuf.st_ino;
4302 if (tino == oino && tdev == odev) {
4308 SV_CWD_RETURN_UNDEF;
4311 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4312 SV_CWD_RETURN_UNDEF;
4315 SvGROW(sv, pathlen + namelen + 1);
4319 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4322 /* prepend current directory to the front */
4324 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4325 pathlen += (namelen + 1);
4327 #ifdef VOID_CLOSEDIR
4330 if (PerlDir_close(dir) < 0) {
4331 SV_CWD_RETURN_UNDEF;
4337 SvCUR_set(sv, pathlen);
4341 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4342 SV_CWD_RETURN_UNDEF;
4345 if (PerlLIO_stat(".", &statbuf) < 0) {
4346 SV_CWD_RETURN_UNDEF;
4349 cdev = statbuf.st_dev;
4350 cino = statbuf.st_ino;
4352 if (cdev != orig_cdev || cino != orig_cino) {
4353 Perl_croak(aTHX_ "Unstable directory path, "
4354 "current directory changed unexpectedly");
4365 #define VERSION_MAX 0x7FFFFFFF
4368 =for apidoc prescan_version
4373 Perl_prescan_version(pTHX_ const char *s, bool strict,
4374 const char **errstr,
4375 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4376 bool qv = (sqv ? *sqv : FALSE);
4378 int saw_decimal = 0;
4382 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4384 if (qv && isDIGIT(*d))
4385 goto dotted_decimal_version;
4387 if (*d == 'v') { /* explicit v-string */
4392 else { /* degenerate v-string */
4393 /* requires v1.2.3 */
4394 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4397 dotted_decimal_version:
4398 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4399 /* no leading zeros allowed */
4400 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4403 while (isDIGIT(*d)) /* integer part */
4409 d++; /* decimal point */
4414 /* require v1.2.3 */
4415 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4418 goto version_prescan_finish;
4425 while (isDIGIT(*d)) { /* just keep reading */
4427 while (isDIGIT(*d)) {
4429 /* maximum 3 digits between decimal */
4430 if (strict && j > 3) {
4431 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4436 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4439 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4444 else if (*d == '.') {
4446 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4451 else if (!isDIGIT(*d)) {
4457 if (strict && i < 2) {
4458 /* requires v1.2.3 */
4459 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4462 } /* end if dotted-decimal */
4464 { /* decimal versions */
4465 /* special strict case for leading '.' or '0' */
4468 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4470 if (*d == '0' && isDIGIT(d[1])) {
4471 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4475 /* consume all of the integer part */
4479 /* look for a fractional part */
4481 /* we found it, so consume it */
4485 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4488 BADVERSION(s,errstr,"Invalid version format (version required)");
4490 /* found just an integer */
4491 goto version_prescan_finish;
4493 else if ( d == s ) {
4494 /* didn't find either integer or period */
4495 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4497 else if (*d == '_') {
4498 /* underscore can't come after integer part */
4500 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4502 else if (isDIGIT(d[1])) {
4503 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4506 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4510 /* anything else after integer part is just invalid data */
4511 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4514 /* scan the fractional part after the decimal point*/
4516 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4517 /* strict or lax-but-not-the-end */
4518 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4521 while (isDIGIT(*d)) {
4523 if (*d == '.' && isDIGIT(d[-1])) {
4525 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4528 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4530 d = (char *)s; /* start all over again */
4532 goto dotted_decimal_version;
4536 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4539 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4541 if ( ! isDIGIT(d[1]) ) {
4542 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4550 version_prescan_finish:
4554 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4555 /* trailing non-numeric data */
4556 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4564 *ssaw_decimal = saw_decimal;
4571 =for apidoc scan_version
4573 Returns a pointer to the next character after the parsed
4574 version string, as well as upgrading the passed in SV to
4577 Function must be called with an already existing SV like
4580 s = scan_version(s, SV *sv, bool qv);
4582 Performs some preprocessing to the string to ensure that
4583 it has the correct characteristics of a version. Flags the
4584 object if it contains an underscore (which denotes this
4585 is an alpha version). The boolean qv denotes that the version
4586 should be interpreted as if it had multiple decimals, even if
4593 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4598 const char *errstr = NULL;
4599 int saw_decimal = 0;
4603 AV * const av = newAV();
4604 SV * const hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4606 PERL_ARGS_ASSERT_SCAN_VERSION;
4608 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4610 #ifndef NODEFAULT_SHAREKEYS
4611 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4614 while (isSPACE(*s)) /* leading whitespace is OK */
4617 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4619 /* "undef" is a special case and not an error */
4620 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4621 Perl_croak(aTHX_ "%s", errstr);
4631 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4633 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4634 if ( !qv && width < 3 )
4635 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4637 while (isDIGIT(*pos))
4639 if (!isALPHA(*pos)) {
4645 /* this is atoi() that delimits on underscores */
4646 const char *end = pos;
4650 /* the following if() will only be true after the decimal
4651 * point of a version originally created with a bare
4652 * floating point number, i.e. not quoted in any way
4654 if ( !qv && s > start && saw_decimal == 1 ) {
4658 rev += (*s - '0') * mult;
4660 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4661 || (PERL_ABS(rev) > VERSION_MAX )) {
4662 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4663 "Integer overflow in version %d",VERSION_MAX);
4674 while (--end >= s) {
4676 rev += (*end - '0') * mult;
4678 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4679 || (PERL_ABS(rev) > VERSION_MAX )) {
4680 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4681 "Integer overflow in version");
4690 /* Append revision */
4691 av_push(av, newSViv(rev));
4696 else if ( *pos == '.' )
4698 else if ( *pos == '_' && isDIGIT(pos[1]) )
4700 else if ( *pos == ',' && isDIGIT(pos[1]) )
4702 else if ( isDIGIT(*pos) )
4709 while ( isDIGIT(*pos) )
4714 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4722 if ( qv ) { /* quoted versions always get at least three terms*/
4723 I32 len = av_len(av);
4724 /* This for loop appears to trigger a compiler bug on OS X, as it
4725 loops infinitely. Yes, len is negative. No, it makes no sense.
4726 Compiler in question is:
4727 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4728 for ( len = 2 - len; len > 0; len-- )
4729 av_push(MUTABLE_AV(sv), newSViv(0));
4733 av_push(av, newSViv(0));
4736 /* need to save off the current version string for later */
4738 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4739 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4740 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4742 else if ( s > start ) {
4743 SV * orig = newSVpvn(start,s-start);
4744 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4745 /* need to insert a v to be consistent */
4746 sv_insert(orig, 0, 0, "v", 1);
4748 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4751 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4752 av_push(av, newSViv(0));
4755 /* And finally, store the AV in the hash */
4756 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4758 /* fix RT#19517 - special case 'undef' as string */
4759 if ( *s == 'u' && strEQ(s,"undef") ) {
4767 =for apidoc new_version
4769 Returns a new version object based on the passed in SV:
4771 SV *sv = new_version(SV *ver);
4773 Does not alter the passed in ver SV. See "upg_version" if you
4774 want to upgrade the SV.
4780 Perl_new_version(pTHX_ SV *ver)
4783 SV * const rv = newSV(0);
4784 PERL_ARGS_ASSERT_NEW_VERSION;
4785 if ( sv_derived_from(ver,"version") ) /* can just copy directly */
4788 AV * const av = newAV();
4790 /* This will get reblessed later if a derived class*/
4791 SV * const hv = newSVrv(rv, "version");
4792 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4793 #ifndef NODEFAULT_SHAREKEYS
4794 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4800 /* Begin copying all of the elements */
4801 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4802 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4804 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4805 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4807 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4809 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4810 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4813 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4815 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4816 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4819 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4820 /* This will get reblessed later if a derived class*/
4821 for ( key = 0; key <= av_len(sav); key++ )
4823 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4824 av_push(av, newSViv(rev));
4827 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4832 const MAGIC* const mg = SvVSTRING_mg(ver);
4833 if ( mg ) { /* already a v-string */
4834 const STRLEN len = mg->mg_len;
4835 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4836 sv_setpvn(rv,version,len);
4837 /* this is for consistency with the pure Perl class */
4838 if ( isDIGIT(*version) )
4839 sv_insert(rv, 0, 0, "v", 1);
4844 sv_setsv(rv,ver); /* make a duplicate */
4849 return upg_version(rv, FALSE);
4853 =for apidoc upg_version
4855 In-place upgrade of the supplied SV to a version object.
4857 SV *sv = upg_version(SV *sv, bool qv);
4859 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4860 to force this SV to be interpreted as an "extended" version.
4866 Perl_upg_version(pTHX_ SV *ver, bool qv)
4868 const char *version, *s;
4873 PERL_ARGS_ASSERT_UPG_VERSION;
4875 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4877 /* may get too much accuracy */
4879 #ifdef USE_LOCALE_NUMERIC
4880 char *loc = setlocale(LC_NUMERIC, "C");
4882 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4883 #ifdef USE_LOCALE_NUMERIC
4884 setlocale(LC_NUMERIC, loc);
4886 while (tbuf[len-1] == '0' && len > 0) len--;
4887 if ( tbuf[len-1] == '.' ) len--; /* eat the trailing decimal */
4888 version = savepvn(tbuf, len);
4891 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4892 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4896 else /* must be a string or something like a string */
4899 version = savepv(SvPV(ver,len));
4901 # if PERL_VERSION > 5
4902 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4903 if ( len >= 3 && !instr(version,".") && !instr(version,"_")
4904 && !(*version == 'u' && strEQ(version, "undef"))
4905 && (*version < '0' || *version > '9') ) {
4906 /* may be a v-string */
4907 SV * const nsv = sv_newmortal();
4910 int saw_decimal = 0;
4911 sv_setpvf(nsv,"v%vd",ver);
4912 pos = nver = savepv(SvPV_nolen(nsv));
4914 /* scan the resulting formatted string */
4915 pos++; /* skip the leading 'v' */
4916 while ( *pos == '.' || isDIGIT(*pos) ) {
4922 /* is definitely a v-string */
4923 if ( saw_decimal >= 2 ) {
4932 s = scan_version(version, ver, qv);
4934 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4935 "Version string '%s' contains invalid data; "
4936 "ignoring: '%s'", version, s);
4944 Validates that the SV contains a valid version object.
4946 bool vverify(SV *vobj);
4948 Note that it only confirms the bare minimum structure (so as not to get
4949 confused by derived classes which may contain additional hash entries):
4953 =item * The SV contains a [reference to a] hash
4955 =item * The hash contains a "version" key
4957 =item * The "version" key has [a reference to] an AV as its value
4965 Perl_vverify(pTHX_ SV *vs)
4969 PERL_ARGS_ASSERT_VVERIFY;
4974 /* see if the appropriate elements exist */
4975 if ( SvTYPE(vs) == SVt_PVHV
4976 && hv_exists(MUTABLE_HV(vs), "version", 7)
4977 && (sv = SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)))
4978 && SvTYPE(sv) == SVt_PVAV )
4987 Accepts a version object and returns the normalized floating
4988 point representation. Call like:
4992 NOTE: you can pass either the object directly or the SV
4993 contained within the RV.
4999 Perl_vnumify(pTHX_ SV *vs)
5007 PERL_ARGS_ASSERT_VNUMIFY;
5013 Perl_croak(aTHX_ "Invalid version object");
5015 /* see if various flags exist */
5016 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
5018 if ( hv_exists(MUTABLE_HV(vs), "width", 5 ) )
5019 width = SvIV(*hv_fetchs(MUTABLE_HV(vs), "width", FALSE));
5024 /* attempt to retrieve the version array */
5025 if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
5026 return newSVpvs("0");
5032 return newSVpvs("0");
5035 digit = SvIV(*av_fetch(av, 0, 0));
5036 sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
5037 for ( i = 1 ; i < len ; i++ )
5039 digit = SvIV(*av_fetch(av, i, 0));
5041 const int denom = (width == 2 ? 10 : 100);
5042 const div_t term = div((int)PERL_ABS(digit),denom);
5043 Perl_sv_catpvf(aTHX_ sv, "%0*d_%d", width, term.quot, term.rem);
5046 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
5052 digit = SvIV(*av_fetch(av, len, 0));
5053 if ( alpha && width == 3 ) /* alpha version */
5055 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
5059 sv_catpvs(sv, "000");
5067 Accepts a version object and returns the normalized string
5068 representation. Call like:
5072 NOTE: you can pass either the object directly or the SV
5073 contained within the RV.
5079 Perl_vnormal(pTHX_ SV *vs)
5086 PERL_ARGS_ASSERT_VNORMAL;
5092 Perl_croak(aTHX_ "Invalid version object");
5094 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
5096 av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
5101 return newSVpvs("");
5103 digit = SvIV(*av_fetch(av, 0, 0));
5104 sv = Perl_newSVpvf(aTHX_ "v%"IVdf, (IV)digit);
5105 for ( i = 1 ; i < len ; i++ ) {
5106 digit = SvIV(*av_fetch(av, i, 0));
5107 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5112 /* handle last digit specially */
5113 digit = SvIV(*av_fetch(av, len, 0));
5115 Perl_sv_catpvf(aTHX_ sv, "_%"IVdf, (IV)digit);
5117 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
5120 if ( len <= 2 ) { /* short version, must be at least three */
5121 for ( len = 2 - len; len != 0; len-- )
5128 =for apidoc vstringify
5130 In order to maintain maximum compatibility with earlier versions
5131 of Perl, this function will return either the floating point
5132 notation or the multiple dotted notation, depending on whether
5133 the original version contained 1 or more dots, respectively
5139 Perl_vstringify(pTHX_ SV *vs)
5141 PERL_ARGS_ASSERT_VSTRINGIFY;
5147 Perl_croak(aTHX_ "Invalid version object");
5149 if (hv_exists(MUTABLE_HV(vs), "original", sizeof("original") - 1)) {
5151 pv = *hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
5155 return &PL_sv_undef;
5158 if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
5168 Version object aware cmp. Both operands must already have been
5169 converted into version objects.
5175 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
5178 bool lalpha = FALSE;
5179 bool ralpha = FALSE;
5184 PERL_ARGS_ASSERT_VCMP;
5191 if ( !vverify(lhv) )
5192 Perl_croak(aTHX_ "Invalid version object");
5194 if ( !vverify(rhv) )
5195 Perl_croak(aTHX_ "Invalid version object");
5197 /* get the left hand term */
5198 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
5199 if ( hv_exists(MUTABLE_HV(lhv), "alpha", 5 ) )
5202 /* and the right hand term */
5203 rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
5204 if ( hv_exists(MUTABLE_HV(rhv), "alpha", 5 ) )
5212 while ( i <= m && retval == 0 )
5214 left = SvIV(*av_fetch(lav,i,0));
5215 right = SvIV(*av_fetch(rav,i,0));
5223 /* tiebreaker for alpha with identical terms */
5224 if ( retval == 0 && l == r && left == right && ( lalpha || ralpha ) )
5226 if ( lalpha && !ralpha )
5230 else if ( ralpha && !lalpha)
5236 if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
5240 while ( i <= r && retval == 0 )
5242 if ( SvIV(*av_fetch(rav,i,0)) != 0 )
5243 retval = -1; /* not a match after all */
5249 while ( i <= l && retval == 0 )
5251 if ( SvIV(*av_fetch(lav,i,0)) != 0 )
5252 retval = +1; /* not a match after all */
5260 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
5261 # define EMULATE_SOCKETPAIR_UDP
5264 #ifdef EMULATE_SOCKETPAIR_UDP
5266 S_socketpair_udp (int fd[2]) {
5268 /* Fake a datagram socketpair using UDP to localhost. */
5269 int sockets[2] = {-1, -1};
5270 struct sockaddr_in addresses[2];
5272 Sock_size_t size = sizeof(struct sockaddr_in);
5273 unsigned short port;
5276 memset(&addresses, 0, sizeof(addresses));
5279 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
5280 if (sockets[i] == -1)
5281 goto tidy_up_and_fail;
5283 addresses[i].sin_family = AF_INET;
5284 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5285 addresses[i].sin_port = 0; /* kernel choses port. */
5286 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
5287 sizeof(struct sockaddr_in)) == -1)
5288 goto tidy_up_and_fail;
5291 /* Now have 2 UDP sockets. Find out which port each is connected to, and
5292 for each connect the other socket to it. */
5295 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
5297 goto tidy_up_and_fail;
5298 if (size != sizeof(struct sockaddr_in))
5299 goto abort_tidy_up_and_fail;
5300 /* !1 is 0, !0 is 1 */
5301 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
5302 sizeof(struct sockaddr_in)) == -1)
5303 goto tidy_up_and_fail;
5306 /* Now we have 2 sockets connected to each other. I don't trust some other
5307 process not to have already sent a packet to us (by random) so send
5308 a packet from each to the other. */
5311 /* I'm going to send my own port number. As a short.
5312 (Who knows if someone somewhere has sin_port as a bitfield and needs
5313 this routine. (I'm assuming crays have socketpair)) */
5314 port = addresses[i].sin_port;
5315 got = PerlLIO_write(sockets[i], &port, sizeof(port));
5316 if (got != sizeof(port)) {
5318 goto tidy_up_and_fail;
5319 goto abort_tidy_up_and_fail;
5323 /* Packets sent. I don't trust them to have arrived though.
5324 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
5325 connect to localhost will use a second kernel thread. In 2.6 the
5326 first thread running the connect() returns before the second completes,
5327 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
5328 returns 0. Poor programs have tripped up. One poor program's authors'
5329 had a 50-1 reverse stock split. Not sure how connected these were.)
5330 So I don't trust someone not to have an unpredictable UDP stack.
5334 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
5335 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
5339 FD_SET((unsigned int)sockets[0], &rset);
5340 FD_SET((unsigned int)sockets[1], &rset);
5342 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
5343 if (got != 2 || !FD_ISSET(sockets[0], &rset)
5344 || !FD_ISSET(sockets[1], &rset)) {
5345 /* I hope this is portable and appropriate. */
5347 goto tidy_up_and_fail;
5348 goto abort_tidy_up_and_fail;
5352 /* And the paranoia department even now doesn't trust it to have arrive
5353 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
5355 struct sockaddr_in readfrom;
5356 unsigned short buffer[2];
5361 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5362 sizeof(buffer), MSG_DONTWAIT,
5363 (struct sockaddr *) &readfrom, &size);
5365 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5367 (struct sockaddr *) &readfrom, &size);
5371 goto tidy_up_and_fail;
5372 if (got != sizeof(port)
5373 || size != sizeof(struct sockaddr_in)
5374 /* Check other socket sent us its port. */
5375 || buffer[0] != (unsigned short) addresses[!i].sin_port
5376 /* Check kernel says we got the datagram from that socket */
5377 || readfrom.sin_family != addresses[!i].sin_family
5378 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
5379 || readfrom.sin_port != addresses[!i].sin_port)
5380 goto abort_tidy_up_and_fail;
5383 /* My caller (my_socketpair) has validated that this is non-NULL */
5386 /* I hereby declare this connection open. May God bless all who cross
5390 abort_tidy_up_and_fail:
5391 errno = ECONNABORTED;
5395 if (sockets[0] != -1)
5396 PerlLIO_close(sockets[0]);
5397 if (sockets[1] != -1)
5398 PerlLIO_close(sockets[1]);
5403 #endif /* EMULATE_SOCKETPAIR_UDP */
5405 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
5407 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5408 /* Stevens says that family must be AF_LOCAL, protocol 0.
5409 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
5414 struct sockaddr_in listen_addr;
5415 struct sockaddr_in connect_addr;
5420 || family != AF_UNIX
5423 errno = EAFNOSUPPORT;
5431 #ifdef EMULATE_SOCKETPAIR_UDP
5432 if (type == SOCK_DGRAM)
5433 return S_socketpair_udp(fd);
5436 listener = PerlSock_socket(AF_INET, type, 0);
5439 memset(&listen_addr, 0, sizeof(listen_addr));
5440 listen_addr.sin_family = AF_INET;
5441 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5442 listen_addr.sin_port = 0; /* kernel choses port. */
5443 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
5444 sizeof(listen_addr)) == -1)
5445 goto tidy_up_and_fail;
5446 if (PerlSock_listen(listener, 1) == -1)
5447 goto tidy_up_and_fail;
5449 connector = PerlSock_socket(AF_INET, type, 0);
5450 if (connector == -1)
5451 goto tidy_up_and_fail;
5452 /* We want to find out the port number to connect to. */
5453 size = sizeof(connect_addr);
5454 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
5456 goto tidy_up_and_fail;
5457 if (size != sizeof(connect_addr))
5458 goto abort_tidy_up_and_fail;
5459 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
5460 sizeof(connect_addr)) == -1)
5461 goto tidy_up_and_fail;
5463 size = sizeof(listen_addr);
5464 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
5467 goto tidy_up_and_fail;
5468 if (size != sizeof(listen_addr))
5469 goto abort_tidy_up_and_fail;
5470 PerlLIO_close(listener);
5471 /* Now check we are talking to ourself by matching port and host on the
5473 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
5475 goto tidy_up_and_fail;
5476 if (size != sizeof(connect_addr)
5477 || listen_addr.sin_family != connect_addr.sin_family
5478 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
5479 || listen_addr.sin_port != connect_addr.sin_port) {
5480 goto abort_tidy_up_and_fail;
5486 abort_tidy_up_and_fail:
5488 errno = ECONNABORTED; /* This would be the standard thing to do. */
5490 # ifdef ECONNREFUSED
5491 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
5493 errno = ETIMEDOUT; /* Desperation time. */
5500 PerlLIO_close(listener);
5501 if (connector != -1)
5502 PerlLIO_close(connector);
5504 PerlLIO_close(acceptor);
5510 /* In any case have a stub so that there's code corresponding
5511 * to the my_socketpair in global.sym. */
5513 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5514 #ifdef HAS_SOCKETPAIR
5515 return socketpair(family, type, protocol, fd);
5524 =for apidoc sv_nosharing
5526 Dummy routine which "shares" an SV when there is no sharing module present.
5527 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
5528 Exists to avoid test for a NULL function pointer and because it could
5529 potentially warn under some level of strict-ness.
5535 Perl_sv_nosharing(pTHX_ SV *sv)
5537 PERL_UNUSED_CONTEXT;
5538 PERL_UNUSED_ARG(sv);
5543 =for apidoc sv_destroyable
5545 Dummy routine which reports that object can be destroyed when there is no
5546 sharing module present. It ignores its single SV argument, and returns
5547 'true'. Exists to avoid test for a NULL function pointer and because it
5548 could potentially warn under some level of strict-ness.
5554 Perl_sv_destroyable(pTHX_ SV *sv)
5556 PERL_UNUSED_CONTEXT;
5557 PERL_UNUSED_ARG(sv);
5562 Perl_parse_unicode_opts(pTHX_ const char **popt)
5564 const char *p = *popt;
5567 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
5571 opt = (U32) atoi(p);
5574 if (*p && *p != '\n' && *p != '\r')
5575 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
5580 case PERL_UNICODE_STDIN:
5581 opt |= PERL_UNICODE_STDIN_FLAG; break;
5582 case PERL_UNICODE_STDOUT:
5583 opt |= PERL_UNICODE_STDOUT_FLAG; break;
5584 case PERL_UNICODE_STDERR:
5585 opt |= PERL_UNICODE_STDERR_FLAG; break;
5586 case PERL_UNICODE_STD:
5587 opt |= PERL_UNICODE_STD_FLAG; break;
5588 case PERL_UNICODE_IN:
5589 opt |= PERL_UNICODE_IN_FLAG; break;
5590 case PERL_UNICODE_OUT:
5591 opt |= PERL_UNICODE_OUT_FLAG; break;
5592 case PERL_UNICODE_INOUT:
5593 opt |= PERL_UNICODE_INOUT_FLAG; break;
5594 case PERL_UNICODE_LOCALE:
5595 opt |= PERL_UNICODE_LOCALE_FLAG; break;
5596 case PERL_UNICODE_ARGV:
5597 opt |= PERL_UNICODE_ARGV_FLAG; break;
5598 case PERL_UNICODE_UTF8CACHEASSERT:
5599 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
5601 if (*p != '\n' && *p != '\r')
5603 "Unknown Unicode option letter '%c'", *p);
5609 opt = PERL_UNICODE_DEFAULT_FLAGS;
5611 if (opt & ~PERL_UNICODE_ALL_FLAGS)
5612 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
5613 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
5625 * This is really just a quick hack which grabs various garbage
5626 * values. It really should be a real hash algorithm which
5627 * spreads the effect of every input bit onto every output bit,
5628 * if someone who knows about such things would bother to write it.
5629 * Might be a good idea to add that function to CORE as well.
5630 * No numbers below come from careful analysis or anything here,
5631 * except they are primes and SEED_C1 > 1E6 to get a full-width
5632 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
5633 * probably be bigger too.
5636 # define SEED_C1 1000003
5637 #define SEED_C4 73819
5639 # define SEED_C1 25747
5640 #define SEED_C4 20639
5644 #define SEED_C5 26107
5646 #ifndef PERL_NO_DEV_RANDOM
5651 # include <starlet.h>
5652 /* when[] = (low 32 bits, high 32 bits) of time since epoch
5653 * in 100-ns units, typically incremented ever 10 ms. */
5654 unsigned int when[2];
5656 # ifdef HAS_GETTIMEOFDAY
5657 struct timeval when;
5663 /* This test is an escape hatch, this symbol isn't set by Configure. */
5664 #ifndef PERL_NO_DEV_RANDOM
5665 #ifndef PERL_RANDOM_DEVICE
5666 /* /dev/random isn't used by default because reads from it will block
5667 * if there isn't enough entropy available. You can compile with
5668 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
5669 * is enough real entropy to fill the seed. */
5670 # define PERL_RANDOM_DEVICE "/dev/urandom"
5672 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
5674 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
5683 _ckvmssts(sys$gettim(when));
5684 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
5686 # ifdef HAS_GETTIMEOFDAY
5687 PerlProc_gettimeofday(&when,NULL);
5688 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
5691 u = (U32)SEED_C1 * when;
5694 u += SEED_C3 * (U32)PerlProc_getpid();
5695 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
5696 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
5697 u += SEED_C5 * (U32)PTR2UV(&when);
5703 Perl_get_hash_seed(pTHX)
5706 const char *s = PerlEnv_getenv("PERL_HASH_SEED");
5712 if (s && isDIGIT(*s))
5713 myseed = (UV)Atoul(s);
5715 #ifdef USE_HASH_SEED_EXPLICIT
5719 /* Compute a random seed */
5720 (void)seedDrand01((Rand_seed_t)seed());
5721 myseed = (UV)(Drand01() * (NV)UV_MAX);
5722 #if RANDBITS < (UVSIZE * 8)
5723 /* Since there are not enough randbits to to reach all
5724 * the bits of a UV, the low bits might need extra
5725 * help. Sum in another random number that will
5726 * fill in the low bits. */
5728 (UV)(Drand01() * (NV)((((UV)1) << ((UVSIZE * 8 - RANDBITS))) - 1));
5729 #endif /* RANDBITS < (UVSIZE * 8) */
5730 if (myseed == 0) { /* Superparanoia. */
5731 myseed = (UV)(Drand01() * (NV)UV_MAX); /* One more chance. */
5733 Perl_croak(aTHX_ "Your random numbers are not that random");
5736 PL_rehash_seed_set = TRUE;
5743 Perl_stashpv_hvname_match(pTHX_ const COP *c, const HV *hv)
5745 const char * const stashpv = CopSTASHPV(c);
5746 const char * const name = HvNAME_get(hv);
5747 PERL_UNUSED_CONTEXT;
5748 PERL_ARGS_ASSERT_STASHPV_HVNAME_MATCH;
5750 if (stashpv == name)
5752 if (stashpv && name)
5753 if (strEQ(stashpv, name))
5760 #ifdef PERL_GLOBAL_STRUCT
5762 #define PERL_GLOBAL_STRUCT_INIT
5763 #include "opcode.h" /* the ppaddr and check */
5766 Perl_init_global_struct(pTHX)
5768 struct perl_vars *plvarsp = NULL;
5769 # ifdef PERL_GLOBAL_STRUCT
5770 const IV nppaddr = sizeof(Gppaddr)/sizeof(Perl_ppaddr_t);
5771 const IV ncheck = sizeof(Gcheck) /sizeof(Perl_check_t);
5772 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5773 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
5774 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
5778 plvarsp = PL_VarsPtr;
5779 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
5785 # define PERLVAR(var,type) /**/
5786 # define PERLVARA(var,n,type) /**/
5787 # define PERLVARI(var,type,init) plvarsp->var = init;
5788 # define PERLVARIC(var,type,init) plvarsp->var = init;
5789 # define PERLVARISC(var,init) Copy(init, plvarsp->var, sizeof(init), char);
5790 # include "perlvars.h"
5796 # ifdef PERL_GLOBAL_STRUCT
5799 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
5800 if (!plvarsp->Gppaddr)
5804 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
5805 if (!plvarsp->Gcheck)
5807 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
5808 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
5810 # ifdef PERL_SET_VARS
5811 PERL_SET_VARS(plvarsp);
5813 # undef PERL_GLOBAL_STRUCT_INIT
5818 #endif /* PERL_GLOBAL_STRUCT */
5820 #ifdef PERL_GLOBAL_STRUCT
5823 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
5825 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
5826 # ifdef PERL_GLOBAL_STRUCT
5827 # ifdef PERL_UNSET_VARS
5828 PERL_UNSET_VARS(plvarsp);
5830 free(plvarsp->Gppaddr);
5831 free(plvarsp->Gcheck);
5832 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5838 #endif /* PERL_GLOBAL_STRUCT */
5842 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
5843 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5844 * given, and you supply your own implementation.
5846 * The default implementation reads a single env var, PERL_MEM_LOG,
5847 * expecting one or more of the following:
5849 * \d+ - fd fd to write to : must be 1st (atoi)
5850 * 'm' - memlog was PERL_MEM_LOG=1
5851 * 's' - svlog was PERL_SV_LOG=1
5852 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5854 * This makes the logger controllable enough that it can reasonably be
5855 * added to the system perl.
5858 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5859 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5861 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
5863 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5864 * writes to. In the default logger, this is settable at runtime.
5866 #ifndef PERL_MEM_LOG_FD
5867 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5870 #ifndef PERL_MEM_LOG_NOIMPL
5872 # ifdef DEBUG_LEAKING_SCALARS
5873 # define SV_LOG_SERIAL_FMT " [%lu]"
5874 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5876 # define SV_LOG_SERIAL_FMT
5877 # define _SV_LOG_SERIAL_ARG(sv)
5881 S_mem_log_common(enum mem_log_type mlt, const UV n,
5882 const UV typesize, const char *type_name, const SV *sv,
5883 Malloc_t oldalloc, Malloc_t newalloc,
5884 const char *filename, const int linenumber,
5885 const char *funcname)
5889 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5891 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5894 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5896 /* We can't use SVs or PerlIO for obvious reasons,
5897 * so we'll use stdio and low-level IO instead. */
5898 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5900 # ifdef HAS_GETTIMEOFDAY
5901 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5902 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5904 gettimeofday(&tv, 0);
5906 # define MEM_LOG_TIME_FMT "%10d: "
5907 # define MEM_LOG_TIME_ARG (int)when
5911 /* If there are other OS specific ways of hires time than
5912 * gettimeofday() (see ext/Time-HiRes), the easiest way is
5913 * probably that they would be used to fill in the struct
5917 int fd = atoi(pmlenv);
5919 fd = PERL_MEM_LOG_FD;
5921 if (strchr(pmlenv, 't')) {
5922 len = my_snprintf(buf, sizeof(buf),
5923 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5924 PerlLIO_write(fd, buf, len);
5928 len = my_snprintf(buf, sizeof(buf),
5929 "alloc: %s:%d:%s: %"IVdf" %"UVuf
5930 " %s = %"IVdf": %"UVxf"\n",
5931 filename, linenumber, funcname, n, typesize,
5932 type_name, n * typesize, PTR2UV(newalloc));
5935 len = my_snprintf(buf, sizeof(buf),
5936 "realloc: %s:%d:%s: %"IVdf" %"UVuf
5937 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
5938 filename, linenumber, funcname, n, typesize,
5939 type_name, n * typesize, PTR2UV(oldalloc),
5943 len = my_snprintf(buf, sizeof(buf),
5944 "free: %s:%d:%s: %"UVxf"\n",
5945 filename, linenumber, funcname,
5950 len = my_snprintf(buf, sizeof(buf),
5951 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
5952 mlt == MLT_NEW_SV ? "new" : "del",
5953 filename, linenumber, funcname,
5954 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5959 PerlLIO_write(fd, buf, len);
5963 #endif /* !PERL_MEM_LOG_NOIMPL */
5965 #ifndef PERL_MEM_LOG_NOIMPL
5967 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5968 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5970 /* this is suboptimal, but bug compatible. User is providing their
5971 own implemenation, but is getting these functions anyway, and they
5972 do nothing. But _NOIMPL users should be able to cope or fix */
5974 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5975 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5979 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5981 const char *filename, const int linenumber,
5982 const char *funcname)
5984 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5985 NULL, NULL, newalloc,
5986 filename, linenumber, funcname);
5991 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5992 Malloc_t oldalloc, Malloc_t newalloc,
5993 const char *filename, const int linenumber,
5994 const char *funcname)
5996 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5997 NULL, oldalloc, newalloc,
5998 filename, linenumber, funcname);
6003 Perl_mem_log_free(Malloc_t oldalloc,
6004 const char *filename, const int linenumber,
6005 const char *funcname)
6007 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
6008 filename, linenumber, funcname);
6013 Perl_mem_log_new_sv(const SV *sv,
6014 const char *filename, const int linenumber,
6015 const char *funcname)
6017 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
6018 filename, linenumber, funcname);
6022 Perl_mem_log_del_sv(const SV *sv,
6023 const char *filename, const int linenumber,
6024 const char *funcname)
6026 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
6027 filename, linenumber, funcname);
6030 #endif /* PERL_MEM_LOG */
6033 =for apidoc my_sprintf
6035 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
6036 the length of the string written to the buffer. Only rare pre-ANSI systems
6037 need the wrapper function - usually this is a direct call to C<sprintf>.
6041 #ifndef SPRINTF_RETURNS_STRLEN
6043 Perl_my_sprintf(char *buffer, const char* pat, ...)
6046 PERL_ARGS_ASSERT_MY_SPRINTF;
6047 va_start(args, pat);
6048 vsprintf(buffer, pat, args);
6050 return strlen(buffer);
6055 =for apidoc my_snprintf
6057 The C library C<snprintf> functionality, if available and
6058 standards-compliant (uses C<vsnprintf>, actually). However, if the
6059 C<vsnprintf> is not available, will unfortunately use the unsafe
6060 C<vsprintf> which can overrun the buffer (there is an overrun check,
6061 but that may be too late). Consider using C<sv_vcatpvf> instead, or
6062 getting C<vsnprintf>.
6067 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
6072 PERL_ARGS_ASSERT_MY_SNPRINTF;
6073 va_start(ap, format);
6074 #ifdef HAS_VSNPRINTF
6075 retval = vsnprintf(buffer, len, format, ap);
6077 retval = vsprintf(buffer, format, ap);
6080 /* vsnprintf() shows failure with >= len, vsprintf() with < 0 */
6081 if (retval < 0 || (len > 0 && (Size_t)retval >= len))
6082 Perl_croak(aTHX_ "panic: my_snprintf buffer overflow");
6087 =for apidoc my_vsnprintf
6089 The C library C<vsnprintf> if available and standards-compliant.
6090 However, if if the C<vsnprintf> is not available, will unfortunately
6091 use the unsafe C<vsprintf> which can overrun the buffer (there is an
6092 overrun check, but that may be too late). Consider using
6093 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
6098 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
6105 PERL_ARGS_ASSERT_MY_VSNPRINTF;
6107 Perl_va_copy(ap, apc);
6108 # ifdef HAS_VSNPRINTF
6109 retval = vsnprintf(buffer, len, format, apc);
6111 retval = vsprintf(buffer, format, apc);
6114 # ifdef HAS_VSNPRINTF
6115 retval = vsnprintf(buffer, len, format, ap);
6117 retval = vsprintf(buffer, format, ap);
6119 #endif /* #ifdef NEED_VA_COPY */
6120 /* vsnprintf() shows failure with >= len, vsprintf() with < 0 */
6121 if (retval < 0 || (len > 0 && (Size_t)retval >= len))
6122 Perl_croak(aTHX_ "panic: my_vsnprintf buffer overflow");
6127 Perl_my_clearenv(pTHX)
6130 #if ! defined(PERL_MICRO)
6131 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
6133 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
6134 # if defined(USE_ENVIRON_ARRAY)
6135 # if defined(USE_ITHREADS)
6136 /* only the parent thread can clobber the process environment */
6137 if (PL_curinterp == aTHX)
6138 # endif /* USE_ITHREADS */
6140 # if ! defined(PERL_USE_SAFE_PUTENV)
6141 if ( !PL_use_safe_putenv) {
6143 if (environ == PL_origenviron)
6144 environ = (char**)safesysmalloc(sizeof(char*));
6146 for (i = 0; environ[i]; i++)
6147 (void)safesysfree(environ[i]);
6150 # else /* PERL_USE_SAFE_PUTENV */
6151 # if defined(HAS_CLEARENV)
6153 # elif defined(HAS_UNSETENV)
6154 int bsiz = 80; /* Most envvar names will be shorter than this. */
6155 int bufsiz = bsiz * sizeof(char); /* sizeof(char) paranoid? */
6156 char *buf = (char*)safesysmalloc(bufsiz);
6157 while (*environ != NULL) {
6158 char *e = strchr(*environ, '=');
6159 int l = e ? e - *environ : (int)strlen(*environ);
6161 (void)safesysfree(buf);
6162 bsiz = l + 1; /* + 1 for the \0. */
6163 buf = (char*)safesysmalloc(bufsiz);
6165 memcpy(buf, *environ, l);
6167 (void)unsetenv(buf);
6169 (void)safesysfree(buf);
6170 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
6171 /* Just null environ and accept the leakage. */
6173 # endif /* HAS_CLEARENV || HAS_UNSETENV */
6174 # endif /* ! PERL_USE_SAFE_PUTENV */
6176 # endif /* USE_ENVIRON_ARRAY */
6177 # endif /* PERL_IMPLICIT_SYS || WIN32 */
6178 #endif /* PERL_MICRO */
6181 #ifdef PERL_IMPLICIT_CONTEXT
6183 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
6184 the global PL_my_cxt_index is incremented, and that value is assigned to
6185 that module's static my_cxt_index (who's address is passed as an arg).
6186 Then, for each interpreter this function is called for, it makes sure a
6187 void* slot is available to hang the static data off, by allocating or
6188 extending the interpreter's PL_my_cxt_list array */
6190 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
6192 Perl_my_cxt_init(pTHX_ int *index, size_t size)
6196 PERL_ARGS_ASSERT_MY_CXT_INIT;
6198 /* this module hasn't been allocated an index yet */
6199 #if defined(USE_ITHREADS)
6200 MUTEX_LOCK(&PL_my_ctx_mutex);
6202 *index = PL_my_cxt_index++;
6203 #if defined(USE_ITHREADS)
6204 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6208 /* make sure the array is big enough */
6209 if (PL_my_cxt_size <= *index) {
6210 if (PL_my_cxt_size) {
6211 while (PL_my_cxt_size <= *index)
6212 PL_my_cxt_size *= 2;
6213 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6216 PL_my_cxt_size = 16;
6217 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6220 /* newSV() allocates one more than needed */
6221 p = (void*)SvPVX(newSV(size-1));
6222 PL_my_cxt_list[*index] = p;
6223 Zero(p, size, char);
6227 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6230 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
6235 PERL_ARGS_ASSERT_MY_CXT_INDEX;
6237 for (index = 0; index < PL_my_cxt_index; index++) {
6238 const char *key = PL_my_cxt_keys[index];
6239 /* try direct pointer compare first - there are chances to success,
6240 * and it's much faster.
6242 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
6249 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
6255 PERL_ARGS_ASSERT_MY_CXT_INIT;
6257 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
6259 /* this module hasn't been allocated an index yet */
6260 #if defined(USE_ITHREADS)
6261 MUTEX_LOCK(&PL_my_ctx_mutex);
6263 index = PL_my_cxt_index++;
6264 #if defined(USE_ITHREADS)
6265 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6269 /* make sure the array is big enough */
6270 if (PL_my_cxt_size <= index) {
6271 int old_size = PL_my_cxt_size;
6273 if (PL_my_cxt_size) {
6274 while (PL_my_cxt_size <= index)
6275 PL_my_cxt_size *= 2;
6276 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6277 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6280 PL_my_cxt_size = 16;
6281 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6282 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6284 for (i = old_size; i < PL_my_cxt_size; i++) {
6285 PL_my_cxt_keys[i] = 0;
6286 PL_my_cxt_list[i] = 0;
6289 PL_my_cxt_keys[index] = my_cxt_key;
6290 /* newSV() allocates one more than needed */
6291 p = (void*)SvPVX(newSV(size-1));
6292 PL_my_cxt_list[index] = p;
6293 Zero(p, size, char);
6296 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6297 #endif /* PERL_IMPLICIT_CONTEXT */
6301 Perl_my_strlcat(char *dst, const char *src, Size_t size)
6303 Size_t used, length, copy;
6306 length = strlen(src);
6307 if (size > 0 && used < size - 1) {
6308 copy = (length >= size - used) ? size - used - 1 : length;
6309 memcpy(dst + used, src, copy);
6310 dst[used + copy] = '\0';
6312 return used + length;
6318 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
6320 Size_t length, copy;
6322 length = strlen(src);
6324 copy = (length >= size) ? size - 1 : length;
6325 memcpy(dst, src, copy);
6332 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
6333 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
6334 long _ftol( double ); /* Defined by VC6 C libs. */
6335 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
6339 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
6342 SV * const dbsv = GvSVn(PL_DBsub);
6343 /* We do not care about using sv to call CV;
6344 * it's for informational purposes only.
6347 PERL_ARGS_ASSERT_GET_DB_SUB;
6350 if (!PERLDB_SUB_NN) {
6351 GV * const gv = CvGV(cv);
6353 if ( svp && ((CvFLAGS(cv) & (CVf_ANON | CVf_CLONED))
6354 || strEQ(GvNAME(gv), "END")
6355 || ((GvCV(gv) != cv) && /* Could be imported, and old sub redefined. */
6356 !( (SvTYPE(*svp) == SVt_PVGV)
6357 && (GvCV((const GV *)*svp) == cv) )))) {
6358 /* Use GV from the stack as a fallback. */
6359 /* GV is potentially non-unique, or contain different CV. */
6360 SV * const tmp = newRV(MUTABLE_SV(cv));
6361 sv_setsv(dbsv, tmp);
6365 gv_efullname3(dbsv, gv, NULL);
6369 const int type = SvTYPE(dbsv);
6370 if (type < SVt_PVIV && type != SVt_IV)
6371 sv_upgrade(dbsv, SVt_PVIV);
6372 (void)SvIOK_on(dbsv);
6373 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
6378 Perl_my_dirfd(pTHX_ DIR * dir) {
6380 /* Most dirfd implementations have problems when passed NULL. */
6385 #elif defined(HAS_DIR_DD_FD)
6388 Perl_die(aTHX_ PL_no_func, "dirfd");
6395 Perl_get_re_arg(pTHX_ SV *sv) {
6401 sv = MUTABLE_SV(SvRV(sv));
6402 if (SvTYPE(sv) == SVt_REGEXP)
6403 return (REGEXP*) sv;
6411 * c-indentation-style: bsd
6413 * indent-tabs-mode: t
6416 * ex: set ts=8 sts=4 sw=4 noet: