3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = Nullch;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 S_free_arena(pTHX_ void **root) {
562 void ** const next = *(void **)root;
569 =for apidoc sv_free_arenas
571 Deallocate the memory used by all arenas. Note that all the individual SV
572 heads and bodies within the arenas must already have been freed.
576 #define free_arena(name) \
578 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
579 PL_ ## name ## _arenaroot = 0; \
580 PL_ ## name ## _root = 0; \
584 Perl_sv_free_arenas(pTHX)
591 /* Free arenas here, but be careful about fake ones. (We assume
592 contiguity of the fake ones with the corresponding real ones.) */
594 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
595 svanext = (SV*) SvANY(sva);
596 while (svanext && SvFAKE(svanext))
597 svanext = (SV*) SvANY(svanext);
603 for (i=0; i<SVt_LAST; i++) {
604 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
605 PL_body_arenaroots[i] = 0;
606 PL_body_roots[i] = 0;
609 Safefree(PL_nice_chunk);
610 PL_nice_chunk = Nullch;
611 PL_nice_chunk_size = 0;
617 Here are mid-level routines that manage the allocation of bodies out
618 of the various arenas. There are 5 kinds of arenas:
620 1. SV-head arenas, which are discussed and handled above
621 2. regular body arenas
622 3. arenas for reduced-size bodies
624 5. pte arenas (thread related)
626 Arena types 2 & 3 are chained by body-type off an array of
627 arena-root pointers, which is indexed by svtype. Some of the
628 larger/less used body types are malloced singly, since a large
629 unused block of them is wasteful. Also, several svtypes dont have
630 bodies; the data fits into the sv-head itself. The arena-root
631 pointer thus has a few unused root-pointers (which may be hijacked
632 later for arena types 4,5)
634 3 differs from 2 as an optimization; some body types have several
635 unused fields in the front of the structure (which are kept in-place
636 for consistency). These bodies can be allocated in smaller chunks,
637 because the leading fields arent accessed. Pointers to such bodies
638 are decremented to point at the unused 'ghost' memory, knowing that
639 the pointers are used with offsets to the real memory.
641 HE, HEK arenas are managed separately, with separate code, but may
642 be merge-able later..
644 PTE arenas are not sv-bodies, but they share these mid-level
645 mechanics, so are considered here. The new mid-level mechanics rely
646 on the sv_type of the body being allocated, so we just reserve one
647 of the unused body-slots for PTEs, then use it in those (2) PTE
648 contexts below (line ~10k)
652 S_more_bodies (pTHX_ size_t size, svtype sv_type)
655 void ** const arena_root = &PL_body_arenaroots[sv_type];
656 void ** const root = &PL_body_roots[sv_type];
659 const size_t count = PERL_ARENA_SIZE / size;
661 Newx(start, count*size, char);
662 *((void **) start) = *arena_root;
663 *arena_root = (void *)start;
665 end = start + (count-1) * size;
667 /* The initial slot is used to link the arenas together, so it isn't to be
668 linked into the list of ready-to-use bodies. */
672 *root = (void *)start;
674 while (start < end) {
675 char * const next = start + size;
676 *(void**) start = (void *)next;
684 /* grab a new thing from the free list, allocating more if necessary */
686 /* 1st, the inline version */
688 #define new_body_inline(xpv, size, sv_type) \
690 void ** const r3wt = &PL_body_roots[sv_type]; \
692 xpv = *((void **)(r3wt)) \
693 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
694 *(r3wt) = *(void**)(xpv); \
698 /* now use the inline version in the proper function */
702 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
703 compilers issue warnings. */
706 S_new_body(pTHX_ size_t size, svtype sv_type)
710 new_body_inline(xpv, size, sv_type);
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 Revisiting type 3 arenas, there are 4 body-types which have some
729 members that are never accessed. They are XPV, XPVIV, XPVAV,
730 XPVHV, which have corresponding types: xpv_allocated,
731 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by
736 the size of the bit not allocated, so it's as if we allocated the
737 full structure. (But things will all go boom if you write to the
738 part that is "not there", because you'll be overwriting the last
739 members of the preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For example, if
742 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
743 and the pointer is unchanged. If the allocated structure is smaller (no
744 initial NV actually allocated) then the net effect is to subtract the size
745 of the NV from the pointer, to return a new pointer as if an initial NV were
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at the
750 start of the structure. IV bodies don't need it either, because they are
751 no longer allocated. */
753 /* The following 2 arrays hide the above details in a pair of
754 lookup-tables, allowing us to be body-type agnostic.
756 size maps svtype to its body's allocated size.
757 offset maps svtype to the body-pointer adjustment needed
759 NB: elements in latter are 0 or <0, and are added during
760 allocation, and subtracted during deallocation. It may be clearer
761 to invert the values, and call it shrinkage_by_svtype.
764 struct body_details {
765 size_t size; /* Size to allocate */
766 size_t copy; /* Size of structure to copy (may be shorter) */
768 bool cant_upgrade; /* Can upgrade this type */
769 bool zero_nv; /* zero the NV when upgrading from this */
770 bool arena; /* Allocated from an arena */
777 /* With -DPURFIY we allocate everything directly, and don't use arenas.
778 This seems a rather elegant way to simplify some of the code below. */
779 #define HASARENA FALSE
781 #define HASARENA TRUE
783 #define NOARENA FALSE
785 /* A macro to work out the offset needed to subtract from a pointer to (say)
792 to make its members accessible via a pointer to (say)
802 #define relative_STRUCT_OFFSET(longer, shorter, member) \
803 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
805 /* Calculate the length to copy. Specifically work out the length less any
806 final padding the compiler needed to add. See the comment in sv_upgrade
807 for why copying the padding proved to be a bug. */
809 #define copy_length(type, last_member) \
810 STRUCT_OFFSET(type, last_member) \
811 + sizeof (((type*)SvANY((SV*)0))->last_member)
813 static const struct body_details bodies_by_type[] = {
814 {0, 0, 0, FALSE, NONV, NOARENA},
815 /* IVs are in the head, so the allocation size is 0 */
816 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
817 /* 8 bytes on most ILP32 with IEEE doubles */
818 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
819 /* RVs are in the head now */
820 /* However, this slot is overloaded and used by the pte */
821 {0, 0, 0, FALSE, NONV, NOARENA},
822 /* 8 bytes on most ILP32 with IEEE doubles */
823 {sizeof(xpv_allocated),
824 copy_length(XPV, xpv_len)
825 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
826 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
827 FALSE, NONV, HASARENA},
829 {sizeof(xpviv_allocated),
830 copy_length(XPVIV, xiv_u)
831 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
832 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
833 FALSE, NONV, HASARENA},
835 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
837 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
839 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
841 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
843 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
845 {sizeof(xpvav_allocated),
846 copy_length(XPVAV, xmg_stash)
847 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
848 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
849 TRUE, HADNV, HASARENA},
851 {sizeof(xpvhv_allocated),
852 copy_length(XPVHV, xmg_stash)
853 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
854 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
855 TRUE, HADNV, HASARENA},
857 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
859 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
861 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
864 #define new_body_type(sv_type) \
865 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
866 - bodies_by_type[sv_type].offset)
868 #define del_body_type(p, sv_type) \
869 del_body(p, &PL_body_roots[sv_type])
872 #define new_body_allocated(sv_type) \
873 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
874 - bodies_by_type[sv_type].offset)
876 #define del_body_allocated(p, sv_type) \
877 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
880 #define my_safemalloc(s) (void*)safemalloc(s)
881 #define my_safecalloc(s) (void*)safecalloc(s, 1)
882 #define my_safefree(p) safefree((char*)p)
886 #define new_XNV() my_safemalloc(sizeof(XPVNV))
887 #define del_XNV(p) my_safefree(p)
889 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
890 #define del_XPVNV(p) my_safefree(p)
892 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
893 #define del_XPVAV(p) my_safefree(p)
895 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
896 #define del_XPVHV(p) my_safefree(p)
898 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
899 #define del_XPVMG(p) my_safefree(p)
901 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
902 #define del_XPVGV(p) my_safefree(p)
906 #define new_XNV() new_body_type(SVt_NV)
907 #define del_XNV(p) del_body_type(p, SVt_NV)
909 #define new_XPVNV() new_body_type(SVt_PVNV)
910 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
912 #define new_XPVAV() new_body_allocated(SVt_PVAV)
913 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
915 #define new_XPVHV() new_body_allocated(SVt_PVHV)
916 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
918 #define new_XPVMG() new_body_type(SVt_PVMG)
919 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
921 #define new_XPVGV() new_body_type(SVt_PVGV)
922 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
926 /* no arena for you! */
928 #define new_NOARENA(details) \
929 my_safemalloc((details)->size + (details)->offset)
930 #define new_NOARENAZ(details) \
931 my_safecalloc((details)->size + (details)->offset)
934 =for apidoc sv_upgrade
936 Upgrade an SV to a more complex form. Generally adds a new body type to the
937 SV, then copies across as much information as possible from the old body.
938 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
944 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
949 const U32 old_type = SvTYPE(sv);
950 const struct body_details *const old_type_details
951 = bodies_by_type + old_type;
952 const struct body_details *new_type_details = bodies_by_type + new_type;
954 if (new_type != SVt_PV && SvIsCOW(sv)) {
955 sv_force_normal_flags(sv, 0);
958 if (old_type == new_type)
961 if (old_type > new_type)
962 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
963 (int)old_type, (int)new_type);
966 old_body = SvANY(sv);
968 /* Copying structures onto other structures that have been neatly zeroed
969 has a subtle gotcha. Consider XPVMG
971 +------+------+------+------+------+-------+-------+
972 | NV | CUR | LEN | IV | MAGIC | STASH |
973 +------+------+------+------+------+-------+-------+
976 where NVs are aligned to 8 bytes, so that sizeof that structure is
977 actually 32 bytes long, with 4 bytes of padding at the end:
979 +------+------+------+------+------+-------+-------+------+
980 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
981 +------+------+------+------+------+-------+-------+------+
982 0 4 8 12 16 20 24 28 32
984 so what happens if you allocate memory for this structure:
986 +------+------+------+------+------+-------+-------+------+------+...
987 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
988 +------+------+------+------+------+-------+-------+------+------+...
989 0 4 8 12 16 20 24 28 32 36
991 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
992 expect, because you copy the area marked ??? onto GP. Now, ??? may have
993 started out as zero once, but it's quite possible that it isn't. So now,
994 rather than a nicely zeroed GP, you have it pointing somewhere random.
997 (In fact, GP ends up pointing at a previous GP structure, because the
998 principle cause of the padding in XPVMG getting garbage is a copy of
999 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1001 So we are careful and work out the size of used parts of all the
1008 if (new_type < SVt_PVIV) {
1009 new_type = (new_type == SVt_NV)
1010 ? SVt_PVNV : SVt_PVIV;
1011 new_type_details = bodies_by_type + new_type;
1015 if (new_type < SVt_PVNV) {
1016 new_type = SVt_PVNV;
1017 new_type_details = bodies_by_type + new_type;
1023 assert(new_type > SVt_PV);
1024 assert(SVt_IV < SVt_PV);
1025 assert(SVt_NV < SVt_PV);
1032 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1033 there's no way that it can be safely upgraded, because perl.c
1034 expects to Safefree(SvANY(PL_mess_sv)) */
1035 assert(sv != PL_mess_sv);
1036 /* This flag bit is used to mean other things in other scalar types.
1037 Given that it only has meaning inside the pad, it shouldn't be set
1038 on anything that can get upgraded. */
1039 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1042 if (old_type_details->cant_upgrade)
1043 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1046 SvFLAGS(sv) &= ~SVTYPEMASK;
1047 SvFLAGS(sv) |= new_type;
1051 Perl_croak(aTHX_ "Can't upgrade to undef");
1053 assert(old_type == SVt_NULL);
1054 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1058 assert(old_type == SVt_NULL);
1059 SvANY(sv) = new_XNV();
1063 assert(old_type == SVt_NULL);
1064 SvANY(sv) = &sv->sv_u.svu_rv;
1068 SvANY(sv) = new_XPVHV();
1071 HvTOTALKEYS(sv) = 0;
1076 SvANY(sv) = new_XPVAV();
1083 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1084 The target created by newSVrv also is, and it can have magic.
1085 However, it never has SvPVX set.
1087 if (old_type >= SVt_RV) {
1088 assert(SvPVX_const(sv) == 0);
1091 /* Could put this in the else clause below, as PVMG must have SvPVX
1092 0 already (the assertion above) */
1095 if (old_type >= SVt_PVMG) {
1096 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1097 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1099 SvMAGIC_set(sv, NULL);
1100 SvSTASH_set(sv, NULL);
1106 /* XXX Is this still needed? Was it ever needed? Surely as there is
1107 no route from NV to PVIV, NOK can never be true */
1108 assert(!SvNOKp(sv));
1120 assert(new_type_details->size);
1121 /* We always allocated the full length item with PURIFY. To do this
1122 we fake things so that arena is false for all 16 types.. */
1123 if(new_type_details->arena) {
1124 /* This points to the start of the allocated area. */
1125 new_body_inline(new_body, new_type_details->size, new_type);
1126 Zero(new_body, new_type_details->size, char);
1127 new_body = ((char *)new_body) - new_type_details->offset;
1129 new_body = new_NOARENAZ(new_type_details);
1131 SvANY(sv) = new_body;
1133 if (old_type_details->copy) {
1134 Copy((char *)old_body + old_type_details->offset,
1135 (char *)new_body + old_type_details->offset,
1136 old_type_details->copy, char);
1139 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1140 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1141 * correct 0.0 for us. Otherwise, if the old body didn't have an
1142 * NV slot, but the new one does, then we need to initialise the
1143 * freshly created NV slot with whatever the correct bit pattern is
1145 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1149 if (new_type == SVt_PVIO)
1150 IoPAGE_LEN(sv) = 60;
1151 if (old_type < SVt_RV)
1155 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1156 (unsigned long)new_type);
1159 if (old_type_details->size) {
1160 /* If the old body had an allocated size, then we need to free it. */
1162 my_safefree(old_body);
1164 del_body((void*)((char*)old_body + old_type_details->offset),
1165 &PL_body_roots[old_type]);
1171 =for apidoc sv_backoff
1173 Remove any string offset. You should normally use the C<SvOOK_off> macro
1180 Perl_sv_backoff(pTHX_ register SV *sv)
1183 assert(SvTYPE(sv) != SVt_PVHV);
1184 assert(SvTYPE(sv) != SVt_PVAV);
1186 const char * const s = SvPVX_const(sv);
1187 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1188 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1190 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1192 SvFLAGS(sv) &= ~SVf_OOK;
1199 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1200 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1201 Use the C<SvGROW> wrapper instead.
1207 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000) {
1213 PerlIO_printf(Perl_debug_log,
1214 "Allocation too large: %"UVxf"\n", (UV)newlen);
1217 #endif /* HAS_64K_LIMIT */
1220 if (SvTYPE(sv) < SVt_PV) {
1221 sv_upgrade(sv, SVt_PV);
1222 s = SvPVX_mutable(sv);
1224 else if (SvOOK(sv)) { /* pv is offset? */
1226 s = SvPVX_mutable(sv);
1227 if (newlen > SvLEN(sv))
1228 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1229 #ifdef HAS_64K_LIMIT
1230 if (newlen >= 0x10000)
1235 s = SvPVX_mutable(sv);
1237 if (newlen > SvLEN(sv)) { /* need more room? */
1238 newlen = PERL_STRLEN_ROUNDUP(newlen);
1239 if (SvLEN(sv) && s) {
1241 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1247 s = saferealloc(s, newlen);
1250 s = safemalloc(newlen);
1251 if (SvPVX_const(sv) && SvCUR(sv)) {
1252 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1256 SvLEN_set(sv, newlen);
1262 =for apidoc sv_setiv
1264 Copies an integer into the given SV, upgrading first if necessary.
1265 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1271 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1274 SV_CHECK_THINKFIRST_COW_DROP(sv);
1275 switch (SvTYPE(sv)) {
1277 sv_upgrade(sv, SVt_IV);
1280 sv_upgrade(sv, SVt_PVNV);
1284 sv_upgrade(sv, SVt_PVIV);
1293 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1296 (void)SvIOK_only(sv); /* validate number */
1302 =for apidoc sv_setiv_mg
1304 Like C<sv_setiv>, but also handles 'set' magic.
1310 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1317 =for apidoc sv_setuv
1319 Copies an unsigned integer into the given SV, upgrading first if necessary.
1320 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1326 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1328 /* With these two if statements:
1329 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1332 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1334 If you wish to remove them, please benchmark to see what the effect is
1336 if (u <= (UV)IV_MAX) {
1337 sv_setiv(sv, (IV)u);
1346 =for apidoc sv_setuv_mg
1348 Like C<sv_setuv>, but also handles 'set' magic.
1354 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1363 =for apidoc sv_setnv
1365 Copies a double into the given SV, upgrading first if necessary.
1366 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1372 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1375 SV_CHECK_THINKFIRST_COW_DROP(sv);
1376 switch (SvTYPE(sv)) {
1379 sv_upgrade(sv, SVt_NV);
1384 sv_upgrade(sv, SVt_PVNV);
1393 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1397 (void)SvNOK_only(sv); /* validate number */
1402 =for apidoc sv_setnv_mg
1404 Like C<sv_setnv>, but also handles 'set' magic.
1410 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1416 /* Print an "isn't numeric" warning, using a cleaned-up,
1417 * printable version of the offending string
1421 S_not_a_number(pTHX_ SV *sv)
1429 dsv = sv_2mortal(newSVpvs(""));
1430 pv = sv_uni_display(dsv, sv, 10, 0);
1433 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1434 /* each *s can expand to 4 chars + "...\0",
1435 i.e. need room for 8 chars */
1437 const char *s = SvPVX_const(sv);
1438 const char * const end = s + SvCUR(sv);
1439 for ( ; s < end && d < limit; s++ ) {
1441 if (ch & 128 && !isPRINT_LC(ch)) {
1450 else if (ch == '\r') {
1454 else if (ch == '\f') {
1458 else if (ch == '\\') {
1462 else if (ch == '\0') {
1466 else if (isPRINT_LC(ch))
1483 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1484 "Argument \"%s\" isn't numeric in %s", pv,
1487 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1488 "Argument \"%s\" isn't numeric", pv);
1492 =for apidoc looks_like_number
1494 Test if the content of an SV looks like a number (or is a number).
1495 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1496 non-numeric warning), even if your atof() doesn't grok them.
1502 Perl_looks_like_number(pTHX_ SV *sv)
1504 register const char *sbegin;
1508 sbegin = SvPVX_const(sv);
1511 else if (SvPOKp(sv))
1512 sbegin = SvPV_const(sv, len);
1514 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1515 return grok_number(sbegin, len, NULL);
1518 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1519 until proven guilty, assume that things are not that bad... */
1524 As 64 bit platforms often have an NV that doesn't preserve all bits of
1525 an IV (an assumption perl has been based on to date) it becomes necessary
1526 to remove the assumption that the NV always carries enough precision to
1527 recreate the IV whenever needed, and that the NV is the canonical form.
1528 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1529 precision as a side effect of conversion (which would lead to insanity
1530 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1531 1) to distinguish between IV/UV/NV slots that have cached a valid
1532 conversion where precision was lost and IV/UV/NV slots that have a
1533 valid conversion which has lost no precision
1534 2) to ensure that if a numeric conversion to one form is requested that
1535 would lose precision, the precise conversion (or differently
1536 imprecise conversion) is also performed and cached, to prevent
1537 requests for different numeric formats on the same SV causing
1538 lossy conversion chains. (lossless conversion chains are perfectly
1543 SvIOKp is true if the IV slot contains a valid value
1544 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1545 SvNOKp is true if the NV slot contains a valid value
1546 SvNOK is true only if the NV value is accurate
1549 while converting from PV to NV, check to see if converting that NV to an
1550 IV(or UV) would lose accuracy over a direct conversion from PV to
1551 IV(or UV). If it would, cache both conversions, return NV, but mark
1552 SV as IOK NOKp (ie not NOK).
1554 While converting from PV to IV, check to see if converting that IV to an
1555 NV would lose accuracy over a direct conversion from PV to NV. If it
1556 would, cache both conversions, flag similarly.
1558 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1559 correctly because if IV & NV were set NV *always* overruled.
1560 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1561 changes - now IV and NV together means that the two are interchangeable:
1562 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1564 The benefit of this is that operations such as pp_add know that if
1565 SvIOK is true for both left and right operands, then integer addition
1566 can be used instead of floating point (for cases where the result won't
1567 overflow). Before, floating point was always used, which could lead to
1568 loss of precision compared with integer addition.
1570 * making IV and NV equal status should make maths accurate on 64 bit
1572 * may speed up maths somewhat if pp_add and friends start to use
1573 integers when possible instead of fp. (Hopefully the overhead in
1574 looking for SvIOK and checking for overflow will not outweigh the
1575 fp to integer speedup)
1576 * will slow down integer operations (callers of SvIV) on "inaccurate"
1577 values, as the change from SvIOK to SvIOKp will cause a call into
1578 sv_2iv each time rather than a macro access direct to the IV slot
1579 * should speed up number->string conversion on integers as IV is
1580 favoured when IV and NV are equally accurate
1582 ####################################################################
1583 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1584 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1585 On the other hand, SvUOK is true iff UV.
1586 ####################################################################
1588 Your mileage will vary depending your CPU's relative fp to integer
1592 #ifndef NV_PRESERVES_UV
1593 # define IS_NUMBER_UNDERFLOW_IV 1
1594 # define IS_NUMBER_UNDERFLOW_UV 2
1595 # define IS_NUMBER_IV_AND_UV 2
1596 # define IS_NUMBER_OVERFLOW_IV 4
1597 # define IS_NUMBER_OVERFLOW_UV 5
1599 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1601 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1603 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1606 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1607 if (SvNVX(sv) < (NV)IV_MIN) {
1608 (void)SvIOKp_on(sv);
1610 SvIV_set(sv, IV_MIN);
1611 return IS_NUMBER_UNDERFLOW_IV;
1613 if (SvNVX(sv) > (NV)UV_MAX) {
1614 (void)SvIOKp_on(sv);
1617 SvUV_set(sv, UV_MAX);
1618 return IS_NUMBER_OVERFLOW_UV;
1620 (void)SvIOKp_on(sv);
1622 /* Can't use strtol etc to convert this string. (See truth table in
1624 if (SvNVX(sv) <= (UV)IV_MAX) {
1625 SvIV_set(sv, I_V(SvNVX(sv)));
1626 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1627 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1629 /* Integer is imprecise. NOK, IOKp */
1631 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1634 SvUV_set(sv, U_V(SvNVX(sv)));
1635 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1636 if (SvUVX(sv) == UV_MAX) {
1637 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1638 possibly be preserved by NV. Hence, it must be overflow.
1640 return IS_NUMBER_OVERFLOW_UV;
1642 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1644 /* Integer is imprecise. NOK, IOKp */
1646 return IS_NUMBER_OVERFLOW_IV;
1648 #endif /* !NV_PRESERVES_UV*/
1651 S_sv_2iuv_common(pTHX_ SV *sv) {
1654 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1655 * without also getting a cached IV/UV from it at the same time
1656 * (ie PV->NV conversion should detect loss of accuracy and cache
1657 * IV or UV at same time to avoid this. */
1658 /* IV-over-UV optimisation - choose to cache IV if possible */
1660 if (SvTYPE(sv) == SVt_NV)
1661 sv_upgrade(sv, SVt_PVNV);
1663 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1664 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1665 certainly cast into the IV range at IV_MAX, whereas the correct
1666 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1668 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1669 SvIV_set(sv, I_V(SvNVX(sv)));
1670 if (SvNVX(sv) == (NV) SvIVX(sv)
1671 #ifndef NV_PRESERVES_UV
1672 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1673 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1674 /* Don't flag it as "accurately an integer" if the number
1675 came from a (by definition imprecise) NV operation, and
1676 we're outside the range of NV integer precision */
1679 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1680 DEBUG_c(PerlIO_printf(Perl_debug_log,
1681 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1687 /* IV not precise. No need to convert from PV, as NV
1688 conversion would already have cached IV if it detected
1689 that PV->IV would be better than PV->NV->IV
1690 flags already correct - don't set public IOK. */
1691 DEBUG_c(PerlIO_printf(Perl_debug_log,
1692 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1697 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1698 but the cast (NV)IV_MIN rounds to a the value less (more
1699 negative) than IV_MIN which happens to be equal to SvNVX ??
1700 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1701 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1702 (NV)UVX == NVX are both true, but the values differ. :-(
1703 Hopefully for 2s complement IV_MIN is something like
1704 0x8000000000000000 which will be exact. NWC */
1707 SvUV_set(sv, U_V(SvNVX(sv)));
1709 (SvNVX(sv) == (NV) SvUVX(sv))
1710 #ifndef NV_PRESERVES_UV
1711 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1712 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1713 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1714 /* Don't flag it as "accurately an integer" if the number
1715 came from a (by definition imprecise) NV operation, and
1716 we're outside the range of NV integer precision */
1721 DEBUG_c(PerlIO_printf(Perl_debug_log,
1722 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1728 else if (SvPOKp(sv) && SvLEN(sv)) {
1730 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1731 /* We want to avoid a possible problem when we cache an IV/ a UV which
1732 may be later translated to an NV, and the resulting NV is not
1733 the same as the direct translation of the initial string
1734 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1735 be careful to ensure that the value with the .456 is around if the
1736 NV value is requested in the future).
1738 This means that if we cache such an IV/a UV, we need to cache the
1739 NV as well. Moreover, we trade speed for space, and do not
1740 cache the NV if we are sure it's not needed.
1743 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1744 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1745 == IS_NUMBER_IN_UV) {
1746 /* It's definitely an integer, only upgrade to PVIV */
1747 if (SvTYPE(sv) < SVt_PVIV)
1748 sv_upgrade(sv, SVt_PVIV);
1750 } else if (SvTYPE(sv) < SVt_PVNV)
1751 sv_upgrade(sv, SVt_PVNV);
1753 /* If NVs preserve UVs then we only use the UV value if we know that
1754 we aren't going to call atof() below. If NVs don't preserve UVs
1755 then the value returned may have more precision than atof() will
1756 return, even though value isn't perfectly accurate. */
1757 if ((numtype & (IS_NUMBER_IN_UV
1758 #ifdef NV_PRESERVES_UV
1761 )) == IS_NUMBER_IN_UV) {
1762 /* This won't turn off the public IOK flag if it was set above */
1763 (void)SvIOKp_on(sv);
1765 if (!(numtype & IS_NUMBER_NEG)) {
1767 if (value <= (UV)IV_MAX) {
1768 SvIV_set(sv, (IV)value);
1770 /* it didn't overflow, and it was positive. */
1771 SvUV_set(sv, value);
1775 /* 2s complement assumption */
1776 if (value <= (UV)IV_MIN) {
1777 SvIV_set(sv, -(IV)value);
1779 /* Too negative for an IV. This is a double upgrade, but
1780 I'm assuming it will be rare. */
1781 if (SvTYPE(sv) < SVt_PVNV)
1782 sv_upgrade(sv, SVt_PVNV);
1786 SvNV_set(sv, -(NV)value);
1787 SvIV_set(sv, IV_MIN);
1791 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1792 will be in the previous block to set the IV slot, and the next
1793 block to set the NV slot. So no else here. */
1795 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1796 != IS_NUMBER_IN_UV) {
1797 /* It wasn't an (integer that doesn't overflow the UV). */
1798 SvNV_set(sv, Atof(SvPVX_const(sv)));
1800 if (! numtype && ckWARN(WARN_NUMERIC))
1803 #if defined(USE_LONG_DOUBLE)
1804 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1805 PTR2UV(sv), SvNVX(sv)));
1807 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1808 PTR2UV(sv), SvNVX(sv)));
1811 #ifdef NV_PRESERVES_UV
1812 (void)SvIOKp_on(sv);
1814 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1815 SvIV_set(sv, I_V(SvNVX(sv)));
1816 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1819 /* Integer is imprecise. NOK, IOKp */
1821 /* UV will not work better than IV */
1823 if (SvNVX(sv) > (NV)UV_MAX) {
1825 /* Integer is inaccurate. NOK, IOKp, is UV */
1826 SvUV_set(sv, UV_MAX);
1828 SvUV_set(sv, U_V(SvNVX(sv)));
1829 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1830 NV preservse UV so can do correct comparison. */
1831 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1834 /* Integer is imprecise. NOK, IOKp, is UV */
1839 #else /* NV_PRESERVES_UV */
1840 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1841 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1842 /* The IV/UV slot will have been set from value returned by
1843 grok_number above. The NV slot has just been set using
1846 assert (SvIOKp(sv));
1848 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1849 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1850 /* Small enough to preserve all bits. */
1851 (void)SvIOKp_on(sv);
1853 SvIV_set(sv, I_V(SvNVX(sv)));
1854 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1856 /* Assumption: first non-preserved integer is < IV_MAX,
1857 this NV is in the preserved range, therefore: */
1858 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1860 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1864 0 0 already failed to read UV.
1865 0 1 already failed to read UV.
1866 1 0 you won't get here in this case. IV/UV
1867 slot set, public IOK, Atof() unneeded.
1868 1 1 already read UV.
1869 so there's no point in sv_2iuv_non_preserve() attempting
1870 to use atol, strtol, strtoul etc. */
1871 sv_2iuv_non_preserve (sv, numtype);
1874 #endif /* NV_PRESERVES_UV */
1878 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1879 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1882 if (SvTYPE(sv) < SVt_IV)
1883 /* Typically the caller expects that sv_any is not NULL now. */
1884 sv_upgrade(sv, SVt_IV);
1885 /* Return 0 from the caller. */
1892 =for apidoc sv_2iv_flags
1894 Return the integer value of an SV, doing any necessary string
1895 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1896 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1902 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1907 if (SvGMAGICAL(sv)) {
1908 if (flags & SV_GMAGIC)
1913 return I_V(SvNVX(sv));
1915 if (SvPOKp(sv) && SvLEN(sv)) {
1918 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1921 == IS_NUMBER_IN_UV) {
1922 /* It's definitely an integer */
1923 if (numtype & IS_NUMBER_NEG) {
1924 if (value < (UV)IV_MIN)
1927 if (value < (UV)IV_MAX)
1932 if (ckWARN(WARN_NUMERIC))
1935 return I_V(Atof(SvPVX_const(sv)));
1940 assert(SvTYPE(sv) >= SVt_PVMG);
1941 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1942 } else if (SvTHINKFIRST(sv)) {
1946 SV * const tmpstr=AMG_CALLun(sv,numer);
1947 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1948 return SvIV(tmpstr);
1951 return PTR2IV(SvRV(sv));
1954 sv_force_normal_flags(sv, 0);
1956 if (SvREADONLY(sv) && !SvOK(sv)) {
1957 if (ckWARN(WARN_UNINITIALIZED))
1963 if (S_sv_2iuv_common(aTHX_ sv))
1966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1967 PTR2UV(sv),SvIVX(sv)));
1968 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1972 =for apidoc sv_2uv_flags
1974 Return the unsigned integer value of an SV, doing any necessary string
1975 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1976 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1982 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1987 if (SvGMAGICAL(sv)) {
1988 if (flags & SV_GMAGIC)
1993 return U_V(SvNVX(sv));
1994 if (SvPOKp(sv) && SvLEN(sv)) {
1997 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer */
2002 if (!(numtype & IS_NUMBER_NEG))
2006 if (ckWARN(WARN_NUMERIC))
2009 return U_V(Atof(SvPVX_const(sv)));
2014 assert(SvTYPE(sv) >= SVt_PVMG);
2015 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2016 } else if (SvTHINKFIRST(sv)) {
2020 SV *const tmpstr = AMG_CALLun(sv,numer);
2021 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2022 return SvUV(tmpstr);
2025 return PTR2UV(SvRV(sv));
2028 sv_force_normal_flags(sv, 0);
2030 if (SvREADONLY(sv) && !SvOK(sv)) {
2031 if (ckWARN(WARN_UNINITIALIZED))
2037 if (S_sv_2iuv_common(aTHX_ sv))
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2042 PTR2UV(sv),SvUVX(sv)));
2043 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2049 Return the num value of an SV, doing any necessary string or integer
2050 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2057 Perl_sv_2nv(pTHX_ register SV *sv)
2062 if (SvGMAGICAL(sv)) {
2066 if (SvPOKp(sv) && SvLEN(sv)) {
2067 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2068 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2070 return Atof(SvPVX_const(sv));
2074 return (NV)SvUVX(sv);
2076 return (NV)SvIVX(sv);
2081 assert(SvTYPE(sv) >= SVt_PVMG);
2082 /* This falls through to the report_uninit near the end of the
2084 } else if (SvTHINKFIRST(sv)) {
2088 SV *const tmpstr = AMG_CALLun(sv,numer);
2089 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2090 return SvNV(tmpstr);
2093 return PTR2NV(SvRV(sv));
2096 sv_force_normal_flags(sv, 0);
2098 if (SvREADONLY(sv) && !SvOK(sv)) {
2099 if (ckWARN(WARN_UNINITIALIZED))
2104 if (SvTYPE(sv) < SVt_NV) {
2105 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2106 sv_upgrade(sv, SVt_NV);
2107 #ifdef USE_LONG_DOUBLE
2109 STORE_NUMERIC_LOCAL_SET_STANDARD();
2110 PerlIO_printf(Perl_debug_log,
2111 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2112 PTR2UV(sv), SvNVX(sv));
2113 RESTORE_NUMERIC_LOCAL();
2117 STORE_NUMERIC_LOCAL_SET_STANDARD();
2118 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2119 PTR2UV(sv), SvNVX(sv));
2120 RESTORE_NUMERIC_LOCAL();
2124 else if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2130 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2131 #ifdef NV_PRESERVES_UV
2134 /* Only set the public NV OK flag if this NV preserves the IV */
2135 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2136 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2137 : (SvIVX(sv) == I_V(SvNVX(sv))))
2143 else if (SvPOKp(sv) && SvLEN(sv)) {
2145 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2146 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2148 #ifdef NV_PRESERVES_UV
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 == IS_NUMBER_IN_UV) {
2151 /* It's definitely an integer */
2152 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2154 SvNV_set(sv, Atof(SvPVX_const(sv)));
2157 SvNV_set(sv, Atof(SvPVX_const(sv)));
2158 /* Only set the public NV OK flag if this NV preserves the value in
2159 the PV at least as well as an IV/UV would.
2160 Not sure how to do this 100% reliably. */
2161 /* if that shift count is out of range then Configure's test is
2162 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2164 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2165 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2166 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2167 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2168 /* Can't use strtol etc to convert this string, so don't try.
2169 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2172 /* value has been set. It may not be precise. */
2173 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2174 /* 2s complement assumption for (UV)IV_MIN */
2175 SvNOK_on(sv); /* Integer is too negative. */
2180 if (numtype & IS_NUMBER_NEG) {
2181 SvIV_set(sv, -(IV)value);
2182 } else if (value <= (UV)IV_MAX) {
2183 SvIV_set(sv, (IV)value);
2185 SvUV_set(sv, value);
2189 if (numtype & IS_NUMBER_NOT_INT) {
2190 /* I believe that even if the original PV had decimals,
2191 they are lost beyond the limit of the FP precision.
2192 However, neither is canonical, so both only get p
2193 flags. NWC, 2000/11/25 */
2194 /* Both already have p flags, so do nothing */
2196 const NV nv = SvNVX(sv);
2197 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2198 if (SvIVX(sv) == I_V(nv)) {
2201 /* It had no "." so it must be integer. */
2205 /* between IV_MAX and NV(UV_MAX).
2206 Could be slightly > UV_MAX */
2208 if (numtype & IS_NUMBER_NOT_INT) {
2209 /* UV and NV both imprecise. */
2211 const UV nv_as_uv = U_V(nv);
2213 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2222 #endif /* NV_PRESERVES_UV */
2225 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2227 assert (SvTYPE(sv) >= SVt_NV);
2228 /* Typically the caller expects that sv_any is not NULL now. */
2229 /* XXX Ilya implies that this is a bug in callers that assume this
2230 and ideally should be fixed. */
2233 #if defined(USE_LONG_DOUBLE)
2235 STORE_NUMERIC_LOCAL_SET_STANDARD();
2236 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2237 PTR2UV(sv), SvNVX(sv));
2238 RESTORE_NUMERIC_LOCAL();
2242 STORE_NUMERIC_LOCAL_SET_STANDARD();
2243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2244 PTR2UV(sv), SvNVX(sv));
2245 RESTORE_NUMERIC_LOCAL();
2251 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2252 * UV as a string towards the end of buf, and return pointers to start and
2255 * We assume that buf is at least TYPE_CHARS(UV) long.
2259 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2261 char *ptr = buf + TYPE_CHARS(UV);
2262 char * const ebuf = ptr;
2275 *--ptr = '0' + (char)(uv % 10);
2283 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2284 * a regexp to its stringified form.
2288 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2290 const regexp * const re = (regexp *)mg->mg_obj;
2293 const char *fptr = "msix";
2298 bool need_newline = 0;
2299 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2301 while((ch = *fptr++)) {
2303 reflags[left++] = ch;
2306 reflags[right--] = ch;
2311 reflags[left] = '-';
2315 mg->mg_len = re->prelen + 4 + left;
2317 * If /x was used, we have to worry about a regex ending with a
2318 * comment later being embedded within another regex. If so, we don't
2319 * want this regex's "commentization" to leak out to the right part of
2320 * the enclosing regex, we must cap it with a newline.
2322 * So, if /x was used, we scan backwards from the end of the regex. If
2323 * we find a '#' before we find a newline, we need to add a newline
2324 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2325 * we don't need to add anything. -jfriedl
2327 if (PMf_EXTENDED & re->reganch) {
2328 const char *endptr = re->precomp + re->prelen;
2329 while (endptr >= re->precomp) {
2330 const char c = *(endptr--);
2332 break; /* don't need another */
2334 /* we end while in a comment, so we need a newline */
2335 mg->mg_len++; /* save space for it */
2336 need_newline = 1; /* note to add it */
2342 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2343 mg->mg_ptr[0] = '(';
2344 mg->mg_ptr[1] = '?';
2345 Copy(reflags, mg->mg_ptr+2, left, char);
2346 *(mg->mg_ptr+left+2) = ':';
2347 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2349 mg->mg_ptr[mg->mg_len - 2] = '\n';
2350 mg->mg_ptr[mg->mg_len - 1] = ')';
2351 mg->mg_ptr[mg->mg_len] = 0;
2353 PL_reginterp_cnt += re->program[0].next_off;
2355 if (re->reganch & ROPT_UTF8)
2365 =for apidoc sv_2pv_flags
2367 Returns a pointer to the string value of an SV, and sets *lp to its length.
2368 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2370 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2371 usually end up here too.
2377 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2387 if (SvGMAGICAL(sv)) {
2388 if (flags & SV_GMAGIC)
2393 if (flags & SV_MUTABLE_RETURN)
2394 return SvPVX_mutable(sv);
2395 if (flags & SV_CONST_RETURN)
2396 return (char *)SvPVX_const(sv);
2399 if (SvIOKp(sv) || SvNOKp(sv)) {
2400 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2404 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2405 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2407 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2410 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2411 /* Sneaky stuff here */
2412 SV * const tsv = newSVpvn(tbuf, len);
2422 #ifdef FIXNEGATIVEZERO
2423 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2429 SvUPGRADE(sv, SVt_PV);
2432 s = SvGROW_mutable(sv, len + 1);
2435 return memcpy(s, tbuf, len + 1);
2441 assert(SvTYPE(sv) >= SVt_PVMG);
2442 /* This falls through to the report_uninit near the end of the
2444 } else if (SvTHINKFIRST(sv)) {
2448 SV *const tmpstr = AMG_CALLun(sv,string);
2449 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2455 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2456 if (flags & SV_CONST_RETURN) {
2457 pv = (char *) SvPVX_const(tmpstr);
2459 pv = (flags & SV_MUTABLE_RETURN)
2460 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2463 *lp = SvCUR(tmpstr);
2465 pv = sv_2pv_flags(tmpstr, lp, flags);
2477 const SV *const referent = (SV*)SvRV(sv);
2480 tsv = sv_2mortal(newSVpvs("NULLREF"));
2481 } else if (SvTYPE(referent) == SVt_PVMG
2482 && ((SvFLAGS(referent) &
2483 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2484 == (SVs_OBJECT|SVs_SMG))
2485 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2486 return stringify_regexp(sv, mg, lp);
2488 const char *const typestr = sv_reftype(referent, 0);
2490 tsv = sv_newmortal();
2491 if (SvOBJECT(referent)) {
2492 const char *const name = HvNAME_get(SvSTASH(referent));
2493 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2494 name ? name : "__ANON__" , typestr,
2498 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2506 if (SvREADONLY(sv) && !SvOK(sv)) {
2507 if (ckWARN(WARN_UNINITIALIZED))
2514 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2515 /* I'm assuming that if both IV and NV are equally valid then
2516 converting the IV is going to be more efficient */
2517 const U32 isIOK = SvIOK(sv);
2518 const U32 isUIOK = SvIsUV(sv);
2519 char buf[TYPE_CHARS(UV)];
2522 if (SvTYPE(sv) < SVt_PVIV)
2523 sv_upgrade(sv, SVt_PVIV);
2524 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2525 /* inlined from sv_setpvn */
2526 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2527 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2528 SvCUR_set(sv, ebuf - ptr);
2538 else if (SvNOKp(sv)) {
2539 const int olderrno = errno;
2540 if (SvTYPE(sv) < SVt_PVNV)
2541 sv_upgrade(sv, SVt_PVNV);
2542 /* The +20 is pure guesswork. Configure test needed. --jhi */
2543 s = SvGROW_mutable(sv, NV_DIG + 20);
2544 /* some Xenix systems wipe out errno here */
2546 if (SvNVX(sv) == 0.0)
2547 (void)strcpy(s,"0");
2551 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2554 #ifdef FIXNEGATIVEZERO
2555 if (*s == '-' && s[1] == '0' && !s[2])
2565 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2569 if (SvTYPE(sv) < SVt_PV)
2570 /* Typically the caller expects that sv_any is not NULL now. */
2571 sv_upgrade(sv, SVt_PV);
2575 const STRLEN len = s - SvPVX_const(sv);
2581 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2582 PTR2UV(sv),SvPVX_const(sv)));
2583 if (flags & SV_CONST_RETURN)
2584 return (char *)SvPVX_const(sv);
2585 if (flags & SV_MUTABLE_RETURN)
2586 return SvPVX_mutable(sv);
2591 =for apidoc sv_copypv
2593 Copies a stringified representation of the source SV into the
2594 destination SV. Automatically performs any necessary mg_get and
2595 coercion of numeric values into strings. Guaranteed to preserve
2596 UTF-8 flag even from overloaded objects. Similar in nature to
2597 sv_2pv[_flags] but operates directly on an SV instead of just the
2598 string. Mostly uses sv_2pv_flags to do its work, except when that
2599 would lose the UTF-8'ness of the PV.
2605 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2608 const char * const s = SvPV_const(ssv,len);
2609 sv_setpvn(dsv,s,len);
2617 =for apidoc sv_2pvbyte
2619 Return a pointer to the byte-encoded representation of the SV, and set *lp
2620 to its length. May cause the SV to be downgraded from UTF-8 as a
2623 Usually accessed via the C<SvPVbyte> macro.
2629 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2631 sv_utf8_downgrade(sv,0);
2632 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2636 =for apidoc sv_2pvutf8
2638 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2639 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2641 Usually accessed via the C<SvPVutf8> macro.
2647 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2649 sv_utf8_upgrade(sv);
2650 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2655 =for apidoc sv_2bool
2657 This function is only called on magical items, and is only used by
2658 sv_true() or its macro equivalent.
2664 Perl_sv_2bool(pTHX_ register SV *sv)
2673 SV * const tmpsv = AMG_CALLun(sv,bool_);
2674 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2675 return (bool)SvTRUE(tmpsv);
2677 return SvRV(sv) != 0;
2680 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2682 (*sv->sv_u.svu_pv > '0' ||
2683 Xpvtmp->xpv_cur > 1 ||
2684 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2691 return SvIVX(sv) != 0;
2694 return SvNVX(sv) != 0.0;
2702 =for apidoc sv_utf8_upgrade
2704 Converts the PV of an SV to its UTF-8-encoded form.
2705 Forces the SV to string form if it is not already.
2706 Always sets the SvUTF8 flag to avoid future validity checks even
2707 if all the bytes have hibit clear.
2709 This is not as a general purpose byte encoding to Unicode interface:
2710 use the Encode extension for that.
2712 =for apidoc sv_utf8_upgrade_flags
2714 Converts the PV of an SV to its UTF-8-encoded form.
2715 Forces the SV to string form if it is not already.
2716 Always sets the SvUTF8 flag to avoid future validity checks even
2717 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2718 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2719 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2721 This is not as a general purpose byte encoding to Unicode interface:
2722 use the Encode extension for that.
2728 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2731 if (sv == &PL_sv_undef)
2735 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2736 (void) sv_2pv_flags(sv,&len, flags);
2740 (void) SvPV_force(sv,len);
2749 sv_force_normal_flags(sv, 0);
2752 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2753 sv_recode_to_utf8(sv, PL_encoding);
2754 else { /* Assume Latin-1/EBCDIC */
2755 /* This function could be much more efficient if we
2756 * had a FLAG in SVs to signal if there are any hibit
2757 * chars in the PV. Given that there isn't such a flag
2758 * make the loop as fast as possible. */
2759 const U8 * const s = (U8 *) SvPVX_const(sv);
2760 const U8 * const e = (U8 *) SvEND(sv);
2765 /* Check for hi bit */
2766 if (!NATIVE_IS_INVARIANT(ch)) {
2767 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2768 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2770 SvPV_free(sv); /* No longer using what was there before. */
2771 SvPV_set(sv, (char*)recoded);
2772 SvCUR_set(sv, len - 1);
2773 SvLEN_set(sv, len); /* No longer know the real size. */
2777 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2784 =for apidoc sv_utf8_downgrade
2786 Attempts to convert the PV of an SV from characters to bytes.
2787 If the PV contains a character beyond byte, this conversion will fail;
2788 in this case, either returns false or, if C<fail_ok> is not
2791 This is not as a general purpose Unicode to byte encoding interface:
2792 use the Encode extension for that.
2798 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2801 if (SvPOKp(sv) && SvUTF8(sv)) {
2807 sv_force_normal_flags(sv, 0);
2809 s = (U8 *) SvPV(sv, len);
2810 if (!utf8_to_bytes(s, &len)) {
2815 Perl_croak(aTHX_ "Wide character in %s",
2818 Perl_croak(aTHX_ "Wide character");
2829 =for apidoc sv_utf8_encode
2831 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2832 flag off so that it looks like octets again.
2838 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2840 (void) sv_utf8_upgrade(sv);
2842 sv_force_normal_flags(sv, 0);
2844 if (SvREADONLY(sv)) {
2845 Perl_croak(aTHX_ PL_no_modify);
2851 =for apidoc sv_utf8_decode
2853 If the PV of the SV is an octet sequence in UTF-8
2854 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2855 so that it looks like a character. If the PV contains only single-byte
2856 characters, the C<SvUTF8> flag stays being off.
2857 Scans PV for validity and returns false if the PV is invalid UTF-8.
2863 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2869 /* The octets may have got themselves encoded - get them back as
2872 if (!sv_utf8_downgrade(sv, TRUE))
2875 /* it is actually just a matter of turning the utf8 flag on, but
2876 * we want to make sure everything inside is valid utf8 first.
2878 c = (const U8 *) SvPVX_const(sv);
2879 if (!is_utf8_string(c, SvCUR(sv)+1))
2881 e = (const U8 *) SvEND(sv);
2884 if (!UTF8_IS_INVARIANT(ch)) {
2894 =for apidoc sv_setsv
2896 Copies the contents of the source SV C<ssv> into the destination SV
2897 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2898 function if the source SV needs to be reused. Does not handle 'set' magic.
2899 Loosely speaking, it performs a copy-by-value, obliterating any previous
2900 content of the destination.
2902 You probably want to use one of the assortment of wrappers, such as
2903 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2904 C<SvSetMagicSV_nosteal>.
2906 =for apidoc sv_setsv_flags
2908 Copies the contents of the source SV C<ssv> into the destination SV
2909 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2910 function if the source SV needs to be reused. Does not handle 'set' magic.
2911 Loosely speaking, it performs a copy-by-value, obliterating any previous
2912 content of the destination.
2913 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2914 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2915 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2916 and C<sv_setsv_nomg> are implemented in terms of this function.
2918 You probably want to use one of the assortment of wrappers, such as
2919 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2920 C<SvSetMagicSV_nosteal>.
2922 This is the primary function for copying scalars, and most other
2923 copy-ish functions and macros use this underneath.
2929 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
2931 if (dtype != SVt_PVGV) {
2932 const char * const name = GvNAME(sstr);
2933 const STRLEN len = GvNAMELEN(sstr);
2934 /* don't upgrade SVt_PVLV: it can hold a glob */
2935 if (dtype != SVt_PVLV)
2936 sv_upgrade(dstr, SVt_PVGV);
2937 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
2938 GvSTASH(dstr) = GvSTASH(sstr);
2940 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
2941 GvNAME(dstr) = savepvn(name, len);
2942 GvNAMELEN(dstr) = len;
2943 SvFAKE_on(dstr); /* can coerce to non-glob */
2946 #ifdef GV_UNIQUE_CHECK
2947 if (GvUNIQUE((GV*)dstr)) {
2948 Perl_croak(aTHX_ PL_no_modify);
2952 (void)SvOK_off(dstr);
2953 GvINTRO_off(dstr); /* one-shot flag */
2955 GvGP(dstr) = gp_ref(GvGP(sstr));
2956 if (SvTAINTED(sstr))
2958 if (GvIMPORTED(dstr) != GVf_IMPORTED
2959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2961 GvIMPORTED_on(dstr);
2968 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
2969 SV * const sref = SvREFCNT_inc(SvRV(sstr));
2971 const int intro = GvINTRO(dstr);
2973 #ifdef GV_UNIQUE_CHECK
2974 if (GvUNIQUE((GV*)dstr)) {
2975 Perl_croak(aTHX_ PL_no_modify);
2980 GvINTRO_off(dstr); /* one-shot flag */
2981 GvLINE(dstr) = CopLINE(PL_curcop);
2982 GvEGV(dstr) = (GV*)dstr;
2985 switch (SvTYPE(sref)) {
2988 SAVEGENERICSV(GvAV(dstr));
2990 dref = (SV*)GvAV(dstr);
2991 GvAV(dstr) = (AV*)sref;
2992 if (!GvIMPORTED_AV(dstr)
2993 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2995 GvIMPORTED_AV_on(dstr);
3000 SAVEGENERICSV(GvHV(dstr));
3002 dref = (SV*)GvHV(dstr);
3003 GvHV(dstr) = (HV*)sref;
3004 if (!GvIMPORTED_HV(dstr)
3005 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3007 GvIMPORTED_HV_on(dstr);
3012 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3013 SvREFCNT_dec(GvCV(dstr));
3014 GvCV(dstr) = Nullcv;
3015 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3016 PL_sub_generation++;
3018 SAVEGENERICSV(GvCV(dstr));
3021 dref = (SV*)GvCV(dstr);
3022 if (GvCV(dstr) != (CV*)sref) {
3023 CV* const cv = GvCV(dstr);
3025 if (!GvCVGEN((GV*)dstr) &&
3026 (CvROOT(cv) || CvXSUB(cv)))
3028 /* Redefining a sub - warning is mandatory if
3029 it was a const and its value changed. */
3030 if (CvCONST(cv) && CvCONST((CV*)sref)
3031 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3032 /* They are 2 constant subroutines generated from
3033 the same constant. This probably means that
3034 they are really the "same" proxy subroutine
3035 instantiated in 2 places. Most likely this is
3036 when a constant is exported twice. Don't warn.
3039 else if (ckWARN(WARN_REDEFINE)
3041 && (!CvCONST((CV*)sref)
3042 || sv_cmp(cv_const_sv(cv),
3043 cv_const_sv((CV*)sref))))) {
3044 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3046 ? "Constant subroutine %s::%s redefined"
3047 : "Subroutine %s::%s redefined",
3048 HvNAME_get(GvSTASH((GV*)dstr)),
3049 GvENAME((GV*)dstr));
3053 cv_ckproto(cv, (GV*)dstr,
3054 SvPOK(sref) ? SvPVX_const(sref) : Nullch);
3056 GvCV(dstr) = (CV*)sref;
3057 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3058 GvASSUMECV_on(dstr);
3059 PL_sub_generation++;
3061 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3062 GvIMPORTED_CV_on(dstr);
3067 SAVEGENERICSV(GvIOp(dstr));
3069 dref = (SV*)GvIOp(dstr);
3070 GvIOp(dstr) = (IO*)sref;
3074 SAVEGENERICSV(GvFORM(dstr));
3076 dref = (SV*)GvFORM(dstr);
3077 GvFORM(dstr) = (CV*)sref;
3081 SAVEGENERICSV(GvSV(dstr));
3083 dref = (SV*)GvSV(dstr);
3085 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3086 GvIMPORTED_SV_on(dstr);
3092 if (SvTAINTED(sstr))
3098 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3101 register U32 sflags;
3107 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3109 sstr = &PL_sv_undef;
3110 stype = SvTYPE(sstr);
3111 dtype = SvTYPE(dstr);
3116 /* need to nuke the magic */
3118 SvRMAGICAL_off(dstr);
3121 /* There's a lot of redundancy below but we're going for speed here */
3126 if (dtype != SVt_PVGV) {
3127 (void)SvOK_off(dstr);
3135 sv_upgrade(dstr, SVt_IV);
3138 sv_upgrade(dstr, SVt_PVNV);
3142 sv_upgrade(dstr, SVt_PVIV);
3145 (void)SvIOK_only(dstr);
3146 SvIV_set(dstr, SvIVX(sstr));
3149 if (SvTAINTED(sstr))
3160 sv_upgrade(dstr, SVt_NV);
3165 sv_upgrade(dstr, SVt_PVNV);
3168 SvNV_set(dstr, SvNVX(sstr));
3169 (void)SvNOK_only(dstr);
3170 if (SvTAINTED(sstr))
3178 sv_upgrade(dstr, SVt_RV);
3179 else if (dtype == SVt_PVGV &&
3180 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3183 if (GvIMPORTED(dstr) != GVf_IMPORTED
3184 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3186 GvIMPORTED_on(dstr);
3191 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3195 #ifdef PERL_OLD_COPY_ON_WRITE
3196 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3197 if (dtype < SVt_PVIV)
3198 sv_upgrade(dstr, SVt_PVIV);
3205 sv_upgrade(dstr, SVt_PV);
3208 if (dtype < SVt_PVIV)
3209 sv_upgrade(dstr, SVt_PVIV);
3212 if (dtype < SVt_PVNV)
3213 sv_upgrade(dstr, SVt_PVNV);
3220 const char * const type = sv_reftype(sstr,0);
3222 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3224 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3229 if (dtype <= SVt_PVGV) {
3230 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3235 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3237 if ((int)SvTYPE(sstr) != stype) {
3238 stype = SvTYPE(sstr);
3239 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3240 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3243 if (stype == SVt_PVLV)
3244 SvUPGRADE(dstr, SVt_PVNV);
3246 SvUPGRADE(dstr, (U32)stype);
3249 sflags = SvFLAGS(sstr);
3251 if (sflags & SVf_ROK) {
3252 if (dtype >= SVt_PV) {
3253 if (dtype == SVt_PVGV)
3254 return S_pvgv_assign(aTHX_ dstr, sstr);
3255 if (SvPVX_const(dstr)) {
3261 (void)SvOK_off(dstr);
3262 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3264 if (sflags & SVp_NOK) {
3266 /* Only set the public OK flag if the source has public OK. */
3267 if (sflags & SVf_NOK)
3268 SvFLAGS(dstr) |= SVf_NOK;
3269 SvNV_set(dstr, SvNVX(sstr));
3271 if (sflags & SVp_IOK) {
3272 (void)SvIOKp_on(dstr);
3273 if (sflags & SVf_IOK)
3274 SvFLAGS(dstr) |= SVf_IOK;
3275 if (sflags & SVf_IVisUV)
3277 SvIV_set(dstr, SvIVX(sstr));
3279 if (SvAMAGIC(sstr)) {
3283 else if (sflags & SVp_POK) {
3287 * Check to see if we can just swipe the string. If so, it's a
3288 * possible small lose on short strings, but a big win on long ones.
3289 * It might even be a win on short strings if SvPVX_const(dstr)
3290 * has to be allocated and SvPVX_const(sstr) has to be freed.
3293 /* Whichever path we take through the next code, we want this true,
3294 and doing it now facilitates the COW check. */
3295 (void)SvPOK_only(dstr);
3298 /* We're not already COW */
3299 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3300 #ifndef PERL_OLD_COPY_ON_WRITE
3301 /* or we are, but dstr isn't a suitable target. */
3302 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3307 (sflags & SVs_TEMP) && /* slated for free anyway? */
3308 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3309 (!(flags & SV_NOSTEAL)) &&
3310 /* and we're allowed to steal temps */
3311 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3312 SvLEN(sstr) && /* and really is a string */
3313 /* and won't be needed again, potentially */
3314 !(PL_op && PL_op->op_type == OP_AASSIGN))
3315 #ifdef PERL_OLD_COPY_ON_WRITE
3316 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3317 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3318 && SvTYPE(sstr) >= SVt_PVIV)
3321 /* Failed the swipe test, and it's not a shared hash key either.
3322 Have to copy the string. */
3323 STRLEN len = SvCUR(sstr);
3324 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3325 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3326 SvCUR_set(dstr, len);
3327 *SvEND(dstr) = '\0';
3329 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3331 /* Either it's a shared hash key, or it's suitable for
3332 copy-on-write or we can swipe the string. */
3334 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3338 #ifdef PERL_OLD_COPY_ON_WRITE
3340 /* I believe I should acquire a global SV mutex if
3341 it's a COW sv (not a shared hash key) to stop
3342 it going un copy-on-write.
3343 If the source SV has gone un copy on write between up there
3344 and down here, then (assert() that) it is of the correct
3345 form to make it copy on write again */
3346 if ((sflags & (SVf_FAKE | SVf_READONLY))
3347 != (SVf_FAKE | SVf_READONLY)) {
3348 SvREADONLY_on(sstr);
3350 /* Make the source SV into a loop of 1.
3351 (about to become 2) */
3352 SV_COW_NEXT_SV_SET(sstr, sstr);
3356 /* Initial code is common. */
3357 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3362 /* making another shared SV. */
3363 STRLEN cur = SvCUR(sstr);
3364 STRLEN len = SvLEN(sstr);
3365 #ifdef PERL_OLD_COPY_ON_WRITE
3367 assert (SvTYPE(dstr) >= SVt_PVIV);
3368 /* SvIsCOW_normal */
3369 /* splice us in between source and next-after-source. */
3370 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3371 SV_COW_NEXT_SV_SET(sstr, dstr);
3372 SvPV_set(dstr, SvPVX_mutable(sstr));
3376 /* SvIsCOW_shared_hash */
3377 DEBUG_C(PerlIO_printf(Perl_debug_log,
3378 "Copy on write: Sharing hash\n"));
3380 assert (SvTYPE(dstr) >= SVt_PV);
3382 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3384 SvLEN_set(dstr, len);
3385 SvCUR_set(dstr, cur);
3386 SvREADONLY_on(dstr);
3388 /* Relesase a global SV mutex. */
3391 { /* Passes the swipe test. */
3392 SvPV_set(dstr, SvPVX_mutable(sstr));
3393 SvLEN_set(dstr, SvLEN(sstr));
3394 SvCUR_set(dstr, SvCUR(sstr));
3397 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3398 SvPV_set(sstr, NULL);
3404 if (sflags & SVf_UTF8)
3406 if (sflags & SVp_NOK) {
3408 if (sflags & SVf_NOK)
3409 SvFLAGS(dstr) |= SVf_NOK;
3410 SvNV_set(dstr, SvNVX(sstr));
3412 if (sflags & SVp_IOK) {
3413 (void)SvIOKp_on(dstr);
3414 if (sflags & SVf_IOK)
3415 SvFLAGS(dstr) |= SVf_IOK;
3416 if (sflags & SVf_IVisUV)
3418 SvIV_set(dstr, SvIVX(sstr));
3421 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3422 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3423 smg->mg_ptr, smg->mg_len);
3424 SvRMAGICAL_on(dstr);
3427 else if (sflags & SVp_IOK) {
3428 if (sflags & SVf_IOK)
3429 (void)SvIOK_only(dstr);
3431 (void)SvOK_off(dstr);
3432 (void)SvIOKp_on(dstr);
3434 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3435 if (sflags & SVf_IVisUV)
3437 SvIV_set(dstr, SvIVX(sstr));
3438 if (sflags & SVp_NOK) {
3439 if (sflags & SVf_NOK)
3440 (void)SvNOK_on(dstr);
3442 (void)SvNOKp_on(dstr);
3443 SvNV_set(dstr, SvNVX(sstr));
3446 else if (sflags & SVp_NOK) {
3447 if (sflags & SVf_NOK)
3448 (void)SvNOK_only(dstr);
3450 (void)SvOK_off(dstr);
3453 SvNV_set(dstr, SvNVX(sstr));
3456 if (dtype == SVt_PVGV) {
3457 if (ckWARN(WARN_MISC))
3458 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3461 (void)SvOK_off(dstr);
3463 if (SvTAINTED(sstr))
3468 =for apidoc sv_setsv_mg
3470 Like C<sv_setsv>, but also handles 'set' magic.
3476 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3478 sv_setsv(dstr,sstr);
3482 #ifdef PERL_OLD_COPY_ON_WRITE
3484 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3486 STRLEN cur = SvCUR(sstr);
3487 STRLEN len = SvLEN(sstr);
3488 register char *new_pv;
3491 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3499 if (SvTHINKFIRST(dstr))
3500 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3501 else if (SvPVX_const(dstr))
3502 Safefree(SvPVX_const(dstr));
3506 SvUPGRADE(dstr, SVt_PVIV);
3508 assert (SvPOK(sstr));
3509 assert (SvPOKp(sstr));
3510 assert (!SvIOK(sstr));
3511 assert (!SvIOKp(sstr));
3512 assert (!SvNOK(sstr));
3513 assert (!SvNOKp(sstr));
3515 if (SvIsCOW(sstr)) {
3517 if (SvLEN(sstr) == 0) {
3518 /* source is a COW shared hash key. */
3519 DEBUG_C(PerlIO_printf(Perl_debug_log,
3520 "Fast copy on write: Sharing hash\n"));
3521 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3524 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3526 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3527 SvUPGRADE(sstr, SVt_PVIV);
3528 SvREADONLY_on(sstr);
3530 DEBUG_C(PerlIO_printf(Perl_debug_log,
3531 "Fast copy on write: Converting sstr to COW\n"));
3532 SV_COW_NEXT_SV_SET(dstr, sstr);
3534 SV_COW_NEXT_SV_SET(sstr, dstr);
3535 new_pv = SvPVX_mutable(sstr);
3538 SvPV_set(dstr, new_pv);
3539 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3542 SvLEN_set(dstr, len);
3543 SvCUR_set(dstr, cur);
3552 =for apidoc sv_setpvn
3554 Copies a string into an SV. The C<len> parameter indicates the number of
3555 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3556 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3562 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3565 register char *dptr;
3567 SV_CHECK_THINKFIRST_COW_DROP(sv);
3573 /* len is STRLEN which is unsigned, need to copy to signed */
3576 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3578 SvUPGRADE(sv, SVt_PV);
3580 dptr = SvGROW(sv, len + 1);
3581 Move(ptr,dptr,len,char);
3584 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3589 =for apidoc sv_setpvn_mg
3591 Like C<sv_setpvn>, but also handles 'set' magic.
3597 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3599 sv_setpvn(sv,ptr,len);
3604 =for apidoc sv_setpv
3606 Copies a string into an SV. The string must be null-terminated. Does not
3607 handle 'set' magic. See C<sv_setpv_mg>.
3613 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3616 register STRLEN len;
3618 SV_CHECK_THINKFIRST_COW_DROP(sv);
3624 SvUPGRADE(sv, SVt_PV);
3626 SvGROW(sv, len + 1);
3627 Move(ptr,SvPVX(sv),len+1,char);
3629 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3634 =for apidoc sv_setpv_mg
3636 Like C<sv_setpv>, but also handles 'set' magic.
3642 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3649 =for apidoc sv_usepvn
3651 Tells an SV to use C<ptr> to find its string value. Normally the string is
3652 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3653 The C<ptr> should point to memory that was allocated by C<malloc>. The
3654 string length, C<len>, must be supplied. This function will realloc the
3655 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3656 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3657 See C<sv_usepvn_mg>.
3663 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3667 SV_CHECK_THINKFIRST_COW_DROP(sv);
3668 SvUPGRADE(sv, SVt_PV);
3673 if (SvPVX_const(sv))
3676 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3677 ptr = saferealloc (ptr, allocate);
3680 SvLEN_set(sv, allocate);
3682 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3687 =for apidoc sv_usepvn_mg
3689 Like C<sv_usepvn>, but also handles 'set' magic.
3695 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3697 sv_usepvn(sv,ptr,len);
3701 #ifdef PERL_OLD_COPY_ON_WRITE
3702 /* Need to do this *after* making the SV normal, as we need the buffer
3703 pointer to remain valid until after we've copied it. If we let go too early,
3704 another thread could invalidate it by unsharing last of the same hash key
3705 (which it can do by means other than releasing copy-on-write Svs)
3706 or by changing the other copy-on-write SVs in the loop. */
3708 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3710 if (len) { /* this SV was SvIsCOW_normal(sv) */
3711 /* we need to find the SV pointing to us. */
3712 SV * const current = SV_COW_NEXT_SV(after);
3714 if (current == sv) {
3715 /* The SV we point to points back to us (there were only two of us
3717 Hence other SV is no longer copy on write either. */
3719 SvREADONLY_off(after);
3721 /* We need to follow the pointers around the loop. */
3723 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3726 /* don't loop forever if the structure is bust, and we have
3727 a pointer into a closed loop. */
3728 assert (current != after);
3729 assert (SvPVX_const(current) == pvx);
3731 /* Make the SV before us point to the SV after us. */
3732 SV_COW_NEXT_SV_SET(current, after);
3735 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3740 Perl_sv_release_IVX(pTHX_ register SV *sv)
3743 sv_force_normal_flags(sv, 0);
3749 =for apidoc sv_force_normal_flags
3751 Undo various types of fakery on an SV: if the PV is a shared string, make
3752 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3753 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3754 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3755 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3756 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3757 set to some other value.) In addition, the C<flags> parameter gets passed to
3758 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3759 with flags set to 0.
3765 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3768 #ifdef PERL_OLD_COPY_ON_WRITE
3769 if (SvREADONLY(sv)) {
3770 /* At this point I believe I should acquire a global SV mutex. */
3772 const char * const pvx = SvPVX_const(sv);
3773 const STRLEN len = SvLEN(sv);
3774 const STRLEN cur = SvCUR(sv);
3775 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3777 PerlIO_printf(Perl_debug_log,
3778 "Copy on write: Force normal %ld\n",
3784 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3787 if (flags & SV_COW_DROP_PV) {
3788 /* OK, so we don't need to copy our buffer. */
3791 SvGROW(sv, cur + 1);
3792 Move(pvx,SvPVX(sv),cur,char);
3796 sv_release_COW(sv, pvx, len, next);
3801 else if (IN_PERL_RUNTIME)
3802 Perl_croak(aTHX_ PL_no_modify);
3803 /* At this point I believe that I can drop the global SV mutex. */
3806 if (SvREADONLY(sv)) {
3808 const char * const pvx = SvPVX_const(sv);
3809 const STRLEN len = SvCUR(sv);
3812 SvPV_set(sv, Nullch);
3814 SvGROW(sv, len + 1);
3815 Move(pvx,SvPVX(sv),len,char);
3817 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3819 else if (IN_PERL_RUNTIME)
3820 Perl_croak(aTHX_ PL_no_modify);
3824 sv_unref_flags(sv, flags);
3825 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3832 Efficient removal of characters from the beginning of the string buffer.
3833 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3834 the string buffer. The C<ptr> becomes the first character of the adjusted
3835 string. Uses the "OOK hack".
3836 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3837 refer to the same chunk of data.
3843 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3845 register STRLEN delta;
3846 if (!ptr || !SvPOKp(sv))
3848 delta = ptr - SvPVX_const(sv);
3849 SV_CHECK_THINKFIRST(sv);
3850 if (SvTYPE(sv) < SVt_PVIV)
3851 sv_upgrade(sv,SVt_PVIV);
3854 if (!SvLEN(sv)) { /* make copy of shared string */
3855 const char *pvx = SvPVX_const(sv);
3856 const STRLEN len = SvCUR(sv);
3857 SvGROW(sv, len + 1);
3858 Move(pvx,SvPVX(sv),len,char);
3862 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3863 and we do that anyway inside the SvNIOK_off
3865 SvFLAGS(sv) |= SVf_OOK;
3868 SvLEN_set(sv, SvLEN(sv) - delta);
3869 SvCUR_set(sv, SvCUR(sv) - delta);
3870 SvPV_set(sv, SvPVX(sv) + delta);
3871 SvIV_set(sv, SvIVX(sv) + delta);
3875 =for apidoc sv_catpvn
3877 Concatenates the string onto the end of the string which is in the SV. The
3878 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3879 status set, then the bytes appended should be valid UTF-8.
3880 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3882 =for apidoc sv_catpvn_flags
3884 Concatenates the string onto the end of the string which is in the SV. The
3885 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3886 status set, then the bytes appended should be valid UTF-8.
3887 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3888 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3889 in terms of this function.
3895 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3899 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3901 SvGROW(dsv, dlen + slen + 1);
3903 sstr = SvPVX_const(dsv);
3904 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3905 SvCUR_set(dsv, SvCUR(dsv) + slen);
3907 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3909 if (flags & SV_SMAGIC)
3914 =for apidoc sv_catsv
3916 Concatenates the string from SV C<ssv> onto the end of the string in
3917 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3918 not 'set' magic. See C<sv_catsv_mg>.
3920 =for apidoc sv_catsv_flags
3922 Concatenates the string from SV C<ssv> onto the end of the string in
3923 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3924 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3925 and C<sv_catsv_nomg> are implemented in terms of this function.
3930 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3935 const char *spv = SvPV_const(ssv, slen);
3937 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3938 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3939 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3940 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3941 dsv->sv_flags doesn't have that bit set.
3942 Andy Dougherty 12 Oct 2001
3944 const I32 sutf8 = DO_UTF8(ssv);
3947 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3949 dutf8 = DO_UTF8(dsv);
3951 if (dutf8 != sutf8) {
3953 /* Not modifying source SV, so taking a temporary copy. */
3954 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3956 sv_utf8_upgrade(csv);
3957 spv = SvPV_const(csv, slen);
3960 sv_utf8_upgrade_nomg(dsv);
3962 sv_catpvn_nomg(dsv, spv, slen);
3965 if (flags & SV_SMAGIC)
3970 =for apidoc sv_catpv
3972 Concatenates the string onto the end of the string which is in the SV.
3973 If the SV has the UTF-8 status set, then the bytes appended should be
3974 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3979 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3982 register STRLEN len;
3988 junk = SvPV_force(sv, tlen);
3990 SvGROW(sv, tlen + len + 1);
3992 ptr = SvPVX_const(sv);
3993 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3994 SvCUR_set(sv, SvCUR(sv) + len);
3995 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4000 =for apidoc sv_catpv_mg
4002 Like C<sv_catpv>, but also handles 'set' magic.
4008 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4017 Creates a new SV. A non-zero C<len> parameter indicates the number of
4018 bytes of preallocated string space the SV should have. An extra byte for a
4019 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4020 space is allocated.) The reference count for the new SV is set to 1.
4022 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4023 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4024 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4025 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4026 modules supporting older perls.
4032 Perl_newSV(pTHX_ STRLEN len)
4039 sv_upgrade(sv, SVt_PV);
4040 SvGROW(sv, len + 1);
4045 =for apidoc sv_magicext
4047 Adds magic to an SV, upgrading it if necessary. Applies the
4048 supplied vtable and returns a pointer to the magic added.
4050 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4051 In particular, you can add magic to SvREADONLY SVs, and add more than
4052 one instance of the same 'how'.
4054 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4055 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4056 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4057 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4059 (This is now used as a subroutine by C<sv_magic>.)
4064 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4065 const char* name, I32 namlen)
4070 if (SvTYPE(sv) < SVt_PVMG) {
4071 SvUPGRADE(sv, SVt_PVMG);
4073 Newxz(mg, 1, MAGIC);
4074 mg->mg_moremagic = SvMAGIC(sv);
4075 SvMAGIC_set(sv, mg);
4077 /* Sometimes a magic contains a reference loop, where the sv and
4078 object refer to each other. To prevent a reference loop that
4079 would prevent such objects being freed, we look for such loops
4080 and if we find one we avoid incrementing the object refcount.
4082 Note we cannot do this to avoid self-tie loops as intervening RV must
4083 have its REFCNT incremented to keep it in existence.
4086 if (!obj || obj == sv ||
4087 how == PERL_MAGIC_arylen ||
4088 how == PERL_MAGIC_qr ||
4089 how == PERL_MAGIC_symtab ||
4090 (SvTYPE(obj) == SVt_PVGV &&
4091 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4092 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4093 GvFORM(obj) == (CV*)sv)))
4098 mg->mg_obj = SvREFCNT_inc(obj);
4099 mg->mg_flags |= MGf_REFCOUNTED;
4102 /* Normal self-ties simply pass a null object, and instead of
4103 using mg_obj directly, use the SvTIED_obj macro to produce a
4104 new RV as needed. For glob "self-ties", we are tieing the PVIO
4105 with an RV obj pointing to the glob containing the PVIO. In
4106 this case, to avoid a reference loop, we need to weaken the
4110 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4111 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4117 mg->mg_len = namlen;
4120 mg->mg_ptr = savepvn(name, namlen);
4121 else if (namlen == HEf_SVKEY)
4122 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4124 mg->mg_ptr = (char *) name;
4126 mg->mg_virtual = vtable;
4130 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4135 =for apidoc sv_magic
4137 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4138 then adds a new magic item of type C<how> to the head of the magic list.
4140 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4141 handling of the C<name> and C<namlen> arguments.
4143 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4144 to add more than one instance of the same 'how'.
4150 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4156 #ifdef PERL_OLD_COPY_ON_WRITE
4158 sv_force_normal_flags(sv, 0);
4160 if (SvREADONLY(sv)) {
4162 /* its okay to attach magic to shared strings; the subsequent
4163 * upgrade to PVMG will unshare the string */
4164 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4167 && how != PERL_MAGIC_regex_global
4168 && how != PERL_MAGIC_bm
4169 && how != PERL_MAGIC_fm
4170 && how != PERL_MAGIC_sv
4171 && how != PERL_MAGIC_backref
4174 Perl_croak(aTHX_ PL_no_modify);
4177 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4178 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4179 /* sv_magic() refuses to add a magic of the same 'how' as an
4182 if (how == PERL_MAGIC_taint)
4190 vtable = &PL_vtbl_sv;
4192 case PERL_MAGIC_overload:
4193 vtable = &PL_vtbl_amagic;
4195 case PERL_MAGIC_overload_elem:
4196 vtable = &PL_vtbl_amagicelem;
4198 case PERL_MAGIC_overload_table:
4199 vtable = &PL_vtbl_ovrld;
4202 vtable = &PL_vtbl_bm;
4204 case PERL_MAGIC_regdata:
4205 vtable = &PL_vtbl_regdata;
4207 case PERL_MAGIC_regdatum:
4208 vtable = &PL_vtbl_regdatum;
4210 case PERL_MAGIC_env:
4211 vtable = &PL_vtbl_env;
4214 vtable = &PL_vtbl_fm;
4216 case PERL_MAGIC_envelem:
4217 vtable = &PL_vtbl_envelem;
4219 case PERL_MAGIC_regex_global:
4220 vtable = &PL_vtbl_mglob;
4222 case PERL_MAGIC_isa:
4223 vtable = &PL_vtbl_isa;
4225 case PERL_MAGIC_isaelem:
4226 vtable = &PL_vtbl_isaelem;
4228 case PERL_MAGIC_nkeys:
4229 vtable = &PL_vtbl_nkeys;
4231 case PERL_MAGIC_dbfile:
4234 case PERL_MAGIC_dbline:
4235 vtable = &PL_vtbl_dbline;
4237 #ifdef USE_LOCALE_COLLATE
4238 case PERL_MAGIC_collxfrm:
4239 vtable = &PL_vtbl_collxfrm;
4241 #endif /* USE_LOCALE_COLLATE */
4242 case PERL_MAGIC_tied:
4243 vtable = &PL_vtbl_pack;
4245 case PERL_MAGIC_tiedelem:
4246 case PERL_MAGIC_tiedscalar:
4247 vtable = &PL_vtbl_packelem;
4250 vtable = &PL_vtbl_regexp;
4252 case PERL_MAGIC_sig:
4253 vtable = &PL_vtbl_sig;
4255 case PERL_MAGIC_sigelem:
4256 vtable = &PL_vtbl_sigelem;
4258 case PERL_MAGIC_taint:
4259 vtable = &PL_vtbl_taint;
4261 case PERL_MAGIC_uvar:
4262 vtable = &PL_vtbl_uvar;
4264 case PERL_MAGIC_vec:
4265 vtable = &PL_vtbl_vec;
4267 case PERL_MAGIC_arylen_p:
4268 case PERL_MAGIC_rhash:
4269 case PERL_MAGIC_symtab:
4270 case PERL_MAGIC_vstring:
4273 case PERL_MAGIC_utf8:
4274 vtable = &PL_vtbl_utf8;
4276 case PERL_MAGIC_substr:
4277 vtable = &PL_vtbl_substr;
4279 case PERL_MAGIC_defelem:
4280 vtable = &PL_vtbl_defelem;
4282 case PERL_MAGIC_glob:
4283 vtable = &PL_vtbl_glob;
4285 case PERL_MAGIC_arylen:
4286 vtable = &PL_vtbl_arylen;
4288 case PERL_MAGIC_pos:
4289 vtable = &PL_vtbl_pos;
4291 case PERL_MAGIC_backref:
4292 vtable = &PL_vtbl_backref;
4294 case PERL_MAGIC_ext:
4295 /* Reserved for use by extensions not perl internals. */
4296 /* Useful for attaching extension internal data to perl vars. */
4297 /* Note that multiple extensions may clash if magical scalars */
4298 /* etc holding private data from one are passed to another. */
4302 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4305 /* Rest of work is done else where */
4306 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4309 case PERL_MAGIC_taint:
4312 case PERL_MAGIC_ext:
4313 case PERL_MAGIC_dbfile:
4320 =for apidoc sv_unmagic
4322 Removes all magic of type C<type> from an SV.
4328 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4332 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4335 for (mg = *mgp; mg; mg = *mgp) {
4336 if (mg->mg_type == type) {
4337 const MGVTBL* const vtbl = mg->mg_virtual;
4338 *mgp = mg->mg_moremagic;
4339 if (vtbl && vtbl->svt_free)
4340 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4341 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4343 Safefree(mg->mg_ptr);
4344 else if (mg->mg_len == HEf_SVKEY)
4345 SvREFCNT_dec((SV*)mg->mg_ptr);
4346 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4347 Safefree(mg->mg_ptr);
4349 if (mg->mg_flags & MGf_REFCOUNTED)
4350 SvREFCNT_dec(mg->mg_obj);
4354 mgp = &mg->mg_moremagic;
4358 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4359 SvMAGIC_set(sv, NULL);
4366 =for apidoc sv_rvweaken
4368 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4369 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4370 push a back-reference to this RV onto the array of backreferences
4371 associated with that magic.
4377 Perl_sv_rvweaken(pTHX_ SV *sv)
4380 if (!SvOK(sv)) /* let undefs pass */
4383 Perl_croak(aTHX_ "Can't weaken a nonreference");
4384 else if (SvWEAKREF(sv)) {
4385 if (ckWARN(WARN_MISC))
4386 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4390 Perl_sv_add_backref(aTHX_ tsv, sv);
4396 /* Give tsv backref magic if it hasn't already got it, then push a
4397 * back-reference to sv onto the array associated with the backref magic.
4401 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4406 if (SvTYPE(tsv) == SVt_PVHV) {
4407 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4411 /* There is no AV in the offical place - try a fixup. */
4412 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4415 /* Aha. They've got it stowed in magic. Bring it back. */
4416 av = (AV*)mg->mg_obj;
4417 /* Stop mg_free decreasing the refernce count. */
4419 /* Stop mg_free even calling the destructor, given that
4420 there's no AV to free up. */
4422 sv_unmagic(tsv, PERL_MAGIC_backref);
4431 const MAGIC *const mg
4432 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4434 av = (AV*)mg->mg_obj;
4438 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4439 /* av now has a refcnt of 2, which avoids it getting freed
4440 * before us during global cleanup. The extra ref is removed
4441 * by magic_killbackrefs() when tsv is being freed */
4444 if (AvFILLp(av) >= AvMAX(av)) {
4445 av_extend(av, AvFILLp(av)+1);
4447 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4450 /* delete a back-reference to ourselves from the backref magic associated
4451 * with the SV we point to.
4455 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4462 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4463 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4464 /* We mustn't attempt to "fix up" the hash here by moving the
4465 backreference array back to the hv_aux structure, as that is stored
4466 in the main HvARRAY(), and hfreentries assumes that no-one
4467 reallocates HvARRAY() while it is running. */
4470 const MAGIC *const mg
4471 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4473 av = (AV *)mg->mg_obj;
4476 if (PL_in_clean_all)
4478 Perl_croak(aTHX_ "panic: del_backref");
4485 /* We shouldn't be in here more than once, but for paranoia reasons lets
4487 for (i = AvFILLp(av); i >= 0; i--) {
4489 const SSize_t fill = AvFILLp(av);
4491 /* We weren't the last entry.
4492 An unordered list has this property that you can take the
4493 last element off the end to fill the hole, and it's still
4494 an unordered list :-)
4499 AvFILLp(av) = fill - 1;
4505 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4507 SV **svp = AvARRAY(av);
4509 PERL_UNUSED_ARG(sv);
4511 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4512 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4513 if (svp && !SvIS_FREED(av)) {
4514 SV *const *const last = svp + AvFILLp(av);
4516 while (svp <= last) {
4518 SV *const referrer = *svp;
4519 if (SvWEAKREF(referrer)) {
4520 /* XXX Should we check that it hasn't changed? */
4521 SvRV_set(referrer, 0);
4523 SvWEAKREF_off(referrer);
4524 } else if (SvTYPE(referrer) == SVt_PVGV ||
4525 SvTYPE(referrer) == SVt_PVLV) {
4526 /* You lookin' at me? */
4527 assert(GvSTASH(referrer));
4528 assert(GvSTASH(referrer) == (HV*)sv);
4529 GvSTASH(referrer) = 0;
4532 "panic: magic_killbackrefs (flags=%"UVxf")",
4533 (UV)SvFLAGS(referrer));
4541 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4546 =for apidoc sv_insert
4548 Inserts a string at the specified offset/length within the SV. Similar to
4549 the Perl substr() function.
4555 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4560 register char *midend;
4561 register char *bigend;
4567 Perl_croak(aTHX_ "Can't modify non-existent substring");
4568 SvPV_force(bigstr, curlen);
4569 (void)SvPOK_only_UTF8(bigstr);
4570 if (offset + len > curlen) {
4571 SvGROW(bigstr, offset+len+1);
4572 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4573 SvCUR_set(bigstr, offset+len);
4577 i = littlelen - len;
4578 if (i > 0) { /* string might grow */
4579 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4580 mid = big + offset + len;
4581 midend = bigend = big + SvCUR(bigstr);
4584 while (midend > mid) /* shove everything down */
4585 *--bigend = *--midend;
4586 Move(little,big+offset,littlelen,char);
4587 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4592 Move(little,SvPVX(bigstr)+offset,len,char);
4597 big = SvPVX(bigstr);
4600 bigend = big + SvCUR(bigstr);
4602 if (midend > bigend)
4603 Perl_croak(aTHX_ "panic: sv_insert");
4605 if (mid - big > bigend - midend) { /* faster to shorten from end */
4607 Move(little, mid, littlelen,char);
4610 i = bigend - midend;
4612 Move(midend, mid, i,char);
4616 SvCUR_set(bigstr, mid - big);
4618 else if ((i = mid - big)) { /* faster from front */
4619 midend -= littlelen;
4621 sv_chop(bigstr,midend-i);
4626 Move(little, mid, littlelen,char);
4628 else if (littlelen) {
4629 midend -= littlelen;
4630 sv_chop(bigstr,midend);
4631 Move(little,midend,littlelen,char);
4634 sv_chop(bigstr,midend);
4640 =for apidoc sv_replace
4642 Make the first argument a copy of the second, then delete the original.
4643 The target SV physically takes over ownership of the body of the source SV
4644 and inherits its flags; however, the target keeps any magic it owns,
4645 and any magic in the source is discarded.
4646 Note that this is a rather specialist SV copying operation; most of the
4647 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4653 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4656 const U32 refcnt = SvREFCNT(sv);
4657 SV_CHECK_THINKFIRST_COW_DROP(sv);
4658 if (SvREFCNT(nsv) != 1) {
4659 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4660 UVuf " != 1)", (UV) SvREFCNT(nsv));
4662 if (SvMAGICAL(sv)) {
4666 sv_upgrade(nsv, SVt_PVMG);
4667 SvMAGIC_set(nsv, SvMAGIC(sv));
4668 SvFLAGS(nsv) |= SvMAGICAL(sv);
4670 SvMAGIC_set(sv, NULL);
4674 assert(!SvREFCNT(sv));
4675 #ifdef DEBUG_LEAKING_SCALARS
4676 sv->sv_flags = nsv->sv_flags;
4677 sv->sv_any = nsv->sv_any;
4678 sv->sv_refcnt = nsv->sv_refcnt;
4679 sv->sv_u = nsv->sv_u;
4681 StructCopy(nsv,sv,SV);
4683 /* Currently could join these into one piece of pointer arithmetic, but
4684 it would be unclear. */
4685 if(SvTYPE(sv) == SVt_IV)
4687 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4688 else if (SvTYPE(sv) == SVt_RV) {
4689 SvANY(sv) = &sv->sv_u.svu_rv;
4693 #ifdef PERL_OLD_COPY_ON_WRITE
4694 if (SvIsCOW_normal(nsv)) {
4695 /* We need to follow the pointers around the loop to make the
4696 previous SV point to sv, rather than nsv. */
4699 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4702 assert(SvPVX_const(current) == SvPVX_const(nsv));
4704 /* Make the SV before us point to the SV after us. */
4706 PerlIO_printf(Perl_debug_log, "previous is\n");
4708 PerlIO_printf(Perl_debug_log,
4709 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4710 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4712 SV_COW_NEXT_SV_SET(current, sv);
4715 SvREFCNT(sv) = refcnt;
4716 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4722 =for apidoc sv_clear
4724 Clear an SV: call any destructors, free up any memory used by the body,
4725 and free the body itself. The SV's head is I<not> freed, although
4726 its type is set to all 1's so that it won't inadvertently be assumed
4727 to be live during global destruction etc.
4728 This function should only be called when REFCNT is zero. Most of the time
4729 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4736 Perl_sv_clear(pTHX_ register SV *sv)
4739 const U32 type = SvTYPE(sv);
4740 const struct body_details *const sv_type_details
4741 = bodies_by_type + type;
4744 assert(SvREFCNT(sv) == 0);
4750 if (PL_defstash) { /* Still have a symbol table? */
4755 stash = SvSTASH(sv);
4756 destructor = StashHANDLER(stash,DESTROY);
4758 SV* const tmpref = newRV(sv);
4759 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4761 PUSHSTACKi(PERLSI_DESTROY);
4766 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4772 if(SvREFCNT(tmpref) < 2) {
4773 /* tmpref is not kept alive! */
4775 SvRV_set(tmpref, NULL);
4778 SvREFCNT_dec(tmpref);
4780 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4784 if (PL_in_clean_objs)
4785 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4787 /* DESTROY gave object new lease on life */
4793 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4794 SvOBJECT_off(sv); /* Curse the object. */
4795 if (type != SVt_PVIO)
4796 --PL_sv_objcount; /* XXX Might want something more general */
4799 if (type >= SVt_PVMG) {
4802 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4803 SvREFCNT_dec(SvSTASH(sv));
4808 IoIFP(sv) != PerlIO_stdin() &&
4809 IoIFP(sv) != PerlIO_stdout() &&
4810 IoIFP(sv) != PerlIO_stderr())
4812 io_close((IO*)sv, FALSE);
4814 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4815 PerlDir_close(IoDIRP(sv));
4816 IoDIRP(sv) = (DIR*)NULL;
4817 Safefree(IoTOP_NAME(sv));
4818 Safefree(IoFMT_NAME(sv));
4819 Safefree(IoBOTTOM_NAME(sv));
4828 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4835 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4836 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4837 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4838 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4840 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4841 SvREFCNT_dec(LvTARG(sv));
4845 Safefree(GvNAME(sv));
4846 /* If we're in a stash, we don't own a reference to it. However it does
4847 have a back reference to us, which needs to be cleared. */
4849 sv_del_backref((SV*)GvSTASH(sv), sv);
4854 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4856 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4857 /* Don't even bother with turning off the OOK flag. */
4862 SV *target = SvRV(sv);
4864 sv_del_backref(target, sv);
4866 SvREFCNT_dec(target);
4868 #ifdef PERL_OLD_COPY_ON_WRITE
4869 else if (SvPVX_const(sv)) {
4871 /* I believe I need to grab the global SV mutex here and
4872 then recheck the COW status. */
4874 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4877 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4878 SV_COW_NEXT_SV(sv));
4879 /* And drop it here. */
4881 } else if (SvLEN(sv)) {
4882 Safefree(SvPVX_const(sv));
4886 else if (SvPVX_const(sv) && SvLEN(sv))
4887 Safefree(SvPVX_mutable(sv));
4888 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4889 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4898 SvFLAGS(sv) &= SVf_BREAK;
4899 SvFLAGS(sv) |= SVTYPEMASK;
4901 if (sv_type_details->arena) {
4902 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4903 &PL_body_roots[type]);
4905 else if (sv_type_details->size) {
4906 my_safefree(SvANY(sv));
4911 =for apidoc sv_newref
4913 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4920 Perl_sv_newref(pTHX_ SV *sv)
4930 Decrement an SV's reference count, and if it drops to zero, call
4931 C<sv_clear> to invoke destructors and free up any memory used by
4932 the body; finally, deallocate the SV's head itself.
4933 Normally called via a wrapper macro C<SvREFCNT_dec>.
4939 Perl_sv_free(pTHX_ SV *sv)
4944 if (SvREFCNT(sv) == 0) {
4945 if (SvFLAGS(sv) & SVf_BREAK)
4946 /* this SV's refcnt has been artificially decremented to
4947 * trigger cleanup */
4949 if (PL_in_clean_all) /* All is fair */
4951 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4952 /* make sure SvREFCNT(sv)==0 happens very seldom */
4953 SvREFCNT(sv) = (~(U32)0)/2;
4956 if (ckWARN_d(WARN_INTERNAL)) {
4957 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4958 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4959 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4960 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4961 Perl_dump_sv_child(aTHX_ sv);
4966 if (--(SvREFCNT(sv)) > 0)
4968 Perl_sv_free2(aTHX_ sv);
4972 Perl_sv_free2(pTHX_ SV *sv)
4977 if (ckWARN_d(WARN_DEBUGGING))
4978 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4979 "Attempt to free temp prematurely: SV 0x%"UVxf
4980 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4984 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4985 /* make sure SvREFCNT(sv)==0 happens very seldom */
4986 SvREFCNT(sv) = (~(U32)0)/2;
4997 Returns the length of the string in the SV. Handles magic and type
4998 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5004 Perl_sv_len(pTHX_ register SV *sv)
5012 len = mg_length(sv);
5014 (void)SvPV_const(sv, len);
5019 =for apidoc sv_len_utf8
5021 Returns the number of characters in the string in an SV, counting wide
5022 UTF-8 bytes as a single character. Handles magic and type coercion.
5028 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5029 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5030 * (Note that the mg_len is not the length of the mg_ptr field.)
5035 Perl_sv_len_utf8(pTHX_ register SV *sv)
5041 return mg_length(sv);
5045 const U8 *s = (U8*)SvPV_const(sv, len);
5046 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5048 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5050 #ifdef PERL_UTF8_CACHE_ASSERT
5051 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5055 ulen = Perl_utf8_length(aTHX_ s, s + len);
5056 if (!mg && !SvREADONLY(sv)) {
5057 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5058 mg = mg_find(sv, PERL_MAGIC_utf8);
5068 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5069 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5070 * between UTF-8 and byte offsets. There are two (substr offset and substr
5071 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5072 * and byte offset) cache positions.
5074 * The mg_len field is used by sv_len_utf8(), see its comments.
5075 * Note that the mg_len is not the length of the mg_ptr field.
5079 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5080 I32 offsetp, const U8 *s, const U8 *start)
5084 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5086 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5090 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5092 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5093 (*mgp)->mg_ptr = (char *) *cachep;
5097 (*cachep)[i] = offsetp;
5098 (*cachep)[i+1] = s - start;
5106 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5107 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5108 * between UTF-8 and byte offsets. See also the comments of
5109 * S_utf8_mg_pos_init().
5113 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)
5117 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5119 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5120 if (*mgp && (*mgp)->mg_ptr) {
5121 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5122 ASSERT_UTF8_CACHE(*cachep);
5123 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5125 else { /* We will skip to the right spot. */
5130 /* The assumption is that going backward is half
5131 * the speed of going forward (that's where the
5132 * 2 * backw in the below comes from). (The real
5133 * figure of course depends on the UTF-8 data.) */
5135 if ((*cachep)[i] > (STRLEN)uoff) {
5137 backw = (*cachep)[i] - (STRLEN)uoff;
5139 if (forw < 2 * backw)
5142 p = start + (*cachep)[i+1];
5144 /* Try this only for the substr offset (i == 0),
5145 * not for the substr length (i == 2). */
5146 else if (i == 0) { /* (*cachep)[i] < uoff */
5147 const STRLEN ulen = sv_len_utf8(sv);
5149 if ((STRLEN)uoff < ulen) {
5150 forw = (STRLEN)uoff - (*cachep)[i];
5151 backw = ulen - (STRLEN)uoff;
5153 if (forw < 2 * backw)
5154 p = start + (*cachep)[i+1];
5159 /* If the string is not long enough for uoff,
5160 * we could extend it, but not at this low a level. */
5164 if (forw < 2 * backw) {
5171 while (UTF8_IS_CONTINUATION(*p))
5176 /* Update the cache. */
5177 (*cachep)[i] = (STRLEN)uoff;
5178 (*cachep)[i+1] = p - start;
5180 /* Drop the stale "length" cache */
5189 if (found) { /* Setup the return values. */
5190 *offsetp = (*cachep)[i+1];
5191 *sp = start + *offsetp;
5194 *offsetp = send - start;
5196 else if (*sp < start) {
5202 #ifdef PERL_UTF8_CACHE_ASSERT
5207 while (n-- && s < send)
5211 assert(*offsetp == s - start);
5212 assert((*cachep)[0] == (STRLEN)uoff);
5213 assert((*cachep)[1] == *offsetp);
5215 ASSERT_UTF8_CACHE(*cachep);
5224 =for apidoc sv_pos_u2b
5226 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5227 the start of the string, to a count of the equivalent number of bytes; if
5228 lenp is non-zero, it does the same to lenp, but this time starting from
5229 the offset, rather than from the start of the string. Handles magic and
5236 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5237 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5238 * byte offsets. See also the comments of S_utf8_mg_pos().
5243 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5251 start = (U8*)SvPV_const(sv, len);
5254 STRLEN *cache = NULL;
5255 const U8 *s = start;
5256 I32 uoffset = *offsetp;
5257 const U8 * const send = s + len;
5259 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5261 if (!found && uoffset > 0) {
5262 while (s < send && uoffset--)
5266 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5268 *offsetp = s - start;
5273 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5277 if (!found && *lenp > 0) {
5280 while (s < send && ulen--)
5284 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5288 ASSERT_UTF8_CACHE(cache);
5300 =for apidoc sv_pos_b2u
5302 Converts the value pointed to by offsetp from a count of bytes from the
5303 start of the string, to a count of the equivalent number of UTF-8 chars.
5304 Handles magic and type coercion.
5310 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5311 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5312 * byte offsets. See also the comments of S_utf8_mg_pos().
5317 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5325 s = (const U8*)SvPV_const(sv, len);
5326 if ((I32)len < *offsetp)
5327 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5329 const U8* send = s + *offsetp;
5331 STRLEN *cache = NULL;
5335 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5336 mg = mg_find(sv, PERL_MAGIC_utf8);
5337 if (mg && mg->mg_ptr) {
5338 cache = (STRLEN *) mg->mg_ptr;
5339 if (cache[1] == (STRLEN)*offsetp) {
5340 /* An exact match. */
5341 *offsetp = cache[0];
5345 else if (cache[1] < (STRLEN)*offsetp) {
5346 /* We already know part of the way. */
5349 /* Let the below loop do the rest. */
5351 else { /* cache[1] > *offsetp */
5352 /* We already know all of the way, now we may
5353 * be able to walk back. The same assumption
5354 * is made as in S_utf8_mg_pos(), namely that
5355 * walking backward is twice slower than
5356 * walking forward. */
5357 const STRLEN forw = *offsetp;
5358 STRLEN backw = cache[1] - *offsetp;
5360 if (!(forw < 2 * backw)) {
5361 const U8 *p = s + cache[1];
5368 while (UTF8_IS_CONTINUATION(*p)) {
5376 *offsetp = cache[0];
5378 /* Drop the stale "length" cache */
5386 ASSERT_UTF8_CACHE(cache);
5392 /* Call utf8n_to_uvchr() to validate the sequence
5393 * (unless a simple non-UTF character) */
5394 if (!UTF8_IS_INVARIANT(*s))
5395 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5404 if (!SvREADONLY(sv)) {
5406 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5407 mg = mg_find(sv, PERL_MAGIC_utf8);
5412 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5413 mg->mg_ptr = (char *) cache;
5418 cache[1] = *offsetp;
5419 /* Drop the stale "length" cache */
5432 Returns a boolean indicating whether the strings in the two SVs are
5433 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5434 coerce its args to strings if necessary.
5440 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5449 SV* svrecode = Nullsv;
5456 pv1 = SvPV_const(sv1, cur1);
5463 pv2 = SvPV_const(sv2, cur2);
5465 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5466 /* Differing utf8ness.
5467 * Do not UTF8size the comparands as a side-effect. */
5470 svrecode = newSVpvn(pv2, cur2);
5471 sv_recode_to_utf8(svrecode, PL_encoding);
5472 pv2 = SvPV_const(svrecode, cur2);
5475 svrecode = newSVpvn(pv1, cur1);
5476 sv_recode_to_utf8(svrecode, PL_encoding);
5477 pv1 = SvPV_const(svrecode, cur1);
5479 /* Now both are in UTF-8. */
5481 SvREFCNT_dec(svrecode);
5486 bool is_utf8 = TRUE;
5489 /* sv1 is the UTF-8 one,
5490 * if is equal it must be downgrade-able */
5491 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5497 /* sv2 is the UTF-8 one,
5498 * if is equal it must be downgrade-able */
5499 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5505 /* Downgrade not possible - cannot be eq */
5513 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5516 SvREFCNT_dec(svrecode);
5527 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5528 string in C<sv1> is less than, equal to, or greater than the string in
5529 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5530 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5536 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5540 const char *pv1, *pv2;
5543 SV *svrecode = Nullsv;
5550 pv1 = SvPV_const(sv1, cur1);
5557 pv2 = SvPV_const(sv2, cur2);
5559 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5560 /* Differing utf8ness.
5561 * Do not UTF8size the comparands as a side-effect. */
5564 svrecode = newSVpvn(pv2, cur2);
5565 sv_recode_to_utf8(svrecode, PL_encoding);
5566 pv2 = SvPV_const(svrecode, cur2);
5569 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5574 svrecode = newSVpvn(pv1, cur1);
5575 sv_recode_to_utf8(svrecode, PL_encoding);
5576 pv1 = SvPV_const(svrecode, cur1);
5579 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5585 cmp = cur2 ? -1 : 0;
5589 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5592 cmp = retval < 0 ? -1 : 1;
5593 } else if (cur1 == cur2) {
5596 cmp = cur1 < cur2 ? -1 : 1;
5601 SvREFCNT_dec(svrecode);
5610 =for apidoc sv_cmp_locale
5612 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5613 'use bytes' aware, handles get magic, and will coerce its args to strings
5614 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5620 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5623 #ifdef USE_LOCALE_COLLATE
5629 if (PL_collation_standard)
5633 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5635 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5637 if (!pv1 || !len1) {
5648 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5651 return retval < 0 ? -1 : 1;
5654 * When the result of collation is equality, that doesn't mean
5655 * that there are no differences -- some locales exclude some
5656 * characters from consideration. So to avoid false equalities,
5657 * we use the raw string as a tiebreaker.
5663 #endif /* USE_LOCALE_COLLATE */
5665 return sv_cmp(sv1, sv2);
5669 #ifdef USE_LOCALE_COLLATE
5672 =for apidoc sv_collxfrm
5674 Add Collate Transform magic to an SV if it doesn't already have it.
5676 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5677 scalar data of the variable, but transformed to such a format that a normal
5678 memory comparison can be used to compare the data according to the locale
5685 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5690 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5691 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5697 Safefree(mg->mg_ptr);
5698 s = SvPV_const(sv, len);
5699 if ((xf = mem_collxfrm(s, len, &xlen))) {
5700 if (SvREADONLY(sv)) {
5703 return xf + sizeof(PL_collation_ix);
5706 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5707 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5720 if (mg && mg->mg_ptr) {
5722 return mg->mg_ptr + sizeof(PL_collation_ix);
5730 #endif /* USE_LOCALE_COLLATE */
5735 Get a line from the filehandle and store it into the SV, optionally
5736 appending to the currently-stored string.
5742 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5747 register STDCHAR rslast;
5748 register STDCHAR *bp;
5754 if (SvTHINKFIRST(sv))
5755 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5756 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5758 However, perlbench says it's slower, because the existing swipe code
5759 is faster than copy on write.
5760 Swings and roundabouts. */
5761 SvUPGRADE(sv, SVt_PV);
5766 if (PerlIO_isutf8(fp)) {
5768 sv_utf8_upgrade_nomg(sv);
5769 sv_pos_u2b(sv,&append,0);
5771 } else if (SvUTF8(sv)) {
5772 SV * const tsv = newSV(0);
5773 sv_gets(tsv, fp, 0);
5774 sv_utf8_upgrade_nomg(tsv);
5775 SvCUR_set(sv,append);
5778 goto return_string_or_null;
5783 if (PerlIO_isutf8(fp))
5786 if (IN_PERL_COMPILETIME) {
5787 /* we always read code in line mode */
5791 else if (RsSNARF(PL_rs)) {
5792 /* If it is a regular disk file use size from stat() as estimate
5793 of amount we are going to read - may result in malloc-ing
5794 more memory than we realy need if layers bellow reduce
5795 size we read (e.g. CRLF or a gzip layer)
5798 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5799 const Off_t offset = PerlIO_tell(fp);
5800 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5801 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5807 else if (RsRECORD(PL_rs)) {
5811 /* Grab the size of the record we're getting */
5812 recsize = SvIV(SvRV(PL_rs));
5813 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5816 /* VMS wants read instead of fread, because fread doesn't respect */
5817 /* RMS record boundaries. This is not necessarily a good thing to be */
5818 /* doing, but we've got no other real choice - except avoid stdio
5819 as implementation - perhaps write a :vms layer ?
5821 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5823 bytesread = PerlIO_read(fp, buffer, recsize);
5827 SvCUR_set(sv, bytesread += append);
5828 buffer[bytesread] = '\0';
5829 goto return_string_or_null;
5831 else if (RsPARA(PL_rs)) {
5837 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5838 if (PerlIO_isutf8(fp)) {
5839 rsptr = SvPVutf8(PL_rs, rslen);
5842 if (SvUTF8(PL_rs)) {
5843 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5844 Perl_croak(aTHX_ "Wide character in $/");
5847 rsptr = SvPV_const(PL_rs, rslen);
5851 rslast = rslen ? rsptr[rslen - 1] : '\0';
5853 if (rspara) { /* have to do this both before and after */
5854 do { /* to make sure file boundaries work right */
5857 i = PerlIO_getc(fp);
5861 PerlIO_ungetc(fp,i);
5867 /* See if we know enough about I/O mechanism to cheat it ! */
5869 /* This used to be #ifdef test - it is made run-time test for ease
5870 of abstracting out stdio interface. One call should be cheap
5871 enough here - and may even be a macro allowing compile
5875 if (PerlIO_fast_gets(fp)) {
5878 * We're going to steal some values from the stdio struct
5879 * and put EVERYTHING in the innermost loop into registers.
5881 register STDCHAR *ptr;
5885 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5886 /* An ungetc()d char is handled separately from the regular
5887 * buffer, so we getc() it back out and stuff it in the buffer.
5889 i = PerlIO_getc(fp);
5890 if (i == EOF) return 0;
5891 *(--((*fp)->_ptr)) = (unsigned char) i;
5895 /* Here is some breathtakingly efficient cheating */
5897 cnt = PerlIO_get_cnt(fp); /* get count into register */
5898 /* make sure we have the room */
5899 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5900 /* Not room for all of it
5901 if we are looking for a separator and room for some
5903 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5904 /* just process what we have room for */
5905 shortbuffered = cnt - SvLEN(sv) + append + 1;
5906 cnt -= shortbuffered;
5910 /* remember that cnt can be negative */
5911 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5916 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5917 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5918 DEBUG_P(PerlIO_printf(Perl_debug_log,
5919 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5920 DEBUG_P(PerlIO_printf(Perl_debug_log,
5921 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5922 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5923 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5928 while (cnt > 0) { /* this | eat */
5930 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5931 goto thats_all_folks; /* screams | sed :-) */
5935 Copy(ptr, bp, cnt, char); /* this | eat */
5936 bp += cnt; /* screams | dust */
5937 ptr += cnt; /* louder | sed :-) */
5942 if (shortbuffered) { /* oh well, must extend */
5943 cnt = shortbuffered;
5945 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5947 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5948 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5952 DEBUG_P(PerlIO_printf(Perl_debug_log,
5953 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5954 PTR2UV(ptr),(long)cnt));
5955 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5957 DEBUG_P(PerlIO_printf(Perl_debug_log,
5958 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5959 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5960 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5962 /* This used to call 'filbuf' in stdio form, but as that behaves like
5963 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5964 another abstraction. */
5965 i = PerlIO_getc(fp); /* get more characters */
5967 DEBUG_P(PerlIO_printf(Perl_debug_log,
5968 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5969 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5970 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5972 cnt = PerlIO_get_cnt(fp);
5973 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5974 DEBUG_P(PerlIO_printf(Perl_debug_log,
5975 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5977 if (i == EOF) /* all done for ever? */
5978 goto thats_really_all_folks;
5980 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5982 SvGROW(sv, bpx + cnt + 2);
5983 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5985 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5987 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5988 goto thats_all_folks;
5992 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5993 memNE((char*)bp - rslen, rsptr, rslen))
5994 goto screamer; /* go back to the fray */
5995 thats_really_all_folks:
5997 cnt += shortbuffered;
5998 DEBUG_P(PerlIO_printf(Perl_debug_log,
5999 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6000 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6001 DEBUG_P(PerlIO_printf(Perl_debug_log,
6002 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6003 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6004 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6006 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6007 DEBUG_P(PerlIO_printf(Perl_debug_log,
6008 "Screamer: done, len=%ld, string=|%.*s|\n",
6009 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6013 /*The big, slow, and stupid way. */
6014 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6015 STDCHAR *buf = NULL;
6016 Newx(buf, 8192, STDCHAR);
6024 register const STDCHAR * const bpe = buf + sizeof(buf);
6026 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6027 ; /* keep reading */
6031 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6032 /* Accomodate broken VAXC compiler, which applies U8 cast to
6033 * both args of ?: operator, causing EOF to change into 255
6036 i = (U8)buf[cnt - 1];
6042 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6044 sv_catpvn(sv, (char *) buf, cnt);
6046 sv_setpvn(sv, (char *) buf, cnt);
6048 if (i != EOF && /* joy */
6050 SvCUR(sv) < rslen ||
6051 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6055 * If we're reading from a TTY and we get a short read,
6056 * indicating that the user hit his EOF character, we need
6057 * to notice it now, because if we try to read from the TTY
6058 * again, the EOF condition will disappear.
6060 * The comparison of cnt to sizeof(buf) is an optimization
6061 * that prevents unnecessary calls to feof().
6065 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6069 #ifdef USE_HEAP_INSTEAD_OF_STACK
6074 if (rspara) { /* have to do this both before and after */
6075 while (i != EOF) { /* to make sure file boundaries work right */
6076 i = PerlIO_getc(fp);
6078 PerlIO_ungetc(fp,i);
6084 return_string_or_null:
6085 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6091 Auto-increment of the value in the SV, doing string to numeric conversion
6092 if necessary. Handles 'get' magic.
6098 Perl_sv_inc(pTHX_ register SV *sv)
6107 if (SvTHINKFIRST(sv)) {
6109 sv_force_normal_flags(sv, 0);
6110 if (SvREADONLY(sv)) {
6111 if (IN_PERL_RUNTIME)
6112 Perl_croak(aTHX_ PL_no_modify);
6116 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6118 i = PTR2IV(SvRV(sv));
6123 flags = SvFLAGS(sv);
6124 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6125 /* It's (privately or publicly) a float, but not tested as an
6126 integer, so test it to see. */
6128 flags = SvFLAGS(sv);
6130 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6131 /* It's publicly an integer, or privately an integer-not-float */
6132 #ifdef PERL_PRESERVE_IVUV
6136 if (SvUVX(sv) == UV_MAX)
6137 sv_setnv(sv, UV_MAX_P1);
6139 (void)SvIOK_only_UV(sv);
6140 SvUV_set(sv, SvUVX(sv) + 1);
6142 if (SvIVX(sv) == IV_MAX)
6143 sv_setuv(sv, (UV)IV_MAX + 1);
6145 (void)SvIOK_only(sv);
6146 SvIV_set(sv, SvIVX(sv) + 1);
6151 if (flags & SVp_NOK) {
6152 (void)SvNOK_only(sv);
6153 SvNV_set(sv, SvNVX(sv) + 1.0);
6157 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6158 if ((flags & SVTYPEMASK) < SVt_PVIV)
6159 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6160 (void)SvIOK_only(sv);
6165 while (isALPHA(*d)) d++;
6166 while (isDIGIT(*d)) d++;
6168 #ifdef PERL_PRESERVE_IVUV
6169 /* Got to punt this as an integer if needs be, but we don't issue
6170 warnings. Probably ought to make the sv_iv_please() that does
6171 the conversion if possible, and silently. */
6172 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6173 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6174 /* Need to try really hard to see if it's an integer.
6175 9.22337203685478e+18 is an integer.
6176 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6177 so $a="9.22337203685478e+18"; $a+0; $a++
6178 needs to be the same as $a="9.22337203685478e+18"; $a++
6185 /* sv_2iv *should* have made this an NV */
6186 if (flags & SVp_NOK) {
6187 (void)SvNOK_only(sv);
6188 SvNV_set(sv, SvNVX(sv) + 1.0);
6191 /* I don't think we can get here. Maybe I should assert this
6192 And if we do get here I suspect that sv_setnv will croak. NWC
6194 #if defined(USE_LONG_DOUBLE)
6195 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",
6196 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6198 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6199 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6202 #endif /* PERL_PRESERVE_IVUV */
6203 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6207 while (d >= SvPVX_const(sv)) {
6215 /* MKS: The original code here died if letters weren't consecutive.
6216 * at least it didn't have to worry about non-C locales. The
6217 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6218 * arranged in order (although not consecutively) and that only
6219 * [A-Za-z] are accepted by isALPHA in the C locale.
6221 if (*d != 'z' && *d != 'Z') {
6222 do { ++*d; } while (!isALPHA(*d));
6225 *(d--) -= 'z' - 'a';
6230 *(d--) -= 'z' - 'a' + 1;
6234 /* oh,oh, the number grew */
6235 SvGROW(sv, SvCUR(sv) + 2);
6236 SvCUR_set(sv, SvCUR(sv) + 1);
6237 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6248 Auto-decrement of the value in the SV, doing string to numeric conversion
6249 if necessary. Handles 'get' magic.
6255 Perl_sv_dec(pTHX_ register SV *sv)
6263 if (SvTHINKFIRST(sv)) {
6265 sv_force_normal_flags(sv, 0);
6266 if (SvREADONLY(sv)) {
6267 if (IN_PERL_RUNTIME)
6268 Perl_croak(aTHX_ PL_no_modify);
6272 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6274 i = PTR2IV(SvRV(sv));
6279 /* Unlike sv_inc we don't have to worry about string-never-numbers
6280 and keeping them magic. But we mustn't warn on punting */
6281 flags = SvFLAGS(sv);
6282 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6283 /* It's publicly an integer, or privately an integer-not-float */
6284 #ifdef PERL_PRESERVE_IVUV
6288 if (SvUVX(sv) == 0) {
6289 (void)SvIOK_only(sv);
6293 (void)SvIOK_only_UV(sv);
6294 SvUV_set(sv, SvUVX(sv) - 1);
6297 if (SvIVX(sv) == IV_MIN)
6298 sv_setnv(sv, (NV)IV_MIN - 1.0);
6300 (void)SvIOK_only(sv);
6301 SvIV_set(sv, SvIVX(sv) - 1);
6306 if (flags & SVp_NOK) {
6307 SvNV_set(sv, SvNVX(sv) - 1.0);
6308 (void)SvNOK_only(sv);
6311 if (!(flags & SVp_POK)) {
6312 if ((flags & SVTYPEMASK) < SVt_PVIV)
6313 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6315 (void)SvIOK_only(sv);
6318 #ifdef PERL_PRESERVE_IVUV
6320 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6321 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6322 /* Need to try really hard to see if it's an integer.
6323 9.22337203685478e+18 is an integer.
6324 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6325 so $a="9.22337203685478e+18"; $a+0; $a--
6326 needs to be the same as $a="9.22337203685478e+18"; $a--
6333 /* sv_2iv *should* have made this an NV */
6334 if (flags & SVp_NOK) {
6335 (void)SvNOK_only(sv);
6336 SvNV_set(sv, SvNVX(sv) - 1.0);
6339 /* I don't think we can get here. Maybe I should assert this
6340 And if we do get here I suspect that sv_setnv will croak. NWC
6342 #if defined(USE_LONG_DOUBLE)
6343 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",
6344 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6346 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6347 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6351 #endif /* PERL_PRESERVE_IVUV */
6352 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6356 =for apidoc sv_mortalcopy
6358 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6359 The new SV is marked as mortal. It will be destroyed "soon", either by an
6360 explicit call to FREETMPS, or by an implicit call at places such as
6361 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6366 /* Make a string that will exist for the duration of the expression
6367 * evaluation. Actually, it may have to last longer than that, but
6368 * hopefully we won't free it until it has been assigned to a
6369 * permanent location. */
6372 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6378 sv_setsv(sv,oldstr);
6380 PL_tmps_stack[++PL_tmps_ix] = sv;
6386 =for apidoc sv_newmortal
6388 Creates a new null SV which is mortal. The reference count of the SV is
6389 set to 1. It will be destroyed "soon", either by an explicit call to
6390 FREETMPS, or by an implicit call at places such as statement boundaries.
6391 See also C<sv_mortalcopy> and C<sv_2mortal>.
6397 Perl_sv_newmortal(pTHX)
6403 SvFLAGS(sv) = SVs_TEMP;
6405 PL_tmps_stack[++PL_tmps_ix] = sv;
6410 =for apidoc sv_2mortal
6412 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6413 by an explicit call to FREETMPS, or by an implicit call at places such as
6414 statement boundaries. SvTEMP() is turned on which means that the SV's
6415 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6416 and C<sv_mortalcopy>.
6422 Perl_sv_2mortal(pTHX_ register SV *sv)
6427 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6430 PL_tmps_stack[++PL_tmps_ix] = sv;
6438 Creates a new SV and copies a string into it. The reference count for the
6439 SV is set to 1. If C<len> is zero, Perl will compute the length using
6440 strlen(). For efficiency, consider using C<newSVpvn> instead.
6446 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6452 sv_setpvn(sv,s,len ? len : strlen(s));
6457 =for apidoc newSVpvn
6459 Creates a new SV and copies a string into it. The reference count for the
6460 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6461 string. You are responsible for ensuring that the source string is at least
6462 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6468 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6474 sv_setpvn(sv,s,len);
6480 =for apidoc newSVhek
6482 Creates a new SV from the hash key structure. It will generate scalars that
6483 point to the shared string table where possible. Returns a new (undefined)
6484 SV if the hek is NULL.
6490 Perl_newSVhek(pTHX_ const HEK *hek)
6500 if (HEK_LEN(hek) == HEf_SVKEY) {
6501 return newSVsv(*(SV**)HEK_KEY(hek));
6503 const int flags = HEK_FLAGS(hek);
6504 if (flags & HVhek_WASUTF8) {
6506 Andreas would like keys he put in as utf8 to come back as utf8
6508 STRLEN utf8_len = HEK_LEN(hek);
6509 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6510 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6513 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6515 } else if (flags & HVhek_REHASH) {
6516 /* We don't have a pointer to the hv, so we have to replicate the
6517 flag into every HEK. This hv is using custom a hasing
6518 algorithm. Hence we can't return a shared string scalar, as
6519 that would contain the (wrong) hash value, and might get passed
6520 into an hv routine with a regular hash */
6522 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6527 /* This will be overwhelminly the most common case. */
6528 return newSVpvn_share(HEK_KEY(hek),
6529 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6535 =for apidoc newSVpvn_share
6537 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6538 table. If the string does not already exist in the table, it is created
6539 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6540 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6541 otherwise the hash is computed. The idea here is that as the string table
6542 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6543 hash lookup will avoid string compare.
6549 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6553 bool is_utf8 = FALSE;
6555 STRLEN tmplen = -len;
6557 /* See the note in hv.c:hv_fetch() --jhi */
6558 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6562 PERL_HASH(hash, src, len);
6564 sv_upgrade(sv, SVt_PV);
6565 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6577 #if defined(PERL_IMPLICIT_CONTEXT)
6579 /* pTHX_ magic can't cope with varargs, so this is a no-context
6580 * version of the main function, (which may itself be aliased to us).
6581 * Don't access this version directly.
6585 Perl_newSVpvf_nocontext(const char* pat, ...)
6590 va_start(args, pat);
6591 sv = vnewSVpvf(pat, &args);
6598 =for apidoc newSVpvf
6600 Creates a new SV and initializes it with the string formatted like
6607 Perl_newSVpvf(pTHX_ const char* pat, ...)
6611 va_start(args, pat);
6612 sv = vnewSVpvf(pat, &args);
6617 /* backend for newSVpvf() and newSVpvf_nocontext() */
6620 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6625 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6632 Creates a new SV and copies a floating point value into it.
6633 The reference count for the SV is set to 1.
6639 Perl_newSVnv(pTHX_ NV n)
6652 Creates a new SV and copies an integer into it. The reference count for the
6659 Perl_newSViv(pTHX_ IV i)
6672 Creates a new SV and copies an unsigned integer into it.
6673 The reference count for the SV is set to 1.
6679 Perl_newSVuv(pTHX_ UV u)
6690 =for apidoc newRV_noinc
6692 Creates an RV wrapper for an SV. The reference count for the original
6693 SV is B<not> incremented.
6699 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6705 sv_upgrade(sv, SVt_RV);
6707 SvRV_set(sv, tmpRef);
6712 /* newRV_inc is the official function name to use now.
6713 * newRV_inc is in fact #defined to newRV in sv.h
6717 Perl_newRV(pTHX_ SV *tmpRef)
6720 return newRV_noinc(SvREFCNT_inc(tmpRef));
6726 Creates a new SV which is an exact duplicate of the original SV.
6733 Perl_newSVsv(pTHX_ register SV *old)
6740 if (SvTYPE(old) == SVTYPEMASK) {
6741 if (ckWARN_d(WARN_INTERNAL))
6742 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6746 /* SV_GMAGIC is the default for sv_setv()
6747 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6748 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6749 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6754 =for apidoc sv_reset
6756 Underlying implementation for the C<reset> Perl function.
6757 Note that the perl-level function is vaguely deprecated.
6763 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6766 char todo[PERL_UCHAR_MAX+1];
6771 if (!*s) { /* reset ?? searches */
6772 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6774 PMOP *pm = (PMOP *) mg->mg_obj;
6776 pm->op_pmdynflags &= ~PMdf_USED;
6783 /* reset variables */
6785 if (!HvARRAY(stash))
6788 Zero(todo, 256, char);
6791 I32 i = (unsigned char)*s;
6795 max = (unsigned char)*s++;
6796 for ( ; i <= max; i++) {
6799 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6801 for (entry = HvARRAY(stash)[i];
6803 entry = HeNEXT(entry))
6808 if (!todo[(U8)*HeKEY(entry)])
6810 gv = (GV*)HeVAL(entry);
6813 if (SvTHINKFIRST(sv)) {
6814 if (!SvREADONLY(sv) && SvROK(sv))
6816 /* XXX Is this continue a bug? Why should THINKFIRST
6817 exempt us from resetting arrays and hashes? */
6821 if (SvTYPE(sv) >= SVt_PV) {
6823 if (SvPVX_const(sv) != Nullch)
6831 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6833 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6836 # if defined(USE_ENVIRON_ARRAY)
6839 # endif /* USE_ENVIRON_ARRAY */
6850 Using various gambits, try to get an IO from an SV: the IO slot if its a
6851 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6852 named after the PV if we're a string.
6858 Perl_sv_2io(pTHX_ SV *sv)
6863 switch (SvTYPE(sv)) {
6871 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6875 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6877 return sv_2io(SvRV(sv));
6878 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6884 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6893 Using various gambits, try to get a CV from an SV; in addition, try if
6894 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6895 The flags in C<lref> are passed to sv_fetchsv.
6901 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6908 return *st = NULL, *gvp = Nullgv, Nullcv;
6909 switch (SvTYPE(sv)) {
6928 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6929 tryAMAGICunDEREF(to_cv);
6932 if (SvTYPE(sv) == SVt_PVCV) {
6941 Perl_croak(aTHX_ "Not a subroutine reference");
6946 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6952 /* Some flags to gv_fetchsv mean don't really create the GV */
6953 if (SvTYPE(gv) != SVt_PVGV) {
6959 if (lref && !GvCVu(gv)) {
6963 gv_efullname3(tmpsv, gv, Nullch);
6964 /* XXX this is probably not what they think they're getting.
6965 * It has the same effect as "sub name;", i.e. just a forward
6967 newSUB(start_subparse(FALSE, 0),
6968 newSVOP(OP_CONST, 0, tmpsv),
6973 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6983 Returns true if the SV has a true value by Perl's rules.
6984 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6985 instead use an in-line version.
6991 Perl_sv_true(pTHX_ register SV *sv)
6996 register const XPV* const tXpv = (XPV*)SvANY(sv);
6998 (tXpv->xpv_cur > 1 ||
6999 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7006 return SvIVX(sv) != 0;
7009 return SvNVX(sv) != 0.0;
7011 return sv_2bool(sv);
7017 =for apidoc sv_pvn_force
7019 Get a sensible string out of the SV somehow.
7020 A private implementation of the C<SvPV_force> macro for compilers which
7021 can't cope with complex macro expressions. Always use the macro instead.
7023 =for apidoc sv_pvn_force_flags
7025 Get a sensible string out of the SV somehow.
7026 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7027 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7028 implemented in terms of this function.
7029 You normally want to use the various wrapper macros instead: see
7030 C<SvPV_force> and C<SvPV_force_nomg>
7036 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7039 if (SvTHINKFIRST(sv) && !SvROK(sv))
7040 sv_force_normal_flags(sv, 0);
7050 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7051 const char * const ref = sv_reftype(sv,0);
7053 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7054 ref, OP_NAME(PL_op));
7056 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7058 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7059 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7061 s = sv_2pv_flags(sv, &len, flags);
7065 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7068 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7069 SvGROW(sv, len + 1);
7070 Move(s,SvPVX(sv),len,char);
7075 SvPOK_on(sv); /* validate pointer */
7077 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7078 PTR2UV(sv),SvPVX_const(sv)));
7081 return SvPVX_mutable(sv);
7085 =for apidoc sv_pvbyten_force
7087 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7093 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7095 sv_pvn_force(sv,lp);
7096 sv_utf8_downgrade(sv,0);
7102 =for apidoc sv_pvutf8n_force
7104 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7110 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7112 sv_pvn_force(sv,lp);
7113 sv_utf8_upgrade(sv);
7119 =for apidoc sv_reftype
7121 Returns a string describing what the SV is a reference to.
7127 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7129 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7130 inside return suggests a const propagation bug in g++. */
7131 if (ob && SvOBJECT(sv)) {
7132 char * const name = HvNAME_get(SvSTASH(sv));
7133 return name ? name : (char *) "__ANON__";
7136 switch (SvTYPE(sv)) {
7153 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7154 /* tied lvalues should appear to be
7155 * scalars for backwards compatitbility */
7156 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7157 ? "SCALAR" : "LVALUE");
7158 case SVt_PVAV: return "ARRAY";
7159 case SVt_PVHV: return "HASH";
7160 case SVt_PVCV: return "CODE";
7161 case SVt_PVGV: return "GLOB";
7162 case SVt_PVFM: return "FORMAT";
7163 case SVt_PVIO: return "IO";
7164 default: return "UNKNOWN";
7170 =for apidoc sv_isobject
7172 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7173 object. If the SV is not an RV, or if the object is not blessed, then this
7180 Perl_sv_isobject(pTHX_ SV *sv)
7196 Returns a boolean indicating whether the SV is blessed into the specified
7197 class. This does not check for subtypes; use C<sv_derived_from> to verify
7198 an inheritance relationship.
7204 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7215 hvname = HvNAME_get(SvSTASH(sv));
7219 return strEQ(hvname, name);
7225 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7226 it will be upgraded to one. If C<classname> is non-null then the new SV will
7227 be blessed in the specified package. The new SV is returned and its
7228 reference count is 1.
7234 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7241 SV_CHECK_THINKFIRST_COW_DROP(rv);
7244 if (SvTYPE(rv) >= SVt_PVMG) {
7245 const U32 refcnt = SvREFCNT(rv);
7249 SvREFCNT(rv) = refcnt;
7252 if (SvTYPE(rv) < SVt_RV)
7253 sv_upgrade(rv, SVt_RV);
7254 else if (SvTYPE(rv) > SVt_RV) {
7265 HV* const stash = gv_stashpv(classname, TRUE);
7266 (void)sv_bless(rv, stash);
7272 =for apidoc sv_setref_pv
7274 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7275 argument will be upgraded to an RV. That RV will be modified to point to
7276 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7277 into the SV. The C<classname> argument indicates the package for the
7278 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7279 will have a reference count of 1, and the RV will be returned.
7281 Do not use with other Perl types such as HV, AV, SV, CV, because those
7282 objects will become corrupted by the pointer copy process.
7284 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7290 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7294 sv_setsv(rv, &PL_sv_undef);
7298 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7303 =for apidoc sv_setref_iv
7305 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7306 argument will be upgraded to an RV. That RV will be modified to point to
7307 the new SV. The C<classname> argument indicates the package for the
7308 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7309 will have a reference count of 1, and the RV will be returned.
7315 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7317 sv_setiv(newSVrv(rv,classname), iv);
7322 =for apidoc sv_setref_uv
7324 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7325 argument will be upgraded to an RV. That RV will be modified to point to
7326 the new SV. The C<classname> argument indicates the package for the
7327 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7328 will have a reference count of 1, and the RV will be returned.
7334 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7336 sv_setuv(newSVrv(rv,classname), uv);
7341 =for apidoc sv_setref_nv
7343 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7344 argument will be upgraded to an RV. That RV will be modified to point to
7345 the new SV. The C<classname> argument indicates the package for the
7346 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7347 will have a reference count of 1, and the RV will be returned.
7353 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7355 sv_setnv(newSVrv(rv,classname), nv);
7360 =for apidoc sv_setref_pvn
7362 Copies a string into a new SV, optionally blessing the SV. The length of the
7363 string must be specified with C<n>. The C<rv> argument will be upgraded to
7364 an RV. That RV will be modified to point to the new SV. The C<classname>
7365 argument indicates the package for the blessing. Set C<classname> to
7366 C<Nullch> to avoid the blessing. The new SV will have a reference count
7367 of 1, and the RV will be returned.
7369 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7375 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7377 sv_setpvn(newSVrv(rv,classname), pv, n);
7382 =for apidoc sv_bless
7384 Blesses an SV into a specified package. The SV must be an RV. The package
7385 must be designated by its stash (see C<gv_stashpv()>). The reference count
7386 of the SV is unaffected.
7392 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7397 Perl_croak(aTHX_ "Can't bless non-reference value");
7399 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7400 if (SvREADONLY(tmpRef))
7401 Perl_croak(aTHX_ PL_no_modify);
7402 if (SvOBJECT(tmpRef)) {
7403 if (SvTYPE(tmpRef) != SVt_PVIO)
7405 SvREFCNT_dec(SvSTASH(tmpRef));
7408 SvOBJECT_on(tmpRef);
7409 if (SvTYPE(tmpRef) != SVt_PVIO)
7411 SvUPGRADE(tmpRef, SVt_PVMG);
7412 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7419 if(SvSMAGICAL(tmpRef))
7420 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7428 /* Downgrades a PVGV to a PVMG.
7432 S_sv_unglob(pTHX_ SV *sv)
7437 assert(SvTYPE(sv) == SVt_PVGV);
7442 sv_del_backref((SV*)GvSTASH(sv), sv);
7445 sv_unmagic(sv, PERL_MAGIC_glob);
7446 Safefree(GvNAME(sv));
7449 /* need to keep SvANY(sv) in the right arena */
7450 xpvmg = new_XPVMG();
7451 StructCopy(SvANY(sv), xpvmg, XPVMG);
7452 del_XPVGV(SvANY(sv));
7455 SvFLAGS(sv) &= ~SVTYPEMASK;
7456 SvFLAGS(sv) |= SVt_PVMG;
7460 =for apidoc sv_unref_flags
7462 Unsets the RV status of the SV, and decrements the reference count of
7463 whatever was being referenced by the RV. This can almost be thought of
7464 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7465 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7466 (otherwise the decrementing is conditional on the reference count being
7467 different from one or the reference being a readonly SV).
7474 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7476 SV* const target = SvRV(ref);
7478 if (SvWEAKREF(ref)) {
7479 sv_del_backref(target, ref);
7481 SvRV_set(ref, NULL);
7484 SvRV_set(ref, NULL);
7486 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7487 assigned to as BEGIN {$a = \"Foo"} will fail. */
7488 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7489 SvREFCNT_dec(target);
7490 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7491 sv_2mortal(target); /* Schedule for freeing later */
7495 =for apidoc sv_untaint
7497 Untaint an SV. Use C<SvTAINTED_off> instead.
7502 Perl_sv_untaint(pTHX_ SV *sv)
7504 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7505 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7512 =for apidoc sv_tainted
7514 Test an SV for taintedness. Use C<SvTAINTED> instead.
7519 Perl_sv_tainted(pTHX_ SV *sv)
7521 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7522 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7523 if (mg && (mg->mg_len & 1) )
7530 =for apidoc sv_setpviv
7532 Copies an integer into the given SV, also updating its string value.
7533 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7539 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7541 char buf[TYPE_CHARS(UV)];
7543 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7545 sv_setpvn(sv, ptr, ebuf - ptr);
7549 =for apidoc sv_setpviv_mg
7551 Like C<sv_setpviv>, but also handles 'set' magic.
7557 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7563 #if defined(PERL_IMPLICIT_CONTEXT)
7565 /* pTHX_ magic can't cope with varargs, so this is a no-context
7566 * version of the main function, (which may itself be aliased to us).
7567 * Don't access this version directly.
7571 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7575 va_start(args, pat);
7576 sv_vsetpvf(sv, pat, &args);
7580 /* pTHX_ magic can't cope with varargs, so this is a no-context
7581 * version of the main function, (which may itself be aliased to us).
7582 * Don't access this version directly.
7586 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7590 va_start(args, pat);
7591 sv_vsetpvf_mg(sv, pat, &args);
7597 =for apidoc sv_setpvf
7599 Works like C<sv_catpvf> but copies the text into the SV instead of
7600 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7606 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7609 va_start(args, pat);
7610 sv_vsetpvf(sv, pat, &args);
7615 =for apidoc sv_vsetpvf
7617 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7618 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7620 Usually used via its frontend C<sv_setpvf>.
7626 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7628 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7632 =for apidoc sv_setpvf_mg
7634 Like C<sv_setpvf>, but also handles 'set' magic.
7640 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7643 va_start(args, pat);
7644 sv_vsetpvf_mg(sv, pat, &args);
7649 =for apidoc sv_vsetpvf_mg
7651 Like C<sv_vsetpvf>, but also handles 'set' magic.
7653 Usually used via its frontend C<sv_setpvf_mg>.
7659 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7661 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7665 #if defined(PERL_IMPLICIT_CONTEXT)
7667 /* pTHX_ magic can't cope with varargs, so this is a no-context
7668 * version of the main function, (which may itself be aliased to us).
7669 * Don't access this version directly.
7673 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7677 va_start(args, pat);
7678 sv_vcatpvf(sv, pat, &args);
7682 /* pTHX_ magic can't cope with varargs, so this is a no-context
7683 * version of the main function, (which may itself be aliased to us).
7684 * Don't access this version directly.
7688 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7692 va_start(args, pat);
7693 sv_vcatpvf_mg(sv, pat, &args);
7699 =for apidoc sv_catpvf
7701 Processes its arguments like C<sprintf> and appends the formatted
7702 output to an SV. If the appended data contains "wide" characters
7703 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7704 and characters >255 formatted with %c), the original SV might get
7705 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7706 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7707 valid UTF-8; if the original SV was bytes, the pattern should be too.
7712 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7715 va_start(args, pat);
7716 sv_vcatpvf(sv, pat, &args);
7721 =for apidoc sv_vcatpvf
7723 Processes its arguments like C<vsprintf> and appends the formatted output
7724 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7726 Usually used via its frontend C<sv_catpvf>.
7732 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7734 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7738 =for apidoc sv_catpvf_mg
7740 Like C<sv_catpvf>, but also handles 'set' magic.
7746 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7749 va_start(args, pat);
7750 sv_vcatpvf_mg(sv, pat, &args);
7755 =for apidoc sv_vcatpvf_mg
7757 Like C<sv_vcatpvf>, but also handles 'set' magic.
7759 Usually used via its frontend C<sv_catpvf_mg>.
7765 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7767 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7772 =for apidoc sv_vsetpvfn
7774 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7777 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7783 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7785 sv_setpvn(sv, "", 0);
7786 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7790 S_expect_number(pTHX_ char** pattern)
7794 switch (**pattern) {
7795 case '1': case '2': case '3':
7796 case '4': case '5': case '6':
7797 case '7': case '8': case '9':
7798 var = *(*pattern)++ - '0';
7799 while (isDIGIT(**pattern)) {
7800 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7802 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7810 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7812 const int neg = nv < 0;
7821 if (uv & 1 && uv == nv)
7822 uv--; /* Round to even */
7824 const unsigned dig = uv % 10;
7837 =for apidoc sv_vcatpvfn
7839 Processes its arguments like C<vsprintf> and appends the formatted output
7840 to an SV. Uses an array of SVs if the C style variable argument list is
7841 missing (NULL). When running with taint checks enabled, indicates via
7842 C<maybe_tainted> if results are untrustworthy (often due to the use of
7845 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7851 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7852 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7853 vec_utf8 = DO_UTF8(vecsv);
7855 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7858 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7866 static const char nullstr[] = "(null)";
7868 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7869 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7871 /* Times 4: a decimal digit takes more than 3 binary digits.
7872 * NV_DIG: mantissa takes than many decimal digits.
7873 * Plus 32: Playing safe. */
7874 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7875 /* large enough for "%#.#f" --chip */
7876 /* what about long double NVs? --jhi */
7878 PERL_UNUSED_ARG(maybe_tainted);
7880 /* no matter what, this is a string now */
7881 (void)SvPV_force(sv, origlen);
7883 /* special-case "", "%s", and "%-p" (SVf - see below) */
7886 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7888 const char * const s = va_arg(*args, char*);
7889 sv_catpv(sv, s ? s : nullstr);
7891 else if (svix < svmax) {
7892 sv_catsv(sv, *svargs);
7896 if (args && patlen == 3 && pat[0] == '%' &&
7897 pat[1] == '-' && pat[2] == 'p') {
7898 argsv = va_arg(*args, SV*);
7899 sv_catsv(sv, argsv);
7903 #ifndef USE_LONG_DOUBLE
7904 /* special-case "%.<number>[gf]" */
7905 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7906 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7907 unsigned digits = 0;
7911 while (*pp >= '0' && *pp <= '9')
7912 digits = 10 * digits + (*pp++ - '0');
7913 if (pp - pat == (int)patlen - 1) {
7921 /* Add check for digits != 0 because it seems that some
7922 gconverts are buggy in this case, and we don't yet have
7923 a Configure test for this. */
7924 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7925 /* 0, point, slack */
7926 Gconvert(nv, (int)digits, 0, ebuf);
7928 if (*ebuf) /* May return an empty string for digits==0 */
7931 } else if (!digits) {
7934 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7935 sv_catpvn(sv, p, l);
7941 #endif /* !USE_LONG_DOUBLE */
7943 if (!args && svix < svmax && DO_UTF8(*svargs))
7946 patend = (char*)pat + patlen;
7947 for (p = (char*)pat; p < patend; p = q) {
7950 bool vectorize = FALSE;
7951 bool vectorarg = FALSE;
7952 bool vec_utf8 = FALSE;
7958 bool has_precis = FALSE;
7960 const I32 osvix = svix;
7961 bool is_utf8 = FALSE; /* is this item utf8? */
7962 #ifdef HAS_LDBL_SPRINTF_BUG
7963 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7964 with sfio - Allen <allens@cpan.org> */
7965 bool fix_ldbl_sprintf_bug = FALSE;
7969 U8 utf8buf[UTF8_MAXBYTES+1];
7970 STRLEN esignlen = 0;
7972 const char *eptr = Nullch;
7975 const U8 *vecstr = Null(U8*);
7982 /* we need a long double target in case HAS_LONG_DOUBLE but
7985 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7993 const char *dotstr = ".";
7994 STRLEN dotstrlen = 1;
7995 I32 efix = 0; /* explicit format parameter index */
7996 I32 ewix = 0; /* explicit width index */
7997 I32 epix = 0; /* explicit precision index */
7998 I32 evix = 0; /* explicit vector index */
7999 bool asterisk = FALSE;
8001 /* echo everything up to the next format specification */
8002 for (q = p; q < patend && *q != '%'; ++q) ;
8004 if (has_utf8 && !pat_utf8)
8005 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8007 sv_catpvn(sv, p, q - p);
8014 We allow format specification elements in this order:
8015 \d+\$ explicit format parameter index
8017 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8018 0 flag (as above): repeated to allow "v02"
8019 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8020 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8022 [%bcdefginopsuxDFOUX] format (mandatory)
8027 As of perl5.9.3, printf format checking is on by default.
8028 Internally, perl uses %p formats to provide an escape to
8029 some extended formatting. This block deals with those
8030 extensions: if it does not match, (char*)q is reset and
8031 the normal format processing code is used.
8033 Currently defined extensions are:
8034 %p include pointer address (standard)
8035 %-p (SVf) include an SV (previously %_)
8036 %-<num>p include an SV with precision <num>
8037 %1p (VDf) include a v-string (as %vd)
8038 %<num>p reserved for future extensions
8040 Robin Barker 2005-07-14
8047 n = expect_number(&q);
8054 argsv = va_arg(*args, SV*);
8055 eptr = SvPVx_const(argsv, elen);
8061 else if (n == vdNUMBER) { /* VDf */
8068 if (ckWARN_d(WARN_INTERNAL))
8069 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8070 "internal %%<num>p might conflict with future printf extensions");
8076 if ( (width = expect_number(&q)) ) {
8117 if ( (ewix = expect_number(&q)) )
8126 if ((vectorarg = asterisk)) {
8139 width = expect_number(&q);
8145 vecsv = va_arg(*args, SV*);
8147 vecsv = (evix > 0 && evix <= svmax)
8148 ? svargs[evix-1] : &PL_sv_undef;
8150 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8152 dotstr = SvPV_const(vecsv, dotstrlen);
8153 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8154 bad with tied or overloaded values that return UTF8. */
8157 else if (has_utf8) {
8158 vecsv = sv_mortalcopy(vecsv);
8159 sv_utf8_upgrade(vecsv);
8160 dotstr = SvPV_const(vecsv, dotstrlen);
8167 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8168 vecsv = svargs[efix ? efix-1 : svix++];
8169 vecstr = (U8*)SvPV_const(vecsv,veclen);
8170 vec_utf8 = DO_UTF8(vecsv);
8172 /* if this is a version object, we need to convert
8173 * back into v-string notation and then let the
8174 * vectorize happen normally
8176 if (sv_derived_from(vecsv, "version")) {
8177 char *version = savesvpv(vecsv);
8178 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8179 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8180 "vector argument not supported with alpha versions");
8183 vecsv = sv_newmortal();
8184 /* scan_vstring is expected to be called during
8185 * tokenization, so we need to fake up the end
8186 * of the buffer for it
8188 PL_bufend = version + veclen;
8189 scan_vstring(version, vecsv);
8190 vecstr = (U8*)SvPV_const(vecsv, veclen);
8191 vec_utf8 = DO_UTF8(vecsv);
8203 i = va_arg(*args, int);
8205 i = (ewix ? ewix <= svmax : svix < svmax) ?
8206 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8208 width = (i < 0) ? -i : i;
8218 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8220 /* XXX: todo, support specified precision parameter */
8224 i = va_arg(*args, int);
8226 i = (ewix ? ewix <= svmax : svix < svmax)
8227 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8228 precis = (i < 0) ? 0 : i;
8233 precis = precis * 10 + (*q++ - '0');
8242 case 'I': /* Ix, I32x, and I64x */
8244 if (q[1] == '6' && q[2] == '4') {
8250 if (q[1] == '3' && q[2] == '2') {
8260 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8271 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8272 if (*(q + 1) == 'l') { /* lld, llf */
8298 if (!vectorize && !args) {
8300 const I32 i = efix-1;
8301 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8303 argsv = (svix >= 0 && svix < svmax)
8304 ? svargs[svix++] : &PL_sv_undef;
8315 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8317 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8319 eptr = (char*)utf8buf;
8320 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8334 eptr = va_arg(*args, char*);
8336 #ifdef MACOS_TRADITIONAL
8337 /* On MacOS, %#s format is used for Pascal strings */
8342 elen = strlen(eptr);
8344 eptr = (char *)nullstr;
8345 elen = sizeof nullstr - 1;
8349 eptr = SvPVx_const(argsv, elen);
8350 if (DO_UTF8(argsv)) {
8351 if (has_precis && precis < elen) {
8353 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8356 if (width) { /* fudge width (can't fudge elen) */
8357 width += elen - sv_len_utf8(argsv);
8364 if (has_precis && elen > precis)
8371 if (alt || vectorize)
8373 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8394 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8403 esignbuf[esignlen++] = plus;
8407 case 'h': iv = (short)va_arg(*args, int); break;
8408 case 'l': iv = va_arg(*args, long); break;
8409 case 'V': iv = va_arg(*args, IV); break;
8410 default: iv = va_arg(*args, int); break;
8412 case 'q': iv = va_arg(*args, Quad_t); break;
8417 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8419 case 'h': iv = (short)tiv; break;
8420 case 'l': iv = (long)tiv; break;
8422 default: iv = tiv; break;
8424 case 'q': iv = (Quad_t)tiv; break;
8428 if ( !vectorize ) /* we already set uv above */
8433 esignbuf[esignlen++] = plus;
8437 esignbuf[esignlen++] = '-';
8480 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8491 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8492 case 'l': uv = va_arg(*args, unsigned long); break;
8493 case 'V': uv = va_arg(*args, UV); break;
8494 default: uv = va_arg(*args, unsigned); break;
8496 case 'q': uv = va_arg(*args, Uquad_t); break;
8501 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8503 case 'h': uv = (unsigned short)tuv; break;
8504 case 'l': uv = (unsigned long)tuv; break;
8506 default: uv = tuv; break;
8508 case 'q': uv = (Uquad_t)tuv; break;
8515 char *ptr = ebuf + sizeof ebuf;
8521 p = (char*)((c == 'X')
8522 ? "0123456789ABCDEF" : "0123456789abcdef");
8528 esignbuf[esignlen++] = '0';
8529 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8537 if (alt && *ptr != '0')
8548 esignbuf[esignlen++] = '0';
8549 esignbuf[esignlen++] = 'b';
8552 default: /* it had better be ten or less */
8556 } while (uv /= base);
8559 elen = (ebuf + sizeof ebuf) - ptr;
8563 zeros = precis - elen;
8564 else if (precis == 0 && elen == 1 && *eptr == '0')
8570 /* FLOATING POINT */
8573 c = 'f'; /* maybe %F isn't supported here */
8581 /* This is evil, but floating point is even more evil */
8583 /* for SV-style calling, we can only get NV
8584 for C-style calling, we assume %f is double;
8585 for simplicity we allow any of %Lf, %llf, %qf for long double
8589 #if defined(USE_LONG_DOUBLE)
8593 /* [perl #20339] - we should accept and ignore %lf rather than die */
8597 #if defined(USE_LONG_DOUBLE)
8598 intsize = args ? 0 : 'q';
8602 #if defined(HAS_LONG_DOUBLE)
8611 /* now we need (long double) if intsize == 'q', else (double) */
8613 #if LONG_DOUBLESIZE > DOUBLESIZE
8615 va_arg(*args, long double) :
8616 va_arg(*args, double)
8618 va_arg(*args, double)
8623 if (c != 'e' && c != 'E') {
8625 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8626 will cast our (long double) to (double) */
8627 (void)Perl_frexp(nv, &i);
8628 if (i == PERL_INT_MIN)
8629 Perl_die(aTHX_ "panic: frexp");
8631 need = BIT_DIGITS(i);
8633 need += has_precis ? precis : 6; /* known default */
8638 #ifdef HAS_LDBL_SPRINTF_BUG
8639 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8640 with sfio - Allen <allens@cpan.org> */
8643 # define MY_DBL_MAX DBL_MAX
8644 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8645 # if DOUBLESIZE >= 8
8646 # define MY_DBL_MAX 1.7976931348623157E+308L
8648 # define MY_DBL_MAX 3.40282347E+38L
8652 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8653 # define MY_DBL_MAX_BUG 1L
8655 # define MY_DBL_MAX_BUG MY_DBL_MAX
8659 # define MY_DBL_MIN DBL_MIN
8660 # else /* XXX guessing! -Allen */
8661 # if DOUBLESIZE >= 8
8662 # define MY_DBL_MIN 2.2250738585072014E-308L
8664 # define MY_DBL_MIN 1.17549435E-38L
8668 if ((intsize == 'q') && (c == 'f') &&
8669 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8671 /* it's going to be short enough that
8672 * long double precision is not needed */
8674 if ((nv <= 0L) && (nv >= -0L))
8675 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8677 /* would use Perl_fp_class as a double-check but not
8678 * functional on IRIX - see perl.h comments */
8680 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8681 /* It's within the range that a double can represent */
8682 #if defined(DBL_MAX) && !defined(DBL_MIN)
8683 if ((nv >= ((long double)1/DBL_MAX)) ||
8684 (nv <= (-(long double)1/DBL_MAX)))
8686 fix_ldbl_sprintf_bug = TRUE;
8689 if (fix_ldbl_sprintf_bug == TRUE) {
8699 # undef MY_DBL_MAX_BUG
8702 #endif /* HAS_LDBL_SPRINTF_BUG */
8704 need += 20; /* fudge factor */
8705 if (PL_efloatsize < need) {
8706 Safefree(PL_efloatbuf);
8707 PL_efloatsize = need + 20; /* more fudge */
8708 Newx(PL_efloatbuf, PL_efloatsize, char);
8709 PL_efloatbuf[0] = '\0';
8712 if ( !(width || left || plus || alt) && fill != '0'
8713 && has_precis && intsize != 'q' ) { /* Shortcuts */
8714 /* See earlier comment about buggy Gconvert when digits,
8716 if ( c == 'g' && precis) {
8717 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8718 /* May return an empty string for digits==0 */
8719 if (*PL_efloatbuf) {
8720 elen = strlen(PL_efloatbuf);
8721 goto float_converted;
8723 } else if ( c == 'f' && !precis) {
8724 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8729 char *ptr = ebuf + sizeof ebuf;
8732 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8733 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8734 if (intsize == 'q') {
8735 /* Copy the one or more characters in a long double
8736 * format before the 'base' ([efgEFG]) character to
8737 * the format string. */
8738 static char const prifldbl[] = PERL_PRIfldbl;
8739 char const *p = prifldbl + sizeof(prifldbl) - 3;
8740 while (p >= prifldbl) { *--ptr = *p--; }
8745 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8750 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8762 /* No taint. Otherwise we are in the strange situation
8763 * where printf() taints but print($float) doesn't.
8765 #if defined(HAS_LONG_DOUBLE)
8766 elen = ((intsize == 'q')
8767 ? my_sprintf(PL_efloatbuf, ptr, nv)
8768 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8770 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8774 eptr = PL_efloatbuf;
8782 i = SvCUR(sv) - origlen;
8785 case 'h': *(va_arg(*args, short*)) = i; break;
8786 default: *(va_arg(*args, int*)) = i; break;
8787 case 'l': *(va_arg(*args, long*)) = i; break;
8788 case 'V': *(va_arg(*args, IV*)) = i; break;
8790 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8795 sv_setuv_mg(argsv, (UV)i);
8796 continue; /* not "break" */
8803 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8804 && ckWARN(WARN_PRINTF))
8806 SV * const msg = sv_newmortal();
8807 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8808 (PL_op->op_type == OP_PRTF) ? "" : "s");
8811 Perl_sv_catpvf(aTHX_ msg,
8812 "\"%%%c\"", c & 0xFF);
8814 Perl_sv_catpvf(aTHX_ msg,
8815 "\"%%\\%03"UVof"\"",
8818 sv_catpvs(msg, "end of string");
8819 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8822 /* output mangled stuff ... */
8828 /* ... right here, because formatting flags should not apply */
8829 SvGROW(sv, SvCUR(sv) + elen + 1);
8831 Copy(eptr, p, elen, char);
8834 SvCUR_set(sv, p - SvPVX_const(sv));
8836 continue; /* not "break" */
8839 /* calculate width before utf8_upgrade changes it */
8840 have = esignlen + zeros + elen;
8842 Perl_croak_nocontext(PL_memory_wrap);
8844 if (is_utf8 != has_utf8) {
8847 sv_utf8_upgrade(sv);
8850 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8851 sv_utf8_upgrade(nsv);
8852 eptr = SvPVX_const(nsv);
8855 SvGROW(sv, SvCUR(sv) + elen + 1);
8860 need = (have > width ? have : width);
8863 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8864 Perl_croak_nocontext(PL_memory_wrap);
8865 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8867 if (esignlen && fill == '0') {
8869 for (i = 0; i < (int)esignlen; i++)
8873 memset(p, fill, gap);
8876 if (esignlen && fill != '0') {
8878 for (i = 0; i < (int)esignlen; i++)
8883 for (i = zeros; i; i--)
8887 Copy(eptr, p, elen, char);
8891 memset(p, ' ', gap);
8896 Copy(dotstr, p, dotstrlen, char);
8900 vectorize = FALSE; /* done iterating over vecstr */
8907 SvCUR_set(sv, p - SvPVX_const(sv));
8915 /* =========================================================================
8917 =head1 Cloning an interpreter
8919 All the macros and functions in this section are for the private use of
8920 the main function, perl_clone().
8922 The foo_dup() functions make an exact copy of an existing foo thinngy.
8923 During the course of a cloning, a hash table is used to map old addresses
8924 to new addresses. The table is created and manipulated with the
8925 ptr_table_* functions.
8929 ============================================================================*/
8932 #if defined(USE_ITHREADS)
8934 #ifndef GpREFCNT_inc
8935 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8939 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8940 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8941 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8942 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8943 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8944 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8945 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8946 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8947 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8948 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8949 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8950 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8951 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8954 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8955 regcomp.c. AMS 20010712 */
8958 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8963 struct reg_substr_datum *s;
8966 return (REGEXP *)NULL;
8968 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8971 len = r->offsets[0];
8972 npar = r->nparens+1;
8974 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8975 Copy(r->program, ret->program, len+1, regnode);
8977 Newx(ret->startp, npar, I32);
8978 Copy(r->startp, ret->startp, npar, I32);
8979 Newx(ret->endp, npar, I32);
8980 Copy(r->startp, ret->startp, npar, I32);
8982 Newx(ret->substrs, 1, struct reg_substr_data);
8983 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8984 s->min_offset = r->substrs->data[i].min_offset;
8985 s->max_offset = r->substrs->data[i].max_offset;
8986 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8987 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8990 ret->regstclass = NULL;
8993 const int count = r->data->count;
8996 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8997 char, struct reg_data);
8998 Newx(d->what, count, U8);
9001 for (i = 0; i < count; i++) {
9002 d->what[i] = r->data->what[i];
9003 switch (d->what[i]) {
9004 /* legal options are one of: sfpont
9005 see also regcomp.h and pregfree() */
9007 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9010 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9013 /* This is cheating. */
9014 Newx(d->data[i], 1, struct regnode_charclass_class);
9015 StructCopy(r->data->data[i], d->data[i],
9016 struct regnode_charclass_class);
9017 ret->regstclass = (regnode*)d->data[i];
9020 /* Compiled op trees are readonly, and can thus be
9021 shared without duplication. */
9023 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9027 d->data[i] = r->data->data[i];
9030 d->data[i] = r->data->data[i];
9032 ((reg_trie_data*)d->data[i])->refcount++;
9036 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9045 Newx(ret->offsets, 2*len+1, U32);
9046 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9048 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9049 ret->refcnt = r->refcnt;
9050 ret->minlen = r->minlen;
9051 ret->prelen = r->prelen;
9052 ret->nparens = r->nparens;
9053 ret->lastparen = r->lastparen;
9054 ret->lastcloseparen = r->lastcloseparen;
9055 ret->reganch = r->reganch;
9057 ret->sublen = r->sublen;
9059 if (RX_MATCH_COPIED(ret))
9060 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9062 ret->subbeg = Nullch;
9063 #ifdef PERL_OLD_COPY_ON_WRITE
9064 ret->saved_copy = Nullsv;
9067 ptr_table_store(PL_ptr_table, r, ret);
9071 /* duplicate a file handle */
9074 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9078 PERL_UNUSED_ARG(type);
9081 return (PerlIO*)NULL;
9083 /* look for it in the table first */
9084 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9088 /* create anew and remember what it is */
9089 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9090 ptr_table_store(PL_ptr_table, fp, ret);
9094 /* duplicate a directory handle */
9097 Perl_dirp_dup(pTHX_ DIR *dp)
9105 /* duplicate a typeglob */
9108 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9113 /* look for it in the table first */
9114 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9118 /* create anew and remember what it is */
9120 ptr_table_store(PL_ptr_table, gp, ret);
9123 ret->gp_refcnt = 0; /* must be before any other dups! */
9124 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9125 ret->gp_io = io_dup_inc(gp->gp_io, param);
9126 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9127 ret->gp_av = av_dup_inc(gp->gp_av, param);
9128 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9129 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9130 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9131 ret->gp_cvgen = gp->gp_cvgen;
9132 ret->gp_line = gp->gp_line;
9133 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9137 /* duplicate a chain of magic */
9140 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9142 MAGIC *mgprev = (MAGIC*)NULL;
9145 return (MAGIC*)NULL;
9146 /* look for it in the table first */
9147 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9151 for (; mg; mg = mg->mg_moremagic) {
9153 Newxz(nmg, 1, MAGIC);
9155 mgprev->mg_moremagic = nmg;
9158 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9159 nmg->mg_private = mg->mg_private;
9160 nmg->mg_type = mg->mg_type;
9161 nmg->mg_flags = mg->mg_flags;
9162 if (mg->mg_type == PERL_MAGIC_qr) {
9163 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9165 else if(mg->mg_type == PERL_MAGIC_backref) {
9166 /* The backref AV has its reference count deliberately bumped by
9168 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9170 else if (mg->mg_type == PERL_MAGIC_symtab) {
9171 nmg->mg_obj = mg->mg_obj;
9174 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9175 ? sv_dup_inc(mg->mg_obj, param)
9176 : sv_dup(mg->mg_obj, param);
9178 nmg->mg_len = mg->mg_len;
9179 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9180 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9181 if (mg->mg_len > 0) {
9182 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9183 if (mg->mg_type == PERL_MAGIC_overload_table &&
9184 AMT_AMAGIC((AMT*)mg->mg_ptr))
9186 const AMT * const amtp = (AMT*)mg->mg_ptr;
9187 AMT * const namtp = (AMT*)nmg->mg_ptr;
9189 for (i = 1; i < NofAMmeth; i++) {
9190 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9194 else if (mg->mg_len == HEf_SVKEY)
9195 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9197 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9198 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9205 /* create a new pointer-mapping table */
9208 Perl_ptr_table_new(pTHX)
9211 Newxz(tbl, 1, PTR_TBL_t);
9214 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9218 #define PTR_TABLE_HASH(ptr) \
9219 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9222 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9223 following define) and at call to new_body_inline made below in
9224 Perl_ptr_table_store()
9227 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9229 /* map an existing pointer using a table */
9231 STATIC PTR_TBL_ENT_t *
9232 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9233 PTR_TBL_ENT_t *tblent;
9234 const UV hash = PTR_TABLE_HASH(sv);
9236 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9237 for (; tblent; tblent = tblent->next) {
9238 if (tblent->oldval == sv)
9245 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9247 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9248 return tblent ? tblent->newval : (void *) 0;
9251 /* add a new entry to a pointer-mapping table */
9254 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9256 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9259 tblent->newval = newsv;
9261 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9263 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9264 tblent->oldval = oldsv;
9265 tblent->newval = newsv;
9266 tblent->next = tbl->tbl_ary[entry];
9267 tbl->tbl_ary[entry] = tblent;
9269 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9270 ptr_table_split(tbl);
9274 /* double the hash bucket size of an existing ptr table */
9277 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9279 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9280 const UV oldsize = tbl->tbl_max + 1;
9281 UV newsize = oldsize * 2;
9284 Renew(ary, newsize, PTR_TBL_ENT_t*);
9285 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9286 tbl->tbl_max = --newsize;
9288 for (i=0; i < oldsize; i++, ary++) {
9289 PTR_TBL_ENT_t **curentp, **entp, *ent;
9292 curentp = ary + oldsize;
9293 for (entp = ary, ent = *ary; ent; ent = *entp) {
9294 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9296 ent->next = *curentp;
9306 /* remove all the entries from a ptr table */
9309 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9311 if (tbl && tbl->tbl_items) {
9312 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9313 UV riter = tbl->tbl_max;
9316 PTR_TBL_ENT_t *entry = array[riter];
9319 PTR_TBL_ENT_t * const oentry = entry;
9320 entry = entry->next;
9329 /* clear and free a ptr table */
9332 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9337 ptr_table_clear(tbl);
9338 Safefree(tbl->tbl_ary);
9344 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9347 SvRV_set(dstr, SvWEAKREF(sstr)
9348 ? sv_dup(SvRV(sstr), param)
9349 : sv_dup_inc(SvRV(sstr), param));
9352 else if (SvPVX_const(sstr)) {
9353 /* Has something there */
9355 /* Normal PV - clone whole allocated space */
9356 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9357 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9358 /* Not that normal - actually sstr is copy on write.
9359 But we are a true, independant SV, so: */
9360 SvREADONLY_off(dstr);
9365 /* Special case - not normally malloced for some reason */
9366 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9367 /* A "shared" PV - clone it as "shared" PV */
9369 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9373 /* Some other special case - random pointer */
9374 SvPV_set(dstr, SvPVX(sstr));
9380 if (SvTYPE(dstr) == SVt_RV)
9381 SvRV_set(dstr, NULL);
9383 SvPV_set(dstr, NULL);
9387 /* duplicate an SV of any type (including AV, HV etc) */
9390 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9395 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9397 /* look for it in the table first */
9398 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9402 if(param->flags & CLONEf_JOIN_IN) {
9403 /** We are joining here so we don't want do clone
9404 something that is bad **/
9405 if (SvTYPE(sstr) == SVt_PVHV) {
9406 const char * const hvname = HvNAME_get(sstr);
9408 /** don't clone stashes if they already exist **/
9409 return (SV*)gv_stashpv(hvname,0);
9413 /* create anew and remember what it is */
9416 #ifdef DEBUG_LEAKING_SCALARS
9417 dstr->sv_debug_optype = sstr->sv_debug_optype;
9418 dstr->sv_debug_line = sstr->sv_debug_line;
9419 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9420 dstr->sv_debug_cloned = 1;
9421 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9424 ptr_table_store(PL_ptr_table, sstr, dstr);
9427 SvFLAGS(dstr) = SvFLAGS(sstr);
9428 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9429 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9432 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9433 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9434 PL_watch_pvx, SvPVX_const(sstr));
9437 /* don't clone objects whose class has asked us not to */
9438 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9439 SvFLAGS(dstr) &= ~SVTYPEMASK;
9444 switch (SvTYPE(sstr)) {
9449 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9450 SvIV_set(dstr, SvIVX(sstr));
9453 SvANY(dstr) = new_XNV();
9454 SvNV_set(dstr, SvNVX(sstr));
9457 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9458 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9462 /* These are all the types that need complex bodies allocating. */
9464 const svtype sv_type = SvTYPE(sstr);
9465 const struct body_details *const sv_type_details
9466 = bodies_by_type + sv_type;
9470 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9475 if (GvUNIQUE((GV*)sstr)) {
9476 /* Do sharing here, and fall through */
9489 assert(sv_type_details->size);
9490 if (sv_type_details->arena) {
9491 new_body_inline(new_body, sv_type_details->size, sv_type);
9493 = (void*)((char*)new_body - sv_type_details->offset);
9495 new_body = new_NOARENA(sv_type_details);
9499 SvANY(dstr) = new_body;
9502 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9503 ((char*)SvANY(dstr)) + sv_type_details->offset,
9504 sv_type_details->copy, char);
9506 Copy(((char*)SvANY(sstr)),
9507 ((char*)SvANY(dstr)),
9508 sv_type_details->size + sv_type_details->offset, char);
9511 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9512 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9514 /* The Copy above means that all the source (unduplicated) pointers
9515 are now in the destination. We can check the flags and the
9516 pointers in either, but it's possible that there's less cache
9517 missing by always going for the destination.
9518 FIXME - instrument and check that assumption */
9519 if (sv_type >= SVt_PVMG) {
9521 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9523 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9526 /* The cast silences a GCC warning about unhandled types. */
9527 switch ((int)sv_type) {
9539 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9540 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9541 LvTARG(dstr) = dstr;
9542 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9543 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9545 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9548 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9549 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9550 /* Don't call sv_add_backref here as it's going to be created
9551 as part of the magic cloning of the symbol table. */
9552 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9553 (void)GpREFCNT_inc(GvGP(dstr));
9556 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9557 if (IoOFP(dstr) == IoIFP(sstr))
9558 IoOFP(dstr) = IoIFP(dstr);
9560 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9561 /* PL_rsfp_filters entries have fake IoDIRP() */
9562 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9563 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9564 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9565 /* I have no idea why fake dirp (rsfps)
9566 should be treated differently but otherwise
9567 we end up with leaks -- sky*/
9568 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9569 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9570 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9572 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9573 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9574 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9576 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9577 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9578 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9581 if (AvARRAY((AV*)sstr)) {
9582 SV **dst_ary, **src_ary;
9583 SSize_t items = AvFILLp((AV*)sstr) + 1;
9585 src_ary = AvARRAY((AV*)sstr);
9586 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9587 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9588 SvPV_set(dstr, (char*)dst_ary);
9589 AvALLOC((AV*)dstr) = dst_ary;
9590 if (AvREAL((AV*)sstr)) {
9592 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9596 *dst_ary++ = sv_dup(*src_ary++, param);
9598 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9599 while (items-- > 0) {
9600 *dst_ary++ = &PL_sv_undef;
9604 SvPV_set(dstr, Nullch);
9605 AvALLOC((AV*)dstr) = (SV**)NULL;
9612 if (HvARRAY((HV*)sstr)) {
9614 const bool sharekeys = !!HvSHAREKEYS(sstr);
9615 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9616 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9618 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9619 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9621 HvARRAY(dstr) = (HE**)darray;
9622 while (i <= sxhv->xhv_max) {
9623 const HE *source = HvARRAY(sstr)[i];
9624 HvARRAY(dstr)[i] = source
9625 ? he_dup(source, sharekeys, param) : 0;
9629 struct xpvhv_aux * const saux = HvAUX(sstr);
9630 struct xpvhv_aux * const daux = HvAUX(dstr);
9631 /* This flag isn't copied. */
9632 /* SvOOK_on(hv) attacks the IV flags. */
9633 SvFLAGS(dstr) |= SVf_OOK;
9635 hvname = saux->xhv_name;
9637 = hvname ? hek_dup(hvname, param) : hvname;
9639 daux->xhv_riter = saux->xhv_riter;
9640 daux->xhv_eiter = saux->xhv_eiter
9641 ? he_dup(saux->xhv_eiter,
9642 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9643 daux->xhv_backreferences = saux->xhv_backreferences
9644 ? (AV*) SvREFCNT_inc(
9652 SvPV_set(dstr, Nullch);
9654 /* Record stashes for possible cloning in Perl_clone(). */
9656 av_push(param->stashes, dstr);
9661 /* NOTE: not refcounted */
9662 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9664 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9666 if (CvCONST(dstr)) {
9667 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9668 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9669 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9671 /* don't dup if copying back - CvGV isn't refcounted, so the
9672 * duped GV may never be freed. A bit of a hack! DAPM */
9673 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9674 Nullgv : gv_dup(CvGV(dstr), param) ;
9675 if (!(param->flags & CLONEf_COPY_STACKS)) {
9678 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9681 ? cv_dup( CvOUTSIDE(dstr), param)
9682 : cv_dup_inc(CvOUTSIDE(dstr), param);
9684 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9690 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9696 /* duplicate a context */
9699 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9704 return (PERL_CONTEXT*)NULL;
9706 /* look for it in the table first */
9707 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9711 /* create anew and remember what it is */
9712 Newxz(ncxs, max + 1, PERL_CONTEXT);
9713 ptr_table_store(PL_ptr_table, cxs, ncxs);
9716 PERL_CONTEXT * const cx = &cxs[ix];
9717 PERL_CONTEXT * const ncx = &ncxs[ix];
9718 ncx->cx_type = cx->cx_type;
9719 if (CxTYPE(cx) == CXt_SUBST) {
9720 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9723 ncx->blk_oldsp = cx->blk_oldsp;
9724 ncx->blk_oldcop = cx->blk_oldcop;
9725 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9726 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9727 ncx->blk_oldpm = cx->blk_oldpm;
9728 ncx->blk_gimme = cx->blk_gimme;
9729 switch (CxTYPE(cx)) {
9731 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9732 ? cv_dup_inc(cx->blk_sub.cv, param)
9733 : cv_dup(cx->blk_sub.cv,param));
9734 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9735 ? av_dup_inc(cx->blk_sub.argarray, param)
9737 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9738 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9739 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9740 ncx->blk_sub.lval = cx->blk_sub.lval;
9741 ncx->blk_sub.retop = cx->blk_sub.retop;
9744 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9745 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9746 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9747 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9748 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9749 ncx->blk_eval.retop = cx->blk_eval.retop;
9752 ncx->blk_loop.label = cx->blk_loop.label;
9753 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9754 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9755 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9756 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9757 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9758 ? cx->blk_loop.iterdata
9759 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9760 ncx->blk_loop.oldcomppad
9761 = (PAD*)ptr_table_fetch(PL_ptr_table,
9762 cx->blk_loop.oldcomppad);
9763 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9764 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9765 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9766 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9767 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9770 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9771 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9772 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9773 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9774 ncx->blk_sub.retop = cx->blk_sub.retop;
9786 /* duplicate a stack info structure */
9789 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9794 return (PERL_SI*)NULL;
9796 /* look for it in the table first */
9797 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9801 /* create anew and remember what it is */
9802 Newxz(nsi, 1, PERL_SI);
9803 ptr_table_store(PL_ptr_table, si, nsi);
9805 nsi->si_stack = av_dup_inc(si->si_stack, param);
9806 nsi->si_cxix = si->si_cxix;
9807 nsi->si_cxmax = si->si_cxmax;
9808 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9809 nsi->si_type = si->si_type;
9810 nsi->si_prev = si_dup(si->si_prev, param);
9811 nsi->si_next = si_dup(si->si_next, param);
9812 nsi->si_markoff = si->si_markoff;
9817 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9818 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9819 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9820 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9821 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9822 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9823 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9824 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9825 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9826 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9827 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9828 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9829 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9830 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9833 #define pv_dup_inc(p) SAVEPV(p)
9834 #define pv_dup(p) SAVEPV(p)
9835 #define svp_dup_inc(p,pp) any_dup(p,pp)
9837 /* map any object to the new equivent - either something in the
9838 * ptr table, or something in the interpreter structure
9842 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9849 /* look for it in the table first */
9850 ret = ptr_table_fetch(PL_ptr_table, v);
9854 /* see if it is part of the interpreter structure */
9855 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9856 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9864 /* duplicate the save stack */
9867 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9869 ANY * const ss = proto_perl->Tsavestack;
9870 const I32 max = proto_perl->Tsavestack_max;
9871 I32 ix = proto_perl->Tsavestack_ix;
9883 void (*dptr) (void*);
9884 void (*dxptr) (pTHX_ void*);
9886 Newxz(nss, max, ANY);
9889 I32 i = POPINT(ss,ix);
9892 case SAVEt_ITEM: /* normal string */
9893 sv = (SV*)POPPTR(ss,ix);
9894 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9895 sv = (SV*)POPPTR(ss,ix);
9896 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9898 case SAVEt_SV: /* scalar reference */
9899 sv = (SV*)POPPTR(ss,ix);
9900 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9901 gv = (GV*)POPPTR(ss,ix);
9902 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9904 case SAVEt_GENERIC_PVREF: /* generic char* */
9905 c = (char*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = pv_dup(c);
9907 ptr = POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9910 case SAVEt_SHARED_PVREF: /* char* in shared space */
9911 c = (char*)POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = savesharedpv(c);
9913 ptr = POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9916 case SAVEt_GENERIC_SVREF: /* generic sv */
9917 case SAVEt_SVREF: /* scalar reference */
9918 sv = (SV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9920 ptr = POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9923 case SAVEt_AV: /* array reference */
9924 av = (AV*)POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = av_dup_inc(av, param);
9926 gv = (GV*)POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = gv_dup(gv, param);
9929 case SAVEt_HV: /* hash reference */
9930 hv = (HV*)POPPTR(ss,ix);
9931 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9932 gv = (GV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = gv_dup(gv, param);
9935 case SAVEt_INT: /* int reference */
9936 ptr = POPPTR(ss,ix);
9937 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9938 intval = (int)POPINT(ss,ix);
9939 TOPINT(nss,ix) = intval;
9941 case SAVEt_LONG: /* long reference */
9942 ptr = POPPTR(ss,ix);
9943 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9944 longval = (long)POPLONG(ss,ix);
9945 TOPLONG(nss,ix) = longval;
9947 case SAVEt_I32: /* I32 reference */
9948 case SAVEt_I16: /* I16 reference */
9949 case SAVEt_I8: /* I8 reference */
9950 ptr = POPPTR(ss,ix);
9951 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9955 case SAVEt_IV: /* IV reference */
9956 ptr = POPPTR(ss,ix);
9957 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9961 case SAVEt_SPTR: /* SV* reference */
9962 ptr = POPPTR(ss,ix);
9963 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9964 sv = (SV*)POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = sv_dup(sv, param);
9967 case SAVEt_VPTR: /* random* reference */
9968 ptr = POPPTR(ss,ix);
9969 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9970 ptr = POPPTR(ss,ix);
9971 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9973 case SAVEt_PPTR: /* char* reference */
9974 ptr = POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9976 c = (char*)POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = pv_dup(c);
9979 case SAVEt_HPTR: /* HV* reference */
9980 ptr = POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9982 hv = (HV*)POPPTR(ss,ix);
9983 TOPPTR(nss,ix) = hv_dup(hv, param);
9985 case SAVEt_APTR: /* AV* reference */
9986 ptr = POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9988 av = (AV*)POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = av_dup(av, param);
9992 gv = (GV*)POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = gv_dup(gv, param);
9995 case SAVEt_GP: /* scalar reference */
9996 gp = (GP*)POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9998 (void)GpREFCNT_inc(gp);
9999 gv = (GV*)POPPTR(ss,ix);
10000 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10001 c = (char*)POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = pv_dup(c);
10004 TOPIV(nss,ix) = iv;
10006 TOPIV(nss,ix) = iv;
10009 case SAVEt_MORTALIZESV:
10010 sv = (SV*)POPPTR(ss,ix);
10011 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10014 ptr = POPPTR(ss,ix);
10015 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10016 /* these are assumed to be refcounted properly */
10018 switch (((OP*)ptr)->op_type) {
10020 case OP_LEAVESUBLV:
10024 case OP_LEAVEWRITE:
10025 TOPPTR(nss,ix) = ptr;
10030 TOPPTR(nss,ix) = Nullop;
10035 TOPPTR(nss,ix) = Nullop;
10038 c = (char*)POPPTR(ss,ix);
10039 TOPPTR(nss,ix) = pv_dup_inc(c);
10041 case SAVEt_CLEARSV:
10042 longval = POPLONG(ss,ix);
10043 TOPLONG(nss,ix) = longval;
10046 hv = (HV*)POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10048 c = (char*)POPPTR(ss,ix);
10049 TOPPTR(nss,ix) = pv_dup_inc(c);
10051 TOPINT(nss,ix) = i;
10053 case SAVEt_DESTRUCTOR:
10054 ptr = POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10056 dptr = POPDPTR(ss,ix);
10057 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10058 any_dup(FPTR2DPTR(void *, dptr),
10061 case SAVEt_DESTRUCTOR_X:
10062 ptr = POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10064 dxptr = POPDXPTR(ss,ix);
10065 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10066 any_dup(FPTR2DPTR(void *, dxptr),
10069 case SAVEt_REGCONTEXT:
10072 TOPINT(nss,ix) = i;
10075 case SAVEt_STACK_POS: /* Position on Perl stack */
10077 TOPINT(nss,ix) = i;
10079 case SAVEt_AELEM: /* array element */
10080 sv = (SV*)POPPTR(ss,ix);
10081 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10083 TOPINT(nss,ix) = i;
10084 av = (AV*)POPPTR(ss,ix);
10085 TOPPTR(nss,ix) = av_dup_inc(av, param);
10087 case SAVEt_HELEM: /* hash element */
10088 sv = (SV*)POPPTR(ss,ix);
10089 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10090 sv = (SV*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10092 hv = (HV*)POPPTR(ss,ix);
10093 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10096 ptr = POPPTR(ss,ix);
10097 TOPPTR(nss,ix) = ptr;
10101 TOPINT(nss,ix) = i;
10103 case SAVEt_COMPPAD:
10104 av = (AV*)POPPTR(ss,ix);
10105 TOPPTR(nss,ix) = av_dup(av, param);
10108 longval = (long)POPLONG(ss,ix);
10109 TOPLONG(nss,ix) = longval;
10110 ptr = POPPTR(ss,ix);
10111 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10112 sv = (SV*)POPPTR(ss,ix);
10113 TOPPTR(nss,ix) = sv_dup(sv, param);
10116 ptr = POPPTR(ss,ix);
10117 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10118 longval = (long)POPBOOL(ss,ix);
10119 TOPBOOL(nss,ix) = (bool)longval;
10121 case SAVEt_SET_SVFLAGS:
10123 TOPINT(nss,ix) = i;
10125 TOPINT(nss,ix) = i;
10126 sv = (SV*)POPPTR(ss,ix);
10127 TOPPTR(nss,ix) = sv_dup(sv, param);
10130 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10138 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10139 * flag to the result. This is done for each stash before cloning starts,
10140 * so we know which stashes want their objects cloned */
10143 do_mark_cloneable_stash(pTHX_ SV *sv)
10145 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10147 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10148 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10149 if (cloner && GvCV(cloner)) {
10156 XPUSHs(sv_2mortal(newSVhek(hvname)));
10158 call_sv((SV*)GvCV(cloner), G_SCALAR);
10165 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10173 =for apidoc perl_clone
10175 Create and return a new interpreter by cloning the current one.
10177 perl_clone takes these flags as parameters:
10179 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10180 without it we only clone the data and zero the stacks,
10181 with it we copy the stacks and the new perl interpreter is
10182 ready to run at the exact same point as the previous one.
10183 The pseudo-fork code uses COPY_STACKS while the
10184 threads->new doesn't.
10186 CLONEf_KEEP_PTR_TABLE
10187 perl_clone keeps a ptr_table with the pointer of the old
10188 variable as a key and the new variable as a value,
10189 this allows it to check if something has been cloned and not
10190 clone it again but rather just use the value and increase the
10191 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10192 the ptr_table using the function
10193 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10194 reason to keep it around is if you want to dup some of your own
10195 variable who are outside the graph perl scans, example of this
10196 code is in threads.xs create
10199 This is a win32 thing, it is ignored on unix, it tells perls
10200 win32host code (which is c++) to clone itself, this is needed on
10201 win32 if you want to run two threads at the same time,
10202 if you just want to do some stuff in a separate perl interpreter
10203 and then throw it away and return to the original one,
10204 you don't need to do anything.
10209 /* XXX the above needs expanding by someone who actually understands it ! */
10210 EXTERN_C PerlInterpreter *
10211 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10214 perl_clone(PerlInterpreter *proto_perl, UV flags)
10217 #ifdef PERL_IMPLICIT_SYS
10219 /* perlhost.h so we need to call into it
10220 to clone the host, CPerlHost should have a c interface, sky */
10222 if (flags & CLONEf_CLONE_HOST) {
10223 return perl_clone_host(proto_perl,flags);
10225 return perl_clone_using(proto_perl, flags,
10227 proto_perl->IMemShared,
10228 proto_perl->IMemParse,
10230 proto_perl->IStdIO,
10234 proto_perl->IProc);
10238 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10239 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10240 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10241 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10242 struct IPerlDir* ipD, struct IPerlSock* ipS,
10243 struct IPerlProc* ipP)
10245 /* XXX many of the string copies here can be optimized if they're
10246 * constants; they need to be allocated as common memory and just
10247 * their pointers copied. */
10250 CLONE_PARAMS clone_params;
10251 CLONE_PARAMS* param = &clone_params;
10253 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10254 /* for each stash, determine whether its objects should be cloned */
10255 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10256 PERL_SET_THX(my_perl);
10259 Poison(my_perl, 1, PerlInterpreter);
10261 PL_curcop = (COP *)Nullop;
10265 PL_savestack_ix = 0;
10266 PL_savestack_max = -1;
10267 PL_sig_pending = 0;
10268 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10269 # else /* !DEBUGGING */
10270 Zero(my_perl, 1, PerlInterpreter);
10271 # endif /* DEBUGGING */
10273 /* host pointers */
10275 PL_MemShared = ipMS;
10276 PL_MemParse = ipMP;
10283 #else /* !PERL_IMPLICIT_SYS */
10285 CLONE_PARAMS clone_params;
10286 CLONE_PARAMS* param = &clone_params;
10287 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10288 /* for each stash, determine whether its objects should be cloned */
10289 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10290 PERL_SET_THX(my_perl);
10293 Poison(my_perl, 1, PerlInterpreter);
10295 PL_curcop = (COP *)Nullop;
10299 PL_savestack_ix = 0;
10300 PL_savestack_max = -1;
10301 PL_sig_pending = 0;
10302 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10303 # else /* !DEBUGGING */
10304 Zero(my_perl, 1, PerlInterpreter);
10305 # endif /* DEBUGGING */
10306 #endif /* PERL_IMPLICIT_SYS */
10307 param->flags = flags;
10308 param->proto_perl = proto_perl;
10310 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10311 Zero(&PL_body_roots, 1, PL_body_roots);
10313 PL_nice_chunk = NULL;
10314 PL_nice_chunk_size = 0;
10316 PL_sv_objcount = 0;
10317 PL_sv_root = Nullsv;
10318 PL_sv_arenaroot = Nullsv;
10320 PL_debug = proto_perl->Idebug;
10322 PL_hash_seed = proto_perl->Ihash_seed;
10323 PL_rehash_seed = proto_perl->Irehash_seed;
10325 #ifdef USE_REENTRANT_API
10326 /* XXX: things like -Dm will segfault here in perlio, but doing
10327 * PERL_SET_CONTEXT(proto_perl);
10328 * breaks too many other things
10330 Perl_reentrant_init(aTHX);
10333 /* create SV map for pointer relocation */
10334 PL_ptr_table = ptr_table_new();
10336 /* initialize these special pointers as early as possible */
10337 SvANY(&PL_sv_undef) = NULL;
10338 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10339 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10340 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10342 SvANY(&PL_sv_no) = new_XPVNV();
10343 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10344 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10345 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10346 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10347 SvCUR_set(&PL_sv_no, 0);
10348 SvLEN_set(&PL_sv_no, 1);
10349 SvIV_set(&PL_sv_no, 0);
10350 SvNV_set(&PL_sv_no, 0);
10351 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10353 SvANY(&PL_sv_yes) = new_XPVNV();
10354 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10355 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10356 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10357 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10358 SvCUR_set(&PL_sv_yes, 1);
10359 SvLEN_set(&PL_sv_yes, 2);
10360 SvIV_set(&PL_sv_yes, 1);
10361 SvNV_set(&PL_sv_yes, 1);
10362 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10364 /* create (a non-shared!) shared string table */
10365 PL_strtab = newHV();
10366 HvSHAREKEYS_off(PL_strtab);
10367 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10368 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10370 PL_compiling = proto_perl->Icompiling;
10372 /* These two PVs will be free'd special way so must set them same way op.c does */
10373 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10374 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10376 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10377 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10379 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10380 if (!specialWARN(PL_compiling.cop_warnings))
10381 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10382 if (!specialCopIO(PL_compiling.cop_io))
10383 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10384 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10386 /* pseudo environmental stuff */
10387 PL_origargc = proto_perl->Iorigargc;
10388 PL_origargv = proto_perl->Iorigargv;
10390 param->stashes = newAV(); /* Setup array of objects to call clone on */
10392 /* Set tainting stuff before PerlIO_debug can possibly get called */
10393 PL_tainting = proto_perl->Itainting;
10394 PL_taint_warn = proto_perl->Itaint_warn;
10396 #ifdef PERLIO_LAYERS
10397 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10398 PerlIO_clone(aTHX_ proto_perl, param);
10401 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10402 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10403 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10404 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10405 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10406 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10409 PL_minus_c = proto_perl->Iminus_c;
10410 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10411 PL_localpatches = proto_perl->Ilocalpatches;
10412 PL_splitstr = proto_perl->Isplitstr;
10413 PL_preprocess = proto_perl->Ipreprocess;
10414 PL_minus_n = proto_perl->Iminus_n;
10415 PL_minus_p = proto_perl->Iminus_p;
10416 PL_minus_l = proto_perl->Iminus_l;
10417 PL_minus_a = proto_perl->Iminus_a;
10418 PL_minus_E = proto_perl->Iminus_E;
10419 PL_minus_F = proto_perl->Iminus_F;
10420 PL_doswitches = proto_perl->Idoswitches;
10421 PL_dowarn = proto_perl->Idowarn;
10422 PL_doextract = proto_perl->Idoextract;
10423 PL_sawampersand = proto_perl->Isawampersand;
10424 PL_unsafe = proto_perl->Iunsafe;
10425 PL_inplace = SAVEPV(proto_perl->Iinplace);
10426 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10427 PL_perldb = proto_perl->Iperldb;
10428 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10429 PL_exit_flags = proto_perl->Iexit_flags;
10431 /* magical thingies */
10432 /* XXX time(&PL_basetime) when asked for? */
10433 PL_basetime = proto_perl->Ibasetime;
10434 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10436 PL_maxsysfd = proto_perl->Imaxsysfd;
10437 PL_multiline = proto_perl->Imultiline;
10438 PL_statusvalue = proto_perl->Istatusvalue;
10440 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10442 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10444 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10446 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10447 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10448 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10450 /* Clone the regex array */
10451 PL_regex_padav = newAV();
10453 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10454 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10456 av_push(PL_regex_padav,
10457 sv_dup_inc(regexen[0],param));
10458 for(i = 1; i <= len; i++) {
10459 const SV * const regex = regexen[i];
10462 ? sv_dup_inc(regex, param)
10464 newSViv(PTR2IV(re_dup(
10465 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10467 av_push(PL_regex_padav, sv);
10470 PL_regex_pad = AvARRAY(PL_regex_padav);
10472 /* shortcuts to various I/O objects */
10473 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10474 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10475 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10476 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10477 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10478 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10480 /* shortcuts to regexp stuff */
10481 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10483 /* shortcuts to misc objects */
10484 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10486 /* shortcuts to debugging objects */
10487 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10488 PL_DBline = gv_dup(proto_perl->IDBline, param);
10489 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10490 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10491 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10492 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10493 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10494 PL_lineary = av_dup(proto_perl->Ilineary, param);
10495 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10497 /* symbol tables */
10498 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10499 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10500 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10501 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10502 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10504 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10505 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10506 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10507 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10508 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10509 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10511 PL_sub_generation = proto_perl->Isub_generation;
10513 /* funky return mechanisms */
10514 PL_forkprocess = proto_perl->Iforkprocess;
10516 /* subprocess state */
10517 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10519 /* internal state */
10520 PL_maxo = proto_perl->Imaxo;
10521 if (proto_perl->Iop_mask)
10522 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10524 PL_op_mask = Nullch;
10525 /* PL_asserting = proto_perl->Iasserting; */
10527 /* current interpreter roots */
10528 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10529 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10530 PL_main_start = proto_perl->Imain_start;
10531 PL_eval_root = proto_perl->Ieval_root;
10532 PL_eval_start = proto_perl->Ieval_start;
10534 /* runtime control stuff */
10535 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10536 PL_copline = proto_perl->Icopline;
10538 PL_filemode = proto_perl->Ifilemode;
10539 PL_lastfd = proto_perl->Ilastfd;
10540 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10543 PL_gensym = proto_perl->Igensym;
10544 PL_preambled = proto_perl->Ipreambled;
10545 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10546 PL_laststatval = proto_perl->Ilaststatval;
10547 PL_laststype = proto_perl->Ilaststype;
10548 PL_mess_sv = Nullsv;
10550 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10552 /* interpreter atexit processing */
10553 PL_exitlistlen = proto_perl->Iexitlistlen;
10554 if (PL_exitlistlen) {
10555 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10556 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10559 PL_exitlist = (PerlExitListEntry*)NULL;
10561 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10562 if (PL_my_cxt_size) {
10563 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10564 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10567 PL_my_cxt_list = (void**)NULL;
10568 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10569 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10570 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10572 PL_profiledata = NULL;
10573 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10574 /* PL_rsfp_filters entries have fake IoDIRP() */
10575 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10577 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10579 PAD_CLONE_VARS(proto_perl, param);
10581 #ifdef HAVE_INTERP_INTERN
10582 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10585 /* more statics moved here */
10586 PL_generation = proto_perl->Igeneration;
10587 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10589 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10590 PL_in_clean_all = proto_perl->Iin_clean_all;
10592 PL_uid = proto_perl->Iuid;
10593 PL_euid = proto_perl->Ieuid;
10594 PL_gid = proto_perl->Igid;
10595 PL_egid = proto_perl->Iegid;
10596 PL_nomemok = proto_perl->Inomemok;
10597 PL_an = proto_perl->Ian;
10598 PL_evalseq = proto_perl->Ievalseq;
10599 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10600 PL_origalen = proto_perl->Iorigalen;
10601 #ifdef PERL_USES_PL_PIDSTATUS
10602 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10604 PL_osname = SAVEPV(proto_perl->Iosname);
10605 PL_sighandlerp = proto_perl->Isighandlerp;
10607 PL_runops = proto_perl->Irunops;
10609 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10612 PL_cshlen = proto_perl->Icshlen;
10613 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10616 PL_lex_state = proto_perl->Ilex_state;
10617 PL_lex_defer = proto_perl->Ilex_defer;
10618 PL_lex_expect = proto_perl->Ilex_expect;
10619 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10620 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10621 PL_lex_starts = proto_perl->Ilex_starts;
10622 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10623 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10624 PL_lex_op = proto_perl->Ilex_op;
10625 PL_lex_inpat = proto_perl->Ilex_inpat;
10626 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10627 PL_lex_brackets = proto_perl->Ilex_brackets;
10628 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10629 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10630 PL_lex_casemods = proto_perl->Ilex_casemods;
10631 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10632 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10634 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10635 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10636 PL_nexttoke = proto_perl->Inexttoke;
10638 /* XXX This is probably masking the deeper issue of why
10639 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10640 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10641 * (A little debugging with a watchpoint on it may help.)
10643 if (SvANY(proto_perl->Ilinestr)) {
10644 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10645 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10646 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10647 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10648 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10649 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10650 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10651 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10652 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10655 PL_linestr = newSV(79);
10656 sv_upgrade(PL_linestr,SVt_PVIV);
10657 sv_setpvn(PL_linestr,"",0);
10658 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10660 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10661 PL_pending_ident = proto_perl->Ipending_ident;
10662 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10664 PL_expect = proto_perl->Iexpect;
10666 PL_multi_start = proto_perl->Imulti_start;
10667 PL_multi_end = proto_perl->Imulti_end;
10668 PL_multi_open = proto_perl->Imulti_open;
10669 PL_multi_close = proto_perl->Imulti_close;
10671 PL_error_count = proto_perl->Ierror_count;
10672 PL_subline = proto_perl->Isubline;
10673 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10675 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10676 if (SvANY(proto_perl->Ilinestr)) {
10677 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10678 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10679 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10680 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10681 PL_last_lop_op = proto_perl->Ilast_lop_op;
10684 PL_last_uni = SvPVX(PL_linestr);
10685 PL_last_lop = SvPVX(PL_linestr);
10686 PL_last_lop_op = 0;
10688 PL_in_my = proto_perl->Iin_my;
10689 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10691 PL_cryptseen = proto_perl->Icryptseen;
10694 PL_hints = proto_perl->Ihints;
10696 PL_amagic_generation = proto_perl->Iamagic_generation;
10698 #ifdef USE_LOCALE_COLLATE
10699 PL_collation_ix = proto_perl->Icollation_ix;
10700 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10701 PL_collation_standard = proto_perl->Icollation_standard;
10702 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10703 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10704 #endif /* USE_LOCALE_COLLATE */
10706 #ifdef USE_LOCALE_NUMERIC
10707 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10708 PL_numeric_standard = proto_perl->Inumeric_standard;
10709 PL_numeric_local = proto_perl->Inumeric_local;
10710 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10711 #endif /* !USE_LOCALE_NUMERIC */
10713 /* utf8 character classes */
10714 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10715 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10716 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10717 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10718 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10719 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10720 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10721 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10722 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10723 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10724 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10725 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10726 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10727 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10728 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10729 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10730 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10731 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10732 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10733 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10735 /* Did the locale setup indicate UTF-8? */
10736 PL_utf8locale = proto_perl->Iutf8locale;
10737 /* Unicode features (see perlrun/-C) */
10738 PL_unicode = proto_perl->Iunicode;
10740 /* Pre-5.8 signals control */
10741 PL_signals = proto_perl->Isignals;
10743 /* times() ticks per second */
10744 PL_clocktick = proto_perl->Iclocktick;
10746 /* Recursion stopper for PerlIO_find_layer */
10747 PL_in_load_module = proto_perl->Iin_load_module;
10749 /* sort() routine */
10750 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10752 /* Not really needed/useful since the reenrant_retint is "volatile",
10753 * but do it for consistency's sake. */
10754 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10756 /* Hooks to shared SVs and locks. */
10757 PL_sharehook = proto_perl->Isharehook;
10758 PL_lockhook = proto_perl->Ilockhook;
10759 PL_unlockhook = proto_perl->Iunlockhook;
10760 PL_threadhook = proto_perl->Ithreadhook;
10762 PL_runops_std = proto_perl->Irunops_std;
10763 PL_runops_dbg = proto_perl->Irunops_dbg;
10765 #ifdef THREADS_HAVE_PIDS
10766 PL_ppid = proto_perl->Ippid;
10770 PL_last_swash_hv = NULL; /* reinits on demand */
10771 PL_last_swash_klen = 0;
10772 PL_last_swash_key[0]= '\0';
10773 PL_last_swash_tmps = (U8*)NULL;
10774 PL_last_swash_slen = 0;
10776 PL_glob_index = proto_perl->Iglob_index;
10777 PL_srand_called = proto_perl->Isrand_called;
10778 PL_uudmap['M'] = 0; /* reinits on demand */
10779 PL_bitcount = Nullch; /* reinits on demand */
10781 if (proto_perl->Ipsig_pend) {
10782 Newxz(PL_psig_pend, SIG_SIZE, int);
10785 PL_psig_pend = (int*)NULL;
10788 if (proto_perl->Ipsig_ptr) {
10789 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10790 Newxz(PL_psig_name, SIG_SIZE, SV*);
10791 for (i = 1; i < SIG_SIZE; i++) {
10792 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10793 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10797 PL_psig_ptr = (SV**)NULL;
10798 PL_psig_name = (SV**)NULL;
10801 /* thrdvar.h stuff */
10803 if (flags & CLONEf_COPY_STACKS) {
10804 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10805 PL_tmps_ix = proto_perl->Ttmps_ix;
10806 PL_tmps_max = proto_perl->Ttmps_max;
10807 PL_tmps_floor = proto_perl->Ttmps_floor;
10808 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10810 while (i <= PL_tmps_ix) {
10811 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10815 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10816 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10817 Newxz(PL_markstack, i, I32);
10818 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10819 - proto_perl->Tmarkstack);
10820 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10821 - proto_perl->Tmarkstack);
10822 Copy(proto_perl->Tmarkstack, PL_markstack,
10823 PL_markstack_ptr - PL_markstack + 1, I32);
10825 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10826 * NOTE: unlike the others! */
10827 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10828 PL_scopestack_max = proto_perl->Tscopestack_max;
10829 Newxz(PL_scopestack, PL_scopestack_max, I32);
10830 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10832 /* NOTE: si_dup() looks at PL_markstack */
10833 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10835 /* PL_curstack = PL_curstackinfo->si_stack; */
10836 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10837 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10839 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10840 PL_stack_base = AvARRAY(PL_curstack);
10841 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10842 - proto_perl->Tstack_base);
10843 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10845 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10846 * NOTE: unlike the others! */
10847 PL_savestack_ix = proto_perl->Tsavestack_ix;
10848 PL_savestack_max = proto_perl->Tsavestack_max;
10849 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10850 PL_savestack = ss_dup(proto_perl, param);
10854 ENTER; /* perl_destruct() wants to LEAVE; */
10856 /* although we're not duplicating the tmps stack, we should still
10857 * add entries for any SVs on the tmps stack that got cloned by a
10858 * non-refcount means (eg a temp in @_); otherwise they will be
10861 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10862 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10863 proto_perl->Ttmps_stack[i]);
10864 if (nsv && !SvREFCNT(nsv)) {
10866 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10871 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10872 PL_top_env = &PL_start_env;
10874 PL_op = proto_perl->Top;
10877 PL_Xpv = (XPV*)NULL;
10878 PL_na = proto_perl->Tna;
10880 PL_statbuf = proto_perl->Tstatbuf;
10881 PL_statcache = proto_perl->Tstatcache;
10882 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10883 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10885 PL_timesbuf = proto_perl->Ttimesbuf;
10888 PL_tainted = proto_perl->Ttainted;
10889 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10890 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10891 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10892 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10893 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10894 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10895 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10896 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10897 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10899 PL_restartop = proto_perl->Trestartop;
10900 PL_in_eval = proto_perl->Tin_eval;
10901 PL_delaymagic = proto_perl->Tdelaymagic;
10902 PL_dirty = proto_perl->Tdirty;
10903 PL_localizing = proto_perl->Tlocalizing;
10905 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10906 PL_hv_fetch_ent_mh = Nullhe;
10907 PL_modcount = proto_perl->Tmodcount;
10908 PL_lastgotoprobe = Nullop;
10909 PL_dumpindent = proto_perl->Tdumpindent;
10911 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10912 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10913 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10914 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10915 PL_efloatbuf = Nullch; /* reinits on demand */
10916 PL_efloatsize = 0; /* reinits on demand */
10920 PL_screamfirst = NULL;
10921 PL_screamnext = NULL;
10922 PL_maxscream = -1; /* reinits on demand */
10923 PL_lastscream = Nullsv;
10925 PL_watchaddr = NULL;
10926 PL_watchok = Nullch;
10928 PL_regdummy = proto_perl->Tregdummy;
10929 PL_regprecomp = Nullch;
10932 PL_colorset = 0; /* reinits PL_colors[] */
10933 /*PL_colors[6] = {0,0,0,0,0,0};*/
10934 PL_reginput = Nullch;
10935 PL_regbol = Nullch;
10936 PL_regeol = Nullch;
10937 PL_regstartp = (I32*)NULL;
10938 PL_regendp = (I32*)NULL;
10939 PL_reglastparen = (U32*)NULL;
10940 PL_reglastcloseparen = (U32*)NULL;
10941 PL_regtill = Nullch;
10942 PL_reg_start_tmp = (char**)NULL;
10943 PL_reg_start_tmpl = 0;
10944 PL_regdata = (struct reg_data*)NULL;
10947 PL_reg_eval_set = 0;
10949 PL_regprogram = (regnode*)NULL;
10951 PL_regcc = (CURCUR*)NULL;
10952 PL_reg_call_cc = (struct re_cc_state*)NULL;
10953 PL_reg_re = (regexp*)NULL;
10954 PL_reg_ganch = Nullch;
10955 PL_reg_sv = Nullsv;
10956 PL_reg_match_utf8 = FALSE;
10957 PL_reg_magic = (MAGIC*)NULL;
10959 PL_reg_oldcurpm = (PMOP*)NULL;
10960 PL_reg_curpm = (PMOP*)NULL;
10961 PL_reg_oldsaved = Nullch;
10962 PL_reg_oldsavedlen = 0;
10963 #ifdef PERL_OLD_COPY_ON_WRITE
10966 PL_reg_maxiter = 0;
10967 PL_reg_leftiter = 0;
10968 PL_reg_poscache = Nullch;
10969 PL_reg_poscache_size= 0;
10971 /* RE engine - function pointers */
10972 PL_regcompp = proto_perl->Tregcompp;
10973 PL_regexecp = proto_perl->Tregexecp;
10974 PL_regint_start = proto_perl->Tregint_start;
10975 PL_regint_string = proto_perl->Tregint_string;
10976 PL_regfree = proto_perl->Tregfree;
10978 PL_reginterp_cnt = 0;
10979 PL_reg_starttry = 0;
10981 /* Pluggable optimizer */
10982 PL_peepp = proto_perl->Tpeepp;
10984 PL_stashcache = newHV();
10986 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10987 ptr_table_free(PL_ptr_table);
10988 PL_ptr_table = NULL;
10991 /* Call the ->CLONE method, if it exists, for each of the stashes
10992 identified by sv_dup() above.
10994 while(av_len(param->stashes) != -1) {
10995 HV* const stash = (HV*) av_shift(param->stashes);
10996 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10997 if (cloner && GvCV(cloner)) {
11002 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11004 call_sv((SV*)GvCV(cloner), G_DISCARD);
11010 SvREFCNT_dec(param->stashes);
11012 /* orphaned? eg threads->new inside BEGIN or use */
11013 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11014 (void)SvREFCNT_inc(PL_compcv);
11015 SAVEFREESV(PL_compcv);
11021 #endif /* USE_ITHREADS */
11024 =head1 Unicode Support
11026 =for apidoc sv_recode_to_utf8
11028 The encoding is assumed to be an Encode object, on entry the PV
11029 of the sv is assumed to be octets in that encoding, and the sv
11030 will be converted into Unicode (and UTF-8).
11032 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11033 is not a reference, nothing is done to the sv. If the encoding is not
11034 an C<Encode::XS> Encoding object, bad things will happen.
11035 (See F<lib/encoding.pm> and L<Encode>).
11037 The PV of the sv is returned.
11042 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11045 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11059 Passing sv_yes is wrong - it needs to be or'ed set of constants
11060 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11061 remove converted chars from source.
11063 Both will default the value - let them.
11065 XPUSHs(&PL_sv_yes);
11068 call_method("decode", G_SCALAR);
11072 s = SvPV_const(uni, len);
11073 if (s != SvPVX_const(sv)) {
11074 SvGROW(sv, len + 1);
11075 Move(s, SvPVX(sv), len + 1, char);
11076 SvCUR_set(sv, len);
11083 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11087 =for apidoc sv_cat_decode
11089 The encoding is assumed to be an Encode object, the PV of the ssv is
11090 assumed to be octets in that encoding and decoding the input starts
11091 from the position which (PV + *offset) pointed to. The dsv will be
11092 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11093 when the string tstr appears in decoding output or the input ends on
11094 the PV of the ssv. The value which the offset points will be modified
11095 to the last input position on the ssv.
11097 Returns TRUE if the terminator was found, else returns FALSE.
11102 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11103 SV *ssv, int *offset, char *tstr, int tlen)
11107 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11118 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11119 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11121 call_method("cat_decode", G_SCALAR);
11123 ret = SvTRUE(TOPs);
11124 *offset = SvIV(offsv);
11130 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11135 /* ---------------------------------------------------------------------
11137 * support functions for report_uninit()
11140 /* the maxiumum size of array or hash where we will scan looking
11141 * for the undefined element that triggered the warning */
11143 #define FUV_MAX_SEARCH_SIZE 1000
11145 /* Look for an entry in the hash whose value has the same SV as val;
11146 * If so, return a mortal copy of the key. */
11149 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11152 register HE **array;
11155 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11156 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11159 array = HvARRAY(hv);
11161 for (i=HvMAX(hv); i>0; i--) {
11162 register HE *entry;
11163 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11164 if (HeVAL(entry) != val)
11166 if ( HeVAL(entry) == &PL_sv_undef ||
11167 HeVAL(entry) == &PL_sv_placeholder)
11171 if (HeKLEN(entry) == HEf_SVKEY)
11172 return sv_mortalcopy(HeKEY_sv(entry));
11173 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11179 /* Look for an entry in the array whose value has the same SV as val;
11180 * If so, return the index, otherwise return -1. */
11183 S_find_array_subscript(pTHX_ AV *av, SV* val)
11188 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11189 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11193 for (i=AvFILLp(av); i>=0; i--) {
11194 if (svp[i] == val && svp[i] != &PL_sv_undef)
11200 /* S_varname(): return the name of a variable, optionally with a subscript.
11201 * If gv is non-zero, use the name of that global, along with gvtype (one
11202 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11203 * targ. Depending on the value of the subscript_type flag, return:
11206 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11207 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11208 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11209 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11212 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11213 SV* keyname, I32 aindex, int subscript_type)
11216 SV * const name = sv_newmortal();
11219 buffer[0] = gvtype;
11222 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11224 gv_fullname4(name, gv, buffer, 0);
11226 if ((unsigned int)SvPVX(name)[1] <= 26) {
11228 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11230 /* Swap the 1 unprintable control character for the 2 byte pretty
11231 version - ie substr($name, 1, 1) = $buffer; */
11232 sv_insert(name, 1, 1, buffer, 2);
11237 CV * const cv = find_runcv(&unused);
11241 if (!cv || !CvPADLIST(cv))
11243 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11244 sv = *av_fetch(av, targ, FALSE);
11245 /* SvLEN in a pad name is not to be trusted */
11246 sv_setpv(name, SvPV_nolen_const(sv));
11249 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11250 SV * const sv = newSV(0);
11251 *SvPVX(name) = '$';
11252 Perl_sv_catpvf(aTHX_ name, "{%s}",
11253 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11256 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11257 *SvPVX(name) = '$';
11258 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11260 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11261 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11268 =for apidoc find_uninit_var
11270 Find the name of the undefined variable (if any) that caused the operator o
11271 to issue a "Use of uninitialized value" warning.
11272 If match is true, only return a name if it's value matches uninit_sv.
11273 So roughly speaking, if a unary operator (such as OP_COS) generates a
11274 warning, then following the direct child of the op may yield an
11275 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11276 other hand, with OP_ADD there are two branches to follow, so we only print
11277 the variable name if we get an exact match.
11279 The name is returned as a mortal SV.
11281 Assumes that PL_op is the op that originally triggered the error, and that
11282 PL_comppad/PL_curpad points to the currently executing pad.
11288 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11296 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11297 uninit_sv == &PL_sv_placeholder)))
11300 switch (obase->op_type) {
11307 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11308 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11310 SV *keysv = Nullsv;
11311 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11313 if (pad) { /* @lex, %lex */
11314 sv = PAD_SVl(obase->op_targ);
11318 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11319 /* @global, %global */
11320 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11323 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11325 else /* @{expr}, %{expr} */
11326 return find_uninit_var(cUNOPx(obase)->op_first,
11330 /* attempt to find a match within the aggregate */
11332 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11334 subscript_type = FUV_SUBSCRIPT_HASH;
11337 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11339 subscript_type = FUV_SUBSCRIPT_ARRAY;
11342 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11345 return varname(gv, hash ? '%' : '@', obase->op_targ,
11346 keysv, index, subscript_type);
11350 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11352 return varname(Nullgv, '$', obase->op_targ,
11353 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11356 gv = cGVOPx_gv(obase);
11357 if (!gv || (match && GvSV(gv) != uninit_sv))
11359 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11362 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11365 av = (AV*)PAD_SV(obase->op_targ);
11366 if (!av || SvRMAGICAL(av))
11368 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11369 if (!svp || *svp != uninit_sv)
11372 return varname(Nullgv, '$', obase->op_targ,
11373 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11376 gv = cGVOPx_gv(obase);
11382 if (!av || SvRMAGICAL(av))
11384 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11385 if (!svp || *svp != uninit_sv)
11388 return varname(gv, '$', 0,
11389 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11394 o = cUNOPx(obase)->op_first;
11395 if (!o || o->op_type != OP_NULL ||
11396 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11398 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11402 if (PL_op == obase)
11403 /* $a[uninit_expr] or $h{uninit_expr} */
11404 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11407 o = cBINOPx(obase)->op_first;
11408 kid = cBINOPx(obase)->op_last;
11410 /* get the av or hv, and optionally the gv */
11412 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11413 sv = PAD_SV(o->op_targ);
11415 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11416 && cUNOPo->op_first->op_type == OP_GV)
11418 gv = cGVOPx_gv(cUNOPo->op_first);
11421 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11426 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11427 /* index is constant */
11431 if (obase->op_type == OP_HELEM) {
11432 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11433 if (!he || HeVAL(he) != uninit_sv)
11437 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11438 if (!svp || *svp != uninit_sv)
11442 if (obase->op_type == OP_HELEM)
11443 return varname(gv, '%', o->op_targ,
11444 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11446 return varname(gv, '@', o->op_targ, Nullsv,
11447 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11450 /* index is an expression;
11451 * attempt to find a match within the aggregate */
11452 if (obase->op_type == OP_HELEM) {
11453 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11455 return varname(gv, '%', o->op_targ,
11456 keysv, 0, FUV_SUBSCRIPT_HASH);
11459 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11461 return varname(gv, '@', o->op_targ,
11462 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11467 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11469 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11475 /* only examine RHS */
11476 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11479 o = cUNOPx(obase)->op_first;
11480 if (o->op_type == OP_PUSHMARK)
11483 if (!o->op_sibling) {
11484 /* one-arg version of open is highly magical */
11486 if (o->op_type == OP_GV) { /* open FOO; */
11488 if (match && GvSV(gv) != uninit_sv)
11490 return varname(gv, '$', 0,
11491 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11493 /* other possibilities not handled are:
11494 * open $x; or open my $x; should return '${*$x}'
11495 * open expr; should return '$'.expr ideally
11501 /* ops where $_ may be an implicit arg */
11505 if ( !(obase->op_flags & OPf_STACKED)) {
11506 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11507 ? PAD_SVl(obase->op_targ)
11510 sv = sv_newmortal();
11511 sv_setpvn(sv, "$_", 2);
11519 /* skip filehandle as it can't produce 'undef' warning */
11520 o = cUNOPx(obase)->op_first;
11521 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11522 o = o->op_sibling->op_sibling;
11529 match = 1; /* XS or custom code could trigger random warnings */
11534 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11535 return sv_2mortal(newSVpvs("${$/}"));
11540 if (!(obase->op_flags & OPf_KIDS))
11542 o = cUNOPx(obase)->op_first;
11548 /* if all except one arg are constant, or have no side-effects,
11549 * or are optimized away, then it's unambiguous */
11551 for (kid=o; kid; kid = kid->op_sibling) {
11553 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11554 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11555 || (kid->op_type == OP_PUSHMARK)
11559 if (o2) { /* more than one found */
11566 return find_uninit_var(o2, uninit_sv, match);
11568 /* scan all args */
11570 sv = find_uninit_var(o, uninit_sv, 1);
11582 =for apidoc report_uninit
11584 Print appropriate "Use of uninitialized variable" warning
11590 Perl_report_uninit(pTHX_ SV* uninit_sv)
11594 SV* varname = Nullsv;
11596 varname = find_uninit_var(PL_op, uninit_sv,0);
11598 sv_insert(varname, 0, 0, " ", 1);
11600 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11601 varname ? SvPV_nolen_const(varname) : "",
11602 " in ", OP_DESC(PL_op));
11605 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11611 * c-indentation-style: bsd
11612 * c-basic-offset: 4
11613 * indent-tabs-mode: t
11616 * ex: set ts=8 sts=4 sw=4 noet: