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) */
1093 SvPV_set(sv, (char*)0);
1095 if (old_type >= SVt_PVMG) {
1096 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1097 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
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", new_type);
1158 if (old_type_details->size) {
1159 /* If the old body had an allocated size, then we need to free it. */
1161 my_safefree(old_body);
1163 del_body((void*)((char*)old_body + old_type_details->offset),
1164 &PL_body_roots[old_type]);
1170 =for apidoc sv_backoff
1172 Remove any string offset. You should normally use the C<SvOOK_off> macro
1179 Perl_sv_backoff(pTHX_ register SV *sv)
1182 assert(SvTYPE(sv) != SVt_PVHV);
1183 assert(SvTYPE(sv) != SVt_PVAV);
1185 const char * const s = SvPVX_const(sv);
1186 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1187 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1189 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1191 SvFLAGS(sv) &= ~SVf_OOK;
1198 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1199 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1200 Use the C<SvGROW> wrapper instead.
1206 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1210 #ifdef HAS_64K_LIMIT
1211 if (newlen >= 0x10000) {
1212 PerlIO_printf(Perl_debug_log,
1213 "Allocation too large: %"UVxf"\n", (UV)newlen);
1216 #endif /* HAS_64K_LIMIT */
1219 if (SvTYPE(sv) < SVt_PV) {
1220 sv_upgrade(sv, SVt_PV);
1221 s = SvPVX_mutable(sv);
1223 else if (SvOOK(sv)) { /* pv is offset? */
1225 s = SvPVX_mutable(sv);
1226 if (newlen > SvLEN(sv))
1227 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1228 #ifdef HAS_64K_LIMIT
1229 if (newlen >= 0x10000)
1234 s = SvPVX_mutable(sv);
1236 if (newlen > SvLEN(sv)) { /* need more room? */
1237 newlen = PERL_STRLEN_ROUNDUP(newlen);
1238 if (SvLEN(sv) && s) {
1240 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1246 s = saferealloc(s, newlen);
1249 s = safemalloc(newlen);
1250 if (SvPVX_const(sv) && SvCUR(sv)) {
1251 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1255 SvLEN_set(sv, newlen);
1261 =for apidoc sv_setiv
1263 Copies an integer into the given SV, upgrading first if necessary.
1264 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1270 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1273 SV_CHECK_THINKFIRST_COW_DROP(sv);
1274 switch (SvTYPE(sv)) {
1276 sv_upgrade(sv, SVt_IV);
1279 sv_upgrade(sv, SVt_PVNV);
1283 sv_upgrade(sv, SVt_PVIV);
1292 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1295 (void)SvIOK_only(sv); /* validate number */
1301 =for apidoc sv_setiv_mg
1303 Like C<sv_setiv>, but also handles 'set' magic.
1309 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1316 =for apidoc sv_setuv
1318 Copies an unsigned integer into the given SV, upgrading first if necessary.
1319 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1325 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1327 /* With these two if statements:
1328 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1331 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1333 If you wish to remove them, please benchmark to see what the effect is
1335 if (u <= (UV)IV_MAX) {
1336 sv_setiv(sv, (IV)u);
1345 =for apidoc sv_setuv_mg
1347 Like C<sv_setuv>, but also handles 'set' magic.
1353 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1362 =for apidoc sv_setnv
1364 Copies a double into the given SV, upgrading first if necessary.
1365 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1371 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1374 SV_CHECK_THINKFIRST_COW_DROP(sv);
1375 switch (SvTYPE(sv)) {
1378 sv_upgrade(sv, SVt_NV);
1383 sv_upgrade(sv, SVt_PVNV);
1392 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1396 (void)SvNOK_only(sv); /* validate number */
1401 =for apidoc sv_setnv_mg
1403 Like C<sv_setnv>, but also handles 'set' magic.
1409 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1415 /* Print an "isn't numeric" warning, using a cleaned-up,
1416 * printable version of the offending string
1420 S_not_a_number(pTHX_ SV *sv)
1428 dsv = sv_2mortal(newSVpvs(""));
1429 pv = sv_uni_display(dsv, sv, 10, 0);
1432 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1433 /* each *s can expand to 4 chars + "...\0",
1434 i.e. need room for 8 chars */
1436 const char *s = SvPVX_const(sv);
1437 const char * const end = s + SvCUR(sv);
1438 for ( ; s < end && d < limit; s++ ) {
1440 if (ch & 128 && !isPRINT_LC(ch)) {
1449 else if (ch == '\r') {
1453 else if (ch == '\f') {
1457 else if (ch == '\\') {
1461 else if (ch == '\0') {
1465 else if (isPRINT_LC(ch))
1482 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1483 "Argument \"%s\" isn't numeric in %s", pv,
1486 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1487 "Argument \"%s\" isn't numeric", pv);
1491 =for apidoc looks_like_number
1493 Test if the content of an SV looks like a number (or is a number).
1494 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1495 non-numeric warning), even if your atof() doesn't grok them.
1501 Perl_looks_like_number(pTHX_ SV *sv)
1503 register const char *sbegin;
1507 sbegin = SvPVX_const(sv);
1510 else if (SvPOKp(sv))
1511 sbegin = SvPV_const(sv, len);
1513 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1514 return grok_number(sbegin, len, NULL);
1517 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1518 until proven guilty, assume that things are not that bad... */
1523 As 64 bit platforms often have an NV that doesn't preserve all bits of
1524 an IV (an assumption perl has been based on to date) it becomes necessary
1525 to remove the assumption that the NV always carries enough precision to
1526 recreate the IV whenever needed, and that the NV is the canonical form.
1527 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1528 precision as a side effect of conversion (which would lead to insanity
1529 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1530 1) to distinguish between IV/UV/NV slots that have cached a valid
1531 conversion where precision was lost and IV/UV/NV slots that have a
1532 valid conversion which has lost no precision
1533 2) to ensure that if a numeric conversion to one form is requested that
1534 would lose precision, the precise conversion (or differently
1535 imprecise conversion) is also performed and cached, to prevent
1536 requests for different numeric formats on the same SV causing
1537 lossy conversion chains. (lossless conversion chains are perfectly
1542 SvIOKp is true if the IV slot contains a valid value
1543 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1544 SvNOKp is true if the NV slot contains a valid value
1545 SvNOK is true only if the NV value is accurate
1548 while converting from PV to NV, check to see if converting that NV to an
1549 IV(or UV) would lose accuracy over a direct conversion from PV to
1550 IV(or UV). If it would, cache both conversions, return NV, but mark
1551 SV as IOK NOKp (ie not NOK).
1553 While converting from PV to IV, check to see if converting that IV to an
1554 NV would lose accuracy over a direct conversion from PV to NV. If it
1555 would, cache both conversions, flag similarly.
1557 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1558 correctly because if IV & NV were set NV *always* overruled.
1559 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1560 changes - now IV and NV together means that the two are interchangeable:
1561 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1563 The benefit of this is that operations such as pp_add know that if
1564 SvIOK is true for both left and right operands, then integer addition
1565 can be used instead of floating point (for cases where the result won't
1566 overflow). Before, floating point was always used, which could lead to
1567 loss of precision compared with integer addition.
1569 * making IV and NV equal status should make maths accurate on 64 bit
1571 * may speed up maths somewhat if pp_add and friends start to use
1572 integers when possible instead of fp. (Hopefully the overhead in
1573 looking for SvIOK and checking for overflow will not outweigh the
1574 fp to integer speedup)
1575 * will slow down integer operations (callers of SvIV) on "inaccurate"
1576 values, as the change from SvIOK to SvIOKp will cause a call into
1577 sv_2iv each time rather than a macro access direct to the IV slot
1578 * should speed up number->string conversion on integers as IV is
1579 favoured when IV and NV are equally accurate
1581 ####################################################################
1582 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1583 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1584 On the other hand, SvUOK is true iff UV.
1585 ####################################################################
1587 Your mileage will vary depending your CPU's relative fp to integer
1591 #ifndef NV_PRESERVES_UV
1592 # define IS_NUMBER_UNDERFLOW_IV 1
1593 # define IS_NUMBER_UNDERFLOW_UV 2
1594 # define IS_NUMBER_IV_AND_UV 2
1595 # define IS_NUMBER_OVERFLOW_IV 4
1596 # define IS_NUMBER_OVERFLOW_UV 5
1598 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1600 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1602 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1605 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));
1606 if (SvNVX(sv) < (NV)IV_MIN) {
1607 (void)SvIOKp_on(sv);
1609 SvIV_set(sv, IV_MIN);
1610 return IS_NUMBER_UNDERFLOW_IV;
1612 if (SvNVX(sv) > (NV)UV_MAX) {
1613 (void)SvIOKp_on(sv);
1616 SvUV_set(sv, UV_MAX);
1617 return IS_NUMBER_OVERFLOW_UV;
1619 (void)SvIOKp_on(sv);
1621 /* Can't use strtol etc to convert this string. (See truth table in
1623 if (SvNVX(sv) <= (UV)IV_MAX) {
1624 SvIV_set(sv, I_V(SvNVX(sv)));
1625 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1626 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1628 /* Integer is imprecise. NOK, IOKp */
1630 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1633 SvUV_set(sv, U_V(SvNVX(sv)));
1634 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1635 if (SvUVX(sv) == UV_MAX) {
1636 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1637 possibly be preserved by NV. Hence, it must be overflow.
1639 return IS_NUMBER_OVERFLOW_UV;
1641 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1643 /* Integer is imprecise. NOK, IOKp */
1645 return IS_NUMBER_OVERFLOW_IV;
1647 #endif /* !NV_PRESERVES_UV*/
1650 S_sv_2iuv_common(pTHX_ SV *sv) {
1653 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1654 * without also getting a cached IV/UV from it at the same time
1655 * (ie PV->NV conversion should detect loss of accuracy and cache
1656 * IV or UV at same time to avoid this. */
1657 /* IV-over-UV optimisation - choose to cache IV if possible */
1659 if (SvTYPE(sv) == SVt_NV)
1660 sv_upgrade(sv, SVt_PVNV);
1662 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1663 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1664 certainly cast into the IV range at IV_MAX, whereas the correct
1665 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1667 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1668 SvIV_set(sv, I_V(SvNVX(sv)));
1669 if (SvNVX(sv) == (NV) SvIVX(sv)
1670 #ifndef NV_PRESERVES_UV
1671 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1672 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1673 /* Don't flag it as "accurately an integer" if the number
1674 came from a (by definition imprecise) NV operation, and
1675 we're outside the range of NV integer precision */
1678 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1679 DEBUG_c(PerlIO_printf(Perl_debug_log,
1680 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1686 /* IV not precise. No need to convert from PV, as NV
1687 conversion would already have cached IV if it detected
1688 that PV->IV would be better than PV->NV->IV
1689 flags already correct - don't set public IOK. */
1690 DEBUG_c(PerlIO_printf(Perl_debug_log,
1691 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1696 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1697 but the cast (NV)IV_MIN rounds to a the value less (more
1698 negative) than IV_MIN which happens to be equal to SvNVX ??
1699 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1700 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1701 (NV)UVX == NVX are both true, but the values differ. :-(
1702 Hopefully for 2s complement IV_MIN is something like
1703 0x8000000000000000 which will be exact. NWC */
1706 SvUV_set(sv, U_V(SvNVX(sv)));
1708 (SvNVX(sv) == (NV) SvUVX(sv))
1709 #ifndef NV_PRESERVES_UV
1710 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1711 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1712 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1713 /* Don't flag it as "accurately an integer" if the number
1714 came from a (by definition imprecise) NV operation, and
1715 we're outside the range of NV integer precision */
1720 DEBUG_c(PerlIO_printf(Perl_debug_log,
1721 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1727 else if (SvPOKp(sv) && SvLEN(sv)) {
1729 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1730 /* We want to avoid a possible problem when we cache an IV/ a UV which
1731 may be later translated to an NV, and the resulting NV is not
1732 the same as the direct translation of the initial string
1733 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1734 be careful to ensure that the value with the .456 is around if the
1735 NV value is requested in the future).
1737 This means that if we cache such an IV/a UV, we need to cache the
1738 NV as well. Moreover, we trade speed for space, and do not
1739 cache the NV if we are sure it's not needed.
1742 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1743 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1744 == IS_NUMBER_IN_UV) {
1745 /* It's definitely an integer, only upgrade to PVIV */
1746 if (SvTYPE(sv) < SVt_PVIV)
1747 sv_upgrade(sv, SVt_PVIV);
1749 } else if (SvTYPE(sv) < SVt_PVNV)
1750 sv_upgrade(sv, SVt_PVNV);
1752 /* If NVs preserve UVs then we only use the UV value if we know that
1753 we aren't going to call atof() below. If NVs don't preserve UVs
1754 then the value returned may have more precision than atof() will
1755 return, even though value isn't perfectly accurate. */
1756 if ((numtype & (IS_NUMBER_IN_UV
1757 #ifdef NV_PRESERVES_UV
1760 )) == IS_NUMBER_IN_UV) {
1761 /* This won't turn off the public IOK flag if it was set above */
1762 (void)SvIOKp_on(sv);
1764 if (!(numtype & IS_NUMBER_NEG)) {
1766 if (value <= (UV)IV_MAX) {
1767 SvIV_set(sv, (IV)value);
1769 /* it didn't overflow, and it was positive. */
1770 SvUV_set(sv, value);
1774 /* 2s complement assumption */
1775 if (value <= (UV)IV_MIN) {
1776 SvIV_set(sv, -(IV)value);
1778 /* Too negative for an IV. This is a double upgrade, but
1779 I'm assuming it will be rare. */
1780 if (SvTYPE(sv) < SVt_PVNV)
1781 sv_upgrade(sv, SVt_PVNV);
1785 SvNV_set(sv, -(NV)value);
1786 SvIV_set(sv, IV_MIN);
1790 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1791 will be in the previous block to set the IV slot, and the next
1792 block to set the NV slot. So no else here. */
1794 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1795 != IS_NUMBER_IN_UV) {
1796 /* It wasn't an (integer that doesn't overflow the UV). */
1797 SvNV_set(sv, Atof(SvPVX_const(sv)));
1799 if (! numtype && ckWARN(WARN_NUMERIC))
1802 #if defined(USE_LONG_DOUBLE)
1803 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1804 PTR2UV(sv), SvNVX(sv)));
1806 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1807 PTR2UV(sv), SvNVX(sv)));
1810 #ifdef NV_PRESERVES_UV
1811 (void)SvIOKp_on(sv);
1813 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1814 SvIV_set(sv, I_V(SvNVX(sv)));
1815 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1818 /* Integer is imprecise. NOK, IOKp */
1820 /* UV will not work better than IV */
1822 if (SvNVX(sv) > (NV)UV_MAX) {
1824 /* Integer is inaccurate. NOK, IOKp, is UV */
1825 SvUV_set(sv, UV_MAX);
1827 SvUV_set(sv, U_V(SvNVX(sv)));
1828 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1829 NV preservse UV so can do correct comparison. */
1830 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1833 /* Integer is imprecise. NOK, IOKp, is UV */
1838 #else /* NV_PRESERVES_UV */
1839 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1840 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1841 /* The IV/UV slot will have been set from value returned by
1842 grok_number above. The NV slot has just been set using
1845 assert (SvIOKp(sv));
1847 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1848 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1849 /* Small enough to preserve all bits. */
1850 (void)SvIOKp_on(sv);
1852 SvIV_set(sv, I_V(SvNVX(sv)));
1853 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1855 /* Assumption: first non-preserved integer is < IV_MAX,
1856 this NV is in the preserved range, therefore: */
1857 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1859 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);
1863 0 0 already failed to read UV.
1864 0 1 already failed to read UV.
1865 1 0 you won't get here in this case. IV/UV
1866 slot set, public IOK, Atof() unneeded.
1867 1 1 already read UV.
1868 so there's no point in sv_2iuv_non_preserve() attempting
1869 to use atol, strtol, strtoul etc. */
1870 sv_2iuv_non_preserve (sv, numtype);
1873 #endif /* NV_PRESERVES_UV */
1877 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1878 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1881 if (SvTYPE(sv) < SVt_IV)
1882 /* Typically the caller expects that sv_any is not NULL now. */
1883 sv_upgrade(sv, SVt_IV);
1884 /* Return 0 from the caller. */
1891 =for apidoc sv_2iv_flags
1893 Return the integer value of an SV, doing any necessary string
1894 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1895 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1901 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1906 if (SvGMAGICAL(sv)) {
1907 if (flags & SV_GMAGIC)
1912 return I_V(SvNVX(sv));
1914 if (SvPOKp(sv) && SvLEN(sv)) {
1917 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1919 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1920 == IS_NUMBER_IN_UV) {
1921 /* It's definitely an integer */
1922 if (numtype & IS_NUMBER_NEG) {
1923 if (value < (UV)IV_MIN)
1926 if (value < (UV)IV_MAX)
1931 if (ckWARN(WARN_NUMERIC))
1934 return I_V(Atof(SvPVX_const(sv)));
1939 assert(SvTYPE(sv) >= SVt_PVMG);
1940 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1941 } else if (SvTHINKFIRST(sv)) {
1945 SV * const tmpstr=AMG_CALLun(sv,numer);
1946 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1947 return SvIV(tmpstr);
1950 return PTR2IV(SvRV(sv));
1953 sv_force_normal_flags(sv, 0);
1955 if (SvREADONLY(sv) && !SvOK(sv)) {
1956 if (ckWARN(WARN_UNINITIALIZED))
1962 if (S_sv_2iuv_common(aTHX_ sv))
1965 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1966 PTR2UV(sv),SvIVX(sv)));
1967 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1971 =for apidoc sv_2uv_flags
1973 Return the unsigned integer value of an SV, doing any necessary string
1974 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1975 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1981 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1986 if (SvGMAGICAL(sv)) {
1987 if (flags & SV_GMAGIC)
1992 return U_V(SvNVX(sv));
1993 if (SvPOKp(sv) && SvLEN(sv)) {
1996 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1998 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1999 == IS_NUMBER_IN_UV) {
2000 /* It's definitely an integer */
2001 if (!(numtype & IS_NUMBER_NEG))
2005 if (ckWARN(WARN_NUMERIC))
2008 return U_V(Atof(SvPVX_const(sv)));
2013 assert(SvTYPE(sv) >= SVt_PVMG);
2014 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2015 } else if (SvTHINKFIRST(sv)) {
2019 SV *const tmpstr = AMG_CALLun(sv,numer);
2020 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2021 return SvUV(tmpstr);
2024 return PTR2UV(SvRV(sv));
2027 sv_force_normal_flags(sv, 0);
2029 if (SvREADONLY(sv) && !SvOK(sv)) {
2030 if (ckWARN(WARN_UNINITIALIZED))
2036 if (S_sv_2iuv_common(aTHX_ sv))
2040 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2041 PTR2UV(sv),SvUVX(sv)));
2042 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2048 Return the num value of an SV, doing any necessary string or integer
2049 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2056 Perl_sv_2nv(pTHX_ register SV *sv)
2061 if (SvGMAGICAL(sv)) {
2065 if (SvPOKp(sv) && SvLEN(sv)) {
2066 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2067 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2069 return Atof(SvPVX_const(sv));
2073 return (NV)SvUVX(sv);
2075 return (NV)SvIVX(sv);
2080 assert(SvTYPE(sv) >= SVt_PVMG);
2081 /* This falls through to the report_uninit near the end of the
2083 } else if (SvTHINKFIRST(sv)) {
2087 SV *const tmpstr = AMG_CALLun(sv,numer);
2088 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2089 return SvNV(tmpstr);
2092 return PTR2NV(SvRV(sv));
2095 sv_force_normal_flags(sv, 0);
2097 if (SvREADONLY(sv) && !SvOK(sv)) {
2098 if (ckWARN(WARN_UNINITIALIZED))
2103 if (SvTYPE(sv) < SVt_NV) {
2104 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2105 sv_upgrade(sv, SVt_NV);
2106 #ifdef USE_LONG_DOUBLE
2108 STORE_NUMERIC_LOCAL_SET_STANDARD();
2109 PerlIO_printf(Perl_debug_log,
2110 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2111 PTR2UV(sv), SvNVX(sv));
2112 RESTORE_NUMERIC_LOCAL();
2116 STORE_NUMERIC_LOCAL_SET_STANDARD();
2117 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2118 PTR2UV(sv), SvNVX(sv));
2119 RESTORE_NUMERIC_LOCAL();
2123 else if (SvTYPE(sv) < SVt_PVNV)
2124 sv_upgrade(sv, SVt_PVNV);
2129 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2130 #ifdef NV_PRESERVES_UV
2133 /* Only set the public NV OK flag if this NV preserves the IV */
2134 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2135 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2136 : (SvIVX(sv) == I_V(SvNVX(sv))))
2142 else if (SvPOKp(sv) && SvLEN(sv)) {
2144 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2145 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2147 #ifdef NV_PRESERVES_UV
2148 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2149 == IS_NUMBER_IN_UV) {
2150 /* It's definitely an integer */
2151 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2153 SvNV_set(sv, Atof(SvPVX_const(sv)));
2156 SvNV_set(sv, Atof(SvPVX_const(sv)));
2157 /* Only set the public NV OK flag if this NV preserves the value in
2158 the PV at least as well as an IV/UV would.
2159 Not sure how to do this 100% reliably. */
2160 /* if that shift count is out of range then Configure's test is
2161 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2163 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2164 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2165 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2166 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2167 /* Can't use strtol etc to convert this string, so don't try.
2168 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2171 /* value has been set. It may not be precise. */
2172 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2173 /* 2s complement assumption for (UV)IV_MIN */
2174 SvNOK_on(sv); /* Integer is too negative. */
2179 if (numtype & IS_NUMBER_NEG) {
2180 SvIV_set(sv, -(IV)value);
2181 } else if (value <= (UV)IV_MAX) {
2182 SvIV_set(sv, (IV)value);
2184 SvUV_set(sv, value);
2188 if (numtype & IS_NUMBER_NOT_INT) {
2189 /* I believe that even if the original PV had decimals,
2190 they are lost beyond the limit of the FP precision.
2191 However, neither is canonical, so both only get p
2192 flags. NWC, 2000/11/25 */
2193 /* Both already have p flags, so do nothing */
2195 const NV nv = SvNVX(sv);
2196 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2197 if (SvIVX(sv) == I_V(nv)) {
2200 /* It had no "." so it must be integer. */
2204 /* between IV_MAX and NV(UV_MAX).
2205 Could be slightly > UV_MAX */
2207 if (numtype & IS_NUMBER_NOT_INT) {
2208 /* UV and NV both imprecise. */
2210 const UV nv_as_uv = U_V(nv);
2212 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2221 #endif /* NV_PRESERVES_UV */
2224 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2226 assert (SvTYPE(sv) >= SVt_NV);
2227 /* Typically the caller expects that sv_any is not NULL now. */
2228 /* XXX Ilya implies that this is a bug in callers that assume this
2229 and ideally should be fixed. */
2232 #if defined(USE_LONG_DOUBLE)
2234 STORE_NUMERIC_LOCAL_SET_STANDARD();
2235 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2236 PTR2UV(sv), SvNVX(sv));
2237 RESTORE_NUMERIC_LOCAL();
2241 STORE_NUMERIC_LOCAL_SET_STANDARD();
2242 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2243 PTR2UV(sv), SvNVX(sv));
2244 RESTORE_NUMERIC_LOCAL();
2250 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2251 * UV as a string towards the end of buf, and return pointers to start and
2254 * We assume that buf is at least TYPE_CHARS(UV) long.
2258 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2260 char *ptr = buf + TYPE_CHARS(UV);
2261 char * const ebuf = ptr;
2274 *--ptr = '0' + (char)(uv % 10);
2282 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2283 * a regexp to its stringified form.
2287 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2289 const regexp * const re = (regexp *)mg->mg_obj;
2292 const char *fptr = "msix";
2297 bool need_newline = 0;
2298 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2300 while((ch = *fptr++)) {
2302 reflags[left++] = ch;
2305 reflags[right--] = ch;
2310 reflags[left] = '-';
2314 mg->mg_len = re->prelen + 4 + left;
2316 * If /x was used, we have to worry about a regex ending with a
2317 * comment later being embedded within another regex. If so, we don't
2318 * want this regex's "commentization" to leak out to the right part of
2319 * the enclosing regex, we must cap it with a newline.
2321 * So, if /x was used, we scan backwards from the end of the regex. If
2322 * we find a '#' before we find a newline, we need to add a newline
2323 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2324 * we don't need to add anything. -jfriedl
2326 if (PMf_EXTENDED & re->reganch) {
2327 const char *endptr = re->precomp + re->prelen;
2328 while (endptr >= re->precomp) {
2329 const char c = *(endptr--);
2331 break; /* don't need another */
2333 /* we end while in a comment, so we need a newline */
2334 mg->mg_len++; /* save space for it */
2335 need_newline = 1; /* note to add it */
2341 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2342 mg->mg_ptr[0] = '(';
2343 mg->mg_ptr[1] = '?';
2344 Copy(reflags, mg->mg_ptr+2, left, char);
2345 *(mg->mg_ptr+left+2) = ':';
2346 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2348 mg->mg_ptr[mg->mg_len - 2] = '\n';
2349 mg->mg_ptr[mg->mg_len - 1] = ')';
2350 mg->mg_ptr[mg->mg_len] = 0;
2352 PL_reginterp_cnt += re->program[0].next_off;
2354 if (re->reganch & ROPT_UTF8)
2364 =for apidoc sv_2pv_flags
2366 Returns a pointer to the string value of an SV, and sets *lp to its length.
2367 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2369 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2370 usually end up here too.
2376 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2386 if (SvGMAGICAL(sv)) {
2387 if (flags & SV_GMAGIC)
2392 if (flags & SV_MUTABLE_RETURN)
2393 return SvPVX_mutable(sv);
2394 if (flags & SV_CONST_RETURN)
2395 return (char *)SvPVX_const(sv);
2398 if (SvIOKp(sv) || SvNOKp(sv)) {
2399 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2403 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2404 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2406 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2409 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2410 /* Sneaky stuff here */
2411 SV * const tsv = newSVpvn(tbuf, len);
2421 #ifdef FIXNEGATIVEZERO
2422 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2428 SvUPGRADE(sv, SVt_PV);
2431 s = SvGROW_mutable(sv, len + 1);
2434 return memcpy(s, tbuf, len + 1);
2440 assert(SvTYPE(sv) >= SVt_PVMG);
2441 /* This falls through to the report_uninit near the end of the
2443 } else if (SvTHINKFIRST(sv)) {
2447 SV *const tmpstr = AMG_CALLun(sv,string);
2448 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2450 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2454 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2455 if (flags & SV_CONST_RETURN) {
2456 pv = (char *) SvPVX_const(tmpstr);
2458 pv = (flags & SV_MUTABLE_RETURN)
2459 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2462 *lp = SvCUR(tmpstr);
2464 pv = sv_2pv_flags(tmpstr, lp, flags);
2476 const SV *const referent = (SV*)SvRV(sv);
2479 tsv = sv_2mortal(newSVpvs("NULLREF"));
2480 } else if (SvTYPE(referent) == SVt_PVMG
2481 && ((SvFLAGS(referent) &
2482 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2483 == (SVs_OBJECT|SVs_SMG))
2484 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2485 return stringify_regexp(sv, mg, lp);
2487 const char *const typestr = sv_reftype(referent, 0);
2489 tsv = sv_newmortal();
2490 if (SvOBJECT(referent)) {
2491 const char *const name = HvNAME_get(SvSTASH(referent));
2492 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2493 name ? name : "__ANON__" , typestr,
2497 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2505 if (SvREADONLY(sv) && !SvOK(sv)) {
2506 if (ckWARN(WARN_UNINITIALIZED))
2513 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2514 /* I'm assuming that if both IV and NV are equally valid then
2515 converting the IV is going to be more efficient */
2516 const U32 isIOK = SvIOK(sv);
2517 const U32 isUIOK = SvIsUV(sv);
2518 char buf[TYPE_CHARS(UV)];
2521 if (SvTYPE(sv) < SVt_PVIV)
2522 sv_upgrade(sv, SVt_PVIV);
2523 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2524 /* inlined from sv_setpvn */
2525 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2526 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2527 SvCUR_set(sv, ebuf - ptr);
2537 else if (SvNOKp(sv)) {
2538 const int olderrno = errno;
2539 if (SvTYPE(sv) < SVt_PVNV)
2540 sv_upgrade(sv, SVt_PVNV);
2541 /* The +20 is pure guesswork. Configure test needed. --jhi */
2542 s = SvGROW_mutable(sv, NV_DIG + 20);
2543 /* some Xenix systems wipe out errno here */
2545 if (SvNVX(sv) == 0.0)
2546 (void)strcpy(s,"0");
2550 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2553 #ifdef FIXNEGATIVEZERO
2554 if (*s == '-' && s[1] == '0' && !s[2])
2564 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2568 if (SvTYPE(sv) < SVt_PV)
2569 /* Typically the caller expects that sv_any is not NULL now. */
2570 sv_upgrade(sv, SVt_PV);
2574 const STRLEN len = s - SvPVX_const(sv);
2580 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2581 PTR2UV(sv),SvPVX_const(sv)));
2582 if (flags & SV_CONST_RETURN)
2583 return (char *)SvPVX_const(sv);
2584 if (flags & SV_MUTABLE_RETURN)
2585 return SvPVX_mutable(sv);
2590 =for apidoc sv_copypv
2592 Copies a stringified representation of the source SV into the
2593 destination SV. Automatically performs any necessary mg_get and
2594 coercion of numeric values into strings. Guaranteed to preserve
2595 UTF-8 flag even from overloaded objects. Similar in nature to
2596 sv_2pv[_flags] but operates directly on an SV instead of just the
2597 string. Mostly uses sv_2pv_flags to do its work, except when that
2598 would lose the UTF-8'ness of the PV.
2604 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2607 const char * const s = SvPV_const(ssv,len);
2608 sv_setpvn(dsv,s,len);
2616 =for apidoc sv_2pvbyte
2618 Return a pointer to the byte-encoded representation of the SV, and set *lp
2619 to its length. May cause the SV to be downgraded from UTF-8 as a
2622 Usually accessed via the C<SvPVbyte> macro.
2628 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2630 sv_utf8_downgrade(sv,0);
2631 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2635 =for apidoc sv_2pvutf8
2637 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2638 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2640 Usually accessed via the C<SvPVutf8> macro.
2646 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2648 sv_utf8_upgrade(sv);
2649 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2654 =for apidoc sv_2bool
2656 This function is only called on magical items, and is only used by
2657 sv_true() or its macro equivalent.
2663 Perl_sv_2bool(pTHX_ register SV *sv)
2672 SV * const tmpsv = AMG_CALLun(sv,bool_);
2673 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2674 return (bool)SvTRUE(tmpsv);
2676 return SvRV(sv) != 0;
2679 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2681 (*sv->sv_u.svu_pv > '0' ||
2682 Xpvtmp->xpv_cur > 1 ||
2683 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2690 return SvIVX(sv) != 0;
2693 return SvNVX(sv) != 0.0;
2701 =for apidoc sv_utf8_upgrade
2703 Converts the PV of an SV to its UTF-8-encoded form.
2704 Forces the SV to string form if it is not already.
2705 Always sets the SvUTF8 flag to avoid future validity checks even
2706 if all the bytes have hibit clear.
2708 This is not as a general purpose byte encoding to Unicode interface:
2709 use the Encode extension for that.
2711 =for apidoc sv_utf8_upgrade_flags
2713 Converts the PV of an SV to its UTF-8-encoded form.
2714 Forces the SV to string form if it is not already.
2715 Always sets the SvUTF8 flag to avoid future validity checks even
2716 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2717 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2718 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2720 This is not as a general purpose byte encoding to Unicode interface:
2721 use the Encode extension for that.
2727 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2730 if (sv == &PL_sv_undef)
2734 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2735 (void) sv_2pv_flags(sv,&len, flags);
2739 (void) SvPV_force(sv,len);
2748 sv_force_normal_flags(sv, 0);
2751 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2752 sv_recode_to_utf8(sv, PL_encoding);
2753 else { /* Assume Latin-1/EBCDIC */
2754 /* This function could be much more efficient if we
2755 * had a FLAG in SVs to signal if there are any hibit
2756 * chars in the PV. Given that there isn't such a flag
2757 * make the loop as fast as possible. */
2758 const U8 * const s = (U8 *) SvPVX_const(sv);
2759 const U8 * const e = (U8 *) SvEND(sv);
2764 /* Check for hi bit */
2765 if (!NATIVE_IS_INVARIANT(ch)) {
2766 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2767 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2769 SvPV_free(sv); /* No longer using what was there before. */
2770 SvPV_set(sv, (char*)recoded);
2771 SvCUR_set(sv, len - 1);
2772 SvLEN_set(sv, len); /* No longer know the real size. */
2776 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2783 =for apidoc sv_utf8_downgrade
2785 Attempts to convert the PV of an SV from characters to bytes.
2786 If the PV contains a character beyond byte, this conversion will fail;
2787 in this case, either returns false or, if C<fail_ok> is not
2790 This is not as a general purpose Unicode to byte encoding interface:
2791 use the Encode extension for that.
2797 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2800 if (SvPOKp(sv) && SvUTF8(sv)) {
2806 sv_force_normal_flags(sv, 0);
2808 s = (U8 *) SvPV(sv, len);
2809 if (!utf8_to_bytes(s, &len)) {
2814 Perl_croak(aTHX_ "Wide character in %s",
2817 Perl_croak(aTHX_ "Wide character");
2828 =for apidoc sv_utf8_encode
2830 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2831 flag off so that it looks like octets again.
2837 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2839 (void) sv_utf8_upgrade(sv);
2841 sv_force_normal_flags(sv, 0);
2843 if (SvREADONLY(sv)) {
2844 Perl_croak(aTHX_ PL_no_modify);
2850 =for apidoc sv_utf8_decode
2852 If the PV of the SV is an octet sequence in UTF-8
2853 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2854 so that it looks like a character. If the PV contains only single-byte
2855 characters, the C<SvUTF8> flag stays being off.
2856 Scans PV for validity and returns false if the PV is invalid UTF-8.
2862 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2868 /* The octets may have got themselves encoded - get them back as
2871 if (!sv_utf8_downgrade(sv, TRUE))
2874 /* it is actually just a matter of turning the utf8 flag on, but
2875 * we want to make sure everything inside is valid utf8 first.
2877 c = (const U8 *) SvPVX_const(sv);
2878 if (!is_utf8_string(c, SvCUR(sv)+1))
2880 e = (const U8 *) SvEND(sv);
2883 if (!UTF8_IS_INVARIANT(ch)) {
2893 =for apidoc sv_setsv
2895 Copies the contents of the source SV C<ssv> into the destination SV
2896 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2897 function if the source SV needs to be reused. Does not handle 'set' magic.
2898 Loosely speaking, it performs a copy-by-value, obliterating any previous
2899 content of the destination.
2901 You probably want to use one of the assortment of wrappers, such as
2902 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2903 C<SvSetMagicSV_nosteal>.
2905 =for apidoc sv_setsv_flags
2907 Copies the contents of the source SV C<ssv> into the destination SV
2908 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2909 function if the source SV needs to be reused. Does not handle 'set' magic.
2910 Loosely speaking, it performs a copy-by-value, obliterating any previous
2911 content of the destination.
2912 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2913 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2914 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2915 and C<sv_setsv_nomg> are implemented in terms of this function.
2917 You probably want to use one of the assortment of wrappers, such as
2918 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2919 C<SvSetMagicSV_nosteal>.
2921 This is the primary function for copying scalars, and most other
2922 copy-ish functions and macros use this underneath.
2928 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2931 register U32 sflags;
2937 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2939 sstr = &PL_sv_undef;
2940 stype = SvTYPE(sstr);
2941 dtype = SvTYPE(dstr);
2946 /* need to nuke the magic */
2948 SvRMAGICAL_off(dstr);
2951 /* There's a lot of redundancy below but we're going for speed here */
2956 if (dtype != SVt_PVGV) {
2957 (void)SvOK_off(dstr);
2965 sv_upgrade(dstr, SVt_IV);
2968 sv_upgrade(dstr, SVt_PVNV);
2972 sv_upgrade(dstr, SVt_PVIV);
2975 (void)SvIOK_only(dstr);
2976 SvIV_set(dstr, SvIVX(sstr));
2979 if (SvTAINTED(sstr))
2990 sv_upgrade(dstr, SVt_NV);
2995 sv_upgrade(dstr, SVt_PVNV);
2998 SvNV_set(dstr, SvNVX(sstr));
2999 (void)SvNOK_only(dstr);
3000 if (SvTAINTED(sstr))
3008 sv_upgrade(dstr, SVt_RV);
3009 else if (dtype == SVt_PVGV &&
3010 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3013 if (GvIMPORTED(dstr) != GVf_IMPORTED
3014 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3016 GvIMPORTED_on(dstr);
3025 #ifdef PERL_OLD_COPY_ON_WRITE
3026 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3027 if (dtype < SVt_PVIV)
3028 sv_upgrade(dstr, SVt_PVIV);
3035 sv_upgrade(dstr, SVt_PV);
3038 if (dtype < SVt_PVIV)
3039 sv_upgrade(dstr, SVt_PVIV);
3042 if (dtype < SVt_PVNV)
3043 sv_upgrade(dstr, SVt_PVNV);
3050 const char * const type = sv_reftype(sstr,0);
3052 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3054 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3059 if (dtype <= SVt_PVGV) {
3061 if (dtype != SVt_PVGV) {
3062 const char * const name = GvNAME(sstr);
3063 const STRLEN len = GvNAMELEN(sstr);
3064 /* don't upgrade SVt_PVLV: it can hold a glob */
3065 if (dtype != SVt_PVLV)
3066 sv_upgrade(dstr, SVt_PVGV);
3067 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3068 GvSTASH(dstr) = GvSTASH(sstr);
3070 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3071 GvNAME(dstr) = savepvn(name, len);
3072 GvNAMELEN(dstr) = len;
3073 SvFAKE_on(dstr); /* can coerce to non-glob */
3076 #ifdef GV_UNIQUE_CHECK
3077 if (GvUNIQUE((GV*)dstr)) {
3078 Perl_croak(aTHX_ PL_no_modify);
3082 (void)SvOK_off(dstr);
3083 GvINTRO_off(dstr); /* one-shot flag */
3085 GvGP(dstr) = gp_ref(GvGP(sstr));
3086 if (SvTAINTED(sstr))
3088 if (GvIMPORTED(dstr) != GVf_IMPORTED
3089 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3091 GvIMPORTED_on(dstr);
3099 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3101 if ((int)SvTYPE(sstr) != stype) {
3102 stype = SvTYPE(sstr);
3103 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3107 if (stype == SVt_PVLV)
3108 SvUPGRADE(dstr, SVt_PVNV);
3110 SvUPGRADE(dstr, (U32)stype);
3113 sflags = SvFLAGS(sstr);
3115 if (sflags & SVf_ROK) {
3116 if (dtype >= SVt_PV) {
3117 if (dtype == SVt_PVGV) {
3118 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3120 const int intro = GvINTRO(dstr);
3122 #ifdef GV_UNIQUE_CHECK
3123 if (GvUNIQUE((GV*)dstr)) {
3124 Perl_croak(aTHX_ PL_no_modify);
3129 GvINTRO_off(dstr); /* one-shot flag */
3130 GvLINE(dstr) = CopLINE(PL_curcop);
3131 GvEGV(dstr) = (GV*)dstr;
3134 switch (SvTYPE(sref)) {
3137 SAVEGENERICSV(GvAV(dstr));
3139 dref = (SV*)GvAV(dstr);
3140 GvAV(dstr) = (AV*)sref;
3141 if (!GvIMPORTED_AV(dstr)
3142 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3144 GvIMPORTED_AV_on(dstr);
3149 SAVEGENERICSV(GvHV(dstr));
3151 dref = (SV*)GvHV(dstr);
3152 GvHV(dstr) = (HV*)sref;
3153 if (!GvIMPORTED_HV(dstr)
3154 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3156 GvIMPORTED_HV_on(dstr);
3161 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3162 SvREFCNT_dec(GvCV(dstr));
3163 GvCV(dstr) = Nullcv;
3164 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3165 PL_sub_generation++;
3167 SAVEGENERICSV(GvCV(dstr));
3170 dref = (SV*)GvCV(dstr);
3171 if (GvCV(dstr) != (CV*)sref) {
3172 CV* const cv = GvCV(dstr);
3174 if (!GvCVGEN((GV*)dstr) &&
3175 (CvROOT(cv) || CvXSUB(cv)))
3177 /* Redefining a sub - warning is mandatory if
3178 it was a const and its value changed. */
3179 if (CvCONST(cv) && CvCONST((CV*)sref)
3181 == cv_const_sv((CV*)sref)) {
3182 /* They are 2 constant subroutines
3183 generated from the same constant.
3184 This probably means that they are
3185 really the "same" proxy subroutine
3186 instantiated in 2 places. Most likely
3187 this is when a constant is exported
3188 twice. Don't warn. */
3190 else if (ckWARN(WARN_REDEFINE)
3192 && (!CvCONST((CV*)sref)
3193 || sv_cmp(cv_const_sv(cv),
3194 cv_const_sv((CV*)sref)))))
3196 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3198 ? "Constant subroutine %s::%s redefined"
3199 : "Subroutine %s::%s redefined",
3200 HvNAME_get(GvSTASH((GV*)dstr)),
3201 GvENAME((GV*)dstr));
3205 cv_ckproto(cv, (GV*)dstr,
3207 ? SvPVX_const(sref) : Nullch);
3209 GvCV(dstr) = (CV*)sref;
3210 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3211 GvASSUMECV_on(dstr);
3212 PL_sub_generation++;
3214 if (!GvIMPORTED_CV(dstr)
3215 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3217 GvIMPORTED_CV_on(dstr);
3222 SAVEGENERICSV(GvIOp(dstr));
3224 dref = (SV*)GvIOp(dstr);
3225 GvIOp(dstr) = (IO*)sref;
3229 SAVEGENERICSV(GvFORM(dstr));
3231 dref = (SV*)GvFORM(dstr);
3232 GvFORM(dstr) = (CV*)sref;
3236 SAVEGENERICSV(GvSV(dstr));
3238 dref = (SV*)GvSV(dstr);
3240 if (!GvIMPORTED_SV(dstr)
3241 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3243 GvIMPORTED_SV_on(dstr);
3249 if (SvTAINTED(sstr))
3253 if (SvPVX_const(dstr)) {
3259 (void)SvOK_off(dstr);
3260 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3262 if (sflags & SVp_NOK) {
3264 /* Only set the public OK flag if the source has public OK. */
3265 if (sflags & SVf_NOK)
3266 SvFLAGS(dstr) |= SVf_NOK;
3267 SvNV_set(dstr, SvNVX(sstr));
3269 if (sflags & SVp_IOK) {
3270 (void)SvIOKp_on(dstr);
3271 if (sflags & SVf_IOK)
3272 SvFLAGS(dstr) |= SVf_IOK;
3273 if (sflags & SVf_IVisUV)
3275 SvIV_set(dstr, SvIVX(sstr));
3277 if (SvAMAGIC(sstr)) {
3281 else if (sflags & SVp_POK) {
3285 * Check to see if we can just swipe the string. If so, it's a
3286 * possible small lose on short strings, but a big win on long ones.
3287 * It might even be a win on short strings if SvPVX_const(dstr)
3288 * has to be allocated and SvPVX_const(sstr) has to be freed.
3291 /* Whichever path we take through the next code, we want this true,
3292 and doing it now facilitates the COW check. */
3293 (void)SvPOK_only(dstr);
3296 /* We're not already COW */
3297 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3298 #ifndef PERL_OLD_COPY_ON_WRITE
3299 /* or we are, but dstr isn't a suitable target. */
3300 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3305 (sflags & SVs_TEMP) && /* slated for free anyway? */
3306 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3307 (!(flags & SV_NOSTEAL)) &&
3308 /* and we're allowed to steal temps */
3309 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3310 SvLEN(sstr) && /* and really is a string */
3311 /* and won't be needed again, potentially */
3312 !(PL_op && PL_op->op_type == OP_AASSIGN))
3313 #ifdef PERL_OLD_COPY_ON_WRITE
3314 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3315 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3316 && SvTYPE(sstr) >= SVt_PVIV)
3319 /* Failed the swipe test, and it's not a shared hash key either.
3320 Have to copy the string. */
3321 STRLEN len = SvCUR(sstr);
3322 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3323 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3324 SvCUR_set(dstr, len);
3325 *SvEND(dstr) = '\0';
3327 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3329 /* Either it's a shared hash key, or it's suitable for
3330 copy-on-write or we can swipe the string. */
3332 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3336 #ifdef PERL_OLD_COPY_ON_WRITE
3338 /* I believe I should acquire a global SV mutex if
3339 it's a COW sv (not a shared hash key) to stop
3340 it going un copy-on-write.
3341 If the source SV has gone un copy on write between up there
3342 and down here, then (assert() that) it is of the correct
3343 form to make it copy on write again */
3344 if ((sflags & (SVf_FAKE | SVf_READONLY))
3345 != (SVf_FAKE | SVf_READONLY)) {
3346 SvREADONLY_on(sstr);
3348 /* Make the source SV into a loop of 1.
3349 (about to become 2) */
3350 SV_COW_NEXT_SV_SET(sstr, sstr);
3354 /* Initial code is common. */
3355 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3360 /* making another shared SV. */
3361 STRLEN cur = SvCUR(sstr);
3362 STRLEN len = SvLEN(sstr);
3363 #ifdef PERL_OLD_COPY_ON_WRITE
3365 assert (SvTYPE(dstr) >= SVt_PVIV);
3366 /* SvIsCOW_normal */
3367 /* splice us in between source and next-after-source. */
3368 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3369 SV_COW_NEXT_SV_SET(sstr, dstr);
3370 SvPV_set(dstr, SvPVX_mutable(sstr));
3374 /* SvIsCOW_shared_hash */
3375 DEBUG_C(PerlIO_printf(Perl_debug_log,
3376 "Copy on write: Sharing hash\n"));
3378 assert (SvTYPE(dstr) >= SVt_PV);
3380 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3382 SvLEN_set(dstr, len);
3383 SvCUR_set(dstr, cur);
3384 SvREADONLY_on(dstr);
3386 /* Relesase a global SV mutex. */
3389 { /* Passes the swipe test. */
3390 SvPV_set(dstr, SvPVX_mutable(sstr));
3391 SvLEN_set(dstr, SvLEN(sstr));
3392 SvCUR_set(dstr, SvCUR(sstr));
3395 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3396 SvPV_set(sstr, Nullch);
3402 if (sflags & SVf_UTF8)
3404 if (sflags & SVp_NOK) {
3406 if (sflags & SVf_NOK)
3407 SvFLAGS(dstr) |= SVf_NOK;
3408 SvNV_set(dstr, SvNVX(sstr));
3410 if (sflags & SVp_IOK) {
3411 (void)SvIOKp_on(dstr);
3412 if (sflags & SVf_IOK)
3413 SvFLAGS(dstr) |= SVf_IOK;
3414 if (sflags & SVf_IVisUV)
3416 SvIV_set(dstr, SvIVX(sstr));
3419 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3420 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3421 smg->mg_ptr, smg->mg_len);
3422 SvRMAGICAL_on(dstr);
3425 else if (sflags & SVp_IOK) {
3426 if (sflags & SVf_IOK)
3427 (void)SvIOK_only(dstr);
3429 (void)SvOK_off(dstr);
3430 (void)SvIOKp_on(dstr);
3432 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3433 if (sflags & SVf_IVisUV)
3435 SvIV_set(dstr, SvIVX(sstr));
3436 if (sflags & SVp_NOK) {
3437 if (sflags & SVf_NOK)
3438 (void)SvNOK_on(dstr);
3440 (void)SvNOKp_on(dstr);
3441 SvNV_set(dstr, SvNVX(sstr));
3444 else if (sflags & SVp_NOK) {
3445 if (sflags & SVf_NOK)
3446 (void)SvNOK_only(dstr);
3448 (void)SvOK_off(dstr);
3451 SvNV_set(dstr, SvNVX(sstr));
3454 if (dtype == SVt_PVGV) {
3455 if (ckWARN(WARN_MISC))
3456 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3459 (void)SvOK_off(dstr);
3461 if (SvTAINTED(sstr))
3466 =for apidoc sv_setsv_mg
3468 Like C<sv_setsv>, but also handles 'set' magic.
3474 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3476 sv_setsv(dstr,sstr);
3480 #ifdef PERL_OLD_COPY_ON_WRITE
3482 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3484 STRLEN cur = SvCUR(sstr);
3485 STRLEN len = SvLEN(sstr);
3486 register char *new_pv;
3489 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3497 if (SvTHINKFIRST(dstr))
3498 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3499 else if (SvPVX_const(dstr))
3500 Safefree(SvPVX_const(dstr));
3504 SvUPGRADE(dstr, SVt_PVIV);
3506 assert (SvPOK(sstr));
3507 assert (SvPOKp(sstr));
3508 assert (!SvIOK(sstr));
3509 assert (!SvIOKp(sstr));
3510 assert (!SvNOK(sstr));
3511 assert (!SvNOKp(sstr));
3513 if (SvIsCOW(sstr)) {
3515 if (SvLEN(sstr) == 0) {
3516 /* source is a COW shared hash key. */
3517 DEBUG_C(PerlIO_printf(Perl_debug_log,
3518 "Fast copy on write: Sharing hash\n"));
3519 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3522 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3524 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3525 SvUPGRADE(sstr, SVt_PVIV);
3526 SvREADONLY_on(sstr);
3528 DEBUG_C(PerlIO_printf(Perl_debug_log,
3529 "Fast copy on write: Converting sstr to COW\n"));
3530 SV_COW_NEXT_SV_SET(dstr, sstr);
3532 SV_COW_NEXT_SV_SET(sstr, dstr);
3533 new_pv = SvPVX_mutable(sstr);
3536 SvPV_set(dstr, new_pv);
3537 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3540 SvLEN_set(dstr, len);
3541 SvCUR_set(dstr, cur);
3550 =for apidoc sv_setpvn
3552 Copies a string into an SV. The C<len> parameter indicates the number of
3553 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3554 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3560 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3563 register char *dptr;
3565 SV_CHECK_THINKFIRST_COW_DROP(sv);
3571 /* len is STRLEN which is unsigned, need to copy to signed */
3574 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3576 SvUPGRADE(sv, SVt_PV);
3578 dptr = SvGROW(sv, len + 1);
3579 Move(ptr,dptr,len,char);
3582 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3587 =for apidoc sv_setpvn_mg
3589 Like C<sv_setpvn>, but also handles 'set' magic.
3595 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3597 sv_setpvn(sv,ptr,len);
3602 =for apidoc sv_setpv
3604 Copies a string into an SV. The string must be null-terminated. Does not
3605 handle 'set' magic. See C<sv_setpv_mg>.
3611 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3614 register STRLEN len;
3616 SV_CHECK_THINKFIRST_COW_DROP(sv);
3622 SvUPGRADE(sv, SVt_PV);
3624 SvGROW(sv, len + 1);
3625 Move(ptr,SvPVX(sv),len+1,char);
3627 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3632 =for apidoc sv_setpv_mg
3634 Like C<sv_setpv>, but also handles 'set' magic.
3640 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3647 =for apidoc sv_usepvn
3649 Tells an SV to use C<ptr> to find its string value. Normally the string is
3650 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3651 The C<ptr> should point to memory that was allocated by C<malloc>. The
3652 string length, C<len>, must be supplied. This function will realloc the
3653 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3654 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3655 See C<sv_usepvn_mg>.
3661 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3665 SV_CHECK_THINKFIRST_COW_DROP(sv);
3666 SvUPGRADE(sv, SVt_PV);
3671 if (SvPVX_const(sv))
3674 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3675 ptr = saferealloc (ptr, allocate);
3678 SvLEN_set(sv, allocate);
3680 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3685 =for apidoc sv_usepvn_mg
3687 Like C<sv_usepvn>, but also handles 'set' magic.
3693 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3695 sv_usepvn(sv,ptr,len);
3699 #ifdef PERL_OLD_COPY_ON_WRITE
3700 /* Need to do this *after* making the SV normal, as we need the buffer
3701 pointer to remain valid until after we've copied it. If we let go too early,
3702 another thread could invalidate it by unsharing last of the same hash key
3703 (which it can do by means other than releasing copy-on-write Svs)
3704 or by changing the other copy-on-write SVs in the loop. */
3706 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3708 if (len) { /* this SV was SvIsCOW_normal(sv) */
3709 /* we need to find the SV pointing to us. */
3710 SV * const current = SV_COW_NEXT_SV(after);
3712 if (current == sv) {
3713 /* The SV we point to points back to us (there were only two of us
3715 Hence other SV is no longer copy on write either. */
3717 SvREADONLY_off(after);
3719 /* We need to follow the pointers around the loop. */
3721 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3724 /* don't loop forever if the structure is bust, and we have
3725 a pointer into a closed loop. */
3726 assert (current != after);
3727 assert (SvPVX_const(current) == pvx);
3729 /* Make the SV before us point to the SV after us. */
3730 SV_COW_NEXT_SV_SET(current, after);
3733 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3738 Perl_sv_release_IVX(pTHX_ register SV *sv)
3741 sv_force_normal_flags(sv, 0);
3747 =for apidoc sv_force_normal_flags
3749 Undo various types of fakery on an SV: if the PV is a shared string, make
3750 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3751 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3752 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3753 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3754 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3755 set to some other value.) In addition, the C<flags> parameter gets passed to
3756 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3757 with flags set to 0.
3763 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3766 #ifdef PERL_OLD_COPY_ON_WRITE
3767 if (SvREADONLY(sv)) {
3768 /* At this point I believe I should acquire a global SV mutex. */
3770 const char * const pvx = SvPVX_const(sv);
3771 const STRLEN len = SvLEN(sv);
3772 const STRLEN cur = SvCUR(sv);
3773 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3775 PerlIO_printf(Perl_debug_log,
3776 "Copy on write: Force normal %ld\n",
3782 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3783 SvPV_set(sv, (char*)0);
3785 if (flags & SV_COW_DROP_PV) {
3786 /* OK, so we don't need to copy our buffer. */
3789 SvGROW(sv, cur + 1);
3790 Move(pvx,SvPVX(sv),cur,char);
3794 sv_release_COW(sv, pvx, len, next);
3799 else if (IN_PERL_RUNTIME)
3800 Perl_croak(aTHX_ PL_no_modify);
3801 /* At this point I believe that I can drop the global SV mutex. */
3804 if (SvREADONLY(sv)) {
3806 const char * const pvx = SvPVX_const(sv);
3807 const STRLEN len = SvCUR(sv);
3810 SvPV_set(sv, Nullch);
3812 SvGROW(sv, len + 1);
3813 Move(pvx,SvPVX(sv),len,char);
3815 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3817 else if (IN_PERL_RUNTIME)
3818 Perl_croak(aTHX_ PL_no_modify);
3822 sv_unref_flags(sv, flags);
3823 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3830 Efficient removal of characters from the beginning of the string buffer.
3831 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3832 the string buffer. The C<ptr> becomes the first character of the adjusted
3833 string. Uses the "OOK hack".
3834 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3835 refer to the same chunk of data.
3841 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3843 register STRLEN delta;
3844 if (!ptr || !SvPOKp(sv))
3846 delta = ptr - SvPVX_const(sv);
3847 SV_CHECK_THINKFIRST(sv);
3848 if (SvTYPE(sv) < SVt_PVIV)
3849 sv_upgrade(sv,SVt_PVIV);
3852 if (!SvLEN(sv)) { /* make copy of shared string */
3853 const char *pvx = SvPVX_const(sv);
3854 const STRLEN len = SvCUR(sv);
3855 SvGROW(sv, len + 1);
3856 Move(pvx,SvPVX(sv),len,char);
3860 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3861 and we do that anyway inside the SvNIOK_off
3863 SvFLAGS(sv) |= SVf_OOK;
3866 SvLEN_set(sv, SvLEN(sv) - delta);
3867 SvCUR_set(sv, SvCUR(sv) - delta);
3868 SvPV_set(sv, SvPVX(sv) + delta);
3869 SvIV_set(sv, SvIVX(sv) + delta);
3873 =for apidoc sv_catpvn
3875 Concatenates the string onto the end of the string which is in the SV. The
3876 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3877 status set, then the bytes appended should be valid UTF-8.
3878 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3880 =for apidoc sv_catpvn_flags
3882 Concatenates the string onto the end of the string which is in the SV. The
3883 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3884 status set, then the bytes appended should be valid UTF-8.
3885 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3886 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3887 in terms of this function.
3893 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3897 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3899 SvGROW(dsv, dlen + slen + 1);
3901 sstr = SvPVX_const(dsv);
3902 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3903 SvCUR_set(dsv, SvCUR(dsv) + slen);
3905 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3907 if (flags & SV_SMAGIC)
3912 =for apidoc sv_catsv
3914 Concatenates the string from SV C<ssv> onto the end of the string in
3915 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3916 not 'set' magic. See C<sv_catsv_mg>.
3918 =for apidoc sv_catsv_flags
3920 Concatenates the string from SV C<ssv> onto the end of the string in
3921 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3922 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3923 and C<sv_catsv_nomg> are implemented in terms of this function.
3928 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3933 const char *spv = SvPV_const(ssv, slen);
3935 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3936 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3937 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3938 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3939 dsv->sv_flags doesn't have that bit set.
3940 Andy Dougherty 12 Oct 2001
3942 const I32 sutf8 = DO_UTF8(ssv);
3945 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3947 dutf8 = DO_UTF8(dsv);
3949 if (dutf8 != sutf8) {
3951 /* Not modifying source SV, so taking a temporary copy. */
3952 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3954 sv_utf8_upgrade(csv);
3955 spv = SvPV_const(csv, slen);
3958 sv_utf8_upgrade_nomg(dsv);
3960 sv_catpvn_nomg(dsv, spv, slen);
3963 if (flags & SV_SMAGIC)
3968 =for apidoc sv_catpv
3970 Concatenates the string onto the end of the string which is in the SV.
3971 If the SV has the UTF-8 status set, then the bytes appended should be
3972 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3977 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3980 register STRLEN len;
3986 junk = SvPV_force(sv, tlen);
3988 SvGROW(sv, tlen + len + 1);
3990 ptr = SvPVX_const(sv);
3991 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3992 SvCUR_set(sv, SvCUR(sv) + len);
3993 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3998 =for apidoc sv_catpv_mg
4000 Like C<sv_catpv>, but also handles 'set' magic.
4006 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4015 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4016 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4023 Perl_newSV(pTHX_ STRLEN len)
4030 sv_upgrade(sv, SVt_PV);
4031 SvGROW(sv, len + 1);
4036 =for apidoc sv_magicext
4038 Adds magic to an SV, upgrading it if necessary. Applies the
4039 supplied vtable and returns a pointer to the magic added.
4041 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4042 In particular, you can add magic to SvREADONLY SVs, and add more than
4043 one instance of the same 'how'.
4045 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4046 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4047 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4048 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4050 (This is now used as a subroutine by C<sv_magic>.)
4055 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4056 const char* name, I32 namlen)
4061 if (SvTYPE(sv) < SVt_PVMG) {
4062 SvUPGRADE(sv, SVt_PVMG);
4064 Newxz(mg, 1, MAGIC);
4065 mg->mg_moremagic = SvMAGIC(sv);
4066 SvMAGIC_set(sv, mg);
4068 /* Sometimes a magic contains a reference loop, where the sv and
4069 object refer to each other. To prevent a reference loop that
4070 would prevent such objects being freed, we look for such loops
4071 and if we find one we avoid incrementing the object refcount.
4073 Note we cannot do this to avoid self-tie loops as intervening RV must
4074 have its REFCNT incremented to keep it in existence.
4077 if (!obj || obj == sv ||
4078 how == PERL_MAGIC_arylen ||
4079 how == PERL_MAGIC_qr ||
4080 how == PERL_MAGIC_symtab ||
4081 (SvTYPE(obj) == SVt_PVGV &&
4082 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4083 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4084 GvFORM(obj) == (CV*)sv)))
4089 mg->mg_obj = SvREFCNT_inc(obj);
4090 mg->mg_flags |= MGf_REFCOUNTED;
4093 /* Normal self-ties simply pass a null object, and instead of
4094 using mg_obj directly, use the SvTIED_obj macro to produce a
4095 new RV as needed. For glob "self-ties", we are tieing the PVIO
4096 with an RV obj pointing to the glob containing the PVIO. In
4097 this case, to avoid a reference loop, we need to weaken the
4101 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4102 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4108 mg->mg_len = namlen;
4111 mg->mg_ptr = savepvn(name, namlen);
4112 else if (namlen == HEf_SVKEY)
4113 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4115 mg->mg_ptr = (char *) name;
4117 mg->mg_virtual = vtable;
4121 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4126 =for apidoc sv_magic
4128 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4129 then adds a new magic item of type C<how> to the head of the magic list.
4131 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4132 handling of the C<name> and C<namlen> arguments.
4134 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4135 to add more than one instance of the same 'how'.
4141 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4144 const MGVTBL *vtable;
4147 #ifdef PERL_OLD_COPY_ON_WRITE
4149 sv_force_normal_flags(sv, 0);
4151 if (SvREADONLY(sv)) {
4153 /* its okay to attach magic to shared strings; the subsequent
4154 * upgrade to PVMG will unshare the string */
4155 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4158 && how != PERL_MAGIC_regex_global
4159 && how != PERL_MAGIC_bm
4160 && how != PERL_MAGIC_fm
4161 && how != PERL_MAGIC_sv
4162 && how != PERL_MAGIC_backref
4165 Perl_croak(aTHX_ PL_no_modify);
4168 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4169 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4170 /* sv_magic() refuses to add a magic of the same 'how' as an
4173 if (how == PERL_MAGIC_taint)
4181 vtable = &PL_vtbl_sv;
4183 case PERL_MAGIC_overload:
4184 vtable = &PL_vtbl_amagic;
4186 case PERL_MAGIC_overload_elem:
4187 vtable = &PL_vtbl_amagicelem;
4189 case PERL_MAGIC_overload_table:
4190 vtable = &PL_vtbl_ovrld;
4193 vtable = &PL_vtbl_bm;
4195 case PERL_MAGIC_regdata:
4196 vtable = &PL_vtbl_regdata;
4198 case PERL_MAGIC_regdatum:
4199 vtable = &PL_vtbl_regdatum;
4201 case PERL_MAGIC_env:
4202 vtable = &PL_vtbl_env;
4205 vtable = &PL_vtbl_fm;
4207 case PERL_MAGIC_envelem:
4208 vtable = &PL_vtbl_envelem;
4210 case PERL_MAGIC_regex_global:
4211 vtable = &PL_vtbl_mglob;
4213 case PERL_MAGIC_isa:
4214 vtable = &PL_vtbl_isa;
4216 case PERL_MAGIC_isaelem:
4217 vtable = &PL_vtbl_isaelem;
4219 case PERL_MAGIC_nkeys:
4220 vtable = &PL_vtbl_nkeys;
4222 case PERL_MAGIC_dbfile:
4225 case PERL_MAGIC_dbline:
4226 vtable = &PL_vtbl_dbline;
4228 #ifdef USE_LOCALE_COLLATE
4229 case PERL_MAGIC_collxfrm:
4230 vtable = &PL_vtbl_collxfrm;
4232 #endif /* USE_LOCALE_COLLATE */
4233 case PERL_MAGIC_tied:
4234 vtable = &PL_vtbl_pack;
4236 case PERL_MAGIC_tiedelem:
4237 case PERL_MAGIC_tiedscalar:
4238 vtable = &PL_vtbl_packelem;
4241 vtable = &PL_vtbl_regexp;
4243 case PERL_MAGIC_sig:
4244 vtable = &PL_vtbl_sig;
4246 case PERL_MAGIC_sigelem:
4247 vtable = &PL_vtbl_sigelem;
4249 case PERL_MAGIC_taint:
4250 vtable = &PL_vtbl_taint;
4252 case PERL_MAGIC_uvar:
4253 vtable = &PL_vtbl_uvar;
4255 case PERL_MAGIC_vec:
4256 vtable = &PL_vtbl_vec;
4258 case PERL_MAGIC_arylen_p:
4259 case PERL_MAGIC_rhash:
4260 case PERL_MAGIC_symtab:
4261 case PERL_MAGIC_vstring:
4264 case PERL_MAGIC_utf8:
4265 vtable = &PL_vtbl_utf8;
4267 case PERL_MAGIC_substr:
4268 vtable = &PL_vtbl_substr;
4270 case PERL_MAGIC_defelem:
4271 vtable = &PL_vtbl_defelem;
4273 case PERL_MAGIC_glob:
4274 vtable = &PL_vtbl_glob;
4276 case PERL_MAGIC_arylen:
4277 vtable = &PL_vtbl_arylen;
4279 case PERL_MAGIC_pos:
4280 vtable = &PL_vtbl_pos;
4282 case PERL_MAGIC_backref:
4283 vtable = &PL_vtbl_backref;
4285 case PERL_MAGIC_ext:
4286 /* Reserved for use by extensions not perl internals. */
4287 /* Useful for attaching extension internal data to perl vars. */
4288 /* Note that multiple extensions may clash if magical scalars */
4289 /* etc holding private data from one are passed to another. */
4293 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4296 /* Rest of work is done else where */
4297 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4300 case PERL_MAGIC_taint:
4303 case PERL_MAGIC_ext:
4304 case PERL_MAGIC_dbfile:
4311 =for apidoc sv_unmagic
4313 Removes all magic of type C<type> from an SV.
4319 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4323 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4326 for (mg = *mgp; mg; mg = *mgp) {
4327 if (mg->mg_type == type) {
4328 const MGVTBL* const vtbl = mg->mg_virtual;
4329 *mgp = mg->mg_moremagic;
4330 if (vtbl && vtbl->svt_free)
4331 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4332 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4334 Safefree(mg->mg_ptr);
4335 else if (mg->mg_len == HEf_SVKEY)
4336 SvREFCNT_dec((SV*)mg->mg_ptr);
4337 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4338 Safefree(mg->mg_ptr);
4340 if (mg->mg_flags & MGf_REFCOUNTED)
4341 SvREFCNT_dec(mg->mg_obj);
4345 mgp = &mg->mg_moremagic;
4349 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4350 SvMAGIC_set(sv, NULL);
4357 =for apidoc sv_rvweaken
4359 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4360 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4361 push a back-reference to this RV onto the array of backreferences
4362 associated with that magic.
4368 Perl_sv_rvweaken(pTHX_ SV *sv)
4371 if (!SvOK(sv)) /* let undefs pass */
4374 Perl_croak(aTHX_ "Can't weaken a nonreference");
4375 else if (SvWEAKREF(sv)) {
4376 if (ckWARN(WARN_MISC))
4377 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4381 Perl_sv_add_backref(aTHX_ tsv, sv);
4387 /* Give tsv backref magic if it hasn't already got it, then push a
4388 * back-reference to sv onto the array associated with the backref magic.
4392 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4397 if (SvTYPE(tsv) == SVt_PVHV) {
4398 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4402 /* There is no AV in the offical place - try a fixup. */
4403 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4406 /* Aha. They've got it stowed in magic. Bring it back. */
4407 av = (AV*)mg->mg_obj;
4408 /* Stop mg_free decreasing the refernce count. */
4410 /* Stop mg_free even calling the destructor, given that
4411 there's no AV to free up. */
4413 sv_unmagic(tsv, PERL_MAGIC_backref);
4422 const MAGIC *const mg
4423 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4425 av = (AV*)mg->mg_obj;
4429 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4430 /* av now has a refcnt of 2, which avoids it getting freed
4431 * before us during global cleanup. The extra ref is removed
4432 * by magic_killbackrefs() when tsv is being freed */
4435 if (AvFILLp(av) >= AvMAX(av)) {
4436 av_extend(av, AvFILLp(av)+1);
4438 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4441 /* delete a back-reference to ourselves from the backref magic associated
4442 * with the SV we point to.
4446 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4453 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4454 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4455 /* We mustn't attempt to "fix up" the hash here by moving the
4456 backreference array back to the hv_aux structure, as that is stored
4457 in the main HvARRAY(), and hfreentries assumes that no-one
4458 reallocates HvARRAY() while it is running. */
4461 const MAGIC *const mg
4462 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4464 av = (AV *)mg->mg_obj;
4467 if (PL_in_clean_all)
4469 Perl_croak(aTHX_ "panic: del_backref");
4476 /* We shouldn't be in here more than once, but for paranoia reasons lets
4478 for (i = AvFILLp(av); i >= 0; i--) {
4480 const SSize_t fill = AvFILLp(av);
4482 /* We weren't the last entry.
4483 An unordered list has this property that you can take the
4484 last element off the end to fill the hole, and it's still
4485 an unordered list :-)
4490 AvFILLp(av) = fill - 1;
4496 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4498 SV **svp = AvARRAY(av);
4500 PERL_UNUSED_ARG(sv);
4502 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4503 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4504 if (svp && !SvIS_FREED(av)) {
4505 SV *const *const last = svp + AvFILLp(av);
4507 while (svp <= last) {
4509 SV *const referrer = *svp;
4510 if (SvWEAKREF(referrer)) {
4511 /* XXX Should we check that it hasn't changed? */
4512 SvRV_set(referrer, 0);
4514 SvWEAKREF_off(referrer);
4515 } else if (SvTYPE(referrer) == SVt_PVGV ||
4516 SvTYPE(referrer) == SVt_PVLV) {
4517 /* You lookin' at me? */
4518 assert(GvSTASH(referrer));
4519 assert(GvSTASH(referrer) == (HV*)sv);
4520 GvSTASH(referrer) = 0;
4523 "panic: magic_killbackrefs (flags=%"UVxf")",
4524 (UV)SvFLAGS(referrer));
4532 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4537 =for apidoc sv_insert
4539 Inserts a string at the specified offset/length within the SV. Similar to
4540 the Perl substr() function.
4546 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4551 register char *midend;
4552 register char *bigend;
4558 Perl_croak(aTHX_ "Can't modify non-existent substring");
4559 SvPV_force(bigstr, curlen);
4560 (void)SvPOK_only_UTF8(bigstr);
4561 if (offset + len > curlen) {
4562 SvGROW(bigstr, offset+len+1);
4563 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4564 SvCUR_set(bigstr, offset+len);
4568 i = littlelen - len;
4569 if (i > 0) { /* string might grow */
4570 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4571 mid = big + offset + len;
4572 midend = bigend = big + SvCUR(bigstr);
4575 while (midend > mid) /* shove everything down */
4576 *--bigend = *--midend;
4577 Move(little,big+offset,littlelen,char);
4578 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4583 Move(little,SvPVX(bigstr)+offset,len,char);
4588 big = SvPVX(bigstr);
4591 bigend = big + SvCUR(bigstr);
4593 if (midend > bigend)
4594 Perl_croak(aTHX_ "panic: sv_insert");
4596 if (mid - big > bigend - midend) { /* faster to shorten from end */
4598 Move(little, mid, littlelen,char);
4601 i = bigend - midend;
4603 Move(midend, mid, i,char);
4607 SvCUR_set(bigstr, mid - big);
4609 else if ((i = mid - big)) { /* faster from front */
4610 midend -= littlelen;
4612 sv_chop(bigstr,midend-i);
4617 Move(little, mid, littlelen,char);
4619 else if (littlelen) {
4620 midend -= littlelen;
4621 sv_chop(bigstr,midend);
4622 Move(little,midend,littlelen,char);
4625 sv_chop(bigstr,midend);
4631 =for apidoc sv_replace
4633 Make the first argument a copy of the second, then delete the original.
4634 The target SV physically takes over ownership of the body of the source SV
4635 and inherits its flags; however, the target keeps any magic it owns,
4636 and any magic in the source is discarded.
4637 Note that this is a rather specialist SV copying operation; most of the
4638 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4644 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4647 const U32 refcnt = SvREFCNT(sv);
4648 SV_CHECK_THINKFIRST_COW_DROP(sv);
4649 if (SvREFCNT(nsv) != 1) {
4650 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4651 UVuf " != 1)", (UV) SvREFCNT(nsv));
4653 if (SvMAGICAL(sv)) {
4657 sv_upgrade(nsv, SVt_PVMG);
4658 SvMAGIC_set(nsv, SvMAGIC(sv));
4659 SvFLAGS(nsv) |= SvMAGICAL(sv);
4661 SvMAGIC_set(sv, NULL);
4665 assert(!SvREFCNT(sv));
4666 #ifdef DEBUG_LEAKING_SCALARS
4667 sv->sv_flags = nsv->sv_flags;
4668 sv->sv_any = nsv->sv_any;
4669 sv->sv_refcnt = nsv->sv_refcnt;
4670 sv->sv_u = nsv->sv_u;
4672 StructCopy(nsv,sv,SV);
4674 /* Currently could join these into one piece of pointer arithmetic, but
4675 it would be unclear. */
4676 if(SvTYPE(sv) == SVt_IV)
4678 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4679 else if (SvTYPE(sv) == SVt_RV) {
4680 SvANY(sv) = &sv->sv_u.svu_rv;
4684 #ifdef PERL_OLD_COPY_ON_WRITE
4685 if (SvIsCOW_normal(nsv)) {
4686 /* We need to follow the pointers around the loop to make the
4687 previous SV point to sv, rather than nsv. */
4690 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4693 assert(SvPVX_const(current) == SvPVX_const(nsv));
4695 /* Make the SV before us point to the SV after us. */
4697 PerlIO_printf(Perl_debug_log, "previous is\n");
4699 PerlIO_printf(Perl_debug_log,
4700 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4701 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4703 SV_COW_NEXT_SV_SET(current, sv);
4706 SvREFCNT(sv) = refcnt;
4707 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4713 =for apidoc sv_clear
4715 Clear an SV: call any destructors, free up any memory used by the body,
4716 and free the body itself. The SV's head is I<not> freed, although
4717 its type is set to all 1's so that it won't inadvertently be assumed
4718 to be live during global destruction etc.
4719 This function should only be called when REFCNT is zero. Most of the time
4720 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4727 Perl_sv_clear(pTHX_ register SV *sv)
4730 const U32 type = SvTYPE(sv);
4731 const struct body_details *const sv_type_details
4732 = bodies_by_type + type;
4735 assert(SvREFCNT(sv) == 0);
4741 if (PL_defstash) { /* Still have a symbol table? */
4746 stash = SvSTASH(sv);
4747 destructor = StashHANDLER(stash,DESTROY);
4749 SV* const tmpref = newRV(sv);
4750 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4752 PUSHSTACKi(PERLSI_DESTROY);
4757 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4763 if(SvREFCNT(tmpref) < 2) {
4764 /* tmpref is not kept alive! */
4766 SvRV_set(tmpref, NULL);
4769 SvREFCNT_dec(tmpref);
4771 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4775 if (PL_in_clean_objs)
4776 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4778 /* DESTROY gave object new lease on life */
4784 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4785 SvOBJECT_off(sv); /* Curse the object. */
4786 if (type != SVt_PVIO)
4787 --PL_sv_objcount; /* XXX Might want something more general */
4790 if (type >= SVt_PVMG) {
4793 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4794 SvREFCNT_dec(SvSTASH(sv));
4799 IoIFP(sv) != PerlIO_stdin() &&
4800 IoIFP(sv) != PerlIO_stdout() &&
4801 IoIFP(sv) != PerlIO_stderr())
4803 io_close((IO*)sv, FALSE);
4805 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4806 PerlDir_close(IoDIRP(sv));
4807 IoDIRP(sv) = (DIR*)NULL;
4808 Safefree(IoTOP_NAME(sv));
4809 Safefree(IoFMT_NAME(sv));
4810 Safefree(IoBOTTOM_NAME(sv));
4819 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4826 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4827 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4828 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4829 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4831 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4832 SvREFCNT_dec(LvTARG(sv));
4836 Safefree(GvNAME(sv));
4837 /* If we're in a stash, we don't own a reference to it. However it does
4838 have a back reference to us, which needs to be cleared. */
4840 sv_del_backref((SV*)GvSTASH(sv), sv);
4845 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4847 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4848 /* Don't even bother with turning off the OOK flag. */
4853 SV *target = SvRV(sv);
4855 sv_del_backref(target, sv);
4857 SvREFCNT_dec(target);
4859 #ifdef PERL_OLD_COPY_ON_WRITE
4860 else if (SvPVX_const(sv)) {
4862 /* I believe I need to grab the global SV mutex here and
4863 then recheck the COW status. */
4865 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4868 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4869 SV_COW_NEXT_SV(sv));
4870 /* And drop it here. */
4872 } else if (SvLEN(sv)) {
4873 Safefree(SvPVX_const(sv));
4877 else if (SvPVX_const(sv) && SvLEN(sv))
4878 Safefree(SvPVX_mutable(sv));
4879 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4880 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4889 SvFLAGS(sv) &= SVf_BREAK;
4890 SvFLAGS(sv) |= SVTYPEMASK;
4892 if (sv_type_details->arena) {
4893 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4894 &PL_body_roots[type]);
4896 else if (sv_type_details->size) {
4897 my_safefree(SvANY(sv));
4902 =for apidoc sv_newref
4904 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4911 Perl_sv_newref(pTHX_ SV *sv)
4921 Decrement an SV's reference count, and if it drops to zero, call
4922 C<sv_clear> to invoke destructors and free up any memory used by
4923 the body; finally, deallocate the SV's head itself.
4924 Normally called via a wrapper macro C<SvREFCNT_dec>.
4930 Perl_sv_free(pTHX_ SV *sv)
4935 if (SvREFCNT(sv) == 0) {
4936 if (SvFLAGS(sv) & SVf_BREAK)
4937 /* this SV's refcnt has been artificially decremented to
4938 * trigger cleanup */
4940 if (PL_in_clean_all) /* All is fair */
4942 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4943 /* make sure SvREFCNT(sv)==0 happens very seldom */
4944 SvREFCNT(sv) = (~(U32)0)/2;
4947 if (ckWARN_d(WARN_INTERNAL)) {
4948 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4949 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4950 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4951 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4952 Perl_dump_sv_child(aTHX_ sv);
4957 if (--(SvREFCNT(sv)) > 0)
4959 Perl_sv_free2(aTHX_ sv);
4963 Perl_sv_free2(pTHX_ SV *sv)
4968 if (ckWARN_d(WARN_DEBUGGING))
4969 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4970 "Attempt to free temp prematurely: SV 0x%"UVxf
4971 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4975 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4976 /* make sure SvREFCNT(sv)==0 happens very seldom */
4977 SvREFCNT(sv) = (~(U32)0)/2;
4988 Returns the length of the string in the SV. Handles magic and type
4989 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4995 Perl_sv_len(pTHX_ register SV *sv)
5003 len = mg_length(sv);
5005 (void)SvPV_const(sv, len);
5010 =for apidoc sv_len_utf8
5012 Returns the number of characters in the string in an SV, counting wide
5013 UTF-8 bytes as a single character. Handles magic and type coercion.
5019 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5020 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5021 * (Note that the mg_len is not the length of the mg_ptr field.)
5026 Perl_sv_len_utf8(pTHX_ register SV *sv)
5032 return mg_length(sv);
5036 const U8 *s = (U8*)SvPV_const(sv, len);
5037 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5039 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5041 #ifdef PERL_UTF8_CACHE_ASSERT
5042 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5046 ulen = Perl_utf8_length(aTHX_ s, s + len);
5047 if (!mg && !SvREADONLY(sv)) {
5048 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5049 mg = mg_find(sv, PERL_MAGIC_utf8);
5059 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5060 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5061 * between UTF-8 and byte offsets. There are two (substr offset and substr
5062 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5063 * and byte offset) cache positions.
5065 * The mg_len field is used by sv_len_utf8(), see its comments.
5066 * Note that the mg_len is not the length of the mg_ptr field.
5070 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5071 I32 offsetp, const U8 *s, const U8 *start)
5075 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5077 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5081 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5083 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5084 (*mgp)->mg_ptr = (char *) *cachep;
5088 (*cachep)[i] = offsetp;
5089 (*cachep)[i+1] = s - start;
5097 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5098 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5099 * between UTF-8 and byte offsets. See also the comments of
5100 * S_utf8_mg_pos_init().
5104 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)
5108 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5110 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5111 if (*mgp && (*mgp)->mg_ptr) {
5112 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5113 ASSERT_UTF8_CACHE(*cachep);
5114 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5116 else { /* We will skip to the right spot. */
5121 /* The assumption is that going backward is half
5122 * the speed of going forward (that's where the
5123 * 2 * backw in the below comes from). (The real
5124 * figure of course depends on the UTF-8 data.) */
5126 if ((*cachep)[i] > (STRLEN)uoff) {
5128 backw = (*cachep)[i] - (STRLEN)uoff;
5130 if (forw < 2 * backw)
5133 p = start + (*cachep)[i+1];
5135 /* Try this only for the substr offset (i == 0),
5136 * not for the substr length (i == 2). */
5137 else if (i == 0) { /* (*cachep)[i] < uoff */
5138 const STRLEN ulen = sv_len_utf8(sv);
5140 if ((STRLEN)uoff < ulen) {
5141 forw = (STRLEN)uoff - (*cachep)[i];
5142 backw = ulen - (STRLEN)uoff;
5144 if (forw < 2 * backw)
5145 p = start + (*cachep)[i+1];
5150 /* If the string is not long enough for uoff,
5151 * we could extend it, but not at this low a level. */
5155 if (forw < 2 * backw) {
5162 while (UTF8_IS_CONTINUATION(*p))
5167 /* Update the cache. */
5168 (*cachep)[i] = (STRLEN)uoff;
5169 (*cachep)[i+1] = p - start;
5171 /* Drop the stale "length" cache */
5180 if (found) { /* Setup the return values. */
5181 *offsetp = (*cachep)[i+1];
5182 *sp = start + *offsetp;
5185 *offsetp = send - start;
5187 else if (*sp < start) {
5193 #ifdef PERL_UTF8_CACHE_ASSERT
5198 while (n-- && s < send)
5202 assert(*offsetp == s - start);
5203 assert((*cachep)[0] == (STRLEN)uoff);
5204 assert((*cachep)[1] == *offsetp);
5206 ASSERT_UTF8_CACHE(*cachep);
5215 =for apidoc sv_pos_u2b
5217 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5218 the start of the string, to a count of the equivalent number of bytes; if
5219 lenp is non-zero, it does the same to lenp, but this time starting from
5220 the offset, rather than from the start of the string. Handles magic and
5227 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5228 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5229 * byte offsets. See also the comments of S_utf8_mg_pos().
5234 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5242 start = (U8*)SvPV_const(sv, len);
5245 STRLEN *cache = NULL;
5246 const U8 *s = start;
5247 I32 uoffset = *offsetp;
5248 const U8 * const send = s + len;
5250 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5252 if (!found && uoffset > 0) {
5253 while (s < send && uoffset--)
5257 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5259 *offsetp = s - start;
5264 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5268 if (!found && *lenp > 0) {
5271 while (s < send && ulen--)
5275 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5279 ASSERT_UTF8_CACHE(cache);
5291 =for apidoc sv_pos_b2u
5293 Converts the value pointed to by offsetp from a count of bytes from the
5294 start of the string, to a count of the equivalent number of UTF-8 chars.
5295 Handles magic and type coercion.
5301 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5302 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5303 * byte offsets. See also the comments of S_utf8_mg_pos().
5308 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5316 s = (const U8*)SvPV_const(sv, len);
5317 if ((I32)len < *offsetp)
5318 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5320 const U8* send = s + *offsetp;
5322 STRLEN *cache = NULL;
5326 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5327 mg = mg_find(sv, PERL_MAGIC_utf8);
5328 if (mg && mg->mg_ptr) {
5329 cache = (STRLEN *) mg->mg_ptr;
5330 if (cache[1] == (STRLEN)*offsetp) {
5331 /* An exact match. */
5332 *offsetp = cache[0];
5336 else if (cache[1] < (STRLEN)*offsetp) {
5337 /* We already know part of the way. */
5340 /* Let the below loop do the rest. */
5342 else { /* cache[1] > *offsetp */
5343 /* We already know all of the way, now we may
5344 * be able to walk back. The same assumption
5345 * is made as in S_utf8_mg_pos(), namely that
5346 * walking backward is twice slower than
5347 * walking forward. */
5348 const STRLEN forw = *offsetp;
5349 STRLEN backw = cache[1] - *offsetp;
5351 if (!(forw < 2 * backw)) {
5352 const U8 *p = s + cache[1];
5359 while (UTF8_IS_CONTINUATION(*p)) {
5367 *offsetp = cache[0];
5369 /* Drop the stale "length" cache */
5377 ASSERT_UTF8_CACHE(cache);
5383 /* Call utf8n_to_uvchr() to validate the sequence
5384 * (unless a simple non-UTF character) */
5385 if (!UTF8_IS_INVARIANT(*s))
5386 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5395 if (!SvREADONLY(sv)) {
5397 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5398 mg = mg_find(sv, PERL_MAGIC_utf8);
5403 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5404 mg->mg_ptr = (char *) cache;
5409 cache[1] = *offsetp;
5410 /* Drop the stale "length" cache */
5423 Returns a boolean indicating whether the strings in the two SVs are
5424 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5425 coerce its args to strings if necessary.
5431 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5440 SV* svrecode = Nullsv;
5447 pv1 = SvPV_const(sv1, cur1);
5454 pv2 = SvPV_const(sv2, cur2);
5456 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5457 /* Differing utf8ness.
5458 * Do not UTF8size the comparands as a side-effect. */
5461 svrecode = newSVpvn(pv2, cur2);
5462 sv_recode_to_utf8(svrecode, PL_encoding);
5463 pv2 = SvPV_const(svrecode, cur2);
5466 svrecode = newSVpvn(pv1, cur1);
5467 sv_recode_to_utf8(svrecode, PL_encoding);
5468 pv1 = SvPV_const(svrecode, cur1);
5470 /* Now both are in UTF-8. */
5472 SvREFCNT_dec(svrecode);
5477 bool is_utf8 = TRUE;
5480 /* sv1 is the UTF-8 one,
5481 * if is equal it must be downgrade-able */
5482 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5488 /* sv2 is the UTF-8 one,
5489 * if is equal it must be downgrade-able */
5490 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5496 /* Downgrade not possible - cannot be eq */
5504 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5507 SvREFCNT_dec(svrecode);
5518 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5519 string in C<sv1> is less than, equal to, or greater than the string in
5520 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5521 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5527 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5531 const char *pv1, *pv2;
5534 SV *svrecode = Nullsv;
5541 pv1 = SvPV_const(sv1, cur1);
5548 pv2 = SvPV_const(sv2, cur2);
5550 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5551 /* Differing utf8ness.
5552 * Do not UTF8size the comparands as a side-effect. */
5555 svrecode = newSVpvn(pv2, cur2);
5556 sv_recode_to_utf8(svrecode, PL_encoding);
5557 pv2 = SvPV_const(svrecode, cur2);
5560 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5565 svrecode = newSVpvn(pv1, cur1);
5566 sv_recode_to_utf8(svrecode, PL_encoding);
5567 pv1 = SvPV_const(svrecode, cur1);
5570 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5576 cmp = cur2 ? -1 : 0;
5580 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5583 cmp = retval < 0 ? -1 : 1;
5584 } else if (cur1 == cur2) {
5587 cmp = cur1 < cur2 ? -1 : 1;
5592 SvREFCNT_dec(svrecode);
5601 =for apidoc sv_cmp_locale
5603 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5604 'use bytes' aware, handles get magic, and will coerce its args to strings
5605 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5611 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5614 #ifdef USE_LOCALE_COLLATE
5620 if (PL_collation_standard)
5624 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5626 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5628 if (!pv1 || !len1) {
5639 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5642 return retval < 0 ? -1 : 1;
5645 * When the result of collation is equality, that doesn't mean
5646 * that there are no differences -- some locales exclude some
5647 * characters from consideration. So to avoid false equalities,
5648 * we use the raw string as a tiebreaker.
5654 #endif /* USE_LOCALE_COLLATE */
5656 return sv_cmp(sv1, sv2);
5660 #ifdef USE_LOCALE_COLLATE
5663 =for apidoc sv_collxfrm
5665 Add Collate Transform magic to an SV if it doesn't already have it.
5667 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5668 scalar data of the variable, but transformed to such a format that a normal
5669 memory comparison can be used to compare the data according to the locale
5676 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5681 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5682 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5688 Safefree(mg->mg_ptr);
5689 s = SvPV_const(sv, len);
5690 if ((xf = mem_collxfrm(s, len, &xlen))) {
5691 if (SvREADONLY(sv)) {
5694 return xf + sizeof(PL_collation_ix);
5697 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5698 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5711 if (mg && mg->mg_ptr) {
5713 return mg->mg_ptr + sizeof(PL_collation_ix);
5721 #endif /* USE_LOCALE_COLLATE */
5726 Get a line from the filehandle and store it into the SV, optionally
5727 appending to the currently-stored string.
5733 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5738 register STDCHAR rslast;
5739 register STDCHAR *bp;
5745 if (SvTHINKFIRST(sv))
5746 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5747 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5749 However, perlbench says it's slower, because the existing swipe code
5750 is faster than copy on write.
5751 Swings and roundabouts. */
5752 SvUPGRADE(sv, SVt_PV);
5757 if (PerlIO_isutf8(fp)) {
5759 sv_utf8_upgrade_nomg(sv);
5760 sv_pos_u2b(sv,&append,0);
5762 } else if (SvUTF8(sv)) {
5763 SV * const tsv = NEWSV(0,0);
5764 sv_gets(tsv, fp, 0);
5765 sv_utf8_upgrade_nomg(tsv);
5766 SvCUR_set(sv,append);
5769 goto return_string_or_null;
5774 if (PerlIO_isutf8(fp))
5777 if (IN_PERL_COMPILETIME) {
5778 /* we always read code in line mode */
5782 else if (RsSNARF(PL_rs)) {
5783 /* If it is a regular disk file use size from stat() as estimate
5784 of amount we are going to read - may result in malloc-ing
5785 more memory than we realy need if layers bellow reduce
5786 size we read (e.g. CRLF or a gzip layer)
5789 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5790 const Off_t offset = PerlIO_tell(fp);
5791 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5792 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5798 else if (RsRECORD(PL_rs)) {
5802 /* Grab the size of the record we're getting */
5803 recsize = SvIV(SvRV(PL_rs));
5804 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5807 /* VMS wants read instead of fread, because fread doesn't respect */
5808 /* RMS record boundaries. This is not necessarily a good thing to be */
5809 /* doing, but we've got no other real choice - except avoid stdio
5810 as implementation - perhaps write a :vms layer ?
5812 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5814 bytesread = PerlIO_read(fp, buffer, recsize);
5818 SvCUR_set(sv, bytesread += append);
5819 buffer[bytesread] = '\0';
5820 goto return_string_or_null;
5822 else if (RsPARA(PL_rs)) {
5828 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5829 if (PerlIO_isutf8(fp)) {
5830 rsptr = SvPVutf8(PL_rs, rslen);
5833 if (SvUTF8(PL_rs)) {
5834 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5835 Perl_croak(aTHX_ "Wide character in $/");
5838 rsptr = SvPV_const(PL_rs, rslen);
5842 rslast = rslen ? rsptr[rslen - 1] : '\0';
5844 if (rspara) { /* have to do this both before and after */
5845 do { /* to make sure file boundaries work right */
5848 i = PerlIO_getc(fp);
5852 PerlIO_ungetc(fp,i);
5858 /* See if we know enough about I/O mechanism to cheat it ! */
5860 /* This used to be #ifdef test - it is made run-time test for ease
5861 of abstracting out stdio interface. One call should be cheap
5862 enough here - and may even be a macro allowing compile
5866 if (PerlIO_fast_gets(fp)) {
5869 * We're going to steal some values from the stdio struct
5870 * and put EVERYTHING in the innermost loop into registers.
5872 register STDCHAR *ptr;
5876 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5877 /* An ungetc()d char is handled separately from the regular
5878 * buffer, so we getc() it back out and stuff it in the buffer.
5880 i = PerlIO_getc(fp);
5881 if (i == EOF) return 0;
5882 *(--((*fp)->_ptr)) = (unsigned char) i;
5886 /* Here is some breathtakingly efficient cheating */
5888 cnt = PerlIO_get_cnt(fp); /* get count into register */
5889 /* make sure we have the room */
5890 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5891 /* Not room for all of it
5892 if we are looking for a separator and room for some
5894 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5895 /* just process what we have room for */
5896 shortbuffered = cnt - SvLEN(sv) + append + 1;
5897 cnt -= shortbuffered;
5901 /* remember that cnt can be negative */
5902 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5907 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5908 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5909 DEBUG_P(PerlIO_printf(Perl_debug_log,
5910 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5911 DEBUG_P(PerlIO_printf(Perl_debug_log,
5912 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5913 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5914 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5919 while (cnt > 0) { /* this | eat */
5921 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5922 goto thats_all_folks; /* screams | sed :-) */
5926 Copy(ptr, bp, cnt, char); /* this | eat */
5927 bp += cnt; /* screams | dust */
5928 ptr += cnt; /* louder | sed :-) */
5933 if (shortbuffered) { /* oh well, must extend */
5934 cnt = shortbuffered;
5936 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5938 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5939 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5943 DEBUG_P(PerlIO_printf(Perl_debug_log,
5944 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5945 PTR2UV(ptr),(long)cnt));
5946 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5948 DEBUG_P(PerlIO_printf(Perl_debug_log,
5949 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5950 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5951 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5953 /* This used to call 'filbuf' in stdio form, but as that behaves like
5954 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5955 another abstraction. */
5956 i = PerlIO_getc(fp); /* get more characters */
5958 DEBUG_P(PerlIO_printf(Perl_debug_log,
5959 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5960 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5961 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5963 cnt = PerlIO_get_cnt(fp);
5964 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5965 DEBUG_P(PerlIO_printf(Perl_debug_log,
5966 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5968 if (i == EOF) /* all done for ever? */
5969 goto thats_really_all_folks;
5971 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5973 SvGROW(sv, bpx + cnt + 2);
5974 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5976 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5978 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5979 goto thats_all_folks;
5983 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5984 memNE((char*)bp - rslen, rsptr, rslen))
5985 goto screamer; /* go back to the fray */
5986 thats_really_all_folks:
5988 cnt += shortbuffered;
5989 DEBUG_P(PerlIO_printf(Perl_debug_log,
5990 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5991 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5992 DEBUG_P(PerlIO_printf(Perl_debug_log,
5993 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5994 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5995 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5997 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5998 DEBUG_P(PerlIO_printf(Perl_debug_log,
5999 "Screamer: done, len=%ld, string=|%.*s|\n",
6000 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6004 /*The big, slow, and stupid way. */
6005 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6006 STDCHAR *buf = NULL;
6007 Newx(buf, 8192, STDCHAR);
6015 register const STDCHAR * const bpe = buf + sizeof(buf);
6017 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6018 ; /* keep reading */
6022 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6023 /* Accomodate broken VAXC compiler, which applies U8 cast to
6024 * both args of ?: operator, causing EOF to change into 255
6027 i = (U8)buf[cnt - 1];
6033 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6035 sv_catpvn(sv, (char *) buf, cnt);
6037 sv_setpvn(sv, (char *) buf, cnt);
6039 if (i != EOF && /* joy */
6041 SvCUR(sv) < rslen ||
6042 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6046 * If we're reading from a TTY and we get a short read,
6047 * indicating that the user hit his EOF character, we need
6048 * to notice it now, because if we try to read from the TTY
6049 * again, the EOF condition will disappear.
6051 * The comparison of cnt to sizeof(buf) is an optimization
6052 * that prevents unnecessary calls to feof().
6056 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6060 #ifdef USE_HEAP_INSTEAD_OF_STACK
6065 if (rspara) { /* have to do this both before and after */
6066 while (i != EOF) { /* to make sure file boundaries work right */
6067 i = PerlIO_getc(fp);
6069 PerlIO_ungetc(fp,i);
6075 return_string_or_null:
6076 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6082 Auto-increment of the value in the SV, doing string to numeric conversion
6083 if necessary. Handles 'get' magic.
6089 Perl_sv_inc(pTHX_ register SV *sv)
6098 if (SvTHINKFIRST(sv)) {
6100 sv_force_normal_flags(sv, 0);
6101 if (SvREADONLY(sv)) {
6102 if (IN_PERL_RUNTIME)
6103 Perl_croak(aTHX_ PL_no_modify);
6107 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6109 i = PTR2IV(SvRV(sv));
6114 flags = SvFLAGS(sv);
6115 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6116 /* It's (privately or publicly) a float, but not tested as an
6117 integer, so test it to see. */
6119 flags = SvFLAGS(sv);
6121 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6122 /* It's publicly an integer, or privately an integer-not-float */
6123 #ifdef PERL_PRESERVE_IVUV
6127 if (SvUVX(sv) == UV_MAX)
6128 sv_setnv(sv, UV_MAX_P1);
6130 (void)SvIOK_only_UV(sv);
6131 SvUV_set(sv, SvUVX(sv) + 1);
6133 if (SvIVX(sv) == IV_MAX)
6134 sv_setuv(sv, (UV)IV_MAX + 1);
6136 (void)SvIOK_only(sv);
6137 SvIV_set(sv, SvIVX(sv) + 1);
6142 if (flags & SVp_NOK) {
6143 (void)SvNOK_only(sv);
6144 SvNV_set(sv, SvNVX(sv) + 1.0);
6148 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6149 if ((flags & SVTYPEMASK) < SVt_PVIV)
6150 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6151 (void)SvIOK_only(sv);
6156 while (isALPHA(*d)) d++;
6157 while (isDIGIT(*d)) d++;
6159 #ifdef PERL_PRESERVE_IVUV
6160 /* Got to punt this as an integer if needs be, but we don't issue
6161 warnings. Probably ought to make the sv_iv_please() that does
6162 the conversion if possible, and silently. */
6163 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6164 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6165 /* Need to try really hard to see if it's an integer.
6166 9.22337203685478e+18 is an integer.
6167 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6168 so $a="9.22337203685478e+18"; $a+0; $a++
6169 needs to be the same as $a="9.22337203685478e+18"; $a++
6176 /* sv_2iv *should* have made this an NV */
6177 if (flags & SVp_NOK) {
6178 (void)SvNOK_only(sv);
6179 SvNV_set(sv, SvNVX(sv) + 1.0);
6182 /* I don't think we can get here. Maybe I should assert this
6183 And if we do get here I suspect that sv_setnv will croak. NWC
6185 #if defined(USE_LONG_DOUBLE)
6186 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",
6187 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6189 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6190 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6193 #endif /* PERL_PRESERVE_IVUV */
6194 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6198 while (d >= SvPVX_const(sv)) {
6206 /* MKS: The original code here died if letters weren't consecutive.
6207 * at least it didn't have to worry about non-C locales. The
6208 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6209 * arranged in order (although not consecutively) and that only
6210 * [A-Za-z] are accepted by isALPHA in the C locale.
6212 if (*d != 'z' && *d != 'Z') {
6213 do { ++*d; } while (!isALPHA(*d));
6216 *(d--) -= 'z' - 'a';
6221 *(d--) -= 'z' - 'a' + 1;
6225 /* oh,oh, the number grew */
6226 SvGROW(sv, SvCUR(sv) + 2);
6227 SvCUR_set(sv, SvCUR(sv) + 1);
6228 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6239 Auto-decrement of the value in the SV, doing string to numeric conversion
6240 if necessary. Handles 'get' magic.
6246 Perl_sv_dec(pTHX_ register SV *sv)
6254 if (SvTHINKFIRST(sv)) {
6256 sv_force_normal_flags(sv, 0);
6257 if (SvREADONLY(sv)) {
6258 if (IN_PERL_RUNTIME)
6259 Perl_croak(aTHX_ PL_no_modify);
6263 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6265 i = PTR2IV(SvRV(sv));
6270 /* Unlike sv_inc we don't have to worry about string-never-numbers
6271 and keeping them magic. But we mustn't warn on punting */
6272 flags = SvFLAGS(sv);
6273 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6274 /* It's publicly an integer, or privately an integer-not-float */
6275 #ifdef PERL_PRESERVE_IVUV
6279 if (SvUVX(sv) == 0) {
6280 (void)SvIOK_only(sv);
6284 (void)SvIOK_only_UV(sv);
6285 SvUV_set(sv, SvUVX(sv) - 1);
6288 if (SvIVX(sv) == IV_MIN)
6289 sv_setnv(sv, (NV)IV_MIN - 1.0);
6291 (void)SvIOK_only(sv);
6292 SvIV_set(sv, SvIVX(sv) - 1);
6297 if (flags & SVp_NOK) {
6298 SvNV_set(sv, SvNVX(sv) - 1.0);
6299 (void)SvNOK_only(sv);
6302 if (!(flags & SVp_POK)) {
6303 if ((flags & SVTYPEMASK) < SVt_PVIV)
6304 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6306 (void)SvIOK_only(sv);
6309 #ifdef PERL_PRESERVE_IVUV
6311 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6312 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6313 /* Need to try really hard to see if it's an integer.
6314 9.22337203685478e+18 is an integer.
6315 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6316 so $a="9.22337203685478e+18"; $a+0; $a--
6317 needs to be the same as $a="9.22337203685478e+18"; $a--
6324 /* sv_2iv *should* have made this an NV */
6325 if (flags & SVp_NOK) {
6326 (void)SvNOK_only(sv);
6327 SvNV_set(sv, SvNVX(sv) - 1.0);
6330 /* I don't think we can get here. Maybe I should assert this
6331 And if we do get here I suspect that sv_setnv will croak. NWC
6333 #if defined(USE_LONG_DOUBLE)
6334 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",
6335 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6337 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6338 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6342 #endif /* PERL_PRESERVE_IVUV */
6343 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6347 =for apidoc sv_mortalcopy
6349 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6350 The new SV is marked as mortal. It will be destroyed "soon", either by an
6351 explicit call to FREETMPS, or by an implicit call at places such as
6352 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6357 /* Make a string that will exist for the duration of the expression
6358 * evaluation. Actually, it may have to last longer than that, but
6359 * hopefully we won't free it until it has been assigned to a
6360 * permanent location. */
6363 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6369 sv_setsv(sv,oldstr);
6371 PL_tmps_stack[++PL_tmps_ix] = sv;
6377 =for apidoc sv_newmortal
6379 Creates a new null SV which is mortal. The reference count of the SV is
6380 set to 1. It will be destroyed "soon", either by an explicit call to
6381 FREETMPS, or by an implicit call at places such as statement boundaries.
6382 See also C<sv_mortalcopy> and C<sv_2mortal>.
6388 Perl_sv_newmortal(pTHX)
6394 SvFLAGS(sv) = SVs_TEMP;
6396 PL_tmps_stack[++PL_tmps_ix] = sv;
6401 =for apidoc sv_2mortal
6403 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6404 by an explicit call to FREETMPS, or by an implicit call at places such as
6405 statement boundaries. SvTEMP() is turned on which means that the SV's
6406 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6407 and C<sv_mortalcopy>.
6413 Perl_sv_2mortal(pTHX_ register SV *sv)
6418 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6421 PL_tmps_stack[++PL_tmps_ix] = sv;
6429 Creates a new SV and copies a string into it. The reference count for the
6430 SV is set to 1. If C<len> is zero, Perl will compute the length using
6431 strlen(). For efficiency, consider using C<newSVpvn> instead.
6437 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6443 sv_setpvn(sv,s,len ? len : strlen(s));
6448 =for apidoc newSVpvn
6450 Creates a new SV and copies a string into it. The reference count for the
6451 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6452 string. You are responsible for ensuring that the source string is at least
6453 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6459 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6465 sv_setpvn(sv,s,len);
6471 =for apidoc newSVhek
6473 Creates a new SV from the hash key structure. It will generate scalars that
6474 point to the shared string table where possible. Returns a new (undefined)
6475 SV if the hek is NULL.
6481 Perl_newSVhek(pTHX_ const HEK *hek)
6491 if (HEK_LEN(hek) == HEf_SVKEY) {
6492 return newSVsv(*(SV**)HEK_KEY(hek));
6494 const int flags = HEK_FLAGS(hek);
6495 if (flags & HVhek_WASUTF8) {
6497 Andreas would like keys he put in as utf8 to come back as utf8
6499 STRLEN utf8_len = HEK_LEN(hek);
6500 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6501 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6504 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6506 } else if (flags & HVhek_REHASH) {
6507 /* We don't have a pointer to the hv, so we have to replicate the
6508 flag into every HEK. This hv is using custom a hasing
6509 algorithm. Hence we can't return a shared string scalar, as
6510 that would contain the (wrong) hash value, and might get passed
6511 into an hv routine with a regular hash */
6513 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6518 /* This will be overwhelminly the most common case. */
6519 return newSVpvn_share(HEK_KEY(hek),
6520 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6526 =for apidoc newSVpvn_share
6528 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6529 table. If the string does not already exist in the table, it is created
6530 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6531 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6532 otherwise the hash is computed. The idea here is that as the string table
6533 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6534 hash lookup will avoid string compare.
6540 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6544 bool is_utf8 = FALSE;
6546 STRLEN tmplen = -len;
6548 /* See the note in hv.c:hv_fetch() --jhi */
6549 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6553 PERL_HASH(hash, src, len);
6555 sv_upgrade(sv, SVt_PV);
6556 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6568 #if defined(PERL_IMPLICIT_CONTEXT)
6570 /* pTHX_ magic can't cope with varargs, so this is a no-context
6571 * version of the main function, (which may itself be aliased to us).
6572 * Don't access this version directly.
6576 Perl_newSVpvf_nocontext(const char* pat, ...)
6581 va_start(args, pat);
6582 sv = vnewSVpvf(pat, &args);
6589 =for apidoc newSVpvf
6591 Creates a new SV and initializes it with the string formatted like
6598 Perl_newSVpvf(pTHX_ const char* pat, ...)
6602 va_start(args, pat);
6603 sv = vnewSVpvf(pat, &args);
6608 /* backend for newSVpvf() and newSVpvf_nocontext() */
6611 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6616 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6623 Creates a new SV and copies a floating point value into it.
6624 The reference count for the SV is set to 1.
6630 Perl_newSVnv(pTHX_ NV n)
6643 Creates a new SV and copies an integer into it. The reference count for the
6650 Perl_newSViv(pTHX_ IV i)
6663 Creates a new SV and copies an unsigned integer into it.
6664 The reference count for the SV is set to 1.
6670 Perl_newSVuv(pTHX_ UV u)
6681 =for apidoc newRV_noinc
6683 Creates an RV wrapper for an SV. The reference count for the original
6684 SV is B<not> incremented.
6690 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6696 sv_upgrade(sv, SVt_RV);
6698 SvRV_set(sv, tmpRef);
6703 /* newRV_inc is the official function name to use now.
6704 * newRV_inc is in fact #defined to newRV in sv.h
6708 Perl_newRV(pTHX_ SV *tmpRef)
6711 return newRV_noinc(SvREFCNT_inc(tmpRef));
6717 Creates a new SV which is an exact duplicate of the original SV.
6724 Perl_newSVsv(pTHX_ register SV *old)
6731 if (SvTYPE(old) == SVTYPEMASK) {
6732 if (ckWARN_d(WARN_INTERNAL))
6733 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6737 /* SV_GMAGIC is the default for sv_setv()
6738 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6739 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6740 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6745 =for apidoc sv_reset
6747 Underlying implementation for the C<reset> Perl function.
6748 Note that the perl-level function is vaguely deprecated.
6754 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6757 char todo[PERL_UCHAR_MAX+1];
6762 if (!*s) { /* reset ?? searches */
6763 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6765 PMOP *pm = (PMOP *) mg->mg_obj;
6767 pm->op_pmdynflags &= ~PMdf_USED;
6774 /* reset variables */
6776 if (!HvARRAY(stash))
6779 Zero(todo, 256, char);
6782 I32 i = (unsigned char)*s;
6786 max = (unsigned char)*s++;
6787 for ( ; i <= max; i++) {
6790 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6792 for (entry = HvARRAY(stash)[i];
6794 entry = HeNEXT(entry))
6799 if (!todo[(U8)*HeKEY(entry)])
6801 gv = (GV*)HeVAL(entry);
6804 if (SvTHINKFIRST(sv)) {
6805 if (!SvREADONLY(sv) && SvROK(sv))
6807 /* XXX Is this continue a bug? Why should THINKFIRST
6808 exempt us from resetting arrays and hashes? */
6812 if (SvTYPE(sv) >= SVt_PV) {
6814 if (SvPVX_const(sv) != Nullch)
6822 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6824 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6827 # if defined(USE_ENVIRON_ARRAY)
6830 # endif /* USE_ENVIRON_ARRAY */
6841 Using various gambits, try to get an IO from an SV: the IO slot if its a
6842 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6843 named after the PV if we're a string.
6849 Perl_sv_2io(pTHX_ SV *sv)
6854 switch (SvTYPE(sv)) {
6862 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6866 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6868 return sv_2io(SvRV(sv));
6869 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6875 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6884 Using various gambits, try to get a CV from an SV; in addition, try if
6885 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6886 The flags in C<lref> are passed to sv_fetchsv.
6892 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6899 return *st = NULL, *gvp = Nullgv, Nullcv;
6900 switch (SvTYPE(sv)) {
6919 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6920 tryAMAGICunDEREF(to_cv);
6923 if (SvTYPE(sv) == SVt_PVCV) {
6932 Perl_croak(aTHX_ "Not a subroutine reference");
6937 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6943 /* Some flags to gv_fetchsv mean don't really create the GV */
6944 if (SvTYPE(gv) != SVt_PVGV) {
6950 if (lref && !GvCVu(gv)) {
6953 tmpsv = NEWSV(704,0);
6954 gv_efullname3(tmpsv, gv, Nullch);
6955 /* XXX this is probably not what they think they're getting.
6956 * It has the same effect as "sub name;", i.e. just a forward
6958 newSUB(start_subparse(FALSE, 0),
6959 newSVOP(OP_CONST, 0, tmpsv),
6964 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6974 Returns true if the SV has a true value by Perl's rules.
6975 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6976 instead use an in-line version.
6982 Perl_sv_true(pTHX_ register SV *sv)
6987 register const XPV* const tXpv = (XPV*)SvANY(sv);
6989 (tXpv->xpv_cur > 1 ||
6990 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6997 return SvIVX(sv) != 0;
7000 return SvNVX(sv) != 0.0;
7002 return sv_2bool(sv);
7008 =for apidoc sv_pvn_force
7010 Get a sensible string out of the SV somehow.
7011 A private implementation of the C<SvPV_force> macro for compilers which
7012 can't cope with complex macro expressions. Always use the macro instead.
7014 =for apidoc sv_pvn_force_flags
7016 Get a sensible string out of the SV somehow.
7017 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7018 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7019 implemented in terms of this function.
7020 You normally want to use the various wrapper macros instead: see
7021 C<SvPV_force> and C<SvPV_force_nomg>
7027 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7030 if (SvTHINKFIRST(sv) && !SvROK(sv))
7031 sv_force_normal_flags(sv, 0);
7041 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7042 const char * const ref = sv_reftype(sv,0);
7044 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7045 ref, OP_NAME(PL_op));
7047 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7049 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7050 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7052 s = sv_2pv_flags(sv, &len, flags);
7056 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7059 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7060 SvGROW(sv, len + 1);
7061 Move(s,SvPVX(sv),len,char);
7066 SvPOK_on(sv); /* validate pointer */
7068 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7069 PTR2UV(sv),SvPVX_const(sv)));
7072 return SvPVX_mutable(sv);
7076 =for apidoc sv_pvbyten_force
7078 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7084 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7086 sv_pvn_force(sv,lp);
7087 sv_utf8_downgrade(sv,0);
7093 =for apidoc sv_pvutf8n_force
7095 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7101 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7103 sv_pvn_force(sv,lp);
7104 sv_utf8_upgrade(sv);
7110 =for apidoc sv_reftype
7112 Returns a string describing what the SV is a reference to.
7118 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7120 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7121 inside return suggests a const propagation bug in g++. */
7122 if (ob && SvOBJECT(sv)) {
7123 char * const name = HvNAME_get(SvSTASH(sv));
7124 return name ? name : (char *) "__ANON__";
7127 switch (SvTYPE(sv)) {
7144 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7145 /* tied lvalues should appear to be
7146 * scalars for backwards compatitbility */
7147 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7148 ? "SCALAR" : "LVALUE");
7149 case SVt_PVAV: return "ARRAY";
7150 case SVt_PVHV: return "HASH";
7151 case SVt_PVCV: return "CODE";
7152 case SVt_PVGV: return "GLOB";
7153 case SVt_PVFM: return "FORMAT";
7154 case SVt_PVIO: return "IO";
7155 default: return "UNKNOWN";
7161 =for apidoc sv_isobject
7163 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7164 object. If the SV is not an RV, or if the object is not blessed, then this
7171 Perl_sv_isobject(pTHX_ SV *sv)
7187 Returns a boolean indicating whether the SV is blessed into the specified
7188 class. This does not check for subtypes; use C<sv_derived_from> to verify
7189 an inheritance relationship.
7195 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7206 hvname = HvNAME_get(SvSTASH(sv));
7210 return strEQ(hvname, name);
7216 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7217 it will be upgraded to one. If C<classname> is non-null then the new SV will
7218 be blessed in the specified package. The new SV is returned and its
7219 reference count is 1.
7225 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7232 SV_CHECK_THINKFIRST_COW_DROP(rv);
7235 if (SvTYPE(rv) >= SVt_PVMG) {
7236 const U32 refcnt = SvREFCNT(rv);
7240 SvREFCNT(rv) = refcnt;
7243 if (SvTYPE(rv) < SVt_RV)
7244 sv_upgrade(rv, SVt_RV);
7245 else if (SvTYPE(rv) > SVt_RV) {
7256 HV* const stash = gv_stashpv(classname, TRUE);
7257 (void)sv_bless(rv, stash);
7263 =for apidoc sv_setref_pv
7265 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7266 argument will be upgraded to an RV. That RV will be modified to point to
7267 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7268 into the SV. The C<classname> argument indicates the package for the
7269 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7270 will have a reference count of 1, and the RV will be returned.
7272 Do not use with other Perl types such as HV, AV, SV, CV, because those
7273 objects will become corrupted by the pointer copy process.
7275 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7281 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7285 sv_setsv(rv, &PL_sv_undef);
7289 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7294 =for apidoc sv_setref_iv
7296 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7297 argument will be upgraded to an RV. That RV will be modified to point to
7298 the new SV. The C<classname> argument indicates the package for the
7299 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7300 will have a reference count of 1, and the RV will be returned.
7306 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7308 sv_setiv(newSVrv(rv,classname), iv);
7313 =for apidoc sv_setref_uv
7315 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7316 argument will be upgraded to an RV. That RV will be modified to point to
7317 the new SV. The C<classname> argument indicates the package for the
7318 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7319 will have a reference count of 1, and the RV will be returned.
7325 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7327 sv_setuv(newSVrv(rv,classname), uv);
7332 =for apidoc sv_setref_nv
7334 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7335 argument will be upgraded to an RV. That RV will be modified to point to
7336 the new SV. The C<classname> argument indicates the package for the
7337 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7338 will have a reference count of 1, and the RV will be returned.
7344 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7346 sv_setnv(newSVrv(rv,classname), nv);
7351 =for apidoc sv_setref_pvn
7353 Copies a string into a new SV, optionally blessing the SV. The length of the
7354 string must be specified with C<n>. The C<rv> argument will be upgraded to
7355 an RV. That RV will be modified to point to the new SV. The C<classname>
7356 argument indicates the package for the blessing. Set C<classname> to
7357 C<Nullch> to avoid the blessing. The new SV will have a reference count
7358 of 1, and the RV will be returned.
7360 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7366 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7368 sv_setpvn(newSVrv(rv,classname), pv, n);
7373 =for apidoc sv_bless
7375 Blesses an SV into a specified package. The SV must be an RV. The package
7376 must be designated by its stash (see C<gv_stashpv()>). The reference count
7377 of the SV is unaffected.
7383 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7388 Perl_croak(aTHX_ "Can't bless non-reference value");
7390 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7391 if (SvREADONLY(tmpRef))
7392 Perl_croak(aTHX_ PL_no_modify);
7393 if (SvOBJECT(tmpRef)) {
7394 if (SvTYPE(tmpRef) != SVt_PVIO)
7396 SvREFCNT_dec(SvSTASH(tmpRef));
7399 SvOBJECT_on(tmpRef);
7400 if (SvTYPE(tmpRef) != SVt_PVIO)
7402 SvUPGRADE(tmpRef, SVt_PVMG);
7403 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7410 if(SvSMAGICAL(tmpRef))
7411 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7419 /* Downgrades a PVGV to a PVMG.
7423 S_sv_unglob(pTHX_ SV *sv)
7428 assert(SvTYPE(sv) == SVt_PVGV);
7433 sv_del_backref((SV*)GvSTASH(sv), sv);
7436 sv_unmagic(sv, PERL_MAGIC_glob);
7437 Safefree(GvNAME(sv));
7440 /* need to keep SvANY(sv) in the right arena */
7441 xpvmg = new_XPVMG();
7442 StructCopy(SvANY(sv), xpvmg, XPVMG);
7443 del_XPVGV(SvANY(sv));
7446 SvFLAGS(sv) &= ~SVTYPEMASK;
7447 SvFLAGS(sv) |= SVt_PVMG;
7451 =for apidoc sv_unref_flags
7453 Unsets the RV status of the SV, and decrements the reference count of
7454 whatever was being referenced by the RV. This can almost be thought of
7455 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7456 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7457 (otherwise the decrementing is conditional on the reference count being
7458 different from one or the reference being a readonly SV).
7465 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7467 SV* const target = SvRV(ref);
7469 if (SvWEAKREF(ref)) {
7470 sv_del_backref(target, ref);
7472 SvRV_set(ref, NULL);
7475 SvRV_set(ref, NULL);
7477 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7478 assigned to as BEGIN {$a = \"Foo"} will fail. */
7479 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7480 SvREFCNT_dec(target);
7481 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7482 sv_2mortal(target); /* Schedule for freeing later */
7486 =for apidoc sv_untaint
7488 Untaint an SV. Use C<SvTAINTED_off> instead.
7493 Perl_sv_untaint(pTHX_ SV *sv)
7495 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7496 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7503 =for apidoc sv_tainted
7505 Test an SV for taintedness. Use C<SvTAINTED> instead.
7510 Perl_sv_tainted(pTHX_ SV *sv)
7512 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7513 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7514 if (mg && (mg->mg_len & 1) )
7521 =for apidoc sv_setpviv
7523 Copies an integer into the given SV, also updating its string value.
7524 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7530 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7532 char buf[TYPE_CHARS(UV)];
7534 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7536 sv_setpvn(sv, ptr, ebuf - ptr);
7540 =for apidoc sv_setpviv_mg
7542 Like C<sv_setpviv>, but also handles 'set' magic.
7548 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7554 #if defined(PERL_IMPLICIT_CONTEXT)
7556 /* pTHX_ magic can't cope with varargs, so this is a no-context
7557 * version of the main function, (which may itself be aliased to us).
7558 * Don't access this version directly.
7562 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7566 va_start(args, pat);
7567 sv_vsetpvf(sv, pat, &args);
7571 /* pTHX_ magic can't cope with varargs, so this is a no-context
7572 * version of the main function, (which may itself be aliased to us).
7573 * Don't access this version directly.
7577 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7581 va_start(args, pat);
7582 sv_vsetpvf_mg(sv, pat, &args);
7588 =for apidoc sv_setpvf
7590 Works like C<sv_catpvf> but copies the text into the SV instead of
7591 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7597 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7600 va_start(args, pat);
7601 sv_vsetpvf(sv, pat, &args);
7606 =for apidoc sv_vsetpvf
7608 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7609 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7611 Usually used via its frontend C<sv_setpvf>.
7617 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7619 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7623 =for apidoc sv_setpvf_mg
7625 Like C<sv_setpvf>, but also handles 'set' magic.
7631 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7634 va_start(args, pat);
7635 sv_vsetpvf_mg(sv, pat, &args);
7640 =for apidoc sv_vsetpvf_mg
7642 Like C<sv_vsetpvf>, but also handles 'set' magic.
7644 Usually used via its frontend C<sv_setpvf_mg>.
7650 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7652 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7656 #if defined(PERL_IMPLICIT_CONTEXT)
7658 /* pTHX_ magic can't cope with varargs, so this is a no-context
7659 * version of the main function, (which may itself be aliased to us).
7660 * Don't access this version directly.
7664 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7668 va_start(args, pat);
7669 sv_vcatpvf(sv, pat, &args);
7673 /* pTHX_ magic can't cope with varargs, so this is a no-context
7674 * version of the main function, (which may itself be aliased to us).
7675 * Don't access this version directly.
7679 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7683 va_start(args, pat);
7684 sv_vcatpvf_mg(sv, pat, &args);
7690 =for apidoc sv_catpvf
7692 Processes its arguments like C<sprintf> and appends the formatted
7693 output to an SV. If the appended data contains "wide" characters
7694 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7695 and characters >255 formatted with %c), the original SV might get
7696 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7697 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7698 valid UTF-8; if the original SV was bytes, the pattern should be too.
7703 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7706 va_start(args, pat);
7707 sv_vcatpvf(sv, pat, &args);
7712 =for apidoc sv_vcatpvf
7714 Processes its arguments like C<vsprintf> and appends the formatted output
7715 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7717 Usually used via its frontend C<sv_catpvf>.
7723 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7725 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7729 =for apidoc sv_catpvf_mg
7731 Like C<sv_catpvf>, but also handles 'set' magic.
7737 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7740 va_start(args, pat);
7741 sv_vcatpvf_mg(sv, pat, &args);
7746 =for apidoc sv_vcatpvf_mg
7748 Like C<sv_vcatpvf>, but also handles 'set' magic.
7750 Usually used via its frontend C<sv_catpvf_mg>.
7756 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7758 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7763 =for apidoc sv_vsetpvfn
7765 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7768 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7774 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7776 sv_setpvn(sv, "", 0);
7777 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7781 S_expect_number(pTHX_ char** pattern)
7785 switch (**pattern) {
7786 case '1': case '2': case '3':
7787 case '4': case '5': case '6':
7788 case '7': case '8': case '9':
7789 var = *(*pattern)++ - '0';
7790 while (isDIGIT(**pattern)) {
7791 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7793 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7801 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7803 const int neg = nv < 0;
7812 if (uv & 1 && uv == nv)
7813 uv--; /* Round to even */
7815 const unsigned dig = uv % 10;
7828 =for apidoc sv_vcatpvfn
7830 Processes its arguments like C<vsprintf> and appends the formatted output
7831 to an SV. Uses an array of SVs if the C style variable argument list is
7832 missing (NULL). When running with taint checks enabled, indicates via
7833 C<maybe_tainted> if results are untrustworthy (often due to the use of
7836 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7842 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7843 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7844 vec_utf8 = DO_UTF8(vecsv);
7846 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7849 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7857 static const char nullstr[] = "(null)";
7859 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7860 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7862 /* Times 4: a decimal digit takes more than 3 binary digits.
7863 * NV_DIG: mantissa takes than many decimal digits.
7864 * Plus 32: Playing safe. */
7865 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7866 /* large enough for "%#.#f" --chip */
7867 /* what about long double NVs? --jhi */
7869 PERL_UNUSED_ARG(maybe_tainted);
7871 /* no matter what, this is a string now */
7872 (void)SvPV_force(sv, origlen);
7874 /* special-case "", "%s", and "%-p" (SVf - see below) */
7877 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7879 const char * const s = va_arg(*args, char*);
7880 sv_catpv(sv, s ? s : nullstr);
7882 else if (svix < svmax) {
7883 sv_catsv(sv, *svargs);
7887 if (args && patlen == 3 && pat[0] == '%' &&
7888 pat[1] == '-' && pat[2] == 'p') {
7889 argsv = va_arg(*args, SV*);
7890 sv_catsv(sv, argsv);
7894 #ifndef USE_LONG_DOUBLE
7895 /* special-case "%.<number>[gf]" */
7896 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7897 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7898 unsigned digits = 0;
7902 while (*pp >= '0' && *pp <= '9')
7903 digits = 10 * digits + (*pp++ - '0');
7904 if (pp - pat == (int)patlen - 1) {
7912 /* Add check for digits != 0 because it seems that some
7913 gconverts are buggy in this case, and we don't yet have
7914 a Configure test for this. */
7915 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7916 /* 0, point, slack */
7917 Gconvert(nv, (int)digits, 0, ebuf);
7919 if (*ebuf) /* May return an empty string for digits==0 */
7922 } else if (!digits) {
7925 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7926 sv_catpvn(sv, p, l);
7932 #endif /* !USE_LONG_DOUBLE */
7934 if (!args && svix < svmax && DO_UTF8(*svargs))
7937 patend = (char*)pat + patlen;
7938 for (p = (char*)pat; p < patend; p = q) {
7941 bool vectorize = FALSE;
7942 bool vectorarg = FALSE;
7943 bool vec_utf8 = FALSE;
7949 bool has_precis = FALSE;
7951 const I32 osvix = svix;
7952 bool is_utf8 = FALSE; /* is this item utf8? */
7953 #ifdef HAS_LDBL_SPRINTF_BUG
7954 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7955 with sfio - Allen <allens@cpan.org> */
7956 bool fix_ldbl_sprintf_bug = FALSE;
7960 U8 utf8buf[UTF8_MAXBYTES+1];
7961 STRLEN esignlen = 0;
7963 const char *eptr = Nullch;
7966 const U8 *vecstr = Null(U8*);
7973 /* we need a long double target in case HAS_LONG_DOUBLE but
7976 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7984 const char *dotstr = ".";
7985 STRLEN dotstrlen = 1;
7986 I32 efix = 0; /* explicit format parameter index */
7987 I32 ewix = 0; /* explicit width index */
7988 I32 epix = 0; /* explicit precision index */
7989 I32 evix = 0; /* explicit vector index */
7990 bool asterisk = FALSE;
7992 /* echo everything up to the next format specification */
7993 for (q = p; q < patend && *q != '%'; ++q) ;
7995 if (has_utf8 && !pat_utf8)
7996 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7998 sv_catpvn(sv, p, q - p);
8005 We allow format specification elements in this order:
8006 \d+\$ explicit format parameter index
8008 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8009 0 flag (as above): repeated to allow "v02"
8010 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8011 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8013 [%bcdefginopsuxDFOUX] format (mandatory)
8018 As of perl5.9.3, printf format checking is on by default.
8019 Internally, perl uses %p formats to provide an escape to
8020 some extended formatting. This block deals with those
8021 extensions: if it does not match, (char*)q is reset and
8022 the normal format processing code is used.
8024 Currently defined extensions are:
8025 %p include pointer address (standard)
8026 %-p (SVf) include an SV (previously %_)
8027 %-<num>p include an SV with precision <num>
8028 %1p (VDf) include a v-string (as %vd)
8029 %<num>p reserved for future extensions
8031 Robin Barker 2005-07-14
8038 n = expect_number(&q);
8045 argsv = va_arg(*args, SV*);
8046 eptr = SvPVx_const(argsv, elen);
8052 else if (n == vdNUMBER) { /* VDf */
8059 if (ckWARN_d(WARN_INTERNAL))
8060 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8061 "internal %%<num>p might conflict with future printf extensions");
8067 if ( (width = expect_number(&q)) ) {
8108 if ( (ewix = expect_number(&q)) )
8117 if ((vectorarg = asterisk)) {
8130 width = expect_number(&q);
8136 vecsv = va_arg(*args, SV*);
8138 vecsv = (evix > 0 && evix <= svmax)
8139 ? svargs[evix-1] : &PL_sv_undef;
8141 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8143 dotstr = SvPV_const(vecsv, dotstrlen);
8144 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8145 bad with tied or overloaded values that return UTF8. */
8148 else if (has_utf8) {
8149 vecsv = sv_mortalcopy(vecsv);
8150 sv_utf8_upgrade(vecsv);
8151 dotstr = SvPV_const(vecsv, dotstrlen);
8158 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8159 vecsv = svargs[efix ? efix-1 : svix++];
8160 vecstr = (U8*)SvPV_const(vecsv,veclen);
8161 vec_utf8 = DO_UTF8(vecsv);
8163 /* if this is a version object, we need to convert
8164 * back into v-string notation and then let the
8165 * vectorize happen normally
8167 if (sv_derived_from(vecsv, "version")) {
8168 char *version = savesvpv(vecsv);
8169 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8170 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8171 "vector argument not supported with alpha versions");
8174 vecsv = sv_newmortal();
8175 /* scan_vstring is expected to be called during
8176 * tokenization, so we need to fake up the end
8177 * of the buffer for it
8179 PL_bufend = version + veclen;
8180 scan_vstring(version, vecsv);
8181 vecstr = (U8*)SvPV_const(vecsv, veclen);
8182 vec_utf8 = DO_UTF8(vecsv);
8194 i = va_arg(*args, int);
8196 i = (ewix ? ewix <= svmax : svix < svmax) ?
8197 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8199 width = (i < 0) ? -i : i;
8209 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8211 /* XXX: todo, support specified precision parameter */
8215 i = va_arg(*args, int);
8217 i = (ewix ? ewix <= svmax : svix < svmax)
8218 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8219 precis = (i < 0) ? 0 : i;
8224 precis = precis * 10 + (*q++ - '0');
8233 case 'I': /* Ix, I32x, and I64x */
8235 if (q[1] == '6' && q[2] == '4') {
8241 if (q[1] == '3' && q[2] == '2') {
8251 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8262 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8263 if (*(q + 1) == 'l') { /* lld, llf */
8289 if (!vectorize && !args) {
8291 const I32 i = efix-1;
8292 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8294 argsv = (svix >= 0 && svix < svmax)
8295 ? svargs[svix++] : &PL_sv_undef;
8306 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8308 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8310 eptr = (char*)utf8buf;
8311 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8325 eptr = va_arg(*args, char*);
8327 #ifdef MACOS_TRADITIONAL
8328 /* On MacOS, %#s format is used for Pascal strings */
8333 elen = strlen(eptr);
8335 eptr = (char *)nullstr;
8336 elen = sizeof nullstr - 1;
8340 eptr = SvPVx_const(argsv, elen);
8341 if (DO_UTF8(argsv)) {
8342 if (has_precis && precis < elen) {
8344 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8347 if (width) { /* fudge width (can't fudge elen) */
8348 width += elen - sv_len_utf8(argsv);
8355 if (has_precis && elen > precis)
8362 if (alt || vectorize)
8364 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8385 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8394 esignbuf[esignlen++] = plus;
8398 case 'h': iv = (short)va_arg(*args, int); break;
8399 case 'l': iv = va_arg(*args, long); break;
8400 case 'V': iv = va_arg(*args, IV); break;
8401 default: iv = va_arg(*args, int); break;
8403 case 'q': iv = va_arg(*args, Quad_t); break;
8408 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8410 case 'h': iv = (short)tiv; break;
8411 case 'l': iv = (long)tiv; break;
8413 default: iv = tiv; break;
8415 case 'q': iv = (Quad_t)tiv; break;
8419 if ( !vectorize ) /* we already set uv above */
8424 esignbuf[esignlen++] = plus;
8428 esignbuf[esignlen++] = '-';
8471 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8482 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8483 case 'l': uv = va_arg(*args, unsigned long); break;
8484 case 'V': uv = va_arg(*args, UV); break;
8485 default: uv = va_arg(*args, unsigned); break;
8487 case 'q': uv = va_arg(*args, Uquad_t); break;
8492 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8494 case 'h': uv = (unsigned short)tuv; break;
8495 case 'l': uv = (unsigned long)tuv; break;
8497 default: uv = tuv; break;
8499 case 'q': uv = (Uquad_t)tuv; break;
8506 char *ptr = ebuf + sizeof ebuf;
8512 p = (char*)((c == 'X')
8513 ? "0123456789ABCDEF" : "0123456789abcdef");
8519 esignbuf[esignlen++] = '0';
8520 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8528 if (alt && *ptr != '0')
8539 esignbuf[esignlen++] = '0';
8540 esignbuf[esignlen++] = 'b';
8543 default: /* it had better be ten or less */
8547 } while (uv /= base);
8550 elen = (ebuf + sizeof ebuf) - ptr;
8554 zeros = precis - elen;
8555 else if (precis == 0 && elen == 1 && *eptr == '0')
8561 /* FLOATING POINT */
8564 c = 'f'; /* maybe %F isn't supported here */
8572 /* This is evil, but floating point is even more evil */
8574 /* for SV-style calling, we can only get NV
8575 for C-style calling, we assume %f is double;
8576 for simplicity we allow any of %Lf, %llf, %qf for long double
8580 #if defined(USE_LONG_DOUBLE)
8584 /* [perl #20339] - we should accept and ignore %lf rather than die */
8588 #if defined(USE_LONG_DOUBLE)
8589 intsize = args ? 0 : 'q';
8593 #if defined(HAS_LONG_DOUBLE)
8602 /* now we need (long double) if intsize == 'q', else (double) */
8604 #if LONG_DOUBLESIZE > DOUBLESIZE
8606 va_arg(*args, long double) :
8607 va_arg(*args, double)
8609 va_arg(*args, double)
8614 if (c != 'e' && c != 'E') {
8616 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8617 will cast our (long double) to (double) */
8618 (void)Perl_frexp(nv, &i);
8619 if (i == PERL_INT_MIN)
8620 Perl_die(aTHX_ "panic: frexp");
8622 need = BIT_DIGITS(i);
8624 need += has_precis ? precis : 6; /* known default */
8629 #ifdef HAS_LDBL_SPRINTF_BUG
8630 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8631 with sfio - Allen <allens@cpan.org> */
8634 # define MY_DBL_MAX DBL_MAX
8635 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8636 # if DOUBLESIZE >= 8
8637 # define MY_DBL_MAX 1.7976931348623157E+308L
8639 # define MY_DBL_MAX 3.40282347E+38L
8643 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8644 # define MY_DBL_MAX_BUG 1L
8646 # define MY_DBL_MAX_BUG MY_DBL_MAX
8650 # define MY_DBL_MIN DBL_MIN
8651 # else /* XXX guessing! -Allen */
8652 # if DOUBLESIZE >= 8
8653 # define MY_DBL_MIN 2.2250738585072014E-308L
8655 # define MY_DBL_MIN 1.17549435E-38L
8659 if ((intsize == 'q') && (c == 'f') &&
8660 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8662 /* it's going to be short enough that
8663 * long double precision is not needed */
8665 if ((nv <= 0L) && (nv >= -0L))
8666 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8668 /* would use Perl_fp_class as a double-check but not
8669 * functional on IRIX - see perl.h comments */
8671 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8672 /* It's within the range that a double can represent */
8673 #if defined(DBL_MAX) && !defined(DBL_MIN)
8674 if ((nv >= ((long double)1/DBL_MAX)) ||
8675 (nv <= (-(long double)1/DBL_MAX)))
8677 fix_ldbl_sprintf_bug = TRUE;
8680 if (fix_ldbl_sprintf_bug == TRUE) {
8690 # undef MY_DBL_MAX_BUG
8693 #endif /* HAS_LDBL_SPRINTF_BUG */
8695 need += 20; /* fudge factor */
8696 if (PL_efloatsize < need) {
8697 Safefree(PL_efloatbuf);
8698 PL_efloatsize = need + 20; /* more fudge */
8699 Newx(PL_efloatbuf, PL_efloatsize, char);
8700 PL_efloatbuf[0] = '\0';
8703 if ( !(width || left || plus || alt) && fill != '0'
8704 && has_precis && intsize != 'q' ) { /* Shortcuts */
8705 /* See earlier comment about buggy Gconvert when digits,
8707 if ( c == 'g' && precis) {
8708 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8709 /* May return an empty string for digits==0 */
8710 if (*PL_efloatbuf) {
8711 elen = strlen(PL_efloatbuf);
8712 goto float_converted;
8714 } else if ( c == 'f' && !precis) {
8715 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8720 char *ptr = ebuf + sizeof ebuf;
8723 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8724 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8725 if (intsize == 'q') {
8726 /* Copy the one or more characters in a long double
8727 * format before the 'base' ([efgEFG]) character to
8728 * the format string. */
8729 static char const prifldbl[] = PERL_PRIfldbl;
8730 char const *p = prifldbl + sizeof(prifldbl) - 3;
8731 while (p >= prifldbl) { *--ptr = *p--; }
8736 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8741 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8753 /* No taint. Otherwise we are in the strange situation
8754 * where printf() taints but print($float) doesn't.
8756 #if defined(HAS_LONG_DOUBLE)
8757 elen = ((intsize == 'q')
8758 ? my_sprintf(PL_efloatbuf, ptr, nv)
8759 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8761 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8765 eptr = PL_efloatbuf;
8773 i = SvCUR(sv) - origlen;
8776 case 'h': *(va_arg(*args, short*)) = i; break;
8777 default: *(va_arg(*args, int*)) = i; break;
8778 case 'l': *(va_arg(*args, long*)) = i; break;
8779 case 'V': *(va_arg(*args, IV*)) = i; break;
8781 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8786 sv_setuv_mg(argsv, (UV)i);
8787 continue; /* not "break" */
8794 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8795 && ckWARN(WARN_PRINTF))
8797 SV * const msg = sv_newmortal();
8798 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8799 (PL_op->op_type == OP_PRTF) ? "" : "s");
8802 Perl_sv_catpvf(aTHX_ msg,
8803 "\"%%%c\"", c & 0xFF);
8805 Perl_sv_catpvf(aTHX_ msg,
8806 "\"%%\\%03"UVof"\"",
8809 sv_catpvs(msg, "end of string");
8810 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8813 /* output mangled stuff ... */
8819 /* ... right here, because formatting flags should not apply */
8820 SvGROW(sv, SvCUR(sv) + elen + 1);
8822 Copy(eptr, p, elen, char);
8825 SvCUR_set(sv, p - SvPVX_const(sv));
8827 continue; /* not "break" */
8830 /* calculate width before utf8_upgrade changes it */
8831 have = esignlen + zeros + elen;
8833 Perl_croak_nocontext(PL_memory_wrap);
8835 if (is_utf8 != has_utf8) {
8838 sv_utf8_upgrade(sv);
8841 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8842 sv_utf8_upgrade(nsv);
8843 eptr = SvPVX_const(nsv);
8846 SvGROW(sv, SvCUR(sv) + elen + 1);
8851 need = (have > width ? have : width);
8854 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8855 Perl_croak_nocontext(PL_memory_wrap);
8856 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8858 if (esignlen && fill == '0') {
8860 for (i = 0; i < (int)esignlen; i++)
8864 memset(p, fill, gap);
8867 if (esignlen && fill != '0') {
8869 for (i = 0; i < (int)esignlen; i++)
8874 for (i = zeros; i; i--)
8878 Copy(eptr, p, elen, char);
8882 memset(p, ' ', gap);
8887 Copy(dotstr, p, dotstrlen, char);
8891 vectorize = FALSE; /* done iterating over vecstr */
8898 SvCUR_set(sv, p - SvPVX_const(sv));
8906 /* =========================================================================
8908 =head1 Cloning an interpreter
8910 All the macros and functions in this section are for the private use of
8911 the main function, perl_clone().
8913 The foo_dup() functions make an exact copy of an existing foo thinngy.
8914 During the course of a cloning, a hash table is used to map old addresses
8915 to new addresses. The table is created and manipulated with the
8916 ptr_table_* functions.
8920 ============================================================================*/
8923 #if defined(USE_ITHREADS)
8925 #ifndef GpREFCNT_inc
8926 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8930 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8931 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8932 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8933 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8934 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8935 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8936 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8937 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8938 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8939 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8940 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8941 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8942 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8945 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8946 regcomp.c. AMS 20010712 */
8949 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8954 struct reg_substr_datum *s;
8957 return (REGEXP *)NULL;
8959 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8962 len = r->offsets[0];
8963 npar = r->nparens+1;
8965 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8966 Copy(r->program, ret->program, len+1, regnode);
8968 Newx(ret->startp, npar, I32);
8969 Copy(r->startp, ret->startp, npar, I32);
8970 Newx(ret->endp, npar, I32);
8971 Copy(r->startp, ret->startp, npar, I32);
8973 Newx(ret->substrs, 1, struct reg_substr_data);
8974 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8975 s->min_offset = r->substrs->data[i].min_offset;
8976 s->max_offset = r->substrs->data[i].max_offset;
8977 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8978 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8981 ret->regstclass = NULL;
8984 const int count = r->data->count;
8987 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8988 char, struct reg_data);
8989 Newx(d->what, count, U8);
8992 for (i = 0; i < count; i++) {
8993 d->what[i] = r->data->what[i];
8994 switch (d->what[i]) {
8995 /* legal options are one of: sfpont
8996 see also regcomp.h and pregfree() */
8998 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9001 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9004 /* This is cheating. */
9005 Newx(d->data[i], 1, struct regnode_charclass_class);
9006 StructCopy(r->data->data[i], d->data[i],
9007 struct regnode_charclass_class);
9008 ret->regstclass = (regnode*)d->data[i];
9011 /* Compiled op trees are readonly, and can thus be
9012 shared without duplication. */
9014 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9018 d->data[i] = r->data->data[i];
9021 d->data[i] = r->data->data[i];
9023 ((reg_trie_data*)d->data[i])->refcount++;
9027 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9036 Newx(ret->offsets, 2*len+1, U32);
9037 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9039 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9040 ret->refcnt = r->refcnt;
9041 ret->minlen = r->minlen;
9042 ret->prelen = r->prelen;
9043 ret->nparens = r->nparens;
9044 ret->lastparen = r->lastparen;
9045 ret->lastcloseparen = r->lastcloseparen;
9046 ret->reganch = r->reganch;
9048 ret->sublen = r->sublen;
9050 if (RX_MATCH_COPIED(ret))
9051 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9053 ret->subbeg = Nullch;
9054 #ifdef PERL_OLD_COPY_ON_WRITE
9055 ret->saved_copy = Nullsv;
9058 ptr_table_store(PL_ptr_table, r, ret);
9062 /* duplicate a file handle */
9065 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9069 PERL_UNUSED_ARG(type);
9072 return (PerlIO*)NULL;
9074 /* look for it in the table first */
9075 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9079 /* create anew and remember what it is */
9080 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9081 ptr_table_store(PL_ptr_table, fp, ret);
9085 /* duplicate a directory handle */
9088 Perl_dirp_dup(pTHX_ DIR *dp)
9096 /* duplicate a typeglob */
9099 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9104 /* look for it in the table first */
9105 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9109 /* create anew and remember what it is */
9111 ptr_table_store(PL_ptr_table, gp, ret);
9114 ret->gp_refcnt = 0; /* must be before any other dups! */
9115 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9116 ret->gp_io = io_dup_inc(gp->gp_io, param);
9117 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9118 ret->gp_av = av_dup_inc(gp->gp_av, param);
9119 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9120 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9121 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9122 ret->gp_cvgen = gp->gp_cvgen;
9123 ret->gp_line = gp->gp_line;
9124 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9128 /* duplicate a chain of magic */
9131 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9133 MAGIC *mgprev = (MAGIC*)NULL;
9136 return (MAGIC*)NULL;
9137 /* look for it in the table first */
9138 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9142 for (; mg; mg = mg->mg_moremagic) {
9144 Newxz(nmg, 1, MAGIC);
9146 mgprev->mg_moremagic = nmg;
9149 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9150 nmg->mg_private = mg->mg_private;
9151 nmg->mg_type = mg->mg_type;
9152 nmg->mg_flags = mg->mg_flags;
9153 if (mg->mg_type == PERL_MAGIC_qr) {
9154 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9156 else if(mg->mg_type == PERL_MAGIC_backref) {
9157 /* The backref AV has its reference count deliberately bumped by
9159 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9161 else if (mg->mg_type == PERL_MAGIC_symtab) {
9162 nmg->mg_obj = mg->mg_obj;
9165 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9166 ? sv_dup_inc(mg->mg_obj, param)
9167 : sv_dup(mg->mg_obj, param);
9169 nmg->mg_len = mg->mg_len;
9170 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9171 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9172 if (mg->mg_len > 0) {
9173 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9174 if (mg->mg_type == PERL_MAGIC_overload_table &&
9175 AMT_AMAGIC((AMT*)mg->mg_ptr))
9177 const AMT * const amtp = (AMT*)mg->mg_ptr;
9178 AMT * const namtp = (AMT*)nmg->mg_ptr;
9180 for (i = 1; i < NofAMmeth; i++) {
9181 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9185 else if (mg->mg_len == HEf_SVKEY)
9186 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9188 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9189 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9196 /* create a new pointer-mapping table */
9199 Perl_ptr_table_new(pTHX)
9202 Newxz(tbl, 1, PTR_TBL_t);
9205 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9209 #define PTR_TABLE_HASH(ptr) \
9210 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9213 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9214 following define) and at call to new_body_inline made below in
9215 Perl_ptr_table_store()
9218 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9220 /* map an existing pointer using a table */
9222 STATIC PTR_TBL_ENT_t *
9223 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9224 PTR_TBL_ENT_t *tblent;
9225 const UV hash = PTR_TABLE_HASH(sv);
9227 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9228 for (; tblent; tblent = tblent->next) {
9229 if (tblent->oldval == sv)
9236 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9238 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9239 return tblent ? tblent->newval : (void *) 0;
9242 /* add a new entry to a pointer-mapping table */
9245 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9247 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9250 tblent->newval = newsv;
9252 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9254 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9255 tblent->oldval = oldsv;
9256 tblent->newval = newsv;
9257 tblent->next = tbl->tbl_ary[entry];
9258 tbl->tbl_ary[entry] = tblent;
9260 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9261 ptr_table_split(tbl);
9265 /* double the hash bucket size of an existing ptr table */
9268 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9270 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9271 const UV oldsize = tbl->tbl_max + 1;
9272 UV newsize = oldsize * 2;
9275 Renew(ary, newsize, PTR_TBL_ENT_t*);
9276 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9277 tbl->tbl_max = --newsize;
9279 for (i=0; i < oldsize; i++, ary++) {
9280 PTR_TBL_ENT_t **curentp, **entp, *ent;
9283 curentp = ary + oldsize;
9284 for (entp = ary, ent = *ary; ent; ent = *entp) {
9285 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9287 ent->next = *curentp;
9297 /* remove all the entries from a ptr table */
9300 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9302 if (tbl && tbl->tbl_items) {
9303 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9304 UV riter = tbl->tbl_max;
9307 PTR_TBL_ENT_t *entry = array[riter];
9310 PTR_TBL_ENT_t * const oentry = entry;
9311 entry = entry->next;
9320 /* clear and free a ptr table */
9323 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9328 ptr_table_clear(tbl);
9329 Safefree(tbl->tbl_ary);
9335 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9338 SvRV_set(dstr, SvWEAKREF(sstr)
9339 ? sv_dup(SvRV(sstr), param)
9340 : sv_dup_inc(SvRV(sstr), param));
9343 else if (SvPVX_const(sstr)) {
9344 /* Has something there */
9346 /* Normal PV - clone whole allocated space */
9347 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9348 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9349 /* Not that normal - actually sstr is copy on write.
9350 But we are a true, independant SV, so: */
9351 SvREADONLY_off(dstr);
9356 /* Special case - not normally malloced for some reason */
9357 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9358 /* A "shared" PV - clone it as "shared" PV */
9360 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9364 /* Some other special case - random pointer */
9365 SvPV_set(dstr, SvPVX(sstr));
9371 if (SvTYPE(dstr) == SVt_RV)
9372 SvRV_set(dstr, NULL);
9378 /* duplicate an SV of any type (including AV, HV etc) */
9381 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9386 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9388 /* look for it in the table first */
9389 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9393 if(param->flags & CLONEf_JOIN_IN) {
9394 /** We are joining here so we don't want do clone
9395 something that is bad **/
9396 if (SvTYPE(sstr) == SVt_PVHV) {
9397 const char * const hvname = HvNAME_get(sstr);
9399 /** don't clone stashes if they already exist **/
9400 return (SV*)gv_stashpv(hvname,0);
9404 /* create anew and remember what it is */
9407 #ifdef DEBUG_LEAKING_SCALARS
9408 dstr->sv_debug_optype = sstr->sv_debug_optype;
9409 dstr->sv_debug_line = sstr->sv_debug_line;
9410 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9411 dstr->sv_debug_cloned = 1;
9412 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9415 ptr_table_store(PL_ptr_table, sstr, dstr);
9418 SvFLAGS(dstr) = SvFLAGS(sstr);
9419 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9420 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9423 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9424 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9425 PL_watch_pvx, SvPVX_const(sstr));
9428 /* don't clone objects whose class has asked us not to */
9429 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9430 SvFLAGS(dstr) &= ~SVTYPEMASK;
9435 switch (SvTYPE(sstr)) {
9440 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9441 SvIV_set(dstr, SvIVX(sstr));
9444 SvANY(dstr) = new_XNV();
9445 SvNV_set(dstr, SvNVX(sstr));
9448 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9449 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9453 /* These are all the types that need complex bodies allocating. */
9455 const svtype sv_type = SvTYPE(sstr);
9456 const struct body_details *const sv_type_details
9457 = bodies_by_type + sv_type;
9461 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9466 if (GvUNIQUE((GV*)sstr)) {
9467 /* Do sharing here, and fall through */
9480 assert(sv_type_details->size);
9481 if (sv_type_details->arena) {
9482 new_body_inline(new_body, sv_type_details->size, sv_type);
9484 = (void*)((char*)new_body - sv_type_details->offset);
9486 new_body = new_NOARENA(sv_type_details);
9490 SvANY(dstr) = new_body;
9493 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9494 ((char*)SvANY(dstr)) + sv_type_details->offset,
9495 sv_type_details->copy, char);
9497 Copy(((char*)SvANY(sstr)),
9498 ((char*)SvANY(dstr)),
9499 sv_type_details->size + sv_type_details->offset, char);
9502 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9503 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9505 /* The Copy above means that all the source (unduplicated) pointers
9506 are now in the destination. We can check the flags and the
9507 pointers in either, but it's possible that there's less cache
9508 missing by always going for the destination.
9509 FIXME - instrument and check that assumption */
9510 if (sv_type >= SVt_PVMG) {
9512 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9514 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9517 /* The cast silences a GCC warning about unhandled types. */
9518 switch ((int)sv_type) {
9530 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9531 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9532 LvTARG(dstr) = dstr;
9533 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9534 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9536 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9539 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9540 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9541 /* Don't call sv_add_backref here as it's going to be created
9542 as part of the magic cloning of the symbol table. */
9543 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9544 (void)GpREFCNT_inc(GvGP(dstr));
9547 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9548 if (IoOFP(dstr) == IoIFP(sstr))
9549 IoOFP(dstr) = IoIFP(dstr);
9551 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9552 /* PL_rsfp_filters entries have fake IoDIRP() */
9553 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9554 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9555 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9556 /* I have no idea why fake dirp (rsfps)
9557 should be treated differently but otherwise
9558 we end up with leaks -- sky*/
9559 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9560 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9561 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9563 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9564 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9565 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9567 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9568 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9569 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9572 if (AvARRAY((AV*)sstr)) {
9573 SV **dst_ary, **src_ary;
9574 SSize_t items = AvFILLp((AV*)sstr) + 1;
9576 src_ary = AvARRAY((AV*)sstr);
9577 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9578 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9579 SvPV_set(dstr, (char*)dst_ary);
9580 AvALLOC((AV*)dstr) = dst_ary;
9581 if (AvREAL((AV*)sstr)) {
9583 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9587 *dst_ary++ = sv_dup(*src_ary++, param);
9589 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9590 while (items-- > 0) {
9591 *dst_ary++ = &PL_sv_undef;
9595 SvPV_set(dstr, Nullch);
9596 AvALLOC((AV*)dstr) = (SV**)NULL;
9603 if (HvARRAY((HV*)sstr)) {
9605 const bool sharekeys = !!HvSHAREKEYS(sstr);
9606 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9607 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9609 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9610 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9612 HvARRAY(dstr) = (HE**)darray;
9613 while (i <= sxhv->xhv_max) {
9614 const HE *source = HvARRAY(sstr)[i];
9615 HvARRAY(dstr)[i] = source
9616 ? he_dup(source, sharekeys, param) : 0;
9620 struct xpvhv_aux * const saux = HvAUX(sstr);
9621 struct xpvhv_aux * const daux = HvAUX(dstr);
9622 /* This flag isn't copied. */
9623 /* SvOOK_on(hv) attacks the IV flags. */
9624 SvFLAGS(dstr) |= SVf_OOK;
9626 hvname = saux->xhv_name;
9628 = hvname ? hek_dup(hvname, param) : hvname;
9630 daux->xhv_riter = saux->xhv_riter;
9631 daux->xhv_eiter = saux->xhv_eiter
9632 ? he_dup(saux->xhv_eiter,
9633 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9634 daux->xhv_backreferences = saux->xhv_backreferences
9635 ? (AV*) SvREFCNT_inc(
9643 SvPV_set(dstr, Nullch);
9645 /* Record stashes for possible cloning in Perl_clone(). */
9647 av_push(param->stashes, dstr);
9652 /* NOTE: not refcounted */
9653 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9655 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9657 if (CvCONST(dstr)) {
9658 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9659 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9660 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9662 /* don't dup if copying back - CvGV isn't refcounted, so the
9663 * duped GV may never be freed. A bit of a hack! DAPM */
9664 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9665 Nullgv : gv_dup(CvGV(dstr), param) ;
9666 if (!(param->flags & CLONEf_COPY_STACKS)) {
9669 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9672 ? cv_dup( CvOUTSIDE(dstr), param)
9673 : cv_dup_inc(CvOUTSIDE(dstr), param);
9675 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9681 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9687 /* duplicate a context */
9690 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9695 return (PERL_CONTEXT*)NULL;
9697 /* look for it in the table first */
9698 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9702 /* create anew and remember what it is */
9703 Newxz(ncxs, max + 1, PERL_CONTEXT);
9704 ptr_table_store(PL_ptr_table, cxs, ncxs);
9707 PERL_CONTEXT * const cx = &cxs[ix];
9708 PERL_CONTEXT * const ncx = &ncxs[ix];
9709 ncx->cx_type = cx->cx_type;
9710 if (CxTYPE(cx) == CXt_SUBST) {
9711 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9714 ncx->blk_oldsp = cx->blk_oldsp;
9715 ncx->blk_oldcop = cx->blk_oldcop;
9716 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9717 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9718 ncx->blk_oldpm = cx->blk_oldpm;
9719 ncx->blk_gimme = cx->blk_gimme;
9720 switch (CxTYPE(cx)) {
9722 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9723 ? cv_dup_inc(cx->blk_sub.cv, param)
9724 : cv_dup(cx->blk_sub.cv,param));
9725 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9726 ? av_dup_inc(cx->blk_sub.argarray, param)
9728 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9729 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9730 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9731 ncx->blk_sub.lval = cx->blk_sub.lval;
9732 ncx->blk_sub.retop = cx->blk_sub.retop;
9735 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9736 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9737 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9738 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9739 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9740 ncx->blk_eval.retop = cx->blk_eval.retop;
9743 ncx->blk_loop.label = cx->blk_loop.label;
9744 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9745 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9746 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9747 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9748 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9749 ? cx->blk_loop.iterdata
9750 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9751 ncx->blk_loop.oldcomppad
9752 = (PAD*)ptr_table_fetch(PL_ptr_table,
9753 cx->blk_loop.oldcomppad);
9754 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9755 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9756 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9757 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9758 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9761 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9762 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9763 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9764 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9765 ncx->blk_sub.retop = cx->blk_sub.retop;
9777 /* duplicate a stack info structure */
9780 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9785 return (PERL_SI*)NULL;
9787 /* look for it in the table first */
9788 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9792 /* create anew and remember what it is */
9793 Newxz(nsi, 1, PERL_SI);
9794 ptr_table_store(PL_ptr_table, si, nsi);
9796 nsi->si_stack = av_dup_inc(si->si_stack, param);
9797 nsi->si_cxix = si->si_cxix;
9798 nsi->si_cxmax = si->si_cxmax;
9799 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9800 nsi->si_type = si->si_type;
9801 nsi->si_prev = si_dup(si->si_prev, param);
9802 nsi->si_next = si_dup(si->si_next, param);
9803 nsi->si_markoff = si->si_markoff;
9808 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9809 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9810 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9811 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9812 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9813 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9814 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9815 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9816 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9817 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9818 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9819 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9820 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9821 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9824 #define pv_dup_inc(p) SAVEPV(p)
9825 #define pv_dup(p) SAVEPV(p)
9826 #define svp_dup_inc(p,pp) any_dup(p,pp)
9828 /* map any object to the new equivent - either something in the
9829 * ptr table, or something in the interpreter structure
9833 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9840 /* look for it in the table first */
9841 ret = ptr_table_fetch(PL_ptr_table, v);
9845 /* see if it is part of the interpreter structure */
9846 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9847 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9855 /* duplicate the save stack */
9858 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9860 ANY * const ss = proto_perl->Tsavestack;
9861 const I32 max = proto_perl->Tsavestack_max;
9862 I32 ix = proto_perl->Tsavestack_ix;
9874 void (*dptr) (void*);
9875 void (*dxptr) (pTHX_ void*);
9877 Newxz(nss, max, ANY);
9880 I32 i = POPINT(ss,ix);
9883 case SAVEt_ITEM: /* normal string */
9884 sv = (SV*)POPPTR(ss,ix);
9885 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9886 sv = (SV*)POPPTR(ss,ix);
9887 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9889 case SAVEt_SV: /* scalar reference */
9890 sv = (SV*)POPPTR(ss,ix);
9891 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9892 gv = (GV*)POPPTR(ss,ix);
9893 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9895 case SAVEt_GENERIC_PVREF: /* generic char* */
9896 c = (char*)POPPTR(ss,ix);
9897 TOPPTR(nss,ix) = pv_dup(c);
9898 ptr = POPPTR(ss,ix);
9899 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9901 case SAVEt_SHARED_PVREF: /* char* in shared space */
9902 c = (char*)POPPTR(ss,ix);
9903 TOPPTR(nss,ix) = savesharedpv(c);
9904 ptr = POPPTR(ss,ix);
9905 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9907 case SAVEt_GENERIC_SVREF: /* generic sv */
9908 case SAVEt_SVREF: /* scalar reference */
9909 sv = (SV*)POPPTR(ss,ix);
9910 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9911 ptr = POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9914 case SAVEt_AV: /* array reference */
9915 av = (AV*)POPPTR(ss,ix);
9916 TOPPTR(nss,ix) = av_dup_inc(av, param);
9917 gv = (GV*)POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = gv_dup(gv, param);
9920 case SAVEt_HV: /* hash reference */
9921 hv = (HV*)POPPTR(ss,ix);
9922 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9923 gv = (GV*)POPPTR(ss,ix);
9924 TOPPTR(nss,ix) = gv_dup(gv, param);
9926 case SAVEt_INT: /* int reference */
9927 ptr = POPPTR(ss,ix);
9928 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9929 intval = (int)POPINT(ss,ix);
9930 TOPINT(nss,ix) = intval;
9932 case SAVEt_LONG: /* long reference */
9933 ptr = POPPTR(ss,ix);
9934 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9935 longval = (long)POPLONG(ss,ix);
9936 TOPLONG(nss,ix) = longval;
9938 case SAVEt_I32: /* I32 reference */
9939 case SAVEt_I16: /* I16 reference */
9940 case SAVEt_I8: /* I8 reference */
9941 ptr = POPPTR(ss,ix);
9942 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 case SAVEt_IV: /* IV reference */
9947 ptr = POPPTR(ss,ix);
9948 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9952 case SAVEt_SPTR: /* SV* reference */
9953 ptr = POPPTR(ss,ix);
9954 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9955 sv = (SV*)POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = sv_dup(sv, param);
9958 case SAVEt_VPTR: /* random* reference */
9959 ptr = POPPTR(ss,ix);
9960 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9961 ptr = POPPTR(ss,ix);
9962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9964 case SAVEt_PPTR: /* char* reference */
9965 ptr = POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9967 c = (char*)POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = pv_dup(c);
9970 case SAVEt_HPTR: /* HV* reference */
9971 ptr = POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9973 hv = (HV*)POPPTR(ss,ix);
9974 TOPPTR(nss,ix) = hv_dup(hv, param);
9976 case SAVEt_APTR: /* AV* reference */
9977 ptr = POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9979 av = (AV*)POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = av_dup(av, param);
9983 gv = (GV*)POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = gv_dup(gv, param);
9986 case SAVEt_GP: /* scalar reference */
9987 gp = (GP*)POPPTR(ss,ix);
9988 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9989 (void)GpREFCNT_inc(gp);
9990 gv = (GV*)POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9992 c = (char*)POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = pv_dup(c);
10000 case SAVEt_MORTALIZESV:
10001 sv = (SV*)POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10005 ptr = POPPTR(ss,ix);
10006 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10007 /* these are assumed to be refcounted properly */
10009 switch (((OP*)ptr)->op_type) {
10011 case OP_LEAVESUBLV:
10015 case OP_LEAVEWRITE:
10016 TOPPTR(nss,ix) = ptr;
10021 TOPPTR(nss,ix) = Nullop;
10026 TOPPTR(nss,ix) = Nullop;
10029 c = (char*)POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = pv_dup_inc(c);
10032 case SAVEt_CLEARSV:
10033 longval = POPLONG(ss,ix);
10034 TOPLONG(nss,ix) = longval;
10037 hv = (HV*)POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10039 c = (char*)POPPTR(ss,ix);
10040 TOPPTR(nss,ix) = pv_dup_inc(c);
10042 TOPINT(nss,ix) = i;
10044 case SAVEt_DESTRUCTOR:
10045 ptr = POPPTR(ss,ix);
10046 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10047 dptr = POPDPTR(ss,ix);
10048 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10049 any_dup(FPTR2DPTR(void *, dptr),
10052 case SAVEt_DESTRUCTOR_X:
10053 ptr = POPPTR(ss,ix);
10054 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10055 dxptr = POPDXPTR(ss,ix);
10056 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10057 any_dup(FPTR2DPTR(void *, dxptr),
10060 case SAVEt_REGCONTEXT:
10063 TOPINT(nss,ix) = i;
10066 case SAVEt_STACK_POS: /* Position on Perl stack */
10068 TOPINT(nss,ix) = i;
10070 case SAVEt_AELEM: /* array element */
10071 sv = (SV*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10074 TOPINT(nss,ix) = i;
10075 av = (AV*)POPPTR(ss,ix);
10076 TOPPTR(nss,ix) = av_dup_inc(av, param);
10078 case SAVEt_HELEM: /* hash element */
10079 sv = (SV*)POPPTR(ss,ix);
10080 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10081 sv = (SV*)POPPTR(ss,ix);
10082 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10083 hv = (HV*)POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10087 ptr = POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = ptr;
10092 TOPINT(nss,ix) = i;
10094 case SAVEt_COMPPAD:
10095 av = (AV*)POPPTR(ss,ix);
10096 TOPPTR(nss,ix) = av_dup(av, param);
10099 longval = (long)POPLONG(ss,ix);
10100 TOPLONG(nss,ix) = longval;
10101 ptr = POPPTR(ss,ix);
10102 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10103 sv = (SV*)POPPTR(ss,ix);
10104 TOPPTR(nss,ix) = sv_dup(sv, param);
10107 ptr = POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10109 longval = (long)POPBOOL(ss,ix);
10110 TOPBOOL(nss,ix) = (bool)longval;
10112 case SAVEt_SET_SVFLAGS:
10114 TOPINT(nss,ix) = i;
10116 TOPINT(nss,ix) = i;
10117 sv = (SV*)POPPTR(ss,ix);
10118 TOPPTR(nss,ix) = sv_dup(sv, param);
10121 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10129 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10130 * flag to the result. This is done for each stash before cloning starts,
10131 * so we know which stashes want their objects cloned */
10134 do_mark_cloneable_stash(pTHX_ SV *sv)
10136 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10138 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10139 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10140 if (cloner && GvCV(cloner)) {
10147 XPUSHs(sv_2mortal(newSVhek(hvname)));
10149 call_sv((SV*)GvCV(cloner), G_SCALAR);
10156 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10164 =for apidoc perl_clone
10166 Create and return a new interpreter by cloning the current one.
10168 perl_clone takes these flags as parameters:
10170 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10171 without it we only clone the data and zero the stacks,
10172 with it we copy the stacks and the new perl interpreter is
10173 ready to run at the exact same point as the previous one.
10174 The pseudo-fork code uses COPY_STACKS while the
10175 threads->new doesn't.
10177 CLONEf_KEEP_PTR_TABLE
10178 perl_clone keeps a ptr_table with the pointer of the old
10179 variable as a key and the new variable as a value,
10180 this allows it to check if something has been cloned and not
10181 clone it again but rather just use the value and increase the
10182 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10183 the ptr_table using the function
10184 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10185 reason to keep it around is if you want to dup some of your own
10186 variable who are outside the graph perl scans, example of this
10187 code is in threads.xs create
10190 This is a win32 thing, it is ignored on unix, it tells perls
10191 win32host code (which is c++) to clone itself, this is needed on
10192 win32 if you want to run two threads at the same time,
10193 if you just want to do some stuff in a separate perl interpreter
10194 and then throw it away and return to the original one,
10195 you don't need to do anything.
10200 /* XXX the above needs expanding by someone who actually understands it ! */
10201 EXTERN_C PerlInterpreter *
10202 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10205 perl_clone(PerlInterpreter *proto_perl, UV flags)
10208 #ifdef PERL_IMPLICIT_SYS
10210 /* perlhost.h so we need to call into it
10211 to clone the host, CPerlHost should have a c interface, sky */
10213 if (flags & CLONEf_CLONE_HOST) {
10214 return perl_clone_host(proto_perl,flags);
10216 return perl_clone_using(proto_perl, flags,
10218 proto_perl->IMemShared,
10219 proto_perl->IMemParse,
10221 proto_perl->IStdIO,
10225 proto_perl->IProc);
10229 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10230 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10231 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10232 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10233 struct IPerlDir* ipD, struct IPerlSock* ipS,
10234 struct IPerlProc* ipP)
10236 /* XXX many of the string copies here can be optimized if they're
10237 * constants; they need to be allocated as common memory and just
10238 * their pointers copied. */
10241 CLONE_PARAMS clone_params;
10242 CLONE_PARAMS* param = &clone_params;
10244 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10245 /* for each stash, determine whether its objects should be cloned */
10246 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10247 PERL_SET_THX(my_perl);
10250 Poison(my_perl, 1, PerlInterpreter);
10252 PL_curcop = (COP *)Nullop;
10256 PL_savestack_ix = 0;
10257 PL_savestack_max = -1;
10258 PL_sig_pending = 0;
10259 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10260 # else /* !DEBUGGING */
10261 Zero(my_perl, 1, PerlInterpreter);
10262 # endif /* DEBUGGING */
10264 /* host pointers */
10266 PL_MemShared = ipMS;
10267 PL_MemParse = ipMP;
10274 #else /* !PERL_IMPLICIT_SYS */
10276 CLONE_PARAMS clone_params;
10277 CLONE_PARAMS* param = &clone_params;
10278 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10279 /* for each stash, determine whether its objects should be cloned */
10280 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10281 PERL_SET_THX(my_perl);
10284 Poison(my_perl, 1, PerlInterpreter);
10286 PL_curcop = (COP *)Nullop;
10290 PL_savestack_ix = 0;
10291 PL_savestack_max = -1;
10292 PL_sig_pending = 0;
10293 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10294 # else /* !DEBUGGING */
10295 Zero(my_perl, 1, PerlInterpreter);
10296 # endif /* DEBUGGING */
10297 #endif /* PERL_IMPLICIT_SYS */
10298 param->flags = flags;
10299 param->proto_perl = proto_perl;
10301 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10302 Zero(&PL_body_roots, 1, PL_body_roots);
10304 PL_nice_chunk = NULL;
10305 PL_nice_chunk_size = 0;
10307 PL_sv_objcount = 0;
10308 PL_sv_root = Nullsv;
10309 PL_sv_arenaroot = Nullsv;
10311 PL_debug = proto_perl->Idebug;
10313 PL_hash_seed = proto_perl->Ihash_seed;
10314 PL_rehash_seed = proto_perl->Irehash_seed;
10316 #ifdef USE_REENTRANT_API
10317 /* XXX: things like -Dm will segfault here in perlio, but doing
10318 * PERL_SET_CONTEXT(proto_perl);
10319 * breaks too many other things
10321 Perl_reentrant_init(aTHX);
10324 /* create SV map for pointer relocation */
10325 PL_ptr_table = ptr_table_new();
10327 /* initialize these special pointers as early as possible */
10328 SvANY(&PL_sv_undef) = NULL;
10329 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10330 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10331 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10333 SvANY(&PL_sv_no) = new_XPVNV();
10334 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10335 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10336 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10337 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10338 SvCUR_set(&PL_sv_no, 0);
10339 SvLEN_set(&PL_sv_no, 1);
10340 SvIV_set(&PL_sv_no, 0);
10341 SvNV_set(&PL_sv_no, 0);
10342 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10344 SvANY(&PL_sv_yes) = new_XPVNV();
10345 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10346 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10347 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10348 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10349 SvCUR_set(&PL_sv_yes, 1);
10350 SvLEN_set(&PL_sv_yes, 2);
10351 SvIV_set(&PL_sv_yes, 1);
10352 SvNV_set(&PL_sv_yes, 1);
10353 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10355 /* create (a non-shared!) shared string table */
10356 PL_strtab = newHV();
10357 HvSHAREKEYS_off(PL_strtab);
10358 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10359 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10361 PL_compiling = proto_perl->Icompiling;
10363 /* These two PVs will be free'd special way so must set them same way op.c does */
10364 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10365 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10367 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10368 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10370 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10371 if (!specialWARN(PL_compiling.cop_warnings))
10372 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10373 if (!specialCopIO(PL_compiling.cop_io))
10374 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10375 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10377 /* pseudo environmental stuff */
10378 PL_origargc = proto_perl->Iorigargc;
10379 PL_origargv = proto_perl->Iorigargv;
10381 param->stashes = newAV(); /* Setup array of objects to call clone on */
10383 /* Set tainting stuff before PerlIO_debug can possibly get called */
10384 PL_tainting = proto_perl->Itainting;
10385 PL_taint_warn = proto_perl->Itaint_warn;
10387 #ifdef PERLIO_LAYERS
10388 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10389 PerlIO_clone(aTHX_ proto_perl, param);
10392 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10393 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10394 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10395 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10396 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10397 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10400 PL_minus_c = proto_perl->Iminus_c;
10401 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10402 PL_localpatches = proto_perl->Ilocalpatches;
10403 PL_splitstr = proto_perl->Isplitstr;
10404 PL_preprocess = proto_perl->Ipreprocess;
10405 PL_minus_n = proto_perl->Iminus_n;
10406 PL_minus_p = proto_perl->Iminus_p;
10407 PL_minus_l = proto_perl->Iminus_l;
10408 PL_minus_a = proto_perl->Iminus_a;
10409 PL_minus_E = proto_perl->Iminus_E;
10410 PL_minus_F = proto_perl->Iminus_F;
10411 PL_doswitches = proto_perl->Idoswitches;
10412 PL_dowarn = proto_perl->Idowarn;
10413 PL_doextract = proto_perl->Idoextract;
10414 PL_sawampersand = proto_perl->Isawampersand;
10415 PL_unsafe = proto_perl->Iunsafe;
10416 PL_inplace = SAVEPV(proto_perl->Iinplace);
10417 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10418 PL_perldb = proto_perl->Iperldb;
10419 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10420 PL_exit_flags = proto_perl->Iexit_flags;
10422 /* magical thingies */
10423 /* XXX time(&PL_basetime) when asked for? */
10424 PL_basetime = proto_perl->Ibasetime;
10425 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10427 PL_maxsysfd = proto_perl->Imaxsysfd;
10428 PL_multiline = proto_perl->Imultiline;
10429 PL_statusvalue = proto_perl->Istatusvalue;
10431 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10433 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10435 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10437 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10438 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10439 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10441 /* Clone the regex array */
10442 PL_regex_padav = newAV();
10444 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10445 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10447 av_push(PL_regex_padav,
10448 sv_dup_inc(regexen[0],param));
10449 for(i = 1; i <= len; i++) {
10450 const SV * const regex = regexen[i];
10453 ? sv_dup_inc(regex, param)
10455 newSViv(PTR2IV(re_dup(
10456 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10458 av_push(PL_regex_padav, sv);
10461 PL_regex_pad = AvARRAY(PL_regex_padav);
10463 /* shortcuts to various I/O objects */
10464 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10465 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10466 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10467 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10468 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10469 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10471 /* shortcuts to regexp stuff */
10472 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10474 /* shortcuts to misc objects */
10475 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10477 /* shortcuts to debugging objects */
10478 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10479 PL_DBline = gv_dup(proto_perl->IDBline, param);
10480 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10481 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10482 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10483 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10484 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10485 PL_lineary = av_dup(proto_perl->Ilineary, param);
10486 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10488 /* symbol tables */
10489 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10490 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10491 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10492 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10493 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10495 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10496 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10497 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10498 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10499 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10500 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10502 PL_sub_generation = proto_perl->Isub_generation;
10504 /* funky return mechanisms */
10505 PL_forkprocess = proto_perl->Iforkprocess;
10507 /* subprocess state */
10508 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10510 /* internal state */
10511 PL_maxo = proto_perl->Imaxo;
10512 if (proto_perl->Iop_mask)
10513 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10515 PL_op_mask = Nullch;
10516 /* PL_asserting = proto_perl->Iasserting; */
10518 /* current interpreter roots */
10519 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10520 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10521 PL_main_start = proto_perl->Imain_start;
10522 PL_eval_root = proto_perl->Ieval_root;
10523 PL_eval_start = proto_perl->Ieval_start;
10525 /* runtime control stuff */
10526 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10527 PL_copline = proto_perl->Icopline;
10529 PL_filemode = proto_perl->Ifilemode;
10530 PL_lastfd = proto_perl->Ilastfd;
10531 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10534 PL_gensym = proto_perl->Igensym;
10535 PL_preambled = proto_perl->Ipreambled;
10536 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10537 PL_laststatval = proto_perl->Ilaststatval;
10538 PL_laststype = proto_perl->Ilaststype;
10539 PL_mess_sv = Nullsv;
10541 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10543 /* interpreter atexit processing */
10544 PL_exitlistlen = proto_perl->Iexitlistlen;
10545 if (PL_exitlistlen) {
10546 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10547 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10550 PL_exitlist = (PerlExitListEntry*)NULL;
10552 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10553 if (PL_my_cxt_size) {
10554 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10555 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10558 PL_my_cxt_list = (void**)NULL;
10559 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10560 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10561 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10563 PL_profiledata = NULL;
10564 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10565 /* PL_rsfp_filters entries have fake IoDIRP() */
10566 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10568 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10570 PAD_CLONE_VARS(proto_perl, param);
10572 #ifdef HAVE_INTERP_INTERN
10573 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10576 /* more statics moved here */
10577 PL_generation = proto_perl->Igeneration;
10578 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10580 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10581 PL_in_clean_all = proto_perl->Iin_clean_all;
10583 PL_uid = proto_perl->Iuid;
10584 PL_euid = proto_perl->Ieuid;
10585 PL_gid = proto_perl->Igid;
10586 PL_egid = proto_perl->Iegid;
10587 PL_nomemok = proto_perl->Inomemok;
10588 PL_an = proto_perl->Ian;
10589 PL_evalseq = proto_perl->Ievalseq;
10590 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10591 PL_origalen = proto_perl->Iorigalen;
10592 #ifdef PERL_USES_PL_PIDSTATUS
10593 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10595 PL_osname = SAVEPV(proto_perl->Iosname);
10596 PL_sighandlerp = proto_perl->Isighandlerp;
10598 PL_runops = proto_perl->Irunops;
10600 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10603 PL_cshlen = proto_perl->Icshlen;
10604 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10607 PL_lex_state = proto_perl->Ilex_state;
10608 PL_lex_defer = proto_perl->Ilex_defer;
10609 PL_lex_expect = proto_perl->Ilex_expect;
10610 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10611 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10612 PL_lex_starts = proto_perl->Ilex_starts;
10613 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10614 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10615 PL_lex_op = proto_perl->Ilex_op;
10616 PL_lex_inpat = proto_perl->Ilex_inpat;
10617 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10618 PL_lex_brackets = proto_perl->Ilex_brackets;
10619 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10620 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10621 PL_lex_casemods = proto_perl->Ilex_casemods;
10622 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10623 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10625 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10626 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10627 PL_nexttoke = proto_perl->Inexttoke;
10629 /* XXX This is probably masking the deeper issue of why
10630 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10631 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10632 * (A little debugging with a watchpoint on it may help.)
10634 if (SvANY(proto_perl->Ilinestr)) {
10635 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10636 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10637 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10638 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10639 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10640 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10641 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10642 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10643 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10646 PL_linestr = NEWSV(65,79);
10647 sv_upgrade(PL_linestr,SVt_PVIV);
10648 sv_setpvn(PL_linestr,"",0);
10649 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10651 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10652 PL_pending_ident = proto_perl->Ipending_ident;
10653 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10655 PL_expect = proto_perl->Iexpect;
10657 PL_multi_start = proto_perl->Imulti_start;
10658 PL_multi_end = proto_perl->Imulti_end;
10659 PL_multi_open = proto_perl->Imulti_open;
10660 PL_multi_close = proto_perl->Imulti_close;
10662 PL_error_count = proto_perl->Ierror_count;
10663 PL_subline = proto_perl->Isubline;
10664 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10666 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10667 if (SvANY(proto_perl->Ilinestr)) {
10668 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10669 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10670 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10671 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10672 PL_last_lop_op = proto_perl->Ilast_lop_op;
10675 PL_last_uni = SvPVX(PL_linestr);
10676 PL_last_lop = SvPVX(PL_linestr);
10677 PL_last_lop_op = 0;
10679 PL_in_my = proto_perl->Iin_my;
10680 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10682 PL_cryptseen = proto_perl->Icryptseen;
10685 PL_hints = proto_perl->Ihints;
10687 PL_amagic_generation = proto_perl->Iamagic_generation;
10689 #ifdef USE_LOCALE_COLLATE
10690 PL_collation_ix = proto_perl->Icollation_ix;
10691 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10692 PL_collation_standard = proto_perl->Icollation_standard;
10693 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10694 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10695 #endif /* USE_LOCALE_COLLATE */
10697 #ifdef USE_LOCALE_NUMERIC
10698 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10699 PL_numeric_standard = proto_perl->Inumeric_standard;
10700 PL_numeric_local = proto_perl->Inumeric_local;
10701 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10702 #endif /* !USE_LOCALE_NUMERIC */
10704 /* utf8 character classes */
10705 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10706 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10707 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10708 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10709 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10710 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10711 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10712 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10713 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10714 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10715 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10716 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10717 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10718 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10719 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10720 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10721 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10722 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10723 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10724 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10726 /* Did the locale setup indicate UTF-8? */
10727 PL_utf8locale = proto_perl->Iutf8locale;
10728 /* Unicode features (see perlrun/-C) */
10729 PL_unicode = proto_perl->Iunicode;
10731 /* Pre-5.8 signals control */
10732 PL_signals = proto_perl->Isignals;
10734 /* times() ticks per second */
10735 PL_clocktick = proto_perl->Iclocktick;
10737 /* Recursion stopper for PerlIO_find_layer */
10738 PL_in_load_module = proto_perl->Iin_load_module;
10740 /* sort() routine */
10741 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10743 /* Not really needed/useful since the reenrant_retint is "volatile",
10744 * but do it for consistency's sake. */
10745 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10747 /* Hooks to shared SVs and locks. */
10748 PL_sharehook = proto_perl->Isharehook;
10749 PL_lockhook = proto_perl->Ilockhook;
10750 PL_unlockhook = proto_perl->Iunlockhook;
10751 PL_threadhook = proto_perl->Ithreadhook;
10753 PL_runops_std = proto_perl->Irunops_std;
10754 PL_runops_dbg = proto_perl->Irunops_dbg;
10756 #ifdef THREADS_HAVE_PIDS
10757 PL_ppid = proto_perl->Ippid;
10761 PL_last_swash_hv = NULL; /* reinits on demand */
10762 PL_last_swash_klen = 0;
10763 PL_last_swash_key[0]= '\0';
10764 PL_last_swash_tmps = (U8*)NULL;
10765 PL_last_swash_slen = 0;
10767 PL_glob_index = proto_perl->Iglob_index;
10768 PL_srand_called = proto_perl->Isrand_called;
10769 PL_uudmap['M'] = 0; /* reinits on demand */
10770 PL_bitcount = Nullch; /* reinits on demand */
10772 if (proto_perl->Ipsig_pend) {
10773 Newxz(PL_psig_pend, SIG_SIZE, int);
10776 PL_psig_pend = (int*)NULL;
10779 if (proto_perl->Ipsig_ptr) {
10780 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10781 Newxz(PL_psig_name, SIG_SIZE, SV*);
10782 for (i = 1; i < SIG_SIZE; i++) {
10783 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10784 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10788 PL_psig_ptr = (SV**)NULL;
10789 PL_psig_name = (SV**)NULL;
10792 /* thrdvar.h stuff */
10794 if (flags & CLONEf_COPY_STACKS) {
10795 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10796 PL_tmps_ix = proto_perl->Ttmps_ix;
10797 PL_tmps_max = proto_perl->Ttmps_max;
10798 PL_tmps_floor = proto_perl->Ttmps_floor;
10799 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10801 while (i <= PL_tmps_ix) {
10802 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10806 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10807 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10808 Newxz(PL_markstack, i, I32);
10809 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10810 - proto_perl->Tmarkstack);
10811 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10812 - proto_perl->Tmarkstack);
10813 Copy(proto_perl->Tmarkstack, PL_markstack,
10814 PL_markstack_ptr - PL_markstack + 1, I32);
10816 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10817 * NOTE: unlike the others! */
10818 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10819 PL_scopestack_max = proto_perl->Tscopestack_max;
10820 Newxz(PL_scopestack, PL_scopestack_max, I32);
10821 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10823 /* NOTE: si_dup() looks at PL_markstack */
10824 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10826 /* PL_curstack = PL_curstackinfo->si_stack; */
10827 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10828 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10830 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10831 PL_stack_base = AvARRAY(PL_curstack);
10832 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10833 - proto_perl->Tstack_base);
10834 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10836 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10837 * NOTE: unlike the others! */
10838 PL_savestack_ix = proto_perl->Tsavestack_ix;
10839 PL_savestack_max = proto_perl->Tsavestack_max;
10840 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10841 PL_savestack = ss_dup(proto_perl, param);
10845 ENTER; /* perl_destruct() wants to LEAVE; */
10847 /* although we're not duplicating the tmps stack, we should still
10848 * add entries for any SVs on the tmps stack that got cloned by a
10849 * non-refcount means (eg a temp in @_); otherwise they will be
10852 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10853 SV *nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10854 proto_perl->Ttmps_stack[i]);
10855 if (nsv && !SvREFCNT(nsv)) {
10857 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10862 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10863 PL_top_env = &PL_start_env;
10865 PL_op = proto_perl->Top;
10868 PL_Xpv = (XPV*)NULL;
10869 PL_na = proto_perl->Tna;
10871 PL_statbuf = proto_perl->Tstatbuf;
10872 PL_statcache = proto_perl->Tstatcache;
10873 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10874 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10876 PL_timesbuf = proto_perl->Ttimesbuf;
10879 PL_tainted = proto_perl->Ttainted;
10880 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10881 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10882 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10883 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10884 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10885 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10886 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10887 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10888 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10890 PL_restartop = proto_perl->Trestartop;
10891 PL_in_eval = proto_perl->Tin_eval;
10892 PL_delaymagic = proto_perl->Tdelaymagic;
10893 PL_dirty = proto_perl->Tdirty;
10894 PL_localizing = proto_perl->Tlocalizing;
10896 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10897 PL_hv_fetch_ent_mh = Nullhe;
10898 PL_modcount = proto_perl->Tmodcount;
10899 PL_lastgotoprobe = Nullop;
10900 PL_dumpindent = proto_perl->Tdumpindent;
10902 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10903 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10904 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10905 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10906 PL_efloatbuf = Nullch; /* reinits on demand */
10907 PL_efloatsize = 0; /* reinits on demand */
10911 PL_screamfirst = NULL;
10912 PL_screamnext = NULL;
10913 PL_maxscream = -1; /* reinits on demand */
10914 PL_lastscream = Nullsv;
10916 PL_watchaddr = NULL;
10917 PL_watchok = Nullch;
10919 PL_regdummy = proto_perl->Tregdummy;
10920 PL_regprecomp = Nullch;
10923 PL_colorset = 0; /* reinits PL_colors[] */
10924 /*PL_colors[6] = {0,0,0,0,0,0};*/
10925 PL_reginput = Nullch;
10926 PL_regbol = Nullch;
10927 PL_regeol = Nullch;
10928 PL_regstartp = (I32*)NULL;
10929 PL_regendp = (I32*)NULL;
10930 PL_reglastparen = (U32*)NULL;
10931 PL_reglastcloseparen = (U32*)NULL;
10932 PL_regtill = Nullch;
10933 PL_reg_start_tmp = (char**)NULL;
10934 PL_reg_start_tmpl = 0;
10935 PL_regdata = (struct reg_data*)NULL;
10938 PL_reg_eval_set = 0;
10940 PL_regprogram = (regnode*)NULL;
10942 PL_regcc = (CURCUR*)NULL;
10943 PL_reg_call_cc = (struct re_cc_state*)NULL;
10944 PL_reg_re = (regexp*)NULL;
10945 PL_reg_ganch = Nullch;
10946 PL_reg_sv = Nullsv;
10947 PL_reg_match_utf8 = FALSE;
10948 PL_reg_magic = (MAGIC*)NULL;
10950 PL_reg_oldcurpm = (PMOP*)NULL;
10951 PL_reg_curpm = (PMOP*)NULL;
10952 PL_reg_oldsaved = Nullch;
10953 PL_reg_oldsavedlen = 0;
10954 #ifdef PERL_OLD_COPY_ON_WRITE
10957 PL_reg_maxiter = 0;
10958 PL_reg_leftiter = 0;
10959 PL_reg_poscache = Nullch;
10960 PL_reg_poscache_size= 0;
10962 /* RE engine - function pointers */
10963 PL_regcompp = proto_perl->Tregcompp;
10964 PL_regexecp = proto_perl->Tregexecp;
10965 PL_regint_start = proto_perl->Tregint_start;
10966 PL_regint_string = proto_perl->Tregint_string;
10967 PL_regfree = proto_perl->Tregfree;
10969 PL_reginterp_cnt = 0;
10970 PL_reg_starttry = 0;
10972 /* Pluggable optimizer */
10973 PL_peepp = proto_perl->Tpeepp;
10975 PL_stashcache = newHV();
10977 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10978 ptr_table_free(PL_ptr_table);
10979 PL_ptr_table = NULL;
10982 /* Call the ->CLONE method, if it exists, for each of the stashes
10983 identified by sv_dup() above.
10985 while(av_len(param->stashes) != -1) {
10986 HV* const stash = (HV*) av_shift(param->stashes);
10987 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10988 if (cloner && GvCV(cloner)) {
10993 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10995 call_sv((SV*)GvCV(cloner), G_DISCARD);
11001 SvREFCNT_dec(param->stashes);
11003 /* orphaned? eg threads->new inside BEGIN or use */
11004 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11005 (void)SvREFCNT_inc(PL_compcv);
11006 SAVEFREESV(PL_compcv);
11012 #endif /* USE_ITHREADS */
11015 =head1 Unicode Support
11017 =for apidoc sv_recode_to_utf8
11019 The encoding is assumed to be an Encode object, on entry the PV
11020 of the sv is assumed to be octets in that encoding, and the sv
11021 will be converted into Unicode (and UTF-8).
11023 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11024 is not a reference, nothing is done to the sv. If the encoding is not
11025 an C<Encode::XS> Encoding object, bad things will happen.
11026 (See F<lib/encoding.pm> and L<Encode>).
11028 The PV of the sv is returned.
11033 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11036 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11050 Passing sv_yes is wrong - it needs to be or'ed set of constants
11051 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11052 remove converted chars from source.
11054 Both will default the value - let them.
11056 XPUSHs(&PL_sv_yes);
11059 call_method("decode", G_SCALAR);
11063 s = SvPV_const(uni, len);
11064 if (s != SvPVX_const(sv)) {
11065 SvGROW(sv, len + 1);
11066 Move(s, SvPVX(sv), len + 1, char);
11067 SvCUR_set(sv, len);
11074 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11078 =for apidoc sv_cat_decode
11080 The encoding is assumed to be an Encode object, the PV of the ssv is
11081 assumed to be octets in that encoding and decoding the input starts
11082 from the position which (PV + *offset) pointed to. The dsv will be
11083 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11084 when the string tstr appears in decoding output or the input ends on
11085 the PV of the ssv. The value which the offset points will be modified
11086 to the last input position on the ssv.
11088 Returns TRUE if the terminator was found, else returns FALSE.
11093 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11094 SV *ssv, int *offset, char *tstr, int tlen)
11098 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11109 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11110 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11112 call_method("cat_decode", G_SCALAR);
11114 ret = SvTRUE(TOPs);
11115 *offset = SvIV(offsv);
11121 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11126 /* ---------------------------------------------------------------------
11128 * support functions for report_uninit()
11131 /* the maxiumum size of array or hash where we will scan looking
11132 * for the undefined element that triggered the warning */
11134 #define FUV_MAX_SEARCH_SIZE 1000
11136 /* Look for an entry in the hash whose value has the same SV as val;
11137 * If so, return a mortal copy of the key. */
11140 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11143 register HE **array;
11146 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11147 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11150 array = HvARRAY(hv);
11152 for (i=HvMAX(hv); i>0; i--) {
11153 register HE *entry;
11154 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11155 if (HeVAL(entry) != val)
11157 if ( HeVAL(entry) == &PL_sv_undef ||
11158 HeVAL(entry) == &PL_sv_placeholder)
11162 if (HeKLEN(entry) == HEf_SVKEY)
11163 return sv_mortalcopy(HeKEY_sv(entry));
11164 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11170 /* Look for an entry in the array whose value has the same SV as val;
11171 * If so, return the index, otherwise return -1. */
11174 S_find_array_subscript(pTHX_ AV *av, SV* val)
11179 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11180 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11184 for (i=AvFILLp(av); i>=0; i--) {
11185 if (svp[i] == val && svp[i] != &PL_sv_undef)
11191 /* S_varname(): return the name of a variable, optionally with a subscript.
11192 * If gv is non-zero, use the name of that global, along with gvtype (one
11193 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11194 * targ. Depending on the value of the subscript_type flag, return:
11197 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11198 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11199 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11200 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11203 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11204 SV* keyname, I32 aindex, int subscript_type)
11207 SV * const name = sv_newmortal();
11210 buffer[0] = gvtype;
11213 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11215 gv_fullname4(name, gv, buffer, 0);
11217 if ((unsigned int)SvPVX(name)[1] <= 26) {
11219 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11221 /* Swap the 1 unprintable control character for the 2 byte pretty
11222 version - ie substr($name, 1, 1) = $buffer; */
11223 sv_insert(name, 1, 1, buffer, 2);
11228 CV * const cv = find_runcv(&unused);
11232 if (!cv || !CvPADLIST(cv))
11234 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11235 sv = *av_fetch(av, targ, FALSE);
11236 /* SvLEN in a pad name is not to be trusted */
11237 sv_setpv(name, SvPV_nolen_const(sv));
11240 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11241 SV * const sv = NEWSV(0,0);
11242 *SvPVX(name) = '$';
11243 Perl_sv_catpvf(aTHX_ name, "{%s}",
11244 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11247 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11248 *SvPVX(name) = '$';
11249 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11251 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11252 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11259 =for apidoc find_uninit_var
11261 Find the name of the undefined variable (if any) that caused the operator o
11262 to issue a "Use of uninitialized value" warning.
11263 If match is true, only return a name if it's value matches uninit_sv.
11264 So roughly speaking, if a unary operator (such as OP_COS) generates a
11265 warning, then following the direct child of the op may yield an
11266 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11267 other hand, with OP_ADD there are two branches to follow, so we only print
11268 the variable name if we get an exact match.
11270 The name is returned as a mortal SV.
11272 Assumes that PL_op is the op that originally triggered the error, and that
11273 PL_comppad/PL_curpad points to the currently executing pad.
11279 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11287 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11288 uninit_sv == &PL_sv_placeholder)))
11291 switch (obase->op_type) {
11298 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11299 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11301 SV *keysv = Nullsv;
11302 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11304 if (pad) { /* @lex, %lex */
11305 sv = PAD_SVl(obase->op_targ);
11309 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11310 /* @global, %global */
11311 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11314 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11316 else /* @{expr}, %{expr} */
11317 return find_uninit_var(cUNOPx(obase)->op_first,
11321 /* attempt to find a match within the aggregate */
11323 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11325 subscript_type = FUV_SUBSCRIPT_HASH;
11328 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11330 subscript_type = FUV_SUBSCRIPT_ARRAY;
11333 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11336 return varname(gv, hash ? '%' : '@', obase->op_targ,
11337 keysv, index, subscript_type);
11341 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11343 return varname(Nullgv, '$', obase->op_targ,
11344 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11347 gv = cGVOPx_gv(obase);
11348 if (!gv || (match && GvSV(gv) != uninit_sv))
11350 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11353 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11356 av = (AV*)PAD_SV(obase->op_targ);
11357 if (!av || SvRMAGICAL(av))
11359 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11360 if (!svp || *svp != uninit_sv)
11363 return varname(Nullgv, '$', obase->op_targ,
11364 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11367 gv = cGVOPx_gv(obase);
11373 if (!av || SvRMAGICAL(av))
11375 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11376 if (!svp || *svp != uninit_sv)
11379 return varname(gv, '$', 0,
11380 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11385 o = cUNOPx(obase)->op_first;
11386 if (!o || o->op_type != OP_NULL ||
11387 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11389 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11393 if (PL_op == obase)
11394 /* $a[uninit_expr] or $h{uninit_expr} */
11395 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11398 o = cBINOPx(obase)->op_first;
11399 kid = cBINOPx(obase)->op_last;
11401 /* get the av or hv, and optionally the gv */
11403 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11404 sv = PAD_SV(o->op_targ);
11406 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11407 && cUNOPo->op_first->op_type == OP_GV)
11409 gv = cGVOPx_gv(cUNOPo->op_first);
11412 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11417 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11418 /* index is constant */
11422 if (obase->op_type == OP_HELEM) {
11423 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11424 if (!he || HeVAL(he) != uninit_sv)
11428 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11429 if (!svp || *svp != uninit_sv)
11433 if (obase->op_type == OP_HELEM)
11434 return varname(gv, '%', o->op_targ,
11435 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11437 return varname(gv, '@', o->op_targ, Nullsv,
11438 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11441 /* index is an expression;
11442 * attempt to find a match within the aggregate */
11443 if (obase->op_type == OP_HELEM) {
11444 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11446 return varname(gv, '%', o->op_targ,
11447 keysv, 0, FUV_SUBSCRIPT_HASH);
11450 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11452 return varname(gv, '@', o->op_targ,
11453 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11458 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11460 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11466 /* only examine RHS */
11467 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11470 o = cUNOPx(obase)->op_first;
11471 if (o->op_type == OP_PUSHMARK)
11474 if (!o->op_sibling) {
11475 /* one-arg version of open is highly magical */
11477 if (o->op_type == OP_GV) { /* open FOO; */
11479 if (match && GvSV(gv) != uninit_sv)
11481 return varname(gv, '$', 0,
11482 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11484 /* other possibilities not handled are:
11485 * open $x; or open my $x; should return '${*$x}'
11486 * open expr; should return '$'.expr ideally
11492 /* ops where $_ may be an implicit arg */
11496 if ( !(obase->op_flags & OPf_STACKED)) {
11497 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11498 ? PAD_SVl(obase->op_targ)
11501 sv = sv_newmortal();
11502 sv_setpvn(sv, "$_", 2);
11510 /* skip filehandle as it can't produce 'undef' warning */
11511 o = cUNOPx(obase)->op_first;
11512 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11513 o = o->op_sibling->op_sibling;
11520 match = 1; /* XS or custom code could trigger random warnings */
11525 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11526 return sv_2mortal(newSVpvs("${$/}"));
11531 if (!(obase->op_flags & OPf_KIDS))
11533 o = cUNOPx(obase)->op_first;
11539 /* if all except one arg are constant, or have no side-effects,
11540 * or are optimized away, then it's unambiguous */
11542 for (kid=o; kid; kid = kid->op_sibling) {
11544 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11545 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11546 || (kid->op_type == OP_PUSHMARK)
11550 if (o2) { /* more than one found */
11557 return find_uninit_var(o2, uninit_sv, match);
11559 /* scan all args */
11561 sv = find_uninit_var(o, uninit_sv, 1);
11573 =for apidoc report_uninit
11575 Print appropriate "Use of uninitialized variable" warning
11581 Perl_report_uninit(pTHX_ SV* uninit_sv)
11585 SV* varname = Nullsv;
11587 varname = find_uninit_var(PL_op, uninit_sv,0);
11589 sv_insert(varname, 0, 0, " ", 1);
11591 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11592 varname ? SvPV_nolen_const(varname) : "",
11593 " in ", OP_DESC(PL_op));
11596 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11602 * c-indentation-style: bsd
11603 * c-basic-offset: 4
11604 * indent-tabs-mode: t
11607 * ex: set ts=8 sts=4 sw=4 noet: