3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = NULL;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 ARENASETS: a meta-arena implementation which separates arena-info
561 into struct arena_set, which contains an array of struct
562 arena_descs, each holding info for a single arena. By separating
563 the meta-info from the arena, we recover the 1st slot, formerly
564 borrowed for list management. The arena_set is about the size of an
565 arena, avoiding the needless malloc overhead of a naive linked-list
567 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
568 memory in the last arena-set (1/2 on average). In trade, we get
569 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
572 union arena is declared with a fixed size, but is intended to vary
573 by type, allowing their use for big, rare body-types where theres
574 currently too much wastage (unused arena slots)
579 char *arena; /* the raw storage, allocated aligned */
580 size_t size; /* its size ~4k typ */
581 int unit_type; /* useful for arena audits */
582 /* info for sv-heads (eventually)
589 /* Get the maximum number of elements in set[] such that struct arena_set
590 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
591 therefore likely to be 1 aligned memory page. */
593 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
594 - 2 * sizeof(int)) / sizeof (struct arena_desc))
597 struct arena_set* next;
598 int set_size; /* ie ARENAS_PER_SET */
599 int curr; /* index of next available arena-desc */
600 struct arena_desc set[ARENAS_PER_SET];
606 S_free_arena(pTHX_ void **root) {
608 void ** const next = *(void **)root;
616 =for apidoc sv_free_arenas
618 Deallocate the memory used by all arenas. Note that all the individual SV
619 heads and bodies within the arenas must already have been freed.
624 Perl_sv_free_arenas(pTHX)
631 /* Free arenas here, but be careful about fake ones. (We assume
632 contiguity of the fake ones with the corresponding real ones.) */
634 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
635 svanext = (SV*) SvANY(sva);
636 while (svanext && SvFAKE(svanext))
637 svanext = (SV*) SvANY(svanext);
645 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
647 for (; aroot; aroot = next) {
648 int max = aroot->curr;
649 for (i=0; i<max; i++) {
650 assert(aroot->set[i].arena);
651 Safefree(aroot->set[i].arena);
658 S_free_arena(aTHX_ (void**) PL_body_arenas);
661 for (i=0; i<SVt_LAST; i++)
662 PL_body_roots[i] = 0;
664 Safefree(PL_nice_chunk);
665 PL_nice_chunk = NULL;
666 PL_nice_chunk_size = 0;
672 Here are mid-level routines that manage the allocation of bodies out
673 of the various arenas. There are 5 kinds of arenas:
675 1. SV-head arenas, which are discussed and handled above
676 2. regular body arenas
677 3. arenas for reduced-size bodies
679 5. pte arenas (thread related)
681 Arena types 2 & 3 are chained by body-type off an array of
682 arena-root pointers, which is indexed by svtype. Some of the
683 larger/less used body types are malloced singly, since a large
684 unused block of them is wasteful. Also, several svtypes dont have
685 bodies; the data fits into the sv-head itself. The arena-root
686 pointer thus has a few unused root-pointers (which may be hijacked
687 later for arena types 4,5)
689 3 differs from 2 as an optimization; some body types have several
690 unused fields in the front of the structure (which are kept in-place
691 for consistency). These bodies can be allocated in smaller chunks,
692 because the leading fields arent accessed. Pointers to such bodies
693 are decremented to point at the unused 'ghost' memory, knowing that
694 the pointers are used with offsets to the real memory.
696 HE, HEK arenas are managed separately, with separate code, but may
697 be merge-able later..
699 PTE arenas are not sv-bodies, but they share these mid-level
700 mechanics, so are considered here. The new mid-level mechanics rely
701 on the sv_type of the body being allocated, so we just reserve one
702 of the unused body-slots for PTEs, then use it in those (2) PTE
703 contexts below (line ~10k)
706 /* get_arena(size): when ARENASETS is enabled, this creates
707 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
709 TBD: export properly for hv.c: S_more_he().
712 Perl_get_arena(pTHX_ int arena_size)
717 /* allocate and attach arena */
718 Newx(arp, PERL_ARENA_SIZE, char);
719 arp->next = PL_body_arenas;
720 PL_body_arenas = arp;
724 struct arena_desc* adesc;
725 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
728 /* shouldnt need this
729 if (!arena_size) arena_size = PERL_ARENA_SIZE;
732 /* may need new arena-set to hold new arena */
733 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
734 Newxz(newroot, 1, struct arena_set);
735 newroot->set_size = ARENAS_PER_SET;
736 newroot->next = *aroot;
738 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
741 /* ok, now have arena-set with at least 1 empty/available arena-desc */
742 curr = (*aroot)->curr++;
743 adesc = &((*aroot)->set[curr]);
744 assert(!adesc->arena);
746 Newxz(adesc->arena, arena_size, char);
747 adesc->size = arena_size;
748 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p\n", curr, aroot));
755 S_more_bodies (pTHX_ size_t size, svtype sv_type)
758 void ** const root = &PL_body_roots[sv_type];
761 const size_t count = PERL_ARENA_SIZE / size;
763 start = (char*) Perl_get_arena(aTHX_ PERL_ARENA_SIZE);
765 end = start + (count-1) * size;
768 /* The initial slot is used to link the arenas together, so it isn't to be
769 linked into the list of ready-to-use bodies. */
773 *root = (void *)start;
775 while (start < end) {
776 char * const next = start + size;
777 *(void**) start = (void *)next;
785 /* grab a new thing from the free list, allocating more if necessary */
787 /* 1st, the inline version */
789 #define new_body_inline(xpv, size, sv_type) \
791 void ** const r3wt = &PL_body_roots[sv_type]; \
793 xpv = *((void **)(r3wt)) \
794 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
795 *(r3wt) = *(void**)(xpv); \
799 /* now use the inline version in the proper function */
803 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
804 compilers issue warnings. */
807 S_new_body(pTHX_ size_t size, svtype sv_type)
811 new_body_inline(xpv, size, sv_type);
817 /* return a thing to the free list */
819 #define del_body(thing, root) \
821 void ** const thing_copy = (void **)thing;\
823 *thing_copy = *root; \
824 *root = (void*)thing_copy; \
829 Revisiting type 3 arenas, there are 4 body-types which have some
830 members that are never accessed. They are XPV, XPVIV, XPVAV,
831 XPVHV, which have corresponding types: xpv_allocated,
832 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
834 For these types, the arenas are carved up into *_allocated size
835 chunks, we thus avoid wasted memory for those unaccessed members.
836 When bodies are allocated, we adjust the pointer back in memory by
837 the size of the bit not allocated, so it's as if we allocated the
838 full structure. (But things will all go boom if you write to the
839 part that is "not there", because you'll be overwriting the last
840 members of the preceding structure in memory.)
842 We calculate the correction using the STRUCT_OFFSET macro. For example, if
843 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
844 and the pointer is unchanged. If the allocated structure is smaller (no
845 initial NV actually allocated) then the net effect is to subtract the size
846 of the NV from the pointer, to return a new pointer as if an initial NV were
849 This is the same trick as was used for NV and IV bodies. Ironically it
850 doesn't need to be used for NV bodies any more, because NV is now at the
851 start of the structure. IV bodies don't need it either, because they are
852 no longer allocated. */
854 /* The following 2 arrays hide the above details in a pair of
855 lookup-tables, allowing us to be body-type agnostic.
857 size maps svtype to its body's allocated size.
858 offset maps svtype to the body-pointer adjustment needed
860 NB: elements in latter are 0 or <0, and are added during
861 allocation, and subtracted during deallocation. It may be clearer
862 to invert the values, and call it shrinkage_by_svtype.
865 struct body_details {
866 size_t size; /* Size to allocate */
867 size_t copy; /* Size of structure to copy (may be shorter) */
869 bool cant_upgrade; /* Can upgrade this type */
870 bool zero_nv; /* zero the NV when upgrading from this */
871 bool arena; /* Allocated from an arena */
878 /* With -DPURFIY we allocate everything directly, and don't use arenas.
879 This seems a rather elegant way to simplify some of the code below. */
880 #define HASARENA FALSE
882 #define HASARENA TRUE
884 #define NOARENA FALSE
886 /* A macro to work out the offset needed to subtract from a pointer to (say)
893 to make its members accessible via a pointer to (say)
903 #define relative_STRUCT_OFFSET(longer, shorter, member) \
904 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
906 /* Calculate the length to copy. Specifically work out the length less any
907 final padding the compiler needed to add. See the comment in sv_upgrade
908 for why copying the padding proved to be a bug. */
910 #define copy_length(type, last_member) \
911 STRUCT_OFFSET(type, last_member) \
912 + sizeof (((type*)SvANY((SV*)0))->last_member)
914 static const struct body_details bodies_by_type[] = {
915 {0, 0, 0, FALSE, NONV, NOARENA},
916 /* IVs are in the head, so the allocation size is 0 */
917 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
918 /* 8 bytes on most ILP32 with IEEE doubles */
919 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
920 /* RVs are in the head now */
921 /* However, this slot is overloaded and used by the pte */
922 {0, 0, 0, FALSE, NONV, NOARENA},
923 /* 8 bytes on most ILP32 with IEEE doubles */
924 {sizeof(xpv_allocated),
925 copy_length(XPV, xpv_len)
926 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
927 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
928 FALSE, NONV, HASARENA},
930 {sizeof(xpviv_allocated),
931 copy_length(XPVIV, xiv_u)
932 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
933 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
934 FALSE, NONV, HASARENA},
936 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
938 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
940 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
942 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
944 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
946 {sizeof(xpvav_allocated),
947 copy_length(XPVAV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
949 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 TRUE, HADNV, HASARENA},
952 {sizeof(xpvhv_allocated),
953 copy_length(XPVHV, xmg_stash)
954 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
955 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 TRUE, HADNV, HASARENA},
958 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
960 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
962 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
965 #define new_body_type(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type))
968 #define del_body_type(p, sv_type) \
969 del_body(p, &PL_body_roots[sv_type])
972 #define new_body_allocated(sv_type) \
973 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
974 - bodies_by_type[sv_type].offset)
976 #define del_body_allocated(p, sv_type) \
977 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
980 #define my_safemalloc(s) (void*)safemalloc(s)
981 #define my_safecalloc(s) (void*)safecalloc(s, 1)
982 #define my_safefree(p) safefree((char*)p)
986 #define new_XNV() my_safemalloc(sizeof(XPVNV))
987 #define del_XNV(p) my_safefree(p)
989 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
990 #define del_XPVNV(p) my_safefree(p)
992 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
993 #define del_XPVAV(p) my_safefree(p)
995 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
996 #define del_XPVHV(p) my_safefree(p)
998 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
999 #define del_XPVMG(p) my_safefree(p)
1001 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1002 #define del_XPVGV(p) my_safefree(p)
1006 #define new_XNV() new_body_type(SVt_NV)
1007 #define del_XNV(p) del_body_type(p, SVt_NV)
1009 #define new_XPVNV() new_body_type(SVt_PVNV)
1010 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1012 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1013 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1015 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1016 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1018 #define new_XPVMG() new_body_type(SVt_PVMG)
1019 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1021 #define new_XPVGV() new_body_type(SVt_PVGV)
1022 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1026 /* no arena for you! */
1028 #define new_NOARENA(details) \
1029 my_safemalloc((details)->size + (details)->offset)
1030 #define new_NOARENAZ(details) \
1031 my_safecalloc((details)->size + (details)->offset)
1034 =for apidoc sv_upgrade
1036 Upgrade an SV to a more complex form. Generally adds a new body type to the
1037 SV, then copies across as much information as possible from the old body.
1038 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1044 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1049 const U32 old_type = SvTYPE(sv);
1050 const struct body_details *const old_type_details
1051 = bodies_by_type + old_type;
1052 const struct body_details *new_type_details;
1054 if (new_type != SVt_PV && SvIsCOW(sv)) {
1055 sv_force_normal_flags(sv, 0);
1058 if (old_type == new_type)
1061 if (old_type > new_type)
1062 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1063 (int)old_type, (int)new_type);
1066 old_body = SvANY(sv);
1068 /* Copying structures onto other structures that have been neatly zeroed
1069 has a subtle gotcha. Consider XPVMG
1071 +------+------+------+------+------+-------+-------+
1072 | NV | CUR | LEN | IV | MAGIC | STASH |
1073 +------+------+------+------+------+-------+-------+
1074 0 4 8 12 16 20 24 28
1076 where NVs are aligned to 8 bytes, so that sizeof that structure is
1077 actually 32 bytes long, with 4 bytes of padding at the end:
1079 +------+------+------+------+------+-------+-------+------+
1080 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1081 +------+------+------+------+------+-------+-------+------+
1082 0 4 8 12 16 20 24 28 32
1084 so what happens if you allocate memory for this structure:
1086 +------+------+------+------+------+-------+-------+------+------+...
1087 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1088 +------+------+------+------+------+-------+-------+------+------+...
1089 0 4 8 12 16 20 24 28 32 36
1091 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1092 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1093 started out as zero once, but it's quite possible that it isn't. So now,
1094 rather than a nicely zeroed GP, you have it pointing somewhere random.
1097 (In fact, GP ends up pointing at a previous GP structure, because the
1098 principle cause of the padding in XPVMG getting garbage is a copy of
1099 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1101 So we are careful and work out the size of used parts of all the
1108 if (new_type < SVt_PVIV) {
1109 new_type = (new_type == SVt_NV)
1110 ? SVt_PVNV : SVt_PVIV;
1114 if (new_type < SVt_PVNV) {
1115 new_type = SVt_PVNV;
1121 assert(new_type > SVt_PV);
1122 assert(SVt_IV < SVt_PV);
1123 assert(SVt_NV < SVt_PV);
1130 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1131 there's no way that it can be safely upgraded, because perl.c
1132 expects to Safefree(SvANY(PL_mess_sv)) */
1133 assert(sv != PL_mess_sv);
1134 /* This flag bit is used to mean other things in other scalar types.
1135 Given that it only has meaning inside the pad, it shouldn't be set
1136 on anything that can get upgraded. */
1137 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1140 if (old_type_details->cant_upgrade)
1141 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1142 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1144 new_type_details = bodies_by_type + new_type;
1146 SvFLAGS(sv) &= ~SVTYPEMASK;
1147 SvFLAGS(sv) |= new_type;
1149 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1150 the return statements above will have triggered. */
1151 assert (new_type != SVt_NULL);
1154 assert(old_type == SVt_NULL);
1155 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1159 assert(old_type == SVt_NULL);
1160 SvANY(sv) = new_XNV();
1164 assert(old_type == SVt_NULL);
1165 SvANY(sv) = &sv->sv_u.svu_rv;
1170 assert(new_type_details->size);
1173 assert(new_type_details->arena);
1174 /* This points to the start of the allocated area. */
1175 new_body_inline(new_body, new_type_details->size, new_type);
1176 Zero(new_body, new_type_details->size, char);
1177 new_body = ((char *)new_body) - new_type_details->offset;
1179 /* We always allocated the full length item with PURIFY. To do this
1180 we fake things so that arena is false for all 16 types.. */
1181 new_body = new_NOARENAZ(new_type_details);
1183 SvANY(sv) = new_body;
1184 if (new_type == SVt_PVAV) {
1190 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1191 The target created by newSVrv also is, and it can have magic.
1192 However, it never has SvPVX set.
1194 if (old_type >= SVt_RV) {
1195 assert(SvPVX_const(sv) == 0);
1198 /* Could put this in the else clause below, as PVMG must have SvPVX
1199 0 already (the assertion above) */
1202 if (old_type >= SVt_PVMG) {
1203 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1204 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1210 /* XXX Is this still needed? Was it ever needed? Surely as there is
1211 no route from NV to PVIV, NOK can never be true */
1212 assert(!SvNOKp(sv));
1224 assert(new_type_details->size);
1225 /* We always allocated the full length item with PURIFY. To do this
1226 we fake things so that arena is false for all 16 types.. */
1227 if(new_type_details->arena) {
1228 /* This points to the start of the allocated area. */
1229 new_body_inline(new_body, new_type_details->size, new_type);
1230 Zero(new_body, new_type_details->size, char);
1231 new_body = ((char *)new_body) - new_type_details->offset;
1233 new_body = new_NOARENAZ(new_type_details);
1235 SvANY(sv) = new_body;
1237 if (old_type_details->copy) {
1238 Copy((char *)old_body + old_type_details->offset,
1239 (char *)new_body + old_type_details->offset,
1240 old_type_details->copy, char);
1243 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1244 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1245 * correct 0.0 for us. Otherwise, if the old body didn't have an
1246 * NV slot, but the new one does, then we need to initialise the
1247 * freshly created NV slot with whatever the correct bit pattern is
1249 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1253 if (new_type == SVt_PVIO)
1254 IoPAGE_LEN(sv) = 60;
1255 if (old_type < SVt_RV)
1259 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1260 (unsigned long)new_type);
1263 if (old_type_details->size) {
1264 /* If the old body had an allocated size, then we need to free it. */
1266 my_safefree(old_body);
1268 del_body((void*)((char*)old_body + old_type_details->offset),
1269 &PL_body_roots[old_type]);
1275 =for apidoc sv_backoff
1277 Remove any string offset. You should normally use the C<SvOOK_off> macro
1284 Perl_sv_backoff(pTHX_ register SV *sv)
1287 assert(SvTYPE(sv) != SVt_PVHV);
1288 assert(SvTYPE(sv) != SVt_PVAV);
1290 const char * const s = SvPVX_const(sv);
1291 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1292 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1294 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1296 SvFLAGS(sv) &= ~SVf_OOK;
1303 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1304 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1305 Use the C<SvGROW> wrapper instead.
1311 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1315 #ifdef HAS_64K_LIMIT
1316 if (newlen >= 0x10000) {
1317 PerlIO_printf(Perl_debug_log,
1318 "Allocation too large: %"UVxf"\n", (UV)newlen);
1321 #endif /* HAS_64K_LIMIT */
1324 if (SvTYPE(sv) < SVt_PV) {
1325 sv_upgrade(sv, SVt_PV);
1326 s = SvPVX_mutable(sv);
1328 else if (SvOOK(sv)) { /* pv is offset? */
1330 s = SvPVX_mutable(sv);
1331 if (newlen > SvLEN(sv))
1332 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1333 #ifdef HAS_64K_LIMIT
1334 if (newlen >= 0x10000)
1339 s = SvPVX_mutable(sv);
1341 if (newlen > SvLEN(sv)) { /* need more room? */
1342 newlen = PERL_STRLEN_ROUNDUP(newlen);
1343 if (SvLEN(sv) && s) {
1345 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1351 s = saferealloc(s, newlen);
1354 s = safemalloc(newlen);
1355 if (SvPVX_const(sv) && SvCUR(sv)) {
1356 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1360 SvLEN_set(sv, newlen);
1366 =for apidoc sv_setiv
1368 Copies an integer into the given SV, upgrading first if necessary.
1369 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1375 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1378 SV_CHECK_THINKFIRST_COW_DROP(sv);
1379 switch (SvTYPE(sv)) {
1381 sv_upgrade(sv, SVt_IV);
1384 sv_upgrade(sv, SVt_PVNV);
1388 sv_upgrade(sv, SVt_PVIV);
1397 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1400 (void)SvIOK_only(sv); /* validate number */
1406 =for apidoc sv_setiv_mg
1408 Like C<sv_setiv>, but also handles 'set' magic.
1414 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1421 =for apidoc sv_setuv
1423 Copies an unsigned integer into the given SV, upgrading first if necessary.
1424 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1430 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1432 /* With these two if statements:
1433 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1436 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1438 If you wish to remove them, please benchmark to see what the effect is
1440 if (u <= (UV)IV_MAX) {
1441 sv_setiv(sv, (IV)u);
1450 =for apidoc sv_setuv_mg
1452 Like C<sv_setuv>, but also handles 'set' magic.
1458 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1467 =for apidoc sv_setnv
1469 Copies a double into the given SV, upgrading first if necessary.
1470 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1476 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1479 SV_CHECK_THINKFIRST_COW_DROP(sv);
1480 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_NV);
1488 sv_upgrade(sv, SVt_PVNV);
1497 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1501 (void)SvNOK_only(sv); /* validate number */
1506 =for apidoc sv_setnv_mg
1508 Like C<sv_setnv>, but also handles 'set' magic.
1514 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1520 /* Print an "isn't numeric" warning, using a cleaned-up,
1521 * printable version of the offending string
1525 S_not_a_number(pTHX_ SV *sv)
1533 dsv = sv_2mortal(newSVpvs(""));
1534 pv = sv_uni_display(dsv, sv, 10, 0);
1537 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1538 /* each *s can expand to 4 chars + "...\0",
1539 i.e. need room for 8 chars */
1541 const char *s = SvPVX_const(sv);
1542 const char * const end = s + SvCUR(sv);
1543 for ( ; s < end && d < limit; s++ ) {
1545 if (ch & 128 && !isPRINT_LC(ch)) {
1554 else if (ch == '\r') {
1558 else if (ch == '\f') {
1562 else if (ch == '\\') {
1566 else if (ch == '\0') {
1570 else if (isPRINT_LC(ch))
1587 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1588 "Argument \"%s\" isn't numeric in %s", pv,
1591 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1592 "Argument \"%s\" isn't numeric", pv);
1596 =for apidoc looks_like_number
1598 Test if the content of an SV looks like a number (or is a number).
1599 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1600 non-numeric warning), even if your atof() doesn't grok them.
1606 Perl_looks_like_number(pTHX_ SV *sv)
1608 register const char *sbegin;
1612 sbegin = SvPVX_const(sv);
1615 else if (SvPOKp(sv))
1616 sbegin = SvPV_const(sv, len);
1618 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1619 return grok_number(sbegin, len, NULL);
1622 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1623 until proven guilty, assume that things are not that bad... */
1628 As 64 bit platforms often have an NV that doesn't preserve all bits of
1629 an IV (an assumption perl has been based on to date) it becomes necessary
1630 to remove the assumption that the NV always carries enough precision to
1631 recreate the IV whenever needed, and that the NV is the canonical form.
1632 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1633 precision as a side effect of conversion (which would lead to insanity
1634 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1635 1) to distinguish between IV/UV/NV slots that have cached a valid
1636 conversion where precision was lost and IV/UV/NV slots that have a
1637 valid conversion which has lost no precision
1638 2) to ensure that if a numeric conversion to one form is requested that
1639 would lose precision, the precise conversion (or differently
1640 imprecise conversion) is also performed and cached, to prevent
1641 requests for different numeric formats on the same SV causing
1642 lossy conversion chains. (lossless conversion chains are perfectly
1647 SvIOKp is true if the IV slot contains a valid value
1648 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1649 SvNOKp is true if the NV slot contains a valid value
1650 SvNOK is true only if the NV value is accurate
1653 while converting from PV to NV, check to see if converting that NV to an
1654 IV(or UV) would lose accuracy over a direct conversion from PV to
1655 IV(or UV). If it would, cache both conversions, return NV, but mark
1656 SV as IOK NOKp (ie not NOK).
1658 While converting from PV to IV, check to see if converting that IV to an
1659 NV would lose accuracy over a direct conversion from PV to NV. If it
1660 would, cache both conversions, flag similarly.
1662 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1663 correctly because if IV & NV were set NV *always* overruled.
1664 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1665 changes - now IV and NV together means that the two are interchangeable:
1666 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1668 The benefit of this is that operations such as pp_add know that if
1669 SvIOK is true for both left and right operands, then integer addition
1670 can be used instead of floating point (for cases where the result won't
1671 overflow). Before, floating point was always used, which could lead to
1672 loss of precision compared with integer addition.
1674 * making IV and NV equal status should make maths accurate on 64 bit
1676 * may speed up maths somewhat if pp_add and friends start to use
1677 integers when possible instead of fp. (Hopefully the overhead in
1678 looking for SvIOK and checking for overflow will not outweigh the
1679 fp to integer speedup)
1680 * will slow down integer operations (callers of SvIV) on "inaccurate"
1681 values, as the change from SvIOK to SvIOKp will cause a call into
1682 sv_2iv each time rather than a macro access direct to the IV slot
1683 * should speed up number->string conversion on integers as IV is
1684 favoured when IV and NV are equally accurate
1686 ####################################################################
1687 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1688 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1689 On the other hand, SvUOK is true iff UV.
1690 ####################################################################
1692 Your mileage will vary depending your CPU's relative fp to integer
1696 #ifndef NV_PRESERVES_UV
1697 # define IS_NUMBER_UNDERFLOW_IV 1
1698 # define IS_NUMBER_UNDERFLOW_UV 2
1699 # define IS_NUMBER_IV_AND_UV 2
1700 # define IS_NUMBER_OVERFLOW_IV 4
1701 # define IS_NUMBER_OVERFLOW_UV 5
1703 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1705 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1707 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1710 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1711 if (SvNVX(sv) < (NV)IV_MIN) {
1712 (void)SvIOKp_on(sv);
1714 SvIV_set(sv, IV_MIN);
1715 return IS_NUMBER_UNDERFLOW_IV;
1717 if (SvNVX(sv) > (NV)UV_MAX) {
1718 (void)SvIOKp_on(sv);
1721 SvUV_set(sv, UV_MAX);
1722 return IS_NUMBER_OVERFLOW_UV;
1724 (void)SvIOKp_on(sv);
1726 /* Can't use strtol etc to convert this string. (See truth table in
1728 if (SvNVX(sv) <= (UV)IV_MAX) {
1729 SvIV_set(sv, I_V(SvNVX(sv)));
1730 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1731 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1733 /* Integer is imprecise. NOK, IOKp */
1735 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1738 SvUV_set(sv, U_V(SvNVX(sv)));
1739 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1740 if (SvUVX(sv) == UV_MAX) {
1741 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1742 possibly be preserved by NV. Hence, it must be overflow.
1744 return IS_NUMBER_OVERFLOW_UV;
1746 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1748 /* Integer is imprecise. NOK, IOKp */
1750 return IS_NUMBER_OVERFLOW_IV;
1752 #endif /* !NV_PRESERVES_UV*/
1755 S_sv_2iuv_common(pTHX_ SV *sv) {
1758 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1759 * without also getting a cached IV/UV from it at the same time
1760 * (ie PV->NV conversion should detect loss of accuracy and cache
1761 * IV or UV at same time to avoid this. */
1762 /* IV-over-UV optimisation - choose to cache IV if possible */
1764 if (SvTYPE(sv) == SVt_NV)
1765 sv_upgrade(sv, SVt_PVNV);
1767 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1768 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1769 certainly cast into the IV range at IV_MAX, whereas the correct
1770 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1772 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1773 SvIV_set(sv, I_V(SvNVX(sv)));
1774 if (SvNVX(sv) == (NV) SvIVX(sv)
1775 #ifndef NV_PRESERVES_UV
1776 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1777 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1778 /* Don't flag it as "accurately an integer" if the number
1779 came from a (by definition imprecise) NV operation, and
1780 we're outside the range of NV integer precision */
1783 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1784 DEBUG_c(PerlIO_printf(Perl_debug_log,
1785 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1791 /* IV not precise. No need to convert from PV, as NV
1792 conversion would already have cached IV if it detected
1793 that PV->IV would be better than PV->NV->IV
1794 flags already correct - don't set public IOK. */
1795 DEBUG_c(PerlIO_printf(Perl_debug_log,
1796 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1801 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1802 but the cast (NV)IV_MIN rounds to a the value less (more
1803 negative) than IV_MIN which happens to be equal to SvNVX ??
1804 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1805 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1806 (NV)UVX == NVX are both true, but the values differ. :-(
1807 Hopefully for 2s complement IV_MIN is something like
1808 0x8000000000000000 which will be exact. NWC */
1811 SvUV_set(sv, U_V(SvNVX(sv)));
1813 (SvNVX(sv) == (NV) SvUVX(sv))
1814 #ifndef NV_PRESERVES_UV
1815 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1816 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1817 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1818 /* Don't flag it as "accurately an integer" if the number
1819 came from a (by definition imprecise) NV operation, and
1820 we're outside the range of NV integer precision */
1825 DEBUG_c(PerlIO_printf(Perl_debug_log,
1826 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1832 else if (SvPOKp(sv) && SvLEN(sv)) {
1834 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1835 /* We want to avoid a possible problem when we cache an IV/ a UV which
1836 may be later translated to an NV, and the resulting NV is not
1837 the same as the direct translation of the initial string
1838 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1839 be careful to ensure that the value with the .456 is around if the
1840 NV value is requested in the future).
1842 This means that if we cache such an IV/a UV, we need to cache the
1843 NV as well. Moreover, we trade speed for space, and do not
1844 cache the NV if we are sure it's not needed.
1847 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1848 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1849 == IS_NUMBER_IN_UV) {
1850 /* It's definitely an integer, only upgrade to PVIV */
1851 if (SvTYPE(sv) < SVt_PVIV)
1852 sv_upgrade(sv, SVt_PVIV);
1854 } else if (SvTYPE(sv) < SVt_PVNV)
1855 sv_upgrade(sv, SVt_PVNV);
1857 /* If NVs preserve UVs then we only use the UV value if we know that
1858 we aren't going to call atof() below. If NVs don't preserve UVs
1859 then the value returned may have more precision than atof() will
1860 return, even though value isn't perfectly accurate. */
1861 if ((numtype & (IS_NUMBER_IN_UV
1862 #ifdef NV_PRESERVES_UV
1865 )) == IS_NUMBER_IN_UV) {
1866 /* This won't turn off the public IOK flag if it was set above */
1867 (void)SvIOKp_on(sv);
1869 if (!(numtype & IS_NUMBER_NEG)) {
1871 if (value <= (UV)IV_MAX) {
1872 SvIV_set(sv, (IV)value);
1874 /* it didn't overflow, and it was positive. */
1875 SvUV_set(sv, value);
1879 /* 2s complement assumption */
1880 if (value <= (UV)IV_MIN) {
1881 SvIV_set(sv, -(IV)value);
1883 /* Too negative for an IV. This is a double upgrade, but
1884 I'm assuming it will be rare. */
1885 if (SvTYPE(sv) < SVt_PVNV)
1886 sv_upgrade(sv, SVt_PVNV);
1890 SvNV_set(sv, -(NV)value);
1891 SvIV_set(sv, IV_MIN);
1895 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1896 will be in the previous block to set the IV slot, and the next
1897 block to set the NV slot. So no else here. */
1899 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1900 != IS_NUMBER_IN_UV) {
1901 /* It wasn't an (integer that doesn't overflow the UV). */
1902 SvNV_set(sv, Atof(SvPVX_const(sv)));
1904 if (! numtype && ckWARN(WARN_NUMERIC))
1907 #if defined(USE_LONG_DOUBLE)
1908 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1909 PTR2UV(sv), SvNVX(sv)));
1911 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1912 PTR2UV(sv), SvNVX(sv)));
1915 #ifdef NV_PRESERVES_UV
1916 (void)SvIOKp_on(sv);
1918 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1919 SvIV_set(sv, I_V(SvNVX(sv)));
1920 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1923 /* Integer is imprecise. NOK, IOKp */
1925 /* UV will not work better than IV */
1927 if (SvNVX(sv) > (NV)UV_MAX) {
1929 /* Integer is inaccurate. NOK, IOKp, is UV */
1930 SvUV_set(sv, UV_MAX);
1932 SvUV_set(sv, U_V(SvNVX(sv)));
1933 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1934 NV preservse UV so can do correct comparison. */
1935 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1938 /* Integer is imprecise. NOK, IOKp, is UV */
1943 #else /* NV_PRESERVES_UV */
1944 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1945 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1946 /* The IV/UV slot will have been set from value returned by
1947 grok_number above. The NV slot has just been set using
1950 assert (SvIOKp(sv));
1952 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1953 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1954 /* Small enough to preserve all bits. */
1955 (void)SvIOKp_on(sv);
1957 SvIV_set(sv, I_V(SvNVX(sv)));
1958 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1960 /* Assumption: first non-preserved integer is < IV_MAX,
1961 this NV is in the preserved range, therefore: */
1962 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1964 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1968 0 0 already failed to read UV.
1969 0 1 already failed to read UV.
1970 1 0 you won't get here in this case. IV/UV
1971 slot set, public IOK, Atof() unneeded.
1972 1 1 already read UV.
1973 so there's no point in sv_2iuv_non_preserve() attempting
1974 to use atol, strtol, strtoul etc. */
1975 sv_2iuv_non_preserve (sv, numtype);
1978 #endif /* NV_PRESERVES_UV */
1982 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1983 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1986 if (SvTYPE(sv) < SVt_IV)
1987 /* Typically the caller expects that sv_any is not NULL now. */
1988 sv_upgrade(sv, SVt_IV);
1989 /* Return 0 from the caller. */
1996 =for apidoc sv_2iv_flags
1998 Return the integer value of an SV, doing any necessary string
1999 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2000 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2006 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2011 if (SvGMAGICAL(sv)) {
2012 if (flags & SV_GMAGIC)
2017 return I_V(SvNVX(sv));
2019 if (SvPOKp(sv) && SvLEN(sv)) {
2022 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2024 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2025 == IS_NUMBER_IN_UV) {
2026 /* It's definitely an integer */
2027 if (numtype & IS_NUMBER_NEG) {
2028 if (value < (UV)IV_MIN)
2031 if (value < (UV)IV_MAX)
2036 if (ckWARN(WARN_NUMERIC))
2039 return I_V(Atof(SvPVX_const(sv)));
2044 assert(SvTYPE(sv) >= SVt_PVMG);
2045 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2046 } else if (SvTHINKFIRST(sv)) {
2050 SV * const tmpstr=AMG_CALLun(sv,numer);
2051 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2052 return SvIV(tmpstr);
2055 return PTR2IV(SvRV(sv));
2058 sv_force_normal_flags(sv, 0);
2060 if (SvREADONLY(sv) && !SvOK(sv)) {
2061 if (ckWARN(WARN_UNINITIALIZED))
2067 if (S_sv_2iuv_common(aTHX_ sv))
2070 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2071 PTR2UV(sv),SvIVX(sv)));
2072 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2076 =for apidoc sv_2uv_flags
2078 Return the unsigned integer value of an SV, doing any necessary string
2079 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2080 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2086 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2091 if (SvGMAGICAL(sv)) {
2092 if (flags & SV_GMAGIC)
2097 return U_V(SvNVX(sv));
2098 if (SvPOKp(sv) && SvLEN(sv)) {
2101 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2103 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2104 == IS_NUMBER_IN_UV) {
2105 /* It's definitely an integer */
2106 if (!(numtype & IS_NUMBER_NEG))
2110 if (ckWARN(WARN_NUMERIC))
2113 return U_V(Atof(SvPVX_const(sv)));
2118 assert(SvTYPE(sv) >= SVt_PVMG);
2119 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2120 } else if (SvTHINKFIRST(sv)) {
2124 SV *const tmpstr = AMG_CALLun(sv,numer);
2125 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2126 return SvUV(tmpstr);
2129 return PTR2UV(SvRV(sv));
2132 sv_force_normal_flags(sv, 0);
2134 if (SvREADONLY(sv) && !SvOK(sv)) {
2135 if (ckWARN(WARN_UNINITIALIZED))
2141 if (S_sv_2iuv_common(aTHX_ sv))
2145 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2146 PTR2UV(sv),SvUVX(sv)));
2147 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2153 Return the num value of an SV, doing any necessary string or integer
2154 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2161 Perl_sv_2nv(pTHX_ register SV *sv)
2166 if (SvGMAGICAL(sv)) {
2170 if (SvPOKp(sv) && SvLEN(sv)) {
2171 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2172 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2174 return Atof(SvPVX_const(sv));
2178 return (NV)SvUVX(sv);
2180 return (NV)SvIVX(sv);
2185 assert(SvTYPE(sv) >= SVt_PVMG);
2186 /* This falls through to the report_uninit near the end of the
2188 } else if (SvTHINKFIRST(sv)) {
2192 SV *const tmpstr = AMG_CALLun(sv,numer);
2193 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2194 return SvNV(tmpstr);
2197 return PTR2NV(SvRV(sv));
2200 sv_force_normal_flags(sv, 0);
2202 if (SvREADONLY(sv) && !SvOK(sv)) {
2203 if (ckWARN(WARN_UNINITIALIZED))
2208 if (SvTYPE(sv) < SVt_NV) {
2209 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2210 sv_upgrade(sv, SVt_NV);
2211 #ifdef USE_LONG_DOUBLE
2213 STORE_NUMERIC_LOCAL_SET_STANDARD();
2214 PerlIO_printf(Perl_debug_log,
2215 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2216 PTR2UV(sv), SvNVX(sv));
2217 RESTORE_NUMERIC_LOCAL();
2221 STORE_NUMERIC_LOCAL_SET_STANDARD();
2222 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2223 PTR2UV(sv), SvNVX(sv));
2224 RESTORE_NUMERIC_LOCAL();
2228 else if (SvTYPE(sv) < SVt_PVNV)
2229 sv_upgrade(sv, SVt_PVNV);
2234 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2235 #ifdef NV_PRESERVES_UV
2238 /* Only set the public NV OK flag if this NV preserves the IV */
2239 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2240 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2241 : (SvIVX(sv) == I_V(SvNVX(sv))))
2247 else if (SvPOKp(sv) && SvLEN(sv)) {
2249 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2250 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2252 #ifdef NV_PRESERVES_UV
2253 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2254 == IS_NUMBER_IN_UV) {
2255 /* It's definitely an integer */
2256 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2258 SvNV_set(sv, Atof(SvPVX_const(sv)));
2261 SvNV_set(sv, Atof(SvPVX_const(sv)));
2262 /* Only set the public NV OK flag if this NV preserves the value in
2263 the PV at least as well as an IV/UV would.
2264 Not sure how to do this 100% reliably. */
2265 /* if that shift count is out of range then Configure's test is
2266 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2268 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2269 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2270 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2271 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2272 /* Can't use strtol etc to convert this string, so don't try.
2273 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2276 /* value has been set. It may not be precise. */
2277 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2278 /* 2s complement assumption for (UV)IV_MIN */
2279 SvNOK_on(sv); /* Integer is too negative. */
2284 if (numtype & IS_NUMBER_NEG) {
2285 SvIV_set(sv, -(IV)value);
2286 } else if (value <= (UV)IV_MAX) {
2287 SvIV_set(sv, (IV)value);
2289 SvUV_set(sv, value);
2293 if (numtype & IS_NUMBER_NOT_INT) {
2294 /* I believe that even if the original PV had decimals,
2295 they are lost beyond the limit of the FP precision.
2296 However, neither is canonical, so both only get p
2297 flags. NWC, 2000/11/25 */
2298 /* Both already have p flags, so do nothing */
2300 const NV nv = SvNVX(sv);
2301 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2302 if (SvIVX(sv) == I_V(nv)) {
2305 /* It had no "." so it must be integer. */
2309 /* between IV_MAX and NV(UV_MAX).
2310 Could be slightly > UV_MAX */
2312 if (numtype & IS_NUMBER_NOT_INT) {
2313 /* UV and NV both imprecise. */
2315 const UV nv_as_uv = U_V(nv);
2317 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2326 #endif /* NV_PRESERVES_UV */
2329 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2331 assert (SvTYPE(sv) >= SVt_NV);
2332 /* Typically the caller expects that sv_any is not NULL now. */
2333 /* XXX Ilya implies that this is a bug in callers that assume this
2334 and ideally should be fixed. */
2337 #if defined(USE_LONG_DOUBLE)
2339 STORE_NUMERIC_LOCAL_SET_STANDARD();
2340 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2341 PTR2UV(sv), SvNVX(sv));
2342 RESTORE_NUMERIC_LOCAL();
2346 STORE_NUMERIC_LOCAL_SET_STANDARD();
2347 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2348 PTR2UV(sv), SvNVX(sv));
2349 RESTORE_NUMERIC_LOCAL();
2355 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2356 * UV as a string towards the end of buf, and return pointers to start and
2359 * We assume that buf is at least TYPE_CHARS(UV) long.
2363 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2365 char *ptr = buf + TYPE_CHARS(UV);
2366 char * const ebuf = ptr;
2379 *--ptr = '0' + (char)(uv % 10);
2387 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2388 * a regexp to its stringified form.
2392 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2394 const regexp * const re = (regexp *)mg->mg_obj;
2397 const char *fptr = "msix";
2402 bool need_newline = 0;
2403 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2405 while((ch = *fptr++)) {
2407 reflags[left++] = ch;
2410 reflags[right--] = ch;
2415 reflags[left] = '-';
2419 mg->mg_len = re->prelen + 4 + left;
2421 * If /x was used, we have to worry about a regex ending with a
2422 * comment later being embedded within another regex. If so, we don't
2423 * want this regex's "commentization" to leak out to the right part of
2424 * the enclosing regex, we must cap it with a newline.
2426 * So, if /x was used, we scan backwards from the end of the regex. If
2427 * we find a '#' before we find a newline, we need to add a newline
2428 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2429 * we don't need to add anything. -jfriedl
2431 if (PMf_EXTENDED & re->reganch) {
2432 const char *endptr = re->precomp + re->prelen;
2433 while (endptr >= re->precomp) {
2434 const char c = *(endptr--);
2436 break; /* don't need another */
2438 /* we end while in a comment, so we need a newline */
2439 mg->mg_len++; /* save space for it */
2440 need_newline = 1; /* note to add it */
2446 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2447 mg->mg_ptr[0] = '(';
2448 mg->mg_ptr[1] = '?';
2449 Copy(reflags, mg->mg_ptr+2, left, char);
2450 *(mg->mg_ptr+left+2) = ':';
2451 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2453 mg->mg_ptr[mg->mg_len - 2] = '\n';
2454 mg->mg_ptr[mg->mg_len - 1] = ')';
2455 mg->mg_ptr[mg->mg_len] = 0;
2457 PL_reginterp_cnt += re->program[0].next_off;
2459 if (re->reganch & ROPT_UTF8)
2469 =for apidoc sv_2pv_flags
2471 Returns a pointer to the string value of an SV, and sets *lp to its length.
2472 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2474 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2475 usually end up here too.
2481 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2491 if (SvGMAGICAL(sv)) {
2492 if (flags & SV_GMAGIC)
2497 if (flags & SV_MUTABLE_RETURN)
2498 return SvPVX_mutable(sv);
2499 if (flags & SV_CONST_RETURN)
2500 return (char *)SvPVX_const(sv);
2503 if (SvIOKp(sv) || SvNOKp(sv)) {
2504 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2508 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2509 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2511 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2514 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2515 /* Sneaky stuff here */
2516 SV * const tsv = newSVpvn(tbuf, len);
2526 #ifdef FIXNEGATIVEZERO
2527 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2533 SvUPGRADE(sv, SVt_PV);
2536 s = SvGROW_mutable(sv, len + 1);
2539 return memcpy(s, tbuf, len + 1);
2545 assert(SvTYPE(sv) >= SVt_PVMG);
2546 /* This falls through to the report_uninit near the end of the
2548 } else if (SvTHINKFIRST(sv)) {
2552 SV *const tmpstr = AMG_CALLun(sv,string);
2553 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2555 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2559 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2560 if (flags & SV_CONST_RETURN) {
2561 pv = (char *) SvPVX_const(tmpstr);
2563 pv = (flags & SV_MUTABLE_RETURN)
2564 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2567 *lp = SvCUR(tmpstr);
2569 pv = sv_2pv_flags(tmpstr, lp, flags);
2581 const SV *const referent = (SV*)SvRV(sv);
2584 tsv = sv_2mortal(newSVpvs("NULLREF"));
2585 } else if (SvTYPE(referent) == SVt_PVMG
2586 && ((SvFLAGS(referent) &
2587 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2588 == (SVs_OBJECT|SVs_SMG))
2589 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2590 return stringify_regexp(sv, mg, lp);
2592 const char *const typestr = sv_reftype(referent, 0);
2594 tsv = sv_newmortal();
2595 if (SvOBJECT(referent)) {
2596 const char *const name = HvNAME_get(SvSTASH(referent));
2597 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2598 name ? name : "__ANON__" , typestr,
2602 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2610 if (SvREADONLY(sv) && !SvOK(sv)) {
2611 if (ckWARN(WARN_UNINITIALIZED))
2618 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2619 /* I'm assuming that if both IV and NV are equally valid then
2620 converting the IV is going to be more efficient */
2621 const U32 isIOK = SvIOK(sv);
2622 const U32 isUIOK = SvIsUV(sv);
2623 char buf[TYPE_CHARS(UV)];
2626 if (SvTYPE(sv) < SVt_PVIV)
2627 sv_upgrade(sv, SVt_PVIV);
2628 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2629 /* inlined from sv_setpvn */
2630 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2631 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2632 SvCUR_set(sv, ebuf - ptr);
2642 else if (SvNOKp(sv)) {
2643 const int olderrno = errno;
2644 if (SvTYPE(sv) < SVt_PVNV)
2645 sv_upgrade(sv, SVt_PVNV);
2646 /* The +20 is pure guesswork. Configure test needed. --jhi */
2647 s = SvGROW_mutable(sv, NV_DIG + 20);
2648 /* some Xenix systems wipe out errno here */
2650 if (SvNVX(sv) == 0.0)
2651 (void)strcpy(s,"0");
2655 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2658 #ifdef FIXNEGATIVEZERO
2659 if (*s == '-' && s[1] == '0' && !s[2])
2669 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2673 if (SvTYPE(sv) < SVt_PV)
2674 /* Typically the caller expects that sv_any is not NULL now. */
2675 sv_upgrade(sv, SVt_PV);
2679 const STRLEN len = s - SvPVX_const(sv);
2685 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2686 PTR2UV(sv),SvPVX_const(sv)));
2687 if (flags & SV_CONST_RETURN)
2688 return (char *)SvPVX_const(sv);
2689 if (flags & SV_MUTABLE_RETURN)
2690 return SvPVX_mutable(sv);
2695 =for apidoc sv_copypv
2697 Copies a stringified representation of the source SV into the
2698 destination SV. Automatically performs any necessary mg_get and
2699 coercion of numeric values into strings. Guaranteed to preserve
2700 UTF-8 flag even from overloaded objects. Similar in nature to
2701 sv_2pv[_flags] but operates directly on an SV instead of just the
2702 string. Mostly uses sv_2pv_flags to do its work, except when that
2703 would lose the UTF-8'ness of the PV.
2709 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2712 const char * const s = SvPV_const(ssv,len);
2713 sv_setpvn(dsv,s,len);
2721 =for apidoc sv_2pvbyte
2723 Return a pointer to the byte-encoded representation of the SV, and set *lp
2724 to its length. May cause the SV to be downgraded from UTF-8 as a
2727 Usually accessed via the C<SvPVbyte> macro.
2733 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2735 sv_utf8_downgrade(sv,0);
2736 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2740 =for apidoc sv_2pvutf8
2742 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2743 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2745 Usually accessed via the C<SvPVutf8> macro.
2751 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2753 sv_utf8_upgrade(sv);
2754 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2759 =for apidoc sv_2bool
2761 This function is only called on magical items, and is only used by
2762 sv_true() or its macro equivalent.
2768 Perl_sv_2bool(pTHX_ register SV *sv)
2777 SV * const tmpsv = AMG_CALLun(sv,bool_);
2778 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2779 return (bool)SvTRUE(tmpsv);
2781 return SvRV(sv) != 0;
2784 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2786 (*sv->sv_u.svu_pv > '0' ||
2787 Xpvtmp->xpv_cur > 1 ||
2788 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2795 return SvIVX(sv) != 0;
2798 return SvNVX(sv) != 0.0;
2806 =for apidoc sv_utf8_upgrade
2808 Converts the PV of an SV to its UTF-8-encoded form.
2809 Forces the SV to string form if it is not already.
2810 Always sets the SvUTF8 flag to avoid future validity checks even
2811 if all the bytes have hibit clear.
2813 This is not as a general purpose byte encoding to Unicode interface:
2814 use the Encode extension for that.
2816 =for apidoc sv_utf8_upgrade_flags
2818 Converts the PV of an SV to its UTF-8-encoded form.
2819 Forces the SV to string form if it is not already.
2820 Always sets the SvUTF8 flag to avoid future validity checks even
2821 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2822 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2823 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2825 This is not as a general purpose byte encoding to Unicode interface:
2826 use the Encode extension for that.
2832 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2835 if (sv == &PL_sv_undef)
2839 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2840 (void) sv_2pv_flags(sv,&len, flags);
2844 (void) SvPV_force(sv,len);
2853 sv_force_normal_flags(sv, 0);
2856 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2857 sv_recode_to_utf8(sv, PL_encoding);
2858 else { /* Assume Latin-1/EBCDIC */
2859 /* This function could be much more efficient if we
2860 * had a FLAG in SVs to signal if there are any hibit
2861 * chars in the PV. Given that there isn't such a flag
2862 * make the loop as fast as possible. */
2863 const U8 * const s = (U8 *) SvPVX_const(sv);
2864 const U8 * const e = (U8 *) SvEND(sv);
2869 /* Check for hi bit */
2870 if (!NATIVE_IS_INVARIANT(ch)) {
2871 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2872 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2874 SvPV_free(sv); /* No longer using what was there before. */
2875 SvPV_set(sv, (char*)recoded);
2876 SvCUR_set(sv, len - 1);
2877 SvLEN_set(sv, len); /* No longer know the real size. */
2881 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2888 =for apidoc sv_utf8_downgrade
2890 Attempts to convert the PV of an SV from characters to bytes.
2891 If the PV contains a character beyond byte, this conversion will fail;
2892 in this case, either returns false or, if C<fail_ok> is not
2895 This is not as a general purpose Unicode to byte encoding interface:
2896 use the Encode extension for that.
2902 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2905 if (SvPOKp(sv) && SvUTF8(sv)) {
2911 sv_force_normal_flags(sv, 0);
2913 s = (U8 *) SvPV(sv, len);
2914 if (!utf8_to_bytes(s, &len)) {
2919 Perl_croak(aTHX_ "Wide character in %s",
2922 Perl_croak(aTHX_ "Wide character");
2933 =for apidoc sv_utf8_encode
2935 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2936 flag off so that it looks like octets again.
2942 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2944 (void) sv_utf8_upgrade(sv);
2946 sv_force_normal_flags(sv, 0);
2948 if (SvREADONLY(sv)) {
2949 Perl_croak(aTHX_ PL_no_modify);
2955 =for apidoc sv_utf8_decode
2957 If the PV of the SV is an octet sequence in UTF-8
2958 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2959 so that it looks like a character. If the PV contains only single-byte
2960 characters, the C<SvUTF8> flag stays being off.
2961 Scans PV for validity and returns false if the PV is invalid UTF-8.
2967 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2973 /* The octets may have got themselves encoded - get them back as
2976 if (!sv_utf8_downgrade(sv, TRUE))
2979 /* it is actually just a matter of turning the utf8 flag on, but
2980 * we want to make sure everything inside is valid utf8 first.
2982 c = (const U8 *) SvPVX_const(sv);
2983 if (!is_utf8_string(c, SvCUR(sv)+1))
2985 e = (const U8 *) SvEND(sv);
2988 if (!UTF8_IS_INVARIANT(ch)) {
2998 =for apidoc sv_setsv
3000 Copies the contents of the source SV C<ssv> into the destination SV
3001 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3002 function if the source SV needs to be reused. Does not handle 'set' magic.
3003 Loosely speaking, it performs a copy-by-value, obliterating any previous
3004 content of the destination.
3006 You probably want to use one of the assortment of wrappers, such as
3007 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3008 C<SvSetMagicSV_nosteal>.
3010 =for apidoc sv_setsv_flags
3012 Copies the contents of the source SV C<ssv> into the destination SV
3013 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3014 function if the source SV needs to be reused. Does not handle 'set' magic.
3015 Loosely speaking, it performs a copy-by-value, obliterating any previous
3016 content of the destination.
3017 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3018 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3019 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3020 and C<sv_setsv_nomg> are implemented in terms of this function.
3022 You probably want to use one of the assortment of wrappers, such as
3023 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3024 C<SvSetMagicSV_nosteal>.
3026 This is the primary function for copying scalars, and most other
3027 copy-ish functions and macros use this underneath.
3033 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3035 if (dtype != SVt_PVGV) {
3036 const char * const name = GvNAME(sstr);
3037 const STRLEN len = GvNAMELEN(sstr);
3038 /* don't upgrade SVt_PVLV: it can hold a glob */
3039 if (dtype != SVt_PVLV)
3040 sv_upgrade(dstr, SVt_PVGV);
3041 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3042 GvSTASH(dstr) = GvSTASH(sstr);
3044 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3045 GvNAME(dstr) = savepvn(name, len);
3046 GvNAMELEN(dstr) = len;
3047 SvFAKE_on(dstr); /* can coerce to non-glob */
3050 #ifdef GV_UNIQUE_CHECK
3051 if (GvUNIQUE((GV*)dstr)) {
3052 Perl_croak(aTHX_ PL_no_modify);
3056 (void)SvOK_off(dstr);
3057 GvINTRO_off(dstr); /* one-shot flag */
3059 GvGP(dstr) = gp_ref(GvGP(sstr));
3060 if (SvTAINTED(sstr))
3062 if (GvIMPORTED(dstr) != GVf_IMPORTED
3063 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3065 GvIMPORTED_on(dstr);
3072 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3073 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3075 const int intro = GvINTRO(dstr);
3078 const U32 stype = SvTYPE(sref);
3081 #ifdef GV_UNIQUE_CHECK
3082 if (GvUNIQUE((GV*)dstr)) {
3083 Perl_croak(aTHX_ PL_no_modify);
3088 GvINTRO_off(dstr); /* one-shot flag */
3089 GvLINE(dstr) = CopLINE(PL_curcop);
3090 GvEGV(dstr) = (GV*)dstr;
3095 location = (SV **) &GvCV(dstr);
3096 import_flag = GVf_IMPORTED_CV;
3099 location = (SV **) &GvHV(dstr);
3100 import_flag = GVf_IMPORTED_HV;
3103 location = (SV **) &GvAV(dstr);
3104 import_flag = GVf_IMPORTED_AV;
3107 location = (SV **) &GvIOp(dstr);
3110 location = (SV **) &GvFORM(dstr);
3112 location = &GvSV(dstr);
3113 import_flag = GVf_IMPORTED_SV;
3116 if (stype == SVt_PVCV) {
3117 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3118 SvREFCNT_dec(GvCV(dstr));
3120 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3121 PL_sub_generation++;
3124 SAVEGENERICSV(*location);
3128 if (stype == SVt_PVCV && *location != sref) {
3129 CV* const cv = (CV*)*location;
3131 if (!GvCVGEN((GV*)dstr) &&
3132 (CvROOT(cv) || CvXSUB(cv)))
3134 /* Redefining a sub - warning is mandatory if
3135 it was a const and its value changed. */
3136 if (CvCONST(cv) && CvCONST((CV*)sref)
3137 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3138 /* They are 2 constant subroutines generated from
3139 the same constant. This probably means that
3140 they are really the "same" proxy subroutine
3141 instantiated in 2 places. Most likely this is
3142 when a constant is exported twice. Don't warn.
3145 else if (ckWARN(WARN_REDEFINE)
3147 && (!CvCONST((CV*)sref)
3148 || sv_cmp(cv_const_sv(cv),
3149 cv_const_sv((CV*)sref))))) {
3150 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3152 ? "Constant subroutine %s::%s redefined"
3153 : "Subroutine %s::%s redefined",
3154 HvNAME_get(GvSTASH((GV*)dstr)),
3155 GvENAME((GV*)dstr));
3159 cv_ckproto(cv, (GV*)dstr,
3160 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3162 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3163 GvASSUMECV_on(dstr);
3164 PL_sub_generation++;
3167 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3168 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3169 GvFLAGS(dstr) |= import_flag;
3175 if (SvTAINTED(sstr))
3181 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3184 register U32 sflags;
3190 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3192 sstr = &PL_sv_undef;
3193 stype = SvTYPE(sstr);
3194 dtype = SvTYPE(dstr);
3199 /* need to nuke the magic */
3201 SvRMAGICAL_off(dstr);
3204 /* There's a lot of redundancy below but we're going for speed here */
3209 if (dtype != SVt_PVGV) {
3210 (void)SvOK_off(dstr);
3218 sv_upgrade(dstr, SVt_IV);
3221 sv_upgrade(dstr, SVt_PVNV);
3225 sv_upgrade(dstr, SVt_PVIV);
3228 (void)SvIOK_only(dstr);
3229 SvIV_set(dstr, SvIVX(sstr));
3232 /* SvTAINTED can only be true if the SV has taint magic, which in
3233 turn means that the SV type is PVMG (or greater). This is the
3234 case statement for SVt_IV, so this cannot be true (whatever gcov
3236 assert(!SvTAINTED(sstr));
3246 sv_upgrade(dstr, SVt_NV);
3251 sv_upgrade(dstr, SVt_PVNV);
3254 SvNV_set(dstr, SvNVX(sstr));
3255 (void)SvNOK_only(dstr);
3256 /* SvTAINTED can only be true if the SV has taint magic, which in
3257 turn means that the SV type is PVMG (or greater). This is the
3258 case statement for SVt_NV, so this cannot be true (whatever gcov
3260 assert(!SvTAINTED(sstr));
3267 sv_upgrade(dstr, SVt_RV);
3270 #ifdef PERL_OLD_COPY_ON_WRITE
3271 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3272 if (dtype < SVt_PVIV)
3273 sv_upgrade(dstr, SVt_PVIV);
3280 sv_upgrade(dstr, SVt_PV);
3283 if (dtype < SVt_PVIV)
3284 sv_upgrade(dstr, SVt_PVIV);
3287 if (dtype < SVt_PVNV)
3288 sv_upgrade(dstr, SVt_PVNV);
3295 const char * const type = sv_reftype(sstr,0);
3297 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3299 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3304 if (dtype <= SVt_PVGV) {
3305 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3311 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3313 if ((int)SvTYPE(sstr) != stype) {
3314 stype = SvTYPE(sstr);
3315 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3316 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3321 if (stype == SVt_PVLV)
3322 SvUPGRADE(dstr, SVt_PVNV);
3324 SvUPGRADE(dstr, (U32)stype);
3327 sflags = SvFLAGS(sstr);
3329 if (sflags & SVf_ROK) {
3330 if (dtype == SVt_PVGV &&
3331 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3334 if (GvIMPORTED(dstr) != GVf_IMPORTED
3335 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3337 GvIMPORTED_on(dstr);
3342 S_glob_assign_glob(aTHX_ dstr, sstr, dtype);
3346 if (dtype >= SVt_PV) {
3347 if (dtype == SVt_PVGV) {
3348 S_glob_assign_ref(aTHX_ dstr, sstr);
3351 if (SvPVX_const(dstr)) {
3357 (void)SvOK_off(dstr);
3358 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3359 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3360 assert(!(sflags & SVp_NOK));
3361 assert(!(sflags & SVp_IOK));
3362 assert(!(sflags & SVf_NOK));
3363 assert(!(sflags & SVf_IOK));
3365 else if (sflags & SVp_POK) {
3369 * Check to see if we can just swipe the string. If so, it's a
3370 * possible small lose on short strings, but a big win on long ones.
3371 * It might even be a win on short strings if SvPVX_const(dstr)
3372 * has to be allocated and SvPVX_const(sstr) has to be freed.
3375 /* Whichever path we take through the next code, we want this true,
3376 and doing it now facilitates the COW check. */
3377 (void)SvPOK_only(dstr);
3380 /* We're not already COW */
3381 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3382 #ifndef PERL_OLD_COPY_ON_WRITE
3383 /* or we are, but dstr isn't a suitable target. */
3384 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3389 (sflags & SVs_TEMP) && /* slated for free anyway? */
3390 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3391 (!(flags & SV_NOSTEAL)) &&
3392 /* and we're allowed to steal temps */
3393 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3394 SvLEN(sstr) && /* and really is a string */
3395 /* and won't be needed again, potentially */
3396 !(PL_op && PL_op->op_type == OP_AASSIGN))
3397 #ifdef PERL_OLD_COPY_ON_WRITE
3398 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3399 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3400 && SvTYPE(sstr) >= SVt_PVIV)
3403 /* Failed the swipe test, and it's not a shared hash key either.
3404 Have to copy the string. */
3405 STRLEN len = SvCUR(sstr);
3406 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3407 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3408 SvCUR_set(dstr, len);
3409 *SvEND(dstr) = '\0';
3411 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3413 /* Either it's a shared hash key, or it's suitable for
3414 copy-on-write or we can swipe the string. */
3416 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3420 #ifdef PERL_OLD_COPY_ON_WRITE
3422 /* I believe I should acquire a global SV mutex if
3423 it's a COW sv (not a shared hash key) to stop
3424 it going un copy-on-write.
3425 If the source SV has gone un copy on write between up there
3426 and down here, then (assert() that) it is of the correct
3427 form to make it copy on write again */
3428 if ((sflags & (SVf_FAKE | SVf_READONLY))
3429 != (SVf_FAKE | SVf_READONLY)) {
3430 SvREADONLY_on(sstr);
3432 /* Make the source SV into a loop of 1.
3433 (about to become 2) */
3434 SV_COW_NEXT_SV_SET(sstr, sstr);
3438 /* Initial code is common. */
3439 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3444 /* making another shared SV. */
3445 STRLEN cur = SvCUR(sstr);
3446 STRLEN len = SvLEN(sstr);
3447 #ifdef PERL_OLD_COPY_ON_WRITE
3449 assert (SvTYPE(dstr) >= SVt_PVIV);
3450 /* SvIsCOW_normal */
3451 /* splice us in between source and next-after-source. */
3452 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3453 SV_COW_NEXT_SV_SET(sstr, dstr);
3454 SvPV_set(dstr, SvPVX_mutable(sstr));
3458 /* SvIsCOW_shared_hash */
3459 DEBUG_C(PerlIO_printf(Perl_debug_log,
3460 "Copy on write: Sharing hash\n"));
3462 assert (SvTYPE(dstr) >= SVt_PV);
3464 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3466 SvLEN_set(dstr, len);
3467 SvCUR_set(dstr, cur);
3468 SvREADONLY_on(dstr);
3470 /* Relesase a global SV mutex. */
3473 { /* Passes the swipe test. */
3474 SvPV_set(dstr, SvPVX_mutable(sstr));
3475 SvLEN_set(dstr, SvLEN(sstr));
3476 SvCUR_set(dstr, SvCUR(sstr));
3479 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3480 SvPV_set(sstr, NULL);
3486 if (sflags & SVp_NOK) {
3487 SvNV_set(dstr, SvNVX(sstr));
3489 if (sflags & SVp_IOK) {
3490 SvRELEASE_IVX(dstr);
3491 SvIV_set(dstr, SvIVX(sstr));
3492 /* Must do this otherwise some other overloaded use of 0x80000000
3493 gets confused. I guess SVpbm_VALID */
3494 if (sflags & SVf_IVisUV)
3497 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3499 const MAGIC * const smg = SvVOK(sstr);
3501 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3502 smg->mg_ptr, smg->mg_len);
3503 SvRMAGICAL_on(dstr);
3507 else if (sflags & (SVp_IOK|SVp_NOK)) {
3508 (void)SvOK_off(dstr);
3509 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3510 if (sflags & SVp_IOK) {
3511 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3512 SvIV_set(dstr, SvIVX(sstr));
3514 if (sflags & SVp_NOK) {
3515 SvNV_set(dstr, SvNVX(sstr));
3519 if (dtype == SVt_PVGV) {
3520 if (ckWARN(WARN_MISC))
3521 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3524 (void)SvOK_off(dstr);
3526 if (SvTAINTED(sstr))
3531 =for apidoc sv_setsv_mg
3533 Like C<sv_setsv>, but also handles 'set' magic.
3539 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3541 sv_setsv(dstr,sstr);
3545 #ifdef PERL_OLD_COPY_ON_WRITE
3547 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3549 STRLEN cur = SvCUR(sstr);
3550 STRLEN len = SvLEN(sstr);
3551 register char *new_pv;
3554 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3562 if (SvTHINKFIRST(dstr))
3563 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3564 else if (SvPVX_const(dstr))
3565 Safefree(SvPVX_const(dstr));
3569 SvUPGRADE(dstr, SVt_PVIV);
3571 assert (SvPOK(sstr));
3572 assert (SvPOKp(sstr));
3573 assert (!SvIOK(sstr));
3574 assert (!SvIOKp(sstr));
3575 assert (!SvNOK(sstr));
3576 assert (!SvNOKp(sstr));
3578 if (SvIsCOW(sstr)) {
3580 if (SvLEN(sstr) == 0) {
3581 /* source is a COW shared hash key. */
3582 DEBUG_C(PerlIO_printf(Perl_debug_log,
3583 "Fast copy on write: Sharing hash\n"));
3584 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3587 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3589 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3590 SvUPGRADE(sstr, SVt_PVIV);
3591 SvREADONLY_on(sstr);
3593 DEBUG_C(PerlIO_printf(Perl_debug_log,
3594 "Fast copy on write: Converting sstr to COW\n"));
3595 SV_COW_NEXT_SV_SET(dstr, sstr);
3597 SV_COW_NEXT_SV_SET(sstr, dstr);
3598 new_pv = SvPVX_mutable(sstr);
3601 SvPV_set(dstr, new_pv);
3602 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3605 SvLEN_set(dstr, len);
3606 SvCUR_set(dstr, cur);
3615 =for apidoc sv_setpvn
3617 Copies a string into an SV. The C<len> parameter indicates the number of
3618 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3619 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3625 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3628 register char *dptr;
3630 SV_CHECK_THINKFIRST_COW_DROP(sv);
3636 /* len is STRLEN which is unsigned, need to copy to signed */
3639 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3641 SvUPGRADE(sv, SVt_PV);
3643 dptr = SvGROW(sv, len + 1);
3644 Move(ptr,dptr,len,char);
3647 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3652 =for apidoc sv_setpvn_mg
3654 Like C<sv_setpvn>, but also handles 'set' magic.
3660 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3662 sv_setpvn(sv,ptr,len);
3667 =for apidoc sv_setpv
3669 Copies a string into an SV. The string must be null-terminated. Does not
3670 handle 'set' magic. See C<sv_setpv_mg>.
3676 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3679 register STRLEN len;
3681 SV_CHECK_THINKFIRST_COW_DROP(sv);
3687 SvUPGRADE(sv, SVt_PV);
3689 SvGROW(sv, len + 1);
3690 Move(ptr,SvPVX(sv),len+1,char);
3692 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3697 =for apidoc sv_setpv_mg
3699 Like C<sv_setpv>, but also handles 'set' magic.
3705 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3712 =for apidoc sv_usepvn
3714 Tells an SV to use C<ptr> to find its string value. Normally the string is
3715 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3716 The C<ptr> should point to memory that was allocated by C<malloc>. The
3717 string length, C<len>, must be supplied. This function will realloc the
3718 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3719 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3720 See C<sv_usepvn_mg>.
3726 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3730 SV_CHECK_THINKFIRST_COW_DROP(sv);
3731 SvUPGRADE(sv, SVt_PV);
3736 if (SvPVX_const(sv))
3739 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3740 ptr = saferealloc (ptr, allocate);
3743 SvLEN_set(sv, allocate);
3745 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3750 =for apidoc sv_usepvn_mg
3752 Like C<sv_usepvn>, but also handles 'set' magic.
3758 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3760 sv_usepvn(sv,ptr,len);
3764 #ifdef PERL_OLD_COPY_ON_WRITE
3765 /* Need to do this *after* making the SV normal, as we need the buffer
3766 pointer to remain valid until after we've copied it. If we let go too early,
3767 another thread could invalidate it by unsharing last of the same hash key
3768 (which it can do by means other than releasing copy-on-write Svs)
3769 or by changing the other copy-on-write SVs in the loop. */
3771 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3773 if (len) { /* this SV was SvIsCOW_normal(sv) */
3774 /* we need to find the SV pointing to us. */
3775 SV *current = SV_COW_NEXT_SV(after);
3777 if (current == sv) {
3778 /* The SV we point to points back to us (there were only two of us
3780 Hence other SV is no longer copy on write either. */
3782 SvREADONLY_off(after);
3784 /* We need to follow the pointers around the loop. */
3786 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3789 /* don't loop forever if the structure is bust, and we have
3790 a pointer into a closed loop. */
3791 assert (current != after);
3792 assert (SvPVX_const(current) == pvx);
3794 /* Make the SV before us point to the SV after us. */
3795 SV_COW_NEXT_SV_SET(current, after);
3798 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3803 Perl_sv_release_IVX(pTHX_ register SV *sv)
3806 sv_force_normal_flags(sv, 0);
3812 =for apidoc sv_force_normal_flags
3814 Undo various types of fakery on an SV: if the PV is a shared string, make
3815 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3816 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3817 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3818 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3819 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3820 set to some other value.) In addition, the C<flags> parameter gets passed to
3821 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3822 with flags set to 0.
3828 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3831 #ifdef PERL_OLD_COPY_ON_WRITE
3832 if (SvREADONLY(sv)) {
3833 /* At this point I believe I should acquire a global SV mutex. */
3835 const char * const pvx = SvPVX_const(sv);
3836 const STRLEN len = SvLEN(sv);
3837 const STRLEN cur = SvCUR(sv);
3838 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3840 PerlIO_printf(Perl_debug_log,
3841 "Copy on write: Force normal %ld\n",
3847 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3850 if (flags & SV_COW_DROP_PV) {
3851 /* OK, so we don't need to copy our buffer. */
3854 SvGROW(sv, cur + 1);
3855 Move(pvx,SvPVX(sv),cur,char);
3859 sv_release_COW(sv, pvx, len, next);
3864 else if (IN_PERL_RUNTIME)
3865 Perl_croak(aTHX_ PL_no_modify);
3866 /* At this point I believe that I can drop the global SV mutex. */
3869 if (SvREADONLY(sv)) {
3871 const char * const pvx = SvPVX_const(sv);
3872 const STRLEN len = SvCUR(sv);
3877 SvGROW(sv, len + 1);
3878 Move(pvx,SvPVX(sv),len,char);
3880 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3882 else if (IN_PERL_RUNTIME)
3883 Perl_croak(aTHX_ PL_no_modify);
3887 sv_unref_flags(sv, flags);
3888 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3895 Efficient removal of characters from the beginning of the string buffer.
3896 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3897 the string buffer. The C<ptr> becomes the first character of the adjusted
3898 string. Uses the "OOK hack".
3899 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3900 refer to the same chunk of data.
3906 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3908 register STRLEN delta;
3909 if (!ptr || !SvPOKp(sv))
3911 delta = ptr - SvPVX_const(sv);
3912 SV_CHECK_THINKFIRST(sv);
3913 if (SvTYPE(sv) < SVt_PVIV)
3914 sv_upgrade(sv,SVt_PVIV);
3917 if (!SvLEN(sv)) { /* make copy of shared string */
3918 const char *pvx = SvPVX_const(sv);
3919 const STRLEN len = SvCUR(sv);
3920 SvGROW(sv, len + 1);
3921 Move(pvx,SvPVX(sv),len,char);
3925 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3926 and we do that anyway inside the SvNIOK_off
3928 SvFLAGS(sv) |= SVf_OOK;
3931 SvLEN_set(sv, SvLEN(sv) - delta);
3932 SvCUR_set(sv, SvCUR(sv) - delta);
3933 SvPV_set(sv, SvPVX(sv) + delta);
3934 SvIV_set(sv, SvIVX(sv) + delta);
3938 =for apidoc sv_catpvn
3940 Concatenates the string onto the end of the string which is in the SV. The
3941 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3942 status set, then the bytes appended should be valid UTF-8.
3943 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3945 =for apidoc sv_catpvn_flags
3947 Concatenates the string onto the end of the string which is in the SV. The
3948 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3949 status set, then the bytes appended should be valid UTF-8.
3950 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3951 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3952 in terms of this function.
3958 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3962 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3964 SvGROW(dsv, dlen + slen + 1);
3966 sstr = SvPVX_const(dsv);
3967 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3968 SvCUR_set(dsv, SvCUR(dsv) + slen);
3970 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3972 if (flags & SV_SMAGIC)
3977 =for apidoc sv_catsv
3979 Concatenates the string from SV C<ssv> onto the end of the string in
3980 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3981 not 'set' magic. See C<sv_catsv_mg>.
3983 =for apidoc sv_catsv_flags
3985 Concatenates the string from SV C<ssv> onto the end of the string in
3986 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3987 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3988 and C<sv_catsv_nomg> are implemented in terms of this function.
3993 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3998 const char *spv = SvPV_const(ssv, slen);
4000 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4001 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4002 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4003 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4004 dsv->sv_flags doesn't have that bit set.
4005 Andy Dougherty 12 Oct 2001
4007 const I32 sutf8 = DO_UTF8(ssv);
4010 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4012 dutf8 = DO_UTF8(dsv);
4014 if (dutf8 != sutf8) {
4016 /* Not modifying source SV, so taking a temporary copy. */
4017 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4019 sv_utf8_upgrade(csv);
4020 spv = SvPV_const(csv, slen);
4023 sv_utf8_upgrade_nomg(dsv);
4025 sv_catpvn_nomg(dsv, spv, slen);
4028 if (flags & SV_SMAGIC)
4033 =for apidoc sv_catpv
4035 Concatenates the string onto the end of the string which is in the SV.
4036 If the SV has the UTF-8 status set, then the bytes appended should be
4037 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4042 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4045 register STRLEN len;
4051 junk = SvPV_force(sv, tlen);
4053 SvGROW(sv, tlen + len + 1);
4055 ptr = SvPVX_const(sv);
4056 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4057 SvCUR_set(sv, SvCUR(sv) + len);
4058 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4063 =for apidoc sv_catpv_mg
4065 Like C<sv_catpv>, but also handles 'set' magic.
4071 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4080 Creates a new SV. A non-zero C<len> parameter indicates the number of
4081 bytes of preallocated string space the SV should have. An extra byte for a
4082 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4083 space is allocated.) The reference count for the new SV is set to 1.
4085 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4086 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4087 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4088 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4089 modules supporting older perls.
4095 Perl_newSV(pTHX_ STRLEN len)
4102 sv_upgrade(sv, SVt_PV);
4103 SvGROW(sv, len + 1);
4108 =for apidoc sv_magicext
4110 Adds magic to an SV, upgrading it if necessary. Applies the
4111 supplied vtable and returns a pointer to the magic added.
4113 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4114 In particular, you can add magic to SvREADONLY SVs, and add more than
4115 one instance of the same 'how'.
4117 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4118 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4119 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4120 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4122 (This is now used as a subroutine by C<sv_magic>.)
4127 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4128 const char* name, I32 namlen)
4133 if (SvTYPE(sv) < SVt_PVMG) {
4134 SvUPGRADE(sv, SVt_PVMG);
4136 Newxz(mg, 1, MAGIC);
4137 mg->mg_moremagic = SvMAGIC(sv);
4138 SvMAGIC_set(sv, mg);
4140 /* Sometimes a magic contains a reference loop, where the sv and
4141 object refer to each other. To prevent a reference loop that
4142 would prevent such objects being freed, we look for such loops
4143 and if we find one we avoid incrementing the object refcount.
4145 Note we cannot do this to avoid self-tie loops as intervening RV must
4146 have its REFCNT incremented to keep it in existence.
4149 if (!obj || obj == sv ||
4150 how == PERL_MAGIC_arylen ||
4151 how == PERL_MAGIC_qr ||
4152 how == PERL_MAGIC_symtab ||
4153 (SvTYPE(obj) == SVt_PVGV &&
4154 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4155 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4156 GvFORM(obj) == (CV*)sv)))
4161 mg->mg_obj = SvREFCNT_inc(obj);
4162 mg->mg_flags |= MGf_REFCOUNTED;
4165 /* Normal self-ties simply pass a null object, and instead of
4166 using mg_obj directly, use the SvTIED_obj macro to produce a
4167 new RV as needed. For glob "self-ties", we are tieing the PVIO
4168 with an RV obj pointing to the glob containing the PVIO. In
4169 this case, to avoid a reference loop, we need to weaken the
4173 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4174 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4180 mg->mg_len = namlen;
4183 mg->mg_ptr = savepvn(name, namlen);
4184 else if (namlen == HEf_SVKEY)
4185 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4187 mg->mg_ptr = (char *) name;
4189 mg->mg_virtual = vtable;
4193 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4198 =for apidoc sv_magic
4200 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4201 then adds a new magic item of type C<how> to the head of the magic list.
4203 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4204 handling of the C<name> and C<namlen> arguments.
4206 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4207 to add more than one instance of the same 'how'.
4213 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4219 #ifdef PERL_OLD_COPY_ON_WRITE
4221 sv_force_normal_flags(sv, 0);
4223 if (SvREADONLY(sv)) {
4225 /* its okay to attach magic to shared strings; the subsequent
4226 * upgrade to PVMG will unshare the string */
4227 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4230 && how != PERL_MAGIC_regex_global
4231 && how != PERL_MAGIC_bm
4232 && how != PERL_MAGIC_fm
4233 && how != PERL_MAGIC_sv
4234 && how != PERL_MAGIC_backref
4237 Perl_croak(aTHX_ PL_no_modify);
4240 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4241 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4242 /* sv_magic() refuses to add a magic of the same 'how' as an
4245 if (how == PERL_MAGIC_taint) {
4247 /* Any scalar which already had taint magic on which someone
4248 (erroneously?) did SvIOK_on() or similar will now be
4249 incorrectly sporting public "OK" flags. */
4250 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4258 vtable = &PL_vtbl_sv;
4260 case PERL_MAGIC_overload:
4261 vtable = &PL_vtbl_amagic;
4263 case PERL_MAGIC_overload_elem:
4264 vtable = &PL_vtbl_amagicelem;
4266 case PERL_MAGIC_overload_table:
4267 vtable = &PL_vtbl_ovrld;
4270 vtable = &PL_vtbl_bm;
4272 case PERL_MAGIC_regdata:
4273 vtable = &PL_vtbl_regdata;
4275 case PERL_MAGIC_regdatum:
4276 vtable = &PL_vtbl_regdatum;
4278 case PERL_MAGIC_env:
4279 vtable = &PL_vtbl_env;
4282 vtable = &PL_vtbl_fm;
4284 case PERL_MAGIC_envelem:
4285 vtable = &PL_vtbl_envelem;
4287 case PERL_MAGIC_regex_global:
4288 vtable = &PL_vtbl_mglob;
4290 case PERL_MAGIC_isa:
4291 vtable = &PL_vtbl_isa;
4293 case PERL_MAGIC_isaelem:
4294 vtable = &PL_vtbl_isaelem;
4296 case PERL_MAGIC_nkeys:
4297 vtable = &PL_vtbl_nkeys;
4299 case PERL_MAGIC_dbfile:
4302 case PERL_MAGIC_dbline:
4303 vtable = &PL_vtbl_dbline;
4305 #ifdef USE_LOCALE_COLLATE
4306 case PERL_MAGIC_collxfrm:
4307 vtable = &PL_vtbl_collxfrm;
4309 #endif /* USE_LOCALE_COLLATE */
4310 case PERL_MAGIC_tied:
4311 vtable = &PL_vtbl_pack;
4313 case PERL_MAGIC_tiedelem:
4314 case PERL_MAGIC_tiedscalar:
4315 vtable = &PL_vtbl_packelem;
4318 vtable = &PL_vtbl_regexp;
4320 case PERL_MAGIC_sig:
4321 vtable = &PL_vtbl_sig;
4323 case PERL_MAGIC_sigelem:
4324 vtable = &PL_vtbl_sigelem;
4326 case PERL_MAGIC_taint:
4327 vtable = &PL_vtbl_taint;
4329 case PERL_MAGIC_uvar:
4330 vtable = &PL_vtbl_uvar;
4332 case PERL_MAGIC_vec:
4333 vtable = &PL_vtbl_vec;
4335 case PERL_MAGIC_arylen_p:
4336 case PERL_MAGIC_rhash:
4337 case PERL_MAGIC_symtab:
4338 case PERL_MAGIC_vstring:
4341 case PERL_MAGIC_utf8:
4342 vtable = &PL_vtbl_utf8;
4344 case PERL_MAGIC_substr:
4345 vtable = &PL_vtbl_substr;
4347 case PERL_MAGIC_defelem:
4348 vtable = &PL_vtbl_defelem;
4350 case PERL_MAGIC_glob:
4351 vtable = &PL_vtbl_glob;
4353 case PERL_MAGIC_arylen:
4354 vtable = &PL_vtbl_arylen;
4356 case PERL_MAGIC_pos:
4357 vtable = &PL_vtbl_pos;
4359 case PERL_MAGIC_backref:
4360 vtable = &PL_vtbl_backref;
4362 case PERL_MAGIC_ext:
4363 /* Reserved for use by extensions not perl internals. */
4364 /* Useful for attaching extension internal data to perl vars. */
4365 /* Note that multiple extensions may clash if magical scalars */
4366 /* etc holding private data from one are passed to another. */
4370 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4373 /* Rest of work is done else where */
4374 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4377 case PERL_MAGIC_taint:
4380 case PERL_MAGIC_ext:
4381 case PERL_MAGIC_dbfile:
4388 =for apidoc sv_unmagic
4390 Removes all magic of type C<type> from an SV.
4396 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4400 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4403 for (mg = *mgp; mg; mg = *mgp) {
4404 if (mg->mg_type == type) {
4405 const MGVTBL* const vtbl = mg->mg_virtual;
4406 *mgp = mg->mg_moremagic;
4407 if (vtbl && vtbl->svt_free)
4408 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4409 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4411 Safefree(mg->mg_ptr);
4412 else if (mg->mg_len == HEf_SVKEY)
4413 SvREFCNT_dec((SV*)mg->mg_ptr);
4414 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4415 Safefree(mg->mg_ptr);
4417 if (mg->mg_flags & MGf_REFCOUNTED)
4418 SvREFCNT_dec(mg->mg_obj);
4422 mgp = &mg->mg_moremagic;
4426 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4427 SvMAGIC_set(sv, NULL);
4434 =for apidoc sv_rvweaken
4436 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4437 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4438 push a back-reference to this RV onto the array of backreferences
4439 associated with that magic.
4445 Perl_sv_rvweaken(pTHX_ SV *sv)
4448 if (!SvOK(sv)) /* let undefs pass */
4451 Perl_croak(aTHX_ "Can't weaken a nonreference");
4452 else if (SvWEAKREF(sv)) {
4453 if (ckWARN(WARN_MISC))
4454 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4458 Perl_sv_add_backref(aTHX_ tsv, sv);
4464 /* Give tsv backref magic if it hasn't already got it, then push a
4465 * back-reference to sv onto the array associated with the backref magic.
4469 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4474 if (SvTYPE(tsv) == SVt_PVHV) {
4475 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4479 /* There is no AV in the offical place - try a fixup. */
4480 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4483 /* Aha. They've got it stowed in magic. Bring it back. */
4484 av = (AV*)mg->mg_obj;
4485 /* Stop mg_free decreasing the refernce count. */
4487 /* Stop mg_free even calling the destructor, given that
4488 there's no AV to free up. */
4490 sv_unmagic(tsv, PERL_MAGIC_backref);
4499 const MAGIC *const mg
4500 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4502 av = (AV*)mg->mg_obj;
4506 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4507 /* av now has a refcnt of 2, which avoids it getting freed
4508 * before us during global cleanup. The extra ref is removed
4509 * by magic_killbackrefs() when tsv is being freed */
4512 if (AvFILLp(av) >= AvMAX(av)) {
4513 av_extend(av, AvFILLp(av)+1);
4515 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4518 /* delete a back-reference to ourselves from the backref magic associated
4519 * with the SV we point to.
4523 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4530 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4531 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4532 /* We mustn't attempt to "fix up" the hash here by moving the
4533 backreference array back to the hv_aux structure, as that is stored
4534 in the main HvARRAY(), and hfreentries assumes that no-one
4535 reallocates HvARRAY() while it is running. */
4538 const MAGIC *const mg
4539 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4541 av = (AV *)mg->mg_obj;
4544 if (PL_in_clean_all)
4546 Perl_croak(aTHX_ "panic: del_backref");
4553 /* We shouldn't be in here more than once, but for paranoia reasons lets
4555 for (i = AvFILLp(av); i >= 0; i--) {
4557 const SSize_t fill = AvFILLp(av);
4559 /* We weren't the last entry.
4560 An unordered list has this property that you can take the
4561 last element off the end to fill the hole, and it's still
4562 an unordered list :-)
4567 AvFILLp(av) = fill - 1;
4573 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4575 SV **svp = AvARRAY(av);
4577 PERL_UNUSED_ARG(sv);
4579 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4580 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4581 if (svp && !SvIS_FREED(av)) {
4582 SV *const *const last = svp + AvFILLp(av);
4584 while (svp <= last) {
4586 SV *const referrer = *svp;
4587 if (SvWEAKREF(referrer)) {
4588 /* XXX Should we check that it hasn't changed? */
4589 SvRV_set(referrer, 0);
4591 SvWEAKREF_off(referrer);
4592 } else if (SvTYPE(referrer) == SVt_PVGV ||
4593 SvTYPE(referrer) == SVt_PVLV) {
4594 /* You lookin' at me? */
4595 assert(GvSTASH(referrer));
4596 assert(GvSTASH(referrer) == (HV*)sv);
4597 GvSTASH(referrer) = 0;
4600 "panic: magic_killbackrefs (flags=%"UVxf")",
4601 (UV)SvFLAGS(referrer));
4609 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4614 =for apidoc sv_insert
4616 Inserts a string at the specified offset/length within the SV. Similar to
4617 the Perl substr() function.
4623 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4628 register char *midend;
4629 register char *bigend;
4635 Perl_croak(aTHX_ "Can't modify non-existent substring");
4636 SvPV_force(bigstr, curlen);
4637 (void)SvPOK_only_UTF8(bigstr);
4638 if (offset + len > curlen) {
4639 SvGROW(bigstr, offset+len+1);
4640 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4641 SvCUR_set(bigstr, offset+len);
4645 i = littlelen - len;
4646 if (i > 0) { /* string might grow */
4647 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4648 mid = big + offset + len;
4649 midend = bigend = big + SvCUR(bigstr);
4652 while (midend > mid) /* shove everything down */
4653 *--bigend = *--midend;
4654 Move(little,big+offset,littlelen,char);
4655 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4660 Move(little,SvPVX(bigstr)+offset,len,char);
4665 big = SvPVX(bigstr);
4668 bigend = big + SvCUR(bigstr);
4670 if (midend > bigend)
4671 Perl_croak(aTHX_ "panic: sv_insert");
4673 if (mid - big > bigend - midend) { /* faster to shorten from end */
4675 Move(little, mid, littlelen,char);
4678 i = bigend - midend;
4680 Move(midend, mid, i,char);
4684 SvCUR_set(bigstr, mid - big);
4686 else if ((i = mid - big)) { /* faster from front */
4687 midend -= littlelen;
4689 sv_chop(bigstr,midend-i);
4694 Move(little, mid, littlelen,char);
4696 else if (littlelen) {
4697 midend -= littlelen;
4698 sv_chop(bigstr,midend);
4699 Move(little,midend,littlelen,char);
4702 sv_chop(bigstr,midend);
4708 =for apidoc sv_replace
4710 Make the first argument a copy of the second, then delete the original.
4711 The target SV physically takes over ownership of the body of the source SV
4712 and inherits its flags; however, the target keeps any magic it owns,
4713 and any magic in the source is discarded.
4714 Note that this is a rather specialist SV copying operation; most of the
4715 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4721 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4724 const U32 refcnt = SvREFCNT(sv);
4725 SV_CHECK_THINKFIRST_COW_DROP(sv);
4726 if (SvREFCNT(nsv) != 1) {
4727 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4728 UVuf " != 1)", (UV) SvREFCNT(nsv));
4730 if (SvMAGICAL(sv)) {
4734 sv_upgrade(nsv, SVt_PVMG);
4735 SvMAGIC_set(nsv, SvMAGIC(sv));
4736 SvFLAGS(nsv) |= SvMAGICAL(sv);
4738 SvMAGIC_set(sv, NULL);
4742 assert(!SvREFCNT(sv));
4743 #ifdef DEBUG_LEAKING_SCALARS
4744 sv->sv_flags = nsv->sv_flags;
4745 sv->sv_any = nsv->sv_any;
4746 sv->sv_refcnt = nsv->sv_refcnt;
4747 sv->sv_u = nsv->sv_u;
4749 StructCopy(nsv,sv,SV);
4751 /* Currently could join these into one piece of pointer arithmetic, but
4752 it would be unclear. */
4753 if(SvTYPE(sv) == SVt_IV)
4755 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4756 else if (SvTYPE(sv) == SVt_RV) {
4757 SvANY(sv) = &sv->sv_u.svu_rv;
4761 #ifdef PERL_OLD_COPY_ON_WRITE
4762 if (SvIsCOW_normal(nsv)) {
4763 /* We need to follow the pointers around the loop to make the
4764 previous SV point to sv, rather than nsv. */
4767 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4770 assert(SvPVX_const(current) == SvPVX_const(nsv));
4772 /* Make the SV before us point to the SV after us. */
4774 PerlIO_printf(Perl_debug_log, "previous is\n");
4776 PerlIO_printf(Perl_debug_log,
4777 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4778 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4780 SV_COW_NEXT_SV_SET(current, sv);
4783 SvREFCNT(sv) = refcnt;
4784 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4790 =for apidoc sv_clear
4792 Clear an SV: call any destructors, free up any memory used by the body,
4793 and free the body itself. The SV's head is I<not> freed, although
4794 its type is set to all 1's so that it won't inadvertently be assumed
4795 to be live during global destruction etc.
4796 This function should only be called when REFCNT is zero. Most of the time
4797 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4804 Perl_sv_clear(pTHX_ register SV *sv)
4807 const U32 type = SvTYPE(sv);
4808 const struct body_details *const sv_type_details
4809 = bodies_by_type + type;
4812 assert(SvREFCNT(sv) == 0);
4818 if (PL_defstash) { /* Still have a symbol table? */
4823 stash = SvSTASH(sv);
4824 destructor = StashHANDLER(stash,DESTROY);
4826 SV* const tmpref = newRV(sv);
4827 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4829 PUSHSTACKi(PERLSI_DESTROY);
4834 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4840 if(SvREFCNT(tmpref) < 2) {
4841 /* tmpref is not kept alive! */
4843 SvRV_set(tmpref, NULL);
4846 SvREFCNT_dec(tmpref);
4848 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4852 if (PL_in_clean_objs)
4853 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4855 /* DESTROY gave object new lease on life */
4861 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4862 SvOBJECT_off(sv); /* Curse the object. */
4863 if (type != SVt_PVIO)
4864 --PL_sv_objcount; /* XXX Might want something more general */
4867 if (type >= SVt_PVMG) {
4870 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4871 SvREFCNT_dec(SvSTASH(sv));
4876 IoIFP(sv) != PerlIO_stdin() &&
4877 IoIFP(sv) != PerlIO_stdout() &&
4878 IoIFP(sv) != PerlIO_stderr())
4880 io_close((IO*)sv, FALSE);
4882 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4883 PerlDir_close(IoDIRP(sv));
4884 IoDIRP(sv) = (DIR*)NULL;
4885 Safefree(IoTOP_NAME(sv));
4886 Safefree(IoFMT_NAME(sv));
4887 Safefree(IoBOTTOM_NAME(sv));
4896 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4903 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4904 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4905 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4906 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4908 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4909 SvREFCNT_dec(LvTARG(sv));
4913 Safefree(GvNAME(sv));
4914 /* If we're in a stash, we don't own a reference to it. However it does
4915 have a back reference to us, which needs to be cleared. */
4917 sv_del_backref((SV*)GvSTASH(sv), sv);
4922 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4924 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4925 /* Don't even bother with turning off the OOK flag. */
4930 SV *target = SvRV(sv);
4932 sv_del_backref(target, sv);
4934 SvREFCNT_dec(target);
4936 #ifdef PERL_OLD_COPY_ON_WRITE
4937 else if (SvPVX_const(sv)) {
4939 /* I believe I need to grab the global SV mutex here and
4940 then recheck the COW status. */
4942 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4945 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4946 SV_COW_NEXT_SV(sv));
4947 /* And drop it here. */
4949 } else if (SvLEN(sv)) {
4950 Safefree(SvPVX_const(sv));
4954 else if (SvPVX_const(sv) && SvLEN(sv))
4955 Safefree(SvPVX_mutable(sv));
4956 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4957 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4966 SvFLAGS(sv) &= SVf_BREAK;
4967 SvFLAGS(sv) |= SVTYPEMASK;
4969 if (sv_type_details->arena) {
4970 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4971 &PL_body_roots[type]);
4973 else if (sv_type_details->size) {
4974 my_safefree(SvANY(sv));
4979 =for apidoc sv_newref
4981 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4988 Perl_sv_newref(pTHX_ SV *sv)
4998 Decrement an SV's reference count, and if it drops to zero, call
4999 C<sv_clear> to invoke destructors and free up any memory used by
5000 the body; finally, deallocate the SV's head itself.
5001 Normally called via a wrapper macro C<SvREFCNT_dec>.
5007 Perl_sv_free(pTHX_ SV *sv)
5012 if (SvREFCNT(sv) == 0) {
5013 if (SvFLAGS(sv) & SVf_BREAK)
5014 /* this SV's refcnt has been artificially decremented to
5015 * trigger cleanup */
5017 if (PL_in_clean_all) /* All is fair */
5019 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5020 /* make sure SvREFCNT(sv)==0 happens very seldom */
5021 SvREFCNT(sv) = (~(U32)0)/2;
5024 if (ckWARN_d(WARN_INTERNAL)) {
5025 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5026 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5027 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5028 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5029 Perl_dump_sv_child(aTHX_ sv);
5034 if (--(SvREFCNT(sv)) > 0)
5036 Perl_sv_free2(aTHX_ sv);
5040 Perl_sv_free2(pTHX_ SV *sv)
5045 if (ckWARN_d(WARN_DEBUGGING))
5046 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5047 "Attempt to free temp prematurely: SV 0x%"UVxf
5048 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5052 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5053 /* make sure SvREFCNT(sv)==0 happens very seldom */
5054 SvREFCNT(sv) = (~(U32)0)/2;
5065 Returns the length of the string in the SV. Handles magic and type
5066 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5072 Perl_sv_len(pTHX_ register SV *sv)
5080 len = mg_length(sv);
5082 (void)SvPV_const(sv, len);
5087 =for apidoc sv_len_utf8
5089 Returns the number of characters in the string in an SV, counting wide
5090 UTF-8 bytes as a single character. Handles magic and type coercion.
5096 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5097 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5098 * (Note that the mg_len is not the length of the mg_ptr field.)
5103 Perl_sv_len_utf8(pTHX_ register SV *sv)
5109 return mg_length(sv);
5113 const U8 *s = (U8*)SvPV_const(sv, len);
5114 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5116 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5118 #ifdef PERL_UTF8_CACHE_ASSERT
5119 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5123 ulen = Perl_utf8_length(aTHX_ s, s + len);
5124 if (!mg && !SvREADONLY(sv)) {
5125 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5126 mg = mg_find(sv, PERL_MAGIC_utf8);
5136 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5137 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5138 * between UTF-8 and byte offsets. There are two (substr offset and substr
5139 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5140 * and byte offset) cache positions.
5142 * The mg_len field is used by sv_len_utf8(), see its comments.
5143 * Note that the mg_len is not the length of the mg_ptr field.
5147 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5148 I32 offsetp, const U8 *s, const U8 *start)
5152 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5154 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5158 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5160 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5161 (*mgp)->mg_ptr = (char *) *cachep;
5165 (*cachep)[i] = offsetp;
5166 (*cachep)[i+1] = s - start;
5174 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5175 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5176 * between UTF-8 and byte offsets. See also the comments of
5177 * S_utf8_mg_pos_init().
5181 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, const U8 **sp, const U8 *start, const U8 *send)
5185 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5187 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5188 if (*mgp && (*mgp)->mg_ptr) {
5189 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5190 ASSERT_UTF8_CACHE(*cachep);
5191 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5193 else { /* We will skip to the right spot. */
5198 /* The assumption is that going backward is half
5199 * the speed of going forward (that's where the
5200 * 2 * backw in the below comes from). (The real
5201 * figure of course depends on the UTF-8 data.) */
5203 if ((*cachep)[i] > (STRLEN)uoff) {
5205 backw = (*cachep)[i] - (STRLEN)uoff;
5207 if (forw < 2 * backw)
5210 p = start + (*cachep)[i+1];
5212 /* Try this only for the substr offset (i == 0),
5213 * not for the substr length (i == 2). */
5214 else if (i == 0) { /* (*cachep)[i] < uoff */
5215 const STRLEN ulen = sv_len_utf8(sv);
5217 if ((STRLEN)uoff < ulen) {
5218 forw = (STRLEN)uoff - (*cachep)[i];
5219 backw = ulen - (STRLEN)uoff;
5221 if (forw < 2 * backw)
5222 p = start + (*cachep)[i+1];
5227 /* If the string is not long enough for uoff,
5228 * we could extend it, but not at this low a level. */
5232 if (forw < 2 * backw) {
5239 while (UTF8_IS_CONTINUATION(*p))
5244 /* Update the cache. */
5245 (*cachep)[i] = (STRLEN)uoff;
5246 (*cachep)[i+1] = p - start;
5248 /* Drop the stale "length" cache */
5257 if (found) { /* Setup the return values. */
5258 *offsetp = (*cachep)[i+1];
5259 *sp = start + *offsetp;
5262 *offsetp = send - start;
5264 else if (*sp < start) {
5270 #ifdef PERL_UTF8_CACHE_ASSERT
5275 while (n-- && s < send)
5279 assert(*offsetp == s - start);
5280 assert((*cachep)[0] == (STRLEN)uoff);
5281 assert((*cachep)[1] == *offsetp);
5283 ASSERT_UTF8_CACHE(*cachep);
5292 =for apidoc sv_pos_u2b
5294 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5295 the start of the string, to a count of the equivalent number of bytes; if
5296 lenp is non-zero, it does the same to lenp, but this time starting from
5297 the offset, rather than from the start of the string. Handles magic and
5304 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5305 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5306 * byte offsets. See also the comments of S_utf8_mg_pos().
5311 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5319 start = (U8*)SvPV_const(sv, len);
5322 STRLEN *cache = NULL;
5323 const U8 *s = start;
5324 I32 uoffset = *offsetp;
5325 const U8 * const send = s + len;
5327 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5329 if (!found && uoffset > 0) {
5330 while (s < send && uoffset--)
5334 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5336 *offsetp = s - start;
5341 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5345 if (!found && *lenp > 0) {
5348 while (s < send && ulen--)
5352 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5356 ASSERT_UTF8_CACHE(cache);
5368 =for apidoc sv_pos_b2u
5370 Converts the value pointed to by offsetp from a count of bytes from the
5371 start of the string, to a count of the equivalent number of UTF-8 chars.
5372 Handles magic and type coercion.
5378 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5379 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5380 * byte offsets. See also the comments of S_utf8_mg_pos().
5385 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5393 s = (const U8*)SvPV_const(sv, len);
5394 if ((I32)len < *offsetp)
5395 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5397 const U8* send = s + *offsetp;
5399 STRLEN *cache = NULL;
5403 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5404 mg = mg_find(sv, PERL_MAGIC_utf8);
5405 if (mg && mg->mg_ptr) {
5406 cache = (STRLEN *) mg->mg_ptr;
5407 if (cache[1] == (STRLEN)*offsetp) {
5408 /* An exact match. */
5409 *offsetp = cache[0];
5413 else if (cache[1] < (STRLEN)*offsetp) {
5414 /* We already know part of the way. */
5417 /* Let the below loop do the rest. */
5419 else { /* cache[1] > *offsetp */
5420 /* We already know all of the way, now we may
5421 * be able to walk back. The same assumption
5422 * is made as in S_utf8_mg_pos(), namely that
5423 * walking backward is twice slower than
5424 * walking forward. */
5425 const STRLEN forw = *offsetp;
5426 STRLEN backw = cache[1] - *offsetp;
5428 if (!(forw < 2 * backw)) {
5429 const U8 *p = s + cache[1];
5436 while (UTF8_IS_CONTINUATION(*p)) {
5444 *offsetp = cache[0];
5446 /* Drop the stale "length" cache */
5454 ASSERT_UTF8_CACHE(cache);
5460 /* Call utf8n_to_uvchr() to validate the sequence
5461 * (unless a simple non-UTF character) */
5462 if (!UTF8_IS_INVARIANT(*s))
5463 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5472 if (!SvREADONLY(sv)) {
5474 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5475 mg = mg_find(sv, PERL_MAGIC_utf8);
5480 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5481 mg->mg_ptr = (char *) cache;
5486 cache[1] = *offsetp;
5487 /* Drop the stale "length" cache */
5500 Returns a boolean indicating whether the strings in the two SVs are
5501 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5502 coerce its args to strings if necessary.
5508 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5517 SV* svrecode = NULL;
5524 pv1 = SvPV_const(sv1, cur1);
5531 pv2 = SvPV_const(sv2, cur2);
5533 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5534 /* Differing utf8ness.
5535 * Do not UTF8size the comparands as a side-effect. */
5538 svrecode = newSVpvn(pv2, cur2);
5539 sv_recode_to_utf8(svrecode, PL_encoding);
5540 pv2 = SvPV_const(svrecode, cur2);
5543 svrecode = newSVpvn(pv1, cur1);
5544 sv_recode_to_utf8(svrecode, PL_encoding);
5545 pv1 = SvPV_const(svrecode, cur1);
5547 /* Now both are in UTF-8. */
5549 SvREFCNT_dec(svrecode);
5554 bool is_utf8 = TRUE;
5557 /* sv1 is the UTF-8 one,
5558 * if is equal it must be downgrade-able */
5559 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5565 /* sv2 is the UTF-8 one,
5566 * if is equal it must be downgrade-able */
5567 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5573 /* Downgrade not possible - cannot be eq */
5581 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5584 SvREFCNT_dec(svrecode);
5595 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5596 string in C<sv1> is less than, equal to, or greater than the string in
5597 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5598 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5604 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5608 const char *pv1, *pv2;
5611 SV *svrecode = NULL;
5618 pv1 = SvPV_const(sv1, cur1);
5625 pv2 = SvPV_const(sv2, cur2);
5627 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5628 /* Differing utf8ness.
5629 * Do not UTF8size the comparands as a side-effect. */
5632 svrecode = newSVpvn(pv2, cur2);
5633 sv_recode_to_utf8(svrecode, PL_encoding);
5634 pv2 = SvPV_const(svrecode, cur2);
5637 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5642 svrecode = newSVpvn(pv1, cur1);
5643 sv_recode_to_utf8(svrecode, PL_encoding);
5644 pv1 = SvPV_const(svrecode, cur1);
5647 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5653 cmp = cur2 ? -1 : 0;
5657 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5660 cmp = retval < 0 ? -1 : 1;
5661 } else if (cur1 == cur2) {
5664 cmp = cur1 < cur2 ? -1 : 1;
5669 SvREFCNT_dec(svrecode);
5678 =for apidoc sv_cmp_locale
5680 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5681 'use bytes' aware, handles get magic, and will coerce its args to strings
5682 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5688 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5691 #ifdef USE_LOCALE_COLLATE
5697 if (PL_collation_standard)
5701 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5703 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5705 if (!pv1 || !len1) {
5716 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5719 return retval < 0 ? -1 : 1;
5722 * When the result of collation is equality, that doesn't mean
5723 * that there are no differences -- some locales exclude some
5724 * characters from consideration. So to avoid false equalities,
5725 * we use the raw string as a tiebreaker.
5731 #endif /* USE_LOCALE_COLLATE */
5733 return sv_cmp(sv1, sv2);
5737 #ifdef USE_LOCALE_COLLATE
5740 =for apidoc sv_collxfrm
5742 Add Collate Transform magic to an SV if it doesn't already have it.
5744 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5745 scalar data of the variable, but transformed to such a format that a normal
5746 memory comparison can be used to compare the data according to the locale
5753 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5758 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5759 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5765 Safefree(mg->mg_ptr);
5766 s = SvPV_const(sv, len);
5767 if ((xf = mem_collxfrm(s, len, &xlen))) {
5768 if (SvREADONLY(sv)) {
5771 return xf + sizeof(PL_collation_ix);
5774 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5775 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5788 if (mg && mg->mg_ptr) {
5790 return mg->mg_ptr + sizeof(PL_collation_ix);
5798 #endif /* USE_LOCALE_COLLATE */
5803 Get a line from the filehandle and store it into the SV, optionally
5804 appending to the currently-stored string.
5810 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5815 register STDCHAR rslast;
5816 register STDCHAR *bp;
5822 if (SvTHINKFIRST(sv))
5823 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5824 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5826 However, perlbench says it's slower, because the existing swipe code
5827 is faster than copy on write.
5828 Swings and roundabouts. */
5829 SvUPGRADE(sv, SVt_PV);
5834 if (PerlIO_isutf8(fp)) {
5836 sv_utf8_upgrade_nomg(sv);
5837 sv_pos_u2b(sv,&append,0);
5839 } else if (SvUTF8(sv)) {
5840 SV * const tsv = newSV(0);
5841 sv_gets(tsv, fp, 0);
5842 sv_utf8_upgrade_nomg(tsv);
5843 SvCUR_set(sv,append);
5846 goto return_string_or_null;
5851 if (PerlIO_isutf8(fp))
5854 if (IN_PERL_COMPILETIME) {
5855 /* we always read code in line mode */
5859 else if (RsSNARF(PL_rs)) {
5860 /* If it is a regular disk file use size from stat() as estimate
5861 of amount we are going to read - may result in malloc-ing
5862 more memory than we realy need if layers bellow reduce
5863 size we read (e.g. CRLF or a gzip layer)
5866 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5867 const Off_t offset = PerlIO_tell(fp);
5868 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5869 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5875 else if (RsRECORD(PL_rs)) {
5879 /* Grab the size of the record we're getting */
5880 recsize = SvIV(SvRV(PL_rs));
5881 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5884 /* VMS wants read instead of fread, because fread doesn't respect */
5885 /* RMS record boundaries. This is not necessarily a good thing to be */
5886 /* doing, but we've got no other real choice - except avoid stdio
5887 as implementation - perhaps write a :vms layer ?
5889 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5891 bytesread = PerlIO_read(fp, buffer, recsize);
5895 SvCUR_set(sv, bytesread += append);
5896 buffer[bytesread] = '\0';
5897 goto return_string_or_null;
5899 else if (RsPARA(PL_rs)) {
5905 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5906 if (PerlIO_isutf8(fp)) {
5907 rsptr = SvPVutf8(PL_rs, rslen);
5910 if (SvUTF8(PL_rs)) {
5911 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5912 Perl_croak(aTHX_ "Wide character in $/");
5915 rsptr = SvPV_const(PL_rs, rslen);
5919 rslast = rslen ? rsptr[rslen - 1] : '\0';
5921 if (rspara) { /* have to do this both before and after */
5922 do { /* to make sure file boundaries work right */
5925 i = PerlIO_getc(fp);
5929 PerlIO_ungetc(fp,i);
5935 /* See if we know enough about I/O mechanism to cheat it ! */
5937 /* This used to be #ifdef test - it is made run-time test for ease
5938 of abstracting out stdio interface. One call should be cheap
5939 enough here - and may even be a macro allowing compile
5943 if (PerlIO_fast_gets(fp)) {
5946 * We're going to steal some values from the stdio struct
5947 * and put EVERYTHING in the innermost loop into registers.
5949 register STDCHAR *ptr;
5953 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5954 /* An ungetc()d char is handled separately from the regular
5955 * buffer, so we getc() it back out and stuff it in the buffer.
5957 i = PerlIO_getc(fp);
5958 if (i == EOF) return 0;
5959 *(--((*fp)->_ptr)) = (unsigned char) i;
5963 /* Here is some breathtakingly efficient cheating */
5965 cnt = PerlIO_get_cnt(fp); /* get count into register */
5966 /* make sure we have the room */
5967 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5968 /* Not room for all of it
5969 if we are looking for a separator and room for some
5971 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5972 /* just process what we have room for */
5973 shortbuffered = cnt - SvLEN(sv) + append + 1;
5974 cnt -= shortbuffered;
5978 /* remember that cnt can be negative */
5979 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5984 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5985 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5986 DEBUG_P(PerlIO_printf(Perl_debug_log,
5987 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5988 DEBUG_P(PerlIO_printf(Perl_debug_log,
5989 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5990 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5991 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5996 while (cnt > 0) { /* this | eat */
5998 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5999 goto thats_all_folks; /* screams | sed :-) */
6003 Copy(ptr, bp, cnt, char); /* this | eat */
6004 bp += cnt; /* screams | dust */
6005 ptr += cnt; /* louder | sed :-) */
6010 if (shortbuffered) { /* oh well, must extend */
6011 cnt = shortbuffered;
6013 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6015 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6016 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6020 DEBUG_P(PerlIO_printf(Perl_debug_log,
6021 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6022 PTR2UV(ptr),(long)cnt));
6023 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6025 DEBUG_P(PerlIO_printf(Perl_debug_log,
6026 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6027 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6028 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6030 /* This used to call 'filbuf' in stdio form, but as that behaves like
6031 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6032 another abstraction. */
6033 i = PerlIO_getc(fp); /* get more characters */
6035 DEBUG_P(PerlIO_printf(Perl_debug_log,
6036 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6037 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6038 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6040 cnt = PerlIO_get_cnt(fp);
6041 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6042 DEBUG_P(PerlIO_printf(Perl_debug_log,
6043 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6045 if (i == EOF) /* all done for ever? */
6046 goto thats_really_all_folks;
6048 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6050 SvGROW(sv, bpx + cnt + 2);
6051 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6053 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6055 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6056 goto thats_all_folks;
6060 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6061 memNE((char*)bp - rslen, rsptr, rslen))
6062 goto screamer; /* go back to the fray */
6063 thats_really_all_folks:
6065 cnt += shortbuffered;
6066 DEBUG_P(PerlIO_printf(Perl_debug_log,
6067 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6068 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6069 DEBUG_P(PerlIO_printf(Perl_debug_log,
6070 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6071 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6072 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6074 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6075 DEBUG_P(PerlIO_printf(Perl_debug_log,
6076 "Screamer: done, len=%ld, string=|%.*s|\n",
6077 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6081 /*The big, slow, and stupid way. */
6082 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6083 STDCHAR *buf = NULL;
6084 Newx(buf, 8192, STDCHAR);
6092 register const STDCHAR * const bpe = buf + sizeof(buf);
6094 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6095 ; /* keep reading */
6099 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6100 /* Accomodate broken VAXC compiler, which applies U8 cast to
6101 * both args of ?: operator, causing EOF to change into 255
6104 i = (U8)buf[cnt - 1];
6110 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6112 sv_catpvn(sv, (char *) buf, cnt);
6114 sv_setpvn(sv, (char *) buf, cnt);
6116 if (i != EOF && /* joy */
6118 SvCUR(sv) < rslen ||
6119 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6123 * If we're reading from a TTY and we get a short read,
6124 * indicating that the user hit his EOF character, we need
6125 * to notice it now, because if we try to read from the TTY
6126 * again, the EOF condition will disappear.
6128 * The comparison of cnt to sizeof(buf) is an optimization
6129 * that prevents unnecessary calls to feof().
6133 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6137 #ifdef USE_HEAP_INSTEAD_OF_STACK
6142 if (rspara) { /* have to do this both before and after */
6143 while (i != EOF) { /* to make sure file boundaries work right */
6144 i = PerlIO_getc(fp);
6146 PerlIO_ungetc(fp,i);
6152 return_string_or_null:
6153 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6159 Auto-increment of the value in the SV, doing string to numeric conversion
6160 if necessary. Handles 'get' magic.
6166 Perl_sv_inc(pTHX_ register SV *sv)
6175 if (SvTHINKFIRST(sv)) {
6177 sv_force_normal_flags(sv, 0);
6178 if (SvREADONLY(sv)) {
6179 if (IN_PERL_RUNTIME)
6180 Perl_croak(aTHX_ PL_no_modify);
6184 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6186 i = PTR2IV(SvRV(sv));
6191 flags = SvFLAGS(sv);
6192 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6193 /* It's (privately or publicly) a float, but not tested as an
6194 integer, so test it to see. */
6196 flags = SvFLAGS(sv);
6198 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6199 /* It's publicly an integer, or privately an integer-not-float */
6200 #ifdef PERL_PRESERVE_IVUV
6204 if (SvUVX(sv) == UV_MAX)
6205 sv_setnv(sv, UV_MAX_P1);
6207 (void)SvIOK_only_UV(sv);
6208 SvUV_set(sv, SvUVX(sv) + 1);
6210 if (SvIVX(sv) == IV_MAX)
6211 sv_setuv(sv, (UV)IV_MAX + 1);
6213 (void)SvIOK_only(sv);
6214 SvIV_set(sv, SvIVX(sv) + 1);
6219 if (flags & SVp_NOK) {
6220 (void)SvNOK_only(sv);
6221 SvNV_set(sv, SvNVX(sv) + 1.0);
6225 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6226 if ((flags & SVTYPEMASK) < SVt_PVIV)
6227 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6228 (void)SvIOK_only(sv);
6233 while (isALPHA(*d)) d++;
6234 while (isDIGIT(*d)) d++;
6236 #ifdef PERL_PRESERVE_IVUV
6237 /* Got to punt this as an integer if needs be, but we don't issue
6238 warnings. Probably ought to make the sv_iv_please() that does
6239 the conversion if possible, and silently. */
6240 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6241 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6242 /* Need to try really hard to see if it's an integer.
6243 9.22337203685478e+18 is an integer.
6244 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6245 so $a="9.22337203685478e+18"; $a+0; $a++
6246 needs to be the same as $a="9.22337203685478e+18"; $a++
6253 /* sv_2iv *should* have made this an NV */
6254 if (flags & SVp_NOK) {
6255 (void)SvNOK_only(sv);
6256 SvNV_set(sv, SvNVX(sv) + 1.0);
6259 /* I don't think we can get here. Maybe I should assert this
6260 And if we do get here I suspect that sv_setnv will croak. NWC
6262 #if defined(USE_LONG_DOUBLE)
6263 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6264 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6266 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6267 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6270 #endif /* PERL_PRESERVE_IVUV */
6271 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6275 while (d >= SvPVX_const(sv)) {
6283 /* MKS: The original code here died if letters weren't consecutive.
6284 * at least it didn't have to worry about non-C locales. The
6285 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6286 * arranged in order (although not consecutively) and that only
6287 * [A-Za-z] are accepted by isALPHA in the C locale.
6289 if (*d != 'z' && *d != 'Z') {
6290 do { ++*d; } while (!isALPHA(*d));
6293 *(d--) -= 'z' - 'a';
6298 *(d--) -= 'z' - 'a' + 1;
6302 /* oh,oh, the number grew */
6303 SvGROW(sv, SvCUR(sv) + 2);
6304 SvCUR_set(sv, SvCUR(sv) + 1);
6305 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6316 Auto-decrement of the value in the SV, doing string to numeric conversion
6317 if necessary. Handles 'get' magic.
6323 Perl_sv_dec(pTHX_ register SV *sv)
6331 if (SvTHINKFIRST(sv)) {
6333 sv_force_normal_flags(sv, 0);
6334 if (SvREADONLY(sv)) {
6335 if (IN_PERL_RUNTIME)
6336 Perl_croak(aTHX_ PL_no_modify);
6340 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6342 i = PTR2IV(SvRV(sv));
6347 /* Unlike sv_inc we don't have to worry about string-never-numbers
6348 and keeping them magic. But we mustn't warn on punting */
6349 flags = SvFLAGS(sv);
6350 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6351 /* It's publicly an integer, or privately an integer-not-float */
6352 #ifdef PERL_PRESERVE_IVUV
6356 if (SvUVX(sv) == 0) {
6357 (void)SvIOK_only(sv);
6361 (void)SvIOK_only_UV(sv);
6362 SvUV_set(sv, SvUVX(sv) - 1);
6365 if (SvIVX(sv) == IV_MIN)
6366 sv_setnv(sv, (NV)IV_MIN - 1.0);
6368 (void)SvIOK_only(sv);
6369 SvIV_set(sv, SvIVX(sv) - 1);
6374 if (flags & SVp_NOK) {
6375 SvNV_set(sv, SvNVX(sv) - 1.0);
6376 (void)SvNOK_only(sv);
6379 if (!(flags & SVp_POK)) {
6380 if ((flags & SVTYPEMASK) < SVt_PVIV)
6381 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6383 (void)SvIOK_only(sv);
6386 #ifdef PERL_PRESERVE_IVUV
6388 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6389 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6390 /* Need to try really hard to see if it's an integer.
6391 9.22337203685478e+18 is an integer.
6392 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6393 so $a="9.22337203685478e+18"; $a+0; $a--
6394 needs to be the same as $a="9.22337203685478e+18"; $a--
6401 /* sv_2iv *should* have made this an NV */
6402 if (flags & SVp_NOK) {
6403 (void)SvNOK_only(sv);
6404 SvNV_set(sv, SvNVX(sv) - 1.0);
6407 /* I don't think we can get here. Maybe I should assert this
6408 And if we do get here I suspect that sv_setnv will croak. NWC
6410 #if defined(USE_LONG_DOUBLE)
6411 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6412 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6414 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6415 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6419 #endif /* PERL_PRESERVE_IVUV */
6420 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6424 =for apidoc sv_mortalcopy
6426 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6427 The new SV is marked as mortal. It will be destroyed "soon", either by an
6428 explicit call to FREETMPS, or by an implicit call at places such as
6429 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6434 /* Make a string that will exist for the duration of the expression
6435 * evaluation. Actually, it may have to last longer than that, but
6436 * hopefully we won't free it until it has been assigned to a
6437 * permanent location. */
6440 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6446 sv_setsv(sv,oldstr);
6448 PL_tmps_stack[++PL_tmps_ix] = sv;
6454 =for apidoc sv_newmortal
6456 Creates a new null SV which is mortal. The reference count of the SV is
6457 set to 1. It will be destroyed "soon", either by an explicit call to
6458 FREETMPS, or by an implicit call at places such as statement boundaries.
6459 See also C<sv_mortalcopy> and C<sv_2mortal>.
6465 Perl_sv_newmortal(pTHX)
6471 SvFLAGS(sv) = SVs_TEMP;
6473 PL_tmps_stack[++PL_tmps_ix] = sv;
6478 =for apidoc sv_2mortal
6480 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6481 by an explicit call to FREETMPS, or by an implicit call at places such as
6482 statement boundaries. SvTEMP() is turned on which means that the SV's
6483 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6484 and C<sv_mortalcopy>.
6490 Perl_sv_2mortal(pTHX_ register SV *sv)
6495 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6498 PL_tmps_stack[++PL_tmps_ix] = sv;
6506 Creates a new SV and copies a string into it. The reference count for the
6507 SV is set to 1. If C<len> is zero, Perl will compute the length using
6508 strlen(). For efficiency, consider using C<newSVpvn> instead.
6514 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6520 sv_setpvn(sv,s,len ? len : strlen(s));
6525 =for apidoc newSVpvn
6527 Creates a new SV and copies a string into it. The reference count for the
6528 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6529 string. You are responsible for ensuring that the source string is at least
6530 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6536 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6542 sv_setpvn(sv,s,len);
6548 =for apidoc newSVhek
6550 Creates a new SV from the hash key structure. It will generate scalars that
6551 point to the shared string table where possible. Returns a new (undefined)
6552 SV if the hek is NULL.
6558 Perl_newSVhek(pTHX_ const HEK *hek)
6568 if (HEK_LEN(hek) == HEf_SVKEY) {
6569 return newSVsv(*(SV**)HEK_KEY(hek));
6571 const int flags = HEK_FLAGS(hek);
6572 if (flags & HVhek_WASUTF8) {
6574 Andreas would like keys he put in as utf8 to come back as utf8
6576 STRLEN utf8_len = HEK_LEN(hek);
6577 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6578 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6581 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6583 } else if (flags & HVhek_REHASH) {
6584 /* We don't have a pointer to the hv, so we have to replicate the
6585 flag into every HEK. This hv is using custom a hasing
6586 algorithm. Hence we can't return a shared string scalar, as
6587 that would contain the (wrong) hash value, and might get passed
6588 into an hv routine with a regular hash */
6590 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6595 /* This will be overwhelminly the most common case. */
6596 return newSVpvn_share(HEK_KEY(hek),
6597 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6603 =for apidoc newSVpvn_share
6605 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6606 table. If the string does not already exist in the table, it is created
6607 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6608 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6609 otherwise the hash is computed. The idea here is that as the string table
6610 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6611 hash lookup will avoid string compare.
6617 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6621 bool is_utf8 = FALSE;
6623 STRLEN tmplen = -len;
6625 /* See the note in hv.c:hv_fetch() --jhi */
6626 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6630 PERL_HASH(hash, src, len);
6632 sv_upgrade(sv, SVt_PV);
6633 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6645 #if defined(PERL_IMPLICIT_CONTEXT)
6647 /* pTHX_ magic can't cope with varargs, so this is a no-context
6648 * version of the main function, (which may itself be aliased to us).
6649 * Don't access this version directly.
6653 Perl_newSVpvf_nocontext(const char* pat, ...)
6658 va_start(args, pat);
6659 sv = vnewSVpvf(pat, &args);
6666 =for apidoc newSVpvf
6668 Creates a new SV and initializes it with the string formatted like
6675 Perl_newSVpvf(pTHX_ const char* pat, ...)
6679 va_start(args, pat);
6680 sv = vnewSVpvf(pat, &args);
6685 /* backend for newSVpvf() and newSVpvf_nocontext() */
6688 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6693 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6700 Creates a new SV and copies a floating point value into it.
6701 The reference count for the SV is set to 1.
6707 Perl_newSVnv(pTHX_ NV n)
6720 Creates a new SV and copies an integer into it. The reference count for the
6727 Perl_newSViv(pTHX_ IV i)
6740 Creates a new SV and copies an unsigned integer into it.
6741 The reference count for the SV is set to 1.
6747 Perl_newSVuv(pTHX_ UV u)
6758 =for apidoc newRV_noinc
6760 Creates an RV wrapper for an SV. The reference count for the original
6761 SV is B<not> incremented.
6767 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6773 sv_upgrade(sv, SVt_RV);
6775 SvRV_set(sv, tmpRef);
6780 /* newRV_inc is the official function name to use now.
6781 * newRV_inc is in fact #defined to newRV in sv.h
6785 Perl_newRV(pTHX_ SV *tmpRef)
6788 return newRV_noinc(SvREFCNT_inc(tmpRef));
6794 Creates a new SV which is an exact duplicate of the original SV.
6801 Perl_newSVsv(pTHX_ register SV *old)
6808 if (SvTYPE(old) == SVTYPEMASK) {
6809 if (ckWARN_d(WARN_INTERNAL))
6810 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6814 /* SV_GMAGIC is the default for sv_setv()
6815 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6816 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6817 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6822 =for apidoc sv_reset
6824 Underlying implementation for the C<reset> Perl function.
6825 Note that the perl-level function is vaguely deprecated.
6831 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6834 char todo[PERL_UCHAR_MAX+1];
6839 if (!*s) { /* reset ?? searches */
6840 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6842 PMOP *pm = (PMOP *) mg->mg_obj;
6844 pm->op_pmdynflags &= ~PMdf_USED;
6851 /* reset variables */
6853 if (!HvARRAY(stash))
6856 Zero(todo, 256, char);
6859 I32 i = (unsigned char)*s;
6863 max = (unsigned char)*s++;
6864 for ( ; i <= max; i++) {
6867 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6869 for (entry = HvARRAY(stash)[i];
6871 entry = HeNEXT(entry))
6876 if (!todo[(U8)*HeKEY(entry)])
6878 gv = (GV*)HeVAL(entry);
6881 if (SvTHINKFIRST(sv)) {
6882 if (!SvREADONLY(sv) && SvROK(sv))
6884 /* XXX Is this continue a bug? Why should THINKFIRST
6885 exempt us from resetting arrays and hashes? */
6889 if (SvTYPE(sv) >= SVt_PV) {
6891 if (SvPVX_const(sv) != NULL)
6899 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6901 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6904 # if defined(USE_ENVIRON_ARRAY)
6907 # endif /* USE_ENVIRON_ARRAY */
6918 Using various gambits, try to get an IO from an SV: the IO slot if its a
6919 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6920 named after the PV if we're a string.
6926 Perl_sv_2io(pTHX_ SV *sv)
6931 switch (SvTYPE(sv)) {
6939 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6943 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6945 return sv_2io(SvRV(sv));
6946 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6952 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6961 Using various gambits, try to get a CV from an SV; in addition, try if
6962 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6963 The flags in C<lref> are passed to sv_fetchsv.
6969 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6980 switch (SvTYPE(sv)) {
6999 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7000 tryAMAGICunDEREF(to_cv);
7003 if (SvTYPE(sv) == SVt_PVCV) {
7012 Perl_croak(aTHX_ "Not a subroutine reference");
7017 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7023 /* Some flags to gv_fetchsv mean don't really create the GV */
7024 if (SvTYPE(gv) != SVt_PVGV) {
7030 if (lref && !GvCVu(gv)) {
7034 gv_efullname3(tmpsv, gv, NULL);
7035 /* XXX this is probably not what they think they're getting.
7036 * It has the same effect as "sub name;", i.e. just a forward
7038 newSUB(start_subparse(FALSE, 0),
7039 newSVOP(OP_CONST, 0, tmpsv),
7043 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7053 Returns true if the SV has a true value by Perl's rules.
7054 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7055 instead use an in-line version.
7061 Perl_sv_true(pTHX_ register SV *sv)
7066 register const XPV* const tXpv = (XPV*)SvANY(sv);
7068 (tXpv->xpv_cur > 1 ||
7069 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7076 return SvIVX(sv) != 0;
7079 return SvNVX(sv) != 0.0;
7081 return sv_2bool(sv);
7087 =for apidoc sv_pvn_force
7089 Get a sensible string out of the SV somehow.
7090 A private implementation of the C<SvPV_force> macro for compilers which
7091 can't cope with complex macro expressions. Always use the macro instead.
7093 =for apidoc sv_pvn_force_flags
7095 Get a sensible string out of the SV somehow.
7096 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7097 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7098 implemented in terms of this function.
7099 You normally want to use the various wrapper macros instead: see
7100 C<SvPV_force> and C<SvPV_force_nomg>
7106 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7109 if (SvTHINKFIRST(sv) && !SvROK(sv))
7110 sv_force_normal_flags(sv, 0);
7120 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7121 const char * const ref = sv_reftype(sv,0);
7123 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7124 ref, OP_NAME(PL_op));
7126 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7128 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7129 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7131 s = sv_2pv_flags(sv, &len, flags);
7135 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7138 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7139 SvGROW(sv, len + 1);
7140 Move(s,SvPVX(sv),len,char);
7145 SvPOK_on(sv); /* validate pointer */
7147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7148 PTR2UV(sv),SvPVX_const(sv)));
7151 return SvPVX_mutable(sv);
7155 =for apidoc sv_pvbyten_force
7157 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7163 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7165 sv_pvn_force(sv,lp);
7166 sv_utf8_downgrade(sv,0);
7172 =for apidoc sv_pvutf8n_force
7174 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7180 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7182 sv_pvn_force(sv,lp);
7183 sv_utf8_upgrade(sv);
7189 =for apidoc sv_reftype
7191 Returns a string describing what the SV is a reference to.
7197 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7199 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7200 inside return suggests a const propagation bug in g++. */
7201 if (ob && SvOBJECT(sv)) {
7202 char * const name = HvNAME_get(SvSTASH(sv));
7203 return name ? name : (char *) "__ANON__";
7206 switch (SvTYPE(sv)) {
7223 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7224 /* tied lvalues should appear to be
7225 * scalars for backwards compatitbility */
7226 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7227 ? "SCALAR" : "LVALUE");
7228 case SVt_PVAV: return "ARRAY";
7229 case SVt_PVHV: return "HASH";
7230 case SVt_PVCV: return "CODE";
7231 case SVt_PVGV: return "GLOB";
7232 case SVt_PVFM: return "FORMAT";
7233 case SVt_PVIO: return "IO";
7234 default: return "UNKNOWN";
7240 =for apidoc sv_isobject
7242 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7243 object. If the SV is not an RV, or if the object is not blessed, then this
7250 Perl_sv_isobject(pTHX_ SV *sv)
7266 Returns a boolean indicating whether the SV is blessed into the specified
7267 class. This does not check for subtypes; use C<sv_derived_from> to verify
7268 an inheritance relationship.
7274 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7285 hvname = HvNAME_get(SvSTASH(sv));
7289 return strEQ(hvname, name);
7295 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7296 it will be upgraded to one. If C<classname> is non-null then the new SV will
7297 be blessed in the specified package. The new SV is returned and its
7298 reference count is 1.
7304 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7311 SV_CHECK_THINKFIRST_COW_DROP(rv);
7314 if (SvTYPE(rv) >= SVt_PVMG) {
7315 const U32 refcnt = SvREFCNT(rv);
7319 SvREFCNT(rv) = refcnt;
7322 if (SvTYPE(rv) < SVt_RV)
7323 sv_upgrade(rv, SVt_RV);
7324 else if (SvTYPE(rv) > SVt_RV) {
7335 HV* const stash = gv_stashpv(classname, TRUE);
7336 (void)sv_bless(rv, stash);
7342 =for apidoc sv_setref_pv
7344 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7345 argument will be upgraded to an RV. That RV will be modified to point to
7346 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7347 into the SV. The C<classname> argument indicates the package for the
7348 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7349 will have a reference count of 1, and the RV will be returned.
7351 Do not use with other Perl types such as HV, AV, SV, CV, because those
7352 objects will become corrupted by the pointer copy process.
7354 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7360 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7364 sv_setsv(rv, &PL_sv_undef);
7368 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7373 =for apidoc sv_setref_iv
7375 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7376 argument will be upgraded to an RV. That RV will be modified to point to
7377 the new SV. The C<classname> argument indicates the package for the
7378 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7379 will have a reference count of 1, and the RV will be returned.
7385 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7387 sv_setiv(newSVrv(rv,classname), iv);
7392 =for apidoc sv_setref_uv
7394 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7395 argument will be upgraded to an RV. That RV will be modified to point to
7396 the new SV. The C<classname> argument indicates the package for the
7397 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7398 will have a reference count of 1, and the RV will be returned.
7404 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7406 sv_setuv(newSVrv(rv,classname), uv);
7411 =for apidoc sv_setref_nv
7413 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7414 argument will be upgraded to an RV. That RV will be modified to point to
7415 the new SV. The C<classname> argument indicates the package for the
7416 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7417 will have a reference count of 1, and the RV will be returned.
7423 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7425 sv_setnv(newSVrv(rv,classname), nv);
7430 =for apidoc sv_setref_pvn
7432 Copies a string into a new SV, optionally blessing the SV. The length of the
7433 string must be specified with C<n>. The C<rv> argument will be upgraded to
7434 an RV. That RV will be modified to point to the new SV. The C<classname>
7435 argument indicates the package for the blessing. Set C<classname> to
7436 C<NULL> to avoid the blessing. The new SV will have a reference count
7437 of 1, and the RV will be returned.
7439 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7445 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7447 sv_setpvn(newSVrv(rv,classname), pv, n);
7452 =for apidoc sv_bless
7454 Blesses an SV into a specified package. The SV must be an RV. The package
7455 must be designated by its stash (see C<gv_stashpv()>). The reference count
7456 of the SV is unaffected.
7462 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7467 Perl_croak(aTHX_ "Can't bless non-reference value");
7469 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7470 if (SvREADONLY(tmpRef))
7471 Perl_croak(aTHX_ PL_no_modify);
7472 if (SvOBJECT(tmpRef)) {
7473 if (SvTYPE(tmpRef) != SVt_PVIO)
7475 SvREFCNT_dec(SvSTASH(tmpRef));
7478 SvOBJECT_on(tmpRef);
7479 if (SvTYPE(tmpRef) != SVt_PVIO)
7481 SvUPGRADE(tmpRef, SVt_PVMG);
7482 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7489 if(SvSMAGICAL(tmpRef))
7490 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7498 /* Downgrades a PVGV to a PVMG.
7502 S_sv_unglob(pTHX_ SV *sv)
7507 assert(SvTYPE(sv) == SVt_PVGV);
7512 sv_del_backref((SV*)GvSTASH(sv), sv);
7515 sv_unmagic(sv, PERL_MAGIC_glob);
7516 Safefree(GvNAME(sv));
7519 /* need to keep SvANY(sv) in the right arena */
7520 xpvmg = new_XPVMG();
7521 StructCopy(SvANY(sv), xpvmg, XPVMG);
7522 del_XPVGV(SvANY(sv));
7525 SvFLAGS(sv) &= ~SVTYPEMASK;
7526 SvFLAGS(sv) |= SVt_PVMG;
7530 =for apidoc sv_unref_flags
7532 Unsets the RV status of the SV, and decrements the reference count of
7533 whatever was being referenced by the RV. This can almost be thought of
7534 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7535 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7536 (otherwise the decrementing is conditional on the reference count being
7537 different from one or the reference being a readonly SV).
7544 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7546 SV* const target = SvRV(ref);
7548 if (SvWEAKREF(ref)) {
7549 sv_del_backref(target, ref);
7551 SvRV_set(ref, NULL);
7554 SvRV_set(ref, NULL);
7556 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7557 assigned to as BEGIN {$a = \"Foo"} will fail. */
7558 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7559 SvREFCNT_dec(target);
7560 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7561 sv_2mortal(target); /* Schedule for freeing later */
7565 =for apidoc sv_untaint
7567 Untaint an SV. Use C<SvTAINTED_off> instead.
7572 Perl_sv_untaint(pTHX_ SV *sv)
7574 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7575 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7582 =for apidoc sv_tainted
7584 Test an SV for taintedness. Use C<SvTAINTED> instead.
7589 Perl_sv_tainted(pTHX_ SV *sv)
7591 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7592 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7593 if (mg && (mg->mg_len & 1) )
7600 =for apidoc sv_setpviv
7602 Copies an integer into the given SV, also updating its string value.
7603 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7609 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7611 char buf[TYPE_CHARS(UV)];
7613 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7615 sv_setpvn(sv, ptr, ebuf - ptr);
7619 =for apidoc sv_setpviv_mg
7621 Like C<sv_setpviv>, but also handles 'set' magic.
7627 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7633 #if defined(PERL_IMPLICIT_CONTEXT)
7635 /* pTHX_ magic can't cope with varargs, so this is a no-context
7636 * version of the main function, (which may itself be aliased to us).
7637 * Don't access this version directly.
7641 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7645 va_start(args, pat);
7646 sv_vsetpvf(sv, pat, &args);
7650 /* pTHX_ magic can't cope with varargs, so this is a no-context
7651 * version of the main function, (which may itself be aliased to us).
7652 * Don't access this version directly.
7656 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7660 va_start(args, pat);
7661 sv_vsetpvf_mg(sv, pat, &args);
7667 =for apidoc sv_setpvf
7669 Works like C<sv_catpvf> but copies the text into the SV instead of
7670 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7676 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7679 va_start(args, pat);
7680 sv_vsetpvf(sv, pat, &args);
7685 =for apidoc sv_vsetpvf
7687 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7688 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7690 Usually used via its frontend C<sv_setpvf>.
7696 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7698 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7702 =for apidoc sv_setpvf_mg
7704 Like C<sv_setpvf>, but also handles 'set' magic.
7710 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7713 va_start(args, pat);
7714 sv_vsetpvf_mg(sv, pat, &args);
7719 =for apidoc sv_vsetpvf_mg
7721 Like C<sv_vsetpvf>, but also handles 'set' magic.
7723 Usually used via its frontend C<sv_setpvf_mg>.
7729 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7731 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7735 #if defined(PERL_IMPLICIT_CONTEXT)
7737 /* pTHX_ magic can't cope with varargs, so this is a no-context
7738 * version of the main function, (which may itself be aliased to us).
7739 * Don't access this version directly.
7743 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7747 va_start(args, pat);
7748 sv_vcatpvf(sv, pat, &args);
7752 /* pTHX_ magic can't cope with varargs, so this is a no-context
7753 * version of the main function, (which may itself be aliased to us).
7754 * Don't access this version directly.
7758 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7762 va_start(args, pat);
7763 sv_vcatpvf_mg(sv, pat, &args);
7769 =for apidoc sv_catpvf
7771 Processes its arguments like C<sprintf> and appends the formatted
7772 output to an SV. If the appended data contains "wide" characters
7773 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7774 and characters >255 formatted with %c), the original SV might get
7775 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7776 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7777 valid UTF-8; if the original SV was bytes, the pattern should be too.
7782 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7785 va_start(args, pat);
7786 sv_vcatpvf(sv, pat, &args);
7791 =for apidoc sv_vcatpvf
7793 Processes its arguments like C<vsprintf> and appends the formatted output
7794 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7796 Usually used via its frontend C<sv_catpvf>.
7802 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7804 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7808 =for apidoc sv_catpvf_mg
7810 Like C<sv_catpvf>, but also handles 'set' magic.
7816 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7819 va_start(args, pat);
7820 sv_vcatpvf_mg(sv, pat, &args);
7825 =for apidoc sv_vcatpvf_mg
7827 Like C<sv_vcatpvf>, but also handles 'set' magic.
7829 Usually used via its frontend C<sv_catpvf_mg>.
7835 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7837 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7842 =for apidoc sv_vsetpvfn
7844 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7847 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7853 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7855 sv_setpvn(sv, "", 0);
7856 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7860 S_expect_number(pTHX_ char** pattern)
7864 switch (**pattern) {
7865 case '1': case '2': case '3':
7866 case '4': case '5': case '6':
7867 case '7': case '8': case '9':
7868 var = *(*pattern)++ - '0';
7869 while (isDIGIT(**pattern)) {
7870 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
7872 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7880 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7882 const int neg = nv < 0;
7891 if (uv & 1 && uv == nv)
7892 uv--; /* Round to even */
7894 const unsigned dig = uv % 10;
7907 =for apidoc sv_vcatpvfn
7909 Processes its arguments like C<vsprintf> and appends the formatted output
7910 to an SV. Uses an array of SVs if the C style variable argument list is
7911 missing (NULL). When running with taint checks enabled, indicates via
7912 C<maybe_tainted> if results are untrustworthy (often due to the use of
7915 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7921 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7922 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7923 vec_utf8 = DO_UTF8(vecsv);
7925 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7928 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7936 static const char nullstr[] = "(null)";
7938 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7939 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7941 /* Times 4: a decimal digit takes more than 3 binary digits.
7942 * NV_DIG: mantissa takes than many decimal digits.
7943 * Plus 32: Playing safe. */
7944 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7945 /* large enough for "%#.#f" --chip */
7946 /* what about long double NVs? --jhi */
7948 PERL_UNUSED_ARG(maybe_tainted);
7950 /* no matter what, this is a string now */
7951 (void)SvPV_force(sv, origlen);
7953 /* special-case "", "%s", and "%-p" (SVf - see below) */
7956 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7958 const char * const s = va_arg(*args, char*);
7959 sv_catpv(sv, s ? s : nullstr);
7961 else if (svix < svmax) {
7962 sv_catsv(sv, *svargs);
7966 if (args && patlen == 3 && pat[0] == '%' &&
7967 pat[1] == '-' && pat[2] == 'p') {
7968 argsv = va_arg(*args, SV*);
7969 sv_catsv(sv, argsv);
7973 #ifndef USE_LONG_DOUBLE
7974 /* special-case "%.<number>[gf]" */
7975 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7976 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7977 unsigned digits = 0;
7981 while (*pp >= '0' && *pp <= '9')
7982 digits = 10 * digits + (*pp++ - '0');
7983 if (pp - pat == (int)patlen - 1) {
7991 /* Add check for digits != 0 because it seems that some
7992 gconverts are buggy in this case, and we don't yet have
7993 a Configure test for this. */
7994 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7995 /* 0, point, slack */
7996 Gconvert(nv, (int)digits, 0, ebuf);
7998 if (*ebuf) /* May return an empty string for digits==0 */
8001 } else if (!digits) {
8004 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8005 sv_catpvn(sv, p, l);
8011 #endif /* !USE_LONG_DOUBLE */
8013 if (!args && svix < svmax && DO_UTF8(*svargs))
8016 patend = (char*)pat + patlen;
8017 for (p = (char*)pat; p < patend; p = q) {
8020 bool vectorize = FALSE;
8021 bool vectorarg = FALSE;
8022 bool vec_utf8 = FALSE;
8028 bool has_precis = FALSE;
8030 const I32 osvix = svix;
8031 bool is_utf8 = FALSE; /* is this item utf8? */
8032 #ifdef HAS_LDBL_SPRINTF_BUG
8033 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8034 with sfio - Allen <allens@cpan.org> */
8035 bool fix_ldbl_sprintf_bug = FALSE;
8039 U8 utf8buf[UTF8_MAXBYTES+1];
8040 STRLEN esignlen = 0;
8042 const char *eptr = NULL;
8045 const U8 *vecstr = Null(U8*);
8052 /* we need a long double target in case HAS_LONG_DOUBLE but
8055 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8063 const char *dotstr = ".";
8064 STRLEN dotstrlen = 1;
8065 I32 efix = 0; /* explicit format parameter index */
8066 I32 ewix = 0; /* explicit width index */
8067 I32 epix = 0; /* explicit precision index */
8068 I32 evix = 0; /* explicit vector index */
8069 bool asterisk = FALSE;
8071 /* echo everything up to the next format specification */
8072 for (q = p; q < patend && *q != '%'; ++q) ;
8074 if (has_utf8 && !pat_utf8)
8075 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8077 sv_catpvn(sv, p, q - p);
8084 We allow format specification elements in this order:
8085 \d+\$ explicit format parameter index
8087 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8088 0 flag (as above): repeated to allow "v02"
8089 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8090 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8092 [%bcdefginopsuxDFOUX] format (mandatory)
8097 As of perl5.9.3, printf format checking is on by default.
8098 Internally, perl uses %p formats to provide an escape to
8099 some extended formatting. This block deals with those
8100 extensions: if it does not match, (char*)q is reset and
8101 the normal format processing code is used.
8103 Currently defined extensions are:
8104 %p include pointer address (standard)
8105 %-p (SVf) include an SV (previously %_)
8106 %-<num>p include an SV with precision <num>
8107 %1p (VDf) include a v-string (as %vd)
8108 %<num>p reserved for future extensions
8110 Robin Barker 2005-07-14
8117 n = expect_number(&q);
8124 argsv = va_arg(*args, SV*);
8125 eptr = SvPVx_const(argsv, elen);
8131 else if (n == vdNUMBER) { /* VDf */
8138 if (ckWARN_d(WARN_INTERNAL))
8139 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8140 "internal %%<num>p might conflict with future printf extensions");
8146 if ( (width = expect_number(&q)) ) {
8187 if ( (ewix = expect_number(&q)) )
8196 if ((vectorarg = asterisk)) {
8209 width = expect_number(&q);
8215 vecsv = va_arg(*args, SV*);
8217 vecsv = (evix > 0 && evix <= svmax)
8218 ? svargs[evix-1] : &PL_sv_undef;
8220 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8222 dotstr = SvPV_const(vecsv, dotstrlen);
8223 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8224 bad with tied or overloaded values that return UTF8. */
8227 else if (has_utf8) {
8228 vecsv = sv_mortalcopy(vecsv);
8229 sv_utf8_upgrade(vecsv);
8230 dotstr = SvPV_const(vecsv, dotstrlen);
8237 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8238 vecsv = svargs[efix ? efix-1 : svix++];
8239 vecstr = (U8*)SvPV_const(vecsv,veclen);
8240 vec_utf8 = DO_UTF8(vecsv);
8242 /* if this is a version object, we need to convert
8243 * back into v-string notation and then let the
8244 * vectorize happen normally
8246 if (sv_derived_from(vecsv, "version")) {
8247 char *version = savesvpv(vecsv);
8248 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8249 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8250 "vector argument not supported with alpha versions");
8253 vecsv = sv_newmortal();
8254 /* scan_vstring is expected to be called during
8255 * tokenization, so we need to fake up the end
8256 * of the buffer for it
8258 PL_bufend = version + veclen;
8259 scan_vstring(version, vecsv);
8260 vecstr = (U8*)SvPV_const(vecsv, veclen);
8261 vec_utf8 = DO_UTF8(vecsv);
8273 i = va_arg(*args, int);
8275 i = (ewix ? ewix <= svmax : svix < svmax) ?
8276 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8278 width = (i < 0) ? -i : i;
8288 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8290 /* XXX: todo, support specified precision parameter */
8294 i = va_arg(*args, int);
8296 i = (ewix ? ewix <= svmax : svix < svmax)
8297 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8298 precis = (i < 0) ? 0 : i;
8303 precis = precis * 10 + (*q++ - '0');
8312 case 'I': /* Ix, I32x, and I64x */
8314 if (q[1] == '6' && q[2] == '4') {
8320 if (q[1] == '3' && q[2] == '2') {
8330 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8341 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8342 if (*(q + 1) == 'l') { /* lld, llf */
8368 if (!vectorize && !args) {
8370 const I32 i = efix-1;
8371 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8373 argsv = (svix >= 0 && svix < svmax)
8374 ? svargs[svix++] : &PL_sv_undef;
8385 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8387 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8389 eptr = (char*)utf8buf;
8390 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8404 eptr = va_arg(*args, char*);
8406 #ifdef MACOS_TRADITIONAL
8407 /* On MacOS, %#s format is used for Pascal strings */
8412 elen = strlen(eptr);
8414 eptr = (char *)nullstr;
8415 elen = sizeof nullstr - 1;
8419 eptr = SvPVx_const(argsv, elen);
8420 if (DO_UTF8(argsv)) {
8421 if (has_precis && precis < elen) {
8423 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8426 if (width) { /* fudge width (can't fudge elen) */
8427 width += elen - sv_len_utf8(argsv);
8434 if (has_precis && elen > precis)
8441 if (alt || vectorize)
8443 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8464 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8473 esignbuf[esignlen++] = plus;
8477 case 'h': iv = (short)va_arg(*args, int); break;
8478 case 'l': iv = va_arg(*args, long); break;
8479 case 'V': iv = va_arg(*args, IV); break;
8480 default: iv = va_arg(*args, int); break;
8482 case 'q': iv = va_arg(*args, Quad_t); break;
8487 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8489 case 'h': iv = (short)tiv; break;
8490 case 'l': iv = (long)tiv; break;
8492 default: iv = tiv; break;
8494 case 'q': iv = (Quad_t)tiv; break;
8498 if ( !vectorize ) /* we already set uv above */
8503 esignbuf[esignlen++] = plus;
8507 esignbuf[esignlen++] = '-';
8550 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8561 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8562 case 'l': uv = va_arg(*args, unsigned long); break;
8563 case 'V': uv = va_arg(*args, UV); break;
8564 default: uv = va_arg(*args, unsigned); break;
8566 case 'q': uv = va_arg(*args, Uquad_t); break;
8571 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8573 case 'h': uv = (unsigned short)tuv; break;
8574 case 'l': uv = (unsigned long)tuv; break;
8576 default: uv = tuv; break;
8578 case 'q': uv = (Uquad_t)tuv; break;
8585 char *ptr = ebuf + sizeof ebuf;
8591 p = (char*)((c == 'X')
8592 ? "0123456789ABCDEF" : "0123456789abcdef");
8598 esignbuf[esignlen++] = '0';
8599 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8607 if (alt && *ptr != '0')
8618 esignbuf[esignlen++] = '0';
8619 esignbuf[esignlen++] = 'b';
8622 default: /* it had better be ten or less */
8626 } while (uv /= base);
8629 elen = (ebuf + sizeof ebuf) - ptr;
8633 zeros = precis - elen;
8634 else if (precis == 0 && elen == 1 && *eptr == '0')
8640 /* FLOATING POINT */
8643 c = 'f'; /* maybe %F isn't supported here */
8651 /* This is evil, but floating point is even more evil */
8653 /* for SV-style calling, we can only get NV
8654 for C-style calling, we assume %f is double;
8655 for simplicity we allow any of %Lf, %llf, %qf for long double
8659 #if defined(USE_LONG_DOUBLE)
8663 /* [perl #20339] - we should accept and ignore %lf rather than die */
8667 #if defined(USE_LONG_DOUBLE)
8668 intsize = args ? 0 : 'q';
8672 #if defined(HAS_LONG_DOUBLE)
8681 /* now we need (long double) if intsize == 'q', else (double) */
8683 #if LONG_DOUBLESIZE > DOUBLESIZE
8685 va_arg(*args, long double) :
8686 va_arg(*args, double)
8688 va_arg(*args, double)
8693 if (c != 'e' && c != 'E') {
8695 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8696 will cast our (long double) to (double) */
8697 (void)Perl_frexp(nv, &i);
8698 if (i == PERL_INT_MIN)
8699 Perl_die(aTHX_ "panic: frexp");
8701 need = BIT_DIGITS(i);
8703 need += has_precis ? precis : 6; /* known default */
8708 #ifdef HAS_LDBL_SPRINTF_BUG
8709 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8710 with sfio - Allen <allens@cpan.org> */
8713 # define MY_DBL_MAX DBL_MAX
8714 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8715 # if DOUBLESIZE >= 8
8716 # define MY_DBL_MAX 1.7976931348623157E+308L
8718 # define MY_DBL_MAX 3.40282347E+38L
8722 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8723 # define MY_DBL_MAX_BUG 1L
8725 # define MY_DBL_MAX_BUG MY_DBL_MAX
8729 # define MY_DBL_MIN DBL_MIN
8730 # else /* XXX guessing! -Allen */
8731 # if DOUBLESIZE >= 8
8732 # define MY_DBL_MIN 2.2250738585072014E-308L
8734 # define MY_DBL_MIN 1.17549435E-38L
8738 if ((intsize == 'q') && (c == 'f') &&
8739 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8741 /* it's going to be short enough that
8742 * long double precision is not needed */
8744 if ((nv <= 0L) && (nv >= -0L))
8745 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8747 /* would use Perl_fp_class as a double-check but not
8748 * functional on IRIX - see perl.h comments */
8750 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8751 /* It's within the range that a double can represent */
8752 #if defined(DBL_MAX) && !defined(DBL_MIN)
8753 if ((nv >= ((long double)1/DBL_MAX)) ||
8754 (nv <= (-(long double)1/DBL_MAX)))
8756 fix_ldbl_sprintf_bug = TRUE;
8759 if (fix_ldbl_sprintf_bug == TRUE) {
8769 # undef MY_DBL_MAX_BUG
8772 #endif /* HAS_LDBL_SPRINTF_BUG */
8774 need += 20; /* fudge factor */
8775 if (PL_efloatsize < need) {
8776 Safefree(PL_efloatbuf);
8777 PL_efloatsize = need + 20; /* more fudge */
8778 Newx(PL_efloatbuf, PL_efloatsize, char);
8779 PL_efloatbuf[0] = '\0';
8782 if ( !(width || left || plus || alt) && fill != '0'
8783 && has_precis && intsize != 'q' ) { /* Shortcuts */
8784 /* See earlier comment about buggy Gconvert when digits,
8786 if ( c == 'g' && precis) {
8787 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8788 /* May return an empty string for digits==0 */
8789 if (*PL_efloatbuf) {
8790 elen = strlen(PL_efloatbuf);
8791 goto float_converted;
8793 } else if ( c == 'f' && !precis) {
8794 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8799 char *ptr = ebuf + sizeof ebuf;
8802 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8803 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8804 if (intsize == 'q') {
8805 /* Copy the one or more characters in a long double
8806 * format before the 'base' ([efgEFG]) character to
8807 * the format string. */
8808 static char const prifldbl[] = PERL_PRIfldbl;
8809 char const *p = prifldbl + sizeof(prifldbl) - 3;
8810 while (p >= prifldbl) { *--ptr = *p--; }
8815 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8820 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8832 /* No taint. Otherwise we are in the strange situation
8833 * where printf() taints but print($float) doesn't.
8835 #if defined(HAS_LONG_DOUBLE)
8836 elen = ((intsize == 'q')
8837 ? my_sprintf(PL_efloatbuf, ptr, nv)
8838 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8840 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8844 eptr = PL_efloatbuf;
8852 i = SvCUR(sv) - origlen;
8855 case 'h': *(va_arg(*args, short*)) = i; break;
8856 default: *(va_arg(*args, int*)) = i; break;
8857 case 'l': *(va_arg(*args, long*)) = i; break;
8858 case 'V': *(va_arg(*args, IV*)) = i; break;
8860 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8865 sv_setuv_mg(argsv, (UV)i);
8866 continue; /* not "break" */
8873 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8874 && ckWARN(WARN_PRINTF))
8876 SV * const msg = sv_newmortal();
8877 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8878 (PL_op->op_type == OP_PRTF) ? "" : "s");
8881 Perl_sv_catpvf(aTHX_ msg,
8882 "\"%%%c\"", c & 0xFF);
8884 Perl_sv_catpvf(aTHX_ msg,
8885 "\"%%\\%03"UVof"\"",
8888 sv_catpvs(msg, "end of string");
8889 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8892 /* output mangled stuff ... */
8898 /* ... right here, because formatting flags should not apply */
8899 SvGROW(sv, SvCUR(sv) + elen + 1);
8901 Copy(eptr, p, elen, char);
8904 SvCUR_set(sv, p - SvPVX_const(sv));
8906 continue; /* not "break" */
8909 /* calculate width before utf8_upgrade changes it */
8910 have = esignlen + zeros + elen;
8912 Perl_croak_nocontext(PL_memory_wrap);
8914 if (is_utf8 != has_utf8) {
8917 sv_utf8_upgrade(sv);
8920 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8921 sv_utf8_upgrade(nsv);
8922 eptr = SvPVX_const(nsv);
8925 SvGROW(sv, SvCUR(sv) + elen + 1);
8930 need = (have > width ? have : width);
8933 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8934 Perl_croak_nocontext(PL_memory_wrap);
8935 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8937 if (esignlen && fill == '0') {
8939 for (i = 0; i < (int)esignlen; i++)
8943 memset(p, fill, gap);
8946 if (esignlen && fill != '0') {
8948 for (i = 0; i < (int)esignlen; i++)
8953 for (i = zeros; i; i--)
8957 Copy(eptr, p, elen, char);
8961 memset(p, ' ', gap);
8966 Copy(dotstr, p, dotstrlen, char);
8970 vectorize = FALSE; /* done iterating over vecstr */
8977 SvCUR_set(sv, p - SvPVX_const(sv));
8985 /* =========================================================================
8987 =head1 Cloning an interpreter
8989 All the macros and functions in this section are for the private use of
8990 the main function, perl_clone().
8992 The foo_dup() functions make an exact copy of an existing foo thinngy.
8993 During the course of a cloning, a hash table is used to map old addresses
8994 to new addresses. The table is created and manipulated with the
8995 ptr_table_* functions.
8999 ============================================================================*/
9002 #if defined(USE_ITHREADS)
9004 #ifndef GpREFCNT_inc
9005 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9009 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9010 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9011 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9012 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9013 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9014 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9015 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9016 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9017 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9018 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9019 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9020 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9021 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9024 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9025 regcomp.c. AMS 20010712 */
9028 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9033 struct reg_substr_datum *s;
9036 return (REGEXP *)NULL;
9038 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9041 len = r->offsets[0];
9042 npar = r->nparens+1;
9044 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9045 Copy(r->program, ret->program, len+1, regnode);
9047 Newx(ret->startp, npar, I32);
9048 Copy(r->startp, ret->startp, npar, I32);
9049 Newx(ret->endp, npar, I32);
9050 Copy(r->startp, ret->startp, npar, I32);
9052 Newx(ret->substrs, 1, struct reg_substr_data);
9053 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9054 s->min_offset = r->substrs->data[i].min_offset;
9055 s->max_offset = r->substrs->data[i].max_offset;
9056 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9057 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9060 ret->regstclass = NULL;
9063 const int count = r->data->count;
9066 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9067 char, struct reg_data);
9068 Newx(d->what, count, U8);
9071 for (i = 0; i < count; i++) {
9072 d->what[i] = r->data->what[i];
9073 switch (d->what[i]) {
9074 /* legal options are one of: sfpont
9075 see also regcomp.h and pregfree() */
9077 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9080 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9083 /* This is cheating. */
9084 Newx(d->data[i], 1, struct regnode_charclass_class);
9085 StructCopy(r->data->data[i], d->data[i],
9086 struct regnode_charclass_class);
9087 ret->regstclass = (regnode*)d->data[i];
9090 /* Compiled op trees are readonly, and can thus be
9091 shared without duplication. */
9093 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9097 d->data[i] = r->data->data[i];
9100 d->data[i] = r->data->data[i];
9102 ((reg_trie_data*)d->data[i])->refcount++;
9106 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9115 Newx(ret->offsets, 2*len+1, U32);
9116 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9118 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9119 ret->refcnt = r->refcnt;
9120 ret->minlen = r->minlen;
9121 ret->prelen = r->prelen;
9122 ret->nparens = r->nparens;
9123 ret->lastparen = r->lastparen;
9124 ret->lastcloseparen = r->lastcloseparen;
9125 ret->reganch = r->reganch;
9127 ret->sublen = r->sublen;
9129 if (RX_MATCH_COPIED(ret))
9130 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9133 #ifdef PERL_OLD_COPY_ON_WRITE
9134 ret->saved_copy = NULL;
9137 ptr_table_store(PL_ptr_table, r, ret);
9141 /* duplicate a file handle */
9144 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9148 PERL_UNUSED_ARG(type);
9151 return (PerlIO*)NULL;
9153 /* look for it in the table first */
9154 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9158 /* create anew and remember what it is */
9159 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9160 ptr_table_store(PL_ptr_table, fp, ret);
9164 /* duplicate a directory handle */
9167 Perl_dirp_dup(pTHX_ DIR *dp)
9175 /* duplicate a typeglob */
9178 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9183 /* look for it in the table first */
9184 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9188 /* create anew and remember what it is */
9190 ptr_table_store(PL_ptr_table, gp, ret);
9193 ret->gp_refcnt = 0; /* must be before any other dups! */
9194 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9195 ret->gp_io = io_dup_inc(gp->gp_io, param);
9196 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9197 ret->gp_av = av_dup_inc(gp->gp_av, param);
9198 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9199 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9200 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9201 ret->gp_cvgen = gp->gp_cvgen;
9202 ret->gp_line = gp->gp_line;
9203 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9207 /* duplicate a chain of magic */
9210 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9212 MAGIC *mgprev = (MAGIC*)NULL;
9215 return (MAGIC*)NULL;
9216 /* look for it in the table first */
9217 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9221 for (; mg; mg = mg->mg_moremagic) {
9223 Newxz(nmg, 1, MAGIC);
9225 mgprev->mg_moremagic = nmg;
9228 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9229 nmg->mg_private = mg->mg_private;
9230 nmg->mg_type = mg->mg_type;
9231 nmg->mg_flags = mg->mg_flags;
9232 if (mg->mg_type == PERL_MAGIC_qr) {
9233 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9235 else if(mg->mg_type == PERL_MAGIC_backref) {
9236 /* The backref AV has its reference count deliberately bumped by
9238 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9240 else if (mg->mg_type == PERL_MAGIC_symtab) {
9241 nmg->mg_obj = mg->mg_obj;
9244 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9245 ? sv_dup_inc(mg->mg_obj, param)
9246 : sv_dup(mg->mg_obj, param);
9248 nmg->mg_len = mg->mg_len;
9249 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9250 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9251 if (mg->mg_len > 0) {
9252 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9253 if (mg->mg_type == PERL_MAGIC_overload_table &&
9254 AMT_AMAGIC((AMT*)mg->mg_ptr))
9256 const AMT * const amtp = (AMT*)mg->mg_ptr;
9257 AMT * const namtp = (AMT*)nmg->mg_ptr;
9259 for (i = 1; i < NofAMmeth; i++) {
9260 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9264 else if (mg->mg_len == HEf_SVKEY)
9265 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9267 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9268 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9275 /* create a new pointer-mapping table */
9278 Perl_ptr_table_new(pTHX)
9281 Newxz(tbl, 1, PTR_TBL_t);
9284 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9288 #define PTR_TABLE_HASH(ptr) \
9289 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9292 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9293 following define) and at call to new_body_inline made below in
9294 Perl_ptr_table_store()
9297 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9299 /* map an existing pointer using a table */
9301 STATIC PTR_TBL_ENT_t *
9302 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9303 PTR_TBL_ENT_t *tblent;
9304 const UV hash = PTR_TABLE_HASH(sv);
9306 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9307 for (; tblent; tblent = tblent->next) {
9308 if (tblent->oldval == sv)
9315 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9317 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9318 return tblent ? tblent->newval : (void *) 0;
9321 /* add a new entry to a pointer-mapping table */
9324 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9326 PTR_TBL_ENT_t *tblent = S_ptr_table_find(tbl, oldsv);
9329 tblent->newval = newsv;
9331 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9333 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9334 tblent->oldval = oldsv;
9335 tblent->newval = newsv;
9336 tblent->next = tbl->tbl_ary[entry];
9337 tbl->tbl_ary[entry] = tblent;
9339 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9340 ptr_table_split(tbl);
9344 /* double the hash bucket size of an existing ptr table */
9347 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9349 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9350 const UV oldsize = tbl->tbl_max + 1;
9351 UV newsize = oldsize * 2;
9354 Renew(ary, newsize, PTR_TBL_ENT_t*);
9355 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9356 tbl->tbl_max = --newsize;
9358 for (i=0; i < oldsize; i++, ary++) {
9359 PTR_TBL_ENT_t **curentp, **entp, *ent;
9362 curentp = ary + oldsize;
9363 for (entp = ary, ent = *ary; ent; ent = *entp) {
9364 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9366 ent->next = *curentp;
9376 /* remove all the entries from a ptr table */
9379 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9381 if (tbl && tbl->tbl_items) {
9382 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9383 UV riter = tbl->tbl_max;
9386 PTR_TBL_ENT_t *entry = array[riter];
9389 PTR_TBL_ENT_t * const oentry = entry;
9390 entry = entry->next;
9399 /* clear and free a ptr table */
9402 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9407 ptr_table_clear(tbl);
9408 Safefree(tbl->tbl_ary);
9414 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9417 SvRV_set(dstr, SvWEAKREF(sstr)
9418 ? sv_dup(SvRV(sstr), param)
9419 : sv_dup_inc(SvRV(sstr), param));
9422 else if (SvPVX_const(sstr)) {
9423 /* Has something there */
9425 /* Normal PV - clone whole allocated space */
9426 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9427 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9428 /* Not that normal - actually sstr is copy on write.
9429 But we are a true, independant SV, so: */
9430 SvREADONLY_off(dstr);
9435 /* Special case - not normally malloced for some reason */
9436 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9437 /* A "shared" PV - clone it as "shared" PV */
9439 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9443 /* Some other special case - random pointer */
9444 SvPV_set(dstr, SvPVX(sstr));
9450 if (SvTYPE(dstr) == SVt_RV)
9451 SvRV_set(dstr, NULL);
9453 SvPV_set(dstr, NULL);
9457 /* duplicate an SV of any type (including AV, HV etc) */
9460 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9465 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9467 /* look for it in the table first */
9468 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9472 if(param->flags & CLONEf_JOIN_IN) {
9473 /** We are joining here so we don't want do clone
9474 something that is bad **/
9475 if (SvTYPE(sstr) == SVt_PVHV) {
9476 const char * const hvname = HvNAME_get(sstr);
9478 /** don't clone stashes if they already exist **/
9479 return (SV*)gv_stashpv(hvname,0);
9483 /* create anew and remember what it is */
9486 #ifdef DEBUG_LEAKING_SCALARS
9487 dstr->sv_debug_optype = sstr->sv_debug_optype;
9488 dstr->sv_debug_line = sstr->sv_debug_line;
9489 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9490 dstr->sv_debug_cloned = 1;
9491 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9494 ptr_table_store(PL_ptr_table, sstr, dstr);
9497 SvFLAGS(dstr) = SvFLAGS(sstr);
9498 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9499 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9502 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9503 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9504 PL_watch_pvx, SvPVX_const(sstr));
9507 /* don't clone objects whose class has asked us not to */
9508 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9509 SvFLAGS(dstr) &= ~SVTYPEMASK;
9514 switch (SvTYPE(sstr)) {
9519 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9520 SvIV_set(dstr, SvIVX(sstr));
9523 SvANY(dstr) = new_XNV();
9524 SvNV_set(dstr, SvNVX(sstr));
9527 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9528 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9532 /* These are all the types that need complex bodies allocating. */
9534 const svtype sv_type = SvTYPE(sstr);
9535 const struct body_details *const sv_type_details
9536 = bodies_by_type + sv_type;
9540 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9545 if (GvUNIQUE((GV*)sstr)) {
9546 /* Do sharing here, and fall through */
9559 assert(sv_type_details->size);
9560 if (sv_type_details->arena) {
9561 new_body_inline(new_body, sv_type_details->size, sv_type);
9563 = (void*)((char*)new_body - sv_type_details->offset);
9565 new_body = new_NOARENA(sv_type_details);
9569 SvANY(dstr) = new_body;
9572 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9573 ((char*)SvANY(dstr)) + sv_type_details->offset,
9574 sv_type_details->copy, char);
9576 Copy(((char*)SvANY(sstr)),
9577 ((char*)SvANY(dstr)),
9578 sv_type_details->size + sv_type_details->offset, char);
9581 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9582 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9584 /* The Copy above means that all the source (unduplicated) pointers
9585 are now in the destination. We can check the flags and the
9586 pointers in either, but it's possible that there's less cache
9587 missing by always going for the destination.
9588 FIXME - instrument and check that assumption */
9589 if (sv_type >= SVt_PVMG) {
9591 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9593 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9596 /* The cast silences a GCC warning about unhandled types. */
9597 switch ((int)sv_type) {
9609 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9610 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9611 LvTARG(dstr) = dstr;
9612 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9613 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9615 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9618 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9619 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9620 /* Don't call sv_add_backref here as it's going to be created
9621 as part of the magic cloning of the symbol table. */
9622 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9623 (void)GpREFCNT_inc(GvGP(dstr));
9626 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9627 if (IoOFP(dstr) == IoIFP(sstr))
9628 IoOFP(dstr) = IoIFP(dstr);
9630 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9631 /* PL_rsfp_filters entries have fake IoDIRP() */
9632 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9633 /* I have no idea why fake dirp (rsfps)
9634 should be treated differently but otherwise
9635 we end up with leaks -- sky*/
9636 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9637 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9638 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9640 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9641 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9642 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9644 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9646 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
9649 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9650 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9651 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9654 if (AvARRAY((AV*)sstr)) {
9655 SV **dst_ary, **src_ary;
9656 SSize_t items = AvFILLp((AV*)sstr) + 1;
9658 src_ary = AvARRAY((AV*)sstr);
9659 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9660 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9661 SvPV_set(dstr, (char*)dst_ary);
9662 AvALLOC((AV*)dstr) = dst_ary;
9663 if (AvREAL((AV*)sstr)) {
9665 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9669 *dst_ary++ = sv_dup(*src_ary++, param);
9671 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9672 while (items-- > 0) {
9673 *dst_ary++ = &PL_sv_undef;
9677 SvPV_set(dstr, NULL);
9678 AvALLOC((AV*)dstr) = (SV**)NULL;
9685 if (HvARRAY((HV*)sstr)) {
9687 const bool sharekeys = !!HvSHAREKEYS(sstr);
9688 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9689 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9691 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9692 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9694 HvARRAY(dstr) = (HE**)darray;
9695 while (i <= sxhv->xhv_max) {
9696 const HE *source = HvARRAY(sstr)[i];
9697 HvARRAY(dstr)[i] = source
9698 ? he_dup(source, sharekeys, param) : 0;
9702 struct xpvhv_aux * const saux = HvAUX(sstr);
9703 struct xpvhv_aux * const daux = HvAUX(dstr);
9704 /* This flag isn't copied. */
9705 /* SvOOK_on(hv) attacks the IV flags. */
9706 SvFLAGS(dstr) |= SVf_OOK;
9708 hvname = saux->xhv_name;
9710 = hvname ? hek_dup(hvname, param) : hvname;
9712 daux->xhv_riter = saux->xhv_riter;
9713 daux->xhv_eiter = saux->xhv_eiter
9714 ? he_dup(saux->xhv_eiter,
9715 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9716 daux->xhv_backreferences = saux->xhv_backreferences
9717 ? (AV*) SvREFCNT_inc(
9725 SvPV_set(dstr, NULL);
9727 /* Record stashes for possible cloning in Perl_clone(). */
9729 av_push(param->stashes, dstr);
9734 /* NOTE: not refcounted */
9735 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9737 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9739 if (CvCONST(dstr)) {
9740 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9741 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9742 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9744 /* don't dup if copying back - CvGV isn't refcounted, so the
9745 * duped GV may never be freed. A bit of a hack! DAPM */
9746 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9747 NULL : gv_dup(CvGV(dstr), param) ;
9748 if (!(param->flags & CLONEf_COPY_STACKS)) {
9751 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9754 ? cv_dup( CvOUTSIDE(dstr), param)
9755 : cv_dup_inc(CvOUTSIDE(dstr), param);
9757 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9763 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9769 /* duplicate a context */
9772 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9777 return (PERL_CONTEXT*)NULL;
9779 /* look for it in the table first */
9780 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9784 /* create anew and remember what it is */
9785 Newxz(ncxs, max + 1, PERL_CONTEXT);
9786 ptr_table_store(PL_ptr_table, cxs, ncxs);
9789 PERL_CONTEXT * const cx = &cxs[ix];
9790 PERL_CONTEXT * const ncx = &ncxs[ix];
9791 ncx->cx_type = cx->cx_type;
9792 if (CxTYPE(cx) == CXt_SUBST) {
9793 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9796 ncx->blk_oldsp = cx->blk_oldsp;
9797 ncx->blk_oldcop = cx->blk_oldcop;
9798 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9799 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9800 ncx->blk_oldpm = cx->blk_oldpm;
9801 ncx->blk_gimme = cx->blk_gimme;
9802 switch (CxTYPE(cx)) {
9804 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9805 ? cv_dup_inc(cx->blk_sub.cv, param)
9806 : cv_dup(cx->blk_sub.cv,param));
9807 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9808 ? av_dup_inc(cx->blk_sub.argarray, param)
9810 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9811 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9812 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9813 ncx->blk_sub.lval = cx->blk_sub.lval;
9814 ncx->blk_sub.retop = cx->blk_sub.retop;
9817 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9818 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9819 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9820 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9821 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9822 ncx->blk_eval.retop = cx->blk_eval.retop;
9825 ncx->blk_loop.label = cx->blk_loop.label;
9826 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9827 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9828 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9829 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9830 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9831 ? cx->blk_loop.iterdata
9832 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9833 ncx->blk_loop.oldcomppad
9834 = (PAD*)ptr_table_fetch(PL_ptr_table,
9835 cx->blk_loop.oldcomppad);
9836 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9837 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9838 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9839 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9840 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9843 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9844 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9845 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9846 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9847 ncx->blk_sub.retop = cx->blk_sub.retop;
9859 /* duplicate a stack info structure */
9862 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9867 return (PERL_SI*)NULL;
9869 /* look for it in the table first */
9870 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9874 /* create anew and remember what it is */
9875 Newxz(nsi, 1, PERL_SI);
9876 ptr_table_store(PL_ptr_table, si, nsi);
9878 nsi->si_stack = av_dup_inc(si->si_stack, param);
9879 nsi->si_cxix = si->si_cxix;
9880 nsi->si_cxmax = si->si_cxmax;
9881 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9882 nsi->si_type = si->si_type;
9883 nsi->si_prev = si_dup(si->si_prev, param);
9884 nsi->si_next = si_dup(si->si_next, param);
9885 nsi->si_markoff = si->si_markoff;
9890 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9891 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9892 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9893 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9894 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9895 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9896 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9897 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9898 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9899 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9900 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9901 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9902 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9903 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9906 #define pv_dup_inc(p) SAVEPV(p)
9907 #define pv_dup(p) SAVEPV(p)
9908 #define svp_dup_inc(p,pp) any_dup(p,pp)
9910 /* map any object to the new equivent - either something in the
9911 * ptr table, or something in the interpreter structure
9915 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9922 /* look for it in the table first */
9923 ret = ptr_table_fetch(PL_ptr_table, v);
9927 /* see if it is part of the interpreter structure */
9928 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9929 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9937 /* duplicate the save stack */
9940 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9942 ANY * const ss = proto_perl->Tsavestack;
9943 const I32 max = proto_perl->Tsavestack_max;
9944 I32 ix = proto_perl->Tsavestack_ix;
9956 void (*dptr) (void*);
9957 void (*dxptr) (pTHX_ void*);
9959 Newxz(nss, max, ANY);
9962 I32 i = POPINT(ss,ix);
9965 case SAVEt_ITEM: /* normal string */
9966 sv = (SV*)POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9968 sv = (SV*)POPPTR(ss,ix);
9969 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9971 case SAVEt_SV: /* scalar reference */
9972 sv = (SV*)POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9974 gv = (GV*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9977 case SAVEt_GENERIC_PVREF: /* generic char* */
9978 c = (char*)POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = pv_dup(c);
9980 ptr = POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9983 case SAVEt_SHARED_PVREF: /* char* in shared space */
9984 c = (char*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = savesharedpv(c);
9986 ptr = POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9989 case SAVEt_GENERIC_SVREF: /* generic sv */
9990 case SAVEt_SVREF: /* scalar reference */
9991 sv = (SV*)POPPTR(ss,ix);
9992 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9993 ptr = POPPTR(ss,ix);
9994 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9996 case SAVEt_AV: /* array reference */
9997 av = (AV*)POPPTR(ss,ix);
9998 TOPPTR(nss,ix) = av_dup_inc(av, param);
9999 gv = (GV*)POPPTR(ss,ix);
10000 TOPPTR(nss,ix) = gv_dup(gv, param);
10002 case SAVEt_HV: /* hash reference */
10003 hv = (HV*)POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10005 gv = (GV*)POPPTR(ss,ix);
10006 TOPPTR(nss,ix) = gv_dup(gv, param);
10008 case SAVEt_INT: /* int reference */
10009 ptr = POPPTR(ss,ix);
10010 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10011 intval = (int)POPINT(ss,ix);
10012 TOPINT(nss,ix) = intval;
10014 case SAVEt_LONG: /* long reference */
10015 ptr = POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10017 longval = (long)POPLONG(ss,ix);
10018 TOPLONG(nss,ix) = longval;
10020 case SAVEt_I32: /* I32 reference */
10021 case SAVEt_I16: /* I16 reference */
10022 case SAVEt_I8: /* I8 reference */
10023 ptr = POPPTR(ss,ix);
10024 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10026 TOPINT(nss,ix) = i;
10028 case SAVEt_IV: /* IV reference */
10029 ptr = POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10032 TOPIV(nss,ix) = iv;
10034 case SAVEt_SPTR: /* SV* reference */
10035 ptr = POPPTR(ss,ix);
10036 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10037 sv = (SV*)POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = sv_dup(sv, param);
10040 case SAVEt_VPTR: /* random* reference */
10041 ptr = POPPTR(ss,ix);
10042 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10043 ptr = POPPTR(ss,ix);
10044 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10046 case SAVEt_PPTR: /* char* reference */
10047 ptr = POPPTR(ss,ix);
10048 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10049 c = (char*)POPPTR(ss,ix);
10050 TOPPTR(nss,ix) = pv_dup(c);
10052 case SAVEt_HPTR: /* HV* reference */
10053 ptr = POPPTR(ss,ix);
10054 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10055 hv = (HV*)POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = hv_dup(hv, param);
10058 case SAVEt_APTR: /* AV* reference */
10059 ptr = POPPTR(ss,ix);
10060 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10061 av = (AV*)POPPTR(ss,ix);
10062 TOPPTR(nss,ix) = av_dup(av, param);
10065 gv = (GV*)POPPTR(ss,ix);
10066 TOPPTR(nss,ix) = gv_dup(gv, param);
10068 case SAVEt_GP: /* scalar reference */
10069 gp = (GP*)POPPTR(ss,ix);
10070 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10071 (void)GpREFCNT_inc(gp);
10072 gv = (GV*)POPPTR(ss,ix);
10073 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10074 c = (char*)POPPTR(ss,ix);
10075 TOPPTR(nss,ix) = pv_dup(c);
10077 TOPIV(nss,ix) = iv;
10079 TOPIV(nss,ix) = iv;
10082 case SAVEt_MORTALIZESV:
10083 sv = (SV*)POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10087 ptr = POPPTR(ss,ix);
10088 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10089 /* these are assumed to be refcounted properly */
10091 switch (((OP*)ptr)->op_type) {
10093 case OP_LEAVESUBLV:
10097 case OP_LEAVEWRITE:
10098 TOPPTR(nss,ix) = ptr;
10103 TOPPTR(nss,ix) = NULL;
10108 TOPPTR(nss,ix) = NULL;
10111 c = (char*)POPPTR(ss,ix);
10112 TOPPTR(nss,ix) = pv_dup_inc(c);
10114 case SAVEt_CLEARSV:
10115 longval = POPLONG(ss,ix);
10116 TOPLONG(nss,ix) = longval;
10119 hv = (HV*)POPPTR(ss,ix);
10120 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10121 c = (char*)POPPTR(ss,ix);
10122 TOPPTR(nss,ix) = pv_dup_inc(c);
10124 TOPINT(nss,ix) = i;
10126 case SAVEt_DESTRUCTOR:
10127 ptr = POPPTR(ss,ix);
10128 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10129 dptr = POPDPTR(ss,ix);
10130 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10131 any_dup(FPTR2DPTR(void *, dptr),
10134 case SAVEt_DESTRUCTOR_X:
10135 ptr = POPPTR(ss,ix);
10136 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10137 dxptr = POPDXPTR(ss,ix);
10138 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10139 any_dup(FPTR2DPTR(void *, dxptr),
10142 case SAVEt_REGCONTEXT:
10145 TOPINT(nss,ix) = i;
10148 case SAVEt_STACK_POS: /* Position on Perl stack */
10150 TOPINT(nss,ix) = i;
10152 case SAVEt_AELEM: /* array element */
10153 sv = (SV*)POPPTR(ss,ix);
10154 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10156 TOPINT(nss,ix) = i;
10157 av = (AV*)POPPTR(ss,ix);
10158 TOPPTR(nss,ix) = av_dup_inc(av, param);
10160 case SAVEt_HELEM: /* hash element */
10161 sv = (SV*)POPPTR(ss,ix);
10162 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10163 sv = (SV*)POPPTR(ss,ix);
10164 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10165 hv = (HV*)POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10169 ptr = POPPTR(ss,ix);
10170 TOPPTR(nss,ix) = ptr;
10174 TOPINT(nss,ix) = i;
10176 case SAVEt_COMPPAD:
10177 av = (AV*)POPPTR(ss,ix);
10178 TOPPTR(nss,ix) = av_dup(av, param);
10181 longval = (long)POPLONG(ss,ix);
10182 TOPLONG(nss,ix) = longval;
10183 ptr = POPPTR(ss,ix);
10184 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10185 sv = (SV*)POPPTR(ss,ix);
10186 TOPPTR(nss,ix) = sv_dup(sv, param);
10189 ptr = POPPTR(ss,ix);
10190 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10191 longval = (long)POPBOOL(ss,ix);
10192 TOPBOOL(nss,ix) = (bool)longval;
10194 case SAVEt_SET_SVFLAGS:
10196 TOPINT(nss,ix) = i;
10198 TOPINT(nss,ix) = i;
10199 sv = (SV*)POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = sv_dup(sv, param);
10203 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10211 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10212 * flag to the result. This is done for each stash before cloning starts,
10213 * so we know which stashes want their objects cloned */
10216 do_mark_cloneable_stash(pTHX_ SV *sv)
10218 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10220 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10221 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10222 if (cloner && GvCV(cloner)) {
10229 XPUSHs(sv_2mortal(newSVhek(hvname)));
10231 call_sv((SV*)GvCV(cloner), G_SCALAR);
10238 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10246 =for apidoc perl_clone
10248 Create and return a new interpreter by cloning the current one.
10250 perl_clone takes these flags as parameters:
10252 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10253 without it we only clone the data and zero the stacks,
10254 with it we copy the stacks and the new perl interpreter is
10255 ready to run at the exact same point as the previous one.
10256 The pseudo-fork code uses COPY_STACKS while the
10257 threads->new doesn't.
10259 CLONEf_KEEP_PTR_TABLE
10260 perl_clone keeps a ptr_table with the pointer of the old
10261 variable as a key and the new variable as a value,
10262 this allows it to check if something has been cloned and not
10263 clone it again but rather just use the value and increase the
10264 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10265 the ptr_table using the function
10266 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10267 reason to keep it around is if you want to dup some of your own
10268 variable who are outside the graph perl scans, example of this
10269 code is in threads.xs create
10272 This is a win32 thing, it is ignored on unix, it tells perls
10273 win32host code (which is c++) to clone itself, this is needed on
10274 win32 if you want to run two threads at the same time,
10275 if you just want to do some stuff in a separate perl interpreter
10276 and then throw it away and return to the original one,
10277 you don't need to do anything.
10282 /* XXX the above needs expanding by someone who actually understands it ! */
10283 EXTERN_C PerlInterpreter *
10284 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10287 perl_clone(PerlInterpreter *proto_perl, UV flags)
10290 #ifdef PERL_IMPLICIT_SYS
10292 /* perlhost.h so we need to call into it
10293 to clone the host, CPerlHost should have a c interface, sky */
10295 if (flags & CLONEf_CLONE_HOST) {
10296 return perl_clone_host(proto_perl,flags);
10298 return perl_clone_using(proto_perl, flags,
10300 proto_perl->IMemShared,
10301 proto_perl->IMemParse,
10303 proto_perl->IStdIO,
10307 proto_perl->IProc);
10311 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10312 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10313 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10314 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10315 struct IPerlDir* ipD, struct IPerlSock* ipS,
10316 struct IPerlProc* ipP)
10318 /* XXX many of the string copies here can be optimized if they're
10319 * constants; they need to be allocated as common memory and just
10320 * their pointers copied. */
10323 CLONE_PARAMS clone_params;
10324 CLONE_PARAMS* const param = &clone_params;
10326 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10327 /* for each stash, determine whether its objects should be cloned */
10328 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10329 PERL_SET_THX(my_perl);
10332 Poison(my_perl, 1, PerlInterpreter);
10338 PL_savestack_ix = 0;
10339 PL_savestack_max = -1;
10340 PL_sig_pending = 0;
10341 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10342 # else /* !DEBUGGING */
10343 Zero(my_perl, 1, PerlInterpreter);
10344 # endif /* DEBUGGING */
10346 /* host pointers */
10348 PL_MemShared = ipMS;
10349 PL_MemParse = ipMP;
10356 #else /* !PERL_IMPLICIT_SYS */
10358 CLONE_PARAMS clone_params;
10359 CLONE_PARAMS* param = &clone_params;
10360 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10361 /* for each stash, determine whether its objects should be cloned */
10362 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10363 PERL_SET_THX(my_perl);
10366 Poison(my_perl, 1, PerlInterpreter);
10372 PL_savestack_ix = 0;
10373 PL_savestack_max = -1;
10374 PL_sig_pending = 0;
10375 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10376 # else /* !DEBUGGING */
10377 Zero(my_perl, 1, PerlInterpreter);
10378 # endif /* DEBUGGING */
10379 #endif /* PERL_IMPLICIT_SYS */
10380 param->flags = flags;
10381 param->proto_perl = proto_perl;
10383 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10385 PL_body_arenas = NULL;
10386 Zero(&PL_body_roots, 1, PL_body_roots);
10388 PL_nice_chunk = NULL;
10389 PL_nice_chunk_size = 0;
10391 PL_sv_objcount = 0;
10393 PL_sv_arenaroot = NULL;
10395 PL_debug = proto_perl->Idebug;
10397 PL_hash_seed = proto_perl->Ihash_seed;
10398 PL_rehash_seed = proto_perl->Irehash_seed;
10400 #ifdef USE_REENTRANT_API
10401 /* XXX: things like -Dm will segfault here in perlio, but doing
10402 * PERL_SET_CONTEXT(proto_perl);
10403 * breaks too many other things
10405 Perl_reentrant_init(aTHX);
10408 /* create SV map for pointer relocation */
10409 PL_ptr_table = ptr_table_new();
10411 /* initialize these special pointers as early as possible */
10412 SvANY(&PL_sv_undef) = NULL;
10413 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10414 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10415 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10417 SvANY(&PL_sv_no) = new_XPVNV();
10418 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10419 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10420 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10421 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10422 SvCUR_set(&PL_sv_no, 0);
10423 SvLEN_set(&PL_sv_no, 1);
10424 SvIV_set(&PL_sv_no, 0);
10425 SvNV_set(&PL_sv_no, 0);
10426 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10428 SvANY(&PL_sv_yes) = new_XPVNV();
10429 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10430 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10431 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10432 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10433 SvCUR_set(&PL_sv_yes, 1);
10434 SvLEN_set(&PL_sv_yes, 2);
10435 SvIV_set(&PL_sv_yes, 1);
10436 SvNV_set(&PL_sv_yes, 1);
10437 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10439 /* create (a non-shared!) shared string table */
10440 PL_strtab = newHV();
10441 HvSHAREKEYS_off(PL_strtab);
10442 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10443 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10445 PL_compiling = proto_perl->Icompiling;
10447 /* These two PVs will be free'd special way so must set them same way op.c does */
10448 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10449 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10451 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10452 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10454 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10455 if (!specialWARN(PL_compiling.cop_warnings))
10456 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10457 if (!specialCopIO(PL_compiling.cop_io))
10458 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10459 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10461 /* pseudo environmental stuff */
10462 PL_origargc = proto_perl->Iorigargc;
10463 PL_origargv = proto_perl->Iorigargv;
10465 param->stashes = newAV(); /* Setup array of objects to call clone on */
10467 /* Set tainting stuff before PerlIO_debug can possibly get called */
10468 PL_tainting = proto_perl->Itainting;
10469 PL_taint_warn = proto_perl->Itaint_warn;
10471 #ifdef PERLIO_LAYERS
10472 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10473 PerlIO_clone(aTHX_ proto_perl, param);
10476 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10477 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10478 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10479 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10480 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10481 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10484 PL_minus_c = proto_perl->Iminus_c;
10485 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10486 PL_localpatches = proto_perl->Ilocalpatches;
10487 PL_splitstr = proto_perl->Isplitstr;
10488 PL_preprocess = proto_perl->Ipreprocess;
10489 PL_minus_n = proto_perl->Iminus_n;
10490 PL_minus_p = proto_perl->Iminus_p;
10491 PL_minus_l = proto_perl->Iminus_l;
10492 PL_minus_a = proto_perl->Iminus_a;
10493 PL_minus_E = proto_perl->Iminus_E;
10494 PL_minus_F = proto_perl->Iminus_F;
10495 PL_doswitches = proto_perl->Idoswitches;
10496 PL_dowarn = proto_perl->Idowarn;
10497 PL_doextract = proto_perl->Idoextract;
10498 PL_sawampersand = proto_perl->Isawampersand;
10499 PL_unsafe = proto_perl->Iunsafe;
10500 PL_inplace = SAVEPV(proto_perl->Iinplace);
10501 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10502 PL_perldb = proto_perl->Iperldb;
10503 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10504 PL_exit_flags = proto_perl->Iexit_flags;
10506 /* magical thingies */
10507 /* XXX time(&PL_basetime) when asked for? */
10508 PL_basetime = proto_perl->Ibasetime;
10509 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10511 PL_maxsysfd = proto_perl->Imaxsysfd;
10512 PL_multiline = proto_perl->Imultiline;
10513 PL_statusvalue = proto_perl->Istatusvalue;
10515 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10517 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10519 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10521 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10522 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10523 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10525 /* Clone the regex array */
10526 PL_regex_padav = newAV();
10528 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10529 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10531 av_push(PL_regex_padav,
10532 sv_dup_inc(regexen[0],param));
10533 for(i = 1; i <= len; i++) {
10534 const SV * const regex = regexen[i];
10537 ? sv_dup_inc(regex, param)
10539 newSViv(PTR2IV(re_dup(
10540 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10542 av_push(PL_regex_padav, sv);
10545 PL_regex_pad = AvARRAY(PL_regex_padav);
10547 /* shortcuts to various I/O objects */
10548 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10549 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10550 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10551 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10552 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10553 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10555 /* shortcuts to regexp stuff */
10556 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10558 /* shortcuts to misc objects */
10559 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10561 /* shortcuts to debugging objects */
10562 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10563 PL_DBline = gv_dup(proto_perl->IDBline, param);
10564 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10565 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10566 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10567 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10568 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10569 PL_lineary = av_dup(proto_perl->Ilineary, param);
10570 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10572 /* symbol tables */
10573 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10574 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10575 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10576 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10577 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10579 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10580 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10581 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10582 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10583 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10584 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10586 PL_sub_generation = proto_perl->Isub_generation;
10588 /* funky return mechanisms */
10589 PL_forkprocess = proto_perl->Iforkprocess;
10591 /* subprocess state */
10592 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10594 /* internal state */
10595 PL_maxo = proto_perl->Imaxo;
10596 if (proto_perl->Iop_mask)
10597 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10600 /* PL_asserting = proto_perl->Iasserting; */
10602 /* current interpreter roots */
10603 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10604 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10605 PL_main_start = proto_perl->Imain_start;
10606 PL_eval_root = proto_perl->Ieval_root;
10607 PL_eval_start = proto_perl->Ieval_start;
10609 /* runtime control stuff */
10610 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10611 PL_copline = proto_perl->Icopline;
10613 PL_filemode = proto_perl->Ifilemode;
10614 PL_lastfd = proto_perl->Ilastfd;
10615 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10618 PL_gensym = proto_perl->Igensym;
10619 PL_preambled = proto_perl->Ipreambled;
10620 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10621 PL_laststatval = proto_perl->Ilaststatval;
10622 PL_laststype = proto_perl->Ilaststype;
10625 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10627 /* interpreter atexit processing */
10628 PL_exitlistlen = proto_perl->Iexitlistlen;
10629 if (PL_exitlistlen) {
10630 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10631 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10634 PL_exitlist = (PerlExitListEntry*)NULL;
10636 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10637 if (PL_my_cxt_size) {
10638 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10639 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10642 PL_my_cxt_list = (void**)NULL;
10643 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10644 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10645 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10647 PL_profiledata = NULL;
10648 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10649 /* PL_rsfp_filters entries have fake IoDIRP() */
10650 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10652 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10654 PAD_CLONE_VARS(proto_perl, param);
10656 #ifdef HAVE_INTERP_INTERN
10657 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10660 /* more statics moved here */
10661 PL_generation = proto_perl->Igeneration;
10662 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10664 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10665 PL_in_clean_all = proto_perl->Iin_clean_all;
10667 PL_uid = proto_perl->Iuid;
10668 PL_euid = proto_perl->Ieuid;
10669 PL_gid = proto_perl->Igid;
10670 PL_egid = proto_perl->Iegid;
10671 PL_nomemok = proto_perl->Inomemok;
10672 PL_an = proto_perl->Ian;
10673 PL_evalseq = proto_perl->Ievalseq;
10674 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10675 PL_origalen = proto_perl->Iorigalen;
10676 #ifdef PERL_USES_PL_PIDSTATUS
10677 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10679 PL_osname = SAVEPV(proto_perl->Iosname);
10680 PL_sighandlerp = proto_perl->Isighandlerp;
10682 PL_runops = proto_perl->Irunops;
10684 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10687 PL_cshlen = proto_perl->Icshlen;
10688 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10691 PL_lex_state = proto_perl->Ilex_state;
10692 PL_lex_defer = proto_perl->Ilex_defer;
10693 PL_lex_expect = proto_perl->Ilex_expect;
10694 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10695 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10696 PL_lex_starts = proto_perl->Ilex_starts;
10697 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10698 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10699 PL_lex_op = proto_perl->Ilex_op;
10700 PL_lex_inpat = proto_perl->Ilex_inpat;
10701 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10702 PL_lex_brackets = proto_perl->Ilex_brackets;
10703 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10704 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10705 PL_lex_casemods = proto_perl->Ilex_casemods;
10706 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10707 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10709 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10710 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10711 PL_nexttoke = proto_perl->Inexttoke;
10713 /* XXX This is probably masking the deeper issue of why
10714 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10715 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10716 * (A little debugging with a watchpoint on it may help.)
10718 if (SvANY(proto_perl->Ilinestr)) {
10719 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10720 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10721 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10722 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10723 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10724 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10725 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10726 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10727 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10730 PL_linestr = newSV(79);
10731 sv_upgrade(PL_linestr,SVt_PVIV);
10732 sv_setpvn(PL_linestr,"",0);
10733 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10735 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10736 PL_pending_ident = proto_perl->Ipending_ident;
10737 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10739 PL_expect = proto_perl->Iexpect;
10741 PL_multi_start = proto_perl->Imulti_start;
10742 PL_multi_end = proto_perl->Imulti_end;
10743 PL_multi_open = proto_perl->Imulti_open;
10744 PL_multi_close = proto_perl->Imulti_close;
10746 PL_error_count = proto_perl->Ierror_count;
10747 PL_subline = proto_perl->Isubline;
10748 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10750 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10751 if (SvANY(proto_perl->Ilinestr)) {
10752 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10753 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10754 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10755 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10756 PL_last_lop_op = proto_perl->Ilast_lop_op;
10759 PL_last_uni = SvPVX(PL_linestr);
10760 PL_last_lop = SvPVX(PL_linestr);
10761 PL_last_lop_op = 0;
10763 PL_in_my = proto_perl->Iin_my;
10764 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10766 PL_cryptseen = proto_perl->Icryptseen;
10769 PL_hints = proto_perl->Ihints;
10771 PL_amagic_generation = proto_perl->Iamagic_generation;
10773 #ifdef USE_LOCALE_COLLATE
10774 PL_collation_ix = proto_perl->Icollation_ix;
10775 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10776 PL_collation_standard = proto_perl->Icollation_standard;
10777 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10778 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10779 #endif /* USE_LOCALE_COLLATE */
10781 #ifdef USE_LOCALE_NUMERIC
10782 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10783 PL_numeric_standard = proto_perl->Inumeric_standard;
10784 PL_numeric_local = proto_perl->Inumeric_local;
10785 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10786 #endif /* !USE_LOCALE_NUMERIC */
10788 /* utf8 character classes */
10789 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10790 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10791 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10792 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10793 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10794 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10795 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10796 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10797 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10798 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10799 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10800 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10801 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10802 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10803 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10804 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10805 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10806 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10807 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10808 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10810 /* Did the locale setup indicate UTF-8? */
10811 PL_utf8locale = proto_perl->Iutf8locale;
10812 /* Unicode features (see perlrun/-C) */
10813 PL_unicode = proto_perl->Iunicode;
10815 /* Pre-5.8 signals control */
10816 PL_signals = proto_perl->Isignals;
10818 /* times() ticks per second */
10819 PL_clocktick = proto_perl->Iclocktick;
10821 /* Recursion stopper for PerlIO_find_layer */
10822 PL_in_load_module = proto_perl->Iin_load_module;
10824 /* sort() routine */
10825 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10827 /* Not really needed/useful since the reenrant_retint is "volatile",
10828 * but do it for consistency's sake. */
10829 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10831 /* Hooks to shared SVs and locks. */
10832 PL_sharehook = proto_perl->Isharehook;
10833 PL_lockhook = proto_perl->Ilockhook;
10834 PL_unlockhook = proto_perl->Iunlockhook;
10835 PL_threadhook = proto_perl->Ithreadhook;
10837 PL_runops_std = proto_perl->Irunops_std;
10838 PL_runops_dbg = proto_perl->Irunops_dbg;
10840 #ifdef THREADS_HAVE_PIDS
10841 PL_ppid = proto_perl->Ippid;
10845 PL_last_swash_hv = NULL; /* reinits on demand */
10846 PL_last_swash_klen = 0;
10847 PL_last_swash_key[0]= '\0';
10848 PL_last_swash_tmps = (U8*)NULL;
10849 PL_last_swash_slen = 0;
10851 PL_glob_index = proto_perl->Iglob_index;
10852 PL_srand_called = proto_perl->Isrand_called;
10853 PL_uudmap['M'] = 0; /* reinits on demand */
10854 PL_bitcount = NULL; /* reinits on demand */
10856 if (proto_perl->Ipsig_pend) {
10857 Newxz(PL_psig_pend, SIG_SIZE, int);
10860 PL_psig_pend = (int*)NULL;
10863 if (proto_perl->Ipsig_ptr) {
10864 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10865 Newxz(PL_psig_name, SIG_SIZE, SV*);
10866 for (i = 1; i < SIG_SIZE; i++) {
10867 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10868 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10872 PL_psig_ptr = (SV**)NULL;
10873 PL_psig_name = (SV**)NULL;
10876 /* thrdvar.h stuff */
10878 if (flags & CLONEf_COPY_STACKS) {
10879 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10880 PL_tmps_ix = proto_perl->Ttmps_ix;
10881 PL_tmps_max = proto_perl->Ttmps_max;
10882 PL_tmps_floor = proto_perl->Ttmps_floor;
10883 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10885 while (i <= PL_tmps_ix) {
10886 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10890 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10891 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10892 Newxz(PL_markstack, i, I32);
10893 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10894 - proto_perl->Tmarkstack);
10895 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10896 - proto_perl->Tmarkstack);
10897 Copy(proto_perl->Tmarkstack, PL_markstack,
10898 PL_markstack_ptr - PL_markstack + 1, I32);
10900 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10901 * NOTE: unlike the others! */
10902 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10903 PL_scopestack_max = proto_perl->Tscopestack_max;
10904 Newxz(PL_scopestack, PL_scopestack_max, I32);
10905 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10907 /* NOTE: si_dup() looks at PL_markstack */
10908 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10910 /* PL_curstack = PL_curstackinfo->si_stack; */
10911 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10912 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10914 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10915 PL_stack_base = AvARRAY(PL_curstack);
10916 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10917 - proto_perl->Tstack_base);
10918 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10920 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10921 * NOTE: unlike the others! */
10922 PL_savestack_ix = proto_perl->Tsavestack_ix;
10923 PL_savestack_max = proto_perl->Tsavestack_max;
10924 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10925 PL_savestack = ss_dup(proto_perl, param);
10929 ENTER; /* perl_destruct() wants to LEAVE; */
10931 /* although we're not duplicating the tmps stack, we should still
10932 * add entries for any SVs on the tmps stack that got cloned by a
10933 * non-refcount means (eg a temp in @_); otherwise they will be
10936 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10937 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10938 proto_perl->Ttmps_stack[i]);
10939 if (nsv && !SvREFCNT(nsv)) {
10941 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10946 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10947 PL_top_env = &PL_start_env;
10949 PL_op = proto_perl->Top;
10952 PL_Xpv = (XPV*)NULL;
10953 PL_na = proto_perl->Tna;
10955 PL_statbuf = proto_perl->Tstatbuf;
10956 PL_statcache = proto_perl->Tstatcache;
10957 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10958 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10960 PL_timesbuf = proto_perl->Ttimesbuf;
10963 PL_tainted = proto_perl->Ttainted;
10964 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10965 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10966 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10967 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10968 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10969 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10970 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10971 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10972 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10974 PL_restartop = proto_perl->Trestartop;
10975 PL_in_eval = proto_perl->Tin_eval;
10976 PL_delaymagic = proto_perl->Tdelaymagic;
10977 PL_dirty = proto_perl->Tdirty;
10978 PL_localizing = proto_perl->Tlocalizing;
10980 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10981 PL_hv_fetch_ent_mh = Nullhe;
10982 PL_modcount = proto_perl->Tmodcount;
10983 PL_lastgotoprobe = NULL;
10984 PL_dumpindent = proto_perl->Tdumpindent;
10986 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10987 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10988 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10989 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10990 PL_efloatbuf = NULL; /* reinits on demand */
10991 PL_efloatsize = 0; /* reinits on demand */
10995 PL_screamfirst = NULL;
10996 PL_screamnext = NULL;
10997 PL_maxscream = -1; /* reinits on demand */
10998 PL_lastscream = NULL;
11000 PL_watchaddr = NULL;
11003 PL_regdummy = proto_perl->Tregdummy;
11004 PL_regprecomp = NULL;
11007 PL_colorset = 0; /* reinits PL_colors[] */
11008 /*PL_colors[6] = {0,0,0,0,0,0};*/
11009 PL_reginput = NULL;
11012 PL_regstartp = (I32*)NULL;
11013 PL_regendp = (I32*)NULL;
11014 PL_reglastparen = (U32*)NULL;
11015 PL_reglastcloseparen = (U32*)NULL;
11017 PL_reg_start_tmp = (char**)NULL;
11018 PL_reg_start_tmpl = 0;
11019 PL_regdata = (struct reg_data*)NULL;
11022 PL_reg_eval_set = 0;
11024 PL_regprogram = (regnode*)NULL;
11026 PL_regcc = (CURCUR*)NULL;
11027 PL_reg_call_cc = (struct re_cc_state*)NULL;
11028 PL_reg_re = (regexp*)NULL;
11029 PL_reg_ganch = NULL;
11031 PL_reg_match_utf8 = FALSE;
11032 PL_reg_magic = (MAGIC*)NULL;
11034 PL_reg_oldcurpm = (PMOP*)NULL;
11035 PL_reg_curpm = (PMOP*)NULL;
11036 PL_reg_oldsaved = NULL;
11037 PL_reg_oldsavedlen = 0;
11038 #ifdef PERL_OLD_COPY_ON_WRITE
11041 PL_reg_maxiter = 0;
11042 PL_reg_leftiter = 0;
11043 PL_reg_poscache = NULL;
11044 PL_reg_poscache_size= 0;
11046 /* RE engine - function pointers */
11047 PL_regcompp = proto_perl->Tregcompp;
11048 PL_regexecp = proto_perl->Tregexecp;
11049 PL_regint_start = proto_perl->Tregint_start;
11050 PL_regint_string = proto_perl->Tregint_string;
11051 PL_regfree = proto_perl->Tregfree;
11053 PL_reginterp_cnt = 0;
11054 PL_reg_starttry = 0;
11056 /* Pluggable optimizer */
11057 PL_peepp = proto_perl->Tpeepp;
11059 PL_stashcache = newHV();
11061 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11062 ptr_table_free(PL_ptr_table);
11063 PL_ptr_table = NULL;
11066 /* Call the ->CLONE method, if it exists, for each of the stashes
11067 identified by sv_dup() above.
11069 while(av_len(param->stashes) != -1) {
11070 HV* const stash = (HV*) av_shift(param->stashes);
11071 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11072 if (cloner && GvCV(cloner)) {
11077 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11079 call_sv((SV*)GvCV(cloner), G_DISCARD);
11085 SvREFCNT_dec(param->stashes);
11087 /* orphaned? eg threads->new inside BEGIN or use */
11088 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11089 (void)SvREFCNT_inc(PL_compcv);
11090 SAVEFREESV(PL_compcv);
11096 #endif /* USE_ITHREADS */
11099 =head1 Unicode Support
11101 =for apidoc sv_recode_to_utf8
11103 The encoding is assumed to be an Encode object, on entry the PV
11104 of the sv is assumed to be octets in that encoding, and the sv
11105 will be converted into Unicode (and UTF-8).
11107 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11108 is not a reference, nothing is done to the sv. If the encoding is not
11109 an C<Encode::XS> Encoding object, bad things will happen.
11110 (See F<lib/encoding.pm> and L<Encode>).
11112 The PV of the sv is returned.
11117 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11120 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11134 Passing sv_yes is wrong - it needs to be or'ed set of constants
11135 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11136 remove converted chars from source.
11138 Both will default the value - let them.
11140 XPUSHs(&PL_sv_yes);
11143 call_method("decode", G_SCALAR);
11147 s = SvPV_const(uni, len);
11148 if (s != SvPVX_const(sv)) {
11149 SvGROW(sv, len + 1);
11150 Move(s, SvPVX(sv), len + 1, char);
11151 SvCUR_set(sv, len);
11158 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11162 =for apidoc sv_cat_decode
11164 The encoding is assumed to be an Encode object, the PV of the ssv is
11165 assumed to be octets in that encoding and decoding the input starts
11166 from the position which (PV + *offset) pointed to. The dsv will be
11167 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11168 when the string tstr appears in decoding output or the input ends on
11169 the PV of the ssv. The value which the offset points will be modified
11170 to the last input position on the ssv.
11172 Returns TRUE if the terminator was found, else returns FALSE.
11177 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11178 SV *ssv, int *offset, char *tstr, int tlen)
11182 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11193 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11194 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11196 call_method("cat_decode", G_SCALAR);
11198 ret = SvTRUE(TOPs);
11199 *offset = SvIV(offsv);
11205 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11210 /* ---------------------------------------------------------------------
11212 * support functions for report_uninit()
11215 /* the maxiumum size of array or hash where we will scan looking
11216 * for the undefined element that triggered the warning */
11218 #define FUV_MAX_SEARCH_SIZE 1000
11220 /* Look for an entry in the hash whose value has the same SV as val;
11221 * If so, return a mortal copy of the key. */
11224 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11227 register HE **array;
11230 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11231 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11234 array = HvARRAY(hv);
11236 for (i=HvMAX(hv); i>0; i--) {
11237 register HE *entry;
11238 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11239 if (HeVAL(entry) != val)
11241 if ( HeVAL(entry) == &PL_sv_undef ||
11242 HeVAL(entry) == &PL_sv_placeholder)
11246 if (HeKLEN(entry) == HEf_SVKEY)
11247 return sv_mortalcopy(HeKEY_sv(entry));
11248 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11254 /* Look for an entry in the array whose value has the same SV as val;
11255 * If so, return the index, otherwise return -1. */
11258 S_find_array_subscript(pTHX_ AV *av, SV* val)
11263 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11264 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11268 for (i=AvFILLp(av); i>=0; i--) {
11269 if (svp[i] == val && svp[i] != &PL_sv_undef)
11275 /* S_varname(): return the name of a variable, optionally with a subscript.
11276 * If gv is non-zero, use the name of that global, along with gvtype (one
11277 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11278 * targ. Depending on the value of the subscript_type flag, return:
11281 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11282 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11283 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11284 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11287 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11288 SV* keyname, I32 aindex, int subscript_type)
11291 SV * const name = sv_newmortal();
11294 buffer[0] = gvtype;
11297 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11299 gv_fullname4(name, gv, buffer, 0);
11301 if ((unsigned int)SvPVX(name)[1] <= 26) {
11303 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11305 /* Swap the 1 unprintable control character for the 2 byte pretty
11306 version - ie substr($name, 1, 1) = $buffer; */
11307 sv_insert(name, 1, 1, buffer, 2);
11312 CV * const cv = find_runcv(&unused);
11316 if (!cv || !CvPADLIST(cv))
11318 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11319 sv = *av_fetch(av, targ, FALSE);
11320 /* SvLEN in a pad name is not to be trusted */
11321 sv_setpv(name, SvPV_nolen_const(sv));
11324 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11325 SV * const sv = newSV(0);
11326 *SvPVX(name) = '$';
11327 Perl_sv_catpvf(aTHX_ name, "{%s}",
11328 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11331 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11332 *SvPVX(name) = '$';
11333 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11335 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11336 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11343 =for apidoc find_uninit_var
11345 Find the name of the undefined variable (if any) that caused the operator o
11346 to issue a "Use of uninitialized value" warning.
11347 If match is true, only return a name if it's value matches uninit_sv.
11348 So roughly speaking, if a unary operator (such as OP_COS) generates a
11349 warning, then following the direct child of the op may yield an
11350 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11351 other hand, with OP_ADD there are two branches to follow, so we only print
11352 the variable name if we get an exact match.
11354 The name is returned as a mortal SV.
11356 Assumes that PL_op is the op that originally triggered the error, and that
11357 PL_comppad/PL_curpad points to the currently executing pad.
11363 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11371 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11372 uninit_sv == &PL_sv_placeholder)))
11375 switch (obase->op_type) {
11382 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11383 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11386 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11388 if (pad) { /* @lex, %lex */
11389 sv = PAD_SVl(obase->op_targ);
11393 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11394 /* @global, %global */
11395 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11398 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11400 else /* @{expr}, %{expr} */
11401 return find_uninit_var(cUNOPx(obase)->op_first,
11405 /* attempt to find a match within the aggregate */
11407 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11409 subscript_type = FUV_SUBSCRIPT_HASH;
11412 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11414 subscript_type = FUV_SUBSCRIPT_ARRAY;
11417 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11420 return varname(gv, hash ? '%' : '@', obase->op_targ,
11421 keysv, index, subscript_type);
11425 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11427 return varname(NULL, '$', obase->op_targ,
11428 NULL, 0, FUV_SUBSCRIPT_NONE);
11431 gv = cGVOPx_gv(obase);
11432 if (!gv || (match && GvSV(gv) != uninit_sv))
11434 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11437 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11440 av = (AV*)PAD_SV(obase->op_targ);
11441 if (!av || SvRMAGICAL(av))
11443 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11444 if (!svp || *svp != uninit_sv)
11447 return varname(NULL, '$', obase->op_targ,
11448 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11451 gv = cGVOPx_gv(obase);
11457 if (!av || SvRMAGICAL(av))
11459 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11460 if (!svp || *svp != uninit_sv)
11463 return varname(gv, '$', 0,
11464 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11469 o = cUNOPx(obase)->op_first;
11470 if (!o || o->op_type != OP_NULL ||
11471 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11473 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11477 if (PL_op == obase)
11478 /* $a[uninit_expr] or $h{uninit_expr} */
11479 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11482 o = cBINOPx(obase)->op_first;
11483 kid = cBINOPx(obase)->op_last;
11485 /* get the av or hv, and optionally the gv */
11487 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11488 sv = PAD_SV(o->op_targ);
11490 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11491 && cUNOPo->op_first->op_type == OP_GV)
11493 gv = cGVOPx_gv(cUNOPo->op_first);
11496 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11501 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11502 /* index is constant */
11506 if (obase->op_type == OP_HELEM) {
11507 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11508 if (!he || HeVAL(he) != uninit_sv)
11512 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11513 if (!svp || *svp != uninit_sv)
11517 if (obase->op_type == OP_HELEM)
11518 return varname(gv, '%', o->op_targ,
11519 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11521 return varname(gv, '@', o->op_targ, NULL,
11522 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11525 /* index is an expression;
11526 * attempt to find a match within the aggregate */
11527 if (obase->op_type == OP_HELEM) {
11528 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11530 return varname(gv, '%', o->op_targ,
11531 keysv, 0, FUV_SUBSCRIPT_HASH);
11534 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11536 return varname(gv, '@', o->op_targ,
11537 NULL, index, FUV_SUBSCRIPT_ARRAY);
11542 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11544 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11549 /* only examine RHS */
11550 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11553 o = cUNOPx(obase)->op_first;
11554 if (o->op_type == OP_PUSHMARK)
11557 if (!o->op_sibling) {
11558 /* one-arg version of open is highly magical */
11560 if (o->op_type == OP_GV) { /* open FOO; */
11562 if (match && GvSV(gv) != uninit_sv)
11564 return varname(gv, '$', 0,
11565 NULL, 0, FUV_SUBSCRIPT_NONE);
11567 /* other possibilities not handled are:
11568 * open $x; or open my $x; should return '${*$x}'
11569 * open expr; should return '$'.expr ideally
11575 /* ops where $_ may be an implicit arg */
11579 if ( !(obase->op_flags & OPf_STACKED)) {
11580 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11581 ? PAD_SVl(obase->op_targ)
11584 sv = sv_newmortal();
11585 sv_setpvn(sv, "$_", 2);
11593 /* skip filehandle as it can't produce 'undef' warning */
11594 o = cUNOPx(obase)->op_first;
11595 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11596 o = o->op_sibling->op_sibling;
11603 match = 1; /* XS or custom code could trigger random warnings */
11608 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11609 return sv_2mortal(newSVpvs("${$/}"));
11614 if (!(obase->op_flags & OPf_KIDS))
11616 o = cUNOPx(obase)->op_first;
11622 /* if all except one arg are constant, or have no side-effects,
11623 * or are optimized away, then it's unambiguous */
11625 for (kid=o; kid; kid = kid->op_sibling) {
11627 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11628 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11629 || (kid->op_type == OP_PUSHMARK)
11633 if (o2) { /* more than one found */
11640 return find_uninit_var(o2, uninit_sv, match);
11642 /* scan all args */
11644 sv = find_uninit_var(o, uninit_sv, 1);
11656 =for apidoc report_uninit
11658 Print appropriate "Use of uninitialized variable" warning
11664 Perl_report_uninit(pTHX_ SV* uninit_sv)
11668 SV* varname = NULL;
11670 varname = find_uninit_var(PL_op, uninit_sv,0);
11672 sv_insert(varname, 0, 0, " ", 1);
11674 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11675 varname ? SvPV_nolen_const(varname) : "",
11676 " in ", OP_DESC(PL_op));
11679 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11685 * c-indentation-style: bsd
11686 * c-basic-offset: 4
11687 * indent-tabs-mode: t
11690 * ex: set ts=8 sts=4 sw=4 noet: