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 /* Refuse to fbm_compile a studied scalar, as this gives more flexibility in
556 SV flag usage. No real-world code would ever end up using a studied
557 scalar as a compile-time second argument to index, so this isn't a real
562 if (flags & FBMcf_TAIL) {
563 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
564 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
565 if (mg && mg->mg_len >= 0)
568 s = (U8*)SvPV_force_mutable(sv, len);
569 if (len == 0) /* TAIL might be on a zero-length string. */
571 SvUPGRADE(sv, SVt_PVGV);
576 const unsigned char *sb;
577 const U8 mlen = (len>255) ? 255 : (U8)len;
580 Sv_Grow(sv, len + 256 + PERL_FBM_TABLE_OFFSET);
582 = (unsigned char*)(SvPVX_mutable(sv) + len + PERL_FBM_TABLE_OFFSET);
583 s = table - 1 - PERL_FBM_TABLE_OFFSET; /* last char */
584 memset((void*)table, mlen, 256);
586 sb = s - mlen + 1; /* first char (maybe) */
588 if (table[*s] == mlen)
593 Sv_Grow(sv, len + PERL_FBM_TABLE_OFFSET);
595 sv_magic(sv, NULL, PERL_MAGIC_bm, NULL, 0); /* deep magic */
597 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
598 for (i = 0; i < len; i++) {
599 if (PL_freq[s[i]] < frequency) {
601 frequency = PL_freq[s[i]];
604 BmFLAGS(sv) = (U8)flags;
605 BmRARE(sv) = s[rarest];
606 BmPREVIOUS(sv) = rarest;
607 BmUSEFUL(sv) = 100; /* Initial value */
608 if (flags & FBMcf_TAIL)
610 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %lu\n",
611 BmRARE(sv),(unsigned long)BmPREVIOUS(sv)));
614 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
615 /* If SvTAIL is actually due to \Z or \z, this gives false positives
619 =for apidoc fbm_instr
621 Returns the location of the SV in the string delimited by C<str> and
622 C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
623 does not have to be fbm_compiled, but the search will not be as fast
630 Perl_fbm_instr(pTHX_ unsigned char *big, register unsigned char *bigend, SV *littlestr, U32 flags)
632 register unsigned char *s;
634 register const unsigned char *little
635 = (const unsigned char *)SvPV_const(littlestr,l);
636 register STRLEN littlelen = l;
637 register const I32 multiline = flags & FBMrf_MULTILINE;
639 PERL_ARGS_ASSERT_FBM_INSTR;
641 if ((STRLEN)(bigend - big) < littlelen) {
642 if ( SvTAIL(littlestr)
643 && ((STRLEN)(bigend - big) == littlelen - 1)
645 || (*big == *little &&
646 memEQ((char *)big, (char *)little, littlelen - 1))))
651 if (littlelen <= 2) { /* Special-cased */
653 if (littlelen == 1) {
654 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
655 /* Know that bigend != big. */
656 if (bigend[-1] == '\n')
657 return (char *)(bigend - 1);
658 return (char *) bigend;
666 if (SvTAIL(littlestr))
667 return (char *) bigend;
671 return (char*)big; /* Cannot be SvTAIL! */
674 if (SvTAIL(littlestr) && !multiline) {
675 if (bigend[-1] == '\n' && bigend[-2] == *little)
676 return (char*)bigend - 2;
677 if (bigend[-1] == *little)
678 return (char*)bigend - 1;
682 /* This should be better than FBM if c1 == c2, and almost
683 as good otherwise: maybe better since we do less indirection.
684 And we save a lot of memory by caching no table. */
685 const unsigned char c1 = little[0];
686 const unsigned char c2 = little[1];
691 while (s <= bigend) {
701 goto check_1char_anchor;
712 goto check_1char_anchor;
715 while (s <= bigend) {
720 goto check_1char_anchor;
729 check_1char_anchor: /* One char and anchor! */
730 if (SvTAIL(littlestr) && (*bigend == *little))
731 return (char *)bigend; /* bigend is already decremented. */
734 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
735 s = bigend - littlelen;
736 if (s >= big && bigend[-1] == '\n' && *s == *little
737 /* Automatically of length > 2 */
738 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
740 return (char*)s; /* how sweet it is */
743 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
745 return (char*)s + 1; /* how sweet it is */
749 if (!SvVALID(littlestr)) {
750 char * const b = ninstr((char*)big,(char*)bigend,
751 (char*)little, (char*)little + littlelen);
753 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
754 /* Chop \n from littlestr: */
755 s = bigend - littlelen + 1;
757 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
767 if (littlelen > (STRLEN)(bigend - big))
771 register const unsigned char * const table
772 = little + littlelen + PERL_FBM_TABLE_OFFSET;
773 register const unsigned char *oldlittle;
775 --littlelen; /* Last char found by table lookup */
778 little += littlelen; /* last char */
784 if ((tmp = table[*s])) {
785 if ((s += tmp) < bigend)
789 else { /* less expensive than calling strncmp() */
790 register unsigned char * const olds = s;
795 if (*--s == *--little)
797 s = olds + 1; /* here we pay the price for failure */
799 if (s < bigend) /* fake up continue to outer loop */
808 && (BmFLAGS(littlestr) & FBMcf_TAIL)
809 && memEQ((char *)(bigend - littlelen),
810 (char *)(oldlittle - littlelen), littlelen) )
811 return (char*)bigend - littlelen;
816 /* start_shift, end_shift are positive quantities which give offsets
817 of ends of some substring of bigstr.
818 If "last" we want the last occurrence.
819 old_posp is the way of communication between consequent calls if
820 the next call needs to find the .
821 The initial *old_posp should be -1.
823 Note that we take into account SvTAIL, so one can get extra
824 optimizations if _ALL flag is set.
827 /* If SvTAIL is actually due to \Z or \z, this gives false positives
828 if PL_multiline. In fact if !PL_multiline the authoritative answer
829 is not supported yet. */
832 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
835 register const unsigned char *big;
837 register I32 previous;
839 register const unsigned char *little;
840 register I32 stop_pos;
841 register const unsigned char *littleend;
844 PERL_ARGS_ASSERT_SCREAMINSTR;
846 assert(SvTYPE(littlestr) == SVt_PVGV);
847 assert(SvVALID(littlestr));
850 ? (pos = PL_screamfirst[BmRARE(littlestr)]) < 0
851 : (((pos = *old_posp), pos += PL_screamnext[pos]) == 0)) {
853 if ( BmRARE(littlestr) == '\n'
854 && BmPREVIOUS(littlestr) == SvCUR(littlestr) - 1) {
855 little = (const unsigned char *)(SvPVX_const(littlestr));
856 littleend = little + SvCUR(littlestr);
863 little = (const unsigned char *)(SvPVX_const(littlestr));
864 littleend = little + SvCUR(littlestr);
866 /* The value of pos we can start at: */
867 previous = BmPREVIOUS(littlestr);
868 big = (const unsigned char *)(SvPVX_const(bigstr));
869 /* The value of pos we can stop at: */
870 stop_pos = SvCUR(bigstr) - end_shift - (SvCUR(littlestr) - 1 - previous);
871 if (previous + start_shift > stop_pos) {
873 stop_pos does not include SvTAIL in the count, so this check is incorrect
874 (I think) - see [ID 20010618.006] and t/op/study.t. HVDS 2001/06/19
877 if (previous + start_shift == stop_pos + 1) /* A fake '\n'? */
882 while (pos < previous + start_shift) {
883 if (!(pos += PL_screamnext[pos]))
888 register const unsigned char *s, *x;
889 if (pos >= stop_pos) break;
890 if (big[pos] != first)
892 for (x=big+pos+1,s=little; s < littleend; /**/ ) {
898 if (s == littleend) {
900 if (!last) return (char *)(big+pos);
903 } while ( pos += PL_screamnext[pos] );
905 return (char *)(big+(*old_posp));
907 if (!SvTAIL(littlestr) || (end_shift > 0))
909 /* Ignore the trailing "\n". This code is not microoptimized */
910 big = (const unsigned char *)(SvPVX_const(bigstr) + SvCUR(bigstr));
911 stop_pos = littleend - little; /* Actual littlestr len */
916 && ((stop_pos == 1) ||
917 memEQ((char *)(big + 1), (char *)little, stop_pos - 1)))
925 Returns true if the leading len bytes of the strings s1 and s2 are the same
926 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
927 match themselves and their opposite case counterparts. Non-cased and non-ASCII
928 range bytes match only themselves.
935 Perl_foldEQ(const char *s1, const char *s2, register I32 len)
937 register const U8 *a = (const U8 *)s1;
938 register const U8 *b = (const U8 *)s2;
940 PERL_ARGS_ASSERT_FOLDEQ;
943 if (*a != *b && *a != PL_fold[*b])
950 Perl_foldEQ_latin1(const char *s1, const char *s2, register I32 len)
952 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
953 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
954 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
955 * does it check that the strings each have at least 'len' characters */
957 register const U8 *a = (const U8 *)s1;
958 register const U8 *b = (const U8 *)s2;
960 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
963 if (*a != *b && *a != PL_fold_latin1[*b]) {
972 =for apidoc foldEQ_locale
974 Returns true if the leading len bytes of the strings s1 and s2 are the same
975 case-insensitively in the current locale; false otherwise.
981 Perl_foldEQ_locale(const char *s1, const char *s2, register I32 len)
984 register const U8 *a = (const U8 *)s1;
985 register const U8 *b = (const U8 *)s2;
987 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
990 if (*a != *b && *a != PL_fold_locale[*b])
997 /* copy a string to a safe spot */
1000 =head1 Memory Management
1004 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
1005 string which is a duplicate of C<pv>. The size of the string is
1006 determined by C<strlen()>. The memory allocated for the new string can
1007 be freed with the C<Safefree()> function.
1013 Perl_savepv(pTHX_ const char *pv)
1015 PERL_UNUSED_CONTEXT;
1020 const STRLEN pvlen = strlen(pv)+1;
1021 Newx(newaddr, pvlen, char);
1022 return (char*)memcpy(newaddr, pv, pvlen);
1026 /* same thing but with a known length */
1031 Perl's version of what C<strndup()> would be if it existed. Returns a
1032 pointer to a newly allocated string which is a duplicate of the first
1033 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
1034 the new string can be freed with the C<Safefree()> function.
1040 Perl_savepvn(pTHX_ const char *pv, register I32 len)
1042 register char *newaddr;
1043 PERL_UNUSED_CONTEXT;
1045 Newx(newaddr,len+1,char);
1046 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
1048 /* might not be null terminated */
1049 newaddr[len] = '\0';
1050 return (char *) CopyD(pv,newaddr,len,char);
1053 return (char *) ZeroD(newaddr,len+1,char);
1058 =for apidoc savesharedpv
1060 A version of C<savepv()> which allocates the duplicate string in memory
1061 which is shared between threads.
1066 Perl_savesharedpv(pTHX_ const char *pv)
1068 register char *newaddr;
1073 pvlen = strlen(pv)+1;
1074 newaddr = (char*)PerlMemShared_malloc(pvlen);
1076 return write_no_mem();
1078 return (char*)memcpy(newaddr, pv, pvlen);
1082 =for apidoc savesharedpvn
1084 A version of C<savepvn()> which allocates the duplicate string in memory
1085 which is shared between threads. (With the specific difference that a NULL
1086 pointer is not acceptable)
1091 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1093 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1095 PERL_ARGS_ASSERT_SAVESHAREDPVN;
1098 return write_no_mem();
1100 newaddr[len] = '\0';
1101 return (char*)memcpy(newaddr, pv, len);
1105 =for apidoc savesvpv
1107 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1108 the passed in SV using C<SvPV()>
1114 Perl_savesvpv(pTHX_ SV *sv)
1117 const char * const pv = SvPV_const(sv, len);
1118 register char *newaddr;
1120 PERL_ARGS_ASSERT_SAVESVPV;
1123 Newx(newaddr,len,char);
1124 return (char *) CopyD(pv,newaddr,len,char);
1128 =for apidoc savesharedsvpv
1130 A version of C<savesharedpv()> which allocates the duplicate string in
1131 memory which is shared between threads.
1137 Perl_savesharedsvpv(pTHX_ SV *sv)
1140 const char * const pv = SvPV_const(sv, len);
1142 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1144 return savesharedpvn(pv, len);
1147 /* the SV for Perl_form() and mess() is not kept in an arena */
1156 if (PL_phase != PERL_PHASE_DESTRUCT)
1157 return newSVpvs_flags("", SVs_TEMP);
1162 /* Create as PVMG now, to avoid any upgrading later */
1164 Newxz(any, 1, XPVMG);
1165 SvFLAGS(sv) = SVt_PVMG;
1166 SvANY(sv) = (void*)any;
1168 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1173 #if defined(PERL_IMPLICIT_CONTEXT)
1175 Perl_form_nocontext(const char* pat, ...)
1180 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1181 va_start(args, pat);
1182 retval = vform(pat, &args);
1186 #endif /* PERL_IMPLICIT_CONTEXT */
1189 =head1 Miscellaneous Functions
1192 Takes a sprintf-style format pattern and conventional
1193 (non-SV) arguments and returns the formatted string.
1195 (char *) Perl_form(pTHX_ const char* pat, ...)
1197 can be used any place a string (char *) is required:
1199 char * s = Perl_form("%d.%d",major,minor);
1201 Uses a single private buffer so if you want to format several strings you
1202 must explicitly copy the earlier strings away (and free the copies when you
1209 Perl_form(pTHX_ const char* pat, ...)
1213 PERL_ARGS_ASSERT_FORM;
1214 va_start(args, pat);
1215 retval = vform(pat, &args);
1221 Perl_vform(pTHX_ const char *pat, va_list *args)
1223 SV * const sv = mess_alloc();
1224 PERL_ARGS_ASSERT_VFORM;
1225 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1230 =for apidoc Am|SV *|mess|const char *pat|...
1232 Take a sprintf-style format pattern and argument list. These are used to
1233 generate a string message. If the message does not end with a newline,
1234 then it will be extended with some indication of the current location
1235 in the code, as described for L</mess_sv>.
1237 Normally, the resulting message is returned in a new mortal SV.
1238 During global destruction a single SV may be shared between uses of
1244 #if defined(PERL_IMPLICIT_CONTEXT)
1246 Perl_mess_nocontext(const char *pat, ...)
1251 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1252 va_start(args, pat);
1253 retval = vmess(pat, &args);
1257 #endif /* PERL_IMPLICIT_CONTEXT */
1260 Perl_mess(pTHX_ const char *pat, ...)
1264 PERL_ARGS_ASSERT_MESS;
1265 va_start(args, pat);
1266 retval = vmess(pat, &args);
1272 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1275 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1277 PERL_ARGS_ASSERT_CLOSEST_COP;
1279 if (!o || o == PL_op)
1282 if (o->op_flags & OPf_KIDS) {
1284 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1287 /* If the OP_NEXTSTATE has been optimised away we can still use it
1288 * the get the file and line number. */
1290 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1291 cop = (const COP *)kid;
1293 /* Keep searching, and return when we've found something. */
1295 new_cop = closest_cop(cop, kid);
1301 /* Nothing found. */
1307 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1309 Expands a message, intended for the user, to include an indication of
1310 the current location in the code, if the message does not already appear
1313 C<basemsg> is the initial message or object. If it is a reference, it
1314 will be used as-is and will be the result of this function. Otherwise it
1315 is used as a string, and if it already ends with a newline, it is taken
1316 to be complete, and the result of this function will be the same string.
1317 If the message does not end with a newline, then a segment such as C<at
1318 foo.pl line 37> will be appended, and possibly other clauses indicating
1319 the current state of execution. The resulting message will end with a
1322 Normally, the resulting message is returned in a new mortal SV.
1323 During global destruction a single SV may be shared between uses of this
1324 function. If C<consume> is true, then the function is permitted (but not
1325 required) to modify and return C<basemsg> instead of allocating a new SV.
1331 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1336 PERL_ARGS_ASSERT_MESS_SV;
1338 if (SvROK(basemsg)) {
1344 sv_setsv(sv, basemsg);
1349 if (SvPOK(basemsg) && consume) {
1354 sv_copypv(sv, basemsg);
1357 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1359 * Try and find the file and line for PL_op. This will usually be
1360 * PL_curcop, but it might be a cop that has been optimised away. We
1361 * can try to find such a cop by searching through the optree starting
1362 * from the sibling of PL_curcop.
1365 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1370 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1371 OutCopFILE(cop), (IV)CopLINE(cop));
1372 /* Seems that GvIO() can be untrustworthy during global destruction. */
1373 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1374 && IoLINES(GvIOp(PL_last_in_gv)))
1376 const bool line_mode = (RsSIMPLE(PL_rs) &&
1377 SvCUR(PL_rs) == 1 && *SvPVX_const(PL_rs) == '\n');
1378 Perl_sv_catpvf(aTHX_ sv, ", <%s> %s %"IVdf,
1379 PL_last_in_gv == PL_argvgv ? "" : GvNAME(PL_last_in_gv),
1380 line_mode ? "line" : "chunk",
1381 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1383 if (PL_phase == PERL_PHASE_DESTRUCT)
1384 sv_catpvs(sv, " during global destruction");
1385 sv_catpvs(sv, ".\n");
1391 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1393 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1394 argument list. These are used to generate a string message. If the
1395 message does not end with a newline, then it will be extended with
1396 some indication of the current location in the code, as described for
1399 Normally, the resulting message is returned in a new mortal SV.
1400 During global destruction a single SV may be shared between uses of
1407 Perl_vmess(pTHX_ const char *pat, va_list *args)
1410 SV * const sv = mess_alloc();
1412 PERL_ARGS_ASSERT_VMESS;
1414 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1415 return mess_sv(sv, 1);
1419 Perl_write_to_stderr(pTHX_ SV* msv)
1425 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1427 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1428 && (io = GvIO(PL_stderrgv))
1429 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1430 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, "PRINT",
1431 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1434 /* SFIO can really mess with your errno */
1437 PerlIO * const serr = Perl_error_log;
1439 do_print(msv, serr);
1440 (void)PerlIO_flush(serr);
1448 =head1 Warning and Dieing
1451 /* Common code used in dieing and warning */
1454 S_with_queued_errors(pTHX_ SV *ex)
1456 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1457 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1458 sv_catsv(PL_errors, ex);
1459 ex = sv_mortalcopy(PL_errors);
1460 SvCUR_set(PL_errors, 0);
1466 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1472 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1473 /* sv_2cv might call Perl_croak() or Perl_warner() */
1474 SV * const oldhook = *hook;
1482 cv = sv_2cv(oldhook, &stash, &gv, 0);
1484 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1494 exarg = newSVsv(ex);
1495 SvREADONLY_on(exarg);
1498 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1502 call_sv(MUTABLE_SV(cv), G_DISCARD);
1511 =for apidoc Am|OP *|die_sv|SV *baseex
1513 Behaves the same as L</croak_sv>, except for the return type.
1514 It should be used only where the C<OP *> return type is required.
1515 The function never actually returns.
1521 Perl_die_sv(pTHX_ SV *baseex)
1523 PERL_ARGS_ASSERT_DIE_SV;
1530 =for apidoc Am|OP *|die|const char *pat|...
1532 Behaves the same as L</croak>, except for the return type.
1533 It should be used only where the C<OP *> return type is required.
1534 The function never actually returns.
1539 #if defined(PERL_IMPLICIT_CONTEXT)
1541 Perl_die_nocontext(const char* pat, ...)
1545 va_start(args, pat);
1551 #endif /* PERL_IMPLICIT_CONTEXT */
1554 Perl_die(pTHX_ const char* pat, ...)
1557 va_start(args, pat);
1565 =for apidoc Am|void|croak_sv|SV *baseex
1567 This is an XS interface to Perl's C<die> function.
1569 C<baseex> is the error message or object. If it is a reference, it
1570 will be used as-is. Otherwise it is used as a string, and if it does
1571 not end with a newline then it will be extended with some indication of
1572 the current location in the code, as described for L</mess_sv>.
1574 The error message or object will be used as an exception, by default
1575 returning control to the nearest enclosing C<eval>, but subject to
1576 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1577 function never returns normally.
1579 To die with a simple string message, the L</croak> function may be
1586 Perl_croak_sv(pTHX_ SV *baseex)
1588 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1589 PERL_ARGS_ASSERT_CROAK_SV;
1590 invoke_exception_hook(ex, FALSE);
1595 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1597 This is an XS interface to Perl's C<die> function.
1599 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1600 argument list. These are used to generate a string message. If the
1601 message does not end with a newline, then it will be extended with
1602 some indication of the current location in the code, as described for
1605 The error message will be used as an exception, by default
1606 returning control to the nearest enclosing C<eval>, but subject to
1607 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1608 function never returns normally.
1610 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1611 (C<$@>) will be used as an error message or object instead of building an
1612 error message from arguments. If you want to throw a non-string object,
1613 or build an error message in an SV yourself, it is preferable to use
1614 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1620 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1622 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1623 invoke_exception_hook(ex, FALSE);
1628 =for apidoc Am|void|croak|const char *pat|...
1630 This is an XS interface to Perl's C<die> function.
1632 Take a sprintf-style format pattern and argument list. These are used to
1633 generate a string message. If the message does not end with a newline,
1634 then it will be extended with some indication of the current location
1635 in the code, as described for L</mess_sv>.
1637 The error message will be used as an exception, by default
1638 returning control to the nearest enclosing C<eval>, but subject to
1639 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1640 function never returns normally.
1642 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1643 (C<$@>) will be used as an error message or object instead of building an
1644 error message from arguments. If you want to throw a non-string object,
1645 or build an error message in an SV yourself, it is preferable to use
1646 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1651 #if defined(PERL_IMPLICIT_CONTEXT)
1653 Perl_croak_nocontext(const char *pat, ...)
1657 va_start(args, pat);
1662 #endif /* PERL_IMPLICIT_CONTEXT */
1665 Perl_croak(pTHX_ const char *pat, ...)
1668 va_start(args, pat);
1675 =for apidoc Am|void|croak_no_modify
1677 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1678 terser object code than using C<Perl_croak>. Less code used on exception code
1679 paths reduces CPU cache pressure.
1685 Perl_croak_no_modify(pTHX)
1687 Perl_croak(aTHX_ "%s", PL_no_modify);
1691 =for apidoc Am|void|warn_sv|SV *baseex
1693 This is an XS interface to Perl's C<warn> function.
1695 C<baseex> is the error message or object. If it is a reference, it
1696 will be used as-is. Otherwise it is used as a string, and if it does
1697 not end with a newline then it will be extended with some indication of
1698 the current location in the code, as described for L</mess_sv>.
1700 The error message or object will by default be written to standard error,
1701 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1703 To warn with a simple string message, the L</warn> function may be
1710 Perl_warn_sv(pTHX_ SV *baseex)
1712 SV *ex = mess_sv(baseex, 0);
1713 PERL_ARGS_ASSERT_WARN_SV;
1714 if (!invoke_exception_hook(ex, TRUE))
1715 write_to_stderr(ex);
1719 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1721 This is an XS interface to Perl's C<warn> function.
1723 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1724 argument list. These are used to generate a string message. If the
1725 message does not end with a newline, then it will be extended with
1726 some indication of the current location in the code, as described for
1729 The error message or object will by default be written to standard error,
1730 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1732 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1738 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1740 SV *ex = vmess(pat, args);
1741 PERL_ARGS_ASSERT_VWARN;
1742 if (!invoke_exception_hook(ex, TRUE))
1743 write_to_stderr(ex);
1747 =for apidoc Am|void|warn|const char *pat|...
1749 This is an XS interface to Perl's C<warn> function.
1751 Take a sprintf-style format pattern and argument list. These are used to
1752 generate a string message. If the message does not end with a newline,
1753 then it will be extended with some indication of the current location
1754 in the code, as described for L</mess_sv>.
1756 The error message or object will by default be written to standard error,
1757 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1759 Unlike with L</croak>, C<pat> is not permitted to be null.
1764 #if defined(PERL_IMPLICIT_CONTEXT)
1766 Perl_warn_nocontext(const char *pat, ...)
1770 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1771 va_start(args, pat);
1775 #endif /* PERL_IMPLICIT_CONTEXT */
1778 Perl_warn(pTHX_ const char *pat, ...)
1781 PERL_ARGS_ASSERT_WARN;
1782 va_start(args, pat);
1787 #if defined(PERL_IMPLICIT_CONTEXT)
1789 Perl_warner_nocontext(U32 err, const char *pat, ...)
1793 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1794 va_start(args, pat);
1795 vwarner(err, pat, &args);
1798 #endif /* PERL_IMPLICIT_CONTEXT */
1801 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1803 PERL_ARGS_ASSERT_CK_WARNER_D;
1805 if (Perl_ckwarn_d(aTHX_ err)) {
1807 va_start(args, pat);
1808 vwarner(err, pat, &args);
1814 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1816 PERL_ARGS_ASSERT_CK_WARNER;
1818 if (Perl_ckwarn(aTHX_ err)) {
1820 va_start(args, pat);
1821 vwarner(err, pat, &args);
1827 Perl_warner(pTHX_ U32 err, const char* pat,...)
1830 PERL_ARGS_ASSERT_WARNER;
1831 va_start(args, pat);
1832 vwarner(err, pat, &args);
1837 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1840 PERL_ARGS_ASSERT_VWARNER;
1841 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1842 SV * const msv = vmess(pat, args);
1844 invoke_exception_hook(msv, FALSE);
1848 Perl_vwarn(aTHX_ pat, args);
1852 /* implements the ckWARN? macros */
1855 Perl_ckwarn(pTHX_ U32 w)
1858 /* If lexical warnings have not been set, use $^W. */
1860 return PL_dowarn & G_WARN_ON;
1862 return ckwarn_common(w);
1865 /* implements the ckWARN?_d macro */
1868 Perl_ckwarn_d(pTHX_ U32 w)
1871 /* If lexical warnings have not been set then default classes warn. */
1875 return ckwarn_common(w);
1879 S_ckwarn_common(pTHX_ U32 w)
1881 if (PL_curcop->cop_warnings == pWARN_ALL)
1884 if (PL_curcop->cop_warnings == pWARN_NONE)
1887 /* Check the assumption that at least the first slot is non-zero. */
1888 assert(unpackWARN1(w));
1890 /* Check the assumption that it is valid to stop as soon as a zero slot is
1892 if (!unpackWARN2(w)) {
1893 assert(!unpackWARN3(w));
1894 assert(!unpackWARN4(w));
1895 } else if (!unpackWARN3(w)) {
1896 assert(!unpackWARN4(w));
1899 /* Right, dealt with all the special cases, which are implemented as non-
1900 pointers, so there is a pointer to a real warnings mask. */
1902 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1904 } while (w >>= WARNshift);
1909 /* Set buffer=NULL to get a new one. */
1911 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1913 const MEM_SIZE len_wanted = sizeof(STRLEN) + size;
1914 PERL_UNUSED_CONTEXT;
1915 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1918 (specialWARN(buffer) ?
1919 PerlMemShared_malloc(len_wanted) :
1920 PerlMemShared_realloc(buffer, len_wanted));
1922 Copy(bits, (buffer + 1), size, char);
1926 /* since we've already done strlen() for both nam and val
1927 * we can use that info to make things faster than
1928 * sprintf(s, "%s=%s", nam, val)
1930 #define my_setenv_format(s, nam, nlen, val, vlen) \
1931 Copy(nam, s, nlen, char); \
1933 Copy(val, s+(nlen+1), vlen, char); \
1934 *(s+(nlen+1+vlen)) = '\0'
1936 #ifdef USE_ENVIRON_ARRAY
1937 /* VMS' my_setenv() is in vms.c */
1938 #if !defined(WIN32) && !defined(NETWARE)
1940 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1944 /* only parent thread can modify process environment */
1945 if (PL_curinterp == aTHX)
1948 #ifndef PERL_USE_SAFE_PUTENV
1949 if (!PL_use_safe_putenv) {
1950 /* most putenv()s leak, so we manipulate environ directly */
1952 register const I32 len = strlen(nam);
1955 /* where does it go? */
1956 for (i = 0; environ[i]; i++) {
1957 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1961 if (environ == PL_origenviron) { /* need we copy environment? */
1967 while (environ[max])
1969 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1970 for (j=0; j<max; j++) { /* copy environment */
1971 const int len = strlen(environ[j]);
1972 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1973 Copy(environ[j], tmpenv[j], len+1, char);
1976 environ = tmpenv; /* tell exec where it is now */
1979 safesysfree(environ[i]);
1980 while (environ[i]) {
1981 environ[i] = environ[i+1];
1986 if (!environ[i]) { /* does not exist yet */
1987 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1988 environ[i+1] = NULL; /* make sure it's null terminated */
1991 safesysfree(environ[i]);
1995 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1996 /* all that work just for this */
1997 my_setenv_format(environ[i], nam, nlen, val, vlen);
2000 # if defined(__CYGWIN__) || defined(EPOC) || defined(__SYMBIAN32__) || defined(__riscos__)
2001 # if defined(HAS_UNSETENV)
2003 (void)unsetenv(nam);
2005 (void)setenv(nam, val, 1);
2007 # else /* ! HAS_UNSETENV */
2008 (void)setenv(nam, val, 1);
2009 # endif /* HAS_UNSETENV */
2011 # if defined(HAS_UNSETENV)
2013 (void)unsetenv(nam);
2015 const int nlen = strlen(nam);
2016 const int vlen = strlen(val);
2017 char * const new_env =
2018 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2019 my_setenv_format(new_env, nam, nlen, val, vlen);
2020 (void)putenv(new_env);
2022 # else /* ! HAS_UNSETENV */
2024 const int nlen = strlen(nam);
2030 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
2031 /* all that work just for this */
2032 my_setenv_format(new_env, nam, nlen, val, vlen);
2033 (void)putenv(new_env);
2034 # endif /* HAS_UNSETENV */
2035 # endif /* __CYGWIN__ */
2036 #ifndef PERL_USE_SAFE_PUTENV
2042 #else /* WIN32 || NETWARE */
2045 Perl_my_setenv(pTHX_ const char *nam, const char *val)
2048 register char *envstr;
2049 const int nlen = strlen(nam);
2056 Newx(envstr, nlen+vlen+2, char);
2057 my_setenv_format(envstr, nam, nlen, val, vlen);
2058 (void)PerlEnv_putenv(envstr);
2062 #endif /* WIN32 || NETWARE */
2064 #endif /* !VMS && !EPOC*/
2066 #ifdef UNLINK_ALL_VERSIONS
2068 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2072 PERL_ARGS_ASSERT_UNLNK;
2074 while (PerlLIO_unlink(f) >= 0)
2076 return retries ? 0 : -1;
2080 /* this is a drop-in replacement for bcopy() */
2081 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2083 Perl_my_bcopy(register const char *from,register char *to,register I32 len)
2085 char * const retval = to;
2087 PERL_ARGS_ASSERT_MY_BCOPY;
2089 if (from - to >= 0) {
2097 *(--to) = *(--from);
2103 /* this is a drop-in replacement for memset() */
2106 Perl_my_memset(register char *loc, register I32 ch, register I32 len)
2108 char * const retval = loc;
2110 PERL_ARGS_ASSERT_MY_MEMSET;
2118 /* this is a drop-in replacement for bzero() */
2119 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2121 Perl_my_bzero(register char *loc, register I32 len)
2123 char * const retval = loc;
2125 PERL_ARGS_ASSERT_MY_BZERO;
2133 /* this is a drop-in replacement for memcmp() */
2134 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2136 Perl_my_memcmp(const char *s1, const char *s2, register I32 len)
2138 register const U8 *a = (const U8 *)s1;
2139 register const U8 *b = (const U8 *)s2;
2142 PERL_ARGS_ASSERT_MY_MEMCMP;
2145 if ((tmp = *a++ - *b++))
2150 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2153 /* This vsprintf replacement should generally never get used, since
2154 vsprintf was available in both System V and BSD 2.11. (There may
2155 be some cross-compilation or embedded set-ups where it is needed,
2158 If you encounter a problem in this function, it's probably a symptom
2159 that Configure failed to detect your system's vprintf() function.
2160 See the section on "item vsprintf" in the INSTALL file.
2162 This version may compile on systems with BSD-ish <stdio.h>,
2163 but probably won't on others.
2166 #ifdef USE_CHAR_VSPRINTF
2171 vsprintf(char *dest, const char *pat, void *args)
2175 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2176 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2177 FILE_cnt(&fakebuf) = 32767;
2179 /* These probably won't compile -- If you really need
2180 this, you'll have to figure out some other method. */
2181 fakebuf._ptr = dest;
2182 fakebuf._cnt = 32767;
2187 fakebuf._flag = _IOWRT|_IOSTRG;
2188 _doprnt(pat, args, &fakebuf); /* what a kludge */
2189 #if defined(STDIO_PTR_LVALUE)
2190 *(FILE_ptr(&fakebuf)++) = '\0';
2192 /* PerlIO has probably #defined away fputc, but we want it here. */
2194 # undef fputc /* XXX Should really restore it later */
2196 (void)fputc('\0', &fakebuf);
2198 #ifdef USE_CHAR_VSPRINTF
2201 return 0; /* perl doesn't use return value */
2205 #endif /* HAS_VPRINTF */
2208 #if BYTEORDER != 0x4321
2210 Perl_my_swap(pTHX_ short s)
2212 #if (BYTEORDER & 1) == 0
2215 result = ((s & 255) << 8) + ((s >> 8) & 255);
2223 Perl_my_htonl(pTHX_ long l)
2227 char c[sizeof(long)];
2230 #if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
2231 #if BYTEORDER == 0x12345678
2234 u.c[0] = (l >> 24) & 255;
2235 u.c[1] = (l >> 16) & 255;
2236 u.c[2] = (l >> 8) & 255;
2240 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2241 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2246 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2247 u.c[o & 0xf] = (l >> s) & 255;
2255 Perl_my_ntohl(pTHX_ long l)
2259 char c[sizeof(long)];
2262 #if BYTEORDER == 0x1234
2263 u.c[0] = (l >> 24) & 255;
2264 u.c[1] = (l >> 16) & 255;
2265 u.c[2] = (l >> 8) & 255;
2269 #if ((BYTEORDER - 0x1111) & 0x444) || !(BYTEORDER & 0xf)
2270 Perl_croak(aTHX_ "Unknown BYTEORDER\n");
2277 for (o = BYTEORDER - 0x1111, s = 0; s < (sizeof(long)*8); o >>= 4, s += 8) {
2278 l |= (u.c[o & 0xf] & 255) << s;
2285 #endif /* BYTEORDER != 0x4321 */
2289 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2290 * If these functions are defined,
2291 * the BYTEORDER is neither 0x1234 nor 0x4321.
2292 * However, this is not assumed.
2296 #define HTOLE(name,type) \
2298 name (register type n) \
2302 char c[sizeof(type)]; \
2305 register U32 s = 0; \
2306 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2307 u.c[i] = (n >> s) & 0xFF; \
2312 #define LETOH(name,type) \
2314 name (register type n) \
2318 char c[sizeof(type)]; \
2321 register U32 s = 0; \
2324 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2325 n |= ((type)(u.c[i] & 0xFF)) << s; \
2331 * Big-endian byte order functions.
2334 #define HTOBE(name,type) \
2336 name (register type n) \
2340 char c[sizeof(type)]; \
2343 register U32 s = 8*(sizeof(u.c)-1); \
2344 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2345 u.c[i] = (n >> s) & 0xFF; \
2350 #define BETOH(name,type) \
2352 name (register type n) \
2356 char c[sizeof(type)]; \
2359 register U32 s = 8*(sizeof(u.c)-1); \
2362 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2363 n |= ((type)(u.c[i] & 0xFF)) << s; \
2369 * If we just can't do it...
2372 #define NOT_AVAIL(name,type) \
2374 name (register type n) \
2376 Perl_croak_nocontext(#name "() not available"); \
2377 return n; /* not reached */ \
2381 #if defined(HAS_HTOVS) && !defined(htovs)
2384 #if defined(HAS_HTOVL) && !defined(htovl)
2387 #if defined(HAS_VTOHS) && !defined(vtohs)
2390 #if defined(HAS_VTOHL) && !defined(vtohl)
2394 #ifdef PERL_NEED_MY_HTOLE16
2396 HTOLE(Perl_my_htole16,U16)
2398 NOT_AVAIL(Perl_my_htole16,U16)
2401 #ifdef PERL_NEED_MY_LETOH16
2403 LETOH(Perl_my_letoh16,U16)
2405 NOT_AVAIL(Perl_my_letoh16,U16)
2408 #ifdef PERL_NEED_MY_HTOBE16
2410 HTOBE(Perl_my_htobe16,U16)
2412 NOT_AVAIL(Perl_my_htobe16,U16)
2415 #ifdef PERL_NEED_MY_BETOH16
2417 BETOH(Perl_my_betoh16,U16)
2419 NOT_AVAIL(Perl_my_betoh16,U16)
2423 #ifdef PERL_NEED_MY_HTOLE32
2425 HTOLE(Perl_my_htole32,U32)
2427 NOT_AVAIL(Perl_my_htole32,U32)
2430 #ifdef PERL_NEED_MY_LETOH32
2432 LETOH(Perl_my_letoh32,U32)
2434 NOT_AVAIL(Perl_my_letoh32,U32)
2437 #ifdef PERL_NEED_MY_HTOBE32
2439 HTOBE(Perl_my_htobe32,U32)
2441 NOT_AVAIL(Perl_my_htobe32,U32)
2444 #ifdef PERL_NEED_MY_BETOH32
2446 BETOH(Perl_my_betoh32,U32)
2448 NOT_AVAIL(Perl_my_betoh32,U32)
2452 #ifdef PERL_NEED_MY_HTOLE64
2454 HTOLE(Perl_my_htole64,U64)
2456 NOT_AVAIL(Perl_my_htole64,U64)
2459 #ifdef PERL_NEED_MY_LETOH64
2461 LETOH(Perl_my_letoh64,U64)
2463 NOT_AVAIL(Perl_my_letoh64,U64)
2466 #ifdef PERL_NEED_MY_HTOBE64
2468 HTOBE(Perl_my_htobe64,U64)
2470 NOT_AVAIL(Perl_my_htobe64,U64)
2473 #ifdef PERL_NEED_MY_BETOH64
2475 BETOH(Perl_my_betoh64,U64)
2477 NOT_AVAIL(Perl_my_betoh64,U64)
2481 #ifdef PERL_NEED_MY_HTOLES
2482 HTOLE(Perl_my_htoles,short)
2484 #ifdef PERL_NEED_MY_LETOHS
2485 LETOH(Perl_my_letohs,short)
2487 #ifdef PERL_NEED_MY_HTOBES
2488 HTOBE(Perl_my_htobes,short)
2490 #ifdef PERL_NEED_MY_BETOHS
2491 BETOH(Perl_my_betohs,short)
2494 #ifdef PERL_NEED_MY_HTOLEI
2495 HTOLE(Perl_my_htolei,int)
2497 #ifdef PERL_NEED_MY_LETOHI
2498 LETOH(Perl_my_letohi,int)
2500 #ifdef PERL_NEED_MY_HTOBEI
2501 HTOBE(Perl_my_htobei,int)
2503 #ifdef PERL_NEED_MY_BETOHI
2504 BETOH(Perl_my_betohi,int)
2507 #ifdef PERL_NEED_MY_HTOLEL
2508 HTOLE(Perl_my_htolel,long)
2510 #ifdef PERL_NEED_MY_LETOHL
2511 LETOH(Perl_my_letohl,long)
2513 #ifdef PERL_NEED_MY_HTOBEL
2514 HTOBE(Perl_my_htobel,long)
2516 #ifdef PERL_NEED_MY_BETOHL
2517 BETOH(Perl_my_betohl,long)
2521 Perl_my_swabn(void *ptr, int n)
2523 register char *s = (char *)ptr;
2524 register char *e = s + (n-1);
2527 PERL_ARGS_ASSERT_MY_SWABN;
2529 for (n /= 2; n > 0; s++, e--, n--) {
2537 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2539 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2542 register I32 This, that;
2548 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2550 PERL_FLUSHALL_FOR_CHILD;
2551 This = (*mode == 'w');
2555 taint_proper("Insecure %s%s", "EXEC");
2557 if (PerlProc_pipe(p) < 0)
2559 /* Try for another pipe pair for error return */
2560 if (PerlProc_pipe(pp) >= 0)
2562 while ((pid = PerlProc_fork()) < 0) {
2563 if (errno != EAGAIN) {
2564 PerlLIO_close(p[This]);
2565 PerlLIO_close(p[that]);
2567 PerlLIO_close(pp[0]);
2568 PerlLIO_close(pp[1]);
2572 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2581 /* Close parent's end of error status pipe (if any) */
2583 PerlLIO_close(pp[0]);
2584 #if defined(HAS_FCNTL) && defined(F_SETFD)
2585 /* Close error pipe automatically if exec works */
2586 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2589 /* Now dup our end of _the_ pipe to right position */
2590 if (p[THIS] != (*mode == 'r')) {
2591 PerlLIO_dup2(p[THIS], *mode == 'r');
2592 PerlLIO_close(p[THIS]);
2593 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2594 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2597 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2598 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2599 /* No automatic close - do it by hand */
2606 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2612 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2618 do_execfree(); /* free any memory malloced by child on fork */
2620 PerlLIO_close(pp[1]);
2621 /* Keep the lower of the two fd numbers */
2622 if (p[that] < p[This]) {
2623 PerlLIO_dup2(p[This], p[that]);
2624 PerlLIO_close(p[This]);
2628 PerlLIO_close(p[that]); /* close child's end of pipe */
2630 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2631 SvUPGRADE(sv,SVt_IV);
2633 PL_forkprocess = pid;
2634 /* If we managed to get status pipe check for exec fail */
2635 if (did_pipes && pid > 0) {
2640 while (n < sizeof(int)) {
2641 n1 = PerlLIO_read(pp[0],
2642 (void*)(((char*)&errkid)+n),
2648 PerlLIO_close(pp[0]);
2650 if (n) { /* Error */
2652 PerlLIO_close(p[This]);
2653 if (n != sizeof(int))
2654 Perl_croak(aTHX_ "panic: kid popen errno read");
2656 pid2 = wait4pid(pid, &status, 0);
2657 } while (pid2 == -1 && errno == EINTR);
2658 errno = errkid; /* Propagate errno from kid */
2663 PerlLIO_close(pp[0]);
2664 return PerlIO_fdopen(p[This], mode);
2666 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2667 return my_syspopen4(aTHX_ NULL, mode, n, args);
2669 Perl_croak(aTHX_ "List form of piped open not implemented");
2670 return (PerlIO *) NULL;
2675 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2676 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
2678 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2682 register I32 This, that;
2685 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2689 PERL_ARGS_ASSERT_MY_POPEN;
2691 PERL_FLUSHALL_FOR_CHILD;
2694 return my_syspopen(aTHX_ cmd,mode);
2697 This = (*mode == 'w');
2699 if (doexec && PL_tainting) {
2701 taint_proper("Insecure %s%s", "EXEC");
2703 if (PerlProc_pipe(p) < 0)
2705 if (doexec && PerlProc_pipe(pp) >= 0)
2707 while ((pid = PerlProc_fork()) < 0) {
2708 if (errno != EAGAIN) {
2709 PerlLIO_close(p[This]);
2710 PerlLIO_close(p[that]);
2712 PerlLIO_close(pp[0]);
2713 PerlLIO_close(pp[1]);
2716 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2719 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2729 PerlLIO_close(pp[0]);
2730 #if defined(HAS_FCNTL) && defined(F_SETFD)
2731 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2734 if (p[THIS] != (*mode == 'r')) {
2735 PerlLIO_dup2(p[THIS], *mode == 'r');
2736 PerlLIO_close(p[THIS]);
2737 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2738 PerlLIO_close(p[THAT]);
2741 PerlLIO_close(p[THAT]);
2744 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2751 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2756 /* may or may not use the shell */
2757 do_exec3(cmd, pp[1], did_pipes);
2760 #endif /* defined OS2 */
2762 #ifdef PERLIO_USING_CRLF
2763 /* Since we circumvent IO layers when we manipulate low-level
2764 filedescriptors directly, need to manually switch to the
2765 default, binary, low-level mode; see PerlIOBuf_open(). */
2766 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2768 #ifdef THREADS_HAVE_PIDS
2769 PL_ppid = (IV)getppid();
2772 #ifdef PERL_USES_PL_PIDSTATUS
2773 hv_clear(PL_pidstatus); /* we have no children */
2779 do_execfree(); /* free any memory malloced by child on vfork */
2781 PerlLIO_close(pp[1]);
2782 if (p[that] < p[This]) {
2783 PerlLIO_dup2(p[This], p[that]);
2784 PerlLIO_close(p[This]);
2788 PerlLIO_close(p[that]);
2790 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2791 SvUPGRADE(sv,SVt_IV);
2793 PL_forkprocess = pid;
2794 if (did_pipes && pid > 0) {
2799 while (n < sizeof(int)) {
2800 n1 = PerlLIO_read(pp[0],
2801 (void*)(((char*)&errkid)+n),
2807 PerlLIO_close(pp[0]);
2809 if (n) { /* Error */
2811 PerlLIO_close(p[This]);
2812 if (n != sizeof(int))
2813 Perl_croak(aTHX_ "panic: kid popen errno read");
2815 pid2 = wait4pid(pid, &status, 0);
2816 } while (pid2 == -1 && errno == EINTR);
2817 errno = errkid; /* Propagate errno from kid */
2822 PerlLIO_close(pp[0]);
2823 return PerlIO_fdopen(p[This], mode);
2826 #if defined(atarist) || defined(EPOC)
2829 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2831 PERL_ARGS_ASSERT_MY_POPEN;
2832 PERL_FLUSHALL_FOR_CHILD;
2833 /* Call system's popen() to get a FILE *, then import it.
2834 used 0 for 2nd parameter to PerlIO_importFILE;
2837 return PerlIO_importFILE(popen(cmd, mode), 0);
2841 FILE *djgpp_popen();
2843 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2845 PERL_FLUSHALL_FOR_CHILD;
2846 /* Call system's popen() to get a FILE *, then import it.
2847 used 0 for 2nd parameter to PerlIO_importFILE;
2850 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2853 #if defined(__LIBCATAMOUNT__)
2855 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2863 #endif /* !DOSISH */
2865 /* this is called in parent before the fork() */
2867 Perl_atfork_lock(void)
2870 #if defined(USE_ITHREADS)
2871 /* locks must be held in locking order (if any) */
2873 MUTEX_LOCK(&PL_malloc_mutex);
2879 /* this is called in both parent and child after the fork() */
2881 Perl_atfork_unlock(void)
2884 #if defined(USE_ITHREADS)
2885 /* locks must be released in same order as in atfork_lock() */
2887 MUTEX_UNLOCK(&PL_malloc_mutex);
2896 #if defined(HAS_FORK)
2898 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2903 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2904 * handlers elsewhere in the code */
2909 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2910 Perl_croak_nocontext("fork() not available");
2912 #endif /* HAS_FORK */
2917 Perl_dump_fds(pTHX_ const char *const s)
2922 PERL_ARGS_ASSERT_DUMP_FDS;
2924 PerlIO_printf(Perl_debug_log,"%s", s);
2925 for (fd = 0; fd < 32; fd++) {
2926 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2927 PerlIO_printf(Perl_debug_log," %d",fd);
2929 PerlIO_printf(Perl_debug_log,"\n");
2932 #endif /* DUMP_FDS */
2936 dup2(int oldfd, int newfd)
2938 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2941 PerlLIO_close(newfd);
2942 return fcntl(oldfd, F_DUPFD, newfd);
2944 #define DUP2_MAX_FDS 256
2945 int fdtmp[DUP2_MAX_FDS];
2951 PerlLIO_close(newfd);
2952 /* good enough for low fd's... */
2953 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2954 if (fdx >= DUP2_MAX_FDS) {
2962 PerlLIO_close(fdtmp[--fdx]);
2969 #ifdef HAS_SIGACTION
2972 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2975 struct sigaction act, oact;
2978 /* only "parent" interpreter can diddle signals */
2979 if (PL_curinterp != aTHX)
2980 return (Sighandler_t) SIG_ERR;
2983 act.sa_handler = (void(*)(int))handler;
2984 sigemptyset(&act.sa_mask);
2987 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2988 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2990 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2991 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2992 act.sa_flags |= SA_NOCLDWAIT;
2994 if (sigaction(signo, &act, &oact) == -1)
2995 return (Sighandler_t) SIG_ERR;
2997 return (Sighandler_t) oact.sa_handler;
3001 Perl_rsignal_state(pTHX_ int signo)
3003 struct sigaction oact;
3004 PERL_UNUSED_CONTEXT;
3006 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
3007 return (Sighandler_t) SIG_ERR;
3009 return (Sighandler_t) oact.sa_handler;
3013 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3016 struct sigaction act;
3018 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
3021 /* only "parent" interpreter can diddle signals */
3022 if (PL_curinterp != aTHX)
3026 act.sa_handler = (void(*)(int))handler;
3027 sigemptyset(&act.sa_mask);
3030 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
3031 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
3033 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
3034 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
3035 act.sa_flags |= SA_NOCLDWAIT;
3037 return sigaction(signo, &act, save);
3041 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3045 /* only "parent" interpreter can diddle signals */
3046 if (PL_curinterp != aTHX)
3050 return sigaction(signo, save, (struct sigaction *)NULL);
3053 #else /* !HAS_SIGACTION */
3056 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
3058 #if defined(USE_ITHREADS) && !defined(WIN32)
3059 /* only "parent" interpreter can diddle signals */
3060 if (PL_curinterp != aTHX)
3061 return (Sighandler_t) SIG_ERR;
3064 return PerlProc_signal(signo, handler);
3075 Perl_rsignal_state(pTHX_ int signo)
3078 Sighandler_t oldsig;
3080 #if defined(USE_ITHREADS) && !defined(WIN32)
3081 /* only "parent" interpreter can diddle signals */
3082 if (PL_curinterp != aTHX)
3083 return (Sighandler_t) SIG_ERR;
3087 oldsig = PerlProc_signal(signo, sig_trap);
3088 PerlProc_signal(signo, oldsig);
3090 PerlProc_kill(PerlProc_getpid(), signo);
3095 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
3097 #if defined(USE_ITHREADS) && !defined(WIN32)
3098 /* only "parent" interpreter can diddle signals */
3099 if (PL_curinterp != aTHX)
3102 *save = PerlProc_signal(signo, handler);
3103 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
3107 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
3109 #if defined(USE_ITHREADS) && !defined(WIN32)
3110 /* only "parent" interpreter can diddle signals */
3111 if (PL_curinterp != aTHX)
3114 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
3117 #endif /* !HAS_SIGACTION */
3118 #endif /* !PERL_MICRO */
3120 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
3121 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__OPEN_VM) && !defined(EPOC) && !defined(__LIBCATAMOUNT__)
3123 Perl_my_pclose(pTHX_ PerlIO *ptr)
3126 Sigsave_t hstat, istat, qstat;
3133 const int fd = PerlIO_fileno(ptr);
3136 /* Find out whether the refcount is low enough for us to wait for the
3137 child proc without blocking. */
3138 const bool should_wait = PerlIOUnix_refcnt(fd) == 1;
3140 const bool should_wait = 1;
3143 svp = av_fetch(PL_fdpid,fd,TRUE);
3144 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3146 *svp = &PL_sv_undef;
3148 if (pid == -1) { /* Opened by popen. */
3149 return my_syspclose(ptr);
3152 close_failed = (PerlIO_close(ptr) == EOF);
3155 if(PerlProc_kill(pid, 0) < 0) { return(pid); } /* HOM 12/23/91 */
3158 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3159 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3160 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3162 if (should_wait) do {
3163 pid2 = wait4pid(pid, &status, 0);
3164 } while (pid2 == -1 && errno == EINTR);
3166 rsignal_restore(SIGHUP, &hstat);
3167 rsignal_restore(SIGINT, &istat);
3168 rsignal_restore(SIGQUIT, &qstat);
3176 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3181 #if defined(__LIBCATAMOUNT__)
3183 Perl_my_pclose(pTHX_ PerlIO *ptr)
3188 #endif /* !DOSISH */
3190 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3192 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3196 PERL_ARGS_ASSERT_WAIT4PID;
3199 #ifdef PERL_USES_PL_PIDSTATUS
3202 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3203 pid, rather than a string form. */
3204 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3205 if (svp && *svp != &PL_sv_undef) {
3206 *statusp = SvIVX(*svp);
3207 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3215 hv_iterinit(PL_pidstatus);
3216 if ((entry = hv_iternext(PL_pidstatus))) {
3217 SV * const sv = hv_iterval(PL_pidstatus,entry);
3219 const char * const spid = hv_iterkey(entry,&len);
3221 assert (len == sizeof(Pid_t));
3222 memcpy((char *)&pid, spid, len);
3223 *statusp = SvIVX(sv);
3224 /* The hash iterator is currently on this entry, so simply
3225 calling hv_delete would trigger the lazy delete, which on
3226 aggregate does more work, beacuse next call to hv_iterinit()
3227 would spot the flag, and have to call the delete routine,
3228 while in the meantime any new entries can't re-use that
3230 hv_iterinit(PL_pidstatus);
3231 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3238 # ifdef HAS_WAITPID_RUNTIME
3239 if (!HAS_WAITPID_RUNTIME)
3242 result = PerlProc_waitpid(pid,statusp,flags);
3245 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3246 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3249 #ifdef PERL_USES_PL_PIDSTATUS
3250 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3255 Perl_croak(aTHX_ "Can't do waitpid with flags");
3257 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3258 pidgone(result,*statusp);
3264 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3267 if (result < 0 && errno == EINTR) {
3269 errno = EINTR; /* reset in case a signal handler changed $! */
3273 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3275 #ifdef PERL_USES_PL_PIDSTATUS
3277 S_pidgone(pTHX_ Pid_t pid, int status)
3281 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3282 SvUPGRADE(sv,SVt_IV);
3283 SvIV_set(sv, status);
3288 #if defined(atarist) || defined(OS2) || defined(EPOC)
3291 int /* Cannot prototype with I32
3293 my_syspclose(PerlIO *ptr)
3296 Perl_my_pclose(pTHX_ PerlIO *ptr)
3299 /* Needs work for PerlIO ! */
3300 FILE * const f = PerlIO_findFILE(ptr);
3301 const I32 result = pclose(f);
3302 PerlIO_releaseFILE(ptr,f);
3310 Perl_my_pclose(pTHX_ PerlIO *ptr)
3312 /* Needs work for PerlIO ! */
3313 FILE * const f = PerlIO_findFILE(ptr);
3314 I32 result = djgpp_pclose(f);
3315 result = (result << 8) & 0xff00;
3316 PerlIO_releaseFILE(ptr,f);
3321 #define PERL_REPEATCPY_LINEAR 4
3323 Perl_repeatcpy(register char *to, register const char *from, I32 len, register I32 count)
3325 PERL_ARGS_ASSERT_REPEATCPY;
3328 memset(to, *from, count);
3330 register char *p = to;
3331 I32 items, linear, half;
3333 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3334 for (items = 0; items < linear; ++items) {
3335 register const char *q = from;
3337 for (todo = len; todo > 0; todo--)
3342 while (items <= half) {
3343 I32 size = items * len;
3344 memcpy(p, to, size);
3350 memcpy(p, to, (count - items) * len);
3356 Perl_same_dirent(pTHX_ const char *a, const char *b)
3358 char *fa = strrchr(a,'/');
3359 char *fb = strrchr(b,'/');
3362 SV * const tmpsv = sv_newmortal();
3364 PERL_ARGS_ASSERT_SAME_DIRENT;
3377 sv_setpvs(tmpsv, ".");
3379 sv_setpvn(tmpsv, a, fa - a);
3380 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3383 sv_setpvs(tmpsv, ".");
3385 sv_setpvn(tmpsv, b, fb - b);
3386 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3388 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3389 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3391 #endif /* !HAS_RENAME */
3394 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3395 const char *const *const search_ext, I32 flags)
3398 const char *xfound = NULL;
3399 char *xfailed = NULL;
3400 char tmpbuf[MAXPATHLEN];
3405 #if defined(DOSISH) && !defined(OS2) && !defined(atarist)
3406 # define SEARCH_EXTS ".bat", ".cmd", NULL
3407 # define MAX_EXT_LEN 4
3410 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3411 # define MAX_EXT_LEN 4
3414 # define SEARCH_EXTS ".pl", ".com", NULL
3415 # define MAX_EXT_LEN 4
3417 /* additional extensions to try in each dir if scriptname not found */
3419 static const char *const exts[] = { SEARCH_EXTS };
3420 const char *const *const ext = search_ext ? search_ext : exts;
3421 int extidx = 0, i = 0;
3422 const char *curext = NULL;
3424 PERL_UNUSED_ARG(search_ext);
3425 # define MAX_EXT_LEN 0
3428 PERL_ARGS_ASSERT_FIND_SCRIPT;
3431 * If dosearch is true and if scriptname does not contain path
3432 * delimiters, search the PATH for scriptname.
3434 * If SEARCH_EXTS is also defined, will look for each
3435 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3436 * while searching the PATH.
3438 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3439 * proceeds as follows:
3440 * If DOSISH or VMSISH:
3441 * + look for ./scriptname{,.foo,.bar}
3442 * + search the PATH for scriptname{,.foo,.bar}
3445 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3446 * this will not look in '.' if it's not in the PATH)
3451 # ifdef ALWAYS_DEFTYPES
3452 len = strlen(scriptname);
3453 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3454 int idx = 0, deftypes = 1;
3457 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3460 int idx = 0, deftypes = 1;
3463 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3465 /* The first time through, just add SEARCH_EXTS to whatever we
3466 * already have, so we can check for default file types. */
3468 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3474 if ((strlen(tmpbuf) + strlen(scriptname)
3475 + MAX_EXT_LEN) >= sizeof tmpbuf)
3476 continue; /* don't search dir with too-long name */
3477 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3481 if (strEQ(scriptname, "-"))
3483 if (dosearch) { /* Look in '.' first. */
3484 const char *cur = scriptname;
3486 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3488 if (strEQ(ext[i++],curext)) {
3489 extidx = -1; /* already has an ext */
3494 DEBUG_p(PerlIO_printf(Perl_debug_log,
3495 "Looking for %s\n",cur));
3496 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3497 && !S_ISDIR(PL_statbuf.st_mode)) {
3505 if (cur == scriptname) {
3506 len = strlen(scriptname);
3507 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3509 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3512 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3513 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3518 if (dosearch && !strchr(scriptname, '/')
3520 && !strchr(scriptname, '\\')
3522 && (s = PerlEnv_getenv("PATH")))
3526 bufend = s + strlen(s);
3527 while (s < bufend) {
3528 #if defined(atarist) || defined(DOSISH)
3533 && *s != ';'; len++, s++) {
3534 if (len < sizeof tmpbuf)
3537 if (len < sizeof tmpbuf)
3539 #else /* ! (atarist || DOSISH) */
3540 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3543 #endif /* ! (atarist || DOSISH) */
3546 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3547 continue; /* don't search dir with too-long name */
3549 # if defined(atarist) || defined(DOSISH)
3550 && tmpbuf[len - 1] != '/'
3551 && tmpbuf[len - 1] != '\\'
3554 tmpbuf[len++] = '/';
3555 if (len == 2 && tmpbuf[0] == '.')
3557 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3561 len = strlen(tmpbuf);
3562 if (extidx > 0) /* reset after previous loop */
3566 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3567 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3568 if (S_ISDIR(PL_statbuf.st_mode)) {
3572 } while ( retval < 0 /* not there */
3573 && extidx>=0 && ext[extidx] /* try an extension? */
3574 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3579 if (S_ISREG(PL_statbuf.st_mode)
3580 && cando(S_IRUSR,TRUE,&PL_statbuf)
3581 #if !defined(DOSISH)
3582 && cando(S_IXUSR,TRUE,&PL_statbuf)
3586 xfound = tmpbuf; /* bingo! */
3590 xfailed = savepv(tmpbuf);
3593 if (!xfound && !seen_dot && !xfailed &&
3594 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3595 || S_ISDIR(PL_statbuf.st_mode)))
3597 seen_dot = 1; /* Disable message. */
3599 if (flags & 1) { /* do or die? */
3600 Perl_croak(aTHX_ "Can't %s %s%s%s",
3601 (xfailed ? "execute" : "find"),
3602 (xfailed ? xfailed : scriptname),
3603 (xfailed ? "" : " on PATH"),
3604 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3609 scriptname = xfound;
3611 return (scriptname ? savepv(scriptname) : NULL);
3614 #ifndef PERL_GET_CONTEXT_DEFINED
3617 Perl_get_context(void)
3620 #if defined(USE_ITHREADS)
3621 # ifdef OLD_PTHREADS_API
3623 if (pthread_getspecific(PL_thr_key, &t))
3624 Perl_croak_nocontext("panic: pthread_getspecific");
3627 # ifdef I_MACH_CTHREADS
3628 return (void*)cthread_data(cthread_self());
3630 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3639 Perl_set_context(void *t)
3642 PERL_ARGS_ASSERT_SET_CONTEXT;
3643 #if defined(USE_ITHREADS)
3644 # ifdef I_MACH_CTHREADS
3645 cthread_set_data(cthread_self(), t);
3647 if (pthread_setspecific(PL_thr_key, t))
3648 Perl_croak_nocontext("panic: pthread_setspecific");
3655 #endif /* !PERL_GET_CONTEXT_DEFINED */
3657 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3666 Perl_get_op_names(pTHX)
3668 PERL_UNUSED_CONTEXT;
3669 return (char **)PL_op_name;
3673 Perl_get_op_descs(pTHX)
3675 PERL_UNUSED_CONTEXT;
3676 return (char **)PL_op_desc;
3680 Perl_get_no_modify(pTHX)
3682 PERL_UNUSED_CONTEXT;
3683 return PL_no_modify;
3687 Perl_get_opargs(pTHX)
3689 PERL_UNUSED_CONTEXT;
3690 return (U32 *)PL_opargs;
3694 Perl_get_ppaddr(pTHX)
3697 PERL_UNUSED_CONTEXT;
3698 return (PPADDR_t*)PL_ppaddr;
3701 #ifndef HAS_GETENV_LEN
3703 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3705 char * const env_trans = PerlEnv_getenv(env_elem);
3706 PERL_UNUSED_CONTEXT;
3707 PERL_ARGS_ASSERT_GETENV_LEN;
3709 *len = strlen(env_trans);
3716 Perl_get_vtbl(pTHX_ int vtbl_id)
3718 const MGVTBL* result;
3719 PERL_UNUSED_CONTEXT;
3723 result = &PL_vtbl_sv;
3726 result = &PL_vtbl_env;
3728 case want_vtbl_envelem:
3729 result = &PL_vtbl_envelem;
3732 result = &PL_vtbl_sig;
3734 case want_vtbl_sigelem:
3735 result = &PL_vtbl_sigelem;
3737 case want_vtbl_pack:
3738 result = &PL_vtbl_pack;
3740 case want_vtbl_packelem:
3741 result = &PL_vtbl_packelem;
3743 case want_vtbl_dbline:
3744 result = &PL_vtbl_dbline;
3747 result = &PL_vtbl_isa;
3749 case want_vtbl_isaelem:
3750 result = &PL_vtbl_isaelem;
3752 case want_vtbl_arylen:
3753 result = &PL_vtbl_arylen;
3755 case want_vtbl_mglob:
3756 result = &PL_vtbl_mglob;
3758 case want_vtbl_nkeys:
3759 result = &PL_vtbl_nkeys;
3761 case want_vtbl_taint:
3762 result = &PL_vtbl_taint;
3764 case want_vtbl_substr:
3765 result = &PL_vtbl_substr;
3768 result = &PL_vtbl_vec;
3771 result = &PL_vtbl_pos;
3774 result = &PL_vtbl_bm;
3777 result = &PL_vtbl_fm;
3779 case want_vtbl_uvar:
3780 result = &PL_vtbl_uvar;
3782 case want_vtbl_defelem:
3783 result = &PL_vtbl_defelem;
3785 case want_vtbl_regexp:
3786 result = &PL_vtbl_regexp;
3788 case want_vtbl_regdata:
3789 result = &PL_vtbl_regdata;
3791 case want_vtbl_regdatum:
3792 result = &PL_vtbl_regdatum;
3794 #ifdef USE_LOCALE_COLLATE
3795 case want_vtbl_collxfrm:
3796 result = &PL_vtbl_collxfrm;
3799 case want_vtbl_amagic:
3800 result = &PL_vtbl_amagic;
3802 case want_vtbl_amagicelem:
3803 result = &PL_vtbl_amagicelem;
3805 case want_vtbl_backref:
3806 result = &PL_vtbl_backref;
3808 case want_vtbl_utf8:
3809 result = &PL_vtbl_utf8;
3815 return (MGVTBL*)result;
3819 Perl_my_fflush_all(pTHX)
3821 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3822 return PerlIO_flush(NULL);
3824 # if defined(HAS__FWALK)
3825 extern int fflush(FILE *);
3826 /* undocumented, unprototyped, but very useful BSDism */
3827 extern void _fwalk(int (*)(FILE *));
3831 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3833 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3834 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3836 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3837 open_max = sysconf(_SC_OPEN_MAX);
3840 open_max = FOPEN_MAX;
3843 open_max = OPEN_MAX;
3854 for (i = 0; i < open_max; i++)
3855 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3856 STDIO_STREAM_ARRAY[i]._file < open_max &&
3857 STDIO_STREAM_ARRAY[i]._flag)
3858 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3862 SETERRNO(EBADF,RMS_IFI);
3869 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3871 if (ckWARN(WARN_IO)) {
3872 const char * const name
3873 = gv && (isGV(gv) || isGV_with_GP(gv)) ? GvENAME(gv) : NULL;
3874 const char * const direction = have == '>' ? "out" : "in";
3877 Perl_warner(aTHX_ packWARN(WARN_IO),
3878 "Filehandle %s opened only for %sput",
3881 Perl_warner(aTHX_ packWARN(WARN_IO),
3882 "Filehandle opened only for %sput", direction);
3887 Perl_report_evil_fh(pTHX_ const GV *gv)
3889 const IO *io = gv ? GvIO(gv) : NULL;
3890 const PERL_BITFIELD16 op = PL_op->op_type;
3894 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3896 warn_type = WARN_CLOSED;
3900 warn_type = WARN_UNOPENED;
3903 if (ckWARN(warn_type)) {
3904 const char * const name
3905 = gv && (isGV(gv) || isGV_with_GP(gv)) ? GvENAME(gv) : NULL;
3906 const char * const pars =
3907 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3908 const char * const func =
3910 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3911 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3913 const char * const type =
3915 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3916 ? "socket" : "filehandle");
3917 if (name && *name) {
3918 Perl_warner(aTHX_ packWARN(warn_type),
3919 "%s%s on %s %s %s", func, pars, vile, type, name);
3920 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3922 aTHX_ packWARN(warn_type),
3923 "\t(Are you trying to call %s%s on dirhandle %s?)\n",
3928 Perl_warner(aTHX_ packWARN(warn_type),
3929 "%s%s on %s %s", func, pars, vile, type);
3930 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3932 aTHX_ packWARN(warn_type),
3933 "\t(Are you trying to call %s%s on dirhandle?)\n",
3940 /* To workaround core dumps from the uninitialised tm_zone we get the
3941 * system to give us a reasonable struct to copy. This fix means that
3942 * strftime uses the tm_zone and tm_gmtoff values returned by
3943 * localtime(time()). That should give the desired result most of the
3944 * time. But probably not always!
3946 * This does not address tzname aspects of NETaa14816.
3951 # ifndef STRUCT_TM_HASZONE
3952 # define STRUCT_TM_HASZONE
3956 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3957 # ifndef HAS_TM_TM_ZONE
3958 # define HAS_TM_TM_ZONE
3963 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3965 #ifdef HAS_TM_TM_ZONE
3967 const struct tm* my_tm;
3968 PERL_ARGS_ASSERT_INIT_TM;
3970 my_tm = localtime(&now);
3972 Copy(my_tm, ptm, 1, struct tm);
3974 PERL_ARGS_ASSERT_INIT_TM;
3975 PERL_UNUSED_ARG(ptm);
3980 * mini_mktime - normalise struct tm values without the localtime()
3981 * semantics (and overhead) of mktime().
3984 Perl_mini_mktime(pTHX_ struct tm *ptm)
3988 int month, mday, year, jday;
3989 int odd_cent, odd_year;
3990 PERL_UNUSED_CONTEXT;
3992 PERL_ARGS_ASSERT_MINI_MKTIME;
3994 #define DAYS_PER_YEAR 365
3995 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3996 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3997 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3998 #define SECS_PER_HOUR (60*60)
3999 #define SECS_PER_DAY (24*SECS_PER_HOUR)
4000 /* parentheses deliberately absent on these two, otherwise they don't work */
4001 #define MONTH_TO_DAYS 153/5
4002 #define DAYS_TO_MONTH 5/153
4003 /* offset to bias by March (month 4) 1st between month/mday & year finding */
4004 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
4005 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
4006 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
4009 * Year/day algorithm notes:
4011 * With a suitable offset for numeric value of the month, one can find
4012 * an offset into the year by considering months to have 30.6 (153/5) days,
4013 * using integer arithmetic (i.e., with truncation). To avoid too much
4014 * messing about with leap days, we consider January and February to be
4015 * the 13th and 14th month of the previous year. After that transformation,
4016 * we need the month index we use to be high by 1 from 'normal human' usage,
4017 * so the month index values we use run from 4 through 15.
4019 * Given that, and the rules for the Gregorian calendar (leap years are those
4020 * divisible by 4 unless also divisible by 100, when they must be divisible
4021 * by 400 instead), we can simply calculate the number of days since some
4022 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
4023 * the days we derive from our month index, and adding in the day of the
4024 * month. The value used here is not adjusted for the actual origin which
4025 * it normally would use (1 January A.D. 1), since we're not exposing it.
4026 * We're only building the value so we can turn around and get the
4027 * normalised values for the year, month, day-of-month, and day-of-year.
4029 * For going backward, we need to bias the value we're using so that we find
4030 * the right year value. (Basically, we don't want the contribution of
4031 * March 1st to the number to apply while deriving the year). Having done
4032 * that, we 'count up' the contribution to the year number by accounting for
4033 * full quadracenturies (400-year periods) with their extra leap days, plus
4034 * the contribution from full centuries (to avoid counting in the lost leap
4035 * days), plus the contribution from full quad-years (to count in the normal
4036 * leap days), plus the leftover contribution from any non-leap years.
4037 * At this point, if we were working with an actual leap day, we'll have 0
4038 * days left over. This is also true for March 1st, however. So, we have
4039 * to special-case that result, and (earlier) keep track of the 'odd'
4040 * century and year contributions. If we got 4 extra centuries in a qcent,
4041 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
4042 * Otherwise, we add back in the earlier bias we removed (the 123 from
4043 * figuring in March 1st), find the month index (integer division by 30.6),
4044 * and the remainder is the day-of-month. We then have to convert back to
4045 * 'real' months (including fixing January and February from being 14/15 in
4046 * the previous year to being in the proper year). After that, to get
4047 * tm_yday, we work with the normalised year and get a new yearday value for
4048 * January 1st, which we subtract from the yearday value we had earlier,
4049 * representing the date we've re-built. This is done from January 1
4050 * because tm_yday is 0-origin.
4052 * Since POSIX time routines are only guaranteed to work for times since the
4053 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
4054 * applies Gregorian calendar rules even to dates before the 16th century
4055 * doesn't bother me. Besides, you'd need cultural context for a given
4056 * date to know whether it was Julian or Gregorian calendar, and that's
4057 * outside the scope for this routine. Since we convert back based on the
4058 * same rules we used to build the yearday, you'll only get strange results
4059 * for input which needed normalising, or for the 'odd' century years which
4060 * were leap years in the Julian calendar but not in the Gregorian one.
4061 * I can live with that.
4063 * This algorithm also fails to handle years before A.D. 1 gracefully, but
4064 * that's still outside the scope for POSIX time manipulation, so I don't
4068 year = 1900 + ptm->tm_year;
4069 month = ptm->tm_mon;
4070 mday = ptm->tm_mday;
4071 /* allow given yday with no month & mday to dominate the result */
4072 if (ptm->tm_yday >= 0 && mday <= 0 && month <= 0) {
4075 jday = 1 + ptm->tm_yday;
4084 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
4085 yearday += month*MONTH_TO_DAYS + mday + jday;
4087 * Note that we don't know when leap-seconds were or will be,
4088 * so we have to trust the user if we get something which looks
4089 * like a sensible leap-second. Wild values for seconds will
4090 * be rationalised, however.
4092 if ((unsigned) ptm->tm_sec <= 60) {
4099 secs += 60 * ptm->tm_min;
4100 secs += SECS_PER_HOUR * ptm->tm_hour;
4102 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
4103 /* got negative remainder, but need positive time */
4104 /* back off an extra day to compensate */
4105 yearday += (secs/SECS_PER_DAY)-1;
4106 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
4109 yearday += (secs/SECS_PER_DAY);
4110 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
4113 else if (secs >= SECS_PER_DAY) {
4114 yearday += (secs/SECS_PER_DAY);
4115 secs %= SECS_PER_DAY;
4117 ptm->tm_hour = secs/SECS_PER_HOUR;
4118 secs %= SECS_PER_HOUR;
4119 ptm->tm_min = secs/60;
4121 ptm->tm_sec += secs;
4122 /* done with time of day effects */
4124 * The algorithm for yearday has (so far) left it high by 428.
4125 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
4126 * bias it by 123 while trying to figure out what year it
4127 * really represents. Even with this tweak, the reverse
4128 * translation fails for years before A.D. 0001.
4129 * It would still fail for Feb 29, but we catch that one below.
4131 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
4132 yearday -= YEAR_ADJUST;
4133 year = (yearday / DAYS_PER_QCENT) * 400;
4134 yearday %= DAYS_PER_QCENT;
4135 odd_cent = yearday / DAYS_PER_CENT;
4136 year += odd_cent * 100;
4137 yearday %= DAYS_PER_CENT;
4138 year += (yearday / DAYS_PER_QYEAR) * 4;
4139 yearday %= DAYS_PER_QYEAR;
4140 odd_year = yearday / DAYS_PER_YEAR;
4142 yearday %= DAYS_PER_YEAR;
4143 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
4148 yearday += YEAR_ADJUST; /* recover March 1st crock */
4149 month = yearday*DAYS_TO_MONTH;
4150 yearday -= month*MONTH_TO_DAYS;
4151 /* recover other leap-year adjustment */
4160 ptm->tm_year = year - 1900;
4162 ptm->tm_mday = yearday;
4163 ptm->tm_mon = month;
4167 ptm->tm_mon = month - 1;
4169 /* re-build yearday based on Jan 1 to get tm_yday */
4171 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
4172 yearday += 14*MONTH_TO_DAYS + 1;
4173 ptm->tm_yday = jday - yearday;
4174 /* fix tm_wday if not overridden by caller */
4175 if ((unsigned)ptm->tm_wday > 6)
4176 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
4180 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)
4188 PERL_ARGS_ASSERT_MY_STRFTIME;
4190 init_tm(&mytm); /* XXX workaround - see init_tm() above */
4193 mytm.tm_hour = hour;
4194 mytm.tm_mday = mday;
4196 mytm.tm_year = year;
4197 mytm.tm_wday = wday;
4198 mytm.tm_yday = yday;
4199 mytm.tm_isdst = isdst;
4201 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
4202 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
4207 #ifdef HAS_TM_TM_GMTOFF
4208 mytm.tm_gmtoff = mytm2.tm_gmtoff;
4210 #ifdef HAS_TM_TM_ZONE
4211 mytm.tm_zone = mytm2.tm_zone;
4216 Newx(buf, buflen, char);
4217 len = strftime(buf, buflen, fmt, &mytm);
4219 ** The following is needed to handle to the situation where
4220 ** tmpbuf overflows. Basically we want to allocate a buffer
4221 ** and try repeatedly. The reason why it is so complicated
4222 ** is that getting a return value of 0 from strftime can indicate
4223 ** one of the following:
4224 ** 1. buffer overflowed,
4225 ** 2. illegal conversion specifier, or
4226 ** 3. the format string specifies nothing to be returned(not
4227 ** an error). This could be because format is an empty string
4228 ** or it specifies %p that yields an empty string in some locale.
4229 ** If there is a better way to make it portable, go ahead by
4232 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
4235 /* Possibly buf overflowed - try again with a bigger buf */
4236 const int fmtlen = strlen(fmt);
4237 int bufsize = fmtlen + buflen;
4239 Renew(buf, bufsize, char);
4241 buflen = strftime(buf, bufsize, fmt, &mytm);
4242 if (buflen > 0 && buflen < bufsize)
4244 /* heuristic to prevent out-of-memory errors */
4245 if (bufsize > 100*fmtlen) {
4251 Renew(buf, bufsize, char);
4256 Perl_croak(aTHX_ "panic: no strftime");
4262 #define SV_CWD_RETURN_UNDEF \
4263 sv_setsv(sv, &PL_sv_undef); \
4266 #define SV_CWD_ISDOT(dp) \
4267 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4268 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4271 =head1 Miscellaneous Functions
4273 =for apidoc getcwd_sv
4275 Fill the sv with current working directory
4280 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4281 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4282 * getcwd(3) if available
4283 * Comments from the orignal:
4284 * This is a faster version of getcwd. It's also more dangerous
4285 * because you might chdir out of a directory that you can't chdir
4289 Perl_getcwd_sv(pTHX_ register SV *sv)
4293 #ifndef INCOMPLETE_TAINTS
4297 PERL_ARGS_ASSERT_GETCWD_SV;
4301 char buf[MAXPATHLEN];
4303 /* Some getcwd()s automatically allocate a buffer of the given
4304 * size from the heap if they are given a NULL buffer pointer.
4305 * The problem is that this behaviour is not portable. */
4306 if (getcwd(buf, sizeof(buf) - 1)) {
4311 sv_setsv(sv, &PL_sv_undef);
4319 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4323 SvUPGRADE(sv, SVt_PV);
4325 if (PerlLIO_lstat(".", &statbuf) < 0) {
4326 SV_CWD_RETURN_UNDEF;
4329 orig_cdev = statbuf.st_dev;
4330 orig_cino = statbuf.st_ino;
4340 if (PerlDir_chdir("..") < 0) {
4341 SV_CWD_RETURN_UNDEF;
4343 if (PerlLIO_stat(".", &statbuf) < 0) {
4344 SV_CWD_RETURN_UNDEF;
4347 cdev = statbuf.st_dev;
4348 cino = statbuf.st_ino;
4350 if (odev == cdev && oino == cino) {
4353 if (!(dir = PerlDir_open("."))) {
4354 SV_CWD_RETURN_UNDEF;
4357 while ((dp = PerlDir_read(dir)) != NULL) {
4359 namelen = dp->d_namlen;
4361 namelen = strlen(dp->d_name);
4364 if (SV_CWD_ISDOT(dp)) {
4368 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4369 SV_CWD_RETURN_UNDEF;
4372 tdev = statbuf.st_dev;
4373 tino = statbuf.st_ino;
4374 if (tino == oino && tdev == odev) {
4380 SV_CWD_RETURN_UNDEF;
4383 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4384 SV_CWD_RETURN_UNDEF;
4387 SvGROW(sv, pathlen + namelen + 1);
4391 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4394 /* prepend current directory to the front */
4396 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4397 pathlen += (namelen + 1);
4399 #ifdef VOID_CLOSEDIR
4402 if (PerlDir_close(dir) < 0) {
4403 SV_CWD_RETURN_UNDEF;
4409 SvCUR_set(sv, pathlen);
4413 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4414 SV_CWD_RETURN_UNDEF;
4417 if (PerlLIO_stat(".", &statbuf) < 0) {
4418 SV_CWD_RETURN_UNDEF;
4421 cdev = statbuf.st_dev;
4422 cino = statbuf.st_ino;
4424 if (cdev != orig_cdev || cino != orig_cino) {
4425 Perl_croak(aTHX_ "Unstable directory path, "
4426 "current directory changed unexpectedly");
4437 #define VERSION_MAX 0x7FFFFFFF
4440 =for apidoc prescan_version
4442 Validate that a given string can be parsed as a version object, but doesn't
4443 actually perform the parsing. Can use either strict or lax validation rules.
4444 Can optionally set a number of hint variables to save the parsing code
4445 some time when tokenizing.
4450 Perl_prescan_version(pTHX_ const char *s, bool strict,
4451 const char **errstr,
4452 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4453 bool qv = (sqv ? *sqv : FALSE);
4455 int saw_decimal = 0;
4459 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4461 if (qv && isDIGIT(*d))
4462 goto dotted_decimal_version;
4464 if (*d == 'v') { /* explicit v-string */
4469 else { /* degenerate v-string */
4470 /* requires v1.2.3 */
4471 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4474 dotted_decimal_version:
4475 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4476 /* no leading zeros allowed */
4477 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4480 while (isDIGIT(*d)) /* integer part */
4486 d++; /* decimal point */
4491 /* require v1.2.3 */
4492 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4495 goto version_prescan_finish;
4502 while (isDIGIT(*d)) { /* just keep reading */
4504 while (isDIGIT(*d)) {
4506 /* maximum 3 digits between decimal */
4507 if (strict && j > 3) {
4508 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4513 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4516 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4521 else if (*d == '.') {
4523 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4528 else if (!isDIGIT(*d)) {
4534 if (strict && i < 2) {
4535 /* requires v1.2.3 */
4536 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4539 } /* end if dotted-decimal */
4541 { /* decimal versions */
4542 /* special strict case for leading '.' or '0' */
4545 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4547 if (*d == '0' && isDIGIT(d[1])) {
4548 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4552 /* consume all of the integer part */
4556 /* look for a fractional part */
4558 /* we found it, so consume it */
4562 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4565 BADVERSION(s,errstr,"Invalid version format (version required)");
4567 /* found just an integer */
4568 goto version_prescan_finish;
4570 else if ( d == s ) {
4571 /* didn't find either integer or period */
4572 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4574 else if (*d == '_') {
4575 /* underscore can't come after integer part */
4577 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4579 else if (isDIGIT(d[1])) {
4580 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4583 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4587 /* anything else after integer part is just invalid data */
4588 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4591 /* scan the fractional part after the decimal point*/
4593 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4594 /* strict or lax-but-not-the-end */
4595 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4598 while (isDIGIT(*d)) {
4600 if (*d == '.' && isDIGIT(d[-1])) {
4602 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4605 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4607 d = (char *)s; /* start all over again */
4609 goto dotted_decimal_version;
4613 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4616 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4618 if ( ! isDIGIT(d[1]) ) {
4619 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4627 version_prescan_finish:
4631 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4632 /* trailing non-numeric data */
4633 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4641 *ssaw_decimal = saw_decimal;
4648 =for apidoc scan_version
4650 Returns a pointer to the next character after the parsed
4651 version string, as well as upgrading the passed in SV to
4654 Function must be called with an already existing SV like
4657 s = scan_version(s, SV *sv, bool qv);
4659 Performs some preprocessing to the string to ensure that
4660 it has the correct characteristics of a version. Flags the
4661 object if it contains an underscore (which denotes this
4662 is an alpha version). The boolean qv denotes that the version
4663 should be interpreted as if it had multiple decimals, even if
4670 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4675 const char *errstr = NULL;
4676 int saw_decimal = 0;
4680 AV * const av = newAV();
4681 SV * const hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4683 PERL_ARGS_ASSERT_SCAN_VERSION;
4685 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4687 #ifndef NODEFAULT_SHAREKEYS
4688 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4691 while (isSPACE(*s)) /* leading whitespace is OK */
4694 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4696 /* "undef" is a special case and not an error */
4697 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4698 Perl_croak(aTHX_ "%s", errstr);
4708 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4710 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4711 if ( !qv && width < 3 )
4712 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4714 while (isDIGIT(*pos))
4716 if (!isALPHA(*pos)) {
4722 /* this is atoi() that delimits on underscores */
4723 const char *end = pos;
4727 /* the following if() will only be true after the decimal
4728 * point of a version originally created with a bare
4729 * floating point number, i.e. not quoted in any way
4731 if ( !qv && s > start && saw_decimal == 1 ) {
4735 rev += (*s - '0') * mult;
4737 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4738 || (PERL_ABS(rev) > VERSION_MAX )) {
4739 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4740 "Integer overflow in version %d",VERSION_MAX);
4751 while (--end >= s) {
4753 rev += (*end - '0') * mult;
4755 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4756 || (PERL_ABS(rev) > VERSION_MAX )) {
4757 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4758 "Integer overflow in version");
4767 /* Append revision */
4768 av_push(av, newSViv(rev));
4773 else if ( *pos == '.' )
4775 else if ( *pos == '_' && isDIGIT(pos[1]) )
4777 else if ( *pos == ',' && isDIGIT(pos[1]) )
4779 else if ( isDIGIT(*pos) )
4786 while ( isDIGIT(*pos) )
4791 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4799 if ( qv ) { /* quoted versions always get at least three terms*/
4800 I32 len = av_len(av);
4801 /* This for loop appears to trigger a compiler bug on OS X, as it
4802 loops infinitely. Yes, len is negative. No, it makes no sense.
4803 Compiler in question is:
4804 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4805 for ( len = 2 - len; len > 0; len-- )
4806 av_push(MUTABLE_AV(sv), newSViv(0));
4810 av_push(av, newSViv(0));
4813 /* need to save off the current version string for later */
4815 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4816 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4817 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4819 else if ( s > start ) {
4820 SV * orig = newSVpvn(start,s-start);
4821 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4822 /* need to insert a v to be consistent */
4823 sv_insert(orig, 0, 0, "v", 1);
4825 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4828 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4829 av_push(av, newSViv(0));
4832 /* And finally, store the AV in the hash */
4833 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4835 /* fix RT#19517 - special case 'undef' as string */
4836 if ( *s == 'u' && strEQ(s,"undef") ) {
4844 =for apidoc new_version
4846 Returns a new version object based on the passed in SV:
4848 SV *sv = new_version(SV *ver);
4850 Does not alter the passed in ver SV. See "upg_version" if you
4851 want to upgrade the SV.
4857 Perl_new_version(pTHX_ SV *ver)
4860 SV * const rv = newSV(0);
4861 PERL_ARGS_ASSERT_NEW_VERSION;
4862 if ( sv_derived_from(ver,"version") ) /* can just copy directly */
4865 AV * const av = newAV();
4867 /* This will get reblessed later if a derived class*/
4868 SV * const hv = newSVrv(rv, "version");
4869 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4870 #ifndef NODEFAULT_SHAREKEYS
4871 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4877 /* Begin copying all of the elements */
4878 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4879 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4881 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4882 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4884 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4886 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4887 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4890 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4892 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4893 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4896 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4897 /* This will get reblessed later if a derived class*/
4898 for ( key = 0; key <= av_len(sav); key++ )
4900 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4901 av_push(av, newSViv(rev));
4904 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4909 const MAGIC* const mg = SvVSTRING_mg(ver);
4910 if ( mg ) { /* already a v-string */
4911 const STRLEN len = mg->mg_len;
4912 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4913 sv_setpvn(rv,version,len);
4914 /* this is for consistency with the pure Perl class */
4915 if ( isDIGIT(*version) )
4916 sv_insert(rv, 0, 0, "v", 1);
4921 sv_setsv(rv,ver); /* make a duplicate */
4926 return upg_version(rv, FALSE);
4930 =for apidoc upg_version
4932 In-place upgrade of the supplied SV to a version object.
4934 SV *sv = upg_version(SV *sv, bool qv);
4936 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4937 to force this SV to be interpreted as an "extended" version.
4943 Perl_upg_version(pTHX_ SV *ver, bool qv)
4945 const char *version, *s;
4950 PERL_ARGS_ASSERT_UPG_VERSION;
4952 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4954 /* may get too much accuracy */
4956 #ifdef USE_LOCALE_NUMERIC
4957 char *loc = setlocale(LC_NUMERIC, "C");
4959 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4960 #ifdef USE_LOCALE_NUMERIC
4961 setlocale(LC_NUMERIC, loc);
4963 while (tbuf[len-1] == '0' && len > 0) len--;
4964 if ( tbuf[len-1] == '.' ) len--; /* eat the trailing decimal */
4965 version = savepvn(tbuf, len);
4968 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4969 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4973 else /* must be a string or something like a string */
4976 version = savepv(SvPV(ver,len));
4978 # if PERL_VERSION > 5
4979 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4980 if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
4981 /* may be a v-string */
4982 char *testv = (char *)version;
4984 for (tlen=0; tlen < len; tlen++, testv++) {
4985 /* if one of the characters is non-text assume v-string */
4986 if (testv[0] < ' ') {
4987 SV * const nsv = sv_newmortal();
4990 int saw_decimal = 0;
4991 sv_setpvf(nsv,"v%vd",ver);
4992 pos = nver = savepv(SvPV_nolen(nsv));
4994 /* scan the resulting formatted string */
4995 pos++; /* skip the leading 'v' */
4996 while ( *pos == '.' || isDIGIT(*pos) ) {
5002 /* is definitely a v-string */
5003 if ( saw_decimal >= 2 ) {
5015 s = scan_version(version, ver, qv);
5017 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
5018 "Version string '%s' contains invalid data; "
5019 "ignoring: '%s'", version, s);
5027 Validates that the SV contains valid internal structure for a version object.
5028 It may be passed either the version object (RV) or the hash itself (HV). If
5029 the structure is valid, it returns the HV. If the structure is invalid,
5032 SV *hv = vverify(sv);