3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = Nullch;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 S_free_arena(pTHX_ void **root) {
562 void ** const next = *(void **)root;
569 =for apidoc sv_free_arenas
571 Deallocate the memory used by all arenas. Note that all the individual SV
572 heads and bodies within the arenas must already have been freed.
576 #define free_arena(name) \
578 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
579 PL_ ## name ## _arenaroot = 0; \
580 PL_ ## name ## _root = 0; \
584 Perl_sv_free_arenas(pTHX)
591 /* Free arenas here, but be careful about fake ones. (We assume
592 contiguity of the fake ones with the corresponding real ones.) */
594 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
595 svanext = (SV*) SvANY(sva);
596 while (svanext && SvFAKE(svanext))
597 svanext = (SV*) SvANY(svanext);
603 for (i=0; i<SVt_LAST; i++) {
604 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
605 PL_body_arenaroots[i] = 0;
606 PL_body_roots[i] = 0;
609 Safefree(PL_nice_chunk);
610 PL_nice_chunk = Nullch;
611 PL_nice_chunk_size = 0;
617 Here are mid-level routines that manage the allocation of bodies out
618 of the various arenas. There are 5 kinds of arenas:
620 1. SV-head arenas, which are discussed and handled above
621 2. regular body arenas
622 3. arenas for reduced-size bodies
624 5. pte arenas (thread related)
626 Arena types 2 & 3 are chained by body-type off an array of
627 arena-root pointers, which is indexed by svtype. Some of the
628 larger/less used body types are malloced singly, since a large
629 unused block of them is wasteful. Also, several svtypes dont have
630 bodies; the data fits into the sv-head itself. The arena-root
631 pointer thus has a few unused root-pointers (which may be hijacked
632 later for arena types 4,5)
634 3 differs from 2 as an optimization; some body types have several
635 unused fields in the front of the structure (which are kept in-place
636 for consistency). These bodies can be allocated in smaller chunks,
637 because the leading fields arent accessed. Pointers to such bodies
638 are decremented to point at the unused 'ghost' memory, knowing that
639 the pointers are used with offsets to the real memory.
641 HE, HEK arenas are managed separately, with separate code, but may
642 be merge-able later..
644 PTE arenas are not sv-bodies, but they share these mid-level
645 mechanics, so are considered here. The new mid-level mechanics rely
646 on the sv_type of the body being allocated, so we just reserve one
647 of the unused body-slots for PTEs, then use it in those (2) PTE
648 contexts below (line ~10k)
652 S_more_bodies (pTHX_ size_t size, svtype sv_type)
655 void ** const arena_root = &PL_body_arenaroots[sv_type];
656 void ** const root = &PL_body_roots[sv_type];
659 const size_t count = PERL_ARENA_SIZE / size;
661 Newx(start, count*size, char);
662 *((void **) start) = *arena_root;
663 *arena_root = (void *)start;
665 end = start + (count-1) * size;
667 /* The initial slot is used to link the arenas together, so it isn't to be
668 linked into the list of ready-to-use bodies. */
672 *root = (void *)start;
674 while (start < end) {
675 char * const next = start + size;
676 *(void**) start = (void *)next;
684 /* grab a new thing from the free list, allocating more if necessary */
686 /* 1st, the inline version */
688 #define new_body_inline(xpv, size, sv_type) \
690 void ** const r3wt = &PL_body_roots[sv_type]; \
692 xpv = *((void **)(r3wt)) \
693 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
694 *(r3wt) = *(void**)(xpv); \
698 /* now use the inline version in the proper function */
702 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
703 compilers issue warnings. */
706 S_new_body(pTHX_ size_t size, svtype sv_type)
710 new_body_inline(xpv, size, sv_type);
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 Revisiting type 3 arenas, there are 4 body-types which have some
729 members that are never accessed. They are XPV, XPVIV, XPVAV,
730 XPVHV, which have corresponding types: xpv_allocated,
731 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by
736 the size of the bit not allocated, so it's as if we allocated the
737 full structure. (But things will all go boom if you write to the
738 part that is "not there", because you'll be overwriting the last
739 members of the preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For example, if
742 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
743 and the pointer is unchanged. If the allocated structure is smaller (no
744 initial NV actually allocated) then the net effect is to subtract the size
745 of the NV from the pointer, to return a new pointer as if an initial NV were
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at the
750 start of the structure. IV bodies don't need it either, because they are
751 no longer allocated. */
753 /* The following 2 arrays hide the above details in a pair of
754 lookup-tables, allowing us to be body-type agnostic.
756 size maps svtype to its body's allocated size.
757 offset maps svtype to the body-pointer adjustment needed
759 NB: elements in latter are 0 or <0, and are added during
760 allocation, and subtracted during deallocation. It may be clearer
761 to invert the values, and call it shrinkage_by_svtype.
764 struct body_details {
765 size_t size; /* Size to allocate */
766 size_t copy; /* Size of structure to copy (may be shorter) */
768 bool cant_upgrade; /* Can upgrade this type */
769 bool zero_nv; /* zero the NV when upgrading from this */
770 bool arena; /* Allocated from an arena */
777 /* With -DPURFIY we allocate everything directly, and don't use arenas.
778 This seems a rather elegant way to simplify some of the code below. */
779 #define HASARENA FALSE
781 #define HASARENA TRUE
783 #define NOARENA FALSE
785 /* A macro to work out the offset needed to subtract from a pointer to (say)
792 to make its members accessible via a pointer to (say)
802 #define relative_STRUCT_OFFSET(longer, shorter, member) \
803 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
805 /* Calculate the length to copy. Specifically work out the length less any
806 final padding the compiler needed to add. See the comment in sv_upgrade
807 for why copying the padding proved to be a bug. */
809 #define copy_length(type, last_member) \
810 STRUCT_OFFSET(type, last_member) \
811 + sizeof (((type*)SvANY((SV*)0))->last_member)
813 static const struct body_details bodies_by_type[] = {
814 {0, 0, 0, FALSE, NONV, NOARENA},
815 /* IVs are in the head, so the allocation size is 0 */
816 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
817 /* 8 bytes on most ILP32 with IEEE doubles */
818 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
819 /* RVs are in the head now */
820 /* However, this slot is overloaded and used by the pte */
821 {0, 0, 0, FALSE, NONV, NOARENA},
822 /* 8 bytes on most ILP32 with IEEE doubles */
823 {sizeof(xpv_allocated),
824 copy_length(XPV, xpv_len)
825 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
826 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
827 FALSE, NONV, HASARENA},
829 {sizeof(xpviv_allocated),
830 copy_length(XPVIV, xiv_u)
831 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
832 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
833 FALSE, NONV, HASARENA},
835 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
837 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
839 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
841 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
843 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
845 {sizeof(xpvav_allocated),
846 copy_length(XPVAV, xmg_stash)
847 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
848 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
849 TRUE, HADNV, HASARENA},
851 {sizeof(xpvhv_allocated),
852 copy_length(XPVHV, xmg_stash)
853 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
854 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
855 TRUE, HADNV, HASARENA},
857 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
859 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
861 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
864 #define new_body_type(sv_type) \
865 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
866 - bodies_by_type[sv_type].offset)
868 #define del_body_type(p, sv_type) \
869 del_body(p, &PL_body_roots[sv_type])
872 #define new_body_allocated(sv_type) \
873 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
874 - bodies_by_type[sv_type].offset)
876 #define del_body_allocated(p, sv_type) \
877 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
880 #define my_safemalloc(s) (void*)safemalloc(s)
881 #define my_safecalloc(s) (void*)safecalloc(s, 1)
882 #define my_safefree(p) safefree((char*)p)
886 #define new_XNV() my_safemalloc(sizeof(XPVNV))
887 #define del_XNV(p) my_safefree(p)
889 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
890 #define del_XPVNV(p) my_safefree(p)
892 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
893 #define del_XPVAV(p) my_safefree(p)
895 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
896 #define del_XPVHV(p) my_safefree(p)
898 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
899 #define del_XPVMG(p) my_safefree(p)
901 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
902 #define del_XPVGV(p) my_safefree(p)
906 #define new_XNV() new_body_type(SVt_NV)
907 #define del_XNV(p) del_body_type(p, SVt_NV)
909 #define new_XPVNV() new_body_type(SVt_PVNV)
910 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
912 #define new_XPVAV() new_body_allocated(SVt_PVAV)
913 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
915 #define new_XPVHV() new_body_allocated(SVt_PVHV)
916 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
918 #define new_XPVMG() new_body_type(SVt_PVMG)
919 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
921 #define new_XPVGV() new_body_type(SVt_PVGV)
922 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
926 /* no arena for you! */
928 #define new_NOARENA(details) \
929 my_safemalloc((details)->size + (details)->offset)
930 #define new_NOARENAZ(details) \
931 my_safecalloc((details)->size + (details)->offset)
934 =for apidoc sv_upgrade
936 Upgrade an SV to a more complex form. Generally adds a new body type to the
937 SV, then copies across as much information as possible from the old body.
938 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
944 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
949 const U32 old_type = SvTYPE(sv);
950 const struct body_details *const old_type_details
951 = bodies_by_type + old_type;
952 const struct body_details *new_type_details = bodies_by_type + new_type;
954 if (new_type != SVt_PV && SvIsCOW(sv)) {
955 sv_force_normal_flags(sv, 0);
958 if (old_type == new_type)
961 if (old_type > new_type)
962 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
963 (int)old_type, (int)new_type);
966 old_body = SvANY(sv);
968 /* Copying structures onto other structures that have been neatly zeroed
969 has a subtle gotcha. Consider XPVMG
971 +------+------+------+------+------+-------+-------+
972 | NV | CUR | LEN | IV | MAGIC | STASH |
973 +------+------+------+------+------+-------+-------+
976 where NVs are aligned to 8 bytes, so that sizeof that structure is
977 actually 32 bytes long, with 4 bytes of padding at the end:
979 +------+------+------+------+------+-------+-------+------+
980 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
981 +------+------+------+------+------+-------+-------+------+
982 0 4 8 12 16 20 24 28 32
984 so what happens if you allocate memory for this structure:
986 +------+------+------+------+------+-------+-------+------+------+...
987 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
988 +------+------+------+------+------+-------+-------+------+------+...
989 0 4 8 12 16 20 24 28 32 36
991 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
992 expect, because you copy the area marked ??? onto GP. Now, ??? may have
993 started out as zero once, but it's quite possible that it isn't. So now,
994 rather than a nicely zeroed GP, you have it pointing somewhere random.
997 (In fact, GP ends up pointing at a previous GP structure, because the
998 principle cause of the padding in XPVMG getting garbage is a copy of
999 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1001 So we are careful and work out the size of used parts of all the
1008 if (new_type < SVt_PVIV) {
1009 new_type = (new_type == SVt_NV)
1010 ? SVt_PVNV : SVt_PVIV;
1011 new_type_details = bodies_by_type + new_type;
1015 if (new_type < SVt_PVNV) {
1016 new_type = SVt_PVNV;
1017 new_type_details = bodies_by_type + new_type;
1023 assert(new_type > SVt_PV);
1024 assert(SVt_IV < SVt_PV);
1025 assert(SVt_NV < SVt_PV);
1032 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1033 there's no way that it can be safely upgraded, because perl.c
1034 expects to Safefree(SvANY(PL_mess_sv)) */
1035 assert(sv != PL_mess_sv);
1036 /* This flag bit is used to mean other things in other scalar types.
1037 Given that it only has meaning inside the pad, it shouldn't be set
1038 on anything that can get upgraded. */
1039 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1042 if (old_type_details->cant_upgrade)
1043 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1046 SvFLAGS(sv) &= ~SVTYPEMASK;
1047 SvFLAGS(sv) |= new_type;
1051 Perl_croak(aTHX_ "Can't upgrade to undef");
1053 assert(old_type == SVt_NULL);
1054 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1058 assert(old_type == SVt_NULL);
1059 SvANY(sv) = new_XNV();
1063 assert(old_type == SVt_NULL);
1064 SvANY(sv) = &sv->sv_u.svu_rv;
1068 SvANY(sv) = new_XPVHV();
1071 HvTOTALKEYS(sv) = 0;
1076 SvANY(sv) = new_XPVAV();
1083 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1084 The target created by newSVrv also is, and it can have magic.
1085 However, it never has SvPVX set.
1087 if (old_type >= SVt_RV) {
1088 assert(SvPVX_const(sv) == 0);
1091 /* Could put this in the else clause below, as PVMG must have SvPVX
1092 0 already (the assertion above) */
1095 if (old_type >= SVt_PVMG) {
1096 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1097 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1099 SvMAGIC_set(sv, NULL);
1100 SvSTASH_set(sv, NULL);
1106 /* XXX Is this still needed? Was it ever needed? Surely as there is
1107 no route from NV to PVIV, NOK can never be true */
1108 assert(!SvNOKp(sv));
1120 assert(new_type_details->size);
1121 /* We always allocated the full length item with PURIFY. To do this
1122 we fake things so that arena is false for all 16 types.. */
1123 if(new_type_details->arena) {
1124 /* This points to the start of the allocated area. */
1125 new_body_inline(new_body, new_type_details->size, new_type);
1126 Zero(new_body, new_type_details->size, char);
1127 new_body = ((char *)new_body) - new_type_details->offset;
1129 new_body = new_NOARENAZ(new_type_details);
1131 SvANY(sv) = new_body;
1133 if (old_type_details->copy) {
1134 Copy((char *)old_body + old_type_details->offset,
1135 (char *)new_body + old_type_details->offset,
1136 old_type_details->copy, char);
1139 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1140 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1141 * correct 0.0 for us. Otherwise, if the old body didn't have an
1142 * NV slot, but the new one does, then we need to initialise the
1143 * freshly created NV slot with whatever the correct bit pattern is
1145 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1149 if (new_type == SVt_PVIO)
1150 IoPAGE_LEN(sv) = 60;
1151 if (old_type < SVt_RV)
1155 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1156 (unsigned long)new_type);
1159 if (old_type_details->size) {
1160 /* If the old body had an allocated size, then we need to free it. */
1162 my_safefree(old_body);
1164 del_body((void*)((char*)old_body + old_type_details->offset),
1165 &PL_body_roots[old_type]);
1171 =for apidoc sv_backoff
1173 Remove any string offset. You should normally use the C<SvOOK_off> macro
1180 Perl_sv_backoff(pTHX_ register SV *sv)
1183 assert(SvTYPE(sv) != SVt_PVHV);
1184 assert(SvTYPE(sv) != SVt_PVAV);
1186 const char * const s = SvPVX_const(sv);
1187 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1188 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1190 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1192 SvFLAGS(sv) &= ~SVf_OOK;
1199 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1200 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1201 Use the C<SvGROW> wrapper instead.
1207 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000) {
1213 PerlIO_printf(Perl_debug_log,
1214 "Allocation too large: %"UVxf"\n", (UV)newlen);
1217 #endif /* HAS_64K_LIMIT */
1220 if (SvTYPE(sv) < SVt_PV) {
1221 sv_upgrade(sv, SVt_PV);
1222 s = SvPVX_mutable(sv);
1224 else if (SvOOK(sv)) { /* pv is offset? */
1226 s = SvPVX_mutable(sv);
1227 if (newlen > SvLEN(sv))
1228 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1229 #ifdef HAS_64K_LIMIT
1230 if (newlen >= 0x10000)
1235 s = SvPVX_mutable(sv);
1237 if (newlen > SvLEN(sv)) { /* need more room? */
1238 newlen = PERL_STRLEN_ROUNDUP(newlen);
1239 if (SvLEN(sv) && s) {
1241 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1247 s = saferealloc(s, newlen);
1250 s = safemalloc(newlen);
1251 if (SvPVX_const(sv) && SvCUR(sv)) {
1252 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1256 SvLEN_set(sv, newlen);
1262 =for apidoc sv_setiv
1264 Copies an integer into the given SV, upgrading first if necessary.
1265 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1271 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1274 SV_CHECK_THINKFIRST_COW_DROP(sv);
1275 switch (SvTYPE(sv)) {
1277 sv_upgrade(sv, SVt_IV);
1280 sv_upgrade(sv, SVt_PVNV);
1284 sv_upgrade(sv, SVt_PVIV);
1293 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1296 (void)SvIOK_only(sv); /* validate number */
1302 =for apidoc sv_setiv_mg
1304 Like C<sv_setiv>, but also handles 'set' magic.
1310 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1317 =for apidoc sv_setuv
1319 Copies an unsigned integer into the given SV, upgrading first if necessary.
1320 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1326 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1328 /* With these two if statements:
1329 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1332 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1334 If you wish to remove them, please benchmark to see what the effect is
1336 if (u <= (UV)IV_MAX) {
1337 sv_setiv(sv, (IV)u);
1346 =for apidoc sv_setuv_mg
1348 Like C<sv_setuv>, but also handles 'set' magic.
1354 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1363 =for apidoc sv_setnv
1365 Copies a double into the given SV, upgrading first if necessary.
1366 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1372 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1375 SV_CHECK_THINKFIRST_COW_DROP(sv);
1376 switch (SvTYPE(sv)) {
1379 sv_upgrade(sv, SVt_NV);
1384 sv_upgrade(sv, SVt_PVNV);
1393 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1397 (void)SvNOK_only(sv); /* validate number */
1402 =for apidoc sv_setnv_mg
1404 Like C<sv_setnv>, but also handles 'set' magic.
1410 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1416 /* Print an "isn't numeric" warning, using a cleaned-up,
1417 * printable version of the offending string
1421 S_not_a_number(pTHX_ SV *sv)
1429 dsv = sv_2mortal(newSVpvs(""));
1430 pv = sv_uni_display(dsv, sv, 10, 0);
1433 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1434 /* each *s can expand to 4 chars + "...\0",
1435 i.e. need room for 8 chars */
1437 const char *s = SvPVX_const(sv);
1438 const char * const end = s + SvCUR(sv);
1439 for ( ; s < end && d < limit; s++ ) {
1441 if (ch & 128 && !isPRINT_LC(ch)) {
1450 else if (ch == '\r') {
1454 else if (ch == '\f') {
1458 else if (ch == '\\') {
1462 else if (ch == '\0') {
1466 else if (isPRINT_LC(ch))
1483 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1484 "Argument \"%s\" isn't numeric in %s", pv,
1487 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1488 "Argument \"%s\" isn't numeric", pv);
1492 =for apidoc looks_like_number
1494 Test if the content of an SV looks like a number (or is a number).
1495 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1496 non-numeric warning), even if your atof() doesn't grok them.
1502 Perl_looks_like_number(pTHX_ SV *sv)
1504 register const char *sbegin;
1508 sbegin = SvPVX_const(sv);
1511 else if (SvPOKp(sv))
1512 sbegin = SvPV_const(sv, len);
1514 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1515 return grok_number(sbegin, len, NULL);
1518 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1519 until proven guilty, assume that things are not that bad... */
1524 As 64 bit platforms often have an NV that doesn't preserve all bits of
1525 an IV (an assumption perl has been based on to date) it becomes necessary
1526 to remove the assumption that the NV always carries enough precision to
1527 recreate the IV whenever needed, and that the NV is the canonical form.
1528 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1529 precision as a side effect of conversion (which would lead to insanity
1530 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1531 1) to distinguish between IV/UV/NV slots that have cached a valid
1532 conversion where precision was lost and IV/UV/NV slots that have a
1533 valid conversion which has lost no precision
1534 2) to ensure that if a numeric conversion to one form is requested that
1535 would lose precision, the precise conversion (or differently
1536 imprecise conversion) is also performed and cached, to prevent
1537 requests for different numeric formats on the same SV causing
1538 lossy conversion chains. (lossless conversion chains are perfectly
1543 SvIOKp is true if the IV slot contains a valid value
1544 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1545 SvNOKp is true if the NV slot contains a valid value
1546 SvNOK is true only if the NV value is accurate
1549 while converting from PV to NV, check to see if converting that NV to an
1550 IV(or UV) would lose accuracy over a direct conversion from PV to
1551 IV(or UV). If it would, cache both conversions, return NV, but mark
1552 SV as IOK NOKp (ie not NOK).
1554 While converting from PV to IV, check to see if converting that IV to an
1555 NV would lose accuracy over a direct conversion from PV to NV. If it
1556 would, cache both conversions, flag similarly.
1558 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1559 correctly because if IV & NV were set NV *always* overruled.
1560 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1561 changes - now IV and NV together means that the two are interchangeable:
1562 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1564 The benefit of this is that operations such as pp_add know that if
1565 SvIOK is true for both left and right operands, then integer addition
1566 can be used instead of floating point (for cases where the result won't
1567 overflow). Before, floating point was always used, which could lead to
1568 loss of precision compared with integer addition.
1570 * making IV and NV equal status should make maths accurate on 64 bit
1572 * may speed up maths somewhat if pp_add and friends start to use
1573 integers when possible instead of fp. (Hopefully the overhead in
1574 looking for SvIOK and checking for overflow will not outweigh the
1575 fp to integer speedup)
1576 * will slow down integer operations (callers of SvIV) on "inaccurate"
1577 values, as the change from SvIOK to SvIOKp will cause a call into
1578 sv_2iv each time rather than a macro access direct to the IV slot
1579 * should speed up number->string conversion on integers as IV is
1580 favoured when IV and NV are equally accurate
1582 ####################################################################
1583 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1584 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1585 On the other hand, SvUOK is true iff UV.
1586 ####################################################################
1588 Your mileage will vary depending your CPU's relative fp to integer
1592 #ifndef NV_PRESERVES_UV
1593 # define IS_NUMBER_UNDERFLOW_IV 1
1594 # define IS_NUMBER_UNDERFLOW_UV 2
1595 # define IS_NUMBER_IV_AND_UV 2
1596 # define IS_NUMBER_OVERFLOW_IV 4
1597 # define IS_NUMBER_OVERFLOW_UV 5
1599 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1601 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1603 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1606 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1607 if (SvNVX(sv) < (NV)IV_MIN) {
1608 (void)SvIOKp_on(sv);
1610 SvIV_set(sv, IV_MIN);
1611 return IS_NUMBER_UNDERFLOW_IV;
1613 if (SvNVX(sv) > (NV)UV_MAX) {
1614 (void)SvIOKp_on(sv);
1617 SvUV_set(sv, UV_MAX);
1618 return IS_NUMBER_OVERFLOW_UV;
1620 (void)SvIOKp_on(sv);
1622 /* Can't use strtol etc to convert this string. (See truth table in
1624 if (SvNVX(sv) <= (UV)IV_MAX) {
1625 SvIV_set(sv, I_V(SvNVX(sv)));
1626 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1627 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1629 /* Integer is imprecise. NOK, IOKp */
1631 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1634 SvUV_set(sv, U_V(SvNVX(sv)));
1635 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1636 if (SvUVX(sv) == UV_MAX) {
1637 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1638 possibly be preserved by NV. Hence, it must be overflow.
1640 return IS_NUMBER_OVERFLOW_UV;
1642 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1644 /* Integer is imprecise. NOK, IOKp */
1646 return IS_NUMBER_OVERFLOW_IV;
1648 #endif /* !NV_PRESERVES_UV*/
1651 S_sv_2iuv_common(pTHX_ SV *sv) {
1654 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1655 * without also getting a cached IV/UV from it at the same time
1656 * (ie PV->NV conversion should detect loss of accuracy and cache
1657 * IV or UV at same time to avoid this. */
1658 /* IV-over-UV optimisation - choose to cache IV if possible */
1660 if (SvTYPE(sv) == SVt_NV)
1661 sv_upgrade(sv, SVt_PVNV);
1663 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1664 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1665 certainly cast into the IV range at IV_MAX, whereas the correct
1666 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1668 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1669 SvIV_set(sv, I_V(SvNVX(sv)));
1670 if (SvNVX(sv) == (NV) SvIVX(sv)
1671 #ifndef NV_PRESERVES_UV
1672 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1673 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1674 /* Don't flag it as "accurately an integer" if the number
1675 came from a (by definition imprecise) NV operation, and
1676 we're outside the range of NV integer precision */
1679 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1680 DEBUG_c(PerlIO_printf(Perl_debug_log,
1681 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1687 /* IV not precise. No need to convert from PV, as NV
1688 conversion would already have cached IV if it detected
1689 that PV->IV would be better than PV->NV->IV
1690 flags already correct - don't set public IOK. */
1691 DEBUG_c(PerlIO_printf(Perl_debug_log,
1692 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1697 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1698 but the cast (NV)IV_MIN rounds to a the value less (more
1699 negative) than IV_MIN which happens to be equal to SvNVX ??
1700 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1701 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1702 (NV)UVX == NVX are both true, but the values differ. :-(
1703 Hopefully for 2s complement IV_MIN is something like
1704 0x8000000000000000 which will be exact. NWC */
1707 SvUV_set(sv, U_V(SvNVX(sv)));
1709 (SvNVX(sv) == (NV) SvUVX(sv))
1710 #ifndef NV_PRESERVES_UV
1711 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1712 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1713 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1714 /* Don't flag it as "accurately an integer" if the number
1715 came from a (by definition imprecise) NV operation, and
1716 we're outside the range of NV integer precision */
1721 DEBUG_c(PerlIO_printf(Perl_debug_log,
1722 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1728 else if (SvPOKp(sv) && SvLEN(sv)) {
1730 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1731 /* We want to avoid a possible problem when we cache an IV/ a UV which
1732 may be later translated to an NV, and the resulting NV is not
1733 the same as the direct translation of the initial string
1734 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1735 be careful to ensure that the value with the .456 is around if the
1736 NV value is requested in the future).
1738 This means that if we cache such an IV/a UV, we need to cache the
1739 NV as well. Moreover, we trade speed for space, and do not
1740 cache the NV if we are sure it's not needed.
1743 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1744 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1745 == IS_NUMBER_IN_UV) {
1746 /* It's definitely an integer, only upgrade to PVIV */
1747 if (SvTYPE(sv) < SVt_PVIV)
1748 sv_upgrade(sv, SVt_PVIV);
1750 } else if (SvTYPE(sv) < SVt_PVNV)
1751 sv_upgrade(sv, SVt_PVNV);
1753 /* If NVs preserve UVs then we only use the UV value if we know that
1754 we aren't going to call atof() below. If NVs don't preserve UVs
1755 then the value returned may have more precision than atof() will
1756 return, even though value isn't perfectly accurate. */
1757 if ((numtype & (IS_NUMBER_IN_UV
1758 #ifdef NV_PRESERVES_UV
1761 )) == IS_NUMBER_IN_UV) {
1762 /* This won't turn off the public IOK flag if it was set above */
1763 (void)SvIOKp_on(sv);
1765 if (!(numtype & IS_NUMBER_NEG)) {
1767 if (value <= (UV)IV_MAX) {
1768 SvIV_set(sv, (IV)value);
1770 /* it didn't overflow, and it was positive. */
1771 SvUV_set(sv, value);
1775 /* 2s complement assumption */
1776 if (value <= (UV)IV_MIN) {
1777 SvIV_set(sv, -(IV)value);
1779 /* Too negative for an IV. This is a double upgrade, but
1780 I'm assuming it will be rare. */
1781 if (SvTYPE(sv) < SVt_PVNV)
1782 sv_upgrade(sv, SVt_PVNV);
1786 SvNV_set(sv, -(NV)value);
1787 SvIV_set(sv, IV_MIN);
1791 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1792 will be in the previous block to set the IV slot, and the next
1793 block to set the NV slot. So no else here. */
1795 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1796 != IS_NUMBER_IN_UV) {
1797 /* It wasn't an (integer that doesn't overflow the UV). */
1798 SvNV_set(sv, Atof(SvPVX_const(sv)));
1800 if (! numtype && ckWARN(WARN_NUMERIC))
1803 #if defined(USE_LONG_DOUBLE)
1804 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1805 PTR2UV(sv), SvNVX(sv)));
1807 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1808 PTR2UV(sv), SvNVX(sv)));
1811 #ifdef NV_PRESERVES_UV
1812 (void)SvIOKp_on(sv);
1814 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1815 SvIV_set(sv, I_V(SvNVX(sv)));
1816 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1819 /* Integer is imprecise. NOK, IOKp */
1821 /* UV will not work better than IV */
1823 if (SvNVX(sv) > (NV)UV_MAX) {
1825 /* Integer is inaccurate. NOK, IOKp, is UV */
1826 SvUV_set(sv, UV_MAX);
1828 SvUV_set(sv, U_V(SvNVX(sv)));
1829 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1830 NV preservse UV so can do correct comparison. */
1831 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1834 /* Integer is imprecise. NOK, IOKp, is UV */
1839 #else /* NV_PRESERVES_UV */
1840 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1841 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1842 /* The IV/UV slot will have been set from value returned by
1843 grok_number above. The NV slot has just been set using
1846 assert (SvIOKp(sv));
1848 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1849 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1850 /* Small enough to preserve all bits. */
1851 (void)SvIOKp_on(sv);
1853 SvIV_set(sv, I_V(SvNVX(sv)));
1854 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1856 /* Assumption: first non-preserved integer is < IV_MAX,
1857 this NV is in the preserved range, therefore: */
1858 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1860 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1864 0 0 already failed to read UV.
1865 0 1 already failed to read UV.
1866 1 0 you won't get here in this case. IV/UV
1867 slot set, public IOK, Atof() unneeded.
1868 1 1 already read UV.
1869 so there's no point in sv_2iuv_non_preserve() attempting
1870 to use atol, strtol, strtoul etc. */
1871 sv_2iuv_non_preserve (sv, numtype);
1874 #endif /* NV_PRESERVES_UV */
1878 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1879 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1882 if (SvTYPE(sv) < SVt_IV)
1883 /* Typically the caller expects that sv_any is not NULL now. */
1884 sv_upgrade(sv, SVt_IV);
1885 /* Return 0 from the caller. */
1892 =for apidoc sv_2iv_flags
1894 Return the integer value of an SV, doing any necessary string
1895 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1896 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1902 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1907 if (SvGMAGICAL(sv)) {
1908 if (flags & SV_GMAGIC)
1913 return I_V(SvNVX(sv));
1915 if (SvPOKp(sv) && SvLEN(sv)) {
1918 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1921 == IS_NUMBER_IN_UV) {
1922 /* It's definitely an integer */
1923 if (numtype & IS_NUMBER_NEG) {
1924 if (value < (UV)IV_MIN)
1927 if (value < (UV)IV_MAX)
1932 if (ckWARN(WARN_NUMERIC))
1935 return I_V(Atof(SvPVX_const(sv)));
1940 assert(SvTYPE(sv) >= SVt_PVMG);
1941 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1942 } else if (SvTHINKFIRST(sv)) {
1946 SV * const tmpstr=AMG_CALLun(sv,numer);
1947 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1948 return SvIV(tmpstr);
1951 return PTR2IV(SvRV(sv));
1954 sv_force_normal_flags(sv, 0);
1956 if (SvREADONLY(sv) && !SvOK(sv)) {
1957 if (ckWARN(WARN_UNINITIALIZED))
1963 if (S_sv_2iuv_common(aTHX_ sv))
1966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1967 PTR2UV(sv),SvIVX(sv)));
1968 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1972 =for apidoc sv_2uv_flags
1974 Return the unsigned integer value of an SV, doing any necessary string
1975 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1976 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1982 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1987 if (SvGMAGICAL(sv)) {
1988 if (flags & SV_GMAGIC)
1993 return U_V(SvNVX(sv));
1994 if (SvPOKp(sv) && SvLEN(sv)) {
1997 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer */
2002 if (!(numtype & IS_NUMBER_NEG))
2006 if (ckWARN(WARN_NUMERIC))
2009 return U_V(Atof(SvPVX_const(sv)));
2014 assert(SvTYPE(sv) >= SVt_PVMG);
2015 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2016 } else if (SvTHINKFIRST(sv)) {
2020 SV *const tmpstr = AMG_CALLun(sv,numer);
2021 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2022 return SvUV(tmpstr);
2025 return PTR2UV(SvRV(sv));
2028 sv_force_normal_flags(sv, 0);
2030 if (SvREADONLY(sv) && !SvOK(sv)) {
2031 if (ckWARN(WARN_UNINITIALIZED))
2037 if (S_sv_2iuv_common(aTHX_ sv))
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2042 PTR2UV(sv),SvUVX(sv)));
2043 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2049 Return the num value of an SV, doing any necessary string or integer
2050 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2057 Perl_sv_2nv(pTHX_ register SV *sv)
2062 if (SvGMAGICAL(sv)) {
2066 if (SvPOKp(sv) && SvLEN(sv)) {
2067 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2068 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2070 return Atof(SvPVX_const(sv));
2074 return (NV)SvUVX(sv);
2076 return (NV)SvIVX(sv);
2081 assert(SvTYPE(sv) >= SVt_PVMG);
2082 /* This falls through to the report_uninit near the end of the
2084 } else if (SvTHINKFIRST(sv)) {
2088 SV *const tmpstr = AMG_CALLun(sv,numer);
2089 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2090 return SvNV(tmpstr);
2093 return PTR2NV(SvRV(sv));
2096 sv_force_normal_flags(sv, 0);
2098 if (SvREADONLY(sv) && !SvOK(sv)) {
2099 if (ckWARN(WARN_UNINITIALIZED))
2104 if (SvTYPE(sv) < SVt_NV) {
2105 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2106 sv_upgrade(sv, SVt_NV);
2107 #ifdef USE_LONG_DOUBLE
2109 STORE_NUMERIC_LOCAL_SET_STANDARD();
2110 PerlIO_printf(Perl_debug_log,
2111 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2112 PTR2UV(sv), SvNVX(sv));
2113 RESTORE_NUMERIC_LOCAL();
2117 STORE_NUMERIC_LOCAL_SET_STANDARD();
2118 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2119 PTR2UV(sv), SvNVX(sv));
2120 RESTORE_NUMERIC_LOCAL();
2124 else if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2130 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2131 #ifdef NV_PRESERVES_UV
2134 /* Only set the public NV OK flag if this NV preserves the IV */
2135 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2136 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2137 : (SvIVX(sv) == I_V(SvNVX(sv))))
2143 else if (SvPOKp(sv) && SvLEN(sv)) {
2145 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2146 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2148 #ifdef NV_PRESERVES_UV
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 == IS_NUMBER_IN_UV) {
2151 /* It's definitely an integer */
2152 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2154 SvNV_set(sv, Atof(SvPVX_const(sv)));
2157 SvNV_set(sv, Atof(SvPVX_const(sv)));
2158 /* Only set the public NV OK flag if this NV preserves the value in
2159 the PV at least as well as an IV/UV would.
2160 Not sure how to do this 100% reliably. */
2161 /* if that shift count is out of range then Configure's test is
2162 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2164 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2165 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2166 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2167 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2168 /* Can't use strtol etc to convert this string, so don't try.
2169 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2172 /* value has been set. It may not be precise. */
2173 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2174 /* 2s complement assumption for (UV)IV_MIN */
2175 SvNOK_on(sv); /* Integer is too negative. */
2180 if (numtype & IS_NUMBER_NEG) {
2181 SvIV_set(sv, -(IV)value);
2182 } else if (value <= (UV)IV_MAX) {
2183 SvIV_set(sv, (IV)value);
2185 SvUV_set(sv, value);
2189 if (numtype & IS_NUMBER_NOT_INT) {
2190 /* I believe that even if the original PV had decimals,
2191 they are lost beyond the limit of the FP precision.
2192 However, neither is canonical, so both only get p
2193 flags. NWC, 2000/11/25 */
2194 /* Both already have p flags, so do nothing */
2196 const NV nv = SvNVX(sv);
2197 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2198 if (SvIVX(sv) == I_V(nv)) {
2201 /* It had no "." so it must be integer. */
2205 /* between IV_MAX and NV(UV_MAX).
2206 Could be slightly > UV_MAX */
2208 if (numtype & IS_NUMBER_NOT_INT) {
2209 /* UV and NV both imprecise. */
2211 const UV nv_as_uv = U_V(nv);
2213 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2222 #endif /* NV_PRESERVES_UV */
2225 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2227 assert (SvTYPE(sv) >= SVt_NV);
2228 /* Typically the caller expects that sv_any is not NULL now. */
2229 /* XXX Ilya implies that this is a bug in callers that assume this
2230 and ideally should be fixed. */
2233 #if defined(USE_LONG_DOUBLE)
2235 STORE_NUMERIC_LOCAL_SET_STANDARD();
2236 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2237 PTR2UV(sv), SvNVX(sv));
2238 RESTORE_NUMERIC_LOCAL();
2242 STORE_NUMERIC_LOCAL_SET_STANDARD();
2243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2244 PTR2UV(sv), SvNVX(sv));
2245 RESTORE_NUMERIC_LOCAL();
2251 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2252 * UV as a string towards the end of buf, and return pointers to start and
2255 * We assume that buf is at least TYPE_CHARS(UV) long.
2259 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2261 char *ptr = buf + TYPE_CHARS(UV);
2262 char * const ebuf = ptr;
2275 *--ptr = '0' + (char)(uv % 10);
2283 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2284 * a regexp to its stringified form.
2288 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2290 const regexp * const re = (regexp *)mg->mg_obj;
2293 const char *fptr = "msix";
2298 bool need_newline = 0;
2299 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2301 while((ch = *fptr++)) {
2303 reflags[left++] = ch;
2306 reflags[right--] = ch;
2311 reflags[left] = '-';
2315 mg->mg_len = re->prelen + 4 + left;
2317 * If /x was used, we have to worry about a regex ending with a
2318 * comment later being embedded within another regex. If so, we don't
2319 * want this regex's "commentization" to leak out to the right part of
2320 * the enclosing regex, we must cap it with a newline.
2322 * So, if /x was used, we scan backwards from the end of the regex. If
2323 * we find a '#' before we find a newline, we need to add a newline
2324 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2325 * we don't need to add anything. -jfriedl
2327 if (PMf_EXTENDED & re->reganch) {
2328 const char *endptr = re->precomp + re->prelen;
2329 while (endptr >= re->precomp) {
2330 const char c = *(endptr--);
2332 break; /* don't need another */
2334 /* we end while in a comment, so we need a newline */
2335 mg->mg_len++; /* save space for it */
2336 need_newline = 1; /* note to add it */
2342 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2343 mg->mg_ptr[0] = '(';
2344 mg->mg_ptr[1] = '?';
2345 Copy(reflags, mg->mg_ptr+2, left, char);
2346 *(mg->mg_ptr+left+2) = ':';
2347 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2349 mg->mg_ptr[mg->mg_len - 2] = '\n';
2350 mg->mg_ptr[mg->mg_len - 1] = ')';
2351 mg->mg_ptr[mg->mg_len] = 0;
2353 PL_reginterp_cnt += re->program[0].next_off;
2355 if (re->reganch & ROPT_UTF8)
2365 =for apidoc sv_2pv_flags
2367 Returns a pointer to the string value of an SV, and sets *lp to its length.
2368 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2370 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2371 usually end up here too.
2377 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2387 if (SvGMAGICAL(sv)) {
2388 if (flags & SV_GMAGIC)
2393 if (flags & SV_MUTABLE_RETURN)
2394 return SvPVX_mutable(sv);
2395 if (flags & SV_CONST_RETURN)
2396 return (char *)SvPVX_const(sv);
2399 if (SvIOKp(sv) || SvNOKp(sv)) {
2400 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2404 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2405 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2407 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2410 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2411 /* Sneaky stuff here */
2412 SV * const tsv = newSVpvn(tbuf, len);
2422 #ifdef FIXNEGATIVEZERO
2423 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2429 SvUPGRADE(sv, SVt_PV);
2432 s = SvGROW_mutable(sv, len + 1);
2435 return memcpy(s, tbuf, len + 1);
2441 assert(SvTYPE(sv) >= SVt_PVMG);
2442 /* This falls through to the report_uninit near the end of the
2444 } else if (SvTHINKFIRST(sv)) {
2448 SV *const tmpstr = AMG_CALLun(sv,string);
2449 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2455 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2456 if (flags & SV_CONST_RETURN) {
2457 pv = (char *) SvPVX_const(tmpstr);
2459 pv = (flags & SV_MUTABLE_RETURN)
2460 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2463 *lp = SvCUR(tmpstr);
2465 pv = sv_2pv_flags(tmpstr, lp, flags);
2477 const SV *const referent = (SV*)SvRV(sv);
2480 tsv = sv_2mortal(newSVpvs("NULLREF"));
2481 } else if (SvTYPE(referent) == SVt_PVMG
2482 && ((SvFLAGS(referent) &
2483 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2484 == (SVs_OBJECT|SVs_SMG))
2485 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2486 return stringify_regexp(sv, mg, lp);
2488 const char *const typestr = sv_reftype(referent, 0);
2490 tsv = sv_newmortal();
2491 if (SvOBJECT(referent)) {
2492 const char *const name = HvNAME_get(SvSTASH(referent));
2493 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2494 name ? name : "__ANON__" , typestr,
2498 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2506 if (SvREADONLY(sv) && !SvOK(sv)) {
2507 if (ckWARN(WARN_UNINITIALIZED))
2514 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2515 /* I'm assuming that if both IV and NV are equally valid then
2516 converting the IV is going to be more efficient */
2517 const U32 isIOK = SvIOK(sv);
2518 const U32 isUIOK = SvIsUV(sv);
2519 char buf[TYPE_CHARS(UV)];
2522 if (SvTYPE(sv) < SVt_PVIV)
2523 sv_upgrade(sv, SVt_PVIV);
2524 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2525 /* inlined from sv_setpvn */
2526 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2527 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2528 SvCUR_set(sv, ebuf - ptr);
2538 else if (SvNOKp(sv)) {
2539 const int olderrno = errno;
2540 if (SvTYPE(sv) < SVt_PVNV)
2541 sv_upgrade(sv, SVt_PVNV);
2542 /* The +20 is pure guesswork. Configure test needed. --jhi */
2543 s = SvGROW_mutable(sv, NV_DIG + 20);
2544 /* some Xenix systems wipe out errno here */
2546 if (SvNVX(sv) == 0.0)
2547 (void)strcpy(s,"0");
2551 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2554 #ifdef FIXNEGATIVEZERO
2555 if (*s == '-' && s[1] == '0' && !s[2])
2565 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2569 if (SvTYPE(sv) < SVt_PV)
2570 /* Typically the caller expects that sv_any is not NULL now. */
2571 sv_upgrade(sv, SVt_PV);
2575 const STRLEN len = s - SvPVX_const(sv);
2581 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2582 PTR2UV(sv),SvPVX_const(sv)));
2583 if (flags & SV_CONST_RETURN)
2584 return (char *)SvPVX_const(sv);
2585 if (flags & SV_MUTABLE_RETURN)
2586 return SvPVX_mutable(sv);
2591 =for apidoc sv_copypv
2593 Copies a stringified representation of the source SV into the
2594 destination SV. Automatically performs any necessary mg_get and
2595 coercion of numeric values into strings. Guaranteed to preserve
2596 UTF-8 flag even from overloaded objects. Similar in nature to
2597 sv_2pv[_flags] but operates directly on an SV instead of just the
2598 string. Mostly uses sv_2pv_flags to do its work, except when that
2599 would lose the UTF-8'ness of the PV.
2605 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2608 const char * const s = SvPV_const(ssv,len);
2609 sv_setpvn(dsv,s,len);
2617 =for apidoc sv_2pvbyte
2619 Return a pointer to the byte-encoded representation of the SV, and set *lp
2620 to its length. May cause the SV to be downgraded from UTF-8 as a
2623 Usually accessed via the C<SvPVbyte> macro.
2629 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2631 sv_utf8_downgrade(sv,0);
2632 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2636 =for apidoc sv_2pvutf8
2638 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2639 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2641 Usually accessed via the C<SvPVutf8> macro.
2647 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2649 sv_utf8_upgrade(sv);
2650 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2655 =for apidoc sv_2bool
2657 This function is only called on magical items, and is only used by
2658 sv_true() or its macro equivalent.
2664 Perl_sv_2bool(pTHX_ register SV *sv)
2673 SV * const tmpsv = AMG_CALLun(sv,bool_);
2674 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2675 return (bool)SvTRUE(tmpsv);
2677 return SvRV(sv) != 0;
2680 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2682 (*sv->sv_u.svu_pv > '0' ||
2683 Xpvtmp->xpv_cur > 1 ||
2684 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2691 return SvIVX(sv) != 0;
2694 return SvNVX(sv) != 0.0;
2702 =for apidoc sv_utf8_upgrade
2704 Converts the PV of an SV to its UTF-8-encoded form.
2705 Forces the SV to string form if it is not already.
2706 Always sets the SvUTF8 flag to avoid future validity checks even
2707 if all the bytes have hibit clear.
2709 This is not as a general purpose byte encoding to Unicode interface:
2710 use the Encode extension for that.
2712 =for apidoc sv_utf8_upgrade_flags
2714 Converts the PV of an SV to its UTF-8-encoded form.
2715 Forces the SV to string form if it is not already.
2716 Always sets the SvUTF8 flag to avoid future validity checks even
2717 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2718 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2719 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2721 This is not as a general purpose byte encoding to Unicode interface:
2722 use the Encode extension for that.
2728 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2731 if (sv == &PL_sv_undef)
2735 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2736 (void) sv_2pv_flags(sv,&len, flags);
2740 (void) SvPV_force(sv,len);
2749 sv_force_normal_flags(sv, 0);
2752 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2753 sv_recode_to_utf8(sv, PL_encoding);
2754 else { /* Assume Latin-1/EBCDIC */
2755 /* This function could be much more efficient if we
2756 * had a FLAG in SVs to signal if there are any hibit
2757 * chars in the PV. Given that there isn't such a flag
2758 * make the loop as fast as possible. */
2759 const U8 * const s = (U8 *) SvPVX_const(sv);
2760 const U8 * const e = (U8 *) SvEND(sv);
2765 /* Check for hi bit */
2766 if (!NATIVE_IS_INVARIANT(ch)) {
2767 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2768 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2770 SvPV_free(sv); /* No longer using what was there before. */
2771 SvPV_set(sv, (char*)recoded);
2772 SvCUR_set(sv, len - 1);
2773 SvLEN_set(sv, len); /* No longer know the real size. */
2777 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2784 =for apidoc sv_utf8_downgrade
2786 Attempts to convert the PV of an SV from characters to bytes.
2787 If the PV contains a character beyond byte, this conversion will fail;
2788 in this case, either returns false or, if C<fail_ok> is not
2791 This is not as a general purpose Unicode to byte encoding interface:
2792 use the Encode extension for that.
2798 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2801 if (SvPOKp(sv) && SvUTF8(sv)) {
2807 sv_force_normal_flags(sv, 0);
2809 s = (U8 *) SvPV(sv, len);
2810 if (!utf8_to_bytes(s, &len)) {
2815 Perl_croak(aTHX_ "Wide character in %s",
2818 Perl_croak(aTHX_ "Wide character");
2829 =for apidoc sv_utf8_encode
2831 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2832 flag off so that it looks like octets again.
2838 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2840 (void) sv_utf8_upgrade(sv);
2842 sv_force_normal_flags(sv, 0);
2844 if (SvREADONLY(sv)) {
2845 Perl_croak(aTHX_ PL_no_modify);
2851 =for apidoc sv_utf8_decode
2853 If the PV of the SV is an octet sequence in UTF-8
2854 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2855 so that it looks like a character. If the PV contains only single-byte
2856 characters, the C<SvUTF8> flag stays being off.
2857 Scans PV for validity and returns false if the PV is invalid UTF-8.
2863 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2869 /* The octets may have got themselves encoded - get them back as
2872 if (!sv_utf8_downgrade(sv, TRUE))
2875 /* it is actually just a matter of turning the utf8 flag on, but
2876 * we want to make sure everything inside is valid utf8 first.
2878 c = (const U8 *) SvPVX_const(sv);
2879 if (!is_utf8_string(c, SvCUR(sv)+1))
2881 e = (const U8 *) SvEND(sv);
2884 if (!UTF8_IS_INVARIANT(ch)) {
2894 =for apidoc sv_setsv
2896 Copies the contents of the source SV C<ssv> into the destination SV
2897 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2898 function if the source SV needs to be reused. Does not handle 'set' magic.
2899 Loosely speaking, it performs a copy-by-value, obliterating any previous
2900 content of the destination.
2902 You probably want to use one of the assortment of wrappers, such as
2903 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2904 C<SvSetMagicSV_nosteal>.
2906 =for apidoc sv_setsv_flags
2908 Copies the contents of the source SV C<ssv> into the destination SV
2909 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2910 function if the source SV needs to be reused. Does not handle 'set' magic.
2911 Loosely speaking, it performs a copy-by-value, obliterating any previous
2912 content of the destination.
2913 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2914 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2915 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2916 and C<sv_setsv_nomg> are implemented in terms of this function.
2918 You probably want to use one of the assortment of wrappers, such as
2919 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2920 C<SvSetMagicSV_nosteal>.
2922 This is the primary function for copying scalars, and most other
2923 copy-ish functions and macros use this underneath.
2929 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
2931 if (dtype != SVt_PVGV) {
2932 const char * const name = GvNAME(sstr);
2933 const STRLEN len = GvNAMELEN(sstr);
2934 /* don't upgrade SVt_PVLV: it can hold a glob */
2935 if (dtype != SVt_PVLV)
2936 sv_upgrade(dstr, SVt_PVGV);
2937 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
2938 GvSTASH(dstr) = GvSTASH(sstr);
2940 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
2941 GvNAME(dstr) = savepvn(name, len);
2942 GvNAMELEN(dstr) = len;
2943 SvFAKE_on(dstr); /* can coerce to non-glob */
2946 #ifdef GV_UNIQUE_CHECK
2947 if (GvUNIQUE((GV*)dstr)) {
2948 Perl_croak(aTHX_ PL_no_modify);
2952 (void)SvOK_off(dstr);
2953 GvINTRO_off(dstr); /* one-shot flag */
2955 GvGP(dstr) = gp_ref(GvGP(sstr));
2956 if (SvTAINTED(sstr))
2958 if (GvIMPORTED(dstr) != GVf_IMPORTED
2959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2961 GvIMPORTED_on(dstr);
2968 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
2969 SV * const sref = SvREFCNT_inc(SvRV(sstr));
2971 const int intro = GvINTRO(dstr);
2973 #ifdef GV_UNIQUE_CHECK
2974 if (GvUNIQUE((GV*)dstr)) {
2975 Perl_croak(aTHX_ PL_no_modify);
2980 GvINTRO_off(dstr); /* one-shot flag */
2981 GvLINE(dstr) = CopLINE(PL_curcop);
2982 GvEGV(dstr) = (GV*)dstr;
2985 switch (SvTYPE(sref)) {
2988 SAVEGENERICSV(GvAV(dstr));
2990 dref = (SV*)GvAV(dstr);
2991 GvAV(dstr) = (AV*)sref;
2992 if (!GvIMPORTED_AV(dstr)
2993 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2995 GvIMPORTED_AV_on(dstr);
3000 SAVEGENERICSV(GvHV(dstr));
3002 dref = (SV*)GvHV(dstr);
3003 GvHV(dstr) = (HV*)sref;
3004 if (!GvIMPORTED_HV(dstr)
3005 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3007 GvIMPORTED_HV_on(dstr);
3012 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3013 SvREFCNT_dec(GvCV(dstr));
3014 GvCV(dstr) = Nullcv;
3015 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3016 PL_sub_generation++;
3018 SAVEGENERICSV(GvCV(dstr));
3021 dref = (SV*)GvCV(dstr);
3022 if (GvCV(dstr) != (CV*)sref) {
3023 CV* const cv = GvCV(dstr);
3025 if (!GvCVGEN((GV*)dstr) &&
3026 (CvROOT(cv) || CvXSUB(cv)))
3028 /* Redefining a sub - warning is mandatory if
3029 it was a const and its value changed. */
3030 if (CvCONST(cv) && CvCONST((CV*)sref)
3031 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3032 /* They are 2 constant subroutines generated from
3033 the same constant. This probably means that
3034 they are really the "same" proxy subroutine
3035 instantiated in 2 places. Most likely this is
3036 when a constant is exported twice. Don't warn.
3039 else if (ckWARN(WARN_REDEFINE)
3041 && (!CvCONST((CV*)sref)
3042 || sv_cmp(cv_const_sv(cv),
3043 cv_const_sv((CV*)sref))))) {
3044 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3046 ? "Constant subroutine %s::%s redefined"
3047 : "Subroutine %s::%s redefined",
3048 HvNAME_get(GvSTASH((GV*)dstr)),
3049 GvENAME((GV*)dstr));
3053 cv_ckproto(cv, (GV*)dstr,
3054 SvPOK(sref) ? SvPVX_const(sref) : Nullch);
3056 GvCV(dstr) = (CV*)sref;
3057 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3058 GvASSUMECV_on(dstr);
3059 PL_sub_generation++;
3061 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3062 GvIMPORTED_CV_on(dstr);
3067 SAVEGENERICSV(GvIOp(dstr));
3069 dref = (SV*)GvIOp(dstr);
3070 GvIOp(dstr) = (IO*)sref;
3074 SAVEGENERICSV(GvFORM(dstr));
3076 dref = (SV*)GvFORM(dstr);
3077 GvFORM(dstr) = (CV*)sref;
3081 SAVEGENERICSV(GvSV(dstr));
3083 dref = (SV*)GvSV(dstr);
3085 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3086 GvIMPORTED_SV_on(dstr);
3092 if (SvTAINTED(sstr))
3098 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3101 register U32 sflags;
3107 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3109 sstr = &PL_sv_undef;
3110 stype = SvTYPE(sstr);
3111 dtype = SvTYPE(dstr);
3116 /* need to nuke the magic */
3118 SvRMAGICAL_off(dstr);
3121 /* There's a lot of redundancy below but we're going for speed here */
3126 if (dtype != SVt_PVGV) {
3127 (void)SvOK_off(dstr);
3135 sv_upgrade(dstr, SVt_IV);
3138 sv_upgrade(dstr, SVt_PVNV);
3142 sv_upgrade(dstr, SVt_PVIV);
3145 (void)SvIOK_only(dstr);
3146 SvIV_set(dstr, SvIVX(sstr));
3149 if (SvTAINTED(sstr))
3160 sv_upgrade(dstr, SVt_NV);
3165 sv_upgrade(dstr, SVt_PVNV);
3168 SvNV_set(dstr, SvNVX(sstr));
3169 (void)SvNOK_only(dstr);
3170 if (SvTAINTED(sstr))
3178 sv_upgrade(dstr, SVt_RV);
3179 else if (dtype == SVt_PVGV &&
3180 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3183 if (GvIMPORTED(dstr) != GVf_IMPORTED
3184 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3186 GvIMPORTED_on(dstr);
3191 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3195 #ifdef PERL_OLD_COPY_ON_WRITE
3196 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3197 if (dtype < SVt_PVIV)
3198 sv_upgrade(dstr, SVt_PVIV);
3205 sv_upgrade(dstr, SVt_PV);
3208 if (dtype < SVt_PVIV)
3209 sv_upgrade(dstr, SVt_PVIV);
3212 if (dtype < SVt_PVNV)
3213 sv_upgrade(dstr, SVt_PVNV);
3220 const char * const type = sv_reftype(sstr,0);
3222 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3224 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3229 if (dtype <= SVt_PVGV) {
3230 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3235 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3237 if ((int)SvTYPE(sstr) != stype) {
3238 stype = SvTYPE(sstr);
3239 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3240 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3243 if (stype == SVt_PVLV)
3244 SvUPGRADE(dstr, SVt_PVNV);
3246 SvUPGRADE(dstr, (U32)stype);
3249 sflags = SvFLAGS(sstr);
3251 if (sflags & SVf_ROK) {
3252 if (dtype >= SVt_PV) {
3253 if (dtype == SVt_PVGV)
3254 return S_pvgv_assign(aTHX_ dstr, sstr);
3255 if (SvPVX_const(dstr)) {
3261 (void)SvOK_off(dstr);
3262 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3264 if (sflags & SVp_NOK) {
3266 /* Only set the public OK flag if the source has public OK. */
3267 if (sflags & SVf_NOK)
3268 SvFLAGS(dstr) |= SVf_NOK;
3269 SvNV_set(dstr, SvNVX(sstr));
3271 if (sflags & SVp_IOK) {
3272 (void)SvIOKp_on(dstr);
3273 if (sflags & SVf_IOK)
3274 SvFLAGS(dstr) |= SVf_IOK;
3275 if (sflags & SVf_IVisUV)
3277 SvIV_set(dstr, SvIVX(sstr));
3279 if (SvAMAGIC(sstr)) {
3283 else if (sflags & SVp_POK) {
3287 * Check to see if we can just swipe the string. If so, it's a
3288 * possible small lose on short strings, but a big win on long ones.
3289 * It might even be a win on short strings if SvPVX_const(dstr)
3290 * has to be allocated and SvPVX_const(sstr) has to be freed.
3293 /* Whichever path we take through the next code, we want this true,
3294 and doing it now facilitates the COW check. */
3295 (void)SvPOK_only(dstr);
3298 /* We're not already COW */
3299 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3300 #ifndef PERL_OLD_COPY_ON_WRITE
3301 /* or we are, but dstr isn't a suitable target. */
3302 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3307 (sflags & SVs_TEMP) && /* slated for free anyway? */
3308 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3309 (!(flags & SV_NOSTEAL)) &&
3310 /* and we're allowed to steal temps */
3311 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3312 SvLEN(sstr) && /* and really is a string */
3313 /* and won't be needed again, potentially */
3314 !(PL_op && PL_op->op_type == OP_AASSIGN))
3315 #ifdef PERL_OLD_COPY_ON_WRITE
3316 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3317 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3318 && SvTYPE(sstr) >= SVt_PVIV)
3321 /* Failed the swipe test, and it's not a shared hash key either.
3322 Have to copy the string. */
3323 STRLEN len = SvCUR(sstr);
3324 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3325 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3326 SvCUR_set(dstr, len);
3327 *SvEND(dstr) = '\0';
3329 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3331 /* Either it's a shared hash key, or it's suitable for
3332 copy-on-write or we can swipe the string. */
3334 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3338 #ifdef PERL_OLD_COPY_ON_WRITE
3340 /* I believe I should acquire a global SV mutex if
3341 it's a COW sv (not a shared hash key) to stop
3342 it going un copy-on-write.
3343 If the source SV has gone un copy on write between up there
3344 and down here, then (assert() that) it is of the correct
3345 form to make it copy on write again */
3346 if ((sflags & (SVf_FAKE | SVf_READONLY))
3347 != (SVf_FAKE | SVf_READONLY)) {
3348 SvREADONLY_on(sstr);
3350 /* Make the source SV into a loop of 1.
3351 (about to become 2) */
3352 SV_COW_NEXT_SV_SET(sstr, sstr);
3356 /* Initial code is common. */
3357 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3362 /* making another shared SV. */
3363 STRLEN cur = SvCUR(sstr);
3364 STRLEN len = SvLEN(sstr);
3365 #ifdef PERL_OLD_COPY_ON_WRITE
3367 assert (SvTYPE(dstr) >= SVt_PVIV);
3368 /* SvIsCOW_normal */
3369 /* splice us in between source and next-after-source. */
3370 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3371 SV_COW_NEXT_SV_SET(sstr, dstr);
3372 SvPV_set(dstr, SvPVX_mutable(sstr));
3376 /* SvIsCOW_shared_hash */
3377 DEBUG_C(PerlIO_printf(Perl_debug_log,
3378 "Copy on write: Sharing hash\n"));
3380 assert (SvTYPE(dstr) >= SVt_PV);
3382 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3384 SvLEN_set(dstr, len);
3385 SvCUR_set(dstr, cur);
3386 SvREADONLY_on(dstr);
3388 /* Relesase a global SV mutex. */
3391 { /* Passes the swipe test. */
3392 SvPV_set(dstr, SvPVX_mutable(sstr));
3393 SvLEN_set(dstr, SvLEN(sstr));
3394 SvCUR_set(dstr, SvCUR(sstr));
3397 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3398 SvPV_set(sstr, NULL);
3404 if (sflags & SVf_UTF8)
3406 if (sflags & SVp_NOK) {
3408 if (sflags & SVf_NOK)
3409 SvFLAGS(dstr) |= SVf_NOK;
3410 SvNV_set(dstr, SvNVX(sstr));
3412 if (sflags & SVp_IOK) {
3413 (void)SvIOKp_on(dstr);
3414 if (sflags & SVf_IOK)
3415 SvFLAGS(dstr) |= SVf_IOK;
3416 if (sflags & SVf_IVisUV)
3418 SvIV_set(dstr, SvIVX(sstr));
3421 const MAGIC * const smg = SvVOK(sstr);
3423 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3424 smg->mg_ptr, smg->mg_len);
3425 SvRMAGICAL_on(dstr);
3429 else if (sflags & SVp_IOK) {
3430 if (sflags & SVf_IOK)
3431 (void)SvIOK_only(dstr);
3433 (void)SvOK_off(dstr);
3434 (void)SvIOKp_on(dstr);
3436 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3437 if (sflags & SVf_IVisUV)
3439 SvIV_set(dstr, SvIVX(sstr));
3440 if (sflags & SVp_NOK) {
3441 if (sflags & SVf_NOK)
3442 (void)SvNOK_on(dstr);
3444 (void)SvNOKp_on(dstr);
3445 SvNV_set(dstr, SvNVX(sstr));
3448 else if (sflags & SVp_NOK) {
3449 if (sflags & SVf_NOK)
3450 (void)SvNOK_only(dstr);
3452 (void)SvOK_off(dstr);
3455 SvNV_set(dstr, SvNVX(sstr));
3458 if (dtype == SVt_PVGV) {
3459 if (ckWARN(WARN_MISC))
3460 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3463 (void)SvOK_off(dstr);
3465 if (SvTAINTED(sstr))
3470 =for apidoc sv_setsv_mg
3472 Like C<sv_setsv>, but also handles 'set' magic.
3478 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3480 sv_setsv(dstr,sstr);
3484 #ifdef PERL_OLD_COPY_ON_WRITE
3486 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3488 STRLEN cur = SvCUR(sstr);
3489 STRLEN len = SvLEN(sstr);
3490 register char *new_pv;
3493 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3501 if (SvTHINKFIRST(dstr))
3502 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3503 else if (SvPVX_const(dstr))
3504 Safefree(SvPVX_const(dstr));
3508 SvUPGRADE(dstr, SVt_PVIV);
3510 assert (SvPOK(sstr));
3511 assert (SvPOKp(sstr));
3512 assert (!SvIOK(sstr));
3513 assert (!SvIOKp(sstr));
3514 assert (!SvNOK(sstr));
3515 assert (!SvNOKp(sstr));
3517 if (SvIsCOW(sstr)) {
3519 if (SvLEN(sstr) == 0) {
3520 /* source is a COW shared hash key. */
3521 DEBUG_C(PerlIO_printf(Perl_debug_log,
3522 "Fast copy on write: Sharing hash\n"));
3523 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3526 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3528 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3529 SvUPGRADE(sstr, SVt_PVIV);
3530 SvREADONLY_on(sstr);
3532 DEBUG_C(PerlIO_printf(Perl_debug_log,
3533 "Fast copy on write: Converting sstr to COW\n"));
3534 SV_COW_NEXT_SV_SET(dstr, sstr);
3536 SV_COW_NEXT_SV_SET(sstr, dstr);
3537 new_pv = SvPVX_mutable(sstr);
3540 SvPV_set(dstr, new_pv);
3541 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3544 SvLEN_set(dstr, len);
3545 SvCUR_set(dstr, cur);
3554 =for apidoc sv_setpvn
3556 Copies a string into an SV. The C<len> parameter indicates the number of
3557 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3558 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3564 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3567 register char *dptr;
3569 SV_CHECK_THINKFIRST_COW_DROP(sv);
3575 /* len is STRLEN which is unsigned, need to copy to signed */
3578 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3580 SvUPGRADE(sv, SVt_PV);
3582 dptr = SvGROW(sv, len + 1);
3583 Move(ptr,dptr,len,char);
3586 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3591 =for apidoc sv_setpvn_mg
3593 Like C<sv_setpvn>, but also handles 'set' magic.
3599 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3601 sv_setpvn(sv,ptr,len);
3606 =for apidoc sv_setpv
3608 Copies a string into an SV. The string must be null-terminated. Does not
3609 handle 'set' magic. See C<sv_setpv_mg>.
3615 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3618 register STRLEN len;
3620 SV_CHECK_THINKFIRST_COW_DROP(sv);
3626 SvUPGRADE(sv, SVt_PV);
3628 SvGROW(sv, len + 1);
3629 Move(ptr,SvPVX(sv),len+1,char);
3631 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3636 =for apidoc sv_setpv_mg
3638 Like C<sv_setpv>, but also handles 'set' magic.
3644 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3651 =for apidoc sv_usepvn
3653 Tells an SV to use C<ptr> to find its string value. Normally the string is
3654 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3655 The C<ptr> should point to memory that was allocated by C<malloc>. The
3656 string length, C<len>, must be supplied. This function will realloc the
3657 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3658 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3659 See C<sv_usepvn_mg>.
3665 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3669 SV_CHECK_THINKFIRST_COW_DROP(sv);
3670 SvUPGRADE(sv, SVt_PV);
3675 if (SvPVX_const(sv))
3678 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3679 ptr = saferealloc (ptr, allocate);
3682 SvLEN_set(sv, allocate);
3684 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3689 =for apidoc sv_usepvn_mg
3691 Like C<sv_usepvn>, but also handles 'set' magic.
3697 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3699 sv_usepvn(sv,ptr,len);
3703 #ifdef PERL_OLD_COPY_ON_WRITE
3704 /* Need to do this *after* making the SV normal, as we need the buffer
3705 pointer to remain valid until after we've copied it. If we let go too early,
3706 another thread could invalidate it by unsharing last of the same hash key
3707 (which it can do by means other than releasing copy-on-write Svs)
3708 or by changing the other copy-on-write SVs in the loop. */
3710 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3712 if (len) { /* this SV was SvIsCOW_normal(sv) */
3713 /* we need to find the SV pointing to us. */
3714 SV * const current = SV_COW_NEXT_SV(after);
3716 if (current == sv) {
3717 /* The SV we point to points back to us (there were only two of us
3719 Hence other SV is no longer copy on write either. */
3721 SvREADONLY_off(after);
3723 /* We need to follow the pointers around the loop. */
3725 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3728 /* don't loop forever if the structure is bust, and we have
3729 a pointer into a closed loop. */
3730 assert (current != after);
3731 assert (SvPVX_const(current) == pvx);
3733 /* Make the SV before us point to the SV after us. */
3734 SV_COW_NEXT_SV_SET(current, after);
3737 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3742 Perl_sv_release_IVX(pTHX_ register SV *sv)
3745 sv_force_normal_flags(sv, 0);
3751 =for apidoc sv_force_normal_flags
3753 Undo various types of fakery on an SV: if the PV is a shared string, make
3754 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3755 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3756 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3757 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3758 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3759 set to some other value.) In addition, the C<flags> parameter gets passed to
3760 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3761 with flags set to 0.
3767 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3770 #ifdef PERL_OLD_COPY_ON_WRITE
3771 if (SvREADONLY(sv)) {
3772 /* At this point I believe I should acquire a global SV mutex. */
3774 const char * const pvx = SvPVX_const(sv);
3775 const STRLEN len = SvLEN(sv);
3776 const STRLEN cur = SvCUR(sv);
3777 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3779 PerlIO_printf(Perl_debug_log,
3780 "Copy on write: Force normal %ld\n",
3786 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3789 if (flags & SV_COW_DROP_PV) {
3790 /* OK, so we don't need to copy our buffer. */
3793 SvGROW(sv, cur + 1);
3794 Move(pvx,SvPVX(sv),cur,char);
3798 sv_release_COW(sv, pvx, len, next);
3803 else if (IN_PERL_RUNTIME)
3804 Perl_croak(aTHX_ PL_no_modify);
3805 /* At this point I believe that I can drop the global SV mutex. */
3808 if (SvREADONLY(sv)) {
3810 const char * const pvx = SvPVX_const(sv);
3811 const STRLEN len = SvCUR(sv);
3814 SvPV_set(sv, Nullch);
3816 SvGROW(sv, len + 1);
3817 Move(pvx,SvPVX(sv),len,char);
3819 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3821 else if (IN_PERL_RUNTIME)
3822 Perl_croak(aTHX_ PL_no_modify);
3826 sv_unref_flags(sv, flags);
3827 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3834 Efficient removal of characters from the beginning of the string buffer.
3835 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3836 the string buffer. The C<ptr> becomes the first character of the adjusted
3837 string. Uses the "OOK hack".
3838 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3839 refer to the same chunk of data.
3845 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3847 register STRLEN delta;
3848 if (!ptr || !SvPOKp(sv))
3850 delta = ptr - SvPVX_const(sv);
3851 SV_CHECK_THINKFIRST(sv);
3852 if (SvTYPE(sv) < SVt_PVIV)
3853 sv_upgrade(sv,SVt_PVIV);
3856 if (!SvLEN(sv)) { /* make copy of shared string */
3857 const char *pvx = SvPVX_const(sv);
3858 const STRLEN len = SvCUR(sv);
3859 SvGROW(sv, len + 1);
3860 Move(pvx,SvPVX(sv),len,char);
3864 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3865 and we do that anyway inside the SvNIOK_off
3867 SvFLAGS(sv) |= SVf_OOK;
3870 SvLEN_set(sv, SvLEN(sv) - delta);
3871 SvCUR_set(sv, SvCUR(sv) - delta);
3872 SvPV_set(sv, SvPVX(sv) + delta);
3873 SvIV_set(sv, SvIVX(sv) + delta);
3877 =for apidoc sv_catpvn
3879 Concatenates the string onto the end of the string which is in the SV. The
3880 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3881 status set, then the bytes appended should be valid UTF-8.
3882 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3884 =for apidoc sv_catpvn_flags
3886 Concatenates the string onto the end of the string which is in the SV. The
3887 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3888 status set, then the bytes appended should be valid UTF-8.
3889 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3890 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3891 in terms of this function.
3897 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3901 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3903 SvGROW(dsv, dlen + slen + 1);
3905 sstr = SvPVX_const(dsv);
3906 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3907 SvCUR_set(dsv, SvCUR(dsv) + slen);
3909 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3911 if (flags & SV_SMAGIC)
3916 =for apidoc sv_catsv
3918 Concatenates the string from SV C<ssv> onto the end of the string in
3919 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3920 not 'set' magic. See C<sv_catsv_mg>.
3922 =for apidoc sv_catsv_flags
3924 Concatenates the string from SV C<ssv> onto the end of the string in
3925 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3926 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3927 and C<sv_catsv_nomg> are implemented in terms of this function.
3932 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3937 const char *spv = SvPV_const(ssv, slen);
3939 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3940 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3941 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3942 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3943 dsv->sv_flags doesn't have that bit set.
3944 Andy Dougherty 12 Oct 2001
3946 const I32 sutf8 = DO_UTF8(ssv);
3949 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3951 dutf8 = DO_UTF8(dsv);
3953 if (dutf8 != sutf8) {
3955 /* Not modifying source SV, so taking a temporary copy. */
3956 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3958 sv_utf8_upgrade(csv);
3959 spv = SvPV_const(csv, slen);
3962 sv_utf8_upgrade_nomg(dsv);
3964 sv_catpvn_nomg(dsv, spv, slen);
3967 if (flags & SV_SMAGIC)
3972 =for apidoc sv_catpv
3974 Concatenates the string onto the end of the string which is in the SV.
3975 If the SV has the UTF-8 status set, then the bytes appended should be
3976 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3981 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3984 register STRLEN len;
3990 junk = SvPV_force(sv, tlen);
3992 SvGROW(sv, tlen + len + 1);
3994 ptr = SvPVX_const(sv);
3995 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3996 SvCUR_set(sv, SvCUR(sv) + len);
3997 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4002 =for apidoc sv_catpv_mg
4004 Like C<sv_catpv>, but also handles 'set' magic.
4010 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4019 Creates a new SV. A non-zero C<len> parameter indicates the number of
4020 bytes of preallocated string space the SV should have. An extra byte for a
4021 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4022 space is allocated.) The reference count for the new SV is set to 1.
4024 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4025 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4026 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4027 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4028 modules supporting older perls.
4034 Perl_newSV(pTHX_ STRLEN len)
4041 sv_upgrade(sv, SVt_PV);
4042 SvGROW(sv, len + 1);
4047 =for apidoc sv_magicext
4049 Adds magic to an SV, upgrading it if necessary. Applies the
4050 supplied vtable and returns a pointer to the magic added.
4052 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4053 In particular, you can add magic to SvREADONLY SVs, and add more than
4054 one instance of the same 'how'.
4056 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4057 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4058 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4059 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4061 (This is now used as a subroutine by C<sv_magic>.)
4066 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4067 const char* name, I32 namlen)
4072 if (SvTYPE(sv) < SVt_PVMG) {
4073 SvUPGRADE(sv, SVt_PVMG);
4075 Newxz(mg, 1, MAGIC);
4076 mg->mg_moremagic = SvMAGIC(sv);
4077 SvMAGIC_set(sv, mg);
4079 /* Sometimes a magic contains a reference loop, where the sv and
4080 object refer to each other. To prevent a reference loop that
4081 would prevent such objects being freed, we look for such loops
4082 and if we find one we avoid incrementing the object refcount.
4084 Note we cannot do this to avoid self-tie loops as intervening RV must
4085 have its REFCNT incremented to keep it in existence.
4088 if (!obj || obj == sv ||
4089 how == PERL_MAGIC_arylen ||
4090 how == PERL_MAGIC_qr ||
4091 how == PERL_MAGIC_symtab ||
4092 (SvTYPE(obj) == SVt_PVGV &&
4093 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4094 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4095 GvFORM(obj) == (CV*)sv)))
4100 mg->mg_obj = SvREFCNT_inc(obj);
4101 mg->mg_flags |= MGf_REFCOUNTED;
4104 /* Normal self-ties simply pass a null object, and instead of
4105 using mg_obj directly, use the SvTIED_obj macro to produce a
4106 new RV as needed. For glob "self-ties", we are tieing the PVIO
4107 with an RV obj pointing to the glob containing the PVIO. In
4108 this case, to avoid a reference loop, we need to weaken the
4112 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4113 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4119 mg->mg_len = namlen;
4122 mg->mg_ptr = savepvn(name, namlen);
4123 else if (namlen == HEf_SVKEY)
4124 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4126 mg->mg_ptr = (char *) name;
4128 mg->mg_virtual = vtable;
4132 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4137 =for apidoc sv_magic
4139 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4140 then adds a new magic item of type C<how> to the head of the magic list.
4142 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4143 handling of the C<name> and C<namlen> arguments.
4145 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4146 to add more than one instance of the same 'how'.
4152 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4158 #ifdef PERL_OLD_COPY_ON_WRITE
4160 sv_force_normal_flags(sv, 0);
4162 if (SvREADONLY(sv)) {
4164 /* its okay to attach magic to shared strings; the subsequent
4165 * upgrade to PVMG will unshare the string */
4166 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4169 && how != PERL_MAGIC_regex_global
4170 && how != PERL_MAGIC_bm
4171 && how != PERL_MAGIC_fm
4172 && how != PERL_MAGIC_sv
4173 && how != PERL_MAGIC_backref
4176 Perl_croak(aTHX_ PL_no_modify);
4179 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4180 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4181 /* sv_magic() refuses to add a magic of the same 'how' as an
4184 if (how == PERL_MAGIC_taint)
4192 vtable = &PL_vtbl_sv;
4194 case PERL_MAGIC_overload:
4195 vtable = &PL_vtbl_amagic;
4197 case PERL_MAGIC_overload_elem:
4198 vtable = &PL_vtbl_amagicelem;
4200 case PERL_MAGIC_overload_table:
4201 vtable = &PL_vtbl_ovrld;
4204 vtable = &PL_vtbl_bm;
4206 case PERL_MAGIC_regdata:
4207 vtable = &PL_vtbl_regdata;
4209 case PERL_MAGIC_regdatum:
4210 vtable = &PL_vtbl_regdatum;
4212 case PERL_MAGIC_env:
4213 vtable = &PL_vtbl_env;
4216 vtable = &PL_vtbl_fm;
4218 case PERL_MAGIC_envelem:
4219 vtable = &PL_vtbl_envelem;
4221 case PERL_MAGIC_regex_global:
4222 vtable = &PL_vtbl_mglob;
4224 case PERL_MAGIC_isa:
4225 vtable = &PL_vtbl_isa;
4227 case PERL_MAGIC_isaelem:
4228 vtable = &PL_vtbl_isaelem;
4230 case PERL_MAGIC_nkeys:
4231 vtable = &PL_vtbl_nkeys;
4233 case PERL_MAGIC_dbfile:
4236 case PERL_MAGIC_dbline:
4237 vtable = &PL_vtbl_dbline;
4239 #ifdef USE_LOCALE_COLLATE
4240 case PERL_MAGIC_collxfrm:
4241 vtable = &PL_vtbl_collxfrm;
4243 #endif /* USE_LOCALE_COLLATE */
4244 case PERL_MAGIC_tied:
4245 vtable = &PL_vtbl_pack;
4247 case PERL_MAGIC_tiedelem:
4248 case PERL_MAGIC_tiedscalar:
4249 vtable = &PL_vtbl_packelem;
4252 vtable = &PL_vtbl_regexp;
4254 case PERL_MAGIC_sig:
4255 vtable = &PL_vtbl_sig;
4257 case PERL_MAGIC_sigelem:
4258 vtable = &PL_vtbl_sigelem;
4260 case PERL_MAGIC_taint:
4261 vtable = &PL_vtbl_taint;
4263 case PERL_MAGIC_uvar:
4264 vtable = &PL_vtbl_uvar;
4266 case PERL_MAGIC_vec:
4267 vtable = &PL_vtbl_vec;
4269 case PERL_MAGIC_arylen_p:
4270 case PERL_MAGIC_rhash:
4271 case PERL_MAGIC_symtab:
4272 case PERL_MAGIC_vstring:
4275 case PERL_MAGIC_utf8:
4276 vtable = &PL_vtbl_utf8;
4278 case PERL_MAGIC_substr:
4279 vtable = &PL_vtbl_substr;
4281 case PERL_MAGIC_defelem:
4282 vtable = &PL_vtbl_defelem;
4284 case PERL_MAGIC_glob:
4285 vtable = &PL_vtbl_glob;
4287 case PERL_MAGIC_arylen:
4288 vtable = &PL_vtbl_arylen;
4290 case PERL_MAGIC_pos:
4291 vtable = &PL_vtbl_pos;
4293 case PERL_MAGIC_backref:
4294 vtable = &PL_vtbl_backref;
4296 case PERL_MAGIC_ext:
4297 /* Reserved for use by extensions not perl internals. */
4298 /* Useful for attaching extension internal data to perl vars. */
4299 /* Note that multiple extensions may clash if magical scalars */
4300 /* etc holding private data from one are passed to another. */
4304 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4307 /* Rest of work is done else where */
4308 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4311 case PERL_MAGIC_taint:
4314 case PERL_MAGIC_ext:
4315 case PERL_MAGIC_dbfile:
4322 =for apidoc sv_unmagic
4324 Removes all magic of type C<type> from an SV.
4330 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4334 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4337 for (mg = *mgp; mg; mg = *mgp) {
4338 if (mg->mg_type == type) {
4339 const MGVTBL* const vtbl = mg->mg_virtual;
4340 *mgp = mg->mg_moremagic;
4341 if (vtbl && vtbl->svt_free)
4342 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4343 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4345 Safefree(mg->mg_ptr);
4346 else if (mg->mg_len == HEf_SVKEY)
4347 SvREFCNT_dec((SV*)mg->mg_ptr);
4348 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4349 Safefree(mg->mg_ptr);
4351 if (mg->mg_flags & MGf_REFCOUNTED)
4352 SvREFCNT_dec(mg->mg_obj);
4356 mgp = &mg->mg_moremagic;
4360 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4361 SvMAGIC_set(sv, NULL);
4368 =for apidoc sv_rvweaken
4370 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4371 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4372 push a back-reference to this RV onto the array of backreferences
4373 associated with that magic.
4379 Perl_sv_rvweaken(pTHX_ SV *sv)
4382 if (!SvOK(sv)) /* let undefs pass */
4385 Perl_croak(aTHX_ "Can't weaken a nonreference");
4386 else if (SvWEAKREF(sv)) {
4387 if (ckWARN(WARN_MISC))
4388 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4392 Perl_sv_add_backref(aTHX_ tsv, sv);
4398 /* Give tsv backref magic if it hasn't already got it, then push a
4399 * back-reference to sv onto the array associated with the backref magic.
4403 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4408 if (SvTYPE(tsv) == SVt_PVHV) {
4409 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4413 /* There is no AV in the offical place - try a fixup. */
4414 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4417 /* Aha. They've got it stowed in magic. Bring it back. */
4418 av = (AV*)mg->mg_obj;
4419 /* Stop mg_free decreasing the refernce count. */
4421 /* Stop mg_free even calling the destructor, given that
4422 there's no AV to free up. */
4424 sv_unmagic(tsv, PERL_MAGIC_backref);
4433 const MAGIC *const mg
4434 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4436 av = (AV*)mg->mg_obj;
4440 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4441 /* av now has a refcnt of 2, which avoids it getting freed
4442 * before us during global cleanup. The extra ref is removed
4443 * by magic_killbackrefs() when tsv is being freed */
4446 if (AvFILLp(av) >= AvMAX(av)) {
4447 av_extend(av, AvFILLp(av)+1);
4449 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4452 /* delete a back-reference to ourselves from the backref magic associated
4453 * with the SV we point to.
4457 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4464 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4465 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4466 /* We mustn't attempt to "fix up" the hash here by moving the
4467 backreference array back to the hv_aux structure, as that is stored
4468 in the main HvARRAY(), and hfreentries assumes that no-one
4469 reallocates HvARRAY() while it is running. */
4472 const MAGIC *const mg
4473 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4475 av = (AV *)mg->mg_obj;
4478 if (PL_in_clean_all)
4480 Perl_croak(aTHX_ "panic: del_backref");
4487 /* We shouldn't be in here more than once, but for paranoia reasons lets
4489 for (i = AvFILLp(av); i >= 0; i--) {
4491 const SSize_t fill = AvFILLp(av);
4493 /* We weren't the last entry.
4494 An unordered list has this property that you can take the
4495 last element off the end to fill the hole, and it's still
4496 an unordered list :-)
4501 AvFILLp(av) = fill - 1;
4507 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4509 SV **svp = AvARRAY(av);
4511 PERL_UNUSED_ARG(sv);
4513 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4514 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4515 if (svp && !SvIS_FREED(av)) {
4516 SV *const *const last = svp + AvFILLp(av);
4518 while (svp <= last) {
4520 SV *const referrer = *svp;
4521 if (SvWEAKREF(referrer)) {
4522 /* XXX Should we check that it hasn't changed? */
4523 SvRV_set(referrer, 0);
4525 SvWEAKREF_off(referrer);
4526 } else if (SvTYPE(referrer) == SVt_PVGV ||
4527 SvTYPE(referrer) == SVt_PVLV) {
4528 /* You lookin' at me? */
4529 assert(GvSTASH(referrer));
4530 assert(GvSTASH(referrer) == (HV*)sv);
4531 GvSTASH(referrer) = 0;
4534 "panic: magic_killbackrefs (flags=%"UVxf")",
4535 (UV)SvFLAGS(referrer));
4543 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4548 =for apidoc sv_insert
4550 Inserts a string at the specified offset/length within the SV. Similar to
4551 the Perl substr() function.
4557 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4562 register char *midend;
4563 register char *bigend;
4569 Perl_croak(aTHX_ "Can't modify non-existent substring");
4570 SvPV_force(bigstr, curlen);
4571 (void)SvPOK_only_UTF8(bigstr);
4572 if (offset + len > curlen) {
4573 SvGROW(bigstr, offset+len+1);
4574 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4575 SvCUR_set(bigstr, offset+len);
4579 i = littlelen - len;
4580 if (i > 0) { /* string might grow */
4581 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4582 mid = big + offset + len;
4583 midend = bigend = big + SvCUR(bigstr);
4586 while (midend > mid) /* shove everything down */
4587 *--bigend = *--midend;
4588 Move(little,big+offset,littlelen,char);
4589 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4594 Move(little,SvPVX(bigstr)+offset,len,char);
4599 big = SvPVX(bigstr);
4602 bigend = big + SvCUR(bigstr);
4604 if (midend > bigend)
4605 Perl_croak(aTHX_ "panic: sv_insert");
4607 if (mid - big > bigend - midend) { /* faster to shorten from end */
4609 Move(little, mid, littlelen,char);
4612 i = bigend - midend;
4614 Move(midend, mid, i,char);
4618 SvCUR_set(bigstr, mid - big);
4620 else if ((i = mid - big)) { /* faster from front */
4621 midend -= littlelen;
4623 sv_chop(bigstr,midend-i);
4628 Move(little, mid, littlelen,char);
4630 else if (littlelen) {
4631 midend -= littlelen;
4632 sv_chop(bigstr,midend);
4633 Move(little,midend,littlelen,char);
4636 sv_chop(bigstr,midend);
4642 =for apidoc sv_replace
4644 Make the first argument a copy of the second, then delete the original.
4645 The target SV physically takes over ownership of the body of the source SV
4646 and inherits its flags; however, the target keeps any magic it owns,
4647 and any magic in the source is discarded.
4648 Note that this is a rather specialist SV copying operation; most of the
4649 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4655 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4658 const U32 refcnt = SvREFCNT(sv);
4659 SV_CHECK_THINKFIRST_COW_DROP(sv);
4660 if (SvREFCNT(nsv) != 1) {
4661 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4662 UVuf " != 1)", (UV) SvREFCNT(nsv));
4664 if (SvMAGICAL(sv)) {
4668 sv_upgrade(nsv, SVt_PVMG);
4669 SvMAGIC_set(nsv, SvMAGIC(sv));
4670 SvFLAGS(nsv) |= SvMAGICAL(sv);
4672 SvMAGIC_set(sv, NULL);
4676 assert(!SvREFCNT(sv));
4677 #ifdef DEBUG_LEAKING_SCALARS
4678 sv->sv_flags = nsv->sv_flags;
4679 sv->sv_any = nsv->sv_any;
4680 sv->sv_refcnt = nsv->sv_refcnt;
4681 sv->sv_u = nsv->sv_u;
4683 StructCopy(nsv,sv,SV);
4685 /* Currently could join these into one piece of pointer arithmetic, but
4686 it would be unclear. */
4687 if(SvTYPE(sv) == SVt_IV)
4689 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4690 else if (SvTYPE(sv) == SVt_RV) {
4691 SvANY(sv) = &sv->sv_u.svu_rv;
4695 #ifdef PERL_OLD_COPY_ON_WRITE
4696 if (SvIsCOW_normal(nsv)) {
4697 /* We need to follow the pointers around the loop to make the
4698 previous SV point to sv, rather than nsv. */
4701 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4704 assert(SvPVX_const(current) == SvPVX_const(nsv));
4706 /* Make the SV before us point to the SV after us. */
4708 PerlIO_printf(Perl_debug_log, "previous is\n");
4710 PerlIO_printf(Perl_debug_log,
4711 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4712 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4714 SV_COW_NEXT_SV_SET(current, sv);
4717 SvREFCNT(sv) = refcnt;
4718 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4724 =for apidoc sv_clear
4726 Clear an SV: call any destructors, free up any memory used by the body,
4727 and free the body itself. The SV's head is I<not> freed, although
4728 its type is set to all 1's so that it won't inadvertently be assumed
4729 to be live during global destruction etc.
4730 This function should only be called when REFCNT is zero. Most of the time
4731 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4738 Perl_sv_clear(pTHX_ register SV *sv)
4741 const U32 type = SvTYPE(sv);
4742 const struct body_details *const sv_type_details
4743 = bodies_by_type + type;
4746 assert(SvREFCNT(sv) == 0);
4752 if (PL_defstash) { /* Still have a symbol table? */
4757 stash = SvSTASH(sv);
4758 destructor = StashHANDLER(stash,DESTROY);
4760 SV* const tmpref = newRV(sv);
4761 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4763 PUSHSTACKi(PERLSI_DESTROY);
4768 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4774 if(SvREFCNT(tmpref) < 2) {
4775 /* tmpref is not kept alive! */
4777 SvRV_set(tmpref, NULL);
4780 SvREFCNT_dec(tmpref);
4782 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4786 if (PL_in_clean_objs)
4787 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4789 /* DESTROY gave object new lease on life */
4795 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4796 SvOBJECT_off(sv); /* Curse the object. */
4797 if (type != SVt_PVIO)
4798 --PL_sv_objcount; /* XXX Might want something more general */
4801 if (type >= SVt_PVMG) {
4804 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4805 SvREFCNT_dec(SvSTASH(sv));
4810 IoIFP(sv) != PerlIO_stdin() &&
4811 IoIFP(sv) != PerlIO_stdout() &&
4812 IoIFP(sv) != PerlIO_stderr())
4814 io_close((IO*)sv, FALSE);
4816 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4817 PerlDir_close(IoDIRP(sv));
4818 IoDIRP(sv) = (DIR*)NULL;
4819 Safefree(IoTOP_NAME(sv));
4820 Safefree(IoFMT_NAME(sv));
4821 Safefree(IoBOTTOM_NAME(sv));
4830 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4837 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4838 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4839 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4840 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4842 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4843 SvREFCNT_dec(LvTARG(sv));
4847 Safefree(GvNAME(sv));
4848 /* If we're in a stash, we don't own a reference to it. However it does
4849 have a back reference to us, which needs to be cleared. */
4851 sv_del_backref((SV*)GvSTASH(sv), sv);
4856 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4858 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4859 /* Don't even bother with turning off the OOK flag. */
4864 SV *target = SvRV(sv);
4866 sv_del_backref(target, sv);
4868 SvREFCNT_dec(target);
4870 #ifdef PERL_OLD_COPY_ON_WRITE
4871 else if (SvPVX_const(sv)) {
4873 /* I believe I need to grab the global SV mutex here and
4874 then recheck the COW status. */
4876 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4879 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4880 SV_COW_NEXT_SV(sv));
4881 /* And drop it here. */
4883 } else if (SvLEN(sv)) {
4884 Safefree(SvPVX_const(sv));
4888 else if (SvPVX_const(sv) && SvLEN(sv))
4889 Safefree(SvPVX_mutable(sv));
4890 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4891 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4900 SvFLAGS(sv) &= SVf_BREAK;
4901 SvFLAGS(sv) |= SVTYPEMASK;
4903 if (sv_type_details->arena) {
4904 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4905 &PL_body_roots[type]);
4907 else if (sv_type_details->size) {
4908 my_safefree(SvANY(sv));
4913 =for apidoc sv_newref
4915 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4922 Perl_sv_newref(pTHX_ SV *sv)
4932 Decrement an SV's reference count, and if it drops to zero, call
4933 C<sv_clear> to invoke destructors and free up any memory used by
4934 the body; finally, deallocate the SV's head itself.
4935 Normally called via a wrapper macro C<SvREFCNT_dec>.
4941 Perl_sv_free(pTHX_ SV *sv)
4946 if (SvREFCNT(sv) == 0) {
4947 if (SvFLAGS(sv) & SVf_BREAK)
4948 /* this SV's refcnt has been artificially decremented to
4949 * trigger cleanup */
4951 if (PL_in_clean_all) /* All is fair */
4953 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4954 /* make sure SvREFCNT(sv)==0 happens very seldom */
4955 SvREFCNT(sv) = (~(U32)0)/2;
4958 if (ckWARN_d(WARN_INTERNAL)) {
4959 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4960 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4961 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4962 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4963 Perl_dump_sv_child(aTHX_ sv);
4968 if (--(SvREFCNT(sv)) > 0)
4970 Perl_sv_free2(aTHX_ sv);
4974 Perl_sv_free2(pTHX_ SV *sv)
4979 if (ckWARN_d(WARN_DEBUGGING))
4980 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4981 "Attempt to free temp prematurely: SV 0x%"UVxf
4982 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4986 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4987 /* make sure SvREFCNT(sv)==0 happens very seldom */
4988 SvREFCNT(sv) = (~(U32)0)/2;
4999 Returns the length of the string in the SV. Handles magic and type
5000 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5006 Perl_sv_len(pTHX_ register SV *sv)
5014 len = mg_length(sv);
5016 (void)SvPV_const(sv, len);
5021 =for apidoc sv_len_utf8
5023 Returns the number of characters in the string in an SV, counting wide
5024 UTF-8 bytes as a single character. Handles magic and type coercion.
5030 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5031 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5032 * (Note that the mg_len is not the length of the mg_ptr field.)
5037 Perl_sv_len_utf8(pTHX_ register SV *sv)
5043 return mg_length(sv);
5047 const U8 *s = (U8*)SvPV_const(sv, len);
5048 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5050 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5052 #ifdef PERL_UTF8_CACHE_ASSERT
5053 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5057 ulen = Perl_utf8_length(aTHX_ s, s + len);
5058 if (!mg && !SvREADONLY(sv)) {
5059 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5060 mg = mg_find(sv, PERL_MAGIC_utf8);
5070 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5071 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5072 * between UTF-8 and byte offsets. There are two (substr offset and substr
5073 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5074 * and byte offset) cache positions.
5076 * The mg_len field is used by sv_len_utf8(), see its comments.
5077 * Note that the mg_len is not the length of the mg_ptr field.
5081 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5082 I32 offsetp, const U8 *s, const U8 *start)
5086 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5088 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5092 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5094 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5095 (*mgp)->mg_ptr = (char *) *cachep;
5099 (*cachep)[i] = offsetp;
5100 (*cachep)[i+1] = s - start;
5108 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5109 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5110 * between UTF-8 and byte offsets. See also the comments of
5111 * S_utf8_mg_pos_init().
5115 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)
5119 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5121 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5122 if (*mgp && (*mgp)->mg_ptr) {
5123 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5124 ASSERT_UTF8_CACHE(*cachep);
5125 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5127 else { /* We will skip to the right spot. */
5132 /* The assumption is that going backward is half
5133 * the speed of going forward (that's where the
5134 * 2 * backw in the below comes from). (The real
5135 * figure of course depends on the UTF-8 data.) */
5137 if ((*cachep)[i] > (STRLEN)uoff) {
5139 backw = (*cachep)[i] - (STRLEN)uoff;
5141 if (forw < 2 * backw)
5144 p = start + (*cachep)[i+1];
5146 /* Try this only for the substr offset (i == 0),
5147 * not for the substr length (i == 2). */
5148 else if (i == 0) { /* (*cachep)[i] < uoff */
5149 const STRLEN ulen = sv_len_utf8(sv);
5151 if ((STRLEN)uoff < ulen) {
5152 forw = (STRLEN)uoff - (*cachep)[i];
5153 backw = ulen - (STRLEN)uoff;
5155 if (forw < 2 * backw)
5156 p = start + (*cachep)[i+1];
5161 /* If the string is not long enough for uoff,
5162 * we could extend it, but not at this low a level. */
5166 if (forw < 2 * backw) {
5173 while (UTF8_IS_CONTINUATION(*p))
5178 /* Update the cache. */
5179 (*cachep)[i] = (STRLEN)uoff;
5180 (*cachep)[i+1] = p - start;
5182 /* Drop the stale "length" cache */
5191 if (found) { /* Setup the return values. */
5192 *offsetp = (*cachep)[i+1];
5193 *sp = start + *offsetp;
5196 *offsetp = send - start;
5198 else if (*sp < start) {
5204 #ifdef PERL_UTF8_CACHE_ASSERT
5209 while (n-- && s < send)
5213 assert(*offsetp == s - start);
5214 assert((*cachep)[0] == (STRLEN)uoff);
5215 assert((*cachep)[1] == *offsetp);
5217 ASSERT_UTF8_CACHE(*cachep);
5226 =for apidoc sv_pos_u2b
5228 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5229 the start of the string, to a count of the equivalent number of bytes; if
5230 lenp is non-zero, it does the same to lenp, but this time starting from
5231 the offset, rather than from the start of the string. Handles magic and
5238 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5239 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5240 * byte offsets. See also the comments of S_utf8_mg_pos().
5245 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5253 start = (U8*)SvPV_const(sv, len);
5256 STRLEN *cache = NULL;
5257 const U8 *s = start;
5258 I32 uoffset = *offsetp;
5259 const U8 * const send = s + len;
5261 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5263 if (!found && uoffset > 0) {
5264 while (s < send && uoffset--)
5268 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5270 *offsetp = s - start;
5275 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5279 if (!found && *lenp > 0) {
5282 while (s < send && ulen--)
5286 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5290 ASSERT_UTF8_CACHE(cache);
5302 =for apidoc sv_pos_b2u
5304 Converts the value pointed to by offsetp from a count of bytes from the
5305 start of the string, to a count of the equivalent number of UTF-8 chars.
5306 Handles magic and type coercion.
5312 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5313 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5314 * byte offsets. See also the comments of S_utf8_mg_pos().
5319 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5327 s = (const U8*)SvPV_const(sv, len);
5328 if ((I32)len < *offsetp)
5329 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5331 const U8* send = s + *offsetp;
5333 STRLEN *cache = NULL;
5337 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5338 mg = mg_find(sv, PERL_MAGIC_utf8);
5339 if (mg && mg->mg_ptr) {
5340 cache = (STRLEN *) mg->mg_ptr;
5341 if (cache[1] == (STRLEN)*offsetp) {
5342 /* An exact match. */
5343 *offsetp = cache[0];
5347 else if (cache[1] < (STRLEN)*offsetp) {
5348 /* We already know part of the way. */
5351 /* Let the below loop do the rest. */
5353 else { /* cache[1] > *offsetp */
5354 /* We already know all of the way, now we may
5355 * be able to walk back. The same assumption
5356 * is made as in S_utf8_mg_pos(), namely that
5357 * walking backward is twice slower than
5358 * walking forward. */
5359 const STRLEN forw = *offsetp;
5360 STRLEN backw = cache[1] - *offsetp;
5362 if (!(forw < 2 * backw)) {
5363 const U8 *p = s + cache[1];
5370 while (UTF8_IS_CONTINUATION(*p)) {
5378 *offsetp = cache[0];
5380 /* Drop the stale "length" cache */
5388 ASSERT_UTF8_CACHE(cache);
5394 /* Call utf8n_to_uvchr() to validate the sequence
5395 * (unless a simple non-UTF character) */
5396 if (!UTF8_IS_INVARIANT(*s))
5397 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5406 if (!SvREADONLY(sv)) {
5408 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5409 mg = mg_find(sv, PERL_MAGIC_utf8);
5414 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5415 mg->mg_ptr = (char *) cache;
5420 cache[1] = *offsetp;
5421 /* Drop the stale "length" cache */
5434 Returns a boolean indicating whether the strings in the two SVs are
5435 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5436 coerce its args to strings if necessary.
5442 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5451 SV* svrecode = Nullsv;
5458 pv1 = SvPV_const(sv1, cur1);
5465 pv2 = SvPV_const(sv2, cur2);
5467 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5468 /* Differing utf8ness.
5469 * Do not UTF8size the comparands as a side-effect. */
5472 svrecode = newSVpvn(pv2, cur2);
5473 sv_recode_to_utf8(svrecode, PL_encoding);
5474 pv2 = SvPV_const(svrecode, cur2);
5477 svrecode = newSVpvn(pv1, cur1);
5478 sv_recode_to_utf8(svrecode, PL_encoding);
5479 pv1 = SvPV_const(svrecode, cur1);
5481 /* Now both are in UTF-8. */
5483 SvREFCNT_dec(svrecode);
5488 bool is_utf8 = TRUE;
5491 /* sv1 is the UTF-8 one,
5492 * if is equal it must be downgrade-able */
5493 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5499 /* sv2 is the UTF-8 one,
5500 * if is equal it must be downgrade-able */
5501 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5507 /* Downgrade not possible - cannot be eq */
5515 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5518 SvREFCNT_dec(svrecode);
5529 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5530 string in C<sv1> is less than, equal to, or greater than the string in
5531 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5532 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5538 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5542 const char *pv1, *pv2;
5545 SV *svrecode = Nullsv;
5552 pv1 = SvPV_const(sv1, cur1);
5559 pv2 = SvPV_const(sv2, cur2);
5561 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5562 /* Differing utf8ness.
5563 * Do not UTF8size the comparands as a side-effect. */
5566 svrecode = newSVpvn(pv2, cur2);
5567 sv_recode_to_utf8(svrecode, PL_encoding);
5568 pv2 = SvPV_const(svrecode, cur2);
5571 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5576 svrecode = newSVpvn(pv1, cur1);
5577 sv_recode_to_utf8(svrecode, PL_encoding);
5578 pv1 = SvPV_const(svrecode, cur1);
5581 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5587 cmp = cur2 ? -1 : 0;
5591 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5594 cmp = retval < 0 ? -1 : 1;
5595 } else if (cur1 == cur2) {
5598 cmp = cur1 < cur2 ? -1 : 1;
5603 SvREFCNT_dec(svrecode);
5612 =for apidoc sv_cmp_locale
5614 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5615 'use bytes' aware, handles get magic, and will coerce its args to strings
5616 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5622 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5625 #ifdef USE_LOCALE_COLLATE
5631 if (PL_collation_standard)
5635 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5637 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5639 if (!pv1 || !len1) {
5650 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5653 return retval < 0 ? -1 : 1;
5656 * When the result of collation is equality, that doesn't mean
5657 * that there are no differences -- some locales exclude some
5658 * characters from consideration. So to avoid false equalities,
5659 * we use the raw string as a tiebreaker.
5665 #endif /* USE_LOCALE_COLLATE */
5667 return sv_cmp(sv1, sv2);
5671 #ifdef USE_LOCALE_COLLATE
5674 =for apidoc sv_collxfrm
5676 Add Collate Transform magic to an SV if it doesn't already have it.
5678 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5679 scalar data of the variable, but transformed to such a format that a normal
5680 memory comparison can be used to compare the data according to the locale
5687 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5692 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5693 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5699 Safefree(mg->mg_ptr);
5700 s = SvPV_const(sv, len);
5701 if ((xf = mem_collxfrm(s, len, &xlen))) {
5702 if (SvREADONLY(sv)) {
5705 return xf + sizeof(PL_collation_ix);
5708 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5709 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5722 if (mg && mg->mg_ptr) {
5724 return mg->mg_ptr + sizeof(PL_collation_ix);
5732 #endif /* USE_LOCALE_COLLATE */
5737 Get a line from the filehandle and store it into the SV, optionally
5738 appending to the currently-stored string.
5744 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5749 register STDCHAR rslast;
5750 register STDCHAR *bp;
5756 if (SvTHINKFIRST(sv))
5757 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5758 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5760 However, perlbench says it's slower, because the existing swipe code
5761 is faster than copy on write.
5762 Swings and roundabouts. */
5763 SvUPGRADE(sv, SVt_PV);
5768 if (PerlIO_isutf8(fp)) {
5770 sv_utf8_upgrade_nomg(sv);
5771 sv_pos_u2b(sv,&append,0);
5773 } else if (SvUTF8(sv)) {
5774 SV * const tsv = newSV(0);
5775 sv_gets(tsv, fp, 0);
5776 sv_utf8_upgrade_nomg(tsv);
5777 SvCUR_set(sv,append);
5780 goto return_string_or_null;
5785 if (PerlIO_isutf8(fp))
5788 if (IN_PERL_COMPILETIME) {
5789 /* we always read code in line mode */
5793 else if (RsSNARF(PL_rs)) {
5794 /* If it is a regular disk file use size from stat() as estimate
5795 of amount we are going to read - may result in malloc-ing
5796 more memory than we realy need if layers bellow reduce
5797 size we read (e.g. CRLF or a gzip layer)
5800 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5801 const Off_t offset = PerlIO_tell(fp);
5802 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5803 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5809 else if (RsRECORD(PL_rs)) {
5813 /* Grab the size of the record we're getting */
5814 recsize = SvIV(SvRV(PL_rs));
5815 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5818 /* VMS wants read instead of fread, because fread doesn't respect */
5819 /* RMS record boundaries. This is not necessarily a good thing to be */
5820 /* doing, but we've got no other real choice - except avoid stdio
5821 as implementation - perhaps write a :vms layer ?
5823 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5825 bytesread = PerlIO_read(fp, buffer, recsize);
5829 SvCUR_set(sv, bytesread += append);
5830 buffer[bytesread] = '\0';
5831 goto return_string_or_null;
5833 else if (RsPARA(PL_rs)) {
5839 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5840 if (PerlIO_isutf8(fp)) {
5841 rsptr = SvPVutf8(PL_rs, rslen);
5844 if (SvUTF8(PL_rs)) {
5845 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5846 Perl_croak(aTHX_ "Wide character in $/");
5849 rsptr = SvPV_const(PL_rs, rslen);
5853 rslast = rslen ? rsptr[rslen - 1] : '\0';
5855 if (rspara) { /* have to do this both before and after */
5856 do { /* to make sure file boundaries work right */
5859 i = PerlIO_getc(fp);
5863 PerlIO_ungetc(fp,i);
5869 /* See if we know enough about I/O mechanism to cheat it ! */
5871 /* This used to be #ifdef test - it is made run-time test for ease
5872 of abstracting out stdio interface. One call should be cheap
5873 enough here - and may even be a macro allowing compile
5877 if (PerlIO_fast_gets(fp)) {
5880 * We're going to steal some values from the stdio struct
5881 * and put EVERYTHING in the innermost loop into registers.
5883 register STDCHAR *ptr;
5887 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5888 /* An ungetc()d char is handled separately from the regular
5889 * buffer, so we getc() it back out and stuff it in the buffer.
5891 i = PerlIO_getc(fp);
5892 if (i == EOF) return 0;
5893 *(--((*fp)->_ptr)) = (unsigned char) i;
5897 /* Here is some breathtakingly efficient cheating */
5899 cnt = PerlIO_get_cnt(fp); /* get count into register */
5900 /* make sure we have the room */
5901 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5902 /* Not room for all of it
5903 if we are looking for a separator and room for some
5905 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5906 /* just process what we have room for */
5907 shortbuffered = cnt - SvLEN(sv) + append + 1;
5908 cnt -= shortbuffered;
5912 /* remember that cnt can be negative */
5913 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5918 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5919 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5920 DEBUG_P(PerlIO_printf(Perl_debug_log,
5921 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5922 DEBUG_P(PerlIO_printf(Perl_debug_log,
5923 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5924 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5925 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5930 while (cnt > 0) { /* this | eat */
5932 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5933 goto thats_all_folks; /* screams | sed :-) */
5937 Copy(ptr, bp, cnt, char); /* this | eat */
5938 bp += cnt; /* screams | dust */
5939 ptr += cnt; /* louder | sed :-) */
5944 if (shortbuffered) { /* oh well, must extend */
5945 cnt = shortbuffered;
5947 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5949 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5950 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5954 DEBUG_P(PerlIO_printf(Perl_debug_log,
5955 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5956 PTR2UV(ptr),(long)cnt));
5957 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5959 DEBUG_P(PerlIO_printf(Perl_debug_log,
5960 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5961 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5962 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5964 /* This used to call 'filbuf' in stdio form, but as that behaves like
5965 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5966 another abstraction. */
5967 i = PerlIO_getc(fp); /* get more characters */
5969 DEBUG_P(PerlIO_printf(Perl_debug_log,
5970 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5971 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5972 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5974 cnt = PerlIO_get_cnt(fp);
5975 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5976 DEBUG_P(PerlIO_printf(Perl_debug_log,
5977 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5979 if (i == EOF) /* all done for ever? */
5980 goto thats_really_all_folks;
5982 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5984 SvGROW(sv, bpx + cnt + 2);
5985 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5987 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5989 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5990 goto thats_all_folks;
5994 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5995 memNE((char*)bp - rslen, rsptr, rslen))
5996 goto screamer; /* go back to the fray */
5997 thats_really_all_folks:
5999 cnt += shortbuffered;
6000 DEBUG_P(PerlIO_printf(Perl_debug_log,
6001 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6002 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6003 DEBUG_P(PerlIO_printf(Perl_debug_log,
6004 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6005 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6006 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6008 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6009 DEBUG_P(PerlIO_printf(Perl_debug_log,
6010 "Screamer: done, len=%ld, string=|%.*s|\n",
6011 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6015 /*The big, slow, and stupid way. */
6016 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6017 STDCHAR *buf = NULL;
6018 Newx(buf, 8192, STDCHAR);
6026 register const STDCHAR * const bpe = buf + sizeof(buf);
6028 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6029 ; /* keep reading */
6033 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6034 /* Accomodate broken VAXC compiler, which applies U8 cast to
6035 * both args of ?: operator, causing EOF to change into 255
6038 i = (U8)buf[cnt - 1];
6044 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6046 sv_catpvn(sv, (char *) buf, cnt);
6048 sv_setpvn(sv, (char *) buf, cnt);
6050 if (i != EOF && /* joy */
6052 SvCUR(sv) < rslen ||
6053 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6057 * If we're reading from a TTY and we get a short read,
6058 * indicating that the user hit his EOF character, we need
6059 * to notice it now, because if we try to read from the TTY
6060 * again, the EOF condition will disappear.
6062 * The comparison of cnt to sizeof(buf) is an optimization
6063 * that prevents unnecessary calls to feof().
6067 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6071 #ifdef USE_HEAP_INSTEAD_OF_STACK
6076 if (rspara) { /* have to do this both before and after */
6077 while (i != EOF) { /* to make sure file boundaries work right */
6078 i = PerlIO_getc(fp);
6080 PerlIO_ungetc(fp,i);
6086 return_string_or_null:
6087 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6093 Auto-increment of the value in the SV, doing string to numeric conversion
6094 if necessary. Handles 'get' magic.
6100 Perl_sv_inc(pTHX_ register SV *sv)
6109 if (SvTHINKFIRST(sv)) {
6111 sv_force_normal_flags(sv, 0);
6112 if (SvREADONLY(sv)) {
6113 if (IN_PERL_RUNTIME)
6114 Perl_croak(aTHX_ PL_no_modify);
6118 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6120 i = PTR2IV(SvRV(sv));
6125 flags = SvFLAGS(sv);
6126 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6127 /* It's (privately or publicly) a float, but not tested as an
6128 integer, so test it to see. */
6130 flags = SvFLAGS(sv);
6132 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6133 /* It's publicly an integer, or privately an integer-not-float */
6134 #ifdef PERL_PRESERVE_IVUV
6138 if (SvUVX(sv) == UV_MAX)
6139 sv_setnv(sv, UV_MAX_P1);
6141 (void)SvIOK_only_UV(sv);
6142 SvUV_set(sv, SvUVX(sv) + 1);
6144 if (SvIVX(sv) == IV_MAX)
6145 sv_setuv(sv, (UV)IV_MAX + 1);
6147 (void)SvIOK_only(sv);
6148 SvIV_set(sv, SvIVX(sv) + 1);
6153 if (flags & SVp_NOK) {
6154 (void)SvNOK_only(sv);
6155 SvNV_set(sv, SvNVX(sv) + 1.0);
6159 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6160 if ((flags & SVTYPEMASK) < SVt_PVIV)
6161 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6162 (void)SvIOK_only(sv);
6167 while (isALPHA(*d)) d++;
6168 while (isDIGIT(*d)) d++;
6170 #ifdef PERL_PRESERVE_IVUV
6171 /* Got to punt this as an integer if needs be, but we don't issue
6172 warnings. Probably ought to make the sv_iv_please() that does
6173 the conversion if possible, and silently. */
6174 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6175 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6176 /* Need to try really hard to see if it's an integer.
6177 9.22337203685478e+18 is an integer.
6178 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6179 so $a="9.22337203685478e+18"; $a+0; $a++
6180 needs to be the same as $a="9.22337203685478e+18"; $a++
6187 /* sv_2iv *should* have made this an NV */
6188 if (flags & SVp_NOK) {
6189 (void)SvNOK_only(sv);
6190 SvNV_set(sv, SvNVX(sv) + 1.0);
6193 /* I don't think we can get here. Maybe I should assert this
6194 And if we do get here I suspect that sv_setnv will croak. NWC
6196 #if defined(USE_LONG_DOUBLE)
6197 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",
6198 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6200 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6201 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6204 #endif /* PERL_PRESERVE_IVUV */
6205 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6209 while (d >= SvPVX_const(sv)) {
6217 /* MKS: The original code here died if letters weren't consecutive.
6218 * at least it didn't have to worry about non-C locales. The
6219 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6220 * arranged in order (although not consecutively) and that only
6221 * [A-Za-z] are accepted by isALPHA in the C locale.
6223 if (*d != 'z' && *d != 'Z') {
6224 do { ++*d; } while (!isALPHA(*d));
6227 *(d--) -= 'z' - 'a';
6232 *(d--) -= 'z' - 'a' + 1;
6236 /* oh,oh, the number grew */
6237 SvGROW(sv, SvCUR(sv) + 2);
6238 SvCUR_set(sv, SvCUR(sv) + 1);
6239 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6250 Auto-decrement of the value in the SV, doing string to numeric conversion
6251 if necessary. Handles 'get' magic.
6257 Perl_sv_dec(pTHX_ register SV *sv)
6265 if (SvTHINKFIRST(sv)) {
6267 sv_force_normal_flags(sv, 0);
6268 if (SvREADONLY(sv)) {
6269 if (IN_PERL_RUNTIME)
6270 Perl_croak(aTHX_ PL_no_modify);
6274 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6276 i = PTR2IV(SvRV(sv));
6281 /* Unlike sv_inc we don't have to worry about string-never-numbers
6282 and keeping them magic. But we mustn't warn on punting */
6283 flags = SvFLAGS(sv);
6284 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6285 /* It's publicly an integer, or privately an integer-not-float */
6286 #ifdef PERL_PRESERVE_IVUV
6290 if (SvUVX(sv) == 0) {
6291 (void)SvIOK_only(sv);
6295 (void)SvIOK_only_UV(sv);
6296 SvUV_set(sv, SvUVX(sv) - 1);
6299 if (SvIVX(sv) == IV_MIN)
6300 sv_setnv(sv, (NV)IV_MIN - 1.0);
6302 (void)SvIOK_only(sv);
6303 SvIV_set(sv, SvIVX(sv) - 1);
6308 if (flags & SVp_NOK) {
6309 SvNV_set(sv, SvNVX(sv) - 1.0);
6310 (void)SvNOK_only(sv);
6313 if (!(flags & SVp_POK)) {
6314 if ((flags & SVTYPEMASK) < SVt_PVIV)
6315 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6317 (void)SvIOK_only(sv);
6320 #ifdef PERL_PRESERVE_IVUV
6322 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6323 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6324 /* Need to try really hard to see if it's an integer.
6325 9.22337203685478e+18 is an integer.
6326 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6327 so $a="9.22337203685478e+18"; $a+0; $a--
6328 needs to be the same as $a="9.22337203685478e+18"; $a--
6335 /* sv_2iv *should* have made this an NV */
6336 if (flags & SVp_NOK) {
6337 (void)SvNOK_only(sv);
6338 SvNV_set(sv, SvNVX(sv) - 1.0);
6341 /* I don't think we can get here. Maybe I should assert this
6342 And if we do get here I suspect that sv_setnv will croak. NWC
6344 #if defined(USE_LONG_DOUBLE)
6345 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",
6346 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6348 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6349 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6353 #endif /* PERL_PRESERVE_IVUV */
6354 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6358 =for apidoc sv_mortalcopy
6360 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6361 The new SV is marked as mortal. It will be destroyed "soon", either by an
6362 explicit call to FREETMPS, or by an implicit call at places such as
6363 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6368 /* Make a string that will exist for the duration of the expression
6369 * evaluation. Actually, it may have to last longer than that, but
6370 * hopefully we won't free it until it has been assigned to a
6371 * permanent location. */
6374 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6380 sv_setsv(sv,oldstr);
6382 PL_tmps_stack[++PL_tmps_ix] = sv;
6388 =for apidoc sv_newmortal
6390 Creates a new null SV which is mortal. The reference count of the SV is
6391 set to 1. It will be destroyed "soon", either by an explicit call to
6392 FREETMPS, or by an implicit call at places such as statement boundaries.
6393 See also C<sv_mortalcopy> and C<sv_2mortal>.
6399 Perl_sv_newmortal(pTHX)
6405 SvFLAGS(sv) = SVs_TEMP;
6407 PL_tmps_stack[++PL_tmps_ix] = sv;
6412 =for apidoc sv_2mortal
6414 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6415 by an explicit call to FREETMPS, or by an implicit call at places such as
6416 statement boundaries. SvTEMP() is turned on which means that the SV's
6417 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6418 and C<sv_mortalcopy>.
6424 Perl_sv_2mortal(pTHX_ register SV *sv)
6429 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6432 PL_tmps_stack[++PL_tmps_ix] = sv;
6440 Creates a new SV and copies a string into it. The reference count for the
6441 SV is set to 1. If C<len> is zero, Perl will compute the length using
6442 strlen(). For efficiency, consider using C<newSVpvn> instead.
6448 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6454 sv_setpvn(sv,s,len ? len : strlen(s));
6459 =for apidoc newSVpvn
6461 Creates a new SV and copies a string into it. The reference count for the
6462 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6463 string. You are responsible for ensuring that the source string is at least
6464 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6470 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6476 sv_setpvn(sv,s,len);
6482 =for apidoc newSVhek
6484 Creates a new SV from the hash key structure. It will generate scalars that
6485 point to the shared string table where possible. Returns a new (undefined)
6486 SV if the hek is NULL.
6492 Perl_newSVhek(pTHX_ const HEK *hek)
6502 if (HEK_LEN(hek) == HEf_SVKEY) {
6503 return newSVsv(*(SV**)HEK_KEY(hek));
6505 const int flags = HEK_FLAGS(hek);
6506 if (flags & HVhek_WASUTF8) {
6508 Andreas would like keys he put in as utf8 to come back as utf8
6510 STRLEN utf8_len = HEK_LEN(hek);
6511 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6512 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6515 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6517 } else if (flags & HVhek_REHASH) {
6518 /* We don't have a pointer to the hv, so we have to replicate the
6519 flag into every HEK. This hv is using custom a hasing
6520 algorithm. Hence we can't return a shared string scalar, as
6521 that would contain the (wrong) hash value, and might get passed
6522 into an hv routine with a regular hash */
6524 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6529 /* This will be overwhelminly the most common case. */
6530 return newSVpvn_share(HEK_KEY(hek),
6531 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6537 =for apidoc newSVpvn_share
6539 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6540 table. If the string does not already exist in the table, it is created
6541 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6542 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6543 otherwise the hash is computed. The idea here is that as the string table
6544 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6545 hash lookup will avoid string compare.
6551 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6555 bool is_utf8 = FALSE;
6557 STRLEN tmplen = -len;
6559 /* See the note in hv.c:hv_fetch() --jhi */
6560 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6564 PERL_HASH(hash, src, len);
6566 sv_upgrade(sv, SVt_PV);
6567 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6579 #if defined(PERL_IMPLICIT_CONTEXT)
6581 /* pTHX_ magic can't cope with varargs, so this is a no-context
6582 * version of the main function, (which may itself be aliased to us).
6583 * Don't access this version directly.
6587 Perl_newSVpvf_nocontext(const char* pat, ...)
6592 va_start(args, pat);
6593 sv = vnewSVpvf(pat, &args);
6600 =for apidoc newSVpvf
6602 Creates a new SV and initializes it with the string formatted like
6609 Perl_newSVpvf(pTHX_ const char* pat, ...)
6613 va_start(args, pat);
6614 sv = vnewSVpvf(pat, &args);
6619 /* backend for newSVpvf() and newSVpvf_nocontext() */
6622 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6627 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6634 Creates a new SV and copies a floating point value into it.
6635 The reference count for the SV is set to 1.
6641 Perl_newSVnv(pTHX_ NV n)
6654 Creates a new SV and copies an integer into it. The reference count for the
6661 Perl_newSViv(pTHX_ IV i)
6674 Creates a new SV and copies an unsigned integer into it.
6675 The reference count for the SV is set to 1.
6681 Perl_newSVuv(pTHX_ UV u)
6692 =for apidoc newRV_noinc
6694 Creates an RV wrapper for an SV. The reference count for the original
6695 SV is B<not> incremented.
6701 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6707 sv_upgrade(sv, SVt_RV);
6709 SvRV_set(sv, tmpRef);
6714 /* newRV_inc is the official function name to use now.
6715 * newRV_inc is in fact #defined to newRV in sv.h
6719 Perl_newRV(pTHX_ SV *tmpRef)
6722 return newRV_noinc(SvREFCNT_inc(tmpRef));
6728 Creates a new SV which is an exact duplicate of the original SV.
6735 Perl_newSVsv(pTHX_ register SV *old)
6742 if (SvTYPE(old) == SVTYPEMASK) {
6743 if (ckWARN_d(WARN_INTERNAL))
6744 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6748 /* SV_GMAGIC is the default for sv_setv()
6749 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6750 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6751 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6756 =for apidoc sv_reset
6758 Underlying implementation for the C<reset> Perl function.
6759 Note that the perl-level function is vaguely deprecated.
6765 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6768 char todo[PERL_UCHAR_MAX+1];
6773 if (!*s) { /* reset ?? searches */
6774 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6776 PMOP *pm = (PMOP *) mg->mg_obj;
6778 pm->op_pmdynflags &= ~PMdf_USED;
6785 /* reset variables */
6787 if (!HvARRAY(stash))
6790 Zero(todo, 256, char);
6793 I32 i = (unsigned char)*s;
6797 max = (unsigned char)*s++;
6798 for ( ; i <= max; i++) {
6801 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6803 for (entry = HvARRAY(stash)[i];
6805 entry = HeNEXT(entry))
6810 if (!todo[(U8)*HeKEY(entry)])
6812 gv = (GV*)HeVAL(entry);
6815 if (SvTHINKFIRST(sv)) {
6816 if (!SvREADONLY(sv) && SvROK(sv))
6818 /* XXX Is this continue a bug? Why should THINKFIRST
6819 exempt us from resetting arrays and hashes? */
6823 if (SvTYPE(sv) >= SVt_PV) {
6825 if (SvPVX_const(sv) != Nullch)
6833 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6835 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6838 # if defined(USE_ENVIRON_ARRAY)
6841 # endif /* USE_ENVIRON_ARRAY */
6852 Using various gambits, try to get an IO from an SV: the IO slot if its a
6853 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6854 named after the PV if we're a string.
6860 Perl_sv_2io(pTHX_ SV *sv)
6865 switch (SvTYPE(sv)) {
6873 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6877 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6879 return sv_2io(SvRV(sv));
6880 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6886 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6895 Using various gambits, try to get a CV from an SV; in addition, try if
6896 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6897 The flags in C<lref> are passed to sv_fetchsv.
6903 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6910 return *st = NULL, *gvp = Nullgv, Nullcv;
6911 switch (SvTYPE(sv)) {
6930 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6931 tryAMAGICunDEREF(to_cv);
6934 if (SvTYPE(sv) == SVt_PVCV) {
6943 Perl_croak(aTHX_ "Not a subroutine reference");
6948 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6954 /* Some flags to gv_fetchsv mean don't really create the GV */
6955 if (SvTYPE(gv) != SVt_PVGV) {
6961 if (lref && !GvCVu(gv)) {
6965 gv_efullname3(tmpsv, gv, Nullch);
6966 /* XXX this is probably not what they think they're getting.
6967 * It has the same effect as "sub name;", i.e. just a forward
6969 newSUB(start_subparse(FALSE, 0),
6970 newSVOP(OP_CONST, 0, tmpsv),
6975 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6985 Returns true if the SV has a true value by Perl's rules.
6986 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6987 instead use an in-line version.
6993 Perl_sv_true(pTHX_ register SV *sv)
6998 register const XPV* const tXpv = (XPV*)SvANY(sv);
7000 (tXpv->xpv_cur > 1 ||
7001 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7008 return SvIVX(sv) != 0;
7011 return SvNVX(sv) != 0.0;
7013 return sv_2bool(sv);
7019 =for apidoc sv_pvn_force
7021 Get a sensible string out of the SV somehow.
7022 A private implementation of the C<SvPV_force> macro for compilers which
7023 can't cope with complex macro expressions. Always use the macro instead.
7025 =for apidoc sv_pvn_force_flags
7027 Get a sensible string out of the SV somehow.
7028 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7029 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7030 implemented in terms of this function.
7031 You normally want to use the various wrapper macros instead: see
7032 C<SvPV_force> and C<SvPV_force_nomg>
7038 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7041 if (SvTHINKFIRST(sv) && !SvROK(sv))
7042 sv_force_normal_flags(sv, 0);
7052 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7053 const char * const ref = sv_reftype(sv,0);
7055 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7056 ref, OP_NAME(PL_op));
7058 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7060 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7061 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7063 s = sv_2pv_flags(sv, &len, flags);
7067 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7070 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7071 SvGROW(sv, len + 1);
7072 Move(s,SvPVX(sv),len,char);
7077 SvPOK_on(sv); /* validate pointer */
7079 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7080 PTR2UV(sv),SvPVX_const(sv)));
7083 return SvPVX_mutable(sv);
7087 =for apidoc sv_pvbyten_force
7089 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7095 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7097 sv_pvn_force(sv,lp);
7098 sv_utf8_downgrade(sv,0);
7104 =for apidoc sv_pvutf8n_force
7106 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7112 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7114 sv_pvn_force(sv,lp);
7115 sv_utf8_upgrade(sv);
7121 =for apidoc sv_reftype
7123 Returns a string describing what the SV is a reference to.
7129 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7131 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7132 inside return suggests a const propagation bug in g++. */
7133 if (ob && SvOBJECT(sv)) {
7134 char * const name = HvNAME_get(SvSTASH(sv));
7135 return name ? name : (char *) "__ANON__";
7138 switch (SvTYPE(sv)) {
7155 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7156 /* tied lvalues should appear to be
7157 * scalars for backwards compatitbility */
7158 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7159 ? "SCALAR" : "LVALUE");
7160 case SVt_PVAV: return "ARRAY";
7161 case SVt_PVHV: return "HASH";
7162 case SVt_PVCV: return "CODE";
7163 case SVt_PVGV: return "GLOB";
7164 case SVt_PVFM: return "FORMAT";
7165 case SVt_PVIO: return "IO";
7166 default: return "UNKNOWN";
7172 =for apidoc sv_isobject
7174 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7175 object. If the SV is not an RV, or if the object is not blessed, then this
7182 Perl_sv_isobject(pTHX_ SV *sv)
7198 Returns a boolean indicating whether the SV is blessed into the specified
7199 class. This does not check for subtypes; use C<sv_derived_from> to verify
7200 an inheritance relationship.
7206 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7217 hvname = HvNAME_get(SvSTASH(sv));
7221 return strEQ(hvname, name);
7227 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7228 it will be upgraded to one. If C<classname> is non-null then the new SV will
7229 be blessed in the specified package. The new SV is returned and its
7230 reference count is 1.
7236 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7243 SV_CHECK_THINKFIRST_COW_DROP(rv);
7246 if (SvTYPE(rv) >= SVt_PVMG) {
7247 const U32 refcnt = SvREFCNT(rv);
7251 SvREFCNT(rv) = refcnt;
7254 if (SvTYPE(rv) < SVt_RV)
7255 sv_upgrade(rv, SVt_RV);
7256 else if (SvTYPE(rv) > SVt_RV) {
7267 HV* const stash = gv_stashpv(classname, TRUE);
7268 (void)sv_bless(rv, stash);
7274 =for apidoc sv_setref_pv
7276 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7277 argument will be upgraded to an RV. That RV will be modified to point to
7278 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7279 into the SV. The C<classname> argument indicates the package for the
7280 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7281 will have a reference count of 1, and the RV will be returned.
7283 Do not use with other Perl types such as HV, AV, SV, CV, because those
7284 objects will become corrupted by the pointer copy process.
7286 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7292 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7296 sv_setsv(rv, &PL_sv_undef);
7300 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7305 =for apidoc sv_setref_iv
7307 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7308 argument will be upgraded to an RV. That RV will be modified to point to
7309 the new SV. The C<classname> argument indicates the package for the
7310 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7311 will have a reference count of 1, and the RV will be returned.
7317 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7319 sv_setiv(newSVrv(rv,classname), iv);
7324 =for apidoc sv_setref_uv
7326 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7327 argument will be upgraded to an RV. That RV will be modified to point to
7328 the new SV. The C<classname> argument indicates the package for the
7329 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7330 will have a reference count of 1, and the RV will be returned.
7336 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7338 sv_setuv(newSVrv(rv,classname), uv);
7343 =for apidoc sv_setref_nv
7345 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7346 argument will be upgraded to an RV. That RV will be modified to point to
7347 the new SV. The C<classname> argument indicates the package for the
7348 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7349 will have a reference count of 1, and the RV will be returned.
7355 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7357 sv_setnv(newSVrv(rv,classname), nv);
7362 =for apidoc sv_setref_pvn
7364 Copies a string into a new SV, optionally blessing the SV. The length of the
7365 string must be specified with C<n>. The C<rv> argument will be upgraded to
7366 an RV. That RV will be modified to point to the new SV. The C<classname>
7367 argument indicates the package for the blessing. Set C<classname> to
7368 C<Nullch> to avoid the blessing. The new SV will have a reference count
7369 of 1, and the RV will be returned.
7371 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7377 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7379 sv_setpvn(newSVrv(rv,classname), pv, n);
7384 =for apidoc sv_bless
7386 Blesses an SV into a specified package. The SV must be an RV. The package
7387 must be designated by its stash (see C<gv_stashpv()>). The reference count
7388 of the SV is unaffected.
7394 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7399 Perl_croak(aTHX_ "Can't bless non-reference value");
7401 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7402 if (SvREADONLY(tmpRef))
7403 Perl_croak(aTHX_ PL_no_modify);
7404 if (SvOBJECT(tmpRef)) {
7405 if (SvTYPE(tmpRef) != SVt_PVIO)
7407 SvREFCNT_dec(SvSTASH(tmpRef));
7410 SvOBJECT_on(tmpRef);
7411 if (SvTYPE(tmpRef) != SVt_PVIO)
7413 SvUPGRADE(tmpRef, SVt_PVMG);
7414 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7421 if(SvSMAGICAL(tmpRef))
7422 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7430 /* Downgrades a PVGV to a PVMG.
7434 S_sv_unglob(pTHX_ SV *sv)
7439 assert(SvTYPE(sv) == SVt_PVGV);
7444 sv_del_backref((SV*)GvSTASH(sv), sv);
7447 sv_unmagic(sv, PERL_MAGIC_glob);
7448 Safefree(GvNAME(sv));
7451 /* need to keep SvANY(sv) in the right arena */
7452 xpvmg = new_XPVMG();
7453 StructCopy(SvANY(sv), xpvmg, XPVMG);
7454 del_XPVGV(SvANY(sv));
7457 SvFLAGS(sv) &= ~SVTYPEMASK;
7458 SvFLAGS(sv) |= SVt_PVMG;
7462 =for apidoc sv_unref_flags
7464 Unsets the RV status of the SV, and decrements the reference count of
7465 whatever was being referenced by the RV. This can almost be thought of
7466 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7467 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7468 (otherwise the decrementing is conditional on the reference count being
7469 different from one or the reference being a readonly SV).
7476 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7478 SV* const target = SvRV(ref);
7480 if (SvWEAKREF(ref)) {
7481 sv_del_backref(target, ref);
7483 SvRV_set(ref, NULL);
7486 SvRV_set(ref, NULL);
7488 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7489 assigned to as BEGIN {$a = \"Foo"} will fail. */
7490 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7491 SvREFCNT_dec(target);
7492 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7493 sv_2mortal(target); /* Schedule for freeing later */
7497 =for apidoc sv_untaint
7499 Untaint an SV. Use C<SvTAINTED_off> instead.
7504 Perl_sv_untaint(pTHX_ SV *sv)
7506 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7507 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7514 =for apidoc sv_tainted
7516 Test an SV for taintedness. Use C<SvTAINTED> instead.
7521 Perl_sv_tainted(pTHX_ SV *sv)
7523 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7524 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7525 if (mg && (mg->mg_len & 1) )
7532 =for apidoc sv_setpviv
7534 Copies an integer into the given SV, also updating its string value.
7535 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7541 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7543 char buf[TYPE_CHARS(UV)];
7545 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7547 sv_setpvn(sv, ptr, ebuf - ptr);
7551 =for apidoc sv_setpviv_mg
7553 Like C<sv_setpviv>, but also handles 'set' magic.
7559 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7565 #if defined(PERL_IMPLICIT_CONTEXT)
7567 /* pTHX_ magic can't cope with varargs, so this is a no-context
7568 * version of the main function, (which may itself be aliased to us).
7569 * Don't access this version directly.
7573 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7577 va_start(args, pat);
7578 sv_vsetpvf(sv, pat, &args);
7582 /* pTHX_ magic can't cope with varargs, so this is a no-context
7583 * version of the main function, (which may itself be aliased to us).
7584 * Don't access this version directly.
7588 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7592 va_start(args, pat);
7593 sv_vsetpvf_mg(sv, pat, &args);
7599 =for apidoc sv_setpvf
7601 Works like C<sv_catpvf> but copies the text into the SV instead of
7602 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7608 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7611 va_start(args, pat);
7612 sv_vsetpvf(sv, pat, &args);
7617 =for apidoc sv_vsetpvf
7619 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7620 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7622 Usually used via its frontend C<sv_setpvf>.
7628 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7630 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7634 =for apidoc sv_setpvf_mg
7636 Like C<sv_setpvf>, but also handles 'set' magic.
7642 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7645 va_start(args, pat);
7646 sv_vsetpvf_mg(sv, pat, &args);
7651 =for apidoc sv_vsetpvf_mg
7653 Like C<sv_vsetpvf>, but also handles 'set' magic.
7655 Usually used via its frontend C<sv_setpvf_mg>.
7661 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7663 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7667 #if defined(PERL_IMPLICIT_CONTEXT)
7669 /* pTHX_ magic can't cope with varargs, so this is a no-context
7670 * version of the main function, (which may itself be aliased to us).
7671 * Don't access this version directly.
7675 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7679 va_start(args, pat);
7680 sv_vcatpvf(sv, pat, &args);
7684 /* pTHX_ magic can't cope with varargs, so this is a no-context
7685 * version of the main function, (which may itself be aliased to us).
7686 * Don't access this version directly.
7690 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7694 va_start(args, pat);
7695 sv_vcatpvf_mg(sv, pat, &args);
7701 =for apidoc sv_catpvf
7703 Processes its arguments like C<sprintf> and appends the formatted
7704 output to an SV. If the appended data contains "wide" characters
7705 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7706 and characters >255 formatted with %c), the original SV might get
7707 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7708 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7709 valid UTF-8; if the original SV was bytes, the pattern should be too.
7714 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7717 va_start(args, pat);
7718 sv_vcatpvf(sv, pat, &args);
7723 =for apidoc sv_vcatpvf
7725 Processes its arguments like C<vsprintf> and appends the formatted output
7726 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7728 Usually used via its frontend C<sv_catpvf>.
7734 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7736 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7740 =for apidoc sv_catpvf_mg
7742 Like C<sv_catpvf>, but also handles 'set' magic.
7748 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7751 va_start(args, pat);
7752 sv_vcatpvf_mg(sv, pat, &args);
7757 =for apidoc sv_vcatpvf_mg
7759 Like C<sv_vcatpvf>, but also handles 'set' magic.
7761 Usually used via its frontend C<sv_catpvf_mg>.
7767 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7769 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7774 =for apidoc sv_vsetpvfn
7776 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7779 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7785 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7787 sv_setpvn(sv, "", 0);
7788 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7792 S_expect_number(pTHX_ char** pattern)
7796 switch (**pattern) {
7797 case '1': case '2': case '3':
7798 case '4': case '5': case '6':
7799 case '7': case '8': case '9':
7800 var = *(*pattern)++ - '0';
7801 while (isDIGIT(**pattern)) {
7802 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7804 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7812 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7814 const int neg = nv < 0;
7823 if (uv & 1 && uv == nv)
7824 uv--; /* Round to even */
7826 const unsigned dig = uv % 10;
7839 =for apidoc sv_vcatpvfn
7841 Processes its arguments like C<vsprintf> and appends the formatted output
7842 to an SV. Uses an array of SVs if the C style variable argument list is
7843 missing (NULL). When running with taint checks enabled, indicates via
7844 C<maybe_tainted> if results are untrustworthy (often due to the use of
7847 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7853 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7854 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7855 vec_utf8 = DO_UTF8(vecsv);
7857 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7860 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7868 static const char nullstr[] = "(null)";
7870 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7871 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7873 /* Times 4: a decimal digit takes more than 3 binary digits.
7874 * NV_DIG: mantissa takes than many decimal digits.
7875 * Plus 32: Playing safe. */
7876 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7877 /* large enough for "%#.#f" --chip */
7878 /* what about long double NVs? --jhi */
7880 PERL_UNUSED_ARG(maybe_tainted);
7882 /* no matter what, this is a string now */
7883 (void)SvPV_force(sv, origlen);
7885 /* special-case "", "%s", and "%-p" (SVf - see below) */
7888 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7890 const char * const s = va_arg(*args, char*);
7891 sv_catpv(sv, s ? s : nullstr);
7893 else if (svix < svmax) {
7894 sv_catsv(sv, *svargs);
7898 if (args && patlen == 3 && pat[0] == '%' &&
7899 pat[1] == '-' && pat[2] == 'p') {
7900 argsv = va_arg(*args, SV*);
7901 sv_catsv(sv, argsv);
7905 #ifndef USE_LONG_DOUBLE
7906 /* special-case "%.<number>[gf]" */
7907 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7908 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7909 unsigned digits = 0;
7913 while (*pp >= '0' && *pp <= '9')
7914 digits = 10 * digits + (*pp++ - '0');
7915 if (pp - pat == (int)patlen - 1) {
7923 /* Add check for digits != 0 because it seems that some
7924 gconverts are buggy in this case, and we don't yet have
7925 a Configure test for this. */
7926 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7927 /* 0, point, slack */
7928 Gconvert(nv, (int)digits, 0, ebuf);
7930 if (*ebuf) /* May return an empty string for digits==0 */
7933 } else if (!digits) {
7936 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7937 sv_catpvn(sv, p, l);
7943 #endif /* !USE_LONG_DOUBLE */
7945 if (!args && svix < svmax && DO_UTF8(*svargs))
7948 patend = (char*)pat + patlen;
7949 for (p = (char*)pat; p < patend; p = q) {
7952 bool vectorize = FALSE;
7953 bool vectorarg = FALSE;
7954 bool vec_utf8 = FALSE;
7960 bool has_precis = FALSE;
7962 const I32 osvix = svix;
7963 bool is_utf8 = FALSE; /* is this item utf8? */
7964 #ifdef HAS_LDBL_SPRINTF_BUG
7965 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7966 with sfio - Allen <allens@cpan.org> */
7967 bool fix_ldbl_sprintf_bug = FALSE;
7971 U8 utf8buf[UTF8_MAXBYTES+1];
7972 STRLEN esignlen = 0;
7974 const char *eptr = Nullch;
7977 const U8 *vecstr = Null(U8*);
7984 /* we need a long double target in case HAS_LONG_DOUBLE but
7987 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7995 const char *dotstr = ".";
7996 STRLEN dotstrlen = 1;
7997 I32 efix = 0; /* explicit format parameter index */
7998 I32 ewix = 0; /* explicit width index */
7999 I32 epix = 0; /* explicit precision index */
8000 I32 evix = 0; /* explicit vector index */
8001 bool asterisk = FALSE;
8003 /* echo everything up to the next format specification */
8004 for (q = p; q < patend && *q != '%'; ++q) ;
8006 if (has_utf8 && !pat_utf8)
8007 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8009 sv_catpvn(sv, p, q - p);
8016 We allow format specification elements in this order:
8017 \d+\$ explicit format parameter index
8019 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8020 0 flag (as above): repeated to allow "v02"
8021 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8022 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8024 [%bcdefginopsuxDFOUX] format (mandatory)
8029 As of perl5.9.3, printf format checking is on by default.
8030 Internally, perl uses %p formats to provide an escape to
8031 some extended formatting. This block deals with those
8032 extensions: if it does not match, (char*)q is reset and
8033 the normal format processing code is used.
8035 Currently defined extensions are:
8036 %p include pointer address (standard)
8037 %-p (SVf) include an SV (previously %_)
8038 %-<num>p include an SV with precision <num>
8039 %1p (VDf) include a v-string (as %vd)
8040 %<num>p reserved for future extensions
8042 Robin Barker 2005-07-14
8049 n = expect_number(&q);
8056 argsv = va_arg(*args, SV*);
8057 eptr = SvPVx_const(argsv, elen);
8063 else if (n == vdNUMBER) { /* VDf */
8070 if (ckWARN_d(WARN_INTERNAL))
8071 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8072 "internal %%<num>p might conflict with future printf extensions");
8078 if ( (width = expect_number(&q)) ) {
8119 if ( (ewix = expect_number(&q)) )
8128 if ((vectorarg = asterisk)) {
8141 width = expect_number(&q);
8147 vecsv = va_arg(*args, SV*);
8149 vecsv = (evix > 0 && evix <= svmax)
8150 ? svargs[evix-1] : &PL_sv_undef;
8152 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8154 dotstr = SvPV_const(vecsv, dotstrlen);
8155 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8156 bad with tied or overloaded values that return UTF8. */
8159 else if (has_utf8) {
8160 vecsv = sv_mortalcopy(vecsv);
8161 sv_utf8_upgrade(vecsv);
8162 dotstr = SvPV_const(vecsv, dotstrlen);
8169 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8170 vecsv = svargs[efix ? efix-1 : svix++];
8171 vecstr = (U8*)SvPV_const(vecsv,veclen);
8172 vec_utf8 = DO_UTF8(vecsv);
8174 /* if this is a version object, we need to convert
8175 * back into v-string notation and then let the
8176 * vectorize happen normally
8178 if (sv_derived_from(vecsv, "version")) {
8179 char *version = savesvpv(vecsv);
8180 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8181 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8182 "vector argument not supported with alpha versions");
8185 vecsv = sv_newmortal();
8186 /* scan_vstring is expected to be called during
8187 * tokenization, so we need to fake up the end
8188 * of the buffer for it
8190 PL_bufend = version + veclen;
8191 scan_vstring(version, vecsv);
8192 vecstr = (U8*)SvPV_const(vecsv, veclen);
8193 vec_utf8 = DO_UTF8(vecsv);
8205 i = va_arg(*args, int);
8207 i = (ewix ? ewix <= svmax : svix < svmax) ?
8208 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8210 width = (i < 0) ? -i : i;
8220 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8222 /* XXX: todo, support specified precision parameter */
8226 i = va_arg(*args, int);
8228 i = (ewix ? ewix <= svmax : svix < svmax)
8229 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8230 precis = (i < 0) ? 0 : i;
8235 precis = precis * 10 + (*q++ - '0');
8244 case 'I': /* Ix, I32x, and I64x */
8246 if (q[1] == '6' && q[2] == '4') {
8252 if (q[1] == '3' && q[2] == '2') {
8262 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8273 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8274 if (*(q + 1) == 'l') { /* lld, llf */
8300 if (!vectorize && !args) {
8302 const I32 i = efix-1;
8303 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8305 argsv = (svix >= 0 && svix < svmax)
8306 ? svargs[svix++] : &PL_sv_undef;
8317 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8319 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8321 eptr = (char*)utf8buf;
8322 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8336 eptr = va_arg(*args, char*);
8338 #ifdef MACOS_TRADITIONAL
8339 /* On MacOS, %#s format is used for Pascal strings */
8344 elen = strlen(eptr);
8346 eptr = (char *)nullstr;
8347 elen = sizeof nullstr - 1;
8351 eptr = SvPVx_const(argsv, elen);
8352 if (DO_UTF8(argsv)) {
8353 if (has_precis && precis < elen) {
8355 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8358 if (width) { /* fudge width (can't fudge elen) */
8359 width += elen - sv_len_utf8(argsv);
8366 if (has_precis && elen > precis)
8373 if (alt || vectorize)
8375 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8396 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8405 esignbuf[esignlen++] = plus;
8409 case 'h': iv = (short)va_arg(*args, int); break;
8410 case 'l': iv = va_arg(*args, long); break;
8411 case 'V': iv = va_arg(*args, IV); break;
8412 default: iv = va_arg(*args, int); break;
8414 case 'q': iv = va_arg(*args, Quad_t); break;
8419 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8421 case 'h': iv = (short)tiv; break;
8422 case 'l': iv = (long)tiv; break;
8424 default: iv = tiv; break;
8426 case 'q': iv = (Quad_t)tiv; break;
8430 if ( !vectorize ) /* we already set uv above */
8435 esignbuf[esignlen++] = plus;
8439 esignbuf[esignlen++] = '-';
8482 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8493 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8494 case 'l': uv = va_arg(*args, unsigned long); break;
8495 case 'V': uv = va_arg(*args, UV); break;
8496 default: uv = va_arg(*args, unsigned); break;
8498 case 'q': uv = va_arg(*args, Uquad_t); break;
8503 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8505 case 'h': uv = (unsigned short)tuv; break;
8506 case 'l': uv = (unsigned long)tuv; break;
8508 default: uv = tuv; break;
8510 case 'q': uv = (Uquad_t)tuv; break;
8517 char *ptr = ebuf + sizeof ebuf;
8523 p = (char*)((c == 'X')
8524 ? "0123456789ABCDEF" : "0123456789abcdef");
8530 esignbuf[esignlen++] = '0';
8531 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8539 if (alt && *ptr != '0')
8550 esignbuf[esignlen++] = '0';
8551 esignbuf[esignlen++] = 'b';
8554 default: /* it had better be ten or less */
8558 } while (uv /= base);
8561 elen = (ebuf + sizeof ebuf) - ptr;
8565 zeros = precis - elen;
8566 else if (precis == 0 && elen == 1 && *eptr == '0')
8572 /* FLOATING POINT */
8575 c = 'f'; /* maybe %F isn't supported here */
8583 /* This is evil, but floating point is even more evil */
8585 /* for SV-style calling, we can only get NV
8586 for C-style calling, we assume %f is double;
8587 for simplicity we allow any of %Lf, %llf, %qf for long double
8591 #if defined(USE_LONG_DOUBLE)
8595 /* [perl #20339] - we should accept and ignore %lf rather than die */
8599 #if defined(USE_LONG_DOUBLE)
8600 intsize = args ? 0 : 'q';
8604 #if defined(HAS_LONG_DOUBLE)
8613 /* now we need (long double) if intsize == 'q', else (double) */
8615 #if LONG_DOUBLESIZE > DOUBLESIZE
8617 va_arg(*args, long double) :
8618 va_arg(*args, double)
8620 va_arg(*args, double)
8625 if (c != 'e' && c != 'E') {
8627 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8628 will cast our (long double) to (double) */
8629 (void)Perl_frexp(nv, &i);
8630 if (i == PERL_INT_MIN)
8631 Perl_die(aTHX_ "panic: frexp");
8633 need = BIT_DIGITS(i);
8635 need += has_precis ? precis : 6; /* known default */
8640 #ifdef HAS_LDBL_SPRINTF_BUG
8641 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8642 with sfio - Allen <allens@cpan.org> */
8645 # define MY_DBL_MAX DBL_MAX
8646 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8647 # if DOUBLESIZE >= 8
8648 # define MY_DBL_MAX 1.7976931348623157E+308L
8650 # define MY_DBL_MAX 3.40282347E+38L
8654 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8655 # define MY_DBL_MAX_BUG 1L
8657 # define MY_DBL_MAX_BUG MY_DBL_MAX
8661 # define MY_DBL_MIN DBL_MIN
8662 # else /* XXX guessing! -Allen */
8663 # if DOUBLESIZE >= 8
8664 # define MY_DBL_MIN 2.2250738585072014E-308L
8666 # define MY_DBL_MIN 1.17549435E-38L
8670 if ((intsize == 'q') && (c == 'f') &&
8671 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8673 /* it's going to be short enough that
8674 * long double precision is not needed */
8676 if ((nv <= 0L) && (nv >= -0L))
8677 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8679 /* would use Perl_fp_class as a double-check but not
8680 * functional on IRIX - see perl.h comments */
8682 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8683 /* It's within the range that a double can represent */
8684 #if defined(DBL_MAX) && !defined(DBL_MIN)
8685 if ((nv >= ((long double)1/DBL_MAX)) ||
8686 (nv <= (-(long double)1/DBL_MAX)))
8688 fix_ldbl_sprintf_bug = TRUE;
8691 if (fix_ldbl_sprintf_bug == TRUE) {
8701 # undef MY_DBL_MAX_BUG
8704 #endif /* HAS_LDBL_SPRINTF_BUG */
8706 need += 20; /* fudge factor */
8707 if (PL_efloatsize < need) {
8708 Safefree(PL_efloatbuf);
8709 PL_efloatsize = need + 20; /* more fudge */
8710 Newx(PL_efloatbuf, PL_efloatsize, char);
8711 PL_efloatbuf[0] = '\0';
8714 if ( !(width || left || plus || alt) && fill != '0'
8715 && has_precis && intsize != 'q' ) { /* Shortcuts */
8716 /* See earlier comment about buggy Gconvert when digits,
8718 if ( c == 'g' && precis) {
8719 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8720 /* May return an empty string for digits==0 */
8721 if (*PL_efloatbuf) {
8722 elen = strlen(PL_efloatbuf);
8723 goto float_converted;
8725 } else if ( c == 'f' && !precis) {
8726 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8731 char *ptr = ebuf + sizeof ebuf;
8734 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8735 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8736 if (intsize == 'q') {
8737 /* Copy the one or more characters in a long double
8738 * format before the 'base' ([efgEFG]) character to
8739 * the format string. */
8740 static char const prifldbl[] = PERL_PRIfldbl;
8741 char const *p = prifldbl + sizeof(prifldbl) - 3;
8742 while (p >= prifldbl) { *--ptr = *p--; }
8747 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8752 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8764 /* No taint. Otherwise we are in the strange situation
8765 * where printf() taints but print($float) doesn't.
8767 #if defined(HAS_LONG_DOUBLE)
8768 elen = ((intsize == 'q')
8769 ? my_sprintf(PL_efloatbuf, ptr, nv)
8770 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8772 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8776 eptr = PL_efloatbuf;
8784 i = SvCUR(sv) - origlen;
8787 case 'h': *(va_arg(*args, short*)) = i; break;
8788 default: *(va_arg(*args, int*)) = i; break;
8789 case 'l': *(va_arg(*args, long*)) = i; break;
8790 case 'V': *(va_arg(*args, IV*)) = i; break;
8792 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8797 sv_setuv_mg(argsv, (UV)i);
8798 continue; /* not "break" */
8805 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8806 && ckWARN(WARN_PRINTF))
8808 SV * const msg = sv_newmortal();
8809 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8810 (PL_op->op_type == OP_PRTF) ? "" : "s");
8813 Perl_sv_catpvf(aTHX_ msg,
8814 "\"%%%c\"", c & 0xFF);
8816 Perl_sv_catpvf(aTHX_ msg,
8817 "\"%%\\%03"UVof"\"",
8820 sv_catpvs(msg, "end of string");
8821 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8824 /* output mangled stuff ... */
8830 /* ... right here, because formatting flags should not apply */
8831 SvGROW(sv, SvCUR(sv) + elen + 1);
8833 Copy(eptr, p, elen, char);
8836 SvCUR_set(sv, p - SvPVX_const(sv));
8838 continue; /* not "break" */
8841 /* calculate width before utf8_upgrade changes it */
8842 have = esignlen + zeros + elen;
8844 Perl_croak_nocontext(PL_memory_wrap);
8846 if (is_utf8 != has_utf8) {
8849 sv_utf8_upgrade(sv);
8852 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8853 sv_utf8_upgrade(nsv);
8854 eptr = SvPVX_const(nsv);
8857 SvGROW(sv, SvCUR(sv) + elen + 1);
8862 need = (have > width ? have : width);
8865 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8866 Perl_croak_nocontext(PL_memory_wrap);
8867 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8869 if (esignlen && fill == '0') {
8871 for (i = 0; i < (int)esignlen; i++)
8875 memset(p, fill, gap);
8878 if (esignlen && fill != '0') {
8880 for (i = 0; i < (int)esignlen; i++)
8885 for (i = zeros; i; i--)
8889 Copy(eptr, p, elen, char);
8893 memset(p, ' ', gap);
8898 Copy(dotstr, p, dotstrlen, char);
8902 vectorize = FALSE; /* done iterating over vecstr */
8909 SvCUR_set(sv, p - SvPVX_const(sv));
8917 /* =========================================================================
8919 =head1 Cloning an interpreter
8921 All the macros and functions in this section are for the private use of
8922 the main function, perl_clone().
8924 The foo_dup() functions make an exact copy of an existing foo thinngy.
8925 During the course of a cloning, a hash table is used to map old addresses
8926 to new addresses. The table is created and manipulated with the
8927 ptr_table_* functions.
8931 ============================================================================*/
8934 #if defined(USE_ITHREADS)
8936 #ifndef GpREFCNT_inc
8937 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8941 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8942 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8943 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8944 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8945 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8946 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8947 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8948 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8949 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8950 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8951 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8952 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8953 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8956 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8957 regcomp.c. AMS 20010712 */
8960 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8965 struct reg_substr_datum *s;
8968 return (REGEXP *)NULL;
8970 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8973 len = r->offsets[0];
8974 npar = r->nparens+1;
8976 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8977 Copy(r->program, ret->program, len+1, regnode);
8979 Newx(ret->startp, npar, I32);
8980 Copy(r->startp, ret->startp, npar, I32);
8981 Newx(ret->endp, npar, I32);
8982 Copy(r->startp, ret->startp, npar, I32);
8984 Newx(ret->substrs, 1, struct reg_substr_data);
8985 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8986 s->min_offset = r->substrs->data[i].min_offset;
8987 s->max_offset = r->substrs->data[i].max_offset;
8988 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8989 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8992 ret->regstclass = NULL;
8995 const int count = r->data->count;
8998 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8999 char, struct reg_data);
9000 Newx(d->what, count, U8);
9003 for (i = 0; i < count; i++) {
9004 d->what[i] = r->data->what[i];
9005 switch (d->what[i]) {
9006 /* legal options are one of: sfpont
9007 see also regcomp.h and pregfree() */
9009 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9012 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9015 /* This is cheating. */
9016 Newx(d->data[i], 1, struct regnode_charclass_class);
9017 StructCopy(r->data->data[i], d->data[i],
9018 struct regnode_charclass_class);
9019 ret->regstclass = (regnode*)d->data[i];
9022 /* Compiled op trees are readonly, and can thus be
9023 shared without duplication. */
9025 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9029 d->data[i] = r->data->data[i];
9032 d->data[i] = r->data->data[i];
9034 ((reg_trie_data*)d->data[i])->refcount++;
9038 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9047 Newx(ret->offsets, 2*len+1, U32);
9048 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9050 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9051 ret->refcnt = r->refcnt;
9052 ret->minlen = r->minlen;
9053 ret->prelen = r->prelen;
9054 ret->nparens = r->nparens;
9055 ret->lastparen = r->lastparen;
9056 ret->lastcloseparen = r->lastcloseparen;
9057 ret->reganch = r->reganch;
9059 ret->sublen = r->sublen;
9061 if (RX_MATCH_COPIED(ret))
9062 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9064 ret->subbeg = Nullch;
9065 #ifdef PERL_OLD_COPY_ON_WRITE
9066 ret->saved_copy = Nullsv;
9069 ptr_table_store(PL_ptr_table, r, ret);
9073 /* duplicate a file handle */
9076 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9080 PERL_UNUSED_ARG(type);
9083 return (PerlIO*)NULL;
9085 /* look for it in the table first */
9086 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9090 /* create anew and remember what it is */
9091 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9092 ptr_table_store(PL_ptr_table, fp, ret);
9096 /* duplicate a directory handle */
9099 Perl_dirp_dup(pTHX_ DIR *dp)
9107 /* duplicate a typeglob */
9110 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9115 /* look for it in the table first */
9116 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9120 /* create anew and remember what it is */
9122 ptr_table_store(PL_ptr_table, gp, ret);
9125 ret->gp_refcnt = 0; /* must be before any other dups! */
9126 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9127 ret->gp_io = io_dup_inc(gp->gp_io, param);
9128 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9129 ret->gp_av = av_dup_inc(gp->gp_av, param);
9130 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9131 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9132 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9133 ret->gp_cvgen = gp->gp_cvgen;
9134 ret->gp_line = gp->gp_line;
9135 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9139 /* duplicate a chain of magic */
9142 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9144 MAGIC *mgprev = (MAGIC*)NULL;
9147 return (MAGIC*)NULL;
9148 /* look for it in the table first */
9149 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9153 for (; mg; mg = mg->mg_moremagic) {
9155 Newxz(nmg, 1, MAGIC);
9157 mgprev->mg_moremagic = nmg;
9160 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9161 nmg->mg_private = mg->mg_private;
9162 nmg->mg_type = mg->mg_type;
9163 nmg->mg_flags = mg->mg_flags;
9164 if (mg->mg_type == PERL_MAGIC_qr) {
9165 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9167 else if(mg->mg_type == PERL_MAGIC_backref) {
9168 /* The backref AV has its reference count deliberately bumped by
9170 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9172 else if (mg->mg_type == PERL_MAGIC_symtab) {
9173 nmg->mg_obj = mg->mg_obj;
9176 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9177 ? sv_dup_inc(mg->mg_obj, param)
9178 : sv_dup(mg->mg_obj, param);
9180 nmg->mg_len = mg->mg_len;
9181 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9182 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9183 if (mg->mg_len > 0) {
9184 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9185 if (mg->mg_type == PERL_MAGIC_overload_table &&
9186 AMT_AMAGIC((AMT*)mg->mg_ptr))
9188 const AMT * const amtp = (AMT*)mg->mg_ptr;
9189 AMT * const namtp = (AMT*)nmg->mg_ptr;
9191 for (i = 1; i < NofAMmeth; i++) {
9192 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9196 else if (mg->mg_len == HEf_SVKEY)
9197 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9199 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9200 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9207 /* create a new pointer-mapping table */
9210 Perl_ptr_table_new(pTHX)
9213 Newxz(tbl, 1, PTR_TBL_t);
9216 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9220 #define PTR_TABLE_HASH(ptr) \
9221 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9224 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9225 following define) and at call to new_body_inline made below in
9226 Perl_ptr_table_store()
9229 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9231 /* map an existing pointer using a table */
9233 STATIC PTR_TBL_ENT_t *
9234 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9235 PTR_TBL_ENT_t *tblent;
9236 const UV hash = PTR_TABLE_HASH(sv);
9238 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9239 for (; tblent; tblent = tblent->next) {
9240 if (tblent->oldval == sv)
9247 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9249 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9250 return tblent ? tblent->newval : (void *) 0;
9253 /* add a new entry to a pointer-mapping table */
9256 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9258 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9261 tblent->newval = newsv;
9263 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9265 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9266 tblent->oldval = oldsv;
9267 tblent->newval = newsv;
9268 tblent->next = tbl->tbl_ary[entry];
9269 tbl->tbl_ary[entry] = tblent;
9271 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9272 ptr_table_split(tbl);
9276 /* double the hash bucket size of an existing ptr table */
9279 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9281 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9282 const UV oldsize = tbl->tbl_max + 1;
9283 UV newsize = oldsize * 2;
9286 Renew(ary, newsize, PTR_TBL_ENT_t*);
9287 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9288 tbl->tbl_max = --newsize;
9290 for (i=0; i < oldsize; i++, ary++) {
9291 PTR_TBL_ENT_t **curentp, **entp, *ent;
9294 curentp = ary + oldsize;
9295 for (entp = ary, ent = *ary; ent; ent = *entp) {
9296 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9298 ent->next = *curentp;
9308 /* remove all the entries from a ptr table */
9311 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9313 if (tbl && tbl->tbl_items) {
9314 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9315 UV riter = tbl->tbl_max;
9318 PTR_TBL_ENT_t *entry = array[riter];
9321 PTR_TBL_ENT_t * const oentry = entry;
9322 entry = entry->next;
9331 /* clear and free a ptr table */
9334 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9339 ptr_table_clear(tbl);
9340 Safefree(tbl->tbl_ary);
9346 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9349 SvRV_set(dstr, SvWEAKREF(sstr)
9350 ? sv_dup(SvRV(sstr), param)
9351 : sv_dup_inc(SvRV(sstr), param));
9354 else if (SvPVX_const(sstr)) {
9355 /* Has something there */
9357 /* Normal PV - clone whole allocated space */
9358 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9359 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9360 /* Not that normal - actually sstr is copy on write.
9361 But we are a true, independant SV, so: */
9362 SvREADONLY_off(dstr);
9367 /* Special case - not normally malloced for some reason */
9368 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9369 /* A "shared" PV - clone it as "shared" PV */
9371 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9375 /* Some other special case - random pointer */
9376 SvPV_set(dstr, SvPVX(sstr));
9382 if (SvTYPE(dstr) == SVt_RV)
9383 SvRV_set(dstr, NULL);
9385 SvPV_set(dstr, NULL);
9389 /* duplicate an SV of any type (including AV, HV etc) */
9392 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9397 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9399 /* look for it in the table first */
9400 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9404 if(param->flags & CLONEf_JOIN_IN) {
9405 /** We are joining here so we don't want do clone
9406 something that is bad **/
9407 if (SvTYPE(sstr) == SVt_PVHV) {
9408 const char * const hvname = HvNAME_get(sstr);
9410 /** don't clone stashes if they already exist **/
9411 return (SV*)gv_stashpv(hvname,0);
9415 /* create anew and remember what it is */
9418 #ifdef DEBUG_LEAKING_SCALARS
9419 dstr->sv_debug_optype = sstr->sv_debug_optype;
9420 dstr->sv_debug_line = sstr->sv_debug_line;
9421 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9422 dstr->sv_debug_cloned = 1;
9423 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9426 ptr_table_store(PL_ptr_table, sstr, dstr);
9429 SvFLAGS(dstr) = SvFLAGS(sstr);
9430 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9431 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9434 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9435 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9436 PL_watch_pvx, SvPVX_const(sstr));
9439 /* don't clone objects whose class has asked us not to */
9440 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9441 SvFLAGS(dstr) &= ~SVTYPEMASK;
9446 switch (SvTYPE(sstr)) {
9451 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9452 SvIV_set(dstr, SvIVX(sstr));
9455 SvANY(dstr) = new_XNV();
9456 SvNV_set(dstr, SvNVX(sstr));
9459 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9460 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9464 /* These are all the types that need complex bodies allocating. */
9466 const svtype sv_type = SvTYPE(sstr);
9467 const struct body_details *const sv_type_details
9468 = bodies_by_type + sv_type;
9472 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9477 if (GvUNIQUE((GV*)sstr)) {
9478 /* Do sharing here, and fall through */
9491 assert(sv_type_details->size);
9492 if (sv_type_details->arena) {
9493 new_body_inline(new_body, sv_type_details->size, sv_type);
9495 = (void*)((char*)new_body - sv_type_details->offset);
9497 new_body = new_NOARENA(sv_type_details);
9501 SvANY(dstr) = new_body;
9504 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9505 ((char*)SvANY(dstr)) + sv_type_details->offset,
9506 sv_type_details->copy, char);
9508 Copy(((char*)SvANY(sstr)),
9509 ((char*)SvANY(dstr)),
9510 sv_type_details->size + sv_type_details->offset, char);
9513 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9514 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9516 /* The Copy above means that all the source (unduplicated) pointers
9517 are now in the destination. We can check the flags and the
9518 pointers in either, but it's possible that there's less cache
9519 missing by always going for the destination.
9520 FIXME - instrument and check that assumption */
9521 if (sv_type >= SVt_PVMG) {
9523 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9525 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9528 /* The cast silences a GCC warning about unhandled types. */
9529 switch ((int)sv_type) {
9541 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9542 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9543 LvTARG(dstr) = dstr;
9544 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9545 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9547 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9550 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9551 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9552 /* Don't call sv_add_backref here as it's going to be created
9553 as part of the magic cloning of the symbol table. */
9554 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9555 (void)GpREFCNT_inc(GvGP(dstr));
9558 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9559 if (IoOFP(dstr) == IoIFP(sstr))
9560 IoOFP(dstr) = IoIFP(dstr);
9562 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9563 /* PL_rsfp_filters entries have fake IoDIRP() */
9564 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9565 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9566 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9567 /* I have no idea why fake dirp (rsfps)
9568 should be treated differently but otherwise
9569 we end up with leaks -- sky*/
9570 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9571 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9572 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9574 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9575 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9576 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9578 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9579 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9580 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9583 if (AvARRAY((AV*)sstr)) {
9584 SV **dst_ary, **src_ary;
9585 SSize_t items = AvFILLp((AV*)sstr) + 1;
9587 src_ary = AvARRAY((AV*)sstr);
9588 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9589 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9590 SvPV_set(dstr, (char*)dst_ary);
9591 AvALLOC((AV*)dstr) = dst_ary;
9592 if (AvREAL((AV*)sstr)) {
9594 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9598 *dst_ary++ = sv_dup(*src_ary++, param);
9600 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9601 while (items-- > 0) {
9602 *dst_ary++ = &PL_sv_undef;
9606 SvPV_set(dstr, Nullch);
9607 AvALLOC((AV*)dstr) = (SV**)NULL;
9614 if (HvARRAY((HV*)sstr)) {
9616 const bool sharekeys = !!HvSHAREKEYS(sstr);
9617 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9618 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9620 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9621 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9623 HvARRAY(dstr) = (HE**)darray;
9624 while (i <= sxhv->xhv_max) {
9625 const HE *source = HvARRAY(sstr)[i];
9626 HvARRAY(dstr)[i] = source
9627 ? he_dup(source, sharekeys, param) : 0;
9631 struct xpvhv_aux * const saux = HvAUX(sstr);
9632 struct xpvhv_aux * const daux = HvAUX(dstr);
9633 /* This flag isn't copied. */
9634 /* SvOOK_on(hv) attacks the IV flags. */
9635 SvFLAGS(dstr) |= SVf_OOK;
9637 hvname = saux->xhv_name;
9639 = hvname ? hek_dup(hvname, param) : hvname;
9641 daux->xhv_riter = saux->xhv_riter;
9642 daux->xhv_eiter = saux->xhv_eiter
9643 ? he_dup(saux->xhv_eiter,
9644 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9645 daux->xhv_backreferences = saux->xhv_backreferences
9646 ? (AV*) SvREFCNT_inc(
9654 SvPV_set(dstr, Nullch);
9656 /* Record stashes for possible cloning in Perl_clone(). */
9658 av_push(param->stashes, dstr);
9663 /* NOTE: not refcounted */
9664 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9666 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9668 if (CvCONST(dstr)) {
9669 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9670 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9671 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9673 /* don't dup if copying back - CvGV isn't refcounted, so the
9674 * duped GV may never be freed. A bit of a hack! DAPM */
9675 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9676 Nullgv : gv_dup(CvGV(dstr), param) ;
9677 if (!(param->flags & CLONEf_COPY_STACKS)) {
9680 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9683 ? cv_dup( CvOUTSIDE(dstr), param)
9684 : cv_dup_inc(CvOUTSIDE(dstr), param);
9686 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9692 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9698 /* duplicate a context */
9701 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9706 return (PERL_CONTEXT*)NULL;
9708 /* look for it in the table first */
9709 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9713 /* create anew and remember what it is */
9714 Newxz(ncxs, max + 1, PERL_CONTEXT);
9715 ptr_table_store(PL_ptr_table, cxs, ncxs);
9718 PERL_CONTEXT * const cx = &cxs[ix];
9719 PERL_CONTEXT * const ncx = &ncxs[ix];
9720 ncx->cx_type = cx->cx_type;
9721 if (CxTYPE(cx) == CXt_SUBST) {
9722 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9725 ncx->blk_oldsp = cx->blk_oldsp;
9726 ncx->blk_oldcop = cx->blk_oldcop;
9727 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9728 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9729 ncx->blk_oldpm = cx->blk_oldpm;
9730 ncx->blk_gimme = cx->blk_gimme;
9731 switch (CxTYPE(cx)) {
9733 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9734 ? cv_dup_inc(cx->blk_sub.cv, param)
9735 : cv_dup(cx->blk_sub.cv,param));
9736 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9737 ? av_dup_inc(cx->blk_sub.argarray, param)
9739 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9740 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9741 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9742 ncx->blk_sub.lval = cx->blk_sub.lval;
9743 ncx->blk_sub.retop = cx->blk_sub.retop;
9746 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9747 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9748 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9749 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9750 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9751 ncx->blk_eval.retop = cx->blk_eval.retop;
9754 ncx->blk_loop.label = cx->blk_loop.label;
9755 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9756 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9757 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9758 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9759 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9760 ? cx->blk_loop.iterdata
9761 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9762 ncx->blk_loop.oldcomppad
9763 = (PAD*)ptr_table_fetch(PL_ptr_table,
9764 cx->blk_loop.oldcomppad);
9765 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9766 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9767 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9768 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9769 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9772 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9773 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9774 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9775 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9776 ncx->blk_sub.retop = cx->blk_sub.retop;
9788 /* duplicate a stack info structure */
9791 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9796 return (PERL_SI*)NULL;
9798 /* look for it in the table first */
9799 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9803 /* create anew and remember what it is */
9804 Newxz(nsi, 1, PERL_SI);
9805 ptr_table_store(PL_ptr_table, si, nsi);
9807 nsi->si_stack = av_dup_inc(si->si_stack, param);
9808 nsi->si_cxix = si->si_cxix;
9809 nsi->si_cxmax = si->si_cxmax;
9810 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9811 nsi->si_type = si->si_type;
9812 nsi->si_prev = si_dup(si->si_prev, param);
9813 nsi->si_next = si_dup(si->si_next, param);
9814 nsi->si_markoff = si->si_markoff;
9819 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9820 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9821 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9822 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9823 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9824 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9825 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9826 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9827 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9828 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9829 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9830 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9831 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9832 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9835 #define pv_dup_inc(p) SAVEPV(p)
9836 #define pv_dup(p) SAVEPV(p)
9837 #define svp_dup_inc(p,pp) any_dup(p,pp)
9839 /* map any object to the new equivent - either something in the
9840 * ptr table, or something in the interpreter structure
9844 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9851 /* look for it in the table first */
9852 ret = ptr_table_fetch(PL_ptr_table, v);
9856 /* see if it is part of the interpreter structure */
9857 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9858 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9866 /* duplicate the save stack */
9869 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9871 ANY * const ss = proto_perl->Tsavestack;
9872 const I32 max = proto_perl->Tsavestack_max;
9873 I32 ix = proto_perl->Tsavestack_ix;
9885 void (*dptr) (void*);
9886 void (*dxptr) (pTHX_ void*);
9888 Newxz(nss, max, ANY);
9891 I32 i = POPINT(ss,ix);
9894 case SAVEt_ITEM: /* normal string */
9895 sv = (SV*)POPPTR(ss,ix);
9896 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9897 sv = (SV*)POPPTR(ss,ix);
9898 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9900 case SAVEt_SV: /* scalar reference */
9901 sv = (SV*)POPPTR(ss,ix);
9902 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9903 gv = (GV*)POPPTR(ss,ix);
9904 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9906 case SAVEt_GENERIC_PVREF: /* generic char* */
9907 c = (char*)POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = pv_dup(c);
9909 ptr = POPPTR(ss,ix);
9910 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9912 case SAVEt_SHARED_PVREF: /* char* in shared space */
9913 c = (char*)POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = savesharedpv(c);
9915 ptr = POPPTR(ss,ix);
9916 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9918 case SAVEt_GENERIC_SVREF: /* generic sv */
9919 case SAVEt_SVREF: /* scalar reference */
9920 sv = (SV*)POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9922 ptr = POPPTR(ss,ix);
9923 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9925 case SAVEt_AV: /* array reference */
9926 av = (AV*)POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = av_dup_inc(av, param);
9928 gv = (GV*)POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = gv_dup(gv, param);
9931 case SAVEt_HV: /* hash reference */
9932 hv = (HV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9934 gv = (GV*)POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = gv_dup(gv, param);
9937 case SAVEt_INT: /* int reference */
9938 ptr = POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9940 intval = (int)POPINT(ss,ix);
9941 TOPINT(nss,ix) = intval;
9943 case SAVEt_LONG: /* long reference */
9944 ptr = POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 longval = (long)POPLONG(ss,ix);
9947 TOPLONG(nss,ix) = longval;
9949 case SAVEt_I32: /* I32 reference */
9950 case SAVEt_I16: /* I16 reference */
9951 case SAVEt_I8: /* I8 reference */
9952 ptr = POPPTR(ss,ix);
9953 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9957 case SAVEt_IV: /* IV reference */
9958 ptr = POPPTR(ss,ix);
9959 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9963 case SAVEt_SPTR: /* SV* reference */
9964 ptr = POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9966 sv = (SV*)POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = sv_dup(sv, param);
9969 case SAVEt_VPTR: /* random* reference */
9970 ptr = POPPTR(ss,ix);
9971 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9972 ptr = POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9975 case SAVEt_PPTR: /* char* reference */
9976 ptr = POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9978 c = (char*)POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = pv_dup(c);
9981 case SAVEt_HPTR: /* HV* reference */
9982 ptr = POPPTR(ss,ix);
9983 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9984 hv = (HV*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = hv_dup(hv, param);
9987 case SAVEt_APTR: /* AV* reference */
9988 ptr = POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9990 av = (AV*)POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = av_dup(av, param);
9994 gv = (GV*)POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = gv_dup(gv, param);
9997 case SAVEt_GP: /* scalar reference */
9998 gp = (GP*)POPPTR(ss,ix);
9999 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10000 (void)GpREFCNT_inc(gp);
10001 gv = (GV*)POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10003 c = (char*)POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = pv_dup(c);
10006 TOPIV(nss,ix) = iv;
10008 TOPIV(nss,ix) = iv;
10011 case SAVEt_MORTALIZESV:
10012 sv = (SV*)POPPTR(ss,ix);
10013 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10016 ptr = POPPTR(ss,ix);
10017 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10018 /* these are assumed to be refcounted properly */
10020 switch (((OP*)ptr)->op_type) {
10022 case OP_LEAVESUBLV:
10026 case OP_LEAVEWRITE:
10027 TOPPTR(nss,ix) = ptr;
10032 TOPPTR(nss,ix) = Nullop;
10037 TOPPTR(nss,ix) = Nullop;
10040 c = (char*)POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = pv_dup_inc(c);
10043 case SAVEt_CLEARSV:
10044 longval = POPLONG(ss,ix);
10045 TOPLONG(nss,ix) = longval;
10048 hv = (HV*)POPPTR(ss,ix);
10049 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10050 c = (char*)POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = pv_dup_inc(c);
10053 TOPINT(nss,ix) = i;
10055 case SAVEt_DESTRUCTOR:
10056 ptr = POPPTR(ss,ix);
10057 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10058 dptr = POPDPTR(ss,ix);
10059 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10060 any_dup(FPTR2DPTR(void *, dptr),
10063 case SAVEt_DESTRUCTOR_X:
10064 ptr = POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10066 dxptr = POPDXPTR(ss,ix);
10067 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10068 any_dup(FPTR2DPTR(void *, dxptr),
10071 case SAVEt_REGCONTEXT:
10074 TOPINT(nss,ix) = i;
10077 case SAVEt_STACK_POS: /* Position on Perl stack */
10079 TOPINT(nss,ix) = i;
10081 case SAVEt_AELEM: /* array element */
10082 sv = (SV*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10085 TOPINT(nss,ix) = i;
10086 av = (AV*)POPPTR(ss,ix);
10087 TOPPTR(nss,ix) = av_dup_inc(av, param);
10089 case SAVEt_HELEM: /* hash element */
10090 sv = (SV*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10092 sv = (SV*)POPPTR(ss,ix);
10093 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10094 hv = (HV*)POPPTR(ss,ix);
10095 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10098 ptr = POPPTR(ss,ix);
10099 TOPPTR(nss,ix) = ptr;
10103 TOPINT(nss,ix) = i;
10105 case SAVEt_COMPPAD:
10106 av = (AV*)POPPTR(ss,ix);
10107 TOPPTR(nss,ix) = av_dup(av, param);
10110 longval = (long)POPLONG(ss,ix);
10111 TOPLONG(nss,ix) = longval;
10112 ptr = POPPTR(ss,ix);
10113 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10114 sv = (SV*)POPPTR(ss,ix);
10115 TOPPTR(nss,ix) = sv_dup(sv, param);
10118 ptr = POPPTR(ss,ix);
10119 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10120 longval = (long)POPBOOL(ss,ix);
10121 TOPBOOL(nss,ix) = (bool)longval;
10123 case SAVEt_SET_SVFLAGS:
10125 TOPINT(nss,ix) = i;
10127 TOPINT(nss,ix) = i;
10128 sv = (SV*)POPPTR(ss,ix);
10129 TOPPTR(nss,ix) = sv_dup(sv, param);
10132 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10140 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10141 * flag to the result. This is done for each stash before cloning starts,
10142 * so we know which stashes want their objects cloned */
10145 do_mark_cloneable_stash(pTHX_ SV *sv)
10147 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10149 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10150 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10151 if (cloner && GvCV(cloner)) {
10158 XPUSHs(sv_2mortal(newSVhek(hvname)));
10160 call_sv((SV*)GvCV(cloner), G_SCALAR);
10167 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10175 =for apidoc perl_clone
10177 Create and return a new interpreter by cloning the current one.
10179 perl_clone takes these flags as parameters:
10181 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10182 without it we only clone the data and zero the stacks,
10183 with it we copy the stacks and the new perl interpreter is
10184 ready to run at the exact same point as the previous one.
10185 The pseudo-fork code uses COPY_STACKS while the
10186 threads->new doesn't.
10188 CLONEf_KEEP_PTR_TABLE
10189 perl_clone keeps a ptr_table with the pointer of the old
10190 variable as a key and the new variable as a value,
10191 this allows it to check if something has been cloned and not
10192 clone it again but rather just use the value and increase the
10193 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10194 the ptr_table using the function
10195 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10196 reason to keep it around is if you want to dup some of your own
10197 variable who are outside the graph perl scans, example of this
10198 code is in threads.xs create
10201 This is a win32 thing, it is ignored on unix, it tells perls
10202 win32host code (which is c++) to clone itself, this is needed on
10203 win32 if you want to run two threads at the same time,
10204 if you just want to do some stuff in a separate perl interpreter
10205 and then throw it away and return to the original one,
10206 you don't need to do anything.
10211 /* XXX the above needs expanding by someone who actually understands it ! */
10212 EXTERN_C PerlInterpreter *
10213 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10216 perl_clone(PerlInterpreter *proto_perl, UV flags)
10219 #ifdef PERL_IMPLICIT_SYS
10221 /* perlhost.h so we need to call into it
10222 to clone the host, CPerlHost should have a c interface, sky */
10224 if (flags & CLONEf_CLONE_HOST) {
10225 return perl_clone_host(proto_perl,flags);
10227 return perl_clone_using(proto_perl, flags,
10229 proto_perl->IMemShared,
10230 proto_perl->IMemParse,
10232 proto_perl->IStdIO,
10236 proto_perl->IProc);
10240 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10241 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10242 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10243 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10244 struct IPerlDir* ipD, struct IPerlSock* ipS,
10245 struct IPerlProc* ipP)
10247 /* XXX many of the string copies here can be optimized if they're
10248 * constants; they need to be allocated as common memory and just
10249 * their pointers copied. */
10252 CLONE_PARAMS clone_params;
10253 CLONE_PARAMS* param = &clone_params;
10255 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10256 /* for each stash, determine whether its objects should be cloned */
10257 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10258 PERL_SET_THX(my_perl);
10261 Poison(my_perl, 1, PerlInterpreter);
10263 PL_curcop = (COP *)Nullop;
10267 PL_savestack_ix = 0;
10268 PL_savestack_max = -1;
10269 PL_sig_pending = 0;
10270 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10271 # else /* !DEBUGGING */
10272 Zero(my_perl, 1, PerlInterpreter);
10273 # endif /* DEBUGGING */
10275 /* host pointers */
10277 PL_MemShared = ipMS;
10278 PL_MemParse = ipMP;
10285 #else /* !PERL_IMPLICIT_SYS */
10287 CLONE_PARAMS clone_params;
10288 CLONE_PARAMS* param = &clone_params;
10289 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10290 /* for each stash, determine whether its objects should be cloned */
10291 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10292 PERL_SET_THX(my_perl);
10295 Poison(my_perl, 1, PerlInterpreter);
10297 PL_curcop = (COP *)Nullop;
10301 PL_savestack_ix = 0;
10302 PL_savestack_max = -1;
10303 PL_sig_pending = 0;
10304 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10305 # else /* !DEBUGGING */
10306 Zero(my_perl, 1, PerlInterpreter);
10307 # endif /* DEBUGGING */
10308 #endif /* PERL_IMPLICIT_SYS */
10309 param->flags = flags;
10310 param->proto_perl = proto_perl;
10312 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10313 Zero(&PL_body_roots, 1, PL_body_roots);
10315 PL_nice_chunk = NULL;
10316 PL_nice_chunk_size = 0;
10318 PL_sv_objcount = 0;
10319 PL_sv_root = Nullsv;
10320 PL_sv_arenaroot = Nullsv;
10322 PL_debug = proto_perl->Idebug;
10324 PL_hash_seed = proto_perl->Ihash_seed;
10325 PL_rehash_seed = proto_perl->Irehash_seed;
10327 #ifdef USE_REENTRANT_API
10328 /* XXX: things like -Dm will segfault here in perlio, but doing
10329 * PERL_SET_CONTEXT(proto_perl);
10330 * breaks too many other things
10332 Perl_reentrant_init(aTHX);
10335 /* create SV map for pointer relocation */
10336 PL_ptr_table = ptr_table_new();
10338 /* initialize these special pointers as early as possible */
10339 SvANY(&PL_sv_undef) = NULL;
10340 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10341 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10342 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10344 SvANY(&PL_sv_no) = new_XPVNV();
10345 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10346 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10347 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10348 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10349 SvCUR_set(&PL_sv_no, 0);
10350 SvLEN_set(&PL_sv_no, 1);
10351 SvIV_set(&PL_sv_no, 0);
10352 SvNV_set(&PL_sv_no, 0);
10353 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10355 SvANY(&PL_sv_yes) = new_XPVNV();
10356 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10357 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10358 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10359 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10360 SvCUR_set(&PL_sv_yes, 1);
10361 SvLEN_set(&PL_sv_yes, 2);
10362 SvIV_set(&PL_sv_yes, 1);
10363 SvNV_set(&PL_sv_yes, 1);
10364 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10366 /* create (a non-shared!) shared string table */
10367 PL_strtab = newHV();
10368 HvSHAREKEYS_off(PL_strtab);
10369 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10370 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10372 PL_compiling = proto_perl->Icompiling;
10374 /* These two PVs will be free'd special way so must set them same way op.c does */
10375 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10376 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10378 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10379 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10381 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10382 if (!specialWARN(PL_compiling.cop_warnings))
10383 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10384 if (!specialCopIO(PL_compiling.cop_io))
10385 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10386 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10388 /* pseudo environmental stuff */
10389 PL_origargc = proto_perl->Iorigargc;
10390 PL_origargv = proto_perl->Iorigargv;
10392 param->stashes = newAV(); /* Setup array of objects to call clone on */
10394 /* Set tainting stuff before PerlIO_debug can possibly get called */
10395 PL_tainting = proto_perl->Itainting;
10396 PL_taint_warn = proto_perl->Itaint_warn;
10398 #ifdef PERLIO_LAYERS
10399 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10400 PerlIO_clone(aTHX_ proto_perl, param);
10403 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10404 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10405 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10406 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10407 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10408 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10411 PL_minus_c = proto_perl->Iminus_c;
10412 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10413 PL_localpatches = proto_perl->Ilocalpatches;
10414 PL_splitstr = proto_perl->Isplitstr;
10415 PL_preprocess = proto_perl->Ipreprocess;
10416 PL_minus_n = proto_perl->Iminus_n;
10417 PL_minus_p = proto_perl->Iminus_p;
10418 PL_minus_l = proto_perl->Iminus_l;
10419 PL_minus_a = proto_perl->Iminus_a;
10420 PL_minus_E = proto_perl->Iminus_E;
10421 PL_minus_F = proto_perl->Iminus_F;
10422 PL_doswitches = proto_perl->Idoswitches;
10423 PL_dowarn = proto_perl->Idowarn;
10424 PL_doextract = proto_perl->Idoextract;
10425 PL_sawampersand = proto_perl->Isawampersand;
10426 PL_unsafe = proto_perl->Iunsafe;
10427 PL_inplace = SAVEPV(proto_perl->Iinplace);
10428 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10429 PL_perldb = proto_perl->Iperldb;
10430 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10431 PL_exit_flags = proto_perl->Iexit_flags;
10433 /* magical thingies */
10434 /* XXX time(&PL_basetime) when asked for? */
10435 PL_basetime = proto_perl->Ibasetime;
10436 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10438 PL_maxsysfd = proto_perl->Imaxsysfd;
10439 PL_multiline = proto_perl->Imultiline;
10440 PL_statusvalue = proto_perl->Istatusvalue;
10442 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10444 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10446 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10448 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10449 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10450 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10452 /* Clone the regex array */
10453 PL_regex_padav = newAV();
10455 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10456 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10458 av_push(PL_regex_padav,
10459 sv_dup_inc(regexen[0],param));
10460 for(i = 1; i <= len; i++) {
10461 const SV * const regex = regexen[i];
10464 ? sv_dup_inc(regex, param)
10466 newSViv(PTR2IV(re_dup(
10467 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10469 av_push(PL_regex_padav, sv);
10472 PL_regex_pad = AvARRAY(PL_regex_padav);
10474 /* shortcuts to various I/O objects */
10475 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10476 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10477 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10478 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10479 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10480 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10482 /* shortcuts to regexp stuff */
10483 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10485 /* shortcuts to misc objects */
10486 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10488 /* shortcuts to debugging objects */
10489 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10490 PL_DBline = gv_dup(proto_perl->IDBline, param);
10491 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10492 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10493 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10494 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10495 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10496 PL_lineary = av_dup(proto_perl->Ilineary, param);
10497 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10499 /* symbol tables */
10500 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10501 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10502 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10503 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10504 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10506 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10507 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10508 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10509 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10510 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10511 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10513 PL_sub_generation = proto_perl->Isub_generation;
10515 /* funky return mechanisms */
10516 PL_forkprocess = proto_perl->Iforkprocess;
10518 /* subprocess state */
10519 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10521 /* internal state */
10522 PL_maxo = proto_perl->Imaxo;
10523 if (proto_perl->Iop_mask)
10524 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10526 PL_op_mask = Nullch;
10527 /* PL_asserting = proto_perl->Iasserting; */
10529 /* current interpreter roots */
10530 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10531 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10532 PL_main_start = proto_perl->Imain_start;
10533 PL_eval_root = proto_perl->Ieval_root;
10534 PL_eval_start = proto_perl->Ieval_start;
10536 /* runtime control stuff */
10537 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10538 PL_copline = proto_perl->Icopline;
10540 PL_filemode = proto_perl->Ifilemode;
10541 PL_lastfd = proto_perl->Ilastfd;
10542 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10545 PL_gensym = proto_perl->Igensym;
10546 PL_preambled = proto_perl->Ipreambled;
10547 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10548 PL_laststatval = proto_perl->Ilaststatval;
10549 PL_laststype = proto_perl->Ilaststype;
10550 PL_mess_sv = Nullsv;
10552 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10554 /* interpreter atexit processing */
10555 PL_exitlistlen = proto_perl->Iexitlistlen;
10556 if (PL_exitlistlen) {
10557 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10558 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10561 PL_exitlist = (PerlExitListEntry*)NULL;
10563 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10564 if (PL_my_cxt_size) {
10565 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10566 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10569 PL_my_cxt_list = (void**)NULL;
10570 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10571 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10572 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10574 PL_profiledata = NULL;
10575 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10576 /* PL_rsfp_filters entries have fake IoDIRP() */
10577 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10579 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10581 PAD_CLONE_VARS(proto_perl, param);
10583 #ifdef HAVE_INTERP_INTERN
10584 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10587 /* more statics moved here */
10588 PL_generation = proto_perl->Igeneration;
10589 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10591 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10592 PL_in_clean_all = proto_perl->Iin_clean_all;
10594 PL_uid = proto_perl->Iuid;
10595 PL_euid = proto_perl->Ieuid;
10596 PL_gid = proto_perl->Igid;
10597 PL_egid = proto_perl->Iegid;
10598 PL_nomemok = proto_perl->Inomemok;
10599 PL_an = proto_perl->Ian;
10600 PL_evalseq = proto_perl->Ievalseq;
10601 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10602 PL_origalen = proto_perl->Iorigalen;
10603 #ifdef PERL_USES_PL_PIDSTATUS
10604 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10606 PL_osname = SAVEPV(proto_perl->Iosname);
10607 PL_sighandlerp = proto_perl->Isighandlerp;
10609 PL_runops = proto_perl->Irunops;
10611 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10614 PL_cshlen = proto_perl->Icshlen;
10615 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10618 PL_lex_state = proto_perl->Ilex_state;
10619 PL_lex_defer = proto_perl->Ilex_defer;
10620 PL_lex_expect = proto_perl->Ilex_expect;
10621 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10622 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10623 PL_lex_starts = proto_perl->Ilex_starts;
10624 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10625 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10626 PL_lex_op = proto_perl->Ilex_op;
10627 PL_lex_inpat = proto_perl->Ilex_inpat;
10628 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10629 PL_lex_brackets = proto_perl->Ilex_brackets;
10630 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10631 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10632 PL_lex_casemods = proto_perl->Ilex_casemods;
10633 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10634 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10636 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10637 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10638 PL_nexttoke = proto_perl->Inexttoke;
10640 /* XXX This is probably masking the deeper issue of why
10641 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10642 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10643 * (A little debugging with a watchpoint on it may help.)
10645 if (SvANY(proto_perl->Ilinestr)) {
10646 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10647 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10648 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10649 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10650 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10651 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10652 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10653 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10654 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10657 PL_linestr = newSV(79);
10658 sv_upgrade(PL_linestr,SVt_PVIV);
10659 sv_setpvn(PL_linestr,"",0);
10660 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10662 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10663 PL_pending_ident = proto_perl->Ipending_ident;
10664 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10666 PL_expect = proto_perl->Iexpect;
10668 PL_multi_start = proto_perl->Imulti_start;
10669 PL_multi_end = proto_perl->Imulti_end;
10670 PL_multi_open = proto_perl->Imulti_open;
10671 PL_multi_close = proto_perl->Imulti_close;
10673 PL_error_count = proto_perl->Ierror_count;
10674 PL_subline = proto_perl->Isubline;
10675 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10677 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10678 if (SvANY(proto_perl->Ilinestr)) {
10679 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10680 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10681 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10682 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10683 PL_last_lop_op = proto_perl->Ilast_lop_op;
10686 PL_last_uni = SvPVX(PL_linestr);
10687 PL_last_lop = SvPVX(PL_linestr);
10688 PL_last_lop_op = 0;
10690 PL_in_my = proto_perl->Iin_my;
10691 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10693 PL_cryptseen = proto_perl->Icryptseen;
10696 PL_hints = proto_perl->Ihints;
10698 PL_amagic_generation = proto_perl->Iamagic_generation;
10700 #ifdef USE_LOCALE_COLLATE
10701 PL_collation_ix = proto_perl->Icollation_ix;
10702 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10703 PL_collation_standard = proto_perl->Icollation_standard;
10704 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10705 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10706 #endif /* USE_LOCALE_COLLATE */
10708 #ifdef USE_LOCALE_NUMERIC
10709 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10710 PL_numeric_standard = proto_perl->Inumeric_standard;
10711 PL_numeric_local = proto_perl->Inumeric_local;
10712 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10713 #endif /* !USE_LOCALE_NUMERIC */
10715 /* utf8 character classes */
10716 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10717 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10718 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10719 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10720 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10721 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10722 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10723 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10724 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10725 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10726 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10727 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10728 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10729 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10730 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10731 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10732 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10733 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10734 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10735 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10737 /* Did the locale setup indicate UTF-8? */
10738 PL_utf8locale = proto_perl->Iutf8locale;
10739 /* Unicode features (see perlrun/-C) */
10740 PL_unicode = proto_perl->Iunicode;
10742 /* Pre-5.8 signals control */
10743 PL_signals = proto_perl->Isignals;
10745 /* times() ticks per second */
10746 PL_clocktick = proto_perl->Iclocktick;
10748 /* Recursion stopper for PerlIO_find_layer */
10749 PL_in_load_module = proto_perl->Iin_load_module;
10751 /* sort() routine */
10752 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10754 /* Not really needed/useful since the reenrant_retint is "volatile",
10755 * but do it for consistency's sake. */
10756 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10758 /* Hooks to shared SVs and locks. */
10759 PL_sharehook = proto_perl->Isharehook;
10760 PL_lockhook = proto_perl->Ilockhook;
10761 PL_unlockhook = proto_perl->Iunlockhook;
10762 PL_threadhook = proto_perl->Ithreadhook;
10764 PL_runops_std = proto_perl->Irunops_std;
10765 PL_runops_dbg = proto_perl->Irunops_dbg;
10767 #ifdef THREADS_HAVE_PIDS
10768 PL_ppid = proto_perl->Ippid;
10772 PL_last_swash_hv = NULL; /* reinits on demand */
10773 PL_last_swash_klen = 0;
10774 PL_last_swash_key[0]= '\0';
10775 PL_last_swash_tmps = (U8*)NULL;
10776 PL_last_swash_slen = 0;
10778 PL_glob_index = proto_perl->Iglob_index;
10779 PL_srand_called = proto_perl->Isrand_called;
10780 PL_uudmap['M'] = 0; /* reinits on demand */
10781 PL_bitcount = Nullch; /* reinits on demand */
10783 if (proto_perl->Ipsig_pend) {
10784 Newxz(PL_psig_pend, SIG_SIZE, int);
10787 PL_psig_pend = (int*)NULL;
10790 if (proto_perl->Ipsig_ptr) {
10791 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10792 Newxz(PL_psig_name, SIG_SIZE, SV*);
10793 for (i = 1; i < SIG_SIZE; i++) {
10794 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10795 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10799 PL_psig_ptr = (SV**)NULL;
10800 PL_psig_name = (SV**)NULL;
10803 /* thrdvar.h stuff */
10805 if (flags & CLONEf_COPY_STACKS) {
10806 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10807 PL_tmps_ix = proto_perl->Ttmps_ix;
10808 PL_tmps_max = proto_perl->Ttmps_max;
10809 PL_tmps_floor = proto_perl->Ttmps_floor;
10810 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10812 while (i <= PL_tmps_ix) {
10813 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10817 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10818 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10819 Newxz(PL_markstack, i, I32);
10820 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10821 - proto_perl->Tmarkstack);
10822 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10823 - proto_perl->Tmarkstack);
10824 Copy(proto_perl->Tmarkstack, PL_markstack,
10825 PL_markstack_ptr - PL_markstack + 1, I32);
10827 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10828 * NOTE: unlike the others! */
10829 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10830 PL_scopestack_max = proto_perl->Tscopestack_max;
10831 Newxz(PL_scopestack, PL_scopestack_max, I32);
10832 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10834 /* NOTE: si_dup() looks at PL_markstack */
10835 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10837 /* PL_curstack = PL_curstackinfo->si_stack; */
10838 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10839 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10841 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10842 PL_stack_base = AvARRAY(PL_curstack);
10843 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10844 - proto_perl->Tstack_base);
10845 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10847 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10848 * NOTE: unlike the others! */
10849 PL_savestack_ix = proto_perl->Tsavestack_ix;
10850 PL_savestack_max = proto_perl->Tsavestack_max;
10851 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10852 PL_savestack = ss_dup(proto_perl, param);
10856 ENTER; /* perl_destruct() wants to LEAVE; */
10858 /* although we're not duplicating the tmps stack, we should still
10859 * add entries for any SVs on the tmps stack that got cloned by a
10860 * non-refcount means (eg a temp in @_); otherwise they will be
10863 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10864 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10865 proto_perl->Ttmps_stack[i]);
10866 if (nsv && !SvREFCNT(nsv)) {
10868 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10873 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10874 PL_top_env = &PL_start_env;
10876 PL_op = proto_perl->Top;
10879 PL_Xpv = (XPV*)NULL;
10880 PL_na = proto_perl->Tna;
10882 PL_statbuf = proto_perl->Tstatbuf;
10883 PL_statcache = proto_perl->Tstatcache;
10884 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10885 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10887 PL_timesbuf = proto_perl->Ttimesbuf;
10890 PL_tainted = proto_perl->Ttainted;
10891 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10892 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10893 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10894 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10895 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10896 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10897 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10898 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10899 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10901 PL_restartop = proto_perl->Trestartop;
10902 PL_in_eval = proto_perl->Tin_eval;
10903 PL_delaymagic = proto_perl->Tdelaymagic;
10904 PL_dirty = proto_perl->Tdirty;
10905 PL_localizing = proto_perl->Tlocalizing;
10907 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10908 PL_hv_fetch_ent_mh = Nullhe;
10909 PL_modcount = proto_perl->Tmodcount;
10910 PL_lastgotoprobe = Nullop;
10911 PL_dumpindent = proto_perl->Tdumpindent;
10913 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10914 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10915 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10916 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10917 PL_efloatbuf = Nullch; /* reinits on demand */
10918 PL_efloatsize = 0; /* reinits on demand */
10922 PL_screamfirst = NULL;
10923 PL_screamnext = NULL;
10924 PL_maxscream = -1; /* reinits on demand */
10925 PL_lastscream = Nullsv;
10927 PL_watchaddr = NULL;
10928 PL_watchok = Nullch;
10930 PL_regdummy = proto_perl->Tregdummy;
10931 PL_regprecomp = Nullch;
10934 PL_colorset = 0; /* reinits PL_colors[] */
10935 /*PL_colors[6] = {0,0,0,0,0,0};*/
10936 PL_reginput = Nullch;
10937 PL_regbol = Nullch;
10938 PL_regeol = Nullch;
10939 PL_regstartp = (I32*)NULL;
10940 PL_regendp = (I32*)NULL;
10941 PL_reglastparen = (U32*)NULL;
10942 PL_reglastcloseparen = (U32*)NULL;
10943 PL_regtill = Nullch;
10944 PL_reg_start_tmp = (char**)NULL;
10945 PL_reg_start_tmpl = 0;
10946 PL_regdata = (struct reg_data*)NULL;
10949 PL_reg_eval_set = 0;
10951 PL_regprogram = (regnode*)NULL;
10953 PL_regcc = (CURCUR*)NULL;
10954 PL_reg_call_cc = (struct re_cc_state*)NULL;
10955 PL_reg_re = (regexp*)NULL;
10956 PL_reg_ganch = Nullch;
10957 PL_reg_sv = Nullsv;
10958 PL_reg_match_utf8 = FALSE;
10959 PL_reg_magic = (MAGIC*)NULL;
10961 PL_reg_oldcurpm = (PMOP*)NULL;
10962 PL_reg_curpm = (PMOP*)NULL;
10963 PL_reg_oldsaved = Nullch;
10964 PL_reg_oldsavedlen = 0;
10965 #ifdef PERL_OLD_COPY_ON_WRITE
10968 PL_reg_maxiter = 0;
10969 PL_reg_leftiter = 0;
10970 PL_reg_poscache = Nullch;
10971 PL_reg_poscache_size= 0;
10973 /* RE engine - function pointers */
10974 PL_regcompp = proto_perl->Tregcompp;
10975 PL_regexecp = proto_perl->Tregexecp;
10976 PL_regint_start = proto_perl->Tregint_start;
10977 PL_regint_string = proto_perl->Tregint_string;
10978 PL_regfree = proto_perl->Tregfree;
10980 PL_reginterp_cnt = 0;
10981 PL_reg_starttry = 0;
10983 /* Pluggable optimizer */
10984 PL_peepp = proto_perl->Tpeepp;
10986 PL_stashcache = newHV();
10988 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10989 ptr_table_free(PL_ptr_table);
10990 PL_ptr_table = NULL;
10993 /* Call the ->CLONE method, if it exists, for each of the stashes
10994 identified by sv_dup() above.
10996 while(av_len(param->stashes) != -1) {
10997 HV* const stash = (HV*) av_shift(param->stashes);
10998 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10999 if (cloner && GvCV(cloner)) {
11004 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11006 call_sv((SV*)GvCV(cloner), G_DISCARD);
11012 SvREFCNT_dec(param->stashes);
11014 /* orphaned? eg threads->new inside BEGIN or use */
11015 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11016 (void)SvREFCNT_inc(PL_compcv);
11017 SAVEFREESV(PL_compcv);
11023 #endif /* USE_ITHREADS */
11026 =head1 Unicode Support
11028 =for apidoc sv_recode_to_utf8
11030 The encoding is assumed to be an Encode object, on entry the PV
11031 of the sv is assumed to be octets in that encoding, and the sv
11032 will be converted into Unicode (and UTF-8).
11034 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11035 is not a reference, nothing is done to the sv. If the encoding is not
11036 an C<Encode::XS> Encoding object, bad things will happen.
11037 (See F<lib/encoding.pm> and L<Encode>).
11039 The PV of the sv is returned.
11044 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11047 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11061 Passing sv_yes is wrong - it needs to be or'ed set of constants
11062 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11063 remove converted chars from source.
11065 Both will default the value - let them.
11067 XPUSHs(&PL_sv_yes);
11070 call_method("decode", G_SCALAR);
11074 s = SvPV_const(uni, len);
11075 if (s != SvPVX_const(sv)) {
11076 SvGROW(sv, len + 1);
11077 Move(s, SvPVX(sv), len + 1, char);
11078 SvCUR_set(sv, len);
11085 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11089 =for apidoc sv_cat_decode
11091 The encoding is assumed to be an Encode object, the PV of the ssv is
11092 assumed to be octets in that encoding and decoding the input starts
11093 from the position which (PV + *offset) pointed to. The dsv will be
11094 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11095 when the string tstr appears in decoding output or the input ends on
11096 the PV of the ssv. The value which the offset points will be modified
11097 to the last input position on the ssv.
11099 Returns TRUE if the terminator was found, else returns FALSE.
11104 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11105 SV *ssv, int *offset, char *tstr, int tlen)
11109 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11120 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11121 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11123 call_method("cat_decode", G_SCALAR);
11125 ret = SvTRUE(TOPs);
11126 *offset = SvIV(offsv);
11132 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11137 /* ---------------------------------------------------------------------
11139 * support functions for report_uninit()
11142 /* the maxiumum size of array or hash where we will scan looking
11143 * for the undefined element that triggered the warning */
11145 #define FUV_MAX_SEARCH_SIZE 1000
11147 /* Look for an entry in the hash whose value has the same SV as val;
11148 * If so, return a mortal copy of the key. */
11151 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11154 register HE **array;
11157 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11158 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11161 array = HvARRAY(hv);
11163 for (i=HvMAX(hv); i>0; i--) {
11164 register HE *entry;
11165 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11166 if (HeVAL(entry) != val)
11168 if ( HeVAL(entry) == &PL_sv_undef ||
11169 HeVAL(entry) == &PL_sv_placeholder)
11173 if (HeKLEN(entry) == HEf_SVKEY)
11174 return sv_mortalcopy(HeKEY_sv(entry));
11175 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11181 /* Look for an entry in the array whose value has the same SV as val;
11182 * If so, return the index, otherwise return -1. */
11185 S_find_array_subscript(pTHX_ AV *av, SV* val)
11190 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11191 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11195 for (i=AvFILLp(av); i>=0; i--) {
11196 if (svp[i] == val && svp[i] != &PL_sv_undef)
11202 /* S_varname(): return the name of a variable, optionally with a subscript.
11203 * If gv is non-zero, use the name of that global, along with gvtype (one
11204 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11205 * targ. Depending on the value of the subscript_type flag, return:
11208 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11209 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11210 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11211 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11214 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11215 SV* keyname, I32 aindex, int subscript_type)
11218 SV * const name = sv_newmortal();
11221 buffer[0] = gvtype;
11224 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11226 gv_fullname4(name, gv, buffer, 0);
11228 if ((unsigned int)SvPVX(name)[1] <= 26) {
11230 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11232 /* Swap the 1 unprintable control character for the 2 byte pretty
11233 version - ie substr($name, 1, 1) = $buffer; */
11234 sv_insert(name, 1, 1, buffer, 2);
11239 CV * const cv = find_runcv(&unused);
11243 if (!cv || !CvPADLIST(cv))
11245 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11246 sv = *av_fetch(av, targ, FALSE);
11247 /* SvLEN in a pad name is not to be trusted */
11248 sv_setpv(name, SvPV_nolen_const(sv));
11251 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11252 SV * const sv = newSV(0);
11253 *SvPVX(name) = '$';
11254 Perl_sv_catpvf(aTHX_ name, "{%s}",
11255 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11258 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11259 *SvPVX(name) = '$';
11260 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11262 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11263 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11270 =for apidoc find_uninit_var
11272 Find the name of the undefined variable (if any) that caused the operator o
11273 to issue a "Use of uninitialized value" warning.
11274 If match is true, only return a name if it's value matches uninit_sv.
11275 So roughly speaking, if a unary operator (such as OP_COS) generates a
11276 warning, then following the direct child of the op may yield an
11277 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11278 other hand, with OP_ADD there are two branches to follow, so we only print
11279 the variable name if we get an exact match.
11281 The name is returned as a mortal SV.
11283 Assumes that PL_op is the op that originally triggered the error, and that
11284 PL_comppad/PL_curpad points to the currently executing pad.
11290 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11298 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11299 uninit_sv == &PL_sv_placeholder)))
11302 switch (obase->op_type) {
11309 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11310 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11312 SV *keysv = Nullsv;
11313 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11315 if (pad) { /* @lex, %lex */
11316 sv = PAD_SVl(obase->op_targ);
11320 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11321 /* @global, %global */
11322 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11325 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11327 else /* @{expr}, %{expr} */
11328 return find_uninit_var(cUNOPx(obase)->op_first,
11332 /* attempt to find a match within the aggregate */
11334 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11336 subscript_type = FUV_SUBSCRIPT_HASH;
11339 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11341 subscript_type = FUV_SUBSCRIPT_ARRAY;
11344 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11347 return varname(gv, hash ? '%' : '@', obase->op_targ,
11348 keysv, index, subscript_type);
11352 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11354 return varname(Nullgv, '$', obase->op_targ,
11355 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11358 gv = cGVOPx_gv(obase);
11359 if (!gv || (match && GvSV(gv) != uninit_sv))
11361 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11364 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11367 av = (AV*)PAD_SV(obase->op_targ);
11368 if (!av || SvRMAGICAL(av))
11370 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11371 if (!svp || *svp != uninit_sv)
11374 return varname(Nullgv, '$', obase->op_targ,
11375 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11378 gv = cGVOPx_gv(obase);
11384 if (!av || SvRMAGICAL(av))
11386 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11387 if (!svp || *svp != uninit_sv)
11390 return varname(gv, '$', 0,
11391 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11396 o = cUNOPx(obase)->op_first;
11397 if (!o || o->op_type != OP_NULL ||
11398 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11400 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11404 if (PL_op == obase)
11405 /* $a[uninit_expr] or $h{uninit_expr} */
11406 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11409 o = cBINOPx(obase)->op_first;
11410 kid = cBINOPx(obase)->op_last;
11412 /* get the av or hv, and optionally the gv */
11414 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11415 sv = PAD_SV(o->op_targ);
11417 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11418 && cUNOPo->op_first->op_type == OP_GV)
11420 gv = cGVOPx_gv(cUNOPo->op_first);
11423 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11428 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11429 /* index is constant */
11433 if (obase->op_type == OP_HELEM) {
11434 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11435 if (!he || HeVAL(he) != uninit_sv)
11439 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11440 if (!svp || *svp != uninit_sv)
11444 if (obase->op_type == OP_HELEM)
11445 return varname(gv, '%', o->op_targ,
11446 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11448 return varname(gv, '@', o->op_targ, Nullsv,
11449 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11452 /* index is an expression;
11453 * attempt to find a match within the aggregate */
11454 if (obase->op_type == OP_HELEM) {
11455 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11457 return varname(gv, '%', o->op_targ,
11458 keysv, 0, FUV_SUBSCRIPT_HASH);
11461 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11463 return varname(gv, '@', o->op_targ,
11464 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11469 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11471 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11477 /* only examine RHS */
11478 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11481 o = cUNOPx(obase)->op_first;
11482 if (o->op_type == OP_PUSHMARK)
11485 if (!o->op_sibling) {
11486 /* one-arg version of open is highly magical */
11488 if (o->op_type == OP_GV) { /* open FOO; */
11490 if (match && GvSV(gv) != uninit_sv)
11492 return varname(gv, '$', 0,
11493 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11495 /* other possibilities not handled are:
11496 * open $x; or open my $x; should return '${*$x}'
11497 * open expr; should return '$'.expr ideally
11503 /* ops where $_ may be an implicit arg */
11507 if ( !(obase->op_flags & OPf_STACKED)) {
11508 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11509 ? PAD_SVl(obase->op_targ)
11512 sv = sv_newmortal();
11513 sv_setpvn(sv, "$_", 2);
11521 /* skip filehandle as it can't produce 'undef' warning */
11522 o = cUNOPx(obase)->op_first;
11523 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11524 o = o->op_sibling->op_sibling;
11531 match = 1; /* XS or custom code could trigger random warnings */
11536 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11537 return sv_2mortal(newSVpvs("${$/}"));
11542 if (!(obase->op_flags & OPf_KIDS))
11544 o = cUNOPx(obase)->op_first;
11550 /* if all except one arg are constant, or have no side-effects,
11551 * or are optimized away, then it's unambiguous */
11553 for (kid=o; kid; kid = kid->op_sibling) {
11555 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11556 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11557 || (kid->op_type == OP_PUSHMARK)
11561 if (o2) { /* more than one found */
11568 return find_uninit_var(o2, uninit_sv, match);
11570 /* scan all args */
11572 sv = find_uninit_var(o, uninit_sv, 1);
11584 =for apidoc report_uninit
11586 Print appropriate "Use of uninitialized variable" warning
11592 Perl_report_uninit(pTHX_ SV* uninit_sv)
11596 SV* varname = Nullsv;
11598 varname = find_uninit_var(PL_op, uninit_sv,0);
11600 sv_insert(varname, 0, 0, " ", 1);
11602 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11603 varname ? SvPV_nolen_const(varname) : "",
11604 " in ", OP_DESC(PL_op));
11607 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11613 * c-indentation-style: bsd
11614 * c-basic-offset: 4
11615 * indent-tabs-mode: t
11618 * ex: set ts=8 sts=4 sw=4 noet: