3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Very useful, no doubt, that was to Saruman; yet it seems that he was
13 * not content.' --Gandalf to Pippin
15 * [p.598 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
18 /* This file contains assorted utility routines.
19 * Which is a polite way of saying any stuff that people couldn't think of
20 * a better place for. Amongst other things, it includes the warning and
21 * dieing stuff, plus wrappers for malloc code.
25 #define PERL_IN_UTIL_C
30 #include "perliol.h" /* For PerlIOUnix_refcnt */
36 # define SIG_ERR ((Sighandler_t) -1)
41 /* Missing protos on LynxOS */
47 # include <sys/select.h>
53 #if defined(HAS_FCNTL) && defined(F_SETFD) && !defined(FD_CLOEXEC)
54 # define FD_CLOEXEC 1 /* NeXT needs this */
57 /* NOTE: Do not call the next three routines directly. Use the macros
58 * in handy.h, so that we can easily redefine everything to do tracking of
59 * allocated hunks back to the original New to track down any memory leaks.
60 * XXX This advice seems to be widely ignored :-( --AD August 1996.
63 #if defined (DEBUGGING) || defined(PERL_IMPLICIT_SYS) || defined (PERL_TRACK_MEMPOOL)
64 # define ALWAYS_NEED_THX
67 /* paranoid version of system's malloc() */
70 Perl_safesysmalloc(MEM_SIZE size)
72 #ifdef ALWAYS_NEED_THX
78 PerlIO_printf(Perl_error_log,
79 "Allocation too large: %lx\n", size) FLUSH;
82 #endif /* HAS_64K_LIMIT */
83 #ifdef PERL_TRACK_MEMPOOL
87 if ((SSize_t)size < 0)
88 Perl_croak_nocontext("panic: malloc, size=%"UVuf, (UV) size);
90 ptr = (Malloc_t)PerlMem_malloc(size?size:1); /* malloc(0) is NASTY on our system */
91 PERL_ALLOC_CHECK(ptr);
93 #ifdef PERL_TRACK_MEMPOOL
94 struct perl_memory_debug_header *const header
95 = (struct perl_memory_debug_header *)ptr;
99 PoisonNew(((char *)ptr), size, char);
102 #ifdef PERL_TRACK_MEMPOOL
103 header->interpreter = aTHX;
104 /* Link us into the list. */
105 header->prev = &PL_memory_debug_header;
106 header->next = PL_memory_debug_header.next;
107 PL_memory_debug_header.next = header;
108 header->next->prev = header;
112 ptr = (Malloc_t)((char*)ptr+sTHX);
114 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) malloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
118 #ifndef ALWAYS_NEED_THX
130 /* paranoid version of system's realloc() */
133 Perl_safesysrealloc(Malloc_t where,MEM_SIZE size)
135 #ifdef ALWAYS_NEED_THX
139 #if !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) && !defined(PERL_MICRO)
140 Malloc_t PerlMem_realloc();
141 #endif /* !defined(STANDARD_C) && !defined(HAS_REALLOC_PROTOTYPE) */
145 PerlIO_printf(Perl_error_log,
146 "Reallocation too large: %lx\n", size) FLUSH;
149 #endif /* HAS_64K_LIMIT */
156 return safesysmalloc(size);
157 #ifdef PERL_TRACK_MEMPOOL
158 where = (Malloc_t)((char*)where-sTHX);
161 struct perl_memory_debug_header *const header
162 = (struct perl_memory_debug_header *)where;
164 if (header->interpreter != aTHX) {
165 Perl_croak_nocontext("panic: realloc from wrong pool, %p!=%p",
166 header->interpreter, aTHX);
168 assert(header->next->prev == header);
169 assert(header->prev->next == header);
171 if (header->size > size) {
172 const MEM_SIZE freed_up = header->size - size;
173 char *start_of_freed = ((char *)where) + size;
174 PoisonFree(start_of_freed, freed_up, char);
181 if ((SSize_t)size < 0)
182 Perl_croak_nocontext("panic: realloc, size=%"UVuf, (UV)size);
184 ptr = (Malloc_t)PerlMem_realloc(where,size);
185 PERL_ALLOC_CHECK(ptr);
187 /* MUST do this fixup first, before doing ANYTHING else, as anything else
188 might allocate memory/free/move memory, and until we do the fixup, it
189 may well be chasing (and writing to) free memory. */
190 #ifdef PERL_TRACK_MEMPOOL
192 struct perl_memory_debug_header *const header
193 = (struct perl_memory_debug_header *)ptr;
196 if (header->size < size) {
197 const MEM_SIZE fresh = size - header->size;
198 char *start_of_fresh = ((char *)ptr) + size;
199 PoisonNew(start_of_fresh, fresh, char);
203 header->next->prev = header;
204 header->prev->next = header;
206 ptr = (Malloc_t)((char*)ptr+sTHX);
210 /* In particular, must do that fixup above before logging anything via
211 *printf(), as it can reallocate memory, which can cause SEGVs. */
213 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) rfree\n",PTR2UV(where),(long)PL_an++));
214 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) realloc %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)size));
221 #ifndef ALWAYS_NEED_THX
233 /* safe version of system's free() */
236 Perl_safesysfree(Malloc_t where)
238 #ifdef ALWAYS_NEED_THX
243 DEBUG_m( PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) free\n",PTR2UV(where),(long)PL_an++));
245 #ifdef PERL_TRACK_MEMPOOL
246 where = (Malloc_t)((char*)where-sTHX);
248 struct perl_memory_debug_header *const header
249 = (struct perl_memory_debug_header *)where;
251 if (header->interpreter != aTHX) {
252 Perl_croak_nocontext("panic: free from wrong pool, %p!=%p",
253 header->interpreter, aTHX);
256 Perl_croak_nocontext("panic: duplicate free");
259 Perl_croak_nocontext("panic: bad free, header->next==NULL");
260 if (header->next->prev != header || header->prev->next != header) {
261 Perl_croak_nocontext("panic: bad free, ->next->prev=%p, "
262 "header=%p, ->prev->next=%p",
263 header->next->prev, header,
266 /* Unlink us from the chain. */
267 header->next->prev = header->prev;
268 header->prev->next = header->next;
270 PoisonNew(where, header->size, char);
272 /* Trigger the duplicate free warning. */
280 /* safe version of system's calloc() */
283 Perl_safesyscalloc(MEM_SIZE count, MEM_SIZE size)
285 #ifdef ALWAYS_NEED_THX
289 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
290 MEM_SIZE total_size = 0;
293 /* Even though calloc() for zero bytes is strange, be robust. */
294 if (size && (count <= MEM_SIZE_MAX / size)) {
295 #if defined(PERL_TRACK_MEMPOOL) || defined(HAS_64K_LIMIT) || defined(DEBUGGING)
296 total_size = size * count;
300 Perl_croak_memory_wrap();
301 #ifdef PERL_TRACK_MEMPOOL
302 if (sTHX <= MEM_SIZE_MAX - (MEM_SIZE)total_size)
305 Perl_croak_memory_wrap();
308 if (total_size > 0xffff) {
309 PerlIO_printf(Perl_error_log,
310 "Allocation too large: %lx\n", total_size) FLUSH;
313 #endif /* HAS_64K_LIMIT */
315 if ((SSize_t)size < 0 || (SSize_t)count < 0)
316 Perl_croak_nocontext("panic: calloc, size=%"UVuf", count=%"UVuf,
317 (UV)size, (UV)count);
319 #ifdef PERL_TRACK_MEMPOOL
320 /* Have to use malloc() because we've added some space for our tracking
322 /* malloc(0) is non-portable. */
323 ptr = (Malloc_t)PerlMem_malloc(total_size ? total_size : 1);
325 /* Use calloc() because it might save a memset() if the memory is fresh
326 and clean from the OS. */
328 ptr = (Malloc_t)PerlMem_calloc(count, size);
329 else /* calloc(0) is non-portable. */
330 ptr = (Malloc_t)PerlMem_calloc(count ? count : 1, size ? size : 1);
332 PERL_ALLOC_CHECK(ptr);
333 DEBUG_m(PerlIO_printf(Perl_debug_log, "0x%"UVxf": (%05ld) calloc %ld x %ld bytes\n",PTR2UV(ptr),(long)PL_an++,(long)count,(long)total_size));
335 #ifdef PERL_TRACK_MEMPOOL
337 struct perl_memory_debug_header *const header
338 = (struct perl_memory_debug_header *)ptr;
340 memset((void*)ptr, 0, total_size);
341 header->interpreter = aTHX;
342 /* Link us into the list. */
343 header->prev = &PL_memory_debug_header;
344 header->next = PL_memory_debug_header.next;
345 PL_memory_debug_header.next = header;
346 header->next->prev = header;
348 header->size = total_size;
350 ptr = (Malloc_t)((char*)ptr+sTHX);
356 #ifndef ALWAYS_NEED_THX
365 /* These must be defined when not using Perl's malloc for binary
370 Malloc_t Perl_malloc (MEM_SIZE nbytes)
373 return (Malloc_t)PerlMem_malloc(nbytes);
376 Malloc_t Perl_calloc (MEM_SIZE elements, MEM_SIZE size)
379 return (Malloc_t)PerlMem_calloc(elements, size);
382 Malloc_t Perl_realloc (Malloc_t where, MEM_SIZE nbytes)
385 return (Malloc_t)PerlMem_realloc(where, nbytes);
388 Free_t Perl_mfree (Malloc_t where)
396 /* copy a string up to some (non-backslashed) delimiter, if any */
399 Perl_delimcpy(char *to, const char *toend, const char *from, const char *fromend, int delim, I32 *retlen)
403 PERL_ARGS_ASSERT_DELIMCPY;
405 for (tolen = 0; from < fromend; from++, tolen++) {
407 if (from[1] != delim) {
414 else if (*from == delim)
425 /* return ptr to little string in big string, NULL if not found */
426 /* This routine was donated by Corey Satten. */
429 Perl_instr(const char *big, const char *little)
432 PERL_ARGS_ASSERT_INSTR;
434 /* libc prior to 4.6.27 did not work properly on a NULL 'little' */
437 return strstr((char*)big, (char*)little);
440 /* same as instr but allow embedded nulls. The end pointers point to 1 beyond
441 * the final character desired to be checked */
444 Perl_ninstr(const char *big, const char *bigend, const char *little, const char *lend)
446 PERL_ARGS_ASSERT_NINSTR;
450 const char first = *little;
452 bigend -= lend - little++;
454 while (big <= bigend) {
455 if (*big++ == first) {
456 for (x=big,s=little; s < lend; x++,s++) {
460 return (char*)(big-1);
467 /* reverse of the above--find last substring */
470 Perl_rninstr(const char *big, const char *bigend, const char *little, const char *lend)
473 const I32 first = *little;
474 const char * const littleend = lend;
476 PERL_ARGS_ASSERT_RNINSTR;
478 if (little >= littleend)
479 return (char*)bigend;
481 big = bigend - (littleend - little++);
482 while (big >= bigbeg) {
486 for (x=big+2,s=little; s < littleend; /**/ ) {
495 return (char*)(big+1);
500 /* As a space optimization, we do not compile tables for strings of length
501 0 and 1, and for strings of length 2 unless FBMcf_TAIL. These are
502 special-cased in fbm_instr().
504 If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
507 =head1 Miscellaneous Functions
509 =for apidoc fbm_compile
511 Analyses the string in order to make fast searches on it using fbm_instr()
512 -- the Boyer-Moore algorithm.
518 Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
528 PERL_ARGS_ASSERT_FBM_COMPILE;
530 if (isGV_with_GP(sv))
536 if (flags & FBMcf_TAIL) {
537 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
538 sv_catpvs(sv, "\n"); /* Taken into account in fbm_instr() */
539 if (mg && mg->mg_len >= 0)
542 s = (U8*)SvPV_force_mutable(sv, len);
543 if (len == 0) /* TAIL might be on a zero-length string. */
545 SvUPGRADE(sv, SVt_PVMG);
550 /* "deep magic", the comment used to add. The use of MAGIC itself isn't
551 really. MAGIC was originally added in 79072805bf63abe5 (perl 5.0 alpha 2)
552 to call SvVALID_off() if the scalar was assigned to.
554 The comment itself (and "deeper magic" below) date back to
555 378cc40b38293ffc (perl 2.0). "deep magic" was an annotation on
557 where the magic (presumably) was that the scalar had a BM table hidden
560 As MAGIC is always present on BMs [in Perl 5 :-)], we can use it to store
561 the table instead of the previous (somewhat hacky) approach of co-opting
562 the string buffer and storing it after the string. */
564 assert(!mg_find(sv, PERL_MAGIC_bm));
565 mg = sv_magicext(sv, NULL, PERL_MAGIC_bm, &PL_vtbl_bm, NULL, 0);
569 /* Shorter strings are special-cased in Perl_fbm_instr(), and don't use
571 const U8 mlen = (len>255) ? 255 : (U8)len;
572 const unsigned char *const sb = s + len - mlen; /* first char (maybe) */
575 Newx(table, 256, U8);
576 memset((void*)table, mlen, 256);
577 mg->mg_ptr = (char *)table;
580 s += len - 1; /* last char */
583 if (table[*s] == mlen)
589 s = (const unsigned char*)(SvPVX_const(sv)); /* deeper magic */
590 for (i = 0; i < len; i++) {
591 if (PL_freq[s[i]] < frequency) {
593 frequency = PL_freq[s[i]];
596 BmRARE(sv) = s[rarest];
597 BmPREVIOUS(sv) = rarest;
598 BmUSEFUL(sv) = 100; /* Initial value */
599 if (flags & FBMcf_TAIL)
601 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
602 BmRARE(sv), BmPREVIOUS(sv)));
605 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
606 /* If SvTAIL is actually due to \Z or \z, this gives false positives
610 =for apidoc fbm_instr
612 Returns the location of the SV in the string delimited by C<big> and
613 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
614 does not have to be fbm_compiled, but the search will not be as fast
621 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
625 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
626 STRLEN littlelen = l;
627 const I32 multiline = flags & FBMrf_MULTILINE;
629 PERL_ARGS_ASSERT_FBM_INSTR;
631 if ((STRLEN)(bigend - big) < littlelen) {
632 if ( SvTAIL(littlestr)
633 && ((STRLEN)(bigend - big) == littlelen - 1)
635 || (*big == *little &&
636 memEQ((char *)big, (char *)little, littlelen - 1))))
641 switch (littlelen) { /* Special cases for 0, 1 and 2 */
643 return (char*)big; /* Cannot be SvTAIL! */
645 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
646 /* Know that bigend != big. */
647 if (bigend[-1] == '\n')
648 return (char *)(bigend - 1);
649 return (char *) bigend;
657 if (SvTAIL(littlestr))
658 return (char *) bigend;
661 if (SvTAIL(littlestr) && !multiline) {
662 if (bigend[-1] == '\n' && bigend[-2] == *little)
663 return (char*)bigend - 2;
664 if (bigend[-1] == *little)
665 return (char*)bigend - 1;
669 /* This should be better than FBM if c1 == c2, and almost
670 as good otherwise: maybe better since we do less indirection.
671 And we save a lot of memory by caching no table. */
672 const unsigned char c1 = little[0];
673 const unsigned char c2 = little[1];
678 while (s <= bigend) {
688 goto check_1char_anchor;
699 goto check_1char_anchor;
702 while (s <= bigend) {
707 goto check_1char_anchor;
716 check_1char_anchor: /* One char and anchor! */
717 if (SvTAIL(littlestr) && (*bigend == *little))
718 return (char *)bigend; /* bigend is already decremented. */
721 break; /* Only lengths 0 1 and 2 have special-case code. */
724 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
725 s = bigend - littlelen;
726 if (s >= big && bigend[-1] == '\n' && *s == *little
727 /* Automatically of length > 2 */
728 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
730 return (char*)s; /* how sweet it is */
733 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
735 return (char*)s + 1; /* how sweet it is */
739 if (!SvVALID(littlestr)) {
740 char * const b = ninstr((char*)big,(char*)bigend,
741 (char*)little, (char*)little + littlelen);
743 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
744 /* Chop \n from littlestr: */
745 s = bigend - littlelen + 1;
747 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
757 if (littlelen > (STRLEN)(bigend - big))
761 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
762 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
763 const unsigned char *oldlittle;
765 --littlelen; /* Last char found by table lookup */
768 little += littlelen; /* last char */
774 if ((tmp = table[*s])) {
775 if ((s += tmp) < bigend)
779 else { /* less expensive than calling strncmp() */
780 unsigned char * const olds = s;
785 if (*--s == *--little)
787 s = olds + 1; /* here we pay the price for failure */
789 if (s < bigend) /* fake up continue to outer loop */
799 && memEQ((char *)(bigend - littlelen),
800 (char *)(oldlittle - littlelen), littlelen) )
801 return (char*)bigend - littlelen;
807 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
810 PERL_ARGS_ASSERT_SCREAMINSTR;
811 PERL_UNUSED_ARG(bigstr);
812 PERL_UNUSED_ARG(littlestr);
813 PERL_UNUSED_ARG(start_shift);
814 PERL_UNUSED_ARG(end_shift);
815 PERL_UNUSED_ARG(old_posp);
816 PERL_UNUSED_ARG(last);
818 /* This function must only ever be called on a scalar with study magic,
819 but those do not happen any more. */
820 Perl_croak(aTHX_ "panic: screaminstr");
827 Returns true if the leading len bytes of the strings s1 and s2 are the same
828 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
829 match themselves and their opposite case counterparts. Non-cased and non-ASCII
830 range bytes match only themselves.
837 Perl_foldEQ(const char *s1, const char *s2, I32 len)
839 const U8 *a = (const U8 *)s1;
840 const U8 *b = (const U8 *)s2;
842 PERL_ARGS_ASSERT_FOLDEQ;
847 if (*a != *b && *a != PL_fold[*b])
854 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
856 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
857 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
858 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
859 * does it check that the strings each have at least 'len' characters */
861 const U8 *a = (const U8 *)s1;
862 const U8 *b = (const U8 *)s2;
864 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
869 if (*a != *b && *a != PL_fold_latin1[*b]) {
878 =for apidoc foldEQ_locale
880 Returns true if the leading len bytes of the strings s1 and s2 are the same
881 case-insensitively in the current locale; false otherwise.
887 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
890 const U8 *a = (const U8 *)s1;
891 const U8 *b = (const U8 *)s2;
893 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
898 if (*a != *b && *a != PL_fold_locale[*b])
905 /* copy a string to a safe spot */
908 =head1 Memory Management
912 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
913 string which is a duplicate of C<pv>. The size of the string is
914 determined by C<strlen()>. The memory allocated for the new string can
915 be freed with the C<Safefree()> function.
921 Perl_savepv(pTHX_ const char *pv)
928 const STRLEN pvlen = strlen(pv)+1;
929 Newx(newaddr, pvlen, char);
930 return (char*)memcpy(newaddr, pv, pvlen);
934 /* same thing but with a known length */
939 Perl's version of what C<strndup()> would be if it existed. Returns a
940 pointer to a newly allocated string which is a duplicate of the first
941 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
942 the new string can be freed with the C<Safefree()> function.
948 Perl_savepvn(pTHX_ const char *pv, I32 len)
955 Newx(newaddr,len+1,char);
956 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
958 /* might not be null terminated */
960 return (char *) CopyD(pv,newaddr,len,char);
963 return (char *) ZeroD(newaddr,len+1,char);
968 =for apidoc savesharedpv
970 A version of C<savepv()> which allocates the duplicate string in memory
971 which is shared between threads.
976 Perl_savesharedpv(pTHX_ const char *pv)
983 pvlen = strlen(pv)+1;
984 newaddr = (char*)PerlMemShared_malloc(pvlen);
988 return (char*)memcpy(newaddr, pv, pvlen);
992 =for apidoc savesharedpvn
994 A version of C<savepvn()> which allocates the duplicate string in memory
995 which is shared between threads. (With the specific difference that a NULL
996 pointer is not acceptable)
1001 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1003 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1005 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1010 newaddr[len] = '\0';
1011 return (char*)memcpy(newaddr, pv, len);
1015 =for apidoc savesvpv
1017 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1018 the passed in SV using C<SvPV()>
1024 Perl_savesvpv(pTHX_ SV *sv)
1027 const char * const pv = SvPV_const(sv, len);
1030 PERL_ARGS_ASSERT_SAVESVPV;
1033 Newx(newaddr,len,char);
1034 return (char *) CopyD(pv,newaddr,len,char);
1038 =for apidoc savesharedsvpv
1040 A version of C<savesharedpv()> which allocates the duplicate string in
1041 memory which is shared between threads.
1047 Perl_savesharedsvpv(pTHX_ SV *sv)
1050 const char * const pv = SvPV_const(sv, len);
1052 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1054 return savesharedpvn(pv, len);
1057 /* the SV for Perl_form() and mess() is not kept in an arena */
1066 if (PL_phase != PERL_PHASE_DESTRUCT)
1067 return newSVpvs_flags("", SVs_TEMP);
1072 /* Create as PVMG now, to avoid any upgrading later */
1074 Newxz(any, 1, XPVMG);
1075 SvFLAGS(sv) = SVt_PVMG;
1076 SvANY(sv) = (void*)any;
1078 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1083 #if defined(PERL_IMPLICIT_CONTEXT)
1085 Perl_form_nocontext(const char* pat, ...)
1090 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1091 va_start(args, pat);
1092 retval = vform(pat, &args);
1096 #endif /* PERL_IMPLICIT_CONTEXT */
1099 =head1 Miscellaneous Functions
1102 Takes a sprintf-style format pattern and conventional
1103 (non-SV) arguments and returns the formatted string.
1105 (char *) Perl_form(pTHX_ const char* pat, ...)
1107 can be used any place a string (char *) is required:
1109 char * s = Perl_form("%d.%d",major,minor);
1111 Uses a single private buffer so if you want to format several strings you
1112 must explicitly copy the earlier strings away (and free the copies when you
1119 Perl_form(pTHX_ const char* pat, ...)
1123 PERL_ARGS_ASSERT_FORM;
1124 va_start(args, pat);
1125 retval = vform(pat, &args);
1131 Perl_vform(pTHX_ const char *pat, va_list *args)
1133 SV * const sv = mess_alloc();
1134 PERL_ARGS_ASSERT_VFORM;
1135 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1140 =for apidoc Am|SV *|mess|const char *pat|...
1142 Take a sprintf-style format pattern and argument list. These are used to
1143 generate a string message. If the message does not end with a newline,
1144 then it will be extended with some indication of the current location
1145 in the code, as described for L</mess_sv>.
1147 Normally, the resulting message is returned in a new mortal SV.
1148 During global destruction a single SV may be shared between uses of
1154 #if defined(PERL_IMPLICIT_CONTEXT)
1156 Perl_mess_nocontext(const char *pat, ...)
1161 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1162 va_start(args, pat);
1163 retval = vmess(pat, &args);
1167 #endif /* PERL_IMPLICIT_CONTEXT */
1170 Perl_mess(pTHX_ const char *pat, ...)
1174 PERL_ARGS_ASSERT_MESS;
1175 va_start(args, pat);
1176 retval = vmess(pat, &args);
1182 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1185 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1187 PERL_ARGS_ASSERT_CLOSEST_COP;
1189 if (!o || o == PL_op)
1192 if (o->op_flags & OPf_KIDS) {
1194 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1197 /* If the OP_NEXTSTATE has been optimised away we can still use it
1198 * the get the file and line number. */
1200 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1201 cop = (const COP *)kid;
1203 /* Keep searching, and return when we've found something. */
1205 new_cop = closest_cop(cop, kid);
1211 /* Nothing found. */
1217 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1219 Expands a message, intended for the user, to include an indication of
1220 the current location in the code, if the message does not already appear
1223 C<basemsg> is the initial message or object. If it is a reference, it
1224 will be used as-is and will be the result of this function. Otherwise it
1225 is used as a string, and if it already ends with a newline, it is taken
1226 to be complete, and the result of this function will be the same string.
1227 If the message does not end with a newline, then a segment such as C<at
1228 foo.pl line 37> will be appended, and possibly other clauses indicating
1229 the current state of execution. The resulting message will end with a
1232 Normally, the resulting message is returned in a new mortal SV.
1233 During global destruction a single SV may be shared between uses of this
1234 function. If C<consume> is true, then the function is permitted (but not
1235 required) to modify and return C<basemsg> instead of allocating a new SV.
1241 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1246 PERL_ARGS_ASSERT_MESS_SV;
1248 if (SvROK(basemsg)) {
1254 sv_setsv(sv, basemsg);
1259 if (SvPOK(basemsg) && consume) {
1264 sv_copypv(sv, basemsg);
1267 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1269 * Try and find the file and line for PL_op. This will usually be
1270 * PL_curcop, but it might be a cop that has been optimised away. We
1271 * can try to find such a cop by searching through the optree starting
1272 * from the sibling of PL_curcop.
1275 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1280 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1281 OutCopFILE(cop), (IV)CopLINE(cop));
1282 /* Seems that GvIO() can be untrustworthy during global destruction. */
1283 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1284 && IoLINES(GvIOp(PL_last_in_gv)))
1287 const bool line_mode = (RsSIMPLE(PL_rs) &&
1288 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1289 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1290 SVfARG(PL_last_in_gv == PL_argvgv
1292 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1293 line_mode ? "line" : "chunk",
1294 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1296 if (PL_phase == PERL_PHASE_DESTRUCT)
1297 sv_catpvs(sv, " during global destruction");
1298 sv_catpvs(sv, ".\n");
1304 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1306 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1307 argument list. These are used to generate a string message. If the
1308 message does not end with a newline, then it will be extended with
1309 some indication of the current location in the code, as described for
1312 Normally, the resulting message is returned in a new mortal SV.
1313 During global destruction a single SV may be shared between uses of
1320 Perl_vmess(pTHX_ const char *pat, va_list *args)
1323 SV * const sv = mess_alloc();
1325 PERL_ARGS_ASSERT_VMESS;
1327 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1328 return mess_sv(sv, 1);
1332 Perl_write_to_stderr(pTHX_ SV* msv)
1338 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1340 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1341 && (io = GvIO(PL_stderrgv))
1342 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1343 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, "PRINT",
1344 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1347 /* SFIO can really mess with your errno */
1350 PerlIO * const serr = Perl_error_log;
1352 do_print(msv, serr);
1353 (void)PerlIO_flush(serr);
1361 =head1 Warning and Dieing
1364 /* Common code used in dieing and warning */
1367 S_with_queued_errors(pTHX_ SV *ex)
1369 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1370 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1371 sv_catsv(PL_errors, ex);
1372 ex = sv_mortalcopy(PL_errors);
1373 SvCUR_set(PL_errors, 0);
1379 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1385 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1386 /* sv_2cv might call Perl_croak() or Perl_warner() */
1387 SV * const oldhook = *hook;
1395 cv = sv_2cv(oldhook, &stash, &gv, 0);
1397 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1407 exarg = newSVsv(ex);
1408 SvREADONLY_on(exarg);
1411 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1415 call_sv(MUTABLE_SV(cv), G_DISCARD);
1424 =for apidoc Am|OP *|die_sv|SV *baseex
1426 Behaves the same as L</croak_sv>, except for the return type.
1427 It should be used only where the C<OP *> return type is required.
1428 The function never actually returns.
1434 Perl_die_sv(pTHX_ SV *baseex)
1436 PERL_ARGS_ASSERT_DIE_SV;
1438 assert(0); /* NOTREACHED */
1443 =for apidoc Am|OP *|die|const char *pat|...
1445 Behaves the same as L</croak>, except for the return type.
1446 It should be used only where the C<OP *> return type is required.
1447 The function never actually returns.
1452 #if defined(PERL_IMPLICIT_CONTEXT)
1454 Perl_die_nocontext(const char* pat, ...)
1458 va_start(args, pat);
1460 assert(0); /* NOTREACHED */
1464 #endif /* PERL_IMPLICIT_CONTEXT */
1467 Perl_die(pTHX_ const char* pat, ...)
1470 va_start(args, pat);
1472 assert(0); /* NOTREACHED */
1478 =for apidoc Am|void|croak_sv|SV *baseex
1480 This is an XS interface to Perl's C<die> function.
1482 C<baseex> is the error message or object. If it is a reference, it
1483 will be used as-is. Otherwise it is used as a string, and if it does
1484 not end with a newline then it will be extended with some indication of
1485 the current location in the code, as described for L</mess_sv>.
1487 The error message or object will be used as an exception, by default
1488 returning control to the nearest enclosing C<eval>, but subject to
1489 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1490 function never returns normally.
1492 To die with a simple string message, the L</croak> function may be
1499 Perl_croak_sv(pTHX_ SV *baseex)
1501 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1502 PERL_ARGS_ASSERT_CROAK_SV;
1503 invoke_exception_hook(ex, FALSE);
1508 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1510 This is an XS interface to Perl's C<die> function.
1512 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1513 argument list. These are used to generate a string message. If the
1514 message does not end with a newline, then it will be extended with
1515 some indication of the current location in the code, as described for
1518 The error message will be used as an exception, by default
1519 returning control to the nearest enclosing C<eval>, but subject to
1520 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1521 function never returns normally.
1523 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1524 (C<$@>) will be used as an error message or object instead of building an
1525 error message from arguments. If you want to throw a non-string object,
1526 or build an error message in an SV yourself, it is preferable to use
1527 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1533 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1535 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1536 invoke_exception_hook(ex, FALSE);
1541 =for apidoc Am|void|croak|const char *pat|...
1543 This is an XS interface to Perl's C<die> function.
1545 Take a sprintf-style format pattern and argument list. These are used to
1546 generate a string message. If the message does not end with a newline,
1547 then it will be extended with some indication of the current location
1548 in the code, as described for L</mess_sv>.
1550 The error message will be used as an exception, by default
1551 returning control to the nearest enclosing C<eval>, but subject to
1552 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1553 function never returns normally.
1555 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1556 (C<$@>) will be used as an error message or object instead of building an
1557 error message from arguments. If you want to throw a non-string object,
1558 or build an error message in an SV yourself, it is preferable to use
1559 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1564 #if defined(PERL_IMPLICIT_CONTEXT)
1566 Perl_croak_nocontext(const char *pat, ...)
1570 va_start(args, pat);
1572 assert(0); /* NOTREACHED */
1575 #endif /* PERL_IMPLICIT_CONTEXT */
1578 Perl_croak(pTHX_ const char *pat, ...)
1581 va_start(args, pat);
1583 assert(0); /* NOTREACHED */
1588 =for apidoc Am|void|croak_no_modify
1590 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1591 terser object code than using C<Perl_croak>. Less code used on exception code
1592 paths reduces CPU cache pressure.
1598 Perl_croak_no_modify()
1600 Perl_croak_nocontext( "%s", PL_no_modify);
1603 /* does not return, used in util.c perlio.c and win32.c
1604 This is typically called when malloc returns NULL.
1611 /* Can't use PerlIO to write as it allocates memory */
1612 PerlLIO_write(PerlIO_fileno(Perl_error_log),
1613 PL_no_mem, sizeof(PL_no_mem)-1);
1617 /* saves machine code for a common noreturn idiom typically used in Newx*() */
1619 Perl_croak_memory_wrap(void)
1621 Perl_croak_nocontext("%s",PL_memory_wrap);
1625 /* does not return, used only in POPSTACK */
1627 Perl_croak_popstack(void)
1630 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1635 =for apidoc Am|void|warn_sv|SV *baseex
1637 This is an XS interface to Perl's C<warn> function.
1639 C<baseex> is the error message or object. If it is a reference, it
1640 will be used as-is. Otherwise it is used as a string, and if it does
1641 not end with a newline then it will be extended with some indication of
1642 the current location in the code, as described for L</mess_sv>.
1644 The error message or object will by default be written to standard error,
1645 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1647 To warn with a simple string message, the L</warn> function may be
1654 Perl_warn_sv(pTHX_ SV *baseex)
1656 SV *ex = mess_sv(baseex, 0);
1657 PERL_ARGS_ASSERT_WARN_SV;
1658 if (!invoke_exception_hook(ex, TRUE))
1659 write_to_stderr(ex);
1663 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1665 This is an XS interface to Perl's C<warn> function.
1667 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1668 argument list. These are used to generate a string message. If the
1669 message does not end with a newline, then it will be extended with
1670 some indication of the current location in the code, as described for
1673 The error message or object will by default be written to standard error,
1674 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1676 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1682 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1684 SV *ex = vmess(pat, args);
1685 PERL_ARGS_ASSERT_VWARN;
1686 if (!invoke_exception_hook(ex, TRUE))
1687 write_to_stderr(ex);
1691 =for apidoc Am|void|warn|const char *pat|...
1693 This is an XS interface to Perl's C<warn> function.
1695 Take a sprintf-style format pattern and argument list. These are used to
1696 generate a string message. If the message does not end with a newline,
1697 then it will be extended with some indication of the current location
1698 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 Unlike with L</croak>, C<pat> is not permitted to be null.
1708 #if defined(PERL_IMPLICIT_CONTEXT)
1710 Perl_warn_nocontext(const char *pat, ...)
1714 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1715 va_start(args, pat);
1719 #endif /* PERL_IMPLICIT_CONTEXT */
1722 Perl_warn(pTHX_ const char *pat, ...)
1725 PERL_ARGS_ASSERT_WARN;
1726 va_start(args, pat);
1731 #if defined(PERL_IMPLICIT_CONTEXT)
1733 Perl_warner_nocontext(U32 err, const char *pat, ...)
1737 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1738 va_start(args, pat);
1739 vwarner(err, pat, &args);
1742 #endif /* PERL_IMPLICIT_CONTEXT */
1745 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1747 PERL_ARGS_ASSERT_CK_WARNER_D;
1749 if (Perl_ckwarn_d(aTHX_ err)) {
1751 va_start(args, pat);
1752 vwarner(err, pat, &args);
1758 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1760 PERL_ARGS_ASSERT_CK_WARNER;
1762 if (Perl_ckwarn(aTHX_ err)) {
1764 va_start(args, pat);
1765 vwarner(err, pat, &args);
1771 Perl_warner(pTHX_ U32 err, const char* pat,...)
1774 PERL_ARGS_ASSERT_WARNER;
1775 va_start(args, pat);
1776 vwarner(err, pat, &args);
1781 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1784 PERL_ARGS_ASSERT_VWARNER;
1785 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1786 SV * const msv = vmess(pat, args);
1788 invoke_exception_hook(msv, FALSE);
1792 Perl_vwarn(aTHX_ pat, args);
1796 /* implements the ckWARN? macros */
1799 Perl_ckwarn(pTHX_ U32 w)
1802 /* If lexical warnings have not been set, use $^W. */
1804 return PL_dowarn & G_WARN_ON;
1806 return ckwarn_common(w);
1809 /* implements the ckWARN?_d macro */
1812 Perl_ckwarn_d(pTHX_ U32 w)
1815 /* If lexical warnings have not been set then default classes warn. */
1819 return ckwarn_common(w);
1823 S_ckwarn_common(pTHX_ U32 w)
1825 if (PL_curcop->cop_warnings == pWARN_ALL)
1828 if (PL_curcop->cop_warnings == pWARN_NONE)
1831 /* Check the assumption that at least the first slot is non-zero. */
1832 assert(unpackWARN1(w));
1834 /* Check the assumption that it is valid to stop as soon as a zero slot is
1836 if (!unpackWARN2(w)) {
1837 assert(!unpackWARN3(w));
1838 assert(!unpackWARN4(w));
1839 } else if (!unpackWARN3(w)) {
1840 assert(!unpackWARN4(w));
1843 /* Right, dealt with all the special cases, which are implemented as non-
1844 pointers, so there is a pointer to a real warnings mask. */
1846 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1848 } while (w >>= WARNshift);
1853 /* Set buffer=NULL to get a new one. */
1855 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1857 const MEM_SIZE len_wanted =
1858 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
1859 PERL_UNUSED_CONTEXT;
1860 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1863 (specialWARN(buffer) ?
1864 PerlMemShared_malloc(len_wanted) :
1865 PerlMemShared_realloc(buffer, len_wanted));
1867 Copy(bits, (buffer + 1), size, char);
1868 if (size < WARNsize)
1869 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
1873 /* since we've already done strlen() for both nam and val
1874 * we can use that info to make things faster than
1875 * sprintf(s, "%s=%s", nam, val)
1877 #define my_setenv_format(s, nam, nlen, val, vlen) \
1878 Copy(nam, s, nlen, char); \
1880 Copy(val, s+(nlen+1), vlen, char); \
1881 *(s+(nlen+1+vlen)) = '\0'
1883 #ifdef USE_ENVIRON_ARRAY
1884 /* VMS' my_setenv() is in vms.c */
1885 #if !defined(WIN32) && !defined(NETWARE)
1887 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1891 /* only parent thread can modify process environment */
1892 if (PL_curinterp == aTHX)
1895 #ifndef PERL_USE_SAFE_PUTENV
1896 if (!PL_use_safe_putenv) {
1897 /* most putenv()s leak, so we manipulate environ directly */
1899 const I32 len = strlen(nam);
1902 /* where does it go? */
1903 for (i = 0; environ[i]; i++) {
1904 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1908 if (environ == PL_origenviron) { /* need we copy environment? */
1914 while (environ[max])
1916 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1917 for (j=0; j<max; j++) { /* copy environment */
1918 const int len = strlen(environ[j]);
1919 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1920 Copy(environ[j], tmpenv[j], len+1, char);
1923 environ = tmpenv; /* tell exec where it is now */
1926 safesysfree(environ[i]);
1927 while (environ[i]) {
1928 environ[i] = environ[i+1];
1933 if (!environ[i]) { /* does not exist yet */
1934 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1935 environ[i+1] = NULL; /* make sure it's null terminated */
1938 safesysfree(environ[i]);
1942 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1943 /* all that work just for this */
1944 my_setenv_format(environ[i], nam, nlen, val, vlen);
1947 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__)
1948 # if defined(HAS_UNSETENV)
1950 (void)unsetenv(nam);
1952 (void)setenv(nam, val, 1);
1954 # else /* ! HAS_UNSETENV */
1955 (void)setenv(nam, val, 1);
1956 # endif /* HAS_UNSETENV */
1958 # if defined(HAS_UNSETENV)
1960 if (environ) /* old glibc can crash with null environ */
1961 (void)unsetenv(nam);
1963 const int nlen = strlen(nam);
1964 const int vlen = strlen(val);
1965 char * const new_env =
1966 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1967 my_setenv_format(new_env, nam, nlen, val, vlen);
1968 (void)putenv(new_env);
1970 # else /* ! HAS_UNSETENV */
1972 const int nlen = strlen(nam);
1978 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1979 /* all that work just for this */
1980 my_setenv_format(new_env, nam, nlen, val, vlen);
1981 (void)putenv(new_env);
1982 # endif /* HAS_UNSETENV */
1983 # endif /* __CYGWIN__ */
1984 #ifndef PERL_USE_SAFE_PUTENV
1990 #else /* WIN32 || NETWARE */
1993 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1997 const int nlen = strlen(nam);
2004 Newx(envstr, nlen+vlen+2, char);
2005 my_setenv_format(envstr, nam, nlen, val, vlen);
2006 (void)PerlEnv_putenv(envstr);
2010 #endif /* WIN32 || NETWARE */
2014 #ifdef UNLINK_ALL_VERSIONS
2016 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2020 PERL_ARGS_ASSERT_UNLNK;
2022 while (PerlLIO_unlink(f) >= 0)
2024 return retries ? 0 : -1;
2028 /* this is a drop-in replacement for bcopy() */
2029 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2031 Perl_my_bcopy(const char *from, char *to, I32 len)
2033 char * const retval = to;
2035 PERL_ARGS_ASSERT_MY_BCOPY;
2039 if (from - to >= 0) {
2047 *(--to) = *(--from);
2053 /* this is a drop-in replacement for memset() */
2056 Perl_my_memset(char *loc, I32 ch, I32 len)
2058 char * const retval = loc;
2060 PERL_ARGS_ASSERT_MY_MEMSET;
2070 /* this is a drop-in replacement for bzero() */
2071 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2073 Perl_my_bzero(char *loc, I32 len)
2075 char * const retval = loc;
2077 PERL_ARGS_ASSERT_MY_BZERO;
2087 /* this is a drop-in replacement for memcmp() */
2088 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2090 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2092 const U8 *a = (const U8 *)s1;
2093 const U8 *b = (const U8 *)s2;
2096 PERL_ARGS_ASSERT_MY_MEMCMP;
2101 if ((tmp = *a++ - *b++))
2106 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2109 /* This vsprintf replacement should generally never get used, since
2110 vsprintf was available in both System V and BSD 2.11. (There may
2111 be some cross-compilation or embedded set-ups where it is needed,
2114 If you encounter a problem in this function, it's probably a symptom
2115 that Configure failed to detect your system's vprintf() function.
2116 See the section on "item vsprintf" in the INSTALL file.
2118 This version may compile on systems with BSD-ish <stdio.h>,
2119 but probably won't on others.
2122 #ifdef USE_CHAR_VSPRINTF
2127 vsprintf(char *dest, const char *pat, void *args)
2131 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2132 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2133 FILE_cnt(&fakebuf) = 32767;
2135 /* These probably won't compile -- If you really need
2136 this, you'll have to figure out some other method. */
2137 fakebuf._ptr = dest;
2138 fakebuf._cnt = 32767;
2143 fakebuf._flag = _IOWRT|_IOSTRG;
2144 _doprnt(pat, args, &fakebuf); /* what a kludge */
2145 #if defined(STDIO_PTR_LVALUE)
2146 *(FILE_ptr(&fakebuf)++) = '\0';
2148 /* PerlIO has probably #defined away fputc, but we want it here. */
2150 # undef fputc /* XXX Should really restore it later */
2152 (void)fputc('\0', &fakebuf);
2154 #ifdef USE_CHAR_VSPRINTF
2157 return 0; /* perl doesn't use return value */
2161 #endif /* HAS_VPRINTF */
2164 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
2165 * If these functions are defined,
2166 * the BYTEORDER is neither 0x1234 nor 0x4321.
2167 * However, this is not assumed.
2171 #define HTOLE(name,type) \
2177 char c[sizeof(type)]; \
2181 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2182 u.c[i] = (n >> s) & 0xFF; \
2187 #define LETOH(name,type) \
2193 char c[sizeof(type)]; \
2199 for (i = 0; i < sizeof(u.c); i++, s += 8) { \
2200 n |= ((type)(u.c[i] & 0xFF)) << s; \
2206 * Big-endian byte order functions.
2209 #define HTOBE(name,type) \
2215 char c[sizeof(type)]; \
2218 U32 s = 8*(sizeof(u.c)-1); \
2219 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2220 u.c[i] = (n >> s) & 0xFF; \
2225 #define BETOH(name,type) \
2231 char c[sizeof(type)]; \
2234 U32 s = 8*(sizeof(u.c)-1); \
2237 for (i = 0; i < sizeof(u.c); i++, s -= 8) { \
2238 n |= ((type)(u.c[i] & 0xFF)) << s; \
2244 * If we just can't do it...
2247 #define NOT_AVAIL(name,type) \
2251 Perl_croak_nocontext(#name "() not available"); \
2252 return n; /* not reached */ \
2269 #ifdef PERL_NEED_MY_HTOLE16
2271 HTOLE(Perl_my_htole16,U16)
2273 NOT_AVAIL(Perl_my_htole16,U16)
2276 #ifdef PERL_NEED_MY_LETOH16
2278 LETOH(Perl_my_letoh16,U16)
2280 NOT_AVAIL(Perl_my_letoh16,U16)
2283 #ifdef PERL_NEED_MY_HTOBE16
2285 HTOBE(Perl_my_htobe16,U16)
2287 NOT_AVAIL(Perl_my_htobe16,U16)
2290 #ifdef PERL_NEED_MY_BETOH16
2292 BETOH(Perl_my_betoh16,U16)
2294 NOT_AVAIL(Perl_my_betoh16,U16)
2298 #ifdef PERL_NEED_MY_HTOLE32
2300 HTOLE(Perl_my_htole32,U32)
2302 NOT_AVAIL(Perl_my_htole32,U32)
2305 #ifdef PERL_NEED_MY_LETOH32
2307 LETOH(Perl_my_letoh32,U32)
2309 NOT_AVAIL(Perl_my_letoh32,U32)
2312 #ifdef PERL_NEED_MY_HTOBE32
2314 HTOBE(Perl_my_htobe32,U32)
2316 NOT_AVAIL(Perl_my_htobe32,U32)
2319 #ifdef PERL_NEED_MY_BETOH32
2321 BETOH(Perl_my_betoh32,U32)
2323 NOT_AVAIL(Perl_my_betoh32,U32)
2327 #ifdef PERL_NEED_MY_HTOLE64
2329 HTOLE(Perl_my_htole64,U64)
2331 NOT_AVAIL(Perl_my_htole64,U64)
2334 #ifdef PERL_NEED_MY_LETOH64
2336 LETOH(Perl_my_letoh64,U64)
2338 NOT_AVAIL(Perl_my_letoh64,U64)
2341 #ifdef PERL_NEED_MY_HTOBE64
2343 HTOBE(Perl_my_htobe64,U64)
2345 NOT_AVAIL(Perl_my_htobe64,U64)
2348 #ifdef PERL_NEED_MY_BETOH64
2350 BETOH(Perl_my_betoh64,U64)
2352 NOT_AVAIL(Perl_my_betoh64,U64)
2356 #ifdef PERL_NEED_MY_HTOLES
2357 HTOLE(Perl_my_htoles,short)
2359 #ifdef PERL_NEED_MY_LETOHS
2360 LETOH(Perl_my_letohs,short)
2362 #ifdef PERL_NEED_MY_HTOBES
2363 HTOBE(Perl_my_htobes,short)
2365 #ifdef PERL_NEED_MY_BETOHS
2366 BETOH(Perl_my_betohs,short)
2369 #ifdef PERL_NEED_MY_HTOLEI
2370 HTOLE(Perl_my_htolei,int)
2372 #ifdef PERL_NEED_MY_LETOHI
2373 LETOH(Perl_my_letohi,int)
2375 #ifdef PERL_NEED_MY_HTOBEI
2376 HTOBE(Perl_my_htobei,int)
2378 #ifdef PERL_NEED_MY_BETOHI
2379 BETOH(Perl_my_betohi,int)
2382 #ifdef PERL_NEED_MY_HTOLEL
2383 HTOLE(Perl_my_htolel,long)
2385 #ifdef PERL_NEED_MY_LETOHL
2386 LETOH(Perl_my_letohl,long)
2388 #ifdef PERL_NEED_MY_HTOBEL
2389 HTOBE(Perl_my_htobel,long)
2391 #ifdef PERL_NEED_MY_BETOHL
2392 BETOH(Perl_my_betohl,long)
2396 Perl_my_swabn(void *ptr, int n)
2398 char *s = (char *)ptr;
2399 char *e = s + (n-1);
2402 PERL_ARGS_ASSERT_MY_SWABN;
2404 for (n /= 2; n > 0; s++, e--, n--) {
2412 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2414 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2423 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2425 PERL_FLUSHALL_FOR_CHILD;
2426 This = (*mode == 'w');
2430 taint_proper("Insecure %s%s", "EXEC");
2432 if (PerlProc_pipe(p) < 0)
2434 /* Try for another pipe pair for error return */
2435 if (PerlProc_pipe(pp) >= 0)
2437 while ((pid = PerlProc_fork()) < 0) {
2438 if (errno != EAGAIN) {
2439 PerlLIO_close(p[This]);
2440 PerlLIO_close(p[that]);
2442 PerlLIO_close(pp[0]);
2443 PerlLIO_close(pp[1]);
2447 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2456 /* Close parent's end of error status pipe (if any) */
2458 PerlLIO_close(pp[0]);
2459 #if defined(HAS_FCNTL) && defined(F_SETFD)
2460 /* Close error pipe automatically if exec works */
2461 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2464 /* Now dup our end of _the_ pipe to right position */
2465 if (p[THIS] != (*mode == 'r')) {
2466 PerlLIO_dup2(p[THIS], *mode == 'r');
2467 PerlLIO_close(p[THIS]);
2468 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2469 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2472 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2473 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2474 /* No automatic close - do it by hand */
2481 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2487 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2493 do_execfree(); /* free any memory malloced by child on fork */
2495 PerlLIO_close(pp[1]);
2496 /* Keep the lower of the two fd numbers */
2497 if (p[that] < p[This]) {
2498 PerlLIO_dup2(p[This], p[that]);
2499 PerlLIO_close(p[This]);
2503 PerlLIO_close(p[that]); /* close child's end of pipe */
2505 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2506 SvUPGRADE(sv,SVt_IV);
2508 PL_forkprocess = pid;
2509 /* If we managed to get status pipe check for exec fail */
2510 if (did_pipes && pid > 0) {
2515 while (n < sizeof(int)) {
2516 n1 = PerlLIO_read(pp[0],
2517 (void*)(((char*)&errkid)+n),
2523 PerlLIO_close(pp[0]);
2525 if (n) { /* Error */
2527 PerlLIO_close(p[This]);
2528 if (n != sizeof(int))
2529 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2531 pid2 = wait4pid(pid, &status, 0);
2532 } while (pid2 == -1 && errno == EINTR);
2533 errno = errkid; /* Propagate errno from kid */
2538 PerlLIO_close(pp[0]);
2539 return PerlIO_fdopen(p[This], mode);
2541 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2542 return my_syspopen4(aTHX_ NULL, mode, n, args);
2544 Perl_croak(aTHX_ "List form of piped open not implemented");
2545 return (PerlIO *) NULL;
2550 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2551 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2553 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2560 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2564 PERL_ARGS_ASSERT_MY_POPEN;
2566 PERL_FLUSHALL_FOR_CHILD;
2569 return my_syspopen(aTHX_ cmd,mode);
2572 This = (*mode == 'w');
2574 if (doexec && TAINTING_get) {
2576 taint_proper("Insecure %s%s", "EXEC");
2578 if (PerlProc_pipe(p) < 0)
2580 if (doexec && PerlProc_pipe(pp) >= 0)
2582 while ((pid = PerlProc_fork()) < 0) {
2583 if (errno != EAGAIN) {
2584 PerlLIO_close(p[This]);
2585 PerlLIO_close(p[that]);
2587 PerlLIO_close(pp[0]);
2588 PerlLIO_close(pp[1]);
2591 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2594 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2604 PerlLIO_close(pp[0]);
2605 #if defined(HAS_FCNTL) && defined(F_SETFD)
2606 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2609 if (p[THIS] != (*mode == 'r')) {
2610 PerlLIO_dup2(p[THIS], *mode == 'r');
2611 PerlLIO_close(p[THIS]);
2612 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2613 PerlLIO_close(p[THAT]);
2616 PerlLIO_close(p[THAT]);
2619 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2626 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2631 /* may or may not use the shell */
2632 do_exec3(cmd, pp[1], did_pipes);
2635 #endif /* defined OS2 */
2637 #ifdef PERLIO_USING_CRLF
2638 /* Since we circumvent IO layers when we manipulate low-level
2639 filedescriptors directly, need to manually switch to the
2640 default, binary, low-level mode; see PerlIOBuf_open(). */
2641 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2644 #ifdef PERL_USES_PL_PIDSTATUS
2645 hv_clear(PL_pidstatus); /* we have no children */
2651 do_execfree(); /* free any memory malloced by child on vfork */
2653 PerlLIO_close(pp[1]);
2654 if (p[that] < p[This]) {
2655 PerlLIO_dup2(p[This], p[that]);
2656 PerlLIO_close(p[This]);
2660 PerlLIO_close(p[that]);
2662 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2663 SvUPGRADE(sv,SVt_IV);
2665 PL_forkprocess = pid;
2666 if (did_pipes && pid > 0) {
2671 while (n < sizeof(int)) {
2672 n1 = PerlLIO_read(pp[0],
2673 (void*)(((char*)&errkid)+n),
2679 PerlLIO_close(pp[0]);
2681 if (n) { /* Error */
2683 PerlLIO_close(p[This]);
2684 if (n != sizeof(int))
2685 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2687 pid2 = wait4pid(pid, &status, 0);
2688 } while (pid2 == -1 && errno == EINTR);
2689 errno = errkid; /* Propagate errno from kid */
2694 PerlLIO_close(pp[0]);
2695 return PerlIO_fdopen(p[This], mode);
2699 FILE *djgpp_popen();
2701 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2703 PERL_FLUSHALL_FOR_CHILD;
2704 /* Call system's popen() to get a FILE *, then import it.
2705 used 0 for 2nd parameter to PerlIO_importFILE;
2708 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2711 #if defined(__LIBCATAMOUNT__)
2713 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2720 #endif /* !DOSISH */
2722 /* this is called in parent before the fork() */
2724 Perl_atfork_lock(void)
2727 #if defined(USE_ITHREADS)
2728 /* locks must be held in locking order (if any) */
2730 MUTEX_LOCK(&PL_perlio_mutex);
2733 MUTEX_LOCK(&PL_malloc_mutex);
2739 /* this is called in both parent and child after the fork() */
2741 Perl_atfork_unlock(void)
2744 #if defined(USE_ITHREADS)
2745 /* locks must be released in same order as in atfork_lock() */
2747 MUTEX_UNLOCK(&PL_perlio_mutex);
2750 MUTEX_UNLOCK(&PL_malloc_mutex);
2759 #if defined(HAS_FORK)
2761 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2766 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2767 * handlers elsewhere in the code */
2772 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2773 Perl_croak_nocontext("fork() not available");
2775 #endif /* HAS_FORK */
2780 Perl_dump_fds(pTHX_ const char *const s)
2785 PERL_ARGS_ASSERT_DUMP_FDS;
2787 PerlIO_printf(Perl_debug_log,"%s", s);
2788 for (fd = 0; fd < 32; fd++) {
2789 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2790 PerlIO_printf(Perl_debug_log," %d",fd);
2792 PerlIO_printf(Perl_debug_log,"\n");
2795 #endif /* DUMP_FDS */
2799 dup2(int oldfd, int newfd)
2801 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2804 PerlLIO_close(newfd);
2805 return fcntl(oldfd, F_DUPFD, newfd);
2807 #define DUP2_MAX_FDS 256
2808 int fdtmp[DUP2_MAX_FDS];
2814 PerlLIO_close(newfd);
2815 /* good enough for low fd's... */
2816 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2817 if (fdx >= DUP2_MAX_FDS) {
2825 PerlLIO_close(fdtmp[--fdx]);
2832 #ifdef HAS_SIGACTION
2835 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2838 struct sigaction act, oact;
2841 /* only "parent" interpreter can diddle signals */
2842 if (PL_curinterp != aTHX)
2843 return (Sighandler_t) SIG_ERR;
2846 act.sa_handler = (void(*)(int))handler;
2847 sigemptyset(&act.sa_mask);
2850 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2851 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2853 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2854 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2855 act.sa_flags |= SA_NOCLDWAIT;
2857 if (sigaction(signo, &act, &oact) == -1)
2858 return (Sighandler_t) SIG_ERR;
2860 return (Sighandler_t) oact.sa_handler;
2864 Perl_rsignal_state(pTHX_ int signo)
2866 struct sigaction oact;
2867 PERL_UNUSED_CONTEXT;
2869 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2870 return (Sighandler_t) SIG_ERR;
2872 return (Sighandler_t) oact.sa_handler;
2876 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2879 struct sigaction act;
2881 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2884 /* only "parent" interpreter can diddle signals */
2885 if (PL_curinterp != aTHX)
2889 act.sa_handler = (void(*)(int))handler;
2890 sigemptyset(&act.sa_mask);
2893 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2894 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2896 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2897 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2898 act.sa_flags |= SA_NOCLDWAIT;
2900 return sigaction(signo, &act, save);
2904 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2908 /* only "parent" interpreter can diddle signals */
2909 if (PL_curinterp != aTHX)
2913 return sigaction(signo, save, (struct sigaction *)NULL);
2916 #else /* !HAS_SIGACTION */
2919 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2921 #if defined(USE_ITHREADS) && !defined(WIN32)
2922 /* only "parent" interpreter can diddle signals */
2923 if (PL_curinterp != aTHX)
2924 return (Sighandler_t) SIG_ERR;
2927 return PerlProc_signal(signo, handler);
2938 Perl_rsignal_state(pTHX_ int signo)
2941 Sighandler_t oldsig;
2943 #if defined(USE_ITHREADS) && !defined(WIN32)
2944 /* only "parent" interpreter can diddle signals */
2945 if (PL_curinterp != aTHX)
2946 return (Sighandler_t) SIG_ERR;
2950 oldsig = PerlProc_signal(signo, sig_trap);
2951 PerlProc_signal(signo, oldsig);
2953 PerlProc_kill(PerlProc_getpid(), signo);
2958 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2960 #if defined(USE_ITHREADS) && !defined(WIN32)
2961 /* only "parent" interpreter can diddle signals */
2962 if (PL_curinterp != aTHX)
2965 *save = PerlProc_signal(signo, handler);
2966 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2970 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2972 #if defined(USE_ITHREADS) && !defined(WIN32)
2973 /* only "parent" interpreter can diddle signals */
2974 if (PL_curinterp != aTHX)
2977 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2980 #endif /* !HAS_SIGACTION */
2981 #endif /* !PERL_MICRO */
2983 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2984 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2986 Perl_my_pclose(pTHX_ PerlIO *ptr)
2989 Sigsave_t hstat, istat, qstat;
2996 const int fd = PerlIO_fileno(ptr);
2999 /* Find out whether the refcount is low enough for us to wait for the
3000 child proc without blocking. */
3001 const bool should_wait = PerlIOUnix_refcnt(fd) == 1;
3003 const bool should_wait = 1;
3006 svp = av_fetch(PL_fdpid,fd,TRUE);
3007 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
3009 *svp = &PL_sv_undef;
3011 if (pid == -1) { /* Opened by popen. */
3012 return my_syspclose(ptr);
3015 close_failed = (PerlIO_close(ptr) == EOF);
3018 rsignal_save(SIGHUP, (Sighandler_t) SIG_IGN, &hstat);
3019 rsignal_save(SIGINT, (Sighandler_t) SIG_IGN, &istat);
3020 rsignal_save(SIGQUIT, (Sighandler_t) SIG_IGN, &qstat);
3022 if (should_wait) do {
3023 pid2 = wait4pid(pid, &status, 0);
3024 } while (pid2 == -1 && errno == EINTR);
3026 rsignal_restore(SIGHUP, &hstat);
3027 rsignal_restore(SIGINT, &istat);
3028 rsignal_restore(SIGQUIT, &qstat);
3036 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
3041 #if defined(__LIBCATAMOUNT__)
3043 Perl_my_pclose(pTHX_ PerlIO *ptr)
3048 #endif /* !DOSISH */
3050 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
3052 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
3056 PERL_ARGS_ASSERT_WAIT4PID;
3059 #ifdef PERL_USES_PL_PIDSTATUS
3062 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
3063 pid, rather than a string form. */
3064 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
3065 if (svp && *svp != &PL_sv_undef) {
3066 *statusp = SvIVX(*svp);
3067 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
3075 hv_iterinit(PL_pidstatus);
3076 if ((entry = hv_iternext(PL_pidstatus))) {
3077 SV * const sv = hv_iterval(PL_pidstatus,entry);
3079 const char * const spid = hv_iterkey(entry,&len);
3081 assert (len == sizeof(Pid_t));
3082 memcpy((char *)&pid, spid, len);
3083 *statusp = SvIVX(sv);
3084 /* The hash iterator is currently on this entry, so simply
3085 calling hv_delete would trigger the lazy delete, which on
3086 aggregate does more work, beacuse next call to hv_iterinit()
3087 would spot the flag, and have to call the delete routine,
3088 while in the meantime any new entries can't re-use that
3090 hv_iterinit(PL_pidstatus);
3091 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
3098 # ifdef HAS_WAITPID_RUNTIME
3099 if (!HAS_WAITPID_RUNTIME)
3102 result = PerlProc_waitpid(pid,statusp,flags);
3105 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
3106 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
3109 #ifdef PERL_USES_PL_PIDSTATUS
3110 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
3115 Perl_croak(aTHX_ "Can't do waitpid with flags");
3117 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
3118 pidgone(result,*statusp);
3124 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
3127 if (result < 0 && errno == EINTR) {
3129 errno = EINTR; /* reset in case a signal handler changed $! */
3133 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
3135 #ifdef PERL_USES_PL_PIDSTATUS
3137 S_pidgone(pTHX_ Pid_t pid, int status)
3141 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
3142 SvUPGRADE(sv,SVt_IV);
3143 SvIV_set(sv, status);
3151 int /* Cannot prototype with I32
3153 my_syspclose(PerlIO *ptr)
3156 Perl_my_pclose(pTHX_ PerlIO *ptr)
3159 /* Needs work for PerlIO ! */
3160 FILE * const f = PerlIO_findFILE(ptr);
3161 const I32 result = pclose(f);
3162 PerlIO_releaseFILE(ptr,f);
3170 Perl_my_pclose(pTHX_ PerlIO *ptr)
3172 /* Needs work for PerlIO ! */
3173 FILE * const f = PerlIO_findFILE(ptr);
3174 I32 result = djgpp_pclose(f);
3175 result = (result << 8) & 0xff00;
3176 PerlIO_releaseFILE(ptr,f);
3181 #define PERL_REPEATCPY_LINEAR 4
3183 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
3185 PERL_ARGS_ASSERT_REPEATCPY;
3190 Perl_croak_memory_wrap();
3193 memset(to, *from, count);
3196 IV items, linear, half;
3198 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
3199 for (items = 0; items < linear; ++items) {
3200 const char *q = from;
3202 for (todo = len; todo > 0; todo--)
3207 while (items <= half) {
3208 IV size = items * len;
3209 memcpy(p, to, size);
3215 memcpy(p, to, (count - items) * len);
3221 Perl_same_dirent(pTHX_ const char *a, const char *b)
3223 char *fa = strrchr(a,'/');
3224 char *fb = strrchr(b,'/');
3227 SV * const tmpsv = sv_newmortal();
3229 PERL_ARGS_ASSERT_SAME_DIRENT;
3242 sv_setpvs(tmpsv, ".");
3244 sv_setpvn(tmpsv, a, fa - a);
3245 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
3248 sv_setpvs(tmpsv, ".");
3250 sv_setpvn(tmpsv, b, fb - b);
3251 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
3253 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
3254 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
3256 #endif /* !HAS_RENAME */
3259 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
3260 const char *const *const search_ext, I32 flags)
3263 const char *xfound = NULL;
3264 char *xfailed = NULL;
3265 char tmpbuf[MAXPATHLEN];
3270 #if defined(DOSISH) && !defined(OS2)
3271 # define SEARCH_EXTS ".bat", ".cmd", NULL
3272 # define MAX_EXT_LEN 4
3275 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3276 # define MAX_EXT_LEN 4
3279 # define SEARCH_EXTS ".pl", ".com", NULL
3280 # define MAX_EXT_LEN 4
3282 /* additional extensions to try in each dir if scriptname not found */
3284 static const char *const exts[] = { SEARCH_EXTS };
3285 const char *const *const ext = search_ext ? search_ext : exts;
3286 int extidx = 0, i = 0;
3287 const char *curext = NULL;
3289 PERL_UNUSED_ARG(search_ext);
3290 # define MAX_EXT_LEN 0
3293 PERL_ARGS_ASSERT_FIND_SCRIPT;
3296 * If dosearch is true and if scriptname does not contain path
3297 * delimiters, search the PATH for scriptname.
3299 * If SEARCH_EXTS is also defined, will look for each
3300 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3301 * while searching the PATH.
3303 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3304 * proceeds as follows:
3305 * If DOSISH or VMSISH:
3306 * + look for ./scriptname{,.foo,.bar}
3307 * + search the PATH for scriptname{,.foo,.bar}
3310 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3311 * this will not look in '.' if it's not in the PATH)
3316 # ifdef ALWAYS_DEFTYPES
3317 len = strlen(scriptname);
3318 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3319 int idx = 0, deftypes = 1;
3322 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3325 int idx = 0, deftypes = 1;
3328 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3330 /* The first time through, just add SEARCH_EXTS to whatever we
3331 * already have, so we can check for default file types. */
3333 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3339 if ((strlen(tmpbuf) + strlen(scriptname)
3340 + MAX_EXT_LEN) >= sizeof tmpbuf)
3341 continue; /* don't search dir with too-long name */
3342 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3346 if (strEQ(scriptname, "-"))
3348 if (dosearch) { /* Look in '.' first. */
3349 const char *cur = scriptname;
3351 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3353 if (strEQ(ext[i++],curext)) {
3354 extidx = -1; /* already has an ext */
3359 DEBUG_p(PerlIO_printf(Perl_debug_log,
3360 "Looking for %s\n",cur));
3361 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3362 && !S_ISDIR(PL_statbuf.st_mode)) {
3370 if (cur == scriptname) {
3371 len = strlen(scriptname);
3372 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3374 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3377 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3378 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3383 if (dosearch && !strchr(scriptname, '/')
3385 && !strchr(scriptname, '\\')
3387 && (s = PerlEnv_getenv("PATH")))
3391 bufend = s + strlen(s);
3392 while (s < bufend) {
3395 && *s != ';'; len++, s++) {
3396 if (len < sizeof tmpbuf)
3399 if (len < sizeof tmpbuf)
3402 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3408 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3409 continue; /* don't search dir with too-long name */
3412 && tmpbuf[len - 1] != '/'
3413 && tmpbuf[len - 1] != '\\'
3416 tmpbuf[len++] = '/';
3417 if (len == 2 && tmpbuf[0] == '.')
3419 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3423 len = strlen(tmpbuf);
3424 if (extidx > 0) /* reset after previous loop */
3428 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3429 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3430 if (S_ISDIR(PL_statbuf.st_mode)) {
3434 } while ( retval < 0 /* not there */
3435 && extidx>=0 && ext[extidx] /* try an extension? */
3436 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3441 if (S_ISREG(PL_statbuf.st_mode)
3442 && cando(S_IRUSR,TRUE,&PL_statbuf)
3443 #if !defined(DOSISH)
3444 && cando(S_IXUSR,TRUE,&PL_statbuf)
3448 xfound = tmpbuf; /* bingo! */
3452 xfailed = savepv(tmpbuf);
3455 if (!xfound && !seen_dot && !xfailed &&
3456 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3457 || S_ISDIR(PL_statbuf.st_mode)))
3459 seen_dot = 1; /* Disable message. */
3461 if (flags & 1) { /* do or die? */
3462 /* diag_listed_as: Can't execute %s */
3463 Perl_croak(aTHX_ "Can't %s %s%s%s",
3464 (xfailed ? "execute" : "find"),
3465 (xfailed ? xfailed : scriptname),
3466 (xfailed ? "" : " on PATH"),
3467 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3472 scriptname = xfound;
3474 return (scriptname ? savepv(scriptname) : NULL);
3477 #ifndef PERL_GET_CONTEXT_DEFINED
3480 Perl_get_context(void)
3483 #if defined(USE_ITHREADS)
3484 # ifdef OLD_PTHREADS_API
3486 int error = pthread_getspecific(PL_thr_key, &t)
3488 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3491 # ifdef I_MACH_CTHREADS
3492 return (void*)cthread_data(cthread_self());
3494 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3503 Perl_set_context(void *t)
3506 PERL_ARGS_ASSERT_SET_CONTEXT;
3507 #if defined(USE_ITHREADS)
3508 # ifdef I_MACH_CTHREADS
3509 cthread_set_data(cthread_self(), t);
3512 const int error = pthread_setspecific(PL_thr_key, t);
3514 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3522 #endif /* !PERL_GET_CONTEXT_DEFINED */
3524 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3533 Perl_get_op_names(pTHX)
3535 PERL_UNUSED_CONTEXT;
3536 return (char **)PL_op_name;
3540 Perl_get_op_descs(pTHX)
3542 PERL_UNUSED_CONTEXT;
3543 return (char **)PL_op_desc;
3547 Perl_get_no_modify(pTHX)
3549 PERL_UNUSED_CONTEXT;
3550 return PL_no_modify;
3554 Perl_get_opargs(pTHX)
3556 PERL_UNUSED_CONTEXT;
3557 return (U32 *)PL_opargs;
3561 Perl_get_ppaddr(pTHX)
3564 PERL_UNUSED_CONTEXT;
3565 return (PPADDR_t*)PL_ppaddr;
3568 #ifndef HAS_GETENV_LEN
3570 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3572 char * const env_trans = PerlEnv_getenv(env_elem);
3573 PERL_UNUSED_CONTEXT;
3574 PERL_ARGS_ASSERT_GETENV_LEN;
3576 *len = strlen(env_trans);
3583 Perl_get_vtbl(pTHX_ int vtbl_id)
3585 PERL_UNUSED_CONTEXT;
3587 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3588 ? NULL : PL_magic_vtables + vtbl_id;
3592 Perl_my_fflush_all(pTHX)
3594 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3595 return PerlIO_flush(NULL);
3597 # if defined(HAS__FWALK)
3598 extern int fflush(FILE *);
3599 /* undocumented, unprototyped, but very useful BSDism */
3600 extern void _fwalk(int (*)(FILE *));
3604 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3606 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3607 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3609 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3610 open_max = sysconf(_SC_OPEN_MAX);
3613 open_max = FOPEN_MAX;
3616 open_max = OPEN_MAX;
3627 for (i = 0; i < open_max; i++)
3628 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3629 STDIO_STREAM_ARRAY[i]._file < open_max &&
3630 STDIO_STREAM_ARRAY[i]._flag)
3631 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3635 SETERRNO(EBADF,RMS_IFI);
3642 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3644 if (ckWARN(WARN_IO)) {
3646 = gv && (isGV_with_GP(gv))
3649 const char * const direction = have == '>' ? "out" : "in";
3651 if (name && HEK_LEN(name))
3652 Perl_warner(aTHX_ packWARN(WARN_IO),
3653 "Filehandle %"HEKf" opened only for %sput",
3656 Perl_warner(aTHX_ packWARN(WARN_IO),
3657 "Filehandle opened only for %sput", direction);
3662 Perl_report_evil_fh(pTHX_ const GV *gv)
3664 const IO *io = gv ? GvIO(gv) : NULL;
3665 const PERL_BITFIELD16 op = PL_op->op_type;
3669 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3671 warn_type = WARN_CLOSED;
3675 warn_type = WARN_UNOPENED;
3678 if (ckWARN(warn_type)) {
3680 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3681 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3682 const char * const pars =
3683 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3684 const char * const func =
3686 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3687 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3689 const char * const type =
3691 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3692 ? "socket" : "filehandle");
3693 const bool have_name = name && SvCUR(name);
3694 Perl_warner(aTHX_ packWARN(warn_type),
3695 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3696 have_name ? " " : "",
3697 SVfARG(have_name ? name : &PL_sv_no));
3698 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3700 aTHX_ packWARN(warn_type),
3701 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3702 func, pars, have_name ? " " : "",
3703 SVfARG(have_name ? name : &PL_sv_no)
3708 /* To workaround core dumps from the uninitialised tm_zone we get the
3709 * system to give us a reasonable struct to copy. This fix means that
3710 * strftime uses the tm_zone and tm_gmtoff values returned by
3711 * localtime(time()). That should give the desired result most of the
3712 * time. But probably not always!
3714 * This does not address tzname aspects of NETaa14816.
3719 # ifndef STRUCT_TM_HASZONE
3720 # define STRUCT_TM_HASZONE
3724 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3725 # ifndef HAS_TM_TM_ZONE
3726 # define HAS_TM_TM_ZONE
3731 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3733 #ifdef HAS_TM_TM_ZONE
3735 const struct tm* my_tm;
3736 PERL_ARGS_ASSERT_INIT_TM;
3738 my_tm = localtime(&now);
3740 Copy(my_tm, ptm, 1, struct tm);
3742 PERL_ARGS_ASSERT_INIT_TM;
3743 PERL_UNUSED_ARG(ptm);
3748 * mini_mktime - normalise struct tm values without the localtime()
3749 * semantics (and overhead) of mktime().
3752 Perl_mini_mktime(pTHX_ struct tm *ptm)
3756 int month, mday, year, jday;
3757 int odd_cent, odd_year;
3758 PERL_UNUSED_CONTEXT;
3760 PERL_ARGS_ASSERT_MINI_MKTIME;
3762 #define DAYS_PER_YEAR 365
3763 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3764 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3765 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3766 #define SECS_PER_HOUR (60*60)
3767 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3768 /* parentheses deliberately absent on these two, otherwise they don't work */
3769 #define MONTH_TO_DAYS 153/5
3770 #define DAYS_TO_MONTH 5/153
3771 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3772 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3773 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3774 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3777 * Year/day algorithm notes:
3779 * With a suitable offset for numeric value of the month, one can find
3780 * an offset into the year by considering months to have 30.6 (153/5) days,
3781 * using integer arithmetic (i.e., with truncation). To avoid too much
3782 * messing about with leap days, we consider January and February to be
3783 * the 13th and 14th month of the previous year. After that transformation,
3784 * we need the month index we use to be high by 1 from 'normal human' usage,
3785 * so the month index values we use run from 4 through 15.
3787 * Given that, and the rules for the Gregorian calendar (leap years are those
3788 * divisible by 4 unless also divisible by 100, when they must be divisible
3789 * by 400 instead), we can simply calculate the number of days since some
3790 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3791 * the days we derive from our month index, and adding in the day of the
3792 * month. The value used here is not adjusted for the actual origin which
3793 * it normally would use (1 January A.D. 1), since we're not exposing it.
3794 * We're only building the value so we can turn around and get the
3795 * normalised values for the year, month, day-of-month, and day-of-year.
3797 * For going backward, we need to bias the value we're using so that we find
3798 * the right year value. (Basically, we don't want the contribution of
3799 * March 1st to the number to apply while deriving the year). Having done
3800 * that, we 'count up' the contribution to the year number by accounting for
3801 * full quadracenturies (400-year periods) with their extra leap days, plus
3802 * the contribution from full centuries (to avoid counting in the lost leap
3803 * days), plus the contribution from full quad-years (to count in the normal
3804 * leap days), plus the leftover contribution from any non-leap years.
3805 * At this point, if we were working with an actual leap day, we'll have 0
3806 * days left over. This is also true for March 1st, however. So, we have
3807 * to special-case that result, and (earlier) keep track of the 'odd'
3808 * century and year contributions. If we got 4 extra centuries in a qcent,
3809 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3810 * Otherwise, we add back in the earlier bias we removed (the 123 from
3811 * figuring in March 1st), find the month index (integer division by 30.6),
3812 * and the remainder is the day-of-month. We then have to convert back to
3813 * 'real' months (including fixing January and February from being 14/15 in
3814 * the previous year to being in the proper year). After that, to get
3815 * tm_yday, we work with the normalised year and get a new yearday value for
3816 * January 1st, which we subtract from the yearday value we had earlier,
3817 * representing the date we've re-built. This is done from January 1
3818 * because tm_yday is 0-origin.
3820 * Since POSIX time routines are only guaranteed to work for times since the
3821 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3822 * applies Gregorian calendar rules even to dates before the 16th century
3823 * doesn't bother me. Besides, you'd need cultural context for a given
3824 * date to know whether it was Julian or Gregorian calendar, and that's
3825 * outside the scope for this routine. Since we convert back based on the
3826 * same rules we used to build the yearday, you'll only get strange results
3827 * for input which needed normalising, or for the 'odd' century years which
3828 * were leap years in the Julian calendar but not in the Gregorian one.
3829 * I can live with that.
3831 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3832 * that's still outside the scope for POSIX time manipulation, so I don't
3836 year = 1900 + ptm->tm_year;
3837 month = ptm->tm_mon;
3838 mday = ptm->tm_mday;
3844 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3845 yearday += month*MONTH_TO_DAYS + mday + jday;
3847 * Note that we don't know when leap-seconds were or will be,
3848 * so we have to trust the user if we get something which looks
3849 * like a sensible leap-second. Wild values for seconds will
3850 * be rationalised, however.
3852 if ((unsigned) ptm->tm_sec <= 60) {
3859 secs += 60 * ptm->tm_min;
3860 secs += SECS_PER_HOUR * ptm->tm_hour;
3862 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3863 /* got negative remainder, but need positive time */
3864 /* back off an extra day to compensate */
3865 yearday += (secs/SECS_PER_DAY)-1;
3866 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3869 yearday += (secs/SECS_PER_DAY);
3870 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3873 else if (secs >= SECS_PER_DAY) {
3874 yearday += (secs/SECS_PER_DAY);
3875 secs %= SECS_PER_DAY;
3877 ptm->tm_hour = secs/SECS_PER_HOUR;
3878 secs %= SECS_PER_HOUR;
3879 ptm->tm_min = secs/60;
3881 ptm->tm_sec += secs;
3882 /* done with time of day effects */
3884 * The algorithm for yearday has (so far) left it high by 428.
3885 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3886 * bias it by 123 while trying to figure out what year it
3887 * really represents. Even with this tweak, the reverse
3888 * translation fails for years before A.D. 0001.
3889 * It would still fail for Feb 29, but we catch that one below.
3891 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3892 yearday -= YEAR_ADJUST;
3893 year = (yearday / DAYS_PER_QCENT) * 400;
3894 yearday %= DAYS_PER_QCENT;
3895 odd_cent = yearday / DAYS_PER_CENT;
3896 year += odd_cent * 100;
3897 yearday %= DAYS_PER_CENT;
3898 year += (yearday / DAYS_PER_QYEAR) * 4;
3899 yearday %= DAYS_PER_QYEAR;
3900 odd_year = yearday / DAYS_PER_YEAR;
3902 yearday %= DAYS_PER_YEAR;
3903 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3908 yearday += YEAR_ADJUST; /* recover March 1st crock */
3909 month = yearday*DAYS_TO_MONTH;
3910 yearday -= month*MONTH_TO_DAYS;
3911 /* recover other leap-year adjustment */
3920 ptm->tm_year = year - 1900;
3922 ptm->tm_mday = yearday;
3923 ptm->tm_mon = month;
3927 ptm->tm_mon = month - 1;
3929 /* re-build yearday based on Jan 1 to get tm_yday */
3931 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3932 yearday += 14*MONTH_TO_DAYS + 1;
3933 ptm->tm_yday = jday - yearday;
3934 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3938 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)
3946 PERL_ARGS_ASSERT_MY_STRFTIME;
3948 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3951 mytm.tm_hour = hour;
3952 mytm.tm_mday = mday;
3954 mytm.tm_year = year;
3955 mytm.tm_wday = wday;
3956 mytm.tm_yday = yday;
3957 mytm.tm_isdst = isdst;
3959 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3960 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3965 #ifdef HAS_TM_TM_GMTOFF
3966 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3968 #ifdef HAS_TM_TM_ZONE
3969 mytm.tm_zone = mytm2.tm_zone;
3974 Newx(buf, buflen, char);
3975 len = strftime(buf, buflen, fmt, &mytm);
3977 ** The following is needed to handle to the situation where
3978 ** tmpbuf overflows. Basically we want to allocate a buffer
3979 ** and try repeatedly. The reason why it is so complicated
3980 ** is that getting a return value of 0 from strftime can indicate
3981 ** one of the following:
3982 ** 1. buffer overflowed,
3983 ** 2. illegal conversion specifier, or
3984 ** 3. the format string specifies nothing to be returned(not
3985 ** an error). This could be because format is an empty string
3986 ** or it specifies %p that yields an empty string in some locale.
3987 ** If there is a better way to make it portable, go ahead by
3990 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3993 /* Possibly buf overflowed - try again with a bigger buf */
3994 const int fmtlen = strlen(fmt);
3995 int bufsize = fmtlen + buflen;
3997 Renew(buf, bufsize, char);
3999 buflen = strftime(buf, bufsize, fmt, &mytm);
4000 if (buflen > 0 && buflen < bufsize)
4002 /* heuristic to prevent out-of-memory errors */
4003 if (bufsize > 100*fmtlen) {
4009 Renew(buf, bufsize, char);
4014 Perl_croak(aTHX_ "panic: no strftime");
4020 #define SV_CWD_RETURN_UNDEF \
4021 sv_setsv(sv, &PL_sv_undef); \
4024 #define SV_CWD_ISDOT(dp) \
4025 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
4026 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
4029 =head1 Miscellaneous Functions
4031 =for apidoc getcwd_sv
4033 Fill the sv with current working directory
4038 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
4039 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
4040 * getcwd(3) if available
4041 * Comments from the orignal:
4042 * This is a faster version of getcwd. It's also more dangerous
4043 * because you might chdir out of a directory that you can't chdir
4047 Perl_getcwd_sv(pTHX_ SV *sv)
4051 #ifndef INCOMPLETE_TAINTS
4055 PERL_ARGS_ASSERT_GETCWD_SV;
4059 char buf[MAXPATHLEN];
4061 /* Some getcwd()s automatically allocate a buffer of the given
4062 * size from the heap if they are given a NULL buffer pointer.
4063 * The problem is that this behaviour is not portable. */
4064 if (getcwd(buf, sizeof(buf) - 1)) {
4069 sv_setsv(sv, &PL_sv_undef);
4077 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
4081 SvUPGRADE(sv, SVt_PV);
4083 if (PerlLIO_lstat(".", &statbuf) < 0) {
4084 SV_CWD_RETURN_UNDEF;
4087 orig_cdev = statbuf.st_dev;
4088 orig_cino = statbuf.st_ino;
4098 if (PerlDir_chdir("..") < 0) {
4099 SV_CWD_RETURN_UNDEF;
4101 if (PerlLIO_stat(".", &statbuf) < 0) {
4102 SV_CWD_RETURN_UNDEF;
4105 cdev = statbuf.st_dev;
4106 cino = statbuf.st_ino;
4108 if (odev == cdev && oino == cino) {
4111 if (!(dir = PerlDir_open("."))) {
4112 SV_CWD_RETURN_UNDEF;
4115 while ((dp = PerlDir_read(dir)) != NULL) {
4117 namelen = dp->d_namlen;
4119 namelen = strlen(dp->d_name);
4122 if (SV_CWD_ISDOT(dp)) {
4126 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
4127 SV_CWD_RETURN_UNDEF;
4130 tdev = statbuf.st_dev;
4131 tino = statbuf.st_ino;
4132 if (tino == oino && tdev == odev) {
4138 SV_CWD_RETURN_UNDEF;
4141 if (pathlen + namelen + 1 >= MAXPATHLEN) {
4142 SV_CWD_RETURN_UNDEF;
4145 SvGROW(sv, pathlen + namelen + 1);
4149 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
4152 /* prepend current directory to the front */
4154 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
4155 pathlen += (namelen + 1);
4157 #ifdef VOID_CLOSEDIR
4160 if (PerlDir_close(dir) < 0) {
4161 SV_CWD_RETURN_UNDEF;
4167 SvCUR_set(sv, pathlen);
4171 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
4172 SV_CWD_RETURN_UNDEF;
4175 if (PerlLIO_stat(".", &statbuf) < 0) {
4176 SV_CWD_RETURN_UNDEF;
4179 cdev = statbuf.st_dev;
4180 cino = statbuf.st_ino;
4182 if (cdev != orig_cdev || cino != orig_cino) {
4183 Perl_croak(aTHX_ "Unstable directory path, "
4184 "current directory changed unexpectedly");
4195 #define VERSION_MAX 0x7FFFFFFF
4198 =for apidoc prescan_version
4200 Validate that a given string can be parsed as a version object, but doesn't
4201 actually perform the parsing. Can use either strict or lax validation rules.
4202 Can optionally set a number of hint variables to save the parsing code
4203 some time when tokenizing.
4208 Perl_prescan_version(pTHX_ const char *s, bool strict,
4209 const char **errstr,
4210 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
4211 bool qv = (sqv ? *sqv : FALSE);
4213 int saw_decimal = 0;
4217 PERL_ARGS_ASSERT_PRESCAN_VERSION;
4219 if (qv && isDIGIT(*d))
4220 goto dotted_decimal_version;
4222 if (*d == 'v') { /* explicit v-string */
4227 else { /* degenerate v-string */
4228 /* requires v1.2.3 */
4229 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4232 dotted_decimal_version:
4233 if (strict && d[0] == '0' && isDIGIT(d[1])) {
4234 /* no leading zeros allowed */
4235 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4238 while (isDIGIT(*d)) /* integer part */
4244 d++; /* decimal point */
4249 /* require v1.2.3 */
4250 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4253 goto version_prescan_finish;
4260 while (isDIGIT(*d)) { /* just keep reading */
4262 while (isDIGIT(*d)) {
4264 /* maximum 3 digits between decimal */
4265 if (strict && j > 3) {
4266 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4271 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4274 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4279 else if (*d == '.') {
4281 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4286 else if (!isDIGIT(*d)) {
4292 if (strict && i < 2) {
4293 /* requires v1.2.3 */
4294 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4297 } /* end if dotted-decimal */
4299 { /* decimal versions */
4300 int j = 0; /* may need this later */
4301 /* special strict case for leading '.' or '0' */
4304 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4306 if (*d == '0' && isDIGIT(d[1])) {
4307 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4311 /* and we never support negative versions */
4313 BADVERSION(s,errstr,"Invalid version format (negative version number)");
4316 /* consume all of the integer part */
4320 /* look for a fractional part */
4322 /* we found it, so consume it */
4326 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4329 BADVERSION(s,errstr,"Invalid version format (version required)");
4331 /* found just an integer */
4332 goto version_prescan_finish;
4334 else if ( d == s ) {
4335 /* didn't find either integer or period */
4336 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4338 else if (*d == '_') {
4339 /* underscore can't come after integer part */
4341 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4343 else if (isDIGIT(d[1])) {
4344 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4347 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4351 /* anything else after integer part is just invalid data */
4352 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4355 /* scan the fractional part after the decimal point*/
4357 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4358 /* strict or lax-but-not-the-end */
4359 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4362 while (isDIGIT(*d)) {
4364 if (*d == '.' && isDIGIT(d[-1])) {
4366 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4369 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4371 d = (char *)s; /* start all over again */
4373 goto dotted_decimal_version;
4377 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4380 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4382 if ( ! isDIGIT(d[1]) ) {
4383 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4392 version_prescan_finish:
4396 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4397 /* trailing non-numeric data */
4398 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4406 *ssaw_decimal = saw_decimal;
4413 =for apidoc scan_version
4415 Returns a pointer to the next character after the parsed
4416 version string, as well as upgrading the passed in SV to
4419 Function must be called with an already existing SV like
4422 s = scan_version(s, SV *sv, bool qv);
4424 Performs some preprocessing to the string to ensure that
4425 it has the correct characteristics of a version. Flags the
4426 object if it contains an underscore (which denotes this
4427 is an alpha version). The boolean qv denotes that the version
4428 should be interpreted as if it had multiple decimals, even if
4435 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4437 const char *start = s;
4440 const char *errstr = NULL;
4441 int saw_decimal = 0;
4448 PERL_ARGS_ASSERT_SCAN_VERSION;
4450 while (isSPACE(*s)) /* leading whitespace is OK */
4453 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4455 /* "undef" is a special case and not an error */
4456 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4458 Perl_croak(aTHX_ "%s", errstr);
4467 /* Now that we are through the prescan, start creating the object */
4469 hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4470 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4472 #ifndef NODEFAULT_SHAREKEYS
4473 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4477 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4479 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4480 if ( !qv && width < 3 )
4481 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4483 while (isDIGIT(*pos))
4485 if (!isALPHA(*pos)) {
4491 /* this is atoi() that delimits on underscores */
4492 const char *end = pos;
4496 /* the following if() will only be true after the decimal
4497 * point of a version originally created with a bare
4498 * floating point number, i.e. not quoted in any way
4500 if ( !qv && s > start && saw_decimal == 1 ) {
4504 rev += (*s - '0') * mult;
4506 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4507 || (PERL_ABS(rev) > VERSION_MAX )) {
4508 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4509 "Integer overflow in version %d",VERSION_MAX);
4520 while (--end >= s) {
4522 rev += (*end - '0') * mult;
4524 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4525 || (PERL_ABS(rev) > VERSION_MAX )) {
4526 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4527 "Integer overflow in version");
4536 /* Append revision */
4537 av_push(av, newSViv(rev));
4542 else if ( *pos == '.' )
4544 else if ( *pos == '_' && isDIGIT(pos[1]) )
4546 else if ( *pos == ',' && isDIGIT(pos[1]) )
4548 else if ( isDIGIT(*pos) )
4555 while ( isDIGIT(*pos) )
4560 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4568 if ( qv ) { /* quoted versions always get at least three terms*/
4569 I32 len = av_len(av);
4570 /* This for loop appears to trigger a compiler bug on OS X, as it
4571 loops infinitely. Yes, len is negative. No, it makes no sense.
4572 Compiler in question is:
4573 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4574 for ( len = 2 - len; len > 0; len-- )
4575 av_push(MUTABLE_AV(sv), newSViv(0));
4579 av_push(av, newSViv(0));
4582 /* need to save off the current version string for later */
4584 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4585 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4586 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4588 else if ( s > start ) {
4589 SV * orig = newSVpvn(start,s-start);
4590 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4591 /* need to insert a v to be consistent */
4592 sv_insert(orig, 0, 0, "v", 1);
4594 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4597 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4598 av_push(av, newSViv(0));
4601 /* And finally, store the AV in the hash */
4602 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4604 /* fix RT#19517 - special case 'undef' as string */
4605 if ( *s == 'u' && strEQ(s,"undef") ) {
4613 =for apidoc new_version
4615 Returns a new version object based on the passed in SV:
4617 SV *sv = new_version(SV *ver);
4619 Does not alter the passed in ver SV. See "upg_version" if you
4620 want to upgrade the SV.
4626 Perl_new_version(pTHX_ SV *ver)
4629 SV * const rv = newSV(0);
4630 PERL_ARGS_ASSERT_NEW_VERSION;
4631 if ( sv_isobject(ver) && sv_derived_from(ver, "version") )
4632 /* can just copy directly */
4635 AV * const av = newAV();
4637 /* This will get reblessed later if a derived class*/
4638 SV * const hv = newSVrv(rv, "version");
4639 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4640 #ifndef NODEFAULT_SHAREKEYS
4641 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4647 /* Begin copying all of the elements */
4648 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4649 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4651 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4652 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4654 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4656 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4657 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4660 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4662 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4663 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4666 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4667 /* This will get reblessed later if a derived class*/
4668 for ( key = 0; key <= av_len(sav); key++ )
4670 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4671 av_push(av, newSViv(rev));
4674 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4679 const MAGIC* const mg = SvVSTRING_mg(ver);
4680 if ( mg ) { /* already a v-string */
4681 const STRLEN len = mg->mg_len;
4682 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4683 sv_setpvn(rv,version,len);
4684 /* this is for consistency with the pure Perl class */
4685 if ( isDIGIT(*version) )
4686 sv_insert(rv, 0, 0, "v", 1);
4691 sv_setsv(rv,ver); /* make a duplicate */
4696 return upg_version(rv, FALSE);
4700 =for apidoc upg_version
4702 In-place upgrade of the supplied SV to a version object.
4704 SV *sv = upg_version(SV *sv, bool qv);
4706 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4707 to force this SV to be interpreted as an "extended" version.
4713 Perl_upg_version(pTHX_ SV *ver, bool qv)
4715 const char *version, *s;
4720 PERL_ARGS_ASSERT_UPG_VERSION;
4722 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4726 /* may get too much accuracy */
4728 SV *sv = SvNVX(ver) > 10e50 ? newSV(64) : 0;
4730 #ifdef USE_LOCALE_NUMERIC
4731 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
4732 setlocale(LC_NUMERIC, "C");
4735 Perl_sv_setpvf(aTHX_ sv, "%.9"NVff, SvNVX(ver));
4736 buf = SvPV(sv, len);
4739 len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4742 #ifdef USE_LOCALE_NUMERIC
4743 setlocale(LC_NUMERIC, loc);
4746 while (buf[len-1] == '0' && len > 0) len--;
4747 if ( buf[len-1] == '.' ) len--; /* eat the trailing decimal */
4748 version = savepvn(buf, len);
4752 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4753 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4757 else /* must be a string or something like a string */
4760 version = savepv(SvPV(ver,len));
4762 # if PERL_VERSION > 5
4763 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4764 if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
4765 /* may be a v-string */
4766 char *testv = (char *)version;
4768 for (tlen=0; tlen < len; tlen++, testv++) {
4769 /* if one of the characters is non-text assume v-string */
4770 if (testv[0] < ' ') {
4771 SV * const nsv = sv_newmortal();
4774 int saw_decimal = 0;
4775 sv_setpvf(nsv,"v%vd",ver);
4776 pos = nver = savepv(SvPV_nolen(nsv));
4778 /* scan the resulting formatted string */
4779 pos++; /* skip the leading 'v' */
4780 while ( *pos == '.' || isDIGIT(*pos) ) {
4786 /* is definitely a v-string */
4787 if ( saw_decimal >= 2 ) {
4799 s = scan_version(version, ver, qv);
4801 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4802 "Version string '%s' contains invalid data; "
4803 "ignoring: '%s'", version, s);
4811 Validates that the SV contains valid internal structure for a version object.
4812 It may be passed either the version object (RV) or the hash itself (HV). If
4813 the structure is valid, it returns the HV. If the structure is invalid,
4816 SV *hv = vverify(sv);
4818 Note that it only confirms the bare minimum structure (so as not to get
4819 confused by derived classes which may contain additional hash entries):
4823 =item * The SV is an HV or a reference to an HV
4825 =item * The hash contains a "version" key
4827 =item * The "version" key has a reference to an AV as its value
4835 Perl_vverify(pTHX_ SV *vs)
4839 PERL_ARGS_ASSERT_VVERIFY;
4844 /* see if the appropriate elements exist */
4845 if ( SvTYPE(vs) == SVt_PVHV
4846 && hv_exists(MUTABLE_HV(vs), "version", 7)
4847 && (sv = SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)))
4848 && SvTYPE(sv) == SVt_PVAV )
4857 Accepts a version object and returns the normalized floating
4858 point representation. Call like:
4862 NOTE: you can pass either the object directly or the SV
4863 contained within the RV.
4865 The SV returned has a refcount of 1.
4871 Perl_vnumify(pTHX_ SV *vs)
4879 PERL_ARGS_ASSERT_VNUMIFY;
4881 /* extract the HV from the object */
4884 Perl_croak(aTHX_ "Invalid version object");
4886 /* see if various flags exist */
4887 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
4889 if ( hv_exists(MUTABLE_HV(vs), "width", 5 ) )
4890 width = SvIV(*hv_fetchs(MUTABLE_HV(vs), "width", FALSE));
4895 /* attempt to retrieve the version array */
4896 if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
4897 return newSVpvs("0");
4903 return newSVpvs("0");
4906 digit = SvIV(*av_fetch(av, 0, 0));
4907 sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
4908 for ( i = 1 ; i < len ; i++ )
4910 digit = SvIV(*av_fetch(av, i, 0));
4912 const int denom = (width == 2 ? 10 : 100);
4913 const div_t term = div((int)PERL_ABS(digit),denom);
4914 Perl_sv_catpvf(aTHX_ sv, "%0*d_%d", width, term.quot, term.rem);
4917 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
4923 digit = SvIV(*av_fetch(av, len, 0));
4924 if ( alpha && width == 3 ) /* alpha version */
4926 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
4930 sv_catpvs(sv, "000");
4938 Accepts a version object and returns the normalized string
4939 representation. Call like:
4943 NOTE: you can pass either the object directly or the SV
4944 contained within the RV.
4946 The SV returned has a refcount of 1.
4952 Perl_vnormal(pTHX_ SV *vs)
4959 PERL_ARGS_ASSERT_VNORMAL;
4961 /* extract the HV from the object */
4964 Perl_croak(aTHX_ "Invalid version object");
4966 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
4968 av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
4973 return newSVpvs("");
4975 digit = SvIV(*av_fetch(av, 0, 0));
4976 sv = Perl_newSVpvf(aTHX_ "v%"IVdf, (IV)digit);
4977 for ( i = 1 ; i < len ; i++ ) {
4978 digit = SvIV(*av_fetch(av, i, 0));
4979 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
4984 /* handle last digit specially */
4985 digit = SvIV(*av_fetch(av, len, 0));
4987 Perl_sv_catpvf(aTHX_ sv, "_%"IVdf, (IV)digit);
4989 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
4992 if ( len <= 2 ) { /* short version, must be at least three */
4993 for ( len = 2 - len; len != 0; len-- )
5000 =for apidoc vstringify
5002 In order to maintain maximum compatibility with earlier versions
5003 of Perl, this function will return either the floating point
5004 notation or the multiple dotted notation, depending on whether
5005 the original version contained 1 or more dots, respectively.
5007 The SV returned has a refcount of 1.
5013 Perl_vstringify(pTHX_ SV *vs)
5015 PERL_ARGS_ASSERT_VSTRINGIFY;
5017 /* extract the HV from the object */
5020 Perl_croak(aTHX_ "Invalid version object");
5022 if (hv_exists(MUTABLE_HV(vs), "original", sizeof("original") - 1)) {
5024 pv = *hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
5028 return &PL_sv_undef;
5031 if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
5041 Version object aware cmp. Both operands must already have been
5042 converted into version objects.
5048 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
5051 bool lalpha = FALSE;
5052 bool ralpha = FALSE;
5057 PERL_ARGS_ASSERT_VCMP;
5059 /* extract the HVs from the objects */
5062 if ( ! ( lhv && rhv ) )
5063 Perl_croak(aTHX_ "Invalid version object");
5065 /* get the left hand term */
5066 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
5067 if ( hv_exists(MUTABLE_HV(lhv), "alpha", 5 ) )
5070 /* and the right hand term */
5071 rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
5072 if ( hv_exists(MUTABLE_HV(rhv), "alpha", 5 ) )
5080 while ( i <= m && retval == 0 )
5082 left = SvIV(*av_fetch(lav,i,0));
5083 right = SvIV(*av_fetch(rav,i,0));
5091 /* tiebreaker for alpha with identical terms */
5092 if ( retval == 0 && l == r && left == right && ( lalpha || ralpha ) )
5094 if ( lalpha && !ralpha )
5098 else if ( ralpha && !lalpha)
5104 if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
5108 while ( i <= r && retval == 0 )
5110 if ( SvIV(*av_fetch(rav,i,0)) != 0 )
5111 retval = -1; /* not a match after all */
5117 while ( i <= l && retval == 0 )
5119 if ( SvIV(*av_fetch(lav,i,0)) != 0 )
5120 retval = +1; /* not a match after all */
5128 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
5129 # define EMULATE_SOCKETPAIR_UDP
5132 #ifdef EMULATE_SOCKETPAIR_UDP
5134 S_socketpair_udp (int fd[2]) {
5136 /* Fake a datagram socketpair using UDP to localhost. */
5137 int sockets[2] = {-1, -1};
5138 struct sockaddr_in addresses[2];
5140 Sock_size_t size = sizeof(struct sockaddr_in);
5141 unsigned short port;
5144 memset(&addresses, 0, sizeof(addresses));
5147 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
5148 if (sockets[i] == -1)
5149 goto tidy_up_and_fail;
5151 addresses[i].sin_family = AF_INET;
5152 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5153 addresses[i].sin_port = 0; /* kernel choses port. */
5154 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
5155 sizeof(struct sockaddr_in)) == -1)
5156 goto tidy_up_and_fail;
5159 /* Now have 2 UDP sockets. Find out which port each is connected to, and
5160 for each connect the other socket to it. */
5163 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
5165 goto tidy_up_and_fail;
5166 if (size != sizeof(struct sockaddr_in))
5167 goto abort_tidy_up_and_fail;
5168 /* !1 is 0, !0 is 1 */
5169 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
5170 sizeof(struct sockaddr_in)) == -1)
5171 goto tidy_up_and_fail;
5174 /* Now we have 2 sockets connected to each other. I don't trust some other
5175 process not to have already sent a packet to us (by random) so send
5176 a packet from each to the other. */
5179 /* I'm going to send my own port number. As a short.
5180 (Who knows if someone somewhere has sin_port as a bitfield and needs
5181 this routine. (I'm assuming crays have socketpair)) */
5182 port = addresses[i].sin_port;
5183 got = PerlLIO_write(sockets[i], &port, sizeof(port));
5184 if (got != sizeof(port)) {
5186 goto tidy_up_and_fail;
5187 goto abort_tidy_up_and_fail;
5191 /* Packets sent. I don't trust them to have arrived though.
5192 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
5193 connect to localhost will use a second kernel thread. In 2.6 the
5194 first thread running the connect() returns before the second completes,
5195 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
5196 returns 0. Poor programs have tripped up. One poor program's authors'
5197 had a 50-1 reverse stock split. Not sure how connected these were.)
5198 So I don't trust someone not to have an unpredictable UDP stack.
5202 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
5203 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
5207 FD_SET((unsigned int)sockets[0], &rset);
5208 FD_SET((unsigned int)sockets[1], &rset);
5210 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
5211 if (got != 2 || !FD_ISSET(sockets[0], &rset)
5212 || !FD_ISSET(sockets[1], &rset)) {
5213 /* I hope this is portable and appropriate. */
5215 goto tidy_up_and_fail;
5216 goto abort_tidy_up_and_fail;
5220 /* And the paranoia department even now doesn't trust it to have arrive
5221 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
5223 struct sockaddr_in readfrom;
5224 unsigned short buffer[2];
5229 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5230 sizeof(buffer), MSG_DONTWAIT,
5231 (struct sockaddr *) &readfrom, &size);
5233 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
5235 (struct sockaddr *) &readfrom, &size);
5239 goto tidy_up_and_fail;
5240 if (got != sizeof(port)
5241 || size != sizeof(struct sockaddr_in)
5242 /* Check other socket sent us its port. */
5243 || buffer[0] != (unsigned short) addresses[!i].sin_port
5244 /* Check kernel says we got the datagram from that socket */
5245 || readfrom.sin_family != addresses[!i].sin_family
5246 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
5247 || readfrom.sin_port != addresses[!i].sin_port)
5248 goto abort_tidy_up_and_fail;
5251 /* My caller (my_socketpair) has validated that this is non-NULL */
5254 /* I hereby declare this connection open. May God bless all who cross
5258 abort_tidy_up_and_fail:
5259 errno = ECONNABORTED;
5263 if (sockets[0] != -1)
5264 PerlLIO_close(sockets[0]);
5265 if (sockets[1] != -1)
5266 PerlLIO_close(sockets[1]);
5271 #endif /* EMULATE_SOCKETPAIR_UDP */
5273 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
5275 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5276 /* Stevens says that family must be AF_LOCAL, protocol 0.
5277 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
5282 struct sockaddr_in listen_addr;
5283 struct sockaddr_in connect_addr;
5288 || family != AF_UNIX
5291 errno = EAFNOSUPPORT;
5299 #ifdef EMULATE_SOCKETPAIR_UDP
5300 if (type == SOCK_DGRAM)
5301 return S_socketpair_udp(fd);
5304 aTHXa(PERL_GET_THX);
5305 listener = PerlSock_socket(AF_INET, type, 0);
5308 memset(&listen_addr, 0, sizeof(listen_addr));
5309 listen_addr.sin_family = AF_INET;
5310 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5311 listen_addr.sin_port = 0; /* kernel choses port. */
5312 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
5313 sizeof(listen_addr)) == -1)
5314 goto tidy_up_and_fail;
5315 if (PerlSock_listen(listener, 1) == -1)
5316 goto tidy_up_and_fail;
5318 connector = PerlSock_socket(AF_INET, type, 0);
5319 if (connector == -1)
5320 goto tidy_up_and_fail;
5321 /* We want to find out the port number to connect to. */
5322 size = sizeof(connect_addr);
5323 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
5325 goto tidy_up_and_fail;
5326 if (size != sizeof(connect_addr))
5327 goto abort_tidy_up_and_fail;
5328 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
5329 sizeof(connect_addr)) == -1)
5330 goto tidy_up_and_fail;
5332 size = sizeof(listen_addr);
5333 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
5336 goto tidy_up_and_fail;
5337 if (size != sizeof(listen_addr))
5338 goto abort_tidy_up_and_fail;
5339 PerlLIO_close(listener);
5340 /* Now check we are talking to ourself by matching port and host on the
5342 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
5344 goto tidy_up_and_fail;
5345 if (size != sizeof(connect_addr)
5346 || listen_addr.sin_family != connect_addr.sin_family
5347 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
5348 || listen_addr.sin_port != connect_addr.sin_port) {
5349 goto abort_tidy_up_and_fail;
5355 abort_tidy_up_and_fail:
5357 errno = ECONNABORTED; /* This would be the standard thing to do. */
5359 # ifdef ECONNREFUSED
5360 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
5362 errno = ETIMEDOUT; /* Desperation time. */
5369 PerlLIO_close(listener);
5370 if (connector != -1)
5371 PerlLIO_close(connector);
5373 PerlLIO_close(acceptor);
5379 /* In any case have a stub so that there's code corresponding
5380 * to the my_socketpair in embed.fnc. */
5382 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5383 #ifdef HAS_SOCKETPAIR
5384 return socketpair(family, type, protocol, fd);
5393 =for apidoc sv_nosharing
5395 Dummy routine which "shares" an SV when there is no sharing module present.
5396 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
5397 Exists to avoid test for a NULL function pointer and because it could
5398 potentially warn under some level of strict-ness.
5404 Perl_sv_nosharing(pTHX_ SV *sv)
5406 PERL_UNUSED_CONTEXT;
5407 PERL_UNUSED_ARG(sv);
5412 =for apidoc sv_destroyable
5414 Dummy routine which reports that object can be destroyed when there is no
5415 sharing module present. It ignores its single SV argument, and returns
5416 'true'. Exists to avoid test for a NULL function pointer and because it
5417 could potentially warn under some level of strict-ness.
5423 Perl_sv_destroyable(pTHX_ SV *sv)
5425 PERL_UNUSED_CONTEXT;
5426 PERL_UNUSED_ARG(sv);
5431 Perl_parse_unicode_opts(pTHX_ const char **popt)
5433 const char *p = *popt;
5436 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
5440 opt = (U32) atoi(p);
5443 if (*p && *p != '\n' && *p != '\r') {
5444 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5446 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
5452 case PERL_UNICODE_STDIN:
5453 opt |= PERL_UNICODE_STDIN_FLAG; break;
5454 case PERL_UNICODE_STDOUT:
5455 opt |= PERL_UNICODE_STDOUT_FLAG; break;
5456 case PERL_UNICODE_STDERR:
5457 opt |= PERL_UNICODE_STDERR_FLAG; break;
5458 case PERL_UNICODE_STD:
5459 opt |= PERL_UNICODE_STD_FLAG; break;
5460 case PERL_UNICODE_IN:
5461 opt |= PERL_UNICODE_IN_FLAG; break;
5462 case PERL_UNICODE_OUT:
5463 opt |= PERL_UNICODE_OUT_FLAG; break;
5464 case PERL_UNICODE_INOUT:
5465 opt |= PERL_UNICODE_INOUT_FLAG; break;
5466 case PERL_UNICODE_LOCALE:
5467 opt |= PERL_UNICODE_LOCALE_FLAG; break;
5468 case PERL_UNICODE_ARGV:
5469 opt |= PERL_UNICODE_ARGV_FLAG; break;
5470 case PERL_UNICODE_UTF8CACHEASSERT:
5471 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
5473 if (*p != '\n' && *p != '\r') {
5474 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5477 "Unknown Unicode option letter '%c'", *p);
5484 opt = PERL_UNICODE_DEFAULT_FLAGS;
5486 the_end_of_the_opts_parser:
5488 if (opt & ~PERL_UNICODE_ALL_FLAGS)
5489 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
5490 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
5498 # include <starlet.h>
5506 * This is really just a quick hack which grabs various garbage
5507 * values. It really should be a real hash algorithm which
5508 * spreads the effect of every input bit onto every output bit,
5509 * if someone who knows about such things would bother to write it.
5510 * Might be a good idea to add that function to CORE as well.
5511 * No numbers below come from careful analysis or anything here,
5512 * except they are primes and SEED_C1 > 1E6 to get a full-width
5513 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
5514 * probably be bigger too.
5517 # define SEED_C1 1000003
5518 #define SEED_C4 73819
5520 # define SEED_C1 25747
5521 #define SEED_C4 20639
5525 #define SEED_C5 26107
5527 #ifndef PERL_NO_DEV_RANDOM
5532 /* when[] = (low 32 bits, high 32 bits) of time since epoch
5533 * in 100-ns units, typically incremented ever 10 ms. */
5534 unsigned int when[2];
5536 # ifdef HAS_GETTIMEOFDAY
5537 struct timeval when;
5543 /* This test is an escape hatch, this symbol isn't set by Configure. */
5544 #ifndef PERL_NO_DEV_RANDOM
5545 #ifndef PERL_RANDOM_DEVICE
5546 /* /dev/random isn't used by default because reads from it will block
5547 * if there isn't enough entropy available. You can compile with
5548 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
5549 * is enough real entropy to fill the seed. */
5550 # define PERL_RANDOM_DEVICE "/dev/urandom"
5552 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
5554 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
5563 _ckvmssts(sys$gettim(when));
5564 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
5566 # ifdef HAS_GETTIMEOFDAY
5567 PerlProc_gettimeofday(&when,NULL);
5568 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
5571 u = (U32)SEED_C1 * when;
5574 u += SEED_C3 * (U32)PerlProc_getpid();
5575 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
5576 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
5577 u += SEED_C5 * (U32)PTR2UV(&when);
5583 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
5589 PERL_ARGS_ASSERT_GET_HASH_SEED;
5591 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
5594 #ifndef USE_HASH_SEED_EXPLICIT
5596 /* ignore leading spaces */
5597 while (isSPACE(*env_pv))
5599 #ifdef USE_PERL_PERTURB_KEYS
5600 /* if they set it to "0" we disable key traversal randomization completely */
5601 if (strEQ(env_pv,"0")) {
5602 PL_hash_rand_bits_enabled= 0;
5604 /* otherwise switch to deterministic mode */
5605 PL_hash_rand_bits_enabled= 2;
5608 /* ignore a leading 0x... if it is there */
5609 if (env_pv[0] == '0' && env_pv[1] == 'x')
5612 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
5613 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
5614 if ( isXDIGIT(*env_pv)) {
5615 seed_buffer[i] |= READ_XDIGIT(env_pv);
5618 while (isSPACE(*env_pv))
5621 if (*env_pv && !isXDIGIT(*env_pv)) {
5622 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
5624 /* should we check for unparsed crap? */
5625 /* should we warn about unused hex? */
5626 /* should we warn about insufficient hex? */
5631 (void)seedDrand01((Rand_seed_t)seed());
5633 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
5634 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
5637 #ifdef USE_PERL_PERTURB_KEYS
5638 { /* initialize PL_hash_rand_bits from the hash seed.
5639 * This value is highly volatile, it is updated every
5640 * hash insert, and is used as part of hash bucket chain
5641 * randomization and hash iterator randomization. */
5642 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
5643 for( i = 0; i < sizeof(UV) ; i++ ) {
5644 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
5645 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
5648 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
5650 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
5651 PL_hash_rand_bits_enabled= 0;
5652 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
5653 PL_hash_rand_bits_enabled= 1;
5654 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
5655 PL_hash_rand_bits_enabled= 2;
5657 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
5663 #ifdef PERL_GLOBAL_STRUCT
5665 #define PERL_GLOBAL_STRUCT_INIT
5666 #include "opcode.h" /* the ppaddr and check */
5669 Perl_init_global_struct(pTHX)
5671 struct perl_vars *plvarsp = NULL;
5672 # ifdef PERL_GLOBAL_STRUCT
5673 const IV nppaddr = sizeof(Gppaddr)/sizeof(Perl_ppaddr_t);
5674 const IV ncheck = sizeof(Gcheck) /sizeof(Perl_check_t);
5675 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5676 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
5677 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
5681 plvarsp = PL_VarsPtr;
5682 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
5687 # define PERLVAR(prefix,var,type) /**/
5688 # define PERLVARA(prefix,var,n,type) /**/
5689 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
5690 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
5691 # include "perlvars.h"
5696 # ifdef PERL_GLOBAL_STRUCT
5699 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
5700 if (!plvarsp->Gppaddr)
5704 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
5705 if (!plvarsp->Gcheck)
5707 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
5708 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
5710 # ifdef PERL_SET_VARS
5711 PERL_SET_VARS(plvarsp);
5713 # undef PERL_GLOBAL_STRUCT_INIT
5718 #endif /* PERL_GLOBAL_STRUCT */
5720 #ifdef PERL_GLOBAL_STRUCT
5723 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
5725 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
5726 # ifdef PERL_GLOBAL_STRUCT
5727 # ifdef PERL_UNSET_VARS
5728 PERL_UNSET_VARS(plvarsp);
5730 free(plvarsp->Gppaddr);
5731 free(plvarsp->Gcheck);
5732 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5738 #endif /* PERL_GLOBAL_STRUCT */
5742 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
5743 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5744 * given, and you supply your own implementation.
5746 * The default implementation reads a single env var, PERL_MEM_LOG,
5747 * expecting one or more of the following:
5749 * \d+ - fd fd to write to : must be 1st (atoi)
5750 * 'm' - memlog was PERL_MEM_LOG=1
5751 * 's' - svlog was PERL_SV_LOG=1
5752 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5754 * This makes the logger controllable enough that it can reasonably be
5755 * added to the system perl.
5758 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5759 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5761 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
5763 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5764 * writes to. In the default logger, this is settable at runtime.
5766 #ifndef PERL_MEM_LOG_FD
5767 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5770 #ifndef PERL_MEM_LOG_NOIMPL
5772 # ifdef DEBUG_LEAKING_SCALARS
5773 # define SV_LOG_SERIAL_FMT " [%lu]"
5774 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5776 # define SV_LOG_SERIAL_FMT
5777 # define _SV_LOG_SERIAL_ARG(sv)
5781 S_mem_log_common(enum mem_log_type mlt, const UV n,
5782 const UV typesize, const char *type_name, const SV *sv,
5783 Malloc_t oldalloc, Malloc_t newalloc,
5784 const char *filename, const int linenumber,
5785 const char *funcname)
5789 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5791 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5794 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5796 /* We can't use SVs or PerlIO for obvious reasons,
5797 * so we'll use stdio and low-level IO instead. */
5798 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5800 # ifdef HAS_GETTIMEOFDAY
5801 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5802 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5804 gettimeofday(&tv, 0);
5806 # define MEM_LOG_TIME_FMT "%10d: "
5807 # define MEM_LOG_TIME_ARG (int)when
5811 /* If there are other OS specific ways of hires time than
5812 * gettimeofday() (see ext/Time-HiRes), the easiest way is
5813 * probably that they would be used to fill in the struct
5817 int fd = atoi(pmlenv);
5819 fd = PERL_MEM_LOG_FD;
5821 if (strchr(pmlenv, 't')) {
5822 len = my_snprintf(buf, sizeof(buf),
5823 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5824 PerlLIO_write(fd, buf, len);
5828 len = my_snprintf(buf, sizeof(buf),
5829 "alloc: %s:%d:%s: %"IVdf" %"UVuf
5830 " %s = %"IVdf": %"UVxf"\n",
5831 filename, linenumber, funcname, n, typesize,
5832 type_name, n * typesize, PTR2UV(newalloc));
5835 len = my_snprintf(buf, sizeof(buf),
5836 "realloc: %s:%d:%s: %"IVdf" %"UVuf
5837 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
5838 filename, linenumber, funcname, n, typesize,
5839 type_name, n * typesize, PTR2UV(oldalloc),
5843 len = my_snprintf(buf, sizeof(buf),
5844 "free: %s:%d:%s: %"UVxf"\n",
5845 filename, linenumber, funcname,
5850 len = my_snprintf(buf, sizeof(buf),
5851 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
5852 mlt == MLT_NEW_SV ? "new" : "del",
5853 filename, linenumber, funcname,
5854 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5859 PerlLIO_write(fd, buf, len);
5863 #endif /* !PERL_MEM_LOG_NOIMPL */
5865 #ifndef PERL_MEM_LOG_NOIMPL
5867 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5868 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5870 /* this is suboptimal, but bug compatible. User is providing their
5871 own implementation, but is getting these functions anyway, and they
5872 do nothing. But _NOIMPL users should be able to cope or fix */
5874 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5875 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5879 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5881 const char *filename, const int linenumber,
5882 const char *funcname)
5884 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5885 NULL, NULL, newalloc,
5886 filename, linenumber, funcname);
5891 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5892 Malloc_t oldalloc, Malloc_t newalloc,
5893 const char *filename, const int linenumber,
5894 const char *funcname)
5896 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5897 NULL, oldalloc, newalloc,
5898 filename, linenumber, funcname);
5903 Perl_mem_log_free(Malloc_t oldalloc,
5904 const char *filename, const int linenumber,
5905 const char *funcname)
5907 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5908 filename, linenumber, funcname);
5913 Perl_mem_log_new_sv(const SV *sv,
5914 const char *filename, const int linenumber,
5915 const char *funcname)
5917 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5918 filename, linenumber, funcname);
5922 Perl_mem_log_del_sv(const SV *sv,
5923 const char *filename, const int linenumber,
5924 const char *funcname)
5926 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5927 filename, linenumber, funcname);
5930 #endif /* PERL_MEM_LOG */
5933 =for apidoc my_sprintf
5935 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5936 the length of the string written to the buffer. Only rare pre-ANSI systems
5937 need the wrapper function - usually this is a direct call to C<sprintf>.
5941 #ifndef SPRINTF_RETURNS_STRLEN
5943 Perl_my_sprintf(char *buffer, const char* pat, ...)
5946 PERL_ARGS_ASSERT_MY_SPRINTF;
5947 va_start(args, pat);
5948 vsprintf(buffer, pat, args);
5950 return strlen(buffer);
5955 =for apidoc my_snprintf
5957 The C library C<snprintf> functionality, if available and
5958 standards-compliant (uses C<vsnprintf>, actually). However, if the
5959 C<vsnprintf> is not available, will unfortunately use the unsafe
5960 C<vsprintf> which can overrun the buffer (there is an overrun check,
5961 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5962 getting C<vsnprintf>.
5967 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5971 PERL_ARGS_ASSERT_MY_SNPRINTF;
5972 va_start(ap, format);
5973 #ifdef HAS_VSNPRINTF
5974 retval = vsnprintf(buffer, len, format, ap);
5976 retval = vsprintf(buffer, format, ap);
5979 /* vsprintf() shows failure with < 0 */
5981 #ifdef HAS_VSNPRINTF
5982 /* vsnprintf() shows failure with >= len */
5984 (len > 0 && (Size_t)retval >= len)
5987 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5992 =for apidoc my_vsnprintf
5994 The C library C<vsnprintf> if available and standards-compliant.
5995 However, if if the C<vsnprintf> is not available, will unfortunately
5996 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5997 overrun check, but that may be too late). Consider using
5998 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
6003 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
6009 PERL_ARGS_ASSERT_MY_VSNPRINTF;
6011 Perl_va_copy(ap, apc);
6012 # ifdef HAS_VSNPRINTF
6013 retval = vsnprintf(buffer, len, format, apc);
6015 retval = vsprintf(buffer, format, apc);
6018 # ifdef HAS_VSNPRINTF
6019 retval = vsnprintf(buffer, len, format, ap);
6021 retval = vsprintf(buffer, format, ap);
6023 #endif /* #ifdef NEED_VA_COPY */
6024 /* vsprintf() shows failure with < 0 */
6026 #ifdef HAS_VSNPRINTF
6027 /* vsnprintf() shows failure with >= len */
6029 (len > 0 && (Size_t)retval >= len)
6032 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
6037 Perl_my_clearenv(pTHX)
6040 #if ! defined(PERL_MICRO)
6041 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
6043 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
6044 # if defined(USE_ENVIRON_ARRAY)
6045 # if defined(USE_ITHREADS)
6046 /* only the parent thread can clobber the process environment */
6047 if (PL_curinterp == aTHX)
6048 # endif /* USE_ITHREADS */
6050 # if ! defined(PERL_USE_SAFE_PUTENV)
6051 if ( !PL_use_safe_putenv) {
6053 if (environ == PL_origenviron)
6054 environ = (char**)safesysmalloc(sizeof(char*));
6056 for (i = 0; environ[i]; i++)
6057 (void)safesysfree(environ[i]);
6060 # else /* PERL_USE_SAFE_PUTENV */
6061 # if defined(HAS_CLEARENV)
6063 # elif defined(HAS_UNSETENV)
6064 int bsiz = 80; /* Most envvar names will be shorter than this. */
6065 char *buf = (char*)safesysmalloc(bsiz);
6066 while (*environ != NULL) {
6067 char *e = strchr(*environ, '=');
6068 int l = e ? e - *environ : (int)strlen(*environ);
6070 (void)safesysfree(buf);
6071 bsiz = l + 1; /* + 1 for the \0. */
6072 buf = (char*)safesysmalloc(bsiz);
6074 memcpy(buf, *environ, l);
6076 (void)unsetenv(buf);
6078 (void)safesysfree(buf);
6079 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
6080 /* Just null environ and accept the leakage. */
6082 # endif /* HAS_CLEARENV || HAS_UNSETENV */
6083 # endif /* ! PERL_USE_SAFE_PUTENV */
6085 # endif /* USE_ENVIRON_ARRAY */
6086 # endif /* PERL_IMPLICIT_SYS || WIN32 */
6087 #endif /* PERL_MICRO */
6090 #ifdef PERL_IMPLICIT_CONTEXT
6092 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
6093 the global PL_my_cxt_index is incremented, and that value is assigned to
6094 that module's static my_cxt_index (who's address is passed as an arg).
6095 Then, for each interpreter this function is called for, it makes sure a
6096 void* slot is available to hang the static data off, by allocating or
6097 extending the interpreter's PL_my_cxt_list array */
6099 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
6101 Perl_my_cxt_init(pTHX_ int *index, size_t size)
6105 PERL_ARGS_ASSERT_MY_CXT_INIT;
6107 /* this module hasn't been allocated an index yet */
6108 #if defined(USE_ITHREADS)
6109 MUTEX_LOCK(&PL_my_ctx_mutex);
6111 *index = PL_my_cxt_index++;
6112 #if defined(USE_ITHREADS)
6113 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6117 /* make sure the array is big enough */
6118 if (PL_my_cxt_size <= *index) {
6119 if (PL_my_cxt_size) {
6120 while (PL_my_cxt_size <= *index)
6121 PL_my_cxt_size *= 2;
6122 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6125 PL_my_cxt_size = 16;
6126 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6129 /* newSV() allocates one more than needed */
6130 p = (void*)SvPVX(newSV(size-1));
6131 PL_my_cxt_list[*index] = p;
6132 Zero(p, size, char);
6136 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6139 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
6144 PERL_ARGS_ASSERT_MY_CXT_INDEX;
6146 for (index = 0; index < PL_my_cxt_index; index++) {
6147 const char *key = PL_my_cxt_keys[index];
6148 /* try direct pointer compare first - there are chances to success,
6149 * and it's much faster.
6151 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
6158 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
6164 PERL_ARGS_ASSERT_MY_CXT_INIT;
6166 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
6168 /* this module hasn't been allocated an index yet */
6169 #if defined(USE_ITHREADS)
6170 MUTEX_LOCK(&PL_my_ctx_mutex);
6172 index = PL_my_cxt_index++;
6173 #if defined(USE_ITHREADS)
6174 MUTEX_UNLOCK(&PL_my_ctx_mutex);
6178 /* make sure the array is big enough */
6179 if (PL_my_cxt_size <= index) {
6180 int old_size = PL_my_cxt_size;
6182 if (PL_my_cxt_size) {
6183 while (PL_my_cxt_size <= index)
6184 PL_my_cxt_size *= 2;
6185 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
6186 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6189 PL_my_cxt_size = 16;
6190 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
6191 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
6193 for (i = old_size; i < PL_my_cxt_size; i++) {
6194 PL_my_cxt_keys[i] = 0;
6195 PL_my_cxt_list[i] = 0;
6198 PL_my_cxt_keys[index] = my_cxt_key;
6199 /* newSV() allocates one more than needed */
6200 p = (void*)SvPVX(newSV(size-1));
6201 PL_my_cxt_list[index] = p;
6202 Zero(p, size, char);
6205 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
6206 #endif /* PERL_IMPLICIT_CONTEXT */
6209 Perl_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
6213 const char *vn = NULL;
6214 SV *const module = PL_stack_base[ax];
6216 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
6218 if (items >= 2) /* version supplied as bootstrap arg */
6219 sv = PL_stack_base[ax + 1];
6221 /* XXX GV_ADDWARN */
6223 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
6224 if (!sv || !SvOK(sv)) {
6226 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
6230 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
6231 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
6232 ? sv : sv_2mortal(new_version(sv));
6233 xssv = upg_version(xssv, 0);
6234 if ( vcmp(pmsv,xssv) ) {
6235 SV *string = vstringify(xssv);
6236 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
6237 " does not match ", module, string);
6239 SvREFCNT_dec(string);
6240 string = vstringify(pmsv);
6243 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, module, vn,
6246 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, string);
6248 SvREFCNT_dec(string);
6250 Perl_sv_2mortal(aTHX_ xpt);
6251 Perl_croak_sv(aTHX_ xpt);
6257 Perl_xs_apiversion_bootcheck(pTHX_ SV *module, const char *api_p,
6261 SV *compver = Perl_newSVpvn_flags(aTHX_ api_p, api_len, SVs_TEMP);
6264 PERL_ARGS_ASSERT_XS_APIVERSION_BOOTCHECK;
6266 /* This might croak */
6267 compver = upg_version(compver, 0);
6268 /* This should never croak */
6269 runver = new_version(PL_apiversion);
6270 if (vcmp(compver, runver)) {
6271 SV *compver_string = vstringify(compver);
6272 SV *runver_string = vstringify(runver);
6273 xpt = Perl_newSVpvf(aTHX_ "Perl API version %"SVf
6274 " of %"SVf" does not match %"SVf,
6275 compver_string, module, runver_string);
6276 Perl_sv_2mortal(aTHX_ xpt);
6278 SvREFCNT_dec(compver_string);
6279 SvREFCNT_dec(runver_string);
6281 SvREFCNT_dec(runver);
6283 Perl_croak_sv(aTHX_ xpt);
6288 Perl_my_strlcat(char *dst, const char *src, Size_t size)
6290 Size_t used, length, copy;
6293 length = strlen(src);
6294 if (size > 0 && used < size - 1) {
6295 copy = (length >= size - used) ? size - used - 1 : length;
6296 memcpy(dst + used, src, copy);
6297 dst[used + copy] = '\0';
6299 return used + length;
6305 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
6307 Size_t length, copy;
6309 length = strlen(src);
6311 copy = (length >= size) ? size - 1 : length;
6312 memcpy(dst, src, copy);
6319 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
6320 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
6321 long _ftol( double ); /* Defined by VC6 C libs. */
6322 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
6325 PERL_STATIC_INLINE bool
6326 S_gv_has_usable_name(pTHX_ GV *gv)
6330 && HvENAME(GvSTASH(gv))
6331 && (gvp = (GV **)hv_fetch(
6332 GvSTASH(gv), GvNAME(gv),
6333 GvNAMEUTF8(gv) ? -GvNAMELEN(gv) : GvNAMELEN(gv), 0
6339 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
6342 SV * const dbsv = GvSVn(PL_DBsub);
6343 const bool save_taint = TAINT_get;
6345 /* When we are called from pp_goto (svp is null),
6346 * we do not care about using dbsv to call CV;
6347 * it's for informational purposes only.
6350 PERL_ARGS_ASSERT_GET_DB_SUB;
6354 if (!PERLDB_SUB_NN) {
6358 gv_efullname3(dbsv, gv, NULL);
6360 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED))
6361 || strEQ(GvNAME(gv), "END")
6362 || ( /* Could be imported, and old sub redefined. */
6363 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
6365 !( (SvTYPE(*svp) == SVt_PVGV)
6366 && (GvCV((const GV *)*svp) == cv)
6367 /* Use GV from the stack as a fallback. */
6368 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
6372 /* GV is potentially non-unique, or contain different CV. */
6373 SV * const tmp = newRV(MUTABLE_SV(cv));
6374 sv_setsv(dbsv, tmp);
6378 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
6379 sv_catpvs(dbsv, "::");
6381 dbsv, GvNAME(gv), GvNAMELEN(gv),
6382 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
6387 const int type = SvTYPE(dbsv);
6388 if (type < SVt_PVIV && type != SVt_IV)
6389 sv_upgrade(dbsv, SVt_PVIV);
6390 (void)SvIOK_on(dbsv);
6391 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
6393 TAINT_IF(save_taint);
6394 #ifdef NO_TAINT_SUPPORT
6395 PERL_UNUSED_VAR(save_taint);
6400 Perl_my_dirfd(pTHX_ DIR * dir) {
6402 /* Most dirfd implementations have problems when passed NULL. */
6407 #elif defined(HAS_DIR_DD_FD)
6410 Perl_die(aTHX_ PL_no_func, "dirfd");
6411 assert(0); /* NOT REACHED */
6417 Perl_get_re_arg(pTHX_ SV *sv) {
6423 sv = MUTABLE_SV(SvRV(sv));
6424 if (SvTYPE(sv) == SVt_REGEXP)
6425 return (REGEXP*) sv;
6433 * c-indentation-style: bsd
6435 * indent-tabs-mode: nil
6438 * ex: set ts=8 sts=4 sw=4 et: