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_allocated, XPV, xpv_cur),
813 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
819 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, 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_allocated, XPVAV, xav_fill),
835 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
841 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv)) {
1894 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 == IS_NUMBER_IN_UV) {
1898 /* It's definitely an integer */
1899 if (numtype & IS_NUMBER_NEG) {
1900 if (value < (UV)IV_MIN)
1903 if (value < (UV)IV_MAX)
1908 if (ckWARN(WARN_NUMERIC))
1911 return I_V(Atof(SvPVX_const(sv)));
1916 assert(SvTYPE(sv) >= SVt_PVMG);
1917 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1918 } else if (SvTHINKFIRST(sv)) {
1922 SV * const tmpstr=AMG_CALLun(sv,numer);
1923 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1924 return SvIV(tmpstr);
1927 return PTR2IV(SvRV(sv));
1930 sv_force_normal_flags(sv, 0);
1932 if (SvREADONLY(sv) && !SvOK(sv)) {
1933 if (ckWARN(WARN_UNINITIALIZED))
1939 if (S_sv_2iuv_common(aTHX_ sv))
1942 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1943 PTR2UV(sv),SvIVX(sv)));
1944 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1948 =for apidoc sv_2uv_flags
1950 Return the unsigned integer value of an SV, doing any necessary string
1951 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1952 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1958 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1962 if (SvGMAGICAL(sv)) {
1963 if (flags & SV_GMAGIC)
1968 return U_V(SvNVX(sv));
1969 if (SvPOKp(sv) && SvLEN(sv)) {
1972 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1974 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1975 == IS_NUMBER_IN_UV) {
1976 /* It's definitely an integer */
1977 if (!(numtype & IS_NUMBER_NEG))
1981 if (ckWARN(WARN_NUMERIC))
1984 return U_V(Atof(SvPVX_const(sv)));
1989 assert(SvTYPE(sv) >= SVt_PVMG);
1990 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1991 } else if (SvTHINKFIRST(sv)) {
1995 SV *const tmpstr = AMG_CALLun(sv,numer);
1996 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1997 return SvUV(tmpstr);
2000 return PTR2UV(SvRV(sv));
2003 sv_force_normal_flags(sv, 0);
2005 if (SvREADONLY(sv) && !SvOK(sv)) {
2006 if (ckWARN(WARN_UNINITIALIZED))
2012 if (S_sv_2iuv_common(aTHX_ sv))
2016 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2017 PTR2UV(sv),SvUVX(sv)));
2018 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2024 Return the num value of an SV, doing any necessary string or integer
2025 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2032 Perl_sv_2nv(pTHX_ register SV *sv)
2036 if (SvGMAGICAL(sv)) {
2040 if (SvPOKp(sv) && SvLEN(sv)) {
2041 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2042 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2044 return Atof(SvPVX_const(sv));
2048 return (NV)SvUVX(sv);
2050 return (NV)SvIVX(sv);
2055 assert(SvTYPE(sv) >= SVt_PVMG);
2056 /* This falls through to the report_uninit near the end of the
2058 } else if (SvTHINKFIRST(sv)) {
2062 SV *const tmpstr = AMG_CALLun(sv,numer);
2063 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2064 return SvNV(tmpstr);
2067 return PTR2NV(SvRV(sv));
2070 sv_force_normal_flags(sv, 0);
2072 if (SvREADONLY(sv) && !SvOK(sv)) {
2073 if (ckWARN(WARN_UNINITIALIZED))
2078 if (SvTYPE(sv) < SVt_NV) {
2079 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2080 sv_upgrade(sv, SVt_NV);
2081 #ifdef USE_LONG_DOUBLE
2083 STORE_NUMERIC_LOCAL_SET_STANDARD();
2084 PerlIO_printf(Perl_debug_log,
2085 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2086 PTR2UV(sv), SvNVX(sv));
2087 RESTORE_NUMERIC_LOCAL();
2091 STORE_NUMERIC_LOCAL_SET_STANDARD();
2092 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2093 PTR2UV(sv), SvNVX(sv));
2094 RESTORE_NUMERIC_LOCAL();
2098 else if (SvTYPE(sv) < SVt_PVNV)
2099 sv_upgrade(sv, SVt_PVNV);
2104 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2105 #ifdef NV_PRESERVES_UV
2108 /* Only set the public NV OK flag if this NV preserves the IV */
2109 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2110 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2111 : (SvIVX(sv) == I_V(SvNVX(sv))))
2117 else if (SvPOKp(sv) && SvLEN(sv)) {
2119 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2120 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2122 #ifdef NV_PRESERVES_UV
2123 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2124 == IS_NUMBER_IN_UV) {
2125 /* It's definitely an integer */
2126 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2128 SvNV_set(sv, Atof(SvPVX_const(sv)));
2131 SvNV_set(sv, Atof(SvPVX_const(sv)));
2132 /* Only set the public NV OK flag if this NV preserves the value in
2133 the PV at least as well as an IV/UV would.
2134 Not sure how to do this 100% reliably. */
2135 /* if that shift count is out of range then Configure's test is
2136 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2138 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2139 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2140 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2141 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2142 /* Can't use strtol etc to convert this string, so don't try.
2143 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2146 /* value has been set. It may not be precise. */
2147 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2148 /* 2s complement assumption for (UV)IV_MIN */
2149 SvNOK_on(sv); /* Integer is too negative. */
2154 if (numtype & IS_NUMBER_NEG) {
2155 SvIV_set(sv, -(IV)value);
2156 } else if (value <= (UV)IV_MAX) {
2157 SvIV_set(sv, (IV)value);
2159 SvUV_set(sv, value);
2163 if (numtype & IS_NUMBER_NOT_INT) {
2164 /* I believe that even if the original PV had decimals,
2165 they are lost beyond the limit of the FP precision.
2166 However, neither is canonical, so both only get p
2167 flags. NWC, 2000/11/25 */
2168 /* Both already have p flags, so do nothing */
2170 const NV nv = SvNVX(sv);
2171 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2172 if (SvIVX(sv) == I_V(nv)) {
2175 /* It had no "." so it must be integer. */
2179 /* between IV_MAX and NV(UV_MAX).
2180 Could be slightly > UV_MAX */
2182 if (numtype & IS_NUMBER_NOT_INT) {
2183 /* UV and NV both imprecise. */
2185 const UV nv_as_uv = U_V(nv);
2187 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2196 #endif /* NV_PRESERVES_UV */
2199 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2201 assert (SvTYPE(sv) >= SVt_NV);
2202 /* Typically the caller expects that sv_any is not NULL now. */
2203 /* XXX Ilya implies that this is a bug in callers that assume this
2204 and ideally should be fixed. */
2207 #if defined(USE_LONG_DOUBLE)
2209 STORE_NUMERIC_LOCAL_SET_STANDARD();
2210 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2211 PTR2UV(sv), SvNVX(sv));
2212 RESTORE_NUMERIC_LOCAL();
2216 STORE_NUMERIC_LOCAL_SET_STANDARD();
2217 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2218 PTR2UV(sv), SvNVX(sv));
2219 RESTORE_NUMERIC_LOCAL();
2225 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2226 * UV as a string towards the end of buf, and return pointers to start and
2229 * We assume that buf is at least TYPE_CHARS(UV) long.
2233 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2235 char *ptr = buf + TYPE_CHARS(UV);
2236 char * const ebuf = ptr;
2249 *--ptr = '0' + (char)(uv % 10);
2257 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2258 * a regexp to its stringified form.
2262 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2263 const regexp * const re = (regexp *)mg->mg_obj;
2266 const char *fptr = "msix";
2271 bool need_newline = 0;
2272 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2274 while((ch = *fptr++)) {
2276 reflags[left++] = ch;
2279 reflags[right--] = ch;
2284 reflags[left] = '-';
2288 mg->mg_len = re->prelen + 4 + left;
2290 * If /x was used, we have to worry about a regex ending with a
2291 * comment later being embedded within another regex. If so, we don't
2292 * want this regex's "commentization" to leak out to the right part of
2293 * the enclosing regex, we must cap it with a newline.
2295 * So, if /x was used, we scan backwards from the end of the regex. If
2296 * we find a '#' before we find a newline, we need to add a newline
2297 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2298 * we don't need to add anything. -jfriedl
2300 if (PMf_EXTENDED & re->reganch) {
2301 const char *endptr = re->precomp + re->prelen;
2302 while (endptr >= re->precomp) {
2303 const char c = *(endptr--);
2305 break; /* don't need another */
2307 /* we end while in a comment, so we need a newline */
2308 mg->mg_len++; /* save space for it */
2309 need_newline = 1; /* note to add it */
2315 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2316 mg->mg_ptr[0] = '(';
2317 mg->mg_ptr[1] = '?';
2318 Copy(reflags, mg->mg_ptr+2, left, char);
2319 *(mg->mg_ptr+left+2) = ':';
2320 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2322 mg->mg_ptr[mg->mg_len - 2] = '\n';
2323 mg->mg_ptr[mg->mg_len - 1] = ')';
2324 mg->mg_ptr[mg->mg_len] = 0;
2326 PL_reginterp_cnt += re->program[0].next_off;
2328 if (re->reganch & ROPT_UTF8)
2338 =for apidoc sv_2pv_flags
2340 Returns a pointer to the string value of an SV, and sets *lp to its length.
2341 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2343 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2344 usually end up here too.
2350 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2359 if (SvGMAGICAL(sv)) {
2360 if (flags & SV_GMAGIC)
2365 if (flags & SV_MUTABLE_RETURN)
2366 return SvPVX_mutable(sv);
2367 if (flags & SV_CONST_RETURN)
2368 return (char *)SvPVX_const(sv);
2371 if (SvIOKp(sv) || SvNOKp(sv)) {
2372 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2376 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2377 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2379 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2382 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2383 /* Sneaky stuff here */
2384 SV * const tsv = newSVpvn(tbuf, len);
2394 #ifdef FIXNEGATIVEZERO
2395 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2401 SvUPGRADE(sv, SVt_PV);
2404 s = SvGROW_mutable(sv, len + 1);
2407 return memcpy(s, tbuf, len + 1);
2413 assert(SvTYPE(sv) >= SVt_PVMG);
2414 /* This falls through to the report_uninit near the end of the
2416 } else if (SvTHINKFIRST(sv)) {
2420 SV *const tmpstr = AMG_CALLun(sv,string);
2421 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2423 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2427 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2428 if (flags & SV_CONST_RETURN) {
2429 pv = (char *) SvPVX_const(tmpstr);
2431 pv = (flags & SV_MUTABLE_RETURN)
2432 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2435 *lp = SvCUR(tmpstr);
2437 pv = sv_2pv_flags(tmpstr, lp, flags);
2449 const SV *const referent = (SV*)SvRV(sv);
2452 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2453 } else if (SvTYPE(referent) == SVt_PVMG
2454 && ((SvFLAGS(referent) &
2455 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2456 == (SVs_OBJECT|SVs_SMG))
2457 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2458 return stringify_regexp(sv, mg, lp);
2460 const char *const typestr = sv_reftype(referent, 0);
2462 tsv = sv_newmortal();
2463 if (SvOBJECT(referent)) {
2464 const char *const name = HvNAME_get(SvSTASH(referent));
2465 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2466 name ? name : "__ANON__" , typestr,
2470 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2478 if (SvREADONLY(sv) && !SvOK(sv)) {
2479 if (ckWARN(WARN_UNINITIALIZED))
2486 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2487 /* I'm assuming that if both IV and NV are equally valid then
2488 converting the IV is going to be more efficient */
2489 const U32 isIOK = SvIOK(sv);
2490 const U32 isUIOK = SvIsUV(sv);
2491 char buf[TYPE_CHARS(UV)];
2494 if (SvTYPE(sv) < SVt_PVIV)
2495 sv_upgrade(sv, SVt_PVIV);
2496 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2497 /* inlined from sv_setpvn */
2498 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2499 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2500 SvCUR_set(sv, ebuf - ptr);
2510 else if (SvNOKp(sv)) {
2511 const int olderrno = errno;
2512 if (SvTYPE(sv) < SVt_PVNV)
2513 sv_upgrade(sv, SVt_PVNV);
2514 /* The +20 is pure guesswork. Configure test needed. --jhi */
2515 s = SvGROW_mutable(sv, NV_DIG + 20);
2516 /* some Xenix systems wipe out errno here */
2518 if (SvNVX(sv) == 0.0)
2519 (void)strcpy(s,"0");
2523 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2526 #ifdef FIXNEGATIVEZERO
2527 if (*s == '-' && s[1] == '0' && !s[2])
2537 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2541 if (SvTYPE(sv) < SVt_PV)
2542 /* Typically the caller expects that sv_any is not NULL now. */
2543 sv_upgrade(sv, SVt_PV);
2547 const STRLEN len = s - SvPVX_const(sv);
2553 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2554 PTR2UV(sv),SvPVX_const(sv)));
2555 if (flags & SV_CONST_RETURN)
2556 return (char *)SvPVX_const(sv);
2557 if (flags & SV_MUTABLE_RETURN)
2558 return SvPVX_mutable(sv);
2563 =for apidoc sv_copypv
2565 Copies a stringified representation of the source SV into the
2566 destination SV. Automatically performs any necessary mg_get and
2567 coercion of numeric values into strings. Guaranteed to preserve
2568 UTF-8 flag even from overloaded objects. Similar in nature to
2569 sv_2pv[_flags] but operates directly on an SV instead of just the
2570 string. Mostly uses sv_2pv_flags to do its work, except when that
2571 would lose the UTF-8'ness of the PV.
2577 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2580 const char * const s = SvPV_const(ssv,len);
2581 sv_setpvn(dsv,s,len);
2589 =for apidoc sv_2pvbyte
2591 Return a pointer to the byte-encoded representation of the SV, and set *lp
2592 to its length. May cause the SV to be downgraded from UTF-8 as a
2595 Usually accessed via the C<SvPVbyte> macro.
2601 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2603 sv_utf8_downgrade(sv,0);
2604 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2608 =for apidoc sv_2pvutf8
2610 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2611 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2613 Usually accessed via the C<SvPVutf8> macro.
2619 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2621 sv_utf8_upgrade(sv);
2622 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2627 =for apidoc sv_2bool
2629 This function is only called on magical items, and is only used by
2630 sv_true() or its macro equivalent.
2636 Perl_sv_2bool(pTHX_ register SV *sv)
2644 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2645 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2646 return (bool)SvTRUE(tmpsv);
2647 return SvRV(sv) != 0;
2650 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2652 (*sv->sv_u.svu_pv > '0' ||
2653 Xpvtmp->xpv_cur > 1 ||
2654 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2661 return SvIVX(sv) != 0;
2664 return SvNVX(sv) != 0.0;
2672 =for apidoc sv_utf8_upgrade
2674 Converts the PV of an SV to its UTF-8-encoded form.
2675 Forces the SV to string form if it is not already.
2676 Always sets the SvUTF8 flag to avoid future validity checks even
2677 if all the bytes have hibit clear.
2679 This is not as a general purpose byte encoding to Unicode interface:
2680 use the Encode extension for that.
2682 =for apidoc sv_utf8_upgrade_flags
2684 Converts the PV of an SV to its UTF-8-encoded form.
2685 Forces the SV to string form if it is not already.
2686 Always sets the SvUTF8 flag to avoid future validity checks even
2687 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2688 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2689 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2691 This is not as a general purpose byte encoding to Unicode interface:
2692 use the Encode extension for that.
2698 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2700 if (sv == &PL_sv_undef)
2704 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2705 (void) sv_2pv_flags(sv,&len, flags);
2709 (void) SvPV_force(sv,len);
2718 sv_force_normal_flags(sv, 0);
2721 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2722 sv_recode_to_utf8(sv, PL_encoding);
2723 else { /* Assume Latin-1/EBCDIC */
2724 /* This function could be much more efficient if we
2725 * had a FLAG in SVs to signal if there are any hibit
2726 * chars in the PV. Given that there isn't such a flag
2727 * make the loop as fast as possible. */
2728 const U8 * const s = (U8 *) SvPVX_const(sv);
2729 const U8 * const e = (U8 *) SvEND(sv);
2734 /* Check for hi bit */
2735 if (!NATIVE_IS_INVARIANT(ch)) {
2736 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2737 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2739 SvPV_free(sv); /* No longer using what was there before. */
2740 SvPV_set(sv, (char*)recoded);
2741 SvCUR_set(sv, len - 1);
2742 SvLEN_set(sv, len); /* No longer know the real size. */
2746 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2753 =for apidoc sv_utf8_downgrade
2755 Attempts to convert the PV of an SV from characters to bytes.
2756 If the PV contains a character beyond byte, this conversion will fail;
2757 in this case, either returns false or, if C<fail_ok> is not
2760 This is not as a general purpose Unicode to byte encoding interface:
2761 use the Encode extension for that.
2767 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2769 if (SvPOKp(sv) && SvUTF8(sv)) {
2775 sv_force_normal_flags(sv, 0);
2777 s = (U8 *) SvPV(sv, len);
2778 if (!utf8_to_bytes(s, &len)) {
2783 Perl_croak(aTHX_ "Wide character in %s",
2786 Perl_croak(aTHX_ "Wide character");
2797 =for apidoc sv_utf8_encode
2799 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2800 flag off so that it looks like octets again.
2806 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2808 (void) sv_utf8_upgrade(sv);
2810 sv_force_normal_flags(sv, 0);
2812 if (SvREADONLY(sv)) {
2813 Perl_croak(aTHX_ PL_no_modify);
2819 =for apidoc sv_utf8_decode
2821 If the PV of the SV is an octet sequence in UTF-8
2822 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2823 so that it looks like a character. If the PV contains only single-byte
2824 characters, the C<SvUTF8> flag stays being off.
2825 Scans PV for validity and returns false if the PV is invalid UTF-8.
2831 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2837 /* The octets may have got themselves encoded - get them back as
2840 if (!sv_utf8_downgrade(sv, TRUE))
2843 /* it is actually just a matter of turning the utf8 flag on, but
2844 * we want to make sure everything inside is valid utf8 first.
2846 c = (const U8 *) SvPVX_const(sv);
2847 if (!is_utf8_string(c, SvCUR(sv)+1))
2849 e = (const U8 *) SvEND(sv);
2852 if (!UTF8_IS_INVARIANT(ch)) {
2862 =for apidoc sv_setsv
2864 Copies the contents of the source SV C<ssv> into the destination SV
2865 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2866 function if the source SV needs to be reused. Does not handle 'set' magic.
2867 Loosely speaking, it performs a copy-by-value, obliterating any previous
2868 content of the destination.
2870 You probably want to use one of the assortment of wrappers, such as
2871 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2872 C<SvSetMagicSV_nosteal>.
2874 =for apidoc sv_setsv_flags
2876 Copies the contents of the source SV C<ssv> into the destination SV
2877 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2878 function if the source SV needs to be reused. Does not handle 'set' magic.
2879 Loosely speaking, it performs a copy-by-value, obliterating any previous
2880 content of the destination.
2881 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2882 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2883 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2884 and C<sv_setsv_nomg> are implemented in terms of this function.
2886 You probably want to use one of the assortment of wrappers, such as
2887 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2888 C<SvSetMagicSV_nosteal>.
2890 This is the primary function for copying scalars, and most other
2891 copy-ish functions and macros use this underneath.
2897 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2899 register U32 sflags;
2905 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2907 sstr = &PL_sv_undef;
2908 stype = SvTYPE(sstr);
2909 dtype = SvTYPE(dstr);
2914 /* need to nuke the magic */
2916 SvRMAGICAL_off(dstr);
2919 /* There's a lot of redundancy below but we're going for speed here */
2924 if (dtype != SVt_PVGV) {
2925 (void)SvOK_off(dstr);
2933 sv_upgrade(dstr, SVt_IV);
2936 sv_upgrade(dstr, SVt_PVNV);
2940 sv_upgrade(dstr, SVt_PVIV);
2943 (void)SvIOK_only(dstr);
2944 SvIV_set(dstr, SvIVX(sstr));
2947 if (SvTAINTED(sstr))
2958 sv_upgrade(dstr, SVt_NV);
2963 sv_upgrade(dstr, SVt_PVNV);
2966 SvNV_set(dstr, SvNVX(sstr));
2967 (void)SvNOK_only(dstr);
2968 if (SvTAINTED(sstr))
2976 sv_upgrade(dstr, SVt_RV);
2977 else if (dtype == SVt_PVGV &&
2978 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2981 if (GvIMPORTED(dstr) != GVf_IMPORTED
2982 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2984 GvIMPORTED_on(dstr);
2993 #ifdef PERL_OLD_COPY_ON_WRITE
2994 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
2995 if (dtype < SVt_PVIV)
2996 sv_upgrade(dstr, SVt_PVIV);
3003 sv_upgrade(dstr, SVt_PV);
3006 if (dtype < SVt_PVIV)
3007 sv_upgrade(dstr, SVt_PVIV);
3010 if (dtype < SVt_PVNV)
3011 sv_upgrade(dstr, SVt_PVNV);
3018 const char * const type = sv_reftype(sstr,0);
3020 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3022 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3027 if (dtype <= SVt_PVGV) {
3029 if (dtype != SVt_PVGV) {
3030 const char * const name = GvNAME(sstr);
3031 const STRLEN len = GvNAMELEN(sstr);
3032 /* don't upgrade SVt_PVLV: it can hold a glob */
3033 if (dtype != SVt_PVLV)
3034 sv_upgrade(dstr, SVt_PVGV);
3035 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3036 GvSTASH(dstr) = GvSTASH(sstr);
3038 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3039 GvNAME(dstr) = savepvn(name, len);
3040 GvNAMELEN(dstr) = len;
3041 SvFAKE_on(dstr); /* can coerce to non-glob */
3044 #ifdef GV_UNIQUE_CHECK
3045 if (GvUNIQUE((GV*)dstr)) {
3046 Perl_croak(aTHX_ PL_no_modify);
3050 (void)SvOK_off(dstr);
3051 GvINTRO_off(dstr); /* one-shot flag */
3053 GvGP(dstr) = gp_ref(GvGP(sstr));
3054 if (SvTAINTED(sstr))
3056 if (GvIMPORTED(dstr) != GVf_IMPORTED
3057 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3059 GvIMPORTED_on(dstr);
3067 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3069 if ((int)SvTYPE(sstr) != stype) {
3070 stype = SvTYPE(sstr);
3071 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3075 if (stype == SVt_PVLV)
3076 SvUPGRADE(dstr, SVt_PVNV);
3078 SvUPGRADE(dstr, (U32)stype);
3081 sflags = SvFLAGS(sstr);
3083 if (sflags & SVf_ROK) {
3084 if (dtype >= SVt_PV) {
3085 if (dtype == SVt_PVGV) {
3086 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3088 const int intro = GvINTRO(dstr);
3090 #ifdef GV_UNIQUE_CHECK
3091 if (GvUNIQUE((GV*)dstr)) {
3092 Perl_croak(aTHX_ PL_no_modify);
3097 GvINTRO_off(dstr); /* one-shot flag */
3098 GvLINE(dstr) = CopLINE(PL_curcop);
3099 GvEGV(dstr) = (GV*)dstr;
3102 switch (SvTYPE(sref)) {
3105 SAVEGENERICSV(GvAV(dstr));
3107 dref = (SV*)GvAV(dstr);
3108 GvAV(dstr) = (AV*)sref;
3109 if (!GvIMPORTED_AV(dstr)
3110 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3112 GvIMPORTED_AV_on(dstr);
3117 SAVEGENERICSV(GvHV(dstr));
3119 dref = (SV*)GvHV(dstr);
3120 GvHV(dstr) = (HV*)sref;
3121 if (!GvIMPORTED_HV(dstr)
3122 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3124 GvIMPORTED_HV_on(dstr);
3129 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3130 SvREFCNT_dec(GvCV(dstr));
3131 GvCV(dstr) = Nullcv;
3132 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3133 PL_sub_generation++;
3135 SAVEGENERICSV(GvCV(dstr));
3138 dref = (SV*)GvCV(dstr);
3139 if (GvCV(dstr) != (CV*)sref) {
3140 CV* const cv = GvCV(dstr);
3142 if (!GvCVGEN((GV*)dstr) &&
3143 (CvROOT(cv) || CvXSUB(cv)))
3145 /* Redefining a sub - warning is mandatory if
3146 it was a const and its value changed. */
3147 if (ckWARN(WARN_REDEFINE)
3149 && (!CvCONST((CV*)sref)
3150 || sv_cmp(cv_const_sv(cv),
3151 cv_const_sv((CV*)sref)))))
3153 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3155 ? "Constant subroutine %s::%s redefined"
3156 : "Subroutine %s::%s redefined",
3157 HvNAME_get(GvSTASH((GV*)dstr)),
3158 GvENAME((GV*)dstr));
3162 cv_ckproto(cv, (GV*)dstr,
3164 ? SvPVX_const(sref) : Nullch);
3166 GvCV(dstr) = (CV*)sref;
3167 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3168 GvASSUMECV_on(dstr);
3169 PL_sub_generation++;
3171 if (!GvIMPORTED_CV(dstr)
3172 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3174 GvIMPORTED_CV_on(dstr);
3179 SAVEGENERICSV(GvIOp(dstr));
3181 dref = (SV*)GvIOp(dstr);
3182 GvIOp(dstr) = (IO*)sref;
3186 SAVEGENERICSV(GvFORM(dstr));
3188 dref = (SV*)GvFORM(dstr);
3189 GvFORM(dstr) = (CV*)sref;
3193 SAVEGENERICSV(GvSV(dstr));
3195 dref = (SV*)GvSV(dstr);
3197 if (!GvIMPORTED_SV(dstr)
3198 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3200 GvIMPORTED_SV_on(dstr);
3206 if (SvTAINTED(sstr))
3210 if (SvPVX_const(dstr)) {
3216 (void)SvOK_off(dstr);
3217 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3219 if (sflags & SVp_NOK) {
3221 /* Only set the public OK flag if the source has public OK. */
3222 if (sflags & SVf_NOK)
3223 SvFLAGS(dstr) |= SVf_NOK;
3224 SvNV_set(dstr, SvNVX(sstr));
3226 if (sflags & SVp_IOK) {
3227 (void)SvIOKp_on(dstr);
3228 if (sflags & SVf_IOK)
3229 SvFLAGS(dstr) |= SVf_IOK;
3230 if (sflags & SVf_IVisUV)
3232 SvIV_set(dstr, SvIVX(sstr));
3234 if (SvAMAGIC(sstr)) {
3238 else if (sflags & SVp_POK) {
3242 * Check to see if we can just swipe the string. If so, it's a
3243 * possible small lose on short strings, but a big win on long ones.
3244 * It might even be a win on short strings if SvPVX_const(dstr)
3245 * has to be allocated and SvPVX_const(sstr) has to be freed.
3248 /* Whichever path we take through the next code, we want this true,
3249 and doing it now facilitates the COW check. */
3250 (void)SvPOK_only(dstr);
3253 /* We're not already COW */
3254 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3255 #ifndef PERL_OLD_COPY_ON_WRITE
3256 /* or we are, but dstr isn't a suitable target. */
3257 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3262 (sflags & SVs_TEMP) && /* slated for free anyway? */
3263 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3264 (!(flags & SV_NOSTEAL)) &&
3265 /* and we're allowed to steal temps */
3266 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3267 SvLEN(sstr) && /* and really is a string */
3268 /* and won't be needed again, potentially */
3269 !(PL_op && PL_op->op_type == OP_AASSIGN))
3270 #ifdef PERL_OLD_COPY_ON_WRITE
3271 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3272 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3273 && SvTYPE(sstr) >= SVt_PVIV)
3276 /* Failed the swipe test, and it's not a shared hash key either.
3277 Have to copy the string. */
3278 STRLEN len = SvCUR(sstr);
3279 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3280 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3281 SvCUR_set(dstr, len);
3282 *SvEND(dstr) = '\0';
3284 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3286 /* Either it's a shared hash key, or it's suitable for
3287 copy-on-write or we can swipe the string. */
3289 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3293 #ifdef PERL_OLD_COPY_ON_WRITE
3295 /* I believe I should acquire a global SV mutex if
3296 it's a COW sv (not a shared hash key) to stop
3297 it going un copy-on-write.
3298 If the source SV has gone un copy on write between up there
3299 and down here, then (assert() that) it is of the correct
3300 form to make it copy on write again */
3301 if ((sflags & (SVf_FAKE | SVf_READONLY))
3302 != (SVf_FAKE | SVf_READONLY)) {
3303 SvREADONLY_on(sstr);
3305 /* Make the source SV into a loop of 1.
3306 (about to become 2) */
3307 SV_COW_NEXT_SV_SET(sstr, sstr);
3311 /* Initial code is common. */
3312 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3317 /* making another shared SV. */
3318 STRLEN cur = SvCUR(sstr);
3319 STRLEN len = SvLEN(sstr);
3320 #ifdef PERL_OLD_COPY_ON_WRITE
3322 assert (SvTYPE(dstr) >= SVt_PVIV);
3323 /* SvIsCOW_normal */
3324 /* splice us in between source and next-after-source. */
3325 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3326 SV_COW_NEXT_SV_SET(sstr, dstr);
3327 SvPV_set(dstr, SvPVX_mutable(sstr));
3331 /* SvIsCOW_shared_hash */
3332 DEBUG_C(PerlIO_printf(Perl_debug_log,
3333 "Copy on write: Sharing hash\n"));
3335 assert (SvTYPE(dstr) >= SVt_PV);
3337 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3339 SvLEN_set(dstr, len);
3340 SvCUR_set(dstr, cur);
3341 SvREADONLY_on(dstr);
3343 /* Relesase a global SV mutex. */
3346 { /* Passes the swipe test. */
3347 SvPV_set(dstr, SvPVX_mutable(sstr));
3348 SvLEN_set(dstr, SvLEN(sstr));
3349 SvCUR_set(dstr, SvCUR(sstr));
3352 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3353 SvPV_set(sstr, Nullch);
3359 if (sflags & SVf_UTF8)
3361 if (sflags & SVp_NOK) {
3363 if (sflags & SVf_NOK)
3364 SvFLAGS(dstr) |= SVf_NOK;
3365 SvNV_set(dstr, SvNVX(sstr));
3367 if (sflags & SVp_IOK) {
3368 (void)SvIOKp_on(dstr);
3369 if (sflags & SVf_IOK)
3370 SvFLAGS(dstr) |= SVf_IOK;
3371 if (sflags & SVf_IVisUV)
3373 SvIV_set(dstr, SvIVX(sstr));
3376 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3377 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3378 smg->mg_ptr, smg->mg_len);
3379 SvRMAGICAL_on(dstr);
3382 else if (sflags & SVp_IOK) {
3383 if (sflags & SVf_IOK)
3384 (void)SvIOK_only(dstr);
3386 (void)SvOK_off(dstr);
3387 (void)SvIOKp_on(dstr);
3389 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3390 if (sflags & SVf_IVisUV)
3392 SvIV_set(dstr, SvIVX(sstr));
3393 if (sflags & SVp_NOK) {
3394 if (sflags & SVf_NOK)
3395 (void)SvNOK_on(dstr);
3397 (void)SvNOKp_on(dstr);
3398 SvNV_set(dstr, SvNVX(sstr));
3401 else if (sflags & SVp_NOK) {
3402 if (sflags & SVf_NOK)
3403 (void)SvNOK_only(dstr);
3405 (void)SvOK_off(dstr);
3408 SvNV_set(dstr, SvNVX(sstr));
3411 if (dtype == SVt_PVGV) {
3412 if (ckWARN(WARN_MISC))
3413 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3416 (void)SvOK_off(dstr);
3418 if (SvTAINTED(sstr))
3423 =for apidoc sv_setsv_mg
3425 Like C<sv_setsv>, but also handles 'set' magic.
3431 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3433 sv_setsv(dstr,sstr);
3437 #ifdef PERL_OLD_COPY_ON_WRITE
3439 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3441 STRLEN cur = SvCUR(sstr);
3442 STRLEN len = SvLEN(sstr);
3443 register char *new_pv;
3446 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3454 if (SvTHINKFIRST(dstr))
3455 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3456 else if (SvPVX_const(dstr))
3457 Safefree(SvPVX_const(dstr));
3461 SvUPGRADE(dstr, SVt_PVIV);
3463 assert (SvPOK(sstr));
3464 assert (SvPOKp(sstr));
3465 assert (!SvIOK(sstr));
3466 assert (!SvIOKp(sstr));
3467 assert (!SvNOK(sstr));
3468 assert (!SvNOKp(sstr));
3470 if (SvIsCOW(sstr)) {
3472 if (SvLEN(sstr) == 0) {
3473 /* source is a COW shared hash key. */
3474 DEBUG_C(PerlIO_printf(Perl_debug_log,
3475 "Fast copy on write: Sharing hash\n"));
3476 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3479 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3481 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3482 SvUPGRADE(sstr, SVt_PVIV);
3483 SvREADONLY_on(sstr);
3485 DEBUG_C(PerlIO_printf(Perl_debug_log,
3486 "Fast copy on write: Converting sstr to COW\n"));
3487 SV_COW_NEXT_SV_SET(dstr, sstr);
3489 SV_COW_NEXT_SV_SET(sstr, dstr);
3490 new_pv = SvPVX_mutable(sstr);
3493 SvPV_set(dstr, new_pv);
3494 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3497 SvLEN_set(dstr, len);
3498 SvCUR_set(dstr, cur);
3507 =for apidoc sv_setpvn
3509 Copies a string into an SV. The C<len> parameter indicates the number of
3510 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3511 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3517 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3519 register char *dptr;
3521 SV_CHECK_THINKFIRST_COW_DROP(sv);
3527 /* len is STRLEN which is unsigned, need to copy to signed */
3530 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3532 SvUPGRADE(sv, SVt_PV);
3534 dptr = SvGROW(sv, len + 1);
3535 Move(ptr,dptr,len,char);
3538 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3543 =for apidoc sv_setpvn_mg
3545 Like C<sv_setpvn>, but also handles 'set' magic.
3551 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3553 sv_setpvn(sv,ptr,len);
3558 =for apidoc sv_setpv
3560 Copies a string into an SV. The string must be null-terminated. Does not
3561 handle 'set' magic. See C<sv_setpv_mg>.
3567 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3569 register STRLEN len;
3571 SV_CHECK_THINKFIRST_COW_DROP(sv);
3577 SvUPGRADE(sv, SVt_PV);
3579 SvGROW(sv, len + 1);
3580 Move(ptr,SvPVX(sv),len+1,char);
3582 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3587 =for apidoc sv_setpv_mg
3589 Like C<sv_setpv>, but also handles 'set' magic.
3595 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3602 =for apidoc sv_usepvn
3604 Tells an SV to use C<ptr> to find its string value. Normally the string is
3605 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3606 The C<ptr> should point to memory that was allocated by C<malloc>. The
3607 string length, C<len>, must be supplied. This function will realloc the
3608 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3609 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3610 See C<sv_usepvn_mg>.
3616 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3619 SV_CHECK_THINKFIRST_COW_DROP(sv);
3620 SvUPGRADE(sv, SVt_PV);
3625 if (SvPVX_const(sv))
3628 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3629 ptr = saferealloc (ptr, allocate);
3632 SvLEN_set(sv, allocate);
3634 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3639 =for apidoc sv_usepvn_mg
3641 Like C<sv_usepvn>, but also handles 'set' magic.
3647 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3649 sv_usepvn(sv,ptr,len);
3653 #ifdef PERL_OLD_COPY_ON_WRITE
3654 /* Need to do this *after* making the SV normal, as we need the buffer
3655 pointer to remain valid until after we've copied it. If we let go too early,
3656 another thread could invalidate it by unsharing last of the same hash key
3657 (which it can do by means other than releasing copy-on-write Svs)
3658 or by changing the other copy-on-write SVs in the loop. */
3660 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3662 if (len) { /* this SV was SvIsCOW_normal(sv) */
3663 /* we need to find the SV pointing to us. */
3664 SV * const current = SV_COW_NEXT_SV(after);
3666 if (current == sv) {
3667 /* The SV we point to points back to us (there were only two of us
3669 Hence other SV is no longer copy on write either. */
3671 SvREADONLY_off(after);
3673 /* We need to follow the pointers around the loop. */
3675 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3678 /* don't loop forever if the structure is bust, and we have
3679 a pointer into a closed loop. */
3680 assert (current != after);
3681 assert (SvPVX_const(current) == pvx);
3683 /* Make the SV before us point to the SV after us. */
3684 SV_COW_NEXT_SV_SET(current, after);
3687 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3692 Perl_sv_release_IVX(pTHX_ register SV *sv)
3695 sv_force_normal_flags(sv, 0);
3701 =for apidoc sv_force_normal_flags
3703 Undo various types of fakery on an SV: if the PV is a shared string, make
3704 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3705 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3706 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3707 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3708 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3709 set to some other value.) In addition, the C<flags> parameter gets passed to
3710 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3711 with flags set to 0.
3717 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3719 #ifdef PERL_OLD_COPY_ON_WRITE
3720 if (SvREADONLY(sv)) {
3721 /* At this point I believe I should acquire a global SV mutex. */
3723 const char * const pvx = SvPVX_const(sv);
3724 const STRLEN len = SvLEN(sv);
3725 const STRLEN cur = SvCUR(sv);
3726 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3728 PerlIO_printf(Perl_debug_log,
3729 "Copy on write: Force normal %ld\n",
3735 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3736 SvPV_set(sv, (char*)0);
3738 if (flags & SV_COW_DROP_PV) {
3739 /* OK, so we don't need to copy our buffer. */
3742 SvGROW(sv, cur + 1);
3743 Move(pvx,SvPVX(sv),cur,char);
3747 sv_release_COW(sv, pvx, len, next);
3752 else if (IN_PERL_RUNTIME)
3753 Perl_croak(aTHX_ PL_no_modify);
3754 /* At this point I believe that I can drop the global SV mutex. */
3757 if (SvREADONLY(sv)) {
3759 const char * const pvx = SvPVX_const(sv);
3760 const STRLEN len = SvCUR(sv);
3763 SvPV_set(sv, Nullch);
3765 SvGROW(sv, len + 1);
3766 Move(pvx,SvPVX(sv),len,char);
3768 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3770 else if (IN_PERL_RUNTIME)
3771 Perl_croak(aTHX_ PL_no_modify);
3775 sv_unref_flags(sv, flags);
3776 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3783 Efficient removal of characters from the beginning of the string buffer.
3784 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3785 the string buffer. The C<ptr> becomes the first character of the adjusted
3786 string. Uses the "OOK hack".
3787 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3788 refer to the same chunk of data.
3794 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3796 register STRLEN delta;
3797 if (!ptr || !SvPOKp(sv))
3799 delta = ptr - SvPVX_const(sv);
3800 SV_CHECK_THINKFIRST(sv);
3801 if (SvTYPE(sv) < SVt_PVIV)
3802 sv_upgrade(sv,SVt_PVIV);
3805 if (!SvLEN(sv)) { /* make copy of shared string */
3806 const char *pvx = SvPVX_const(sv);
3807 const STRLEN len = SvCUR(sv);
3808 SvGROW(sv, len + 1);
3809 Move(pvx,SvPVX(sv),len,char);
3813 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3814 and we do that anyway inside the SvNIOK_off
3816 SvFLAGS(sv) |= SVf_OOK;
3819 SvLEN_set(sv, SvLEN(sv) - delta);
3820 SvCUR_set(sv, SvCUR(sv) - delta);
3821 SvPV_set(sv, SvPVX(sv) + delta);
3822 SvIV_set(sv, SvIVX(sv) + delta);
3826 =for apidoc sv_catpvn
3828 Concatenates the string onto the end of the string which is in the SV. The
3829 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3830 status set, then the bytes appended should be valid UTF-8.
3831 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3833 =for apidoc sv_catpvn_flags
3835 Concatenates the string onto the end of the string which is in the SV. The
3836 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3837 status set, then the bytes appended should be valid UTF-8.
3838 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3839 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3840 in terms of this function.
3846 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3849 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3851 SvGROW(dsv, dlen + slen + 1);
3853 sstr = SvPVX_const(dsv);
3854 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3855 SvCUR_set(dsv, SvCUR(dsv) + slen);
3857 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3859 if (flags & SV_SMAGIC)
3864 =for apidoc sv_catsv
3866 Concatenates the string from SV C<ssv> onto the end of the string in
3867 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3868 not 'set' magic. See C<sv_catsv_mg>.
3870 =for apidoc sv_catsv_flags
3872 Concatenates the string from SV C<ssv> onto the end of the string in
3873 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3874 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3875 and C<sv_catsv_nomg> are implemented in terms of this function.
3880 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3884 const char *spv = SvPV_const(ssv, slen);
3886 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3887 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3888 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3889 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3890 dsv->sv_flags doesn't have that bit set.
3891 Andy Dougherty 12 Oct 2001
3893 const I32 sutf8 = DO_UTF8(ssv);
3896 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3898 dutf8 = DO_UTF8(dsv);
3900 if (dutf8 != sutf8) {
3902 /* Not modifying source SV, so taking a temporary copy. */
3903 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3905 sv_utf8_upgrade(csv);
3906 spv = SvPV_const(csv, slen);
3909 sv_utf8_upgrade_nomg(dsv);
3911 sv_catpvn_nomg(dsv, spv, slen);
3914 if (flags & SV_SMAGIC)
3919 =for apidoc sv_catpv
3921 Concatenates the string onto the end of the string which is in the SV.
3922 If the SV has the UTF-8 status set, then the bytes appended should be
3923 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3928 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3930 register STRLEN len;
3936 junk = SvPV_force(sv, tlen);
3938 SvGROW(sv, tlen + len + 1);
3940 ptr = SvPVX_const(sv);
3941 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3942 SvCUR_set(sv, SvCUR(sv) + len);
3943 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3948 =for apidoc sv_catpv_mg
3950 Like C<sv_catpv>, but also handles 'set' magic.
3956 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3965 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3966 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3973 Perl_newSV(pTHX_ STRLEN len)
3979 sv_upgrade(sv, SVt_PV);
3980 SvGROW(sv, len + 1);
3985 =for apidoc sv_magicext
3987 Adds magic to an SV, upgrading it if necessary. Applies the
3988 supplied vtable and returns a pointer to the magic added.
3990 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
3991 In particular, you can add magic to SvREADONLY SVs, and add more than
3992 one instance of the same 'how'.
3994 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
3995 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
3996 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
3997 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
3999 (This is now used as a subroutine by C<sv_magic>.)
4004 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4005 const char* name, I32 namlen)
4009 if (SvTYPE(sv) < SVt_PVMG) {
4010 SvUPGRADE(sv, SVt_PVMG);
4012 Newxz(mg, 1, MAGIC);
4013 mg->mg_moremagic = SvMAGIC(sv);
4014 SvMAGIC_set(sv, mg);
4016 /* Sometimes a magic contains a reference loop, where the sv and
4017 object refer to each other. To prevent a reference loop that
4018 would prevent such objects being freed, we look for such loops
4019 and if we find one we avoid incrementing the object refcount.
4021 Note we cannot do this to avoid self-tie loops as intervening RV must
4022 have its REFCNT incremented to keep it in existence.
4025 if (!obj || obj == sv ||
4026 how == PERL_MAGIC_arylen ||
4027 how == PERL_MAGIC_qr ||
4028 how == PERL_MAGIC_symtab ||
4029 (SvTYPE(obj) == SVt_PVGV &&
4030 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4031 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4032 GvFORM(obj) == (CV*)sv)))
4037 mg->mg_obj = SvREFCNT_inc(obj);
4038 mg->mg_flags |= MGf_REFCOUNTED;
4041 /* Normal self-ties simply pass a null object, and instead of
4042 using mg_obj directly, use the SvTIED_obj macro to produce a
4043 new RV as needed. For glob "self-ties", we are tieing the PVIO
4044 with an RV obj pointing to the glob containing the PVIO. In
4045 this case, to avoid a reference loop, we need to weaken the
4049 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4050 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4056 mg->mg_len = namlen;
4059 mg->mg_ptr = savepvn(name, namlen);
4060 else if (namlen == HEf_SVKEY)
4061 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4063 mg->mg_ptr = (char *) name;
4065 mg->mg_virtual = vtable;
4069 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4074 =for apidoc sv_magic
4076 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4077 then adds a new magic item of type C<how> to the head of the magic list.
4079 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4080 handling of the C<name> and C<namlen> arguments.
4082 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4083 to add more than one instance of the same 'how'.
4089 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4091 const MGVTBL *vtable;
4094 #ifdef PERL_OLD_COPY_ON_WRITE
4096 sv_force_normal_flags(sv, 0);
4098 if (SvREADONLY(sv)) {
4100 /* its okay to attach magic to shared strings; the subsequent
4101 * upgrade to PVMG will unshare the string */
4102 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4105 && how != PERL_MAGIC_regex_global
4106 && how != PERL_MAGIC_bm
4107 && how != PERL_MAGIC_fm
4108 && how != PERL_MAGIC_sv
4109 && how != PERL_MAGIC_backref
4112 Perl_croak(aTHX_ PL_no_modify);
4115 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4116 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4117 /* sv_magic() refuses to add a magic of the same 'how' as an
4120 if (how == PERL_MAGIC_taint)
4128 vtable = &PL_vtbl_sv;
4130 case PERL_MAGIC_overload:
4131 vtable = &PL_vtbl_amagic;
4133 case PERL_MAGIC_overload_elem:
4134 vtable = &PL_vtbl_amagicelem;
4136 case PERL_MAGIC_overload_table:
4137 vtable = &PL_vtbl_ovrld;
4140 vtable = &PL_vtbl_bm;
4142 case PERL_MAGIC_regdata:
4143 vtable = &PL_vtbl_regdata;
4145 case PERL_MAGIC_regdatum:
4146 vtable = &PL_vtbl_regdatum;
4148 case PERL_MAGIC_env:
4149 vtable = &PL_vtbl_env;
4152 vtable = &PL_vtbl_fm;
4154 case PERL_MAGIC_envelem:
4155 vtable = &PL_vtbl_envelem;
4157 case PERL_MAGIC_regex_global:
4158 vtable = &PL_vtbl_mglob;
4160 case PERL_MAGIC_isa:
4161 vtable = &PL_vtbl_isa;
4163 case PERL_MAGIC_isaelem:
4164 vtable = &PL_vtbl_isaelem;
4166 case PERL_MAGIC_nkeys:
4167 vtable = &PL_vtbl_nkeys;
4169 case PERL_MAGIC_dbfile:
4172 case PERL_MAGIC_dbline:
4173 vtable = &PL_vtbl_dbline;
4175 #ifdef USE_LOCALE_COLLATE
4176 case PERL_MAGIC_collxfrm:
4177 vtable = &PL_vtbl_collxfrm;
4179 #endif /* USE_LOCALE_COLLATE */
4180 case PERL_MAGIC_tied:
4181 vtable = &PL_vtbl_pack;
4183 case PERL_MAGIC_tiedelem:
4184 case PERL_MAGIC_tiedscalar:
4185 vtable = &PL_vtbl_packelem;
4188 vtable = &PL_vtbl_regexp;
4190 case PERL_MAGIC_sig:
4191 vtable = &PL_vtbl_sig;
4193 case PERL_MAGIC_sigelem:
4194 vtable = &PL_vtbl_sigelem;
4196 case PERL_MAGIC_taint:
4197 vtable = &PL_vtbl_taint;
4199 case PERL_MAGIC_uvar:
4200 vtable = &PL_vtbl_uvar;
4202 case PERL_MAGIC_vec:
4203 vtable = &PL_vtbl_vec;
4205 case PERL_MAGIC_arylen_p:
4206 case PERL_MAGIC_rhash:
4207 case PERL_MAGIC_symtab:
4208 case PERL_MAGIC_vstring:
4211 case PERL_MAGIC_utf8:
4212 vtable = &PL_vtbl_utf8;
4214 case PERL_MAGIC_substr:
4215 vtable = &PL_vtbl_substr;
4217 case PERL_MAGIC_defelem:
4218 vtable = &PL_vtbl_defelem;
4220 case PERL_MAGIC_glob:
4221 vtable = &PL_vtbl_glob;
4223 case PERL_MAGIC_arylen:
4224 vtable = &PL_vtbl_arylen;
4226 case PERL_MAGIC_pos:
4227 vtable = &PL_vtbl_pos;
4229 case PERL_MAGIC_backref:
4230 vtable = &PL_vtbl_backref;
4232 case PERL_MAGIC_ext:
4233 /* Reserved for use by extensions not perl internals. */
4234 /* Useful for attaching extension internal data to perl vars. */
4235 /* Note that multiple extensions may clash if magical scalars */
4236 /* etc holding private data from one are passed to another. */
4240 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4243 /* Rest of work is done else where */
4244 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4247 case PERL_MAGIC_taint:
4250 case PERL_MAGIC_ext:
4251 case PERL_MAGIC_dbfile:
4258 =for apidoc sv_unmagic
4260 Removes all magic of type C<type> from an SV.
4266 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4270 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4273 for (mg = *mgp; mg; mg = *mgp) {
4274 if (mg->mg_type == type) {
4275 const MGVTBL* const vtbl = mg->mg_virtual;
4276 *mgp = mg->mg_moremagic;
4277 if (vtbl && vtbl->svt_free)
4278 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4279 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4281 Safefree(mg->mg_ptr);
4282 else if (mg->mg_len == HEf_SVKEY)
4283 SvREFCNT_dec((SV*)mg->mg_ptr);
4284 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4285 Safefree(mg->mg_ptr);
4287 if (mg->mg_flags & MGf_REFCOUNTED)
4288 SvREFCNT_dec(mg->mg_obj);
4292 mgp = &mg->mg_moremagic;
4296 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4303 =for apidoc sv_rvweaken
4305 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4306 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4307 push a back-reference to this RV onto the array of backreferences
4308 associated with that magic.
4314 Perl_sv_rvweaken(pTHX_ SV *sv)
4317 if (!SvOK(sv)) /* let undefs pass */
4320 Perl_croak(aTHX_ "Can't weaken a nonreference");
4321 else if (SvWEAKREF(sv)) {
4322 if (ckWARN(WARN_MISC))
4323 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4327 Perl_sv_add_backref(aTHX_ tsv, sv);
4333 /* Give tsv backref magic if it hasn't already got it, then push a
4334 * back-reference to sv onto the array associated with the backref magic.
4338 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4342 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4343 av = (AV*)mg->mg_obj;
4346 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4347 /* av now has a refcnt of 2, which avoids it getting freed
4348 * before us during global cleanup. The extra ref is removed
4349 * by magic_killbackrefs() when tsv is being freed */
4351 if (AvFILLp(av) >= AvMAX(av)) {
4352 av_extend(av, AvFILLp(av)+1);
4354 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4357 /* delete a back-reference to ourselves from the backref magic associated
4358 * with the SV we point to.
4362 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4368 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4369 if (PL_in_clean_all)
4372 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4373 Perl_croak(aTHX_ "panic: del_backref");
4374 av = (AV *)mg->mg_obj;
4376 /* We shouldn't be in here more than once, but for paranoia reasons lets
4378 for (i = AvFILLp(av); i >= 0; i--) {
4380 const SSize_t fill = AvFILLp(av);
4382 /* We weren't the last entry.
4383 An unordered list has this property that you can take the
4384 last element off the end to fill the hole, and it's still
4385 an unordered list :-)
4390 AvFILLp(av) = fill - 1;
4396 =for apidoc sv_insert
4398 Inserts a string at the specified offset/length within the SV. Similar to
4399 the Perl substr() function.
4405 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4409 register char *midend;
4410 register char *bigend;
4416 Perl_croak(aTHX_ "Can't modify non-existent substring");
4417 SvPV_force(bigstr, curlen);
4418 (void)SvPOK_only_UTF8(bigstr);
4419 if (offset + len > curlen) {
4420 SvGROW(bigstr, offset+len+1);
4421 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4422 SvCUR_set(bigstr, offset+len);
4426 i = littlelen - len;
4427 if (i > 0) { /* string might grow */
4428 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4429 mid = big + offset + len;
4430 midend = bigend = big + SvCUR(bigstr);
4433 while (midend > mid) /* shove everything down */
4434 *--bigend = *--midend;
4435 Move(little,big+offset,littlelen,char);
4436 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4441 Move(little,SvPVX(bigstr)+offset,len,char);
4446 big = SvPVX(bigstr);
4449 bigend = big + SvCUR(bigstr);
4451 if (midend > bigend)
4452 Perl_croak(aTHX_ "panic: sv_insert");
4454 if (mid - big > bigend - midend) { /* faster to shorten from end */
4456 Move(little, mid, littlelen,char);
4459 i = bigend - midend;
4461 Move(midend, mid, i,char);
4465 SvCUR_set(bigstr, mid - big);
4467 else if ((i = mid - big)) { /* faster from front */
4468 midend -= littlelen;
4470 sv_chop(bigstr,midend-i);
4475 Move(little, mid, littlelen,char);
4477 else if (littlelen) {
4478 midend -= littlelen;
4479 sv_chop(bigstr,midend);
4480 Move(little,midend,littlelen,char);
4483 sv_chop(bigstr,midend);
4489 =for apidoc sv_replace
4491 Make the first argument a copy of the second, then delete the original.
4492 The target SV physically takes over ownership of the body of the source SV
4493 and inherits its flags; however, the target keeps any magic it owns,
4494 and any magic in the source is discarded.
4495 Note that this is a rather specialist SV copying operation; most of the
4496 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4502 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4504 const U32 refcnt = SvREFCNT(sv);
4505 SV_CHECK_THINKFIRST_COW_DROP(sv);
4506 if (SvREFCNT(nsv) != 1) {
4507 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4508 UVuf " != 1)", (UV) SvREFCNT(nsv));
4510 if (SvMAGICAL(sv)) {
4514 sv_upgrade(nsv, SVt_PVMG);
4515 SvMAGIC_set(nsv, SvMAGIC(sv));
4516 SvFLAGS(nsv) |= SvMAGICAL(sv);
4518 SvMAGIC_set(sv, NULL);
4522 assert(!SvREFCNT(sv));
4523 #ifdef DEBUG_LEAKING_SCALARS
4524 sv->sv_flags = nsv->sv_flags;
4525 sv->sv_any = nsv->sv_any;
4526 sv->sv_refcnt = nsv->sv_refcnt;
4527 sv->sv_u = nsv->sv_u;
4529 StructCopy(nsv,sv,SV);
4531 /* Currently could join these into one piece of pointer arithmetic, but
4532 it would be unclear. */
4533 if(SvTYPE(sv) == SVt_IV)
4535 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4536 else if (SvTYPE(sv) == SVt_RV) {
4537 SvANY(sv) = &sv->sv_u.svu_rv;
4541 #ifdef PERL_OLD_COPY_ON_WRITE
4542 if (SvIsCOW_normal(nsv)) {
4543 /* We need to follow the pointers around the loop to make the
4544 previous SV point to sv, rather than nsv. */
4547 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4550 assert(SvPVX_const(current) == SvPVX_const(nsv));
4552 /* Make the SV before us point to the SV after us. */
4554 PerlIO_printf(Perl_debug_log, "previous is\n");
4556 PerlIO_printf(Perl_debug_log,
4557 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4558 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4560 SV_COW_NEXT_SV_SET(current, sv);
4563 SvREFCNT(sv) = refcnt;
4564 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4570 =for apidoc sv_clear
4572 Clear an SV: call any destructors, free up any memory used by the body,
4573 and free the body itself. The SV's head is I<not> freed, although
4574 its type is set to all 1's so that it won't inadvertently be assumed
4575 to be live during global destruction etc.
4576 This function should only be called when REFCNT is zero. Most of the time
4577 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4584 Perl_sv_clear(pTHX_ register SV *sv)
4587 const U32 type = SvTYPE(sv);
4588 const struct body_details *const sv_type_details
4589 = bodies_by_type + type;
4592 assert(SvREFCNT(sv) == 0);
4598 if (PL_defstash) { /* Still have a symbol table? */
4603 stash = SvSTASH(sv);
4604 destructor = StashHANDLER(stash,DESTROY);
4606 SV* const tmpref = newRV(sv);
4607 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4609 PUSHSTACKi(PERLSI_DESTROY);
4614 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4620 if(SvREFCNT(tmpref) < 2) {
4621 /* tmpref is not kept alive! */
4623 SvRV_set(tmpref, NULL);
4626 SvREFCNT_dec(tmpref);
4628 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4632 if (PL_in_clean_objs)
4633 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4635 /* DESTROY gave object new lease on life */
4641 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4642 SvOBJECT_off(sv); /* Curse the object. */
4643 if (type != SVt_PVIO)
4644 --PL_sv_objcount; /* XXX Might want something more general */
4647 if (type >= SVt_PVMG) {
4650 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4651 SvREFCNT_dec(SvSTASH(sv));
4656 IoIFP(sv) != PerlIO_stdin() &&
4657 IoIFP(sv) != PerlIO_stdout() &&
4658 IoIFP(sv) != PerlIO_stderr())
4660 io_close((IO*)sv, FALSE);
4662 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4663 PerlDir_close(IoDIRP(sv));
4664 IoDIRP(sv) = (DIR*)NULL;
4665 Safefree(IoTOP_NAME(sv));
4666 Safefree(IoFMT_NAME(sv));
4667 Safefree(IoBOTTOM_NAME(sv));
4682 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4683 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4684 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4685 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4687 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4688 SvREFCNT_dec(LvTARG(sv));
4692 Safefree(GvNAME(sv));
4693 /* If we're in a stash, we don't own a reference to it. However it does
4694 have a back reference to us, which needs to be cleared. */
4696 sv_del_backref((SV*)GvSTASH(sv), sv);
4701 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4703 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4704 /* Don't even bother with turning off the OOK flag. */
4709 SV *target = SvRV(sv);
4711 sv_del_backref(target, sv);
4713 SvREFCNT_dec(target);
4715 #ifdef PERL_OLD_COPY_ON_WRITE
4716 else if (SvPVX_const(sv)) {
4718 /* I believe I need to grab the global SV mutex here and
4719 then recheck the COW status. */
4721 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4724 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4725 SV_COW_NEXT_SV(sv));
4726 /* And drop it here. */
4728 } else if (SvLEN(sv)) {
4729 Safefree(SvPVX_const(sv));
4733 else if (SvPVX_const(sv) && SvLEN(sv))
4734 Safefree(SvPVX_mutable(sv));
4735 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4736 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4745 SvFLAGS(sv) &= SVf_BREAK;
4746 SvFLAGS(sv) |= SVTYPEMASK;
4748 if (sv_type_details->arena) {
4749 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4750 &PL_body_roots[type]);
4752 else if (sv_type_details->size) {
4753 my_safefree(SvANY(sv));
4758 =for apidoc sv_newref
4760 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4767 Perl_sv_newref(pTHX_ SV *sv)
4777 Decrement an SV's reference count, and if it drops to zero, call
4778 C<sv_clear> to invoke destructors and free up any memory used by
4779 the body; finally, deallocate the SV's head itself.
4780 Normally called via a wrapper macro C<SvREFCNT_dec>.
4786 Perl_sv_free(pTHX_ SV *sv)
4791 if (SvREFCNT(sv) == 0) {
4792 if (SvFLAGS(sv) & SVf_BREAK)
4793 /* this SV's refcnt has been artificially decremented to
4794 * trigger cleanup */
4796 if (PL_in_clean_all) /* All is fair */
4798 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4799 /* make sure SvREFCNT(sv)==0 happens very seldom */
4800 SvREFCNT(sv) = (~(U32)0)/2;
4803 if (ckWARN_d(WARN_INTERNAL)) {
4804 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4805 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4806 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4807 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4808 Perl_dump_sv_child(aTHX_ sv);
4813 if (--(SvREFCNT(sv)) > 0)
4815 Perl_sv_free2(aTHX_ sv);
4819 Perl_sv_free2(pTHX_ SV *sv)
4824 if (ckWARN_d(WARN_DEBUGGING))
4825 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4826 "Attempt to free temp prematurely: SV 0x%"UVxf
4827 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4831 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4832 /* make sure SvREFCNT(sv)==0 happens very seldom */
4833 SvREFCNT(sv) = (~(U32)0)/2;
4844 Returns the length of the string in the SV. Handles magic and type
4845 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4851 Perl_sv_len(pTHX_ register SV *sv)
4859 len = mg_length(sv);
4861 (void)SvPV_const(sv, len);
4866 =for apidoc sv_len_utf8
4868 Returns the number of characters in the string in an SV, counting wide
4869 UTF-8 bytes as a single character. Handles magic and type coercion.
4875 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4876 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4877 * (Note that the mg_len is not the length of the mg_ptr field.)
4882 Perl_sv_len_utf8(pTHX_ register SV *sv)
4888 return mg_length(sv);
4892 const U8 *s = (U8*)SvPV_const(sv, len);
4893 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4895 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4897 #ifdef PERL_UTF8_CACHE_ASSERT
4898 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4902 ulen = Perl_utf8_length(aTHX_ s, s + len);
4903 if (!mg && !SvREADONLY(sv)) {
4904 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4905 mg = mg_find(sv, PERL_MAGIC_utf8);
4915 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4916 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4917 * between UTF-8 and byte offsets. There are two (substr offset and substr
4918 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4919 * and byte offset) cache positions.
4921 * The mg_len field is used by sv_len_utf8(), see its comments.
4922 * Note that the mg_len is not the length of the mg_ptr field.
4926 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4927 I32 offsetp, const U8 *s, const U8 *start)
4931 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4933 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4937 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4939 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4940 (*mgp)->mg_ptr = (char *) *cachep;
4944 (*cachep)[i] = offsetp;
4945 (*cachep)[i+1] = s - start;
4953 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4954 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4955 * between UTF-8 and byte offsets. See also the comments of
4956 * S_utf8_mg_pos_init().
4960 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)
4964 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4966 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4967 if (*mgp && (*mgp)->mg_ptr) {
4968 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4969 ASSERT_UTF8_CACHE(*cachep);
4970 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4972 else { /* We will skip to the right spot. */
4977 /* The assumption is that going backward is half
4978 * the speed of going forward (that's where the
4979 * 2 * backw in the below comes from). (The real
4980 * figure of course depends on the UTF-8 data.) */
4982 if ((*cachep)[i] > (STRLEN)uoff) {
4984 backw = (*cachep)[i] - (STRLEN)uoff;
4986 if (forw < 2 * backw)
4989 p = start + (*cachep)[i+1];
4991 /* Try this only for the substr offset (i == 0),
4992 * not for the substr length (i == 2). */
4993 else if (i == 0) { /* (*cachep)[i] < uoff */
4994 const STRLEN ulen = sv_len_utf8(sv);
4996 if ((STRLEN)uoff < ulen) {
4997 forw = (STRLEN)uoff - (*cachep)[i];
4998 backw = ulen - (STRLEN)uoff;
5000 if (forw < 2 * backw)
5001 p = start + (*cachep)[i+1];
5006 /* If the string is not long enough for uoff,
5007 * we could extend it, but not at this low a level. */
5011 if (forw < 2 * backw) {
5018 while (UTF8_IS_CONTINUATION(*p))
5023 /* Update the cache. */
5024 (*cachep)[i] = (STRLEN)uoff;
5025 (*cachep)[i+1] = p - start;
5027 /* Drop the stale "length" cache */
5036 if (found) { /* Setup the return values. */
5037 *offsetp = (*cachep)[i+1];
5038 *sp = start + *offsetp;
5041 *offsetp = send - start;
5043 else if (*sp < start) {
5049 #ifdef PERL_UTF8_CACHE_ASSERT
5054 while (n-- && s < send)
5058 assert(*offsetp == s - start);
5059 assert((*cachep)[0] == (STRLEN)uoff);
5060 assert((*cachep)[1] == *offsetp);
5062 ASSERT_UTF8_CACHE(*cachep);
5071 =for apidoc sv_pos_u2b
5073 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5074 the start of the string, to a count of the equivalent number of bytes; if
5075 lenp is non-zero, it does the same to lenp, but this time starting from
5076 the offset, rather than from the start of the string. Handles magic and
5083 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5084 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5085 * byte offsets. See also the comments of S_utf8_mg_pos().
5090 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5098 start = (U8*)SvPV_const(sv, len);
5102 const U8 *s = start;
5103 I32 uoffset = *offsetp;
5104 const U8 * const send = s + len;
5108 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5110 if (!found && uoffset > 0) {
5111 while (s < send && uoffset--)
5115 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5117 *offsetp = s - start;
5122 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5126 if (!found && *lenp > 0) {
5129 while (s < send && ulen--)
5133 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5137 ASSERT_UTF8_CACHE(cache);
5149 =for apidoc sv_pos_b2u
5151 Converts the value pointed to by offsetp from a count of bytes from the
5152 start of the string, to a count of the equivalent number of UTF-8 chars.
5153 Handles magic and type coercion.
5159 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5160 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5161 * byte offsets. See also the comments of S_utf8_mg_pos().
5166 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5174 s = (const U8*)SvPV_const(sv, len);
5175 if ((I32)len < *offsetp)
5176 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5178 const U8* send = s + *offsetp;
5180 STRLEN *cache = NULL;
5184 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5185 mg = mg_find(sv, PERL_MAGIC_utf8);
5186 if (mg && mg->mg_ptr) {
5187 cache = (STRLEN *) mg->mg_ptr;
5188 if (cache[1] == (STRLEN)*offsetp) {
5189 /* An exact match. */
5190 *offsetp = cache[0];
5194 else if (cache[1] < (STRLEN)*offsetp) {
5195 /* We already know part of the way. */
5198 /* Let the below loop do the rest. */
5200 else { /* cache[1] > *offsetp */
5201 /* We already know all of the way, now we may
5202 * be able to walk back. The same assumption
5203 * is made as in S_utf8_mg_pos(), namely that
5204 * walking backward is twice slower than
5205 * walking forward. */
5206 const STRLEN forw = *offsetp;
5207 STRLEN backw = cache[1] - *offsetp;
5209 if (!(forw < 2 * backw)) {
5210 const U8 *p = s + cache[1];
5217 while (UTF8_IS_CONTINUATION(*p)) {
5225 *offsetp = cache[0];
5227 /* Drop the stale "length" cache */
5235 ASSERT_UTF8_CACHE(cache);
5241 /* Call utf8n_to_uvchr() to validate the sequence
5242 * (unless a simple non-UTF character) */
5243 if (!UTF8_IS_INVARIANT(*s))
5244 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5253 if (!SvREADONLY(sv)) {
5255 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5256 mg = mg_find(sv, PERL_MAGIC_utf8);
5261 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5262 mg->mg_ptr = (char *) cache;
5267 cache[1] = *offsetp;
5268 /* Drop the stale "length" cache */
5281 Returns a boolean indicating whether the strings in the two SVs are
5282 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5283 coerce its args to strings if necessary.
5289 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5297 SV* svrecode = Nullsv;
5304 pv1 = SvPV_const(sv1, cur1);
5311 pv2 = SvPV_const(sv2, cur2);
5313 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5314 /* Differing utf8ness.
5315 * Do not UTF8size the comparands as a side-effect. */
5318 svrecode = newSVpvn(pv2, cur2);
5319 sv_recode_to_utf8(svrecode, PL_encoding);
5320 pv2 = SvPV_const(svrecode, cur2);
5323 svrecode = newSVpvn(pv1, cur1);
5324 sv_recode_to_utf8(svrecode, PL_encoding);
5325 pv1 = SvPV_const(svrecode, cur1);
5327 /* Now both are in UTF-8. */
5329 SvREFCNT_dec(svrecode);
5334 bool is_utf8 = TRUE;
5337 /* sv1 is the UTF-8 one,
5338 * if is equal it must be downgrade-able */
5339 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5345 /* sv2 is the UTF-8 one,
5346 * if is equal it must be downgrade-able */
5347 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5353 /* Downgrade not possible - cannot be eq */
5361 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5364 SvREFCNT_dec(svrecode);
5375 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5376 string in C<sv1> is less than, equal to, or greater than the string in
5377 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5378 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5384 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5387 const char *pv1, *pv2;
5390 SV *svrecode = Nullsv;
5397 pv1 = SvPV_const(sv1, cur1);
5404 pv2 = SvPV_const(sv2, cur2);
5406 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5407 /* Differing utf8ness.
5408 * Do not UTF8size the comparands as a side-effect. */
5411 svrecode = newSVpvn(pv2, cur2);
5412 sv_recode_to_utf8(svrecode, PL_encoding);
5413 pv2 = SvPV_const(svrecode, cur2);
5416 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5421 svrecode = newSVpvn(pv1, cur1);
5422 sv_recode_to_utf8(svrecode, PL_encoding);
5423 pv1 = SvPV_const(svrecode, cur1);
5426 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5432 cmp = cur2 ? -1 : 0;
5436 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5439 cmp = retval < 0 ? -1 : 1;
5440 } else if (cur1 == cur2) {
5443 cmp = cur1 < cur2 ? -1 : 1;
5448 SvREFCNT_dec(svrecode);
5457 =for apidoc sv_cmp_locale
5459 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5460 'use bytes' aware, handles get magic, and will coerce its args to strings
5461 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5467 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5469 #ifdef USE_LOCALE_COLLATE
5475 if (PL_collation_standard)
5479 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5481 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5483 if (!pv1 || !len1) {
5494 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5497 return retval < 0 ? -1 : 1;
5500 * When the result of collation is equality, that doesn't mean
5501 * that there are no differences -- some locales exclude some
5502 * characters from consideration. So to avoid false equalities,
5503 * we use the raw string as a tiebreaker.
5509 #endif /* USE_LOCALE_COLLATE */
5511 return sv_cmp(sv1, sv2);
5515 #ifdef USE_LOCALE_COLLATE
5518 =for apidoc sv_collxfrm
5520 Add Collate Transform magic to an SV if it doesn't already have it.
5522 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5523 scalar data of the variable, but transformed to such a format that a normal
5524 memory comparison can be used to compare the data according to the locale
5531 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5535 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5536 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5542 Safefree(mg->mg_ptr);
5543 s = SvPV_const(sv, len);
5544 if ((xf = mem_collxfrm(s, len, &xlen))) {
5545 if (SvREADONLY(sv)) {
5548 return xf + sizeof(PL_collation_ix);
5551 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5552 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5565 if (mg && mg->mg_ptr) {
5567 return mg->mg_ptr + sizeof(PL_collation_ix);
5575 #endif /* USE_LOCALE_COLLATE */
5580 Get a line from the filehandle and store it into the SV, optionally
5581 appending to the currently-stored string.
5587 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5591 register STDCHAR rslast;
5592 register STDCHAR *bp;
5598 if (SvTHINKFIRST(sv))
5599 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5600 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5602 However, perlbench says it's slower, because the existing swipe code
5603 is faster than copy on write.
5604 Swings and roundabouts. */
5605 SvUPGRADE(sv, SVt_PV);
5610 if (PerlIO_isutf8(fp)) {
5612 sv_utf8_upgrade_nomg(sv);
5613 sv_pos_u2b(sv,&append,0);
5615 } else if (SvUTF8(sv)) {
5616 SV * const tsv = NEWSV(0,0);
5617 sv_gets(tsv, fp, 0);
5618 sv_utf8_upgrade_nomg(tsv);
5619 SvCUR_set(sv,append);
5622 goto return_string_or_null;
5627 if (PerlIO_isutf8(fp))
5630 if (IN_PERL_COMPILETIME) {
5631 /* we always read code in line mode */
5635 else if (RsSNARF(PL_rs)) {
5636 /* If it is a regular disk file use size from stat() as estimate
5637 of amount we are going to read - may result in malloc-ing
5638 more memory than we realy need if layers bellow reduce
5639 size we read (e.g. CRLF or a gzip layer)
5642 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5643 const Off_t offset = PerlIO_tell(fp);
5644 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5645 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5651 else if (RsRECORD(PL_rs)) {
5655 /* Grab the size of the record we're getting */
5656 recsize = SvIV(SvRV(PL_rs));
5657 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5660 /* VMS wants read instead of fread, because fread doesn't respect */
5661 /* RMS record boundaries. This is not necessarily a good thing to be */
5662 /* doing, but we've got no other real choice - except avoid stdio
5663 as implementation - perhaps write a :vms layer ?
5665 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5667 bytesread = PerlIO_read(fp, buffer, recsize);
5671 SvCUR_set(sv, bytesread += append);
5672 buffer[bytesread] = '\0';
5673 goto return_string_or_null;
5675 else if (RsPARA(PL_rs)) {
5681 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5682 if (PerlIO_isutf8(fp)) {
5683 rsptr = SvPVutf8(PL_rs, rslen);
5686 if (SvUTF8(PL_rs)) {
5687 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5688 Perl_croak(aTHX_ "Wide character in $/");
5691 rsptr = SvPV_const(PL_rs, rslen);
5695 rslast = rslen ? rsptr[rslen - 1] : '\0';
5697 if (rspara) { /* have to do this both before and after */
5698 do { /* to make sure file boundaries work right */
5701 i = PerlIO_getc(fp);
5705 PerlIO_ungetc(fp,i);
5711 /* See if we know enough about I/O mechanism to cheat it ! */
5713 /* This used to be #ifdef test - it is made run-time test for ease
5714 of abstracting out stdio interface. One call should be cheap
5715 enough here - and may even be a macro allowing compile
5719 if (PerlIO_fast_gets(fp)) {
5722 * We're going to steal some values from the stdio struct
5723 * and put EVERYTHING in the innermost loop into registers.
5725 register STDCHAR *ptr;
5729 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5730 /* An ungetc()d char is handled separately from the regular
5731 * buffer, so we getc() it back out and stuff it in the buffer.
5733 i = PerlIO_getc(fp);
5734 if (i == EOF) return 0;
5735 *(--((*fp)->_ptr)) = (unsigned char) i;
5739 /* Here is some breathtakingly efficient cheating */
5741 cnt = PerlIO_get_cnt(fp); /* get count into register */
5742 /* make sure we have the room */
5743 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5744 /* Not room for all of it
5745 if we are looking for a separator and room for some
5747 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5748 /* just process what we have room for */
5749 shortbuffered = cnt - SvLEN(sv) + append + 1;
5750 cnt -= shortbuffered;
5754 /* remember that cnt can be negative */
5755 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5760 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5761 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5762 DEBUG_P(PerlIO_printf(Perl_debug_log,
5763 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5764 DEBUG_P(PerlIO_printf(Perl_debug_log,
5765 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5766 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5767 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5772 while (cnt > 0) { /* this | eat */
5774 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5775 goto thats_all_folks; /* screams | sed :-) */
5779 Copy(ptr, bp, cnt, char); /* this | eat */
5780 bp += cnt; /* screams | dust */
5781 ptr += cnt; /* louder | sed :-) */
5786 if (shortbuffered) { /* oh well, must extend */
5787 cnt = shortbuffered;
5789 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5791 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5792 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5796 DEBUG_P(PerlIO_printf(Perl_debug_log,
5797 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5798 PTR2UV(ptr),(long)cnt));
5799 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5801 DEBUG_P(PerlIO_printf(Perl_debug_log,
5802 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5803 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5804 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5806 /* This used to call 'filbuf' in stdio form, but as that behaves like
5807 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5808 another abstraction. */
5809 i = PerlIO_getc(fp); /* get more characters */
5811 DEBUG_P(PerlIO_printf(Perl_debug_log,
5812 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5813 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5814 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5816 cnt = PerlIO_get_cnt(fp);
5817 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5818 DEBUG_P(PerlIO_printf(Perl_debug_log,
5819 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5821 if (i == EOF) /* all done for ever? */
5822 goto thats_really_all_folks;
5824 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5826 SvGROW(sv, bpx + cnt + 2);
5827 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5829 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5831 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5832 goto thats_all_folks;
5836 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5837 memNE((char*)bp - rslen, rsptr, rslen))
5838 goto screamer; /* go back to the fray */
5839 thats_really_all_folks:
5841 cnt += shortbuffered;
5842 DEBUG_P(PerlIO_printf(Perl_debug_log,
5843 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5844 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5845 DEBUG_P(PerlIO_printf(Perl_debug_log,
5846 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5847 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5848 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5850 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5851 DEBUG_P(PerlIO_printf(Perl_debug_log,
5852 "Screamer: done, len=%ld, string=|%.*s|\n",
5853 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5857 /*The big, slow, and stupid way. */
5858 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5860 Newx(buf, 8192, STDCHAR);
5868 register const STDCHAR * const bpe = buf + sizeof(buf);
5870 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5871 ; /* keep reading */
5875 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5876 /* Accomodate broken VAXC compiler, which applies U8 cast to
5877 * both args of ?: operator, causing EOF to change into 255
5880 i = (U8)buf[cnt - 1];
5886 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5888 sv_catpvn(sv, (char *) buf, cnt);
5890 sv_setpvn(sv, (char *) buf, cnt);
5892 if (i != EOF && /* joy */
5894 SvCUR(sv) < rslen ||
5895 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5899 * If we're reading from a TTY and we get a short read,
5900 * indicating that the user hit his EOF character, we need
5901 * to notice it now, because if we try to read from the TTY
5902 * again, the EOF condition will disappear.
5904 * The comparison of cnt to sizeof(buf) is an optimization
5905 * that prevents unnecessary calls to feof().
5909 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5913 #ifdef USE_HEAP_INSTEAD_OF_STACK
5918 if (rspara) { /* have to do this both before and after */
5919 while (i != EOF) { /* to make sure file boundaries work right */
5920 i = PerlIO_getc(fp);
5922 PerlIO_ungetc(fp,i);
5928 return_string_or_null:
5929 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5935 Auto-increment of the value in the SV, doing string to numeric conversion
5936 if necessary. Handles 'get' magic.
5942 Perl_sv_inc(pTHX_ register SV *sv)
5950 if (SvTHINKFIRST(sv)) {
5952 sv_force_normal_flags(sv, 0);
5953 if (SvREADONLY(sv)) {
5954 if (IN_PERL_RUNTIME)
5955 Perl_croak(aTHX_ PL_no_modify);
5959 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5961 i = PTR2IV(SvRV(sv));
5966 flags = SvFLAGS(sv);
5967 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5968 /* It's (privately or publicly) a float, but not tested as an
5969 integer, so test it to see. */
5971 flags = SvFLAGS(sv);
5973 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5974 /* It's publicly an integer, or privately an integer-not-float */
5975 #ifdef PERL_PRESERVE_IVUV
5979 if (SvUVX(sv) == UV_MAX)
5980 sv_setnv(sv, UV_MAX_P1);
5982 (void)SvIOK_only_UV(sv);
5983 SvUV_set(sv, SvUVX(sv) + 1);
5985 if (SvIVX(sv) == IV_MAX)
5986 sv_setuv(sv, (UV)IV_MAX + 1);
5988 (void)SvIOK_only(sv);
5989 SvIV_set(sv, SvIVX(sv) + 1);
5994 if (flags & SVp_NOK) {
5995 (void)SvNOK_only(sv);
5996 SvNV_set(sv, SvNVX(sv) + 1.0);
6000 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6001 if ((flags & SVTYPEMASK) < SVt_PVIV)
6002 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6003 (void)SvIOK_only(sv);
6008 while (isALPHA(*d)) d++;
6009 while (isDIGIT(*d)) d++;
6011 #ifdef PERL_PRESERVE_IVUV
6012 /* Got to punt this as an integer if needs be, but we don't issue
6013 warnings. Probably ought to make the sv_iv_please() that does
6014 the conversion if possible, and silently. */
6015 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6016 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6017 /* Need to try really hard to see if it's an integer.
6018 9.22337203685478e+18 is an integer.
6019 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6020 so $a="9.22337203685478e+18"; $a+0; $a++
6021 needs to be the same as $a="9.22337203685478e+18"; $a++
6028 /* sv_2iv *should* have made this an NV */
6029 if (flags & SVp_NOK) {
6030 (void)SvNOK_only(sv);
6031 SvNV_set(sv, SvNVX(sv) + 1.0);
6034 /* I don't think we can get here. Maybe I should assert this
6035 And if we do get here I suspect that sv_setnv will croak. NWC
6037 #if defined(USE_LONG_DOUBLE)
6038 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",
6039 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6041 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6042 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6045 #endif /* PERL_PRESERVE_IVUV */
6046 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6050 while (d >= SvPVX_const(sv)) {
6058 /* MKS: The original code here died if letters weren't consecutive.
6059 * at least it didn't have to worry about non-C locales. The
6060 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6061 * arranged in order (although not consecutively) and that only
6062 * [A-Za-z] are accepted by isALPHA in the C locale.
6064 if (*d != 'z' && *d != 'Z') {
6065 do { ++*d; } while (!isALPHA(*d));
6068 *(d--) -= 'z' - 'a';
6073 *(d--) -= 'z' - 'a' + 1;
6077 /* oh,oh, the number grew */
6078 SvGROW(sv, SvCUR(sv) + 2);
6079 SvCUR_set(sv, SvCUR(sv) + 1);
6080 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6091 Auto-decrement of the value in the SV, doing string to numeric conversion
6092 if necessary. Handles 'get' magic.
6098 Perl_sv_dec(pTHX_ register SV *sv)
6105 if (SvTHINKFIRST(sv)) {
6107 sv_force_normal_flags(sv, 0);
6108 if (SvREADONLY(sv)) {
6109 if (IN_PERL_RUNTIME)
6110 Perl_croak(aTHX_ PL_no_modify);
6114 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6116 i = PTR2IV(SvRV(sv));
6121 /* Unlike sv_inc we don't have to worry about string-never-numbers
6122 and keeping them magic. But we mustn't warn on punting */
6123 flags = SvFLAGS(sv);
6124 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6125 /* It's publicly an integer, or privately an integer-not-float */
6126 #ifdef PERL_PRESERVE_IVUV
6130 if (SvUVX(sv) == 0) {
6131 (void)SvIOK_only(sv);
6135 (void)SvIOK_only_UV(sv);
6136 SvUV_set(sv, SvUVX(sv) - 1);
6139 if (SvIVX(sv) == IV_MIN)
6140 sv_setnv(sv, (NV)IV_MIN - 1.0);
6142 (void)SvIOK_only(sv);
6143 SvIV_set(sv, SvIVX(sv) - 1);
6148 if (flags & SVp_NOK) {
6149 SvNV_set(sv, SvNVX(sv) - 1.0);
6150 (void)SvNOK_only(sv);
6153 if (!(flags & SVp_POK)) {
6154 if ((flags & SVTYPEMASK) < SVt_PVIV)
6155 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6157 (void)SvIOK_only(sv);
6160 #ifdef PERL_PRESERVE_IVUV
6162 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6163 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6164 /* Need to try really hard to see if it's an integer.
6165 9.22337203685478e+18 is an integer.
6166 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6167 so $a="9.22337203685478e+18"; $a+0; $a--
6168 needs to be the same as $a="9.22337203685478e+18"; $a--
6175 /* sv_2iv *should* have made this an NV */
6176 if (flags & SVp_NOK) {
6177 (void)SvNOK_only(sv);
6178 SvNV_set(sv, SvNVX(sv) - 1.0);
6181 /* I don't think we can get here. Maybe I should assert this
6182 And if we do get here I suspect that sv_setnv will croak. NWC
6184 #if defined(USE_LONG_DOUBLE)
6185 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",
6186 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6188 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6189 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6193 #endif /* PERL_PRESERVE_IVUV */
6194 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6198 =for apidoc sv_mortalcopy
6200 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6201 The new SV is marked as mortal. It will be destroyed "soon", either by an
6202 explicit call to FREETMPS, or by an implicit call at places such as
6203 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6208 /* Make a string that will exist for the duration of the expression
6209 * evaluation. Actually, it may have to last longer than that, but
6210 * hopefully we won't free it until it has been assigned to a
6211 * permanent location. */
6214 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6219 sv_setsv(sv,oldstr);
6221 PL_tmps_stack[++PL_tmps_ix] = sv;
6227 =for apidoc sv_newmortal
6229 Creates a new null SV which is mortal. The reference count of the SV is
6230 set to 1. It will be destroyed "soon", either by an explicit call to
6231 FREETMPS, or by an implicit call at places such as statement boundaries.
6232 See also C<sv_mortalcopy> and C<sv_2mortal>.
6238 Perl_sv_newmortal(pTHX)
6243 SvFLAGS(sv) = SVs_TEMP;
6245 PL_tmps_stack[++PL_tmps_ix] = sv;
6250 =for apidoc sv_2mortal
6252 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6253 by an explicit call to FREETMPS, or by an implicit call at places such as
6254 statement boundaries. SvTEMP() is turned on which means that the SV's
6255 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6256 and C<sv_mortalcopy>.
6262 Perl_sv_2mortal(pTHX_ register SV *sv)
6267 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6270 PL_tmps_stack[++PL_tmps_ix] = sv;
6278 Creates a new SV and copies a string into it. The reference count for the
6279 SV is set to 1. If C<len> is zero, Perl will compute the length using
6280 strlen(). For efficiency, consider using C<newSVpvn> instead.
6286 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6291 sv_setpvn(sv,s,len ? len : strlen(s));
6296 =for apidoc newSVpvn
6298 Creates a new SV and copies a string into it. The reference count for the
6299 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6300 string. You are responsible for ensuring that the source string is at least
6301 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6307 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6312 sv_setpvn(sv,s,len);
6318 =for apidoc newSVhek
6320 Creates a new SV from the hash key structure. It will generate scalars that
6321 point to the shared string table where possible. Returns a new (undefined)
6322 SV if the hek is NULL.
6328 Perl_newSVhek(pTHX_ const HEK *hek)
6337 if (HEK_LEN(hek) == HEf_SVKEY) {
6338 return newSVsv(*(SV**)HEK_KEY(hek));
6340 const int flags = HEK_FLAGS(hek);
6341 if (flags & HVhek_WASUTF8) {
6343 Andreas would like keys he put in as utf8 to come back as utf8
6345 STRLEN utf8_len = HEK_LEN(hek);
6346 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6347 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6350 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6352 } else if (flags & HVhek_REHASH) {
6353 /* We don't have a pointer to the hv, so we have to replicate the
6354 flag into every HEK. This hv is using custom a hasing
6355 algorithm. Hence we can't return a shared string scalar, as
6356 that would contain the (wrong) hash value, and might get passed
6357 into an hv routine with a regular hash */
6359 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6364 /* This will be overwhelminly the most common case. */
6365 return newSVpvn_share(HEK_KEY(hek),
6366 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6372 =for apidoc newSVpvn_share
6374 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6375 table. If the string does not already exist in the table, it is created
6376 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6377 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6378 otherwise the hash is computed. The idea here is that as the string table
6379 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6380 hash lookup will avoid string compare.
6386 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6389 bool is_utf8 = FALSE;
6391 STRLEN tmplen = -len;
6393 /* See the note in hv.c:hv_fetch() --jhi */
6394 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6398 PERL_HASH(hash, src, len);
6400 sv_upgrade(sv, SVt_PV);
6401 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6413 #if defined(PERL_IMPLICIT_CONTEXT)
6415 /* pTHX_ magic can't cope with varargs, so this is a no-context
6416 * version of the main function, (which may itself be aliased to us).
6417 * Don't access this version directly.
6421 Perl_newSVpvf_nocontext(const char* pat, ...)
6426 va_start(args, pat);
6427 sv = vnewSVpvf(pat, &args);
6434 =for apidoc newSVpvf
6436 Creates a new SV and initializes it with the string formatted like
6443 Perl_newSVpvf(pTHX_ const char* pat, ...)
6447 va_start(args, pat);
6448 sv = vnewSVpvf(pat, &args);
6453 /* backend for newSVpvf() and newSVpvf_nocontext() */
6456 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6460 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6467 Creates a new SV and copies a floating point value into it.
6468 The reference count for the SV is set to 1.
6474 Perl_newSVnv(pTHX_ NV n)
6486 Creates a new SV and copies an integer into it. The reference count for the
6493 Perl_newSViv(pTHX_ IV i)
6505 Creates a new SV and copies an unsigned integer into it.
6506 The reference count for the SV is set to 1.
6512 Perl_newSVuv(pTHX_ UV u)
6522 =for apidoc newRV_noinc
6524 Creates an RV wrapper for an SV. The reference count for the original
6525 SV is B<not> incremented.
6531 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6536 sv_upgrade(sv, SVt_RV);
6538 SvRV_set(sv, tmpRef);
6543 /* newRV_inc is the official function name to use now.
6544 * newRV_inc is in fact #defined to newRV in sv.h
6548 Perl_newRV(pTHX_ SV *tmpRef)
6550 return newRV_noinc(SvREFCNT_inc(tmpRef));
6556 Creates a new SV which is an exact duplicate of the original SV.
6563 Perl_newSVsv(pTHX_ register SV *old)
6569 if (SvTYPE(old) == SVTYPEMASK) {
6570 if (ckWARN_d(WARN_INTERNAL))
6571 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6575 /* SV_GMAGIC is the default for sv_setv()
6576 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6577 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6578 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6583 =for apidoc sv_reset
6585 Underlying implementation for the C<reset> Perl function.
6586 Note that the perl-level function is vaguely deprecated.
6592 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6595 char todo[PERL_UCHAR_MAX+1];
6600 if (!*s) { /* reset ?? searches */
6601 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6603 PMOP *pm = (PMOP *) mg->mg_obj;
6605 pm->op_pmdynflags &= ~PMdf_USED;
6612 /* reset variables */
6614 if (!HvARRAY(stash))
6617 Zero(todo, 256, char);
6620 I32 i = (unsigned char)*s;
6624 max = (unsigned char)*s++;
6625 for ( ; i <= max; i++) {
6628 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6630 for (entry = HvARRAY(stash)[i];
6632 entry = HeNEXT(entry))
6637 if (!todo[(U8)*HeKEY(entry)])
6639 gv = (GV*)HeVAL(entry);
6642 if (SvTHINKFIRST(sv)) {
6643 if (!SvREADONLY(sv) && SvROK(sv))
6645 /* XXX Is this continue a bug? Why should THINKFIRST
6646 exempt us from resetting arrays and hashes? */
6650 if (SvTYPE(sv) >= SVt_PV) {
6652 if (SvPVX_const(sv) != Nullch)
6660 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6662 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6665 # if defined(USE_ENVIRON_ARRAY)
6668 # endif /* USE_ENVIRON_ARRAY */
6679 Using various gambits, try to get an IO from an SV: the IO slot if its a
6680 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6681 named after the PV if we're a string.
6687 Perl_sv_2io(pTHX_ SV *sv)
6692 switch (SvTYPE(sv)) {
6700 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6704 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6706 return sv_2io(SvRV(sv));
6707 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6713 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6722 Using various gambits, try to get a CV from an SV; in addition, try if
6723 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6724 The flags in C<lref> are passed to sv_fetchsv.
6730 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6737 return *st = NULL, *gvp = Nullgv, Nullcv;
6738 switch (SvTYPE(sv)) {
6757 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6758 tryAMAGICunDEREF(to_cv);
6761 if (SvTYPE(sv) == SVt_PVCV) {
6770 Perl_croak(aTHX_ "Not a subroutine reference");
6775 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6781 /* Some flags to gv_fetchsv mean don't really create the GV */
6782 if (SvTYPE(gv) != SVt_PVGV) {
6788 if (lref && !GvCVu(gv)) {
6791 tmpsv = NEWSV(704,0);
6792 gv_efullname3(tmpsv, gv, Nullch);
6793 /* XXX this is probably not what they think they're getting.
6794 * It has the same effect as "sub name;", i.e. just a forward
6796 newSUB(start_subparse(FALSE, 0),
6797 newSVOP(OP_CONST, 0, tmpsv),
6802 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6812 Returns true if the SV has a true value by Perl's rules.
6813 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6814 instead use an in-line version.
6820 Perl_sv_true(pTHX_ register SV *sv)
6825 register const XPV* const tXpv = (XPV*)SvANY(sv);
6827 (tXpv->xpv_cur > 1 ||
6828 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6835 return SvIVX(sv) != 0;
6838 return SvNVX(sv) != 0.0;
6840 return sv_2bool(sv);
6846 =for apidoc sv_pvn_force
6848 Get a sensible string out of the SV somehow.
6849 A private implementation of the C<SvPV_force> macro for compilers which
6850 can't cope with complex macro expressions. Always use the macro instead.
6852 =for apidoc sv_pvn_force_flags
6854 Get a sensible string out of the SV somehow.
6855 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6856 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6857 implemented in terms of this function.
6858 You normally want to use the various wrapper macros instead: see
6859 C<SvPV_force> and C<SvPV_force_nomg>
6865 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6868 if (SvTHINKFIRST(sv) && !SvROK(sv))
6869 sv_force_normal_flags(sv, 0);
6879 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6880 const char * const ref = sv_reftype(sv,0);
6882 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6883 ref, OP_NAME(PL_op));
6885 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6887 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6888 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6890 s = sv_2pv_flags(sv, &len, flags);
6894 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6897 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6898 SvGROW(sv, len + 1);
6899 Move(s,SvPVX(sv),len,char);
6904 SvPOK_on(sv); /* validate pointer */
6906 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6907 PTR2UV(sv),SvPVX_const(sv)));
6910 return SvPVX_mutable(sv);
6914 =for apidoc sv_pvbyten_force
6916 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6922 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6924 sv_pvn_force(sv,lp);
6925 sv_utf8_downgrade(sv,0);
6931 =for apidoc sv_pvutf8n_force
6933 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6939 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6941 sv_pvn_force(sv,lp);
6942 sv_utf8_upgrade(sv);
6948 =for apidoc sv_reftype
6950 Returns a string describing what the SV is a reference to.
6956 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6958 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6959 inside return suggests a const propagation bug in g++. */
6960 if (ob && SvOBJECT(sv)) {
6961 char * const name = HvNAME_get(SvSTASH(sv));
6962 return name ? name : (char *) "__ANON__";
6965 switch (SvTYPE(sv)) {
6982 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6983 /* tied lvalues should appear to be
6984 * scalars for backwards compatitbility */
6985 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6986 ? "SCALAR" : "LVALUE");
6987 case SVt_PVAV: return "ARRAY";
6988 case SVt_PVHV: return "HASH";
6989 case SVt_PVCV: return "CODE";
6990 case SVt_PVGV: return "GLOB";
6991 case SVt_PVFM: return "FORMAT";
6992 case SVt_PVIO: return "IO";
6993 default: return "UNKNOWN";
6999 =for apidoc sv_isobject
7001 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7002 object. If the SV is not an RV, or if the object is not blessed, then this
7009 Perl_sv_isobject(pTHX_ SV *sv)
7025 Returns a boolean indicating whether the SV is blessed into the specified
7026 class. This does not check for subtypes; use C<sv_derived_from> to verify
7027 an inheritance relationship.
7033 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7044 hvname = HvNAME_get(SvSTASH(sv));
7048 return strEQ(hvname, name);
7054 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7055 it will be upgraded to one. If C<classname> is non-null then the new SV will
7056 be blessed in the specified package. The new SV is returned and its
7057 reference count is 1.
7063 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7069 SV_CHECK_THINKFIRST_COW_DROP(rv);
7072 if (SvTYPE(rv) >= SVt_PVMG) {
7073 const U32 refcnt = SvREFCNT(rv);
7077 SvREFCNT(rv) = refcnt;
7080 if (SvTYPE(rv) < SVt_RV)
7081 sv_upgrade(rv, SVt_RV);
7082 else if (SvTYPE(rv) > SVt_RV) {
7093 HV* const stash = gv_stashpv(classname, TRUE);
7094 (void)sv_bless(rv, stash);
7100 =for apidoc sv_setref_pv
7102 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7103 argument will be upgraded to an RV. That RV will be modified to point to
7104 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7105 into the SV. The C<classname> argument indicates the package for the
7106 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7107 will have a reference count of 1, and the RV will be returned.
7109 Do not use with other Perl types such as HV, AV, SV, CV, because those
7110 objects will become corrupted by the pointer copy process.
7112 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7118 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7121 sv_setsv(rv, &PL_sv_undef);
7125 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7130 =for apidoc sv_setref_iv
7132 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7133 argument will be upgraded to an RV. That RV will be modified to point to
7134 the new SV. The C<classname> argument indicates the package for the
7135 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7136 will have a reference count of 1, and the RV will be returned.
7142 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7144 sv_setiv(newSVrv(rv,classname), iv);
7149 =for apidoc sv_setref_uv
7151 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7152 argument will be upgraded to an RV. That RV will be modified to point to
7153 the new SV. The C<classname> argument indicates the package for the
7154 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7155 will have a reference count of 1, and the RV will be returned.
7161 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7163 sv_setuv(newSVrv(rv,classname), uv);
7168 =for apidoc sv_setref_nv
7170 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7171 argument will be upgraded to an RV. That RV will be modified to point to
7172 the new SV. The C<classname> argument indicates the package for the
7173 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7174 will have a reference count of 1, and the RV will be returned.
7180 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7182 sv_setnv(newSVrv(rv,classname), nv);
7187 =for apidoc sv_setref_pvn
7189 Copies a string into a new SV, optionally blessing the SV. The length of the
7190 string must be specified with C<n>. The C<rv> argument will be upgraded to
7191 an RV. That RV will be modified to point to the new SV. The C<classname>
7192 argument indicates the package for the blessing. Set C<classname> to
7193 C<Nullch> to avoid the blessing. The new SV will have a reference count
7194 of 1, and the RV will be returned.
7196 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7202 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7204 sv_setpvn(newSVrv(rv,classname), pv, n);
7209 =for apidoc sv_bless
7211 Blesses an SV into a specified package. The SV must be an RV. The package
7212 must be designated by its stash (see C<gv_stashpv()>). The reference count
7213 of the SV is unaffected.
7219 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7223 Perl_croak(aTHX_ "Can't bless non-reference value");
7225 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7226 if (SvREADONLY(tmpRef))
7227 Perl_croak(aTHX_ PL_no_modify);
7228 if (SvOBJECT(tmpRef)) {
7229 if (SvTYPE(tmpRef) != SVt_PVIO)
7231 SvREFCNT_dec(SvSTASH(tmpRef));
7234 SvOBJECT_on(tmpRef);
7235 if (SvTYPE(tmpRef) != SVt_PVIO)
7237 SvUPGRADE(tmpRef, SVt_PVMG);
7238 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7245 if(SvSMAGICAL(tmpRef))
7246 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7254 /* Downgrades a PVGV to a PVMG.
7258 S_sv_unglob(pTHX_ SV *sv)
7262 assert(SvTYPE(sv) == SVt_PVGV);
7267 sv_del_backref((SV*)GvSTASH(sv), sv);
7270 sv_unmagic(sv, PERL_MAGIC_glob);
7271 Safefree(GvNAME(sv));
7274 /* need to keep SvANY(sv) in the right arena */
7275 xpvmg = new_XPVMG();
7276 StructCopy(SvANY(sv), xpvmg, XPVMG);
7277 del_XPVGV(SvANY(sv));
7280 SvFLAGS(sv) &= ~SVTYPEMASK;
7281 SvFLAGS(sv) |= SVt_PVMG;
7285 =for apidoc sv_unref_flags
7287 Unsets the RV status of the SV, and decrements the reference count of
7288 whatever was being referenced by the RV. This can almost be thought of
7289 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7290 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7291 (otherwise the decrementing is conditional on the reference count being
7292 different from one or the reference being a readonly SV).
7299 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7301 SV* const target = SvRV(ref);
7303 if (SvWEAKREF(ref)) {
7304 sv_del_backref(target, ref);
7306 SvRV_set(ref, NULL);
7309 SvRV_set(ref, NULL);
7311 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7312 assigned to as BEGIN {$a = \"Foo"} will fail. */
7313 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7314 SvREFCNT_dec(target);
7315 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7316 sv_2mortal(target); /* Schedule for freeing later */
7320 =for apidoc sv_untaint
7322 Untaint an SV. Use C<SvTAINTED_off> instead.
7327 Perl_sv_untaint(pTHX_ SV *sv)
7329 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7330 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7337 =for apidoc sv_tainted
7339 Test an SV for taintedness. Use C<SvTAINTED> instead.
7344 Perl_sv_tainted(pTHX_ SV *sv)
7346 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7347 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7348 if (mg && (mg->mg_len & 1) )
7355 =for apidoc sv_setpviv
7357 Copies an integer into the given SV, also updating its string value.
7358 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7364 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7366 char buf[TYPE_CHARS(UV)];
7368 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7370 sv_setpvn(sv, ptr, ebuf - ptr);
7374 =for apidoc sv_setpviv_mg
7376 Like C<sv_setpviv>, but also handles 'set' magic.
7382 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7388 #if defined(PERL_IMPLICIT_CONTEXT)
7390 /* pTHX_ magic can't cope with varargs, so this is a no-context
7391 * version of the main function, (which may itself be aliased to us).
7392 * Don't access this version directly.
7396 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7400 va_start(args, pat);
7401 sv_vsetpvf(sv, pat, &args);
7405 /* pTHX_ magic can't cope with varargs, so this is a no-context
7406 * version of the main function, (which may itself be aliased to us).
7407 * Don't access this version directly.
7411 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7415 va_start(args, pat);
7416 sv_vsetpvf_mg(sv, pat, &args);
7422 =for apidoc sv_setpvf
7424 Works like C<sv_catpvf> but copies the text into the SV instead of
7425 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7431 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7434 va_start(args, pat);
7435 sv_vsetpvf(sv, pat, &args);
7440 =for apidoc sv_vsetpvf
7442 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7443 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7445 Usually used via its frontend C<sv_setpvf>.
7451 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7453 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7457 =for apidoc sv_setpvf_mg
7459 Like C<sv_setpvf>, but also handles 'set' magic.
7465 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7468 va_start(args, pat);
7469 sv_vsetpvf_mg(sv, pat, &args);
7474 =for apidoc sv_vsetpvf_mg
7476 Like C<sv_vsetpvf>, but also handles 'set' magic.
7478 Usually used via its frontend C<sv_setpvf_mg>.
7484 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7486 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7490 #if defined(PERL_IMPLICIT_CONTEXT)
7492 /* pTHX_ magic can't cope with varargs, so this is a no-context
7493 * version of the main function, (which may itself be aliased to us).
7494 * Don't access this version directly.
7498 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7502 va_start(args, pat);
7503 sv_vcatpvf(sv, pat, &args);
7507 /* pTHX_ magic can't cope with varargs, so this is a no-context
7508 * version of the main function, (which may itself be aliased to us).
7509 * Don't access this version directly.
7513 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7517 va_start(args, pat);
7518 sv_vcatpvf_mg(sv, pat, &args);
7524 =for apidoc sv_catpvf
7526 Processes its arguments like C<sprintf> and appends the formatted
7527 output to an SV. If the appended data contains "wide" characters
7528 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7529 and characters >255 formatted with %c), the original SV might get
7530 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7531 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7532 valid UTF-8; if the original SV was bytes, the pattern should be too.
7537 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7540 va_start(args, pat);
7541 sv_vcatpvf(sv, pat, &args);
7546 =for apidoc sv_vcatpvf
7548 Processes its arguments like C<vsprintf> and appends the formatted output
7549 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7551 Usually used via its frontend C<sv_catpvf>.
7557 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7559 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7563 =for apidoc sv_catpvf_mg
7565 Like C<sv_catpvf>, but also handles 'set' magic.
7571 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7574 va_start(args, pat);
7575 sv_vcatpvf_mg(sv, pat, &args);
7580 =for apidoc sv_vcatpvf_mg
7582 Like C<sv_vcatpvf>, but also handles 'set' magic.
7584 Usually used via its frontend C<sv_catpvf_mg>.
7590 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7592 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7597 =for apidoc sv_vsetpvfn
7599 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7602 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7608 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7610 sv_setpvn(sv, "", 0);
7611 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7615 S_expect_number(pTHX_ char** pattern)
7618 switch (**pattern) {
7619 case '1': case '2': case '3':
7620 case '4': case '5': case '6':
7621 case '7': case '8': case '9':
7622 var = *(*pattern)++ - '0';
7623 while (isDIGIT(**pattern)) {
7624 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7626 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7634 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7636 const int neg = nv < 0;
7645 if (uv & 1 && uv == nv)
7646 uv--; /* Round to even */
7648 const unsigned dig = uv % 10;
7661 =for apidoc sv_vcatpvfn
7663 Processes its arguments like C<vsprintf> and appends the formatted output
7664 to an SV. Uses an array of SVs if the C style variable argument list is
7665 missing (NULL). When running with taint checks enabled, indicates via
7666 C<maybe_tainted> if results are untrustworthy (often due to the use of
7669 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7675 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7676 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7677 vec_utf8 = DO_UTF8(vecsv);
7679 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7682 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7689 static const char nullstr[] = "(null)";
7691 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7692 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7694 /* Times 4: a decimal digit takes more than 3 binary digits.
7695 * NV_DIG: mantissa takes than many decimal digits.
7696 * Plus 32: Playing safe. */
7697 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7698 /* large enough for "%#.#f" --chip */
7699 /* what about long double NVs? --jhi */
7701 PERL_UNUSED_ARG(maybe_tainted);
7703 /* no matter what, this is a string now */
7704 (void)SvPV_force(sv, origlen);
7706 /* special-case "", "%s", and "%-p" (SVf - see below) */
7709 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7711 const char * const s = va_arg(*args, char*);
7712 sv_catpv(sv, s ? s : nullstr);
7714 else if (svix < svmax) {
7715 sv_catsv(sv, *svargs);
7719 if (args && patlen == 3 && pat[0] == '%' &&
7720 pat[1] == '-' && pat[2] == 'p') {
7721 argsv = va_arg(*args, SV*);
7722 sv_catsv(sv, argsv);
7726 #ifndef USE_LONG_DOUBLE
7727 /* special-case "%.<number>[gf]" */
7728 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7729 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7730 unsigned digits = 0;
7734 while (*pp >= '0' && *pp <= '9')
7735 digits = 10 * digits + (*pp++ - '0');
7736 if (pp - pat == (int)patlen - 1) {
7744 /* Add check for digits != 0 because it seems that some
7745 gconverts are buggy in this case, and we don't yet have
7746 a Configure test for this. */
7747 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7748 /* 0, point, slack */
7749 Gconvert(nv, (int)digits, 0, ebuf);
7751 if (*ebuf) /* May return an empty string for digits==0 */
7754 } else if (!digits) {
7757 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7758 sv_catpvn(sv, p, l);
7764 #endif /* !USE_LONG_DOUBLE */
7766 if (!args && svix < svmax && DO_UTF8(*svargs))
7769 patend = (char*)pat + patlen;
7770 for (p = (char*)pat; p < patend; p = q) {
7773 bool vectorize = FALSE;
7774 bool vectorarg = FALSE;
7775 bool vec_utf8 = FALSE;
7781 bool has_precis = FALSE;
7783 const I32 osvix = svix;
7784 bool is_utf8 = FALSE; /* is this item utf8? */
7785 #ifdef HAS_LDBL_SPRINTF_BUG
7786 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7787 with sfio - Allen <allens@cpan.org> */
7788 bool fix_ldbl_sprintf_bug = FALSE;
7792 U8 utf8buf[UTF8_MAXBYTES+1];
7793 STRLEN esignlen = 0;
7795 const char *eptr = Nullch;
7798 const U8 *vecstr = Null(U8*);
7805 /* we need a long double target in case HAS_LONG_DOUBLE but
7808 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7816 const char *dotstr = ".";
7817 STRLEN dotstrlen = 1;
7818 I32 efix = 0; /* explicit format parameter index */
7819 I32 ewix = 0; /* explicit width index */
7820 I32 epix = 0; /* explicit precision index */
7821 I32 evix = 0; /* explicit vector index */
7822 bool asterisk = FALSE;
7824 /* echo everything up to the next format specification */
7825 for (q = p; q < patend && *q != '%'; ++q) ;
7827 if (has_utf8 && !pat_utf8)
7828 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7830 sv_catpvn(sv, p, q - p);
7837 We allow format specification elements in this order:
7838 \d+\$ explicit format parameter index
7840 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7841 0 flag (as above): repeated to allow "v02"
7842 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7843 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7845 [%bcdefginopsuxDFOUX] format (mandatory)
7850 As of perl5.9.3, printf format checking is on by default.
7851 Internally, perl uses %p formats to provide an escape to
7852 some extended formatting. This block deals with those
7853 extensions: if it does not match, (char*)q is reset and
7854 the normal format processing code is used.
7856 Currently defined extensions are:
7857 %p include pointer address (standard)
7858 %-p (SVf) include an SV (previously %_)
7859 %-<num>p include an SV with precision <num>
7860 %1p (VDf) include a v-string (as %vd)
7861 %<num>p reserved for future extensions
7863 Robin Barker 2005-07-14
7870 n = expect_number(&q);
7877 argsv = va_arg(*args, SV*);
7878 eptr = SvPVx_const(argsv, elen);
7884 else if (n == vdNUMBER) { /* VDf */
7891 if (ckWARN_d(WARN_INTERNAL))
7892 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7893 "internal %%<num>p might conflict with future printf extensions");
7899 if ( (width = expect_number(&q)) ) {
7940 if ( (ewix = expect_number(&q)) )
7949 if ((vectorarg = asterisk)) {
7962 width = expect_number(&q);
7968 vecsv = va_arg(*args, SV*);
7970 vecsv = (evix > 0 && evix <= svmax)
7971 ? svargs[evix-1] : &PL_sv_undef;
7973 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7975 dotstr = SvPV_const(vecsv, dotstrlen);
7976 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7977 bad with tied or overloaded values that return UTF8. */
7980 else if (has_utf8) {
7981 vecsv = sv_mortalcopy(vecsv);
7982 sv_utf8_upgrade(vecsv);
7983 dotstr = SvPV_const(vecsv, dotstrlen);
7990 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
7991 vecsv = svargs[efix ? efix-1 : svix++];
7992 vecstr = (U8*)SvPV_const(vecsv,veclen);
7993 vec_utf8 = DO_UTF8(vecsv);
7995 /* if this is a version object, we need to convert
7996 * back into v-string notation and then let the
7997 * vectorize happen normally
7999 if (sv_derived_from(vecsv, "version")) {
8000 char *version = savesvpv(vecsv);
8001 vecsv = sv_newmortal();
8002 /* scan_vstring is expected to be called during
8003 * tokenization, so we need to fake up the end
8004 * of the buffer for it
8006 PL_bufend = version + veclen;
8007 scan_vstring(version, vecsv);
8008 vecstr = (U8*)SvPV_const(vecsv, veclen);
8009 vec_utf8 = DO_UTF8(vecsv);
8021 i = va_arg(*args, int);
8023 i = (ewix ? ewix <= svmax : svix < svmax) ?
8024 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8026 width = (i < 0) ? -i : i;
8036 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8038 /* XXX: todo, support specified precision parameter */
8042 i = va_arg(*args, int);
8044 i = (ewix ? ewix <= svmax : svix < svmax)
8045 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8046 precis = (i < 0) ? 0 : i;
8051 precis = precis * 10 + (*q++ - '0');
8060 case 'I': /* Ix, I32x, and I64x */
8062 if (q[1] == '6' && q[2] == '4') {
8068 if (q[1] == '3' && q[2] == '2') {
8078 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8089 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8090 if (*(q + 1) == 'l') { /* lld, llf */
8116 if (!vectorize && !args) {
8118 const I32 i = efix-1;
8119 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8121 argsv = (svix >= 0 && svix < svmax)
8122 ? svargs[svix++] : &PL_sv_undef;
8133 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8135 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8137 eptr = (char*)utf8buf;
8138 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8152 eptr = va_arg(*args, char*);
8154 #ifdef MACOS_TRADITIONAL
8155 /* On MacOS, %#s format is used for Pascal strings */
8160 elen = strlen(eptr);
8162 eptr = (char *)nullstr;
8163 elen = sizeof nullstr - 1;
8167 eptr = SvPVx_const(argsv, elen);
8168 if (DO_UTF8(argsv)) {
8169 if (has_precis && precis < elen) {
8171 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8174 if (width) { /* fudge width (can't fudge elen) */
8175 width += elen - sv_len_utf8(argsv);
8182 if (has_precis && elen > precis)
8189 if (alt || vectorize)
8191 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8212 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8221 esignbuf[esignlen++] = plus;
8225 case 'h': iv = (short)va_arg(*args, int); break;
8226 case 'l': iv = va_arg(*args, long); break;
8227 case 'V': iv = va_arg(*args, IV); break;
8228 default: iv = va_arg(*args, int); break;
8230 case 'q': iv = va_arg(*args, Quad_t); break;
8235 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8237 case 'h': iv = (short)tiv; break;
8238 case 'l': iv = (long)tiv; break;
8240 default: iv = tiv; break;
8242 case 'q': iv = (Quad_t)tiv; break;
8246 if ( !vectorize ) /* we already set uv above */
8251 esignbuf[esignlen++] = plus;
8255 esignbuf[esignlen++] = '-';
8298 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8309 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8310 case 'l': uv = va_arg(*args, unsigned long); break;
8311 case 'V': uv = va_arg(*args, UV); break;
8312 default: uv = va_arg(*args, unsigned); break;
8314 case 'q': uv = va_arg(*args, Uquad_t); break;
8319 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8321 case 'h': uv = (unsigned short)tuv; break;
8322 case 'l': uv = (unsigned long)tuv; break;
8324 default: uv = tuv; break;
8326 case 'q': uv = (Uquad_t)tuv; break;
8333 char *ptr = ebuf + sizeof ebuf;
8339 p = (char*)((c == 'X')
8340 ? "0123456789ABCDEF" : "0123456789abcdef");
8346 esignbuf[esignlen++] = '0';
8347 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8355 if (alt && *ptr != '0')
8366 esignbuf[esignlen++] = '0';
8367 esignbuf[esignlen++] = 'b';
8370 default: /* it had better be ten or less */
8374 } while (uv /= base);
8377 elen = (ebuf + sizeof ebuf) - ptr;
8381 zeros = precis - elen;
8382 else if (precis == 0 && elen == 1 && *eptr == '0')
8388 /* FLOATING POINT */
8391 c = 'f'; /* maybe %F isn't supported here */
8399 /* This is evil, but floating point is even more evil */
8401 /* for SV-style calling, we can only get NV
8402 for C-style calling, we assume %f is double;
8403 for simplicity we allow any of %Lf, %llf, %qf for long double
8407 #if defined(USE_LONG_DOUBLE)
8411 /* [perl #20339] - we should accept and ignore %lf rather than die */
8415 #if defined(USE_LONG_DOUBLE)
8416 intsize = args ? 0 : 'q';
8420 #if defined(HAS_LONG_DOUBLE)
8429 /* now we need (long double) if intsize == 'q', else (double) */
8431 #if LONG_DOUBLESIZE > DOUBLESIZE
8433 va_arg(*args, long double) :
8434 va_arg(*args, double)
8436 va_arg(*args, double)
8441 if (c != 'e' && c != 'E') {
8443 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8444 will cast our (long double) to (double) */
8445 (void)Perl_frexp(nv, &i);
8446 if (i == PERL_INT_MIN)
8447 Perl_die(aTHX_ "panic: frexp");
8449 need = BIT_DIGITS(i);
8451 need += has_precis ? precis : 6; /* known default */
8456 #ifdef HAS_LDBL_SPRINTF_BUG
8457 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8458 with sfio - Allen <allens@cpan.org> */
8461 # define MY_DBL_MAX DBL_MAX
8462 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8463 # if DOUBLESIZE >= 8
8464 # define MY_DBL_MAX 1.7976931348623157E+308L
8466 # define MY_DBL_MAX 3.40282347E+38L
8470 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8471 # define MY_DBL_MAX_BUG 1L
8473 # define MY_DBL_MAX_BUG MY_DBL_MAX
8477 # define MY_DBL_MIN DBL_MIN
8478 # else /* XXX guessing! -Allen */
8479 # if DOUBLESIZE >= 8
8480 # define MY_DBL_MIN 2.2250738585072014E-308L
8482 # define MY_DBL_MIN 1.17549435E-38L
8486 if ((intsize == 'q') && (c == 'f') &&
8487 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8489 /* it's going to be short enough that
8490 * long double precision is not needed */
8492 if ((nv <= 0L) && (nv >= -0L))
8493 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8495 /* would use Perl_fp_class as a double-check but not
8496 * functional on IRIX - see perl.h comments */
8498 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8499 /* It's within the range that a double can represent */
8500 #if defined(DBL_MAX) && !defined(DBL_MIN)
8501 if ((nv >= ((long double)1/DBL_MAX)) ||
8502 (nv <= (-(long double)1/DBL_MAX)))
8504 fix_ldbl_sprintf_bug = TRUE;
8507 if (fix_ldbl_sprintf_bug == TRUE) {
8517 # undef MY_DBL_MAX_BUG
8520 #endif /* HAS_LDBL_SPRINTF_BUG */
8522 need += 20; /* fudge factor */
8523 if (PL_efloatsize < need) {
8524 Safefree(PL_efloatbuf);
8525 PL_efloatsize = need + 20; /* more fudge */
8526 Newx(PL_efloatbuf, PL_efloatsize, char);
8527 PL_efloatbuf[0] = '\0';
8530 if ( !(width || left || plus || alt) && fill != '0'
8531 && has_precis && intsize != 'q' ) { /* Shortcuts */
8532 /* See earlier comment about buggy Gconvert when digits,
8534 if ( c == 'g' && precis) {
8535 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8536 /* May return an empty string for digits==0 */
8537 if (*PL_efloatbuf) {
8538 elen = strlen(PL_efloatbuf);
8539 goto float_converted;
8541 } else if ( c == 'f' && !precis) {
8542 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8547 char *ptr = ebuf + sizeof ebuf;
8550 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8551 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8552 if (intsize == 'q') {
8553 /* Copy the one or more characters in a long double
8554 * format before the 'base' ([efgEFG]) character to
8555 * the format string. */
8556 static char const prifldbl[] = PERL_PRIfldbl;
8557 char const *p = prifldbl + sizeof(prifldbl) - 3;
8558 while (p >= prifldbl) { *--ptr = *p--; }
8563 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8568 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8580 /* No taint. Otherwise we are in the strange situation
8581 * where printf() taints but print($float) doesn't.
8583 #if defined(HAS_LONG_DOUBLE)
8584 elen = ((intsize == 'q')
8585 ? my_sprintf(PL_efloatbuf, ptr, nv)
8586 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8588 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8592 eptr = PL_efloatbuf;
8600 i = SvCUR(sv) - origlen;
8603 case 'h': *(va_arg(*args, short*)) = i; break;
8604 default: *(va_arg(*args, int*)) = i; break;
8605 case 'l': *(va_arg(*args, long*)) = i; break;
8606 case 'V': *(va_arg(*args, IV*)) = i; break;
8608 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8613 sv_setuv_mg(argsv, (UV)i);
8614 continue; /* not "break" */
8621 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8622 && ckWARN(WARN_PRINTF))
8624 SV * const msg = sv_newmortal();
8625 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8626 (PL_op->op_type == OP_PRTF) ? "" : "s");
8629 Perl_sv_catpvf(aTHX_ msg,
8630 "\"%%%c\"", c & 0xFF);
8632 Perl_sv_catpvf(aTHX_ msg,
8633 "\"%%\\%03"UVof"\"",
8636 sv_catpv(msg, "end of string");
8637 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8640 /* output mangled stuff ... */
8646 /* ... right here, because formatting flags should not apply */
8647 SvGROW(sv, SvCUR(sv) + elen + 1);
8649 Copy(eptr, p, elen, char);
8652 SvCUR_set(sv, p - SvPVX_const(sv));
8654 continue; /* not "break" */
8657 /* calculate width before utf8_upgrade changes it */
8658 have = esignlen + zeros + elen;
8660 Perl_croak_nocontext(PL_memory_wrap);
8662 if (is_utf8 != has_utf8) {
8665 sv_utf8_upgrade(sv);
8668 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8669 sv_utf8_upgrade(nsv);
8670 eptr = SvPVX_const(nsv);
8673 SvGROW(sv, SvCUR(sv) + elen + 1);
8678 need = (have > width ? have : width);
8681 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8682 Perl_croak_nocontext(PL_memory_wrap);
8683 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8685 if (esignlen && fill == '0') {
8687 for (i = 0; i < (int)esignlen; i++)
8691 memset(p, fill, gap);
8694 if (esignlen && fill != '0') {
8696 for (i = 0; i < (int)esignlen; i++)
8701 for (i = zeros; i; i--)
8705 Copy(eptr, p, elen, char);
8709 memset(p, ' ', gap);
8714 Copy(dotstr, p, dotstrlen, char);
8718 vectorize = FALSE; /* done iterating over vecstr */
8725 SvCUR_set(sv, p - SvPVX_const(sv));
8733 /* =========================================================================
8735 =head1 Cloning an interpreter
8737 All the macros and functions in this section are for the private use of
8738 the main function, perl_clone().
8740 The foo_dup() functions make an exact copy of an existing foo thinngy.
8741 During the course of a cloning, a hash table is used to map old addresses
8742 to new addresses. The table is created and manipulated with the
8743 ptr_table_* functions.
8747 ============================================================================*/
8750 #if defined(USE_ITHREADS)
8752 #ifndef GpREFCNT_inc
8753 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8757 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8758 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8759 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8760 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8761 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8762 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8763 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8764 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8765 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8766 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8767 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8768 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8769 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8772 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8773 regcomp.c. AMS 20010712 */
8776 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8781 struct reg_substr_datum *s;
8784 return (REGEXP *)NULL;
8786 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8789 len = r->offsets[0];
8790 npar = r->nparens+1;
8792 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8793 Copy(r->program, ret->program, len+1, regnode);
8795 Newx(ret->startp, npar, I32);
8796 Copy(r->startp, ret->startp, npar, I32);
8797 Newx(ret->endp, npar, I32);
8798 Copy(r->startp, ret->startp, npar, I32);
8800 Newx(ret->substrs, 1, struct reg_substr_data);
8801 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8802 s->min_offset = r->substrs->data[i].min_offset;
8803 s->max_offset = r->substrs->data[i].max_offset;
8804 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8805 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8808 ret->regstclass = NULL;
8811 const int count = r->data->count;
8814 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8815 char, struct reg_data);
8816 Newx(d->what, count, U8);
8819 for (i = 0; i < count; i++) {
8820 d->what[i] = r->data->what[i];
8821 switch (d->what[i]) {
8822 /* legal options are one of: sfpont
8823 see also regcomp.h and pregfree() */
8825 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8828 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8831 /* This is cheating. */
8832 Newx(d->data[i], 1, struct regnode_charclass_class);
8833 StructCopy(r->data->data[i], d->data[i],
8834 struct regnode_charclass_class);
8835 ret->regstclass = (regnode*)d->data[i];
8838 /* Compiled op trees are readonly, and can thus be
8839 shared without duplication. */
8841 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8845 d->data[i] = r->data->data[i];
8848 d->data[i] = r->data->data[i];
8850 ((reg_trie_data*)d->data[i])->refcount++;
8854 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8863 Newx(ret->offsets, 2*len+1, U32);
8864 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8866 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8867 ret->refcnt = r->refcnt;
8868 ret->minlen = r->minlen;
8869 ret->prelen = r->prelen;
8870 ret->nparens = r->nparens;
8871 ret->lastparen = r->lastparen;
8872 ret->lastcloseparen = r->lastcloseparen;
8873 ret->reganch = r->reganch;
8875 ret->sublen = r->sublen;
8877 if (RX_MATCH_COPIED(ret))
8878 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8880 ret->subbeg = Nullch;
8881 #ifdef PERL_OLD_COPY_ON_WRITE
8882 ret->saved_copy = Nullsv;
8885 ptr_table_store(PL_ptr_table, r, ret);
8889 /* duplicate a file handle */
8892 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8896 PERL_UNUSED_ARG(type);
8899 return (PerlIO*)NULL;
8901 /* look for it in the table first */
8902 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8906 /* create anew and remember what it is */
8907 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8908 ptr_table_store(PL_ptr_table, fp, ret);
8912 /* duplicate a directory handle */
8915 Perl_dirp_dup(pTHX_ DIR *dp)
8923 /* duplicate a typeglob */
8926 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8931 /* look for it in the table first */
8932 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8936 /* create anew and remember what it is */
8938 ptr_table_store(PL_ptr_table, gp, ret);
8941 ret->gp_refcnt = 0; /* must be before any other dups! */
8942 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8943 ret->gp_io = io_dup_inc(gp->gp_io, param);
8944 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8945 ret->gp_av = av_dup_inc(gp->gp_av, param);
8946 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8947 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8948 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8949 ret->gp_cvgen = gp->gp_cvgen;
8950 ret->gp_line = gp->gp_line;
8951 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8955 /* duplicate a chain of magic */
8958 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8960 MAGIC *mgprev = (MAGIC*)NULL;
8963 return (MAGIC*)NULL;
8964 /* look for it in the table first */
8965 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8969 for (; mg; mg = mg->mg_moremagic) {
8971 Newxz(nmg, 1, MAGIC);
8973 mgprev->mg_moremagic = nmg;
8976 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8977 nmg->mg_private = mg->mg_private;
8978 nmg->mg_type = mg->mg_type;
8979 nmg->mg_flags = mg->mg_flags;
8980 if (mg->mg_type == PERL_MAGIC_qr) {
8981 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8983 else if(mg->mg_type == PERL_MAGIC_backref) {
8984 const AV * const av = (AV*) mg->mg_obj;
8987 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8989 for (i = AvFILLp(av); i >= 0; i--) {
8990 if (!svp[i]) continue;
8991 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8994 else if (mg->mg_type == PERL_MAGIC_symtab) {
8995 nmg->mg_obj = mg->mg_obj;
8998 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
8999 ? sv_dup_inc(mg->mg_obj, param)
9000 : sv_dup(mg->mg_obj, param);
9002 nmg->mg_len = mg->mg_len;
9003 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9004 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9005 if (mg->mg_len > 0) {
9006 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9007 if (mg->mg_type == PERL_MAGIC_overload_table &&
9008 AMT_AMAGIC((AMT*)mg->mg_ptr))
9010 const AMT * const amtp = (AMT*)mg->mg_ptr;
9011 AMT * const namtp = (AMT*)nmg->mg_ptr;
9013 for (i = 1; i < NofAMmeth; i++) {
9014 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9018 else if (mg->mg_len == HEf_SVKEY)
9019 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9021 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9022 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9029 /* create a new pointer-mapping table */
9032 Perl_ptr_table_new(pTHX)
9035 Newxz(tbl, 1, PTR_TBL_t);
9038 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9042 #define PTR_TABLE_HASH(ptr) \
9043 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9046 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9047 following define) and at call to new_body_inline made below in
9048 Perl_ptr_table_store()
9051 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9053 /* map an existing pointer using a table */
9055 STATIC PTR_TBL_ENT_t *
9056 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9057 PTR_TBL_ENT_t *tblent;
9058 const UV hash = PTR_TABLE_HASH(sv);
9060 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9061 for (; tblent; tblent = tblent->next) {
9062 if (tblent->oldval == sv)
9069 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9071 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9072 return tblent ? tblent->newval : (void *) 0;
9075 /* add a new entry to a pointer-mapping table */
9078 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9080 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9083 tblent->newval = newsv;
9085 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9087 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9088 tblent->oldval = oldsv;
9089 tblent->newval = newsv;
9090 tblent->next = tbl->tbl_ary[entry];
9091 tbl->tbl_ary[entry] = tblent;
9093 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9094 ptr_table_split(tbl);
9098 /* double the hash bucket size of an existing ptr table */
9101 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9103 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9104 const UV oldsize = tbl->tbl_max + 1;
9105 UV newsize = oldsize * 2;
9108 Renew(ary, newsize, PTR_TBL_ENT_t*);
9109 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9110 tbl->tbl_max = --newsize;
9112 for (i=0; i < oldsize; i++, ary++) {
9113 PTR_TBL_ENT_t **curentp, **entp, *ent;
9116 curentp = ary + oldsize;
9117 for (entp = ary, ent = *ary; ent; ent = *entp) {
9118 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9120 ent->next = *curentp;
9130 /* remove all the entries from a ptr table */
9133 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9135 if (tbl && tbl->tbl_items) {
9136 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9137 UV riter = tbl->tbl_max;
9140 PTR_TBL_ENT_t *entry = array[riter];
9143 PTR_TBL_ENT_t * const oentry = entry;
9144 entry = entry->next;
9153 /* clear and free a ptr table */
9156 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9161 ptr_table_clear(tbl);
9162 Safefree(tbl->tbl_ary);
9168 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9171 SvRV_set(dstr, SvWEAKREF(sstr)
9172 ? sv_dup(SvRV(sstr), param)
9173 : sv_dup_inc(SvRV(sstr), param));
9176 else if (SvPVX_const(sstr)) {
9177 /* Has something there */
9179 /* Normal PV - clone whole allocated space */
9180 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9181 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9182 /* Not that normal - actually sstr is copy on write.
9183 But we are a true, independant SV, so: */
9184 SvREADONLY_off(dstr);
9189 /* Special case - not normally malloced for some reason */
9190 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9191 /* A "shared" PV - clone it as "shared" PV */
9193 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9197 /* Some other special case - random pointer */
9198 SvPV_set(dstr, SvPVX(sstr));
9204 if (SvTYPE(dstr) == SVt_RV)
9205 SvRV_set(dstr, NULL);
9211 /* duplicate an SV of any type (including AV, HV etc) */
9214 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9219 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9221 /* look for it in the table first */
9222 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9226 if(param->flags & CLONEf_JOIN_IN) {
9227 /** We are joining here so we don't want do clone
9228 something that is bad **/
9231 if(SvTYPE(sstr) == SVt_PVHV &&
9232 (hvname = HvNAME_get(sstr))) {
9233 /** don't clone stashes if they already exist **/
9234 return (SV*)gv_stashpv(hvname,0);
9238 /* create anew and remember what it is */
9241 #ifdef DEBUG_LEAKING_SCALARS
9242 dstr->sv_debug_optype = sstr->sv_debug_optype;
9243 dstr->sv_debug_line = sstr->sv_debug_line;
9244 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9245 dstr->sv_debug_cloned = 1;
9247 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9249 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9253 ptr_table_store(PL_ptr_table, sstr, dstr);
9256 SvFLAGS(dstr) = SvFLAGS(sstr);
9257 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9258 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9261 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9262 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9263 PL_watch_pvx, SvPVX_const(sstr));
9266 /* don't clone objects whose class has asked us not to */
9267 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9268 SvFLAGS(dstr) &= ~SVTYPEMASK;
9273 switch (SvTYPE(sstr)) {
9278 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9279 SvIV_set(dstr, SvIVX(sstr));
9282 SvANY(dstr) = new_XNV();
9283 SvNV_set(dstr, SvNVX(sstr));
9286 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9287 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9291 /* These are all the types that need complex bodies allocating. */
9293 const svtype sv_type = SvTYPE(sstr);
9294 const struct body_details *const sv_type_details
9295 = bodies_by_type + sv_type;
9299 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9304 if (GvUNIQUE((GV*)sstr)) {
9305 /* Do sharing here, and fall through */
9318 assert(sv_type_details->size);
9319 if (sv_type_details->arena) {
9320 new_body_inline(new_body, sv_type_details->size, sv_type);
9322 = (void*)((char*)new_body - sv_type_details->offset);
9324 new_body = new_NOARENA(sv_type_details);
9328 SvANY(dstr) = new_body;
9331 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9332 ((char*)SvANY(dstr)) + sv_type_details->offset,
9333 sv_type_details->copy, char);
9335 Copy(((char*)SvANY(sstr)),
9336 ((char*)SvANY(dstr)),
9337 sv_type_details->size + sv_type_details->offset, char);
9340 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9341 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9343 /* The Copy above means that all the source (unduplicated) pointers
9344 are now in the destination. We can check the flags and the
9345 pointers in either, but it's possible that there's less cache
9346 missing by always going for the destination.
9347 FIXME - instrument and check that assumption */
9348 if (sv_type >= SVt_PVMG) {
9350 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9352 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9355 /* The cast silences a GCC warning about unhandled types. */
9356 switch ((int)sv_type) {
9368 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9369 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9370 LvTARG(dstr) = dstr;
9371 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9372 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9374 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9377 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9378 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9379 /* Don't call sv_add_backref here as it's going to be created
9380 as part of the magic cloning of the symbol table. */
9381 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9382 (void)GpREFCNT_inc(GvGP(dstr));
9385 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9386 if (IoOFP(dstr) == IoIFP(sstr))
9387 IoOFP(dstr) = IoIFP(dstr);
9389 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9390 /* PL_rsfp_filters entries have fake IoDIRP() */
9391 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9392 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9393 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9394 /* I have no idea why fake dirp (rsfps)
9395 should be treated differently but otherwise
9396 we end up with leaks -- sky*/
9397 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9398 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9399 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9401 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9402 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9403 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9405 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9406 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9407 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9410 if (AvARRAY((AV*)sstr)) {
9411 SV **dst_ary, **src_ary;
9412 SSize_t items = AvFILLp((AV*)sstr) + 1;
9414 src_ary = AvARRAY((AV*)sstr);
9415 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9416 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9417 SvPV_set(dstr, (char*)dst_ary);
9418 AvALLOC((AV*)dstr) = dst_ary;
9419 if (AvREAL((AV*)sstr)) {
9421 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9425 *dst_ary++ = sv_dup(*src_ary++, param);
9427 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9428 while (items-- > 0) {
9429 *dst_ary++ = &PL_sv_undef;
9433 SvPV_set(dstr, Nullch);
9434 AvALLOC((AV*)dstr) = (SV**)NULL;
9441 if (HvARRAY((HV*)sstr)) {
9443 const bool sharekeys = !!HvSHAREKEYS(sstr);
9444 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9445 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9447 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9448 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9450 HvARRAY(dstr) = (HE**)darray;
9451 while (i <= sxhv->xhv_max) {
9452 const HE *source = HvARRAY(sstr)[i];
9453 HvARRAY(dstr)[i] = source
9454 ? he_dup(source, sharekeys, param) : 0;
9458 struct xpvhv_aux * const saux = HvAUX(sstr);
9459 struct xpvhv_aux * const daux = HvAUX(dstr);
9460 /* This flag isn't copied. */
9461 /* SvOOK_on(hv) attacks the IV flags. */
9462 SvFLAGS(dstr) |= SVf_OOK;
9464 hvname = saux->xhv_name;
9466 = hvname ? hek_dup(hvname, param) : hvname;
9468 daux->xhv_riter = saux->xhv_riter;
9469 daux->xhv_eiter = saux->xhv_eiter
9470 ? he_dup(saux->xhv_eiter,
9471 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9475 SvPV_set(dstr, Nullch);
9477 /* Record stashes for possible cloning in Perl_clone(). */
9479 av_push(param->stashes, dstr);
9484 /* NOTE: not refcounted */
9485 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9487 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9489 if (CvCONST(dstr)) {
9490 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9491 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9492 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9494 /* don't dup if copying back - CvGV isn't refcounted, so the
9495 * duped GV may never be freed. A bit of a hack! DAPM */
9496 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9497 Nullgv : gv_dup(CvGV(dstr), param) ;
9498 if (!(param->flags & CLONEf_COPY_STACKS)) {
9501 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9504 ? cv_dup( CvOUTSIDE(dstr), param)
9505 : cv_dup_inc(CvOUTSIDE(dstr), param);
9507 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9513 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9519 /* duplicate a context */
9522 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9527 return (PERL_CONTEXT*)NULL;
9529 /* look for it in the table first */
9530 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9534 /* create anew and remember what it is */
9535 Newxz(ncxs, max + 1, PERL_CONTEXT);
9536 ptr_table_store(PL_ptr_table, cxs, ncxs);
9539 PERL_CONTEXT * const cx = &cxs[ix];
9540 PERL_CONTEXT * const ncx = &ncxs[ix];
9541 ncx->cx_type = cx->cx_type;
9542 if (CxTYPE(cx) == CXt_SUBST) {
9543 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9546 ncx->blk_oldsp = cx->blk_oldsp;
9547 ncx->blk_oldcop = cx->blk_oldcop;
9548 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9549 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9550 ncx->blk_oldpm = cx->blk_oldpm;
9551 ncx->blk_gimme = cx->blk_gimme;
9552 switch (CxTYPE(cx)) {
9554 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9555 ? cv_dup_inc(cx->blk_sub.cv, param)
9556 : cv_dup(cx->blk_sub.cv,param));
9557 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9558 ? av_dup_inc(cx->blk_sub.argarray, param)
9560 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9561 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9562 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9563 ncx->blk_sub.lval = cx->blk_sub.lval;
9564 ncx->blk_sub.retop = cx->blk_sub.retop;
9567 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9568 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9569 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9570 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9571 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9572 ncx->blk_eval.retop = cx->blk_eval.retop;
9575 ncx->blk_loop.label = cx->blk_loop.label;
9576 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9577 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9578 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9579 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9580 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9581 ? cx->blk_loop.iterdata
9582 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9583 ncx->blk_loop.oldcomppad
9584 = (PAD*)ptr_table_fetch(PL_ptr_table,
9585 cx->blk_loop.oldcomppad);
9586 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9587 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9588 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9589 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9590 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9593 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9594 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9595 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9596 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9597 ncx->blk_sub.retop = cx->blk_sub.retop;
9609 /* duplicate a stack info structure */
9612 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9617 return (PERL_SI*)NULL;
9619 /* look for it in the table first */
9620 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9624 /* create anew and remember what it is */
9625 Newxz(nsi, 1, PERL_SI);
9626 ptr_table_store(PL_ptr_table, si, nsi);
9628 nsi->si_stack = av_dup_inc(si->si_stack, param);
9629 nsi->si_cxix = si->si_cxix;
9630 nsi->si_cxmax = si->si_cxmax;
9631 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9632 nsi->si_type = si->si_type;
9633 nsi->si_prev = si_dup(si->si_prev, param);
9634 nsi->si_next = si_dup(si->si_next, param);
9635 nsi->si_markoff = si->si_markoff;
9640 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9641 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9642 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9643 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9644 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9645 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9646 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9647 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9648 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9649 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9650 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9651 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9652 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9653 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9656 #define pv_dup_inc(p) SAVEPV(p)
9657 #define pv_dup(p) SAVEPV(p)
9658 #define svp_dup_inc(p,pp) any_dup(p,pp)
9660 /* map any object to the new equivent - either something in the
9661 * ptr table, or something in the interpreter structure
9665 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9672 /* look for it in the table first */
9673 ret = ptr_table_fetch(PL_ptr_table, v);
9677 /* see if it is part of the interpreter structure */
9678 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9679 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9687 /* duplicate the save stack */
9690 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9692 ANY * const ss = proto_perl->Tsavestack;
9693 const I32 max = proto_perl->Tsavestack_max;
9694 I32 ix = proto_perl->Tsavestack_ix;
9706 void (*dptr) (void*);
9707 void (*dxptr) (pTHX_ void*);
9709 Newxz(nss, max, ANY);
9712 I32 i = POPINT(ss,ix);
9715 case SAVEt_ITEM: /* normal string */
9716 sv = (SV*)POPPTR(ss,ix);
9717 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9718 sv = (SV*)POPPTR(ss,ix);
9719 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9721 case SAVEt_SV: /* scalar reference */
9722 sv = (SV*)POPPTR(ss,ix);
9723 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9724 gv = (GV*)POPPTR(ss,ix);
9725 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9727 case SAVEt_GENERIC_PVREF: /* generic char* */
9728 c = (char*)POPPTR(ss,ix);
9729 TOPPTR(nss,ix) = pv_dup(c);
9730 ptr = POPPTR(ss,ix);
9731 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9733 case SAVEt_SHARED_PVREF: /* char* in shared space */
9734 c = (char*)POPPTR(ss,ix);
9735 TOPPTR(nss,ix) = savesharedpv(c);
9736 ptr = POPPTR(ss,ix);
9737 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9739 case SAVEt_GENERIC_SVREF: /* generic sv */
9740 case SAVEt_SVREF: /* scalar reference */
9741 sv = (SV*)POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9743 ptr = POPPTR(ss,ix);
9744 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9746 case SAVEt_AV: /* array reference */
9747 av = (AV*)POPPTR(ss,ix);
9748 TOPPTR(nss,ix) = av_dup_inc(av, param);
9749 gv = (GV*)POPPTR(ss,ix);
9750 TOPPTR(nss,ix) = gv_dup(gv, param);
9752 case SAVEt_HV: /* hash reference */
9753 hv = (HV*)POPPTR(ss,ix);
9754 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9755 gv = (GV*)POPPTR(ss,ix);
9756 TOPPTR(nss,ix) = gv_dup(gv, param);
9758 case SAVEt_INT: /* int reference */
9759 ptr = POPPTR(ss,ix);
9760 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9761 intval = (int)POPINT(ss,ix);
9762 TOPINT(nss,ix) = intval;
9764 case SAVEt_LONG: /* long reference */
9765 ptr = POPPTR(ss,ix);
9766 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9767 longval = (long)POPLONG(ss,ix);
9768 TOPLONG(nss,ix) = longval;
9770 case SAVEt_I32: /* I32 reference */
9771 case SAVEt_I16: /* I16 reference */
9772 case SAVEt_I8: /* I8 reference */
9773 ptr = POPPTR(ss,ix);
9774 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9778 case SAVEt_IV: /* IV reference */
9779 ptr = POPPTR(ss,ix);
9780 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9784 case SAVEt_SPTR: /* SV* reference */
9785 ptr = POPPTR(ss,ix);
9786 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9787 sv = (SV*)POPPTR(ss,ix);
9788 TOPPTR(nss,ix) = sv_dup(sv, param);
9790 case SAVEt_VPTR: /* random* reference */
9791 ptr = POPPTR(ss,ix);
9792 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9793 ptr = POPPTR(ss,ix);
9794 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9796 case SAVEt_PPTR: /* char* reference */
9797 ptr = POPPTR(ss,ix);
9798 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9799 c = (char*)POPPTR(ss,ix);
9800 TOPPTR(nss,ix) = pv_dup(c);
9802 case SAVEt_HPTR: /* HV* reference */
9803 ptr = POPPTR(ss,ix);
9804 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9805 hv = (HV*)POPPTR(ss,ix);
9806 TOPPTR(nss,ix) = hv_dup(hv, param);
9808 case SAVEt_APTR: /* AV* reference */
9809 ptr = POPPTR(ss,ix);
9810 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9811 av = (AV*)POPPTR(ss,ix);
9812 TOPPTR(nss,ix) = av_dup(av, param);
9815 gv = (GV*)POPPTR(ss,ix);
9816 TOPPTR(nss,ix) = gv_dup(gv, param);
9818 case SAVEt_GP: /* scalar reference */
9819 gp = (GP*)POPPTR(ss,ix);
9820 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9821 (void)GpREFCNT_inc(gp);
9822 gv = (GV*)POPPTR(ss,ix);
9823 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9824 c = (char*)POPPTR(ss,ix);
9825 TOPPTR(nss,ix) = pv_dup(c);
9832 case SAVEt_MORTALIZESV:
9833 sv = (SV*)POPPTR(ss,ix);
9834 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9837 ptr = POPPTR(ss,ix);
9838 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9839 /* these are assumed to be refcounted properly */
9841 switch (((OP*)ptr)->op_type) {
9848 TOPPTR(nss,ix) = ptr;
9853 TOPPTR(nss,ix) = Nullop;
9858 TOPPTR(nss,ix) = Nullop;
9861 c = (char*)POPPTR(ss,ix);
9862 TOPPTR(nss,ix) = pv_dup_inc(c);
9865 longval = POPLONG(ss,ix);
9866 TOPLONG(nss,ix) = longval;
9869 hv = (HV*)POPPTR(ss,ix);
9870 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9871 c = (char*)POPPTR(ss,ix);
9872 TOPPTR(nss,ix) = pv_dup_inc(c);
9876 case SAVEt_DESTRUCTOR:
9877 ptr = POPPTR(ss,ix);
9878 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9879 dptr = POPDPTR(ss,ix);
9880 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9881 any_dup(FPTR2DPTR(void *, dptr),
9884 case SAVEt_DESTRUCTOR_X:
9885 ptr = POPPTR(ss,ix);
9886 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9887 dxptr = POPDXPTR(ss,ix);
9888 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9889 any_dup(FPTR2DPTR(void *, dxptr),
9892 case SAVEt_REGCONTEXT:
9898 case SAVEt_STACK_POS: /* Position on Perl stack */
9902 case SAVEt_AELEM: /* array element */
9903 sv = (SV*)POPPTR(ss,ix);
9904 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9907 av = (AV*)POPPTR(ss,ix);
9908 TOPPTR(nss,ix) = av_dup_inc(av, param);
9910 case SAVEt_HELEM: /* hash element */
9911 sv = (SV*)POPPTR(ss,ix);
9912 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9913 sv = (SV*)POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9915 hv = (HV*)POPPTR(ss,ix);
9916 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9919 ptr = POPPTR(ss,ix);
9920 TOPPTR(nss,ix) = ptr;
9927 av = (AV*)POPPTR(ss,ix);
9928 TOPPTR(nss,ix) = av_dup(av, param);
9931 longval = (long)POPLONG(ss,ix);
9932 TOPLONG(nss,ix) = longval;
9933 ptr = POPPTR(ss,ix);
9934 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9935 sv = (SV*)POPPTR(ss,ix);
9936 TOPPTR(nss,ix) = sv_dup(sv, param);
9939 ptr = POPPTR(ss,ix);
9940 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9941 longval = (long)POPBOOL(ss,ix);
9942 TOPBOOL(nss,ix) = (bool)longval;
9944 case SAVEt_SET_SVFLAGS:
9949 sv = (SV*)POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = sv_dup(sv, param);
9953 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9961 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9962 * flag to the result. This is done for each stash before cloning starts,
9963 * so we know which stashes want their objects cloned */
9966 do_mark_cloneable_stash(pTHX_ SV *sv)
9968 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9970 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9971 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9972 if (cloner && GvCV(cloner)) {
9979 XPUSHs(sv_2mortal(newSVhek(hvname)));
9981 call_sv((SV*)GvCV(cloner), G_SCALAR);
9988 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
9996 =for apidoc perl_clone
9998 Create and return a new interpreter by cloning the current one.
10000 perl_clone takes these flags as parameters:
10002 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10003 without it we only clone the data and zero the stacks,
10004 with it we copy the stacks and the new perl interpreter is
10005 ready to run at the exact same point as the previous one.
10006 The pseudo-fork code uses COPY_STACKS while the
10007 threads->new doesn't.
10009 CLONEf_KEEP_PTR_TABLE
10010 perl_clone keeps a ptr_table with the pointer of the old
10011 variable as a key and the new variable as a value,
10012 this allows it to check if something has been cloned and not
10013 clone it again but rather just use the value and increase the
10014 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10015 the ptr_table using the function
10016 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10017 reason to keep it around is if you want to dup some of your own
10018 variable who are outside the graph perl scans, example of this
10019 code is in threads.xs create
10022 This is a win32 thing, it is ignored on unix, it tells perls
10023 win32host code (which is c++) to clone itself, this is needed on
10024 win32 if you want to run two threads at the same time,
10025 if you just want to do some stuff in a separate perl interpreter
10026 and then throw it away and return to the original one,
10027 you don't need to do anything.
10032 /* XXX the above needs expanding by someone who actually understands it ! */
10033 EXTERN_C PerlInterpreter *
10034 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10037 perl_clone(PerlInterpreter *proto_perl, UV flags)
10040 #ifdef PERL_IMPLICIT_SYS
10042 /* perlhost.h so we need to call into it
10043 to clone the host, CPerlHost should have a c interface, sky */
10045 if (flags & CLONEf_CLONE_HOST) {
10046 return perl_clone_host(proto_perl,flags);
10048 return perl_clone_using(proto_perl, flags,
10050 proto_perl->IMemShared,
10051 proto_perl->IMemParse,
10053 proto_perl->IStdIO,
10057 proto_perl->IProc);
10061 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10062 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10063 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10064 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10065 struct IPerlDir* ipD, struct IPerlSock* ipS,
10066 struct IPerlProc* ipP)
10068 /* XXX many of the string copies here can be optimized if they're
10069 * constants; they need to be allocated as common memory and just
10070 * their pointers copied. */
10073 CLONE_PARAMS clone_params;
10074 CLONE_PARAMS* param = &clone_params;
10076 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10077 /* for each stash, determine whether its objects should be cloned */
10078 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10079 PERL_SET_THX(my_perl);
10082 Poison(my_perl, 1, PerlInterpreter);
10084 PL_curcop = (COP *)Nullop;
10088 PL_savestack_ix = 0;
10089 PL_savestack_max = -1;
10090 PL_sig_pending = 0;
10091 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10092 # else /* !DEBUGGING */
10093 Zero(my_perl, 1, PerlInterpreter);
10094 # endif /* DEBUGGING */
10096 /* host pointers */
10098 PL_MemShared = ipMS;
10099 PL_MemParse = ipMP;
10106 #else /* !PERL_IMPLICIT_SYS */
10108 CLONE_PARAMS clone_params;
10109 CLONE_PARAMS* param = &clone_params;
10110 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10111 /* for each stash, determine whether its objects should be cloned */
10112 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10113 PERL_SET_THX(my_perl);
10116 Poison(my_perl, 1, PerlInterpreter);
10118 PL_curcop = (COP *)Nullop;
10122 PL_savestack_ix = 0;
10123 PL_savestack_max = -1;
10124 PL_sig_pending = 0;
10125 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10126 # else /* !DEBUGGING */
10127 Zero(my_perl, 1, PerlInterpreter);
10128 # endif /* DEBUGGING */
10129 #endif /* PERL_IMPLICIT_SYS */
10130 param->flags = flags;
10131 param->proto_perl = proto_perl;
10133 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10134 Zero(&PL_body_roots, 1, PL_body_roots);
10136 PL_nice_chunk = NULL;
10137 PL_nice_chunk_size = 0;
10139 PL_sv_objcount = 0;
10140 PL_sv_root = Nullsv;
10141 PL_sv_arenaroot = Nullsv;
10143 PL_debug = proto_perl->Idebug;
10145 PL_hash_seed = proto_perl->Ihash_seed;
10146 PL_rehash_seed = proto_perl->Irehash_seed;
10148 #ifdef USE_REENTRANT_API
10149 /* XXX: things like -Dm will segfault here in perlio, but doing
10150 * PERL_SET_CONTEXT(proto_perl);
10151 * breaks too many other things
10153 Perl_reentrant_init(aTHX);
10156 /* create SV map for pointer relocation */
10157 PL_ptr_table = ptr_table_new();
10159 /* initialize these special pointers as early as possible */
10160 SvANY(&PL_sv_undef) = NULL;
10161 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10162 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10163 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10165 SvANY(&PL_sv_no) = new_XPVNV();
10166 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10167 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10168 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10169 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10170 SvCUR_set(&PL_sv_no, 0);
10171 SvLEN_set(&PL_sv_no, 1);
10172 SvIV_set(&PL_sv_no, 0);
10173 SvNV_set(&PL_sv_no, 0);
10174 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10176 SvANY(&PL_sv_yes) = new_XPVNV();
10177 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10178 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10179 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10180 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10181 SvCUR_set(&PL_sv_yes, 1);
10182 SvLEN_set(&PL_sv_yes, 2);
10183 SvIV_set(&PL_sv_yes, 1);
10184 SvNV_set(&PL_sv_yes, 1);
10185 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10187 /* create (a non-shared!) shared string table */
10188 PL_strtab = newHV();
10189 HvSHAREKEYS_off(PL_strtab);
10190 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10191 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10193 PL_compiling = proto_perl->Icompiling;
10195 /* These two PVs will be free'd special way so must set them same way op.c does */
10196 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10197 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10199 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10200 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10202 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10203 if (!specialWARN(PL_compiling.cop_warnings))
10204 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10205 if (!specialCopIO(PL_compiling.cop_io))
10206 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10207 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10209 /* pseudo environmental stuff */
10210 PL_origargc = proto_perl->Iorigargc;
10211 PL_origargv = proto_perl->Iorigargv;
10213 param->stashes = newAV(); /* Setup array of objects to call clone on */
10215 /* Set tainting stuff before PerlIO_debug can possibly get called */
10216 PL_tainting = proto_perl->Itainting;
10217 PL_taint_warn = proto_perl->Itaint_warn;
10219 #ifdef PERLIO_LAYERS
10220 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10221 PerlIO_clone(aTHX_ proto_perl, param);
10224 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10225 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10226 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10227 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10228 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10229 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10232 PL_minus_c = proto_perl->Iminus_c;
10233 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10234 PL_localpatches = proto_perl->Ilocalpatches;
10235 PL_splitstr = proto_perl->Isplitstr;
10236 PL_preprocess = proto_perl->Ipreprocess;
10237 PL_minus_n = proto_perl->Iminus_n;
10238 PL_minus_p = proto_perl->Iminus_p;
10239 PL_minus_l = proto_perl->Iminus_l;
10240 PL_minus_a = proto_perl->Iminus_a;
10241 PL_minus_E = proto_perl->Iminus_E;
10242 PL_minus_F = proto_perl->Iminus_F;
10243 PL_doswitches = proto_perl->Idoswitches;
10244 PL_dowarn = proto_perl->Idowarn;
10245 PL_doextract = proto_perl->Idoextract;
10246 PL_sawampersand = proto_perl->Isawampersand;
10247 PL_unsafe = proto_perl->Iunsafe;
10248 PL_inplace = SAVEPV(proto_perl->Iinplace);
10249 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10250 PL_perldb = proto_perl->Iperldb;
10251 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10252 PL_exit_flags = proto_perl->Iexit_flags;
10254 /* magical thingies */
10255 /* XXX time(&PL_basetime) when asked for? */
10256 PL_basetime = proto_perl->Ibasetime;
10257 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10259 PL_maxsysfd = proto_perl->Imaxsysfd;
10260 PL_multiline = proto_perl->Imultiline;
10261 PL_statusvalue = proto_perl->Istatusvalue;
10263 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10265 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10267 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10269 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10270 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10271 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10273 /* Clone the regex array */
10274 PL_regex_padav = newAV();
10276 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10277 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10279 av_push(PL_regex_padav,
10280 sv_dup_inc(regexen[0],param));
10281 for(i = 1; i <= len; i++) {
10282 if(SvREPADTMP(regexen[i])) {
10283 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10285 av_push(PL_regex_padav,
10287 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10288 SvIVX(regexen[i])), param)))
10293 PL_regex_pad = AvARRAY(PL_regex_padav);
10295 /* shortcuts to various I/O objects */
10296 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10297 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10298 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10299 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10300 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10301 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10303 /* shortcuts to regexp stuff */
10304 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10306 /* shortcuts to misc objects */
10307 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10309 /* shortcuts to debugging objects */
10310 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10311 PL_DBline = gv_dup(proto_perl->IDBline, param);
10312 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10313 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10314 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10315 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10316 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10317 PL_lineary = av_dup(proto_perl->Ilineary, param);
10318 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10320 /* symbol tables */
10321 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10322 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10323 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10324 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10325 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10327 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10328 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10329 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10330 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10331 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10332 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10334 PL_sub_generation = proto_perl->Isub_generation;
10336 /* funky return mechanisms */
10337 PL_forkprocess = proto_perl->Iforkprocess;
10339 /* subprocess state */
10340 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10342 /* internal state */
10343 PL_maxo = proto_perl->Imaxo;
10344 if (proto_perl->Iop_mask)
10345 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10347 PL_op_mask = Nullch;
10348 /* PL_asserting = proto_perl->Iasserting; */
10350 /* current interpreter roots */
10351 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10352 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10353 PL_main_start = proto_perl->Imain_start;
10354 PL_eval_root = proto_perl->Ieval_root;
10355 PL_eval_start = proto_perl->Ieval_start;
10357 /* runtime control stuff */
10358 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10359 PL_copline = proto_perl->Icopline;
10361 PL_filemode = proto_perl->Ifilemode;
10362 PL_lastfd = proto_perl->Ilastfd;
10363 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10366 PL_gensym = proto_perl->Igensym;
10367 PL_preambled = proto_perl->Ipreambled;
10368 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10369 PL_laststatval = proto_perl->Ilaststatval;
10370 PL_laststype = proto_perl->Ilaststype;
10371 PL_mess_sv = Nullsv;
10373 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10375 /* interpreter atexit processing */
10376 PL_exitlistlen = proto_perl->Iexitlistlen;
10377 if (PL_exitlistlen) {
10378 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10379 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10382 PL_exitlist = (PerlExitListEntry*)NULL;
10383 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10384 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10385 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10387 PL_profiledata = NULL;
10388 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10389 /* PL_rsfp_filters entries have fake IoDIRP() */
10390 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10392 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10394 PAD_CLONE_VARS(proto_perl, param);
10396 #ifdef HAVE_INTERP_INTERN
10397 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10400 /* more statics moved here */
10401 PL_generation = proto_perl->Igeneration;
10402 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10404 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10405 PL_in_clean_all = proto_perl->Iin_clean_all;
10407 PL_uid = proto_perl->Iuid;
10408 PL_euid = proto_perl->Ieuid;
10409 PL_gid = proto_perl->Igid;
10410 PL_egid = proto_perl->Iegid;
10411 PL_nomemok = proto_perl->Inomemok;
10412 PL_an = proto_perl->Ian;
10413 PL_evalseq = proto_perl->Ievalseq;
10414 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10415 PL_origalen = proto_perl->Iorigalen;
10416 #ifdef PERL_USES_PL_PIDSTATUS
10417 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10419 PL_osname = SAVEPV(proto_perl->Iosname);
10420 PL_sighandlerp = proto_perl->Isighandlerp;
10422 PL_runops = proto_perl->Irunops;
10424 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10427 PL_cshlen = proto_perl->Icshlen;
10428 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10431 PL_lex_state = proto_perl->Ilex_state;
10432 PL_lex_defer = proto_perl->Ilex_defer;
10433 PL_lex_expect = proto_perl->Ilex_expect;
10434 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10435 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10436 PL_lex_starts = proto_perl->Ilex_starts;
10437 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10438 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10439 PL_lex_op = proto_perl->Ilex_op;
10440 PL_lex_inpat = proto_perl->Ilex_inpat;
10441 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10442 PL_lex_brackets = proto_perl->Ilex_brackets;
10443 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10444 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10445 PL_lex_casemods = proto_perl->Ilex_casemods;
10446 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10447 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10449 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10450 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10451 PL_nexttoke = proto_perl->Inexttoke;
10453 /* XXX This is probably masking the deeper issue of why
10454 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10455 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10456 * (A little debugging with a watchpoint on it may help.)
10458 if (SvANY(proto_perl->Ilinestr)) {
10459 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10460 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10461 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10462 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10463 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10464 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10465 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10466 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10467 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10470 PL_linestr = NEWSV(65,79);
10471 sv_upgrade(PL_linestr,SVt_PVIV);
10472 sv_setpvn(PL_linestr,"",0);
10473 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10475 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10476 PL_pending_ident = proto_perl->Ipending_ident;
10477 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10479 PL_expect = proto_perl->Iexpect;
10481 PL_multi_start = proto_perl->Imulti_start;
10482 PL_multi_end = proto_perl->Imulti_end;
10483 PL_multi_open = proto_perl->Imulti_open;
10484 PL_multi_close = proto_perl->Imulti_close;
10486 PL_error_count = proto_perl->Ierror_count;
10487 PL_subline = proto_perl->Isubline;
10488 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10490 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10491 if (SvANY(proto_perl->Ilinestr)) {
10492 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10493 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10494 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10495 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10496 PL_last_lop_op = proto_perl->Ilast_lop_op;
10499 PL_last_uni = SvPVX(PL_linestr);
10500 PL_last_lop = SvPVX(PL_linestr);
10501 PL_last_lop_op = 0;
10503 PL_in_my = proto_perl->Iin_my;
10504 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10506 PL_cryptseen = proto_perl->Icryptseen;
10509 PL_hints = proto_perl->Ihints;
10511 PL_amagic_generation = proto_perl->Iamagic_generation;
10513 #ifdef USE_LOCALE_COLLATE
10514 PL_collation_ix = proto_perl->Icollation_ix;
10515 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10516 PL_collation_standard = proto_perl->Icollation_standard;
10517 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10518 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10519 #endif /* USE_LOCALE_COLLATE */
10521 #ifdef USE_LOCALE_NUMERIC
10522 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10523 PL_numeric_standard = proto_perl->Inumeric_standard;
10524 PL_numeric_local = proto_perl->Inumeric_local;
10525 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10526 #endif /* !USE_LOCALE_NUMERIC */
10528 /* utf8 character classes */
10529 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10530 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10531 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10532 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10533 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10534 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10535 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10536 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10537 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10538 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10539 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10540 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10541 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10542 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10543 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10544 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10545 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10546 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10547 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10548 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10550 /* Did the locale setup indicate UTF-8? */
10551 PL_utf8locale = proto_perl->Iutf8locale;
10552 /* Unicode features (see perlrun/-C) */
10553 PL_unicode = proto_perl->Iunicode;
10555 /* Pre-5.8 signals control */
10556 PL_signals = proto_perl->Isignals;
10558 /* times() ticks per second */
10559 PL_clocktick = proto_perl->Iclocktick;
10561 /* Recursion stopper for PerlIO_find_layer */
10562 PL_in_load_module = proto_perl->Iin_load_module;
10564 /* sort() routine */
10565 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10567 /* Not really needed/useful since the reenrant_retint is "volatile",
10568 * but do it for consistency's sake. */
10569 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10571 /* Hooks to shared SVs and locks. */
10572 PL_sharehook = proto_perl->Isharehook;
10573 PL_lockhook = proto_perl->Ilockhook;
10574 PL_unlockhook = proto_perl->Iunlockhook;
10575 PL_threadhook = proto_perl->Ithreadhook;
10577 PL_runops_std = proto_perl->Irunops_std;
10578 PL_runops_dbg = proto_perl->Irunops_dbg;
10580 #ifdef THREADS_HAVE_PIDS
10581 PL_ppid = proto_perl->Ippid;
10585 PL_last_swash_hv = NULL; /* reinits on demand */
10586 PL_last_swash_klen = 0;
10587 PL_last_swash_key[0]= '\0';
10588 PL_last_swash_tmps = (U8*)NULL;
10589 PL_last_swash_slen = 0;
10591 PL_glob_index = proto_perl->Iglob_index;
10592 PL_srand_called = proto_perl->Isrand_called;
10593 PL_uudmap['M'] = 0; /* reinits on demand */
10594 PL_bitcount = Nullch; /* reinits on demand */
10596 if (proto_perl->Ipsig_pend) {
10597 Newxz(PL_psig_pend, SIG_SIZE, int);
10600 PL_psig_pend = (int*)NULL;
10603 if (proto_perl->Ipsig_ptr) {
10604 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10605 Newxz(PL_psig_name, SIG_SIZE, SV*);
10606 for (i = 1; i < SIG_SIZE; i++) {
10607 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10608 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10612 PL_psig_ptr = (SV**)NULL;
10613 PL_psig_name = (SV**)NULL;
10616 /* thrdvar.h stuff */
10618 if (flags & CLONEf_COPY_STACKS) {
10619 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10620 PL_tmps_ix = proto_perl->Ttmps_ix;
10621 PL_tmps_max = proto_perl->Ttmps_max;
10622 PL_tmps_floor = proto_perl->Ttmps_floor;
10623 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10625 while (i <= PL_tmps_ix) {
10626 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10630 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10631 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10632 Newxz(PL_markstack, i, I32);
10633 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10634 - proto_perl->Tmarkstack);
10635 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10636 - proto_perl->Tmarkstack);
10637 Copy(proto_perl->Tmarkstack, PL_markstack,
10638 PL_markstack_ptr - PL_markstack + 1, I32);
10640 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10641 * NOTE: unlike the others! */
10642 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10643 PL_scopestack_max = proto_perl->Tscopestack_max;
10644 Newxz(PL_scopestack, PL_scopestack_max, I32);
10645 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10647 /* NOTE: si_dup() looks at PL_markstack */
10648 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10650 /* PL_curstack = PL_curstackinfo->si_stack; */
10651 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10652 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10654 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10655 PL_stack_base = AvARRAY(PL_curstack);
10656 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10657 - proto_perl->Tstack_base);
10658 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10660 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10661 * NOTE: unlike the others! */
10662 PL_savestack_ix = proto_perl->Tsavestack_ix;
10663 PL_savestack_max = proto_perl->Tsavestack_max;
10664 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10665 PL_savestack = ss_dup(proto_perl, param);
10669 ENTER; /* perl_destruct() wants to LEAVE; */
10672 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10673 PL_top_env = &PL_start_env;
10675 PL_op = proto_perl->Top;
10678 PL_Xpv = (XPV*)NULL;
10679 PL_na = proto_perl->Tna;
10681 PL_statbuf = proto_perl->Tstatbuf;
10682 PL_statcache = proto_perl->Tstatcache;
10683 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10684 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10686 PL_timesbuf = proto_perl->Ttimesbuf;
10689 PL_tainted = proto_perl->Ttainted;
10690 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10691 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10692 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10693 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10694 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10695 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10696 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10697 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10698 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10700 PL_restartop = proto_perl->Trestartop;
10701 PL_in_eval = proto_perl->Tin_eval;
10702 PL_delaymagic = proto_perl->Tdelaymagic;
10703 PL_dirty = proto_perl->Tdirty;
10704 PL_localizing = proto_perl->Tlocalizing;
10706 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10707 PL_hv_fetch_ent_mh = Nullhe;
10708 PL_modcount = proto_perl->Tmodcount;
10709 PL_lastgotoprobe = Nullop;
10710 PL_dumpindent = proto_perl->Tdumpindent;
10712 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10713 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10714 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10715 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10716 PL_efloatbuf = Nullch; /* reinits on demand */
10717 PL_efloatsize = 0; /* reinits on demand */
10721 PL_screamfirst = NULL;
10722 PL_screamnext = NULL;
10723 PL_maxscream = -1; /* reinits on demand */
10724 PL_lastscream = Nullsv;
10726 PL_watchaddr = NULL;
10727 PL_watchok = Nullch;
10729 PL_regdummy = proto_perl->Tregdummy;
10730 PL_regprecomp = Nullch;
10733 PL_colorset = 0; /* reinits PL_colors[] */
10734 /*PL_colors[6] = {0,0,0,0,0,0};*/
10735 PL_reginput = Nullch;
10736 PL_regbol = Nullch;
10737 PL_regeol = Nullch;
10738 PL_regstartp = (I32*)NULL;
10739 PL_regendp = (I32*)NULL;
10740 PL_reglastparen = (U32*)NULL;
10741 PL_reglastcloseparen = (U32*)NULL;
10742 PL_regtill = Nullch;
10743 PL_reg_start_tmp = (char**)NULL;
10744 PL_reg_start_tmpl = 0;
10745 PL_regdata = (struct reg_data*)NULL;
10748 PL_reg_eval_set = 0;
10750 PL_regprogram = (regnode*)NULL;
10752 PL_regcc = (CURCUR*)NULL;
10753 PL_reg_call_cc = (struct re_cc_state*)NULL;
10754 PL_reg_re = (regexp*)NULL;
10755 PL_reg_ganch = Nullch;
10756 PL_reg_sv = Nullsv;
10757 PL_reg_match_utf8 = FALSE;
10758 PL_reg_magic = (MAGIC*)NULL;
10760 PL_reg_oldcurpm = (PMOP*)NULL;
10761 PL_reg_curpm = (PMOP*)NULL;
10762 PL_reg_oldsaved = Nullch;
10763 PL_reg_oldsavedlen = 0;
10764 #ifdef PERL_OLD_COPY_ON_WRITE
10767 PL_reg_maxiter = 0;
10768 PL_reg_leftiter = 0;
10769 PL_reg_poscache = Nullch;
10770 PL_reg_poscache_size= 0;
10772 /* RE engine - function pointers */
10773 PL_regcompp = proto_perl->Tregcompp;
10774 PL_regexecp = proto_perl->Tregexecp;
10775 PL_regint_start = proto_perl->Tregint_start;
10776 PL_regint_string = proto_perl->Tregint_string;
10777 PL_regfree = proto_perl->Tregfree;
10779 PL_reginterp_cnt = 0;
10780 PL_reg_starttry = 0;
10782 /* Pluggable optimizer */
10783 PL_peepp = proto_perl->Tpeepp;
10785 PL_stashcache = newHV();
10787 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10788 ptr_table_free(PL_ptr_table);
10789 PL_ptr_table = NULL;
10792 /* Call the ->CLONE method, if it exists, for each of the stashes
10793 identified by sv_dup() above.
10795 while(av_len(param->stashes) != -1) {
10796 HV* const stash = (HV*) av_shift(param->stashes);
10797 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10798 if (cloner && GvCV(cloner)) {
10803 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10805 call_sv((SV*)GvCV(cloner), G_DISCARD);
10811 SvREFCNT_dec(param->stashes);
10813 /* orphaned? eg threads->new inside BEGIN or use */
10814 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10815 (void)SvREFCNT_inc(PL_compcv);
10816 SAVEFREESV(PL_compcv);
10822 #endif /* USE_ITHREADS */
10825 =head1 Unicode Support
10827 =for apidoc sv_recode_to_utf8
10829 The encoding is assumed to be an Encode object, on entry the PV
10830 of the sv is assumed to be octets in that encoding, and the sv
10831 will be converted into Unicode (and UTF-8).
10833 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10834 is not a reference, nothing is done to the sv. If the encoding is not
10835 an C<Encode::XS> Encoding object, bad things will happen.
10836 (See F<lib/encoding.pm> and L<Encode>).
10838 The PV of the sv is returned.
10843 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10846 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10860 Passing sv_yes is wrong - it needs to be or'ed set of constants
10861 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10862 remove converted chars from source.
10864 Both will default the value - let them.
10866 XPUSHs(&PL_sv_yes);
10869 call_method("decode", G_SCALAR);
10873 s = SvPV_const(uni, len);
10874 if (s != SvPVX_const(sv)) {
10875 SvGROW(sv, len + 1);
10876 Move(s, SvPVX(sv), len + 1, char);
10877 SvCUR_set(sv, len);
10884 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10888 =for apidoc sv_cat_decode
10890 The encoding is assumed to be an Encode object, the PV of the ssv is
10891 assumed to be octets in that encoding and decoding the input starts
10892 from the position which (PV + *offset) pointed to. The dsv will be
10893 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10894 when the string tstr appears in decoding output or the input ends on
10895 the PV of the ssv. The value which the offset points will be modified
10896 to the last input position on the ssv.
10898 Returns TRUE if the terminator was found, else returns FALSE.
10903 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10904 SV *ssv, int *offset, char *tstr, int tlen)
10908 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10919 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10920 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10922 call_method("cat_decode", G_SCALAR);
10924 ret = SvTRUE(TOPs);
10925 *offset = SvIV(offsv);
10931 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10936 /* ---------------------------------------------------------------------
10938 * support functions for report_uninit()
10941 /* the maxiumum size of array or hash where we will scan looking
10942 * for the undefined element that triggered the warning */
10944 #define FUV_MAX_SEARCH_SIZE 1000
10946 /* Look for an entry in the hash whose value has the same SV as val;
10947 * If so, return a mortal copy of the key. */
10950 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10953 register HE **array;
10956 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10957 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10960 array = HvARRAY(hv);
10962 for (i=HvMAX(hv); i>0; i--) {
10963 register HE *entry;
10964 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10965 if (HeVAL(entry) != val)
10967 if ( HeVAL(entry) == &PL_sv_undef ||
10968 HeVAL(entry) == &PL_sv_placeholder)
10972 if (HeKLEN(entry) == HEf_SVKEY)
10973 return sv_mortalcopy(HeKEY_sv(entry));
10974 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10980 /* Look for an entry in the array whose value has the same SV as val;
10981 * If so, return the index, otherwise return -1. */
10984 S_find_array_subscript(pTHX_ AV *av, SV* val)
10988 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10989 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10993 for (i=AvFILLp(av); i>=0; i--) {
10994 if (svp[i] == val && svp[i] != &PL_sv_undef)
11000 /* S_varname(): return the name of a variable, optionally with a subscript.
11001 * If gv is non-zero, use the name of that global, along with gvtype (one
11002 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11003 * targ. Depending on the value of the subscript_type flag, return:
11006 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11007 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11008 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11009 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11012 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11013 SV* keyname, I32 aindex, int subscript_type)
11016 SV * const name = sv_newmortal();
11019 buffer[0] = gvtype;
11022 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11024 gv_fullname4(name, gv, buffer, 0);
11026 if ((unsigned int)SvPVX(name)[1] <= 26) {
11028 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11030 /* Swap the 1 unprintable control character for the 2 byte pretty
11031 version - ie substr($name, 1, 1) = $buffer; */
11032 sv_insert(name, 1, 1, buffer, 2);
11037 CV * const cv = find_runcv(&unused);
11041 if (!cv || !CvPADLIST(cv))
11043 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11044 sv = *av_fetch(av, targ, FALSE);
11045 /* SvLEN in a pad name is not to be trusted */
11046 sv_setpv(name, SvPV_nolen_const(sv));
11049 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11050 SV * const sv = NEWSV(0,0);
11051 *SvPVX(name) = '$';
11052 Perl_sv_catpvf(aTHX_ name, "{%s}",
11053 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11056 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11057 *SvPVX(name) = '$';
11058 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11060 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11061 sv_insert(name, 0, 0, "within ", 7);
11068 =for apidoc find_uninit_var
11070 Find the name of the undefined variable (if any) that caused the operator o
11071 to issue a "Use of uninitialized value" warning.
11072 If match is true, only return a name if it's value matches uninit_sv.
11073 So roughly speaking, if a unary operator (such as OP_COS) generates a
11074 warning, then following the direct child of the op may yield an
11075 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11076 other hand, with OP_ADD there are two branches to follow, so we only print
11077 the variable name if we get an exact match.
11079 The name is returned as a mortal SV.
11081 Assumes that PL_op is the op that originally triggered the error, and that
11082 PL_comppad/PL_curpad points to the currently executing pad.
11088 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11096 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11097 uninit_sv == &PL_sv_placeholder)))
11100 switch (obase->op_type) {
11107 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11108 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11110 SV *keysv = Nullsv;
11111 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11113 if (pad) { /* @lex, %lex */
11114 sv = PAD_SVl(obase->op_targ);
11118 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11119 /* @global, %global */
11120 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11123 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11125 else /* @{expr}, %{expr} */
11126 return find_uninit_var(cUNOPx(obase)->op_first,
11130 /* attempt to find a match within the aggregate */
11132 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11134 subscript_type = FUV_SUBSCRIPT_HASH;
11137 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11139 subscript_type = FUV_SUBSCRIPT_ARRAY;
11142 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11145 return varname(gv, hash ? '%' : '@', obase->op_targ,
11146 keysv, index, subscript_type);
11150 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11152 return varname(Nullgv, '$', obase->op_targ,
11153 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11156 gv = cGVOPx_gv(obase);
11157 if (!gv || (match && GvSV(gv) != uninit_sv))
11159 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11162 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11165 av = (AV*)PAD_SV(obase->op_targ);
11166 if (!av || SvRMAGICAL(av))
11168 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11169 if (!svp || *svp != uninit_sv)
11172 return varname(Nullgv, '$', obase->op_targ,
11173 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11176 gv = cGVOPx_gv(obase);
11182 if (!av || SvRMAGICAL(av))
11184 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11185 if (!svp || *svp != uninit_sv)
11188 return varname(gv, '$', 0,
11189 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11194 o = cUNOPx(obase)->op_first;
11195 if (!o || o->op_type != OP_NULL ||
11196 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11198 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11202 if (PL_op == obase)
11203 /* $a[uninit_expr] or $h{uninit_expr} */
11204 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11207 o = cBINOPx(obase)->op_first;
11208 kid = cBINOPx(obase)->op_last;
11210 /* get the av or hv, and optionally the gv */
11212 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11213 sv = PAD_SV(o->op_targ);
11215 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11216 && cUNOPo->op_first->op_type == OP_GV)
11218 gv = cGVOPx_gv(cUNOPo->op_first);
11221 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11226 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11227 /* index is constant */
11231 if (obase->op_type == OP_HELEM) {
11232 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11233 if (!he || HeVAL(he) != uninit_sv)
11237 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11238 if (!svp || *svp != uninit_sv)
11242 if (obase->op_type == OP_HELEM)
11243 return varname(gv, '%', o->op_targ,
11244 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11246 return varname(gv, '@', o->op_targ, Nullsv,
11247 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11250 /* index is an expression;
11251 * attempt to find a match within the aggregate */
11252 if (obase->op_type == OP_HELEM) {
11253 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11255 return varname(gv, '%', o->op_targ,
11256 keysv, 0, FUV_SUBSCRIPT_HASH);
11259 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11261 return varname(gv, '@', o->op_targ,
11262 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11267 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11269 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11275 /* only examine RHS */
11276 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11279 o = cUNOPx(obase)->op_first;
11280 if (o->op_type == OP_PUSHMARK)
11283 if (!o->op_sibling) {
11284 /* one-arg version of open is highly magical */
11286 if (o->op_type == OP_GV) { /* open FOO; */
11288 if (match && GvSV(gv) != uninit_sv)
11290 return varname(gv, '$', 0,
11291 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11293 /* other possibilities not handled are:
11294 * open $x; or open my $x; should return '${*$x}'
11295 * open expr; should return '$'.expr ideally
11301 /* ops where $_ may be an implicit arg */
11305 if ( !(obase->op_flags & OPf_STACKED)) {
11306 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11307 ? PAD_SVl(obase->op_targ)
11310 sv = sv_newmortal();
11311 sv_setpvn(sv, "$_", 2);
11319 /* skip filehandle as it can't produce 'undef' warning */
11320 o = cUNOPx(obase)->op_first;
11321 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11322 o = o->op_sibling->op_sibling;
11329 match = 1; /* XS or custom code could trigger random warnings */
11334 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11335 return sv_2mortal(newSVpvn("${$/}", 5));
11340 if (!(obase->op_flags & OPf_KIDS))
11342 o = cUNOPx(obase)->op_first;
11348 /* if all except one arg are constant, or have no side-effects,
11349 * or are optimized away, then it's unambiguous */
11351 for (kid=o; kid; kid = kid->op_sibling) {
11353 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11354 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11355 || (kid->op_type == OP_PUSHMARK)
11359 if (o2) { /* more than one found */
11366 return find_uninit_var(o2, uninit_sv, match);
11368 /* scan all args */
11370 sv = find_uninit_var(o, uninit_sv, 1);
11382 =for apidoc report_uninit
11384 Print appropriate "Use of uninitialized variable" warning
11390 Perl_report_uninit(pTHX_ SV* uninit_sv)
11393 SV* varname = Nullsv;
11395 varname = find_uninit_var(PL_op, uninit_sv,0);
11397 sv_insert(varname, 0, 0, " ", 1);
11399 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11400 varname ? SvPV_nolen_const(varname) : "",
11401 " in ", OP_DESC(PL_op));
11404 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11410 * c-indentation-style: bsd
11411 * c-basic-offset: 4
11412 * indent-tabs-mode: t
11415 * ex: set ts=8 sts=4 sw=4 noet: