3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void ** const arena_root = &PL_body_arenaroots[sv_type];
644 void ** const root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void ** const r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv)) {
1894 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 == IS_NUMBER_IN_UV) {
1898 /* It's definitely an integer */
1899 if (numtype & IS_NUMBER_NEG) {
1900 if (value < (UV)IV_MIN)
1903 if (value < (UV)IV_MAX)
1908 if (ckWARN(WARN_NUMERIC))
1911 return I_V(Atof(SvPVX_const(sv)));
1916 assert(SvTYPE(sv) >= SVt_PVMG);
1917 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1919 if (SvTHINKFIRST(sv)) {
1923 SV * const tmpstr=AMG_CALLun(sv,numer);
1924 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1925 return SvIV(tmpstr);
1928 return PTR2IV(SvRV(sv));
1931 sv_force_normal_flags(sv, 0);
1933 if (SvREADONLY(sv) && !SvOK(sv)) {
1934 if (ckWARN(WARN_UNINITIALIZED))
1940 if (S_sv_2iuv_common(aTHX_ sv))
1943 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1944 PTR2UV(sv),SvIVX(sv)));
1945 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1949 =for apidoc sv_2uv_flags
1951 Return the unsigned integer value of an SV, doing any necessary string
1952 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1953 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1959 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1963 if (SvGMAGICAL(sv)) {
1964 if (flags & SV_GMAGIC)
1969 return U_V(SvNVX(sv));
1970 if (SvPOKp(sv) && SvLEN(sv)) {
1973 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1975 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1976 == IS_NUMBER_IN_UV) {
1977 /* It's definitely an integer */
1978 if (!(numtype & IS_NUMBER_NEG))
1982 if (ckWARN(WARN_NUMERIC))
1985 return U_V(Atof(SvPVX_const(sv)));
1990 assert(SvTYPE(sv) >= SVt_PVMG);
1991 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1993 if (SvTHINKFIRST(sv)) {
1997 SV *const tmpstr = AMG_CALLun(sv,numer);
1998 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1999 return SvUV(tmpstr);
2002 return PTR2UV(SvRV(sv));
2005 sv_force_normal_flags(sv, 0);
2007 if (SvREADONLY(sv) && !SvOK(sv)) {
2008 if (ckWARN(WARN_UNINITIALIZED))
2014 if (S_sv_2iuv_common(aTHX_ sv))
2018 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2019 PTR2UV(sv),SvUVX(sv)));
2020 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2026 Return the num value of an SV, doing any necessary string or integer
2027 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2034 Perl_sv_2nv(pTHX_ register SV *sv)
2038 if (SvGMAGICAL(sv)) {
2042 if (SvPOKp(sv) && SvLEN(sv)) {
2043 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2044 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2046 return Atof(SvPVX_const(sv));
2050 return (NV)SvUVX(sv);
2052 return (NV)SvIVX(sv);
2057 assert(SvTYPE(sv) >= SVt_PVMG);
2058 /* This falls through to the report_uninit near the end of the
2060 } else if (SvTHINKFIRST(sv)) {
2064 SV *const tmpstr = AMG_CALLun(sv,numer);
2065 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2066 return SvNV(tmpstr);
2069 return PTR2NV(SvRV(sv));
2072 sv_force_normal_flags(sv, 0);
2074 if (SvREADONLY(sv) && !SvOK(sv)) {
2075 if (ckWARN(WARN_UNINITIALIZED))
2080 if (SvTYPE(sv) < SVt_NV) {
2081 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2082 sv_upgrade(sv, SVt_NV);
2083 #ifdef USE_LONG_DOUBLE
2085 STORE_NUMERIC_LOCAL_SET_STANDARD();
2086 PerlIO_printf(Perl_debug_log,
2087 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2088 PTR2UV(sv), SvNVX(sv));
2089 RESTORE_NUMERIC_LOCAL();
2093 STORE_NUMERIC_LOCAL_SET_STANDARD();
2094 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2095 PTR2UV(sv), SvNVX(sv));
2096 RESTORE_NUMERIC_LOCAL();
2100 else if (SvTYPE(sv) < SVt_PVNV)
2101 sv_upgrade(sv, SVt_PVNV);
2106 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2107 #ifdef NV_PRESERVES_UV
2110 /* Only set the public NV OK flag if this NV preserves the IV */
2111 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2112 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2113 : (SvIVX(sv) == I_V(SvNVX(sv))))
2119 else if (SvPOKp(sv) && SvLEN(sv)) {
2121 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2122 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2124 #ifdef NV_PRESERVES_UV
2125 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2126 == IS_NUMBER_IN_UV) {
2127 /* It's definitely an integer */
2128 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2130 SvNV_set(sv, Atof(SvPVX_const(sv)));
2133 SvNV_set(sv, Atof(SvPVX_const(sv)));
2134 /* Only set the public NV OK flag if this NV preserves the value in
2135 the PV at least as well as an IV/UV would.
2136 Not sure how to do this 100% reliably. */
2137 /* if that shift count is out of range then Configure's test is
2138 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2140 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2141 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2142 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2143 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2144 /* Can't use strtol etc to convert this string, so don't try.
2145 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2148 /* value has been set. It may not be precise. */
2149 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2150 /* 2s complement assumption for (UV)IV_MIN */
2151 SvNOK_on(sv); /* Integer is too negative. */
2156 if (numtype & IS_NUMBER_NEG) {
2157 SvIV_set(sv, -(IV)value);
2158 } else if (value <= (UV)IV_MAX) {
2159 SvIV_set(sv, (IV)value);
2161 SvUV_set(sv, value);
2165 if (numtype & IS_NUMBER_NOT_INT) {
2166 /* I believe that even if the original PV had decimals,
2167 they are lost beyond the limit of the FP precision.
2168 However, neither is canonical, so both only get p
2169 flags. NWC, 2000/11/25 */
2170 /* Both already have p flags, so do nothing */
2172 const NV nv = SvNVX(sv);
2173 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2174 if (SvIVX(sv) == I_V(nv)) {
2177 /* It had no "." so it must be integer. */
2181 /* between IV_MAX and NV(UV_MAX).
2182 Could be slightly > UV_MAX */
2184 if (numtype & IS_NUMBER_NOT_INT) {
2185 /* UV and NV both imprecise. */
2187 const UV nv_as_uv = U_V(nv);
2189 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2198 #endif /* NV_PRESERVES_UV */
2201 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2203 assert (SvTYPE(sv) >= SVt_NV);
2204 /* Typically the caller expects that sv_any is not NULL now. */
2205 /* XXX Ilya implies that this is a bug in callers that assume this
2206 and ideally should be fixed. */
2209 #if defined(USE_LONG_DOUBLE)
2211 STORE_NUMERIC_LOCAL_SET_STANDARD();
2212 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2213 PTR2UV(sv), SvNVX(sv));
2214 RESTORE_NUMERIC_LOCAL();
2218 STORE_NUMERIC_LOCAL_SET_STANDARD();
2219 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2220 PTR2UV(sv), SvNVX(sv));
2221 RESTORE_NUMERIC_LOCAL();
2227 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2228 * UV as a string towards the end of buf, and return pointers to start and
2231 * We assume that buf is at least TYPE_CHARS(UV) long.
2235 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2237 char *ptr = buf + TYPE_CHARS(UV);
2238 char * const ebuf = ptr;
2251 *--ptr = '0' + (char)(uv % 10);
2259 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2260 * a regexp to its stringified form.
2264 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2265 const regexp * const re = (regexp *)mg->mg_obj;
2268 const char *fptr = "msix";
2273 bool need_newline = 0;
2274 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2276 while((ch = *fptr++)) {
2278 reflags[left++] = ch;
2281 reflags[right--] = ch;
2286 reflags[left] = '-';
2290 mg->mg_len = re->prelen + 4 + left;
2292 * If /x was used, we have to worry about a regex ending with a
2293 * comment later being embedded within another regex. If so, we don't
2294 * want this regex's "commentization" to leak out to the right part of
2295 * the enclosing regex, we must cap it with a newline.
2297 * So, if /x was used, we scan backwards from the end of the regex. If
2298 * we find a '#' before we find a newline, we need to add a newline
2299 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2300 * we don't need to add anything. -jfriedl
2302 if (PMf_EXTENDED & re->reganch) {
2303 const char *endptr = re->precomp + re->prelen;
2304 while (endptr >= re->precomp) {
2305 const char c = *(endptr--);
2307 break; /* don't need another */
2309 /* we end while in a comment, so we need a newline */
2310 mg->mg_len++; /* save space for it */
2311 need_newline = 1; /* note to add it */
2317 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2318 mg->mg_ptr[0] = '(';
2319 mg->mg_ptr[1] = '?';
2320 Copy(reflags, mg->mg_ptr+2, left, char);
2321 *(mg->mg_ptr+left+2) = ':';
2322 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2324 mg->mg_ptr[mg->mg_len - 2] = '\n';
2325 mg->mg_ptr[mg->mg_len - 1] = ')';
2326 mg->mg_ptr[mg->mg_len] = 0;
2328 PL_reginterp_cnt += re->program[0].next_off;
2330 if (re->reganch & ROPT_UTF8)
2340 =for apidoc sv_2pv_flags
2342 Returns a pointer to the string value of an SV, and sets *lp to its length.
2343 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2345 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2346 usually end up here too.
2352 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2362 if (SvGMAGICAL(sv)) {
2363 if (flags & SV_GMAGIC)
2368 if (flags & SV_MUTABLE_RETURN)
2369 return SvPVX_mutable(sv);
2370 if (flags & SV_CONST_RETURN)
2371 return (char *)SvPVX_const(sv);
2374 if (SvIOKp(sv) || SvNOKp(sv)) {
2375 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2379 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2380 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2382 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2385 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2386 /* Sneaky stuff here */
2387 SV * const tsv = newSVpvn(tbuf, len);
2397 #ifdef FIXNEGATIVEZERO
2398 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2404 SvUPGRADE(sv, SVt_PV);
2407 s = SvGROW_mutable(sv, len + 1);
2410 return memcpy(s, tbuf, len + 1);
2416 assert(SvTYPE(sv) >= SVt_PVMG);
2417 /* This falls through to the report_uninit near the end of the
2419 } else if (SvTHINKFIRST(sv)) {
2423 SV *const tmpstr = AMG_CALLun(sv,string);
2424 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2426 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2430 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2431 if (flags & SV_CONST_RETURN) {
2432 pv = (char *) SvPVX_const(tmpstr);
2434 pv = (flags & SV_MUTABLE_RETURN)
2435 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2438 *lp = SvCUR(tmpstr);
2440 pv = sv_2pv_flags(tmpstr, lp, flags);
2452 const SV *const referent = (SV*)SvRV(sv);
2455 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2456 } else if (SvTYPE(referent) == SVt_PVMG
2457 && ((SvFLAGS(referent) &
2458 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2459 == (SVs_OBJECT|SVs_SMG))
2460 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2461 return S_stringify_regexp(aTHX_ sv, mg, lp);
2463 const char *const typestr = sv_reftype(referent, 0);
2465 tsv = sv_newmortal();
2466 if (SvOBJECT(referent)) {
2467 const char *const name = HvNAME_get(SvSTASH(referent));
2468 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2469 name ? name : "__ANON__" , typestr,
2473 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2481 if (SvREADONLY(sv) && !SvOK(sv)) {
2482 if (ckWARN(WARN_UNINITIALIZED))
2489 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2490 /* I'm assuming that if both IV and NV are equally valid then
2491 converting the IV is going to be more efficient */
2492 const U32 isIOK = SvIOK(sv);
2493 const U32 isUIOK = SvIsUV(sv);
2494 char buf[TYPE_CHARS(UV)];
2497 if (SvTYPE(sv) < SVt_PVIV)
2498 sv_upgrade(sv, SVt_PVIV);
2500 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2502 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2503 /* inlined from sv_setpvn */
2504 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2505 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2506 SvCUR_set(sv, ebuf - ptr);
2516 else if (SvNOKp(sv)) {
2517 if (SvTYPE(sv) < SVt_PVNV)
2518 sv_upgrade(sv, SVt_PVNV);
2519 /* The +20 is pure guesswork. Configure test needed. --jhi */
2520 s = SvGROW_mutable(sv, NV_DIG + 20);
2521 olderrno = errno; /* some Xenix systems wipe out errno here */
2523 if (SvNVX(sv) == 0.0)
2524 (void)strcpy(s,"0");
2528 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2531 #ifdef FIXNEGATIVEZERO
2532 if (*s == '-' && s[1] == '0' && !s[2])
2542 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2546 if (SvTYPE(sv) < SVt_PV)
2547 /* Typically the caller expects that sv_any is not NULL now. */
2548 sv_upgrade(sv, SVt_PV);
2552 const STRLEN len = s - SvPVX_const(sv);
2558 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2559 PTR2UV(sv),SvPVX_const(sv)));
2560 if (flags & SV_CONST_RETURN)
2561 return (char *)SvPVX_const(sv);
2562 if (flags & SV_MUTABLE_RETURN)
2563 return SvPVX_mutable(sv);
2568 =for apidoc sv_copypv
2570 Copies a stringified representation of the source SV into the
2571 destination SV. Automatically performs any necessary mg_get and
2572 coercion of numeric values into strings. Guaranteed to preserve
2573 UTF-8 flag even from overloaded objects. Similar in nature to
2574 sv_2pv[_flags] but operates directly on an SV instead of just the
2575 string. Mostly uses sv_2pv_flags to do its work, except when that
2576 would lose the UTF-8'ness of the PV.
2582 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2585 const char * const s = SvPV_const(ssv,len);
2586 sv_setpvn(dsv,s,len);
2594 =for apidoc sv_2pvbyte
2596 Return a pointer to the byte-encoded representation of the SV, and set *lp
2597 to its length. May cause the SV to be downgraded from UTF-8 as a
2600 Usually accessed via the C<SvPVbyte> macro.
2606 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2608 sv_utf8_downgrade(sv,0);
2609 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2613 =for apidoc sv_2pvutf8
2615 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2616 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2618 Usually accessed via the C<SvPVutf8> macro.
2624 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2626 sv_utf8_upgrade(sv);
2627 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2632 =for apidoc sv_2bool
2634 This function is only called on magical items, and is only used by
2635 sv_true() or its macro equivalent.
2641 Perl_sv_2bool(pTHX_ register SV *sv)
2649 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2650 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2651 return (bool)SvTRUE(tmpsv);
2652 return SvRV(sv) != 0;
2655 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2657 (*sv->sv_u.svu_pv > '0' ||
2658 Xpvtmp->xpv_cur > 1 ||
2659 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2666 return SvIVX(sv) != 0;
2669 return SvNVX(sv) != 0.0;
2677 =for apidoc sv_utf8_upgrade
2679 Converts the PV of an SV to its UTF-8-encoded form.
2680 Forces the SV to string form if it is not already.
2681 Always sets the SvUTF8 flag to avoid future validity checks even
2682 if all the bytes have hibit clear.
2684 This is not as a general purpose byte encoding to Unicode interface:
2685 use the Encode extension for that.
2687 =for apidoc sv_utf8_upgrade_flags
2689 Converts the PV of an SV to its UTF-8-encoded form.
2690 Forces the SV to string form if it is not already.
2691 Always sets the SvUTF8 flag to avoid future validity checks even
2692 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2693 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2694 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2696 This is not as a general purpose byte encoding to Unicode interface:
2697 use the Encode extension for that.
2703 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2705 if (sv == &PL_sv_undef)
2709 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2710 (void) sv_2pv_flags(sv,&len, flags);
2714 (void) SvPV_force(sv,len);
2723 sv_force_normal_flags(sv, 0);
2726 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2727 sv_recode_to_utf8(sv, PL_encoding);
2728 else { /* Assume Latin-1/EBCDIC */
2729 /* This function could be much more efficient if we
2730 * had a FLAG in SVs to signal if there are any hibit
2731 * chars in the PV. Given that there isn't such a flag
2732 * make the loop as fast as possible. */
2733 const U8 * const s = (U8 *) SvPVX_const(sv);
2734 const U8 * const e = (U8 *) SvEND(sv);
2739 /* Check for hi bit */
2740 if (!NATIVE_IS_INVARIANT(ch)) {
2741 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2742 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2744 SvPV_free(sv); /* No longer using what was there before. */
2745 SvPV_set(sv, (char*)recoded);
2746 SvCUR_set(sv, len - 1);
2747 SvLEN_set(sv, len); /* No longer know the real size. */
2751 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2758 =for apidoc sv_utf8_downgrade
2760 Attempts to convert the PV of an SV from characters to bytes.
2761 If the PV contains a character beyond byte, this conversion will fail;
2762 in this case, either returns false or, if C<fail_ok> is not
2765 This is not as a general purpose Unicode to byte encoding interface:
2766 use the Encode extension for that.
2772 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2774 if (SvPOKp(sv) && SvUTF8(sv)) {
2780 sv_force_normal_flags(sv, 0);
2782 s = (U8 *) SvPV(sv, len);
2783 if (!utf8_to_bytes(s, &len)) {
2788 Perl_croak(aTHX_ "Wide character in %s",
2791 Perl_croak(aTHX_ "Wide character");
2802 =for apidoc sv_utf8_encode
2804 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2805 flag off so that it looks like octets again.
2811 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2813 (void) sv_utf8_upgrade(sv);
2815 sv_force_normal_flags(sv, 0);
2817 if (SvREADONLY(sv)) {
2818 Perl_croak(aTHX_ PL_no_modify);
2824 =for apidoc sv_utf8_decode
2826 If the PV of the SV is an octet sequence in UTF-8
2827 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2828 so that it looks like a character. If the PV contains only single-byte
2829 characters, the C<SvUTF8> flag stays being off.
2830 Scans PV for validity and returns false if the PV is invalid UTF-8.
2836 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2842 /* The octets may have got themselves encoded - get them back as
2845 if (!sv_utf8_downgrade(sv, TRUE))
2848 /* it is actually just a matter of turning the utf8 flag on, but
2849 * we want to make sure everything inside is valid utf8 first.
2851 c = (const U8 *) SvPVX_const(sv);
2852 if (!is_utf8_string(c, SvCUR(sv)+1))
2854 e = (const U8 *) SvEND(sv);
2857 if (!UTF8_IS_INVARIANT(ch)) {
2867 =for apidoc sv_setsv
2869 Copies the contents of the source SV C<ssv> into the destination SV
2870 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2871 function if the source SV needs to be reused. Does not handle 'set' magic.
2872 Loosely speaking, it performs a copy-by-value, obliterating any previous
2873 content of the destination.
2875 You probably want to use one of the assortment of wrappers, such as
2876 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2877 C<SvSetMagicSV_nosteal>.
2879 =for apidoc sv_setsv_flags
2881 Copies the contents of the source SV C<ssv> into the destination SV
2882 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2883 function if the source SV needs to be reused. Does not handle 'set' magic.
2884 Loosely speaking, it performs a copy-by-value, obliterating any previous
2885 content of the destination.
2886 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2887 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2888 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2889 and C<sv_setsv_nomg> are implemented in terms of this function.
2891 You probably want to use one of the assortment of wrappers, such as
2892 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2893 C<SvSetMagicSV_nosteal>.
2895 This is the primary function for copying scalars, and most other
2896 copy-ish functions and macros use this underneath.
2902 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2904 register U32 sflags;
2910 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2912 sstr = &PL_sv_undef;
2913 stype = SvTYPE(sstr);
2914 dtype = SvTYPE(dstr);
2919 /* need to nuke the magic */
2921 SvRMAGICAL_off(dstr);
2924 /* There's a lot of redundancy below but we're going for speed here */
2929 if (dtype != SVt_PVGV) {
2930 (void)SvOK_off(dstr);
2938 sv_upgrade(dstr, SVt_IV);
2941 sv_upgrade(dstr, SVt_PVNV);
2945 sv_upgrade(dstr, SVt_PVIV);
2948 (void)SvIOK_only(dstr);
2949 SvIV_set(dstr, SvIVX(sstr));
2952 if (SvTAINTED(sstr))
2963 sv_upgrade(dstr, SVt_NV);
2968 sv_upgrade(dstr, SVt_PVNV);
2971 SvNV_set(dstr, SvNVX(sstr));
2972 (void)SvNOK_only(dstr);
2973 if (SvTAINTED(sstr))
2981 sv_upgrade(dstr, SVt_RV);
2982 else if (dtype == SVt_PVGV &&
2983 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2986 if (GvIMPORTED(dstr) != GVf_IMPORTED
2987 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2989 GvIMPORTED_on(dstr);
2998 #ifdef PERL_OLD_COPY_ON_WRITE
2999 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3000 if (dtype < SVt_PVIV)
3001 sv_upgrade(dstr, SVt_PVIV);
3008 sv_upgrade(dstr, SVt_PV);
3011 if (dtype < SVt_PVIV)
3012 sv_upgrade(dstr, SVt_PVIV);
3015 if (dtype < SVt_PVNV)
3016 sv_upgrade(dstr, SVt_PVNV);
3023 const char * const type = sv_reftype(sstr,0);
3025 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3027 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3032 if (dtype <= SVt_PVGV) {
3034 if (dtype != SVt_PVGV) {
3035 const char * const name = GvNAME(sstr);
3036 const STRLEN len = GvNAMELEN(sstr);
3037 /* don't upgrade SVt_PVLV: it can hold a glob */
3038 if (dtype != SVt_PVLV)
3039 sv_upgrade(dstr, SVt_PVGV);
3040 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3041 GvSTASH(dstr) = GvSTASH(sstr);
3043 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3044 GvNAME(dstr) = savepvn(name, len);
3045 GvNAMELEN(dstr) = len;
3046 SvFAKE_on(dstr); /* can coerce to non-glob */
3049 #ifdef GV_UNIQUE_CHECK
3050 if (GvUNIQUE((GV*)dstr)) {
3051 Perl_croak(aTHX_ PL_no_modify);
3055 (void)SvOK_off(dstr);
3056 GvINTRO_off(dstr); /* one-shot flag */
3058 GvGP(dstr) = gp_ref(GvGP(sstr));
3059 if (SvTAINTED(sstr))
3061 if (GvIMPORTED(dstr) != GVf_IMPORTED
3062 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3064 GvIMPORTED_on(dstr);
3072 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3074 if ((int)SvTYPE(sstr) != stype) {
3075 stype = SvTYPE(sstr);
3076 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3080 if (stype == SVt_PVLV)
3081 SvUPGRADE(dstr, SVt_PVNV);
3083 SvUPGRADE(dstr, (U32)stype);
3086 sflags = SvFLAGS(sstr);
3088 if (sflags & SVf_ROK) {
3089 if (dtype >= SVt_PV) {
3090 if (dtype == SVt_PVGV) {
3091 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3093 const int intro = GvINTRO(dstr);
3095 #ifdef GV_UNIQUE_CHECK
3096 if (GvUNIQUE((GV*)dstr)) {
3097 Perl_croak(aTHX_ PL_no_modify);
3102 GvINTRO_off(dstr); /* one-shot flag */
3103 GvLINE(dstr) = CopLINE(PL_curcop);
3104 GvEGV(dstr) = (GV*)dstr;
3107 switch (SvTYPE(sref)) {
3110 SAVEGENERICSV(GvAV(dstr));
3112 dref = (SV*)GvAV(dstr);
3113 GvAV(dstr) = (AV*)sref;
3114 if (!GvIMPORTED_AV(dstr)
3115 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3117 GvIMPORTED_AV_on(dstr);
3122 SAVEGENERICSV(GvHV(dstr));
3124 dref = (SV*)GvHV(dstr);
3125 GvHV(dstr) = (HV*)sref;
3126 if (!GvIMPORTED_HV(dstr)
3127 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3129 GvIMPORTED_HV_on(dstr);
3134 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3135 SvREFCNT_dec(GvCV(dstr));
3136 GvCV(dstr) = Nullcv;
3137 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3138 PL_sub_generation++;
3140 SAVEGENERICSV(GvCV(dstr));
3143 dref = (SV*)GvCV(dstr);
3144 if (GvCV(dstr) != (CV*)sref) {
3145 CV* const cv = GvCV(dstr);
3147 if (!GvCVGEN((GV*)dstr) &&
3148 (CvROOT(cv) || CvXSUB(cv)))
3150 /* Redefining a sub - warning is mandatory if
3151 it was a const and its value changed. */
3152 if (ckWARN(WARN_REDEFINE)
3154 && (!CvCONST((CV*)sref)
3155 || sv_cmp(cv_const_sv(cv),
3156 cv_const_sv((CV*)sref)))))
3158 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3160 ? "Constant subroutine %s::%s redefined"
3161 : "Subroutine %s::%s redefined",
3162 HvNAME_get(GvSTASH((GV*)dstr)),
3163 GvENAME((GV*)dstr));
3167 cv_ckproto(cv, (GV*)dstr,
3169 ? SvPVX_const(sref) : Nullch);
3171 GvCV(dstr) = (CV*)sref;
3172 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3173 GvASSUMECV_on(dstr);
3174 PL_sub_generation++;
3176 if (!GvIMPORTED_CV(dstr)
3177 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3179 GvIMPORTED_CV_on(dstr);
3184 SAVEGENERICSV(GvIOp(dstr));
3186 dref = (SV*)GvIOp(dstr);
3187 GvIOp(dstr) = (IO*)sref;
3191 SAVEGENERICSV(GvFORM(dstr));
3193 dref = (SV*)GvFORM(dstr);
3194 GvFORM(dstr) = (CV*)sref;
3198 SAVEGENERICSV(GvSV(dstr));
3200 dref = (SV*)GvSV(dstr);
3202 if (!GvIMPORTED_SV(dstr)
3203 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3205 GvIMPORTED_SV_on(dstr);
3211 if (SvTAINTED(sstr))
3215 if (SvPVX_const(dstr)) {
3221 (void)SvOK_off(dstr);
3222 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3224 if (sflags & SVp_NOK) {
3226 /* Only set the public OK flag if the source has public OK. */
3227 if (sflags & SVf_NOK)
3228 SvFLAGS(dstr) |= SVf_NOK;
3229 SvNV_set(dstr, SvNVX(sstr));
3231 if (sflags & SVp_IOK) {
3232 (void)SvIOKp_on(dstr);
3233 if (sflags & SVf_IOK)
3234 SvFLAGS(dstr) |= SVf_IOK;
3235 if (sflags & SVf_IVisUV)
3237 SvIV_set(dstr, SvIVX(sstr));
3239 if (SvAMAGIC(sstr)) {
3243 else if (sflags & SVp_POK) {
3247 * Check to see if we can just swipe the string. If so, it's a
3248 * possible small lose on short strings, but a big win on long ones.
3249 * It might even be a win on short strings if SvPVX_const(dstr)
3250 * has to be allocated and SvPVX_const(sstr) has to be freed.
3253 /* Whichever path we take through the next code, we want this true,
3254 and doing it now facilitates the COW check. */
3255 (void)SvPOK_only(dstr);
3258 /* We're not already COW */
3259 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3260 #ifndef PERL_OLD_COPY_ON_WRITE
3261 /* or we are, but dstr isn't a suitable target. */
3262 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3267 (sflags & SVs_TEMP) && /* slated for free anyway? */
3268 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3269 (!(flags & SV_NOSTEAL)) &&
3270 /* and we're allowed to steal temps */
3271 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3272 SvLEN(sstr) && /* and really is a string */
3273 /* and won't be needed again, potentially */
3274 !(PL_op && PL_op->op_type == OP_AASSIGN))
3275 #ifdef PERL_OLD_COPY_ON_WRITE
3276 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3277 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3278 && SvTYPE(sstr) >= SVt_PVIV)
3281 /* Failed the swipe test, and it's not a shared hash key either.
3282 Have to copy the string. */
3283 STRLEN len = SvCUR(sstr);
3284 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3285 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3286 SvCUR_set(dstr, len);
3287 *SvEND(dstr) = '\0';
3289 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3291 /* Either it's a shared hash key, or it's suitable for
3292 copy-on-write or we can swipe the string. */
3294 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3298 #ifdef PERL_OLD_COPY_ON_WRITE
3300 /* I believe I should acquire a global SV mutex if
3301 it's a COW sv (not a shared hash key) to stop
3302 it going un copy-on-write.
3303 If the source SV has gone un copy on write between up there
3304 and down here, then (assert() that) it is of the correct
3305 form to make it copy on write again */
3306 if ((sflags & (SVf_FAKE | SVf_READONLY))
3307 != (SVf_FAKE | SVf_READONLY)) {
3308 SvREADONLY_on(sstr);
3310 /* Make the source SV into a loop of 1.
3311 (about to become 2) */
3312 SV_COW_NEXT_SV_SET(sstr, sstr);
3316 /* Initial code is common. */
3317 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3322 /* making another shared SV. */
3323 STRLEN cur = SvCUR(sstr);
3324 STRLEN len = SvLEN(sstr);
3325 #ifdef PERL_OLD_COPY_ON_WRITE
3327 assert (SvTYPE(dstr) >= SVt_PVIV);
3328 /* SvIsCOW_normal */
3329 /* splice us in between source and next-after-source. */
3330 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3331 SV_COW_NEXT_SV_SET(sstr, dstr);
3332 SvPV_set(dstr, SvPVX_mutable(sstr));
3336 /* SvIsCOW_shared_hash */
3337 DEBUG_C(PerlIO_printf(Perl_debug_log,
3338 "Copy on write: Sharing hash\n"));
3340 assert (SvTYPE(dstr) >= SVt_PV);
3342 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3344 SvLEN_set(dstr, len);
3345 SvCUR_set(dstr, cur);
3346 SvREADONLY_on(dstr);
3348 /* Relesase a global SV mutex. */
3351 { /* Passes the swipe test. */
3352 SvPV_set(dstr, SvPVX_mutable(sstr));
3353 SvLEN_set(dstr, SvLEN(sstr));
3354 SvCUR_set(dstr, SvCUR(sstr));
3357 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3358 SvPV_set(sstr, Nullch);
3364 if (sflags & SVf_UTF8)
3366 if (sflags & SVp_NOK) {
3368 if (sflags & SVf_NOK)
3369 SvFLAGS(dstr) |= SVf_NOK;
3370 SvNV_set(dstr, SvNVX(sstr));
3372 if (sflags & SVp_IOK) {
3373 (void)SvIOKp_on(dstr);
3374 if (sflags & SVf_IOK)
3375 SvFLAGS(dstr) |= SVf_IOK;
3376 if (sflags & SVf_IVisUV)
3378 SvIV_set(dstr, SvIVX(sstr));
3381 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3382 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3383 smg->mg_ptr, smg->mg_len);
3384 SvRMAGICAL_on(dstr);
3387 else if (sflags & SVp_IOK) {
3388 if (sflags & SVf_IOK)
3389 (void)SvIOK_only(dstr);
3391 (void)SvOK_off(dstr);
3392 (void)SvIOKp_on(dstr);
3394 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3395 if (sflags & SVf_IVisUV)
3397 SvIV_set(dstr, SvIVX(sstr));
3398 if (sflags & SVp_NOK) {
3399 if (sflags & SVf_NOK)
3400 (void)SvNOK_on(dstr);
3402 (void)SvNOKp_on(dstr);
3403 SvNV_set(dstr, SvNVX(sstr));
3406 else if (sflags & SVp_NOK) {
3407 if (sflags & SVf_NOK)
3408 (void)SvNOK_only(dstr);
3410 (void)SvOK_off(dstr);
3413 SvNV_set(dstr, SvNVX(sstr));
3416 if (dtype == SVt_PVGV) {
3417 if (ckWARN(WARN_MISC))
3418 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3421 (void)SvOK_off(dstr);
3423 if (SvTAINTED(sstr))
3428 =for apidoc sv_setsv_mg
3430 Like C<sv_setsv>, but also handles 'set' magic.
3436 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3438 sv_setsv(dstr,sstr);
3442 #ifdef PERL_OLD_COPY_ON_WRITE
3444 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3446 STRLEN cur = SvCUR(sstr);
3447 STRLEN len = SvLEN(sstr);
3448 register char *new_pv;
3451 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3459 if (SvTHINKFIRST(dstr))
3460 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3461 else if (SvPVX_const(dstr))
3462 Safefree(SvPVX_const(dstr));
3466 SvUPGRADE(dstr, SVt_PVIV);
3468 assert (SvPOK(sstr));
3469 assert (SvPOKp(sstr));
3470 assert (!SvIOK(sstr));
3471 assert (!SvIOKp(sstr));
3472 assert (!SvNOK(sstr));
3473 assert (!SvNOKp(sstr));
3475 if (SvIsCOW(sstr)) {
3477 if (SvLEN(sstr) == 0) {
3478 /* source is a COW shared hash key. */
3479 DEBUG_C(PerlIO_printf(Perl_debug_log,
3480 "Fast copy on write: Sharing hash\n"));
3481 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3484 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3486 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3487 SvUPGRADE(sstr, SVt_PVIV);
3488 SvREADONLY_on(sstr);
3490 DEBUG_C(PerlIO_printf(Perl_debug_log,
3491 "Fast copy on write: Converting sstr to COW\n"));
3492 SV_COW_NEXT_SV_SET(dstr, sstr);
3494 SV_COW_NEXT_SV_SET(sstr, dstr);
3495 new_pv = SvPVX_mutable(sstr);
3498 SvPV_set(dstr, new_pv);
3499 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3502 SvLEN_set(dstr, len);
3503 SvCUR_set(dstr, cur);
3512 =for apidoc sv_setpvn
3514 Copies a string into an SV. The C<len> parameter indicates the number of
3515 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3516 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3522 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3524 register char *dptr;
3526 SV_CHECK_THINKFIRST_COW_DROP(sv);
3532 /* len is STRLEN which is unsigned, need to copy to signed */
3535 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3537 SvUPGRADE(sv, SVt_PV);
3539 dptr = SvGROW(sv, len + 1);
3540 Move(ptr,dptr,len,char);
3543 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3548 =for apidoc sv_setpvn_mg
3550 Like C<sv_setpvn>, but also handles 'set' magic.
3556 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3558 sv_setpvn(sv,ptr,len);
3563 =for apidoc sv_setpv
3565 Copies a string into an SV. The string must be null-terminated. Does not
3566 handle 'set' magic. See C<sv_setpv_mg>.
3572 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3574 register STRLEN len;
3576 SV_CHECK_THINKFIRST_COW_DROP(sv);
3582 SvUPGRADE(sv, SVt_PV);
3584 SvGROW(sv, len + 1);
3585 Move(ptr,SvPVX(sv),len+1,char);
3587 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3592 =for apidoc sv_setpv_mg
3594 Like C<sv_setpv>, but also handles 'set' magic.
3600 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3607 =for apidoc sv_usepvn
3609 Tells an SV to use C<ptr> to find its string value. Normally the string is
3610 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3611 The C<ptr> should point to memory that was allocated by C<malloc>. The
3612 string length, C<len>, must be supplied. This function will realloc the
3613 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3614 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3615 See C<sv_usepvn_mg>.
3621 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3624 SV_CHECK_THINKFIRST_COW_DROP(sv);
3625 SvUPGRADE(sv, SVt_PV);
3630 if (SvPVX_const(sv))
3633 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3634 ptr = saferealloc (ptr, allocate);
3637 SvLEN_set(sv, allocate);
3639 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3644 =for apidoc sv_usepvn_mg
3646 Like C<sv_usepvn>, but also handles 'set' magic.
3652 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3654 sv_usepvn(sv,ptr,len);
3658 #ifdef PERL_OLD_COPY_ON_WRITE
3659 /* Need to do this *after* making the SV normal, as we need the buffer
3660 pointer to remain valid until after we've copied it. If we let go too early,
3661 another thread could invalidate it by unsharing last of the same hash key
3662 (which it can do by means other than releasing copy-on-write Svs)
3663 or by changing the other copy-on-write SVs in the loop. */
3665 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3667 if (len) { /* this SV was SvIsCOW_normal(sv) */
3668 /* we need to find the SV pointing to us. */
3669 SV * const current = SV_COW_NEXT_SV(after);
3671 if (current == sv) {
3672 /* The SV we point to points back to us (there were only two of us
3674 Hence other SV is no longer copy on write either. */
3676 SvREADONLY_off(after);
3678 /* We need to follow the pointers around the loop. */
3680 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3683 /* don't loop forever if the structure is bust, and we have
3684 a pointer into a closed loop. */
3685 assert (current != after);
3686 assert (SvPVX_const(current) == pvx);
3688 /* Make the SV before us point to the SV after us. */
3689 SV_COW_NEXT_SV_SET(current, after);
3692 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3697 Perl_sv_release_IVX(pTHX_ register SV *sv)
3700 sv_force_normal_flags(sv, 0);
3706 =for apidoc sv_force_normal_flags
3708 Undo various types of fakery on an SV: if the PV is a shared string, make
3709 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3710 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3711 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3712 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3713 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3714 set to some other value.) In addition, the C<flags> parameter gets passed to
3715 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3716 with flags set to 0.
3722 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3724 #ifdef PERL_OLD_COPY_ON_WRITE
3725 if (SvREADONLY(sv)) {
3726 /* At this point I believe I should acquire a global SV mutex. */
3728 const char * const pvx = SvPVX_const(sv);
3729 const STRLEN len = SvLEN(sv);
3730 const STRLEN cur = SvCUR(sv);
3731 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3733 PerlIO_printf(Perl_debug_log,
3734 "Copy on write: Force normal %ld\n",
3740 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3741 SvPV_set(sv, (char*)0);
3743 if (flags & SV_COW_DROP_PV) {
3744 /* OK, so we don't need to copy our buffer. */
3747 SvGROW(sv, cur + 1);
3748 Move(pvx,SvPVX(sv),cur,char);
3752 sv_release_COW(sv, pvx, len, next);
3757 else if (IN_PERL_RUNTIME)
3758 Perl_croak(aTHX_ PL_no_modify);
3759 /* At this point I believe that I can drop the global SV mutex. */
3762 if (SvREADONLY(sv)) {
3764 const char * const pvx = SvPVX_const(sv);
3765 const STRLEN len = SvCUR(sv);
3768 SvPV_set(sv, Nullch);
3770 SvGROW(sv, len + 1);
3771 Move(pvx,SvPVX(sv),len,char);
3773 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3775 else if (IN_PERL_RUNTIME)
3776 Perl_croak(aTHX_ PL_no_modify);
3780 sv_unref_flags(sv, flags);
3781 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3788 Efficient removal of characters from the beginning of the string buffer.
3789 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3790 the string buffer. The C<ptr> becomes the first character of the adjusted
3791 string. Uses the "OOK hack".
3792 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3793 refer to the same chunk of data.
3799 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3801 register STRLEN delta;
3802 if (!ptr || !SvPOKp(sv))
3804 delta = ptr - SvPVX_const(sv);
3805 SV_CHECK_THINKFIRST(sv);
3806 if (SvTYPE(sv) < SVt_PVIV)
3807 sv_upgrade(sv,SVt_PVIV);
3810 if (!SvLEN(sv)) { /* make copy of shared string */
3811 const char *pvx = SvPVX_const(sv);
3812 const STRLEN len = SvCUR(sv);
3813 SvGROW(sv, len + 1);
3814 Move(pvx,SvPVX(sv),len,char);
3818 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3819 and we do that anyway inside the SvNIOK_off
3821 SvFLAGS(sv) |= SVf_OOK;
3824 SvLEN_set(sv, SvLEN(sv) - delta);
3825 SvCUR_set(sv, SvCUR(sv) - delta);
3826 SvPV_set(sv, SvPVX(sv) + delta);
3827 SvIV_set(sv, SvIVX(sv) + delta);
3831 =for apidoc sv_catpvn
3833 Concatenates the string onto the end of the string which is in the SV. The
3834 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3835 status set, then the bytes appended should be valid UTF-8.
3836 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3838 =for apidoc sv_catpvn_flags
3840 Concatenates the string onto the end of the string which is in the SV. The
3841 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3842 status set, then the bytes appended should be valid UTF-8.
3843 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3844 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3845 in terms of this function.
3851 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3854 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3856 SvGROW(dsv, dlen + slen + 1);
3858 sstr = SvPVX_const(dsv);
3859 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3860 SvCUR_set(dsv, SvCUR(dsv) + slen);
3862 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3864 if (flags & SV_SMAGIC)
3869 =for apidoc sv_catsv
3871 Concatenates the string from SV C<ssv> onto the end of the string in
3872 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3873 not 'set' magic. See C<sv_catsv_mg>.
3875 =for apidoc sv_catsv_flags
3877 Concatenates the string from SV C<ssv> onto the end of the string in
3878 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3879 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3880 and C<sv_catsv_nomg> are implemented in terms of this function.
3885 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3889 const char *spv = SvPV_const(ssv, slen);
3891 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3892 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3893 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3894 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3895 dsv->sv_flags doesn't have that bit set.
3896 Andy Dougherty 12 Oct 2001
3898 const I32 sutf8 = DO_UTF8(ssv);
3901 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3903 dutf8 = DO_UTF8(dsv);
3905 if (dutf8 != sutf8) {
3907 /* Not modifying source SV, so taking a temporary copy. */
3908 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3910 sv_utf8_upgrade(csv);
3911 spv = SvPV_const(csv, slen);
3914 sv_utf8_upgrade_nomg(dsv);
3916 sv_catpvn_nomg(dsv, spv, slen);
3919 if (flags & SV_SMAGIC)
3924 =for apidoc sv_catpv
3926 Concatenates the string onto the end of the string which is in the SV.
3927 If the SV has the UTF-8 status set, then the bytes appended should be
3928 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3933 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3935 register STRLEN len;
3941 junk = SvPV_force(sv, tlen);
3943 SvGROW(sv, tlen + len + 1);
3945 ptr = SvPVX_const(sv);
3946 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3947 SvCUR_set(sv, SvCUR(sv) + len);
3948 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3953 =for apidoc sv_catpv_mg
3955 Like C<sv_catpv>, but also handles 'set' magic.
3961 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3970 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3971 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3978 Perl_newSV(pTHX_ STRLEN len)
3984 sv_upgrade(sv, SVt_PV);
3985 SvGROW(sv, len + 1);
3990 =for apidoc sv_magicext
3992 Adds magic to an SV, upgrading it if necessary. Applies the
3993 supplied vtable and returns a pointer to the magic added.
3995 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
3996 In particular, you can add magic to SvREADONLY SVs, and add more than
3997 one instance of the same 'how'.
3999 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4000 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4001 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4002 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4004 (This is now used as a subroutine by C<sv_magic>.)
4009 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4010 const char* name, I32 namlen)
4014 if (SvTYPE(sv) < SVt_PVMG) {
4015 SvUPGRADE(sv, SVt_PVMG);
4017 Newxz(mg, 1, MAGIC);
4018 mg->mg_moremagic = SvMAGIC(sv);
4019 SvMAGIC_set(sv, mg);
4021 /* Sometimes a magic contains a reference loop, where the sv and
4022 object refer to each other. To prevent a reference loop that
4023 would prevent such objects being freed, we look for such loops
4024 and if we find one we avoid incrementing the object refcount.
4026 Note we cannot do this to avoid self-tie loops as intervening RV must
4027 have its REFCNT incremented to keep it in existence.
4030 if (!obj || obj == sv ||
4031 how == PERL_MAGIC_arylen ||
4032 how == PERL_MAGIC_qr ||
4033 how == PERL_MAGIC_symtab ||
4034 (SvTYPE(obj) == SVt_PVGV &&
4035 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4036 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4037 GvFORM(obj) == (CV*)sv)))
4042 mg->mg_obj = SvREFCNT_inc(obj);
4043 mg->mg_flags |= MGf_REFCOUNTED;
4046 /* Normal self-ties simply pass a null object, and instead of
4047 using mg_obj directly, use the SvTIED_obj macro to produce a
4048 new RV as needed. For glob "self-ties", we are tieing the PVIO
4049 with an RV obj pointing to the glob containing the PVIO. In
4050 this case, to avoid a reference loop, we need to weaken the
4054 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4055 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4061 mg->mg_len = namlen;
4064 mg->mg_ptr = savepvn(name, namlen);
4065 else if (namlen == HEf_SVKEY)
4066 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4068 mg->mg_ptr = (char *) name;
4070 mg->mg_virtual = vtable;
4074 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4079 =for apidoc sv_magic
4081 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4082 then adds a new magic item of type C<how> to the head of the magic list.
4084 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4085 handling of the C<name> and C<namlen> arguments.
4087 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4088 to add more than one instance of the same 'how'.
4094 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4096 const MGVTBL *vtable;
4099 #ifdef PERL_OLD_COPY_ON_WRITE
4101 sv_force_normal_flags(sv, 0);
4103 if (SvREADONLY(sv)) {
4105 /* its okay to attach magic to shared strings; the subsequent
4106 * upgrade to PVMG will unshare the string */
4107 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4110 && how != PERL_MAGIC_regex_global
4111 && how != PERL_MAGIC_bm
4112 && how != PERL_MAGIC_fm
4113 && how != PERL_MAGIC_sv
4114 && how != PERL_MAGIC_backref
4117 Perl_croak(aTHX_ PL_no_modify);
4120 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4121 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4122 /* sv_magic() refuses to add a magic of the same 'how' as an
4125 if (how == PERL_MAGIC_taint)
4133 vtable = &PL_vtbl_sv;
4135 case PERL_MAGIC_overload:
4136 vtable = &PL_vtbl_amagic;
4138 case PERL_MAGIC_overload_elem:
4139 vtable = &PL_vtbl_amagicelem;
4141 case PERL_MAGIC_overload_table:
4142 vtable = &PL_vtbl_ovrld;
4145 vtable = &PL_vtbl_bm;
4147 case PERL_MAGIC_regdata:
4148 vtable = &PL_vtbl_regdata;
4150 case PERL_MAGIC_regdatum:
4151 vtable = &PL_vtbl_regdatum;
4153 case PERL_MAGIC_env:
4154 vtable = &PL_vtbl_env;
4157 vtable = &PL_vtbl_fm;
4159 case PERL_MAGIC_envelem:
4160 vtable = &PL_vtbl_envelem;
4162 case PERL_MAGIC_regex_global:
4163 vtable = &PL_vtbl_mglob;
4165 case PERL_MAGIC_isa:
4166 vtable = &PL_vtbl_isa;
4168 case PERL_MAGIC_isaelem:
4169 vtable = &PL_vtbl_isaelem;
4171 case PERL_MAGIC_nkeys:
4172 vtable = &PL_vtbl_nkeys;
4174 case PERL_MAGIC_dbfile:
4177 case PERL_MAGIC_dbline:
4178 vtable = &PL_vtbl_dbline;
4180 #ifdef USE_LOCALE_COLLATE
4181 case PERL_MAGIC_collxfrm:
4182 vtable = &PL_vtbl_collxfrm;
4184 #endif /* USE_LOCALE_COLLATE */
4185 case PERL_MAGIC_tied:
4186 vtable = &PL_vtbl_pack;
4188 case PERL_MAGIC_tiedelem:
4189 case PERL_MAGIC_tiedscalar:
4190 vtable = &PL_vtbl_packelem;
4193 vtable = &PL_vtbl_regexp;
4195 case PERL_MAGIC_sig:
4196 vtable = &PL_vtbl_sig;
4198 case PERL_MAGIC_sigelem:
4199 vtable = &PL_vtbl_sigelem;
4201 case PERL_MAGIC_taint:
4202 vtable = &PL_vtbl_taint;
4204 case PERL_MAGIC_uvar:
4205 vtable = &PL_vtbl_uvar;
4207 case PERL_MAGIC_vec:
4208 vtable = &PL_vtbl_vec;
4210 case PERL_MAGIC_arylen_p:
4211 case PERL_MAGIC_rhash:
4212 case PERL_MAGIC_symtab:
4213 case PERL_MAGIC_vstring:
4216 case PERL_MAGIC_utf8:
4217 vtable = &PL_vtbl_utf8;
4219 case PERL_MAGIC_substr:
4220 vtable = &PL_vtbl_substr;
4222 case PERL_MAGIC_defelem:
4223 vtable = &PL_vtbl_defelem;
4225 case PERL_MAGIC_glob:
4226 vtable = &PL_vtbl_glob;
4228 case PERL_MAGIC_arylen:
4229 vtable = &PL_vtbl_arylen;
4231 case PERL_MAGIC_pos:
4232 vtable = &PL_vtbl_pos;
4234 case PERL_MAGIC_backref:
4235 vtable = &PL_vtbl_backref;
4237 case PERL_MAGIC_ext:
4238 /* Reserved for use by extensions not perl internals. */
4239 /* Useful for attaching extension internal data to perl vars. */
4240 /* Note that multiple extensions may clash if magical scalars */
4241 /* etc holding private data from one are passed to another. */
4245 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4248 /* Rest of work is done else where */
4249 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4252 case PERL_MAGIC_taint:
4255 case PERL_MAGIC_ext:
4256 case PERL_MAGIC_dbfile:
4263 =for apidoc sv_unmagic
4265 Removes all magic of type C<type> from an SV.
4271 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4275 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4278 for (mg = *mgp; mg; mg = *mgp) {
4279 if (mg->mg_type == type) {
4280 const MGVTBL* const vtbl = mg->mg_virtual;
4281 *mgp = mg->mg_moremagic;
4282 if (vtbl && vtbl->svt_free)
4283 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4284 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4286 Safefree(mg->mg_ptr);
4287 else if (mg->mg_len == HEf_SVKEY)
4288 SvREFCNT_dec((SV*)mg->mg_ptr);
4289 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4290 Safefree(mg->mg_ptr);
4292 if (mg->mg_flags & MGf_REFCOUNTED)
4293 SvREFCNT_dec(mg->mg_obj);
4297 mgp = &mg->mg_moremagic;
4301 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4308 =for apidoc sv_rvweaken
4310 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4311 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4312 push a back-reference to this RV onto the array of backreferences
4313 associated with that magic.
4319 Perl_sv_rvweaken(pTHX_ SV *sv)
4322 if (!SvOK(sv)) /* let undefs pass */
4325 Perl_croak(aTHX_ "Can't weaken a nonreference");
4326 else if (SvWEAKREF(sv)) {
4327 if (ckWARN(WARN_MISC))
4328 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4332 Perl_sv_add_backref(aTHX_ tsv, sv);
4338 /* Give tsv backref magic if it hasn't already got it, then push a
4339 * back-reference to sv onto the array associated with the backref magic.
4343 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4347 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4348 av = (AV*)mg->mg_obj;
4351 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4352 /* av now has a refcnt of 2, which avoids it getting freed
4353 * before us during global cleanup. The extra ref is removed
4354 * by magic_killbackrefs() when tsv is being freed */
4356 if (AvFILLp(av) >= AvMAX(av)) {
4357 av_extend(av, AvFILLp(av)+1);
4359 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4362 /* delete a back-reference to ourselves from the backref magic associated
4363 * with the SV we point to.
4367 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4373 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4374 if (PL_in_clean_all)
4377 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4378 Perl_croak(aTHX_ "panic: del_backref");
4379 av = (AV *)mg->mg_obj;
4381 /* We shouldn't be in here more than once, but for paranoia reasons lets
4383 for (i = AvFILLp(av); i >= 0; i--) {
4385 const SSize_t fill = AvFILLp(av);
4387 /* We weren't the last entry.
4388 An unordered list has this property that you can take the
4389 last element off the end to fill the hole, and it's still
4390 an unordered list :-)
4395 AvFILLp(av) = fill - 1;
4401 =for apidoc sv_insert
4403 Inserts a string at the specified offset/length within the SV. Similar to
4404 the Perl substr() function.
4410 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4414 register char *midend;
4415 register char *bigend;
4421 Perl_croak(aTHX_ "Can't modify non-existent substring");
4422 SvPV_force(bigstr, curlen);
4423 (void)SvPOK_only_UTF8(bigstr);
4424 if (offset + len > curlen) {
4425 SvGROW(bigstr, offset+len+1);
4426 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4427 SvCUR_set(bigstr, offset+len);
4431 i = littlelen - len;
4432 if (i > 0) { /* string might grow */
4433 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4434 mid = big + offset + len;
4435 midend = bigend = big + SvCUR(bigstr);
4438 while (midend > mid) /* shove everything down */
4439 *--bigend = *--midend;
4440 Move(little,big+offset,littlelen,char);
4441 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4446 Move(little,SvPVX(bigstr)+offset,len,char);
4451 big = SvPVX(bigstr);
4454 bigend = big + SvCUR(bigstr);
4456 if (midend > bigend)
4457 Perl_croak(aTHX_ "panic: sv_insert");
4459 if (mid - big > bigend - midend) { /* faster to shorten from end */
4461 Move(little, mid, littlelen,char);
4464 i = bigend - midend;
4466 Move(midend, mid, i,char);
4470 SvCUR_set(bigstr, mid - big);
4472 else if ((i = mid - big)) { /* faster from front */
4473 midend -= littlelen;
4475 sv_chop(bigstr,midend-i);
4480 Move(little, mid, littlelen,char);
4482 else if (littlelen) {
4483 midend -= littlelen;
4484 sv_chop(bigstr,midend);
4485 Move(little,midend,littlelen,char);
4488 sv_chop(bigstr,midend);
4494 =for apidoc sv_replace
4496 Make the first argument a copy of the second, then delete the original.
4497 The target SV physically takes over ownership of the body of the source SV
4498 and inherits its flags; however, the target keeps any magic it owns,
4499 and any magic in the source is discarded.
4500 Note that this is a rather specialist SV copying operation; most of the
4501 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4507 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4509 const U32 refcnt = SvREFCNT(sv);
4510 SV_CHECK_THINKFIRST_COW_DROP(sv);
4511 if (SvREFCNT(nsv) != 1) {
4512 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4513 UVuf " != 1)", (UV) SvREFCNT(nsv));
4515 if (SvMAGICAL(sv)) {
4519 sv_upgrade(nsv, SVt_PVMG);
4520 SvMAGIC_set(nsv, SvMAGIC(sv));
4521 SvFLAGS(nsv) |= SvMAGICAL(sv);
4523 SvMAGIC_set(sv, NULL);
4527 assert(!SvREFCNT(sv));
4528 #ifdef DEBUG_LEAKING_SCALARS
4529 sv->sv_flags = nsv->sv_flags;
4530 sv->sv_any = nsv->sv_any;
4531 sv->sv_refcnt = nsv->sv_refcnt;
4532 sv->sv_u = nsv->sv_u;
4534 StructCopy(nsv,sv,SV);
4536 /* Currently could join these into one piece of pointer arithmetic, but
4537 it would be unclear. */
4538 if(SvTYPE(sv) == SVt_IV)
4540 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4541 else if (SvTYPE(sv) == SVt_RV) {
4542 SvANY(sv) = &sv->sv_u.svu_rv;
4546 #ifdef PERL_OLD_COPY_ON_WRITE
4547 if (SvIsCOW_normal(nsv)) {
4548 /* We need to follow the pointers around the loop to make the
4549 previous SV point to sv, rather than nsv. */
4552 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4555 assert(SvPVX_const(current) == SvPVX_const(nsv));
4557 /* Make the SV before us point to the SV after us. */
4559 PerlIO_printf(Perl_debug_log, "previous is\n");
4561 PerlIO_printf(Perl_debug_log,
4562 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4563 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4565 SV_COW_NEXT_SV_SET(current, sv);
4568 SvREFCNT(sv) = refcnt;
4569 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4575 =for apidoc sv_clear
4577 Clear an SV: call any destructors, free up any memory used by the body,
4578 and free the body itself. The SV's head is I<not> freed, although
4579 its type is set to all 1's so that it won't inadvertently be assumed
4580 to be live during global destruction etc.
4581 This function should only be called when REFCNT is zero. Most of the time
4582 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4589 Perl_sv_clear(pTHX_ register SV *sv)
4592 const U32 type = SvTYPE(sv);
4593 const struct body_details *const sv_type_details
4594 = bodies_by_type + type;
4597 assert(SvREFCNT(sv) == 0);
4603 if (PL_defstash) { /* Still have a symbol table? */
4608 stash = SvSTASH(sv);
4609 destructor = StashHANDLER(stash,DESTROY);
4611 SV* const tmpref = newRV(sv);
4612 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4614 PUSHSTACKi(PERLSI_DESTROY);
4619 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4625 if(SvREFCNT(tmpref) < 2) {
4626 /* tmpref is not kept alive! */
4628 SvRV_set(tmpref, NULL);
4631 SvREFCNT_dec(tmpref);
4633 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4637 if (PL_in_clean_objs)
4638 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4640 /* DESTROY gave object new lease on life */
4646 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4647 SvOBJECT_off(sv); /* Curse the object. */
4648 if (type != SVt_PVIO)
4649 --PL_sv_objcount; /* XXX Might want something more general */
4652 if (type >= SVt_PVMG) {
4655 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4656 SvREFCNT_dec(SvSTASH(sv));
4661 IoIFP(sv) != PerlIO_stdin() &&
4662 IoIFP(sv) != PerlIO_stdout() &&
4663 IoIFP(sv) != PerlIO_stderr())
4665 io_close((IO*)sv, FALSE);
4667 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4668 PerlDir_close(IoDIRP(sv));
4669 IoDIRP(sv) = (DIR*)NULL;
4670 Safefree(IoTOP_NAME(sv));
4671 Safefree(IoFMT_NAME(sv));
4672 Safefree(IoBOTTOM_NAME(sv));
4687 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4688 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4689 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4690 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4692 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4693 SvREFCNT_dec(LvTARG(sv));
4697 Safefree(GvNAME(sv));
4698 /* If we're in a stash, we don't own a reference to it. However it does
4699 have a back reference to us, which needs to be cleared. */
4701 sv_del_backref((SV*)GvSTASH(sv), sv);
4706 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4708 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4709 /* Don't even bother with turning off the OOK flag. */
4714 SV *target = SvRV(sv);
4716 sv_del_backref(target, sv);
4718 SvREFCNT_dec(target);
4720 #ifdef PERL_OLD_COPY_ON_WRITE
4721 else if (SvPVX_const(sv)) {
4723 /* I believe I need to grab the global SV mutex here and
4724 then recheck the COW status. */
4726 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4729 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4730 SV_COW_NEXT_SV(sv));
4731 /* And drop it here. */
4733 } else if (SvLEN(sv)) {
4734 Safefree(SvPVX_const(sv));
4738 else if (SvPVX_const(sv) && SvLEN(sv))
4739 Safefree(SvPVX_mutable(sv));
4740 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4741 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4750 SvFLAGS(sv) &= SVf_BREAK;
4751 SvFLAGS(sv) |= SVTYPEMASK;
4753 if (sv_type_details->arena) {
4754 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4755 &PL_body_roots[type]);
4757 else if (sv_type_details->size) {
4758 my_safefree(SvANY(sv));
4763 =for apidoc sv_newref
4765 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4772 Perl_sv_newref(pTHX_ SV *sv)
4782 Decrement an SV's reference count, and if it drops to zero, call
4783 C<sv_clear> to invoke destructors and free up any memory used by
4784 the body; finally, deallocate the SV's head itself.
4785 Normally called via a wrapper macro C<SvREFCNT_dec>.
4791 Perl_sv_free(pTHX_ SV *sv)
4796 if (SvREFCNT(sv) == 0) {
4797 if (SvFLAGS(sv) & SVf_BREAK)
4798 /* this SV's refcnt has been artificially decremented to
4799 * trigger cleanup */
4801 if (PL_in_clean_all) /* All is fair */
4803 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4804 /* make sure SvREFCNT(sv)==0 happens very seldom */
4805 SvREFCNT(sv) = (~(U32)0)/2;
4808 if (ckWARN_d(WARN_INTERNAL)) {
4809 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4810 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4811 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4812 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4813 Perl_dump_sv_child(aTHX_ sv);
4818 if (--(SvREFCNT(sv)) > 0)
4820 Perl_sv_free2(aTHX_ sv);
4824 Perl_sv_free2(pTHX_ SV *sv)
4829 if (ckWARN_d(WARN_DEBUGGING))
4830 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4831 "Attempt to free temp prematurely: SV 0x%"UVxf
4832 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4836 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4837 /* make sure SvREFCNT(sv)==0 happens very seldom */
4838 SvREFCNT(sv) = (~(U32)0)/2;
4849 Returns the length of the string in the SV. Handles magic and type
4850 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4856 Perl_sv_len(pTHX_ register SV *sv)
4864 len = mg_length(sv);
4866 (void)SvPV_const(sv, len);
4871 =for apidoc sv_len_utf8
4873 Returns the number of characters in the string in an SV, counting wide
4874 UTF-8 bytes as a single character. Handles magic and type coercion.
4880 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4881 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4882 * (Note that the mg_len is not the length of the mg_ptr field.)
4887 Perl_sv_len_utf8(pTHX_ register SV *sv)
4893 return mg_length(sv);
4897 const U8 *s = (U8*)SvPV_const(sv, len);
4898 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4900 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4902 #ifdef PERL_UTF8_CACHE_ASSERT
4903 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4907 ulen = Perl_utf8_length(aTHX_ s, s + len);
4908 if (!mg && !SvREADONLY(sv)) {
4909 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4910 mg = mg_find(sv, PERL_MAGIC_utf8);
4920 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4921 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4922 * between UTF-8 and byte offsets. There are two (substr offset and substr
4923 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4924 * and byte offset) cache positions.
4926 * The mg_len field is used by sv_len_utf8(), see its comments.
4927 * Note that the mg_len is not the length of the mg_ptr field.
4931 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4932 I32 offsetp, const U8 *s, const U8 *start)
4936 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4938 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4942 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4944 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4945 (*mgp)->mg_ptr = (char *) *cachep;
4949 (*cachep)[i] = offsetp;
4950 (*cachep)[i+1] = s - start;
4958 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4959 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4960 * between UTF-8 and byte offsets. See also the comments of
4961 * S_utf8_mg_pos_init().
4965 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)
4969 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4971 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4972 if (*mgp && (*mgp)->mg_ptr) {
4973 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4974 ASSERT_UTF8_CACHE(*cachep);
4975 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4977 else { /* We will skip to the right spot. */
4982 /* The assumption is that going backward is half
4983 * the speed of going forward (that's where the
4984 * 2 * backw in the below comes from). (The real
4985 * figure of course depends on the UTF-8 data.) */
4987 if ((*cachep)[i] > (STRLEN)uoff) {
4989 backw = (*cachep)[i] - (STRLEN)uoff;
4991 if (forw < 2 * backw)
4994 p = start + (*cachep)[i+1];
4996 /* Try this only for the substr offset (i == 0),
4997 * not for the substr length (i == 2). */
4998 else if (i == 0) { /* (*cachep)[i] < uoff */
4999 const STRLEN ulen = sv_len_utf8(sv);
5001 if ((STRLEN)uoff < ulen) {
5002 forw = (STRLEN)uoff - (*cachep)[i];
5003 backw = ulen - (STRLEN)uoff;
5005 if (forw < 2 * backw)
5006 p = start + (*cachep)[i+1];
5011 /* If the string is not long enough for uoff,
5012 * we could extend it, but not at this low a level. */
5016 if (forw < 2 * backw) {
5023 while (UTF8_IS_CONTINUATION(*p))
5028 /* Update the cache. */
5029 (*cachep)[i] = (STRLEN)uoff;
5030 (*cachep)[i+1] = p - start;
5032 /* Drop the stale "length" cache */
5041 if (found) { /* Setup the return values. */
5042 *offsetp = (*cachep)[i+1];
5043 *sp = start + *offsetp;
5046 *offsetp = send - start;
5048 else if (*sp < start) {
5054 #ifdef PERL_UTF8_CACHE_ASSERT
5059 while (n-- && s < send)
5063 assert(*offsetp == s - start);
5064 assert((*cachep)[0] == (STRLEN)uoff);
5065 assert((*cachep)[1] == *offsetp);
5067 ASSERT_UTF8_CACHE(*cachep);
5076 =for apidoc sv_pos_u2b
5078 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5079 the start of the string, to a count of the equivalent number of bytes; if
5080 lenp is non-zero, it does the same to lenp, but this time starting from
5081 the offset, rather than from the start of the string. Handles magic and
5088 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5089 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5090 * byte offsets. See also the comments of S_utf8_mg_pos().
5095 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5103 start = (U8*)SvPV_const(sv, len);
5107 const U8 *s = start;
5108 I32 uoffset = *offsetp;
5109 const U8 * const send = s + len;
5113 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5115 if (!found && uoffset > 0) {
5116 while (s < send && uoffset--)
5120 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5122 *offsetp = s - start;
5127 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5131 if (!found && *lenp > 0) {
5134 while (s < send && ulen--)
5138 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5142 ASSERT_UTF8_CACHE(cache);
5154 =for apidoc sv_pos_b2u
5156 Converts the value pointed to by offsetp from a count of bytes from the
5157 start of the string, to a count of the equivalent number of UTF-8 chars.
5158 Handles magic and type coercion.
5164 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5165 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5166 * byte offsets. See also the comments of S_utf8_mg_pos().
5171 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5179 s = (const U8*)SvPV_const(sv, len);
5180 if ((I32)len < *offsetp)
5181 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5183 const U8* send = s + *offsetp;
5185 STRLEN *cache = NULL;
5189 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5190 mg = mg_find(sv, PERL_MAGIC_utf8);
5191 if (mg && mg->mg_ptr) {
5192 cache = (STRLEN *) mg->mg_ptr;
5193 if (cache[1] == (STRLEN)*offsetp) {
5194 /* An exact match. */
5195 *offsetp = cache[0];
5199 else if (cache[1] < (STRLEN)*offsetp) {
5200 /* We already know part of the way. */
5203 /* Let the below loop do the rest. */
5205 else { /* cache[1] > *offsetp */
5206 /* We already know all of the way, now we may
5207 * be able to walk back. The same assumption
5208 * is made as in S_utf8_mg_pos(), namely that
5209 * walking backward is twice slower than
5210 * walking forward. */
5211 const STRLEN forw = *offsetp;
5212 STRLEN backw = cache[1] - *offsetp;
5214 if (!(forw < 2 * backw)) {
5215 const U8 *p = s + cache[1];
5222 while (UTF8_IS_CONTINUATION(*p)) {
5230 *offsetp = cache[0];
5232 /* Drop the stale "length" cache */
5240 ASSERT_UTF8_CACHE(cache);
5246 /* Call utf8n_to_uvchr() to validate the sequence
5247 * (unless a simple non-UTF character) */
5248 if (!UTF8_IS_INVARIANT(*s))
5249 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5258 if (!SvREADONLY(sv)) {
5260 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5261 mg = mg_find(sv, PERL_MAGIC_utf8);
5266 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5267 mg->mg_ptr = (char *) cache;
5272 cache[1] = *offsetp;
5273 /* Drop the stale "length" cache */
5286 Returns a boolean indicating whether the strings in the two SVs are
5287 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5288 coerce its args to strings if necessary.
5294 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5302 SV* svrecode = Nullsv;
5309 pv1 = SvPV_const(sv1, cur1);
5316 pv2 = SvPV_const(sv2, cur2);
5318 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5319 /* Differing utf8ness.
5320 * Do not UTF8size the comparands as a side-effect. */
5323 svrecode = newSVpvn(pv2, cur2);
5324 sv_recode_to_utf8(svrecode, PL_encoding);
5325 pv2 = SvPV_const(svrecode, cur2);
5328 svrecode = newSVpvn(pv1, cur1);
5329 sv_recode_to_utf8(svrecode, PL_encoding);
5330 pv1 = SvPV_const(svrecode, cur1);
5332 /* Now both are in UTF-8. */
5334 SvREFCNT_dec(svrecode);
5339 bool is_utf8 = TRUE;
5342 /* sv1 is the UTF-8 one,
5343 * if is equal it must be downgrade-able */
5344 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5350 /* sv2 is the UTF-8 one,
5351 * if is equal it must be downgrade-able */
5352 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5358 /* Downgrade not possible - cannot be eq */
5366 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5369 SvREFCNT_dec(svrecode);
5380 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5381 string in C<sv1> is less than, equal to, or greater than the string in
5382 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5383 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5389 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5392 const char *pv1, *pv2;
5395 SV *svrecode = Nullsv;
5402 pv1 = SvPV_const(sv1, cur1);
5409 pv2 = SvPV_const(sv2, cur2);
5411 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5412 /* Differing utf8ness.
5413 * Do not UTF8size the comparands as a side-effect. */
5416 svrecode = newSVpvn(pv2, cur2);
5417 sv_recode_to_utf8(svrecode, PL_encoding);
5418 pv2 = SvPV_const(svrecode, cur2);
5421 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5426 svrecode = newSVpvn(pv1, cur1);
5427 sv_recode_to_utf8(svrecode, PL_encoding);
5428 pv1 = SvPV_const(svrecode, cur1);
5431 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5437 cmp = cur2 ? -1 : 0;
5441 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5444 cmp = retval < 0 ? -1 : 1;
5445 } else if (cur1 == cur2) {
5448 cmp = cur1 < cur2 ? -1 : 1;
5453 SvREFCNT_dec(svrecode);
5462 =for apidoc sv_cmp_locale
5464 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5465 'use bytes' aware, handles get magic, and will coerce its args to strings
5466 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5472 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5474 #ifdef USE_LOCALE_COLLATE
5480 if (PL_collation_standard)
5484 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5486 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5488 if (!pv1 || !len1) {
5499 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5502 return retval < 0 ? -1 : 1;
5505 * When the result of collation is equality, that doesn't mean
5506 * that there are no differences -- some locales exclude some
5507 * characters from consideration. So to avoid false equalities,
5508 * we use the raw string as a tiebreaker.
5514 #endif /* USE_LOCALE_COLLATE */
5516 return sv_cmp(sv1, sv2);
5520 #ifdef USE_LOCALE_COLLATE
5523 =for apidoc sv_collxfrm
5525 Add Collate Transform magic to an SV if it doesn't already have it.
5527 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5528 scalar data of the variable, but transformed to such a format that a normal
5529 memory comparison can be used to compare the data according to the locale
5536 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5540 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5541 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5547 Safefree(mg->mg_ptr);
5548 s = SvPV_const(sv, len);
5549 if ((xf = mem_collxfrm(s, len, &xlen))) {
5550 if (SvREADONLY(sv)) {
5553 return xf + sizeof(PL_collation_ix);
5556 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5557 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5570 if (mg && mg->mg_ptr) {
5572 return mg->mg_ptr + sizeof(PL_collation_ix);
5580 #endif /* USE_LOCALE_COLLATE */
5585 Get a line from the filehandle and store it into the SV, optionally
5586 appending to the currently-stored string.
5592 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5596 register STDCHAR rslast;
5597 register STDCHAR *bp;
5603 if (SvTHINKFIRST(sv))
5604 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5605 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5607 However, perlbench says it's slower, because the existing swipe code
5608 is faster than copy on write.
5609 Swings and roundabouts. */
5610 SvUPGRADE(sv, SVt_PV);
5615 if (PerlIO_isutf8(fp)) {
5617 sv_utf8_upgrade_nomg(sv);
5618 sv_pos_u2b(sv,&append,0);
5620 } else if (SvUTF8(sv)) {
5621 SV * const tsv = NEWSV(0,0);
5622 sv_gets(tsv, fp, 0);
5623 sv_utf8_upgrade_nomg(tsv);
5624 SvCUR_set(sv,append);
5627 goto return_string_or_null;
5632 if (PerlIO_isutf8(fp))
5635 if (IN_PERL_COMPILETIME) {
5636 /* we always read code in line mode */
5640 else if (RsSNARF(PL_rs)) {
5641 /* If it is a regular disk file use size from stat() as estimate
5642 of amount we are going to read - may result in malloc-ing
5643 more memory than we realy need if layers bellow reduce
5644 size we read (e.g. CRLF or a gzip layer)
5647 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5648 const Off_t offset = PerlIO_tell(fp);
5649 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5650 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5656 else if (RsRECORD(PL_rs)) {
5660 /* Grab the size of the record we're getting */
5661 recsize = SvIV(SvRV(PL_rs));
5662 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5665 /* VMS wants read instead of fread, because fread doesn't respect */
5666 /* RMS record boundaries. This is not necessarily a good thing to be */
5667 /* doing, but we've got no other real choice - except avoid stdio
5668 as implementation - perhaps write a :vms layer ?
5670 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5672 bytesread = PerlIO_read(fp, buffer, recsize);
5676 SvCUR_set(sv, bytesread += append);
5677 buffer[bytesread] = '\0';
5678 goto return_string_or_null;
5680 else if (RsPARA(PL_rs)) {
5686 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5687 if (PerlIO_isutf8(fp)) {
5688 rsptr = SvPVutf8(PL_rs, rslen);
5691 if (SvUTF8(PL_rs)) {
5692 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5693 Perl_croak(aTHX_ "Wide character in $/");
5696 rsptr = SvPV_const(PL_rs, rslen);
5700 rslast = rslen ? rsptr[rslen - 1] : '\0';
5702 if (rspara) { /* have to do this both before and after */
5703 do { /* to make sure file boundaries work right */
5706 i = PerlIO_getc(fp);
5710 PerlIO_ungetc(fp,i);
5716 /* See if we know enough about I/O mechanism to cheat it ! */
5718 /* This used to be #ifdef test - it is made run-time test for ease
5719 of abstracting out stdio interface. One call should be cheap
5720 enough here - and may even be a macro allowing compile
5724 if (PerlIO_fast_gets(fp)) {
5727 * We're going to steal some values from the stdio struct
5728 * and put EVERYTHING in the innermost loop into registers.
5730 register STDCHAR *ptr;
5734 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5735 /* An ungetc()d char is handled separately from the regular
5736 * buffer, so we getc() it back out and stuff it in the buffer.
5738 i = PerlIO_getc(fp);
5739 if (i == EOF) return 0;
5740 *(--((*fp)->_ptr)) = (unsigned char) i;
5744 /* Here is some breathtakingly efficient cheating */
5746 cnt = PerlIO_get_cnt(fp); /* get count into register */
5747 /* make sure we have the room */
5748 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5749 /* Not room for all of it
5750 if we are looking for a separator and room for some
5752 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5753 /* just process what we have room for */
5754 shortbuffered = cnt - SvLEN(sv) + append + 1;
5755 cnt -= shortbuffered;
5759 /* remember that cnt can be negative */
5760 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5765 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5766 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5767 DEBUG_P(PerlIO_printf(Perl_debug_log,
5768 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5769 DEBUG_P(PerlIO_printf(Perl_debug_log,
5770 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5771 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5772 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5777 while (cnt > 0) { /* this | eat */
5779 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5780 goto thats_all_folks; /* screams | sed :-) */
5784 Copy(ptr, bp, cnt, char); /* this | eat */
5785 bp += cnt; /* screams | dust */
5786 ptr += cnt; /* louder | sed :-) */
5791 if (shortbuffered) { /* oh well, must extend */
5792 cnt = shortbuffered;
5794 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5796 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5797 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5801 DEBUG_P(PerlIO_printf(Perl_debug_log,
5802 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5803 PTR2UV(ptr),(long)cnt));
5804 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5806 DEBUG_P(PerlIO_printf(Perl_debug_log,
5807 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5808 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5809 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5811 /* This used to call 'filbuf' in stdio form, but as that behaves like
5812 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5813 another abstraction. */
5814 i = PerlIO_getc(fp); /* get more characters */
5816 DEBUG_P(PerlIO_printf(Perl_debug_log,
5817 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5818 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5819 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5821 cnt = PerlIO_get_cnt(fp);
5822 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5823 DEBUG_P(PerlIO_printf(Perl_debug_log,
5824 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5826 if (i == EOF) /* all done for ever? */
5827 goto thats_really_all_folks;
5829 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5831 SvGROW(sv, bpx + cnt + 2);
5832 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5834 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5836 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5837 goto thats_all_folks;
5841 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5842 memNE((char*)bp - rslen, rsptr, rslen))
5843 goto screamer; /* go back to the fray */
5844 thats_really_all_folks:
5846 cnt += shortbuffered;
5847 DEBUG_P(PerlIO_printf(Perl_debug_log,
5848 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5849 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5850 DEBUG_P(PerlIO_printf(Perl_debug_log,
5851 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5852 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5853 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5855 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5856 DEBUG_P(PerlIO_printf(Perl_debug_log,
5857 "Screamer: done, len=%ld, string=|%.*s|\n",
5858 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5862 /*The big, slow, and stupid way. */
5863 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5865 Newx(buf, 8192, STDCHAR);
5873 register const STDCHAR * const bpe = buf + sizeof(buf);
5875 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5876 ; /* keep reading */
5880 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5881 /* Accomodate broken VAXC compiler, which applies U8 cast to
5882 * both args of ?: operator, causing EOF to change into 255
5885 i = (U8)buf[cnt - 1];
5891 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5893 sv_catpvn(sv, (char *) buf, cnt);
5895 sv_setpvn(sv, (char *) buf, cnt);
5897 if (i != EOF && /* joy */
5899 SvCUR(sv) < rslen ||
5900 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5904 * If we're reading from a TTY and we get a short read,
5905 * indicating that the user hit his EOF character, we need
5906 * to notice it now, because if we try to read from the TTY
5907 * again, the EOF condition will disappear.
5909 * The comparison of cnt to sizeof(buf) is an optimization
5910 * that prevents unnecessary calls to feof().
5914 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5918 #ifdef USE_HEAP_INSTEAD_OF_STACK
5923 if (rspara) { /* have to do this both before and after */
5924 while (i != EOF) { /* to make sure file boundaries work right */
5925 i = PerlIO_getc(fp);
5927 PerlIO_ungetc(fp,i);
5933 return_string_or_null:
5934 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5940 Auto-increment of the value in the SV, doing string to numeric conversion
5941 if necessary. Handles 'get' magic.
5947 Perl_sv_inc(pTHX_ register SV *sv)
5955 if (SvTHINKFIRST(sv)) {
5957 sv_force_normal_flags(sv, 0);
5958 if (SvREADONLY(sv)) {
5959 if (IN_PERL_RUNTIME)
5960 Perl_croak(aTHX_ PL_no_modify);
5964 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5966 i = PTR2IV(SvRV(sv));
5971 flags = SvFLAGS(sv);
5972 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5973 /* It's (privately or publicly) a float, but not tested as an
5974 integer, so test it to see. */
5976 flags = SvFLAGS(sv);
5978 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5979 /* It's publicly an integer, or privately an integer-not-float */
5980 #ifdef PERL_PRESERVE_IVUV
5984 if (SvUVX(sv) == UV_MAX)
5985 sv_setnv(sv, UV_MAX_P1);
5987 (void)SvIOK_only_UV(sv);
5988 SvUV_set(sv, SvUVX(sv) + 1);
5990 if (SvIVX(sv) == IV_MAX)
5991 sv_setuv(sv, (UV)IV_MAX + 1);
5993 (void)SvIOK_only(sv);
5994 SvIV_set(sv, SvIVX(sv) + 1);
5999 if (flags & SVp_NOK) {
6000 (void)SvNOK_only(sv);
6001 SvNV_set(sv, SvNVX(sv) + 1.0);
6005 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6006 if ((flags & SVTYPEMASK) < SVt_PVIV)
6007 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6008 (void)SvIOK_only(sv);
6013 while (isALPHA(*d)) d++;
6014 while (isDIGIT(*d)) d++;
6016 #ifdef PERL_PRESERVE_IVUV
6017 /* Got to punt this as an integer if needs be, but we don't issue
6018 warnings. Probably ought to make the sv_iv_please() that does
6019 the conversion if possible, and silently. */
6020 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6021 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6022 /* Need to try really hard to see if it's an integer.
6023 9.22337203685478e+18 is an integer.
6024 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6025 so $a="9.22337203685478e+18"; $a+0; $a++
6026 needs to be the same as $a="9.22337203685478e+18"; $a++
6033 /* sv_2iv *should* have made this an NV */
6034 if (flags & SVp_NOK) {
6035 (void)SvNOK_only(sv);
6036 SvNV_set(sv, SvNVX(sv) + 1.0);
6039 /* I don't think we can get here. Maybe I should assert this
6040 And if we do get here I suspect that sv_setnv will croak. NWC
6042 #if defined(USE_LONG_DOUBLE)
6043 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",
6044 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6046 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6047 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6050 #endif /* PERL_PRESERVE_IVUV */
6051 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6055 while (d >= SvPVX_const(sv)) {
6063 /* MKS: The original code here died if letters weren't consecutive.
6064 * at least it didn't have to worry about non-C locales. The
6065 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6066 * arranged in order (although not consecutively) and that only
6067 * [A-Za-z] are accepted by isALPHA in the C locale.
6069 if (*d != 'z' && *d != 'Z') {
6070 do { ++*d; } while (!isALPHA(*d));
6073 *(d--) -= 'z' - 'a';
6078 *(d--) -= 'z' - 'a' + 1;
6082 /* oh,oh, the number grew */
6083 SvGROW(sv, SvCUR(sv) + 2);
6084 SvCUR_set(sv, SvCUR(sv) + 1);
6085 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6096 Auto-decrement of the value in the SV, doing string to numeric conversion
6097 if necessary. Handles 'get' magic.
6103 Perl_sv_dec(pTHX_ register SV *sv)
6110 if (SvTHINKFIRST(sv)) {
6112 sv_force_normal_flags(sv, 0);
6113 if (SvREADONLY(sv)) {
6114 if (IN_PERL_RUNTIME)
6115 Perl_croak(aTHX_ PL_no_modify);
6119 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6121 i = PTR2IV(SvRV(sv));
6126 /* Unlike sv_inc we don't have to worry about string-never-numbers
6127 and keeping them magic. But we mustn't warn on punting */
6128 flags = SvFLAGS(sv);
6129 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6130 /* It's publicly an integer, or privately an integer-not-float */
6131 #ifdef PERL_PRESERVE_IVUV
6135 if (SvUVX(sv) == 0) {
6136 (void)SvIOK_only(sv);
6140 (void)SvIOK_only_UV(sv);
6141 SvUV_set(sv, SvUVX(sv) - 1);
6144 if (SvIVX(sv) == IV_MIN)
6145 sv_setnv(sv, (NV)IV_MIN - 1.0);
6147 (void)SvIOK_only(sv);
6148 SvIV_set(sv, SvIVX(sv) - 1);
6153 if (flags & SVp_NOK) {
6154 SvNV_set(sv, SvNVX(sv) - 1.0);
6155 (void)SvNOK_only(sv);
6158 if (!(flags & SVp_POK)) {
6159 if ((flags & SVTYPEMASK) < SVt_PVIV)
6160 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6162 (void)SvIOK_only(sv);
6165 #ifdef PERL_PRESERVE_IVUV
6167 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6168 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6169 /* Need to try really hard to see if it's an integer.
6170 9.22337203685478e+18 is an integer.
6171 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6172 so $a="9.22337203685478e+18"; $a+0; $a--
6173 needs to be the same as $a="9.22337203685478e+18"; $a--
6180 /* sv_2iv *should* have made this an NV */
6181 if (flags & SVp_NOK) {
6182 (void)SvNOK_only(sv);
6183 SvNV_set(sv, SvNVX(sv) - 1.0);
6186 /* I don't think we can get here. Maybe I should assert this
6187 And if we do get here I suspect that sv_setnv will croak. NWC
6189 #if defined(USE_LONG_DOUBLE)
6190 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",
6191 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6193 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6194 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6198 #endif /* PERL_PRESERVE_IVUV */
6199 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6203 =for apidoc sv_mortalcopy
6205 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6206 The new SV is marked as mortal. It will be destroyed "soon", either by an
6207 explicit call to FREETMPS, or by an implicit call at places such as
6208 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6213 /* Make a string that will exist for the duration of the expression
6214 * evaluation. Actually, it may have to last longer than that, but
6215 * hopefully we won't free it until it has been assigned to a
6216 * permanent location. */
6219 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6224 sv_setsv(sv,oldstr);
6226 PL_tmps_stack[++PL_tmps_ix] = sv;
6232 =for apidoc sv_newmortal
6234 Creates a new null SV which is mortal. The reference count of the SV is
6235 set to 1. It will be destroyed "soon", either by an explicit call to
6236 FREETMPS, or by an implicit call at places such as statement boundaries.
6237 See also C<sv_mortalcopy> and C<sv_2mortal>.
6243 Perl_sv_newmortal(pTHX)
6248 SvFLAGS(sv) = SVs_TEMP;
6250 PL_tmps_stack[++PL_tmps_ix] = sv;
6255 =for apidoc sv_2mortal
6257 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6258 by an explicit call to FREETMPS, or by an implicit call at places such as
6259 statement boundaries. SvTEMP() is turned on which means that the SV's
6260 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6261 and C<sv_mortalcopy>.
6267 Perl_sv_2mortal(pTHX_ register SV *sv)
6272 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6275 PL_tmps_stack[++PL_tmps_ix] = sv;
6283 Creates a new SV and copies a string into it. The reference count for the
6284 SV is set to 1. If C<len> is zero, Perl will compute the length using
6285 strlen(). For efficiency, consider using C<newSVpvn> instead.
6291 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6296 sv_setpvn(sv,s,len ? len : strlen(s));
6301 =for apidoc newSVpvn
6303 Creates a new SV and copies a string into it. The reference count for the
6304 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6305 string. You are responsible for ensuring that the source string is at least
6306 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6312 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6317 sv_setpvn(sv,s,len);
6323 =for apidoc newSVhek
6325 Creates a new SV from the hash key structure. It will generate scalars that
6326 point to the shared string table where possible. Returns a new (undefined)
6327 SV if the hek is NULL.
6333 Perl_newSVhek(pTHX_ const HEK *hek)
6342 if (HEK_LEN(hek) == HEf_SVKEY) {
6343 return newSVsv(*(SV**)HEK_KEY(hek));
6345 const int flags = HEK_FLAGS(hek);
6346 if (flags & HVhek_WASUTF8) {
6348 Andreas would like keys he put in as utf8 to come back as utf8
6350 STRLEN utf8_len = HEK_LEN(hek);
6351 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6352 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6355 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6357 } else if (flags & HVhek_REHASH) {
6358 /* We don't have a pointer to the hv, so we have to replicate the
6359 flag into every HEK. This hv is using custom a hasing
6360 algorithm. Hence we can't return a shared string scalar, as
6361 that would contain the (wrong) hash value, and might get passed
6362 into an hv routine with a regular hash */
6364 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6369 /* This will be overwhelminly the most common case. */
6370 return newSVpvn_share(HEK_KEY(hek),
6371 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6377 =for apidoc newSVpvn_share
6379 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6380 table. If the string does not already exist in the table, it is created
6381 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6382 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6383 otherwise the hash is computed. The idea here is that as the string table
6384 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6385 hash lookup will avoid string compare.
6391 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6394 bool is_utf8 = FALSE;
6396 STRLEN tmplen = -len;
6398 /* See the note in hv.c:hv_fetch() --jhi */
6399 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6403 PERL_HASH(hash, src, len);
6405 sv_upgrade(sv, SVt_PV);
6406 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6418 #if defined(PERL_IMPLICIT_CONTEXT)
6420 /* pTHX_ magic can't cope with varargs, so this is a no-context
6421 * version of the main function, (which may itself be aliased to us).
6422 * Don't access this version directly.
6426 Perl_newSVpvf_nocontext(const char* pat, ...)
6431 va_start(args, pat);
6432 sv = vnewSVpvf(pat, &args);
6439 =for apidoc newSVpvf
6441 Creates a new SV and initializes it with the string formatted like
6448 Perl_newSVpvf(pTHX_ const char* pat, ...)
6452 va_start(args, pat);
6453 sv = vnewSVpvf(pat, &args);
6458 /* backend for newSVpvf() and newSVpvf_nocontext() */
6461 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6465 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6472 Creates a new SV and copies a floating point value into it.
6473 The reference count for the SV is set to 1.
6479 Perl_newSVnv(pTHX_ NV n)
6491 Creates a new SV and copies an integer into it. The reference count for the
6498 Perl_newSViv(pTHX_ IV i)
6510 Creates a new SV and copies an unsigned integer into it.
6511 The reference count for the SV is set to 1.
6517 Perl_newSVuv(pTHX_ UV u)
6527 =for apidoc newRV_noinc
6529 Creates an RV wrapper for an SV. The reference count for the original
6530 SV is B<not> incremented.
6536 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6541 sv_upgrade(sv, SVt_RV);
6543 SvRV_set(sv, tmpRef);
6548 /* newRV_inc is the official function name to use now.
6549 * newRV_inc is in fact #defined to newRV in sv.h
6553 Perl_newRV(pTHX_ SV *tmpRef)
6555 return newRV_noinc(SvREFCNT_inc(tmpRef));
6561 Creates a new SV which is an exact duplicate of the original SV.
6568 Perl_newSVsv(pTHX_ register SV *old)
6574 if (SvTYPE(old) == SVTYPEMASK) {
6575 if (ckWARN_d(WARN_INTERNAL))
6576 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6580 /* SV_GMAGIC is the default for sv_setv()
6581 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6582 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6583 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6588 =for apidoc sv_reset
6590 Underlying implementation for the C<reset> Perl function.
6591 Note that the perl-level function is vaguely deprecated.
6597 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6600 char todo[PERL_UCHAR_MAX+1];
6605 if (!*s) { /* reset ?? searches */
6606 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6608 PMOP *pm = (PMOP *) mg->mg_obj;
6610 pm->op_pmdynflags &= ~PMdf_USED;
6617 /* reset variables */
6619 if (!HvARRAY(stash))
6622 Zero(todo, 256, char);
6625 I32 i = (unsigned char)*s;
6629 max = (unsigned char)*s++;
6630 for ( ; i <= max; i++) {
6633 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6635 for (entry = HvARRAY(stash)[i];
6637 entry = HeNEXT(entry))
6642 if (!todo[(U8)*HeKEY(entry)])
6644 gv = (GV*)HeVAL(entry);
6647 if (SvTHINKFIRST(sv)) {
6648 if (!SvREADONLY(sv) && SvROK(sv))
6650 /* XXX Is this continue a bug? Why should THINKFIRST
6651 exempt us from resetting arrays and hashes? */
6655 if (SvTYPE(sv) >= SVt_PV) {
6657 if (SvPVX_const(sv) != Nullch)
6665 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6667 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6670 # if defined(USE_ENVIRON_ARRAY)
6673 # endif /* USE_ENVIRON_ARRAY */
6684 Using various gambits, try to get an IO from an SV: the IO slot if its a
6685 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6686 named after the PV if we're a string.
6692 Perl_sv_2io(pTHX_ SV *sv)
6697 switch (SvTYPE(sv)) {
6705 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6709 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6711 return sv_2io(SvRV(sv));
6712 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6718 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6727 Using various gambits, try to get a CV from an SV; in addition, try if
6728 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6734 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6741 return *gvp = Nullgv, Nullcv;
6742 switch (SvTYPE(sv)) {
6760 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6761 tryAMAGICunDEREF(to_cv);
6764 if (SvTYPE(sv) == SVt_PVCV) {
6773 Perl_croak(aTHX_ "Not a subroutine reference");
6778 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6784 if (lref && !GvCVu(gv)) {
6787 tmpsv = NEWSV(704,0);
6788 gv_efullname3(tmpsv, gv, Nullch);
6789 /* XXX this is probably not what they think they're getting.
6790 * It has the same effect as "sub name;", i.e. just a forward
6792 newSUB(start_subparse(FALSE, 0),
6793 newSVOP(OP_CONST, 0, tmpsv),
6798 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6808 Returns true if the SV has a true value by Perl's rules.
6809 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6810 instead use an in-line version.
6816 Perl_sv_true(pTHX_ register SV *sv)
6821 register const XPV* const tXpv = (XPV*)SvANY(sv);
6823 (tXpv->xpv_cur > 1 ||
6824 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6831 return SvIVX(sv) != 0;
6834 return SvNVX(sv) != 0.0;
6836 return sv_2bool(sv);
6842 =for apidoc sv_pvn_force
6844 Get a sensible string out of the SV somehow.
6845 A private implementation of the C<SvPV_force> macro for compilers which
6846 can't cope with complex macro expressions. Always use the macro instead.
6848 =for apidoc sv_pvn_force_flags
6850 Get a sensible string out of the SV somehow.
6851 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6852 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6853 implemented in terms of this function.
6854 You normally want to use the various wrapper macros instead: see
6855 C<SvPV_force> and C<SvPV_force_nomg>
6861 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6864 if (SvTHINKFIRST(sv) && !SvROK(sv))
6865 sv_force_normal_flags(sv, 0);
6875 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6876 const char * const ref = sv_reftype(sv,0);
6878 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6879 ref, OP_NAME(PL_op));
6881 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6883 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6884 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6886 s = sv_2pv_flags(sv, &len, flags);
6890 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6893 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6894 SvGROW(sv, len + 1);
6895 Move(s,SvPVX(sv),len,char);
6900 SvPOK_on(sv); /* validate pointer */
6902 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6903 PTR2UV(sv),SvPVX_const(sv)));
6906 return SvPVX_mutable(sv);
6910 =for apidoc sv_pvbyten_force
6912 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6918 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6920 sv_pvn_force(sv,lp);
6921 sv_utf8_downgrade(sv,0);
6927 =for apidoc sv_pvutf8n_force
6929 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6935 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6937 sv_pvn_force(sv,lp);
6938 sv_utf8_upgrade(sv);
6944 =for apidoc sv_reftype
6946 Returns a string describing what the SV is a reference to.
6952 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6954 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6955 inside return suggests a const propagation bug in g++. */
6956 if (ob && SvOBJECT(sv)) {
6957 char * const name = HvNAME_get(SvSTASH(sv));
6958 return name ? name : (char *) "__ANON__";
6961 switch (SvTYPE(sv)) {
6978 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6979 /* tied lvalues should appear to be
6980 * scalars for backwards compatitbility */
6981 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6982 ? "SCALAR" : "LVALUE");
6983 case SVt_PVAV: return "ARRAY";
6984 case SVt_PVHV: return "HASH";
6985 case SVt_PVCV: return "CODE";
6986 case SVt_PVGV: return "GLOB";
6987 case SVt_PVFM: return "FORMAT";
6988 case SVt_PVIO: return "IO";
6989 default: return "UNKNOWN";
6995 =for apidoc sv_isobject
6997 Returns a boolean indicating whether the SV is an RV pointing to a blessed
6998 object. If the SV is not an RV, or if the object is not blessed, then this
7005 Perl_sv_isobject(pTHX_ SV *sv)
7021 Returns a boolean indicating whether the SV is blessed into the specified
7022 class. This does not check for subtypes; use C<sv_derived_from> to verify
7023 an inheritance relationship.
7029 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7040 hvname = HvNAME_get(SvSTASH(sv));
7044 return strEQ(hvname, name);
7050 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7051 it will be upgraded to one. If C<classname> is non-null then the new SV will
7052 be blessed in the specified package. The new SV is returned and its
7053 reference count is 1.
7059 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7065 SV_CHECK_THINKFIRST_COW_DROP(rv);
7068 if (SvTYPE(rv) >= SVt_PVMG) {
7069 const U32 refcnt = SvREFCNT(rv);
7073 SvREFCNT(rv) = refcnt;
7076 if (SvTYPE(rv) < SVt_RV)
7077 sv_upgrade(rv, SVt_RV);
7078 else if (SvTYPE(rv) > SVt_RV) {
7089 HV* const stash = gv_stashpv(classname, TRUE);
7090 (void)sv_bless(rv, stash);
7096 =for apidoc sv_setref_pv
7098 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7099 argument will be upgraded to an RV. That RV will be modified to point to
7100 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7101 into the SV. The C<classname> argument indicates the package for the
7102 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7103 will have a reference count of 1, and the RV will be returned.
7105 Do not use with other Perl types such as HV, AV, SV, CV, because those
7106 objects will become corrupted by the pointer copy process.
7108 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7114 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7117 sv_setsv(rv, &PL_sv_undef);
7121 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7126 =for apidoc sv_setref_iv
7128 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7129 argument will be upgraded to an RV. That RV will be modified to point to
7130 the new SV. The C<classname> argument indicates the package for the
7131 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7132 will have a reference count of 1, and the RV will be returned.
7138 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7140 sv_setiv(newSVrv(rv,classname), iv);
7145 =for apidoc sv_setref_uv
7147 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7148 argument will be upgraded to an RV. That RV will be modified to point to
7149 the new SV. The C<classname> argument indicates the package for the
7150 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7151 will have a reference count of 1, and the RV will be returned.
7157 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7159 sv_setuv(newSVrv(rv,classname), uv);
7164 =for apidoc sv_setref_nv
7166 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7167 argument will be upgraded to an RV. That RV will be modified to point to
7168 the new SV. The C<classname> argument indicates the package for the
7169 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7170 will have a reference count of 1, and the RV will be returned.
7176 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7178 sv_setnv(newSVrv(rv,classname), nv);
7183 =for apidoc sv_setref_pvn
7185 Copies a string into a new SV, optionally blessing the SV. The length of the
7186 string must be specified with C<n>. The C<rv> argument will be upgraded to
7187 an RV. That RV will be modified to point to the new SV. The C<classname>
7188 argument indicates the package for the blessing. Set C<classname> to
7189 C<Nullch> to avoid the blessing. The new SV will have a reference count
7190 of 1, and the RV will be returned.
7192 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7198 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7200 sv_setpvn(newSVrv(rv,classname), pv, n);
7205 =for apidoc sv_bless
7207 Blesses an SV into a specified package. The SV must be an RV. The package
7208 must be designated by its stash (see C<gv_stashpv()>). The reference count
7209 of the SV is unaffected.
7215 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7219 Perl_croak(aTHX_ "Can't bless non-reference value");
7221 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7222 if (SvREADONLY(tmpRef))
7223 Perl_croak(aTHX_ PL_no_modify);
7224 if (SvOBJECT(tmpRef)) {
7225 if (SvTYPE(tmpRef) != SVt_PVIO)
7227 SvREFCNT_dec(SvSTASH(tmpRef));
7230 SvOBJECT_on(tmpRef);
7231 if (SvTYPE(tmpRef) != SVt_PVIO)
7233 SvUPGRADE(tmpRef, SVt_PVMG);
7234 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7241 if(SvSMAGICAL(tmpRef))
7242 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7250 /* Downgrades a PVGV to a PVMG.
7254 S_sv_unglob(pTHX_ SV *sv)
7258 assert(SvTYPE(sv) == SVt_PVGV);
7263 sv_del_backref((SV*)GvSTASH(sv), sv);
7266 sv_unmagic(sv, PERL_MAGIC_glob);
7267 Safefree(GvNAME(sv));
7270 /* need to keep SvANY(sv) in the right arena */
7271 xpvmg = new_XPVMG();
7272 StructCopy(SvANY(sv), xpvmg, XPVMG);
7273 del_XPVGV(SvANY(sv));
7276 SvFLAGS(sv) &= ~SVTYPEMASK;
7277 SvFLAGS(sv) |= SVt_PVMG;
7281 =for apidoc sv_unref_flags
7283 Unsets the RV status of the SV, and decrements the reference count of
7284 whatever was being referenced by the RV. This can almost be thought of
7285 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7286 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7287 (otherwise the decrementing is conditional on the reference count being
7288 different from one or the reference being a readonly SV).
7295 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7297 SV* const target = SvRV(ref);
7299 if (SvWEAKREF(ref)) {
7300 sv_del_backref(target, ref);
7302 SvRV_set(ref, NULL);
7305 SvRV_set(ref, NULL);
7307 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7308 assigned to as BEGIN {$a = \"Foo"} will fail. */
7309 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7310 SvREFCNT_dec(target);
7311 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7312 sv_2mortal(target); /* Schedule for freeing later */
7316 =for apidoc sv_untaint
7318 Untaint an SV. Use C<SvTAINTED_off> instead.
7323 Perl_sv_untaint(pTHX_ SV *sv)
7325 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7326 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7333 =for apidoc sv_tainted
7335 Test an SV for taintedness. Use C<SvTAINTED> instead.
7340 Perl_sv_tainted(pTHX_ SV *sv)
7342 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7343 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7344 if (mg && (mg->mg_len & 1) )
7351 =for apidoc sv_setpviv
7353 Copies an integer into the given SV, also updating its string value.
7354 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7360 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7362 char buf[TYPE_CHARS(UV)];
7364 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7366 sv_setpvn(sv, ptr, ebuf - ptr);
7370 =for apidoc sv_setpviv_mg
7372 Like C<sv_setpviv>, but also handles 'set' magic.
7378 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7384 #if defined(PERL_IMPLICIT_CONTEXT)
7386 /* pTHX_ magic can't cope with varargs, so this is a no-context
7387 * version of the main function, (which may itself be aliased to us).
7388 * Don't access this version directly.
7392 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7396 va_start(args, pat);
7397 sv_vsetpvf(sv, pat, &args);
7401 /* pTHX_ magic can't cope with varargs, so this is a no-context
7402 * version of the main function, (which may itself be aliased to us).
7403 * Don't access this version directly.
7407 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7411 va_start(args, pat);
7412 sv_vsetpvf_mg(sv, pat, &args);
7418 =for apidoc sv_setpvf
7420 Works like C<sv_catpvf> but copies the text into the SV instead of
7421 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7427 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7430 va_start(args, pat);
7431 sv_vsetpvf(sv, pat, &args);
7436 =for apidoc sv_vsetpvf
7438 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7439 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7441 Usually used via its frontend C<sv_setpvf>.
7447 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7449 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7453 =for apidoc sv_setpvf_mg
7455 Like C<sv_setpvf>, but also handles 'set' magic.
7461 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7464 va_start(args, pat);
7465 sv_vsetpvf_mg(sv, pat, &args);
7470 =for apidoc sv_vsetpvf_mg
7472 Like C<sv_vsetpvf>, but also handles 'set' magic.
7474 Usually used via its frontend C<sv_setpvf_mg>.
7480 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7482 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7486 #if defined(PERL_IMPLICIT_CONTEXT)
7488 /* pTHX_ magic can't cope with varargs, so this is a no-context
7489 * version of the main function, (which may itself be aliased to us).
7490 * Don't access this version directly.
7494 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7498 va_start(args, pat);
7499 sv_vcatpvf(sv, pat, &args);
7503 /* pTHX_ magic can't cope with varargs, so this is a no-context
7504 * version of the main function, (which may itself be aliased to us).
7505 * Don't access this version directly.
7509 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7513 va_start(args, pat);
7514 sv_vcatpvf_mg(sv, pat, &args);
7520 =for apidoc sv_catpvf
7522 Processes its arguments like C<sprintf> and appends the formatted
7523 output to an SV. If the appended data contains "wide" characters
7524 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7525 and characters >255 formatted with %c), the original SV might get
7526 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7527 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7528 valid UTF-8; if the original SV was bytes, the pattern should be too.
7533 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7536 va_start(args, pat);
7537 sv_vcatpvf(sv, pat, &args);
7542 =for apidoc sv_vcatpvf
7544 Processes its arguments like C<vsprintf> and appends the formatted output
7545 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7547 Usually used via its frontend C<sv_catpvf>.
7553 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7555 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7559 =for apidoc sv_catpvf_mg
7561 Like C<sv_catpvf>, but also handles 'set' magic.
7567 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7570 va_start(args, pat);
7571 sv_vcatpvf_mg(sv, pat, &args);
7576 =for apidoc sv_vcatpvf_mg
7578 Like C<sv_vcatpvf>, but also handles 'set' magic.
7580 Usually used via its frontend C<sv_catpvf_mg>.
7586 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7588 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7593 =for apidoc sv_vsetpvfn
7595 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7598 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7604 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7606 sv_setpvn(sv, "", 0);
7607 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7610 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7613 S_expect_number(pTHX_ char** pattern)
7616 switch (**pattern) {
7617 case '1': case '2': case '3':
7618 case '4': case '5': case '6':
7619 case '7': case '8': case '9':
7620 var = *(*pattern)++ - '0';
7621 while (isDIGIT(**pattern)) {
7622 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7624 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7630 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7633 F0convert(NV nv, char *endbuf, STRLEN *len)
7635 const int neg = nv < 0;
7644 if (uv & 1 && uv == nv)
7645 uv--; /* Round to even */
7647 const unsigned dig = uv % 10;
7660 =for apidoc sv_vcatpvfn
7662 Processes its arguments like C<vsprintf> and appends the formatted output
7663 to an SV. Uses an array of SVs if the C style variable argument list is
7664 missing (NULL). When running with taint checks enabled, indicates via
7665 C<maybe_tainted> if results are untrustworthy (often due to the use of
7668 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7674 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7675 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7676 vec_utf8 = DO_UTF8(vecsv);
7678 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7681 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7688 static const char nullstr[] = "(null)";
7690 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7691 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7693 /* Times 4: a decimal digit takes more than 3 binary digits.
7694 * NV_DIG: mantissa takes than many decimal digits.
7695 * Plus 32: Playing safe. */
7696 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7697 /* large enough for "%#.#f" --chip */
7698 /* what about long double NVs? --jhi */
7700 PERL_UNUSED_ARG(maybe_tainted);
7702 /* no matter what, this is a string now */
7703 (void)SvPV_force(sv, origlen);
7705 /* special-case "", "%s", and "%-p" (SVf - see below) */
7708 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7710 const char * const s = va_arg(*args, char*);
7711 sv_catpv(sv, s ? s : nullstr);
7713 else if (svix < svmax) {
7714 sv_catsv(sv, *svargs);
7718 if (args && patlen == 3 && pat[0] == '%' &&
7719 pat[1] == '-' && pat[2] == 'p') {
7720 argsv = va_arg(*args, SV*);
7721 sv_catsv(sv, argsv);
7725 #ifndef USE_LONG_DOUBLE
7726 /* special-case "%.<number>[gf]" */
7727 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7728 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7729 unsigned digits = 0;
7733 while (*pp >= '0' && *pp <= '9')
7734 digits = 10 * digits + (*pp++ - '0');
7735 if (pp - pat == (int)patlen - 1) {
7743 /* Add check for digits != 0 because it seems that some
7744 gconverts are buggy in this case, and we don't yet have
7745 a Configure test for this. */
7746 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7747 /* 0, point, slack */
7748 Gconvert(nv, (int)digits, 0, ebuf);
7750 if (*ebuf) /* May return an empty string for digits==0 */
7753 } else if (!digits) {
7756 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7757 sv_catpvn(sv, p, l);
7763 #endif /* !USE_LONG_DOUBLE */
7765 if (!args && svix < svmax && DO_UTF8(*svargs))
7768 patend = (char*)pat + patlen;
7769 for (p = (char*)pat; p < patend; p = q) {
7772 bool vectorize = FALSE;
7773 bool vectorarg = FALSE;
7774 bool vec_utf8 = FALSE;
7780 bool has_precis = FALSE;
7783 bool is_utf8 = FALSE; /* is this item utf8? */
7784 #ifdef HAS_LDBL_SPRINTF_BUG
7785 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7786 with sfio - Allen <allens@cpan.org> */
7787 bool fix_ldbl_sprintf_bug = FALSE;
7791 U8 utf8buf[UTF8_MAXBYTES+1];
7792 STRLEN esignlen = 0;
7794 const char *eptr = Nullch;
7797 const U8 *vecstr = Null(U8*);
7804 /* we need a long double target in case HAS_LONG_DOUBLE but
7807 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7815 const char *dotstr = ".";
7816 STRLEN dotstrlen = 1;
7817 I32 efix = 0; /* explicit format parameter index */
7818 I32 ewix = 0; /* explicit width index */
7819 I32 epix = 0; /* explicit precision index */
7820 I32 evix = 0; /* explicit vector index */
7821 bool asterisk = FALSE;
7823 /* echo everything up to the next format specification */
7824 for (q = p; q < patend && *q != '%'; ++q) ;
7826 if (has_utf8 && !pat_utf8)
7827 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7829 sv_catpvn(sv, p, q - p);
7836 We allow format specification elements in this order:
7837 \d+\$ explicit format parameter index
7839 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7840 0 flag (as above): repeated to allow "v02"
7841 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7842 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7844 [%bcdefginopsuxDFOUX] format (mandatory)
7849 As of perl5.9.3, printf format checking is on by default.
7850 Internally, perl uses %p formats to provide an escape to
7851 some extended formatting. This block deals with those
7852 extensions: if it does not match, (char*)q is reset and
7853 the normal format processing code is used.
7855 Currently defined extensions are:
7856 %p include pointer address (standard)
7857 %-p (SVf) include an SV (previously %_)
7858 %-<num>p include an SV with precision <num>
7859 %1p (VDf) include a v-string (as %vd)
7860 %<num>p reserved for future extensions
7862 Robin Barker 2005-07-14
7869 EXPECT_NUMBER(q, n);
7876 argsv = va_arg(*args, SV*);
7877 eptr = SvPVx_const(argsv, elen);
7883 else if (n == vdNUMBER) { /* VDf */
7890 if (ckWARN_d(WARN_INTERNAL))
7891 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7892 "internal %%<num>p might conflict with future printf extensions");
7898 if (EXPECT_NUMBER(q, width)) {
7939 if (EXPECT_NUMBER(q, ewix))
7948 if ((vectorarg = asterisk)) {
7961 EXPECT_NUMBER(q, width);
7967 vecsv = va_arg(*args, SV*);
7969 vecsv = (evix > 0 && evix <= svmax)
7970 ? svargs[evix-1] : &PL_sv_undef;
7972 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7974 dotstr = SvPV_const(vecsv, dotstrlen);
7975 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7976 bad with tied or overloaded values that return UTF8. */
7979 else if (has_utf8) {
7980 vecsv = sv_mortalcopy(vecsv);
7981 sv_utf8_upgrade(vecsv);
7982 dotstr = SvPV_const(vecsv, dotstrlen);
7989 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
7990 vecsv = svargs[efix ? efix-1 : svix++];
7991 vecstr = (U8*)SvPV_const(vecsv,veclen);
7992 vec_utf8 = DO_UTF8(vecsv);
7994 /* if this is a version object, we need to convert
7995 * back into v-string notation and then let the
7996 * vectorize happen normally
7998 if (sv_derived_from(vecsv, "version")) {
7999 char *version = savesvpv(vecsv);
8000 vecsv = sv_newmortal();
8001 /* scan_vstring is expected to be called during
8002 * tokenization, so we need to fake up the end
8003 * of the buffer for it
8005 PL_bufend = version + veclen;
8006 scan_vstring(version, vecsv);
8007 vecstr = (U8*)SvPV_const(vecsv, veclen);
8008 vec_utf8 = DO_UTF8(vecsv);
8020 i = va_arg(*args, int);
8022 i = (ewix ? ewix <= svmax : svix < svmax) ?
8023 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8025 width = (i < 0) ? -i : i;
8035 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8037 /* XXX: todo, support specified precision parameter */
8041 i = va_arg(*args, int);
8043 i = (ewix ? ewix <= svmax : svix < svmax)
8044 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8045 precis = (i < 0) ? 0 : i;
8050 precis = precis * 10 + (*q++ - '0');
8059 case 'I': /* Ix, I32x, and I64x */
8061 if (q[1] == '6' && q[2] == '4') {
8067 if (q[1] == '3' && q[2] == '2') {
8077 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8088 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8089 if (*(q + 1) == 'l') { /* lld, llf */
8115 if (!vectorize && !args) {
8117 const I32 i = efix-1;
8118 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8120 argsv = (svix >= 0 && svix < svmax)
8121 ? svargs[svix++] : &PL_sv_undef;
8132 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8134 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8136 eptr = (char*)utf8buf;
8137 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8151 eptr = va_arg(*args, char*);
8153 #ifdef MACOS_TRADITIONAL
8154 /* On MacOS, %#s format is used for Pascal strings */
8159 elen = strlen(eptr);
8161 eptr = (char *)nullstr;
8162 elen = sizeof nullstr - 1;
8166 eptr = SvPVx_const(argsv, elen);
8167 if (DO_UTF8(argsv)) {
8168 if (has_precis && precis < elen) {
8170 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8173 if (width) { /* fudge width (can't fudge elen) */
8174 width += elen - sv_len_utf8(argsv);
8181 if (has_precis && elen > precis)
8188 if (alt || vectorize)
8190 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8211 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8220 esignbuf[esignlen++] = plus;
8224 case 'h': iv = (short)va_arg(*args, int); break;
8225 case 'l': iv = va_arg(*args, long); break;
8226 case 'V': iv = va_arg(*args, IV); break;
8227 default: iv = va_arg(*args, int); break;
8229 case 'q': iv = va_arg(*args, Quad_t); break;
8234 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8236 case 'h': iv = (short)tiv; break;
8237 case 'l': iv = (long)tiv; break;
8239 default: iv = tiv; break;
8241 case 'q': iv = (Quad_t)tiv; break;
8245 if ( !vectorize ) /* we already set uv above */
8250 esignbuf[esignlen++] = plus;
8254 esignbuf[esignlen++] = '-';
8297 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8308 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8309 case 'l': uv = va_arg(*args, unsigned long); break;
8310 case 'V': uv = va_arg(*args, UV); break;
8311 default: uv = va_arg(*args, unsigned); break;
8313 case 'q': uv = va_arg(*args, Uquad_t); break;
8318 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8320 case 'h': uv = (unsigned short)tuv; break;
8321 case 'l': uv = (unsigned long)tuv; break;
8323 default: uv = tuv; break;
8325 case 'q': uv = (Uquad_t)tuv; break;
8332 char *ptr = ebuf + sizeof ebuf;
8338 p = (char*)((c == 'X')
8339 ? "0123456789ABCDEF" : "0123456789abcdef");
8345 esignbuf[esignlen++] = '0';
8346 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8354 if (alt && *ptr != '0')
8365 esignbuf[esignlen++] = '0';
8366 esignbuf[esignlen++] = 'b';
8369 default: /* it had better be ten or less */
8373 } while (uv /= base);
8376 elen = (ebuf + sizeof ebuf) - ptr;
8380 zeros = precis - elen;
8381 else if (precis == 0 && elen == 1 && *eptr == '0')
8387 /* FLOATING POINT */
8390 c = 'f'; /* maybe %F isn't supported here */
8398 /* This is evil, but floating point is even more evil */
8400 /* for SV-style calling, we can only get NV
8401 for C-style calling, we assume %f is double;
8402 for simplicity we allow any of %Lf, %llf, %qf for long double
8406 #if defined(USE_LONG_DOUBLE)
8410 /* [perl #20339] - we should accept and ignore %lf rather than die */
8414 #if defined(USE_LONG_DOUBLE)
8415 intsize = args ? 0 : 'q';
8419 #if defined(HAS_LONG_DOUBLE)
8428 /* now we need (long double) if intsize == 'q', else (double) */
8430 #if LONG_DOUBLESIZE > DOUBLESIZE
8432 va_arg(*args, long double) :
8433 va_arg(*args, double)
8435 va_arg(*args, double)
8440 if (c != 'e' && c != 'E') {
8442 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8443 will cast our (long double) to (double) */
8444 (void)Perl_frexp(nv, &i);
8445 if (i == PERL_INT_MIN)
8446 Perl_die(aTHX_ "panic: frexp");
8448 need = BIT_DIGITS(i);
8450 need += has_precis ? precis : 6; /* known default */
8455 #ifdef HAS_LDBL_SPRINTF_BUG
8456 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8457 with sfio - Allen <allens@cpan.org> */
8460 # define MY_DBL_MAX DBL_MAX
8461 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8462 # if DOUBLESIZE >= 8
8463 # define MY_DBL_MAX 1.7976931348623157E+308L
8465 # define MY_DBL_MAX 3.40282347E+38L
8469 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8470 # define MY_DBL_MAX_BUG 1L
8472 # define MY_DBL_MAX_BUG MY_DBL_MAX
8476 # define MY_DBL_MIN DBL_MIN
8477 # else /* XXX guessing! -Allen */
8478 # if DOUBLESIZE >= 8
8479 # define MY_DBL_MIN 2.2250738585072014E-308L
8481 # define MY_DBL_MIN 1.17549435E-38L
8485 if ((intsize == 'q') && (c == 'f') &&
8486 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8488 /* it's going to be short enough that
8489 * long double precision is not needed */
8491 if ((nv <= 0L) && (nv >= -0L))
8492 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8494 /* would use Perl_fp_class as a double-check but not
8495 * functional on IRIX - see perl.h comments */
8497 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8498 /* It's within the range that a double can represent */
8499 #if defined(DBL_MAX) && !defined(DBL_MIN)
8500 if ((nv >= ((long double)1/DBL_MAX)) ||
8501 (nv <= (-(long double)1/DBL_MAX)))
8503 fix_ldbl_sprintf_bug = TRUE;
8506 if (fix_ldbl_sprintf_bug == TRUE) {
8516 # undef MY_DBL_MAX_BUG
8519 #endif /* HAS_LDBL_SPRINTF_BUG */
8521 need += 20; /* fudge factor */
8522 if (PL_efloatsize < need) {
8523 Safefree(PL_efloatbuf);
8524 PL_efloatsize = need + 20; /* more fudge */
8525 Newx(PL_efloatbuf, PL_efloatsize, char);
8526 PL_efloatbuf[0] = '\0';
8529 if ( !(width || left || plus || alt) && fill != '0'
8530 && has_precis && intsize != 'q' ) { /* Shortcuts */
8531 /* See earlier comment about buggy Gconvert when digits,
8533 if ( c == 'g' && precis) {
8534 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8535 /* May return an empty string for digits==0 */
8536 if (*PL_efloatbuf) {
8537 elen = strlen(PL_efloatbuf);
8538 goto float_converted;
8540 } else if ( c == 'f' && !precis) {
8541 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8546 char *ptr = ebuf + sizeof ebuf;
8549 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8550 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8551 if (intsize == 'q') {
8552 /* Copy the one or more characters in a long double
8553 * format before the 'base' ([efgEFG]) character to
8554 * the format string. */
8555 static char const prifldbl[] = PERL_PRIfldbl;
8556 char const *p = prifldbl + sizeof(prifldbl) - 3;
8557 while (p >= prifldbl) { *--ptr = *p--; }
8562 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8567 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8579 /* No taint. Otherwise we are in the strange situation
8580 * where printf() taints but print($float) doesn't.
8582 #if defined(HAS_LONG_DOUBLE)
8583 elen = ((intsize == 'q')
8584 ? my_sprintf(PL_efloatbuf, ptr, nv)
8585 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8587 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8591 eptr = PL_efloatbuf;
8599 i = SvCUR(sv) - origlen;
8602 case 'h': *(va_arg(*args, short*)) = i; break;
8603 default: *(va_arg(*args, int*)) = i; break;
8604 case 'l': *(va_arg(*args, long*)) = i; break;
8605 case 'V': *(va_arg(*args, IV*)) = i; break;
8607 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8612 sv_setuv_mg(argsv, (UV)i);
8613 continue; /* not "break" */
8620 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8621 && ckWARN(WARN_PRINTF))
8623 SV * const msg = sv_newmortal();
8624 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8625 (PL_op->op_type == OP_PRTF) ? "" : "s");
8628 Perl_sv_catpvf(aTHX_ msg,
8629 "\"%%%c\"", c & 0xFF);
8631 Perl_sv_catpvf(aTHX_ msg,
8632 "\"%%\\%03"UVof"\"",
8635 sv_catpv(msg, "end of string");
8636 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8639 /* output mangled stuff ... */
8645 /* ... right here, because formatting flags should not apply */
8646 SvGROW(sv, SvCUR(sv) + elen + 1);
8648 Copy(eptr, p, elen, char);
8651 SvCUR_set(sv, p - SvPVX_const(sv));
8653 continue; /* not "break" */
8656 /* calculate width before utf8_upgrade changes it */
8657 have = esignlen + zeros + elen;
8659 Perl_croak_nocontext(PL_memory_wrap);
8661 if (is_utf8 != has_utf8) {
8664 sv_utf8_upgrade(sv);
8667 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8668 sv_utf8_upgrade(nsv);
8669 eptr = SvPVX_const(nsv);
8672 SvGROW(sv, SvCUR(sv) + elen + 1);
8677 need = (have > width ? have : width);
8680 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8681 Perl_croak_nocontext(PL_memory_wrap);
8682 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8684 if (esignlen && fill == '0') {
8686 for (i = 0; i < (int)esignlen; i++)
8690 memset(p, fill, gap);
8693 if (esignlen && fill != '0') {
8695 for (i = 0; i < (int)esignlen; i++)
8700 for (i = zeros; i; i--)
8704 Copy(eptr, p, elen, char);
8708 memset(p, ' ', gap);
8713 Copy(dotstr, p, dotstrlen, char);
8717 vectorize = FALSE; /* done iterating over vecstr */
8724 SvCUR_set(sv, p - SvPVX_const(sv));
8732 /* =========================================================================
8734 =head1 Cloning an interpreter
8736 All the macros and functions in this section are for the private use of
8737 the main function, perl_clone().
8739 The foo_dup() functions make an exact copy of an existing foo thinngy.
8740 During the course of a cloning, a hash table is used to map old addresses
8741 to new addresses. The table is created and manipulated with the
8742 ptr_table_* functions.
8746 ============================================================================*/
8749 #if defined(USE_ITHREADS)
8751 #ifndef GpREFCNT_inc
8752 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8756 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8757 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8758 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8759 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8760 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8761 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8762 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8763 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8764 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8765 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8766 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8767 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8768 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8771 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8772 regcomp.c. AMS 20010712 */
8775 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8780 struct reg_substr_datum *s;
8783 return (REGEXP *)NULL;
8785 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8788 len = r->offsets[0];
8789 npar = r->nparens+1;
8791 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8792 Copy(r->program, ret->program, len+1, regnode);
8794 Newx(ret->startp, npar, I32);
8795 Copy(r->startp, ret->startp, npar, I32);
8796 Newx(ret->endp, npar, I32);
8797 Copy(r->startp, ret->startp, npar, I32);
8799 Newx(ret->substrs, 1, struct reg_substr_data);
8800 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8801 s->min_offset = r->substrs->data[i].min_offset;
8802 s->max_offset = r->substrs->data[i].max_offset;
8803 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8804 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8807 ret->regstclass = NULL;
8810 const int count = r->data->count;
8813 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8814 char, struct reg_data);
8815 Newx(d->what, count, U8);
8818 for (i = 0; i < count; i++) {
8819 d->what[i] = r->data->what[i];
8820 switch (d->what[i]) {
8821 /* legal options are one of: sfpont
8822 see also regcomp.h and pregfree() */
8824 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8827 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8830 /* This is cheating. */
8831 Newx(d->data[i], 1, struct regnode_charclass_class);
8832 StructCopy(r->data->data[i], d->data[i],
8833 struct regnode_charclass_class);
8834 ret->regstclass = (regnode*)d->data[i];
8837 /* Compiled op trees are readonly, and can thus be
8838 shared without duplication. */
8840 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8844 d->data[i] = r->data->data[i];
8847 d->data[i] = r->data->data[i];
8849 ((reg_trie_data*)d->data[i])->refcount++;
8853 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8862 Newx(ret->offsets, 2*len+1, U32);
8863 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8865 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8866 ret->refcnt = r->refcnt;
8867 ret->minlen = r->minlen;
8868 ret->prelen = r->prelen;
8869 ret->nparens = r->nparens;
8870 ret->lastparen = r->lastparen;
8871 ret->lastcloseparen = r->lastcloseparen;
8872 ret->reganch = r->reganch;
8874 ret->sublen = r->sublen;
8876 if (RX_MATCH_COPIED(ret))
8877 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8879 ret->subbeg = Nullch;
8880 #ifdef PERL_OLD_COPY_ON_WRITE
8881 ret->saved_copy = Nullsv;
8884 ptr_table_store(PL_ptr_table, r, ret);
8888 /* duplicate a file handle */
8891 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8895 PERL_UNUSED_ARG(type);
8898 return (PerlIO*)NULL;
8900 /* look for it in the table first */
8901 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8905 /* create anew and remember what it is */
8906 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8907 ptr_table_store(PL_ptr_table, fp, ret);
8911 /* duplicate a directory handle */
8914 Perl_dirp_dup(pTHX_ DIR *dp)
8922 /* duplicate a typeglob */
8925 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8930 /* look for it in the table first */
8931 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8935 /* create anew and remember what it is */
8937 ptr_table_store(PL_ptr_table, gp, ret);
8940 ret->gp_refcnt = 0; /* must be before any other dups! */
8941 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8942 ret->gp_io = io_dup_inc(gp->gp_io, param);
8943 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8944 ret->gp_av = av_dup_inc(gp->gp_av, param);
8945 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8946 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8947 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8948 ret->gp_cvgen = gp->gp_cvgen;
8949 ret->gp_line = gp->gp_line;
8950 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8954 /* duplicate a chain of magic */
8957 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8959 MAGIC *mgprev = (MAGIC*)NULL;
8962 return (MAGIC*)NULL;
8963 /* look for it in the table first */
8964 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8968 for (; mg; mg = mg->mg_moremagic) {
8970 Newxz(nmg, 1, MAGIC);
8972 mgprev->mg_moremagic = nmg;
8975 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8976 nmg->mg_private = mg->mg_private;
8977 nmg->mg_type = mg->mg_type;
8978 nmg->mg_flags = mg->mg_flags;
8979 if (mg->mg_type == PERL_MAGIC_qr) {
8980 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8982 else if(mg->mg_type == PERL_MAGIC_backref) {
8983 const AV * const av = (AV*) mg->mg_obj;
8986 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8988 for (i = AvFILLp(av); i >= 0; i--) {
8989 if (!svp[i]) continue;
8990 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8993 else if (mg->mg_type == PERL_MAGIC_symtab) {
8994 nmg->mg_obj = mg->mg_obj;
8997 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8998 ? sv_dup_inc(mg->mg_obj, param)
8999 : sv_dup(mg->mg_obj, param);
9001 nmg->mg_len = mg->mg_len;
9002 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9003 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9004 if (mg->mg_len > 0) {
9005 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9006 if (mg->mg_type == PERL_MAGIC_overload_table &&
9007 AMT_AMAGIC((AMT*)mg->mg_ptr))
9009 AMT * const amtp = (AMT*)mg->mg_ptr;
9010 AMT * const namtp = (AMT*)nmg->mg_ptr;
9012 for (i = 1; i < NofAMmeth; i++) {
9013 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9017 else if (mg->mg_len == HEf_SVKEY)
9018 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9020 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9021 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9028 /* create a new pointer-mapping table */
9031 Perl_ptr_table_new(pTHX)
9034 Newxz(tbl, 1, PTR_TBL_t);
9037 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9041 #define PTR_TABLE_HASH(ptr) \
9042 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9045 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9046 following define) and at call to new_body_inline made below in
9047 Perl_ptr_table_store()
9050 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9052 /* map an existing pointer using a table */
9054 STATIC PTR_TBL_ENT_t *
9055 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9056 PTR_TBL_ENT_t *tblent;
9057 const UV hash = PTR_TABLE_HASH(sv);
9059 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9060 for (; tblent; tblent = tblent->next) {
9061 if (tblent->oldval == sv)
9068 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9070 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9071 return tblent ? tblent->newval : (void *) 0;
9074 /* add a new entry to a pointer-mapping table */
9077 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9079 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9082 tblent->newval = newsv;
9084 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9086 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9087 tblent->oldval = oldsv;
9088 tblent->newval = newsv;
9089 tblent->next = tbl->tbl_ary[entry];
9090 tbl->tbl_ary[entry] = tblent;
9092 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9093 ptr_table_split(tbl);
9097 /* double the hash bucket size of an existing ptr table */
9100 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9102 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9103 const UV oldsize = tbl->tbl_max + 1;
9104 UV newsize = oldsize * 2;
9107 Renew(ary, newsize, PTR_TBL_ENT_t*);
9108 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9109 tbl->tbl_max = --newsize;
9111 for (i=0; i < oldsize; i++, ary++) {
9112 PTR_TBL_ENT_t **curentp, **entp, *ent;
9115 curentp = ary + oldsize;
9116 for (entp = ary, ent = *ary; ent; ent = *entp) {
9117 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9119 ent->next = *curentp;
9129 /* remove all the entries from a ptr table */
9132 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9134 if (tbl && tbl->tbl_items) {
9135 register PTR_TBL_ENT_t **array = tbl->tbl_ary;
9136 UV riter = tbl->tbl_max;
9139 PTR_TBL_ENT_t *entry = array[riter];
9142 PTR_TBL_ENT_t * const oentry = entry;
9143 entry = entry->next;
9152 /* clear and free a ptr table */
9155 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9160 ptr_table_clear(tbl);
9161 Safefree(tbl->tbl_ary);
9167 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9170 SvRV_set(dstr, SvWEAKREF(sstr)
9171 ? sv_dup(SvRV(sstr), param)
9172 : sv_dup_inc(SvRV(sstr), param));
9175 else if (SvPVX_const(sstr)) {
9176 /* Has something there */
9178 /* Normal PV - clone whole allocated space */
9179 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9180 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9181 /* Not that normal - actually sstr is copy on write.
9182 But we are a true, independant SV, so: */
9183 SvREADONLY_off(dstr);
9188 /* Special case - not normally malloced for some reason */
9189 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9190 /* A "shared" PV - clone it as "shared" PV */
9192 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9196 /* Some other special case - random pointer */
9197 SvPV_set(dstr, SvPVX(sstr));
9203 if (SvTYPE(dstr) == SVt_RV)
9204 SvRV_set(dstr, NULL);
9210 /* duplicate an SV of any type (including AV, HV etc) */
9213 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9218 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9220 /* look for it in the table first */
9221 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9225 if(param->flags & CLONEf_JOIN_IN) {
9226 /** We are joining here so we don't want do clone
9227 something that is bad **/
9230 if(SvTYPE(sstr) == SVt_PVHV &&
9231 (hvname = HvNAME_get(sstr))) {
9232 /** don't clone stashes if they already exist **/
9233 return (SV*)gv_stashpv(hvname,0);
9237 /* create anew and remember what it is */
9240 #ifdef DEBUG_LEAKING_SCALARS
9241 dstr->sv_debug_optype = sstr->sv_debug_optype;
9242 dstr->sv_debug_line = sstr->sv_debug_line;
9243 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9244 dstr->sv_debug_cloned = 1;
9246 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9248 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9252 ptr_table_store(PL_ptr_table, sstr, dstr);
9255 SvFLAGS(dstr) = SvFLAGS(sstr);
9256 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9257 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9260 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9261 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9262 PL_watch_pvx, SvPVX_const(sstr));
9265 /* don't clone objects whose class has asked us not to */
9266 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9267 SvFLAGS(dstr) &= ~SVTYPEMASK;
9272 switch (SvTYPE(sstr)) {
9277 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9278 SvIV_set(dstr, SvIVX(sstr));
9281 SvANY(dstr) = new_XNV();
9282 SvNV_set(dstr, SvNVX(sstr));
9285 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9286 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9290 /* These are all the types that need complex bodies allocating. */
9292 const svtype sv_type = SvTYPE(sstr);
9293 const struct body_details *const sv_type_details
9294 = bodies_by_type + sv_type;
9298 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9303 if (GvUNIQUE((GV*)sstr)) {
9304 /* Do sharing here, and fall through */
9317 assert(sv_type_details->size);
9318 if (sv_type_details->arena) {
9319 new_body_inline(new_body, sv_type_details->size, sv_type);
9321 = (void*)((char*)new_body - sv_type_details->offset);
9323 new_body = new_NOARENA(sv_type_details);
9327 SvANY(dstr) = new_body;
9330 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9331 ((char*)SvANY(dstr)) + sv_type_details->offset,
9332 sv_type_details->copy, char);
9334 Copy(((char*)SvANY(sstr)),
9335 ((char*)SvANY(dstr)),
9336 sv_type_details->size + sv_type_details->offset, char);
9339 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9340 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9342 /* The Copy above means that all the source (unduplicated) pointers
9343 are now in the destination. We can check the flags and the
9344 pointers in either, but it's possible that there's less cache
9345 missing by always going for the destination.
9346 FIXME - instrument and check that assumption */
9347 if (sv_type >= SVt_PVMG) {
9349 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9351 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9354 /* The cast silences a GCC warning about unhandled types. */
9355 switch ((int)sv_type) {
9367 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9368 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9369 LvTARG(dstr) = dstr;
9370 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9371 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9373 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9376 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9377 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9378 /* Don't call sv_add_backref here as it's going to be created
9379 as part of the magic cloning of the symbol table. */
9380 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9381 (void)GpREFCNT_inc(GvGP(dstr));
9384 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9385 if (IoOFP(dstr) == IoIFP(sstr))
9386 IoOFP(dstr) = IoIFP(dstr);
9388 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9389 /* PL_rsfp_filters entries have fake IoDIRP() */
9390 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9391 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9392 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9393 /* I have no idea why fake dirp (rsfps)
9394 should be treated differently but otherwise
9395 we end up with leaks -- sky*/
9396 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9397 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9398 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9400 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9401 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9402 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9404 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9405 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9406 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9409 if (AvARRAY((AV*)sstr)) {
9410 SV **dst_ary, **src_ary;
9411 SSize_t items = AvFILLp((AV*)sstr) + 1;
9413 src_ary = AvARRAY((AV*)sstr);
9414 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9415 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9416 SvPV_set(dstr, (char*)dst_ary);
9417 AvALLOC((AV*)dstr) = dst_ary;
9418 if (AvREAL((AV*)sstr)) {
9420 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9424 *dst_ary++ = sv_dup(*src_ary++, param);
9426 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9427 while (items-- > 0) {
9428 *dst_ary++ = &PL_sv_undef;
9432 SvPV_set(dstr, Nullch);
9433 AvALLOC((AV*)dstr) = (SV**)NULL;
9440 if (HvARRAY((HV*)sstr)) {
9442 const bool sharekeys = !!HvSHAREKEYS(sstr);
9443 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9444 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9446 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9447 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9449 HvARRAY(dstr) = (HE**)darray;
9450 while (i <= sxhv->xhv_max) {
9451 const HE *source = HvARRAY(sstr)[i];
9452 HvARRAY(dstr)[i] = source
9453 ? he_dup(source, sharekeys, param) : 0;
9457 struct xpvhv_aux * const saux = HvAUX(sstr);
9458 struct xpvhv_aux * const daux = HvAUX(dstr);
9459 /* This flag isn't copied. */
9460 /* SvOOK_on(hv) attacks the IV flags. */
9461 SvFLAGS(dstr) |= SVf_OOK;
9463 hvname = saux->xhv_name;
9465 = hvname ? hek_dup(hvname, param) : hvname;
9467 daux->xhv_riter = saux->xhv_riter;
9468 daux->xhv_eiter = saux->xhv_eiter
9469 ? he_dup(saux->xhv_eiter,
9470 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9474 SvPV_set(dstr, Nullch);
9476 /* Record stashes for possible cloning in Perl_clone(). */
9478 av_push(param->stashes, dstr);
9483 /* NOTE: not refcounted */
9484 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9486 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9488 if (CvCONST(dstr)) {
9489 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9490 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9491 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9493 /* don't dup if copying back - CvGV isn't refcounted, so the
9494 * duped GV may never be freed. A bit of a hack! DAPM */
9495 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9496 Nullgv : gv_dup(CvGV(dstr), param) ;
9497 if (!(param->flags & CLONEf_COPY_STACKS)) {
9500 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9503 ? cv_dup( CvOUTSIDE(dstr), param)
9504 : cv_dup_inc(CvOUTSIDE(dstr), param);
9506 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9512 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9518 /* duplicate a context */
9521 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9526 return (PERL_CONTEXT*)NULL;
9528 /* look for it in the table first */
9529 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9533 /* create anew and remember what it is */
9534 Newxz(ncxs, max + 1, PERL_CONTEXT);
9535 ptr_table_store(PL_ptr_table, cxs, ncxs);
9538 PERL_CONTEXT *cx = &cxs[ix];
9539 PERL_CONTEXT *ncx = &ncxs[ix];
9540 ncx->cx_type = cx->cx_type;
9541 if (CxTYPE(cx) == CXt_SUBST) {
9542 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9545 ncx->blk_oldsp = cx->blk_oldsp;
9546 ncx->blk_oldcop = cx->blk_oldcop;
9547 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9548 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9549 ncx->blk_oldpm = cx->blk_oldpm;
9550 ncx->blk_gimme = cx->blk_gimme;
9551 switch (CxTYPE(cx)) {
9553 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9554 ? cv_dup_inc(cx->blk_sub.cv, param)
9555 : cv_dup(cx->blk_sub.cv,param));
9556 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9557 ? av_dup_inc(cx->blk_sub.argarray, param)
9559 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9560 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9561 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9562 ncx->blk_sub.lval = cx->blk_sub.lval;
9563 ncx->blk_sub.retop = cx->blk_sub.retop;
9566 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9567 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9568 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9569 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9570 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9571 ncx->blk_eval.retop = cx->blk_eval.retop;
9574 ncx->blk_loop.label = cx->blk_loop.label;
9575 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9576 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9577 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9578 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9579 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9580 ? cx->blk_loop.iterdata
9581 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9582 ncx->blk_loop.oldcomppad
9583 = (PAD*)ptr_table_fetch(PL_ptr_table,
9584 cx->blk_loop.oldcomppad);
9585 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9586 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9587 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9588 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9589 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9592 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9593 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9594 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9595 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9596 ncx->blk_sub.retop = cx->blk_sub.retop;
9608 /* duplicate a stack info structure */
9611 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9616 return (PERL_SI*)NULL;
9618 /* look for it in the table first */
9619 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9623 /* create anew and remember what it is */
9624 Newxz(nsi, 1, PERL_SI);
9625 ptr_table_store(PL_ptr_table, si, nsi);
9627 nsi->si_stack = av_dup_inc(si->si_stack, param);
9628 nsi->si_cxix = si->si_cxix;
9629 nsi->si_cxmax = si->si_cxmax;
9630 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9631 nsi->si_type = si->si_type;
9632 nsi->si_prev = si_dup(si->si_prev, param);
9633 nsi->si_next = si_dup(si->si_next, param);
9634 nsi->si_markoff = si->si_markoff;
9639 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9640 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9641 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9642 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9643 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9644 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9645 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9646 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9647 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9648 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9649 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9650 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9651 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9652 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9655 #define pv_dup_inc(p) SAVEPV(p)
9656 #define pv_dup(p) SAVEPV(p)
9657 #define svp_dup_inc(p,pp) any_dup(p,pp)
9659 /* map any object to the new equivent - either something in the
9660 * ptr table, or something in the interpreter structure
9664 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9671 /* look for it in the table first */
9672 ret = ptr_table_fetch(PL_ptr_table, v);
9676 /* see if it is part of the interpreter structure */
9677 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9678 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9686 /* duplicate the save stack */
9689 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9691 ANY * const ss = proto_perl->Tsavestack;
9692 const I32 max = proto_perl->Tsavestack_max;
9693 I32 ix = proto_perl->Tsavestack_ix;
9705 void (*dptr) (void*);
9706 void (*dxptr) (pTHX_ void*);
9708 Newxz(nss, max, ANY);
9711 I32 i = POPINT(ss,ix);
9714 case SAVEt_ITEM: /* normal string */
9715 sv = (SV*)POPPTR(ss,ix);
9716 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9717 sv = (SV*)POPPTR(ss,ix);
9718 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9720 case SAVEt_SV: /* scalar reference */
9721 sv = (SV*)POPPTR(ss,ix);
9722 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9723 gv = (GV*)POPPTR(ss,ix);
9724 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9726 case SAVEt_GENERIC_PVREF: /* generic char* */
9727 c = (char*)POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = pv_dup(c);
9729 ptr = POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9732 case SAVEt_SHARED_PVREF: /* char* in shared space */
9733 c = (char*)POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = savesharedpv(c);
9735 ptr = POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9738 case SAVEt_GENERIC_SVREF: /* generic sv */
9739 case SAVEt_SVREF: /* scalar reference */
9740 sv = (SV*)POPPTR(ss,ix);
9741 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9742 ptr = POPPTR(ss,ix);
9743 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9745 case SAVEt_AV: /* array reference */
9746 av = (AV*)POPPTR(ss,ix);
9747 TOPPTR(nss,ix) = av_dup_inc(av, param);
9748 gv = (GV*)POPPTR(ss,ix);
9749 TOPPTR(nss,ix) = gv_dup(gv, param);
9751 case SAVEt_HV: /* hash reference */
9752 hv = (HV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9754 gv = (GV*)POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = gv_dup(gv, param);
9757 case SAVEt_INT: /* int reference */
9758 ptr = POPPTR(ss,ix);
9759 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9760 intval = (int)POPINT(ss,ix);
9761 TOPINT(nss,ix) = intval;
9763 case SAVEt_LONG: /* long reference */
9764 ptr = POPPTR(ss,ix);
9765 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9766 longval = (long)POPLONG(ss,ix);
9767 TOPLONG(nss,ix) = longval;
9769 case SAVEt_I32: /* I32 reference */
9770 case SAVEt_I16: /* I16 reference */
9771 case SAVEt_I8: /* I8 reference */
9772 ptr = POPPTR(ss,ix);
9773 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9777 case SAVEt_IV: /* IV reference */
9778 ptr = POPPTR(ss,ix);
9779 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9783 case SAVEt_SPTR: /* SV* reference */
9784 ptr = POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9786 sv = (SV*)POPPTR(ss,ix);
9787 TOPPTR(nss,ix) = sv_dup(sv, param);
9789 case SAVEt_VPTR: /* random* reference */
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9792 ptr = POPPTR(ss,ix);
9793 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9795 case SAVEt_PPTR: /* char* reference */
9796 ptr = POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 c = (char*)POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = pv_dup(c);
9801 case SAVEt_HPTR: /* HV* reference */
9802 ptr = POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9804 hv = (HV*)POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = hv_dup(hv, param);
9807 case SAVEt_APTR: /* AV* reference */
9808 ptr = POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9810 av = (AV*)POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = av_dup(av, param);
9814 gv = (GV*)POPPTR(ss,ix);
9815 TOPPTR(nss,ix) = gv_dup(gv, param);
9817 case SAVEt_GP: /* scalar reference */
9818 gp = (GP*)POPPTR(ss,ix);
9819 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9820 (void)GpREFCNT_inc(gp);
9821 gv = (GV*)POPPTR(ss,ix);
9822 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9823 c = (char*)POPPTR(ss,ix);
9824 TOPPTR(nss,ix) = pv_dup(c);
9831 case SAVEt_MORTALIZESV:
9832 sv = (SV*)POPPTR(ss,ix);
9833 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9836 ptr = POPPTR(ss,ix);
9837 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9838 /* these are assumed to be refcounted properly */
9840 switch (((OP*)ptr)->op_type) {
9847 TOPPTR(nss,ix) = ptr;
9852 TOPPTR(nss,ix) = Nullop;
9857 TOPPTR(nss,ix) = Nullop;
9860 c = (char*)POPPTR(ss,ix);
9861 TOPPTR(nss,ix) = pv_dup_inc(c);
9864 longval = POPLONG(ss,ix);
9865 TOPLONG(nss,ix) = longval;
9868 hv = (HV*)POPPTR(ss,ix);
9869 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9870 c = (char*)POPPTR(ss,ix);
9871 TOPPTR(nss,ix) = pv_dup_inc(c);
9875 case SAVEt_DESTRUCTOR:
9876 ptr = POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9878 dptr = POPDPTR(ss,ix);
9879 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9880 any_dup(FPTR2DPTR(void *, dptr),
9883 case SAVEt_DESTRUCTOR_X:
9884 ptr = POPPTR(ss,ix);
9885 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9886 dxptr = POPDXPTR(ss,ix);
9887 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9888 any_dup(FPTR2DPTR(void *, dxptr),
9891 case SAVEt_REGCONTEXT:
9897 case SAVEt_STACK_POS: /* Position on Perl stack */
9901 case SAVEt_AELEM: /* array element */
9902 sv = (SV*)POPPTR(ss,ix);
9903 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9906 av = (AV*)POPPTR(ss,ix);
9907 TOPPTR(nss,ix) = av_dup_inc(av, param);
9909 case SAVEt_HELEM: /* hash element */
9910 sv = (SV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 sv = (SV*)POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9914 hv = (HV*)POPPTR(ss,ix);
9915 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9918 ptr = POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = ptr;
9926 av = (AV*)POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = av_dup(av, param);
9930 longval = (long)POPLONG(ss,ix);
9931 TOPLONG(nss,ix) = longval;
9932 ptr = POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9934 sv = (SV*)POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = sv_dup(sv, param);
9938 ptr = POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9940 longval = (long)POPBOOL(ss,ix);
9941 TOPBOOL(nss,ix) = (bool)longval;
9943 case SAVEt_SET_SVFLAGS:
9948 sv = (SV*)POPPTR(ss,ix);
9949 TOPPTR(nss,ix) = sv_dup(sv, param);
9952 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9960 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9961 * flag to the result. This is done for each stash before cloning starts,
9962 * so we know which stashes want their objects cloned */
9965 do_mark_cloneable_stash(pTHX_ SV *sv)
9967 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9969 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9970 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9971 if (cloner && GvCV(cloner)) {
9978 XPUSHs(sv_2mortal(newSVhek(hvname)));
9980 call_sv((SV*)GvCV(cloner), G_SCALAR);
9987 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
9995 =for apidoc perl_clone
9997 Create and return a new interpreter by cloning the current one.
9999 perl_clone takes these flags as parameters:
10001 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10002 without it we only clone the data and zero the stacks,
10003 with it we copy the stacks and the new perl interpreter is
10004 ready to run at the exact same point as the previous one.
10005 The pseudo-fork code uses COPY_STACKS while the
10006 threads->new doesn't.
10008 CLONEf_KEEP_PTR_TABLE
10009 perl_clone keeps a ptr_table with the pointer of the old
10010 variable as a key and the new variable as a value,
10011 this allows it to check if something has been cloned and not
10012 clone it again but rather just use the value and increase the
10013 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10014 the ptr_table using the function
10015 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10016 reason to keep it around is if you want to dup some of your own
10017 variable who are outside the graph perl scans, example of this
10018 code is in threads.xs create
10021 This is a win32 thing, it is ignored on unix, it tells perls
10022 win32host code (which is c++) to clone itself, this is needed on
10023 win32 if you want to run two threads at the same time,
10024 if you just want to do some stuff in a separate perl interpreter
10025 and then throw it away and return to the original one,
10026 you don't need to do anything.
10031 /* XXX the above needs expanding by someone who actually understands it ! */
10032 EXTERN_C PerlInterpreter *
10033 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10036 perl_clone(PerlInterpreter *proto_perl, UV flags)
10039 #ifdef PERL_IMPLICIT_SYS
10041 /* perlhost.h so we need to call into it
10042 to clone the host, CPerlHost should have a c interface, sky */
10044 if (flags & CLONEf_CLONE_HOST) {
10045 return perl_clone_host(proto_perl,flags);
10047 return perl_clone_using(proto_perl, flags,
10049 proto_perl->IMemShared,
10050 proto_perl->IMemParse,
10052 proto_perl->IStdIO,
10056 proto_perl->IProc);
10060 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10061 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10062 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10063 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10064 struct IPerlDir* ipD, struct IPerlSock* ipS,
10065 struct IPerlProc* ipP)
10067 /* XXX many of the string copies here can be optimized if they're
10068 * constants; they need to be allocated as common memory and just
10069 * their pointers copied. */
10072 CLONE_PARAMS clone_params;
10073 CLONE_PARAMS* param = &clone_params;
10075 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10076 /* for each stash, determine whether its objects should be cloned */
10077 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10078 PERL_SET_THX(my_perl);
10081 Poison(my_perl, 1, PerlInterpreter);
10083 PL_curcop = (COP *)Nullop;
10087 PL_savestack_ix = 0;
10088 PL_savestack_max = -1;
10089 PL_sig_pending = 0;
10090 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10091 # else /* !DEBUGGING */
10092 Zero(my_perl, 1, PerlInterpreter);
10093 # endif /* DEBUGGING */
10095 /* host pointers */
10097 PL_MemShared = ipMS;
10098 PL_MemParse = ipMP;
10105 #else /* !PERL_IMPLICIT_SYS */
10107 CLONE_PARAMS clone_params;
10108 CLONE_PARAMS* param = &clone_params;
10109 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10110 /* for each stash, determine whether its objects should be cloned */
10111 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10112 PERL_SET_THX(my_perl);
10115 Poison(my_perl, 1, PerlInterpreter);
10117 PL_curcop = (COP *)Nullop;
10121 PL_savestack_ix = 0;
10122 PL_savestack_max = -1;
10123 PL_sig_pending = 0;
10124 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10125 # else /* !DEBUGGING */
10126 Zero(my_perl, 1, PerlInterpreter);
10127 # endif /* DEBUGGING */
10128 #endif /* PERL_IMPLICIT_SYS */
10129 param->flags = flags;
10130 param->proto_perl = proto_perl;
10132 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10133 Zero(&PL_body_roots, 1, PL_body_roots);
10135 PL_nice_chunk = NULL;
10136 PL_nice_chunk_size = 0;
10138 PL_sv_objcount = 0;
10139 PL_sv_root = Nullsv;
10140 PL_sv_arenaroot = Nullsv;
10142 PL_debug = proto_perl->Idebug;
10144 PL_hash_seed = proto_perl->Ihash_seed;
10145 PL_rehash_seed = proto_perl->Irehash_seed;
10147 #ifdef USE_REENTRANT_API
10148 /* XXX: things like -Dm will segfault here in perlio, but doing
10149 * PERL_SET_CONTEXT(proto_perl);
10150 * breaks too many other things
10152 Perl_reentrant_init(aTHX);
10155 /* create SV map for pointer relocation */
10156 PL_ptr_table = ptr_table_new();
10158 /* initialize these special pointers as early as possible */
10159 SvANY(&PL_sv_undef) = NULL;
10160 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10161 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10162 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10164 SvANY(&PL_sv_no) = new_XPVNV();
10165 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10166 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10167 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10168 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10169 SvCUR_set(&PL_sv_no, 0);
10170 SvLEN_set(&PL_sv_no, 1);
10171 SvIV_set(&PL_sv_no, 0);
10172 SvNV_set(&PL_sv_no, 0);
10173 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10175 SvANY(&PL_sv_yes) = new_XPVNV();
10176 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10177 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10178 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10179 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10180 SvCUR_set(&PL_sv_yes, 1);
10181 SvLEN_set(&PL_sv_yes, 2);
10182 SvIV_set(&PL_sv_yes, 1);
10183 SvNV_set(&PL_sv_yes, 1);
10184 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10186 /* create (a non-shared!) shared string table */
10187 PL_strtab = newHV();
10188 HvSHAREKEYS_off(PL_strtab);
10189 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10190 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10192 PL_compiling = proto_perl->Icompiling;
10194 /* These two PVs will be free'd special way so must set them same way op.c does */
10195 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10196 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10198 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10199 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10201 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10202 if (!specialWARN(PL_compiling.cop_warnings))
10203 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10204 if (!specialCopIO(PL_compiling.cop_io))
10205 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10206 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10208 /* pseudo environmental stuff */
10209 PL_origargc = proto_perl->Iorigargc;
10210 PL_origargv = proto_perl->Iorigargv;
10212 param->stashes = newAV(); /* Setup array of objects to call clone on */
10214 /* Set tainting stuff before PerlIO_debug can possibly get called */
10215 PL_tainting = proto_perl->Itainting;
10216 PL_taint_warn = proto_perl->Itaint_warn;
10218 #ifdef PERLIO_LAYERS
10219 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10220 PerlIO_clone(aTHX_ proto_perl, param);
10223 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10224 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10225 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10226 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10227 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10228 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10231 PL_minus_c = proto_perl->Iminus_c;
10232 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10233 PL_localpatches = proto_perl->Ilocalpatches;
10234 PL_splitstr = proto_perl->Isplitstr;
10235 PL_preprocess = proto_perl->Ipreprocess;
10236 PL_minus_n = proto_perl->Iminus_n;
10237 PL_minus_p = proto_perl->Iminus_p;
10238 PL_minus_l = proto_perl->Iminus_l;
10239 PL_minus_a = proto_perl->Iminus_a;
10240 PL_minus_F = proto_perl->Iminus_F;
10241 PL_doswitches = proto_perl->Idoswitches;
10242 PL_dowarn = proto_perl->Idowarn;
10243 PL_doextract = proto_perl->Idoextract;
10244 PL_sawampersand = proto_perl->Isawampersand;
10245 PL_unsafe = proto_perl->Iunsafe;
10246 PL_inplace = SAVEPV(proto_perl->Iinplace);
10247 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10248 PL_perldb = proto_perl->Iperldb;
10249 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10250 PL_exit_flags = proto_perl->Iexit_flags;
10252 /* magical thingies */
10253 /* XXX time(&PL_basetime) when asked for? */
10254 PL_basetime = proto_perl->Ibasetime;
10255 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10257 PL_maxsysfd = proto_perl->Imaxsysfd;
10258 PL_multiline = proto_perl->Imultiline;
10259 PL_statusvalue = proto_perl->Istatusvalue;
10261 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10263 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10265 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10267 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10268 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10269 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10271 /* Clone the regex array */
10272 PL_regex_padav = newAV();
10274 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10275 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10277 av_push(PL_regex_padav,
10278 sv_dup_inc(regexen[0],param));
10279 for(i = 1; i <= len; i++) {
10280 if(SvREPADTMP(regexen[i])) {
10281 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10283 av_push(PL_regex_padav,
10285 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10286 SvIVX(regexen[i])), param)))
10291 PL_regex_pad = AvARRAY(PL_regex_padav);
10293 /* shortcuts to various I/O objects */
10294 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10295 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10296 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10297 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10298 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10299 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10301 /* shortcuts to regexp stuff */
10302 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10304 /* shortcuts to misc objects */
10305 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10307 /* shortcuts to debugging objects */
10308 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10309 PL_DBline = gv_dup(proto_perl->IDBline, param);
10310 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10311 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10312 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10313 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10314 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10315 PL_lineary = av_dup(proto_perl->Ilineary, param);
10316 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10318 /* symbol tables */
10319 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10320 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10321 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10322 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10323 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10325 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10326 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10327 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10328 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10329 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10330 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10332 PL_sub_generation = proto_perl->Isub_generation;
10334 /* funky return mechanisms */
10335 PL_forkprocess = proto_perl->Iforkprocess;
10337 /* subprocess state */
10338 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10340 /* internal state */
10341 PL_maxo = proto_perl->Imaxo;
10342 if (proto_perl->Iop_mask)
10343 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10345 PL_op_mask = Nullch;
10346 /* PL_asserting = proto_perl->Iasserting; */
10348 /* current interpreter roots */
10349 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10350 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10351 PL_main_start = proto_perl->Imain_start;
10352 PL_eval_root = proto_perl->Ieval_root;
10353 PL_eval_start = proto_perl->Ieval_start;
10355 /* runtime control stuff */
10356 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10357 PL_copline = proto_perl->Icopline;
10359 PL_filemode = proto_perl->Ifilemode;
10360 PL_lastfd = proto_perl->Ilastfd;
10361 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10364 PL_gensym = proto_perl->Igensym;
10365 PL_preambled = proto_perl->Ipreambled;
10366 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10367 PL_laststatval = proto_perl->Ilaststatval;
10368 PL_laststype = proto_perl->Ilaststype;
10369 PL_mess_sv = Nullsv;
10371 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10373 /* interpreter atexit processing */
10374 PL_exitlistlen = proto_perl->Iexitlistlen;
10375 if (PL_exitlistlen) {
10376 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10377 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10380 PL_exitlist = (PerlExitListEntry*)NULL;
10381 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10382 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10383 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10385 PL_profiledata = NULL;
10386 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10387 /* PL_rsfp_filters entries have fake IoDIRP() */
10388 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10390 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10392 PAD_CLONE_VARS(proto_perl, param);
10394 #ifdef HAVE_INTERP_INTERN
10395 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10398 /* more statics moved here */
10399 PL_generation = proto_perl->Igeneration;
10400 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10402 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10403 PL_in_clean_all = proto_perl->Iin_clean_all;
10405 PL_uid = proto_perl->Iuid;
10406 PL_euid = proto_perl->Ieuid;
10407 PL_gid = proto_perl->Igid;
10408 PL_egid = proto_perl->Iegid;
10409 PL_nomemok = proto_perl->Inomemok;
10410 PL_an = proto_perl->Ian;
10411 PL_evalseq = proto_perl->Ievalseq;
10412 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10413 PL_origalen = proto_perl->Iorigalen;
10414 #ifdef PERL_USES_PL_PIDSTATUS
10415 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10417 PL_osname = SAVEPV(proto_perl->Iosname);
10418 PL_sighandlerp = proto_perl->Isighandlerp;
10420 PL_runops = proto_perl->Irunops;
10422 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10425 PL_cshlen = proto_perl->Icshlen;
10426 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10429 PL_lex_state = proto_perl->Ilex_state;
10430 PL_lex_defer = proto_perl->Ilex_defer;
10431 PL_lex_expect = proto_perl->Ilex_expect;
10432 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10433 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10434 PL_lex_starts = proto_perl->Ilex_starts;
10435 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10436 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10437 PL_lex_op = proto_perl->Ilex_op;
10438 PL_lex_inpat = proto_perl->Ilex_inpat;
10439 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10440 PL_lex_brackets = proto_perl->Ilex_brackets;
10441 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10442 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10443 PL_lex_casemods = proto_perl->Ilex_casemods;
10444 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10445 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10447 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10448 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10449 PL_nexttoke = proto_perl->Inexttoke;
10451 /* XXX This is probably masking the deeper issue of why
10452 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10453 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10454 * (A little debugging with a watchpoint on it may help.)
10456 if (SvANY(proto_perl->Ilinestr)) {
10457 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10458 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10459 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10460 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10461 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10462 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10463 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10464 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10465 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10468 PL_linestr = NEWSV(65,79);
10469 sv_upgrade(PL_linestr,SVt_PVIV);
10470 sv_setpvn(PL_linestr,"",0);
10471 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10473 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10474 PL_pending_ident = proto_perl->Ipending_ident;
10475 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10477 PL_expect = proto_perl->Iexpect;
10479 PL_multi_start = proto_perl->Imulti_start;
10480 PL_multi_end = proto_perl->Imulti_end;
10481 PL_multi_open = proto_perl->Imulti_open;
10482 PL_multi_close = proto_perl->Imulti_close;
10484 PL_error_count = proto_perl->Ierror_count;
10485 PL_subline = proto_perl->Isubline;
10486 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10488 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10489 if (SvANY(proto_perl->Ilinestr)) {
10490 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10491 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10492 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10493 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10494 PL_last_lop_op = proto_perl->Ilast_lop_op;
10497 PL_last_uni = SvPVX(PL_linestr);
10498 PL_last_lop = SvPVX(PL_linestr);
10499 PL_last_lop_op = 0;
10501 PL_in_my = proto_perl->Iin_my;
10502 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10504 PL_cryptseen = proto_perl->Icryptseen;
10507 PL_hints = proto_perl->Ihints;
10509 PL_amagic_generation = proto_perl->Iamagic_generation;
10511 #ifdef USE_LOCALE_COLLATE
10512 PL_collation_ix = proto_perl->Icollation_ix;
10513 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10514 PL_collation_standard = proto_perl->Icollation_standard;
10515 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10516 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10517 #endif /* USE_LOCALE_COLLATE */
10519 #ifdef USE_LOCALE_NUMERIC
10520 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10521 PL_numeric_standard = proto_perl->Inumeric_standard;
10522 PL_numeric_local = proto_perl->Inumeric_local;
10523 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10524 #endif /* !USE_LOCALE_NUMERIC */
10526 /* utf8 character classes */
10527 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10528 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10529 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10530 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10531 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10532 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10533 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10534 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10535 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10536 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10537 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10538 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10539 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10540 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10541 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10542 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10543 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10544 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10545 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10546 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10548 /* Did the locale setup indicate UTF-8? */
10549 PL_utf8locale = proto_perl->Iutf8locale;
10550 /* Unicode features (see perlrun/-C) */
10551 PL_unicode = proto_perl->Iunicode;
10553 /* Pre-5.8 signals control */
10554 PL_signals = proto_perl->Isignals;
10556 /* times() ticks per second */
10557 PL_clocktick = proto_perl->Iclocktick;
10559 /* Recursion stopper for PerlIO_find_layer */
10560 PL_in_load_module = proto_perl->Iin_load_module;
10562 /* sort() routine */
10563 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10565 /* Not really needed/useful since the reenrant_retint is "volatile",
10566 * but do it for consistency's sake. */
10567 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10569 /* Hooks to shared SVs and locks. */
10570 PL_sharehook = proto_perl->Isharehook;
10571 PL_lockhook = proto_perl->Ilockhook;
10572 PL_unlockhook = proto_perl->Iunlockhook;
10573 PL_threadhook = proto_perl->Ithreadhook;
10575 PL_runops_std = proto_perl->Irunops_std;
10576 PL_runops_dbg = proto_perl->Irunops_dbg;
10578 #ifdef THREADS_HAVE_PIDS
10579 PL_ppid = proto_perl->Ippid;
10583 PL_last_swash_hv = NULL; /* reinits on demand */
10584 PL_last_swash_klen = 0;
10585 PL_last_swash_key[0]= '\0';
10586 PL_last_swash_tmps = (U8*)NULL;
10587 PL_last_swash_slen = 0;
10589 PL_glob_index = proto_perl->Iglob_index;
10590 PL_srand_called = proto_perl->Isrand_called;
10591 PL_uudmap['M'] = 0; /* reinits on demand */
10592 PL_bitcount = Nullch; /* reinits on demand */
10594 if (proto_perl->Ipsig_pend) {
10595 Newxz(PL_psig_pend, SIG_SIZE, int);
10598 PL_psig_pend = (int*)NULL;
10601 if (proto_perl->Ipsig_ptr) {
10602 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10603 Newxz(PL_psig_name, SIG_SIZE, SV*);
10604 for (i = 1; i < SIG_SIZE; i++) {
10605 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10606 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10610 PL_psig_ptr = (SV**)NULL;
10611 PL_psig_name = (SV**)NULL;
10614 /* thrdvar.h stuff */
10616 if (flags & CLONEf_COPY_STACKS) {
10617 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10618 PL_tmps_ix = proto_perl->Ttmps_ix;
10619 PL_tmps_max = proto_perl->Ttmps_max;
10620 PL_tmps_floor = proto_perl->Ttmps_floor;
10621 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10623 while (i <= PL_tmps_ix) {
10624 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10628 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10629 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10630 Newxz(PL_markstack, i, I32);
10631 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10632 - proto_perl->Tmarkstack);
10633 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10634 - proto_perl->Tmarkstack);
10635 Copy(proto_perl->Tmarkstack, PL_markstack,
10636 PL_markstack_ptr - PL_markstack + 1, I32);
10638 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10639 * NOTE: unlike the others! */
10640 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10641 PL_scopestack_max = proto_perl->Tscopestack_max;
10642 Newxz(PL_scopestack, PL_scopestack_max, I32);
10643 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10645 /* NOTE: si_dup() looks at PL_markstack */
10646 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10648 /* PL_curstack = PL_curstackinfo->si_stack; */
10649 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10650 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10652 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10653 PL_stack_base = AvARRAY(PL_curstack);
10654 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10655 - proto_perl->Tstack_base);
10656 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10658 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10659 * NOTE: unlike the others! */
10660 PL_savestack_ix = proto_perl->Tsavestack_ix;
10661 PL_savestack_max = proto_perl->Tsavestack_max;
10662 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10663 PL_savestack = ss_dup(proto_perl, param);
10667 ENTER; /* perl_destruct() wants to LEAVE; */
10670 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10671 PL_top_env = &PL_start_env;
10673 PL_op = proto_perl->Top;
10676 PL_Xpv = (XPV*)NULL;
10677 PL_na = proto_perl->Tna;
10679 PL_statbuf = proto_perl->Tstatbuf;
10680 PL_statcache = proto_perl->Tstatcache;
10681 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10682 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10684 PL_timesbuf = proto_perl->Ttimesbuf;
10687 PL_tainted = proto_perl->Ttainted;
10688 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10689 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10690 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10691 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10692 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10693 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10694 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10695 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10696 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10698 PL_restartop = proto_perl->Trestartop;
10699 PL_in_eval = proto_perl->Tin_eval;
10700 PL_delaymagic = proto_perl->Tdelaymagic;
10701 PL_dirty = proto_perl->Tdirty;
10702 PL_localizing = proto_perl->Tlocalizing;
10704 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10705 PL_hv_fetch_ent_mh = Nullhe;
10706 PL_modcount = proto_perl->Tmodcount;
10707 PL_lastgotoprobe = Nullop;
10708 PL_dumpindent = proto_perl->Tdumpindent;
10710 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10711 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10712 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10713 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10714 PL_efloatbuf = Nullch; /* reinits on demand */
10715 PL_efloatsize = 0; /* reinits on demand */
10719 PL_screamfirst = NULL;
10720 PL_screamnext = NULL;
10721 PL_maxscream = -1; /* reinits on demand */
10722 PL_lastscream = Nullsv;
10724 PL_watchaddr = NULL;
10725 PL_watchok = Nullch;
10727 PL_regdummy = proto_perl->Tregdummy;
10728 PL_regprecomp = Nullch;
10731 PL_colorset = 0; /* reinits PL_colors[] */
10732 /*PL_colors[6] = {0,0,0,0,0,0};*/
10733 PL_reginput = Nullch;
10734 PL_regbol = Nullch;
10735 PL_regeol = Nullch;
10736 PL_regstartp = (I32*)NULL;
10737 PL_regendp = (I32*)NULL;
10738 PL_reglastparen = (U32*)NULL;
10739 PL_reglastcloseparen = (U32*)NULL;
10740 PL_regtill = Nullch;
10741 PL_reg_start_tmp = (char**)NULL;
10742 PL_reg_start_tmpl = 0;
10743 PL_regdata = (struct reg_data*)NULL;
10746 PL_reg_eval_set = 0;
10748 PL_regprogram = (regnode*)NULL;
10750 PL_regcc = (CURCUR*)NULL;
10751 PL_reg_call_cc = (struct re_cc_state*)NULL;
10752 PL_reg_re = (regexp*)NULL;
10753 PL_reg_ganch = Nullch;
10754 PL_reg_sv = Nullsv;
10755 PL_reg_match_utf8 = FALSE;
10756 PL_reg_magic = (MAGIC*)NULL;
10758 PL_reg_oldcurpm = (PMOP*)NULL;
10759 PL_reg_curpm = (PMOP*)NULL;
10760 PL_reg_oldsaved = Nullch;
10761 PL_reg_oldsavedlen = 0;
10762 #ifdef PERL_OLD_COPY_ON_WRITE
10765 PL_reg_maxiter = 0;
10766 PL_reg_leftiter = 0;
10767 PL_reg_poscache = Nullch;
10768 PL_reg_poscache_size= 0;
10770 /* RE engine - function pointers */
10771 PL_regcompp = proto_perl->Tregcompp;
10772 PL_regexecp = proto_perl->Tregexecp;
10773 PL_regint_start = proto_perl->Tregint_start;
10774 PL_regint_string = proto_perl->Tregint_string;
10775 PL_regfree = proto_perl->Tregfree;
10777 PL_reginterp_cnt = 0;
10778 PL_reg_starttry = 0;
10780 /* Pluggable optimizer */
10781 PL_peepp = proto_perl->Tpeepp;
10783 PL_stashcache = newHV();
10785 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10786 ptr_table_free(PL_ptr_table);
10787 PL_ptr_table = NULL;
10790 /* Call the ->CLONE method, if it exists, for each of the stashes
10791 identified by sv_dup() above.
10793 while(av_len(param->stashes) != -1) {
10794 HV* const stash = (HV*) av_shift(param->stashes);
10795 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10796 if (cloner && GvCV(cloner)) {
10801 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10803 call_sv((SV*)GvCV(cloner), G_DISCARD);
10809 SvREFCNT_dec(param->stashes);
10811 /* orphaned? eg threads->new inside BEGIN or use */
10812 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10813 (void)SvREFCNT_inc(PL_compcv);
10814 SAVEFREESV(PL_compcv);
10820 #endif /* USE_ITHREADS */
10823 =head1 Unicode Support
10825 =for apidoc sv_recode_to_utf8
10827 The encoding is assumed to be an Encode object, on entry the PV
10828 of the sv is assumed to be octets in that encoding, and the sv
10829 will be converted into Unicode (and UTF-8).
10831 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10832 is not a reference, nothing is done to the sv. If the encoding is not
10833 an C<Encode::XS> Encoding object, bad things will happen.
10834 (See F<lib/encoding.pm> and L<Encode>).
10836 The PV of the sv is returned.
10841 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10844 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10858 Passing sv_yes is wrong - it needs to be or'ed set of constants
10859 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10860 remove converted chars from source.
10862 Both will default the value - let them.
10864 XPUSHs(&PL_sv_yes);
10867 call_method("decode", G_SCALAR);
10871 s = SvPV_const(uni, len);
10872 if (s != SvPVX_const(sv)) {
10873 SvGROW(sv, len + 1);
10874 Move(s, SvPVX(sv), len + 1, char);
10875 SvCUR_set(sv, len);
10882 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10886 =for apidoc sv_cat_decode
10888 The encoding is assumed to be an Encode object, the PV of the ssv is
10889 assumed to be octets in that encoding and decoding the input starts
10890 from the position which (PV + *offset) pointed to. The dsv will be
10891 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10892 when the string tstr appears in decoding output or the input ends on
10893 the PV of the ssv. The value which the offset points will be modified
10894 to the last input position on the ssv.
10896 Returns TRUE if the terminator was found, else returns FALSE.
10901 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10902 SV *ssv, int *offset, char *tstr, int tlen)
10906 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10917 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10918 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10920 call_method("cat_decode", G_SCALAR);
10922 ret = SvTRUE(TOPs);
10923 *offset = SvIV(offsv);
10929 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10934 /* ---------------------------------------------------------------------
10936 * support functions for report_uninit()
10939 /* the maxiumum size of array or hash where we will scan looking
10940 * for the undefined element that triggered the warning */
10942 #define FUV_MAX_SEARCH_SIZE 1000
10944 /* Look for an entry in the hash whose value has the same SV as val;
10945 * If so, return a mortal copy of the key. */
10948 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10951 register HE **array;
10954 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10955 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10958 array = HvARRAY(hv);
10960 for (i=HvMAX(hv); i>0; i--) {
10961 register HE *entry;
10962 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10963 if (HeVAL(entry) != val)
10965 if ( HeVAL(entry) == &PL_sv_undef ||
10966 HeVAL(entry) == &PL_sv_placeholder)
10970 if (HeKLEN(entry) == HEf_SVKEY)
10971 return sv_mortalcopy(HeKEY_sv(entry));
10972 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10978 /* Look for an entry in the array whose value has the same SV as val;
10979 * If so, return the index, otherwise return -1. */
10982 S_find_array_subscript(pTHX_ AV *av, SV* val)
10986 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10987 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10991 for (i=AvFILLp(av); i>=0; i--) {
10992 if (svp[i] == val && svp[i] != &PL_sv_undef)
10998 /* S_varname(): return the name of a variable, optionally with a subscript.
10999 * If gv is non-zero, use the name of that global, along with gvtype (one
11000 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11001 * targ. Depending on the value of the subscript_type flag, return:
11004 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11005 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11006 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11007 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11010 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11011 SV* keyname, I32 aindex, int subscript_type)
11014 SV * const name = sv_newmortal();
11017 buffer[0] = gvtype;
11020 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11022 gv_fullname4(name, gv, buffer, 0);
11024 if ((unsigned int)SvPVX(name)[1] <= 26) {
11026 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11028 /* Swap the 1 unprintable control character for the 2 byte pretty
11029 version - ie substr($name, 1, 1) = $buffer; */
11030 sv_insert(name, 1, 1, buffer, 2);
11035 CV * const cv = find_runcv(&unused);
11039 if (!cv || !CvPADLIST(cv))
11041 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11042 sv = *av_fetch(av, targ, FALSE);
11043 /* SvLEN in a pad name is not to be trusted */
11044 sv_setpv(name, SvPV_nolen_const(sv));
11047 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11048 SV * const sv = NEWSV(0,0);
11049 *SvPVX(name) = '$';
11050 Perl_sv_catpvf(aTHX_ name, "{%s}",
11051 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11054 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11055 *SvPVX(name) = '$';
11056 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11058 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11059 sv_insert(name, 0, 0, "within ", 7);
11066 =for apidoc find_uninit_var
11068 Find the name of the undefined variable (if any) that caused the operator o
11069 to issue a "Use of uninitialized value" warning.
11070 If match is true, only return a name if it's value matches uninit_sv.
11071 So roughly speaking, if a unary operator (such as OP_COS) generates a
11072 warning, then following the direct child of the op may yield an
11073 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11074 other hand, with OP_ADD there are two branches to follow, so we only print
11075 the variable name if we get an exact match.
11077 The name is returned as a mortal SV.
11079 Assumes that PL_op is the op that originally triggered the error, and that
11080 PL_comppad/PL_curpad points to the currently executing pad.
11086 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11094 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11095 uninit_sv == &PL_sv_placeholder)))
11098 switch (obase->op_type) {
11105 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11106 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11108 SV *keysv = Nullsv;
11109 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11111 if (pad) { /* @lex, %lex */
11112 sv = PAD_SVl(obase->op_targ);
11116 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11117 /* @global, %global */
11118 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11121 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11123 else /* @{expr}, %{expr} */
11124 return find_uninit_var(cUNOPx(obase)->op_first,
11128 /* attempt to find a match within the aggregate */
11130 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11132 subscript_type = FUV_SUBSCRIPT_HASH;
11135 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11137 subscript_type = FUV_SUBSCRIPT_ARRAY;
11140 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11143 return varname(gv, hash ? '%' : '@', obase->op_targ,
11144 keysv, index, subscript_type);
11148 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11150 return varname(Nullgv, '$', obase->op_targ,
11151 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11154 gv = cGVOPx_gv(obase);
11155 if (!gv || (match && GvSV(gv) != uninit_sv))
11157 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11160 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11163 av = (AV*)PAD_SV(obase->op_targ);
11164 if (!av || SvRMAGICAL(av))
11166 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11167 if (!svp || *svp != uninit_sv)
11170 return varname(Nullgv, '$', obase->op_targ,
11171 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11174 gv = cGVOPx_gv(obase);
11180 if (!av || SvRMAGICAL(av))
11182 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11183 if (!svp || *svp != uninit_sv)
11186 return varname(gv, '$', 0,
11187 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11192 o = cUNOPx(obase)->op_first;
11193 if (!o || o->op_type != OP_NULL ||
11194 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11196 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11200 if (PL_op == obase)
11201 /* $a[uninit_expr] or $h{uninit_expr} */
11202 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11205 o = cBINOPx(obase)->op_first;
11206 kid = cBINOPx(obase)->op_last;
11208 /* get the av or hv, and optionally the gv */
11210 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11211 sv = PAD_SV(o->op_targ);
11213 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11214 && cUNOPo->op_first->op_type == OP_GV)
11216 gv = cGVOPx_gv(cUNOPo->op_first);
11219 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11224 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11225 /* index is constant */
11229 if (obase->op_type == OP_HELEM) {
11230 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11231 if (!he || HeVAL(he) != uninit_sv)
11235 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11236 if (!svp || *svp != uninit_sv)
11240 if (obase->op_type == OP_HELEM)
11241 return varname(gv, '%', o->op_targ,
11242 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11244 return varname(gv, '@', o->op_targ, Nullsv,
11245 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11248 /* index is an expression;
11249 * attempt to find a match within the aggregate */
11250 if (obase->op_type == OP_HELEM) {
11251 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11253 return varname(gv, '%', o->op_targ,
11254 keysv, 0, FUV_SUBSCRIPT_HASH);
11257 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11259 return varname(gv, '@', o->op_targ,
11260 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11265 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11267 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11273 /* only examine RHS */
11274 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11277 o = cUNOPx(obase)->op_first;
11278 if (o->op_type == OP_PUSHMARK)
11281 if (!o->op_sibling) {
11282 /* one-arg version of open is highly magical */
11284 if (o->op_type == OP_GV) { /* open FOO; */
11286 if (match && GvSV(gv) != uninit_sv)
11288 return varname(gv, '$', 0,
11289 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11291 /* other possibilities not handled are:
11292 * open $x; or open my $x; should return '${*$x}'
11293 * open expr; should return '$'.expr ideally
11299 /* ops where $_ may be an implicit arg */
11303 if ( !(obase->op_flags & OPf_STACKED)) {
11304 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11305 ? PAD_SVl(obase->op_targ)
11308 sv = sv_newmortal();
11309 sv_setpvn(sv, "$_", 2);
11317 /* skip filehandle as it can't produce 'undef' warning */
11318 o = cUNOPx(obase)->op_first;
11319 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11320 o = o->op_sibling->op_sibling;
11327 match = 1; /* XS or custom code could trigger random warnings */
11332 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11333 return sv_2mortal(newSVpvn("${$/}", 5));
11338 if (!(obase->op_flags & OPf_KIDS))
11340 o = cUNOPx(obase)->op_first;
11346 /* if all except one arg are constant, or have no side-effects,
11347 * or are optimized away, then it's unambiguous */
11349 for (kid=o; kid; kid = kid->op_sibling) {
11351 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11352 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11353 || (kid->op_type == OP_PUSHMARK)
11357 if (o2) { /* more than one found */
11364 return find_uninit_var(o2, uninit_sv, match);
11366 /* scan all args */
11368 sv = find_uninit_var(o, uninit_sv, 1);
11380 =for apidoc report_uninit
11382 Print appropriate "Use of uninitialized variable" warning
11388 Perl_report_uninit(pTHX_ SV* uninit_sv)
11391 SV* varname = Nullsv;
11393 varname = find_uninit_var(PL_op, uninit_sv,0);
11395 sv_insert(varname, 0, 0, " ", 1);
11397 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11398 varname ? SvPV_nolen_const(varname) : "",
11399 " in ", OP_DESC(PL_op));
11402 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11408 * c-indentation-style: bsd
11409 * c-basic-offset: 4
11410 * indent-tabs-mode: t
11413 * ex: set ts=8 sts=4 sw=4 noet: