3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 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)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void ** const arena_root = &PL_body_arenaroots[sv_type];
644 void ** const root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void ** const r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 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));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 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);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv)) {
1894 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 == IS_NUMBER_IN_UV) {
1898 /* It's definitely an integer */
1899 if (numtype & IS_NUMBER_NEG) {
1900 if (value < (UV)IV_MIN)
1903 if (value < (UV)IV_MAX)
1908 if (ckWARN(WARN_NUMERIC))
1911 return I_V(Atof(SvPVX_const(sv)));
1916 assert(SvTYPE(sv) >= SVt_PVMG);
1917 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1918 } else if (SvTHINKFIRST(sv)) {
1922 SV * const tmpstr=AMG_CALLun(sv,numer);
1923 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1924 return SvIV(tmpstr);
1927 return PTR2IV(SvRV(sv));
1930 sv_force_normal_flags(sv, 0);
1932 if (SvREADONLY(sv) && !SvOK(sv)) {
1933 if (ckWARN(WARN_UNINITIALIZED))
1939 if (S_sv_2iuv_common(aTHX_ sv))
1942 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1943 PTR2UV(sv),SvIVX(sv)));
1944 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1948 =for apidoc sv_2uv_flags
1950 Return the unsigned integer value of an SV, doing any necessary string
1951 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1952 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1958 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1962 if (SvGMAGICAL(sv)) {
1963 if (flags & SV_GMAGIC)
1968 return U_V(SvNVX(sv));
1969 if (SvPOKp(sv) && SvLEN(sv)) {
1972 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1974 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1975 == IS_NUMBER_IN_UV) {
1976 /* It's definitely an integer */
1977 if (!(numtype & IS_NUMBER_NEG))
1981 if (ckWARN(WARN_NUMERIC))
1984 return U_V(Atof(SvPVX_const(sv)));
1989 assert(SvTYPE(sv) >= SVt_PVMG);
1990 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1991 } else if (SvTHINKFIRST(sv)) {
1995 SV *const tmpstr = AMG_CALLun(sv,numer);
1996 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1997 return SvUV(tmpstr);
2000 return PTR2UV(SvRV(sv));
2003 sv_force_normal_flags(sv, 0);
2005 if (SvREADONLY(sv) && !SvOK(sv)) {
2006 if (ckWARN(WARN_UNINITIALIZED))
2012 if (S_sv_2iuv_common(aTHX_ sv))
2016 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2017 PTR2UV(sv),SvUVX(sv)));
2018 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2024 Return the num value of an SV, doing any necessary string or integer
2025 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2032 Perl_sv_2nv(pTHX_ register SV *sv)
2036 if (SvGMAGICAL(sv)) {
2040 if (SvPOKp(sv) && SvLEN(sv)) {
2041 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2042 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2044 return Atof(SvPVX_const(sv));
2048 return (NV)SvUVX(sv);
2050 return (NV)SvIVX(sv);
2055 assert(SvTYPE(sv) >= SVt_PVMG);
2056 /* This falls through to the report_uninit near the end of the
2058 } else if (SvTHINKFIRST(sv)) {
2062 SV *const tmpstr = AMG_CALLun(sv,numer);
2063 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2064 return SvNV(tmpstr);
2067 return PTR2NV(SvRV(sv));
2070 sv_force_normal_flags(sv, 0);
2072 if (SvREADONLY(sv) && !SvOK(sv)) {
2073 if (ckWARN(WARN_UNINITIALIZED))
2078 if (SvTYPE(sv) < SVt_NV) {
2079 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2080 sv_upgrade(sv, SVt_NV);
2081 #ifdef USE_LONG_DOUBLE
2083 STORE_NUMERIC_LOCAL_SET_STANDARD();
2084 PerlIO_printf(Perl_debug_log,
2085 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2086 PTR2UV(sv), SvNVX(sv));
2087 RESTORE_NUMERIC_LOCAL();
2091 STORE_NUMERIC_LOCAL_SET_STANDARD();
2092 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2093 PTR2UV(sv), SvNVX(sv));
2094 RESTORE_NUMERIC_LOCAL();
2098 else if (SvTYPE(sv) < SVt_PVNV)
2099 sv_upgrade(sv, SVt_PVNV);
2104 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2105 #ifdef NV_PRESERVES_UV
2108 /* Only set the public NV OK flag if this NV preserves the IV */
2109 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2110 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2111 : (SvIVX(sv) == I_V(SvNVX(sv))))
2117 else if (SvPOKp(sv) && SvLEN(sv)) {
2119 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2120 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2122 #ifdef NV_PRESERVES_UV
2123 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2124 == IS_NUMBER_IN_UV) {
2125 /* It's definitely an integer */
2126 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2128 SvNV_set(sv, Atof(SvPVX_const(sv)));
2131 SvNV_set(sv, Atof(SvPVX_const(sv)));
2132 /* Only set the public NV OK flag if this NV preserves the value in
2133 the PV at least as well as an IV/UV would.
2134 Not sure how to do this 100% reliably. */
2135 /* if that shift count is out of range then Configure's test is
2136 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2138 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2139 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2140 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2141 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2142 /* Can't use strtol etc to convert this string, so don't try.
2143 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2146 /* value has been set. It may not be precise. */
2147 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2148 /* 2s complement assumption for (UV)IV_MIN */
2149 SvNOK_on(sv); /* Integer is too negative. */
2154 if (numtype & IS_NUMBER_NEG) {
2155 SvIV_set(sv, -(IV)value);
2156 } else if (value <= (UV)IV_MAX) {
2157 SvIV_set(sv, (IV)value);
2159 SvUV_set(sv, value);
2163 if (numtype & IS_NUMBER_NOT_INT) {
2164 /* I believe that even if the original PV had decimals,
2165 they are lost beyond the limit of the FP precision.
2166 However, neither is canonical, so both only get p
2167 flags. NWC, 2000/11/25 */
2168 /* Both already have p flags, so do nothing */
2170 const NV nv = SvNVX(sv);
2171 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2172 if (SvIVX(sv) == I_V(nv)) {
2175 /* It had no "." so it must be integer. */
2179 /* between IV_MAX and NV(UV_MAX).
2180 Could be slightly > UV_MAX */
2182 if (numtype & IS_NUMBER_NOT_INT) {
2183 /* UV and NV both imprecise. */
2185 const UV nv_as_uv = U_V(nv);
2187 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2196 #endif /* NV_PRESERVES_UV */
2199 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2201 assert (SvTYPE(sv) >= SVt_NV);
2202 /* Typically the caller expects that sv_any is not NULL now. */
2203 /* XXX Ilya implies that this is a bug in callers that assume this
2204 and ideally should be fixed. */
2207 #if defined(USE_LONG_DOUBLE)
2209 STORE_NUMERIC_LOCAL_SET_STANDARD();
2210 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2211 PTR2UV(sv), SvNVX(sv));
2212 RESTORE_NUMERIC_LOCAL();
2216 STORE_NUMERIC_LOCAL_SET_STANDARD();
2217 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2218 PTR2UV(sv), SvNVX(sv));
2219 RESTORE_NUMERIC_LOCAL();
2225 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2226 * UV as a string towards the end of buf, and return pointers to start and
2229 * We assume that buf is at least TYPE_CHARS(UV) long.
2233 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2235 char *ptr = buf + TYPE_CHARS(UV);
2236 char * const ebuf = ptr;
2249 *--ptr = '0' + (char)(uv % 10);
2257 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2258 * a regexp to its stringified form.
2262 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2263 const regexp * const re = (regexp *)mg->mg_obj;
2266 const char *fptr = "msix";
2271 bool need_newline = 0;
2272 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2274 while((ch = *fptr++)) {
2276 reflags[left++] = ch;
2279 reflags[right--] = ch;
2284 reflags[left] = '-';
2288 mg->mg_len = re->prelen + 4 + left;
2290 * If /x was used, we have to worry about a regex ending with a
2291 * comment later being embedded within another regex. If so, we don't
2292 * want this regex's "commentization" to leak out to the right part of
2293 * the enclosing regex, we must cap it with a newline.
2295 * So, if /x was used, we scan backwards from the end of the regex. If
2296 * we find a '#' before we find a newline, we need to add a newline
2297 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2298 * we don't need to add anything. -jfriedl
2300 if (PMf_EXTENDED & re->reganch) {
2301 const char *endptr = re->precomp + re->prelen;
2302 while (endptr >= re->precomp) {
2303 const char c = *(endptr--);
2305 break; /* don't need another */
2307 /* we end while in a comment, so we need a newline */
2308 mg->mg_len++; /* save space for it */
2309 need_newline = 1; /* note to add it */
2315 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2316 mg->mg_ptr[0] = '(';
2317 mg->mg_ptr[1] = '?';
2318 Copy(reflags, mg->mg_ptr+2, left, char);
2319 *(mg->mg_ptr+left+2) = ':';
2320 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2322 mg->mg_ptr[mg->mg_len - 2] = '\n';
2323 mg->mg_ptr[mg->mg_len - 1] = ')';
2324 mg->mg_ptr[mg->mg_len] = 0;
2326 PL_reginterp_cnt += re->program[0].next_off;
2328 if (re->reganch & ROPT_UTF8)
2338 =for apidoc sv_2pv_flags
2340 Returns a pointer to the string value of an SV, and sets *lp to its length.
2341 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2343 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2344 usually end up here too.
2350 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2360 if (SvGMAGICAL(sv)) {
2361 if (flags & SV_GMAGIC)
2366 if (flags & SV_MUTABLE_RETURN)
2367 return SvPVX_mutable(sv);
2368 if (flags & SV_CONST_RETURN)
2369 return (char *)SvPVX_const(sv);
2372 if (SvIOKp(sv) || SvNOKp(sv)) {
2373 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2377 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2378 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2380 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2383 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2384 /* Sneaky stuff here */
2385 SV * const tsv = newSVpvn(tbuf, len);
2395 #ifdef FIXNEGATIVEZERO
2396 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2402 SvUPGRADE(sv, SVt_PV);
2405 s = SvGROW_mutable(sv, len + 1);
2408 return memcpy(s, tbuf, len + 1);
2414 assert(SvTYPE(sv) >= SVt_PVMG);
2415 /* This falls through to the report_uninit near the end of the
2417 } else if (SvTHINKFIRST(sv)) {
2421 SV *const tmpstr = AMG_CALLun(sv,string);
2422 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2424 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2428 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2429 if (flags & SV_CONST_RETURN) {
2430 pv = (char *) SvPVX_const(tmpstr);
2432 pv = (flags & SV_MUTABLE_RETURN)
2433 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2436 *lp = SvCUR(tmpstr);
2438 pv = sv_2pv_flags(tmpstr, lp, flags);
2450 const SV *const referent = (SV*)SvRV(sv);
2453 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2454 } else if (SvTYPE(referent) == SVt_PVMG
2455 && ((SvFLAGS(referent) &
2456 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2457 == (SVs_OBJECT|SVs_SMG))
2458 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2459 return S_stringify_regexp(aTHX_ sv, mg, lp);
2461 const char *const typestr = sv_reftype(referent, 0);
2463 tsv = sv_newmortal();
2464 if (SvOBJECT(referent)) {
2465 const char *const name = HvNAME_get(SvSTASH(referent));
2466 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2467 name ? name : "__ANON__" , typestr,
2471 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2479 if (SvREADONLY(sv) && !SvOK(sv)) {
2480 if (ckWARN(WARN_UNINITIALIZED))
2487 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2488 /* I'm assuming that if both IV and NV are equally valid then
2489 converting the IV is going to be more efficient */
2490 const U32 isIOK = SvIOK(sv);
2491 const U32 isUIOK = SvIsUV(sv);
2492 char buf[TYPE_CHARS(UV)];
2495 if (SvTYPE(sv) < SVt_PVIV)
2496 sv_upgrade(sv, SVt_PVIV);
2498 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2500 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2501 /* inlined from sv_setpvn */
2502 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2503 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2504 SvCUR_set(sv, ebuf - ptr);
2514 else if (SvNOKp(sv)) {
2515 if (SvTYPE(sv) < SVt_PVNV)
2516 sv_upgrade(sv, SVt_PVNV);
2517 /* The +20 is pure guesswork. Configure test needed. --jhi */
2518 s = SvGROW_mutable(sv, NV_DIG + 20);
2519 olderrno = errno; /* some Xenix systems wipe out errno here */
2521 if (SvNVX(sv) == 0.0)
2522 (void)strcpy(s,"0");
2526 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2529 #ifdef FIXNEGATIVEZERO
2530 if (*s == '-' && s[1] == '0' && !s[2])
2540 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2544 if (SvTYPE(sv) < SVt_PV)
2545 /* Typically the caller expects that sv_any is not NULL now. */
2546 sv_upgrade(sv, SVt_PV);
2550 const STRLEN len = s - SvPVX_const(sv);
2556 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2557 PTR2UV(sv),SvPVX_const(sv)));
2558 if (flags & SV_CONST_RETURN)
2559 return (char *)SvPVX_const(sv);
2560 if (flags & SV_MUTABLE_RETURN)
2561 return SvPVX_mutable(sv);
2566 =for apidoc sv_copypv
2568 Copies a stringified representation of the source SV into the
2569 destination SV. Automatically performs any necessary mg_get and
2570 coercion of numeric values into strings. Guaranteed to preserve
2571 UTF-8 flag even from overloaded objects. Similar in nature to
2572 sv_2pv[_flags] but operates directly on an SV instead of just the
2573 string. Mostly uses sv_2pv_flags to do its work, except when that
2574 would lose the UTF-8'ness of the PV.
2580 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2583 const char * const s = SvPV_const(ssv,len);
2584 sv_setpvn(dsv,s,len);
2592 =for apidoc sv_2pvbyte
2594 Return a pointer to the byte-encoded representation of the SV, and set *lp
2595 to its length. May cause the SV to be downgraded from UTF-8 as a
2598 Usually accessed via the C<SvPVbyte> macro.
2604 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2606 sv_utf8_downgrade(sv,0);
2607 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2611 =for apidoc sv_2pvutf8
2613 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2614 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2616 Usually accessed via the C<SvPVutf8> macro.
2622 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2624 sv_utf8_upgrade(sv);
2625 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2630 =for apidoc sv_2bool
2632 This function is only called on magical items, and is only used by
2633 sv_true() or its macro equivalent.
2639 Perl_sv_2bool(pTHX_ register SV *sv)
2647 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2648 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2649 return (bool)SvTRUE(tmpsv);
2650 return SvRV(sv) != 0;
2653 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2655 (*sv->sv_u.svu_pv > '0' ||
2656 Xpvtmp->xpv_cur > 1 ||
2657 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2664 return SvIVX(sv) != 0;
2667 return SvNVX(sv) != 0.0;
2675 =for apidoc sv_utf8_upgrade
2677 Converts the PV of an SV to its UTF-8-encoded form.
2678 Forces the SV to string form if it is not already.
2679 Always sets the SvUTF8 flag to avoid future validity checks even
2680 if all the bytes have hibit clear.
2682 This is not as a general purpose byte encoding to Unicode interface:
2683 use the Encode extension for that.
2685 =for apidoc sv_utf8_upgrade_flags
2687 Converts the PV of an SV to its UTF-8-encoded form.
2688 Forces the SV to string form if it is not already.
2689 Always sets the SvUTF8 flag to avoid future validity checks even
2690 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2691 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2692 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2694 This is not as a general purpose byte encoding to Unicode interface:
2695 use the Encode extension for that.
2701 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2703 if (sv == &PL_sv_undef)
2707 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2708 (void) sv_2pv_flags(sv,&len, flags);
2712 (void) SvPV_force(sv,len);
2721 sv_force_normal_flags(sv, 0);
2724 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2725 sv_recode_to_utf8(sv, PL_encoding);
2726 else { /* Assume Latin-1/EBCDIC */
2727 /* This function could be much more efficient if we
2728 * had a FLAG in SVs to signal if there are any hibit
2729 * chars in the PV. Given that there isn't such a flag
2730 * make the loop as fast as possible. */
2731 const U8 * const s = (U8 *) SvPVX_const(sv);
2732 const U8 * const e = (U8 *) SvEND(sv);
2737 /* Check for hi bit */
2738 if (!NATIVE_IS_INVARIANT(ch)) {
2739 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2740 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2742 SvPV_free(sv); /* No longer using what was there before. */
2743 SvPV_set(sv, (char*)recoded);
2744 SvCUR_set(sv, len - 1);
2745 SvLEN_set(sv, len); /* No longer know the real size. */
2749 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2756 =for apidoc sv_utf8_downgrade
2758 Attempts to convert the PV of an SV from characters to bytes.
2759 If the PV contains a character beyond byte, this conversion will fail;
2760 in this case, either returns false or, if C<fail_ok> is not
2763 This is not as a general purpose Unicode to byte encoding interface:
2764 use the Encode extension for that.
2770 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2772 if (SvPOKp(sv) && SvUTF8(sv)) {
2778 sv_force_normal_flags(sv, 0);
2780 s = (U8 *) SvPV(sv, len);
2781 if (!utf8_to_bytes(s, &len)) {
2786 Perl_croak(aTHX_ "Wide character in %s",
2789 Perl_croak(aTHX_ "Wide character");
2800 =for apidoc sv_utf8_encode
2802 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2803 flag off so that it looks like octets again.
2809 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2811 (void) sv_utf8_upgrade(sv);
2813 sv_force_normal_flags(sv, 0);
2815 if (SvREADONLY(sv)) {
2816 Perl_croak(aTHX_ PL_no_modify);
2822 =for apidoc sv_utf8_decode
2824 If the PV of the SV is an octet sequence in UTF-8
2825 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2826 so that it looks like a character. If the PV contains only single-byte
2827 characters, the C<SvUTF8> flag stays being off.
2828 Scans PV for validity and returns false if the PV is invalid UTF-8.
2834 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2840 /* The octets may have got themselves encoded - get them back as
2843 if (!sv_utf8_downgrade(sv, TRUE))
2846 /* it is actually just a matter of turning the utf8 flag on, but
2847 * we want to make sure everything inside is valid utf8 first.
2849 c = (const U8 *) SvPVX_const(sv);
2850 if (!is_utf8_string(c, SvCUR(sv)+1))
2852 e = (const U8 *) SvEND(sv);
2855 if (!UTF8_IS_INVARIANT(ch)) {
2865 =for apidoc sv_setsv
2867 Copies the contents of the source SV C<ssv> into the destination SV
2868 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2869 function if the source SV needs to be reused. Does not handle 'set' magic.
2870 Loosely speaking, it performs a copy-by-value, obliterating any previous
2871 content of the destination.
2873 You probably want to use one of the assortment of wrappers, such as
2874 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2875 C<SvSetMagicSV_nosteal>.
2877 =for apidoc sv_setsv_flags
2879 Copies the contents of the source SV C<ssv> into the destination SV
2880 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2881 function if the source SV needs to be reused. Does not handle 'set' magic.
2882 Loosely speaking, it performs a copy-by-value, obliterating any previous
2883 content of the destination.
2884 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2885 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2886 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2887 and C<sv_setsv_nomg> are implemented in terms of this function.
2889 You probably want to use one of the assortment of wrappers, such as
2890 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2891 C<SvSetMagicSV_nosteal>.
2893 This is the primary function for copying scalars, and most other
2894 copy-ish functions and macros use this underneath.
2900 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2902 register U32 sflags;
2908 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2910 sstr = &PL_sv_undef;
2911 stype = SvTYPE(sstr);
2912 dtype = SvTYPE(dstr);
2917 /* need to nuke the magic */
2919 SvRMAGICAL_off(dstr);
2922 /* There's a lot of redundancy below but we're going for speed here */
2927 if (dtype != SVt_PVGV) {
2928 (void)SvOK_off(dstr);
2936 sv_upgrade(dstr, SVt_IV);
2939 sv_upgrade(dstr, SVt_PVNV);
2943 sv_upgrade(dstr, SVt_PVIV);
2946 (void)SvIOK_only(dstr);
2947 SvIV_set(dstr, SvIVX(sstr));
2950 if (SvTAINTED(sstr))
2961 sv_upgrade(dstr, SVt_NV);
2966 sv_upgrade(dstr, SVt_PVNV);
2969 SvNV_set(dstr, SvNVX(sstr));
2970 (void)SvNOK_only(dstr);
2971 if (SvTAINTED(sstr))
2979 sv_upgrade(dstr, SVt_RV);
2980 else if (dtype == SVt_PVGV &&
2981 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2984 if (GvIMPORTED(dstr) != GVf_IMPORTED
2985 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2987 GvIMPORTED_on(dstr);
2996 #ifdef PERL_OLD_COPY_ON_WRITE
2997 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
2998 if (dtype < SVt_PVIV)
2999 sv_upgrade(dstr, SVt_PVIV);
3006 sv_upgrade(dstr, SVt_PV);
3009 if (dtype < SVt_PVIV)
3010 sv_upgrade(dstr, SVt_PVIV);
3013 if (dtype < SVt_PVNV)
3014 sv_upgrade(dstr, SVt_PVNV);
3021 const char * const type = sv_reftype(sstr,0);
3023 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3025 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3030 if (dtype <= SVt_PVGV) {
3032 if (dtype != SVt_PVGV) {
3033 const char * const name = GvNAME(sstr);
3034 const STRLEN len = GvNAMELEN(sstr);
3035 /* don't upgrade SVt_PVLV: it can hold a glob */
3036 if (dtype != SVt_PVLV)
3037 sv_upgrade(dstr, SVt_PVGV);
3038 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3039 GvSTASH(dstr) = GvSTASH(sstr);
3041 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3042 GvNAME(dstr) = savepvn(name, len);
3043 GvNAMELEN(dstr) = len;
3044 SvFAKE_on(dstr); /* can coerce to non-glob */
3047 #ifdef GV_UNIQUE_CHECK
3048 if (GvUNIQUE((GV*)dstr)) {
3049 Perl_croak(aTHX_ PL_no_modify);
3053 (void)SvOK_off(dstr);
3054 GvINTRO_off(dstr); /* one-shot flag */
3056 GvGP(dstr) = gp_ref(GvGP(sstr));
3057 if (SvTAINTED(sstr))
3059 if (GvIMPORTED(dstr) != GVf_IMPORTED
3060 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3062 GvIMPORTED_on(dstr);
3070 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3072 if ((int)SvTYPE(sstr) != stype) {
3073 stype = SvTYPE(sstr);
3074 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3078 if (stype == SVt_PVLV)
3079 SvUPGRADE(dstr, SVt_PVNV);
3081 SvUPGRADE(dstr, (U32)stype);
3084 sflags = SvFLAGS(sstr);
3086 if (sflags & SVf_ROK) {
3087 if (dtype >= SVt_PV) {
3088 if (dtype == SVt_PVGV) {
3089 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3091 const int intro = GvINTRO(dstr);
3093 #ifdef GV_UNIQUE_CHECK
3094 if (GvUNIQUE((GV*)dstr)) {
3095 Perl_croak(aTHX_ PL_no_modify);
3100 GvINTRO_off(dstr); /* one-shot flag */
3101 GvLINE(dstr) = CopLINE(PL_curcop);
3102 GvEGV(dstr) = (GV*)dstr;
3105 switch (SvTYPE(sref)) {
3108 SAVEGENERICSV(GvAV(dstr));
3110 dref = (SV*)GvAV(dstr);
3111 GvAV(dstr) = (AV*)sref;
3112 if (!GvIMPORTED_AV(dstr)
3113 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3115 GvIMPORTED_AV_on(dstr);
3120 SAVEGENERICSV(GvHV(dstr));
3122 dref = (SV*)GvHV(dstr);
3123 GvHV(dstr) = (HV*)sref;
3124 if (!GvIMPORTED_HV(dstr)
3125 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3127 GvIMPORTED_HV_on(dstr);
3132 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3133 SvREFCNT_dec(GvCV(dstr));
3134 GvCV(dstr) = Nullcv;
3135 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3136 PL_sub_generation++;
3138 SAVEGENERICSV(GvCV(dstr));
3141 dref = (SV*)GvCV(dstr);
3142 if (GvCV(dstr) != (CV*)sref) {
3143 CV* const cv = GvCV(dstr);
3145 if (!GvCVGEN((GV*)dstr) &&
3146 (CvROOT(cv) || CvXSUB(cv)))
3148 /* Redefining a sub - warning is mandatory if
3149 it was a const and its value changed. */
3150 if (ckWARN(WARN_REDEFINE)
3152 && (!CvCONST((CV*)sref)
3153 || sv_cmp(cv_const_sv(cv),
3154 cv_const_sv((CV*)sref)))))
3156 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3158 ? "Constant subroutine %s::%s redefined"
3159 : "Subroutine %s::%s redefined",
3160 HvNAME_get(GvSTASH((GV*)dstr)),
3161 GvENAME((GV*)dstr));
3165 cv_ckproto(cv, (GV*)dstr,
3167 ? SvPVX_const(sref) : Nullch);
3169 GvCV(dstr) = (CV*)sref;
3170 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3171 GvASSUMECV_on(dstr);
3172 PL_sub_generation++;
3174 if (!GvIMPORTED_CV(dstr)
3175 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3177 GvIMPORTED_CV_on(dstr);
3182 SAVEGENERICSV(GvIOp(dstr));
3184 dref = (SV*)GvIOp(dstr);
3185 GvIOp(dstr) = (IO*)sref;
3189 SAVEGENERICSV(GvFORM(dstr));
3191 dref = (SV*)GvFORM(dstr);
3192 GvFORM(dstr) = (CV*)sref;
3196 SAVEGENERICSV(GvSV(dstr));
3198 dref = (SV*)GvSV(dstr);
3200 if (!GvIMPORTED_SV(dstr)
3201 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3203 GvIMPORTED_SV_on(dstr);
3209 if (SvTAINTED(sstr))
3213 if (SvPVX_const(dstr)) {
3219 (void)SvOK_off(dstr);
3220 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3222 if (sflags & SVp_NOK) {
3224 /* Only set the public OK flag if the source has public OK. */
3225 if (sflags & SVf_NOK)
3226 SvFLAGS(dstr) |= SVf_NOK;
3227 SvNV_set(dstr, SvNVX(sstr));
3229 if (sflags & SVp_IOK) {
3230 (void)SvIOKp_on(dstr);
3231 if (sflags & SVf_IOK)
3232 SvFLAGS(dstr) |= SVf_IOK;
3233 if (sflags & SVf_IVisUV)
3235 SvIV_set(dstr, SvIVX(sstr));
3237 if (SvAMAGIC(sstr)) {
3241 else if (sflags & SVp_POK) {
3245 * Check to see if we can just swipe the string. If so, it's a
3246 * possible small lose on short strings, but a big win on long ones.
3247 * It might even be a win on short strings if SvPVX_const(dstr)
3248 * has to be allocated and SvPVX_const(sstr) has to be freed.
3251 /* Whichever path we take through the next code, we want this true,
3252 and doing it now facilitates the COW check. */
3253 (void)SvPOK_only(dstr);
3256 /* We're not already COW */
3257 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3258 #ifndef PERL_OLD_COPY_ON_WRITE
3259 /* or we are, but dstr isn't a suitable target. */
3260 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3265 (sflags & SVs_TEMP) && /* slated for free anyway? */
3266 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3267 (!(flags & SV_NOSTEAL)) &&
3268 /* and we're allowed to steal temps */
3269 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3270 SvLEN(sstr) && /* and really is a string */
3271 /* and won't be needed again, potentially */
3272 !(PL_op && PL_op->op_type == OP_AASSIGN))
3273 #ifdef PERL_OLD_COPY_ON_WRITE
3274 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3275 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3276 && SvTYPE(sstr) >= SVt_PVIV)
3279 /* Failed the swipe test, and it's not a shared hash key either.
3280 Have to copy the string. */
3281 STRLEN len = SvCUR(sstr);
3282 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3283 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3284 SvCUR_set(dstr, len);
3285 *SvEND(dstr) = '\0';
3287 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3289 /* Either it's a shared hash key, or it's suitable for
3290 copy-on-write or we can swipe the string. */
3292 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3296 #ifdef PERL_OLD_COPY_ON_WRITE
3298 /* I believe I should acquire a global SV mutex if
3299 it's a COW sv (not a shared hash key) to stop
3300 it going un copy-on-write.
3301 If the source SV has gone un copy on write between up there
3302 and down here, then (assert() that) it is of the correct
3303 form to make it copy on write again */
3304 if ((sflags & (SVf_FAKE | SVf_READONLY))
3305 != (SVf_FAKE | SVf_READONLY)) {
3306 SvREADONLY_on(sstr);
3308 /* Make the source SV into a loop of 1.
3309 (about to become 2) */
3310 SV_COW_NEXT_SV_SET(sstr, sstr);
3314 /* Initial code is common. */
3315 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3320 /* making another shared SV. */
3321 STRLEN cur = SvCUR(sstr);
3322 STRLEN len = SvLEN(sstr);
3323 #ifdef PERL_OLD_COPY_ON_WRITE
3325 assert (SvTYPE(dstr) >= SVt_PVIV);
3326 /* SvIsCOW_normal */
3327 /* splice us in between source and next-after-source. */
3328 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3329 SV_COW_NEXT_SV_SET(sstr, dstr);
3330 SvPV_set(dstr, SvPVX_mutable(sstr));
3334 /* SvIsCOW_shared_hash */
3335 DEBUG_C(PerlIO_printf(Perl_debug_log,
3336 "Copy on write: Sharing hash\n"));
3338 assert (SvTYPE(dstr) >= SVt_PV);
3340 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3342 SvLEN_set(dstr, len);
3343 SvCUR_set(dstr, cur);
3344 SvREADONLY_on(dstr);
3346 /* Relesase a global SV mutex. */
3349 { /* Passes the swipe test. */
3350 SvPV_set(dstr, SvPVX_mutable(sstr));
3351 SvLEN_set(dstr, SvLEN(sstr));
3352 SvCUR_set(dstr, SvCUR(sstr));
3355 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3356 SvPV_set(sstr, Nullch);
3362 if (sflags & SVf_UTF8)
3364 if (sflags & SVp_NOK) {
3366 if (sflags & SVf_NOK)
3367 SvFLAGS(dstr) |= SVf_NOK;
3368 SvNV_set(dstr, SvNVX(sstr));
3370 if (sflags & SVp_IOK) {
3371 (void)SvIOKp_on(dstr);
3372 if (sflags & SVf_IOK)
3373 SvFLAGS(dstr) |= SVf_IOK;
3374 if (sflags & SVf_IVisUV)
3376 SvIV_set(dstr, SvIVX(sstr));
3379 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3380 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3381 smg->mg_ptr, smg->mg_len);
3382 SvRMAGICAL_on(dstr);
3385 else if (sflags & SVp_IOK) {
3386 if (sflags & SVf_IOK)
3387 (void)SvIOK_only(dstr);
3389 (void)SvOK_off(dstr);
3390 (void)SvIOKp_on(dstr);
3392 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3393 if (sflags & SVf_IVisUV)
3395 SvIV_set(dstr, SvIVX(sstr));
3396 if (sflags & SVp_NOK) {
3397 if (sflags & SVf_NOK)
3398 (void)SvNOK_on(dstr);
3400 (void)SvNOKp_on(dstr);
3401 SvNV_set(dstr, SvNVX(sstr));
3404 else if (sflags & SVp_NOK) {
3405 if (sflags & SVf_NOK)
3406 (void)SvNOK_only(dstr);
3408 (void)SvOK_off(dstr);
3411 SvNV_set(dstr, SvNVX(sstr));
3414 if (dtype == SVt_PVGV) {
3415 if (ckWARN(WARN_MISC))
3416 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3419 (void)SvOK_off(dstr);
3421 if (SvTAINTED(sstr))
3426 =for apidoc sv_setsv_mg
3428 Like C<sv_setsv>, but also handles 'set' magic.
3434 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3436 sv_setsv(dstr,sstr);
3440 #ifdef PERL_OLD_COPY_ON_WRITE
3442 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3444 STRLEN cur = SvCUR(sstr);
3445 STRLEN len = SvLEN(sstr);
3446 register char *new_pv;
3449 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3457 if (SvTHINKFIRST(dstr))
3458 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3459 else if (SvPVX_const(dstr))
3460 Safefree(SvPVX_const(dstr));
3464 SvUPGRADE(dstr, SVt_PVIV);
3466 assert (SvPOK(sstr));
3467 assert (SvPOKp(sstr));
3468 assert (!SvIOK(sstr));
3469 assert (!SvIOKp(sstr));
3470 assert (!SvNOK(sstr));
3471 assert (!SvNOKp(sstr));
3473 if (SvIsCOW(sstr)) {
3475 if (SvLEN(sstr) == 0) {
3476 /* source is a COW shared hash key. */
3477 DEBUG_C(PerlIO_printf(Perl_debug_log,
3478 "Fast copy on write: Sharing hash\n"));
3479 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3482 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3484 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3485 SvUPGRADE(sstr, SVt_PVIV);
3486 SvREADONLY_on(sstr);
3488 DEBUG_C(PerlIO_printf(Perl_debug_log,
3489 "Fast copy on write: Converting sstr to COW\n"));
3490 SV_COW_NEXT_SV_SET(dstr, sstr);
3492 SV_COW_NEXT_SV_SET(sstr, dstr);
3493 new_pv = SvPVX_mutable(sstr);
3496 SvPV_set(dstr, new_pv);
3497 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3500 SvLEN_set(dstr, len);
3501 SvCUR_set(dstr, cur);
3510 =for apidoc sv_setpvn
3512 Copies a string into an SV. The C<len> parameter indicates the number of
3513 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3514 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3520 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3522 register char *dptr;
3524 SV_CHECK_THINKFIRST_COW_DROP(sv);
3530 /* len is STRLEN which is unsigned, need to copy to signed */
3533 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3535 SvUPGRADE(sv, SVt_PV);
3537 dptr = SvGROW(sv, len + 1);
3538 Move(ptr,dptr,len,char);
3541 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3546 =for apidoc sv_setpvn_mg
3548 Like C<sv_setpvn>, but also handles 'set' magic.
3554 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3556 sv_setpvn(sv,ptr,len);
3561 =for apidoc sv_setpv
3563 Copies a string into an SV. The string must be null-terminated. Does not
3564 handle 'set' magic. See C<sv_setpv_mg>.
3570 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3572 register STRLEN len;
3574 SV_CHECK_THINKFIRST_COW_DROP(sv);
3580 SvUPGRADE(sv, SVt_PV);
3582 SvGROW(sv, len + 1);
3583 Move(ptr,SvPVX(sv),len+1,char);
3585 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3590 =for apidoc sv_setpv_mg
3592 Like C<sv_setpv>, but also handles 'set' magic.
3598 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3605 =for apidoc sv_usepvn
3607 Tells an SV to use C<ptr> to find its string value. Normally the string is
3608 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3609 The C<ptr> should point to memory that was allocated by C<malloc>. The
3610 string length, C<len>, must be supplied. This function will realloc the
3611 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3612 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3613 See C<sv_usepvn_mg>.
3619 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3622 SV_CHECK_THINKFIRST_COW_DROP(sv);
3623 SvUPGRADE(sv, SVt_PV);
3628 if (SvPVX_const(sv))
3631 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3632 ptr = saferealloc (ptr, allocate);
3635 SvLEN_set(sv, allocate);
3637 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3642 =for apidoc sv_usepvn_mg
3644 Like C<sv_usepvn>, but also handles 'set' magic.
3650 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3652 sv_usepvn(sv,ptr,len);
3656 #ifdef PERL_OLD_COPY_ON_WRITE
3657 /* Need to do this *after* making the SV normal, as we need the buffer
3658 pointer to remain valid until after we've copied it. If we let go too early,
3659 another thread could invalidate it by unsharing last of the same hash key
3660 (which it can do by means other than releasing copy-on-write Svs)
3661 or by changing the other copy-on-write SVs in the loop. */
3663 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3665 if (len) { /* this SV was SvIsCOW_normal(sv) */
3666 /* we need to find the SV pointing to us. */
3667 SV * const current = SV_COW_NEXT_SV(after);
3669 if (current == sv) {
3670 /* The SV we point to points back to us (there were only two of us
3672 Hence other SV is no longer copy on write either. */
3674 SvREADONLY_off(after);
3676 /* We need to follow the pointers around the loop. */
3678 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3681 /* don't loop forever if the structure is bust, and we have
3682 a pointer into a closed loop. */
3683 assert (current != after);
3684 assert (SvPVX_const(current) == pvx);
3686 /* Make the SV before us point to the SV after us. */
3687 SV_COW_NEXT_SV_SET(current, after);
3690 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3695 Perl_sv_release_IVX(pTHX_ register SV *sv)
3698 sv_force_normal_flags(sv, 0);
3704 =for apidoc sv_force_normal_flags
3706 Undo various types of fakery on an SV: if the PV is a shared string, make
3707 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3708 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3709 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3710 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3711 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3712 set to some other value.) In addition, the C<flags> parameter gets passed to
3713 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3714 with flags set to 0.
3720 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3722 #ifdef PERL_OLD_COPY_ON_WRITE
3723 if (SvREADONLY(sv)) {
3724 /* At this point I believe I should acquire a global SV mutex. */
3726 const char * const pvx = SvPVX_const(sv);
3727 const STRLEN len = SvLEN(sv);
3728 const STRLEN cur = SvCUR(sv);
3729 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3731 PerlIO_printf(Perl_debug_log,
3732 "Copy on write: Force normal %ld\n",
3738 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3739 SvPV_set(sv, (char*)0);
3741 if (flags & SV_COW_DROP_PV) {
3742 /* OK, so we don't need to copy our buffer. */
3745 SvGROW(sv, cur + 1);
3746 Move(pvx,SvPVX(sv),cur,char);
3750 sv_release_COW(sv, pvx, len, next);
3755 else if (IN_PERL_RUNTIME)
3756 Perl_croak(aTHX_ PL_no_modify);
3757 /* At this point I believe that I can drop the global SV mutex. */
3760 if (SvREADONLY(sv)) {
3762 const char * const pvx = SvPVX_const(sv);
3763 const STRLEN len = SvCUR(sv);
3766 SvPV_set(sv, Nullch);
3768 SvGROW(sv, len + 1);
3769 Move(pvx,SvPVX(sv),len,char);
3771 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3773 else if (IN_PERL_RUNTIME)
3774 Perl_croak(aTHX_ PL_no_modify);
3778 sv_unref_flags(sv, flags);
3779 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3786 Efficient removal of characters from the beginning of the string buffer.
3787 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3788 the string buffer. The C<ptr> becomes the first character of the adjusted
3789 string. Uses the "OOK hack".
3790 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3791 refer to the same chunk of data.
3797 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3799 register STRLEN delta;
3800 if (!ptr || !SvPOKp(sv))
3802 delta = ptr - SvPVX_const(sv);
3803 SV_CHECK_THINKFIRST(sv);
3804 if (SvTYPE(sv) < SVt_PVIV)
3805 sv_upgrade(sv,SVt_PVIV);
3808 if (!SvLEN(sv)) { /* make copy of shared string */
3809 const char *pvx = SvPVX_const(sv);
3810 const STRLEN len = SvCUR(sv);
3811 SvGROW(sv, len + 1);
3812 Move(pvx,SvPVX(sv),len,char);
3816 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3817 and we do that anyway inside the SvNIOK_off
3819 SvFLAGS(sv) |= SVf_OOK;
3822 SvLEN_set(sv, SvLEN(sv) - delta);
3823 SvCUR_set(sv, SvCUR(sv) - delta);
3824 SvPV_set(sv, SvPVX(sv) + delta);
3825 SvIV_set(sv, SvIVX(sv) + delta);
3829 =for apidoc sv_catpvn
3831 Concatenates the string onto the end of the string which is in the SV. The
3832 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3833 status set, then the bytes appended should be valid UTF-8.
3834 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3836 =for apidoc sv_catpvn_flags
3838 Concatenates the string onto the end of the string which is in the SV. The
3839 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3840 status set, then the bytes appended should be valid UTF-8.
3841 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3842 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3843 in terms of this function.
3849 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3852 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3854 SvGROW(dsv, dlen + slen + 1);
3856 sstr = SvPVX_const(dsv);
3857 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3858 SvCUR_set(dsv, SvCUR(dsv) + slen);
3860 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3862 if (flags & SV_SMAGIC)
3867 =for apidoc sv_catsv
3869 Concatenates the string from SV C<ssv> onto the end of the string in
3870 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3871 not 'set' magic. See C<sv_catsv_mg>.
3873 =for apidoc sv_catsv_flags
3875 Concatenates the string from SV C<ssv> onto the end of the string in
3876 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3877 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3878 and C<sv_catsv_nomg> are implemented in terms of this function.
3883 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3887 const char *spv = SvPV_const(ssv, slen);
3889 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3890 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3891 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3892 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3893 dsv->sv_flags doesn't have that bit set.
3894 Andy Dougherty 12 Oct 2001
3896 const I32 sutf8 = DO_UTF8(ssv);
3899 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3901 dutf8 = DO_UTF8(dsv);
3903 if (dutf8 != sutf8) {
3905 /* Not modifying source SV, so taking a temporary copy. */
3906 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3908 sv_utf8_upgrade(csv);
3909 spv = SvPV_const(csv, slen);
3912 sv_utf8_upgrade_nomg(dsv);
3914 sv_catpvn_nomg(dsv, spv, slen);
3917 if (flags & SV_SMAGIC)
3922 =for apidoc sv_catpv
3924 Concatenates the string onto the end of the string which is in the SV.
3925 If the SV has the UTF-8 status set, then the bytes appended should be
3926 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3931 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3933 register STRLEN len;
3939 junk = SvPV_force(sv, tlen);
3941 SvGROW(sv, tlen + len + 1);
3943 ptr = SvPVX_const(sv);
3944 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3945 SvCUR_set(sv, SvCUR(sv) + len);
3946 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3951 =for apidoc sv_catpv_mg
3953 Like C<sv_catpv>, but also handles 'set' magic.
3959 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3968 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3969 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3976 Perl_newSV(pTHX_ STRLEN len)
3982 sv_upgrade(sv, SVt_PV);
3983 SvGROW(sv, len + 1);
3988 =for apidoc sv_magicext
3990 Adds magic to an SV, upgrading it if necessary. Applies the
3991 supplied vtable and returns a pointer to the magic added.
3993 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
3994 In particular, you can add magic to SvREADONLY SVs, and add more than
3995 one instance of the same 'how'.
3997 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
3998 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
3999 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4000 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4002 (This is now used as a subroutine by C<sv_magic>.)
4007 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4008 const char* name, I32 namlen)
4012 if (SvTYPE(sv) < SVt_PVMG) {
4013 SvUPGRADE(sv, SVt_PVMG);
4015 Newxz(mg, 1, MAGIC);
4016 mg->mg_moremagic = SvMAGIC(sv);
4017 SvMAGIC_set(sv, mg);
4019 /* Sometimes a magic contains a reference loop, where the sv and
4020 object refer to each other. To prevent a reference loop that
4021 would prevent such objects being freed, we look for such loops
4022 and if we find one we avoid incrementing the object refcount.
4024 Note we cannot do this to avoid self-tie loops as intervening RV must
4025 have its REFCNT incremented to keep it in existence.
4028 if (!obj || obj == sv ||
4029 how == PERL_MAGIC_arylen ||
4030 how == PERL_MAGIC_qr ||
4031 how == PERL_MAGIC_symtab ||
4032 (SvTYPE(obj) == SVt_PVGV &&
4033 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4034 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4035 GvFORM(obj) == (CV*)sv)))
4040 mg->mg_obj = SvREFCNT_inc(obj);
4041 mg->mg_flags |= MGf_REFCOUNTED;
4044 /* Normal self-ties simply pass a null object, and instead of
4045 using mg_obj directly, use the SvTIED_obj macro to produce a
4046 new RV as needed. For glob "self-ties", we are tieing the PVIO
4047 with an RV obj pointing to the glob containing the PVIO. In
4048 this case, to avoid a reference loop, we need to weaken the
4052 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4053 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4059 mg->mg_len = namlen;
4062 mg->mg_ptr = savepvn(name, namlen);
4063 else if (namlen == HEf_SVKEY)
4064 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4066 mg->mg_ptr = (char *) name;
4068 mg->mg_virtual = vtable;
4072 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4077 =for apidoc sv_magic
4079 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4080 then adds a new magic item of type C<how> to the head of the magic list.
4082 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4083 handling of the C<name> and C<namlen> arguments.
4085 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4086 to add more than one instance of the same 'how'.
4092 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4094 const MGVTBL *vtable;
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4099 sv_force_normal_flags(sv, 0);
4101 if (SvREADONLY(sv)) {
4103 /* its okay to attach magic to shared strings; the subsequent
4104 * upgrade to PVMG will unshare the string */
4105 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4108 && how != PERL_MAGIC_regex_global
4109 && how != PERL_MAGIC_bm
4110 && how != PERL_MAGIC_fm
4111 && how != PERL_MAGIC_sv
4112 && how != PERL_MAGIC_backref
4115 Perl_croak(aTHX_ PL_no_modify);
4118 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4119 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4120 /* sv_magic() refuses to add a magic of the same 'how' as an
4123 if (how == PERL_MAGIC_taint)
4131 vtable = &PL_vtbl_sv;
4133 case PERL_MAGIC_overload:
4134 vtable = &PL_vtbl_amagic;
4136 case PERL_MAGIC_overload_elem:
4137 vtable = &PL_vtbl_amagicelem;
4139 case PERL_MAGIC_overload_table:
4140 vtable = &PL_vtbl_ovrld;
4143 vtable = &PL_vtbl_bm;
4145 case PERL_MAGIC_regdata:
4146 vtable = &PL_vtbl_regdata;
4148 case PERL_MAGIC_regdatum:
4149 vtable = &PL_vtbl_regdatum;
4151 case PERL_MAGIC_env:
4152 vtable = &PL_vtbl_env;
4155 vtable = &PL_vtbl_fm;
4157 case PERL_MAGIC_envelem:
4158 vtable = &PL_vtbl_envelem;
4160 case PERL_MAGIC_regex_global:
4161 vtable = &PL_vtbl_mglob;
4163 case PERL_MAGIC_isa:
4164 vtable = &PL_vtbl_isa;
4166 case PERL_MAGIC_isaelem:
4167 vtable = &PL_vtbl_isaelem;
4169 case PERL_MAGIC_nkeys:
4170 vtable = &PL_vtbl_nkeys;
4172 case PERL_MAGIC_dbfile:
4175 case PERL_MAGIC_dbline:
4176 vtable = &PL_vtbl_dbline;
4178 #ifdef USE_LOCALE_COLLATE
4179 case PERL_MAGIC_collxfrm:
4180 vtable = &PL_vtbl_collxfrm;
4182 #endif /* USE_LOCALE_COLLATE */
4183 case PERL_MAGIC_tied:
4184 vtable = &PL_vtbl_pack;
4186 case PERL_MAGIC_tiedelem:
4187 case PERL_MAGIC_tiedscalar:
4188 vtable = &PL_vtbl_packelem;
4191 vtable = &PL_vtbl_regexp;
4193 case PERL_MAGIC_sig:
4194 vtable = &PL_vtbl_sig;
4196 case PERL_MAGIC_sigelem:
4197 vtable = &PL_vtbl_sigelem;
4199 case PERL_MAGIC_taint:
4200 vtable = &PL_vtbl_taint;
4202 case PERL_MAGIC_uvar:
4203 vtable = &PL_vtbl_uvar;
4205 case PERL_MAGIC_vec:
4206 vtable = &PL_vtbl_vec;
4208 case PERL_MAGIC_arylen_p:
4209 case PERL_MAGIC_rhash:
4210 case PERL_MAGIC_symtab:
4211 case PERL_MAGIC_vstring:
4214 case PERL_MAGIC_utf8:
4215 vtable = &PL_vtbl_utf8;
4217 case PERL_MAGIC_substr:
4218 vtable = &PL_vtbl_substr;
4220 case PERL_MAGIC_defelem:
4221 vtable = &PL_vtbl_defelem;
4223 case PERL_MAGIC_glob:
4224 vtable = &PL_vtbl_glob;
4226 case PERL_MAGIC_arylen:
4227 vtable = &PL_vtbl_arylen;
4229 case PERL_MAGIC_pos:
4230 vtable = &PL_vtbl_pos;
4232 case PERL_MAGIC_backref:
4233 vtable = &PL_vtbl_backref;
4235 case PERL_MAGIC_ext:
4236 /* Reserved for use by extensions not perl internals. */
4237 /* Useful for attaching extension internal data to perl vars. */
4238 /* Note that multiple extensions may clash if magical scalars */
4239 /* etc holding private data from one are passed to another. */
4243 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4246 /* Rest of work is done else where */
4247 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4250 case PERL_MAGIC_taint:
4253 case PERL_MAGIC_ext:
4254 case PERL_MAGIC_dbfile:
4261 =for apidoc sv_unmagic
4263 Removes all magic of type C<type> from an SV.
4269 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4273 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4276 for (mg = *mgp; mg; mg = *mgp) {
4277 if (mg->mg_type == type) {
4278 const MGVTBL* const vtbl = mg->mg_virtual;
4279 *mgp = mg->mg_moremagic;
4280 if (vtbl && vtbl->svt_free)
4281 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4282 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4284 Safefree(mg->mg_ptr);
4285 else if (mg->mg_len == HEf_SVKEY)
4286 SvREFCNT_dec((SV*)mg->mg_ptr);
4287 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4288 Safefree(mg->mg_ptr);
4290 if (mg->mg_flags & MGf_REFCOUNTED)
4291 SvREFCNT_dec(mg->mg_obj);
4295 mgp = &mg->mg_moremagic;
4299 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4306 =for apidoc sv_rvweaken
4308 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4309 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4310 push a back-reference to this RV onto the array of backreferences
4311 associated with that magic.
4317 Perl_sv_rvweaken(pTHX_ SV *sv)
4320 if (!SvOK(sv)) /* let undefs pass */
4323 Perl_croak(aTHX_ "Can't weaken a nonreference");
4324 else if (SvWEAKREF(sv)) {
4325 if (ckWARN(WARN_MISC))
4326 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4330 Perl_sv_add_backref(aTHX_ tsv, sv);
4336 /* Give tsv backref magic if it hasn't already got it, then push a
4337 * back-reference to sv onto the array associated with the backref magic.
4341 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4345 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4346 av = (AV*)mg->mg_obj;
4349 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4350 /* av now has a refcnt of 2, which avoids it getting freed
4351 * before us during global cleanup. The extra ref is removed
4352 * by magic_killbackrefs() when tsv is being freed */
4354 if (AvFILLp(av) >= AvMAX(av)) {
4355 av_extend(av, AvFILLp(av)+1);
4357 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4360 /* delete a back-reference to ourselves from the backref magic associated
4361 * with the SV we point to.
4365 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4371 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4372 if (PL_in_clean_all)
4375 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4376 Perl_croak(aTHX_ "panic: del_backref");
4377 av = (AV *)mg->mg_obj;
4379 /* We shouldn't be in here more than once, but for paranoia reasons lets
4381 for (i = AvFILLp(av); i >= 0; i--) {
4383 const SSize_t fill = AvFILLp(av);
4385 /* We weren't the last entry.
4386 An unordered list has this property that you can take the
4387 last element off the end to fill the hole, and it's still
4388 an unordered list :-)
4393 AvFILLp(av) = fill - 1;
4399 =for apidoc sv_insert
4401 Inserts a string at the specified offset/length within the SV. Similar to
4402 the Perl substr() function.
4408 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4412 register char *midend;
4413 register char *bigend;
4419 Perl_croak(aTHX_ "Can't modify non-existent substring");
4420 SvPV_force(bigstr, curlen);
4421 (void)SvPOK_only_UTF8(bigstr);
4422 if (offset + len > curlen) {
4423 SvGROW(bigstr, offset+len+1);
4424 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4425 SvCUR_set(bigstr, offset+len);
4429 i = littlelen - len;
4430 if (i > 0) { /* string might grow */
4431 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4432 mid = big + offset + len;
4433 midend = bigend = big + SvCUR(bigstr);
4436 while (midend > mid) /* shove everything down */
4437 *--bigend = *--midend;
4438 Move(little,big+offset,littlelen,char);
4439 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4444 Move(little,SvPVX(bigstr)+offset,len,char);
4449 big = SvPVX(bigstr);
4452 bigend = big + SvCUR(bigstr);
4454 if (midend > bigend)
4455 Perl_croak(aTHX_ "panic: sv_insert");
4457 if (mid - big > bigend - midend) { /* faster to shorten from end */
4459 Move(little, mid, littlelen,char);
4462 i = bigend - midend;
4464 Move(midend, mid, i,char);
4468 SvCUR_set(bigstr, mid - big);
4470 else if ((i = mid - big)) { /* faster from front */
4471 midend -= littlelen;
4473 sv_chop(bigstr,midend-i);
4478 Move(little, mid, littlelen,char);
4480 else if (littlelen) {
4481 midend -= littlelen;
4482 sv_chop(bigstr,midend);
4483 Move(little,midend,littlelen,char);
4486 sv_chop(bigstr,midend);
4492 =for apidoc sv_replace
4494 Make the first argument a copy of the second, then delete the original.
4495 The target SV physically takes over ownership of the body of the source SV
4496 and inherits its flags; however, the target keeps any magic it owns,
4497 and any magic in the source is discarded.
4498 Note that this is a rather specialist SV copying operation; most of the
4499 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4505 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4507 const U32 refcnt = SvREFCNT(sv);
4508 SV_CHECK_THINKFIRST_COW_DROP(sv);
4509 if (SvREFCNT(nsv) != 1) {
4510 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4511 UVuf " != 1)", (UV) SvREFCNT(nsv));
4513 if (SvMAGICAL(sv)) {
4517 sv_upgrade(nsv, SVt_PVMG);
4518 SvMAGIC_set(nsv, SvMAGIC(sv));
4519 SvFLAGS(nsv) |= SvMAGICAL(sv);
4521 SvMAGIC_set(sv, NULL);
4525 assert(!SvREFCNT(sv));
4526 #ifdef DEBUG_LEAKING_SCALARS
4527 sv->sv_flags = nsv->sv_flags;
4528 sv->sv_any = nsv->sv_any;
4529 sv->sv_refcnt = nsv->sv_refcnt;
4530 sv->sv_u = nsv->sv_u;
4532 StructCopy(nsv,sv,SV);
4534 /* Currently could join these into one piece of pointer arithmetic, but
4535 it would be unclear. */
4536 if(SvTYPE(sv) == SVt_IV)
4538 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4539 else if (SvTYPE(sv) == SVt_RV) {
4540 SvANY(sv) = &sv->sv_u.svu_rv;
4544 #ifdef PERL_OLD_COPY_ON_WRITE
4545 if (SvIsCOW_normal(nsv)) {
4546 /* We need to follow the pointers around the loop to make the
4547 previous SV point to sv, rather than nsv. */
4550 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4553 assert(SvPVX_const(current) == SvPVX_const(nsv));
4555 /* Make the SV before us point to the SV after us. */
4557 PerlIO_printf(Perl_debug_log, "previous is\n");
4559 PerlIO_printf(Perl_debug_log,
4560 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4561 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4563 SV_COW_NEXT_SV_SET(current, sv);
4566 SvREFCNT(sv) = refcnt;
4567 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4573 =for apidoc sv_clear
4575 Clear an SV: call any destructors, free up any memory used by the body,
4576 and free the body itself. The SV's head is I<not> freed, although
4577 its type is set to all 1's so that it won't inadvertently be assumed
4578 to be live during global destruction etc.
4579 This function should only be called when REFCNT is zero. Most of the time
4580 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4587 Perl_sv_clear(pTHX_ register SV *sv)
4590 const U32 type = SvTYPE(sv);
4591 const struct body_details *const sv_type_details
4592 = bodies_by_type + type;
4595 assert(SvREFCNT(sv) == 0);
4601 if (PL_defstash) { /* Still have a symbol table? */
4606 stash = SvSTASH(sv);
4607 destructor = StashHANDLER(stash,DESTROY);
4609 SV* const tmpref = newRV(sv);
4610 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4612 PUSHSTACKi(PERLSI_DESTROY);
4617 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4623 if(SvREFCNT(tmpref) < 2) {
4624 /* tmpref is not kept alive! */
4626 SvRV_set(tmpref, NULL);
4629 SvREFCNT_dec(tmpref);
4631 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4635 if (PL_in_clean_objs)
4636 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4638 /* DESTROY gave object new lease on life */
4644 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4645 SvOBJECT_off(sv); /* Curse the object. */
4646 if (type != SVt_PVIO)
4647 --PL_sv_objcount; /* XXX Might want something more general */
4650 if (type >= SVt_PVMG) {
4653 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4654 SvREFCNT_dec(SvSTASH(sv));
4659 IoIFP(sv) != PerlIO_stdin() &&
4660 IoIFP(sv) != PerlIO_stdout() &&
4661 IoIFP(sv) != PerlIO_stderr())
4663 io_close((IO*)sv, FALSE);
4665 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4666 PerlDir_close(IoDIRP(sv));
4667 IoDIRP(sv) = (DIR*)NULL;
4668 Safefree(IoTOP_NAME(sv));
4669 Safefree(IoFMT_NAME(sv));
4670 Safefree(IoBOTTOM_NAME(sv));
4685 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4686 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4687 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4688 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4690 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4691 SvREFCNT_dec(LvTARG(sv));
4695 Safefree(GvNAME(sv));
4696 /* If we're in a stash, we don't own a reference to it. However it does
4697 have a back reference to us, which needs to be cleared. */
4699 sv_del_backref((SV*)GvSTASH(sv), sv);
4704 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4706 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4707 /* Don't even bother with turning off the OOK flag. */
4712 SV *target = SvRV(sv);
4714 sv_del_backref(target, sv);
4716 SvREFCNT_dec(target);
4718 #ifdef PERL_OLD_COPY_ON_WRITE
4719 else if (SvPVX_const(sv)) {
4721 /* I believe I need to grab the global SV mutex here and
4722 then recheck the COW status. */
4724 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4727 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4728 SV_COW_NEXT_SV(sv));
4729 /* And drop it here. */
4731 } else if (SvLEN(sv)) {
4732 Safefree(SvPVX_const(sv));
4736 else if (SvPVX_const(sv) && SvLEN(sv))
4737 Safefree(SvPVX_mutable(sv));
4738 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4739 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4748 SvFLAGS(sv) &= SVf_BREAK;
4749 SvFLAGS(sv) |= SVTYPEMASK;
4751 if (sv_type_details->arena) {
4752 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4753 &PL_body_roots[type]);
4755 else if (sv_type_details->size) {
4756 my_safefree(SvANY(sv));
4761 =for apidoc sv_newref
4763 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4770 Perl_sv_newref(pTHX_ SV *sv)
4780 Decrement an SV's reference count, and if it drops to zero, call
4781 C<sv_clear> to invoke destructors and free up any memory used by
4782 the body; finally, deallocate the SV's head itself.
4783 Normally called via a wrapper macro C<SvREFCNT_dec>.
4789 Perl_sv_free(pTHX_ SV *sv)
4794 if (SvREFCNT(sv) == 0) {
4795 if (SvFLAGS(sv) & SVf_BREAK)
4796 /* this SV's refcnt has been artificially decremented to
4797 * trigger cleanup */
4799 if (PL_in_clean_all) /* All is fair */
4801 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4802 /* make sure SvREFCNT(sv)==0 happens very seldom */
4803 SvREFCNT(sv) = (~(U32)0)/2;
4806 if (ckWARN_d(WARN_INTERNAL)) {
4807 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4808 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4809 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4810 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4811 Perl_dump_sv_child(aTHX_ sv);
4816 if (--(SvREFCNT(sv)) > 0)
4818 Perl_sv_free2(aTHX_ sv);
4822 Perl_sv_free2(pTHX_ SV *sv)
4827 if (ckWARN_d(WARN_DEBUGGING))
4828 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4829 "Attempt to free temp prematurely: SV 0x%"UVxf
4830 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4834 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4835 /* make sure SvREFCNT(sv)==0 happens very seldom */
4836 SvREFCNT(sv) = (~(U32)0)/2;
4847 Returns the length of the string in the SV. Handles magic and type
4848 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4854 Perl_sv_len(pTHX_ register SV *sv)
4862 len = mg_length(sv);
4864 (void)SvPV_const(sv, len);
4869 =for apidoc sv_len_utf8
4871 Returns the number of characters in the string in an SV, counting wide
4872 UTF-8 bytes as a single character. Handles magic and type coercion.
4878 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4879 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4880 * (Note that the mg_len is not the length of the mg_ptr field.)
4885 Perl_sv_len_utf8(pTHX_ register SV *sv)
4891 return mg_length(sv);
4895 const U8 *s = (U8*)SvPV_const(sv, len);
4896 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4898 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4900 #ifdef PERL_UTF8_CACHE_ASSERT
4901 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4905 ulen = Perl_utf8_length(aTHX_ s, s + len);
4906 if (!mg && !SvREADONLY(sv)) {
4907 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4908 mg = mg_find(sv, PERL_MAGIC_utf8);
4918 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4919 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4920 * between UTF-8 and byte offsets. There are two (substr offset and substr
4921 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4922 * and byte offset) cache positions.
4924 * The mg_len field is used by sv_len_utf8(), see its comments.
4925 * Note that the mg_len is not the length of the mg_ptr field.
4929 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4930 I32 offsetp, const U8 *s, const U8 *start)
4934 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4936 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4940 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4942 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4943 (*mgp)->mg_ptr = (char *) *cachep;
4947 (*cachep)[i] = offsetp;
4948 (*cachep)[i+1] = s - start;
4956 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4957 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4958 * between UTF-8 and byte offsets. See also the comments of
4959 * S_utf8_mg_pos_init().
4963 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)
4967 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4969 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4970 if (*mgp && (*mgp)->mg_ptr) {
4971 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4972 ASSERT_UTF8_CACHE(*cachep);
4973 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4975 else { /* We will skip to the right spot. */
4980 /* The assumption is that going backward is half
4981 * the speed of going forward (that's where the
4982 * 2 * backw in the below comes from). (The real
4983 * figure of course depends on the UTF-8 data.) */
4985 if ((*cachep)[i] > (STRLEN)uoff) {
4987 backw = (*cachep)[i] - (STRLEN)uoff;
4989 if (forw < 2 * backw)
4992 p = start + (*cachep)[i+1];
4994 /* Try this only for the substr offset (i == 0),
4995 * not for the substr length (i == 2). */
4996 else if (i == 0) { /* (*cachep)[i] < uoff */
4997 const STRLEN ulen = sv_len_utf8(sv);
4999 if ((STRLEN)uoff < ulen) {
5000 forw = (STRLEN)uoff - (*cachep)[i];
5001 backw = ulen - (STRLEN)uoff;
5003 if (forw < 2 * backw)
5004 p = start + (*cachep)[i+1];
5009 /* If the string is not long enough for uoff,
5010 * we could extend it, but not at this low a level. */
5014 if (forw < 2 * backw) {
5021 while (UTF8_IS_CONTINUATION(*p))
5026 /* Update the cache. */
5027 (*cachep)[i] = (STRLEN)uoff;
5028 (*cachep)[i+1] = p - start;
5030 /* Drop the stale "length" cache */
5039 if (found) { /* Setup the return values. */
5040 *offsetp = (*cachep)[i+1];
5041 *sp = start + *offsetp;
5044 *offsetp = send - start;
5046 else if (*sp < start) {
5052 #ifdef PERL_UTF8_CACHE_ASSERT
5057 while (n-- && s < send)
5061 assert(*offsetp == s - start);
5062 assert((*cachep)[0] == (STRLEN)uoff);
5063 assert((*cachep)[1] == *offsetp);
5065 ASSERT_UTF8_CACHE(*cachep);
5074 =for apidoc sv_pos_u2b
5076 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5077 the start of the string, to a count of the equivalent number of bytes; if
5078 lenp is non-zero, it does the same to lenp, but this time starting from
5079 the offset, rather than from the start of the string. Handles magic and
5086 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5087 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5088 * byte offsets. See also the comments of S_utf8_mg_pos().
5093 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5101 start = (U8*)SvPV_const(sv, len);
5105 const U8 *s = start;
5106 I32 uoffset = *offsetp;
5107 const U8 * const send = s + len;
5111 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5113 if (!found && uoffset > 0) {
5114 while (s < send && uoffset--)
5118 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5120 *offsetp = s - start;
5125 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5129 if (!found && *lenp > 0) {
5132 while (s < send && ulen--)
5136 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5140 ASSERT_UTF8_CACHE(cache);
5152 =for apidoc sv_pos_b2u
5154 Converts the value pointed to by offsetp from a count of bytes from the
5155 start of the string, to a count of the equivalent number of UTF-8 chars.
5156 Handles magic and type coercion.
5162 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5163 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5164 * byte offsets. See also the comments of S_utf8_mg_pos().
5169 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5177 s = (const U8*)SvPV_const(sv, len);
5178 if ((I32)len < *offsetp)
5179 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5181 const U8* send = s + *offsetp;
5183 STRLEN *cache = NULL;
5187 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5188 mg = mg_find(sv, PERL_MAGIC_utf8);
5189 if (mg && mg->mg_ptr) {
5190 cache = (STRLEN *) mg->mg_ptr;
5191 if (cache[1] == (STRLEN)*offsetp) {
5192 /* An exact match. */
5193 *offsetp = cache[0];
5197 else if (cache[1] < (STRLEN)*offsetp) {
5198 /* We already know part of the way. */
5201 /* Let the below loop do the rest. */
5203 else { /* cache[1] > *offsetp */
5204 /* We already know all of the way, now we may
5205 * be able to walk back. The same assumption
5206 * is made as in S_utf8_mg_pos(), namely that
5207 * walking backward is twice slower than
5208 * walking forward. */
5209 const STRLEN forw = *offsetp;
5210 STRLEN backw = cache[1] - *offsetp;
5212 if (!(forw < 2 * backw)) {
5213 const U8 *p = s + cache[1];
5220 while (UTF8_IS_CONTINUATION(*p)) {
5228 *offsetp = cache[0];
5230 /* Drop the stale "length" cache */
5238 ASSERT_UTF8_CACHE(cache);
5244 /* Call utf8n_to_uvchr() to validate the sequence
5245 * (unless a simple non-UTF character) */
5246 if (!UTF8_IS_INVARIANT(*s))
5247 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5256 if (!SvREADONLY(sv)) {
5258 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5259 mg = mg_find(sv, PERL_MAGIC_utf8);
5264 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5265 mg->mg_ptr = (char *) cache;
5270 cache[1] = *offsetp;
5271 /* Drop the stale "length" cache */
5284 Returns a boolean indicating whether the strings in the two SVs are
5285 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5286 coerce its args to strings if necessary.
5292 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5300 SV* svrecode = Nullsv;
5307 pv1 = SvPV_const(sv1, cur1);
5314 pv2 = SvPV_const(sv2, cur2);
5316 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5317 /* Differing utf8ness.
5318 * Do not UTF8size the comparands as a side-effect. */
5321 svrecode = newSVpvn(pv2, cur2);
5322 sv_recode_to_utf8(svrecode, PL_encoding);
5323 pv2 = SvPV_const(svrecode, cur2);
5326 svrecode = newSVpvn(pv1, cur1);
5327 sv_recode_to_utf8(svrecode, PL_encoding);
5328 pv1 = SvPV_const(svrecode, cur1);
5330 /* Now both are in UTF-8. */
5332 SvREFCNT_dec(svrecode);
5337 bool is_utf8 = TRUE;
5340 /* sv1 is the UTF-8 one,
5341 * if is equal it must be downgrade-able */
5342 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5348 /* sv2 is the UTF-8 one,
5349 * if is equal it must be downgrade-able */
5350 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5356 /* Downgrade not possible - cannot be eq */
5364 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5367 SvREFCNT_dec(svrecode);
5378 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5379 string in C<sv1> is less than, equal to, or greater than the string in
5380 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5381 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5387 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5390 const char *pv1, *pv2;
5393 SV *svrecode = Nullsv;
5400 pv1 = SvPV_const(sv1, cur1);
5407 pv2 = SvPV_const(sv2, cur2);
5409 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5410 /* Differing utf8ness.
5411 * Do not UTF8size the comparands as a side-effect. */
5414 svrecode = newSVpvn(pv2, cur2);
5415 sv_recode_to_utf8(svrecode, PL_encoding);
5416 pv2 = SvPV_const(svrecode, cur2);
5419 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5424 svrecode = newSVpvn(pv1, cur1);
5425 sv_recode_to_utf8(svrecode, PL_encoding);
5426 pv1 = SvPV_const(svrecode, cur1);
5429 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5435 cmp = cur2 ? -1 : 0;
5439 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5442 cmp = retval < 0 ? -1 : 1;
5443 } else if (cur1 == cur2) {
5446 cmp = cur1 < cur2 ? -1 : 1;
5451 SvREFCNT_dec(svrecode);
5460 =for apidoc sv_cmp_locale
5462 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5463 'use bytes' aware, handles get magic, and will coerce its args to strings
5464 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5470 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5472 #ifdef USE_LOCALE_COLLATE
5478 if (PL_collation_standard)
5482 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5484 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5486 if (!pv1 || !len1) {
5497 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5500 return retval < 0 ? -1 : 1;
5503 * When the result of collation is equality, that doesn't mean
5504 * that there are no differences -- some locales exclude some
5505 * characters from consideration. So to avoid false equalities,
5506 * we use the raw string as a tiebreaker.
5512 #endif /* USE_LOCALE_COLLATE */
5514 return sv_cmp(sv1, sv2);
5518 #ifdef USE_LOCALE_COLLATE
5521 =for apidoc sv_collxfrm
5523 Add Collate Transform magic to an SV if it doesn't already have it.
5525 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5526 scalar data of the variable, but transformed to such a format that a normal
5527 memory comparison can be used to compare the data according to the locale
5534 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5538 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5539 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5545 Safefree(mg->mg_ptr);
5546 s = SvPV_const(sv, len);
5547 if ((xf = mem_collxfrm(s, len, &xlen))) {
5548 if (SvREADONLY(sv)) {
5551 return xf + sizeof(PL_collation_ix);
5554 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5555 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5568 if (mg && mg->mg_ptr) {
5570 return mg->mg_ptr + sizeof(PL_collation_ix);
5578 #endif /* USE_LOCALE_COLLATE */
5583 Get a line from the filehandle and store it into the SV, optionally
5584 appending to the currently-stored string.
5590 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5594 register STDCHAR rslast;
5595 register STDCHAR *bp;
5601 if (SvTHINKFIRST(sv))
5602 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5603 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5605 However, perlbench says it's slower, because the existing swipe code
5606 is faster than copy on write.
5607 Swings and roundabouts. */
5608 SvUPGRADE(sv, SVt_PV);
5613 if (PerlIO_isutf8(fp)) {
5615 sv_utf8_upgrade_nomg(sv);
5616 sv_pos_u2b(sv,&append,0);
5618 } else if (SvUTF8(sv)) {
5619 SV * const tsv = NEWSV(0,0);
5620 sv_gets(tsv, fp, 0);
5621 sv_utf8_upgrade_nomg(tsv);
5622 SvCUR_set(sv,append);
5625 goto return_string_or_null;
5630 if (PerlIO_isutf8(fp))
5633 if (IN_PERL_COMPILETIME) {
5634 /* we always read code in line mode */
5638 else if (RsSNARF(PL_rs)) {
5639 /* If it is a regular disk file use size from stat() as estimate
5640 of amount we are going to read - may result in malloc-ing
5641 more memory than we realy need if layers bellow reduce
5642 size we read (e.g. CRLF or a gzip layer)
5645 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5646 const Off_t offset = PerlIO_tell(fp);
5647 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5648 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5654 else if (RsRECORD(PL_rs)) {
5658 /* Grab the size of the record we're getting */
5659 recsize = SvIV(SvRV(PL_rs));
5660 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5663 /* VMS wants read instead of fread, because fread doesn't respect */
5664 /* RMS record boundaries. This is not necessarily a good thing to be */
5665 /* doing, but we've got no other real choice - except avoid stdio
5666 as implementation - perhaps write a :vms layer ?
5668 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5670 bytesread = PerlIO_read(fp, buffer, recsize);
5674 SvCUR_set(sv, bytesread += append);
5675 buffer[bytesread] = '\0';
5676 goto return_string_or_null;
5678 else if (RsPARA(PL_rs)) {
5684 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5685 if (PerlIO_isutf8(fp)) {
5686 rsptr = SvPVutf8(PL_rs, rslen);
5689 if (SvUTF8(PL_rs)) {
5690 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5691 Perl_croak(aTHX_ "Wide character in $/");
5694 rsptr = SvPV_const(PL_rs, rslen);
5698 rslast = rslen ? rsptr[rslen - 1] : '\0';
5700 if (rspara) { /* have to do this both before and after */
5701 do { /* to make sure file boundaries work right */
5704 i = PerlIO_getc(fp);
5708 PerlIO_ungetc(fp,i);
5714 /* See if we know enough about I/O mechanism to cheat it ! */
5716 /* This used to be #ifdef test - it is made run-time test for ease
5717 of abstracting out stdio interface. One call should be cheap
5718 enough here - and may even be a macro allowing compile
5722 if (PerlIO_fast_gets(fp)) {
5725 * We're going to steal some values from the stdio struct
5726 * and put EVERYTHING in the innermost loop into registers.
5728 register STDCHAR *ptr;
5732 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5733 /* An ungetc()d char is handled separately from the regular
5734 * buffer, so we getc() it back out and stuff it in the buffer.
5736 i = PerlIO_getc(fp);
5737 if (i == EOF) return 0;
5738 *(--((*fp)->_ptr)) = (unsigned char) i;
5742 /* Here is some breathtakingly efficient cheating */
5744 cnt = PerlIO_get_cnt(fp); /* get count into register */
5745 /* make sure we have the room */
5746 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5747 /* Not room for all of it
5748 if we are looking for a separator and room for some
5750 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5751 /* just process what we have room for */
5752 shortbuffered = cnt - SvLEN(sv) + append + 1;
5753 cnt -= shortbuffered;
5757 /* remember that cnt can be negative */
5758 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5763 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5764 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5765 DEBUG_P(PerlIO_printf(Perl_debug_log,
5766 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5767 DEBUG_P(PerlIO_printf(Perl_debug_log,
5768 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5769 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5770 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5775 while (cnt > 0) { /* this | eat */
5777 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5778 goto thats_all_folks; /* screams | sed :-) */
5782 Copy(ptr, bp, cnt, char); /* this | eat */
5783 bp += cnt; /* screams | dust */
5784 ptr += cnt; /* louder | sed :-) */
5789 if (shortbuffered) { /* oh well, must extend */
5790 cnt = shortbuffered;
5792 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5794 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5795 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5799 DEBUG_P(PerlIO_printf(Perl_debug_log,
5800 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5801 PTR2UV(ptr),(long)cnt));
5802 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5804 DEBUG_P(PerlIO_printf(Perl_debug_log,
5805 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5806 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5807 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5809 /* This used to call 'filbuf' in stdio form, but as that behaves like
5810 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5811 another abstraction. */
5812 i = PerlIO_getc(fp); /* get more characters */
5814 DEBUG_P(PerlIO_printf(Perl_debug_log,
5815 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5816 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5817 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5819 cnt = PerlIO_get_cnt(fp);
5820 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5821 DEBUG_P(PerlIO_printf(Perl_debug_log,
5822 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5824 if (i == EOF) /* all done for ever? */
5825 goto thats_really_all_folks;
5827 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5829 SvGROW(sv, bpx + cnt + 2);
5830 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5832 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5834 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5835 goto thats_all_folks;
5839 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5840 memNE((char*)bp - rslen, rsptr, rslen))
5841 goto screamer; /* go back to the fray */
5842 thats_really_all_folks:
5844 cnt += shortbuffered;
5845 DEBUG_P(PerlIO_printf(Perl_debug_log,
5846 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5847 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5848 DEBUG_P(PerlIO_printf(Perl_debug_log,
5849 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5850 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5851 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5853 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5854 DEBUG_P(PerlIO_printf(Perl_debug_log,
5855 "Screamer: done, len=%ld, string=|%.*s|\n",
5856 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5860 /*The big, slow, and stupid way. */
5861 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5863 Newx(buf, 8192, STDCHAR);
5871 register const STDCHAR * const bpe = buf + sizeof(buf);
5873 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5874 ; /* keep reading */
5878 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5879 /* Accomodate broken VAXC compiler, which applies U8 cast to
5880 * both args of ?: operator, causing EOF to change into 255
5883 i = (U8)buf[cnt - 1];
5889 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5891 sv_catpvn(sv, (char *) buf, cnt);
5893 sv_setpvn(sv, (char *) buf, cnt);
5895 if (i != EOF && /* joy */
5897 SvCUR(sv) < rslen ||
5898 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5902 * If we're reading from a TTY and we get a short read,
5903 * indicating that the user hit his EOF character, we need
5904 * to notice it now, because if we try to read from the TTY
5905 * again, the EOF condition will disappear.
5907 * The comparison of cnt to sizeof(buf) is an optimization
5908 * that prevents unnecessary calls to feof().
5912 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5916 #ifdef USE_HEAP_INSTEAD_OF_STACK
5921 if (rspara) { /* have to do this both before and after */
5922 while (i != EOF) { /* to make sure file boundaries work right */
5923 i = PerlIO_getc(fp);
5925 PerlIO_ungetc(fp,i);
5931 return_string_or_null:
5932 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5938 Auto-increment of the value in the SV, doing string to numeric conversion
5939 if necessary. Handles 'get' magic.
5945 Perl_sv_inc(pTHX_ register SV *sv)
5953 if (SvTHINKFIRST(sv)) {
5955 sv_force_normal_flags(sv, 0);
5956 if (SvREADONLY(sv)) {
5957 if (IN_PERL_RUNTIME)
5958 Perl_croak(aTHX_ PL_no_modify);
5962 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5964 i = PTR2IV(SvRV(sv));
5969 flags = SvFLAGS(sv);
5970 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5971 /* It's (privately or publicly) a float, but not tested as an
5972 integer, so test it to see. */
5974 flags = SvFLAGS(sv);
5976 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5977 /* It's publicly an integer, or privately an integer-not-float */
5978 #ifdef PERL_PRESERVE_IVUV
5982 if (SvUVX(sv) == UV_MAX)
5983 sv_setnv(sv, UV_MAX_P1);
5985 (void)SvIOK_only_UV(sv);
5986 SvUV_set(sv, SvUVX(sv) + 1);
5988 if (SvIVX(sv) == IV_MAX)
5989 sv_setuv(sv, (UV)IV_MAX + 1);
5991 (void)SvIOK_only(sv);
5992 SvIV_set(sv, SvIVX(sv) + 1);
5997 if (flags & SVp_NOK) {
5998 (void)SvNOK_only(sv);
5999 SvNV_set(sv, SvNVX(sv) + 1.0);
6003 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6004 if ((flags & SVTYPEMASK) < SVt_PVIV)
6005 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6006 (void)SvIOK_only(sv);
6011 while (isALPHA(*d)) d++;
6012 while (isDIGIT(*d)) d++;
6014 #ifdef PERL_PRESERVE_IVUV
6015 /* Got to punt this as an integer if needs be, but we don't issue
6016 warnings. Probably ought to make the sv_iv_please() that does
6017 the conversion if possible, and silently. */
6018 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6019 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6020 /* Need to try really hard to see if it's an integer.
6021 9.22337203685478e+18 is an integer.
6022 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6023 so $a="9.22337203685478e+18"; $a+0; $a++
6024 needs to be the same as $a="9.22337203685478e+18"; $a++
6031 /* sv_2iv *should* have made this an NV */
6032 if (flags & SVp_NOK) {
6033 (void)SvNOK_only(sv);
6034 SvNV_set(sv, SvNVX(sv) + 1.0);
6037 /* I don't think we can get here. Maybe I should assert this
6038 And if we do get here I suspect that sv_setnv will croak. NWC
6040 #if defined(USE_LONG_DOUBLE)
6041 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",
6042 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6044 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6045 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6048 #endif /* PERL_PRESERVE_IVUV */
6049 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6053 while (d >= SvPVX_const(sv)) {
6061 /* MKS: The original code here died if letters weren't consecutive.
6062 * at least it didn't have to worry about non-C locales. The
6063 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6064 * arranged in order (although not consecutively) and that only
6065 * [A-Za-z] are accepted by isALPHA in the C locale.
6067 if (*d != 'z' && *d != 'Z') {
6068 do { ++*d; } while (!isALPHA(*d));
6071 *(d--) -= 'z' - 'a';
6076 *(d--) -= 'z' - 'a' + 1;
6080 /* oh,oh, the number grew */
6081 SvGROW(sv, SvCUR(sv) + 2);
6082 SvCUR_set(sv, SvCUR(sv) + 1);
6083 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6094 Auto-decrement of the value in the SV, doing string to numeric conversion
6095 if necessary. Handles 'get' magic.
6101 Perl_sv_dec(pTHX_ register SV *sv)
6108 if (SvTHINKFIRST(sv)) {
6110 sv_force_normal_flags(sv, 0);
6111 if (SvREADONLY(sv)) {
6112 if (IN_PERL_RUNTIME)
6113 Perl_croak(aTHX_ PL_no_modify);
6117 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6119 i = PTR2IV(SvRV(sv));
6124 /* Unlike sv_inc we don't have to worry about string-never-numbers
6125 and keeping them magic. But we mustn't warn on punting */
6126 flags = SvFLAGS(sv);
6127 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6128 /* It's publicly an integer, or privately an integer-not-float */
6129 #ifdef PERL_PRESERVE_IVUV
6133 if (SvUVX(sv) == 0) {
6134 (void)SvIOK_only(sv);
6138 (void)SvIOK_only_UV(sv);
6139 SvUV_set(sv, SvUVX(sv) - 1);
6142 if (SvIVX(sv) == IV_MIN)
6143 sv_setnv(sv, (NV)IV_MIN - 1.0);
6145 (void)SvIOK_only(sv);
6146 SvIV_set(sv, SvIVX(sv) - 1);
6151 if (flags & SVp_NOK) {
6152 SvNV_set(sv, SvNVX(sv) - 1.0);
6153 (void)SvNOK_only(sv);
6156 if (!(flags & SVp_POK)) {
6157 if ((flags & SVTYPEMASK) < SVt_PVIV)
6158 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6160 (void)SvIOK_only(sv);
6163 #ifdef PERL_PRESERVE_IVUV
6165 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6166 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6167 /* Need to try really hard to see if it's an integer.
6168 9.22337203685478e+18 is an integer.
6169 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6170 so $a="9.22337203685478e+18"; $a+0; $a--
6171 needs to be the same as $a="9.22337203685478e+18"; $a--
6178 /* sv_2iv *should* have made this an NV */
6179 if (flags & SVp_NOK) {
6180 (void)SvNOK_only(sv);
6181 SvNV_set(sv, SvNVX(sv) - 1.0);
6184 /* I don't think we can get here. Maybe I should assert this
6185 And if we do get here I suspect that sv_setnv will croak. NWC
6187 #if defined(USE_LONG_DOUBLE)
6188 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",
6189 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6191 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6192 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6196 #endif /* PERL_PRESERVE_IVUV */
6197 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6201 =for apidoc sv_mortalcopy
6203 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6204 The new SV is marked as mortal. It will be destroyed "soon", either by an
6205 explicit call to FREETMPS, or by an implicit call at places such as
6206 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6211 /* Make a string that will exist for the duration of the expression
6212 * evaluation. Actually, it may have to last longer than that, but
6213 * hopefully we won't free it until it has been assigned to a
6214 * permanent location. */
6217 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6222 sv_setsv(sv,oldstr);
6224 PL_tmps_stack[++PL_tmps_ix] = sv;
6230 =for apidoc sv_newmortal
6232 Creates a new null SV which is mortal. The reference count of the SV is
6233 set to 1. It will be destroyed "soon", either by an explicit call to
6234 FREETMPS, or by an implicit call at places such as statement boundaries.
6235 See also C<sv_mortalcopy> and C<sv_2mortal>.
6241 Perl_sv_newmortal(pTHX)
6246 SvFLAGS(sv) = SVs_TEMP;
6248 PL_tmps_stack[++PL_tmps_ix] = sv;
6253 =for apidoc sv_2mortal
6255 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6256 by an explicit call to FREETMPS, or by an implicit call at places such as
6257 statement boundaries. SvTEMP() is turned on which means that the SV's
6258 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6259 and C<sv_mortalcopy>.
6265 Perl_sv_2mortal(pTHX_ register SV *sv)
6270 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6273 PL_tmps_stack[++PL_tmps_ix] = sv;
6281 Creates a new SV and copies a string into it. The reference count for the
6282 SV is set to 1. If C<len> is zero, Perl will compute the length using
6283 strlen(). For efficiency, consider using C<newSVpvn> instead.
6289 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6294 sv_setpvn(sv,s,len ? len : strlen(s));
6299 =for apidoc newSVpvn
6301 Creates a new SV and copies a string into it. The reference count for the
6302 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6303 string. You are responsible for ensuring that the source string is at least
6304 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6310 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6315 sv_setpvn(sv,s,len);
6321 =for apidoc newSVhek
6323 Creates a new SV from the hash key structure. It will generate scalars that
6324 point to the shared string table where possible. Returns a new (undefined)
6325 SV if the hek is NULL.
6331 Perl_newSVhek(pTHX_ const HEK *hek)
6340 if (HEK_LEN(hek) == HEf_SVKEY) {
6341 return newSVsv(*(SV**)HEK_KEY(hek));
6343 const int flags = HEK_FLAGS(hek);
6344 if (flags & HVhek_WASUTF8) {
6346 Andreas would like keys he put in as utf8 to come back as utf8
6348 STRLEN utf8_len = HEK_LEN(hek);
6349 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6350 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6353 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6355 } else if (flags & HVhek_REHASH) {
6356 /* We don't have a pointer to the hv, so we have to replicate the
6357 flag into every HEK. This hv is using custom a hasing
6358 algorithm. Hence we can't return a shared string scalar, as
6359 that would contain the (wrong) hash value, and might get passed
6360 into an hv routine with a regular hash */
6362 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6367 /* This will be overwhelminly the most common case. */
6368 return newSVpvn_share(HEK_KEY(hek),
6369 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6375 =for apidoc newSVpvn_share
6377 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6378 table. If the string does not already exist in the table, it is created
6379 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6380 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6381 otherwise the hash is computed. The idea here is that as the string table
6382 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6383 hash lookup will avoid string compare.
6389 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6392 bool is_utf8 = FALSE;
6394 STRLEN tmplen = -len;
6396 /* See the note in hv.c:hv_fetch() --jhi */
6397 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6401 PERL_HASH(hash, src, len);
6403 sv_upgrade(sv, SVt_PV);
6404 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6416 #if defined(PERL_IMPLICIT_CONTEXT)
6418 /* pTHX_ magic can't cope with varargs, so this is a no-context
6419 * version of the main function, (which may itself be aliased to us).
6420 * Don't access this version directly.
6424 Perl_newSVpvf_nocontext(const char* pat, ...)
6429 va_start(args, pat);
6430 sv = vnewSVpvf(pat, &args);
6437 =for apidoc newSVpvf
6439 Creates a new SV and initializes it with the string formatted like
6446 Perl_newSVpvf(pTHX_ const char* pat, ...)
6450 va_start(args, pat);
6451 sv = vnewSVpvf(pat, &args);
6456 /* backend for newSVpvf() and newSVpvf_nocontext() */
6459 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6463 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6470 Creates a new SV and copies a floating point value into it.
6471 The reference count for the SV is set to 1.
6477 Perl_newSVnv(pTHX_ NV n)
6489 Creates a new SV and copies an integer into it. The reference count for the
6496 Perl_newSViv(pTHX_ IV i)
6508 Creates a new SV and copies an unsigned integer into it.
6509 The reference count for the SV is set to 1.
6515 Perl_newSVuv(pTHX_ UV u)
6525 =for apidoc newRV_noinc
6527 Creates an RV wrapper for an SV. The reference count for the original
6528 SV is B<not> incremented.
6534 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6539 sv_upgrade(sv, SVt_RV);
6541 SvRV_set(sv, tmpRef);
6546 /* newRV_inc is the official function name to use now.
6547 * newRV_inc is in fact #defined to newRV in sv.h
6551 Perl_newRV(pTHX_ SV *tmpRef)
6553 return newRV_noinc(SvREFCNT_inc(tmpRef));
6559 Creates a new SV which is an exact duplicate of the original SV.
6566 Perl_newSVsv(pTHX_ register SV *old)
6572 if (SvTYPE(old) == SVTYPEMASK) {
6573 if (ckWARN_d(WARN_INTERNAL))
6574 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6578 /* SV_GMAGIC is the default for sv_setv()
6579 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6580 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6581 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6586 =for apidoc sv_reset
6588 Underlying implementation for the C<reset> Perl function.
6589 Note that the perl-level function is vaguely deprecated.
6595 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6598 char todo[PERL_UCHAR_MAX+1];
6603 if (!*s) { /* reset ?? searches */
6604 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6606 PMOP *pm = (PMOP *) mg->mg_obj;
6608 pm->op_pmdynflags &= ~PMdf_USED;
6615 /* reset variables */
6617 if (!HvARRAY(stash))
6620 Zero(todo, 256, char);
6623 I32 i = (unsigned char)*s;
6627 max = (unsigned char)*s++;
6628 for ( ; i <= max; i++) {
6631 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6633 for (entry = HvARRAY(stash)[i];
6635 entry = HeNEXT(entry))
6640 if (!todo[(U8)*HeKEY(entry)])
6642 gv = (GV*)HeVAL(entry);
6645 if (SvTHINKFIRST(sv)) {
6646 if (!SvREADONLY(sv) && SvROK(sv))
6648 /* XXX Is this continue a bug? Why should THINKFIRST
6649 exempt us from resetting arrays and hashes? */
6653 if (SvTYPE(sv) >= SVt_PV) {
6655 if (SvPVX_const(sv) != Nullch)
6663 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6665 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6668 # if defined(USE_ENVIRON_ARRAY)
6671 # endif /* USE_ENVIRON_ARRAY */
6682 Using various gambits, try to get an IO from an SV: the IO slot if its a
6683 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6684 named after the PV if we're a string.
6690 Perl_sv_2io(pTHX_ SV *sv)
6695 switch (SvTYPE(sv)) {
6703 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6707 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6709 return sv_2io(SvRV(sv));
6710 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6716 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6725 Using various gambits, try to get a CV from an SV; in addition, try if
6726 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6732 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6739 return *gvp = Nullgv, Nullcv;
6740 switch (SvTYPE(sv)) {
6758 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6759 tryAMAGICunDEREF(to_cv);
6762 if (SvTYPE(sv) == SVt_PVCV) {
6771 Perl_croak(aTHX_ "Not a subroutine reference");
6776 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6782 if (lref && !GvCVu(gv)) {
6785 tmpsv = NEWSV(704,0);
6786 gv_efullname3(tmpsv, gv, Nullch);
6787 /* XXX this is probably not what they think they're getting.
6788 * It has the same effect as "sub name;", i.e. just a forward
6790 newSUB(start_subparse(FALSE, 0),
6791 newSVOP(OP_CONST, 0, tmpsv),
6796 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6806 Returns true if the SV has a true value by Perl's rules.
6807 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6808 instead use an in-line version.
6814 Perl_sv_true(pTHX_ register SV *sv)
6819 register const XPV* const tXpv = (XPV*)SvANY(sv);
6821 (tXpv->xpv_cur > 1 ||
6822 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6829 return SvIVX(sv) != 0;
6832 return SvNVX(sv) != 0.0;
6834 return sv_2bool(sv);
6840 =for apidoc sv_pvn_force
6842 Get a sensible string out of the SV somehow.
6843 A private implementation of the C<SvPV_force> macro for compilers which
6844 can't cope with complex macro expressions. Always use the macro instead.
6846 =for apidoc sv_pvn_force_flags
6848 Get a sensible string out of the SV somehow.
6849 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6850 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6851 implemented in terms of this function.
6852 You normally want to use the various wrapper macros instead: see
6853 C<SvPV_force> and C<SvPV_force_nomg>
6859 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6862 if (SvTHINKFIRST(sv) && !SvROK(sv))
6863 sv_force_normal_flags(sv, 0);
6873 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6874 const char * const ref = sv_reftype(sv,0);
6876 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6877 ref, OP_NAME(PL_op));
6879 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6881 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6882 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6884 s = sv_2pv_flags(sv, &len, flags);
6888 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6891 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6892 SvGROW(sv, len + 1);
6893 Move(s,SvPVX(sv),len,char);
6898 SvPOK_on(sv); /* validate pointer */
6900 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6901 PTR2UV(sv),SvPVX_const(sv)));
6904 return SvPVX_mutable(sv);
6908 =for apidoc sv_pvbyten_force
6910 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6916 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6918 sv_pvn_force(sv,lp);
6919 sv_utf8_downgrade(sv,0);
6925 =for apidoc sv_pvutf8n_force
6927 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6933 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6935 sv_pvn_force(sv,lp);
6936 sv_utf8_upgrade(sv);
6942 =for apidoc sv_reftype
6944 Returns a string describing what the SV is a reference to.
6950 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6952 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6953 inside return suggests a const propagation bug in g++. */
6954 if (ob && SvOBJECT(sv)) {
6955 char * const name = HvNAME_get(SvSTASH(sv));
6956 return name ? name : (char *) "__ANON__";
6959 switch (SvTYPE(sv)) {
6976 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6977 /* tied lvalues should appear to be
6978 * scalars for backwards compatitbility */
6979 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6980 ? "SCALAR" : "LVALUE");
6981 case SVt_PVAV: return "ARRAY";
6982 case SVt_PVHV: return "HASH";
6983 case SVt_PVCV: return "CODE";
6984 case SVt_PVGV: return "GLOB";
6985 case SVt_PVFM: return "FORMAT";
6986 case SVt_PVIO: return "IO";
6987 default: return "UNKNOWN";
6993 =for apidoc sv_isobject
6995 Returns a boolean indicating whether the SV is an RV pointing to a blessed
6996 object. If the SV is not an RV, or if the object is not blessed, then this
7003 Perl_sv_isobject(pTHX_ SV *sv)
7019 Returns a boolean indicating whether the SV is blessed into the specified
7020 class. This does not check for subtypes; use C<sv_derived_from> to verify
7021 an inheritance relationship.
7027 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7038 hvname = HvNAME_get(SvSTASH(sv));
7042 return strEQ(hvname, name);
7048 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7049 it will be upgraded to one. If C<classname> is non-null then the new SV will
7050 be blessed in the specified package. The new SV is returned and its
7051 reference count is 1.
7057 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7063 SV_CHECK_THINKFIRST_COW_DROP(rv);
7066 if (SvTYPE(rv) >= SVt_PVMG) {
7067 const U32 refcnt = SvREFCNT(rv);
7071 SvREFCNT(rv) = refcnt;
7074 if (SvTYPE(rv) < SVt_RV)
7075 sv_upgrade(rv, SVt_RV);
7076 else if (SvTYPE(rv) > SVt_RV) {
7087 HV* const stash = gv_stashpv(classname, TRUE);
7088 (void)sv_bless(rv, stash);
7094 =for apidoc sv_setref_pv
7096 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7097 argument will be upgraded to an RV. That RV will be modified to point to
7098 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7099 into the SV. The C<classname> argument indicates the package for the
7100 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7101 will have a reference count of 1, and the RV will be returned.
7103 Do not use with other Perl types such as HV, AV, SV, CV, because those
7104 objects will become corrupted by the pointer copy process.
7106 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7112 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7115 sv_setsv(rv, &PL_sv_undef);
7119 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7124 =for apidoc sv_setref_iv
7126 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7127 argument will be upgraded to an RV. That RV will be modified to point to
7128 the new SV. The C<classname> argument indicates the package for the
7129 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7130 will have a reference count of 1, and the RV will be returned.
7136 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7138 sv_setiv(newSVrv(rv,classname), iv);
7143 =for apidoc sv_setref_uv
7145 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7146 argument will be upgraded to an RV. That RV will be modified to point to
7147 the new SV. The C<classname> argument indicates the package for the
7148 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7149 will have a reference count of 1, and the RV will be returned.
7155 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7157 sv_setuv(newSVrv(rv,classname), uv);
7162 =for apidoc sv_setref_nv
7164 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7165 argument will be upgraded to an RV. That RV will be modified to point to
7166 the new SV. The C<classname> argument indicates the package for the
7167 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7168 will have a reference count of 1, and the RV will be returned.
7174 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7176 sv_setnv(newSVrv(rv,classname), nv);
7181 =for apidoc sv_setref_pvn
7183 Copies a string into a new SV, optionally blessing the SV. The length of the
7184 string must be specified with C<n>. The C<rv> argument will be upgraded to
7185 an RV. That RV will be modified to point to the new SV. The C<classname>
7186 argument indicates the package for the blessing. Set C<classname> to
7187 C<Nullch> to avoid the blessing. The new SV will have a reference count
7188 of 1, and the RV will be returned.
7190 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7196 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7198 sv_setpvn(newSVrv(rv,classname), pv, n);
7203 =for apidoc sv_bless
7205 Blesses an SV into a specified package. The SV must be an RV. The package
7206 must be designated by its stash (see C<gv_stashpv()>). The reference count
7207 of the SV is unaffected.
7213 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7217 Perl_croak(aTHX_ "Can't bless non-reference value");
7219 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7220 if (SvREADONLY(tmpRef))
7221 Perl_croak(aTHX_ PL_no_modify);
7222 if (SvOBJECT(tmpRef)) {
7223 if (SvTYPE(tmpRef) != SVt_PVIO)
7225 SvREFCNT_dec(SvSTASH(tmpRef));
7228 SvOBJECT_on(tmpRef);
7229 if (SvTYPE(tmpRef) != SVt_PVIO)
7231 SvUPGRADE(tmpRef, SVt_PVMG);
7232 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7239 if(SvSMAGICAL(tmpRef))
7240 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7248 /* Downgrades a PVGV to a PVMG.
7252 S_sv_unglob(pTHX_ SV *sv)
7256 assert(SvTYPE(sv) == SVt_PVGV);
7261 sv_del_backref((SV*)GvSTASH(sv), sv);
7264 sv_unmagic(sv, PERL_MAGIC_glob);
7265 Safefree(GvNAME(sv));
7268 /* need to keep SvANY(sv) in the right arena */
7269 xpvmg = new_XPVMG();
7270 StructCopy(SvANY(sv), xpvmg, XPVMG);
7271 del_XPVGV(SvANY(sv));
7274 SvFLAGS(sv) &= ~SVTYPEMASK;
7275 SvFLAGS(sv) |= SVt_PVMG;
7279 =for apidoc sv_unref_flags
7281 Unsets the RV status of the SV, and decrements the reference count of
7282 whatever was being referenced by the RV. This can almost be thought of
7283 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7284 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7285 (otherwise the decrementing is conditional on the reference count being
7286 different from one or the reference being a readonly SV).
7293 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7295 SV* const target = SvRV(ref);
7297 if (SvWEAKREF(ref)) {
7298 sv_del_backref(target, ref);
7300 SvRV_set(ref, NULL);
7303 SvRV_set(ref, NULL);
7305 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7306 assigned to as BEGIN {$a = \"Foo"} will fail. */
7307 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7308 SvREFCNT_dec(target);
7309 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7310 sv_2mortal(target); /* Schedule for freeing later */
7314 =for apidoc sv_untaint
7316 Untaint an SV. Use C<SvTAINTED_off> instead.
7321 Perl_sv_untaint(pTHX_ SV *sv)
7323 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7324 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7331 =for apidoc sv_tainted
7333 Test an SV for taintedness. Use C<SvTAINTED> instead.
7338 Perl_sv_tainted(pTHX_ SV *sv)
7340 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7341 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7342 if (mg && (mg->mg_len & 1) )
7349 =for apidoc sv_setpviv
7351 Copies an integer into the given SV, also updating its string value.
7352 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7358 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7360 char buf[TYPE_CHARS(UV)];
7362 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7364 sv_setpvn(sv, ptr, ebuf - ptr);
7368 =for apidoc sv_setpviv_mg
7370 Like C<sv_setpviv>, but also handles 'set' magic.
7376 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7382 #if defined(PERL_IMPLICIT_CONTEXT)
7384 /* pTHX_ magic can't cope with varargs, so this is a no-context
7385 * version of the main function, (which may itself be aliased to us).
7386 * Don't access this version directly.
7390 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7394 va_start(args, pat);
7395 sv_vsetpvf(sv, pat, &args);
7399 /* pTHX_ magic can't cope with varargs, so this is a no-context
7400 * version of the main function, (which may itself be aliased to us).
7401 * Don't access this version directly.
7405 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7409 va_start(args, pat);
7410 sv_vsetpvf_mg(sv, pat, &args);
7416 =for apidoc sv_setpvf
7418 Works like C<sv_catpvf> but copies the text into the SV instead of
7419 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7425 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7428 va_start(args, pat);
7429 sv_vsetpvf(sv, pat, &args);
7434 =for apidoc sv_vsetpvf
7436 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7437 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7439 Usually used via its frontend C<sv_setpvf>.
7445 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7447 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7451 =for apidoc sv_setpvf_mg
7453 Like C<sv_setpvf>, but also handles 'set' magic.
7459 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7462 va_start(args, pat);
7463 sv_vsetpvf_mg(sv, pat, &args);
7468 =for apidoc sv_vsetpvf_mg
7470 Like C<sv_vsetpvf>, but also handles 'set' magic.
7472 Usually used via its frontend C<sv_setpvf_mg>.
7478 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7480 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7484 #if defined(PERL_IMPLICIT_CONTEXT)
7486 /* pTHX_ magic can't cope with varargs, so this is a no-context
7487 * version of the main function, (which may itself be aliased to us).
7488 * Don't access this version directly.
7492 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7496 va_start(args, pat);
7497 sv_vcatpvf(sv, pat, &args);
7501 /* pTHX_ magic can't cope with varargs, so this is a no-context
7502 * version of the main function, (which may itself be aliased to us).
7503 * Don't access this version directly.
7507 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7511 va_start(args, pat);
7512 sv_vcatpvf_mg(sv, pat, &args);
7518 =for apidoc sv_catpvf
7520 Processes its arguments like C<sprintf> and appends the formatted
7521 output to an SV. If the appended data contains "wide" characters
7522 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7523 and characters >255 formatted with %c), the original SV might get
7524 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7525 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7526 valid UTF-8; if the original SV was bytes, the pattern should be too.
7531 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7534 va_start(args, pat);
7535 sv_vcatpvf(sv, pat, &args);
7540 =for apidoc sv_vcatpvf
7542 Processes its arguments like C<vsprintf> and appends the formatted output
7543 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7545 Usually used via its frontend C<sv_catpvf>.
7551 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7553 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7557 =for apidoc sv_catpvf_mg
7559 Like C<sv_catpvf>, but also handles 'set' magic.
7565 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7568 va_start(args, pat);
7569 sv_vcatpvf_mg(sv, pat, &args);
7574 =for apidoc sv_vcatpvf_mg
7576 Like C<sv_vcatpvf>, but also handles 'set' magic.
7578 Usually used via its frontend C<sv_catpvf_mg>.
7584 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7586 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7591 =for apidoc sv_vsetpvfn
7593 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7596 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7602 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7604 sv_setpvn(sv, "", 0);
7605 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7608 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7611 S_expect_number(pTHX_ char** pattern)
7614 switch (**pattern) {
7615 case '1': case '2': case '3':
7616 case '4': case '5': case '6':
7617 case '7': case '8': case '9':
7618 var = *(*pattern)++ - '0';
7619 while (isDIGIT(**pattern)) {
7620 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7622 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7628 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7631 F0convert(NV nv, char *endbuf, STRLEN *len)
7633 const int neg = nv < 0;
7642 if (uv & 1 && uv == nv)
7643 uv--; /* Round to even */
7645 const unsigned dig = uv % 10;
7658 =for apidoc sv_vcatpvfn
7660 Processes its arguments like C<vsprintf> and appends the formatted output
7661 to an SV. Uses an array of SVs if the C style variable argument list is
7662 missing (NULL). When running with taint checks enabled, indicates via
7663 C<maybe_tainted> if results are untrustworthy (often due to the use of
7666 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7672 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7673 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7674 vec_utf8 = DO_UTF8(vecsv);
7676 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7679 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7686 static const char nullstr[] = "(null)";
7688 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7689 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7691 /* Times 4: a decimal digit takes more than 3 binary digits.
7692 * NV_DIG: mantissa takes than many decimal digits.
7693 * Plus 32: Playing safe. */
7694 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7695 /* large enough for "%#.#f" --chip */
7696 /* what about long double NVs? --jhi */
7698 PERL_UNUSED_ARG(maybe_tainted);
7700 /* no matter what, this is a string now */
7701 (void)SvPV_force(sv, origlen);
7703 /* special-case "", "%s", and "%-p" (SVf - see below) */
7706 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7708 const char * const s = va_arg(*args, char*);
7709 sv_catpv(sv, s ? s : nullstr);
7711 else if (svix < svmax) {
7712 sv_catsv(sv, *svargs);
7716 if (args && patlen == 3 && pat[0] == '%' &&
7717 pat[1] == '-' && pat[2] == 'p') {
7718 argsv = va_arg(*args, SV*);
7719 sv_catsv(sv, argsv);
7723 #ifndef USE_LONG_DOUBLE
7724 /* special-case "%.<number>[gf]" */
7725 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7726 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7727 unsigned digits = 0;
7731 while (*pp >= '0' && *pp <= '9')
7732 digits = 10 * digits + (*pp++ - '0');
7733 if (pp - pat == (int)patlen - 1) {
7741 /* Add check for digits != 0 because it seems that some
7742 gconverts are buggy in this case, and we don't yet have
7743 a Configure test for this. */
7744 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7745 /* 0, point, slack */
7746 Gconvert(nv, (int)digits, 0, ebuf);
7748 if (*ebuf) /* May return an empty string for digits==0 */
7751 } else if (!digits) {
7754 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7755 sv_catpvn(sv, p, l);
7761 #endif /* !USE_LONG_DOUBLE */
7763 if (!args && svix < svmax && DO_UTF8(*svargs))
7766 patend = (char*)pat + patlen;
7767 for (p = (char*)pat; p < patend; p = q) {
7770 bool vectorize = FALSE;
7771 bool vectorarg = FALSE;
7772 bool vec_utf8 = FALSE;
7778 bool has_precis = FALSE;
7781 bool is_utf8 = FALSE; /* is this item utf8? */
7782 #ifdef HAS_LDBL_SPRINTF_BUG
7783 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7784 with sfio - Allen <allens@cpan.org> */
7785 bool fix_ldbl_sprintf_bug = FALSE;
7789 U8 utf8buf[UTF8_MAXBYTES+1];
7790 STRLEN esignlen = 0;
7792 const char *eptr = Nullch;
7795 const U8 *vecstr = Null(U8*);
7802 /* we need a long double target in case HAS_LONG_DOUBLE but
7805 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7813 const char *dotstr = ".";
7814 STRLEN dotstrlen = 1;
7815 I32 efix = 0; /* explicit format parameter index */
7816 I32 ewix = 0; /* explicit width index */
7817 I32 epix = 0; /* explicit precision index */
7818 I32 evix = 0; /* explicit vector index */
7819 bool asterisk = FALSE;
7821 /* echo everything up to the next format specification */
7822 for (q = p; q < patend && *q != '%'; ++q) ;
7824 if (has_utf8 && !pat_utf8)
7825 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7827 sv_catpvn(sv, p, q - p);
7834 We allow format specification elements in this order:
7835 \d+\$ explicit format parameter index
7837 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7838 0 flag (as above): repeated to allow "v02"
7839 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7840 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7842 [%bcdefginopsuxDFOUX] format (mandatory)
7847 As of perl5.9.3, printf format checking is on by default.
7848 Internally, perl uses %p formats to provide an escape to
7849 some extended formatting. This block deals with those
7850 extensions: if it does not match, (char*)q is reset and
7851 the normal format processing code is used.
7853 Currently defined extensions are:
7854 %p include pointer address (standard)
7855 %-p (SVf) include an SV (previously %_)
7856 %-<num>p include an SV with precision <num>
7857 %1p (VDf) include a v-string (as %vd)
7858 %<num>p reserved for future extensions
7860 Robin Barker 2005-07-14
7867 EXPECT_NUMBER(q, n);
7874 argsv = va_arg(*args, SV*);
7875 eptr = SvPVx_const(argsv, elen);
7881 else if (n == vdNUMBER) { /* VDf */
7888 if (ckWARN_d(WARN_INTERNAL))
7889 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7890 "internal %%<num>p might conflict with future printf extensions");
7896 if (EXPECT_NUMBER(q, width)) {
7937 if (EXPECT_NUMBER(q, ewix))
7946 if ((vectorarg = asterisk)) {
7959 EXPECT_NUMBER(q, width);
7965 vecsv = va_arg(*args, SV*);
7967 vecsv = (evix > 0 && evix <= svmax)
7968 ? svargs[evix-1] : &PL_sv_undef;
7970 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7972 dotstr = SvPV_const(vecsv, dotstrlen);
7973 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7974 bad with tied or overloaded values that return UTF8. */
7977 else if (has_utf8) {
7978 vecsv = sv_mortalcopy(vecsv);
7979 sv_utf8_upgrade(vecsv);
7980 dotstr = SvPV_const(vecsv, dotstrlen);
7987 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
7988 vecsv = svargs[efix ? efix-1 : svix++];
7989 vecstr = (U8*)SvPV_const(vecsv,veclen);
7990 vec_utf8 = DO_UTF8(vecsv);
7992 /* if this is a version object, we need to convert
7993 * back into v-string notation and then let the
7994 * vectorize happen normally
7996 if (sv_derived_from(vecsv, "version")) {
7997 char *version = savesvpv(vecsv);
7998 vecsv = sv_newmortal();
7999 /* scan_vstring is expected to be called during
8000 * tokenization, so we need to fake up the end
8001 * of the buffer for it
8003 PL_bufend = version + veclen;
8004 scan_vstring(version, vecsv);
8005 vecstr = (U8*)SvPV_const(vecsv, veclen);
8006 vec_utf8 = DO_UTF8(vecsv);
8018 i = va_arg(*args, int);
8020 i = (ewix ? ewix <= svmax : svix < svmax) ?
8021 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8023 width = (i < 0) ? -i : i;
8033 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8035 /* XXX: todo, support specified precision parameter */
8039 i = va_arg(*args, int);
8041 i = (ewix ? ewix <= svmax : svix < svmax)
8042 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8043 precis = (i < 0) ? 0 : i;
8048 precis = precis * 10 + (*q++ - '0');
8057 case 'I': /* Ix, I32x, and I64x */
8059 if (q[1] == '6' && q[2] == '4') {
8065 if (q[1] == '3' && q[2] == '2') {
8075 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8086 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8087 if (*(q + 1) == 'l') { /* lld, llf */
8113 if (!vectorize && !args) {
8115 const I32 i = efix-1;
8116 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8118 argsv = (svix >= 0 && svix < svmax)
8119 ? svargs[svix++] : &PL_sv_undef;
8130 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8132 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8134 eptr = (char*)utf8buf;
8135 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8149 eptr = va_arg(*args, char*);
8151 #ifdef MACOS_TRADITIONAL
8152 /* On MacOS, %#s format is used for Pascal strings */
8157 elen = strlen(eptr);
8159 eptr = (char *)nullstr;
8160 elen = sizeof nullstr - 1;
8164 eptr = SvPVx_const(argsv, elen);
8165 if (DO_UTF8(argsv)) {
8166 if (has_precis && precis < elen) {
8168 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8171 if (width) { /* fudge width (can't fudge elen) */
8172 width += elen - sv_len_utf8(argsv);
8179 if (has_precis && elen > precis)
8186 if (alt || vectorize)
8188 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8209 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8218 esignbuf[esignlen++] = plus;
8222 case 'h': iv = (short)va_arg(*args, int); break;
8223 case 'l': iv = va_arg(*args, long); break;
8224 case 'V': iv = va_arg(*args, IV); break;
8225 default: iv = va_arg(*args, int); break;
8227 case 'q': iv = va_arg(*args, Quad_t); break;
8232 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8234 case 'h': iv = (short)tiv; break;
8235 case 'l': iv = (long)tiv; break;
8237 default: iv = tiv; break;
8239 case 'q': iv = (Quad_t)tiv; break;
8243 if ( !vectorize ) /* we already set uv above */
8248 esignbuf[esignlen++] = plus;
8252 esignbuf[esignlen++] = '-';
8295 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8306 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8307 case 'l': uv = va_arg(*args, unsigned long); break;
8308 case 'V': uv = va_arg(*args, UV); break;
8309 default: uv = va_arg(*args, unsigned); break;
8311 case 'q': uv = va_arg(*args, Uquad_t); break;
8316 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8318 case 'h': uv = (unsigned short)tuv; break;
8319 case 'l': uv = (unsigned long)tuv; break;
8321 default: uv = tuv; break;
8323 case 'q': uv = (Uquad_t)tuv; break;
8330 char *ptr = ebuf + sizeof ebuf;
8336 p = (char*)((c == 'X')
8337 ? "0123456789ABCDEF" : "0123456789abcdef");
8343 esignbuf[esignlen++] = '0';
8344 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8352 if (alt && *ptr != '0')
8363 esignbuf[esignlen++] = '0';
8364 esignbuf[esignlen++] = 'b';
8367 default: /* it had better be ten or less */
8371 } while (uv /= base);
8374 elen = (ebuf + sizeof ebuf) - ptr;
8378 zeros = precis - elen;
8379 else if (precis == 0 && elen == 1 && *eptr == '0')
8385 /* FLOATING POINT */
8388 c = 'f'; /* maybe %F isn't supported here */
8396 /* This is evil, but floating point is even more evil */
8398 /* for SV-style calling, we can only get NV
8399 for C-style calling, we assume %f is double;
8400 for simplicity we allow any of %Lf, %llf, %qf for long double
8404 #if defined(USE_LONG_DOUBLE)
8408 /* [perl #20339] - we should accept and ignore %lf rather than die */
8412 #if defined(USE_LONG_DOUBLE)
8413 intsize = args ? 0 : 'q';
8417 #if defined(HAS_LONG_DOUBLE)
8426 /* now we need (long double) if intsize == 'q', else (double) */
8428 #if LONG_DOUBLESIZE > DOUBLESIZE
8430 va_arg(*args, long double) :
8431 va_arg(*args, double)
8433 va_arg(*args, double)
8438 if (c != 'e' && c != 'E') {
8440 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8441 will cast our (long double) to (double) */
8442 (void)Perl_frexp(nv, &i);
8443 if (i == PERL_INT_MIN)
8444 Perl_die(aTHX_ "panic: frexp");
8446 need = BIT_DIGITS(i);
8448 need += has_precis ? precis : 6; /* known default */
8453 #ifdef HAS_LDBL_SPRINTF_BUG
8454 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8455 with sfio - Allen <allens@cpan.org> */
8458 # define MY_DBL_MAX DBL_MAX
8459 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8460 # if DOUBLESIZE >= 8
8461 # define MY_DBL_MAX 1.7976931348623157E+308L
8463 # define MY_DBL_MAX 3.40282347E+38L
8467 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8468 # define MY_DBL_MAX_BUG 1L
8470 # define MY_DBL_MAX_BUG MY_DBL_MAX
8474 # define MY_DBL_MIN DBL_MIN
8475 # else /* XXX guessing! -Allen */
8476 # if DOUBLESIZE >= 8
8477 # define MY_DBL_MIN 2.2250738585072014E-308L
8479 # define MY_DBL_MIN 1.17549435E-38L
8483 if ((intsize == 'q') && (c == 'f') &&
8484 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8486 /* it's going to be short enough that
8487 * long double precision is not needed */
8489 if ((nv <= 0L) && (nv >= -0L))
8490 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8492 /* would use Perl_fp_class as a double-check but not
8493 * functional on IRIX - see perl.h comments */
8495 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8496 /* It's within the range that a double can represent */
8497 #if defined(DBL_MAX) && !defined(DBL_MIN)
8498 if ((nv >= ((long double)1/DBL_MAX)) ||
8499 (nv <= (-(long double)1/DBL_MAX)))
8501 fix_ldbl_sprintf_bug = TRUE;
8504 if (fix_ldbl_sprintf_bug == TRUE) {
8514 # undef MY_DBL_MAX_BUG
8517 #endif /* HAS_LDBL_SPRINTF_BUG */
8519 need += 20; /* fudge factor */
8520 if (PL_efloatsize < need) {
8521 Safefree(PL_efloatbuf);
8522 PL_efloatsize = need + 20; /* more fudge */
8523 Newx(PL_efloatbuf, PL_efloatsize, char);
8524 PL_efloatbuf[0] = '\0';
8527 if ( !(width || left || plus || alt) && fill != '0'
8528 && has_precis && intsize != 'q' ) { /* Shortcuts */
8529 /* See earlier comment about buggy Gconvert when digits,
8531 if ( c == 'g' && precis) {
8532 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8533 /* May return an empty string for digits==0 */
8534 if (*PL_efloatbuf) {
8535 elen = strlen(PL_efloatbuf);
8536 goto float_converted;
8538 } else if ( c == 'f' && !precis) {
8539 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8544 char *ptr = ebuf + sizeof ebuf;
8547 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8548 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8549 if (intsize == 'q') {
8550 /* Copy the one or more characters in a long double
8551 * format before the 'base' ([efgEFG]) character to
8552 * the format string. */
8553 static char const prifldbl[] = PERL_PRIfldbl;
8554 char const *p = prifldbl + sizeof(prifldbl) - 3;
8555 while (p >= prifldbl) { *--ptr = *p--; }
8560 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8565 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8577 /* No taint. Otherwise we are in the strange situation
8578 * where printf() taints but print($float) doesn't.
8580 #if defined(HAS_LONG_DOUBLE)
8581 elen = ((intsize == 'q')
8582 ? my_sprintf(PL_efloatbuf, ptr, nv)
8583 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8585 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8589 eptr = PL_efloatbuf;
8597 i = SvCUR(sv) - origlen;
8600 case 'h': *(va_arg(*args, short*)) = i; break;
8601 default: *(va_arg(*args, int*)) = i; break;
8602 case 'l': *(va_arg(*args, long*)) = i; break;
8603 case 'V': *(va_arg(*args, IV*)) = i; break;
8605 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8610 sv_setuv_mg(argsv, (UV)i);
8611 continue; /* not "break" */
8618 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8619 && ckWARN(WARN_PRINTF))
8621 SV * const msg = sv_newmortal();
8622 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8623 (PL_op->op_type == OP_PRTF) ? "" : "s");
8626 Perl_sv_catpvf(aTHX_ msg,
8627 "\"%%%c\"", c & 0xFF);
8629 Perl_sv_catpvf(aTHX_ msg,
8630 "\"%%\\%03"UVof"\"",
8633 sv_catpv(msg, "end of string");
8634 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8637 /* output mangled stuff ... */
8643 /* ... right here, because formatting flags should not apply */
8644 SvGROW(sv, SvCUR(sv) + elen + 1);
8646 Copy(eptr, p, elen, char);
8649 SvCUR_set(sv, p - SvPVX_const(sv));
8651 continue; /* not "break" */
8654 /* calculate width before utf8_upgrade changes it */
8655 have = esignlen + zeros + elen;
8657 Perl_croak_nocontext(PL_memory_wrap);
8659 if (is_utf8 != has_utf8) {
8662 sv_utf8_upgrade(sv);
8665 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8666 sv_utf8_upgrade(nsv);
8667 eptr = SvPVX_const(nsv);
8670 SvGROW(sv, SvCUR(sv) + elen + 1);
8675 need = (have > width ? have : width);
8678 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8679 Perl_croak_nocontext(PL_memory_wrap);
8680 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8682 if (esignlen && fill == '0') {
8684 for (i = 0; i < (int)esignlen; i++)
8688 memset(p, fill, gap);
8691 if (esignlen && fill != '0') {
8693 for (i = 0; i < (int)esignlen; i++)
8698 for (i = zeros; i; i--)
8702 Copy(eptr, p, elen, char);
8706 memset(p, ' ', gap);
8711 Copy(dotstr, p, dotstrlen, char);
8715 vectorize = FALSE; /* done iterating over vecstr */
8722 SvCUR_set(sv, p - SvPVX_const(sv));
8730 /* =========================================================================
8732 =head1 Cloning an interpreter
8734 All the macros and functions in this section are for the private use of
8735 the main function, perl_clone().
8737 The foo_dup() functions make an exact copy of an existing foo thinngy.
8738 During the course of a cloning, a hash table is used to map old addresses
8739 to new addresses. The table is created and manipulated with the
8740 ptr_table_* functions.
8744 ============================================================================*/
8747 #if defined(USE_ITHREADS)
8749 #ifndef GpREFCNT_inc
8750 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8754 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8755 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8756 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8757 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8758 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8759 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8760 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8761 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8762 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8763 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8764 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8765 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8766 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8769 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8770 regcomp.c. AMS 20010712 */
8773 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8778 struct reg_substr_datum *s;
8781 return (REGEXP *)NULL;
8783 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8786 len = r->offsets[0];
8787 npar = r->nparens+1;
8789 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8790 Copy(r->program, ret->program, len+1, regnode);
8792 Newx(ret->startp, npar, I32);
8793 Copy(r->startp, ret->startp, npar, I32);
8794 Newx(ret->endp, npar, I32);
8795 Copy(r->startp, ret->startp, npar, I32);
8797 Newx(ret->substrs, 1, struct reg_substr_data);
8798 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8799 s->min_offset = r->substrs->data[i].min_offset;
8800 s->max_offset = r->substrs->data[i].max_offset;
8801 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8802 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8805 ret->regstclass = NULL;
8808 const int count = r->data->count;
8811 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8812 char, struct reg_data);
8813 Newx(d->what, count, U8);
8816 for (i = 0; i < count; i++) {
8817 d->what[i] = r->data->what[i];
8818 switch (d->what[i]) {
8819 /* legal options are one of: sfpont
8820 see also regcomp.h and pregfree() */
8822 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8825 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8828 /* This is cheating. */
8829 Newx(d->data[i], 1, struct regnode_charclass_class);
8830 StructCopy(r->data->data[i], d->data[i],
8831 struct regnode_charclass_class);
8832 ret->regstclass = (regnode*)d->data[i];
8835 /* Compiled op trees are readonly, and can thus be
8836 shared without duplication. */
8838 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8842 d->data[i] = r->data->data[i];
8845 d->data[i] = r->data->data[i];
8847 ((reg_trie_data*)d->data[i])->refcount++;
8851 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8860 Newx(ret->offsets, 2*len+1, U32);
8861 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8863 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8864 ret->refcnt = r->refcnt;
8865 ret->minlen = r->minlen;
8866 ret->prelen = r->prelen;
8867 ret->nparens = r->nparens;
8868 ret->lastparen = r->lastparen;
8869 ret->lastcloseparen = r->lastcloseparen;
8870 ret->reganch = r->reganch;
8872 ret->sublen = r->sublen;
8874 if (RX_MATCH_COPIED(ret))
8875 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8877 ret->subbeg = Nullch;
8878 #ifdef PERL_OLD_COPY_ON_WRITE
8879 ret->saved_copy = Nullsv;
8882 ptr_table_store(PL_ptr_table, r, ret);
8886 /* duplicate a file handle */
8889 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8893 PERL_UNUSED_ARG(type);
8896 return (PerlIO*)NULL;
8898 /* look for it in the table first */
8899 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8903 /* create anew and remember what it is */
8904 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8905 ptr_table_store(PL_ptr_table, fp, ret);
8909 /* duplicate a directory handle */
8912 Perl_dirp_dup(pTHX_ DIR *dp)
8920 /* duplicate a typeglob */
8923 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8928 /* look for it in the table first */
8929 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8933 /* create anew and remember what it is */
8935 ptr_table_store(PL_ptr_table, gp, ret);
8938 ret->gp_refcnt = 0; /* must be before any other dups! */
8939 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8940 ret->gp_io = io_dup_inc(gp->gp_io, param);
8941 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8942 ret->gp_av = av_dup_inc(gp->gp_av, param);
8943 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8944 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8945 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8946 ret->gp_cvgen = gp->gp_cvgen;
8947 ret->gp_line = gp->gp_line;
8948 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8952 /* duplicate a chain of magic */
8955 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8957 MAGIC *mgprev = (MAGIC*)NULL;
8960 return (MAGIC*)NULL;
8961 /* look for it in the table first */
8962 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8966 for (; mg; mg = mg->mg_moremagic) {
8968 Newxz(nmg, 1, MAGIC);
8970 mgprev->mg_moremagic = nmg;
8973 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8974 nmg->mg_private = mg->mg_private;
8975 nmg->mg_type = mg->mg_type;
8976 nmg->mg_flags = mg->mg_flags;
8977 if (mg->mg_type == PERL_MAGIC_qr) {
8978 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8980 else if(mg->mg_type == PERL_MAGIC_backref) {
8981 const AV * const av = (AV*) mg->mg_obj;
8984 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8986 for (i = AvFILLp(av); i >= 0; i--) {
8987 if (!svp[i]) continue;
8988 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8991 else if (mg->mg_type == PERL_MAGIC_symtab) {
8992 nmg->mg_obj = mg->mg_obj;
8995 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8996 ? sv_dup_inc(mg->mg_obj, param)
8997 : sv_dup(mg->mg_obj, param);
8999 nmg->mg_len = mg->mg_len;
9000 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9001 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9002 if (mg->mg_len > 0) {
9003 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9004 if (mg->mg_type == PERL_MAGIC_overload_table &&
9005 AMT_AMAGIC((AMT*)mg->mg_ptr))
9007 AMT * const amtp = (AMT*)mg->mg_ptr;
9008 AMT * const namtp = (AMT*)nmg->mg_ptr;
9010 for (i = 1; i < NofAMmeth; i++) {
9011 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9015 else if (mg->mg_len == HEf_SVKEY)
9016 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9018 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9019 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9026 /* create a new pointer-mapping table */
9029 Perl_ptr_table_new(pTHX)
9032 Newxz(tbl, 1, PTR_TBL_t);
9035 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9039 #define PTR_TABLE_HASH(ptr) \
9040 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9043 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9044 following define) and at call to new_body_inline made below in
9045 Perl_ptr_table_store()
9048 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9050 /* map an existing pointer using a table */
9052 STATIC PTR_TBL_ENT_t *
9053 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9054 PTR_TBL_ENT_t *tblent;
9055 const UV hash = PTR_TABLE_HASH(sv);
9057 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9058 for (; tblent; tblent = tblent->next) {
9059 if (tblent->oldval == sv)
9066 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9068 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9069 return tblent ? tblent->newval : (void *) 0;
9072 /* add a new entry to a pointer-mapping table */
9075 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9077 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9080 tblent->newval = newsv;
9082 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9084 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9085 tblent->oldval = oldsv;
9086 tblent->newval = newsv;
9087 tblent->next = tbl->tbl_ary[entry];
9088 tbl->tbl_ary[entry] = tblent;
9090 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9091 ptr_table_split(tbl);
9095 /* double the hash bucket size of an existing ptr table */
9098 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9100 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9101 const UV oldsize = tbl->tbl_max + 1;
9102 UV newsize = oldsize * 2;
9105 Renew(ary, newsize, PTR_TBL_ENT_t*);
9106 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9107 tbl->tbl_max = --newsize;
9109 for (i=0; i < oldsize; i++, ary++) {
9110 PTR_TBL_ENT_t **curentp, **entp, *ent;
9113 curentp = ary + oldsize;
9114 for (entp = ary, ent = *ary; ent; ent = *entp) {
9115 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9117 ent->next = *curentp;
9127 /* remove all the entries from a ptr table */
9130 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9132 if (tbl && tbl->tbl_items) {
9133 register PTR_TBL_ENT_t **array = tbl->tbl_ary;
9134 UV riter = tbl->tbl_max;
9137 PTR_TBL_ENT_t *entry = array[riter];
9140 PTR_TBL_ENT_t * const oentry = entry;
9141 entry = entry->next;
9150 /* clear and free a ptr table */
9153 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9158 ptr_table_clear(tbl);
9159 Safefree(tbl->tbl_ary);
9165 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9168 SvRV_set(dstr, SvWEAKREF(sstr)
9169 ? sv_dup(SvRV(sstr), param)
9170 : sv_dup_inc(SvRV(sstr), param));
9173 else if (SvPVX_const(sstr)) {
9174 /* Has something there */
9176 /* Normal PV - clone whole allocated space */
9177 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9178 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9179 /* Not that normal - actually sstr is copy on write.
9180 But we are a true, independant SV, so: */
9181 SvREADONLY_off(dstr);
9186 /* Special case - not normally malloced for some reason */
9187 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9188 /* A "shared" PV - clone it as "shared" PV */
9190 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9194 /* Some other special case - random pointer */
9195 SvPV_set(dstr, SvPVX(sstr));
9201 if (SvTYPE(dstr) == SVt_RV)
9202 SvRV_set(dstr, NULL);
9208 /* duplicate an SV of any type (including AV, HV etc) */
9211 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9216 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9218 /* look for it in the table first */
9219 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9223 if(param->flags & CLONEf_JOIN_IN) {
9224 /** We are joining here so we don't want do clone
9225 something that is bad **/
9228 if(SvTYPE(sstr) == SVt_PVHV &&
9229 (hvname = HvNAME_get(sstr))) {
9230 /** don't clone stashes if they already exist **/
9231 return (SV*)gv_stashpv(hvname,0);
9235 /* create anew and remember what it is */
9238 #ifdef DEBUG_LEAKING_SCALARS
9239 dstr->sv_debug_optype = sstr->sv_debug_optype;
9240 dstr->sv_debug_line = sstr->sv_debug_line;
9241 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9242 dstr->sv_debug_cloned = 1;
9244 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9246 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9250 ptr_table_store(PL_ptr_table, sstr, dstr);
9253 SvFLAGS(dstr) = SvFLAGS(sstr);
9254 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9255 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9258 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9259 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9260 PL_watch_pvx, SvPVX_const(sstr));
9263 /* don't clone objects whose class has asked us not to */
9264 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9265 SvFLAGS(dstr) &= ~SVTYPEMASK;
9270 switch (SvTYPE(sstr)) {
9275 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9276 SvIV_set(dstr, SvIVX(sstr));
9279 SvANY(dstr) = new_XNV();
9280 SvNV_set(dstr, SvNVX(sstr));
9283 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9284 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9288 /* These are all the types that need complex bodies allocating. */
9290 const svtype sv_type = SvTYPE(sstr);
9291 const struct body_details *const sv_type_details
9292 = bodies_by_type + sv_type;
9296 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9301 if (GvUNIQUE((GV*)sstr)) {
9302 /* Do sharing here, and fall through */
9315 assert(sv_type_details->size);
9316 if (sv_type_details->arena) {
9317 new_body_inline(new_body, sv_type_details->size, sv_type);
9319 = (void*)((char*)new_body - sv_type_details->offset);
9321 new_body = new_NOARENA(sv_type_details);
9325 SvANY(dstr) = new_body;
9328 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9329 ((char*)SvANY(dstr)) + sv_type_details->offset,
9330 sv_type_details->copy, char);
9332 Copy(((char*)SvANY(sstr)),
9333 ((char*)SvANY(dstr)),
9334 sv_type_details->size + sv_type_details->offset, char);
9337 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9338 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9340 /* The Copy above means that all the source (unduplicated) pointers
9341 are now in the destination. We can check the flags and the
9342 pointers in either, but it's possible that there's less cache
9343 missing by always going for the destination.
9344 FIXME - instrument and check that assumption */
9345 if (sv_type >= SVt_PVMG) {
9347 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9349 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9352 /* The cast silences a GCC warning about unhandled types. */
9353 switch ((int)sv_type) {
9365 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9366 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9367 LvTARG(dstr) = dstr;
9368 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9369 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9371 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9374 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9375 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9376 /* Don't call sv_add_backref here as it's going to be created
9377 as part of the magic cloning of the symbol table. */
9378 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9379 (void)GpREFCNT_inc(GvGP(dstr));
9382 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9383 if (IoOFP(dstr) == IoIFP(sstr))
9384 IoOFP(dstr) = IoIFP(dstr);
9386 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9387 /* PL_rsfp_filters entries have fake IoDIRP() */
9388 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9389 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9390 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9391 /* I have no idea why fake dirp (rsfps)
9392 should be treated differently but otherwise
9393 we end up with leaks -- sky*/
9394 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9395 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9396 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9398 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9399 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9400 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9402 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9403 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9404 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9407 if (AvARRAY((AV*)sstr)) {
9408 SV **dst_ary, **src_ary;
9409 SSize_t items = AvFILLp((AV*)sstr) + 1;
9411 src_ary = AvARRAY((AV*)sstr);
9412 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9413 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9414 SvPV_set(dstr, (char*)dst_ary);
9415 AvALLOC((AV*)dstr) = dst_ary;
9416 if (AvREAL((AV*)sstr)) {
9418 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9422 *dst_ary++ = sv_dup(*src_ary++, param);
9424 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9425 while (items-- > 0) {
9426 *dst_ary++ = &PL_sv_undef;
9430 SvPV_set(dstr, Nullch);
9431 AvALLOC((AV*)dstr) = (SV**)NULL;
9438 if (HvARRAY((HV*)sstr)) {
9440 const bool sharekeys = !!HvSHAREKEYS(sstr);
9441 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9442 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9444 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9445 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9447 HvARRAY(dstr) = (HE**)darray;
9448 while (i <= sxhv->xhv_max) {
9449 const HE *source = HvARRAY(sstr)[i];
9450 HvARRAY(dstr)[i] = source
9451 ? he_dup(source, sharekeys, param) : 0;
9455 struct xpvhv_aux * const saux = HvAUX(sstr);
9456 struct xpvhv_aux * const daux = HvAUX(dstr);
9457 /* This flag isn't copied. */
9458 /* SvOOK_on(hv) attacks the IV flags. */
9459 SvFLAGS(dstr) |= SVf_OOK;
9461 hvname = saux->xhv_name;
9463 = hvname ? hek_dup(hvname, param) : hvname;
9465 daux->xhv_riter = saux->xhv_riter;
9466 daux->xhv_eiter = saux->xhv_eiter
9467 ? he_dup(saux->xhv_eiter,
9468 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9472 SvPV_set(dstr, Nullch);
9474 /* Record stashes for possible cloning in Perl_clone(). */
9476 av_push(param->stashes, dstr);
9481 /* NOTE: not refcounted */
9482 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9484 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9486 if (CvCONST(dstr)) {
9487 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9488 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9489 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9491 /* don't dup if copying back - CvGV isn't refcounted, so the
9492 * duped GV may never be freed. A bit of a hack! DAPM */
9493 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9494 Nullgv : gv_dup(CvGV(dstr), param) ;
9495 if (!(param->flags & CLONEf_COPY_STACKS)) {
9498 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9501 ? cv_dup( CvOUTSIDE(dstr), param)
9502 : cv_dup_inc(CvOUTSIDE(dstr), param);
9504 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9510 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9516 /* duplicate a context */
9519 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9524 return (PERL_CONTEXT*)NULL;
9526 /* look for it in the table first */
9527 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9531 /* create anew and remember what it is */
9532 Newxz(ncxs, max + 1, PERL_CONTEXT);
9533 ptr_table_store(PL_ptr_table, cxs, ncxs);
9536 PERL_CONTEXT *cx = &cxs[ix];
9537 PERL_CONTEXT *ncx = &ncxs[ix];
9538 ncx->cx_type = cx->cx_type;
9539 if (CxTYPE(cx) == CXt_SUBST) {
9540 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9543 ncx->blk_oldsp = cx->blk_oldsp;
9544 ncx->blk_oldcop = cx->blk_oldcop;
9545 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9546 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9547 ncx->blk_oldpm = cx->blk_oldpm;
9548 ncx->blk_gimme = cx->blk_gimme;
9549 switch (CxTYPE(cx)) {
9551 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9552 ? cv_dup_inc(cx->blk_sub.cv, param)
9553 : cv_dup(cx->blk_sub.cv,param));
9554 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9555 ? av_dup_inc(cx->blk_sub.argarray, param)
9557 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9558 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9559 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9560 ncx->blk_sub.lval = cx->blk_sub.lval;
9561 ncx->blk_sub.retop = cx->blk_sub.retop;
9564 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9565 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9566 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9567 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9568 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9569 ncx->blk_eval.retop = cx->blk_eval.retop;
9572 ncx->blk_loop.label = cx->blk_loop.label;
9573 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9574 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9575 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9576 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9577 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9578 ? cx->blk_loop.iterdata
9579 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9580 ncx->blk_loop.oldcomppad
9581 = (PAD*)ptr_table_fetch(PL_ptr_table,
9582 cx->blk_loop.oldcomppad);
9583 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9584 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9585 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9586 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9587 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9590 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9591 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9592 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9593 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9594 ncx->blk_sub.retop = cx->blk_sub.retop;
9606 /* duplicate a stack info structure */
9609 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9614 return (PERL_SI*)NULL;
9616 /* look for it in the table first */
9617 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9621 /* create anew and remember what it is */
9622 Newxz(nsi, 1, PERL_SI);
9623 ptr_table_store(PL_ptr_table, si, nsi);
9625 nsi->si_stack = av_dup_inc(si->si_stack, param);
9626 nsi->si_cxix = si->si_cxix;
9627 nsi->si_cxmax = si->si_cxmax;
9628 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9629 nsi->si_type = si->si_type;
9630 nsi->si_prev = si_dup(si->si_prev, param);
9631 nsi->si_next = si_dup(si->si_next, param);
9632 nsi->si_markoff = si->si_markoff;
9637 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9638 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9639 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9640 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9641 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9642 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9643 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9644 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9645 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9646 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9647 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9648 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9649 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9650 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9653 #define pv_dup_inc(p) SAVEPV(p)
9654 #define pv_dup(p) SAVEPV(p)
9655 #define svp_dup_inc(p,pp) any_dup(p,pp)
9657 /* map any object to the new equivent - either something in the
9658 * ptr table, or something in the interpreter structure
9662 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9669 /* look for it in the table first */
9670 ret = ptr_table_fetch(PL_ptr_table, v);
9674 /* see if it is part of the interpreter structure */
9675 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9676 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9684 /* duplicate the save stack */
9687 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9689 ANY * const ss = proto_perl->Tsavestack;
9690 const I32 max = proto_perl->Tsavestack_max;
9691 I32 ix = proto_perl->Tsavestack_ix;
9703 void (*dptr) (void*);
9704 void (*dxptr) (pTHX_ void*);
9706 Newxz(nss, max, ANY);
9709 I32 i = POPINT(ss,ix);
9712 case SAVEt_ITEM: /* normal string */
9713 sv = (SV*)POPPTR(ss,ix);
9714 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9715 sv = (SV*)POPPTR(ss,ix);
9716 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9718 case SAVEt_SV: /* scalar reference */
9719 sv = (SV*)POPPTR(ss,ix);
9720 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9721 gv = (GV*)POPPTR(ss,ix);
9722 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9724 case SAVEt_GENERIC_PVREF: /* generic char* */
9725 c = (char*)POPPTR(ss,ix);
9726 TOPPTR(nss,ix) = pv_dup(c);
9727 ptr = POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9730 case SAVEt_SHARED_PVREF: /* char* in shared space */
9731 c = (char*)POPPTR(ss,ix);
9732 TOPPTR(nss,ix) = savesharedpv(c);
9733 ptr = POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9736 case SAVEt_GENERIC_SVREF: /* generic sv */
9737 case SAVEt_SVREF: /* scalar reference */
9738 sv = (SV*)POPPTR(ss,ix);
9739 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9740 ptr = POPPTR(ss,ix);
9741 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9743 case SAVEt_AV: /* array reference */
9744 av = (AV*)POPPTR(ss,ix);
9745 TOPPTR(nss,ix) = av_dup_inc(av, param);
9746 gv = (GV*)POPPTR(ss,ix);
9747 TOPPTR(nss,ix) = gv_dup(gv, param);
9749 case SAVEt_HV: /* hash reference */
9750 hv = (HV*)POPPTR(ss,ix);
9751 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9752 gv = (GV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = gv_dup(gv, param);
9755 case SAVEt_INT: /* int reference */
9756 ptr = POPPTR(ss,ix);
9757 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9758 intval = (int)POPINT(ss,ix);
9759 TOPINT(nss,ix) = intval;
9761 case SAVEt_LONG: /* long reference */
9762 ptr = POPPTR(ss,ix);
9763 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9764 longval = (long)POPLONG(ss,ix);
9765 TOPLONG(nss,ix) = longval;
9767 case SAVEt_I32: /* I32 reference */
9768 case SAVEt_I16: /* I16 reference */
9769 case SAVEt_I8: /* I8 reference */
9770 ptr = POPPTR(ss,ix);
9771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9775 case SAVEt_IV: /* IV reference */
9776 ptr = POPPTR(ss,ix);
9777 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9781 case SAVEt_SPTR: /* SV* reference */
9782 ptr = POPPTR(ss,ix);
9783 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9784 sv = (SV*)POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = sv_dup(sv, param);
9787 case SAVEt_VPTR: /* random* reference */
9788 ptr = POPPTR(ss,ix);
9789 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9793 case SAVEt_PPTR: /* char* reference */
9794 ptr = POPPTR(ss,ix);
9795 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9796 c = (char*)POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = pv_dup(c);
9799 case SAVEt_HPTR: /* HV* reference */
9800 ptr = POPPTR(ss,ix);
9801 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9802 hv = (HV*)POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = hv_dup(hv, param);
9805 case SAVEt_APTR: /* AV* reference */
9806 ptr = POPPTR(ss,ix);
9807 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9808 av = (AV*)POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = av_dup(av, param);
9812 gv = (GV*)POPPTR(ss,ix);
9813 TOPPTR(nss,ix) = gv_dup(gv, param);
9815 case SAVEt_GP: /* scalar reference */
9816 gp = (GP*)POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9818 (void)GpREFCNT_inc(gp);
9819 gv = (GV*)POPPTR(ss,ix);
9820 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9821 c = (char*)POPPTR(ss,ix);
9822 TOPPTR(nss,ix) = pv_dup(c);
9829 case SAVEt_MORTALIZESV:
9830 sv = (SV*)POPPTR(ss,ix);
9831 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9834 ptr = POPPTR(ss,ix);
9835 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9836 /* these are assumed to be refcounted properly */
9838 switch (((OP*)ptr)->op_type) {
9845 TOPPTR(nss,ix) = ptr;
9850 TOPPTR(nss,ix) = Nullop;
9855 TOPPTR(nss,ix) = Nullop;
9858 c = (char*)POPPTR(ss,ix);
9859 TOPPTR(nss,ix) = pv_dup_inc(c);
9862 longval = POPLONG(ss,ix);
9863 TOPLONG(nss,ix) = longval;
9866 hv = (HV*)POPPTR(ss,ix);
9867 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9868 c = (char*)POPPTR(ss,ix);
9869 TOPPTR(nss,ix) = pv_dup_inc(c);
9873 case SAVEt_DESTRUCTOR:
9874 ptr = POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9876 dptr = POPDPTR(ss,ix);
9877 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9878 any_dup(FPTR2DPTR(void *, dptr),
9881 case SAVEt_DESTRUCTOR_X:
9882 ptr = POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9884 dxptr = POPDXPTR(ss,ix);
9885 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9886 any_dup(FPTR2DPTR(void *, dxptr),
9889 case SAVEt_REGCONTEXT:
9895 case SAVEt_STACK_POS: /* Position on Perl stack */
9899 case SAVEt_AELEM: /* array element */
9900 sv = (SV*)POPPTR(ss,ix);
9901 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9904 av = (AV*)POPPTR(ss,ix);
9905 TOPPTR(nss,ix) = av_dup_inc(av, param);
9907 case SAVEt_HELEM: /* hash element */
9908 sv = (SV*)POPPTR(ss,ix);
9909 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9910 sv = (SV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 hv = (HV*)POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9916 ptr = POPPTR(ss,ix);
9917 TOPPTR(nss,ix) = ptr;
9924 av = (AV*)POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = av_dup(av, param);
9928 longval = (long)POPLONG(ss,ix);
9929 TOPLONG(nss,ix) = longval;
9930 ptr = POPPTR(ss,ix);
9931 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9932 sv = (SV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = sv_dup(sv, param);
9936 ptr = POPPTR(ss,ix);
9937 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9938 longval = (long)POPBOOL(ss,ix);
9939 TOPBOOL(nss,ix) = (bool)longval;
9941 case SAVEt_SET_SVFLAGS:
9946 sv = (SV*)POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = sv_dup(sv, param);
9950 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9958 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9959 * flag to the result. This is done for each stash before cloning starts,
9960 * so we know which stashes want their objects cloned */
9963 do_mark_cloneable_stash(pTHX_ SV *sv)
9965 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9967 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9968 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9969 if (cloner && GvCV(cloner)) {
9976 XPUSHs(sv_2mortal(newSVhek(hvname)));
9978 call_sv((SV*)GvCV(cloner), G_SCALAR);
9985 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
9993 =for apidoc perl_clone
9995 Create and return a new interpreter by cloning the current one.
9997 perl_clone takes these flags as parameters:
9999 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10000 without it we only clone the data and zero the stacks,
10001 with it we copy the stacks and the new perl interpreter is
10002 ready to run at the exact same point as the previous one.
10003 The pseudo-fork code uses COPY_STACKS while the
10004 threads->new doesn't.
10006 CLONEf_KEEP_PTR_TABLE
10007 perl_clone keeps a ptr_table with the pointer of the old
10008 variable as a key and the new variable as a value,
10009 this allows it to check if something has been cloned and not
10010 clone it again but rather just use the value and increase the
10011 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10012 the ptr_table using the function
10013 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10014 reason to keep it around is if you want to dup some of your own
10015 variable who are outside the graph perl scans, example of this
10016 code is in threads.xs create
10019 This is a win32 thing, it is ignored on unix, it tells perls
10020 win32host code (which is c++) to clone itself, this is needed on
10021 win32 if you want to run two threads at the same time,
10022 if you just want to do some stuff in a separate perl interpreter
10023 and then throw it away and return to the original one,
10024 you don't need to do anything.
10029 /* XXX the above needs expanding by someone who actually understands it ! */
10030 EXTERN_C PerlInterpreter *
10031 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10034 perl_clone(PerlInterpreter *proto_perl, UV flags)
10037 #ifdef PERL_IMPLICIT_SYS
10039 /* perlhost.h so we need to call into it
10040 to clone the host, CPerlHost should have a c interface, sky */
10042 if (flags & CLONEf_CLONE_HOST) {
10043 return perl_clone_host(proto_perl,flags);
10045 return perl_clone_using(proto_perl, flags,
10047 proto_perl->IMemShared,
10048 proto_perl->IMemParse,
10050 proto_perl->IStdIO,
10054 proto_perl->IProc);
10058 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10059 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10060 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10061 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10062 struct IPerlDir* ipD, struct IPerlSock* ipS,
10063 struct IPerlProc* ipP)
10065 /* XXX many of the string copies here can be optimized if they're
10066 * constants; they need to be allocated as common memory and just
10067 * their pointers copied. */
10070 CLONE_PARAMS clone_params;
10071 CLONE_PARAMS* param = &clone_params;
10073 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10074 /* for each stash, determine whether its objects should be cloned */
10075 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10076 PERL_SET_THX(my_perl);
10079 Poison(my_perl, 1, PerlInterpreter);
10081 PL_curcop = (COP *)Nullop;
10085 PL_savestack_ix = 0;
10086 PL_savestack_max = -1;
10087 PL_sig_pending = 0;
10088 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10089 # else /* !DEBUGGING */
10090 Zero(my_perl, 1, PerlInterpreter);
10091 # endif /* DEBUGGING */
10093 /* host pointers */
10095 PL_MemShared = ipMS;
10096 PL_MemParse = ipMP;
10103 #else /* !PERL_IMPLICIT_SYS */
10105 CLONE_PARAMS clone_params;
10106 CLONE_PARAMS* param = &clone_params;
10107 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10108 /* for each stash, determine whether its objects should be cloned */
10109 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10110 PERL_SET_THX(my_perl);
10113 Poison(my_perl, 1, PerlInterpreter);
10115 PL_curcop = (COP *)Nullop;
10119 PL_savestack_ix = 0;
10120 PL_savestack_max = -1;
10121 PL_sig_pending = 0;
10122 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10123 # else /* !DEBUGGING */
10124 Zero(my_perl, 1, PerlInterpreter);
10125 # endif /* DEBUGGING */
10126 #endif /* PERL_IMPLICIT_SYS */
10127 param->flags = flags;
10128 param->proto_perl = proto_perl;
10130 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10131 Zero(&PL_body_roots, 1, PL_body_roots);
10133 PL_nice_chunk = NULL;
10134 PL_nice_chunk_size = 0;
10136 PL_sv_objcount = 0;
10137 PL_sv_root = Nullsv;
10138 PL_sv_arenaroot = Nullsv;
10140 PL_debug = proto_perl->Idebug;
10142 PL_hash_seed = proto_perl->Ihash_seed;
10143 PL_rehash_seed = proto_perl->Irehash_seed;
10145 #ifdef USE_REENTRANT_API
10146 /* XXX: things like -Dm will segfault here in perlio, but doing
10147 * PERL_SET_CONTEXT(proto_perl);
10148 * breaks too many other things
10150 Perl_reentrant_init(aTHX);
10153 /* create SV map for pointer relocation */
10154 PL_ptr_table = ptr_table_new();
10156 /* initialize these special pointers as early as possible */
10157 SvANY(&PL_sv_undef) = NULL;
10158 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10159 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10160 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10162 SvANY(&PL_sv_no) = new_XPVNV();
10163 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10164 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10165 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10166 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10167 SvCUR_set(&PL_sv_no, 0);
10168 SvLEN_set(&PL_sv_no, 1);
10169 SvIV_set(&PL_sv_no, 0);
10170 SvNV_set(&PL_sv_no, 0);
10171 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10173 SvANY(&PL_sv_yes) = new_XPVNV();
10174 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10175 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10176 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10177 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10178 SvCUR_set(&PL_sv_yes, 1);
10179 SvLEN_set(&PL_sv_yes, 2);
10180 SvIV_set(&PL_sv_yes, 1);
10181 SvNV_set(&PL_sv_yes, 1);
10182 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10184 /* create (a non-shared!) shared string table */
10185 PL_strtab = newHV();
10186 HvSHAREKEYS_off(PL_strtab);
10187 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10188 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10190 PL_compiling = proto_perl->Icompiling;
10192 /* These two PVs will be free'd special way so must set them same way op.c does */
10193 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10194 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10196 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10197 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10199 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10200 if (!specialWARN(PL_compiling.cop_warnings))
10201 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10202 if (!specialCopIO(PL_compiling.cop_io))
10203 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10204 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10206 /* pseudo environmental stuff */
10207 PL_origargc = proto_perl->Iorigargc;
10208 PL_origargv = proto_perl->Iorigargv;
10210 param->stashes = newAV(); /* Setup array of objects to call clone on */
10212 /* Set tainting stuff before PerlIO_debug can possibly get called */
10213 PL_tainting = proto_perl->Itainting;
10214 PL_taint_warn = proto_perl->Itaint_warn;
10216 #ifdef PERLIO_LAYERS
10217 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10218 PerlIO_clone(aTHX_ proto_perl, param);
10221 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10222 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10223 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10224 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10225 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10226 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10229 PL_minus_c = proto_perl->Iminus_c;
10230 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10231 PL_localpatches = proto_perl->Ilocalpatches;
10232 PL_splitstr = proto_perl->Isplitstr;
10233 PL_preprocess = proto_perl->Ipreprocess;
10234 PL_minus_n = proto_perl->Iminus_n;
10235 PL_minus_p = proto_perl->Iminus_p;
10236 PL_minus_l = proto_perl->Iminus_l;
10237 PL_minus_a = proto_perl->Iminus_a;
10238 PL_minus_F = proto_perl->Iminus_F;
10239 PL_doswitches = proto_perl->Idoswitches;
10240 PL_dowarn = proto_perl->Idowarn;
10241 PL_doextract = proto_perl->Idoextract;
10242 PL_sawampersand = proto_perl->Isawampersand;
10243 PL_unsafe = proto_perl->Iunsafe;
10244 PL_inplace = SAVEPV(proto_perl->Iinplace);
10245 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10246 PL_perldb = proto_perl->Iperldb;
10247 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10248 PL_exit_flags = proto_perl->Iexit_flags;
10250 /* magical thingies */
10251 /* XXX time(&PL_basetime) when asked for? */
10252 PL_basetime = proto_perl->Ibasetime;
10253 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10255 PL_maxsysfd = proto_perl->Imaxsysfd;
10256 PL_multiline = proto_perl->Imultiline;
10257 PL_statusvalue = proto_perl->Istatusvalue;
10259 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10261 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10263 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10265 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10266 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10267 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10269 /* Clone the regex array */
10270 PL_regex_padav = newAV();
10272 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10273 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10275 av_push(PL_regex_padav,
10276 sv_dup_inc(regexen[0],param));
10277 for(i = 1; i <= len; i++) {
10278 if(SvREPADTMP(regexen[i])) {
10279 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10281 av_push(PL_regex_padav,
10283 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10284 SvIVX(regexen[i])), param)))
10289 PL_regex_pad = AvARRAY(PL_regex_padav);
10291 /* shortcuts to various I/O objects */
10292 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10293 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10294 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10295 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10296 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10297 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10299 /* shortcuts to regexp stuff */
10300 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10302 /* shortcuts to misc objects */
10303 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10305 /* shortcuts to debugging objects */
10306 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10307 PL_DBline = gv_dup(proto_perl->IDBline, param);
10308 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10309 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10310 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10311 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10312 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10313 PL_lineary = av_dup(proto_perl->Ilineary, param);
10314 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10316 /* symbol tables */
10317 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10318 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10319 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10320 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10321 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10323 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10324 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10325 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10326 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10327 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10328 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10330 PL_sub_generation = proto_perl->Isub_generation;
10332 /* funky return mechanisms */
10333 PL_forkprocess = proto_perl->Iforkprocess;
10335 /* subprocess state */
10336 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10338 /* internal state */
10339 PL_maxo = proto_perl->Imaxo;
10340 if (proto_perl->Iop_mask)
10341 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10343 PL_op_mask = Nullch;
10344 /* PL_asserting = proto_perl->Iasserting; */
10346 /* current interpreter roots */
10347 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10348 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10349 PL_main_start = proto_perl->Imain_start;
10350 PL_eval_root = proto_perl->Ieval_root;
10351 PL_eval_start = proto_perl->Ieval_start;
10353 /* runtime control stuff */
10354 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10355 PL_copline = proto_perl->Icopline;
10357 PL_filemode = proto_perl->Ifilemode;
10358 PL_lastfd = proto_perl->Ilastfd;
10359 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10362 PL_gensym = proto_perl->Igensym;
10363 PL_preambled = proto_perl->Ipreambled;
10364 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10365 PL_laststatval = proto_perl->Ilaststatval;
10366 PL_laststype = proto_perl->Ilaststype;
10367 PL_mess_sv = Nullsv;
10369 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10371 /* interpreter atexit processing */
10372 PL_exitlistlen = proto_perl->Iexitlistlen;
10373 if (PL_exitlistlen) {
10374 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10375 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10378 PL_exitlist = (PerlExitListEntry*)NULL;
10379 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10380 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10381 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10383 PL_profiledata = NULL;
10384 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10385 /* PL_rsfp_filters entries have fake IoDIRP() */
10386 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10388 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10390 PAD_CLONE_VARS(proto_perl, param);
10392 #ifdef HAVE_INTERP_INTERN
10393 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10396 /* more statics moved here */
10397 PL_generation = proto_perl->Igeneration;
10398 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10400 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10401 PL_in_clean_all = proto_perl->Iin_clean_all;
10403 PL_uid = proto_perl->Iuid;
10404 PL_euid = proto_perl->Ieuid;
10405 PL_gid = proto_perl->Igid;
10406 PL_egid = proto_perl->Iegid;
10407 PL_nomemok = proto_perl->Inomemok;
10408 PL_an = proto_perl->Ian;
10409 PL_evalseq = proto_perl->Ievalseq;
10410 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10411 PL_origalen = proto_perl->Iorigalen;
10412 #ifdef PERL_USES_PL_PIDSTATUS
10413 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10415 PL_osname = SAVEPV(proto_perl->Iosname);
10416 PL_sighandlerp = proto_perl->Isighandlerp;
10418 PL_runops = proto_perl->Irunops;
10420 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10423 PL_cshlen = proto_perl->Icshlen;
10424 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10427 PL_lex_state = proto_perl->Ilex_state;
10428 PL_lex_defer = proto_perl->Ilex_defer;
10429 PL_lex_expect = proto_perl->Ilex_expect;
10430 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10431 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10432 PL_lex_starts = proto_perl->Ilex_starts;
10433 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10434 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10435 PL_lex_op = proto_perl->Ilex_op;
10436 PL_lex_inpat = proto_perl->Ilex_inpat;
10437 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10438 PL_lex_brackets = proto_perl->Ilex_brackets;
10439 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10440 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10441 PL_lex_casemods = proto_perl->Ilex_casemods;
10442 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10443 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10445 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10446 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10447 PL_nexttoke = proto_perl->Inexttoke;
10449 /* XXX This is probably masking the deeper issue of why
10450 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10451 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10452 * (A little debugging with a watchpoint on it may help.)
10454 if (SvANY(proto_perl->Ilinestr)) {
10455 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10456 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10457 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10458 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10459 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10460 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10461 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10462 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10463 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10466 PL_linestr = NEWSV(65,79);
10467 sv_upgrade(PL_linestr,SVt_PVIV);
10468 sv_setpvn(PL_linestr,"",0);
10469 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10471 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10472 PL_pending_ident = proto_perl->Ipending_ident;
10473 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10475 PL_expect = proto_perl->Iexpect;
10477 PL_multi_start = proto_perl->Imulti_start;
10478 PL_multi_end = proto_perl->Imulti_end;
10479 PL_multi_open = proto_perl->Imulti_open;
10480 PL_multi_close = proto_perl->Imulti_close;
10482 PL_error_count = proto_perl->Ierror_count;
10483 PL_subline = proto_perl->Isubline;
10484 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10486 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10487 if (SvANY(proto_perl->Ilinestr)) {
10488 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10489 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10490 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10491 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10492 PL_last_lop_op = proto_perl->Ilast_lop_op;
10495 PL_last_uni = SvPVX(PL_linestr);
10496 PL_last_lop = SvPVX(PL_linestr);
10497 PL_last_lop_op = 0;
10499 PL_in_my = proto_perl->Iin_my;
10500 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10502 PL_cryptseen = proto_perl->Icryptseen;
10505 PL_hints = proto_perl->Ihints;
10507 PL_amagic_generation = proto_perl->Iamagic_generation;
10509 #ifdef USE_LOCALE_COLLATE
10510 PL_collation_ix = proto_perl->Icollation_ix;
10511 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10512 PL_collation_standard = proto_perl->Icollation_standard;
10513 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10514 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10515 #endif /* USE_LOCALE_COLLATE */
10517 #ifdef USE_LOCALE_NUMERIC
10518 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10519 PL_numeric_standard = proto_perl->Inumeric_standard;
10520 PL_numeric_local = proto_perl->Inumeric_local;
10521 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10522 #endif /* !USE_LOCALE_NUMERIC */
10524 /* utf8 character classes */
10525 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10526 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10527 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10528 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10529 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10530 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10531 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10532 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10533 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10534 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10535 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10536 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10537 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10538 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10539 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10540 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10541 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10542 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10543 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10544 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10546 /* Did the locale setup indicate UTF-8? */
10547 PL_utf8locale = proto_perl->Iutf8locale;
10548 /* Unicode features (see perlrun/-C) */
10549 PL_unicode = proto_perl->Iunicode;
10551 /* Pre-5.8 signals control */
10552 PL_signals = proto_perl->Isignals;
10554 /* times() ticks per second */
10555 PL_clocktick = proto_perl->Iclocktick;
10557 /* Recursion stopper for PerlIO_find_layer */
10558 PL_in_load_module = proto_perl->Iin_load_module;
10560 /* sort() routine */
10561 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10563 /* Not really needed/useful since the reenrant_retint is "volatile",
10564 * but do it for consistency's sake. */
10565 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10567 /* Hooks to shared SVs and locks. */
10568 PL_sharehook = proto_perl->Isharehook;
10569 PL_lockhook = proto_perl->Ilockhook;
10570 PL_unlockhook = proto_perl->Iunlockhook;
10571 PL_threadhook = proto_perl->Ithreadhook;
10573 PL_runops_std = proto_perl->Irunops_std;
10574 PL_runops_dbg = proto_perl->Irunops_dbg;
10576 #ifdef THREADS_HAVE_PIDS
10577 PL_ppid = proto_perl->Ippid;
10581 PL_last_swash_hv = NULL; /* reinits on demand */
10582 PL_last_swash_klen = 0;
10583 PL_last_swash_key[0]= '\0';
10584 PL_last_swash_tmps = (U8*)NULL;
10585 PL_last_swash_slen = 0;
10587 PL_glob_index = proto_perl->Iglob_index;
10588 PL_srand_called = proto_perl->Isrand_called;
10589 PL_uudmap['M'] = 0; /* reinits on demand */
10590 PL_bitcount = Nullch; /* reinits on demand */
10592 if (proto_perl->Ipsig_pend) {
10593 Newxz(PL_psig_pend, SIG_SIZE, int);
10596 PL_psig_pend = (int*)NULL;
10599 if (proto_perl->Ipsig_ptr) {
10600 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10601 Newxz(PL_psig_name, SIG_SIZE, SV*);
10602 for (i = 1; i < SIG_SIZE; i++) {
10603 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10604 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10608 PL_psig_ptr = (SV**)NULL;
10609 PL_psig_name = (SV**)NULL;
10612 /* thrdvar.h stuff */
10614 if (flags & CLONEf_COPY_STACKS) {
10615 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10616 PL_tmps_ix = proto_perl->Ttmps_ix;
10617 PL_tmps_max = proto_perl->Ttmps_max;
10618 PL_tmps_floor = proto_perl->Ttmps_floor;
10619 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10621 while (i <= PL_tmps_ix) {
10622 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10626 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10627 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10628 Newxz(PL_markstack, i, I32);
10629 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10630 - proto_perl->Tmarkstack);
10631 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10632 - proto_perl->Tmarkstack);
10633 Copy(proto_perl->Tmarkstack, PL_markstack,
10634 PL_markstack_ptr - PL_markstack + 1, I32);
10636 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10637 * NOTE: unlike the others! */
10638 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10639 PL_scopestack_max = proto_perl->Tscopestack_max;
10640 Newxz(PL_scopestack, PL_scopestack_max, I32);
10641 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10643 /* NOTE: si_dup() looks at PL_markstack */
10644 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10646 /* PL_curstack = PL_curstackinfo->si_stack; */
10647 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10648 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10650 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10651 PL_stack_base = AvARRAY(PL_curstack);
10652 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10653 - proto_perl->Tstack_base);
10654 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10656 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10657 * NOTE: unlike the others! */
10658 PL_savestack_ix = proto_perl->Tsavestack_ix;
10659 PL_savestack_max = proto_perl->Tsavestack_max;
10660 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10661 PL_savestack = ss_dup(proto_perl, param);
10665 ENTER; /* perl_destruct() wants to LEAVE; */
10668 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10669 PL_top_env = &PL_start_env;
10671 PL_op = proto_perl->Top;
10674 PL_Xpv = (XPV*)NULL;
10675 PL_na = proto_perl->Tna;
10677 PL_statbuf = proto_perl->Tstatbuf;
10678 PL_statcache = proto_perl->Tstatcache;
10679 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10680 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10682 PL_timesbuf = proto_perl->Ttimesbuf;
10685 PL_tainted = proto_perl->Ttainted;
10686 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10687 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10688 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10689 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10690 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10691 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10692 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10693 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10694 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10696 PL_restartop = proto_perl->Trestartop;
10697 PL_in_eval = proto_perl->Tin_eval;
10698 PL_delaymagic = proto_perl->Tdelaymagic;
10699 PL_dirty = proto_perl->Tdirty;
10700 PL_localizing = proto_perl->Tlocalizing;
10702 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10703 PL_hv_fetch_ent_mh = Nullhe;
10704 PL_modcount = proto_perl->Tmodcount;
10705 PL_lastgotoprobe = Nullop;
10706 PL_dumpindent = proto_perl->Tdumpindent;
10708 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10709 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10710 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10711 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10712 PL_efloatbuf = Nullch; /* reinits on demand */
10713 PL_efloatsize = 0; /* reinits on demand */
10717 PL_screamfirst = NULL;
10718 PL_screamnext = NULL;
10719 PL_maxscream = -1; /* reinits on demand */
10720 PL_lastscream = Nullsv;
10722 PL_watchaddr = NULL;
10723 PL_watchok = Nullch;
10725 PL_regdummy = proto_perl->Tregdummy;
10726 PL_regprecomp = Nullch;
10729 PL_colorset = 0; /* reinits PL_colors[] */
10730 /*PL_colors[6] = {0,0,0,0,0,0};*/
10731 PL_reginput = Nullch;
10732 PL_regbol = Nullch;
10733 PL_regeol = Nullch;
10734 PL_regstartp = (I32*)NULL;
10735 PL_regendp = (I32*)NULL;
10736 PL_reglastparen = (U32*)NULL;
10737 PL_reglastcloseparen = (U32*)NULL;
10738 PL_regtill = Nullch;
10739 PL_reg_start_tmp = (char**)NULL;
10740 PL_reg_start_tmpl = 0;
10741 PL_regdata = (struct reg_data*)NULL;
10744 PL_reg_eval_set = 0;
10746 PL_regprogram = (regnode*)NULL;
10748 PL_regcc = (CURCUR*)NULL;
10749 PL_reg_call_cc = (struct re_cc_state*)NULL;
10750 PL_reg_re = (regexp*)NULL;
10751 PL_reg_ganch = Nullch;
10752 PL_reg_sv = Nullsv;
10753 PL_reg_match_utf8 = FALSE;
10754 PL_reg_magic = (MAGIC*)NULL;
10756 PL_reg_oldcurpm = (PMOP*)NULL;
10757 PL_reg_curpm = (PMOP*)NULL;
10758 PL_reg_oldsaved = Nullch;
10759 PL_reg_oldsavedlen = 0;
10760 #ifdef PERL_OLD_COPY_ON_WRITE
10763 PL_reg_maxiter = 0;
10764 PL_reg_leftiter = 0;
10765 PL_reg_poscache = Nullch;
10766 PL_reg_poscache_size= 0;
10768 /* RE engine - function pointers */
10769 PL_regcompp = proto_perl->Tregcompp;
10770 PL_regexecp = proto_perl->Tregexecp;
10771 PL_regint_start = proto_perl->Tregint_start;
10772 PL_regint_string = proto_perl->Tregint_string;
10773 PL_regfree = proto_perl->Tregfree;
10775 PL_reginterp_cnt = 0;
10776 PL_reg_starttry = 0;
10778 /* Pluggable optimizer */
10779 PL_peepp = proto_perl->Tpeepp;
10781 PL_stashcache = newHV();
10783 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10784 ptr_table_free(PL_ptr_table);
10785 PL_ptr_table = NULL;
10788 /* Call the ->CLONE method, if it exists, for each of the stashes
10789 identified by sv_dup() above.
10791 while(av_len(param->stashes) != -1) {
10792 HV* const stash = (HV*) av_shift(param->stashes);
10793 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10794 if (cloner && GvCV(cloner)) {
10799 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10801 call_sv((SV*)GvCV(cloner), G_DISCARD);
10807 SvREFCNT_dec(param->stashes);
10809 /* orphaned? eg threads->new inside BEGIN or use */
10810 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10811 (void)SvREFCNT_inc(PL_compcv);
10812 SAVEFREESV(PL_compcv);
10818 #endif /* USE_ITHREADS */
10821 =head1 Unicode Support
10823 =for apidoc sv_recode_to_utf8
10825 The encoding is assumed to be an Encode object, on entry the PV
10826 of the sv is assumed to be octets in that encoding, and the sv
10827 will be converted into Unicode (and UTF-8).
10829 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10830 is not a reference, nothing is done to the sv. If the encoding is not
10831 an C<Encode::XS> Encoding object, bad things will happen.
10832 (See F<lib/encoding.pm> and L<Encode>).
10834 The PV of the sv is returned.
10839 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10842 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10856 Passing sv_yes is wrong - it needs to be or'ed set of constants
10857 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10858 remove converted chars from source.
10860 Both will default the value - let them.
10862 XPUSHs(&PL_sv_yes);
10865 call_method("decode", G_SCALAR);
10869 s = SvPV_const(uni, len);
10870 if (s != SvPVX_const(sv)) {
10871 SvGROW(sv, len + 1);
10872 Move(s, SvPVX(sv), len + 1, char);
10873 SvCUR_set(sv, len);
10880 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10884 =for apidoc sv_cat_decode
10886 The encoding is assumed to be an Encode object, the PV of the ssv is
10887 assumed to be octets in that encoding and decoding the input starts
10888 from the position which (PV + *offset) pointed to. The dsv will be
10889 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10890 when the string tstr appears in decoding output or the input ends on
10891 the PV of the ssv. The value which the offset points will be modified
10892 to the last input position on the ssv.
10894 Returns TRUE if the terminator was found, else returns FALSE.
10899 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10900 SV *ssv, int *offset, char *tstr, int tlen)
10904 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10915 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10916 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10918 call_method("cat_decode", G_SCALAR);
10920 ret = SvTRUE(TOPs);
10921 *offset = SvIV(offsv);
10927 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10932 /* ---------------------------------------------------------------------
10934 * support functions for report_uninit()
10937 /* the maxiumum size of array or hash where we will scan looking
10938 * for the undefined element that triggered the warning */
10940 #define FUV_MAX_SEARCH_SIZE 1000
10942 /* Look for an entry in the hash whose value has the same SV as val;
10943 * If so, return a mortal copy of the key. */
10946 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10949 register HE **array;
10952 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10953 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10956 array = HvARRAY(hv);
10958 for (i=HvMAX(hv); i>0; i--) {
10959 register HE *entry;
10960 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10961 if (HeVAL(entry) != val)
10963 if ( HeVAL(entry) == &PL_sv_undef ||
10964 HeVAL(entry) == &PL_sv_placeholder)
10968 if (HeKLEN(entry) == HEf_SVKEY)
10969 return sv_mortalcopy(HeKEY_sv(entry));
10970 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10976 /* Look for an entry in the array whose value has the same SV as val;
10977 * If so, return the index, otherwise return -1. */
10980 S_find_array_subscript(pTHX_ AV *av, SV* val)
10984 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10985 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10989 for (i=AvFILLp(av); i>=0; i--) {
10990 if (svp[i] == val && svp[i] != &PL_sv_undef)
10996 /* S_varname(): return the name of a variable, optionally with a subscript.
10997 * If gv is non-zero, use the name of that global, along with gvtype (one
10998 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
10999 * targ. Depending on the value of the subscript_type flag, return:
11002 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11003 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11004 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11005 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11008 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11009 SV* keyname, I32 aindex, int subscript_type)
11012 SV * const name = sv_newmortal();
11015 buffer[0] = gvtype;
11018 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11020 gv_fullname4(name, gv, buffer, 0);
11022 if ((unsigned int)SvPVX(name)[1] <= 26) {
11024 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11026 /* Swap the 1 unprintable control character for the 2 byte pretty
11027 version - ie substr($name, 1, 1) = $buffer; */
11028 sv_insert(name, 1, 1, buffer, 2);
11033 CV * const cv = find_runcv(&unused);
11037 if (!cv || !CvPADLIST(cv))
11039 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11040 sv = *av_fetch(av, targ, FALSE);
11041 /* SvLEN in a pad name is not to be trusted */
11042 sv_setpv(name, SvPV_nolen_const(sv));
11045 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11046 SV * const sv = NEWSV(0,0);
11047 *SvPVX(name) = '$';
11048 Perl_sv_catpvf(aTHX_ name, "{%s}",
11049 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11052 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11053 *SvPVX(name) = '$';
11054 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11056 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11057 sv_insert(name, 0, 0, "within ", 7);
11064 =for apidoc find_uninit_var
11066 Find the name of the undefined variable (if any) that caused the operator o
11067 to issue a "Use of uninitialized value" warning.
11068 If match is true, only return a name if it's value matches uninit_sv.
11069 So roughly speaking, if a unary operator (such as OP_COS) generates a
11070 warning, then following the direct child of the op may yield an
11071 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11072 other hand, with OP_ADD there are two branches to follow, so we only print
11073 the variable name if we get an exact match.
11075 The name is returned as a mortal SV.
11077 Assumes that PL_op is the op that originally triggered the error, and that
11078 PL_comppad/PL_curpad points to the currently executing pad.
11084 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11092 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11093 uninit_sv == &PL_sv_placeholder)))
11096 switch (obase->op_type) {
11103 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11104 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11106 SV *keysv = Nullsv;
11107 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11109 if (pad) { /* @lex, %lex */
11110 sv = PAD_SVl(obase->op_targ);
11114 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11115 /* @global, %global */
11116 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11119 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11121 else /* @{expr}, %{expr} */
11122 return find_uninit_var(cUNOPx(obase)->op_first,
11126 /* attempt to find a match within the aggregate */
11128 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11130 subscript_type = FUV_SUBSCRIPT_HASH;
11133 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11135 subscript_type = FUV_SUBSCRIPT_ARRAY;
11138 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11141 return varname(gv, hash ? '%' : '@', obase->op_targ,
11142 keysv, index, subscript_type);
11146 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11148 return varname(Nullgv, '$', obase->op_targ,
11149 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11152 gv = cGVOPx_gv(obase);
11153 if (!gv || (match && GvSV(gv) != uninit_sv))
11155 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11158 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11161 av = (AV*)PAD_SV(obase->op_targ);
11162 if (!av || SvRMAGICAL(av))
11164 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11165 if (!svp || *svp != uninit_sv)
11168 return varname(Nullgv, '$', obase->op_targ,
11169 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11172 gv = cGVOPx_gv(obase);
11178 if (!av || SvRMAGICAL(av))
11180 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11181 if (!svp || *svp != uninit_sv)
11184 return varname(gv, '$', 0,
11185 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11190 o = cUNOPx(obase)->op_first;
11191 if (!o || o->op_type != OP_NULL ||
11192 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11194 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11198 if (PL_op == obase)
11199 /* $a[uninit_expr] or $h{uninit_expr} */
11200 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11203 o = cBINOPx(obase)->op_first;
11204 kid = cBINOPx(obase)->op_last;
11206 /* get the av or hv, and optionally the gv */
11208 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11209 sv = PAD_SV(o->op_targ);
11211 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11212 && cUNOPo->op_first->op_type == OP_GV)
11214 gv = cGVOPx_gv(cUNOPo->op_first);
11217 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11222 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11223 /* index is constant */
11227 if (obase->op_type == OP_HELEM) {
11228 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11229 if (!he || HeVAL(he) != uninit_sv)
11233 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11234 if (!svp || *svp != uninit_sv)
11238 if (obase->op_type == OP_HELEM)
11239 return varname(gv, '%', o->op_targ,
11240 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11242 return varname(gv, '@', o->op_targ, Nullsv,
11243 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11246 /* index is an expression;
11247 * attempt to find a match within the aggregate */
11248 if (obase->op_type == OP_HELEM) {
11249 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11251 return varname(gv, '%', o->op_targ,
11252 keysv, 0, FUV_SUBSCRIPT_HASH);
11255 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11257 return varname(gv, '@', o->op_targ,
11258 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11263 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11265 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11271 /* only examine RHS */
11272 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11275 o = cUNOPx(obase)->op_first;
11276 if (o->op_type == OP_PUSHMARK)
11279 if (!o->op_sibling) {
11280 /* one-arg version of open is highly magical */
11282 if (o->op_type == OP_GV) { /* open FOO; */
11284 if (match && GvSV(gv) != uninit_sv)
11286 return varname(gv, '$', 0,
11287 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11289 /* other possibilities not handled are:
11290 * open $x; or open my $x; should return '${*$x}'
11291 * open expr; should return '$'.expr ideally
11297 /* ops where $_ may be an implicit arg */
11301 if ( !(obase->op_flags & OPf_STACKED)) {
11302 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11303 ? PAD_SVl(obase->op_targ)
11306 sv = sv_newmortal();
11307 sv_setpvn(sv, "$_", 2);
11315 /* skip filehandle as it can't produce 'undef' warning */
11316 o = cUNOPx(obase)->op_first;
11317 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11318 o = o->op_sibling->op_sibling;
11325 match = 1; /* XS or custom code could trigger random warnings */
11330 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11331 return sv_2mortal(newSVpvn("${$/}", 5));
11336 if (!(obase->op_flags & OPf_KIDS))
11338 o = cUNOPx(obase)->op_first;
11344 /* if all except one arg are constant, or have no side-effects,
11345 * or are optimized away, then it's unambiguous */
11347 for (kid=o; kid; kid = kid->op_sibling) {
11349 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11350 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11351 || (kid->op_type == OP_PUSHMARK)
11355 if (o2) { /* more than one found */
11362 return find_uninit_var(o2, uninit_sv, match);
11364 /* scan all args */
11366 sv = find_uninit_var(o, uninit_sv, 1);
11378 =for apidoc report_uninit
11380 Print appropriate "Use of uninitialized variable" warning
11386 Perl_report_uninit(pTHX_ SV* uninit_sv)
11389 SV* varname = Nullsv;
11391 varname = find_uninit_var(PL_op, uninit_sv,0);
11393 sv_insert(varname, 0, 0, " ", 1);
11395 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11396 varname ? SvPV_nolen_const(varname) : "",
11397 " in ", OP_DESC(PL_op));
11400 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11406 * c-indentation-style: bsd
11407 * c-basic-offset: 4
11408 * indent-tabs-mode: t
11411 * ex: set ts=8 sts=4 sw=4 noet: