3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = Nullch;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 S_free_arena(pTHX_ void **root) {
562 void ** const next = *(void **)root;
569 =for apidoc sv_free_arenas
571 Deallocate the memory used by all arenas. Note that all the individual SV
572 heads and bodies within the arenas must already have been freed.
576 #define free_arena(name) \
578 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
579 PL_ ## name ## _arenaroot = 0; \
580 PL_ ## name ## _root = 0; \
584 Perl_sv_free_arenas(pTHX)
591 /* Free arenas here, but be careful about fake ones. (We assume
592 contiguity of the fake ones with the corresponding real ones.) */
594 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
595 svanext = (SV*) SvANY(sva);
596 while (svanext && SvFAKE(svanext))
597 svanext = (SV*) SvANY(svanext);
603 for (i=0; i<SVt_LAST; i++) {
604 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
605 PL_body_arenaroots[i] = 0;
606 PL_body_roots[i] = 0;
609 Safefree(PL_nice_chunk);
610 PL_nice_chunk = Nullch;
611 PL_nice_chunk_size = 0;
617 Here are mid-level routines that manage the allocation of bodies out
618 of the various arenas. There are 5 kinds of arenas:
620 1. SV-head arenas, which are discussed and handled above
621 2. regular body arenas
622 3. arenas for reduced-size bodies
624 5. pte arenas (thread related)
626 Arena types 2 & 3 are chained by body-type off an array of
627 arena-root pointers, which is indexed by svtype. Some of the
628 larger/less used body types are malloced singly, since a large
629 unused block of them is wasteful. Also, several svtypes dont have
630 bodies; the data fits into the sv-head itself. The arena-root
631 pointer thus has a few unused root-pointers (which may be hijacked
632 later for arena types 4,5)
634 3 differs from 2 as an optimization; some body types have several
635 unused fields in the front of the structure (which are kept in-place
636 for consistency). These bodies can be allocated in smaller chunks,
637 because the leading fields arent accessed. Pointers to such bodies
638 are decremented to point at the unused 'ghost' memory, knowing that
639 the pointers are used with offsets to the real memory.
641 HE, HEK arenas are managed separately, with separate code, but may
642 be merge-able later..
644 PTE arenas are not sv-bodies, but they share these mid-level
645 mechanics, so are considered here. The new mid-level mechanics rely
646 on the sv_type of the body being allocated, so we just reserve one
647 of the unused body-slots for PTEs, then use it in those (2) PTE
648 contexts below (line ~10k)
652 S_more_bodies (pTHX_ size_t size, svtype sv_type)
655 void ** const arena_root = &PL_body_arenaroots[sv_type];
656 void ** const root = &PL_body_roots[sv_type];
659 const size_t count = PERL_ARENA_SIZE / size;
661 Newx(start, count*size, char);
662 *((void **) start) = *arena_root;
663 *arena_root = (void *)start;
665 end = start + (count-1) * size;
667 /* The initial slot is used to link the arenas together, so it isn't to be
668 linked into the list of ready-to-use bodies. */
672 *root = (void *)start;
674 while (start < end) {
675 char * const next = start + size;
676 *(void**) start = (void *)next;
684 /* grab a new thing from the free list, allocating more if necessary */
686 /* 1st, the inline version */
688 #define new_body_inline(xpv, size, sv_type) \
690 void ** const r3wt = &PL_body_roots[sv_type]; \
692 xpv = *((void **)(r3wt)) \
693 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
694 *(r3wt) = *(void**)(xpv); \
698 /* now use the inline version in the proper function */
702 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
703 compilers issue warnings. */
706 S_new_body(pTHX_ size_t size, svtype sv_type)
710 new_body_inline(xpv, size, sv_type);
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 Revisiting type 3 arenas, there are 4 body-types which have some
729 members that are never accessed. They are XPV, XPVIV, XPVAV,
730 XPVHV, which have corresponding types: xpv_allocated,
731 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by
736 the size of the bit not allocated, so it's as if we allocated the
737 full structure. (But things will all go boom if you write to the
738 part that is "not there", because you'll be overwriting the last
739 members of the preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For example, if
742 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
743 and the pointer is unchanged. If the allocated structure is smaller (no
744 initial NV actually allocated) then the net effect is to subtract the size
745 of the NV from the pointer, to return a new pointer as if an initial NV were
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at the
750 start of the structure. IV bodies don't need it either, because they are
751 no longer allocated. */
753 /* The following 2 arrays hide the above details in a pair of
754 lookup-tables, allowing us to be body-type agnostic.
756 size maps svtype to its body's allocated size.
757 offset maps svtype to the body-pointer adjustment needed
759 NB: elements in latter are 0 or <0, and are added during
760 allocation, and subtracted during deallocation. It may be clearer
761 to invert the values, and call it shrinkage_by_svtype.
764 struct body_details {
765 size_t size; /* Size to allocate */
766 size_t copy; /* Size of structure to copy (may be shorter) */
768 bool cant_upgrade; /* Can upgrade this type */
769 bool zero_nv; /* zero the NV when upgrading from this */
770 bool arena; /* Allocated from an arena */
777 /* With -DPURFIY we allocate everything directly, and don't use arenas.
778 This seems a rather elegant way to simplify some of the code below. */
779 #define HASARENA FALSE
781 #define HASARENA TRUE
783 #define NOARENA FALSE
785 /* A macro to work out the offset needed to subtract from a pointer to (say)
792 to make its members accessible via a pointer to (say)
802 #define relative_STRUCT_OFFSET(longer, shorter, member) \
803 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
805 /* Calculate the length to copy. Specifically work out the length less any
806 final padding the compiler needed to add. See the comment in sv_upgrade
807 for why copying the padding proved to be a bug. */
809 #define copy_length(type, last_member) \
810 STRUCT_OFFSET(type, last_member) \
811 + sizeof (((type*)SvANY((SV*)0))->last_member)
813 static const struct body_details bodies_by_type[] = {
814 {0, 0, 0, FALSE, NONV, NOARENA},
815 /* IVs are in the head, so the allocation size is 0 */
816 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
817 /* 8 bytes on most ILP32 with IEEE doubles */
818 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
819 /* RVs are in the head now */
820 /* However, this slot is overloaded and used by the pte */
821 {0, 0, 0, FALSE, NONV, NOARENA},
822 /* 8 bytes on most ILP32 with IEEE doubles */
823 {sizeof(xpv_allocated),
824 copy_length(XPV, xpv_len)
825 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
826 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
827 FALSE, NONV, HASARENA},
829 {sizeof(xpviv_allocated),
830 copy_length(XPVIV, xiv_u)
831 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
832 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
833 FALSE, NONV, HASARENA},
835 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
837 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
839 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
841 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
843 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
845 {sizeof(xpvav_allocated),
846 copy_length(XPVAV, xmg_stash)
847 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
848 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
849 TRUE, HADNV, HASARENA},
851 {sizeof(xpvhv_allocated),
852 copy_length(XPVHV, xmg_stash)
853 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
854 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
855 TRUE, HADNV, HASARENA},
857 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
859 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
861 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
864 #define new_body_type(sv_type) \
865 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
866 - bodies_by_type[sv_type].offset)
868 #define del_body_type(p, sv_type) \
869 del_body(p, &PL_body_roots[sv_type])
872 #define new_body_allocated(sv_type) \
873 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
874 - bodies_by_type[sv_type].offset)
876 #define del_body_allocated(p, sv_type) \
877 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
880 #define my_safemalloc(s) (void*)safemalloc(s)
881 #define my_safecalloc(s) (void*)safecalloc(s, 1)
882 #define my_safefree(p) safefree((char*)p)
886 #define new_XNV() my_safemalloc(sizeof(XPVNV))
887 #define del_XNV(p) my_safefree(p)
889 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
890 #define del_XPVNV(p) my_safefree(p)
892 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
893 #define del_XPVAV(p) my_safefree(p)
895 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
896 #define del_XPVHV(p) my_safefree(p)
898 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
899 #define del_XPVMG(p) my_safefree(p)
901 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
902 #define del_XPVGV(p) my_safefree(p)
906 #define new_XNV() new_body_type(SVt_NV)
907 #define del_XNV(p) del_body_type(p, SVt_NV)
909 #define new_XPVNV() new_body_type(SVt_PVNV)
910 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
912 #define new_XPVAV() new_body_allocated(SVt_PVAV)
913 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
915 #define new_XPVHV() new_body_allocated(SVt_PVHV)
916 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
918 #define new_XPVMG() new_body_type(SVt_PVMG)
919 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
921 #define new_XPVGV() new_body_type(SVt_PVGV)
922 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
926 /* no arena for you! */
928 #define new_NOARENA(details) \
929 my_safemalloc((details)->size + (details)->offset)
930 #define new_NOARENAZ(details) \
931 my_safecalloc((details)->size + (details)->offset)
934 =for apidoc sv_upgrade
936 Upgrade an SV to a more complex form. Generally adds a new body type to the
937 SV, then copies across as much information as possible from the old body.
938 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
944 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
949 const U32 old_type = SvTYPE(sv);
950 const struct body_details *const old_type_details
951 = bodies_by_type + old_type;
952 const struct body_details *new_type_details = bodies_by_type + new_type;
954 if (new_type != SVt_PV && SvIsCOW(sv)) {
955 sv_force_normal_flags(sv, 0);
958 if (old_type == new_type)
961 if (old_type > new_type)
962 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
963 (int)old_type, (int)new_type);
966 old_body = SvANY(sv);
968 /* Copying structures onto other structures that have been neatly zeroed
969 has a subtle gotcha. Consider XPVMG
971 +------+------+------+------+------+-------+-------+
972 | NV | CUR | LEN | IV | MAGIC | STASH |
973 +------+------+------+------+------+-------+-------+
976 where NVs are aligned to 8 bytes, so that sizeof that structure is
977 actually 32 bytes long, with 4 bytes of padding at the end:
979 +------+------+------+------+------+-------+-------+------+
980 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
981 +------+------+------+------+------+-------+-------+------+
982 0 4 8 12 16 20 24 28 32
984 so what happens if you allocate memory for this structure:
986 +------+------+------+------+------+-------+-------+------+------+...
987 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
988 +------+------+------+------+------+-------+-------+------+------+...
989 0 4 8 12 16 20 24 28 32 36
991 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
992 expect, because you copy the area marked ??? onto GP. Now, ??? may have
993 started out as zero once, but it's quite possible that it isn't. So now,
994 rather than a nicely zeroed GP, you have it pointing somewhere random.
997 (In fact, GP ends up pointing at a previous GP structure, because the
998 principle cause of the padding in XPVMG getting garbage is a copy of
999 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1001 So we are careful and work out the size of used parts of all the
1008 if (new_type < SVt_PVIV) {
1009 new_type = (new_type == SVt_NV)
1010 ? SVt_PVNV : SVt_PVIV;
1011 new_type_details = bodies_by_type + new_type;
1015 if (new_type < SVt_PVNV) {
1016 new_type = SVt_PVNV;
1017 new_type_details = bodies_by_type + new_type;
1023 assert(new_type > SVt_PV);
1024 assert(SVt_IV < SVt_PV);
1025 assert(SVt_NV < SVt_PV);
1032 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1033 there's no way that it can be safely upgraded, because perl.c
1034 expects to Safefree(SvANY(PL_mess_sv)) */
1035 assert(sv != PL_mess_sv);
1036 /* This flag bit is used to mean other things in other scalar types.
1037 Given that it only has meaning inside the pad, it shouldn't be set
1038 on anything that can get upgraded. */
1039 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1042 if (old_type_details->cant_upgrade)
1043 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1046 SvFLAGS(sv) &= ~SVTYPEMASK;
1047 SvFLAGS(sv) |= new_type;
1051 Perl_croak(aTHX_ "Can't upgrade to undef");
1053 assert(old_type == SVt_NULL);
1054 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1058 assert(old_type == SVt_NULL);
1059 SvANY(sv) = new_XNV();
1063 assert(old_type == SVt_NULL);
1064 SvANY(sv) = &sv->sv_u.svu_rv;
1068 SvANY(sv) = new_XPVHV();
1071 HvTOTALKEYS(sv) = 0;
1076 SvANY(sv) = new_XPVAV();
1083 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1084 The target created by newSVrv also is, and it can have magic.
1085 However, it never has SvPVX set.
1087 if (old_type >= SVt_RV) {
1088 assert(SvPVX_const(sv) == 0);
1091 /* Could put this in the else clause below, as PVMG must have SvPVX
1092 0 already (the assertion above) */
1095 if (old_type >= SVt_PVMG) {
1096 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1097 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1099 SvMAGIC_set(sv, NULL);
1100 SvSTASH_set(sv, NULL);
1106 /* XXX Is this still needed? Was it ever needed? Surely as there is
1107 no route from NV to PVIV, NOK can never be true */
1108 assert(!SvNOKp(sv));
1120 assert(new_type_details->size);
1121 /* We always allocated the full length item with PURIFY. To do this
1122 we fake things so that arena is false for all 16 types.. */
1123 if(new_type_details->arena) {
1124 /* This points to the start of the allocated area. */
1125 new_body_inline(new_body, new_type_details->size, new_type);
1126 Zero(new_body, new_type_details->size, char);
1127 new_body = ((char *)new_body) - new_type_details->offset;
1129 new_body = new_NOARENAZ(new_type_details);
1131 SvANY(sv) = new_body;
1133 if (old_type_details->copy) {
1134 Copy((char *)old_body + old_type_details->offset,
1135 (char *)new_body + old_type_details->offset,
1136 old_type_details->copy, char);
1139 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1140 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1141 * correct 0.0 for us. Otherwise, if the old body didn't have an
1142 * NV slot, but the new one does, then we need to initialise the
1143 * freshly created NV slot with whatever the correct bit pattern is
1145 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1149 if (new_type == SVt_PVIO)
1150 IoPAGE_LEN(sv) = 60;
1151 if (old_type < SVt_RV)
1155 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1156 (unsigned long)new_type);
1159 if (old_type_details->size) {
1160 /* If the old body had an allocated size, then we need to free it. */
1162 my_safefree(old_body);
1164 del_body((void*)((char*)old_body + old_type_details->offset),
1165 &PL_body_roots[old_type]);
1171 =for apidoc sv_backoff
1173 Remove any string offset. You should normally use the C<SvOOK_off> macro
1180 Perl_sv_backoff(pTHX_ register SV *sv)
1183 assert(SvTYPE(sv) != SVt_PVHV);
1184 assert(SvTYPE(sv) != SVt_PVAV);
1186 const char * const s = SvPVX_const(sv);
1187 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1188 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1190 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1192 SvFLAGS(sv) &= ~SVf_OOK;
1199 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1200 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1201 Use the C<SvGROW> wrapper instead.
1207 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000) {
1213 PerlIO_printf(Perl_debug_log,
1214 "Allocation too large: %"UVxf"\n", (UV)newlen);
1217 #endif /* HAS_64K_LIMIT */
1220 if (SvTYPE(sv) < SVt_PV) {
1221 sv_upgrade(sv, SVt_PV);
1222 s = SvPVX_mutable(sv);
1224 else if (SvOOK(sv)) { /* pv is offset? */
1226 s = SvPVX_mutable(sv);
1227 if (newlen > SvLEN(sv))
1228 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1229 #ifdef HAS_64K_LIMIT
1230 if (newlen >= 0x10000)
1235 s = SvPVX_mutable(sv);
1237 if (newlen > SvLEN(sv)) { /* need more room? */
1238 newlen = PERL_STRLEN_ROUNDUP(newlen);
1239 if (SvLEN(sv) && s) {
1241 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1247 s = saferealloc(s, newlen);
1250 s = safemalloc(newlen);
1251 if (SvPVX_const(sv) && SvCUR(sv)) {
1252 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1256 SvLEN_set(sv, newlen);
1262 =for apidoc sv_setiv
1264 Copies an integer into the given SV, upgrading first if necessary.
1265 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1271 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1274 SV_CHECK_THINKFIRST_COW_DROP(sv);
1275 switch (SvTYPE(sv)) {
1277 sv_upgrade(sv, SVt_IV);
1280 sv_upgrade(sv, SVt_PVNV);
1284 sv_upgrade(sv, SVt_PVIV);
1293 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1296 (void)SvIOK_only(sv); /* validate number */
1302 =for apidoc sv_setiv_mg
1304 Like C<sv_setiv>, but also handles 'set' magic.
1310 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1317 =for apidoc sv_setuv
1319 Copies an unsigned integer into the given SV, upgrading first if necessary.
1320 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1326 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1328 /* With these two if statements:
1329 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1332 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1334 If you wish to remove them, please benchmark to see what the effect is
1336 if (u <= (UV)IV_MAX) {
1337 sv_setiv(sv, (IV)u);
1346 =for apidoc sv_setuv_mg
1348 Like C<sv_setuv>, but also handles 'set' magic.
1354 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1363 =for apidoc sv_setnv
1365 Copies a double into the given SV, upgrading first if necessary.
1366 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1372 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1375 SV_CHECK_THINKFIRST_COW_DROP(sv);
1376 switch (SvTYPE(sv)) {
1379 sv_upgrade(sv, SVt_NV);
1384 sv_upgrade(sv, SVt_PVNV);
1393 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1397 (void)SvNOK_only(sv); /* validate number */
1402 =for apidoc sv_setnv_mg
1404 Like C<sv_setnv>, but also handles 'set' magic.
1410 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1416 /* Print an "isn't numeric" warning, using a cleaned-up,
1417 * printable version of the offending string
1421 S_not_a_number(pTHX_ SV *sv)
1429 dsv = sv_2mortal(newSVpvs(""));
1430 pv = sv_uni_display(dsv, sv, 10, 0);
1433 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1434 /* each *s can expand to 4 chars + "...\0",
1435 i.e. need room for 8 chars */
1437 const char *s = SvPVX_const(sv);
1438 const char * const end = s + SvCUR(sv);
1439 for ( ; s < end && d < limit; s++ ) {
1441 if (ch & 128 && !isPRINT_LC(ch)) {
1450 else if (ch == '\r') {
1454 else if (ch == '\f') {
1458 else if (ch == '\\') {
1462 else if (ch == '\0') {
1466 else if (isPRINT_LC(ch))
1483 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1484 "Argument \"%s\" isn't numeric in %s", pv,
1487 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1488 "Argument \"%s\" isn't numeric", pv);
1492 =for apidoc looks_like_number
1494 Test if the content of an SV looks like a number (or is a number).
1495 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1496 non-numeric warning), even if your atof() doesn't grok them.
1502 Perl_looks_like_number(pTHX_ SV *sv)
1504 register const char *sbegin;
1508 sbegin = SvPVX_const(sv);
1511 else if (SvPOKp(sv))
1512 sbegin = SvPV_const(sv, len);
1514 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1515 return grok_number(sbegin, len, NULL);
1518 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1519 until proven guilty, assume that things are not that bad... */
1524 As 64 bit platforms often have an NV that doesn't preserve all bits of
1525 an IV (an assumption perl has been based on to date) it becomes necessary
1526 to remove the assumption that the NV always carries enough precision to
1527 recreate the IV whenever needed, and that the NV is the canonical form.
1528 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1529 precision as a side effect of conversion (which would lead to insanity
1530 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1531 1) to distinguish between IV/UV/NV slots that have cached a valid
1532 conversion where precision was lost and IV/UV/NV slots that have a
1533 valid conversion which has lost no precision
1534 2) to ensure that if a numeric conversion to one form is requested that
1535 would lose precision, the precise conversion (or differently
1536 imprecise conversion) is also performed and cached, to prevent
1537 requests for different numeric formats on the same SV causing
1538 lossy conversion chains. (lossless conversion chains are perfectly
1543 SvIOKp is true if the IV slot contains a valid value
1544 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1545 SvNOKp is true if the NV slot contains a valid value
1546 SvNOK is true only if the NV value is accurate
1549 while converting from PV to NV, check to see if converting that NV to an
1550 IV(or UV) would lose accuracy over a direct conversion from PV to
1551 IV(or UV). If it would, cache both conversions, return NV, but mark
1552 SV as IOK NOKp (ie not NOK).
1554 While converting from PV to IV, check to see if converting that IV to an
1555 NV would lose accuracy over a direct conversion from PV to NV. If it
1556 would, cache both conversions, flag similarly.
1558 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1559 correctly because if IV & NV were set NV *always* overruled.
1560 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1561 changes - now IV and NV together means that the two are interchangeable:
1562 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1564 The benefit of this is that operations such as pp_add know that if
1565 SvIOK is true for both left and right operands, then integer addition
1566 can be used instead of floating point (for cases where the result won't
1567 overflow). Before, floating point was always used, which could lead to
1568 loss of precision compared with integer addition.
1570 * making IV and NV equal status should make maths accurate on 64 bit
1572 * may speed up maths somewhat if pp_add and friends start to use
1573 integers when possible instead of fp. (Hopefully the overhead in
1574 looking for SvIOK and checking for overflow will not outweigh the
1575 fp to integer speedup)
1576 * will slow down integer operations (callers of SvIV) on "inaccurate"
1577 values, as the change from SvIOK to SvIOKp will cause a call into
1578 sv_2iv each time rather than a macro access direct to the IV slot
1579 * should speed up number->string conversion on integers as IV is
1580 favoured when IV and NV are equally accurate
1582 ####################################################################
1583 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1584 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1585 On the other hand, SvUOK is true iff UV.
1586 ####################################################################
1588 Your mileage will vary depending your CPU's relative fp to integer
1592 #ifndef NV_PRESERVES_UV
1593 # define IS_NUMBER_UNDERFLOW_IV 1
1594 # define IS_NUMBER_UNDERFLOW_UV 2
1595 # define IS_NUMBER_IV_AND_UV 2
1596 # define IS_NUMBER_OVERFLOW_IV 4
1597 # define IS_NUMBER_OVERFLOW_UV 5
1599 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1601 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1603 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1606 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1607 if (SvNVX(sv) < (NV)IV_MIN) {
1608 (void)SvIOKp_on(sv);
1610 SvIV_set(sv, IV_MIN);
1611 return IS_NUMBER_UNDERFLOW_IV;
1613 if (SvNVX(sv) > (NV)UV_MAX) {
1614 (void)SvIOKp_on(sv);
1617 SvUV_set(sv, UV_MAX);
1618 return IS_NUMBER_OVERFLOW_UV;
1620 (void)SvIOKp_on(sv);
1622 /* Can't use strtol etc to convert this string. (See truth table in
1624 if (SvNVX(sv) <= (UV)IV_MAX) {
1625 SvIV_set(sv, I_V(SvNVX(sv)));
1626 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1627 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1629 /* Integer is imprecise. NOK, IOKp */
1631 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1634 SvUV_set(sv, U_V(SvNVX(sv)));
1635 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1636 if (SvUVX(sv) == UV_MAX) {
1637 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1638 possibly be preserved by NV. Hence, it must be overflow.
1640 return IS_NUMBER_OVERFLOW_UV;
1642 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1644 /* Integer is imprecise. NOK, IOKp */
1646 return IS_NUMBER_OVERFLOW_IV;
1648 #endif /* !NV_PRESERVES_UV*/
1651 S_sv_2iuv_common(pTHX_ SV *sv) {
1654 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1655 * without also getting a cached IV/UV from it at the same time
1656 * (ie PV->NV conversion should detect loss of accuracy and cache
1657 * IV or UV at same time to avoid this. */
1658 /* IV-over-UV optimisation - choose to cache IV if possible */
1660 if (SvTYPE(sv) == SVt_NV)
1661 sv_upgrade(sv, SVt_PVNV);
1663 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1664 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1665 certainly cast into the IV range at IV_MAX, whereas the correct
1666 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1668 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1669 SvIV_set(sv, I_V(SvNVX(sv)));
1670 if (SvNVX(sv) == (NV) SvIVX(sv)
1671 #ifndef NV_PRESERVES_UV
1672 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1673 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1674 /* Don't flag it as "accurately an integer" if the number
1675 came from a (by definition imprecise) NV operation, and
1676 we're outside the range of NV integer precision */
1679 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1680 DEBUG_c(PerlIO_printf(Perl_debug_log,
1681 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1687 /* IV not precise. No need to convert from PV, as NV
1688 conversion would already have cached IV if it detected
1689 that PV->IV would be better than PV->NV->IV
1690 flags already correct - don't set public IOK. */
1691 DEBUG_c(PerlIO_printf(Perl_debug_log,
1692 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1697 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1698 but the cast (NV)IV_MIN rounds to a the value less (more
1699 negative) than IV_MIN which happens to be equal to SvNVX ??
1700 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1701 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1702 (NV)UVX == NVX are both true, but the values differ. :-(
1703 Hopefully for 2s complement IV_MIN is something like
1704 0x8000000000000000 which will be exact. NWC */
1707 SvUV_set(sv, U_V(SvNVX(sv)));
1709 (SvNVX(sv) == (NV) SvUVX(sv))
1710 #ifndef NV_PRESERVES_UV
1711 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1712 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1713 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1714 /* Don't flag it as "accurately an integer" if the number
1715 came from a (by definition imprecise) NV operation, and
1716 we're outside the range of NV integer precision */
1721 DEBUG_c(PerlIO_printf(Perl_debug_log,
1722 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1728 else if (SvPOKp(sv) && SvLEN(sv)) {
1730 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1731 /* We want to avoid a possible problem when we cache an IV/ a UV which
1732 may be later translated to an NV, and the resulting NV is not
1733 the same as the direct translation of the initial string
1734 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1735 be careful to ensure that the value with the .456 is around if the
1736 NV value is requested in the future).
1738 This means that if we cache such an IV/a UV, we need to cache the
1739 NV as well. Moreover, we trade speed for space, and do not
1740 cache the NV if we are sure it's not needed.
1743 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1744 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1745 == IS_NUMBER_IN_UV) {
1746 /* It's definitely an integer, only upgrade to PVIV */
1747 if (SvTYPE(sv) < SVt_PVIV)
1748 sv_upgrade(sv, SVt_PVIV);
1750 } else if (SvTYPE(sv) < SVt_PVNV)
1751 sv_upgrade(sv, SVt_PVNV);
1753 /* If NVs preserve UVs then we only use the UV value if we know that
1754 we aren't going to call atof() below. If NVs don't preserve UVs
1755 then the value returned may have more precision than atof() will
1756 return, even though value isn't perfectly accurate. */
1757 if ((numtype & (IS_NUMBER_IN_UV
1758 #ifdef NV_PRESERVES_UV
1761 )) == IS_NUMBER_IN_UV) {
1762 /* This won't turn off the public IOK flag if it was set above */
1763 (void)SvIOKp_on(sv);
1765 if (!(numtype & IS_NUMBER_NEG)) {
1767 if (value <= (UV)IV_MAX) {
1768 SvIV_set(sv, (IV)value);
1770 /* it didn't overflow, and it was positive. */
1771 SvUV_set(sv, value);
1775 /* 2s complement assumption */
1776 if (value <= (UV)IV_MIN) {
1777 SvIV_set(sv, -(IV)value);
1779 /* Too negative for an IV. This is a double upgrade, but
1780 I'm assuming it will be rare. */
1781 if (SvTYPE(sv) < SVt_PVNV)
1782 sv_upgrade(sv, SVt_PVNV);
1786 SvNV_set(sv, -(NV)value);
1787 SvIV_set(sv, IV_MIN);
1791 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1792 will be in the previous block to set the IV slot, and the next
1793 block to set the NV slot. So no else here. */
1795 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1796 != IS_NUMBER_IN_UV) {
1797 /* It wasn't an (integer that doesn't overflow the UV). */
1798 SvNV_set(sv, Atof(SvPVX_const(sv)));
1800 if (! numtype && ckWARN(WARN_NUMERIC))
1803 #if defined(USE_LONG_DOUBLE)
1804 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1805 PTR2UV(sv), SvNVX(sv)));
1807 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1808 PTR2UV(sv), SvNVX(sv)));
1811 #ifdef NV_PRESERVES_UV
1812 (void)SvIOKp_on(sv);
1814 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1815 SvIV_set(sv, I_V(SvNVX(sv)));
1816 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1819 /* Integer is imprecise. NOK, IOKp */
1821 /* UV will not work better than IV */
1823 if (SvNVX(sv) > (NV)UV_MAX) {
1825 /* Integer is inaccurate. NOK, IOKp, is UV */
1826 SvUV_set(sv, UV_MAX);
1828 SvUV_set(sv, U_V(SvNVX(sv)));
1829 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1830 NV preservse UV so can do correct comparison. */
1831 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1834 /* Integer is imprecise. NOK, IOKp, is UV */
1839 #else /* NV_PRESERVES_UV */
1840 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1841 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1842 /* The IV/UV slot will have been set from value returned by
1843 grok_number above. The NV slot has just been set using
1846 assert (SvIOKp(sv));
1848 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1849 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1850 /* Small enough to preserve all bits. */
1851 (void)SvIOKp_on(sv);
1853 SvIV_set(sv, I_V(SvNVX(sv)));
1854 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1856 /* Assumption: first non-preserved integer is < IV_MAX,
1857 this NV is in the preserved range, therefore: */
1858 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1860 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1864 0 0 already failed to read UV.
1865 0 1 already failed to read UV.
1866 1 0 you won't get here in this case. IV/UV
1867 slot set, public IOK, Atof() unneeded.
1868 1 1 already read UV.
1869 so there's no point in sv_2iuv_non_preserve() attempting
1870 to use atol, strtol, strtoul etc. */
1871 sv_2iuv_non_preserve (sv, numtype);
1874 #endif /* NV_PRESERVES_UV */
1878 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1879 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1882 if (SvTYPE(sv) < SVt_IV)
1883 /* Typically the caller expects that sv_any is not NULL now. */
1884 sv_upgrade(sv, SVt_IV);
1885 /* Return 0 from the caller. */
1892 =for apidoc sv_2iv_flags
1894 Return the integer value of an SV, doing any necessary string
1895 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1896 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1902 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1907 if (SvGMAGICAL(sv)) {
1908 if (flags & SV_GMAGIC)
1913 return I_V(SvNVX(sv));
1915 if (SvPOKp(sv) && SvLEN(sv)) {
1918 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1920 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1921 == IS_NUMBER_IN_UV) {
1922 /* It's definitely an integer */
1923 if (numtype & IS_NUMBER_NEG) {
1924 if (value < (UV)IV_MIN)
1927 if (value < (UV)IV_MAX)
1932 if (ckWARN(WARN_NUMERIC))
1935 return I_V(Atof(SvPVX_const(sv)));
1940 assert(SvTYPE(sv) >= SVt_PVMG);
1941 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1942 } else if (SvTHINKFIRST(sv)) {
1946 SV * const tmpstr=AMG_CALLun(sv,numer);
1947 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1948 return SvIV(tmpstr);
1951 return PTR2IV(SvRV(sv));
1954 sv_force_normal_flags(sv, 0);
1956 if (SvREADONLY(sv) && !SvOK(sv)) {
1957 if (ckWARN(WARN_UNINITIALIZED))
1963 if (S_sv_2iuv_common(aTHX_ sv))
1966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1967 PTR2UV(sv),SvIVX(sv)));
1968 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1972 =for apidoc sv_2uv_flags
1974 Return the unsigned integer value of an SV, doing any necessary string
1975 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1976 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1982 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1987 if (SvGMAGICAL(sv)) {
1988 if (flags & SV_GMAGIC)
1993 return U_V(SvNVX(sv));
1994 if (SvPOKp(sv) && SvLEN(sv)) {
1997 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1999 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2000 == IS_NUMBER_IN_UV) {
2001 /* It's definitely an integer */
2002 if (!(numtype & IS_NUMBER_NEG))
2006 if (ckWARN(WARN_NUMERIC))
2009 return U_V(Atof(SvPVX_const(sv)));
2014 assert(SvTYPE(sv) >= SVt_PVMG);
2015 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2016 } else if (SvTHINKFIRST(sv)) {
2020 SV *const tmpstr = AMG_CALLun(sv,numer);
2021 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2022 return SvUV(tmpstr);
2025 return PTR2UV(SvRV(sv));
2028 sv_force_normal_flags(sv, 0);
2030 if (SvREADONLY(sv) && !SvOK(sv)) {
2031 if (ckWARN(WARN_UNINITIALIZED))
2037 if (S_sv_2iuv_common(aTHX_ sv))
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2042 PTR2UV(sv),SvUVX(sv)));
2043 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2049 Return the num value of an SV, doing any necessary string or integer
2050 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2057 Perl_sv_2nv(pTHX_ register SV *sv)
2062 if (SvGMAGICAL(sv)) {
2066 if (SvPOKp(sv) && SvLEN(sv)) {
2067 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2068 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2070 return Atof(SvPVX_const(sv));
2074 return (NV)SvUVX(sv);
2076 return (NV)SvIVX(sv);
2081 assert(SvTYPE(sv) >= SVt_PVMG);
2082 /* This falls through to the report_uninit near the end of the
2084 } else if (SvTHINKFIRST(sv)) {
2088 SV *const tmpstr = AMG_CALLun(sv,numer);
2089 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2090 return SvNV(tmpstr);
2093 return PTR2NV(SvRV(sv));
2096 sv_force_normal_flags(sv, 0);
2098 if (SvREADONLY(sv) && !SvOK(sv)) {
2099 if (ckWARN(WARN_UNINITIALIZED))
2104 if (SvTYPE(sv) < SVt_NV) {
2105 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2106 sv_upgrade(sv, SVt_NV);
2107 #ifdef USE_LONG_DOUBLE
2109 STORE_NUMERIC_LOCAL_SET_STANDARD();
2110 PerlIO_printf(Perl_debug_log,
2111 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2112 PTR2UV(sv), SvNVX(sv));
2113 RESTORE_NUMERIC_LOCAL();
2117 STORE_NUMERIC_LOCAL_SET_STANDARD();
2118 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2119 PTR2UV(sv), SvNVX(sv));
2120 RESTORE_NUMERIC_LOCAL();
2124 else if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2130 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2131 #ifdef NV_PRESERVES_UV
2134 /* Only set the public NV OK flag if this NV preserves the IV */
2135 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2136 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2137 : (SvIVX(sv) == I_V(SvNVX(sv))))
2143 else if (SvPOKp(sv) && SvLEN(sv)) {
2145 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2146 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2148 #ifdef NV_PRESERVES_UV
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 == IS_NUMBER_IN_UV) {
2151 /* It's definitely an integer */
2152 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2154 SvNV_set(sv, Atof(SvPVX_const(sv)));
2157 SvNV_set(sv, Atof(SvPVX_const(sv)));
2158 /* Only set the public NV OK flag if this NV preserves the value in
2159 the PV at least as well as an IV/UV would.
2160 Not sure how to do this 100% reliably. */
2161 /* if that shift count is out of range then Configure's test is
2162 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2164 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2165 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2166 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2167 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2168 /* Can't use strtol etc to convert this string, so don't try.
2169 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2172 /* value has been set. It may not be precise. */
2173 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2174 /* 2s complement assumption for (UV)IV_MIN */
2175 SvNOK_on(sv); /* Integer is too negative. */
2180 if (numtype & IS_NUMBER_NEG) {
2181 SvIV_set(sv, -(IV)value);
2182 } else if (value <= (UV)IV_MAX) {
2183 SvIV_set(sv, (IV)value);
2185 SvUV_set(sv, value);
2189 if (numtype & IS_NUMBER_NOT_INT) {
2190 /* I believe that even if the original PV had decimals,
2191 they are lost beyond the limit of the FP precision.
2192 However, neither is canonical, so both only get p
2193 flags. NWC, 2000/11/25 */
2194 /* Both already have p flags, so do nothing */
2196 const NV nv = SvNVX(sv);
2197 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2198 if (SvIVX(sv) == I_V(nv)) {
2201 /* It had no "." so it must be integer. */
2205 /* between IV_MAX and NV(UV_MAX).
2206 Could be slightly > UV_MAX */
2208 if (numtype & IS_NUMBER_NOT_INT) {
2209 /* UV and NV both imprecise. */
2211 const UV nv_as_uv = U_V(nv);
2213 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2222 #endif /* NV_PRESERVES_UV */
2225 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2227 assert (SvTYPE(sv) >= SVt_NV);
2228 /* Typically the caller expects that sv_any is not NULL now. */
2229 /* XXX Ilya implies that this is a bug in callers that assume this
2230 and ideally should be fixed. */
2233 #if defined(USE_LONG_DOUBLE)
2235 STORE_NUMERIC_LOCAL_SET_STANDARD();
2236 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2237 PTR2UV(sv), SvNVX(sv));
2238 RESTORE_NUMERIC_LOCAL();
2242 STORE_NUMERIC_LOCAL_SET_STANDARD();
2243 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2244 PTR2UV(sv), SvNVX(sv));
2245 RESTORE_NUMERIC_LOCAL();
2251 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2252 * UV as a string towards the end of buf, and return pointers to start and
2255 * We assume that buf is at least TYPE_CHARS(UV) long.
2259 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2261 char *ptr = buf + TYPE_CHARS(UV);
2262 char * const ebuf = ptr;
2275 *--ptr = '0' + (char)(uv % 10);
2283 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2284 * a regexp to its stringified form.
2288 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2290 const regexp * const re = (regexp *)mg->mg_obj;
2293 const char *fptr = "msix";
2298 bool need_newline = 0;
2299 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2301 while((ch = *fptr++)) {
2303 reflags[left++] = ch;
2306 reflags[right--] = ch;
2311 reflags[left] = '-';
2315 mg->mg_len = re->prelen + 4 + left;
2317 * If /x was used, we have to worry about a regex ending with a
2318 * comment later being embedded within another regex. If so, we don't
2319 * want this regex's "commentization" to leak out to the right part of
2320 * the enclosing regex, we must cap it with a newline.
2322 * So, if /x was used, we scan backwards from the end of the regex. If
2323 * we find a '#' before we find a newline, we need to add a newline
2324 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2325 * we don't need to add anything. -jfriedl
2327 if (PMf_EXTENDED & re->reganch) {
2328 const char *endptr = re->precomp + re->prelen;
2329 while (endptr >= re->precomp) {
2330 const char c = *(endptr--);
2332 break; /* don't need another */
2334 /* we end while in a comment, so we need a newline */
2335 mg->mg_len++; /* save space for it */
2336 need_newline = 1; /* note to add it */
2342 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2343 mg->mg_ptr[0] = '(';
2344 mg->mg_ptr[1] = '?';
2345 Copy(reflags, mg->mg_ptr+2, left, char);
2346 *(mg->mg_ptr+left+2) = ':';
2347 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2349 mg->mg_ptr[mg->mg_len - 2] = '\n';
2350 mg->mg_ptr[mg->mg_len - 1] = ')';
2351 mg->mg_ptr[mg->mg_len] = 0;
2353 PL_reginterp_cnt += re->program[0].next_off;
2355 if (re->reganch & ROPT_UTF8)
2365 =for apidoc sv_2pv_flags
2367 Returns a pointer to the string value of an SV, and sets *lp to its length.
2368 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2370 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2371 usually end up here too.
2377 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2387 if (SvGMAGICAL(sv)) {
2388 if (flags & SV_GMAGIC)
2393 if (flags & SV_MUTABLE_RETURN)
2394 return SvPVX_mutable(sv);
2395 if (flags & SV_CONST_RETURN)
2396 return (char *)SvPVX_const(sv);
2399 if (SvIOKp(sv) || SvNOKp(sv)) {
2400 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2404 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2405 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2407 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2410 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2411 /* Sneaky stuff here */
2412 SV * const tsv = newSVpvn(tbuf, len);
2422 #ifdef FIXNEGATIVEZERO
2423 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2429 SvUPGRADE(sv, SVt_PV);
2432 s = SvGROW_mutable(sv, len + 1);
2435 return memcpy(s, tbuf, len + 1);
2441 assert(SvTYPE(sv) >= SVt_PVMG);
2442 /* This falls through to the report_uninit near the end of the
2444 } else if (SvTHINKFIRST(sv)) {
2448 SV *const tmpstr = AMG_CALLun(sv,string);
2449 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2455 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2456 if (flags & SV_CONST_RETURN) {
2457 pv = (char *) SvPVX_const(tmpstr);
2459 pv = (flags & SV_MUTABLE_RETURN)
2460 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2463 *lp = SvCUR(tmpstr);
2465 pv = sv_2pv_flags(tmpstr, lp, flags);
2477 const SV *const referent = (SV*)SvRV(sv);
2480 tsv = sv_2mortal(newSVpvs("NULLREF"));
2481 } else if (SvTYPE(referent) == SVt_PVMG
2482 && ((SvFLAGS(referent) &
2483 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2484 == (SVs_OBJECT|SVs_SMG))
2485 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2486 return stringify_regexp(sv, mg, lp);
2488 const char *const typestr = sv_reftype(referent, 0);
2490 tsv = sv_newmortal();
2491 if (SvOBJECT(referent)) {
2492 const char *const name = HvNAME_get(SvSTASH(referent));
2493 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2494 name ? name : "__ANON__" , typestr,
2498 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2506 if (SvREADONLY(sv) && !SvOK(sv)) {
2507 if (ckWARN(WARN_UNINITIALIZED))
2514 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2515 /* I'm assuming that if both IV and NV are equally valid then
2516 converting the IV is going to be more efficient */
2517 const U32 isIOK = SvIOK(sv);
2518 const U32 isUIOK = SvIsUV(sv);
2519 char buf[TYPE_CHARS(UV)];
2522 if (SvTYPE(sv) < SVt_PVIV)
2523 sv_upgrade(sv, SVt_PVIV);
2524 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2525 /* inlined from sv_setpvn */
2526 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2527 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2528 SvCUR_set(sv, ebuf - ptr);
2538 else if (SvNOKp(sv)) {
2539 const int olderrno = errno;
2540 if (SvTYPE(sv) < SVt_PVNV)
2541 sv_upgrade(sv, SVt_PVNV);
2542 /* The +20 is pure guesswork. Configure test needed. --jhi */
2543 s = SvGROW_mutable(sv, NV_DIG + 20);
2544 /* some Xenix systems wipe out errno here */
2546 if (SvNVX(sv) == 0.0)
2547 (void)strcpy(s,"0");
2551 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2554 #ifdef FIXNEGATIVEZERO
2555 if (*s == '-' && s[1] == '0' && !s[2])
2565 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2569 if (SvTYPE(sv) < SVt_PV)
2570 /* Typically the caller expects that sv_any is not NULL now. */
2571 sv_upgrade(sv, SVt_PV);
2575 const STRLEN len = s - SvPVX_const(sv);
2581 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2582 PTR2UV(sv),SvPVX_const(sv)));
2583 if (flags & SV_CONST_RETURN)
2584 return (char *)SvPVX_const(sv);
2585 if (flags & SV_MUTABLE_RETURN)
2586 return SvPVX_mutable(sv);
2591 =for apidoc sv_copypv
2593 Copies a stringified representation of the source SV into the
2594 destination SV. Automatically performs any necessary mg_get and
2595 coercion of numeric values into strings. Guaranteed to preserve
2596 UTF-8 flag even from overloaded objects. Similar in nature to
2597 sv_2pv[_flags] but operates directly on an SV instead of just the
2598 string. Mostly uses sv_2pv_flags to do its work, except when that
2599 would lose the UTF-8'ness of the PV.
2605 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2608 const char * const s = SvPV_const(ssv,len);
2609 sv_setpvn(dsv,s,len);
2617 =for apidoc sv_2pvbyte
2619 Return a pointer to the byte-encoded representation of the SV, and set *lp
2620 to its length. May cause the SV to be downgraded from UTF-8 as a
2623 Usually accessed via the C<SvPVbyte> macro.
2629 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2631 sv_utf8_downgrade(sv,0);
2632 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2636 =for apidoc sv_2pvutf8
2638 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2639 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2641 Usually accessed via the C<SvPVutf8> macro.
2647 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2649 sv_utf8_upgrade(sv);
2650 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2655 =for apidoc sv_2bool
2657 This function is only called on magical items, and is only used by
2658 sv_true() or its macro equivalent.
2664 Perl_sv_2bool(pTHX_ register SV *sv)
2673 SV * const tmpsv = AMG_CALLun(sv,bool_);
2674 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2675 return (bool)SvTRUE(tmpsv);
2677 return SvRV(sv) != 0;
2680 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2682 (*sv->sv_u.svu_pv > '0' ||
2683 Xpvtmp->xpv_cur > 1 ||
2684 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2691 return SvIVX(sv) != 0;
2694 return SvNVX(sv) != 0.0;
2702 =for apidoc sv_utf8_upgrade
2704 Converts the PV of an SV to its UTF-8-encoded form.
2705 Forces the SV to string form if it is not already.
2706 Always sets the SvUTF8 flag to avoid future validity checks even
2707 if all the bytes have hibit clear.
2709 This is not as a general purpose byte encoding to Unicode interface:
2710 use the Encode extension for that.
2712 =for apidoc sv_utf8_upgrade_flags
2714 Converts the PV of an SV to its UTF-8-encoded form.
2715 Forces the SV to string form if it is not already.
2716 Always sets the SvUTF8 flag to avoid future validity checks even
2717 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2718 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2719 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2721 This is not as a general purpose byte encoding to Unicode interface:
2722 use the Encode extension for that.
2728 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2731 if (sv == &PL_sv_undef)
2735 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2736 (void) sv_2pv_flags(sv,&len, flags);
2740 (void) SvPV_force(sv,len);
2749 sv_force_normal_flags(sv, 0);
2752 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2753 sv_recode_to_utf8(sv, PL_encoding);
2754 else { /* Assume Latin-1/EBCDIC */
2755 /* This function could be much more efficient if we
2756 * had a FLAG in SVs to signal if there are any hibit
2757 * chars in the PV. Given that there isn't such a flag
2758 * make the loop as fast as possible. */
2759 const U8 * const s = (U8 *) SvPVX_const(sv);
2760 const U8 * const e = (U8 *) SvEND(sv);
2765 /* Check for hi bit */
2766 if (!NATIVE_IS_INVARIANT(ch)) {
2767 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2768 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2770 SvPV_free(sv); /* No longer using what was there before. */
2771 SvPV_set(sv, (char*)recoded);
2772 SvCUR_set(sv, len - 1);
2773 SvLEN_set(sv, len); /* No longer know the real size. */
2777 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2784 =for apidoc sv_utf8_downgrade
2786 Attempts to convert the PV of an SV from characters to bytes.
2787 If the PV contains a character beyond byte, this conversion will fail;
2788 in this case, either returns false or, if C<fail_ok> is not
2791 This is not as a general purpose Unicode to byte encoding interface:
2792 use the Encode extension for that.
2798 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2801 if (SvPOKp(sv) && SvUTF8(sv)) {
2807 sv_force_normal_flags(sv, 0);
2809 s = (U8 *) SvPV(sv, len);
2810 if (!utf8_to_bytes(s, &len)) {
2815 Perl_croak(aTHX_ "Wide character in %s",
2818 Perl_croak(aTHX_ "Wide character");
2829 =for apidoc sv_utf8_encode
2831 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2832 flag off so that it looks like octets again.
2838 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2840 (void) sv_utf8_upgrade(sv);
2842 sv_force_normal_flags(sv, 0);
2844 if (SvREADONLY(sv)) {
2845 Perl_croak(aTHX_ PL_no_modify);
2851 =for apidoc sv_utf8_decode
2853 If the PV of the SV is an octet sequence in UTF-8
2854 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2855 so that it looks like a character. If the PV contains only single-byte
2856 characters, the C<SvUTF8> flag stays being off.
2857 Scans PV for validity and returns false if the PV is invalid UTF-8.
2863 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2869 /* The octets may have got themselves encoded - get them back as
2872 if (!sv_utf8_downgrade(sv, TRUE))
2875 /* it is actually just a matter of turning the utf8 flag on, but
2876 * we want to make sure everything inside is valid utf8 first.
2878 c = (const U8 *) SvPVX_const(sv);
2879 if (!is_utf8_string(c, SvCUR(sv)+1))
2881 e = (const U8 *) SvEND(sv);
2884 if (!UTF8_IS_INVARIANT(ch)) {
2894 =for apidoc sv_setsv
2896 Copies the contents of the source SV C<ssv> into the destination SV
2897 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2898 function if the source SV needs to be reused. Does not handle 'set' magic.
2899 Loosely speaking, it performs a copy-by-value, obliterating any previous
2900 content of the destination.
2902 You probably want to use one of the assortment of wrappers, such as
2903 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2904 C<SvSetMagicSV_nosteal>.
2906 =for apidoc sv_setsv_flags
2908 Copies the contents of the source SV C<ssv> into the destination SV
2909 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2910 function if the source SV needs to be reused. Does not handle 'set' magic.
2911 Loosely speaking, it performs a copy-by-value, obliterating any previous
2912 content of the destination.
2913 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2914 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2915 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2916 and C<sv_setsv_nomg> are implemented in terms of this function.
2918 You probably want to use one of the assortment of wrappers, such as
2919 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2920 C<SvSetMagicSV_nosteal>.
2922 This is the primary function for copying scalars, and most other
2923 copy-ish functions and macros use this underneath.
2929 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
2931 if (dtype != SVt_PVGV) {
2932 const char * const name = GvNAME(sstr);
2933 const STRLEN len = GvNAMELEN(sstr);
2934 /* don't upgrade SVt_PVLV: it can hold a glob */
2935 if (dtype != SVt_PVLV)
2936 sv_upgrade(dstr, SVt_PVGV);
2937 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
2938 GvSTASH(dstr) = GvSTASH(sstr);
2940 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
2941 GvNAME(dstr) = savepvn(name, len);
2942 GvNAMELEN(dstr) = len;
2943 SvFAKE_on(dstr); /* can coerce to non-glob */
2946 #ifdef GV_UNIQUE_CHECK
2947 if (GvUNIQUE((GV*)dstr)) {
2948 Perl_croak(aTHX_ PL_no_modify);
2952 (void)SvOK_off(dstr);
2953 GvINTRO_off(dstr); /* one-shot flag */
2955 GvGP(dstr) = gp_ref(GvGP(sstr));
2956 if (SvTAINTED(sstr))
2958 if (GvIMPORTED(dstr) != GVf_IMPORTED
2959 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2961 GvIMPORTED_on(dstr);
2968 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
2969 SV * const sref = SvREFCNT_inc(SvRV(sstr));
2971 const int intro = GvINTRO(dstr);
2973 #ifdef GV_UNIQUE_CHECK
2974 if (GvUNIQUE((GV*)dstr)) {
2975 Perl_croak(aTHX_ PL_no_modify);
2980 GvINTRO_off(dstr); /* one-shot flag */
2981 GvLINE(dstr) = CopLINE(PL_curcop);
2982 GvEGV(dstr) = (GV*)dstr;
2985 switch (SvTYPE(sref)) {
2988 SAVEGENERICSV(GvAV(dstr));
2990 dref = (SV*)GvAV(dstr);
2991 GvAV(dstr) = (AV*)sref;
2992 if (!GvIMPORTED_AV(dstr)
2993 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2995 GvIMPORTED_AV_on(dstr);
3000 SAVEGENERICSV(GvHV(dstr));
3002 dref = (SV*)GvHV(dstr);
3003 GvHV(dstr) = (HV*)sref;
3004 if (!GvIMPORTED_HV(dstr)
3005 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3007 GvIMPORTED_HV_on(dstr);
3012 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3013 SvREFCNT_dec(GvCV(dstr));
3014 GvCV(dstr) = Nullcv;
3015 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3016 PL_sub_generation++;
3018 SAVEGENERICSV(GvCV(dstr));
3021 dref = (SV*)GvCV(dstr);
3022 if (GvCV(dstr) != (CV*)sref) {
3023 CV* const cv = GvCV(dstr);
3025 if (!GvCVGEN((GV*)dstr) &&
3026 (CvROOT(cv) || CvXSUB(cv)))
3028 /* Redefining a sub - warning is mandatory if
3029 it was a const and its value changed. */
3030 if (CvCONST(cv) && CvCONST((CV*)sref)
3031 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3032 /* They are 2 constant subroutines generated from
3033 the same constant. This probably means that
3034 they are really the "same" proxy subroutine
3035 instantiated in 2 places. Most likely this is
3036 when a constant is exported twice. Don't warn.
3039 else if (ckWARN(WARN_REDEFINE)
3041 && (!CvCONST((CV*)sref)
3042 || sv_cmp(cv_const_sv(cv),
3043 cv_const_sv((CV*)sref))))) {
3044 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3046 ? "Constant subroutine %s::%s redefined"
3047 : "Subroutine %s::%s redefined",
3048 HvNAME_get(GvSTASH((GV*)dstr)),
3049 GvENAME((GV*)dstr));
3053 cv_ckproto(cv, (GV*)dstr,
3054 SvPOK(sref) ? SvPVX_const(sref) : Nullch);
3056 GvCV(dstr) = (CV*)sref;
3057 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3058 GvASSUMECV_on(dstr);
3059 PL_sub_generation++;
3061 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3062 GvIMPORTED_CV_on(dstr);
3067 SAVEGENERICSV(GvIOp(dstr));
3069 dref = (SV*)GvIOp(dstr);
3070 GvIOp(dstr) = (IO*)sref;
3074 SAVEGENERICSV(GvFORM(dstr));
3076 dref = (SV*)GvFORM(dstr);
3077 GvFORM(dstr) = (CV*)sref;
3081 SAVEGENERICSV(GvSV(dstr));
3083 dref = (SV*)GvSV(dstr);
3085 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3086 GvIMPORTED_SV_on(dstr);
3092 if (SvTAINTED(sstr))
3098 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3101 register U32 sflags;
3107 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3109 sstr = &PL_sv_undef;
3110 stype = SvTYPE(sstr);
3111 dtype = SvTYPE(dstr);
3116 /* need to nuke the magic */
3118 SvRMAGICAL_off(dstr);
3121 /* There's a lot of redundancy below but we're going for speed here */
3126 if (dtype != SVt_PVGV) {
3127 (void)SvOK_off(dstr);
3135 sv_upgrade(dstr, SVt_IV);
3138 sv_upgrade(dstr, SVt_PVNV);
3142 sv_upgrade(dstr, SVt_PVIV);
3145 (void)SvIOK_only(dstr);
3146 SvIV_set(dstr, SvIVX(sstr));
3149 if (SvTAINTED(sstr))
3160 sv_upgrade(dstr, SVt_NV);
3165 sv_upgrade(dstr, SVt_PVNV);
3168 SvNV_set(dstr, SvNVX(sstr));
3169 (void)SvNOK_only(dstr);
3170 if (SvTAINTED(sstr))
3178 sv_upgrade(dstr, SVt_RV);
3179 else if (dtype == SVt_PVGV &&
3180 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3183 if (GvIMPORTED(dstr) != GVf_IMPORTED
3184 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3186 GvIMPORTED_on(dstr);
3191 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3195 #ifdef PERL_OLD_COPY_ON_WRITE
3196 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3197 if (dtype < SVt_PVIV)
3198 sv_upgrade(dstr, SVt_PVIV);
3205 sv_upgrade(dstr, SVt_PV);
3208 if (dtype < SVt_PVIV)
3209 sv_upgrade(dstr, SVt_PVIV);
3212 if (dtype < SVt_PVNV)
3213 sv_upgrade(dstr, SVt_PVNV);
3220 const char * const type = sv_reftype(sstr,0);
3222 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3224 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3229 if (dtype <= SVt_PVGV) {
3230 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3235 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3237 if ((int)SvTYPE(sstr) != stype) {
3238 stype = SvTYPE(sstr);
3239 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3240 return S_glob_assign(aTHX_ dstr, sstr, dtype);
3243 if (stype == SVt_PVLV)
3244 SvUPGRADE(dstr, SVt_PVNV);
3246 SvUPGRADE(dstr, (U32)stype);
3249 sflags = SvFLAGS(sstr);
3251 if (sflags & SVf_ROK) {
3252 if (dtype >= SVt_PV) {
3253 if (dtype == SVt_PVGV)
3254 return S_pvgv_assign(aTHX_ dstr, sstr);
3255 if (SvPVX_const(dstr)) {
3261 (void)SvOK_off(dstr);
3262 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3263 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_ROK
3265 if (sflags & SVp_NOK) {
3266 SvNV_set(dstr, SvNVX(sstr));
3268 if (sflags & SVp_IOK) {
3269 /* Must do this otherwise some other overloaded use of 0x80000000
3270 gets confused. Probably 0x80000000 */
3271 if (sflags & SVf_IVisUV)
3273 SvIV_set(dstr, SvIVX(sstr));
3276 else if (sflags & SVp_POK) {
3280 * Check to see if we can just swipe the string. If so, it's a
3281 * possible small lose on short strings, but a big win on long ones.
3282 * It might even be a win on short strings if SvPVX_const(dstr)
3283 * has to be allocated and SvPVX_const(sstr) has to be freed.
3286 /* Whichever path we take through the next code, we want this true,
3287 and doing it now facilitates the COW check. */
3288 (void)SvPOK_only(dstr);
3291 /* We're not already COW */
3292 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3293 #ifndef PERL_OLD_COPY_ON_WRITE
3294 /* or we are, but dstr isn't a suitable target. */
3295 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3300 (sflags & SVs_TEMP) && /* slated for free anyway? */
3301 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3302 (!(flags & SV_NOSTEAL)) &&
3303 /* and we're allowed to steal temps */
3304 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3305 SvLEN(sstr) && /* and really is a string */
3306 /* and won't be needed again, potentially */
3307 !(PL_op && PL_op->op_type == OP_AASSIGN))
3308 #ifdef PERL_OLD_COPY_ON_WRITE
3309 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3310 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3311 && SvTYPE(sstr) >= SVt_PVIV)
3314 /* Failed the swipe test, and it's not a shared hash key either.
3315 Have to copy the string. */
3316 STRLEN len = SvCUR(sstr);
3317 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3318 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3319 SvCUR_set(dstr, len);
3320 *SvEND(dstr) = '\0';
3322 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3324 /* Either it's a shared hash key, or it's suitable for
3325 copy-on-write or we can swipe the string. */
3327 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3331 #ifdef PERL_OLD_COPY_ON_WRITE
3333 /* I believe I should acquire a global SV mutex if
3334 it's a COW sv (not a shared hash key) to stop
3335 it going un copy-on-write.
3336 If the source SV has gone un copy on write between up there
3337 and down here, then (assert() that) it is of the correct
3338 form to make it copy on write again */
3339 if ((sflags & (SVf_FAKE | SVf_READONLY))
3340 != (SVf_FAKE | SVf_READONLY)) {
3341 SvREADONLY_on(sstr);
3343 /* Make the source SV into a loop of 1.
3344 (about to become 2) */
3345 SV_COW_NEXT_SV_SET(sstr, sstr);
3349 /* Initial code is common. */
3350 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3355 /* making another shared SV. */
3356 STRLEN cur = SvCUR(sstr);
3357 STRLEN len = SvLEN(sstr);
3358 #ifdef PERL_OLD_COPY_ON_WRITE
3360 assert (SvTYPE(dstr) >= SVt_PVIV);
3361 /* SvIsCOW_normal */
3362 /* splice us in between source and next-after-source. */
3363 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3364 SV_COW_NEXT_SV_SET(sstr, dstr);
3365 SvPV_set(dstr, SvPVX_mutable(sstr));
3369 /* SvIsCOW_shared_hash */
3370 DEBUG_C(PerlIO_printf(Perl_debug_log,
3371 "Copy on write: Sharing hash\n"));
3373 assert (SvTYPE(dstr) >= SVt_PV);
3375 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3377 SvLEN_set(dstr, len);
3378 SvCUR_set(dstr, cur);
3379 SvREADONLY_on(dstr);
3381 /* Relesase a global SV mutex. */
3384 { /* Passes the swipe test. */
3385 SvPV_set(dstr, SvPVX_mutable(sstr));
3386 SvLEN_set(dstr, SvLEN(sstr));
3387 SvCUR_set(dstr, SvCUR(sstr));
3390 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3391 SvPV_set(sstr, NULL);
3397 if (sflags & SVp_NOK) {
3398 SvNV_set(dstr, SvNVX(sstr));
3400 if (sflags & SVp_IOK) {
3401 SvRELEASE_IVX(dstr);
3402 SvIV_set(dstr, SvIVX(sstr));
3403 /* Must do this otherwise some other overloaded use of 0x80000000
3404 gets confused. I guess SVpbm_VALID */
3405 if (sflags & SVf_IVisUV)
3408 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3410 const MAGIC * const smg = SvVOK(sstr);
3412 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3413 smg->mg_ptr, smg->mg_len);
3414 SvRMAGICAL_on(dstr);
3418 else if (sflags & (SVp_IOK|SVp_NOK)) {
3419 (void)SvOK_off(dstr);
3420 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3421 if (sflags & SVp_IOK) {
3422 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3423 SvIV_set(dstr, SvIVX(sstr));
3425 if (sflags & SVp_NOK) {
3426 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3427 SvNV_set(dstr, SvNVX(sstr));
3431 if (dtype == SVt_PVGV) {
3432 if (ckWARN(WARN_MISC))
3433 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3436 (void)SvOK_off(dstr);
3438 if (SvTAINTED(sstr))
3443 =for apidoc sv_setsv_mg
3445 Like C<sv_setsv>, but also handles 'set' magic.
3451 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3453 sv_setsv(dstr,sstr);
3457 #ifdef PERL_OLD_COPY_ON_WRITE
3459 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3461 STRLEN cur = SvCUR(sstr);
3462 STRLEN len = SvLEN(sstr);
3463 register char *new_pv;
3466 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3474 if (SvTHINKFIRST(dstr))
3475 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3476 else if (SvPVX_const(dstr))
3477 Safefree(SvPVX_const(dstr));
3481 SvUPGRADE(dstr, SVt_PVIV);
3483 assert (SvPOK(sstr));
3484 assert (SvPOKp(sstr));
3485 assert (!SvIOK(sstr));
3486 assert (!SvIOKp(sstr));
3487 assert (!SvNOK(sstr));
3488 assert (!SvNOKp(sstr));
3490 if (SvIsCOW(sstr)) {
3492 if (SvLEN(sstr) == 0) {
3493 /* source is a COW shared hash key. */
3494 DEBUG_C(PerlIO_printf(Perl_debug_log,
3495 "Fast copy on write: Sharing hash\n"));
3496 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3499 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3501 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3502 SvUPGRADE(sstr, SVt_PVIV);
3503 SvREADONLY_on(sstr);
3505 DEBUG_C(PerlIO_printf(Perl_debug_log,
3506 "Fast copy on write: Converting sstr to COW\n"));
3507 SV_COW_NEXT_SV_SET(dstr, sstr);
3509 SV_COW_NEXT_SV_SET(sstr, dstr);
3510 new_pv = SvPVX_mutable(sstr);
3513 SvPV_set(dstr, new_pv);
3514 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3517 SvLEN_set(dstr, len);
3518 SvCUR_set(dstr, cur);
3527 =for apidoc sv_setpvn
3529 Copies a string into an SV. The C<len> parameter indicates the number of
3530 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3531 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3537 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3540 register char *dptr;
3542 SV_CHECK_THINKFIRST_COW_DROP(sv);
3548 /* len is STRLEN which is unsigned, need to copy to signed */
3551 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3553 SvUPGRADE(sv, SVt_PV);
3555 dptr = SvGROW(sv, len + 1);
3556 Move(ptr,dptr,len,char);
3559 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3564 =for apidoc sv_setpvn_mg
3566 Like C<sv_setpvn>, but also handles 'set' magic.
3572 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3574 sv_setpvn(sv,ptr,len);
3579 =for apidoc sv_setpv
3581 Copies a string into an SV. The string must be null-terminated. Does not
3582 handle 'set' magic. See C<sv_setpv_mg>.
3588 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3591 register STRLEN len;
3593 SV_CHECK_THINKFIRST_COW_DROP(sv);
3599 SvUPGRADE(sv, SVt_PV);
3601 SvGROW(sv, len + 1);
3602 Move(ptr,SvPVX(sv),len+1,char);
3604 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3609 =for apidoc sv_setpv_mg
3611 Like C<sv_setpv>, but also handles 'set' magic.
3617 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3624 =for apidoc sv_usepvn
3626 Tells an SV to use C<ptr> to find its string value. Normally the string is
3627 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3628 The C<ptr> should point to memory that was allocated by C<malloc>. The
3629 string length, C<len>, must be supplied. This function will realloc the
3630 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3631 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3632 See C<sv_usepvn_mg>.
3638 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3642 SV_CHECK_THINKFIRST_COW_DROP(sv);
3643 SvUPGRADE(sv, SVt_PV);
3648 if (SvPVX_const(sv))
3651 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3652 ptr = saferealloc (ptr, allocate);
3655 SvLEN_set(sv, allocate);
3657 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3662 =for apidoc sv_usepvn_mg
3664 Like C<sv_usepvn>, but also handles 'set' magic.
3670 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3672 sv_usepvn(sv,ptr,len);
3676 #ifdef PERL_OLD_COPY_ON_WRITE
3677 /* Need to do this *after* making the SV normal, as we need the buffer
3678 pointer to remain valid until after we've copied it. If we let go too early,
3679 another thread could invalidate it by unsharing last of the same hash key
3680 (which it can do by means other than releasing copy-on-write Svs)
3681 or by changing the other copy-on-write SVs in the loop. */
3683 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3685 if (len) { /* this SV was SvIsCOW_normal(sv) */
3686 /* we need to find the SV pointing to us. */
3687 SV * const current = SV_COW_NEXT_SV(after);
3689 if (current == sv) {
3690 /* The SV we point to points back to us (there were only two of us
3692 Hence other SV is no longer copy on write either. */
3694 SvREADONLY_off(after);
3696 /* We need to follow the pointers around the loop. */
3698 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3701 /* don't loop forever if the structure is bust, and we have
3702 a pointer into a closed loop. */
3703 assert (current != after);
3704 assert (SvPVX_const(current) == pvx);
3706 /* Make the SV before us point to the SV after us. */
3707 SV_COW_NEXT_SV_SET(current, after);
3710 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3715 Perl_sv_release_IVX(pTHX_ register SV *sv)
3718 sv_force_normal_flags(sv, 0);
3724 =for apidoc sv_force_normal_flags
3726 Undo various types of fakery on an SV: if the PV is a shared string, make
3727 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3728 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3729 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3730 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3731 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3732 set to some other value.) In addition, the C<flags> parameter gets passed to
3733 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3734 with flags set to 0.
3740 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3743 #ifdef PERL_OLD_COPY_ON_WRITE
3744 if (SvREADONLY(sv)) {
3745 /* At this point I believe I should acquire a global SV mutex. */
3747 const char * const pvx = SvPVX_const(sv);
3748 const STRLEN len = SvLEN(sv);
3749 const STRLEN cur = SvCUR(sv);
3750 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3752 PerlIO_printf(Perl_debug_log,
3753 "Copy on write: Force normal %ld\n",
3759 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3762 if (flags & SV_COW_DROP_PV) {
3763 /* OK, so we don't need to copy our buffer. */
3766 SvGROW(sv, cur + 1);
3767 Move(pvx,SvPVX(sv),cur,char);
3771 sv_release_COW(sv, pvx, len, next);
3776 else if (IN_PERL_RUNTIME)
3777 Perl_croak(aTHX_ PL_no_modify);
3778 /* At this point I believe that I can drop the global SV mutex. */
3781 if (SvREADONLY(sv)) {
3783 const char * const pvx = SvPVX_const(sv);
3784 const STRLEN len = SvCUR(sv);
3787 SvPV_set(sv, Nullch);
3789 SvGROW(sv, len + 1);
3790 Move(pvx,SvPVX(sv),len,char);
3792 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3794 else if (IN_PERL_RUNTIME)
3795 Perl_croak(aTHX_ PL_no_modify);
3799 sv_unref_flags(sv, flags);
3800 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3807 Efficient removal of characters from the beginning of the string buffer.
3808 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3809 the string buffer. The C<ptr> becomes the first character of the adjusted
3810 string. Uses the "OOK hack".
3811 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3812 refer to the same chunk of data.
3818 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3820 register STRLEN delta;
3821 if (!ptr || !SvPOKp(sv))
3823 delta = ptr - SvPVX_const(sv);
3824 SV_CHECK_THINKFIRST(sv);
3825 if (SvTYPE(sv) < SVt_PVIV)
3826 sv_upgrade(sv,SVt_PVIV);
3829 if (!SvLEN(sv)) { /* make copy of shared string */
3830 const char *pvx = SvPVX_const(sv);
3831 const STRLEN len = SvCUR(sv);
3832 SvGROW(sv, len + 1);
3833 Move(pvx,SvPVX(sv),len,char);
3837 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3838 and we do that anyway inside the SvNIOK_off
3840 SvFLAGS(sv) |= SVf_OOK;
3843 SvLEN_set(sv, SvLEN(sv) - delta);
3844 SvCUR_set(sv, SvCUR(sv) - delta);
3845 SvPV_set(sv, SvPVX(sv) + delta);
3846 SvIV_set(sv, SvIVX(sv) + delta);
3850 =for apidoc sv_catpvn
3852 Concatenates the string onto the end of the string which is in the SV. The
3853 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3854 status set, then the bytes appended should be valid UTF-8.
3855 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3857 =for apidoc sv_catpvn_flags
3859 Concatenates the string onto the end of the string which is in the SV. The
3860 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3861 status set, then the bytes appended should be valid UTF-8.
3862 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3863 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3864 in terms of this function.
3870 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3874 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3876 SvGROW(dsv, dlen + slen + 1);
3878 sstr = SvPVX_const(dsv);
3879 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3880 SvCUR_set(dsv, SvCUR(dsv) + slen);
3882 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3884 if (flags & SV_SMAGIC)
3889 =for apidoc sv_catsv
3891 Concatenates the string from SV C<ssv> onto the end of the string in
3892 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3893 not 'set' magic. See C<sv_catsv_mg>.
3895 =for apidoc sv_catsv_flags
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>. If C<flags> has C<SV_GMAGIC>
3899 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3900 and C<sv_catsv_nomg> are implemented in terms of this function.
3905 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3910 const char *spv = SvPV_const(ssv, slen);
3912 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3913 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3914 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3915 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3916 dsv->sv_flags doesn't have that bit set.
3917 Andy Dougherty 12 Oct 2001
3919 const I32 sutf8 = DO_UTF8(ssv);
3922 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3924 dutf8 = DO_UTF8(dsv);
3926 if (dutf8 != sutf8) {
3928 /* Not modifying source SV, so taking a temporary copy. */
3929 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3931 sv_utf8_upgrade(csv);
3932 spv = SvPV_const(csv, slen);
3935 sv_utf8_upgrade_nomg(dsv);
3937 sv_catpvn_nomg(dsv, spv, slen);
3940 if (flags & SV_SMAGIC)
3945 =for apidoc sv_catpv
3947 Concatenates the string onto the end of the string which is in the SV.
3948 If the SV has the UTF-8 status set, then the bytes appended should be
3949 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3954 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3957 register STRLEN len;
3963 junk = SvPV_force(sv, tlen);
3965 SvGROW(sv, tlen + len + 1);
3967 ptr = SvPVX_const(sv);
3968 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3969 SvCUR_set(sv, SvCUR(sv) + len);
3970 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3975 =for apidoc sv_catpv_mg
3977 Like C<sv_catpv>, but also handles 'set' magic.
3983 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3992 Creates a new SV. A non-zero C<len> parameter indicates the number of
3993 bytes of preallocated string space the SV should have. An extra byte for a
3994 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
3995 space is allocated.) The reference count for the new SV is set to 1.
3997 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
3998 parameter, I<x>, a debug aid which allowed callers to identify themselves.
3999 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4000 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4001 modules supporting older perls.
4007 Perl_newSV(pTHX_ STRLEN len)
4014 sv_upgrade(sv, SVt_PV);
4015 SvGROW(sv, len + 1);
4020 =for apidoc sv_magicext
4022 Adds magic to an SV, upgrading it if necessary. Applies the
4023 supplied vtable and returns a pointer to the magic added.
4025 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4026 In particular, you can add magic to SvREADONLY SVs, and add more than
4027 one instance of the same 'how'.
4029 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4030 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4031 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4032 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4034 (This is now used as a subroutine by C<sv_magic>.)
4039 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4040 const char* name, I32 namlen)
4045 if (SvTYPE(sv) < SVt_PVMG) {
4046 SvUPGRADE(sv, SVt_PVMG);
4048 Newxz(mg, 1, MAGIC);
4049 mg->mg_moremagic = SvMAGIC(sv);
4050 SvMAGIC_set(sv, mg);
4052 /* Sometimes a magic contains a reference loop, where the sv and
4053 object refer to each other. To prevent a reference loop that
4054 would prevent such objects being freed, we look for such loops
4055 and if we find one we avoid incrementing the object refcount.
4057 Note we cannot do this to avoid self-tie loops as intervening RV must
4058 have its REFCNT incremented to keep it in existence.
4061 if (!obj || obj == sv ||
4062 how == PERL_MAGIC_arylen ||
4063 how == PERL_MAGIC_qr ||
4064 how == PERL_MAGIC_symtab ||
4065 (SvTYPE(obj) == SVt_PVGV &&
4066 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4067 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4068 GvFORM(obj) == (CV*)sv)))
4073 mg->mg_obj = SvREFCNT_inc(obj);
4074 mg->mg_flags |= MGf_REFCOUNTED;
4077 /* Normal self-ties simply pass a null object, and instead of
4078 using mg_obj directly, use the SvTIED_obj macro to produce a
4079 new RV as needed. For glob "self-ties", we are tieing the PVIO
4080 with an RV obj pointing to the glob containing the PVIO. In
4081 this case, to avoid a reference loop, we need to weaken the
4085 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4086 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4092 mg->mg_len = namlen;
4095 mg->mg_ptr = savepvn(name, namlen);
4096 else if (namlen == HEf_SVKEY)
4097 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4099 mg->mg_ptr = (char *) name;
4101 mg->mg_virtual = vtable;
4105 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4110 =for apidoc sv_magic
4112 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4113 then adds a new magic item of type C<how> to the head of the magic list.
4115 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4116 handling of the C<name> and C<namlen> arguments.
4118 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4119 to add more than one instance of the same 'how'.
4125 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4131 #ifdef PERL_OLD_COPY_ON_WRITE
4133 sv_force_normal_flags(sv, 0);
4135 if (SvREADONLY(sv)) {
4137 /* its okay to attach magic to shared strings; the subsequent
4138 * upgrade to PVMG will unshare the string */
4139 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4142 && how != PERL_MAGIC_regex_global
4143 && how != PERL_MAGIC_bm
4144 && how != PERL_MAGIC_fm
4145 && how != PERL_MAGIC_sv
4146 && how != PERL_MAGIC_backref
4149 Perl_croak(aTHX_ PL_no_modify);
4152 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4153 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4154 /* sv_magic() refuses to add a magic of the same 'how' as an
4157 if (how == PERL_MAGIC_taint)
4165 vtable = &PL_vtbl_sv;
4167 case PERL_MAGIC_overload:
4168 vtable = &PL_vtbl_amagic;
4170 case PERL_MAGIC_overload_elem:
4171 vtable = &PL_vtbl_amagicelem;
4173 case PERL_MAGIC_overload_table:
4174 vtable = &PL_vtbl_ovrld;
4177 vtable = &PL_vtbl_bm;
4179 case PERL_MAGIC_regdata:
4180 vtable = &PL_vtbl_regdata;
4182 case PERL_MAGIC_regdatum:
4183 vtable = &PL_vtbl_regdatum;
4185 case PERL_MAGIC_env:
4186 vtable = &PL_vtbl_env;
4189 vtable = &PL_vtbl_fm;
4191 case PERL_MAGIC_envelem:
4192 vtable = &PL_vtbl_envelem;
4194 case PERL_MAGIC_regex_global:
4195 vtable = &PL_vtbl_mglob;
4197 case PERL_MAGIC_isa:
4198 vtable = &PL_vtbl_isa;
4200 case PERL_MAGIC_isaelem:
4201 vtable = &PL_vtbl_isaelem;
4203 case PERL_MAGIC_nkeys:
4204 vtable = &PL_vtbl_nkeys;
4206 case PERL_MAGIC_dbfile:
4209 case PERL_MAGIC_dbline:
4210 vtable = &PL_vtbl_dbline;
4212 #ifdef USE_LOCALE_COLLATE
4213 case PERL_MAGIC_collxfrm:
4214 vtable = &PL_vtbl_collxfrm;
4216 #endif /* USE_LOCALE_COLLATE */
4217 case PERL_MAGIC_tied:
4218 vtable = &PL_vtbl_pack;
4220 case PERL_MAGIC_tiedelem:
4221 case PERL_MAGIC_tiedscalar:
4222 vtable = &PL_vtbl_packelem;
4225 vtable = &PL_vtbl_regexp;
4227 case PERL_MAGIC_sig:
4228 vtable = &PL_vtbl_sig;
4230 case PERL_MAGIC_sigelem:
4231 vtable = &PL_vtbl_sigelem;
4233 case PERL_MAGIC_taint:
4234 vtable = &PL_vtbl_taint;
4236 case PERL_MAGIC_uvar:
4237 vtable = &PL_vtbl_uvar;
4239 case PERL_MAGIC_vec:
4240 vtable = &PL_vtbl_vec;
4242 case PERL_MAGIC_arylen_p:
4243 case PERL_MAGIC_rhash:
4244 case PERL_MAGIC_symtab:
4245 case PERL_MAGIC_vstring:
4248 case PERL_MAGIC_utf8:
4249 vtable = &PL_vtbl_utf8;
4251 case PERL_MAGIC_substr:
4252 vtable = &PL_vtbl_substr;
4254 case PERL_MAGIC_defelem:
4255 vtable = &PL_vtbl_defelem;
4257 case PERL_MAGIC_glob:
4258 vtable = &PL_vtbl_glob;
4260 case PERL_MAGIC_arylen:
4261 vtable = &PL_vtbl_arylen;
4263 case PERL_MAGIC_pos:
4264 vtable = &PL_vtbl_pos;
4266 case PERL_MAGIC_backref:
4267 vtable = &PL_vtbl_backref;
4269 case PERL_MAGIC_ext:
4270 /* Reserved for use by extensions not perl internals. */
4271 /* Useful for attaching extension internal data to perl vars. */
4272 /* Note that multiple extensions may clash if magical scalars */
4273 /* etc holding private data from one are passed to another. */
4277 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4280 /* Rest of work is done else where */
4281 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4284 case PERL_MAGIC_taint:
4287 case PERL_MAGIC_ext:
4288 case PERL_MAGIC_dbfile:
4295 =for apidoc sv_unmagic
4297 Removes all magic of type C<type> from an SV.
4303 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4307 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4310 for (mg = *mgp; mg; mg = *mgp) {
4311 if (mg->mg_type == type) {
4312 const MGVTBL* const vtbl = mg->mg_virtual;
4313 *mgp = mg->mg_moremagic;
4314 if (vtbl && vtbl->svt_free)
4315 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4316 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4318 Safefree(mg->mg_ptr);
4319 else if (mg->mg_len == HEf_SVKEY)
4320 SvREFCNT_dec((SV*)mg->mg_ptr);
4321 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4322 Safefree(mg->mg_ptr);
4324 if (mg->mg_flags & MGf_REFCOUNTED)
4325 SvREFCNT_dec(mg->mg_obj);
4329 mgp = &mg->mg_moremagic;
4333 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4334 SvMAGIC_set(sv, NULL);
4341 =for apidoc sv_rvweaken
4343 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4344 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4345 push a back-reference to this RV onto the array of backreferences
4346 associated with that magic.
4352 Perl_sv_rvweaken(pTHX_ SV *sv)
4355 if (!SvOK(sv)) /* let undefs pass */
4358 Perl_croak(aTHX_ "Can't weaken a nonreference");
4359 else if (SvWEAKREF(sv)) {
4360 if (ckWARN(WARN_MISC))
4361 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4365 Perl_sv_add_backref(aTHX_ tsv, sv);
4371 /* Give tsv backref magic if it hasn't already got it, then push a
4372 * back-reference to sv onto the array associated with the backref magic.
4376 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4381 if (SvTYPE(tsv) == SVt_PVHV) {
4382 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4386 /* There is no AV in the offical place - try a fixup. */
4387 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4390 /* Aha. They've got it stowed in magic. Bring it back. */
4391 av = (AV*)mg->mg_obj;
4392 /* Stop mg_free decreasing the refernce count. */
4394 /* Stop mg_free even calling the destructor, given that
4395 there's no AV to free up. */
4397 sv_unmagic(tsv, PERL_MAGIC_backref);
4406 const MAGIC *const mg
4407 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4409 av = (AV*)mg->mg_obj;
4413 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4414 /* av now has a refcnt of 2, which avoids it getting freed
4415 * before us during global cleanup. The extra ref is removed
4416 * by magic_killbackrefs() when tsv is being freed */
4419 if (AvFILLp(av) >= AvMAX(av)) {
4420 av_extend(av, AvFILLp(av)+1);
4422 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4425 /* delete a back-reference to ourselves from the backref magic associated
4426 * with the SV we point to.
4430 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4437 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4438 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4439 /* We mustn't attempt to "fix up" the hash here by moving the
4440 backreference array back to the hv_aux structure, as that is stored
4441 in the main HvARRAY(), and hfreentries assumes that no-one
4442 reallocates HvARRAY() while it is running. */
4445 const MAGIC *const mg
4446 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4448 av = (AV *)mg->mg_obj;
4451 if (PL_in_clean_all)
4453 Perl_croak(aTHX_ "panic: del_backref");
4460 /* We shouldn't be in here more than once, but for paranoia reasons lets
4462 for (i = AvFILLp(av); i >= 0; i--) {
4464 const SSize_t fill = AvFILLp(av);
4466 /* We weren't the last entry.
4467 An unordered list has this property that you can take the
4468 last element off the end to fill the hole, and it's still
4469 an unordered list :-)
4474 AvFILLp(av) = fill - 1;
4480 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4482 SV **svp = AvARRAY(av);
4484 PERL_UNUSED_ARG(sv);
4486 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4487 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4488 if (svp && !SvIS_FREED(av)) {
4489 SV *const *const last = svp + AvFILLp(av);
4491 while (svp <= last) {
4493 SV *const referrer = *svp;
4494 if (SvWEAKREF(referrer)) {
4495 /* XXX Should we check that it hasn't changed? */
4496 SvRV_set(referrer, 0);
4498 SvWEAKREF_off(referrer);
4499 } else if (SvTYPE(referrer) == SVt_PVGV ||
4500 SvTYPE(referrer) == SVt_PVLV) {
4501 /* You lookin' at me? */
4502 assert(GvSTASH(referrer));
4503 assert(GvSTASH(referrer) == (HV*)sv);
4504 GvSTASH(referrer) = 0;
4507 "panic: magic_killbackrefs (flags=%"UVxf")",
4508 (UV)SvFLAGS(referrer));
4516 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4521 =for apidoc sv_insert
4523 Inserts a string at the specified offset/length within the SV. Similar to
4524 the Perl substr() function.
4530 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4535 register char *midend;
4536 register char *bigend;
4542 Perl_croak(aTHX_ "Can't modify non-existent substring");
4543 SvPV_force(bigstr, curlen);
4544 (void)SvPOK_only_UTF8(bigstr);
4545 if (offset + len > curlen) {
4546 SvGROW(bigstr, offset+len+1);
4547 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4548 SvCUR_set(bigstr, offset+len);
4552 i = littlelen - len;
4553 if (i > 0) { /* string might grow */
4554 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4555 mid = big + offset + len;
4556 midend = bigend = big + SvCUR(bigstr);
4559 while (midend > mid) /* shove everything down */
4560 *--bigend = *--midend;
4561 Move(little,big+offset,littlelen,char);
4562 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4567 Move(little,SvPVX(bigstr)+offset,len,char);
4572 big = SvPVX(bigstr);
4575 bigend = big + SvCUR(bigstr);
4577 if (midend > bigend)
4578 Perl_croak(aTHX_ "panic: sv_insert");
4580 if (mid - big > bigend - midend) { /* faster to shorten from end */
4582 Move(little, mid, littlelen,char);
4585 i = bigend - midend;
4587 Move(midend, mid, i,char);
4591 SvCUR_set(bigstr, mid - big);
4593 else if ((i = mid - big)) { /* faster from front */
4594 midend -= littlelen;
4596 sv_chop(bigstr,midend-i);
4601 Move(little, mid, littlelen,char);
4603 else if (littlelen) {
4604 midend -= littlelen;
4605 sv_chop(bigstr,midend);
4606 Move(little,midend,littlelen,char);
4609 sv_chop(bigstr,midend);
4615 =for apidoc sv_replace
4617 Make the first argument a copy of the second, then delete the original.
4618 The target SV physically takes over ownership of the body of the source SV
4619 and inherits its flags; however, the target keeps any magic it owns,
4620 and any magic in the source is discarded.
4621 Note that this is a rather specialist SV copying operation; most of the
4622 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4628 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4631 const U32 refcnt = SvREFCNT(sv);
4632 SV_CHECK_THINKFIRST_COW_DROP(sv);
4633 if (SvREFCNT(nsv) != 1) {
4634 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4635 UVuf " != 1)", (UV) SvREFCNT(nsv));
4637 if (SvMAGICAL(sv)) {
4641 sv_upgrade(nsv, SVt_PVMG);
4642 SvMAGIC_set(nsv, SvMAGIC(sv));
4643 SvFLAGS(nsv) |= SvMAGICAL(sv);
4645 SvMAGIC_set(sv, NULL);
4649 assert(!SvREFCNT(sv));
4650 #ifdef DEBUG_LEAKING_SCALARS
4651 sv->sv_flags = nsv->sv_flags;
4652 sv->sv_any = nsv->sv_any;
4653 sv->sv_refcnt = nsv->sv_refcnt;
4654 sv->sv_u = nsv->sv_u;
4656 StructCopy(nsv,sv,SV);
4658 /* Currently could join these into one piece of pointer arithmetic, but
4659 it would be unclear. */
4660 if(SvTYPE(sv) == SVt_IV)
4662 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4663 else if (SvTYPE(sv) == SVt_RV) {
4664 SvANY(sv) = &sv->sv_u.svu_rv;
4668 #ifdef PERL_OLD_COPY_ON_WRITE
4669 if (SvIsCOW_normal(nsv)) {
4670 /* We need to follow the pointers around the loop to make the
4671 previous SV point to sv, rather than nsv. */
4674 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4677 assert(SvPVX_const(current) == SvPVX_const(nsv));
4679 /* Make the SV before us point to the SV after us. */
4681 PerlIO_printf(Perl_debug_log, "previous is\n");
4683 PerlIO_printf(Perl_debug_log,
4684 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4685 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4687 SV_COW_NEXT_SV_SET(current, sv);
4690 SvREFCNT(sv) = refcnt;
4691 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4697 =for apidoc sv_clear
4699 Clear an SV: call any destructors, free up any memory used by the body,
4700 and free the body itself. The SV's head is I<not> freed, although
4701 its type is set to all 1's so that it won't inadvertently be assumed
4702 to be live during global destruction etc.
4703 This function should only be called when REFCNT is zero. Most of the time
4704 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4711 Perl_sv_clear(pTHX_ register SV *sv)
4714 const U32 type = SvTYPE(sv);
4715 const struct body_details *const sv_type_details
4716 = bodies_by_type + type;
4719 assert(SvREFCNT(sv) == 0);
4725 if (PL_defstash) { /* Still have a symbol table? */
4730 stash = SvSTASH(sv);
4731 destructor = StashHANDLER(stash,DESTROY);
4733 SV* const tmpref = newRV(sv);
4734 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4736 PUSHSTACKi(PERLSI_DESTROY);
4741 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4747 if(SvREFCNT(tmpref) < 2) {
4748 /* tmpref is not kept alive! */
4750 SvRV_set(tmpref, NULL);
4753 SvREFCNT_dec(tmpref);
4755 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4759 if (PL_in_clean_objs)
4760 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4762 /* DESTROY gave object new lease on life */
4768 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4769 SvOBJECT_off(sv); /* Curse the object. */
4770 if (type != SVt_PVIO)
4771 --PL_sv_objcount; /* XXX Might want something more general */
4774 if (type >= SVt_PVMG) {
4777 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4778 SvREFCNT_dec(SvSTASH(sv));
4783 IoIFP(sv) != PerlIO_stdin() &&
4784 IoIFP(sv) != PerlIO_stdout() &&
4785 IoIFP(sv) != PerlIO_stderr())
4787 io_close((IO*)sv, FALSE);
4789 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4790 PerlDir_close(IoDIRP(sv));
4791 IoDIRP(sv) = (DIR*)NULL;
4792 Safefree(IoTOP_NAME(sv));
4793 Safefree(IoFMT_NAME(sv));
4794 Safefree(IoBOTTOM_NAME(sv));
4803 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4810 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4811 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4812 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4813 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4815 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4816 SvREFCNT_dec(LvTARG(sv));
4820 Safefree(GvNAME(sv));
4821 /* If we're in a stash, we don't own a reference to it. However it does
4822 have a back reference to us, which needs to be cleared. */
4824 sv_del_backref((SV*)GvSTASH(sv), sv);
4829 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4831 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4832 /* Don't even bother with turning off the OOK flag. */
4837 SV *target = SvRV(sv);
4839 sv_del_backref(target, sv);
4841 SvREFCNT_dec(target);
4843 #ifdef PERL_OLD_COPY_ON_WRITE
4844 else if (SvPVX_const(sv)) {
4846 /* I believe I need to grab the global SV mutex here and
4847 then recheck the COW status. */
4849 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4852 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4853 SV_COW_NEXT_SV(sv));
4854 /* And drop it here. */
4856 } else if (SvLEN(sv)) {
4857 Safefree(SvPVX_const(sv));
4861 else if (SvPVX_const(sv) && SvLEN(sv))
4862 Safefree(SvPVX_mutable(sv));
4863 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4864 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4873 SvFLAGS(sv) &= SVf_BREAK;
4874 SvFLAGS(sv) |= SVTYPEMASK;
4876 if (sv_type_details->arena) {
4877 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4878 &PL_body_roots[type]);
4880 else if (sv_type_details->size) {
4881 my_safefree(SvANY(sv));
4886 =for apidoc sv_newref
4888 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4895 Perl_sv_newref(pTHX_ SV *sv)
4905 Decrement an SV's reference count, and if it drops to zero, call
4906 C<sv_clear> to invoke destructors and free up any memory used by
4907 the body; finally, deallocate the SV's head itself.
4908 Normally called via a wrapper macro C<SvREFCNT_dec>.
4914 Perl_sv_free(pTHX_ SV *sv)
4919 if (SvREFCNT(sv) == 0) {
4920 if (SvFLAGS(sv) & SVf_BREAK)
4921 /* this SV's refcnt has been artificially decremented to
4922 * trigger cleanup */
4924 if (PL_in_clean_all) /* All is fair */
4926 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4927 /* make sure SvREFCNT(sv)==0 happens very seldom */
4928 SvREFCNT(sv) = (~(U32)0)/2;
4931 if (ckWARN_d(WARN_INTERNAL)) {
4932 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4933 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4934 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4935 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4936 Perl_dump_sv_child(aTHX_ sv);
4941 if (--(SvREFCNT(sv)) > 0)
4943 Perl_sv_free2(aTHX_ sv);
4947 Perl_sv_free2(pTHX_ SV *sv)
4952 if (ckWARN_d(WARN_DEBUGGING))
4953 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4954 "Attempt to free temp prematurely: SV 0x%"UVxf
4955 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4959 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4960 /* make sure SvREFCNT(sv)==0 happens very seldom */
4961 SvREFCNT(sv) = (~(U32)0)/2;
4972 Returns the length of the string in the SV. Handles magic and type
4973 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4979 Perl_sv_len(pTHX_ register SV *sv)
4987 len = mg_length(sv);
4989 (void)SvPV_const(sv, len);
4994 =for apidoc sv_len_utf8
4996 Returns the number of characters in the string in an SV, counting wide
4997 UTF-8 bytes as a single character. Handles magic and type coercion.
5003 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5004 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5005 * (Note that the mg_len is not the length of the mg_ptr field.)
5010 Perl_sv_len_utf8(pTHX_ register SV *sv)
5016 return mg_length(sv);
5020 const U8 *s = (U8*)SvPV_const(sv, len);
5021 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5023 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5025 #ifdef PERL_UTF8_CACHE_ASSERT
5026 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5030 ulen = Perl_utf8_length(aTHX_ s, s + len);
5031 if (!mg && !SvREADONLY(sv)) {
5032 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5033 mg = mg_find(sv, PERL_MAGIC_utf8);
5043 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5044 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5045 * between UTF-8 and byte offsets. There are two (substr offset and substr
5046 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5047 * and byte offset) cache positions.
5049 * The mg_len field is used by sv_len_utf8(), see its comments.
5050 * Note that the mg_len is not the length of the mg_ptr field.
5054 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5055 I32 offsetp, const U8 *s, const U8 *start)
5059 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5061 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5065 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5067 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5068 (*mgp)->mg_ptr = (char *) *cachep;
5072 (*cachep)[i] = offsetp;
5073 (*cachep)[i+1] = s - start;
5081 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5082 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5083 * between UTF-8 and byte offsets. See also the comments of
5084 * S_utf8_mg_pos_init().
5088 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)
5092 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5094 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5095 if (*mgp && (*mgp)->mg_ptr) {
5096 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5097 ASSERT_UTF8_CACHE(*cachep);
5098 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5100 else { /* We will skip to the right spot. */
5105 /* The assumption is that going backward is half
5106 * the speed of going forward (that's where the
5107 * 2 * backw in the below comes from). (The real
5108 * figure of course depends on the UTF-8 data.) */
5110 if ((*cachep)[i] > (STRLEN)uoff) {
5112 backw = (*cachep)[i] - (STRLEN)uoff;
5114 if (forw < 2 * backw)
5117 p = start + (*cachep)[i+1];
5119 /* Try this only for the substr offset (i == 0),
5120 * not for the substr length (i == 2). */
5121 else if (i == 0) { /* (*cachep)[i] < uoff */
5122 const STRLEN ulen = sv_len_utf8(sv);
5124 if ((STRLEN)uoff < ulen) {
5125 forw = (STRLEN)uoff - (*cachep)[i];
5126 backw = ulen - (STRLEN)uoff;
5128 if (forw < 2 * backw)
5129 p = start + (*cachep)[i+1];
5134 /* If the string is not long enough for uoff,
5135 * we could extend it, but not at this low a level. */
5139 if (forw < 2 * backw) {
5146 while (UTF8_IS_CONTINUATION(*p))
5151 /* Update the cache. */
5152 (*cachep)[i] = (STRLEN)uoff;
5153 (*cachep)[i+1] = p - start;
5155 /* Drop the stale "length" cache */
5164 if (found) { /* Setup the return values. */
5165 *offsetp = (*cachep)[i+1];
5166 *sp = start + *offsetp;
5169 *offsetp = send - start;
5171 else if (*sp < start) {
5177 #ifdef PERL_UTF8_CACHE_ASSERT
5182 while (n-- && s < send)
5186 assert(*offsetp == s - start);
5187 assert((*cachep)[0] == (STRLEN)uoff);
5188 assert((*cachep)[1] == *offsetp);
5190 ASSERT_UTF8_CACHE(*cachep);
5199 =for apidoc sv_pos_u2b
5201 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5202 the start of the string, to a count of the equivalent number of bytes; if
5203 lenp is non-zero, it does the same to lenp, but this time starting from
5204 the offset, rather than from the start of the string. Handles magic and
5211 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5212 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5213 * byte offsets. See also the comments of S_utf8_mg_pos().
5218 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5226 start = (U8*)SvPV_const(sv, len);
5229 STRLEN *cache = NULL;
5230 const U8 *s = start;
5231 I32 uoffset = *offsetp;
5232 const U8 * const send = s + len;
5234 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5236 if (!found && uoffset > 0) {
5237 while (s < send && uoffset--)
5241 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5243 *offsetp = s - start;
5248 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5252 if (!found && *lenp > 0) {
5255 while (s < send && ulen--)
5259 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5263 ASSERT_UTF8_CACHE(cache);
5275 =for apidoc sv_pos_b2u
5277 Converts the value pointed to by offsetp from a count of bytes from the
5278 start of the string, to a count of the equivalent number of UTF-8 chars.
5279 Handles magic and type coercion.
5285 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5286 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5287 * byte offsets. See also the comments of S_utf8_mg_pos().
5292 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5300 s = (const U8*)SvPV_const(sv, len);
5301 if ((I32)len < *offsetp)
5302 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5304 const U8* send = s + *offsetp;
5306 STRLEN *cache = NULL;
5310 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5311 mg = mg_find(sv, PERL_MAGIC_utf8);
5312 if (mg && mg->mg_ptr) {
5313 cache = (STRLEN *) mg->mg_ptr;
5314 if (cache[1] == (STRLEN)*offsetp) {
5315 /* An exact match. */
5316 *offsetp = cache[0];
5320 else if (cache[1] < (STRLEN)*offsetp) {
5321 /* We already know part of the way. */
5324 /* Let the below loop do the rest. */
5326 else { /* cache[1] > *offsetp */
5327 /* We already know all of the way, now we may
5328 * be able to walk back. The same assumption
5329 * is made as in S_utf8_mg_pos(), namely that
5330 * walking backward is twice slower than
5331 * walking forward. */
5332 const STRLEN forw = *offsetp;
5333 STRLEN backw = cache[1] - *offsetp;
5335 if (!(forw < 2 * backw)) {
5336 const U8 *p = s + cache[1];
5343 while (UTF8_IS_CONTINUATION(*p)) {
5351 *offsetp = cache[0];
5353 /* Drop the stale "length" cache */
5361 ASSERT_UTF8_CACHE(cache);
5367 /* Call utf8n_to_uvchr() to validate the sequence
5368 * (unless a simple non-UTF character) */
5369 if (!UTF8_IS_INVARIANT(*s))
5370 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5379 if (!SvREADONLY(sv)) {
5381 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5382 mg = mg_find(sv, PERL_MAGIC_utf8);
5387 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5388 mg->mg_ptr = (char *) cache;
5393 cache[1] = *offsetp;
5394 /* Drop the stale "length" cache */
5407 Returns a boolean indicating whether the strings in the two SVs are
5408 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5409 coerce its args to strings if necessary.
5415 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5424 SV* svrecode = Nullsv;
5431 pv1 = SvPV_const(sv1, cur1);
5438 pv2 = SvPV_const(sv2, cur2);
5440 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5441 /* Differing utf8ness.
5442 * Do not UTF8size the comparands as a side-effect. */
5445 svrecode = newSVpvn(pv2, cur2);
5446 sv_recode_to_utf8(svrecode, PL_encoding);
5447 pv2 = SvPV_const(svrecode, cur2);
5450 svrecode = newSVpvn(pv1, cur1);
5451 sv_recode_to_utf8(svrecode, PL_encoding);
5452 pv1 = SvPV_const(svrecode, cur1);
5454 /* Now both are in UTF-8. */
5456 SvREFCNT_dec(svrecode);
5461 bool is_utf8 = TRUE;
5464 /* sv1 is the UTF-8 one,
5465 * if is equal it must be downgrade-able */
5466 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5472 /* sv2 is the UTF-8 one,
5473 * if is equal it must be downgrade-able */
5474 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5480 /* Downgrade not possible - cannot be eq */
5488 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5491 SvREFCNT_dec(svrecode);
5502 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5503 string in C<sv1> is less than, equal to, or greater than the string in
5504 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5505 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5511 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5515 const char *pv1, *pv2;
5518 SV *svrecode = Nullsv;
5525 pv1 = SvPV_const(sv1, cur1);
5532 pv2 = SvPV_const(sv2, cur2);
5534 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5535 /* Differing utf8ness.
5536 * Do not UTF8size the comparands as a side-effect. */
5539 svrecode = newSVpvn(pv2, cur2);
5540 sv_recode_to_utf8(svrecode, PL_encoding);
5541 pv2 = SvPV_const(svrecode, cur2);
5544 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5549 svrecode = newSVpvn(pv1, cur1);
5550 sv_recode_to_utf8(svrecode, PL_encoding);
5551 pv1 = SvPV_const(svrecode, cur1);
5554 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5560 cmp = cur2 ? -1 : 0;
5564 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5567 cmp = retval < 0 ? -1 : 1;
5568 } else if (cur1 == cur2) {
5571 cmp = cur1 < cur2 ? -1 : 1;
5576 SvREFCNT_dec(svrecode);
5585 =for apidoc sv_cmp_locale
5587 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5588 'use bytes' aware, handles get magic, and will coerce its args to strings
5589 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5595 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5598 #ifdef USE_LOCALE_COLLATE
5604 if (PL_collation_standard)
5608 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5610 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5612 if (!pv1 || !len1) {
5623 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5626 return retval < 0 ? -1 : 1;
5629 * When the result of collation is equality, that doesn't mean
5630 * that there are no differences -- some locales exclude some
5631 * characters from consideration. So to avoid false equalities,
5632 * we use the raw string as a tiebreaker.
5638 #endif /* USE_LOCALE_COLLATE */
5640 return sv_cmp(sv1, sv2);
5644 #ifdef USE_LOCALE_COLLATE
5647 =for apidoc sv_collxfrm
5649 Add Collate Transform magic to an SV if it doesn't already have it.
5651 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5652 scalar data of the variable, but transformed to such a format that a normal
5653 memory comparison can be used to compare the data according to the locale
5660 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5665 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5666 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5672 Safefree(mg->mg_ptr);
5673 s = SvPV_const(sv, len);
5674 if ((xf = mem_collxfrm(s, len, &xlen))) {
5675 if (SvREADONLY(sv)) {
5678 return xf + sizeof(PL_collation_ix);
5681 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5682 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5695 if (mg && mg->mg_ptr) {
5697 return mg->mg_ptr + sizeof(PL_collation_ix);
5705 #endif /* USE_LOCALE_COLLATE */
5710 Get a line from the filehandle and store it into the SV, optionally
5711 appending to the currently-stored string.
5717 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5722 register STDCHAR rslast;
5723 register STDCHAR *bp;
5729 if (SvTHINKFIRST(sv))
5730 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5731 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5733 However, perlbench says it's slower, because the existing swipe code
5734 is faster than copy on write.
5735 Swings and roundabouts. */
5736 SvUPGRADE(sv, SVt_PV);
5741 if (PerlIO_isutf8(fp)) {
5743 sv_utf8_upgrade_nomg(sv);
5744 sv_pos_u2b(sv,&append,0);
5746 } else if (SvUTF8(sv)) {
5747 SV * const tsv = newSV(0);
5748 sv_gets(tsv, fp, 0);
5749 sv_utf8_upgrade_nomg(tsv);
5750 SvCUR_set(sv,append);
5753 goto return_string_or_null;
5758 if (PerlIO_isutf8(fp))
5761 if (IN_PERL_COMPILETIME) {
5762 /* we always read code in line mode */
5766 else if (RsSNARF(PL_rs)) {
5767 /* If it is a regular disk file use size from stat() as estimate
5768 of amount we are going to read - may result in malloc-ing
5769 more memory than we realy need if layers bellow reduce
5770 size we read (e.g. CRLF or a gzip layer)
5773 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5774 const Off_t offset = PerlIO_tell(fp);
5775 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5776 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5782 else if (RsRECORD(PL_rs)) {
5786 /* Grab the size of the record we're getting */
5787 recsize = SvIV(SvRV(PL_rs));
5788 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5791 /* VMS wants read instead of fread, because fread doesn't respect */
5792 /* RMS record boundaries. This is not necessarily a good thing to be */
5793 /* doing, but we've got no other real choice - except avoid stdio
5794 as implementation - perhaps write a :vms layer ?
5796 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5798 bytesread = PerlIO_read(fp, buffer, recsize);
5802 SvCUR_set(sv, bytesread += append);
5803 buffer[bytesread] = '\0';
5804 goto return_string_or_null;
5806 else if (RsPARA(PL_rs)) {
5812 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5813 if (PerlIO_isutf8(fp)) {
5814 rsptr = SvPVutf8(PL_rs, rslen);
5817 if (SvUTF8(PL_rs)) {
5818 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5819 Perl_croak(aTHX_ "Wide character in $/");
5822 rsptr = SvPV_const(PL_rs, rslen);
5826 rslast = rslen ? rsptr[rslen - 1] : '\0';
5828 if (rspara) { /* have to do this both before and after */
5829 do { /* to make sure file boundaries work right */
5832 i = PerlIO_getc(fp);
5836 PerlIO_ungetc(fp,i);
5842 /* See if we know enough about I/O mechanism to cheat it ! */
5844 /* This used to be #ifdef test - it is made run-time test for ease
5845 of abstracting out stdio interface. One call should be cheap
5846 enough here - and may even be a macro allowing compile
5850 if (PerlIO_fast_gets(fp)) {
5853 * We're going to steal some values from the stdio struct
5854 * and put EVERYTHING in the innermost loop into registers.
5856 register STDCHAR *ptr;
5860 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5861 /* An ungetc()d char is handled separately from the regular
5862 * buffer, so we getc() it back out and stuff it in the buffer.
5864 i = PerlIO_getc(fp);
5865 if (i == EOF) return 0;
5866 *(--((*fp)->_ptr)) = (unsigned char) i;
5870 /* Here is some breathtakingly efficient cheating */
5872 cnt = PerlIO_get_cnt(fp); /* get count into register */
5873 /* make sure we have the room */
5874 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5875 /* Not room for all of it
5876 if we are looking for a separator and room for some
5878 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5879 /* just process what we have room for */
5880 shortbuffered = cnt - SvLEN(sv) + append + 1;
5881 cnt -= shortbuffered;
5885 /* remember that cnt can be negative */
5886 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5891 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5892 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5893 DEBUG_P(PerlIO_printf(Perl_debug_log,
5894 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5895 DEBUG_P(PerlIO_printf(Perl_debug_log,
5896 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5897 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5898 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5903 while (cnt > 0) { /* this | eat */
5905 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5906 goto thats_all_folks; /* screams | sed :-) */
5910 Copy(ptr, bp, cnt, char); /* this | eat */
5911 bp += cnt; /* screams | dust */
5912 ptr += cnt; /* louder | sed :-) */
5917 if (shortbuffered) { /* oh well, must extend */
5918 cnt = shortbuffered;
5920 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5922 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5923 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5927 DEBUG_P(PerlIO_printf(Perl_debug_log,
5928 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5929 PTR2UV(ptr),(long)cnt));
5930 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5932 DEBUG_P(PerlIO_printf(Perl_debug_log,
5933 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5934 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5935 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5937 /* This used to call 'filbuf' in stdio form, but as that behaves like
5938 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5939 another abstraction. */
5940 i = PerlIO_getc(fp); /* get more characters */
5942 DEBUG_P(PerlIO_printf(Perl_debug_log,
5943 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5944 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5945 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5947 cnt = PerlIO_get_cnt(fp);
5948 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5949 DEBUG_P(PerlIO_printf(Perl_debug_log,
5950 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5952 if (i == EOF) /* all done for ever? */
5953 goto thats_really_all_folks;
5955 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5957 SvGROW(sv, bpx + cnt + 2);
5958 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5960 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5962 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5963 goto thats_all_folks;
5967 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5968 memNE((char*)bp - rslen, rsptr, rslen))
5969 goto screamer; /* go back to the fray */
5970 thats_really_all_folks:
5972 cnt += shortbuffered;
5973 DEBUG_P(PerlIO_printf(Perl_debug_log,
5974 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5975 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5976 DEBUG_P(PerlIO_printf(Perl_debug_log,
5977 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5978 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5979 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5981 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5982 DEBUG_P(PerlIO_printf(Perl_debug_log,
5983 "Screamer: done, len=%ld, string=|%.*s|\n",
5984 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5988 /*The big, slow, and stupid way. */
5989 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5990 STDCHAR *buf = NULL;
5991 Newx(buf, 8192, STDCHAR);
5999 register const STDCHAR * const bpe = buf + sizeof(buf);
6001 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6002 ; /* keep reading */
6006 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6007 /* Accomodate broken VAXC compiler, which applies U8 cast to
6008 * both args of ?: operator, causing EOF to change into 255
6011 i = (U8)buf[cnt - 1];
6017 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6019 sv_catpvn(sv, (char *) buf, cnt);
6021 sv_setpvn(sv, (char *) buf, cnt);
6023 if (i != EOF && /* joy */
6025 SvCUR(sv) < rslen ||
6026 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6030 * If we're reading from a TTY and we get a short read,
6031 * indicating that the user hit his EOF character, we need
6032 * to notice it now, because if we try to read from the TTY
6033 * again, the EOF condition will disappear.
6035 * The comparison of cnt to sizeof(buf) is an optimization
6036 * that prevents unnecessary calls to feof().
6040 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6044 #ifdef USE_HEAP_INSTEAD_OF_STACK
6049 if (rspara) { /* have to do this both before and after */
6050 while (i != EOF) { /* to make sure file boundaries work right */
6051 i = PerlIO_getc(fp);
6053 PerlIO_ungetc(fp,i);
6059 return_string_or_null:
6060 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6066 Auto-increment of the value in the SV, doing string to numeric conversion
6067 if necessary. Handles 'get' magic.
6073 Perl_sv_inc(pTHX_ register SV *sv)
6082 if (SvTHINKFIRST(sv)) {
6084 sv_force_normal_flags(sv, 0);
6085 if (SvREADONLY(sv)) {
6086 if (IN_PERL_RUNTIME)
6087 Perl_croak(aTHX_ PL_no_modify);
6091 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6093 i = PTR2IV(SvRV(sv));
6098 flags = SvFLAGS(sv);
6099 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6100 /* It's (privately or publicly) a float, but not tested as an
6101 integer, so test it to see. */
6103 flags = SvFLAGS(sv);
6105 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6106 /* It's publicly an integer, or privately an integer-not-float */
6107 #ifdef PERL_PRESERVE_IVUV
6111 if (SvUVX(sv) == UV_MAX)
6112 sv_setnv(sv, UV_MAX_P1);
6114 (void)SvIOK_only_UV(sv);
6115 SvUV_set(sv, SvUVX(sv) + 1);
6117 if (SvIVX(sv) == IV_MAX)
6118 sv_setuv(sv, (UV)IV_MAX + 1);
6120 (void)SvIOK_only(sv);
6121 SvIV_set(sv, SvIVX(sv) + 1);
6126 if (flags & SVp_NOK) {
6127 (void)SvNOK_only(sv);
6128 SvNV_set(sv, SvNVX(sv) + 1.0);
6132 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6133 if ((flags & SVTYPEMASK) < SVt_PVIV)
6134 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6135 (void)SvIOK_only(sv);
6140 while (isALPHA(*d)) d++;
6141 while (isDIGIT(*d)) d++;
6143 #ifdef PERL_PRESERVE_IVUV
6144 /* Got to punt this as an integer if needs be, but we don't issue
6145 warnings. Probably ought to make the sv_iv_please() that does
6146 the conversion if possible, and silently. */
6147 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6148 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6149 /* Need to try really hard to see if it's an integer.
6150 9.22337203685478e+18 is an integer.
6151 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6152 so $a="9.22337203685478e+18"; $a+0; $a++
6153 needs to be the same as $a="9.22337203685478e+18"; $a++
6160 /* sv_2iv *should* have made this an NV */
6161 if (flags & SVp_NOK) {
6162 (void)SvNOK_only(sv);
6163 SvNV_set(sv, SvNVX(sv) + 1.0);
6166 /* I don't think we can get here. Maybe I should assert this
6167 And if we do get here I suspect that sv_setnv will croak. NWC
6169 #if defined(USE_LONG_DOUBLE)
6170 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",
6171 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6173 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6174 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6177 #endif /* PERL_PRESERVE_IVUV */
6178 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6182 while (d >= SvPVX_const(sv)) {
6190 /* MKS: The original code here died if letters weren't consecutive.
6191 * at least it didn't have to worry about non-C locales. The
6192 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6193 * arranged in order (although not consecutively) and that only
6194 * [A-Za-z] are accepted by isALPHA in the C locale.
6196 if (*d != 'z' && *d != 'Z') {
6197 do { ++*d; } while (!isALPHA(*d));
6200 *(d--) -= 'z' - 'a';
6205 *(d--) -= 'z' - 'a' + 1;
6209 /* oh,oh, the number grew */
6210 SvGROW(sv, SvCUR(sv) + 2);
6211 SvCUR_set(sv, SvCUR(sv) + 1);
6212 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6223 Auto-decrement of the value in the SV, doing string to numeric conversion
6224 if necessary. Handles 'get' magic.
6230 Perl_sv_dec(pTHX_ register SV *sv)
6238 if (SvTHINKFIRST(sv)) {
6240 sv_force_normal_flags(sv, 0);
6241 if (SvREADONLY(sv)) {
6242 if (IN_PERL_RUNTIME)
6243 Perl_croak(aTHX_ PL_no_modify);
6247 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6249 i = PTR2IV(SvRV(sv));
6254 /* Unlike sv_inc we don't have to worry about string-never-numbers
6255 and keeping them magic. But we mustn't warn on punting */
6256 flags = SvFLAGS(sv);
6257 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6258 /* It's publicly an integer, or privately an integer-not-float */
6259 #ifdef PERL_PRESERVE_IVUV
6263 if (SvUVX(sv) == 0) {
6264 (void)SvIOK_only(sv);
6268 (void)SvIOK_only_UV(sv);
6269 SvUV_set(sv, SvUVX(sv) - 1);
6272 if (SvIVX(sv) == IV_MIN)
6273 sv_setnv(sv, (NV)IV_MIN - 1.0);
6275 (void)SvIOK_only(sv);
6276 SvIV_set(sv, SvIVX(sv) - 1);
6281 if (flags & SVp_NOK) {
6282 SvNV_set(sv, SvNVX(sv) - 1.0);
6283 (void)SvNOK_only(sv);
6286 if (!(flags & SVp_POK)) {
6287 if ((flags & SVTYPEMASK) < SVt_PVIV)
6288 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6290 (void)SvIOK_only(sv);
6293 #ifdef PERL_PRESERVE_IVUV
6295 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6296 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6297 /* Need to try really hard to see if it's an integer.
6298 9.22337203685478e+18 is an integer.
6299 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6300 so $a="9.22337203685478e+18"; $a+0; $a--
6301 needs to be the same as $a="9.22337203685478e+18"; $a--
6308 /* sv_2iv *should* have made this an NV */
6309 if (flags & SVp_NOK) {
6310 (void)SvNOK_only(sv);
6311 SvNV_set(sv, SvNVX(sv) - 1.0);
6314 /* I don't think we can get here. Maybe I should assert this
6315 And if we do get here I suspect that sv_setnv will croak. NWC
6317 #if defined(USE_LONG_DOUBLE)
6318 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",
6319 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6321 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6322 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6326 #endif /* PERL_PRESERVE_IVUV */
6327 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6331 =for apidoc sv_mortalcopy
6333 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6334 The new SV is marked as mortal. It will be destroyed "soon", either by an
6335 explicit call to FREETMPS, or by an implicit call at places such as
6336 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6341 /* Make a string that will exist for the duration of the expression
6342 * evaluation. Actually, it may have to last longer than that, but
6343 * hopefully we won't free it until it has been assigned to a
6344 * permanent location. */
6347 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6353 sv_setsv(sv,oldstr);
6355 PL_tmps_stack[++PL_tmps_ix] = sv;
6361 =for apidoc sv_newmortal
6363 Creates a new null SV which is mortal. The reference count of the SV is
6364 set to 1. It will be destroyed "soon", either by an explicit call to
6365 FREETMPS, or by an implicit call at places such as statement boundaries.
6366 See also C<sv_mortalcopy> and C<sv_2mortal>.
6372 Perl_sv_newmortal(pTHX)
6378 SvFLAGS(sv) = SVs_TEMP;
6380 PL_tmps_stack[++PL_tmps_ix] = sv;
6385 =for apidoc sv_2mortal
6387 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6388 by an explicit call to FREETMPS, or by an implicit call at places such as
6389 statement boundaries. SvTEMP() is turned on which means that the SV's
6390 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6391 and C<sv_mortalcopy>.
6397 Perl_sv_2mortal(pTHX_ register SV *sv)
6402 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6405 PL_tmps_stack[++PL_tmps_ix] = sv;
6413 Creates a new SV and copies a string into it. The reference count for the
6414 SV is set to 1. If C<len> is zero, Perl will compute the length using
6415 strlen(). For efficiency, consider using C<newSVpvn> instead.
6421 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6427 sv_setpvn(sv,s,len ? len : strlen(s));
6432 =for apidoc newSVpvn
6434 Creates a new SV and copies a string into it. The reference count for the
6435 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6436 string. You are responsible for ensuring that the source string is at least
6437 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6443 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6449 sv_setpvn(sv,s,len);
6455 =for apidoc newSVhek
6457 Creates a new SV from the hash key structure. It will generate scalars that
6458 point to the shared string table where possible. Returns a new (undefined)
6459 SV if the hek is NULL.
6465 Perl_newSVhek(pTHX_ const HEK *hek)
6475 if (HEK_LEN(hek) == HEf_SVKEY) {
6476 return newSVsv(*(SV**)HEK_KEY(hek));
6478 const int flags = HEK_FLAGS(hek);
6479 if (flags & HVhek_WASUTF8) {
6481 Andreas would like keys he put in as utf8 to come back as utf8
6483 STRLEN utf8_len = HEK_LEN(hek);
6484 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6485 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6488 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6490 } else if (flags & HVhek_REHASH) {
6491 /* We don't have a pointer to the hv, so we have to replicate the
6492 flag into every HEK. This hv is using custom a hasing
6493 algorithm. Hence we can't return a shared string scalar, as
6494 that would contain the (wrong) hash value, and might get passed
6495 into an hv routine with a regular hash */
6497 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6502 /* This will be overwhelminly the most common case. */
6503 return newSVpvn_share(HEK_KEY(hek),
6504 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6510 =for apidoc newSVpvn_share
6512 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6513 table. If the string does not already exist in the table, it is created
6514 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6515 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6516 otherwise the hash is computed. The idea here is that as the string table
6517 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6518 hash lookup will avoid string compare.
6524 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6528 bool is_utf8 = FALSE;
6530 STRLEN tmplen = -len;
6532 /* See the note in hv.c:hv_fetch() --jhi */
6533 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6537 PERL_HASH(hash, src, len);
6539 sv_upgrade(sv, SVt_PV);
6540 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6552 #if defined(PERL_IMPLICIT_CONTEXT)
6554 /* pTHX_ magic can't cope with varargs, so this is a no-context
6555 * version of the main function, (which may itself be aliased to us).
6556 * Don't access this version directly.
6560 Perl_newSVpvf_nocontext(const char* pat, ...)
6565 va_start(args, pat);
6566 sv = vnewSVpvf(pat, &args);
6573 =for apidoc newSVpvf
6575 Creates a new SV and initializes it with the string formatted like
6582 Perl_newSVpvf(pTHX_ const char* pat, ...)
6586 va_start(args, pat);
6587 sv = vnewSVpvf(pat, &args);
6592 /* backend for newSVpvf() and newSVpvf_nocontext() */
6595 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6600 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6607 Creates a new SV and copies a floating point value into it.
6608 The reference count for the SV is set to 1.
6614 Perl_newSVnv(pTHX_ NV n)
6627 Creates a new SV and copies an integer into it. The reference count for the
6634 Perl_newSViv(pTHX_ IV i)
6647 Creates a new SV and copies an unsigned integer into it.
6648 The reference count for the SV is set to 1.
6654 Perl_newSVuv(pTHX_ UV u)
6665 =for apidoc newRV_noinc
6667 Creates an RV wrapper for an SV. The reference count for the original
6668 SV is B<not> incremented.
6674 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6680 sv_upgrade(sv, SVt_RV);
6682 SvRV_set(sv, tmpRef);
6687 /* newRV_inc is the official function name to use now.
6688 * newRV_inc is in fact #defined to newRV in sv.h
6692 Perl_newRV(pTHX_ SV *tmpRef)
6695 return newRV_noinc(SvREFCNT_inc(tmpRef));
6701 Creates a new SV which is an exact duplicate of the original SV.
6708 Perl_newSVsv(pTHX_ register SV *old)
6715 if (SvTYPE(old) == SVTYPEMASK) {
6716 if (ckWARN_d(WARN_INTERNAL))
6717 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6721 /* SV_GMAGIC is the default for sv_setv()
6722 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6723 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6724 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6729 =for apidoc sv_reset
6731 Underlying implementation for the C<reset> Perl function.
6732 Note that the perl-level function is vaguely deprecated.
6738 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6741 char todo[PERL_UCHAR_MAX+1];
6746 if (!*s) { /* reset ?? searches */
6747 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6749 PMOP *pm = (PMOP *) mg->mg_obj;
6751 pm->op_pmdynflags &= ~PMdf_USED;
6758 /* reset variables */
6760 if (!HvARRAY(stash))
6763 Zero(todo, 256, char);
6766 I32 i = (unsigned char)*s;
6770 max = (unsigned char)*s++;
6771 for ( ; i <= max; i++) {
6774 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6776 for (entry = HvARRAY(stash)[i];
6778 entry = HeNEXT(entry))
6783 if (!todo[(U8)*HeKEY(entry)])
6785 gv = (GV*)HeVAL(entry);
6788 if (SvTHINKFIRST(sv)) {
6789 if (!SvREADONLY(sv) && SvROK(sv))
6791 /* XXX Is this continue a bug? Why should THINKFIRST
6792 exempt us from resetting arrays and hashes? */
6796 if (SvTYPE(sv) >= SVt_PV) {
6798 if (SvPVX_const(sv) != Nullch)
6806 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6808 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6811 # if defined(USE_ENVIRON_ARRAY)
6814 # endif /* USE_ENVIRON_ARRAY */
6825 Using various gambits, try to get an IO from an SV: the IO slot if its a
6826 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6827 named after the PV if we're a string.
6833 Perl_sv_2io(pTHX_ SV *sv)
6838 switch (SvTYPE(sv)) {
6846 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6850 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6852 return sv_2io(SvRV(sv));
6853 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6859 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6868 Using various gambits, try to get a CV from an SV; in addition, try if
6869 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6870 The flags in C<lref> are passed to sv_fetchsv.
6876 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6883 return *st = NULL, *gvp = Nullgv, Nullcv;
6884 switch (SvTYPE(sv)) {
6903 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6904 tryAMAGICunDEREF(to_cv);
6907 if (SvTYPE(sv) == SVt_PVCV) {
6916 Perl_croak(aTHX_ "Not a subroutine reference");
6921 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6927 /* Some flags to gv_fetchsv mean don't really create the GV */
6928 if (SvTYPE(gv) != SVt_PVGV) {
6934 if (lref && !GvCVu(gv)) {
6938 gv_efullname3(tmpsv, gv, Nullch);
6939 /* XXX this is probably not what they think they're getting.
6940 * It has the same effect as "sub name;", i.e. just a forward
6942 newSUB(start_subparse(FALSE, 0),
6943 newSVOP(OP_CONST, 0, tmpsv),
6948 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6958 Returns true if the SV has a true value by Perl's rules.
6959 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6960 instead use an in-line version.
6966 Perl_sv_true(pTHX_ register SV *sv)
6971 register const XPV* const tXpv = (XPV*)SvANY(sv);
6973 (tXpv->xpv_cur > 1 ||
6974 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6981 return SvIVX(sv) != 0;
6984 return SvNVX(sv) != 0.0;
6986 return sv_2bool(sv);
6992 =for apidoc sv_pvn_force
6994 Get a sensible string out of the SV somehow.
6995 A private implementation of the C<SvPV_force> macro for compilers which
6996 can't cope with complex macro expressions. Always use the macro instead.
6998 =for apidoc sv_pvn_force_flags
7000 Get a sensible string out of the SV somehow.
7001 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7002 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7003 implemented in terms of this function.
7004 You normally want to use the various wrapper macros instead: see
7005 C<SvPV_force> and C<SvPV_force_nomg>
7011 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7014 if (SvTHINKFIRST(sv) && !SvROK(sv))
7015 sv_force_normal_flags(sv, 0);
7025 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7026 const char * const ref = sv_reftype(sv,0);
7028 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7029 ref, OP_NAME(PL_op));
7031 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7033 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7034 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7036 s = sv_2pv_flags(sv, &len, flags);
7040 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7043 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7044 SvGROW(sv, len + 1);
7045 Move(s,SvPVX(sv),len,char);
7050 SvPOK_on(sv); /* validate pointer */
7052 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7053 PTR2UV(sv),SvPVX_const(sv)));
7056 return SvPVX_mutable(sv);
7060 =for apidoc sv_pvbyten_force
7062 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7068 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7070 sv_pvn_force(sv,lp);
7071 sv_utf8_downgrade(sv,0);
7077 =for apidoc sv_pvutf8n_force
7079 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7085 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7087 sv_pvn_force(sv,lp);
7088 sv_utf8_upgrade(sv);
7094 =for apidoc sv_reftype
7096 Returns a string describing what the SV is a reference to.
7102 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7104 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7105 inside return suggests a const propagation bug in g++. */
7106 if (ob && SvOBJECT(sv)) {
7107 char * const name = HvNAME_get(SvSTASH(sv));
7108 return name ? name : (char *) "__ANON__";
7111 switch (SvTYPE(sv)) {
7128 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7129 /* tied lvalues should appear to be
7130 * scalars for backwards compatitbility */
7131 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7132 ? "SCALAR" : "LVALUE");
7133 case SVt_PVAV: return "ARRAY";
7134 case SVt_PVHV: return "HASH";
7135 case SVt_PVCV: return "CODE";
7136 case SVt_PVGV: return "GLOB";
7137 case SVt_PVFM: return "FORMAT";
7138 case SVt_PVIO: return "IO";
7139 default: return "UNKNOWN";
7145 =for apidoc sv_isobject
7147 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7148 object. If the SV is not an RV, or if the object is not blessed, then this
7155 Perl_sv_isobject(pTHX_ SV *sv)
7171 Returns a boolean indicating whether the SV is blessed into the specified
7172 class. This does not check for subtypes; use C<sv_derived_from> to verify
7173 an inheritance relationship.
7179 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7190 hvname = HvNAME_get(SvSTASH(sv));
7194 return strEQ(hvname, name);
7200 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7201 it will be upgraded to one. If C<classname> is non-null then the new SV will
7202 be blessed in the specified package. The new SV is returned and its
7203 reference count is 1.
7209 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7216 SV_CHECK_THINKFIRST_COW_DROP(rv);
7219 if (SvTYPE(rv) >= SVt_PVMG) {
7220 const U32 refcnt = SvREFCNT(rv);
7224 SvREFCNT(rv) = refcnt;
7227 if (SvTYPE(rv) < SVt_RV)
7228 sv_upgrade(rv, SVt_RV);
7229 else if (SvTYPE(rv) > SVt_RV) {
7240 HV* const stash = gv_stashpv(classname, TRUE);
7241 (void)sv_bless(rv, stash);
7247 =for apidoc sv_setref_pv
7249 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7250 argument will be upgraded to an RV. That RV will be modified to point to
7251 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7252 into the SV. The C<classname> argument indicates the package for the
7253 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7254 will have a reference count of 1, and the RV will be returned.
7256 Do not use with other Perl types such as HV, AV, SV, CV, because those
7257 objects will become corrupted by the pointer copy process.
7259 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7265 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7269 sv_setsv(rv, &PL_sv_undef);
7273 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7278 =for apidoc sv_setref_iv
7280 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7281 argument will be upgraded to an RV. That RV will be modified to point to
7282 the new SV. The C<classname> argument indicates the package for the
7283 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7284 will have a reference count of 1, and the RV will be returned.
7290 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7292 sv_setiv(newSVrv(rv,classname), iv);
7297 =for apidoc sv_setref_uv
7299 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7300 argument will be upgraded to an RV. That RV will be modified to point to
7301 the new SV. The C<classname> argument indicates the package for the
7302 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7303 will have a reference count of 1, and the RV will be returned.
7309 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7311 sv_setuv(newSVrv(rv,classname), uv);
7316 =for apidoc sv_setref_nv
7318 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7319 argument will be upgraded to an RV. That RV will be modified to point to
7320 the new SV. The C<classname> argument indicates the package for the
7321 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7322 will have a reference count of 1, and the RV will be returned.
7328 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7330 sv_setnv(newSVrv(rv,classname), nv);
7335 =for apidoc sv_setref_pvn
7337 Copies a string into a new SV, optionally blessing the SV. The length of the
7338 string must be specified with C<n>. The C<rv> argument will be upgraded to
7339 an RV. That RV will be modified to point to the new SV. The C<classname>
7340 argument indicates the package for the blessing. Set C<classname> to
7341 C<Nullch> to avoid the blessing. The new SV will have a reference count
7342 of 1, and the RV will be returned.
7344 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7350 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7352 sv_setpvn(newSVrv(rv,classname), pv, n);
7357 =for apidoc sv_bless
7359 Blesses an SV into a specified package. The SV must be an RV. The package
7360 must be designated by its stash (see C<gv_stashpv()>). The reference count
7361 of the SV is unaffected.
7367 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7372 Perl_croak(aTHX_ "Can't bless non-reference value");
7374 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7375 if (SvREADONLY(tmpRef))
7376 Perl_croak(aTHX_ PL_no_modify);
7377 if (SvOBJECT(tmpRef)) {
7378 if (SvTYPE(tmpRef) != SVt_PVIO)
7380 SvREFCNT_dec(SvSTASH(tmpRef));
7383 SvOBJECT_on(tmpRef);
7384 if (SvTYPE(tmpRef) != SVt_PVIO)
7386 SvUPGRADE(tmpRef, SVt_PVMG);
7387 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7394 if(SvSMAGICAL(tmpRef))
7395 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7403 /* Downgrades a PVGV to a PVMG.
7407 S_sv_unglob(pTHX_ SV *sv)
7412 assert(SvTYPE(sv) == SVt_PVGV);
7417 sv_del_backref((SV*)GvSTASH(sv), sv);
7420 sv_unmagic(sv, PERL_MAGIC_glob);
7421 Safefree(GvNAME(sv));
7424 /* need to keep SvANY(sv) in the right arena */
7425 xpvmg = new_XPVMG();
7426 StructCopy(SvANY(sv), xpvmg, XPVMG);
7427 del_XPVGV(SvANY(sv));
7430 SvFLAGS(sv) &= ~SVTYPEMASK;
7431 SvFLAGS(sv) |= SVt_PVMG;
7435 =for apidoc sv_unref_flags
7437 Unsets the RV status of the SV, and decrements the reference count of
7438 whatever was being referenced by the RV. This can almost be thought of
7439 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7440 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7441 (otherwise the decrementing is conditional on the reference count being
7442 different from one or the reference being a readonly SV).
7449 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7451 SV* const target = SvRV(ref);
7453 if (SvWEAKREF(ref)) {
7454 sv_del_backref(target, ref);
7456 SvRV_set(ref, NULL);
7459 SvRV_set(ref, NULL);
7461 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7462 assigned to as BEGIN {$a = \"Foo"} will fail. */
7463 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7464 SvREFCNT_dec(target);
7465 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7466 sv_2mortal(target); /* Schedule for freeing later */
7470 =for apidoc sv_untaint
7472 Untaint an SV. Use C<SvTAINTED_off> instead.
7477 Perl_sv_untaint(pTHX_ SV *sv)
7479 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7480 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7487 =for apidoc sv_tainted
7489 Test an SV for taintedness. Use C<SvTAINTED> instead.
7494 Perl_sv_tainted(pTHX_ SV *sv)
7496 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7497 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7498 if (mg && (mg->mg_len & 1) )
7505 =for apidoc sv_setpviv
7507 Copies an integer into the given SV, also updating its string value.
7508 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7514 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7516 char buf[TYPE_CHARS(UV)];
7518 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7520 sv_setpvn(sv, ptr, ebuf - ptr);
7524 =for apidoc sv_setpviv_mg
7526 Like C<sv_setpviv>, but also handles 'set' magic.
7532 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7538 #if defined(PERL_IMPLICIT_CONTEXT)
7540 /* pTHX_ magic can't cope with varargs, so this is a no-context
7541 * version of the main function, (which may itself be aliased to us).
7542 * Don't access this version directly.
7546 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7550 va_start(args, pat);
7551 sv_vsetpvf(sv, pat, &args);
7555 /* pTHX_ magic can't cope with varargs, so this is a no-context
7556 * version of the main function, (which may itself be aliased to us).
7557 * Don't access this version directly.
7561 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7565 va_start(args, pat);
7566 sv_vsetpvf_mg(sv, pat, &args);
7572 =for apidoc sv_setpvf
7574 Works like C<sv_catpvf> but copies the text into the SV instead of
7575 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7581 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7584 va_start(args, pat);
7585 sv_vsetpvf(sv, pat, &args);
7590 =for apidoc sv_vsetpvf
7592 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7593 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7595 Usually used via its frontend C<sv_setpvf>.
7601 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7603 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7607 =for apidoc sv_setpvf_mg
7609 Like C<sv_setpvf>, but also handles 'set' magic.
7615 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7618 va_start(args, pat);
7619 sv_vsetpvf_mg(sv, pat, &args);
7624 =for apidoc sv_vsetpvf_mg
7626 Like C<sv_vsetpvf>, but also handles 'set' magic.
7628 Usually used via its frontend C<sv_setpvf_mg>.
7634 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7636 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7640 #if defined(PERL_IMPLICIT_CONTEXT)
7642 /* pTHX_ magic can't cope with varargs, so this is a no-context
7643 * version of the main function, (which may itself be aliased to us).
7644 * Don't access this version directly.
7648 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7652 va_start(args, pat);
7653 sv_vcatpvf(sv, pat, &args);
7657 /* pTHX_ magic can't cope with varargs, so this is a no-context
7658 * version of the main function, (which may itself be aliased to us).
7659 * Don't access this version directly.
7663 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7667 va_start(args, pat);
7668 sv_vcatpvf_mg(sv, pat, &args);
7674 =for apidoc sv_catpvf
7676 Processes its arguments like C<sprintf> and appends the formatted
7677 output to an SV. If the appended data contains "wide" characters
7678 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7679 and characters >255 formatted with %c), the original SV might get
7680 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7681 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7682 valid UTF-8; if the original SV was bytes, the pattern should be too.
7687 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7690 va_start(args, pat);
7691 sv_vcatpvf(sv, pat, &args);
7696 =for apidoc sv_vcatpvf
7698 Processes its arguments like C<vsprintf> and appends the formatted output
7699 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7701 Usually used via its frontend C<sv_catpvf>.
7707 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7709 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7713 =for apidoc sv_catpvf_mg
7715 Like C<sv_catpvf>, but also handles 'set' magic.
7721 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7724 va_start(args, pat);
7725 sv_vcatpvf_mg(sv, pat, &args);
7730 =for apidoc sv_vcatpvf_mg
7732 Like C<sv_vcatpvf>, but also handles 'set' magic.
7734 Usually used via its frontend C<sv_catpvf_mg>.
7740 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7742 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7747 =for apidoc sv_vsetpvfn
7749 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7752 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7758 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7760 sv_setpvn(sv, "", 0);
7761 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7765 S_expect_number(pTHX_ char** pattern)
7769 switch (**pattern) {
7770 case '1': case '2': case '3':
7771 case '4': case '5': case '6':
7772 case '7': case '8': case '9':
7773 var = *(*pattern)++ - '0';
7774 while (isDIGIT(**pattern)) {
7775 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7777 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7785 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7787 const int neg = nv < 0;
7796 if (uv & 1 && uv == nv)
7797 uv--; /* Round to even */
7799 const unsigned dig = uv % 10;
7812 =for apidoc sv_vcatpvfn
7814 Processes its arguments like C<vsprintf> and appends the formatted output
7815 to an SV. Uses an array of SVs if the C style variable argument list is
7816 missing (NULL). When running with taint checks enabled, indicates via
7817 C<maybe_tainted> if results are untrustworthy (often due to the use of
7820 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7826 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7827 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7828 vec_utf8 = DO_UTF8(vecsv);
7830 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7833 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7841 static const char nullstr[] = "(null)";
7843 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7844 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7846 /* Times 4: a decimal digit takes more than 3 binary digits.
7847 * NV_DIG: mantissa takes than many decimal digits.
7848 * Plus 32: Playing safe. */
7849 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7850 /* large enough for "%#.#f" --chip */
7851 /* what about long double NVs? --jhi */
7853 PERL_UNUSED_ARG(maybe_tainted);
7855 /* no matter what, this is a string now */
7856 (void)SvPV_force(sv, origlen);
7858 /* special-case "", "%s", and "%-p" (SVf - see below) */
7861 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7863 const char * const s = va_arg(*args, char*);
7864 sv_catpv(sv, s ? s : nullstr);
7866 else if (svix < svmax) {
7867 sv_catsv(sv, *svargs);
7871 if (args && patlen == 3 && pat[0] == '%' &&
7872 pat[1] == '-' && pat[2] == 'p') {
7873 argsv = va_arg(*args, SV*);
7874 sv_catsv(sv, argsv);
7878 #ifndef USE_LONG_DOUBLE
7879 /* special-case "%.<number>[gf]" */
7880 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7881 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7882 unsigned digits = 0;
7886 while (*pp >= '0' && *pp <= '9')
7887 digits = 10 * digits + (*pp++ - '0');
7888 if (pp - pat == (int)patlen - 1) {
7896 /* Add check for digits != 0 because it seems that some
7897 gconverts are buggy in this case, and we don't yet have
7898 a Configure test for this. */
7899 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7900 /* 0, point, slack */
7901 Gconvert(nv, (int)digits, 0, ebuf);
7903 if (*ebuf) /* May return an empty string for digits==0 */
7906 } else if (!digits) {
7909 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7910 sv_catpvn(sv, p, l);
7916 #endif /* !USE_LONG_DOUBLE */
7918 if (!args && svix < svmax && DO_UTF8(*svargs))
7921 patend = (char*)pat + patlen;
7922 for (p = (char*)pat; p < patend; p = q) {
7925 bool vectorize = FALSE;
7926 bool vectorarg = FALSE;
7927 bool vec_utf8 = FALSE;
7933 bool has_precis = FALSE;
7935 const I32 osvix = svix;
7936 bool is_utf8 = FALSE; /* is this item utf8? */
7937 #ifdef HAS_LDBL_SPRINTF_BUG
7938 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7939 with sfio - Allen <allens@cpan.org> */
7940 bool fix_ldbl_sprintf_bug = FALSE;
7944 U8 utf8buf[UTF8_MAXBYTES+1];
7945 STRLEN esignlen = 0;
7947 const char *eptr = Nullch;
7950 const U8 *vecstr = Null(U8*);
7957 /* we need a long double target in case HAS_LONG_DOUBLE but
7960 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7968 const char *dotstr = ".";
7969 STRLEN dotstrlen = 1;
7970 I32 efix = 0; /* explicit format parameter index */
7971 I32 ewix = 0; /* explicit width index */
7972 I32 epix = 0; /* explicit precision index */
7973 I32 evix = 0; /* explicit vector index */
7974 bool asterisk = FALSE;
7976 /* echo everything up to the next format specification */
7977 for (q = p; q < patend && *q != '%'; ++q) ;
7979 if (has_utf8 && !pat_utf8)
7980 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7982 sv_catpvn(sv, p, q - p);
7989 We allow format specification elements in this order:
7990 \d+\$ explicit format parameter index
7992 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7993 0 flag (as above): repeated to allow "v02"
7994 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7995 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7997 [%bcdefginopsuxDFOUX] format (mandatory)
8002 As of perl5.9.3, printf format checking is on by default.
8003 Internally, perl uses %p formats to provide an escape to
8004 some extended formatting. This block deals with those
8005 extensions: if it does not match, (char*)q is reset and
8006 the normal format processing code is used.
8008 Currently defined extensions are:
8009 %p include pointer address (standard)
8010 %-p (SVf) include an SV (previously %_)
8011 %-<num>p include an SV with precision <num>
8012 %1p (VDf) include a v-string (as %vd)
8013 %<num>p reserved for future extensions
8015 Robin Barker 2005-07-14
8022 n = expect_number(&q);
8029 argsv = va_arg(*args, SV*);
8030 eptr = SvPVx_const(argsv, elen);
8036 else if (n == vdNUMBER) { /* VDf */
8043 if (ckWARN_d(WARN_INTERNAL))
8044 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8045 "internal %%<num>p might conflict with future printf extensions");
8051 if ( (width = expect_number(&q)) ) {
8092 if ( (ewix = expect_number(&q)) )
8101 if ((vectorarg = asterisk)) {
8114 width = expect_number(&q);
8120 vecsv = va_arg(*args, SV*);
8122 vecsv = (evix > 0 && evix <= svmax)
8123 ? svargs[evix-1] : &PL_sv_undef;
8125 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8127 dotstr = SvPV_const(vecsv, dotstrlen);
8128 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8129 bad with tied or overloaded values that return UTF8. */
8132 else if (has_utf8) {
8133 vecsv = sv_mortalcopy(vecsv);
8134 sv_utf8_upgrade(vecsv);
8135 dotstr = SvPV_const(vecsv, dotstrlen);
8142 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8143 vecsv = svargs[efix ? efix-1 : svix++];
8144 vecstr = (U8*)SvPV_const(vecsv,veclen);
8145 vec_utf8 = DO_UTF8(vecsv);
8147 /* if this is a version object, we need to convert
8148 * back into v-string notation and then let the
8149 * vectorize happen normally
8151 if (sv_derived_from(vecsv, "version")) {
8152 char *version = savesvpv(vecsv);
8153 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8154 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8155 "vector argument not supported with alpha versions");
8158 vecsv = sv_newmortal();
8159 /* scan_vstring is expected to be called during
8160 * tokenization, so we need to fake up the end
8161 * of the buffer for it
8163 PL_bufend = version + veclen;
8164 scan_vstring(version, vecsv);
8165 vecstr = (U8*)SvPV_const(vecsv, veclen);
8166 vec_utf8 = DO_UTF8(vecsv);
8178 i = va_arg(*args, int);
8180 i = (ewix ? ewix <= svmax : svix < svmax) ?
8181 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8183 width = (i < 0) ? -i : i;
8193 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8195 /* XXX: todo, support specified precision parameter */
8199 i = va_arg(*args, int);
8201 i = (ewix ? ewix <= svmax : svix < svmax)
8202 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8203 precis = (i < 0) ? 0 : i;
8208 precis = precis * 10 + (*q++ - '0');
8217 case 'I': /* Ix, I32x, and I64x */
8219 if (q[1] == '6' && q[2] == '4') {
8225 if (q[1] == '3' && q[2] == '2') {
8235 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8246 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8247 if (*(q + 1) == 'l') { /* lld, llf */
8273 if (!vectorize && !args) {
8275 const I32 i = efix-1;
8276 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8278 argsv = (svix >= 0 && svix < svmax)
8279 ? svargs[svix++] : &PL_sv_undef;
8290 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8292 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8294 eptr = (char*)utf8buf;
8295 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8309 eptr = va_arg(*args, char*);
8311 #ifdef MACOS_TRADITIONAL
8312 /* On MacOS, %#s format is used for Pascal strings */
8317 elen = strlen(eptr);
8319 eptr = (char *)nullstr;
8320 elen = sizeof nullstr - 1;
8324 eptr = SvPVx_const(argsv, elen);
8325 if (DO_UTF8(argsv)) {
8326 if (has_precis && precis < elen) {
8328 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8331 if (width) { /* fudge width (can't fudge elen) */
8332 width += elen - sv_len_utf8(argsv);
8339 if (has_precis && elen > precis)
8346 if (alt || vectorize)
8348 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8369 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8378 esignbuf[esignlen++] = plus;
8382 case 'h': iv = (short)va_arg(*args, int); break;
8383 case 'l': iv = va_arg(*args, long); break;
8384 case 'V': iv = va_arg(*args, IV); break;
8385 default: iv = va_arg(*args, int); break;
8387 case 'q': iv = va_arg(*args, Quad_t); break;
8392 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8394 case 'h': iv = (short)tiv; break;
8395 case 'l': iv = (long)tiv; break;
8397 default: iv = tiv; break;
8399 case 'q': iv = (Quad_t)tiv; break;
8403 if ( !vectorize ) /* we already set uv above */
8408 esignbuf[esignlen++] = plus;
8412 esignbuf[esignlen++] = '-';
8455 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8466 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8467 case 'l': uv = va_arg(*args, unsigned long); break;
8468 case 'V': uv = va_arg(*args, UV); break;
8469 default: uv = va_arg(*args, unsigned); break;
8471 case 'q': uv = va_arg(*args, Uquad_t); break;
8476 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8478 case 'h': uv = (unsigned short)tuv; break;
8479 case 'l': uv = (unsigned long)tuv; break;
8481 default: uv = tuv; break;
8483 case 'q': uv = (Uquad_t)tuv; break;
8490 char *ptr = ebuf + sizeof ebuf;
8496 p = (char*)((c == 'X')
8497 ? "0123456789ABCDEF" : "0123456789abcdef");
8503 esignbuf[esignlen++] = '0';
8504 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8512 if (alt && *ptr != '0')
8523 esignbuf[esignlen++] = '0';
8524 esignbuf[esignlen++] = 'b';
8527 default: /* it had better be ten or less */
8531 } while (uv /= base);
8534 elen = (ebuf + sizeof ebuf) - ptr;
8538 zeros = precis - elen;
8539 else if (precis == 0 && elen == 1 && *eptr == '0')
8545 /* FLOATING POINT */
8548 c = 'f'; /* maybe %F isn't supported here */
8556 /* This is evil, but floating point is even more evil */
8558 /* for SV-style calling, we can only get NV
8559 for C-style calling, we assume %f is double;
8560 for simplicity we allow any of %Lf, %llf, %qf for long double
8564 #if defined(USE_LONG_DOUBLE)
8568 /* [perl #20339] - we should accept and ignore %lf rather than die */
8572 #if defined(USE_LONG_DOUBLE)
8573 intsize = args ? 0 : 'q';
8577 #if defined(HAS_LONG_DOUBLE)
8586 /* now we need (long double) if intsize == 'q', else (double) */
8588 #if LONG_DOUBLESIZE > DOUBLESIZE
8590 va_arg(*args, long double) :
8591 va_arg(*args, double)
8593 va_arg(*args, double)
8598 if (c != 'e' && c != 'E') {
8600 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8601 will cast our (long double) to (double) */
8602 (void)Perl_frexp(nv, &i);
8603 if (i == PERL_INT_MIN)
8604 Perl_die(aTHX_ "panic: frexp");
8606 need = BIT_DIGITS(i);
8608 need += has_precis ? precis : 6; /* known default */
8613 #ifdef HAS_LDBL_SPRINTF_BUG
8614 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8615 with sfio - Allen <allens@cpan.org> */
8618 # define MY_DBL_MAX DBL_MAX
8619 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8620 # if DOUBLESIZE >= 8
8621 # define MY_DBL_MAX 1.7976931348623157E+308L
8623 # define MY_DBL_MAX 3.40282347E+38L
8627 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8628 # define MY_DBL_MAX_BUG 1L
8630 # define MY_DBL_MAX_BUG MY_DBL_MAX
8634 # define MY_DBL_MIN DBL_MIN
8635 # else /* XXX guessing! -Allen */
8636 # if DOUBLESIZE >= 8
8637 # define MY_DBL_MIN 2.2250738585072014E-308L
8639 # define MY_DBL_MIN 1.17549435E-38L
8643 if ((intsize == 'q') && (c == 'f') &&
8644 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8646 /* it's going to be short enough that
8647 * long double precision is not needed */
8649 if ((nv <= 0L) && (nv >= -0L))
8650 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8652 /* would use Perl_fp_class as a double-check but not
8653 * functional on IRIX - see perl.h comments */
8655 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8656 /* It's within the range that a double can represent */
8657 #if defined(DBL_MAX) && !defined(DBL_MIN)
8658 if ((nv >= ((long double)1/DBL_MAX)) ||
8659 (nv <= (-(long double)1/DBL_MAX)))
8661 fix_ldbl_sprintf_bug = TRUE;
8664 if (fix_ldbl_sprintf_bug == TRUE) {
8674 # undef MY_DBL_MAX_BUG
8677 #endif /* HAS_LDBL_SPRINTF_BUG */
8679 need += 20; /* fudge factor */
8680 if (PL_efloatsize < need) {
8681 Safefree(PL_efloatbuf);
8682 PL_efloatsize = need + 20; /* more fudge */
8683 Newx(PL_efloatbuf, PL_efloatsize, char);
8684 PL_efloatbuf[0] = '\0';
8687 if ( !(width || left || plus || alt) && fill != '0'
8688 && has_precis && intsize != 'q' ) { /* Shortcuts */
8689 /* See earlier comment about buggy Gconvert when digits,
8691 if ( c == 'g' && precis) {
8692 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8693 /* May return an empty string for digits==0 */
8694 if (*PL_efloatbuf) {
8695 elen = strlen(PL_efloatbuf);
8696 goto float_converted;
8698 } else if ( c == 'f' && !precis) {
8699 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8704 char *ptr = ebuf + sizeof ebuf;
8707 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8708 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8709 if (intsize == 'q') {
8710 /* Copy the one or more characters in a long double
8711 * format before the 'base' ([efgEFG]) character to
8712 * the format string. */
8713 static char const prifldbl[] = PERL_PRIfldbl;
8714 char const *p = prifldbl + sizeof(prifldbl) - 3;
8715 while (p >= prifldbl) { *--ptr = *p--; }
8720 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8725 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8737 /* No taint. Otherwise we are in the strange situation
8738 * where printf() taints but print($float) doesn't.
8740 #if defined(HAS_LONG_DOUBLE)
8741 elen = ((intsize == 'q')
8742 ? my_sprintf(PL_efloatbuf, ptr, nv)
8743 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8745 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8749 eptr = PL_efloatbuf;
8757 i = SvCUR(sv) - origlen;
8760 case 'h': *(va_arg(*args, short*)) = i; break;
8761 default: *(va_arg(*args, int*)) = i; break;
8762 case 'l': *(va_arg(*args, long*)) = i; break;
8763 case 'V': *(va_arg(*args, IV*)) = i; break;
8765 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8770 sv_setuv_mg(argsv, (UV)i);
8771 continue; /* not "break" */
8778 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8779 && ckWARN(WARN_PRINTF))
8781 SV * const msg = sv_newmortal();
8782 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8783 (PL_op->op_type == OP_PRTF) ? "" : "s");
8786 Perl_sv_catpvf(aTHX_ msg,
8787 "\"%%%c\"", c & 0xFF);
8789 Perl_sv_catpvf(aTHX_ msg,
8790 "\"%%\\%03"UVof"\"",
8793 sv_catpvs(msg, "end of string");
8794 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8797 /* output mangled stuff ... */
8803 /* ... right here, because formatting flags should not apply */
8804 SvGROW(sv, SvCUR(sv) + elen + 1);
8806 Copy(eptr, p, elen, char);
8809 SvCUR_set(sv, p - SvPVX_const(sv));
8811 continue; /* not "break" */
8814 /* calculate width before utf8_upgrade changes it */
8815 have = esignlen + zeros + elen;
8817 Perl_croak_nocontext(PL_memory_wrap);
8819 if (is_utf8 != has_utf8) {
8822 sv_utf8_upgrade(sv);
8825 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8826 sv_utf8_upgrade(nsv);
8827 eptr = SvPVX_const(nsv);
8830 SvGROW(sv, SvCUR(sv) + elen + 1);
8835 need = (have > width ? have : width);
8838 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8839 Perl_croak_nocontext(PL_memory_wrap);
8840 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8842 if (esignlen && fill == '0') {
8844 for (i = 0; i < (int)esignlen; i++)
8848 memset(p, fill, gap);
8851 if (esignlen && fill != '0') {
8853 for (i = 0; i < (int)esignlen; i++)
8858 for (i = zeros; i; i--)
8862 Copy(eptr, p, elen, char);
8866 memset(p, ' ', gap);
8871 Copy(dotstr, p, dotstrlen, char);
8875 vectorize = FALSE; /* done iterating over vecstr */
8882 SvCUR_set(sv, p - SvPVX_const(sv));
8890 /* =========================================================================
8892 =head1 Cloning an interpreter
8894 All the macros and functions in this section are for the private use of
8895 the main function, perl_clone().
8897 The foo_dup() functions make an exact copy of an existing foo thinngy.
8898 During the course of a cloning, a hash table is used to map old addresses
8899 to new addresses. The table is created and manipulated with the
8900 ptr_table_* functions.
8904 ============================================================================*/
8907 #if defined(USE_ITHREADS)
8909 #ifndef GpREFCNT_inc
8910 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8914 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8915 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8916 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8917 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8918 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8919 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8920 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8921 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8922 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8923 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8924 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8925 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8926 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8929 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8930 regcomp.c. AMS 20010712 */
8933 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8938 struct reg_substr_datum *s;
8941 return (REGEXP *)NULL;
8943 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8946 len = r->offsets[0];
8947 npar = r->nparens+1;
8949 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8950 Copy(r->program, ret->program, len+1, regnode);
8952 Newx(ret->startp, npar, I32);
8953 Copy(r->startp, ret->startp, npar, I32);
8954 Newx(ret->endp, npar, I32);
8955 Copy(r->startp, ret->startp, npar, I32);
8957 Newx(ret->substrs, 1, struct reg_substr_data);
8958 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8959 s->min_offset = r->substrs->data[i].min_offset;
8960 s->max_offset = r->substrs->data[i].max_offset;
8961 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8962 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8965 ret->regstclass = NULL;
8968 const int count = r->data->count;
8971 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8972 char, struct reg_data);
8973 Newx(d->what, count, U8);
8976 for (i = 0; i < count; i++) {
8977 d->what[i] = r->data->what[i];
8978 switch (d->what[i]) {
8979 /* legal options are one of: sfpont
8980 see also regcomp.h and pregfree() */
8982 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8985 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8988 /* This is cheating. */
8989 Newx(d->data[i], 1, struct regnode_charclass_class);
8990 StructCopy(r->data->data[i], d->data[i],
8991 struct regnode_charclass_class);
8992 ret->regstclass = (regnode*)d->data[i];
8995 /* Compiled op trees are readonly, and can thus be
8996 shared without duplication. */
8998 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9002 d->data[i] = r->data->data[i];
9005 d->data[i] = r->data->data[i];
9007 ((reg_trie_data*)d->data[i])->refcount++;
9011 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9020 Newx(ret->offsets, 2*len+1, U32);
9021 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9023 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9024 ret->refcnt = r->refcnt;
9025 ret->minlen = r->minlen;
9026 ret->prelen = r->prelen;
9027 ret->nparens = r->nparens;
9028 ret->lastparen = r->lastparen;
9029 ret->lastcloseparen = r->lastcloseparen;
9030 ret->reganch = r->reganch;
9032 ret->sublen = r->sublen;
9034 if (RX_MATCH_COPIED(ret))
9035 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9037 ret->subbeg = Nullch;
9038 #ifdef PERL_OLD_COPY_ON_WRITE
9039 ret->saved_copy = Nullsv;
9042 ptr_table_store(PL_ptr_table, r, ret);
9046 /* duplicate a file handle */
9049 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9053 PERL_UNUSED_ARG(type);
9056 return (PerlIO*)NULL;
9058 /* look for it in the table first */
9059 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9063 /* create anew and remember what it is */
9064 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9065 ptr_table_store(PL_ptr_table, fp, ret);
9069 /* duplicate a directory handle */
9072 Perl_dirp_dup(pTHX_ DIR *dp)
9080 /* duplicate a typeglob */
9083 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9088 /* look for it in the table first */
9089 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9093 /* create anew and remember what it is */
9095 ptr_table_store(PL_ptr_table, gp, ret);
9098 ret->gp_refcnt = 0; /* must be before any other dups! */
9099 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9100 ret->gp_io = io_dup_inc(gp->gp_io, param);
9101 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9102 ret->gp_av = av_dup_inc(gp->gp_av, param);
9103 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9104 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9105 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9106 ret->gp_cvgen = gp->gp_cvgen;
9107 ret->gp_line = gp->gp_line;
9108 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9112 /* duplicate a chain of magic */
9115 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9117 MAGIC *mgprev = (MAGIC*)NULL;
9120 return (MAGIC*)NULL;
9121 /* look for it in the table first */
9122 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9126 for (; mg; mg = mg->mg_moremagic) {
9128 Newxz(nmg, 1, MAGIC);
9130 mgprev->mg_moremagic = nmg;
9133 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9134 nmg->mg_private = mg->mg_private;
9135 nmg->mg_type = mg->mg_type;
9136 nmg->mg_flags = mg->mg_flags;
9137 if (mg->mg_type == PERL_MAGIC_qr) {
9138 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9140 else if(mg->mg_type == PERL_MAGIC_backref) {
9141 /* The backref AV has its reference count deliberately bumped by
9143 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9145 else if (mg->mg_type == PERL_MAGIC_symtab) {
9146 nmg->mg_obj = mg->mg_obj;
9149 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9150 ? sv_dup_inc(mg->mg_obj, param)
9151 : sv_dup(mg->mg_obj, param);
9153 nmg->mg_len = mg->mg_len;
9154 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9155 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9156 if (mg->mg_len > 0) {
9157 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9158 if (mg->mg_type == PERL_MAGIC_overload_table &&
9159 AMT_AMAGIC((AMT*)mg->mg_ptr))
9161 const AMT * const amtp = (AMT*)mg->mg_ptr;
9162 AMT * const namtp = (AMT*)nmg->mg_ptr;
9164 for (i = 1; i < NofAMmeth; i++) {
9165 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9169 else if (mg->mg_len == HEf_SVKEY)
9170 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9172 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9173 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9180 /* create a new pointer-mapping table */
9183 Perl_ptr_table_new(pTHX)
9186 Newxz(tbl, 1, PTR_TBL_t);
9189 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9193 #define PTR_TABLE_HASH(ptr) \
9194 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9197 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9198 following define) and at call to new_body_inline made below in
9199 Perl_ptr_table_store()
9202 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9204 /* map an existing pointer using a table */
9206 STATIC PTR_TBL_ENT_t *
9207 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9208 PTR_TBL_ENT_t *tblent;
9209 const UV hash = PTR_TABLE_HASH(sv);
9211 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9212 for (; tblent; tblent = tblent->next) {
9213 if (tblent->oldval == sv)
9220 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9222 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9223 return tblent ? tblent->newval : (void *) 0;
9226 /* add a new entry to a pointer-mapping table */
9229 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9231 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9234 tblent->newval = newsv;
9236 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9238 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9239 tblent->oldval = oldsv;
9240 tblent->newval = newsv;
9241 tblent->next = tbl->tbl_ary[entry];
9242 tbl->tbl_ary[entry] = tblent;
9244 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9245 ptr_table_split(tbl);
9249 /* double the hash bucket size of an existing ptr table */
9252 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9254 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9255 const UV oldsize = tbl->tbl_max + 1;
9256 UV newsize = oldsize * 2;
9259 Renew(ary, newsize, PTR_TBL_ENT_t*);
9260 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9261 tbl->tbl_max = --newsize;
9263 for (i=0; i < oldsize; i++, ary++) {
9264 PTR_TBL_ENT_t **curentp, **entp, *ent;
9267 curentp = ary + oldsize;
9268 for (entp = ary, ent = *ary; ent; ent = *entp) {
9269 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9271 ent->next = *curentp;
9281 /* remove all the entries from a ptr table */
9284 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9286 if (tbl && tbl->tbl_items) {
9287 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9288 UV riter = tbl->tbl_max;
9291 PTR_TBL_ENT_t *entry = array[riter];
9294 PTR_TBL_ENT_t * const oentry = entry;
9295 entry = entry->next;
9304 /* clear and free a ptr table */
9307 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9312 ptr_table_clear(tbl);
9313 Safefree(tbl->tbl_ary);
9319 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9322 SvRV_set(dstr, SvWEAKREF(sstr)
9323 ? sv_dup(SvRV(sstr), param)
9324 : sv_dup_inc(SvRV(sstr), param));
9327 else if (SvPVX_const(sstr)) {
9328 /* Has something there */
9330 /* Normal PV - clone whole allocated space */
9331 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9332 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9333 /* Not that normal - actually sstr is copy on write.
9334 But we are a true, independant SV, so: */
9335 SvREADONLY_off(dstr);
9340 /* Special case - not normally malloced for some reason */
9341 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9342 /* A "shared" PV - clone it as "shared" PV */
9344 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9348 /* Some other special case - random pointer */
9349 SvPV_set(dstr, SvPVX(sstr));
9355 if (SvTYPE(dstr) == SVt_RV)
9356 SvRV_set(dstr, NULL);
9358 SvPV_set(dstr, NULL);
9362 /* duplicate an SV of any type (including AV, HV etc) */
9365 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9370 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9372 /* look for it in the table first */
9373 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9377 if(param->flags & CLONEf_JOIN_IN) {
9378 /** We are joining here so we don't want do clone
9379 something that is bad **/
9380 if (SvTYPE(sstr) == SVt_PVHV) {
9381 const char * const hvname = HvNAME_get(sstr);
9383 /** don't clone stashes if they already exist **/
9384 return (SV*)gv_stashpv(hvname,0);
9388 /* create anew and remember what it is */
9391 #ifdef DEBUG_LEAKING_SCALARS
9392 dstr->sv_debug_optype = sstr->sv_debug_optype;
9393 dstr->sv_debug_line = sstr->sv_debug_line;
9394 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9395 dstr->sv_debug_cloned = 1;
9396 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9399 ptr_table_store(PL_ptr_table, sstr, dstr);
9402 SvFLAGS(dstr) = SvFLAGS(sstr);
9403 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9404 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9407 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9408 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9409 PL_watch_pvx, SvPVX_const(sstr));
9412 /* don't clone objects whose class has asked us not to */
9413 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9414 SvFLAGS(dstr) &= ~SVTYPEMASK;
9419 switch (SvTYPE(sstr)) {
9424 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9425 SvIV_set(dstr, SvIVX(sstr));
9428 SvANY(dstr) = new_XNV();
9429 SvNV_set(dstr, SvNVX(sstr));
9432 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9433 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9437 /* These are all the types that need complex bodies allocating. */
9439 const svtype sv_type = SvTYPE(sstr);
9440 const struct body_details *const sv_type_details
9441 = bodies_by_type + sv_type;
9445 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9450 if (GvUNIQUE((GV*)sstr)) {
9451 /* Do sharing here, and fall through */
9464 assert(sv_type_details->size);
9465 if (sv_type_details->arena) {
9466 new_body_inline(new_body, sv_type_details->size, sv_type);
9468 = (void*)((char*)new_body - sv_type_details->offset);
9470 new_body = new_NOARENA(sv_type_details);
9474 SvANY(dstr) = new_body;
9477 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9478 ((char*)SvANY(dstr)) + sv_type_details->offset,
9479 sv_type_details->copy, char);
9481 Copy(((char*)SvANY(sstr)),
9482 ((char*)SvANY(dstr)),
9483 sv_type_details->size + sv_type_details->offset, char);
9486 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9487 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9489 /* The Copy above means that all the source (unduplicated) pointers
9490 are now in the destination. We can check the flags and the
9491 pointers in either, but it's possible that there's less cache
9492 missing by always going for the destination.
9493 FIXME - instrument and check that assumption */
9494 if (sv_type >= SVt_PVMG) {
9496 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9498 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9501 /* The cast silences a GCC warning about unhandled types. */
9502 switch ((int)sv_type) {
9514 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9515 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9516 LvTARG(dstr) = dstr;
9517 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9518 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9520 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9523 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9524 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9525 /* Don't call sv_add_backref here as it's going to be created
9526 as part of the magic cloning of the symbol table. */
9527 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9528 (void)GpREFCNT_inc(GvGP(dstr));
9531 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9532 if (IoOFP(dstr) == IoIFP(sstr))
9533 IoOFP(dstr) = IoIFP(dstr);
9535 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9536 /* PL_rsfp_filters entries have fake IoDIRP() */
9537 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9538 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9539 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9540 /* I have no idea why fake dirp (rsfps)
9541 should be treated differently but otherwise
9542 we end up with leaks -- sky*/
9543 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9544 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9545 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9547 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9548 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9549 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9551 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9552 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9553 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9556 if (AvARRAY((AV*)sstr)) {
9557 SV **dst_ary, **src_ary;
9558 SSize_t items = AvFILLp((AV*)sstr) + 1;
9560 src_ary = AvARRAY((AV*)sstr);
9561 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9562 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9563 SvPV_set(dstr, (char*)dst_ary);
9564 AvALLOC((AV*)dstr) = dst_ary;
9565 if (AvREAL((AV*)sstr)) {
9567 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9571 *dst_ary++ = sv_dup(*src_ary++, param);
9573 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9574 while (items-- > 0) {
9575 *dst_ary++ = &PL_sv_undef;
9579 SvPV_set(dstr, Nullch);
9580 AvALLOC((AV*)dstr) = (SV**)NULL;
9587 if (HvARRAY((HV*)sstr)) {
9589 const bool sharekeys = !!HvSHAREKEYS(sstr);
9590 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9591 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9593 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9594 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9596 HvARRAY(dstr) = (HE**)darray;
9597 while (i <= sxhv->xhv_max) {
9598 const HE *source = HvARRAY(sstr)[i];
9599 HvARRAY(dstr)[i] = source
9600 ? he_dup(source, sharekeys, param) : 0;
9604 struct xpvhv_aux * const saux = HvAUX(sstr);
9605 struct xpvhv_aux * const daux = HvAUX(dstr);
9606 /* This flag isn't copied. */
9607 /* SvOOK_on(hv) attacks the IV flags. */
9608 SvFLAGS(dstr) |= SVf_OOK;
9610 hvname = saux->xhv_name;
9612 = hvname ? hek_dup(hvname, param) : hvname;
9614 daux->xhv_riter = saux->xhv_riter;
9615 daux->xhv_eiter = saux->xhv_eiter
9616 ? he_dup(saux->xhv_eiter,
9617 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9618 daux->xhv_backreferences = saux->xhv_backreferences
9619 ? (AV*) SvREFCNT_inc(
9627 SvPV_set(dstr, Nullch);
9629 /* Record stashes for possible cloning in Perl_clone(). */
9631 av_push(param->stashes, dstr);
9636 /* NOTE: not refcounted */
9637 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9639 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9641 if (CvCONST(dstr)) {
9642 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9643 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9644 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9646 /* don't dup if copying back - CvGV isn't refcounted, so the
9647 * duped GV may never be freed. A bit of a hack! DAPM */
9648 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9649 Nullgv : gv_dup(CvGV(dstr), param) ;
9650 if (!(param->flags & CLONEf_COPY_STACKS)) {
9653 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9656 ? cv_dup( CvOUTSIDE(dstr), param)
9657 : cv_dup_inc(CvOUTSIDE(dstr), param);
9659 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9665 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9671 /* duplicate a context */
9674 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9679 return (PERL_CONTEXT*)NULL;
9681 /* look for it in the table first */
9682 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9686 /* create anew and remember what it is */
9687 Newxz(ncxs, max + 1, PERL_CONTEXT);
9688 ptr_table_store(PL_ptr_table, cxs, ncxs);
9691 PERL_CONTEXT * const cx = &cxs[ix];
9692 PERL_CONTEXT * const ncx = &ncxs[ix];
9693 ncx->cx_type = cx->cx_type;
9694 if (CxTYPE(cx) == CXt_SUBST) {
9695 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9698 ncx->blk_oldsp = cx->blk_oldsp;
9699 ncx->blk_oldcop = cx->blk_oldcop;
9700 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9701 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9702 ncx->blk_oldpm = cx->blk_oldpm;
9703 ncx->blk_gimme = cx->blk_gimme;
9704 switch (CxTYPE(cx)) {
9706 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9707 ? cv_dup_inc(cx->blk_sub.cv, param)
9708 : cv_dup(cx->blk_sub.cv,param));
9709 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9710 ? av_dup_inc(cx->blk_sub.argarray, param)
9712 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9713 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9714 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9715 ncx->blk_sub.lval = cx->blk_sub.lval;
9716 ncx->blk_sub.retop = cx->blk_sub.retop;
9719 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9720 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9721 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9722 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9723 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9724 ncx->blk_eval.retop = cx->blk_eval.retop;
9727 ncx->blk_loop.label = cx->blk_loop.label;
9728 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9729 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9730 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9731 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9732 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9733 ? cx->blk_loop.iterdata
9734 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9735 ncx->blk_loop.oldcomppad
9736 = (PAD*)ptr_table_fetch(PL_ptr_table,
9737 cx->blk_loop.oldcomppad);
9738 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9739 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9740 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9741 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9742 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9745 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9746 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9747 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9748 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9749 ncx->blk_sub.retop = cx->blk_sub.retop;
9761 /* duplicate a stack info structure */
9764 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9769 return (PERL_SI*)NULL;
9771 /* look for it in the table first */
9772 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9776 /* create anew and remember what it is */
9777 Newxz(nsi, 1, PERL_SI);
9778 ptr_table_store(PL_ptr_table, si, nsi);
9780 nsi->si_stack = av_dup_inc(si->si_stack, param);
9781 nsi->si_cxix = si->si_cxix;
9782 nsi->si_cxmax = si->si_cxmax;
9783 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9784 nsi->si_type = si->si_type;
9785 nsi->si_prev = si_dup(si->si_prev, param);
9786 nsi->si_next = si_dup(si->si_next, param);
9787 nsi->si_markoff = si->si_markoff;
9792 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9793 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9794 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9795 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9796 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9797 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9798 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9799 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9800 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9801 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9802 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9803 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9804 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9805 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9808 #define pv_dup_inc(p) SAVEPV(p)
9809 #define pv_dup(p) SAVEPV(p)
9810 #define svp_dup_inc(p,pp) any_dup(p,pp)
9812 /* map any object to the new equivent - either something in the
9813 * ptr table, or something in the interpreter structure
9817 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9824 /* look for it in the table first */
9825 ret = ptr_table_fetch(PL_ptr_table, v);
9829 /* see if it is part of the interpreter structure */
9830 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9831 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9839 /* duplicate the save stack */
9842 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9844 ANY * const ss = proto_perl->Tsavestack;
9845 const I32 max = proto_perl->Tsavestack_max;
9846 I32 ix = proto_perl->Tsavestack_ix;
9858 void (*dptr) (void*);
9859 void (*dxptr) (pTHX_ void*);
9861 Newxz(nss, max, ANY);
9864 I32 i = POPINT(ss,ix);
9867 case SAVEt_ITEM: /* normal string */
9868 sv = (SV*)POPPTR(ss,ix);
9869 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9870 sv = (SV*)POPPTR(ss,ix);
9871 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9873 case SAVEt_SV: /* scalar reference */
9874 sv = (SV*)POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9876 gv = (GV*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9879 case SAVEt_GENERIC_PVREF: /* generic char* */
9880 c = (char*)POPPTR(ss,ix);
9881 TOPPTR(nss,ix) = pv_dup(c);
9882 ptr = POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9885 case SAVEt_SHARED_PVREF: /* char* in shared space */
9886 c = (char*)POPPTR(ss,ix);
9887 TOPPTR(nss,ix) = savesharedpv(c);
9888 ptr = POPPTR(ss,ix);
9889 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9891 case SAVEt_GENERIC_SVREF: /* generic sv */
9892 case SAVEt_SVREF: /* scalar reference */
9893 sv = (SV*)POPPTR(ss,ix);
9894 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9895 ptr = POPPTR(ss,ix);
9896 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9898 case SAVEt_AV: /* array reference */
9899 av = (AV*)POPPTR(ss,ix);
9900 TOPPTR(nss,ix) = av_dup_inc(av, param);
9901 gv = (GV*)POPPTR(ss,ix);
9902 TOPPTR(nss,ix) = gv_dup(gv, param);
9904 case SAVEt_HV: /* hash reference */
9905 hv = (HV*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9907 gv = (GV*)POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = gv_dup(gv, param);
9910 case SAVEt_INT: /* int reference */
9911 ptr = POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9913 intval = (int)POPINT(ss,ix);
9914 TOPINT(nss,ix) = intval;
9916 case SAVEt_LONG: /* long reference */
9917 ptr = POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9919 longval = (long)POPLONG(ss,ix);
9920 TOPLONG(nss,ix) = longval;
9922 case SAVEt_I32: /* I32 reference */
9923 case SAVEt_I16: /* I16 reference */
9924 case SAVEt_I8: /* I8 reference */
9925 ptr = POPPTR(ss,ix);
9926 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9930 case SAVEt_IV: /* IV reference */
9931 ptr = POPPTR(ss,ix);
9932 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9936 case SAVEt_SPTR: /* SV* reference */
9937 ptr = POPPTR(ss,ix);
9938 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9939 sv = (SV*)POPPTR(ss,ix);
9940 TOPPTR(nss,ix) = sv_dup(sv, param);
9942 case SAVEt_VPTR: /* random* reference */
9943 ptr = POPPTR(ss,ix);
9944 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9945 ptr = POPPTR(ss,ix);
9946 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9948 case SAVEt_PPTR: /* char* reference */
9949 ptr = POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9951 c = (char*)POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = pv_dup(c);
9954 case SAVEt_HPTR: /* HV* reference */
9955 ptr = POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9957 hv = (HV*)POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = hv_dup(hv, param);
9960 case SAVEt_APTR: /* AV* reference */
9961 ptr = POPPTR(ss,ix);
9962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9963 av = (AV*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = av_dup(av, param);
9967 gv = (GV*)POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = gv_dup(gv, param);
9970 case SAVEt_GP: /* scalar reference */
9971 gp = (GP*)POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9973 (void)GpREFCNT_inc(gp);
9974 gv = (GV*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9976 c = (char*)POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = pv_dup(c);
9984 case SAVEt_MORTALIZESV:
9985 sv = (SV*)POPPTR(ss,ix);
9986 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9989 ptr = POPPTR(ss,ix);
9990 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9991 /* these are assumed to be refcounted properly */
9993 switch (((OP*)ptr)->op_type) {
10000 TOPPTR(nss,ix) = ptr;
10005 TOPPTR(nss,ix) = Nullop;
10010 TOPPTR(nss,ix) = Nullop;
10013 c = (char*)POPPTR(ss,ix);
10014 TOPPTR(nss,ix) = pv_dup_inc(c);
10016 case SAVEt_CLEARSV:
10017 longval = POPLONG(ss,ix);
10018 TOPLONG(nss,ix) = longval;
10021 hv = (HV*)POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10023 c = (char*)POPPTR(ss,ix);
10024 TOPPTR(nss,ix) = pv_dup_inc(c);
10026 TOPINT(nss,ix) = i;
10028 case SAVEt_DESTRUCTOR:
10029 ptr = POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10031 dptr = POPDPTR(ss,ix);
10032 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10033 any_dup(FPTR2DPTR(void *, dptr),
10036 case SAVEt_DESTRUCTOR_X:
10037 ptr = POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10039 dxptr = POPDXPTR(ss,ix);
10040 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10041 any_dup(FPTR2DPTR(void *, dxptr),
10044 case SAVEt_REGCONTEXT:
10047 TOPINT(nss,ix) = i;
10050 case SAVEt_STACK_POS: /* Position on Perl stack */
10052 TOPINT(nss,ix) = i;
10054 case SAVEt_AELEM: /* array element */
10055 sv = (SV*)POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10058 TOPINT(nss,ix) = i;
10059 av = (AV*)POPPTR(ss,ix);
10060 TOPPTR(nss,ix) = av_dup_inc(av, param);
10062 case SAVEt_HELEM: /* hash element */
10063 sv = (SV*)POPPTR(ss,ix);
10064 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10065 sv = (SV*)POPPTR(ss,ix);
10066 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10067 hv = (HV*)POPPTR(ss,ix);
10068 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10071 ptr = POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = ptr;
10076 TOPINT(nss,ix) = i;
10078 case SAVEt_COMPPAD:
10079 av = (AV*)POPPTR(ss,ix);
10080 TOPPTR(nss,ix) = av_dup(av, param);
10083 longval = (long)POPLONG(ss,ix);
10084 TOPLONG(nss,ix) = longval;
10085 ptr = POPPTR(ss,ix);
10086 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10087 sv = (SV*)POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = sv_dup(sv, param);
10091 ptr = POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10093 longval = (long)POPBOOL(ss,ix);
10094 TOPBOOL(nss,ix) = (bool)longval;
10096 case SAVEt_SET_SVFLAGS:
10098 TOPINT(nss,ix) = i;
10100 TOPINT(nss,ix) = i;
10101 sv = (SV*)POPPTR(ss,ix);
10102 TOPPTR(nss,ix) = sv_dup(sv, param);
10105 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10113 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10114 * flag to the result. This is done for each stash before cloning starts,
10115 * so we know which stashes want their objects cloned */
10118 do_mark_cloneable_stash(pTHX_ SV *sv)
10120 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10122 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10123 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10124 if (cloner && GvCV(cloner)) {
10131 XPUSHs(sv_2mortal(newSVhek(hvname)));
10133 call_sv((SV*)GvCV(cloner), G_SCALAR);
10140 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10148 =for apidoc perl_clone
10150 Create and return a new interpreter by cloning the current one.
10152 perl_clone takes these flags as parameters:
10154 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10155 without it we only clone the data and zero the stacks,
10156 with it we copy the stacks and the new perl interpreter is
10157 ready to run at the exact same point as the previous one.
10158 The pseudo-fork code uses COPY_STACKS while the
10159 threads->new doesn't.
10161 CLONEf_KEEP_PTR_TABLE
10162 perl_clone keeps a ptr_table with the pointer of the old
10163 variable as a key and the new variable as a value,
10164 this allows it to check if something has been cloned and not
10165 clone it again but rather just use the value and increase the
10166 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10167 the ptr_table using the function
10168 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10169 reason to keep it around is if you want to dup some of your own
10170 variable who are outside the graph perl scans, example of this
10171 code is in threads.xs create
10174 This is a win32 thing, it is ignored on unix, it tells perls
10175 win32host code (which is c++) to clone itself, this is needed on
10176 win32 if you want to run two threads at the same time,
10177 if you just want to do some stuff in a separate perl interpreter
10178 and then throw it away and return to the original one,
10179 you don't need to do anything.
10184 /* XXX the above needs expanding by someone who actually understands it ! */
10185 EXTERN_C PerlInterpreter *
10186 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10189 perl_clone(PerlInterpreter *proto_perl, UV flags)
10192 #ifdef PERL_IMPLICIT_SYS
10194 /* perlhost.h so we need to call into it
10195 to clone the host, CPerlHost should have a c interface, sky */
10197 if (flags & CLONEf_CLONE_HOST) {
10198 return perl_clone_host(proto_perl,flags);
10200 return perl_clone_using(proto_perl, flags,
10202 proto_perl->IMemShared,
10203 proto_perl->IMemParse,
10205 proto_perl->IStdIO,
10209 proto_perl->IProc);
10213 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10214 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10215 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10216 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10217 struct IPerlDir* ipD, struct IPerlSock* ipS,
10218 struct IPerlProc* ipP)
10220 /* XXX many of the string copies here can be optimized if they're
10221 * constants; they need to be allocated as common memory and just
10222 * their pointers copied. */
10225 CLONE_PARAMS clone_params;
10226 CLONE_PARAMS* param = &clone_params;
10228 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10229 /* for each stash, determine whether its objects should be cloned */
10230 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10231 PERL_SET_THX(my_perl);
10234 Poison(my_perl, 1, PerlInterpreter);
10236 PL_curcop = (COP *)Nullop;
10240 PL_savestack_ix = 0;
10241 PL_savestack_max = -1;
10242 PL_sig_pending = 0;
10243 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10244 # else /* !DEBUGGING */
10245 Zero(my_perl, 1, PerlInterpreter);
10246 # endif /* DEBUGGING */
10248 /* host pointers */
10250 PL_MemShared = ipMS;
10251 PL_MemParse = ipMP;
10258 #else /* !PERL_IMPLICIT_SYS */
10260 CLONE_PARAMS clone_params;
10261 CLONE_PARAMS* param = &clone_params;
10262 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10263 /* for each stash, determine whether its objects should be cloned */
10264 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10265 PERL_SET_THX(my_perl);
10268 Poison(my_perl, 1, PerlInterpreter);
10270 PL_curcop = (COP *)Nullop;
10274 PL_savestack_ix = 0;
10275 PL_savestack_max = -1;
10276 PL_sig_pending = 0;
10277 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10278 # else /* !DEBUGGING */
10279 Zero(my_perl, 1, PerlInterpreter);
10280 # endif /* DEBUGGING */
10281 #endif /* PERL_IMPLICIT_SYS */
10282 param->flags = flags;
10283 param->proto_perl = proto_perl;
10285 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10286 Zero(&PL_body_roots, 1, PL_body_roots);
10288 PL_nice_chunk = NULL;
10289 PL_nice_chunk_size = 0;
10291 PL_sv_objcount = 0;
10292 PL_sv_root = Nullsv;
10293 PL_sv_arenaroot = Nullsv;
10295 PL_debug = proto_perl->Idebug;
10297 PL_hash_seed = proto_perl->Ihash_seed;
10298 PL_rehash_seed = proto_perl->Irehash_seed;
10300 #ifdef USE_REENTRANT_API
10301 /* XXX: things like -Dm will segfault here in perlio, but doing
10302 * PERL_SET_CONTEXT(proto_perl);
10303 * breaks too many other things
10305 Perl_reentrant_init(aTHX);
10308 /* create SV map for pointer relocation */
10309 PL_ptr_table = ptr_table_new();
10311 /* initialize these special pointers as early as possible */
10312 SvANY(&PL_sv_undef) = NULL;
10313 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10314 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10315 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10317 SvANY(&PL_sv_no) = new_XPVNV();
10318 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10319 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10320 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10321 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10322 SvCUR_set(&PL_sv_no, 0);
10323 SvLEN_set(&PL_sv_no, 1);
10324 SvIV_set(&PL_sv_no, 0);
10325 SvNV_set(&PL_sv_no, 0);
10326 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10328 SvANY(&PL_sv_yes) = new_XPVNV();
10329 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10330 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10331 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10332 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10333 SvCUR_set(&PL_sv_yes, 1);
10334 SvLEN_set(&PL_sv_yes, 2);
10335 SvIV_set(&PL_sv_yes, 1);
10336 SvNV_set(&PL_sv_yes, 1);
10337 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10339 /* create (a non-shared!) shared string table */
10340 PL_strtab = newHV();
10341 HvSHAREKEYS_off(PL_strtab);
10342 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10343 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10345 PL_compiling = proto_perl->Icompiling;
10347 /* These two PVs will be free'd special way so must set them same way op.c does */
10348 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10349 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10351 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10352 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10354 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10355 if (!specialWARN(PL_compiling.cop_warnings))
10356 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10357 if (!specialCopIO(PL_compiling.cop_io))
10358 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10359 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10361 /* pseudo environmental stuff */
10362 PL_origargc = proto_perl->Iorigargc;
10363 PL_origargv = proto_perl->Iorigargv;
10365 param->stashes = newAV(); /* Setup array of objects to call clone on */
10367 /* Set tainting stuff before PerlIO_debug can possibly get called */
10368 PL_tainting = proto_perl->Itainting;
10369 PL_taint_warn = proto_perl->Itaint_warn;
10371 #ifdef PERLIO_LAYERS
10372 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10373 PerlIO_clone(aTHX_ proto_perl, param);
10376 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10377 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10378 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10379 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10380 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10381 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10384 PL_minus_c = proto_perl->Iminus_c;
10385 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10386 PL_localpatches = proto_perl->Ilocalpatches;
10387 PL_splitstr = proto_perl->Isplitstr;
10388 PL_preprocess = proto_perl->Ipreprocess;
10389 PL_minus_n = proto_perl->Iminus_n;
10390 PL_minus_p = proto_perl->Iminus_p;
10391 PL_minus_l = proto_perl->Iminus_l;
10392 PL_minus_a = proto_perl->Iminus_a;
10393 PL_minus_E = proto_perl->Iminus_E;
10394 PL_minus_F = proto_perl->Iminus_F;
10395 PL_doswitches = proto_perl->Idoswitches;
10396 PL_dowarn = proto_perl->Idowarn;
10397 PL_doextract = proto_perl->Idoextract;
10398 PL_sawampersand = proto_perl->Isawampersand;
10399 PL_unsafe = proto_perl->Iunsafe;
10400 PL_inplace = SAVEPV(proto_perl->Iinplace);
10401 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10402 PL_perldb = proto_perl->Iperldb;
10403 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10404 PL_exit_flags = proto_perl->Iexit_flags;
10406 /* magical thingies */
10407 /* XXX time(&PL_basetime) when asked for? */
10408 PL_basetime = proto_perl->Ibasetime;
10409 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10411 PL_maxsysfd = proto_perl->Imaxsysfd;
10412 PL_multiline = proto_perl->Imultiline;
10413 PL_statusvalue = proto_perl->Istatusvalue;
10415 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10417 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10419 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10421 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10422 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10423 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10425 /* Clone the regex array */
10426 PL_regex_padav = newAV();
10428 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10429 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10431 av_push(PL_regex_padav,
10432 sv_dup_inc(regexen[0],param));
10433 for(i = 1; i <= len; i++) {
10434 const SV * const regex = regexen[i];
10437 ? sv_dup_inc(regex, param)
10439 newSViv(PTR2IV(re_dup(
10440 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10442 av_push(PL_regex_padav, sv);
10445 PL_regex_pad = AvARRAY(PL_regex_padav);
10447 /* shortcuts to various I/O objects */
10448 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10449 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10450 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10451 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10452 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10453 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10455 /* shortcuts to regexp stuff */
10456 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10458 /* shortcuts to misc objects */
10459 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10461 /* shortcuts to debugging objects */
10462 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10463 PL_DBline = gv_dup(proto_perl->IDBline, param);
10464 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10465 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10466 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10467 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10468 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10469 PL_lineary = av_dup(proto_perl->Ilineary, param);
10470 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10472 /* symbol tables */
10473 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10474 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10475 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10476 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10477 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10479 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10480 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10481 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10482 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10483 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10484 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10486 PL_sub_generation = proto_perl->Isub_generation;
10488 /* funky return mechanisms */
10489 PL_forkprocess = proto_perl->Iforkprocess;
10491 /* subprocess state */
10492 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10494 /* internal state */
10495 PL_maxo = proto_perl->Imaxo;
10496 if (proto_perl->Iop_mask)
10497 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10499 PL_op_mask = Nullch;
10500 /* PL_asserting = proto_perl->Iasserting; */
10502 /* current interpreter roots */
10503 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10504 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10505 PL_main_start = proto_perl->Imain_start;
10506 PL_eval_root = proto_perl->Ieval_root;
10507 PL_eval_start = proto_perl->Ieval_start;
10509 /* runtime control stuff */
10510 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10511 PL_copline = proto_perl->Icopline;
10513 PL_filemode = proto_perl->Ifilemode;
10514 PL_lastfd = proto_perl->Ilastfd;
10515 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10518 PL_gensym = proto_perl->Igensym;
10519 PL_preambled = proto_perl->Ipreambled;
10520 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10521 PL_laststatval = proto_perl->Ilaststatval;
10522 PL_laststype = proto_perl->Ilaststype;
10523 PL_mess_sv = Nullsv;
10525 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10527 /* interpreter atexit processing */
10528 PL_exitlistlen = proto_perl->Iexitlistlen;
10529 if (PL_exitlistlen) {
10530 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10531 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10534 PL_exitlist = (PerlExitListEntry*)NULL;
10536 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10537 if (PL_my_cxt_size) {
10538 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10539 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10542 PL_my_cxt_list = (void**)NULL;
10543 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10544 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10545 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10547 PL_profiledata = NULL;
10548 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10549 /* PL_rsfp_filters entries have fake IoDIRP() */
10550 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10552 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10554 PAD_CLONE_VARS(proto_perl, param);
10556 #ifdef HAVE_INTERP_INTERN
10557 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10560 /* more statics moved here */
10561 PL_generation = proto_perl->Igeneration;
10562 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10564 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10565 PL_in_clean_all = proto_perl->Iin_clean_all;
10567 PL_uid = proto_perl->Iuid;
10568 PL_euid = proto_perl->Ieuid;
10569 PL_gid = proto_perl->Igid;
10570 PL_egid = proto_perl->Iegid;
10571 PL_nomemok = proto_perl->Inomemok;
10572 PL_an = proto_perl->Ian;
10573 PL_evalseq = proto_perl->Ievalseq;
10574 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10575 PL_origalen = proto_perl->Iorigalen;
10576 #ifdef PERL_USES_PL_PIDSTATUS
10577 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10579 PL_osname = SAVEPV(proto_perl->Iosname);
10580 PL_sighandlerp = proto_perl->Isighandlerp;
10582 PL_runops = proto_perl->Irunops;
10584 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10587 PL_cshlen = proto_perl->Icshlen;
10588 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10591 PL_lex_state = proto_perl->Ilex_state;
10592 PL_lex_defer = proto_perl->Ilex_defer;
10593 PL_lex_expect = proto_perl->Ilex_expect;
10594 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10595 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10596 PL_lex_starts = proto_perl->Ilex_starts;
10597 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10598 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10599 PL_lex_op = proto_perl->Ilex_op;
10600 PL_lex_inpat = proto_perl->Ilex_inpat;
10601 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10602 PL_lex_brackets = proto_perl->Ilex_brackets;
10603 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10604 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10605 PL_lex_casemods = proto_perl->Ilex_casemods;
10606 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10607 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10609 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10610 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10611 PL_nexttoke = proto_perl->Inexttoke;
10613 /* XXX This is probably masking the deeper issue of why
10614 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10615 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10616 * (A little debugging with a watchpoint on it may help.)
10618 if (SvANY(proto_perl->Ilinestr)) {
10619 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10620 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10621 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10622 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10623 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10624 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10625 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10626 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10627 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10630 PL_linestr = newSV(79);
10631 sv_upgrade(PL_linestr,SVt_PVIV);
10632 sv_setpvn(PL_linestr,"",0);
10633 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10635 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10636 PL_pending_ident = proto_perl->Ipending_ident;
10637 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10639 PL_expect = proto_perl->Iexpect;
10641 PL_multi_start = proto_perl->Imulti_start;
10642 PL_multi_end = proto_perl->Imulti_end;
10643 PL_multi_open = proto_perl->Imulti_open;
10644 PL_multi_close = proto_perl->Imulti_close;
10646 PL_error_count = proto_perl->Ierror_count;
10647 PL_subline = proto_perl->Isubline;
10648 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10650 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10651 if (SvANY(proto_perl->Ilinestr)) {
10652 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10653 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10654 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10655 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10656 PL_last_lop_op = proto_perl->Ilast_lop_op;
10659 PL_last_uni = SvPVX(PL_linestr);
10660 PL_last_lop = SvPVX(PL_linestr);
10661 PL_last_lop_op = 0;
10663 PL_in_my = proto_perl->Iin_my;
10664 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10666 PL_cryptseen = proto_perl->Icryptseen;
10669 PL_hints = proto_perl->Ihints;
10671 PL_amagic_generation = proto_perl->Iamagic_generation;
10673 #ifdef USE_LOCALE_COLLATE
10674 PL_collation_ix = proto_perl->Icollation_ix;
10675 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10676 PL_collation_standard = proto_perl->Icollation_standard;
10677 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10678 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10679 #endif /* USE_LOCALE_COLLATE */
10681 #ifdef USE_LOCALE_NUMERIC
10682 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10683 PL_numeric_standard = proto_perl->Inumeric_standard;
10684 PL_numeric_local = proto_perl->Inumeric_local;
10685 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10686 #endif /* !USE_LOCALE_NUMERIC */
10688 /* utf8 character classes */
10689 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10690 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10691 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10692 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10693 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10694 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10695 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10696 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10697 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10698 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10699 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10700 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10701 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10702 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10703 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10704 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10705 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10706 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10707 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10708 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10710 /* Did the locale setup indicate UTF-8? */
10711 PL_utf8locale = proto_perl->Iutf8locale;
10712 /* Unicode features (see perlrun/-C) */
10713 PL_unicode = proto_perl->Iunicode;
10715 /* Pre-5.8 signals control */
10716 PL_signals = proto_perl->Isignals;
10718 /* times() ticks per second */
10719 PL_clocktick = proto_perl->Iclocktick;
10721 /* Recursion stopper for PerlIO_find_layer */
10722 PL_in_load_module = proto_perl->Iin_load_module;
10724 /* sort() routine */
10725 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10727 /* Not really needed/useful since the reenrant_retint is "volatile",
10728 * but do it for consistency's sake. */
10729 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10731 /* Hooks to shared SVs and locks. */
10732 PL_sharehook = proto_perl->Isharehook;
10733 PL_lockhook = proto_perl->Ilockhook;
10734 PL_unlockhook = proto_perl->Iunlockhook;
10735 PL_threadhook = proto_perl->Ithreadhook;
10737 PL_runops_std = proto_perl->Irunops_std;
10738 PL_runops_dbg = proto_perl->Irunops_dbg;
10740 #ifdef THREADS_HAVE_PIDS
10741 PL_ppid = proto_perl->Ippid;
10745 PL_last_swash_hv = NULL; /* reinits on demand */
10746 PL_last_swash_klen = 0;
10747 PL_last_swash_key[0]= '\0';
10748 PL_last_swash_tmps = (U8*)NULL;
10749 PL_last_swash_slen = 0;
10751 PL_glob_index = proto_perl->Iglob_index;
10752 PL_srand_called = proto_perl->Isrand_called;
10753 PL_uudmap['M'] = 0; /* reinits on demand */
10754 PL_bitcount = Nullch; /* reinits on demand */
10756 if (proto_perl->Ipsig_pend) {
10757 Newxz(PL_psig_pend, SIG_SIZE, int);
10760 PL_psig_pend = (int*)NULL;
10763 if (proto_perl->Ipsig_ptr) {
10764 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10765 Newxz(PL_psig_name, SIG_SIZE, SV*);
10766 for (i = 1; i < SIG_SIZE; i++) {
10767 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10768 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10772 PL_psig_ptr = (SV**)NULL;
10773 PL_psig_name = (SV**)NULL;
10776 /* thrdvar.h stuff */
10778 if (flags & CLONEf_COPY_STACKS) {
10779 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10780 PL_tmps_ix = proto_perl->Ttmps_ix;
10781 PL_tmps_max = proto_perl->Ttmps_max;
10782 PL_tmps_floor = proto_perl->Ttmps_floor;
10783 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10785 while (i <= PL_tmps_ix) {
10786 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10790 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10791 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10792 Newxz(PL_markstack, i, I32);
10793 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10794 - proto_perl->Tmarkstack);
10795 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10796 - proto_perl->Tmarkstack);
10797 Copy(proto_perl->Tmarkstack, PL_markstack,
10798 PL_markstack_ptr - PL_markstack + 1, I32);
10800 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10801 * NOTE: unlike the others! */
10802 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10803 PL_scopestack_max = proto_perl->Tscopestack_max;
10804 Newxz(PL_scopestack, PL_scopestack_max, I32);
10805 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10807 /* NOTE: si_dup() looks at PL_markstack */
10808 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10810 /* PL_curstack = PL_curstackinfo->si_stack; */
10811 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10812 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10814 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10815 PL_stack_base = AvARRAY(PL_curstack);
10816 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10817 - proto_perl->Tstack_base);
10818 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10820 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10821 * NOTE: unlike the others! */
10822 PL_savestack_ix = proto_perl->Tsavestack_ix;
10823 PL_savestack_max = proto_perl->Tsavestack_max;
10824 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10825 PL_savestack = ss_dup(proto_perl, param);
10829 ENTER; /* perl_destruct() wants to LEAVE; */
10831 /* although we're not duplicating the tmps stack, we should still
10832 * add entries for any SVs on the tmps stack that got cloned by a
10833 * non-refcount means (eg a temp in @_); otherwise they will be
10836 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10837 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10838 proto_perl->Ttmps_stack[i]);
10839 if (nsv && !SvREFCNT(nsv)) {
10841 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10846 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10847 PL_top_env = &PL_start_env;
10849 PL_op = proto_perl->Top;
10852 PL_Xpv = (XPV*)NULL;
10853 PL_na = proto_perl->Tna;
10855 PL_statbuf = proto_perl->Tstatbuf;
10856 PL_statcache = proto_perl->Tstatcache;
10857 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10858 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10860 PL_timesbuf = proto_perl->Ttimesbuf;
10863 PL_tainted = proto_perl->Ttainted;
10864 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10865 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10866 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10867 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10868 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10869 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10870 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10871 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10872 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10874 PL_restartop = proto_perl->Trestartop;
10875 PL_in_eval = proto_perl->Tin_eval;
10876 PL_delaymagic = proto_perl->Tdelaymagic;
10877 PL_dirty = proto_perl->Tdirty;
10878 PL_localizing = proto_perl->Tlocalizing;
10880 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10881 PL_hv_fetch_ent_mh = Nullhe;
10882 PL_modcount = proto_perl->Tmodcount;
10883 PL_lastgotoprobe = Nullop;
10884 PL_dumpindent = proto_perl->Tdumpindent;
10886 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10887 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10888 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10889 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10890 PL_efloatbuf = Nullch; /* reinits on demand */
10891 PL_efloatsize = 0; /* reinits on demand */
10895 PL_screamfirst = NULL;
10896 PL_screamnext = NULL;
10897 PL_maxscream = -1; /* reinits on demand */
10898 PL_lastscream = Nullsv;
10900 PL_watchaddr = NULL;
10901 PL_watchok = Nullch;
10903 PL_regdummy = proto_perl->Tregdummy;
10904 PL_regprecomp = Nullch;
10907 PL_colorset = 0; /* reinits PL_colors[] */
10908 /*PL_colors[6] = {0,0,0,0,0,0};*/
10909 PL_reginput = Nullch;
10910 PL_regbol = Nullch;
10911 PL_regeol = Nullch;
10912 PL_regstartp = (I32*)NULL;
10913 PL_regendp = (I32*)NULL;
10914 PL_reglastparen = (U32*)NULL;
10915 PL_reglastcloseparen = (U32*)NULL;
10916 PL_regtill = Nullch;
10917 PL_reg_start_tmp = (char**)NULL;
10918 PL_reg_start_tmpl = 0;
10919 PL_regdata = (struct reg_data*)NULL;
10922 PL_reg_eval_set = 0;
10924 PL_regprogram = (regnode*)NULL;
10926 PL_regcc = (CURCUR*)NULL;
10927 PL_reg_call_cc = (struct re_cc_state*)NULL;
10928 PL_reg_re = (regexp*)NULL;
10929 PL_reg_ganch = Nullch;
10930 PL_reg_sv = Nullsv;
10931 PL_reg_match_utf8 = FALSE;
10932 PL_reg_magic = (MAGIC*)NULL;
10934 PL_reg_oldcurpm = (PMOP*)NULL;
10935 PL_reg_curpm = (PMOP*)NULL;
10936 PL_reg_oldsaved = Nullch;
10937 PL_reg_oldsavedlen = 0;
10938 #ifdef PERL_OLD_COPY_ON_WRITE
10941 PL_reg_maxiter = 0;
10942 PL_reg_leftiter = 0;
10943 PL_reg_poscache = Nullch;
10944 PL_reg_poscache_size= 0;
10946 /* RE engine - function pointers */
10947 PL_regcompp = proto_perl->Tregcompp;
10948 PL_regexecp = proto_perl->Tregexecp;
10949 PL_regint_start = proto_perl->Tregint_start;
10950 PL_regint_string = proto_perl->Tregint_string;
10951 PL_regfree = proto_perl->Tregfree;
10953 PL_reginterp_cnt = 0;
10954 PL_reg_starttry = 0;
10956 /* Pluggable optimizer */
10957 PL_peepp = proto_perl->Tpeepp;
10959 PL_stashcache = newHV();
10961 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10962 ptr_table_free(PL_ptr_table);
10963 PL_ptr_table = NULL;
10966 /* Call the ->CLONE method, if it exists, for each of the stashes
10967 identified by sv_dup() above.
10969 while(av_len(param->stashes) != -1) {
10970 HV* const stash = (HV*) av_shift(param->stashes);
10971 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10972 if (cloner && GvCV(cloner)) {
10977 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10979 call_sv((SV*)GvCV(cloner), G_DISCARD);
10985 SvREFCNT_dec(param->stashes);
10987 /* orphaned? eg threads->new inside BEGIN or use */
10988 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10989 (void)SvREFCNT_inc(PL_compcv);
10990 SAVEFREESV(PL_compcv);
10996 #endif /* USE_ITHREADS */
10999 =head1 Unicode Support
11001 =for apidoc sv_recode_to_utf8
11003 The encoding is assumed to be an Encode object, on entry the PV
11004 of the sv is assumed to be octets in that encoding, and the sv
11005 will be converted into Unicode (and UTF-8).
11007 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11008 is not a reference, nothing is done to the sv. If the encoding is not
11009 an C<Encode::XS> Encoding object, bad things will happen.
11010 (See F<lib/encoding.pm> and L<Encode>).
11012 The PV of the sv is returned.
11017 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11020 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11034 Passing sv_yes is wrong - it needs to be or'ed set of constants
11035 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11036 remove converted chars from source.
11038 Both will default the value - let them.
11040 XPUSHs(&PL_sv_yes);
11043 call_method("decode", G_SCALAR);
11047 s = SvPV_const(uni, len);
11048 if (s != SvPVX_const(sv)) {
11049 SvGROW(sv, len + 1);
11050 Move(s, SvPVX(sv), len + 1, char);
11051 SvCUR_set(sv, len);
11058 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11062 =for apidoc sv_cat_decode
11064 The encoding is assumed to be an Encode object, the PV of the ssv is
11065 assumed to be octets in that encoding and decoding the input starts
11066 from the position which (PV + *offset) pointed to. The dsv will be
11067 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11068 when the string tstr appears in decoding output or the input ends on
11069 the PV of the ssv. The value which the offset points will be modified
11070 to the last input position on the ssv.
11072 Returns TRUE if the terminator was found, else returns FALSE.
11077 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11078 SV *ssv, int *offset, char *tstr, int tlen)
11082 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11093 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11094 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11096 call_method("cat_decode", G_SCALAR);
11098 ret = SvTRUE(TOPs);
11099 *offset = SvIV(offsv);
11105 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11110 /* ---------------------------------------------------------------------
11112 * support functions for report_uninit()
11115 /* the maxiumum size of array or hash where we will scan looking
11116 * for the undefined element that triggered the warning */
11118 #define FUV_MAX_SEARCH_SIZE 1000
11120 /* Look for an entry in the hash whose value has the same SV as val;
11121 * If so, return a mortal copy of the key. */
11124 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11127 register HE **array;
11130 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11131 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11134 array = HvARRAY(hv);
11136 for (i=HvMAX(hv); i>0; i--) {
11137 register HE *entry;
11138 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11139 if (HeVAL(entry) != val)
11141 if ( HeVAL(entry) == &PL_sv_undef ||
11142 HeVAL(entry) == &PL_sv_placeholder)
11146 if (HeKLEN(entry) == HEf_SVKEY)
11147 return sv_mortalcopy(HeKEY_sv(entry));
11148 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11154 /* Look for an entry in the array whose value has the same SV as val;
11155 * If so, return the index, otherwise return -1. */
11158 S_find_array_subscript(pTHX_ AV *av, SV* val)
11163 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11164 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11168 for (i=AvFILLp(av); i>=0; i--) {
11169 if (svp[i] == val && svp[i] != &PL_sv_undef)
11175 /* S_varname(): return the name of a variable, optionally with a subscript.
11176 * If gv is non-zero, use the name of that global, along with gvtype (one
11177 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11178 * targ. Depending on the value of the subscript_type flag, return:
11181 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11182 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11183 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11184 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11187 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11188 SV* keyname, I32 aindex, int subscript_type)
11191 SV * const name = sv_newmortal();
11194 buffer[0] = gvtype;
11197 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11199 gv_fullname4(name, gv, buffer, 0);
11201 if ((unsigned int)SvPVX(name)[1] <= 26) {
11203 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11205 /* Swap the 1 unprintable control character for the 2 byte pretty
11206 version - ie substr($name, 1, 1) = $buffer; */
11207 sv_insert(name, 1, 1, buffer, 2);
11212 CV * const cv = find_runcv(&unused);
11216 if (!cv || !CvPADLIST(cv))
11218 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11219 sv = *av_fetch(av, targ, FALSE);
11220 /* SvLEN in a pad name is not to be trusted */
11221 sv_setpv(name, SvPV_nolen_const(sv));
11224 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11225 SV * const sv = newSV(0);
11226 *SvPVX(name) = '$';
11227 Perl_sv_catpvf(aTHX_ name, "{%s}",
11228 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11231 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11232 *SvPVX(name) = '$';
11233 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11235 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11236 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11243 =for apidoc find_uninit_var
11245 Find the name of the undefined variable (if any) that caused the operator o
11246 to issue a "Use of uninitialized value" warning.
11247 If match is true, only return a name if it's value matches uninit_sv.
11248 So roughly speaking, if a unary operator (such as OP_COS) generates a
11249 warning, then following the direct child of the op may yield an
11250 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11251 other hand, with OP_ADD there are two branches to follow, so we only print
11252 the variable name if we get an exact match.
11254 The name is returned as a mortal SV.
11256 Assumes that PL_op is the op that originally triggered the error, and that
11257 PL_comppad/PL_curpad points to the currently executing pad.
11263 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11271 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11272 uninit_sv == &PL_sv_placeholder)))
11275 switch (obase->op_type) {
11282 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11283 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11285 SV *keysv = Nullsv;
11286 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11288 if (pad) { /* @lex, %lex */
11289 sv = PAD_SVl(obase->op_targ);
11293 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11294 /* @global, %global */
11295 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11298 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11300 else /* @{expr}, %{expr} */
11301 return find_uninit_var(cUNOPx(obase)->op_first,
11305 /* attempt to find a match within the aggregate */
11307 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11309 subscript_type = FUV_SUBSCRIPT_HASH;
11312 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11314 subscript_type = FUV_SUBSCRIPT_ARRAY;
11317 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11320 return varname(gv, hash ? '%' : '@', obase->op_targ,
11321 keysv, index, subscript_type);
11325 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11327 return varname(Nullgv, '$', obase->op_targ,
11328 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11331 gv = cGVOPx_gv(obase);
11332 if (!gv || (match && GvSV(gv) != uninit_sv))
11334 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11337 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11340 av = (AV*)PAD_SV(obase->op_targ);
11341 if (!av || SvRMAGICAL(av))
11343 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11344 if (!svp || *svp != uninit_sv)
11347 return varname(Nullgv, '$', obase->op_targ,
11348 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11351 gv = cGVOPx_gv(obase);
11357 if (!av || SvRMAGICAL(av))
11359 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11360 if (!svp || *svp != uninit_sv)
11363 return varname(gv, '$', 0,
11364 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11369 o = cUNOPx(obase)->op_first;
11370 if (!o || o->op_type != OP_NULL ||
11371 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11373 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11377 if (PL_op == obase)
11378 /* $a[uninit_expr] or $h{uninit_expr} */
11379 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11382 o = cBINOPx(obase)->op_first;
11383 kid = cBINOPx(obase)->op_last;
11385 /* get the av or hv, and optionally the gv */
11387 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11388 sv = PAD_SV(o->op_targ);
11390 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11391 && cUNOPo->op_first->op_type == OP_GV)
11393 gv = cGVOPx_gv(cUNOPo->op_first);
11396 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11401 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11402 /* index is constant */
11406 if (obase->op_type == OP_HELEM) {
11407 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11408 if (!he || HeVAL(he) != uninit_sv)
11412 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11413 if (!svp || *svp != uninit_sv)
11417 if (obase->op_type == OP_HELEM)
11418 return varname(gv, '%', o->op_targ,
11419 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11421 return varname(gv, '@', o->op_targ, Nullsv,
11422 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11425 /* index is an expression;
11426 * attempt to find a match within the aggregate */
11427 if (obase->op_type == OP_HELEM) {
11428 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11430 return varname(gv, '%', o->op_targ,
11431 keysv, 0, FUV_SUBSCRIPT_HASH);
11434 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11436 return varname(gv, '@', o->op_targ,
11437 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11442 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11444 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11450 /* only examine RHS */
11451 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11454 o = cUNOPx(obase)->op_first;
11455 if (o->op_type == OP_PUSHMARK)
11458 if (!o->op_sibling) {
11459 /* one-arg version of open is highly magical */
11461 if (o->op_type == OP_GV) { /* open FOO; */
11463 if (match && GvSV(gv) != uninit_sv)
11465 return varname(gv, '$', 0,
11466 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11468 /* other possibilities not handled are:
11469 * open $x; or open my $x; should return '${*$x}'
11470 * open expr; should return '$'.expr ideally
11476 /* ops where $_ may be an implicit arg */
11480 if ( !(obase->op_flags & OPf_STACKED)) {
11481 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11482 ? PAD_SVl(obase->op_targ)
11485 sv = sv_newmortal();
11486 sv_setpvn(sv, "$_", 2);
11494 /* skip filehandle as it can't produce 'undef' warning */
11495 o = cUNOPx(obase)->op_first;
11496 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11497 o = o->op_sibling->op_sibling;
11504 match = 1; /* XS or custom code could trigger random warnings */
11509 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11510 return sv_2mortal(newSVpvs("${$/}"));
11515 if (!(obase->op_flags & OPf_KIDS))
11517 o = cUNOPx(obase)->op_first;
11523 /* if all except one arg are constant, or have no side-effects,
11524 * or are optimized away, then it's unambiguous */
11526 for (kid=o; kid; kid = kid->op_sibling) {
11528 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11529 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11530 || (kid->op_type == OP_PUSHMARK)
11534 if (o2) { /* more than one found */
11541 return find_uninit_var(o2, uninit_sv, match);
11543 /* scan all args */
11545 sv = find_uninit_var(o, uninit_sv, 1);
11557 =for apidoc report_uninit
11559 Print appropriate "Use of uninitialized variable" warning
11565 Perl_report_uninit(pTHX_ SV* uninit_sv)
11569 SV* varname = Nullsv;
11571 varname = find_uninit_var(PL_op, uninit_sv,0);
11573 sv_insert(varname, 0, 0, " ", 1);
11575 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11576 varname ? SvPV_nolen_const(varname) : "",
11577 " in ", OP_DESC(PL_op));
11580 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11586 * c-indentation-style: bsd
11587 * c-basic-offset: 4
11588 * indent-tabs-mode: t
11591 * ex: set ts=8 sts=4 sw=4 noet: