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 = Nullch;
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 S_free_arena(pTHX_ void **root) {
562 void ** const next = *(void **)root;
569 =for apidoc sv_free_arenas
571 Deallocate the memory used by all arenas. Note that all the individual SV
572 heads and bodies within the arenas must already have been freed.
576 #define free_arena(name) \
578 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
579 PL_ ## name ## _arenaroot = 0; \
580 PL_ ## name ## _root = 0; \
584 Perl_sv_free_arenas(pTHX)
591 /* Free arenas here, but be careful about fake ones. (We assume
592 contiguity of the fake ones with the corresponding real ones.) */
594 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
595 svanext = (SV*) SvANY(sva);
596 while (svanext && SvFAKE(svanext))
597 svanext = (SV*) SvANY(svanext);
603 for (i=0; i<SVt_LAST; i++) {
604 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
605 PL_body_arenaroots[i] = 0;
606 PL_body_roots[i] = 0;
609 Safefree(PL_nice_chunk);
610 PL_nice_chunk = Nullch;
611 PL_nice_chunk_size = 0;
617 Here are mid-level routines that manage the allocation of bodies out
618 of the various arenas. There are 5 kinds of arenas:
620 1. SV-head arenas, which are discussed and handled above
621 2. regular body arenas
622 3. arenas for reduced-size bodies
624 5. pte arenas (thread related)
626 Arena types 2 & 3 are chained by body-type off an array of
627 arena-root pointers, which is indexed by svtype. Some of the
628 larger/less used body types are malloced singly, since a large
629 unused block of them is wasteful. Also, several svtypes dont have
630 bodies; the data fits into the sv-head itself. The arena-root
631 pointer thus has a few unused root-pointers (which may be hijacked
632 later for arena types 4,5)
634 3 differs from 2 as an optimization; some body types have several
635 unused fields in the front of the structure (which are kept in-place
636 for consistency). These bodies can be allocated in smaller chunks,
637 because the leading fields arent accessed. Pointers to such bodies
638 are decremented to point at the unused 'ghost' memory, knowing that
639 the pointers are used with offsets to the real memory.
641 HE, HEK arenas are managed separately, with separate code, but may
642 be merge-able later..
644 PTE arenas are not sv-bodies, but they share these mid-level
645 mechanics, so are considered here. The new mid-level mechanics rely
646 on the sv_type of the body being allocated, so we just reserve one
647 of the unused body-slots for PTEs, then use it in those (2) PTE
648 contexts below (line ~10k)
652 S_more_bodies (pTHX_ size_t size, svtype sv_type)
655 void ** const arena_root = &PL_body_arenaroots[sv_type];
656 void ** const root = &PL_body_roots[sv_type];
659 const size_t count = PERL_ARENA_SIZE / size;
661 Newx(start, count*size, char);
662 *((void **) start) = *arena_root;
663 *arena_root = (void *)start;
665 end = start + (count-1) * size;
667 /* The initial slot is used to link the arenas together, so it isn't to be
668 linked into the list of ready-to-use bodies. */
672 *root = (void *)start;
674 while (start < end) {
675 char * const next = start + size;
676 *(void**) start = (void *)next;
684 /* grab a new thing from the free list, allocating more if necessary */
686 /* 1st, the inline version */
688 #define new_body_inline(xpv, size, sv_type) \
690 void ** const r3wt = &PL_body_roots[sv_type]; \
692 xpv = *((void **)(r3wt)) \
693 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
694 *(r3wt) = *(void**)(xpv); \
698 /* now use the inline version in the proper function */
702 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
703 compilers issue warnings. */
706 S_new_body(pTHX_ size_t size, svtype sv_type)
710 new_body_inline(xpv, size, sv_type);
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 Revisiting type 3 arenas, there are 4 body-types which have some
729 members that are never accessed. They are XPV, XPVIV, XPVAV,
730 XPVHV, which have corresponding types: xpv_allocated,
731 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by
736 the size of the bit not allocated, so it's as if we allocated the
737 full structure. (But things will all go boom if you write to the
738 part that is "not there", because you'll be overwriting the last
739 members of the preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For example, if
742 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
743 and the pointer is unchanged. If the allocated structure is smaller (no
744 initial NV actually allocated) then the net effect is to subtract the size
745 of the NV from the pointer, to return a new pointer as if an initial NV were
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at the
750 start of the structure. IV bodies don't need it either, because they are
751 no longer allocated. */
753 /* The following 2 arrays hide the above details in a pair of
754 lookup-tables, allowing us to be body-type agnostic.
756 size maps svtype to its body's allocated size.
757 offset maps svtype to the body-pointer adjustment needed
759 NB: elements in latter are 0 or <0, and are added during
760 allocation, and subtracted during deallocation. It may be clearer
761 to invert the values, and call it shrinkage_by_svtype.
764 struct body_details {
765 size_t size; /* Size to allocate */
766 size_t copy; /* Size of structure to copy (may be shorter) */
768 bool cant_upgrade; /* Can upgrade this type */
769 bool zero_nv; /* zero the NV when upgrading from this */
770 bool arena; /* Allocated from an arena */
777 /* With -DPURFIY we allocate everything directly, and don't use arenas.
778 This seems a rather elegant way to simplify some of the code below. */
779 #define HASARENA FALSE
781 #define HASARENA TRUE
783 #define NOARENA FALSE
785 /* A macro to work out the offset needed to subtract from a pointer to (say)
792 to make its members accessible via a pointer to (say)
802 #define relative_STRUCT_OFFSET(longer, shorter, member) \
803 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
805 /* Calculate the length to copy. Specifically work out the length less any
806 final padding the compiler needed to add. See the comment in sv_upgrade
807 for why copying the padding proved to be a bug. */
809 #define copy_length(type, last_member) \
810 STRUCT_OFFSET(type, last_member) \
811 + sizeof (((type*)SvANY((SV*)0))->last_member)
813 static const struct body_details bodies_by_type[] = {
814 {0, 0, 0, FALSE, NONV, NOARENA},
815 /* IVs are in the head, so the allocation size is 0 */
816 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
817 /* 8 bytes on most ILP32 with IEEE doubles */
818 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
819 /* RVs are in the head now */
820 /* However, this slot is overloaded and used by the pte */
821 {0, 0, 0, FALSE, NONV, NOARENA},
822 /* 8 bytes on most ILP32 with IEEE doubles */
823 {sizeof(xpv_allocated),
824 copy_length(XPV, xpv_len)
825 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
826 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
827 FALSE, NONV, HASARENA},
829 {sizeof(xpviv_allocated),
830 copy_length(XPVIV, xiv_u)
831 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
832 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
833 FALSE, NONV, HASARENA},
835 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
837 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
839 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
841 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
843 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
845 {sizeof(xpvav_allocated),
846 copy_length(XPVAV, xmg_stash)
847 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
848 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
849 TRUE, HADNV, HASARENA},
851 {sizeof(xpvhv_allocated),
852 copy_length(XPVHV, xmg_stash)
853 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
854 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
855 TRUE, HADNV, HASARENA},
857 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
859 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
861 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
864 #define new_body_type(sv_type) \
865 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
866 - bodies_by_type[sv_type].offset)
868 #define del_body_type(p, sv_type) \
869 del_body(p, &PL_body_roots[sv_type])
872 #define new_body_allocated(sv_type) \
873 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
874 - bodies_by_type[sv_type].offset)
876 #define del_body_allocated(p, sv_type) \
877 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
880 #define my_safemalloc(s) (void*)safemalloc(s)
881 #define my_safecalloc(s) (void*)safecalloc(s, 1)
882 #define my_safefree(p) safefree((char*)p)
886 #define new_XNV() my_safemalloc(sizeof(XPVNV))
887 #define del_XNV(p) my_safefree(p)
889 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
890 #define del_XPVNV(p) my_safefree(p)
892 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
893 #define del_XPVAV(p) my_safefree(p)
895 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
896 #define del_XPVHV(p) my_safefree(p)
898 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
899 #define del_XPVMG(p) my_safefree(p)
901 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
902 #define del_XPVGV(p) my_safefree(p)
906 #define new_XNV() new_body_type(SVt_NV)
907 #define del_XNV(p) del_body_type(p, SVt_NV)
909 #define new_XPVNV() new_body_type(SVt_PVNV)
910 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
912 #define new_XPVAV() new_body_allocated(SVt_PVAV)
913 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
915 #define new_XPVHV() new_body_allocated(SVt_PVHV)
916 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
918 #define new_XPVMG() new_body_type(SVt_PVMG)
919 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
921 #define new_XPVGV() new_body_type(SVt_PVGV)
922 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
926 /* no arena for you! */
928 #define new_NOARENA(details) \
929 my_safemalloc((details)->size + (details)->offset)
930 #define new_NOARENAZ(details) \
931 my_safecalloc((details)->size + (details)->offset)
934 =for apidoc sv_upgrade
936 Upgrade an SV to a more complex form. Generally adds a new body type to the
937 SV, then copies across as much information as possible from the old body.
938 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
944 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
949 const U32 old_type = SvTYPE(sv);
950 const struct body_details *const old_type_details
951 = bodies_by_type + old_type;
952 const struct body_details *new_type_details = bodies_by_type + new_type;
954 if (new_type != SVt_PV && SvIsCOW(sv)) {
955 sv_force_normal_flags(sv, 0);
958 if (old_type == new_type)
961 if (old_type > new_type)
962 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
963 (int)old_type, (int)new_type);
966 old_body = SvANY(sv);
968 /* Copying structures onto other structures that have been neatly zeroed
969 has a subtle gotcha. Consider XPVMG
971 +------+------+------+------+------+-------+-------+
972 | NV | CUR | LEN | IV | MAGIC | STASH |
973 +------+------+------+------+------+-------+-------+
976 where NVs are aligned to 8 bytes, so that sizeof that structure is
977 actually 32 bytes long, with 4 bytes of padding at the end:
979 +------+------+------+------+------+-------+-------+------+
980 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
981 +------+------+------+------+------+-------+-------+------+
982 0 4 8 12 16 20 24 28 32
984 so what happens if you allocate memory for this structure:
986 +------+------+------+------+------+-------+-------+------+------+...
987 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
988 +------+------+------+------+------+-------+-------+------+------+...
989 0 4 8 12 16 20 24 28 32 36
991 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
992 expect, because you copy the area marked ??? onto GP. Now, ??? may have
993 started out as zero once, but it's quite possible that it isn't. So now,
994 rather than a nicely zeroed GP, you have it pointing somewhere random.
997 (In fact, GP ends up pointing at a previous GP structure, because the
998 principle cause of the padding in XPVMG getting garbage is a copy of
999 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1001 So we are careful and work out the size of used parts of all the
1008 if (new_type < SVt_PVIV) {
1009 new_type = (new_type == SVt_NV)
1010 ? SVt_PVNV : SVt_PVIV;
1011 new_type_details = bodies_by_type + new_type;
1015 if (new_type < SVt_PVNV) {
1016 new_type = SVt_PVNV;
1017 new_type_details = bodies_by_type + new_type;
1023 assert(new_type > SVt_PV);
1024 assert(SVt_IV < SVt_PV);
1025 assert(SVt_NV < SVt_PV);
1032 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1033 there's no way that it can be safely upgraded, because perl.c
1034 expects to Safefree(SvANY(PL_mess_sv)) */
1035 assert(sv != PL_mess_sv);
1036 /* This flag bit is used to mean other things in other scalar types.
1037 Given that it only has meaning inside the pad, it shouldn't be set
1038 on anything that can get upgraded. */
1039 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1042 if (old_type_details->cant_upgrade)
1043 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1046 SvFLAGS(sv) &= ~SVTYPEMASK;
1047 SvFLAGS(sv) |= new_type;
1051 Perl_croak(aTHX_ "Can't upgrade to undef");
1053 assert(old_type == SVt_NULL);
1054 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1058 assert(old_type == SVt_NULL);
1059 SvANY(sv) = new_XNV();
1063 assert(old_type == SVt_NULL);
1064 SvANY(sv) = &sv->sv_u.svu_rv;
1068 SvANY(sv) = new_XPVHV();
1071 HvTOTALKEYS(sv) = 0;
1076 SvANY(sv) = new_XPVAV();
1083 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1084 The target created by newSVrv also is, and it can have magic.
1085 However, it never has SvPVX set.
1087 if (old_type >= SVt_RV) {
1088 assert(SvPVX_const(sv) == 0);
1091 /* Could put this in the else clause below, as PVMG must have SvPVX
1092 0 already (the assertion above) */
1095 if (old_type >= SVt_PVMG) {
1096 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1097 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1099 SvMAGIC_set(sv, NULL);
1100 SvSTASH_set(sv, NULL);
1106 /* XXX Is this still needed? Was it ever needed? Surely as there is
1107 no route from NV to PVIV, NOK can never be true */
1108 assert(!SvNOKp(sv));
1120 assert(new_type_details->size);
1121 /* We always allocated the full length item with PURIFY. To do this
1122 we fake things so that arena is false for all 16 types.. */
1123 if(new_type_details->arena) {
1124 /* This points to the start of the allocated area. */
1125 new_body_inline(new_body, new_type_details->size, new_type);
1126 Zero(new_body, new_type_details->size, char);
1127 new_body = ((char *)new_body) - new_type_details->offset;
1129 new_body = new_NOARENAZ(new_type_details);
1131 SvANY(sv) = new_body;
1133 if (old_type_details->copy) {
1134 Copy((char *)old_body + old_type_details->offset,
1135 (char *)new_body + old_type_details->offset,
1136 old_type_details->copy, char);
1139 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1140 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1141 * correct 0.0 for us. Otherwise, if the old body didn't have an
1142 * NV slot, but the new one does, then we need to initialise the
1143 * freshly created NV slot with whatever the correct bit pattern is
1145 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1149 if (new_type == SVt_PVIO)
1150 IoPAGE_LEN(sv) = 60;
1151 if (old_type < SVt_RV)
1155 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1156 (unsigned long)new_type);
1159 if (old_type_details->size) {
1160 /* If the old body had an allocated size, then we need to free it. */
1162 my_safefree(old_body);
1164 del_body((void*)((char*)old_body + old_type_details->offset),
1165 &PL_body_roots[old_type]);
1171 =for apidoc sv_backoff
1173 Remove any string offset. You should normally use the C<SvOOK_off> macro
1180 Perl_sv_backoff(pTHX_ register SV *sv)
1183 assert(SvTYPE(sv) != SVt_PVHV);
1184 assert(SvTYPE(sv) != SVt_PVAV);
1186 const char * const s = SvPVX_const(sv);
1187 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1188 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1190 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1192 SvFLAGS(sv) &= ~SVf_OOK;
1199 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1200 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1201 Use the C<SvGROW> wrapper instead.
1207 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000) {
1213 PerlIO_printf(Perl_debug_log,
1214 "Allocation too large: %"UVxf"\n", (UV)newlen);
1217 #endif /* HAS_64K_LIMIT */
1220 if (SvTYPE(sv) < SVt_PV) {
1221 sv_upgrade(sv, SVt_PV);
1222 s = SvPVX_mutable(sv);
1224 else if (SvOOK(sv)) { /* pv is offset? */
1226 s = SvPVX_mutable(sv);
1227 if (newlen > SvLEN(sv))
1228 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1229 #ifdef HAS_64K_LIMIT
1230 if (newlen >= 0x10000)
1235 s = SvPVX_mutable(sv);
1237 if (newlen > SvLEN(sv)) { /* need more room? */
1238 newlen = PERL_STRLEN_ROUNDUP(newlen);
1239 if (SvLEN(sv) && s) {
1241 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1247 s = saferealloc(s, newlen);
1250 s = safemalloc(newlen);
1251 if (SvPVX_const(sv) && SvCUR(sv)) {
1252 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1256 SvLEN_set(sv, newlen);
1262 =for apidoc sv_setiv
1264 Copies an integer into the given SV, upgrading first if necessary.
1265 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1271 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1274 SV_CHECK_THINKFIRST_COW_DROP(sv);
1275 switch (SvTYPE(sv)) {
1277 sv_upgrade(sv, SVt_IV);
1280 sv_upgrade(sv, SVt_PVNV);
1284 sv_upgrade(sv, SVt_PVIV);
1293 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1296 (void)SvIOK_only(sv); /* validate number */
1302 =for apidoc sv_setiv_mg
1304 Like C<sv_setiv>, but also handles 'set' magic.
1310 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1317 =for apidoc sv_setuv
1319 Copies an unsigned integer into the given SV, upgrading first if necessary.
1320 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1326 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1328 /* With these two if statements:
1329 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1332 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1334 If you wish to remove them, please benchmark to see what the effect is
1336 if (u <= (UV)IV_MAX) {
1337 sv_setiv(sv, (IV)u);
1346 =for apidoc sv_setuv_mg
1348 Like C<sv_setuv>, but also handles 'set' magic.
1354 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1363 =for apidoc sv_setnv
1365 Copies a double into the given SV, upgrading first if necessary.
1366 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1372 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1375 SV_CHECK_THINKFIRST_COW_DROP(sv);
1376 switch (SvTYPE(sv)) {
1379 sv_upgrade(sv, SVt_NV);
1384 sv_upgrade(sv, SVt_PVNV);
1393 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1397 (void)SvNOK_only(sv); /* validate number */
1402 =for apidoc sv_setnv_mg
1404 Like C<sv_setnv>, but also handles 'set' magic.
1410 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1416 /* Print an "isn't numeric" warning, using a cleaned-up,
1417 * printable version of the offending string
1421 S_not_a_number(pTHX_ SV *sv)
1429 dsv = sv_2mortal(newSVpvs(""));
1430 pv = sv_uni_display(dsv, sv, 10, 0);
1433 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1434 /* each *s can expand to 4 chars + "...\0",
1435 i.e. need room for 8 chars */
1437 const char *s = SvPVX_const(sv);
1438 const char * const end = s + SvCUR(sv);
1439 for ( ; s < end && d < limit; s++ ) {
1441 if (ch & 128 && !isPRINT_LC(ch)) {
1450 else if (ch == '\r') {
1454 else if (ch == '\f') {
1458 else if (ch == '\\') {
1462 else if (ch == '\0') {
1466 else if (isPRINT_LC(ch))
1483 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1484 "Argument \"%s\" isn't numeric in %s", pv,
1487 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1488 "Argument \"%s\" isn't numeric", pv);
1492 =for apidoc looks_like_number
1494 Test if the content of an SV looks like a number (or is a number).
1495 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1496 non-numeric warning), even if your atof() doesn't grok them.
1502 Perl_looks_like_number(pTHX_ SV *sv)
1504 register const char *sbegin;
1508 sbegin = SvPVX_const(sv);
1511 else if (SvPOKp(sv))
1512 sbegin = SvPV_const(sv, len);
1514 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1515 return grok_number(sbegin, len, NULL);
1518 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1519 until proven guilty, assume that things are not that bad... */
1524 As 64 bit platforms often have an NV that doesn't preserve all bits of
1525 an IV (an assumption perl has been based on to date) it becomes necessary
1526 to remove the assumption that the NV always carries enough precision to
1527 recreate the IV whenever needed, and that the NV is the canonical form.
1528 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1529 precision as a side effect of conversion (which would lead to insanity
1530 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1531 1) to distinguish between IV/UV/NV slots that have cached a valid
1532 conversion where precision was lost and IV/UV/NV slots that have a
1533 valid conversion which has lost no precision
1534 2) to ensure that if a numeric conversion to one form is requested that
1535 would lose precision, the precise conversion (or differently
1536 imprecise conversion) is also performed and cached, to prevent
1537 requests for different numeric formats on the same SV causing
1538 lossy conversion chains. (lossless conversion chains are perfectly
1543 SvIOKp is true if the IV slot contains a valid value
1544 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1545 SvNOKp is true if the NV slot contains a valid value
1546 SvNOK is true only if the NV value is accurate
1549 while converting from PV to NV, check to see if converting that NV to an
1550 IV(or UV) would lose accuracy over a direct conversion from PV to
1551 IV(or UV). If it would, cache both conversions, return NV, but mark
1552 SV as IOK NOKp (ie not NOK).
1554 While converting from PV to IV, check to see if converting that IV to an
1555 NV would lose accuracy over a direct conversion from PV to NV. If it
1556 would, cache both conversions, flag similarly.
1558 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1559 correctly because if IV & NV were set NV *always* overruled.
1560 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1561 changes - now IV and NV together means that the two are interchangeable:
1562 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1564 The benefit of this is that operations such as pp_add know that if
1565 SvIOK is true for both left and right operands, then integer addition
1566 can be used instead of floating point (for cases where the result won't
1567 overflow). Before, floating point was always used, which could lead to
1568 loss of precision compared with integer addition.
1570 * making IV and NV equal status should make maths accurate on 64 bit
1572 * may speed up maths somewhat if pp_add and friends start to use
1573 integers when possible instead of fp. (Hopefully the overhead in
1574 looking for SvIOK and checking for overflow will not outweigh the
1575 fp to integer speedup)
1576 * will slow down integer operations (callers of SvIV) on "inaccurate"
1577 values, as the change from SvIOK to SvIOKp will cause a call into
1578 sv_2iv each time rather than a macro access direct to the IV slot
1579 * should speed up number->string conversion on integers as IV is
1580 favoured when IV and NV are equally accurate
1582 ####################################################################
1583 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1584 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1585 On the other hand, SvUOK is true iff UV.
1586 ####################################################################
1588 Your mileage will vary depending your CPU's relative fp to integer
1592 #ifndef NV_PRESERVES_UV
1593 # define IS_NUMBER_UNDERFLOW_IV 1
1594 # define IS_NUMBER_UNDERFLOW_UV 2
1595 # define IS_NUMBER_IV_AND_UV 2
1596 # define IS_NUMBER_OVERFLOW_IV 4
1597 # define IS_NUMBER_OVERFLOW_UV 5
1599 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1601 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1603 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1606 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));
1607 if (SvNVX(sv) < (NV)IV_MIN) {
1608 (void)SvIOKp_on(sv);
1610 SvIV_set(sv, IV_MIN);
1611 return IS_NUMBER_UNDERFLOW_IV;
1613 if (SvNVX(sv) > (NV)UV_MAX) {
1614 (void)SvIOKp_on(sv);
1617 SvUV_set(sv, UV_MAX);
1618 return IS_NUMBER_OVERFLOW_UV;
1620 (void)SvIOKp_on(sv);
1622 /* Can't use strtol etc to convert this string. (See truth table in
1624 if (SvNVX(sv) <= (UV)IV_MAX) {
1625 SvIV_set(sv, I_V(SvNVX(sv)));
1626 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1627 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1629 /* Integer is imprecise. NOK, IOKp */
1631 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1634 SvUV_set(sv, U_V(SvNVX(sv)));
1635 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1636 if (SvUVX(sv) == UV_MAX) {
1637 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1638 possibly be preserved by NV. Hence, it must be overflow.
1640 return IS_NUMBER_OVERFLOW_UV;
1642 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1644 /* Integer is imprecise. NOK, IOKp */
1646 return IS_NUMBER_OVERFLOW_IV;
1648 #endif /* !NV_PRESERVES_UV*/
1651 S_sv_2iuv_common(pTHX_ SV *sv) {
1654 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1655 * without also getting a cached IV/UV from it at the same time
1656 * (ie PV->NV conversion should detect loss of accuracy and cache
1657 * IV or UV at same time to avoid this. */
1658 /* IV-over-UV optimisation - choose to cache IV if possible */
1660 if (SvTYPE(sv) == SVt_NV)
1661 sv_upgrade(sv, SVt_PVNV);
1663 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1664 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1665 certainly cast into the IV range at IV_MAX, whereas the correct
1666 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1668 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1669 SvIV_set(sv, I_V(SvNVX(sv)));
1670 if (SvNVX(sv) == (NV) SvIVX(sv)
1671 #ifndef NV_PRESERVES_UV
1672 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1673 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1674 /* Don't flag it as "accurately an integer" if the number
1675 came from a (by definition imprecise) NV operation, and
1676 we're outside the range of NV integer precision */
1679 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1680 DEBUG_c(PerlIO_printf(Perl_debug_log,
1681 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1687 /* IV not precise. No need to convert from PV, as NV
1688 conversion would already have cached IV if it detected
1689 that PV->IV would be better than PV->NV->IV
1690 flags already correct - don't set public IOK. */
1691 DEBUG_c(PerlIO_printf(Perl_debug_log,
1692 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1697 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1698 but the cast (NV)IV_MIN rounds to a the value less (more
1699 negative) than IV_MIN which happens to be equal to SvNVX ??
1700 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1701 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1702 (NV)UVX == NVX are both true, but the values differ. :-(
1703 Hopefully for 2s complement IV_MIN is something like
1704 0x8000000000000000 which will be exact. NWC */
1707 SvUV_set(sv, U_V(SvNVX(sv)));
1709 (SvNVX(sv) == (NV) SvUVX(sv))
1710 #ifndef NV_PRESERVES_UV
1711 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1712 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1713 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1714 /* Don't flag it as "accurately an integer" if the number
1715 came from a (by definition imprecise) NV operation, and
1716 we're outside the range of NV integer precision */
1721 DEBUG_c(PerlIO_printf(Perl_debug_log,
1722 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1728 else if (SvPOKp(sv) && SvLEN(sv)) {
1730 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1731 /* We want to avoid a possible problem when we cache an IV/ a UV which
1732 may be later translated to an NV, and the resulting NV is not
1733 the same as the direct translation of the initial string
1734 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1735 be careful to ensure that the value with the .456 is around if the
1736 NV value is requested in the future).
1738 This means that if we cache such an IV/a UV, we need to cache the
1739 NV as well. Moreover, we trade speed for space, and do not
1740 cache the NV if we are sure it's not needed.
1743 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1744 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1745 == IS_NUMBER_IN_UV) {
1746 /* It's definitely an integer, only upgrade to PVIV */
1747 if (SvTYPE(sv) < SVt_PVIV)
1748 sv_upgrade(sv, SVt_PVIV);
1750 } else if (SvTYPE(sv) < SVt_PVNV)
1751 sv_upgrade(sv, SVt_PVNV);
1753 /* If NVs preserve UVs then we only use the UV value if we know that
1754 we aren't going to call atof() below. If NVs don't preserve UVs
1755 then the value returned may have more precision than atof() will
1756 return, even though value isn't perfectly accurate. */
1757 if ((numtype & (IS_NUMBER_IN_UV
1758 #ifdef NV_PRESERVES_UV
1761 )) == IS_NUMBER_IN_UV) {
1762 /* This won't turn off the public IOK flag if it was set above */
1763 (void)SvIOKp_on(sv);
1765 if (!(numtype & IS_NUMBER_NEG)) {
1767 if (value <= (UV)IV_MAX) {
1768 SvIV_set(sv, (IV)value);
1770 /* it didn't overflow, and it was positive. */
1771 SvUV_set(sv, value);
1775 /* 2s complement assumption */
1776 if (value <= (UV)IV_MIN) {
1777 SvIV_set(sv, -(IV)value);
1779 /* Too negative for an IV. This is a double upgrade, but
1780 I'm assuming it will be rare. */
1781 if (SvTYPE(sv) < SVt_PVNV)
1782 sv_upgrade(sv, SVt_PVNV);
1786 SvNV_set(sv, -(NV)value);
1787 SvIV_set(sv, IV_MIN);
1791 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1792 will be in the previous block to set the IV slot, and the next
1793 block to set the NV slot. So no else here. */
1795 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1796 != IS_NUMBER_IN_UV) {
1797 /* It wasn't an (integer that doesn't overflow the UV). */
1798 SvNV_set(sv, Atof(SvPVX_const(sv)));
1800 if (! numtype && ckWARN(WARN_NUMERIC))
1803 #if defined(USE_LONG_DOUBLE)
1804 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1805 PTR2UV(sv), SvNVX(sv)));
1807 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1808 PTR2UV(sv), SvNVX(sv)));
1811 #ifdef NV_PRESERVES_UV
1812 (void)SvIOKp_on(sv);
1814 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1815 SvIV_set(sv, I_V(SvNVX(sv)));
1816 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1819 /* Integer is imprecise. NOK, IOKp */
1821 /* UV will not work better than IV */
1823 if (SvNVX(sv) > (NV)UV_MAX) {
1825 /* Integer is inaccurate. NOK, IOKp, is UV */
1826 SvUV_set(sv, UV_MAX);
1828 SvUV_set(sv, U_V(SvNVX(sv)));
1829 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1830 NV preservse UV so can do correct comparison. */
1831 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1834 /* Integer is imprecise. NOK, IOKp, is UV */
1839 #else /* NV_PRESERVES_UV */
1840 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1841 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1842 /* The IV/UV slot will have been set from value returned by
1843 grok_number above. The NV slot has just been set using
1846 assert (SvIOKp(sv));
1848 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1849 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1850 /* Small enough to preserve all bits. */
1851 (void)SvIOKp_on(sv);
1853 SvIV_set(sv, I_V(SvNVX(sv)));
1854 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1856 /* Assumption: first non-preserved integer is < IV_MAX,
1857 this NV is in the preserved range, therefore: */
1858 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1860 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);
1864 0 0 already failed to read UV.
1865 0 1 already failed to read UV.
1866 1 0 you won't get here in this case. IV/UV
1867 slot set, public IOK, Atof() unneeded.
1868 1 1 already read UV.
1869 so there's no point in sv_2iuv_non_preserve() attempting
1870 to use atol, strtol, strtoul etc. */
1871 sv_2iuv_non_preserve (sv, numtype);
1874 #endif /* NV_PRESERVES_UV */
1878 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1879 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1882 if (SvTYPE(sv) < SVt_IV)
1883 /* Typically the caller expects that sv_any is not NULL now. */
1884 sv_upgrade(sv, SVt_IV);
1885 /* Return 0 from the caller. */
1892 =for apidoc sv_2iv_flags
1894 Return the integer value of an SV, doing any necessary string
1895 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1896 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1902 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1907 if (SvGMAGICAL(sv)) {
1908 if (flags & SV_GMAGIC)
1913 return I_V(SvNVX(sv));
1915 if (SvPOKp(sv) && SvLEN(sv)) {
1918 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1921 == IS_NUMBER_IN_UV) {
1922 /* It's definitely an integer */
1923 if (numtype & IS_NUMBER_NEG) {
1924 if (value < (UV)IV_MIN)
1927 if (value < (UV)IV_MAX)
1932 if (ckWARN(WARN_NUMERIC))
1935 return I_V(Atof(SvPVX_const(sv)));
1940 assert(SvTYPE(sv) >= SVt_PVMG);
1941 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1942 } else if (SvTHINKFIRST(sv)) {
1946 SV * const tmpstr=AMG_CALLun(sv,numer);
1947 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1948 return SvIV(tmpstr);
1951 return PTR2IV(SvRV(sv));
1954 sv_force_normal_flags(sv, 0);
1956 if (SvREADONLY(sv) && !SvOK(sv)) {
1957 if (ckWARN(WARN_UNINITIALIZED))
1963 if (S_sv_2iuv_common(aTHX_ sv))
1966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1967 PTR2UV(sv),SvIVX(sv)));
1968 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1972 =for apidoc sv_2uv_flags
1974 Return the unsigned integer value of an SV, doing any necessary string
1975 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1976 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1982 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1987 if (SvGMAGICAL(sv)) {
1988 if (flags & SV_GMAGIC)
1993 return U_V(SvNVX(sv));
1994 if (SvPOKp(sv) && SvLEN(sv)) {
1997 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer */
2002 if (!(numtype & IS_NUMBER_NEG))
2006 if (ckWARN(WARN_NUMERIC))
2009 return U_V(Atof(SvPVX_const(sv)));
2014 assert(SvTYPE(sv) >= SVt_PVMG);
2015 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2016 } else if (SvTHINKFIRST(sv)) {
2020 SV *const tmpstr = AMG_CALLun(sv,numer);
2021 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2022 return SvUV(tmpstr);
2025 return PTR2UV(SvRV(sv));
2028 sv_force_normal_flags(sv, 0);
2030 if (SvREADONLY(sv) && !SvOK(sv)) {
2031 if (ckWARN(WARN_UNINITIALIZED))
2037 if (S_sv_2iuv_common(aTHX_ sv))
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2042 PTR2UV(sv),SvUVX(sv)));
2043 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2049 Return the num value of an SV, doing any necessary string or integer
2050 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2057 Perl_sv_2nv(pTHX_ register SV *sv)
2062 if (SvGMAGICAL(sv)) {
2066 if (SvPOKp(sv) && SvLEN(sv)) {
2067 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2068 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2070 return Atof(SvPVX_const(sv));
2074 return (NV)SvUVX(sv);
2076 return (NV)SvIVX(sv);
2081 assert(SvTYPE(sv) >= SVt_PVMG);
2082 /* This falls through to the report_uninit near the end of the
2084 } else if (SvTHINKFIRST(sv)) {
2088 SV *const tmpstr = AMG_CALLun(sv,numer);
2089 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2090 return SvNV(tmpstr);
2093 return PTR2NV(SvRV(sv));
2096 sv_force_normal_flags(sv, 0);
2098 if (SvREADONLY(sv) && !SvOK(sv)) {
2099 if (ckWARN(WARN_UNINITIALIZED))
2104 if (SvTYPE(sv) < SVt_NV) {
2105 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2106 sv_upgrade(sv, SVt_NV);
2107 #ifdef USE_LONG_DOUBLE
2109 STORE_NUMERIC_LOCAL_SET_STANDARD();
2110 PerlIO_printf(Perl_debug_log,
2111 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2112 PTR2UV(sv), SvNVX(sv));
2113 RESTORE_NUMERIC_LOCAL();
2117 STORE_NUMERIC_LOCAL_SET_STANDARD();
2118 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2119 PTR2UV(sv), SvNVX(sv));
2120 RESTORE_NUMERIC_LOCAL();
2124 else if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2130 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2131 #ifdef NV_PRESERVES_UV
2134 /* Only set the public NV OK flag if this NV preserves the IV */
2135 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2136 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2137 : (SvIVX(sv) == I_V(SvNVX(sv))))
2143 else if (SvPOKp(sv) && SvLEN(sv)) {
2145 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2146 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2148 #ifdef NV_PRESERVES_UV
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 == IS_NUMBER_IN_UV) {
2151 /* It's definitely an integer */
2152 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2154 SvNV_set(sv, Atof(SvPVX_const(sv)));
2157 SvNV_set(sv, Atof(SvPVX_const(sv)));
2158 /* Only set the public NV OK flag if this NV preserves the value in
2159 the PV at least as well as an IV/UV would.
2160 Not sure how to do this 100% reliably. */
2161 /* if that shift count is out of range then Configure's test is
2162 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2164 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2165 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2166 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2167 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2168 /* Can't use strtol etc to convert this string, so don't try.
2169 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2172 /* value has been set. It may not be precise. */
2173 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2174 /* 2s complement assumption for (UV)IV_MIN */
2175 SvNOK_on(sv); /* Integer is too negative. */
2180 if (numtype & IS_NUMBER_NEG) {
2181 SvIV_set(sv, -(IV)value);
2182 } else if (value <= (UV)IV_MAX) {
2183 SvIV_set(sv, (IV)value);
2185 SvUV_set(sv, value);
2189 if (numtype & IS_NUMBER_NOT_INT) {
2190 /* I believe that even if the original PV had decimals,
2191 they are lost beyond the limit of the FP precision.
2192 However, neither is canonical, so both only get p
2193 flags. NWC, 2000/11/25 */
2194 /* Both already have p flags, so do nothing */
2196 const NV nv = SvNVX(sv);
2197 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2198 if (SvIVX(sv) == I_V(nv)) {
2201 /* It had no "." so it must be integer. */
2205 /* between IV_MAX and NV(UV_MAX).
2206 Could be slightly > UV_MAX */
2208 if (numtype & IS_NUMBER_NOT_INT) {
2209 /* UV and NV both imprecise. */
2211 const UV nv_as_uv = U_V(nv);
2213 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2222 #endif /* NV_PRESERVES_UV */
2225 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2227 assert (SvTYPE(sv) >= SVt_NV);
2228 /* Typically the caller expects that sv_any is not NULL now. */
2229 /* XXX Ilya implies that this is a bug in callers that assume this
2230 and ideally should be fixed. */
2233 #if defined(USE_LONG_DOUBLE)
2235 STORE_NUMERIC_LOCAL_SET_STANDARD();
2236 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2237 PTR2UV(sv), SvNVX(sv));
2238 RESTORE_NUMERIC_LOCAL();
2242 STORE_NUMERIC_LOCAL_SET_STANDARD();
2243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2244 PTR2UV(sv), SvNVX(sv));
2245 RESTORE_NUMERIC_LOCAL();
2251 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2252 * UV as a string towards the end of buf, and return pointers to start and
2255 * We assume that buf is at least TYPE_CHARS(UV) long.
2259 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2261 char *ptr = buf + TYPE_CHARS(UV);
2262 char * const ebuf = ptr;
2275 *--ptr = '0' + (char)(uv % 10);
2283 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2284 * a regexp to its stringified form.
2288 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2290 const regexp * const re = (regexp *)mg->mg_obj;
2293 const char *fptr = "msix";
2298 bool need_newline = 0;
2299 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2301 while((ch = *fptr++)) {
2303 reflags[left++] = ch;
2306 reflags[right--] = ch;
2311 reflags[left] = '-';
2315 mg->mg_len = re->prelen + 4 + left;
2317 * If /x was used, we have to worry about a regex ending with a
2318 * comment later being embedded within another regex. If so, we don't
2319 * want this regex's "commentization" to leak out to the right part of
2320 * the enclosing regex, we must cap it with a newline.
2322 * So, if /x was used, we scan backwards from the end of the regex. If
2323 * we find a '#' before we find a newline, we need to add a newline
2324 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2325 * we don't need to add anything. -jfriedl
2327 if (PMf_EXTENDED & re->reganch) {
2328 const char *endptr = re->precomp + re->prelen;
2329 while (endptr >= re->precomp) {
2330 const char c = *(endptr--);
2332 break; /* don't need another */
2334 /* we end while in a comment, so we need a newline */
2335 mg->mg_len++; /* save space for it */
2336 need_newline = 1; /* note to add it */
2342 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2343 mg->mg_ptr[0] = '(';
2344 mg->mg_ptr[1] = '?';
2345 Copy(reflags, mg->mg_ptr+2, left, char);
2346 *(mg->mg_ptr+left+2) = ':';
2347 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2349 mg->mg_ptr[mg->mg_len - 2] = '\n';
2350 mg->mg_ptr[mg->mg_len - 1] = ')';
2351 mg->mg_ptr[mg->mg_len] = 0;
2353 PL_reginterp_cnt += re->program[0].next_off;
2355 if (re->reganch & ROPT_UTF8)
2365 =for apidoc sv_2pv_flags
2367 Returns a pointer to the string value of an SV, and sets *lp to its length.
2368 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2370 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2371 usually end up here too.
2377 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2387 if (SvGMAGICAL(sv)) {
2388 if (flags & SV_GMAGIC)
2393 if (flags & SV_MUTABLE_RETURN)
2394 return SvPVX_mutable(sv);
2395 if (flags & SV_CONST_RETURN)
2396 return (char *)SvPVX_const(sv);
2399 if (SvIOKp(sv) || SvNOKp(sv)) {
2400 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2404 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2405 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2407 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2410 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2411 /* Sneaky stuff here */
2412 SV * const tsv = newSVpvn(tbuf, len);
2422 #ifdef FIXNEGATIVEZERO
2423 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2429 SvUPGRADE(sv, SVt_PV);
2432 s = SvGROW_mutable(sv, len + 1);
2435 return memcpy(s, tbuf, len + 1);
2441 assert(SvTYPE(sv) >= SVt_PVMG);
2442 /* This falls through to the report_uninit near the end of the
2444 } else if (SvTHINKFIRST(sv)) {
2448 SV *const tmpstr = AMG_CALLun(sv,string);
2449 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2455 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2456 if (flags & SV_CONST_RETURN) {
2457 pv = (char *) SvPVX_const(tmpstr);
2459 pv = (flags & SV_MUTABLE_RETURN)
2460 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2463 *lp = SvCUR(tmpstr);
2465 pv = sv_2pv_flags(tmpstr, lp, flags);
2477 const SV *const referent = (SV*)SvRV(sv);
2480 tsv = sv_2mortal(newSVpvs("NULLREF"));
2481 } else if (SvTYPE(referent) == SVt_PVMG
2482 && ((SvFLAGS(referent) &
2483 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2484 == (SVs_OBJECT|SVs_SMG))
2485 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2486 return stringify_regexp(sv, mg, lp);
2488 const char *const typestr = sv_reftype(referent, 0);
2490 tsv = sv_newmortal();
2491 if (SvOBJECT(referent)) {
2492 const char *const name = HvNAME_get(SvSTASH(referent));
2493 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2494 name ? name : "__ANON__" , typestr,
2498 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2506 if (SvREADONLY(sv) && !SvOK(sv)) {
2507 if (ckWARN(WARN_UNINITIALIZED))
2514 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2515 /* I'm assuming that if both IV and NV are equally valid then
2516 converting the IV is going to be more efficient */
2517 const U32 isIOK = SvIOK(sv);
2518 const U32 isUIOK = SvIsUV(sv);
2519 char buf[TYPE_CHARS(UV)];
2522 if (SvTYPE(sv) < SVt_PVIV)
2523 sv_upgrade(sv, SVt_PVIV);
2524 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2525 /* inlined from sv_setpvn */
2526 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2527 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2528 SvCUR_set(sv, ebuf - ptr);
2538 else if (SvNOKp(sv)) {
2539 const int olderrno = errno;
2540 if (SvTYPE(sv) < SVt_PVNV)
2541 sv_upgrade(sv, SVt_PVNV);
2542 /* The +20 is pure guesswork. Configure test needed. --jhi */
2543 s = SvGROW_mutable(sv, NV_DIG + 20);
2544 /* some Xenix systems wipe out errno here */
2546 if (SvNVX(sv) == 0.0)
2547 (void)strcpy(s,"0");
2551 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2554 #ifdef FIXNEGATIVEZERO
2555 if (*s == '-' && s[1] == '0' && !s[2])
2565 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2569 if (SvTYPE(sv) < SVt_PV)
2570 /* Typically the caller expects that sv_any is not NULL now. */
2571 sv_upgrade(sv, SVt_PV);
2575 const STRLEN len = s - SvPVX_const(sv);
2581 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2582 PTR2UV(sv),SvPVX_const(sv)));
2583 if (flags & SV_CONST_RETURN)
2584 return (char *)SvPVX_const(sv);
2585 if (flags & SV_MUTABLE_RETURN)
2586 return SvPVX_mutable(sv);
2591 =for apidoc sv_copypv
2593 Copies a stringified representation of the source SV into the
2594 destination SV. Automatically performs any necessary mg_get and
2595 coercion of numeric values into strings. Guaranteed to preserve
2596 UTF-8 flag even from overloaded objects. Similar in nature to
2597 sv_2pv[_flags] but operates directly on an SV instead of just the
2598 string. Mostly uses sv_2pv_flags to do its work, except when that
2599 would lose the UTF-8'ness of the PV.
2605 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2608 const char * const s = SvPV_const(ssv,len);
2609 sv_setpvn(dsv,s,len);
2617 =for apidoc sv_2pvbyte
2619 Return a pointer to the byte-encoded representation of the SV, and set *lp
2620 to its length. May cause the SV to be downgraded from UTF-8 as a
2623 Usually accessed via the C<SvPVbyte> macro.
2629 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2631 sv_utf8_downgrade(sv,0);
2632 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2636 =for apidoc sv_2pvutf8
2638 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2639 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2641 Usually accessed via the C<SvPVutf8> macro.
2647 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2649 sv_utf8_upgrade(sv);
2650 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2655 =for apidoc sv_2bool
2657 This function is only called on magical items, and is only used by
2658 sv_true() or its macro equivalent.
2664 Perl_sv_2bool(pTHX_ register SV *sv)
2673 SV * const tmpsv = AMG_CALLun(sv,bool_);
2674 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2675 return (bool)SvTRUE(tmpsv);
2677 return SvRV(sv) != 0;
2680 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2682 (*sv->sv_u.svu_pv > '0' ||
2683 Xpvtmp->xpv_cur > 1 ||
2684 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2691 return SvIVX(sv) != 0;
2694 return SvNVX(sv) != 0.0;
2702 =for apidoc sv_utf8_upgrade
2704 Converts the PV of an SV to its UTF-8-encoded form.
2705 Forces the SV to string form if it is not already.
2706 Always sets the SvUTF8 flag to avoid future validity checks even
2707 if all the bytes have hibit clear.
2709 This is not as a general purpose byte encoding to Unicode interface:
2710 use the Encode extension for that.
2712 =for apidoc sv_utf8_upgrade_flags
2714 Converts the PV of an SV to its UTF-8-encoded form.
2715 Forces the SV to string form if it is not already.
2716 Always sets the SvUTF8 flag to avoid future validity checks even
2717 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2718 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2719 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2721 This is not as a general purpose byte encoding to Unicode interface:
2722 use the Encode extension for that.
2728 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2731 if (sv == &PL_sv_undef)
2735 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2736 (void) sv_2pv_flags(sv,&len, flags);
2740 (void) SvPV_force(sv,len);
2749 sv_force_normal_flags(sv, 0);
2752 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2753 sv_recode_to_utf8(sv, PL_encoding);
2754 else { /* Assume Latin-1/EBCDIC */
2755 /* This function could be much more efficient if we
2756 * had a FLAG in SVs to signal if there are any hibit
2757 * chars in the PV. Given that there isn't such a flag
2758 * make the loop as fast as possible. */
2759 const U8 * const s = (U8 *) SvPVX_const(sv);
2760 const U8 * const e = (U8 *) SvEND(sv);
2765 /* Check for hi bit */
2766 if (!NATIVE_IS_INVARIANT(ch)) {
2767 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2768 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2770 SvPV_free(sv); /* No longer using what was there before. */
2771 SvPV_set(sv, (char*)recoded);
2772 SvCUR_set(sv, len - 1);
2773 SvLEN_set(sv, len); /* No longer know the real size. */
2777 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2784 =for apidoc sv_utf8_downgrade
2786 Attempts to convert the PV of an SV from characters to bytes.
2787 If the PV contains a character beyond byte, this conversion will fail;
2788 in this case, either returns false or, if C<fail_ok> is not
2791 This is not as a general purpose Unicode to byte encoding interface:
2792 use the Encode extension for that.
2798 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2801 if (SvPOKp(sv) && SvUTF8(sv)) {
2807 sv_force_normal_flags(sv, 0);
2809 s = (U8 *) SvPV(sv, len);
2810 if (!utf8_to_bytes(s, &len)) {
2815 Perl_croak(aTHX_ "Wide character in %s",
2818 Perl_croak(aTHX_ "Wide character");
2829 =for apidoc sv_utf8_encode
2831 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2832 flag off so that it looks like octets again.
2838 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2840 (void) sv_utf8_upgrade(sv);
2842 sv_force_normal_flags(sv, 0);
2844 if (SvREADONLY(sv)) {
2845 Perl_croak(aTHX_ PL_no_modify);
2851 =for apidoc sv_utf8_decode
2853 If the PV of the SV is an octet sequence in UTF-8
2854 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2855 so that it looks like a character. If the PV contains only single-byte
2856 characters, the C<SvUTF8> flag stays being off.
2857 Scans PV for validity and returns false if the PV is invalid UTF-8.
2863 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2869 /* The octets may have got themselves encoded - get them back as
2872 if (!sv_utf8_downgrade(sv, TRUE))
2875 /* it is actually just a matter of turning the utf8 flag on, but
2876 * we want to make sure everything inside is valid utf8 first.
2878 c = (const U8 *) SvPVX_const(sv);
2879 if (!is_utf8_string(c, SvCUR(sv)+1))
2881 e = (const U8 *) SvEND(sv);
2884 if (!UTF8_IS_INVARIANT(ch)) {
2894 =for apidoc sv_setsv
2896 Copies the contents of the source SV C<ssv> into the destination SV
2897 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2898 function if the source SV needs to be reused. Does not handle 'set' magic.
2899 Loosely speaking, it performs a copy-by-value, obliterating any previous
2900 content of the destination.
2902 You probably want to use one of the assortment of wrappers, such as
2903 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2904 C<SvSetMagicSV_nosteal>.
2906 =for apidoc sv_setsv_flags
2908 Copies the contents of the source SV C<ssv> into the destination SV
2909 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2910 function if the source SV needs to be reused. Does not handle 'set' magic.
2911 Loosely speaking, it performs a copy-by-value, obliterating any previous
2912 content of the destination.
2913 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2914 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2915 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2916 and C<sv_setsv_nomg> are implemented in terms of this function.
2918 You probably want to use one of the assortment of wrappers, such as
2919 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2920 C<SvSetMagicSV_nosteal>.
2922 This is the primary function for copying scalars, and most other
2923 copy-ish functions and macros use this underneath.
2929 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
2931 if (dtype != SVt_PVGV) {
2932 const char * const name = GvNAME(sstr);
2933 const STRLEN len = GvNAMELEN(sstr);
2934 /* don't upgrade SVt_PVLV: it can hold a glob */
2935 if (dtype != SVt_PVLV)
2936 sv_upgrade(dstr, SVt_PVGV);
2937 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
2938 GvSTASH(dstr) = GvSTASH(sstr);
2940 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
2941 GvNAME(dstr) = savepvn(name, len);
2942 GvNAMELEN(dstr) = len;
2943 SvFAKE_on(dstr); /* can coerce to non-glob */
2946 #ifdef GV_UNIQUE_CHECK
2947 if (GvUNIQUE((GV*)dstr)) {
2948 Perl_croak(aTHX_ PL_no_modify);
2952 (void)SvOK_off(dstr);
2953 GvINTRO_off(dstr); /* one-shot flag */
2955 GvGP(dstr) = gp_ref(GvGP(sstr));
2956 if (SvTAINTED(sstr))
2958 if (GvIMPORTED(dstr) != GVf_IMPORTED
2959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2961 GvIMPORTED_on(dstr);
2968 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2971 register U32 sflags;
2977 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2979 sstr = &PL_sv_undef;
2980 stype = SvTYPE(sstr);
2981 dtype = SvTYPE(dstr);
2986 /* need to nuke the magic */
2988 SvRMAGICAL_off(dstr);
2991 /* There's a lot of redundancy below but we're going for speed here */
2996 if (dtype != SVt_PVGV) {
2997 (void)SvOK_off(dstr);
3005 sv_upgrade(dstr, SVt_IV);
3008 sv_upgrade(dstr, SVt_PVNV);
3012 sv_upgrade(dstr, SVt_PVIV);
3015 (void)SvIOK_only(dstr);
3016 SvIV_set(dstr, SvIVX(sstr));
3019 if (SvTAINTED(sstr))
3030 sv_upgrade(dstr, SVt_NV);
3035 sv_upgrade(dstr, SVt_PVNV);
3038 SvNV_set(dstr, SvNVX(sstr));
3039 (void)SvNOK_only(dstr);
3040 if (SvTAINTED(sstr))
3048 sv_upgrade(dstr, SVt_RV);
3049 else if (dtype == SVt_PVGV &&
3050 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3053 if (GvIMPORTED(dstr) != GVf_IMPORTED
3054 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3056 GvIMPORTED_on(dstr);
3061 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3065 #ifdef PERL_OLD_COPY_ON_WRITE
3066 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3067 if (dtype < SVt_PVIV)
3068 sv_upgrade(dstr, SVt_PVIV);
3075 sv_upgrade(dstr, SVt_PV);
3078 if (dtype < SVt_PVIV)
3079 sv_upgrade(dstr, SVt_PVIV);
3082 if (dtype < SVt_PVNV)
3083 sv_upgrade(dstr, SVt_PVNV);
3090 const char * const type = sv_reftype(sstr,0);
3092 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3094 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3099 if (dtype <= SVt_PVGV) {
3100 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3105 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3107 if ((int)SvTYPE(sstr) != stype) {
3108 stype = SvTYPE(sstr);
3109 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3110 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3113 if (stype == SVt_PVLV)
3114 SvUPGRADE(dstr, SVt_PVNV);
3116 SvUPGRADE(dstr, (U32)stype);
3119 sflags = SvFLAGS(sstr);
3121 if (sflags & SVf_ROK) {
3122 if (dtype >= SVt_PV) {
3123 if (dtype == SVt_PVGV) {
3124 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3126 const int intro = GvINTRO(dstr);
3128 #ifdef GV_UNIQUE_CHECK
3129 if (GvUNIQUE((GV*)dstr)) {
3130 Perl_croak(aTHX_ PL_no_modify);
3135 GvINTRO_off(dstr); /* one-shot flag */
3136 GvLINE(dstr) = CopLINE(PL_curcop);
3137 GvEGV(dstr) = (GV*)dstr;
3140 switch (SvTYPE(sref)) {
3143 SAVEGENERICSV(GvAV(dstr));
3145 dref = (SV*)GvAV(dstr);
3146 GvAV(dstr) = (AV*)sref;
3147 if (!GvIMPORTED_AV(dstr)
3148 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3150 GvIMPORTED_AV_on(dstr);
3155 SAVEGENERICSV(GvHV(dstr));
3157 dref = (SV*)GvHV(dstr);
3158 GvHV(dstr) = (HV*)sref;
3159 if (!GvIMPORTED_HV(dstr)
3160 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3162 GvIMPORTED_HV_on(dstr);
3167 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3168 SvREFCNT_dec(GvCV(dstr));
3169 GvCV(dstr) = Nullcv;
3170 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3171 PL_sub_generation++;
3173 SAVEGENERICSV(GvCV(dstr));
3176 dref = (SV*)GvCV(dstr);
3177 if (GvCV(dstr) != (CV*)sref) {
3178 CV* const cv = GvCV(dstr);
3180 if (!GvCVGEN((GV*)dstr) &&
3181 (CvROOT(cv) || CvXSUB(cv)))
3183 /* Redefining a sub - warning is mandatory if
3184 it was a const and its value changed. */
3185 if (CvCONST(cv) && CvCONST((CV*)sref)
3187 == cv_const_sv((CV*)sref)) {
3188 /* They are 2 constant subroutines
3189 generated from the same constant.
3190 This probably means that they are
3191 really the "same" proxy subroutine
3192 instantiated in 2 places. Most likely
3193 this is when a constant is exported
3194 twice. Don't warn. */
3196 else if (ckWARN(WARN_REDEFINE)
3198 && (!CvCONST((CV*)sref)
3199 || sv_cmp(cv_const_sv(cv),
3200 cv_const_sv((CV*)sref)))))
3202 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3204 ? "Constant subroutine %s::%s redefined"
3205 : "Subroutine %s::%s redefined",
3206 HvNAME_get(GvSTASH((GV*)dstr)),
3207 GvENAME((GV*)dstr));
3211 cv_ckproto(cv, (GV*)dstr,
3213 ? SvPVX_const(sref) : Nullch);
3215 GvCV(dstr) = (CV*)sref;
3216 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3217 GvASSUMECV_on(dstr);
3218 PL_sub_generation++;
3220 if (!GvIMPORTED_CV(dstr)
3221 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3223 GvIMPORTED_CV_on(dstr);
3228 SAVEGENERICSV(GvIOp(dstr));
3230 dref = (SV*)GvIOp(dstr);
3231 GvIOp(dstr) = (IO*)sref;
3235 SAVEGENERICSV(GvFORM(dstr));
3237 dref = (SV*)GvFORM(dstr);
3238 GvFORM(dstr) = (CV*)sref;
3242 SAVEGENERICSV(GvSV(dstr));
3244 dref = (SV*)GvSV(dstr);
3246 if (!GvIMPORTED_SV(dstr)
3247 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3249 GvIMPORTED_SV_on(dstr);
3255 if (SvTAINTED(sstr))
3259 if (SvPVX_const(dstr)) {
3265 (void)SvOK_off(dstr);
3266 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3268 if (sflags & SVp_NOK) {
3270 /* Only set the public OK flag if the source has public OK. */
3271 if (sflags & SVf_NOK)
3272 SvFLAGS(dstr) |= SVf_NOK;
3273 SvNV_set(dstr, SvNVX(sstr));
3275 if (sflags & SVp_IOK) {
3276 (void)SvIOKp_on(dstr);
3277 if (sflags & SVf_IOK)
3278 SvFLAGS(dstr) |= SVf_IOK;
3279 if (sflags & SVf_IVisUV)
3281 SvIV_set(dstr, SvIVX(sstr));
3283 if (SvAMAGIC(sstr)) {
3287 else if (sflags & SVp_POK) {
3291 * Check to see if we can just swipe the string. If so, it's a
3292 * possible small lose on short strings, but a big win on long ones.
3293 * It might even be a win on short strings if SvPVX_const(dstr)
3294 * has to be allocated and SvPVX_const(sstr) has to be freed.
3297 /* Whichever path we take through the next code, we want this true,
3298 and doing it now facilitates the COW check. */
3299 (void)SvPOK_only(dstr);
3302 /* We're not already COW */
3303 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3304 #ifndef PERL_OLD_COPY_ON_WRITE
3305 /* or we are, but dstr isn't a suitable target. */
3306 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3311 (sflags & SVs_TEMP) && /* slated for free anyway? */
3312 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3313 (!(flags & SV_NOSTEAL)) &&
3314 /* and we're allowed to steal temps */
3315 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3316 SvLEN(sstr) && /* and really is a string */
3317 /* and won't be needed again, potentially */
3318 !(PL_op && PL_op->op_type == OP_AASSIGN))
3319 #ifdef PERL_OLD_COPY_ON_WRITE
3320 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3321 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3322 && SvTYPE(sstr) >= SVt_PVIV)
3325 /* Failed the swipe test, and it's not a shared hash key either.
3326 Have to copy the string. */
3327 STRLEN len = SvCUR(sstr);
3328 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3329 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3330 SvCUR_set(dstr, len);
3331 *SvEND(dstr) = '\0';
3333 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3335 /* Either it's a shared hash key, or it's suitable for
3336 copy-on-write or we can swipe the string. */
3338 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3342 #ifdef PERL_OLD_COPY_ON_WRITE
3344 /* I believe I should acquire a global SV mutex if
3345 it's a COW sv (not a shared hash key) to stop
3346 it going un copy-on-write.
3347 If the source SV has gone un copy on write between up there
3348 and down here, then (assert() that) it is of the correct
3349 form to make it copy on write again */
3350 if ((sflags & (SVf_FAKE | SVf_READONLY))
3351 != (SVf_FAKE | SVf_READONLY)) {
3352 SvREADONLY_on(sstr);
3354 /* Make the source SV into a loop of 1.
3355 (about to become 2) */
3356 SV_COW_NEXT_SV_SET(sstr, sstr);
3360 /* Initial code is common. */
3361 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3366 /* making another shared SV. */
3367 STRLEN cur = SvCUR(sstr);
3368 STRLEN len = SvLEN(sstr);
3369 #ifdef PERL_OLD_COPY_ON_WRITE
3371 assert (SvTYPE(dstr) >= SVt_PVIV);
3372 /* SvIsCOW_normal */
3373 /* splice us in between source and next-after-source. */
3374 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3375 SV_COW_NEXT_SV_SET(sstr, dstr);
3376 SvPV_set(dstr, SvPVX_mutable(sstr));
3380 /* SvIsCOW_shared_hash */
3381 DEBUG_C(PerlIO_printf(Perl_debug_log,
3382 "Copy on write: Sharing hash\n"));
3384 assert (SvTYPE(dstr) >= SVt_PV);
3386 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3388 SvLEN_set(dstr, len);
3389 SvCUR_set(dstr, cur);
3390 SvREADONLY_on(dstr);
3392 /* Relesase a global SV mutex. */
3395 { /* Passes the swipe test. */
3396 SvPV_set(dstr, SvPVX_mutable(sstr));
3397 SvLEN_set(dstr, SvLEN(sstr));
3398 SvCUR_set(dstr, SvCUR(sstr));
3401 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3402 SvPV_set(sstr, NULL);
3408 if (sflags & SVf_UTF8)
3410 if (sflags & SVp_NOK) {
3412 if (sflags & SVf_NOK)
3413 SvFLAGS(dstr) |= SVf_NOK;
3414 SvNV_set(dstr, SvNVX(sstr));
3416 if (sflags & SVp_IOK) {
3417 (void)SvIOKp_on(dstr);
3418 if (sflags & SVf_IOK)
3419 SvFLAGS(dstr) |= SVf_IOK;
3420 if (sflags & SVf_IVisUV)
3422 SvIV_set(dstr, SvIVX(sstr));
3425 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3426 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3427 smg->mg_ptr, smg->mg_len);
3428 SvRMAGICAL_on(dstr);
3431 else if (sflags & SVp_IOK) {
3432 if (sflags & SVf_IOK)
3433 (void)SvIOK_only(dstr);
3435 (void)SvOK_off(dstr);
3436 (void)SvIOKp_on(dstr);
3438 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3439 if (sflags & SVf_IVisUV)
3441 SvIV_set(dstr, SvIVX(sstr));
3442 if (sflags & SVp_NOK) {
3443 if (sflags & SVf_NOK)
3444 (void)SvNOK_on(dstr);
3446 (void)SvNOKp_on(dstr);
3447 SvNV_set(dstr, SvNVX(sstr));
3450 else if (sflags & SVp_NOK) {
3451 if (sflags & SVf_NOK)
3452 (void)SvNOK_only(dstr);
3454 (void)SvOK_off(dstr);
3457 SvNV_set(dstr, SvNVX(sstr));
3460 if (dtype == SVt_PVGV) {
3461 if (ckWARN(WARN_MISC))
3462 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3465 (void)SvOK_off(dstr);
3467 if (SvTAINTED(sstr))
3472 =for apidoc sv_setsv_mg
3474 Like C<sv_setsv>, but also handles 'set' magic.
3480 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3482 sv_setsv(dstr,sstr);
3486 #ifdef PERL_OLD_COPY_ON_WRITE
3488 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3490 STRLEN cur = SvCUR(sstr);
3491 STRLEN len = SvLEN(sstr);
3492 register char *new_pv;
3495 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3503 if (SvTHINKFIRST(dstr))
3504 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3505 else if (SvPVX_const(dstr))
3506 Safefree(SvPVX_const(dstr));
3510 SvUPGRADE(dstr, SVt_PVIV);
3512 assert (SvPOK(sstr));
3513 assert (SvPOKp(sstr));
3514 assert (!SvIOK(sstr));
3515 assert (!SvIOKp(sstr));
3516 assert (!SvNOK(sstr));
3517 assert (!SvNOKp(sstr));
3519 if (SvIsCOW(sstr)) {
3521 if (SvLEN(sstr) == 0) {
3522 /* source is a COW shared hash key. */
3523 DEBUG_C(PerlIO_printf(Perl_debug_log,
3524 "Fast copy on write: Sharing hash\n"));
3525 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3528 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3530 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3531 SvUPGRADE(sstr, SVt_PVIV);
3532 SvREADONLY_on(sstr);
3534 DEBUG_C(PerlIO_printf(Perl_debug_log,
3535 "Fast copy on write: Converting sstr to COW\n"));
3536 SV_COW_NEXT_SV_SET(dstr, sstr);
3538 SV_COW_NEXT_SV_SET(sstr, dstr);
3539 new_pv = SvPVX_mutable(sstr);
3542 SvPV_set(dstr, new_pv);
3543 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3546 SvLEN_set(dstr, len);
3547 SvCUR_set(dstr, cur);
3556 =for apidoc sv_setpvn
3558 Copies a string into an SV. The C<len> parameter indicates the number of
3559 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3560 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3566 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3569 register char *dptr;
3571 SV_CHECK_THINKFIRST_COW_DROP(sv);
3577 /* len is STRLEN which is unsigned, need to copy to signed */
3580 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3582 SvUPGRADE(sv, SVt_PV);
3584 dptr = SvGROW(sv, len + 1);
3585 Move(ptr,dptr,len,char);
3588 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3593 =for apidoc sv_setpvn_mg
3595 Like C<sv_setpvn>, but also handles 'set' magic.
3601 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3603 sv_setpvn(sv,ptr,len);
3608 =for apidoc sv_setpv
3610 Copies a string into an SV. The string must be null-terminated. Does not
3611 handle 'set' magic. See C<sv_setpv_mg>.
3617 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3620 register STRLEN len;
3622 SV_CHECK_THINKFIRST_COW_DROP(sv);
3628 SvUPGRADE(sv, SVt_PV);
3630 SvGROW(sv, len + 1);
3631 Move(ptr,SvPVX(sv),len+1,char);
3633 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3638 =for apidoc sv_setpv_mg
3640 Like C<sv_setpv>, but also handles 'set' magic.
3646 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3653 =for apidoc sv_usepvn
3655 Tells an SV to use C<ptr> to find its string value. Normally the string is
3656 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3657 The C<ptr> should point to memory that was allocated by C<malloc>. The
3658 string length, C<len>, must be supplied. This function will realloc the
3659 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3660 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3661 See C<sv_usepvn_mg>.
3667 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3671 SV_CHECK_THINKFIRST_COW_DROP(sv);
3672 SvUPGRADE(sv, SVt_PV);
3677 if (SvPVX_const(sv))
3680 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3681 ptr = saferealloc (ptr, allocate);
3684 SvLEN_set(sv, allocate);
3686 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3691 =for apidoc sv_usepvn_mg
3693 Like C<sv_usepvn>, but also handles 'set' magic.
3699 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3701 sv_usepvn(sv,ptr,len);
3705 #ifdef PERL_OLD_COPY_ON_WRITE
3706 /* Need to do this *after* making the SV normal, as we need the buffer
3707 pointer to remain valid until after we've copied it. If we let go too early,
3708 another thread could invalidate it by unsharing last of the same hash key
3709 (which it can do by means other than releasing copy-on-write Svs)
3710 or by changing the other copy-on-write SVs in the loop. */
3712 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3714 if (len) { /* this SV was SvIsCOW_normal(sv) */
3715 /* we need to find the SV pointing to us. */
3716 SV * const current = SV_COW_NEXT_SV(after);
3718 if (current == sv) {
3719 /* The SV we point to points back to us (there were only two of us
3721 Hence other SV is no longer copy on write either. */
3723 SvREADONLY_off(after);
3725 /* We need to follow the pointers around the loop. */
3727 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3730 /* don't loop forever if the structure is bust, and we have
3731 a pointer into a closed loop. */
3732 assert (current != after);
3733 assert (SvPVX_const(current) == pvx);
3735 /* Make the SV before us point to the SV after us. */
3736 SV_COW_NEXT_SV_SET(current, after);
3739 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3744 Perl_sv_release_IVX(pTHX_ register SV *sv)
3747 sv_force_normal_flags(sv, 0);
3753 =for apidoc sv_force_normal_flags
3755 Undo various types of fakery on an SV: if the PV is a shared string, make
3756 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3757 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3758 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3759 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3760 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3761 set to some other value.) In addition, the C<flags> parameter gets passed to
3762 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3763 with flags set to 0.
3769 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3772 #ifdef PERL_OLD_COPY_ON_WRITE
3773 if (SvREADONLY(sv)) {
3774 /* At this point I believe I should acquire a global SV mutex. */
3776 const char * const pvx = SvPVX_const(sv);
3777 const STRLEN len = SvLEN(sv);
3778 const STRLEN cur = SvCUR(sv);
3779 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3781 PerlIO_printf(Perl_debug_log,
3782 "Copy on write: Force normal %ld\n",
3788 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3791 if (flags & SV_COW_DROP_PV) {
3792 /* OK, so we don't need to copy our buffer. */
3795 SvGROW(sv, cur + 1);
3796 Move(pvx,SvPVX(sv),cur,char);
3800 sv_release_COW(sv, pvx, len, next);
3805 else if (IN_PERL_RUNTIME)
3806 Perl_croak(aTHX_ PL_no_modify);
3807 /* At this point I believe that I can drop the global SV mutex. */
3810 if (SvREADONLY(sv)) {
3812 const char * const pvx = SvPVX_const(sv);
3813 const STRLEN len = SvCUR(sv);
3816 SvPV_set(sv, Nullch);
3818 SvGROW(sv, len + 1);
3819 Move(pvx,SvPVX(sv),len,char);
3821 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3823 else if (IN_PERL_RUNTIME)
3824 Perl_croak(aTHX_ PL_no_modify);
3828 sv_unref_flags(sv, flags);
3829 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3836 Efficient removal of characters from the beginning of the string buffer.
3837 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3838 the string buffer. The C<ptr> becomes the first character of the adjusted
3839 string. Uses the "OOK hack".
3840 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3841 refer to the same chunk of data.
3847 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3849 register STRLEN delta;
3850 if (!ptr || !SvPOKp(sv))
3852 delta = ptr - SvPVX_const(sv);
3853 SV_CHECK_THINKFIRST(sv);
3854 if (SvTYPE(sv) < SVt_PVIV)
3855 sv_upgrade(sv,SVt_PVIV);
3858 if (!SvLEN(sv)) { /* make copy of shared string */
3859 const char *pvx = SvPVX_const(sv);
3860 const STRLEN len = SvCUR(sv);
3861 SvGROW(sv, len + 1);
3862 Move(pvx,SvPVX(sv),len,char);
3866 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3867 and we do that anyway inside the SvNIOK_off
3869 SvFLAGS(sv) |= SVf_OOK;
3872 SvLEN_set(sv, SvLEN(sv) - delta);
3873 SvCUR_set(sv, SvCUR(sv) - delta);
3874 SvPV_set(sv, SvPVX(sv) + delta);
3875 SvIV_set(sv, SvIVX(sv) + delta);
3879 =for apidoc sv_catpvn
3881 Concatenates the string onto the end of the string which is in the SV. The
3882 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3883 status set, then the bytes appended should be valid UTF-8.
3884 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3886 =for apidoc sv_catpvn_flags
3888 Concatenates the string onto the end of the string which is in the SV. The
3889 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3890 status set, then the bytes appended should be valid UTF-8.
3891 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3892 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3893 in terms of this function.
3899 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3903 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3905 SvGROW(dsv, dlen + slen + 1);
3907 sstr = SvPVX_const(dsv);
3908 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3909 SvCUR_set(dsv, SvCUR(dsv) + slen);
3911 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3913 if (flags & SV_SMAGIC)
3918 =for apidoc sv_catsv
3920 Concatenates the string from SV C<ssv> onto the end of the string in
3921 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3922 not 'set' magic. See C<sv_catsv_mg>.
3924 =for apidoc sv_catsv_flags
3926 Concatenates the string from SV C<ssv> onto the end of the string in
3927 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3928 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3929 and C<sv_catsv_nomg> are implemented in terms of this function.
3934 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3939 const char *spv = SvPV_const(ssv, slen);
3941 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3942 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3943 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3944 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3945 dsv->sv_flags doesn't have that bit set.
3946 Andy Dougherty 12 Oct 2001
3948 const I32 sutf8 = DO_UTF8(ssv);
3951 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3953 dutf8 = DO_UTF8(dsv);
3955 if (dutf8 != sutf8) {
3957 /* Not modifying source SV, so taking a temporary copy. */
3958 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3960 sv_utf8_upgrade(csv);
3961 spv = SvPV_const(csv, slen);
3964 sv_utf8_upgrade_nomg(dsv);
3966 sv_catpvn_nomg(dsv, spv, slen);
3969 if (flags & SV_SMAGIC)
3974 =for apidoc sv_catpv
3976 Concatenates the string onto the end of the string which is in the SV.
3977 If the SV has the UTF-8 status set, then the bytes appended should be
3978 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3983 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3986 register STRLEN len;
3992 junk = SvPV_force(sv, tlen);
3994 SvGROW(sv, tlen + len + 1);
3996 ptr = SvPVX_const(sv);
3997 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3998 SvCUR_set(sv, SvCUR(sv) + len);
3999 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4004 =for apidoc sv_catpv_mg
4006 Like C<sv_catpv>, but also handles 'set' magic.
4012 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4021 Creates a new SV. A non-zero C<len> parameter indicates the number of
4022 bytes of preallocated string space the SV should have. An extra byte for a
4023 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4024 space is allocated.) The reference count for the new SV is set to 1.
4026 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4027 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4028 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4029 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4030 modules supporting older perls.
4036 Perl_newSV(pTHX_ STRLEN len)
4043 sv_upgrade(sv, SVt_PV);
4044 SvGROW(sv, len + 1);
4049 =for apidoc sv_magicext
4051 Adds magic to an SV, upgrading it if necessary. Applies the
4052 supplied vtable and returns a pointer to the magic added.
4054 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4055 In particular, you can add magic to SvREADONLY SVs, and add more than
4056 one instance of the same 'how'.
4058 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4059 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4060 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4061 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4063 (This is now used as a subroutine by C<sv_magic>.)
4068 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4069 const char* name, I32 namlen)
4074 if (SvTYPE(sv) < SVt_PVMG) {
4075 SvUPGRADE(sv, SVt_PVMG);
4077 Newxz(mg, 1, MAGIC);
4078 mg->mg_moremagic = SvMAGIC(sv);
4079 SvMAGIC_set(sv, mg);
4081 /* Sometimes a magic contains a reference loop, where the sv and
4082 object refer to each other. To prevent a reference loop that
4083 would prevent such objects being freed, we look for such loops
4084 and if we find one we avoid incrementing the object refcount.
4086 Note we cannot do this to avoid self-tie loops as intervening RV must
4087 have its REFCNT incremented to keep it in existence.
4090 if (!obj || obj == sv ||
4091 how == PERL_MAGIC_arylen ||
4092 how == PERL_MAGIC_qr ||
4093 how == PERL_MAGIC_symtab ||
4094 (SvTYPE(obj) == SVt_PVGV &&
4095 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4096 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4097 GvFORM(obj) == (CV*)sv)))
4102 mg->mg_obj = SvREFCNT_inc(obj);
4103 mg->mg_flags |= MGf_REFCOUNTED;
4106 /* Normal self-ties simply pass a null object, and instead of
4107 using mg_obj directly, use the SvTIED_obj macro to produce a
4108 new RV as needed. For glob "self-ties", we are tieing the PVIO
4109 with an RV obj pointing to the glob containing the PVIO. In
4110 this case, to avoid a reference loop, we need to weaken the
4114 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4115 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4121 mg->mg_len = namlen;
4124 mg->mg_ptr = savepvn(name, namlen);
4125 else if (namlen == HEf_SVKEY)
4126 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4128 mg->mg_ptr = (char *) name;
4130 mg->mg_virtual = vtable;
4134 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4139 =for apidoc sv_magic
4141 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4142 then adds a new magic item of type C<how> to the head of the magic list.
4144 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4145 handling of the C<name> and C<namlen> arguments.
4147 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4148 to add more than one instance of the same 'how'.
4154 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4160 #ifdef PERL_OLD_COPY_ON_WRITE
4162 sv_force_normal_flags(sv, 0);
4164 if (SvREADONLY(sv)) {
4166 /* its okay to attach magic to shared strings; the subsequent
4167 * upgrade to PVMG will unshare the string */
4168 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4171 && how != PERL_MAGIC_regex_global
4172 && how != PERL_MAGIC_bm
4173 && how != PERL_MAGIC_fm
4174 && how != PERL_MAGIC_sv
4175 && how != PERL_MAGIC_backref
4178 Perl_croak(aTHX_ PL_no_modify);
4181 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4182 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4183 /* sv_magic() refuses to add a magic of the same 'how' as an
4186 if (how == PERL_MAGIC_taint)
4194 vtable = &PL_vtbl_sv;
4196 case PERL_MAGIC_overload:
4197 vtable = &PL_vtbl_amagic;
4199 case PERL_MAGIC_overload_elem:
4200 vtable = &PL_vtbl_amagicelem;
4202 case PERL_MAGIC_overload_table:
4203 vtable = &PL_vtbl_ovrld;
4206 vtable = &PL_vtbl_bm;
4208 case PERL_MAGIC_regdata:
4209 vtable = &PL_vtbl_regdata;
4211 case PERL_MAGIC_regdatum:
4212 vtable = &PL_vtbl_regdatum;
4214 case PERL_MAGIC_env:
4215 vtable = &PL_vtbl_env;
4218 vtable = &PL_vtbl_fm;
4220 case PERL_MAGIC_envelem:
4221 vtable = &PL_vtbl_envelem;
4223 case PERL_MAGIC_regex_global:
4224 vtable = &PL_vtbl_mglob;
4226 case PERL_MAGIC_isa:
4227 vtable = &PL_vtbl_isa;
4229 case PERL_MAGIC_isaelem:
4230 vtable = &PL_vtbl_isaelem;
4232 case PERL_MAGIC_nkeys:
4233 vtable = &PL_vtbl_nkeys;
4235 case PERL_MAGIC_dbfile:
4238 case PERL_MAGIC_dbline:
4239 vtable = &PL_vtbl_dbline;
4241 #ifdef USE_LOCALE_COLLATE
4242 case PERL_MAGIC_collxfrm:
4243 vtable = &PL_vtbl_collxfrm;
4245 #endif /* USE_LOCALE_COLLATE */
4246 case PERL_MAGIC_tied:
4247 vtable = &PL_vtbl_pack;
4249 case PERL_MAGIC_tiedelem:
4250 case PERL_MAGIC_tiedscalar:
4251 vtable = &PL_vtbl_packelem;
4254 vtable = &PL_vtbl_regexp;
4256 case PERL_MAGIC_sig:
4257 vtable = &PL_vtbl_sig;
4259 case PERL_MAGIC_sigelem:
4260 vtable = &PL_vtbl_sigelem;
4262 case PERL_MAGIC_taint:
4263 vtable = &PL_vtbl_taint;
4265 case PERL_MAGIC_uvar:
4266 vtable = &PL_vtbl_uvar;
4268 case PERL_MAGIC_vec:
4269 vtable = &PL_vtbl_vec;
4271 case PERL_MAGIC_arylen_p:
4272 case PERL_MAGIC_rhash:
4273 case PERL_MAGIC_symtab:
4274 case PERL_MAGIC_vstring:
4277 case PERL_MAGIC_utf8:
4278 vtable = &PL_vtbl_utf8;
4280 case PERL_MAGIC_substr:
4281 vtable = &PL_vtbl_substr;
4283 case PERL_MAGIC_defelem:
4284 vtable = &PL_vtbl_defelem;
4286 case PERL_MAGIC_glob:
4287 vtable = &PL_vtbl_glob;
4289 case PERL_MAGIC_arylen:
4290 vtable = &PL_vtbl_arylen;
4292 case PERL_MAGIC_pos:
4293 vtable = &PL_vtbl_pos;
4295 case PERL_MAGIC_backref:
4296 vtable = &PL_vtbl_backref;
4298 case PERL_MAGIC_ext:
4299 /* Reserved for use by extensions not perl internals. */
4300 /* Useful for attaching extension internal data to perl vars. */
4301 /* Note that multiple extensions may clash if magical scalars */
4302 /* etc holding private data from one are passed to another. */
4306 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4309 /* Rest of work is done else where */
4310 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4313 case PERL_MAGIC_taint:
4316 case PERL_MAGIC_ext:
4317 case PERL_MAGIC_dbfile:
4324 =for apidoc sv_unmagic
4326 Removes all magic of type C<type> from an SV.
4332 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4336 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4339 for (mg = *mgp; mg; mg = *mgp) {
4340 if (mg->mg_type == type) {
4341 const MGVTBL* const vtbl = mg->mg_virtual;
4342 *mgp = mg->mg_moremagic;
4343 if (vtbl && vtbl->svt_free)
4344 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4345 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4347 Safefree(mg->mg_ptr);
4348 else if (mg->mg_len == HEf_SVKEY)
4349 SvREFCNT_dec((SV*)mg->mg_ptr);
4350 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4351 Safefree(mg->mg_ptr);
4353 if (mg->mg_flags & MGf_REFCOUNTED)
4354 SvREFCNT_dec(mg->mg_obj);
4358 mgp = &mg->mg_moremagic;
4362 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4363 SvMAGIC_set(sv, NULL);
4370 =for apidoc sv_rvweaken
4372 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4373 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4374 push a back-reference to this RV onto the array of backreferences
4375 associated with that magic.
4381 Perl_sv_rvweaken(pTHX_ SV *sv)
4384 if (!SvOK(sv)) /* let undefs pass */
4387 Perl_croak(aTHX_ "Can't weaken a nonreference");
4388 else if (SvWEAKREF(sv)) {
4389 if (ckWARN(WARN_MISC))
4390 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4394 Perl_sv_add_backref(aTHX_ tsv, sv);
4400 /* Give tsv backref magic if it hasn't already got it, then push a
4401 * back-reference to sv onto the array associated with the backref magic.
4405 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4410 if (SvTYPE(tsv) == SVt_PVHV) {
4411 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4415 /* There is no AV in the offical place - try a fixup. */
4416 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4419 /* Aha. They've got it stowed in magic. Bring it back. */
4420 av = (AV*)mg->mg_obj;
4421 /* Stop mg_free decreasing the refernce count. */
4423 /* Stop mg_free even calling the destructor, given that
4424 there's no AV to free up. */
4426 sv_unmagic(tsv, PERL_MAGIC_backref);
4435 const MAGIC *const mg
4436 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4438 av = (AV*)mg->mg_obj;
4442 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4443 /* av now has a refcnt of 2, which avoids it getting freed
4444 * before us during global cleanup. The extra ref is removed
4445 * by magic_killbackrefs() when tsv is being freed */
4448 if (AvFILLp(av) >= AvMAX(av)) {
4449 av_extend(av, AvFILLp(av)+1);
4451 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4454 /* delete a back-reference to ourselves from the backref magic associated
4455 * with the SV we point to.
4459 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4466 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4467 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4468 /* We mustn't attempt to "fix up" the hash here by moving the
4469 backreference array back to the hv_aux structure, as that is stored
4470 in the main HvARRAY(), and hfreentries assumes that no-one
4471 reallocates HvARRAY() while it is running. */
4474 const MAGIC *const mg
4475 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4477 av = (AV *)mg->mg_obj;
4480 if (PL_in_clean_all)
4482 Perl_croak(aTHX_ "panic: del_backref");
4489 /* We shouldn't be in here more than once, but for paranoia reasons lets
4491 for (i = AvFILLp(av); i >= 0; i--) {
4493 const SSize_t fill = AvFILLp(av);
4495 /* We weren't the last entry.
4496 An unordered list has this property that you can take the
4497 last element off the end to fill the hole, and it's still
4498 an unordered list :-)
4503 AvFILLp(av) = fill - 1;
4509 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4511 SV **svp = AvARRAY(av);
4513 PERL_UNUSED_ARG(sv);
4515 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4516 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4517 if (svp && !SvIS_FREED(av)) {
4518 SV *const *const last = svp + AvFILLp(av);
4520 while (svp <= last) {
4522 SV *const referrer = *svp;
4523 if (SvWEAKREF(referrer)) {
4524 /* XXX Should we check that it hasn't changed? */
4525 SvRV_set(referrer, 0);
4527 SvWEAKREF_off(referrer);
4528 } else if (SvTYPE(referrer) == SVt_PVGV ||
4529 SvTYPE(referrer) == SVt_PVLV) {
4530 /* You lookin' at me? */
4531 assert(GvSTASH(referrer));
4532 assert(GvSTASH(referrer) == (HV*)sv);
4533 GvSTASH(referrer) = 0;
4536 "panic: magic_killbackrefs (flags=%"UVxf")",
4537 (UV)SvFLAGS(referrer));
4545 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4550 =for apidoc sv_insert
4552 Inserts a string at the specified offset/length within the SV. Similar to
4553 the Perl substr() function.
4559 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4564 register char *midend;
4565 register char *bigend;
4571 Perl_croak(aTHX_ "Can't modify non-existent substring");
4572 SvPV_force(bigstr, curlen);
4573 (void)SvPOK_only_UTF8(bigstr);
4574 if (offset + len > curlen) {
4575 SvGROW(bigstr, offset+len+1);
4576 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4577 SvCUR_set(bigstr, offset+len);
4581 i = littlelen - len;
4582 if (i > 0) { /* string might grow */
4583 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4584 mid = big + offset + len;
4585 midend = bigend = big + SvCUR(bigstr);
4588 while (midend > mid) /* shove everything down */
4589 *--bigend = *--midend;
4590 Move(little,big+offset,littlelen,char);
4591 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4596 Move(little,SvPVX(bigstr)+offset,len,char);
4601 big = SvPVX(bigstr);
4604 bigend = big + SvCUR(bigstr);
4606 if (midend > bigend)
4607 Perl_croak(aTHX_ "panic: sv_insert");
4609 if (mid - big > bigend - midend) { /* faster to shorten from end */
4611 Move(little, mid, littlelen,char);
4614 i = bigend - midend;
4616 Move(midend, mid, i,char);
4620 SvCUR_set(bigstr, mid - big);
4622 else if ((i = mid - big)) { /* faster from front */
4623 midend -= littlelen;
4625 sv_chop(bigstr,midend-i);
4630 Move(little, mid, littlelen,char);
4632 else if (littlelen) {
4633 midend -= littlelen;
4634 sv_chop(bigstr,midend);
4635 Move(little,midend,littlelen,char);
4638 sv_chop(bigstr,midend);
4644 =for apidoc sv_replace
4646 Make the first argument a copy of the second, then delete the original.
4647 The target SV physically takes over ownership of the body of the source SV
4648 and inherits its flags; however, the target keeps any magic it owns,
4649 and any magic in the source is discarded.
4650 Note that this is a rather specialist SV copying operation; most of the
4651 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4657 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4660 const U32 refcnt = SvREFCNT(sv);
4661 SV_CHECK_THINKFIRST_COW_DROP(sv);
4662 if (SvREFCNT(nsv) != 1) {
4663 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4664 UVuf " != 1)", (UV) SvREFCNT(nsv));
4666 if (SvMAGICAL(sv)) {
4670 sv_upgrade(nsv, SVt_PVMG);
4671 SvMAGIC_set(nsv, SvMAGIC(sv));
4672 SvFLAGS(nsv) |= SvMAGICAL(sv);
4674 SvMAGIC_set(sv, NULL);
4678 assert(!SvREFCNT(sv));
4679 #ifdef DEBUG_LEAKING_SCALARS
4680 sv->sv_flags = nsv->sv_flags;
4681 sv->sv_any = nsv->sv_any;
4682 sv->sv_refcnt = nsv->sv_refcnt;
4683 sv->sv_u = nsv->sv_u;
4685 StructCopy(nsv,sv,SV);
4687 /* Currently could join these into one piece of pointer arithmetic, but
4688 it would be unclear. */
4689 if(SvTYPE(sv) == SVt_IV)
4691 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4692 else if (SvTYPE(sv) == SVt_RV) {
4693 SvANY(sv) = &sv->sv_u.svu_rv;
4697 #ifdef PERL_OLD_COPY_ON_WRITE
4698 if (SvIsCOW_normal(nsv)) {
4699 /* We need to follow the pointers around the loop to make the
4700 previous SV point to sv, rather than nsv. */
4703 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4706 assert(SvPVX_const(current) == SvPVX_const(nsv));
4708 /* Make the SV before us point to the SV after us. */
4710 PerlIO_printf(Perl_debug_log, "previous is\n");
4712 PerlIO_printf(Perl_debug_log,
4713 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4714 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4716 SV_COW_NEXT_SV_SET(current, sv);
4719 SvREFCNT(sv) = refcnt;
4720 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4726 =for apidoc sv_clear
4728 Clear an SV: call any destructors, free up any memory used by the body,
4729 and free the body itself. The SV's head is I<not> freed, although
4730 its type is set to all 1's so that it won't inadvertently be assumed
4731 to be live during global destruction etc.
4732 This function should only be called when REFCNT is zero. Most of the time
4733 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4740 Perl_sv_clear(pTHX_ register SV *sv)
4743 const U32 type = SvTYPE(sv);
4744 const struct body_details *const sv_type_details
4745 = bodies_by_type + type;
4748 assert(SvREFCNT(sv) == 0);
4754 if (PL_defstash) { /* Still have a symbol table? */
4759 stash = SvSTASH(sv);
4760 destructor = StashHANDLER(stash,DESTROY);
4762 SV* const tmpref = newRV(sv);
4763 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4765 PUSHSTACKi(PERLSI_DESTROY);
4770 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4776 if(SvREFCNT(tmpref) < 2) {
4777 /* tmpref is not kept alive! */
4779 SvRV_set(tmpref, NULL);
4782 SvREFCNT_dec(tmpref);
4784 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4788 if (PL_in_clean_objs)
4789 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4791 /* DESTROY gave object new lease on life */
4797 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4798 SvOBJECT_off(sv); /* Curse the object. */
4799 if (type != SVt_PVIO)
4800 --PL_sv_objcount; /* XXX Might want something more general */
4803 if (type >= SVt_PVMG) {
4806 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4807 SvREFCNT_dec(SvSTASH(sv));
4812 IoIFP(sv) != PerlIO_stdin() &&
4813 IoIFP(sv) != PerlIO_stdout() &&
4814 IoIFP(sv) != PerlIO_stderr())
4816 io_close((IO*)sv, FALSE);
4818 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4819 PerlDir_close(IoDIRP(sv));
4820 IoDIRP(sv) = (DIR*)NULL;
4821 Safefree(IoTOP_NAME(sv));
4822 Safefree(IoFMT_NAME(sv));
4823 Safefree(IoBOTTOM_NAME(sv));
4832 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4839 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4840 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4841 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4842 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4844 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4845 SvREFCNT_dec(LvTARG(sv));
4849 Safefree(GvNAME(sv));
4850 /* If we're in a stash, we don't own a reference to it. However it does
4851 have a back reference to us, which needs to be cleared. */
4853 sv_del_backref((SV*)GvSTASH(sv), sv);
4858 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4860 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4861 /* Don't even bother with turning off the OOK flag. */
4866 SV *target = SvRV(sv);
4868 sv_del_backref(target, sv);
4870 SvREFCNT_dec(target);
4872 #ifdef PERL_OLD_COPY_ON_WRITE
4873 else if (SvPVX_const(sv)) {
4875 /* I believe I need to grab the global SV mutex here and
4876 then recheck the COW status. */
4878 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4881 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4882 SV_COW_NEXT_SV(sv));
4883 /* And drop it here. */
4885 } else if (SvLEN(sv)) {
4886 Safefree(SvPVX_const(sv));
4890 else if (SvPVX_const(sv) && SvLEN(sv))
4891 Safefree(SvPVX_mutable(sv));
4892 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4893 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4902 SvFLAGS(sv) &= SVf_BREAK;
4903 SvFLAGS(sv) |= SVTYPEMASK;
4905 if (sv_type_details->arena) {
4906 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4907 &PL_body_roots[type]);
4909 else if (sv_type_details->size) {
4910 my_safefree(SvANY(sv));
4915 =for apidoc sv_newref
4917 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4924 Perl_sv_newref(pTHX_ SV *sv)
4934 Decrement an SV's reference count, and if it drops to zero, call
4935 C<sv_clear> to invoke destructors and free up any memory used by
4936 the body; finally, deallocate the SV's head itself.
4937 Normally called via a wrapper macro C<SvREFCNT_dec>.
4943 Perl_sv_free(pTHX_ SV *sv)
4948 if (SvREFCNT(sv) == 0) {
4949 if (SvFLAGS(sv) & SVf_BREAK)
4950 /* this SV's refcnt has been artificially decremented to
4951 * trigger cleanup */
4953 if (PL_in_clean_all) /* All is fair */
4955 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4956 /* make sure SvREFCNT(sv)==0 happens very seldom */
4957 SvREFCNT(sv) = (~(U32)0)/2;
4960 if (ckWARN_d(WARN_INTERNAL)) {
4961 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4962 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4963 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4964 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4965 Perl_dump_sv_child(aTHX_ sv);
4970 if (--(SvREFCNT(sv)) > 0)
4972 Perl_sv_free2(aTHX_ sv);
4976 Perl_sv_free2(pTHX_ SV *sv)
4981 if (ckWARN_d(WARN_DEBUGGING))
4982 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4983 "Attempt to free temp prematurely: SV 0x%"UVxf
4984 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4988 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4989 /* make sure SvREFCNT(sv)==0 happens very seldom */
4990 SvREFCNT(sv) = (~(U32)0)/2;
5001 Returns the length of the string in the SV. Handles magic and type
5002 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5008 Perl_sv_len(pTHX_ register SV *sv)
5016 len = mg_length(sv);
5018 (void)SvPV_const(sv, len);
5023 =for apidoc sv_len_utf8
5025 Returns the number of characters in the string in an SV, counting wide
5026 UTF-8 bytes as a single character. Handles magic and type coercion.
5032 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5033 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5034 * (Note that the mg_len is not the length of the mg_ptr field.)
5039 Perl_sv_len_utf8(pTHX_ register SV *sv)
5045 return mg_length(sv);
5049 const U8 *s = (U8*)SvPV_const(sv, len);
5050 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5052 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5054 #ifdef PERL_UTF8_CACHE_ASSERT
5055 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5059 ulen = Perl_utf8_length(aTHX_ s, s + len);
5060 if (!mg && !SvREADONLY(sv)) {
5061 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5062 mg = mg_find(sv, PERL_MAGIC_utf8);
5072 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5073 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5074 * between UTF-8 and byte offsets. There are two (substr offset and substr
5075 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5076 * and byte offset) cache positions.
5078 * The mg_len field is used by sv_len_utf8(), see its comments.
5079 * Note that the mg_len is not the length of the mg_ptr field.
5083 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5084 I32 offsetp, const U8 *s, const U8 *start)
5088 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5090 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5094 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5096 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5097 (*mgp)->mg_ptr = (char *) *cachep;
5101 (*cachep)[i] = offsetp;
5102 (*cachep)[i+1] = s - start;
5110 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5111 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5112 * between UTF-8 and byte offsets. See also the comments of
5113 * S_utf8_mg_pos_init().
5117 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)
5121 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5123 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5124 if (*mgp && (*mgp)->mg_ptr) {
5125 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5126 ASSERT_UTF8_CACHE(*cachep);
5127 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5129 else { /* We will skip to the right spot. */
5134 /* The assumption is that going backward is half
5135 * the speed of going forward (that's where the
5136 * 2 * backw in the below comes from). (The real
5137 * figure of course depends on the UTF-8 data.) */
5139 if ((*cachep)[i] > (STRLEN)uoff) {
5141 backw = (*cachep)[i] - (STRLEN)uoff;
5143 if (forw < 2 * backw)
5146 p = start + (*cachep)[i+1];
5148 /* Try this only for the substr offset (i == 0),
5149 * not for the substr length (i == 2). */
5150 else if (i == 0) { /* (*cachep)[i] < uoff */
5151 const STRLEN ulen = sv_len_utf8(sv);
5153 if ((STRLEN)uoff < ulen) {
5154 forw = (STRLEN)uoff - (*cachep)[i];
5155 backw = ulen - (STRLEN)uoff;
5157 if (forw < 2 * backw)
5158 p = start + (*cachep)[i+1];
5163 /* If the string is not long enough for uoff,
5164 * we could extend it, but not at this low a level. */
5168 if (forw < 2 * backw) {
5175 while (UTF8_IS_CONTINUATION(*p))
5180 /* Update the cache. */
5181 (*cachep)[i] = (STRLEN)uoff;
5182 (*cachep)[i+1] = p - start;
5184 /* Drop the stale "length" cache */
5193 if (found) { /* Setup the return values. */
5194 *offsetp = (*cachep)[i+1];
5195 *sp = start + *offsetp;
5198 *offsetp = send - start;
5200 else if (*sp < start) {
5206 #ifdef PERL_UTF8_CACHE_ASSERT
5211 while (n-- && s < send)
5215 assert(*offsetp == s - start);
5216 assert((*cachep)[0] == (STRLEN)uoff);
5217 assert((*cachep)[1] == *offsetp);
5219 ASSERT_UTF8_CACHE(*cachep);
5228 =for apidoc sv_pos_u2b
5230 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5231 the start of the string, to a count of the equivalent number of bytes; if
5232 lenp is non-zero, it does the same to lenp, but this time starting from
5233 the offset, rather than from the start of the string. Handles magic and
5240 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5241 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5242 * byte offsets. See also the comments of S_utf8_mg_pos().
5247 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5255 start = (U8*)SvPV_const(sv, len);
5258 STRLEN *cache = NULL;
5259 const U8 *s = start;
5260 I32 uoffset = *offsetp;
5261 const U8 * const send = s + len;
5263 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5265 if (!found && uoffset > 0) {
5266 while (s < send && uoffset--)
5270 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5272 *offsetp = s - start;
5277 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5281 if (!found && *lenp > 0) {
5284 while (s < send && ulen--)
5288 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5292 ASSERT_UTF8_CACHE(cache);
5304 =for apidoc sv_pos_b2u
5306 Converts the value pointed to by offsetp from a count of bytes from the
5307 start of the string, to a count of the equivalent number of UTF-8 chars.
5308 Handles magic and type coercion.
5314 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5315 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5316 * byte offsets. See also the comments of S_utf8_mg_pos().
5321 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5329 s = (const U8*)SvPV_const(sv, len);
5330 if ((I32)len < *offsetp)
5331 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5333 const U8* send = s + *offsetp;
5335 STRLEN *cache = NULL;
5339 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5340 mg = mg_find(sv, PERL_MAGIC_utf8);
5341 if (mg && mg->mg_ptr) {
5342 cache = (STRLEN *) mg->mg_ptr;
5343 if (cache[1] == (STRLEN)*offsetp) {
5344 /* An exact match. */
5345 *offsetp = cache[0];
5349 else if (cache[1] < (STRLEN)*offsetp) {
5350 /* We already know part of the way. */
5353 /* Let the below loop do the rest. */
5355 else { /* cache[1] > *offsetp */
5356 /* We already know all of the way, now we may
5357 * be able to walk back. The same assumption
5358 * is made as in S_utf8_mg_pos(), namely that
5359 * walking backward is twice slower than
5360 * walking forward. */
5361 const STRLEN forw = *offsetp;
5362 STRLEN backw = cache[1] - *offsetp;
5364 if (!(forw < 2 * backw)) {
5365 const U8 *p = s + cache[1];
5372 while (UTF8_IS_CONTINUATION(*p)) {
5380 *offsetp = cache[0];
5382 /* Drop the stale "length" cache */
5390 ASSERT_UTF8_CACHE(cache);
5396 /* Call utf8n_to_uvchr() to validate the sequence
5397 * (unless a simple non-UTF character) */
5398 if (!UTF8_IS_INVARIANT(*s))
5399 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5408 if (!SvREADONLY(sv)) {
5410 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5411 mg = mg_find(sv, PERL_MAGIC_utf8);
5416 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5417 mg->mg_ptr = (char *) cache;
5422 cache[1] = *offsetp;
5423 /* Drop the stale "length" cache */
5436 Returns a boolean indicating whether the strings in the two SVs are
5437 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5438 coerce its args to strings if necessary.
5444 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5453 SV* svrecode = Nullsv;
5460 pv1 = SvPV_const(sv1, cur1);
5467 pv2 = SvPV_const(sv2, cur2);
5469 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5470 /* Differing utf8ness.
5471 * Do not UTF8size the comparands as a side-effect. */
5474 svrecode = newSVpvn(pv2, cur2);
5475 sv_recode_to_utf8(svrecode, PL_encoding);
5476 pv2 = SvPV_const(svrecode, cur2);
5479 svrecode = newSVpvn(pv1, cur1);
5480 sv_recode_to_utf8(svrecode, PL_encoding);
5481 pv1 = SvPV_const(svrecode, cur1);
5483 /* Now both are in UTF-8. */
5485 SvREFCNT_dec(svrecode);
5490 bool is_utf8 = TRUE;
5493 /* sv1 is the UTF-8 one,
5494 * if is equal it must be downgrade-able */
5495 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5501 /* sv2 is the UTF-8 one,
5502 * if is equal it must be downgrade-able */
5503 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5509 /* Downgrade not possible - cannot be eq */
5517 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5520 SvREFCNT_dec(svrecode);
5531 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5532 string in C<sv1> is less than, equal to, or greater than the string in
5533 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5534 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5540 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5544 const char *pv1, *pv2;
5547 SV *svrecode = Nullsv;
5554 pv1 = SvPV_const(sv1, cur1);
5561 pv2 = SvPV_const(sv2, cur2);
5563 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5564 /* Differing utf8ness.
5565 * Do not UTF8size the comparands as a side-effect. */
5568 svrecode = newSVpvn(pv2, cur2);
5569 sv_recode_to_utf8(svrecode, PL_encoding);
5570 pv2 = SvPV_const(svrecode, cur2);
5573 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5578 svrecode = newSVpvn(pv1, cur1);
5579 sv_recode_to_utf8(svrecode, PL_encoding);
5580 pv1 = SvPV_const(svrecode, cur1);
5583 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5589 cmp = cur2 ? -1 : 0;
5593 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5596 cmp = retval < 0 ? -1 : 1;
5597 } else if (cur1 == cur2) {
5600 cmp = cur1 < cur2 ? -1 : 1;
5605 SvREFCNT_dec(svrecode);
5614 =for apidoc sv_cmp_locale
5616 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5617 'use bytes' aware, handles get magic, and will coerce its args to strings
5618 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5624 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5627 #ifdef USE_LOCALE_COLLATE
5633 if (PL_collation_standard)
5637 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5639 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5641 if (!pv1 || !len1) {
5652 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5655 return retval < 0 ? -1 : 1;
5658 * When the result of collation is equality, that doesn't mean
5659 * that there are no differences -- some locales exclude some
5660 * characters from consideration. So to avoid false equalities,
5661 * we use the raw string as a tiebreaker.
5667 #endif /* USE_LOCALE_COLLATE */
5669 return sv_cmp(sv1, sv2);
5673 #ifdef USE_LOCALE_COLLATE
5676 =for apidoc sv_collxfrm
5678 Add Collate Transform magic to an SV if it doesn't already have it.
5680 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5681 scalar data of the variable, but transformed to such a format that a normal
5682 memory comparison can be used to compare the data according to the locale
5689 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5694 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5695 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5701 Safefree(mg->mg_ptr);
5702 s = SvPV_const(sv, len);
5703 if ((xf = mem_collxfrm(s, len, &xlen))) {
5704 if (SvREADONLY(sv)) {
5707 return xf + sizeof(PL_collation_ix);
5710 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5711 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5724 if (mg && mg->mg_ptr) {
5726 return mg->mg_ptr + sizeof(PL_collation_ix);
5734 #endif /* USE_LOCALE_COLLATE */
5739 Get a line from the filehandle and store it into the SV, optionally
5740 appending to the currently-stored string.
5746 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5751 register STDCHAR rslast;
5752 register STDCHAR *bp;
5758 if (SvTHINKFIRST(sv))
5759 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5760 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5762 However, perlbench says it's slower, because the existing swipe code
5763 is faster than copy on write.
5764 Swings and roundabouts. */
5765 SvUPGRADE(sv, SVt_PV);
5770 if (PerlIO_isutf8(fp)) {
5772 sv_utf8_upgrade_nomg(sv);
5773 sv_pos_u2b(sv,&append,0);
5775 } else if (SvUTF8(sv)) {
5776 SV * const tsv = newSV(0);
5777 sv_gets(tsv, fp, 0);
5778 sv_utf8_upgrade_nomg(tsv);
5779 SvCUR_set(sv,append);
5782 goto return_string_or_null;
5787 if (PerlIO_isutf8(fp))
5790 if (IN_PERL_COMPILETIME) {
5791 /* we always read code in line mode */
5795 else if (RsSNARF(PL_rs)) {
5796 /* If it is a regular disk file use size from stat() as estimate
5797 of amount we are going to read - may result in malloc-ing
5798 more memory than we realy need if layers bellow reduce
5799 size we read (e.g. CRLF or a gzip layer)
5802 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5803 const Off_t offset = PerlIO_tell(fp);
5804 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5805 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5811 else if (RsRECORD(PL_rs)) {
5815 /* Grab the size of the record we're getting */
5816 recsize = SvIV(SvRV(PL_rs));
5817 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5820 /* VMS wants read instead of fread, because fread doesn't respect */
5821 /* RMS record boundaries. This is not necessarily a good thing to be */
5822 /* doing, but we've got no other real choice - except avoid stdio
5823 as implementation - perhaps write a :vms layer ?
5825 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5827 bytesread = PerlIO_read(fp, buffer, recsize);
5831 SvCUR_set(sv, bytesread += append);
5832 buffer[bytesread] = '\0';
5833 goto return_string_or_null;
5835 else if (RsPARA(PL_rs)) {
5841 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5842 if (PerlIO_isutf8(fp)) {
5843 rsptr = SvPVutf8(PL_rs, rslen);
5846 if (SvUTF8(PL_rs)) {
5847 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5848 Perl_croak(aTHX_ "Wide character in $/");
5851 rsptr = SvPV_const(PL_rs, rslen);
5855 rslast = rslen ? rsptr[rslen - 1] : '\0';
5857 if (rspara) { /* have to do this both before and after */
5858 do { /* to make sure file boundaries work right */
5861 i = PerlIO_getc(fp);
5865 PerlIO_ungetc(fp,i);
5871 /* See if we know enough about I/O mechanism to cheat it ! */
5873 /* This used to be #ifdef test - it is made run-time test for ease
5874 of abstracting out stdio interface. One call should be cheap
5875 enough here - and may even be a macro allowing compile
5879 if (PerlIO_fast_gets(fp)) {
5882 * We're going to steal some values from the stdio struct
5883 * and put EVERYTHING in the innermost loop into registers.
5885 register STDCHAR *ptr;
5889 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5890 /* An ungetc()d char is handled separately from the regular
5891 * buffer, so we getc() it back out and stuff it in the buffer.
5893 i = PerlIO_getc(fp);
5894 if (i == EOF) return 0;
5895 *(--((*fp)->_ptr)) = (unsigned char) i;
5899 /* Here is some breathtakingly efficient cheating */
5901 cnt = PerlIO_get_cnt(fp); /* get count into register */
5902 /* make sure we have the room */
5903 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5904 /* Not room for all of it
5905 if we are looking for a separator and room for some
5907 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5908 /* just process what we have room for */
5909 shortbuffered = cnt - SvLEN(sv) + append + 1;
5910 cnt -= shortbuffered;
5914 /* remember that cnt can be negative */
5915 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5920 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5921 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5922 DEBUG_P(PerlIO_printf(Perl_debug_log,
5923 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5924 DEBUG_P(PerlIO_printf(Perl_debug_log,
5925 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5926 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5927 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5932 while (cnt > 0) { /* this | eat */
5934 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5935 goto thats_all_folks; /* screams | sed :-) */
5939 Copy(ptr, bp, cnt, char); /* this | eat */
5940 bp += cnt; /* screams | dust */
5941 ptr += cnt; /* louder | sed :-) */
5946 if (shortbuffered) { /* oh well, must extend */
5947 cnt = shortbuffered;
5949 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5951 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5952 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5956 DEBUG_P(PerlIO_printf(Perl_debug_log,
5957 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5958 PTR2UV(ptr),(long)cnt));
5959 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5961 DEBUG_P(PerlIO_printf(Perl_debug_log,
5962 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5963 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5964 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5966 /* This used to call 'filbuf' in stdio form, but as that behaves like
5967 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5968 another abstraction. */
5969 i = PerlIO_getc(fp); /* get more characters */
5971 DEBUG_P(PerlIO_printf(Perl_debug_log,
5972 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5973 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5974 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5976 cnt = PerlIO_get_cnt(fp);
5977 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5978 DEBUG_P(PerlIO_printf(Perl_debug_log,
5979 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5981 if (i == EOF) /* all done for ever? */
5982 goto thats_really_all_folks;
5984 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5986 SvGROW(sv, bpx + cnt + 2);
5987 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5989 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5991 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5992 goto thats_all_folks;
5996 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5997 memNE((char*)bp - rslen, rsptr, rslen))
5998 goto screamer; /* go back to the fray */
5999 thats_really_all_folks:
6001 cnt += shortbuffered;
6002 DEBUG_P(PerlIO_printf(Perl_debug_log,
6003 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6004 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6005 DEBUG_P(PerlIO_printf(Perl_debug_log,
6006 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6007 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6008 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6010 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6011 DEBUG_P(PerlIO_printf(Perl_debug_log,
6012 "Screamer: done, len=%ld, string=|%.*s|\n",
6013 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6017 /*The big, slow, and stupid way. */
6018 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6019 STDCHAR *buf = NULL;
6020 Newx(buf, 8192, STDCHAR);
6028 register const STDCHAR * const bpe = buf + sizeof(buf);
6030 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6031 ; /* keep reading */
6035 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6036 /* Accomodate broken VAXC compiler, which applies U8 cast to
6037 * both args of ?: operator, causing EOF to change into 255
6040 i = (U8)buf[cnt - 1];
6046 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6048 sv_catpvn(sv, (char *) buf, cnt);
6050 sv_setpvn(sv, (char *) buf, cnt);
6052 if (i != EOF && /* joy */
6054 SvCUR(sv) < rslen ||
6055 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6059 * If we're reading from a TTY and we get a short read,
6060 * indicating that the user hit his EOF character, we need
6061 * to notice it now, because if we try to read from the TTY
6062 * again, the EOF condition will disappear.
6064 * The comparison of cnt to sizeof(buf) is an optimization
6065 * that prevents unnecessary calls to feof().
6069 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6073 #ifdef USE_HEAP_INSTEAD_OF_STACK
6078 if (rspara) { /* have to do this both before and after */
6079 while (i != EOF) { /* to make sure file boundaries work right */
6080 i = PerlIO_getc(fp);
6082 PerlIO_ungetc(fp,i);
6088 return_string_or_null:
6089 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6095 Auto-increment of the value in the SV, doing string to numeric conversion
6096 if necessary. Handles 'get' magic.
6102 Perl_sv_inc(pTHX_ register SV *sv)
6111 if (SvTHINKFIRST(sv)) {
6113 sv_force_normal_flags(sv, 0);
6114 if (SvREADONLY(sv)) {
6115 if (IN_PERL_RUNTIME)
6116 Perl_croak(aTHX_ PL_no_modify);
6120 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6122 i = PTR2IV(SvRV(sv));
6127 flags = SvFLAGS(sv);
6128 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6129 /* It's (privately or publicly) a float, but not tested as an
6130 integer, so test it to see. */
6132 flags = SvFLAGS(sv);
6134 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6135 /* It's publicly an integer, or privately an integer-not-float */
6136 #ifdef PERL_PRESERVE_IVUV
6140 if (SvUVX(sv) == UV_MAX)
6141 sv_setnv(sv, UV_MAX_P1);
6143 (void)SvIOK_only_UV(sv);
6144 SvUV_set(sv, SvUVX(sv) + 1);
6146 if (SvIVX(sv) == IV_MAX)
6147 sv_setuv(sv, (UV)IV_MAX + 1);
6149 (void)SvIOK_only(sv);
6150 SvIV_set(sv, SvIVX(sv) + 1);
6155 if (flags & SVp_NOK) {
6156 (void)SvNOK_only(sv);
6157 SvNV_set(sv, SvNVX(sv) + 1.0);
6161 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6162 if ((flags & SVTYPEMASK) < SVt_PVIV)
6163 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6164 (void)SvIOK_only(sv);
6169 while (isALPHA(*d)) d++;
6170 while (isDIGIT(*d)) d++;
6172 #ifdef PERL_PRESERVE_IVUV
6173 /* Got to punt this as an integer if needs be, but we don't issue
6174 warnings. Probably ought to make the sv_iv_please() that does
6175 the conversion if possible, and silently. */
6176 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6177 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6178 /* Need to try really hard to see if it's an integer.
6179 9.22337203685478e+18 is an integer.
6180 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6181 so $a="9.22337203685478e+18"; $a+0; $a++
6182 needs to be the same as $a="9.22337203685478e+18"; $a++
6189 /* sv_2iv *should* have made this an NV */
6190 if (flags & SVp_NOK) {
6191 (void)SvNOK_only(sv);
6192 SvNV_set(sv, SvNVX(sv) + 1.0);
6195 /* I don't think we can get here. Maybe I should assert this
6196 And if we do get here I suspect that sv_setnv will croak. NWC
6198 #if defined(USE_LONG_DOUBLE)
6199 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",
6200 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6202 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6203 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6206 #endif /* PERL_PRESERVE_IVUV */
6207 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6211 while (d >= SvPVX_const(sv)) {
6219 /* MKS: The original code here died if letters weren't consecutive.
6220 * at least it didn't have to worry about non-C locales. The
6221 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6222 * arranged in order (although not consecutively) and that only
6223 * [A-Za-z] are accepted by isALPHA in the C locale.
6225 if (*d != 'z' && *d != 'Z') {
6226 do { ++*d; } while (!isALPHA(*d));
6229 *(d--) -= 'z' - 'a';
6234 *(d--) -= 'z' - 'a' + 1;
6238 /* oh,oh, the number grew */
6239 SvGROW(sv, SvCUR(sv) + 2);
6240 SvCUR_set(sv, SvCUR(sv) + 1);
6241 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6252 Auto-decrement of the value in the SV, doing string to numeric conversion
6253 if necessary. Handles 'get' magic.
6259 Perl_sv_dec(pTHX_ register SV *sv)
6267 if (SvTHINKFIRST(sv)) {
6269 sv_force_normal_flags(sv, 0);
6270 if (SvREADONLY(sv)) {
6271 if (IN_PERL_RUNTIME)
6272 Perl_croak(aTHX_ PL_no_modify);
6276 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6278 i = PTR2IV(SvRV(sv));
6283 /* Unlike sv_inc we don't have to worry about string-never-numbers
6284 and keeping them magic. But we mustn't warn on punting */
6285 flags = SvFLAGS(sv);
6286 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6287 /* It's publicly an integer, or privately an integer-not-float */
6288 #ifdef PERL_PRESERVE_IVUV
6292 if (SvUVX(sv) == 0) {
6293 (void)SvIOK_only(sv);
6297 (void)SvIOK_only_UV(sv);
6298 SvUV_set(sv, SvUVX(sv) - 1);
6301 if (SvIVX(sv) == IV_MIN)
6302 sv_setnv(sv, (NV)IV_MIN - 1.0);
6304 (void)SvIOK_only(sv);
6305 SvIV_set(sv, SvIVX(sv) - 1);
6310 if (flags & SVp_NOK) {
6311 SvNV_set(sv, SvNVX(sv) - 1.0);
6312 (void)SvNOK_only(sv);
6315 if (!(flags & SVp_POK)) {
6316 if ((flags & SVTYPEMASK) < SVt_PVIV)
6317 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6319 (void)SvIOK_only(sv);
6322 #ifdef PERL_PRESERVE_IVUV
6324 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6325 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6326 /* Need to try really hard to see if it's an integer.
6327 9.22337203685478e+18 is an integer.
6328 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6329 so $a="9.22337203685478e+18"; $a+0; $a--
6330 needs to be the same as $a="9.22337203685478e+18"; $a--
6337 /* sv_2iv *should* have made this an NV */
6338 if (flags & SVp_NOK) {
6339 (void)SvNOK_only(sv);
6340 SvNV_set(sv, SvNVX(sv) - 1.0);
6343 /* I don't think we can get here. Maybe I should assert this
6344 And if we do get here I suspect that sv_setnv will croak. NWC
6346 #if defined(USE_LONG_DOUBLE)
6347 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",
6348 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6350 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6351 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6355 #endif /* PERL_PRESERVE_IVUV */
6356 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6360 =for apidoc sv_mortalcopy
6362 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6363 The new SV is marked as mortal. It will be destroyed "soon", either by an
6364 explicit call to FREETMPS, or by an implicit call at places such as
6365 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6370 /* Make a string that will exist for the duration of the expression
6371 * evaluation. Actually, it may have to last longer than that, but
6372 * hopefully we won't free it until it has been assigned to a
6373 * permanent location. */
6376 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6382 sv_setsv(sv,oldstr);
6384 PL_tmps_stack[++PL_tmps_ix] = sv;
6390 =for apidoc sv_newmortal
6392 Creates a new null SV which is mortal. The reference count of the SV is
6393 set to 1. It will be destroyed "soon", either by an explicit call to
6394 FREETMPS, or by an implicit call at places such as statement boundaries.
6395 See also C<sv_mortalcopy> and C<sv_2mortal>.
6401 Perl_sv_newmortal(pTHX)
6407 SvFLAGS(sv) = SVs_TEMP;
6409 PL_tmps_stack[++PL_tmps_ix] = sv;
6414 =for apidoc sv_2mortal
6416 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6417 by an explicit call to FREETMPS, or by an implicit call at places such as
6418 statement boundaries. SvTEMP() is turned on which means that the SV's
6419 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6420 and C<sv_mortalcopy>.
6426 Perl_sv_2mortal(pTHX_ register SV *sv)
6431 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6434 PL_tmps_stack[++PL_tmps_ix] = sv;
6442 Creates a new SV and copies a string into it. The reference count for the
6443 SV is set to 1. If C<len> is zero, Perl will compute the length using
6444 strlen(). For efficiency, consider using C<newSVpvn> instead.
6450 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6456 sv_setpvn(sv,s,len ? len : strlen(s));
6461 =for apidoc newSVpvn
6463 Creates a new SV and copies a string into it. The reference count for the
6464 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6465 string. You are responsible for ensuring that the source string is at least
6466 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6472 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6478 sv_setpvn(sv,s,len);
6484 =for apidoc newSVhek
6486 Creates a new SV from the hash key structure. It will generate scalars that
6487 point to the shared string table where possible. Returns a new (undefined)
6488 SV if the hek is NULL.
6494 Perl_newSVhek(pTHX_ const HEK *hek)
6504 if (HEK_LEN(hek) == HEf_SVKEY) {
6505 return newSVsv(*(SV**)HEK_KEY(hek));
6507 const int flags = HEK_FLAGS(hek);
6508 if (flags & HVhek_WASUTF8) {
6510 Andreas would like keys he put in as utf8 to come back as utf8
6512 STRLEN utf8_len = HEK_LEN(hek);
6513 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6514 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6517 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6519 } else if (flags & HVhek_REHASH) {
6520 /* We don't have a pointer to the hv, so we have to replicate the
6521 flag into every HEK. This hv is using custom a hasing
6522 algorithm. Hence we can't return a shared string scalar, as
6523 that would contain the (wrong) hash value, and might get passed
6524 into an hv routine with a regular hash */
6526 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6531 /* This will be overwhelminly the most common case. */
6532 return newSVpvn_share(HEK_KEY(hek),
6533 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6539 =for apidoc newSVpvn_share
6541 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6542 table. If the string does not already exist in the table, it is created
6543 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6544 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6545 otherwise the hash is computed. The idea here is that as the string table
6546 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6547 hash lookup will avoid string compare.
6553 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6557 bool is_utf8 = FALSE;
6559 STRLEN tmplen = -len;
6561 /* See the note in hv.c:hv_fetch() --jhi */
6562 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6566 PERL_HASH(hash, src, len);
6568 sv_upgrade(sv, SVt_PV);
6569 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6581 #if defined(PERL_IMPLICIT_CONTEXT)
6583 /* pTHX_ magic can't cope with varargs, so this is a no-context
6584 * version of the main function, (which may itself be aliased to us).
6585 * Don't access this version directly.
6589 Perl_newSVpvf_nocontext(const char* pat, ...)
6594 va_start(args, pat);
6595 sv = vnewSVpvf(pat, &args);
6602 =for apidoc newSVpvf
6604 Creates a new SV and initializes it with the string formatted like
6611 Perl_newSVpvf(pTHX_ const char* pat, ...)
6615 va_start(args, pat);
6616 sv = vnewSVpvf(pat, &args);
6621 /* backend for newSVpvf() and newSVpvf_nocontext() */
6624 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6629 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6636 Creates a new SV and copies a floating point value into it.
6637 The reference count for the SV is set to 1.
6643 Perl_newSVnv(pTHX_ NV n)
6656 Creates a new SV and copies an integer into it. The reference count for the
6663 Perl_newSViv(pTHX_ IV i)
6676 Creates a new SV and copies an unsigned integer into it.
6677 The reference count for the SV is set to 1.
6683 Perl_newSVuv(pTHX_ UV u)
6694 =for apidoc newRV_noinc
6696 Creates an RV wrapper for an SV. The reference count for the original
6697 SV is B<not> incremented.
6703 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6709 sv_upgrade(sv, SVt_RV);
6711 SvRV_set(sv, tmpRef);
6716 /* newRV_inc is the official function name to use now.
6717 * newRV_inc is in fact #defined to newRV in sv.h
6721 Perl_newRV(pTHX_ SV *tmpRef)
6724 return newRV_noinc(SvREFCNT_inc(tmpRef));
6730 Creates a new SV which is an exact duplicate of the original SV.
6737 Perl_newSVsv(pTHX_ register SV *old)
6744 if (SvTYPE(old) == SVTYPEMASK) {
6745 if (ckWARN_d(WARN_INTERNAL))
6746 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6750 /* SV_GMAGIC is the default for sv_setv()
6751 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6752 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6753 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6758 =for apidoc sv_reset
6760 Underlying implementation for the C<reset> Perl function.
6761 Note that the perl-level function is vaguely deprecated.
6767 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6770 char todo[PERL_UCHAR_MAX+1];
6775 if (!*s) { /* reset ?? searches */
6776 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6778 PMOP *pm = (PMOP *) mg->mg_obj;
6780 pm->op_pmdynflags &= ~PMdf_USED;
6787 /* reset variables */
6789 if (!HvARRAY(stash))
6792 Zero(todo, 256, char);
6795 I32 i = (unsigned char)*s;
6799 max = (unsigned char)*s++;
6800 for ( ; i <= max; i++) {
6803 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6805 for (entry = HvARRAY(stash)[i];
6807 entry = HeNEXT(entry))
6812 if (!todo[(U8)*HeKEY(entry)])
6814 gv = (GV*)HeVAL(entry);
6817 if (SvTHINKFIRST(sv)) {
6818 if (!SvREADONLY(sv) && SvROK(sv))
6820 /* XXX Is this continue a bug? Why should THINKFIRST
6821 exempt us from resetting arrays and hashes? */
6825 if (SvTYPE(sv) >= SVt_PV) {
6827 if (SvPVX_const(sv) != Nullch)
6835 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6837 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6840 # if defined(USE_ENVIRON_ARRAY)
6843 # endif /* USE_ENVIRON_ARRAY */
6854 Using various gambits, try to get an IO from an SV: the IO slot if its a
6855 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6856 named after the PV if we're a string.
6862 Perl_sv_2io(pTHX_ SV *sv)
6867 switch (SvTYPE(sv)) {
6875 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6879 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6881 return sv_2io(SvRV(sv));
6882 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6888 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6897 Using various gambits, try to get a CV from an SV; in addition, try if
6898 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6899 The flags in C<lref> are passed to sv_fetchsv.
6905 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6912 return *st = NULL, *gvp = Nullgv, Nullcv;
6913 switch (SvTYPE(sv)) {
6932 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6933 tryAMAGICunDEREF(to_cv);
6936 if (SvTYPE(sv) == SVt_PVCV) {
6945 Perl_croak(aTHX_ "Not a subroutine reference");
6950 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6956 /* Some flags to gv_fetchsv mean don't really create the GV */
6957 if (SvTYPE(gv) != SVt_PVGV) {
6963 if (lref && !GvCVu(gv)) {
6967 gv_efullname3(tmpsv, gv, Nullch);
6968 /* XXX this is probably not what they think they're getting.
6969 * It has the same effect as "sub name;", i.e. just a forward
6971 newSUB(start_subparse(FALSE, 0),
6972 newSVOP(OP_CONST, 0, tmpsv),
6977 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6987 Returns true if the SV has a true value by Perl's rules.
6988 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6989 instead use an in-line version.
6995 Perl_sv_true(pTHX_ register SV *sv)
7000 register const XPV* const tXpv = (XPV*)SvANY(sv);
7002 (tXpv->xpv_cur > 1 ||
7003 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7010 return SvIVX(sv) != 0;
7013 return SvNVX(sv) != 0.0;
7015 return sv_2bool(sv);
7021 =for apidoc sv_pvn_force
7023 Get a sensible string out of the SV somehow.
7024 A private implementation of the C<SvPV_force> macro for compilers which
7025 can't cope with complex macro expressions. Always use the macro instead.
7027 =for apidoc sv_pvn_force_flags
7029 Get a sensible string out of the SV somehow.
7030 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7031 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7032 implemented in terms of this function.
7033 You normally want to use the various wrapper macros instead: see
7034 C<SvPV_force> and C<SvPV_force_nomg>
7040 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7043 if (SvTHINKFIRST(sv) && !SvROK(sv))
7044 sv_force_normal_flags(sv, 0);
7054 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7055 const char * const ref = sv_reftype(sv,0);
7057 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7058 ref, OP_NAME(PL_op));
7060 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7062 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7063 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7065 s = sv_2pv_flags(sv, &len, flags);
7069 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7072 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7073 SvGROW(sv, len + 1);
7074 Move(s,SvPVX(sv),len,char);
7079 SvPOK_on(sv); /* validate pointer */
7081 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7082 PTR2UV(sv),SvPVX_const(sv)));
7085 return SvPVX_mutable(sv);
7089 =for apidoc sv_pvbyten_force
7091 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7097 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7099 sv_pvn_force(sv,lp);
7100 sv_utf8_downgrade(sv,0);
7106 =for apidoc sv_pvutf8n_force
7108 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7114 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7116 sv_pvn_force(sv,lp);
7117 sv_utf8_upgrade(sv);
7123 =for apidoc sv_reftype
7125 Returns a string describing what the SV is a reference to.
7131 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7133 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7134 inside return suggests a const propagation bug in g++. */
7135 if (ob && SvOBJECT(sv)) {
7136 char * const name = HvNAME_get(SvSTASH(sv));
7137 return name ? name : (char *) "__ANON__";
7140 switch (SvTYPE(sv)) {
7157 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7158 /* tied lvalues should appear to be
7159 * scalars for backwards compatitbility */
7160 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7161 ? "SCALAR" : "LVALUE");
7162 case SVt_PVAV: return "ARRAY";
7163 case SVt_PVHV: return "HASH";
7164 case SVt_PVCV: return "CODE";
7165 case SVt_PVGV: return "GLOB";
7166 case SVt_PVFM: return "FORMAT";
7167 case SVt_PVIO: return "IO";
7168 default: return "UNKNOWN";
7174 =for apidoc sv_isobject
7176 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7177 object. If the SV is not an RV, or if the object is not blessed, then this
7184 Perl_sv_isobject(pTHX_ SV *sv)
7200 Returns a boolean indicating whether the SV is blessed into the specified
7201 class. This does not check for subtypes; use C<sv_derived_from> to verify
7202 an inheritance relationship.
7208 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7219 hvname = HvNAME_get(SvSTASH(sv));
7223 return strEQ(hvname, name);
7229 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7230 it will be upgraded to one. If C<classname> is non-null then the new SV will
7231 be blessed in the specified package. The new SV is returned and its
7232 reference count is 1.
7238 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7245 SV_CHECK_THINKFIRST_COW_DROP(rv);
7248 if (SvTYPE(rv) >= SVt_PVMG) {
7249 const U32 refcnt = SvREFCNT(rv);
7253 SvREFCNT(rv) = refcnt;
7256 if (SvTYPE(rv) < SVt_RV)
7257 sv_upgrade(rv, SVt_RV);
7258 else if (SvTYPE(rv) > SVt_RV) {
7269 HV* const stash = gv_stashpv(classname, TRUE);
7270 (void)sv_bless(rv, stash);
7276 =for apidoc sv_setref_pv
7278 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7279 argument will be upgraded to an RV. That RV will be modified to point to
7280 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7281 into the SV. The C<classname> argument indicates the package for the
7282 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7283 will have a reference count of 1, and the RV will be returned.
7285 Do not use with other Perl types such as HV, AV, SV, CV, because those
7286 objects will become corrupted by the pointer copy process.
7288 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7294 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7298 sv_setsv(rv, &PL_sv_undef);
7302 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7307 =for apidoc sv_setref_iv
7309 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7310 argument will be upgraded to an RV. That RV will be modified to point to
7311 the new SV. The C<classname> argument indicates the package for the
7312 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7313 will have a reference count of 1, and the RV will be returned.
7319 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7321 sv_setiv(newSVrv(rv,classname), iv);
7326 =for apidoc sv_setref_uv
7328 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7329 argument will be upgraded to an RV. That RV will be modified to point to
7330 the new SV. The C<classname> argument indicates the package for the
7331 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7332 will have a reference count of 1, and the RV will be returned.
7338 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7340 sv_setuv(newSVrv(rv,classname), uv);
7345 =for apidoc sv_setref_nv
7347 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7348 argument will be upgraded to an RV. That RV will be modified to point to
7349 the new SV. The C<classname> argument indicates the package for the
7350 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7351 will have a reference count of 1, and the RV will be returned.
7357 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7359 sv_setnv(newSVrv(rv,classname), nv);
7364 =for apidoc sv_setref_pvn
7366 Copies a string into a new SV, optionally blessing the SV. The length of the
7367 string must be specified with C<n>. The C<rv> argument will be upgraded to
7368 an RV. That RV will be modified to point to the new SV. The C<classname>
7369 argument indicates the package for the blessing. Set C<classname> to
7370 C<Nullch> to avoid the blessing. The new SV will have a reference count
7371 of 1, and the RV will be returned.
7373 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7379 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7381 sv_setpvn(newSVrv(rv,classname), pv, n);
7386 =for apidoc sv_bless
7388 Blesses an SV into a specified package. The SV must be an RV. The package
7389 must be designated by its stash (see C<gv_stashpv()>). The reference count
7390 of the SV is unaffected.
7396 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7401 Perl_croak(aTHX_ "Can't bless non-reference value");
7403 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7404 if (SvREADONLY(tmpRef))
7405 Perl_croak(aTHX_ PL_no_modify);
7406 if (SvOBJECT(tmpRef)) {
7407 if (SvTYPE(tmpRef) != SVt_PVIO)
7409 SvREFCNT_dec(SvSTASH(tmpRef));
7412 SvOBJECT_on(tmpRef);
7413 if (SvTYPE(tmpRef) != SVt_PVIO)
7415 SvUPGRADE(tmpRef, SVt_PVMG);
7416 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7423 if(SvSMAGICAL(tmpRef))
7424 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7432 /* Downgrades a PVGV to a PVMG.
7436 S_sv_unglob(pTHX_ SV *sv)
7441 assert(SvTYPE(sv) == SVt_PVGV);
7446 sv_del_backref((SV*)GvSTASH(sv), sv);
7449 sv_unmagic(sv, PERL_MAGIC_glob);
7450 Safefree(GvNAME(sv));
7453 /* need to keep SvANY(sv) in the right arena */
7454 xpvmg = new_XPVMG();
7455 StructCopy(SvANY(sv), xpvmg, XPVMG);
7456 del_XPVGV(SvANY(sv));
7459 SvFLAGS(sv) &= ~SVTYPEMASK;
7460 SvFLAGS(sv) |= SVt_PVMG;
7464 =for apidoc sv_unref_flags
7466 Unsets the RV status of the SV, and decrements the reference count of
7467 whatever was being referenced by the RV. This can almost be thought of
7468 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7469 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7470 (otherwise the decrementing is conditional on the reference count being
7471 different from one or the reference being a readonly SV).
7478 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7480 SV* const target = SvRV(ref);
7482 if (SvWEAKREF(ref)) {
7483 sv_del_backref(target, ref);
7485 SvRV_set(ref, NULL);
7488 SvRV_set(ref, NULL);
7490 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7491 assigned to as BEGIN {$a = \"Foo"} will fail. */
7492 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7493 SvREFCNT_dec(target);
7494 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7495 sv_2mortal(target); /* Schedule for freeing later */
7499 =for apidoc sv_untaint
7501 Untaint an SV. Use C<SvTAINTED_off> instead.
7506 Perl_sv_untaint(pTHX_ SV *sv)
7508 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7509 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7516 =for apidoc sv_tainted
7518 Test an SV for taintedness. Use C<SvTAINTED> instead.
7523 Perl_sv_tainted(pTHX_ SV *sv)
7525 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7526 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7527 if (mg && (mg->mg_len & 1) )
7534 =for apidoc sv_setpviv
7536 Copies an integer into the given SV, also updating its string value.
7537 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7543 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7545 char buf[TYPE_CHARS(UV)];
7547 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7549 sv_setpvn(sv, ptr, ebuf - ptr);
7553 =for apidoc sv_setpviv_mg
7555 Like C<sv_setpviv>, but also handles 'set' magic.
7561 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7567 #if defined(PERL_IMPLICIT_CONTEXT)
7569 /* pTHX_ magic can't cope with varargs, so this is a no-context
7570 * version of the main function, (which may itself be aliased to us).
7571 * Don't access this version directly.
7575 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7579 va_start(args, pat);
7580 sv_vsetpvf(sv, pat, &args);
7584 /* pTHX_ magic can't cope with varargs, so this is a no-context
7585 * version of the main function, (which may itself be aliased to us).
7586 * Don't access this version directly.
7590 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7594 va_start(args, pat);
7595 sv_vsetpvf_mg(sv, pat, &args);
7601 =for apidoc sv_setpvf
7603 Works like C<sv_catpvf> but copies the text into the SV instead of
7604 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7610 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7613 va_start(args, pat);
7614 sv_vsetpvf(sv, pat, &args);
7619 =for apidoc sv_vsetpvf
7621 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7622 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7624 Usually used via its frontend C<sv_setpvf>.
7630 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7632 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7636 =for apidoc sv_setpvf_mg
7638 Like C<sv_setpvf>, but also handles 'set' magic.
7644 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7647 va_start(args, pat);
7648 sv_vsetpvf_mg(sv, pat, &args);
7653 =for apidoc sv_vsetpvf_mg
7655 Like C<sv_vsetpvf>, but also handles 'set' magic.
7657 Usually used via its frontend C<sv_setpvf_mg>.
7663 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7665 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7669 #if defined(PERL_IMPLICIT_CONTEXT)
7671 /* pTHX_ magic can't cope with varargs, so this is a no-context
7672 * version of the main function, (which may itself be aliased to us).
7673 * Don't access this version directly.
7677 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7681 va_start(args, pat);
7682 sv_vcatpvf(sv, pat, &args);
7686 /* pTHX_ magic can't cope with varargs, so this is a no-context
7687 * version of the main function, (which may itself be aliased to us).
7688 * Don't access this version directly.
7692 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7696 va_start(args, pat);
7697 sv_vcatpvf_mg(sv, pat, &args);
7703 =for apidoc sv_catpvf
7705 Processes its arguments like C<sprintf> and appends the formatted
7706 output to an SV. If the appended data contains "wide" characters
7707 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7708 and characters >255 formatted with %c), the original SV might get
7709 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7710 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7711 valid UTF-8; if the original SV was bytes, the pattern should be too.
7716 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7719 va_start(args, pat);
7720 sv_vcatpvf(sv, pat, &args);
7725 =for apidoc sv_vcatpvf
7727 Processes its arguments like C<vsprintf> and appends the formatted output
7728 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7730 Usually used via its frontend C<sv_catpvf>.
7736 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7738 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7742 =for apidoc sv_catpvf_mg
7744 Like C<sv_catpvf>, but also handles 'set' magic.
7750 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7753 va_start(args, pat);
7754 sv_vcatpvf_mg(sv, pat, &args);
7759 =for apidoc sv_vcatpvf_mg
7761 Like C<sv_vcatpvf>, but also handles 'set' magic.
7763 Usually used via its frontend C<sv_catpvf_mg>.
7769 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7771 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7776 =for apidoc sv_vsetpvfn
7778 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7781 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7787 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7789 sv_setpvn(sv, "", 0);
7790 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7794 S_expect_number(pTHX_ char** pattern)
7798 switch (**pattern) {
7799 case '1': case '2': case '3':
7800 case '4': case '5': case '6':
7801 case '7': case '8': case '9':
7802 var = *(*pattern)++ - '0';
7803 while (isDIGIT(**pattern)) {
7804 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7806 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7814 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7816 const int neg = nv < 0;
7825 if (uv & 1 && uv == nv)
7826 uv--; /* Round to even */
7828 const unsigned dig = uv % 10;
7841 =for apidoc sv_vcatpvfn
7843 Processes its arguments like C<vsprintf> and appends the formatted output
7844 to an SV. Uses an array of SVs if the C style variable argument list is
7845 missing (NULL). When running with taint checks enabled, indicates via
7846 C<maybe_tainted> if results are untrustworthy (often due to the use of
7849 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7855 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7856 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7857 vec_utf8 = DO_UTF8(vecsv);
7859 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7862 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7870 static const char nullstr[] = "(null)";
7872 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7873 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7875 /* Times 4: a decimal digit takes more than 3 binary digits.
7876 * NV_DIG: mantissa takes than many decimal digits.
7877 * Plus 32: Playing safe. */
7878 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7879 /* large enough for "%#.#f" --chip */
7880 /* what about long double NVs? --jhi */
7882 PERL_UNUSED_ARG(maybe_tainted);
7884 /* no matter what, this is a string now */
7885 (void)SvPV_force(sv, origlen);
7887 /* special-case "", "%s", and "%-p" (SVf - see below) */
7890 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7892 const char * const s = va_arg(*args, char*);
7893 sv_catpv(sv, s ? s : nullstr);
7895 else if (svix < svmax) {
7896 sv_catsv(sv, *svargs);
7900 if (args && patlen == 3 && pat[0] == '%' &&
7901 pat[1] == '-' && pat[2] == 'p') {
7902 argsv = va_arg(*args, SV*);
7903 sv_catsv(sv, argsv);
7907 #ifndef USE_LONG_DOUBLE
7908 /* special-case "%.<number>[gf]" */
7909 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7910 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7911 unsigned digits = 0;
7915 while (*pp >= '0' && *pp <= '9')
7916 digits = 10 * digits + (*pp++ - '0');
7917 if (pp - pat == (int)patlen - 1) {
7925 /* Add check for digits != 0 because it seems that some
7926 gconverts are buggy in this case, and we don't yet have
7927 a Configure test for this. */
7928 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7929 /* 0, point, slack */
7930 Gconvert(nv, (int)digits, 0, ebuf);
7932 if (*ebuf) /* May return an empty string for digits==0 */
7935 } else if (!digits) {
7938 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7939 sv_catpvn(sv, p, l);
7945 #endif /* !USE_LONG_DOUBLE */
7947 if (!args && svix < svmax && DO_UTF8(*svargs))
7950 patend = (char*)pat + patlen;
7951 for (p = (char*)pat; p < patend; p = q) {
7954 bool vectorize = FALSE;
7955 bool vectorarg = FALSE;
7956 bool vec_utf8 = FALSE;
7962 bool has_precis = FALSE;
7964 const I32 osvix = svix;
7965 bool is_utf8 = FALSE; /* is this item utf8? */
7966 #ifdef HAS_LDBL_SPRINTF_BUG
7967 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7968 with sfio - Allen <allens@cpan.org> */
7969 bool fix_ldbl_sprintf_bug = FALSE;
7973 U8 utf8buf[UTF8_MAXBYTES+1];
7974 STRLEN esignlen = 0;
7976 const char *eptr = Nullch;
7979 const U8 *vecstr = Null(U8*);
7986 /* we need a long double target in case HAS_LONG_DOUBLE but
7989 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7997 const char *dotstr = ".";
7998 STRLEN dotstrlen = 1;
7999 I32 efix = 0; /* explicit format parameter index */
8000 I32 ewix = 0; /* explicit width index */
8001 I32 epix = 0; /* explicit precision index */
8002 I32 evix = 0; /* explicit vector index */
8003 bool asterisk = FALSE;
8005 /* echo everything up to the next format specification */
8006 for (q = p; q < patend && *q != '%'; ++q) ;
8008 if (has_utf8 && !pat_utf8)
8009 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8011 sv_catpvn(sv, p, q - p);
8018 We allow format specification elements in this order:
8019 \d+\$ explicit format parameter index
8021 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8022 0 flag (as above): repeated to allow "v02"
8023 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8024 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8026 [%bcdefginopsuxDFOUX] format (mandatory)
8031 As of perl5.9.3, printf format checking is on by default.
8032 Internally, perl uses %p formats to provide an escape to
8033 some extended formatting. This block deals with those
8034 extensions: if it does not match, (char*)q is reset and
8035 the normal format processing code is used.
8037 Currently defined extensions are:
8038 %p include pointer address (standard)
8039 %-p (SVf) include an SV (previously %_)
8040 %-<num>p include an SV with precision <num>
8041 %1p (VDf) include a v-string (as %vd)
8042 %<num>p reserved for future extensions
8044 Robin Barker 2005-07-14
8051 n = expect_number(&q);
8058 argsv = va_arg(*args, SV*);
8059 eptr = SvPVx_const(argsv, elen);
8065 else if (n == vdNUMBER) { /* VDf */
8072 if (ckWARN_d(WARN_INTERNAL))
8073 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8074 "internal %%<num>p might conflict with future printf extensions");
8080 if ( (width = expect_number(&q)) ) {
8121 if ( (ewix = expect_number(&q)) )
8130 if ((vectorarg = asterisk)) {
8143 width = expect_number(&q);
8149 vecsv = va_arg(*args, SV*);
8151 vecsv = (evix > 0 && evix <= svmax)
8152 ? svargs[evix-1] : &PL_sv_undef;
8154 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8156 dotstr = SvPV_const(vecsv, dotstrlen);
8157 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8158 bad with tied or overloaded values that return UTF8. */
8161 else if (has_utf8) {
8162 vecsv = sv_mortalcopy(vecsv);
8163 sv_utf8_upgrade(vecsv);
8164 dotstr = SvPV_const(vecsv, dotstrlen);
8171 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8172 vecsv = svargs[efix ? efix-1 : svix++];
8173 vecstr = (U8*)SvPV_const(vecsv,veclen);
8174 vec_utf8 = DO_UTF8(vecsv);
8176 /* if this is a version object, we need to convert
8177 * back into v-string notation and then let the
8178 * vectorize happen normally
8180 if (sv_derived_from(vecsv, "version")) {
8181 char *version = savesvpv(vecsv);
8182 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8183 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8184 "vector argument not supported with alpha versions");
8187 vecsv = sv_newmortal();
8188 /* scan_vstring is expected to be called during
8189 * tokenization, so we need to fake up the end
8190 * of the buffer for it
8192 PL_bufend = version + veclen;
8193 scan_vstring(version, vecsv);
8194 vecstr = (U8*)SvPV_const(vecsv, veclen);
8195 vec_utf8 = DO_UTF8(vecsv);
8207 i = va_arg(*args, int);
8209 i = (ewix ? ewix <= svmax : svix < svmax) ?
8210 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8212 width = (i < 0) ? -i : i;
8222 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8224 /* XXX: todo, support specified precision parameter */
8228 i = va_arg(*args, int);
8230 i = (ewix ? ewix <= svmax : svix < svmax)
8231 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8232 precis = (i < 0) ? 0 : i;
8237 precis = precis * 10 + (*q++ - '0');
8246 case 'I': /* Ix, I32x, and I64x */
8248 if (q[1] == '6' && q[2] == '4') {
8254 if (q[1] == '3' && q[2] == '2') {
8264 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8275 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8276 if (*(q + 1) == 'l') { /* lld, llf */
8302 if (!vectorize && !args) {
8304 const I32 i = efix-1;
8305 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8307 argsv = (svix >= 0 && svix < svmax)
8308 ? svargs[svix++] : &PL_sv_undef;
8319 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8321 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8323 eptr = (char*)utf8buf;
8324 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8338 eptr = va_arg(*args, char*);
8340 #ifdef MACOS_TRADITIONAL
8341 /* On MacOS, %#s format is used for Pascal strings */
8346 elen = strlen(eptr);
8348 eptr = (char *)nullstr;
8349 elen = sizeof nullstr - 1;
8353 eptr = SvPVx_const(argsv, elen);
8354 if (DO_UTF8(argsv)) {
8355 if (has_precis && precis < elen) {
8357 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8360 if (width) { /* fudge width (can't fudge elen) */
8361 width += elen - sv_len_utf8(argsv);
8368 if (has_precis && elen > precis)
8375 if (alt || vectorize)
8377 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8398 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8407 esignbuf[esignlen++] = plus;
8411 case 'h': iv = (short)va_arg(*args, int); break;
8412 case 'l': iv = va_arg(*args, long); break;
8413 case 'V': iv = va_arg(*args, IV); break;
8414 default: iv = va_arg(*args, int); break;
8416 case 'q': iv = va_arg(*args, Quad_t); break;
8421 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8423 case 'h': iv = (short)tiv; break;
8424 case 'l': iv = (long)tiv; break;
8426 default: iv = tiv; break;
8428 case 'q': iv = (Quad_t)tiv; break;
8432 if ( !vectorize ) /* we already set uv above */
8437 esignbuf[esignlen++] = plus;
8441 esignbuf[esignlen++] = '-';
8484 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8495 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8496 case 'l': uv = va_arg(*args, unsigned long); break;
8497 case 'V': uv = va_arg(*args, UV); break;
8498 default: uv = va_arg(*args, unsigned); break;
8500 case 'q': uv = va_arg(*args, Uquad_t); break;
8505 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8507 case 'h': uv = (unsigned short)tuv; break;
8508 case 'l': uv = (unsigned long)tuv; break;
8510 default: uv = tuv; break;
8512 case 'q': uv = (Uquad_t)tuv; break;
8519 char *ptr = ebuf + sizeof ebuf;
8525 p = (char*)((c == 'X')
8526 ? "0123456789ABCDEF" : "0123456789abcdef");
8532 esignbuf[esignlen++] = '0';
8533 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8541 if (alt && *ptr != '0')
8552 esignbuf[esignlen++] = '0';
8553 esignbuf[esignlen++] = 'b';
8556 default: /* it had better be ten or less */
8560 } while (uv /= base);
8563 elen = (ebuf + sizeof ebuf) - ptr;
8567 zeros = precis - elen;
8568 else if (precis == 0 && elen == 1 && *eptr == '0')
8574 /* FLOATING POINT */
8577 c = 'f'; /* maybe %F isn't supported here */
8585 /* This is evil, but floating point is even more evil */
8587 /* for SV-style calling, we can only get NV
8588 for C-style calling, we assume %f is double;
8589 for simplicity we allow any of %Lf, %llf, %qf for long double
8593 #if defined(USE_LONG_DOUBLE)
8597 /* [perl #20339] - we should accept and ignore %lf rather than die */
8601 #if defined(USE_LONG_DOUBLE)
8602 intsize = args ? 0 : 'q';
8606 #if defined(HAS_LONG_DOUBLE)
8615 /* now we need (long double) if intsize == 'q', else (double) */
8617 #if LONG_DOUBLESIZE > DOUBLESIZE
8619 va_arg(*args, long double) :
8620 va_arg(*args, double)
8622 va_arg(*args, double)
8627 if (c != 'e' && c != 'E') {
8629 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8630 will cast our (long double) to (double) */
8631 (void)Perl_frexp(nv, &i);
8632 if (i == PERL_INT_MIN)
8633 Perl_die(aTHX_ "panic: frexp");
8635 need = BIT_DIGITS(i);
8637 need += has_precis ? precis : 6; /* known default */
8642 #ifdef HAS_LDBL_SPRINTF_BUG
8643 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8644 with sfio - Allen <allens@cpan.org> */
8647 # define MY_DBL_MAX DBL_MAX
8648 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8649 # if DOUBLESIZE >= 8
8650 # define MY_DBL_MAX 1.7976931348623157E+308L
8652 # define MY_DBL_MAX 3.40282347E+38L
8656 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8657 # define MY_DBL_MAX_BUG 1L
8659 # define MY_DBL_MAX_BUG MY_DBL_MAX
8663 # define MY_DBL_MIN DBL_MIN
8664 # else /* XXX guessing! -Allen */
8665 # if DOUBLESIZE >= 8
8666 # define MY_DBL_MIN 2.2250738585072014E-308L
8668 # define MY_DBL_MIN 1.17549435E-38L
8672 if ((intsize == 'q') && (c == 'f') &&
8673 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8675 /* it's going to be short enough that
8676 * long double precision is not needed */
8678 if ((nv <= 0L) && (nv >= -0L))
8679 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8681 /* would use Perl_fp_class as a double-check but not
8682 * functional on IRIX - see perl.h comments */
8684 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8685 /* It's within the range that a double can represent */
8686 #if defined(DBL_MAX) && !defined(DBL_MIN)
8687 if ((nv >= ((long double)1/DBL_MAX)) ||
8688 (nv <= (-(long double)1/DBL_MAX)))
8690 fix_ldbl_sprintf_bug = TRUE;
8693 if (fix_ldbl_sprintf_bug == TRUE) {
8703 # undef MY_DBL_MAX_BUG
8706 #endif /* HAS_LDBL_SPRINTF_BUG */
8708 need += 20; /* fudge factor */
8709 if (PL_efloatsize < need) {
8710 Safefree(PL_efloatbuf);
8711 PL_efloatsize = need + 20; /* more fudge */
8712 Newx(PL_efloatbuf, PL_efloatsize, char);
8713 PL_efloatbuf[0] = '\0';
8716 if ( !(width || left || plus || alt) && fill != '0'
8717 && has_precis && intsize != 'q' ) { /* Shortcuts */
8718 /* See earlier comment about buggy Gconvert when digits,
8720 if ( c == 'g' && precis) {
8721 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8722 /* May return an empty string for digits==0 */
8723 if (*PL_efloatbuf) {
8724 elen = strlen(PL_efloatbuf);
8725 goto float_converted;
8727 } else if ( c == 'f' && !precis) {
8728 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8733 char *ptr = ebuf + sizeof ebuf;
8736 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8737 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8738 if (intsize == 'q') {
8739 /* Copy the one or more characters in a long double
8740 * format before the 'base' ([efgEFG]) character to
8741 * the format string. */
8742 static char const prifldbl[] = PERL_PRIfldbl;
8743 char const *p = prifldbl + sizeof(prifldbl) - 3;
8744 while (p >= prifldbl) { *--ptr = *p--; }
8749 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8754 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8766 /* No taint. Otherwise we are in the strange situation
8767 * where printf() taints but print($float) doesn't.
8769 #if defined(HAS_LONG_DOUBLE)
8770 elen = ((intsize == 'q')
8771 ? my_sprintf(PL_efloatbuf, ptr, nv)
8772 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8774 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8778 eptr = PL_efloatbuf;
8786 i = SvCUR(sv) - origlen;
8789 case 'h': *(va_arg(*args, short*)) = i; break;
8790 default: *(va_arg(*args, int*)) = i; break;
8791 case 'l': *(va_arg(*args, long*)) = i; break;
8792 case 'V': *(va_arg(*args, IV*)) = i; break;
8794 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8799 sv_setuv_mg(argsv, (UV)i);
8800 continue; /* not "break" */
8807 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8808 && ckWARN(WARN_PRINTF))
8810 SV * const msg = sv_newmortal();
8811 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8812 (PL_op->op_type == OP_PRTF) ? "" : "s");
8815 Perl_sv_catpvf(aTHX_ msg,
8816 "\"%%%c\"", c & 0xFF);
8818 Perl_sv_catpvf(aTHX_ msg,
8819 "\"%%\\%03"UVof"\"",
8822 sv_catpvs(msg, "end of string");
8823 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8826 /* output mangled stuff ... */
8832 /* ... right here, because formatting flags should not apply */
8833 SvGROW(sv, SvCUR(sv) + elen + 1);
8835 Copy(eptr, p, elen, char);
8838 SvCUR_set(sv, p - SvPVX_const(sv));
8840 continue; /* not "break" */
8843 /* calculate width before utf8_upgrade changes it */
8844 have = esignlen + zeros + elen;
8846 Perl_croak_nocontext(PL_memory_wrap);
8848 if (is_utf8 != has_utf8) {
8851 sv_utf8_upgrade(sv);
8854 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8855 sv_utf8_upgrade(nsv);
8856 eptr = SvPVX_const(nsv);
8859 SvGROW(sv, SvCUR(sv) + elen + 1);
8864 need = (have > width ? have : width);
8867 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8868 Perl_croak_nocontext(PL_memory_wrap);
8869 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8871 if (esignlen && fill == '0') {
8873 for (i = 0; i < (int)esignlen; i++)
8877 memset(p, fill, gap);
8880 if (esignlen && fill != '0') {
8882 for (i = 0; i < (int)esignlen; i++)
8887 for (i = zeros; i; i--)
8891 Copy(eptr, p, elen, char);
8895 memset(p, ' ', gap);
8900 Copy(dotstr, p, dotstrlen, char);
8904 vectorize = FALSE; /* done iterating over vecstr */
8911 SvCUR_set(sv, p - SvPVX_const(sv));
8919 /* =========================================================================
8921 =head1 Cloning an interpreter
8923 All the macros and functions in this section are for the private use of
8924 the main function, perl_clone().
8926 The foo_dup() functions make an exact copy of an existing foo thinngy.
8927 During the course of a cloning, a hash table is used to map old addresses
8928 to new addresses. The table is created and manipulated with the
8929 ptr_table_* functions.
8933 ============================================================================*/
8936 #if defined(USE_ITHREADS)
8938 #ifndef GpREFCNT_inc
8939 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8943 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8944 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8945 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8946 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8947 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8948 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8949 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8950 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8951 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8952 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8953 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8954 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8955 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8958 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8959 regcomp.c. AMS 20010712 */
8962 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8967 struct reg_substr_datum *s;
8970 return (REGEXP *)NULL;
8972 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8975 len = r->offsets[0];
8976 npar = r->nparens+1;
8978 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8979 Copy(r->program, ret->program, len+1, regnode);
8981 Newx(ret->startp, npar, I32);
8982 Copy(r->startp, ret->startp, npar, I32);
8983 Newx(ret->endp, npar, I32);
8984 Copy(r->startp, ret->startp, npar, I32);
8986 Newx(ret->substrs, 1, struct reg_substr_data);
8987 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8988 s->min_offset = r->substrs->data[i].min_offset;
8989 s->max_offset = r->substrs->data[i].max_offset;
8990 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8991 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8994 ret->regstclass = NULL;
8997 const int count = r->data->count;
9000 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9001 char, struct reg_data);
9002 Newx(d->what, count, U8);
9005 for (i = 0; i < count; i++) {
9006 d->what[i] = r->data->what[i];
9007 switch (d->what[i]) {
9008 /* legal options are one of: sfpont
9009 see also regcomp.h and pregfree() */
9011 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9014 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9017 /* This is cheating. */
9018 Newx(d->data[i], 1, struct regnode_charclass_class);
9019 StructCopy(r->data->data[i], d->data[i],
9020 struct regnode_charclass_class);
9021 ret->regstclass = (regnode*)d->data[i];
9024 /* Compiled op trees are readonly, and can thus be
9025 shared without duplication. */
9027 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9031 d->data[i] = r->data->data[i];
9034 d->data[i] = r->data->data[i];
9036 ((reg_trie_data*)d->data[i])->refcount++;
9040 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9049 Newx(ret->offsets, 2*len+1, U32);
9050 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9052 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9053 ret->refcnt = r->refcnt;
9054 ret->minlen = r->minlen;
9055 ret->prelen = r->prelen;
9056 ret->nparens = r->nparens;
9057 ret->lastparen = r->lastparen;
9058 ret->lastcloseparen = r->lastcloseparen;
9059 ret->reganch = r->reganch;
9061 ret->sublen = r->sublen;
9063 if (RX_MATCH_COPIED(ret))
9064 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9066 ret->subbeg = Nullch;
9067 #ifdef PERL_OLD_COPY_ON_WRITE
9068 ret->saved_copy = Nullsv;
9071 ptr_table_store(PL_ptr_table, r, ret);
9075 /* duplicate a file handle */
9078 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9082 PERL_UNUSED_ARG(type);
9085 return (PerlIO*)NULL;
9087 /* look for it in the table first */
9088 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9092 /* create anew and remember what it is */
9093 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9094 ptr_table_store(PL_ptr_table, fp, ret);
9098 /* duplicate a directory handle */
9101 Perl_dirp_dup(pTHX_ DIR *dp)
9109 /* duplicate a typeglob */
9112 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9117 /* look for it in the table first */
9118 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9122 /* create anew and remember what it is */
9124 ptr_table_store(PL_ptr_table, gp, ret);
9127 ret->gp_refcnt = 0; /* must be before any other dups! */
9128 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9129 ret->gp_io = io_dup_inc(gp->gp_io, param);
9130 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9131 ret->gp_av = av_dup_inc(gp->gp_av, param);
9132 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9133 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9134 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9135 ret->gp_cvgen = gp->gp_cvgen;
9136 ret->gp_line = gp->gp_line;
9137 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9141 /* duplicate a chain of magic */
9144 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9146 MAGIC *mgprev = (MAGIC*)NULL;
9149 return (MAGIC*)NULL;
9150 /* look for it in the table first */
9151 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9155 for (; mg; mg = mg->mg_moremagic) {
9157 Newxz(nmg, 1, MAGIC);
9159 mgprev->mg_moremagic = nmg;
9162 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9163 nmg->mg_private = mg->mg_private;
9164 nmg->mg_type = mg->mg_type;
9165 nmg->mg_flags = mg->mg_flags;
9166 if (mg->mg_type == PERL_MAGIC_qr) {
9167 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9169 else if(mg->mg_type == PERL_MAGIC_backref) {
9170 /* The backref AV has its reference count deliberately bumped by
9172 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9174 else if (mg->mg_type == PERL_MAGIC_symtab) {
9175 nmg->mg_obj = mg->mg_obj;
9178 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9179 ? sv_dup_inc(mg->mg_obj, param)
9180 : sv_dup(mg->mg_obj, param);
9182 nmg->mg_len = mg->mg_len;
9183 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9184 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9185 if (mg->mg_len > 0) {
9186 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9187 if (mg->mg_type == PERL_MAGIC_overload_table &&
9188 AMT_AMAGIC((AMT*)mg->mg_ptr))
9190 const AMT * const amtp = (AMT*)mg->mg_ptr;
9191 AMT * const namtp = (AMT*)nmg->mg_ptr;
9193 for (i = 1; i < NofAMmeth; i++) {
9194 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9198 else if (mg->mg_len == HEf_SVKEY)
9199 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9201 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9202 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9209 /* create a new pointer-mapping table */
9212 Perl_ptr_table_new(pTHX)
9215 Newxz(tbl, 1, PTR_TBL_t);
9218 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9222 #define PTR_TABLE_HASH(ptr) \
9223 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9226 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9227 following define) and at call to new_body_inline made below in
9228 Perl_ptr_table_store()
9231 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9233 /* map an existing pointer using a table */
9235 STATIC PTR_TBL_ENT_t *
9236 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9237 PTR_TBL_ENT_t *tblent;
9238 const UV hash = PTR_TABLE_HASH(sv);
9240 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9241 for (; tblent; tblent = tblent->next) {
9242 if (tblent->oldval == sv)
9249 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9251 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9252 return tblent ? tblent->newval : (void *) 0;
9255 /* add a new entry to a pointer-mapping table */
9258 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9260 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9263 tblent->newval = newsv;
9265 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9267 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9268 tblent->oldval = oldsv;
9269 tblent->newval = newsv;
9270 tblent->next = tbl->tbl_ary[entry];
9271 tbl->tbl_ary[entry] = tblent;
9273 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9274 ptr_table_split(tbl);
9278 /* double the hash bucket size of an existing ptr table */
9281 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9283 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9284 const UV oldsize = tbl->tbl_max + 1;
9285 UV newsize = oldsize * 2;
9288 Renew(ary, newsize, PTR_TBL_ENT_t*);
9289 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9290 tbl->tbl_max = --newsize;
9292 for (i=0; i < oldsize; i++, ary++) {
9293 PTR_TBL_ENT_t **curentp, **entp, *ent;
9296 curentp = ary + oldsize;
9297 for (entp = ary, ent = *ary; ent; ent = *entp) {
9298 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9300 ent->next = *curentp;
9310 /* remove all the entries from a ptr table */
9313 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9315 if (tbl && tbl->tbl_items) {
9316 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9317 UV riter = tbl->tbl_max;
9320 PTR_TBL_ENT_t *entry = array[riter];
9323 PTR_TBL_ENT_t * const oentry = entry;
9324 entry = entry->next;
9333 /* clear and free a ptr table */
9336 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9341 ptr_table_clear(tbl);
9342 Safefree(tbl->tbl_ary);
9348 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9351 SvRV_set(dstr, SvWEAKREF(sstr)
9352 ? sv_dup(SvRV(sstr), param)
9353 : sv_dup_inc(SvRV(sstr), param));
9356 else if (SvPVX_const(sstr)) {
9357 /* Has something there */
9359 /* Normal PV - clone whole allocated space */
9360 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9361 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9362 /* Not that normal - actually sstr is copy on write.
9363 But we are a true, independant SV, so: */
9364 SvREADONLY_off(dstr);
9369 /* Special case - not normally malloced for some reason */
9370 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9371 /* A "shared" PV - clone it as "shared" PV */
9373 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9377 /* Some other special case - random pointer */
9378 SvPV_set(dstr, SvPVX(sstr));
9384 if (SvTYPE(dstr) == SVt_RV)
9385 SvRV_set(dstr, NULL);
9387 SvPV_set(dstr, NULL);
9391 /* duplicate an SV of any type (including AV, HV etc) */
9394 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9399 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9401 /* look for it in the table first */
9402 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9406 if(param->flags & CLONEf_JOIN_IN) {
9407 /** We are joining here so we don't want do clone
9408 something that is bad **/
9409 if (SvTYPE(sstr) == SVt_PVHV) {
9410 const char * const hvname = HvNAME_get(sstr);
9412 /** don't clone stashes if they already exist **/
9413 return (SV*)gv_stashpv(hvname,0);
9417 /* create anew and remember what it is */
9420 #ifdef DEBUG_LEAKING_SCALARS
9421 dstr->sv_debug_optype = sstr->sv_debug_optype;
9422 dstr->sv_debug_line = sstr->sv_debug_line;
9423 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9424 dstr->sv_debug_cloned = 1;
9425 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9428 ptr_table_store(PL_ptr_table, sstr, dstr);
9431 SvFLAGS(dstr) = SvFLAGS(sstr);
9432 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9433 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9436 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9437 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9438 PL_watch_pvx, SvPVX_const(sstr));
9441 /* don't clone objects whose class has asked us not to */
9442 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9443 SvFLAGS(dstr) &= ~SVTYPEMASK;
9448 switch (SvTYPE(sstr)) {
9453 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9454 SvIV_set(dstr, SvIVX(sstr));
9457 SvANY(dstr) = new_XNV();
9458 SvNV_set(dstr, SvNVX(sstr));
9461 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9462 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9466 /* These are all the types that need complex bodies allocating. */
9468 const svtype sv_type = SvTYPE(sstr);
9469 const struct body_details *const sv_type_details
9470 = bodies_by_type + sv_type;
9474 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9479 if (GvUNIQUE((GV*)sstr)) {
9480 /* Do sharing here, and fall through */
9493 assert(sv_type_details->size);
9494 if (sv_type_details->arena) {
9495 new_body_inline(new_body, sv_type_details->size, sv_type);
9497 = (void*)((char*)new_body - sv_type_details->offset);
9499 new_body = new_NOARENA(sv_type_details);
9503 SvANY(dstr) = new_body;
9506 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9507 ((char*)SvANY(dstr)) + sv_type_details->offset,
9508 sv_type_details->copy, char);
9510 Copy(((char*)SvANY(sstr)),
9511 ((char*)SvANY(dstr)),
9512 sv_type_details->size + sv_type_details->offset, char);
9515 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9516 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9518 /* The Copy above means that all the source (unduplicated) pointers
9519 are now in the destination. We can check the flags and the
9520 pointers in either, but it's possible that there's less cache
9521 missing by always going for the destination.
9522 FIXME - instrument and check that assumption */
9523 if (sv_type >= SVt_PVMG) {
9525 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9527 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9530 /* The cast silences a GCC warning about unhandled types. */
9531 switch ((int)sv_type) {
9543 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9544 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9545 LvTARG(dstr) = dstr;
9546 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9547 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9549 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9552 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9553 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9554 /* Don't call sv_add_backref here as it's going to be created
9555 as part of the magic cloning of the symbol table. */
9556 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9557 (void)GpREFCNT_inc(GvGP(dstr));
9560 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9561 if (IoOFP(dstr) == IoIFP(sstr))
9562 IoOFP(dstr) = IoIFP(dstr);
9564 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9565 /* PL_rsfp_filters entries have fake IoDIRP() */
9566 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9567 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9568 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9569 /* I have no idea why fake dirp (rsfps)
9570 should be treated differently but otherwise
9571 we end up with leaks -- sky*/
9572 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9573 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9574 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9576 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9577 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9578 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9580 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9581 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9582 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9585 if (AvARRAY((AV*)sstr)) {
9586 SV **dst_ary, **src_ary;
9587 SSize_t items = AvFILLp((AV*)sstr) + 1;
9589 src_ary = AvARRAY((AV*)sstr);
9590 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9591 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9592 SvPV_set(dstr, (char*)dst_ary);
9593 AvALLOC((AV*)dstr) = dst_ary;
9594 if (AvREAL((AV*)sstr)) {
9596 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9600 *dst_ary++ = sv_dup(*src_ary++, param);
9602 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9603 while (items-- > 0) {
9604 *dst_ary++ = &PL_sv_undef;
9608 SvPV_set(dstr, Nullch);
9609 AvALLOC((AV*)dstr) = (SV**)NULL;
9616 if (HvARRAY((HV*)sstr)) {
9618 const bool sharekeys = !!HvSHAREKEYS(sstr);
9619 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9620 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9622 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9623 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9625 HvARRAY(dstr) = (HE**)darray;
9626 while (i <= sxhv->xhv_max) {
9627 const HE *source = HvARRAY(sstr)[i];
9628 HvARRAY(dstr)[i] = source
9629 ? he_dup(source, sharekeys, param) : 0;
9633 struct xpvhv_aux * const saux = HvAUX(sstr);
9634 struct xpvhv_aux * const daux = HvAUX(dstr);
9635 /* This flag isn't copied. */
9636 /* SvOOK_on(hv) attacks the IV flags. */
9637 SvFLAGS(dstr) |= SVf_OOK;
9639 hvname = saux->xhv_name;
9641 = hvname ? hek_dup(hvname, param) : hvname;
9643 daux->xhv_riter = saux->xhv_riter;
9644 daux->xhv_eiter = saux->xhv_eiter
9645 ? he_dup(saux->xhv_eiter,
9646 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9647 daux->xhv_backreferences = saux->xhv_backreferences
9648 ? (AV*) SvREFCNT_inc(
9656 SvPV_set(dstr, Nullch);
9658 /* Record stashes for possible cloning in Perl_clone(). */
9660 av_push(param->stashes, dstr);
9665 /* NOTE: not refcounted */
9666 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9668 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9670 if (CvCONST(dstr)) {
9671 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9672 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9673 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9675 /* don't dup if copying back - CvGV isn't refcounted, so the
9676 * duped GV may never be freed. A bit of a hack! DAPM */
9677 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9678 Nullgv : gv_dup(CvGV(dstr), param) ;
9679 if (!(param->flags & CLONEf_COPY_STACKS)) {
9682 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9685 ? cv_dup( CvOUTSIDE(dstr), param)
9686 : cv_dup_inc(CvOUTSIDE(dstr), param);
9688 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9694 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9700 /* duplicate a context */
9703 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9708 return (PERL_CONTEXT*)NULL;
9710 /* look for it in the table first */
9711 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9715 /* create anew and remember what it is */
9716 Newxz(ncxs, max + 1, PERL_CONTEXT);
9717 ptr_table_store(PL_ptr_table, cxs, ncxs);
9720 PERL_CONTEXT * const cx = &cxs[ix];
9721 PERL_CONTEXT * const ncx = &ncxs[ix];
9722 ncx->cx_type = cx->cx_type;
9723 if (CxTYPE(cx) == CXt_SUBST) {
9724 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9727 ncx->blk_oldsp = cx->blk_oldsp;
9728 ncx->blk_oldcop = cx->blk_oldcop;
9729 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9730 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9731 ncx->blk_oldpm = cx->blk_oldpm;
9732 ncx->blk_gimme = cx->blk_gimme;
9733 switch (CxTYPE(cx)) {
9735 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9736 ? cv_dup_inc(cx->blk_sub.cv, param)
9737 : cv_dup(cx->blk_sub.cv,param));
9738 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9739 ? av_dup_inc(cx->blk_sub.argarray, param)
9741 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9742 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9743 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9744 ncx->blk_sub.lval = cx->blk_sub.lval;
9745 ncx->blk_sub.retop = cx->blk_sub.retop;
9748 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9749 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9750 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9751 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9752 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9753 ncx->blk_eval.retop = cx->blk_eval.retop;
9756 ncx->blk_loop.label = cx->blk_loop.label;
9757 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9758 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9759 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9760 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9761 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9762 ? cx->blk_loop.iterdata
9763 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9764 ncx->blk_loop.oldcomppad
9765 = (PAD*)ptr_table_fetch(PL_ptr_table,
9766 cx->blk_loop.oldcomppad);
9767 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9768 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9769 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9770 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9771 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9774 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9775 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9776 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9777 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9778 ncx->blk_sub.retop = cx->blk_sub.retop;
9790 /* duplicate a stack info structure */
9793 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9798 return (PERL_SI*)NULL;
9800 /* look for it in the table first */
9801 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9805 /* create anew and remember what it is */
9806 Newxz(nsi, 1, PERL_SI);
9807 ptr_table_store(PL_ptr_table, si, nsi);
9809 nsi->si_stack = av_dup_inc(si->si_stack, param);
9810 nsi->si_cxix = si->si_cxix;
9811 nsi->si_cxmax = si->si_cxmax;
9812 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9813 nsi->si_type = si->si_type;
9814 nsi->si_prev = si_dup(si->si_prev, param);
9815 nsi->si_next = si_dup(si->si_next, param);
9816 nsi->si_markoff = si->si_markoff;
9821 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9822 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9823 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9824 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9825 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9826 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9827 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9828 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9829 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9830 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9831 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9832 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9833 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9834 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9837 #define pv_dup_inc(p) SAVEPV(p)
9838 #define pv_dup(p) SAVEPV(p)
9839 #define svp_dup_inc(p,pp) any_dup(p,pp)
9841 /* map any object to the new equivent - either something in the
9842 * ptr table, or something in the interpreter structure
9846 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9853 /* look for it in the table first */
9854 ret = ptr_table_fetch(PL_ptr_table, v);
9858 /* see if it is part of the interpreter structure */
9859 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9860 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9868 /* duplicate the save stack */
9871 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9873 ANY * const ss = proto_perl->Tsavestack;
9874 const I32 max = proto_perl->Tsavestack_max;
9875 I32 ix = proto_perl->Tsavestack_ix;
9887 void (*dptr) (void*);
9888 void (*dxptr) (pTHX_ void*);
9890 Newxz(nss, max, ANY);
9893 I32 i = POPINT(ss,ix);
9896 case SAVEt_ITEM: /* normal string */
9897 sv = (SV*)POPPTR(ss,ix);
9898 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9899 sv = (SV*)POPPTR(ss,ix);
9900 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9902 case SAVEt_SV: /* scalar reference */
9903 sv = (SV*)POPPTR(ss,ix);
9904 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9905 gv = (GV*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9908 case SAVEt_GENERIC_PVREF: /* generic char* */
9909 c = (char*)POPPTR(ss,ix);
9910 TOPPTR(nss,ix) = pv_dup(c);
9911 ptr = POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9914 case SAVEt_SHARED_PVREF: /* char* in shared space */
9915 c = (char*)POPPTR(ss,ix);
9916 TOPPTR(nss,ix) = savesharedpv(c);
9917 ptr = POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9920 case SAVEt_GENERIC_SVREF: /* generic sv */
9921 case SAVEt_SVREF: /* scalar reference */
9922 sv = (SV*)POPPTR(ss,ix);
9923 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9924 ptr = POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9927 case SAVEt_AV: /* array reference */
9928 av = (AV*)POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = av_dup_inc(av, param);
9930 gv = (GV*)POPPTR(ss,ix);
9931 TOPPTR(nss,ix) = gv_dup(gv, param);
9933 case SAVEt_HV: /* hash reference */
9934 hv = (HV*)POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9936 gv = (GV*)POPPTR(ss,ix);
9937 TOPPTR(nss,ix) = gv_dup(gv, param);
9939 case SAVEt_INT: /* int reference */
9940 ptr = POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9942 intval = (int)POPINT(ss,ix);
9943 TOPINT(nss,ix) = intval;
9945 case SAVEt_LONG: /* long reference */
9946 ptr = POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9948 longval = (long)POPLONG(ss,ix);
9949 TOPLONG(nss,ix) = longval;
9951 case SAVEt_I32: /* I32 reference */
9952 case SAVEt_I16: /* I16 reference */
9953 case SAVEt_I8: /* I8 reference */
9954 ptr = POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9959 case SAVEt_IV: /* IV reference */
9960 ptr = POPPTR(ss,ix);
9961 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9965 case SAVEt_SPTR: /* SV* reference */
9966 ptr = POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9968 sv = (SV*)POPPTR(ss,ix);
9969 TOPPTR(nss,ix) = sv_dup(sv, param);
9971 case SAVEt_VPTR: /* random* reference */
9972 ptr = POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9974 ptr = POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9977 case SAVEt_PPTR: /* char* reference */
9978 ptr = POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9980 c = (char*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = pv_dup(c);
9983 case SAVEt_HPTR: /* HV* reference */
9984 ptr = POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9986 hv = (HV*)POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = hv_dup(hv, param);
9989 case SAVEt_APTR: /* AV* reference */
9990 ptr = POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9992 av = (AV*)POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = av_dup(av, param);
9996 gv = (GV*)POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = gv_dup(gv, param);
9999 case SAVEt_GP: /* scalar reference */
10000 gp = (GP*)POPPTR(ss,ix);
10001 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10002 (void)GpREFCNT_inc(gp);
10003 gv = (GV*)POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10005 c = (char*)POPPTR(ss,ix);
10006 TOPPTR(nss,ix) = pv_dup(c);
10008 TOPIV(nss,ix) = iv;
10010 TOPIV(nss,ix) = iv;
10013 case SAVEt_MORTALIZESV:
10014 sv = (SV*)POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10018 ptr = POPPTR(ss,ix);
10019 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10020 /* these are assumed to be refcounted properly */
10022 switch (((OP*)ptr)->op_type) {
10024 case OP_LEAVESUBLV:
10028 case OP_LEAVEWRITE:
10029 TOPPTR(nss,ix) = ptr;
10034 TOPPTR(nss,ix) = Nullop;
10039 TOPPTR(nss,ix) = Nullop;
10042 c = (char*)POPPTR(ss,ix);
10043 TOPPTR(nss,ix) = pv_dup_inc(c);
10045 case SAVEt_CLEARSV:
10046 longval = POPLONG(ss,ix);
10047 TOPLONG(nss,ix) = longval;
10050 hv = (HV*)POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10052 c = (char*)POPPTR(ss,ix);
10053 TOPPTR(nss,ix) = pv_dup_inc(c);
10055 TOPINT(nss,ix) = i;
10057 case SAVEt_DESTRUCTOR:
10058 ptr = POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10060 dptr = POPDPTR(ss,ix);
10061 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10062 any_dup(FPTR2DPTR(void *, dptr),
10065 case SAVEt_DESTRUCTOR_X:
10066 ptr = POPPTR(ss,ix);
10067 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10068 dxptr = POPDXPTR(ss,ix);
10069 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10070 any_dup(FPTR2DPTR(void *, dxptr),
10073 case SAVEt_REGCONTEXT:
10076 TOPINT(nss,ix) = i;
10079 case SAVEt_STACK_POS: /* Position on Perl stack */
10081 TOPINT(nss,ix) = i;
10083 case SAVEt_AELEM: /* array element */
10084 sv = (SV*)POPPTR(ss,ix);
10085 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10087 TOPINT(nss,ix) = i;
10088 av = (AV*)POPPTR(ss,ix);
10089 TOPPTR(nss,ix) = av_dup_inc(av, param);
10091 case SAVEt_HELEM: /* hash element */
10092 sv = (SV*)POPPTR(ss,ix);
10093 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10094 sv = (SV*)POPPTR(ss,ix);
10095 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10096 hv = (HV*)POPPTR(ss,ix);
10097 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10100 ptr = POPPTR(ss,ix);
10101 TOPPTR(nss,ix) = ptr;
10105 TOPINT(nss,ix) = i;
10107 case SAVEt_COMPPAD:
10108 av = (AV*)POPPTR(ss,ix);
10109 TOPPTR(nss,ix) = av_dup(av, param);
10112 longval = (long)POPLONG(ss,ix);
10113 TOPLONG(nss,ix) = longval;
10114 ptr = POPPTR(ss,ix);
10115 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10116 sv = (SV*)POPPTR(ss,ix);
10117 TOPPTR(nss,ix) = sv_dup(sv, param);
10120 ptr = POPPTR(ss,ix);
10121 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10122 longval = (long)POPBOOL(ss,ix);
10123 TOPBOOL(nss,ix) = (bool)longval;
10125 case SAVEt_SET_SVFLAGS:
10127 TOPINT(nss,ix) = i;
10129 TOPINT(nss,ix) = i;
10130 sv = (SV*)POPPTR(ss,ix);
10131 TOPPTR(nss,ix) = sv_dup(sv, param);
10134 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10142 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10143 * flag to the result. This is done for each stash before cloning starts,
10144 * so we know which stashes want their objects cloned */
10147 do_mark_cloneable_stash(pTHX_ SV *sv)
10149 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10151 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10152 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10153 if (cloner && GvCV(cloner)) {
10160 XPUSHs(sv_2mortal(newSVhek(hvname)));
10162 call_sv((SV*)GvCV(cloner), G_SCALAR);
10169 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10177 =for apidoc perl_clone
10179 Create and return a new interpreter by cloning the current one.
10181 perl_clone takes these flags as parameters:
10183 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10184 without it we only clone the data and zero the stacks,
10185 with it we copy the stacks and the new perl interpreter is
10186 ready to run at the exact same point as the previous one.
10187 The pseudo-fork code uses COPY_STACKS while the
10188 threads->new doesn't.
10190 CLONEf_KEEP_PTR_TABLE
10191 perl_clone keeps a ptr_table with the pointer of the old
10192 variable as a key and the new variable as a value,
10193 this allows it to check if something has been cloned and not
10194 clone it again but rather just use the value and increase the
10195 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10196 the ptr_table using the function
10197 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10198 reason to keep it around is if you want to dup some of your own
10199 variable who are outside the graph perl scans, example of this
10200 code is in threads.xs create
10203 This is a win32 thing, it is ignored on unix, it tells perls
10204 win32host code (which is c++) to clone itself, this is needed on
10205 win32 if you want to run two threads at the same time,
10206 if you just want to do some stuff in a separate perl interpreter
10207 and then throw it away and return to the original one,
10208 you don't need to do anything.
10213 /* XXX the above needs expanding by someone who actually understands it ! */
10214 EXTERN_C PerlInterpreter *
10215 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10218 perl_clone(PerlInterpreter *proto_perl, UV flags)
10221 #ifdef PERL_IMPLICIT_SYS
10223 /* perlhost.h so we need to call into it
10224 to clone the host, CPerlHost should have a c interface, sky */
10226 if (flags & CLONEf_CLONE_HOST) {
10227 return perl_clone_host(proto_perl,flags);
10229 return perl_clone_using(proto_perl, flags,
10231 proto_perl->IMemShared,
10232 proto_perl->IMemParse,
10234 proto_perl->IStdIO,
10238 proto_perl->IProc);
10242 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10243 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10244 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10245 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10246 struct IPerlDir* ipD, struct IPerlSock* ipS,
10247 struct IPerlProc* ipP)
10249 /* XXX many of the string copies here can be optimized if they're
10250 * constants; they need to be allocated as common memory and just
10251 * their pointers copied. */
10254 CLONE_PARAMS clone_params;
10255 CLONE_PARAMS* param = &clone_params;
10257 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10258 /* for each stash, determine whether its objects should be cloned */
10259 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10260 PERL_SET_THX(my_perl);
10263 Poison(my_perl, 1, PerlInterpreter);
10265 PL_curcop = (COP *)Nullop;
10269 PL_savestack_ix = 0;
10270 PL_savestack_max = -1;
10271 PL_sig_pending = 0;
10272 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10273 # else /* !DEBUGGING */
10274 Zero(my_perl, 1, PerlInterpreter);
10275 # endif /* DEBUGGING */
10277 /* host pointers */
10279 PL_MemShared = ipMS;
10280 PL_MemParse = ipMP;
10287 #else /* !PERL_IMPLICIT_SYS */
10289 CLONE_PARAMS clone_params;
10290 CLONE_PARAMS* param = &clone_params;
10291 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10292 /* for each stash, determine whether its objects should be cloned */
10293 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10294 PERL_SET_THX(my_perl);
10297 Poison(my_perl, 1, PerlInterpreter);
10299 PL_curcop = (COP *)Nullop;
10303 PL_savestack_ix = 0;
10304 PL_savestack_max = -1;
10305 PL_sig_pending = 0;
10306 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10307 # else /* !DEBUGGING */
10308 Zero(my_perl, 1, PerlInterpreter);
10309 # endif /* DEBUGGING */
10310 #endif /* PERL_IMPLICIT_SYS */
10311 param->flags = flags;
10312 param->proto_perl = proto_perl;
10314 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10315 Zero(&PL_body_roots, 1, PL_body_roots);
10317 PL_nice_chunk = NULL;
10318 PL_nice_chunk_size = 0;
10320 PL_sv_objcount = 0;
10321 PL_sv_root = Nullsv;
10322 PL_sv_arenaroot = Nullsv;
10324 PL_debug = proto_perl->Idebug;
10326 PL_hash_seed = proto_perl->Ihash_seed;
10327 PL_rehash_seed = proto_perl->Irehash_seed;
10329 #ifdef USE_REENTRANT_API
10330 /* XXX: things like -Dm will segfault here in perlio, but doing
10331 * PERL_SET_CONTEXT(proto_perl);
10332 * breaks too many other things
10334 Perl_reentrant_init(aTHX);
10337 /* create SV map for pointer relocation */
10338 PL_ptr_table = ptr_table_new();
10340 /* initialize these special pointers as early as possible */
10341 SvANY(&PL_sv_undef) = NULL;
10342 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10343 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10344 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10346 SvANY(&PL_sv_no) = new_XPVNV();
10347 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10348 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10349 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10350 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10351 SvCUR_set(&PL_sv_no, 0);
10352 SvLEN_set(&PL_sv_no, 1);
10353 SvIV_set(&PL_sv_no, 0);
10354 SvNV_set(&PL_sv_no, 0);
10355 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10357 SvANY(&PL_sv_yes) = new_XPVNV();
10358 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10359 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10360 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10361 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10362 SvCUR_set(&PL_sv_yes, 1);
10363 SvLEN_set(&PL_sv_yes, 2);
10364 SvIV_set(&PL_sv_yes, 1);
10365 SvNV_set(&PL_sv_yes, 1);
10366 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10368 /* create (a non-shared!) shared string table */
10369 PL_strtab = newHV();
10370 HvSHAREKEYS_off(PL_strtab);
10371 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10372 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10374 PL_compiling = proto_perl->Icompiling;
10376 /* These two PVs will be free'd special way so must set them same way op.c does */
10377 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10378 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10380 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10381 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10383 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10384 if (!specialWARN(PL_compiling.cop_warnings))
10385 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10386 if (!specialCopIO(PL_compiling.cop_io))
10387 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10388 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10390 /* pseudo environmental stuff */
10391 PL_origargc = proto_perl->Iorigargc;
10392 PL_origargv = proto_perl->Iorigargv;
10394 param->stashes = newAV(); /* Setup array of objects to call clone on */
10396 /* Set tainting stuff before PerlIO_debug can possibly get called */
10397 PL_tainting = proto_perl->Itainting;
10398 PL_taint_warn = proto_perl->Itaint_warn;
10400 #ifdef PERLIO_LAYERS
10401 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10402 PerlIO_clone(aTHX_ proto_perl, param);
10405 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10406 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10407 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10408 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10409 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10410 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10413 PL_minus_c = proto_perl->Iminus_c;
10414 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10415 PL_localpatches = proto_perl->Ilocalpatches;
10416 PL_splitstr = proto_perl->Isplitstr;
10417 PL_preprocess = proto_perl->Ipreprocess;
10418 PL_minus_n = proto_perl->Iminus_n;
10419 PL_minus_p = proto_perl->Iminus_p;
10420 PL_minus_l = proto_perl->Iminus_l;
10421 PL_minus_a = proto_perl->Iminus_a;
10422 PL_minus_E = proto_perl->Iminus_E;
10423 PL_minus_F = proto_perl->Iminus_F;
10424 PL_doswitches = proto_perl->Idoswitches;
10425 PL_dowarn = proto_perl->Idowarn;
10426 PL_doextract = proto_perl->Idoextract;
10427 PL_sawampersand = proto_perl->Isawampersand;
10428 PL_unsafe = proto_perl->Iunsafe;
10429 PL_inplace = SAVEPV(proto_perl->Iinplace);
10430 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10431 PL_perldb = proto_perl->Iperldb;
10432 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10433 PL_exit_flags = proto_perl->Iexit_flags;
10435 /* magical thingies */
10436 /* XXX time(&PL_basetime) when asked for? */
10437 PL_basetime = proto_perl->Ibasetime;
10438 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10440 PL_maxsysfd = proto_perl->Imaxsysfd;
10441 PL_multiline = proto_perl->Imultiline;
10442 PL_statusvalue = proto_perl->Istatusvalue;
10444 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10446 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10448 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10450 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10451 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10452 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10454 /* Clone the regex array */
10455 PL_regex_padav = newAV();
10457 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10458 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10460 av_push(PL_regex_padav,
10461 sv_dup_inc(regexen[0],param));
10462 for(i = 1; i <= len; i++) {
10463 const SV * const regex = regexen[i];
10466 ? sv_dup_inc(regex, param)
10468 newSViv(PTR2IV(re_dup(
10469 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10471 av_push(PL_regex_padav, sv);
10474 PL_regex_pad = AvARRAY(PL_regex_padav);
10476 /* shortcuts to various I/O objects */
10477 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10478 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10479 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10480 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10481 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10482 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10484 /* shortcuts to regexp stuff */
10485 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10487 /* shortcuts to misc objects */
10488 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10490 /* shortcuts to debugging objects */
10491 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10492 PL_DBline = gv_dup(proto_perl->IDBline, param);
10493 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10494 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10495 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10496 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10497 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10498 PL_lineary = av_dup(proto_perl->Ilineary, param);
10499 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10501 /* symbol tables */
10502 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10503 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10504 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10505 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10506 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10508 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10509 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10510 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10511 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10512 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10513 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10515 PL_sub_generation = proto_perl->Isub_generation;
10517 /* funky return mechanisms */
10518 PL_forkprocess = proto_perl->Iforkprocess;
10520 /* subprocess state */
10521 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10523 /* internal state */
10524 PL_maxo = proto_perl->Imaxo;
10525 if (proto_perl->Iop_mask)
10526 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10528 PL_op_mask = Nullch;
10529 /* PL_asserting = proto_perl->Iasserting; */
10531 /* current interpreter roots */
10532 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10533 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10534 PL_main_start = proto_perl->Imain_start;
10535 PL_eval_root = proto_perl->Ieval_root;
10536 PL_eval_start = proto_perl->Ieval_start;
10538 /* runtime control stuff */
10539 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10540 PL_copline = proto_perl->Icopline;
10542 PL_filemode = proto_perl->Ifilemode;
10543 PL_lastfd = proto_perl->Ilastfd;
10544 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10547 PL_gensym = proto_perl->Igensym;
10548 PL_preambled = proto_perl->Ipreambled;
10549 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10550 PL_laststatval = proto_perl->Ilaststatval;
10551 PL_laststype = proto_perl->Ilaststype;
10552 PL_mess_sv = Nullsv;
10554 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10556 /* interpreter atexit processing */
10557 PL_exitlistlen = proto_perl->Iexitlistlen;
10558 if (PL_exitlistlen) {
10559 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10560 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10563 PL_exitlist = (PerlExitListEntry*)NULL;
10565 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10566 if (PL_my_cxt_size) {
10567 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10568 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10571 PL_my_cxt_list = (void**)NULL;
10572 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10573 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10574 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10576 PL_profiledata = NULL;
10577 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10578 /* PL_rsfp_filters entries have fake IoDIRP() */
10579 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10581 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10583 PAD_CLONE_VARS(proto_perl, param);
10585 #ifdef HAVE_INTERP_INTERN
10586 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10589 /* more statics moved here */
10590 PL_generation = proto_perl->Igeneration;
10591 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10593 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10594 PL_in_clean_all = proto_perl->Iin_clean_all;
10596 PL_uid = proto_perl->Iuid;
10597 PL_euid = proto_perl->Ieuid;
10598 PL_gid = proto_perl->Igid;
10599 PL_egid = proto_perl->Iegid;
10600 PL_nomemok = proto_perl->Inomemok;
10601 PL_an = proto_perl->Ian;
10602 PL_evalseq = proto_perl->Ievalseq;
10603 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10604 PL_origalen = proto_perl->Iorigalen;
10605 #ifdef PERL_USES_PL_PIDSTATUS
10606 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10608 PL_osname = SAVEPV(proto_perl->Iosname);
10609 PL_sighandlerp = proto_perl->Isighandlerp;
10611 PL_runops = proto_perl->Irunops;
10613 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10616 PL_cshlen = proto_perl->Icshlen;
10617 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10620 PL_lex_state = proto_perl->Ilex_state;
10621 PL_lex_defer = proto_perl->Ilex_defer;
10622 PL_lex_expect = proto_perl->Ilex_expect;
10623 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10624 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10625 PL_lex_starts = proto_perl->Ilex_starts;
10626 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10627 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10628 PL_lex_op = proto_perl->Ilex_op;
10629 PL_lex_inpat = proto_perl->Ilex_inpat;
10630 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10631 PL_lex_brackets = proto_perl->Ilex_brackets;
10632 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10633 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10634 PL_lex_casemods = proto_perl->Ilex_casemods;
10635 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10636 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10638 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10639 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10640 PL_nexttoke = proto_perl->Inexttoke;
10642 /* XXX This is probably masking the deeper issue of why
10643 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10644 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10645 * (A little debugging with a watchpoint on it may help.)
10647 if (SvANY(proto_perl->Ilinestr)) {
10648 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10649 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10650 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10651 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10652 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10653 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10654 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10655 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10656 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10659 PL_linestr = newSV(79);
10660 sv_upgrade(PL_linestr,SVt_PVIV);
10661 sv_setpvn(PL_linestr,"",0);
10662 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10664 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10665 PL_pending_ident = proto_perl->Ipending_ident;
10666 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10668 PL_expect = proto_perl->Iexpect;
10670 PL_multi_start = proto_perl->Imulti_start;
10671 PL_multi_end = proto_perl->Imulti_end;
10672 PL_multi_open = proto_perl->Imulti_open;
10673 PL_multi_close = proto_perl->Imulti_close;
10675 PL_error_count = proto_perl->Ierror_count;
10676 PL_subline = proto_perl->Isubline;
10677 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10679 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10680 if (SvANY(proto_perl->Ilinestr)) {
10681 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10682 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10683 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10684 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10685 PL_last_lop_op = proto_perl->Ilast_lop_op;
10688 PL_last_uni = SvPVX(PL_linestr);
10689 PL_last_lop = SvPVX(PL_linestr);
10690 PL_last_lop_op = 0;
10692 PL_in_my = proto_perl->Iin_my;
10693 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10695 PL_cryptseen = proto_perl->Icryptseen;
10698 PL_hints = proto_perl->Ihints;
10700 PL_amagic_generation = proto_perl->Iamagic_generation;
10702 #ifdef USE_LOCALE_COLLATE
10703 PL_collation_ix = proto_perl->Icollation_ix;
10704 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10705 PL_collation_standard = proto_perl->Icollation_standard;
10706 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10707 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10708 #endif /* USE_LOCALE_COLLATE */
10710 #ifdef USE_LOCALE_NUMERIC
10711 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10712 PL_numeric_standard = proto_perl->Inumeric_standard;
10713 PL_numeric_local = proto_perl->Inumeric_local;
10714 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10715 #endif /* !USE_LOCALE_NUMERIC */
10717 /* utf8 character classes */
10718 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10719 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10720 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10721 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10722 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10723 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10724 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10725 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10726 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10727 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10728 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10729 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10730 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10731 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10732 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10733 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10734 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10735 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10736 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10737 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10739 /* Did the locale setup indicate UTF-8? */
10740 PL_utf8locale = proto_perl->Iutf8locale;
10741 /* Unicode features (see perlrun/-C) */
10742 PL_unicode = proto_perl->Iunicode;
10744 /* Pre-5.8 signals control */
10745 PL_signals = proto_perl->Isignals;
10747 /* times() ticks per second */
10748 PL_clocktick = proto_perl->Iclocktick;
10750 /* Recursion stopper for PerlIO_find_layer */
10751 PL_in_load_module = proto_perl->Iin_load_module;
10753 /* sort() routine */
10754 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10756 /* Not really needed/useful since the reenrant_retint is "volatile",
10757 * but do it for consistency's sake. */
10758 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10760 /* Hooks to shared SVs and locks. */
10761 PL_sharehook = proto_perl->Isharehook;
10762 PL_lockhook = proto_perl->Ilockhook;
10763 PL_unlockhook = proto_perl->Iunlockhook;
10764 PL_threadhook = proto_perl->Ithreadhook;
10766 PL_runops_std = proto_perl->Irunops_std;
10767 PL_runops_dbg = proto_perl->Irunops_dbg;
10769 #ifdef THREADS_HAVE_PIDS
10770 PL_ppid = proto_perl->Ippid;
10774 PL_last_swash_hv = NULL; /* reinits on demand */
10775 PL_last_swash_klen = 0;
10776 PL_last_swash_key[0]= '\0';
10777 PL_last_swash_tmps = (U8*)NULL;
10778 PL_last_swash_slen = 0;
10780 PL_glob_index = proto_perl->Iglob_index;
10781 PL_srand_called = proto_perl->Isrand_called;
10782 PL_uudmap['M'] = 0; /* reinits on demand */
10783 PL_bitcount = Nullch; /* reinits on demand */
10785 if (proto_perl->Ipsig_pend) {
10786 Newxz(PL_psig_pend, SIG_SIZE, int);
10789 PL_psig_pend = (int*)NULL;
10792 if (proto_perl->Ipsig_ptr) {
10793 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10794 Newxz(PL_psig_name, SIG_SIZE, SV*);
10795 for (i = 1; i < SIG_SIZE; i++) {
10796 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10797 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10801 PL_psig_ptr = (SV**)NULL;
10802 PL_psig_name = (SV**)NULL;
10805 /* thrdvar.h stuff */
10807 if (flags & CLONEf_COPY_STACKS) {
10808 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10809 PL_tmps_ix = proto_perl->Ttmps_ix;
10810 PL_tmps_max = proto_perl->Ttmps_max;
10811 PL_tmps_floor = proto_perl->Ttmps_floor;
10812 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10814 while (i <= PL_tmps_ix) {
10815 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10819 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10820 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10821 Newxz(PL_markstack, i, I32);
10822 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10823 - proto_perl->Tmarkstack);
10824 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10825 - proto_perl->Tmarkstack);
10826 Copy(proto_perl->Tmarkstack, PL_markstack,
10827 PL_markstack_ptr - PL_markstack + 1, I32);
10829 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10830 * NOTE: unlike the others! */
10831 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10832 PL_scopestack_max = proto_perl->Tscopestack_max;
10833 Newxz(PL_scopestack, PL_scopestack_max, I32);
10834 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10836 /* NOTE: si_dup() looks at PL_markstack */
10837 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10839 /* PL_curstack = PL_curstackinfo->si_stack; */
10840 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10841 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10843 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10844 PL_stack_base = AvARRAY(PL_curstack);
10845 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10846 - proto_perl->Tstack_base);
10847 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10849 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10850 * NOTE: unlike the others! */
10851 PL_savestack_ix = proto_perl->Tsavestack_ix;
10852 PL_savestack_max = proto_perl->Tsavestack_max;
10853 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10854 PL_savestack = ss_dup(proto_perl, param);
10858 ENTER; /* perl_destruct() wants to LEAVE; */
10860 /* although we're not duplicating the tmps stack, we should still
10861 * add entries for any SVs on the tmps stack that got cloned by a
10862 * non-refcount means (eg a temp in @_); otherwise they will be
10865 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10866 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10867 proto_perl->Ttmps_stack[i]);
10868 if (nsv && !SvREFCNT(nsv)) {
10870 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10875 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10876 PL_top_env = &PL_start_env;
10878 PL_op = proto_perl->Top;
10881 PL_Xpv = (XPV*)NULL;
10882 PL_na = proto_perl->Tna;
10884 PL_statbuf = proto_perl->Tstatbuf;
10885 PL_statcache = proto_perl->Tstatcache;
10886 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10887 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10889 PL_timesbuf = proto_perl->Ttimesbuf;
10892 PL_tainted = proto_perl->Ttainted;
10893 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10894 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10895 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10896 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10897 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10898 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10899 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10900 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10901 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10903 PL_restartop = proto_perl->Trestartop;
10904 PL_in_eval = proto_perl->Tin_eval;
10905 PL_delaymagic = proto_perl->Tdelaymagic;
10906 PL_dirty = proto_perl->Tdirty;
10907 PL_localizing = proto_perl->Tlocalizing;
10909 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10910 PL_hv_fetch_ent_mh = Nullhe;
10911 PL_modcount = proto_perl->Tmodcount;
10912 PL_lastgotoprobe = Nullop;
10913 PL_dumpindent = proto_perl->Tdumpindent;
10915 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10916 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10917 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10918 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10919 PL_efloatbuf = Nullch; /* reinits on demand */
10920 PL_efloatsize = 0; /* reinits on demand */
10924 PL_screamfirst = NULL;
10925 PL_screamnext = NULL;
10926 PL_maxscream = -1; /* reinits on demand */
10927 PL_lastscream = Nullsv;
10929 PL_watchaddr = NULL;
10930 PL_watchok = Nullch;
10932 PL_regdummy = proto_perl->Tregdummy;
10933 PL_regprecomp = Nullch;
10936 PL_colorset = 0; /* reinits PL_colors[] */
10937 /*PL_colors[6] = {0,0,0,0,0,0};*/
10938 PL_reginput = Nullch;
10939 PL_regbol = Nullch;
10940 PL_regeol = Nullch;
10941 PL_regstartp = (I32*)NULL;
10942 PL_regendp = (I32*)NULL;
10943 PL_reglastparen = (U32*)NULL;
10944 PL_reglastcloseparen = (U32*)NULL;
10945 PL_regtill = Nullch;
10946 PL_reg_start_tmp = (char**)NULL;
10947 PL_reg_start_tmpl = 0;
10948 PL_regdata = (struct reg_data*)NULL;
10951 PL_reg_eval_set = 0;
10953 PL_regprogram = (regnode*)NULL;
10955 PL_regcc = (CURCUR*)NULL;
10956 PL_reg_call_cc = (struct re_cc_state*)NULL;
10957 PL_reg_re = (regexp*)NULL;
10958 PL_reg_ganch = Nullch;
10959 PL_reg_sv = Nullsv;
10960 PL_reg_match_utf8 = FALSE;
10961 PL_reg_magic = (MAGIC*)NULL;
10963 PL_reg_oldcurpm = (PMOP*)NULL;
10964 PL_reg_curpm = (PMOP*)NULL;
10965 PL_reg_oldsaved = Nullch;
10966 PL_reg_oldsavedlen = 0;
10967 #ifdef PERL_OLD_COPY_ON_WRITE
10970 PL_reg_maxiter = 0;
10971 PL_reg_leftiter = 0;
10972 PL_reg_poscache = Nullch;
10973 PL_reg_poscache_size= 0;
10975 /* RE engine - function pointers */
10976 PL_regcompp = proto_perl->Tregcompp;
10977 PL_regexecp = proto_perl->Tregexecp;
10978 PL_regint_start = proto_perl->Tregint_start;
10979 PL_regint_string = proto_perl->Tregint_string;
10980 PL_regfree = proto_perl->Tregfree;
10982 PL_reginterp_cnt = 0;
10983 PL_reg_starttry = 0;
10985 /* Pluggable optimizer */
10986 PL_peepp = proto_perl->Tpeepp;
10988 PL_stashcache = newHV();
10990 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10991 ptr_table_free(PL_ptr_table);
10992 PL_ptr_table = NULL;
10995 /* Call the ->CLONE method, if it exists, for each of the stashes
10996 identified by sv_dup() above.
10998 while(av_len(param->stashes) != -1) {
10999 HV* const stash = (HV*) av_shift(param->stashes);
11000 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11001 if (cloner && GvCV(cloner)) {
11006 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11008 call_sv((SV*)GvCV(cloner), G_DISCARD);
11014 SvREFCNT_dec(param->stashes);
11016 /* orphaned? eg threads->new inside BEGIN or use */
11017 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11018 (void)SvREFCNT_inc(PL_compcv);
11019 SAVEFREESV(PL_compcv);
11025 #endif /* USE_ITHREADS */
11028 =head1 Unicode Support
11030 =for apidoc sv_recode_to_utf8
11032 The encoding is assumed to be an Encode object, on entry the PV
11033 of the sv is assumed to be octets in that encoding, and the sv
11034 will be converted into Unicode (and UTF-8).
11036 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11037 is not a reference, nothing is done to the sv. If the encoding is not
11038 an C<Encode::XS> Encoding object, bad things will happen.
11039 (See F<lib/encoding.pm> and L<Encode>).
11041 The PV of the sv is returned.
11046 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11049 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11063 Passing sv_yes is wrong - it needs to be or'ed set of constants
11064 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11065 remove converted chars from source.
11067 Both will default the value - let them.
11069 XPUSHs(&PL_sv_yes);
11072 call_method("decode", G_SCALAR);
11076 s = SvPV_const(uni, len);
11077 if (s != SvPVX_const(sv)) {
11078 SvGROW(sv, len + 1);
11079 Move(s, SvPVX(sv), len + 1, char);
11080 SvCUR_set(sv, len);
11087 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11091 =for apidoc sv_cat_decode
11093 The encoding is assumed to be an Encode object, the PV of the ssv is
11094 assumed to be octets in that encoding and decoding the input starts
11095 from the position which (PV + *offset) pointed to. The dsv will be
11096 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11097 when the string tstr appears in decoding output or the input ends on
11098 the PV of the ssv. The value which the offset points will be modified
11099 to the last input position on the ssv.
11101 Returns TRUE if the terminator was found, else returns FALSE.
11106 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11107 SV *ssv, int *offset, char *tstr, int tlen)
11111 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11122 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11123 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11125 call_method("cat_decode", G_SCALAR);
11127 ret = SvTRUE(TOPs);
11128 *offset = SvIV(offsv);
11134 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11139 /* ---------------------------------------------------------------------
11141 * support functions for report_uninit()
11144 /* the maxiumum size of array or hash where we will scan looking
11145 * for the undefined element that triggered the warning */
11147 #define FUV_MAX_SEARCH_SIZE 1000
11149 /* Look for an entry in the hash whose value has the same SV as val;
11150 * If so, return a mortal copy of the key. */
11153 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11156 register HE **array;
11159 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11160 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11163 array = HvARRAY(hv);
11165 for (i=HvMAX(hv); i>0; i--) {
11166 register HE *entry;
11167 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11168 if (HeVAL(entry) != val)
11170 if ( HeVAL(entry) == &PL_sv_undef ||
11171 HeVAL(entry) == &PL_sv_placeholder)
11175 if (HeKLEN(entry) == HEf_SVKEY)
11176 return sv_mortalcopy(HeKEY_sv(entry));
11177 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11183 /* Look for an entry in the array whose value has the same SV as val;
11184 * If so, return the index, otherwise return -1. */
11187 S_find_array_subscript(pTHX_ AV *av, SV* val)
11192 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11193 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11197 for (i=AvFILLp(av); i>=0; i--) {
11198 if (svp[i] == val && svp[i] != &PL_sv_undef)
11204 /* S_varname(): return the name of a variable, optionally with a subscript.
11205 * If gv is non-zero, use the name of that global, along with gvtype (one
11206 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11207 * targ. Depending on the value of the subscript_type flag, return:
11210 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11211 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11212 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11213 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11216 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11217 SV* keyname, I32 aindex, int subscript_type)
11220 SV * const name = sv_newmortal();
11223 buffer[0] = gvtype;
11226 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11228 gv_fullname4(name, gv, buffer, 0);
11230 if ((unsigned int)SvPVX(name)[1] <= 26) {
11232 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11234 /* Swap the 1 unprintable control character for the 2 byte pretty
11235 version - ie substr($name, 1, 1) = $buffer; */
11236 sv_insert(name, 1, 1, buffer, 2);
11241 CV * const cv = find_runcv(&unused);
11245 if (!cv || !CvPADLIST(cv))
11247 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11248 sv = *av_fetch(av, targ, FALSE);
11249 /* SvLEN in a pad name is not to be trusted */
11250 sv_setpv(name, SvPV_nolen_const(sv));
11253 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11254 SV * const sv = newSV(0);
11255 *SvPVX(name) = '$';
11256 Perl_sv_catpvf(aTHX_ name, "{%s}",
11257 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11260 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11261 *SvPVX(name) = '$';
11262 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11264 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11265 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11272 =for apidoc find_uninit_var
11274 Find the name of the undefined variable (if any) that caused the operator o
11275 to issue a "Use of uninitialized value" warning.
11276 If match is true, only return a name if it's value matches uninit_sv.
11277 So roughly speaking, if a unary operator (such as OP_COS) generates a
11278 warning, then following the direct child of the op may yield an
11279 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11280 other hand, with OP_ADD there are two branches to follow, so we only print
11281 the variable name if we get an exact match.
11283 The name is returned as a mortal SV.
11285 Assumes that PL_op is the op that originally triggered the error, and that
11286 PL_comppad/PL_curpad points to the currently executing pad.
11292 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11300 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11301 uninit_sv == &PL_sv_placeholder)))
11304 switch (obase->op_type) {
11311 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11312 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11314 SV *keysv = Nullsv;
11315 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11317 if (pad) { /* @lex, %lex */
11318 sv = PAD_SVl(obase->op_targ);
11322 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11323 /* @global, %global */
11324 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11327 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11329 else /* @{expr}, %{expr} */
11330 return find_uninit_var(cUNOPx(obase)->op_first,
11334 /* attempt to find a match within the aggregate */
11336 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11338 subscript_type = FUV_SUBSCRIPT_HASH;
11341 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11343 subscript_type = FUV_SUBSCRIPT_ARRAY;
11346 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11349 return varname(gv, hash ? '%' : '@', obase->op_targ,
11350 keysv, index, subscript_type);
11354 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11356 return varname(Nullgv, '$', obase->op_targ,
11357 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11360 gv = cGVOPx_gv(obase);
11361 if (!gv || (match && GvSV(gv) != uninit_sv))
11363 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11366 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11369 av = (AV*)PAD_SV(obase->op_targ);
11370 if (!av || SvRMAGICAL(av))
11372 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11373 if (!svp || *svp != uninit_sv)
11376 return varname(Nullgv, '$', obase->op_targ,
11377 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11380 gv = cGVOPx_gv(obase);
11386 if (!av || SvRMAGICAL(av))
11388 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11389 if (!svp || *svp != uninit_sv)
11392 return varname(gv, '$', 0,
11393 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11398 o = cUNOPx(obase)->op_first;
11399 if (!o || o->op_type != OP_NULL ||
11400 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11402 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11406 if (PL_op == obase)
11407 /* $a[uninit_expr] or $h{uninit_expr} */
11408 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11411 o = cBINOPx(obase)->op_first;
11412 kid = cBINOPx(obase)->op_last;
11414 /* get the av or hv, and optionally the gv */
11416 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11417 sv = PAD_SV(o->op_targ);
11419 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11420 && cUNOPo->op_first->op_type == OP_GV)
11422 gv = cGVOPx_gv(cUNOPo->op_first);
11425 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11430 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11431 /* index is constant */
11435 if (obase->op_type == OP_HELEM) {
11436 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11437 if (!he || HeVAL(he) != uninit_sv)
11441 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11442 if (!svp || *svp != uninit_sv)
11446 if (obase->op_type == OP_HELEM)
11447 return varname(gv, '%', o->op_targ,
11448 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11450 return varname(gv, '@', o->op_targ, Nullsv,
11451 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11454 /* index is an expression;
11455 * attempt to find a match within the aggregate */
11456 if (obase->op_type == OP_HELEM) {
11457 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11459 return varname(gv, '%', o->op_targ,
11460 keysv, 0, FUV_SUBSCRIPT_HASH);
11463 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11465 return varname(gv, '@', o->op_targ,
11466 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11471 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11473 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11479 /* only examine RHS */
11480 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11483 o = cUNOPx(obase)->op_first;
11484 if (o->op_type == OP_PUSHMARK)
11487 if (!o->op_sibling) {
11488 /* one-arg version of open is highly magical */
11490 if (o->op_type == OP_GV) { /* open FOO; */
11492 if (match && GvSV(gv) != uninit_sv)
11494 return varname(gv, '$', 0,
11495 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11497 /* other possibilities not handled are:
11498 * open $x; or open my $x; should return '${*$x}'
11499 * open expr; should return '$'.expr ideally
11505 /* ops where $_ may be an implicit arg */
11509 if ( !(obase->op_flags & OPf_STACKED)) {
11510 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11511 ? PAD_SVl(obase->op_targ)
11514 sv = sv_newmortal();
11515 sv_setpvn(sv, "$_", 2);
11523 /* skip filehandle as it can't produce 'undef' warning */
11524 o = cUNOPx(obase)->op_first;
11525 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11526 o = o->op_sibling->op_sibling;
11533 match = 1; /* XS or custom code could trigger random warnings */
11538 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11539 return sv_2mortal(newSVpvs("${$/}"));
11544 if (!(obase->op_flags & OPf_KIDS))
11546 o = cUNOPx(obase)->op_first;
11552 /* if all except one arg are constant, or have no side-effects,
11553 * or are optimized away, then it's unambiguous */
11555 for (kid=o; kid; kid = kid->op_sibling) {
11557 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11558 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11559 || (kid->op_type == OP_PUSHMARK)
11563 if (o2) { /* more than one found */
11570 return find_uninit_var(o2, uninit_sv, match);
11572 /* scan all args */
11574 sv = find_uninit_var(o, uninit_sv, 1);
11586 =for apidoc report_uninit
11588 Print appropriate "Use of uninitialized variable" warning
11594 Perl_report_uninit(pTHX_ SV* uninit_sv)
11598 SV* varname = Nullsv;
11600 varname = find_uninit_var(PL_op, uninit_sv,0);
11602 sv_insert(varname, 0, 0, " ", 1);
11604 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11605 varname ? SvPV_nolen_const(varname) : "",
11606 " in ", OP_DESC(PL_op));
11609 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11615 * c-indentation-style: bsd
11616 * c-basic-offset: 4
11617 * indent-tabs-mode: t
11620 * ex: set ts=8 sts=4 sw=4 noet: