3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
29 #include "perliol.h" /* For PerlIOUnix_refcnt */
35 # define SIG_ERR ((Sighandler_t) -1)
40 /* Missing protos on LynxOS */
45 # include <sys/wait.h>
50 # include <sys/select.h>
56 #if defined(HAS_FCNTL) && defined(F_SETFD) && !defined(FD_CLOEXEC)
57 # define FD_CLOEXEC 1 /* NeXT needs this */
60 /* NOTE: Do not call the next three routines directly. Use the macros
61 * in handy.h, so that we can easily redefine everything to do tracking of
62 * allocated hunks back to the original New to track down any memory leaks.
63 * XXX This advice seems to be widely ignored :-( --AD August 1996.
70 /* Can't use PerlIO to write as it allocates memory */
71 PerlLIO_write(PerlIO_fileno(Perl_error_log),
72 PL_no_mem, strlen(PL_no_mem));
74 NORETURN_FUNCTION_END;
77 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
78 # define ALWAYS_NEED_THX
81 /* paranoid version of system's malloc() */
84 Perl_safesysmalloc(MEM_SIZE size)
86 #ifdef ALWAYS_NEED_THX
92 PerlIO_printf(Perl_error_log,
93 "Allocation too large: %lx\n", size) FLUSH;
96 #endif /* HAS_64K_LIMIT */
97 #ifdef PERL_TRACK_MEMPOOL
102 Perl_croak_nocontext("panic: malloc");
104 ptr = (Malloc_t)PerlMem_malloc(size?size:1); /* malloc(0) is NASTY on our system */
105 PERL_ALLOC_CHECK(ptr);
107 #ifdef PERL_TRACK_MEMPOOL
108 struct perl_memory_debug_header *const header
109 = (struct perl_memory_debug_header *)ptr;
113 PoisonNew(((char *)ptr), size, char);
116 #ifdef PERL_TRACK_MEMPOOL
117 header->interpreter = aTHX;
118 /* Link us into the list. */
119 header->prev = &PL_memory_debug_header;
120 header->next = PL_memory_debug_header.next;
121 PL_memory_debug_header.next = header;
122 header->next->prev = header;
126 ptr = (Malloc_t)((char*)ptr+sTHX);
128 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
132 #ifndef ALWAYS_NEED_THX
138 return write_no_mem();
144 /* paranoid version of system's realloc() */
147 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
149 #ifdef ALWAYS_NEED_THX
153 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
154 Malloc_t PerlMem_realloc();
155 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
159 PerlIO_printf(Perl_error_log,
160 "Reallocation too large: %lx\n", size) FLUSH;
163 #endif /* HAS_64K_LIMIT */
170 return safesysmalloc(size);
171 #ifdef PERL_TRACK_MEMPOOL
172 where = (Malloc_t)((char*)where-sTHX);
175 struct perl_memory_debug_header *const header
176 = (struct perl_memory_debug_header *)where;
178 if (header->interpreter != aTHX) {
179 Perl_croak_nocontext("panic: realloc from wrong pool");
181 assert(header->next->prev == header);
182 assert(header->prev->next == header);
184 if (header->size > size) {
185 const MEM_SIZE freed_up = header->size - size;
186 char *start_of_freed = ((char *)where) + size;
187 PoisonFree(start_of_freed, freed_up, char);
195 Perl_croak_nocontext("panic: realloc");
197 ptr = (Malloc_t)PerlMem_realloc(where,size);
198 PERL_ALLOC_CHECK(ptr);
200 /* MUST do this fixup first, before doing ANYTHING else, as anything else
201 might allocate memory/free/move memory, and until we do the fixup, it
202 may well be chasing (and writing to) free memory. */
203 #ifdef PERL_TRACK_MEMPOOL
205 struct perl_memory_debug_header *const header
206 = (struct perl_memory_debug_header *)ptr;
209 if (header->size < size) {
210 const MEM_SIZE fresh = size - header->size;
211 char *start_of_fresh = ((char *)ptr) + size;
212 PoisonNew(start_of_fresh, fresh, char);
216 header->next->prev = header;
217 header->prev->next = header;
219 ptr = (Malloc_t)((char*)ptr+sTHX);
223 /* In particular, must do that fixup above before logging anything via
224 *printf(), as it can reallocate memory, which can cause SEGVs. */
226 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
227 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
234 #ifndef ALWAYS_NEED_THX
240 return write_no_mem();
246 /* safe version of system's free() */
249 Perl_safesysfree(Malloc_t where)
251 #ifdef ALWAYS_NEED_THX
256 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
258 #ifdef PERL_TRACK_MEMPOOL
259 where = (Malloc_t)((char*)where-sTHX);
261 struct perl_memory_debug_header *const header
262 = (struct perl_memory_debug_header *)where;
264 if (header->interpreter != aTHX) {
265 Perl_croak_nocontext("panic: free from wrong pool");
268 Perl_croak_nocontext("panic: duplicate free");
270 if (!(header->next) || header->next->prev != header
271 || header->prev->next != header) {
272 Perl_croak_nocontext("panic: bad free");
274 /* Unlink us from the chain. */
275 header->next->prev = header->prev;
276 header->prev->next = header->next;
278 PoisonNew(where, header->size, char);
280 /* Trigger the duplicate free warning. */
288 /* safe version of system's calloc() */
291 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
293 #ifdef ALWAYS_NEED_THX
297 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
298 MEM_SIZE total_size = 0;
301 /* Even though calloc() for zero bytes is strange, be robust. */
302 if (size && (count <= MEM_SIZE_MAX / size)) {
303 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
304 total_size = size * count;
308 Perl_croak_nocontext("%s", PL_memory_wrap);
309 #ifdef PERL_TRACK_MEMPOOL
310 if (sTHX <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
313 Perl_croak_nocontext("%s", PL_memory_wrap);
316 if (total_size > 0xffff) {
317 PerlIO_printf(Perl_error_log,
318 "Allocation too large: %lx\n", total_size) FLUSH;
321 #endif /* HAS_64K_LIMIT */
323 if ((long)size < 0 || (long)count < 0)
324 Perl_croak_nocontext("panic: calloc");
326 #ifdef PERL_TRACK_MEMPOOL
327 /* Have to use malloc() because we've added some space for our tracking
329 /* malloc(0) is non-portable. */
330 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
332 /* Use calloc() because it might save a memset() if the memory is fresh
333 and clean from the OS. */
335 ptr = (Malloc_t)PerlMem_calloc(count, size);
336 else /* calloc(0) is non-portable. */
337 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
339 PERL_ALLOC_CHECK(ptr);
340 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));
342 #ifdef PERL_TRACK_MEMPOOL
344 struct perl_memory_debug_header *const header
345 = (struct perl_memory_debug_header *)ptr;
347 memset((void*)ptr, 0, total_size);
348 header->interpreter = aTHX;
349 /* Link us into the list. */
350 header->prev = &PL_memory_debug_header;
351 header->next = PL_memory_debug_header.next;
352 PL_memory_debug_header.next = header;
353 header->next->prev = header;
355 header->size = total_size;
357 ptr = (Malloc_t)((char*)ptr+sTHX);
363 #ifndef ALWAYS_NEED_THX
368 return write_no_mem();
372 /* These must be defined when not using Perl's malloc for binary
377 Malloc_t Perl_malloc (MEM_SIZE nbytes)
380 return (Malloc_t)PerlMem_malloc(nbytes);
383 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
386 return (Malloc_t)PerlMem_calloc(elements, size);
389 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
392 return (Malloc_t)PerlMem_realloc(where, nbytes);
395 Free_t Perl_mfree (Malloc_t where)
403 /* copy a string up to some (non-backslashed) delimiter, if any */
406 Perl_delimcpy(register char *to, register const char *toend, register const char *from, register const char *fromend, register int delim, I32 *retlen)
410 PERL_ARGS_ASSERT_DELIMCPY;
412 for (tolen = 0; from < fromend; from++, tolen++) {
414 if (from[1] != delim) {
421 else if (*from == delim)
432 /* return ptr to little string in big string, NULL if not found */
433 /* This routine was donated by Corey Satten. */
436 Perl_instr(register const char *big, register const char *little)
440 PERL_ARGS_ASSERT_INSTR;
448 register const char *s, *x;
451 for (x=big,s=little; *s; /**/ ) {
462 return (char*)(big-1);
467 /* same as instr but allow embedded nulls */
470 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
472 PERL_ARGS_ASSERT_NINSTR;
476 const char first = *little;
478 bigend -= lend - little++;
480 while (big <= bigend) {
481 if (*big++ == first) {
482 for (x=big,s=little; s < lend; x++,s++) {
486 return (char*)(big-1);
493 /* reverse of the above--find last substring */
496 Perl_rninstr(register const char *big, const char *bigend, const char *little, const char *lend)
498 register const char *bigbeg;
499 register const I32 first = *little;
500 register const char * const littleend = lend;
502 PERL_ARGS_ASSERT_RNINSTR;
504 if (little >= littleend)
505 return (char*)bigend;
507 big = bigend - (littleend - little++);
508 while (big >= bigbeg) {
509 register const char *s, *x;
512 for (x=big+2,s=little; s < littleend; /**/ ) {
521 return (char*)(big+1);
526 /* As a space optimization, we do not compile tables for strings of length
527 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
528 special-cased in fbm_instr().
530 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
533 =head1 Miscellaneous Functions
535 =for apidoc fbm_compile
537 Analyses the string in order to make fast searches on it using fbm_instr()
538 -- the Boyer-Moore algorithm.
544 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
547 register const U8 *s;
553 PERL_ARGS_ASSERT_FBM_COMPILE;
555 if (flags & FBMcf_TAIL) {
556 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
557 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
558 if (mg && mg->mg_len >= 0)
561 s = (U8*)SvPV_force_mutable(sv, len);
562 if (len == 0) /* TAIL might be on a zero-length string. */
564 SvUPGRADE(sv, SVt_PVGV);
569 const unsigned char *sb;
570 const U8 mlen = (len>255) ? 255 : (U8)len;
573 Sv_Grow(sv, len + 256 + PERL_FBM_TABLE_OFFSET);
575 = (unsigned char*)(SvPVX_mutable(sv) + len + PERL_FBM_TABLE_OFFSET);
576 s = table - 1 - PERL_FBM_TABLE_OFFSET; /* last char */
577 memset((void*)table, mlen, 256);
579 sb = s - mlen + 1; /* first char (maybe) */
581 if (table[*s] == mlen)
586 Sv_Grow(sv, len + PERL_FBM_TABLE_OFFSET);
588 sv_magic(sv, NULL, PERL_MAGIC_bm, NULL, 0); /* deep magic */
590 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
591 for (i = 0; i < len; i++) {
592 if (PL_freq[s[i]] < frequency) {
594 frequency = PL_freq[s[i]];
597 BmFLAGS(sv) = (U8)flags;
598 BmRARE(sv) = s[rarest];
599 BmPREVIOUS(sv) = rarest;
600 BmUSEFUL(sv) = 100; /* Initial value */
601 if (flags & FBMcf_TAIL)
603 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %lu\n",
604 BmRARE(sv),(unsigned long)BmPREVIOUS(sv)));
607 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
608 /* If SvTAIL is actually due to \Z or \z, this gives false positives
612 =for apidoc fbm_instr
614 Returns the location of the SV in the string delimited by C<str> and
615 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
616 does not have to be fbm_compiled, but the search will not be as fast
623 Perl_fbm_instr(pTHX_ unsigned char *big, register unsigned char *bigend, SV *littlestr, U32 flags)
625 register unsigned char *s;
627 register const unsigned char *little
628 = (const unsigned char *)SvPV_const(littlestr,l);
629 register STRLEN littlelen = l;
630 register const I32 multiline = flags & FBMrf_MULTILINE;
632 PERL_ARGS_ASSERT_FBM_INSTR;
634 if ((STRLEN)(bigend - big) < littlelen) {
635 if ( SvTAIL(littlestr)
636 && ((STRLEN)(bigend - big) == littlelen - 1)
638 || (*big == *little &&
639 memEQ((char *)big, (char *)little, littlelen - 1))))
644 if (littlelen <= 2) { /* Special-cased */
646 if (littlelen == 1) {
647 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
648 /* Know that bigend != big. */
649 if (bigend[-1] == '\n')
650 return (char *)(bigend - 1);
651 return (char *) bigend;
659 if (SvTAIL(littlestr))
660 return (char *) bigend;
664 return (char*)big; /* Cannot be SvTAIL! */
667 if (SvTAIL(littlestr) && !multiline) {
668 if (bigend[-1] == '\n' && bigend[-2] == *little)
669 return (char*)bigend - 2;
670 if (bigend[-1] == *little)
671 return (char*)bigend - 1;
675 /* This should be better than FBM if c1 == c2, and almost
676 as good otherwise: maybe better since we do less indirection.
677 And we save a lot of memory by caching no table. */
678 const unsigned char c1 = little[0];
679 const unsigned char c2 = little[1];
684 while (s <= bigend) {
694 goto check_1char_anchor;
705 goto check_1char_anchor;
708 while (s <= bigend) {
713 goto check_1char_anchor;
722 check_1char_anchor: /* One char and anchor! */
723 if (SvTAIL(littlestr) && (*bigend == *little))
724 return (char *)bigend; /* bigend is already decremented. */
727 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
728 s = bigend - littlelen;
729 if (s >= big && bigend[-1] == '\n' && *s == *little
730 /* Automatically of length > 2 */
731 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
733 return (char*)s; /* how sweet it is */
736 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
738 return (char*)s + 1; /* how sweet it is */
742 if (!SvVALID(littlestr)) {
743 char * const b = ninstr((char*)big,(char*)bigend,
744 (char*)little, (char*)little + littlelen);
746 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
747 /* Chop \n from littlestr: */
748 s = bigend - littlelen + 1;
750 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
760 if (littlelen > (STRLEN)(bigend - big))
764 register const unsigned char * const table
765 = little + littlelen + PERL_FBM_TABLE_OFFSET;
766 register const unsigned char *oldlittle;
768 --littlelen; /* Last char found by table lookup */
771 little += littlelen; /* last char */
777 if ((tmp = table[*s])) {
778 if ((s += tmp) < bigend)
782 else { /* less expensive than calling strncmp() */
783 register unsigned char * const olds = s;
788 if (*--s == *--little)
790 s = olds + 1; /* here we pay the price for failure */
792 if (s < bigend) /* fake up continue to outer loop */
801 && (BmFLAGS(littlestr) & FBMcf_TAIL)
802 && memEQ((char *)(bigend - littlelen),
803 (char *)(oldlittle - littlelen), littlelen) )
804 return (char*)bigend - littlelen;
809 /* start_shift, end_shift are positive quantities which give offsets
810 of ends of some substring of bigstr.
811 If "last" we want the last occurrence.
812 old_posp is the way of communication between consequent calls if
813 the next call needs to find the .
814 The initial *old_posp should be -1.
816 Note that we take into account SvTAIL, so one can get extra
817 optimizations if _ALL flag is set.
820 /* If SvTAIL is actually due to \Z or \z, this gives false positives
821 if PL_multiline. In fact if !PL_multiline the authoritative answer
822 is not supported yet. */
825 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
828 register const unsigned char *big;
830 register I32 previous;
832 register const unsigned char *little;
833 register I32 stop_pos;
834 register const unsigned char *littleend;
837 PERL_ARGS_ASSERT_SCREAMINSTR;
839 assert(SvTYPE(littlestr) == SVt_PVGV);
840 assert(SvVALID(littlestr));
843 ? (pos = PL_screamfirst[BmRARE(littlestr)]) < 0
844 : (((pos = *old_posp), pos += PL_screamnext[pos]) == 0)) {
846 if ( BmRARE(littlestr) == '\n'
847 && BmPREVIOUS(littlestr) == SvCUR(littlestr) - 1) {
848 little = (const unsigned char *)(SvPVX_const(littlestr));
849 littleend = little + SvCUR(littlestr);
856 little = (const unsigned char *)(SvPVX_const(littlestr));
857 littleend = little + SvCUR(littlestr);
859 /* The value of pos we can start at: */
860 previous = BmPREVIOUS(littlestr);
861 big = (const unsigned char *)(SvPVX_const(bigstr));
862 /* The value of pos we can stop at: */
863 stop_pos = SvCUR(bigstr) - end_shift - (SvCUR(littlestr) - 1 - previous);
864 if (previous + start_shift > stop_pos) {
866 stop_pos does not include SvTAIL in the count, so this check is incorrect
867 (I think) - see [ID 20010618.006] and t/op/study.t. HVDS 2001/06/19
870 if (previous + start_shift == stop_pos + 1) /* A fake '\n'? */
875 while (pos < previous + start_shift) {
876 if (!(pos += PL_screamnext[pos]))
881 register const unsigned char *s, *x;
882 if (pos >= stop_pos) break;
883 if (big[pos] != first)
885 for (x=big+pos+1,s=little; s < littleend; /**/ ) {
891 if (s == littleend) {
893 if (!last) return (char *)(big+pos);
896 } while ( pos += PL_screamnext[pos] );
898 return (char *)(big+(*old_posp));
900 if (!SvTAIL(littlestr) || (end_shift > 0))
902 /* Ignore the trailing "\n". This code is not microoptimized */
903 big = (const unsigned char *)(SvPVX_const(bigstr) + SvCUR(bigstr));
904 stop_pos = littleend - little; /* Actual littlestr len */
909 && ((stop_pos == 1) ||
910 memEQ((char *)(big + 1), (char *)little, stop_pos - 1)))
918 Returns true if the leading len bytes of the strings s1 and s2 are the same
919 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
920 match themselves and their opposite case counterparts. Non-cased and non-ASCII
921 range bytes match only themselves.
928 Perl_foldEQ(const char *s1, const char *s2, register I32 len)
930 register const U8 *a = (const U8 *)s1;
931 register const U8 *b = (const U8 *)s2;
933 PERL_ARGS_ASSERT_FOLDEQ;
936 if (*a != *b && *a != PL_fold[*b])
943 Perl_foldEQ_latin1(const char *s1, const char *s2, register I32 len)
945 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
946 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
947 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
948 * does it check that the strings each have at least 'len' characters */
950 register const U8 *a = (const U8 *)s1;
951 register const U8 *b = (const U8 *)s2;
953 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
956 if (*a != *b && *a != PL_fold_latin1[*b]) {
965 =for apidoc foldEQ_locale
967 Returns true if the leading len bytes of the strings s1 and s2 are the same
968 case-insensitively in the current locale; false otherwise.
974 Perl_foldEQ_locale(const char *s1, const char *s2, register I32 len)
977 register const U8 *a = (const U8 *)s1;
978 register const U8 *b = (const U8 *)s2;
980 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
983 if (*a != *b && *a != PL_fold_locale[*b])
990 /* copy a string to a safe spot */
993 =head1 Memory Management
997 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
998 string which is a duplicate of C<pv>. The size of the string is
999 determined by C<strlen()>. The memory allocated for the new string can
1000 be freed with the C<Safefree()> function.
1006 Perl_savepv(pTHX_ const char *pv)
1008 PERL_UNUSED_CONTEXT;
1013 const STRLEN pvlen = strlen(pv)+1;
1014 Newx(newaddr, pvlen, char);
1015 return (char*)memcpy(newaddr, pv, pvlen);
1019 /* same thing but with a known length */
1024 Perl's version of what C<strndup()> would be if it existed. Returns a
1025 pointer to a newly allocated string which is a duplicate of the first
1026 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
1027 the new string can be freed with the C<Safefree()> function.
1033 Perl_savepvn(pTHX_ const char *pv, register I32 len)
1035 register char *newaddr;
1036 PERL_UNUSED_CONTEXT;
1038 Newx(newaddr,len+1,char);
1039 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1041 /* might not be null terminated */
1042 newaddr[len] = '\0';
1043 return (char *) CopyD(pv,newaddr,len,char);
1046 return (char *) ZeroD(newaddr,len+1,char);
1051 =for apidoc savesharedpv
1053 A version of C<savepv()> which allocates the duplicate string in memory
1054 which is shared between threads.
1059 Perl_savesharedpv(pTHX_ const char *pv)
1061 register char *newaddr;
1066 pvlen = strlen(pv)+1;
1067 newaddr = (char*)PerlMemShared_malloc(pvlen);
1069 return write_no_mem();
1071 return (char*)memcpy(newaddr, pv, pvlen);
1075 =for apidoc savesharedpvn
1077 A version of C<savepvn()> which allocates the duplicate string in memory
1078 which is shared between threads. (With the specific difference that a NULL
1079 pointer is not acceptable)
1084 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1086 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1088 PERL_ARGS_ASSERT_SAVESHAREDPVN;
1091 return write_no_mem();
1093 newaddr[len] = '\0';
1094 return (char*)memcpy(newaddr, pv, len);
1098 =for apidoc savesvpv
1100 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1101 the passed in SV using C<SvPV()>
1107 Perl_savesvpv(pTHX_ SV *sv)
1110 const char * const pv = SvPV_const(sv, len);
1111 register char *newaddr;
1113 PERL_ARGS_ASSERT_SAVESVPV;
1116 Newx(newaddr,len,char);
1117 return (char *) CopyD(pv,newaddr,len,char);
1121 =for apidoc savesharedsvpv
1123 A version of C<savesharedpv()> which allocates the duplicate string in
1124 memory which is shared between threads.
1130 Perl_savesharedsvpv(pTHX_ SV *sv)
1133 const char * const pv = SvPV_const(sv, len);
1135 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1137 return savesharedpvn(pv, len);
1140 /* the SV for Perl_form() and mess() is not kept in an arena */
1149 if (PL_phase != PERL_PHASE_DESTRUCT)
1150 return newSVpvs_flags("", SVs_TEMP);
1155 /* Create as PVMG now, to avoid any upgrading later */
1157 Newxz(any, 1, XPVMG);
1158 SvFLAGS(sv) = SVt_PVMG;
1159 SvANY(sv) = (void*)any;
1161 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1166 #if defined(PERL_IMPLICIT_CONTEXT)
1168 Perl_form_nocontext(const char* pat, ...)
1173 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1174 va_start(args, pat);
1175 retval = vform(pat, &args);
1179 #endif /* PERL_IMPLICIT_CONTEXT */
1182 =head1 Miscellaneous Functions
1185 Takes a sprintf-style format pattern and conventional
1186 (non-SV) arguments and returns the formatted string.
1188 (char *) Perl_form(pTHX_ const char* pat, ...)
1190 can be used any place a string (char *) is required:
1192 char * s = Perl_form("%d.%d",major,minor);
1194 Uses a single private buffer so if you want to format several strings you
1195 must explicitly copy the earlier strings away (and free the copies when you
1202 Perl_form(pTHX_ const char* pat, ...)
1206 PERL_ARGS_ASSERT_FORM;
1207 va_start(args, pat);
1208 retval = vform(pat, &args);
1214 Perl_vform(pTHX_ const char *pat, va_list *args)
1216 SV * const sv = mess_alloc();
1217 PERL_ARGS_ASSERT_VFORM;
1218 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1223 =for apidoc Am|SV *|mess|const char *pat|...
1225 Take a sprintf-style format pattern and argument list. These are used to
1226 generate a string message. If the message does not end with a newline,
1227 then it will be extended with some indication of the current location
1228 in the code, as described for L</mess_sv>.
1230 Normally, the resulting message is returned in a new mortal SV.
1231 During global destruction a single SV may be shared between uses of
1237 #if defined(PERL_IMPLICIT_CONTEXT)
1239 Perl_mess_nocontext(const char *pat, ...)
1244 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1245 va_start(args, pat);
1246 retval = vmess(pat, &args);
1250 #endif /* PERL_IMPLICIT_CONTEXT */
1253 Perl_mess(pTHX_ const char *pat, ...)
1257 PERL_ARGS_ASSERT_MESS;
1258 va_start(args, pat);
1259 retval = vmess(pat, &args);
1265 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1268 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1270 PERL_ARGS_ASSERT_CLOSEST_COP;
1272 if (!o || o == PL_op)
1275 if (o->op_flags & OPf_KIDS) {
1277 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1280 /* If the OP_NEXTSTATE has been optimised away we can still use it
1281 * the get the file and line number. */
1283 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1284 cop = (const COP *)kid;
1286 /* Keep searching, and return when we've found something. */
1288 new_cop = closest_cop(cop, kid);
1294 /* Nothing found. */
1300 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1302 Expands a message, intended for the user, to include an indication of
1303 the current location in the code, if the message does not already appear
1306 C<basemsg> is the initial message or object. If it is a reference, it
1307 will be used as-is and will be the result of this function. Otherwise it
1308 is used as a string, and if it already ends with a newline, it is taken
1309 to be complete, and the result of this function will be the same string.
1310 If the message does not end with a newline, then a segment such as C<at
1311 foo.pl line 37> will be appended, and possibly other clauses indicating
1312 the current state of execution. The resulting message will end with a
1315 Normally, the resulting message is returned in a new mortal SV.
1316 During global destruction a single SV may be shared between uses of this
1317 function. If C<consume> is true, then the function is permitted (but not
1318 required) to modify and return C<basemsg> instead of allocating a new SV.
1324 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1329 PERL_ARGS_ASSERT_MESS_SV;
1331 if (SvROK(basemsg)) {
1337 sv_setsv(sv, basemsg);
1342 if (SvPOK(basemsg) && consume) {
1347 sv_copypv(sv, basemsg);
1350 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1352 * Try and find the file and line for PL_op. This will usually be
1353 * PL_curcop, but it might be a cop that has been optimised away. We
1354 * can try to find such a cop by searching through the optree starting
1355 * from the sibling of PL_curcop.
1358 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1363 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1364 OutCopFILE(cop), (IV)CopLINE(cop));
1365 /* Seems that GvIO() can be untrustworthy during global destruction. */
1366 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1367 && IoLINES(GvIOp(PL_last_in_gv)))
1369 const bool line_mode = (RsSIMPLE(PL_rs) &&
1370 SvCUR(PL_rs) == 1 && *SvPVX_const(PL_rs) == '\n');
1371 Perl_sv_catpvf(aTHX_ sv, ", <%s> %s %"IVdf,
1372 PL_last_in_gv == PL_argvgv ? "" : GvNAME(PL_last_in_gv),
1373 line_mode ? "line" : "chunk",
1374 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1376 if (PL_phase == PERL_PHASE_DESTRUCT)
1377 sv_catpvs(sv, " during global destruction");
1378 sv_catpvs(sv, ".\n");
1384 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1386 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1387 argument list. These are used to generate a string message. If the
1388 message does not end with a newline, then it will be extended with
1389 some indication of the current location in the code, as described for
1392 Normally, the resulting message is returned in a new mortal SV.
1393 During global destruction a single SV may be shared between uses of
1400 Perl_vmess(pTHX_ const char *pat, va_list *args)
1403 SV * const sv = mess_alloc();
1405 PERL_ARGS_ASSERT_VMESS;
1407 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1408 return mess_sv(sv, 1);
1412 Perl_write_to_stderr(pTHX_ SV* msv)
1418 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1420 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1421 && (io = GvIO(PL_stderrgv))
1422 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1423 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, "PRINT",
1424 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1427 /* SFIO can really mess with your errno */
1430 PerlIO * const serr = Perl_error_log;
1432 do_print(msv, serr);
1433 (void)PerlIO_flush(serr);
1441 =head1 Warning and Dieing
1444 /* Common code used in dieing and warning */
1447 S_with_queued_errors(pTHX_ SV *ex)
1449 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1450 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1451 sv_catsv(PL_errors, ex);
1452 ex = sv_mortalcopy(PL_errors);
1453 SvCUR_set(PL_errors, 0);
1459 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1465 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1466 /* sv_2cv might call Perl_croak() or Perl_warner() */
1467 SV * const oldhook = *hook;
1475 cv = sv_2cv(oldhook, &stash, &gv, 0);
1477 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1487 exarg = newSVsv(ex);
1488 SvREADONLY_on(exarg);
1491 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1495 call_sv(MUTABLE_SV(cv), G_DISCARD);
1504 =for apidoc Am|OP *|die_sv|SV *baseex
1506 Behaves the same as L</croak_sv>, except for the return type.
1507 It should be used only where the C<OP *> return type is required.
1508 The function never actually returns.
1514 Perl_die_sv(pTHX_ SV *baseex)
1516 PERL_ARGS_ASSERT_DIE_SV;
1523 =for apidoc Am|OP *|die|const char *pat|...
1525 Behaves the same as L</croak>, except for the return type.
1526 It should be used only where the C<OP *> return type is required.
1527 The function never actually returns.
1532 #if defined(PERL_IMPLICIT_CONTEXT)
1534 Perl_die_nocontext(const char* pat, ...)
1538 va_start(args, pat);
1544 #endif /* PERL_IMPLICIT_CONTEXT */
1547 Perl_die(pTHX_ const char* pat, ...)
1550 va_start(args, pat);
1558 =for apidoc Am|void|croak_sv|SV *baseex
1560 This is an XS interface to Perl's C<die> function.
1562 C<baseex> is the error message or object. If it is a reference, it
1563 will be used as-is. Otherwise it is used as a string, and if it does
1564 not end with a newline then it will be extended with some indication of
1565 the current location in the code, as described for L</mess_sv>.
1567 The error message or object will be used as an exception, by default
1568 returning control to the nearest enclosing C<eval>, but subject to
1569 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1570 function never returns normally.
1572 To die with a simple string message, the L</croak> function may be
1579 Perl_croak_sv(pTHX_ SV *baseex)
1581 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1582 PERL_ARGS_ASSERT_CROAK_SV;
1583 invoke_exception_hook(ex, FALSE);
1588 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1590 This is an XS interface to Perl's C<die> function.
1592 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1593 argument list. These are used to generate a string message. If the
1594 message does not end with a newline, then it will be extended with
1595 some indication of the current location in the code, as described for
1598 The error message will be used as an exception, by default
1599 returning control to the nearest enclosing C<eval>, but subject to
1600 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1601 function never returns normally.
1603 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1604 (C<$@>) will be used as an error message or object instead of building an
1605 error message from arguments. If you want to throw a non-string object,
1606 or build an error message in an SV yourself, it is preferable to use
1607 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1613 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1615 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1616 invoke_exception_hook(ex, FALSE);
1621 =for apidoc Am|void|croak|const char *pat|...
1623 This is an XS interface to Perl's C<die> function.
1625 Take a sprintf-style format pattern and argument list. These are used to
1626 generate a string message. If the message does not end with a newline,
1627 then it will be extended with some indication of the current location
1628 in the code, as described for L</mess_sv>.
1630 The error message will be used as an exception, by default
1631 returning control to the nearest enclosing C<eval>, but subject to
1632 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1633 function never returns normally.
1635 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1636 (C<$@>) will be used as an error message or object instead of building an
1637 error message from arguments. If you want to throw a non-string object,
1638 or build an error message in an SV yourself, it is preferable to use
1639 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1644 #if defined(PERL_IMPLICIT_CONTEXT)
1646 Perl_croak_nocontext(const char *pat, ...)
1650 va_start(args, pat);
1655 #endif /* PERL_IMPLICIT_CONTEXT */
1658 Perl_croak(pTHX_ const char *pat, ...)
1661 va_start(args, pat);
1668 =for apidoc Am|void|croak_no_modify
1670 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1671 terser object code than using C<Perl_croak>. Less code used on exception code
1672 paths reduces CPU cache pressure.
1678 Perl_croak_no_modify(pTHX)
1680 Perl_croak(aTHX_ "%s", PL_no_modify);
1684 =for apidoc Am|void|warn_sv|SV *baseex
1686 This is an XS interface to Perl's C<warn> function.
1688 C<baseex> is the error message or object. If it is a reference, it
1689 will be used as-is. Otherwise it is used as a string, and if it does
1690 not end with a newline then it will be extended with some indication of
1691 the current location in the code, as described for L</mess_sv>.
1693 The error message or object will by default be written to standard error,
1694 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1696 To warn with a simple string message, the L</warn> function may be
1703 Perl_warn_sv(pTHX_ SV *baseex)
1705 SV *ex = mess_sv(baseex, 0);
1706 PERL_ARGS_ASSERT_WARN_SV;
1707 if (!invoke_exception_hook(ex, TRUE))
1708 write_to_stderr(ex);
1712 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1714 This is an XS interface to Perl's C<warn> function.
1716 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1717 argument list. These are used to generate a string message. If the
1718 message does not end with a newline, then it will be extended with
1719 some indication of the current location in the code, as described for
1722 The error message or object will by default be written to standard error,
1723 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1725 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1731 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1733 SV *ex = vmess(pat, args);
1734 PERL_ARGS_ASSERT_VWARN;
1735 if (!invoke_exception_hook(ex, TRUE))
1736 write_to_stderr(ex);
1740 =for apidoc Am|void|warn|const char *pat|...
1742 This is an XS interface to Perl's C<warn> function.
1744 Take a sprintf-style format pattern and argument list. These are used to
1745 generate a string message. If the message does not end with a newline,
1746 then it will be extended with some indication of the current location
1747 in the code, as described for L</mess_sv>.
1749 The error message or object will by default be written to standard error,
1750 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1752 Unlike with L</croak>, C<pat> is not permitted to be null.
1757 #if defined(PERL_IMPLICIT_CONTEXT)
1759 Perl_warn_nocontext(const char *pat, ...)
1763 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1764 va_start(args, pat);
1768 #endif /* PERL_IMPLICIT_CONTEXT */
1771 Perl_warn(pTHX_ const char *pat, ...)
1774 PERL_ARGS_ASSERT_WARN;
1775 va_start(args, pat);
1780 #if defined(PERL_IMPLICIT_CONTEXT)
1782 Perl_warner_nocontext(U32 err, const char *pat, ...)
1786 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1787 va_start(args, pat);
1788 vwarner(err, pat, &args);
1791 #endif /* PERL_IMPLICIT_CONTEXT */
1794 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1796 PERL_ARGS_ASSERT_CK_WARNER_D;
1798 if (Perl_ckwarn_d(aTHX_ err)) {
1800 va_start(args, pat);
1801 vwarner(err, pat, &args);
1807 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1809 PERL_ARGS_ASSERT_CK_WARNER;
1811 if (Perl_ckwarn(aTHX_ err)) {
1813 va_start(args, pat);
1814 vwarner(err, pat, &args);
1820 Perl_warner(pTHX_ U32 err, const char* pat,...)
1823 PERL_ARGS_ASSERT_WARNER;
1824 va_start(args, pat);
1825 vwarner(err, pat, &args);
1830 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1833 PERL_ARGS_ASSERT_VWARNER;
1834 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1835 SV * const msv = vmess(pat, args);
1837 invoke_exception_hook(msv, FALSE);
1841 Perl_vwarn(aTHX_ pat, args);
1845 /* implements the ckWARN? macros */
1848 Perl_ckwarn(pTHX_ U32 w)
1851 /* If lexical warnings have not been set, use $^W. */
1853 return PL_dowarn & G_WARN_ON;
1855 return ckwarn_common(w);
1858 /* implements the ckWARN?_d macro */
1861 Perl_ckwarn_d(pTHX_ U32 w)
1864 /* If lexical warnings have not been set then default classes warn. */
1868 return ckwarn_common(w);
1872 S_ckwarn_common(pTHX_ U32 w)
1874 if (PL_curcop->cop_warnings == pWARN_ALL)
1877 if (PL_curcop->cop_warnings == pWARN_NONE)
1880 /* Check the assumption that at least the first slot is non-zero. */
1881 assert(unpackWARN1(w));
1883 /* Check the assumption that it is valid to stop as soon as a zero slot is
1885 if (!unpackWARN2(w)) {
1886 assert(!unpackWARN3(w));
1887 assert(!unpackWARN4(w));
1888 } else if (!unpackWARN3(w)) {
1889 assert(!unpackWARN4(w));
1892 /* Right, dealt with all the special cases, which are implemented as non-
1893 pointers, so there is a pointer to a real warnings mask. */
1895 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1897 } while (w >>= WARNshift);
1902 /* Set buffer=NULL to get a new one. */
1904 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1906 const MEM_SIZE len_wanted = sizeof(STRLEN) + size;
1907 PERL_UNUSED_CONTEXT;
1908 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1911 (specialWARN(buffer) ?
1912 PerlMemShared_malloc(len_wanted) :
1913 PerlMemShared_realloc(buffer, len_wanted));
1915 Copy(bits, (buffer + 1), size, char);
1919 /* since we've already done strlen() for both nam and val
1920 * we can use that info to make things faster than
1921 * sprintf(s, "%s=%s", nam, val)
1923 #define my_setenv_format(s, nam, nlen, val, vlen) \
1924 Copy(nam, s, nlen, char); \
1926 Copy(val, s+(nlen+1), vlen, char); \
1927 *(s+(nlen+1+vlen)) = '\0'
1929 #ifdef USE_ENVIRON_ARRAY
1930 /* VMS' my_setenv() is in vms.c */
1931 #if !defined(WIN32) && !defined(NETWARE)
1933 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1937 /* only parent thread can modify process environment */
1938 if (PL_curinterp == aTHX)
1941 #ifndef PERL_USE_SAFE_PUTENV
1942 if (!PL_use_safe_putenv) {
1943 /* most putenv()s leak, so we manipulate environ directly */
1945 register const I32 len = strlen(nam);
1948 /* where does it go? */
1949 for (i = 0; environ[i]; i++) {
1950 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1954 if (environ == PL_origenviron) { /* need we copy environment? */
1960 while (environ[max])
1962 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1963 for (j=0; j<max; j++) { /* copy environment */
1964 const int len = strlen(environ[j]);
1965 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1966 Copy(environ[j], tmpenv[j], len+1, char);
1969 environ = tmpenv; /* tell exec where it is now */
1972 safesysfree(environ[i]);
1973 while (environ[i]) {
1974 environ[i] = environ[i+1];
1979 if (!environ[i]) { /* does not exist yet */
1980 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1981 environ[i+1] = NULL; /* make sure it's null terminated */
1984 safesysfree(environ[i]);
1988 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1989 /* all that work just for this */
1990 my_setenv_format(environ[i], nam, nlen, val, vlen);
1993 # if defined(__CYGWIN__) || defined(EPOC) || defined(__SYMBIAN32__) || defined(__riscos__)
1994 # if defined(HAS_UNSETENV)
1996 (void)unsetenv(nam);
1998 (void)setenv(nam, val, 1);
2000 # else /* ! HAS_UNSETENV */
2001 (void)setenv(nam, val, 1);
2002 # endif /* HAS_UNSETENV */
2004 # if defined(HAS_UNSETENV)
2006 (void)unsetenv(nam);
2008 const int nlen = strlen(nam);
2009 const int vlen = strlen(val);
2010 char * const new_env =
2011 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2012 my_setenv_format(new_env, nam, nlen, val, vlen);
2013 (void)putenv(new_env);
2015 # else /* ! HAS_UNSETENV */
2017 const int nlen = strlen(nam);
2023 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2024 /* all that work just for this */
2025 my_setenv_format(new_env, nam, nlen, val, vlen);
2026 (void)putenv(new_env);
2027 # endif /* HAS_UNSETENV */
2028 # endif /* __CYGWIN__ */
2029 #ifndef PERL_USE_SAFE_PUTENV
2035 #else /* WIN32 || NETWARE */
2038 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2041 register char *envstr;
2042 const int nlen = strlen(nam);
2049 Newx(envstr, nlen+vlen+2, char);
2050 my_setenv_format(envstr, nam, nlen, val, vlen);
2051 (void)PerlEnv_putenv(envstr);
2055 #endif /* WIN32 || NETWARE */
2057 #endif /* !VMS && !EPOC*/
2059 #ifdef UNLINK_ALL_VERSIONS
2061 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2065 PERL_ARGS_ASSERT_UNLNK;
2067 while (PerlLIO_unlink(f) >= 0)
2069 return retries ? 0 : -1;
2073 /* this is a drop-in replacement for bcopy() */
2074 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2076 Perl_my_bcopy(register const char *from,register char *to,register I32 len)
2078 char * const retval = to;
2080 PERL_ARGS_ASSERT_MY_BCOPY;
2082 if (from - to >= 0) {
2090 *(--to) = *(--from);
2096 /* this is a drop-in replacement for memset() */
2099 Perl_my_memset(register char *loc, register I32 ch, register I32 len)
2101 char * const retval = loc;
2103 PERL_ARGS_ASSERT_MY_MEMSET;
2111 /* this is a drop-in replacement for bzero() */
2112 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2114 Perl_my_bzero(register char *loc, register I32 len)
2116 char * const retval = loc;
2118 PERL_ARGS_ASSERT_MY_BZERO;
2126 /* this is a drop-in replacement for memcmp() */
2127 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2129 Perl_my_memcmp(const char *s1, const char *s2, register I32 len)
2131 register const U8 *a = (const U8 *)s1;
2132 register const U8 *b = (const U8 *)s2;
2135 PERL_ARGS_ASSERT_MY_MEMCMP;
2138 if ((tmp = *a++ - *b++))
2143 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2146 /* This vsprintf replacement should generally never get used, since
2147 vsprintf was available in both System V and BSD 2.11. (There may
2148 be some cross-compilation or embedded set-ups where it is needed,
2151 If you encounter a problem in this function, it's probably a symptom
2152 that Configure failed to detect your system's vprintf() function.
2153 See the section on "item vsprintf" in the INSTALL file.
2155 This version may compile on systems with BSD-ish <stdio.h>,
2156 but probably won't on others.
2159 #ifdef USE_CHAR_VSPRINTF
2164 vsprintf(char *dest, const char *pat, void *args)
2168 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2169 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2170 FILE_cnt(&fakebuf) = 32767;
2172 /* These probably won't compile -- If you really need
2173 this, you'll have to figure out some other method. */
2174 fakebuf._ptr = dest;
2175 fakebuf._cnt = 32767;
2180 fakebuf._flag = _IOWRT|_IOSTRG;
2181 _doprnt(pat, args, &fakebuf); /* what a kludge */
2182 #if defined(STDIO_PTR_LVALUE)
2183 *(FILE_ptr(&fakebuf)++) = '\0';
2185 /* PerlIO has probably #defined away fputc, but we want it here. */
2187 # undef fputc /* XXX Should really restore it later */
2189 (void)fputc('\0', &fakebuf);
2191 #ifdef USE_CHAR_VSPRINTF
2194 return 0; /* perl doesn't use return value */
2198 #endif /* HAS_VPRINTF */
2201 #if BYTEORDER != 0x4321
2203 Perl_my_swap(pTHX_ short s)
2205 #if (BYTEORDER & 1) == 0
2208 result = ((s & 255) << 8) + ((s >> 8) & 255);
2216 Perl_my_htonl(pTHX_ long l)
2220 char c[sizeof(long)];
2223 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
2224 #if BYTEORDER == 0x12345678
2227 u.c[0] = (l >> 24) & 255;
2228 u.c[1] = (l >> 16) & 255;
2229 u.c[2] = (l >> 8) & 255;
2233 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2234 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2239 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2240 u.c[o & 0xf] = (l >> s) & 255;
2248 Perl_my_ntohl(pTHX_ long l)
2252 char c[sizeof(long)];
2255 #if BYTEORDER == 0x1234
2256 u.c[0] = (l >> 24) & 255;
2257 u.c[1] = (l >> 16) & 255;
2258 u.c[2] = (l >> 8) & 255;
2262 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2263 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2270 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2271 l |= (u.c[o & 0xf] & 255) << s;
2278 #endif /* BYTEORDER != 0x4321 */
2282 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2283 * If these functions are defined,
2284 * the BYTEORDER is neither 0x1234 nor 0x4321.
2285 * However, this is not assumed.
2289 #define HTOLE(name,type) \
2291 name (register type n) \
2295 char c[sizeof(type)]; \
2298 register U32 s = 0; \
2299 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2300 u.c[i] = (n >> s) & 0xFF; \
2305 #define LETOH(name,type) \
2307 name (register type n) \
2311 char c[sizeof(type)]; \
2314 register U32 s = 0; \
2317 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2318 n |= ((type)(u.c[i] & 0xFF)) << s; \
2324 * Big-endian byte order functions.
2327 #define HTOBE(name,type) \
2329 name (register type n) \
2333 char c[sizeof(type)]; \
2336 register U32 s = 8*(sizeof(u.c)-1); \
2337 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2338 u.c[i] = (n >> s) & 0xFF; \
2343 #define BETOH(name,type) \
2345 name (register type n) \
2349 char c[sizeof(type)]; \
2352 register U32 s = 8*(sizeof(u.c)-1); \
2355 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2356 n |= ((type)(u.c[i] & 0xFF)) << s; \
2362 * If we just can't do it...
2365 #define NOT_AVAIL(name,type) \
2367 name (register type n) \
2369 Perl_croak_nocontext(#name "() not available"); \
2370 return n; /* not reached */ \
2374 #if defined(HAS_HTOVS) && !defined(htovs)
2377 #if defined(HAS_HTOVL) && !defined(htovl)
2380 #if defined(HAS_VTOHS) && !defined(vtohs)
2383 #if defined(HAS_VTOHL) && !defined(vtohl)
2387 #ifdef PERL_NEED_MY_HTOLE16
2389 HTOLE(Perl_my_htole16,U16)
2391 NOT_AVAIL(Perl_my_htole16,U16)
2394 #ifdef PERL_NEED_MY_LETOH16
2396 LETOH(Perl_my_letoh16,U16)
2398 NOT_AVAIL(Perl_my_letoh16,U16)
2401 #ifdef PERL_NEED_MY_HTOBE16
2403 HTOBE(Perl_my_htobe16,U16)
2405 NOT_AVAIL(Perl_my_htobe16,U16)
2408 #ifdef PERL_NEED_MY_BETOH16
2410 BETOH(Perl_my_betoh16,U16)
2412 NOT_AVAIL(Perl_my_betoh16,U16)
2416 #ifdef PERL_NEED_MY_HTOLE32
2418 HTOLE(Perl_my_htole32,U32)
2420 NOT_AVAIL(Perl_my_htole32,U32)
2423 #ifdef PERL_NEED_MY_LETOH32
2425 LETOH(Perl_my_letoh32,U32)
2427 NOT_AVAIL(Perl_my_letoh32,U32)
2430 #ifdef PERL_NEED_MY_HTOBE32
2432 HTOBE(Perl_my_htobe32,U32)
2434 NOT_AVAIL(Perl_my_htobe32,U32)
2437 #ifdef PERL_NEED_MY_BETOH32
2439 BETOH(Perl_my_betoh32,U32)
2441 NOT_AVAIL(Perl_my_betoh32,U32)
2445 #ifdef PERL_NEED_MY_HTOLE64
2447 HTOLE(Perl_my_htole64,U64)
2449 NOT_AVAIL(Perl_my_htole64,U64)
2452 #ifdef PERL_NEED_MY_LETOH64
2454 LETOH(Perl_my_letoh64,U64)
2456 NOT_AVAIL(Perl_my_letoh64,U64)
2459 #ifdef PERL_NEED_MY_HTOBE64
2461 HTOBE(Perl_my_htobe64,U64)
2463 NOT_AVAIL(Perl_my_htobe64,U64)
2466 #ifdef PERL_NEED_MY_BETOH64
2468 BETOH(Perl_my_betoh64,U64)
2470 NOT_AVAIL(Perl_my_betoh64,U64)
2474 #ifdef PERL_NEED_MY_HTOLES
2475 HTOLE(Perl_my_htoles,short)
2477 #ifdef PERL_NEED_MY_LETOHS
2478 LETOH(Perl_my_letohs,short)
2480 #ifdef PERL_NEED_MY_HTOBES
2481 HTOBE(Perl_my_htobes,short)
2483 #ifdef PERL_NEED_MY_BETOHS
2484 BETOH(Perl_my_betohs,short)
2487 #ifdef PERL_NEED_MY_HTOLEI
2488 HTOLE(Perl_my_htolei,int)
2490 #ifdef PERL_NEED_MY_LETOHI
2491 LETOH(Perl_my_letohi,int)
2493 #ifdef PERL_NEED_MY_HTOBEI
2494 HTOBE(Perl_my_htobei,int)
2496 #ifdef PERL_NEED_MY_BETOHI
2497 BETOH(Perl_my_betohi,int)
2500 #ifdef PERL_NEED_MY_HTOLEL
2501 HTOLE(Perl_my_htolel,long)
2503 #ifdef PERL_NEED_MY_LETOHL
2504 LETOH(Perl_my_letohl,long)
2506 #ifdef PERL_NEED_MY_HTOBEL
2507 HTOBE(Perl_my_htobel,long)
2509 #ifdef PERL_NEED_MY_BETOHL
2510 BETOH(Perl_my_betohl,long)
2514 Perl_my_swabn(void *ptr, int n)
2516 register char *s = (char *)ptr;
2517 register char *e = s + (n-1);
2520 PERL_ARGS_ASSERT_MY_SWABN;
2522 for (n /= 2; n > 0; s++, e--, n--) {
2530 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2532 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2535 register I32 This, that;
2541 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2543 PERL_FLUSHALL_FOR_CHILD;
2544 This = (*mode == 'w');
2548 taint_proper("Insecure %s%s", "EXEC");
2550 if (PerlProc_pipe(p) < 0)
2552 /* Try for another pipe pair for error return */
2553 if (PerlProc_pipe(pp) >= 0)
2555 while ((pid = PerlProc_fork()) < 0) {
2556 if (errno != EAGAIN) {
2557 PerlLIO_close(p[This]);
2558 PerlLIO_close(p[that]);
2560 PerlLIO_close(pp[0]);
2561 PerlLIO_close(pp[1]);
2565 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2574 /* Close parent's end of error status pipe (if any) */
2576 PerlLIO_close(pp[0]);
2577 #if defined(HAS_FCNTL) && defined(F_SETFD)
2578 /* Close error pipe automatically if exec works */
2579 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2582 /* Now dup our end of _the_ pipe to right position */
2583 if (p[THIS] != (*mode == 'r')) {
2584 PerlLIO_dup2(p[THIS], *mode == 'r');
2585 PerlLIO_close(p[THIS]);
2586 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2587 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2590 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2591 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2592 /* No automatic close - do it by hand */
2599 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2605 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2611 do_execfree(); /* free any memory malloced by child on fork */
2613 PerlLIO_close(pp[1]);
2614 /* Keep the lower of the two fd numbers */
2615 if (p[that] < p[This]) {
2616 PerlLIO_dup2(p[This], p[that]);
2617 PerlLIO_close(p[This]);
2621 PerlLIO_close(p[that]); /* close child's end of pipe */
2623 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2624 SvUPGRADE(sv,SVt_IV);
2626 PL_forkprocess = pid;
2627 /* If we managed to get status pipe check for exec fail */
2628 if (did_pipes && pid > 0) {
2633 while (n < sizeof(int)) {
2634 n1 = PerlLIO_read(pp[0],
2635 (void*)(((char*)&errkid)+n),
2641 PerlLIO_close(pp[0]);
2643 if (n) { /* Error */
2645 PerlLIO_close(p[This]);
2646 if (n != sizeof(int))
2647 Perl_croak(aTHX_ "panic: kid popen errno read");
2649 pid2 = wait4pid(pid, &status, 0);
2650 } while (pid2 == -1 && errno == EINTR);
2651 errno = errkid; /* Propagate errno from kid */
2656 PerlLIO_close(pp[0]);
2657 return PerlIO_fdopen(p[This], mode);
2659 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2660 return my_syspopen4(aTHX_ NULL, mode, n, args);
2662 Perl_croak(aTHX_ "List form of piped open not implemented");
2663 return (PerlIO *) NULL;
2668 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2669 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
2671 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2675 register I32 This, that;
2678 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2682 PERL_ARGS_ASSERT_MY_POPEN;
2684 PERL_FLUSHALL_FOR_CHILD;
2687 return my_syspopen(aTHX_ cmd,mode);
2690 This = (*mode == 'w');
2692 if (doexec && PL_tainting) {
2694 taint_proper("Insecure %s%s", "EXEC");
2696 if (PerlProc_pipe(p) < 0)
2698 if (doexec && PerlProc_pipe(pp) >= 0)
2700 while ((pid = PerlProc_fork()) < 0) {
2701 if (errno != EAGAIN) {
2702 PerlLIO_close(p[This]);
2703 PerlLIO_close(p[that]);
2705 PerlLIO_close(pp[0]);
2706 PerlLIO_close(pp[1]);
2709 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2712 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2722 PerlLIO_close(pp[0]);
2723 #if defined(HAS_FCNTL) && defined(F_SETFD)
2724 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2727 if (p[THIS] != (*mode == 'r')) {
2728 PerlLIO_dup2(p[THIS], *mode == 'r');
2729 PerlLIO_close(p[THIS]);
2730 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2731 PerlLIO_close(p[THAT]);
2734 PerlLIO_close(p[THAT]);
2737 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2744 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2749 /* may or may not use the shell */
2750 do_exec3(cmd, pp[1], did_pipes);
2753 #endif /* defined OS2 */
2755 #ifdef PERLIO_USING_CRLF
2756 /* Since we circumvent IO layers when we manipulate low-level
2757 filedescriptors directly, need to manually switch to the
2758 default, binary, low-level mode; see PerlIOBuf_open(). */
2759 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2761 #ifdef THREADS_HAVE_PIDS
2762 PL_ppid = (IV)getppid();
2765 #ifdef PERL_USES_PL_PIDSTATUS
2766 hv_clear(PL_pidstatus); /* we have no children */
2772 do_execfree(); /* free any memory malloced by child on vfork */
2774 PerlLIO_close(pp[1]);
2775 if (p[that] < p[This]) {
2776 PerlLIO_dup2(p[This], p[that]);
2777 PerlLIO_close(p[This]);
2781 PerlLIO_close(p[that]);
2783 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2784 SvUPGRADE(sv,SVt_IV);
2786 PL_forkprocess = pid;
2787 if (did_pipes && pid > 0) {
2792 while (n < sizeof(int)) {
2793 n1 = PerlLIO_read(pp[0],
2794 (void*)(((char*)&errkid)+n),
2800 PerlLIO_close(pp[0]);
2802 if (n) { /* Error */
2804 PerlLIO_close(p[This]);
2805 if (n != sizeof(int))
2806 Perl_croak(aTHX_ "panic: kid popen errno read");
2808 pid2 = wait4pid(pid, &status, 0);
2809 } while (pid2 == -1 && errno == EINTR);
2810 errno = errkid; /* Propagate errno from kid */
2815 PerlLIO_close(pp[0]);
2816 return PerlIO_fdopen(p[This], mode);
2819 #if defined(atarist) || defined(EPOC)
2822 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2824 PERL_ARGS_ASSERT_MY_POPEN;
2825 PERL_FLUSHALL_FOR_CHILD;
2826 /* Call system's popen() to get a FILE *, then import it.
2827 used 0 for 2nd parameter to PerlIO_importFILE;
2830 return PerlIO_importFILE(popen(cmd, mode), 0);
2834 FILE *djgpp_popen();
2836 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2838 PERL_FLUSHALL_FOR_CHILD;
2839 /* Call system's popen() to get a FILE *, then import it.
2840 used 0 for 2nd parameter to PerlIO_importFILE;
2843 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2846 #if defined(__LIBCATAMOUNT__)
2848 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2856 #endif /* !DOSISH */
2858 /* this is called in parent before the fork() */
2860 Perl_atfork_lock(void)
2863 #if defined(USE_ITHREADS)
2864 /* locks must be held in locking order (if any) */
2866 MUTEX_LOCK(&PL_malloc_mutex);
2872 /* this is called in both parent and child after the fork() */
2874 Perl_atfork_unlock(void)
2877 #if defined(USE_ITHREADS)
2878 /* locks must be released in same order as in atfork_lock() */
2880 MUTEX_UNLOCK(&PL_malloc_mutex);
2889 #if defined(HAS_FORK)
2891 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2896 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2897 * handlers elsewhere in the code */
2902 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2903 Perl_croak_nocontext("fork() not available");
2905 #endif /* HAS_FORK */
2910 Perl_dump_fds(pTHX_ const char *const s)
2915 PERL_ARGS_ASSERT_DUMP_FDS;
2917 PerlIO_printf(Perl_debug_log,"%s", s);
2918 for (fd = 0; fd < 32; fd++) {
2919 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2920 PerlIO_printf(Perl_debug_log," %d",fd);
2922 PerlIO_printf(Perl_debug_log,"\n");
2925 #endif /* DUMP_FDS */
2929 dup2(int oldfd, int newfd)
2931 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2934 PerlLIO_close(newfd);
2935 return fcntl(oldfd, F_DUPFD, newfd);
2937 #define DUP2_MAX_FDS 256
2938 int fdtmp[DUP2_MAX_FDS];
2944 PerlLIO_close(newfd);
2945 /* good enough for low fd's... */
2946 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2947 if (fdx >= DUP2_MAX_FDS) {
2955 PerlLIO_close(fdtmp[--fdx]);
2962 #ifdef HAS_SIGACTION
2965 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2968 struct sigaction act, oact;
2971 /* only "parent" interpreter can diddle signals */
2972 if (PL_curinterp != aTHX)
2973 return (Sighandler_t) SIG_ERR;
2976 act.sa_handler = (void(*)(int))handler;
2977 sigemptyset(&act.sa_mask);
2980 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2981 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2983 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2984 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2985 act.sa_flags |= SA_NOCLDWAIT;
2987 if (sigaction(signo, &act, &oact) == -1)
2988 return (Sighandler_t) SIG_ERR;
2990 return (Sighandler_t) oact.sa_handler;
2994 Perl_rsignal_state(pTHX_ int signo)
2996 struct sigaction oact;
2997 PERL_UNUSED_CONTEXT;
2999 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
3000 return (Sighandler_t) SIG_ERR;
3002 return (Sighandler_t) oact.sa_handler;
3006 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3009 struct sigaction act;
3011 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
3014 /* only "parent" interpreter can diddle signals */
3015 if (PL_curinterp != aTHX)
3019 act.sa_handler = (void(*)(int))handler;
3020 sigemptyset(&act.sa_mask);
3023 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3024 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3026 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3027 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3028 act.sa_flags |= SA_NOCLDWAIT;
3030 return sigaction(signo, &act, save);
3034 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3038 /* only "parent" interpreter can diddle signals */
3039 if (PL_curinterp != aTHX)
3043 return sigaction(signo, save, (struct sigaction *)NULL);
3046 #else /* !HAS_SIGACTION */
3049 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3051 #if defined(USE_ITHREADS) && !defined(WIN32)
3052 /* only "parent" interpreter can diddle signals */
3053 if (PL_curinterp != aTHX)
3054 return (Sighandler_t) SIG_ERR;
3057 return PerlProc_signal(signo, handler);
3068 Perl_rsignal_state(pTHX_ int signo)
3071 Sighandler_t oldsig;
3073 #if defined(USE_ITHREADS) && !defined(WIN32)
3074 /* only "parent" interpreter can diddle signals */
3075 if (PL_curinterp != aTHX)
3076 return (Sighandler_t) SIG_ERR;
3080 oldsig = PerlProc_signal(signo, sig_trap);
3081 PerlProc_signal(signo, oldsig);
3083 PerlProc_kill(PerlProc_getpid(), signo);
3088 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3090 #if defined(USE_ITHREADS) && !defined(WIN32)
3091 /* only "parent" interpreter can diddle signals */
3092 if (PL_curinterp != aTHX)
3095 *save = PerlProc_signal(signo, handler);
3096 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3100 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3102 #if defined(USE_ITHREADS) && !defined(WIN32)
3103 /* only "parent" interpreter can diddle signals */
3104 if (PL_curinterp != aTHX)
3107 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3110 #endif /* !HAS_SIGACTION */
3111 #endif /* !PERL_MICRO */
3113 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3114 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
3116 Perl_my_pclose(pTHX_ PerlIO *ptr)
3119 Sigsave_t hstat, istat, qstat;
3126 const int fd = PerlIO_fileno(ptr);
3129 /* Find out whether the refcount is low enough for us to wait for the
3130 child proc without blocking. */
3131 const bool should_wait = PerlIOUnix_refcnt(fd) == 1;
3133 const bool should_wait = 1;
3136 svp = av_fetch(PL_fdpid,fd,TRUE);
3137 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3139 *svp = &PL_sv_undef;
3141 if (pid == -1) { /* Opened by popen. */
3142 return my_syspclose(ptr);
3145 close_failed = (PerlIO_close(ptr) == EOF);
3148 if(PerlProc_kill(pid, 0) < 0) { return(pid); } /* HOM 12/23/91 */
3151 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3152 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3153 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3155 if (should_wait) do {
3156 pid2 = wait4pid(pid, &status, 0);
3157 } while (pid2 == -1 && errno == EINTR);
3159 rsignal_restore(SIGHUP, &hstat);
3160 rsignal_restore(SIGINT, &istat);
3161 rsignal_restore(SIGQUIT, &qstat);
3169 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3174 #if defined(__LIBCATAMOUNT__)
3176 Perl_my_pclose(pTHX_ PerlIO *ptr)
3181 #endif /* !DOSISH */
3183 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3185 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3189 PERL_ARGS_ASSERT_WAIT4PID;
3192 #ifdef PERL_USES_PL_PIDSTATUS
3195 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3196 pid, rather than a string form. */
3197 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3198 if (svp && *svp != &PL_sv_undef) {
3199 *statusp = SvIVX(*svp);
3200 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3208 hv_iterinit(PL_pidstatus);
3209 if ((entry = hv_iternext(PL_pidstatus))) {
3210 SV * const sv = hv_iterval(PL_pidstatus,entry);
3212 const char * const spid = hv_iterkey(entry,&len);
3214 assert (len == sizeof(Pid_t));
3215 memcpy((char *)&pid, spid, len);
3216 *statusp = SvIVX(sv);
3217 /* The hash iterator is currently on this entry, so simply
3218 calling hv_delete would trigger the lazy delete, which on
3219 aggregate does more work, beacuse next call to hv_iterinit()
3220 would spot the flag, and have to call the delete routine,
3221 while in the meantime any new entries can't re-use that
3223 hv_iterinit(PL_pidstatus);
3224 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3231 # ifdef HAS_WAITPID_RUNTIME
3232 if (!HAS_WAITPID_RUNTIME)
3235 result = PerlProc_waitpid(pid,statusp,flags);
3238 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3239 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3242 #ifdef PERL_USES_PL_PIDSTATUS
3243 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3248 Perl_croak(aTHX_ "Can't do waitpid with flags");
3250 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3251 pidgone(result,*statusp);
3257 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3260 if (result < 0 && errno == EINTR) {
3262 errno = EINTR; /* reset in case a signal handler changed $! */
3266 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3268 #ifdef PERL_USES_PL_PIDSTATUS
3270 S_pidgone(pTHX_ Pid_t pid, int status)
3274 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3275 SvUPGRADE(sv,SVt_IV);
3276 SvIV_set(sv, status);
3281 #if defined(atarist) || defined(OS2) || defined(EPOC)
3284 int /* Cannot prototype with I32
3286 my_syspclose(PerlIO *ptr)
3289 Perl_my_pclose(pTHX_ PerlIO *ptr)
3292 /* Needs work for PerlIO ! */
3293 FILE * const f = PerlIO_findFILE(ptr);
3294 const I32 result = pclose(f);
3295 PerlIO_releaseFILE(ptr,f);
3303 Perl_my_pclose(pTHX_ PerlIO *ptr)
3305 /* Needs work for PerlIO ! */
3306 FILE * const f = PerlIO_findFILE(ptr);
3307 I32 result = djgpp_pclose(f);
3308 result = (result << 8) & 0xff00;
3309 PerlIO_releaseFILE(ptr,f);
3314 #define PERL_REPEATCPY_LINEAR 4
3316 Perl_repeatcpy(register char *to, register const char *from, I32 len, register I32 count)
3318 PERL_ARGS_ASSERT_REPEATCPY;
3321 memset(to, *from, count);
3323 register char *p = to;
3324 I32 items, linear, half;
3326 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3327 for (items = 0; items < linear; ++items) {
3328 register const char *q = from;
3330 for (todo = len; todo > 0; todo--)
3335 while (items <= half) {
3336 I32 size = items * len;
3337 memcpy(p, to, size);
3343 memcpy(p, to, (count - items) * len);
3349 Perl_same_dirent(pTHX_ const char *a, const char *b)
3351 char *fa = strrchr(a,'/');
3352 char *fb = strrchr(b,'/');
3355 SV * const tmpsv = sv_newmortal();
3357 PERL_ARGS_ASSERT_SAME_DIRENT;
3370 sv_setpvs(tmpsv, ".");
3372 sv_setpvn(tmpsv, a, fa - a);
3373 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3376 sv_setpvs(tmpsv, ".");
3378 sv_setpvn(tmpsv, b, fb - b);
3379 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3381 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3382 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3384 #endif /* !HAS_RENAME */
3387 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3388 const char *const *const search_ext, I32 flags)
3391 const char *xfound = NULL;
3392 char *xfailed = NULL;
3393 char tmpbuf[MAXPATHLEN];
3398 #if defined(DOSISH) && !defined(OS2) && !defined(atarist)
3399 # define SEARCH_EXTS ".bat", ".cmd", NULL
3400 # define MAX_EXT_LEN 4
3403 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3404 # define MAX_EXT_LEN 4
3407 # define SEARCH_EXTS ".pl", ".com", NULL
3408 # define MAX_EXT_LEN 4
3410 /* additional extensions to try in each dir if scriptname not found */
3412 static const char *const exts[] = { SEARCH_EXTS };
3413 const char *const *const ext = search_ext ? search_ext : exts;
3414 int extidx = 0, i = 0;
3415 const char *curext = NULL;
3417 PERL_UNUSED_ARG(search_ext);
3418 # define MAX_EXT_LEN 0
3421 PERL_ARGS_ASSERT_FIND_SCRIPT;
3424 * If dosearch is true and if scriptname does not contain path
3425 * delimiters, search the PATH for scriptname.
3427 * If SEARCH_EXTS is also defined, will look for each
3428 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3429 * while searching the PATH.
3431 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3432 * proceeds as follows:
3433 * If DOSISH or VMSISH:
3434 * + look for ./scriptname{,.foo,.bar}
3435 * + search the PATH for scriptname{,.foo,.bar}
3438 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3439 * this will not look in '.' if it's not in the PATH)
3444 # ifdef ALWAYS_DEFTYPES
3445 len = strlen(scriptname);
3446 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3447 int idx = 0, deftypes = 1;
3450 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3453 int idx = 0, deftypes = 1;
3456 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3458 /* The first time through, just add SEARCH_EXTS to whatever we
3459 * already have, so we can check for default file types. */
3461 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3467 if ((strlen(tmpbuf) + strlen(scriptname)
3468 + MAX_EXT_LEN) >= sizeof tmpbuf)
3469 continue; /* don't search dir with too-long name */
3470 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3474 if (strEQ(scriptname, "-"))
3476 if (dosearch) { /* Look in '.' first. */
3477 const char *cur = scriptname;
3479 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3481 if (strEQ(ext[i++],curext)) {
3482 extidx = -1; /* already has an ext */
3487 DEBUG_p(PerlIO_printf(Perl_debug_log,
3488 "Looking for %s\n",cur));
3489 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3490 && !S_ISDIR(PL_statbuf.st_mode)) {
3498 if (cur == scriptname) {
3499 len = strlen(scriptname);
3500 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3502 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3505 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3506 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3511 if (dosearch && !strchr(scriptname, '/')
3513 && !strchr(scriptname, '\\')
3515 && (s = PerlEnv_getenv("PATH")))
3519 bufend = s + strlen(s);
3520 while (s < bufend) {
3521 #if defined(atarist) || defined(DOSISH)
3526 && *s != ';'; len++, s++) {
3527 if (len < sizeof tmpbuf)
3530 if (len < sizeof tmpbuf)
3532 #else /* ! (atarist || DOSISH) */
3533 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3536 #endif /* ! (atarist || DOSISH) */
3539 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3540 continue; /* don't search dir with too-long name */
3542 # if defined(atarist) || defined(DOSISH)
3543 && tmpbuf[len - 1] != '/'
3544 && tmpbuf[len - 1] != '\\'
3547 tmpbuf[len++] = '/';
3548 if (len == 2 && tmpbuf[0] == '.')
3550 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3554 len = strlen(tmpbuf);
3555 if (extidx > 0) /* reset after previous loop */
3559 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3560 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3561 if (S_ISDIR(PL_statbuf.st_mode)) {
3565 } while ( retval < 0 /* not there */
3566 && extidx>=0 && ext[extidx] /* try an extension? */
3567 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3572 if (S_ISREG(PL_statbuf.st_mode)
3573 && cando(S_IRUSR,TRUE,&PL_statbuf)
3574 #if !defined(DOSISH)
3575 && cando(S_IXUSR,TRUE,&PL_statbuf)
3579 xfound = tmpbuf; /* bingo! */
3583 xfailed = savepv(tmpbuf);
3586 if (!xfound && !seen_dot && !xfailed &&
3587 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3588 || S_ISDIR(PL_statbuf.st_mode)))
3590 seen_dot = 1; /* Disable message. */
3592 if (flags & 1) { /* do or die? */
3593 Perl_croak(aTHX_ "Can't %s %s%s%s",
3594 (xfailed ? "execute" : "find"),
3595 (xfailed ? xfailed : scriptname),
3596 (xfailed ? "" : " on PATH"),
3597 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3602 scriptname = xfound;
3604 return (scriptname ? savepv(scriptname) : NULL);
3607 #ifndef PERL_GET_CONTEXT_DEFINED
3610 Perl_get_context(void)
3613 #if defined(USE_ITHREADS)
3614 # ifdef OLD_PTHREADS_API
3616 if (pthread_getspecific(PL_thr_key, &t))
3617 Perl_croak_nocontext("panic: pthread_getspecific");
3620 # ifdef I_MACH_CTHREADS
3621 return (void*)cthread_data(cthread_self());
3623 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3632 Perl_set_context(void *t)
3635 PERL_ARGS_ASSERT_SET_CONTEXT;
3636 #if defined(USE_ITHREADS)
3637 # ifdef I_MACH_CTHREADS
3638 cthread_set_data(cthread_self(), t);
3640 if (pthread_setspecific(PL_thr_key, t))
3641 Perl_croak_nocontext("panic: pthread_setspecific");
3648 #endif /* !PERL_GET_CONTEXT_DEFINED */
3650 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3659 Perl_get_op_names(pTHX)
3661 PERL_UNUSED_CONTEXT;
3662 return (char **)PL_op_name;
3666 Perl_get_op_descs(pTHX)
3668 PERL_UNUSED_CONTEXT;
3669 return (char **)PL_op_desc;
3673 Perl_get_no_modify(pTHX)
3675 PERL_UNUSED_CONTEXT;
3676 return PL_no_modify;
3680 Perl_get_opargs(pTHX)
3682 PERL_UNUSED_CONTEXT;
3683 return (U32 *)PL_opargs;
3687 Perl_get_ppaddr(pTHX)
3690 PERL_UNUSED_CONTEXT;
3691 return (PPADDR_t*)PL_ppaddr;
3694 #ifndef HAS_GETENV_LEN
3696 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3698 char * const env_trans = PerlEnv_getenv(env_elem);
3699 PERL_UNUSED_CONTEXT;
3700 PERL_ARGS_ASSERT_GETENV_LEN;
3702 *len = strlen(env_trans);
3709 Perl_get_vtbl(pTHX_ int vtbl_id)
3711 const MGVTBL* result;
3712 PERL_UNUSED_CONTEXT;
3716 result = &PL_vtbl_sv;
3719 result = &PL_vtbl_env;
3721 case want_vtbl_envelem:
3722 result = &PL_vtbl_envelem;
3725 result = &PL_vtbl_sig;
3727 case want_vtbl_sigelem:
3728 result = &PL_vtbl_sigelem;
3730 case want_vtbl_pack:
3731 result = &PL_vtbl_pack;
3733 case want_vtbl_packelem:
3734 result = &PL_vtbl_packelem;
3736 case want_vtbl_dbline:
3737 result = &PL_vtbl_dbline;
3740 result = &PL_vtbl_isa;
3742 case want_vtbl_isaelem:
3743 result = &PL_vtbl_isaelem;
3745 case want_vtbl_arylen:
3746 result = &PL_vtbl_arylen;
3748 case want_vtbl_mglob:
3749 result = &PL_vtbl_mglob;
3751 case want_vtbl_nkeys:
3752 result = &PL_vtbl_nkeys;
3754 case want_vtbl_taint:
3755 result = &PL_vtbl_taint;
3757 case want_vtbl_substr:
3758 result = &PL_vtbl_substr;
3761 result = &PL_vtbl_vec;
3764 result = &PL_vtbl_pos;
3767 result = &PL_vtbl_bm;
3770 result = &PL_vtbl_fm;
3772 case want_vtbl_uvar:
3773 result = &PL_vtbl_uvar;
3775 case want_vtbl_defelem:
3776 result = &PL_vtbl_defelem;
3778 case want_vtbl_regexp:
3779 result = &PL_vtbl_regexp;
3781 case want_vtbl_regdata:
3782 result = &PL_vtbl_regdata;
3784 case want_vtbl_regdatum:
3785 result = &PL_vtbl_regdatum;
3787 #ifdef USE_LOCALE_COLLATE
3788 case want_vtbl_collxfrm:
3789 result = &PL_vtbl_collxfrm;
3792 case want_vtbl_amagic:
3793 result = &PL_vtbl_amagic;
3795 case want_vtbl_amagicelem:
3796 result = &PL_vtbl_amagicelem;
3798 case want_vtbl_backref:
3799 result = &PL_vtbl_backref;
3801 case want_vtbl_utf8:
3802 result = &PL_vtbl_utf8;
3808 return (MGVTBL*)result;
3812 Perl_my_fflush_all(pTHX)
3814 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3815 return PerlIO_flush(NULL);
3817 # if defined(HAS__FWALK)
3818 extern int fflush(FILE *);
3819 /* undocumented, unprototyped, but very useful BSDism */
3820 extern void _fwalk(int (*)(FILE *));
3824 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3826 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3827 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3829 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3830 open_max = sysconf(_SC_OPEN_MAX);
3833 open_max = FOPEN_MAX;
3836 open_max = OPEN_MAX;
3847 for (i = 0; i < open_max; i++)
3848 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3849 STDIO_STREAM_ARRAY[i]._file < open_max &&
3850 STDIO_STREAM_ARRAY[i]._flag)
3851 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3855 SETERRNO(EBADF,RMS_IFI);
3862 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3864 if (ckWARN(WARN_IO)) {
3865 const char * const name
3866 = gv && (isGV(gv) || isGV_with_GP(gv)) ? GvENAME(gv) : NULL;
3867 const char * const direction = have == '>' ? "out" : "in";
3870 Perl_warner(aTHX_ packWARN(WARN_IO),
3871 "Filehandle %s opened only for %sput",
3874 Perl_warner(aTHX_ packWARN(WARN_IO),
3875 "Filehandle opened only for %sput", direction);
3880 Perl_report_evil_fh(pTHX_ const GV *gv)
3882 const IO *io = gv ? GvIO(gv) : NULL;
3883 const PERL_BITFIELD16 op = PL_op->op_type;
3887 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3889 warn_type = WARN_CLOSED;
3893 warn_type = WARN_UNOPENED;
3896 if (ckWARN(warn_type)) {
3897 const char * const name
3898 = gv && (isGV(gv) || isGV_with_GP(gv)) ? GvENAME(gv) : NULL;
3899 const char * const pars =
3900 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3901 const char * const func =
3903 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3904 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3906 const char * const type =
3908 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3909 ? "socket" : "filehandle");
3910 if (name && *name) {
3911 Perl_warner(aTHX_ packWARN(warn_type),
3912 "%s%s on %s %s %s", func, pars, vile, type, name);
3913 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3915 aTHX_ packWARN(warn_type),
3916 "\t(Are you trying to call %s%s on dirhandle %s?)\n",
3921 Perl_warner(aTHX_ packWARN(warn_type),
3922 "%s%s on %s %s", func, pars, vile, type);
3923 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3925 aTHX_ packWARN(warn_type),
3926 "\t(Are you trying to call %s%s on dirhandle?)\n",
3933 /* To workaround core dumps from the uninitialised tm_zone we get the
3934 * system to give us a reasonable struct to copy. This fix means that
3935 * strftime uses the tm_zone and tm_gmtoff values returned by
3936 * localtime(time()). That should give the desired result most of the
3937 * time. But probably not always!
3939 * This does not address tzname aspects of NETaa14816.
3944 # ifndef STRUCT_TM_HASZONE
3945 # define STRUCT_TM_HASZONE
3949 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3950 # ifndef HAS_TM_TM_ZONE
3951 # define HAS_TM_TM_ZONE
3956 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3958 #ifdef HAS_TM_TM_ZONE
3960 const struct tm* my_tm;
3961 PERL_ARGS_ASSERT_INIT_TM;
3963 my_tm = localtime(&now);
3965 Copy(my_tm, ptm, 1, struct tm);
3967 PERL_ARGS_ASSERT_INIT_TM;
3968 PERL_UNUSED_ARG(ptm);
3973 * mini_mktime - normalise struct tm values without the localtime()
3974 * semantics (and overhead) of mktime().
3977 Perl_mini_mktime(pTHX_ struct tm *ptm)
3981 int month, mday, year, jday;
3982 int odd_cent, odd_year;
3983 PERL_UNUSED_CONTEXT;
3985 PERL_ARGS_ASSERT_MINI_MKTIME;
3987 #define DAYS_PER_YEAR 365
3988 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3989 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3990 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3991 #define SECS_PER_HOUR (60*60)
3992 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3993 /* parentheses deliberately absent on these two, otherwise they don't work */
3994 #define MONTH_TO_DAYS 153/5
3995 #define DAYS_TO_MONTH 5/153
3996 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3997 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3998 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3999 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
4002 * Year/day algorithm notes:
4004 * With a suitable offset for numeric value of the month, one can find
4005 * an offset into the year by considering months to have 30.6 (153/5) days,
4006 * using integer arithmetic (i.e., with truncation). To avoid too much
4007 * messing about with leap days, we consider January and February to be
4008 * the 13th and 14th month of the previous year. After that transformation,
4009 * we need the month index we use to be high by 1 from 'normal human' usage,
4010 * so the month index values we use run from 4 through 15.
4012 * Given that, and the rules for the Gregorian calendar (leap years are those
4013 * divisible by 4 unless also divisible by 100, when they must be divisible
4014 * by 400 instead), we can simply calculate the number of days since some
4015 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
4016 * the days we derive from our month index, and adding in the day of the
4017 * month. The value used here is not adjusted for the actual origin which
4018 * it normally would use (1 January A.D. 1), since we're not exposing it.
4019 * We're only building the value so we can turn around and get the
4020 * normalised values for the year, month, day-of-month, and day-of-year.
4022 * For going backward, we need to bias the value we're using so that we find
4023 * the right year value. (Basically, we don't want the contribution of
4024 * March 1st to the number to apply while deriving the year). Having done
4025 * that, we 'count up' the contribution to the year number by accounting for
4026 * full quadracenturies (400-year periods) with their extra leap days, plus
4027 * the contribution from full centuries (to avoid counting in the lost leap
4028 * days), plus the contribution from full quad-years (to count in the normal
4029 * leap days), plus the leftover contribution from any non-leap years.
4030 * At this point, if we were working with an actual leap day, we'll have 0
4031 * days left over. This is also true for March 1st, however. So, we have
4032 * to special-case that result, and (earlier) keep track of the 'odd'
4033 * century and year contributions. If we got 4 extra centuries in a qcent,
4034 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
4035 * Otherwise, we add back in the earlier bias we removed (the 123 from
4036 * figuring in March 1st), find the month index (integer division by 30.6),
4037 * and the remainder is the day-of-month. We then have to convert back to
4038 * 'real' months (including fixing January and February from being 14/15 in
4039 * the previous year to being in the proper year). After that, to get
4040 * tm_yday, we work with the normalised year and get a new yearday value for
4041 * January 1st, which we subtract from the yearday value we had earlier,
4042 * representing the date we've re-built. This is done from January 1
4043 * because tm_yday is 0-origin.
4045 * Since POSIX time routines are only guaranteed to work for times since the
4046 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
4047 * applies Gregorian calendar rules even to dates before the 16th century
4048 * doesn't bother me. Besides, you'd need cultural context for a given
4049 * date to know whether it was Julian or Gregorian calendar, and that's
4050 * outside the scope for this routine. Since we convert back based on the
4051 * same rules we used to build the yearday, you'll only get strange results
4052 * for input which needed normalising, or for the 'odd' century years which
4053 * were leap years in the Julian calendar but not in the Gregorian one.
4054 * I can live with that.
4056 * This algorithm also fails to handle years before A.D. 1 gracefully, but
4057 * that's still outside the scope for POSIX time manipulation, so I don't
4061 year = 1900 + ptm->tm_year;
4062 month = ptm->tm_mon;
4063 mday = ptm->tm_mday;
4064 /* allow given yday with no month & mday to dominate the result */
4065 if (ptm->tm_yday >= 0 && mday <= 0 && month <= 0) {
4068 jday = 1 + ptm->tm_yday;
4077 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4078 yearday += month*MONTH_TO_DAYS + mday + jday;
4080 * Note that we don't know when leap-seconds were or will be,
4081 * so we have to trust the user if we get something which looks
4082 * like a sensible leap-second. Wild values for seconds will
4083 * be rationalised, however.
4085 if ((unsigned) ptm->tm_sec <= 60) {
4092 secs += 60 * ptm->tm_min;
4093 secs += SECS_PER_HOUR * ptm->tm_hour;
4095 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4096 /* got negative remainder, but need positive time */
4097 /* back off an extra day to compensate */
4098 yearday += (secs/SECS_PER_DAY)-1;
4099 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4102 yearday += (secs/SECS_PER_DAY);
4103 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4106 else if (secs >= SECS_PER_DAY) {
4107 yearday += (secs/SECS_PER_DAY);
4108 secs %= SECS_PER_DAY;
4110 ptm->tm_hour = secs/SECS_PER_HOUR;
4111 secs %= SECS_PER_HOUR;
4112 ptm->tm_min = secs/60;
4114 ptm->tm_sec += secs;
4115 /* done with time of day effects */
4117 * The algorithm for yearday has (so far) left it high by 428.
4118 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4119 * bias it by 123 while trying to figure out what year it
4120 * really represents. Even with this tweak, the reverse
4121 * translation fails for years before A.D. 0001.
4122 * It would still fail for Feb 29, but we catch that one below.
4124 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4125 yearday -= YEAR_ADJUST;
4126 year = (yearday / DAYS_PER_QCENT) * 400;
4127 yearday %= DAYS_PER_QCENT;
4128 odd_cent = yearday / DAYS_PER_CENT;
4129 year += odd_cent * 100;
4130 yearday %= DAYS_PER_CENT;
4131 year += (yearday / DAYS_PER_QYEAR) * 4;
4132 yearday %= DAYS_PER_QYEAR;
4133 odd_year = yearday / DAYS_PER_YEAR;
4135 yearday %= DAYS_PER_YEAR;
4136 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4141 yearday += YEAR_ADJUST; /* recover March 1st crock */
4142 month = yearday*DAYS_TO_MONTH;
4143 yearday -= month*MONTH_TO_DAYS;
4144 /* recover other leap-year adjustment */
4153 ptm->tm_year = year - 1900;
4155 ptm->tm_mday = yearday;
4156 ptm->tm_mon = month;
4160 ptm->tm_mon = month - 1;
4162 /* re-build yearday based on Jan 1 to get tm_yday */
4164 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4165 yearday += 14*MONTH_TO_DAYS + 1;
4166 ptm->tm_yday = jday - yearday;
4167 /* fix tm_wday if not overridden by caller */
4168 if ((unsigned)ptm->tm_wday > 6)
4169 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4173 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)
4181 PERL_ARGS_ASSERT_MY_STRFTIME;
4183 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4186 mytm.tm_hour = hour;
4187 mytm.tm_mday = mday;
4189 mytm.tm_year = year;
4190 mytm.tm_wday = wday;
4191 mytm.tm_yday = yday;
4192 mytm.tm_isdst = isdst;
4194 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4195 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4200 #ifdef HAS_TM_TM_GMTOFF
4201 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4203 #ifdef HAS_TM_TM_ZONE
4204 mytm.tm_zone = mytm2.tm_zone;
4209 Newx(buf, buflen, char);
4210 len = strftime(buf, buflen, fmt, &mytm);
4212 ** The following is needed to handle to the situation where
4213 ** tmpbuf overflows. Basically we want to allocate a buffer
4214 ** and try repeatedly. The reason why it is so complicated
4215 ** is that getting a return value of 0 from strftime can indicate
4216 ** one of the following:
4217 ** 1. buffer overflowed,
4218 ** 2. illegal conversion specifier, or
4219 ** 3. the format string specifies nothing to be returned(not
4220 ** an error). This could be because format is an empty string
4221 ** or it specifies %p that yields an empty string in some locale.
4222 ** If there is a better way to make it portable, go ahead by
4225 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4228 /* Possibly buf overflowed - try again with a bigger buf */
4229 const int fmtlen = strlen(fmt);
4230 int bufsize = fmtlen + buflen;
4232 Renew(buf, bufsize, char);
4234 buflen = strftime(buf, bufsize, fmt, &mytm);
4235 if (buflen > 0 && buflen < bufsize)
4237 /* heuristic to prevent out-of-memory errors */
4238 if (bufsize > 100*fmtlen) {
4244 Renew(buf, bufsize, char);
4249 Perl_croak(aTHX_ "panic: no strftime");
4255 #define SV_CWD_RETURN_UNDEF \
4256 sv_setsv(sv, &PL_sv_undef); \
4259 #define SV_CWD_ISDOT(dp) \
4260 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4261 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4264 =head1 Miscellaneous Functions
4266 =for apidoc getcwd_sv
4268 Fill the sv with current working directory
4273 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4274 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4275 * getcwd(3) if available
4276 * Comments from the orignal:
4277 * This is a faster version of getcwd. It's also more dangerous
4278 * because you might chdir out of a directory that you can't chdir
4282 Perl_getcwd_sv(pTHX_ register SV *sv)
4286 #ifndef INCOMPLETE_TAINTS
4290 PERL_ARGS_ASSERT_GETCWD_SV;
4294 char buf[MAXPATHLEN];
4296 /* Some getcwd()s automatically allocate a buffer of the given
4297 * size from the heap if they are given a NULL buffer pointer.
4298 * The problem is that this behaviour is not portable. */
4299 if (getcwd(buf, sizeof(buf) - 1)) {
4304 sv_setsv(sv, &PL_sv_undef);
4312 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4316 SvUPGRADE(sv, SVt_PV);
4318 if (PerlLIO_lstat(".", &statbuf) < 0) {
4319 SV_CWD_RETURN_UNDEF;
4322 orig_cdev = statbuf.st_dev;
4323 orig_cino = statbuf.st_ino;
4333 if (PerlDir_chdir("..") < 0) {
4334 SV_CWD_RETURN_UNDEF;
4336 if (PerlLIO_stat(".", &statbuf) < 0) {
4337 SV_CWD_RETURN_UNDEF;
4340 cdev = statbuf.st_dev;
4341 cino = statbuf.st_ino;
4343 if (odev == cdev && oino == cino) {
4346 if (!(dir = PerlDir_open("."))) {
4347 SV_CWD_RETURN_UNDEF;
4350 while ((dp = PerlDir_read(dir)) != NULL) {
4352 namelen = dp->d_namlen;
4354 namelen = strlen(dp->d_name);
4357 if (SV_CWD_ISDOT(dp)) {
4361 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4362 SV_CWD_RETURN_UNDEF;
4365 tdev = statbuf.st_dev;
4366 tino = statbuf.st_ino;
4367 if (tino == oino && tdev == odev) {
4373 SV_CWD_RETURN_UNDEF;
4376 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4377 SV_CWD_RETURN_UNDEF;
4380 SvGROW(sv, pathlen + namelen + 1);
4384 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4387 /* prepend current directory to the front */
4389 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4390 pathlen += (namelen + 1);
4392 #ifdef VOID_CLOSEDIR
4395 if (PerlDir_close(dir) < 0) {
4396 SV_CWD_RETURN_UNDEF;
4402 SvCUR_set(sv, pathlen);
4406 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4407 SV_CWD_RETURN_UNDEF;
4410 if (PerlLIO_stat(".", &statbuf) < 0) {
4411 SV_CWD_RETURN_UNDEF;
4414 cdev = statbuf.st_dev;
4415 cino = statbuf.st_ino;
4417 if (cdev != orig_cdev || cino != orig_cino) {
4418 Perl_croak(aTHX_ "Unstable directory path, "
4419 "current directory changed unexpectedly");
4430 #define VERSION_MAX 0x7FFFFFFF
4433 =for apidoc prescan_version
4435 Validate that a given string can be parsed as a version object, but doesn't
4436 actually perform the parsing. Can use either strict or lax validation rules.
4437 Can optionally set a number of hint variables to save the parsing code
4438 some time when tokenizing.
4443 Perl_prescan_version(pTHX_ const char *s, bool strict,
4444 const char **errstr,
4445 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4446 bool qv = (sqv ? *sqv : FALSE);
4448 int saw_decimal = 0;
4452 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4454 if (qv && isDIGIT(*d))
4455 goto dotted_decimal_version;
4457 if (*d == 'v') { /* explicit v-string */
4462 else { /* degenerate v-string */
4463 /* requires v1.2.3 */
4464 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4467 dotted_decimal_version:
4468 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4469 /* no leading zeros allowed */
4470 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4473 while (isDIGIT(*d)) /* integer part */
4479 d++; /* decimal point */
4484 /* require v1.2.3 */
4485 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4488 goto version_prescan_finish;
4495 while (isDIGIT(*d)) { /* just keep reading */
4497 while (isDIGIT(*d)) {
4499 /* maximum 3 digits between decimal */
4500 if (strict && j > 3) {
4501 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4506 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4509 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4514 else if (*d == '.') {
4516 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4521 else if (!isDIGIT(*d)) {
4527 if (strict && i < 2) {
4528 /* requires v1.2.3 */
4529 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4532 } /* end if dotted-decimal */
4534 { /* decimal versions */
4535 /* special strict case for leading '.' or '0' */
4538 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4540 if (*d == '0' && isDIGIT(d[1])) {
4541 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4545 /* consume all of the integer part */
4549 /* look for a fractional part */
4551 /* we found it, so consume it */
4555 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4558 BADVERSION(s,errstr,"Invalid version format (version required)");
4560 /* found just an integer */
4561 goto version_prescan_finish;
4563 else if ( d == s ) {
4564 /* didn't find either integer or period */
4565 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4567 else if (*d == '_') {
4568 /* underscore can't come after integer part */
4570 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4572 else if (isDIGIT(d[1])) {
4573 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4576 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4580 /* anything else after integer part is just invalid data */
4581 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4584 /* scan the fractional part after the decimal point*/
4586 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4587 /* strict or lax-but-not-the-end */
4588 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4591 while (isDIGIT(*d)) {
4593 if (*d == '.' && isDIGIT(d[-1])) {
4595 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4598 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4600 d = (char *)s; /* start all over again */
4602 goto dotted_decimal_version;
4606 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4609 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4611 if ( ! isDIGIT(d[1]) ) {
4612 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4620 version_prescan_finish:
4624 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4625 /* trailing non-numeric data */
4626 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4634 *ssaw_decimal = saw_decimal;
4641 =for apidoc scan_version
4643 Returns a pointer to the next character after the parsed
4644 version string, as well as upgrading the passed in SV to
4647 Function must be called with an already existing SV like
4650 s = scan_version(s, SV *sv, bool qv);
4652 Performs some preprocessing to the string to ensure that
4653 it has the correct characteristics of a version. Flags the
4654 object if it contains an underscore (which denotes this
4655 is an alpha version). The boolean qv denotes that the version
4656 should be interpreted as if it had multiple decimals, even if
4663 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4668 const char *errstr = NULL;
4669 int saw_decimal = 0;
4673 AV * const av = newAV();
4674 SV * const hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4676 PERL_ARGS_ASSERT_SCAN_VERSION;
4678 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4680 #ifndef NODEFAULT_SHAREKEYS
4681 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4684 while (isSPACE(*s)) /* leading whitespace is OK */
4687 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4689 /* "undef" is a special case and not an error */
4690 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4691 Perl_croak(aTHX_ "%s", errstr);
4701 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4703 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4704 if ( !qv && width < 3 )
4705 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4707 while (isDIGIT(*pos))
4709 if (!isALPHA(*pos)) {
4715 /* this is atoi() that delimits on underscores */
4716 const char *end = pos;
4720 /* the following if() will only be true after the decimal
4721 * point of a version originally created with a bare
4722 * floating point number, i.e. not quoted in any way
4724 if ( !qv && s > start && saw_decimal == 1 ) {
4728 rev += (*s - '0') * mult;
4730 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4731 || (PERL_ABS(rev) > VERSION_MAX )) {
4732 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4733 "Integer overflow in version %d",VERSION_MAX);
4744 while (--end >= s) {
4746 rev += (*end - '0') * mult;
4748 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4749 || (PERL_ABS(rev) > VERSION_MAX )) {
4750 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4751 "Integer overflow in version");
4760 /* Append revision */
4761 av_push(av, newSViv(rev));
4766 else if ( *pos == '.' )
4768 else if ( *pos == '_' && isDIGIT(pos[1]) )
4770 else if ( *pos == ',' && isDIGIT(pos[1]) )
4772 else if ( isDIGIT(*pos) )
4779 while ( isDIGIT(*pos) )
4784 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4792 if ( qv ) { /* quoted versions always get at least three terms*/
4793 I32 len = av_len(av);
4794 /* This for loop appears to trigger a compiler bug on OS X, as it
4795 loops infinitely. Yes, len is negative. No, it makes no sense.
4796 Compiler in question is:
4797 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4798 for ( len = 2 - len; len > 0; len-- )
4799 av_push(MUTABLE_AV(sv), newSViv(0));
4803 av_push(av, newSViv(0));
4806 /* need to save off the current version string for later */
4808 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4809 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4810 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4812 else if ( s > start ) {
4813 SV * orig = newSVpvn(start,s-start);
4814 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4815 /* need to insert a v to be consistent */
4816 sv_insert(orig, 0, 0, "v", 1);
4818 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4821 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4822 av_push(av, newSViv(0));
4825 /* And finally, store the AV in the hash */
4826 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4828 /* fix RT#19517 - special case 'undef' as string */
4829 if ( *s == 'u' && strEQ(s,"undef") ) {
4837 =for apidoc new_version
4839 Returns a new version object based on the passed in SV:
4841 SV *sv = new_version(SV *ver);
4843 Does not alter the passed in ver SV. See "upg_version" if you
4844 want to upgrade the SV.
4850 Perl_new_version(pTHX_ SV *ver)
4853 SV * const rv = newSV(0);
4854 PERL_ARGS_ASSERT_NEW_VERSION;
4855 if ( sv_derived_from(ver,"version") ) /* can just copy directly */
4858 AV * const av = newAV();
4860 /* This will get reblessed later if a derived class*/
4861 SV * const hv = newSVrv(rv, "version");
4862 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4863 #ifndef NODEFAULT_SHAREKEYS
4864 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4870 /* Begin copying all of the elements */
4871 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4872 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4874 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4875 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4877 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4879 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4880 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4883 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4885 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4886 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4889 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4890 /* This will get reblessed later if a derived class*/
4891 for ( key = 0; key <= av_len(sav); key++ )
4893 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4894 av_push(av, newSViv(rev));
4897 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4902 const MAGIC* const mg = SvVSTRING_mg(ver);
4903 if ( mg ) { /* already a v-string */
4904 const STRLEN len = mg->mg_len;
4905 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4906 sv_setpvn(rv,version,len);
4907 /* this is for consistency with the pure Perl class */
4908 if ( isDIGIT(*version) )
4909 sv_insert(rv, 0, 0, "v", 1);
4914 sv_setsv(rv,ver); /* make a duplicate */
4919 return upg_version(rv, FALSE);
4923 =for apidoc upg_version
4925 In-place upgrade of the supplied SV to a version object.
4927 SV *sv = upg_version(SV *sv, bool qv);
4929 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4930 to force this SV to be interpreted as an "extended" version.
4936 Perl_upg_version(pTHX_ SV *ver, bool qv)
4938 const char *version, *s;
4943 PERL_ARGS_ASSERT_UPG_VERSION;
4945 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4947 /* may get too much accuracy */
4949 #ifdef USE_LOCALE_NUMERIC
4950 char *loc = setlocale(LC_NUMERIC, "C");
4952 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4953 #ifdef USE_LOCALE_NUMERIC
4954 setlocale(LC_NUMERIC, loc);
4956 while (tbuf[len-1] == '0' && len > 0) len--;
4957 if ( tbuf[len-1] == '.' ) len--; /* eat the trailing decimal */
4958 version = savepvn(tbuf, len);
4961 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4962 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4966 else /* must be a string or something like a string */
4969 version = savepv(SvPV(ver,len));
4971 # if PERL_VERSION > 5
4972 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4973 if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
4974 /* may be a v-string */
4975 char *testv = (char *)version;
4977 for (tlen=0; tlen < len; tlen++, testv++) {
4978 /* if one of the characters is non-text assume v-string */
4979 if (testv[0] < ' ') {
4980 SV * const nsv = sv_newmortal();
4983 int saw_decimal = 0;
4984 sv_setpvf(nsv,"v%vd",ver);
4985 pos = nver = savepv(SvPV_nolen(nsv));
4987 /* scan the resulting formatted string */
4988 pos++; /* skip the leading 'v' */
4989 while ( *pos == '.' || isDIGIT(*pos) ) {
4995 /* is definitely a v-string */
4996 if ( saw_decimal >= 2 ) {
5008 s = scan_version(version, ver, qv);
5010 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
5011 "Version string '%s' contains invalid data; "
5012 "ignoring: '%s'", version, s);
5020 Validates that the SV contains valid internal structure for a version object.
5021 It may be passed either the version object (RV) or the hash itself (HV). If
5022 the structure is valid, it returns the HV. If the structure is invalid,
5025 SV *hv = vverify(sv);
5027 Note that it only confirms the bare minimum structure (so as not to get
5028 confused by derived classes which may contain additional hash entries):
5032 =item * The SV is an HV or a reference to an HV
5034 =item * The hash contains a "version" key