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 S_glob_assign(aTHX_ dstr, sstr, dtype);
3196 #ifdef PERL_OLD_COPY_ON_WRITE
3197 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3198 if (dtype < SVt_PVIV)
3199 sv_upgrade(dstr, SVt_PVIV);
3206 sv_upgrade(dstr, SVt_PV);
3209 if (dtype < SVt_PVIV)
3210 sv_upgrade(dstr, SVt_PVIV);
3213 if (dtype < SVt_PVNV)
3214 sv_upgrade(dstr, SVt_PVNV);
3221 const char * const type = sv_reftype(sstr,0);
3223 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3225 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3230 if (dtype <= SVt_PVGV) {
3231 S_glob_assign(aTHX_ dstr, sstr, dtype);
3237 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3239 if ((int)SvTYPE(sstr) != stype) {
3240 stype = SvTYPE(sstr);
3241 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3242 S_glob_assign(aTHX_ dstr, sstr, dtype);
3247 if (stype == SVt_PVLV)
3248 SvUPGRADE(dstr, SVt_PVNV);
3250 SvUPGRADE(dstr, (U32)stype);
3253 sflags = SvFLAGS(sstr);
3255 if (sflags & SVf_ROK) {
3256 if (dtype >= SVt_PV) {
3257 if (dtype == SVt_PVGV) {
3258 S_pvgv_assign(aTHX_ dstr, sstr);
3261 if (SvPVX_const(dstr)) {
3267 (void)SvOK_off(dstr);
3268 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3269 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_ROK
3271 if (sflags & SVp_NOK) {
3272 SvNV_set(dstr, SvNVX(sstr));
3274 if (sflags & SVp_IOK) {
3275 /* Must do this otherwise some other overloaded use of 0x80000000
3276 gets confused. Probably 0x80000000 */
3277 if (sflags & SVf_IVisUV)
3279 SvIV_set(dstr, SvIVX(sstr));
3282 else if (sflags & SVp_POK) {
3286 * Check to see if we can just swipe the string. If so, it's a
3287 * possible small lose on short strings, but a big win on long ones.
3288 * It might even be a win on short strings if SvPVX_const(dstr)
3289 * has to be allocated and SvPVX_const(sstr) has to be freed.
3292 /* Whichever path we take through the next code, we want this true,
3293 and doing it now facilitates the COW check. */
3294 (void)SvPOK_only(dstr);
3297 /* We're not already COW */
3298 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3299 #ifndef PERL_OLD_COPY_ON_WRITE
3300 /* or we are, but dstr isn't a suitable target. */
3301 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3306 (sflags & SVs_TEMP) && /* slated for free anyway? */
3307 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3308 (!(flags & SV_NOSTEAL)) &&
3309 /* and we're allowed to steal temps */
3310 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3311 SvLEN(sstr) && /* and really is a string */
3312 /* and won't be needed again, potentially */
3313 !(PL_op && PL_op->op_type == OP_AASSIGN))
3314 #ifdef PERL_OLD_COPY_ON_WRITE
3315 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3316 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3317 && SvTYPE(sstr) >= SVt_PVIV)
3320 /* Failed the swipe test, and it's not a shared hash key either.
3321 Have to copy the string. */
3322 STRLEN len = SvCUR(sstr);
3323 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3324 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3325 SvCUR_set(dstr, len);
3326 *SvEND(dstr) = '\0';
3328 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3330 /* Either it's a shared hash key, or it's suitable for
3331 copy-on-write or we can swipe the string. */
3333 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3337 #ifdef PERL_OLD_COPY_ON_WRITE
3339 /* I believe I should acquire a global SV mutex if
3340 it's a COW sv (not a shared hash key) to stop
3341 it going un copy-on-write.
3342 If the source SV has gone un copy on write between up there
3343 and down here, then (assert() that) it is of the correct
3344 form to make it copy on write again */
3345 if ((sflags & (SVf_FAKE | SVf_READONLY))
3346 != (SVf_FAKE | SVf_READONLY)) {
3347 SvREADONLY_on(sstr);
3349 /* Make the source SV into a loop of 1.
3350 (about to become 2) */
3351 SV_COW_NEXT_SV_SET(sstr, sstr);
3355 /* Initial code is common. */
3356 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3361 /* making another shared SV. */
3362 STRLEN cur = SvCUR(sstr);
3363 STRLEN len = SvLEN(sstr);
3364 #ifdef PERL_OLD_COPY_ON_WRITE
3366 assert (SvTYPE(dstr) >= SVt_PVIV);
3367 /* SvIsCOW_normal */
3368 /* splice us in between source and next-after-source. */
3369 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3370 SV_COW_NEXT_SV_SET(sstr, dstr);
3371 SvPV_set(dstr, SvPVX_mutable(sstr));
3375 /* SvIsCOW_shared_hash */
3376 DEBUG_C(PerlIO_printf(Perl_debug_log,
3377 "Copy on write: Sharing hash\n"));
3379 assert (SvTYPE(dstr) >= SVt_PV);
3381 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3383 SvLEN_set(dstr, len);
3384 SvCUR_set(dstr, cur);
3385 SvREADONLY_on(dstr);
3387 /* Relesase a global SV mutex. */
3390 { /* Passes the swipe test. */
3391 SvPV_set(dstr, SvPVX_mutable(sstr));
3392 SvLEN_set(dstr, SvLEN(sstr));
3393 SvCUR_set(dstr, SvCUR(sstr));
3396 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3397 SvPV_set(sstr, NULL);
3403 if (sflags & SVp_NOK) {
3404 SvNV_set(dstr, SvNVX(sstr));
3406 if (sflags & SVp_IOK) {
3407 SvRELEASE_IVX(dstr);
3408 SvIV_set(dstr, SvIVX(sstr));
3409 /* Must do this otherwise some other overloaded use of 0x80000000
3410 gets confused. I guess SVpbm_VALID */
3411 if (sflags & SVf_IVisUV)
3414 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3416 const MAGIC * const smg = SvVOK(sstr);
3418 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3419 smg->mg_ptr, smg->mg_len);
3420 SvRMAGICAL_on(dstr);
3424 else if (sflags & (SVp_IOK|SVp_NOK)) {
3425 (void)SvOK_off(dstr);
3426 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3427 if (sflags & SVp_IOK) {
3428 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3429 SvIV_set(dstr, SvIVX(sstr));
3431 if (sflags & SVp_NOK) {
3432 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3433 SvNV_set(dstr, SvNVX(sstr));
3437 if (dtype == SVt_PVGV) {
3438 if (ckWARN(WARN_MISC))
3439 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3442 (void)SvOK_off(dstr);
3444 if (SvTAINTED(sstr))
3449 =for apidoc sv_setsv_mg
3451 Like C<sv_setsv>, but also handles 'set' magic.
3457 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3459 sv_setsv(dstr,sstr);
3463 #ifdef PERL_OLD_COPY_ON_WRITE
3465 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3467 STRLEN cur = SvCUR(sstr);
3468 STRLEN len = SvLEN(sstr);
3469 register char *new_pv;
3472 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3480 if (SvTHINKFIRST(dstr))
3481 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3482 else if (SvPVX_const(dstr))
3483 Safefree(SvPVX_const(dstr));
3487 SvUPGRADE(dstr, SVt_PVIV);
3489 assert (SvPOK(sstr));
3490 assert (SvPOKp(sstr));
3491 assert (!SvIOK(sstr));
3492 assert (!SvIOKp(sstr));
3493 assert (!SvNOK(sstr));
3494 assert (!SvNOKp(sstr));
3496 if (SvIsCOW(sstr)) {
3498 if (SvLEN(sstr) == 0) {
3499 /* source is a COW shared hash key. */
3500 DEBUG_C(PerlIO_printf(Perl_debug_log,
3501 "Fast copy on write: Sharing hash\n"));
3502 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3505 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3507 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3508 SvUPGRADE(sstr, SVt_PVIV);
3509 SvREADONLY_on(sstr);
3511 DEBUG_C(PerlIO_printf(Perl_debug_log,
3512 "Fast copy on write: Converting sstr to COW\n"));
3513 SV_COW_NEXT_SV_SET(dstr, sstr);
3515 SV_COW_NEXT_SV_SET(sstr, dstr);
3516 new_pv = SvPVX_mutable(sstr);
3519 SvPV_set(dstr, new_pv);
3520 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3523 SvLEN_set(dstr, len);
3524 SvCUR_set(dstr, cur);
3533 =for apidoc sv_setpvn
3535 Copies a string into an SV. The C<len> parameter indicates the number of
3536 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3537 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3543 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3546 register char *dptr;
3548 SV_CHECK_THINKFIRST_COW_DROP(sv);
3554 /* len is STRLEN which is unsigned, need to copy to signed */
3557 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3559 SvUPGRADE(sv, SVt_PV);
3561 dptr = SvGROW(sv, len + 1);
3562 Move(ptr,dptr,len,char);
3565 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3570 =for apidoc sv_setpvn_mg
3572 Like C<sv_setpvn>, but also handles 'set' magic.
3578 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3580 sv_setpvn(sv,ptr,len);
3585 =for apidoc sv_setpv
3587 Copies a string into an SV. The string must be null-terminated. Does not
3588 handle 'set' magic. See C<sv_setpv_mg>.
3594 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3597 register STRLEN len;
3599 SV_CHECK_THINKFIRST_COW_DROP(sv);
3605 SvUPGRADE(sv, SVt_PV);
3607 SvGROW(sv, len + 1);
3608 Move(ptr,SvPVX(sv),len+1,char);
3610 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3615 =for apidoc sv_setpv_mg
3617 Like C<sv_setpv>, but also handles 'set' magic.
3623 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3630 =for apidoc sv_usepvn
3632 Tells an SV to use C<ptr> to find its string value. Normally the string is
3633 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3634 The C<ptr> should point to memory that was allocated by C<malloc>. The
3635 string length, C<len>, must be supplied. This function will realloc the
3636 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3637 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3638 See C<sv_usepvn_mg>.
3644 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3648 SV_CHECK_THINKFIRST_COW_DROP(sv);
3649 SvUPGRADE(sv, SVt_PV);
3654 if (SvPVX_const(sv))
3657 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3658 ptr = saferealloc (ptr, allocate);
3661 SvLEN_set(sv, allocate);
3663 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3668 =for apidoc sv_usepvn_mg
3670 Like C<sv_usepvn>, but also handles 'set' magic.
3676 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3678 sv_usepvn(sv,ptr,len);
3682 #ifdef PERL_OLD_COPY_ON_WRITE
3683 /* Need to do this *after* making the SV normal, as we need the buffer
3684 pointer to remain valid until after we've copied it. If we let go too early,
3685 another thread could invalidate it by unsharing last of the same hash key
3686 (which it can do by means other than releasing copy-on-write Svs)
3687 or by changing the other copy-on-write SVs in the loop. */
3689 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3691 if (len) { /* this SV was SvIsCOW_normal(sv) */
3692 /* we need to find the SV pointing to us. */
3693 SV * const current = SV_COW_NEXT_SV(after);
3695 if (current == sv) {
3696 /* The SV we point to points back to us (there were only two of us
3698 Hence other SV is no longer copy on write either. */
3700 SvREADONLY_off(after);
3702 /* We need to follow the pointers around the loop. */
3704 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3707 /* don't loop forever if the structure is bust, and we have
3708 a pointer into a closed loop. */
3709 assert (current != after);
3710 assert (SvPVX_const(current) == pvx);
3712 /* Make the SV before us point to the SV after us. */
3713 SV_COW_NEXT_SV_SET(current, after);
3716 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3721 Perl_sv_release_IVX(pTHX_ register SV *sv)
3724 sv_force_normal_flags(sv, 0);
3730 =for apidoc sv_force_normal_flags
3732 Undo various types of fakery on an SV: if the PV is a shared string, make
3733 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3734 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3735 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3736 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3737 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3738 set to some other value.) In addition, the C<flags> parameter gets passed to
3739 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3740 with flags set to 0.
3746 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3749 #ifdef PERL_OLD_COPY_ON_WRITE
3750 if (SvREADONLY(sv)) {
3751 /* At this point I believe I should acquire a global SV mutex. */
3753 const char * const pvx = SvPVX_const(sv);
3754 const STRLEN len = SvLEN(sv);
3755 const STRLEN cur = SvCUR(sv);
3756 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3758 PerlIO_printf(Perl_debug_log,
3759 "Copy on write: Force normal %ld\n",
3765 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3768 if (flags & SV_COW_DROP_PV) {
3769 /* OK, so we don't need to copy our buffer. */
3772 SvGROW(sv, cur + 1);
3773 Move(pvx,SvPVX(sv),cur,char);
3777 sv_release_COW(sv, pvx, len, next);
3782 else if (IN_PERL_RUNTIME)
3783 Perl_croak(aTHX_ PL_no_modify);
3784 /* At this point I believe that I can drop the global SV mutex. */
3787 if (SvREADONLY(sv)) {
3789 const char * const pvx = SvPVX_const(sv);
3790 const STRLEN len = SvCUR(sv);
3793 SvPV_set(sv, Nullch);
3795 SvGROW(sv, len + 1);
3796 Move(pvx,SvPVX(sv),len,char);
3798 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3800 else if (IN_PERL_RUNTIME)
3801 Perl_croak(aTHX_ PL_no_modify);
3805 sv_unref_flags(sv, flags);
3806 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3813 Efficient removal of characters from the beginning of the string buffer.
3814 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3815 the string buffer. The C<ptr> becomes the first character of the adjusted
3816 string. Uses the "OOK hack".
3817 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3818 refer to the same chunk of data.
3824 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3826 register STRLEN delta;
3827 if (!ptr || !SvPOKp(sv))
3829 delta = ptr - SvPVX_const(sv);
3830 SV_CHECK_THINKFIRST(sv);
3831 if (SvTYPE(sv) < SVt_PVIV)
3832 sv_upgrade(sv,SVt_PVIV);
3835 if (!SvLEN(sv)) { /* make copy of shared string */
3836 const char *pvx = SvPVX_const(sv);
3837 const STRLEN len = SvCUR(sv);
3838 SvGROW(sv, len + 1);
3839 Move(pvx,SvPVX(sv),len,char);
3843 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3844 and we do that anyway inside the SvNIOK_off
3846 SvFLAGS(sv) |= SVf_OOK;
3849 SvLEN_set(sv, SvLEN(sv) - delta);
3850 SvCUR_set(sv, SvCUR(sv) - delta);
3851 SvPV_set(sv, SvPVX(sv) + delta);
3852 SvIV_set(sv, SvIVX(sv) + delta);
3856 =for apidoc sv_catpvn
3858 Concatenates the string onto the end of the string which is in the SV. The
3859 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3860 status set, then the bytes appended should be valid UTF-8.
3861 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3863 =for apidoc sv_catpvn_flags
3865 Concatenates the string onto the end of the string which is in the SV. The
3866 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3867 status set, then the bytes appended should be valid UTF-8.
3868 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3869 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3870 in terms of this function.
3876 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3880 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3882 SvGROW(dsv, dlen + slen + 1);
3884 sstr = SvPVX_const(dsv);
3885 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3886 SvCUR_set(dsv, SvCUR(dsv) + slen);
3888 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3890 if (flags & SV_SMAGIC)
3895 =for apidoc sv_catsv
3897 Concatenates the string from SV C<ssv> onto the end of the string in
3898 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3899 not 'set' magic. See C<sv_catsv_mg>.
3901 =for apidoc sv_catsv_flags
3903 Concatenates the string from SV C<ssv> onto the end of the string in
3904 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3905 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3906 and C<sv_catsv_nomg> are implemented in terms of this function.
3911 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3916 const char *spv = SvPV_const(ssv, slen);
3918 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3919 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3920 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3921 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3922 dsv->sv_flags doesn't have that bit set.
3923 Andy Dougherty 12 Oct 2001
3925 const I32 sutf8 = DO_UTF8(ssv);
3928 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3930 dutf8 = DO_UTF8(dsv);
3932 if (dutf8 != sutf8) {
3934 /* Not modifying source SV, so taking a temporary copy. */
3935 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3937 sv_utf8_upgrade(csv);
3938 spv = SvPV_const(csv, slen);
3941 sv_utf8_upgrade_nomg(dsv);
3943 sv_catpvn_nomg(dsv, spv, slen);
3946 if (flags & SV_SMAGIC)
3951 =for apidoc sv_catpv
3953 Concatenates the string onto the end of the string which is in the SV.
3954 If the SV has the UTF-8 status set, then the bytes appended should be
3955 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3960 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3963 register STRLEN len;
3969 junk = SvPV_force(sv, tlen);
3971 SvGROW(sv, tlen + len + 1);
3973 ptr = SvPVX_const(sv);
3974 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3975 SvCUR_set(sv, SvCUR(sv) + len);
3976 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3981 =for apidoc sv_catpv_mg
3983 Like C<sv_catpv>, but also handles 'set' magic.
3989 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3998 Creates a new SV. A non-zero C<len> parameter indicates the number of
3999 bytes of preallocated string space the SV should have. An extra byte for a
4000 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4001 space is allocated.) The reference count for the new SV is set to 1.
4003 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4004 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4005 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4006 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4007 modules supporting older perls.
4013 Perl_newSV(pTHX_ STRLEN len)
4020 sv_upgrade(sv, SVt_PV);
4021 SvGROW(sv, len + 1);
4026 =for apidoc sv_magicext
4028 Adds magic to an SV, upgrading it if necessary. Applies the
4029 supplied vtable and returns a pointer to the magic added.
4031 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4032 In particular, you can add magic to SvREADONLY SVs, and add more than
4033 one instance of the same 'how'.
4035 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4036 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4037 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4038 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4040 (This is now used as a subroutine by C<sv_magic>.)
4045 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4046 const char* name, I32 namlen)
4051 if (SvTYPE(sv) < SVt_PVMG) {
4052 SvUPGRADE(sv, SVt_PVMG);
4054 Newxz(mg, 1, MAGIC);
4055 mg->mg_moremagic = SvMAGIC(sv);
4056 SvMAGIC_set(sv, mg);
4058 /* Sometimes a magic contains a reference loop, where the sv and
4059 object refer to each other. To prevent a reference loop that
4060 would prevent such objects being freed, we look for such loops
4061 and if we find one we avoid incrementing the object refcount.
4063 Note we cannot do this to avoid self-tie loops as intervening RV must
4064 have its REFCNT incremented to keep it in existence.
4067 if (!obj || obj == sv ||
4068 how == PERL_MAGIC_arylen ||
4069 how == PERL_MAGIC_qr ||
4070 how == PERL_MAGIC_symtab ||
4071 (SvTYPE(obj) == SVt_PVGV &&
4072 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4073 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4074 GvFORM(obj) == (CV*)sv)))
4079 mg->mg_obj = SvREFCNT_inc(obj);
4080 mg->mg_flags |= MGf_REFCOUNTED;
4083 /* Normal self-ties simply pass a null object, and instead of
4084 using mg_obj directly, use the SvTIED_obj macro to produce a
4085 new RV as needed. For glob "self-ties", we are tieing the PVIO
4086 with an RV obj pointing to the glob containing the PVIO. In
4087 this case, to avoid a reference loop, we need to weaken the
4091 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4092 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4098 mg->mg_len = namlen;
4101 mg->mg_ptr = savepvn(name, namlen);
4102 else if (namlen == HEf_SVKEY)
4103 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4105 mg->mg_ptr = (char *) name;
4107 mg->mg_virtual = vtable;
4111 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4116 =for apidoc sv_magic
4118 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4119 then adds a new magic item of type C<how> to the head of the magic list.
4121 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4122 handling of the C<name> and C<namlen> arguments.
4124 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4125 to add more than one instance of the same 'how'.
4131 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4137 #ifdef PERL_OLD_COPY_ON_WRITE
4139 sv_force_normal_flags(sv, 0);
4141 if (SvREADONLY(sv)) {
4143 /* its okay to attach magic to shared strings; the subsequent
4144 * upgrade to PVMG will unshare the string */
4145 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4148 && how != PERL_MAGIC_regex_global
4149 && how != PERL_MAGIC_bm
4150 && how != PERL_MAGIC_fm
4151 && how != PERL_MAGIC_sv
4152 && how != PERL_MAGIC_backref
4155 Perl_croak(aTHX_ PL_no_modify);
4158 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4159 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4160 /* sv_magic() refuses to add a magic of the same 'how' as an
4163 if (how == PERL_MAGIC_taint)
4171 vtable = &PL_vtbl_sv;
4173 case PERL_MAGIC_overload:
4174 vtable = &PL_vtbl_amagic;
4176 case PERL_MAGIC_overload_elem:
4177 vtable = &PL_vtbl_amagicelem;
4179 case PERL_MAGIC_overload_table:
4180 vtable = &PL_vtbl_ovrld;
4183 vtable = &PL_vtbl_bm;
4185 case PERL_MAGIC_regdata:
4186 vtable = &PL_vtbl_regdata;
4188 case PERL_MAGIC_regdatum:
4189 vtable = &PL_vtbl_regdatum;
4191 case PERL_MAGIC_env:
4192 vtable = &PL_vtbl_env;
4195 vtable = &PL_vtbl_fm;
4197 case PERL_MAGIC_envelem:
4198 vtable = &PL_vtbl_envelem;
4200 case PERL_MAGIC_regex_global:
4201 vtable = &PL_vtbl_mglob;
4203 case PERL_MAGIC_isa:
4204 vtable = &PL_vtbl_isa;
4206 case PERL_MAGIC_isaelem:
4207 vtable = &PL_vtbl_isaelem;
4209 case PERL_MAGIC_nkeys:
4210 vtable = &PL_vtbl_nkeys;
4212 case PERL_MAGIC_dbfile:
4215 case PERL_MAGIC_dbline:
4216 vtable = &PL_vtbl_dbline;
4218 #ifdef USE_LOCALE_COLLATE
4219 case PERL_MAGIC_collxfrm:
4220 vtable = &PL_vtbl_collxfrm;
4222 #endif /* USE_LOCALE_COLLATE */
4223 case PERL_MAGIC_tied:
4224 vtable = &PL_vtbl_pack;
4226 case PERL_MAGIC_tiedelem:
4227 case PERL_MAGIC_tiedscalar:
4228 vtable = &PL_vtbl_packelem;
4231 vtable = &PL_vtbl_regexp;
4233 case PERL_MAGIC_sig:
4234 vtable = &PL_vtbl_sig;
4236 case PERL_MAGIC_sigelem:
4237 vtable = &PL_vtbl_sigelem;
4239 case PERL_MAGIC_taint:
4240 vtable = &PL_vtbl_taint;
4242 case PERL_MAGIC_uvar:
4243 vtable = &PL_vtbl_uvar;
4245 case PERL_MAGIC_vec:
4246 vtable = &PL_vtbl_vec;
4248 case PERL_MAGIC_arylen_p:
4249 case PERL_MAGIC_rhash:
4250 case PERL_MAGIC_symtab:
4251 case PERL_MAGIC_vstring:
4254 case PERL_MAGIC_utf8:
4255 vtable = &PL_vtbl_utf8;
4257 case PERL_MAGIC_substr:
4258 vtable = &PL_vtbl_substr;
4260 case PERL_MAGIC_defelem:
4261 vtable = &PL_vtbl_defelem;
4263 case PERL_MAGIC_glob:
4264 vtable = &PL_vtbl_glob;
4266 case PERL_MAGIC_arylen:
4267 vtable = &PL_vtbl_arylen;
4269 case PERL_MAGIC_pos:
4270 vtable = &PL_vtbl_pos;
4272 case PERL_MAGIC_backref:
4273 vtable = &PL_vtbl_backref;
4275 case PERL_MAGIC_ext:
4276 /* Reserved for use by extensions not perl internals. */
4277 /* Useful for attaching extension internal data to perl vars. */
4278 /* Note that multiple extensions may clash if magical scalars */
4279 /* etc holding private data from one are passed to another. */
4283 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4286 /* Rest of work is done else where */
4287 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4290 case PERL_MAGIC_taint:
4293 case PERL_MAGIC_ext:
4294 case PERL_MAGIC_dbfile:
4301 =for apidoc sv_unmagic
4303 Removes all magic of type C<type> from an SV.
4309 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4313 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4316 for (mg = *mgp; mg; mg = *mgp) {
4317 if (mg->mg_type == type) {
4318 const MGVTBL* const vtbl = mg->mg_virtual;
4319 *mgp = mg->mg_moremagic;
4320 if (vtbl && vtbl->svt_free)
4321 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4322 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4324 Safefree(mg->mg_ptr);
4325 else if (mg->mg_len == HEf_SVKEY)
4326 SvREFCNT_dec((SV*)mg->mg_ptr);
4327 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4328 Safefree(mg->mg_ptr);
4330 if (mg->mg_flags & MGf_REFCOUNTED)
4331 SvREFCNT_dec(mg->mg_obj);
4335 mgp = &mg->mg_moremagic;
4339 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4340 SvMAGIC_set(sv, NULL);
4347 =for apidoc sv_rvweaken
4349 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4350 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4351 push a back-reference to this RV onto the array of backreferences
4352 associated with that magic.
4358 Perl_sv_rvweaken(pTHX_ SV *sv)
4361 if (!SvOK(sv)) /* let undefs pass */
4364 Perl_croak(aTHX_ "Can't weaken a nonreference");
4365 else if (SvWEAKREF(sv)) {
4366 if (ckWARN(WARN_MISC))
4367 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4371 Perl_sv_add_backref(aTHX_ tsv, sv);
4377 /* Give tsv backref magic if it hasn't already got it, then push a
4378 * back-reference to sv onto the array associated with the backref magic.
4382 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4387 if (SvTYPE(tsv) == SVt_PVHV) {
4388 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4392 /* There is no AV in the offical place - try a fixup. */
4393 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4396 /* Aha. They've got it stowed in magic. Bring it back. */
4397 av = (AV*)mg->mg_obj;
4398 /* Stop mg_free decreasing the refernce count. */
4400 /* Stop mg_free even calling the destructor, given that
4401 there's no AV to free up. */
4403 sv_unmagic(tsv, PERL_MAGIC_backref);
4412 const MAGIC *const mg
4413 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4415 av = (AV*)mg->mg_obj;
4419 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4420 /* av now has a refcnt of 2, which avoids it getting freed
4421 * before us during global cleanup. The extra ref is removed
4422 * by magic_killbackrefs() when tsv is being freed */
4425 if (AvFILLp(av) >= AvMAX(av)) {
4426 av_extend(av, AvFILLp(av)+1);
4428 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4431 /* delete a back-reference to ourselves from the backref magic associated
4432 * with the SV we point to.
4436 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4443 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4444 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4445 /* We mustn't attempt to "fix up" the hash here by moving the
4446 backreference array back to the hv_aux structure, as that is stored
4447 in the main HvARRAY(), and hfreentries assumes that no-one
4448 reallocates HvARRAY() while it is running. */
4451 const MAGIC *const mg
4452 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4454 av = (AV *)mg->mg_obj;
4457 if (PL_in_clean_all)
4459 Perl_croak(aTHX_ "panic: del_backref");
4466 /* We shouldn't be in here more than once, but for paranoia reasons lets
4468 for (i = AvFILLp(av); i >= 0; i--) {
4470 const SSize_t fill = AvFILLp(av);
4472 /* We weren't the last entry.
4473 An unordered list has this property that you can take the
4474 last element off the end to fill the hole, and it's still
4475 an unordered list :-)
4480 AvFILLp(av) = fill - 1;
4486 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4488 SV **svp = AvARRAY(av);
4490 PERL_UNUSED_ARG(sv);
4492 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4493 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4494 if (svp && !SvIS_FREED(av)) {
4495 SV *const *const last = svp + AvFILLp(av);
4497 while (svp <= last) {
4499 SV *const referrer = *svp;
4500 if (SvWEAKREF(referrer)) {
4501 /* XXX Should we check that it hasn't changed? */
4502 SvRV_set(referrer, 0);
4504 SvWEAKREF_off(referrer);
4505 } else if (SvTYPE(referrer) == SVt_PVGV ||
4506 SvTYPE(referrer) == SVt_PVLV) {
4507 /* You lookin' at me? */
4508 assert(GvSTASH(referrer));
4509 assert(GvSTASH(referrer) == (HV*)sv);
4510 GvSTASH(referrer) = 0;
4513 "panic: magic_killbackrefs (flags=%"UVxf")",
4514 (UV)SvFLAGS(referrer));
4522 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4527 =for apidoc sv_insert
4529 Inserts a string at the specified offset/length within the SV. Similar to
4530 the Perl substr() function.
4536 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4541 register char *midend;
4542 register char *bigend;
4548 Perl_croak(aTHX_ "Can't modify non-existent substring");
4549 SvPV_force(bigstr, curlen);
4550 (void)SvPOK_only_UTF8(bigstr);
4551 if (offset + len > curlen) {
4552 SvGROW(bigstr, offset+len+1);
4553 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4554 SvCUR_set(bigstr, offset+len);
4558 i = littlelen - len;
4559 if (i > 0) { /* string might grow */
4560 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4561 mid = big + offset + len;
4562 midend = bigend = big + SvCUR(bigstr);
4565 while (midend > mid) /* shove everything down */
4566 *--bigend = *--midend;
4567 Move(little,big+offset,littlelen,char);
4568 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4573 Move(little,SvPVX(bigstr)+offset,len,char);
4578 big = SvPVX(bigstr);
4581 bigend = big + SvCUR(bigstr);
4583 if (midend > bigend)
4584 Perl_croak(aTHX_ "panic: sv_insert");
4586 if (mid - big > bigend - midend) { /* faster to shorten from end */
4588 Move(little, mid, littlelen,char);
4591 i = bigend - midend;
4593 Move(midend, mid, i,char);
4597 SvCUR_set(bigstr, mid - big);
4599 else if ((i = mid - big)) { /* faster from front */
4600 midend -= littlelen;
4602 sv_chop(bigstr,midend-i);
4607 Move(little, mid, littlelen,char);
4609 else if (littlelen) {
4610 midend -= littlelen;
4611 sv_chop(bigstr,midend);
4612 Move(little,midend,littlelen,char);
4615 sv_chop(bigstr,midend);
4621 =for apidoc sv_replace
4623 Make the first argument a copy of the second, then delete the original.
4624 The target SV physically takes over ownership of the body of the source SV
4625 and inherits its flags; however, the target keeps any magic it owns,
4626 and any magic in the source is discarded.
4627 Note that this is a rather specialist SV copying operation; most of the
4628 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4634 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4637 const U32 refcnt = SvREFCNT(sv);
4638 SV_CHECK_THINKFIRST_COW_DROP(sv);
4639 if (SvREFCNT(nsv) != 1) {
4640 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4641 UVuf " != 1)", (UV) SvREFCNT(nsv));
4643 if (SvMAGICAL(sv)) {
4647 sv_upgrade(nsv, SVt_PVMG);
4648 SvMAGIC_set(nsv, SvMAGIC(sv));
4649 SvFLAGS(nsv) |= SvMAGICAL(sv);
4651 SvMAGIC_set(sv, NULL);
4655 assert(!SvREFCNT(sv));
4656 #ifdef DEBUG_LEAKING_SCALARS
4657 sv->sv_flags = nsv->sv_flags;
4658 sv->sv_any = nsv->sv_any;
4659 sv->sv_refcnt = nsv->sv_refcnt;
4660 sv->sv_u = nsv->sv_u;
4662 StructCopy(nsv,sv,SV);
4664 /* Currently could join these into one piece of pointer arithmetic, but
4665 it would be unclear. */
4666 if(SvTYPE(sv) == SVt_IV)
4668 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4669 else if (SvTYPE(sv) == SVt_RV) {
4670 SvANY(sv) = &sv->sv_u.svu_rv;
4674 #ifdef PERL_OLD_COPY_ON_WRITE
4675 if (SvIsCOW_normal(nsv)) {
4676 /* We need to follow the pointers around the loop to make the
4677 previous SV point to sv, rather than nsv. */
4680 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4683 assert(SvPVX_const(current) == SvPVX_const(nsv));
4685 /* Make the SV before us point to the SV after us. */
4687 PerlIO_printf(Perl_debug_log, "previous is\n");
4689 PerlIO_printf(Perl_debug_log,
4690 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4691 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4693 SV_COW_NEXT_SV_SET(current, sv);
4696 SvREFCNT(sv) = refcnt;
4697 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4703 =for apidoc sv_clear
4705 Clear an SV: call any destructors, free up any memory used by the body,
4706 and free the body itself. The SV's head is I<not> freed, although
4707 its type is set to all 1's so that it won't inadvertently be assumed
4708 to be live during global destruction etc.
4709 This function should only be called when REFCNT is zero. Most of the time
4710 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4717 Perl_sv_clear(pTHX_ register SV *sv)
4720 const U32 type = SvTYPE(sv);
4721 const struct body_details *const sv_type_details
4722 = bodies_by_type + type;
4725 assert(SvREFCNT(sv) == 0);
4731 if (PL_defstash) { /* Still have a symbol table? */
4736 stash = SvSTASH(sv);
4737 destructor = StashHANDLER(stash,DESTROY);
4739 SV* const tmpref = newRV(sv);
4740 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4742 PUSHSTACKi(PERLSI_DESTROY);
4747 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4753 if(SvREFCNT(tmpref) < 2) {
4754 /* tmpref is not kept alive! */
4756 SvRV_set(tmpref, NULL);
4759 SvREFCNT_dec(tmpref);
4761 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4765 if (PL_in_clean_objs)
4766 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4768 /* DESTROY gave object new lease on life */
4774 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4775 SvOBJECT_off(sv); /* Curse the object. */
4776 if (type != SVt_PVIO)
4777 --PL_sv_objcount; /* XXX Might want something more general */
4780 if (type >= SVt_PVMG) {
4783 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4784 SvREFCNT_dec(SvSTASH(sv));
4789 IoIFP(sv) != PerlIO_stdin() &&
4790 IoIFP(sv) != PerlIO_stdout() &&
4791 IoIFP(sv) != PerlIO_stderr())
4793 io_close((IO*)sv, FALSE);
4795 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4796 PerlDir_close(IoDIRP(sv));
4797 IoDIRP(sv) = (DIR*)NULL;
4798 Safefree(IoTOP_NAME(sv));
4799 Safefree(IoFMT_NAME(sv));
4800 Safefree(IoBOTTOM_NAME(sv));
4809 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4816 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4817 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4818 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4819 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4821 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4822 SvREFCNT_dec(LvTARG(sv));
4826 Safefree(GvNAME(sv));
4827 /* If we're in a stash, we don't own a reference to it. However it does
4828 have a back reference to us, which needs to be cleared. */
4830 sv_del_backref((SV*)GvSTASH(sv), sv);
4835 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4837 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4838 /* Don't even bother with turning off the OOK flag. */
4843 SV *target = SvRV(sv);
4845 sv_del_backref(target, sv);
4847 SvREFCNT_dec(target);
4849 #ifdef PERL_OLD_COPY_ON_WRITE
4850 else if (SvPVX_const(sv)) {
4852 /* I believe I need to grab the global SV mutex here and
4853 then recheck the COW status. */
4855 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4858 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4859 SV_COW_NEXT_SV(sv));
4860 /* And drop it here. */
4862 } else if (SvLEN(sv)) {
4863 Safefree(SvPVX_const(sv));
4867 else if (SvPVX_const(sv) && SvLEN(sv))
4868 Safefree(SvPVX_mutable(sv));
4869 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4870 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4879 SvFLAGS(sv) &= SVf_BREAK;
4880 SvFLAGS(sv) |= SVTYPEMASK;
4882 if (sv_type_details->arena) {
4883 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4884 &PL_body_roots[type]);
4886 else if (sv_type_details->size) {
4887 my_safefree(SvANY(sv));
4892 =for apidoc sv_newref
4894 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4901 Perl_sv_newref(pTHX_ SV *sv)
4911 Decrement an SV's reference count, and if it drops to zero, call
4912 C<sv_clear> to invoke destructors and free up any memory used by
4913 the body; finally, deallocate the SV's head itself.
4914 Normally called via a wrapper macro C<SvREFCNT_dec>.
4920 Perl_sv_free(pTHX_ SV *sv)
4925 if (SvREFCNT(sv) == 0) {
4926 if (SvFLAGS(sv) & SVf_BREAK)
4927 /* this SV's refcnt has been artificially decremented to
4928 * trigger cleanup */
4930 if (PL_in_clean_all) /* All is fair */
4932 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4933 /* make sure SvREFCNT(sv)==0 happens very seldom */
4934 SvREFCNT(sv) = (~(U32)0)/2;
4937 if (ckWARN_d(WARN_INTERNAL)) {
4938 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4939 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4940 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4941 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4942 Perl_dump_sv_child(aTHX_ sv);
4947 if (--(SvREFCNT(sv)) > 0)
4949 Perl_sv_free2(aTHX_ sv);
4953 Perl_sv_free2(pTHX_ SV *sv)
4958 if (ckWARN_d(WARN_DEBUGGING))
4959 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4960 "Attempt to free temp prematurely: SV 0x%"UVxf
4961 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4965 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4966 /* make sure SvREFCNT(sv)==0 happens very seldom */
4967 SvREFCNT(sv) = (~(U32)0)/2;
4978 Returns the length of the string in the SV. Handles magic and type
4979 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4985 Perl_sv_len(pTHX_ register SV *sv)
4993 len = mg_length(sv);
4995 (void)SvPV_const(sv, len);
5000 =for apidoc sv_len_utf8
5002 Returns the number of characters in the string in an SV, counting wide
5003 UTF-8 bytes as a single character. Handles magic and type coercion.
5009 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5010 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5011 * (Note that the mg_len is not the length of the mg_ptr field.)
5016 Perl_sv_len_utf8(pTHX_ register SV *sv)
5022 return mg_length(sv);
5026 const U8 *s = (U8*)SvPV_const(sv, len);
5027 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5029 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5031 #ifdef PERL_UTF8_CACHE_ASSERT
5032 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5036 ulen = Perl_utf8_length(aTHX_ s, s + len);
5037 if (!mg && !SvREADONLY(sv)) {
5038 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5039 mg = mg_find(sv, PERL_MAGIC_utf8);
5049 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5050 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5051 * between UTF-8 and byte offsets. There are two (substr offset and substr
5052 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5053 * and byte offset) cache positions.
5055 * The mg_len field is used by sv_len_utf8(), see its comments.
5056 * Note that the mg_len is not the length of the mg_ptr field.
5060 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5061 I32 offsetp, const U8 *s, const U8 *start)
5065 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5067 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5071 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5073 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5074 (*mgp)->mg_ptr = (char *) *cachep;
5078 (*cachep)[i] = offsetp;
5079 (*cachep)[i+1] = s - start;
5087 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5088 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5089 * between UTF-8 and byte offsets. See also the comments of
5090 * S_utf8_mg_pos_init().
5094 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)
5098 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5100 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5101 if (*mgp && (*mgp)->mg_ptr) {
5102 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5103 ASSERT_UTF8_CACHE(*cachep);
5104 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5106 else { /* We will skip to the right spot. */
5111 /* The assumption is that going backward is half
5112 * the speed of going forward (that's where the
5113 * 2 * backw in the below comes from). (The real
5114 * figure of course depends on the UTF-8 data.) */
5116 if ((*cachep)[i] > (STRLEN)uoff) {
5118 backw = (*cachep)[i] - (STRLEN)uoff;
5120 if (forw < 2 * backw)
5123 p = start + (*cachep)[i+1];
5125 /* Try this only for the substr offset (i == 0),
5126 * not for the substr length (i == 2). */
5127 else if (i == 0) { /* (*cachep)[i] < uoff */
5128 const STRLEN ulen = sv_len_utf8(sv);
5130 if ((STRLEN)uoff < ulen) {
5131 forw = (STRLEN)uoff - (*cachep)[i];
5132 backw = ulen - (STRLEN)uoff;
5134 if (forw < 2 * backw)
5135 p = start + (*cachep)[i+1];
5140 /* If the string is not long enough for uoff,
5141 * we could extend it, but not at this low a level. */
5145 if (forw < 2 * backw) {
5152 while (UTF8_IS_CONTINUATION(*p))
5157 /* Update the cache. */
5158 (*cachep)[i] = (STRLEN)uoff;
5159 (*cachep)[i+1] = p - start;
5161 /* Drop the stale "length" cache */
5170 if (found) { /* Setup the return values. */
5171 *offsetp = (*cachep)[i+1];
5172 *sp = start + *offsetp;
5175 *offsetp = send - start;
5177 else if (*sp < start) {
5183 #ifdef PERL_UTF8_CACHE_ASSERT
5188 while (n-- && s < send)
5192 assert(*offsetp == s - start);
5193 assert((*cachep)[0] == (STRLEN)uoff);
5194 assert((*cachep)[1] == *offsetp);
5196 ASSERT_UTF8_CACHE(*cachep);
5205 =for apidoc sv_pos_u2b
5207 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5208 the start of the string, to a count of the equivalent number of bytes; if
5209 lenp is non-zero, it does the same to lenp, but this time starting from
5210 the offset, rather than from the start of the string. Handles magic and
5217 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5218 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5219 * byte offsets. See also the comments of S_utf8_mg_pos().
5224 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5232 start = (U8*)SvPV_const(sv, len);
5235 STRLEN *cache = NULL;
5236 const U8 *s = start;
5237 I32 uoffset = *offsetp;
5238 const U8 * const send = s + len;
5240 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5242 if (!found && uoffset > 0) {
5243 while (s < send && uoffset--)
5247 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5249 *offsetp = s - start;
5254 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5258 if (!found && *lenp > 0) {
5261 while (s < send && ulen--)
5265 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5269 ASSERT_UTF8_CACHE(cache);
5281 =for apidoc sv_pos_b2u
5283 Converts the value pointed to by offsetp from a count of bytes from the
5284 start of the string, to a count of the equivalent number of UTF-8 chars.
5285 Handles magic and type coercion.
5291 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5292 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5293 * byte offsets. See also the comments of S_utf8_mg_pos().
5298 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5306 s = (const U8*)SvPV_const(sv, len);
5307 if ((I32)len < *offsetp)
5308 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5310 const U8* send = s + *offsetp;
5312 STRLEN *cache = NULL;
5316 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5317 mg = mg_find(sv, PERL_MAGIC_utf8);
5318 if (mg && mg->mg_ptr) {
5319 cache = (STRLEN *) mg->mg_ptr;
5320 if (cache[1] == (STRLEN)*offsetp) {
5321 /* An exact match. */
5322 *offsetp = cache[0];
5326 else if (cache[1] < (STRLEN)*offsetp) {
5327 /* We already know part of the way. */
5330 /* Let the below loop do the rest. */
5332 else { /* cache[1] > *offsetp */
5333 /* We already know all of the way, now we may
5334 * be able to walk back. The same assumption
5335 * is made as in S_utf8_mg_pos(), namely that
5336 * walking backward is twice slower than
5337 * walking forward. */
5338 const STRLEN forw = *offsetp;
5339 STRLEN backw = cache[1] - *offsetp;
5341 if (!(forw < 2 * backw)) {
5342 const U8 *p = s + cache[1];
5349 while (UTF8_IS_CONTINUATION(*p)) {
5357 *offsetp = cache[0];
5359 /* Drop the stale "length" cache */
5367 ASSERT_UTF8_CACHE(cache);
5373 /* Call utf8n_to_uvchr() to validate the sequence
5374 * (unless a simple non-UTF character) */
5375 if (!UTF8_IS_INVARIANT(*s))
5376 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5385 if (!SvREADONLY(sv)) {
5387 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5388 mg = mg_find(sv, PERL_MAGIC_utf8);
5393 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5394 mg->mg_ptr = (char *) cache;
5399 cache[1] = *offsetp;
5400 /* Drop the stale "length" cache */
5413 Returns a boolean indicating whether the strings in the two SVs are
5414 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5415 coerce its args to strings if necessary.
5421 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5430 SV* svrecode = Nullsv;
5437 pv1 = SvPV_const(sv1, cur1);
5444 pv2 = SvPV_const(sv2, cur2);
5446 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5447 /* Differing utf8ness.
5448 * Do not UTF8size the comparands as a side-effect. */
5451 svrecode = newSVpvn(pv2, cur2);
5452 sv_recode_to_utf8(svrecode, PL_encoding);
5453 pv2 = SvPV_const(svrecode, cur2);
5456 svrecode = newSVpvn(pv1, cur1);
5457 sv_recode_to_utf8(svrecode, PL_encoding);
5458 pv1 = SvPV_const(svrecode, cur1);
5460 /* Now both are in UTF-8. */
5462 SvREFCNT_dec(svrecode);
5467 bool is_utf8 = TRUE;
5470 /* sv1 is the UTF-8 one,
5471 * if is equal it must be downgrade-able */
5472 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5478 /* sv2 is the UTF-8 one,
5479 * if is equal it must be downgrade-able */
5480 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5486 /* Downgrade not possible - cannot be eq */
5494 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5497 SvREFCNT_dec(svrecode);
5508 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5509 string in C<sv1> is less than, equal to, or greater than the string in
5510 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5511 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5517 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5521 const char *pv1, *pv2;
5524 SV *svrecode = Nullsv;
5531 pv1 = SvPV_const(sv1, cur1);
5538 pv2 = SvPV_const(sv2, cur2);
5540 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5541 /* Differing utf8ness.
5542 * Do not UTF8size the comparands as a side-effect. */
5545 svrecode = newSVpvn(pv2, cur2);
5546 sv_recode_to_utf8(svrecode, PL_encoding);
5547 pv2 = SvPV_const(svrecode, cur2);
5550 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5555 svrecode = newSVpvn(pv1, cur1);
5556 sv_recode_to_utf8(svrecode, PL_encoding);
5557 pv1 = SvPV_const(svrecode, cur1);
5560 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5566 cmp = cur2 ? -1 : 0;
5570 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5573 cmp = retval < 0 ? -1 : 1;
5574 } else if (cur1 == cur2) {
5577 cmp = cur1 < cur2 ? -1 : 1;
5582 SvREFCNT_dec(svrecode);
5591 =for apidoc sv_cmp_locale
5593 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5594 'use bytes' aware, handles get magic, and will coerce its args to strings
5595 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5601 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5604 #ifdef USE_LOCALE_COLLATE
5610 if (PL_collation_standard)
5614 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5616 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5618 if (!pv1 || !len1) {
5629 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5632 return retval < 0 ? -1 : 1;
5635 * When the result of collation is equality, that doesn't mean
5636 * that there are no differences -- some locales exclude some
5637 * characters from consideration. So to avoid false equalities,
5638 * we use the raw string as a tiebreaker.
5644 #endif /* USE_LOCALE_COLLATE */
5646 return sv_cmp(sv1, sv2);
5650 #ifdef USE_LOCALE_COLLATE
5653 =for apidoc sv_collxfrm
5655 Add Collate Transform magic to an SV if it doesn't already have it.
5657 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5658 scalar data of the variable, but transformed to such a format that a normal
5659 memory comparison can be used to compare the data according to the locale
5666 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5671 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5672 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5678 Safefree(mg->mg_ptr);
5679 s = SvPV_const(sv, len);
5680 if ((xf = mem_collxfrm(s, len, &xlen))) {
5681 if (SvREADONLY(sv)) {
5684 return xf + sizeof(PL_collation_ix);
5687 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5688 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5701 if (mg && mg->mg_ptr) {
5703 return mg->mg_ptr + sizeof(PL_collation_ix);
5711 #endif /* USE_LOCALE_COLLATE */
5716 Get a line from the filehandle and store it into the SV, optionally
5717 appending to the currently-stored string.
5723 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5728 register STDCHAR rslast;
5729 register STDCHAR *bp;
5735 if (SvTHINKFIRST(sv))
5736 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5737 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5739 However, perlbench says it's slower, because the existing swipe code
5740 is faster than copy on write.
5741 Swings and roundabouts. */
5742 SvUPGRADE(sv, SVt_PV);
5747 if (PerlIO_isutf8(fp)) {
5749 sv_utf8_upgrade_nomg(sv);
5750 sv_pos_u2b(sv,&append,0);
5752 } else if (SvUTF8(sv)) {
5753 SV * const tsv = newSV(0);
5754 sv_gets(tsv, fp, 0);
5755 sv_utf8_upgrade_nomg(tsv);
5756 SvCUR_set(sv,append);
5759 goto return_string_or_null;
5764 if (PerlIO_isutf8(fp))
5767 if (IN_PERL_COMPILETIME) {
5768 /* we always read code in line mode */
5772 else if (RsSNARF(PL_rs)) {
5773 /* If it is a regular disk file use size from stat() as estimate
5774 of amount we are going to read - may result in malloc-ing
5775 more memory than we realy need if layers bellow reduce
5776 size we read (e.g. CRLF or a gzip layer)
5779 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5780 const Off_t offset = PerlIO_tell(fp);
5781 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5782 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5788 else if (RsRECORD(PL_rs)) {
5792 /* Grab the size of the record we're getting */
5793 recsize = SvIV(SvRV(PL_rs));
5794 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5797 /* VMS wants read instead of fread, because fread doesn't respect */
5798 /* RMS record boundaries. This is not necessarily a good thing to be */
5799 /* doing, but we've got no other real choice - except avoid stdio
5800 as implementation - perhaps write a :vms layer ?
5802 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5804 bytesread = PerlIO_read(fp, buffer, recsize);
5808 SvCUR_set(sv, bytesread += append);
5809 buffer[bytesread] = '\0';
5810 goto return_string_or_null;
5812 else if (RsPARA(PL_rs)) {
5818 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5819 if (PerlIO_isutf8(fp)) {
5820 rsptr = SvPVutf8(PL_rs, rslen);
5823 if (SvUTF8(PL_rs)) {
5824 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5825 Perl_croak(aTHX_ "Wide character in $/");
5828 rsptr = SvPV_const(PL_rs, rslen);
5832 rslast = rslen ? rsptr[rslen - 1] : '\0';
5834 if (rspara) { /* have to do this both before and after */
5835 do { /* to make sure file boundaries work right */
5838 i = PerlIO_getc(fp);
5842 PerlIO_ungetc(fp,i);
5848 /* See if we know enough about I/O mechanism to cheat it ! */
5850 /* This used to be #ifdef test - it is made run-time test for ease
5851 of abstracting out stdio interface. One call should be cheap
5852 enough here - and may even be a macro allowing compile
5856 if (PerlIO_fast_gets(fp)) {
5859 * We're going to steal some values from the stdio struct
5860 * and put EVERYTHING in the innermost loop into registers.
5862 register STDCHAR *ptr;
5866 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5867 /* An ungetc()d char is handled separately from the regular
5868 * buffer, so we getc() it back out and stuff it in the buffer.
5870 i = PerlIO_getc(fp);
5871 if (i == EOF) return 0;
5872 *(--((*fp)->_ptr)) = (unsigned char) i;
5876 /* Here is some breathtakingly efficient cheating */
5878 cnt = PerlIO_get_cnt(fp); /* get count into register */
5879 /* make sure we have the room */
5880 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5881 /* Not room for all of it
5882 if we are looking for a separator and room for some
5884 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5885 /* just process what we have room for */
5886 shortbuffered = cnt - SvLEN(sv) + append + 1;
5887 cnt -= shortbuffered;
5891 /* remember that cnt can be negative */
5892 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5897 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5898 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5899 DEBUG_P(PerlIO_printf(Perl_debug_log,
5900 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5901 DEBUG_P(PerlIO_printf(Perl_debug_log,
5902 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5903 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5904 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5909 while (cnt > 0) { /* this | eat */
5911 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5912 goto thats_all_folks; /* screams | sed :-) */
5916 Copy(ptr, bp, cnt, char); /* this | eat */
5917 bp += cnt; /* screams | dust */
5918 ptr += cnt; /* louder | sed :-) */
5923 if (shortbuffered) { /* oh well, must extend */
5924 cnt = shortbuffered;
5926 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5928 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5929 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5933 DEBUG_P(PerlIO_printf(Perl_debug_log,
5934 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5935 PTR2UV(ptr),(long)cnt));
5936 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5938 DEBUG_P(PerlIO_printf(Perl_debug_log,
5939 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5940 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5941 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5943 /* This used to call 'filbuf' in stdio form, but as that behaves like
5944 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5945 another abstraction. */
5946 i = PerlIO_getc(fp); /* get more characters */
5948 DEBUG_P(PerlIO_printf(Perl_debug_log,
5949 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5950 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5951 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5953 cnt = PerlIO_get_cnt(fp);
5954 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5955 DEBUG_P(PerlIO_printf(Perl_debug_log,
5956 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5958 if (i == EOF) /* all done for ever? */
5959 goto thats_really_all_folks;
5961 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5963 SvGROW(sv, bpx + cnt + 2);
5964 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5966 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5968 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5969 goto thats_all_folks;
5973 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5974 memNE((char*)bp - rslen, rsptr, rslen))
5975 goto screamer; /* go back to the fray */
5976 thats_really_all_folks:
5978 cnt += shortbuffered;
5979 DEBUG_P(PerlIO_printf(Perl_debug_log,
5980 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5981 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5982 DEBUG_P(PerlIO_printf(Perl_debug_log,
5983 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5984 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5985 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5987 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5988 DEBUG_P(PerlIO_printf(Perl_debug_log,
5989 "Screamer: done, len=%ld, string=|%.*s|\n",
5990 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5994 /*The big, slow, and stupid way. */
5995 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5996 STDCHAR *buf = NULL;
5997 Newx(buf, 8192, STDCHAR);
6005 register const STDCHAR * const bpe = buf + sizeof(buf);
6007 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6008 ; /* keep reading */
6012 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6013 /* Accomodate broken VAXC compiler, which applies U8 cast to
6014 * both args of ?: operator, causing EOF to change into 255
6017 i = (U8)buf[cnt - 1];
6023 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6025 sv_catpvn(sv, (char *) buf, cnt);
6027 sv_setpvn(sv, (char *) buf, cnt);
6029 if (i != EOF && /* joy */
6031 SvCUR(sv) < rslen ||
6032 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6036 * If we're reading from a TTY and we get a short read,
6037 * indicating that the user hit his EOF character, we need
6038 * to notice it now, because if we try to read from the TTY
6039 * again, the EOF condition will disappear.
6041 * The comparison of cnt to sizeof(buf) is an optimization
6042 * that prevents unnecessary calls to feof().
6046 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6050 #ifdef USE_HEAP_INSTEAD_OF_STACK
6055 if (rspara) { /* have to do this both before and after */
6056 while (i != EOF) { /* to make sure file boundaries work right */
6057 i = PerlIO_getc(fp);
6059 PerlIO_ungetc(fp,i);
6065 return_string_or_null:
6066 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6072 Auto-increment of the value in the SV, doing string to numeric conversion
6073 if necessary. Handles 'get' magic.
6079 Perl_sv_inc(pTHX_ register SV *sv)
6088 if (SvTHINKFIRST(sv)) {
6090 sv_force_normal_flags(sv, 0);
6091 if (SvREADONLY(sv)) {
6092 if (IN_PERL_RUNTIME)
6093 Perl_croak(aTHX_ PL_no_modify);
6097 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6099 i = PTR2IV(SvRV(sv));
6104 flags = SvFLAGS(sv);
6105 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6106 /* It's (privately or publicly) a float, but not tested as an
6107 integer, so test it to see. */
6109 flags = SvFLAGS(sv);
6111 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6112 /* It's publicly an integer, or privately an integer-not-float */
6113 #ifdef PERL_PRESERVE_IVUV
6117 if (SvUVX(sv) == UV_MAX)
6118 sv_setnv(sv, UV_MAX_P1);
6120 (void)SvIOK_only_UV(sv);
6121 SvUV_set(sv, SvUVX(sv) + 1);
6123 if (SvIVX(sv) == IV_MAX)
6124 sv_setuv(sv, (UV)IV_MAX + 1);
6126 (void)SvIOK_only(sv);
6127 SvIV_set(sv, SvIVX(sv) + 1);
6132 if (flags & SVp_NOK) {
6133 (void)SvNOK_only(sv);
6134 SvNV_set(sv, SvNVX(sv) + 1.0);
6138 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6139 if ((flags & SVTYPEMASK) < SVt_PVIV)
6140 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6141 (void)SvIOK_only(sv);
6146 while (isALPHA(*d)) d++;
6147 while (isDIGIT(*d)) d++;
6149 #ifdef PERL_PRESERVE_IVUV
6150 /* Got to punt this as an integer if needs be, but we don't issue
6151 warnings. Probably ought to make the sv_iv_please() that does
6152 the conversion if possible, and silently. */
6153 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6154 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6155 /* Need to try really hard to see if it's an integer.
6156 9.22337203685478e+18 is an integer.
6157 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6158 so $a="9.22337203685478e+18"; $a+0; $a++
6159 needs to be the same as $a="9.22337203685478e+18"; $a++
6166 /* sv_2iv *should* have made this an NV */
6167 if (flags & SVp_NOK) {
6168 (void)SvNOK_only(sv);
6169 SvNV_set(sv, SvNVX(sv) + 1.0);
6172 /* I don't think we can get here. Maybe I should assert this
6173 And if we do get here I suspect that sv_setnv will croak. NWC
6175 #if defined(USE_LONG_DOUBLE)
6176 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",
6177 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6179 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6180 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6183 #endif /* PERL_PRESERVE_IVUV */
6184 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6188 while (d >= SvPVX_const(sv)) {
6196 /* MKS: The original code here died if letters weren't consecutive.
6197 * at least it didn't have to worry about non-C locales. The
6198 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6199 * arranged in order (although not consecutively) and that only
6200 * [A-Za-z] are accepted by isALPHA in the C locale.
6202 if (*d != 'z' && *d != 'Z') {
6203 do { ++*d; } while (!isALPHA(*d));
6206 *(d--) -= 'z' - 'a';
6211 *(d--) -= 'z' - 'a' + 1;
6215 /* oh,oh, the number grew */
6216 SvGROW(sv, SvCUR(sv) + 2);
6217 SvCUR_set(sv, SvCUR(sv) + 1);
6218 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6229 Auto-decrement of the value in the SV, doing string to numeric conversion
6230 if necessary. Handles 'get' magic.
6236 Perl_sv_dec(pTHX_ register SV *sv)
6244 if (SvTHINKFIRST(sv)) {
6246 sv_force_normal_flags(sv, 0);
6247 if (SvREADONLY(sv)) {
6248 if (IN_PERL_RUNTIME)
6249 Perl_croak(aTHX_ PL_no_modify);
6253 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6255 i = PTR2IV(SvRV(sv));
6260 /* Unlike sv_inc we don't have to worry about string-never-numbers
6261 and keeping them magic. But we mustn't warn on punting */
6262 flags = SvFLAGS(sv);
6263 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6264 /* It's publicly an integer, or privately an integer-not-float */
6265 #ifdef PERL_PRESERVE_IVUV
6269 if (SvUVX(sv) == 0) {
6270 (void)SvIOK_only(sv);
6274 (void)SvIOK_only_UV(sv);
6275 SvUV_set(sv, SvUVX(sv) - 1);
6278 if (SvIVX(sv) == IV_MIN)
6279 sv_setnv(sv, (NV)IV_MIN - 1.0);
6281 (void)SvIOK_only(sv);
6282 SvIV_set(sv, SvIVX(sv) - 1);
6287 if (flags & SVp_NOK) {
6288 SvNV_set(sv, SvNVX(sv) - 1.0);
6289 (void)SvNOK_only(sv);
6292 if (!(flags & SVp_POK)) {
6293 if ((flags & SVTYPEMASK) < SVt_PVIV)
6294 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6296 (void)SvIOK_only(sv);
6299 #ifdef PERL_PRESERVE_IVUV
6301 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6302 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6303 /* Need to try really hard to see if it's an integer.
6304 9.22337203685478e+18 is an integer.
6305 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6306 so $a="9.22337203685478e+18"; $a+0; $a--
6307 needs to be the same as $a="9.22337203685478e+18"; $a--
6314 /* sv_2iv *should* have made this an NV */
6315 if (flags & SVp_NOK) {
6316 (void)SvNOK_only(sv);
6317 SvNV_set(sv, SvNVX(sv) - 1.0);
6320 /* I don't think we can get here. Maybe I should assert this
6321 And if we do get here I suspect that sv_setnv will croak. NWC
6323 #if defined(USE_LONG_DOUBLE)
6324 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",
6325 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6327 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6328 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6332 #endif /* PERL_PRESERVE_IVUV */
6333 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6337 =for apidoc sv_mortalcopy
6339 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6340 The new SV is marked as mortal. It will be destroyed "soon", either by an
6341 explicit call to FREETMPS, or by an implicit call at places such as
6342 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6347 /* Make a string that will exist for the duration of the expression
6348 * evaluation. Actually, it may have to last longer than that, but
6349 * hopefully we won't free it until it has been assigned to a
6350 * permanent location. */
6353 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6359 sv_setsv(sv,oldstr);
6361 PL_tmps_stack[++PL_tmps_ix] = sv;
6367 =for apidoc sv_newmortal
6369 Creates a new null SV which is mortal. The reference count of the SV is
6370 set to 1. It will be destroyed "soon", either by an explicit call to
6371 FREETMPS, or by an implicit call at places such as statement boundaries.
6372 See also C<sv_mortalcopy> and C<sv_2mortal>.
6378 Perl_sv_newmortal(pTHX)
6384 SvFLAGS(sv) = SVs_TEMP;
6386 PL_tmps_stack[++PL_tmps_ix] = sv;
6391 =for apidoc sv_2mortal
6393 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6394 by an explicit call to FREETMPS, or by an implicit call at places such as
6395 statement boundaries. SvTEMP() is turned on which means that the SV's
6396 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6397 and C<sv_mortalcopy>.
6403 Perl_sv_2mortal(pTHX_ register SV *sv)
6408 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6411 PL_tmps_stack[++PL_tmps_ix] = sv;
6419 Creates a new SV and copies a string into it. The reference count for the
6420 SV is set to 1. If C<len> is zero, Perl will compute the length using
6421 strlen(). For efficiency, consider using C<newSVpvn> instead.
6427 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6433 sv_setpvn(sv,s,len ? len : strlen(s));
6438 =for apidoc newSVpvn
6440 Creates a new SV and copies a string into it. The reference count for the
6441 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6442 string. You are responsible for ensuring that the source string is at least
6443 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6449 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6455 sv_setpvn(sv,s,len);
6461 =for apidoc newSVhek
6463 Creates a new SV from the hash key structure. It will generate scalars that
6464 point to the shared string table where possible. Returns a new (undefined)
6465 SV if the hek is NULL.
6471 Perl_newSVhek(pTHX_ const HEK *hek)
6481 if (HEK_LEN(hek) == HEf_SVKEY) {
6482 return newSVsv(*(SV**)HEK_KEY(hek));
6484 const int flags = HEK_FLAGS(hek);
6485 if (flags & HVhek_WASUTF8) {
6487 Andreas would like keys he put in as utf8 to come back as utf8
6489 STRLEN utf8_len = HEK_LEN(hek);
6490 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6491 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6494 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6496 } else if (flags & HVhek_REHASH) {
6497 /* We don't have a pointer to the hv, so we have to replicate the
6498 flag into every HEK. This hv is using custom a hasing
6499 algorithm. Hence we can't return a shared string scalar, as
6500 that would contain the (wrong) hash value, and might get passed
6501 into an hv routine with a regular hash */
6503 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6508 /* This will be overwhelminly the most common case. */
6509 return newSVpvn_share(HEK_KEY(hek),
6510 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6516 =for apidoc newSVpvn_share
6518 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6519 table. If the string does not already exist in the table, it is created
6520 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6521 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6522 otherwise the hash is computed. The idea here is that as the string table
6523 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6524 hash lookup will avoid string compare.
6530 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6534 bool is_utf8 = FALSE;
6536 STRLEN tmplen = -len;
6538 /* See the note in hv.c:hv_fetch() --jhi */
6539 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6543 PERL_HASH(hash, src, len);
6545 sv_upgrade(sv, SVt_PV);
6546 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6558 #if defined(PERL_IMPLICIT_CONTEXT)
6560 /* pTHX_ magic can't cope with varargs, so this is a no-context
6561 * version of the main function, (which may itself be aliased to us).
6562 * Don't access this version directly.
6566 Perl_newSVpvf_nocontext(const char* pat, ...)
6571 va_start(args, pat);
6572 sv = vnewSVpvf(pat, &args);
6579 =for apidoc newSVpvf
6581 Creates a new SV and initializes it with the string formatted like
6588 Perl_newSVpvf(pTHX_ const char* pat, ...)
6592 va_start(args, pat);
6593 sv = vnewSVpvf(pat, &args);
6598 /* backend for newSVpvf() and newSVpvf_nocontext() */
6601 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6606 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6613 Creates a new SV and copies a floating point value into it.
6614 The reference count for the SV is set to 1.
6620 Perl_newSVnv(pTHX_ NV n)
6633 Creates a new SV and copies an integer into it. The reference count for the
6640 Perl_newSViv(pTHX_ IV i)
6653 Creates a new SV and copies an unsigned integer into it.
6654 The reference count for the SV is set to 1.
6660 Perl_newSVuv(pTHX_ UV u)
6671 =for apidoc newRV_noinc
6673 Creates an RV wrapper for an SV. The reference count for the original
6674 SV is B<not> incremented.
6680 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6686 sv_upgrade(sv, SVt_RV);
6688 SvRV_set(sv, tmpRef);
6693 /* newRV_inc is the official function name to use now.
6694 * newRV_inc is in fact #defined to newRV in sv.h
6698 Perl_newRV(pTHX_ SV *tmpRef)
6701 return newRV_noinc(SvREFCNT_inc(tmpRef));
6707 Creates a new SV which is an exact duplicate of the original SV.
6714 Perl_newSVsv(pTHX_ register SV *old)
6721 if (SvTYPE(old) == SVTYPEMASK) {
6722 if (ckWARN_d(WARN_INTERNAL))
6723 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6727 /* SV_GMAGIC is the default for sv_setv()
6728 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6729 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6730 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6735 =for apidoc sv_reset
6737 Underlying implementation for the C<reset> Perl function.
6738 Note that the perl-level function is vaguely deprecated.
6744 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6747 char todo[PERL_UCHAR_MAX+1];
6752 if (!*s) { /* reset ?? searches */
6753 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6755 PMOP *pm = (PMOP *) mg->mg_obj;
6757 pm->op_pmdynflags &= ~PMdf_USED;
6764 /* reset variables */
6766 if (!HvARRAY(stash))
6769 Zero(todo, 256, char);
6772 I32 i = (unsigned char)*s;
6776 max = (unsigned char)*s++;
6777 for ( ; i <= max; i++) {
6780 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6782 for (entry = HvARRAY(stash)[i];
6784 entry = HeNEXT(entry))
6789 if (!todo[(U8)*HeKEY(entry)])
6791 gv = (GV*)HeVAL(entry);
6794 if (SvTHINKFIRST(sv)) {
6795 if (!SvREADONLY(sv) && SvROK(sv))
6797 /* XXX Is this continue a bug? Why should THINKFIRST
6798 exempt us from resetting arrays and hashes? */
6802 if (SvTYPE(sv) >= SVt_PV) {
6804 if (SvPVX_const(sv) != Nullch)
6812 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6814 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6817 # if defined(USE_ENVIRON_ARRAY)
6820 # endif /* USE_ENVIRON_ARRAY */
6831 Using various gambits, try to get an IO from an SV: the IO slot if its a
6832 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6833 named after the PV if we're a string.
6839 Perl_sv_2io(pTHX_ SV *sv)
6844 switch (SvTYPE(sv)) {
6852 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6856 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6858 return sv_2io(SvRV(sv));
6859 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6865 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6874 Using various gambits, try to get a CV from an SV; in addition, try if
6875 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6876 The flags in C<lref> are passed to sv_fetchsv.
6882 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6889 return *st = NULL, *gvp = Nullgv, Nullcv;
6890 switch (SvTYPE(sv)) {
6909 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6910 tryAMAGICunDEREF(to_cv);
6913 if (SvTYPE(sv) == SVt_PVCV) {
6922 Perl_croak(aTHX_ "Not a subroutine reference");
6927 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6933 /* Some flags to gv_fetchsv mean don't really create the GV */
6934 if (SvTYPE(gv) != SVt_PVGV) {
6940 if (lref && !GvCVu(gv)) {
6944 gv_efullname3(tmpsv, gv, Nullch);
6945 /* XXX this is probably not what they think they're getting.
6946 * It has the same effect as "sub name;", i.e. just a forward
6948 newSUB(start_subparse(FALSE, 0),
6949 newSVOP(OP_CONST, 0, tmpsv),
6954 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6964 Returns true if the SV has a true value by Perl's rules.
6965 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6966 instead use an in-line version.
6972 Perl_sv_true(pTHX_ register SV *sv)
6977 register const XPV* const tXpv = (XPV*)SvANY(sv);
6979 (tXpv->xpv_cur > 1 ||
6980 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6987 return SvIVX(sv) != 0;
6990 return SvNVX(sv) != 0.0;
6992 return sv_2bool(sv);
6998 =for apidoc sv_pvn_force
7000 Get a sensible string out of the SV somehow.
7001 A private implementation of the C<SvPV_force> macro for compilers which
7002 can't cope with complex macro expressions. Always use the macro instead.
7004 =for apidoc sv_pvn_force_flags
7006 Get a sensible string out of the SV somehow.
7007 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7008 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7009 implemented in terms of this function.
7010 You normally want to use the various wrapper macros instead: see
7011 C<SvPV_force> and C<SvPV_force_nomg>
7017 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7020 if (SvTHINKFIRST(sv) && !SvROK(sv))
7021 sv_force_normal_flags(sv, 0);
7031 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7032 const char * const ref = sv_reftype(sv,0);
7034 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7035 ref, OP_NAME(PL_op));
7037 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7039 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7040 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7042 s = sv_2pv_flags(sv, &len, flags);
7046 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7049 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7050 SvGROW(sv, len + 1);
7051 Move(s,SvPVX(sv),len,char);
7056 SvPOK_on(sv); /* validate pointer */
7058 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7059 PTR2UV(sv),SvPVX_const(sv)));
7062 return SvPVX_mutable(sv);
7066 =for apidoc sv_pvbyten_force
7068 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7074 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7076 sv_pvn_force(sv,lp);
7077 sv_utf8_downgrade(sv,0);
7083 =for apidoc sv_pvutf8n_force
7085 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7091 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7093 sv_pvn_force(sv,lp);
7094 sv_utf8_upgrade(sv);
7100 =for apidoc sv_reftype
7102 Returns a string describing what the SV is a reference to.
7108 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7110 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7111 inside return suggests a const propagation bug in g++. */
7112 if (ob && SvOBJECT(sv)) {
7113 char * const name = HvNAME_get(SvSTASH(sv));
7114 return name ? name : (char *) "__ANON__";
7117 switch (SvTYPE(sv)) {
7134 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7135 /* tied lvalues should appear to be
7136 * scalars for backwards compatitbility */
7137 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7138 ? "SCALAR" : "LVALUE");
7139 case SVt_PVAV: return "ARRAY";
7140 case SVt_PVHV: return "HASH";
7141 case SVt_PVCV: return "CODE";
7142 case SVt_PVGV: return "GLOB";
7143 case SVt_PVFM: return "FORMAT";
7144 case SVt_PVIO: return "IO";
7145 default: return "UNKNOWN";
7151 =for apidoc sv_isobject
7153 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7154 object. If the SV is not an RV, or if the object is not blessed, then this
7161 Perl_sv_isobject(pTHX_ SV *sv)
7177 Returns a boolean indicating whether the SV is blessed into the specified
7178 class. This does not check for subtypes; use C<sv_derived_from> to verify
7179 an inheritance relationship.
7185 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7196 hvname = HvNAME_get(SvSTASH(sv));
7200 return strEQ(hvname, name);
7206 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7207 it will be upgraded to one. If C<classname> is non-null then the new SV will
7208 be blessed in the specified package. The new SV is returned and its
7209 reference count is 1.
7215 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7222 SV_CHECK_THINKFIRST_COW_DROP(rv);
7225 if (SvTYPE(rv) >= SVt_PVMG) {
7226 const U32 refcnt = SvREFCNT(rv);
7230 SvREFCNT(rv) = refcnt;
7233 if (SvTYPE(rv) < SVt_RV)
7234 sv_upgrade(rv, SVt_RV);
7235 else if (SvTYPE(rv) > SVt_RV) {
7246 HV* const stash = gv_stashpv(classname, TRUE);
7247 (void)sv_bless(rv, stash);
7253 =for apidoc sv_setref_pv
7255 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7256 argument will be upgraded to an RV. That RV will be modified to point to
7257 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7258 into the SV. The C<classname> argument indicates the package for the
7259 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7260 will have a reference count of 1, and the RV will be returned.
7262 Do not use with other Perl types such as HV, AV, SV, CV, because those
7263 objects will become corrupted by the pointer copy process.
7265 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7271 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7275 sv_setsv(rv, &PL_sv_undef);
7279 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7284 =for apidoc sv_setref_iv
7286 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7287 argument will be upgraded to an RV. That RV will be modified to point to
7288 the new SV. The C<classname> argument indicates the package for the
7289 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7290 will have a reference count of 1, and the RV will be returned.
7296 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7298 sv_setiv(newSVrv(rv,classname), iv);
7303 =for apidoc sv_setref_uv
7305 Copies an unsigned 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_uv(pTHX_ SV *rv, const char *classname, UV uv)
7317 sv_setuv(newSVrv(rv,classname), uv);
7322 =for apidoc sv_setref_nv
7324 Copies a double 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_nv(pTHX_ SV *rv, const char *classname, NV nv)
7336 sv_setnv(newSVrv(rv,classname), nv);
7341 =for apidoc sv_setref_pvn
7343 Copies a string into a new SV, optionally blessing the SV. The length of the
7344 string must be specified with C<n>. The C<rv> argument will be upgraded to
7345 an RV. That RV will be modified to point to the new SV. The C<classname>
7346 argument indicates the package for the blessing. Set C<classname> to
7347 C<Nullch> to avoid the blessing. The new SV will have a reference count
7348 of 1, and the RV will be returned.
7350 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7356 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7358 sv_setpvn(newSVrv(rv,classname), pv, n);
7363 =for apidoc sv_bless
7365 Blesses an SV into a specified package. The SV must be an RV. The package
7366 must be designated by its stash (see C<gv_stashpv()>). The reference count
7367 of the SV is unaffected.
7373 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7378 Perl_croak(aTHX_ "Can't bless non-reference value");
7380 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7381 if (SvREADONLY(tmpRef))
7382 Perl_croak(aTHX_ PL_no_modify);
7383 if (SvOBJECT(tmpRef)) {
7384 if (SvTYPE(tmpRef) != SVt_PVIO)
7386 SvREFCNT_dec(SvSTASH(tmpRef));
7389 SvOBJECT_on(tmpRef);
7390 if (SvTYPE(tmpRef) != SVt_PVIO)
7392 SvUPGRADE(tmpRef, SVt_PVMG);
7393 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7400 if(SvSMAGICAL(tmpRef))
7401 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7409 /* Downgrades a PVGV to a PVMG.
7413 S_sv_unglob(pTHX_ SV *sv)
7418 assert(SvTYPE(sv) == SVt_PVGV);
7423 sv_del_backref((SV*)GvSTASH(sv), sv);
7426 sv_unmagic(sv, PERL_MAGIC_glob);
7427 Safefree(GvNAME(sv));
7430 /* need to keep SvANY(sv) in the right arena */
7431 xpvmg = new_XPVMG();
7432 StructCopy(SvANY(sv), xpvmg, XPVMG);
7433 del_XPVGV(SvANY(sv));
7436 SvFLAGS(sv) &= ~SVTYPEMASK;
7437 SvFLAGS(sv) |= SVt_PVMG;
7441 =for apidoc sv_unref_flags
7443 Unsets the RV status of the SV, and decrements the reference count of
7444 whatever was being referenced by the RV. This can almost be thought of
7445 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7446 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7447 (otherwise the decrementing is conditional on the reference count being
7448 different from one or the reference being a readonly SV).
7455 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7457 SV* const target = SvRV(ref);
7459 if (SvWEAKREF(ref)) {
7460 sv_del_backref(target, ref);
7462 SvRV_set(ref, NULL);
7465 SvRV_set(ref, NULL);
7467 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7468 assigned to as BEGIN {$a = \"Foo"} will fail. */
7469 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7470 SvREFCNT_dec(target);
7471 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7472 sv_2mortal(target); /* Schedule for freeing later */
7476 =for apidoc sv_untaint
7478 Untaint an SV. Use C<SvTAINTED_off> instead.
7483 Perl_sv_untaint(pTHX_ SV *sv)
7485 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7486 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7493 =for apidoc sv_tainted
7495 Test an SV for taintedness. Use C<SvTAINTED> instead.
7500 Perl_sv_tainted(pTHX_ SV *sv)
7502 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7503 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7504 if (mg && (mg->mg_len & 1) )
7511 =for apidoc sv_setpviv
7513 Copies an integer into the given SV, also updating its string value.
7514 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7520 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7522 char buf[TYPE_CHARS(UV)];
7524 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7526 sv_setpvn(sv, ptr, ebuf - ptr);
7530 =for apidoc sv_setpviv_mg
7532 Like C<sv_setpviv>, but also handles 'set' magic.
7538 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7544 #if defined(PERL_IMPLICIT_CONTEXT)
7546 /* pTHX_ magic can't cope with varargs, so this is a no-context
7547 * version of the main function, (which may itself be aliased to us).
7548 * Don't access this version directly.
7552 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7556 va_start(args, pat);
7557 sv_vsetpvf(sv, pat, &args);
7561 /* pTHX_ magic can't cope with varargs, so this is a no-context
7562 * version of the main function, (which may itself be aliased to us).
7563 * Don't access this version directly.
7567 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7571 va_start(args, pat);
7572 sv_vsetpvf_mg(sv, pat, &args);
7578 =for apidoc sv_setpvf
7580 Works like C<sv_catpvf> but copies the text into the SV instead of
7581 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7587 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7590 va_start(args, pat);
7591 sv_vsetpvf(sv, pat, &args);
7596 =for apidoc sv_vsetpvf
7598 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7599 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7601 Usually used via its frontend C<sv_setpvf>.
7607 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7609 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7613 =for apidoc sv_setpvf_mg
7615 Like C<sv_setpvf>, but also handles 'set' magic.
7621 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7624 va_start(args, pat);
7625 sv_vsetpvf_mg(sv, pat, &args);
7630 =for apidoc sv_vsetpvf_mg
7632 Like C<sv_vsetpvf>, but also handles 'set' magic.
7634 Usually used via its frontend C<sv_setpvf_mg>.
7640 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7642 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7646 #if defined(PERL_IMPLICIT_CONTEXT)
7648 /* pTHX_ magic can't cope with varargs, so this is a no-context
7649 * version of the main function, (which may itself be aliased to us).
7650 * Don't access this version directly.
7654 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7658 va_start(args, pat);
7659 sv_vcatpvf(sv, pat, &args);
7663 /* pTHX_ magic can't cope with varargs, so this is a no-context
7664 * version of the main function, (which may itself be aliased to us).
7665 * Don't access this version directly.
7669 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7673 va_start(args, pat);
7674 sv_vcatpvf_mg(sv, pat, &args);
7680 =for apidoc sv_catpvf
7682 Processes its arguments like C<sprintf> and appends the formatted
7683 output to an SV. If the appended data contains "wide" characters
7684 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7685 and characters >255 formatted with %c), the original SV might get
7686 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7687 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7688 valid UTF-8; if the original SV was bytes, the pattern should be too.
7693 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7696 va_start(args, pat);
7697 sv_vcatpvf(sv, pat, &args);
7702 =for apidoc sv_vcatpvf
7704 Processes its arguments like C<vsprintf> and appends the formatted output
7705 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7707 Usually used via its frontend C<sv_catpvf>.
7713 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7715 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7719 =for apidoc sv_catpvf_mg
7721 Like C<sv_catpvf>, but also handles 'set' magic.
7727 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7730 va_start(args, pat);
7731 sv_vcatpvf_mg(sv, pat, &args);
7736 =for apidoc sv_vcatpvf_mg
7738 Like C<sv_vcatpvf>, but also handles 'set' magic.
7740 Usually used via its frontend C<sv_catpvf_mg>.
7746 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7748 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7753 =for apidoc sv_vsetpvfn
7755 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7758 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7764 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7766 sv_setpvn(sv, "", 0);
7767 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7771 S_expect_number(pTHX_ char** pattern)
7775 switch (**pattern) {
7776 case '1': case '2': case '3':
7777 case '4': case '5': case '6':
7778 case '7': case '8': case '9':
7779 var = *(*pattern)++ - '0';
7780 while (isDIGIT(**pattern)) {
7781 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7783 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7791 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7793 const int neg = nv < 0;
7802 if (uv & 1 && uv == nv)
7803 uv--; /* Round to even */
7805 const unsigned dig = uv % 10;
7818 =for apidoc sv_vcatpvfn
7820 Processes its arguments like C<vsprintf> and appends the formatted output
7821 to an SV. Uses an array of SVs if the C style variable argument list is
7822 missing (NULL). When running with taint checks enabled, indicates via
7823 C<maybe_tainted> if results are untrustworthy (often due to the use of
7826 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7832 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7833 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7834 vec_utf8 = DO_UTF8(vecsv);
7836 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7839 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7847 static const char nullstr[] = "(null)";
7849 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7850 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7852 /* Times 4: a decimal digit takes more than 3 binary digits.
7853 * NV_DIG: mantissa takes than many decimal digits.
7854 * Plus 32: Playing safe. */
7855 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7856 /* large enough for "%#.#f" --chip */
7857 /* what about long double NVs? --jhi */
7859 PERL_UNUSED_ARG(maybe_tainted);
7861 /* no matter what, this is a string now */
7862 (void)SvPV_force(sv, origlen);
7864 /* special-case "", "%s", and "%-p" (SVf - see below) */
7867 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7869 const char * const s = va_arg(*args, char*);
7870 sv_catpv(sv, s ? s : nullstr);
7872 else if (svix < svmax) {
7873 sv_catsv(sv, *svargs);
7877 if (args && patlen == 3 && pat[0] == '%' &&
7878 pat[1] == '-' && pat[2] == 'p') {
7879 argsv = va_arg(*args, SV*);
7880 sv_catsv(sv, argsv);
7884 #ifndef USE_LONG_DOUBLE
7885 /* special-case "%.<number>[gf]" */
7886 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7887 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7888 unsigned digits = 0;
7892 while (*pp >= '0' && *pp <= '9')
7893 digits = 10 * digits + (*pp++ - '0');
7894 if (pp - pat == (int)patlen - 1) {
7902 /* Add check for digits != 0 because it seems that some
7903 gconverts are buggy in this case, and we don't yet have
7904 a Configure test for this. */
7905 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7906 /* 0, point, slack */
7907 Gconvert(nv, (int)digits, 0, ebuf);
7909 if (*ebuf) /* May return an empty string for digits==0 */
7912 } else if (!digits) {
7915 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7916 sv_catpvn(sv, p, l);
7922 #endif /* !USE_LONG_DOUBLE */
7924 if (!args && svix < svmax && DO_UTF8(*svargs))
7927 patend = (char*)pat + patlen;
7928 for (p = (char*)pat; p < patend; p = q) {
7931 bool vectorize = FALSE;
7932 bool vectorarg = FALSE;
7933 bool vec_utf8 = FALSE;
7939 bool has_precis = FALSE;
7941 const I32 osvix = svix;
7942 bool is_utf8 = FALSE; /* is this item utf8? */
7943 #ifdef HAS_LDBL_SPRINTF_BUG
7944 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7945 with sfio - Allen <allens@cpan.org> */
7946 bool fix_ldbl_sprintf_bug = FALSE;
7950 U8 utf8buf[UTF8_MAXBYTES+1];
7951 STRLEN esignlen = 0;
7953 const char *eptr = Nullch;
7956 const U8 *vecstr = Null(U8*);
7963 /* we need a long double target in case HAS_LONG_DOUBLE but
7966 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7974 const char *dotstr = ".";
7975 STRLEN dotstrlen = 1;
7976 I32 efix = 0; /* explicit format parameter index */
7977 I32 ewix = 0; /* explicit width index */
7978 I32 epix = 0; /* explicit precision index */
7979 I32 evix = 0; /* explicit vector index */
7980 bool asterisk = FALSE;
7982 /* echo everything up to the next format specification */
7983 for (q = p; q < patend && *q != '%'; ++q) ;
7985 if (has_utf8 && !pat_utf8)
7986 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7988 sv_catpvn(sv, p, q - p);
7995 We allow format specification elements in this order:
7996 \d+\$ explicit format parameter index
7998 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7999 0 flag (as above): repeated to allow "v02"
8000 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8001 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8003 [%bcdefginopsuxDFOUX] format (mandatory)
8008 As of perl5.9.3, printf format checking is on by default.
8009 Internally, perl uses %p formats to provide an escape to
8010 some extended formatting. This block deals with those
8011 extensions: if it does not match, (char*)q is reset and
8012 the normal format processing code is used.
8014 Currently defined extensions are:
8015 %p include pointer address (standard)
8016 %-p (SVf) include an SV (previously %_)
8017 %-<num>p include an SV with precision <num>
8018 %1p (VDf) include a v-string (as %vd)
8019 %<num>p reserved for future extensions
8021 Robin Barker 2005-07-14
8028 n = expect_number(&q);
8035 argsv = va_arg(*args, SV*);
8036 eptr = SvPVx_const(argsv, elen);
8042 else if (n == vdNUMBER) { /* VDf */
8049 if (ckWARN_d(WARN_INTERNAL))
8050 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8051 "internal %%<num>p might conflict with future printf extensions");
8057 if ( (width = expect_number(&q)) ) {
8098 if ( (ewix = expect_number(&q)) )
8107 if ((vectorarg = asterisk)) {
8120 width = expect_number(&q);
8126 vecsv = va_arg(*args, SV*);
8128 vecsv = (evix > 0 && evix <= svmax)
8129 ? svargs[evix-1] : &PL_sv_undef;
8131 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8133 dotstr = SvPV_const(vecsv, dotstrlen);
8134 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8135 bad with tied or overloaded values that return UTF8. */
8138 else if (has_utf8) {
8139 vecsv = sv_mortalcopy(vecsv);
8140 sv_utf8_upgrade(vecsv);
8141 dotstr = SvPV_const(vecsv, dotstrlen);
8148 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8149 vecsv = svargs[efix ? efix-1 : svix++];
8150 vecstr = (U8*)SvPV_const(vecsv,veclen);
8151 vec_utf8 = DO_UTF8(vecsv);
8153 /* if this is a version object, we need to convert
8154 * back into v-string notation and then let the
8155 * vectorize happen normally
8157 if (sv_derived_from(vecsv, "version")) {
8158 char *version = savesvpv(vecsv);
8159 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8160 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8161 "vector argument not supported with alpha versions");
8164 vecsv = sv_newmortal();
8165 /* scan_vstring is expected to be called during
8166 * tokenization, so we need to fake up the end
8167 * of the buffer for it
8169 PL_bufend = version + veclen;
8170 scan_vstring(version, vecsv);
8171 vecstr = (U8*)SvPV_const(vecsv, veclen);
8172 vec_utf8 = DO_UTF8(vecsv);
8184 i = va_arg(*args, int);
8186 i = (ewix ? ewix <= svmax : svix < svmax) ?
8187 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8189 width = (i < 0) ? -i : i;
8199 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8201 /* XXX: todo, support specified precision parameter */
8205 i = va_arg(*args, int);
8207 i = (ewix ? ewix <= svmax : svix < svmax)
8208 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8209 precis = (i < 0) ? 0 : i;
8214 precis = precis * 10 + (*q++ - '0');
8223 case 'I': /* Ix, I32x, and I64x */
8225 if (q[1] == '6' && q[2] == '4') {
8231 if (q[1] == '3' && q[2] == '2') {
8241 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8252 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8253 if (*(q + 1) == 'l') { /* lld, llf */
8279 if (!vectorize && !args) {
8281 const I32 i = efix-1;
8282 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8284 argsv = (svix >= 0 && svix < svmax)
8285 ? svargs[svix++] : &PL_sv_undef;
8296 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8298 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8300 eptr = (char*)utf8buf;
8301 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8315 eptr = va_arg(*args, char*);
8317 #ifdef MACOS_TRADITIONAL
8318 /* On MacOS, %#s format is used for Pascal strings */
8323 elen = strlen(eptr);
8325 eptr = (char *)nullstr;
8326 elen = sizeof nullstr - 1;
8330 eptr = SvPVx_const(argsv, elen);
8331 if (DO_UTF8(argsv)) {
8332 if (has_precis && precis < elen) {
8334 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8337 if (width) { /* fudge width (can't fudge elen) */
8338 width += elen - sv_len_utf8(argsv);
8345 if (has_precis && elen > precis)
8352 if (alt || vectorize)
8354 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8375 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8384 esignbuf[esignlen++] = plus;
8388 case 'h': iv = (short)va_arg(*args, int); break;
8389 case 'l': iv = va_arg(*args, long); break;
8390 case 'V': iv = va_arg(*args, IV); break;
8391 default: iv = va_arg(*args, int); break;
8393 case 'q': iv = va_arg(*args, Quad_t); break;
8398 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8400 case 'h': iv = (short)tiv; break;
8401 case 'l': iv = (long)tiv; break;
8403 default: iv = tiv; break;
8405 case 'q': iv = (Quad_t)tiv; break;
8409 if ( !vectorize ) /* we already set uv above */
8414 esignbuf[esignlen++] = plus;
8418 esignbuf[esignlen++] = '-';
8461 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8472 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8473 case 'l': uv = va_arg(*args, unsigned long); break;
8474 case 'V': uv = va_arg(*args, UV); break;
8475 default: uv = va_arg(*args, unsigned); break;
8477 case 'q': uv = va_arg(*args, Uquad_t); break;
8482 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8484 case 'h': uv = (unsigned short)tuv; break;
8485 case 'l': uv = (unsigned long)tuv; break;
8487 default: uv = tuv; break;
8489 case 'q': uv = (Uquad_t)tuv; break;
8496 char *ptr = ebuf + sizeof ebuf;
8502 p = (char*)((c == 'X')
8503 ? "0123456789ABCDEF" : "0123456789abcdef");
8509 esignbuf[esignlen++] = '0';
8510 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8518 if (alt && *ptr != '0')
8529 esignbuf[esignlen++] = '0';
8530 esignbuf[esignlen++] = 'b';
8533 default: /* it had better be ten or less */
8537 } while (uv /= base);
8540 elen = (ebuf + sizeof ebuf) - ptr;
8544 zeros = precis - elen;
8545 else if (precis == 0 && elen == 1 && *eptr == '0')
8551 /* FLOATING POINT */
8554 c = 'f'; /* maybe %F isn't supported here */
8562 /* This is evil, but floating point is even more evil */
8564 /* for SV-style calling, we can only get NV
8565 for C-style calling, we assume %f is double;
8566 for simplicity we allow any of %Lf, %llf, %qf for long double
8570 #if defined(USE_LONG_DOUBLE)
8574 /* [perl #20339] - we should accept and ignore %lf rather than die */
8578 #if defined(USE_LONG_DOUBLE)
8579 intsize = args ? 0 : 'q';
8583 #if defined(HAS_LONG_DOUBLE)
8592 /* now we need (long double) if intsize == 'q', else (double) */
8594 #if LONG_DOUBLESIZE > DOUBLESIZE
8596 va_arg(*args, long double) :
8597 va_arg(*args, double)
8599 va_arg(*args, double)
8604 if (c != 'e' && c != 'E') {
8606 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8607 will cast our (long double) to (double) */
8608 (void)Perl_frexp(nv, &i);
8609 if (i == PERL_INT_MIN)
8610 Perl_die(aTHX_ "panic: frexp");
8612 need = BIT_DIGITS(i);
8614 need += has_precis ? precis : 6; /* known default */
8619 #ifdef HAS_LDBL_SPRINTF_BUG
8620 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8621 with sfio - Allen <allens@cpan.org> */
8624 # define MY_DBL_MAX DBL_MAX
8625 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8626 # if DOUBLESIZE >= 8
8627 # define MY_DBL_MAX 1.7976931348623157E+308L
8629 # define MY_DBL_MAX 3.40282347E+38L
8633 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8634 # define MY_DBL_MAX_BUG 1L
8636 # define MY_DBL_MAX_BUG MY_DBL_MAX
8640 # define MY_DBL_MIN DBL_MIN
8641 # else /* XXX guessing! -Allen */
8642 # if DOUBLESIZE >= 8
8643 # define MY_DBL_MIN 2.2250738585072014E-308L
8645 # define MY_DBL_MIN 1.17549435E-38L
8649 if ((intsize == 'q') && (c == 'f') &&
8650 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8652 /* it's going to be short enough that
8653 * long double precision is not needed */
8655 if ((nv <= 0L) && (nv >= -0L))
8656 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8658 /* would use Perl_fp_class as a double-check but not
8659 * functional on IRIX - see perl.h comments */
8661 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8662 /* It's within the range that a double can represent */
8663 #if defined(DBL_MAX) && !defined(DBL_MIN)
8664 if ((nv >= ((long double)1/DBL_MAX)) ||
8665 (nv <= (-(long double)1/DBL_MAX)))
8667 fix_ldbl_sprintf_bug = TRUE;
8670 if (fix_ldbl_sprintf_bug == TRUE) {
8680 # undef MY_DBL_MAX_BUG
8683 #endif /* HAS_LDBL_SPRINTF_BUG */
8685 need += 20; /* fudge factor */
8686 if (PL_efloatsize < need) {
8687 Safefree(PL_efloatbuf);
8688 PL_efloatsize = need + 20; /* more fudge */
8689 Newx(PL_efloatbuf, PL_efloatsize, char);
8690 PL_efloatbuf[0] = '\0';
8693 if ( !(width || left || plus || alt) && fill != '0'
8694 && has_precis && intsize != 'q' ) { /* Shortcuts */
8695 /* See earlier comment about buggy Gconvert when digits,
8697 if ( c == 'g' && precis) {
8698 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8699 /* May return an empty string for digits==0 */
8700 if (*PL_efloatbuf) {
8701 elen = strlen(PL_efloatbuf);
8702 goto float_converted;
8704 } else if ( c == 'f' && !precis) {
8705 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8710 char *ptr = ebuf + sizeof ebuf;
8713 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8714 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8715 if (intsize == 'q') {
8716 /* Copy the one or more characters in a long double
8717 * format before the 'base' ([efgEFG]) character to
8718 * the format string. */
8719 static char const prifldbl[] = PERL_PRIfldbl;
8720 char const *p = prifldbl + sizeof(prifldbl) - 3;
8721 while (p >= prifldbl) { *--ptr = *p--; }
8726 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8731 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8743 /* No taint. Otherwise we are in the strange situation
8744 * where printf() taints but print($float) doesn't.
8746 #if defined(HAS_LONG_DOUBLE)
8747 elen = ((intsize == 'q')
8748 ? my_sprintf(PL_efloatbuf, ptr, nv)
8749 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8751 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8755 eptr = PL_efloatbuf;
8763 i = SvCUR(sv) - origlen;
8766 case 'h': *(va_arg(*args, short*)) = i; break;
8767 default: *(va_arg(*args, int*)) = i; break;
8768 case 'l': *(va_arg(*args, long*)) = i; break;
8769 case 'V': *(va_arg(*args, IV*)) = i; break;
8771 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8776 sv_setuv_mg(argsv, (UV)i);
8777 continue; /* not "break" */
8784 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8785 && ckWARN(WARN_PRINTF))
8787 SV * const msg = sv_newmortal();
8788 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8789 (PL_op->op_type == OP_PRTF) ? "" : "s");
8792 Perl_sv_catpvf(aTHX_ msg,
8793 "\"%%%c\"", c & 0xFF);
8795 Perl_sv_catpvf(aTHX_ msg,
8796 "\"%%\\%03"UVof"\"",
8799 sv_catpvs(msg, "end of string");
8800 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8803 /* output mangled stuff ... */
8809 /* ... right here, because formatting flags should not apply */
8810 SvGROW(sv, SvCUR(sv) + elen + 1);
8812 Copy(eptr, p, elen, char);
8815 SvCUR_set(sv, p - SvPVX_const(sv));
8817 continue; /* not "break" */
8820 /* calculate width before utf8_upgrade changes it */
8821 have = esignlen + zeros + elen;
8823 Perl_croak_nocontext(PL_memory_wrap);
8825 if (is_utf8 != has_utf8) {
8828 sv_utf8_upgrade(sv);
8831 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8832 sv_utf8_upgrade(nsv);
8833 eptr = SvPVX_const(nsv);
8836 SvGROW(sv, SvCUR(sv) + elen + 1);
8841 need = (have > width ? have : width);
8844 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8845 Perl_croak_nocontext(PL_memory_wrap);
8846 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8848 if (esignlen && fill == '0') {
8850 for (i = 0; i < (int)esignlen; i++)
8854 memset(p, fill, gap);
8857 if (esignlen && fill != '0') {
8859 for (i = 0; i < (int)esignlen; i++)
8864 for (i = zeros; i; i--)
8868 Copy(eptr, p, elen, char);
8872 memset(p, ' ', gap);
8877 Copy(dotstr, p, dotstrlen, char);
8881 vectorize = FALSE; /* done iterating over vecstr */
8888 SvCUR_set(sv, p - SvPVX_const(sv));
8896 /* =========================================================================
8898 =head1 Cloning an interpreter
8900 All the macros and functions in this section are for the private use of
8901 the main function, perl_clone().
8903 The foo_dup() functions make an exact copy of an existing foo thinngy.
8904 During the course of a cloning, a hash table is used to map old addresses
8905 to new addresses. The table is created and manipulated with the
8906 ptr_table_* functions.
8910 ============================================================================*/
8913 #if defined(USE_ITHREADS)
8915 #ifndef GpREFCNT_inc
8916 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8920 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8921 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8922 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8923 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8924 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8925 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8926 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8927 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8928 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8929 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8930 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8931 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8932 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8935 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8936 regcomp.c. AMS 20010712 */
8939 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8944 struct reg_substr_datum *s;
8947 return (REGEXP *)NULL;
8949 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8952 len = r->offsets[0];
8953 npar = r->nparens+1;
8955 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8956 Copy(r->program, ret->program, len+1, regnode);
8958 Newx(ret->startp, npar, I32);
8959 Copy(r->startp, ret->startp, npar, I32);
8960 Newx(ret->endp, npar, I32);
8961 Copy(r->startp, ret->startp, npar, I32);
8963 Newx(ret->substrs, 1, struct reg_substr_data);
8964 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8965 s->min_offset = r->substrs->data[i].min_offset;
8966 s->max_offset = r->substrs->data[i].max_offset;
8967 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8968 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8971 ret->regstclass = NULL;
8974 const int count = r->data->count;
8977 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8978 char, struct reg_data);
8979 Newx(d->what, count, U8);
8982 for (i = 0; i < count; i++) {
8983 d->what[i] = r->data->what[i];
8984 switch (d->what[i]) {
8985 /* legal options are one of: sfpont
8986 see also regcomp.h and pregfree() */
8988 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8991 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8994 /* This is cheating. */
8995 Newx(d->data[i], 1, struct regnode_charclass_class);
8996 StructCopy(r->data->data[i], d->data[i],
8997 struct regnode_charclass_class);
8998 ret->regstclass = (regnode*)d->data[i];
9001 /* Compiled op trees are readonly, and can thus be
9002 shared without duplication. */
9004 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9008 d->data[i] = r->data->data[i];
9011 d->data[i] = r->data->data[i];
9013 ((reg_trie_data*)d->data[i])->refcount++;
9017 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9026 Newx(ret->offsets, 2*len+1, U32);
9027 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9029 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9030 ret->refcnt = r->refcnt;
9031 ret->minlen = r->minlen;
9032 ret->prelen = r->prelen;
9033 ret->nparens = r->nparens;
9034 ret->lastparen = r->lastparen;
9035 ret->lastcloseparen = r->lastcloseparen;
9036 ret->reganch = r->reganch;
9038 ret->sublen = r->sublen;
9040 if (RX_MATCH_COPIED(ret))
9041 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9043 ret->subbeg = Nullch;
9044 #ifdef PERL_OLD_COPY_ON_WRITE
9045 ret->saved_copy = Nullsv;
9048 ptr_table_store(PL_ptr_table, r, ret);
9052 /* duplicate a file handle */
9055 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9059 PERL_UNUSED_ARG(type);
9062 return (PerlIO*)NULL;
9064 /* look for it in the table first */
9065 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9069 /* create anew and remember what it is */
9070 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9071 ptr_table_store(PL_ptr_table, fp, ret);
9075 /* duplicate a directory handle */
9078 Perl_dirp_dup(pTHX_ DIR *dp)
9086 /* duplicate a typeglob */
9089 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9094 /* look for it in the table first */
9095 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9099 /* create anew and remember what it is */
9101 ptr_table_store(PL_ptr_table, gp, ret);
9104 ret->gp_refcnt = 0; /* must be before any other dups! */
9105 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9106 ret->gp_io = io_dup_inc(gp->gp_io, param);
9107 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9108 ret->gp_av = av_dup_inc(gp->gp_av, param);
9109 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9110 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9111 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9112 ret->gp_cvgen = gp->gp_cvgen;
9113 ret->gp_line = gp->gp_line;
9114 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9118 /* duplicate a chain of magic */
9121 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9123 MAGIC *mgprev = (MAGIC*)NULL;
9126 return (MAGIC*)NULL;
9127 /* look for it in the table first */
9128 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9132 for (; mg; mg = mg->mg_moremagic) {
9134 Newxz(nmg, 1, MAGIC);
9136 mgprev->mg_moremagic = nmg;
9139 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9140 nmg->mg_private = mg->mg_private;
9141 nmg->mg_type = mg->mg_type;
9142 nmg->mg_flags = mg->mg_flags;
9143 if (mg->mg_type == PERL_MAGIC_qr) {
9144 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9146 else if(mg->mg_type == PERL_MAGIC_backref) {
9147 /* The backref AV has its reference count deliberately bumped by
9149 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9151 else if (mg->mg_type == PERL_MAGIC_symtab) {
9152 nmg->mg_obj = mg->mg_obj;
9155 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9156 ? sv_dup_inc(mg->mg_obj, param)
9157 : sv_dup(mg->mg_obj, param);
9159 nmg->mg_len = mg->mg_len;
9160 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9161 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9162 if (mg->mg_len > 0) {
9163 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9164 if (mg->mg_type == PERL_MAGIC_overload_table &&
9165 AMT_AMAGIC((AMT*)mg->mg_ptr))
9167 const AMT * const amtp = (AMT*)mg->mg_ptr;
9168 AMT * const namtp = (AMT*)nmg->mg_ptr;
9170 for (i = 1; i < NofAMmeth; i++) {
9171 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9175 else if (mg->mg_len == HEf_SVKEY)
9176 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9178 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9179 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9186 /* create a new pointer-mapping table */
9189 Perl_ptr_table_new(pTHX)
9192 Newxz(tbl, 1, PTR_TBL_t);
9195 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9199 #define PTR_TABLE_HASH(ptr) \
9200 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9203 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9204 following define) and at call to new_body_inline made below in
9205 Perl_ptr_table_store()
9208 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9210 /* map an existing pointer using a table */
9212 STATIC PTR_TBL_ENT_t *
9213 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9214 PTR_TBL_ENT_t *tblent;
9215 const UV hash = PTR_TABLE_HASH(sv);
9217 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9218 for (; tblent; tblent = tblent->next) {
9219 if (tblent->oldval == sv)
9226 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9228 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9229 return tblent ? tblent->newval : (void *) 0;
9232 /* add a new entry to a pointer-mapping table */
9235 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9237 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9240 tblent->newval = newsv;
9242 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9244 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9245 tblent->oldval = oldsv;
9246 tblent->newval = newsv;
9247 tblent->next = tbl->tbl_ary[entry];
9248 tbl->tbl_ary[entry] = tblent;
9250 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9251 ptr_table_split(tbl);
9255 /* double the hash bucket size of an existing ptr table */
9258 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9260 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9261 const UV oldsize = tbl->tbl_max + 1;
9262 UV newsize = oldsize * 2;
9265 Renew(ary, newsize, PTR_TBL_ENT_t*);
9266 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9267 tbl->tbl_max = --newsize;
9269 for (i=0; i < oldsize; i++, ary++) {
9270 PTR_TBL_ENT_t **curentp, **entp, *ent;
9273 curentp = ary + oldsize;
9274 for (entp = ary, ent = *ary; ent; ent = *entp) {
9275 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9277 ent->next = *curentp;
9287 /* remove all the entries from a ptr table */
9290 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9292 if (tbl && tbl->tbl_items) {
9293 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9294 UV riter = tbl->tbl_max;
9297 PTR_TBL_ENT_t *entry = array[riter];
9300 PTR_TBL_ENT_t * const oentry = entry;
9301 entry = entry->next;
9310 /* clear and free a ptr table */
9313 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9318 ptr_table_clear(tbl);
9319 Safefree(tbl->tbl_ary);
9325 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9328 SvRV_set(dstr, SvWEAKREF(sstr)
9329 ? sv_dup(SvRV(sstr), param)
9330 : sv_dup_inc(SvRV(sstr), param));
9333 else if (SvPVX_const(sstr)) {
9334 /* Has something there */
9336 /* Normal PV - clone whole allocated space */
9337 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9338 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9339 /* Not that normal - actually sstr is copy on write.
9340 But we are a true, independant SV, so: */
9341 SvREADONLY_off(dstr);
9346 /* Special case - not normally malloced for some reason */
9347 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9348 /* A "shared" PV - clone it as "shared" PV */
9350 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9354 /* Some other special case - random pointer */
9355 SvPV_set(dstr, SvPVX(sstr));
9361 if (SvTYPE(dstr) == SVt_RV)
9362 SvRV_set(dstr, NULL);
9364 SvPV_set(dstr, NULL);
9368 /* duplicate an SV of any type (including AV, HV etc) */
9371 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9376 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9378 /* look for it in the table first */
9379 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9383 if(param->flags & CLONEf_JOIN_IN) {
9384 /** We are joining here so we don't want do clone
9385 something that is bad **/
9386 if (SvTYPE(sstr) == SVt_PVHV) {
9387 const char * const hvname = HvNAME_get(sstr);
9389 /** don't clone stashes if they already exist **/
9390 return (SV*)gv_stashpv(hvname,0);
9394 /* create anew and remember what it is */
9397 #ifdef DEBUG_LEAKING_SCALARS
9398 dstr->sv_debug_optype = sstr->sv_debug_optype;
9399 dstr->sv_debug_line = sstr->sv_debug_line;
9400 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9401 dstr->sv_debug_cloned = 1;
9402 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9405 ptr_table_store(PL_ptr_table, sstr, dstr);
9408 SvFLAGS(dstr) = SvFLAGS(sstr);
9409 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9410 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9413 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9414 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9415 PL_watch_pvx, SvPVX_const(sstr));
9418 /* don't clone objects whose class has asked us not to */
9419 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9420 SvFLAGS(dstr) &= ~SVTYPEMASK;
9425 switch (SvTYPE(sstr)) {
9430 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9431 SvIV_set(dstr, SvIVX(sstr));
9434 SvANY(dstr) = new_XNV();
9435 SvNV_set(dstr, SvNVX(sstr));
9438 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9439 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9443 /* These are all the types that need complex bodies allocating. */
9445 const svtype sv_type = SvTYPE(sstr);
9446 const struct body_details *const sv_type_details
9447 = bodies_by_type + sv_type;
9451 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9456 if (GvUNIQUE((GV*)sstr)) {
9457 /* Do sharing here, and fall through */
9470 assert(sv_type_details->size);
9471 if (sv_type_details->arena) {
9472 new_body_inline(new_body, sv_type_details->size, sv_type);
9474 = (void*)((char*)new_body - sv_type_details->offset);
9476 new_body = new_NOARENA(sv_type_details);
9480 SvANY(dstr) = new_body;
9483 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9484 ((char*)SvANY(dstr)) + sv_type_details->offset,
9485 sv_type_details->copy, char);
9487 Copy(((char*)SvANY(sstr)),
9488 ((char*)SvANY(dstr)),
9489 sv_type_details->size + sv_type_details->offset, char);
9492 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9493 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9495 /* The Copy above means that all the source (unduplicated) pointers
9496 are now in the destination. We can check the flags and the
9497 pointers in either, but it's possible that there's less cache
9498 missing by always going for the destination.
9499 FIXME - instrument and check that assumption */
9500 if (sv_type >= SVt_PVMG) {
9502 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9504 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9507 /* The cast silences a GCC warning about unhandled types. */
9508 switch ((int)sv_type) {
9520 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9521 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9522 LvTARG(dstr) = dstr;
9523 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9524 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9526 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9529 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9530 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9531 /* Don't call sv_add_backref here as it's going to be created
9532 as part of the magic cloning of the symbol table. */
9533 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9534 (void)GpREFCNT_inc(GvGP(dstr));
9537 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9538 if (IoOFP(dstr) == IoIFP(sstr))
9539 IoOFP(dstr) = IoIFP(dstr);
9541 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9542 /* PL_rsfp_filters entries have fake IoDIRP() */
9543 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9544 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9545 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9546 /* I have no idea why fake dirp (rsfps)
9547 should be treated differently but otherwise
9548 we end up with leaks -- sky*/
9549 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9550 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9551 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9553 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9554 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9555 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9557 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9558 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9559 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9562 if (AvARRAY((AV*)sstr)) {
9563 SV **dst_ary, **src_ary;
9564 SSize_t items = AvFILLp((AV*)sstr) + 1;
9566 src_ary = AvARRAY((AV*)sstr);
9567 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9568 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9569 SvPV_set(dstr, (char*)dst_ary);
9570 AvALLOC((AV*)dstr) = dst_ary;
9571 if (AvREAL((AV*)sstr)) {
9573 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9577 *dst_ary++ = sv_dup(*src_ary++, param);
9579 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9580 while (items-- > 0) {
9581 *dst_ary++ = &PL_sv_undef;
9585 SvPV_set(dstr, Nullch);
9586 AvALLOC((AV*)dstr) = (SV**)NULL;
9593 if (HvARRAY((HV*)sstr)) {
9595 const bool sharekeys = !!HvSHAREKEYS(sstr);
9596 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9597 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9599 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9600 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9602 HvARRAY(dstr) = (HE**)darray;
9603 while (i <= sxhv->xhv_max) {
9604 const HE *source = HvARRAY(sstr)[i];
9605 HvARRAY(dstr)[i] = source
9606 ? he_dup(source, sharekeys, param) : 0;
9610 struct xpvhv_aux * const saux = HvAUX(sstr);
9611 struct xpvhv_aux * const daux = HvAUX(dstr);
9612 /* This flag isn't copied. */
9613 /* SvOOK_on(hv) attacks the IV flags. */
9614 SvFLAGS(dstr) |= SVf_OOK;
9616 hvname = saux->xhv_name;
9618 = hvname ? hek_dup(hvname, param) : hvname;
9620 daux->xhv_riter = saux->xhv_riter;
9621 daux->xhv_eiter = saux->xhv_eiter
9622 ? he_dup(saux->xhv_eiter,
9623 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9624 daux->xhv_backreferences = saux->xhv_backreferences
9625 ? (AV*) SvREFCNT_inc(
9633 SvPV_set(dstr, Nullch);
9635 /* Record stashes for possible cloning in Perl_clone(). */
9637 av_push(param->stashes, dstr);
9642 /* NOTE: not refcounted */
9643 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9645 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9647 if (CvCONST(dstr)) {
9648 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9649 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9650 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9652 /* don't dup if copying back - CvGV isn't refcounted, so the
9653 * duped GV may never be freed. A bit of a hack! DAPM */
9654 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9655 Nullgv : gv_dup(CvGV(dstr), param) ;
9656 if (!(param->flags & CLONEf_COPY_STACKS)) {
9659 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9662 ? cv_dup( CvOUTSIDE(dstr), param)
9663 : cv_dup_inc(CvOUTSIDE(dstr), param);
9665 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9671 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9677 /* duplicate a context */
9680 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9685 return (PERL_CONTEXT*)NULL;
9687 /* look for it in the table first */
9688 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9692 /* create anew and remember what it is */
9693 Newxz(ncxs, max + 1, PERL_CONTEXT);
9694 ptr_table_store(PL_ptr_table, cxs, ncxs);
9697 PERL_CONTEXT * const cx = &cxs[ix];
9698 PERL_CONTEXT * const ncx = &ncxs[ix];
9699 ncx->cx_type = cx->cx_type;
9700 if (CxTYPE(cx) == CXt_SUBST) {
9701 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9704 ncx->blk_oldsp = cx->blk_oldsp;
9705 ncx->blk_oldcop = cx->blk_oldcop;
9706 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9707 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9708 ncx->blk_oldpm = cx->blk_oldpm;
9709 ncx->blk_gimme = cx->blk_gimme;
9710 switch (CxTYPE(cx)) {
9712 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9713 ? cv_dup_inc(cx->blk_sub.cv, param)
9714 : cv_dup(cx->blk_sub.cv,param));
9715 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9716 ? av_dup_inc(cx->blk_sub.argarray, param)
9718 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9719 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9720 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9721 ncx->blk_sub.lval = cx->blk_sub.lval;
9722 ncx->blk_sub.retop = cx->blk_sub.retop;
9725 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9726 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9727 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9728 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9729 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9730 ncx->blk_eval.retop = cx->blk_eval.retop;
9733 ncx->blk_loop.label = cx->blk_loop.label;
9734 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9735 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9736 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9737 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9738 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9739 ? cx->blk_loop.iterdata
9740 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9741 ncx->blk_loop.oldcomppad
9742 = (PAD*)ptr_table_fetch(PL_ptr_table,
9743 cx->blk_loop.oldcomppad);
9744 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9745 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9746 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9747 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9748 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9751 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9752 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9753 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9754 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9755 ncx->blk_sub.retop = cx->blk_sub.retop;
9767 /* duplicate a stack info structure */
9770 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9775 return (PERL_SI*)NULL;
9777 /* look for it in the table first */
9778 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9782 /* create anew and remember what it is */
9783 Newxz(nsi, 1, PERL_SI);
9784 ptr_table_store(PL_ptr_table, si, nsi);
9786 nsi->si_stack = av_dup_inc(si->si_stack, param);
9787 nsi->si_cxix = si->si_cxix;
9788 nsi->si_cxmax = si->si_cxmax;
9789 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9790 nsi->si_type = si->si_type;
9791 nsi->si_prev = si_dup(si->si_prev, param);
9792 nsi->si_next = si_dup(si->si_next, param);
9793 nsi->si_markoff = si->si_markoff;
9798 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9799 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9800 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9801 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9802 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9803 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9804 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9805 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9806 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9807 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9808 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9809 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9810 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9811 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9814 #define pv_dup_inc(p) SAVEPV(p)
9815 #define pv_dup(p) SAVEPV(p)
9816 #define svp_dup_inc(p,pp) any_dup(p,pp)
9818 /* map any object to the new equivent - either something in the
9819 * ptr table, or something in the interpreter structure
9823 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9830 /* look for it in the table first */
9831 ret = ptr_table_fetch(PL_ptr_table, v);
9835 /* see if it is part of the interpreter structure */
9836 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9837 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9845 /* duplicate the save stack */
9848 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9850 ANY * const ss = proto_perl->Tsavestack;
9851 const I32 max = proto_perl->Tsavestack_max;
9852 I32 ix = proto_perl->Tsavestack_ix;
9864 void (*dptr) (void*);
9865 void (*dxptr) (pTHX_ void*);
9867 Newxz(nss, max, ANY);
9870 I32 i = POPINT(ss,ix);
9873 case SAVEt_ITEM: /* normal string */
9874 sv = (SV*)POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9876 sv = (SV*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9879 case SAVEt_SV: /* scalar reference */
9880 sv = (SV*)POPPTR(ss,ix);
9881 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9882 gv = (GV*)POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9885 case SAVEt_GENERIC_PVREF: /* generic char* */
9886 c = (char*)POPPTR(ss,ix);
9887 TOPPTR(nss,ix) = pv_dup(c);
9888 ptr = POPPTR(ss,ix);
9889 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9891 case SAVEt_SHARED_PVREF: /* char* in shared space */
9892 c = (char*)POPPTR(ss,ix);
9893 TOPPTR(nss,ix) = savesharedpv(c);
9894 ptr = POPPTR(ss,ix);
9895 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9897 case SAVEt_GENERIC_SVREF: /* generic sv */
9898 case SAVEt_SVREF: /* scalar reference */
9899 sv = (SV*)POPPTR(ss,ix);
9900 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9901 ptr = POPPTR(ss,ix);
9902 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9904 case SAVEt_AV: /* array reference */
9905 av = (AV*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = av_dup_inc(av, param);
9907 gv = (GV*)POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = gv_dup(gv, param);
9910 case SAVEt_HV: /* hash reference */
9911 hv = (HV*)POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9913 gv = (GV*)POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = gv_dup(gv, param);
9916 case SAVEt_INT: /* int reference */
9917 ptr = POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9919 intval = (int)POPINT(ss,ix);
9920 TOPINT(nss,ix) = intval;
9922 case SAVEt_LONG: /* long reference */
9923 ptr = POPPTR(ss,ix);
9924 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9925 longval = (long)POPLONG(ss,ix);
9926 TOPLONG(nss,ix) = longval;
9928 case SAVEt_I32: /* I32 reference */
9929 case SAVEt_I16: /* I16 reference */
9930 case SAVEt_I8: /* I8 reference */
9931 ptr = POPPTR(ss,ix);
9932 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9936 case SAVEt_IV: /* IV reference */
9937 ptr = POPPTR(ss,ix);
9938 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9942 case SAVEt_SPTR: /* SV* reference */
9943 ptr = POPPTR(ss,ix);
9944 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9945 sv = (SV*)POPPTR(ss,ix);
9946 TOPPTR(nss,ix) = sv_dup(sv, param);
9948 case SAVEt_VPTR: /* random* reference */
9949 ptr = POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9951 ptr = POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9954 case SAVEt_PPTR: /* char* reference */
9955 ptr = POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9957 c = (char*)POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = pv_dup(c);
9960 case SAVEt_HPTR: /* HV* reference */
9961 ptr = POPPTR(ss,ix);
9962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9963 hv = (HV*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = hv_dup(hv, param);
9966 case SAVEt_APTR: /* AV* reference */
9967 ptr = POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9969 av = (AV*)POPPTR(ss,ix);
9970 TOPPTR(nss,ix) = av_dup(av, param);
9973 gv = (GV*)POPPTR(ss,ix);
9974 TOPPTR(nss,ix) = gv_dup(gv, param);
9976 case SAVEt_GP: /* scalar reference */
9977 gp = (GP*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9979 (void)GpREFCNT_inc(gp);
9980 gv = (GV*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9982 c = (char*)POPPTR(ss,ix);
9983 TOPPTR(nss,ix) = pv_dup(c);
9990 case SAVEt_MORTALIZESV:
9991 sv = (SV*)POPPTR(ss,ix);
9992 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9995 ptr = POPPTR(ss,ix);
9996 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9997 /* these are assumed to be refcounted properly */
9999 switch (((OP*)ptr)->op_type) {
10001 case OP_LEAVESUBLV:
10005 case OP_LEAVEWRITE:
10006 TOPPTR(nss,ix) = ptr;
10011 TOPPTR(nss,ix) = Nullop;
10016 TOPPTR(nss,ix) = Nullop;
10019 c = (char*)POPPTR(ss,ix);
10020 TOPPTR(nss,ix) = pv_dup_inc(c);
10022 case SAVEt_CLEARSV:
10023 longval = POPLONG(ss,ix);
10024 TOPLONG(nss,ix) = longval;
10027 hv = (HV*)POPPTR(ss,ix);
10028 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10029 c = (char*)POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = pv_dup_inc(c);
10032 TOPINT(nss,ix) = i;
10034 case SAVEt_DESTRUCTOR:
10035 ptr = POPPTR(ss,ix);
10036 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10037 dptr = POPDPTR(ss,ix);
10038 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10039 any_dup(FPTR2DPTR(void *, dptr),
10042 case SAVEt_DESTRUCTOR_X:
10043 ptr = POPPTR(ss,ix);
10044 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10045 dxptr = POPDXPTR(ss,ix);
10046 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10047 any_dup(FPTR2DPTR(void *, dxptr),
10050 case SAVEt_REGCONTEXT:
10053 TOPINT(nss,ix) = i;
10056 case SAVEt_STACK_POS: /* Position on Perl stack */
10058 TOPINT(nss,ix) = i;
10060 case SAVEt_AELEM: /* array element */
10061 sv = (SV*)POPPTR(ss,ix);
10062 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10064 TOPINT(nss,ix) = i;
10065 av = (AV*)POPPTR(ss,ix);
10066 TOPPTR(nss,ix) = av_dup_inc(av, param);
10068 case SAVEt_HELEM: /* hash element */
10069 sv = (SV*)POPPTR(ss,ix);
10070 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10071 sv = (SV*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10073 hv = (HV*)POPPTR(ss,ix);
10074 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10077 ptr = POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = ptr;
10082 TOPINT(nss,ix) = i;
10084 case SAVEt_COMPPAD:
10085 av = (AV*)POPPTR(ss,ix);
10086 TOPPTR(nss,ix) = av_dup(av, param);
10089 longval = (long)POPLONG(ss,ix);
10090 TOPLONG(nss,ix) = longval;
10091 ptr = POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10093 sv = (SV*)POPPTR(ss,ix);
10094 TOPPTR(nss,ix) = sv_dup(sv, param);
10097 ptr = POPPTR(ss,ix);
10098 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10099 longval = (long)POPBOOL(ss,ix);
10100 TOPBOOL(nss,ix) = (bool)longval;
10102 case SAVEt_SET_SVFLAGS:
10104 TOPINT(nss,ix) = i;
10106 TOPINT(nss,ix) = i;
10107 sv = (SV*)POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = sv_dup(sv, param);
10111 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10119 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10120 * flag to the result. This is done for each stash before cloning starts,
10121 * so we know which stashes want their objects cloned */
10124 do_mark_cloneable_stash(pTHX_ SV *sv)
10126 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10128 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10129 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10130 if (cloner && GvCV(cloner)) {
10137 XPUSHs(sv_2mortal(newSVhek(hvname)));
10139 call_sv((SV*)GvCV(cloner), G_SCALAR);
10146 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10154 =for apidoc perl_clone
10156 Create and return a new interpreter by cloning the current one.
10158 perl_clone takes these flags as parameters:
10160 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10161 without it we only clone the data and zero the stacks,
10162 with it we copy the stacks and the new perl interpreter is
10163 ready to run at the exact same point as the previous one.
10164 The pseudo-fork code uses COPY_STACKS while the
10165 threads->new doesn't.
10167 CLONEf_KEEP_PTR_TABLE
10168 perl_clone keeps a ptr_table with the pointer of the old
10169 variable as a key and the new variable as a value,
10170 this allows it to check if something has been cloned and not
10171 clone it again but rather just use the value and increase the
10172 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10173 the ptr_table using the function
10174 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10175 reason to keep it around is if you want to dup some of your own
10176 variable who are outside the graph perl scans, example of this
10177 code is in threads.xs create
10180 This is a win32 thing, it is ignored on unix, it tells perls
10181 win32host code (which is c++) to clone itself, this is needed on
10182 win32 if you want to run two threads at the same time,
10183 if you just want to do some stuff in a separate perl interpreter
10184 and then throw it away and return to the original one,
10185 you don't need to do anything.
10190 /* XXX the above needs expanding by someone who actually understands it ! */
10191 EXTERN_C PerlInterpreter *
10192 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10195 perl_clone(PerlInterpreter *proto_perl, UV flags)
10198 #ifdef PERL_IMPLICIT_SYS
10200 /* perlhost.h so we need to call into it
10201 to clone the host, CPerlHost should have a c interface, sky */
10203 if (flags & CLONEf_CLONE_HOST) {
10204 return perl_clone_host(proto_perl,flags);
10206 return perl_clone_using(proto_perl, flags,
10208 proto_perl->IMemShared,
10209 proto_perl->IMemParse,
10211 proto_perl->IStdIO,
10215 proto_perl->IProc);
10219 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10220 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10221 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10222 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10223 struct IPerlDir* ipD, struct IPerlSock* ipS,
10224 struct IPerlProc* ipP)
10226 /* XXX many of the string copies here can be optimized if they're
10227 * constants; they need to be allocated as common memory and just
10228 * their pointers copied. */
10231 CLONE_PARAMS clone_params;
10232 CLONE_PARAMS* param = &clone_params;
10234 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10235 /* for each stash, determine whether its objects should be cloned */
10236 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10237 PERL_SET_THX(my_perl);
10240 Poison(my_perl, 1, PerlInterpreter);
10242 PL_curcop = (COP *)Nullop;
10246 PL_savestack_ix = 0;
10247 PL_savestack_max = -1;
10248 PL_sig_pending = 0;
10249 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10250 # else /* !DEBUGGING */
10251 Zero(my_perl, 1, PerlInterpreter);
10252 # endif /* DEBUGGING */
10254 /* host pointers */
10256 PL_MemShared = ipMS;
10257 PL_MemParse = ipMP;
10264 #else /* !PERL_IMPLICIT_SYS */
10266 CLONE_PARAMS clone_params;
10267 CLONE_PARAMS* param = &clone_params;
10268 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10269 /* for each stash, determine whether its objects should be cloned */
10270 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10271 PERL_SET_THX(my_perl);
10274 Poison(my_perl, 1, PerlInterpreter);
10276 PL_curcop = (COP *)Nullop;
10280 PL_savestack_ix = 0;
10281 PL_savestack_max = -1;
10282 PL_sig_pending = 0;
10283 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10284 # else /* !DEBUGGING */
10285 Zero(my_perl, 1, PerlInterpreter);
10286 # endif /* DEBUGGING */
10287 #endif /* PERL_IMPLICIT_SYS */
10288 param->flags = flags;
10289 param->proto_perl = proto_perl;
10291 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10292 Zero(&PL_body_roots, 1, PL_body_roots);
10294 PL_nice_chunk = NULL;
10295 PL_nice_chunk_size = 0;
10297 PL_sv_objcount = 0;
10298 PL_sv_root = Nullsv;
10299 PL_sv_arenaroot = Nullsv;
10301 PL_debug = proto_perl->Idebug;
10303 PL_hash_seed = proto_perl->Ihash_seed;
10304 PL_rehash_seed = proto_perl->Irehash_seed;
10306 #ifdef USE_REENTRANT_API
10307 /* XXX: things like -Dm will segfault here in perlio, but doing
10308 * PERL_SET_CONTEXT(proto_perl);
10309 * breaks too many other things
10311 Perl_reentrant_init(aTHX);
10314 /* create SV map for pointer relocation */
10315 PL_ptr_table = ptr_table_new();
10317 /* initialize these special pointers as early as possible */
10318 SvANY(&PL_sv_undef) = NULL;
10319 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10320 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10321 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10323 SvANY(&PL_sv_no) = new_XPVNV();
10324 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10325 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10326 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10327 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10328 SvCUR_set(&PL_sv_no, 0);
10329 SvLEN_set(&PL_sv_no, 1);
10330 SvIV_set(&PL_sv_no, 0);
10331 SvNV_set(&PL_sv_no, 0);
10332 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10334 SvANY(&PL_sv_yes) = new_XPVNV();
10335 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10336 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10337 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10338 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10339 SvCUR_set(&PL_sv_yes, 1);
10340 SvLEN_set(&PL_sv_yes, 2);
10341 SvIV_set(&PL_sv_yes, 1);
10342 SvNV_set(&PL_sv_yes, 1);
10343 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10345 /* create (a non-shared!) shared string table */
10346 PL_strtab = newHV();
10347 HvSHAREKEYS_off(PL_strtab);
10348 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10349 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10351 PL_compiling = proto_perl->Icompiling;
10353 /* These two PVs will be free'd special way so must set them same way op.c does */
10354 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10355 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10357 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10358 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10360 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10361 if (!specialWARN(PL_compiling.cop_warnings))
10362 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10363 if (!specialCopIO(PL_compiling.cop_io))
10364 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10365 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10367 /* pseudo environmental stuff */
10368 PL_origargc = proto_perl->Iorigargc;
10369 PL_origargv = proto_perl->Iorigargv;
10371 param->stashes = newAV(); /* Setup array of objects to call clone on */
10373 /* Set tainting stuff before PerlIO_debug can possibly get called */
10374 PL_tainting = proto_perl->Itainting;
10375 PL_taint_warn = proto_perl->Itaint_warn;
10377 #ifdef PERLIO_LAYERS
10378 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10379 PerlIO_clone(aTHX_ proto_perl, param);
10382 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10383 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10384 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10385 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10386 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10387 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10390 PL_minus_c = proto_perl->Iminus_c;
10391 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10392 PL_localpatches = proto_perl->Ilocalpatches;
10393 PL_splitstr = proto_perl->Isplitstr;
10394 PL_preprocess = proto_perl->Ipreprocess;
10395 PL_minus_n = proto_perl->Iminus_n;
10396 PL_minus_p = proto_perl->Iminus_p;
10397 PL_minus_l = proto_perl->Iminus_l;
10398 PL_minus_a = proto_perl->Iminus_a;
10399 PL_minus_E = proto_perl->Iminus_E;
10400 PL_minus_F = proto_perl->Iminus_F;
10401 PL_doswitches = proto_perl->Idoswitches;
10402 PL_dowarn = proto_perl->Idowarn;
10403 PL_doextract = proto_perl->Idoextract;
10404 PL_sawampersand = proto_perl->Isawampersand;
10405 PL_unsafe = proto_perl->Iunsafe;
10406 PL_inplace = SAVEPV(proto_perl->Iinplace);
10407 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10408 PL_perldb = proto_perl->Iperldb;
10409 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10410 PL_exit_flags = proto_perl->Iexit_flags;
10412 /* magical thingies */
10413 /* XXX time(&PL_basetime) when asked for? */
10414 PL_basetime = proto_perl->Ibasetime;
10415 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10417 PL_maxsysfd = proto_perl->Imaxsysfd;
10418 PL_multiline = proto_perl->Imultiline;
10419 PL_statusvalue = proto_perl->Istatusvalue;
10421 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10423 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10425 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10427 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10428 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10429 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10431 /* Clone the regex array */
10432 PL_regex_padav = newAV();
10434 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10435 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10437 av_push(PL_regex_padav,
10438 sv_dup_inc(regexen[0],param));
10439 for(i = 1; i <= len; i++) {
10440 const SV * const regex = regexen[i];
10443 ? sv_dup_inc(regex, param)
10445 newSViv(PTR2IV(re_dup(
10446 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10448 av_push(PL_regex_padav, sv);
10451 PL_regex_pad = AvARRAY(PL_regex_padav);
10453 /* shortcuts to various I/O objects */
10454 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10455 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10456 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10457 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10458 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10459 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10461 /* shortcuts to regexp stuff */
10462 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10464 /* shortcuts to misc objects */
10465 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10467 /* shortcuts to debugging objects */
10468 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10469 PL_DBline = gv_dup(proto_perl->IDBline, param);
10470 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10471 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10472 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10473 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10474 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10475 PL_lineary = av_dup(proto_perl->Ilineary, param);
10476 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10478 /* symbol tables */
10479 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10480 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10481 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10482 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10483 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10485 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10486 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10487 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10488 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10489 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10490 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10492 PL_sub_generation = proto_perl->Isub_generation;
10494 /* funky return mechanisms */
10495 PL_forkprocess = proto_perl->Iforkprocess;
10497 /* subprocess state */
10498 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10500 /* internal state */
10501 PL_maxo = proto_perl->Imaxo;
10502 if (proto_perl->Iop_mask)
10503 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10505 PL_op_mask = Nullch;
10506 /* PL_asserting = proto_perl->Iasserting; */
10508 /* current interpreter roots */
10509 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10510 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10511 PL_main_start = proto_perl->Imain_start;
10512 PL_eval_root = proto_perl->Ieval_root;
10513 PL_eval_start = proto_perl->Ieval_start;
10515 /* runtime control stuff */
10516 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10517 PL_copline = proto_perl->Icopline;
10519 PL_filemode = proto_perl->Ifilemode;
10520 PL_lastfd = proto_perl->Ilastfd;
10521 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10524 PL_gensym = proto_perl->Igensym;
10525 PL_preambled = proto_perl->Ipreambled;
10526 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10527 PL_laststatval = proto_perl->Ilaststatval;
10528 PL_laststype = proto_perl->Ilaststype;
10529 PL_mess_sv = Nullsv;
10531 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10533 /* interpreter atexit processing */
10534 PL_exitlistlen = proto_perl->Iexitlistlen;
10535 if (PL_exitlistlen) {
10536 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10537 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10540 PL_exitlist = (PerlExitListEntry*)NULL;
10542 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10543 if (PL_my_cxt_size) {
10544 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10545 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10548 PL_my_cxt_list = (void**)NULL;
10549 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10550 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10551 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10553 PL_profiledata = NULL;
10554 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10555 /* PL_rsfp_filters entries have fake IoDIRP() */
10556 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10558 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10560 PAD_CLONE_VARS(proto_perl, param);
10562 #ifdef HAVE_INTERP_INTERN
10563 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10566 /* more statics moved here */
10567 PL_generation = proto_perl->Igeneration;
10568 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10570 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10571 PL_in_clean_all = proto_perl->Iin_clean_all;
10573 PL_uid = proto_perl->Iuid;
10574 PL_euid = proto_perl->Ieuid;
10575 PL_gid = proto_perl->Igid;
10576 PL_egid = proto_perl->Iegid;
10577 PL_nomemok = proto_perl->Inomemok;
10578 PL_an = proto_perl->Ian;
10579 PL_evalseq = proto_perl->Ievalseq;
10580 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10581 PL_origalen = proto_perl->Iorigalen;
10582 #ifdef PERL_USES_PL_PIDSTATUS
10583 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10585 PL_osname = SAVEPV(proto_perl->Iosname);
10586 PL_sighandlerp = proto_perl->Isighandlerp;
10588 PL_runops = proto_perl->Irunops;
10590 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10593 PL_cshlen = proto_perl->Icshlen;
10594 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10597 PL_lex_state = proto_perl->Ilex_state;
10598 PL_lex_defer = proto_perl->Ilex_defer;
10599 PL_lex_expect = proto_perl->Ilex_expect;
10600 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10601 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10602 PL_lex_starts = proto_perl->Ilex_starts;
10603 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10604 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10605 PL_lex_op = proto_perl->Ilex_op;
10606 PL_lex_inpat = proto_perl->Ilex_inpat;
10607 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10608 PL_lex_brackets = proto_perl->Ilex_brackets;
10609 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10610 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10611 PL_lex_casemods = proto_perl->Ilex_casemods;
10612 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10613 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10615 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10616 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10617 PL_nexttoke = proto_perl->Inexttoke;
10619 /* XXX This is probably masking the deeper issue of why
10620 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10621 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10622 * (A little debugging with a watchpoint on it may help.)
10624 if (SvANY(proto_perl->Ilinestr)) {
10625 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10626 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10627 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10628 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10629 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10630 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10631 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10632 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10633 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10636 PL_linestr = newSV(79);
10637 sv_upgrade(PL_linestr,SVt_PVIV);
10638 sv_setpvn(PL_linestr,"",0);
10639 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10641 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10642 PL_pending_ident = proto_perl->Ipending_ident;
10643 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10645 PL_expect = proto_perl->Iexpect;
10647 PL_multi_start = proto_perl->Imulti_start;
10648 PL_multi_end = proto_perl->Imulti_end;
10649 PL_multi_open = proto_perl->Imulti_open;
10650 PL_multi_close = proto_perl->Imulti_close;
10652 PL_error_count = proto_perl->Ierror_count;
10653 PL_subline = proto_perl->Isubline;
10654 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10656 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10657 if (SvANY(proto_perl->Ilinestr)) {
10658 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10659 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10660 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10661 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10662 PL_last_lop_op = proto_perl->Ilast_lop_op;
10665 PL_last_uni = SvPVX(PL_linestr);
10666 PL_last_lop = SvPVX(PL_linestr);
10667 PL_last_lop_op = 0;
10669 PL_in_my = proto_perl->Iin_my;
10670 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10672 PL_cryptseen = proto_perl->Icryptseen;
10675 PL_hints = proto_perl->Ihints;
10677 PL_amagic_generation = proto_perl->Iamagic_generation;
10679 #ifdef USE_LOCALE_COLLATE
10680 PL_collation_ix = proto_perl->Icollation_ix;
10681 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10682 PL_collation_standard = proto_perl->Icollation_standard;
10683 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10684 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10685 #endif /* USE_LOCALE_COLLATE */
10687 #ifdef USE_LOCALE_NUMERIC
10688 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10689 PL_numeric_standard = proto_perl->Inumeric_standard;
10690 PL_numeric_local = proto_perl->Inumeric_local;
10691 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10692 #endif /* !USE_LOCALE_NUMERIC */
10694 /* utf8 character classes */
10695 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10696 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10697 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10698 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10699 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10700 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10701 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10702 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10703 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10704 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10705 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10706 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10707 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10708 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10709 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10710 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10711 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10712 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10713 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10714 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10716 /* Did the locale setup indicate UTF-8? */
10717 PL_utf8locale = proto_perl->Iutf8locale;
10718 /* Unicode features (see perlrun/-C) */
10719 PL_unicode = proto_perl->Iunicode;
10721 /* Pre-5.8 signals control */
10722 PL_signals = proto_perl->Isignals;
10724 /* times() ticks per second */
10725 PL_clocktick = proto_perl->Iclocktick;
10727 /* Recursion stopper for PerlIO_find_layer */
10728 PL_in_load_module = proto_perl->Iin_load_module;
10730 /* sort() routine */
10731 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10733 /* Not really needed/useful since the reenrant_retint is "volatile",
10734 * but do it for consistency's sake. */
10735 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10737 /* Hooks to shared SVs and locks. */
10738 PL_sharehook = proto_perl->Isharehook;
10739 PL_lockhook = proto_perl->Ilockhook;
10740 PL_unlockhook = proto_perl->Iunlockhook;
10741 PL_threadhook = proto_perl->Ithreadhook;
10743 PL_runops_std = proto_perl->Irunops_std;
10744 PL_runops_dbg = proto_perl->Irunops_dbg;
10746 #ifdef THREADS_HAVE_PIDS
10747 PL_ppid = proto_perl->Ippid;
10751 PL_last_swash_hv = NULL; /* reinits on demand */
10752 PL_last_swash_klen = 0;
10753 PL_last_swash_key[0]= '\0';
10754 PL_last_swash_tmps = (U8*)NULL;
10755 PL_last_swash_slen = 0;
10757 PL_glob_index = proto_perl->Iglob_index;
10758 PL_srand_called = proto_perl->Isrand_called;
10759 PL_uudmap['M'] = 0; /* reinits on demand */
10760 PL_bitcount = Nullch; /* reinits on demand */
10762 if (proto_perl->Ipsig_pend) {
10763 Newxz(PL_psig_pend, SIG_SIZE, int);
10766 PL_psig_pend = (int*)NULL;
10769 if (proto_perl->Ipsig_ptr) {
10770 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10771 Newxz(PL_psig_name, SIG_SIZE, SV*);
10772 for (i = 1; i < SIG_SIZE; i++) {
10773 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10774 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10778 PL_psig_ptr = (SV**)NULL;
10779 PL_psig_name = (SV**)NULL;
10782 /* thrdvar.h stuff */
10784 if (flags & CLONEf_COPY_STACKS) {
10785 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10786 PL_tmps_ix = proto_perl->Ttmps_ix;
10787 PL_tmps_max = proto_perl->Ttmps_max;
10788 PL_tmps_floor = proto_perl->Ttmps_floor;
10789 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10791 while (i <= PL_tmps_ix) {
10792 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10796 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10797 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10798 Newxz(PL_markstack, i, I32);
10799 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10800 - proto_perl->Tmarkstack);
10801 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10802 - proto_perl->Tmarkstack);
10803 Copy(proto_perl->Tmarkstack, PL_markstack,
10804 PL_markstack_ptr - PL_markstack + 1, I32);
10806 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10807 * NOTE: unlike the others! */
10808 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10809 PL_scopestack_max = proto_perl->Tscopestack_max;
10810 Newxz(PL_scopestack, PL_scopestack_max, I32);
10811 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10813 /* NOTE: si_dup() looks at PL_markstack */
10814 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10816 /* PL_curstack = PL_curstackinfo->si_stack; */
10817 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10818 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10820 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10821 PL_stack_base = AvARRAY(PL_curstack);
10822 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10823 - proto_perl->Tstack_base);
10824 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10826 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10827 * NOTE: unlike the others! */
10828 PL_savestack_ix = proto_perl->Tsavestack_ix;
10829 PL_savestack_max = proto_perl->Tsavestack_max;
10830 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10831 PL_savestack = ss_dup(proto_perl, param);
10835 ENTER; /* perl_destruct() wants to LEAVE; */
10837 /* although we're not duplicating the tmps stack, we should still
10838 * add entries for any SVs on the tmps stack that got cloned by a
10839 * non-refcount means (eg a temp in @_); otherwise they will be
10842 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10843 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10844 proto_perl->Ttmps_stack[i]);
10845 if (nsv && !SvREFCNT(nsv)) {
10847 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10852 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10853 PL_top_env = &PL_start_env;
10855 PL_op = proto_perl->Top;
10858 PL_Xpv = (XPV*)NULL;
10859 PL_na = proto_perl->Tna;
10861 PL_statbuf = proto_perl->Tstatbuf;
10862 PL_statcache = proto_perl->Tstatcache;
10863 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10864 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10866 PL_timesbuf = proto_perl->Ttimesbuf;
10869 PL_tainted = proto_perl->Ttainted;
10870 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10871 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10872 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10873 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10874 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10875 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10876 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10877 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10878 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10880 PL_restartop = proto_perl->Trestartop;
10881 PL_in_eval = proto_perl->Tin_eval;
10882 PL_delaymagic = proto_perl->Tdelaymagic;
10883 PL_dirty = proto_perl->Tdirty;
10884 PL_localizing = proto_perl->Tlocalizing;
10886 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10887 PL_hv_fetch_ent_mh = Nullhe;
10888 PL_modcount = proto_perl->Tmodcount;
10889 PL_lastgotoprobe = Nullop;
10890 PL_dumpindent = proto_perl->Tdumpindent;
10892 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10893 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10894 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10895 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10896 PL_efloatbuf = Nullch; /* reinits on demand */
10897 PL_efloatsize = 0; /* reinits on demand */
10901 PL_screamfirst = NULL;
10902 PL_screamnext = NULL;
10903 PL_maxscream = -1; /* reinits on demand */
10904 PL_lastscream = Nullsv;
10906 PL_watchaddr = NULL;
10907 PL_watchok = Nullch;
10909 PL_regdummy = proto_perl->Tregdummy;
10910 PL_regprecomp = Nullch;
10913 PL_colorset = 0; /* reinits PL_colors[] */
10914 /*PL_colors[6] = {0,0,0,0,0,0};*/
10915 PL_reginput = Nullch;
10916 PL_regbol = Nullch;
10917 PL_regeol = Nullch;
10918 PL_regstartp = (I32*)NULL;
10919 PL_regendp = (I32*)NULL;
10920 PL_reglastparen = (U32*)NULL;
10921 PL_reglastcloseparen = (U32*)NULL;
10922 PL_regtill = Nullch;
10923 PL_reg_start_tmp = (char**)NULL;
10924 PL_reg_start_tmpl = 0;
10925 PL_regdata = (struct reg_data*)NULL;
10928 PL_reg_eval_set = 0;
10930 PL_regprogram = (regnode*)NULL;
10932 PL_regcc = (CURCUR*)NULL;
10933 PL_reg_call_cc = (struct re_cc_state*)NULL;
10934 PL_reg_re = (regexp*)NULL;
10935 PL_reg_ganch = Nullch;
10936 PL_reg_sv = Nullsv;
10937 PL_reg_match_utf8 = FALSE;
10938 PL_reg_magic = (MAGIC*)NULL;
10940 PL_reg_oldcurpm = (PMOP*)NULL;
10941 PL_reg_curpm = (PMOP*)NULL;
10942 PL_reg_oldsaved = Nullch;
10943 PL_reg_oldsavedlen = 0;
10944 #ifdef PERL_OLD_COPY_ON_WRITE
10947 PL_reg_maxiter = 0;
10948 PL_reg_leftiter = 0;
10949 PL_reg_poscache = Nullch;
10950 PL_reg_poscache_size= 0;
10952 /* RE engine - function pointers */
10953 PL_regcompp = proto_perl->Tregcompp;
10954 PL_regexecp = proto_perl->Tregexecp;
10955 PL_regint_start = proto_perl->Tregint_start;
10956 PL_regint_string = proto_perl->Tregint_string;
10957 PL_regfree = proto_perl->Tregfree;
10959 PL_reginterp_cnt = 0;
10960 PL_reg_starttry = 0;
10962 /* Pluggable optimizer */
10963 PL_peepp = proto_perl->Tpeepp;
10965 PL_stashcache = newHV();
10967 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10968 ptr_table_free(PL_ptr_table);
10969 PL_ptr_table = NULL;
10972 /* Call the ->CLONE method, if it exists, for each of the stashes
10973 identified by sv_dup() above.
10975 while(av_len(param->stashes) != -1) {
10976 HV* const stash = (HV*) av_shift(param->stashes);
10977 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10978 if (cloner && GvCV(cloner)) {
10983 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10985 call_sv((SV*)GvCV(cloner), G_DISCARD);
10991 SvREFCNT_dec(param->stashes);
10993 /* orphaned? eg threads->new inside BEGIN or use */
10994 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10995 (void)SvREFCNT_inc(PL_compcv);
10996 SAVEFREESV(PL_compcv);
11002 #endif /* USE_ITHREADS */
11005 =head1 Unicode Support
11007 =for apidoc sv_recode_to_utf8
11009 The encoding is assumed to be an Encode object, on entry the PV
11010 of the sv is assumed to be octets in that encoding, and the sv
11011 will be converted into Unicode (and UTF-8).
11013 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11014 is not a reference, nothing is done to the sv. If the encoding is not
11015 an C<Encode::XS> Encoding object, bad things will happen.
11016 (See F<lib/encoding.pm> and L<Encode>).
11018 The PV of the sv is returned.
11023 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11026 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11040 Passing sv_yes is wrong - it needs to be or'ed set of constants
11041 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11042 remove converted chars from source.
11044 Both will default the value - let them.
11046 XPUSHs(&PL_sv_yes);
11049 call_method("decode", G_SCALAR);
11053 s = SvPV_const(uni, len);
11054 if (s != SvPVX_const(sv)) {
11055 SvGROW(sv, len + 1);
11056 Move(s, SvPVX(sv), len + 1, char);
11057 SvCUR_set(sv, len);
11064 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11068 =for apidoc sv_cat_decode
11070 The encoding is assumed to be an Encode object, the PV of the ssv is
11071 assumed to be octets in that encoding and decoding the input starts
11072 from the position which (PV + *offset) pointed to. The dsv will be
11073 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11074 when the string tstr appears in decoding output or the input ends on
11075 the PV of the ssv. The value which the offset points will be modified
11076 to the last input position on the ssv.
11078 Returns TRUE if the terminator was found, else returns FALSE.
11083 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11084 SV *ssv, int *offset, char *tstr, int tlen)
11088 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11099 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11100 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11102 call_method("cat_decode", G_SCALAR);
11104 ret = SvTRUE(TOPs);
11105 *offset = SvIV(offsv);
11111 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11116 /* ---------------------------------------------------------------------
11118 * support functions for report_uninit()
11121 /* the maxiumum size of array or hash where we will scan looking
11122 * for the undefined element that triggered the warning */
11124 #define FUV_MAX_SEARCH_SIZE 1000
11126 /* Look for an entry in the hash whose value has the same SV as val;
11127 * If so, return a mortal copy of the key. */
11130 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11133 register HE **array;
11136 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11137 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11140 array = HvARRAY(hv);
11142 for (i=HvMAX(hv); i>0; i--) {
11143 register HE *entry;
11144 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11145 if (HeVAL(entry) != val)
11147 if ( HeVAL(entry) == &PL_sv_undef ||
11148 HeVAL(entry) == &PL_sv_placeholder)
11152 if (HeKLEN(entry) == HEf_SVKEY)
11153 return sv_mortalcopy(HeKEY_sv(entry));
11154 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11160 /* Look for an entry in the array whose value has the same SV as val;
11161 * If so, return the index, otherwise return -1. */
11164 S_find_array_subscript(pTHX_ AV *av, SV* val)
11169 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11170 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11174 for (i=AvFILLp(av); i>=0; i--) {
11175 if (svp[i] == val && svp[i] != &PL_sv_undef)
11181 /* S_varname(): return the name of a variable, optionally with a subscript.
11182 * If gv is non-zero, use the name of that global, along with gvtype (one
11183 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11184 * targ. Depending on the value of the subscript_type flag, return:
11187 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11188 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11189 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11190 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11193 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11194 SV* keyname, I32 aindex, int subscript_type)
11197 SV * const name = sv_newmortal();
11200 buffer[0] = gvtype;
11203 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11205 gv_fullname4(name, gv, buffer, 0);
11207 if ((unsigned int)SvPVX(name)[1] <= 26) {
11209 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11211 /* Swap the 1 unprintable control character for the 2 byte pretty
11212 version - ie substr($name, 1, 1) = $buffer; */
11213 sv_insert(name, 1, 1, buffer, 2);
11218 CV * const cv = find_runcv(&unused);
11222 if (!cv || !CvPADLIST(cv))
11224 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11225 sv = *av_fetch(av, targ, FALSE);
11226 /* SvLEN in a pad name is not to be trusted */
11227 sv_setpv(name, SvPV_nolen_const(sv));
11230 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11231 SV * const sv = newSV(0);
11232 *SvPVX(name) = '$';
11233 Perl_sv_catpvf(aTHX_ name, "{%s}",
11234 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11237 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11238 *SvPVX(name) = '$';
11239 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11241 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11242 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11249 =for apidoc find_uninit_var
11251 Find the name of the undefined variable (if any) that caused the operator o
11252 to issue a "Use of uninitialized value" warning.
11253 If match is true, only return a name if it's value matches uninit_sv.
11254 So roughly speaking, if a unary operator (such as OP_COS) generates a
11255 warning, then following the direct child of the op may yield an
11256 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11257 other hand, with OP_ADD there are two branches to follow, so we only print
11258 the variable name if we get an exact match.
11260 The name is returned as a mortal SV.
11262 Assumes that PL_op is the op that originally triggered the error, and that
11263 PL_comppad/PL_curpad points to the currently executing pad.
11269 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11277 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11278 uninit_sv == &PL_sv_placeholder)))
11281 switch (obase->op_type) {
11288 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11289 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11291 SV *keysv = Nullsv;
11292 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11294 if (pad) { /* @lex, %lex */
11295 sv = PAD_SVl(obase->op_targ);
11299 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11300 /* @global, %global */
11301 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11304 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11306 else /* @{expr}, %{expr} */
11307 return find_uninit_var(cUNOPx(obase)->op_first,
11311 /* attempt to find a match within the aggregate */
11313 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11315 subscript_type = FUV_SUBSCRIPT_HASH;
11318 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11320 subscript_type = FUV_SUBSCRIPT_ARRAY;
11323 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11326 return varname(gv, hash ? '%' : '@', obase->op_targ,
11327 keysv, index, subscript_type);
11331 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11333 return varname(Nullgv, '$', obase->op_targ,
11334 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11337 gv = cGVOPx_gv(obase);
11338 if (!gv || (match && GvSV(gv) != uninit_sv))
11340 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11343 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11346 av = (AV*)PAD_SV(obase->op_targ);
11347 if (!av || SvRMAGICAL(av))
11349 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11350 if (!svp || *svp != uninit_sv)
11353 return varname(Nullgv, '$', obase->op_targ,
11354 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11357 gv = cGVOPx_gv(obase);
11363 if (!av || SvRMAGICAL(av))
11365 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11366 if (!svp || *svp != uninit_sv)
11369 return varname(gv, '$', 0,
11370 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11375 o = cUNOPx(obase)->op_first;
11376 if (!o || o->op_type != OP_NULL ||
11377 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11379 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11383 if (PL_op == obase)
11384 /* $a[uninit_expr] or $h{uninit_expr} */
11385 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11388 o = cBINOPx(obase)->op_first;
11389 kid = cBINOPx(obase)->op_last;
11391 /* get the av or hv, and optionally the gv */
11393 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11394 sv = PAD_SV(o->op_targ);
11396 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11397 && cUNOPo->op_first->op_type == OP_GV)
11399 gv = cGVOPx_gv(cUNOPo->op_first);
11402 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11407 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11408 /* index is constant */
11412 if (obase->op_type == OP_HELEM) {
11413 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11414 if (!he || HeVAL(he) != uninit_sv)
11418 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11419 if (!svp || *svp != uninit_sv)
11423 if (obase->op_type == OP_HELEM)
11424 return varname(gv, '%', o->op_targ,
11425 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11427 return varname(gv, '@', o->op_targ, Nullsv,
11428 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11431 /* index is an expression;
11432 * attempt to find a match within the aggregate */
11433 if (obase->op_type == OP_HELEM) {
11434 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11436 return varname(gv, '%', o->op_targ,
11437 keysv, 0, FUV_SUBSCRIPT_HASH);
11440 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11442 return varname(gv, '@', o->op_targ,
11443 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11448 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11450 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11456 /* only examine RHS */
11457 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11460 o = cUNOPx(obase)->op_first;
11461 if (o->op_type == OP_PUSHMARK)
11464 if (!o->op_sibling) {
11465 /* one-arg version of open is highly magical */
11467 if (o->op_type == OP_GV) { /* open FOO; */
11469 if (match && GvSV(gv) != uninit_sv)
11471 return varname(gv, '$', 0,
11472 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11474 /* other possibilities not handled are:
11475 * open $x; or open my $x; should return '${*$x}'
11476 * open expr; should return '$'.expr ideally
11482 /* ops where $_ may be an implicit arg */
11486 if ( !(obase->op_flags & OPf_STACKED)) {
11487 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11488 ? PAD_SVl(obase->op_targ)
11491 sv = sv_newmortal();
11492 sv_setpvn(sv, "$_", 2);
11500 /* skip filehandle as it can't produce 'undef' warning */
11501 o = cUNOPx(obase)->op_first;
11502 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11503 o = o->op_sibling->op_sibling;
11510 match = 1; /* XS or custom code could trigger random warnings */
11515 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11516 return sv_2mortal(newSVpvs("${$/}"));
11521 if (!(obase->op_flags & OPf_KIDS))
11523 o = cUNOPx(obase)->op_first;
11529 /* if all except one arg are constant, or have no side-effects,
11530 * or are optimized away, then it's unambiguous */
11532 for (kid=o; kid; kid = kid->op_sibling) {
11534 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11535 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11536 || (kid->op_type == OP_PUSHMARK)
11540 if (o2) { /* more than one found */
11547 return find_uninit_var(o2, uninit_sv, match);
11549 /* scan all args */
11551 sv = find_uninit_var(o, uninit_sv, 1);
11563 =for apidoc report_uninit
11565 Print appropriate "Use of uninitialized variable" warning
11571 Perl_report_uninit(pTHX_ SV* uninit_sv)
11575 SV* varname = Nullsv;
11577 varname = find_uninit_var(PL_op, uninit_sv,0);
11579 sv_insert(varname, 0, 0, " ", 1);
11581 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11582 varname ? SvPV_nolen_const(varname) : "",
11583 " in ", OP_DESC(PL_op));
11586 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11592 * c-indentation-style: bsd
11593 * c-basic-offset: 4
11594 * indent-tabs-mode: t
11597 * ex: set ts=8 sts=4 sw=4 noet: