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);
1806 SvUV_set(sv, U_V(SvNVX(sv)));
1807 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1808 NV preservse UV so can do correct comparison. */
1809 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1813 /* Integer is imprecise. NOK, IOKp, is UV */
1818 #else /* NV_PRESERVES_UV */
1819 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1820 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1821 /* The IV/UV slot will have been set from value returned by
1822 grok_number above. The NV slot has just been set using
1825 assert (SvIOKp(sv));
1827 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1828 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1829 /* Small enough to preserve all bits. */
1830 (void)SvIOKp_on(sv);
1832 SvIV_set(sv, I_V(SvNVX(sv)));
1833 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1835 /* Assumption: first non-preserved integer is < IV_MAX,
1836 this NV is in the preserved range, therefore: */
1837 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1839 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);
1843 0 0 already failed to read UV.
1844 0 1 already failed to read UV.
1845 1 0 you won't get here in this case. IV/UV
1846 slot set, public IOK, Atof() unneeded.
1847 1 1 already read UV.
1848 so there's no point in sv_2iuv_non_preserve() attempting
1849 to use atol, strtol, strtoul etc. */
1850 sv_2iuv_non_preserve (sv, numtype);
1853 #endif /* NV_PRESERVES_UV */
1857 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1858 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1861 if (SvTYPE(sv) < SVt_IV)
1862 /* Typically the caller expects that sv_any is not NULL now. */
1863 sv_upgrade(sv, SVt_IV);
1864 /* Return 0 from the caller. */
1871 =for apidoc sv_2iv_flags
1873 Return the integer value of an SV, doing any necessary string
1874 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1875 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1881 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1885 if (SvGMAGICAL(sv)) {
1886 if (flags & SV_GMAGIC)
1891 return I_V(SvNVX(sv));
1893 if (SvPOKp(sv) && SvLEN(sv))
1896 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1897 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1903 if (SvTHINKFIRST(sv)) {
1906 SV * const tmpstr=AMG_CALLun(sv,numer);
1907 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1908 return SvIV(tmpstr);
1911 return PTR2IV(SvRV(sv));
1914 sv_force_normal_flags(sv, 0);
1916 if (SvREADONLY(sv) && !SvOK(sv)) {
1917 if (ckWARN(WARN_UNINITIALIZED))
1923 if (S_sv_2iuv_common(aTHX_ sv))
1926 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1927 PTR2UV(sv),SvIVX(sv)));
1928 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1932 =for apidoc sv_2uv_flags
1934 Return the unsigned integer value of an SV, doing any necessary string
1935 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1936 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1942 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1946 if (SvGMAGICAL(sv)) {
1947 if (flags & SV_GMAGIC)
1952 return U_V(SvNVX(sv));
1953 if (SvPOKp(sv) && SvLEN(sv))
1956 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1957 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1963 if (SvTHINKFIRST(sv)) {
1966 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1967 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1968 return SvUV(tmpstr);
1969 return PTR2UV(SvRV(sv));
1972 sv_force_normal_flags(sv, 0);
1974 if (SvREADONLY(sv) && !SvOK(sv)) {
1975 if (ckWARN(WARN_UNINITIALIZED))
1981 if (S_sv_2iuv_common(aTHX_ sv))
1985 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
1986 PTR2UV(sv),SvUVX(sv)));
1987 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
1993 Return the num value of an SV, doing any necessary string or integer
1994 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2001 Perl_sv_2nv(pTHX_ register SV *sv)
2005 if (SvGMAGICAL(sv)) {
2009 if (SvPOKp(sv) && SvLEN(sv)) {
2010 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2011 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2013 return Atof(SvPVX_const(sv));
2017 return (NV)SvUVX(sv);
2019 return (NV)SvIVX(sv);
2022 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2023 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2029 if (SvTHINKFIRST(sv)) {
2032 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2033 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2034 return SvNV(tmpstr);
2035 return PTR2NV(SvRV(sv));
2038 sv_force_normal_flags(sv, 0);
2040 if (SvREADONLY(sv) && !SvOK(sv)) {
2041 if (ckWARN(WARN_UNINITIALIZED))
2046 if (SvTYPE(sv) < SVt_NV) {
2047 if (SvTYPE(sv) == SVt_IV)
2048 sv_upgrade(sv, SVt_PVNV);
2050 sv_upgrade(sv, SVt_NV);
2051 #ifdef USE_LONG_DOUBLE
2053 STORE_NUMERIC_LOCAL_SET_STANDARD();
2054 PerlIO_printf(Perl_debug_log,
2055 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2056 PTR2UV(sv), SvNVX(sv));
2057 RESTORE_NUMERIC_LOCAL();
2061 STORE_NUMERIC_LOCAL_SET_STANDARD();
2062 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2063 PTR2UV(sv), SvNVX(sv));
2064 RESTORE_NUMERIC_LOCAL();
2068 else if (SvTYPE(sv) < SVt_PVNV)
2069 sv_upgrade(sv, SVt_PVNV);
2074 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2075 #ifdef NV_PRESERVES_UV
2078 /* Only set the public NV OK flag if this NV preserves the IV */
2079 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2080 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2081 : (SvIVX(sv) == I_V(SvNVX(sv))))
2087 else if (SvPOKp(sv) && SvLEN(sv)) {
2089 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2090 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2092 #ifdef NV_PRESERVES_UV
2093 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2094 == IS_NUMBER_IN_UV) {
2095 /* It's definitely an integer */
2096 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2098 SvNV_set(sv, Atof(SvPVX_const(sv)));
2101 SvNV_set(sv, Atof(SvPVX_const(sv)));
2102 /* Only set the public NV OK flag if this NV preserves the value in
2103 the PV at least as well as an IV/UV would.
2104 Not sure how to do this 100% reliably. */
2105 /* if that shift count is out of range then Configure's test is
2106 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2108 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2109 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2110 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2111 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2112 /* Can't use strtol etc to convert this string, so don't try.
2113 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2116 /* value has been set. It may not be precise. */
2117 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2118 /* 2s complement assumption for (UV)IV_MIN */
2119 SvNOK_on(sv); /* Integer is too negative. */
2124 if (numtype & IS_NUMBER_NEG) {
2125 SvIV_set(sv, -(IV)value);
2126 } else if (value <= (UV)IV_MAX) {
2127 SvIV_set(sv, (IV)value);
2129 SvUV_set(sv, value);
2133 if (numtype & IS_NUMBER_NOT_INT) {
2134 /* I believe that even if the original PV had decimals,
2135 they are lost beyond the limit of the FP precision.
2136 However, neither is canonical, so both only get p
2137 flags. NWC, 2000/11/25 */
2138 /* Both already have p flags, so do nothing */
2140 const NV nv = SvNVX(sv);
2141 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2142 if (SvIVX(sv) == I_V(nv)) {
2147 /* It had no "." so it must be integer. */
2150 /* between IV_MAX and NV(UV_MAX).
2151 Could be slightly > UV_MAX */
2153 if (numtype & IS_NUMBER_NOT_INT) {
2154 /* UV and NV both imprecise. */
2156 const UV nv_as_uv = U_V(nv);
2158 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2169 #endif /* NV_PRESERVES_UV */
2172 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2174 if (SvTYPE(sv) < SVt_NV)
2175 /* Typically the caller expects that sv_any is not NULL now. */
2176 /* XXX Ilya implies that this is a bug in callers that assume this
2177 and ideally should be fixed. */
2178 sv_upgrade(sv, SVt_NV);
2181 #if defined(USE_LONG_DOUBLE)
2183 STORE_NUMERIC_LOCAL_SET_STANDARD();
2184 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2185 PTR2UV(sv), SvNVX(sv));
2186 RESTORE_NUMERIC_LOCAL();
2190 STORE_NUMERIC_LOCAL_SET_STANDARD();
2191 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2192 PTR2UV(sv), SvNVX(sv));
2193 RESTORE_NUMERIC_LOCAL();
2199 /* asIV(): extract an integer from the string value of an SV.
2200 * Caller must validate PVX */
2203 S_asIV(pTHX_ SV *sv)
2206 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 == IS_NUMBER_IN_UV) {
2210 /* It's definitely an integer */
2211 if (numtype & IS_NUMBER_NEG) {
2212 if (value < (UV)IV_MIN)
2215 if (value < (UV)IV_MAX)
2220 if (ckWARN(WARN_NUMERIC))
2223 return I_V(Atof(SvPVX_const(sv)));
2226 /* asUV(): extract an unsigned integer from the string value of an SV
2227 * Caller must validate PVX */
2230 S_asUV(pTHX_ SV *sv)
2233 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2235 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2236 == IS_NUMBER_IN_UV) {
2237 /* It's definitely an integer */
2238 if (!(numtype & IS_NUMBER_NEG))
2242 if (ckWARN(WARN_NUMERIC))
2245 return U_V(Atof(SvPVX_const(sv)));
2248 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2249 * UV as a string towards the end of buf, and return pointers to start and
2252 * We assume that buf is at least TYPE_CHARS(UV) long.
2256 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2258 char *ptr = buf + TYPE_CHARS(UV);
2259 char * const ebuf = ptr;
2272 *--ptr = '0' + (char)(uv % 10);
2281 =for apidoc sv_2pv_flags
2283 Returns a pointer to the string value of an SV, and sets *lp to its length.
2284 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2286 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2287 usually end up here too.
2293 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2303 if (SvGMAGICAL(sv)) {
2304 if (flags & SV_GMAGIC)
2309 if (flags & SV_MUTABLE_RETURN)
2310 return SvPVX_mutable(sv);
2311 if (flags & SV_CONST_RETURN)
2312 return (char *)SvPVX_const(sv);
2315 if (SvIOKp(sv) || SvNOKp(sv)) {
2316 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2320 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2321 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2323 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2326 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2327 /* Sneaky stuff here */
2328 SV *tsv = newSVpvn(tbuf, len);
2338 #ifdef FIXNEGATIVEZERO
2339 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2345 SvUPGRADE(sv, SVt_PV);
2348 s = SvGROW_mutable(sv, len + 1);
2351 return memcpy(s, tbuf, len + 1);
2355 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2356 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2364 if (SvTHINKFIRST(sv)) {
2368 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2369 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2371 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2374 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2375 if (flags & SV_CONST_RETURN) {
2376 pv = (char *) SvPVX_const(tmpstr);
2378 pv = (flags & SV_MUTABLE_RETURN)
2379 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2382 *lp = SvCUR(tmpstr);
2384 pv = sv_2pv_flags(tmpstr, lp, flags);
2394 const SV *const referent = (SV*)SvRV(sv);
2397 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2398 } else if (SvTYPE(referent) == SVt_PVMG
2399 && ((SvFLAGS(referent) &
2400 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2401 == (SVs_OBJECT|SVs_SMG))
2402 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2403 const regexp *re = (regexp *)mg->mg_obj;
2406 const char *fptr = "msix";
2411 char need_newline = 0;
2413 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2415 while((ch = *fptr++)) {
2417 reflags[left++] = ch;
2420 reflags[right--] = ch;
2425 reflags[left] = '-';
2429 mg->mg_len = re->prelen + 4 + left;
2431 * If /x was used, we have to worry about a regex
2432 * ending with a comment later being embedded
2433 * within another regex. If so, we don't want this
2434 * regex's "commentization" to leak out to the
2435 * right part of the enclosing regex, we must cap
2436 * it with a newline.
2438 * So, if /x was used, we scan backwards from the
2439 * end of the regex. If we find a '#' before we
2440 * find a newline, we need to add a newline
2441 * ourself. If we find a '\n' first (or if we
2442 * don't find '#' or '\n'), we don't need to add
2443 * anything. -jfriedl
2445 if (PMf_EXTENDED & re->reganch) {
2446 const char *endptr = re->precomp + re->prelen;
2447 while (endptr >= re->precomp) {
2448 const char c = *(endptr--);
2450 break; /* don't need another */
2452 /* we end while in a comment, so we
2454 mg->mg_len++; /* save space for it */
2455 need_newline = 1; /* note to add it */
2461 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2462 mg->mg_ptr[0] = '(';
2463 mg->mg_ptr[1] = '?';
2464 Copy(reflags, mg->mg_ptr+2, left, char);
2465 *(mg->mg_ptr+left+2) = ':';
2466 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2468 mg->mg_ptr[mg->mg_len - 2] = '\n';
2469 mg->mg_ptr[mg->mg_len - 1] = ')';
2470 mg->mg_ptr[mg->mg_len] = 0;
2472 PL_reginterp_cnt += re->program[0].next_off;
2474 if (re->reganch & ROPT_UTF8)
2482 const char *const typestr = sv_reftype(referent, 0);
2484 tsv = sv_newmortal();
2485 if (SvOBJECT(referent)) {
2486 const char *const name = HvNAME_get(SvSTASH(referent));
2487 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2488 name ? name : "__ANON__" , typestr,
2492 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2500 if (SvREADONLY(sv) && !SvOK(sv)) {
2501 if (ckWARN(WARN_UNINITIALIZED))
2508 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2509 /* I'm assuming that if both IV and NV are equally valid then
2510 converting the IV is going to be more efficient */
2511 const U32 isIOK = SvIOK(sv);
2512 const U32 isUIOK = SvIsUV(sv);
2513 char buf[TYPE_CHARS(UV)];
2516 if (SvTYPE(sv) < SVt_PVIV)
2517 sv_upgrade(sv, SVt_PVIV);
2519 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2521 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2522 /* inlined from sv_setpvn */
2523 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2524 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2525 SvCUR_set(sv, ebuf - ptr);
2535 else if (SvNOKp(sv)) {
2536 if (SvTYPE(sv) < SVt_PVNV)
2537 sv_upgrade(sv, SVt_PVNV);
2538 /* The +20 is pure guesswork. Configure test needed. --jhi */
2539 s = SvGROW_mutable(sv, NV_DIG + 20);
2540 olderrno = errno; /* some Xenix systems wipe out errno here */
2542 if (SvNVX(sv) == 0.0)
2543 (void)strcpy(s,"0");
2547 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2550 #ifdef FIXNEGATIVEZERO
2551 if (*s == '-' && s[1] == '0' && !s[2])
2561 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2565 if (SvTYPE(sv) < SVt_PV)
2566 /* Typically the caller expects that sv_any is not NULL now. */
2567 sv_upgrade(sv, SVt_PV);
2571 const STRLEN len = s - SvPVX_const(sv);
2577 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2578 PTR2UV(sv),SvPVX_const(sv)));
2579 if (flags & SV_CONST_RETURN)
2580 return (char *)SvPVX_const(sv);
2581 if (flags & SV_MUTABLE_RETURN)
2582 return SvPVX_mutable(sv);
2587 =for apidoc sv_copypv
2589 Copies a stringified representation of the source SV into the
2590 destination SV. Automatically performs any necessary mg_get and
2591 coercion of numeric values into strings. Guaranteed to preserve
2592 UTF-8 flag even from overloaded objects. Similar in nature to
2593 sv_2pv[_flags] but operates directly on an SV instead of just the
2594 string. Mostly uses sv_2pv_flags to do its work, except when that
2595 would lose the UTF-8'ness of the PV.
2601 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2604 const char * const s = SvPV_const(ssv,len);
2605 sv_setpvn(dsv,s,len);
2613 =for apidoc sv_2pvbyte
2615 Return a pointer to the byte-encoded representation of the SV, and set *lp
2616 to its length. May cause the SV to be downgraded from UTF-8 as a
2619 Usually accessed via the C<SvPVbyte> macro.
2625 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2627 sv_utf8_downgrade(sv,0);
2628 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2632 =for apidoc sv_2pvutf8
2634 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2635 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2637 Usually accessed via the C<SvPVutf8> macro.
2643 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2645 sv_utf8_upgrade(sv);
2646 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2651 =for apidoc sv_2bool
2653 This function is only called on magical items, and is only used by
2654 sv_true() or its macro equivalent.
2660 Perl_sv_2bool(pTHX_ register SV *sv)
2668 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2669 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2670 return (bool)SvTRUE(tmpsv);
2671 return SvRV(sv) != 0;
2674 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2676 (*sv->sv_u.svu_pv > '0' ||
2677 Xpvtmp->xpv_cur > 1 ||
2678 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2685 return SvIVX(sv) != 0;
2688 return SvNVX(sv) != 0.0;
2696 =for apidoc sv_utf8_upgrade
2698 Converts the PV of an SV to its UTF-8-encoded form.
2699 Forces the SV to string form if it is not already.
2700 Always sets the SvUTF8 flag to avoid future validity checks even
2701 if all the bytes have hibit clear.
2703 This is not as a general purpose byte encoding to Unicode interface:
2704 use the Encode extension for that.
2706 =for apidoc sv_utf8_upgrade_flags
2708 Converts the PV of an SV to its UTF-8-encoded form.
2709 Forces the SV to string form if it is not already.
2710 Always sets the SvUTF8 flag to avoid future validity checks even
2711 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2712 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2713 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2715 This is not as a general purpose byte encoding to Unicode interface:
2716 use the Encode extension for that.
2722 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2724 if (sv == &PL_sv_undef)
2728 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2729 (void) sv_2pv_flags(sv,&len, flags);
2733 (void) SvPV_force(sv,len);
2742 sv_force_normal_flags(sv, 0);
2745 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2746 sv_recode_to_utf8(sv, PL_encoding);
2747 else { /* Assume Latin-1/EBCDIC */
2748 /* This function could be much more efficient if we
2749 * had a FLAG in SVs to signal if there are any hibit
2750 * chars in the PV. Given that there isn't such a flag
2751 * make the loop as fast as possible. */
2752 const U8 *s = (U8 *) SvPVX_const(sv);
2753 const U8 * const e = (U8 *) SvEND(sv);
2759 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2763 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2764 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2766 SvPV_free(sv); /* No longer using what was there before. */
2768 SvPV_set(sv, (char*)recoded);
2769 SvCUR_set(sv, len - 1);
2770 SvLEN_set(sv, len); /* No longer know the real size. */
2772 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2779 =for apidoc sv_utf8_downgrade
2781 Attempts to convert the PV of an SV from characters to bytes.
2782 If the PV contains a character beyond byte, this conversion will fail;
2783 in this case, either returns false or, if C<fail_ok> is not
2786 This is not as a general purpose Unicode to byte encoding interface:
2787 use the Encode extension for that.
2793 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2795 if (SvPOKp(sv) && SvUTF8(sv)) {
2801 sv_force_normal_flags(sv, 0);
2803 s = (U8 *) SvPV(sv, len);
2804 if (!utf8_to_bytes(s, &len)) {
2809 Perl_croak(aTHX_ "Wide character in %s",
2812 Perl_croak(aTHX_ "Wide character");
2823 =for apidoc sv_utf8_encode
2825 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2826 flag off so that it looks like octets again.
2832 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2834 (void) sv_utf8_upgrade(sv);
2836 sv_force_normal_flags(sv, 0);
2838 if (SvREADONLY(sv)) {
2839 Perl_croak(aTHX_ PL_no_modify);
2845 =for apidoc sv_utf8_decode
2847 If the PV of the SV is an octet sequence in UTF-8
2848 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2849 so that it looks like a character. If the PV contains only single-byte
2850 characters, the C<SvUTF8> flag stays being off.
2851 Scans PV for validity and returns false if the PV is invalid UTF-8.
2857 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2863 /* The octets may have got themselves encoded - get them back as
2866 if (!sv_utf8_downgrade(sv, TRUE))
2869 /* it is actually just a matter of turning the utf8 flag on, but
2870 * we want to make sure everything inside is valid utf8 first.
2872 c = (const U8 *) SvPVX_const(sv);
2873 if (!is_utf8_string(c, SvCUR(sv)+1))
2875 e = (const U8 *) SvEND(sv);
2878 if (!UTF8_IS_INVARIANT(ch)) {
2888 =for apidoc sv_setsv
2890 Copies the contents of the source SV C<ssv> into the destination SV
2891 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2892 function if the source SV needs to be reused. Does not handle 'set' magic.
2893 Loosely speaking, it performs a copy-by-value, obliterating any previous
2894 content of the destination.
2896 You probably want to use one of the assortment of wrappers, such as
2897 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2898 C<SvSetMagicSV_nosteal>.
2900 =for apidoc sv_setsv_flags
2902 Copies the contents of the source SV C<ssv> into the destination SV
2903 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2904 function if the source SV needs to be reused. Does not handle 'set' magic.
2905 Loosely speaking, it performs a copy-by-value, obliterating any previous
2906 content of the destination.
2907 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2908 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2909 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2910 and C<sv_setsv_nomg> are implemented in terms of this function.
2912 You probably want to use one of the assortment of wrappers, such as
2913 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2914 C<SvSetMagicSV_nosteal>.
2916 This is the primary function for copying scalars, and most other
2917 copy-ish functions and macros use this underneath.
2923 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2925 register U32 sflags;
2931 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2933 sstr = &PL_sv_undef;
2934 stype = SvTYPE(sstr);
2935 dtype = SvTYPE(dstr);
2940 /* need to nuke the magic */
2942 SvRMAGICAL_off(dstr);
2945 /* There's a lot of redundancy below but we're going for speed here */
2950 if (dtype != SVt_PVGV) {
2951 (void)SvOK_off(dstr);
2959 sv_upgrade(dstr, SVt_IV);
2962 sv_upgrade(dstr, SVt_PVNV);
2966 sv_upgrade(dstr, SVt_PVIV);
2969 (void)SvIOK_only(dstr);
2970 SvIV_set(dstr, SvIVX(sstr));
2973 if (SvTAINTED(sstr))
2984 sv_upgrade(dstr, SVt_NV);
2989 sv_upgrade(dstr, SVt_PVNV);
2992 SvNV_set(dstr, SvNVX(sstr));
2993 (void)SvNOK_only(dstr);
2994 if (SvTAINTED(sstr))
3002 sv_upgrade(dstr, SVt_RV);
3003 else if (dtype == SVt_PVGV &&
3004 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3007 if (GvIMPORTED(dstr) != GVf_IMPORTED
3008 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3010 GvIMPORTED_on(dstr);
3019 #ifdef PERL_OLD_COPY_ON_WRITE
3020 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3021 if (dtype < SVt_PVIV)
3022 sv_upgrade(dstr, SVt_PVIV);
3029 sv_upgrade(dstr, SVt_PV);
3032 if (dtype < SVt_PVIV)
3033 sv_upgrade(dstr, SVt_PVIV);
3036 if (dtype < SVt_PVNV)
3037 sv_upgrade(dstr, SVt_PVNV);
3044 const char * const type = sv_reftype(sstr,0);
3046 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3048 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3053 if (dtype <= SVt_PVGV) {
3055 if (dtype != SVt_PVGV) {
3056 const char * const name = GvNAME(sstr);
3057 const STRLEN len = GvNAMELEN(sstr);
3058 /* don't upgrade SVt_PVLV: it can hold a glob */
3059 if (dtype != SVt_PVLV)
3060 sv_upgrade(dstr, SVt_PVGV);
3061 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3062 GvSTASH(dstr) = GvSTASH(sstr);
3064 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3065 GvNAME(dstr) = savepvn(name, len);
3066 GvNAMELEN(dstr) = len;
3067 SvFAKE_on(dstr); /* can coerce to non-glob */
3070 #ifdef GV_UNIQUE_CHECK
3071 if (GvUNIQUE((GV*)dstr)) {
3072 Perl_croak(aTHX_ PL_no_modify);
3076 (void)SvOK_off(dstr);
3077 GvINTRO_off(dstr); /* one-shot flag */
3079 GvGP(dstr) = gp_ref(GvGP(sstr));
3080 if (SvTAINTED(sstr))
3082 if (GvIMPORTED(dstr) != GVf_IMPORTED
3083 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3085 GvIMPORTED_on(dstr);
3093 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3095 if ((int)SvTYPE(sstr) != stype) {
3096 stype = SvTYPE(sstr);
3097 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3101 if (stype == SVt_PVLV)
3102 SvUPGRADE(dstr, SVt_PVNV);
3104 SvUPGRADE(dstr, (U32)stype);
3107 sflags = SvFLAGS(sstr);
3109 if (sflags & SVf_ROK) {
3110 if (dtype >= SVt_PV) {
3111 if (dtype == SVt_PVGV) {
3112 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3114 const int intro = GvINTRO(dstr);
3116 #ifdef GV_UNIQUE_CHECK
3117 if (GvUNIQUE((GV*)dstr)) {
3118 Perl_croak(aTHX_ PL_no_modify);
3123 GvINTRO_off(dstr); /* one-shot flag */
3124 GvLINE(dstr) = CopLINE(PL_curcop);
3125 GvEGV(dstr) = (GV*)dstr;
3128 switch (SvTYPE(sref)) {
3131 SAVEGENERICSV(GvAV(dstr));
3133 dref = (SV*)GvAV(dstr);
3134 GvAV(dstr) = (AV*)sref;
3135 if (!GvIMPORTED_AV(dstr)
3136 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3138 GvIMPORTED_AV_on(dstr);
3143 SAVEGENERICSV(GvHV(dstr));
3145 dref = (SV*)GvHV(dstr);
3146 GvHV(dstr) = (HV*)sref;
3147 if (!GvIMPORTED_HV(dstr)
3148 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3150 GvIMPORTED_HV_on(dstr);
3155 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3156 SvREFCNT_dec(GvCV(dstr));
3157 GvCV(dstr) = Nullcv;
3158 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3159 PL_sub_generation++;
3161 SAVEGENERICSV(GvCV(dstr));
3164 dref = (SV*)GvCV(dstr);
3165 if (GvCV(dstr) != (CV*)sref) {
3166 CV* const cv = GvCV(dstr);
3168 if (!GvCVGEN((GV*)dstr) &&
3169 (CvROOT(cv) || CvXSUB(cv)))
3171 /* Redefining a sub - warning is mandatory if
3172 it was a const and its value changed. */
3173 if (ckWARN(WARN_REDEFINE)
3175 && (!CvCONST((CV*)sref)
3176 || sv_cmp(cv_const_sv(cv),
3177 cv_const_sv((CV*)sref)))))
3179 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3181 ? "Constant subroutine %s::%s redefined"
3182 : "Subroutine %s::%s redefined",
3183 HvNAME_get(GvSTASH((GV*)dstr)),
3184 GvENAME((GV*)dstr));
3188 cv_ckproto(cv, (GV*)dstr,
3190 ? SvPVX_const(sref) : Nullch);
3192 GvCV(dstr) = (CV*)sref;
3193 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3194 GvASSUMECV_on(dstr);
3195 PL_sub_generation++;
3197 if (!GvIMPORTED_CV(dstr)
3198 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3200 GvIMPORTED_CV_on(dstr);
3205 SAVEGENERICSV(GvIOp(dstr));
3207 dref = (SV*)GvIOp(dstr);
3208 GvIOp(dstr) = (IO*)sref;
3212 SAVEGENERICSV(GvFORM(dstr));
3214 dref = (SV*)GvFORM(dstr);
3215 GvFORM(dstr) = (CV*)sref;
3219 SAVEGENERICSV(GvSV(dstr));
3221 dref = (SV*)GvSV(dstr);
3223 if (!GvIMPORTED_SV(dstr)
3224 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3226 GvIMPORTED_SV_on(dstr);
3232 if (SvTAINTED(sstr))
3236 if (SvPVX_const(dstr)) {
3242 (void)SvOK_off(dstr);
3243 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3245 if (sflags & SVp_NOK) {
3247 /* Only set the public OK flag if the source has public OK. */
3248 if (sflags & SVf_NOK)
3249 SvFLAGS(dstr) |= SVf_NOK;
3250 SvNV_set(dstr, SvNVX(sstr));
3252 if (sflags & SVp_IOK) {
3253 (void)SvIOKp_on(dstr);
3254 if (sflags & SVf_IOK)
3255 SvFLAGS(dstr) |= SVf_IOK;
3256 if (sflags & SVf_IVisUV)
3258 SvIV_set(dstr, SvIVX(sstr));
3260 if (SvAMAGIC(sstr)) {
3264 else if (sflags & SVp_POK) {
3268 * Check to see if we can just swipe the string. If so, it's a
3269 * possible small lose on short strings, but a big win on long ones.
3270 * It might even be a win on short strings if SvPVX_const(dstr)
3271 * has to be allocated and SvPVX_const(sstr) has to be freed.
3274 /* Whichever path we take through the next code, we want this true,
3275 and doing it now facilitates the COW check. */
3276 (void)SvPOK_only(dstr);
3279 /* We're not already COW */
3280 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3281 #ifndef PERL_OLD_COPY_ON_WRITE
3282 /* or we are, but dstr isn't a suitable target. */
3283 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3288 (sflags & SVs_TEMP) && /* slated for free anyway? */
3289 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3290 (!(flags & SV_NOSTEAL)) &&
3291 /* and we're allowed to steal temps */
3292 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3293 SvLEN(sstr) && /* and really is a string */
3294 /* and won't be needed again, potentially */
3295 !(PL_op && PL_op->op_type == OP_AASSIGN))
3296 #ifdef PERL_OLD_COPY_ON_WRITE
3297 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3298 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3299 && SvTYPE(sstr) >= SVt_PVIV)
3302 /* Failed the swipe test, and it's not a shared hash key either.
3303 Have to copy the string. */
3304 STRLEN len = SvCUR(sstr);
3305 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3306 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3307 SvCUR_set(dstr, len);
3308 *SvEND(dstr) = '\0';
3310 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3312 /* Either it's a shared hash key, or it's suitable for
3313 copy-on-write or we can swipe the string. */
3315 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3319 #ifdef PERL_OLD_COPY_ON_WRITE
3321 /* I believe I should acquire a global SV mutex if
3322 it's a COW sv (not a shared hash key) to stop
3323 it going un copy-on-write.
3324 If the source SV has gone un copy on write between up there
3325 and down here, then (assert() that) it is of the correct
3326 form to make it copy on write again */
3327 if ((sflags & (SVf_FAKE | SVf_READONLY))
3328 != (SVf_FAKE | SVf_READONLY)) {
3329 SvREADONLY_on(sstr);
3331 /* Make the source SV into a loop of 1.
3332 (about to become 2) */
3333 SV_COW_NEXT_SV_SET(sstr, sstr);
3337 /* Initial code is common. */
3338 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3343 /* making another shared SV. */
3344 STRLEN cur = SvCUR(sstr);
3345 STRLEN len = SvLEN(sstr);
3346 #ifdef PERL_OLD_COPY_ON_WRITE
3348 assert (SvTYPE(dstr) >= SVt_PVIV);
3349 /* SvIsCOW_normal */
3350 /* splice us in between source and next-after-source. */
3351 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3352 SV_COW_NEXT_SV_SET(sstr, dstr);
3353 SvPV_set(dstr, SvPVX_mutable(sstr));
3357 /* SvIsCOW_shared_hash */
3358 DEBUG_C(PerlIO_printf(Perl_debug_log,
3359 "Copy on write: Sharing hash\n"));
3361 assert (SvTYPE(dstr) >= SVt_PV);
3363 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3365 SvLEN_set(dstr, len);
3366 SvCUR_set(dstr, cur);
3367 SvREADONLY_on(dstr);
3369 /* Relesase a global SV mutex. */
3372 { /* Passes the swipe test. */
3373 SvPV_set(dstr, SvPVX_mutable(sstr));
3374 SvLEN_set(dstr, SvLEN(sstr));
3375 SvCUR_set(dstr, SvCUR(sstr));
3378 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3379 SvPV_set(sstr, Nullch);
3385 if (sflags & SVf_UTF8)
3387 if (sflags & SVp_NOK) {
3389 if (sflags & SVf_NOK)
3390 SvFLAGS(dstr) |= SVf_NOK;
3391 SvNV_set(dstr, SvNVX(sstr));
3393 if (sflags & SVp_IOK) {
3394 (void)SvIOKp_on(dstr);
3395 if (sflags & SVf_IOK)
3396 SvFLAGS(dstr) |= SVf_IOK;
3397 if (sflags & SVf_IVisUV)
3399 SvIV_set(dstr, SvIVX(sstr));
3402 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3403 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3404 smg->mg_ptr, smg->mg_len);
3405 SvRMAGICAL_on(dstr);
3408 else if (sflags & SVp_IOK) {
3409 if (sflags & SVf_IOK)
3410 (void)SvIOK_only(dstr);
3412 (void)SvOK_off(dstr);
3413 (void)SvIOKp_on(dstr);
3415 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3416 if (sflags & SVf_IVisUV)
3418 SvIV_set(dstr, SvIVX(sstr));
3419 if (sflags & SVp_NOK) {
3420 if (sflags & SVf_NOK)
3421 (void)SvNOK_on(dstr);
3423 (void)SvNOKp_on(dstr);
3424 SvNV_set(dstr, SvNVX(sstr));
3427 else if (sflags & SVp_NOK) {
3428 if (sflags & SVf_NOK)
3429 (void)SvNOK_only(dstr);
3431 (void)SvOK_off(dstr);
3434 SvNV_set(dstr, SvNVX(sstr));
3437 if (dtype == SVt_PVGV) {
3438 if (ckWARN(WARN_MISC))
3439 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3442 (void)SvOK_off(dstr);
3444 if (SvTAINTED(sstr))
3449 =for apidoc sv_setsv_mg
3451 Like C<sv_setsv>, but also handles 'set' magic.
3457 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3459 sv_setsv(dstr,sstr);
3463 #ifdef PERL_OLD_COPY_ON_WRITE
3465 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3467 STRLEN cur = SvCUR(sstr);
3468 STRLEN len = SvLEN(sstr);
3469 register char *new_pv;
3472 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3480 if (SvTHINKFIRST(dstr))
3481 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3482 else if (SvPVX_const(dstr))
3483 Safefree(SvPVX_const(dstr));
3487 SvUPGRADE(dstr, SVt_PVIV);
3489 assert (SvPOK(sstr));
3490 assert (SvPOKp(sstr));
3491 assert (!SvIOK(sstr));
3492 assert (!SvIOKp(sstr));
3493 assert (!SvNOK(sstr));
3494 assert (!SvNOKp(sstr));
3496 if (SvIsCOW(sstr)) {
3498 if (SvLEN(sstr) == 0) {
3499 /* source is a COW shared hash key. */
3500 DEBUG_C(PerlIO_printf(Perl_debug_log,
3501 "Fast copy on write: Sharing hash\n"));
3502 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3505 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3507 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3508 SvUPGRADE(sstr, SVt_PVIV);
3509 SvREADONLY_on(sstr);
3511 DEBUG_C(PerlIO_printf(Perl_debug_log,
3512 "Fast copy on write: Converting sstr to COW\n"));
3513 SV_COW_NEXT_SV_SET(dstr, sstr);
3515 SV_COW_NEXT_SV_SET(sstr, dstr);
3516 new_pv = SvPVX_mutable(sstr);
3519 SvPV_set(dstr, new_pv);
3520 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3523 SvLEN_set(dstr, len);
3524 SvCUR_set(dstr, cur);
3533 =for apidoc sv_setpvn
3535 Copies a string into an SV. The C<len> parameter indicates the number of
3536 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3537 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3543 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3545 register char *dptr;
3547 SV_CHECK_THINKFIRST_COW_DROP(sv);
3553 /* len is STRLEN which is unsigned, need to copy to signed */
3556 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3558 SvUPGRADE(sv, SVt_PV);
3560 dptr = SvGROW(sv, len + 1);
3561 Move(ptr,dptr,len,char);
3564 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3569 =for apidoc sv_setpvn_mg
3571 Like C<sv_setpvn>, but also handles 'set' magic.
3577 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3579 sv_setpvn(sv,ptr,len);
3584 =for apidoc sv_setpv
3586 Copies a string into an SV. The string must be null-terminated. Does not
3587 handle 'set' magic. See C<sv_setpv_mg>.
3593 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3595 register STRLEN len;
3597 SV_CHECK_THINKFIRST_COW_DROP(sv);
3603 SvUPGRADE(sv, SVt_PV);
3605 SvGROW(sv, len + 1);
3606 Move(ptr,SvPVX(sv),len+1,char);
3608 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3613 =for apidoc sv_setpv_mg
3615 Like C<sv_setpv>, but also handles 'set' magic.
3621 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3628 =for apidoc sv_usepvn
3630 Tells an SV to use C<ptr> to find its string value. Normally the string is
3631 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3632 The C<ptr> should point to memory that was allocated by C<malloc>. The
3633 string length, C<len>, must be supplied. This function will realloc the
3634 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3635 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3636 See C<sv_usepvn_mg>.
3642 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3645 SV_CHECK_THINKFIRST_COW_DROP(sv);
3646 SvUPGRADE(sv, SVt_PV);
3651 if (SvPVX_const(sv))
3654 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3655 ptr = saferealloc (ptr, allocate);
3658 SvLEN_set(sv, allocate);
3660 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3665 =for apidoc sv_usepvn_mg
3667 Like C<sv_usepvn>, but also handles 'set' magic.
3673 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3675 sv_usepvn(sv,ptr,len);
3679 #ifdef PERL_OLD_COPY_ON_WRITE
3680 /* Need to do this *after* making the SV normal, as we need the buffer
3681 pointer to remain valid until after we've copied it. If we let go too early,
3682 another thread could invalidate it by unsharing last of the same hash key
3683 (which it can do by means other than releasing copy-on-write Svs)
3684 or by changing the other copy-on-write SVs in the loop. */
3686 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3688 if (len) { /* this SV was SvIsCOW_normal(sv) */
3689 /* we need to find the SV pointing to us. */
3690 SV * const current = SV_COW_NEXT_SV(after);
3692 if (current == sv) {
3693 /* The SV we point to points back to us (there were only two of us
3695 Hence other SV is no longer copy on write either. */
3697 SvREADONLY_off(after);
3699 /* We need to follow the pointers around the loop. */
3701 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3704 /* don't loop forever if the structure is bust, and we have
3705 a pointer into a closed loop. */
3706 assert (current != after);
3707 assert (SvPVX_const(current) == pvx);
3709 /* Make the SV before us point to the SV after us. */
3710 SV_COW_NEXT_SV_SET(current, after);
3713 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3718 Perl_sv_release_IVX(pTHX_ register SV *sv)
3721 sv_force_normal_flags(sv, 0);
3727 =for apidoc sv_force_normal_flags
3729 Undo various types of fakery on an SV: if the PV is a shared string, make
3730 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3731 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3732 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3733 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3734 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3735 set to some other value.) In addition, the C<flags> parameter gets passed to
3736 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3737 with flags set to 0.
3743 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3745 #ifdef PERL_OLD_COPY_ON_WRITE
3746 if (SvREADONLY(sv)) {
3747 /* At this point I believe I should acquire a global SV mutex. */
3749 const char * const pvx = SvPVX_const(sv);
3750 const STRLEN len = SvLEN(sv);
3751 const STRLEN cur = SvCUR(sv);
3752 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3754 PerlIO_printf(Perl_debug_log,
3755 "Copy on write: Force normal %ld\n",
3761 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3762 SvPV_set(sv, (char*)0);
3764 if (flags & SV_COW_DROP_PV) {
3765 /* OK, so we don't need to copy our buffer. */
3768 SvGROW(sv, cur + 1);
3769 Move(pvx,SvPVX(sv),cur,char);
3773 sv_release_COW(sv, pvx, len, next);
3778 else if (IN_PERL_RUNTIME)
3779 Perl_croak(aTHX_ PL_no_modify);
3780 /* At this point I believe that I can drop the global SV mutex. */
3783 if (SvREADONLY(sv)) {
3785 const char * const pvx = SvPVX_const(sv);
3786 const STRLEN len = SvCUR(sv);
3789 SvPV_set(sv, Nullch);
3791 SvGROW(sv, len + 1);
3792 Move(pvx,SvPVX(sv),len,char);
3794 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3796 else if (IN_PERL_RUNTIME)
3797 Perl_croak(aTHX_ PL_no_modify);
3801 sv_unref_flags(sv, flags);
3802 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3809 Efficient removal of characters from the beginning of the string buffer.
3810 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3811 the string buffer. The C<ptr> becomes the first character of the adjusted
3812 string. Uses the "OOK hack".
3813 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3814 refer to the same chunk of data.
3820 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3822 register STRLEN delta;
3823 if (!ptr || !SvPOKp(sv))
3825 delta = ptr - SvPVX_const(sv);
3826 SV_CHECK_THINKFIRST(sv);
3827 if (SvTYPE(sv) < SVt_PVIV)
3828 sv_upgrade(sv,SVt_PVIV);
3831 if (!SvLEN(sv)) { /* make copy of shared string */
3832 const char *pvx = SvPVX_const(sv);
3833 const STRLEN len = SvCUR(sv);
3834 SvGROW(sv, len + 1);
3835 Move(pvx,SvPVX(sv),len,char);
3839 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3840 and we do that anyway inside the SvNIOK_off
3842 SvFLAGS(sv) |= SVf_OOK;
3845 SvLEN_set(sv, SvLEN(sv) - delta);
3846 SvCUR_set(sv, SvCUR(sv) - delta);
3847 SvPV_set(sv, SvPVX(sv) + delta);
3848 SvIV_set(sv, SvIVX(sv) + delta);
3852 =for apidoc sv_catpvn
3854 Concatenates the string onto the end of the string which is in the SV. The
3855 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3856 status set, then the bytes appended should be valid UTF-8.
3857 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3859 =for apidoc sv_catpvn_flags
3861 Concatenates the string onto the end of the string which is in the SV. The
3862 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3863 status set, then the bytes appended should be valid UTF-8.
3864 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3865 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3866 in terms of this function.
3872 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3875 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3877 SvGROW(dsv, dlen + slen + 1);
3879 sstr = SvPVX_const(dsv);
3880 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3881 SvCUR_set(dsv, SvCUR(dsv) + slen);
3883 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3885 if (flags & SV_SMAGIC)
3890 =for apidoc sv_catsv
3892 Concatenates the string from SV C<ssv> onto the end of the string in
3893 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3894 not 'set' magic. See C<sv_catsv_mg>.
3896 =for apidoc sv_catsv_flags
3898 Concatenates the string from SV C<ssv> onto the end of the string in
3899 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3900 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3901 and C<sv_catsv_nomg> are implemented in terms of this function.
3906 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3911 if ((spv = SvPV_const(ssv, slen))) {
3912 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3913 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3914 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3915 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3916 dsv->sv_flags doesn't have that bit set.
3917 Andy Dougherty 12 Oct 2001
3919 const I32 sutf8 = DO_UTF8(ssv);
3922 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3924 dutf8 = DO_UTF8(dsv);
3926 if (dutf8 != sutf8) {
3928 /* Not modifying source SV, so taking a temporary copy. */
3929 SV* csv = sv_2mortal(newSVpvn(spv, slen));
3931 sv_utf8_upgrade(csv);
3932 spv = SvPV_const(csv, slen);
3935 sv_utf8_upgrade_nomg(dsv);
3937 sv_catpvn_nomg(dsv, spv, slen);
3940 if (flags & SV_SMAGIC)
3945 =for apidoc sv_catpv
3947 Concatenates the string onto the end of the string which is in the SV.
3948 If the SV has the UTF-8 status set, then the bytes appended should be
3949 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3954 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3956 register STRLEN len;
3962 junk = SvPV_force(sv, tlen);
3964 SvGROW(sv, tlen + len + 1);
3966 ptr = SvPVX_const(sv);
3967 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3968 SvCUR_set(sv, SvCUR(sv) + len);
3969 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3974 =for apidoc sv_catpv_mg
3976 Like C<sv_catpv>, but also handles 'set' magic.
3982 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3991 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3992 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3999 Perl_newSV(pTHX_ STRLEN len)
4005 sv_upgrade(sv, SVt_PV);
4006 SvGROW(sv, len + 1);
4011 =for apidoc sv_magicext
4013 Adds magic to an SV, upgrading it if necessary. Applies the
4014 supplied vtable and returns a pointer to the magic added.
4016 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4017 In particular, you can add magic to SvREADONLY SVs, and add more than
4018 one instance of the same 'how'.
4020 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4021 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4022 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4023 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4025 (This is now used as a subroutine by C<sv_magic>.)
4030 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4031 const char* name, I32 namlen)
4035 if (SvTYPE(sv) < SVt_PVMG) {
4036 SvUPGRADE(sv, SVt_PVMG);
4038 Newxz(mg, 1, MAGIC);
4039 mg->mg_moremagic = SvMAGIC(sv);
4040 SvMAGIC_set(sv, mg);
4042 /* Sometimes a magic contains a reference loop, where the sv and
4043 object refer to each other. To prevent a reference loop that
4044 would prevent such objects being freed, we look for such loops
4045 and if we find one we avoid incrementing the object refcount.
4047 Note we cannot do this to avoid self-tie loops as intervening RV must
4048 have its REFCNT incremented to keep it in existence.
4051 if (!obj || obj == sv ||
4052 how == PERL_MAGIC_arylen ||
4053 how == PERL_MAGIC_qr ||
4054 how == PERL_MAGIC_symtab ||
4055 (SvTYPE(obj) == SVt_PVGV &&
4056 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4057 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4058 GvFORM(obj) == (CV*)sv)))
4063 mg->mg_obj = SvREFCNT_inc(obj);
4064 mg->mg_flags |= MGf_REFCOUNTED;
4067 /* Normal self-ties simply pass a null object, and instead of
4068 using mg_obj directly, use the SvTIED_obj macro to produce a
4069 new RV as needed. For glob "self-ties", we are tieing the PVIO
4070 with an RV obj pointing to the glob containing the PVIO. In
4071 this case, to avoid a reference loop, we need to weaken the
4075 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4076 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4082 mg->mg_len = namlen;
4085 mg->mg_ptr = savepvn(name, namlen);
4086 else if (namlen == HEf_SVKEY)
4087 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4089 mg->mg_ptr = (char *) name;
4091 mg->mg_virtual = vtable;
4095 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4100 =for apidoc sv_magic
4102 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4103 then adds a new magic item of type C<how> to the head of the magic list.
4105 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4106 handling of the C<name> and C<namlen> arguments.
4108 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4109 to add more than one instance of the same 'how'.
4115 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4117 const MGVTBL *vtable;
4120 #ifdef PERL_OLD_COPY_ON_WRITE
4122 sv_force_normal_flags(sv, 0);
4124 if (SvREADONLY(sv)) {
4126 /* its okay to attach magic to shared strings; the subsequent
4127 * upgrade to PVMG will unshare the string */
4128 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4131 && how != PERL_MAGIC_regex_global
4132 && how != PERL_MAGIC_bm
4133 && how != PERL_MAGIC_fm
4134 && how != PERL_MAGIC_sv
4135 && how != PERL_MAGIC_backref
4138 Perl_croak(aTHX_ PL_no_modify);
4141 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4142 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4143 /* sv_magic() refuses to add a magic of the same 'how' as an
4146 if (how == PERL_MAGIC_taint)
4154 vtable = &PL_vtbl_sv;
4156 case PERL_MAGIC_overload:
4157 vtable = &PL_vtbl_amagic;
4159 case PERL_MAGIC_overload_elem:
4160 vtable = &PL_vtbl_amagicelem;
4162 case PERL_MAGIC_overload_table:
4163 vtable = &PL_vtbl_ovrld;
4166 vtable = &PL_vtbl_bm;
4168 case PERL_MAGIC_regdata:
4169 vtable = &PL_vtbl_regdata;
4171 case PERL_MAGIC_regdatum:
4172 vtable = &PL_vtbl_regdatum;
4174 case PERL_MAGIC_env:
4175 vtable = &PL_vtbl_env;
4178 vtable = &PL_vtbl_fm;
4180 case PERL_MAGIC_envelem:
4181 vtable = &PL_vtbl_envelem;
4183 case PERL_MAGIC_regex_global:
4184 vtable = &PL_vtbl_mglob;
4186 case PERL_MAGIC_isa:
4187 vtable = &PL_vtbl_isa;
4189 case PERL_MAGIC_isaelem:
4190 vtable = &PL_vtbl_isaelem;
4192 case PERL_MAGIC_nkeys:
4193 vtable = &PL_vtbl_nkeys;
4195 case PERL_MAGIC_dbfile:
4198 case PERL_MAGIC_dbline:
4199 vtable = &PL_vtbl_dbline;
4201 #ifdef USE_LOCALE_COLLATE
4202 case PERL_MAGIC_collxfrm:
4203 vtable = &PL_vtbl_collxfrm;
4205 #endif /* USE_LOCALE_COLLATE */
4206 case PERL_MAGIC_tied:
4207 vtable = &PL_vtbl_pack;
4209 case PERL_MAGIC_tiedelem:
4210 case PERL_MAGIC_tiedscalar:
4211 vtable = &PL_vtbl_packelem;
4214 vtable = &PL_vtbl_regexp;
4216 case PERL_MAGIC_sig:
4217 vtable = &PL_vtbl_sig;
4219 case PERL_MAGIC_sigelem:
4220 vtable = &PL_vtbl_sigelem;
4222 case PERL_MAGIC_taint:
4223 vtable = &PL_vtbl_taint;
4225 case PERL_MAGIC_uvar:
4226 vtable = &PL_vtbl_uvar;
4228 case PERL_MAGIC_vec:
4229 vtable = &PL_vtbl_vec;
4231 case PERL_MAGIC_arylen_p:
4232 case PERL_MAGIC_rhash:
4233 case PERL_MAGIC_symtab:
4234 case PERL_MAGIC_vstring:
4237 case PERL_MAGIC_utf8:
4238 vtable = &PL_vtbl_utf8;
4240 case PERL_MAGIC_substr:
4241 vtable = &PL_vtbl_substr;
4243 case PERL_MAGIC_defelem:
4244 vtable = &PL_vtbl_defelem;
4246 case PERL_MAGIC_glob:
4247 vtable = &PL_vtbl_glob;
4249 case PERL_MAGIC_arylen:
4250 vtable = &PL_vtbl_arylen;
4252 case PERL_MAGIC_pos:
4253 vtable = &PL_vtbl_pos;
4255 case PERL_MAGIC_backref:
4256 vtable = &PL_vtbl_backref;
4258 case PERL_MAGIC_ext:
4259 /* Reserved for use by extensions not perl internals. */
4260 /* Useful for attaching extension internal data to perl vars. */
4261 /* Note that multiple extensions may clash if magical scalars */
4262 /* etc holding private data from one are passed to another. */
4266 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4269 /* Rest of work is done else where */
4270 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4273 case PERL_MAGIC_taint:
4276 case PERL_MAGIC_ext:
4277 case PERL_MAGIC_dbfile:
4284 =for apidoc sv_unmagic
4286 Removes all magic of type C<type> from an SV.
4292 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4296 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4299 for (mg = *mgp; mg; mg = *mgp) {
4300 if (mg->mg_type == type) {
4301 const MGVTBL* const vtbl = mg->mg_virtual;
4302 *mgp = mg->mg_moremagic;
4303 if (vtbl && vtbl->svt_free)
4304 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4305 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4307 Safefree(mg->mg_ptr);
4308 else if (mg->mg_len == HEf_SVKEY)
4309 SvREFCNT_dec((SV*)mg->mg_ptr);
4310 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4311 Safefree(mg->mg_ptr);
4313 if (mg->mg_flags & MGf_REFCOUNTED)
4314 SvREFCNT_dec(mg->mg_obj);
4318 mgp = &mg->mg_moremagic;
4322 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4329 =for apidoc sv_rvweaken
4331 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4332 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4333 push a back-reference to this RV onto the array of backreferences
4334 associated with that magic.
4340 Perl_sv_rvweaken(pTHX_ SV *sv)
4343 if (!SvOK(sv)) /* let undefs pass */
4346 Perl_croak(aTHX_ "Can't weaken a nonreference");
4347 else if (SvWEAKREF(sv)) {
4348 if (ckWARN(WARN_MISC))
4349 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4353 Perl_sv_add_backref(aTHX_ tsv, sv);
4359 /* Give tsv backref magic if it hasn't already got it, then push a
4360 * back-reference to sv onto the array associated with the backref magic.
4364 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4368 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4369 av = (AV*)mg->mg_obj;
4372 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4373 /* av now has a refcnt of 2, which avoids it getting freed
4374 * before us during global cleanup. The extra ref is removed
4375 * by magic_killbackrefs() when tsv is being freed */
4377 if (AvFILLp(av) >= AvMAX(av)) {
4378 av_extend(av, AvFILLp(av)+1);
4380 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4383 /* delete a back-reference to ourselves from the backref magic associated
4384 * with the SV we point to.
4388 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4394 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4395 if (PL_in_clean_all)
4398 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4399 Perl_croak(aTHX_ "panic: del_backref");
4400 av = (AV *)mg->mg_obj;
4402 /* We shouldn't be in here more than once, but for paranoia reasons lets
4404 for (i = AvFILLp(av); i >= 0; i--) {
4406 const SSize_t fill = AvFILLp(av);
4408 /* We weren't the last entry.
4409 An unordered list has this property that you can take the
4410 last element off the end to fill the hole, and it's still
4411 an unordered list :-)
4416 AvFILLp(av) = fill - 1;
4422 =for apidoc sv_insert
4424 Inserts a string at the specified offset/length within the SV. Similar to
4425 the Perl substr() function.
4431 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4435 register char *midend;
4436 register char *bigend;
4442 Perl_croak(aTHX_ "Can't modify non-existent substring");
4443 SvPV_force(bigstr, curlen);
4444 (void)SvPOK_only_UTF8(bigstr);
4445 if (offset + len > curlen) {
4446 SvGROW(bigstr, offset+len+1);
4447 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4448 SvCUR_set(bigstr, offset+len);
4452 i = littlelen - len;
4453 if (i > 0) { /* string might grow */
4454 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4455 mid = big + offset + len;
4456 midend = bigend = big + SvCUR(bigstr);
4459 while (midend > mid) /* shove everything down */
4460 *--bigend = *--midend;
4461 Move(little,big+offset,littlelen,char);
4462 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4467 Move(little,SvPVX(bigstr)+offset,len,char);
4472 big = SvPVX(bigstr);
4475 bigend = big + SvCUR(bigstr);
4477 if (midend > bigend)
4478 Perl_croak(aTHX_ "panic: sv_insert");
4480 if (mid - big > bigend - midend) { /* faster to shorten from end */
4482 Move(little, mid, littlelen,char);
4485 i = bigend - midend;
4487 Move(midend, mid, i,char);
4491 SvCUR_set(bigstr, mid - big);
4493 else if ((i = mid - big)) { /* faster from front */
4494 midend -= littlelen;
4496 sv_chop(bigstr,midend-i);
4501 Move(little, mid, littlelen,char);
4503 else if (littlelen) {
4504 midend -= littlelen;
4505 sv_chop(bigstr,midend);
4506 Move(little,midend,littlelen,char);
4509 sv_chop(bigstr,midend);
4515 =for apidoc sv_replace
4517 Make the first argument a copy of the second, then delete the original.
4518 The target SV physically takes over ownership of the body of the source SV
4519 and inherits its flags; however, the target keeps any magic it owns,
4520 and any magic in the source is discarded.
4521 Note that this is a rather specialist SV copying operation; most of the
4522 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4528 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4530 const U32 refcnt = SvREFCNT(sv);
4531 SV_CHECK_THINKFIRST_COW_DROP(sv);
4532 if (SvREFCNT(nsv) != 1) {
4533 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4534 UVuf " != 1)", (UV) SvREFCNT(nsv));
4536 if (SvMAGICAL(sv)) {
4540 sv_upgrade(nsv, SVt_PVMG);
4541 SvMAGIC_set(nsv, SvMAGIC(sv));
4542 SvFLAGS(nsv) |= SvMAGICAL(sv);
4544 SvMAGIC_set(sv, NULL);
4548 assert(!SvREFCNT(sv));
4549 #ifdef DEBUG_LEAKING_SCALARS
4550 sv->sv_flags = nsv->sv_flags;
4551 sv->sv_any = nsv->sv_any;
4552 sv->sv_refcnt = nsv->sv_refcnt;
4553 sv->sv_u = nsv->sv_u;
4555 StructCopy(nsv,sv,SV);
4557 /* Currently could join these into one piece of pointer arithmetic, but
4558 it would be unclear. */
4559 if(SvTYPE(sv) == SVt_IV)
4561 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4562 else if (SvTYPE(sv) == SVt_RV) {
4563 SvANY(sv) = &sv->sv_u.svu_rv;
4567 #ifdef PERL_OLD_COPY_ON_WRITE
4568 if (SvIsCOW_normal(nsv)) {
4569 /* We need to follow the pointers around the loop to make the
4570 previous SV point to sv, rather than nsv. */
4573 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4576 assert(SvPVX_const(current) == SvPVX_const(nsv));
4578 /* Make the SV before us point to the SV after us. */
4580 PerlIO_printf(Perl_debug_log, "previous is\n");
4582 PerlIO_printf(Perl_debug_log,
4583 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4584 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4586 SV_COW_NEXT_SV_SET(current, sv);
4589 SvREFCNT(sv) = refcnt;
4590 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4596 =for apidoc sv_clear
4598 Clear an SV: call any destructors, free up any memory used by the body,
4599 and free the body itself. The SV's head is I<not> freed, although
4600 its type is set to all 1's so that it won't inadvertently be assumed
4601 to be live during global destruction etc.
4602 This function should only be called when REFCNT is zero. Most of the time
4603 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4610 Perl_sv_clear(pTHX_ register SV *sv)
4613 const U32 type = SvTYPE(sv);
4614 const struct body_details *const sv_type_details
4615 = bodies_by_type + type;
4618 assert(SvREFCNT(sv) == 0);
4624 if (PL_defstash) { /* Still have a symbol table? */
4629 stash = SvSTASH(sv);
4630 destructor = StashHANDLER(stash,DESTROY);
4632 SV* const tmpref = newRV(sv);
4633 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4635 PUSHSTACKi(PERLSI_DESTROY);
4640 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4646 if(SvREFCNT(tmpref) < 2) {
4647 /* tmpref is not kept alive! */
4649 SvRV_set(tmpref, NULL);
4652 SvREFCNT_dec(tmpref);
4654 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4658 if (PL_in_clean_objs)
4659 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4661 /* DESTROY gave object new lease on life */
4667 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4668 SvOBJECT_off(sv); /* Curse the object. */
4669 if (type != SVt_PVIO)
4670 --PL_sv_objcount; /* XXX Might want something more general */
4673 if (type >= SVt_PVMG) {
4676 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4677 SvREFCNT_dec(SvSTASH(sv));
4682 IoIFP(sv) != PerlIO_stdin() &&
4683 IoIFP(sv) != PerlIO_stdout() &&
4684 IoIFP(sv) != PerlIO_stderr())
4686 io_close((IO*)sv, FALSE);
4688 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4689 PerlDir_close(IoDIRP(sv));
4690 IoDIRP(sv) = (DIR*)NULL;
4691 Safefree(IoTOP_NAME(sv));
4692 Safefree(IoFMT_NAME(sv));
4693 Safefree(IoBOTTOM_NAME(sv));
4708 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4709 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4710 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4711 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4713 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4714 SvREFCNT_dec(LvTARG(sv));
4718 Safefree(GvNAME(sv));
4719 /* If we're in a stash, we don't own a reference to it. However it does
4720 have a back reference to us, which needs to be cleared. */
4722 sv_del_backref((SV*)GvSTASH(sv), sv);
4727 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4729 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4730 /* Don't even bother with turning off the OOK flag. */
4735 SV *target = SvRV(sv);
4737 sv_del_backref(target, sv);
4739 SvREFCNT_dec(target);
4741 #ifdef PERL_OLD_COPY_ON_WRITE
4742 else if (SvPVX_const(sv)) {
4744 /* I believe I need to grab the global SV mutex here and
4745 then recheck the COW status. */
4747 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4750 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4751 SV_COW_NEXT_SV(sv));
4752 /* And drop it here. */
4754 } else if (SvLEN(sv)) {
4755 Safefree(SvPVX_const(sv));
4759 else if (SvPVX_const(sv) && SvLEN(sv))
4760 Safefree(SvPVX_mutable(sv));
4761 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4762 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4771 SvFLAGS(sv) &= SVf_BREAK;
4772 SvFLAGS(sv) |= SVTYPEMASK;
4774 if (sv_type_details->arena) {
4775 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4776 &PL_body_roots[type]);
4778 else if (sv_type_details->size) {
4779 my_safefree(SvANY(sv));
4784 =for apidoc sv_newref
4786 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4793 Perl_sv_newref(pTHX_ SV *sv)
4803 Decrement an SV's reference count, and if it drops to zero, call
4804 C<sv_clear> to invoke destructors and free up any memory used by
4805 the body; finally, deallocate the SV's head itself.
4806 Normally called via a wrapper macro C<SvREFCNT_dec>.
4812 Perl_sv_free(pTHX_ SV *sv)
4817 if (SvREFCNT(sv) == 0) {
4818 if (SvFLAGS(sv) & SVf_BREAK)
4819 /* this SV's refcnt has been artificially decremented to
4820 * trigger cleanup */
4822 if (PL_in_clean_all) /* All is fair */
4824 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4825 /* make sure SvREFCNT(sv)==0 happens very seldom */
4826 SvREFCNT(sv) = (~(U32)0)/2;
4829 if (ckWARN_d(WARN_INTERNAL)) {
4830 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4831 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4832 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4833 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4834 Perl_dump_sv_child(aTHX_ sv);
4839 if (--(SvREFCNT(sv)) > 0)
4841 Perl_sv_free2(aTHX_ sv);
4845 Perl_sv_free2(pTHX_ SV *sv)
4850 if (ckWARN_d(WARN_DEBUGGING))
4851 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4852 "Attempt to free temp prematurely: SV 0x%"UVxf
4853 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4857 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4858 /* make sure SvREFCNT(sv)==0 happens very seldom */
4859 SvREFCNT(sv) = (~(U32)0)/2;
4870 Returns the length of the string in the SV. Handles magic and type
4871 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4877 Perl_sv_len(pTHX_ register SV *sv)
4885 len = mg_length(sv);
4887 (void)SvPV_const(sv, len);
4892 =for apidoc sv_len_utf8
4894 Returns the number of characters in the string in an SV, counting wide
4895 UTF-8 bytes as a single character. Handles magic and type coercion.
4901 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4902 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4903 * (Note that the mg_len is not the length of the mg_ptr field.)
4908 Perl_sv_len_utf8(pTHX_ register SV *sv)
4914 return mg_length(sv);
4918 const U8 *s = (U8*)SvPV_const(sv, len);
4919 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4921 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4923 #ifdef PERL_UTF8_CACHE_ASSERT
4924 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4928 ulen = Perl_utf8_length(aTHX_ s, s + len);
4929 if (!mg && !SvREADONLY(sv)) {
4930 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4931 mg = mg_find(sv, PERL_MAGIC_utf8);
4941 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4942 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4943 * between UTF-8 and byte offsets. There are two (substr offset and substr
4944 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4945 * and byte offset) cache positions.
4947 * The mg_len field is used by sv_len_utf8(), see its comments.
4948 * Note that the mg_len is not the length of the mg_ptr field.
4952 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4953 I32 offsetp, const U8 *s, const U8 *start)
4957 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4959 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4963 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4965 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4966 (*mgp)->mg_ptr = (char *) *cachep;
4970 (*cachep)[i] = offsetp;
4971 (*cachep)[i+1] = s - start;
4979 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4980 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4981 * between UTF-8 and byte offsets. See also the comments of
4982 * S_utf8_mg_pos_init().
4986 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)
4990 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4992 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4993 if (*mgp && (*mgp)->mg_ptr) {
4994 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4995 ASSERT_UTF8_CACHE(*cachep);
4996 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4998 else { /* We will skip to the right spot. */
5003 /* The assumption is that going backward is half
5004 * the speed of going forward (that's where the
5005 * 2 * backw in the below comes from). (The real
5006 * figure of course depends on the UTF-8 data.) */
5008 if ((*cachep)[i] > (STRLEN)uoff) {
5010 backw = (*cachep)[i] - (STRLEN)uoff;
5012 if (forw < 2 * backw)
5015 p = start + (*cachep)[i+1];
5017 /* Try this only for the substr offset (i == 0),
5018 * not for the substr length (i == 2). */
5019 else if (i == 0) { /* (*cachep)[i] < uoff */
5020 const STRLEN ulen = sv_len_utf8(sv);
5022 if ((STRLEN)uoff < ulen) {
5023 forw = (STRLEN)uoff - (*cachep)[i];
5024 backw = ulen - (STRLEN)uoff;
5026 if (forw < 2 * backw)
5027 p = start + (*cachep)[i+1];
5032 /* If the string is not long enough for uoff,
5033 * we could extend it, but not at this low a level. */
5037 if (forw < 2 * backw) {
5044 while (UTF8_IS_CONTINUATION(*p))
5049 /* Update the cache. */
5050 (*cachep)[i] = (STRLEN)uoff;
5051 (*cachep)[i+1] = p - start;
5053 /* Drop the stale "length" cache */
5062 if (found) { /* Setup the return values. */
5063 *offsetp = (*cachep)[i+1];
5064 *sp = start + *offsetp;
5067 *offsetp = send - start;
5069 else if (*sp < start) {
5075 #ifdef PERL_UTF8_CACHE_ASSERT
5080 while (n-- && s < send)
5084 assert(*offsetp == s - start);
5085 assert((*cachep)[0] == (STRLEN)uoff);
5086 assert((*cachep)[1] == *offsetp);
5088 ASSERT_UTF8_CACHE(*cachep);
5097 =for apidoc sv_pos_u2b
5099 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5100 the start of the string, to a count of the equivalent number of bytes; if
5101 lenp is non-zero, it does the same to lenp, but this time starting from
5102 the offset, rather than from the start of the string. Handles magic and
5109 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5110 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5111 * byte offsets. See also the comments of S_utf8_mg_pos().
5116 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5124 start = (U8*)SvPV_const(sv, len);
5128 const U8 *s = start;
5129 I32 uoffset = *offsetp;
5130 const U8 * const send = s + len;
5134 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5136 if (!found && uoffset > 0) {
5137 while (s < send && uoffset--)
5141 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5143 *offsetp = s - start;
5148 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5152 if (!found && *lenp > 0) {
5155 while (s < send && ulen--)
5159 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5163 ASSERT_UTF8_CACHE(cache);
5175 =for apidoc sv_pos_b2u
5177 Converts the value pointed to by offsetp from a count of bytes from the
5178 start of the string, to a count of the equivalent number of UTF-8 chars.
5179 Handles magic and type coercion.
5185 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5186 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5187 * byte offsets. See also the comments of S_utf8_mg_pos().
5192 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5200 s = (const U8*)SvPV_const(sv, len);
5201 if ((I32)len < *offsetp)
5202 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5204 const U8* send = s + *offsetp;
5206 STRLEN *cache = NULL;
5210 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5211 mg = mg_find(sv, PERL_MAGIC_utf8);
5212 if (mg && mg->mg_ptr) {
5213 cache = (STRLEN *) mg->mg_ptr;
5214 if (cache[1] == (STRLEN)*offsetp) {
5215 /* An exact match. */
5216 *offsetp = cache[0];
5220 else if (cache[1] < (STRLEN)*offsetp) {
5221 /* We already know part of the way. */
5224 /* Let the below loop do the rest. */
5226 else { /* cache[1] > *offsetp */
5227 /* We already know all of the way, now we may
5228 * be able to walk back. The same assumption
5229 * is made as in S_utf8_mg_pos(), namely that
5230 * walking backward is twice slower than
5231 * walking forward. */
5232 const STRLEN forw = *offsetp;
5233 STRLEN backw = cache[1] - *offsetp;
5235 if (!(forw < 2 * backw)) {
5236 const U8 *p = s + cache[1];
5243 while (UTF8_IS_CONTINUATION(*p)) {
5251 *offsetp = cache[0];
5253 /* Drop the stale "length" cache */
5261 ASSERT_UTF8_CACHE(cache);
5267 /* Call utf8n_to_uvchr() to validate the sequence
5268 * (unless a simple non-UTF character) */
5269 if (!UTF8_IS_INVARIANT(*s))
5270 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5279 if (!SvREADONLY(sv)) {
5281 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5282 mg = mg_find(sv, PERL_MAGIC_utf8);
5287 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5288 mg->mg_ptr = (char *) cache;
5293 cache[1] = *offsetp;
5294 /* Drop the stale "length" cache */
5307 Returns a boolean indicating whether the strings in the two SVs are
5308 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5309 coerce its args to strings if necessary.
5315 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5323 SV* svrecode = Nullsv;
5330 pv1 = SvPV_const(sv1, cur1);
5337 pv2 = SvPV_const(sv2, cur2);
5339 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5340 /* Differing utf8ness.
5341 * Do not UTF8size the comparands as a side-effect. */
5344 svrecode = newSVpvn(pv2, cur2);
5345 sv_recode_to_utf8(svrecode, PL_encoding);
5346 pv2 = SvPV_const(svrecode, cur2);
5349 svrecode = newSVpvn(pv1, cur1);
5350 sv_recode_to_utf8(svrecode, PL_encoding);
5351 pv1 = SvPV_const(svrecode, cur1);
5353 /* Now both are in UTF-8. */
5355 SvREFCNT_dec(svrecode);
5360 bool is_utf8 = TRUE;
5363 /* sv1 is the UTF-8 one,
5364 * if is equal it must be downgrade-able */
5365 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5371 /* sv2 is the UTF-8 one,
5372 * if is equal it must be downgrade-able */
5373 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5379 /* Downgrade not possible - cannot be eq */
5387 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5390 SvREFCNT_dec(svrecode);
5401 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5402 string in C<sv1> is less than, equal to, or greater than the string in
5403 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5404 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5410 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5413 const char *pv1, *pv2;
5416 SV *svrecode = Nullsv;
5423 pv1 = SvPV_const(sv1, cur1);
5430 pv2 = SvPV_const(sv2, cur2);
5432 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5433 /* Differing utf8ness.
5434 * Do not UTF8size the comparands as a side-effect. */
5437 svrecode = newSVpvn(pv2, cur2);
5438 sv_recode_to_utf8(svrecode, PL_encoding);
5439 pv2 = SvPV_const(svrecode, cur2);
5442 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5447 svrecode = newSVpvn(pv1, cur1);
5448 sv_recode_to_utf8(svrecode, PL_encoding);
5449 pv1 = SvPV_const(svrecode, cur1);
5452 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5458 cmp = cur2 ? -1 : 0;
5462 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5465 cmp = retval < 0 ? -1 : 1;
5466 } else if (cur1 == cur2) {
5469 cmp = cur1 < cur2 ? -1 : 1;
5474 SvREFCNT_dec(svrecode);
5483 =for apidoc sv_cmp_locale
5485 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5486 'use bytes' aware, handles get magic, and will coerce its args to strings
5487 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5493 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5495 #ifdef USE_LOCALE_COLLATE
5501 if (PL_collation_standard)
5505 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5507 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5509 if (!pv1 || !len1) {
5520 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5523 return retval < 0 ? -1 : 1;
5526 * When the result of collation is equality, that doesn't mean
5527 * that there are no differences -- some locales exclude some
5528 * characters from consideration. So to avoid false equalities,
5529 * we use the raw string as a tiebreaker.
5535 #endif /* USE_LOCALE_COLLATE */
5537 return sv_cmp(sv1, sv2);
5541 #ifdef USE_LOCALE_COLLATE
5544 =for apidoc sv_collxfrm
5546 Add Collate Transform magic to an SV if it doesn't already have it.
5548 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5549 scalar data of the variable, but transformed to such a format that a normal
5550 memory comparison can be used to compare the data according to the locale
5557 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5561 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5562 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5568 Safefree(mg->mg_ptr);
5569 s = SvPV_const(sv, len);
5570 if ((xf = mem_collxfrm(s, len, &xlen))) {
5571 if (SvREADONLY(sv)) {
5574 return xf + sizeof(PL_collation_ix);
5577 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5578 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5591 if (mg && mg->mg_ptr) {
5593 return mg->mg_ptr + sizeof(PL_collation_ix);
5601 #endif /* USE_LOCALE_COLLATE */
5606 Get a line from the filehandle and store it into the SV, optionally
5607 appending to the currently-stored string.
5613 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5617 register STDCHAR rslast;
5618 register STDCHAR *bp;
5624 if (SvTHINKFIRST(sv))
5625 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5626 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5628 However, perlbench says it's slower, because the existing swipe code
5629 is faster than copy on write.
5630 Swings and roundabouts. */
5631 SvUPGRADE(sv, SVt_PV);
5636 if (PerlIO_isutf8(fp)) {
5638 sv_utf8_upgrade_nomg(sv);
5639 sv_pos_u2b(sv,&append,0);
5641 } else if (SvUTF8(sv)) {
5642 SV * const tsv = NEWSV(0,0);
5643 sv_gets(tsv, fp, 0);
5644 sv_utf8_upgrade_nomg(tsv);
5645 SvCUR_set(sv,append);
5648 goto return_string_or_null;
5653 if (PerlIO_isutf8(fp))
5656 if (IN_PERL_COMPILETIME) {
5657 /* we always read code in line mode */
5661 else if (RsSNARF(PL_rs)) {
5662 /* If it is a regular disk file use size from stat() as estimate
5663 of amount we are going to read - may result in malloc-ing
5664 more memory than we realy need if layers bellow reduce
5665 size we read (e.g. CRLF or a gzip layer)
5668 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5669 const Off_t offset = PerlIO_tell(fp);
5670 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5671 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5677 else if (RsRECORD(PL_rs)) {
5681 /* Grab the size of the record we're getting */
5682 recsize = SvIV(SvRV(PL_rs));
5683 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5686 /* VMS wants read instead of fread, because fread doesn't respect */
5687 /* RMS record boundaries. This is not necessarily a good thing to be */
5688 /* doing, but we've got no other real choice - except avoid stdio
5689 as implementation - perhaps write a :vms layer ?
5691 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5693 bytesread = PerlIO_read(fp, buffer, recsize);
5697 SvCUR_set(sv, bytesread += append);
5698 buffer[bytesread] = '\0';
5699 goto return_string_or_null;
5701 else if (RsPARA(PL_rs)) {
5707 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5708 if (PerlIO_isutf8(fp)) {
5709 rsptr = SvPVutf8(PL_rs, rslen);
5712 if (SvUTF8(PL_rs)) {
5713 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5714 Perl_croak(aTHX_ "Wide character in $/");
5717 rsptr = SvPV_const(PL_rs, rslen);
5721 rslast = rslen ? rsptr[rslen - 1] : '\0';
5723 if (rspara) { /* have to do this both before and after */
5724 do { /* to make sure file boundaries work right */
5727 i = PerlIO_getc(fp);
5731 PerlIO_ungetc(fp,i);
5737 /* See if we know enough about I/O mechanism to cheat it ! */
5739 /* This used to be #ifdef test - it is made run-time test for ease
5740 of abstracting out stdio interface. One call should be cheap
5741 enough here - and may even be a macro allowing compile
5745 if (PerlIO_fast_gets(fp)) {
5748 * We're going to steal some values from the stdio struct
5749 * and put EVERYTHING in the innermost loop into registers.
5751 register STDCHAR *ptr;
5755 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5756 /* An ungetc()d char is handled separately from the regular
5757 * buffer, so we getc() it back out and stuff it in the buffer.
5759 i = PerlIO_getc(fp);
5760 if (i == EOF) return 0;
5761 *(--((*fp)->_ptr)) = (unsigned char) i;
5765 /* Here is some breathtakingly efficient cheating */
5767 cnt = PerlIO_get_cnt(fp); /* get count into register */
5768 /* make sure we have the room */
5769 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5770 /* Not room for all of it
5771 if we are looking for a separator and room for some
5773 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5774 /* just process what we have room for */
5775 shortbuffered = cnt - SvLEN(sv) + append + 1;
5776 cnt -= shortbuffered;
5780 /* remember that cnt can be negative */
5781 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5786 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5787 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5788 DEBUG_P(PerlIO_printf(Perl_debug_log,
5789 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5790 DEBUG_P(PerlIO_printf(Perl_debug_log,
5791 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5792 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5793 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5798 while (cnt > 0) { /* this | eat */
5800 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5801 goto thats_all_folks; /* screams | sed :-) */
5805 Copy(ptr, bp, cnt, char); /* this | eat */
5806 bp += cnt; /* screams | dust */
5807 ptr += cnt; /* louder | sed :-) */
5812 if (shortbuffered) { /* oh well, must extend */
5813 cnt = shortbuffered;
5815 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5817 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5818 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5822 DEBUG_P(PerlIO_printf(Perl_debug_log,
5823 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5824 PTR2UV(ptr),(long)cnt));
5825 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5827 DEBUG_P(PerlIO_printf(Perl_debug_log,
5828 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5829 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5830 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5832 /* This used to call 'filbuf' in stdio form, but as that behaves like
5833 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5834 another abstraction. */
5835 i = PerlIO_getc(fp); /* get more characters */
5837 DEBUG_P(PerlIO_printf(Perl_debug_log,
5838 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5839 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5840 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5842 cnt = PerlIO_get_cnt(fp);
5843 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5844 DEBUG_P(PerlIO_printf(Perl_debug_log,
5845 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5847 if (i == EOF) /* all done for ever? */
5848 goto thats_really_all_folks;
5850 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5852 SvGROW(sv, bpx + cnt + 2);
5853 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5855 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5857 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5858 goto thats_all_folks;
5862 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5863 memNE((char*)bp - rslen, rsptr, rslen))
5864 goto screamer; /* go back to the fray */
5865 thats_really_all_folks:
5867 cnt += shortbuffered;
5868 DEBUG_P(PerlIO_printf(Perl_debug_log,
5869 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5870 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5871 DEBUG_P(PerlIO_printf(Perl_debug_log,
5872 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5873 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5874 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5876 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5877 DEBUG_P(PerlIO_printf(Perl_debug_log,
5878 "Screamer: done, len=%ld, string=|%.*s|\n",
5879 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5883 /*The big, slow, and stupid way. */
5884 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5886 Newx(buf, 8192, STDCHAR);
5894 register const STDCHAR *bpe = buf + sizeof(buf);
5896 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5897 ; /* keep reading */
5901 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5902 /* Accomodate broken VAXC compiler, which applies U8 cast to
5903 * both args of ?: operator, causing EOF to change into 255
5906 i = (U8)buf[cnt - 1];
5912 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5914 sv_catpvn(sv, (char *) buf, cnt);
5916 sv_setpvn(sv, (char *) buf, cnt);
5918 if (i != EOF && /* joy */
5920 SvCUR(sv) < rslen ||
5921 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5925 * If we're reading from a TTY and we get a short read,
5926 * indicating that the user hit his EOF character, we need
5927 * to notice it now, because if we try to read from the TTY
5928 * again, the EOF condition will disappear.
5930 * The comparison of cnt to sizeof(buf) is an optimization
5931 * that prevents unnecessary calls to feof().
5935 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5939 #ifdef USE_HEAP_INSTEAD_OF_STACK
5944 if (rspara) { /* have to do this both before and after */
5945 while (i != EOF) { /* to make sure file boundaries work right */
5946 i = PerlIO_getc(fp);
5948 PerlIO_ungetc(fp,i);
5954 return_string_or_null:
5955 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5961 Auto-increment of the value in the SV, doing string to numeric conversion
5962 if necessary. Handles 'get' magic.
5968 Perl_sv_inc(pTHX_ register SV *sv)
5976 if (SvTHINKFIRST(sv)) {
5978 sv_force_normal_flags(sv, 0);
5979 if (SvREADONLY(sv)) {
5980 if (IN_PERL_RUNTIME)
5981 Perl_croak(aTHX_ PL_no_modify);
5985 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5987 i = PTR2IV(SvRV(sv));
5992 flags = SvFLAGS(sv);
5993 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5994 /* It's (privately or publicly) a float, but not tested as an
5995 integer, so test it to see. */
5997 flags = SvFLAGS(sv);
5999 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6000 /* It's publicly an integer, or privately an integer-not-float */
6001 #ifdef PERL_PRESERVE_IVUV
6005 if (SvUVX(sv) == UV_MAX)
6006 sv_setnv(sv, UV_MAX_P1);
6008 (void)SvIOK_only_UV(sv);
6009 SvUV_set(sv, SvUVX(sv) + 1);
6011 if (SvIVX(sv) == IV_MAX)
6012 sv_setuv(sv, (UV)IV_MAX + 1);
6014 (void)SvIOK_only(sv);
6015 SvIV_set(sv, SvIVX(sv) + 1);
6020 if (flags & SVp_NOK) {
6021 (void)SvNOK_only(sv);
6022 SvNV_set(sv, SvNVX(sv) + 1.0);
6026 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6027 if ((flags & SVTYPEMASK) < SVt_PVIV)
6028 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6029 (void)SvIOK_only(sv);
6034 while (isALPHA(*d)) d++;
6035 while (isDIGIT(*d)) d++;
6037 #ifdef PERL_PRESERVE_IVUV
6038 /* Got to punt this as an integer if needs be, but we don't issue
6039 warnings. Probably ought to make the sv_iv_please() that does
6040 the conversion if possible, and silently. */
6041 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6042 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6043 /* Need to try really hard to see if it's an integer.
6044 9.22337203685478e+18 is an integer.
6045 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6046 so $a="9.22337203685478e+18"; $a+0; $a++
6047 needs to be the same as $a="9.22337203685478e+18"; $a++
6054 /* sv_2iv *should* have made this an NV */
6055 if (flags & SVp_NOK) {
6056 (void)SvNOK_only(sv);
6057 SvNV_set(sv, SvNVX(sv) + 1.0);
6060 /* I don't think we can get here. Maybe I should assert this
6061 And if we do get here I suspect that sv_setnv will croak. NWC
6063 #if defined(USE_LONG_DOUBLE)
6064 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",
6065 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6067 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6068 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6071 #endif /* PERL_PRESERVE_IVUV */
6072 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6076 while (d >= SvPVX_const(sv)) {
6084 /* MKS: The original code here died if letters weren't consecutive.
6085 * at least it didn't have to worry about non-C locales. The
6086 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6087 * arranged in order (although not consecutively) and that only
6088 * [A-Za-z] are accepted by isALPHA in the C locale.
6090 if (*d != 'z' && *d != 'Z') {
6091 do { ++*d; } while (!isALPHA(*d));
6094 *(d--) -= 'z' - 'a';
6099 *(d--) -= 'z' - 'a' + 1;
6103 /* oh,oh, the number grew */
6104 SvGROW(sv, SvCUR(sv) + 2);
6105 SvCUR_set(sv, SvCUR(sv) + 1);
6106 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6117 Auto-decrement of the value in the SV, doing string to numeric conversion
6118 if necessary. Handles 'get' magic.
6124 Perl_sv_dec(pTHX_ register SV *sv)
6131 if (SvTHINKFIRST(sv)) {
6133 sv_force_normal_flags(sv, 0);
6134 if (SvREADONLY(sv)) {
6135 if (IN_PERL_RUNTIME)
6136 Perl_croak(aTHX_ PL_no_modify);
6140 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6142 i = PTR2IV(SvRV(sv));
6147 /* Unlike sv_inc we don't have to worry about string-never-numbers
6148 and keeping them magic. But we mustn't warn on punting */
6149 flags = SvFLAGS(sv);
6150 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6151 /* It's publicly an integer, or privately an integer-not-float */
6152 #ifdef PERL_PRESERVE_IVUV
6156 if (SvUVX(sv) == 0) {
6157 (void)SvIOK_only(sv);
6161 (void)SvIOK_only_UV(sv);
6162 SvUV_set(sv, SvUVX(sv) - 1);
6165 if (SvIVX(sv) == IV_MIN)
6166 sv_setnv(sv, (NV)IV_MIN - 1.0);
6168 (void)SvIOK_only(sv);
6169 SvIV_set(sv, SvIVX(sv) - 1);
6174 if (flags & SVp_NOK) {
6175 SvNV_set(sv, SvNVX(sv) - 1.0);
6176 (void)SvNOK_only(sv);
6179 if (!(flags & SVp_POK)) {
6180 if ((flags & SVTYPEMASK) < SVt_PVIV)
6181 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6183 (void)SvIOK_only(sv);
6186 #ifdef PERL_PRESERVE_IVUV
6188 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6189 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6190 /* Need to try really hard to see if it's an integer.
6191 9.22337203685478e+18 is an integer.
6192 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6193 so $a="9.22337203685478e+18"; $a+0; $a--
6194 needs to be the same as $a="9.22337203685478e+18"; $a--
6201 /* sv_2iv *should* have made this an NV */
6202 if (flags & SVp_NOK) {
6203 (void)SvNOK_only(sv);
6204 SvNV_set(sv, SvNVX(sv) - 1.0);
6207 /* I don't think we can get here. Maybe I should assert this
6208 And if we do get here I suspect that sv_setnv will croak. NWC
6210 #if defined(USE_LONG_DOUBLE)
6211 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",
6212 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6214 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6215 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6219 #endif /* PERL_PRESERVE_IVUV */
6220 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6224 =for apidoc sv_mortalcopy
6226 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6227 The new SV is marked as mortal. It will be destroyed "soon", either by an
6228 explicit call to FREETMPS, or by an implicit call at places such as
6229 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6234 /* Make a string that will exist for the duration of the expression
6235 * evaluation. Actually, it may have to last longer than that, but
6236 * hopefully we won't free it until it has been assigned to a
6237 * permanent location. */
6240 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6245 sv_setsv(sv,oldstr);
6247 PL_tmps_stack[++PL_tmps_ix] = sv;
6253 =for apidoc sv_newmortal
6255 Creates a new null SV which is mortal. The reference count of the SV is
6256 set to 1. It will be destroyed "soon", either by an explicit call to
6257 FREETMPS, or by an implicit call at places such as statement boundaries.
6258 See also C<sv_mortalcopy> and C<sv_2mortal>.
6264 Perl_sv_newmortal(pTHX)
6269 SvFLAGS(sv) = SVs_TEMP;
6271 PL_tmps_stack[++PL_tmps_ix] = sv;
6276 =for apidoc sv_2mortal
6278 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6279 by an explicit call to FREETMPS, or by an implicit call at places such as
6280 statement boundaries. SvTEMP() is turned on which means that the SV's
6281 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6282 and C<sv_mortalcopy>.
6288 Perl_sv_2mortal(pTHX_ register SV *sv)
6293 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6296 PL_tmps_stack[++PL_tmps_ix] = sv;
6304 Creates a new SV and copies a string into it. The reference count for the
6305 SV is set to 1. If C<len> is zero, Perl will compute the length using
6306 strlen(). For efficiency, consider using C<newSVpvn> instead.
6312 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6317 sv_setpvn(sv,s,len ? len : strlen(s));
6322 =for apidoc newSVpvn
6324 Creates a new SV and copies a string into it. The reference count for the
6325 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6326 string. You are responsible for ensuring that the source string is at least
6327 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6333 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6338 sv_setpvn(sv,s,len);
6344 =for apidoc newSVhek
6346 Creates a new SV from the hash key structure. It will generate scalars that
6347 point to the shared string table where possible. Returns a new (undefined)
6348 SV if the hek is NULL.
6354 Perl_newSVhek(pTHX_ const HEK *hek)
6363 if (HEK_LEN(hek) == HEf_SVKEY) {
6364 return newSVsv(*(SV**)HEK_KEY(hek));
6366 const int flags = HEK_FLAGS(hek);
6367 if (flags & HVhek_WASUTF8) {
6369 Andreas would like keys he put in as utf8 to come back as utf8
6371 STRLEN utf8_len = HEK_LEN(hek);
6372 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6373 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6376 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6378 } else if (flags & HVhek_REHASH) {
6379 /* We don't have a pointer to the hv, so we have to replicate the
6380 flag into every HEK. This hv is using custom a hasing
6381 algorithm. Hence we can't return a shared string scalar, as
6382 that would contain the (wrong) hash value, and might get passed
6383 into an hv routine with a regular hash */
6385 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6390 /* This will be overwhelminly the most common case. */
6391 return newSVpvn_share(HEK_KEY(hek),
6392 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6398 =for apidoc newSVpvn_share
6400 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6401 table. If the string does not already exist in the table, it is created
6402 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6403 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6404 otherwise the hash is computed. The idea here is that as the string table
6405 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6406 hash lookup will avoid string compare.
6412 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6415 bool is_utf8 = FALSE;
6417 STRLEN tmplen = -len;
6419 /* See the note in hv.c:hv_fetch() --jhi */
6420 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6424 PERL_HASH(hash, src, len);
6426 sv_upgrade(sv, SVt_PV);
6427 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6439 #if defined(PERL_IMPLICIT_CONTEXT)
6441 /* pTHX_ magic can't cope with varargs, so this is a no-context
6442 * version of the main function, (which may itself be aliased to us).
6443 * Don't access this version directly.
6447 Perl_newSVpvf_nocontext(const char* pat, ...)
6452 va_start(args, pat);
6453 sv = vnewSVpvf(pat, &args);
6460 =for apidoc newSVpvf
6462 Creates a new SV and initializes it with the string formatted like
6469 Perl_newSVpvf(pTHX_ const char* pat, ...)
6473 va_start(args, pat);
6474 sv = vnewSVpvf(pat, &args);
6479 /* backend for newSVpvf() and newSVpvf_nocontext() */
6482 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6486 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6493 Creates a new SV and copies a floating point value into it.
6494 The reference count for the SV is set to 1.
6500 Perl_newSVnv(pTHX_ NV n)
6512 Creates a new SV and copies an integer into it. The reference count for the
6519 Perl_newSViv(pTHX_ IV i)
6531 Creates a new SV and copies an unsigned integer into it.
6532 The reference count for the SV is set to 1.
6538 Perl_newSVuv(pTHX_ UV u)
6548 =for apidoc newRV_noinc
6550 Creates an RV wrapper for an SV. The reference count for the original
6551 SV is B<not> incremented.
6557 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6562 sv_upgrade(sv, SVt_RV);
6564 SvRV_set(sv, tmpRef);
6569 /* newRV_inc is the official function name to use now.
6570 * newRV_inc is in fact #defined to newRV in sv.h
6574 Perl_newRV(pTHX_ SV *tmpRef)
6576 return newRV_noinc(SvREFCNT_inc(tmpRef));
6582 Creates a new SV which is an exact duplicate of the original SV.
6589 Perl_newSVsv(pTHX_ register SV *old)
6595 if (SvTYPE(old) == SVTYPEMASK) {
6596 if (ckWARN_d(WARN_INTERNAL))
6597 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6601 /* SV_GMAGIC is the default for sv_setv()
6602 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6603 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6604 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6609 =for apidoc sv_reset
6611 Underlying implementation for the C<reset> Perl function.
6612 Note that the perl-level function is vaguely deprecated.
6618 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6621 char todo[PERL_UCHAR_MAX+1];
6626 if (!*s) { /* reset ?? searches */
6627 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6629 PMOP *pm = (PMOP *) mg->mg_obj;
6631 pm->op_pmdynflags &= ~PMdf_USED;
6638 /* reset variables */
6640 if (!HvARRAY(stash))
6643 Zero(todo, 256, char);
6646 I32 i = (unsigned char)*s;
6650 max = (unsigned char)*s++;
6651 for ( ; i <= max; i++) {
6654 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6656 for (entry = HvARRAY(stash)[i];
6658 entry = HeNEXT(entry))
6663 if (!todo[(U8)*HeKEY(entry)])
6665 gv = (GV*)HeVAL(entry);
6668 if (SvTHINKFIRST(sv)) {
6669 if (!SvREADONLY(sv) && SvROK(sv))
6671 /* XXX Is this continue a bug? Why should THINKFIRST
6672 exempt us from resetting arrays and hashes? */
6676 if (SvTYPE(sv) >= SVt_PV) {
6678 if (SvPVX_const(sv) != Nullch)
6686 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6688 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6691 # if defined(USE_ENVIRON_ARRAY)
6694 # endif /* USE_ENVIRON_ARRAY */
6705 Using various gambits, try to get an IO from an SV: the IO slot if its a
6706 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6707 named after the PV if we're a string.
6713 Perl_sv_2io(pTHX_ SV *sv)
6718 switch (SvTYPE(sv)) {
6726 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6730 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6732 return sv_2io(SvRV(sv));
6733 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6739 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6748 Using various gambits, try to get a CV from an SV; in addition, try if
6749 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6755 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6762 return *gvp = Nullgv, Nullcv;
6763 switch (SvTYPE(sv)) {
6781 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6782 tryAMAGICunDEREF(to_cv);
6785 if (SvTYPE(sv) == SVt_PVCV) {
6794 Perl_croak(aTHX_ "Not a subroutine reference");
6799 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6805 if (lref && !GvCVu(gv)) {
6808 tmpsv = NEWSV(704,0);
6809 gv_efullname3(tmpsv, gv, Nullch);
6810 /* XXX this is probably not what they think they're getting.
6811 * It has the same effect as "sub name;", i.e. just a forward
6813 newSUB(start_subparse(FALSE, 0),
6814 newSVOP(OP_CONST, 0, tmpsv),
6819 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6829 Returns true if the SV has a true value by Perl's rules.
6830 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6831 instead use an in-line version.
6837 Perl_sv_true(pTHX_ register SV *sv)
6842 register const XPV* const tXpv = (XPV*)SvANY(sv);
6844 (tXpv->xpv_cur > 1 ||
6845 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6852 return SvIVX(sv) != 0;
6855 return SvNVX(sv) != 0.0;
6857 return sv_2bool(sv);
6863 =for apidoc sv_pvn_force
6865 Get a sensible string out of the SV somehow.
6866 A private implementation of the C<SvPV_force> macro for compilers which
6867 can't cope with complex macro expressions. Always use the macro instead.
6869 =for apidoc sv_pvn_force_flags
6871 Get a sensible string out of the SV somehow.
6872 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6873 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6874 implemented in terms of this function.
6875 You normally want to use the various wrapper macros instead: see
6876 C<SvPV_force> and C<SvPV_force_nomg>
6882 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6885 if (SvTHINKFIRST(sv) && !SvROK(sv))
6886 sv_force_normal_flags(sv, 0);
6896 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6897 const char * const ref = sv_reftype(sv,0);
6899 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6900 ref, OP_NAME(PL_op));
6902 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6904 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6905 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6907 s = sv_2pv_flags(sv, &len, flags);
6911 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6914 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6915 SvGROW(sv, len + 1);
6916 Move(s,SvPVX(sv),len,char);
6921 SvPOK_on(sv); /* validate pointer */
6923 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6924 PTR2UV(sv),SvPVX_const(sv)));
6927 return SvPVX_mutable(sv);
6931 =for apidoc sv_pvbyten_force
6933 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6939 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6941 sv_pvn_force(sv,lp);
6942 sv_utf8_downgrade(sv,0);
6948 =for apidoc sv_pvutf8n_force
6950 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6956 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6958 sv_pvn_force(sv,lp);
6959 sv_utf8_upgrade(sv);
6965 =for apidoc sv_reftype
6967 Returns a string describing what the SV is a reference to.
6973 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6975 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6976 inside return suggests a const propagation bug in g++. */
6977 if (ob && SvOBJECT(sv)) {
6978 char * const name = HvNAME_get(SvSTASH(sv));
6979 return name ? name : (char *) "__ANON__";
6982 switch (SvTYPE(sv)) {
6999 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7000 /* tied lvalues should appear to be
7001 * scalars for backwards compatitbility */
7002 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7003 ? "SCALAR" : "LVALUE");
7004 case SVt_PVAV: return "ARRAY";
7005 case SVt_PVHV: return "HASH";
7006 case SVt_PVCV: return "CODE";
7007 case SVt_PVGV: return "GLOB";
7008 case SVt_PVFM: return "FORMAT";
7009 case SVt_PVIO: return "IO";
7010 default: return "UNKNOWN";
7016 =for apidoc sv_isobject
7018 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7019 object. If the SV is not an RV, or if the object is not blessed, then this
7026 Perl_sv_isobject(pTHX_ SV *sv)
7042 Returns a boolean indicating whether the SV is blessed into the specified
7043 class. This does not check for subtypes; use C<sv_derived_from> to verify
7044 an inheritance relationship.
7050 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7061 hvname = HvNAME_get(SvSTASH(sv));
7065 return strEQ(hvname, name);
7071 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7072 it will be upgraded to one. If C<classname> is non-null then the new SV will
7073 be blessed in the specified package. The new SV is returned and its
7074 reference count is 1.
7080 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7086 SV_CHECK_THINKFIRST_COW_DROP(rv);
7089 if (SvTYPE(rv) >= SVt_PVMG) {
7090 const U32 refcnt = SvREFCNT(rv);
7094 SvREFCNT(rv) = refcnt;
7097 if (SvTYPE(rv) < SVt_RV)
7098 sv_upgrade(rv, SVt_RV);
7099 else if (SvTYPE(rv) > SVt_RV) {
7110 HV* const stash = gv_stashpv(classname, TRUE);
7111 (void)sv_bless(rv, stash);
7117 =for apidoc sv_setref_pv
7119 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7120 argument will be upgraded to an RV. That RV will be modified to point to
7121 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7122 into the SV. The C<classname> argument indicates the package for the
7123 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7124 will have a reference count of 1, and the RV will be returned.
7126 Do not use with other Perl types such as HV, AV, SV, CV, because those
7127 objects will become corrupted by the pointer copy process.
7129 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7135 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7138 sv_setsv(rv, &PL_sv_undef);
7142 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7147 =for apidoc sv_setref_iv
7149 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7150 argument will be upgraded to an RV. That RV will be modified to point to
7151 the new SV. The C<classname> argument indicates the package for the
7152 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7153 will have a reference count of 1, and the RV will be returned.
7159 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7161 sv_setiv(newSVrv(rv,classname), iv);
7166 =for apidoc sv_setref_uv
7168 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7169 argument will be upgraded to an RV. That RV will be modified to point to
7170 the new SV. The C<classname> argument indicates the package for the
7171 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7172 will have a reference count of 1, and the RV will be returned.
7178 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7180 sv_setuv(newSVrv(rv,classname), uv);
7185 =for apidoc sv_setref_nv
7187 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7188 argument will be upgraded to an RV. That RV will be modified to point to
7189 the new SV. The C<classname> argument indicates the package for the
7190 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7191 will have a reference count of 1, and the RV will be returned.
7197 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7199 sv_setnv(newSVrv(rv,classname), nv);
7204 =for apidoc sv_setref_pvn
7206 Copies a string into a new SV, optionally blessing the SV. The length of the
7207 string must be specified with C<n>. The C<rv> argument will be upgraded to
7208 an RV. That RV will be modified to point to the new SV. The C<classname>
7209 argument indicates the package for the blessing. Set C<classname> to
7210 C<Nullch> to avoid the blessing. The new SV will have a reference count
7211 of 1, and the RV will be returned.
7213 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7219 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7221 sv_setpvn(newSVrv(rv,classname), pv, n);
7226 =for apidoc sv_bless
7228 Blesses an SV into a specified package. The SV must be an RV. The package
7229 must be designated by its stash (see C<gv_stashpv()>). The reference count
7230 of the SV is unaffected.
7236 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7240 Perl_croak(aTHX_ "Can't bless non-reference value");
7242 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7243 if (SvREADONLY(tmpRef))
7244 Perl_croak(aTHX_ PL_no_modify);
7245 if (SvOBJECT(tmpRef)) {
7246 if (SvTYPE(tmpRef) != SVt_PVIO)
7248 SvREFCNT_dec(SvSTASH(tmpRef));
7251 SvOBJECT_on(tmpRef);
7252 if (SvTYPE(tmpRef) != SVt_PVIO)
7254 SvUPGRADE(tmpRef, SVt_PVMG);
7255 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7262 if(SvSMAGICAL(tmpRef))
7263 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7271 /* Downgrades a PVGV to a PVMG.
7275 S_sv_unglob(pTHX_ SV *sv)
7279 assert(SvTYPE(sv) == SVt_PVGV);
7284 sv_del_backref((SV*)GvSTASH(sv), sv);
7285 GvSTASH(sv) = Nullhv;
7287 sv_unmagic(sv, PERL_MAGIC_glob);
7288 Safefree(GvNAME(sv));
7291 /* need to keep SvANY(sv) in the right arena */
7292 xpvmg = new_XPVMG();
7293 StructCopy(SvANY(sv), xpvmg, XPVMG);
7294 del_XPVGV(SvANY(sv));
7297 SvFLAGS(sv) &= ~SVTYPEMASK;
7298 SvFLAGS(sv) |= SVt_PVMG;
7302 =for apidoc sv_unref_flags
7304 Unsets the RV status of the SV, and decrements the reference count of
7305 whatever was being referenced by the RV. This can almost be thought of
7306 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7307 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7308 (otherwise the decrementing is conditional on the reference count being
7309 different from one or the reference being a readonly SV).
7316 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7318 SV* const target = SvRV(ref);
7320 if (SvWEAKREF(ref)) {
7321 sv_del_backref(target, ref);
7323 SvRV_set(ref, NULL);
7326 SvRV_set(ref, NULL);
7328 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7329 assigned to as BEGIN {$a = \"Foo"} will fail. */
7330 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7331 SvREFCNT_dec(target);
7332 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7333 sv_2mortal(target); /* Schedule for freeing later */
7337 =for apidoc sv_untaint
7339 Untaint an SV. Use C<SvTAINTED_off> instead.
7344 Perl_sv_untaint(pTHX_ SV *sv)
7346 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7347 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7354 =for apidoc sv_tainted
7356 Test an SV for taintedness. Use C<SvTAINTED> instead.
7361 Perl_sv_tainted(pTHX_ SV *sv)
7363 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7364 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7365 if (mg && (mg->mg_len & 1) )
7372 =for apidoc sv_setpviv
7374 Copies an integer into the given SV, also updating its string value.
7375 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7381 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7383 char buf[TYPE_CHARS(UV)];
7385 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7387 sv_setpvn(sv, ptr, ebuf - ptr);
7391 =for apidoc sv_setpviv_mg
7393 Like C<sv_setpviv>, but also handles 'set' magic.
7399 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7405 #if defined(PERL_IMPLICIT_CONTEXT)
7407 /* pTHX_ magic can't cope with varargs, so this is a no-context
7408 * version of the main function, (which may itself be aliased to us).
7409 * Don't access this version directly.
7413 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7417 va_start(args, pat);
7418 sv_vsetpvf(sv, pat, &args);
7422 /* pTHX_ magic can't cope with varargs, so this is a no-context
7423 * version of the main function, (which may itself be aliased to us).
7424 * Don't access this version directly.
7428 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7432 va_start(args, pat);
7433 sv_vsetpvf_mg(sv, pat, &args);
7439 =for apidoc sv_setpvf
7441 Works like C<sv_catpvf> but copies the text into the SV instead of
7442 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7448 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7451 va_start(args, pat);
7452 sv_vsetpvf(sv, pat, &args);
7457 =for apidoc sv_vsetpvf
7459 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7460 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7462 Usually used via its frontend C<sv_setpvf>.
7468 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7470 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7474 =for apidoc sv_setpvf_mg
7476 Like C<sv_setpvf>, but also handles 'set' magic.
7482 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7485 va_start(args, pat);
7486 sv_vsetpvf_mg(sv, pat, &args);
7491 =for apidoc sv_vsetpvf_mg
7493 Like C<sv_vsetpvf>, but also handles 'set' magic.
7495 Usually used via its frontend C<sv_setpvf_mg>.
7501 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7503 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7507 #if defined(PERL_IMPLICIT_CONTEXT)
7509 /* pTHX_ magic can't cope with varargs, so this is a no-context
7510 * version of the main function, (which may itself be aliased to us).
7511 * Don't access this version directly.
7515 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7519 va_start(args, pat);
7520 sv_vcatpvf(sv, pat, &args);
7524 /* pTHX_ magic can't cope with varargs, so this is a no-context
7525 * version of the main function, (which may itself be aliased to us).
7526 * Don't access this version directly.
7530 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7534 va_start(args, pat);
7535 sv_vcatpvf_mg(sv, pat, &args);
7541 =for apidoc sv_catpvf
7543 Processes its arguments like C<sprintf> and appends the formatted
7544 output to an SV. If the appended data contains "wide" characters
7545 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7546 and characters >255 formatted with %c), the original SV might get
7547 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7548 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7549 valid UTF-8; if the original SV was bytes, the pattern should be too.
7554 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7557 va_start(args, pat);
7558 sv_vcatpvf(sv, pat, &args);
7563 =for apidoc sv_vcatpvf
7565 Processes its arguments like C<vsprintf> and appends the formatted output
7566 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7568 Usually used via its frontend C<sv_catpvf>.
7574 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7576 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7580 =for apidoc sv_catpvf_mg
7582 Like C<sv_catpvf>, but also handles 'set' magic.
7588 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7591 va_start(args, pat);
7592 sv_vcatpvf_mg(sv, pat, &args);
7597 =for apidoc sv_vcatpvf_mg
7599 Like C<sv_vcatpvf>, but also handles 'set' magic.
7601 Usually used via its frontend C<sv_catpvf_mg>.
7607 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7609 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7614 =for apidoc sv_vsetpvfn
7616 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7619 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7625 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7627 sv_setpvn(sv, "", 0);
7628 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7631 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7634 S_expect_number(pTHX_ char** pattern)
7637 switch (**pattern) {
7638 case '1': case '2': case '3':
7639 case '4': case '5': case '6':
7640 case '7': case '8': case '9':
7641 while (isDIGIT(**pattern))
7642 var = var * 10 + (*(*pattern)++ - '0');
7646 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7649 F0convert(NV nv, char *endbuf, STRLEN *len)
7651 const int neg = nv < 0;
7660 if (uv & 1 && uv == nv)
7661 uv--; /* Round to even */
7663 const unsigned dig = uv % 10;
7676 =for apidoc sv_vcatpvfn
7678 Processes its arguments like C<vsprintf> and appends the formatted output
7679 to an SV. Uses an array of SVs if the C style variable argument list is
7680 missing (NULL). When running with taint checks enabled, indicates via
7681 C<maybe_tainted> if results are untrustworthy (often due to the use of
7684 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7690 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7691 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7692 vec_utf8 = DO_UTF8(vecsv);
7694 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7697 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7704 static const char nullstr[] = "(null)";
7706 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7707 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7709 /* Times 4: a decimal digit takes more than 3 binary digits.
7710 * NV_DIG: mantissa takes than many decimal digits.
7711 * Plus 32: Playing safe. */
7712 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7713 /* large enough for "%#.#f" --chip */
7714 /* what about long double NVs? --jhi */
7716 PERL_UNUSED_ARG(maybe_tainted);
7718 /* no matter what, this is a string now */
7719 (void)SvPV_force(sv, origlen);
7721 /* special-case "", "%s", and "%-p" (SVf - see below) */
7724 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7726 const char * const s = va_arg(*args, char*);
7727 sv_catpv(sv, s ? s : nullstr);
7729 else if (svix < svmax) {
7730 sv_catsv(sv, *svargs);
7734 if (args && patlen == 3 && pat[0] == '%' &&
7735 pat[1] == '-' && pat[2] == 'p') {
7736 argsv = va_arg(*args, SV*);
7737 sv_catsv(sv, argsv);
7741 #ifndef USE_LONG_DOUBLE
7742 /* special-case "%.<number>[gf]" */
7743 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7744 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7745 unsigned digits = 0;
7749 while (*pp >= '0' && *pp <= '9')
7750 digits = 10 * digits + (*pp++ - '0');
7751 if (pp - pat == (int)patlen - 1) {
7759 /* Add check for digits != 0 because it seems that some
7760 gconverts are buggy in this case, and we don't yet have
7761 a Configure test for this. */
7762 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7763 /* 0, point, slack */
7764 Gconvert(nv, (int)digits, 0, ebuf);
7766 if (*ebuf) /* May return an empty string for digits==0 */
7769 } else if (!digits) {
7772 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7773 sv_catpvn(sv, p, l);
7779 #endif /* !USE_LONG_DOUBLE */
7781 if (!args && svix < svmax && DO_UTF8(*svargs))
7784 patend = (char*)pat + patlen;
7785 for (p = (char*)pat; p < patend; p = q) {
7788 bool vectorize = FALSE;
7789 bool vectorarg = FALSE;
7790 bool vec_utf8 = FALSE;
7796 bool has_precis = FALSE;
7799 bool is_utf8 = FALSE; /* is this item utf8? */
7800 #ifdef HAS_LDBL_SPRINTF_BUG
7801 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7802 with sfio - Allen <allens@cpan.org> */
7803 bool fix_ldbl_sprintf_bug = FALSE;
7807 U8 utf8buf[UTF8_MAXBYTES+1];
7808 STRLEN esignlen = 0;
7810 const char *eptr = Nullch;
7813 const U8 *vecstr = Null(U8*);
7820 /* we need a long double target in case HAS_LONG_DOUBLE but
7823 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7831 const char *dotstr = ".";
7832 STRLEN dotstrlen = 1;
7833 I32 efix = 0; /* explicit format parameter index */
7834 I32 ewix = 0; /* explicit width index */
7835 I32 epix = 0; /* explicit precision index */
7836 I32 evix = 0; /* explicit vector index */
7837 bool asterisk = FALSE;
7839 /* echo everything up to the next format specification */
7840 for (q = p; q < patend && *q != '%'; ++q) ;
7842 if (has_utf8 && !pat_utf8)
7843 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7845 sv_catpvn(sv, p, q - p);
7852 We allow format specification elements in this order:
7853 \d+\$ explicit format parameter index
7855 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7856 0 flag (as above): repeated to allow "v02"
7857 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7858 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7860 [%bcdefginopsuxDFOUX] format (mandatory)
7865 As of perl5.9.3, printf format checking is on by default.
7866 Internally, perl uses %p formats to provide an escape to
7867 some extended formatting. This block deals with those
7868 extensions: if it does not match, (char*)q is reset and
7869 the normal format processing code is used.
7871 Currently defined extensions are:
7872 %p include pointer address (standard)
7873 %-p (SVf) include an SV (previously %_)
7874 %-<num>p include an SV with precision <num>
7875 %1p (VDf) include a v-string (as %vd)
7876 %<num>p reserved for future extensions
7878 Robin Barker 2005-07-14
7885 EXPECT_NUMBER(q, n);
7892 argsv = va_arg(*args, SV*);
7893 eptr = SvPVx_const(argsv, elen);
7899 else if (n == vdNUMBER) { /* VDf */
7906 if (ckWARN_d(WARN_INTERNAL))
7907 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7908 "internal %%<num>p might conflict with future printf extensions");
7914 if (EXPECT_NUMBER(q, width)) {
7955 if (EXPECT_NUMBER(q, ewix))
7964 if ((vectorarg = asterisk)) {
7977 EXPECT_NUMBER(q, width);
7983 vecsv = va_arg(*args, SV*);
7985 vecsv = (evix ? evix <= svmax : svix < svmax) ?
7986 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
7987 dotstr = SvPV_const(vecsv, dotstrlen);
7994 else if (efix ? efix <= svmax : svix < svmax) {
7995 vecsv = svargs[efix ? efix-1 : svix++];
7996 vecstr = (U8*)SvPV_const(vecsv,veclen);
7997 vec_utf8 = DO_UTF8(vecsv);
7998 /* if this is a version object, we need to return the
7999 * stringified representation (which the SvPVX_const has
8000 * already done for us), but not vectorize the args
8002 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8004 q++; /* skip past the rest of the %vd format */
8005 eptr = (const char *) vecstr;
8019 i = va_arg(*args, int);
8021 i = (ewix ? ewix <= svmax : svix < svmax) ?
8022 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8024 width = (i < 0) ? -i : i;
8034 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8036 /* XXX: todo, support specified precision parameter */
8040 i = va_arg(*args, int);
8042 i = (ewix ? ewix <= svmax : svix < svmax)
8043 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8044 precis = (i < 0) ? 0 : i;
8049 precis = precis * 10 + (*q++ - '0');
8058 case 'I': /* Ix, I32x, and I64x */
8060 if (q[1] == '6' && q[2] == '4') {
8066 if (q[1] == '3' && q[2] == '2') {
8076 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8087 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8088 if (*(q + 1) == 'l') { /* lld, llf */
8114 const I32 i = efix-1;
8115 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8117 argsv = (svix >= 0 && svix < svmax)
8118 ? svargs[svix++] : &PL_sv_undef;
8127 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8129 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8131 eptr = (char*)utf8buf;
8132 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8143 if (args && !vectorize) {
8144 eptr = va_arg(*args, char*);
8146 #ifdef MACOS_TRADITIONAL
8147 /* On MacOS, %#s format is used for Pascal strings */
8152 elen = strlen(eptr);
8154 eptr = (char *)nullstr;
8155 elen = sizeof nullstr - 1;
8159 eptr = SvPVx_const(argsv, elen);
8160 if (DO_UTF8(argsv)) {
8161 if (has_precis && precis < elen) {
8163 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8166 if (width) { /* fudge width (can't fudge elen) */
8167 width += elen - sv_len_utf8(argsv);
8175 if (has_precis && elen > precis)
8182 if (alt || vectorize)
8184 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8205 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8214 esignbuf[esignlen++] = plus;
8218 case 'h': iv = (short)va_arg(*args, int); break;
8219 case 'l': iv = va_arg(*args, long); break;
8220 case 'V': iv = va_arg(*args, IV); break;
8221 default: iv = va_arg(*args, int); break;
8223 case 'q': iv = va_arg(*args, Quad_t); break;
8228 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8230 case 'h': iv = (short)tiv; break;
8231 case 'l': iv = (long)tiv; break;
8233 default: iv = tiv; break;
8235 case 'q': iv = (Quad_t)tiv; break;
8239 if ( !vectorize ) /* we already set uv above */
8244 esignbuf[esignlen++] = plus;
8248 esignbuf[esignlen++] = '-';
8291 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8302 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8303 case 'l': uv = va_arg(*args, unsigned long); break;
8304 case 'V': uv = va_arg(*args, UV); break;
8305 default: uv = va_arg(*args, unsigned); break;
8307 case 'q': uv = va_arg(*args, Uquad_t); break;
8312 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8314 case 'h': uv = (unsigned short)tuv; break;
8315 case 'l': uv = (unsigned long)tuv; break;
8317 default: uv = tuv; break;
8319 case 'q': uv = (Uquad_t)tuv; break;
8326 char *ptr = ebuf + sizeof ebuf;
8332 p = (char*)((c == 'X')
8333 ? "0123456789ABCDEF" : "0123456789abcdef");
8339 esignbuf[esignlen++] = '0';
8340 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8348 if (alt && *ptr != '0')
8359 esignbuf[esignlen++] = '0';
8360 esignbuf[esignlen++] = 'b';
8363 default: /* it had better be ten or less */
8367 } while (uv /= base);
8370 elen = (ebuf + sizeof ebuf) - ptr;
8374 zeros = precis - elen;
8375 else if (precis == 0 && elen == 1 && *eptr == '0')
8381 /* FLOATING POINT */
8384 c = 'f'; /* maybe %F isn't supported here */
8390 /* This is evil, but floating point is even more evil */
8392 /* for SV-style calling, we can only get NV
8393 for C-style calling, we assume %f is double;
8394 for simplicity we allow any of %Lf, %llf, %qf for long double
8398 #if defined(USE_LONG_DOUBLE)
8402 /* [perl #20339] - we should accept and ignore %lf rather than die */
8406 #if defined(USE_LONG_DOUBLE)
8407 intsize = args ? 0 : 'q';
8411 #if defined(HAS_LONG_DOUBLE)
8420 /* now we need (long double) if intsize == 'q', else (double) */
8421 nv = (args && !vectorize) ?
8422 #if LONG_DOUBLESIZE > DOUBLESIZE
8424 va_arg(*args, long double) :
8425 va_arg(*args, double)
8427 va_arg(*args, double)
8433 if (c != 'e' && c != 'E') {
8435 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8436 will cast our (long double) to (double) */
8437 (void)Perl_frexp(nv, &i);
8438 if (i == PERL_INT_MIN)
8439 Perl_die(aTHX_ "panic: frexp");
8441 need = BIT_DIGITS(i);
8443 need += has_precis ? precis : 6; /* known default */
8448 #ifdef HAS_LDBL_SPRINTF_BUG
8449 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8450 with sfio - Allen <allens@cpan.org> */
8453 # define MY_DBL_MAX DBL_MAX
8454 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8455 # if DOUBLESIZE >= 8
8456 # define MY_DBL_MAX 1.7976931348623157E+308L
8458 # define MY_DBL_MAX 3.40282347E+38L
8462 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8463 # define MY_DBL_MAX_BUG 1L
8465 # define MY_DBL_MAX_BUG MY_DBL_MAX
8469 # define MY_DBL_MIN DBL_MIN
8470 # else /* XXX guessing! -Allen */
8471 # if DOUBLESIZE >= 8
8472 # define MY_DBL_MIN 2.2250738585072014E-308L
8474 # define MY_DBL_MIN 1.17549435E-38L
8478 if ((intsize == 'q') && (c == 'f') &&
8479 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8481 /* it's going to be short enough that
8482 * long double precision is not needed */
8484 if ((nv <= 0L) && (nv >= -0L))
8485 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8487 /* would use Perl_fp_class as a double-check but not
8488 * functional on IRIX - see perl.h comments */
8490 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8491 /* It's within the range that a double can represent */
8492 #if defined(DBL_MAX) && !defined(DBL_MIN)
8493 if ((nv >= ((long double)1/DBL_MAX)) ||
8494 (nv <= (-(long double)1/DBL_MAX)))
8496 fix_ldbl_sprintf_bug = TRUE;
8499 if (fix_ldbl_sprintf_bug == TRUE) {
8509 # undef MY_DBL_MAX_BUG
8512 #endif /* HAS_LDBL_SPRINTF_BUG */
8514 need += 20; /* fudge factor */
8515 if (PL_efloatsize < need) {
8516 Safefree(PL_efloatbuf);
8517 PL_efloatsize = need + 20; /* more fudge */
8518 Newx(PL_efloatbuf, PL_efloatsize, char);
8519 PL_efloatbuf[0] = '\0';
8522 if ( !(width || left || plus || alt) && fill != '0'
8523 && has_precis && intsize != 'q' ) { /* Shortcuts */
8524 /* See earlier comment about buggy Gconvert when digits,
8526 if ( c == 'g' && precis) {
8527 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8528 /* May return an empty string for digits==0 */
8529 if (*PL_efloatbuf) {
8530 elen = strlen(PL_efloatbuf);
8531 goto float_converted;
8533 } else if ( c == 'f' && !precis) {
8534 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8539 char *ptr = ebuf + sizeof ebuf;
8542 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8543 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8544 if (intsize == 'q') {
8545 /* Copy the one or more characters in a long double
8546 * format before the 'base' ([efgEFG]) character to
8547 * the format string. */
8548 static char const prifldbl[] = PERL_PRIfldbl;
8549 char const *p = prifldbl + sizeof(prifldbl) - 3;
8550 while (p >= prifldbl) { *--ptr = *p--; }
8555 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8560 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8572 /* No taint. Otherwise we are in the strange situation
8573 * where printf() taints but print($float) doesn't.
8575 #if defined(HAS_LONG_DOUBLE)
8576 elen = ((intsize == 'q')
8577 ? my_sprintf(PL_efloatbuf, ptr, nv)
8578 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8580 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8584 eptr = PL_efloatbuf;
8590 i = SvCUR(sv) - origlen;
8591 if (args && !vectorize) {
8593 case 'h': *(va_arg(*args, short*)) = i; break;
8594 default: *(va_arg(*args, int*)) = i; break;
8595 case 'l': *(va_arg(*args, long*)) = i; break;
8596 case 'V': *(va_arg(*args, IV*)) = i; break;
8598 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8603 sv_setuv_mg(argsv, (UV)i);
8605 continue; /* not "break" */
8612 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8613 && ckWARN(WARN_PRINTF))
8615 SV * const msg = sv_newmortal();
8616 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8617 (PL_op->op_type == OP_PRTF) ? "" : "s");
8620 Perl_sv_catpvf(aTHX_ msg,
8621 "\"%%%c\"", c & 0xFF);
8623 Perl_sv_catpvf(aTHX_ msg,
8624 "\"%%\\%03"UVof"\"",
8627 sv_catpv(msg, "end of string");
8628 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8631 /* output mangled stuff ... */
8637 /* ... right here, because formatting flags should not apply */
8638 SvGROW(sv, SvCUR(sv) + elen + 1);
8640 Copy(eptr, p, elen, char);
8643 SvCUR_set(sv, p - SvPVX_const(sv));
8645 continue; /* not "break" */
8648 /* calculate width before utf8_upgrade changes it */
8649 have = esignlen + zeros + elen;
8651 Perl_croak_nocontext(PL_memory_wrap);
8653 if (is_utf8 != has_utf8) {
8656 sv_utf8_upgrade(sv);
8659 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8660 sv_utf8_upgrade(nsv);
8661 eptr = SvPVX_const(nsv);
8664 SvGROW(sv, SvCUR(sv) + elen + 1);
8669 need = (have > width ? have : width);
8672 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8673 Perl_croak_nocontext(PL_memory_wrap);
8674 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8676 if (esignlen && fill == '0') {
8678 for (i = 0; i < (int)esignlen; i++)
8682 memset(p, fill, gap);
8685 if (esignlen && fill != '0') {
8687 for (i = 0; i < (int)esignlen; i++)
8692 for (i = zeros; i; i--)
8696 Copy(eptr, p, elen, char);
8700 memset(p, ' ', gap);
8705 Copy(dotstr, p, dotstrlen, char);
8709 vectorize = FALSE; /* done iterating over vecstr */
8716 SvCUR_set(sv, p - SvPVX_const(sv));
8724 /* =========================================================================
8726 =head1 Cloning an interpreter
8728 All the macros and functions in this section are for the private use of
8729 the main function, perl_clone().
8731 The foo_dup() functions make an exact copy of an existing foo thinngy.
8732 During the course of a cloning, a hash table is used to map old addresses
8733 to new addresses. The table is created and manipulated with the
8734 ptr_table_* functions.
8738 ============================================================================*/
8741 #if defined(USE_ITHREADS)
8743 #ifndef GpREFCNT_inc
8744 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8748 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8749 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8750 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8751 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8752 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8753 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8754 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8755 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8756 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8757 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8758 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8759 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8760 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8763 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8764 regcomp.c. AMS 20010712 */
8767 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8772 struct reg_substr_datum *s;
8775 return (REGEXP *)NULL;
8777 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8780 len = r->offsets[0];
8781 npar = r->nparens+1;
8783 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8784 Copy(r->program, ret->program, len+1, regnode);
8786 Newx(ret->startp, npar, I32);
8787 Copy(r->startp, ret->startp, npar, I32);
8788 Newx(ret->endp, npar, I32);
8789 Copy(r->startp, ret->startp, npar, I32);
8791 Newx(ret->substrs, 1, struct reg_substr_data);
8792 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8793 s->min_offset = r->substrs->data[i].min_offset;
8794 s->max_offset = r->substrs->data[i].max_offset;
8795 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8796 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8799 ret->regstclass = NULL;
8802 const int count = r->data->count;
8805 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8806 char, struct reg_data);
8807 Newx(d->what, count, U8);
8810 for (i = 0; i < count; i++) {
8811 d->what[i] = r->data->what[i];
8812 switch (d->what[i]) {
8813 /* legal options are one of: sfpont
8814 see also regcomp.h and pregfree() */
8816 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8819 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8822 /* This is cheating. */
8823 Newx(d->data[i], 1, struct regnode_charclass_class);
8824 StructCopy(r->data->data[i], d->data[i],
8825 struct regnode_charclass_class);
8826 ret->regstclass = (regnode*)d->data[i];
8829 /* Compiled op trees are readonly, and can thus be
8830 shared without duplication. */
8832 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8836 d->data[i] = r->data->data[i];
8839 d->data[i] = r->data->data[i];
8841 ((reg_trie_data*)d->data[i])->refcount++;
8845 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8854 Newx(ret->offsets, 2*len+1, U32);
8855 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8857 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8858 ret->refcnt = r->refcnt;
8859 ret->minlen = r->minlen;
8860 ret->prelen = r->prelen;
8861 ret->nparens = r->nparens;
8862 ret->lastparen = r->lastparen;
8863 ret->lastcloseparen = r->lastcloseparen;
8864 ret->reganch = r->reganch;
8866 ret->sublen = r->sublen;
8868 if (RX_MATCH_COPIED(ret))
8869 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8871 ret->subbeg = Nullch;
8872 #ifdef PERL_OLD_COPY_ON_WRITE
8873 ret->saved_copy = Nullsv;
8876 ptr_table_store(PL_ptr_table, r, ret);
8880 /* duplicate a file handle */
8883 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8887 PERL_UNUSED_ARG(type);
8890 return (PerlIO*)NULL;
8892 /* look for it in the table first */
8893 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8897 /* create anew and remember what it is */
8898 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8899 ptr_table_store(PL_ptr_table, fp, ret);
8903 /* duplicate a directory handle */
8906 Perl_dirp_dup(pTHX_ DIR *dp)
8914 /* duplicate a typeglob */
8917 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8922 /* look for it in the table first */
8923 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8927 /* create anew and remember what it is */
8929 ptr_table_store(PL_ptr_table, gp, ret);
8932 ret->gp_refcnt = 0; /* must be before any other dups! */
8933 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8934 ret->gp_io = io_dup_inc(gp->gp_io, param);
8935 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8936 ret->gp_av = av_dup_inc(gp->gp_av, param);
8937 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8938 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8939 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8940 ret->gp_cvgen = gp->gp_cvgen;
8941 ret->gp_line = gp->gp_line;
8942 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8946 /* duplicate a chain of magic */
8949 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8951 MAGIC *mgprev = (MAGIC*)NULL;
8954 return (MAGIC*)NULL;
8955 /* look for it in the table first */
8956 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8960 for (; mg; mg = mg->mg_moremagic) {
8962 Newxz(nmg, 1, MAGIC);
8964 mgprev->mg_moremagic = nmg;
8967 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8968 nmg->mg_private = mg->mg_private;
8969 nmg->mg_type = mg->mg_type;
8970 nmg->mg_flags = mg->mg_flags;
8971 if (mg->mg_type == PERL_MAGIC_qr) {
8972 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8974 else if(mg->mg_type == PERL_MAGIC_backref) {
8975 const AV * const av = (AV*) mg->mg_obj;
8978 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8980 for (i = AvFILLp(av); i >= 0; i--) {
8981 if (!svp[i]) continue;
8982 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8985 else if (mg->mg_type == PERL_MAGIC_symtab) {
8986 nmg->mg_obj = mg->mg_obj;
8989 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8990 ? sv_dup_inc(mg->mg_obj, param)
8991 : sv_dup(mg->mg_obj, param);
8993 nmg->mg_len = mg->mg_len;
8994 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
8995 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
8996 if (mg->mg_len > 0) {
8997 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
8998 if (mg->mg_type == PERL_MAGIC_overload_table &&
8999 AMT_AMAGIC((AMT*)mg->mg_ptr))
9001 AMT * const amtp = (AMT*)mg->mg_ptr;
9002 AMT * const namtp = (AMT*)nmg->mg_ptr;
9004 for (i = 1; i < NofAMmeth; i++) {
9005 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9009 else if (mg->mg_len == HEf_SVKEY)
9010 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9012 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9013 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9020 /* create a new pointer-mapping table */
9023 Perl_ptr_table_new(pTHX)
9026 Newxz(tbl, 1, PTR_TBL_t);
9029 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9034 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9036 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9040 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9041 following define) and at call to new_body_inline made below in
9042 Perl_ptr_table_store()
9045 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9047 /* map an existing pointer using a table */
9050 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9052 PTR_TBL_ENT_t *tblent;
9053 const UV hash = PTR_TABLE_HASH(sv);
9055 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9056 for (; tblent; tblent = tblent->next) {
9057 if (tblent->oldval == sv)
9058 return tblent->newval;
9063 /* add a new entry to a pointer-mapping table */
9066 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9068 PTR_TBL_ENT_t *tblent, **otblent;
9069 /* XXX this may be pessimal on platforms where pointers aren't good
9070 * hash values e.g. if they grow faster in the most significant
9072 const UV hash = PTR_TABLE_HASH(oldsv);
9076 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9077 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9078 if (tblent->oldval == oldsv) {
9079 tblent->newval = newsv;
9083 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9084 tblent->oldval = oldsv;
9085 tblent->newval = newsv;
9086 tblent->next = *otblent;
9089 if (!empty && tbl->tbl_items > tbl->tbl_max)
9090 ptr_table_split(tbl);
9093 /* double the hash bucket size of an existing ptr table */
9096 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9098 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9099 const UV oldsize = tbl->tbl_max + 1;
9100 UV newsize = oldsize * 2;
9103 Renew(ary, newsize, PTR_TBL_ENT_t*);
9104 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9105 tbl->tbl_max = --newsize;
9107 for (i=0; i < oldsize; i++, ary++) {
9108 PTR_TBL_ENT_t **curentp, **entp, *ent;
9111 curentp = ary + oldsize;
9112 for (entp = ary, ent = *ary; ent; ent = *entp) {
9113 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9115 ent->next = *curentp;
9125 /* remove all the entries from a ptr table */
9128 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9130 register PTR_TBL_ENT_t **array;
9131 register PTR_TBL_ENT_t *entry;
9135 if (!tbl || !tbl->tbl_items) {
9139 array = tbl->tbl_ary;
9145 PTR_TBL_ENT_t *oentry = entry;
9146 entry = entry->next;
9150 if (++riter > max) {
9153 entry = array[riter];
9160 /* clear and free a ptr table */
9163 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9168 ptr_table_clear(tbl);
9169 Safefree(tbl->tbl_ary);
9175 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9178 SvRV_set(dstr, SvWEAKREF(sstr)
9179 ? sv_dup(SvRV(sstr), param)
9180 : sv_dup_inc(SvRV(sstr), param));
9183 else if (SvPVX_const(sstr)) {
9184 /* Has something there */
9186 /* Normal PV - clone whole allocated space */
9187 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9188 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9189 /* Not that normal - actually sstr is copy on write.
9190 But we are a true, independant SV, so: */
9191 SvREADONLY_off(dstr);
9196 /* Special case - not normally malloced for some reason */
9197 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9198 /* A "shared" PV - clone it as "shared" PV */
9200 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9204 /* Some other special case - random pointer */
9205 SvPV_set(dstr, SvPVX(sstr));
9211 if (SvTYPE(dstr) == SVt_RV)
9212 SvRV_set(dstr, NULL);
9218 /* duplicate an SV of any type (including AV, HV etc) */
9221 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9226 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9228 /* look for it in the table first */
9229 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9233 if(param->flags & CLONEf_JOIN_IN) {
9234 /** We are joining here so we don't want do clone
9235 something that is bad **/
9238 if(SvTYPE(sstr) == SVt_PVHV &&
9239 (hvname = HvNAME_get(sstr))) {
9240 /** don't clone stashes if they already exist **/
9241 return (SV*)gv_stashpv(hvname,0);
9245 /* create anew and remember what it is */
9248 #ifdef DEBUG_LEAKING_SCALARS
9249 dstr->sv_debug_optype = sstr->sv_debug_optype;
9250 dstr->sv_debug_line = sstr->sv_debug_line;
9251 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9252 dstr->sv_debug_cloned = 1;
9254 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9256 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9260 ptr_table_store(PL_ptr_table, sstr, dstr);
9263 SvFLAGS(dstr) = SvFLAGS(sstr);
9264 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9265 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9268 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9269 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9270 PL_watch_pvx, SvPVX_const(sstr));
9273 /* don't clone objects whose class has asked us not to */
9274 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9275 SvFLAGS(dstr) &= ~SVTYPEMASK;
9280 switch (SvTYPE(sstr)) {
9285 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9286 SvIV_set(dstr, SvIVX(sstr));
9289 SvANY(dstr) = new_XNV();
9290 SvNV_set(dstr, SvNVX(sstr));
9293 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9294 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9298 /* These are all the types that need complex bodies allocating. */
9300 const svtype sv_type = SvTYPE(sstr);
9301 const struct body_details *const sv_type_details
9302 = bodies_by_type + sv_type;
9306 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9311 if (GvUNIQUE((GV*)sstr)) {
9312 /* Do sharing here, and fall through */
9325 assert(sv_type_details->copy);
9326 if (sv_type_details->arena) {
9327 new_body_inline(new_body, sv_type_details->copy, sv_type);
9329 = (void*)((char*)new_body - sv_type_details->offset);
9331 new_body = new_NOARENA(sv_type_details);
9335 SvANY(dstr) = new_body;
9338 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9339 ((char*)SvANY(dstr)) + sv_type_details->offset,
9340 sv_type_details->copy, char);
9342 Copy(((char*)SvANY(sstr)),
9343 ((char*)SvANY(dstr)),
9344 sv_type_details->size + sv_type_details->offset, char);
9347 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9348 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9350 /* The Copy above means that all the source (unduplicated) pointers
9351 are now in the destination. We can check the flags and the
9352 pointers in either, but it's possible that there's less cache
9353 missing by always going for the destination.
9354 FIXME - instrument and check that assumption */
9355 if (sv_type >= SVt_PVMG) {
9357 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9359 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9362 /* The cast silences a GCC warning about unhandled types. */
9363 switch ((int)sv_type) {
9375 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9376 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9377 LvTARG(dstr) = dstr;
9378 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9379 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9381 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9384 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9385 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9386 /* Don't call sv_add_backref here as it's going to be created
9387 as part of the magic cloning of the symbol table. */
9388 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9389 (void)GpREFCNT_inc(GvGP(dstr));
9392 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9393 if (IoOFP(dstr) == IoIFP(sstr))
9394 IoOFP(dstr) = IoIFP(dstr);
9396 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9397 /* PL_rsfp_filters entries have fake IoDIRP() */
9398 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9399 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9400 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9401 /* I have no idea why fake dirp (rsfps)
9402 should be treated differently but otherwise
9403 we end up with leaks -- sky*/
9404 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9405 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9406 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9408 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9409 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9410 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9412 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9413 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9414 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9417 if (AvARRAY((AV*)sstr)) {
9418 SV **dst_ary, **src_ary;
9419 SSize_t items = AvFILLp((AV*)sstr) + 1;
9421 src_ary = AvARRAY((AV*)sstr);
9422 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9423 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9424 SvPV_set(dstr, (char*)dst_ary);
9425 AvALLOC((AV*)dstr) = dst_ary;
9426 if (AvREAL((AV*)sstr)) {
9428 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9432 *dst_ary++ = sv_dup(*src_ary++, param);
9434 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9435 while (items-- > 0) {
9436 *dst_ary++ = &PL_sv_undef;
9440 SvPV_set(dstr, Nullch);
9441 AvALLOC((AV*)dstr) = (SV**)NULL;
9448 if (HvARRAY((HV*)sstr)) {
9450 const bool sharekeys = !!HvSHAREKEYS(sstr);
9451 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9452 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9454 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9455 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9457 HvARRAY(dstr) = (HE**)darray;
9458 while (i <= sxhv->xhv_max) {
9459 const HE *source = HvARRAY(sstr)[i];
9460 HvARRAY(dstr)[i] = source
9461 ? he_dup(source, sharekeys, param) : 0;
9465 struct xpvhv_aux *saux = HvAUX(sstr);
9466 struct xpvhv_aux *daux = HvAUX(dstr);
9467 /* This flag isn't copied. */
9468 /* SvOOK_on(hv) attacks the IV flags. */
9469 SvFLAGS(dstr) |= SVf_OOK;
9471 hvname = saux->xhv_name;
9473 = hvname ? hek_dup(hvname, param) : hvname;
9475 daux->xhv_riter = saux->xhv_riter;
9476 daux->xhv_eiter = saux->xhv_eiter
9477 ? he_dup(saux->xhv_eiter,
9478 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9482 SvPV_set(dstr, Nullch);
9484 /* Record stashes for possible cloning in Perl_clone(). */
9486 av_push(param->stashes, dstr);
9491 /* NOTE: not refcounted */
9492 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9494 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9496 if (CvCONST(dstr)) {
9497 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9498 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9499 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9501 /* don't dup if copying back - CvGV isn't refcounted, so the
9502 * duped GV may never be freed. A bit of a hack! DAPM */
9503 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9504 Nullgv : gv_dup(CvGV(dstr), param) ;
9505 if (!(param->flags & CLONEf_COPY_STACKS)) {
9508 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9511 ? cv_dup( CvOUTSIDE(dstr), param)
9512 : cv_dup_inc(CvOUTSIDE(dstr), param);
9514 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9520 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9526 /* duplicate a context */
9529 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9534 return (PERL_CONTEXT*)NULL;
9536 /* look for it in the table first */
9537 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9541 /* create anew and remember what it is */
9542 Newxz(ncxs, max + 1, PERL_CONTEXT);
9543 ptr_table_store(PL_ptr_table, cxs, ncxs);
9546 PERL_CONTEXT *cx = &cxs[ix];
9547 PERL_CONTEXT *ncx = &ncxs[ix];
9548 ncx->cx_type = cx->cx_type;
9549 if (CxTYPE(cx) == CXt_SUBST) {
9550 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9553 ncx->blk_oldsp = cx->blk_oldsp;
9554 ncx->blk_oldcop = cx->blk_oldcop;
9555 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9556 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9557 ncx->blk_oldpm = cx->blk_oldpm;
9558 ncx->blk_gimme = cx->blk_gimme;
9559 switch (CxTYPE(cx)) {
9561 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9562 ? cv_dup_inc(cx->blk_sub.cv, param)
9563 : cv_dup(cx->blk_sub.cv,param));
9564 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9565 ? av_dup_inc(cx->blk_sub.argarray, param)
9567 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9568 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9569 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9570 ncx->blk_sub.lval = cx->blk_sub.lval;
9571 ncx->blk_sub.retop = cx->blk_sub.retop;
9574 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9575 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9576 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9577 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9578 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9579 ncx->blk_eval.retop = cx->blk_eval.retop;
9582 ncx->blk_loop.label = cx->blk_loop.label;
9583 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9584 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9585 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9586 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9587 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9588 ? cx->blk_loop.iterdata
9589 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9590 ncx->blk_loop.oldcomppad
9591 = (PAD*)ptr_table_fetch(PL_ptr_table,
9592 cx->blk_loop.oldcomppad);
9593 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9594 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9595 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9596 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9597 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9600 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9601 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9602 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9603 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9604 ncx->blk_sub.retop = cx->blk_sub.retop;
9616 /* duplicate a stack info structure */
9619 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9624 return (PERL_SI*)NULL;
9626 /* look for it in the table first */
9627 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9631 /* create anew and remember what it is */
9632 Newxz(nsi, 1, PERL_SI);
9633 ptr_table_store(PL_ptr_table, si, nsi);
9635 nsi->si_stack = av_dup_inc(si->si_stack, param);
9636 nsi->si_cxix = si->si_cxix;
9637 nsi->si_cxmax = si->si_cxmax;
9638 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9639 nsi->si_type = si->si_type;
9640 nsi->si_prev = si_dup(si->si_prev, param);
9641 nsi->si_next = si_dup(si->si_next, param);
9642 nsi->si_markoff = si->si_markoff;
9647 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9648 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9649 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9650 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9651 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9652 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9653 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9654 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9655 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9656 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9657 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9658 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9659 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9660 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9663 #define pv_dup_inc(p) SAVEPV(p)
9664 #define pv_dup(p) SAVEPV(p)
9665 #define svp_dup_inc(p,pp) any_dup(p,pp)
9667 /* map any object to the new equivent - either something in the
9668 * ptr table, or something in the interpreter structure
9672 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9679 /* look for it in the table first */
9680 ret = ptr_table_fetch(PL_ptr_table, v);
9684 /* see if it is part of the interpreter structure */
9685 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9686 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9694 /* duplicate the save stack */
9697 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9699 ANY * const ss = proto_perl->Tsavestack;
9700 const I32 max = proto_perl->Tsavestack_max;
9701 I32 ix = proto_perl->Tsavestack_ix;
9713 void (*dptr) (void*);
9714 void (*dxptr) (pTHX_ void*);
9716 Newxz(nss, max, ANY);
9719 I32 i = POPINT(ss,ix);
9722 case SAVEt_ITEM: /* normal string */
9723 sv = (SV*)POPPTR(ss,ix);
9724 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9725 sv = (SV*)POPPTR(ss,ix);
9726 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9728 case SAVEt_SV: /* scalar reference */
9729 sv = (SV*)POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9731 gv = (GV*)POPPTR(ss,ix);
9732 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9734 case SAVEt_GENERIC_PVREF: /* generic char* */
9735 c = (char*)POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = pv_dup(c);
9737 ptr = POPPTR(ss,ix);
9738 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9740 case SAVEt_SHARED_PVREF: /* char* in shared space */
9741 c = (char*)POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = savesharedpv(c);
9743 ptr = POPPTR(ss,ix);
9744 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9746 case SAVEt_GENERIC_SVREF: /* generic sv */
9747 case SAVEt_SVREF: /* scalar reference */
9748 sv = (SV*)POPPTR(ss,ix);
9749 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9750 ptr = POPPTR(ss,ix);
9751 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9753 case SAVEt_AV: /* array reference */
9754 av = (AV*)POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = av_dup_inc(av, param);
9756 gv = (GV*)POPPTR(ss,ix);
9757 TOPPTR(nss,ix) = gv_dup(gv, param);
9759 case SAVEt_HV: /* hash reference */
9760 hv = (HV*)POPPTR(ss,ix);
9761 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9762 gv = (GV*)POPPTR(ss,ix);
9763 TOPPTR(nss,ix) = gv_dup(gv, param);
9765 case SAVEt_INT: /* int reference */
9766 ptr = POPPTR(ss,ix);
9767 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9768 intval = (int)POPINT(ss,ix);
9769 TOPINT(nss,ix) = intval;
9771 case SAVEt_LONG: /* long reference */
9772 ptr = POPPTR(ss,ix);
9773 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9774 longval = (long)POPLONG(ss,ix);
9775 TOPLONG(nss,ix) = longval;
9777 case SAVEt_I32: /* I32 reference */
9778 case SAVEt_I16: /* I16 reference */
9779 case SAVEt_I8: /* I8 reference */
9780 ptr = POPPTR(ss,ix);
9781 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9785 case SAVEt_IV: /* IV reference */
9786 ptr = POPPTR(ss,ix);
9787 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9791 case SAVEt_SPTR: /* SV* reference */
9792 ptr = POPPTR(ss,ix);
9793 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9794 sv = (SV*)POPPTR(ss,ix);
9795 TOPPTR(nss,ix) = sv_dup(sv, param);
9797 case SAVEt_VPTR: /* random* reference */
9798 ptr = POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9800 ptr = POPPTR(ss,ix);
9801 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9803 case SAVEt_PPTR: /* char* reference */
9804 ptr = POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9806 c = (char*)POPPTR(ss,ix);
9807 TOPPTR(nss,ix) = pv_dup(c);
9809 case SAVEt_HPTR: /* HV* reference */
9810 ptr = POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9812 hv = (HV*)POPPTR(ss,ix);
9813 TOPPTR(nss,ix) = hv_dup(hv, param);
9815 case SAVEt_APTR: /* AV* reference */
9816 ptr = POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9818 av = (AV*)POPPTR(ss,ix);
9819 TOPPTR(nss,ix) = av_dup(av, param);
9822 gv = (GV*)POPPTR(ss,ix);
9823 TOPPTR(nss,ix) = gv_dup(gv, param);
9825 case SAVEt_GP: /* scalar reference */
9826 gp = (GP*)POPPTR(ss,ix);
9827 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9828 (void)GpREFCNT_inc(gp);
9829 gv = (GV*)POPPTR(ss,ix);
9830 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9831 c = (char*)POPPTR(ss,ix);
9832 TOPPTR(nss,ix) = pv_dup(c);
9839 case SAVEt_MORTALIZESV:
9840 sv = (SV*)POPPTR(ss,ix);
9841 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9844 ptr = POPPTR(ss,ix);
9845 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9846 /* these are assumed to be refcounted properly */
9848 switch (((OP*)ptr)->op_type) {
9855 TOPPTR(nss,ix) = ptr;
9860 TOPPTR(nss,ix) = Nullop;
9865 TOPPTR(nss,ix) = Nullop;
9868 c = (char*)POPPTR(ss,ix);
9869 TOPPTR(nss,ix) = pv_dup_inc(c);
9872 longval = POPLONG(ss,ix);
9873 TOPLONG(nss,ix) = longval;
9876 hv = (HV*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9878 c = (char*)POPPTR(ss,ix);
9879 TOPPTR(nss,ix) = pv_dup_inc(c);
9883 case SAVEt_DESTRUCTOR:
9884 ptr = POPPTR(ss,ix);
9885 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9886 dptr = POPDPTR(ss,ix);
9887 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9888 any_dup(FPTR2DPTR(void *, dptr),
9891 case SAVEt_DESTRUCTOR_X:
9892 ptr = POPPTR(ss,ix);
9893 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9894 dxptr = POPDXPTR(ss,ix);
9895 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9896 any_dup(FPTR2DPTR(void *, dxptr),
9899 case SAVEt_REGCONTEXT:
9905 case SAVEt_STACK_POS: /* Position on Perl stack */
9909 case SAVEt_AELEM: /* array element */
9910 sv = (SV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9914 av = (AV*)POPPTR(ss,ix);
9915 TOPPTR(nss,ix) = av_dup_inc(av, param);
9917 case SAVEt_HELEM: /* hash element */
9918 sv = (SV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9920 sv = (SV*)POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9922 hv = (HV*)POPPTR(ss,ix);
9923 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9926 ptr = POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = ptr;
9934 av = (AV*)POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = av_dup(av, param);
9938 longval = (long)POPLONG(ss,ix);
9939 TOPLONG(nss,ix) = longval;
9940 ptr = POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9942 sv = (SV*)POPPTR(ss,ix);
9943 TOPPTR(nss,ix) = sv_dup(sv, param);
9946 ptr = POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9948 longval = (long)POPBOOL(ss,ix);
9949 TOPBOOL(nss,ix) = (bool)longval;
9951 case SAVEt_SET_SVFLAGS:
9956 sv = (SV*)POPPTR(ss,ix);
9957 TOPPTR(nss,ix) = sv_dup(sv, param);
9960 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9968 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9969 * flag to the result. This is done for each stash before cloning starts,
9970 * so we know which stashes want their objects cloned */
9973 do_mark_cloneable_stash(pTHX_ SV *sv)
9975 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9977 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9978 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9979 if (cloner && GvCV(cloner)) {
9986 XPUSHs(sv_2mortal(newSVhek(hvname)));
9988 call_sv((SV*)GvCV(cloner), G_SCALAR);
9995 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10003 =for apidoc perl_clone
10005 Create and return a new interpreter by cloning the current one.
10007 perl_clone takes these flags as parameters:
10009 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10010 without it we only clone the data and zero the stacks,
10011 with it we copy the stacks and the new perl interpreter is
10012 ready to run at the exact same point as the previous one.
10013 The pseudo-fork code uses COPY_STACKS while the
10014 threads->new doesn't.
10016 CLONEf_KEEP_PTR_TABLE
10017 perl_clone keeps a ptr_table with the pointer of the old
10018 variable as a key and the new variable as a value,
10019 this allows it to check if something has been cloned and not
10020 clone it again but rather just use the value and increase the
10021 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10022 the ptr_table using the function
10023 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10024 reason to keep it around is if you want to dup some of your own
10025 variable who are outside the graph perl scans, example of this
10026 code is in threads.xs create
10029 This is a win32 thing, it is ignored on unix, it tells perls
10030 win32host code (which is c++) to clone itself, this is needed on
10031 win32 if you want to run two threads at the same time,
10032 if you just want to do some stuff in a separate perl interpreter
10033 and then throw it away and return to the original one,
10034 you don't need to do anything.
10039 /* XXX the above needs expanding by someone who actually understands it ! */
10040 EXTERN_C PerlInterpreter *
10041 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10044 perl_clone(PerlInterpreter *proto_perl, UV flags)
10047 #ifdef PERL_IMPLICIT_SYS
10049 /* perlhost.h so we need to call into it
10050 to clone the host, CPerlHost should have a c interface, sky */
10052 if (flags & CLONEf_CLONE_HOST) {
10053 return perl_clone_host(proto_perl,flags);
10055 return perl_clone_using(proto_perl, flags,
10057 proto_perl->IMemShared,
10058 proto_perl->IMemParse,
10060 proto_perl->IStdIO,
10064 proto_perl->IProc);
10068 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10069 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10070 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10071 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10072 struct IPerlDir* ipD, struct IPerlSock* ipS,
10073 struct IPerlProc* ipP)
10075 /* XXX many of the string copies here can be optimized if they're
10076 * constants; they need to be allocated as common memory and just
10077 * their pointers copied. */
10080 CLONE_PARAMS clone_params;
10081 CLONE_PARAMS* param = &clone_params;
10083 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10084 /* for each stash, determine whether its objects should be cloned */
10085 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10086 PERL_SET_THX(my_perl);
10089 Poison(my_perl, 1, PerlInterpreter);
10091 PL_curcop = (COP *)Nullop;
10095 PL_savestack_ix = 0;
10096 PL_savestack_max = -1;
10097 PL_sig_pending = 0;
10098 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10099 # else /* !DEBUGGING */
10100 Zero(my_perl, 1, PerlInterpreter);
10101 # endif /* DEBUGGING */
10103 /* host pointers */
10105 PL_MemShared = ipMS;
10106 PL_MemParse = ipMP;
10113 #else /* !PERL_IMPLICIT_SYS */
10115 CLONE_PARAMS clone_params;
10116 CLONE_PARAMS* param = &clone_params;
10117 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10118 /* for each stash, determine whether its objects should be cloned */
10119 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10120 PERL_SET_THX(my_perl);
10123 Poison(my_perl, 1, PerlInterpreter);
10125 PL_curcop = (COP *)Nullop;
10129 PL_savestack_ix = 0;
10130 PL_savestack_max = -1;
10131 PL_sig_pending = 0;
10132 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10133 # else /* !DEBUGGING */
10134 Zero(my_perl, 1, PerlInterpreter);
10135 # endif /* DEBUGGING */
10136 #endif /* PERL_IMPLICIT_SYS */
10137 param->flags = flags;
10138 param->proto_perl = proto_perl;
10140 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10141 Zero(&PL_body_roots, 1, PL_body_roots);
10143 PL_nice_chunk = NULL;
10144 PL_nice_chunk_size = 0;
10146 PL_sv_objcount = 0;
10147 PL_sv_root = Nullsv;
10148 PL_sv_arenaroot = Nullsv;
10150 PL_debug = proto_perl->Idebug;
10152 PL_hash_seed = proto_perl->Ihash_seed;
10153 PL_rehash_seed = proto_perl->Irehash_seed;
10155 #ifdef USE_REENTRANT_API
10156 /* XXX: things like -Dm will segfault here in perlio, but doing
10157 * PERL_SET_CONTEXT(proto_perl);
10158 * breaks too many other things
10160 Perl_reentrant_init(aTHX);
10163 /* create SV map for pointer relocation */
10164 PL_ptr_table = ptr_table_new();
10166 /* initialize these special pointers as early as possible */
10167 SvANY(&PL_sv_undef) = NULL;
10168 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10169 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10170 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10172 SvANY(&PL_sv_no) = new_XPVNV();
10173 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10174 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10175 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10176 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10177 SvCUR_set(&PL_sv_no, 0);
10178 SvLEN_set(&PL_sv_no, 1);
10179 SvIV_set(&PL_sv_no, 0);
10180 SvNV_set(&PL_sv_no, 0);
10181 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10183 SvANY(&PL_sv_yes) = new_XPVNV();
10184 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10185 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10186 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10187 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10188 SvCUR_set(&PL_sv_yes, 1);
10189 SvLEN_set(&PL_sv_yes, 2);
10190 SvIV_set(&PL_sv_yes, 1);
10191 SvNV_set(&PL_sv_yes, 1);
10192 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10194 /* create (a non-shared!) shared string table */
10195 PL_strtab = newHV();
10196 HvSHAREKEYS_off(PL_strtab);
10197 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10198 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10200 PL_compiling = proto_perl->Icompiling;
10202 /* These two PVs will be free'd special way so must set them same way op.c does */
10203 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10204 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10206 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10207 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10209 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10210 if (!specialWARN(PL_compiling.cop_warnings))
10211 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10212 if (!specialCopIO(PL_compiling.cop_io))
10213 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10214 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10216 /* pseudo environmental stuff */
10217 PL_origargc = proto_perl->Iorigargc;
10218 PL_origargv = proto_perl->Iorigargv;
10220 param->stashes = newAV(); /* Setup array of objects to call clone on */
10222 /* Set tainting stuff before PerlIO_debug can possibly get called */
10223 PL_tainting = proto_perl->Itainting;
10224 PL_taint_warn = proto_perl->Itaint_warn;
10226 #ifdef PERLIO_LAYERS
10227 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10228 PerlIO_clone(aTHX_ proto_perl, param);
10231 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10232 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10233 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10234 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10235 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10236 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10239 PL_minus_c = proto_perl->Iminus_c;
10240 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10241 PL_localpatches = proto_perl->Ilocalpatches;
10242 PL_splitstr = proto_perl->Isplitstr;
10243 PL_preprocess = proto_perl->Ipreprocess;
10244 PL_minus_n = proto_perl->Iminus_n;
10245 PL_minus_p = proto_perl->Iminus_p;
10246 PL_minus_l = proto_perl->Iminus_l;
10247 PL_minus_a = proto_perl->Iminus_a;
10248 PL_minus_F = proto_perl->Iminus_F;
10249 PL_doswitches = proto_perl->Idoswitches;
10250 PL_dowarn = proto_perl->Idowarn;
10251 PL_doextract = proto_perl->Idoextract;
10252 PL_sawampersand = proto_perl->Isawampersand;
10253 PL_unsafe = proto_perl->Iunsafe;
10254 PL_inplace = SAVEPV(proto_perl->Iinplace);
10255 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10256 PL_perldb = proto_perl->Iperldb;
10257 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10258 PL_exit_flags = proto_perl->Iexit_flags;
10260 /* magical thingies */
10261 /* XXX time(&PL_basetime) when asked for? */
10262 PL_basetime = proto_perl->Ibasetime;
10263 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10265 PL_maxsysfd = proto_perl->Imaxsysfd;
10266 PL_multiline = proto_perl->Imultiline;
10267 PL_statusvalue = proto_perl->Istatusvalue;
10269 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10271 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10273 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10275 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10276 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10277 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10279 /* Clone the regex array */
10280 PL_regex_padav = newAV();
10282 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10283 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10285 av_push(PL_regex_padav,
10286 sv_dup_inc(regexen[0],param));
10287 for(i = 1; i <= len; i++) {
10288 if(SvREPADTMP(regexen[i])) {
10289 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10291 av_push(PL_regex_padav,
10293 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10294 SvIVX(regexen[i])), param)))
10299 PL_regex_pad = AvARRAY(PL_regex_padav);
10301 /* shortcuts to various I/O objects */
10302 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10303 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10304 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10305 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10306 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10307 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10309 /* shortcuts to regexp stuff */
10310 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10312 /* shortcuts to misc objects */
10313 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10315 /* shortcuts to debugging objects */
10316 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10317 PL_DBline = gv_dup(proto_perl->IDBline, param);
10318 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10319 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10320 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10321 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10322 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10323 PL_lineary = av_dup(proto_perl->Ilineary, param);
10324 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10326 /* symbol tables */
10327 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10328 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10329 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10330 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10331 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10333 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10334 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10335 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10336 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10337 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10338 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10340 PL_sub_generation = proto_perl->Isub_generation;
10342 /* funky return mechanisms */
10343 PL_forkprocess = proto_perl->Iforkprocess;
10345 /* subprocess state */
10346 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10348 /* internal state */
10349 PL_maxo = proto_perl->Imaxo;
10350 if (proto_perl->Iop_mask)
10351 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10353 PL_op_mask = Nullch;
10354 /* PL_asserting = proto_perl->Iasserting; */
10356 /* current interpreter roots */
10357 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10358 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10359 PL_main_start = proto_perl->Imain_start;
10360 PL_eval_root = proto_perl->Ieval_root;
10361 PL_eval_start = proto_perl->Ieval_start;
10363 /* runtime control stuff */
10364 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10365 PL_copline = proto_perl->Icopline;
10367 PL_filemode = proto_perl->Ifilemode;
10368 PL_lastfd = proto_perl->Ilastfd;
10369 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10372 PL_gensym = proto_perl->Igensym;
10373 PL_preambled = proto_perl->Ipreambled;
10374 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10375 PL_laststatval = proto_perl->Ilaststatval;
10376 PL_laststype = proto_perl->Ilaststype;
10377 PL_mess_sv = Nullsv;
10379 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10381 /* interpreter atexit processing */
10382 PL_exitlistlen = proto_perl->Iexitlistlen;
10383 if (PL_exitlistlen) {
10384 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10385 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10388 PL_exitlist = (PerlExitListEntry*)NULL;
10389 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10390 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10391 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10393 PL_profiledata = NULL;
10394 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10395 /* PL_rsfp_filters entries have fake IoDIRP() */
10396 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10398 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10400 PAD_CLONE_VARS(proto_perl, param);
10402 #ifdef HAVE_INTERP_INTERN
10403 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10406 /* more statics moved here */
10407 PL_generation = proto_perl->Igeneration;
10408 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10410 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10411 PL_in_clean_all = proto_perl->Iin_clean_all;
10413 PL_uid = proto_perl->Iuid;
10414 PL_euid = proto_perl->Ieuid;
10415 PL_gid = proto_perl->Igid;
10416 PL_egid = proto_perl->Iegid;
10417 PL_nomemok = proto_perl->Inomemok;
10418 PL_an = proto_perl->Ian;
10419 PL_evalseq = proto_perl->Ievalseq;
10420 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10421 PL_origalen = proto_perl->Iorigalen;
10422 #ifdef PERL_USES_PL_PIDSTATUS
10423 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10425 PL_osname = SAVEPV(proto_perl->Iosname);
10426 PL_sighandlerp = proto_perl->Isighandlerp;
10428 PL_runops = proto_perl->Irunops;
10430 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10433 PL_cshlen = proto_perl->Icshlen;
10434 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10437 PL_lex_state = proto_perl->Ilex_state;
10438 PL_lex_defer = proto_perl->Ilex_defer;
10439 PL_lex_expect = proto_perl->Ilex_expect;
10440 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10441 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10442 PL_lex_starts = proto_perl->Ilex_starts;
10443 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10444 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10445 PL_lex_op = proto_perl->Ilex_op;
10446 PL_lex_inpat = proto_perl->Ilex_inpat;
10447 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10448 PL_lex_brackets = proto_perl->Ilex_brackets;
10449 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10450 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10451 PL_lex_casemods = proto_perl->Ilex_casemods;
10452 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10453 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10455 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10456 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10457 PL_nexttoke = proto_perl->Inexttoke;
10459 /* XXX This is probably masking the deeper issue of why
10460 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10461 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10462 * (A little debugging with a watchpoint on it may help.)
10464 if (SvANY(proto_perl->Ilinestr)) {
10465 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10466 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10467 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10468 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10469 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10470 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10471 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10472 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10473 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10476 PL_linestr = NEWSV(65,79);
10477 sv_upgrade(PL_linestr,SVt_PVIV);
10478 sv_setpvn(PL_linestr,"",0);
10479 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10481 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10482 PL_pending_ident = proto_perl->Ipending_ident;
10483 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10485 PL_expect = proto_perl->Iexpect;
10487 PL_multi_start = proto_perl->Imulti_start;
10488 PL_multi_end = proto_perl->Imulti_end;
10489 PL_multi_open = proto_perl->Imulti_open;
10490 PL_multi_close = proto_perl->Imulti_close;
10492 PL_error_count = proto_perl->Ierror_count;
10493 PL_subline = proto_perl->Isubline;
10494 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10496 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10497 if (SvANY(proto_perl->Ilinestr)) {
10498 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10499 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10500 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10501 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10502 PL_last_lop_op = proto_perl->Ilast_lop_op;
10505 PL_last_uni = SvPVX(PL_linestr);
10506 PL_last_lop = SvPVX(PL_linestr);
10507 PL_last_lop_op = 0;
10509 PL_in_my = proto_perl->Iin_my;
10510 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10512 PL_cryptseen = proto_perl->Icryptseen;
10515 PL_hints = proto_perl->Ihints;
10517 PL_amagic_generation = proto_perl->Iamagic_generation;
10519 #ifdef USE_LOCALE_COLLATE
10520 PL_collation_ix = proto_perl->Icollation_ix;
10521 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10522 PL_collation_standard = proto_perl->Icollation_standard;
10523 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10524 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10525 #endif /* USE_LOCALE_COLLATE */
10527 #ifdef USE_LOCALE_NUMERIC
10528 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10529 PL_numeric_standard = proto_perl->Inumeric_standard;
10530 PL_numeric_local = proto_perl->Inumeric_local;
10531 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10532 #endif /* !USE_LOCALE_NUMERIC */
10534 /* utf8 character classes */
10535 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10536 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10537 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10538 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10539 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10540 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10541 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10542 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10543 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10544 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10545 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10546 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10547 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10548 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10549 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10550 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10551 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10552 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10553 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10554 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10556 /* Did the locale setup indicate UTF-8? */
10557 PL_utf8locale = proto_perl->Iutf8locale;
10558 /* Unicode features (see perlrun/-C) */
10559 PL_unicode = proto_perl->Iunicode;
10561 /* Pre-5.8 signals control */
10562 PL_signals = proto_perl->Isignals;
10564 /* times() ticks per second */
10565 PL_clocktick = proto_perl->Iclocktick;
10567 /* Recursion stopper for PerlIO_find_layer */
10568 PL_in_load_module = proto_perl->Iin_load_module;
10570 /* sort() routine */
10571 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10573 /* Not really needed/useful since the reenrant_retint is "volatile",
10574 * but do it for consistency's sake. */
10575 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10577 /* Hooks to shared SVs and locks. */
10578 PL_sharehook = proto_perl->Isharehook;
10579 PL_lockhook = proto_perl->Ilockhook;
10580 PL_unlockhook = proto_perl->Iunlockhook;
10581 PL_threadhook = proto_perl->Ithreadhook;
10583 PL_runops_std = proto_perl->Irunops_std;
10584 PL_runops_dbg = proto_perl->Irunops_dbg;
10586 #ifdef THREADS_HAVE_PIDS
10587 PL_ppid = proto_perl->Ippid;
10591 PL_last_swash_hv = Nullhv; /* reinits on demand */
10592 PL_last_swash_klen = 0;
10593 PL_last_swash_key[0]= '\0';
10594 PL_last_swash_tmps = (U8*)NULL;
10595 PL_last_swash_slen = 0;
10597 PL_glob_index = proto_perl->Iglob_index;
10598 PL_srand_called = proto_perl->Isrand_called;
10599 PL_uudmap['M'] = 0; /* reinits on demand */
10600 PL_bitcount = Nullch; /* reinits on demand */
10602 if (proto_perl->Ipsig_pend) {
10603 Newxz(PL_psig_pend, SIG_SIZE, int);
10606 PL_psig_pend = (int*)NULL;
10609 if (proto_perl->Ipsig_ptr) {
10610 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10611 Newxz(PL_psig_name, SIG_SIZE, SV*);
10612 for (i = 1; i < SIG_SIZE; i++) {
10613 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10614 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10618 PL_psig_ptr = (SV**)NULL;
10619 PL_psig_name = (SV**)NULL;
10622 /* thrdvar.h stuff */
10624 if (flags & CLONEf_COPY_STACKS) {
10625 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10626 PL_tmps_ix = proto_perl->Ttmps_ix;
10627 PL_tmps_max = proto_perl->Ttmps_max;
10628 PL_tmps_floor = proto_perl->Ttmps_floor;
10629 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10631 while (i <= PL_tmps_ix) {
10632 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10636 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10637 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10638 Newxz(PL_markstack, i, I32);
10639 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10640 - proto_perl->Tmarkstack);
10641 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10642 - proto_perl->Tmarkstack);
10643 Copy(proto_perl->Tmarkstack, PL_markstack,
10644 PL_markstack_ptr - PL_markstack + 1, I32);
10646 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10647 * NOTE: unlike the others! */
10648 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10649 PL_scopestack_max = proto_perl->Tscopestack_max;
10650 Newxz(PL_scopestack, PL_scopestack_max, I32);
10651 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10653 /* NOTE: si_dup() looks at PL_markstack */
10654 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10656 /* PL_curstack = PL_curstackinfo->si_stack; */
10657 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10658 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10660 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10661 PL_stack_base = AvARRAY(PL_curstack);
10662 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10663 - proto_perl->Tstack_base);
10664 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10666 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10667 * NOTE: unlike the others! */
10668 PL_savestack_ix = proto_perl->Tsavestack_ix;
10669 PL_savestack_max = proto_perl->Tsavestack_max;
10670 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10671 PL_savestack = ss_dup(proto_perl, param);
10675 ENTER; /* perl_destruct() wants to LEAVE; */
10678 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10679 PL_top_env = &PL_start_env;
10681 PL_op = proto_perl->Top;
10684 PL_Xpv = (XPV*)NULL;
10685 PL_na = proto_perl->Tna;
10687 PL_statbuf = proto_perl->Tstatbuf;
10688 PL_statcache = proto_perl->Tstatcache;
10689 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10690 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10692 PL_timesbuf = proto_perl->Ttimesbuf;
10695 PL_tainted = proto_perl->Ttainted;
10696 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10697 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10698 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10699 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10700 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10701 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10702 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10703 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10704 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10706 PL_restartop = proto_perl->Trestartop;
10707 PL_in_eval = proto_perl->Tin_eval;
10708 PL_delaymagic = proto_perl->Tdelaymagic;
10709 PL_dirty = proto_perl->Tdirty;
10710 PL_localizing = proto_perl->Tlocalizing;
10712 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10713 PL_hv_fetch_ent_mh = Nullhe;
10714 PL_modcount = proto_perl->Tmodcount;
10715 PL_lastgotoprobe = Nullop;
10716 PL_dumpindent = proto_perl->Tdumpindent;
10718 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10719 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10720 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10721 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10722 PL_efloatbuf = Nullch; /* reinits on demand */
10723 PL_efloatsize = 0; /* reinits on demand */
10727 PL_screamfirst = NULL;
10728 PL_screamnext = NULL;
10729 PL_maxscream = -1; /* reinits on demand */
10730 PL_lastscream = Nullsv;
10732 PL_watchaddr = NULL;
10733 PL_watchok = Nullch;
10735 PL_regdummy = proto_perl->Tregdummy;
10736 PL_regprecomp = Nullch;
10739 PL_colorset = 0; /* reinits PL_colors[] */
10740 /*PL_colors[6] = {0,0,0,0,0,0};*/
10741 PL_reginput = Nullch;
10742 PL_regbol = Nullch;
10743 PL_regeol = Nullch;
10744 PL_regstartp = (I32*)NULL;
10745 PL_regendp = (I32*)NULL;
10746 PL_reglastparen = (U32*)NULL;
10747 PL_reglastcloseparen = (U32*)NULL;
10748 PL_regtill = Nullch;
10749 PL_reg_start_tmp = (char**)NULL;
10750 PL_reg_start_tmpl = 0;
10751 PL_regdata = (struct reg_data*)NULL;
10754 PL_reg_eval_set = 0;
10756 PL_regprogram = (regnode*)NULL;
10758 PL_regcc = (CURCUR*)NULL;
10759 PL_reg_call_cc = (struct re_cc_state*)NULL;
10760 PL_reg_re = (regexp*)NULL;
10761 PL_reg_ganch = Nullch;
10762 PL_reg_sv = Nullsv;
10763 PL_reg_match_utf8 = FALSE;
10764 PL_reg_magic = (MAGIC*)NULL;
10766 PL_reg_oldcurpm = (PMOP*)NULL;
10767 PL_reg_curpm = (PMOP*)NULL;
10768 PL_reg_oldsaved = Nullch;
10769 PL_reg_oldsavedlen = 0;
10770 #ifdef PERL_OLD_COPY_ON_WRITE
10773 PL_reg_maxiter = 0;
10774 PL_reg_leftiter = 0;
10775 PL_reg_poscache = Nullch;
10776 PL_reg_poscache_size= 0;
10778 /* RE engine - function pointers */
10779 PL_regcompp = proto_perl->Tregcompp;
10780 PL_regexecp = proto_perl->Tregexecp;
10781 PL_regint_start = proto_perl->Tregint_start;
10782 PL_regint_string = proto_perl->Tregint_string;
10783 PL_regfree = proto_perl->Tregfree;
10785 PL_reginterp_cnt = 0;
10786 PL_reg_starttry = 0;
10788 /* Pluggable optimizer */
10789 PL_peepp = proto_perl->Tpeepp;
10791 PL_stashcache = newHV();
10793 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10794 ptr_table_free(PL_ptr_table);
10795 PL_ptr_table = NULL;
10798 /* Call the ->CLONE method, if it exists, for each of the stashes
10799 identified by sv_dup() above.
10801 while(av_len(param->stashes) != -1) {
10802 HV* const stash = (HV*) av_shift(param->stashes);
10803 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10804 if (cloner && GvCV(cloner)) {
10809 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10811 call_sv((SV*)GvCV(cloner), G_DISCARD);
10817 SvREFCNT_dec(param->stashes);
10819 /* orphaned? eg threads->new inside BEGIN or use */
10820 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10821 (void)SvREFCNT_inc(PL_compcv);
10822 SAVEFREESV(PL_compcv);
10828 #endif /* USE_ITHREADS */
10831 =head1 Unicode Support
10833 =for apidoc sv_recode_to_utf8
10835 The encoding is assumed to be an Encode object, on entry the PV
10836 of the sv is assumed to be octets in that encoding, and the sv
10837 will be converted into Unicode (and UTF-8).
10839 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10840 is not a reference, nothing is done to the sv. If the encoding is not
10841 an C<Encode::XS> Encoding object, bad things will happen.
10842 (See F<lib/encoding.pm> and L<Encode>).
10844 The PV of the sv is returned.
10849 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10852 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10866 Passing sv_yes is wrong - it needs to be or'ed set of constants
10867 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10868 remove converted chars from source.
10870 Both will default the value - let them.
10872 XPUSHs(&PL_sv_yes);
10875 call_method("decode", G_SCALAR);
10879 s = SvPV_const(uni, len);
10880 if (s != SvPVX_const(sv)) {
10881 SvGROW(sv, len + 1);
10882 Move(s, SvPVX(sv), len + 1, char);
10883 SvCUR_set(sv, len);
10890 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10894 =for apidoc sv_cat_decode
10896 The encoding is assumed to be an Encode object, the PV of the ssv is
10897 assumed to be octets in that encoding and decoding the input starts
10898 from the position which (PV + *offset) pointed to. The dsv will be
10899 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10900 when the string tstr appears in decoding output or the input ends on
10901 the PV of the ssv. The value which the offset points will be modified
10902 to the last input position on the ssv.
10904 Returns TRUE if the terminator was found, else returns FALSE.
10909 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10910 SV *ssv, int *offset, char *tstr, int tlen)
10914 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10925 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10926 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10928 call_method("cat_decode", G_SCALAR);
10930 ret = SvTRUE(TOPs);
10931 *offset = SvIV(offsv);
10937 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10942 /* ---------------------------------------------------------------------
10944 * support functions for report_uninit()
10947 /* the maxiumum size of array or hash where we will scan looking
10948 * for the undefined element that triggered the warning */
10950 #define FUV_MAX_SEARCH_SIZE 1000
10952 /* Look for an entry in the hash whose value has the same SV as val;
10953 * If so, return a mortal copy of the key. */
10956 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10959 register HE **array;
10962 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10963 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10966 array = HvARRAY(hv);
10968 for (i=HvMAX(hv); i>0; i--) {
10969 register HE *entry;
10970 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10971 if (HeVAL(entry) != val)
10973 if ( HeVAL(entry) == &PL_sv_undef ||
10974 HeVAL(entry) == &PL_sv_placeholder)
10978 if (HeKLEN(entry) == HEf_SVKEY)
10979 return sv_mortalcopy(HeKEY_sv(entry));
10980 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10986 /* Look for an entry in the array whose value has the same SV as val;
10987 * If so, return the index, otherwise return -1. */
10990 S_find_array_subscript(pTHX_ AV *av, SV* val)
10994 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10995 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10999 for (i=AvFILLp(av); i>=0; i--) {
11000 if (svp[i] == val && svp[i] != &PL_sv_undef)
11006 /* S_varname(): return the name of a variable, optionally with a subscript.
11007 * If gv is non-zero, use the name of that global, along with gvtype (one
11008 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11009 * targ. Depending on the value of the subscript_type flag, return:
11012 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11013 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11014 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11015 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11018 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11019 SV* keyname, I32 aindex, int subscript_type)
11022 SV * const name = sv_newmortal();
11025 buffer[0] = gvtype;
11028 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11030 gv_fullname4(name, gv, buffer, 0);
11032 if ((unsigned int)SvPVX(name)[1] <= 26) {
11034 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11036 /* Swap the 1 unprintable control character for the 2 byte pretty
11037 version - ie substr($name, 1, 1) = $buffer; */
11038 sv_insert(name, 1, 1, buffer, 2);
11043 CV * const cv = find_runcv(&unused);
11047 if (!cv || !CvPADLIST(cv))
11049 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11050 sv = *av_fetch(av, targ, FALSE);
11051 /* SvLEN in a pad name is not to be trusted */
11052 sv_setpv(name, SvPV_nolen_const(sv));
11055 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11056 SV * const sv = NEWSV(0,0);
11057 *SvPVX(name) = '$';
11058 Perl_sv_catpvf(aTHX_ name, "{%s}",
11059 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11062 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11063 *SvPVX(name) = '$';
11064 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11066 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11067 sv_insert(name, 0, 0, "within ", 7);
11074 =for apidoc find_uninit_var
11076 Find the name of the undefined variable (if any) that caused the operator o
11077 to issue a "Use of uninitialized value" warning.
11078 If match is true, only return a name if it's value matches uninit_sv.
11079 So roughly speaking, if a unary operator (such as OP_COS) generates a
11080 warning, then following the direct child of the op may yield an
11081 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11082 other hand, with OP_ADD there are two branches to follow, so we only print
11083 the variable name if we get an exact match.
11085 The name is returned as a mortal SV.
11087 Assumes that PL_op is the op that originally triggered the error, and that
11088 PL_comppad/PL_curpad points to the currently executing pad.
11094 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11102 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11103 uninit_sv == &PL_sv_placeholder)))
11106 switch (obase->op_type) {
11113 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11114 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11116 SV *keysv = Nullsv;
11117 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11119 if (pad) { /* @lex, %lex */
11120 sv = PAD_SVl(obase->op_targ);
11124 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11125 /* @global, %global */
11126 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11129 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11131 else /* @{expr}, %{expr} */
11132 return find_uninit_var(cUNOPx(obase)->op_first,
11136 /* attempt to find a match within the aggregate */
11138 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11140 subscript_type = FUV_SUBSCRIPT_HASH;
11143 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11145 subscript_type = FUV_SUBSCRIPT_ARRAY;
11148 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11151 return varname(gv, hash ? '%' : '@', obase->op_targ,
11152 keysv, index, subscript_type);
11156 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11158 return varname(Nullgv, '$', obase->op_targ,
11159 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11162 gv = cGVOPx_gv(obase);
11163 if (!gv || (match && GvSV(gv) != uninit_sv))
11165 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11168 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11171 av = (AV*)PAD_SV(obase->op_targ);
11172 if (!av || SvRMAGICAL(av))
11174 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11175 if (!svp || *svp != uninit_sv)
11178 return varname(Nullgv, '$', obase->op_targ,
11179 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11182 gv = cGVOPx_gv(obase);
11188 if (!av || SvRMAGICAL(av))
11190 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11191 if (!svp || *svp != uninit_sv)
11194 return varname(gv, '$', 0,
11195 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11200 o = cUNOPx(obase)->op_first;
11201 if (!o || o->op_type != OP_NULL ||
11202 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11204 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11208 if (PL_op == obase)
11209 /* $a[uninit_expr] or $h{uninit_expr} */
11210 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11213 o = cBINOPx(obase)->op_first;
11214 kid = cBINOPx(obase)->op_last;
11216 /* get the av or hv, and optionally the gv */
11218 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11219 sv = PAD_SV(o->op_targ);
11221 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11222 && cUNOPo->op_first->op_type == OP_GV)
11224 gv = cGVOPx_gv(cUNOPo->op_first);
11227 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11232 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11233 /* index is constant */
11237 if (obase->op_type == OP_HELEM) {
11238 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11239 if (!he || HeVAL(he) != uninit_sv)
11243 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11244 if (!svp || *svp != uninit_sv)
11248 if (obase->op_type == OP_HELEM)
11249 return varname(gv, '%', o->op_targ,
11250 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11252 return varname(gv, '@', o->op_targ, Nullsv,
11253 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11257 /* index is an expression;
11258 * attempt to find a match within the aggregate */
11259 if (obase->op_type == OP_HELEM) {
11260 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11262 return varname(gv, '%', o->op_targ,
11263 keysv, 0, FUV_SUBSCRIPT_HASH);
11266 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11268 return varname(gv, '@', o->op_targ,
11269 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11274 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11276 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11282 /* only examine RHS */
11283 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11286 o = cUNOPx(obase)->op_first;
11287 if (o->op_type == OP_PUSHMARK)
11290 if (!o->op_sibling) {
11291 /* one-arg version of open is highly magical */
11293 if (o->op_type == OP_GV) { /* open FOO; */
11295 if (match && GvSV(gv) != uninit_sv)
11297 return varname(gv, '$', 0,
11298 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11300 /* other possibilities not handled are:
11301 * open $x; or open my $x; should return '${*$x}'
11302 * open expr; should return '$'.expr ideally
11308 /* ops where $_ may be an implicit arg */
11312 if ( !(obase->op_flags & OPf_STACKED)) {
11313 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11314 ? PAD_SVl(obase->op_targ)
11317 sv = sv_newmortal();
11318 sv_setpvn(sv, "$_", 2);
11326 /* skip filehandle as it can't produce 'undef' warning */
11327 o = cUNOPx(obase)->op_first;
11328 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11329 o = o->op_sibling->op_sibling;
11336 match = 1; /* XS or custom code could trigger random warnings */
11341 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11342 return sv_2mortal(newSVpvn("${$/}", 5));
11347 if (!(obase->op_flags & OPf_KIDS))
11349 o = cUNOPx(obase)->op_first;
11355 /* if all except one arg are constant, or have no side-effects,
11356 * or are optimized away, then it's unambiguous */
11358 for (kid=o; kid; kid = kid->op_sibling) {
11360 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11361 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11362 || (kid->op_type == OP_PUSHMARK)
11366 if (o2) { /* more than one found */
11373 return find_uninit_var(o2, uninit_sv, match);
11375 /* scan all args */
11377 sv = find_uninit_var(o, uninit_sv, 1);
11389 =for apidoc report_uninit
11391 Print appropriate "Use of uninitialized variable" warning
11397 Perl_report_uninit(pTHX_ SV* uninit_sv)
11400 SV* varname = Nullsv;
11402 varname = find_uninit_var(PL_op, uninit_sv,0);
11404 sv_insert(varname, 0, 0, " ", 1);
11406 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11407 varname ? SvPV_nolen_const(varname) : "",
11408 " in ", OP_DESC(PL_op));
11411 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11417 * c-indentation-style: bsd
11418 * c-basic-offset: 4
11419 * indent-tabs-mode: t
11422 * ex: set ts=8 sts=4 sw=4 noet: