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 /* SvTAINTED can only be true if the SV has taint magic, which in
3150 turn means that the SV type is PVMG (or greater). This is the
3151 case statement for SVt_IV, so this cannot be true (whatever gcov
3153 assert(!SvTAINTED(sstr));
3163 sv_upgrade(dstr, SVt_NV);
3168 sv_upgrade(dstr, SVt_PVNV);
3171 SvNV_set(dstr, SvNVX(sstr));
3172 (void)SvNOK_only(dstr);
3173 /* SvTAINTED can only be true if the SV has taint magic, which in
3174 turn means that the SV type is PVMG (or greater). This is the
3175 case statement for SVt_NV, so this cannot be true (whatever gcov
3177 assert(!SvTAINTED(sstr));
3184 sv_upgrade(dstr, SVt_RV);
3185 else if (dtype == SVt_PVGV &&
3186 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3189 if (GvIMPORTED(dstr) != GVf_IMPORTED
3190 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3192 GvIMPORTED_on(dstr);
3197 S_glob_assign(aTHX_ dstr, sstr, dtype);
3202 #ifdef PERL_OLD_COPY_ON_WRITE
3203 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3204 if (dtype < SVt_PVIV)
3205 sv_upgrade(dstr, SVt_PVIV);
3212 sv_upgrade(dstr, SVt_PV);
3215 if (dtype < SVt_PVIV)
3216 sv_upgrade(dstr, SVt_PVIV);
3219 if (dtype < SVt_PVNV)
3220 sv_upgrade(dstr, SVt_PVNV);
3227 const char * const type = sv_reftype(sstr,0);
3229 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3231 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3236 if (dtype <= SVt_PVGV) {
3237 S_glob_assign(aTHX_ dstr, sstr, dtype);
3243 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3245 if ((int)SvTYPE(sstr) != stype) {
3246 stype = SvTYPE(sstr);
3247 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3248 S_glob_assign(aTHX_ dstr, sstr, dtype);
3253 if (stype == SVt_PVLV)
3254 SvUPGRADE(dstr, SVt_PVNV);
3256 SvUPGRADE(dstr, (U32)stype);
3259 sflags = SvFLAGS(sstr);
3261 if (sflags & SVf_ROK) {
3262 if (dtype >= SVt_PV) {
3263 if (dtype == SVt_PVGV) {
3264 S_pvgv_assign(aTHX_ dstr, sstr);
3267 if (SvPVX_const(dstr)) {
3273 (void)SvOK_off(dstr);
3274 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3275 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_ROK
3277 if (sflags & SVp_NOK) {
3278 SvNV_set(dstr, SvNVX(sstr));
3280 if (sflags & SVp_IOK) {
3281 /* Must do this otherwise some other overloaded use of 0x80000000
3282 gets confused. Probably 0x80000000 */
3283 if (sflags & SVf_IVisUV)
3285 SvIV_set(dstr, SvIVX(sstr));
3288 else if (sflags & SVp_POK) {
3292 * Check to see if we can just swipe the string. If so, it's a
3293 * possible small lose on short strings, but a big win on long ones.
3294 * It might even be a win on short strings if SvPVX_const(dstr)
3295 * has to be allocated and SvPVX_const(sstr) has to be freed.
3298 /* Whichever path we take through the next code, we want this true,
3299 and doing it now facilitates the COW check. */
3300 (void)SvPOK_only(dstr);
3303 /* We're not already COW */
3304 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3305 #ifndef PERL_OLD_COPY_ON_WRITE
3306 /* or we are, but dstr isn't a suitable target. */
3307 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3312 (sflags & SVs_TEMP) && /* slated for free anyway? */
3313 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3314 (!(flags & SV_NOSTEAL)) &&
3315 /* and we're allowed to steal temps */
3316 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3317 SvLEN(sstr) && /* and really is a string */
3318 /* and won't be needed again, potentially */
3319 !(PL_op && PL_op->op_type == OP_AASSIGN))
3320 #ifdef PERL_OLD_COPY_ON_WRITE
3321 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3322 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3323 && SvTYPE(sstr) >= SVt_PVIV)
3326 /* Failed the swipe test, and it's not a shared hash key either.
3327 Have to copy the string. */
3328 STRLEN len = SvCUR(sstr);
3329 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3330 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3331 SvCUR_set(dstr, len);
3332 *SvEND(dstr) = '\0';
3334 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3336 /* Either it's a shared hash key, or it's suitable for
3337 copy-on-write or we can swipe the string. */
3339 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3343 #ifdef PERL_OLD_COPY_ON_WRITE
3345 /* I believe I should acquire a global SV mutex if
3346 it's a COW sv (not a shared hash key) to stop
3347 it going un copy-on-write.
3348 If the source SV has gone un copy on write between up there
3349 and down here, then (assert() that) it is of the correct
3350 form to make it copy on write again */
3351 if ((sflags & (SVf_FAKE | SVf_READONLY))
3352 != (SVf_FAKE | SVf_READONLY)) {
3353 SvREADONLY_on(sstr);
3355 /* Make the source SV into a loop of 1.
3356 (about to become 2) */
3357 SV_COW_NEXT_SV_SET(sstr, sstr);
3361 /* Initial code is common. */
3362 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3367 /* making another shared SV. */
3368 STRLEN cur = SvCUR(sstr);
3369 STRLEN len = SvLEN(sstr);
3370 #ifdef PERL_OLD_COPY_ON_WRITE
3372 assert (SvTYPE(dstr) >= SVt_PVIV);
3373 /* SvIsCOW_normal */
3374 /* splice us in between source and next-after-source. */
3375 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3376 SV_COW_NEXT_SV_SET(sstr, dstr);
3377 SvPV_set(dstr, SvPVX_mutable(sstr));
3381 /* SvIsCOW_shared_hash */
3382 DEBUG_C(PerlIO_printf(Perl_debug_log,
3383 "Copy on write: Sharing hash\n"));
3385 assert (SvTYPE(dstr) >= SVt_PV);
3387 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3389 SvLEN_set(dstr, len);
3390 SvCUR_set(dstr, cur);
3391 SvREADONLY_on(dstr);
3393 /* Relesase a global SV mutex. */
3396 { /* Passes the swipe test. */
3397 SvPV_set(dstr, SvPVX_mutable(sstr));
3398 SvLEN_set(dstr, SvLEN(sstr));
3399 SvCUR_set(dstr, SvCUR(sstr));
3402 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3403 SvPV_set(sstr, NULL);
3409 if (sflags & SVp_NOK) {
3410 SvNV_set(dstr, SvNVX(sstr));
3412 if (sflags & SVp_IOK) {
3413 SvRELEASE_IVX(dstr);
3414 SvIV_set(dstr, SvIVX(sstr));
3415 /* Must do this otherwise some other overloaded use of 0x80000000
3416 gets confused. I guess SVpbm_VALID */
3417 if (sflags & SVf_IVisUV)
3420 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3422 const MAGIC * const smg = SvVOK(sstr);
3424 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3425 smg->mg_ptr, smg->mg_len);
3426 SvRMAGICAL_on(dstr);
3430 else if (sflags & (SVp_IOK|SVp_NOK)) {
3431 (void)SvOK_off(dstr);
3432 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3433 if (sflags & SVp_IOK) {
3434 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3435 SvIV_set(dstr, SvIVX(sstr));
3437 if (sflags & SVp_NOK) {
3438 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3439 SvNV_set(dstr, SvNVX(sstr));
3443 if (dtype == SVt_PVGV) {
3444 if (ckWARN(WARN_MISC))
3445 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3448 (void)SvOK_off(dstr);
3450 if (SvTAINTED(sstr))
3455 =for apidoc sv_setsv_mg
3457 Like C<sv_setsv>, but also handles 'set' magic.
3463 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3465 sv_setsv(dstr,sstr);
3469 #ifdef PERL_OLD_COPY_ON_WRITE
3471 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3473 STRLEN cur = SvCUR(sstr);
3474 STRLEN len = SvLEN(sstr);
3475 register char *new_pv;
3478 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3486 if (SvTHINKFIRST(dstr))
3487 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3488 else if (SvPVX_const(dstr))
3489 Safefree(SvPVX_const(dstr));
3493 SvUPGRADE(dstr, SVt_PVIV);
3495 assert (SvPOK(sstr));
3496 assert (SvPOKp(sstr));
3497 assert (!SvIOK(sstr));
3498 assert (!SvIOKp(sstr));
3499 assert (!SvNOK(sstr));
3500 assert (!SvNOKp(sstr));
3502 if (SvIsCOW(sstr)) {
3504 if (SvLEN(sstr) == 0) {
3505 /* source is a COW shared hash key. */
3506 DEBUG_C(PerlIO_printf(Perl_debug_log,
3507 "Fast copy on write: Sharing hash\n"));
3508 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3511 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3513 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3514 SvUPGRADE(sstr, SVt_PVIV);
3515 SvREADONLY_on(sstr);
3517 DEBUG_C(PerlIO_printf(Perl_debug_log,
3518 "Fast copy on write: Converting sstr to COW\n"));
3519 SV_COW_NEXT_SV_SET(dstr, sstr);
3521 SV_COW_NEXT_SV_SET(sstr, dstr);
3522 new_pv = SvPVX_mutable(sstr);
3525 SvPV_set(dstr, new_pv);
3526 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3529 SvLEN_set(dstr, len);
3530 SvCUR_set(dstr, cur);
3539 =for apidoc sv_setpvn
3541 Copies a string into an SV. The C<len> parameter indicates the number of
3542 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3543 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3549 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3552 register char *dptr;
3554 SV_CHECK_THINKFIRST_COW_DROP(sv);
3560 /* len is STRLEN which is unsigned, need to copy to signed */
3563 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3565 SvUPGRADE(sv, SVt_PV);
3567 dptr = SvGROW(sv, len + 1);
3568 Move(ptr,dptr,len,char);
3571 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3576 =for apidoc sv_setpvn_mg
3578 Like C<sv_setpvn>, but also handles 'set' magic.
3584 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3586 sv_setpvn(sv,ptr,len);
3591 =for apidoc sv_setpv
3593 Copies a string into an SV. The string must be null-terminated. Does not
3594 handle 'set' magic. See C<sv_setpv_mg>.
3600 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3603 register STRLEN len;
3605 SV_CHECK_THINKFIRST_COW_DROP(sv);
3611 SvUPGRADE(sv, SVt_PV);
3613 SvGROW(sv, len + 1);
3614 Move(ptr,SvPVX(sv),len+1,char);
3616 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3621 =for apidoc sv_setpv_mg
3623 Like C<sv_setpv>, but also handles 'set' magic.
3629 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3636 =for apidoc sv_usepvn
3638 Tells an SV to use C<ptr> to find its string value. Normally the string is
3639 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3640 The C<ptr> should point to memory that was allocated by C<malloc>. The
3641 string length, C<len>, must be supplied. This function will realloc the
3642 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3643 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3644 See C<sv_usepvn_mg>.
3650 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3654 SV_CHECK_THINKFIRST_COW_DROP(sv);
3655 SvUPGRADE(sv, SVt_PV);
3660 if (SvPVX_const(sv))
3663 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3664 ptr = saferealloc (ptr, allocate);
3667 SvLEN_set(sv, allocate);
3669 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3674 =for apidoc sv_usepvn_mg
3676 Like C<sv_usepvn>, but also handles 'set' magic.
3682 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3684 sv_usepvn(sv,ptr,len);
3688 #ifdef PERL_OLD_COPY_ON_WRITE
3689 /* Need to do this *after* making the SV normal, as we need the buffer
3690 pointer to remain valid until after we've copied it. If we let go too early,
3691 another thread could invalidate it by unsharing last of the same hash key
3692 (which it can do by means other than releasing copy-on-write Svs)
3693 or by changing the other copy-on-write SVs in the loop. */
3695 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3697 if (len) { /* this SV was SvIsCOW_normal(sv) */
3698 /* we need to find the SV pointing to us. */
3699 SV * const current = SV_COW_NEXT_SV(after);
3701 if (current == sv) {
3702 /* The SV we point to points back to us (there were only two of us
3704 Hence other SV is no longer copy on write either. */
3706 SvREADONLY_off(after);
3708 /* We need to follow the pointers around the loop. */
3710 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3713 /* don't loop forever if the structure is bust, and we have
3714 a pointer into a closed loop. */
3715 assert (current != after);
3716 assert (SvPVX_const(current) == pvx);
3718 /* Make the SV before us point to the SV after us. */
3719 SV_COW_NEXT_SV_SET(current, after);
3722 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3727 Perl_sv_release_IVX(pTHX_ register SV *sv)
3730 sv_force_normal_flags(sv, 0);
3736 =for apidoc sv_force_normal_flags
3738 Undo various types of fakery on an SV: if the PV is a shared string, make
3739 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3740 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3741 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3742 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3743 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3744 set to some other value.) In addition, the C<flags> parameter gets passed to
3745 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3746 with flags set to 0.
3752 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3755 #ifdef PERL_OLD_COPY_ON_WRITE
3756 if (SvREADONLY(sv)) {
3757 /* At this point I believe I should acquire a global SV mutex. */
3759 const char * const pvx = SvPVX_const(sv);
3760 const STRLEN len = SvLEN(sv);
3761 const STRLEN cur = SvCUR(sv);
3762 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3764 PerlIO_printf(Perl_debug_log,
3765 "Copy on write: Force normal %ld\n",
3771 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3774 if (flags & SV_COW_DROP_PV) {
3775 /* OK, so we don't need to copy our buffer. */
3778 SvGROW(sv, cur + 1);
3779 Move(pvx,SvPVX(sv),cur,char);
3783 sv_release_COW(sv, pvx, len, next);
3788 else if (IN_PERL_RUNTIME)
3789 Perl_croak(aTHX_ PL_no_modify);
3790 /* At this point I believe that I can drop the global SV mutex. */
3793 if (SvREADONLY(sv)) {
3795 const char * const pvx = SvPVX_const(sv);
3796 const STRLEN len = SvCUR(sv);
3799 SvPV_set(sv, Nullch);
3801 SvGROW(sv, len + 1);
3802 Move(pvx,SvPVX(sv),len,char);
3804 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3806 else if (IN_PERL_RUNTIME)
3807 Perl_croak(aTHX_ PL_no_modify);
3811 sv_unref_flags(sv, flags);
3812 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3819 Efficient removal of characters from the beginning of the string buffer.
3820 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3821 the string buffer. The C<ptr> becomes the first character of the adjusted
3822 string. Uses the "OOK hack".
3823 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3824 refer to the same chunk of data.
3830 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3832 register STRLEN delta;
3833 if (!ptr || !SvPOKp(sv))
3835 delta = ptr - SvPVX_const(sv);
3836 SV_CHECK_THINKFIRST(sv);
3837 if (SvTYPE(sv) < SVt_PVIV)
3838 sv_upgrade(sv,SVt_PVIV);
3841 if (!SvLEN(sv)) { /* make copy of shared string */
3842 const char *pvx = SvPVX_const(sv);
3843 const STRLEN len = SvCUR(sv);
3844 SvGROW(sv, len + 1);
3845 Move(pvx,SvPVX(sv),len,char);
3849 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3850 and we do that anyway inside the SvNIOK_off
3852 SvFLAGS(sv) |= SVf_OOK;
3855 SvLEN_set(sv, SvLEN(sv) - delta);
3856 SvCUR_set(sv, SvCUR(sv) - delta);
3857 SvPV_set(sv, SvPVX(sv) + delta);
3858 SvIV_set(sv, SvIVX(sv) + delta);
3862 =for apidoc sv_catpvn
3864 Concatenates the string onto the end of the string which is in the SV. The
3865 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3866 status set, then the bytes appended should be valid UTF-8.
3867 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3869 =for apidoc sv_catpvn_flags
3871 Concatenates the string onto the end of the string which is in the SV. The
3872 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3873 status set, then the bytes appended should be valid UTF-8.
3874 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3875 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3876 in terms of this function.
3882 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3886 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3888 SvGROW(dsv, dlen + slen + 1);
3890 sstr = SvPVX_const(dsv);
3891 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3892 SvCUR_set(dsv, SvCUR(dsv) + slen);
3894 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3896 if (flags & SV_SMAGIC)
3901 =for apidoc sv_catsv
3903 Concatenates the string from SV C<ssv> onto the end of the string in
3904 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3905 not 'set' magic. See C<sv_catsv_mg>.
3907 =for apidoc sv_catsv_flags
3909 Concatenates the string from SV C<ssv> onto the end of the string in
3910 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3911 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3912 and C<sv_catsv_nomg> are implemented in terms of this function.
3917 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3922 const char *spv = SvPV_const(ssv, slen);
3924 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3925 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3926 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3927 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3928 dsv->sv_flags doesn't have that bit set.
3929 Andy Dougherty 12 Oct 2001
3931 const I32 sutf8 = DO_UTF8(ssv);
3934 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3936 dutf8 = DO_UTF8(dsv);
3938 if (dutf8 != sutf8) {
3940 /* Not modifying source SV, so taking a temporary copy. */
3941 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3943 sv_utf8_upgrade(csv);
3944 spv = SvPV_const(csv, slen);
3947 sv_utf8_upgrade_nomg(dsv);
3949 sv_catpvn_nomg(dsv, spv, slen);
3952 if (flags & SV_SMAGIC)
3957 =for apidoc sv_catpv
3959 Concatenates the string onto the end of the string which is in the SV.
3960 If the SV has the UTF-8 status set, then the bytes appended should be
3961 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3966 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3969 register STRLEN len;
3975 junk = SvPV_force(sv, tlen);
3977 SvGROW(sv, tlen + len + 1);
3979 ptr = SvPVX_const(sv);
3980 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3981 SvCUR_set(sv, SvCUR(sv) + len);
3982 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3987 =for apidoc sv_catpv_mg
3989 Like C<sv_catpv>, but also handles 'set' magic.
3995 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4004 Creates a new SV. A non-zero C<len> parameter indicates the number of
4005 bytes of preallocated string space the SV should have. An extra byte for a
4006 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4007 space is allocated.) The reference count for the new SV is set to 1.
4009 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4010 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4011 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4012 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4013 modules supporting older perls.
4019 Perl_newSV(pTHX_ STRLEN len)
4026 sv_upgrade(sv, SVt_PV);
4027 SvGROW(sv, len + 1);
4032 =for apidoc sv_magicext
4034 Adds magic to an SV, upgrading it if necessary. Applies the
4035 supplied vtable and returns a pointer to the magic added.
4037 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4038 In particular, you can add magic to SvREADONLY SVs, and add more than
4039 one instance of the same 'how'.
4041 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4042 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4043 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4044 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4046 (This is now used as a subroutine by C<sv_magic>.)
4051 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4052 const char* name, I32 namlen)
4057 if (SvTYPE(sv) < SVt_PVMG) {
4058 SvUPGRADE(sv, SVt_PVMG);
4060 Newxz(mg, 1, MAGIC);
4061 mg->mg_moremagic = SvMAGIC(sv);
4062 SvMAGIC_set(sv, mg);
4064 /* Sometimes a magic contains a reference loop, where the sv and
4065 object refer to each other. To prevent a reference loop that
4066 would prevent such objects being freed, we look for such loops
4067 and if we find one we avoid incrementing the object refcount.
4069 Note we cannot do this to avoid self-tie loops as intervening RV must
4070 have its REFCNT incremented to keep it in existence.
4073 if (!obj || obj == sv ||
4074 how == PERL_MAGIC_arylen ||
4075 how == PERL_MAGIC_qr ||
4076 how == PERL_MAGIC_symtab ||
4077 (SvTYPE(obj) == SVt_PVGV &&
4078 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4079 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4080 GvFORM(obj) == (CV*)sv)))
4085 mg->mg_obj = SvREFCNT_inc(obj);
4086 mg->mg_flags |= MGf_REFCOUNTED;
4089 /* Normal self-ties simply pass a null object, and instead of
4090 using mg_obj directly, use the SvTIED_obj macro to produce a
4091 new RV as needed. For glob "self-ties", we are tieing the PVIO
4092 with an RV obj pointing to the glob containing the PVIO. In
4093 this case, to avoid a reference loop, we need to weaken the
4097 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4098 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4104 mg->mg_len = namlen;
4107 mg->mg_ptr = savepvn(name, namlen);
4108 else if (namlen == HEf_SVKEY)
4109 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4111 mg->mg_ptr = (char *) name;
4113 mg->mg_virtual = vtable;
4117 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4122 =for apidoc sv_magic
4124 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4125 then adds a new magic item of type C<how> to the head of the magic list.
4127 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4128 handling of the C<name> and C<namlen> arguments.
4130 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4131 to add more than one instance of the same 'how'.
4137 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4143 #ifdef PERL_OLD_COPY_ON_WRITE
4145 sv_force_normal_flags(sv, 0);
4147 if (SvREADONLY(sv)) {
4149 /* its okay to attach magic to shared strings; the subsequent
4150 * upgrade to PVMG will unshare the string */
4151 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4154 && how != PERL_MAGIC_regex_global
4155 && how != PERL_MAGIC_bm
4156 && how != PERL_MAGIC_fm
4157 && how != PERL_MAGIC_sv
4158 && how != PERL_MAGIC_backref
4161 Perl_croak(aTHX_ PL_no_modify);
4164 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4165 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4166 /* sv_magic() refuses to add a magic of the same 'how' as an
4169 if (how == PERL_MAGIC_taint)
4177 vtable = &PL_vtbl_sv;
4179 case PERL_MAGIC_overload:
4180 vtable = &PL_vtbl_amagic;
4182 case PERL_MAGIC_overload_elem:
4183 vtable = &PL_vtbl_amagicelem;
4185 case PERL_MAGIC_overload_table:
4186 vtable = &PL_vtbl_ovrld;
4189 vtable = &PL_vtbl_bm;
4191 case PERL_MAGIC_regdata:
4192 vtable = &PL_vtbl_regdata;
4194 case PERL_MAGIC_regdatum:
4195 vtable = &PL_vtbl_regdatum;
4197 case PERL_MAGIC_env:
4198 vtable = &PL_vtbl_env;
4201 vtable = &PL_vtbl_fm;
4203 case PERL_MAGIC_envelem:
4204 vtable = &PL_vtbl_envelem;
4206 case PERL_MAGIC_regex_global:
4207 vtable = &PL_vtbl_mglob;
4209 case PERL_MAGIC_isa:
4210 vtable = &PL_vtbl_isa;
4212 case PERL_MAGIC_isaelem:
4213 vtable = &PL_vtbl_isaelem;
4215 case PERL_MAGIC_nkeys:
4216 vtable = &PL_vtbl_nkeys;
4218 case PERL_MAGIC_dbfile:
4221 case PERL_MAGIC_dbline:
4222 vtable = &PL_vtbl_dbline;
4224 #ifdef USE_LOCALE_COLLATE
4225 case PERL_MAGIC_collxfrm:
4226 vtable = &PL_vtbl_collxfrm;
4228 #endif /* USE_LOCALE_COLLATE */
4229 case PERL_MAGIC_tied:
4230 vtable = &PL_vtbl_pack;
4232 case PERL_MAGIC_tiedelem:
4233 case PERL_MAGIC_tiedscalar:
4234 vtable = &PL_vtbl_packelem;
4237 vtable = &PL_vtbl_regexp;
4239 case PERL_MAGIC_sig:
4240 vtable = &PL_vtbl_sig;
4242 case PERL_MAGIC_sigelem:
4243 vtable = &PL_vtbl_sigelem;
4245 case PERL_MAGIC_taint:
4246 vtable = &PL_vtbl_taint;
4248 case PERL_MAGIC_uvar:
4249 vtable = &PL_vtbl_uvar;
4251 case PERL_MAGIC_vec:
4252 vtable = &PL_vtbl_vec;
4254 case PERL_MAGIC_arylen_p:
4255 case PERL_MAGIC_rhash:
4256 case PERL_MAGIC_symtab:
4257 case PERL_MAGIC_vstring:
4260 case PERL_MAGIC_utf8:
4261 vtable = &PL_vtbl_utf8;
4263 case PERL_MAGIC_substr:
4264 vtable = &PL_vtbl_substr;
4266 case PERL_MAGIC_defelem:
4267 vtable = &PL_vtbl_defelem;
4269 case PERL_MAGIC_glob:
4270 vtable = &PL_vtbl_glob;
4272 case PERL_MAGIC_arylen:
4273 vtable = &PL_vtbl_arylen;
4275 case PERL_MAGIC_pos:
4276 vtable = &PL_vtbl_pos;
4278 case PERL_MAGIC_backref:
4279 vtable = &PL_vtbl_backref;
4281 case PERL_MAGIC_ext:
4282 /* Reserved for use by extensions not perl internals. */
4283 /* Useful for attaching extension internal data to perl vars. */
4284 /* Note that multiple extensions may clash if magical scalars */
4285 /* etc holding private data from one are passed to another. */
4289 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4292 /* Rest of work is done else where */
4293 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4296 case PERL_MAGIC_taint:
4299 case PERL_MAGIC_ext:
4300 case PERL_MAGIC_dbfile:
4307 =for apidoc sv_unmagic
4309 Removes all magic of type C<type> from an SV.
4315 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4319 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4322 for (mg = *mgp; mg; mg = *mgp) {
4323 if (mg->mg_type == type) {
4324 const MGVTBL* const vtbl = mg->mg_virtual;
4325 *mgp = mg->mg_moremagic;
4326 if (vtbl && vtbl->svt_free)
4327 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4328 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4330 Safefree(mg->mg_ptr);
4331 else if (mg->mg_len == HEf_SVKEY)
4332 SvREFCNT_dec((SV*)mg->mg_ptr);
4333 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4334 Safefree(mg->mg_ptr);
4336 if (mg->mg_flags & MGf_REFCOUNTED)
4337 SvREFCNT_dec(mg->mg_obj);
4341 mgp = &mg->mg_moremagic;
4345 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4346 SvMAGIC_set(sv, NULL);
4353 =for apidoc sv_rvweaken
4355 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4356 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4357 push a back-reference to this RV onto the array of backreferences
4358 associated with that magic.
4364 Perl_sv_rvweaken(pTHX_ SV *sv)
4367 if (!SvOK(sv)) /* let undefs pass */
4370 Perl_croak(aTHX_ "Can't weaken a nonreference");
4371 else if (SvWEAKREF(sv)) {
4372 if (ckWARN(WARN_MISC))
4373 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4377 Perl_sv_add_backref(aTHX_ tsv, sv);
4383 /* Give tsv backref magic if it hasn't already got it, then push a
4384 * back-reference to sv onto the array associated with the backref magic.
4388 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4393 if (SvTYPE(tsv) == SVt_PVHV) {
4394 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4398 /* There is no AV in the offical place - try a fixup. */
4399 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4402 /* Aha. They've got it stowed in magic. Bring it back. */
4403 av = (AV*)mg->mg_obj;
4404 /* Stop mg_free decreasing the refernce count. */
4406 /* Stop mg_free even calling the destructor, given that
4407 there's no AV to free up. */
4409 sv_unmagic(tsv, PERL_MAGIC_backref);
4418 const MAGIC *const mg
4419 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4421 av = (AV*)mg->mg_obj;
4425 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4426 /* av now has a refcnt of 2, which avoids it getting freed
4427 * before us during global cleanup. The extra ref is removed
4428 * by magic_killbackrefs() when tsv is being freed */
4431 if (AvFILLp(av) >= AvMAX(av)) {
4432 av_extend(av, AvFILLp(av)+1);
4434 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4437 /* delete a back-reference to ourselves from the backref magic associated
4438 * with the SV we point to.
4442 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4449 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4450 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4451 /* We mustn't attempt to "fix up" the hash here by moving the
4452 backreference array back to the hv_aux structure, as that is stored
4453 in the main HvARRAY(), and hfreentries assumes that no-one
4454 reallocates HvARRAY() while it is running. */
4457 const MAGIC *const mg
4458 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4460 av = (AV *)mg->mg_obj;
4463 if (PL_in_clean_all)
4465 Perl_croak(aTHX_ "panic: del_backref");
4472 /* We shouldn't be in here more than once, but for paranoia reasons lets
4474 for (i = AvFILLp(av); i >= 0; i--) {
4476 const SSize_t fill = AvFILLp(av);
4478 /* We weren't the last entry.
4479 An unordered list has this property that you can take the
4480 last element off the end to fill the hole, and it's still
4481 an unordered list :-)
4486 AvFILLp(av) = fill - 1;
4492 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4494 SV **svp = AvARRAY(av);
4496 PERL_UNUSED_ARG(sv);
4498 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4499 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4500 if (svp && !SvIS_FREED(av)) {
4501 SV *const *const last = svp + AvFILLp(av);
4503 while (svp <= last) {
4505 SV *const referrer = *svp;
4506 if (SvWEAKREF(referrer)) {
4507 /* XXX Should we check that it hasn't changed? */
4508 SvRV_set(referrer, 0);
4510 SvWEAKREF_off(referrer);
4511 } else if (SvTYPE(referrer) == SVt_PVGV ||
4512 SvTYPE(referrer) == SVt_PVLV) {
4513 /* You lookin' at me? */
4514 assert(GvSTASH(referrer));
4515 assert(GvSTASH(referrer) == (HV*)sv);
4516 GvSTASH(referrer) = 0;
4519 "panic: magic_killbackrefs (flags=%"UVxf")",
4520 (UV)SvFLAGS(referrer));
4528 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4533 =for apidoc sv_insert
4535 Inserts a string at the specified offset/length within the SV. Similar to
4536 the Perl substr() function.
4542 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4547 register char *midend;
4548 register char *bigend;
4554 Perl_croak(aTHX_ "Can't modify non-existent substring");
4555 SvPV_force(bigstr, curlen);
4556 (void)SvPOK_only_UTF8(bigstr);
4557 if (offset + len > curlen) {
4558 SvGROW(bigstr, offset+len+1);
4559 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4560 SvCUR_set(bigstr, offset+len);
4564 i = littlelen - len;
4565 if (i > 0) { /* string might grow */
4566 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4567 mid = big + offset + len;
4568 midend = bigend = big + SvCUR(bigstr);
4571 while (midend > mid) /* shove everything down */
4572 *--bigend = *--midend;
4573 Move(little,big+offset,littlelen,char);
4574 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4579 Move(little,SvPVX(bigstr)+offset,len,char);
4584 big = SvPVX(bigstr);
4587 bigend = big + SvCUR(bigstr);
4589 if (midend > bigend)
4590 Perl_croak(aTHX_ "panic: sv_insert");
4592 if (mid - big > bigend - midend) { /* faster to shorten from end */
4594 Move(little, mid, littlelen,char);
4597 i = bigend - midend;
4599 Move(midend, mid, i,char);
4603 SvCUR_set(bigstr, mid - big);
4605 else if ((i = mid - big)) { /* faster from front */
4606 midend -= littlelen;
4608 sv_chop(bigstr,midend-i);
4613 Move(little, mid, littlelen,char);
4615 else if (littlelen) {
4616 midend -= littlelen;
4617 sv_chop(bigstr,midend);
4618 Move(little,midend,littlelen,char);
4621 sv_chop(bigstr,midend);
4627 =for apidoc sv_replace
4629 Make the first argument a copy of the second, then delete the original.
4630 The target SV physically takes over ownership of the body of the source SV
4631 and inherits its flags; however, the target keeps any magic it owns,
4632 and any magic in the source is discarded.
4633 Note that this is a rather specialist SV copying operation; most of the
4634 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4640 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4643 const U32 refcnt = SvREFCNT(sv);
4644 SV_CHECK_THINKFIRST_COW_DROP(sv);
4645 if (SvREFCNT(nsv) != 1) {
4646 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4647 UVuf " != 1)", (UV) SvREFCNT(nsv));
4649 if (SvMAGICAL(sv)) {
4653 sv_upgrade(nsv, SVt_PVMG);
4654 SvMAGIC_set(nsv, SvMAGIC(sv));
4655 SvFLAGS(nsv) |= SvMAGICAL(sv);
4657 SvMAGIC_set(sv, NULL);
4661 assert(!SvREFCNT(sv));
4662 #ifdef DEBUG_LEAKING_SCALARS
4663 sv->sv_flags = nsv->sv_flags;
4664 sv->sv_any = nsv->sv_any;
4665 sv->sv_refcnt = nsv->sv_refcnt;
4666 sv->sv_u = nsv->sv_u;
4668 StructCopy(nsv,sv,SV);
4670 /* Currently could join these into one piece of pointer arithmetic, but
4671 it would be unclear. */
4672 if(SvTYPE(sv) == SVt_IV)
4674 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4675 else if (SvTYPE(sv) == SVt_RV) {
4676 SvANY(sv) = &sv->sv_u.svu_rv;
4680 #ifdef PERL_OLD_COPY_ON_WRITE
4681 if (SvIsCOW_normal(nsv)) {
4682 /* We need to follow the pointers around the loop to make the
4683 previous SV point to sv, rather than nsv. */
4686 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4689 assert(SvPVX_const(current) == SvPVX_const(nsv));
4691 /* Make the SV before us point to the SV after us. */
4693 PerlIO_printf(Perl_debug_log, "previous is\n");
4695 PerlIO_printf(Perl_debug_log,
4696 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4697 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4699 SV_COW_NEXT_SV_SET(current, sv);
4702 SvREFCNT(sv) = refcnt;
4703 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4709 =for apidoc sv_clear
4711 Clear an SV: call any destructors, free up any memory used by the body,
4712 and free the body itself. The SV's head is I<not> freed, although
4713 its type is set to all 1's so that it won't inadvertently be assumed
4714 to be live during global destruction etc.
4715 This function should only be called when REFCNT is zero. Most of the time
4716 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4723 Perl_sv_clear(pTHX_ register SV *sv)
4726 const U32 type = SvTYPE(sv);
4727 const struct body_details *const sv_type_details
4728 = bodies_by_type + type;
4731 assert(SvREFCNT(sv) == 0);
4737 if (PL_defstash) { /* Still have a symbol table? */
4742 stash = SvSTASH(sv);
4743 destructor = StashHANDLER(stash,DESTROY);
4745 SV* const tmpref = newRV(sv);
4746 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4748 PUSHSTACKi(PERLSI_DESTROY);
4753 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4759 if(SvREFCNT(tmpref) < 2) {
4760 /* tmpref is not kept alive! */
4762 SvRV_set(tmpref, NULL);
4765 SvREFCNT_dec(tmpref);
4767 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4771 if (PL_in_clean_objs)
4772 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4774 /* DESTROY gave object new lease on life */
4780 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4781 SvOBJECT_off(sv); /* Curse the object. */
4782 if (type != SVt_PVIO)
4783 --PL_sv_objcount; /* XXX Might want something more general */
4786 if (type >= SVt_PVMG) {
4789 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4790 SvREFCNT_dec(SvSTASH(sv));
4795 IoIFP(sv) != PerlIO_stdin() &&
4796 IoIFP(sv) != PerlIO_stdout() &&
4797 IoIFP(sv) != PerlIO_stderr())
4799 io_close((IO*)sv, FALSE);
4801 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4802 PerlDir_close(IoDIRP(sv));
4803 IoDIRP(sv) = (DIR*)NULL;
4804 Safefree(IoTOP_NAME(sv));
4805 Safefree(IoFMT_NAME(sv));
4806 Safefree(IoBOTTOM_NAME(sv));
4815 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4822 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4823 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4824 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4825 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4827 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4828 SvREFCNT_dec(LvTARG(sv));
4832 Safefree(GvNAME(sv));
4833 /* If we're in a stash, we don't own a reference to it. However it does
4834 have a back reference to us, which needs to be cleared. */
4836 sv_del_backref((SV*)GvSTASH(sv), sv);
4841 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4843 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4844 /* Don't even bother with turning off the OOK flag. */
4849 SV *target = SvRV(sv);
4851 sv_del_backref(target, sv);
4853 SvREFCNT_dec(target);
4855 #ifdef PERL_OLD_COPY_ON_WRITE
4856 else if (SvPVX_const(sv)) {
4858 /* I believe I need to grab the global SV mutex here and
4859 then recheck the COW status. */
4861 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4864 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4865 SV_COW_NEXT_SV(sv));
4866 /* And drop it here. */
4868 } else if (SvLEN(sv)) {
4869 Safefree(SvPVX_const(sv));
4873 else if (SvPVX_const(sv) && SvLEN(sv))
4874 Safefree(SvPVX_mutable(sv));
4875 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4876 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4885 SvFLAGS(sv) &= SVf_BREAK;
4886 SvFLAGS(sv) |= SVTYPEMASK;
4888 if (sv_type_details->arena) {
4889 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4890 &PL_body_roots[type]);
4892 else if (sv_type_details->size) {
4893 my_safefree(SvANY(sv));
4898 =for apidoc sv_newref
4900 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4907 Perl_sv_newref(pTHX_ SV *sv)
4917 Decrement an SV's reference count, and if it drops to zero, call
4918 C<sv_clear> to invoke destructors and free up any memory used by
4919 the body; finally, deallocate the SV's head itself.
4920 Normally called via a wrapper macro C<SvREFCNT_dec>.
4926 Perl_sv_free(pTHX_ SV *sv)
4931 if (SvREFCNT(sv) == 0) {
4932 if (SvFLAGS(sv) & SVf_BREAK)
4933 /* this SV's refcnt has been artificially decremented to
4934 * trigger cleanup */
4936 if (PL_in_clean_all) /* All is fair */
4938 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4939 /* make sure SvREFCNT(sv)==0 happens very seldom */
4940 SvREFCNT(sv) = (~(U32)0)/2;
4943 if (ckWARN_d(WARN_INTERNAL)) {
4944 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4945 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4946 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4947 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4948 Perl_dump_sv_child(aTHX_ sv);
4953 if (--(SvREFCNT(sv)) > 0)
4955 Perl_sv_free2(aTHX_ sv);
4959 Perl_sv_free2(pTHX_ SV *sv)
4964 if (ckWARN_d(WARN_DEBUGGING))
4965 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4966 "Attempt to free temp prematurely: SV 0x%"UVxf
4967 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4971 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4972 /* make sure SvREFCNT(sv)==0 happens very seldom */
4973 SvREFCNT(sv) = (~(U32)0)/2;
4984 Returns the length of the string in the SV. Handles magic and type
4985 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4991 Perl_sv_len(pTHX_ register SV *sv)
4999 len = mg_length(sv);
5001 (void)SvPV_const(sv, len);
5006 =for apidoc sv_len_utf8
5008 Returns the number of characters in the string in an SV, counting wide
5009 UTF-8 bytes as a single character. Handles magic and type coercion.
5015 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5016 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5017 * (Note that the mg_len is not the length of the mg_ptr field.)
5022 Perl_sv_len_utf8(pTHX_ register SV *sv)
5028 return mg_length(sv);
5032 const U8 *s = (U8*)SvPV_const(sv, len);
5033 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5035 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5037 #ifdef PERL_UTF8_CACHE_ASSERT
5038 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5042 ulen = Perl_utf8_length(aTHX_ s, s + len);
5043 if (!mg && !SvREADONLY(sv)) {
5044 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5045 mg = mg_find(sv, PERL_MAGIC_utf8);
5055 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5056 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5057 * between UTF-8 and byte offsets. There are two (substr offset and substr
5058 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5059 * and byte offset) cache positions.
5061 * The mg_len field is used by sv_len_utf8(), see its comments.
5062 * Note that the mg_len is not the length of the mg_ptr field.
5066 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5067 I32 offsetp, const U8 *s, const U8 *start)
5071 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5073 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5077 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5079 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5080 (*mgp)->mg_ptr = (char *) *cachep;
5084 (*cachep)[i] = offsetp;
5085 (*cachep)[i+1] = s - start;
5093 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5094 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5095 * between UTF-8 and byte offsets. See also the comments of
5096 * S_utf8_mg_pos_init().
5100 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)
5104 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5106 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5107 if (*mgp && (*mgp)->mg_ptr) {
5108 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5109 ASSERT_UTF8_CACHE(*cachep);
5110 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5112 else { /* We will skip to the right spot. */
5117 /* The assumption is that going backward is half
5118 * the speed of going forward (that's where the
5119 * 2 * backw in the below comes from). (The real
5120 * figure of course depends on the UTF-8 data.) */
5122 if ((*cachep)[i] > (STRLEN)uoff) {
5124 backw = (*cachep)[i] - (STRLEN)uoff;
5126 if (forw < 2 * backw)
5129 p = start + (*cachep)[i+1];
5131 /* Try this only for the substr offset (i == 0),
5132 * not for the substr length (i == 2). */
5133 else if (i == 0) { /* (*cachep)[i] < uoff */
5134 const STRLEN ulen = sv_len_utf8(sv);
5136 if ((STRLEN)uoff < ulen) {
5137 forw = (STRLEN)uoff - (*cachep)[i];
5138 backw = ulen - (STRLEN)uoff;
5140 if (forw < 2 * backw)
5141 p = start + (*cachep)[i+1];
5146 /* If the string is not long enough for uoff,
5147 * we could extend it, but not at this low a level. */
5151 if (forw < 2 * backw) {
5158 while (UTF8_IS_CONTINUATION(*p))
5163 /* Update the cache. */
5164 (*cachep)[i] = (STRLEN)uoff;
5165 (*cachep)[i+1] = p - start;
5167 /* Drop the stale "length" cache */
5176 if (found) { /* Setup the return values. */
5177 *offsetp = (*cachep)[i+1];
5178 *sp = start + *offsetp;
5181 *offsetp = send - start;
5183 else if (*sp < start) {
5189 #ifdef PERL_UTF8_CACHE_ASSERT
5194 while (n-- && s < send)
5198 assert(*offsetp == s - start);
5199 assert((*cachep)[0] == (STRLEN)uoff);
5200 assert((*cachep)[1] == *offsetp);
5202 ASSERT_UTF8_CACHE(*cachep);
5211 =for apidoc sv_pos_u2b
5213 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5214 the start of the string, to a count of the equivalent number of bytes; if
5215 lenp is non-zero, it does the same to lenp, but this time starting from
5216 the offset, rather than from the start of the string. Handles magic and
5223 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5224 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5225 * byte offsets. See also the comments of S_utf8_mg_pos().
5230 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5238 start = (U8*)SvPV_const(sv, len);
5241 STRLEN *cache = NULL;
5242 const U8 *s = start;
5243 I32 uoffset = *offsetp;
5244 const U8 * const send = s + len;
5246 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5248 if (!found && uoffset > 0) {
5249 while (s < send && uoffset--)
5253 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5255 *offsetp = s - start;
5260 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5264 if (!found && *lenp > 0) {
5267 while (s < send && ulen--)
5271 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5275 ASSERT_UTF8_CACHE(cache);
5287 =for apidoc sv_pos_b2u
5289 Converts the value pointed to by offsetp from a count of bytes from the
5290 start of the string, to a count of the equivalent number of UTF-8 chars.
5291 Handles magic and type coercion.
5297 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5298 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5299 * byte offsets. See also the comments of S_utf8_mg_pos().
5304 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5312 s = (const U8*)SvPV_const(sv, len);
5313 if ((I32)len < *offsetp)
5314 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5316 const U8* send = s + *offsetp;
5318 STRLEN *cache = NULL;
5322 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5323 mg = mg_find(sv, PERL_MAGIC_utf8);
5324 if (mg && mg->mg_ptr) {
5325 cache = (STRLEN *) mg->mg_ptr;
5326 if (cache[1] == (STRLEN)*offsetp) {
5327 /* An exact match. */
5328 *offsetp = cache[0];
5332 else if (cache[1] < (STRLEN)*offsetp) {
5333 /* We already know part of the way. */
5336 /* Let the below loop do the rest. */
5338 else { /* cache[1] > *offsetp */
5339 /* We already know all of the way, now we may
5340 * be able to walk back. The same assumption
5341 * is made as in S_utf8_mg_pos(), namely that
5342 * walking backward is twice slower than
5343 * walking forward. */
5344 const STRLEN forw = *offsetp;
5345 STRLEN backw = cache[1] - *offsetp;
5347 if (!(forw < 2 * backw)) {
5348 const U8 *p = s + cache[1];
5355 while (UTF8_IS_CONTINUATION(*p)) {
5363 *offsetp = cache[0];
5365 /* Drop the stale "length" cache */
5373 ASSERT_UTF8_CACHE(cache);
5379 /* Call utf8n_to_uvchr() to validate the sequence
5380 * (unless a simple non-UTF character) */
5381 if (!UTF8_IS_INVARIANT(*s))
5382 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5391 if (!SvREADONLY(sv)) {
5393 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5394 mg = mg_find(sv, PERL_MAGIC_utf8);
5399 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5400 mg->mg_ptr = (char *) cache;
5405 cache[1] = *offsetp;
5406 /* Drop the stale "length" cache */
5419 Returns a boolean indicating whether the strings in the two SVs are
5420 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5421 coerce its args to strings if necessary.
5427 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5436 SV* svrecode = Nullsv;
5443 pv1 = SvPV_const(sv1, cur1);
5450 pv2 = SvPV_const(sv2, cur2);
5452 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5453 /* Differing utf8ness.
5454 * Do not UTF8size the comparands as a side-effect. */
5457 svrecode = newSVpvn(pv2, cur2);
5458 sv_recode_to_utf8(svrecode, PL_encoding);
5459 pv2 = SvPV_const(svrecode, cur2);
5462 svrecode = newSVpvn(pv1, cur1);
5463 sv_recode_to_utf8(svrecode, PL_encoding);
5464 pv1 = SvPV_const(svrecode, cur1);
5466 /* Now both are in UTF-8. */
5468 SvREFCNT_dec(svrecode);
5473 bool is_utf8 = TRUE;
5476 /* sv1 is the UTF-8 one,
5477 * if is equal it must be downgrade-able */
5478 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5484 /* sv2 is the UTF-8 one,
5485 * if is equal it must be downgrade-able */
5486 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5492 /* Downgrade not possible - cannot be eq */
5500 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5503 SvREFCNT_dec(svrecode);
5514 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5515 string in C<sv1> is less than, equal to, or greater than the string in
5516 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5517 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5523 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5527 const char *pv1, *pv2;
5530 SV *svrecode = Nullsv;
5537 pv1 = SvPV_const(sv1, cur1);
5544 pv2 = SvPV_const(sv2, cur2);
5546 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5547 /* Differing utf8ness.
5548 * Do not UTF8size the comparands as a side-effect. */
5551 svrecode = newSVpvn(pv2, cur2);
5552 sv_recode_to_utf8(svrecode, PL_encoding);
5553 pv2 = SvPV_const(svrecode, cur2);
5556 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5561 svrecode = newSVpvn(pv1, cur1);
5562 sv_recode_to_utf8(svrecode, PL_encoding);
5563 pv1 = SvPV_const(svrecode, cur1);
5566 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5572 cmp = cur2 ? -1 : 0;
5576 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5579 cmp = retval < 0 ? -1 : 1;
5580 } else if (cur1 == cur2) {
5583 cmp = cur1 < cur2 ? -1 : 1;
5588 SvREFCNT_dec(svrecode);
5597 =for apidoc sv_cmp_locale
5599 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5600 'use bytes' aware, handles get magic, and will coerce its args to strings
5601 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5607 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5610 #ifdef USE_LOCALE_COLLATE
5616 if (PL_collation_standard)
5620 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5622 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5624 if (!pv1 || !len1) {
5635 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5638 return retval < 0 ? -1 : 1;
5641 * When the result of collation is equality, that doesn't mean
5642 * that there are no differences -- some locales exclude some
5643 * characters from consideration. So to avoid false equalities,
5644 * we use the raw string as a tiebreaker.
5650 #endif /* USE_LOCALE_COLLATE */
5652 return sv_cmp(sv1, sv2);
5656 #ifdef USE_LOCALE_COLLATE
5659 =for apidoc sv_collxfrm
5661 Add Collate Transform magic to an SV if it doesn't already have it.
5663 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5664 scalar data of the variable, but transformed to such a format that a normal
5665 memory comparison can be used to compare the data according to the locale
5672 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5677 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5678 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5684 Safefree(mg->mg_ptr);
5685 s = SvPV_const(sv, len);
5686 if ((xf = mem_collxfrm(s, len, &xlen))) {
5687 if (SvREADONLY(sv)) {
5690 return xf + sizeof(PL_collation_ix);
5693 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5694 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5707 if (mg && mg->mg_ptr) {
5709 return mg->mg_ptr + sizeof(PL_collation_ix);
5717 #endif /* USE_LOCALE_COLLATE */
5722 Get a line from the filehandle and store it into the SV, optionally
5723 appending to the currently-stored string.
5729 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5734 register STDCHAR rslast;
5735 register STDCHAR *bp;
5741 if (SvTHINKFIRST(sv))
5742 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5743 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5745 However, perlbench says it's slower, because the existing swipe code
5746 is faster than copy on write.
5747 Swings and roundabouts. */
5748 SvUPGRADE(sv, SVt_PV);
5753 if (PerlIO_isutf8(fp)) {
5755 sv_utf8_upgrade_nomg(sv);
5756 sv_pos_u2b(sv,&append,0);
5758 } else if (SvUTF8(sv)) {
5759 SV * const tsv = newSV(0);
5760 sv_gets(tsv, fp, 0);
5761 sv_utf8_upgrade_nomg(tsv);
5762 SvCUR_set(sv,append);
5765 goto return_string_or_null;
5770 if (PerlIO_isutf8(fp))
5773 if (IN_PERL_COMPILETIME) {
5774 /* we always read code in line mode */
5778 else if (RsSNARF(PL_rs)) {
5779 /* If it is a regular disk file use size from stat() as estimate
5780 of amount we are going to read - may result in malloc-ing
5781 more memory than we realy need if layers bellow reduce
5782 size we read (e.g. CRLF or a gzip layer)
5785 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5786 const Off_t offset = PerlIO_tell(fp);
5787 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5788 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5794 else if (RsRECORD(PL_rs)) {
5798 /* Grab the size of the record we're getting */
5799 recsize = SvIV(SvRV(PL_rs));
5800 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5803 /* VMS wants read instead of fread, because fread doesn't respect */
5804 /* RMS record boundaries. This is not necessarily a good thing to be */
5805 /* doing, but we've got no other real choice - except avoid stdio
5806 as implementation - perhaps write a :vms layer ?
5808 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5810 bytesread = PerlIO_read(fp, buffer, recsize);
5814 SvCUR_set(sv, bytesread += append);
5815 buffer[bytesread] = '\0';
5816 goto return_string_or_null;
5818 else if (RsPARA(PL_rs)) {
5824 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5825 if (PerlIO_isutf8(fp)) {
5826 rsptr = SvPVutf8(PL_rs, rslen);
5829 if (SvUTF8(PL_rs)) {
5830 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5831 Perl_croak(aTHX_ "Wide character in $/");
5834 rsptr = SvPV_const(PL_rs, rslen);
5838 rslast = rslen ? rsptr[rslen - 1] : '\0';
5840 if (rspara) { /* have to do this both before and after */
5841 do { /* to make sure file boundaries work right */
5844 i = PerlIO_getc(fp);
5848 PerlIO_ungetc(fp,i);
5854 /* See if we know enough about I/O mechanism to cheat it ! */
5856 /* This used to be #ifdef test - it is made run-time test for ease
5857 of abstracting out stdio interface. One call should be cheap
5858 enough here - and may even be a macro allowing compile
5862 if (PerlIO_fast_gets(fp)) {
5865 * We're going to steal some values from the stdio struct
5866 * and put EVERYTHING in the innermost loop into registers.
5868 register STDCHAR *ptr;
5872 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5873 /* An ungetc()d char is handled separately from the regular
5874 * buffer, so we getc() it back out and stuff it in the buffer.
5876 i = PerlIO_getc(fp);
5877 if (i == EOF) return 0;
5878 *(--((*fp)->_ptr)) = (unsigned char) i;
5882 /* Here is some breathtakingly efficient cheating */
5884 cnt = PerlIO_get_cnt(fp); /* get count into register */
5885 /* make sure we have the room */
5886 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5887 /* Not room for all of it
5888 if we are looking for a separator and room for some
5890 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5891 /* just process what we have room for */
5892 shortbuffered = cnt - SvLEN(sv) + append + 1;
5893 cnt -= shortbuffered;
5897 /* remember that cnt can be negative */
5898 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5903 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5904 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5905 DEBUG_P(PerlIO_printf(Perl_debug_log,
5906 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5907 DEBUG_P(PerlIO_printf(Perl_debug_log,
5908 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5909 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5910 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5915 while (cnt > 0) { /* this | eat */
5917 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5918 goto thats_all_folks; /* screams | sed :-) */
5922 Copy(ptr, bp, cnt, char); /* this | eat */
5923 bp += cnt; /* screams | dust */
5924 ptr += cnt; /* louder | sed :-) */
5929 if (shortbuffered) { /* oh well, must extend */
5930 cnt = shortbuffered;
5932 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5934 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5935 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5939 DEBUG_P(PerlIO_printf(Perl_debug_log,
5940 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5941 PTR2UV(ptr),(long)cnt));
5942 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5944 DEBUG_P(PerlIO_printf(Perl_debug_log,
5945 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5946 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5947 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5949 /* This used to call 'filbuf' in stdio form, but as that behaves like
5950 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5951 another abstraction. */
5952 i = PerlIO_getc(fp); /* get more characters */
5954 DEBUG_P(PerlIO_printf(Perl_debug_log,
5955 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5956 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5957 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5959 cnt = PerlIO_get_cnt(fp);
5960 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5961 DEBUG_P(PerlIO_printf(Perl_debug_log,
5962 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5964 if (i == EOF) /* all done for ever? */
5965 goto thats_really_all_folks;
5967 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5969 SvGROW(sv, bpx + cnt + 2);
5970 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5972 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5974 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5975 goto thats_all_folks;
5979 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5980 memNE((char*)bp - rslen, rsptr, rslen))
5981 goto screamer; /* go back to the fray */
5982 thats_really_all_folks:
5984 cnt += shortbuffered;
5985 DEBUG_P(PerlIO_printf(Perl_debug_log,
5986 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5987 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5988 DEBUG_P(PerlIO_printf(Perl_debug_log,
5989 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5990 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5991 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5993 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5994 DEBUG_P(PerlIO_printf(Perl_debug_log,
5995 "Screamer: done, len=%ld, string=|%.*s|\n",
5996 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6000 /*The big, slow, and stupid way. */
6001 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6002 STDCHAR *buf = NULL;
6003 Newx(buf, 8192, STDCHAR);
6011 register const STDCHAR * const bpe = buf + sizeof(buf);
6013 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6014 ; /* keep reading */
6018 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6019 /* Accomodate broken VAXC compiler, which applies U8 cast to
6020 * both args of ?: operator, causing EOF to change into 255
6023 i = (U8)buf[cnt - 1];
6029 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6031 sv_catpvn(sv, (char *) buf, cnt);
6033 sv_setpvn(sv, (char *) buf, cnt);
6035 if (i != EOF && /* joy */
6037 SvCUR(sv) < rslen ||
6038 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6042 * If we're reading from a TTY and we get a short read,
6043 * indicating that the user hit his EOF character, we need
6044 * to notice it now, because if we try to read from the TTY
6045 * again, the EOF condition will disappear.
6047 * The comparison of cnt to sizeof(buf) is an optimization
6048 * that prevents unnecessary calls to feof().
6052 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6056 #ifdef USE_HEAP_INSTEAD_OF_STACK
6061 if (rspara) { /* have to do this both before and after */
6062 while (i != EOF) { /* to make sure file boundaries work right */
6063 i = PerlIO_getc(fp);
6065 PerlIO_ungetc(fp,i);
6071 return_string_or_null:
6072 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6078 Auto-increment of the value in the SV, doing string to numeric conversion
6079 if necessary. Handles 'get' magic.
6085 Perl_sv_inc(pTHX_ register SV *sv)
6094 if (SvTHINKFIRST(sv)) {
6096 sv_force_normal_flags(sv, 0);
6097 if (SvREADONLY(sv)) {
6098 if (IN_PERL_RUNTIME)
6099 Perl_croak(aTHX_ PL_no_modify);
6103 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6105 i = PTR2IV(SvRV(sv));
6110 flags = SvFLAGS(sv);
6111 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6112 /* It's (privately or publicly) a float, but not tested as an
6113 integer, so test it to see. */
6115 flags = SvFLAGS(sv);
6117 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6118 /* It's publicly an integer, or privately an integer-not-float */
6119 #ifdef PERL_PRESERVE_IVUV
6123 if (SvUVX(sv) == UV_MAX)
6124 sv_setnv(sv, UV_MAX_P1);
6126 (void)SvIOK_only_UV(sv);
6127 SvUV_set(sv, SvUVX(sv) + 1);
6129 if (SvIVX(sv) == IV_MAX)
6130 sv_setuv(sv, (UV)IV_MAX + 1);
6132 (void)SvIOK_only(sv);
6133 SvIV_set(sv, SvIVX(sv) + 1);
6138 if (flags & SVp_NOK) {
6139 (void)SvNOK_only(sv);
6140 SvNV_set(sv, SvNVX(sv) + 1.0);
6144 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6145 if ((flags & SVTYPEMASK) < SVt_PVIV)
6146 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6147 (void)SvIOK_only(sv);
6152 while (isALPHA(*d)) d++;
6153 while (isDIGIT(*d)) d++;
6155 #ifdef PERL_PRESERVE_IVUV
6156 /* Got to punt this as an integer if needs be, but we don't issue
6157 warnings. Probably ought to make the sv_iv_please() that does
6158 the conversion if possible, and silently. */
6159 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6160 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6161 /* Need to try really hard to see if it's an integer.
6162 9.22337203685478e+18 is an integer.
6163 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6164 so $a="9.22337203685478e+18"; $a+0; $a++
6165 needs to be the same as $a="9.22337203685478e+18"; $a++
6172 /* sv_2iv *should* have made this an NV */
6173 if (flags & SVp_NOK) {
6174 (void)SvNOK_only(sv);
6175 SvNV_set(sv, SvNVX(sv) + 1.0);
6178 /* I don't think we can get here. Maybe I should assert this
6179 And if we do get here I suspect that sv_setnv will croak. NWC
6181 #if defined(USE_LONG_DOUBLE)
6182 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",
6183 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6185 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6186 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6189 #endif /* PERL_PRESERVE_IVUV */
6190 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6194 while (d >= SvPVX_const(sv)) {
6202 /* MKS: The original code here died if letters weren't consecutive.
6203 * at least it didn't have to worry about non-C locales. The
6204 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6205 * arranged in order (although not consecutively) and that only
6206 * [A-Za-z] are accepted by isALPHA in the C locale.
6208 if (*d != 'z' && *d != 'Z') {
6209 do { ++*d; } while (!isALPHA(*d));
6212 *(d--) -= 'z' - 'a';
6217 *(d--) -= 'z' - 'a' + 1;
6221 /* oh,oh, the number grew */
6222 SvGROW(sv, SvCUR(sv) + 2);
6223 SvCUR_set(sv, SvCUR(sv) + 1);
6224 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6235 Auto-decrement of the value in the SV, doing string to numeric conversion
6236 if necessary. Handles 'get' magic.
6242 Perl_sv_dec(pTHX_ register SV *sv)
6250 if (SvTHINKFIRST(sv)) {
6252 sv_force_normal_flags(sv, 0);
6253 if (SvREADONLY(sv)) {
6254 if (IN_PERL_RUNTIME)
6255 Perl_croak(aTHX_ PL_no_modify);
6259 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6261 i = PTR2IV(SvRV(sv));
6266 /* Unlike sv_inc we don't have to worry about string-never-numbers
6267 and keeping them magic. But we mustn't warn on punting */
6268 flags = SvFLAGS(sv);
6269 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6270 /* It's publicly an integer, or privately an integer-not-float */
6271 #ifdef PERL_PRESERVE_IVUV
6275 if (SvUVX(sv) == 0) {
6276 (void)SvIOK_only(sv);
6280 (void)SvIOK_only_UV(sv);
6281 SvUV_set(sv, SvUVX(sv) - 1);
6284 if (SvIVX(sv) == IV_MIN)
6285 sv_setnv(sv, (NV)IV_MIN - 1.0);
6287 (void)SvIOK_only(sv);
6288 SvIV_set(sv, SvIVX(sv) - 1);
6293 if (flags & SVp_NOK) {
6294 SvNV_set(sv, SvNVX(sv) - 1.0);
6295 (void)SvNOK_only(sv);
6298 if (!(flags & SVp_POK)) {
6299 if ((flags & SVTYPEMASK) < SVt_PVIV)
6300 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6302 (void)SvIOK_only(sv);
6305 #ifdef PERL_PRESERVE_IVUV
6307 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6308 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6309 /* Need to try really hard to see if it's an integer.
6310 9.22337203685478e+18 is an integer.
6311 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6312 so $a="9.22337203685478e+18"; $a+0; $a--
6313 needs to be the same as $a="9.22337203685478e+18"; $a--
6320 /* sv_2iv *should* have made this an NV */
6321 if (flags & SVp_NOK) {
6322 (void)SvNOK_only(sv);
6323 SvNV_set(sv, SvNVX(sv) - 1.0);
6326 /* I don't think we can get here. Maybe I should assert this
6327 And if we do get here I suspect that sv_setnv will croak. NWC
6329 #if defined(USE_LONG_DOUBLE)
6330 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",
6331 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6333 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6334 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6338 #endif /* PERL_PRESERVE_IVUV */
6339 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6343 =for apidoc sv_mortalcopy
6345 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6346 The new SV is marked as mortal. It will be destroyed "soon", either by an
6347 explicit call to FREETMPS, or by an implicit call at places such as
6348 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6353 /* Make a string that will exist for the duration of the expression
6354 * evaluation. Actually, it may have to last longer than that, but
6355 * hopefully we won't free it until it has been assigned to a
6356 * permanent location. */
6359 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6365 sv_setsv(sv,oldstr);
6367 PL_tmps_stack[++PL_tmps_ix] = sv;
6373 =for apidoc sv_newmortal
6375 Creates a new null SV which is mortal. The reference count of the SV is
6376 set to 1. It will be destroyed "soon", either by an explicit call to
6377 FREETMPS, or by an implicit call at places such as statement boundaries.
6378 See also C<sv_mortalcopy> and C<sv_2mortal>.
6384 Perl_sv_newmortal(pTHX)
6390 SvFLAGS(sv) = SVs_TEMP;
6392 PL_tmps_stack[++PL_tmps_ix] = sv;
6397 =for apidoc sv_2mortal
6399 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6400 by an explicit call to FREETMPS, or by an implicit call at places such as
6401 statement boundaries. SvTEMP() is turned on which means that the SV's
6402 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6403 and C<sv_mortalcopy>.
6409 Perl_sv_2mortal(pTHX_ register SV *sv)
6414 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6417 PL_tmps_stack[++PL_tmps_ix] = sv;
6425 Creates a new SV and copies a string into it. The reference count for the
6426 SV is set to 1. If C<len> is zero, Perl will compute the length using
6427 strlen(). For efficiency, consider using C<newSVpvn> instead.
6433 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6439 sv_setpvn(sv,s,len ? len : strlen(s));
6444 =for apidoc newSVpvn
6446 Creates a new SV and copies a string into it. The reference count for the
6447 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6448 string. You are responsible for ensuring that the source string is at least
6449 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6455 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6461 sv_setpvn(sv,s,len);
6467 =for apidoc newSVhek
6469 Creates a new SV from the hash key structure. It will generate scalars that
6470 point to the shared string table where possible. Returns a new (undefined)
6471 SV if the hek is NULL.
6477 Perl_newSVhek(pTHX_ const HEK *hek)
6487 if (HEK_LEN(hek) == HEf_SVKEY) {
6488 return newSVsv(*(SV**)HEK_KEY(hek));
6490 const int flags = HEK_FLAGS(hek);
6491 if (flags & HVhek_WASUTF8) {
6493 Andreas would like keys he put in as utf8 to come back as utf8
6495 STRLEN utf8_len = HEK_LEN(hek);
6496 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6497 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6500 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6502 } else if (flags & HVhek_REHASH) {
6503 /* We don't have a pointer to the hv, so we have to replicate the
6504 flag into every HEK. This hv is using custom a hasing
6505 algorithm. Hence we can't return a shared string scalar, as
6506 that would contain the (wrong) hash value, and might get passed
6507 into an hv routine with a regular hash */
6509 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6514 /* This will be overwhelminly the most common case. */
6515 return newSVpvn_share(HEK_KEY(hek),
6516 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6522 =for apidoc newSVpvn_share
6524 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6525 table. If the string does not already exist in the table, it is created
6526 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6527 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6528 otherwise the hash is computed. The idea here is that as the string table
6529 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6530 hash lookup will avoid string compare.
6536 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6540 bool is_utf8 = FALSE;
6542 STRLEN tmplen = -len;
6544 /* See the note in hv.c:hv_fetch() --jhi */
6545 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6549 PERL_HASH(hash, src, len);
6551 sv_upgrade(sv, SVt_PV);
6552 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6564 #if defined(PERL_IMPLICIT_CONTEXT)
6566 /* pTHX_ magic can't cope with varargs, so this is a no-context
6567 * version of the main function, (which may itself be aliased to us).
6568 * Don't access this version directly.
6572 Perl_newSVpvf_nocontext(const char* pat, ...)
6577 va_start(args, pat);
6578 sv = vnewSVpvf(pat, &args);
6585 =for apidoc newSVpvf
6587 Creates a new SV and initializes it with the string formatted like
6594 Perl_newSVpvf(pTHX_ const char* pat, ...)
6598 va_start(args, pat);
6599 sv = vnewSVpvf(pat, &args);
6604 /* backend for newSVpvf() and newSVpvf_nocontext() */
6607 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6612 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6619 Creates a new SV and copies a floating point value into it.
6620 The reference count for the SV is set to 1.
6626 Perl_newSVnv(pTHX_ NV n)
6639 Creates a new SV and copies an integer into it. The reference count for the
6646 Perl_newSViv(pTHX_ IV i)
6659 Creates a new SV and copies an unsigned integer into it.
6660 The reference count for the SV is set to 1.
6666 Perl_newSVuv(pTHX_ UV u)
6677 =for apidoc newRV_noinc
6679 Creates an RV wrapper for an SV. The reference count for the original
6680 SV is B<not> incremented.
6686 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6692 sv_upgrade(sv, SVt_RV);
6694 SvRV_set(sv, tmpRef);
6699 /* newRV_inc is the official function name to use now.
6700 * newRV_inc is in fact #defined to newRV in sv.h
6704 Perl_newRV(pTHX_ SV *tmpRef)
6707 return newRV_noinc(SvREFCNT_inc(tmpRef));
6713 Creates a new SV which is an exact duplicate of the original SV.
6720 Perl_newSVsv(pTHX_ register SV *old)
6727 if (SvTYPE(old) == SVTYPEMASK) {
6728 if (ckWARN_d(WARN_INTERNAL))
6729 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6733 /* SV_GMAGIC is the default for sv_setv()
6734 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6735 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6736 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6741 =for apidoc sv_reset
6743 Underlying implementation for the C<reset> Perl function.
6744 Note that the perl-level function is vaguely deprecated.
6750 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6753 char todo[PERL_UCHAR_MAX+1];
6758 if (!*s) { /* reset ?? searches */
6759 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6761 PMOP *pm = (PMOP *) mg->mg_obj;
6763 pm->op_pmdynflags &= ~PMdf_USED;
6770 /* reset variables */
6772 if (!HvARRAY(stash))
6775 Zero(todo, 256, char);
6778 I32 i = (unsigned char)*s;
6782 max = (unsigned char)*s++;
6783 for ( ; i <= max; i++) {
6786 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6788 for (entry = HvARRAY(stash)[i];
6790 entry = HeNEXT(entry))
6795 if (!todo[(U8)*HeKEY(entry)])
6797 gv = (GV*)HeVAL(entry);
6800 if (SvTHINKFIRST(sv)) {
6801 if (!SvREADONLY(sv) && SvROK(sv))
6803 /* XXX Is this continue a bug? Why should THINKFIRST
6804 exempt us from resetting arrays and hashes? */
6808 if (SvTYPE(sv) >= SVt_PV) {
6810 if (SvPVX_const(sv) != Nullch)
6818 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6820 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6823 # if defined(USE_ENVIRON_ARRAY)
6826 # endif /* USE_ENVIRON_ARRAY */
6837 Using various gambits, try to get an IO from an SV: the IO slot if its a
6838 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6839 named after the PV if we're a string.
6845 Perl_sv_2io(pTHX_ SV *sv)
6850 switch (SvTYPE(sv)) {
6858 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6862 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6864 return sv_2io(SvRV(sv));
6865 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6871 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6880 Using various gambits, try to get a CV from an SV; in addition, try if
6881 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6882 The flags in C<lref> are passed to sv_fetchsv.
6888 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6895 return *st = NULL, *gvp = Nullgv, Nullcv;
6896 switch (SvTYPE(sv)) {
6915 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6916 tryAMAGICunDEREF(to_cv);
6919 if (SvTYPE(sv) == SVt_PVCV) {
6928 Perl_croak(aTHX_ "Not a subroutine reference");
6933 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6939 /* Some flags to gv_fetchsv mean don't really create the GV */
6940 if (SvTYPE(gv) != SVt_PVGV) {
6946 if (lref && !GvCVu(gv)) {
6950 gv_efullname3(tmpsv, gv, Nullch);
6951 /* XXX this is probably not what they think they're getting.
6952 * It has the same effect as "sub name;", i.e. just a forward
6954 newSUB(start_subparse(FALSE, 0),
6955 newSVOP(OP_CONST, 0, tmpsv),
6960 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6970 Returns true if the SV has a true value by Perl's rules.
6971 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6972 instead use an in-line version.
6978 Perl_sv_true(pTHX_ register SV *sv)
6983 register const XPV* const tXpv = (XPV*)SvANY(sv);
6985 (tXpv->xpv_cur > 1 ||
6986 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6993 return SvIVX(sv) != 0;
6996 return SvNVX(sv) != 0.0;
6998 return sv_2bool(sv);
7004 =for apidoc sv_pvn_force
7006 Get a sensible string out of the SV somehow.
7007 A private implementation of the C<SvPV_force> macro for compilers which
7008 can't cope with complex macro expressions. Always use the macro instead.
7010 =for apidoc sv_pvn_force_flags
7012 Get a sensible string out of the SV somehow.
7013 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7014 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7015 implemented in terms of this function.
7016 You normally want to use the various wrapper macros instead: see
7017 C<SvPV_force> and C<SvPV_force_nomg>
7023 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7026 if (SvTHINKFIRST(sv) && !SvROK(sv))
7027 sv_force_normal_flags(sv, 0);
7037 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7038 const char * const ref = sv_reftype(sv,0);
7040 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7041 ref, OP_NAME(PL_op));
7043 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7045 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7046 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7048 s = sv_2pv_flags(sv, &len, flags);
7052 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7055 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7056 SvGROW(sv, len + 1);
7057 Move(s,SvPVX(sv),len,char);
7062 SvPOK_on(sv); /* validate pointer */
7064 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7065 PTR2UV(sv),SvPVX_const(sv)));
7068 return SvPVX_mutable(sv);
7072 =for apidoc sv_pvbyten_force
7074 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7080 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7082 sv_pvn_force(sv,lp);
7083 sv_utf8_downgrade(sv,0);
7089 =for apidoc sv_pvutf8n_force
7091 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7097 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7099 sv_pvn_force(sv,lp);
7100 sv_utf8_upgrade(sv);
7106 =for apidoc sv_reftype
7108 Returns a string describing what the SV is a reference to.
7114 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7116 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7117 inside return suggests a const propagation bug in g++. */
7118 if (ob && SvOBJECT(sv)) {
7119 char * const name = HvNAME_get(SvSTASH(sv));
7120 return name ? name : (char *) "__ANON__";
7123 switch (SvTYPE(sv)) {
7140 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7141 /* tied lvalues should appear to be
7142 * scalars for backwards compatitbility */
7143 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7144 ? "SCALAR" : "LVALUE");
7145 case SVt_PVAV: return "ARRAY";
7146 case SVt_PVHV: return "HASH";
7147 case SVt_PVCV: return "CODE";
7148 case SVt_PVGV: return "GLOB";
7149 case SVt_PVFM: return "FORMAT";
7150 case SVt_PVIO: return "IO";
7151 default: return "UNKNOWN";
7157 =for apidoc sv_isobject
7159 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7160 object. If the SV is not an RV, or if the object is not blessed, then this
7167 Perl_sv_isobject(pTHX_ SV *sv)
7183 Returns a boolean indicating whether the SV is blessed into the specified
7184 class. This does not check for subtypes; use C<sv_derived_from> to verify
7185 an inheritance relationship.
7191 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7202 hvname = HvNAME_get(SvSTASH(sv));
7206 return strEQ(hvname, name);
7212 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7213 it will be upgraded to one. If C<classname> is non-null then the new SV will
7214 be blessed in the specified package. The new SV is returned and its
7215 reference count is 1.
7221 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7228 SV_CHECK_THINKFIRST_COW_DROP(rv);
7231 if (SvTYPE(rv) >= SVt_PVMG) {
7232 const U32 refcnt = SvREFCNT(rv);
7236 SvREFCNT(rv) = refcnt;
7239 if (SvTYPE(rv) < SVt_RV)
7240 sv_upgrade(rv, SVt_RV);
7241 else if (SvTYPE(rv) > SVt_RV) {
7252 HV* const stash = gv_stashpv(classname, TRUE);
7253 (void)sv_bless(rv, stash);
7259 =for apidoc sv_setref_pv
7261 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7262 argument will be upgraded to an RV. That RV will be modified to point to
7263 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7264 into the SV. The C<classname> argument indicates the package for the
7265 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7266 will have a reference count of 1, and the RV will be returned.
7268 Do not use with other Perl types such as HV, AV, SV, CV, because those
7269 objects will become corrupted by the pointer copy process.
7271 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7277 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7281 sv_setsv(rv, &PL_sv_undef);
7285 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7290 =for apidoc sv_setref_iv
7292 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7293 argument will be upgraded to an RV. That RV will be modified to point to
7294 the new SV. The C<classname> argument indicates the package for the
7295 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7296 will have a reference count of 1, and the RV will be returned.
7302 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7304 sv_setiv(newSVrv(rv,classname), iv);
7309 =for apidoc sv_setref_uv
7311 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7312 argument will be upgraded to an RV. That RV will be modified to point to
7313 the new SV. The C<classname> argument indicates the package for the
7314 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7315 will have a reference count of 1, and the RV will be returned.
7321 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7323 sv_setuv(newSVrv(rv,classname), uv);
7328 =for apidoc sv_setref_nv
7330 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7331 argument will be upgraded to an RV. That RV will be modified to point to
7332 the new SV. The C<classname> argument indicates the package for the
7333 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7334 will have a reference count of 1, and the RV will be returned.
7340 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7342 sv_setnv(newSVrv(rv,classname), nv);
7347 =for apidoc sv_setref_pvn
7349 Copies a string into a new SV, optionally blessing the SV. The length of the
7350 string must be specified with C<n>. The C<rv> argument will be upgraded to
7351 an RV. That RV will be modified to point to the new SV. The C<classname>
7352 argument indicates the package for the blessing. Set C<classname> to
7353 C<Nullch> to avoid the blessing. The new SV will have a reference count
7354 of 1, and the RV will be returned.
7356 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7362 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7364 sv_setpvn(newSVrv(rv,classname), pv, n);
7369 =for apidoc sv_bless
7371 Blesses an SV into a specified package. The SV must be an RV. The package
7372 must be designated by its stash (see C<gv_stashpv()>). The reference count
7373 of the SV is unaffected.
7379 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7384 Perl_croak(aTHX_ "Can't bless non-reference value");
7386 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7387 if (SvREADONLY(tmpRef))
7388 Perl_croak(aTHX_ PL_no_modify);
7389 if (SvOBJECT(tmpRef)) {
7390 if (SvTYPE(tmpRef) != SVt_PVIO)
7392 SvREFCNT_dec(SvSTASH(tmpRef));
7395 SvOBJECT_on(tmpRef);
7396 if (SvTYPE(tmpRef) != SVt_PVIO)
7398 SvUPGRADE(tmpRef, SVt_PVMG);
7399 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7406 if(SvSMAGICAL(tmpRef))
7407 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7415 /* Downgrades a PVGV to a PVMG.
7419 S_sv_unglob(pTHX_ SV *sv)
7424 assert(SvTYPE(sv) == SVt_PVGV);
7429 sv_del_backref((SV*)GvSTASH(sv), sv);
7432 sv_unmagic(sv, PERL_MAGIC_glob);
7433 Safefree(GvNAME(sv));
7436 /* need to keep SvANY(sv) in the right arena */
7437 xpvmg = new_XPVMG();
7438 StructCopy(SvANY(sv), xpvmg, XPVMG);
7439 del_XPVGV(SvANY(sv));
7442 SvFLAGS(sv) &= ~SVTYPEMASK;
7443 SvFLAGS(sv) |= SVt_PVMG;
7447 =for apidoc sv_unref_flags
7449 Unsets the RV status of the SV, and decrements the reference count of
7450 whatever was being referenced by the RV. This can almost be thought of
7451 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7452 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7453 (otherwise the decrementing is conditional on the reference count being
7454 different from one or the reference being a readonly SV).
7461 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7463 SV* const target = SvRV(ref);
7465 if (SvWEAKREF(ref)) {
7466 sv_del_backref(target, ref);
7468 SvRV_set(ref, NULL);
7471 SvRV_set(ref, NULL);
7473 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7474 assigned to as BEGIN {$a = \"Foo"} will fail. */
7475 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7476 SvREFCNT_dec(target);
7477 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7478 sv_2mortal(target); /* Schedule for freeing later */
7482 =for apidoc sv_untaint
7484 Untaint an SV. Use C<SvTAINTED_off> instead.
7489 Perl_sv_untaint(pTHX_ SV *sv)
7491 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7492 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7499 =for apidoc sv_tainted
7501 Test an SV for taintedness. Use C<SvTAINTED> instead.
7506 Perl_sv_tainted(pTHX_ SV *sv)
7508 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7509 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7510 if (mg && (mg->mg_len & 1) )
7517 =for apidoc sv_setpviv
7519 Copies an integer into the given SV, also updating its string value.
7520 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7526 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7528 char buf[TYPE_CHARS(UV)];
7530 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7532 sv_setpvn(sv, ptr, ebuf - ptr);
7536 =for apidoc sv_setpviv_mg
7538 Like C<sv_setpviv>, but also handles 'set' magic.
7544 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7550 #if defined(PERL_IMPLICIT_CONTEXT)
7552 /* pTHX_ magic can't cope with varargs, so this is a no-context
7553 * version of the main function, (which may itself be aliased to us).
7554 * Don't access this version directly.
7558 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7562 va_start(args, pat);
7563 sv_vsetpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
7577 va_start(args, pat);
7578 sv_vsetpvf_mg(sv, pat, &args);
7584 =for apidoc sv_setpvf
7586 Works like C<sv_catpvf> but copies the text into the SV instead of
7587 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7593 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7596 va_start(args, pat);
7597 sv_vsetpvf(sv, pat, &args);
7602 =for apidoc sv_vsetpvf
7604 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7605 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7607 Usually used via its frontend C<sv_setpvf>.
7613 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7615 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7619 =for apidoc sv_setpvf_mg
7621 Like C<sv_setpvf>, but also handles 'set' magic.
7627 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7630 va_start(args, pat);
7631 sv_vsetpvf_mg(sv, pat, &args);
7636 =for apidoc sv_vsetpvf_mg
7638 Like C<sv_vsetpvf>, but also handles 'set' magic.
7640 Usually used via its frontend C<sv_setpvf_mg>.
7646 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7648 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7652 #if defined(PERL_IMPLICIT_CONTEXT)
7654 /* pTHX_ magic can't cope with varargs, so this is a no-context
7655 * version of the main function, (which may itself be aliased to us).
7656 * Don't access this version directly.
7660 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7664 va_start(args, pat);
7665 sv_vcatpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
7679 va_start(args, pat);
7680 sv_vcatpvf_mg(sv, pat, &args);
7686 =for apidoc sv_catpvf
7688 Processes its arguments like C<sprintf> and appends the formatted
7689 output to an SV. If the appended data contains "wide" characters
7690 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7691 and characters >255 formatted with %c), the original SV might get
7692 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7693 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7694 valid UTF-8; if the original SV was bytes, the pattern should be too.
7699 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7702 va_start(args, pat);
7703 sv_vcatpvf(sv, pat, &args);
7708 =for apidoc sv_vcatpvf
7710 Processes its arguments like C<vsprintf> and appends the formatted output
7711 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7713 Usually used via its frontend C<sv_catpvf>.
7719 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7721 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7725 =for apidoc sv_catpvf_mg
7727 Like C<sv_catpvf>, but also handles 'set' magic.
7733 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7736 va_start(args, pat);
7737 sv_vcatpvf_mg(sv, pat, &args);
7742 =for apidoc sv_vcatpvf_mg
7744 Like C<sv_vcatpvf>, but also handles 'set' magic.
7746 Usually used via its frontend C<sv_catpvf_mg>.
7752 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7754 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7759 =for apidoc sv_vsetpvfn
7761 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7764 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7770 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7772 sv_setpvn(sv, "", 0);
7773 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7777 S_expect_number(pTHX_ char** pattern)
7781 switch (**pattern) {
7782 case '1': case '2': case '3':
7783 case '4': case '5': case '6':
7784 case '7': case '8': case '9':
7785 var = *(*pattern)++ - '0';
7786 while (isDIGIT(**pattern)) {
7787 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7789 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7797 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7799 const int neg = nv < 0;
7808 if (uv & 1 && uv == nv)
7809 uv--; /* Round to even */
7811 const unsigned dig = uv % 10;
7824 =for apidoc sv_vcatpvfn
7826 Processes its arguments like C<vsprintf> and appends the formatted output
7827 to an SV. Uses an array of SVs if the C style variable argument list is
7828 missing (NULL). When running with taint checks enabled, indicates via
7829 C<maybe_tainted> if results are untrustworthy (often due to the use of
7832 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7838 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7839 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7840 vec_utf8 = DO_UTF8(vecsv);
7842 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7845 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7853 static const char nullstr[] = "(null)";
7855 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7856 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7858 /* Times 4: a decimal digit takes more than 3 binary digits.
7859 * NV_DIG: mantissa takes than many decimal digits.
7860 * Plus 32: Playing safe. */
7861 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7862 /* large enough for "%#.#f" --chip */
7863 /* what about long double NVs? --jhi */
7865 PERL_UNUSED_ARG(maybe_tainted);
7867 /* no matter what, this is a string now */
7868 (void)SvPV_force(sv, origlen);
7870 /* special-case "", "%s", and "%-p" (SVf - see below) */
7873 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7875 const char * const s = va_arg(*args, char*);
7876 sv_catpv(sv, s ? s : nullstr);
7878 else if (svix < svmax) {
7879 sv_catsv(sv, *svargs);
7883 if (args && patlen == 3 && pat[0] == '%' &&
7884 pat[1] == '-' && pat[2] == 'p') {
7885 argsv = va_arg(*args, SV*);
7886 sv_catsv(sv, argsv);
7890 #ifndef USE_LONG_DOUBLE
7891 /* special-case "%.<number>[gf]" */
7892 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7893 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7894 unsigned digits = 0;
7898 while (*pp >= '0' && *pp <= '9')
7899 digits = 10 * digits + (*pp++ - '0');
7900 if (pp - pat == (int)patlen - 1) {
7908 /* Add check for digits != 0 because it seems that some
7909 gconverts are buggy in this case, and we don't yet have
7910 a Configure test for this. */
7911 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7912 /* 0, point, slack */
7913 Gconvert(nv, (int)digits, 0, ebuf);
7915 if (*ebuf) /* May return an empty string for digits==0 */
7918 } else if (!digits) {
7921 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7922 sv_catpvn(sv, p, l);
7928 #endif /* !USE_LONG_DOUBLE */
7930 if (!args && svix < svmax && DO_UTF8(*svargs))
7933 patend = (char*)pat + patlen;
7934 for (p = (char*)pat; p < patend; p = q) {
7937 bool vectorize = FALSE;
7938 bool vectorarg = FALSE;
7939 bool vec_utf8 = FALSE;
7945 bool has_precis = FALSE;
7947 const I32 osvix = svix;
7948 bool is_utf8 = FALSE; /* is this item utf8? */
7949 #ifdef HAS_LDBL_SPRINTF_BUG
7950 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7951 with sfio - Allen <allens@cpan.org> */
7952 bool fix_ldbl_sprintf_bug = FALSE;
7956 U8 utf8buf[UTF8_MAXBYTES+1];
7957 STRLEN esignlen = 0;
7959 const char *eptr = Nullch;
7962 const U8 *vecstr = Null(U8*);
7969 /* we need a long double target in case HAS_LONG_DOUBLE but
7972 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7980 const char *dotstr = ".";
7981 STRLEN dotstrlen = 1;
7982 I32 efix = 0; /* explicit format parameter index */
7983 I32 ewix = 0; /* explicit width index */
7984 I32 epix = 0; /* explicit precision index */
7985 I32 evix = 0; /* explicit vector index */
7986 bool asterisk = FALSE;
7988 /* echo everything up to the next format specification */
7989 for (q = p; q < patend && *q != '%'; ++q) ;
7991 if (has_utf8 && !pat_utf8)
7992 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7994 sv_catpvn(sv, p, q - p);
8001 We allow format specification elements in this order:
8002 \d+\$ explicit format parameter index
8004 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8005 0 flag (as above): repeated to allow "v02"
8006 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8007 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8009 [%bcdefginopsuxDFOUX] format (mandatory)
8014 As of perl5.9.3, printf format checking is on by default.
8015 Internally, perl uses %p formats to provide an escape to
8016 some extended formatting. This block deals with those
8017 extensions: if it does not match, (char*)q is reset and
8018 the normal format processing code is used.
8020 Currently defined extensions are:
8021 %p include pointer address (standard)
8022 %-p (SVf) include an SV (previously %_)
8023 %-<num>p include an SV with precision <num>
8024 %1p (VDf) include a v-string (as %vd)
8025 %<num>p reserved for future extensions
8027 Robin Barker 2005-07-14
8034 n = expect_number(&q);
8041 argsv = va_arg(*args, SV*);
8042 eptr = SvPVx_const(argsv, elen);
8048 else if (n == vdNUMBER) { /* VDf */
8055 if (ckWARN_d(WARN_INTERNAL))
8056 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8057 "internal %%<num>p might conflict with future printf extensions");
8063 if ( (width = expect_number(&q)) ) {
8104 if ( (ewix = expect_number(&q)) )
8113 if ((vectorarg = asterisk)) {
8126 width = expect_number(&q);
8132 vecsv = va_arg(*args, SV*);
8134 vecsv = (evix > 0 && evix <= svmax)
8135 ? svargs[evix-1] : &PL_sv_undef;
8137 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8139 dotstr = SvPV_const(vecsv, dotstrlen);
8140 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8141 bad with tied or overloaded values that return UTF8. */
8144 else if (has_utf8) {
8145 vecsv = sv_mortalcopy(vecsv);
8146 sv_utf8_upgrade(vecsv);
8147 dotstr = SvPV_const(vecsv, dotstrlen);
8154 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8155 vecsv = svargs[efix ? efix-1 : svix++];
8156 vecstr = (U8*)SvPV_const(vecsv,veclen);
8157 vec_utf8 = DO_UTF8(vecsv);
8159 /* if this is a version object, we need to convert
8160 * back into v-string notation and then let the
8161 * vectorize happen normally
8163 if (sv_derived_from(vecsv, "version")) {
8164 char *version = savesvpv(vecsv);
8165 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8166 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8167 "vector argument not supported with alpha versions");
8170 vecsv = sv_newmortal();
8171 /* scan_vstring is expected to be called during
8172 * tokenization, so we need to fake up the end
8173 * of the buffer for it
8175 PL_bufend = version + veclen;
8176 scan_vstring(version, vecsv);
8177 vecstr = (U8*)SvPV_const(vecsv, veclen);
8178 vec_utf8 = DO_UTF8(vecsv);
8190 i = va_arg(*args, int);
8192 i = (ewix ? ewix <= svmax : svix < svmax) ?
8193 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8195 width = (i < 0) ? -i : i;
8205 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8207 /* XXX: todo, support specified precision parameter */
8211 i = va_arg(*args, int);
8213 i = (ewix ? ewix <= svmax : svix < svmax)
8214 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8215 precis = (i < 0) ? 0 : i;
8220 precis = precis * 10 + (*q++ - '0');
8229 case 'I': /* Ix, I32x, and I64x */
8231 if (q[1] == '6' && q[2] == '4') {
8237 if (q[1] == '3' && q[2] == '2') {
8247 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8258 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8259 if (*(q + 1) == 'l') { /* lld, llf */
8285 if (!vectorize && !args) {
8287 const I32 i = efix-1;
8288 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8290 argsv = (svix >= 0 && svix < svmax)
8291 ? svargs[svix++] : &PL_sv_undef;
8302 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8304 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8306 eptr = (char*)utf8buf;
8307 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8321 eptr = va_arg(*args, char*);
8323 #ifdef MACOS_TRADITIONAL
8324 /* On MacOS, %#s format is used for Pascal strings */
8329 elen = strlen(eptr);
8331 eptr = (char *)nullstr;
8332 elen = sizeof nullstr - 1;
8336 eptr = SvPVx_const(argsv, elen);
8337 if (DO_UTF8(argsv)) {
8338 if (has_precis && precis < elen) {
8340 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8343 if (width) { /* fudge width (can't fudge elen) */
8344 width += elen - sv_len_utf8(argsv);
8351 if (has_precis && elen > precis)
8358 if (alt || vectorize)
8360 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8381 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8390 esignbuf[esignlen++] = plus;
8394 case 'h': iv = (short)va_arg(*args, int); break;
8395 case 'l': iv = va_arg(*args, long); break;
8396 case 'V': iv = va_arg(*args, IV); break;
8397 default: iv = va_arg(*args, int); break;
8399 case 'q': iv = va_arg(*args, Quad_t); break;
8404 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8406 case 'h': iv = (short)tiv; break;
8407 case 'l': iv = (long)tiv; break;
8409 default: iv = tiv; break;
8411 case 'q': iv = (Quad_t)tiv; break;
8415 if ( !vectorize ) /* we already set uv above */
8420 esignbuf[esignlen++] = plus;
8424 esignbuf[esignlen++] = '-';
8467 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8478 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8479 case 'l': uv = va_arg(*args, unsigned long); break;
8480 case 'V': uv = va_arg(*args, UV); break;
8481 default: uv = va_arg(*args, unsigned); break;
8483 case 'q': uv = va_arg(*args, Uquad_t); break;
8488 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8490 case 'h': uv = (unsigned short)tuv; break;
8491 case 'l': uv = (unsigned long)tuv; break;
8493 default: uv = tuv; break;
8495 case 'q': uv = (Uquad_t)tuv; break;
8502 char *ptr = ebuf + sizeof ebuf;
8508 p = (char*)((c == 'X')
8509 ? "0123456789ABCDEF" : "0123456789abcdef");
8515 esignbuf[esignlen++] = '0';
8516 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8524 if (alt && *ptr != '0')
8535 esignbuf[esignlen++] = '0';
8536 esignbuf[esignlen++] = 'b';
8539 default: /* it had better be ten or less */
8543 } while (uv /= base);
8546 elen = (ebuf + sizeof ebuf) - ptr;
8550 zeros = precis - elen;
8551 else if (precis == 0 && elen == 1 && *eptr == '0')
8557 /* FLOATING POINT */
8560 c = 'f'; /* maybe %F isn't supported here */
8568 /* This is evil, but floating point is even more evil */
8570 /* for SV-style calling, we can only get NV
8571 for C-style calling, we assume %f is double;
8572 for simplicity we allow any of %Lf, %llf, %qf for long double
8576 #if defined(USE_LONG_DOUBLE)
8580 /* [perl #20339] - we should accept and ignore %lf rather than die */
8584 #if defined(USE_LONG_DOUBLE)
8585 intsize = args ? 0 : 'q';
8589 #if defined(HAS_LONG_DOUBLE)
8598 /* now we need (long double) if intsize == 'q', else (double) */
8600 #if LONG_DOUBLESIZE > DOUBLESIZE
8602 va_arg(*args, long double) :
8603 va_arg(*args, double)
8605 va_arg(*args, double)
8610 if (c != 'e' && c != 'E') {
8612 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8613 will cast our (long double) to (double) */
8614 (void)Perl_frexp(nv, &i);
8615 if (i == PERL_INT_MIN)
8616 Perl_die(aTHX_ "panic: frexp");
8618 need = BIT_DIGITS(i);
8620 need += has_precis ? precis : 6; /* known default */
8625 #ifdef HAS_LDBL_SPRINTF_BUG
8626 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8627 with sfio - Allen <allens@cpan.org> */
8630 # define MY_DBL_MAX DBL_MAX
8631 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8632 # if DOUBLESIZE >= 8
8633 # define MY_DBL_MAX 1.7976931348623157E+308L
8635 # define MY_DBL_MAX 3.40282347E+38L
8639 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8640 # define MY_DBL_MAX_BUG 1L
8642 # define MY_DBL_MAX_BUG MY_DBL_MAX
8646 # define MY_DBL_MIN DBL_MIN
8647 # else /* XXX guessing! -Allen */
8648 # if DOUBLESIZE >= 8
8649 # define MY_DBL_MIN 2.2250738585072014E-308L
8651 # define MY_DBL_MIN 1.17549435E-38L
8655 if ((intsize == 'q') && (c == 'f') &&
8656 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8658 /* it's going to be short enough that
8659 * long double precision is not needed */
8661 if ((nv <= 0L) && (nv >= -0L))
8662 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8664 /* would use Perl_fp_class as a double-check but not
8665 * functional on IRIX - see perl.h comments */
8667 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8668 /* It's within the range that a double can represent */
8669 #if defined(DBL_MAX) && !defined(DBL_MIN)
8670 if ((nv >= ((long double)1/DBL_MAX)) ||
8671 (nv <= (-(long double)1/DBL_MAX)))
8673 fix_ldbl_sprintf_bug = TRUE;
8676 if (fix_ldbl_sprintf_bug == TRUE) {
8686 # undef MY_DBL_MAX_BUG
8689 #endif /* HAS_LDBL_SPRINTF_BUG */
8691 need += 20; /* fudge factor */
8692 if (PL_efloatsize < need) {
8693 Safefree(PL_efloatbuf);
8694 PL_efloatsize = need + 20; /* more fudge */
8695 Newx(PL_efloatbuf, PL_efloatsize, char);
8696 PL_efloatbuf[0] = '\0';
8699 if ( !(width || left || plus || alt) && fill != '0'
8700 && has_precis && intsize != 'q' ) { /* Shortcuts */
8701 /* See earlier comment about buggy Gconvert when digits,
8703 if ( c == 'g' && precis) {
8704 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8705 /* May return an empty string for digits==0 */
8706 if (*PL_efloatbuf) {
8707 elen = strlen(PL_efloatbuf);
8708 goto float_converted;
8710 } else if ( c == 'f' && !precis) {
8711 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8716 char *ptr = ebuf + sizeof ebuf;
8719 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8720 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8721 if (intsize == 'q') {
8722 /* Copy the one or more characters in a long double
8723 * format before the 'base' ([efgEFG]) character to
8724 * the format string. */
8725 static char const prifldbl[] = PERL_PRIfldbl;
8726 char const *p = prifldbl + sizeof(prifldbl) - 3;
8727 while (p >= prifldbl) { *--ptr = *p--; }
8732 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8737 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8749 /* No taint. Otherwise we are in the strange situation
8750 * where printf() taints but print($float) doesn't.
8752 #if defined(HAS_LONG_DOUBLE)
8753 elen = ((intsize == 'q')
8754 ? my_sprintf(PL_efloatbuf, ptr, nv)
8755 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8757 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8761 eptr = PL_efloatbuf;
8769 i = SvCUR(sv) - origlen;
8772 case 'h': *(va_arg(*args, short*)) = i; break;
8773 default: *(va_arg(*args, int*)) = i; break;
8774 case 'l': *(va_arg(*args, long*)) = i; break;
8775 case 'V': *(va_arg(*args, IV*)) = i; break;
8777 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8782 sv_setuv_mg(argsv, (UV)i);
8783 continue; /* not "break" */
8790 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8791 && ckWARN(WARN_PRINTF))
8793 SV * const msg = sv_newmortal();
8794 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8795 (PL_op->op_type == OP_PRTF) ? "" : "s");
8798 Perl_sv_catpvf(aTHX_ msg,
8799 "\"%%%c\"", c & 0xFF);
8801 Perl_sv_catpvf(aTHX_ msg,
8802 "\"%%\\%03"UVof"\"",
8805 sv_catpvs(msg, "end of string");
8806 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8809 /* output mangled stuff ... */
8815 /* ... right here, because formatting flags should not apply */
8816 SvGROW(sv, SvCUR(sv) + elen + 1);
8818 Copy(eptr, p, elen, char);
8821 SvCUR_set(sv, p - SvPVX_const(sv));
8823 continue; /* not "break" */
8826 /* calculate width before utf8_upgrade changes it */
8827 have = esignlen + zeros + elen;
8829 Perl_croak_nocontext(PL_memory_wrap);
8831 if (is_utf8 != has_utf8) {
8834 sv_utf8_upgrade(sv);
8837 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8838 sv_utf8_upgrade(nsv);
8839 eptr = SvPVX_const(nsv);
8842 SvGROW(sv, SvCUR(sv) + elen + 1);
8847 need = (have > width ? have : width);
8850 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8851 Perl_croak_nocontext(PL_memory_wrap);
8852 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8854 if (esignlen && fill == '0') {
8856 for (i = 0; i < (int)esignlen; i++)
8860 memset(p, fill, gap);
8863 if (esignlen && fill != '0') {
8865 for (i = 0; i < (int)esignlen; i++)
8870 for (i = zeros; i; i--)
8874 Copy(eptr, p, elen, char);
8878 memset(p, ' ', gap);
8883 Copy(dotstr, p, dotstrlen, char);
8887 vectorize = FALSE; /* done iterating over vecstr */
8894 SvCUR_set(sv, p - SvPVX_const(sv));
8902 /* =========================================================================
8904 =head1 Cloning an interpreter
8906 All the macros and functions in this section are for the private use of
8907 the main function, perl_clone().
8909 The foo_dup() functions make an exact copy of an existing foo thinngy.
8910 During the course of a cloning, a hash table is used to map old addresses
8911 to new addresses. The table is created and manipulated with the
8912 ptr_table_* functions.
8916 ============================================================================*/
8919 #if defined(USE_ITHREADS)
8921 #ifndef GpREFCNT_inc
8922 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8926 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8927 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8928 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8929 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8930 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8931 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8932 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8933 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8934 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8935 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8936 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8937 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8938 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8941 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8942 regcomp.c. AMS 20010712 */
8945 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8950 struct reg_substr_datum *s;
8953 return (REGEXP *)NULL;
8955 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8958 len = r->offsets[0];
8959 npar = r->nparens+1;
8961 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8962 Copy(r->program, ret->program, len+1, regnode);
8964 Newx(ret->startp, npar, I32);
8965 Copy(r->startp, ret->startp, npar, I32);
8966 Newx(ret->endp, npar, I32);
8967 Copy(r->startp, ret->startp, npar, I32);
8969 Newx(ret->substrs, 1, struct reg_substr_data);
8970 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8971 s->min_offset = r->substrs->data[i].min_offset;
8972 s->max_offset = r->substrs->data[i].max_offset;
8973 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8974 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8977 ret->regstclass = NULL;
8980 const int count = r->data->count;
8983 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8984 char, struct reg_data);
8985 Newx(d->what, count, U8);
8988 for (i = 0; i < count; i++) {
8989 d->what[i] = r->data->what[i];
8990 switch (d->what[i]) {
8991 /* legal options are one of: sfpont
8992 see also regcomp.h and pregfree() */
8994 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8997 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9000 /* This is cheating. */
9001 Newx(d->data[i], 1, struct regnode_charclass_class);
9002 StructCopy(r->data->data[i], d->data[i],
9003 struct regnode_charclass_class);
9004 ret->regstclass = (regnode*)d->data[i];
9007 /* Compiled op trees are readonly, and can thus be
9008 shared without duplication. */
9010 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9014 d->data[i] = r->data->data[i];
9017 d->data[i] = r->data->data[i];
9019 ((reg_trie_data*)d->data[i])->refcount++;
9023 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9032 Newx(ret->offsets, 2*len+1, U32);
9033 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9035 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9036 ret->refcnt = r->refcnt;
9037 ret->minlen = r->minlen;
9038 ret->prelen = r->prelen;
9039 ret->nparens = r->nparens;
9040 ret->lastparen = r->lastparen;
9041 ret->lastcloseparen = r->lastcloseparen;
9042 ret->reganch = r->reganch;
9044 ret->sublen = r->sublen;
9046 if (RX_MATCH_COPIED(ret))
9047 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9049 ret->subbeg = Nullch;
9050 #ifdef PERL_OLD_COPY_ON_WRITE
9051 ret->saved_copy = Nullsv;
9054 ptr_table_store(PL_ptr_table, r, ret);
9058 /* duplicate a file handle */
9061 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9065 PERL_UNUSED_ARG(type);
9068 return (PerlIO*)NULL;
9070 /* look for it in the table first */
9071 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9075 /* create anew and remember what it is */
9076 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9077 ptr_table_store(PL_ptr_table, fp, ret);
9081 /* duplicate a directory handle */
9084 Perl_dirp_dup(pTHX_ DIR *dp)
9092 /* duplicate a typeglob */
9095 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9100 /* look for it in the table first */
9101 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9105 /* create anew and remember what it is */
9107 ptr_table_store(PL_ptr_table, gp, ret);
9110 ret->gp_refcnt = 0; /* must be before any other dups! */
9111 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9112 ret->gp_io = io_dup_inc(gp->gp_io, param);
9113 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9114 ret->gp_av = av_dup_inc(gp->gp_av, param);
9115 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9116 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9117 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9118 ret->gp_cvgen = gp->gp_cvgen;
9119 ret->gp_line = gp->gp_line;
9120 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9124 /* duplicate a chain of magic */
9127 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9129 MAGIC *mgprev = (MAGIC*)NULL;
9132 return (MAGIC*)NULL;
9133 /* look for it in the table first */
9134 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9138 for (; mg; mg = mg->mg_moremagic) {
9140 Newxz(nmg, 1, MAGIC);
9142 mgprev->mg_moremagic = nmg;
9145 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9146 nmg->mg_private = mg->mg_private;
9147 nmg->mg_type = mg->mg_type;
9148 nmg->mg_flags = mg->mg_flags;
9149 if (mg->mg_type == PERL_MAGIC_qr) {
9150 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9152 else if(mg->mg_type == PERL_MAGIC_backref) {
9153 /* The backref AV has its reference count deliberately bumped by
9155 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9157 else if (mg->mg_type == PERL_MAGIC_symtab) {
9158 nmg->mg_obj = mg->mg_obj;
9161 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9162 ? sv_dup_inc(mg->mg_obj, param)
9163 : sv_dup(mg->mg_obj, param);
9165 nmg->mg_len = mg->mg_len;
9166 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9167 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9168 if (mg->mg_len > 0) {
9169 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9170 if (mg->mg_type == PERL_MAGIC_overload_table &&
9171 AMT_AMAGIC((AMT*)mg->mg_ptr))
9173 const AMT * const amtp = (AMT*)mg->mg_ptr;
9174 AMT * const namtp = (AMT*)nmg->mg_ptr;
9176 for (i = 1; i < NofAMmeth; i++) {
9177 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9181 else if (mg->mg_len == HEf_SVKEY)
9182 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9184 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9185 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9192 /* create a new pointer-mapping table */
9195 Perl_ptr_table_new(pTHX)
9198 Newxz(tbl, 1, PTR_TBL_t);
9201 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9205 #define PTR_TABLE_HASH(ptr) \
9206 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9209 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9210 following define) and at call to new_body_inline made below in
9211 Perl_ptr_table_store()
9214 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9216 /* map an existing pointer using a table */
9218 STATIC PTR_TBL_ENT_t *
9219 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9220 PTR_TBL_ENT_t *tblent;
9221 const UV hash = PTR_TABLE_HASH(sv);
9223 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9224 for (; tblent; tblent = tblent->next) {
9225 if (tblent->oldval == sv)
9232 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9234 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9235 return tblent ? tblent->newval : (void *) 0;
9238 /* add a new entry to a pointer-mapping table */
9241 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9243 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9246 tblent->newval = newsv;
9248 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9250 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9251 tblent->oldval = oldsv;
9252 tblent->newval = newsv;
9253 tblent->next = tbl->tbl_ary[entry];
9254 tbl->tbl_ary[entry] = tblent;
9256 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9257 ptr_table_split(tbl);
9261 /* double the hash bucket size of an existing ptr table */
9264 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9266 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9267 const UV oldsize = tbl->tbl_max + 1;
9268 UV newsize = oldsize * 2;
9271 Renew(ary, newsize, PTR_TBL_ENT_t*);
9272 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9273 tbl->tbl_max = --newsize;
9275 for (i=0; i < oldsize; i++, ary++) {
9276 PTR_TBL_ENT_t **curentp, **entp, *ent;
9279 curentp = ary + oldsize;
9280 for (entp = ary, ent = *ary; ent; ent = *entp) {
9281 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9283 ent->next = *curentp;
9293 /* remove all the entries from a ptr table */
9296 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9298 if (tbl && tbl->tbl_items) {
9299 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9300 UV riter = tbl->tbl_max;
9303 PTR_TBL_ENT_t *entry = array[riter];
9306 PTR_TBL_ENT_t * const oentry = entry;
9307 entry = entry->next;
9316 /* clear and free a ptr table */
9319 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9324 ptr_table_clear(tbl);
9325 Safefree(tbl->tbl_ary);
9331 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9334 SvRV_set(dstr, SvWEAKREF(sstr)
9335 ? sv_dup(SvRV(sstr), param)
9336 : sv_dup_inc(SvRV(sstr), param));
9339 else if (SvPVX_const(sstr)) {
9340 /* Has something there */
9342 /* Normal PV - clone whole allocated space */
9343 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9344 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9345 /* Not that normal - actually sstr is copy on write.
9346 But we are a true, independant SV, so: */
9347 SvREADONLY_off(dstr);
9352 /* Special case - not normally malloced for some reason */
9353 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9354 /* A "shared" PV - clone it as "shared" PV */
9356 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9360 /* Some other special case - random pointer */
9361 SvPV_set(dstr, SvPVX(sstr));
9367 if (SvTYPE(dstr) == SVt_RV)
9368 SvRV_set(dstr, NULL);
9370 SvPV_set(dstr, NULL);
9374 /* duplicate an SV of any type (including AV, HV etc) */
9377 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9382 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9384 /* look for it in the table first */
9385 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9389 if(param->flags & CLONEf_JOIN_IN) {
9390 /** We are joining here so we don't want do clone
9391 something that is bad **/
9392 if (SvTYPE(sstr) == SVt_PVHV) {
9393 const char * const hvname = HvNAME_get(sstr);
9395 /** don't clone stashes if they already exist **/
9396 return (SV*)gv_stashpv(hvname,0);
9400 /* create anew and remember what it is */
9403 #ifdef DEBUG_LEAKING_SCALARS
9404 dstr->sv_debug_optype = sstr->sv_debug_optype;
9405 dstr->sv_debug_line = sstr->sv_debug_line;
9406 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9407 dstr->sv_debug_cloned = 1;
9408 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9411 ptr_table_store(PL_ptr_table, sstr, dstr);
9414 SvFLAGS(dstr) = SvFLAGS(sstr);
9415 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9416 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9419 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9420 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9421 PL_watch_pvx, SvPVX_const(sstr));
9424 /* don't clone objects whose class has asked us not to */
9425 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9426 SvFLAGS(dstr) &= ~SVTYPEMASK;
9431 switch (SvTYPE(sstr)) {
9436 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9437 SvIV_set(dstr, SvIVX(sstr));
9440 SvANY(dstr) = new_XNV();
9441 SvNV_set(dstr, SvNVX(sstr));
9444 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9445 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9449 /* These are all the types that need complex bodies allocating. */
9451 const svtype sv_type = SvTYPE(sstr);
9452 const struct body_details *const sv_type_details
9453 = bodies_by_type + sv_type;
9457 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9462 if (GvUNIQUE((GV*)sstr)) {
9463 /* Do sharing here, and fall through */
9476 assert(sv_type_details->size);
9477 if (sv_type_details->arena) {
9478 new_body_inline(new_body, sv_type_details->size, sv_type);
9480 = (void*)((char*)new_body - sv_type_details->offset);
9482 new_body = new_NOARENA(sv_type_details);
9486 SvANY(dstr) = new_body;
9489 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9490 ((char*)SvANY(dstr)) + sv_type_details->offset,
9491 sv_type_details->copy, char);
9493 Copy(((char*)SvANY(sstr)),
9494 ((char*)SvANY(dstr)),
9495 sv_type_details->size + sv_type_details->offset, char);
9498 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9499 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9501 /* The Copy above means that all the source (unduplicated) pointers
9502 are now in the destination. We can check the flags and the
9503 pointers in either, but it's possible that there's less cache
9504 missing by always going for the destination.
9505 FIXME - instrument and check that assumption */
9506 if (sv_type >= SVt_PVMG) {
9508 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9510 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9513 /* The cast silences a GCC warning about unhandled types. */
9514 switch ((int)sv_type) {
9526 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9527 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9528 LvTARG(dstr) = dstr;
9529 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9530 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9532 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9535 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9536 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9537 /* Don't call sv_add_backref here as it's going to be created
9538 as part of the magic cloning of the symbol table. */
9539 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9540 (void)GpREFCNT_inc(GvGP(dstr));
9543 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9544 if (IoOFP(dstr) == IoIFP(sstr))
9545 IoOFP(dstr) = IoIFP(dstr);
9547 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9548 /* PL_rsfp_filters entries have fake IoDIRP() */
9549 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9550 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9551 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9552 /* I have no idea why fake dirp (rsfps)
9553 should be treated differently but otherwise
9554 we end up with leaks -- sky*/
9555 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9556 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9557 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9559 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9560 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9561 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9563 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9564 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9565 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9568 if (AvARRAY((AV*)sstr)) {
9569 SV **dst_ary, **src_ary;
9570 SSize_t items = AvFILLp((AV*)sstr) + 1;
9572 src_ary = AvARRAY((AV*)sstr);
9573 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9574 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9575 SvPV_set(dstr, (char*)dst_ary);
9576 AvALLOC((AV*)dstr) = dst_ary;
9577 if (AvREAL((AV*)sstr)) {
9579 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9583 *dst_ary++ = sv_dup(*src_ary++, param);
9585 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9586 while (items-- > 0) {
9587 *dst_ary++ = &PL_sv_undef;
9591 SvPV_set(dstr, Nullch);
9592 AvALLOC((AV*)dstr) = (SV**)NULL;
9599 if (HvARRAY((HV*)sstr)) {
9601 const bool sharekeys = !!HvSHAREKEYS(sstr);
9602 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9603 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9605 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9606 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9608 HvARRAY(dstr) = (HE**)darray;
9609 while (i <= sxhv->xhv_max) {
9610 const HE *source = HvARRAY(sstr)[i];
9611 HvARRAY(dstr)[i] = source
9612 ? he_dup(source, sharekeys, param) : 0;
9616 struct xpvhv_aux * const saux = HvAUX(sstr);
9617 struct xpvhv_aux * const daux = HvAUX(dstr);
9618 /* This flag isn't copied. */
9619 /* SvOOK_on(hv) attacks the IV flags. */
9620 SvFLAGS(dstr) |= SVf_OOK;
9622 hvname = saux->xhv_name;
9624 = hvname ? hek_dup(hvname, param) : hvname;
9626 daux->xhv_riter = saux->xhv_riter;
9627 daux->xhv_eiter = saux->xhv_eiter
9628 ? he_dup(saux->xhv_eiter,
9629 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9630 daux->xhv_backreferences = saux->xhv_backreferences
9631 ? (AV*) SvREFCNT_inc(
9639 SvPV_set(dstr, Nullch);
9641 /* Record stashes for possible cloning in Perl_clone(). */
9643 av_push(param->stashes, dstr);
9648 /* NOTE: not refcounted */
9649 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9651 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9653 if (CvCONST(dstr)) {
9654 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9655 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9656 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9658 /* don't dup if copying back - CvGV isn't refcounted, so the
9659 * duped GV may never be freed. A bit of a hack! DAPM */
9660 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9661 Nullgv : gv_dup(CvGV(dstr), param) ;
9662 if (!(param->flags & CLONEf_COPY_STACKS)) {
9665 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9668 ? cv_dup( CvOUTSIDE(dstr), param)
9669 : cv_dup_inc(CvOUTSIDE(dstr), param);
9671 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9677 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9683 /* duplicate a context */
9686 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9691 return (PERL_CONTEXT*)NULL;
9693 /* look for it in the table first */
9694 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9698 /* create anew and remember what it is */
9699 Newxz(ncxs, max + 1, PERL_CONTEXT);
9700 ptr_table_store(PL_ptr_table, cxs, ncxs);
9703 PERL_CONTEXT * const cx = &cxs[ix];
9704 PERL_CONTEXT * const ncx = &ncxs[ix];
9705 ncx->cx_type = cx->cx_type;
9706 if (CxTYPE(cx) == CXt_SUBST) {
9707 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9710 ncx->blk_oldsp = cx->blk_oldsp;
9711 ncx->blk_oldcop = cx->blk_oldcop;
9712 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9713 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9714 ncx->blk_oldpm = cx->blk_oldpm;
9715 ncx->blk_gimme = cx->blk_gimme;
9716 switch (CxTYPE(cx)) {
9718 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9719 ? cv_dup_inc(cx->blk_sub.cv, param)
9720 : cv_dup(cx->blk_sub.cv,param));
9721 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9722 ? av_dup_inc(cx->blk_sub.argarray, param)
9724 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9725 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9726 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9727 ncx->blk_sub.lval = cx->blk_sub.lval;
9728 ncx->blk_sub.retop = cx->blk_sub.retop;
9731 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9732 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9733 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9734 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9735 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9736 ncx->blk_eval.retop = cx->blk_eval.retop;
9739 ncx->blk_loop.label = cx->blk_loop.label;
9740 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9741 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9742 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9743 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9744 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9745 ? cx->blk_loop.iterdata
9746 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9747 ncx->blk_loop.oldcomppad
9748 = (PAD*)ptr_table_fetch(PL_ptr_table,
9749 cx->blk_loop.oldcomppad);
9750 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9751 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9752 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9753 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9754 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9757 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9758 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9759 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9760 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9761 ncx->blk_sub.retop = cx->blk_sub.retop;
9773 /* duplicate a stack info structure */
9776 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9781 return (PERL_SI*)NULL;
9783 /* look for it in the table first */
9784 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9788 /* create anew and remember what it is */
9789 Newxz(nsi, 1, PERL_SI);
9790 ptr_table_store(PL_ptr_table, si, nsi);
9792 nsi->si_stack = av_dup_inc(si->si_stack, param);
9793 nsi->si_cxix = si->si_cxix;
9794 nsi->si_cxmax = si->si_cxmax;
9795 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9796 nsi->si_type = si->si_type;
9797 nsi->si_prev = si_dup(si->si_prev, param);
9798 nsi->si_next = si_dup(si->si_next, param);
9799 nsi->si_markoff = si->si_markoff;
9804 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9805 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9806 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9807 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9808 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9809 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9810 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9811 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9812 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9813 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9814 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9815 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9816 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9817 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9820 #define pv_dup_inc(p) SAVEPV(p)
9821 #define pv_dup(p) SAVEPV(p)
9822 #define svp_dup_inc(p,pp) any_dup(p,pp)
9824 /* map any object to the new equivent - either something in the
9825 * ptr table, or something in the interpreter structure
9829 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9836 /* look for it in the table first */
9837 ret = ptr_table_fetch(PL_ptr_table, v);
9841 /* see if it is part of the interpreter structure */
9842 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9843 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9851 /* duplicate the save stack */
9854 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9856 ANY * const ss = proto_perl->Tsavestack;
9857 const I32 max = proto_perl->Tsavestack_max;
9858 I32 ix = proto_perl->Tsavestack_ix;
9870 void (*dptr) (void*);
9871 void (*dxptr) (pTHX_ void*);
9873 Newxz(nss, max, ANY);
9876 I32 i = POPINT(ss,ix);
9879 case SAVEt_ITEM: /* normal string */
9880 sv = (SV*)POPPTR(ss,ix);
9881 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9882 sv = (SV*)POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9885 case SAVEt_SV: /* scalar reference */
9886 sv = (SV*)POPPTR(ss,ix);
9887 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9888 gv = (GV*)POPPTR(ss,ix);
9889 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9891 case SAVEt_GENERIC_PVREF: /* generic char* */
9892 c = (char*)POPPTR(ss,ix);
9893 TOPPTR(nss,ix) = pv_dup(c);
9894 ptr = POPPTR(ss,ix);
9895 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9897 case SAVEt_SHARED_PVREF: /* char* in shared space */
9898 c = (char*)POPPTR(ss,ix);
9899 TOPPTR(nss,ix) = savesharedpv(c);
9900 ptr = POPPTR(ss,ix);
9901 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9903 case SAVEt_GENERIC_SVREF: /* generic sv */
9904 case SAVEt_SVREF: /* scalar reference */
9905 sv = (SV*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9907 ptr = POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9910 case SAVEt_AV: /* array reference */
9911 av = (AV*)POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = av_dup_inc(av, param);
9913 gv = (GV*)POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = gv_dup(gv, param);
9916 case SAVEt_HV: /* hash reference */
9917 hv = (HV*)POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9919 gv = (GV*)POPPTR(ss,ix);
9920 TOPPTR(nss,ix) = gv_dup(gv, param);
9922 case SAVEt_INT: /* int reference */
9923 ptr = POPPTR(ss,ix);
9924 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9925 intval = (int)POPINT(ss,ix);
9926 TOPINT(nss,ix) = intval;
9928 case SAVEt_LONG: /* long reference */
9929 ptr = POPPTR(ss,ix);
9930 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9931 longval = (long)POPLONG(ss,ix);
9932 TOPLONG(nss,ix) = longval;
9934 case SAVEt_I32: /* I32 reference */
9935 case SAVEt_I16: /* I16 reference */
9936 case SAVEt_I8: /* I8 reference */
9937 ptr = POPPTR(ss,ix);
9938 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9942 case SAVEt_IV: /* IV reference */
9943 ptr = POPPTR(ss,ix);
9944 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9948 case SAVEt_SPTR: /* SV* reference */
9949 ptr = POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9951 sv = (SV*)POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = sv_dup(sv, param);
9954 case SAVEt_VPTR: /* random* reference */
9955 ptr = POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9957 ptr = POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9960 case SAVEt_PPTR: /* char* reference */
9961 ptr = POPPTR(ss,ix);
9962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9963 c = (char*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = pv_dup(c);
9966 case SAVEt_HPTR: /* HV* reference */
9967 ptr = POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9969 hv = (HV*)POPPTR(ss,ix);
9970 TOPPTR(nss,ix) = hv_dup(hv, param);
9972 case SAVEt_APTR: /* AV* reference */
9973 ptr = POPPTR(ss,ix);
9974 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9975 av = (AV*)POPPTR(ss,ix);
9976 TOPPTR(nss,ix) = av_dup(av, param);
9979 gv = (GV*)POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = gv_dup(gv, param);
9982 case SAVEt_GP: /* scalar reference */
9983 gp = (GP*)POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9985 (void)GpREFCNT_inc(gp);
9986 gv = (GV*)POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9988 c = (char*)POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = pv_dup(c);
9996 case SAVEt_MORTALIZESV:
9997 sv = (SV*)POPPTR(ss,ix);
9998 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10001 ptr = POPPTR(ss,ix);
10002 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10003 /* these are assumed to be refcounted properly */
10005 switch (((OP*)ptr)->op_type) {
10007 case OP_LEAVESUBLV:
10011 case OP_LEAVEWRITE:
10012 TOPPTR(nss,ix) = ptr;
10017 TOPPTR(nss,ix) = Nullop;
10022 TOPPTR(nss,ix) = Nullop;
10025 c = (char*)POPPTR(ss,ix);
10026 TOPPTR(nss,ix) = pv_dup_inc(c);
10028 case SAVEt_CLEARSV:
10029 longval = POPLONG(ss,ix);
10030 TOPLONG(nss,ix) = longval;
10033 hv = (HV*)POPPTR(ss,ix);
10034 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10035 c = (char*)POPPTR(ss,ix);
10036 TOPPTR(nss,ix) = pv_dup_inc(c);
10038 TOPINT(nss,ix) = i;
10040 case SAVEt_DESTRUCTOR:
10041 ptr = POPPTR(ss,ix);
10042 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10043 dptr = POPDPTR(ss,ix);
10044 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10045 any_dup(FPTR2DPTR(void *, dptr),
10048 case SAVEt_DESTRUCTOR_X:
10049 ptr = POPPTR(ss,ix);
10050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10051 dxptr = POPDXPTR(ss,ix);
10052 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10053 any_dup(FPTR2DPTR(void *, dxptr),
10056 case SAVEt_REGCONTEXT:
10059 TOPINT(nss,ix) = i;
10062 case SAVEt_STACK_POS: /* Position on Perl stack */
10064 TOPINT(nss,ix) = i;
10066 case SAVEt_AELEM: /* array element */
10067 sv = (SV*)POPPTR(ss,ix);
10068 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10070 TOPINT(nss,ix) = i;
10071 av = (AV*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = av_dup_inc(av, param);
10074 case SAVEt_HELEM: /* hash element */
10075 sv = (SV*)POPPTR(ss,ix);
10076 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10077 sv = (SV*)POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10079 hv = (HV*)POPPTR(ss,ix);
10080 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10083 ptr = POPPTR(ss,ix);
10084 TOPPTR(nss,ix) = ptr;
10088 TOPINT(nss,ix) = i;
10090 case SAVEt_COMPPAD:
10091 av = (AV*)POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = av_dup(av, param);
10095 longval = (long)POPLONG(ss,ix);
10096 TOPLONG(nss,ix) = longval;
10097 ptr = POPPTR(ss,ix);
10098 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10099 sv = (SV*)POPPTR(ss,ix);
10100 TOPPTR(nss,ix) = sv_dup(sv, param);
10103 ptr = POPPTR(ss,ix);
10104 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10105 longval = (long)POPBOOL(ss,ix);
10106 TOPBOOL(nss,ix) = (bool)longval;
10108 case SAVEt_SET_SVFLAGS:
10110 TOPINT(nss,ix) = i;
10112 TOPINT(nss,ix) = i;
10113 sv = (SV*)POPPTR(ss,ix);
10114 TOPPTR(nss,ix) = sv_dup(sv, param);
10117 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10125 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10126 * flag to the result. This is done for each stash before cloning starts,
10127 * so we know which stashes want their objects cloned */
10130 do_mark_cloneable_stash(pTHX_ SV *sv)
10132 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10134 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10135 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10136 if (cloner && GvCV(cloner)) {
10143 XPUSHs(sv_2mortal(newSVhek(hvname)));
10145 call_sv((SV*)GvCV(cloner), G_SCALAR);
10152 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10160 =for apidoc perl_clone
10162 Create and return a new interpreter by cloning the current one.
10164 perl_clone takes these flags as parameters:
10166 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10167 without it we only clone the data and zero the stacks,
10168 with it we copy the stacks and the new perl interpreter is
10169 ready to run at the exact same point as the previous one.
10170 The pseudo-fork code uses COPY_STACKS while the
10171 threads->new doesn't.
10173 CLONEf_KEEP_PTR_TABLE
10174 perl_clone keeps a ptr_table with the pointer of the old
10175 variable as a key and the new variable as a value,
10176 this allows it to check if something has been cloned and not
10177 clone it again but rather just use the value and increase the
10178 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10179 the ptr_table using the function
10180 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10181 reason to keep it around is if you want to dup some of your own
10182 variable who are outside the graph perl scans, example of this
10183 code is in threads.xs create
10186 This is a win32 thing, it is ignored on unix, it tells perls
10187 win32host code (which is c++) to clone itself, this is needed on
10188 win32 if you want to run two threads at the same time,
10189 if you just want to do some stuff in a separate perl interpreter
10190 and then throw it away and return to the original one,
10191 you don't need to do anything.
10196 /* XXX the above needs expanding by someone who actually understands it ! */
10197 EXTERN_C PerlInterpreter *
10198 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10201 perl_clone(PerlInterpreter *proto_perl, UV flags)
10204 #ifdef PERL_IMPLICIT_SYS
10206 /* perlhost.h so we need to call into it
10207 to clone the host, CPerlHost should have a c interface, sky */
10209 if (flags & CLONEf_CLONE_HOST) {
10210 return perl_clone_host(proto_perl,flags);
10212 return perl_clone_using(proto_perl, flags,
10214 proto_perl->IMemShared,
10215 proto_perl->IMemParse,
10217 proto_perl->IStdIO,
10221 proto_perl->IProc);
10225 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10226 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10227 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10228 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10229 struct IPerlDir* ipD, struct IPerlSock* ipS,
10230 struct IPerlProc* ipP)
10232 /* XXX many of the string copies here can be optimized if they're
10233 * constants; they need to be allocated as common memory and just
10234 * their pointers copied. */
10237 CLONE_PARAMS clone_params;
10238 CLONE_PARAMS* param = &clone_params;
10240 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10241 /* for each stash, determine whether its objects should be cloned */
10242 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10243 PERL_SET_THX(my_perl);
10246 Poison(my_perl, 1, PerlInterpreter);
10248 PL_curcop = (COP *)Nullop;
10252 PL_savestack_ix = 0;
10253 PL_savestack_max = -1;
10254 PL_sig_pending = 0;
10255 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10256 # else /* !DEBUGGING */
10257 Zero(my_perl, 1, PerlInterpreter);
10258 # endif /* DEBUGGING */
10260 /* host pointers */
10262 PL_MemShared = ipMS;
10263 PL_MemParse = ipMP;
10270 #else /* !PERL_IMPLICIT_SYS */
10272 CLONE_PARAMS clone_params;
10273 CLONE_PARAMS* param = &clone_params;
10274 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10275 /* for each stash, determine whether its objects should be cloned */
10276 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10277 PERL_SET_THX(my_perl);
10280 Poison(my_perl, 1, PerlInterpreter);
10282 PL_curcop = (COP *)Nullop;
10286 PL_savestack_ix = 0;
10287 PL_savestack_max = -1;
10288 PL_sig_pending = 0;
10289 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10290 # else /* !DEBUGGING */
10291 Zero(my_perl, 1, PerlInterpreter);
10292 # endif /* DEBUGGING */
10293 #endif /* PERL_IMPLICIT_SYS */
10294 param->flags = flags;
10295 param->proto_perl = proto_perl;
10297 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10298 Zero(&PL_body_roots, 1, PL_body_roots);
10300 PL_nice_chunk = NULL;
10301 PL_nice_chunk_size = 0;
10303 PL_sv_objcount = 0;
10304 PL_sv_root = Nullsv;
10305 PL_sv_arenaroot = Nullsv;
10307 PL_debug = proto_perl->Idebug;
10309 PL_hash_seed = proto_perl->Ihash_seed;
10310 PL_rehash_seed = proto_perl->Irehash_seed;
10312 #ifdef USE_REENTRANT_API
10313 /* XXX: things like -Dm will segfault here in perlio, but doing
10314 * PERL_SET_CONTEXT(proto_perl);
10315 * breaks too many other things
10317 Perl_reentrant_init(aTHX);
10320 /* create SV map for pointer relocation */
10321 PL_ptr_table = ptr_table_new();
10323 /* initialize these special pointers as early as possible */
10324 SvANY(&PL_sv_undef) = NULL;
10325 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10326 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10327 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10329 SvANY(&PL_sv_no) = new_XPVNV();
10330 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10331 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10332 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10333 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10334 SvCUR_set(&PL_sv_no, 0);
10335 SvLEN_set(&PL_sv_no, 1);
10336 SvIV_set(&PL_sv_no, 0);
10337 SvNV_set(&PL_sv_no, 0);
10338 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10340 SvANY(&PL_sv_yes) = new_XPVNV();
10341 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10342 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10343 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10344 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10345 SvCUR_set(&PL_sv_yes, 1);
10346 SvLEN_set(&PL_sv_yes, 2);
10347 SvIV_set(&PL_sv_yes, 1);
10348 SvNV_set(&PL_sv_yes, 1);
10349 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10351 /* create (a non-shared!) shared string table */
10352 PL_strtab = newHV();
10353 HvSHAREKEYS_off(PL_strtab);
10354 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10355 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10357 PL_compiling = proto_perl->Icompiling;
10359 /* These two PVs will be free'd special way so must set them same way op.c does */
10360 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10361 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10363 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10364 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10366 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10367 if (!specialWARN(PL_compiling.cop_warnings))
10368 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10369 if (!specialCopIO(PL_compiling.cop_io))
10370 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10371 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10373 /* pseudo environmental stuff */
10374 PL_origargc = proto_perl->Iorigargc;
10375 PL_origargv = proto_perl->Iorigargv;
10377 param->stashes = newAV(); /* Setup array of objects to call clone on */
10379 /* Set tainting stuff before PerlIO_debug can possibly get called */
10380 PL_tainting = proto_perl->Itainting;
10381 PL_taint_warn = proto_perl->Itaint_warn;
10383 #ifdef PERLIO_LAYERS
10384 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10385 PerlIO_clone(aTHX_ proto_perl, param);
10388 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10389 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10390 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10391 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10392 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10393 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10396 PL_minus_c = proto_perl->Iminus_c;
10397 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10398 PL_localpatches = proto_perl->Ilocalpatches;
10399 PL_splitstr = proto_perl->Isplitstr;
10400 PL_preprocess = proto_perl->Ipreprocess;
10401 PL_minus_n = proto_perl->Iminus_n;
10402 PL_minus_p = proto_perl->Iminus_p;
10403 PL_minus_l = proto_perl->Iminus_l;
10404 PL_minus_a = proto_perl->Iminus_a;
10405 PL_minus_E = proto_perl->Iminus_E;
10406 PL_minus_F = proto_perl->Iminus_F;
10407 PL_doswitches = proto_perl->Idoswitches;
10408 PL_dowarn = proto_perl->Idowarn;
10409 PL_doextract = proto_perl->Idoextract;
10410 PL_sawampersand = proto_perl->Isawampersand;
10411 PL_unsafe = proto_perl->Iunsafe;
10412 PL_inplace = SAVEPV(proto_perl->Iinplace);
10413 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10414 PL_perldb = proto_perl->Iperldb;
10415 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10416 PL_exit_flags = proto_perl->Iexit_flags;
10418 /* magical thingies */
10419 /* XXX time(&PL_basetime) when asked for? */
10420 PL_basetime = proto_perl->Ibasetime;
10421 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10423 PL_maxsysfd = proto_perl->Imaxsysfd;
10424 PL_multiline = proto_perl->Imultiline;
10425 PL_statusvalue = proto_perl->Istatusvalue;
10427 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10429 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10431 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10433 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10434 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10435 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10437 /* Clone the regex array */
10438 PL_regex_padav = newAV();
10440 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10441 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10443 av_push(PL_regex_padav,
10444 sv_dup_inc(regexen[0],param));
10445 for(i = 1; i <= len; i++) {
10446 const SV * const regex = regexen[i];
10449 ? sv_dup_inc(regex, param)
10451 newSViv(PTR2IV(re_dup(
10452 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10454 av_push(PL_regex_padav, sv);
10457 PL_regex_pad = AvARRAY(PL_regex_padav);
10459 /* shortcuts to various I/O objects */
10460 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10461 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10462 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10463 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10464 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10465 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10467 /* shortcuts to regexp stuff */
10468 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10470 /* shortcuts to misc objects */
10471 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10473 /* shortcuts to debugging objects */
10474 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10475 PL_DBline = gv_dup(proto_perl->IDBline, param);
10476 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10477 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10478 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10479 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10480 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10481 PL_lineary = av_dup(proto_perl->Ilineary, param);
10482 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10484 /* symbol tables */
10485 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10486 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10487 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10488 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10489 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10491 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10492 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10493 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10494 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10495 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10496 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10498 PL_sub_generation = proto_perl->Isub_generation;
10500 /* funky return mechanisms */
10501 PL_forkprocess = proto_perl->Iforkprocess;
10503 /* subprocess state */
10504 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10506 /* internal state */
10507 PL_maxo = proto_perl->Imaxo;
10508 if (proto_perl->Iop_mask)
10509 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10511 PL_op_mask = Nullch;
10512 /* PL_asserting = proto_perl->Iasserting; */
10514 /* current interpreter roots */
10515 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10516 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10517 PL_main_start = proto_perl->Imain_start;
10518 PL_eval_root = proto_perl->Ieval_root;
10519 PL_eval_start = proto_perl->Ieval_start;
10521 /* runtime control stuff */
10522 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10523 PL_copline = proto_perl->Icopline;
10525 PL_filemode = proto_perl->Ifilemode;
10526 PL_lastfd = proto_perl->Ilastfd;
10527 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10530 PL_gensym = proto_perl->Igensym;
10531 PL_preambled = proto_perl->Ipreambled;
10532 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10533 PL_laststatval = proto_perl->Ilaststatval;
10534 PL_laststype = proto_perl->Ilaststype;
10535 PL_mess_sv = Nullsv;
10537 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10539 /* interpreter atexit processing */
10540 PL_exitlistlen = proto_perl->Iexitlistlen;
10541 if (PL_exitlistlen) {
10542 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10543 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10546 PL_exitlist = (PerlExitListEntry*)NULL;
10548 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10549 if (PL_my_cxt_size) {
10550 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10551 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10554 PL_my_cxt_list = (void**)NULL;
10555 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10556 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10557 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10559 PL_profiledata = NULL;
10560 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10561 /* PL_rsfp_filters entries have fake IoDIRP() */
10562 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10564 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10566 PAD_CLONE_VARS(proto_perl, param);
10568 #ifdef HAVE_INTERP_INTERN
10569 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10572 /* more statics moved here */
10573 PL_generation = proto_perl->Igeneration;
10574 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10576 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10577 PL_in_clean_all = proto_perl->Iin_clean_all;
10579 PL_uid = proto_perl->Iuid;
10580 PL_euid = proto_perl->Ieuid;
10581 PL_gid = proto_perl->Igid;
10582 PL_egid = proto_perl->Iegid;
10583 PL_nomemok = proto_perl->Inomemok;
10584 PL_an = proto_perl->Ian;
10585 PL_evalseq = proto_perl->Ievalseq;
10586 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10587 PL_origalen = proto_perl->Iorigalen;
10588 #ifdef PERL_USES_PL_PIDSTATUS
10589 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10591 PL_osname = SAVEPV(proto_perl->Iosname);
10592 PL_sighandlerp = proto_perl->Isighandlerp;
10594 PL_runops = proto_perl->Irunops;
10596 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10599 PL_cshlen = proto_perl->Icshlen;
10600 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10603 PL_lex_state = proto_perl->Ilex_state;
10604 PL_lex_defer = proto_perl->Ilex_defer;
10605 PL_lex_expect = proto_perl->Ilex_expect;
10606 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10607 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10608 PL_lex_starts = proto_perl->Ilex_starts;
10609 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10610 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10611 PL_lex_op = proto_perl->Ilex_op;
10612 PL_lex_inpat = proto_perl->Ilex_inpat;
10613 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10614 PL_lex_brackets = proto_perl->Ilex_brackets;
10615 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10616 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10617 PL_lex_casemods = proto_perl->Ilex_casemods;
10618 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10619 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10621 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10622 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10623 PL_nexttoke = proto_perl->Inexttoke;
10625 /* XXX This is probably masking the deeper issue of why
10626 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10627 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10628 * (A little debugging with a watchpoint on it may help.)
10630 if (SvANY(proto_perl->Ilinestr)) {
10631 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10632 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10633 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10634 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10635 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10636 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10637 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10638 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10639 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10642 PL_linestr = newSV(79);
10643 sv_upgrade(PL_linestr,SVt_PVIV);
10644 sv_setpvn(PL_linestr,"",0);
10645 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10647 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10648 PL_pending_ident = proto_perl->Ipending_ident;
10649 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10651 PL_expect = proto_perl->Iexpect;
10653 PL_multi_start = proto_perl->Imulti_start;
10654 PL_multi_end = proto_perl->Imulti_end;
10655 PL_multi_open = proto_perl->Imulti_open;
10656 PL_multi_close = proto_perl->Imulti_close;
10658 PL_error_count = proto_perl->Ierror_count;
10659 PL_subline = proto_perl->Isubline;
10660 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10662 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10663 if (SvANY(proto_perl->Ilinestr)) {
10664 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10665 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10666 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10667 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10668 PL_last_lop_op = proto_perl->Ilast_lop_op;
10671 PL_last_uni = SvPVX(PL_linestr);
10672 PL_last_lop = SvPVX(PL_linestr);
10673 PL_last_lop_op = 0;
10675 PL_in_my = proto_perl->Iin_my;
10676 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10678 PL_cryptseen = proto_perl->Icryptseen;
10681 PL_hints = proto_perl->Ihints;
10683 PL_amagic_generation = proto_perl->Iamagic_generation;
10685 #ifdef USE_LOCALE_COLLATE
10686 PL_collation_ix = proto_perl->Icollation_ix;
10687 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10688 PL_collation_standard = proto_perl->Icollation_standard;
10689 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10690 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10691 #endif /* USE_LOCALE_COLLATE */
10693 #ifdef USE_LOCALE_NUMERIC
10694 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10695 PL_numeric_standard = proto_perl->Inumeric_standard;
10696 PL_numeric_local = proto_perl->Inumeric_local;
10697 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10698 #endif /* !USE_LOCALE_NUMERIC */
10700 /* utf8 character classes */
10701 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10702 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10703 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10704 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10705 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10706 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10707 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10708 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10709 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10710 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10711 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10712 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10713 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10714 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10715 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10716 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10717 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10718 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10719 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10720 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10722 /* Did the locale setup indicate UTF-8? */
10723 PL_utf8locale = proto_perl->Iutf8locale;
10724 /* Unicode features (see perlrun/-C) */
10725 PL_unicode = proto_perl->Iunicode;
10727 /* Pre-5.8 signals control */
10728 PL_signals = proto_perl->Isignals;
10730 /* times() ticks per second */
10731 PL_clocktick = proto_perl->Iclocktick;
10733 /* Recursion stopper for PerlIO_find_layer */
10734 PL_in_load_module = proto_perl->Iin_load_module;
10736 /* sort() routine */
10737 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10739 /* Not really needed/useful since the reenrant_retint is "volatile",
10740 * but do it for consistency's sake. */
10741 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10743 /* Hooks to shared SVs and locks. */
10744 PL_sharehook = proto_perl->Isharehook;
10745 PL_lockhook = proto_perl->Ilockhook;
10746 PL_unlockhook = proto_perl->Iunlockhook;
10747 PL_threadhook = proto_perl->Ithreadhook;
10749 PL_runops_std = proto_perl->Irunops_std;
10750 PL_runops_dbg = proto_perl->Irunops_dbg;
10752 #ifdef THREADS_HAVE_PIDS
10753 PL_ppid = proto_perl->Ippid;
10757 PL_last_swash_hv = NULL; /* reinits on demand */
10758 PL_last_swash_klen = 0;
10759 PL_last_swash_key[0]= '\0';
10760 PL_last_swash_tmps = (U8*)NULL;
10761 PL_last_swash_slen = 0;
10763 PL_glob_index = proto_perl->Iglob_index;
10764 PL_srand_called = proto_perl->Isrand_called;
10765 PL_uudmap['M'] = 0; /* reinits on demand */
10766 PL_bitcount = Nullch; /* reinits on demand */
10768 if (proto_perl->Ipsig_pend) {
10769 Newxz(PL_psig_pend, SIG_SIZE, int);
10772 PL_psig_pend = (int*)NULL;
10775 if (proto_perl->Ipsig_ptr) {
10776 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10777 Newxz(PL_psig_name, SIG_SIZE, SV*);
10778 for (i = 1; i < SIG_SIZE; i++) {
10779 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10780 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10784 PL_psig_ptr = (SV**)NULL;
10785 PL_psig_name = (SV**)NULL;
10788 /* thrdvar.h stuff */
10790 if (flags & CLONEf_COPY_STACKS) {
10791 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10792 PL_tmps_ix = proto_perl->Ttmps_ix;
10793 PL_tmps_max = proto_perl->Ttmps_max;
10794 PL_tmps_floor = proto_perl->Ttmps_floor;
10795 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10797 while (i <= PL_tmps_ix) {
10798 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10802 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10803 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10804 Newxz(PL_markstack, i, I32);
10805 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10806 - proto_perl->Tmarkstack);
10807 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10808 - proto_perl->Tmarkstack);
10809 Copy(proto_perl->Tmarkstack, PL_markstack,
10810 PL_markstack_ptr - PL_markstack + 1, I32);
10812 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10813 * NOTE: unlike the others! */
10814 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10815 PL_scopestack_max = proto_perl->Tscopestack_max;
10816 Newxz(PL_scopestack, PL_scopestack_max, I32);
10817 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10819 /* NOTE: si_dup() looks at PL_markstack */
10820 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10822 /* PL_curstack = PL_curstackinfo->si_stack; */
10823 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10824 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10826 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10827 PL_stack_base = AvARRAY(PL_curstack);
10828 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10829 - proto_perl->Tstack_base);
10830 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10832 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10833 * NOTE: unlike the others! */
10834 PL_savestack_ix = proto_perl->Tsavestack_ix;
10835 PL_savestack_max = proto_perl->Tsavestack_max;
10836 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10837 PL_savestack = ss_dup(proto_perl, param);
10841 ENTER; /* perl_destruct() wants to LEAVE; */
10843 /* although we're not duplicating the tmps stack, we should still
10844 * add entries for any SVs on the tmps stack that got cloned by a
10845 * non-refcount means (eg a temp in @_); otherwise they will be
10848 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10849 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10850 proto_perl->Ttmps_stack[i]);
10851 if (nsv && !SvREFCNT(nsv)) {
10853 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10858 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10859 PL_top_env = &PL_start_env;
10861 PL_op = proto_perl->Top;
10864 PL_Xpv = (XPV*)NULL;
10865 PL_na = proto_perl->Tna;
10867 PL_statbuf = proto_perl->Tstatbuf;
10868 PL_statcache = proto_perl->Tstatcache;
10869 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10870 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10872 PL_timesbuf = proto_perl->Ttimesbuf;
10875 PL_tainted = proto_perl->Ttainted;
10876 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10877 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10878 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10879 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10880 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10881 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10882 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10883 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10884 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10886 PL_restartop = proto_perl->Trestartop;
10887 PL_in_eval = proto_perl->Tin_eval;
10888 PL_delaymagic = proto_perl->Tdelaymagic;
10889 PL_dirty = proto_perl->Tdirty;
10890 PL_localizing = proto_perl->Tlocalizing;
10892 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10893 PL_hv_fetch_ent_mh = Nullhe;
10894 PL_modcount = proto_perl->Tmodcount;
10895 PL_lastgotoprobe = Nullop;
10896 PL_dumpindent = proto_perl->Tdumpindent;
10898 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10899 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10900 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10901 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10902 PL_efloatbuf = Nullch; /* reinits on demand */
10903 PL_efloatsize = 0; /* reinits on demand */
10907 PL_screamfirst = NULL;
10908 PL_screamnext = NULL;
10909 PL_maxscream = -1; /* reinits on demand */
10910 PL_lastscream = Nullsv;
10912 PL_watchaddr = NULL;
10913 PL_watchok = Nullch;
10915 PL_regdummy = proto_perl->Tregdummy;
10916 PL_regprecomp = Nullch;
10919 PL_colorset = 0; /* reinits PL_colors[] */
10920 /*PL_colors[6] = {0,0,0,0,0,0};*/
10921 PL_reginput = Nullch;
10922 PL_regbol = Nullch;
10923 PL_regeol = Nullch;
10924 PL_regstartp = (I32*)NULL;
10925 PL_regendp = (I32*)NULL;
10926 PL_reglastparen = (U32*)NULL;
10927 PL_reglastcloseparen = (U32*)NULL;
10928 PL_regtill = Nullch;
10929 PL_reg_start_tmp = (char**)NULL;
10930 PL_reg_start_tmpl = 0;
10931 PL_regdata = (struct reg_data*)NULL;
10934 PL_reg_eval_set = 0;
10936 PL_regprogram = (regnode*)NULL;
10938 PL_regcc = (CURCUR*)NULL;
10939 PL_reg_call_cc = (struct re_cc_state*)NULL;
10940 PL_reg_re = (regexp*)NULL;
10941 PL_reg_ganch = Nullch;
10942 PL_reg_sv = Nullsv;
10943 PL_reg_match_utf8 = FALSE;
10944 PL_reg_magic = (MAGIC*)NULL;
10946 PL_reg_oldcurpm = (PMOP*)NULL;
10947 PL_reg_curpm = (PMOP*)NULL;
10948 PL_reg_oldsaved = Nullch;
10949 PL_reg_oldsavedlen = 0;
10950 #ifdef PERL_OLD_COPY_ON_WRITE
10953 PL_reg_maxiter = 0;
10954 PL_reg_leftiter = 0;
10955 PL_reg_poscache = Nullch;
10956 PL_reg_poscache_size= 0;
10958 /* RE engine - function pointers */
10959 PL_regcompp = proto_perl->Tregcompp;
10960 PL_regexecp = proto_perl->Tregexecp;
10961 PL_regint_start = proto_perl->Tregint_start;
10962 PL_regint_string = proto_perl->Tregint_string;
10963 PL_regfree = proto_perl->Tregfree;
10965 PL_reginterp_cnt = 0;
10966 PL_reg_starttry = 0;
10968 /* Pluggable optimizer */
10969 PL_peepp = proto_perl->Tpeepp;
10971 PL_stashcache = newHV();
10973 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10974 ptr_table_free(PL_ptr_table);
10975 PL_ptr_table = NULL;
10978 /* Call the ->CLONE method, if it exists, for each of the stashes
10979 identified by sv_dup() above.
10981 while(av_len(param->stashes) != -1) {
10982 HV* const stash = (HV*) av_shift(param->stashes);
10983 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10984 if (cloner && GvCV(cloner)) {
10989 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10991 call_sv((SV*)GvCV(cloner), G_DISCARD);
10997 SvREFCNT_dec(param->stashes);
10999 /* orphaned? eg threads->new inside BEGIN or use */
11000 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11001 (void)SvREFCNT_inc(PL_compcv);
11002 SAVEFREESV(PL_compcv);
11008 #endif /* USE_ITHREADS */
11011 =head1 Unicode Support
11013 =for apidoc sv_recode_to_utf8
11015 The encoding is assumed to be an Encode object, on entry the PV
11016 of the sv is assumed to be octets in that encoding, and the sv
11017 will be converted into Unicode (and UTF-8).
11019 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11020 is not a reference, nothing is done to the sv. If the encoding is not
11021 an C<Encode::XS> Encoding object, bad things will happen.
11022 (See F<lib/encoding.pm> and L<Encode>).
11024 The PV of the sv is returned.
11029 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11032 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11046 Passing sv_yes is wrong - it needs to be or'ed set of constants
11047 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11048 remove converted chars from source.
11050 Both will default the value - let them.
11052 XPUSHs(&PL_sv_yes);
11055 call_method("decode", G_SCALAR);
11059 s = SvPV_const(uni, len);
11060 if (s != SvPVX_const(sv)) {
11061 SvGROW(sv, len + 1);
11062 Move(s, SvPVX(sv), len + 1, char);
11063 SvCUR_set(sv, len);
11070 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11074 =for apidoc sv_cat_decode
11076 The encoding is assumed to be an Encode object, the PV of the ssv is
11077 assumed to be octets in that encoding and decoding the input starts
11078 from the position which (PV + *offset) pointed to. The dsv will be
11079 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11080 when the string tstr appears in decoding output or the input ends on
11081 the PV of the ssv. The value which the offset points will be modified
11082 to the last input position on the ssv.
11084 Returns TRUE if the terminator was found, else returns FALSE.
11089 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11090 SV *ssv, int *offset, char *tstr, int tlen)
11094 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11105 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11106 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11108 call_method("cat_decode", G_SCALAR);
11110 ret = SvTRUE(TOPs);
11111 *offset = SvIV(offsv);
11117 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11122 /* ---------------------------------------------------------------------
11124 * support functions for report_uninit()
11127 /* the maxiumum size of array or hash where we will scan looking
11128 * for the undefined element that triggered the warning */
11130 #define FUV_MAX_SEARCH_SIZE 1000
11132 /* Look for an entry in the hash whose value has the same SV as val;
11133 * If so, return a mortal copy of the key. */
11136 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11139 register HE **array;
11142 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11143 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11146 array = HvARRAY(hv);
11148 for (i=HvMAX(hv); i>0; i--) {
11149 register HE *entry;
11150 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11151 if (HeVAL(entry) != val)
11153 if ( HeVAL(entry) == &PL_sv_undef ||
11154 HeVAL(entry) == &PL_sv_placeholder)
11158 if (HeKLEN(entry) == HEf_SVKEY)
11159 return sv_mortalcopy(HeKEY_sv(entry));
11160 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11166 /* Look for an entry in the array whose value has the same SV as val;
11167 * If so, return the index, otherwise return -1. */
11170 S_find_array_subscript(pTHX_ AV *av, SV* val)
11175 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11176 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11180 for (i=AvFILLp(av); i>=0; i--) {
11181 if (svp[i] == val && svp[i] != &PL_sv_undef)
11187 /* S_varname(): return the name of a variable, optionally with a subscript.
11188 * If gv is non-zero, use the name of that global, along with gvtype (one
11189 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11190 * targ. Depending on the value of the subscript_type flag, return:
11193 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11194 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11195 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11196 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11199 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11200 SV* keyname, I32 aindex, int subscript_type)
11203 SV * const name = sv_newmortal();
11206 buffer[0] = gvtype;
11209 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11211 gv_fullname4(name, gv, buffer, 0);
11213 if ((unsigned int)SvPVX(name)[1] <= 26) {
11215 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11217 /* Swap the 1 unprintable control character for the 2 byte pretty
11218 version - ie substr($name, 1, 1) = $buffer; */
11219 sv_insert(name, 1, 1, buffer, 2);
11224 CV * const cv = find_runcv(&unused);
11228 if (!cv || !CvPADLIST(cv))
11230 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11231 sv = *av_fetch(av, targ, FALSE);
11232 /* SvLEN in a pad name is not to be trusted */
11233 sv_setpv(name, SvPV_nolen_const(sv));
11236 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11237 SV * const sv = newSV(0);
11238 *SvPVX(name) = '$';
11239 Perl_sv_catpvf(aTHX_ name, "{%s}",
11240 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11243 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11244 *SvPVX(name) = '$';
11245 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11247 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11248 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11255 =for apidoc find_uninit_var
11257 Find the name of the undefined variable (if any) that caused the operator o
11258 to issue a "Use of uninitialized value" warning.
11259 If match is true, only return a name if it's value matches uninit_sv.
11260 So roughly speaking, if a unary operator (such as OP_COS) generates a
11261 warning, then following the direct child of the op may yield an
11262 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11263 other hand, with OP_ADD there are two branches to follow, so we only print
11264 the variable name if we get an exact match.
11266 The name is returned as a mortal SV.
11268 Assumes that PL_op is the op that originally triggered the error, and that
11269 PL_comppad/PL_curpad points to the currently executing pad.
11275 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11283 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11284 uninit_sv == &PL_sv_placeholder)))
11287 switch (obase->op_type) {
11294 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11295 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11297 SV *keysv = Nullsv;
11298 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11300 if (pad) { /* @lex, %lex */
11301 sv = PAD_SVl(obase->op_targ);
11305 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11306 /* @global, %global */
11307 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11310 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11312 else /* @{expr}, %{expr} */
11313 return find_uninit_var(cUNOPx(obase)->op_first,
11317 /* attempt to find a match within the aggregate */
11319 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11321 subscript_type = FUV_SUBSCRIPT_HASH;
11324 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11326 subscript_type = FUV_SUBSCRIPT_ARRAY;
11329 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11332 return varname(gv, hash ? '%' : '@', obase->op_targ,
11333 keysv, index, subscript_type);
11337 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11339 return varname(Nullgv, '$', obase->op_targ,
11340 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11343 gv = cGVOPx_gv(obase);
11344 if (!gv || (match && GvSV(gv) != uninit_sv))
11346 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11349 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11352 av = (AV*)PAD_SV(obase->op_targ);
11353 if (!av || SvRMAGICAL(av))
11355 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11356 if (!svp || *svp != uninit_sv)
11359 return varname(Nullgv, '$', obase->op_targ,
11360 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11363 gv = cGVOPx_gv(obase);
11369 if (!av || SvRMAGICAL(av))
11371 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11372 if (!svp || *svp != uninit_sv)
11375 return varname(gv, '$', 0,
11376 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11381 o = cUNOPx(obase)->op_first;
11382 if (!o || o->op_type != OP_NULL ||
11383 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11385 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11389 if (PL_op == obase)
11390 /* $a[uninit_expr] or $h{uninit_expr} */
11391 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11394 o = cBINOPx(obase)->op_first;
11395 kid = cBINOPx(obase)->op_last;
11397 /* get the av or hv, and optionally the gv */
11399 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11400 sv = PAD_SV(o->op_targ);
11402 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11403 && cUNOPo->op_first->op_type == OP_GV)
11405 gv = cGVOPx_gv(cUNOPo->op_first);
11408 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11413 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11414 /* index is constant */
11418 if (obase->op_type == OP_HELEM) {
11419 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11420 if (!he || HeVAL(he) != uninit_sv)
11424 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11425 if (!svp || *svp != uninit_sv)
11429 if (obase->op_type == OP_HELEM)
11430 return varname(gv, '%', o->op_targ,
11431 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11433 return varname(gv, '@', o->op_targ, Nullsv,
11434 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11437 /* index is an expression;
11438 * attempt to find a match within the aggregate */
11439 if (obase->op_type == OP_HELEM) {
11440 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11442 return varname(gv, '%', o->op_targ,
11443 keysv, 0, FUV_SUBSCRIPT_HASH);
11446 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11448 return varname(gv, '@', o->op_targ,
11449 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11454 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11456 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11462 /* only examine RHS */
11463 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11466 o = cUNOPx(obase)->op_first;
11467 if (o->op_type == OP_PUSHMARK)
11470 if (!o->op_sibling) {
11471 /* one-arg version of open is highly magical */
11473 if (o->op_type == OP_GV) { /* open FOO; */
11475 if (match && GvSV(gv) != uninit_sv)
11477 return varname(gv, '$', 0,
11478 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11480 /* other possibilities not handled are:
11481 * open $x; or open my $x; should return '${*$x}'
11482 * open expr; should return '$'.expr ideally
11488 /* ops where $_ may be an implicit arg */
11492 if ( !(obase->op_flags & OPf_STACKED)) {
11493 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11494 ? PAD_SVl(obase->op_targ)
11497 sv = sv_newmortal();
11498 sv_setpvn(sv, "$_", 2);
11506 /* skip filehandle as it can't produce 'undef' warning */
11507 o = cUNOPx(obase)->op_first;
11508 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11509 o = o->op_sibling->op_sibling;
11516 match = 1; /* XS or custom code could trigger random warnings */
11521 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11522 return sv_2mortal(newSVpvs("${$/}"));
11527 if (!(obase->op_flags & OPf_KIDS))
11529 o = cUNOPx(obase)->op_first;
11535 /* if all except one arg are constant, or have no side-effects,
11536 * or are optimized away, then it's unambiguous */
11538 for (kid=o; kid; kid = kid->op_sibling) {
11540 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11541 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11542 || (kid->op_type == OP_PUSHMARK)
11546 if (o2) { /* more than one found */
11553 return find_uninit_var(o2, uninit_sv, match);
11555 /* scan all args */
11557 sv = find_uninit_var(o, uninit_sv, 1);
11569 =for apidoc report_uninit
11571 Print appropriate "Use of uninitialized variable" warning
11577 Perl_report_uninit(pTHX_ SV* uninit_sv)
11581 SV* varname = Nullsv;
11583 varname = find_uninit_var(PL_op, uninit_sv,0);
11585 sv_insert(varname, 0, 0, " ", 1);
11587 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11588 varname ? SvPV_nolen_const(varname) : "",
11589 " in ", OP_DESC(PL_op));
11592 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11598 * c-indentation-style: bsd
11599 * c-basic-offset: 4
11600 * indent-tabs-mode: t
11603 * ex: set ts=8 sts=4 sw=4 noet: