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 BmUSEFUL(sv) = 100; /* Initial value */
597 if (flags & FBMcf_TAIL)
599 DEBUG_r(PerlIO_printf(Perl_debug_log, "rarest char %c at %"UVuf"\n",
603 /* If SvTAIL(littlestr), it has a fake '\n' at end. */
604 /* If SvTAIL is actually due to \Z or \z, this gives false positives
608 =for apidoc fbm_instr
610 Returns the location of the SV in the string delimited by C<big> and
611 C<bigend>. It returns C<NULL> if the string can't be found. The C<sv>
612 does not have to be fbm_compiled, but the search will not be as fast
619 Perl_fbm_instr(pTHX_ unsigned char *big, unsigned char *bigend, SV *littlestr, U32 flags)
623 const unsigned char *little = (const unsigned char *)SvPV_const(littlestr,l);
624 STRLEN littlelen = l;
625 const I32 multiline = flags & FBMrf_MULTILINE;
627 PERL_ARGS_ASSERT_FBM_INSTR;
629 if ((STRLEN)(bigend - big) < littlelen) {
630 if ( SvTAIL(littlestr)
631 && ((STRLEN)(bigend - big) == littlelen - 1)
633 || (*big == *little &&
634 memEQ((char *)big, (char *)little, littlelen - 1))))
639 switch (littlelen) { /* Special cases for 0, 1 and 2 */
641 return (char*)big; /* Cannot be SvTAIL! */
643 if (SvTAIL(littlestr) && !multiline) { /* Anchor only! */
644 /* Know that bigend != big. */
645 if (bigend[-1] == '\n')
646 return (char *)(bigend - 1);
647 return (char *) bigend;
655 if (SvTAIL(littlestr))
656 return (char *) bigend;
659 if (SvTAIL(littlestr) && !multiline) {
660 if (bigend[-1] == '\n' && bigend[-2] == *little)
661 return (char*)bigend - 2;
662 if (bigend[-1] == *little)
663 return (char*)bigend - 1;
667 /* This should be better than FBM if c1 == c2, and almost
668 as good otherwise: maybe better since we do less indirection.
669 And we save a lot of memory by caching no table. */
670 const unsigned char c1 = little[0];
671 const unsigned char c2 = little[1];
676 while (s <= bigend) {
686 goto check_1char_anchor;
697 goto check_1char_anchor;
700 while (s <= bigend) {
705 goto check_1char_anchor;
714 check_1char_anchor: /* One char and anchor! */
715 if (SvTAIL(littlestr) && (*bigend == *little))
716 return (char *)bigend; /* bigend is already decremented. */
719 break; /* Only lengths 0 1 and 2 have special-case code. */
722 if (SvTAIL(littlestr) && !multiline) { /* tail anchored? */
723 s = bigend - littlelen;
724 if (s >= big && bigend[-1] == '\n' && *s == *little
725 /* Automatically of length > 2 */
726 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
728 return (char*)s; /* how sweet it is */
731 && memEQ((char*)s + 2, (char*)little + 1, littlelen - 2))
733 return (char*)s + 1; /* how sweet it is */
737 if (!SvVALID(littlestr)) {
738 char * const b = ninstr((char*)big,(char*)bigend,
739 (char*)little, (char*)little + littlelen);
741 if (!b && SvTAIL(littlestr)) { /* Automatically multiline! */
742 /* Chop \n from littlestr: */
743 s = bigend - littlelen + 1;
745 && memEQ((char*)s + 1, (char*)little + 1, littlelen - 2))
755 if (littlelen > (STRLEN)(bigend - big))
759 const MAGIC *const mg = mg_find(littlestr, PERL_MAGIC_bm);
760 const unsigned char * const table = (const unsigned char *) mg->mg_ptr;
761 const unsigned char *oldlittle;
763 --littlelen; /* Last char found by table lookup */
766 little += littlelen; /* last char */
772 if ((tmp = table[*s])) {
773 if ((s += tmp) < bigend)
777 else { /* less expensive than calling strncmp() */
778 unsigned char * const olds = s;
783 if (*--s == *--little)
785 s = olds + 1; /* here we pay the price for failure */
787 if (s < bigend) /* fake up continue to outer loop */
797 && memEQ((char *)(bigend - littlelen),
798 (char *)(oldlittle - littlelen), littlelen) )
799 return (char*)bigend - littlelen;
805 Perl_screaminstr(pTHX_ SV *bigstr, SV *littlestr, I32 start_shift, I32 end_shift, I32 *old_posp, I32 last)
808 PERL_ARGS_ASSERT_SCREAMINSTR;
809 PERL_UNUSED_ARG(bigstr);
810 PERL_UNUSED_ARG(littlestr);
811 PERL_UNUSED_ARG(start_shift);
812 PERL_UNUSED_ARG(end_shift);
813 PERL_UNUSED_ARG(old_posp);
814 PERL_UNUSED_ARG(last);
816 /* This function must only ever be called on a scalar with study magic,
817 but those do not happen any more. */
818 Perl_croak(aTHX_ "panic: screaminstr");
825 Returns true if the leading len bytes of the strings s1 and s2 are the same
826 case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
827 match themselves and their opposite case counterparts. Non-cased and non-ASCII
828 range bytes match only themselves.
835 Perl_foldEQ(const char *s1, const char *s2, I32 len)
837 const U8 *a = (const U8 *)s1;
838 const U8 *b = (const U8 *)s2;
840 PERL_ARGS_ASSERT_FOLDEQ;
845 if (*a != *b && *a != PL_fold[*b])
852 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
854 /* Compare non-utf8 using Unicode (Latin1) semantics. Does not work on
855 * MICRO_SIGN, LATIN_SMALL_LETTER_SHARP_S, nor
856 * LATIN_SMALL_LETTER_Y_WITH_DIAERESIS, and does not check for these. Nor
857 * does it check that the strings each have at least 'len' characters */
859 const U8 *a = (const U8 *)s1;
860 const U8 *b = (const U8 *)s2;
862 PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
867 if (*a != *b && *a != PL_fold_latin1[*b]) {
876 =for apidoc foldEQ_locale
878 Returns true if the leading len bytes of the strings s1 and s2 are the same
879 case-insensitively in the current locale; false otherwise.
885 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
888 const U8 *a = (const U8 *)s1;
889 const U8 *b = (const U8 *)s2;
891 PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
896 if (*a != *b && *a != PL_fold_locale[*b])
903 /* copy a string to a safe spot */
906 =head1 Memory Management
910 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
911 string which is a duplicate of C<pv>. The size of the string is
912 determined by C<strlen()>. The memory allocated for the new string can
913 be freed with the C<Safefree()> function.
919 Perl_savepv(pTHX_ const char *pv)
926 const STRLEN pvlen = strlen(pv)+1;
927 Newx(newaddr, pvlen, char);
928 return (char*)memcpy(newaddr, pv, pvlen);
932 /* same thing but with a known length */
937 Perl's version of what C<strndup()> would be if it existed. Returns a
938 pointer to a newly allocated string which is a duplicate of the first
939 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
940 the new string can be freed with the C<Safefree()> function.
946 Perl_savepvn(pTHX_ const char *pv, I32 len)
953 Newx(newaddr,len+1,char);
954 /* Give a meaning to NULL pointer mainly for the use in sv_magic() */
956 /* might not be null terminated */
958 return (char *) CopyD(pv,newaddr,len,char);
961 return (char *) ZeroD(newaddr,len+1,char);
966 =for apidoc savesharedpv
968 A version of C<savepv()> which allocates the duplicate string in memory
969 which is shared between threads.
974 Perl_savesharedpv(pTHX_ const char *pv)
981 pvlen = strlen(pv)+1;
982 newaddr = (char*)PerlMemShared_malloc(pvlen);
986 return (char*)memcpy(newaddr, pv, pvlen);
990 =for apidoc savesharedpvn
992 A version of C<savepvn()> which allocates the duplicate string in memory
993 which is shared between threads. (With the specific difference that a NULL
994 pointer is not acceptable)
999 Perl_savesharedpvn(pTHX_ const char *const pv, const STRLEN len)
1001 char *const newaddr = (char*)PerlMemShared_malloc(len + 1);
1003 /* PERL_ARGS_ASSERT_SAVESHAREDPVN; */
1008 newaddr[len] = '\0';
1009 return (char*)memcpy(newaddr, pv, len);
1013 =for apidoc savesvpv
1015 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
1016 the passed in SV using C<SvPV()>
1022 Perl_savesvpv(pTHX_ SV *sv)
1025 const char * const pv = SvPV_const(sv, len);
1028 PERL_ARGS_ASSERT_SAVESVPV;
1031 Newx(newaddr,len,char);
1032 return (char *) CopyD(pv,newaddr,len,char);
1036 =for apidoc savesharedsvpv
1038 A version of C<savesharedpv()> which allocates the duplicate string in
1039 memory which is shared between threads.
1045 Perl_savesharedsvpv(pTHX_ SV *sv)
1048 const char * const pv = SvPV_const(sv, len);
1050 PERL_ARGS_ASSERT_SAVESHAREDSVPV;
1052 return savesharedpvn(pv, len);
1055 /* the SV for Perl_form() and mess() is not kept in an arena */
1064 if (PL_phase != PERL_PHASE_DESTRUCT)
1065 return newSVpvs_flags("", SVs_TEMP);
1070 /* Create as PVMG now, to avoid any upgrading later */
1072 Newxz(any, 1, XPVMG);
1073 SvFLAGS(sv) = SVt_PVMG;
1074 SvANY(sv) = (void*)any;
1076 SvREFCNT(sv) = 1 << 30; /* practically infinite */
1081 #if defined(PERL_IMPLICIT_CONTEXT)
1083 Perl_form_nocontext(const char* pat, ...)
1088 PERL_ARGS_ASSERT_FORM_NOCONTEXT;
1089 va_start(args, pat);
1090 retval = vform(pat, &args);
1094 #endif /* PERL_IMPLICIT_CONTEXT */
1097 =head1 Miscellaneous Functions
1100 Takes a sprintf-style format pattern and conventional
1101 (non-SV) arguments and returns the formatted string.
1103 (char *) Perl_form(pTHX_ const char* pat, ...)
1105 can be used any place a string (char *) is required:
1107 char * s = Perl_form("%d.%d",major,minor);
1109 Uses a single private buffer so if you want to format several strings you
1110 must explicitly copy the earlier strings away (and free the copies when you
1117 Perl_form(pTHX_ const char* pat, ...)
1121 PERL_ARGS_ASSERT_FORM;
1122 va_start(args, pat);
1123 retval = vform(pat, &args);
1129 Perl_vform(pTHX_ const char *pat, va_list *args)
1131 SV * const sv = mess_alloc();
1132 PERL_ARGS_ASSERT_VFORM;
1133 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1138 =for apidoc Am|SV *|mess|const char *pat|...
1140 Take a sprintf-style format pattern and argument list. These are used to
1141 generate a string message. If the message does not end with a newline,
1142 then it will be extended with some indication of the current location
1143 in the code, as described for L</mess_sv>.
1145 Normally, the resulting message is returned in a new mortal SV.
1146 During global destruction a single SV may be shared between uses of
1152 #if defined(PERL_IMPLICIT_CONTEXT)
1154 Perl_mess_nocontext(const char *pat, ...)
1159 PERL_ARGS_ASSERT_MESS_NOCONTEXT;
1160 va_start(args, pat);
1161 retval = vmess(pat, &args);
1165 #endif /* PERL_IMPLICIT_CONTEXT */
1168 Perl_mess(pTHX_ const char *pat, ...)
1172 PERL_ARGS_ASSERT_MESS;
1173 va_start(args, pat);
1174 retval = vmess(pat, &args);
1180 S_closest_cop(pTHX_ const COP *cop, const OP *o)
1183 /* Look for PL_op starting from o. cop is the last COP we've seen. */
1185 PERL_ARGS_ASSERT_CLOSEST_COP;
1187 if (!o || o == PL_op)
1190 if (o->op_flags & OPf_KIDS) {
1192 for (kid = cUNOPo->op_first; kid; kid = kid->op_sibling) {
1195 /* If the OP_NEXTSTATE has been optimised away we can still use it
1196 * the get the file and line number. */
1198 if (kid->op_type == OP_NULL && kid->op_targ == OP_NEXTSTATE)
1199 cop = (const COP *)kid;
1201 /* Keep searching, and return when we've found something. */
1203 new_cop = closest_cop(cop, kid);
1209 /* Nothing found. */
1215 =for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume
1217 Expands a message, intended for the user, to include an indication of
1218 the current location in the code, if the message does not already appear
1221 C<basemsg> is the initial message or object. If it is a reference, it
1222 will be used as-is and will be the result of this function. Otherwise it
1223 is used as a string, and if it already ends with a newline, it is taken
1224 to be complete, and the result of this function will be the same string.
1225 If the message does not end with a newline, then a segment such as C<at
1226 foo.pl line 37> will be appended, and possibly other clauses indicating
1227 the current state of execution. The resulting message will end with a
1230 Normally, the resulting message is returned in a new mortal SV.
1231 During global destruction a single SV may be shared between uses of this
1232 function. If C<consume> is true, then the function is permitted (but not
1233 required) to modify and return C<basemsg> instead of allocating a new SV.
1239 Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
1244 PERL_ARGS_ASSERT_MESS_SV;
1246 if (SvROK(basemsg)) {
1252 sv_setsv(sv, basemsg);
1257 if (SvPOK(basemsg) && consume) {
1262 sv_copypv(sv, basemsg);
1265 if (!SvCUR(sv) || *(SvEND(sv) - 1) != '\n') {
1267 * Try and find the file and line for PL_op. This will usually be
1268 * PL_curcop, but it might be a cop that has been optimised away. We
1269 * can try to find such a cop by searching through the optree starting
1270 * from the sibling of PL_curcop.
1273 const COP *cop = closest_cop(PL_curcop, PL_curcop->op_sibling);
1278 Perl_sv_catpvf(aTHX_ sv, " at %s line %"IVdf,
1279 OutCopFILE(cop), (IV)CopLINE(cop));
1280 /* Seems that GvIO() can be untrustworthy during global destruction. */
1281 if (GvIO(PL_last_in_gv) && (SvTYPE(GvIOp(PL_last_in_gv)) == SVt_PVIO)
1282 && IoLINES(GvIOp(PL_last_in_gv)))
1285 const bool line_mode = (RsSIMPLE(PL_rs) &&
1286 *SvPV_const(PL_rs,l) == '\n' && l == 1);
1287 Perl_sv_catpvf(aTHX_ sv, ", <%"SVf"> %s %"IVdf,
1288 SVfARG(PL_last_in_gv == PL_argvgv
1290 : sv_2mortal(newSVhek(GvNAME_HEK(PL_last_in_gv)))),
1291 line_mode ? "line" : "chunk",
1292 (IV)IoLINES(GvIOp(PL_last_in_gv)));
1294 if (PL_phase == PERL_PHASE_DESTRUCT)
1295 sv_catpvs(sv, " during global destruction");
1296 sv_catpvs(sv, ".\n");
1302 =for apidoc Am|SV *|vmess|const char *pat|va_list *args
1304 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1305 argument list. These are used to generate a string message. If the
1306 message does not end with a newline, then it will be extended with
1307 some indication of the current location in the code, as described for
1310 Normally, the resulting message is returned in a new mortal SV.
1311 During global destruction a single SV may be shared between uses of
1318 Perl_vmess(pTHX_ const char *pat, va_list *args)
1321 SV * const sv = mess_alloc();
1323 PERL_ARGS_ASSERT_VMESS;
1325 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
1326 return mess_sv(sv, 1);
1330 Perl_write_to_stderr(pTHX_ SV* msv)
1336 PERL_ARGS_ASSERT_WRITE_TO_STDERR;
1338 if (PL_stderrgv && SvREFCNT(PL_stderrgv)
1339 && (io = GvIO(PL_stderrgv))
1340 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1341 Perl_magic_methcall(aTHX_ MUTABLE_SV(io), mg, "PRINT",
1342 G_SCALAR | G_DISCARD | G_WRITING_TO_STDERR, 1, msv);
1345 /* SFIO can really mess with your errno */
1348 PerlIO * const serr = Perl_error_log;
1350 do_print(msv, serr);
1351 (void)PerlIO_flush(serr);
1359 =head1 Warning and Dieing
1362 /* Common code used in dieing and warning */
1365 S_with_queued_errors(pTHX_ SV *ex)
1367 PERL_ARGS_ASSERT_WITH_QUEUED_ERRORS;
1368 if (PL_errors && SvCUR(PL_errors) && !SvROK(ex)) {
1369 sv_catsv(PL_errors, ex);
1370 ex = sv_mortalcopy(PL_errors);
1371 SvCUR_set(PL_errors, 0);
1377 S_invoke_exception_hook(pTHX_ SV *ex, bool warn)
1383 SV **const hook = warn ? &PL_warnhook : &PL_diehook;
1384 /* sv_2cv might call Perl_croak() or Perl_warner() */
1385 SV * const oldhook = *hook;
1393 cv = sv_2cv(oldhook, &stash, &gv, 0);
1395 if (cv && !CvDEPTH(cv) && (CvROOT(cv) || CvXSUB(cv))) {
1405 exarg = newSVsv(ex);
1406 SvREADONLY_on(exarg);
1409 PUSHSTACKi(warn ? PERLSI_WARNHOOK : PERLSI_DIEHOOK);
1413 call_sv(MUTABLE_SV(cv), G_DISCARD);
1422 =for apidoc Am|OP *|die_sv|SV *baseex
1424 Behaves the same as L</croak_sv>, except for the return type.
1425 It should be used only where the C<OP *> return type is required.
1426 The function never actually returns.
1432 Perl_die_sv(pTHX_ SV *baseex)
1434 PERL_ARGS_ASSERT_DIE_SV;
1436 assert(0); /* NOTREACHED */
1441 =for apidoc Am|OP *|die|const char *pat|...
1443 Behaves the same as L</croak>, except for the return type.
1444 It should be used only where the C<OP *> return type is required.
1445 The function never actually returns.
1450 #if defined(PERL_IMPLICIT_CONTEXT)
1452 Perl_die_nocontext(const char* pat, ...)
1456 va_start(args, pat);
1458 assert(0); /* NOTREACHED */
1462 #endif /* PERL_IMPLICIT_CONTEXT */
1465 Perl_die(pTHX_ const char* pat, ...)
1468 va_start(args, pat);
1470 assert(0); /* NOTREACHED */
1476 =for apidoc Am|void|croak_sv|SV *baseex
1478 This is an XS interface to Perl's C<die> function.
1480 C<baseex> is the error message or object. If it is a reference, it
1481 will be used as-is. Otherwise it is used as a string, and if it does
1482 not end with a newline then it will be extended with some indication of
1483 the current location in the code, as described for L</mess_sv>.
1485 The error message or object will be used as an exception, by default
1486 returning control to the nearest enclosing C<eval>, but subject to
1487 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
1488 function never returns normally.
1490 To die with a simple string message, the L</croak> function may be
1497 Perl_croak_sv(pTHX_ SV *baseex)
1499 SV *ex = with_queued_errors(mess_sv(baseex, 0));
1500 PERL_ARGS_ASSERT_CROAK_SV;
1501 invoke_exception_hook(ex, FALSE);
1506 =for apidoc Am|void|vcroak|const char *pat|va_list *args
1508 This is an XS interface to Perl's C<die> function.
1510 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1511 argument list. These are used to generate a string message. If the
1512 message does not end with a newline, then it will be extended with
1513 some indication of the current location in the code, as described for
1516 The error message will be used as an exception, by default
1517 returning control to the nearest enclosing C<eval>, but subject to
1518 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1519 function never returns normally.
1521 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1522 (C<$@>) will be used as an error message or object instead of building an
1523 error message from arguments. If you want to throw a non-string object,
1524 or build an error message in an SV yourself, it is preferable to use
1525 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1531 Perl_vcroak(pTHX_ const char* pat, va_list *args)
1533 SV *ex = with_queued_errors(pat ? vmess(pat, args) : mess_sv(ERRSV, 0));
1534 invoke_exception_hook(ex, FALSE);
1539 =for apidoc Am|void|croak|const char *pat|...
1541 This is an XS interface to Perl's C<die> function.
1543 Take a sprintf-style format pattern and argument list. These are used to
1544 generate a string message. If the message does not end with a newline,
1545 then it will be extended with some indication of the current location
1546 in the code, as described for L</mess_sv>.
1548 The error message will be used as an exception, by default
1549 returning control to the nearest enclosing C<eval>, but subject to
1550 modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
1551 function never returns normally.
1553 For historical reasons, if C<pat> is null then the contents of C<ERRSV>
1554 (C<$@>) will be used as an error message or object instead of building an
1555 error message from arguments. If you want to throw a non-string object,
1556 or build an error message in an SV yourself, it is preferable to use
1557 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
1562 #if defined(PERL_IMPLICIT_CONTEXT)
1564 Perl_croak_nocontext(const char *pat, ...)
1568 va_start(args, pat);
1570 assert(0); /* NOTREACHED */
1573 #endif /* PERL_IMPLICIT_CONTEXT */
1576 Perl_croak(pTHX_ const char *pat, ...)
1579 va_start(args, pat);
1581 assert(0); /* NOTREACHED */
1586 =for apidoc Am|void|croak_no_modify
1588 Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
1589 terser object code than using C<Perl_croak>. Less code used on exception code
1590 paths reduces CPU cache pressure.
1596 Perl_croak_no_modify()
1598 Perl_croak_nocontext( "%s", PL_no_modify);
1601 /* does not return, used in util.c perlio.c and win32.c
1602 This is typically called when malloc returns NULL.
1609 /* Can't use PerlIO to write as it allocates memory */
1610 PerlLIO_write(PerlIO_fileno(Perl_error_log),
1611 PL_no_mem, sizeof(PL_no_mem)-1);
1615 /* saves machine code for a common noreturn idiom typically used in Newx*() */
1617 Perl_croak_memory_wrap(void)
1619 Perl_croak_nocontext("%s",PL_memory_wrap);
1623 /* does not return, used only in POPSTACK */
1625 Perl_croak_popstack(void)
1628 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");
1633 =for apidoc Am|void|warn_sv|SV *baseex
1635 This is an XS interface to Perl's C<warn> function.
1637 C<baseex> is the error message or object. If it is a reference, it
1638 will be used as-is. Otherwise it is used as a string, and if it does
1639 not end with a newline then it will be extended with some indication of
1640 the current location in the code, as described for L</mess_sv>.
1642 The error message or object will by default be written to standard error,
1643 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1645 To warn with a simple string message, the L</warn> function may be
1652 Perl_warn_sv(pTHX_ SV *baseex)
1654 SV *ex = mess_sv(baseex, 0);
1655 PERL_ARGS_ASSERT_WARN_SV;
1656 if (!invoke_exception_hook(ex, TRUE))
1657 write_to_stderr(ex);
1661 =for apidoc Am|void|vwarn|const char *pat|va_list *args
1663 This is an XS interface to Perl's C<warn> function.
1665 C<pat> and C<args> are a sprintf-style format pattern and encapsulated
1666 argument list. These are used to generate a string message. If the
1667 message does not end with a newline, then it will be extended with
1668 some indication of the current location in the code, as described for
1671 The error message or object will by default be written to standard error,
1672 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1674 Unlike with L</vcroak>, C<pat> is not permitted to be null.
1680 Perl_vwarn(pTHX_ const char* pat, va_list *args)
1682 SV *ex = vmess(pat, args);
1683 PERL_ARGS_ASSERT_VWARN;
1684 if (!invoke_exception_hook(ex, TRUE))
1685 write_to_stderr(ex);
1689 =for apidoc Am|void|warn|const char *pat|...
1691 This is an XS interface to Perl's C<warn> function.
1693 Take a sprintf-style format pattern and argument list. These are used to
1694 generate a string message. If the message does not end with a newline,
1695 then it will be extended with some indication of the current location
1696 in the code, as described for L</mess_sv>.
1698 The error message or object will by default be written to standard error,
1699 but this is subject to modification by a C<$SIG{__WARN__}> handler.
1701 Unlike with L</croak>, C<pat> is not permitted to be null.
1706 #if defined(PERL_IMPLICIT_CONTEXT)
1708 Perl_warn_nocontext(const char *pat, ...)
1712 PERL_ARGS_ASSERT_WARN_NOCONTEXT;
1713 va_start(args, pat);
1717 #endif /* PERL_IMPLICIT_CONTEXT */
1720 Perl_warn(pTHX_ const char *pat, ...)
1723 PERL_ARGS_ASSERT_WARN;
1724 va_start(args, pat);
1729 #if defined(PERL_IMPLICIT_CONTEXT)
1731 Perl_warner_nocontext(U32 err, const char *pat, ...)
1735 PERL_ARGS_ASSERT_WARNER_NOCONTEXT;
1736 va_start(args, pat);
1737 vwarner(err, pat, &args);
1740 #endif /* PERL_IMPLICIT_CONTEXT */
1743 Perl_ck_warner_d(pTHX_ U32 err, const char* pat, ...)
1745 PERL_ARGS_ASSERT_CK_WARNER_D;
1747 if (Perl_ckwarn_d(aTHX_ err)) {
1749 va_start(args, pat);
1750 vwarner(err, pat, &args);
1756 Perl_ck_warner(pTHX_ U32 err, const char* pat, ...)
1758 PERL_ARGS_ASSERT_CK_WARNER;
1760 if (Perl_ckwarn(aTHX_ err)) {
1762 va_start(args, pat);
1763 vwarner(err, pat, &args);
1769 Perl_warner(pTHX_ U32 err, const char* pat,...)
1772 PERL_ARGS_ASSERT_WARNER;
1773 va_start(args, pat);
1774 vwarner(err, pat, &args);
1779 Perl_vwarner(pTHX_ U32 err, const char* pat, va_list* args)
1782 PERL_ARGS_ASSERT_VWARNER;
1783 if (PL_warnhook == PERL_WARNHOOK_FATAL || ckDEAD(err)) {
1784 SV * const msv = vmess(pat, args);
1786 invoke_exception_hook(msv, FALSE);
1790 Perl_vwarn(aTHX_ pat, args);
1794 /* implements the ckWARN? macros */
1797 Perl_ckwarn(pTHX_ U32 w)
1800 /* If lexical warnings have not been set, use $^W. */
1802 return PL_dowarn & G_WARN_ON;
1804 return ckwarn_common(w);
1807 /* implements the ckWARN?_d macro */
1810 Perl_ckwarn_d(pTHX_ U32 w)
1813 /* If lexical warnings have not been set then default classes warn. */
1817 return ckwarn_common(w);
1821 S_ckwarn_common(pTHX_ U32 w)
1823 if (PL_curcop->cop_warnings == pWARN_ALL)
1826 if (PL_curcop->cop_warnings == pWARN_NONE)
1829 /* Check the assumption that at least the first slot is non-zero. */
1830 assert(unpackWARN1(w));
1832 /* Check the assumption that it is valid to stop as soon as a zero slot is
1834 if (!unpackWARN2(w)) {
1835 assert(!unpackWARN3(w));
1836 assert(!unpackWARN4(w));
1837 } else if (!unpackWARN3(w)) {
1838 assert(!unpackWARN4(w));
1841 /* Right, dealt with all the special cases, which are implemented as non-
1842 pointers, so there is a pointer to a real warnings mask. */
1844 if (isWARN_on(PL_curcop->cop_warnings, unpackWARN1(w)))
1846 } while (w >>= WARNshift);
1851 /* Set buffer=NULL to get a new one. */
1853 Perl_new_warnings_bitfield(pTHX_ STRLEN *buffer, const char *const bits,
1855 const MEM_SIZE len_wanted =
1856 sizeof(STRLEN) + (size > WARNsize ? size : WARNsize);
1857 PERL_UNUSED_CONTEXT;
1858 PERL_ARGS_ASSERT_NEW_WARNINGS_BITFIELD;
1861 (specialWARN(buffer) ?
1862 PerlMemShared_malloc(len_wanted) :
1863 PerlMemShared_realloc(buffer, len_wanted));
1865 Copy(bits, (buffer + 1), size, char);
1866 if (size < WARNsize)
1867 Zero((char *)(buffer + 1) + size, WARNsize - size, char);
1871 /* since we've already done strlen() for both nam and val
1872 * we can use that info to make things faster than
1873 * sprintf(s, "%s=%s", nam, val)
1875 #define my_setenv_format(s, nam, nlen, val, vlen) \
1876 Copy(nam, s, nlen, char); \
1878 Copy(val, s+(nlen+1), vlen, char); \
1879 *(s+(nlen+1+vlen)) = '\0'
1881 #ifdef USE_ENVIRON_ARRAY
1882 /* VMS' my_setenv() is in vms.c */
1883 #if !defined(WIN32) && !defined(NETWARE)
1885 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1889 /* only parent thread can modify process environment */
1890 if (PL_curinterp == aTHX)
1893 #ifndef PERL_USE_SAFE_PUTENV
1894 if (!PL_use_safe_putenv) {
1895 /* most putenv()s leak, so we manipulate environ directly */
1897 const I32 len = strlen(nam);
1900 /* where does it go? */
1901 for (i = 0; environ[i]; i++) {
1902 if (strnEQ(environ[i],nam,len) && environ[i][len] == '=')
1906 if (environ == PL_origenviron) { /* need we copy environment? */
1912 while (environ[max])
1914 tmpenv = (char**)safesysmalloc((max+2) * sizeof(char*));
1915 for (j=0; j<max; j++) { /* copy environment */
1916 const int len = strlen(environ[j]);
1917 tmpenv[j] = (char*)safesysmalloc((len+1)*sizeof(char));
1918 Copy(environ[j], tmpenv[j], len+1, char);
1921 environ = tmpenv; /* tell exec where it is now */
1924 safesysfree(environ[i]);
1925 while (environ[i]) {
1926 environ[i] = environ[i+1];
1931 if (!environ[i]) { /* does not exist yet */
1932 environ = (char**)safesysrealloc(environ, (i+2) * sizeof(char*));
1933 environ[i+1] = NULL; /* make sure it's null terminated */
1936 safesysfree(environ[i]);
1940 environ[i] = (char*)safesysmalloc((nlen+vlen+2) * sizeof(char));
1941 /* all that work just for this */
1942 my_setenv_format(environ[i], nam, nlen, val, vlen);
1945 # if defined(__CYGWIN__)|| defined(__SYMBIAN32__) || defined(__riscos__)
1946 # if defined(HAS_UNSETENV)
1948 (void)unsetenv(nam);
1950 (void)setenv(nam, val, 1);
1952 # else /* ! HAS_UNSETENV */
1953 (void)setenv(nam, val, 1);
1954 # endif /* HAS_UNSETENV */
1956 # if defined(HAS_UNSETENV)
1958 if (environ) /* old glibc can crash with null environ */
1959 (void)unsetenv(nam);
1961 const int nlen = strlen(nam);
1962 const int vlen = strlen(val);
1963 char * const new_env =
1964 (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1965 my_setenv_format(new_env, nam, nlen, val, vlen);
1966 (void)putenv(new_env);
1968 # else /* ! HAS_UNSETENV */
1970 const int nlen = strlen(nam);
1976 new_env = (char*)safesysmalloc((nlen + vlen + 2) * sizeof(char));
1977 /* all that work just for this */
1978 my_setenv_format(new_env, nam, nlen, val, vlen);
1979 (void)putenv(new_env);
1980 # endif /* HAS_UNSETENV */
1981 # endif /* __CYGWIN__ */
1982 #ifndef PERL_USE_SAFE_PUTENV
1988 #else /* WIN32 || NETWARE */
1991 Perl_my_setenv(pTHX_ const char *nam, const char *val)
1995 const int nlen = strlen(nam);
2002 Newx(envstr, nlen+vlen+2, char);
2003 my_setenv_format(envstr, nam, nlen, val, vlen);
2004 (void)PerlEnv_putenv(envstr);
2008 #endif /* WIN32 || NETWARE */
2012 #ifdef UNLINK_ALL_VERSIONS
2014 Perl_unlnk(pTHX_ const char *f) /* unlink all versions of a file */
2018 PERL_ARGS_ASSERT_UNLNK;
2020 while (PerlLIO_unlink(f) >= 0)
2022 return retries ? 0 : -1;
2026 /* this is a drop-in replacement for bcopy() */
2027 #if (!defined(HAS_MEMCPY) && !defined(HAS_BCOPY)) || (!defined(HAS_MEMMOVE) && !defined(HAS_SAFE_MEMCPY) && !defined(HAS_SAFE_BCOPY))
2029 Perl_my_bcopy(const char *from, char *to, I32 len)
2031 char * const retval = to;
2033 PERL_ARGS_ASSERT_MY_BCOPY;
2037 if (from - to >= 0) {
2045 *(--to) = *(--from);
2051 /* this is a drop-in replacement for memset() */
2054 Perl_my_memset(char *loc, I32 ch, I32 len)
2056 char * const retval = loc;
2058 PERL_ARGS_ASSERT_MY_MEMSET;
2068 /* this is a drop-in replacement for bzero() */
2069 #if !defined(HAS_BZERO) && !defined(HAS_MEMSET)
2071 Perl_my_bzero(char *loc, I32 len)
2073 char * const retval = loc;
2075 PERL_ARGS_ASSERT_MY_BZERO;
2085 /* this is a drop-in replacement for memcmp() */
2086 #if !defined(HAS_MEMCMP) || !defined(HAS_SANE_MEMCMP)
2088 Perl_my_memcmp(const char *s1, const char *s2, I32 len)
2090 const U8 *a = (const U8 *)s1;
2091 const U8 *b = (const U8 *)s2;
2094 PERL_ARGS_ASSERT_MY_MEMCMP;
2099 if ((tmp = *a++ - *b++))
2104 #endif /* !HAS_MEMCMP || !HAS_SANE_MEMCMP */
2107 /* This vsprintf replacement should generally never get used, since
2108 vsprintf was available in both System V and BSD 2.11. (There may
2109 be some cross-compilation or embedded set-ups where it is needed,
2112 If you encounter a problem in this function, it's probably a symptom
2113 that Configure failed to detect your system's vprintf() function.
2114 See the section on "item vsprintf" in the INSTALL file.
2116 This version may compile on systems with BSD-ish <stdio.h>,
2117 but probably won't on others.
2120 #ifdef USE_CHAR_VSPRINTF
2125 vsprintf(char *dest, const char *pat, void *args)
2129 #if defined(STDIO_PTR_LVALUE) && defined(STDIO_CNT_LVALUE)
2130 FILE_ptr(&fakebuf) = (STDCHAR *) dest;
2131 FILE_cnt(&fakebuf) = 32767;
2133 /* These probably won't compile -- If you really need
2134 this, you'll have to figure out some other method. */
2135 fakebuf._ptr = dest;
2136 fakebuf._cnt = 32767;
2141 fakebuf._flag = _IOWRT|_IOSTRG;
2142 _doprnt(pat, args, &fakebuf); /* what a kludge */
2143 #if defined(STDIO_PTR_LVALUE)
2144 *(FILE_ptr(&fakebuf)++) = '\0';
2146 /* PerlIO has probably #defined away fputc, but we want it here. */
2148 # undef fputc /* XXX Should really restore it later */
2150 (void)fputc('\0', &fakebuf);
2152 #ifdef USE_CHAR_VSPRINTF
2155 return 0; /* perl doesn't use return value */
2159 #endif /* HAS_VPRINTF */
2162 Perl_my_popen_list(pTHX_ const char *mode, int n, SV **args)
2164 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(OS2) && !defined(VMS) && !defined(NETWARE) && !defined(__LIBCATAMOUNT__)
2173 PERL_ARGS_ASSERT_MY_POPEN_LIST;
2175 PERL_FLUSHALL_FOR_CHILD;
2176 This = (*mode == 'w');
2180 taint_proper("Insecure %s%s", "EXEC");
2182 if (PerlProc_pipe(p) < 0)
2184 /* Try for another pipe pair for error return */
2185 if (PerlProc_pipe(pp) >= 0)
2187 while ((pid = PerlProc_fork()) < 0) {
2188 if (errno != EAGAIN) {
2189 PerlLIO_close(p[This]);
2190 PerlLIO_close(p[that]);
2192 PerlLIO_close(pp[0]);
2193 PerlLIO_close(pp[1]);
2197 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2206 /* Close parent's end of error status pipe (if any) */
2208 PerlLIO_close(pp[0]);
2209 #if defined(HAS_FCNTL) && defined(F_SETFD)
2210 /* Close error pipe automatically if exec works */
2211 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2214 /* Now dup our end of _the_ pipe to right position */
2215 if (p[THIS] != (*mode == 'r')) {
2216 PerlLIO_dup2(p[THIS], *mode == 'r');
2217 PerlLIO_close(p[THIS]);
2218 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2219 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2222 PerlLIO_close(p[THAT]); /* close parent's end of _the_ pipe */
2223 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2224 /* No automatic close - do it by hand */
2231 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++) {
2237 do_aexec5(NULL, args-1, args-1+n, pp[1], did_pipes);
2243 do_execfree(); /* free any memory malloced by child on fork */
2245 PerlLIO_close(pp[1]);
2246 /* Keep the lower of the two fd numbers */
2247 if (p[that] < p[This]) {
2248 PerlLIO_dup2(p[This], p[that]);
2249 PerlLIO_close(p[This]);
2253 PerlLIO_close(p[that]); /* close child's end of pipe */
2255 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2256 SvUPGRADE(sv,SVt_IV);
2258 PL_forkprocess = pid;
2259 /* If we managed to get status pipe check for exec fail */
2260 if (did_pipes && pid > 0) {
2265 while (n < sizeof(int)) {
2266 n1 = PerlLIO_read(pp[0],
2267 (void*)(((char*)&errkid)+n),
2273 PerlLIO_close(pp[0]);
2275 if (n) { /* Error */
2277 PerlLIO_close(p[This]);
2278 if (n != sizeof(int))
2279 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2281 pid2 = wait4pid(pid, &status, 0);
2282 } while (pid2 == -1 && errno == EINTR);
2283 errno = errkid; /* Propagate errno from kid */
2288 PerlLIO_close(pp[0]);
2289 return PerlIO_fdopen(p[This], mode);
2291 # ifdef OS2 /* Same, without fork()ing and all extra overhead... */
2292 return my_syspopen4(aTHX_ NULL, mode, n, args);
2294 Perl_croak(aTHX_ "List form of piped open not implemented");
2295 return (PerlIO *) NULL;
2300 /* VMS' my_popen() is in VMS.c, same with OS/2. */
2301 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2303 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2310 const I32 doexec = !(*cmd == '-' && cmd[1] == '\0');
2314 PERL_ARGS_ASSERT_MY_POPEN;
2316 PERL_FLUSHALL_FOR_CHILD;
2319 return my_syspopen(aTHX_ cmd,mode);
2322 This = (*mode == 'w');
2324 if (doexec && TAINTING_get) {
2326 taint_proper("Insecure %s%s", "EXEC");
2328 if (PerlProc_pipe(p) < 0)
2330 if (doexec && PerlProc_pipe(pp) >= 0)
2332 while ((pid = PerlProc_fork()) < 0) {
2333 if (errno != EAGAIN) {
2334 PerlLIO_close(p[This]);
2335 PerlLIO_close(p[that]);
2337 PerlLIO_close(pp[0]);
2338 PerlLIO_close(pp[1]);
2341 Perl_croak(aTHX_ "Can't fork: %s", Strerror(errno));
2344 Perl_ck_warner(aTHX_ packWARN(WARN_PIPE), "Can't fork, trying again in 5 seconds");
2354 PerlLIO_close(pp[0]);
2355 #if defined(HAS_FCNTL) && defined(F_SETFD)
2356 fcntl(pp[1], F_SETFD, FD_CLOEXEC);
2359 if (p[THIS] != (*mode == 'r')) {
2360 PerlLIO_dup2(p[THIS], *mode == 'r');
2361 PerlLIO_close(p[THIS]);
2362 if (p[THAT] != (*mode == 'r')) /* if dup2() didn't close it */
2363 PerlLIO_close(p[THAT]);
2366 PerlLIO_close(p[THAT]);
2369 #if !defined(HAS_FCNTL) || !defined(F_SETFD)
2376 for (fd = PL_maxsysfd + 1; fd < NOFILE; fd++)
2381 /* may or may not use the shell */
2382 do_exec3(cmd, pp[1], did_pipes);
2385 #endif /* defined OS2 */
2387 #ifdef PERLIO_USING_CRLF
2388 /* Since we circumvent IO layers when we manipulate low-level
2389 filedescriptors directly, need to manually switch to the
2390 default, binary, low-level mode; see PerlIOBuf_open(). */
2391 PerlLIO_setmode((*mode == 'r'), O_BINARY);
2394 #ifdef PERL_USES_PL_PIDSTATUS
2395 hv_clear(PL_pidstatus); /* we have no children */
2401 do_execfree(); /* free any memory malloced by child on vfork */
2403 PerlLIO_close(pp[1]);
2404 if (p[that] < p[This]) {
2405 PerlLIO_dup2(p[This], p[that]);
2406 PerlLIO_close(p[This]);
2410 PerlLIO_close(p[that]);
2412 sv = *av_fetch(PL_fdpid,p[This],TRUE);
2413 SvUPGRADE(sv,SVt_IV);
2415 PL_forkprocess = pid;
2416 if (did_pipes && pid > 0) {
2421 while (n < sizeof(int)) {
2422 n1 = PerlLIO_read(pp[0],
2423 (void*)(((char*)&errkid)+n),
2429 PerlLIO_close(pp[0]);
2431 if (n) { /* Error */
2433 PerlLIO_close(p[This]);
2434 if (n != sizeof(int))
2435 Perl_croak(aTHX_ "panic: kid popen errno read, n=%u", n);
2437 pid2 = wait4pid(pid, &status, 0);
2438 } while (pid2 == -1 && errno == EINTR);
2439 errno = errkid; /* Propagate errno from kid */
2444 PerlLIO_close(pp[0]);
2445 return PerlIO_fdopen(p[This], mode);
2449 FILE *djgpp_popen();
2451 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2453 PERL_FLUSHALL_FOR_CHILD;
2454 /* Call system's popen() to get a FILE *, then import it.
2455 used 0 for 2nd parameter to PerlIO_importFILE;
2458 return PerlIO_importFILE(djgpp_popen(cmd, mode), 0);
2461 #if defined(__LIBCATAMOUNT__)
2463 Perl_my_popen(pTHX_ const char *cmd, const char *mode)
2470 #endif /* !DOSISH */
2472 /* this is called in parent before the fork() */
2474 Perl_atfork_lock(void)
2477 #if defined(USE_ITHREADS)
2478 /* locks must be held in locking order (if any) */
2480 MUTEX_LOCK(&PL_perlio_mutex);
2483 MUTEX_LOCK(&PL_malloc_mutex);
2489 /* this is called in both parent and child after the fork() */
2491 Perl_atfork_unlock(void)
2494 #if defined(USE_ITHREADS)
2495 /* locks must be released in same order as in atfork_lock() */
2497 MUTEX_UNLOCK(&PL_perlio_mutex);
2500 MUTEX_UNLOCK(&PL_malloc_mutex);
2509 #if defined(HAS_FORK)
2511 #if defined(USE_ITHREADS) && !defined(HAS_PTHREAD_ATFORK)
2516 /* atfork_lock() and atfork_unlock() are installed as pthread_atfork()
2517 * handlers elsewhere in the code */
2522 /* this "canna happen" since nothing should be calling here if !HAS_FORK */
2523 Perl_croak_nocontext("fork() not available");
2525 #endif /* HAS_FORK */
2530 Perl_dump_fds(pTHX_ const char *const s)
2535 PERL_ARGS_ASSERT_DUMP_FDS;
2537 PerlIO_printf(Perl_debug_log,"%s", s);
2538 for (fd = 0; fd < 32; fd++) {
2539 if (PerlLIO_fstat(fd,&tmpstatbuf) >= 0)
2540 PerlIO_printf(Perl_debug_log," %d",fd);
2542 PerlIO_printf(Perl_debug_log,"\n");
2545 #endif /* DUMP_FDS */
2549 dup2(int oldfd, int newfd)
2551 #if defined(HAS_FCNTL) && defined(F_DUPFD)
2554 PerlLIO_close(newfd);
2555 return fcntl(oldfd, F_DUPFD, newfd);
2557 #define DUP2_MAX_FDS 256
2558 int fdtmp[DUP2_MAX_FDS];
2564 PerlLIO_close(newfd);
2565 /* good enough for low fd's... */
2566 while ((fd = PerlLIO_dup(oldfd)) != newfd && fd >= 0) {
2567 if (fdx >= DUP2_MAX_FDS) {
2575 PerlLIO_close(fdtmp[--fdx]);
2582 #ifdef HAS_SIGACTION
2585 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2588 struct sigaction act, oact;
2591 /* only "parent" interpreter can diddle signals */
2592 if (PL_curinterp != aTHX)
2593 return (Sighandler_t) SIG_ERR;
2596 act.sa_handler = (void(*)(int))handler;
2597 sigemptyset(&act.sa_mask);
2600 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2601 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2603 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2604 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2605 act.sa_flags |= SA_NOCLDWAIT;
2607 if (sigaction(signo, &act, &oact) == -1)
2608 return (Sighandler_t) SIG_ERR;
2610 return (Sighandler_t) oact.sa_handler;
2614 Perl_rsignal_state(pTHX_ int signo)
2616 struct sigaction oact;
2617 PERL_UNUSED_CONTEXT;
2619 if (sigaction(signo, (struct sigaction *)NULL, &oact) == -1)
2620 return (Sighandler_t) SIG_ERR;
2622 return (Sighandler_t) oact.sa_handler;
2626 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2629 struct sigaction act;
2631 PERL_ARGS_ASSERT_RSIGNAL_SAVE;
2634 /* only "parent" interpreter can diddle signals */
2635 if (PL_curinterp != aTHX)
2639 act.sa_handler = (void(*)(int))handler;
2640 sigemptyset(&act.sa_mask);
2643 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
2644 act.sa_flags |= SA_RESTART; /* SVR4, 4.3+BSD */
2646 #if defined(SA_NOCLDWAIT) && !defined(BSDish) /* See [perl #18849] */
2647 if (signo == SIGCHLD && handler == (Sighandler_t) SIG_IGN)
2648 act.sa_flags |= SA_NOCLDWAIT;
2650 return sigaction(signo, &act, save);
2654 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2658 /* only "parent" interpreter can diddle signals */
2659 if (PL_curinterp != aTHX)
2663 return sigaction(signo, save, (struct sigaction *)NULL);
2666 #else /* !HAS_SIGACTION */
2669 Perl_rsignal(pTHX_ int signo, Sighandler_t handler)
2671 #if defined(USE_ITHREADS) && !defined(WIN32)
2672 /* only "parent" interpreter can diddle signals */
2673 if (PL_curinterp != aTHX)
2674 return (Sighandler_t) SIG_ERR;
2677 return PerlProc_signal(signo, handler);
2688 Perl_rsignal_state(pTHX_ int signo)
2691 Sighandler_t oldsig;
2693 #if defined(USE_ITHREADS) && !defined(WIN32)
2694 /* only "parent" interpreter can diddle signals */
2695 if (PL_curinterp != aTHX)
2696 return (Sighandler_t) SIG_ERR;
2700 oldsig = PerlProc_signal(signo, sig_trap);
2701 PerlProc_signal(signo, oldsig);
2703 PerlProc_kill(PerlProc_getpid(), signo);
2708 Perl_rsignal_save(pTHX_ int signo, Sighandler_t handler, Sigsave_t *save)
2710 #if defined(USE_ITHREADS) && !defined(WIN32)
2711 /* only "parent" interpreter can diddle signals */
2712 if (PL_curinterp != aTHX)
2715 *save = PerlProc_signal(signo, handler);
2716 return (*save == (Sighandler_t) SIG_ERR) ? -1 : 0;
2720 Perl_rsignal_restore(pTHX_ int signo, Sigsave_t *save)
2722 #if defined(USE_ITHREADS) && !defined(WIN32)
2723 /* only "parent" interpreter can diddle signals */
2724 if (PL_curinterp != aTHX)
2727 return (PerlProc_signal(signo, *save) == (Sighandler_t) SIG_ERR) ? -1 : 0;
2730 #endif /* !HAS_SIGACTION */
2731 #endif /* !PERL_MICRO */
2733 /* VMS' my_pclose() is in VMS.c; same with OS/2 */
2734 #if (!defined(DOSISH) || defined(HAS_FORK) || defined(AMIGAOS)) && !defined(VMS) && !defined(__LIBCATAMOUNT__)
2736 Perl_my_pclose(pTHX_ PerlIO *ptr)
2745 const int fd = PerlIO_fileno(ptr);
2748 /* Find out whether the refcount is low enough for us to wait for the
2749 child proc without blocking. */
2750 const bool should_wait = PerlIOUnix_refcnt(fd) == 1;
2752 const bool should_wait = 1;
2755 svp = av_fetch(PL_fdpid,fd,TRUE);
2756 pid = (SvTYPE(*svp) == SVt_IV) ? SvIVX(*svp) : -1;
2758 *svp = &PL_sv_undef;
2760 if (pid == -1) { /* Opened by popen. */
2761 return my_syspclose(ptr);
2764 close_failed = (PerlIO_close(ptr) == EOF);
2766 if (should_wait) do {
2767 pid2 = wait4pid(pid, &status, 0);
2768 } while (pid2 == -1 && errno == EINTR);
2775 ? pid2 < 0 ? pid2 : status == 0 ? 0 : (errno = 0, status)
2780 #if defined(__LIBCATAMOUNT__)
2782 Perl_my_pclose(pTHX_ PerlIO *ptr)
2787 #endif /* !DOSISH */
2789 #if (!defined(DOSISH) || defined(OS2) || defined(WIN32) || defined(NETWARE)) && !defined(__LIBCATAMOUNT__)
2791 Perl_wait4pid(pTHX_ Pid_t pid, int *statusp, int flags)
2795 PERL_ARGS_ASSERT_WAIT4PID;
2798 #ifdef PERL_USES_PL_PIDSTATUS
2801 /* The keys in PL_pidstatus are now the raw 4 (or 8) bytes of the
2802 pid, rather than a string form. */
2803 SV * const * const svp = hv_fetch(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),FALSE);
2804 if (svp && *svp != &PL_sv_undef) {
2805 *statusp = SvIVX(*svp);
2806 (void)hv_delete(PL_pidstatus,(const char*) &pid,sizeof(Pid_t),
2814 hv_iterinit(PL_pidstatus);
2815 if ((entry = hv_iternext(PL_pidstatus))) {
2816 SV * const sv = hv_iterval(PL_pidstatus,entry);
2818 const char * const spid = hv_iterkey(entry,&len);
2820 assert (len == sizeof(Pid_t));
2821 memcpy((char *)&pid, spid, len);
2822 *statusp = SvIVX(sv);
2823 /* The hash iterator is currently on this entry, so simply
2824 calling hv_delete would trigger the lazy delete, which on
2825 aggregate does more work, beacuse next call to hv_iterinit()
2826 would spot the flag, and have to call the delete routine,
2827 while in the meantime any new entries can't re-use that
2829 hv_iterinit(PL_pidstatus);
2830 (void)hv_delete(PL_pidstatus,spid,len,G_DISCARD);
2837 # ifdef HAS_WAITPID_RUNTIME
2838 if (!HAS_WAITPID_RUNTIME)
2841 result = PerlProc_waitpid(pid,statusp,flags);
2844 #if !defined(HAS_WAITPID) && defined(HAS_WAIT4)
2845 result = wait4((pid==-1)?0:pid,statusp,flags,NULL);
2848 #ifdef PERL_USES_PL_PIDSTATUS
2849 #if defined(HAS_WAITPID) && defined(HAS_WAITPID_RUNTIME)
2854 Perl_croak(aTHX_ "Can't do waitpid with flags");
2856 while ((result = PerlProc_wait(statusp)) != pid && pid > 0 && result >= 0)
2857 pidgone(result,*statusp);
2863 #if defined(HAS_WAITPID) || defined(HAS_WAIT4)
2866 if (result < 0 && errno == EINTR) {
2868 errno = EINTR; /* reset in case a signal handler changed $! */
2872 #endif /* !DOSISH || OS2 || WIN32 || NETWARE */
2874 #ifdef PERL_USES_PL_PIDSTATUS
2876 S_pidgone(pTHX_ Pid_t pid, int status)
2880 sv = *hv_fetch(PL_pidstatus,(const char*)&pid,sizeof(Pid_t),TRUE);
2881 SvUPGRADE(sv,SVt_IV);
2882 SvIV_set(sv, status);
2890 int /* Cannot prototype with I32
2892 my_syspclose(PerlIO *ptr)
2895 Perl_my_pclose(pTHX_ PerlIO *ptr)
2898 /* Needs work for PerlIO ! */
2899 FILE * const f = PerlIO_findFILE(ptr);
2900 const I32 result = pclose(f);
2901 PerlIO_releaseFILE(ptr,f);
2909 Perl_my_pclose(pTHX_ PerlIO *ptr)
2911 /* Needs work for PerlIO ! */
2912 FILE * const f = PerlIO_findFILE(ptr);
2913 I32 result = djgpp_pclose(f);
2914 result = (result << 8) & 0xff00;
2915 PerlIO_releaseFILE(ptr,f);
2920 #define PERL_REPEATCPY_LINEAR 4
2922 Perl_repeatcpy(char *to, const char *from, I32 len, IV count)
2924 PERL_ARGS_ASSERT_REPEATCPY;
2929 Perl_croak_memory_wrap();
2932 memset(to, *from, count);
2935 IV items, linear, half;
2937 linear = count < PERL_REPEATCPY_LINEAR ? count : PERL_REPEATCPY_LINEAR;
2938 for (items = 0; items < linear; ++items) {
2939 const char *q = from;
2941 for (todo = len; todo > 0; todo--)
2946 while (items <= half) {
2947 IV size = items * len;
2948 memcpy(p, to, size);
2954 memcpy(p, to, (count - items) * len);
2960 Perl_same_dirent(pTHX_ const char *a, const char *b)
2962 char *fa = strrchr(a,'/');
2963 char *fb = strrchr(b,'/');
2966 SV * const tmpsv = sv_newmortal();
2968 PERL_ARGS_ASSERT_SAME_DIRENT;
2981 sv_setpvs(tmpsv, ".");
2983 sv_setpvn(tmpsv, a, fa - a);
2984 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf1) < 0)
2987 sv_setpvs(tmpsv, ".");
2989 sv_setpvn(tmpsv, b, fb - b);
2990 if (PerlLIO_stat(SvPVX_const(tmpsv), &tmpstatbuf2) < 0)
2992 return tmpstatbuf1.st_dev == tmpstatbuf2.st_dev &&
2993 tmpstatbuf1.st_ino == tmpstatbuf2.st_ino;
2995 #endif /* !HAS_RENAME */
2998 Perl_find_script(pTHX_ const char *scriptname, bool dosearch,
2999 const char *const *const search_ext, I32 flags)
3002 const char *xfound = NULL;
3003 char *xfailed = NULL;
3004 char tmpbuf[MAXPATHLEN];
3009 #if defined(DOSISH) && !defined(OS2)
3010 # define SEARCH_EXTS ".bat", ".cmd", NULL
3011 # define MAX_EXT_LEN 4
3014 # define SEARCH_EXTS ".cmd", ".btm", ".bat", ".pl", NULL
3015 # define MAX_EXT_LEN 4
3018 # define SEARCH_EXTS ".pl", ".com", NULL
3019 # define MAX_EXT_LEN 4
3021 /* additional extensions to try in each dir if scriptname not found */
3023 static const char *const exts[] = { SEARCH_EXTS };
3024 const char *const *const ext = search_ext ? search_ext : exts;
3025 int extidx = 0, i = 0;
3026 const char *curext = NULL;
3028 PERL_UNUSED_ARG(search_ext);
3029 # define MAX_EXT_LEN 0
3032 PERL_ARGS_ASSERT_FIND_SCRIPT;
3035 * If dosearch is true and if scriptname does not contain path
3036 * delimiters, search the PATH for scriptname.
3038 * If SEARCH_EXTS is also defined, will look for each
3039 * scriptname{SEARCH_EXTS} whenever scriptname is not found
3040 * while searching the PATH.
3042 * Assuming SEARCH_EXTS is C<".foo",".bar",NULL>, PATH search
3043 * proceeds as follows:
3044 * If DOSISH or VMSISH:
3045 * + look for ./scriptname{,.foo,.bar}
3046 * + search the PATH for scriptname{,.foo,.bar}
3049 * + look *only* in the PATH for scriptname{,.foo,.bar} (note
3050 * this will not look in '.' if it's not in the PATH)
3055 # ifdef ALWAYS_DEFTYPES
3056 len = strlen(scriptname);
3057 if (!(len == 1 && *scriptname == '-') && scriptname[len-1] != ':') {
3058 int idx = 0, deftypes = 1;
3061 const int hasdir = !dosearch || (strpbrk(scriptname,":[</") != NULL);
3064 int idx = 0, deftypes = 1;
3067 const int hasdir = (strpbrk(scriptname,":[</") != NULL);
3069 /* The first time through, just add SEARCH_EXTS to whatever we
3070 * already have, so we can check for default file types. */
3072 (!hasdir && my_trnlnm("DCL$PATH",tmpbuf,idx++)) )
3078 if ((strlen(tmpbuf) + strlen(scriptname)
3079 + MAX_EXT_LEN) >= sizeof tmpbuf)
3080 continue; /* don't search dir with too-long name */
3081 my_strlcat(tmpbuf, scriptname, sizeof(tmpbuf));
3085 if (strEQ(scriptname, "-"))
3087 if (dosearch) { /* Look in '.' first. */
3088 const char *cur = scriptname;
3090 if ((curext = strrchr(scriptname,'.'))) /* possible current ext */
3092 if (strEQ(ext[i++],curext)) {
3093 extidx = -1; /* already has an ext */
3098 DEBUG_p(PerlIO_printf(Perl_debug_log,
3099 "Looking for %s\n",cur));
3100 if (PerlLIO_stat(cur,&PL_statbuf) >= 0
3101 && !S_ISDIR(PL_statbuf.st_mode)) {
3109 if (cur == scriptname) {
3110 len = strlen(scriptname);
3111 if (len+MAX_EXT_LEN+1 >= sizeof(tmpbuf))
3113 my_strlcpy(tmpbuf, scriptname, sizeof(tmpbuf));
3116 } while (extidx >= 0 && ext[extidx] /* try an extension? */
3117 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len));
3122 if (dosearch && !strchr(scriptname, '/')
3124 && !strchr(scriptname, '\\')
3126 && (s = PerlEnv_getenv("PATH")))
3130 bufend = s + strlen(s);
3131 while (s < bufend) {
3134 && *s != ';'; len++, s++) {
3135 if (len < sizeof tmpbuf)
3138 if (len < sizeof tmpbuf)
3141 s = delimcpy(tmpbuf, tmpbuf + sizeof tmpbuf, s, bufend,
3147 if (len + 1 + strlen(scriptname) + MAX_EXT_LEN >= sizeof tmpbuf)
3148 continue; /* don't search dir with too-long name */
3151 && tmpbuf[len - 1] != '/'
3152 && tmpbuf[len - 1] != '\\'
3155 tmpbuf[len++] = '/';
3156 if (len == 2 && tmpbuf[0] == '.')
3158 (void)my_strlcpy(tmpbuf + len, scriptname, sizeof(tmpbuf) - len);
3162 len = strlen(tmpbuf);
3163 if (extidx > 0) /* reset after previous loop */
3167 DEBUG_p(PerlIO_printf(Perl_debug_log, "Looking for %s\n",tmpbuf));
3168 retval = PerlLIO_stat(tmpbuf,&PL_statbuf);
3169 if (S_ISDIR(PL_statbuf.st_mode)) {
3173 } while ( retval < 0 /* not there */
3174 && extidx>=0 && ext[extidx] /* try an extension? */
3175 && my_strlcpy(tmpbuf+len, ext[extidx++], sizeof(tmpbuf) - len)
3180 if (S_ISREG(PL_statbuf.st_mode)
3181 && cando(S_IRUSR,TRUE,&PL_statbuf)
3182 #if !defined(DOSISH)
3183 && cando(S_IXUSR,TRUE,&PL_statbuf)
3187 xfound = tmpbuf; /* bingo! */
3191 xfailed = savepv(tmpbuf);
3194 if (!xfound && !seen_dot && !xfailed &&
3195 (PerlLIO_stat(scriptname,&PL_statbuf) < 0
3196 || S_ISDIR(PL_statbuf.st_mode)))
3198 seen_dot = 1; /* Disable message. */
3200 if (flags & 1) { /* do or die? */
3201 /* diag_listed_as: Can't execute %s */
3202 Perl_croak(aTHX_ "Can't %s %s%s%s",
3203 (xfailed ? "execute" : "find"),
3204 (xfailed ? xfailed : scriptname),
3205 (xfailed ? "" : " on PATH"),
3206 (xfailed || seen_dot) ? "" : ", '.' not in PATH");
3211 scriptname = xfound;
3213 return (scriptname ? savepv(scriptname) : NULL);
3216 #ifndef PERL_GET_CONTEXT_DEFINED
3219 Perl_get_context(void)
3222 #if defined(USE_ITHREADS)
3223 # ifdef OLD_PTHREADS_API
3225 int error = pthread_getspecific(PL_thr_key, &t)
3227 Perl_croak_nocontext("panic: pthread_getspecific, error=%d", error);
3230 # ifdef I_MACH_CTHREADS
3231 return (void*)cthread_data(cthread_self());
3233 return (void*)PTHREAD_GETSPECIFIC(PL_thr_key);
3242 Perl_set_context(void *t)
3245 PERL_ARGS_ASSERT_SET_CONTEXT;
3246 #if defined(USE_ITHREADS)
3247 # ifdef I_MACH_CTHREADS
3248 cthread_set_data(cthread_self(), t);
3251 const int error = pthread_setspecific(PL_thr_key, t);
3253 Perl_croak_nocontext("panic: pthread_setspecific, error=%d", error);
3261 #endif /* !PERL_GET_CONTEXT_DEFINED */
3263 #if defined(PERL_GLOBAL_STRUCT) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
3272 Perl_get_op_names(pTHX)
3274 PERL_UNUSED_CONTEXT;
3275 return (char **)PL_op_name;
3279 Perl_get_op_descs(pTHX)
3281 PERL_UNUSED_CONTEXT;
3282 return (char **)PL_op_desc;
3286 Perl_get_no_modify(pTHX)
3288 PERL_UNUSED_CONTEXT;
3289 return PL_no_modify;
3293 Perl_get_opargs(pTHX)
3295 PERL_UNUSED_CONTEXT;
3296 return (U32 *)PL_opargs;
3300 Perl_get_ppaddr(pTHX)
3303 PERL_UNUSED_CONTEXT;
3304 return (PPADDR_t*)PL_ppaddr;
3307 #ifndef HAS_GETENV_LEN
3309 Perl_getenv_len(pTHX_ const char *env_elem, unsigned long *len)
3311 char * const env_trans = PerlEnv_getenv(env_elem);
3312 PERL_UNUSED_CONTEXT;
3313 PERL_ARGS_ASSERT_GETENV_LEN;
3315 *len = strlen(env_trans);
3322 Perl_get_vtbl(pTHX_ int vtbl_id)
3324 PERL_UNUSED_CONTEXT;
3326 return (vtbl_id < 0 || vtbl_id >= magic_vtable_max)
3327 ? NULL : PL_magic_vtables + vtbl_id;
3331 Perl_my_fflush_all(pTHX)
3333 #if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3334 return PerlIO_flush(NULL);
3336 # if defined(HAS__FWALK)
3337 extern int fflush(FILE *);
3338 /* undocumented, unprototyped, but very useful BSDism */
3339 extern void _fwalk(int (*)(FILE *));
3343 # if defined(FFLUSH_ALL) && defined(HAS_STDIO_STREAM_ARRAY)
3345 # ifdef PERL_FFLUSH_ALL_FOPEN_MAX
3346 open_max = PERL_FFLUSH_ALL_FOPEN_MAX;
3348 # if defined(HAS_SYSCONF) && defined(_SC_OPEN_MAX)
3349 open_max = sysconf(_SC_OPEN_MAX);
3352 open_max = FOPEN_MAX;
3355 open_max = OPEN_MAX;
3366 for (i = 0; i < open_max; i++)
3367 if (STDIO_STREAM_ARRAY[i]._file >= 0 &&
3368 STDIO_STREAM_ARRAY[i]._file < open_max &&
3369 STDIO_STREAM_ARRAY[i]._flag)
3370 PerlIO_flush(&STDIO_STREAM_ARRAY[i]);
3374 SETERRNO(EBADF,RMS_IFI);
3381 Perl_report_wrongway_fh(pTHX_ const GV *gv, const char have)
3383 if (ckWARN(WARN_IO)) {
3385 = gv && (isGV_with_GP(gv))
3388 const char * const direction = have == '>' ? "out" : "in";
3390 if (name && HEK_LEN(name))
3391 Perl_warner(aTHX_ packWARN(WARN_IO),
3392 "Filehandle %"HEKf" opened only for %sput",
3395 Perl_warner(aTHX_ packWARN(WARN_IO),
3396 "Filehandle opened only for %sput", direction);
3401 Perl_report_evil_fh(pTHX_ const GV *gv)
3403 const IO *io = gv ? GvIO(gv) : NULL;
3404 const PERL_BITFIELD16 op = PL_op->op_type;
3408 if (io && IoTYPE(io) == IoTYPE_CLOSED) {
3410 warn_type = WARN_CLOSED;
3414 warn_type = WARN_UNOPENED;
3417 if (ckWARN(warn_type)) {
3419 = gv && isGV_with_GP(gv) && GvENAMELEN(gv) ?
3420 sv_2mortal(newSVhek(GvENAME_HEK(gv))) : NULL;
3421 const char * const pars =
3422 (const char *)(OP_IS_FILETEST(op) ? "" : "()");
3423 const char * const func =
3425 (op == OP_READLINE ? "readline" : /* "<HANDLE>" not nice */
3426 op == OP_LEAVEWRITE ? "write" : /* "write exit" not nice */
3428 const char * const type =
3430 (OP_IS_SOCKET(op) || (io && IoTYPE(io) == IoTYPE_SOCKET)
3431 ? "socket" : "filehandle");
3432 const bool have_name = name && SvCUR(name);
3433 Perl_warner(aTHX_ packWARN(warn_type),
3434 "%s%s on %s %s%s%"SVf, func, pars, vile, type,
3435 have_name ? " " : "",
3436 SVfARG(have_name ? name : &PL_sv_no));
3437 if (io && IoDIRP(io) && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3439 aTHX_ packWARN(warn_type),
3440 "\t(Are you trying to call %s%s on dirhandle%s%"SVf"?)\n",
3441 func, pars, have_name ? " " : "",
3442 SVfARG(have_name ? name : &PL_sv_no)
3447 /* To workaround core dumps from the uninitialised tm_zone we get the
3448 * system to give us a reasonable struct to copy. This fix means that
3449 * strftime uses the tm_zone and tm_gmtoff values returned by
3450 * localtime(time()). That should give the desired result most of the
3451 * time. But probably not always!
3453 * This does not address tzname aspects of NETaa14816.
3458 # ifndef STRUCT_TM_HASZONE
3459 # define STRUCT_TM_HASZONE
3463 #ifdef STRUCT_TM_HASZONE /* Backward compat */
3464 # ifndef HAS_TM_TM_ZONE
3465 # define HAS_TM_TM_ZONE
3470 Perl_init_tm(pTHX_ struct tm *ptm) /* see mktime, strftime and asctime */
3472 #ifdef HAS_TM_TM_ZONE
3474 const struct tm* my_tm;
3475 PERL_ARGS_ASSERT_INIT_TM;
3477 my_tm = localtime(&now);
3479 Copy(my_tm, ptm, 1, struct tm);
3481 PERL_ARGS_ASSERT_INIT_TM;
3482 PERL_UNUSED_ARG(ptm);
3487 * mini_mktime - normalise struct tm values without the localtime()
3488 * semantics (and overhead) of mktime().
3491 Perl_mini_mktime(pTHX_ struct tm *ptm)
3495 int month, mday, year, jday;
3496 int odd_cent, odd_year;
3497 PERL_UNUSED_CONTEXT;
3499 PERL_ARGS_ASSERT_MINI_MKTIME;
3501 #define DAYS_PER_YEAR 365
3502 #define DAYS_PER_QYEAR (4*DAYS_PER_YEAR+1)
3503 #define DAYS_PER_CENT (25*DAYS_PER_QYEAR-1)
3504 #define DAYS_PER_QCENT (4*DAYS_PER_CENT+1)
3505 #define SECS_PER_HOUR (60*60)
3506 #define SECS_PER_DAY (24*SECS_PER_HOUR)
3507 /* parentheses deliberately absent on these two, otherwise they don't work */
3508 #define MONTH_TO_DAYS 153/5
3509 #define DAYS_TO_MONTH 5/153
3510 /* offset to bias by March (month 4) 1st between month/mday & year finding */
3511 #define YEAR_ADJUST (4*MONTH_TO_DAYS+1)
3512 /* as used here, the algorithm leaves Sunday as day 1 unless we adjust it */
3513 #define WEEKDAY_BIAS 6 /* (1+6)%7 makes Sunday 0 again */
3516 * Year/day algorithm notes:
3518 * With a suitable offset for numeric value of the month, one can find
3519 * an offset into the year by considering months to have 30.6 (153/5) days,
3520 * using integer arithmetic (i.e., with truncation). To avoid too much
3521 * messing about with leap days, we consider January and February to be
3522 * the 13th and 14th month of the previous year. After that transformation,
3523 * we need the month index we use to be high by 1 from 'normal human' usage,
3524 * so the month index values we use run from 4 through 15.
3526 * Given that, and the rules for the Gregorian calendar (leap years are those
3527 * divisible by 4 unless also divisible by 100, when they must be divisible
3528 * by 400 instead), we can simply calculate the number of days since some
3529 * arbitrary 'beginning of time' by futzing with the (adjusted) year number,
3530 * the days we derive from our month index, and adding in the day of the
3531 * month. The value used here is not adjusted for the actual origin which
3532 * it normally would use (1 January A.D. 1), since we're not exposing it.
3533 * We're only building the value so we can turn around and get the
3534 * normalised values for the year, month, day-of-month, and day-of-year.
3536 * For going backward, we need to bias the value we're using so that we find
3537 * the right year value. (Basically, we don't want the contribution of
3538 * March 1st to the number to apply while deriving the year). Having done
3539 * that, we 'count up' the contribution to the year number by accounting for
3540 * full quadracenturies (400-year periods) with their extra leap days, plus
3541 * the contribution from full centuries (to avoid counting in the lost leap
3542 * days), plus the contribution from full quad-years (to count in the normal
3543 * leap days), plus the leftover contribution from any non-leap years.
3544 * At this point, if we were working with an actual leap day, we'll have 0
3545 * days left over. This is also true for March 1st, however. So, we have
3546 * to special-case that result, and (earlier) keep track of the 'odd'
3547 * century and year contributions. If we got 4 extra centuries in a qcent,
3548 * or 4 extra years in a qyear, then it's a leap day and we call it 29 Feb.
3549 * Otherwise, we add back in the earlier bias we removed (the 123 from
3550 * figuring in March 1st), find the month index (integer division by 30.6),
3551 * and the remainder is the day-of-month. We then have to convert back to
3552 * 'real' months (including fixing January and February from being 14/15 in
3553 * the previous year to being in the proper year). After that, to get
3554 * tm_yday, we work with the normalised year and get a new yearday value for
3555 * January 1st, which we subtract from the yearday value we had earlier,
3556 * representing the date we've re-built. This is done from January 1
3557 * because tm_yday is 0-origin.
3559 * Since POSIX time routines are only guaranteed to work for times since the
3560 * UNIX epoch (00:00:00 1 Jan 1970 UTC), the fact that this algorithm
3561 * applies Gregorian calendar rules even to dates before the 16th century
3562 * doesn't bother me. Besides, you'd need cultural context for a given
3563 * date to know whether it was Julian or Gregorian calendar, and that's
3564 * outside the scope for this routine. Since we convert back based on the
3565 * same rules we used to build the yearday, you'll only get strange results
3566 * for input which needed normalising, or for the 'odd' century years which
3567 * were leap years in the Julian calendar but not in the Gregorian one.
3568 * I can live with that.
3570 * This algorithm also fails to handle years before A.D. 1 gracefully, but
3571 * that's still outside the scope for POSIX time manipulation, so I don't
3575 year = 1900 + ptm->tm_year;
3576 month = ptm->tm_mon;
3577 mday = ptm->tm_mday;
3583 yearday = DAYS_PER_YEAR * year + year/4 - year/100 + year/400;
3584 yearday += month*MONTH_TO_DAYS + mday + jday;
3586 * Note that we don't know when leap-seconds were or will be,
3587 * so we have to trust the user if we get something which looks
3588 * like a sensible leap-second. Wild values for seconds will
3589 * be rationalised, however.
3591 if ((unsigned) ptm->tm_sec <= 60) {
3598 secs += 60 * ptm->tm_min;
3599 secs += SECS_PER_HOUR * ptm->tm_hour;
3601 if (secs-(secs/SECS_PER_DAY*SECS_PER_DAY) < 0) {
3602 /* got negative remainder, but need positive time */
3603 /* back off an extra day to compensate */
3604 yearday += (secs/SECS_PER_DAY)-1;
3605 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY - 1);
3608 yearday += (secs/SECS_PER_DAY);
3609 secs -= SECS_PER_DAY * (secs/SECS_PER_DAY);
3612 else if (secs >= SECS_PER_DAY) {
3613 yearday += (secs/SECS_PER_DAY);
3614 secs %= SECS_PER_DAY;
3616 ptm->tm_hour = secs/SECS_PER_HOUR;
3617 secs %= SECS_PER_HOUR;
3618 ptm->tm_min = secs/60;
3620 ptm->tm_sec += secs;
3621 /* done with time of day effects */
3623 * The algorithm for yearday has (so far) left it high by 428.
3624 * To avoid mistaking a legitimate Feb 29 as Mar 1, we need to
3625 * bias it by 123 while trying to figure out what year it
3626 * really represents. Even with this tweak, the reverse
3627 * translation fails for years before A.D. 0001.
3628 * It would still fail for Feb 29, but we catch that one below.
3630 jday = yearday; /* save for later fixup vis-a-vis Jan 1 */
3631 yearday -= YEAR_ADJUST;
3632 year = (yearday / DAYS_PER_QCENT) * 400;
3633 yearday %= DAYS_PER_QCENT;
3634 odd_cent = yearday / DAYS_PER_CENT;
3635 year += odd_cent * 100;
3636 yearday %= DAYS_PER_CENT;
3637 year += (yearday / DAYS_PER_QYEAR) * 4;
3638 yearday %= DAYS_PER_QYEAR;
3639 odd_year = yearday / DAYS_PER_YEAR;
3641 yearday %= DAYS_PER_YEAR;
3642 if (!yearday && (odd_cent==4 || odd_year==4)) { /* catch Feb 29 */
3647 yearday += YEAR_ADJUST; /* recover March 1st crock */
3648 month = yearday*DAYS_TO_MONTH;
3649 yearday -= month*MONTH_TO_DAYS;
3650 /* recover other leap-year adjustment */
3659 ptm->tm_year = year - 1900;
3661 ptm->tm_mday = yearday;
3662 ptm->tm_mon = month;
3666 ptm->tm_mon = month - 1;
3668 /* re-build yearday based on Jan 1 to get tm_yday */
3670 yearday = year*DAYS_PER_YEAR + year/4 - year/100 + year/400;
3671 yearday += 14*MONTH_TO_DAYS + 1;
3672 ptm->tm_yday = jday - yearday;
3673 ptm->tm_wday = (jday + WEEKDAY_BIAS) % 7;
3677 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)
3685 PERL_ARGS_ASSERT_MY_STRFTIME;
3687 init_tm(&mytm); /* XXX workaround - see init_tm() above */
3690 mytm.tm_hour = hour;
3691 mytm.tm_mday = mday;
3693 mytm.tm_year = year;
3694 mytm.tm_wday = wday;
3695 mytm.tm_yday = yday;
3696 mytm.tm_isdst = isdst;
3698 /* use libc to get the values for tm_gmtoff and tm_zone [perl #18238] */
3699 #if defined(HAS_MKTIME) && (defined(HAS_TM_TM_GMTOFF) || defined(HAS_TM_TM_ZONE))
3704 #ifdef HAS_TM_TM_GMTOFF
3705 mytm.tm_gmtoff = mytm2.tm_gmtoff;
3707 #ifdef HAS_TM_TM_ZONE
3708 mytm.tm_zone = mytm2.tm_zone;
3713 Newx(buf, buflen, char);
3714 len = strftime(buf, buflen, fmt, &mytm);
3716 ** The following is needed to handle to the situation where
3717 ** tmpbuf overflows. Basically we want to allocate a buffer
3718 ** and try repeatedly. The reason why it is so complicated
3719 ** is that getting a return value of 0 from strftime can indicate
3720 ** one of the following:
3721 ** 1. buffer overflowed,
3722 ** 2. illegal conversion specifier, or
3723 ** 3. the format string specifies nothing to be returned(not
3724 ** an error). This could be because format is an empty string
3725 ** or it specifies %p that yields an empty string in some locale.
3726 ** If there is a better way to make it portable, go ahead by
3729 if ((len > 0 && len < buflen) || (len == 0 && *fmt == '\0'))
3732 /* Possibly buf overflowed - try again with a bigger buf */
3733 const int fmtlen = strlen(fmt);
3734 int bufsize = fmtlen + buflen;
3736 Renew(buf, bufsize, char);
3738 buflen = strftime(buf, bufsize, fmt, &mytm);
3739 if (buflen > 0 && buflen < bufsize)
3741 /* heuristic to prevent out-of-memory errors */
3742 if (bufsize > 100*fmtlen) {
3748 Renew(buf, bufsize, char);
3753 Perl_croak(aTHX_ "panic: no strftime");
3759 #define SV_CWD_RETURN_UNDEF \
3760 sv_setsv(sv, &PL_sv_undef); \
3763 #define SV_CWD_ISDOT(dp) \
3764 (dp->d_name[0] == '.' && (dp->d_name[1] == '\0' || \
3765 (dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
3768 =head1 Miscellaneous Functions
3770 =for apidoc getcwd_sv
3772 Fill the sv with current working directory
3777 /* Originally written in Perl by John Bazik; rewritten in C by Ben Sugars.
3778 * rewritten again by dougm, optimized for use with xs TARG, and to prefer
3779 * getcwd(3) if available
3780 * Comments from the orignal:
3781 * This is a faster version of getcwd. It's also more dangerous
3782 * because you might chdir out of a directory that you can't chdir
3786 Perl_getcwd_sv(pTHX_ SV *sv)
3790 #ifndef INCOMPLETE_TAINTS
3794 PERL_ARGS_ASSERT_GETCWD_SV;
3798 char buf[MAXPATHLEN];
3800 /* Some getcwd()s automatically allocate a buffer of the given
3801 * size from the heap if they are given a NULL buffer pointer.
3802 * The problem is that this behaviour is not portable. */
3803 if (getcwd(buf, sizeof(buf) - 1)) {
3808 sv_setsv(sv, &PL_sv_undef);
3816 int orig_cdev, orig_cino, cdev, cino, odev, oino, tdev, tino;
3820 SvUPGRADE(sv, SVt_PV);
3822 if (PerlLIO_lstat(".", &statbuf) < 0) {
3823 SV_CWD_RETURN_UNDEF;
3826 orig_cdev = statbuf.st_dev;
3827 orig_cino = statbuf.st_ino;
3837 if (PerlDir_chdir("..") < 0) {
3838 SV_CWD_RETURN_UNDEF;
3840 if (PerlLIO_stat(".", &statbuf) < 0) {
3841 SV_CWD_RETURN_UNDEF;
3844 cdev = statbuf.st_dev;
3845 cino = statbuf.st_ino;
3847 if (odev == cdev && oino == cino) {
3850 if (!(dir = PerlDir_open("."))) {
3851 SV_CWD_RETURN_UNDEF;
3854 while ((dp = PerlDir_read(dir)) != NULL) {
3856 namelen = dp->d_namlen;
3858 namelen = strlen(dp->d_name);
3861 if (SV_CWD_ISDOT(dp)) {
3865 if (PerlLIO_lstat(dp->d_name, &statbuf) < 0) {
3866 SV_CWD_RETURN_UNDEF;
3869 tdev = statbuf.st_dev;
3870 tino = statbuf.st_ino;
3871 if (tino == oino && tdev == odev) {
3877 SV_CWD_RETURN_UNDEF;
3880 if (pathlen + namelen + 1 >= MAXPATHLEN) {
3881 SV_CWD_RETURN_UNDEF;
3884 SvGROW(sv, pathlen + namelen + 1);
3888 Move(SvPVX_const(sv), SvPVX(sv) + namelen + 1, pathlen, char);
3891 /* prepend current directory to the front */
3893 Move(dp->d_name, SvPVX(sv)+1, namelen, char);
3894 pathlen += (namelen + 1);
3896 #ifdef VOID_CLOSEDIR
3899 if (PerlDir_close(dir) < 0) {
3900 SV_CWD_RETURN_UNDEF;
3906 SvCUR_set(sv, pathlen);
3910 if (PerlDir_chdir(SvPVX_const(sv)) < 0) {
3911 SV_CWD_RETURN_UNDEF;
3914 if (PerlLIO_stat(".", &statbuf) < 0) {
3915 SV_CWD_RETURN_UNDEF;
3918 cdev = statbuf.st_dev;
3919 cino = statbuf.st_ino;
3921 if (cdev != orig_cdev || cino != orig_cino) {
3922 Perl_croak(aTHX_ "Unstable directory path, "
3923 "current directory changed unexpectedly");
3934 #define VERSION_MAX 0x7FFFFFFF
3937 =for apidoc prescan_version
3939 Validate that a given string can be parsed as a version object, but doesn't
3940 actually perform the parsing. Can use either strict or lax validation rules.
3941 Can optionally set a number of hint variables to save the parsing code
3942 some time when tokenizing.
3947 Perl_prescan_version(pTHX_ const char *s, bool strict,
3948 const char **errstr,
3949 bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
3950 bool qv = (sqv ? *sqv : FALSE);
3952 int saw_decimal = 0;
3956 PERL_ARGS_ASSERT_PRESCAN_VERSION;
3958 if (qv && isDIGIT(*d))
3959 goto dotted_decimal_version;
3961 if (*d == 'v') { /* explicit v-string */
3966 else { /* degenerate v-string */
3967 /* requires v1.2.3 */
3968 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
3971 dotted_decimal_version:
3972 if (strict && d[0] == '0' && isDIGIT(d[1])) {
3973 /* no leading zeros allowed */
3974 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
3977 while (isDIGIT(*d)) /* integer part */
3983 d++; /* decimal point */
3988 /* require v1.2.3 */
3989 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
3992 goto version_prescan_finish;
3999 while (isDIGIT(*d)) { /* just keep reading */
4001 while (isDIGIT(*d)) {
4003 /* maximum 3 digits between decimal */
4004 if (strict && j > 3) {
4005 BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
4010 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4013 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4018 else if (*d == '.') {
4020 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4025 else if (!isDIGIT(*d)) {
4031 if (strict && i < 2) {
4032 /* requires v1.2.3 */
4033 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
4036 } /* end if dotted-decimal */
4038 { /* decimal versions */
4039 int j = 0; /* may need this later */
4040 /* special strict case for leading '.' or '0' */
4043 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
4045 if (*d == '0' && isDIGIT(d[1])) {
4046 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
4050 /* and we never support negative versions */
4052 BADVERSION(s,errstr,"Invalid version format (negative version number)");
4055 /* consume all of the integer part */
4059 /* look for a fractional part */
4061 /* we found it, so consume it */
4065 else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
4068 BADVERSION(s,errstr,"Invalid version format (version required)");
4070 /* found just an integer */
4071 goto version_prescan_finish;
4073 else if ( d == s ) {
4074 /* didn't find either integer or period */
4075 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4077 else if (*d == '_') {
4078 /* underscore can't come after integer part */
4080 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4082 else if (isDIGIT(d[1])) {
4083 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
4086 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4090 /* anything else after integer part is just invalid data */
4091 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4094 /* scan the fractional part after the decimal point*/
4096 if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
4097 /* strict or lax-but-not-the-end */
4098 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
4101 while (isDIGIT(*d)) {
4103 if (*d == '.' && isDIGIT(d[-1])) {
4105 BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
4108 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
4110 d = (char *)s; /* start all over again */
4112 goto dotted_decimal_version;
4116 BADVERSION(s,errstr,"Invalid version format (no underscores)");
4119 BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
4121 if ( ! isDIGIT(d[1]) ) {
4122 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
4131 version_prescan_finish:
4135 if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
4136 /* trailing non-numeric data */
4137 BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
4145 *ssaw_decimal = saw_decimal;
4152 =for apidoc scan_version
4154 Returns a pointer to the next character after the parsed
4155 version string, as well as upgrading the passed in SV to
4158 Function must be called with an already existing SV like
4161 s = scan_version(s, SV *sv, bool qv);
4163 Performs some preprocessing to the string to ensure that
4164 it has the correct characteristics of a version. Flags the
4165 object if it contains an underscore (which denotes this
4166 is an alpha version). The boolean qv denotes that the version
4167 should be interpreted as if it had multiple decimals, even if
4174 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
4176 const char *start = s;
4179 const char *errstr = NULL;
4180 int saw_decimal = 0;
4187 PERL_ARGS_ASSERT_SCAN_VERSION;
4189 while (isSPACE(*s)) /* leading whitespace is OK */
4192 last = prescan_version(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
4194 /* "undef" is a special case and not an error */
4195 if ( ! ( *s == 'u' && strEQ(s,"undef")) ) {
4197 Perl_croak(aTHX_ "%s", errstr);
4206 /* Now that we are through the prescan, start creating the object */
4208 hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
4209 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4211 #ifndef NODEFAULT_SHAREKEYS
4212 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4216 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
4218 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
4219 if ( !qv && width < 3 )
4220 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4222 while (isDIGIT(*pos))
4224 if (!isALPHA(*pos)) {
4230 /* this is atoi() that delimits on underscores */
4231 const char *end = pos;
4235 /* the following if() will only be true after the decimal
4236 * point of a version originally created with a bare
4237 * floating point number, i.e. not quoted in any way
4239 if ( !qv && s > start && saw_decimal == 1 ) {
4243 rev += (*s - '0') * mult;
4245 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4246 || (PERL_ABS(rev) > VERSION_MAX )) {
4247 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4248 "Integer overflow in version %d",VERSION_MAX);
4259 while (--end >= s) {
4261 rev += (*end - '0') * mult;
4263 if ( (PERL_ABS(orev) > PERL_ABS(rev))
4264 || (PERL_ABS(rev) > VERSION_MAX )) {
4265 Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
4266 "Integer overflow in version");
4275 /* Append revision */
4276 av_push(av, newSViv(rev));
4281 else if ( *pos == '.' )
4283 else if ( *pos == '_' && isDIGIT(pos[1]) )
4285 else if ( *pos == ',' && isDIGIT(pos[1]) )
4287 else if ( isDIGIT(*pos) )
4294 while ( isDIGIT(*pos) )
4299 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
4307 if ( qv ) { /* quoted versions always get at least three terms*/
4308 I32 len = av_len(av);
4309 /* This for loop appears to trigger a compiler bug on OS X, as it
4310 loops infinitely. Yes, len is negative. No, it makes no sense.
4311 Compiler in question is:
4312 gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
4313 for ( len = 2 - len; len > 0; len-- )
4314 av_push(MUTABLE_AV(sv), newSViv(0));
4318 av_push(av, newSViv(0));
4321 /* need to save off the current version string for later */
4323 SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
4324 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4325 (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
4327 else if ( s > start ) {
4328 SV * orig = newSVpvn(start,s-start);
4329 if ( qv && saw_decimal == 1 && *start != 'v' ) {
4330 /* need to insert a v to be consistent */
4331 sv_insert(orig, 0, 0, "v", 1);
4333 (void)hv_stores(MUTABLE_HV(hv), "original", orig);
4336 (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
4337 av_push(av, newSViv(0));
4340 /* And finally, store the AV in the hash */
4341 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4343 /* fix RT#19517 - special case 'undef' as string */
4344 if ( *s == 'u' && strEQ(s,"undef") ) {
4352 =for apidoc new_version
4354 Returns a new version object based on the passed in SV:
4356 SV *sv = new_version(SV *ver);
4358 Does not alter the passed in ver SV. See "upg_version" if you
4359 want to upgrade the SV.
4365 Perl_new_version(pTHX_ SV *ver)
4368 SV * const rv = newSV(0);
4369 PERL_ARGS_ASSERT_NEW_VERSION;
4370 if ( sv_isobject(ver) && sv_derived_from(ver, "version") )
4371 /* can just copy directly */
4374 AV * const av = newAV();
4376 /* This will get reblessed later if a derived class*/
4377 SV * const hv = newSVrv(rv, "version");
4378 (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
4379 #ifndef NODEFAULT_SHAREKEYS
4380 HvSHAREKEYS_on(hv); /* key-sharing on by default */
4386 /* Begin copying all of the elements */
4387 if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
4388 (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
4390 if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
4391 (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
4393 if ( hv_exists(MUTABLE_HV(ver), "width", 5 ) )
4395 const I32 width = SvIV(*hv_fetchs(MUTABLE_HV(ver), "width", FALSE));
4396 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
4399 if ( hv_exists(MUTABLE_HV(ver), "original", 8 ) )
4401 SV * pv = *hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
4402 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(pv));
4405 sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
4406 /* This will get reblessed later if a derived class*/
4407 for ( key = 0; key <= av_len(sav); key++ )
4409 const I32 rev = SvIV(*av_fetch(sav, key, FALSE));
4410 av_push(av, newSViv(rev));
4413 (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
4418 const MAGIC* const mg = SvVSTRING_mg(ver);
4419 if ( mg ) { /* already a v-string */
4420 const STRLEN len = mg->mg_len;
4421 char * const version = savepvn( (const char*)mg->mg_ptr, len);
4422 sv_setpvn(rv,version,len);
4423 /* this is for consistency with the pure Perl class */
4424 if ( isDIGIT(*version) )
4425 sv_insert(rv, 0, 0, "v", 1);
4430 sv_setsv(rv,ver); /* make a duplicate */
4435 return upg_version(rv, FALSE);
4439 =for apidoc upg_version
4441 In-place upgrade of the supplied SV to a version object.
4443 SV *sv = upg_version(SV *sv, bool qv);
4445 Returns a pointer to the upgraded SV. Set the boolean qv if you want
4446 to force this SV to be interpreted as an "extended" version.
4452 Perl_upg_version(pTHX_ SV *ver, bool qv)
4454 const char *version, *s;
4459 PERL_ARGS_ASSERT_UPG_VERSION;
4461 if ( SvNOK(ver) && !( SvPOK(ver) && sv_len(ver) == 3 ) )
4465 /* may get too much accuracy */
4467 SV *sv = SvNVX(ver) > 10e50 ? newSV(64) : 0;
4469 #ifdef USE_LOCALE_NUMERIC
4470 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
4471 setlocale(LC_NUMERIC, "C");
4474 Perl_sv_setpvf(aTHX_ sv, "%.9"NVff, SvNVX(ver));
4475 buf = SvPV(sv, len);
4478 len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVff, SvNVX(ver));
4481 #ifdef USE_LOCALE_NUMERIC
4482 setlocale(LC_NUMERIC, loc);
4485 while (buf[len-1] == '0' && len > 0) len--;
4486 if ( buf[len-1] == '.' ) len--; /* eat the trailing decimal */
4487 version = savepvn(buf, len);
4491 else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
4492 version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
4496 else /* must be a string or something like a string */
4499 version = savepv(SvPV(ver,len));
4501 # if PERL_VERSION > 5
4502 /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
4503 if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
4504 /* may be a v-string */
4505 char *testv = (char *)version;
4507 for (tlen=0; tlen < len; tlen++, testv++) {
4508 /* if one of the characters is non-text assume v-string */
4509 if (testv[0] < ' ') {
4510 SV * const nsv = sv_newmortal();
4513 int saw_decimal = 0;
4514 sv_setpvf(nsv,"v%vd",ver);
4515 pos = nver = savepv(SvPV_nolen(nsv));
4517 /* scan the resulting formatted string */
4518 pos++; /* skip the leading 'v' */
4519 while ( *pos == '.' || isDIGIT(*pos) ) {
4525 /* is definitely a v-string */
4526 if ( saw_decimal >= 2 ) {
4538 s = scan_version(version, ver, qv);
4540 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4541 "Version string '%s' contains invalid data; "
4542 "ignoring: '%s'", version, s);
4550 Validates that the SV contains valid internal structure for a version object.
4551 It may be passed either the version object (RV) or the hash itself (HV). If
4552 the structure is valid, it returns the HV. If the structure is invalid,
4555 SV *hv = vverify(sv);
4557 Note that it only confirms the bare minimum structure (so as not to get
4558 confused by derived classes which may contain additional hash entries):
4562 =item * The SV is an HV or a reference to an HV
4564 =item * The hash contains a "version" key
4566 =item * The "version" key has a reference to an AV as its value
4574 Perl_vverify(pTHX_ SV *vs)
4578 PERL_ARGS_ASSERT_VVERIFY;
4583 /* see if the appropriate elements exist */
4584 if ( SvTYPE(vs) == SVt_PVHV
4585 && hv_exists(MUTABLE_HV(vs), "version", 7)
4586 && (sv = SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)))
4587 && SvTYPE(sv) == SVt_PVAV )
4596 Accepts a version object and returns the normalized floating
4597 point representation. Call like:
4601 NOTE: you can pass either the object directly or the SV
4602 contained within the RV.
4604 The SV returned has a refcount of 1.
4610 Perl_vnumify(pTHX_ SV *vs)
4618 PERL_ARGS_ASSERT_VNUMIFY;
4620 /* extract the HV from the object */
4623 Perl_croak(aTHX_ "Invalid version object");
4625 /* see if various flags exist */
4626 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
4628 if ( hv_exists(MUTABLE_HV(vs), "width", 5 ) )
4629 width = SvIV(*hv_fetchs(MUTABLE_HV(vs), "width", FALSE));
4634 /* attempt to retrieve the version array */
4635 if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
4636 return newSVpvs("0");
4642 return newSVpvs("0");
4645 digit = SvIV(*av_fetch(av, 0, 0));
4646 sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
4647 for ( i = 1 ; i < len ; i++ )
4649 digit = SvIV(*av_fetch(av, i, 0));
4651 const int denom = (width == 2 ? 10 : 100);
4652 const div_t term = div((int)PERL_ABS(digit),denom);
4653 Perl_sv_catpvf(aTHX_ sv, "%0*d_%d", width, term.quot, term.rem);
4656 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
4662 digit = SvIV(*av_fetch(av, len, 0));
4663 if ( alpha && width == 3 ) /* alpha version */
4665 Perl_sv_catpvf(aTHX_ sv, "%0*d", width, (int)digit);
4669 sv_catpvs(sv, "000");
4677 Accepts a version object and returns the normalized string
4678 representation. Call like:
4682 NOTE: you can pass either the object directly or the SV
4683 contained within the RV.
4685 The SV returned has a refcount of 1.
4691 Perl_vnormal(pTHX_ SV *vs)
4698 PERL_ARGS_ASSERT_VNORMAL;
4700 /* extract the HV from the object */
4703 Perl_croak(aTHX_ "Invalid version object");
4705 if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
4707 av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
4712 return newSVpvs("");
4714 digit = SvIV(*av_fetch(av, 0, 0));
4715 sv = Perl_newSVpvf(aTHX_ "v%"IVdf, (IV)digit);
4716 for ( i = 1 ; i < len ; i++ ) {
4717 digit = SvIV(*av_fetch(av, i, 0));
4718 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
4723 /* handle last digit specially */
4724 digit = SvIV(*av_fetch(av, len, 0));
4726 Perl_sv_catpvf(aTHX_ sv, "_%"IVdf, (IV)digit);
4728 Perl_sv_catpvf(aTHX_ sv, ".%"IVdf, (IV)digit);
4731 if ( len <= 2 ) { /* short version, must be at least three */
4732 for ( len = 2 - len; len != 0; len-- )
4739 =for apidoc vstringify
4741 In order to maintain maximum compatibility with earlier versions
4742 of Perl, this function will return either the floating point
4743 notation or the multiple dotted notation, depending on whether
4744 the original version contained 1 or more dots, respectively.
4746 The SV returned has a refcount of 1.
4752 Perl_vstringify(pTHX_ SV *vs)
4754 PERL_ARGS_ASSERT_VSTRINGIFY;
4756 /* extract the HV from the object */
4759 Perl_croak(aTHX_ "Invalid version object");
4761 if (hv_exists(MUTABLE_HV(vs), "original", sizeof("original") - 1)) {
4763 pv = *hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
4767 return &PL_sv_undef;
4770 if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
4780 Version object aware cmp. Both operands must already have been
4781 converted into version objects.
4787 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
4790 bool lalpha = FALSE;
4791 bool ralpha = FALSE;
4796 PERL_ARGS_ASSERT_VCMP;
4798 /* extract the HVs from the objects */
4801 if ( ! ( lhv && rhv ) )
4802 Perl_croak(aTHX_ "Invalid version object");
4804 /* get the left hand term */
4805 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
4806 if ( hv_exists(MUTABLE_HV(lhv), "alpha", 5 ) )
4809 /* and the right hand term */
4810 rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
4811 if ( hv_exists(MUTABLE_HV(rhv), "alpha", 5 ) )
4819 while ( i <= m && retval == 0 )
4821 left = SvIV(*av_fetch(lav,i,0));
4822 right = SvIV(*av_fetch(rav,i,0));
4830 /* tiebreaker for alpha with identical terms */
4831 if ( retval == 0 && l == r && left == right && ( lalpha || ralpha ) )
4833 if ( lalpha && !ralpha )
4837 else if ( ralpha && !lalpha)
4843 if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
4847 while ( i <= r && retval == 0 )
4849 if ( SvIV(*av_fetch(rav,i,0)) != 0 )
4850 retval = -1; /* not a match after all */
4856 while ( i <= l && retval == 0 )
4858 if ( SvIV(*av_fetch(lav,i,0)) != 0 )
4859 retval = +1; /* not a match after all */
4867 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET) && defined(SOCK_DGRAM) && defined(HAS_SELECT)
4868 # define EMULATE_SOCKETPAIR_UDP
4871 #ifdef EMULATE_SOCKETPAIR_UDP
4873 S_socketpair_udp (int fd[2]) {
4875 /* Fake a datagram socketpair using UDP to localhost. */
4876 int sockets[2] = {-1, -1};
4877 struct sockaddr_in addresses[2];
4879 Sock_size_t size = sizeof(struct sockaddr_in);
4880 unsigned short port;
4883 memset(&addresses, 0, sizeof(addresses));
4886 sockets[i] = PerlSock_socket(AF_INET, SOCK_DGRAM, PF_INET);
4887 if (sockets[i] == -1)
4888 goto tidy_up_and_fail;
4890 addresses[i].sin_family = AF_INET;
4891 addresses[i].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
4892 addresses[i].sin_port = 0; /* kernel choses port. */
4893 if (PerlSock_bind(sockets[i], (struct sockaddr *) &addresses[i],
4894 sizeof(struct sockaddr_in)) == -1)
4895 goto tidy_up_and_fail;
4898 /* Now have 2 UDP sockets. Find out which port each is connected to, and
4899 for each connect the other socket to it. */
4902 if (PerlSock_getsockname(sockets[i], (struct sockaddr *) &addresses[i],
4904 goto tidy_up_and_fail;
4905 if (size != sizeof(struct sockaddr_in))
4906 goto abort_tidy_up_and_fail;
4907 /* !1 is 0, !0 is 1 */
4908 if (PerlSock_connect(sockets[!i], (struct sockaddr *) &addresses[i],
4909 sizeof(struct sockaddr_in)) == -1)
4910 goto tidy_up_and_fail;
4913 /* Now we have 2 sockets connected to each other. I don't trust some other
4914 process not to have already sent a packet to us (by random) so send
4915 a packet from each to the other. */
4918 /* I'm going to send my own port number. As a short.
4919 (Who knows if someone somewhere has sin_port as a bitfield and needs
4920 this routine. (I'm assuming crays have socketpair)) */
4921 port = addresses[i].sin_port;
4922 got = PerlLIO_write(sockets[i], &port, sizeof(port));
4923 if (got != sizeof(port)) {
4925 goto tidy_up_and_fail;
4926 goto abort_tidy_up_and_fail;
4930 /* Packets sent. I don't trust them to have arrived though.
4931 (As I understand it Solaris TCP stack is multithreaded. Non-blocking
4932 connect to localhost will use a second kernel thread. In 2.6 the
4933 first thread running the connect() returns before the second completes,
4934 so EINPROGRESS> In 2.7 the improved stack is faster and connect()
4935 returns 0. Poor programs have tripped up. One poor program's authors'
4936 had a 50-1 reverse stock split. Not sure how connected these were.)
4937 So I don't trust someone not to have an unpredictable UDP stack.
4941 struct timeval waitfor = {0, 100000}; /* You have 0.1 seconds */
4942 int max = sockets[1] > sockets[0] ? sockets[1] : sockets[0];
4946 FD_SET((unsigned int)sockets[0], &rset);
4947 FD_SET((unsigned int)sockets[1], &rset);
4949 got = PerlSock_select(max + 1, &rset, NULL, NULL, &waitfor);
4950 if (got != 2 || !FD_ISSET(sockets[0], &rset)
4951 || !FD_ISSET(sockets[1], &rset)) {
4952 /* I hope this is portable and appropriate. */
4954 goto tidy_up_and_fail;
4955 goto abort_tidy_up_and_fail;
4959 /* And the paranoia department even now doesn't trust it to have arrive
4960 (hence MSG_DONTWAIT). Or that what arrives was sent by us. */
4962 struct sockaddr_in readfrom;
4963 unsigned short buffer[2];
4968 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4969 sizeof(buffer), MSG_DONTWAIT,
4970 (struct sockaddr *) &readfrom, &size);
4972 got = PerlSock_recvfrom(sockets[i], (char *) &buffer,
4974 (struct sockaddr *) &readfrom, &size);
4978 goto tidy_up_and_fail;
4979 if (got != sizeof(port)
4980 || size != sizeof(struct sockaddr_in)
4981 /* Check other socket sent us its port. */
4982 || buffer[0] != (unsigned short) addresses[!i].sin_port
4983 /* Check kernel says we got the datagram from that socket */
4984 || readfrom.sin_family != addresses[!i].sin_family
4985 || readfrom.sin_addr.s_addr != addresses[!i].sin_addr.s_addr
4986 || readfrom.sin_port != addresses[!i].sin_port)
4987 goto abort_tidy_up_and_fail;
4990 /* My caller (my_socketpair) has validated that this is non-NULL */
4993 /* I hereby declare this connection open. May God bless all who cross
4997 abort_tidy_up_and_fail:
4998 errno = ECONNABORTED;
5002 if (sockets[0] != -1)
5003 PerlLIO_close(sockets[0]);
5004 if (sockets[1] != -1)
5005 PerlLIO_close(sockets[1]);
5010 #endif /* EMULATE_SOCKETPAIR_UDP */
5012 #if !defined(HAS_SOCKETPAIR) && defined(HAS_SOCKET) && defined(AF_INET) && defined(PF_INET)
5014 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5015 /* Stevens says that family must be AF_LOCAL, protocol 0.
5016 I'm going to enforce that, then ignore it, and use TCP (or UDP). */
5021 struct sockaddr_in listen_addr;
5022 struct sockaddr_in connect_addr;
5027 || family != AF_UNIX
5030 errno = EAFNOSUPPORT;
5038 #ifdef EMULATE_SOCKETPAIR_UDP
5039 if (type == SOCK_DGRAM)
5040 return S_socketpair_udp(fd);
5043 aTHXa(PERL_GET_THX);
5044 listener = PerlSock_socket(AF_INET, type, 0);
5047 memset(&listen_addr, 0, sizeof(listen_addr));
5048 listen_addr.sin_family = AF_INET;
5049 listen_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
5050 listen_addr.sin_port = 0; /* kernel choses port. */
5051 if (PerlSock_bind(listener, (struct sockaddr *) &listen_addr,
5052 sizeof(listen_addr)) == -1)
5053 goto tidy_up_and_fail;
5054 if (PerlSock_listen(listener, 1) == -1)
5055 goto tidy_up_and_fail;
5057 connector = PerlSock_socket(AF_INET, type, 0);
5058 if (connector == -1)
5059 goto tidy_up_and_fail;
5060 /* We want to find out the port number to connect to. */
5061 size = sizeof(connect_addr);
5062 if (PerlSock_getsockname(listener, (struct sockaddr *) &connect_addr,
5064 goto tidy_up_and_fail;
5065 if (size != sizeof(connect_addr))
5066 goto abort_tidy_up_and_fail;
5067 if (PerlSock_connect(connector, (struct sockaddr *) &connect_addr,
5068 sizeof(connect_addr)) == -1)
5069 goto tidy_up_and_fail;
5071 size = sizeof(listen_addr);
5072 acceptor = PerlSock_accept(listener, (struct sockaddr *) &listen_addr,
5075 goto tidy_up_and_fail;
5076 if (size != sizeof(listen_addr))
5077 goto abort_tidy_up_and_fail;
5078 PerlLIO_close(listener);
5079 /* Now check we are talking to ourself by matching port and host on the
5081 if (PerlSock_getsockname(connector, (struct sockaddr *) &connect_addr,
5083 goto tidy_up_and_fail;
5084 if (size != sizeof(connect_addr)
5085 || listen_addr.sin_family != connect_addr.sin_family
5086 || listen_addr.sin_addr.s_addr != connect_addr.sin_addr.s_addr
5087 || listen_addr.sin_port != connect_addr.sin_port) {
5088 goto abort_tidy_up_and_fail;
5094 abort_tidy_up_and_fail:
5096 errno = ECONNABORTED; /* This would be the standard thing to do. */
5098 # ifdef ECONNREFUSED
5099 errno = ECONNREFUSED; /* E.g. Symbian does not have ECONNABORTED. */
5101 errno = ETIMEDOUT; /* Desperation time. */
5108 PerlLIO_close(listener);
5109 if (connector != -1)
5110 PerlLIO_close(connector);
5112 PerlLIO_close(acceptor);
5118 /* In any case have a stub so that there's code corresponding
5119 * to the my_socketpair in embed.fnc. */
5121 Perl_my_socketpair (int family, int type, int protocol, int fd[2]) {
5122 #ifdef HAS_SOCKETPAIR
5123 return socketpair(family, type, protocol, fd);
5132 =for apidoc sv_nosharing
5134 Dummy routine which "shares" an SV when there is no sharing module present.
5135 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
5136 Exists to avoid test for a NULL function pointer and because it could
5137 potentially warn under some level of strict-ness.
5143 Perl_sv_nosharing(pTHX_ SV *sv)
5145 PERL_UNUSED_CONTEXT;
5146 PERL_UNUSED_ARG(sv);
5151 =for apidoc sv_destroyable
5153 Dummy routine which reports that object can be destroyed when there is no
5154 sharing module present. It ignores its single SV argument, and returns
5155 'true'. Exists to avoid test for a NULL function pointer and because it
5156 could potentially warn under some level of strict-ness.
5162 Perl_sv_destroyable(pTHX_ SV *sv)
5164 PERL_UNUSED_CONTEXT;
5165 PERL_UNUSED_ARG(sv);
5170 Perl_parse_unicode_opts(pTHX_ const char **popt)
5172 const char *p = *popt;
5175 PERL_ARGS_ASSERT_PARSE_UNICODE_OPTS;
5179 opt = (U32) atoi(p);
5182 if (*p && *p != '\n' && *p != '\r') {
5183 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5185 Perl_croak(aTHX_ "Unknown Unicode option letter '%c'", *p);
5191 case PERL_UNICODE_STDIN:
5192 opt |= PERL_UNICODE_STDIN_FLAG; break;
5193 case PERL_UNICODE_STDOUT:
5194 opt |= PERL_UNICODE_STDOUT_FLAG; break;
5195 case PERL_UNICODE_STDERR:
5196 opt |= PERL_UNICODE_STDERR_FLAG; break;
5197 case PERL_UNICODE_STD:
5198 opt |= PERL_UNICODE_STD_FLAG; break;
5199 case PERL_UNICODE_IN:
5200 opt |= PERL_UNICODE_IN_FLAG; break;
5201 case PERL_UNICODE_OUT:
5202 opt |= PERL_UNICODE_OUT_FLAG; break;
5203 case PERL_UNICODE_INOUT:
5204 opt |= PERL_UNICODE_INOUT_FLAG; break;
5205 case PERL_UNICODE_LOCALE:
5206 opt |= PERL_UNICODE_LOCALE_FLAG; break;
5207 case PERL_UNICODE_ARGV:
5208 opt |= PERL_UNICODE_ARGV_FLAG; break;
5209 case PERL_UNICODE_UTF8CACHEASSERT:
5210 opt |= PERL_UNICODE_UTF8CACHEASSERT_FLAG; break;
5212 if (*p != '\n' && *p != '\r') {
5213 if(isSPACE(*p)) goto the_end_of_the_opts_parser;
5216 "Unknown Unicode option letter '%c'", *p);
5223 opt = PERL_UNICODE_DEFAULT_FLAGS;
5225 the_end_of_the_opts_parser:
5227 if (opt & ~PERL_UNICODE_ALL_FLAGS)
5228 Perl_croak(aTHX_ "Unknown Unicode option value %"UVuf,
5229 (UV) (opt & ~PERL_UNICODE_ALL_FLAGS));
5237 # include <starlet.h>
5245 * This is really just a quick hack which grabs various garbage
5246 * values. It really should be a real hash algorithm which
5247 * spreads the effect of every input bit onto every output bit,
5248 * if someone who knows about such things would bother to write it.
5249 * Might be a good idea to add that function to CORE as well.
5250 * No numbers below come from careful analysis or anything here,
5251 * except they are primes and SEED_C1 > 1E6 to get a full-width
5252 * value from (tv_sec * SEED_C1 + tv_usec). The multipliers should
5253 * probably be bigger too.
5256 # define SEED_C1 1000003
5257 #define SEED_C4 73819
5259 # define SEED_C1 25747
5260 #define SEED_C4 20639
5264 #define SEED_C5 26107
5266 #ifndef PERL_NO_DEV_RANDOM
5271 /* when[] = (low 32 bits, high 32 bits) of time since epoch
5272 * in 100-ns units, typically incremented ever 10 ms. */
5273 unsigned int when[2];
5275 # ifdef HAS_GETTIMEOFDAY
5276 struct timeval when;
5282 /* This test is an escape hatch, this symbol isn't set by Configure. */
5283 #ifndef PERL_NO_DEV_RANDOM
5284 #ifndef PERL_RANDOM_DEVICE
5285 /* /dev/random isn't used by default because reads from it will block
5286 * if there isn't enough entropy available. You can compile with
5287 * PERL_RANDOM_DEVICE to it if you'd prefer Perl to block until there
5288 * is enough real entropy to fill the seed. */
5289 # define PERL_RANDOM_DEVICE "/dev/urandom"
5291 fd = PerlLIO_open(PERL_RANDOM_DEVICE, 0);
5293 if (PerlLIO_read(fd, (void*)&u, sizeof u) != sizeof u)
5302 _ckvmssts(sys$gettim(when));
5303 u = (U32)SEED_C1 * when[0] + (U32)SEED_C2 * when[1];
5305 # ifdef HAS_GETTIMEOFDAY
5306 PerlProc_gettimeofday(&when,NULL);
5307 u = (U32)SEED_C1 * when.tv_sec + (U32)SEED_C2 * when.tv_usec;
5310 u = (U32)SEED_C1 * when;
5313 u += SEED_C3 * (U32)PerlProc_getpid();
5314 u += SEED_C4 * (U32)PTR2UV(PL_stack_sp);
5315 #ifndef PLAN9 /* XXX Plan9 assembler chokes on this; fix needed */
5316 u += SEED_C5 * (U32)PTR2UV(&when);
5322 Perl_get_hash_seed(pTHX_ unsigned char * const seed_buffer)
5328 PERL_ARGS_ASSERT_GET_HASH_SEED;
5330 env_pv= PerlEnv_getenv("PERL_HASH_SEED");
5333 #ifndef USE_HASH_SEED_EXPLICIT
5335 /* ignore leading spaces */
5336 while (isSPACE(*env_pv))
5338 #ifdef USE_PERL_PERTURB_KEYS
5339 /* if they set it to "0" we disable key traversal randomization completely */
5340 if (strEQ(env_pv,"0")) {
5341 PL_hash_rand_bits_enabled= 0;
5343 /* otherwise switch to deterministic mode */
5344 PL_hash_rand_bits_enabled= 2;
5347 /* ignore a leading 0x... if it is there */
5348 if (env_pv[0] == '0' && env_pv[1] == 'x')
5351 for( i = 0; isXDIGIT(*env_pv) && i < PERL_HASH_SEED_BYTES; i++ ) {
5352 seed_buffer[i] = READ_XDIGIT(env_pv) << 4;
5353 if ( isXDIGIT(*env_pv)) {
5354 seed_buffer[i] |= READ_XDIGIT(env_pv);
5357 while (isSPACE(*env_pv))
5360 if (*env_pv && !isXDIGIT(*env_pv)) {
5361 Perl_warn(aTHX_ "perl: warning: Non hex character in '$ENV{PERL_HASH_SEED}', seed only partially set\n");
5363 /* should we check for unparsed crap? */
5364 /* should we warn about unused hex? */
5365 /* should we warn about insufficient hex? */
5370 (void)seedDrand01((Rand_seed_t)seed());
5372 for( i = 0; i < PERL_HASH_SEED_BYTES; i++ ) {
5373 seed_buffer[i] = (unsigned char)(Drand01() * (U8_MAX+1));
5376 #ifdef USE_PERL_PERTURB_KEYS
5377 { /* initialize PL_hash_rand_bits from the hash seed.
5378 * This value is highly volatile, it is updated every
5379 * hash insert, and is used as part of hash bucket chain
5380 * randomization and hash iterator randomization. */
5381 PL_hash_rand_bits= 0xbe49d17f; /* I just picked a number */
5382 for( i = 0; i < sizeof(UV) ; i++ ) {
5383 PL_hash_rand_bits += seed_buffer[i % PERL_HASH_SEED_BYTES];
5384 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,8);
5387 env_pv= PerlEnv_getenv("PERL_PERTURB_KEYS");
5389 if (strEQ(env_pv,"0") || strEQ(env_pv,"NO")) {
5390 PL_hash_rand_bits_enabled= 0;
5391 } else if (strEQ(env_pv,"1") || strEQ(env_pv,"RANDOM")) {
5392 PL_hash_rand_bits_enabled= 1;
5393 } else if (strEQ(env_pv,"2") || strEQ(env_pv,"DETERMINISTIC")) {
5394 PL_hash_rand_bits_enabled= 2;
5396 Perl_warn(aTHX_ "perl: warning: strange setting in '$ENV{PERL_PERTURB_KEYS}': '%s'\n", env_pv);
5402 #ifdef PERL_GLOBAL_STRUCT
5404 #define PERL_GLOBAL_STRUCT_INIT
5405 #include "opcode.h" /* the ppaddr and check */
5408 Perl_init_global_struct(pTHX)
5410 struct perl_vars *plvarsp = NULL;
5411 # ifdef PERL_GLOBAL_STRUCT
5412 const IV nppaddr = sizeof(Gppaddr)/sizeof(Perl_ppaddr_t);
5413 const IV ncheck = sizeof(Gcheck) /sizeof(Perl_check_t);
5414 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5415 /* PerlMem_malloc() because can't use even safesysmalloc() this early. */
5416 plvarsp = (struct perl_vars*)PerlMem_malloc(sizeof(struct perl_vars));
5420 plvarsp = PL_VarsPtr;
5421 # endif /* PERL_GLOBAL_STRUCT_PRIVATE */
5426 # define PERLVAR(prefix,var,type) /**/
5427 # define PERLVARA(prefix,var,n,type) /**/
5428 # define PERLVARI(prefix,var,type,init) plvarsp->prefix##var = init;
5429 # define PERLVARIC(prefix,var,type,init) plvarsp->prefix##var = init;
5430 # include "perlvars.h"
5435 # ifdef PERL_GLOBAL_STRUCT
5438 PerlMem_malloc(nppaddr * sizeof(Perl_ppaddr_t));
5439 if (!plvarsp->Gppaddr)
5443 PerlMem_malloc(ncheck * sizeof(Perl_check_t));
5444 if (!plvarsp->Gcheck)
5446 Copy(Gppaddr, plvarsp->Gppaddr, nppaddr, Perl_ppaddr_t);
5447 Copy(Gcheck, plvarsp->Gcheck, ncheck, Perl_check_t);
5449 # ifdef PERL_SET_VARS
5450 PERL_SET_VARS(plvarsp);
5452 # undef PERL_GLOBAL_STRUCT_INIT
5457 #endif /* PERL_GLOBAL_STRUCT */
5459 #ifdef PERL_GLOBAL_STRUCT
5462 Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
5464 PERL_ARGS_ASSERT_FREE_GLOBAL_STRUCT;
5465 # ifdef PERL_GLOBAL_STRUCT
5466 # ifdef PERL_UNSET_VARS
5467 PERL_UNSET_VARS(plvarsp);
5469 free(plvarsp->Gppaddr);
5470 free(plvarsp->Gcheck);
5471 # ifdef PERL_GLOBAL_STRUCT_PRIVATE
5477 #endif /* PERL_GLOBAL_STRUCT */
5481 /* -DPERL_MEM_LOG: the Perl_mem_log_..() is compiled, including the
5482 * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
5483 * given, and you supply your own implementation.
5485 * The default implementation reads a single env var, PERL_MEM_LOG,
5486 * expecting one or more of the following:
5488 * \d+ - fd fd to write to : must be 1st (atoi)
5489 * 'm' - memlog was PERL_MEM_LOG=1
5490 * 's' - svlog was PERL_SV_LOG=1
5491 * 't' - timestamp was PERL_MEM_LOG_TIMESTAMP=1
5493 * This makes the logger controllable enough that it can reasonably be
5494 * added to the system perl.
5497 /* -DPERL_MEM_LOG_SPRINTF_BUF_SIZE=X: size of a (stack-allocated) buffer
5498 * the Perl_mem_log_...() will use (either via sprintf or snprintf).
5500 #define PERL_MEM_LOG_SPRINTF_BUF_SIZE 128
5502 /* -DPERL_MEM_LOG_FD=N: the file descriptor the Perl_mem_log_...()
5503 * writes to. In the default logger, this is settable at runtime.
5505 #ifndef PERL_MEM_LOG_FD
5506 # define PERL_MEM_LOG_FD 2 /* If STDERR is too boring for you. */
5509 #ifndef PERL_MEM_LOG_NOIMPL
5511 # ifdef DEBUG_LEAKING_SCALARS
5512 # define SV_LOG_SERIAL_FMT " [%lu]"
5513 # define _SV_LOG_SERIAL_ARG(sv) , (unsigned long) (sv)->sv_debug_serial
5515 # define SV_LOG_SERIAL_FMT
5516 # define _SV_LOG_SERIAL_ARG(sv)
5520 S_mem_log_common(enum mem_log_type mlt, const UV n,
5521 const UV typesize, const char *type_name, const SV *sv,
5522 Malloc_t oldalloc, Malloc_t newalloc,
5523 const char *filename, const int linenumber,
5524 const char *funcname)
5528 PERL_ARGS_ASSERT_MEM_LOG_COMMON;
5530 pmlenv = PerlEnv_getenv("PERL_MEM_LOG");
5533 if (mlt < MLT_NEW_SV ? strchr(pmlenv,'m') : strchr(pmlenv,'s'))
5535 /* We can't use SVs or PerlIO for obvious reasons,
5536 * so we'll use stdio and low-level IO instead. */
5537 char buf[PERL_MEM_LOG_SPRINTF_BUF_SIZE];
5539 # ifdef HAS_GETTIMEOFDAY
5540 # define MEM_LOG_TIME_FMT "%10d.%06d: "
5541 # define MEM_LOG_TIME_ARG (int)tv.tv_sec, (int)tv.tv_usec
5543 gettimeofday(&tv, 0);
5545 # define MEM_LOG_TIME_FMT "%10d: "
5546 # define MEM_LOG_TIME_ARG (int)when
5550 /* If there are other OS specific ways of hires time than
5551 * gettimeofday() (see ext/Time-HiRes), the easiest way is
5552 * probably that they would be used to fill in the struct
5556 int fd = atoi(pmlenv);
5558 fd = PERL_MEM_LOG_FD;
5560 if (strchr(pmlenv, 't')) {
5561 len = my_snprintf(buf, sizeof(buf),
5562 MEM_LOG_TIME_FMT, MEM_LOG_TIME_ARG);
5563 PerlLIO_write(fd, buf, len);
5567 len = my_snprintf(buf, sizeof(buf),
5568 "alloc: %s:%d:%s: %"IVdf" %"UVuf
5569 " %s = %"IVdf": %"UVxf"\n",
5570 filename, linenumber, funcname, n, typesize,
5571 type_name, n * typesize, PTR2UV(newalloc));
5574 len = my_snprintf(buf, sizeof(buf),
5575 "realloc: %s:%d:%s: %"IVdf" %"UVuf
5576 " %s = %"IVdf": %"UVxf" -> %"UVxf"\n",
5577 filename, linenumber, funcname, n, typesize,
5578 type_name, n * typesize, PTR2UV(oldalloc),
5582 len = my_snprintf(buf, sizeof(buf),
5583 "free: %s:%d:%s: %"UVxf"\n",
5584 filename, linenumber, funcname,
5589 len = my_snprintf(buf, sizeof(buf),
5590 "%s_SV: %s:%d:%s: %"UVxf SV_LOG_SERIAL_FMT "\n",
5591 mlt == MLT_NEW_SV ? "new" : "del",
5592 filename, linenumber, funcname,
5593 PTR2UV(sv) _SV_LOG_SERIAL_ARG(sv));
5598 PerlLIO_write(fd, buf, len);
5602 #endif /* !PERL_MEM_LOG_NOIMPL */
5604 #ifndef PERL_MEM_LOG_NOIMPL
5606 mem_log_common_if(alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm) \
5607 mem_log_common (alty, num, tysz, tynm, sv, oal, nal, flnm, ln, fnnm)
5609 /* this is suboptimal, but bug compatible. User is providing their
5610 own implementation, but is getting these functions anyway, and they
5611 do nothing. But _NOIMPL users should be able to cope or fix */
5613 mem_log_common_if(alty, num, tysz, tynm, u, oal, nal, flnm, ln, fnnm) \
5614 /* mem_log_common_if_PERL_MEM_LOG_NOIMPL */
5618 Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name,
5620 const char *filename, const int linenumber,
5621 const char *funcname)
5623 mem_log_common_if(MLT_ALLOC, n, typesize, type_name,
5624 NULL, NULL, newalloc,
5625 filename, linenumber, funcname);
5630 Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name,
5631 Malloc_t oldalloc, Malloc_t newalloc,
5632 const char *filename, const int linenumber,
5633 const char *funcname)
5635 mem_log_common_if(MLT_REALLOC, n, typesize, type_name,
5636 NULL, oldalloc, newalloc,
5637 filename, linenumber, funcname);
5642 Perl_mem_log_free(Malloc_t oldalloc,
5643 const char *filename, const int linenumber,
5644 const char *funcname)
5646 mem_log_common_if(MLT_FREE, 0, 0, "", NULL, oldalloc, NULL,
5647 filename, linenumber, funcname);
5652 Perl_mem_log_new_sv(const SV *sv,
5653 const char *filename, const int linenumber,
5654 const char *funcname)
5656 mem_log_common_if(MLT_NEW_SV, 0, 0, "", sv, NULL, NULL,
5657 filename, linenumber, funcname);
5661 Perl_mem_log_del_sv(const SV *sv,
5662 const char *filename, const int linenumber,
5663 const char *funcname)
5665 mem_log_common_if(MLT_DEL_SV, 0, 0, "", sv, NULL, NULL,
5666 filename, linenumber, funcname);
5669 #endif /* PERL_MEM_LOG */
5672 =for apidoc my_sprintf
5674 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
5675 the length of the string written to the buffer. Only rare pre-ANSI systems
5676 need the wrapper function - usually this is a direct call to C<sprintf>.
5680 #ifndef SPRINTF_RETURNS_STRLEN
5682 Perl_my_sprintf(char *buffer, const char* pat, ...)
5685 PERL_ARGS_ASSERT_MY_SPRINTF;
5686 va_start(args, pat);
5687 vsprintf(buffer, pat, args);
5689 return strlen(buffer);
5694 =for apidoc my_snprintf
5696 The C library C<snprintf> functionality, if available and
5697 standards-compliant (uses C<vsnprintf>, actually). However, if the
5698 C<vsnprintf> is not available, will unfortunately use the unsafe
5699 C<vsprintf> which can overrun the buffer (there is an overrun check,
5700 but that may be too late). Consider using C<sv_vcatpvf> instead, or
5701 getting C<vsnprintf>.
5706 Perl_my_snprintf(char *buffer, const Size_t len, const char *format, ...)
5710 PERL_ARGS_ASSERT_MY_SNPRINTF;
5711 va_start(ap, format);
5712 #ifdef HAS_VSNPRINTF
5713 retval = vsnprintf(buffer, len, format, ap);
5715 retval = vsprintf(buffer, format, ap);
5718 /* vsprintf() shows failure with < 0 */
5720 #ifdef HAS_VSNPRINTF
5721 /* vsnprintf() shows failure with >= len */
5723 (len > 0 && (Size_t)retval >= len)
5726 Perl_croak_nocontext("panic: my_snprintf buffer overflow");
5731 =for apidoc my_vsnprintf
5733 The C library C<vsnprintf> if available and standards-compliant.
5734 However, if if the C<vsnprintf> is not available, will unfortunately
5735 use the unsafe C<vsprintf> which can overrun the buffer (there is an
5736 overrun check, but that may be too late). Consider using
5737 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
5742 Perl_my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
5748 PERL_ARGS_ASSERT_MY_VSNPRINTF;
5750 Perl_va_copy(ap, apc);
5751 # ifdef HAS_VSNPRINTF
5752 retval = vsnprintf(buffer, len, format, apc);
5754 retval = vsprintf(buffer, format, apc);
5757 # ifdef HAS_VSNPRINTF
5758 retval = vsnprintf(buffer, len, format, ap);
5760 retval = vsprintf(buffer, format, ap);
5762 #endif /* #ifdef NEED_VA_COPY */
5763 /* vsprintf() shows failure with < 0 */
5765 #ifdef HAS_VSNPRINTF
5766 /* vsnprintf() shows failure with >= len */
5768 (len > 0 && (Size_t)retval >= len)
5771 Perl_croak_nocontext("panic: my_vsnprintf buffer overflow");
5776 Perl_my_clearenv(pTHX)
5779 #if ! defined(PERL_MICRO)
5780 # if defined(PERL_IMPLICIT_SYS) || defined(WIN32)
5782 # else /* ! (PERL_IMPLICIT_SYS || WIN32) */
5783 # if defined(USE_ENVIRON_ARRAY)
5784 # if defined(USE_ITHREADS)
5785 /* only the parent thread can clobber the process environment */
5786 if (PL_curinterp == aTHX)
5787 # endif /* USE_ITHREADS */
5789 # if ! defined(PERL_USE_SAFE_PUTENV)
5790 if ( !PL_use_safe_putenv) {
5792 if (environ == PL_origenviron)
5793 environ = (char**)safesysmalloc(sizeof(char*));
5795 for (i = 0; environ[i]; i++)
5796 (void)safesysfree(environ[i]);
5799 # else /* PERL_USE_SAFE_PUTENV */
5800 # if defined(HAS_CLEARENV)
5802 # elif defined(HAS_UNSETENV)
5803 int bsiz = 80; /* Most envvar names will be shorter than this. */
5804 char *buf = (char*)safesysmalloc(bsiz);
5805 while (*environ != NULL) {
5806 char *e = strchr(*environ, '=');
5807 int l = e ? e - *environ : (int)strlen(*environ);
5809 (void)safesysfree(buf);
5810 bsiz = l + 1; /* + 1 for the \0. */
5811 buf = (char*)safesysmalloc(bsiz);
5813 memcpy(buf, *environ, l);
5815 (void)unsetenv(buf);
5817 (void)safesysfree(buf);
5818 # else /* ! HAS_CLEARENV && ! HAS_UNSETENV */
5819 /* Just null environ and accept the leakage. */
5821 # endif /* HAS_CLEARENV || HAS_UNSETENV */
5822 # endif /* ! PERL_USE_SAFE_PUTENV */
5824 # endif /* USE_ENVIRON_ARRAY */
5825 # endif /* PERL_IMPLICIT_SYS || WIN32 */
5826 #endif /* PERL_MICRO */
5829 #ifdef PERL_IMPLICIT_CONTEXT
5831 /* Implements the MY_CXT_INIT macro. The first time a module is loaded,
5832 the global PL_my_cxt_index is incremented, and that value is assigned to
5833 that module's static my_cxt_index (who's address is passed as an arg).
5834 Then, for each interpreter this function is called for, it makes sure a
5835 void* slot is available to hang the static data off, by allocating or
5836 extending the interpreter's PL_my_cxt_list array */
5838 #ifndef PERL_GLOBAL_STRUCT_PRIVATE
5840 Perl_my_cxt_init(pTHX_ int *index, size_t size)
5844 PERL_ARGS_ASSERT_MY_CXT_INIT;
5846 /* this module hasn't been allocated an index yet */
5847 #if defined(USE_ITHREADS)
5848 MUTEX_LOCK(&PL_my_ctx_mutex);
5850 *index = PL_my_cxt_index++;
5851 #if defined(USE_ITHREADS)
5852 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5856 /* make sure the array is big enough */
5857 if (PL_my_cxt_size <= *index) {
5858 if (PL_my_cxt_size) {
5859 while (PL_my_cxt_size <= *index)
5860 PL_my_cxt_size *= 2;
5861 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5864 PL_my_cxt_size = 16;
5865 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5868 /* newSV() allocates one more than needed */
5869 p = (void*)SvPVX(newSV(size-1));
5870 PL_my_cxt_list[*index] = p;
5871 Zero(p, size, char);
5875 #else /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5878 Perl_my_cxt_index(pTHX_ const char *my_cxt_key)
5883 PERL_ARGS_ASSERT_MY_CXT_INDEX;
5885 for (index = 0; index < PL_my_cxt_index; index++) {
5886 const char *key = PL_my_cxt_keys[index];
5887 /* try direct pointer compare first - there are chances to success,
5888 * and it's much faster.
5890 if ((key == my_cxt_key) || strEQ(key, my_cxt_key))
5897 Perl_my_cxt_init(pTHX_ const char *my_cxt_key, size_t size)
5903 PERL_ARGS_ASSERT_MY_CXT_INIT;
5905 index = Perl_my_cxt_index(aTHX_ my_cxt_key);
5907 /* this module hasn't been allocated an index yet */
5908 #if defined(USE_ITHREADS)
5909 MUTEX_LOCK(&PL_my_ctx_mutex);
5911 index = PL_my_cxt_index++;
5912 #if defined(USE_ITHREADS)
5913 MUTEX_UNLOCK(&PL_my_ctx_mutex);
5917 /* make sure the array is big enough */
5918 if (PL_my_cxt_size <= index) {
5919 int old_size = PL_my_cxt_size;
5921 if (PL_my_cxt_size) {
5922 while (PL_my_cxt_size <= index)
5923 PL_my_cxt_size *= 2;
5924 Renew(PL_my_cxt_list, PL_my_cxt_size, void *);
5925 Renew(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5928 PL_my_cxt_size = 16;
5929 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
5930 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
5932 for (i = old_size; i < PL_my_cxt_size; i++) {
5933 PL_my_cxt_keys[i] = 0;
5934 PL_my_cxt_list[i] = 0;
5937 PL_my_cxt_keys[index] = my_cxt_key;
5938 /* newSV() allocates one more than needed */
5939 p = (void*)SvPVX(newSV(size-1));
5940 PL_my_cxt_list[index] = p;
5941 Zero(p, size, char);
5944 #endif /* #ifndef PERL_GLOBAL_STRUCT_PRIVATE */
5945 #endif /* PERL_IMPLICIT_CONTEXT */
5948 Perl_xs_version_bootcheck(pTHX_ U32 items, U32 ax, const char *xs_p,
5952 const char *vn = NULL;
5953 SV *const module = PL_stack_base[ax];
5955 PERL_ARGS_ASSERT_XS_VERSION_BOOTCHECK;
5957 if (items >= 2) /* version supplied as bootstrap arg */
5958 sv = PL_stack_base[ax + 1];
5960 /* XXX GV_ADDWARN */
5962 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
5963 if (!sv || !SvOK(sv)) {
5965 sv = get_sv(Perl_form(aTHX_ "%"SVf"::%s", module, vn), 0);
5969 SV *xssv = Perl_newSVpvn_flags(aTHX_ xs_p, xs_len, SVs_TEMP);
5970 SV *pmsv = sv_isobject(sv) && sv_derived_from(sv, "version")
5971 ? sv : sv_2mortal(new_version(sv));
5972 xssv = upg_version(xssv, 0);
5973 if ( vcmp(pmsv,xssv) ) {
5974 SV *string = vstringify(xssv);
5975 SV *xpt = Perl_newSVpvf(aTHX_ "%"SVf" object version %"SVf
5976 " does not match ", module, string);
5978 SvREFCNT_dec(string);
5979 string = vstringify(pmsv);
5982 Perl_sv_catpvf(aTHX_ xpt, "$%"SVf"::%s %"SVf, module, vn,
5985 Perl_sv_catpvf(aTHX_ xpt, "bootstrap parameter %"SVf, string);
5987 SvREFCNT_dec(string);
5989 Perl_sv_2mortal(aTHX_ xpt);
5990 Perl_croak_sv(aTHX_ xpt);
5996 Perl_xs_apiversion_bootcheck(pTHX_ SV *module, const char *api_p,
6000 SV *compver = Perl_newSVpvn_flags(aTHX_ api_p, api_len, SVs_TEMP);
6003 PERL_ARGS_ASSERT_XS_APIVERSION_BOOTCHECK;
6005 /* This might croak */
6006 compver = upg_version(compver, 0);
6007 /* This should never croak */
6008 runver = new_version(PL_apiversion);
6009 if (vcmp(compver, runver)) {
6010 SV *compver_string = vstringify(compver);
6011 SV *runver_string = vstringify(runver);
6012 xpt = Perl_newSVpvf(aTHX_ "Perl API version %"SVf
6013 " of %"SVf" does not match %"SVf,
6014 compver_string, module, runver_string);
6015 Perl_sv_2mortal(aTHX_ xpt);
6017 SvREFCNT_dec(compver_string);
6018 SvREFCNT_dec(runver_string);
6020 SvREFCNT_dec(runver);
6022 Perl_croak_sv(aTHX_ xpt);
6027 Perl_my_strlcat(char *dst, const char *src, Size_t size)
6029 Size_t used, length, copy;
6032 length = strlen(src);
6033 if (size > 0 && used < size - 1) {
6034 copy = (length >= size - used) ? size - used - 1 : length;
6035 memcpy(dst + used, src, copy);
6036 dst[used + copy] = '\0';
6038 return used + length;
6044 Perl_my_strlcpy(char *dst, const char *src, Size_t size)
6046 Size_t length, copy;
6048 length = strlen(src);
6050 copy = (length >= size) ? size - 1 : length;
6051 memcpy(dst, src, copy);
6058 #if defined(_MSC_VER) && (_MSC_VER >= 1300) && (_MSC_VER < 1400) && (WINVER < 0x0500)
6059 /* VC7 or 7.1, building with pre-VC7 runtime libraries. */
6060 long _ftol( double ); /* Defined by VC6 C libs. */
6061 long _ftol2( double dblSource ) { return _ftol( dblSource ); }
6064 PERL_STATIC_INLINE bool
6065 S_gv_has_usable_name(pTHX_ GV *gv)
6069 && HvENAME(GvSTASH(gv))
6070 && (gvp = (GV **)hv_fetch(
6071 GvSTASH(gv), GvNAME(gv),
6072 GvNAMEUTF8(gv) ? -GvNAMELEN(gv) : GvNAMELEN(gv), 0
6078 Perl_get_db_sub(pTHX_ SV **svp, CV *cv)
6081 SV * const dbsv = GvSVn(PL_DBsub);
6082 const bool save_taint = TAINT_get;
6084 /* When we are called from pp_goto (svp is null),
6085 * we do not care about using dbsv to call CV;
6086 * it's for informational purposes only.
6089 PERL_ARGS_ASSERT_GET_DB_SUB;
6093 if (!PERLDB_SUB_NN) {
6097 gv_efullname3(dbsv, gv, NULL);
6099 else if ( (CvFLAGS(cv) & (CVf_ANON | CVf_CLONED))
6100 || strEQ(GvNAME(gv), "END")
6101 || ( /* Could be imported, and old sub redefined. */
6102 (GvCV(gv) != cv || !S_gv_has_usable_name(aTHX_ gv))
6104 !( (SvTYPE(*svp) == SVt_PVGV)
6105 && (GvCV((const GV *)*svp) == cv)
6106 /* Use GV from the stack as a fallback. */
6107 && S_gv_has_usable_name(aTHX_ gv = (GV *)*svp)
6111 /* GV is potentially non-unique, or contain different CV. */
6112 SV * const tmp = newRV(MUTABLE_SV(cv));
6113 sv_setsv(dbsv, tmp);
6117 sv_sethek(dbsv, HvENAME_HEK(GvSTASH(gv)));
6118 sv_catpvs(dbsv, "::");
6120 dbsv, GvNAME(gv), GvNAMELEN(gv),
6121 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
6126 const int type = SvTYPE(dbsv);
6127 if (type < SVt_PVIV && type != SVt_IV)
6128 sv_upgrade(dbsv, SVt_PVIV);
6129 (void)SvIOK_on(dbsv);
6130 SvIV_set(dbsv, PTR2IV(cv)); /* Do it the quickest way */
6132 TAINT_IF(save_taint);
6133 #ifdef NO_TAINT_SUPPORT
6134 PERL_UNUSED_VAR(save_taint);
6139 Perl_my_dirfd(pTHX_ DIR * dir) {
6141 /* Most dirfd implementations have problems when passed NULL. */
6146 #elif defined(HAS_DIR_DD_FD)
6149 Perl_die(aTHX_ PL_no_func, "dirfd");
6150 assert(0); /* NOT REACHED */
6156 Perl_get_re_arg(pTHX_ SV *sv) {
6162 sv = MUTABLE_SV(SvRV(sv));
6163 if (SvTYPE(sv) == SVt_REGEXP)
6164 return (REGEXP*) sv;
6172 * c-indentation-style: bsd
6174 * indent-tabs-mode: nil
6177 * ex: set ts=8 sts=4 sw=4 et: