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 **arena_root = &PL_body_arenaroots[sv_type];
644 void **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 **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 **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, *end;
1417 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
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 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1895 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1901 if (SvTHINKFIRST(sv)) {
1904 SV * const tmpstr=AMG_CALLun(sv,numer);
1905 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1906 return SvIV(tmpstr);
1909 return PTR2IV(SvRV(sv));
1912 sv_force_normal_flags(sv, 0);
1914 if (SvREADONLY(sv) && !SvOK(sv)) {
1915 if (ckWARN(WARN_UNINITIALIZED))
1921 if (S_sv_2iuv_common(aTHX_ sv))
1924 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1925 PTR2UV(sv),SvIVX(sv)));
1926 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1930 =for apidoc sv_2uv_flags
1932 Return the unsigned integer value of an SV, doing any necessary string
1933 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1934 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1940 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1944 if (SvGMAGICAL(sv)) {
1945 if (flags & SV_GMAGIC)
1950 return U_V(SvNVX(sv));
1951 if (SvPOKp(sv) && SvLEN(sv))
1954 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1955 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1961 if (SvTHINKFIRST(sv)) {
1964 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1965 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1966 return SvUV(tmpstr);
1967 return PTR2UV(SvRV(sv));
1970 sv_force_normal_flags(sv, 0);
1972 if (SvREADONLY(sv) && !SvOK(sv)) {
1973 if (ckWARN(WARN_UNINITIALIZED))
1979 if (S_sv_2iuv_common(aTHX_ sv))
1983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
1984 PTR2UV(sv),SvUVX(sv)));
1985 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
1991 Return the num value of an SV, doing any necessary string or integer
1992 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
1999 Perl_sv_2nv(pTHX_ register SV *sv)
2003 if (SvGMAGICAL(sv)) {
2007 if (SvPOKp(sv) && SvLEN(sv)) {
2008 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2009 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2011 return Atof(SvPVX_const(sv));
2015 return (NV)SvUVX(sv);
2017 return (NV)SvIVX(sv);
2020 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2021 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2027 if (SvTHINKFIRST(sv)) {
2030 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2031 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2032 return SvNV(tmpstr);
2033 return PTR2NV(SvRV(sv));
2036 sv_force_normal_flags(sv, 0);
2038 if (SvREADONLY(sv) && !SvOK(sv)) {
2039 if (ckWARN(WARN_UNINITIALIZED))
2044 if (SvTYPE(sv) < SVt_NV) {
2045 if (SvTYPE(sv) == SVt_IV)
2046 sv_upgrade(sv, SVt_PVNV);
2048 sv_upgrade(sv, SVt_NV);
2049 #ifdef USE_LONG_DOUBLE
2051 STORE_NUMERIC_LOCAL_SET_STANDARD();
2052 PerlIO_printf(Perl_debug_log,
2053 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2054 PTR2UV(sv), SvNVX(sv));
2055 RESTORE_NUMERIC_LOCAL();
2059 STORE_NUMERIC_LOCAL_SET_STANDARD();
2060 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2061 PTR2UV(sv), SvNVX(sv));
2062 RESTORE_NUMERIC_LOCAL();
2066 else if (SvTYPE(sv) < SVt_PVNV)
2067 sv_upgrade(sv, SVt_PVNV);
2072 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2073 #ifdef NV_PRESERVES_UV
2076 /* Only set the public NV OK flag if this NV preserves the IV */
2077 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2078 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2079 : (SvIVX(sv) == I_V(SvNVX(sv))))
2085 else if (SvPOKp(sv) && SvLEN(sv)) {
2087 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2088 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2090 #ifdef NV_PRESERVES_UV
2091 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2092 == IS_NUMBER_IN_UV) {
2093 /* It's definitely an integer */
2094 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2096 SvNV_set(sv, Atof(SvPVX_const(sv)));
2099 SvNV_set(sv, Atof(SvPVX_const(sv)));
2100 /* Only set the public NV OK flag if this NV preserves the value in
2101 the PV at least as well as an IV/UV would.
2102 Not sure how to do this 100% reliably. */
2103 /* if that shift count is out of range then Configure's test is
2104 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2106 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2107 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2108 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2109 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2110 /* Can't use strtol etc to convert this string, so don't try.
2111 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2114 /* value has been set. It may not be precise. */
2115 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2116 /* 2s complement assumption for (UV)IV_MIN */
2117 SvNOK_on(sv); /* Integer is too negative. */
2122 if (numtype & IS_NUMBER_NEG) {
2123 SvIV_set(sv, -(IV)value);
2124 } else if (value <= (UV)IV_MAX) {
2125 SvIV_set(sv, (IV)value);
2127 SvUV_set(sv, value);
2131 if (numtype & IS_NUMBER_NOT_INT) {
2132 /* I believe that even if the original PV had decimals,
2133 they are lost beyond the limit of the FP precision.
2134 However, neither is canonical, so both only get p
2135 flags. NWC, 2000/11/25 */
2136 /* Both already have p flags, so do nothing */
2138 const NV nv = SvNVX(sv);
2139 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2140 if (SvIVX(sv) == I_V(nv)) {
2145 /* It had no "." so it must be integer. */
2148 /* between IV_MAX and NV(UV_MAX).
2149 Could be slightly > UV_MAX */
2151 if (numtype & IS_NUMBER_NOT_INT) {
2152 /* UV and NV both imprecise. */
2154 const UV nv_as_uv = U_V(nv);
2156 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2167 #endif /* NV_PRESERVES_UV */
2170 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2172 if (SvTYPE(sv) < SVt_NV)
2173 /* Typically the caller expects that sv_any is not NULL now. */
2174 /* XXX Ilya implies that this is a bug in callers that assume this
2175 and ideally should be fixed. */
2176 sv_upgrade(sv, SVt_NV);
2179 #if defined(USE_LONG_DOUBLE)
2181 STORE_NUMERIC_LOCAL_SET_STANDARD();
2182 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2183 PTR2UV(sv), SvNVX(sv));
2184 RESTORE_NUMERIC_LOCAL();
2188 STORE_NUMERIC_LOCAL_SET_STANDARD();
2189 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2190 PTR2UV(sv), SvNVX(sv));
2191 RESTORE_NUMERIC_LOCAL();
2197 /* asIV(): extract an integer from the string value of an SV.
2198 * Caller must validate PVX */
2201 S_asIV(pTHX_ SV *sv)
2204 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2206 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2207 == IS_NUMBER_IN_UV) {
2208 /* It's definitely an integer */
2209 if (numtype & IS_NUMBER_NEG) {
2210 if (value < (UV)IV_MIN)
2213 if (value < (UV)IV_MAX)
2218 if (ckWARN(WARN_NUMERIC))
2221 return I_V(Atof(SvPVX_const(sv)));
2224 /* asUV(): extract an unsigned integer from the string value of an SV
2225 * Caller must validate PVX */
2228 S_asUV(pTHX_ SV *sv)
2231 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2233 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2234 == IS_NUMBER_IN_UV) {
2235 /* It's definitely an integer */
2236 if (!(numtype & IS_NUMBER_NEG))
2240 if (ckWARN(WARN_NUMERIC))
2243 return U_V(Atof(SvPVX_const(sv)));
2246 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2247 * UV as a string towards the end of buf, and return pointers to start and
2250 * We assume that buf is at least TYPE_CHARS(UV) long.
2254 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2256 char *ptr = buf + TYPE_CHARS(UV);
2257 char * const ebuf = ptr;
2270 *--ptr = '0' + (char)(uv % 10);
2279 =for apidoc sv_2pv_flags
2281 Returns a pointer to the string value of an SV, and sets *lp to its length.
2282 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2284 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2285 usually end up here too.
2291 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2301 if (SvGMAGICAL(sv)) {
2302 if (flags & SV_GMAGIC)
2307 if (flags & SV_MUTABLE_RETURN)
2308 return SvPVX_mutable(sv);
2309 if (flags & SV_CONST_RETURN)
2310 return (char *)SvPVX_const(sv);
2313 if (SvIOKp(sv) || SvNOKp(sv)) {
2314 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2318 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2319 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2321 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2324 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2325 /* Sneaky stuff here */
2326 SV *tsv = newSVpvn(tbuf, len);
2336 #ifdef FIXNEGATIVEZERO
2337 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2343 SvUPGRADE(sv, SVt_PV);
2346 s = SvGROW_mutable(sv, len + 1);
2349 return memcpy(s, tbuf, len + 1);
2353 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2354 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2362 if (SvTHINKFIRST(sv)) {
2366 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2367 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2369 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2372 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2373 if (flags & SV_CONST_RETURN) {
2374 pv = (char *) SvPVX_const(tmpstr);
2376 pv = (flags & SV_MUTABLE_RETURN)
2377 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2380 *lp = SvCUR(tmpstr);
2382 pv = sv_2pv_flags(tmpstr, lp, flags);
2392 const SV *const referent = (SV*)SvRV(sv);
2395 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2396 } else if (SvTYPE(referent) == SVt_PVMG
2397 && ((SvFLAGS(referent) &
2398 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2399 == (SVs_OBJECT|SVs_SMG))
2400 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2401 const regexp *re = (regexp *)mg->mg_obj;
2404 const char *fptr = "msix";
2409 char need_newline = 0;
2411 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2413 while((ch = *fptr++)) {
2415 reflags[left++] = ch;
2418 reflags[right--] = ch;
2423 reflags[left] = '-';
2427 mg->mg_len = re->prelen + 4 + left;
2429 * If /x was used, we have to worry about a regex
2430 * ending with a comment later being embedded
2431 * within another regex. If so, we don't want this
2432 * regex's "commentization" to leak out to the
2433 * right part of the enclosing regex, we must cap
2434 * it with a newline.
2436 * So, if /x was used, we scan backwards from the
2437 * end of the regex. If we find a '#' before we
2438 * find a newline, we need to add a newline
2439 * ourself. If we find a '\n' first (or if we
2440 * don't find '#' or '\n'), we don't need to add
2441 * anything. -jfriedl
2443 if (PMf_EXTENDED & re->reganch) {
2444 const char *endptr = re->precomp + re->prelen;
2445 while (endptr >= re->precomp) {
2446 const char c = *(endptr--);
2448 break; /* don't need another */
2450 /* we end while in a comment, so we
2452 mg->mg_len++; /* save space for it */
2453 need_newline = 1; /* note to add it */
2459 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2460 mg->mg_ptr[0] = '(';
2461 mg->mg_ptr[1] = '?';
2462 Copy(reflags, mg->mg_ptr+2, left, char);
2463 *(mg->mg_ptr+left+2) = ':';
2464 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2466 mg->mg_ptr[mg->mg_len - 2] = '\n';
2467 mg->mg_ptr[mg->mg_len - 1] = ')';
2468 mg->mg_ptr[mg->mg_len] = 0;
2470 PL_reginterp_cnt += re->program[0].next_off;
2472 if (re->reganch & ROPT_UTF8)
2480 const char *const typestr = sv_reftype(referent, 0);
2482 tsv = sv_newmortal();
2483 if (SvOBJECT(referent)) {
2484 const char *const name = HvNAME_get(SvSTASH(referent));
2485 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2486 name ? name : "__ANON__" , typestr,
2490 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2498 if (SvREADONLY(sv) && !SvOK(sv)) {
2499 if (ckWARN(WARN_UNINITIALIZED))
2506 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2507 /* I'm assuming that if both IV and NV are equally valid then
2508 converting the IV is going to be more efficient */
2509 const U32 isIOK = SvIOK(sv);
2510 const U32 isUIOK = SvIsUV(sv);
2511 char buf[TYPE_CHARS(UV)];
2514 if (SvTYPE(sv) < SVt_PVIV)
2515 sv_upgrade(sv, SVt_PVIV);
2517 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2519 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2520 /* inlined from sv_setpvn */
2521 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2522 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2523 SvCUR_set(sv, ebuf - ptr);
2533 else if (SvNOKp(sv)) {
2534 if (SvTYPE(sv) < SVt_PVNV)
2535 sv_upgrade(sv, SVt_PVNV);
2536 /* The +20 is pure guesswork. Configure test needed. --jhi */
2537 s = SvGROW_mutable(sv, NV_DIG + 20);
2538 olderrno = errno; /* some Xenix systems wipe out errno here */
2540 if (SvNVX(sv) == 0.0)
2541 (void)strcpy(s,"0");
2545 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2548 #ifdef FIXNEGATIVEZERO
2549 if (*s == '-' && s[1] == '0' && !s[2])
2559 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2563 if (SvTYPE(sv) < SVt_PV)
2564 /* Typically the caller expects that sv_any is not NULL now. */
2565 sv_upgrade(sv, SVt_PV);
2569 const STRLEN len = s - SvPVX_const(sv);
2575 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2576 PTR2UV(sv),SvPVX_const(sv)));
2577 if (flags & SV_CONST_RETURN)
2578 return (char *)SvPVX_const(sv);
2579 if (flags & SV_MUTABLE_RETURN)
2580 return SvPVX_mutable(sv);
2585 =for apidoc sv_copypv
2587 Copies a stringified representation of the source SV into the
2588 destination SV. Automatically performs any necessary mg_get and
2589 coercion of numeric values into strings. Guaranteed to preserve
2590 UTF-8 flag even from overloaded objects. Similar in nature to
2591 sv_2pv[_flags] but operates directly on an SV instead of just the
2592 string. Mostly uses sv_2pv_flags to do its work, except when that
2593 would lose the UTF-8'ness of the PV.
2599 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2602 const char * const s = SvPV_const(ssv,len);
2603 sv_setpvn(dsv,s,len);
2611 =for apidoc sv_2pvbyte
2613 Return a pointer to the byte-encoded representation of the SV, and set *lp
2614 to its length. May cause the SV to be downgraded from UTF-8 as a
2617 Usually accessed via the C<SvPVbyte> macro.
2623 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2625 sv_utf8_downgrade(sv,0);
2626 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2630 =for apidoc sv_2pvutf8
2632 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2633 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2635 Usually accessed via the C<SvPVutf8> macro.
2641 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2643 sv_utf8_upgrade(sv);
2644 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2649 =for apidoc sv_2bool
2651 This function is only called on magical items, and is only used by
2652 sv_true() or its macro equivalent.
2658 Perl_sv_2bool(pTHX_ register SV *sv)
2666 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2667 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2668 return (bool)SvTRUE(tmpsv);
2669 return SvRV(sv) != 0;
2672 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2674 (*sv->sv_u.svu_pv > '0' ||
2675 Xpvtmp->xpv_cur > 1 ||
2676 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2683 return SvIVX(sv) != 0;
2686 return SvNVX(sv) != 0.0;
2694 =for apidoc sv_utf8_upgrade
2696 Converts the PV of an SV to its UTF-8-encoded form.
2697 Forces the SV to string form if it is not already.
2698 Always sets the SvUTF8 flag to avoid future validity checks even
2699 if all the bytes have hibit clear.
2701 This is not as a general purpose byte encoding to Unicode interface:
2702 use the Encode extension for that.
2704 =for apidoc sv_utf8_upgrade_flags
2706 Converts the PV of an SV to its UTF-8-encoded form.
2707 Forces the SV to string form if it is not already.
2708 Always sets the SvUTF8 flag to avoid future validity checks even
2709 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2710 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2711 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2713 This is not as a general purpose byte encoding to Unicode interface:
2714 use the Encode extension for that.
2720 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2722 if (sv == &PL_sv_undef)
2726 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2727 (void) sv_2pv_flags(sv,&len, flags);
2731 (void) SvPV_force(sv,len);
2740 sv_force_normal_flags(sv, 0);
2743 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2744 sv_recode_to_utf8(sv, PL_encoding);
2745 else { /* Assume Latin-1/EBCDIC */
2746 /* This function could be much more efficient if we
2747 * had a FLAG in SVs to signal if there are any hibit
2748 * chars in the PV. Given that there isn't such a flag
2749 * make the loop as fast as possible. */
2750 const U8 *s = (U8 *) SvPVX_const(sv);
2751 const U8 * const e = (U8 *) SvEND(sv);
2757 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2761 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2762 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2764 SvPV_free(sv); /* No longer using what was there before. */
2766 SvPV_set(sv, (char*)recoded);
2767 SvCUR_set(sv, len - 1);
2768 SvLEN_set(sv, len); /* No longer know the real size. */
2770 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2777 =for apidoc sv_utf8_downgrade
2779 Attempts to convert the PV of an SV from characters to bytes.
2780 If the PV contains a character beyond byte, this conversion will fail;
2781 in this case, either returns false or, if C<fail_ok> is not
2784 This is not as a general purpose Unicode to byte encoding interface:
2785 use the Encode extension for that.
2791 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2793 if (SvPOKp(sv) && SvUTF8(sv)) {
2799 sv_force_normal_flags(sv, 0);
2801 s = (U8 *) SvPV(sv, len);
2802 if (!utf8_to_bytes(s, &len)) {
2807 Perl_croak(aTHX_ "Wide character in %s",
2810 Perl_croak(aTHX_ "Wide character");
2821 =for apidoc sv_utf8_encode
2823 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2824 flag off so that it looks like octets again.
2830 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2832 (void) sv_utf8_upgrade(sv);
2834 sv_force_normal_flags(sv, 0);
2836 if (SvREADONLY(sv)) {
2837 Perl_croak(aTHX_ PL_no_modify);
2843 =for apidoc sv_utf8_decode
2845 If the PV of the SV is an octet sequence in UTF-8
2846 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2847 so that it looks like a character. If the PV contains only single-byte
2848 characters, the C<SvUTF8> flag stays being off.
2849 Scans PV for validity and returns false if the PV is invalid UTF-8.
2855 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2861 /* The octets may have got themselves encoded - get them back as
2864 if (!sv_utf8_downgrade(sv, TRUE))
2867 /* it is actually just a matter of turning the utf8 flag on, but
2868 * we want to make sure everything inside is valid utf8 first.
2870 c = (const U8 *) SvPVX_const(sv);
2871 if (!is_utf8_string(c, SvCUR(sv)+1))
2873 e = (const U8 *) SvEND(sv);
2876 if (!UTF8_IS_INVARIANT(ch)) {
2886 =for apidoc sv_setsv
2888 Copies the contents of the source SV C<ssv> into the destination SV
2889 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2890 function if the source SV needs to be reused. Does not handle 'set' magic.
2891 Loosely speaking, it performs a copy-by-value, obliterating any previous
2892 content of the destination.
2894 You probably want to use one of the assortment of wrappers, such as
2895 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2896 C<SvSetMagicSV_nosteal>.
2898 =for apidoc sv_setsv_flags
2900 Copies the contents of the source SV C<ssv> into the destination SV
2901 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2902 function if the source SV needs to be reused. Does not handle 'set' magic.
2903 Loosely speaking, it performs a copy-by-value, obliterating any previous
2904 content of the destination.
2905 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2906 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2907 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2908 and C<sv_setsv_nomg> are implemented in terms of this function.
2910 You probably want to use one of the assortment of wrappers, such as
2911 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2912 C<SvSetMagicSV_nosteal>.
2914 This is the primary function for copying scalars, and most other
2915 copy-ish functions and macros use this underneath.
2921 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2923 register U32 sflags;
2929 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2931 sstr = &PL_sv_undef;
2932 stype = SvTYPE(sstr);
2933 dtype = SvTYPE(dstr);
2938 /* need to nuke the magic */
2940 SvRMAGICAL_off(dstr);
2943 /* There's a lot of redundancy below but we're going for speed here */
2948 if (dtype != SVt_PVGV) {
2949 (void)SvOK_off(dstr);
2957 sv_upgrade(dstr, SVt_IV);
2960 sv_upgrade(dstr, SVt_PVNV);
2964 sv_upgrade(dstr, SVt_PVIV);
2967 (void)SvIOK_only(dstr);
2968 SvIV_set(dstr, SvIVX(sstr));
2971 if (SvTAINTED(sstr))
2982 sv_upgrade(dstr, SVt_NV);
2987 sv_upgrade(dstr, SVt_PVNV);
2990 SvNV_set(dstr, SvNVX(sstr));
2991 (void)SvNOK_only(dstr);
2992 if (SvTAINTED(sstr))
3000 sv_upgrade(dstr, SVt_RV);
3001 else if (dtype == SVt_PVGV &&
3002 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3005 if (GvIMPORTED(dstr) != GVf_IMPORTED
3006 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3008 GvIMPORTED_on(dstr);
3017 #ifdef PERL_OLD_COPY_ON_WRITE
3018 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3019 if (dtype < SVt_PVIV)
3020 sv_upgrade(dstr, SVt_PVIV);
3027 sv_upgrade(dstr, SVt_PV);
3030 if (dtype < SVt_PVIV)
3031 sv_upgrade(dstr, SVt_PVIV);
3034 if (dtype < SVt_PVNV)
3035 sv_upgrade(dstr, SVt_PVNV);
3042 const char * const type = sv_reftype(sstr,0);
3044 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3046 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3051 if (dtype <= SVt_PVGV) {
3053 if (dtype != SVt_PVGV) {
3054 const char * const name = GvNAME(sstr);
3055 const STRLEN len = GvNAMELEN(sstr);
3056 /* don't upgrade SVt_PVLV: it can hold a glob */
3057 if (dtype != SVt_PVLV)
3058 sv_upgrade(dstr, SVt_PVGV);
3059 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3060 GvSTASH(dstr) = GvSTASH(sstr);
3062 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3063 GvNAME(dstr) = savepvn(name, len);
3064 GvNAMELEN(dstr) = len;
3065 SvFAKE_on(dstr); /* can coerce to non-glob */
3068 #ifdef GV_UNIQUE_CHECK
3069 if (GvUNIQUE((GV*)dstr)) {
3070 Perl_croak(aTHX_ PL_no_modify);
3074 (void)SvOK_off(dstr);
3075 GvINTRO_off(dstr); /* one-shot flag */
3077 GvGP(dstr) = gp_ref(GvGP(sstr));
3078 if (SvTAINTED(sstr))
3080 if (GvIMPORTED(dstr) != GVf_IMPORTED
3081 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3083 GvIMPORTED_on(dstr);
3091 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3093 if ((int)SvTYPE(sstr) != stype) {
3094 stype = SvTYPE(sstr);
3095 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3099 if (stype == SVt_PVLV)
3100 SvUPGRADE(dstr, SVt_PVNV);
3102 SvUPGRADE(dstr, (U32)stype);
3105 sflags = SvFLAGS(sstr);
3107 if (sflags & SVf_ROK) {
3108 if (dtype >= SVt_PV) {
3109 if (dtype == SVt_PVGV) {
3110 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3112 const int intro = GvINTRO(dstr);
3114 #ifdef GV_UNIQUE_CHECK
3115 if (GvUNIQUE((GV*)dstr)) {
3116 Perl_croak(aTHX_ PL_no_modify);
3121 GvINTRO_off(dstr); /* one-shot flag */
3122 GvLINE(dstr) = CopLINE(PL_curcop);
3123 GvEGV(dstr) = (GV*)dstr;
3126 switch (SvTYPE(sref)) {
3129 SAVEGENERICSV(GvAV(dstr));
3131 dref = (SV*)GvAV(dstr);
3132 GvAV(dstr) = (AV*)sref;
3133 if (!GvIMPORTED_AV(dstr)
3134 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3136 GvIMPORTED_AV_on(dstr);
3141 SAVEGENERICSV(GvHV(dstr));
3143 dref = (SV*)GvHV(dstr);
3144 GvHV(dstr) = (HV*)sref;
3145 if (!GvIMPORTED_HV(dstr)
3146 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3148 GvIMPORTED_HV_on(dstr);
3153 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3154 SvREFCNT_dec(GvCV(dstr));
3155 GvCV(dstr) = Nullcv;
3156 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3157 PL_sub_generation++;
3159 SAVEGENERICSV(GvCV(dstr));
3162 dref = (SV*)GvCV(dstr);
3163 if (GvCV(dstr) != (CV*)sref) {
3164 CV* const cv = GvCV(dstr);
3166 if (!GvCVGEN((GV*)dstr) &&
3167 (CvROOT(cv) || CvXSUB(cv)))
3169 /* Redefining a sub - warning is mandatory if
3170 it was a const and its value changed. */
3171 if (ckWARN(WARN_REDEFINE)
3173 && (!CvCONST((CV*)sref)
3174 || sv_cmp(cv_const_sv(cv),
3175 cv_const_sv((CV*)sref)))))
3177 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3179 ? "Constant subroutine %s::%s redefined"
3180 : "Subroutine %s::%s redefined",
3181 HvNAME_get(GvSTASH((GV*)dstr)),
3182 GvENAME((GV*)dstr));
3186 cv_ckproto(cv, (GV*)dstr,
3188 ? SvPVX_const(sref) : Nullch);
3190 GvCV(dstr) = (CV*)sref;
3191 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3192 GvASSUMECV_on(dstr);
3193 PL_sub_generation++;
3195 if (!GvIMPORTED_CV(dstr)
3196 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3198 GvIMPORTED_CV_on(dstr);
3203 SAVEGENERICSV(GvIOp(dstr));
3205 dref = (SV*)GvIOp(dstr);
3206 GvIOp(dstr) = (IO*)sref;
3210 SAVEGENERICSV(GvFORM(dstr));
3212 dref = (SV*)GvFORM(dstr);
3213 GvFORM(dstr) = (CV*)sref;
3217 SAVEGENERICSV(GvSV(dstr));
3219 dref = (SV*)GvSV(dstr);
3221 if (!GvIMPORTED_SV(dstr)
3222 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3224 GvIMPORTED_SV_on(dstr);
3230 if (SvTAINTED(sstr))
3234 if (SvPVX_const(dstr)) {
3240 (void)SvOK_off(dstr);
3241 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3243 if (sflags & SVp_NOK) {
3245 /* Only set the public OK flag if the source has public OK. */
3246 if (sflags & SVf_NOK)
3247 SvFLAGS(dstr) |= SVf_NOK;
3248 SvNV_set(dstr, SvNVX(sstr));
3250 if (sflags & SVp_IOK) {
3251 (void)SvIOKp_on(dstr);
3252 if (sflags & SVf_IOK)
3253 SvFLAGS(dstr) |= SVf_IOK;
3254 if (sflags & SVf_IVisUV)
3256 SvIV_set(dstr, SvIVX(sstr));
3258 if (SvAMAGIC(sstr)) {
3262 else if (sflags & SVp_POK) {
3266 * Check to see if we can just swipe the string. If so, it's a
3267 * possible small lose on short strings, but a big win on long ones.
3268 * It might even be a win on short strings if SvPVX_const(dstr)
3269 * has to be allocated and SvPVX_const(sstr) has to be freed.
3272 /* Whichever path we take through the next code, we want this true,
3273 and doing it now facilitates the COW check. */
3274 (void)SvPOK_only(dstr);
3277 /* We're not already COW */
3278 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3279 #ifndef PERL_OLD_COPY_ON_WRITE
3280 /* or we are, but dstr isn't a suitable target. */
3281 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3286 (sflags & SVs_TEMP) && /* slated for free anyway? */
3287 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3288 (!(flags & SV_NOSTEAL)) &&
3289 /* and we're allowed to steal temps */
3290 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3291 SvLEN(sstr) && /* and really is a string */
3292 /* and won't be needed again, potentially */
3293 !(PL_op && PL_op->op_type == OP_AASSIGN))
3294 #ifdef PERL_OLD_COPY_ON_WRITE
3295 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3296 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3297 && SvTYPE(sstr) >= SVt_PVIV)
3300 /* Failed the swipe test, and it's not a shared hash key either.
3301 Have to copy the string. */
3302 STRLEN len = SvCUR(sstr);
3303 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3304 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3305 SvCUR_set(dstr, len);
3306 *SvEND(dstr) = '\0';
3308 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3310 /* Either it's a shared hash key, or it's suitable for
3311 copy-on-write or we can swipe the string. */
3313 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3317 #ifdef PERL_OLD_COPY_ON_WRITE
3319 /* I believe I should acquire a global SV mutex if
3320 it's a COW sv (not a shared hash key) to stop
3321 it going un copy-on-write.
3322 If the source SV has gone un copy on write between up there
3323 and down here, then (assert() that) it is of the correct
3324 form to make it copy on write again */
3325 if ((sflags & (SVf_FAKE | SVf_READONLY))
3326 != (SVf_FAKE | SVf_READONLY)) {
3327 SvREADONLY_on(sstr);
3329 /* Make the source SV into a loop of 1.
3330 (about to become 2) */
3331 SV_COW_NEXT_SV_SET(sstr, sstr);
3335 /* Initial code is common. */
3336 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3341 /* making another shared SV. */
3342 STRLEN cur = SvCUR(sstr);
3343 STRLEN len = SvLEN(sstr);
3344 #ifdef PERL_OLD_COPY_ON_WRITE
3346 assert (SvTYPE(dstr) >= SVt_PVIV);
3347 /* SvIsCOW_normal */
3348 /* splice us in between source and next-after-source. */
3349 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3350 SV_COW_NEXT_SV_SET(sstr, dstr);
3351 SvPV_set(dstr, SvPVX_mutable(sstr));
3355 /* SvIsCOW_shared_hash */
3356 DEBUG_C(PerlIO_printf(Perl_debug_log,
3357 "Copy on write: Sharing hash\n"));
3359 assert (SvTYPE(dstr) >= SVt_PV);
3361 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3363 SvLEN_set(dstr, len);
3364 SvCUR_set(dstr, cur);
3365 SvREADONLY_on(dstr);
3367 /* Relesase a global SV mutex. */
3370 { /* Passes the swipe test. */
3371 SvPV_set(dstr, SvPVX_mutable(sstr));
3372 SvLEN_set(dstr, SvLEN(sstr));
3373 SvCUR_set(dstr, SvCUR(sstr));
3376 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3377 SvPV_set(sstr, Nullch);
3383 if (sflags & SVf_UTF8)
3385 if (sflags & SVp_NOK) {
3387 if (sflags & SVf_NOK)
3388 SvFLAGS(dstr) |= SVf_NOK;
3389 SvNV_set(dstr, SvNVX(sstr));
3391 if (sflags & SVp_IOK) {
3392 (void)SvIOKp_on(dstr);
3393 if (sflags & SVf_IOK)
3394 SvFLAGS(dstr) |= SVf_IOK;
3395 if (sflags & SVf_IVisUV)
3397 SvIV_set(dstr, SvIVX(sstr));
3400 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3401 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3402 smg->mg_ptr, smg->mg_len);
3403 SvRMAGICAL_on(dstr);
3406 else if (sflags & SVp_IOK) {
3407 if (sflags & SVf_IOK)
3408 (void)SvIOK_only(dstr);
3410 (void)SvOK_off(dstr);
3411 (void)SvIOKp_on(dstr);
3413 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3414 if (sflags & SVf_IVisUV)
3416 SvIV_set(dstr, SvIVX(sstr));
3417 if (sflags & SVp_NOK) {
3418 if (sflags & SVf_NOK)
3419 (void)SvNOK_on(dstr);
3421 (void)SvNOKp_on(dstr);
3422 SvNV_set(dstr, SvNVX(sstr));
3425 else if (sflags & SVp_NOK) {
3426 if (sflags & SVf_NOK)
3427 (void)SvNOK_only(dstr);
3429 (void)SvOK_off(dstr);
3432 SvNV_set(dstr, SvNVX(sstr));
3435 if (dtype == SVt_PVGV) {
3436 if (ckWARN(WARN_MISC))
3437 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3440 (void)SvOK_off(dstr);
3442 if (SvTAINTED(sstr))
3447 =for apidoc sv_setsv_mg
3449 Like C<sv_setsv>, but also handles 'set' magic.
3455 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3457 sv_setsv(dstr,sstr);
3461 #ifdef PERL_OLD_COPY_ON_WRITE
3463 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3465 STRLEN cur = SvCUR(sstr);
3466 STRLEN len = SvLEN(sstr);
3467 register char *new_pv;
3470 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3478 if (SvTHINKFIRST(dstr))
3479 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3480 else if (SvPVX_const(dstr))
3481 Safefree(SvPVX_const(dstr));
3485 SvUPGRADE(dstr, SVt_PVIV);
3487 assert (SvPOK(sstr));
3488 assert (SvPOKp(sstr));
3489 assert (!SvIOK(sstr));
3490 assert (!SvIOKp(sstr));
3491 assert (!SvNOK(sstr));
3492 assert (!SvNOKp(sstr));
3494 if (SvIsCOW(sstr)) {
3496 if (SvLEN(sstr) == 0) {
3497 /* source is a COW shared hash key. */
3498 DEBUG_C(PerlIO_printf(Perl_debug_log,
3499 "Fast copy on write: Sharing hash\n"));
3500 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3503 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3505 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3506 SvUPGRADE(sstr, SVt_PVIV);
3507 SvREADONLY_on(sstr);
3509 DEBUG_C(PerlIO_printf(Perl_debug_log,
3510 "Fast copy on write: Converting sstr to COW\n"));
3511 SV_COW_NEXT_SV_SET(dstr, sstr);
3513 SV_COW_NEXT_SV_SET(sstr, dstr);
3514 new_pv = SvPVX_mutable(sstr);
3517 SvPV_set(dstr, new_pv);
3518 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3521 SvLEN_set(dstr, len);
3522 SvCUR_set(dstr, cur);
3531 =for apidoc sv_setpvn
3533 Copies a string into an SV. The C<len> parameter indicates the number of
3534 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3535 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3541 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3543 register char *dptr;
3545 SV_CHECK_THINKFIRST_COW_DROP(sv);
3551 /* len is STRLEN which is unsigned, need to copy to signed */
3554 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3556 SvUPGRADE(sv, SVt_PV);
3558 dptr = SvGROW(sv, len + 1);
3559 Move(ptr,dptr,len,char);
3562 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3567 =for apidoc sv_setpvn_mg
3569 Like C<sv_setpvn>, but also handles 'set' magic.
3575 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3577 sv_setpvn(sv,ptr,len);
3582 =for apidoc sv_setpv
3584 Copies a string into an SV. The string must be null-terminated. Does not
3585 handle 'set' magic. See C<sv_setpv_mg>.
3591 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3593 register STRLEN len;
3595 SV_CHECK_THINKFIRST_COW_DROP(sv);
3601 SvUPGRADE(sv, SVt_PV);
3603 SvGROW(sv, len + 1);
3604 Move(ptr,SvPVX(sv),len+1,char);
3606 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3611 =for apidoc sv_setpv_mg
3613 Like C<sv_setpv>, but also handles 'set' magic.
3619 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3626 =for apidoc sv_usepvn
3628 Tells an SV to use C<ptr> to find its string value. Normally the string is
3629 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3630 The C<ptr> should point to memory that was allocated by C<malloc>. The
3631 string length, C<len>, must be supplied. This function will realloc the
3632 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3633 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3634 See C<sv_usepvn_mg>.
3640 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3643 SV_CHECK_THINKFIRST_COW_DROP(sv);
3644 SvUPGRADE(sv, SVt_PV);
3649 if (SvPVX_const(sv))
3652 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3653 ptr = saferealloc (ptr, allocate);
3656 SvLEN_set(sv, allocate);
3658 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3663 =for apidoc sv_usepvn_mg
3665 Like C<sv_usepvn>, but also handles 'set' magic.
3671 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3673 sv_usepvn(sv,ptr,len);
3677 #ifdef PERL_OLD_COPY_ON_WRITE
3678 /* Need to do this *after* making the SV normal, as we need the buffer
3679 pointer to remain valid until after we've copied it. If we let go too early,
3680 another thread could invalidate it by unsharing last of the same hash key
3681 (which it can do by means other than releasing copy-on-write Svs)
3682 or by changing the other copy-on-write SVs in the loop. */
3684 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3686 if (len) { /* this SV was SvIsCOW_normal(sv) */
3687 /* we need to find the SV pointing to us. */
3688 SV * const current = SV_COW_NEXT_SV(after);
3690 if (current == sv) {
3691 /* The SV we point to points back to us (there were only two of us
3693 Hence other SV is no longer copy on write either. */
3695 SvREADONLY_off(after);
3697 /* We need to follow the pointers around the loop. */
3699 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3702 /* don't loop forever if the structure is bust, and we have
3703 a pointer into a closed loop. */
3704 assert (current != after);
3705 assert (SvPVX_const(current) == pvx);
3707 /* Make the SV before us point to the SV after us. */
3708 SV_COW_NEXT_SV_SET(current, after);
3711 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3716 Perl_sv_release_IVX(pTHX_ register SV *sv)
3719 sv_force_normal_flags(sv, 0);
3725 =for apidoc sv_force_normal_flags
3727 Undo various types of fakery on an SV: if the PV is a shared string, make
3728 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3729 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3730 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3731 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3732 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3733 set to some other value.) In addition, the C<flags> parameter gets passed to
3734 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3735 with flags set to 0.
3741 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3743 #ifdef PERL_OLD_COPY_ON_WRITE
3744 if (SvREADONLY(sv)) {
3745 /* At this point I believe I should acquire a global SV mutex. */
3747 const char * const pvx = SvPVX_const(sv);
3748 const STRLEN len = SvLEN(sv);
3749 const STRLEN cur = SvCUR(sv);
3750 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3752 PerlIO_printf(Perl_debug_log,
3753 "Copy on write: Force normal %ld\n",
3759 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3760 SvPV_set(sv, (char*)0);
3762 if (flags & SV_COW_DROP_PV) {
3763 /* OK, so we don't need to copy our buffer. */
3766 SvGROW(sv, cur + 1);
3767 Move(pvx,SvPVX(sv),cur,char);
3771 sv_release_COW(sv, pvx, len, next);
3776 else if (IN_PERL_RUNTIME)
3777 Perl_croak(aTHX_ PL_no_modify);
3778 /* At this point I believe that I can drop the global SV mutex. */
3781 if (SvREADONLY(sv)) {
3783 const char * const pvx = SvPVX_const(sv);
3784 const STRLEN len = SvCUR(sv);
3787 SvPV_set(sv, Nullch);
3789 SvGROW(sv, len + 1);
3790 Move(pvx,SvPVX(sv),len,char);
3792 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3794 else if (IN_PERL_RUNTIME)
3795 Perl_croak(aTHX_ PL_no_modify);
3799 sv_unref_flags(sv, flags);
3800 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3807 Efficient removal of characters from the beginning of the string buffer.
3808 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3809 the string buffer. The C<ptr> becomes the first character of the adjusted
3810 string. Uses the "OOK hack".
3811 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3812 refer to the same chunk of data.
3818 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3820 register STRLEN delta;
3821 if (!ptr || !SvPOKp(sv))
3823 delta = ptr - SvPVX_const(sv);
3824 SV_CHECK_THINKFIRST(sv);
3825 if (SvTYPE(sv) < SVt_PVIV)
3826 sv_upgrade(sv,SVt_PVIV);
3829 if (!SvLEN(sv)) { /* make copy of shared string */
3830 const char *pvx = SvPVX_const(sv);
3831 const STRLEN len = SvCUR(sv);
3832 SvGROW(sv, len + 1);
3833 Move(pvx,SvPVX(sv),len,char);
3837 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3838 and we do that anyway inside the SvNIOK_off
3840 SvFLAGS(sv) |= SVf_OOK;
3843 SvLEN_set(sv, SvLEN(sv) - delta);
3844 SvCUR_set(sv, SvCUR(sv) - delta);
3845 SvPV_set(sv, SvPVX(sv) + delta);
3846 SvIV_set(sv, SvIVX(sv) + delta);
3850 =for apidoc sv_catpvn
3852 Concatenates the string onto the end of the string which is in the SV. The
3853 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3854 status set, then the bytes appended should be valid UTF-8.
3855 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3857 =for apidoc sv_catpvn_flags
3859 Concatenates the string onto the end of the string which is in the SV. The
3860 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3861 status set, then the bytes appended should be valid UTF-8.
3862 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3863 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3864 in terms of this function.
3870 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3873 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3875 SvGROW(dsv, dlen + slen + 1);
3877 sstr = SvPVX_const(dsv);
3878 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3879 SvCUR_set(dsv, SvCUR(dsv) + slen);
3881 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3883 if (flags & SV_SMAGIC)
3888 =for apidoc sv_catsv
3890 Concatenates the string from SV C<ssv> onto the end of the string in
3891 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3892 not 'set' magic. See C<sv_catsv_mg>.
3894 =for apidoc sv_catsv_flags
3896 Concatenates the string from SV C<ssv> onto the end of the string in
3897 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3898 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3899 and C<sv_catsv_nomg> are implemented in terms of this function.
3904 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3909 if ((spv = SvPV_const(ssv, slen))) {
3910 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3911 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3912 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3913 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3914 dsv->sv_flags doesn't have that bit set.
3915 Andy Dougherty 12 Oct 2001
3917 const I32 sutf8 = DO_UTF8(ssv);
3920 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3922 dutf8 = DO_UTF8(dsv);
3924 if (dutf8 != sutf8) {
3926 /* Not modifying source SV, so taking a temporary copy. */
3927 SV* csv = sv_2mortal(newSVpvn(spv, slen));
3929 sv_utf8_upgrade(csv);
3930 spv = SvPV_const(csv, slen);
3933 sv_utf8_upgrade_nomg(dsv);
3935 sv_catpvn_nomg(dsv, spv, slen);
3938 if (flags & SV_SMAGIC)
3943 =for apidoc sv_catpv
3945 Concatenates the string onto the end of the string which is in the SV.
3946 If the SV has the UTF-8 status set, then the bytes appended should be
3947 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3952 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3954 register STRLEN len;
3960 junk = SvPV_force(sv, tlen);
3962 SvGROW(sv, tlen + len + 1);
3964 ptr = SvPVX_const(sv);
3965 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3966 SvCUR_set(sv, SvCUR(sv) + len);
3967 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3972 =for apidoc sv_catpv_mg
3974 Like C<sv_catpv>, but also handles 'set' magic.
3980 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3989 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3990 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3997 Perl_newSV(pTHX_ STRLEN len)
4003 sv_upgrade(sv, SVt_PV);
4004 SvGROW(sv, len + 1);
4009 =for apidoc sv_magicext
4011 Adds magic to an SV, upgrading it if necessary. Applies the
4012 supplied vtable and returns a pointer to the magic added.
4014 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4015 In particular, you can add magic to SvREADONLY SVs, and add more than
4016 one instance of the same 'how'.
4018 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4019 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4020 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4021 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4023 (This is now used as a subroutine by C<sv_magic>.)
4028 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4029 const char* name, I32 namlen)
4033 if (SvTYPE(sv) < SVt_PVMG) {
4034 SvUPGRADE(sv, SVt_PVMG);
4036 Newxz(mg, 1, MAGIC);
4037 mg->mg_moremagic = SvMAGIC(sv);
4038 SvMAGIC_set(sv, mg);
4040 /* Sometimes a magic contains a reference loop, where the sv and
4041 object refer to each other. To prevent a reference loop that
4042 would prevent such objects being freed, we look for such loops
4043 and if we find one we avoid incrementing the object refcount.
4045 Note we cannot do this to avoid self-tie loops as intervening RV must
4046 have its REFCNT incremented to keep it in existence.
4049 if (!obj || obj == sv ||
4050 how == PERL_MAGIC_arylen ||
4051 how == PERL_MAGIC_qr ||
4052 how == PERL_MAGIC_symtab ||
4053 (SvTYPE(obj) == SVt_PVGV &&
4054 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4055 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4056 GvFORM(obj) == (CV*)sv)))
4061 mg->mg_obj = SvREFCNT_inc(obj);
4062 mg->mg_flags |= MGf_REFCOUNTED;
4065 /* Normal self-ties simply pass a null object, and instead of
4066 using mg_obj directly, use the SvTIED_obj macro to produce a
4067 new RV as needed. For glob "self-ties", we are tieing the PVIO
4068 with an RV obj pointing to the glob containing the PVIO. In
4069 this case, to avoid a reference loop, we need to weaken the
4073 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4074 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4080 mg->mg_len = namlen;
4083 mg->mg_ptr = savepvn(name, namlen);
4084 else if (namlen == HEf_SVKEY)
4085 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4087 mg->mg_ptr = (char *) name;
4089 mg->mg_virtual = vtable;
4093 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4098 =for apidoc sv_magic
4100 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4101 then adds a new magic item of type C<how> to the head of the magic list.
4103 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4104 handling of the C<name> and C<namlen> arguments.
4106 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4107 to add more than one instance of the same 'how'.
4113 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4115 const MGVTBL *vtable;
4118 #ifdef PERL_OLD_COPY_ON_WRITE
4120 sv_force_normal_flags(sv, 0);
4122 if (SvREADONLY(sv)) {
4124 /* its okay to attach magic to shared strings; the subsequent
4125 * upgrade to PVMG will unshare the string */
4126 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4129 && how != PERL_MAGIC_regex_global
4130 && how != PERL_MAGIC_bm
4131 && how != PERL_MAGIC_fm
4132 && how != PERL_MAGIC_sv
4133 && how != PERL_MAGIC_backref
4136 Perl_croak(aTHX_ PL_no_modify);
4139 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4140 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4141 /* sv_magic() refuses to add a magic of the same 'how' as an
4144 if (how == PERL_MAGIC_taint)
4152 vtable = &PL_vtbl_sv;
4154 case PERL_MAGIC_overload:
4155 vtable = &PL_vtbl_amagic;
4157 case PERL_MAGIC_overload_elem:
4158 vtable = &PL_vtbl_amagicelem;
4160 case PERL_MAGIC_overload_table:
4161 vtable = &PL_vtbl_ovrld;
4164 vtable = &PL_vtbl_bm;
4166 case PERL_MAGIC_regdata:
4167 vtable = &PL_vtbl_regdata;
4169 case PERL_MAGIC_regdatum:
4170 vtable = &PL_vtbl_regdatum;
4172 case PERL_MAGIC_env:
4173 vtable = &PL_vtbl_env;
4176 vtable = &PL_vtbl_fm;
4178 case PERL_MAGIC_envelem:
4179 vtable = &PL_vtbl_envelem;
4181 case PERL_MAGIC_regex_global:
4182 vtable = &PL_vtbl_mglob;
4184 case PERL_MAGIC_isa:
4185 vtable = &PL_vtbl_isa;
4187 case PERL_MAGIC_isaelem:
4188 vtable = &PL_vtbl_isaelem;
4190 case PERL_MAGIC_nkeys:
4191 vtable = &PL_vtbl_nkeys;
4193 case PERL_MAGIC_dbfile:
4196 case PERL_MAGIC_dbline:
4197 vtable = &PL_vtbl_dbline;
4199 #ifdef USE_LOCALE_COLLATE
4200 case PERL_MAGIC_collxfrm:
4201 vtable = &PL_vtbl_collxfrm;
4203 #endif /* USE_LOCALE_COLLATE */
4204 case PERL_MAGIC_tied:
4205 vtable = &PL_vtbl_pack;
4207 case PERL_MAGIC_tiedelem:
4208 case PERL_MAGIC_tiedscalar:
4209 vtable = &PL_vtbl_packelem;
4212 vtable = &PL_vtbl_regexp;
4214 case PERL_MAGIC_sig:
4215 vtable = &PL_vtbl_sig;
4217 case PERL_MAGIC_sigelem:
4218 vtable = &PL_vtbl_sigelem;
4220 case PERL_MAGIC_taint:
4221 vtable = &PL_vtbl_taint;
4223 case PERL_MAGIC_uvar:
4224 vtable = &PL_vtbl_uvar;
4226 case PERL_MAGIC_vec:
4227 vtable = &PL_vtbl_vec;
4229 case PERL_MAGIC_arylen_p:
4230 case PERL_MAGIC_rhash:
4231 case PERL_MAGIC_symtab:
4232 case PERL_MAGIC_vstring:
4235 case PERL_MAGIC_utf8:
4236 vtable = &PL_vtbl_utf8;
4238 case PERL_MAGIC_substr:
4239 vtable = &PL_vtbl_substr;
4241 case PERL_MAGIC_defelem:
4242 vtable = &PL_vtbl_defelem;
4244 case PERL_MAGIC_glob:
4245 vtable = &PL_vtbl_glob;
4247 case PERL_MAGIC_arylen:
4248 vtable = &PL_vtbl_arylen;
4250 case PERL_MAGIC_pos:
4251 vtable = &PL_vtbl_pos;
4253 case PERL_MAGIC_backref:
4254 vtable = &PL_vtbl_backref;
4256 case PERL_MAGIC_ext:
4257 /* Reserved for use by extensions not perl internals. */
4258 /* Useful for attaching extension internal data to perl vars. */
4259 /* Note that multiple extensions may clash if magical scalars */
4260 /* etc holding private data from one are passed to another. */
4264 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4267 /* Rest of work is done else where */
4268 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4271 case PERL_MAGIC_taint:
4274 case PERL_MAGIC_ext:
4275 case PERL_MAGIC_dbfile:
4282 =for apidoc sv_unmagic
4284 Removes all magic of type C<type> from an SV.
4290 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4294 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4297 for (mg = *mgp; mg; mg = *mgp) {
4298 if (mg->mg_type == type) {
4299 const MGVTBL* const vtbl = mg->mg_virtual;
4300 *mgp = mg->mg_moremagic;
4301 if (vtbl && vtbl->svt_free)
4302 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4303 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4305 Safefree(mg->mg_ptr);
4306 else if (mg->mg_len == HEf_SVKEY)
4307 SvREFCNT_dec((SV*)mg->mg_ptr);
4308 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4309 Safefree(mg->mg_ptr);
4311 if (mg->mg_flags & MGf_REFCOUNTED)
4312 SvREFCNT_dec(mg->mg_obj);
4316 mgp = &mg->mg_moremagic;
4320 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4327 =for apidoc sv_rvweaken
4329 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4330 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4331 push a back-reference to this RV onto the array of backreferences
4332 associated with that magic.
4338 Perl_sv_rvweaken(pTHX_ SV *sv)
4341 if (!SvOK(sv)) /* let undefs pass */
4344 Perl_croak(aTHX_ "Can't weaken a nonreference");
4345 else if (SvWEAKREF(sv)) {
4346 if (ckWARN(WARN_MISC))
4347 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4351 Perl_sv_add_backref(aTHX_ tsv, sv);
4357 /* Give tsv backref magic if it hasn't already got it, then push a
4358 * back-reference to sv onto the array associated with the backref magic.
4362 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4366 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4367 av = (AV*)mg->mg_obj;
4370 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4371 /* av now has a refcnt of 2, which avoids it getting freed
4372 * before us during global cleanup. The extra ref is removed
4373 * by magic_killbackrefs() when tsv is being freed */
4375 if (AvFILLp(av) >= AvMAX(av)) {
4376 av_extend(av, AvFILLp(av)+1);
4378 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4381 /* delete a back-reference to ourselves from the backref magic associated
4382 * with the SV we point to.
4386 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4392 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4393 if (PL_in_clean_all)
4396 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4397 Perl_croak(aTHX_ "panic: del_backref");
4398 av = (AV *)mg->mg_obj;
4400 /* We shouldn't be in here more than once, but for paranoia reasons lets
4402 for (i = AvFILLp(av); i >= 0; i--) {
4404 const SSize_t fill = AvFILLp(av);
4406 /* We weren't the last entry.
4407 An unordered list has this property that you can take the
4408 last element off the end to fill the hole, and it's still
4409 an unordered list :-)
4414 AvFILLp(av) = fill - 1;
4420 =for apidoc sv_insert
4422 Inserts a string at the specified offset/length within the SV. Similar to
4423 the Perl substr() function.
4429 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4433 register char *midend;
4434 register char *bigend;
4440 Perl_croak(aTHX_ "Can't modify non-existent substring");
4441 SvPV_force(bigstr, curlen);
4442 (void)SvPOK_only_UTF8(bigstr);
4443 if (offset + len > curlen) {
4444 SvGROW(bigstr, offset+len+1);
4445 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4446 SvCUR_set(bigstr, offset+len);
4450 i = littlelen - len;
4451 if (i > 0) { /* string might grow */
4452 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4453 mid = big + offset + len;
4454 midend = bigend = big + SvCUR(bigstr);
4457 while (midend > mid) /* shove everything down */
4458 *--bigend = *--midend;
4459 Move(little,big+offset,littlelen,char);
4460 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4465 Move(little,SvPVX(bigstr)+offset,len,char);
4470 big = SvPVX(bigstr);
4473 bigend = big + SvCUR(bigstr);
4475 if (midend > bigend)
4476 Perl_croak(aTHX_ "panic: sv_insert");
4478 if (mid - big > bigend - midend) { /* faster to shorten from end */
4480 Move(little, mid, littlelen,char);
4483 i = bigend - midend;
4485 Move(midend, mid, i,char);
4489 SvCUR_set(bigstr, mid - big);
4491 else if ((i = mid - big)) { /* faster from front */
4492 midend -= littlelen;
4494 sv_chop(bigstr,midend-i);
4499 Move(little, mid, littlelen,char);
4501 else if (littlelen) {
4502 midend -= littlelen;
4503 sv_chop(bigstr,midend);
4504 Move(little,midend,littlelen,char);
4507 sv_chop(bigstr,midend);
4513 =for apidoc sv_replace
4515 Make the first argument a copy of the second, then delete the original.
4516 The target SV physically takes over ownership of the body of the source SV
4517 and inherits its flags; however, the target keeps any magic it owns,
4518 and any magic in the source is discarded.
4519 Note that this is a rather specialist SV copying operation; most of the
4520 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4526 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4528 const U32 refcnt = SvREFCNT(sv);
4529 SV_CHECK_THINKFIRST_COW_DROP(sv);
4530 if (SvREFCNT(nsv) != 1) {
4531 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4532 UVuf " != 1)", (UV) SvREFCNT(nsv));
4534 if (SvMAGICAL(sv)) {
4538 sv_upgrade(nsv, SVt_PVMG);
4539 SvMAGIC_set(nsv, SvMAGIC(sv));
4540 SvFLAGS(nsv) |= SvMAGICAL(sv);
4542 SvMAGIC_set(sv, NULL);
4546 assert(!SvREFCNT(sv));
4547 #ifdef DEBUG_LEAKING_SCALARS
4548 sv->sv_flags = nsv->sv_flags;
4549 sv->sv_any = nsv->sv_any;
4550 sv->sv_refcnt = nsv->sv_refcnt;
4551 sv->sv_u = nsv->sv_u;
4553 StructCopy(nsv,sv,SV);
4555 /* Currently could join these into one piece of pointer arithmetic, but
4556 it would be unclear. */
4557 if(SvTYPE(sv) == SVt_IV)
4559 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4560 else if (SvTYPE(sv) == SVt_RV) {
4561 SvANY(sv) = &sv->sv_u.svu_rv;
4565 #ifdef PERL_OLD_COPY_ON_WRITE
4566 if (SvIsCOW_normal(nsv)) {
4567 /* We need to follow the pointers around the loop to make the
4568 previous SV point to sv, rather than nsv. */
4571 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4574 assert(SvPVX_const(current) == SvPVX_const(nsv));
4576 /* Make the SV before us point to the SV after us. */
4578 PerlIO_printf(Perl_debug_log, "previous is\n");
4580 PerlIO_printf(Perl_debug_log,
4581 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4582 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4584 SV_COW_NEXT_SV_SET(current, sv);
4587 SvREFCNT(sv) = refcnt;
4588 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4594 =for apidoc sv_clear
4596 Clear an SV: call any destructors, free up any memory used by the body,
4597 and free the body itself. The SV's head is I<not> freed, although
4598 its type is set to all 1's so that it won't inadvertently be assumed
4599 to be live during global destruction etc.
4600 This function should only be called when REFCNT is zero. Most of the time
4601 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4608 Perl_sv_clear(pTHX_ register SV *sv)
4611 const U32 type = SvTYPE(sv);
4612 const struct body_details *const sv_type_details
4613 = bodies_by_type + type;
4616 assert(SvREFCNT(sv) == 0);
4622 if (PL_defstash) { /* Still have a symbol table? */
4627 stash = SvSTASH(sv);
4628 destructor = StashHANDLER(stash,DESTROY);
4630 SV* const tmpref = newRV(sv);
4631 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4633 PUSHSTACKi(PERLSI_DESTROY);
4638 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4644 if(SvREFCNT(tmpref) < 2) {
4645 /* tmpref is not kept alive! */
4647 SvRV_set(tmpref, NULL);
4650 SvREFCNT_dec(tmpref);
4652 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4656 if (PL_in_clean_objs)
4657 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4659 /* DESTROY gave object new lease on life */
4665 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4666 SvOBJECT_off(sv); /* Curse the object. */
4667 if (type != SVt_PVIO)
4668 --PL_sv_objcount; /* XXX Might want something more general */
4671 if (type >= SVt_PVMG) {
4674 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4675 SvREFCNT_dec(SvSTASH(sv));
4680 IoIFP(sv) != PerlIO_stdin() &&
4681 IoIFP(sv) != PerlIO_stdout() &&
4682 IoIFP(sv) != PerlIO_stderr())
4684 io_close((IO*)sv, FALSE);
4686 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4687 PerlDir_close(IoDIRP(sv));
4688 IoDIRP(sv) = (DIR*)NULL;
4689 Safefree(IoTOP_NAME(sv));
4690 Safefree(IoFMT_NAME(sv));
4691 Safefree(IoBOTTOM_NAME(sv));
4706 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4707 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4708 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4709 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4711 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4712 SvREFCNT_dec(LvTARG(sv));
4716 Safefree(GvNAME(sv));
4717 /* If we're in a stash, we don't own a reference to it. However it does
4718 have a back reference to us, which needs to be cleared. */
4720 sv_del_backref((SV*)GvSTASH(sv), sv);
4725 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4727 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4728 /* Don't even bother with turning off the OOK flag. */
4733 SV *target = SvRV(sv);
4735 sv_del_backref(target, sv);
4737 SvREFCNT_dec(target);
4739 #ifdef PERL_OLD_COPY_ON_WRITE
4740 else if (SvPVX_const(sv)) {
4742 /* I believe I need to grab the global SV mutex here and
4743 then recheck the COW status. */
4745 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4748 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4749 SV_COW_NEXT_SV(sv));
4750 /* And drop it here. */
4752 } else if (SvLEN(sv)) {
4753 Safefree(SvPVX_const(sv));
4757 else if (SvPVX_const(sv) && SvLEN(sv))
4758 Safefree(SvPVX_mutable(sv));
4759 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4760 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4769 SvFLAGS(sv) &= SVf_BREAK;
4770 SvFLAGS(sv) |= SVTYPEMASK;
4772 if (sv_type_details->arena) {
4773 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4774 &PL_body_roots[type]);
4776 else if (sv_type_details->size) {
4777 my_safefree(SvANY(sv));
4782 =for apidoc sv_newref
4784 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4791 Perl_sv_newref(pTHX_ SV *sv)
4801 Decrement an SV's reference count, and if it drops to zero, call
4802 C<sv_clear> to invoke destructors and free up any memory used by
4803 the body; finally, deallocate the SV's head itself.
4804 Normally called via a wrapper macro C<SvREFCNT_dec>.
4810 Perl_sv_free(pTHX_ SV *sv)
4815 if (SvREFCNT(sv) == 0) {
4816 if (SvFLAGS(sv) & SVf_BREAK)
4817 /* this SV's refcnt has been artificially decremented to
4818 * trigger cleanup */
4820 if (PL_in_clean_all) /* All is fair */
4822 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4823 /* make sure SvREFCNT(sv)==0 happens very seldom */
4824 SvREFCNT(sv) = (~(U32)0)/2;
4827 if (ckWARN_d(WARN_INTERNAL)) {
4828 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4829 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4830 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4831 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4832 Perl_dump_sv_child(aTHX_ sv);
4837 if (--(SvREFCNT(sv)) > 0)
4839 Perl_sv_free2(aTHX_ sv);
4843 Perl_sv_free2(pTHX_ SV *sv)
4848 if (ckWARN_d(WARN_DEBUGGING))
4849 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4850 "Attempt to free temp prematurely: SV 0x%"UVxf
4851 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4855 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4856 /* make sure SvREFCNT(sv)==0 happens very seldom */
4857 SvREFCNT(sv) = (~(U32)0)/2;
4868 Returns the length of the string in the SV. Handles magic and type
4869 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4875 Perl_sv_len(pTHX_ register SV *sv)
4883 len = mg_length(sv);
4885 (void)SvPV_const(sv, len);
4890 =for apidoc sv_len_utf8
4892 Returns the number of characters in the string in an SV, counting wide
4893 UTF-8 bytes as a single character. Handles magic and type coercion.
4899 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4900 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4901 * (Note that the mg_len is not the length of the mg_ptr field.)
4906 Perl_sv_len_utf8(pTHX_ register SV *sv)
4912 return mg_length(sv);
4916 const U8 *s = (U8*)SvPV_const(sv, len);
4917 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4919 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4921 #ifdef PERL_UTF8_CACHE_ASSERT
4922 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4926 ulen = Perl_utf8_length(aTHX_ s, s + len);
4927 if (!mg && !SvREADONLY(sv)) {
4928 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4929 mg = mg_find(sv, PERL_MAGIC_utf8);
4939 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4940 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4941 * between UTF-8 and byte offsets. There are two (substr offset and substr
4942 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4943 * and byte offset) cache positions.
4945 * The mg_len field is used by sv_len_utf8(), see its comments.
4946 * Note that the mg_len is not the length of the mg_ptr field.
4950 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4951 I32 offsetp, const U8 *s, const U8 *start)
4955 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4957 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4961 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4963 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4964 (*mgp)->mg_ptr = (char *) *cachep;
4968 (*cachep)[i] = offsetp;
4969 (*cachep)[i+1] = s - start;
4977 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4978 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4979 * between UTF-8 and byte offsets. See also the comments of
4980 * S_utf8_mg_pos_init().
4984 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)
4988 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4990 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4991 if (*mgp && (*mgp)->mg_ptr) {
4992 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4993 ASSERT_UTF8_CACHE(*cachep);
4994 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4996 else { /* We will skip to the right spot. */
5001 /* The assumption is that going backward is half
5002 * the speed of going forward (that's where the
5003 * 2 * backw in the below comes from). (The real
5004 * figure of course depends on the UTF-8 data.) */
5006 if ((*cachep)[i] > (STRLEN)uoff) {
5008 backw = (*cachep)[i] - (STRLEN)uoff;
5010 if (forw < 2 * backw)
5013 p = start + (*cachep)[i+1];
5015 /* Try this only for the substr offset (i == 0),
5016 * not for the substr length (i == 2). */
5017 else if (i == 0) { /* (*cachep)[i] < uoff */
5018 const STRLEN ulen = sv_len_utf8(sv);
5020 if ((STRLEN)uoff < ulen) {
5021 forw = (STRLEN)uoff - (*cachep)[i];
5022 backw = ulen - (STRLEN)uoff;
5024 if (forw < 2 * backw)
5025 p = start + (*cachep)[i+1];
5030 /* If the string is not long enough for uoff,
5031 * we could extend it, but not at this low a level. */
5035 if (forw < 2 * backw) {
5042 while (UTF8_IS_CONTINUATION(*p))
5047 /* Update the cache. */
5048 (*cachep)[i] = (STRLEN)uoff;
5049 (*cachep)[i+1] = p - start;
5051 /* Drop the stale "length" cache */
5060 if (found) { /* Setup the return values. */
5061 *offsetp = (*cachep)[i+1];
5062 *sp = start + *offsetp;
5065 *offsetp = send - start;
5067 else if (*sp < start) {
5073 #ifdef PERL_UTF8_CACHE_ASSERT
5078 while (n-- && s < send)
5082 assert(*offsetp == s - start);
5083 assert((*cachep)[0] == (STRLEN)uoff);
5084 assert((*cachep)[1] == *offsetp);
5086 ASSERT_UTF8_CACHE(*cachep);
5095 =for apidoc sv_pos_u2b
5097 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5098 the start of the string, to a count of the equivalent number of bytes; if
5099 lenp is non-zero, it does the same to lenp, but this time starting from
5100 the offset, rather than from the start of the string. Handles magic and
5107 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5108 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5109 * byte offsets. See also the comments of S_utf8_mg_pos().
5114 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5122 start = (U8*)SvPV_const(sv, len);
5126 const U8 *s = start;
5127 I32 uoffset = *offsetp;
5128 const U8 * const send = s + len;
5132 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5134 if (!found && uoffset > 0) {
5135 while (s < send && uoffset--)
5139 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5141 *offsetp = s - start;
5146 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5150 if (!found && *lenp > 0) {
5153 while (s < send && ulen--)
5157 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5161 ASSERT_UTF8_CACHE(cache);
5173 =for apidoc sv_pos_b2u
5175 Converts the value pointed to by offsetp from a count of bytes from the
5176 start of the string, to a count of the equivalent number of UTF-8 chars.
5177 Handles magic and type coercion.
5183 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5184 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5185 * byte offsets. See also the comments of S_utf8_mg_pos().
5190 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5198 s = (const U8*)SvPV_const(sv, len);
5199 if ((I32)len < *offsetp)
5200 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5202 const U8* send = s + *offsetp;
5204 STRLEN *cache = NULL;
5208 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5209 mg = mg_find(sv, PERL_MAGIC_utf8);
5210 if (mg && mg->mg_ptr) {
5211 cache = (STRLEN *) mg->mg_ptr;
5212 if (cache[1] == (STRLEN)*offsetp) {
5213 /* An exact match. */
5214 *offsetp = cache[0];
5218 else if (cache[1] < (STRLEN)*offsetp) {
5219 /* We already know part of the way. */
5222 /* Let the below loop do the rest. */
5224 else { /* cache[1] > *offsetp */
5225 /* We already know all of the way, now we may
5226 * be able to walk back. The same assumption
5227 * is made as in S_utf8_mg_pos(), namely that
5228 * walking backward is twice slower than
5229 * walking forward. */
5230 const STRLEN forw = *offsetp;
5231 STRLEN backw = cache[1] - *offsetp;
5233 if (!(forw < 2 * backw)) {
5234 const U8 *p = s + cache[1];
5241 while (UTF8_IS_CONTINUATION(*p)) {
5249 *offsetp = cache[0];
5251 /* Drop the stale "length" cache */
5259 ASSERT_UTF8_CACHE(cache);
5265 /* Call utf8n_to_uvchr() to validate the sequence
5266 * (unless a simple non-UTF character) */
5267 if (!UTF8_IS_INVARIANT(*s))
5268 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5277 if (!SvREADONLY(sv)) {
5279 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5280 mg = mg_find(sv, PERL_MAGIC_utf8);
5285 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5286 mg->mg_ptr = (char *) cache;
5291 cache[1] = *offsetp;
5292 /* Drop the stale "length" cache */
5305 Returns a boolean indicating whether the strings in the two SVs are
5306 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5307 coerce its args to strings if necessary.
5313 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5321 SV* svrecode = Nullsv;
5328 pv1 = SvPV_const(sv1, cur1);
5335 pv2 = SvPV_const(sv2, cur2);
5337 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5338 /* Differing utf8ness.
5339 * Do not UTF8size the comparands as a side-effect. */
5342 svrecode = newSVpvn(pv2, cur2);
5343 sv_recode_to_utf8(svrecode, PL_encoding);
5344 pv2 = SvPV_const(svrecode, cur2);
5347 svrecode = newSVpvn(pv1, cur1);
5348 sv_recode_to_utf8(svrecode, PL_encoding);
5349 pv1 = SvPV_const(svrecode, cur1);
5351 /* Now both are in UTF-8. */
5353 SvREFCNT_dec(svrecode);
5358 bool is_utf8 = TRUE;
5361 /* sv1 is the UTF-8 one,
5362 * if is equal it must be downgrade-able */
5363 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5369 /* sv2 is the UTF-8 one,
5370 * if is equal it must be downgrade-able */
5371 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5377 /* Downgrade not possible - cannot be eq */
5385 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5388 SvREFCNT_dec(svrecode);
5399 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5400 string in C<sv1> is less than, equal to, or greater than the string in
5401 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5402 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5408 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5411 const char *pv1, *pv2;
5414 SV *svrecode = Nullsv;
5421 pv1 = SvPV_const(sv1, cur1);
5428 pv2 = SvPV_const(sv2, cur2);
5430 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5431 /* Differing utf8ness.
5432 * Do not UTF8size the comparands as a side-effect. */
5435 svrecode = newSVpvn(pv2, cur2);
5436 sv_recode_to_utf8(svrecode, PL_encoding);
5437 pv2 = SvPV_const(svrecode, cur2);
5440 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5445 svrecode = newSVpvn(pv1, cur1);
5446 sv_recode_to_utf8(svrecode, PL_encoding);
5447 pv1 = SvPV_const(svrecode, cur1);
5450 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5456 cmp = cur2 ? -1 : 0;
5460 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5463 cmp = retval < 0 ? -1 : 1;
5464 } else if (cur1 == cur2) {
5467 cmp = cur1 < cur2 ? -1 : 1;
5472 SvREFCNT_dec(svrecode);
5481 =for apidoc sv_cmp_locale
5483 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5484 'use bytes' aware, handles get magic, and will coerce its args to strings
5485 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5491 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5493 #ifdef USE_LOCALE_COLLATE
5499 if (PL_collation_standard)
5503 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5505 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5507 if (!pv1 || !len1) {
5518 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5521 return retval < 0 ? -1 : 1;
5524 * When the result of collation is equality, that doesn't mean
5525 * that there are no differences -- some locales exclude some
5526 * characters from consideration. So to avoid false equalities,
5527 * we use the raw string as a tiebreaker.
5533 #endif /* USE_LOCALE_COLLATE */
5535 return sv_cmp(sv1, sv2);
5539 #ifdef USE_LOCALE_COLLATE
5542 =for apidoc sv_collxfrm
5544 Add Collate Transform magic to an SV if it doesn't already have it.
5546 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5547 scalar data of the variable, but transformed to such a format that a normal
5548 memory comparison can be used to compare the data according to the locale
5555 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5559 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5560 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5566 Safefree(mg->mg_ptr);
5567 s = SvPV_const(sv, len);
5568 if ((xf = mem_collxfrm(s, len, &xlen))) {
5569 if (SvREADONLY(sv)) {
5572 return xf + sizeof(PL_collation_ix);
5575 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5576 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5589 if (mg && mg->mg_ptr) {
5591 return mg->mg_ptr + sizeof(PL_collation_ix);
5599 #endif /* USE_LOCALE_COLLATE */
5604 Get a line from the filehandle and store it into the SV, optionally
5605 appending to the currently-stored string.
5611 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5615 register STDCHAR rslast;
5616 register STDCHAR *bp;
5622 if (SvTHINKFIRST(sv))
5623 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5624 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5626 However, perlbench says it's slower, because the existing swipe code
5627 is faster than copy on write.
5628 Swings and roundabouts. */
5629 SvUPGRADE(sv, SVt_PV);
5634 if (PerlIO_isutf8(fp)) {
5636 sv_utf8_upgrade_nomg(sv);
5637 sv_pos_u2b(sv,&append,0);
5639 } else if (SvUTF8(sv)) {
5640 SV * const tsv = NEWSV(0,0);
5641 sv_gets(tsv, fp, 0);
5642 sv_utf8_upgrade_nomg(tsv);
5643 SvCUR_set(sv,append);
5646 goto return_string_or_null;
5651 if (PerlIO_isutf8(fp))
5654 if (IN_PERL_COMPILETIME) {
5655 /* we always read code in line mode */
5659 else if (RsSNARF(PL_rs)) {
5660 /* If it is a regular disk file use size from stat() as estimate
5661 of amount we are going to read - may result in malloc-ing
5662 more memory than we realy need if layers bellow reduce
5663 size we read (e.g. CRLF or a gzip layer)
5666 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5667 const Off_t offset = PerlIO_tell(fp);
5668 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5669 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5675 else if (RsRECORD(PL_rs)) {
5679 /* Grab the size of the record we're getting */
5680 recsize = SvIV(SvRV(PL_rs));
5681 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5684 /* VMS wants read instead of fread, because fread doesn't respect */
5685 /* RMS record boundaries. This is not necessarily a good thing to be */
5686 /* doing, but we've got no other real choice - except avoid stdio
5687 as implementation - perhaps write a :vms layer ?
5689 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5691 bytesread = PerlIO_read(fp, buffer, recsize);
5695 SvCUR_set(sv, bytesread += append);
5696 buffer[bytesread] = '\0';
5697 goto return_string_or_null;
5699 else if (RsPARA(PL_rs)) {
5705 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5706 if (PerlIO_isutf8(fp)) {
5707 rsptr = SvPVutf8(PL_rs, rslen);
5710 if (SvUTF8(PL_rs)) {
5711 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5712 Perl_croak(aTHX_ "Wide character in $/");
5715 rsptr = SvPV_const(PL_rs, rslen);
5719 rslast = rslen ? rsptr[rslen - 1] : '\0';
5721 if (rspara) { /* have to do this both before and after */
5722 do { /* to make sure file boundaries work right */
5725 i = PerlIO_getc(fp);
5729 PerlIO_ungetc(fp,i);
5735 /* See if we know enough about I/O mechanism to cheat it ! */
5737 /* This used to be #ifdef test - it is made run-time test for ease
5738 of abstracting out stdio interface. One call should be cheap
5739 enough here - and may even be a macro allowing compile
5743 if (PerlIO_fast_gets(fp)) {
5746 * We're going to steal some values from the stdio struct
5747 * and put EVERYTHING in the innermost loop into registers.
5749 register STDCHAR *ptr;
5753 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5754 /* An ungetc()d char is handled separately from the regular
5755 * buffer, so we getc() it back out and stuff it in the buffer.
5757 i = PerlIO_getc(fp);
5758 if (i == EOF) return 0;
5759 *(--((*fp)->_ptr)) = (unsigned char) i;
5763 /* Here is some breathtakingly efficient cheating */
5765 cnt = PerlIO_get_cnt(fp); /* get count into register */
5766 /* make sure we have the room */
5767 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5768 /* Not room for all of it
5769 if we are looking for a separator and room for some
5771 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5772 /* just process what we have room for */
5773 shortbuffered = cnt - SvLEN(sv) + append + 1;
5774 cnt -= shortbuffered;
5778 /* remember that cnt can be negative */
5779 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5784 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5785 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5786 DEBUG_P(PerlIO_printf(Perl_debug_log,
5787 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5788 DEBUG_P(PerlIO_printf(Perl_debug_log,
5789 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5790 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5791 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5796 while (cnt > 0) { /* this | eat */
5798 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5799 goto thats_all_folks; /* screams | sed :-) */
5803 Copy(ptr, bp, cnt, char); /* this | eat */
5804 bp += cnt; /* screams | dust */
5805 ptr += cnt; /* louder | sed :-) */
5810 if (shortbuffered) { /* oh well, must extend */
5811 cnt = shortbuffered;
5813 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5815 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5816 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5820 DEBUG_P(PerlIO_printf(Perl_debug_log,
5821 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5822 PTR2UV(ptr),(long)cnt));
5823 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5825 DEBUG_P(PerlIO_printf(Perl_debug_log,
5826 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5827 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5828 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5830 /* This used to call 'filbuf' in stdio form, but as that behaves like
5831 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5832 another abstraction. */
5833 i = PerlIO_getc(fp); /* get more characters */
5835 DEBUG_P(PerlIO_printf(Perl_debug_log,
5836 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5837 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5838 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5840 cnt = PerlIO_get_cnt(fp);
5841 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5842 DEBUG_P(PerlIO_printf(Perl_debug_log,
5843 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5845 if (i == EOF) /* all done for ever? */
5846 goto thats_really_all_folks;
5848 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5850 SvGROW(sv, bpx + cnt + 2);
5851 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5853 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5855 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5856 goto thats_all_folks;
5860 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5861 memNE((char*)bp - rslen, rsptr, rslen))
5862 goto screamer; /* go back to the fray */
5863 thats_really_all_folks:
5865 cnt += shortbuffered;
5866 DEBUG_P(PerlIO_printf(Perl_debug_log,
5867 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5868 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5869 DEBUG_P(PerlIO_printf(Perl_debug_log,
5870 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5871 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5872 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5874 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5875 DEBUG_P(PerlIO_printf(Perl_debug_log,
5876 "Screamer: done, len=%ld, string=|%.*s|\n",
5877 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5881 /*The big, slow, and stupid way. */
5882 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5884 Newx(buf, 8192, STDCHAR);
5892 register const STDCHAR *bpe = buf + sizeof(buf);
5894 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5895 ; /* keep reading */
5899 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5900 /* Accomodate broken VAXC compiler, which applies U8 cast to
5901 * both args of ?: operator, causing EOF to change into 255
5904 i = (U8)buf[cnt - 1];
5910 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5912 sv_catpvn(sv, (char *) buf, cnt);
5914 sv_setpvn(sv, (char *) buf, cnt);
5916 if (i != EOF && /* joy */
5918 SvCUR(sv) < rslen ||
5919 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5923 * If we're reading from a TTY and we get a short read,
5924 * indicating that the user hit his EOF character, we need
5925 * to notice it now, because if we try to read from the TTY
5926 * again, the EOF condition will disappear.
5928 * The comparison of cnt to sizeof(buf) is an optimization
5929 * that prevents unnecessary calls to feof().
5933 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5937 #ifdef USE_HEAP_INSTEAD_OF_STACK
5942 if (rspara) { /* have to do this both before and after */
5943 while (i != EOF) { /* to make sure file boundaries work right */
5944 i = PerlIO_getc(fp);
5946 PerlIO_ungetc(fp,i);
5952 return_string_or_null:
5953 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5959 Auto-increment of the value in the SV, doing string to numeric conversion
5960 if necessary. Handles 'get' magic.
5966 Perl_sv_inc(pTHX_ register SV *sv)
5974 if (SvTHINKFIRST(sv)) {
5976 sv_force_normal_flags(sv, 0);
5977 if (SvREADONLY(sv)) {
5978 if (IN_PERL_RUNTIME)
5979 Perl_croak(aTHX_ PL_no_modify);
5983 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5985 i = PTR2IV(SvRV(sv));
5990 flags = SvFLAGS(sv);
5991 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5992 /* It's (privately or publicly) a float, but not tested as an
5993 integer, so test it to see. */
5995 flags = SvFLAGS(sv);
5997 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5998 /* It's publicly an integer, or privately an integer-not-float */
5999 #ifdef PERL_PRESERVE_IVUV
6003 if (SvUVX(sv) == UV_MAX)
6004 sv_setnv(sv, UV_MAX_P1);
6006 (void)SvIOK_only_UV(sv);
6007 SvUV_set(sv, SvUVX(sv) + 1);
6009 if (SvIVX(sv) == IV_MAX)
6010 sv_setuv(sv, (UV)IV_MAX + 1);
6012 (void)SvIOK_only(sv);
6013 SvIV_set(sv, SvIVX(sv) + 1);
6018 if (flags & SVp_NOK) {
6019 (void)SvNOK_only(sv);
6020 SvNV_set(sv, SvNVX(sv) + 1.0);
6024 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6025 if ((flags & SVTYPEMASK) < SVt_PVIV)
6026 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6027 (void)SvIOK_only(sv);
6032 while (isALPHA(*d)) d++;
6033 while (isDIGIT(*d)) d++;
6035 #ifdef PERL_PRESERVE_IVUV
6036 /* Got to punt this as an integer if needs be, but we don't issue
6037 warnings. Probably ought to make the sv_iv_please() that does
6038 the conversion if possible, and silently. */
6039 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6040 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6041 /* Need to try really hard to see if it's an integer.
6042 9.22337203685478e+18 is an integer.
6043 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6044 so $a="9.22337203685478e+18"; $a+0; $a++
6045 needs to be the same as $a="9.22337203685478e+18"; $a++
6052 /* sv_2iv *should* have made this an NV */
6053 if (flags & SVp_NOK) {
6054 (void)SvNOK_only(sv);
6055 SvNV_set(sv, SvNVX(sv) + 1.0);
6058 /* I don't think we can get here. Maybe I should assert this
6059 And if we do get here I suspect that sv_setnv will croak. NWC
6061 #if defined(USE_LONG_DOUBLE)
6062 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",
6063 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6065 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6066 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6069 #endif /* PERL_PRESERVE_IVUV */
6070 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6074 while (d >= SvPVX_const(sv)) {
6082 /* MKS: The original code here died if letters weren't consecutive.
6083 * at least it didn't have to worry about non-C locales. The
6084 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6085 * arranged in order (although not consecutively) and that only
6086 * [A-Za-z] are accepted by isALPHA in the C locale.
6088 if (*d != 'z' && *d != 'Z') {
6089 do { ++*d; } while (!isALPHA(*d));
6092 *(d--) -= 'z' - 'a';
6097 *(d--) -= 'z' - 'a' + 1;
6101 /* oh,oh, the number grew */
6102 SvGROW(sv, SvCUR(sv) + 2);
6103 SvCUR_set(sv, SvCUR(sv) + 1);
6104 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6115 Auto-decrement of the value in the SV, doing string to numeric conversion
6116 if necessary. Handles 'get' magic.
6122 Perl_sv_dec(pTHX_ register SV *sv)
6129 if (SvTHINKFIRST(sv)) {
6131 sv_force_normal_flags(sv, 0);
6132 if (SvREADONLY(sv)) {
6133 if (IN_PERL_RUNTIME)
6134 Perl_croak(aTHX_ PL_no_modify);
6138 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6140 i = PTR2IV(SvRV(sv));
6145 /* Unlike sv_inc we don't have to worry about string-never-numbers
6146 and keeping them magic. But we mustn't warn on punting */
6147 flags = SvFLAGS(sv);
6148 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6149 /* It's publicly an integer, or privately an integer-not-float */
6150 #ifdef PERL_PRESERVE_IVUV
6154 if (SvUVX(sv) == 0) {
6155 (void)SvIOK_only(sv);
6159 (void)SvIOK_only_UV(sv);
6160 SvUV_set(sv, SvUVX(sv) - 1);
6163 if (SvIVX(sv) == IV_MIN)
6164 sv_setnv(sv, (NV)IV_MIN - 1.0);
6166 (void)SvIOK_only(sv);
6167 SvIV_set(sv, SvIVX(sv) - 1);
6172 if (flags & SVp_NOK) {
6173 SvNV_set(sv, SvNVX(sv) - 1.0);
6174 (void)SvNOK_only(sv);
6177 if (!(flags & SVp_POK)) {
6178 if ((flags & SVTYPEMASK) < SVt_PVIV)
6179 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6181 (void)SvIOK_only(sv);
6184 #ifdef PERL_PRESERVE_IVUV
6186 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6187 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6188 /* Need to try really hard to see if it's an integer.
6189 9.22337203685478e+18 is an integer.
6190 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6191 so $a="9.22337203685478e+18"; $a+0; $a--
6192 needs to be the same as $a="9.22337203685478e+18"; $a--
6199 /* sv_2iv *should* have made this an NV */
6200 if (flags & SVp_NOK) {
6201 (void)SvNOK_only(sv);
6202 SvNV_set(sv, SvNVX(sv) - 1.0);
6205 /* I don't think we can get here. Maybe I should assert this
6206 And if we do get here I suspect that sv_setnv will croak. NWC
6208 #if defined(USE_LONG_DOUBLE)
6209 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",
6210 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6212 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6213 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6217 #endif /* PERL_PRESERVE_IVUV */
6218 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6222 =for apidoc sv_mortalcopy
6224 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6225 The new SV is marked as mortal. It will be destroyed "soon", either by an
6226 explicit call to FREETMPS, or by an implicit call at places such as
6227 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6232 /* Make a string that will exist for the duration of the expression
6233 * evaluation. Actually, it may have to last longer than that, but
6234 * hopefully we won't free it until it has been assigned to a
6235 * permanent location. */
6238 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6243 sv_setsv(sv,oldstr);
6245 PL_tmps_stack[++PL_tmps_ix] = sv;
6251 =for apidoc sv_newmortal
6253 Creates a new null SV which is mortal. The reference count of the SV is
6254 set to 1. It will be destroyed "soon", either by an explicit call to
6255 FREETMPS, or by an implicit call at places such as statement boundaries.
6256 See also C<sv_mortalcopy> and C<sv_2mortal>.
6262 Perl_sv_newmortal(pTHX)
6267 SvFLAGS(sv) = SVs_TEMP;
6269 PL_tmps_stack[++PL_tmps_ix] = sv;
6274 =for apidoc sv_2mortal
6276 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6277 by an explicit call to FREETMPS, or by an implicit call at places such as
6278 statement boundaries. SvTEMP() is turned on which means that the SV's
6279 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6280 and C<sv_mortalcopy>.
6286 Perl_sv_2mortal(pTHX_ register SV *sv)
6291 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6294 PL_tmps_stack[++PL_tmps_ix] = sv;
6302 Creates a new SV and copies a string into it. The reference count for the
6303 SV is set to 1. If C<len> is zero, Perl will compute the length using
6304 strlen(). For efficiency, consider using C<newSVpvn> instead.
6310 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6315 sv_setpvn(sv,s,len ? len : strlen(s));
6320 =for apidoc newSVpvn
6322 Creates a new SV and copies a string into it. The reference count for the
6323 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6324 string. You are responsible for ensuring that the source string is at least
6325 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6331 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6336 sv_setpvn(sv,s,len);
6342 =for apidoc newSVhek
6344 Creates a new SV from the hash key structure. It will generate scalars that
6345 point to the shared string table where possible. Returns a new (undefined)
6346 SV if the hek is NULL.
6352 Perl_newSVhek(pTHX_ const HEK *hek)
6361 if (HEK_LEN(hek) == HEf_SVKEY) {
6362 return newSVsv(*(SV**)HEK_KEY(hek));
6364 const int flags = HEK_FLAGS(hek);
6365 if (flags & HVhek_WASUTF8) {
6367 Andreas would like keys he put in as utf8 to come back as utf8
6369 STRLEN utf8_len = HEK_LEN(hek);
6370 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6371 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6374 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6376 } else if (flags & HVhek_REHASH) {
6377 /* We don't have a pointer to the hv, so we have to replicate the
6378 flag into every HEK. This hv is using custom a hasing
6379 algorithm. Hence we can't return a shared string scalar, as
6380 that would contain the (wrong) hash value, and might get passed
6381 into an hv routine with a regular hash */
6383 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6388 /* This will be overwhelminly the most common case. */
6389 return newSVpvn_share(HEK_KEY(hek),
6390 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6396 =for apidoc newSVpvn_share
6398 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6399 table. If the string does not already exist in the table, it is created
6400 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6401 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6402 otherwise the hash is computed. The idea here is that as the string table
6403 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6404 hash lookup will avoid string compare.
6410 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6413 bool is_utf8 = FALSE;
6415 STRLEN tmplen = -len;
6417 /* See the note in hv.c:hv_fetch() --jhi */
6418 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6422 PERL_HASH(hash, src, len);
6424 sv_upgrade(sv, SVt_PV);
6425 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6437 #if defined(PERL_IMPLICIT_CONTEXT)
6439 /* pTHX_ magic can't cope with varargs, so this is a no-context
6440 * version of the main function, (which may itself be aliased to us).
6441 * Don't access this version directly.
6445 Perl_newSVpvf_nocontext(const char* pat, ...)
6450 va_start(args, pat);
6451 sv = vnewSVpvf(pat, &args);
6458 =for apidoc newSVpvf
6460 Creates a new SV and initializes it with the string formatted like
6467 Perl_newSVpvf(pTHX_ const char* pat, ...)
6471 va_start(args, pat);
6472 sv = vnewSVpvf(pat, &args);
6477 /* backend for newSVpvf() and newSVpvf_nocontext() */
6480 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6484 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6491 Creates a new SV and copies a floating point value into it.
6492 The reference count for the SV is set to 1.
6498 Perl_newSVnv(pTHX_ NV n)
6510 Creates a new SV and copies an integer into it. The reference count for the
6517 Perl_newSViv(pTHX_ IV i)
6529 Creates a new SV and copies an unsigned integer into it.
6530 The reference count for the SV is set to 1.
6536 Perl_newSVuv(pTHX_ UV u)
6546 =for apidoc newRV_noinc
6548 Creates an RV wrapper for an SV. The reference count for the original
6549 SV is B<not> incremented.
6555 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6560 sv_upgrade(sv, SVt_RV);
6562 SvRV_set(sv, tmpRef);
6567 /* newRV_inc is the official function name to use now.
6568 * newRV_inc is in fact #defined to newRV in sv.h
6572 Perl_newRV(pTHX_ SV *tmpRef)
6574 return newRV_noinc(SvREFCNT_inc(tmpRef));
6580 Creates a new SV which is an exact duplicate of the original SV.
6587 Perl_newSVsv(pTHX_ register SV *old)
6593 if (SvTYPE(old) == SVTYPEMASK) {
6594 if (ckWARN_d(WARN_INTERNAL))
6595 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6599 /* SV_GMAGIC is the default for sv_setv()
6600 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6601 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6602 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6607 =for apidoc sv_reset
6609 Underlying implementation for the C<reset> Perl function.
6610 Note that the perl-level function is vaguely deprecated.
6616 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6619 char todo[PERL_UCHAR_MAX+1];
6624 if (!*s) { /* reset ?? searches */
6625 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6627 PMOP *pm = (PMOP *) mg->mg_obj;
6629 pm->op_pmdynflags &= ~PMdf_USED;
6636 /* reset variables */
6638 if (!HvARRAY(stash))
6641 Zero(todo, 256, char);
6644 I32 i = (unsigned char)*s;
6648 max = (unsigned char)*s++;
6649 for ( ; i <= max; i++) {
6652 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6654 for (entry = HvARRAY(stash)[i];
6656 entry = HeNEXT(entry))
6661 if (!todo[(U8)*HeKEY(entry)])
6663 gv = (GV*)HeVAL(entry);
6666 if (SvTHINKFIRST(sv)) {
6667 if (!SvREADONLY(sv) && SvROK(sv))
6669 /* XXX Is this continue a bug? Why should THINKFIRST
6670 exempt us from resetting arrays and hashes? */
6674 if (SvTYPE(sv) >= SVt_PV) {
6676 if (SvPVX_const(sv) != Nullch)
6684 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6686 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6689 # if defined(USE_ENVIRON_ARRAY)
6692 # endif /* USE_ENVIRON_ARRAY */
6703 Using various gambits, try to get an IO from an SV: the IO slot if its a
6704 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6705 named after the PV if we're a string.
6711 Perl_sv_2io(pTHX_ SV *sv)
6716 switch (SvTYPE(sv)) {
6724 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6728 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6730 return sv_2io(SvRV(sv));
6731 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6737 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6746 Using various gambits, try to get a CV from an SV; in addition, try if
6747 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6753 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6760 return *gvp = Nullgv, Nullcv;
6761 switch (SvTYPE(sv)) {
6779 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6780 tryAMAGICunDEREF(to_cv);
6783 if (SvTYPE(sv) == SVt_PVCV) {
6792 Perl_croak(aTHX_ "Not a subroutine reference");
6797 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6803 if (lref && !GvCVu(gv)) {
6806 tmpsv = NEWSV(704,0);
6807 gv_efullname3(tmpsv, gv, Nullch);
6808 /* XXX this is probably not what they think they're getting.
6809 * It has the same effect as "sub name;", i.e. just a forward
6811 newSUB(start_subparse(FALSE, 0),
6812 newSVOP(OP_CONST, 0, tmpsv),
6817 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6827 Returns true if the SV has a true value by Perl's rules.
6828 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6829 instead use an in-line version.
6835 Perl_sv_true(pTHX_ register SV *sv)
6840 register const XPV* const tXpv = (XPV*)SvANY(sv);
6842 (tXpv->xpv_cur > 1 ||
6843 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6850 return SvIVX(sv) != 0;
6853 return SvNVX(sv) != 0.0;
6855 return sv_2bool(sv);
6861 =for apidoc sv_pvn_force
6863 Get a sensible string out of the SV somehow.
6864 A private implementation of the C<SvPV_force> macro for compilers which
6865 can't cope with complex macro expressions. Always use the macro instead.
6867 =for apidoc sv_pvn_force_flags
6869 Get a sensible string out of the SV somehow.
6870 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6871 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6872 implemented in terms of this function.
6873 You normally want to use the various wrapper macros instead: see
6874 C<SvPV_force> and C<SvPV_force_nomg>
6880 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6883 if (SvTHINKFIRST(sv) && !SvROK(sv))
6884 sv_force_normal_flags(sv, 0);
6894 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6895 const char * const ref = sv_reftype(sv,0);
6897 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6898 ref, OP_NAME(PL_op));
6900 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6902 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6903 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6905 s = sv_2pv_flags(sv, &len, flags);
6909 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6912 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6913 SvGROW(sv, len + 1);
6914 Move(s,SvPVX(sv),len,char);
6919 SvPOK_on(sv); /* validate pointer */
6921 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6922 PTR2UV(sv),SvPVX_const(sv)));
6925 return SvPVX_mutable(sv);
6929 =for apidoc sv_pvbyten_force
6931 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6937 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6939 sv_pvn_force(sv,lp);
6940 sv_utf8_downgrade(sv,0);
6946 =for apidoc sv_pvutf8n_force
6948 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6954 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6956 sv_pvn_force(sv,lp);
6957 sv_utf8_upgrade(sv);
6963 =for apidoc sv_reftype
6965 Returns a string describing what the SV is a reference to.
6971 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6973 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6974 inside return suggests a const propagation bug in g++. */
6975 if (ob && SvOBJECT(sv)) {
6976 char * const name = HvNAME_get(SvSTASH(sv));
6977 return name ? name : (char *) "__ANON__";
6980 switch (SvTYPE(sv)) {
6997 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6998 /* tied lvalues should appear to be
6999 * scalars for backwards compatitbility */
7000 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7001 ? "SCALAR" : "LVALUE");
7002 case SVt_PVAV: return "ARRAY";
7003 case SVt_PVHV: return "HASH";
7004 case SVt_PVCV: return "CODE";
7005 case SVt_PVGV: return "GLOB";
7006 case SVt_PVFM: return "FORMAT";
7007 case SVt_PVIO: return "IO";
7008 default: return "UNKNOWN";
7014 =for apidoc sv_isobject
7016 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7017 object. If the SV is not an RV, or if the object is not blessed, then this
7024 Perl_sv_isobject(pTHX_ SV *sv)
7040 Returns a boolean indicating whether the SV is blessed into the specified
7041 class. This does not check for subtypes; use C<sv_derived_from> to verify
7042 an inheritance relationship.
7048 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7059 hvname = HvNAME_get(SvSTASH(sv));
7063 return strEQ(hvname, name);
7069 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7070 it will be upgraded to one. If C<classname> is non-null then the new SV will
7071 be blessed in the specified package. The new SV is returned and its
7072 reference count is 1.
7078 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7084 SV_CHECK_THINKFIRST_COW_DROP(rv);
7087 if (SvTYPE(rv) >= SVt_PVMG) {
7088 const U32 refcnt = SvREFCNT(rv);
7092 SvREFCNT(rv) = refcnt;
7095 if (SvTYPE(rv) < SVt_RV)
7096 sv_upgrade(rv, SVt_RV);
7097 else if (SvTYPE(rv) > SVt_RV) {
7108 HV* const stash = gv_stashpv(classname, TRUE);
7109 (void)sv_bless(rv, stash);
7115 =for apidoc sv_setref_pv
7117 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7118 argument will be upgraded to an RV. That RV will be modified to point to
7119 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7120 into the SV. The C<classname> argument indicates the package for the
7121 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7122 will have a reference count of 1, and the RV will be returned.
7124 Do not use with other Perl types such as HV, AV, SV, CV, because those
7125 objects will become corrupted by the pointer copy process.
7127 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7133 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7136 sv_setsv(rv, &PL_sv_undef);
7140 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7145 =for apidoc sv_setref_iv
7147 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7148 argument will be upgraded to an RV. That RV will be modified to point to
7149 the new SV. The C<classname> argument indicates the package for the
7150 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7151 will have a reference count of 1, and the RV will be returned.
7157 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7159 sv_setiv(newSVrv(rv,classname), iv);
7164 =for apidoc sv_setref_uv
7166 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7167 argument will be upgraded to an RV. That RV will be modified to point to
7168 the new SV. The C<classname> argument indicates the package for the
7169 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7170 will have a reference count of 1, and the RV will be returned.
7176 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7178 sv_setuv(newSVrv(rv,classname), uv);
7183 =for apidoc sv_setref_nv
7185 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7186 argument will be upgraded to an RV. That RV will be modified to point to
7187 the new SV. The C<classname> argument indicates the package for the
7188 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7189 will have a reference count of 1, and the RV will be returned.
7195 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7197 sv_setnv(newSVrv(rv,classname), nv);
7202 =for apidoc sv_setref_pvn
7204 Copies a string into a new SV, optionally blessing the SV. The length of the
7205 string must be specified with C<n>. The C<rv> argument will be upgraded to
7206 an RV. That RV will be modified to point to the new SV. The C<classname>
7207 argument indicates the package for the blessing. Set C<classname> to
7208 C<Nullch> to avoid the blessing. The new SV will have a reference count
7209 of 1, and the RV will be returned.
7211 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7217 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7219 sv_setpvn(newSVrv(rv,classname), pv, n);
7224 =for apidoc sv_bless
7226 Blesses an SV into a specified package. The SV must be an RV. The package
7227 must be designated by its stash (see C<gv_stashpv()>). The reference count
7228 of the SV is unaffected.
7234 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7238 Perl_croak(aTHX_ "Can't bless non-reference value");
7240 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7241 if (SvREADONLY(tmpRef))
7242 Perl_croak(aTHX_ PL_no_modify);
7243 if (SvOBJECT(tmpRef)) {
7244 if (SvTYPE(tmpRef) != SVt_PVIO)
7246 SvREFCNT_dec(SvSTASH(tmpRef));
7249 SvOBJECT_on(tmpRef);
7250 if (SvTYPE(tmpRef) != SVt_PVIO)
7252 SvUPGRADE(tmpRef, SVt_PVMG);
7253 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7260 if(SvSMAGICAL(tmpRef))
7261 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7269 /* Downgrades a PVGV to a PVMG.
7273 S_sv_unglob(pTHX_ SV *sv)
7277 assert(SvTYPE(sv) == SVt_PVGV);
7282 sv_del_backref((SV*)GvSTASH(sv), sv);
7283 GvSTASH(sv) = Nullhv;
7285 sv_unmagic(sv, PERL_MAGIC_glob);
7286 Safefree(GvNAME(sv));
7289 /* need to keep SvANY(sv) in the right arena */
7290 xpvmg = new_XPVMG();
7291 StructCopy(SvANY(sv), xpvmg, XPVMG);
7292 del_XPVGV(SvANY(sv));
7295 SvFLAGS(sv) &= ~SVTYPEMASK;
7296 SvFLAGS(sv) |= SVt_PVMG;
7300 =for apidoc sv_unref_flags
7302 Unsets the RV status of the SV, and decrements the reference count of
7303 whatever was being referenced by the RV. This can almost be thought of
7304 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7305 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7306 (otherwise the decrementing is conditional on the reference count being
7307 different from one or the reference being a readonly SV).
7314 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7316 SV* const target = SvRV(ref);
7318 if (SvWEAKREF(ref)) {
7319 sv_del_backref(target, ref);
7321 SvRV_set(ref, NULL);
7324 SvRV_set(ref, NULL);
7326 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7327 assigned to as BEGIN {$a = \"Foo"} will fail. */
7328 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7329 SvREFCNT_dec(target);
7330 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7331 sv_2mortal(target); /* Schedule for freeing later */
7335 =for apidoc sv_untaint
7337 Untaint an SV. Use C<SvTAINTED_off> instead.
7342 Perl_sv_untaint(pTHX_ SV *sv)
7344 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7345 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7352 =for apidoc sv_tainted
7354 Test an SV for taintedness. Use C<SvTAINTED> instead.
7359 Perl_sv_tainted(pTHX_ SV *sv)
7361 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7362 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7363 if (mg && (mg->mg_len & 1) )
7370 =for apidoc sv_setpviv
7372 Copies an integer into the given SV, also updating its string value.
7373 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7379 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7381 char buf[TYPE_CHARS(UV)];
7383 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7385 sv_setpvn(sv, ptr, ebuf - ptr);
7389 =for apidoc sv_setpviv_mg
7391 Like C<sv_setpviv>, but also handles 'set' magic.
7397 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7403 #if defined(PERL_IMPLICIT_CONTEXT)
7405 /* pTHX_ magic can't cope with varargs, so this is a no-context
7406 * version of the main function, (which may itself be aliased to us).
7407 * Don't access this version directly.
7411 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7415 va_start(args, pat);
7416 sv_vsetpvf(sv, pat, &args);
7420 /* pTHX_ magic can't cope with varargs, so this is a no-context
7421 * version of the main function, (which may itself be aliased to us).
7422 * Don't access this version directly.
7426 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7430 va_start(args, pat);
7431 sv_vsetpvf_mg(sv, pat, &args);
7437 =for apidoc sv_setpvf
7439 Works like C<sv_catpvf> but copies the text into the SV instead of
7440 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7446 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7449 va_start(args, pat);
7450 sv_vsetpvf(sv, pat, &args);
7455 =for apidoc sv_vsetpvf
7457 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7458 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7460 Usually used via its frontend C<sv_setpvf>.
7466 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7468 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7472 =for apidoc sv_setpvf_mg
7474 Like C<sv_setpvf>, but also handles 'set' magic.
7480 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7483 va_start(args, pat);
7484 sv_vsetpvf_mg(sv, pat, &args);
7489 =for apidoc sv_vsetpvf_mg
7491 Like C<sv_vsetpvf>, but also handles 'set' magic.
7493 Usually used via its frontend C<sv_setpvf_mg>.
7499 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7501 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7505 #if defined(PERL_IMPLICIT_CONTEXT)
7507 /* pTHX_ magic can't cope with varargs, so this is a no-context
7508 * version of the main function, (which may itself be aliased to us).
7509 * Don't access this version directly.
7513 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7517 va_start(args, pat);
7518 sv_vcatpvf(sv, pat, &args);
7522 /* pTHX_ magic can't cope with varargs, so this is a no-context
7523 * version of the main function, (which may itself be aliased to us).
7524 * Don't access this version directly.
7528 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7532 va_start(args, pat);
7533 sv_vcatpvf_mg(sv, pat, &args);
7539 =for apidoc sv_catpvf
7541 Processes its arguments like C<sprintf> and appends the formatted
7542 output to an SV. If the appended data contains "wide" characters
7543 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7544 and characters >255 formatted with %c), the original SV might get
7545 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7546 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7547 valid UTF-8; if the original SV was bytes, the pattern should be too.
7552 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7555 va_start(args, pat);
7556 sv_vcatpvf(sv, pat, &args);
7561 =for apidoc sv_vcatpvf
7563 Processes its arguments like C<vsprintf> and appends the formatted output
7564 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7566 Usually used via its frontend C<sv_catpvf>.
7572 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7574 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7578 =for apidoc sv_catpvf_mg
7580 Like C<sv_catpvf>, but also handles 'set' magic.
7586 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7589 va_start(args, pat);
7590 sv_vcatpvf_mg(sv, pat, &args);
7595 =for apidoc sv_vcatpvf_mg
7597 Like C<sv_vcatpvf>, but also handles 'set' magic.
7599 Usually used via its frontend C<sv_catpvf_mg>.
7605 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7607 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7612 =for apidoc sv_vsetpvfn
7614 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7617 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7623 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7625 sv_setpvn(sv, "", 0);
7626 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7629 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7632 S_expect_number(pTHX_ char** pattern)
7635 switch (**pattern) {
7636 case '1': case '2': case '3':
7637 case '4': case '5': case '6':
7638 case '7': case '8': case '9':
7639 while (isDIGIT(**pattern))
7640 var = var * 10 + (*(*pattern)++ - '0');
7644 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7647 F0convert(NV nv, char *endbuf, STRLEN *len)
7649 const int neg = nv < 0;
7658 if (uv & 1 && uv == nv)
7659 uv--; /* Round to even */
7661 const unsigned dig = uv % 10;
7674 =for apidoc sv_vcatpvfn
7676 Processes its arguments like C<vsprintf> and appends the formatted output
7677 to an SV. Uses an array of SVs if the C style variable argument list is
7678 missing (NULL). When running with taint checks enabled, indicates via
7679 C<maybe_tainted> if results are untrustworthy (often due to the use of
7682 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7688 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7689 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7690 vec_utf8 = DO_UTF8(vecsv);
7692 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7695 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7702 static const char nullstr[] = "(null)";
7704 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7705 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7707 /* Times 4: a decimal digit takes more than 3 binary digits.
7708 * NV_DIG: mantissa takes than many decimal digits.
7709 * Plus 32: Playing safe. */
7710 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7711 /* large enough for "%#.#f" --chip */
7712 /* what about long double NVs? --jhi */
7714 PERL_UNUSED_ARG(maybe_tainted);
7716 /* no matter what, this is a string now */
7717 (void)SvPV_force(sv, origlen);
7719 /* special-case "", "%s", and "%-p" (SVf - see below) */
7722 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7724 const char * const s = va_arg(*args, char*);
7725 sv_catpv(sv, s ? s : nullstr);
7727 else if (svix < svmax) {
7728 sv_catsv(sv, *svargs);
7732 if (args && patlen == 3 && pat[0] == '%' &&
7733 pat[1] == '-' && pat[2] == 'p') {
7734 argsv = va_arg(*args, SV*);
7735 sv_catsv(sv, argsv);
7739 #ifndef USE_LONG_DOUBLE
7740 /* special-case "%.<number>[gf]" */
7741 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7742 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7743 unsigned digits = 0;
7747 while (*pp >= '0' && *pp <= '9')
7748 digits = 10 * digits + (*pp++ - '0');
7749 if (pp - pat == (int)patlen - 1) {
7757 /* Add check for digits != 0 because it seems that some
7758 gconverts are buggy in this case, and we don't yet have
7759 a Configure test for this. */
7760 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7761 /* 0, point, slack */
7762 Gconvert(nv, (int)digits, 0, ebuf);
7764 if (*ebuf) /* May return an empty string for digits==0 */
7767 } else if (!digits) {
7770 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7771 sv_catpvn(sv, p, l);
7777 #endif /* !USE_LONG_DOUBLE */
7779 if (!args && svix < svmax && DO_UTF8(*svargs))
7782 patend = (char*)pat + patlen;
7783 for (p = (char*)pat; p < patend; p = q) {
7786 bool vectorize = FALSE;
7787 bool vectorarg = FALSE;
7788 bool vec_utf8 = FALSE;
7794 bool has_precis = FALSE;
7797 bool is_utf8 = FALSE; /* is this item utf8? */
7798 #ifdef HAS_LDBL_SPRINTF_BUG
7799 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7800 with sfio - Allen <allens@cpan.org> */
7801 bool fix_ldbl_sprintf_bug = FALSE;
7805 U8 utf8buf[UTF8_MAXBYTES+1];
7806 STRLEN esignlen = 0;
7808 const char *eptr = Nullch;
7811 const U8 *vecstr = Null(U8*);
7818 /* we need a long double target in case HAS_LONG_DOUBLE but
7821 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7829 const char *dotstr = ".";
7830 STRLEN dotstrlen = 1;
7831 I32 efix = 0; /* explicit format parameter index */
7832 I32 ewix = 0; /* explicit width index */
7833 I32 epix = 0; /* explicit precision index */
7834 I32 evix = 0; /* explicit vector index */
7835 bool asterisk = FALSE;
7837 /* echo everything up to the next format specification */
7838 for (q = p; q < patend && *q != '%'; ++q) ;
7840 if (has_utf8 && !pat_utf8)
7841 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7843 sv_catpvn(sv, p, q - p);
7850 We allow format specification elements in this order:
7851 \d+\$ explicit format parameter index
7853 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7854 0 flag (as above): repeated to allow "v02"
7855 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7856 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7858 [%bcdefginopsuxDFOUX] format (mandatory)
7863 As of perl5.9.3, printf format checking is on by default.
7864 Internally, perl uses %p formats to provide an escape to
7865 some extended formatting. This block deals with those
7866 extensions: if it does not match, (char*)q is reset and
7867 the normal format processing code is used.
7869 Currently defined extensions are:
7870 %p include pointer address (standard)
7871 %-p (SVf) include an SV (previously %_)
7872 %-<num>p include an SV with precision <num>
7873 %1p (VDf) include a v-string (as %vd)
7874 %<num>p reserved for future extensions
7876 Robin Barker 2005-07-14
7883 EXPECT_NUMBER(q, n);
7890 argsv = va_arg(*args, SV*);
7891 eptr = SvPVx_const(argsv, elen);
7897 else if (n == vdNUMBER) { /* VDf */
7904 if (ckWARN_d(WARN_INTERNAL))
7905 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7906 "internal %%<num>p might conflict with future printf extensions");
7912 if (EXPECT_NUMBER(q, width)) {
7953 if (EXPECT_NUMBER(q, ewix))
7962 if ((vectorarg = asterisk)) {
7975 EXPECT_NUMBER(q, width);
7981 vecsv = va_arg(*args, SV*);
7983 vecsv = (evix ? evix <= svmax : svix < svmax) ?
7984 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
7985 dotstr = SvPV_const(vecsv, dotstrlen);
7992 else if (efix ? efix <= svmax : svix < svmax) {
7993 vecsv = svargs[efix ? efix-1 : svix++];
7994 vecstr = (U8*)SvPV_const(vecsv,veclen);
7995 vec_utf8 = DO_UTF8(vecsv);
7996 /* if this is a version object, we need to return the
7997 * stringified representation (which the SvPVX_const has
7998 * already done for us), but not vectorize the args
8000 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8002 q++; /* skip past the rest of the %vd format */
8003 eptr = (const char *) vecstr;
8017 i = va_arg(*args, int);
8019 i = (ewix ? ewix <= svmax : svix < svmax) ?
8020 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8022 width = (i < 0) ? -i : i;
8032 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8034 /* XXX: todo, support specified precision parameter */
8038 i = va_arg(*args, int);
8040 i = (ewix ? ewix <= svmax : svix < svmax)
8041 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8042 precis = (i < 0) ? 0 : i;
8047 precis = precis * 10 + (*q++ - '0');
8056 case 'I': /* Ix, I32x, and I64x */
8058 if (q[1] == '6' && q[2] == '4') {
8064 if (q[1] == '3' && q[2] == '2') {
8074 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8085 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8086 if (*(q + 1) == 'l') { /* lld, llf */
8112 const I32 i = efix-1;
8113 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8115 argsv = (svix >= 0 && svix < svmax)
8116 ? svargs[svix++] : &PL_sv_undef;
8125 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8127 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8129 eptr = (char*)utf8buf;
8130 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8141 if (args && !vectorize) {
8142 eptr = va_arg(*args, char*);
8144 #ifdef MACOS_TRADITIONAL
8145 /* On MacOS, %#s format is used for Pascal strings */
8150 elen = strlen(eptr);
8152 eptr = (char *)nullstr;
8153 elen = sizeof nullstr - 1;
8157 eptr = SvPVx_const(argsv, elen);
8158 if (DO_UTF8(argsv)) {
8159 if (has_precis && precis < elen) {
8161 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8164 if (width) { /* fudge width (can't fudge elen) */
8165 width += elen - sv_len_utf8(argsv);
8173 if (has_precis && elen > precis)
8180 if (alt || vectorize)
8182 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8203 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8212 esignbuf[esignlen++] = plus;
8216 case 'h': iv = (short)va_arg(*args, int); break;
8217 case 'l': iv = va_arg(*args, long); break;
8218 case 'V': iv = va_arg(*args, IV); break;
8219 default: iv = va_arg(*args, int); break;
8221 case 'q': iv = va_arg(*args, Quad_t); break;
8226 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8228 case 'h': iv = (short)tiv; break;
8229 case 'l': iv = (long)tiv; break;
8231 default: iv = tiv; break;
8233 case 'q': iv = (Quad_t)tiv; break;
8237 if ( !vectorize ) /* we already set uv above */
8242 esignbuf[esignlen++] = plus;
8246 esignbuf[esignlen++] = '-';
8289 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8300 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8301 case 'l': uv = va_arg(*args, unsigned long); break;
8302 case 'V': uv = va_arg(*args, UV); break;
8303 default: uv = va_arg(*args, unsigned); break;
8305 case 'q': uv = va_arg(*args, Uquad_t); break;
8310 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8312 case 'h': uv = (unsigned short)tuv; break;
8313 case 'l': uv = (unsigned long)tuv; break;
8315 default: uv = tuv; break;
8317 case 'q': uv = (Uquad_t)tuv; break;
8324 char *ptr = ebuf + sizeof ebuf;
8330 p = (char*)((c == 'X')
8331 ? "0123456789ABCDEF" : "0123456789abcdef");
8337 esignbuf[esignlen++] = '0';
8338 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8346 if (alt && *ptr != '0')
8357 esignbuf[esignlen++] = '0';
8358 esignbuf[esignlen++] = 'b';
8361 default: /* it had better be ten or less */
8365 } while (uv /= base);
8368 elen = (ebuf + sizeof ebuf) - ptr;
8372 zeros = precis - elen;
8373 else if (precis == 0 && elen == 1 && *eptr == '0')
8379 /* FLOATING POINT */
8382 c = 'f'; /* maybe %F isn't supported here */
8388 /* This is evil, but floating point is even more evil */
8390 /* for SV-style calling, we can only get NV
8391 for C-style calling, we assume %f is double;
8392 for simplicity we allow any of %Lf, %llf, %qf for long double
8396 #if defined(USE_LONG_DOUBLE)
8400 /* [perl #20339] - we should accept and ignore %lf rather than die */
8404 #if defined(USE_LONG_DOUBLE)
8405 intsize = args ? 0 : 'q';
8409 #if defined(HAS_LONG_DOUBLE)
8418 /* now we need (long double) if intsize == 'q', else (double) */
8419 nv = (args && !vectorize) ?
8420 #if LONG_DOUBLESIZE > DOUBLESIZE
8422 va_arg(*args, long double) :
8423 va_arg(*args, double)
8425 va_arg(*args, double)
8431 if (c != 'e' && c != 'E') {
8433 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8434 will cast our (long double) to (double) */
8435 (void)Perl_frexp(nv, &i);
8436 if (i == PERL_INT_MIN)
8437 Perl_die(aTHX_ "panic: frexp");
8439 need = BIT_DIGITS(i);
8441 need += has_precis ? precis : 6; /* known default */
8446 #ifdef HAS_LDBL_SPRINTF_BUG
8447 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8448 with sfio - Allen <allens@cpan.org> */
8451 # define MY_DBL_MAX DBL_MAX
8452 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8453 # if DOUBLESIZE >= 8
8454 # define MY_DBL_MAX 1.7976931348623157E+308L
8456 # define MY_DBL_MAX 3.40282347E+38L
8460 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8461 # define MY_DBL_MAX_BUG 1L
8463 # define MY_DBL_MAX_BUG MY_DBL_MAX
8467 # define MY_DBL_MIN DBL_MIN
8468 # else /* XXX guessing! -Allen */
8469 # if DOUBLESIZE >= 8
8470 # define MY_DBL_MIN 2.2250738585072014E-308L
8472 # define MY_DBL_MIN 1.17549435E-38L
8476 if ((intsize == 'q') && (c == 'f') &&
8477 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8479 /* it's going to be short enough that
8480 * long double precision is not needed */
8482 if ((nv <= 0L) && (nv >= -0L))
8483 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8485 /* would use Perl_fp_class as a double-check but not
8486 * functional on IRIX - see perl.h comments */
8488 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8489 /* It's within the range that a double can represent */
8490 #if defined(DBL_MAX) && !defined(DBL_MIN)
8491 if ((nv >= ((long double)1/DBL_MAX)) ||
8492 (nv <= (-(long double)1/DBL_MAX)))
8494 fix_ldbl_sprintf_bug = TRUE;
8497 if (fix_ldbl_sprintf_bug == TRUE) {
8507 # undef MY_DBL_MAX_BUG
8510 #endif /* HAS_LDBL_SPRINTF_BUG */
8512 need += 20; /* fudge factor */
8513 if (PL_efloatsize < need) {
8514 Safefree(PL_efloatbuf);
8515 PL_efloatsize = need + 20; /* more fudge */
8516 Newx(PL_efloatbuf, PL_efloatsize, char);
8517 PL_efloatbuf[0] = '\0';
8520 if ( !(width || left || plus || alt) && fill != '0'
8521 && has_precis && intsize != 'q' ) { /* Shortcuts */
8522 /* See earlier comment about buggy Gconvert when digits,
8524 if ( c == 'g' && precis) {
8525 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8526 /* May return an empty string for digits==0 */
8527 if (*PL_efloatbuf) {
8528 elen = strlen(PL_efloatbuf);
8529 goto float_converted;
8531 } else if ( c == 'f' && !precis) {
8532 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8537 char *ptr = ebuf + sizeof ebuf;
8540 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8541 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8542 if (intsize == 'q') {
8543 /* Copy the one or more characters in a long double
8544 * format before the 'base' ([efgEFG]) character to
8545 * the format string. */
8546 static char const prifldbl[] = PERL_PRIfldbl;
8547 char const *p = prifldbl + sizeof(prifldbl) - 3;
8548 while (p >= prifldbl) { *--ptr = *p--; }
8553 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8558 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8570 /* No taint. Otherwise we are in the strange situation
8571 * where printf() taints but print($float) doesn't.
8573 #if defined(HAS_LONG_DOUBLE)
8574 elen = ((intsize == 'q')
8575 ? my_sprintf(PL_efloatbuf, ptr, nv)
8576 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8578 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8582 eptr = PL_efloatbuf;
8588 i = SvCUR(sv) - origlen;
8589 if (args && !vectorize) {
8591 case 'h': *(va_arg(*args, short*)) = i; break;
8592 default: *(va_arg(*args, int*)) = i; break;
8593 case 'l': *(va_arg(*args, long*)) = i; break;
8594 case 'V': *(va_arg(*args, IV*)) = i; break;
8596 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8601 sv_setuv_mg(argsv, (UV)i);
8603 continue; /* not "break" */
8610 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8611 && ckWARN(WARN_PRINTF))
8613 SV * const msg = sv_newmortal();
8614 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8615 (PL_op->op_type == OP_PRTF) ? "" : "s");
8618 Perl_sv_catpvf(aTHX_ msg,
8619 "\"%%%c\"", c & 0xFF);
8621 Perl_sv_catpvf(aTHX_ msg,
8622 "\"%%\\%03"UVof"\"",
8625 sv_catpv(msg, "end of string");
8626 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8629 /* output mangled stuff ... */
8635 /* ... right here, because formatting flags should not apply */
8636 SvGROW(sv, SvCUR(sv) + elen + 1);
8638 Copy(eptr, p, elen, char);
8641 SvCUR_set(sv, p - SvPVX_const(sv));
8643 continue; /* not "break" */
8646 /* calculate width before utf8_upgrade changes it */
8647 have = esignlen + zeros + elen;
8649 Perl_croak_nocontext(PL_memory_wrap);
8651 if (is_utf8 != has_utf8) {
8654 sv_utf8_upgrade(sv);
8657 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8658 sv_utf8_upgrade(nsv);
8659 eptr = SvPVX_const(nsv);
8662 SvGROW(sv, SvCUR(sv) + elen + 1);
8667 need = (have > width ? have : width);
8670 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8671 Perl_croak_nocontext(PL_memory_wrap);
8672 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8674 if (esignlen && fill == '0') {
8676 for (i = 0; i < (int)esignlen; i++)
8680 memset(p, fill, gap);
8683 if (esignlen && fill != '0') {
8685 for (i = 0; i < (int)esignlen; i++)
8690 for (i = zeros; i; i--)
8694 Copy(eptr, p, elen, char);
8698 memset(p, ' ', gap);
8703 Copy(dotstr, p, dotstrlen, char);
8707 vectorize = FALSE; /* done iterating over vecstr */
8714 SvCUR_set(sv, p - SvPVX_const(sv));
8722 /* =========================================================================
8724 =head1 Cloning an interpreter
8726 All the macros and functions in this section are for the private use of
8727 the main function, perl_clone().
8729 The foo_dup() functions make an exact copy of an existing foo thinngy.
8730 During the course of a cloning, a hash table is used to map old addresses
8731 to new addresses. The table is created and manipulated with the
8732 ptr_table_* functions.
8736 ============================================================================*/
8739 #if defined(USE_ITHREADS)
8741 #ifndef GpREFCNT_inc
8742 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8746 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8747 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8748 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8749 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8750 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8751 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8752 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8753 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8754 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8755 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8756 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8757 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8758 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8761 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8762 regcomp.c. AMS 20010712 */
8765 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8770 struct reg_substr_datum *s;
8773 return (REGEXP *)NULL;
8775 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8778 len = r->offsets[0];
8779 npar = r->nparens+1;
8781 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8782 Copy(r->program, ret->program, len+1, regnode);
8784 Newx(ret->startp, npar, I32);
8785 Copy(r->startp, ret->startp, npar, I32);
8786 Newx(ret->endp, npar, I32);
8787 Copy(r->startp, ret->startp, npar, I32);
8789 Newx(ret->substrs, 1, struct reg_substr_data);
8790 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8791 s->min_offset = r->substrs->data[i].min_offset;
8792 s->max_offset = r->substrs->data[i].max_offset;
8793 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8794 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8797 ret->regstclass = NULL;
8800 const int count = r->data->count;
8803 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8804 char, struct reg_data);
8805 Newx(d->what, count, U8);
8808 for (i = 0; i < count; i++) {
8809 d->what[i] = r->data->what[i];
8810 switch (d->what[i]) {
8811 /* legal options are one of: sfpont
8812 see also regcomp.h and pregfree() */
8814 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8817 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8820 /* This is cheating. */
8821 Newx(d->data[i], 1, struct regnode_charclass_class);
8822 StructCopy(r->data->data[i], d->data[i],
8823 struct regnode_charclass_class);
8824 ret->regstclass = (regnode*)d->data[i];
8827 /* Compiled op trees are readonly, and can thus be
8828 shared without duplication. */
8830 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8834 d->data[i] = r->data->data[i];
8837 d->data[i] = r->data->data[i];
8839 ((reg_trie_data*)d->data[i])->refcount++;
8843 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8852 Newx(ret->offsets, 2*len+1, U32);
8853 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8855 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8856 ret->refcnt = r->refcnt;
8857 ret->minlen = r->minlen;
8858 ret->prelen = r->prelen;
8859 ret->nparens = r->nparens;
8860 ret->lastparen = r->lastparen;
8861 ret->lastcloseparen = r->lastcloseparen;
8862 ret->reganch = r->reganch;
8864 ret->sublen = r->sublen;
8866 if (RX_MATCH_COPIED(ret))
8867 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8869 ret->subbeg = Nullch;
8870 #ifdef PERL_OLD_COPY_ON_WRITE
8871 ret->saved_copy = Nullsv;
8874 ptr_table_store(PL_ptr_table, r, ret);
8878 /* duplicate a file handle */
8881 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8885 PERL_UNUSED_ARG(type);
8888 return (PerlIO*)NULL;
8890 /* look for it in the table first */
8891 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8895 /* create anew and remember what it is */
8896 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8897 ptr_table_store(PL_ptr_table, fp, ret);
8901 /* duplicate a directory handle */
8904 Perl_dirp_dup(pTHX_ DIR *dp)
8912 /* duplicate a typeglob */
8915 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8920 /* look for it in the table first */
8921 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8925 /* create anew and remember what it is */
8927 ptr_table_store(PL_ptr_table, gp, ret);
8930 ret->gp_refcnt = 0; /* must be before any other dups! */
8931 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8932 ret->gp_io = io_dup_inc(gp->gp_io, param);
8933 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8934 ret->gp_av = av_dup_inc(gp->gp_av, param);
8935 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8936 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8937 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8938 ret->gp_cvgen = gp->gp_cvgen;
8939 ret->gp_line = gp->gp_line;
8940 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8944 /* duplicate a chain of magic */
8947 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8949 MAGIC *mgprev = (MAGIC*)NULL;
8952 return (MAGIC*)NULL;
8953 /* look for it in the table first */
8954 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8958 for (; mg; mg = mg->mg_moremagic) {
8960 Newxz(nmg, 1, MAGIC);
8962 mgprev->mg_moremagic = nmg;
8965 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8966 nmg->mg_private = mg->mg_private;
8967 nmg->mg_type = mg->mg_type;
8968 nmg->mg_flags = mg->mg_flags;
8969 if (mg->mg_type == PERL_MAGIC_qr) {
8970 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8972 else if(mg->mg_type == PERL_MAGIC_backref) {
8973 const AV * const av = (AV*) mg->mg_obj;
8976 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8978 for (i = AvFILLp(av); i >= 0; i--) {
8979 if (!svp[i]) continue;
8980 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8983 else if (mg->mg_type == PERL_MAGIC_symtab) {
8984 nmg->mg_obj = mg->mg_obj;
8987 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8988 ? sv_dup_inc(mg->mg_obj, param)
8989 : sv_dup(mg->mg_obj, param);
8991 nmg->mg_len = mg->mg_len;
8992 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
8993 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8994 if (mg->mg_len > 0) {
8995 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
8996 if (mg->mg_type == PERL_MAGIC_overload_table &&
8997 AMT_AMAGIC((AMT*)mg->mg_ptr))
8999 AMT * const amtp = (AMT*)mg->mg_ptr;
9000 AMT * const namtp = (AMT*)nmg->mg_ptr;
9002 for (i = 1; i < NofAMmeth; i++) {
9003 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9007 else if (mg->mg_len == HEf_SVKEY)
9008 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9010 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9011 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9018 /* create a new pointer-mapping table */
9021 Perl_ptr_table_new(pTHX)
9024 Newxz(tbl, 1, PTR_TBL_t);
9027 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9032 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9034 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9038 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9039 following define) and at call to new_body_inline made below in
9040 Perl_ptr_table_store()
9043 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9045 /* map an existing pointer using a table */
9048 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9050 PTR_TBL_ENT_t *tblent;
9051 const UV hash = PTR_TABLE_HASH(sv);
9053 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9054 for (; tblent; tblent = tblent->next) {
9055 if (tblent->oldval == sv)
9056 return tblent->newval;
9061 /* add a new entry to a pointer-mapping table */
9064 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9066 PTR_TBL_ENT_t *tblent, **otblent;
9067 /* XXX this may be pessimal on platforms where pointers aren't good
9068 * hash values e.g. if they grow faster in the most significant
9070 const UV hash = PTR_TABLE_HASH(oldsv);
9074 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9075 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9076 if (tblent->oldval == oldsv) {
9077 tblent->newval = newsv;
9081 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9082 tblent->oldval = oldsv;
9083 tblent->newval = newsv;
9084 tblent->next = *otblent;
9087 if (!empty && tbl->tbl_items > tbl->tbl_max)
9088 ptr_table_split(tbl);
9091 /* double the hash bucket size of an existing ptr table */
9094 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9096 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9097 const UV oldsize = tbl->tbl_max + 1;
9098 UV newsize = oldsize * 2;
9101 Renew(ary, newsize, PTR_TBL_ENT_t*);
9102 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9103 tbl->tbl_max = --newsize;
9105 for (i=0; i < oldsize; i++, ary++) {
9106 PTR_TBL_ENT_t **curentp, **entp, *ent;
9109 curentp = ary + oldsize;
9110 for (entp = ary, ent = *ary; ent; ent = *entp) {
9111 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9113 ent->next = *curentp;
9123 /* remove all the entries from a ptr table */
9126 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9128 register PTR_TBL_ENT_t **array;
9129 register PTR_TBL_ENT_t *entry;
9133 if (!tbl || !tbl->tbl_items) {
9137 array = tbl->tbl_ary;
9143 PTR_TBL_ENT_t *oentry = entry;
9144 entry = entry->next;
9148 if (++riter > max) {
9151 entry = array[riter];
9158 /* clear and free a ptr table */
9161 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9166 ptr_table_clear(tbl);
9167 Safefree(tbl->tbl_ary);
9173 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9176 SvRV_set(dstr, SvWEAKREF(sstr)
9177 ? sv_dup(SvRV(sstr), param)
9178 : sv_dup_inc(SvRV(sstr), param));
9181 else if (SvPVX_const(sstr)) {
9182 /* Has something there */
9184 /* Normal PV - clone whole allocated space */
9185 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9186 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9187 /* Not that normal - actually sstr is copy on write.
9188 But we are a true, independant SV, so: */
9189 SvREADONLY_off(dstr);
9194 /* Special case - not normally malloced for some reason */
9195 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9196 /* A "shared" PV - clone it as "shared" PV */
9198 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9202 /* Some other special case - random pointer */
9203 SvPV_set(dstr, SvPVX(sstr));
9209 if (SvTYPE(dstr) == SVt_RV)
9210 SvRV_set(dstr, NULL);
9216 /* duplicate an SV of any type (including AV, HV etc) */
9219 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9224 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9226 /* look for it in the table first */
9227 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9231 if(param->flags & CLONEf_JOIN_IN) {
9232 /** We are joining here so we don't want do clone
9233 something that is bad **/
9236 if(SvTYPE(sstr) == SVt_PVHV &&
9237 (hvname = HvNAME_get(sstr))) {
9238 /** don't clone stashes if they already exist **/
9239 return (SV*)gv_stashpv(hvname,0);
9243 /* create anew and remember what it is */
9246 #ifdef DEBUG_LEAKING_SCALARS
9247 dstr->sv_debug_optype = sstr->sv_debug_optype;
9248 dstr->sv_debug_line = sstr->sv_debug_line;
9249 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9250 dstr->sv_debug_cloned = 1;
9252 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9254 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9258 ptr_table_store(PL_ptr_table, sstr, dstr);
9261 SvFLAGS(dstr) = SvFLAGS(sstr);
9262 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9263 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9266 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9267 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9268 PL_watch_pvx, SvPVX_const(sstr));
9271 /* don't clone objects whose class has asked us not to */
9272 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9273 SvFLAGS(dstr) &= ~SVTYPEMASK;
9278 switch (SvTYPE(sstr)) {
9283 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9284 SvIV_set(dstr, SvIVX(sstr));
9287 SvANY(dstr) = new_XNV();
9288 SvNV_set(dstr, SvNVX(sstr));
9291 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9292 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9296 /* These are all the types that need complex bodies allocating. */
9298 const svtype sv_type = SvTYPE(sstr);
9299 const struct body_details *const sv_type_details
9300 = bodies_by_type + sv_type;
9304 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9309 if (GvUNIQUE((GV*)sstr)) {
9310 /* Do sharing here, and fall through */
9323 assert(sv_type_details->copy);
9324 if (sv_type_details->arena) {
9325 new_body_inline(new_body, sv_type_details->copy, sv_type);
9327 = (void*)((char*)new_body - sv_type_details->offset);
9329 new_body = new_NOARENA(sv_type_details);
9333 SvANY(dstr) = new_body;
9336 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9337 ((char*)SvANY(dstr)) + sv_type_details->offset,
9338 sv_type_details->copy, char);
9340 Copy(((char*)SvANY(sstr)),
9341 ((char*)SvANY(dstr)),
9342 sv_type_details->size + sv_type_details->offset, char);
9345 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9346 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9348 /* The Copy above means that all the source (unduplicated) pointers
9349 are now in the destination. We can check the flags and the
9350 pointers in either, but it's possible that there's less cache
9351 missing by always going for the destination.
9352 FIXME - instrument and check that assumption */
9353 if (sv_type >= SVt_PVMG) {
9355 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9357 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9360 /* The cast silences a GCC warning about unhandled types. */
9361 switch ((int)sv_type) {
9373 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9374 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9375 LvTARG(dstr) = dstr;
9376 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9377 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9379 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9382 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9383 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9384 /* Don't call sv_add_backref here as it's going to be created
9385 as part of the magic cloning of the symbol table. */
9386 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9387 (void)GpREFCNT_inc(GvGP(dstr));
9390 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9391 if (IoOFP(dstr) == IoIFP(sstr))
9392 IoOFP(dstr) = IoIFP(dstr);
9394 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9395 /* PL_rsfp_filters entries have fake IoDIRP() */
9396 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9397 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9398 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9399 /* I have no idea why fake dirp (rsfps)
9400 should be treated differently but otherwise
9401 we end up with leaks -- sky*/
9402 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9403 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9404 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9406 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9407 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9408 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9410 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9411 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9412 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9415 if (AvARRAY((AV*)sstr)) {
9416 SV **dst_ary, **src_ary;
9417 SSize_t items = AvFILLp((AV*)sstr) + 1;
9419 src_ary = AvARRAY((AV*)sstr);
9420 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9421 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9422 SvPV_set(dstr, (char*)dst_ary);
9423 AvALLOC((AV*)dstr) = dst_ary;
9424 if (AvREAL((AV*)sstr)) {
9426 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9430 *dst_ary++ = sv_dup(*src_ary++, param);
9432 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9433 while (items-- > 0) {
9434 *dst_ary++ = &PL_sv_undef;
9438 SvPV_set(dstr, Nullch);
9439 AvALLOC((AV*)dstr) = (SV**)NULL;
9446 if (HvARRAY((HV*)sstr)) {
9448 const bool sharekeys = !!HvSHAREKEYS(sstr);
9449 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9450 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9452 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9453 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9455 HvARRAY(dstr) = (HE**)darray;
9456 while (i <= sxhv->xhv_max) {
9457 const HE *source = HvARRAY(sstr)[i];
9458 HvARRAY(dstr)[i] = source
9459 ? he_dup(source, sharekeys, param) : 0;
9463 struct xpvhv_aux *saux = HvAUX(sstr);
9464 struct xpvhv_aux *daux = HvAUX(dstr);
9465 /* This flag isn't copied. */
9466 /* SvOOK_on(hv) attacks the IV flags. */
9467 SvFLAGS(dstr) |= SVf_OOK;
9469 hvname = saux->xhv_name;
9471 = hvname ? hek_dup(hvname, param) : hvname;
9473 daux->xhv_riter = saux->xhv_riter;
9474 daux->xhv_eiter = saux->xhv_eiter
9475 ? he_dup(saux->xhv_eiter,
9476 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9480 SvPV_set(dstr, Nullch);
9482 /* Record stashes for possible cloning in Perl_clone(). */
9484 av_push(param->stashes, dstr);
9489 /* NOTE: not refcounted */
9490 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9492 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9494 if (CvCONST(dstr)) {
9495 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9496 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9497 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9499 /* don't dup if copying back - CvGV isn't refcounted, so the
9500 * duped GV may never be freed. A bit of a hack! DAPM */
9501 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9502 Nullgv : gv_dup(CvGV(dstr), param) ;
9503 if (!(param->flags & CLONEf_COPY_STACKS)) {
9506 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9509 ? cv_dup( CvOUTSIDE(dstr), param)
9510 : cv_dup_inc(CvOUTSIDE(dstr), param);
9512 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9518 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9524 /* duplicate a context */
9527 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9532 return (PERL_CONTEXT*)NULL;
9534 /* look for it in the table first */
9535 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9539 /* create anew and remember what it is */
9540 Newxz(ncxs, max + 1, PERL_CONTEXT);
9541 ptr_table_store(PL_ptr_table, cxs, ncxs);
9544 PERL_CONTEXT *cx = &cxs[ix];
9545 PERL_CONTEXT *ncx = &ncxs[ix];
9546 ncx->cx_type = cx->cx_type;
9547 if (CxTYPE(cx) == CXt_SUBST) {
9548 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9551 ncx->blk_oldsp = cx->blk_oldsp;
9552 ncx->blk_oldcop = cx->blk_oldcop;
9553 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9554 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9555 ncx->blk_oldpm = cx->blk_oldpm;
9556 ncx->blk_gimme = cx->blk_gimme;
9557 switch (CxTYPE(cx)) {
9559 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9560 ? cv_dup_inc(cx->blk_sub.cv, param)
9561 : cv_dup(cx->blk_sub.cv,param));
9562 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9563 ? av_dup_inc(cx->blk_sub.argarray, param)
9565 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9566 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9567 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9568 ncx->blk_sub.lval = cx->blk_sub.lval;
9569 ncx->blk_sub.retop = cx->blk_sub.retop;
9572 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9573 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9574 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9575 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9576 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9577 ncx->blk_eval.retop = cx->blk_eval.retop;
9580 ncx->blk_loop.label = cx->blk_loop.label;
9581 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9582 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9583 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9584 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9585 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9586 ? cx->blk_loop.iterdata
9587 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9588 ncx->blk_loop.oldcomppad
9589 = (PAD*)ptr_table_fetch(PL_ptr_table,
9590 cx->blk_loop.oldcomppad);
9591 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9592 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9593 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9594 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9595 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9598 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9599 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9600 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9601 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9602 ncx->blk_sub.retop = cx->blk_sub.retop;
9614 /* duplicate a stack info structure */
9617 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9622 return (PERL_SI*)NULL;
9624 /* look for it in the table first */
9625 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9629 /* create anew and remember what it is */
9630 Newxz(nsi, 1, PERL_SI);
9631 ptr_table_store(PL_ptr_table, si, nsi);
9633 nsi->si_stack = av_dup_inc(si->si_stack, param);
9634 nsi->si_cxix = si->si_cxix;
9635 nsi->si_cxmax = si->si_cxmax;
9636 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9637 nsi->si_type = si->si_type;
9638 nsi->si_prev = si_dup(si->si_prev, param);
9639 nsi->si_next = si_dup(si->si_next, param);
9640 nsi->si_markoff = si->si_markoff;
9645 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9646 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9647 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9648 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9649 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9650 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9651 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9652 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9653 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9654 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9655 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9656 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9657 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9658 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9661 #define pv_dup_inc(p) SAVEPV(p)
9662 #define pv_dup(p) SAVEPV(p)
9663 #define svp_dup_inc(p,pp) any_dup(p,pp)
9665 /* map any object to the new equivent - either something in the
9666 * ptr table, or something in the interpreter structure
9670 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9677 /* look for it in the table first */
9678 ret = ptr_table_fetch(PL_ptr_table, v);
9682 /* see if it is part of the interpreter structure */
9683 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9684 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9692 /* duplicate the save stack */
9695 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9697 ANY * const ss = proto_perl->Tsavestack;
9698 const I32 max = proto_perl->Tsavestack_max;
9699 I32 ix = proto_perl->Tsavestack_ix;
9711 void (*dptr) (void*);
9712 void (*dxptr) (pTHX_ void*);
9714 Newxz(nss, max, ANY);
9717 I32 i = POPINT(ss,ix);
9720 case SAVEt_ITEM: /* normal string */
9721 sv = (SV*)POPPTR(ss,ix);
9722 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9723 sv = (SV*)POPPTR(ss,ix);
9724 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9726 case SAVEt_SV: /* scalar reference */
9727 sv = (SV*)POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9729 gv = (GV*)POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9732 case SAVEt_GENERIC_PVREF: /* generic char* */
9733 c = (char*)POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = pv_dup(c);
9735 ptr = POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9738 case SAVEt_SHARED_PVREF: /* char* in shared space */
9739 c = (char*)POPPTR(ss,ix);
9740 TOPPTR(nss,ix) = savesharedpv(c);
9741 ptr = POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9744 case SAVEt_GENERIC_SVREF: /* generic sv */
9745 case SAVEt_SVREF: /* scalar reference */
9746 sv = (SV*)POPPTR(ss,ix);
9747 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9748 ptr = POPPTR(ss,ix);
9749 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9751 case SAVEt_AV: /* array reference */
9752 av = (AV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = av_dup_inc(av, param);
9754 gv = (GV*)POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = gv_dup(gv, param);
9757 case SAVEt_HV: /* hash reference */
9758 hv = (HV*)POPPTR(ss,ix);
9759 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9760 gv = (GV*)POPPTR(ss,ix);
9761 TOPPTR(nss,ix) = gv_dup(gv, param);
9763 case SAVEt_INT: /* int reference */
9764 ptr = POPPTR(ss,ix);
9765 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9766 intval = (int)POPINT(ss,ix);
9767 TOPINT(nss,ix) = intval;
9769 case SAVEt_LONG: /* long reference */
9770 ptr = POPPTR(ss,ix);
9771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9772 longval = (long)POPLONG(ss,ix);
9773 TOPLONG(nss,ix) = longval;
9775 case SAVEt_I32: /* I32 reference */
9776 case SAVEt_I16: /* I16 reference */
9777 case SAVEt_I8: /* I8 reference */
9778 ptr = POPPTR(ss,ix);
9779 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9783 case SAVEt_IV: /* IV reference */
9784 ptr = POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9789 case SAVEt_SPTR: /* SV* reference */
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9792 sv = (SV*)POPPTR(ss,ix);
9793 TOPPTR(nss,ix) = sv_dup(sv, param);
9795 case SAVEt_VPTR: /* random* reference */
9796 ptr = POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 ptr = POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9801 case SAVEt_PPTR: /* char* reference */
9802 ptr = POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9804 c = (char*)POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = pv_dup(c);
9807 case SAVEt_HPTR: /* HV* reference */
9808 ptr = POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9810 hv = (HV*)POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = hv_dup(hv, param);
9813 case SAVEt_APTR: /* AV* reference */
9814 ptr = POPPTR(ss,ix);
9815 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9816 av = (AV*)POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = av_dup(av, param);
9820 gv = (GV*)POPPTR(ss,ix);
9821 TOPPTR(nss,ix) = gv_dup(gv, param);
9823 case SAVEt_GP: /* scalar reference */
9824 gp = (GP*)POPPTR(ss,ix);
9825 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9826 (void)GpREFCNT_inc(gp);
9827 gv = (GV*)POPPTR(ss,ix);
9828 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9829 c = (char*)POPPTR(ss,ix);
9830 TOPPTR(nss,ix) = pv_dup(c);
9837 case SAVEt_MORTALIZESV:
9838 sv = (SV*)POPPTR(ss,ix);
9839 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9842 ptr = POPPTR(ss,ix);
9843 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9844 /* these are assumed to be refcounted properly */
9846 switch (((OP*)ptr)->op_type) {
9853 TOPPTR(nss,ix) = ptr;
9858 TOPPTR(nss,ix) = Nullop;
9863 TOPPTR(nss,ix) = Nullop;
9866 c = (char*)POPPTR(ss,ix);
9867 TOPPTR(nss,ix) = pv_dup_inc(c);
9870 longval = POPLONG(ss,ix);
9871 TOPLONG(nss,ix) = longval;
9874 hv = (HV*)POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9876 c = (char*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = pv_dup_inc(c);
9881 case SAVEt_DESTRUCTOR:
9882 ptr = POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9884 dptr = POPDPTR(ss,ix);
9885 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9886 any_dup(FPTR2DPTR(void *, dptr),
9889 case SAVEt_DESTRUCTOR_X:
9890 ptr = POPPTR(ss,ix);
9891 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9892 dxptr = POPDXPTR(ss,ix);
9893 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9894 any_dup(FPTR2DPTR(void *, dxptr),
9897 case SAVEt_REGCONTEXT:
9903 case SAVEt_STACK_POS: /* Position on Perl stack */
9907 case SAVEt_AELEM: /* array element */
9908 sv = (SV*)POPPTR(ss,ix);
9909 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 av = (AV*)POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = av_dup_inc(av, param);
9915 case SAVEt_HELEM: /* hash element */
9916 sv = (SV*)POPPTR(ss,ix);
9917 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9918 sv = (SV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9920 hv = (HV*)POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9924 ptr = POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = ptr;
9932 av = (AV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = av_dup(av, param);
9936 longval = (long)POPLONG(ss,ix);
9937 TOPLONG(nss,ix) = longval;
9938 ptr = POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9940 sv = (SV*)POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = sv_dup(sv, param);
9944 ptr = POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 longval = (long)POPBOOL(ss,ix);
9947 TOPBOOL(nss,ix) = (bool)longval;
9949 case SAVEt_SET_SVFLAGS:
9954 sv = (SV*)POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = sv_dup(sv, param);
9958 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9966 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9967 * flag to the result. This is done for each stash before cloning starts,
9968 * so we know which stashes want their objects cloned */
9971 do_mark_cloneable_stash(pTHX_ SV *sv)
9973 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9975 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9976 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9977 if (cloner && GvCV(cloner)) {
9984 XPUSHs(sv_2mortal(newSVhek(hvname)));
9986 call_sv((SV*)GvCV(cloner), G_SCALAR);
9993 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10001 =for apidoc perl_clone
10003 Create and return a new interpreter by cloning the current one.
10005 perl_clone takes these flags as parameters:
10007 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10008 without it we only clone the data and zero the stacks,
10009 with it we copy the stacks and the new perl interpreter is
10010 ready to run at the exact same point as the previous one.
10011 The pseudo-fork code uses COPY_STACKS while the
10012 threads->new doesn't.
10014 CLONEf_KEEP_PTR_TABLE
10015 perl_clone keeps a ptr_table with the pointer of the old
10016 variable as a key and the new variable as a value,
10017 this allows it to check if something has been cloned and not
10018 clone it again but rather just use the value and increase the
10019 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10020 the ptr_table using the function
10021 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10022 reason to keep it around is if you want to dup some of your own
10023 variable who are outside the graph perl scans, example of this
10024 code is in threads.xs create
10027 This is a win32 thing, it is ignored on unix, it tells perls
10028 win32host code (which is c++) to clone itself, this is needed on
10029 win32 if you want to run two threads at the same time,
10030 if you just want to do some stuff in a separate perl interpreter
10031 and then throw it away and return to the original one,
10032 you don't need to do anything.
10037 /* XXX the above needs expanding by someone who actually understands it ! */
10038 EXTERN_C PerlInterpreter *
10039 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10042 perl_clone(PerlInterpreter *proto_perl, UV flags)
10045 #ifdef PERL_IMPLICIT_SYS
10047 /* perlhost.h so we need to call into it
10048 to clone the host, CPerlHost should have a c interface, sky */
10050 if (flags & CLONEf_CLONE_HOST) {
10051 return perl_clone_host(proto_perl,flags);
10053 return perl_clone_using(proto_perl, flags,
10055 proto_perl->IMemShared,
10056 proto_perl->IMemParse,
10058 proto_perl->IStdIO,
10062 proto_perl->IProc);
10066 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10067 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10068 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10069 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10070 struct IPerlDir* ipD, struct IPerlSock* ipS,
10071 struct IPerlProc* ipP)
10073 /* XXX many of the string copies here can be optimized if they're
10074 * constants; they need to be allocated as common memory and just
10075 * their pointers copied. */
10078 CLONE_PARAMS clone_params;
10079 CLONE_PARAMS* param = &clone_params;
10081 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10082 /* for each stash, determine whether its objects should be cloned */
10083 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10084 PERL_SET_THX(my_perl);
10087 Poison(my_perl, 1, PerlInterpreter);
10089 PL_curcop = (COP *)Nullop;
10093 PL_savestack_ix = 0;
10094 PL_savestack_max = -1;
10095 PL_sig_pending = 0;
10096 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10097 # else /* !DEBUGGING */
10098 Zero(my_perl, 1, PerlInterpreter);
10099 # endif /* DEBUGGING */
10101 /* host pointers */
10103 PL_MemShared = ipMS;
10104 PL_MemParse = ipMP;
10111 #else /* !PERL_IMPLICIT_SYS */
10113 CLONE_PARAMS clone_params;
10114 CLONE_PARAMS* param = &clone_params;
10115 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10116 /* for each stash, determine whether its objects should be cloned */
10117 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10118 PERL_SET_THX(my_perl);
10121 Poison(my_perl, 1, PerlInterpreter);
10123 PL_curcop = (COP *)Nullop;
10127 PL_savestack_ix = 0;
10128 PL_savestack_max = -1;
10129 PL_sig_pending = 0;
10130 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10131 # else /* !DEBUGGING */
10132 Zero(my_perl, 1, PerlInterpreter);
10133 # endif /* DEBUGGING */
10134 #endif /* PERL_IMPLICIT_SYS */
10135 param->flags = flags;
10136 param->proto_perl = proto_perl;
10138 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10139 Zero(&PL_body_roots, 1, PL_body_roots);
10141 PL_nice_chunk = NULL;
10142 PL_nice_chunk_size = 0;
10144 PL_sv_objcount = 0;
10145 PL_sv_root = Nullsv;
10146 PL_sv_arenaroot = Nullsv;
10148 PL_debug = proto_perl->Idebug;
10150 PL_hash_seed = proto_perl->Ihash_seed;
10151 PL_rehash_seed = proto_perl->Irehash_seed;
10153 #ifdef USE_REENTRANT_API
10154 /* XXX: things like -Dm will segfault here in perlio, but doing
10155 * PERL_SET_CONTEXT(proto_perl);
10156 * breaks too many other things
10158 Perl_reentrant_init(aTHX);
10161 /* create SV map for pointer relocation */
10162 PL_ptr_table = ptr_table_new();
10164 /* initialize these special pointers as early as possible */
10165 SvANY(&PL_sv_undef) = NULL;
10166 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10167 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10168 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10170 SvANY(&PL_sv_no) = new_XPVNV();
10171 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10172 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10173 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10174 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10175 SvCUR_set(&PL_sv_no, 0);
10176 SvLEN_set(&PL_sv_no, 1);
10177 SvIV_set(&PL_sv_no, 0);
10178 SvNV_set(&PL_sv_no, 0);
10179 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10181 SvANY(&PL_sv_yes) = new_XPVNV();
10182 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10183 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10184 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10185 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10186 SvCUR_set(&PL_sv_yes, 1);
10187 SvLEN_set(&PL_sv_yes, 2);
10188 SvIV_set(&PL_sv_yes, 1);
10189 SvNV_set(&PL_sv_yes, 1);
10190 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10192 /* create (a non-shared!) shared string table */
10193 PL_strtab = newHV();
10194 HvSHAREKEYS_off(PL_strtab);
10195 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10196 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10198 PL_compiling = proto_perl->Icompiling;
10200 /* These two PVs will be free'd special way so must set them same way op.c does */
10201 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10202 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10204 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10205 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10207 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10208 if (!specialWARN(PL_compiling.cop_warnings))
10209 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10210 if (!specialCopIO(PL_compiling.cop_io))
10211 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10212 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10214 /* pseudo environmental stuff */
10215 PL_origargc = proto_perl->Iorigargc;
10216 PL_origargv = proto_perl->Iorigargv;
10218 param->stashes = newAV(); /* Setup array of objects to call clone on */
10220 /* Set tainting stuff before PerlIO_debug can possibly get called */
10221 PL_tainting = proto_perl->Itainting;
10222 PL_taint_warn = proto_perl->Itaint_warn;
10224 #ifdef PERLIO_LAYERS
10225 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10226 PerlIO_clone(aTHX_ proto_perl, param);
10229 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10230 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10231 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10232 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10233 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10234 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10237 PL_minus_c = proto_perl->Iminus_c;
10238 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10239 PL_localpatches = proto_perl->Ilocalpatches;
10240 PL_splitstr = proto_perl->Isplitstr;
10241 PL_preprocess = proto_perl->Ipreprocess;
10242 PL_minus_n = proto_perl->Iminus_n;
10243 PL_minus_p = proto_perl->Iminus_p;
10244 PL_minus_l = proto_perl->Iminus_l;
10245 PL_minus_a = proto_perl->Iminus_a;
10246 PL_minus_F = proto_perl->Iminus_F;
10247 PL_doswitches = proto_perl->Idoswitches;
10248 PL_dowarn = proto_perl->Idowarn;
10249 PL_doextract = proto_perl->Idoextract;
10250 PL_sawampersand = proto_perl->Isawampersand;
10251 PL_unsafe = proto_perl->Iunsafe;
10252 PL_inplace = SAVEPV(proto_perl->Iinplace);
10253 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10254 PL_perldb = proto_perl->Iperldb;
10255 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10256 PL_exit_flags = proto_perl->Iexit_flags;
10258 /* magical thingies */
10259 /* XXX time(&PL_basetime) when asked for? */
10260 PL_basetime = proto_perl->Ibasetime;
10261 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10263 PL_maxsysfd = proto_perl->Imaxsysfd;
10264 PL_multiline = proto_perl->Imultiline;
10265 PL_statusvalue = proto_perl->Istatusvalue;
10267 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10269 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10271 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10273 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10274 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10275 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10277 /* Clone the regex array */
10278 PL_regex_padav = newAV();
10280 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10281 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10283 av_push(PL_regex_padav,
10284 sv_dup_inc(regexen[0],param));
10285 for(i = 1; i <= len; i++) {
10286 if(SvREPADTMP(regexen[i])) {
10287 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10289 av_push(PL_regex_padav,
10291 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10292 SvIVX(regexen[i])), param)))
10297 PL_regex_pad = AvARRAY(PL_regex_padav);
10299 /* shortcuts to various I/O objects */
10300 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10301 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10302 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10303 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10304 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10305 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10307 /* shortcuts to regexp stuff */
10308 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10310 /* shortcuts to misc objects */
10311 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10313 /* shortcuts to debugging objects */
10314 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10315 PL_DBline = gv_dup(proto_perl->IDBline, param);
10316 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10317 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10318 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10319 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10320 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10321 PL_lineary = av_dup(proto_perl->Ilineary, param);
10322 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10324 /* symbol tables */
10325 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10326 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10327 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10328 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10329 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10331 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10332 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10333 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10334 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10335 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10336 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10338 PL_sub_generation = proto_perl->Isub_generation;
10340 /* funky return mechanisms */
10341 PL_forkprocess = proto_perl->Iforkprocess;
10343 /* subprocess state */
10344 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10346 /* internal state */
10347 PL_maxo = proto_perl->Imaxo;
10348 if (proto_perl->Iop_mask)
10349 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10351 PL_op_mask = Nullch;
10352 /* PL_asserting = proto_perl->Iasserting; */
10354 /* current interpreter roots */
10355 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10356 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10357 PL_main_start = proto_perl->Imain_start;
10358 PL_eval_root = proto_perl->Ieval_root;
10359 PL_eval_start = proto_perl->Ieval_start;
10361 /* runtime control stuff */
10362 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10363 PL_copline = proto_perl->Icopline;
10365 PL_filemode = proto_perl->Ifilemode;
10366 PL_lastfd = proto_perl->Ilastfd;
10367 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10370 PL_gensym = proto_perl->Igensym;
10371 PL_preambled = proto_perl->Ipreambled;
10372 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10373 PL_laststatval = proto_perl->Ilaststatval;
10374 PL_laststype = proto_perl->Ilaststype;
10375 PL_mess_sv = Nullsv;
10377 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10379 /* interpreter atexit processing */
10380 PL_exitlistlen = proto_perl->Iexitlistlen;
10381 if (PL_exitlistlen) {
10382 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10383 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10386 PL_exitlist = (PerlExitListEntry*)NULL;
10387 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10388 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10389 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10391 PL_profiledata = NULL;
10392 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10393 /* PL_rsfp_filters entries have fake IoDIRP() */
10394 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10396 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10398 PAD_CLONE_VARS(proto_perl, param);
10400 #ifdef HAVE_INTERP_INTERN
10401 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10404 /* more statics moved here */
10405 PL_generation = proto_perl->Igeneration;
10406 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10408 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10409 PL_in_clean_all = proto_perl->Iin_clean_all;
10411 PL_uid = proto_perl->Iuid;
10412 PL_euid = proto_perl->Ieuid;
10413 PL_gid = proto_perl->Igid;
10414 PL_egid = proto_perl->Iegid;
10415 PL_nomemok = proto_perl->Inomemok;
10416 PL_an = proto_perl->Ian;
10417 PL_evalseq = proto_perl->Ievalseq;
10418 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10419 PL_origalen = proto_perl->Iorigalen;
10420 #ifdef PERL_USES_PL_PIDSTATUS
10421 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10423 PL_osname = SAVEPV(proto_perl->Iosname);
10424 PL_sighandlerp = proto_perl->Isighandlerp;
10426 PL_runops = proto_perl->Irunops;
10428 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10431 PL_cshlen = proto_perl->Icshlen;
10432 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10435 PL_lex_state = proto_perl->Ilex_state;
10436 PL_lex_defer = proto_perl->Ilex_defer;
10437 PL_lex_expect = proto_perl->Ilex_expect;
10438 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10439 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10440 PL_lex_starts = proto_perl->Ilex_starts;
10441 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10442 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10443 PL_lex_op = proto_perl->Ilex_op;
10444 PL_lex_inpat = proto_perl->Ilex_inpat;
10445 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10446 PL_lex_brackets = proto_perl->Ilex_brackets;
10447 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10448 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10449 PL_lex_casemods = proto_perl->Ilex_casemods;
10450 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10451 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10453 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10454 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10455 PL_nexttoke = proto_perl->Inexttoke;
10457 /* XXX This is probably masking the deeper issue of why
10458 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10459 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10460 * (A little debugging with a watchpoint on it may help.)
10462 if (SvANY(proto_perl->Ilinestr)) {
10463 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10464 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10465 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10466 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10467 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10468 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10469 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10470 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10471 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10474 PL_linestr = NEWSV(65,79);
10475 sv_upgrade(PL_linestr,SVt_PVIV);
10476 sv_setpvn(PL_linestr,"",0);
10477 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10479 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10480 PL_pending_ident = proto_perl->Ipending_ident;
10481 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10483 PL_expect = proto_perl->Iexpect;
10485 PL_multi_start = proto_perl->Imulti_start;
10486 PL_multi_end = proto_perl->Imulti_end;
10487 PL_multi_open = proto_perl->Imulti_open;
10488 PL_multi_close = proto_perl->Imulti_close;
10490 PL_error_count = proto_perl->Ierror_count;
10491 PL_subline = proto_perl->Isubline;
10492 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10494 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10495 if (SvANY(proto_perl->Ilinestr)) {
10496 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10497 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10498 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10499 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10500 PL_last_lop_op = proto_perl->Ilast_lop_op;
10503 PL_last_uni = SvPVX(PL_linestr);
10504 PL_last_lop = SvPVX(PL_linestr);
10505 PL_last_lop_op = 0;
10507 PL_in_my = proto_perl->Iin_my;
10508 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10510 PL_cryptseen = proto_perl->Icryptseen;
10513 PL_hints = proto_perl->Ihints;
10515 PL_amagic_generation = proto_perl->Iamagic_generation;
10517 #ifdef USE_LOCALE_COLLATE
10518 PL_collation_ix = proto_perl->Icollation_ix;
10519 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10520 PL_collation_standard = proto_perl->Icollation_standard;
10521 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10522 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10523 #endif /* USE_LOCALE_COLLATE */
10525 #ifdef USE_LOCALE_NUMERIC
10526 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10527 PL_numeric_standard = proto_perl->Inumeric_standard;
10528 PL_numeric_local = proto_perl->Inumeric_local;
10529 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10530 #endif /* !USE_LOCALE_NUMERIC */
10532 /* utf8 character classes */
10533 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10534 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10535 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10536 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10537 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10538 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10539 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10540 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10541 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10542 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10543 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10544 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10545 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10546 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10547 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10548 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10549 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10550 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10551 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10552 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10554 /* Did the locale setup indicate UTF-8? */
10555 PL_utf8locale = proto_perl->Iutf8locale;
10556 /* Unicode features (see perlrun/-C) */
10557 PL_unicode = proto_perl->Iunicode;
10559 /* Pre-5.8 signals control */
10560 PL_signals = proto_perl->Isignals;
10562 /* times() ticks per second */
10563 PL_clocktick = proto_perl->Iclocktick;
10565 /* Recursion stopper for PerlIO_find_layer */
10566 PL_in_load_module = proto_perl->Iin_load_module;
10568 /* sort() routine */
10569 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10571 /* Not really needed/useful since the reenrant_retint is "volatile",
10572 * but do it for consistency's sake. */
10573 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10575 /* Hooks to shared SVs and locks. */
10576 PL_sharehook = proto_perl->Isharehook;
10577 PL_lockhook = proto_perl->Ilockhook;
10578 PL_unlockhook = proto_perl->Iunlockhook;
10579 PL_threadhook = proto_perl->Ithreadhook;
10581 PL_runops_std = proto_perl->Irunops_std;
10582 PL_runops_dbg = proto_perl->Irunops_dbg;
10584 #ifdef THREADS_HAVE_PIDS
10585 PL_ppid = proto_perl->Ippid;
10589 PL_last_swash_hv = Nullhv; /* reinits on demand */
10590 PL_last_swash_klen = 0;
10591 PL_last_swash_key[0]= '\0';
10592 PL_last_swash_tmps = (U8*)NULL;
10593 PL_last_swash_slen = 0;
10595 PL_glob_index = proto_perl->Iglob_index;
10596 PL_srand_called = proto_perl->Isrand_called;
10597 PL_uudmap['M'] = 0; /* reinits on demand */
10598 PL_bitcount = Nullch; /* reinits on demand */
10600 if (proto_perl->Ipsig_pend) {
10601 Newxz(PL_psig_pend, SIG_SIZE, int);
10604 PL_psig_pend = (int*)NULL;
10607 if (proto_perl->Ipsig_ptr) {
10608 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10609 Newxz(PL_psig_name, SIG_SIZE, SV*);
10610 for (i = 1; i < SIG_SIZE; i++) {
10611 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10612 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10616 PL_psig_ptr = (SV**)NULL;
10617 PL_psig_name = (SV**)NULL;
10620 /* thrdvar.h stuff */
10622 if (flags & CLONEf_COPY_STACKS) {
10623 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10624 PL_tmps_ix = proto_perl->Ttmps_ix;
10625 PL_tmps_max = proto_perl->Ttmps_max;
10626 PL_tmps_floor = proto_perl->Ttmps_floor;
10627 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10629 while (i <= PL_tmps_ix) {
10630 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10634 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10635 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10636 Newxz(PL_markstack, i, I32);
10637 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10638 - proto_perl->Tmarkstack);
10639 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10640 - proto_perl->Tmarkstack);
10641 Copy(proto_perl->Tmarkstack, PL_markstack,
10642 PL_markstack_ptr - PL_markstack + 1, I32);
10644 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10645 * NOTE: unlike the others! */
10646 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10647 PL_scopestack_max = proto_perl->Tscopestack_max;
10648 Newxz(PL_scopestack, PL_scopestack_max, I32);
10649 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10651 /* NOTE: si_dup() looks at PL_markstack */
10652 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10654 /* PL_curstack = PL_curstackinfo->si_stack; */
10655 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10656 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10658 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10659 PL_stack_base = AvARRAY(PL_curstack);
10660 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10661 - proto_perl->Tstack_base);
10662 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10664 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10665 * NOTE: unlike the others! */
10666 PL_savestack_ix = proto_perl->Tsavestack_ix;
10667 PL_savestack_max = proto_perl->Tsavestack_max;
10668 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10669 PL_savestack = ss_dup(proto_perl, param);
10673 ENTER; /* perl_destruct() wants to LEAVE; */
10676 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10677 PL_top_env = &PL_start_env;
10679 PL_op = proto_perl->Top;
10682 PL_Xpv = (XPV*)NULL;
10683 PL_na = proto_perl->Tna;
10685 PL_statbuf = proto_perl->Tstatbuf;
10686 PL_statcache = proto_perl->Tstatcache;
10687 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10688 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10690 PL_timesbuf = proto_perl->Ttimesbuf;
10693 PL_tainted = proto_perl->Ttainted;
10694 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10695 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10696 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10697 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10698 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10699 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10700 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10701 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10702 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10704 PL_restartop = proto_perl->Trestartop;
10705 PL_in_eval = proto_perl->Tin_eval;
10706 PL_delaymagic = proto_perl->Tdelaymagic;
10707 PL_dirty = proto_perl->Tdirty;
10708 PL_localizing = proto_perl->Tlocalizing;
10710 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10711 PL_hv_fetch_ent_mh = Nullhe;
10712 PL_modcount = proto_perl->Tmodcount;
10713 PL_lastgotoprobe = Nullop;
10714 PL_dumpindent = proto_perl->Tdumpindent;
10716 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10717 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10718 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10719 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10720 PL_efloatbuf = Nullch; /* reinits on demand */
10721 PL_efloatsize = 0; /* reinits on demand */
10725 PL_screamfirst = NULL;
10726 PL_screamnext = NULL;
10727 PL_maxscream = -1; /* reinits on demand */
10728 PL_lastscream = Nullsv;
10730 PL_watchaddr = NULL;
10731 PL_watchok = Nullch;
10733 PL_regdummy = proto_perl->Tregdummy;
10734 PL_regprecomp = Nullch;
10737 PL_colorset = 0; /* reinits PL_colors[] */
10738 /*PL_colors[6] = {0,0,0,0,0,0};*/
10739 PL_reginput = Nullch;
10740 PL_regbol = Nullch;
10741 PL_regeol = Nullch;
10742 PL_regstartp = (I32*)NULL;
10743 PL_regendp = (I32*)NULL;
10744 PL_reglastparen = (U32*)NULL;
10745 PL_reglastcloseparen = (U32*)NULL;
10746 PL_regtill = Nullch;
10747 PL_reg_start_tmp = (char**)NULL;
10748 PL_reg_start_tmpl = 0;
10749 PL_regdata = (struct reg_data*)NULL;
10752 PL_reg_eval_set = 0;
10754 PL_regprogram = (regnode*)NULL;
10756 PL_regcc = (CURCUR*)NULL;
10757 PL_reg_call_cc = (struct re_cc_state*)NULL;
10758 PL_reg_re = (regexp*)NULL;
10759 PL_reg_ganch = Nullch;
10760 PL_reg_sv = Nullsv;
10761 PL_reg_match_utf8 = FALSE;
10762 PL_reg_magic = (MAGIC*)NULL;
10764 PL_reg_oldcurpm = (PMOP*)NULL;
10765 PL_reg_curpm = (PMOP*)NULL;
10766 PL_reg_oldsaved = Nullch;
10767 PL_reg_oldsavedlen = 0;
10768 #ifdef PERL_OLD_COPY_ON_WRITE
10771 PL_reg_maxiter = 0;
10772 PL_reg_leftiter = 0;
10773 PL_reg_poscache = Nullch;
10774 PL_reg_poscache_size= 0;
10776 /* RE engine - function pointers */
10777 PL_regcompp = proto_perl->Tregcompp;
10778 PL_regexecp = proto_perl->Tregexecp;
10779 PL_regint_start = proto_perl->Tregint_start;
10780 PL_regint_string = proto_perl->Tregint_string;
10781 PL_regfree = proto_perl->Tregfree;
10783 PL_reginterp_cnt = 0;
10784 PL_reg_starttry = 0;
10786 /* Pluggable optimizer */
10787 PL_peepp = proto_perl->Tpeepp;
10789 PL_stashcache = newHV();
10791 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10792 ptr_table_free(PL_ptr_table);
10793 PL_ptr_table = NULL;
10796 /* Call the ->CLONE method, if it exists, for each of the stashes
10797 identified by sv_dup() above.
10799 while(av_len(param->stashes) != -1) {
10800 HV* const stash = (HV*) av_shift(param->stashes);
10801 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10802 if (cloner && GvCV(cloner)) {
10807 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10809 call_sv((SV*)GvCV(cloner), G_DISCARD);
10815 SvREFCNT_dec(param->stashes);
10817 /* orphaned? eg threads->new inside BEGIN or use */
10818 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10819 (void)SvREFCNT_inc(PL_compcv);
10820 SAVEFREESV(PL_compcv);
10826 #endif /* USE_ITHREADS */
10829 =head1 Unicode Support
10831 =for apidoc sv_recode_to_utf8
10833 The encoding is assumed to be an Encode object, on entry the PV
10834 of the sv is assumed to be octets in that encoding, and the sv
10835 will be converted into Unicode (and UTF-8).
10837 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10838 is not a reference, nothing is done to the sv. If the encoding is not
10839 an C<Encode::XS> Encoding object, bad things will happen.
10840 (See F<lib/encoding.pm> and L<Encode>).
10842 The PV of the sv is returned.
10847 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10850 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10864 Passing sv_yes is wrong - it needs to be or'ed set of constants
10865 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10866 remove converted chars from source.
10868 Both will default the value - let them.
10870 XPUSHs(&PL_sv_yes);
10873 call_method("decode", G_SCALAR);
10877 s = SvPV_const(uni, len);
10878 if (s != SvPVX_const(sv)) {
10879 SvGROW(sv, len + 1);
10880 Move(s, SvPVX(sv), len + 1, char);
10881 SvCUR_set(sv, len);
10888 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10892 =for apidoc sv_cat_decode
10894 The encoding is assumed to be an Encode object, the PV of the ssv is
10895 assumed to be octets in that encoding and decoding the input starts
10896 from the position which (PV + *offset) pointed to. The dsv will be
10897 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10898 when the string tstr appears in decoding output or the input ends on
10899 the PV of the ssv. The value which the offset points will be modified
10900 to the last input position on the ssv.
10902 Returns TRUE if the terminator was found, else returns FALSE.
10907 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10908 SV *ssv, int *offset, char *tstr, int tlen)
10912 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10923 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10924 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10926 call_method("cat_decode", G_SCALAR);
10928 ret = SvTRUE(TOPs);
10929 *offset = SvIV(offsv);
10935 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10940 /* ---------------------------------------------------------------------
10942 * support functions for report_uninit()
10945 /* the maxiumum size of array or hash where we will scan looking
10946 * for the undefined element that triggered the warning */
10948 #define FUV_MAX_SEARCH_SIZE 1000
10950 /* Look for an entry in the hash whose value has the same SV as val;
10951 * If so, return a mortal copy of the key. */
10954 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10957 register HE **array;
10960 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10961 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10964 array = HvARRAY(hv);
10966 for (i=HvMAX(hv); i>0; i--) {
10967 register HE *entry;
10968 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10969 if (HeVAL(entry) != val)
10971 if ( HeVAL(entry) == &PL_sv_undef ||
10972 HeVAL(entry) == &PL_sv_placeholder)
10976 if (HeKLEN(entry) == HEf_SVKEY)
10977 return sv_mortalcopy(HeKEY_sv(entry));
10978 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10984 /* Look for an entry in the array whose value has the same SV as val;
10985 * If so, return the index, otherwise return -1. */
10988 S_find_array_subscript(pTHX_ AV *av, SV* val)
10992 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10993 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10997 for (i=AvFILLp(av); i>=0; i--) {
10998 if (svp[i] == val && svp[i] != &PL_sv_undef)
11004 /* S_varname(): return the name of a variable, optionally with a subscript.
11005 * If gv is non-zero, use the name of that global, along with gvtype (one
11006 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11007 * targ. Depending on the value of the subscript_type flag, return:
11010 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11011 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11012 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11013 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11016 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11017 SV* keyname, I32 aindex, int subscript_type)
11020 SV * const name = sv_newmortal();
11023 buffer[0] = gvtype;
11026 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11028 gv_fullname4(name, gv, buffer, 0);
11030 if ((unsigned int)SvPVX(name)[1] <= 26) {
11032 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11034 /* Swap the 1 unprintable control character for the 2 byte pretty
11035 version - ie substr($name, 1, 1) = $buffer; */
11036 sv_insert(name, 1, 1, buffer, 2);
11041 CV * const cv = find_runcv(&unused);
11045 if (!cv || !CvPADLIST(cv))
11047 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11048 sv = *av_fetch(av, targ, FALSE);
11049 /* SvLEN in a pad name is not to be trusted */
11050 sv_setpv(name, SvPV_nolen_const(sv));
11053 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11054 SV * const sv = NEWSV(0,0);
11055 *SvPVX(name) = '$';
11056 Perl_sv_catpvf(aTHX_ name, "{%s}",
11057 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11060 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11061 *SvPVX(name) = '$';
11062 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11064 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11065 sv_insert(name, 0, 0, "within ", 7);
11072 =for apidoc find_uninit_var
11074 Find the name of the undefined variable (if any) that caused the operator o
11075 to issue a "Use of uninitialized value" warning.
11076 If match is true, only return a name if it's value matches uninit_sv.
11077 So roughly speaking, if a unary operator (such as OP_COS) generates a
11078 warning, then following the direct child of the op may yield an
11079 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11080 other hand, with OP_ADD there are two branches to follow, so we only print
11081 the variable name if we get an exact match.
11083 The name is returned as a mortal SV.
11085 Assumes that PL_op is the op that originally triggered the error, and that
11086 PL_comppad/PL_curpad points to the currently executing pad.
11092 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11100 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11101 uninit_sv == &PL_sv_placeholder)))
11104 switch (obase->op_type) {
11111 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11112 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11114 SV *keysv = Nullsv;
11115 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11117 if (pad) { /* @lex, %lex */
11118 sv = PAD_SVl(obase->op_targ);
11122 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11123 /* @global, %global */
11124 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11127 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11129 else /* @{expr}, %{expr} */
11130 return find_uninit_var(cUNOPx(obase)->op_first,
11134 /* attempt to find a match within the aggregate */
11136 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11138 subscript_type = FUV_SUBSCRIPT_HASH;
11141 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11143 subscript_type = FUV_SUBSCRIPT_ARRAY;
11146 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11149 return varname(gv, hash ? '%' : '@', obase->op_targ,
11150 keysv, index, subscript_type);
11154 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11156 return varname(Nullgv, '$', obase->op_targ,
11157 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11160 gv = cGVOPx_gv(obase);
11161 if (!gv || (match && GvSV(gv) != uninit_sv))
11163 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11166 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11169 av = (AV*)PAD_SV(obase->op_targ);
11170 if (!av || SvRMAGICAL(av))
11172 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11173 if (!svp || *svp != uninit_sv)
11176 return varname(Nullgv, '$', obase->op_targ,
11177 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11180 gv = cGVOPx_gv(obase);
11186 if (!av || SvRMAGICAL(av))
11188 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11189 if (!svp || *svp != uninit_sv)
11192 return varname(gv, '$', 0,
11193 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11198 o = cUNOPx(obase)->op_first;
11199 if (!o || o->op_type != OP_NULL ||
11200 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11202 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11206 if (PL_op == obase)
11207 /* $a[uninit_expr] or $h{uninit_expr} */
11208 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11211 o = cBINOPx(obase)->op_first;
11212 kid = cBINOPx(obase)->op_last;
11214 /* get the av or hv, and optionally the gv */
11216 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11217 sv = PAD_SV(o->op_targ);
11219 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11220 && cUNOPo->op_first->op_type == OP_GV)
11222 gv = cGVOPx_gv(cUNOPo->op_first);
11225 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11230 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11231 /* index is constant */
11235 if (obase->op_type == OP_HELEM) {
11236 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11237 if (!he || HeVAL(he) != uninit_sv)
11241 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11242 if (!svp || *svp != uninit_sv)
11246 if (obase->op_type == OP_HELEM)
11247 return varname(gv, '%', o->op_targ,
11248 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11250 return varname(gv, '@', o->op_targ, Nullsv,
11251 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11255 /* index is an expression;
11256 * attempt to find a match within the aggregate */
11257 if (obase->op_type == OP_HELEM) {
11258 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11260 return varname(gv, '%', o->op_targ,
11261 keysv, 0, FUV_SUBSCRIPT_HASH);
11264 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11266 return varname(gv, '@', o->op_targ,
11267 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11272 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11274 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11280 /* only examine RHS */
11281 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11284 o = cUNOPx(obase)->op_first;
11285 if (o->op_type == OP_PUSHMARK)
11288 if (!o->op_sibling) {
11289 /* one-arg version of open is highly magical */
11291 if (o->op_type == OP_GV) { /* open FOO; */
11293 if (match && GvSV(gv) != uninit_sv)
11295 return varname(gv, '$', 0,
11296 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11298 /* other possibilities not handled are:
11299 * open $x; or open my $x; should return '${*$x}'
11300 * open expr; should return '$'.expr ideally
11306 /* ops where $_ may be an implicit arg */
11310 if ( !(obase->op_flags & OPf_STACKED)) {
11311 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11312 ? PAD_SVl(obase->op_targ)
11315 sv = sv_newmortal();
11316 sv_setpvn(sv, "$_", 2);
11324 /* skip filehandle as it can't produce 'undef' warning */
11325 o = cUNOPx(obase)->op_first;
11326 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11327 o = o->op_sibling->op_sibling;
11334 match = 1; /* XS or custom code could trigger random warnings */
11339 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11340 return sv_2mortal(newSVpvn("${$/}", 5));
11345 if (!(obase->op_flags & OPf_KIDS))
11347 o = cUNOPx(obase)->op_first;
11353 /* if all except one arg are constant, or have no side-effects,
11354 * or are optimized away, then it's unambiguous */
11356 for (kid=o; kid; kid = kid->op_sibling) {
11358 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11359 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11360 || (kid->op_type == OP_PUSHMARK)
11364 if (o2) { /* more than one found */
11371 return find_uninit_var(o2, uninit_sv, match);
11373 /* scan all args */
11375 sv = find_uninit_var(o, uninit_sv, 1);
11387 =for apidoc report_uninit
11389 Print appropriate "Use of uninitialized variable" warning
11395 Perl_report_uninit(pTHX_ SV* uninit_sv)
11398 SV* varname = Nullsv;
11400 varname = find_uninit_var(PL_op, uninit_sv,0);
11402 sv_insert(varname, 0, 0, " ", 1);
11404 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11405 varname ? SvPV_nolen_const(varname) : "",
11406 " in ", OP_DESC(PL_op));
11409 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11415 * c-indentation-style: bsd
11416 * c-basic-offset: 4
11417 * indent-tabs-mode: t
11420 * ex: set ts=8 sts=4 sw=4 noet: