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 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2932 register U32 sflags;
2938 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2940 sstr = &PL_sv_undef;
2941 stype = SvTYPE(sstr);
2942 dtype = SvTYPE(dstr);
2947 /* need to nuke the magic */
2949 SvRMAGICAL_off(dstr);
2952 /* There's a lot of redundancy below but we're going for speed here */
2957 if (dtype != SVt_PVGV) {
2958 (void)SvOK_off(dstr);
2966 sv_upgrade(dstr, SVt_IV);
2969 sv_upgrade(dstr, SVt_PVNV);
2973 sv_upgrade(dstr, SVt_PVIV);
2976 (void)SvIOK_only(dstr);
2977 SvIV_set(dstr, SvIVX(sstr));
2980 if (SvTAINTED(sstr))
2991 sv_upgrade(dstr, SVt_NV);
2996 sv_upgrade(dstr, SVt_PVNV);
2999 SvNV_set(dstr, SvNVX(sstr));
3000 (void)SvNOK_only(dstr);
3001 if (SvTAINTED(sstr))
3009 sv_upgrade(dstr, SVt_RV);
3010 else if (dtype == SVt_PVGV &&
3011 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3014 if (GvIMPORTED(dstr) != GVf_IMPORTED
3015 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3017 GvIMPORTED_on(dstr);
3026 #ifdef PERL_OLD_COPY_ON_WRITE
3027 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3028 if (dtype < SVt_PVIV)
3029 sv_upgrade(dstr, SVt_PVIV);
3036 sv_upgrade(dstr, SVt_PV);
3039 if (dtype < SVt_PVIV)
3040 sv_upgrade(dstr, SVt_PVIV);
3043 if (dtype < SVt_PVNV)
3044 sv_upgrade(dstr, SVt_PVNV);
3051 const char * const type = sv_reftype(sstr,0);
3053 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3055 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3060 if (dtype <= SVt_PVGV) {
3062 if (dtype != SVt_PVGV) {
3063 const char * const name = GvNAME(sstr);
3064 const STRLEN len = GvNAMELEN(sstr);
3065 /* don't upgrade SVt_PVLV: it can hold a glob */
3066 if (dtype != SVt_PVLV)
3067 sv_upgrade(dstr, SVt_PVGV);
3068 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3069 GvSTASH(dstr) = GvSTASH(sstr);
3071 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3072 GvNAME(dstr) = savepvn(name, len);
3073 GvNAMELEN(dstr) = len;
3074 SvFAKE_on(dstr); /* can coerce to non-glob */
3077 #ifdef GV_UNIQUE_CHECK
3078 if (GvUNIQUE((GV*)dstr)) {
3079 Perl_croak(aTHX_ PL_no_modify);
3083 (void)SvOK_off(dstr);
3084 GvINTRO_off(dstr); /* one-shot flag */
3086 GvGP(dstr) = gp_ref(GvGP(sstr));
3087 if (SvTAINTED(sstr))
3089 if (GvIMPORTED(dstr) != GVf_IMPORTED
3090 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3092 GvIMPORTED_on(dstr);
3100 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3102 if ((int)SvTYPE(sstr) != stype) {
3103 stype = SvTYPE(sstr);
3104 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3108 if (stype == SVt_PVLV)
3109 SvUPGRADE(dstr, SVt_PVNV);
3111 SvUPGRADE(dstr, (U32)stype);
3114 sflags = SvFLAGS(sstr);
3116 if (sflags & SVf_ROK) {
3117 if (dtype >= SVt_PV) {
3118 if (dtype == SVt_PVGV) {
3119 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3121 const int intro = GvINTRO(dstr);
3123 #ifdef GV_UNIQUE_CHECK
3124 if (GvUNIQUE((GV*)dstr)) {
3125 Perl_croak(aTHX_ PL_no_modify);
3130 GvINTRO_off(dstr); /* one-shot flag */
3131 GvLINE(dstr) = CopLINE(PL_curcop);
3132 GvEGV(dstr) = (GV*)dstr;
3135 switch (SvTYPE(sref)) {
3138 SAVEGENERICSV(GvAV(dstr));
3140 dref = (SV*)GvAV(dstr);
3141 GvAV(dstr) = (AV*)sref;
3142 if (!GvIMPORTED_AV(dstr)
3143 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3145 GvIMPORTED_AV_on(dstr);
3150 SAVEGENERICSV(GvHV(dstr));
3152 dref = (SV*)GvHV(dstr);
3153 GvHV(dstr) = (HV*)sref;
3154 if (!GvIMPORTED_HV(dstr)
3155 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3157 GvIMPORTED_HV_on(dstr);
3162 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3163 SvREFCNT_dec(GvCV(dstr));
3164 GvCV(dstr) = Nullcv;
3165 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3166 PL_sub_generation++;
3168 SAVEGENERICSV(GvCV(dstr));
3171 dref = (SV*)GvCV(dstr);
3172 if (GvCV(dstr) != (CV*)sref) {
3173 CV* const cv = GvCV(dstr);
3175 if (!GvCVGEN((GV*)dstr) &&
3176 (CvROOT(cv) || CvXSUB(cv)))
3178 /* Redefining a sub - warning is mandatory if
3179 it was a const and its value changed. */
3180 if (CvCONST(cv) && CvCONST((CV*)sref)
3182 == cv_const_sv((CV*)sref)) {
3183 /* They are 2 constant subroutines
3184 generated from the same constant.
3185 This probably means that they are
3186 really the "same" proxy subroutine
3187 instantiated in 2 places. Most likely
3188 this is when a constant is exported
3189 twice. Don't warn. */
3191 else if (ckWARN(WARN_REDEFINE)
3193 && (!CvCONST((CV*)sref)
3194 || sv_cmp(cv_const_sv(cv),
3195 cv_const_sv((CV*)sref)))))
3197 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3199 ? "Constant subroutine %s::%s redefined"
3200 : "Subroutine %s::%s redefined",
3201 HvNAME_get(GvSTASH((GV*)dstr)),
3202 GvENAME((GV*)dstr));
3206 cv_ckproto(cv, (GV*)dstr,
3208 ? SvPVX_const(sref) : Nullch);
3210 GvCV(dstr) = (CV*)sref;
3211 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3212 GvASSUMECV_on(dstr);
3213 PL_sub_generation++;
3215 if (!GvIMPORTED_CV(dstr)
3216 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3218 GvIMPORTED_CV_on(dstr);
3223 SAVEGENERICSV(GvIOp(dstr));
3225 dref = (SV*)GvIOp(dstr);
3226 GvIOp(dstr) = (IO*)sref;
3230 SAVEGENERICSV(GvFORM(dstr));
3232 dref = (SV*)GvFORM(dstr);
3233 GvFORM(dstr) = (CV*)sref;
3237 SAVEGENERICSV(GvSV(dstr));
3239 dref = (SV*)GvSV(dstr);
3241 if (!GvIMPORTED_SV(dstr)
3242 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3244 GvIMPORTED_SV_on(dstr);
3250 if (SvTAINTED(sstr))
3254 if (SvPVX_const(dstr)) {
3260 (void)SvOK_off(dstr);
3261 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3263 if (sflags & SVp_NOK) {
3265 /* Only set the public OK flag if the source has public OK. */
3266 if (sflags & SVf_NOK)
3267 SvFLAGS(dstr) |= SVf_NOK;
3268 SvNV_set(dstr, SvNVX(sstr));
3270 if (sflags & SVp_IOK) {
3271 (void)SvIOKp_on(dstr);
3272 if (sflags & SVf_IOK)
3273 SvFLAGS(dstr) |= SVf_IOK;
3274 if (sflags & SVf_IVisUV)
3276 SvIV_set(dstr, SvIVX(sstr));
3278 if (SvAMAGIC(sstr)) {
3282 else if (sflags & SVp_POK) {
3286 * Check to see if we can just swipe the string. If so, it's a
3287 * possible small lose on short strings, but a big win on long ones.
3288 * It might even be a win on short strings if SvPVX_const(dstr)
3289 * has to be allocated and SvPVX_const(sstr) has to be freed.
3292 /* Whichever path we take through the next code, we want this true,
3293 and doing it now facilitates the COW check. */
3294 (void)SvPOK_only(dstr);
3297 /* We're not already COW */
3298 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3299 #ifndef PERL_OLD_COPY_ON_WRITE
3300 /* or we are, but dstr isn't a suitable target. */
3301 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3306 (sflags & SVs_TEMP) && /* slated for free anyway? */
3307 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3308 (!(flags & SV_NOSTEAL)) &&
3309 /* and we're allowed to steal temps */
3310 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3311 SvLEN(sstr) && /* and really is a string */
3312 /* and won't be needed again, potentially */
3313 !(PL_op && PL_op->op_type == OP_AASSIGN))
3314 #ifdef PERL_OLD_COPY_ON_WRITE
3315 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3316 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3317 && SvTYPE(sstr) >= SVt_PVIV)
3320 /* Failed the swipe test, and it's not a shared hash key either.
3321 Have to copy the string. */
3322 STRLEN len = SvCUR(sstr);
3323 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3324 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3325 SvCUR_set(dstr, len);
3326 *SvEND(dstr) = '\0';
3328 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3330 /* Either it's a shared hash key, or it's suitable for
3331 copy-on-write or we can swipe the string. */
3333 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3337 #ifdef PERL_OLD_COPY_ON_WRITE
3339 /* I believe I should acquire a global SV mutex if
3340 it's a COW sv (not a shared hash key) to stop
3341 it going un copy-on-write.
3342 If the source SV has gone un copy on write between up there
3343 and down here, then (assert() that) it is of the correct
3344 form to make it copy on write again */
3345 if ((sflags & (SVf_FAKE | SVf_READONLY))
3346 != (SVf_FAKE | SVf_READONLY)) {
3347 SvREADONLY_on(sstr);
3349 /* Make the source SV into a loop of 1.
3350 (about to become 2) */
3351 SV_COW_NEXT_SV_SET(sstr, sstr);
3355 /* Initial code is common. */
3356 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3361 /* making another shared SV. */
3362 STRLEN cur = SvCUR(sstr);
3363 STRLEN len = SvLEN(sstr);
3364 #ifdef PERL_OLD_COPY_ON_WRITE
3366 assert (SvTYPE(dstr) >= SVt_PVIV);
3367 /* SvIsCOW_normal */
3368 /* splice us in between source and next-after-source. */
3369 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3370 SV_COW_NEXT_SV_SET(sstr, dstr);
3371 SvPV_set(dstr, SvPVX_mutable(sstr));
3375 /* SvIsCOW_shared_hash */
3376 DEBUG_C(PerlIO_printf(Perl_debug_log,
3377 "Copy on write: Sharing hash\n"));
3379 assert (SvTYPE(dstr) >= SVt_PV);
3381 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3383 SvLEN_set(dstr, len);
3384 SvCUR_set(dstr, cur);
3385 SvREADONLY_on(dstr);
3387 /* Relesase a global SV mutex. */
3390 { /* Passes the swipe test. */
3391 SvPV_set(dstr, SvPVX_mutable(sstr));
3392 SvLEN_set(dstr, SvLEN(sstr));
3393 SvCUR_set(dstr, SvCUR(sstr));
3396 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3397 SvPV_set(sstr, NULL);
3403 if (sflags & SVf_UTF8)
3405 if (sflags & SVp_NOK) {
3407 if (sflags & SVf_NOK)
3408 SvFLAGS(dstr) |= SVf_NOK;
3409 SvNV_set(dstr, SvNVX(sstr));
3411 if (sflags & SVp_IOK) {
3412 (void)SvIOKp_on(dstr);
3413 if (sflags & SVf_IOK)
3414 SvFLAGS(dstr) |= SVf_IOK;
3415 if (sflags & SVf_IVisUV)
3417 SvIV_set(dstr, SvIVX(sstr));
3420 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3421 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3422 smg->mg_ptr, smg->mg_len);
3423 SvRMAGICAL_on(dstr);
3426 else if (sflags & SVp_IOK) {
3427 if (sflags & SVf_IOK)
3428 (void)SvIOK_only(dstr);
3430 (void)SvOK_off(dstr);
3431 (void)SvIOKp_on(dstr);
3433 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3434 if (sflags & SVf_IVisUV)
3436 SvIV_set(dstr, SvIVX(sstr));
3437 if (sflags & SVp_NOK) {
3438 if (sflags & SVf_NOK)
3439 (void)SvNOK_on(dstr);
3441 (void)SvNOKp_on(dstr);
3442 SvNV_set(dstr, SvNVX(sstr));
3445 else if (sflags & SVp_NOK) {
3446 if (sflags & SVf_NOK)
3447 (void)SvNOK_only(dstr);
3449 (void)SvOK_off(dstr);
3452 SvNV_set(dstr, SvNVX(sstr));
3455 if (dtype == SVt_PVGV) {
3456 if (ckWARN(WARN_MISC))
3457 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3460 (void)SvOK_off(dstr);
3462 if (SvTAINTED(sstr))
3467 =for apidoc sv_setsv_mg
3469 Like C<sv_setsv>, but also handles 'set' magic.
3475 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3477 sv_setsv(dstr,sstr);
3481 #ifdef PERL_OLD_COPY_ON_WRITE
3483 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3485 STRLEN cur = SvCUR(sstr);
3486 STRLEN len = SvLEN(sstr);
3487 register char *new_pv;
3490 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3498 if (SvTHINKFIRST(dstr))
3499 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3500 else if (SvPVX_const(dstr))
3501 Safefree(SvPVX_const(dstr));
3505 SvUPGRADE(dstr, SVt_PVIV);
3507 assert (SvPOK(sstr));
3508 assert (SvPOKp(sstr));
3509 assert (!SvIOK(sstr));
3510 assert (!SvIOKp(sstr));
3511 assert (!SvNOK(sstr));
3512 assert (!SvNOKp(sstr));
3514 if (SvIsCOW(sstr)) {
3516 if (SvLEN(sstr) == 0) {
3517 /* source is a COW shared hash key. */
3518 DEBUG_C(PerlIO_printf(Perl_debug_log,
3519 "Fast copy on write: Sharing hash\n"));
3520 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3523 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3525 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3526 SvUPGRADE(sstr, SVt_PVIV);
3527 SvREADONLY_on(sstr);
3529 DEBUG_C(PerlIO_printf(Perl_debug_log,
3530 "Fast copy on write: Converting sstr to COW\n"));
3531 SV_COW_NEXT_SV_SET(dstr, sstr);
3533 SV_COW_NEXT_SV_SET(sstr, dstr);
3534 new_pv = SvPVX_mutable(sstr);
3537 SvPV_set(dstr, new_pv);
3538 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3541 SvLEN_set(dstr, len);
3542 SvCUR_set(dstr, cur);
3551 =for apidoc sv_setpvn
3553 Copies a string into an SV. The C<len> parameter indicates the number of
3554 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3555 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3561 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3564 register char *dptr;
3566 SV_CHECK_THINKFIRST_COW_DROP(sv);
3572 /* len is STRLEN which is unsigned, need to copy to signed */
3575 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3577 SvUPGRADE(sv, SVt_PV);
3579 dptr = SvGROW(sv, len + 1);
3580 Move(ptr,dptr,len,char);
3583 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3588 =for apidoc sv_setpvn_mg
3590 Like C<sv_setpvn>, but also handles 'set' magic.
3596 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3598 sv_setpvn(sv,ptr,len);
3603 =for apidoc sv_setpv
3605 Copies a string into an SV. The string must be null-terminated. Does not
3606 handle 'set' magic. See C<sv_setpv_mg>.
3612 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3615 register STRLEN len;
3617 SV_CHECK_THINKFIRST_COW_DROP(sv);
3623 SvUPGRADE(sv, SVt_PV);
3625 SvGROW(sv, len + 1);
3626 Move(ptr,SvPVX(sv),len+1,char);
3628 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3633 =for apidoc sv_setpv_mg
3635 Like C<sv_setpv>, but also handles 'set' magic.
3641 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3648 =for apidoc sv_usepvn
3650 Tells an SV to use C<ptr> to find its string value. Normally the string is
3651 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3652 The C<ptr> should point to memory that was allocated by C<malloc>. The
3653 string length, C<len>, must be supplied. This function will realloc the
3654 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3655 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3656 See C<sv_usepvn_mg>.
3662 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3666 SV_CHECK_THINKFIRST_COW_DROP(sv);
3667 SvUPGRADE(sv, SVt_PV);
3672 if (SvPVX_const(sv))
3675 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3676 ptr = saferealloc (ptr, allocate);
3679 SvLEN_set(sv, allocate);
3681 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3686 =for apidoc sv_usepvn_mg
3688 Like C<sv_usepvn>, but also handles 'set' magic.
3694 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3696 sv_usepvn(sv,ptr,len);
3700 #ifdef PERL_OLD_COPY_ON_WRITE
3701 /* Need to do this *after* making the SV normal, as we need the buffer
3702 pointer to remain valid until after we've copied it. If we let go too early,
3703 another thread could invalidate it by unsharing last of the same hash key
3704 (which it can do by means other than releasing copy-on-write Svs)
3705 or by changing the other copy-on-write SVs in the loop. */
3707 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3709 if (len) { /* this SV was SvIsCOW_normal(sv) */
3710 /* we need to find the SV pointing to us. */
3711 SV * const current = SV_COW_NEXT_SV(after);
3713 if (current == sv) {
3714 /* The SV we point to points back to us (there were only two of us
3716 Hence other SV is no longer copy on write either. */
3718 SvREADONLY_off(after);
3720 /* We need to follow the pointers around the loop. */
3722 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3725 /* don't loop forever if the structure is bust, and we have
3726 a pointer into a closed loop. */
3727 assert (current != after);
3728 assert (SvPVX_const(current) == pvx);
3730 /* Make the SV before us point to the SV after us. */
3731 SV_COW_NEXT_SV_SET(current, after);
3734 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3739 Perl_sv_release_IVX(pTHX_ register SV *sv)
3742 sv_force_normal_flags(sv, 0);
3748 =for apidoc sv_force_normal_flags
3750 Undo various types of fakery on an SV: if the PV is a shared string, make
3751 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3752 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3753 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3754 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3755 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3756 set to some other value.) In addition, the C<flags> parameter gets passed to
3757 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3758 with flags set to 0.
3764 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3767 #ifdef PERL_OLD_COPY_ON_WRITE
3768 if (SvREADONLY(sv)) {
3769 /* At this point I believe I should acquire a global SV mutex. */
3771 const char * const pvx = SvPVX_const(sv);
3772 const STRLEN len = SvLEN(sv);
3773 const STRLEN cur = SvCUR(sv);
3774 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3776 PerlIO_printf(Perl_debug_log,
3777 "Copy on write: Force normal %ld\n",
3783 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3786 if (flags & SV_COW_DROP_PV) {
3787 /* OK, so we don't need to copy our buffer. */
3790 SvGROW(sv, cur + 1);
3791 Move(pvx,SvPVX(sv),cur,char);
3795 sv_release_COW(sv, pvx, len, next);
3800 else if (IN_PERL_RUNTIME)
3801 Perl_croak(aTHX_ PL_no_modify);
3802 /* At this point I believe that I can drop the global SV mutex. */
3805 if (SvREADONLY(sv)) {
3807 const char * const pvx = SvPVX_const(sv);
3808 const STRLEN len = SvCUR(sv);
3811 SvPV_set(sv, Nullch);
3813 SvGROW(sv, len + 1);
3814 Move(pvx,SvPVX(sv),len,char);
3816 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3818 else if (IN_PERL_RUNTIME)
3819 Perl_croak(aTHX_ PL_no_modify);
3823 sv_unref_flags(sv, flags);
3824 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3831 Efficient removal of characters from the beginning of the string buffer.
3832 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3833 the string buffer. The C<ptr> becomes the first character of the adjusted
3834 string. Uses the "OOK hack".
3835 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3836 refer to the same chunk of data.
3842 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3844 register STRLEN delta;
3845 if (!ptr || !SvPOKp(sv))
3847 delta = ptr - SvPVX_const(sv);
3848 SV_CHECK_THINKFIRST(sv);
3849 if (SvTYPE(sv) < SVt_PVIV)
3850 sv_upgrade(sv,SVt_PVIV);
3853 if (!SvLEN(sv)) { /* make copy of shared string */
3854 const char *pvx = SvPVX_const(sv);
3855 const STRLEN len = SvCUR(sv);
3856 SvGROW(sv, len + 1);
3857 Move(pvx,SvPVX(sv),len,char);
3861 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3862 and we do that anyway inside the SvNIOK_off
3864 SvFLAGS(sv) |= SVf_OOK;
3867 SvLEN_set(sv, SvLEN(sv) - delta);
3868 SvCUR_set(sv, SvCUR(sv) - delta);
3869 SvPV_set(sv, SvPVX(sv) + delta);
3870 SvIV_set(sv, SvIVX(sv) + delta);
3874 =for apidoc sv_catpvn
3876 Concatenates the string onto the end of the string which is in the SV. The
3877 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3878 status set, then the bytes appended should be valid UTF-8.
3879 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3881 =for apidoc sv_catpvn_flags
3883 Concatenates the string onto the end of the string which is in the SV. The
3884 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3885 status set, then the bytes appended should be valid UTF-8.
3886 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3887 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3888 in terms of this function.
3894 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3898 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3900 SvGROW(dsv, dlen + slen + 1);
3902 sstr = SvPVX_const(dsv);
3903 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3904 SvCUR_set(dsv, SvCUR(dsv) + slen);
3906 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3908 if (flags & SV_SMAGIC)
3913 =for apidoc sv_catsv
3915 Concatenates the string from SV C<ssv> onto the end of the string in
3916 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3917 not 'set' magic. See C<sv_catsv_mg>.
3919 =for apidoc sv_catsv_flags
3921 Concatenates the string from SV C<ssv> onto the end of the string in
3922 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3923 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3924 and C<sv_catsv_nomg> are implemented in terms of this function.
3929 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3934 const char *spv = SvPV_const(ssv, slen);
3936 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3937 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3938 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3939 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3940 dsv->sv_flags doesn't have that bit set.
3941 Andy Dougherty 12 Oct 2001
3943 const I32 sutf8 = DO_UTF8(ssv);
3946 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3948 dutf8 = DO_UTF8(dsv);
3950 if (dutf8 != sutf8) {
3952 /* Not modifying source SV, so taking a temporary copy. */
3953 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3955 sv_utf8_upgrade(csv);
3956 spv = SvPV_const(csv, slen);
3959 sv_utf8_upgrade_nomg(dsv);
3961 sv_catpvn_nomg(dsv, spv, slen);
3964 if (flags & SV_SMAGIC)
3969 =for apidoc sv_catpv
3971 Concatenates the string onto the end of the string which is in the SV.
3972 If the SV has the UTF-8 status set, then the bytes appended should be
3973 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3978 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3981 register STRLEN len;
3987 junk = SvPV_force(sv, tlen);
3989 SvGROW(sv, tlen + len + 1);
3991 ptr = SvPVX_const(sv);
3992 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3993 SvCUR_set(sv, SvCUR(sv) + len);
3994 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3999 =for apidoc sv_catpv_mg
4001 Like C<sv_catpv>, but also handles 'set' magic.
4007 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4016 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4017 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4024 Perl_newSV(pTHX_ STRLEN len)
4031 sv_upgrade(sv, SVt_PV);
4032 SvGROW(sv, len + 1);
4037 =for apidoc sv_magicext
4039 Adds magic to an SV, upgrading it if necessary. Applies the
4040 supplied vtable and returns a pointer to the magic added.
4042 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4043 In particular, you can add magic to SvREADONLY SVs, and add more than
4044 one instance of the same 'how'.
4046 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4047 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4048 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4049 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4051 (This is now used as a subroutine by C<sv_magic>.)
4056 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4057 const char* name, I32 namlen)
4062 if (SvTYPE(sv) < SVt_PVMG) {
4063 SvUPGRADE(sv, SVt_PVMG);
4065 Newxz(mg, 1, MAGIC);
4066 mg->mg_moremagic = SvMAGIC(sv);
4067 SvMAGIC_set(sv, mg);
4069 /* Sometimes a magic contains a reference loop, where the sv and
4070 object refer to each other. To prevent a reference loop that
4071 would prevent such objects being freed, we look for such loops
4072 and if we find one we avoid incrementing the object refcount.
4074 Note we cannot do this to avoid self-tie loops as intervening RV must
4075 have its REFCNT incremented to keep it in existence.
4078 if (!obj || obj == sv ||
4079 how == PERL_MAGIC_arylen ||
4080 how == PERL_MAGIC_qr ||
4081 how == PERL_MAGIC_symtab ||
4082 (SvTYPE(obj) == SVt_PVGV &&
4083 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4084 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4085 GvFORM(obj) == (CV*)sv)))
4090 mg->mg_obj = SvREFCNT_inc(obj);
4091 mg->mg_flags |= MGf_REFCOUNTED;
4094 /* Normal self-ties simply pass a null object, and instead of
4095 using mg_obj directly, use the SvTIED_obj macro to produce a
4096 new RV as needed. For glob "self-ties", we are tieing the PVIO
4097 with an RV obj pointing to the glob containing the PVIO. In
4098 this case, to avoid a reference loop, we need to weaken the
4102 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4103 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4109 mg->mg_len = namlen;
4112 mg->mg_ptr = savepvn(name, namlen);
4113 else if (namlen == HEf_SVKEY)
4114 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4116 mg->mg_ptr = (char *) name;
4118 mg->mg_virtual = vtable;
4122 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4127 =for apidoc sv_magic
4129 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4130 then adds a new magic item of type C<how> to the head of the magic list.
4132 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4133 handling of the C<name> and C<namlen> arguments.
4135 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4136 to add more than one instance of the same 'how'.
4142 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4145 const MGVTBL *vtable;
4148 #ifdef PERL_OLD_COPY_ON_WRITE
4150 sv_force_normal_flags(sv, 0);
4152 if (SvREADONLY(sv)) {
4154 /* its okay to attach magic to shared strings; the subsequent
4155 * upgrade to PVMG will unshare the string */
4156 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4159 && how != PERL_MAGIC_regex_global
4160 && how != PERL_MAGIC_bm
4161 && how != PERL_MAGIC_fm
4162 && how != PERL_MAGIC_sv
4163 && how != PERL_MAGIC_backref
4166 Perl_croak(aTHX_ PL_no_modify);
4169 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4170 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4171 /* sv_magic() refuses to add a magic of the same 'how' as an
4174 if (how == PERL_MAGIC_taint)
4182 vtable = &PL_vtbl_sv;
4184 case PERL_MAGIC_overload:
4185 vtable = &PL_vtbl_amagic;
4187 case PERL_MAGIC_overload_elem:
4188 vtable = &PL_vtbl_amagicelem;
4190 case PERL_MAGIC_overload_table:
4191 vtable = &PL_vtbl_ovrld;
4194 vtable = &PL_vtbl_bm;
4196 case PERL_MAGIC_regdata:
4197 vtable = &PL_vtbl_regdata;
4199 case PERL_MAGIC_regdatum:
4200 vtable = &PL_vtbl_regdatum;
4202 case PERL_MAGIC_env:
4203 vtable = &PL_vtbl_env;
4206 vtable = &PL_vtbl_fm;
4208 case PERL_MAGIC_envelem:
4209 vtable = &PL_vtbl_envelem;
4211 case PERL_MAGIC_regex_global:
4212 vtable = &PL_vtbl_mglob;
4214 case PERL_MAGIC_isa:
4215 vtable = &PL_vtbl_isa;
4217 case PERL_MAGIC_isaelem:
4218 vtable = &PL_vtbl_isaelem;
4220 case PERL_MAGIC_nkeys:
4221 vtable = &PL_vtbl_nkeys;
4223 case PERL_MAGIC_dbfile:
4226 case PERL_MAGIC_dbline:
4227 vtable = &PL_vtbl_dbline;
4229 #ifdef USE_LOCALE_COLLATE
4230 case PERL_MAGIC_collxfrm:
4231 vtable = &PL_vtbl_collxfrm;
4233 #endif /* USE_LOCALE_COLLATE */
4234 case PERL_MAGIC_tied:
4235 vtable = &PL_vtbl_pack;
4237 case PERL_MAGIC_tiedelem:
4238 case PERL_MAGIC_tiedscalar:
4239 vtable = &PL_vtbl_packelem;
4242 vtable = &PL_vtbl_regexp;
4244 case PERL_MAGIC_sig:
4245 vtable = &PL_vtbl_sig;
4247 case PERL_MAGIC_sigelem:
4248 vtable = &PL_vtbl_sigelem;
4250 case PERL_MAGIC_taint:
4251 vtable = &PL_vtbl_taint;
4253 case PERL_MAGIC_uvar:
4254 vtable = &PL_vtbl_uvar;
4256 case PERL_MAGIC_vec:
4257 vtable = &PL_vtbl_vec;
4259 case PERL_MAGIC_arylen_p:
4260 case PERL_MAGIC_rhash:
4261 case PERL_MAGIC_symtab:
4262 case PERL_MAGIC_vstring:
4265 case PERL_MAGIC_utf8:
4266 vtable = &PL_vtbl_utf8;
4268 case PERL_MAGIC_substr:
4269 vtable = &PL_vtbl_substr;
4271 case PERL_MAGIC_defelem:
4272 vtable = &PL_vtbl_defelem;
4274 case PERL_MAGIC_glob:
4275 vtable = &PL_vtbl_glob;
4277 case PERL_MAGIC_arylen:
4278 vtable = &PL_vtbl_arylen;
4280 case PERL_MAGIC_pos:
4281 vtable = &PL_vtbl_pos;
4283 case PERL_MAGIC_backref:
4284 vtable = &PL_vtbl_backref;
4286 case PERL_MAGIC_ext:
4287 /* Reserved for use by extensions not perl internals. */
4288 /* Useful for attaching extension internal data to perl vars. */
4289 /* Note that multiple extensions may clash if magical scalars */
4290 /* etc holding private data from one are passed to another. */
4294 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4297 /* Rest of work is done else where */
4298 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4301 case PERL_MAGIC_taint:
4304 case PERL_MAGIC_ext:
4305 case PERL_MAGIC_dbfile:
4312 =for apidoc sv_unmagic
4314 Removes all magic of type C<type> from an SV.
4320 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4324 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4327 for (mg = *mgp; mg; mg = *mgp) {
4328 if (mg->mg_type == type) {
4329 const MGVTBL* const vtbl = mg->mg_virtual;
4330 *mgp = mg->mg_moremagic;
4331 if (vtbl && vtbl->svt_free)
4332 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4333 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4335 Safefree(mg->mg_ptr);
4336 else if (mg->mg_len == HEf_SVKEY)
4337 SvREFCNT_dec((SV*)mg->mg_ptr);
4338 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4339 Safefree(mg->mg_ptr);
4341 if (mg->mg_flags & MGf_REFCOUNTED)
4342 SvREFCNT_dec(mg->mg_obj);
4346 mgp = &mg->mg_moremagic;
4350 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4351 SvMAGIC_set(sv, NULL);
4358 =for apidoc sv_rvweaken
4360 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4361 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4362 push a back-reference to this RV onto the array of backreferences
4363 associated with that magic.
4369 Perl_sv_rvweaken(pTHX_ SV *sv)
4372 if (!SvOK(sv)) /* let undefs pass */
4375 Perl_croak(aTHX_ "Can't weaken a nonreference");
4376 else if (SvWEAKREF(sv)) {
4377 if (ckWARN(WARN_MISC))
4378 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4382 Perl_sv_add_backref(aTHX_ tsv, sv);
4388 /* Give tsv backref magic if it hasn't already got it, then push a
4389 * back-reference to sv onto the array associated with the backref magic.
4393 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4398 if (SvTYPE(tsv) == SVt_PVHV) {
4399 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4403 /* There is no AV in the offical place - try a fixup. */
4404 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4407 /* Aha. They've got it stowed in magic. Bring it back. */
4408 av = (AV*)mg->mg_obj;
4409 /* Stop mg_free decreasing the refernce count. */
4411 /* Stop mg_free even calling the destructor, given that
4412 there's no AV to free up. */
4414 sv_unmagic(tsv, PERL_MAGIC_backref);
4423 const MAGIC *const mg
4424 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4426 av = (AV*)mg->mg_obj;
4430 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4431 /* av now has a refcnt of 2, which avoids it getting freed
4432 * before us during global cleanup. The extra ref is removed
4433 * by magic_killbackrefs() when tsv is being freed */
4436 if (AvFILLp(av) >= AvMAX(av)) {
4437 av_extend(av, AvFILLp(av)+1);
4439 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4442 /* delete a back-reference to ourselves from the backref magic associated
4443 * with the SV we point to.
4447 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4454 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4455 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4456 /* We mustn't attempt to "fix up" the hash here by moving the
4457 backreference array back to the hv_aux structure, as that is stored
4458 in the main HvARRAY(), and hfreentries assumes that no-one
4459 reallocates HvARRAY() while it is running. */
4462 const MAGIC *const mg
4463 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4465 av = (AV *)mg->mg_obj;
4468 if (PL_in_clean_all)
4470 Perl_croak(aTHX_ "panic: del_backref");
4477 /* We shouldn't be in here more than once, but for paranoia reasons lets
4479 for (i = AvFILLp(av); i >= 0; i--) {
4481 const SSize_t fill = AvFILLp(av);
4483 /* We weren't the last entry.
4484 An unordered list has this property that you can take the
4485 last element off the end to fill the hole, and it's still
4486 an unordered list :-)
4491 AvFILLp(av) = fill - 1;
4497 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4499 SV **svp = AvARRAY(av);
4501 PERL_UNUSED_ARG(sv);
4503 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4504 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4505 if (svp && !SvIS_FREED(av)) {
4506 SV *const *const last = svp + AvFILLp(av);
4508 while (svp <= last) {
4510 SV *const referrer = *svp;
4511 if (SvWEAKREF(referrer)) {
4512 /* XXX Should we check that it hasn't changed? */
4513 SvRV_set(referrer, 0);
4515 SvWEAKREF_off(referrer);
4516 } else if (SvTYPE(referrer) == SVt_PVGV ||
4517 SvTYPE(referrer) == SVt_PVLV) {
4518 /* You lookin' at me? */
4519 assert(GvSTASH(referrer));
4520 assert(GvSTASH(referrer) == (HV*)sv);
4521 GvSTASH(referrer) = 0;
4524 "panic: magic_killbackrefs (flags=%"UVxf")",
4525 (UV)SvFLAGS(referrer));
4533 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4538 =for apidoc sv_insert
4540 Inserts a string at the specified offset/length within the SV. Similar to
4541 the Perl substr() function.
4547 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4552 register char *midend;
4553 register char *bigend;
4559 Perl_croak(aTHX_ "Can't modify non-existent substring");
4560 SvPV_force(bigstr, curlen);
4561 (void)SvPOK_only_UTF8(bigstr);
4562 if (offset + len > curlen) {
4563 SvGROW(bigstr, offset+len+1);
4564 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4565 SvCUR_set(bigstr, offset+len);
4569 i = littlelen - len;
4570 if (i > 0) { /* string might grow */
4571 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4572 mid = big + offset + len;
4573 midend = bigend = big + SvCUR(bigstr);
4576 while (midend > mid) /* shove everything down */
4577 *--bigend = *--midend;
4578 Move(little,big+offset,littlelen,char);
4579 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4584 Move(little,SvPVX(bigstr)+offset,len,char);
4589 big = SvPVX(bigstr);
4592 bigend = big + SvCUR(bigstr);
4594 if (midend > bigend)
4595 Perl_croak(aTHX_ "panic: sv_insert");
4597 if (mid - big > bigend - midend) { /* faster to shorten from end */
4599 Move(little, mid, littlelen,char);
4602 i = bigend - midend;
4604 Move(midend, mid, i,char);
4608 SvCUR_set(bigstr, mid - big);
4610 else if ((i = mid - big)) { /* faster from front */
4611 midend -= littlelen;
4613 sv_chop(bigstr,midend-i);
4618 Move(little, mid, littlelen,char);
4620 else if (littlelen) {
4621 midend -= littlelen;
4622 sv_chop(bigstr,midend);
4623 Move(little,midend,littlelen,char);
4626 sv_chop(bigstr,midend);
4632 =for apidoc sv_replace
4634 Make the first argument a copy of the second, then delete the original.
4635 The target SV physically takes over ownership of the body of the source SV
4636 and inherits its flags; however, the target keeps any magic it owns,
4637 and any magic in the source is discarded.
4638 Note that this is a rather specialist SV copying operation; most of the
4639 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4645 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4648 const U32 refcnt = SvREFCNT(sv);
4649 SV_CHECK_THINKFIRST_COW_DROP(sv);
4650 if (SvREFCNT(nsv) != 1) {
4651 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4652 UVuf " != 1)", (UV) SvREFCNT(nsv));
4654 if (SvMAGICAL(sv)) {
4658 sv_upgrade(nsv, SVt_PVMG);
4659 SvMAGIC_set(nsv, SvMAGIC(sv));
4660 SvFLAGS(nsv) |= SvMAGICAL(sv);
4662 SvMAGIC_set(sv, NULL);
4666 assert(!SvREFCNT(sv));
4667 #ifdef DEBUG_LEAKING_SCALARS
4668 sv->sv_flags = nsv->sv_flags;
4669 sv->sv_any = nsv->sv_any;
4670 sv->sv_refcnt = nsv->sv_refcnt;
4671 sv->sv_u = nsv->sv_u;
4673 StructCopy(nsv,sv,SV);
4675 /* Currently could join these into one piece of pointer arithmetic, but
4676 it would be unclear. */
4677 if(SvTYPE(sv) == SVt_IV)
4679 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4680 else if (SvTYPE(sv) == SVt_RV) {
4681 SvANY(sv) = &sv->sv_u.svu_rv;
4685 #ifdef PERL_OLD_COPY_ON_WRITE
4686 if (SvIsCOW_normal(nsv)) {
4687 /* We need to follow the pointers around the loop to make the
4688 previous SV point to sv, rather than nsv. */
4691 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4694 assert(SvPVX_const(current) == SvPVX_const(nsv));
4696 /* Make the SV before us point to the SV after us. */
4698 PerlIO_printf(Perl_debug_log, "previous is\n");
4700 PerlIO_printf(Perl_debug_log,
4701 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4702 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4704 SV_COW_NEXT_SV_SET(current, sv);
4707 SvREFCNT(sv) = refcnt;
4708 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4714 =for apidoc sv_clear
4716 Clear an SV: call any destructors, free up any memory used by the body,
4717 and free the body itself. The SV's head is I<not> freed, although
4718 its type is set to all 1's so that it won't inadvertently be assumed
4719 to be live during global destruction etc.
4720 This function should only be called when REFCNT is zero. Most of the time
4721 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4728 Perl_sv_clear(pTHX_ register SV *sv)
4731 const U32 type = SvTYPE(sv);
4732 const struct body_details *const sv_type_details
4733 = bodies_by_type + type;
4736 assert(SvREFCNT(sv) == 0);
4742 if (PL_defstash) { /* Still have a symbol table? */
4747 stash = SvSTASH(sv);
4748 destructor = StashHANDLER(stash,DESTROY);
4750 SV* const tmpref = newRV(sv);
4751 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4753 PUSHSTACKi(PERLSI_DESTROY);
4758 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4764 if(SvREFCNT(tmpref) < 2) {
4765 /* tmpref is not kept alive! */
4767 SvRV_set(tmpref, NULL);
4770 SvREFCNT_dec(tmpref);
4772 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4776 if (PL_in_clean_objs)
4777 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4779 /* DESTROY gave object new lease on life */
4785 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4786 SvOBJECT_off(sv); /* Curse the object. */
4787 if (type != SVt_PVIO)
4788 --PL_sv_objcount; /* XXX Might want something more general */
4791 if (type >= SVt_PVMG) {
4794 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4795 SvREFCNT_dec(SvSTASH(sv));
4800 IoIFP(sv) != PerlIO_stdin() &&
4801 IoIFP(sv) != PerlIO_stdout() &&
4802 IoIFP(sv) != PerlIO_stderr())
4804 io_close((IO*)sv, FALSE);
4806 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4807 PerlDir_close(IoDIRP(sv));
4808 IoDIRP(sv) = (DIR*)NULL;
4809 Safefree(IoTOP_NAME(sv));
4810 Safefree(IoFMT_NAME(sv));
4811 Safefree(IoBOTTOM_NAME(sv));
4820 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4827 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4828 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4829 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4830 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4832 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4833 SvREFCNT_dec(LvTARG(sv));
4837 Safefree(GvNAME(sv));
4838 /* If we're in a stash, we don't own a reference to it. However it does
4839 have a back reference to us, which needs to be cleared. */
4841 sv_del_backref((SV*)GvSTASH(sv), sv);
4846 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4848 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4849 /* Don't even bother with turning off the OOK flag. */
4854 SV *target = SvRV(sv);
4856 sv_del_backref(target, sv);
4858 SvREFCNT_dec(target);
4860 #ifdef PERL_OLD_COPY_ON_WRITE
4861 else if (SvPVX_const(sv)) {
4863 /* I believe I need to grab the global SV mutex here and
4864 then recheck the COW status. */
4866 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4869 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4870 SV_COW_NEXT_SV(sv));
4871 /* And drop it here. */
4873 } else if (SvLEN(sv)) {
4874 Safefree(SvPVX_const(sv));
4878 else if (SvPVX_const(sv) && SvLEN(sv))
4879 Safefree(SvPVX_mutable(sv));
4880 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4881 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4890 SvFLAGS(sv) &= SVf_BREAK;
4891 SvFLAGS(sv) |= SVTYPEMASK;
4893 if (sv_type_details->arena) {
4894 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4895 &PL_body_roots[type]);
4897 else if (sv_type_details->size) {
4898 my_safefree(SvANY(sv));
4903 =for apidoc sv_newref
4905 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4912 Perl_sv_newref(pTHX_ SV *sv)
4922 Decrement an SV's reference count, and if it drops to zero, call
4923 C<sv_clear> to invoke destructors and free up any memory used by
4924 the body; finally, deallocate the SV's head itself.
4925 Normally called via a wrapper macro C<SvREFCNT_dec>.
4931 Perl_sv_free(pTHX_ SV *sv)
4936 if (SvREFCNT(sv) == 0) {
4937 if (SvFLAGS(sv) & SVf_BREAK)
4938 /* this SV's refcnt has been artificially decremented to
4939 * trigger cleanup */
4941 if (PL_in_clean_all) /* All is fair */
4943 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4944 /* make sure SvREFCNT(sv)==0 happens very seldom */
4945 SvREFCNT(sv) = (~(U32)0)/2;
4948 if (ckWARN_d(WARN_INTERNAL)) {
4949 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4950 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4951 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4952 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4953 Perl_dump_sv_child(aTHX_ sv);
4958 if (--(SvREFCNT(sv)) > 0)
4960 Perl_sv_free2(aTHX_ sv);
4964 Perl_sv_free2(pTHX_ SV *sv)
4969 if (ckWARN_d(WARN_DEBUGGING))
4970 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4971 "Attempt to free temp prematurely: SV 0x%"UVxf
4972 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4976 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4977 /* make sure SvREFCNT(sv)==0 happens very seldom */
4978 SvREFCNT(sv) = (~(U32)0)/2;
4989 Returns the length of the string in the SV. Handles magic and type
4990 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4996 Perl_sv_len(pTHX_ register SV *sv)
5004 len = mg_length(sv);
5006 (void)SvPV_const(sv, len);
5011 =for apidoc sv_len_utf8
5013 Returns the number of characters in the string in an SV, counting wide
5014 UTF-8 bytes as a single character. Handles magic and type coercion.
5020 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5021 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5022 * (Note that the mg_len is not the length of the mg_ptr field.)
5027 Perl_sv_len_utf8(pTHX_ register SV *sv)
5033 return mg_length(sv);
5037 const U8 *s = (U8*)SvPV_const(sv, len);
5038 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5040 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5042 #ifdef PERL_UTF8_CACHE_ASSERT
5043 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5047 ulen = Perl_utf8_length(aTHX_ s, s + len);
5048 if (!mg && !SvREADONLY(sv)) {
5049 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5050 mg = mg_find(sv, PERL_MAGIC_utf8);
5060 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5061 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5062 * between UTF-8 and byte offsets. There are two (substr offset and substr
5063 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5064 * and byte offset) cache positions.
5066 * The mg_len field is used by sv_len_utf8(), see its comments.
5067 * Note that the mg_len is not the length of the mg_ptr field.
5071 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5072 I32 offsetp, const U8 *s, const U8 *start)
5076 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5078 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5082 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5084 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5085 (*mgp)->mg_ptr = (char *) *cachep;
5089 (*cachep)[i] = offsetp;
5090 (*cachep)[i+1] = s - start;
5098 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5099 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5100 * between UTF-8 and byte offsets. See also the comments of
5101 * S_utf8_mg_pos_init().
5105 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)
5109 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5111 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5112 if (*mgp && (*mgp)->mg_ptr) {
5113 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5114 ASSERT_UTF8_CACHE(*cachep);
5115 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5117 else { /* We will skip to the right spot. */
5122 /* The assumption is that going backward is half
5123 * the speed of going forward (that's where the
5124 * 2 * backw in the below comes from). (The real
5125 * figure of course depends on the UTF-8 data.) */
5127 if ((*cachep)[i] > (STRLEN)uoff) {
5129 backw = (*cachep)[i] - (STRLEN)uoff;
5131 if (forw < 2 * backw)
5134 p = start + (*cachep)[i+1];
5136 /* Try this only for the substr offset (i == 0),
5137 * not for the substr length (i == 2). */
5138 else if (i == 0) { /* (*cachep)[i] < uoff */
5139 const STRLEN ulen = sv_len_utf8(sv);
5141 if ((STRLEN)uoff < ulen) {
5142 forw = (STRLEN)uoff - (*cachep)[i];
5143 backw = ulen - (STRLEN)uoff;
5145 if (forw < 2 * backw)
5146 p = start + (*cachep)[i+1];
5151 /* If the string is not long enough for uoff,
5152 * we could extend it, but not at this low a level. */
5156 if (forw < 2 * backw) {
5163 while (UTF8_IS_CONTINUATION(*p))
5168 /* Update the cache. */
5169 (*cachep)[i] = (STRLEN)uoff;
5170 (*cachep)[i+1] = p - start;
5172 /* Drop the stale "length" cache */
5181 if (found) { /* Setup the return values. */
5182 *offsetp = (*cachep)[i+1];
5183 *sp = start + *offsetp;
5186 *offsetp = send - start;
5188 else if (*sp < start) {
5194 #ifdef PERL_UTF8_CACHE_ASSERT
5199 while (n-- && s < send)
5203 assert(*offsetp == s - start);
5204 assert((*cachep)[0] == (STRLEN)uoff);
5205 assert((*cachep)[1] == *offsetp);
5207 ASSERT_UTF8_CACHE(*cachep);
5216 =for apidoc sv_pos_u2b
5218 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5219 the start of the string, to a count of the equivalent number of bytes; if
5220 lenp is non-zero, it does the same to lenp, but this time starting from
5221 the offset, rather than from the start of the string. Handles magic and
5228 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5229 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5230 * byte offsets. See also the comments of S_utf8_mg_pos().
5235 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5243 start = (U8*)SvPV_const(sv, len);
5246 STRLEN *cache = NULL;
5247 const U8 *s = start;
5248 I32 uoffset = *offsetp;
5249 const U8 * const send = s + len;
5251 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5253 if (!found && uoffset > 0) {
5254 while (s < send && uoffset--)
5258 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5260 *offsetp = s - start;
5265 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5269 if (!found && *lenp > 0) {
5272 while (s < send && ulen--)
5276 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5280 ASSERT_UTF8_CACHE(cache);
5292 =for apidoc sv_pos_b2u
5294 Converts the value pointed to by offsetp from a count of bytes from the
5295 start of the string, to a count of the equivalent number of UTF-8 chars.
5296 Handles magic and type coercion.
5302 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5303 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5304 * byte offsets. See also the comments of S_utf8_mg_pos().
5309 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5317 s = (const U8*)SvPV_const(sv, len);
5318 if ((I32)len < *offsetp)
5319 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5321 const U8* send = s + *offsetp;
5323 STRLEN *cache = NULL;
5327 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5328 mg = mg_find(sv, PERL_MAGIC_utf8);
5329 if (mg && mg->mg_ptr) {
5330 cache = (STRLEN *) mg->mg_ptr;
5331 if (cache[1] == (STRLEN)*offsetp) {
5332 /* An exact match. */
5333 *offsetp = cache[0];
5337 else if (cache[1] < (STRLEN)*offsetp) {
5338 /* We already know part of the way. */
5341 /* Let the below loop do the rest. */
5343 else { /* cache[1] > *offsetp */
5344 /* We already know all of the way, now we may
5345 * be able to walk back. The same assumption
5346 * is made as in S_utf8_mg_pos(), namely that
5347 * walking backward is twice slower than
5348 * walking forward. */
5349 const STRLEN forw = *offsetp;
5350 STRLEN backw = cache[1] - *offsetp;
5352 if (!(forw < 2 * backw)) {
5353 const U8 *p = s + cache[1];
5360 while (UTF8_IS_CONTINUATION(*p)) {
5368 *offsetp = cache[0];
5370 /* Drop the stale "length" cache */
5378 ASSERT_UTF8_CACHE(cache);
5384 /* Call utf8n_to_uvchr() to validate the sequence
5385 * (unless a simple non-UTF character) */
5386 if (!UTF8_IS_INVARIANT(*s))
5387 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5396 if (!SvREADONLY(sv)) {
5398 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5399 mg = mg_find(sv, PERL_MAGIC_utf8);
5404 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5405 mg->mg_ptr = (char *) cache;
5410 cache[1] = *offsetp;
5411 /* Drop the stale "length" cache */
5424 Returns a boolean indicating whether the strings in the two SVs are
5425 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5426 coerce its args to strings if necessary.
5432 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5441 SV* svrecode = Nullsv;
5448 pv1 = SvPV_const(sv1, cur1);
5455 pv2 = SvPV_const(sv2, cur2);
5457 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5458 /* Differing utf8ness.
5459 * Do not UTF8size the comparands as a side-effect. */
5462 svrecode = newSVpvn(pv2, cur2);
5463 sv_recode_to_utf8(svrecode, PL_encoding);
5464 pv2 = SvPV_const(svrecode, cur2);
5467 svrecode = newSVpvn(pv1, cur1);
5468 sv_recode_to_utf8(svrecode, PL_encoding);
5469 pv1 = SvPV_const(svrecode, cur1);
5471 /* Now both are in UTF-8. */
5473 SvREFCNT_dec(svrecode);
5478 bool is_utf8 = TRUE;
5481 /* sv1 is the UTF-8 one,
5482 * if is equal it must be downgrade-able */
5483 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5489 /* sv2 is the UTF-8 one,
5490 * if is equal it must be downgrade-able */
5491 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5497 /* Downgrade not possible - cannot be eq */
5505 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5508 SvREFCNT_dec(svrecode);
5519 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5520 string in C<sv1> is less than, equal to, or greater than the string in
5521 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5522 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5528 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5532 const char *pv1, *pv2;
5535 SV *svrecode = Nullsv;
5542 pv1 = SvPV_const(sv1, cur1);
5549 pv2 = SvPV_const(sv2, cur2);
5551 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5552 /* Differing utf8ness.
5553 * Do not UTF8size the comparands as a side-effect. */
5556 svrecode = newSVpvn(pv2, cur2);
5557 sv_recode_to_utf8(svrecode, PL_encoding);
5558 pv2 = SvPV_const(svrecode, cur2);
5561 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5566 svrecode = newSVpvn(pv1, cur1);
5567 sv_recode_to_utf8(svrecode, PL_encoding);
5568 pv1 = SvPV_const(svrecode, cur1);
5571 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5577 cmp = cur2 ? -1 : 0;
5581 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5584 cmp = retval < 0 ? -1 : 1;
5585 } else if (cur1 == cur2) {
5588 cmp = cur1 < cur2 ? -1 : 1;
5593 SvREFCNT_dec(svrecode);
5602 =for apidoc sv_cmp_locale
5604 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5605 'use bytes' aware, handles get magic, and will coerce its args to strings
5606 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5612 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5615 #ifdef USE_LOCALE_COLLATE
5621 if (PL_collation_standard)
5625 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5627 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5629 if (!pv1 || !len1) {
5640 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5643 return retval < 0 ? -1 : 1;
5646 * When the result of collation is equality, that doesn't mean
5647 * that there are no differences -- some locales exclude some
5648 * characters from consideration. So to avoid false equalities,
5649 * we use the raw string as a tiebreaker.
5655 #endif /* USE_LOCALE_COLLATE */
5657 return sv_cmp(sv1, sv2);
5661 #ifdef USE_LOCALE_COLLATE
5664 =for apidoc sv_collxfrm
5666 Add Collate Transform magic to an SV if it doesn't already have it.
5668 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5669 scalar data of the variable, but transformed to such a format that a normal
5670 memory comparison can be used to compare the data according to the locale
5677 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5682 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5683 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5689 Safefree(mg->mg_ptr);
5690 s = SvPV_const(sv, len);
5691 if ((xf = mem_collxfrm(s, len, &xlen))) {
5692 if (SvREADONLY(sv)) {
5695 return xf + sizeof(PL_collation_ix);
5698 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5699 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5712 if (mg && mg->mg_ptr) {
5714 return mg->mg_ptr + sizeof(PL_collation_ix);
5722 #endif /* USE_LOCALE_COLLATE */
5727 Get a line from the filehandle and store it into the SV, optionally
5728 appending to the currently-stored string.
5734 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5739 register STDCHAR rslast;
5740 register STDCHAR *bp;
5746 if (SvTHINKFIRST(sv))
5747 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5748 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5750 However, perlbench says it's slower, because the existing swipe code
5751 is faster than copy on write.
5752 Swings and roundabouts. */
5753 SvUPGRADE(sv, SVt_PV);
5758 if (PerlIO_isutf8(fp)) {
5760 sv_utf8_upgrade_nomg(sv);
5761 sv_pos_u2b(sv,&append,0);
5763 } else if (SvUTF8(sv)) {
5764 SV * const tsv = NEWSV(0,0);
5765 sv_gets(tsv, fp, 0);
5766 sv_utf8_upgrade_nomg(tsv);
5767 SvCUR_set(sv,append);
5770 goto return_string_or_null;
5775 if (PerlIO_isutf8(fp))
5778 if (IN_PERL_COMPILETIME) {
5779 /* we always read code in line mode */
5783 else if (RsSNARF(PL_rs)) {
5784 /* If it is a regular disk file use size from stat() as estimate
5785 of amount we are going to read - may result in malloc-ing
5786 more memory than we realy need if layers bellow reduce
5787 size we read (e.g. CRLF or a gzip layer)
5790 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5791 const Off_t offset = PerlIO_tell(fp);
5792 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5793 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5799 else if (RsRECORD(PL_rs)) {
5803 /* Grab the size of the record we're getting */
5804 recsize = SvIV(SvRV(PL_rs));
5805 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5808 /* VMS wants read instead of fread, because fread doesn't respect */
5809 /* RMS record boundaries. This is not necessarily a good thing to be */
5810 /* doing, but we've got no other real choice - except avoid stdio
5811 as implementation - perhaps write a :vms layer ?
5813 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5815 bytesread = PerlIO_read(fp, buffer, recsize);
5819 SvCUR_set(sv, bytesread += append);
5820 buffer[bytesread] = '\0';
5821 goto return_string_or_null;
5823 else if (RsPARA(PL_rs)) {
5829 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5830 if (PerlIO_isutf8(fp)) {
5831 rsptr = SvPVutf8(PL_rs, rslen);
5834 if (SvUTF8(PL_rs)) {
5835 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5836 Perl_croak(aTHX_ "Wide character in $/");
5839 rsptr = SvPV_const(PL_rs, rslen);
5843 rslast = rslen ? rsptr[rslen - 1] : '\0';
5845 if (rspara) { /* have to do this both before and after */
5846 do { /* to make sure file boundaries work right */
5849 i = PerlIO_getc(fp);
5853 PerlIO_ungetc(fp,i);
5859 /* See if we know enough about I/O mechanism to cheat it ! */
5861 /* This used to be #ifdef test - it is made run-time test for ease
5862 of abstracting out stdio interface. One call should be cheap
5863 enough here - and may even be a macro allowing compile
5867 if (PerlIO_fast_gets(fp)) {
5870 * We're going to steal some values from the stdio struct
5871 * and put EVERYTHING in the innermost loop into registers.
5873 register STDCHAR *ptr;
5877 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5878 /* An ungetc()d char is handled separately from the regular
5879 * buffer, so we getc() it back out and stuff it in the buffer.
5881 i = PerlIO_getc(fp);
5882 if (i == EOF) return 0;
5883 *(--((*fp)->_ptr)) = (unsigned char) i;
5887 /* Here is some breathtakingly efficient cheating */
5889 cnt = PerlIO_get_cnt(fp); /* get count into register */
5890 /* make sure we have the room */
5891 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5892 /* Not room for all of it
5893 if we are looking for a separator and room for some
5895 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5896 /* just process what we have room for */
5897 shortbuffered = cnt - SvLEN(sv) + append + 1;
5898 cnt -= shortbuffered;
5902 /* remember that cnt can be negative */
5903 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5908 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5909 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5910 DEBUG_P(PerlIO_printf(Perl_debug_log,
5911 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5912 DEBUG_P(PerlIO_printf(Perl_debug_log,
5913 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5914 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5915 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5920 while (cnt > 0) { /* this | eat */
5922 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5923 goto thats_all_folks; /* screams | sed :-) */
5927 Copy(ptr, bp, cnt, char); /* this | eat */
5928 bp += cnt; /* screams | dust */
5929 ptr += cnt; /* louder | sed :-) */
5934 if (shortbuffered) { /* oh well, must extend */
5935 cnt = shortbuffered;
5937 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5939 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5940 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5944 DEBUG_P(PerlIO_printf(Perl_debug_log,
5945 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5946 PTR2UV(ptr),(long)cnt));
5947 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5949 DEBUG_P(PerlIO_printf(Perl_debug_log,
5950 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5951 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5952 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5954 /* This used to call 'filbuf' in stdio form, but as that behaves like
5955 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5956 another abstraction. */
5957 i = PerlIO_getc(fp); /* get more characters */
5959 DEBUG_P(PerlIO_printf(Perl_debug_log,
5960 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5961 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5962 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5964 cnt = PerlIO_get_cnt(fp);
5965 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5966 DEBUG_P(PerlIO_printf(Perl_debug_log,
5967 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5969 if (i == EOF) /* all done for ever? */
5970 goto thats_really_all_folks;
5972 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5974 SvGROW(sv, bpx + cnt + 2);
5975 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5977 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5979 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5980 goto thats_all_folks;
5984 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5985 memNE((char*)bp - rslen, rsptr, rslen))
5986 goto screamer; /* go back to the fray */
5987 thats_really_all_folks:
5989 cnt += shortbuffered;
5990 DEBUG_P(PerlIO_printf(Perl_debug_log,
5991 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5992 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5993 DEBUG_P(PerlIO_printf(Perl_debug_log,
5994 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5995 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5996 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5998 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5999 DEBUG_P(PerlIO_printf(Perl_debug_log,
6000 "Screamer: done, len=%ld, string=|%.*s|\n",
6001 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6005 /*The big, slow, and stupid way. */
6006 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6007 STDCHAR *buf = NULL;
6008 Newx(buf, 8192, STDCHAR);
6016 register const STDCHAR * const bpe = buf + sizeof(buf);
6018 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6019 ; /* keep reading */
6023 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6024 /* Accomodate broken VAXC compiler, which applies U8 cast to
6025 * both args of ?: operator, causing EOF to change into 255
6028 i = (U8)buf[cnt - 1];
6034 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6036 sv_catpvn(sv, (char *) buf, cnt);
6038 sv_setpvn(sv, (char *) buf, cnt);
6040 if (i != EOF && /* joy */
6042 SvCUR(sv) < rslen ||
6043 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6047 * If we're reading from a TTY and we get a short read,
6048 * indicating that the user hit his EOF character, we need
6049 * to notice it now, because if we try to read from the TTY
6050 * again, the EOF condition will disappear.
6052 * The comparison of cnt to sizeof(buf) is an optimization
6053 * that prevents unnecessary calls to feof().
6057 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6061 #ifdef USE_HEAP_INSTEAD_OF_STACK
6066 if (rspara) { /* have to do this both before and after */
6067 while (i != EOF) { /* to make sure file boundaries work right */
6068 i = PerlIO_getc(fp);
6070 PerlIO_ungetc(fp,i);
6076 return_string_or_null:
6077 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6083 Auto-increment of the value in the SV, doing string to numeric conversion
6084 if necessary. Handles 'get' magic.
6090 Perl_sv_inc(pTHX_ register SV *sv)
6099 if (SvTHINKFIRST(sv)) {
6101 sv_force_normal_flags(sv, 0);
6102 if (SvREADONLY(sv)) {
6103 if (IN_PERL_RUNTIME)
6104 Perl_croak(aTHX_ PL_no_modify);
6108 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6110 i = PTR2IV(SvRV(sv));
6115 flags = SvFLAGS(sv);
6116 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6117 /* It's (privately or publicly) a float, but not tested as an
6118 integer, so test it to see. */
6120 flags = SvFLAGS(sv);
6122 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6123 /* It's publicly an integer, or privately an integer-not-float */
6124 #ifdef PERL_PRESERVE_IVUV
6128 if (SvUVX(sv) == UV_MAX)
6129 sv_setnv(sv, UV_MAX_P1);
6131 (void)SvIOK_only_UV(sv);
6132 SvUV_set(sv, SvUVX(sv) + 1);
6134 if (SvIVX(sv) == IV_MAX)
6135 sv_setuv(sv, (UV)IV_MAX + 1);
6137 (void)SvIOK_only(sv);
6138 SvIV_set(sv, SvIVX(sv) + 1);
6143 if (flags & SVp_NOK) {
6144 (void)SvNOK_only(sv);
6145 SvNV_set(sv, SvNVX(sv) + 1.0);
6149 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6150 if ((flags & SVTYPEMASK) < SVt_PVIV)
6151 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6152 (void)SvIOK_only(sv);
6157 while (isALPHA(*d)) d++;
6158 while (isDIGIT(*d)) d++;
6160 #ifdef PERL_PRESERVE_IVUV
6161 /* Got to punt this as an integer if needs be, but we don't issue
6162 warnings. Probably ought to make the sv_iv_please() that does
6163 the conversion if possible, and silently. */
6164 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6165 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6166 /* Need to try really hard to see if it's an integer.
6167 9.22337203685478e+18 is an integer.
6168 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6169 so $a="9.22337203685478e+18"; $a+0; $a++
6170 needs to be the same as $a="9.22337203685478e+18"; $a++
6177 /* sv_2iv *should* have made this an NV */
6178 if (flags & SVp_NOK) {
6179 (void)SvNOK_only(sv);
6180 SvNV_set(sv, SvNVX(sv) + 1.0);
6183 /* I don't think we can get here. Maybe I should assert this
6184 And if we do get here I suspect that sv_setnv will croak. NWC
6186 #if defined(USE_LONG_DOUBLE)
6187 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",
6188 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6190 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6191 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6194 #endif /* PERL_PRESERVE_IVUV */
6195 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6199 while (d >= SvPVX_const(sv)) {
6207 /* MKS: The original code here died if letters weren't consecutive.
6208 * at least it didn't have to worry about non-C locales. The
6209 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6210 * arranged in order (although not consecutively) and that only
6211 * [A-Za-z] are accepted by isALPHA in the C locale.
6213 if (*d != 'z' && *d != 'Z') {
6214 do { ++*d; } while (!isALPHA(*d));
6217 *(d--) -= 'z' - 'a';
6222 *(d--) -= 'z' - 'a' + 1;
6226 /* oh,oh, the number grew */
6227 SvGROW(sv, SvCUR(sv) + 2);
6228 SvCUR_set(sv, SvCUR(sv) + 1);
6229 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6240 Auto-decrement of the value in the SV, doing string to numeric conversion
6241 if necessary. Handles 'get' magic.
6247 Perl_sv_dec(pTHX_ register SV *sv)
6255 if (SvTHINKFIRST(sv)) {
6257 sv_force_normal_flags(sv, 0);
6258 if (SvREADONLY(sv)) {
6259 if (IN_PERL_RUNTIME)
6260 Perl_croak(aTHX_ PL_no_modify);
6264 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6266 i = PTR2IV(SvRV(sv));
6271 /* Unlike sv_inc we don't have to worry about string-never-numbers
6272 and keeping them magic. But we mustn't warn on punting */
6273 flags = SvFLAGS(sv);
6274 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6275 /* It's publicly an integer, or privately an integer-not-float */
6276 #ifdef PERL_PRESERVE_IVUV
6280 if (SvUVX(sv) == 0) {
6281 (void)SvIOK_only(sv);
6285 (void)SvIOK_only_UV(sv);
6286 SvUV_set(sv, SvUVX(sv) - 1);
6289 if (SvIVX(sv) == IV_MIN)
6290 sv_setnv(sv, (NV)IV_MIN - 1.0);
6292 (void)SvIOK_only(sv);
6293 SvIV_set(sv, SvIVX(sv) - 1);
6298 if (flags & SVp_NOK) {
6299 SvNV_set(sv, SvNVX(sv) - 1.0);
6300 (void)SvNOK_only(sv);
6303 if (!(flags & SVp_POK)) {
6304 if ((flags & SVTYPEMASK) < SVt_PVIV)
6305 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6307 (void)SvIOK_only(sv);
6310 #ifdef PERL_PRESERVE_IVUV
6312 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6313 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6314 /* Need to try really hard to see if it's an integer.
6315 9.22337203685478e+18 is an integer.
6316 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6317 so $a="9.22337203685478e+18"; $a+0; $a--
6318 needs to be the same as $a="9.22337203685478e+18"; $a--
6325 /* sv_2iv *should* have made this an NV */
6326 if (flags & SVp_NOK) {
6327 (void)SvNOK_only(sv);
6328 SvNV_set(sv, SvNVX(sv) - 1.0);
6331 /* I don't think we can get here. Maybe I should assert this
6332 And if we do get here I suspect that sv_setnv will croak. NWC
6334 #if defined(USE_LONG_DOUBLE)
6335 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",
6336 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6338 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6339 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6343 #endif /* PERL_PRESERVE_IVUV */
6344 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6348 =for apidoc sv_mortalcopy
6350 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6351 The new SV is marked as mortal. It will be destroyed "soon", either by an
6352 explicit call to FREETMPS, or by an implicit call at places such as
6353 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6358 /* Make a string that will exist for the duration of the expression
6359 * evaluation. Actually, it may have to last longer than that, but
6360 * hopefully we won't free it until it has been assigned to a
6361 * permanent location. */
6364 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6370 sv_setsv(sv,oldstr);
6372 PL_tmps_stack[++PL_tmps_ix] = sv;
6378 =for apidoc sv_newmortal
6380 Creates a new null SV which is mortal. The reference count of the SV is
6381 set to 1. It will be destroyed "soon", either by an explicit call to
6382 FREETMPS, or by an implicit call at places such as statement boundaries.
6383 See also C<sv_mortalcopy> and C<sv_2mortal>.
6389 Perl_sv_newmortal(pTHX)
6395 SvFLAGS(sv) = SVs_TEMP;
6397 PL_tmps_stack[++PL_tmps_ix] = sv;
6402 =for apidoc sv_2mortal
6404 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6405 by an explicit call to FREETMPS, or by an implicit call at places such as
6406 statement boundaries. SvTEMP() is turned on which means that the SV's
6407 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6408 and C<sv_mortalcopy>.
6414 Perl_sv_2mortal(pTHX_ register SV *sv)
6419 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6422 PL_tmps_stack[++PL_tmps_ix] = sv;
6430 Creates a new SV and copies a string into it. The reference count for the
6431 SV is set to 1. If C<len> is zero, Perl will compute the length using
6432 strlen(). For efficiency, consider using C<newSVpvn> instead.
6438 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6444 sv_setpvn(sv,s,len ? len : strlen(s));
6449 =for apidoc newSVpvn
6451 Creates a new SV and copies a string into it. The reference count for the
6452 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6453 string. You are responsible for ensuring that the source string is at least
6454 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6460 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6466 sv_setpvn(sv,s,len);
6472 =for apidoc newSVhek
6474 Creates a new SV from the hash key structure. It will generate scalars that
6475 point to the shared string table where possible. Returns a new (undefined)
6476 SV if the hek is NULL.
6482 Perl_newSVhek(pTHX_ const HEK *hek)
6492 if (HEK_LEN(hek) == HEf_SVKEY) {
6493 return newSVsv(*(SV**)HEK_KEY(hek));
6495 const int flags = HEK_FLAGS(hek);
6496 if (flags & HVhek_WASUTF8) {
6498 Andreas would like keys he put in as utf8 to come back as utf8
6500 STRLEN utf8_len = HEK_LEN(hek);
6501 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6502 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6505 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6507 } else if (flags & HVhek_REHASH) {
6508 /* We don't have a pointer to the hv, so we have to replicate the
6509 flag into every HEK. This hv is using custom a hasing
6510 algorithm. Hence we can't return a shared string scalar, as
6511 that would contain the (wrong) hash value, and might get passed
6512 into an hv routine with a regular hash */
6514 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6519 /* This will be overwhelminly the most common case. */
6520 return newSVpvn_share(HEK_KEY(hek),
6521 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6527 =for apidoc newSVpvn_share
6529 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6530 table. If the string does not already exist in the table, it is created
6531 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6532 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6533 otherwise the hash is computed. The idea here is that as the string table
6534 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6535 hash lookup will avoid string compare.
6541 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6545 bool is_utf8 = FALSE;
6547 STRLEN tmplen = -len;
6549 /* See the note in hv.c:hv_fetch() --jhi */
6550 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6554 PERL_HASH(hash, src, len);
6556 sv_upgrade(sv, SVt_PV);
6557 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6569 #if defined(PERL_IMPLICIT_CONTEXT)
6571 /* pTHX_ magic can't cope with varargs, so this is a no-context
6572 * version of the main function, (which may itself be aliased to us).
6573 * Don't access this version directly.
6577 Perl_newSVpvf_nocontext(const char* pat, ...)
6582 va_start(args, pat);
6583 sv = vnewSVpvf(pat, &args);
6590 =for apidoc newSVpvf
6592 Creates a new SV and initializes it with the string formatted like
6599 Perl_newSVpvf(pTHX_ const char* pat, ...)
6603 va_start(args, pat);
6604 sv = vnewSVpvf(pat, &args);
6609 /* backend for newSVpvf() and newSVpvf_nocontext() */
6612 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6617 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6624 Creates a new SV and copies a floating point value into it.
6625 The reference count for the SV is set to 1.
6631 Perl_newSVnv(pTHX_ NV n)
6644 Creates a new SV and copies an integer into it. The reference count for the
6651 Perl_newSViv(pTHX_ IV i)
6664 Creates a new SV and copies an unsigned integer into it.
6665 The reference count for the SV is set to 1.
6671 Perl_newSVuv(pTHX_ UV u)
6682 =for apidoc newRV_noinc
6684 Creates an RV wrapper for an SV. The reference count for the original
6685 SV is B<not> incremented.
6691 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6697 sv_upgrade(sv, SVt_RV);
6699 SvRV_set(sv, tmpRef);
6704 /* newRV_inc is the official function name to use now.
6705 * newRV_inc is in fact #defined to newRV in sv.h
6709 Perl_newRV(pTHX_ SV *tmpRef)
6712 return newRV_noinc(SvREFCNT_inc(tmpRef));
6718 Creates a new SV which is an exact duplicate of the original SV.
6725 Perl_newSVsv(pTHX_ register SV *old)
6732 if (SvTYPE(old) == SVTYPEMASK) {
6733 if (ckWARN_d(WARN_INTERNAL))
6734 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6738 /* SV_GMAGIC is the default for sv_setv()
6739 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6740 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6741 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6746 =for apidoc sv_reset
6748 Underlying implementation for the C<reset> Perl function.
6749 Note that the perl-level function is vaguely deprecated.
6755 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6758 char todo[PERL_UCHAR_MAX+1];
6763 if (!*s) { /* reset ?? searches */
6764 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6766 PMOP *pm = (PMOP *) mg->mg_obj;
6768 pm->op_pmdynflags &= ~PMdf_USED;
6775 /* reset variables */
6777 if (!HvARRAY(stash))
6780 Zero(todo, 256, char);
6783 I32 i = (unsigned char)*s;
6787 max = (unsigned char)*s++;
6788 for ( ; i <= max; i++) {
6791 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6793 for (entry = HvARRAY(stash)[i];
6795 entry = HeNEXT(entry))
6800 if (!todo[(U8)*HeKEY(entry)])
6802 gv = (GV*)HeVAL(entry);
6805 if (SvTHINKFIRST(sv)) {
6806 if (!SvREADONLY(sv) && SvROK(sv))
6808 /* XXX Is this continue a bug? Why should THINKFIRST
6809 exempt us from resetting arrays and hashes? */
6813 if (SvTYPE(sv) >= SVt_PV) {
6815 if (SvPVX_const(sv) != Nullch)
6823 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6825 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6828 # if defined(USE_ENVIRON_ARRAY)
6831 # endif /* USE_ENVIRON_ARRAY */
6842 Using various gambits, try to get an IO from an SV: the IO slot if its a
6843 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6844 named after the PV if we're a string.
6850 Perl_sv_2io(pTHX_ SV *sv)
6855 switch (SvTYPE(sv)) {
6863 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6867 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6869 return sv_2io(SvRV(sv));
6870 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6876 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6885 Using various gambits, try to get a CV from an SV; in addition, try if
6886 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6887 The flags in C<lref> are passed to sv_fetchsv.
6893 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6900 return *st = NULL, *gvp = Nullgv, Nullcv;
6901 switch (SvTYPE(sv)) {
6920 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6921 tryAMAGICunDEREF(to_cv);
6924 if (SvTYPE(sv) == SVt_PVCV) {
6933 Perl_croak(aTHX_ "Not a subroutine reference");
6938 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6944 /* Some flags to gv_fetchsv mean don't really create the GV */
6945 if (SvTYPE(gv) != SVt_PVGV) {
6951 if (lref && !GvCVu(gv)) {
6954 tmpsv = NEWSV(704,0);
6955 gv_efullname3(tmpsv, gv, Nullch);
6956 /* XXX this is probably not what they think they're getting.
6957 * It has the same effect as "sub name;", i.e. just a forward
6959 newSUB(start_subparse(FALSE, 0),
6960 newSVOP(OP_CONST, 0, tmpsv),
6965 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6975 Returns true if the SV has a true value by Perl's rules.
6976 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6977 instead use an in-line version.
6983 Perl_sv_true(pTHX_ register SV *sv)
6988 register const XPV* const tXpv = (XPV*)SvANY(sv);
6990 (tXpv->xpv_cur > 1 ||
6991 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6998 return SvIVX(sv) != 0;
7001 return SvNVX(sv) != 0.0;
7003 return sv_2bool(sv);
7009 =for apidoc sv_pvn_force
7011 Get a sensible string out of the SV somehow.
7012 A private implementation of the C<SvPV_force> macro for compilers which
7013 can't cope with complex macro expressions. Always use the macro instead.
7015 =for apidoc sv_pvn_force_flags
7017 Get a sensible string out of the SV somehow.
7018 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7019 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7020 implemented in terms of this function.
7021 You normally want to use the various wrapper macros instead: see
7022 C<SvPV_force> and C<SvPV_force_nomg>
7028 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7031 if (SvTHINKFIRST(sv) && !SvROK(sv))
7032 sv_force_normal_flags(sv, 0);
7042 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7043 const char * const ref = sv_reftype(sv,0);
7045 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7046 ref, OP_NAME(PL_op));
7048 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7050 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7051 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7053 s = sv_2pv_flags(sv, &len, flags);
7057 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7060 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7061 SvGROW(sv, len + 1);
7062 Move(s,SvPVX(sv),len,char);
7067 SvPOK_on(sv); /* validate pointer */
7069 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7070 PTR2UV(sv),SvPVX_const(sv)));
7073 return SvPVX_mutable(sv);
7077 =for apidoc sv_pvbyten_force
7079 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7085 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7087 sv_pvn_force(sv,lp);
7088 sv_utf8_downgrade(sv,0);
7094 =for apidoc sv_pvutf8n_force
7096 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7102 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7104 sv_pvn_force(sv,lp);
7105 sv_utf8_upgrade(sv);
7111 =for apidoc sv_reftype
7113 Returns a string describing what the SV is a reference to.
7119 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7121 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7122 inside return suggests a const propagation bug in g++. */
7123 if (ob && SvOBJECT(sv)) {
7124 char * const name = HvNAME_get(SvSTASH(sv));
7125 return name ? name : (char *) "__ANON__";
7128 switch (SvTYPE(sv)) {
7145 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7146 /* tied lvalues should appear to be
7147 * scalars for backwards compatitbility */
7148 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7149 ? "SCALAR" : "LVALUE");
7150 case SVt_PVAV: return "ARRAY";
7151 case SVt_PVHV: return "HASH";
7152 case SVt_PVCV: return "CODE";
7153 case SVt_PVGV: return "GLOB";
7154 case SVt_PVFM: return "FORMAT";
7155 case SVt_PVIO: return "IO";
7156 default: return "UNKNOWN";
7162 =for apidoc sv_isobject
7164 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7165 object. If the SV is not an RV, or if the object is not blessed, then this
7172 Perl_sv_isobject(pTHX_ SV *sv)
7188 Returns a boolean indicating whether the SV is blessed into the specified
7189 class. This does not check for subtypes; use C<sv_derived_from> to verify
7190 an inheritance relationship.
7196 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7207 hvname = HvNAME_get(SvSTASH(sv));
7211 return strEQ(hvname, name);
7217 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7218 it will be upgraded to one. If C<classname> is non-null then the new SV will
7219 be blessed in the specified package. The new SV is returned and its
7220 reference count is 1.
7226 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7233 SV_CHECK_THINKFIRST_COW_DROP(rv);
7236 if (SvTYPE(rv) >= SVt_PVMG) {
7237 const U32 refcnt = SvREFCNT(rv);
7241 SvREFCNT(rv) = refcnt;
7244 if (SvTYPE(rv) < SVt_RV)
7245 sv_upgrade(rv, SVt_RV);
7246 else if (SvTYPE(rv) > SVt_RV) {
7257 HV* const stash = gv_stashpv(classname, TRUE);
7258 (void)sv_bless(rv, stash);
7264 =for apidoc sv_setref_pv
7266 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7267 argument will be upgraded to an RV. That RV will be modified to point to
7268 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7269 into the SV. The C<classname> argument indicates the package for the
7270 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7271 will have a reference count of 1, and the RV will be returned.
7273 Do not use with other Perl types such as HV, AV, SV, CV, because those
7274 objects will become corrupted by the pointer copy process.
7276 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7282 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7286 sv_setsv(rv, &PL_sv_undef);
7290 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7295 =for apidoc sv_setref_iv
7297 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7298 argument will be upgraded to an RV. That RV will be modified to point to
7299 the new SV. The C<classname> argument indicates the package for the
7300 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7301 will have a reference count of 1, and the RV will be returned.
7307 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7309 sv_setiv(newSVrv(rv,classname), iv);
7314 =for apidoc sv_setref_uv
7316 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7317 argument will be upgraded to an RV. That RV will be modified to point to
7318 the new SV. The C<classname> argument indicates the package for the
7319 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7320 will have a reference count of 1, and the RV will be returned.
7326 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7328 sv_setuv(newSVrv(rv,classname), uv);
7333 =for apidoc sv_setref_nv
7335 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7336 argument will be upgraded to an RV. That RV will be modified to point to
7337 the new SV. The C<classname> argument indicates the package for the
7338 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7339 will have a reference count of 1, and the RV will be returned.
7345 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7347 sv_setnv(newSVrv(rv,classname), nv);
7352 =for apidoc sv_setref_pvn
7354 Copies a string into a new SV, optionally blessing the SV. The length of the
7355 string must be specified with C<n>. The C<rv> argument will be upgraded to
7356 an RV. That RV will be modified to point to the new SV. The C<classname>
7357 argument indicates the package for the blessing. Set C<classname> to
7358 C<Nullch> to avoid the blessing. The new SV will have a reference count
7359 of 1, and the RV will be returned.
7361 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7367 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7369 sv_setpvn(newSVrv(rv,classname), pv, n);
7374 =for apidoc sv_bless
7376 Blesses an SV into a specified package. The SV must be an RV. The package
7377 must be designated by its stash (see C<gv_stashpv()>). The reference count
7378 of the SV is unaffected.
7384 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7389 Perl_croak(aTHX_ "Can't bless non-reference value");
7391 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7392 if (SvREADONLY(tmpRef))
7393 Perl_croak(aTHX_ PL_no_modify);
7394 if (SvOBJECT(tmpRef)) {
7395 if (SvTYPE(tmpRef) != SVt_PVIO)
7397 SvREFCNT_dec(SvSTASH(tmpRef));
7400 SvOBJECT_on(tmpRef);
7401 if (SvTYPE(tmpRef) != SVt_PVIO)
7403 SvUPGRADE(tmpRef, SVt_PVMG);
7404 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7411 if(SvSMAGICAL(tmpRef))
7412 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7420 /* Downgrades a PVGV to a PVMG.
7424 S_sv_unglob(pTHX_ SV *sv)
7429 assert(SvTYPE(sv) == SVt_PVGV);
7434 sv_del_backref((SV*)GvSTASH(sv), sv);
7437 sv_unmagic(sv, PERL_MAGIC_glob);
7438 Safefree(GvNAME(sv));
7441 /* need to keep SvANY(sv) in the right arena */
7442 xpvmg = new_XPVMG();
7443 StructCopy(SvANY(sv), xpvmg, XPVMG);
7444 del_XPVGV(SvANY(sv));
7447 SvFLAGS(sv) &= ~SVTYPEMASK;
7448 SvFLAGS(sv) |= SVt_PVMG;
7452 =for apidoc sv_unref_flags
7454 Unsets the RV status of the SV, and decrements the reference count of
7455 whatever was being referenced by the RV. This can almost be thought of
7456 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7457 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7458 (otherwise the decrementing is conditional on the reference count being
7459 different from one or the reference being a readonly SV).
7466 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7468 SV* const target = SvRV(ref);
7470 if (SvWEAKREF(ref)) {
7471 sv_del_backref(target, ref);
7473 SvRV_set(ref, NULL);
7476 SvRV_set(ref, NULL);
7478 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7479 assigned to as BEGIN {$a = \"Foo"} will fail. */
7480 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7481 SvREFCNT_dec(target);
7482 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7483 sv_2mortal(target); /* Schedule for freeing later */
7487 =for apidoc sv_untaint
7489 Untaint an SV. Use C<SvTAINTED_off> instead.
7494 Perl_sv_untaint(pTHX_ SV *sv)
7496 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7497 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7504 =for apidoc sv_tainted
7506 Test an SV for taintedness. Use C<SvTAINTED> instead.
7511 Perl_sv_tainted(pTHX_ SV *sv)
7513 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7514 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7515 if (mg && (mg->mg_len & 1) )
7522 =for apidoc sv_setpviv
7524 Copies an integer into the given SV, also updating its string value.
7525 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7531 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7533 char buf[TYPE_CHARS(UV)];
7535 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7537 sv_setpvn(sv, ptr, ebuf - ptr);
7541 =for apidoc sv_setpviv_mg
7543 Like C<sv_setpviv>, but also handles 'set' magic.
7549 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7555 #if defined(PERL_IMPLICIT_CONTEXT)
7557 /* pTHX_ magic can't cope with varargs, so this is a no-context
7558 * version of the main function, (which may itself be aliased to us).
7559 * Don't access this version directly.
7563 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7567 va_start(args, pat);
7568 sv_vsetpvf(sv, pat, &args);
7572 /* pTHX_ magic can't cope with varargs, so this is a no-context
7573 * version of the main function, (which may itself be aliased to us).
7574 * Don't access this version directly.
7578 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7582 va_start(args, pat);
7583 sv_vsetpvf_mg(sv, pat, &args);
7589 =for apidoc sv_setpvf
7591 Works like C<sv_catpvf> but copies the text into the SV instead of
7592 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7598 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7601 va_start(args, pat);
7602 sv_vsetpvf(sv, pat, &args);
7607 =for apidoc sv_vsetpvf
7609 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7610 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7612 Usually used via its frontend C<sv_setpvf>.
7618 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7620 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7624 =for apidoc sv_setpvf_mg
7626 Like C<sv_setpvf>, but also handles 'set' magic.
7632 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7635 va_start(args, pat);
7636 sv_vsetpvf_mg(sv, pat, &args);
7641 =for apidoc sv_vsetpvf_mg
7643 Like C<sv_vsetpvf>, but also handles 'set' magic.
7645 Usually used via its frontend C<sv_setpvf_mg>.
7651 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7653 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7657 #if defined(PERL_IMPLICIT_CONTEXT)
7659 /* pTHX_ magic can't cope with varargs, so this is a no-context
7660 * version of the main function, (which may itself be aliased to us).
7661 * Don't access this version directly.
7665 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7669 va_start(args, pat);
7670 sv_vcatpvf(sv, pat, &args);
7674 /* pTHX_ magic can't cope with varargs, so this is a no-context
7675 * version of the main function, (which may itself be aliased to us).
7676 * Don't access this version directly.
7680 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7684 va_start(args, pat);
7685 sv_vcatpvf_mg(sv, pat, &args);
7691 =for apidoc sv_catpvf
7693 Processes its arguments like C<sprintf> and appends the formatted
7694 output to an SV. If the appended data contains "wide" characters
7695 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7696 and characters >255 formatted with %c), the original SV might get
7697 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7698 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7699 valid UTF-8; if the original SV was bytes, the pattern should be too.
7704 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7707 va_start(args, pat);
7708 sv_vcatpvf(sv, pat, &args);
7713 =for apidoc sv_vcatpvf
7715 Processes its arguments like C<vsprintf> and appends the formatted output
7716 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7718 Usually used via its frontend C<sv_catpvf>.
7724 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7726 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7730 =for apidoc sv_catpvf_mg
7732 Like C<sv_catpvf>, but also handles 'set' magic.
7738 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7741 va_start(args, pat);
7742 sv_vcatpvf_mg(sv, pat, &args);
7747 =for apidoc sv_vcatpvf_mg
7749 Like C<sv_vcatpvf>, but also handles 'set' magic.
7751 Usually used via its frontend C<sv_catpvf_mg>.
7757 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7759 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7764 =for apidoc sv_vsetpvfn
7766 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7769 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7775 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7777 sv_setpvn(sv, "", 0);
7778 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7782 S_expect_number(pTHX_ char** pattern)
7786 switch (**pattern) {
7787 case '1': case '2': case '3':
7788 case '4': case '5': case '6':
7789 case '7': case '8': case '9':
7790 var = *(*pattern)++ - '0';
7791 while (isDIGIT(**pattern)) {
7792 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7794 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7802 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7804 const int neg = nv < 0;
7813 if (uv & 1 && uv == nv)
7814 uv--; /* Round to even */
7816 const unsigned dig = uv % 10;
7829 =for apidoc sv_vcatpvfn
7831 Processes its arguments like C<vsprintf> and appends the formatted output
7832 to an SV. Uses an array of SVs if the C style variable argument list is
7833 missing (NULL). When running with taint checks enabled, indicates via
7834 C<maybe_tainted> if results are untrustworthy (often due to the use of
7837 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7843 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7844 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7845 vec_utf8 = DO_UTF8(vecsv);
7847 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7850 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7858 static const char nullstr[] = "(null)";
7860 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7861 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7863 /* Times 4: a decimal digit takes more than 3 binary digits.
7864 * NV_DIG: mantissa takes than many decimal digits.
7865 * Plus 32: Playing safe. */
7866 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7867 /* large enough for "%#.#f" --chip */
7868 /* what about long double NVs? --jhi */
7870 PERL_UNUSED_ARG(maybe_tainted);
7872 /* no matter what, this is a string now */
7873 (void)SvPV_force(sv, origlen);
7875 /* special-case "", "%s", and "%-p" (SVf - see below) */
7878 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7880 const char * const s = va_arg(*args, char*);
7881 sv_catpv(sv, s ? s : nullstr);
7883 else if (svix < svmax) {
7884 sv_catsv(sv, *svargs);
7888 if (args && patlen == 3 && pat[0] == '%' &&
7889 pat[1] == '-' && pat[2] == 'p') {
7890 argsv = va_arg(*args, SV*);
7891 sv_catsv(sv, argsv);
7895 #ifndef USE_LONG_DOUBLE
7896 /* special-case "%.<number>[gf]" */
7897 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7898 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7899 unsigned digits = 0;
7903 while (*pp >= '0' && *pp <= '9')
7904 digits = 10 * digits + (*pp++ - '0');
7905 if (pp - pat == (int)patlen - 1) {
7913 /* Add check for digits != 0 because it seems that some
7914 gconverts are buggy in this case, and we don't yet have
7915 a Configure test for this. */
7916 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7917 /* 0, point, slack */
7918 Gconvert(nv, (int)digits, 0, ebuf);
7920 if (*ebuf) /* May return an empty string for digits==0 */
7923 } else if (!digits) {
7926 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7927 sv_catpvn(sv, p, l);
7933 #endif /* !USE_LONG_DOUBLE */
7935 if (!args && svix < svmax && DO_UTF8(*svargs))
7938 patend = (char*)pat + patlen;
7939 for (p = (char*)pat; p < patend; p = q) {
7942 bool vectorize = FALSE;
7943 bool vectorarg = FALSE;
7944 bool vec_utf8 = FALSE;
7950 bool has_precis = FALSE;
7952 const I32 osvix = svix;
7953 bool is_utf8 = FALSE; /* is this item utf8? */
7954 #ifdef HAS_LDBL_SPRINTF_BUG
7955 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7956 with sfio - Allen <allens@cpan.org> */
7957 bool fix_ldbl_sprintf_bug = FALSE;
7961 U8 utf8buf[UTF8_MAXBYTES+1];
7962 STRLEN esignlen = 0;
7964 const char *eptr = Nullch;
7967 const U8 *vecstr = Null(U8*);
7974 /* we need a long double target in case HAS_LONG_DOUBLE but
7977 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7985 const char *dotstr = ".";
7986 STRLEN dotstrlen = 1;
7987 I32 efix = 0; /* explicit format parameter index */
7988 I32 ewix = 0; /* explicit width index */
7989 I32 epix = 0; /* explicit precision index */
7990 I32 evix = 0; /* explicit vector index */
7991 bool asterisk = FALSE;
7993 /* echo everything up to the next format specification */
7994 for (q = p; q < patend && *q != '%'; ++q) ;
7996 if (has_utf8 && !pat_utf8)
7997 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7999 sv_catpvn(sv, p, q - p);
8006 We allow format specification elements in this order:
8007 \d+\$ explicit format parameter index
8009 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8010 0 flag (as above): repeated to allow "v02"
8011 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8012 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8014 [%bcdefginopsuxDFOUX] format (mandatory)
8019 As of perl5.9.3, printf format checking is on by default.
8020 Internally, perl uses %p formats to provide an escape to
8021 some extended formatting. This block deals with those
8022 extensions: if it does not match, (char*)q is reset and
8023 the normal format processing code is used.
8025 Currently defined extensions are:
8026 %p include pointer address (standard)
8027 %-p (SVf) include an SV (previously %_)
8028 %-<num>p include an SV with precision <num>
8029 %1p (VDf) include a v-string (as %vd)
8030 %<num>p reserved for future extensions
8032 Robin Barker 2005-07-14
8039 n = expect_number(&q);
8046 argsv = va_arg(*args, SV*);
8047 eptr = SvPVx_const(argsv, elen);
8053 else if (n == vdNUMBER) { /* VDf */
8060 if (ckWARN_d(WARN_INTERNAL))
8061 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8062 "internal %%<num>p might conflict with future printf extensions");
8068 if ( (width = expect_number(&q)) ) {
8109 if ( (ewix = expect_number(&q)) )
8118 if ((vectorarg = asterisk)) {
8131 width = expect_number(&q);
8137 vecsv = va_arg(*args, SV*);
8139 vecsv = (evix > 0 && evix <= svmax)
8140 ? svargs[evix-1] : &PL_sv_undef;
8142 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8144 dotstr = SvPV_const(vecsv, dotstrlen);
8145 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8146 bad with tied or overloaded values that return UTF8. */
8149 else if (has_utf8) {
8150 vecsv = sv_mortalcopy(vecsv);
8151 sv_utf8_upgrade(vecsv);
8152 dotstr = SvPV_const(vecsv, dotstrlen);
8159 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8160 vecsv = svargs[efix ? efix-1 : svix++];
8161 vecstr = (U8*)SvPV_const(vecsv,veclen);
8162 vec_utf8 = DO_UTF8(vecsv);
8164 /* if this is a version object, we need to convert
8165 * back into v-string notation and then let the
8166 * vectorize happen normally
8168 if (sv_derived_from(vecsv, "version")) {
8169 char *version = savesvpv(vecsv);
8170 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8171 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8172 "vector argument not supported with alpha versions");
8175 vecsv = sv_newmortal();
8176 /* scan_vstring is expected to be called during
8177 * tokenization, so we need to fake up the end
8178 * of the buffer for it
8180 PL_bufend = version + veclen;
8181 scan_vstring(version, vecsv);
8182 vecstr = (U8*)SvPV_const(vecsv, veclen);
8183 vec_utf8 = DO_UTF8(vecsv);
8195 i = va_arg(*args, int);
8197 i = (ewix ? ewix <= svmax : svix < svmax) ?
8198 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8200 width = (i < 0) ? -i : i;
8210 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8212 /* XXX: todo, support specified precision parameter */
8216 i = va_arg(*args, int);
8218 i = (ewix ? ewix <= svmax : svix < svmax)
8219 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8220 precis = (i < 0) ? 0 : i;
8225 precis = precis * 10 + (*q++ - '0');
8234 case 'I': /* Ix, I32x, and I64x */
8236 if (q[1] == '6' && q[2] == '4') {
8242 if (q[1] == '3' && q[2] == '2') {
8252 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8263 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8264 if (*(q + 1) == 'l') { /* lld, llf */
8290 if (!vectorize && !args) {
8292 const I32 i = efix-1;
8293 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8295 argsv = (svix >= 0 && svix < svmax)
8296 ? svargs[svix++] : &PL_sv_undef;
8307 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8309 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8311 eptr = (char*)utf8buf;
8312 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8326 eptr = va_arg(*args, char*);
8328 #ifdef MACOS_TRADITIONAL
8329 /* On MacOS, %#s format is used for Pascal strings */
8334 elen = strlen(eptr);
8336 eptr = (char *)nullstr;
8337 elen = sizeof nullstr - 1;
8341 eptr = SvPVx_const(argsv, elen);
8342 if (DO_UTF8(argsv)) {
8343 if (has_precis && precis < elen) {
8345 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8348 if (width) { /* fudge width (can't fudge elen) */
8349 width += elen - sv_len_utf8(argsv);
8356 if (has_precis && elen > precis)
8363 if (alt || vectorize)
8365 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8386 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8395 esignbuf[esignlen++] = plus;
8399 case 'h': iv = (short)va_arg(*args, int); break;
8400 case 'l': iv = va_arg(*args, long); break;
8401 case 'V': iv = va_arg(*args, IV); break;
8402 default: iv = va_arg(*args, int); break;
8404 case 'q': iv = va_arg(*args, Quad_t); break;
8409 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8411 case 'h': iv = (short)tiv; break;
8412 case 'l': iv = (long)tiv; break;
8414 default: iv = tiv; break;
8416 case 'q': iv = (Quad_t)tiv; break;
8420 if ( !vectorize ) /* we already set uv above */
8425 esignbuf[esignlen++] = plus;
8429 esignbuf[esignlen++] = '-';
8472 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8483 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8484 case 'l': uv = va_arg(*args, unsigned long); break;
8485 case 'V': uv = va_arg(*args, UV); break;
8486 default: uv = va_arg(*args, unsigned); break;
8488 case 'q': uv = va_arg(*args, Uquad_t); break;
8493 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8495 case 'h': uv = (unsigned short)tuv; break;
8496 case 'l': uv = (unsigned long)tuv; break;
8498 default: uv = tuv; break;
8500 case 'q': uv = (Uquad_t)tuv; break;
8507 char *ptr = ebuf + sizeof ebuf;
8513 p = (char*)((c == 'X')
8514 ? "0123456789ABCDEF" : "0123456789abcdef");
8520 esignbuf[esignlen++] = '0';
8521 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8529 if (alt && *ptr != '0')
8540 esignbuf[esignlen++] = '0';
8541 esignbuf[esignlen++] = 'b';
8544 default: /* it had better be ten or less */
8548 } while (uv /= base);
8551 elen = (ebuf + sizeof ebuf) - ptr;
8555 zeros = precis - elen;
8556 else if (precis == 0 && elen == 1 && *eptr == '0')
8562 /* FLOATING POINT */
8565 c = 'f'; /* maybe %F isn't supported here */
8573 /* This is evil, but floating point is even more evil */
8575 /* for SV-style calling, we can only get NV
8576 for C-style calling, we assume %f is double;
8577 for simplicity we allow any of %Lf, %llf, %qf for long double
8581 #if defined(USE_LONG_DOUBLE)
8585 /* [perl #20339] - we should accept and ignore %lf rather than die */
8589 #if defined(USE_LONG_DOUBLE)
8590 intsize = args ? 0 : 'q';
8594 #if defined(HAS_LONG_DOUBLE)
8603 /* now we need (long double) if intsize == 'q', else (double) */
8605 #if LONG_DOUBLESIZE > DOUBLESIZE
8607 va_arg(*args, long double) :
8608 va_arg(*args, double)
8610 va_arg(*args, double)
8615 if (c != 'e' && c != 'E') {
8617 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8618 will cast our (long double) to (double) */
8619 (void)Perl_frexp(nv, &i);
8620 if (i == PERL_INT_MIN)
8621 Perl_die(aTHX_ "panic: frexp");
8623 need = BIT_DIGITS(i);
8625 need += has_precis ? precis : 6; /* known default */
8630 #ifdef HAS_LDBL_SPRINTF_BUG
8631 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8632 with sfio - Allen <allens@cpan.org> */
8635 # define MY_DBL_MAX DBL_MAX
8636 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8637 # if DOUBLESIZE >= 8
8638 # define MY_DBL_MAX 1.7976931348623157E+308L
8640 # define MY_DBL_MAX 3.40282347E+38L
8644 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8645 # define MY_DBL_MAX_BUG 1L
8647 # define MY_DBL_MAX_BUG MY_DBL_MAX
8651 # define MY_DBL_MIN DBL_MIN
8652 # else /* XXX guessing! -Allen */
8653 # if DOUBLESIZE >= 8
8654 # define MY_DBL_MIN 2.2250738585072014E-308L
8656 # define MY_DBL_MIN 1.17549435E-38L
8660 if ((intsize == 'q') && (c == 'f') &&
8661 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8663 /* it's going to be short enough that
8664 * long double precision is not needed */
8666 if ((nv <= 0L) && (nv >= -0L))
8667 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8669 /* would use Perl_fp_class as a double-check but not
8670 * functional on IRIX - see perl.h comments */
8672 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8673 /* It's within the range that a double can represent */
8674 #if defined(DBL_MAX) && !defined(DBL_MIN)
8675 if ((nv >= ((long double)1/DBL_MAX)) ||
8676 (nv <= (-(long double)1/DBL_MAX)))
8678 fix_ldbl_sprintf_bug = TRUE;
8681 if (fix_ldbl_sprintf_bug == TRUE) {
8691 # undef MY_DBL_MAX_BUG
8694 #endif /* HAS_LDBL_SPRINTF_BUG */
8696 need += 20; /* fudge factor */
8697 if (PL_efloatsize < need) {
8698 Safefree(PL_efloatbuf);
8699 PL_efloatsize = need + 20; /* more fudge */
8700 Newx(PL_efloatbuf, PL_efloatsize, char);
8701 PL_efloatbuf[0] = '\0';
8704 if ( !(width || left || plus || alt) && fill != '0'
8705 && has_precis && intsize != 'q' ) { /* Shortcuts */
8706 /* See earlier comment about buggy Gconvert when digits,
8708 if ( c == 'g' && precis) {
8709 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8710 /* May return an empty string for digits==0 */
8711 if (*PL_efloatbuf) {
8712 elen = strlen(PL_efloatbuf);
8713 goto float_converted;
8715 } else if ( c == 'f' && !precis) {
8716 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8721 char *ptr = ebuf + sizeof ebuf;
8724 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8725 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8726 if (intsize == 'q') {
8727 /* Copy the one or more characters in a long double
8728 * format before the 'base' ([efgEFG]) character to
8729 * the format string. */
8730 static char const prifldbl[] = PERL_PRIfldbl;
8731 char const *p = prifldbl + sizeof(prifldbl) - 3;
8732 while (p >= prifldbl) { *--ptr = *p--; }
8737 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8742 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8754 /* No taint. Otherwise we are in the strange situation
8755 * where printf() taints but print($float) doesn't.
8757 #if defined(HAS_LONG_DOUBLE)
8758 elen = ((intsize == 'q')
8759 ? my_sprintf(PL_efloatbuf, ptr, nv)
8760 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8762 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8766 eptr = PL_efloatbuf;
8774 i = SvCUR(sv) - origlen;
8777 case 'h': *(va_arg(*args, short*)) = i; break;
8778 default: *(va_arg(*args, int*)) = i; break;
8779 case 'l': *(va_arg(*args, long*)) = i; break;
8780 case 'V': *(va_arg(*args, IV*)) = i; break;
8782 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8787 sv_setuv_mg(argsv, (UV)i);
8788 continue; /* not "break" */
8795 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8796 && ckWARN(WARN_PRINTF))
8798 SV * const msg = sv_newmortal();
8799 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8800 (PL_op->op_type == OP_PRTF) ? "" : "s");
8803 Perl_sv_catpvf(aTHX_ msg,
8804 "\"%%%c\"", c & 0xFF);
8806 Perl_sv_catpvf(aTHX_ msg,
8807 "\"%%\\%03"UVof"\"",
8810 sv_catpvs(msg, "end of string");
8811 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8814 /* output mangled stuff ... */
8820 /* ... right here, because formatting flags should not apply */
8821 SvGROW(sv, SvCUR(sv) + elen + 1);
8823 Copy(eptr, p, elen, char);
8826 SvCUR_set(sv, p - SvPVX_const(sv));
8828 continue; /* not "break" */
8831 /* calculate width before utf8_upgrade changes it */
8832 have = esignlen + zeros + elen;
8834 Perl_croak_nocontext(PL_memory_wrap);
8836 if (is_utf8 != has_utf8) {
8839 sv_utf8_upgrade(sv);
8842 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8843 sv_utf8_upgrade(nsv);
8844 eptr = SvPVX_const(nsv);
8847 SvGROW(sv, SvCUR(sv) + elen + 1);
8852 need = (have > width ? have : width);
8855 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8856 Perl_croak_nocontext(PL_memory_wrap);
8857 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8859 if (esignlen && fill == '0') {
8861 for (i = 0; i < (int)esignlen; i++)
8865 memset(p, fill, gap);
8868 if (esignlen && fill != '0') {
8870 for (i = 0; i < (int)esignlen; i++)
8875 for (i = zeros; i; i--)
8879 Copy(eptr, p, elen, char);
8883 memset(p, ' ', gap);
8888 Copy(dotstr, p, dotstrlen, char);
8892 vectorize = FALSE; /* done iterating over vecstr */
8899 SvCUR_set(sv, p - SvPVX_const(sv));
8907 /* =========================================================================
8909 =head1 Cloning an interpreter
8911 All the macros and functions in this section are for the private use of
8912 the main function, perl_clone().
8914 The foo_dup() functions make an exact copy of an existing foo thinngy.
8915 During the course of a cloning, a hash table is used to map old addresses
8916 to new addresses. The table is created and manipulated with the
8917 ptr_table_* functions.
8921 ============================================================================*/
8924 #if defined(USE_ITHREADS)
8926 #ifndef GpREFCNT_inc
8927 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8931 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8932 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8933 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8934 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8935 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8936 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8937 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8938 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8939 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8940 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8941 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8942 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8943 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8946 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8947 regcomp.c. AMS 20010712 */
8950 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8955 struct reg_substr_datum *s;
8958 return (REGEXP *)NULL;
8960 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8963 len = r->offsets[0];
8964 npar = r->nparens+1;
8966 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8967 Copy(r->program, ret->program, len+1, regnode);
8969 Newx(ret->startp, npar, I32);
8970 Copy(r->startp, ret->startp, npar, I32);
8971 Newx(ret->endp, npar, I32);
8972 Copy(r->startp, ret->startp, npar, I32);
8974 Newx(ret->substrs, 1, struct reg_substr_data);
8975 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8976 s->min_offset = r->substrs->data[i].min_offset;
8977 s->max_offset = r->substrs->data[i].max_offset;
8978 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8979 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8982 ret->regstclass = NULL;
8985 const int count = r->data->count;
8988 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8989 char, struct reg_data);
8990 Newx(d->what, count, U8);
8993 for (i = 0; i < count; i++) {
8994 d->what[i] = r->data->what[i];
8995 switch (d->what[i]) {
8996 /* legal options are one of: sfpont
8997 see also regcomp.h and pregfree() */
8999 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9002 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9005 /* This is cheating. */
9006 Newx(d->data[i], 1, struct regnode_charclass_class);
9007 StructCopy(r->data->data[i], d->data[i],
9008 struct regnode_charclass_class);
9009 ret->regstclass = (regnode*)d->data[i];
9012 /* Compiled op trees are readonly, and can thus be
9013 shared without duplication. */
9015 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9019 d->data[i] = r->data->data[i];
9022 d->data[i] = r->data->data[i];
9024 ((reg_trie_data*)d->data[i])->refcount++;
9028 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9037 Newx(ret->offsets, 2*len+1, U32);
9038 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9040 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9041 ret->refcnt = r->refcnt;
9042 ret->minlen = r->minlen;
9043 ret->prelen = r->prelen;
9044 ret->nparens = r->nparens;
9045 ret->lastparen = r->lastparen;
9046 ret->lastcloseparen = r->lastcloseparen;
9047 ret->reganch = r->reganch;
9049 ret->sublen = r->sublen;
9051 if (RX_MATCH_COPIED(ret))
9052 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9054 ret->subbeg = Nullch;
9055 #ifdef PERL_OLD_COPY_ON_WRITE
9056 ret->saved_copy = Nullsv;
9059 ptr_table_store(PL_ptr_table, r, ret);
9063 /* duplicate a file handle */
9066 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9070 PERL_UNUSED_ARG(type);
9073 return (PerlIO*)NULL;
9075 /* look for it in the table first */
9076 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9080 /* create anew and remember what it is */
9081 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9082 ptr_table_store(PL_ptr_table, fp, ret);
9086 /* duplicate a directory handle */
9089 Perl_dirp_dup(pTHX_ DIR *dp)
9097 /* duplicate a typeglob */
9100 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9105 /* look for it in the table first */
9106 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9110 /* create anew and remember what it is */
9112 ptr_table_store(PL_ptr_table, gp, ret);
9115 ret->gp_refcnt = 0; /* must be before any other dups! */
9116 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9117 ret->gp_io = io_dup_inc(gp->gp_io, param);
9118 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9119 ret->gp_av = av_dup_inc(gp->gp_av, param);
9120 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9121 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9122 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9123 ret->gp_cvgen = gp->gp_cvgen;
9124 ret->gp_line = gp->gp_line;
9125 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9129 /* duplicate a chain of magic */
9132 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9134 MAGIC *mgprev = (MAGIC*)NULL;
9137 return (MAGIC*)NULL;
9138 /* look for it in the table first */
9139 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9143 for (; mg; mg = mg->mg_moremagic) {
9145 Newxz(nmg, 1, MAGIC);
9147 mgprev->mg_moremagic = nmg;
9150 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9151 nmg->mg_private = mg->mg_private;
9152 nmg->mg_type = mg->mg_type;
9153 nmg->mg_flags = mg->mg_flags;
9154 if (mg->mg_type == PERL_MAGIC_qr) {
9155 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9157 else if(mg->mg_type == PERL_MAGIC_backref) {
9158 /* The backref AV has its reference count deliberately bumped by
9160 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9162 else if (mg->mg_type == PERL_MAGIC_symtab) {
9163 nmg->mg_obj = mg->mg_obj;
9166 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9167 ? sv_dup_inc(mg->mg_obj, param)
9168 : sv_dup(mg->mg_obj, param);
9170 nmg->mg_len = mg->mg_len;
9171 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9172 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9173 if (mg->mg_len > 0) {
9174 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9175 if (mg->mg_type == PERL_MAGIC_overload_table &&
9176 AMT_AMAGIC((AMT*)mg->mg_ptr))
9178 const AMT * const amtp = (AMT*)mg->mg_ptr;
9179 AMT * const namtp = (AMT*)nmg->mg_ptr;
9181 for (i = 1; i < NofAMmeth; i++) {
9182 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9186 else if (mg->mg_len == HEf_SVKEY)
9187 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9189 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9190 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9197 /* create a new pointer-mapping table */
9200 Perl_ptr_table_new(pTHX)
9203 Newxz(tbl, 1, PTR_TBL_t);
9206 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9210 #define PTR_TABLE_HASH(ptr) \
9211 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9214 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9215 following define) and at call to new_body_inline made below in
9216 Perl_ptr_table_store()
9219 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9221 /* map an existing pointer using a table */
9223 STATIC PTR_TBL_ENT_t *
9224 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9225 PTR_TBL_ENT_t *tblent;
9226 const UV hash = PTR_TABLE_HASH(sv);
9228 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9229 for (; tblent; tblent = tblent->next) {
9230 if (tblent->oldval == sv)
9237 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9239 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9240 return tblent ? tblent->newval : (void *) 0;
9243 /* add a new entry to a pointer-mapping table */
9246 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9248 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9251 tblent->newval = newsv;
9253 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9255 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9256 tblent->oldval = oldsv;
9257 tblent->newval = newsv;
9258 tblent->next = tbl->tbl_ary[entry];
9259 tbl->tbl_ary[entry] = tblent;
9261 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9262 ptr_table_split(tbl);
9266 /* double the hash bucket size of an existing ptr table */
9269 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9271 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9272 const UV oldsize = tbl->tbl_max + 1;
9273 UV newsize = oldsize * 2;
9276 Renew(ary, newsize, PTR_TBL_ENT_t*);
9277 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9278 tbl->tbl_max = --newsize;
9280 for (i=0; i < oldsize; i++, ary++) {
9281 PTR_TBL_ENT_t **curentp, **entp, *ent;
9284 curentp = ary + oldsize;
9285 for (entp = ary, ent = *ary; ent; ent = *entp) {
9286 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9288 ent->next = *curentp;
9298 /* remove all the entries from a ptr table */
9301 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9303 if (tbl && tbl->tbl_items) {
9304 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9305 UV riter = tbl->tbl_max;
9308 PTR_TBL_ENT_t *entry = array[riter];
9311 PTR_TBL_ENT_t * const oentry = entry;
9312 entry = entry->next;
9321 /* clear and free a ptr table */
9324 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9329 ptr_table_clear(tbl);
9330 Safefree(tbl->tbl_ary);
9336 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9339 SvRV_set(dstr, SvWEAKREF(sstr)
9340 ? sv_dup(SvRV(sstr), param)
9341 : sv_dup_inc(SvRV(sstr), param));
9344 else if (SvPVX_const(sstr)) {
9345 /* Has something there */
9347 /* Normal PV - clone whole allocated space */
9348 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9349 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9350 /* Not that normal - actually sstr is copy on write.
9351 But we are a true, independant SV, so: */
9352 SvREADONLY_off(dstr);
9357 /* Special case - not normally malloced for some reason */
9358 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9359 /* A "shared" PV - clone it as "shared" PV */
9361 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9365 /* Some other special case - random pointer */
9366 SvPV_set(dstr, SvPVX(sstr));
9372 if (SvTYPE(dstr) == SVt_RV)
9373 SvRV_set(dstr, NULL);
9375 SvPV_set(dstr, NULL);
9379 /* duplicate an SV of any type (including AV, HV etc) */
9382 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9387 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9389 /* look for it in the table first */
9390 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9394 if(param->flags & CLONEf_JOIN_IN) {
9395 /** We are joining here so we don't want do clone
9396 something that is bad **/
9397 if (SvTYPE(sstr) == SVt_PVHV) {
9398 const char * const hvname = HvNAME_get(sstr);
9400 /** don't clone stashes if they already exist **/
9401 return (SV*)gv_stashpv(hvname,0);
9405 /* create anew and remember what it is */
9408 #ifdef DEBUG_LEAKING_SCALARS
9409 dstr->sv_debug_optype = sstr->sv_debug_optype;
9410 dstr->sv_debug_line = sstr->sv_debug_line;
9411 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9412 dstr->sv_debug_cloned = 1;
9413 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9416 ptr_table_store(PL_ptr_table, sstr, dstr);
9419 SvFLAGS(dstr) = SvFLAGS(sstr);
9420 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9421 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9424 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9425 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9426 PL_watch_pvx, SvPVX_const(sstr));
9429 /* don't clone objects whose class has asked us not to */
9430 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9431 SvFLAGS(dstr) &= ~SVTYPEMASK;
9436 switch (SvTYPE(sstr)) {
9441 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9442 SvIV_set(dstr, SvIVX(sstr));
9445 SvANY(dstr) = new_XNV();
9446 SvNV_set(dstr, SvNVX(sstr));
9449 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9450 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9454 /* These are all the types that need complex bodies allocating. */
9456 const svtype sv_type = SvTYPE(sstr);
9457 const struct body_details *const sv_type_details
9458 = bodies_by_type + sv_type;
9462 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9467 if (GvUNIQUE((GV*)sstr)) {
9468 /* Do sharing here, and fall through */
9481 assert(sv_type_details->size);
9482 if (sv_type_details->arena) {
9483 new_body_inline(new_body, sv_type_details->size, sv_type);
9485 = (void*)((char*)new_body - sv_type_details->offset);
9487 new_body = new_NOARENA(sv_type_details);
9491 SvANY(dstr) = new_body;
9494 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9495 ((char*)SvANY(dstr)) + sv_type_details->offset,
9496 sv_type_details->copy, char);
9498 Copy(((char*)SvANY(sstr)),
9499 ((char*)SvANY(dstr)),
9500 sv_type_details->size + sv_type_details->offset, char);
9503 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9504 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9506 /* The Copy above means that all the source (unduplicated) pointers
9507 are now in the destination. We can check the flags and the
9508 pointers in either, but it's possible that there's less cache
9509 missing by always going for the destination.
9510 FIXME - instrument and check that assumption */
9511 if (sv_type >= SVt_PVMG) {
9513 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9515 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9518 /* The cast silences a GCC warning about unhandled types. */
9519 switch ((int)sv_type) {
9531 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9532 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9533 LvTARG(dstr) = dstr;
9534 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9535 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9537 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9540 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9541 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9542 /* Don't call sv_add_backref here as it's going to be created
9543 as part of the magic cloning of the symbol table. */
9544 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9545 (void)GpREFCNT_inc(GvGP(dstr));
9548 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9549 if (IoOFP(dstr) == IoIFP(sstr))
9550 IoOFP(dstr) = IoIFP(dstr);
9552 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9553 /* PL_rsfp_filters entries have fake IoDIRP() */
9554 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9555 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9556 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9557 /* I have no idea why fake dirp (rsfps)
9558 should be treated differently but otherwise
9559 we end up with leaks -- sky*/
9560 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9561 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9562 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9564 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9565 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9566 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9568 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9569 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9570 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9573 if (AvARRAY((AV*)sstr)) {
9574 SV **dst_ary, **src_ary;
9575 SSize_t items = AvFILLp((AV*)sstr) + 1;
9577 src_ary = AvARRAY((AV*)sstr);
9578 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9579 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9580 SvPV_set(dstr, (char*)dst_ary);
9581 AvALLOC((AV*)dstr) = dst_ary;
9582 if (AvREAL((AV*)sstr)) {
9584 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9588 *dst_ary++ = sv_dup(*src_ary++, param);
9590 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9591 while (items-- > 0) {
9592 *dst_ary++ = &PL_sv_undef;
9596 SvPV_set(dstr, Nullch);
9597 AvALLOC((AV*)dstr) = (SV**)NULL;
9604 if (HvARRAY((HV*)sstr)) {
9606 const bool sharekeys = !!HvSHAREKEYS(sstr);
9607 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9608 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9610 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9611 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9613 HvARRAY(dstr) = (HE**)darray;
9614 while (i <= sxhv->xhv_max) {
9615 const HE *source = HvARRAY(sstr)[i];
9616 HvARRAY(dstr)[i] = source
9617 ? he_dup(source, sharekeys, param) : 0;
9621 struct xpvhv_aux * const saux = HvAUX(sstr);
9622 struct xpvhv_aux * const daux = HvAUX(dstr);
9623 /* This flag isn't copied. */
9624 /* SvOOK_on(hv) attacks the IV flags. */
9625 SvFLAGS(dstr) |= SVf_OOK;
9627 hvname = saux->xhv_name;
9629 = hvname ? hek_dup(hvname, param) : hvname;
9631 daux->xhv_riter = saux->xhv_riter;
9632 daux->xhv_eiter = saux->xhv_eiter
9633 ? he_dup(saux->xhv_eiter,
9634 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9635 daux->xhv_backreferences = saux->xhv_backreferences
9636 ? (AV*) SvREFCNT_inc(
9644 SvPV_set(dstr, Nullch);
9646 /* Record stashes for possible cloning in Perl_clone(). */
9648 av_push(param->stashes, dstr);
9653 /* NOTE: not refcounted */
9654 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9656 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9658 if (CvCONST(dstr)) {
9659 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9660 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9661 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9663 /* don't dup if copying back - CvGV isn't refcounted, so the
9664 * duped GV may never be freed. A bit of a hack! DAPM */
9665 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9666 Nullgv : gv_dup(CvGV(dstr), param) ;
9667 if (!(param->flags & CLONEf_COPY_STACKS)) {
9670 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9673 ? cv_dup( CvOUTSIDE(dstr), param)
9674 : cv_dup_inc(CvOUTSIDE(dstr), param);
9676 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9682 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9688 /* duplicate a context */
9691 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9696 return (PERL_CONTEXT*)NULL;
9698 /* look for it in the table first */
9699 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9703 /* create anew and remember what it is */
9704 Newxz(ncxs, max + 1, PERL_CONTEXT);
9705 ptr_table_store(PL_ptr_table, cxs, ncxs);
9708 PERL_CONTEXT * const cx = &cxs[ix];
9709 PERL_CONTEXT * const ncx = &ncxs[ix];
9710 ncx->cx_type = cx->cx_type;
9711 if (CxTYPE(cx) == CXt_SUBST) {
9712 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9715 ncx->blk_oldsp = cx->blk_oldsp;
9716 ncx->blk_oldcop = cx->blk_oldcop;
9717 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9718 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9719 ncx->blk_oldpm = cx->blk_oldpm;
9720 ncx->blk_gimme = cx->blk_gimme;
9721 switch (CxTYPE(cx)) {
9723 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9724 ? cv_dup_inc(cx->blk_sub.cv, param)
9725 : cv_dup(cx->blk_sub.cv,param));
9726 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9727 ? av_dup_inc(cx->blk_sub.argarray, param)
9729 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9730 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9731 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9732 ncx->blk_sub.lval = cx->blk_sub.lval;
9733 ncx->blk_sub.retop = cx->blk_sub.retop;
9736 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9737 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9738 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9739 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9740 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9741 ncx->blk_eval.retop = cx->blk_eval.retop;
9744 ncx->blk_loop.label = cx->blk_loop.label;
9745 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9746 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9747 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9748 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9749 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9750 ? cx->blk_loop.iterdata
9751 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9752 ncx->blk_loop.oldcomppad
9753 = (PAD*)ptr_table_fetch(PL_ptr_table,
9754 cx->blk_loop.oldcomppad);
9755 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9756 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9757 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9758 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9759 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9762 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9763 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9764 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9765 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9766 ncx->blk_sub.retop = cx->blk_sub.retop;
9778 /* duplicate a stack info structure */
9781 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9786 return (PERL_SI*)NULL;
9788 /* look for it in the table first */
9789 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9793 /* create anew and remember what it is */
9794 Newxz(nsi, 1, PERL_SI);
9795 ptr_table_store(PL_ptr_table, si, nsi);
9797 nsi->si_stack = av_dup_inc(si->si_stack, param);
9798 nsi->si_cxix = si->si_cxix;
9799 nsi->si_cxmax = si->si_cxmax;
9800 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9801 nsi->si_type = si->si_type;
9802 nsi->si_prev = si_dup(si->si_prev, param);
9803 nsi->si_next = si_dup(si->si_next, param);
9804 nsi->si_markoff = si->si_markoff;
9809 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9810 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9811 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9812 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9813 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9814 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9815 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9816 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9817 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9818 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9819 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9820 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9821 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9822 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9825 #define pv_dup_inc(p) SAVEPV(p)
9826 #define pv_dup(p) SAVEPV(p)
9827 #define svp_dup_inc(p,pp) any_dup(p,pp)
9829 /* map any object to the new equivent - either something in the
9830 * ptr table, or something in the interpreter structure
9834 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9841 /* look for it in the table first */
9842 ret = ptr_table_fetch(PL_ptr_table, v);
9846 /* see if it is part of the interpreter structure */
9847 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9848 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9856 /* duplicate the save stack */
9859 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9861 ANY * const ss = proto_perl->Tsavestack;
9862 const I32 max = proto_perl->Tsavestack_max;
9863 I32 ix = proto_perl->Tsavestack_ix;
9875 void (*dptr) (void*);
9876 void (*dxptr) (pTHX_ void*);
9878 Newxz(nss, max, ANY);
9881 I32 i = POPINT(ss,ix);
9884 case SAVEt_ITEM: /* normal string */
9885 sv = (SV*)POPPTR(ss,ix);
9886 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9887 sv = (SV*)POPPTR(ss,ix);
9888 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9890 case SAVEt_SV: /* scalar reference */
9891 sv = (SV*)POPPTR(ss,ix);
9892 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9893 gv = (GV*)POPPTR(ss,ix);
9894 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9896 case SAVEt_GENERIC_PVREF: /* generic char* */
9897 c = (char*)POPPTR(ss,ix);
9898 TOPPTR(nss,ix) = pv_dup(c);
9899 ptr = POPPTR(ss,ix);
9900 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9902 case SAVEt_SHARED_PVREF: /* char* in shared space */
9903 c = (char*)POPPTR(ss,ix);
9904 TOPPTR(nss,ix) = savesharedpv(c);
9905 ptr = POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9908 case SAVEt_GENERIC_SVREF: /* generic sv */
9909 case SAVEt_SVREF: /* scalar reference */
9910 sv = (SV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 ptr = POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9915 case SAVEt_AV: /* array reference */
9916 av = (AV*)POPPTR(ss,ix);
9917 TOPPTR(nss,ix) = av_dup_inc(av, param);
9918 gv = (GV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = gv_dup(gv, param);
9921 case SAVEt_HV: /* hash reference */
9922 hv = (HV*)POPPTR(ss,ix);
9923 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9924 gv = (GV*)POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = gv_dup(gv, param);
9927 case SAVEt_INT: /* int reference */
9928 ptr = POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9930 intval = (int)POPINT(ss,ix);
9931 TOPINT(nss,ix) = intval;
9933 case SAVEt_LONG: /* long reference */
9934 ptr = POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9936 longval = (long)POPLONG(ss,ix);
9937 TOPLONG(nss,ix) = longval;
9939 case SAVEt_I32: /* I32 reference */
9940 case SAVEt_I16: /* I16 reference */
9941 case SAVEt_I8: /* I8 reference */
9942 ptr = POPPTR(ss,ix);
9943 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9947 case SAVEt_IV: /* IV reference */
9948 ptr = POPPTR(ss,ix);
9949 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9953 case SAVEt_SPTR: /* SV* reference */
9954 ptr = POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9956 sv = (SV*)POPPTR(ss,ix);
9957 TOPPTR(nss,ix) = sv_dup(sv, param);
9959 case SAVEt_VPTR: /* random* reference */
9960 ptr = POPPTR(ss,ix);
9961 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9962 ptr = POPPTR(ss,ix);
9963 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9965 case SAVEt_PPTR: /* char* reference */
9966 ptr = POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9968 c = (char*)POPPTR(ss,ix);
9969 TOPPTR(nss,ix) = pv_dup(c);
9971 case SAVEt_HPTR: /* HV* reference */
9972 ptr = POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9974 hv = (HV*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = hv_dup(hv, param);
9977 case SAVEt_APTR: /* AV* reference */
9978 ptr = POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9980 av = (AV*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = av_dup(av, param);
9984 gv = (GV*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = gv_dup(gv, param);
9987 case SAVEt_GP: /* scalar reference */
9988 gp = (GP*)POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9990 (void)GpREFCNT_inc(gp);
9991 gv = (GV*)POPPTR(ss,ix);
9992 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9993 c = (char*)POPPTR(ss,ix);
9994 TOPPTR(nss,ix) = pv_dup(c);
10001 case SAVEt_MORTALIZESV:
10002 sv = (SV*)POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10006 ptr = POPPTR(ss,ix);
10007 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10008 /* these are assumed to be refcounted properly */
10010 switch (((OP*)ptr)->op_type) {
10012 case OP_LEAVESUBLV:
10016 case OP_LEAVEWRITE:
10017 TOPPTR(nss,ix) = ptr;
10022 TOPPTR(nss,ix) = Nullop;
10027 TOPPTR(nss,ix) = Nullop;
10030 c = (char*)POPPTR(ss,ix);
10031 TOPPTR(nss,ix) = pv_dup_inc(c);
10033 case SAVEt_CLEARSV:
10034 longval = POPLONG(ss,ix);
10035 TOPLONG(nss,ix) = longval;
10038 hv = (HV*)POPPTR(ss,ix);
10039 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10040 c = (char*)POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = pv_dup_inc(c);
10043 TOPINT(nss,ix) = i;
10045 case SAVEt_DESTRUCTOR:
10046 ptr = POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10048 dptr = POPDPTR(ss,ix);
10049 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10050 any_dup(FPTR2DPTR(void *, dptr),
10053 case SAVEt_DESTRUCTOR_X:
10054 ptr = POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10056 dxptr = POPDXPTR(ss,ix);
10057 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10058 any_dup(FPTR2DPTR(void *, dxptr),
10061 case SAVEt_REGCONTEXT:
10064 TOPINT(nss,ix) = i;
10067 case SAVEt_STACK_POS: /* Position on Perl stack */
10069 TOPINT(nss,ix) = i;
10071 case SAVEt_AELEM: /* array element */
10072 sv = (SV*)POPPTR(ss,ix);
10073 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10075 TOPINT(nss,ix) = i;
10076 av = (AV*)POPPTR(ss,ix);
10077 TOPPTR(nss,ix) = av_dup_inc(av, param);
10079 case SAVEt_HELEM: /* hash element */
10080 sv = (SV*)POPPTR(ss,ix);
10081 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10082 sv = (SV*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10084 hv = (HV*)POPPTR(ss,ix);
10085 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10088 ptr = POPPTR(ss,ix);
10089 TOPPTR(nss,ix) = ptr;
10093 TOPINT(nss,ix) = i;
10095 case SAVEt_COMPPAD:
10096 av = (AV*)POPPTR(ss,ix);
10097 TOPPTR(nss,ix) = av_dup(av, param);
10100 longval = (long)POPLONG(ss,ix);
10101 TOPLONG(nss,ix) = longval;
10102 ptr = POPPTR(ss,ix);
10103 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10104 sv = (SV*)POPPTR(ss,ix);
10105 TOPPTR(nss,ix) = sv_dup(sv, param);
10108 ptr = POPPTR(ss,ix);
10109 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10110 longval = (long)POPBOOL(ss,ix);
10111 TOPBOOL(nss,ix) = (bool)longval;
10113 case SAVEt_SET_SVFLAGS:
10115 TOPINT(nss,ix) = i;
10117 TOPINT(nss,ix) = i;
10118 sv = (SV*)POPPTR(ss,ix);
10119 TOPPTR(nss,ix) = sv_dup(sv, param);
10122 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10130 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10131 * flag to the result. This is done for each stash before cloning starts,
10132 * so we know which stashes want their objects cloned */
10135 do_mark_cloneable_stash(pTHX_ SV *sv)
10137 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10139 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10140 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10141 if (cloner && GvCV(cloner)) {
10148 XPUSHs(sv_2mortal(newSVhek(hvname)));
10150 call_sv((SV*)GvCV(cloner), G_SCALAR);
10157 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10165 =for apidoc perl_clone
10167 Create and return a new interpreter by cloning the current one.
10169 perl_clone takes these flags as parameters:
10171 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10172 without it we only clone the data and zero the stacks,
10173 with it we copy the stacks and the new perl interpreter is
10174 ready to run at the exact same point as the previous one.
10175 The pseudo-fork code uses COPY_STACKS while the
10176 threads->new doesn't.
10178 CLONEf_KEEP_PTR_TABLE
10179 perl_clone keeps a ptr_table with the pointer of the old
10180 variable as a key and the new variable as a value,
10181 this allows it to check if something has been cloned and not
10182 clone it again but rather just use the value and increase the
10183 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10184 the ptr_table using the function
10185 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10186 reason to keep it around is if you want to dup some of your own
10187 variable who are outside the graph perl scans, example of this
10188 code is in threads.xs create
10191 This is a win32 thing, it is ignored on unix, it tells perls
10192 win32host code (which is c++) to clone itself, this is needed on
10193 win32 if you want to run two threads at the same time,
10194 if you just want to do some stuff in a separate perl interpreter
10195 and then throw it away and return to the original one,
10196 you don't need to do anything.
10201 /* XXX the above needs expanding by someone who actually understands it ! */
10202 EXTERN_C PerlInterpreter *
10203 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10206 perl_clone(PerlInterpreter *proto_perl, UV flags)
10209 #ifdef PERL_IMPLICIT_SYS
10211 /* perlhost.h so we need to call into it
10212 to clone the host, CPerlHost should have a c interface, sky */
10214 if (flags & CLONEf_CLONE_HOST) {
10215 return perl_clone_host(proto_perl,flags);
10217 return perl_clone_using(proto_perl, flags,
10219 proto_perl->IMemShared,
10220 proto_perl->IMemParse,
10222 proto_perl->IStdIO,
10226 proto_perl->IProc);
10230 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10231 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10232 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10233 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10234 struct IPerlDir* ipD, struct IPerlSock* ipS,
10235 struct IPerlProc* ipP)
10237 /* XXX many of the string copies here can be optimized if they're
10238 * constants; they need to be allocated as common memory and just
10239 * their pointers copied. */
10242 CLONE_PARAMS clone_params;
10243 CLONE_PARAMS* param = &clone_params;
10245 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10246 /* for each stash, determine whether its objects should be cloned */
10247 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10248 PERL_SET_THX(my_perl);
10251 Poison(my_perl, 1, PerlInterpreter);
10253 PL_curcop = (COP *)Nullop;
10257 PL_savestack_ix = 0;
10258 PL_savestack_max = -1;
10259 PL_sig_pending = 0;
10260 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10261 # else /* !DEBUGGING */
10262 Zero(my_perl, 1, PerlInterpreter);
10263 # endif /* DEBUGGING */
10265 /* host pointers */
10267 PL_MemShared = ipMS;
10268 PL_MemParse = ipMP;
10275 #else /* !PERL_IMPLICIT_SYS */
10277 CLONE_PARAMS clone_params;
10278 CLONE_PARAMS* param = &clone_params;
10279 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10280 /* for each stash, determine whether its objects should be cloned */
10281 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10282 PERL_SET_THX(my_perl);
10285 Poison(my_perl, 1, PerlInterpreter);
10287 PL_curcop = (COP *)Nullop;
10291 PL_savestack_ix = 0;
10292 PL_savestack_max = -1;
10293 PL_sig_pending = 0;
10294 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10295 # else /* !DEBUGGING */
10296 Zero(my_perl, 1, PerlInterpreter);
10297 # endif /* DEBUGGING */
10298 #endif /* PERL_IMPLICIT_SYS */
10299 param->flags = flags;
10300 param->proto_perl = proto_perl;
10302 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10303 Zero(&PL_body_roots, 1, PL_body_roots);
10305 PL_nice_chunk = NULL;
10306 PL_nice_chunk_size = 0;
10308 PL_sv_objcount = 0;
10309 PL_sv_root = Nullsv;
10310 PL_sv_arenaroot = Nullsv;
10312 PL_debug = proto_perl->Idebug;
10314 PL_hash_seed = proto_perl->Ihash_seed;
10315 PL_rehash_seed = proto_perl->Irehash_seed;
10317 #ifdef USE_REENTRANT_API
10318 /* XXX: things like -Dm will segfault here in perlio, but doing
10319 * PERL_SET_CONTEXT(proto_perl);
10320 * breaks too many other things
10322 Perl_reentrant_init(aTHX);
10325 /* create SV map for pointer relocation */
10326 PL_ptr_table = ptr_table_new();
10328 /* initialize these special pointers as early as possible */
10329 SvANY(&PL_sv_undef) = NULL;
10330 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10331 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10332 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10334 SvANY(&PL_sv_no) = new_XPVNV();
10335 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10336 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10337 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10338 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10339 SvCUR_set(&PL_sv_no, 0);
10340 SvLEN_set(&PL_sv_no, 1);
10341 SvIV_set(&PL_sv_no, 0);
10342 SvNV_set(&PL_sv_no, 0);
10343 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10345 SvANY(&PL_sv_yes) = new_XPVNV();
10346 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10347 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10348 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10349 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10350 SvCUR_set(&PL_sv_yes, 1);
10351 SvLEN_set(&PL_sv_yes, 2);
10352 SvIV_set(&PL_sv_yes, 1);
10353 SvNV_set(&PL_sv_yes, 1);
10354 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10356 /* create (a non-shared!) shared string table */
10357 PL_strtab = newHV();
10358 HvSHAREKEYS_off(PL_strtab);
10359 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10360 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10362 PL_compiling = proto_perl->Icompiling;
10364 /* These two PVs will be free'd special way so must set them same way op.c does */
10365 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10366 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10368 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10369 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10371 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10372 if (!specialWARN(PL_compiling.cop_warnings))
10373 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10374 if (!specialCopIO(PL_compiling.cop_io))
10375 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10376 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10378 /* pseudo environmental stuff */
10379 PL_origargc = proto_perl->Iorigargc;
10380 PL_origargv = proto_perl->Iorigargv;
10382 param->stashes = newAV(); /* Setup array of objects to call clone on */
10384 /* Set tainting stuff before PerlIO_debug can possibly get called */
10385 PL_tainting = proto_perl->Itainting;
10386 PL_taint_warn = proto_perl->Itaint_warn;
10388 #ifdef PERLIO_LAYERS
10389 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10390 PerlIO_clone(aTHX_ proto_perl, param);
10393 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10394 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10395 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10396 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10397 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10398 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10401 PL_minus_c = proto_perl->Iminus_c;
10402 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10403 PL_localpatches = proto_perl->Ilocalpatches;
10404 PL_splitstr = proto_perl->Isplitstr;
10405 PL_preprocess = proto_perl->Ipreprocess;
10406 PL_minus_n = proto_perl->Iminus_n;
10407 PL_minus_p = proto_perl->Iminus_p;
10408 PL_minus_l = proto_perl->Iminus_l;
10409 PL_minus_a = proto_perl->Iminus_a;
10410 PL_minus_E = proto_perl->Iminus_E;
10411 PL_minus_F = proto_perl->Iminus_F;
10412 PL_doswitches = proto_perl->Idoswitches;
10413 PL_dowarn = proto_perl->Idowarn;
10414 PL_doextract = proto_perl->Idoextract;
10415 PL_sawampersand = proto_perl->Isawampersand;
10416 PL_unsafe = proto_perl->Iunsafe;
10417 PL_inplace = SAVEPV(proto_perl->Iinplace);
10418 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10419 PL_perldb = proto_perl->Iperldb;
10420 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10421 PL_exit_flags = proto_perl->Iexit_flags;
10423 /* magical thingies */
10424 /* XXX time(&PL_basetime) when asked for? */
10425 PL_basetime = proto_perl->Ibasetime;
10426 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10428 PL_maxsysfd = proto_perl->Imaxsysfd;
10429 PL_multiline = proto_perl->Imultiline;
10430 PL_statusvalue = proto_perl->Istatusvalue;
10432 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10434 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10436 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10438 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10439 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10440 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10442 /* Clone the regex array */
10443 PL_regex_padav = newAV();
10445 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10446 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10448 av_push(PL_regex_padav,
10449 sv_dup_inc(regexen[0],param));
10450 for(i = 1; i <= len; i++) {
10451 const SV * const regex = regexen[i];
10454 ? sv_dup_inc(regex, param)
10456 newSViv(PTR2IV(re_dup(
10457 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10459 av_push(PL_regex_padav, sv);
10462 PL_regex_pad = AvARRAY(PL_regex_padav);
10464 /* shortcuts to various I/O objects */
10465 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10466 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10467 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10468 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10469 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10470 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10472 /* shortcuts to regexp stuff */
10473 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10475 /* shortcuts to misc objects */
10476 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10478 /* shortcuts to debugging objects */
10479 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10480 PL_DBline = gv_dup(proto_perl->IDBline, param);
10481 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10482 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10483 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10484 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10485 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10486 PL_lineary = av_dup(proto_perl->Ilineary, param);
10487 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10489 /* symbol tables */
10490 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10491 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10492 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10493 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10494 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10496 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10497 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10498 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10499 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10500 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10501 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10503 PL_sub_generation = proto_perl->Isub_generation;
10505 /* funky return mechanisms */
10506 PL_forkprocess = proto_perl->Iforkprocess;
10508 /* subprocess state */
10509 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10511 /* internal state */
10512 PL_maxo = proto_perl->Imaxo;
10513 if (proto_perl->Iop_mask)
10514 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10516 PL_op_mask = Nullch;
10517 /* PL_asserting = proto_perl->Iasserting; */
10519 /* current interpreter roots */
10520 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10521 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10522 PL_main_start = proto_perl->Imain_start;
10523 PL_eval_root = proto_perl->Ieval_root;
10524 PL_eval_start = proto_perl->Ieval_start;
10526 /* runtime control stuff */
10527 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10528 PL_copline = proto_perl->Icopline;
10530 PL_filemode = proto_perl->Ifilemode;
10531 PL_lastfd = proto_perl->Ilastfd;
10532 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10535 PL_gensym = proto_perl->Igensym;
10536 PL_preambled = proto_perl->Ipreambled;
10537 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10538 PL_laststatval = proto_perl->Ilaststatval;
10539 PL_laststype = proto_perl->Ilaststype;
10540 PL_mess_sv = Nullsv;
10542 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10544 /* interpreter atexit processing */
10545 PL_exitlistlen = proto_perl->Iexitlistlen;
10546 if (PL_exitlistlen) {
10547 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10548 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10551 PL_exitlist = (PerlExitListEntry*)NULL;
10553 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10554 if (PL_my_cxt_size) {
10555 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10556 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10559 PL_my_cxt_list = (void**)NULL;
10560 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10561 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10562 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10564 PL_profiledata = NULL;
10565 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10566 /* PL_rsfp_filters entries have fake IoDIRP() */
10567 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10569 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10571 PAD_CLONE_VARS(proto_perl, param);
10573 #ifdef HAVE_INTERP_INTERN
10574 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10577 /* more statics moved here */
10578 PL_generation = proto_perl->Igeneration;
10579 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10581 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10582 PL_in_clean_all = proto_perl->Iin_clean_all;
10584 PL_uid = proto_perl->Iuid;
10585 PL_euid = proto_perl->Ieuid;
10586 PL_gid = proto_perl->Igid;
10587 PL_egid = proto_perl->Iegid;
10588 PL_nomemok = proto_perl->Inomemok;
10589 PL_an = proto_perl->Ian;
10590 PL_evalseq = proto_perl->Ievalseq;
10591 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10592 PL_origalen = proto_perl->Iorigalen;
10593 #ifdef PERL_USES_PL_PIDSTATUS
10594 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10596 PL_osname = SAVEPV(proto_perl->Iosname);
10597 PL_sighandlerp = proto_perl->Isighandlerp;
10599 PL_runops = proto_perl->Irunops;
10601 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10604 PL_cshlen = proto_perl->Icshlen;
10605 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10608 PL_lex_state = proto_perl->Ilex_state;
10609 PL_lex_defer = proto_perl->Ilex_defer;
10610 PL_lex_expect = proto_perl->Ilex_expect;
10611 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10612 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10613 PL_lex_starts = proto_perl->Ilex_starts;
10614 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10615 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10616 PL_lex_op = proto_perl->Ilex_op;
10617 PL_lex_inpat = proto_perl->Ilex_inpat;
10618 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10619 PL_lex_brackets = proto_perl->Ilex_brackets;
10620 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10621 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10622 PL_lex_casemods = proto_perl->Ilex_casemods;
10623 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10624 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10626 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10627 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10628 PL_nexttoke = proto_perl->Inexttoke;
10630 /* XXX This is probably masking the deeper issue of why
10631 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10632 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10633 * (A little debugging with a watchpoint on it may help.)
10635 if (SvANY(proto_perl->Ilinestr)) {
10636 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10637 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10638 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10639 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10640 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10641 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10642 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10643 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10644 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10647 PL_linestr = NEWSV(65,79);
10648 sv_upgrade(PL_linestr,SVt_PVIV);
10649 sv_setpvn(PL_linestr,"",0);
10650 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10652 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10653 PL_pending_ident = proto_perl->Ipending_ident;
10654 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10656 PL_expect = proto_perl->Iexpect;
10658 PL_multi_start = proto_perl->Imulti_start;
10659 PL_multi_end = proto_perl->Imulti_end;
10660 PL_multi_open = proto_perl->Imulti_open;
10661 PL_multi_close = proto_perl->Imulti_close;
10663 PL_error_count = proto_perl->Ierror_count;
10664 PL_subline = proto_perl->Isubline;
10665 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10667 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10668 if (SvANY(proto_perl->Ilinestr)) {
10669 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10670 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10671 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10672 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10673 PL_last_lop_op = proto_perl->Ilast_lop_op;
10676 PL_last_uni = SvPVX(PL_linestr);
10677 PL_last_lop = SvPVX(PL_linestr);
10678 PL_last_lop_op = 0;
10680 PL_in_my = proto_perl->Iin_my;
10681 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10683 PL_cryptseen = proto_perl->Icryptseen;
10686 PL_hints = proto_perl->Ihints;
10688 PL_amagic_generation = proto_perl->Iamagic_generation;
10690 #ifdef USE_LOCALE_COLLATE
10691 PL_collation_ix = proto_perl->Icollation_ix;
10692 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10693 PL_collation_standard = proto_perl->Icollation_standard;
10694 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10695 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10696 #endif /* USE_LOCALE_COLLATE */
10698 #ifdef USE_LOCALE_NUMERIC
10699 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10700 PL_numeric_standard = proto_perl->Inumeric_standard;
10701 PL_numeric_local = proto_perl->Inumeric_local;
10702 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10703 #endif /* !USE_LOCALE_NUMERIC */
10705 /* utf8 character classes */
10706 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10707 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10708 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10709 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10710 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10711 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10712 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10713 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10714 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10715 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10716 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10717 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10718 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10719 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10720 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10721 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10722 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10723 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10724 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10725 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10727 /* Did the locale setup indicate UTF-8? */
10728 PL_utf8locale = proto_perl->Iutf8locale;
10729 /* Unicode features (see perlrun/-C) */
10730 PL_unicode = proto_perl->Iunicode;
10732 /* Pre-5.8 signals control */
10733 PL_signals = proto_perl->Isignals;
10735 /* times() ticks per second */
10736 PL_clocktick = proto_perl->Iclocktick;
10738 /* Recursion stopper for PerlIO_find_layer */
10739 PL_in_load_module = proto_perl->Iin_load_module;
10741 /* sort() routine */
10742 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10744 /* Not really needed/useful since the reenrant_retint is "volatile",
10745 * but do it for consistency's sake. */
10746 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10748 /* Hooks to shared SVs and locks. */
10749 PL_sharehook = proto_perl->Isharehook;
10750 PL_lockhook = proto_perl->Ilockhook;
10751 PL_unlockhook = proto_perl->Iunlockhook;
10752 PL_threadhook = proto_perl->Ithreadhook;
10754 PL_runops_std = proto_perl->Irunops_std;
10755 PL_runops_dbg = proto_perl->Irunops_dbg;
10757 #ifdef THREADS_HAVE_PIDS
10758 PL_ppid = proto_perl->Ippid;
10762 PL_last_swash_hv = NULL; /* reinits on demand */
10763 PL_last_swash_klen = 0;
10764 PL_last_swash_key[0]= '\0';
10765 PL_last_swash_tmps = (U8*)NULL;
10766 PL_last_swash_slen = 0;
10768 PL_glob_index = proto_perl->Iglob_index;
10769 PL_srand_called = proto_perl->Isrand_called;
10770 PL_uudmap['M'] = 0; /* reinits on demand */
10771 PL_bitcount = Nullch; /* reinits on demand */
10773 if (proto_perl->Ipsig_pend) {
10774 Newxz(PL_psig_pend, SIG_SIZE, int);
10777 PL_psig_pend = (int*)NULL;
10780 if (proto_perl->Ipsig_ptr) {
10781 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10782 Newxz(PL_psig_name, SIG_SIZE, SV*);
10783 for (i = 1; i < SIG_SIZE; i++) {
10784 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10785 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10789 PL_psig_ptr = (SV**)NULL;
10790 PL_psig_name = (SV**)NULL;
10793 /* thrdvar.h stuff */
10795 if (flags & CLONEf_COPY_STACKS) {
10796 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10797 PL_tmps_ix = proto_perl->Ttmps_ix;
10798 PL_tmps_max = proto_perl->Ttmps_max;
10799 PL_tmps_floor = proto_perl->Ttmps_floor;
10800 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10802 while (i <= PL_tmps_ix) {
10803 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10807 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10808 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10809 Newxz(PL_markstack, i, I32);
10810 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10811 - proto_perl->Tmarkstack);
10812 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10813 - proto_perl->Tmarkstack);
10814 Copy(proto_perl->Tmarkstack, PL_markstack,
10815 PL_markstack_ptr - PL_markstack + 1, I32);
10817 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10818 * NOTE: unlike the others! */
10819 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10820 PL_scopestack_max = proto_perl->Tscopestack_max;
10821 Newxz(PL_scopestack, PL_scopestack_max, I32);
10822 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10824 /* NOTE: si_dup() looks at PL_markstack */
10825 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10827 /* PL_curstack = PL_curstackinfo->si_stack; */
10828 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10829 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10831 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10832 PL_stack_base = AvARRAY(PL_curstack);
10833 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10834 - proto_perl->Tstack_base);
10835 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10837 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10838 * NOTE: unlike the others! */
10839 PL_savestack_ix = proto_perl->Tsavestack_ix;
10840 PL_savestack_max = proto_perl->Tsavestack_max;
10841 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10842 PL_savestack = ss_dup(proto_perl, param);
10846 ENTER; /* perl_destruct() wants to LEAVE; */
10848 /* although we're not duplicating the tmps stack, we should still
10849 * add entries for any SVs on the tmps stack that got cloned by a
10850 * non-refcount means (eg a temp in @_); otherwise they will be
10853 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10854 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10855 proto_perl->Ttmps_stack[i]);
10856 if (nsv && !SvREFCNT(nsv)) {
10858 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10863 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10864 PL_top_env = &PL_start_env;
10866 PL_op = proto_perl->Top;
10869 PL_Xpv = (XPV*)NULL;
10870 PL_na = proto_perl->Tna;
10872 PL_statbuf = proto_perl->Tstatbuf;
10873 PL_statcache = proto_perl->Tstatcache;
10874 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10875 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10877 PL_timesbuf = proto_perl->Ttimesbuf;
10880 PL_tainted = proto_perl->Ttainted;
10881 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10882 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10883 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10884 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10885 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10886 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10887 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10888 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10889 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10891 PL_restartop = proto_perl->Trestartop;
10892 PL_in_eval = proto_perl->Tin_eval;
10893 PL_delaymagic = proto_perl->Tdelaymagic;
10894 PL_dirty = proto_perl->Tdirty;
10895 PL_localizing = proto_perl->Tlocalizing;
10897 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10898 PL_hv_fetch_ent_mh = Nullhe;
10899 PL_modcount = proto_perl->Tmodcount;
10900 PL_lastgotoprobe = Nullop;
10901 PL_dumpindent = proto_perl->Tdumpindent;
10903 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10904 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10905 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10906 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10907 PL_efloatbuf = Nullch; /* reinits on demand */
10908 PL_efloatsize = 0; /* reinits on demand */
10912 PL_screamfirst = NULL;
10913 PL_screamnext = NULL;
10914 PL_maxscream = -1; /* reinits on demand */
10915 PL_lastscream = Nullsv;
10917 PL_watchaddr = NULL;
10918 PL_watchok = Nullch;
10920 PL_regdummy = proto_perl->Tregdummy;
10921 PL_regprecomp = Nullch;
10924 PL_colorset = 0; /* reinits PL_colors[] */
10925 /*PL_colors[6] = {0,0,0,0,0,0};*/
10926 PL_reginput = Nullch;
10927 PL_regbol = Nullch;
10928 PL_regeol = Nullch;
10929 PL_regstartp = (I32*)NULL;
10930 PL_regendp = (I32*)NULL;
10931 PL_reglastparen = (U32*)NULL;
10932 PL_reglastcloseparen = (U32*)NULL;
10933 PL_regtill = Nullch;
10934 PL_reg_start_tmp = (char**)NULL;
10935 PL_reg_start_tmpl = 0;
10936 PL_regdata = (struct reg_data*)NULL;
10939 PL_reg_eval_set = 0;
10941 PL_regprogram = (regnode*)NULL;
10943 PL_regcc = (CURCUR*)NULL;
10944 PL_reg_call_cc = (struct re_cc_state*)NULL;
10945 PL_reg_re = (regexp*)NULL;
10946 PL_reg_ganch = Nullch;
10947 PL_reg_sv = Nullsv;
10948 PL_reg_match_utf8 = FALSE;
10949 PL_reg_magic = (MAGIC*)NULL;
10951 PL_reg_oldcurpm = (PMOP*)NULL;
10952 PL_reg_curpm = (PMOP*)NULL;
10953 PL_reg_oldsaved = Nullch;
10954 PL_reg_oldsavedlen = 0;
10955 #ifdef PERL_OLD_COPY_ON_WRITE
10958 PL_reg_maxiter = 0;
10959 PL_reg_leftiter = 0;
10960 PL_reg_poscache = Nullch;
10961 PL_reg_poscache_size= 0;
10963 /* RE engine - function pointers */
10964 PL_regcompp = proto_perl->Tregcompp;
10965 PL_regexecp = proto_perl->Tregexecp;
10966 PL_regint_start = proto_perl->Tregint_start;
10967 PL_regint_string = proto_perl->Tregint_string;
10968 PL_regfree = proto_perl->Tregfree;
10970 PL_reginterp_cnt = 0;
10971 PL_reg_starttry = 0;
10973 /* Pluggable optimizer */
10974 PL_peepp = proto_perl->Tpeepp;
10976 PL_stashcache = newHV();
10978 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10979 ptr_table_free(PL_ptr_table);
10980 PL_ptr_table = NULL;
10983 /* Call the ->CLONE method, if it exists, for each of the stashes
10984 identified by sv_dup() above.
10986 while(av_len(param->stashes) != -1) {
10987 HV* const stash = (HV*) av_shift(param->stashes);
10988 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10989 if (cloner && GvCV(cloner)) {
10994 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10996 call_sv((SV*)GvCV(cloner), G_DISCARD);
11002 SvREFCNT_dec(param->stashes);
11004 /* orphaned? eg threads->new inside BEGIN or use */
11005 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11006 (void)SvREFCNT_inc(PL_compcv);
11007 SAVEFREESV(PL_compcv);
11013 #endif /* USE_ITHREADS */
11016 =head1 Unicode Support
11018 =for apidoc sv_recode_to_utf8
11020 The encoding is assumed to be an Encode object, on entry the PV
11021 of the sv is assumed to be octets in that encoding, and the sv
11022 will be converted into Unicode (and UTF-8).
11024 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11025 is not a reference, nothing is done to the sv. If the encoding is not
11026 an C<Encode::XS> Encoding object, bad things will happen.
11027 (See F<lib/encoding.pm> and L<Encode>).
11029 The PV of the sv is returned.
11034 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11037 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11051 Passing sv_yes is wrong - it needs to be or'ed set of constants
11052 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11053 remove converted chars from source.
11055 Both will default the value - let them.
11057 XPUSHs(&PL_sv_yes);
11060 call_method("decode", G_SCALAR);
11064 s = SvPV_const(uni, len);
11065 if (s != SvPVX_const(sv)) {
11066 SvGROW(sv, len + 1);
11067 Move(s, SvPVX(sv), len + 1, char);
11068 SvCUR_set(sv, len);
11075 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11079 =for apidoc sv_cat_decode
11081 The encoding is assumed to be an Encode object, the PV of the ssv is
11082 assumed to be octets in that encoding and decoding the input starts
11083 from the position which (PV + *offset) pointed to. The dsv will be
11084 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11085 when the string tstr appears in decoding output or the input ends on
11086 the PV of the ssv. The value which the offset points will be modified
11087 to the last input position on the ssv.
11089 Returns TRUE if the terminator was found, else returns FALSE.
11094 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11095 SV *ssv, int *offset, char *tstr, int tlen)
11099 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11110 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11111 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11113 call_method("cat_decode", G_SCALAR);
11115 ret = SvTRUE(TOPs);
11116 *offset = SvIV(offsv);
11122 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11127 /* ---------------------------------------------------------------------
11129 * support functions for report_uninit()
11132 /* the maxiumum size of array or hash where we will scan looking
11133 * for the undefined element that triggered the warning */
11135 #define FUV_MAX_SEARCH_SIZE 1000
11137 /* Look for an entry in the hash whose value has the same SV as val;
11138 * If so, return a mortal copy of the key. */
11141 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11144 register HE **array;
11147 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11148 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11151 array = HvARRAY(hv);
11153 for (i=HvMAX(hv); i>0; i--) {
11154 register HE *entry;
11155 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11156 if (HeVAL(entry) != val)
11158 if ( HeVAL(entry) == &PL_sv_undef ||
11159 HeVAL(entry) == &PL_sv_placeholder)
11163 if (HeKLEN(entry) == HEf_SVKEY)
11164 return sv_mortalcopy(HeKEY_sv(entry));
11165 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11171 /* Look for an entry in the array whose value has the same SV as val;
11172 * If so, return the index, otherwise return -1. */
11175 S_find_array_subscript(pTHX_ AV *av, SV* val)
11180 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11181 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11185 for (i=AvFILLp(av); i>=0; i--) {
11186 if (svp[i] == val && svp[i] != &PL_sv_undef)
11192 /* S_varname(): return the name of a variable, optionally with a subscript.
11193 * If gv is non-zero, use the name of that global, along with gvtype (one
11194 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11195 * targ. Depending on the value of the subscript_type flag, return:
11198 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11199 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11200 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11201 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11204 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11205 SV* keyname, I32 aindex, int subscript_type)
11208 SV * const name = sv_newmortal();
11211 buffer[0] = gvtype;
11214 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11216 gv_fullname4(name, gv, buffer, 0);
11218 if ((unsigned int)SvPVX(name)[1] <= 26) {
11220 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11222 /* Swap the 1 unprintable control character for the 2 byte pretty
11223 version - ie substr($name, 1, 1) = $buffer; */
11224 sv_insert(name, 1, 1, buffer, 2);
11229 CV * const cv = find_runcv(&unused);
11233 if (!cv || !CvPADLIST(cv))
11235 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11236 sv = *av_fetch(av, targ, FALSE);
11237 /* SvLEN in a pad name is not to be trusted */
11238 sv_setpv(name, SvPV_nolen_const(sv));
11241 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11242 SV * const sv = NEWSV(0,0);
11243 *SvPVX(name) = '$';
11244 Perl_sv_catpvf(aTHX_ name, "{%s}",
11245 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11248 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11249 *SvPVX(name) = '$';
11250 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11252 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11253 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11260 =for apidoc find_uninit_var
11262 Find the name of the undefined variable (if any) that caused the operator o
11263 to issue a "Use of uninitialized value" warning.
11264 If match is true, only return a name if it's value matches uninit_sv.
11265 So roughly speaking, if a unary operator (such as OP_COS) generates a
11266 warning, then following the direct child of the op may yield an
11267 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11268 other hand, with OP_ADD there are two branches to follow, so we only print
11269 the variable name if we get an exact match.
11271 The name is returned as a mortal SV.
11273 Assumes that PL_op is the op that originally triggered the error, and that
11274 PL_comppad/PL_curpad points to the currently executing pad.
11280 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11288 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11289 uninit_sv == &PL_sv_placeholder)))
11292 switch (obase->op_type) {
11299 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11300 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11302 SV *keysv = Nullsv;
11303 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11305 if (pad) { /* @lex, %lex */
11306 sv = PAD_SVl(obase->op_targ);
11310 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11311 /* @global, %global */
11312 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11315 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11317 else /* @{expr}, %{expr} */
11318 return find_uninit_var(cUNOPx(obase)->op_first,
11322 /* attempt to find a match within the aggregate */
11324 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11326 subscript_type = FUV_SUBSCRIPT_HASH;
11329 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11331 subscript_type = FUV_SUBSCRIPT_ARRAY;
11334 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11337 return varname(gv, hash ? '%' : '@', obase->op_targ,
11338 keysv, index, subscript_type);
11342 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11344 return varname(Nullgv, '$', obase->op_targ,
11345 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11348 gv = cGVOPx_gv(obase);
11349 if (!gv || (match && GvSV(gv) != uninit_sv))
11351 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11354 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11357 av = (AV*)PAD_SV(obase->op_targ);
11358 if (!av || SvRMAGICAL(av))
11360 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11361 if (!svp || *svp != uninit_sv)
11364 return varname(Nullgv, '$', obase->op_targ,
11365 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11368 gv = cGVOPx_gv(obase);
11374 if (!av || SvRMAGICAL(av))
11376 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11377 if (!svp || *svp != uninit_sv)
11380 return varname(gv, '$', 0,
11381 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11386 o = cUNOPx(obase)->op_first;
11387 if (!o || o->op_type != OP_NULL ||
11388 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11390 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11394 if (PL_op == obase)
11395 /* $a[uninit_expr] or $h{uninit_expr} */
11396 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11399 o = cBINOPx(obase)->op_first;
11400 kid = cBINOPx(obase)->op_last;
11402 /* get the av or hv, and optionally the gv */
11404 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11405 sv = PAD_SV(o->op_targ);
11407 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11408 && cUNOPo->op_first->op_type == OP_GV)
11410 gv = cGVOPx_gv(cUNOPo->op_first);
11413 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11418 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11419 /* index is constant */
11423 if (obase->op_type == OP_HELEM) {
11424 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11425 if (!he || HeVAL(he) != uninit_sv)
11429 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11430 if (!svp || *svp != uninit_sv)
11434 if (obase->op_type == OP_HELEM)
11435 return varname(gv, '%', o->op_targ,
11436 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11438 return varname(gv, '@', o->op_targ, Nullsv,
11439 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11442 /* index is an expression;
11443 * attempt to find a match within the aggregate */
11444 if (obase->op_type == OP_HELEM) {
11445 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11447 return varname(gv, '%', o->op_targ,
11448 keysv, 0, FUV_SUBSCRIPT_HASH);
11451 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11453 return varname(gv, '@', o->op_targ,
11454 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11459 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11461 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11467 /* only examine RHS */
11468 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11471 o = cUNOPx(obase)->op_first;
11472 if (o->op_type == OP_PUSHMARK)
11475 if (!o->op_sibling) {
11476 /* one-arg version of open is highly magical */
11478 if (o->op_type == OP_GV) { /* open FOO; */
11480 if (match && GvSV(gv) != uninit_sv)
11482 return varname(gv, '$', 0,
11483 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11485 /* other possibilities not handled are:
11486 * open $x; or open my $x; should return '${*$x}'
11487 * open expr; should return '$'.expr ideally
11493 /* ops where $_ may be an implicit arg */
11497 if ( !(obase->op_flags & OPf_STACKED)) {
11498 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11499 ? PAD_SVl(obase->op_targ)
11502 sv = sv_newmortal();
11503 sv_setpvn(sv, "$_", 2);
11511 /* skip filehandle as it can't produce 'undef' warning */
11512 o = cUNOPx(obase)->op_first;
11513 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11514 o = o->op_sibling->op_sibling;
11521 match = 1; /* XS or custom code could trigger random warnings */
11526 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11527 return sv_2mortal(newSVpvs("${$/}"));
11532 if (!(obase->op_flags & OPf_KIDS))
11534 o = cUNOPx(obase)->op_first;
11540 /* if all except one arg are constant, or have no side-effects,
11541 * or are optimized away, then it's unambiguous */
11543 for (kid=o; kid; kid = kid->op_sibling) {
11545 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11546 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11547 || (kid->op_type == OP_PUSHMARK)
11551 if (o2) { /* more than one found */
11558 return find_uninit_var(o2, uninit_sv, match);
11560 /* scan all args */
11562 sv = find_uninit_var(o, uninit_sv, 1);
11574 =for apidoc report_uninit
11576 Print appropriate "Use of uninitialized variable" warning
11582 Perl_report_uninit(pTHX_ SV* uninit_sv)
11586 SV* varname = Nullsv;
11588 varname = find_uninit_var(PL_op, uninit_sv,0);
11590 sv_insert(varname, 0, 0, " ", 1);
11592 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11593 varname ? SvPV_nolen_const(varname) : "",
11594 " in ", OP_DESC(PL_op));
11597 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11603 * c-indentation-style: bsd
11604 * c-basic-offset: 4
11605 * indent-tabs-mode: t
11608 * ex: set ts=8 sts=4 sw=4 noet: