3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void ** const arena_root = &PL_body_arenaroots[sv_type];
644 void ** const root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void ** const r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv)) {
1894 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 == IS_NUMBER_IN_UV) {
1898 /* It's definitely an integer */
1899 if (numtype & IS_NUMBER_NEG) {
1900 if (value < (UV)IV_MIN)
1903 if (value < (UV)IV_MAX)
1908 if (ckWARN(WARN_NUMERIC))
1911 return I_V(Atof(SvPVX_const(sv)));
1914 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1915 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1920 /* Else this will drop through into the SvROK case just below, which
1921 will return within the {} for all code paths. */
1923 if (SvTHINKFIRST(sv)) {
1926 SV * const tmpstr=AMG_CALLun(sv,numer);
1927 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1928 return SvIV(tmpstr);
1931 return PTR2IV(SvRV(sv));
1934 sv_force_normal_flags(sv, 0);
1936 if (SvREADONLY(sv) && !SvOK(sv)) {
1937 if (ckWARN(WARN_UNINITIALIZED))
1943 if (S_sv_2iuv_common(aTHX_ sv))
1946 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1947 PTR2UV(sv),SvIVX(sv)));
1948 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1952 =for apidoc sv_2uv_flags
1954 Return the unsigned integer value of an SV, doing any necessary string
1955 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1956 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1962 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1966 if (SvGMAGICAL(sv)) {
1967 if (flags & SV_GMAGIC)
1972 return U_V(SvNVX(sv));
1973 if (SvPOKp(sv) && SvLEN(sv)) {
1976 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1978 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1979 == IS_NUMBER_IN_UV) {
1980 /* It's definitely an integer */
1981 if (!(numtype & IS_NUMBER_NEG))
1985 if (ckWARN(WARN_NUMERIC))
1988 return U_V(Atof(SvPVX_const(sv)));
1991 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1992 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1997 /* Else this will drop through into the SvROK case just below, which
1998 will return within the {} for all code paths. */
2000 if (SvTHINKFIRST(sv)) {
2003 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2004 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2005 return SvUV(tmpstr);
2006 return PTR2UV(SvRV(sv));
2009 sv_force_normal_flags(sv, 0);
2011 if (SvREADONLY(sv) && !SvOK(sv)) {
2012 if (ckWARN(WARN_UNINITIALIZED))
2018 if (S_sv_2iuv_common(aTHX_ sv))
2022 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2023 PTR2UV(sv),SvUVX(sv)));
2024 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2030 Return the num value of an SV, doing any necessary string or integer
2031 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2038 Perl_sv_2nv(pTHX_ register SV *sv)
2042 if (SvGMAGICAL(sv)) {
2046 if (SvPOKp(sv) && SvLEN(sv)) {
2047 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2048 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2050 return Atof(SvPVX_const(sv));
2054 return (NV)SvUVX(sv);
2056 return (NV)SvIVX(sv);
2061 assert(SvTYPE(sv) >= SVt_PVMG);
2062 /* This falls through to the report_uninit near the end of the
2064 } else if (SvTHINKFIRST(sv)) {
2068 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2069 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2070 return SvNV(tmpstr);
2071 return PTR2NV(SvRV(sv));
2074 sv_force_normal_flags(sv, 0);
2076 if (SvREADONLY(sv) && !SvOK(sv)) {
2077 if (ckWARN(WARN_UNINITIALIZED))
2082 if (SvTYPE(sv) < SVt_NV) {
2083 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2084 sv_upgrade(sv, SVt_NV);
2085 #ifdef USE_LONG_DOUBLE
2087 STORE_NUMERIC_LOCAL_SET_STANDARD();
2088 PerlIO_printf(Perl_debug_log,
2089 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2090 PTR2UV(sv), SvNVX(sv));
2091 RESTORE_NUMERIC_LOCAL();
2095 STORE_NUMERIC_LOCAL_SET_STANDARD();
2096 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2097 PTR2UV(sv), SvNVX(sv));
2098 RESTORE_NUMERIC_LOCAL();
2102 else if (SvTYPE(sv) < SVt_PVNV)
2103 sv_upgrade(sv, SVt_PVNV);
2108 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2109 #ifdef NV_PRESERVES_UV
2112 /* Only set the public NV OK flag if this NV preserves the IV */
2113 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2114 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2115 : (SvIVX(sv) == I_V(SvNVX(sv))))
2121 else if (SvPOKp(sv) && SvLEN(sv)) {
2123 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2124 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2126 #ifdef NV_PRESERVES_UV
2127 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2128 == IS_NUMBER_IN_UV) {
2129 /* It's definitely an integer */
2130 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2132 SvNV_set(sv, Atof(SvPVX_const(sv)));
2135 SvNV_set(sv, Atof(SvPVX_const(sv)));
2136 /* Only set the public NV OK flag if this NV preserves the value in
2137 the PV at least as well as an IV/UV would.
2138 Not sure how to do this 100% reliably. */
2139 /* if that shift count is out of range then Configure's test is
2140 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2142 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2143 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2144 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2145 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2146 /* Can't use strtol etc to convert this string, so don't try.
2147 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2150 /* value has been set. It may not be precise. */
2151 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2152 /* 2s complement assumption for (UV)IV_MIN */
2153 SvNOK_on(sv); /* Integer is too negative. */
2158 if (numtype & IS_NUMBER_NEG) {
2159 SvIV_set(sv, -(IV)value);
2160 } else if (value <= (UV)IV_MAX) {
2161 SvIV_set(sv, (IV)value);
2163 SvUV_set(sv, value);
2167 if (numtype & IS_NUMBER_NOT_INT) {
2168 /* I believe that even if the original PV had decimals,
2169 they are lost beyond the limit of the FP precision.
2170 However, neither is canonical, so both only get p
2171 flags. NWC, 2000/11/25 */
2172 /* Both already have p flags, so do nothing */
2174 const NV nv = SvNVX(sv);
2175 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2176 if (SvIVX(sv) == I_V(nv)) {
2179 /* It had no "." so it must be integer. */
2183 /* between IV_MAX and NV(UV_MAX).
2184 Could be slightly > UV_MAX */
2186 if (numtype & IS_NUMBER_NOT_INT) {
2187 /* UV and NV both imprecise. */
2189 const UV nv_as_uv = U_V(nv);
2191 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2200 #endif /* NV_PRESERVES_UV */
2203 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2205 assert (SvTYPE(sv) >= SVt_NV);
2206 /* Typically the caller expects that sv_any is not NULL now. */
2207 /* XXX Ilya implies that this is a bug in callers that assume this
2208 and ideally should be fixed. */
2211 #if defined(USE_LONG_DOUBLE)
2213 STORE_NUMERIC_LOCAL_SET_STANDARD();
2214 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2215 PTR2UV(sv), SvNVX(sv));
2216 RESTORE_NUMERIC_LOCAL();
2220 STORE_NUMERIC_LOCAL_SET_STANDARD();
2221 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2222 PTR2UV(sv), SvNVX(sv));
2223 RESTORE_NUMERIC_LOCAL();
2229 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2230 * UV as a string towards the end of buf, and return pointers to start and
2233 * We assume that buf is at least TYPE_CHARS(UV) long.
2237 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2239 char *ptr = buf + TYPE_CHARS(UV);
2240 char * const ebuf = ptr;
2253 *--ptr = '0' + (char)(uv % 10);
2261 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2262 * a regexp to its stringified form.
2266 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2267 const regexp * const re = (regexp *)mg->mg_obj;
2270 const char *fptr = "msix";
2275 bool need_newline = 0;
2276 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2278 while((ch = *fptr++)) {
2280 reflags[left++] = ch;
2283 reflags[right--] = ch;
2288 reflags[left] = '-';
2292 mg->mg_len = re->prelen + 4 + left;
2294 * If /x was used, we have to worry about a regex ending with a
2295 * comment later being embedded within another regex. If so, we don't
2296 * want this regex's "commentization" to leak out to the right part of
2297 * the enclosing regex, we must cap it with a newline.
2299 * So, if /x was used, we scan backwards from the end of the regex. If
2300 * we find a '#' before we find a newline, we need to add a newline
2301 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2302 * we don't need to add anything. -jfriedl
2304 if (PMf_EXTENDED & re->reganch) {
2305 const char *endptr = re->precomp + re->prelen;
2306 while (endptr >= re->precomp) {
2307 const char c = *(endptr--);
2309 break; /* don't need another */
2311 /* we end while in a comment, so we need a newline */
2312 mg->mg_len++; /* save space for it */
2313 need_newline = 1; /* note to add it */
2319 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2320 mg->mg_ptr[0] = '(';
2321 mg->mg_ptr[1] = '?';
2322 Copy(reflags, mg->mg_ptr+2, left, char);
2323 *(mg->mg_ptr+left+2) = ':';
2324 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2326 mg->mg_ptr[mg->mg_len - 2] = '\n';
2327 mg->mg_ptr[mg->mg_len - 1] = ')';
2328 mg->mg_ptr[mg->mg_len] = 0;
2330 PL_reginterp_cnt += re->program[0].next_off;
2332 if (re->reganch & ROPT_UTF8)
2342 =for apidoc sv_2pv_flags
2344 Returns a pointer to the string value of an SV, and sets *lp to its length.
2345 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2347 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2348 usually end up here too.
2354 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2364 if (SvGMAGICAL(sv)) {
2365 if (flags & SV_GMAGIC)
2370 if (flags & SV_MUTABLE_RETURN)
2371 return SvPVX_mutable(sv);
2372 if (flags & SV_CONST_RETURN)
2373 return (char *)SvPVX_const(sv);
2376 if (SvIOKp(sv) || SvNOKp(sv)) {
2377 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2381 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2382 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2384 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2387 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2388 /* Sneaky stuff here */
2389 SV * const tsv = newSVpvn(tbuf, len);
2399 #ifdef FIXNEGATIVEZERO
2400 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2406 SvUPGRADE(sv, SVt_PV);
2409 s = SvGROW_mutable(sv, len + 1);
2412 return memcpy(s, tbuf, len + 1);
2416 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2417 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2424 /* Else this will drop through into the SvROK case just below, which
2425 will return within the {} for all code paths. */
2427 if (SvTHINKFIRST(sv)) {
2431 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2432 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2434 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2437 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2438 if (flags & SV_CONST_RETURN) {
2439 pv = (char *) SvPVX_const(tmpstr);
2441 pv = (flags & SV_MUTABLE_RETURN)
2442 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2445 *lp = SvCUR(tmpstr);
2447 pv = sv_2pv_flags(tmpstr, lp, flags);
2457 const SV *const referent = (SV*)SvRV(sv);
2460 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2461 } else if (SvTYPE(referent) == SVt_PVMG
2462 && ((SvFLAGS(referent) &
2463 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2464 == (SVs_OBJECT|SVs_SMG))
2465 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2466 return S_stringify_regexp(aTHX_ sv, mg, lp);
2468 const char *const typestr = sv_reftype(referent, 0);
2470 tsv = sv_newmortal();
2471 if (SvOBJECT(referent)) {
2472 const char *const name = HvNAME_get(SvSTASH(referent));
2473 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2474 name ? name : "__ANON__" , typestr,
2478 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2486 if (SvREADONLY(sv) && !SvOK(sv)) {
2487 if (ckWARN(WARN_UNINITIALIZED))
2494 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2495 /* I'm assuming that if both IV and NV are equally valid then
2496 converting the IV is going to be more efficient */
2497 const U32 isIOK = SvIOK(sv);
2498 const U32 isUIOK = SvIsUV(sv);
2499 char buf[TYPE_CHARS(UV)];
2502 if (SvTYPE(sv) < SVt_PVIV)
2503 sv_upgrade(sv, SVt_PVIV);
2505 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2507 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2508 /* inlined from sv_setpvn */
2509 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2510 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2511 SvCUR_set(sv, ebuf - ptr);
2521 else if (SvNOKp(sv)) {
2522 if (SvTYPE(sv) < SVt_PVNV)
2523 sv_upgrade(sv, SVt_PVNV);
2524 /* The +20 is pure guesswork. Configure test needed. --jhi */
2525 s = SvGROW_mutable(sv, NV_DIG + 20);
2526 olderrno = errno; /* some Xenix systems wipe out errno here */
2528 if (SvNVX(sv) == 0.0)
2529 (void)strcpy(s,"0");
2533 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2536 #ifdef FIXNEGATIVEZERO
2537 if (*s == '-' && s[1] == '0' && !s[2])
2547 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2551 if (SvTYPE(sv) < SVt_PV)
2552 /* Typically the caller expects that sv_any is not NULL now. */
2553 sv_upgrade(sv, SVt_PV);
2557 const STRLEN len = s - SvPVX_const(sv);
2563 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2564 PTR2UV(sv),SvPVX_const(sv)));
2565 if (flags & SV_CONST_RETURN)
2566 return (char *)SvPVX_const(sv);
2567 if (flags & SV_MUTABLE_RETURN)
2568 return SvPVX_mutable(sv);
2573 =for apidoc sv_copypv
2575 Copies a stringified representation of the source SV into the
2576 destination SV. Automatically performs any necessary mg_get and
2577 coercion of numeric values into strings. Guaranteed to preserve
2578 UTF-8 flag even from overloaded objects. Similar in nature to
2579 sv_2pv[_flags] but operates directly on an SV instead of just the
2580 string. Mostly uses sv_2pv_flags to do its work, except when that
2581 would lose the UTF-8'ness of the PV.
2587 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2590 const char * const s = SvPV_const(ssv,len);
2591 sv_setpvn(dsv,s,len);
2599 =for apidoc sv_2pvbyte
2601 Return a pointer to the byte-encoded representation of the SV, and set *lp
2602 to its length. May cause the SV to be downgraded from UTF-8 as a
2605 Usually accessed via the C<SvPVbyte> macro.
2611 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2613 sv_utf8_downgrade(sv,0);
2614 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2618 =for apidoc sv_2pvutf8
2620 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2621 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2623 Usually accessed via the C<SvPVutf8> macro.
2629 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2631 sv_utf8_upgrade(sv);
2632 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2637 =for apidoc sv_2bool
2639 This function is only called on magical items, and is only used by
2640 sv_true() or its macro equivalent.
2646 Perl_sv_2bool(pTHX_ register SV *sv)
2654 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2655 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2656 return (bool)SvTRUE(tmpsv);
2657 return SvRV(sv) != 0;
2660 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2662 (*sv->sv_u.svu_pv > '0' ||
2663 Xpvtmp->xpv_cur > 1 ||
2664 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2671 return SvIVX(sv) != 0;
2674 return SvNVX(sv) != 0.0;
2682 =for apidoc sv_utf8_upgrade
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.
2689 This is not as a general purpose byte encoding to Unicode interface:
2690 use the Encode extension for that.
2692 =for apidoc sv_utf8_upgrade_flags
2694 Converts the PV of an SV to its UTF-8-encoded form.
2695 Forces the SV to string form if it is not already.
2696 Always sets the SvUTF8 flag to avoid future validity checks even
2697 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2698 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2699 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2701 This is not as a general purpose byte encoding to Unicode interface:
2702 use the Encode extension for that.
2708 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2710 if (sv == &PL_sv_undef)
2714 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2715 (void) sv_2pv_flags(sv,&len, flags);
2719 (void) SvPV_force(sv,len);
2728 sv_force_normal_flags(sv, 0);
2731 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2732 sv_recode_to_utf8(sv, PL_encoding);
2733 else { /* Assume Latin-1/EBCDIC */
2734 /* This function could be much more efficient if we
2735 * had a FLAG in SVs to signal if there are any hibit
2736 * chars in the PV. Given that there isn't such a flag
2737 * make the loop as fast as possible. */
2738 const U8 * const s = (U8 *) SvPVX_const(sv);
2739 const U8 * const e = (U8 *) SvEND(sv);
2744 /* Check for hi bit */
2745 if (!NATIVE_IS_INVARIANT(ch)) {
2746 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2747 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2749 SvPV_free(sv); /* No longer using what was there before. */
2750 SvPV_set(sv, (char*)recoded);
2751 SvCUR_set(sv, len - 1);
2752 SvLEN_set(sv, len); /* No longer know the real size. */
2756 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2763 =for apidoc sv_utf8_downgrade
2765 Attempts to convert the PV of an SV from characters to bytes.
2766 If the PV contains a character beyond byte, this conversion will fail;
2767 in this case, either returns false or, if C<fail_ok> is not
2770 This is not as a general purpose Unicode to byte encoding interface:
2771 use the Encode extension for that.
2777 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2779 if (SvPOKp(sv) && SvUTF8(sv)) {
2785 sv_force_normal_flags(sv, 0);
2787 s = (U8 *) SvPV(sv, len);
2788 if (!utf8_to_bytes(s, &len)) {
2793 Perl_croak(aTHX_ "Wide character in %s",
2796 Perl_croak(aTHX_ "Wide character");
2807 =for apidoc sv_utf8_encode
2809 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2810 flag off so that it looks like octets again.
2816 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2818 (void) sv_utf8_upgrade(sv);
2820 sv_force_normal_flags(sv, 0);
2822 if (SvREADONLY(sv)) {
2823 Perl_croak(aTHX_ PL_no_modify);
2829 =for apidoc sv_utf8_decode
2831 If the PV of the SV is an octet sequence in UTF-8
2832 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2833 so that it looks like a character. If the PV contains only single-byte
2834 characters, the C<SvUTF8> flag stays being off.
2835 Scans PV for validity and returns false if the PV is invalid UTF-8.
2841 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2847 /* The octets may have got themselves encoded - get them back as
2850 if (!sv_utf8_downgrade(sv, TRUE))
2853 /* it is actually just a matter of turning the utf8 flag on, but
2854 * we want to make sure everything inside is valid utf8 first.
2856 c = (const U8 *) SvPVX_const(sv);
2857 if (!is_utf8_string(c, SvCUR(sv)+1))
2859 e = (const U8 *) SvEND(sv);
2862 if (!UTF8_IS_INVARIANT(ch)) {
2872 =for apidoc sv_setsv
2874 Copies the contents of the source SV C<ssv> into the destination SV
2875 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2876 function if the source SV needs to be reused. Does not handle 'set' magic.
2877 Loosely speaking, it performs a copy-by-value, obliterating any previous
2878 content of the destination.
2880 You probably want to use one of the assortment of wrappers, such as
2881 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2882 C<SvSetMagicSV_nosteal>.
2884 =for apidoc sv_setsv_flags
2886 Copies the contents of the source SV C<ssv> into the destination SV
2887 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2888 function if the source SV needs to be reused. Does not handle 'set' magic.
2889 Loosely speaking, it performs a copy-by-value, obliterating any previous
2890 content of the destination.
2891 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2892 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2893 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2894 and C<sv_setsv_nomg> are implemented in terms of this function.
2896 You probably want to use one of the assortment of wrappers, such as
2897 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2898 C<SvSetMagicSV_nosteal>.
2900 This is the primary function for copying scalars, and most other
2901 copy-ish functions and macros use this underneath.
2907 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2909 register U32 sflags;
2915 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2917 sstr = &PL_sv_undef;
2918 stype = SvTYPE(sstr);
2919 dtype = SvTYPE(dstr);
2924 /* need to nuke the magic */
2926 SvRMAGICAL_off(dstr);
2929 /* There's a lot of redundancy below but we're going for speed here */
2934 if (dtype != SVt_PVGV) {
2935 (void)SvOK_off(dstr);
2943 sv_upgrade(dstr, SVt_IV);
2946 sv_upgrade(dstr, SVt_PVNV);
2950 sv_upgrade(dstr, SVt_PVIV);
2953 (void)SvIOK_only(dstr);
2954 SvIV_set(dstr, SvIVX(sstr));
2957 if (SvTAINTED(sstr))
2968 sv_upgrade(dstr, SVt_NV);
2973 sv_upgrade(dstr, SVt_PVNV);
2976 SvNV_set(dstr, SvNVX(sstr));
2977 (void)SvNOK_only(dstr);
2978 if (SvTAINTED(sstr))
2986 sv_upgrade(dstr, SVt_RV);
2987 else if (dtype == SVt_PVGV &&
2988 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2991 if (GvIMPORTED(dstr) != GVf_IMPORTED
2992 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2994 GvIMPORTED_on(dstr);
3003 #ifdef PERL_OLD_COPY_ON_WRITE
3004 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3005 if (dtype < SVt_PVIV)
3006 sv_upgrade(dstr, SVt_PVIV);
3013 sv_upgrade(dstr, SVt_PV);
3016 if (dtype < SVt_PVIV)
3017 sv_upgrade(dstr, SVt_PVIV);
3020 if (dtype < SVt_PVNV)
3021 sv_upgrade(dstr, SVt_PVNV);
3028 const char * const type = sv_reftype(sstr,0);
3030 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3032 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3037 if (dtype <= SVt_PVGV) {
3039 if (dtype != SVt_PVGV) {
3040 const char * const name = GvNAME(sstr);
3041 const STRLEN len = GvNAMELEN(sstr);
3042 /* don't upgrade SVt_PVLV: it can hold a glob */
3043 if (dtype != SVt_PVLV)
3044 sv_upgrade(dstr, SVt_PVGV);
3045 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3046 GvSTASH(dstr) = GvSTASH(sstr);
3048 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3049 GvNAME(dstr) = savepvn(name, len);
3050 GvNAMELEN(dstr) = len;
3051 SvFAKE_on(dstr); /* can coerce to non-glob */
3054 #ifdef GV_UNIQUE_CHECK
3055 if (GvUNIQUE((GV*)dstr)) {
3056 Perl_croak(aTHX_ PL_no_modify);
3060 (void)SvOK_off(dstr);
3061 GvINTRO_off(dstr); /* one-shot flag */
3063 GvGP(dstr) = gp_ref(GvGP(sstr));
3064 if (SvTAINTED(sstr))
3066 if (GvIMPORTED(dstr) != GVf_IMPORTED
3067 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3069 GvIMPORTED_on(dstr);
3077 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3079 if ((int)SvTYPE(sstr) != stype) {
3080 stype = SvTYPE(sstr);
3081 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3085 if (stype == SVt_PVLV)
3086 SvUPGRADE(dstr, SVt_PVNV);
3088 SvUPGRADE(dstr, (U32)stype);
3091 sflags = SvFLAGS(sstr);
3093 if (sflags & SVf_ROK) {
3094 if (dtype >= SVt_PV) {
3095 if (dtype == SVt_PVGV) {
3096 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3098 const int intro = GvINTRO(dstr);
3100 #ifdef GV_UNIQUE_CHECK
3101 if (GvUNIQUE((GV*)dstr)) {
3102 Perl_croak(aTHX_ PL_no_modify);
3107 GvINTRO_off(dstr); /* one-shot flag */
3108 GvLINE(dstr) = CopLINE(PL_curcop);
3109 GvEGV(dstr) = (GV*)dstr;
3112 switch (SvTYPE(sref)) {
3115 SAVEGENERICSV(GvAV(dstr));
3117 dref = (SV*)GvAV(dstr);
3118 GvAV(dstr) = (AV*)sref;
3119 if (!GvIMPORTED_AV(dstr)
3120 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3122 GvIMPORTED_AV_on(dstr);
3127 SAVEGENERICSV(GvHV(dstr));
3129 dref = (SV*)GvHV(dstr);
3130 GvHV(dstr) = (HV*)sref;
3131 if (!GvIMPORTED_HV(dstr)
3132 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3134 GvIMPORTED_HV_on(dstr);
3139 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3140 SvREFCNT_dec(GvCV(dstr));
3141 GvCV(dstr) = Nullcv;
3142 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3143 PL_sub_generation++;
3145 SAVEGENERICSV(GvCV(dstr));
3148 dref = (SV*)GvCV(dstr);
3149 if (GvCV(dstr) != (CV*)sref) {
3150 CV* const cv = GvCV(dstr);
3152 if (!GvCVGEN((GV*)dstr) &&
3153 (CvROOT(cv) || CvXSUB(cv)))
3155 /* Redefining a sub - warning is mandatory if
3156 it was a const and its value changed. */
3157 if (ckWARN(WARN_REDEFINE)
3159 && (!CvCONST((CV*)sref)
3160 || sv_cmp(cv_const_sv(cv),
3161 cv_const_sv((CV*)sref)))))
3163 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3165 ? "Constant subroutine %s::%s redefined"
3166 : "Subroutine %s::%s redefined",
3167 HvNAME_get(GvSTASH((GV*)dstr)),
3168 GvENAME((GV*)dstr));
3172 cv_ckproto(cv, (GV*)dstr,
3174 ? SvPVX_const(sref) : Nullch);
3176 GvCV(dstr) = (CV*)sref;
3177 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3178 GvASSUMECV_on(dstr);
3179 PL_sub_generation++;
3181 if (!GvIMPORTED_CV(dstr)
3182 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3184 GvIMPORTED_CV_on(dstr);
3189 SAVEGENERICSV(GvIOp(dstr));
3191 dref = (SV*)GvIOp(dstr);
3192 GvIOp(dstr) = (IO*)sref;
3196 SAVEGENERICSV(GvFORM(dstr));
3198 dref = (SV*)GvFORM(dstr);
3199 GvFORM(dstr) = (CV*)sref;
3203 SAVEGENERICSV(GvSV(dstr));
3205 dref = (SV*)GvSV(dstr);
3207 if (!GvIMPORTED_SV(dstr)
3208 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3210 GvIMPORTED_SV_on(dstr);
3216 if (SvTAINTED(sstr))
3220 if (SvPVX_const(dstr)) {
3226 (void)SvOK_off(dstr);
3227 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3229 if (sflags & SVp_NOK) {
3231 /* Only set the public OK flag if the source has public OK. */
3232 if (sflags & SVf_NOK)
3233 SvFLAGS(dstr) |= SVf_NOK;
3234 SvNV_set(dstr, SvNVX(sstr));
3236 if (sflags & SVp_IOK) {
3237 (void)SvIOKp_on(dstr);
3238 if (sflags & SVf_IOK)
3239 SvFLAGS(dstr) |= SVf_IOK;
3240 if (sflags & SVf_IVisUV)
3242 SvIV_set(dstr, SvIVX(sstr));
3244 if (SvAMAGIC(sstr)) {
3248 else if (sflags & SVp_POK) {
3252 * Check to see if we can just swipe the string. If so, it's a
3253 * possible small lose on short strings, but a big win on long ones.
3254 * It might even be a win on short strings if SvPVX_const(dstr)
3255 * has to be allocated and SvPVX_const(sstr) has to be freed.
3258 /* Whichever path we take through the next code, we want this true,
3259 and doing it now facilitates the COW check. */
3260 (void)SvPOK_only(dstr);
3263 /* We're not already COW */
3264 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3265 #ifndef PERL_OLD_COPY_ON_WRITE
3266 /* or we are, but dstr isn't a suitable target. */
3267 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3272 (sflags & SVs_TEMP) && /* slated for free anyway? */
3273 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3274 (!(flags & SV_NOSTEAL)) &&
3275 /* and we're allowed to steal temps */
3276 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3277 SvLEN(sstr) && /* and really is a string */
3278 /* and won't be needed again, potentially */
3279 !(PL_op && PL_op->op_type == OP_AASSIGN))
3280 #ifdef PERL_OLD_COPY_ON_WRITE
3281 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3282 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3283 && SvTYPE(sstr) >= SVt_PVIV)
3286 /* Failed the swipe test, and it's not a shared hash key either.
3287 Have to copy the string. */
3288 STRLEN len = SvCUR(sstr);
3289 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3290 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3291 SvCUR_set(dstr, len);
3292 *SvEND(dstr) = '\0';
3294 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3296 /* Either it's a shared hash key, or it's suitable for
3297 copy-on-write or we can swipe the string. */
3299 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3303 #ifdef PERL_OLD_COPY_ON_WRITE
3305 /* I believe I should acquire a global SV mutex if
3306 it's a COW sv (not a shared hash key) to stop
3307 it going un copy-on-write.
3308 If the source SV has gone un copy on write between up there
3309 and down here, then (assert() that) it is of the correct
3310 form to make it copy on write again */
3311 if ((sflags & (SVf_FAKE | SVf_READONLY))
3312 != (SVf_FAKE | SVf_READONLY)) {
3313 SvREADONLY_on(sstr);
3315 /* Make the source SV into a loop of 1.
3316 (about to become 2) */
3317 SV_COW_NEXT_SV_SET(sstr, sstr);
3321 /* Initial code is common. */
3322 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3327 /* making another shared SV. */
3328 STRLEN cur = SvCUR(sstr);
3329 STRLEN len = SvLEN(sstr);
3330 #ifdef PERL_OLD_COPY_ON_WRITE
3332 assert (SvTYPE(dstr) >= SVt_PVIV);
3333 /* SvIsCOW_normal */
3334 /* splice us in between source and next-after-source. */
3335 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3336 SV_COW_NEXT_SV_SET(sstr, dstr);
3337 SvPV_set(dstr, SvPVX_mutable(sstr));
3341 /* SvIsCOW_shared_hash */
3342 DEBUG_C(PerlIO_printf(Perl_debug_log,
3343 "Copy on write: Sharing hash\n"));
3345 assert (SvTYPE(dstr) >= SVt_PV);
3347 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3349 SvLEN_set(dstr, len);
3350 SvCUR_set(dstr, cur);
3351 SvREADONLY_on(dstr);
3353 /* Relesase a global SV mutex. */
3356 { /* Passes the swipe test. */
3357 SvPV_set(dstr, SvPVX_mutable(sstr));
3358 SvLEN_set(dstr, SvLEN(sstr));
3359 SvCUR_set(dstr, SvCUR(sstr));
3362 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3363 SvPV_set(sstr, Nullch);
3369 if (sflags & SVf_UTF8)
3371 if (sflags & SVp_NOK) {
3373 if (sflags & SVf_NOK)
3374 SvFLAGS(dstr) |= SVf_NOK;
3375 SvNV_set(dstr, SvNVX(sstr));
3377 if (sflags & SVp_IOK) {
3378 (void)SvIOKp_on(dstr);
3379 if (sflags & SVf_IOK)
3380 SvFLAGS(dstr) |= SVf_IOK;
3381 if (sflags & SVf_IVisUV)
3383 SvIV_set(dstr, SvIVX(sstr));
3386 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3387 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3388 smg->mg_ptr, smg->mg_len);
3389 SvRMAGICAL_on(dstr);
3392 else if (sflags & SVp_IOK) {
3393 if (sflags & SVf_IOK)
3394 (void)SvIOK_only(dstr);
3396 (void)SvOK_off(dstr);
3397 (void)SvIOKp_on(dstr);
3399 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3400 if (sflags & SVf_IVisUV)
3402 SvIV_set(dstr, SvIVX(sstr));
3403 if (sflags & SVp_NOK) {
3404 if (sflags & SVf_NOK)
3405 (void)SvNOK_on(dstr);
3407 (void)SvNOKp_on(dstr);
3408 SvNV_set(dstr, SvNVX(sstr));
3411 else if (sflags & SVp_NOK) {
3412 if (sflags & SVf_NOK)
3413 (void)SvNOK_only(dstr);
3415 (void)SvOK_off(dstr);
3418 SvNV_set(dstr, SvNVX(sstr));
3421 if (dtype == SVt_PVGV) {
3422 if (ckWARN(WARN_MISC))
3423 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3426 (void)SvOK_off(dstr);
3428 if (SvTAINTED(sstr))
3433 =for apidoc sv_setsv_mg
3435 Like C<sv_setsv>, but also handles 'set' magic.
3441 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3443 sv_setsv(dstr,sstr);
3447 #ifdef PERL_OLD_COPY_ON_WRITE
3449 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3451 STRLEN cur = SvCUR(sstr);
3452 STRLEN len = SvLEN(sstr);
3453 register char *new_pv;
3456 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3464 if (SvTHINKFIRST(dstr))
3465 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3466 else if (SvPVX_const(dstr))
3467 Safefree(SvPVX_const(dstr));
3471 SvUPGRADE(dstr, SVt_PVIV);
3473 assert (SvPOK(sstr));
3474 assert (SvPOKp(sstr));
3475 assert (!SvIOK(sstr));
3476 assert (!SvIOKp(sstr));
3477 assert (!SvNOK(sstr));
3478 assert (!SvNOKp(sstr));
3480 if (SvIsCOW(sstr)) {
3482 if (SvLEN(sstr) == 0) {
3483 /* source is a COW shared hash key. */
3484 DEBUG_C(PerlIO_printf(Perl_debug_log,
3485 "Fast copy on write: Sharing hash\n"));
3486 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3489 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3491 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3492 SvUPGRADE(sstr, SVt_PVIV);
3493 SvREADONLY_on(sstr);
3495 DEBUG_C(PerlIO_printf(Perl_debug_log,
3496 "Fast copy on write: Converting sstr to COW\n"));
3497 SV_COW_NEXT_SV_SET(dstr, sstr);
3499 SV_COW_NEXT_SV_SET(sstr, dstr);
3500 new_pv = SvPVX_mutable(sstr);
3503 SvPV_set(dstr, new_pv);
3504 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3507 SvLEN_set(dstr, len);
3508 SvCUR_set(dstr, cur);
3517 =for apidoc sv_setpvn
3519 Copies a string into an SV. The C<len> parameter indicates the number of
3520 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3521 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3527 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3529 register char *dptr;
3531 SV_CHECK_THINKFIRST_COW_DROP(sv);
3537 /* len is STRLEN which is unsigned, need to copy to signed */
3540 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3542 SvUPGRADE(sv, SVt_PV);
3544 dptr = SvGROW(sv, len + 1);
3545 Move(ptr,dptr,len,char);
3548 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3553 =for apidoc sv_setpvn_mg
3555 Like C<sv_setpvn>, but also handles 'set' magic.
3561 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3563 sv_setpvn(sv,ptr,len);
3568 =for apidoc sv_setpv
3570 Copies a string into an SV. The string must be null-terminated. Does not
3571 handle 'set' magic. See C<sv_setpv_mg>.
3577 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3579 register STRLEN len;
3581 SV_CHECK_THINKFIRST_COW_DROP(sv);
3587 SvUPGRADE(sv, SVt_PV);
3589 SvGROW(sv, len + 1);
3590 Move(ptr,SvPVX(sv),len+1,char);
3592 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3597 =for apidoc sv_setpv_mg
3599 Like C<sv_setpv>, but also handles 'set' magic.
3605 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3612 =for apidoc sv_usepvn
3614 Tells an SV to use C<ptr> to find its string value. Normally the string is
3615 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3616 The C<ptr> should point to memory that was allocated by C<malloc>. The
3617 string length, C<len>, must be supplied. This function will realloc the
3618 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3619 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3620 See C<sv_usepvn_mg>.
3626 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3629 SV_CHECK_THINKFIRST_COW_DROP(sv);
3630 SvUPGRADE(sv, SVt_PV);
3635 if (SvPVX_const(sv))
3638 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3639 ptr = saferealloc (ptr, allocate);
3642 SvLEN_set(sv, allocate);
3644 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3649 =for apidoc sv_usepvn_mg
3651 Like C<sv_usepvn>, but also handles 'set' magic.
3657 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3659 sv_usepvn(sv,ptr,len);
3663 #ifdef PERL_OLD_COPY_ON_WRITE
3664 /* Need to do this *after* making the SV normal, as we need the buffer
3665 pointer to remain valid until after we've copied it. If we let go too early,
3666 another thread could invalidate it by unsharing last of the same hash key
3667 (which it can do by means other than releasing copy-on-write Svs)
3668 or by changing the other copy-on-write SVs in the loop. */
3670 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3672 if (len) { /* this SV was SvIsCOW_normal(sv) */
3673 /* we need to find the SV pointing to us. */
3674 SV * const current = SV_COW_NEXT_SV(after);
3676 if (current == sv) {
3677 /* The SV we point to points back to us (there were only two of us
3679 Hence other SV is no longer copy on write either. */
3681 SvREADONLY_off(after);
3683 /* We need to follow the pointers around the loop. */
3685 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3688 /* don't loop forever if the structure is bust, and we have
3689 a pointer into a closed loop. */
3690 assert (current != after);
3691 assert (SvPVX_const(current) == pvx);
3693 /* Make the SV before us point to the SV after us. */
3694 SV_COW_NEXT_SV_SET(current, after);
3697 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3702 Perl_sv_release_IVX(pTHX_ register SV *sv)
3705 sv_force_normal_flags(sv, 0);
3711 =for apidoc sv_force_normal_flags
3713 Undo various types of fakery on an SV: if the PV is a shared string, make
3714 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3715 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3716 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3717 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3718 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3719 set to some other value.) In addition, the C<flags> parameter gets passed to
3720 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3721 with flags set to 0.
3727 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3729 #ifdef PERL_OLD_COPY_ON_WRITE
3730 if (SvREADONLY(sv)) {
3731 /* At this point I believe I should acquire a global SV mutex. */
3733 const char * const pvx = SvPVX_const(sv);
3734 const STRLEN len = SvLEN(sv);
3735 const STRLEN cur = SvCUR(sv);
3736 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3738 PerlIO_printf(Perl_debug_log,
3739 "Copy on write: Force normal %ld\n",
3745 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3746 SvPV_set(sv, (char*)0);
3748 if (flags & SV_COW_DROP_PV) {
3749 /* OK, so we don't need to copy our buffer. */
3752 SvGROW(sv, cur + 1);
3753 Move(pvx,SvPVX(sv),cur,char);
3757 sv_release_COW(sv, pvx, len, next);
3762 else if (IN_PERL_RUNTIME)
3763 Perl_croak(aTHX_ PL_no_modify);
3764 /* At this point I believe that I can drop the global SV mutex. */
3767 if (SvREADONLY(sv)) {
3769 const char * const pvx = SvPVX_const(sv);
3770 const STRLEN len = SvCUR(sv);
3773 SvPV_set(sv, Nullch);
3775 SvGROW(sv, len + 1);
3776 Move(pvx,SvPVX(sv),len,char);
3778 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3780 else if (IN_PERL_RUNTIME)
3781 Perl_croak(aTHX_ PL_no_modify);
3785 sv_unref_flags(sv, flags);
3786 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3793 Efficient removal of characters from the beginning of the string buffer.
3794 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3795 the string buffer. The C<ptr> becomes the first character of the adjusted
3796 string. Uses the "OOK hack".
3797 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3798 refer to the same chunk of data.
3804 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3806 register STRLEN delta;
3807 if (!ptr || !SvPOKp(sv))
3809 delta = ptr - SvPVX_const(sv);
3810 SV_CHECK_THINKFIRST(sv);
3811 if (SvTYPE(sv) < SVt_PVIV)
3812 sv_upgrade(sv,SVt_PVIV);
3815 if (!SvLEN(sv)) { /* make copy of shared string */
3816 const char *pvx = SvPVX_const(sv);
3817 const STRLEN len = SvCUR(sv);
3818 SvGROW(sv, len + 1);
3819 Move(pvx,SvPVX(sv),len,char);
3823 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3824 and we do that anyway inside the SvNIOK_off
3826 SvFLAGS(sv) |= SVf_OOK;
3829 SvLEN_set(sv, SvLEN(sv) - delta);
3830 SvCUR_set(sv, SvCUR(sv) - delta);
3831 SvPV_set(sv, SvPVX(sv) + delta);
3832 SvIV_set(sv, SvIVX(sv) + delta);
3836 =for apidoc sv_catpvn
3838 Concatenates the string onto the end of the string which is in the SV. The
3839 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3840 status set, then the bytes appended should be valid UTF-8.
3841 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3843 =for apidoc sv_catpvn_flags
3845 Concatenates the string onto the end of the string which is in the SV. The
3846 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3847 status set, then the bytes appended should be valid UTF-8.
3848 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3849 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3850 in terms of this function.
3856 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3859 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3861 SvGROW(dsv, dlen + slen + 1);
3863 sstr = SvPVX_const(dsv);
3864 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3865 SvCUR_set(dsv, SvCUR(dsv) + slen);
3867 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3869 if (flags & SV_SMAGIC)
3874 =for apidoc sv_catsv
3876 Concatenates the string from SV C<ssv> onto the end of the string in
3877 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3878 not 'set' magic. See C<sv_catsv_mg>.
3880 =for apidoc sv_catsv_flags
3882 Concatenates the string from SV C<ssv> onto the end of the string in
3883 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3884 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3885 and C<sv_catsv_nomg> are implemented in terms of this function.
3890 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3894 const char *spv = SvPV_const(ssv, slen);
3896 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3897 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3898 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3899 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3900 dsv->sv_flags doesn't have that bit set.
3901 Andy Dougherty 12 Oct 2001
3903 const I32 sutf8 = DO_UTF8(ssv);
3906 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3908 dutf8 = DO_UTF8(dsv);
3910 if (dutf8 != sutf8) {
3912 /* Not modifying source SV, so taking a temporary copy. */
3913 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3915 sv_utf8_upgrade(csv);
3916 spv = SvPV_const(csv, slen);
3919 sv_utf8_upgrade_nomg(dsv);
3921 sv_catpvn_nomg(dsv, spv, slen);
3924 if (flags & SV_SMAGIC)
3929 =for apidoc sv_catpv
3931 Concatenates the string onto the end of the string which is in the SV.
3932 If the SV has the UTF-8 status set, then the bytes appended should be
3933 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3938 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3940 register STRLEN len;
3946 junk = SvPV_force(sv, tlen);
3948 SvGROW(sv, tlen + len + 1);
3950 ptr = SvPVX_const(sv);
3951 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3952 SvCUR_set(sv, SvCUR(sv) + len);
3953 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3958 =for apidoc sv_catpv_mg
3960 Like C<sv_catpv>, but also handles 'set' magic.
3966 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3975 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3976 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3983 Perl_newSV(pTHX_ STRLEN len)
3989 sv_upgrade(sv, SVt_PV);
3990 SvGROW(sv, len + 1);
3995 =for apidoc sv_magicext
3997 Adds magic to an SV, upgrading it if necessary. Applies the
3998 supplied vtable and returns a pointer to the magic added.
4000 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4001 In particular, you can add magic to SvREADONLY SVs, and add more than
4002 one instance of the same 'how'.
4004 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4005 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4006 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4007 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4009 (This is now used as a subroutine by C<sv_magic>.)
4014 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4015 const char* name, I32 namlen)
4019 if (SvTYPE(sv) < SVt_PVMG) {
4020 SvUPGRADE(sv, SVt_PVMG);
4022 Newxz(mg, 1, MAGIC);
4023 mg->mg_moremagic = SvMAGIC(sv);
4024 SvMAGIC_set(sv, mg);
4026 /* Sometimes a magic contains a reference loop, where the sv and
4027 object refer to each other. To prevent a reference loop that
4028 would prevent such objects being freed, we look for such loops
4029 and if we find one we avoid incrementing the object refcount.
4031 Note we cannot do this to avoid self-tie loops as intervening RV must
4032 have its REFCNT incremented to keep it in existence.
4035 if (!obj || obj == sv ||
4036 how == PERL_MAGIC_arylen ||
4037 how == PERL_MAGIC_qr ||
4038 how == PERL_MAGIC_symtab ||
4039 (SvTYPE(obj) == SVt_PVGV &&
4040 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4041 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4042 GvFORM(obj) == (CV*)sv)))
4047 mg->mg_obj = SvREFCNT_inc(obj);
4048 mg->mg_flags |= MGf_REFCOUNTED;
4051 /* Normal self-ties simply pass a null object, and instead of
4052 using mg_obj directly, use the SvTIED_obj macro to produce a
4053 new RV as needed. For glob "self-ties", we are tieing the PVIO
4054 with an RV obj pointing to the glob containing the PVIO. In
4055 this case, to avoid a reference loop, we need to weaken the
4059 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4060 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4066 mg->mg_len = namlen;
4069 mg->mg_ptr = savepvn(name, namlen);
4070 else if (namlen == HEf_SVKEY)
4071 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4073 mg->mg_ptr = (char *) name;
4075 mg->mg_virtual = vtable;
4079 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4084 =for apidoc sv_magic
4086 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4087 then adds a new magic item of type C<how> to the head of the magic list.
4089 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4090 handling of the C<name> and C<namlen> arguments.
4092 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4093 to add more than one instance of the same 'how'.
4099 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4101 const MGVTBL *vtable;
4104 #ifdef PERL_OLD_COPY_ON_WRITE
4106 sv_force_normal_flags(sv, 0);
4108 if (SvREADONLY(sv)) {
4110 /* its okay to attach magic to shared strings; the subsequent
4111 * upgrade to PVMG will unshare the string */
4112 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4115 && how != PERL_MAGIC_regex_global
4116 && how != PERL_MAGIC_bm
4117 && how != PERL_MAGIC_fm
4118 && how != PERL_MAGIC_sv
4119 && how != PERL_MAGIC_backref
4122 Perl_croak(aTHX_ PL_no_modify);
4125 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4126 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4127 /* sv_magic() refuses to add a magic of the same 'how' as an
4130 if (how == PERL_MAGIC_taint)
4138 vtable = &PL_vtbl_sv;
4140 case PERL_MAGIC_overload:
4141 vtable = &PL_vtbl_amagic;
4143 case PERL_MAGIC_overload_elem:
4144 vtable = &PL_vtbl_amagicelem;
4146 case PERL_MAGIC_overload_table:
4147 vtable = &PL_vtbl_ovrld;
4150 vtable = &PL_vtbl_bm;
4152 case PERL_MAGIC_regdata:
4153 vtable = &PL_vtbl_regdata;
4155 case PERL_MAGIC_regdatum:
4156 vtable = &PL_vtbl_regdatum;
4158 case PERL_MAGIC_env:
4159 vtable = &PL_vtbl_env;
4162 vtable = &PL_vtbl_fm;
4164 case PERL_MAGIC_envelem:
4165 vtable = &PL_vtbl_envelem;
4167 case PERL_MAGIC_regex_global:
4168 vtable = &PL_vtbl_mglob;
4170 case PERL_MAGIC_isa:
4171 vtable = &PL_vtbl_isa;
4173 case PERL_MAGIC_isaelem:
4174 vtable = &PL_vtbl_isaelem;
4176 case PERL_MAGIC_nkeys:
4177 vtable = &PL_vtbl_nkeys;
4179 case PERL_MAGIC_dbfile:
4182 case PERL_MAGIC_dbline:
4183 vtable = &PL_vtbl_dbline;
4185 #ifdef USE_LOCALE_COLLATE
4186 case PERL_MAGIC_collxfrm:
4187 vtable = &PL_vtbl_collxfrm;
4189 #endif /* USE_LOCALE_COLLATE */
4190 case PERL_MAGIC_tied:
4191 vtable = &PL_vtbl_pack;
4193 case PERL_MAGIC_tiedelem:
4194 case PERL_MAGIC_tiedscalar:
4195 vtable = &PL_vtbl_packelem;
4198 vtable = &PL_vtbl_regexp;
4200 case PERL_MAGIC_sig:
4201 vtable = &PL_vtbl_sig;
4203 case PERL_MAGIC_sigelem:
4204 vtable = &PL_vtbl_sigelem;
4206 case PERL_MAGIC_taint:
4207 vtable = &PL_vtbl_taint;
4209 case PERL_MAGIC_uvar:
4210 vtable = &PL_vtbl_uvar;
4212 case PERL_MAGIC_vec:
4213 vtable = &PL_vtbl_vec;
4215 case PERL_MAGIC_arylen_p:
4216 case PERL_MAGIC_rhash:
4217 case PERL_MAGIC_symtab:
4218 case PERL_MAGIC_vstring:
4221 case PERL_MAGIC_utf8:
4222 vtable = &PL_vtbl_utf8;
4224 case PERL_MAGIC_substr:
4225 vtable = &PL_vtbl_substr;
4227 case PERL_MAGIC_defelem:
4228 vtable = &PL_vtbl_defelem;
4230 case PERL_MAGIC_glob:
4231 vtable = &PL_vtbl_glob;
4233 case PERL_MAGIC_arylen:
4234 vtable = &PL_vtbl_arylen;
4236 case PERL_MAGIC_pos:
4237 vtable = &PL_vtbl_pos;
4239 case PERL_MAGIC_backref:
4240 vtable = &PL_vtbl_backref;
4242 case PERL_MAGIC_ext:
4243 /* Reserved for use by extensions not perl internals. */
4244 /* Useful for attaching extension internal data to perl vars. */
4245 /* Note that multiple extensions may clash if magical scalars */
4246 /* etc holding private data from one are passed to another. */
4250 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4253 /* Rest of work is done else where */
4254 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4257 case PERL_MAGIC_taint:
4260 case PERL_MAGIC_ext:
4261 case PERL_MAGIC_dbfile:
4268 =for apidoc sv_unmagic
4270 Removes all magic of type C<type> from an SV.
4276 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4280 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4283 for (mg = *mgp; mg; mg = *mgp) {
4284 if (mg->mg_type == type) {
4285 const MGVTBL* const vtbl = mg->mg_virtual;
4286 *mgp = mg->mg_moremagic;
4287 if (vtbl && vtbl->svt_free)
4288 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4289 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4291 Safefree(mg->mg_ptr);
4292 else if (mg->mg_len == HEf_SVKEY)
4293 SvREFCNT_dec((SV*)mg->mg_ptr);
4294 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4295 Safefree(mg->mg_ptr);
4297 if (mg->mg_flags & MGf_REFCOUNTED)
4298 SvREFCNT_dec(mg->mg_obj);
4302 mgp = &mg->mg_moremagic;
4306 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4313 =for apidoc sv_rvweaken
4315 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4316 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4317 push a back-reference to this RV onto the array of backreferences
4318 associated with that magic.
4324 Perl_sv_rvweaken(pTHX_ SV *sv)
4327 if (!SvOK(sv)) /* let undefs pass */
4330 Perl_croak(aTHX_ "Can't weaken a nonreference");
4331 else if (SvWEAKREF(sv)) {
4332 if (ckWARN(WARN_MISC))
4333 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4337 Perl_sv_add_backref(aTHX_ tsv, sv);
4343 /* Give tsv backref magic if it hasn't already got it, then push a
4344 * back-reference to sv onto the array associated with the backref magic.
4348 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4352 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4353 av = (AV*)mg->mg_obj;
4356 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4357 /* av now has a refcnt of 2, which avoids it getting freed
4358 * before us during global cleanup. The extra ref is removed
4359 * by magic_killbackrefs() when tsv is being freed */
4361 if (AvFILLp(av) >= AvMAX(av)) {
4362 av_extend(av, AvFILLp(av)+1);
4364 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4367 /* delete a back-reference to ourselves from the backref magic associated
4368 * with the SV we point to.
4372 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4378 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4379 if (PL_in_clean_all)
4382 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4383 Perl_croak(aTHX_ "panic: del_backref");
4384 av = (AV *)mg->mg_obj;
4386 /* We shouldn't be in here more than once, but for paranoia reasons lets
4388 for (i = AvFILLp(av); i >= 0; i--) {
4390 const SSize_t fill = AvFILLp(av);
4392 /* We weren't the last entry.
4393 An unordered list has this property that you can take the
4394 last element off the end to fill the hole, and it's still
4395 an unordered list :-)
4400 AvFILLp(av) = fill - 1;
4406 =for apidoc sv_insert
4408 Inserts a string at the specified offset/length within the SV. Similar to
4409 the Perl substr() function.
4415 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4419 register char *midend;
4420 register char *bigend;
4426 Perl_croak(aTHX_ "Can't modify non-existent substring");
4427 SvPV_force(bigstr, curlen);
4428 (void)SvPOK_only_UTF8(bigstr);
4429 if (offset + len > curlen) {
4430 SvGROW(bigstr, offset+len+1);
4431 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4432 SvCUR_set(bigstr, offset+len);
4436 i = littlelen - len;
4437 if (i > 0) { /* string might grow */
4438 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4439 mid = big + offset + len;
4440 midend = bigend = big + SvCUR(bigstr);
4443 while (midend > mid) /* shove everything down */
4444 *--bigend = *--midend;
4445 Move(little,big+offset,littlelen,char);
4446 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4451 Move(little,SvPVX(bigstr)+offset,len,char);
4456 big = SvPVX(bigstr);
4459 bigend = big + SvCUR(bigstr);
4461 if (midend > bigend)
4462 Perl_croak(aTHX_ "panic: sv_insert");
4464 if (mid - big > bigend - midend) { /* faster to shorten from end */
4466 Move(little, mid, littlelen,char);
4469 i = bigend - midend;
4471 Move(midend, mid, i,char);
4475 SvCUR_set(bigstr, mid - big);
4477 else if ((i = mid - big)) { /* faster from front */
4478 midend -= littlelen;
4480 sv_chop(bigstr,midend-i);
4485 Move(little, mid, littlelen,char);
4487 else if (littlelen) {
4488 midend -= littlelen;
4489 sv_chop(bigstr,midend);
4490 Move(little,midend,littlelen,char);
4493 sv_chop(bigstr,midend);
4499 =for apidoc sv_replace
4501 Make the first argument a copy of the second, then delete the original.
4502 The target SV physically takes over ownership of the body of the source SV
4503 and inherits its flags; however, the target keeps any magic it owns,
4504 and any magic in the source is discarded.
4505 Note that this is a rather specialist SV copying operation; most of the
4506 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4512 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4514 const U32 refcnt = SvREFCNT(sv);
4515 SV_CHECK_THINKFIRST_COW_DROP(sv);
4516 if (SvREFCNT(nsv) != 1) {
4517 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4518 UVuf " != 1)", (UV) SvREFCNT(nsv));
4520 if (SvMAGICAL(sv)) {
4524 sv_upgrade(nsv, SVt_PVMG);
4525 SvMAGIC_set(nsv, SvMAGIC(sv));
4526 SvFLAGS(nsv) |= SvMAGICAL(sv);
4528 SvMAGIC_set(sv, NULL);
4532 assert(!SvREFCNT(sv));
4533 #ifdef DEBUG_LEAKING_SCALARS
4534 sv->sv_flags = nsv->sv_flags;
4535 sv->sv_any = nsv->sv_any;
4536 sv->sv_refcnt = nsv->sv_refcnt;
4537 sv->sv_u = nsv->sv_u;
4539 StructCopy(nsv,sv,SV);
4541 /* Currently could join these into one piece of pointer arithmetic, but
4542 it would be unclear. */
4543 if(SvTYPE(sv) == SVt_IV)
4545 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4546 else if (SvTYPE(sv) == SVt_RV) {
4547 SvANY(sv) = &sv->sv_u.svu_rv;
4551 #ifdef PERL_OLD_COPY_ON_WRITE
4552 if (SvIsCOW_normal(nsv)) {
4553 /* We need to follow the pointers around the loop to make the
4554 previous SV point to sv, rather than nsv. */
4557 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4560 assert(SvPVX_const(current) == SvPVX_const(nsv));
4562 /* Make the SV before us point to the SV after us. */
4564 PerlIO_printf(Perl_debug_log, "previous is\n");
4566 PerlIO_printf(Perl_debug_log,
4567 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4568 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4570 SV_COW_NEXT_SV_SET(current, sv);
4573 SvREFCNT(sv) = refcnt;
4574 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4580 =for apidoc sv_clear
4582 Clear an SV: call any destructors, free up any memory used by the body,
4583 and free the body itself. The SV's head is I<not> freed, although
4584 its type is set to all 1's so that it won't inadvertently be assumed
4585 to be live during global destruction etc.
4586 This function should only be called when REFCNT is zero. Most of the time
4587 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4594 Perl_sv_clear(pTHX_ register SV *sv)
4597 const U32 type = SvTYPE(sv);
4598 const struct body_details *const sv_type_details
4599 = bodies_by_type + type;
4602 assert(SvREFCNT(sv) == 0);
4608 if (PL_defstash) { /* Still have a symbol table? */
4613 stash = SvSTASH(sv);
4614 destructor = StashHANDLER(stash,DESTROY);
4616 SV* const tmpref = newRV(sv);
4617 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4619 PUSHSTACKi(PERLSI_DESTROY);
4624 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4630 if(SvREFCNT(tmpref) < 2) {
4631 /* tmpref is not kept alive! */
4633 SvRV_set(tmpref, NULL);
4636 SvREFCNT_dec(tmpref);
4638 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4642 if (PL_in_clean_objs)
4643 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4645 /* DESTROY gave object new lease on life */
4651 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4652 SvOBJECT_off(sv); /* Curse the object. */
4653 if (type != SVt_PVIO)
4654 --PL_sv_objcount; /* XXX Might want something more general */
4657 if (type >= SVt_PVMG) {
4660 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4661 SvREFCNT_dec(SvSTASH(sv));
4666 IoIFP(sv) != PerlIO_stdin() &&
4667 IoIFP(sv) != PerlIO_stdout() &&
4668 IoIFP(sv) != PerlIO_stderr())
4670 io_close((IO*)sv, FALSE);
4672 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4673 PerlDir_close(IoDIRP(sv));
4674 IoDIRP(sv) = (DIR*)NULL;
4675 Safefree(IoTOP_NAME(sv));
4676 Safefree(IoFMT_NAME(sv));
4677 Safefree(IoBOTTOM_NAME(sv));
4692 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4693 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4694 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4695 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4697 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4698 SvREFCNT_dec(LvTARG(sv));
4702 Safefree(GvNAME(sv));
4703 /* If we're in a stash, we don't own a reference to it. However it does
4704 have a back reference to us, which needs to be cleared. */
4706 sv_del_backref((SV*)GvSTASH(sv), sv);
4711 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4713 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4714 /* Don't even bother with turning off the OOK flag. */
4719 SV *target = SvRV(sv);
4721 sv_del_backref(target, sv);
4723 SvREFCNT_dec(target);
4725 #ifdef PERL_OLD_COPY_ON_WRITE
4726 else if (SvPVX_const(sv)) {
4728 /* I believe I need to grab the global SV mutex here and
4729 then recheck the COW status. */
4731 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4734 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4735 SV_COW_NEXT_SV(sv));
4736 /* And drop it here. */
4738 } else if (SvLEN(sv)) {
4739 Safefree(SvPVX_const(sv));
4743 else if (SvPVX_const(sv) && SvLEN(sv))
4744 Safefree(SvPVX_mutable(sv));
4745 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4746 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4755 SvFLAGS(sv) &= SVf_BREAK;
4756 SvFLAGS(sv) |= SVTYPEMASK;
4758 if (sv_type_details->arena) {
4759 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4760 &PL_body_roots[type]);
4762 else if (sv_type_details->size) {
4763 my_safefree(SvANY(sv));
4768 =for apidoc sv_newref
4770 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4777 Perl_sv_newref(pTHX_ SV *sv)
4787 Decrement an SV's reference count, and if it drops to zero, call
4788 C<sv_clear> to invoke destructors and free up any memory used by
4789 the body; finally, deallocate the SV's head itself.
4790 Normally called via a wrapper macro C<SvREFCNT_dec>.
4796 Perl_sv_free(pTHX_ SV *sv)
4801 if (SvREFCNT(sv) == 0) {
4802 if (SvFLAGS(sv) & SVf_BREAK)
4803 /* this SV's refcnt has been artificially decremented to
4804 * trigger cleanup */
4806 if (PL_in_clean_all) /* All is fair */
4808 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4809 /* make sure SvREFCNT(sv)==0 happens very seldom */
4810 SvREFCNT(sv) = (~(U32)0)/2;
4813 if (ckWARN_d(WARN_INTERNAL)) {
4814 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4815 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4816 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4817 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4818 Perl_dump_sv_child(aTHX_ sv);
4823 if (--(SvREFCNT(sv)) > 0)
4825 Perl_sv_free2(aTHX_ sv);
4829 Perl_sv_free2(pTHX_ SV *sv)
4834 if (ckWARN_d(WARN_DEBUGGING))
4835 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4836 "Attempt to free temp prematurely: SV 0x%"UVxf
4837 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4841 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4842 /* make sure SvREFCNT(sv)==0 happens very seldom */
4843 SvREFCNT(sv) = (~(U32)0)/2;
4854 Returns the length of the string in the SV. Handles magic and type
4855 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4861 Perl_sv_len(pTHX_ register SV *sv)
4869 len = mg_length(sv);
4871 (void)SvPV_const(sv, len);
4876 =for apidoc sv_len_utf8
4878 Returns the number of characters in the string in an SV, counting wide
4879 UTF-8 bytes as a single character. Handles magic and type coercion.
4885 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4886 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4887 * (Note that the mg_len is not the length of the mg_ptr field.)
4892 Perl_sv_len_utf8(pTHX_ register SV *sv)
4898 return mg_length(sv);
4902 const U8 *s = (U8*)SvPV_const(sv, len);
4903 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4905 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4907 #ifdef PERL_UTF8_CACHE_ASSERT
4908 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4912 ulen = Perl_utf8_length(aTHX_ s, s + len);
4913 if (!mg && !SvREADONLY(sv)) {
4914 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4915 mg = mg_find(sv, PERL_MAGIC_utf8);
4925 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4926 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4927 * between UTF-8 and byte offsets. There are two (substr offset and substr
4928 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4929 * and byte offset) cache positions.
4931 * The mg_len field is used by sv_len_utf8(), see its comments.
4932 * Note that the mg_len is not the length of the mg_ptr field.
4936 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4937 I32 offsetp, const U8 *s, const U8 *start)
4941 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4943 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4947 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4949 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4950 (*mgp)->mg_ptr = (char *) *cachep;
4954 (*cachep)[i] = offsetp;
4955 (*cachep)[i+1] = s - start;
4963 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4964 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4965 * between UTF-8 and byte offsets. See also the comments of
4966 * S_utf8_mg_pos_init().
4970 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)
4974 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4976 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4977 if (*mgp && (*mgp)->mg_ptr) {
4978 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4979 ASSERT_UTF8_CACHE(*cachep);
4980 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4982 else { /* We will skip to the right spot. */
4987 /* The assumption is that going backward is half
4988 * the speed of going forward (that's where the
4989 * 2 * backw in the below comes from). (The real
4990 * figure of course depends on the UTF-8 data.) */
4992 if ((*cachep)[i] > (STRLEN)uoff) {
4994 backw = (*cachep)[i] - (STRLEN)uoff;
4996 if (forw < 2 * backw)
4999 p = start + (*cachep)[i+1];
5001 /* Try this only for the substr offset (i == 0),
5002 * not for the substr length (i == 2). */
5003 else if (i == 0) { /* (*cachep)[i] < uoff */
5004 const STRLEN ulen = sv_len_utf8(sv);
5006 if ((STRLEN)uoff < ulen) {
5007 forw = (STRLEN)uoff - (*cachep)[i];
5008 backw = ulen - (STRLEN)uoff;
5010 if (forw < 2 * backw)
5011 p = start + (*cachep)[i+1];
5016 /* If the string is not long enough for uoff,
5017 * we could extend it, but not at this low a level. */
5021 if (forw < 2 * backw) {
5028 while (UTF8_IS_CONTINUATION(*p))
5033 /* Update the cache. */
5034 (*cachep)[i] = (STRLEN)uoff;
5035 (*cachep)[i+1] = p - start;
5037 /* Drop the stale "length" cache */
5046 if (found) { /* Setup the return values. */
5047 *offsetp = (*cachep)[i+1];
5048 *sp = start + *offsetp;
5051 *offsetp = send - start;
5053 else if (*sp < start) {
5059 #ifdef PERL_UTF8_CACHE_ASSERT
5064 while (n-- && s < send)
5068 assert(*offsetp == s - start);
5069 assert((*cachep)[0] == (STRLEN)uoff);
5070 assert((*cachep)[1] == *offsetp);
5072 ASSERT_UTF8_CACHE(*cachep);
5081 =for apidoc sv_pos_u2b
5083 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5084 the start of the string, to a count of the equivalent number of bytes; if
5085 lenp is non-zero, it does the same to lenp, but this time starting from
5086 the offset, rather than from the start of the string. Handles magic and
5093 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5094 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5095 * byte offsets. See also the comments of S_utf8_mg_pos().
5100 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5108 start = (U8*)SvPV_const(sv, len);
5112 const U8 *s = start;
5113 I32 uoffset = *offsetp;
5114 const U8 * const send = s + len;
5118 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5120 if (!found && uoffset > 0) {
5121 while (s < send && uoffset--)
5125 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5127 *offsetp = s - start;
5132 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5136 if (!found && *lenp > 0) {
5139 while (s < send && ulen--)
5143 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5147 ASSERT_UTF8_CACHE(cache);
5159 =for apidoc sv_pos_b2u
5161 Converts the value pointed to by offsetp from a count of bytes from the
5162 start of the string, to a count of the equivalent number of UTF-8 chars.
5163 Handles magic and type coercion.
5169 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5170 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5171 * byte offsets. See also the comments of S_utf8_mg_pos().
5176 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5184 s = (const U8*)SvPV_const(sv, len);
5185 if ((I32)len < *offsetp)
5186 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5188 const U8* send = s + *offsetp;
5190 STRLEN *cache = NULL;
5194 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5195 mg = mg_find(sv, PERL_MAGIC_utf8);
5196 if (mg && mg->mg_ptr) {
5197 cache = (STRLEN *) mg->mg_ptr;
5198 if (cache[1] == (STRLEN)*offsetp) {
5199 /* An exact match. */
5200 *offsetp = cache[0];
5204 else if (cache[1] < (STRLEN)*offsetp) {
5205 /* We already know part of the way. */
5208 /* Let the below loop do the rest. */
5210 else { /* cache[1] > *offsetp */
5211 /* We already know all of the way, now we may
5212 * be able to walk back. The same assumption
5213 * is made as in S_utf8_mg_pos(), namely that
5214 * walking backward is twice slower than
5215 * walking forward. */
5216 const STRLEN forw = *offsetp;
5217 STRLEN backw = cache[1] - *offsetp;
5219 if (!(forw < 2 * backw)) {
5220 const U8 *p = s + cache[1];
5227 while (UTF8_IS_CONTINUATION(*p)) {
5235 *offsetp = cache[0];
5237 /* Drop the stale "length" cache */
5245 ASSERT_UTF8_CACHE(cache);
5251 /* Call utf8n_to_uvchr() to validate the sequence
5252 * (unless a simple non-UTF character) */
5253 if (!UTF8_IS_INVARIANT(*s))
5254 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5263 if (!SvREADONLY(sv)) {
5265 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5266 mg = mg_find(sv, PERL_MAGIC_utf8);
5271 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5272 mg->mg_ptr = (char *) cache;
5277 cache[1] = *offsetp;
5278 /* Drop the stale "length" cache */
5291 Returns a boolean indicating whether the strings in the two SVs are
5292 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5293 coerce its args to strings if necessary.
5299 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5307 SV* svrecode = Nullsv;
5314 pv1 = SvPV_const(sv1, cur1);
5321 pv2 = SvPV_const(sv2, cur2);
5323 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5324 /* Differing utf8ness.
5325 * Do not UTF8size the comparands as a side-effect. */
5328 svrecode = newSVpvn(pv2, cur2);
5329 sv_recode_to_utf8(svrecode, PL_encoding);
5330 pv2 = SvPV_const(svrecode, cur2);
5333 svrecode = newSVpvn(pv1, cur1);
5334 sv_recode_to_utf8(svrecode, PL_encoding);
5335 pv1 = SvPV_const(svrecode, cur1);
5337 /* Now both are in UTF-8. */
5339 SvREFCNT_dec(svrecode);
5344 bool is_utf8 = TRUE;
5347 /* sv1 is the UTF-8 one,
5348 * if is equal it must be downgrade-able */
5349 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5355 /* sv2 is the UTF-8 one,
5356 * if is equal it must be downgrade-able */
5357 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5363 /* Downgrade not possible - cannot be eq */
5371 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5374 SvREFCNT_dec(svrecode);
5385 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5386 string in C<sv1> is less than, equal to, or greater than the string in
5387 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5388 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5394 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5397 const char *pv1, *pv2;
5400 SV *svrecode = Nullsv;
5407 pv1 = SvPV_const(sv1, cur1);
5414 pv2 = SvPV_const(sv2, cur2);
5416 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5417 /* Differing utf8ness.
5418 * Do not UTF8size the comparands as a side-effect. */
5421 svrecode = newSVpvn(pv2, cur2);
5422 sv_recode_to_utf8(svrecode, PL_encoding);
5423 pv2 = SvPV_const(svrecode, cur2);
5426 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5431 svrecode = newSVpvn(pv1, cur1);
5432 sv_recode_to_utf8(svrecode, PL_encoding);
5433 pv1 = SvPV_const(svrecode, cur1);
5436 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5442 cmp = cur2 ? -1 : 0;
5446 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5449 cmp = retval < 0 ? -1 : 1;
5450 } else if (cur1 == cur2) {
5453 cmp = cur1 < cur2 ? -1 : 1;
5458 SvREFCNT_dec(svrecode);
5467 =for apidoc sv_cmp_locale
5469 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5470 'use bytes' aware, handles get magic, and will coerce its args to strings
5471 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5477 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5479 #ifdef USE_LOCALE_COLLATE
5485 if (PL_collation_standard)
5489 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5491 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5493 if (!pv1 || !len1) {
5504 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5507 return retval < 0 ? -1 : 1;
5510 * When the result of collation is equality, that doesn't mean
5511 * that there are no differences -- some locales exclude some
5512 * characters from consideration. So to avoid false equalities,
5513 * we use the raw string as a tiebreaker.
5519 #endif /* USE_LOCALE_COLLATE */
5521 return sv_cmp(sv1, sv2);
5525 #ifdef USE_LOCALE_COLLATE
5528 =for apidoc sv_collxfrm
5530 Add Collate Transform magic to an SV if it doesn't already have it.
5532 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5533 scalar data of the variable, but transformed to such a format that a normal
5534 memory comparison can be used to compare the data according to the locale
5541 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5545 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5546 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5552 Safefree(mg->mg_ptr);
5553 s = SvPV_const(sv, len);
5554 if ((xf = mem_collxfrm(s, len, &xlen))) {
5555 if (SvREADONLY(sv)) {
5558 return xf + sizeof(PL_collation_ix);
5561 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5562 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5575 if (mg && mg->mg_ptr) {
5577 return mg->mg_ptr + sizeof(PL_collation_ix);
5585 #endif /* USE_LOCALE_COLLATE */
5590 Get a line from the filehandle and store it into the SV, optionally
5591 appending to the currently-stored string.
5597 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5601 register STDCHAR rslast;
5602 register STDCHAR *bp;
5608 if (SvTHINKFIRST(sv))
5609 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5610 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5612 However, perlbench says it's slower, because the existing swipe code
5613 is faster than copy on write.
5614 Swings and roundabouts. */
5615 SvUPGRADE(sv, SVt_PV);
5620 if (PerlIO_isutf8(fp)) {
5622 sv_utf8_upgrade_nomg(sv);
5623 sv_pos_u2b(sv,&append,0);
5625 } else if (SvUTF8(sv)) {
5626 SV * const tsv = NEWSV(0,0);
5627 sv_gets(tsv, fp, 0);
5628 sv_utf8_upgrade_nomg(tsv);
5629 SvCUR_set(sv,append);
5632 goto return_string_or_null;
5637 if (PerlIO_isutf8(fp))
5640 if (IN_PERL_COMPILETIME) {
5641 /* we always read code in line mode */
5645 else if (RsSNARF(PL_rs)) {
5646 /* If it is a regular disk file use size from stat() as estimate
5647 of amount we are going to read - may result in malloc-ing
5648 more memory than we realy need if layers bellow reduce
5649 size we read (e.g. CRLF or a gzip layer)
5652 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5653 const Off_t offset = PerlIO_tell(fp);
5654 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5655 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5661 else if (RsRECORD(PL_rs)) {
5665 /* Grab the size of the record we're getting */
5666 recsize = SvIV(SvRV(PL_rs));
5667 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5670 /* VMS wants read instead of fread, because fread doesn't respect */
5671 /* RMS record boundaries. This is not necessarily a good thing to be */
5672 /* doing, but we've got no other real choice - except avoid stdio
5673 as implementation - perhaps write a :vms layer ?
5675 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5677 bytesread = PerlIO_read(fp, buffer, recsize);
5681 SvCUR_set(sv, bytesread += append);
5682 buffer[bytesread] = '\0';
5683 goto return_string_or_null;
5685 else if (RsPARA(PL_rs)) {
5691 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5692 if (PerlIO_isutf8(fp)) {
5693 rsptr = SvPVutf8(PL_rs, rslen);
5696 if (SvUTF8(PL_rs)) {
5697 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5698 Perl_croak(aTHX_ "Wide character in $/");
5701 rsptr = SvPV_const(PL_rs, rslen);
5705 rslast = rslen ? rsptr[rslen - 1] : '\0';
5707 if (rspara) { /* have to do this both before and after */
5708 do { /* to make sure file boundaries work right */
5711 i = PerlIO_getc(fp);
5715 PerlIO_ungetc(fp,i);
5721 /* See if we know enough about I/O mechanism to cheat it ! */
5723 /* This used to be #ifdef test - it is made run-time test for ease
5724 of abstracting out stdio interface. One call should be cheap
5725 enough here - and may even be a macro allowing compile
5729 if (PerlIO_fast_gets(fp)) {
5732 * We're going to steal some values from the stdio struct
5733 * and put EVERYTHING in the innermost loop into registers.
5735 register STDCHAR *ptr;
5739 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5740 /* An ungetc()d char is handled separately from the regular
5741 * buffer, so we getc() it back out and stuff it in the buffer.
5743 i = PerlIO_getc(fp);
5744 if (i == EOF) return 0;
5745 *(--((*fp)->_ptr)) = (unsigned char) i;
5749 /* Here is some breathtakingly efficient cheating */
5751 cnt = PerlIO_get_cnt(fp); /* get count into register */
5752 /* make sure we have the room */
5753 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5754 /* Not room for all of it
5755 if we are looking for a separator and room for some
5757 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5758 /* just process what we have room for */
5759 shortbuffered = cnt - SvLEN(sv) + append + 1;
5760 cnt -= shortbuffered;
5764 /* remember that cnt can be negative */
5765 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5770 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5771 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5772 DEBUG_P(PerlIO_printf(Perl_debug_log,
5773 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5774 DEBUG_P(PerlIO_printf(Perl_debug_log,
5775 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5776 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5777 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5782 while (cnt > 0) { /* this | eat */
5784 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5785 goto thats_all_folks; /* screams | sed :-) */
5789 Copy(ptr, bp, cnt, char); /* this | eat */
5790 bp += cnt; /* screams | dust */
5791 ptr += cnt; /* louder | sed :-) */
5796 if (shortbuffered) { /* oh well, must extend */
5797 cnt = shortbuffered;
5799 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5801 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5802 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5806 DEBUG_P(PerlIO_printf(Perl_debug_log,
5807 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5808 PTR2UV(ptr),(long)cnt));
5809 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5811 DEBUG_P(PerlIO_printf(Perl_debug_log,
5812 "Screamer: pre: 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 /* This used to call 'filbuf' in stdio form, but as that behaves like
5817 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5818 another abstraction. */
5819 i = PerlIO_getc(fp); /* get more characters */
5821 DEBUG_P(PerlIO_printf(Perl_debug_log,
5822 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5823 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5824 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5826 cnt = PerlIO_get_cnt(fp);
5827 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5828 DEBUG_P(PerlIO_printf(Perl_debug_log,
5829 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5831 if (i == EOF) /* all done for ever? */
5832 goto thats_really_all_folks;
5834 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5836 SvGROW(sv, bpx + cnt + 2);
5837 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5839 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5841 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5842 goto thats_all_folks;
5846 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5847 memNE((char*)bp - rslen, rsptr, rslen))
5848 goto screamer; /* go back to the fray */
5849 thats_really_all_folks:
5851 cnt += shortbuffered;
5852 DEBUG_P(PerlIO_printf(Perl_debug_log,
5853 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5854 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5855 DEBUG_P(PerlIO_printf(Perl_debug_log,
5856 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5857 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5858 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5860 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5861 DEBUG_P(PerlIO_printf(Perl_debug_log,
5862 "Screamer: done, len=%ld, string=|%.*s|\n",
5863 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5867 /*The big, slow, and stupid way. */
5868 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5870 Newx(buf, 8192, STDCHAR);
5878 register const STDCHAR * const bpe = buf + sizeof(buf);
5880 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5881 ; /* keep reading */
5885 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5886 /* Accomodate broken VAXC compiler, which applies U8 cast to
5887 * both args of ?: operator, causing EOF to change into 255
5890 i = (U8)buf[cnt - 1];
5896 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5898 sv_catpvn(sv, (char *) buf, cnt);
5900 sv_setpvn(sv, (char *) buf, cnt);
5902 if (i != EOF && /* joy */
5904 SvCUR(sv) < rslen ||
5905 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5909 * If we're reading from a TTY and we get a short read,
5910 * indicating that the user hit his EOF character, we need
5911 * to notice it now, because if we try to read from the TTY
5912 * again, the EOF condition will disappear.
5914 * The comparison of cnt to sizeof(buf) is an optimization
5915 * that prevents unnecessary calls to feof().
5919 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5923 #ifdef USE_HEAP_INSTEAD_OF_STACK
5928 if (rspara) { /* have to do this both before and after */
5929 while (i != EOF) { /* to make sure file boundaries work right */
5930 i = PerlIO_getc(fp);
5932 PerlIO_ungetc(fp,i);
5938 return_string_or_null:
5939 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5945 Auto-increment of the value in the SV, doing string to numeric conversion
5946 if necessary. Handles 'get' magic.
5952 Perl_sv_inc(pTHX_ register SV *sv)
5960 if (SvTHINKFIRST(sv)) {
5962 sv_force_normal_flags(sv, 0);
5963 if (SvREADONLY(sv)) {
5964 if (IN_PERL_RUNTIME)
5965 Perl_croak(aTHX_ PL_no_modify);
5969 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5971 i = PTR2IV(SvRV(sv));
5976 flags = SvFLAGS(sv);
5977 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5978 /* It's (privately or publicly) a float, but not tested as an
5979 integer, so test it to see. */
5981 flags = SvFLAGS(sv);
5983 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5984 /* It's publicly an integer, or privately an integer-not-float */
5985 #ifdef PERL_PRESERVE_IVUV
5989 if (SvUVX(sv) == UV_MAX)
5990 sv_setnv(sv, UV_MAX_P1);
5992 (void)SvIOK_only_UV(sv);
5993 SvUV_set(sv, SvUVX(sv) + 1);
5995 if (SvIVX(sv) == IV_MAX)
5996 sv_setuv(sv, (UV)IV_MAX + 1);
5998 (void)SvIOK_only(sv);
5999 SvIV_set(sv, SvIVX(sv) + 1);
6004 if (flags & SVp_NOK) {
6005 (void)SvNOK_only(sv);
6006 SvNV_set(sv, SvNVX(sv) + 1.0);
6010 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6011 if ((flags & SVTYPEMASK) < SVt_PVIV)
6012 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6013 (void)SvIOK_only(sv);
6018 while (isALPHA(*d)) d++;
6019 while (isDIGIT(*d)) d++;
6021 #ifdef PERL_PRESERVE_IVUV
6022 /* Got to punt this as an integer if needs be, but we don't issue
6023 warnings. Probably ought to make the sv_iv_please() that does
6024 the conversion if possible, and silently. */
6025 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6026 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6027 /* Need to try really hard to see if it's an integer.
6028 9.22337203685478e+18 is an integer.
6029 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6030 so $a="9.22337203685478e+18"; $a+0; $a++
6031 needs to be the same as $a="9.22337203685478e+18"; $a++
6038 /* sv_2iv *should* have made this an NV */
6039 if (flags & SVp_NOK) {
6040 (void)SvNOK_only(sv);
6041 SvNV_set(sv, SvNVX(sv) + 1.0);
6044 /* I don't think we can get here. Maybe I should assert this
6045 And if we do get here I suspect that sv_setnv will croak. NWC
6047 #if defined(USE_LONG_DOUBLE)
6048 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",
6049 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6051 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6052 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6055 #endif /* PERL_PRESERVE_IVUV */
6056 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6060 while (d >= SvPVX_const(sv)) {
6068 /* MKS: The original code here died if letters weren't consecutive.
6069 * at least it didn't have to worry about non-C locales. The
6070 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6071 * arranged in order (although not consecutively) and that only
6072 * [A-Za-z] are accepted by isALPHA in the C locale.
6074 if (*d != 'z' && *d != 'Z') {
6075 do { ++*d; } while (!isALPHA(*d));
6078 *(d--) -= 'z' - 'a';
6083 *(d--) -= 'z' - 'a' + 1;
6087 /* oh,oh, the number grew */
6088 SvGROW(sv, SvCUR(sv) + 2);
6089 SvCUR_set(sv, SvCUR(sv) + 1);
6090 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6101 Auto-decrement of the value in the SV, doing string to numeric conversion
6102 if necessary. Handles 'get' magic.
6108 Perl_sv_dec(pTHX_ register SV *sv)
6115 if (SvTHINKFIRST(sv)) {
6117 sv_force_normal_flags(sv, 0);
6118 if (SvREADONLY(sv)) {
6119 if (IN_PERL_RUNTIME)
6120 Perl_croak(aTHX_ PL_no_modify);
6124 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6126 i = PTR2IV(SvRV(sv));
6131 /* Unlike sv_inc we don't have to worry about string-never-numbers
6132 and keeping them magic. But we mustn't warn on punting */
6133 flags = SvFLAGS(sv);
6134 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6135 /* It's publicly an integer, or privately an integer-not-float */
6136 #ifdef PERL_PRESERVE_IVUV
6140 if (SvUVX(sv) == 0) {
6141 (void)SvIOK_only(sv);
6145 (void)SvIOK_only_UV(sv);
6146 SvUV_set(sv, SvUVX(sv) - 1);
6149 if (SvIVX(sv) == IV_MIN)
6150 sv_setnv(sv, (NV)IV_MIN - 1.0);
6152 (void)SvIOK_only(sv);
6153 SvIV_set(sv, SvIVX(sv) - 1);
6158 if (flags & SVp_NOK) {
6159 SvNV_set(sv, SvNVX(sv) - 1.0);
6160 (void)SvNOK_only(sv);
6163 if (!(flags & SVp_POK)) {
6164 if ((flags & SVTYPEMASK) < SVt_PVIV)
6165 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6167 (void)SvIOK_only(sv);
6170 #ifdef PERL_PRESERVE_IVUV
6172 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6173 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6174 /* Need to try really hard to see if it's an integer.
6175 9.22337203685478e+18 is an integer.
6176 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6177 so $a="9.22337203685478e+18"; $a+0; $a--
6178 needs to be the same as $a="9.22337203685478e+18"; $a--
6185 /* sv_2iv *should* have made this an NV */
6186 if (flags & SVp_NOK) {
6187 (void)SvNOK_only(sv);
6188 SvNV_set(sv, SvNVX(sv) - 1.0);
6191 /* I don't think we can get here. Maybe I should assert this
6192 And if we do get here I suspect that sv_setnv will croak. NWC
6194 #if defined(USE_LONG_DOUBLE)
6195 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",
6196 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6198 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6199 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6203 #endif /* PERL_PRESERVE_IVUV */
6204 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6208 =for apidoc sv_mortalcopy
6210 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6211 The new SV is marked as mortal. It will be destroyed "soon", either by an
6212 explicit call to FREETMPS, or by an implicit call at places such as
6213 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6218 /* Make a string that will exist for the duration of the expression
6219 * evaluation. Actually, it may have to last longer than that, but
6220 * hopefully we won't free it until it has been assigned to a
6221 * permanent location. */
6224 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6229 sv_setsv(sv,oldstr);
6231 PL_tmps_stack[++PL_tmps_ix] = sv;
6237 =for apidoc sv_newmortal
6239 Creates a new null SV which is mortal. The reference count of the SV is
6240 set to 1. It will be destroyed "soon", either by an explicit call to
6241 FREETMPS, or by an implicit call at places such as statement boundaries.
6242 See also C<sv_mortalcopy> and C<sv_2mortal>.
6248 Perl_sv_newmortal(pTHX)
6253 SvFLAGS(sv) = SVs_TEMP;
6255 PL_tmps_stack[++PL_tmps_ix] = sv;
6260 =for apidoc sv_2mortal
6262 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6263 by an explicit call to FREETMPS, or by an implicit call at places such as
6264 statement boundaries. SvTEMP() is turned on which means that the SV's
6265 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6266 and C<sv_mortalcopy>.
6272 Perl_sv_2mortal(pTHX_ register SV *sv)
6277 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6280 PL_tmps_stack[++PL_tmps_ix] = sv;
6288 Creates a new SV and copies a string into it. The reference count for the
6289 SV is set to 1. If C<len> is zero, Perl will compute the length using
6290 strlen(). For efficiency, consider using C<newSVpvn> instead.
6296 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6301 sv_setpvn(sv,s,len ? len : strlen(s));
6306 =for apidoc newSVpvn
6308 Creates a new SV and copies a string into it. The reference count for the
6309 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6310 string. You are responsible for ensuring that the source string is at least
6311 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6317 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6322 sv_setpvn(sv,s,len);
6328 =for apidoc newSVhek
6330 Creates a new SV from the hash key structure. It will generate scalars that
6331 point to the shared string table where possible. Returns a new (undefined)
6332 SV if the hek is NULL.
6338 Perl_newSVhek(pTHX_ const HEK *hek)
6347 if (HEK_LEN(hek) == HEf_SVKEY) {
6348 return newSVsv(*(SV**)HEK_KEY(hek));
6350 const int flags = HEK_FLAGS(hek);
6351 if (flags & HVhek_WASUTF8) {
6353 Andreas would like keys he put in as utf8 to come back as utf8
6355 STRLEN utf8_len = HEK_LEN(hek);
6356 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6357 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6360 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6362 } else if (flags & HVhek_REHASH) {
6363 /* We don't have a pointer to the hv, so we have to replicate the
6364 flag into every HEK. This hv is using custom a hasing
6365 algorithm. Hence we can't return a shared string scalar, as
6366 that would contain the (wrong) hash value, and might get passed
6367 into an hv routine with a regular hash */
6369 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6374 /* This will be overwhelminly the most common case. */
6375 return newSVpvn_share(HEK_KEY(hek),
6376 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6382 =for apidoc newSVpvn_share
6384 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6385 table. If the string does not already exist in the table, it is created
6386 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6387 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6388 otherwise the hash is computed. The idea here is that as the string table
6389 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6390 hash lookup will avoid string compare.
6396 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6399 bool is_utf8 = FALSE;
6401 STRLEN tmplen = -len;
6403 /* See the note in hv.c:hv_fetch() --jhi */
6404 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6408 PERL_HASH(hash, src, len);
6410 sv_upgrade(sv, SVt_PV);
6411 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6423 #if defined(PERL_IMPLICIT_CONTEXT)
6425 /* pTHX_ magic can't cope with varargs, so this is a no-context
6426 * version of the main function, (which may itself be aliased to us).
6427 * Don't access this version directly.
6431 Perl_newSVpvf_nocontext(const char* pat, ...)
6436 va_start(args, pat);
6437 sv = vnewSVpvf(pat, &args);
6444 =for apidoc newSVpvf
6446 Creates a new SV and initializes it with the string formatted like
6453 Perl_newSVpvf(pTHX_ const char* pat, ...)
6457 va_start(args, pat);
6458 sv = vnewSVpvf(pat, &args);
6463 /* backend for newSVpvf() and newSVpvf_nocontext() */
6466 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6470 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6477 Creates a new SV and copies a floating point value into it.
6478 The reference count for the SV is set to 1.
6484 Perl_newSVnv(pTHX_ NV n)
6496 Creates a new SV and copies an integer into it. The reference count for the
6503 Perl_newSViv(pTHX_ IV i)
6515 Creates a new SV and copies an unsigned integer into it.
6516 The reference count for the SV is set to 1.
6522 Perl_newSVuv(pTHX_ UV u)
6532 =for apidoc newRV_noinc
6534 Creates an RV wrapper for an SV. The reference count for the original
6535 SV is B<not> incremented.
6541 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6546 sv_upgrade(sv, SVt_RV);
6548 SvRV_set(sv, tmpRef);
6553 /* newRV_inc is the official function name to use now.
6554 * newRV_inc is in fact #defined to newRV in sv.h
6558 Perl_newRV(pTHX_ SV *tmpRef)
6560 return newRV_noinc(SvREFCNT_inc(tmpRef));
6566 Creates a new SV which is an exact duplicate of the original SV.
6573 Perl_newSVsv(pTHX_ register SV *old)
6579 if (SvTYPE(old) == SVTYPEMASK) {
6580 if (ckWARN_d(WARN_INTERNAL))
6581 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6585 /* SV_GMAGIC is the default for sv_setv()
6586 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6587 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6588 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6593 =for apidoc sv_reset
6595 Underlying implementation for the C<reset> Perl function.
6596 Note that the perl-level function is vaguely deprecated.
6602 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6605 char todo[PERL_UCHAR_MAX+1];
6610 if (!*s) { /* reset ?? searches */
6611 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6613 PMOP *pm = (PMOP *) mg->mg_obj;
6615 pm->op_pmdynflags &= ~PMdf_USED;
6622 /* reset variables */
6624 if (!HvARRAY(stash))
6627 Zero(todo, 256, char);
6630 I32 i = (unsigned char)*s;
6634 max = (unsigned char)*s++;
6635 for ( ; i <= max; i++) {
6638 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6640 for (entry = HvARRAY(stash)[i];
6642 entry = HeNEXT(entry))
6647 if (!todo[(U8)*HeKEY(entry)])
6649 gv = (GV*)HeVAL(entry);
6652 if (SvTHINKFIRST(sv)) {
6653 if (!SvREADONLY(sv) && SvROK(sv))
6655 /* XXX Is this continue a bug? Why should THINKFIRST
6656 exempt us from resetting arrays and hashes? */
6660 if (SvTYPE(sv) >= SVt_PV) {
6662 if (SvPVX_const(sv) != Nullch)
6670 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6672 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6675 # if defined(USE_ENVIRON_ARRAY)
6678 # endif /* USE_ENVIRON_ARRAY */
6689 Using various gambits, try to get an IO from an SV: the IO slot if its a
6690 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6691 named after the PV if we're a string.
6697 Perl_sv_2io(pTHX_ SV *sv)
6702 switch (SvTYPE(sv)) {
6710 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6714 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6716 return sv_2io(SvRV(sv));
6717 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6723 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6732 Using various gambits, try to get a CV from an SV; in addition, try if
6733 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6739 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6746 return *gvp = Nullgv, Nullcv;
6747 switch (SvTYPE(sv)) {
6765 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6766 tryAMAGICunDEREF(to_cv);
6769 if (SvTYPE(sv) == SVt_PVCV) {
6778 Perl_croak(aTHX_ "Not a subroutine reference");
6783 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6789 if (lref && !GvCVu(gv)) {
6792 tmpsv = NEWSV(704,0);
6793 gv_efullname3(tmpsv, gv, Nullch);
6794 /* XXX this is probably not what they think they're getting.
6795 * It has the same effect as "sub name;", i.e. just a forward
6797 newSUB(start_subparse(FALSE, 0),
6798 newSVOP(OP_CONST, 0, tmpsv),
6803 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6813 Returns true if the SV has a true value by Perl's rules.
6814 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6815 instead use an in-line version.
6821 Perl_sv_true(pTHX_ register SV *sv)
6826 register const XPV* const tXpv = (XPV*)SvANY(sv);
6828 (tXpv->xpv_cur > 1 ||
6829 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6836 return SvIVX(sv) != 0;
6839 return SvNVX(sv) != 0.0;
6841 return sv_2bool(sv);
6847 =for apidoc sv_pvn_force
6849 Get a sensible string out of the SV somehow.
6850 A private implementation of the C<SvPV_force> macro for compilers which
6851 can't cope with complex macro expressions. Always use the macro instead.
6853 =for apidoc sv_pvn_force_flags
6855 Get a sensible string out of the SV somehow.
6856 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6857 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6858 implemented in terms of this function.
6859 You normally want to use the various wrapper macros instead: see
6860 C<SvPV_force> and C<SvPV_force_nomg>
6866 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6869 if (SvTHINKFIRST(sv) && !SvROK(sv))
6870 sv_force_normal_flags(sv, 0);
6880 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6881 const char * const ref = sv_reftype(sv,0);
6883 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6884 ref, OP_NAME(PL_op));
6886 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6888 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6889 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6891 s = sv_2pv_flags(sv, &len, flags);
6895 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6898 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6899 SvGROW(sv, len + 1);
6900 Move(s,SvPVX(sv),len,char);
6905 SvPOK_on(sv); /* validate pointer */
6907 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6908 PTR2UV(sv),SvPVX_const(sv)));
6911 return SvPVX_mutable(sv);
6915 =for apidoc sv_pvbyten_force
6917 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6923 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6925 sv_pvn_force(sv,lp);
6926 sv_utf8_downgrade(sv,0);
6932 =for apidoc sv_pvutf8n_force
6934 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6940 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6942 sv_pvn_force(sv,lp);
6943 sv_utf8_upgrade(sv);
6949 =for apidoc sv_reftype
6951 Returns a string describing what the SV is a reference to.
6957 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6959 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6960 inside return suggests a const propagation bug in g++. */
6961 if (ob && SvOBJECT(sv)) {
6962 char * const name = HvNAME_get(SvSTASH(sv));
6963 return name ? name : (char *) "__ANON__";
6966 switch (SvTYPE(sv)) {
6983 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6984 /* tied lvalues should appear to be
6985 * scalars for backwards compatitbility */
6986 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6987 ? "SCALAR" : "LVALUE");
6988 case SVt_PVAV: return "ARRAY";
6989 case SVt_PVHV: return "HASH";
6990 case SVt_PVCV: return "CODE";
6991 case SVt_PVGV: return "GLOB";
6992 case SVt_PVFM: return "FORMAT";
6993 case SVt_PVIO: return "IO";
6994 default: return "UNKNOWN";
7000 =for apidoc sv_isobject
7002 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7003 object. If the SV is not an RV, or if the object is not blessed, then this
7010 Perl_sv_isobject(pTHX_ SV *sv)
7026 Returns a boolean indicating whether the SV is blessed into the specified
7027 class. This does not check for subtypes; use C<sv_derived_from> to verify
7028 an inheritance relationship.
7034 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7045 hvname = HvNAME_get(SvSTASH(sv));
7049 return strEQ(hvname, name);
7055 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7056 it will be upgraded to one. If C<classname> is non-null then the new SV will
7057 be blessed in the specified package. The new SV is returned and its
7058 reference count is 1.
7064 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7070 SV_CHECK_THINKFIRST_COW_DROP(rv);
7073 if (SvTYPE(rv) >= SVt_PVMG) {
7074 const U32 refcnt = SvREFCNT(rv);
7078 SvREFCNT(rv) = refcnt;
7081 if (SvTYPE(rv) < SVt_RV)
7082 sv_upgrade(rv, SVt_RV);
7083 else if (SvTYPE(rv) > SVt_RV) {
7094 HV* const stash = gv_stashpv(classname, TRUE);
7095 (void)sv_bless(rv, stash);
7101 =for apidoc sv_setref_pv
7103 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7104 argument will be upgraded to an RV. That RV will be modified to point to
7105 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7106 into the SV. The C<classname> argument indicates the package for the
7107 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7108 will have a reference count of 1, and the RV will be returned.
7110 Do not use with other Perl types such as HV, AV, SV, CV, because those
7111 objects will become corrupted by the pointer copy process.
7113 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7119 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7122 sv_setsv(rv, &PL_sv_undef);
7126 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7131 =for apidoc sv_setref_iv
7133 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7134 argument will be upgraded to an RV. That RV will be modified to point to
7135 the new SV. The C<classname> argument indicates the package for the
7136 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7137 will have a reference count of 1, and the RV will be returned.
7143 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7145 sv_setiv(newSVrv(rv,classname), iv);
7150 =for apidoc sv_setref_uv
7152 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7153 argument will be upgraded to an RV. That RV will be modified to point to
7154 the new SV. The C<classname> argument indicates the package for the
7155 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7156 will have a reference count of 1, and the RV will be returned.
7162 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7164 sv_setuv(newSVrv(rv,classname), uv);
7169 =for apidoc sv_setref_nv
7171 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7172 argument will be upgraded to an RV. That RV will be modified to point to
7173 the new SV. The C<classname> argument indicates the package for the
7174 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7175 will have a reference count of 1, and the RV will be returned.
7181 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7183 sv_setnv(newSVrv(rv,classname), nv);
7188 =for apidoc sv_setref_pvn
7190 Copies a string into a new SV, optionally blessing the SV. The length of the
7191 string must be specified with C<n>. The C<rv> argument will be upgraded to
7192 an RV. That RV will be modified to point to the new SV. The C<classname>
7193 argument indicates the package for the blessing. Set C<classname> to
7194 C<Nullch> to avoid the blessing. The new SV will have a reference count
7195 of 1, and the RV will be returned.
7197 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7203 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7205 sv_setpvn(newSVrv(rv,classname), pv, n);
7210 =for apidoc sv_bless
7212 Blesses an SV into a specified package. The SV must be an RV. The package
7213 must be designated by its stash (see C<gv_stashpv()>). The reference count
7214 of the SV is unaffected.
7220 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7224 Perl_croak(aTHX_ "Can't bless non-reference value");
7226 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7227 if (SvREADONLY(tmpRef))
7228 Perl_croak(aTHX_ PL_no_modify);
7229 if (SvOBJECT(tmpRef)) {
7230 if (SvTYPE(tmpRef) != SVt_PVIO)
7232 SvREFCNT_dec(SvSTASH(tmpRef));
7235 SvOBJECT_on(tmpRef);
7236 if (SvTYPE(tmpRef) != SVt_PVIO)
7238 SvUPGRADE(tmpRef, SVt_PVMG);
7239 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7246 if(SvSMAGICAL(tmpRef))
7247 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7255 /* Downgrades a PVGV to a PVMG.
7259 S_sv_unglob(pTHX_ SV *sv)
7263 assert(SvTYPE(sv) == SVt_PVGV);
7268 sv_del_backref((SV*)GvSTASH(sv), sv);
7269 GvSTASH(sv) = Nullhv;
7271 sv_unmagic(sv, PERL_MAGIC_glob);
7272 Safefree(GvNAME(sv));
7275 /* need to keep SvANY(sv) in the right arena */
7276 xpvmg = new_XPVMG();
7277 StructCopy(SvANY(sv), xpvmg, XPVMG);
7278 del_XPVGV(SvANY(sv));
7281 SvFLAGS(sv) &= ~SVTYPEMASK;
7282 SvFLAGS(sv) |= SVt_PVMG;
7286 =for apidoc sv_unref_flags
7288 Unsets the RV status of the SV, and decrements the reference count of
7289 whatever was being referenced by the RV. This can almost be thought of
7290 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7291 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7292 (otherwise the decrementing is conditional on the reference count being
7293 different from one or the reference being a readonly SV).
7300 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7302 SV* const target = SvRV(ref);
7304 if (SvWEAKREF(ref)) {
7305 sv_del_backref(target, ref);
7307 SvRV_set(ref, NULL);
7310 SvRV_set(ref, NULL);
7312 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7313 assigned to as BEGIN {$a = \"Foo"} will fail. */
7314 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7315 SvREFCNT_dec(target);
7316 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7317 sv_2mortal(target); /* Schedule for freeing later */
7321 =for apidoc sv_untaint
7323 Untaint an SV. Use C<SvTAINTED_off> instead.
7328 Perl_sv_untaint(pTHX_ SV *sv)
7330 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7331 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7338 =for apidoc sv_tainted
7340 Test an SV for taintedness. Use C<SvTAINTED> instead.
7345 Perl_sv_tainted(pTHX_ SV *sv)
7347 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7348 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7349 if (mg && (mg->mg_len & 1) )
7356 =for apidoc sv_setpviv
7358 Copies an integer into the given SV, also updating its string value.
7359 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7365 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7367 char buf[TYPE_CHARS(UV)];
7369 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7371 sv_setpvn(sv, ptr, ebuf - ptr);
7375 =for apidoc sv_setpviv_mg
7377 Like C<sv_setpviv>, but also handles 'set' magic.
7383 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7389 #if defined(PERL_IMPLICIT_CONTEXT)
7391 /* pTHX_ magic can't cope with varargs, so this is a no-context
7392 * version of the main function, (which may itself be aliased to us).
7393 * Don't access this version directly.
7397 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7401 va_start(args, pat);
7402 sv_vsetpvf(sv, pat, &args);
7406 /* pTHX_ magic can't cope with varargs, so this is a no-context
7407 * version of the main function, (which may itself be aliased to us).
7408 * Don't access this version directly.
7412 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7416 va_start(args, pat);
7417 sv_vsetpvf_mg(sv, pat, &args);
7423 =for apidoc sv_setpvf
7425 Works like C<sv_catpvf> but copies the text into the SV instead of
7426 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7432 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7435 va_start(args, pat);
7436 sv_vsetpvf(sv, pat, &args);
7441 =for apidoc sv_vsetpvf
7443 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7444 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7446 Usually used via its frontend C<sv_setpvf>.
7452 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7454 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7458 =for apidoc sv_setpvf_mg
7460 Like C<sv_setpvf>, but also handles 'set' magic.
7466 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7469 va_start(args, pat);
7470 sv_vsetpvf_mg(sv, pat, &args);
7475 =for apidoc sv_vsetpvf_mg
7477 Like C<sv_vsetpvf>, but also handles 'set' magic.
7479 Usually used via its frontend C<sv_setpvf_mg>.
7485 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7487 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7491 #if defined(PERL_IMPLICIT_CONTEXT)
7493 /* pTHX_ magic can't cope with varargs, so this is a no-context
7494 * version of the main function, (which may itself be aliased to us).
7495 * Don't access this version directly.
7499 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7503 va_start(args, pat);
7504 sv_vcatpvf(sv, pat, &args);
7508 /* pTHX_ magic can't cope with varargs, so this is a no-context
7509 * version of the main function, (which may itself be aliased to us).
7510 * Don't access this version directly.
7514 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7518 va_start(args, pat);
7519 sv_vcatpvf_mg(sv, pat, &args);
7525 =for apidoc sv_catpvf
7527 Processes its arguments like C<sprintf> and appends the formatted
7528 output to an SV. If the appended data contains "wide" characters
7529 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7530 and characters >255 formatted with %c), the original SV might get
7531 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7532 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7533 valid UTF-8; if the original SV was bytes, the pattern should be too.
7538 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7541 va_start(args, pat);
7542 sv_vcatpvf(sv, pat, &args);
7547 =for apidoc sv_vcatpvf
7549 Processes its arguments like C<vsprintf> and appends the formatted output
7550 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7552 Usually used via its frontend C<sv_catpvf>.
7558 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7560 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7564 =for apidoc sv_catpvf_mg
7566 Like C<sv_catpvf>, but also handles 'set' magic.
7572 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7575 va_start(args, pat);
7576 sv_vcatpvf_mg(sv, pat, &args);
7581 =for apidoc sv_vcatpvf_mg
7583 Like C<sv_vcatpvf>, but also handles 'set' magic.
7585 Usually used via its frontend C<sv_catpvf_mg>.
7591 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7593 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7598 =for apidoc sv_vsetpvfn
7600 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7603 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7609 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7611 sv_setpvn(sv, "", 0);
7612 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7615 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7618 S_expect_number(pTHX_ char** pattern)
7621 switch (**pattern) {
7622 case '1': case '2': case '3':
7623 case '4': case '5': case '6':
7624 case '7': case '8': case '9':
7625 var = *(*pattern)++ - '0';
7626 while (isDIGIT(**pattern)) {
7627 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7629 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7635 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7638 F0convert(NV nv, char *endbuf, STRLEN *len)
7640 const int neg = nv < 0;
7649 if (uv & 1 && uv == nv)
7650 uv--; /* Round to even */
7652 const unsigned dig = uv % 10;
7665 =for apidoc sv_vcatpvfn
7667 Processes its arguments like C<vsprintf> and appends the formatted output
7668 to an SV. Uses an array of SVs if the C style variable argument list is
7669 missing (NULL). When running with taint checks enabled, indicates via
7670 C<maybe_tainted> if results are untrustworthy (often due to the use of
7673 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7679 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7680 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7681 vec_utf8 = DO_UTF8(vecsv);
7683 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7686 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7693 static const char nullstr[] = "(null)";
7695 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7696 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7698 /* Times 4: a decimal digit takes more than 3 binary digits.
7699 * NV_DIG: mantissa takes than many decimal digits.
7700 * Plus 32: Playing safe. */
7701 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7702 /* large enough for "%#.#f" --chip */
7703 /* what about long double NVs? --jhi */
7705 PERL_UNUSED_ARG(maybe_tainted);
7707 /* no matter what, this is a string now */
7708 (void)SvPV_force(sv, origlen);
7710 /* special-case "", "%s", and "%-p" (SVf - see below) */
7713 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7715 const char * const s = va_arg(*args, char*);
7716 sv_catpv(sv, s ? s : nullstr);
7718 else if (svix < svmax) {
7719 sv_catsv(sv, *svargs);
7723 if (args && patlen == 3 && pat[0] == '%' &&
7724 pat[1] == '-' && pat[2] == 'p') {
7725 argsv = va_arg(*args, SV*);
7726 sv_catsv(sv, argsv);
7730 #ifndef USE_LONG_DOUBLE
7731 /* special-case "%.<number>[gf]" */
7732 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7733 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7734 unsigned digits = 0;
7738 while (*pp >= '0' && *pp <= '9')
7739 digits = 10 * digits + (*pp++ - '0');
7740 if (pp - pat == (int)patlen - 1) {
7748 /* Add check for digits != 0 because it seems that some
7749 gconverts are buggy in this case, and we don't yet have
7750 a Configure test for this. */
7751 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7752 /* 0, point, slack */
7753 Gconvert(nv, (int)digits, 0, ebuf);
7755 if (*ebuf) /* May return an empty string for digits==0 */
7758 } else if (!digits) {
7761 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7762 sv_catpvn(sv, p, l);
7768 #endif /* !USE_LONG_DOUBLE */
7770 if (!args && svix < svmax && DO_UTF8(*svargs))
7773 patend = (char*)pat + patlen;
7774 for (p = (char*)pat; p < patend; p = q) {
7777 bool vectorize = FALSE;
7778 bool vectorarg = FALSE;
7779 bool vec_utf8 = FALSE;
7785 bool has_precis = FALSE;
7788 bool is_utf8 = FALSE; /* is this item utf8? */
7789 #ifdef HAS_LDBL_SPRINTF_BUG
7790 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7791 with sfio - Allen <allens@cpan.org> */
7792 bool fix_ldbl_sprintf_bug = FALSE;
7796 U8 utf8buf[UTF8_MAXBYTES+1];
7797 STRLEN esignlen = 0;
7799 const char *eptr = Nullch;
7802 const U8 *vecstr = Null(U8*);
7809 /* we need a long double target in case HAS_LONG_DOUBLE but
7812 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7820 const char *dotstr = ".";
7821 STRLEN dotstrlen = 1;
7822 I32 efix = 0; /* explicit format parameter index */
7823 I32 ewix = 0; /* explicit width index */
7824 I32 epix = 0; /* explicit precision index */
7825 I32 evix = 0; /* explicit vector index */
7826 bool asterisk = FALSE;
7828 /* echo everything up to the next format specification */
7829 for (q = p; q < patend && *q != '%'; ++q) ;
7831 if (has_utf8 && !pat_utf8)
7832 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7834 sv_catpvn(sv, p, q - p);
7841 We allow format specification elements in this order:
7842 \d+\$ explicit format parameter index
7844 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7845 0 flag (as above): repeated to allow "v02"
7846 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7847 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7849 [%bcdefginopsuxDFOUX] format (mandatory)
7854 As of perl5.9.3, printf format checking is on by default.
7855 Internally, perl uses %p formats to provide an escape to
7856 some extended formatting. This block deals with those
7857 extensions: if it does not match, (char*)q is reset and
7858 the normal format processing code is used.
7860 Currently defined extensions are:
7861 %p include pointer address (standard)
7862 %-p (SVf) include an SV (previously %_)
7863 %-<num>p include an SV with precision <num>
7864 %1p (VDf) include a v-string (as %vd)
7865 %<num>p reserved for future extensions
7867 Robin Barker 2005-07-14
7874 EXPECT_NUMBER(q, n);
7881 argsv = va_arg(*args, SV*);
7882 eptr = SvPVx_const(argsv, elen);
7888 else if (n == vdNUMBER) { /* VDf */
7895 if (ckWARN_d(WARN_INTERNAL))
7896 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7897 "internal %%<num>p might conflict with future printf extensions");
7903 if (EXPECT_NUMBER(q, width)) {
7944 if (EXPECT_NUMBER(q, ewix))
7953 if ((vectorarg = asterisk)) {
7966 EXPECT_NUMBER(q, width);
7972 vecsv = va_arg(*args, SV*);
7974 vecsv = (evix > 0 && evix <= svmax)
7975 ? svargs[evix-1] : &PL_sv_undef;
7977 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7979 dotstr = SvPV_const(vecsv, dotstrlen);
7980 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7981 bad with tied or overloaded values that return UTF8. */
7984 else if (has_utf8) {
7985 vecsv = sv_mortalcopy(vecsv);
7986 sv_utf8_upgrade(vecsv);
7987 dotstr = SvPV_const(vecsv, dotstrlen);
7994 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
7995 vecsv = svargs[efix ? efix-1 : svix++];
7996 vecstr = (U8*)SvPV_const(vecsv,veclen);
7997 vec_utf8 = DO_UTF8(vecsv);
7998 /* if this is a version object, we need to return the
7999 * stringified representation (which the SvPVX_const has
8000 * already done for us), but not vectorize the args
8002 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8004 q++; /* skip past the rest of the %vd format */
8005 eptr = (const char *) vecstr;
8007 if (elen && *eptr == 'v') {
8023 i = va_arg(*args, int);
8025 i = (ewix ? ewix <= svmax : svix < svmax) ?
8026 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8028 width = (i < 0) ? -i : i;
8038 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8040 /* XXX: todo, support specified precision parameter */
8044 i = va_arg(*args, int);
8046 i = (ewix ? ewix <= svmax : svix < svmax)
8047 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8048 precis = (i < 0) ? 0 : i;
8053 precis = precis * 10 + (*q++ - '0');
8062 case 'I': /* Ix, I32x, and I64x */
8064 if (q[1] == '6' && q[2] == '4') {
8070 if (q[1] == '3' && q[2] == '2') {
8080 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8091 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8092 if (*(q + 1) == 'l') { /* lld, llf */
8118 if (!vectorize && !args) {
8120 const I32 i = efix-1;
8121 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8123 argsv = (svix >= 0 && svix < svmax)
8124 ? svargs[svix++] : &PL_sv_undef;
8135 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8137 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8139 eptr = (char*)utf8buf;
8140 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8154 eptr = va_arg(*args, char*);
8156 #ifdef MACOS_TRADITIONAL
8157 /* On MacOS, %#s format is used for Pascal strings */
8162 elen = strlen(eptr);
8164 eptr = (char *)nullstr;
8165 elen = sizeof nullstr - 1;
8169 eptr = SvPVx_const(argsv, elen);
8170 if (DO_UTF8(argsv)) {
8171 if (has_precis && precis < elen) {
8173 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8176 if (width) { /* fudge width (can't fudge elen) */
8177 width += elen - sv_len_utf8(argsv);
8184 if (has_precis && elen > precis)
8191 if (alt || vectorize)
8193 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8214 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8223 esignbuf[esignlen++] = plus;
8227 case 'h': iv = (short)va_arg(*args, int); break;
8228 case 'l': iv = va_arg(*args, long); break;
8229 case 'V': iv = va_arg(*args, IV); break;
8230 default: iv = va_arg(*args, int); break;
8232 case 'q': iv = va_arg(*args, Quad_t); break;
8237 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8239 case 'h': iv = (short)tiv; break;
8240 case 'l': iv = (long)tiv; break;
8242 default: iv = tiv; break;
8244 case 'q': iv = (Quad_t)tiv; break;
8248 if ( !vectorize ) /* we already set uv above */
8253 esignbuf[esignlen++] = plus;
8257 esignbuf[esignlen++] = '-';
8300 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8311 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8312 case 'l': uv = va_arg(*args, unsigned long); break;
8313 case 'V': uv = va_arg(*args, UV); break;
8314 default: uv = va_arg(*args, unsigned); break;
8316 case 'q': uv = va_arg(*args, Uquad_t); break;
8321 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8323 case 'h': uv = (unsigned short)tuv; break;
8324 case 'l': uv = (unsigned long)tuv; break;
8326 default: uv = tuv; break;
8328 case 'q': uv = (Uquad_t)tuv; break;
8335 char *ptr = ebuf + sizeof ebuf;
8341 p = (char*)((c == 'X')
8342 ? "0123456789ABCDEF" : "0123456789abcdef");
8348 esignbuf[esignlen++] = '0';
8349 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8357 if (alt && *ptr != '0')
8368 esignbuf[esignlen++] = '0';
8369 esignbuf[esignlen++] = 'b';
8372 default: /* it had better be ten or less */
8376 } while (uv /= base);
8379 elen = (ebuf + sizeof ebuf) - ptr;
8383 zeros = precis - elen;
8384 else if (precis == 0 && elen == 1 && *eptr == '0')
8390 /* FLOATING POINT */
8393 c = 'f'; /* maybe %F isn't supported here */
8401 /* This is evil, but floating point is even more evil */
8403 /* for SV-style calling, we can only get NV
8404 for C-style calling, we assume %f is double;
8405 for simplicity we allow any of %Lf, %llf, %qf for long double
8409 #if defined(USE_LONG_DOUBLE)
8413 /* [perl #20339] - we should accept and ignore %lf rather than die */
8417 #if defined(USE_LONG_DOUBLE)
8418 intsize = args ? 0 : 'q';
8422 #if defined(HAS_LONG_DOUBLE)
8431 /* now we need (long double) if intsize == 'q', else (double) */
8433 #if LONG_DOUBLESIZE > DOUBLESIZE
8435 va_arg(*args, long double) :
8436 va_arg(*args, double)
8438 va_arg(*args, double)
8443 if (c != 'e' && c != 'E') {
8445 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8446 will cast our (long double) to (double) */
8447 (void)Perl_frexp(nv, &i);
8448 if (i == PERL_INT_MIN)
8449 Perl_die(aTHX_ "panic: frexp");
8451 need = BIT_DIGITS(i);
8453 need += has_precis ? precis : 6; /* known default */
8458 #ifdef HAS_LDBL_SPRINTF_BUG
8459 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8460 with sfio - Allen <allens@cpan.org> */
8463 # define MY_DBL_MAX DBL_MAX
8464 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8465 # if DOUBLESIZE >= 8
8466 # define MY_DBL_MAX 1.7976931348623157E+308L
8468 # define MY_DBL_MAX 3.40282347E+38L
8472 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8473 # define MY_DBL_MAX_BUG 1L
8475 # define MY_DBL_MAX_BUG MY_DBL_MAX
8479 # define MY_DBL_MIN DBL_MIN
8480 # else /* XXX guessing! -Allen */
8481 # if DOUBLESIZE >= 8
8482 # define MY_DBL_MIN 2.2250738585072014E-308L
8484 # define MY_DBL_MIN 1.17549435E-38L
8488 if ((intsize == 'q') && (c == 'f') &&
8489 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8491 /* it's going to be short enough that
8492 * long double precision is not needed */
8494 if ((nv <= 0L) && (nv >= -0L))
8495 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8497 /* would use Perl_fp_class as a double-check but not
8498 * functional on IRIX - see perl.h comments */
8500 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8501 /* It's within the range that a double can represent */
8502 #if defined(DBL_MAX) && !defined(DBL_MIN)
8503 if ((nv >= ((long double)1/DBL_MAX)) ||
8504 (nv <= (-(long double)1/DBL_MAX)))
8506 fix_ldbl_sprintf_bug = TRUE;
8509 if (fix_ldbl_sprintf_bug == TRUE) {
8519 # undef MY_DBL_MAX_BUG
8522 #endif /* HAS_LDBL_SPRINTF_BUG */
8524 need += 20; /* fudge factor */
8525 if (PL_efloatsize < need) {
8526 Safefree(PL_efloatbuf);
8527 PL_efloatsize = need + 20; /* more fudge */
8528 Newx(PL_efloatbuf, PL_efloatsize, char);
8529 PL_efloatbuf[0] = '\0';
8532 if ( !(width || left || plus || alt) && fill != '0'
8533 && has_precis && intsize != 'q' ) { /* Shortcuts */
8534 /* See earlier comment about buggy Gconvert when digits,
8536 if ( c == 'g' && precis) {
8537 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8538 /* May return an empty string for digits==0 */
8539 if (*PL_efloatbuf) {
8540 elen = strlen(PL_efloatbuf);
8541 goto float_converted;
8543 } else if ( c == 'f' && !precis) {
8544 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8549 char *ptr = ebuf + sizeof ebuf;
8552 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8553 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8554 if (intsize == 'q') {
8555 /* Copy the one or more characters in a long double
8556 * format before the 'base' ([efgEFG]) character to
8557 * the format string. */
8558 static char const prifldbl[] = PERL_PRIfldbl;
8559 char const *p = prifldbl + sizeof(prifldbl) - 3;
8560 while (p >= prifldbl) { *--ptr = *p--; }
8565 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8570 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8582 /* No taint. Otherwise we are in the strange situation
8583 * where printf() taints but print($float) doesn't.
8585 #if defined(HAS_LONG_DOUBLE)
8586 elen = ((intsize == 'q')
8587 ? my_sprintf(PL_efloatbuf, ptr, nv)
8588 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8590 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8594 eptr = PL_efloatbuf;
8602 i = SvCUR(sv) - origlen;
8605 case 'h': *(va_arg(*args, short*)) = i; break;
8606 default: *(va_arg(*args, int*)) = i; break;
8607 case 'l': *(va_arg(*args, long*)) = i; break;
8608 case 'V': *(va_arg(*args, IV*)) = i; break;
8610 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8615 sv_setuv_mg(argsv, (UV)i);
8616 continue; /* not "break" */
8623 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8624 && ckWARN(WARN_PRINTF))
8626 SV * const msg = sv_newmortal();
8627 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8628 (PL_op->op_type == OP_PRTF) ? "" : "s");
8631 Perl_sv_catpvf(aTHX_ msg,
8632 "\"%%%c\"", c & 0xFF);
8634 Perl_sv_catpvf(aTHX_ msg,
8635 "\"%%\\%03"UVof"\"",
8638 sv_catpv(msg, "end of string");
8639 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8642 /* output mangled stuff ... */
8648 /* ... right here, because formatting flags should not apply */
8649 SvGROW(sv, SvCUR(sv) + elen + 1);
8651 Copy(eptr, p, elen, char);
8654 SvCUR_set(sv, p - SvPVX_const(sv));
8656 continue; /* not "break" */
8659 /* calculate width before utf8_upgrade changes it */
8660 have = esignlen + zeros + elen;
8662 Perl_croak_nocontext(PL_memory_wrap);
8664 if (is_utf8 != has_utf8) {
8667 sv_utf8_upgrade(sv);
8670 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8671 sv_utf8_upgrade(nsv);
8672 eptr = SvPVX_const(nsv);
8675 SvGROW(sv, SvCUR(sv) + elen + 1);
8680 need = (have > width ? have : width);
8683 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8684 Perl_croak_nocontext(PL_memory_wrap);
8685 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8687 if (esignlen && fill == '0') {
8689 for (i = 0; i < (int)esignlen; i++)
8693 memset(p, fill, gap);
8696 if (esignlen && fill != '0') {
8698 for (i = 0; i < (int)esignlen; i++)
8703 for (i = zeros; i; i--)
8707 Copy(eptr, p, elen, char);
8711 memset(p, ' ', gap);
8716 Copy(dotstr, p, dotstrlen, char);
8720 vectorize = FALSE; /* done iterating over vecstr */
8727 SvCUR_set(sv, p - SvPVX_const(sv));
8735 /* =========================================================================
8737 =head1 Cloning an interpreter
8739 All the macros and functions in this section are for the private use of
8740 the main function, perl_clone().
8742 The foo_dup() functions make an exact copy of an existing foo thinngy.
8743 During the course of a cloning, a hash table is used to map old addresses
8744 to new addresses. The table is created and manipulated with the
8745 ptr_table_* functions.
8749 ============================================================================*/
8752 #if defined(USE_ITHREADS)
8754 #ifndef GpREFCNT_inc
8755 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8759 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8760 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8761 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8762 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8763 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8764 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8765 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8766 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8767 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8768 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8769 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8770 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8771 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8774 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8775 regcomp.c. AMS 20010712 */
8778 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8783 struct reg_substr_datum *s;
8786 return (REGEXP *)NULL;
8788 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8791 len = r->offsets[0];
8792 npar = r->nparens+1;
8794 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8795 Copy(r->program, ret->program, len+1, regnode);
8797 Newx(ret->startp, npar, I32);
8798 Copy(r->startp, ret->startp, npar, I32);
8799 Newx(ret->endp, npar, I32);
8800 Copy(r->startp, ret->startp, npar, I32);
8802 Newx(ret->substrs, 1, struct reg_substr_data);
8803 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8804 s->min_offset = r->substrs->data[i].min_offset;
8805 s->max_offset = r->substrs->data[i].max_offset;
8806 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8807 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8810 ret->regstclass = NULL;
8813 const int count = r->data->count;
8816 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8817 char, struct reg_data);
8818 Newx(d->what, count, U8);
8821 for (i = 0; i < count; i++) {
8822 d->what[i] = r->data->what[i];
8823 switch (d->what[i]) {
8824 /* legal options are one of: sfpont
8825 see also regcomp.h and pregfree() */
8827 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8830 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8833 /* This is cheating. */
8834 Newx(d->data[i], 1, struct regnode_charclass_class);
8835 StructCopy(r->data->data[i], d->data[i],
8836 struct regnode_charclass_class);
8837 ret->regstclass = (regnode*)d->data[i];
8840 /* Compiled op trees are readonly, and can thus be
8841 shared without duplication. */
8843 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8847 d->data[i] = r->data->data[i];
8850 d->data[i] = r->data->data[i];
8852 ((reg_trie_data*)d->data[i])->refcount++;
8856 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8865 Newx(ret->offsets, 2*len+1, U32);
8866 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8868 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8869 ret->refcnt = r->refcnt;
8870 ret->minlen = r->minlen;
8871 ret->prelen = r->prelen;
8872 ret->nparens = r->nparens;
8873 ret->lastparen = r->lastparen;
8874 ret->lastcloseparen = r->lastcloseparen;
8875 ret->reganch = r->reganch;
8877 ret->sublen = r->sublen;
8879 if (RX_MATCH_COPIED(ret))
8880 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8882 ret->subbeg = Nullch;
8883 #ifdef PERL_OLD_COPY_ON_WRITE
8884 ret->saved_copy = Nullsv;
8887 ptr_table_store(PL_ptr_table, r, ret);
8891 /* duplicate a file handle */
8894 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8898 PERL_UNUSED_ARG(type);
8901 return (PerlIO*)NULL;
8903 /* look for it in the table first */
8904 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8908 /* create anew and remember what it is */
8909 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8910 ptr_table_store(PL_ptr_table, fp, ret);
8914 /* duplicate a directory handle */
8917 Perl_dirp_dup(pTHX_ DIR *dp)
8925 /* duplicate a typeglob */
8928 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8933 /* look for it in the table first */
8934 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8938 /* create anew and remember what it is */
8940 ptr_table_store(PL_ptr_table, gp, ret);
8943 ret->gp_refcnt = 0; /* must be before any other dups! */
8944 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8945 ret->gp_io = io_dup_inc(gp->gp_io, param);
8946 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8947 ret->gp_av = av_dup_inc(gp->gp_av, param);
8948 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8949 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8950 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8951 ret->gp_cvgen = gp->gp_cvgen;
8952 ret->gp_line = gp->gp_line;
8953 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8957 /* duplicate a chain of magic */
8960 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8962 MAGIC *mgprev = (MAGIC*)NULL;
8965 return (MAGIC*)NULL;
8966 /* look for it in the table first */
8967 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8971 for (; mg; mg = mg->mg_moremagic) {
8973 Newxz(nmg, 1, MAGIC);
8975 mgprev->mg_moremagic = nmg;
8978 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8979 nmg->mg_private = mg->mg_private;
8980 nmg->mg_type = mg->mg_type;
8981 nmg->mg_flags = mg->mg_flags;
8982 if (mg->mg_type == PERL_MAGIC_qr) {
8983 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8985 else if(mg->mg_type == PERL_MAGIC_backref) {
8986 const AV * const av = (AV*) mg->mg_obj;
8989 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8991 for (i = AvFILLp(av); i >= 0; i--) {
8992 if (!svp[i]) continue;
8993 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8996 else if (mg->mg_type == PERL_MAGIC_symtab) {
8997 nmg->mg_obj = mg->mg_obj;
9000 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9001 ? sv_dup_inc(mg->mg_obj, param)
9002 : sv_dup(mg->mg_obj, param);
9004 nmg->mg_len = mg->mg_len;
9005 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9006 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9007 if (mg->mg_len > 0) {
9008 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9009 if (mg->mg_type == PERL_MAGIC_overload_table &&
9010 AMT_AMAGIC((AMT*)mg->mg_ptr))
9012 AMT * const amtp = (AMT*)mg->mg_ptr;
9013 AMT * const namtp = (AMT*)nmg->mg_ptr;
9015 for (i = 1; i < NofAMmeth; i++) {
9016 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9020 else if (mg->mg_len == HEf_SVKEY)
9021 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9023 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9024 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9031 /* create a new pointer-mapping table */
9034 Perl_ptr_table_new(pTHX)
9037 Newxz(tbl, 1, PTR_TBL_t);
9040 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9044 #define PTR_TABLE_HASH(ptr) \
9045 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9048 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9049 following define) and at call to new_body_inline made below in
9050 Perl_ptr_table_store()
9053 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9055 /* map an existing pointer using a table */
9057 STATIC PTR_TBL_ENT_t *
9058 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9059 PTR_TBL_ENT_t *tblent;
9060 const UV hash = PTR_TABLE_HASH(sv);
9062 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9063 for (; tblent; tblent = tblent->next) {
9064 if (tblent->oldval == sv)
9071 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9073 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9074 return tblent ? tblent->newval : (void *) 0;
9077 /* add a new entry to a pointer-mapping table */
9080 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9082 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9085 tblent->newval = newsv;
9087 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9089 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9090 tblent->oldval = oldsv;
9091 tblent->newval = newsv;
9092 tblent->next = tbl->tbl_ary[entry];
9093 tbl->tbl_ary[entry] = tblent;
9095 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9096 ptr_table_split(tbl);
9100 /* double the hash bucket size of an existing ptr table */
9103 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9105 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9106 const UV oldsize = tbl->tbl_max + 1;
9107 UV newsize = oldsize * 2;
9110 Renew(ary, newsize, PTR_TBL_ENT_t*);
9111 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9112 tbl->tbl_max = --newsize;
9114 for (i=0; i < oldsize; i++, ary++) {
9115 PTR_TBL_ENT_t **curentp, **entp, *ent;
9118 curentp = ary + oldsize;
9119 for (entp = ary, ent = *ary; ent; ent = *entp) {
9120 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9122 ent->next = *curentp;
9132 /* remove all the entries from a ptr table */
9135 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9137 if (tbl && tbl->tbl_items) {
9138 register PTR_TBL_ENT_t **array = tbl->tbl_ary;
9139 UV riter = tbl->tbl_max;
9142 PTR_TBL_ENT_t *entry = array[riter];
9145 PTR_TBL_ENT_t * const oentry = entry;
9146 entry = entry->next;
9155 /* clear and free a ptr table */
9158 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9163 ptr_table_clear(tbl);
9164 Safefree(tbl->tbl_ary);
9170 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9173 SvRV_set(dstr, SvWEAKREF(sstr)
9174 ? sv_dup(SvRV(sstr), param)
9175 : sv_dup_inc(SvRV(sstr), param));
9178 else if (SvPVX_const(sstr)) {
9179 /* Has something there */
9181 /* Normal PV - clone whole allocated space */
9182 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9183 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9184 /* Not that normal - actually sstr is copy on write.
9185 But we are a true, independant SV, so: */
9186 SvREADONLY_off(dstr);
9191 /* Special case - not normally malloced for some reason */
9192 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9193 /* A "shared" PV - clone it as "shared" PV */
9195 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9199 /* Some other special case - random pointer */
9200 SvPV_set(dstr, SvPVX(sstr));
9206 if (SvTYPE(dstr) == SVt_RV)
9207 SvRV_set(dstr, NULL);
9213 /* duplicate an SV of any type (including AV, HV etc) */
9216 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9221 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9223 /* look for it in the table first */
9224 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9228 if(param->flags & CLONEf_JOIN_IN) {
9229 /** We are joining here so we don't want do clone
9230 something that is bad **/
9233 if(SvTYPE(sstr) == SVt_PVHV &&
9234 (hvname = HvNAME_get(sstr))) {
9235 /** don't clone stashes if they already exist **/
9236 return (SV*)gv_stashpv(hvname,0);
9240 /* create anew and remember what it is */
9243 #ifdef DEBUG_LEAKING_SCALARS
9244 dstr->sv_debug_optype = sstr->sv_debug_optype;
9245 dstr->sv_debug_line = sstr->sv_debug_line;
9246 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9247 dstr->sv_debug_cloned = 1;
9249 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9251 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9255 ptr_table_store(PL_ptr_table, sstr, dstr);
9258 SvFLAGS(dstr) = SvFLAGS(sstr);
9259 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9260 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9263 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9264 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9265 PL_watch_pvx, SvPVX_const(sstr));
9268 /* don't clone objects whose class has asked us not to */
9269 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9270 SvFLAGS(dstr) &= ~SVTYPEMASK;
9275 switch (SvTYPE(sstr)) {
9280 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9281 SvIV_set(dstr, SvIVX(sstr));
9284 SvANY(dstr) = new_XNV();
9285 SvNV_set(dstr, SvNVX(sstr));
9288 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9289 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9293 /* These are all the types that need complex bodies allocating. */
9295 const svtype sv_type = SvTYPE(sstr);
9296 const struct body_details *const sv_type_details
9297 = bodies_by_type + sv_type;
9301 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9306 if (GvUNIQUE((GV*)sstr)) {
9307 /* Do sharing here, and fall through */
9320 assert(sv_type_details->copy);
9321 if (sv_type_details->arena) {
9322 new_body_inline(new_body, sv_type_details->copy, sv_type);
9324 = (void*)((char*)new_body - sv_type_details->offset);
9326 new_body = new_NOARENA(sv_type_details);
9330 SvANY(dstr) = new_body;
9333 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9334 ((char*)SvANY(dstr)) + sv_type_details->offset,
9335 sv_type_details->copy, char);
9337 Copy(((char*)SvANY(sstr)),
9338 ((char*)SvANY(dstr)),
9339 sv_type_details->size + sv_type_details->offset, char);
9342 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9343 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9345 /* The Copy above means that all the source (unduplicated) pointers
9346 are now in the destination. We can check the flags and the
9347 pointers in either, but it's possible that there's less cache
9348 missing by always going for the destination.
9349 FIXME - instrument and check that assumption */
9350 if (sv_type >= SVt_PVMG) {
9352 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9354 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9357 /* The cast silences a GCC warning about unhandled types. */
9358 switch ((int)sv_type) {
9370 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9371 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9372 LvTARG(dstr) = dstr;
9373 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9374 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9376 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9379 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9380 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9381 /* Don't call sv_add_backref here as it's going to be created
9382 as part of the magic cloning of the symbol table. */
9383 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9384 (void)GpREFCNT_inc(GvGP(dstr));
9387 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9388 if (IoOFP(dstr) == IoIFP(sstr))
9389 IoOFP(dstr) = IoIFP(dstr);
9391 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9392 /* PL_rsfp_filters entries have fake IoDIRP() */
9393 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9394 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9395 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9396 /* I have no idea why fake dirp (rsfps)
9397 should be treated differently but otherwise
9398 we end up with leaks -- sky*/
9399 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9400 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9401 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9403 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9404 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9405 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9407 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9408 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9409 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9412 if (AvARRAY((AV*)sstr)) {
9413 SV **dst_ary, **src_ary;
9414 SSize_t items = AvFILLp((AV*)sstr) + 1;
9416 src_ary = AvARRAY((AV*)sstr);
9417 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9418 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9419 SvPV_set(dstr, (char*)dst_ary);
9420 AvALLOC((AV*)dstr) = dst_ary;
9421 if (AvREAL((AV*)sstr)) {
9423 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9427 *dst_ary++ = sv_dup(*src_ary++, param);
9429 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9430 while (items-- > 0) {
9431 *dst_ary++ = &PL_sv_undef;
9435 SvPV_set(dstr, Nullch);
9436 AvALLOC((AV*)dstr) = (SV**)NULL;
9443 if (HvARRAY((HV*)sstr)) {
9445 const bool sharekeys = !!HvSHAREKEYS(sstr);
9446 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9447 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9449 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9450 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9452 HvARRAY(dstr) = (HE**)darray;
9453 while (i <= sxhv->xhv_max) {
9454 const HE *source = HvARRAY(sstr)[i];
9455 HvARRAY(dstr)[i] = source
9456 ? he_dup(source, sharekeys, param) : 0;
9460 struct xpvhv_aux * const saux = HvAUX(sstr);
9461 struct xpvhv_aux * const daux = HvAUX(dstr);
9462 /* This flag isn't copied. */
9463 /* SvOOK_on(hv) attacks the IV flags. */
9464 SvFLAGS(dstr) |= SVf_OOK;
9466 hvname = saux->xhv_name;
9468 = hvname ? hek_dup(hvname, param) : hvname;
9470 daux->xhv_riter = saux->xhv_riter;
9471 daux->xhv_eiter = saux->xhv_eiter
9472 ? he_dup(saux->xhv_eiter,
9473 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9477 SvPV_set(dstr, Nullch);
9479 /* Record stashes for possible cloning in Perl_clone(). */
9481 av_push(param->stashes, dstr);
9486 /* NOTE: not refcounted */
9487 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9489 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9491 if (CvCONST(dstr)) {
9492 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9493 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9494 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9496 /* don't dup if copying back - CvGV isn't refcounted, so the
9497 * duped GV may never be freed. A bit of a hack! DAPM */
9498 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9499 Nullgv : gv_dup(CvGV(dstr), param) ;
9500 if (!(param->flags & CLONEf_COPY_STACKS)) {
9503 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9506 ? cv_dup( CvOUTSIDE(dstr), param)
9507 : cv_dup_inc(CvOUTSIDE(dstr), param);
9509 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9515 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9521 /* duplicate a context */
9524 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9529 return (PERL_CONTEXT*)NULL;
9531 /* look for it in the table first */
9532 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9536 /* create anew and remember what it is */
9537 Newxz(ncxs, max + 1, PERL_CONTEXT);
9538 ptr_table_store(PL_ptr_table, cxs, ncxs);
9541 PERL_CONTEXT *cx = &cxs[ix];
9542 PERL_CONTEXT *ncx = &ncxs[ix];
9543 ncx->cx_type = cx->cx_type;
9544 if (CxTYPE(cx) == CXt_SUBST) {
9545 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9548 ncx->blk_oldsp = cx->blk_oldsp;
9549 ncx->blk_oldcop = cx->blk_oldcop;
9550 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9551 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9552 ncx->blk_oldpm = cx->blk_oldpm;
9553 ncx->blk_gimme = cx->blk_gimme;
9554 switch (CxTYPE(cx)) {
9556 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9557 ? cv_dup_inc(cx->blk_sub.cv, param)
9558 : cv_dup(cx->blk_sub.cv,param));
9559 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9560 ? av_dup_inc(cx->blk_sub.argarray, param)
9562 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9563 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9564 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9565 ncx->blk_sub.lval = cx->blk_sub.lval;
9566 ncx->blk_sub.retop = cx->blk_sub.retop;
9569 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9570 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9571 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9572 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9573 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9574 ncx->blk_eval.retop = cx->blk_eval.retop;
9577 ncx->blk_loop.label = cx->blk_loop.label;
9578 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9579 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9580 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9581 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9582 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9583 ? cx->blk_loop.iterdata
9584 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9585 ncx->blk_loop.oldcomppad
9586 = (PAD*)ptr_table_fetch(PL_ptr_table,
9587 cx->blk_loop.oldcomppad);
9588 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9589 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9590 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9591 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9592 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9595 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9596 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9597 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9598 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9599 ncx->blk_sub.retop = cx->blk_sub.retop;
9611 /* duplicate a stack info structure */
9614 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9619 return (PERL_SI*)NULL;
9621 /* look for it in the table first */
9622 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9626 /* create anew and remember what it is */
9627 Newxz(nsi, 1, PERL_SI);
9628 ptr_table_store(PL_ptr_table, si, nsi);
9630 nsi->si_stack = av_dup_inc(si->si_stack, param);
9631 nsi->si_cxix = si->si_cxix;
9632 nsi->si_cxmax = si->si_cxmax;
9633 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9634 nsi->si_type = si->si_type;
9635 nsi->si_prev = si_dup(si->si_prev, param);
9636 nsi->si_next = si_dup(si->si_next, param);
9637 nsi->si_markoff = si->si_markoff;
9642 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9643 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9644 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9645 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9646 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9647 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9648 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9649 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9650 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9651 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9652 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9653 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9654 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9655 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9658 #define pv_dup_inc(p) SAVEPV(p)
9659 #define pv_dup(p) SAVEPV(p)
9660 #define svp_dup_inc(p,pp) any_dup(p,pp)
9662 /* map any object to the new equivent - either something in the
9663 * ptr table, or something in the interpreter structure
9667 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9674 /* look for it in the table first */
9675 ret = ptr_table_fetch(PL_ptr_table, v);
9679 /* see if it is part of the interpreter structure */
9680 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9681 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9689 /* duplicate the save stack */
9692 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9694 ANY * const ss = proto_perl->Tsavestack;
9695 const I32 max = proto_perl->Tsavestack_max;
9696 I32 ix = proto_perl->Tsavestack_ix;
9708 void (*dptr) (void*);
9709 void (*dxptr) (pTHX_ void*);
9711 Newxz(nss, max, ANY);
9714 I32 i = POPINT(ss,ix);
9717 case SAVEt_ITEM: /* normal string */
9718 sv = (SV*)POPPTR(ss,ix);
9719 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9720 sv = (SV*)POPPTR(ss,ix);
9721 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9723 case SAVEt_SV: /* scalar reference */
9724 sv = (SV*)POPPTR(ss,ix);
9725 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9726 gv = (GV*)POPPTR(ss,ix);
9727 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9729 case SAVEt_GENERIC_PVREF: /* generic char* */
9730 c = (char*)POPPTR(ss,ix);
9731 TOPPTR(nss,ix) = pv_dup(c);
9732 ptr = POPPTR(ss,ix);
9733 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9735 case SAVEt_SHARED_PVREF: /* char* in shared space */
9736 c = (char*)POPPTR(ss,ix);
9737 TOPPTR(nss,ix) = savesharedpv(c);
9738 ptr = POPPTR(ss,ix);
9739 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9741 case SAVEt_GENERIC_SVREF: /* generic sv */
9742 case SAVEt_SVREF: /* scalar reference */
9743 sv = (SV*)POPPTR(ss,ix);
9744 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9745 ptr = POPPTR(ss,ix);
9746 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9748 case SAVEt_AV: /* array reference */
9749 av = (AV*)POPPTR(ss,ix);
9750 TOPPTR(nss,ix) = av_dup_inc(av, param);
9751 gv = (GV*)POPPTR(ss,ix);
9752 TOPPTR(nss,ix) = gv_dup(gv, param);
9754 case SAVEt_HV: /* hash reference */
9755 hv = (HV*)POPPTR(ss,ix);
9756 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9757 gv = (GV*)POPPTR(ss,ix);
9758 TOPPTR(nss,ix) = gv_dup(gv, param);
9760 case SAVEt_INT: /* int reference */
9761 ptr = POPPTR(ss,ix);
9762 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9763 intval = (int)POPINT(ss,ix);
9764 TOPINT(nss,ix) = intval;
9766 case SAVEt_LONG: /* long reference */
9767 ptr = POPPTR(ss,ix);
9768 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9769 longval = (long)POPLONG(ss,ix);
9770 TOPLONG(nss,ix) = longval;
9772 case SAVEt_I32: /* I32 reference */
9773 case SAVEt_I16: /* I16 reference */
9774 case SAVEt_I8: /* I8 reference */
9775 ptr = POPPTR(ss,ix);
9776 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9780 case SAVEt_IV: /* IV reference */
9781 ptr = POPPTR(ss,ix);
9782 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9786 case SAVEt_SPTR: /* SV* reference */
9787 ptr = POPPTR(ss,ix);
9788 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9789 sv = (SV*)POPPTR(ss,ix);
9790 TOPPTR(nss,ix) = sv_dup(sv, param);
9792 case SAVEt_VPTR: /* random* reference */
9793 ptr = POPPTR(ss,ix);
9794 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9795 ptr = POPPTR(ss,ix);
9796 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 case SAVEt_PPTR: /* char* reference */
9799 ptr = POPPTR(ss,ix);
9800 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9801 c = (char*)POPPTR(ss,ix);
9802 TOPPTR(nss,ix) = pv_dup(c);
9804 case SAVEt_HPTR: /* HV* reference */
9805 ptr = POPPTR(ss,ix);
9806 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9807 hv = (HV*)POPPTR(ss,ix);
9808 TOPPTR(nss,ix) = hv_dup(hv, param);
9810 case SAVEt_APTR: /* AV* reference */
9811 ptr = POPPTR(ss,ix);
9812 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9813 av = (AV*)POPPTR(ss,ix);
9814 TOPPTR(nss,ix) = av_dup(av, param);
9817 gv = (GV*)POPPTR(ss,ix);
9818 TOPPTR(nss,ix) = gv_dup(gv, param);
9820 case SAVEt_GP: /* scalar reference */
9821 gp = (GP*)POPPTR(ss,ix);
9822 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9823 (void)GpREFCNT_inc(gp);
9824 gv = (GV*)POPPTR(ss,ix);
9825 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9826 c = (char*)POPPTR(ss,ix);
9827 TOPPTR(nss,ix) = pv_dup(c);
9834 case SAVEt_MORTALIZESV:
9835 sv = (SV*)POPPTR(ss,ix);
9836 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9839 ptr = POPPTR(ss,ix);
9840 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9841 /* these are assumed to be refcounted properly */
9843 switch (((OP*)ptr)->op_type) {
9850 TOPPTR(nss,ix) = ptr;
9855 TOPPTR(nss,ix) = Nullop;
9860 TOPPTR(nss,ix) = Nullop;
9863 c = (char*)POPPTR(ss,ix);
9864 TOPPTR(nss,ix) = pv_dup_inc(c);
9867 longval = POPLONG(ss,ix);
9868 TOPLONG(nss,ix) = longval;
9871 hv = (HV*)POPPTR(ss,ix);
9872 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9873 c = (char*)POPPTR(ss,ix);
9874 TOPPTR(nss,ix) = pv_dup_inc(c);
9878 case SAVEt_DESTRUCTOR:
9879 ptr = POPPTR(ss,ix);
9880 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9881 dptr = POPDPTR(ss,ix);
9882 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9883 any_dup(FPTR2DPTR(void *, dptr),
9886 case SAVEt_DESTRUCTOR_X:
9887 ptr = POPPTR(ss,ix);
9888 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9889 dxptr = POPDXPTR(ss,ix);
9890 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9891 any_dup(FPTR2DPTR(void *, dxptr),
9894 case SAVEt_REGCONTEXT:
9900 case SAVEt_STACK_POS: /* Position on Perl stack */
9904 case SAVEt_AELEM: /* array element */
9905 sv = (SV*)POPPTR(ss,ix);
9906 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9909 av = (AV*)POPPTR(ss,ix);
9910 TOPPTR(nss,ix) = av_dup_inc(av, param);
9912 case SAVEt_HELEM: /* hash element */
9913 sv = (SV*)POPPTR(ss,ix);
9914 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9915 sv = (SV*)POPPTR(ss,ix);
9916 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9917 hv = (HV*)POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9921 ptr = POPPTR(ss,ix);
9922 TOPPTR(nss,ix) = ptr;
9929 av = (AV*)POPPTR(ss,ix);
9930 TOPPTR(nss,ix) = av_dup(av, param);
9933 longval = (long)POPLONG(ss,ix);
9934 TOPLONG(nss,ix) = longval;
9935 ptr = POPPTR(ss,ix);
9936 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9937 sv = (SV*)POPPTR(ss,ix);
9938 TOPPTR(nss,ix) = sv_dup(sv, param);
9941 ptr = POPPTR(ss,ix);
9942 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9943 longval = (long)POPBOOL(ss,ix);
9944 TOPBOOL(nss,ix) = (bool)longval;
9946 case SAVEt_SET_SVFLAGS:
9951 sv = (SV*)POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = sv_dup(sv, param);
9955 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9963 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9964 * flag to the result. This is done for each stash before cloning starts,
9965 * so we know which stashes want their objects cloned */
9968 do_mark_cloneable_stash(pTHX_ SV *sv)
9970 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9972 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9973 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9974 if (cloner && GvCV(cloner)) {
9981 XPUSHs(sv_2mortal(newSVhek(hvname)));
9983 call_sv((SV*)GvCV(cloner), G_SCALAR);
9990 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
9998 =for apidoc perl_clone
10000 Create and return a new interpreter by cloning the current one.
10002 perl_clone takes these flags as parameters:
10004 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10005 without it we only clone the data and zero the stacks,
10006 with it we copy the stacks and the new perl interpreter is
10007 ready to run at the exact same point as the previous one.
10008 The pseudo-fork code uses COPY_STACKS while the
10009 threads->new doesn't.
10011 CLONEf_KEEP_PTR_TABLE
10012 perl_clone keeps a ptr_table with the pointer of the old
10013 variable as a key and the new variable as a value,
10014 this allows it to check if something has been cloned and not
10015 clone it again but rather just use the value and increase the
10016 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10017 the ptr_table using the function
10018 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10019 reason to keep it around is if you want to dup some of your own
10020 variable who are outside the graph perl scans, example of this
10021 code is in threads.xs create
10024 This is a win32 thing, it is ignored on unix, it tells perls
10025 win32host code (which is c++) to clone itself, this is needed on
10026 win32 if you want to run two threads at the same time,
10027 if you just want to do some stuff in a separate perl interpreter
10028 and then throw it away and return to the original one,
10029 you don't need to do anything.
10034 /* XXX the above needs expanding by someone who actually understands it ! */
10035 EXTERN_C PerlInterpreter *
10036 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10039 perl_clone(PerlInterpreter *proto_perl, UV flags)
10042 #ifdef PERL_IMPLICIT_SYS
10044 /* perlhost.h so we need to call into it
10045 to clone the host, CPerlHost should have a c interface, sky */
10047 if (flags & CLONEf_CLONE_HOST) {
10048 return perl_clone_host(proto_perl,flags);
10050 return perl_clone_using(proto_perl, flags,
10052 proto_perl->IMemShared,
10053 proto_perl->IMemParse,
10055 proto_perl->IStdIO,
10059 proto_perl->IProc);
10063 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10064 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10065 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10066 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10067 struct IPerlDir* ipD, struct IPerlSock* ipS,
10068 struct IPerlProc* ipP)
10070 /* XXX many of the string copies here can be optimized if they're
10071 * constants; they need to be allocated as common memory and just
10072 * their pointers copied. */
10075 CLONE_PARAMS clone_params;
10076 CLONE_PARAMS* param = &clone_params;
10078 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10079 /* for each stash, determine whether its objects should be cloned */
10080 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10081 PERL_SET_THX(my_perl);
10084 Poison(my_perl, 1, PerlInterpreter);
10086 PL_curcop = (COP *)Nullop;
10090 PL_savestack_ix = 0;
10091 PL_savestack_max = -1;
10092 PL_sig_pending = 0;
10093 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10094 # else /* !DEBUGGING */
10095 Zero(my_perl, 1, PerlInterpreter);
10096 # endif /* DEBUGGING */
10098 /* host pointers */
10100 PL_MemShared = ipMS;
10101 PL_MemParse = ipMP;
10108 #else /* !PERL_IMPLICIT_SYS */
10110 CLONE_PARAMS clone_params;
10111 CLONE_PARAMS* param = &clone_params;
10112 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10113 /* for each stash, determine whether its objects should be cloned */
10114 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10115 PERL_SET_THX(my_perl);
10118 Poison(my_perl, 1, PerlInterpreter);
10120 PL_curcop = (COP *)Nullop;
10124 PL_savestack_ix = 0;
10125 PL_savestack_max = -1;
10126 PL_sig_pending = 0;
10127 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10128 # else /* !DEBUGGING */
10129 Zero(my_perl, 1, PerlInterpreter);
10130 # endif /* DEBUGGING */
10131 #endif /* PERL_IMPLICIT_SYS */
10132 param->flags = flags;
10133 param->proto_perl = proto_perl;
10135 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10136 Zero(&PL_body_roots, 1, PL_body_roots);
10138 PL_nice_chunk = NULL;
10139 PL_nice_chunk_size = 0;
10141 PL_sv_objcount = 0;
10142 PL_sv_root = Nullsv;
10143 PL_sv_arenaroot = Nullsv;
10145 PL_debug = proto_perl->Idebug;
10147 PL_hash_seed = proto_perl->Ihash_seed;
10148 PL_rehash_seed = proto_perl->Irehash_seed;
10150 #ifdef USE_REENTRANT_API
10151 /* XXX: things like -Dm will segfault here in perlio, but doing
10152 * PERL_SET_CONTEXT(proto_perl);
10153 * breaks too many other things
10155 Perl_reentrant_init(aTHX);
10158 /* create SV map for pointer relocation */
10159 PL_ptr_table = ptr_table_new();
10161 /* initialize these special pointers as early as possible */
10162 SvANY(&PL_sv_undef) = NULL;
10163 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10164 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10165 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10167 SvANY(&PL_sv_no) = new_XPVNV();
10168 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10169 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10170 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10171 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10172 SvCUR_set(&PL_sv_no, 0);
10173 SvLEN_set(&PL_sv_no, 1);
10174 SvIV_set(&PL_sv_no, 0);
10175 SvNV_set(&PL_sv_no, 0);
10176 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10178 SvANY(&PL_sv_yes) = new_XPVNV();
10179 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10180 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10181 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10182 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10183 SvCUR_set(&PL_sv_yes, 1);
10184 SvLEN_set(&PL_sv_yes, 2);
10185 SvIV_set(&PL_sv_yes, 1);
10186 SvNV_set(&PL_sv_yes, 1);
10187 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10189 /* create (a non-shared!) shared string table */
10190 PL_strtab = newHV();
10191 HvSHAREKEYS_off(PL_strtab);
10192 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10193 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10195 PL_compiling = proto_perl->Icompiling;
10197 /* These two PVs will be free'd special way so must set them same way op.c does */
10198 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10199 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10201 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10202 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10204 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10205 if (!specialWARN(PL_compiling.cop_warnings))
10206 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10207 if (!specialCopIO(PL_compiling.cop_io))
10208 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10209 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10211 /* pseudo environmental stuff */
10212 PL_origargc = proto_perl->Iorigargc;
10213 PL_origargv = proto_perl->Iorigargv;
10215 param->stashes = newAV(); /* Setup array of objects to call clone on */
10217 /* Set tainting stuff before PerlIO_debug can possibly get called */
10218 PL_tainting = proto_perl->Itainting;
10219 PL_taint_warn = proto_perl->Itaint_warn;
10221 #ifdef PERLIO_LAYERS
10222 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10223 PerlIO_clone(aTHX_ proto_perl, param);
10226 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10227 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10228 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10229 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10230 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10231 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10234 PL_minus_c = proto_perl->Iminus_c;
10235 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10236 PL_localpatches = proto_perl->Ilocalpatches;
10237 PL_splitstr = proto_perl->Isplitstr;
10238 PL_preprocess = proto_perl->Ipreprocess;
10239 PL_minus_n = proto_perl->Iminus_n;
10240 PL_minus_p = proto_perl->Iminus_p;
10241 PL_minus_l = proto_perl->Iminus_l;
10242 PL_minus_a = proto_perl->Iminus_a;
10243 PL_minus_F = proto_perl->Iminus_F;
10244 PL_doswitches = proto_perl->Idoswitches;
10245 PL_dowarn = proto_perl->Idowarn;
10246 PL_doextract = proto_perl->Idoextract;
10247 PL_sawampersand = proto_perl->Isawampersand;
10248 PL_unsafe = proto_perl->Iunsafe;
10249 PL_inplace = SAVEPV(proto_perl->Iinplace);
10250 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10251 PL_perldb = proto_perl->Iperldb;
10252 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10253 PL_exit_flags = proto_perl->Iexit_flags;
10255 /* magical thingies */
10256 /* XXX time(&PL_basetime) when asked for? */
10257 PL_basetime = proto_perl->Ibasetime;
10258 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10260 PL_maxsysfd = proto_perl->Imaxsysfd;
10261 PL_multiline = proto_perl->Imultiline;
10262 PL_statusvalue = proto_perl->Istatusvalue;
10264 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10266 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10268 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10270 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10271 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10272 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10274 /* Clone the regex array */
10275 PL_regex_padav = newAV();
10277 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10278 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10280 av_push(PL_regex_padav,
10281 sv_dup_inc(regexen[0],param));
10282 for(i = 1; i <= len; i++) {
10283 if(SvREPADTMP(regexen[i])) {
10284 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10286 av_push(PL_regex_padav,
10288 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10289 SvIVX(regexen[i])), param)))
10294 PL_regex_pad = AvARRAY(PL_regex_padav);
10296 /* shortcuts to various I/O objects */
10297 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10298 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10299 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10300 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10301 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10302 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10304 /* shortcuts to regexp stuff */
10305 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10307 /* shortcuts to misc objects */
10308 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10310 /* shortcuts to debugging objects */
10311 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10312 PL_DBline = gv_dup(proto_perl->IDBline, param);
10313 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10314 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10315 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10316 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10317 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10318 PL_lineary = av_dup(proto_perl->Ilineary, param);
10319 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10321 /* symbol tables */
10322 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10323 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10324 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10325 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10326 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10328 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10329 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10330 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10331 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10332 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10333 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10335 PL_sub_generation = proto_perl->Isub_generation;
10337 /* funky return mechanisms */
10338 PL_forkprocess = proto_perl->Iforkprocess;
10340 /* subprocess state */
10341 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10343 /* internal state */
10344 PL_maxo = proto_perl->Imaxo;
10345 if (proto_perl->Iop_mask)
10346 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10348 PL_op_mask = Nullch;
10349 /* PL_asserting = proto_perl->Iasserting; */
10351 /* current interpreter roots */
10352 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10353 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10354 PL_main_start = proto_perl->Imain_start;
10355 PL_eval_root = proto_perl->Ieval_root;
10356 PL_eval_start = proto_perl->Ieval_start;
10358 /* runtime control stuff */
10359 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10360 PL_copline = proto_perl->Icopline;
10362 PL_filemode = proto_perl->Ifilemode;
10363 PL_lastfd = proto_perl->Ilastfd;
10364 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10367 PL_gensym = proto_perl->Igensym;
10368 PL_preambled = proto_perl->Ipreambled;
10369 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10370 PL_laststatval = proto_perl->Ilaststatval;
10371 PL_laststype = proto_perl->Ilaststype;
10372 PL_mess_sv = Nullsv;
10374 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10376 /* interpreter atexit processing */
10377 PL_exitlistlen = proto_perl->Iexitlistlen;
10378 if (PL_exitlistlen) {
10379 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10380 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10383 PL_exitlist = (PerlExitListEntry*)NULL;
10384 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10385 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10386 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10388 PL_profiledata = NULL;
10389 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10390 /* PL_rsfp_filters entries have fake IoDIRP() */
10391 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10393 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10395 PAD_CLONE_VARS(proto_perl, param);
10397 #ifdef HAVE_INTERP_INTERN
10398 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10401 /* more statics moved here */
10402 PL_generation = proto_perl->Igeneration;
10403 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10405 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10406 PL_in_clean_all = proto_perl->Iin_clean_all;
10408 PL_uid = proto_perl->Iuid;
10409 PL_euid = proto_perl->Ieuid;
10410 PL_gid = proto_perl->Igid;
10411 PL_egid = proto_perl->Iegid;
10412 PL_nomemok = proto_perl->Inomemok;
10413 PL_an = proto_perl->Ian;
10414 PL_evalseq = proto_perl->Ievalseq;
10415 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10416 PL_origalen = proto_perl->Iorigalen;
10417 #ifdef PERL_USES_PL_PIDSTATUS
10418 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10420 PL_osname = SAVEPV(proto_perl->Iosname);
10421 PL_sighandlerp = proto_perl->Isighandlerp;
10423 PL_runops = proto_perl->Irunops;
10425 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10428 PL_cshlen = proto_perl->Icshlen;
10429 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10432 PL_lex_state = proto_perl->Ilex_state;
10433 PL_lex_defer = proto_perl->Ilex_defer;
10434 PL_lex_expect = proto_perl->Ilex_expect;
10435 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10436 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10437 PL_lex_starts = proto_perl->Ilex_starts;
10438 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10439 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10440 PL_lex_op = proto_perl->Ilex_op;
10441 PL_lex_inpat = proto_perl->Ilex_inpat;
10442 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10443 PL_lex_brackets = proto_perl->Ilex_brackets;
10444 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10445 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10446 PL_lex_casemods = proto_perl->Ilex_casemods;
10447 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10448 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10450 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10451 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10452 PL_nexttoke = proto_perl->Inexttoke;
10454 /* XXX This is probably masking the deeper issue of why
10455 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10456 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10457 * (A little debugging with a watchpoint on it may help.)
10459 if (SvANY(proto_perl->Ilinestr)) {
10460 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10461 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10462 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10463 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10464 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10465 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10466 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10467 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10468 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10471 PL_linestr = NEWSV(65,79);
10472 sv_upgrade(PL_linestr,SVt_PVIV);
10473 sv_setpvn(PL_linestr,"",0);
10474 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10476 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10477 PL_pending_ident = proto_perl->Ipending_ident;
10478 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10480 PL_expect = proto_perl->Iexpect;
10482 PL_multi_start = proto_perl->Imulti_start;
10483 PL_multi_end = proto_perl->Imulti_end;
10484 PL_multi_open = proto_perl->Imulti_open;
10485 PL_multi_close = proto_perl->Imulti_close;
10487 PL_error_count = proto_perl->Ierror_count;
10488 PL_subline = proto_perl->Isubline;
10489 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10491 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10492 if (SvANY(proto_perl->Ilinestr)) {
10493 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10494 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10495 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10496 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10497 PL_last_lop_op = proto_perl->Ilast_lop_op;
10500 PL_last_uni = SvPVX(PL_linestr);
10501 PL_last_lop = SvPVX(PL_linestr);
10502 PL_last_lop_op = 0;
10504 PL_in_my = proto_perl->Iin_my;
10505 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10507 PL_cryptseen = proto_perl->Icryptseen;
10510 PL_hints = proto_perl->Ihints;
10512 PL_amagic_generation = proto_perl->Iamagic_generation;
10514 #ifdef USE_LOCALE_COLLATE
10515 PL_collation_ix = proto_perl->Icollation_ix;
10516 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10517 PL_collation_standard = proto_perl->Icollation_standard;
10518 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10519 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10520 #endif /* USE_LOCALE_COLLATE */
10522 #ifdef USE_LOCALE_NUMERIC
10523 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10524 PL_numeric_standard = proto_perl->Inumeric_standard;
10525 PL_numeric_local = proto_perl->Inumeric_local;
10526 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10527 #endif /* !USE_LOCALE_NUMERIC */
10529 /* utf8 character classes */
10530 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10531 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10532 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10533 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10534 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10535 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10536 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10537 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10538 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10539 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10540 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10541 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10542 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10543 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10544 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10545 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10546 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10547 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10548 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10549 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10551 /* Did the locale setup indicate UTF-8? */
10552 PL_utf8locale = proto_perl->Iutf8locale;
10553 /* Unicode features (see perlrun/-C) */
10554 PL_unicode = proto_perl->Iunicode;
10556 /* Pre-5.8 signals control */
10557 PL_signals = proto_perl->Isignals;
10559 /* times() ticks per second */
10560 PL_clocktick = proto_perl->Iclocktick;
10562 /* Recursion stopper for PerlIO_find_layer */
10563 PL_in_load_module = proto_perl->Iin_load_module;
10565 /* sort() routine */
10566 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10568 /* Not really needed/useful since the reenrant_retint is "volatile",
10569 * but do it for consistency's sake. */
10570 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10572 /* Hooks to shared SVs and locks. */
10573 PL_sharehook = proto_perl->Isharehook;
10574 PL_lockhook = proto_perl->Ilockhook;
10575 PL_unlockhook = proto_perl->Iunlockhook;
10576 PL_threadhook = proto_perl->Ithreadhook;
10578 PL_runops_std = proto_perl->Irunops_std;
10579 PL_runops_dbg = proto_perl->Irunops_dbg;
10581 #ifdef THREADS_HAVE_PIDS
10582 PL_ppid = proto_perl->Ippid;
10586 PL_last_swash_hv = Nullhv; /* reinits on demand */
10587 PL_last_swash_klen = 0;
10588 PL_last_swash_key[0]= '\0';
10589 PL_last_swash_tmps = (U8*)NULL;
10590 PL_last_swash_slen = 0;
10592 PL_glob_index = proto_perl->Iglob_index;
10593 PL_srand_called = proto_perl->Isrand_called;
10594 PL_uudmap['M'] = 0; /* reinits on demand */
10595 PL_bitcount = Nullch; /* reinits on demand */
10597 if (proto_perl->Ipsig_pend) {
10598 Newxz(PL_psig_pend, SIG_SIZE, int);
10601 PL_psig_pend = (int*)NULL;
10604 if (proto_perl->Ipsig_ptr) {
10605 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10606 Newxz(PL_psig_name, SIG_SIZE, SV*);
10607 for (i = 1; i < SIG_SIZE; i++) {
10608 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10609 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10613 PL_psig_ptr = (SV**)NULL;
10614 PL_psig_name = (SV**)NULL;
10617 /* thrdvar.h stuff */
10619 if (flags & CLONEf_COPY_STACKS) {
10620 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10621 PL_tmps_ix = proto_perl->Ttmps_ix;
10622 PL_tmps_max = proto_perl->Ttmps_max;
10623 PL_tmps_floor = proto_perl->Ttmps_floor;
10624 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10626 while (i <= PL_tmps_ix) {
10627 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10631 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10632 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10633 Newxz(PL_markstack, i, I32);
10634 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10635 - proto_perl->Tmarkstack);
10636 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10637 - proto_perl->Tmarkstack);
10638 Copy(proto_perl->Tmarkstack, PL_markstack,
10639 PL_markstack_ptr - PL_markstack + 1, I32);
10641 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10642 * NOTE: unlike the others! */
10643 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10644 PL_scopestack_max = proto_perl->Tscopestack_max;
10645 Newxz(PL_scopestack, PL_scopestack_max, I32);
10646 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10648 /* NOTE: si_dup() looks at PL_markstack */
10649 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10651 /* PL_curstack = PL_curstackinfo->si_stack; */
10652 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10653 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10655 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10656 PL_stack_base = AvARRAY(PL_curstack);
10657 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10658 - proto_perl->Tstack_base);
10659 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10661 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10662 * NOTE: unlike the others! */
10663 PL_savestack_ix = proto_perl->Tsavestack_ix;
10664 PL_savestack_max = proto_perl->Tsavestack_max;
10665 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10666 PL_savestack = ss_dup(proto_perl, param);
10670 ENTER; /* perl_destruct() wants to LEAVE; */
10673 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10674 PL_top_env = &PL_start_env;
10676 PL_op = proto_perl->Top;
10679 PL_Xpv = (XPV*)NULL;
10680 PL_na = proto_perl->Tna;
10682 PL_statbuf = proto_perl->Tstatbuf;
10683 PL_statcache = proto_perl->Tstatcache;
10684 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10685 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10687 PL_timesbuf = proto_perl->Ttimesbuf;
10690 PL_tainted = proto_perl->Ttainted;
10691 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10692 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10693 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10694 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10695 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10696 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10697 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10698 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10699 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10701 PL_restartop = proto_perl->Trestartop;
10702 PL_in_eval = proto_perl->Tin_eval;
10703 PL_delaymagic = proto_perl->Tdelaymagic;
10704 PL_dirty = proto_perl->Tdirty;
10705 PL_localizing = proto_perl->Tlocalizing;
10707 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10708 PL_hv_fetch_ent_mh = Nullhe;
10709 PL_modcount = proto_perl->Tmodcount;
10710 PL_lastgotoprobe = Nullop;
10711 PL_dumpindent = proto_perl->Tdumpindent;
10713 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10714 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10715 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10716 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10717 PL_efloatbuf = Nullch; /* reinits on demand */
10718 PL_efloatsize = 0; /* reinits on demand */
10722 PL_screamfirst = NULL;
10723 PL_screamnext = NULL;
10724 PL_maxscream = -1; /* reinits on demand */
10725 PL_lastscream = Nullsv;
10727 PL_watchaddr = NULL;
10728 PL_watchok = Nullch;
10730 PL_regdummy = proto_perl->Tregdummy;
10731 PL_regprecomp = Nullch;
10734 PL_colorset = 0; /* reinits PL_colors[] */
10735 /*PL_colors[6] = {0,0,0,0,0,0};*/
10736 PL_reginput = Nullch;
10737 PL_regbol = Nullch;
10738 PL_regeol = Nullch;
10739 PL_regstartp = (I32*)NULL;
10740 PL_regendp = (I32*)NULL;
10741 PL_reglastparen = (U32*)NULL;
10742 PL_reglastcloseparen = (U32*)NULL;
10743 PL_regtill = Nullch;
10744 PL_reg_start_tmp = (char**)NULL;
10745 PL_reg_start_tmpl = 0;
10746 PL_regdata = (struct reg_data*)NULL;
10749 PL_reg_eval_set = 0;
10751 PL_regprogram = (regnode*)NULL;
10753 PL_regcc = (CURCUR*)NULL;
10754 PL_reg_call_cc = (struct re_cc_state*)NULL;
10755 PL_reg_re = (regexp*)NULL;
10756 PL_reg_ganch = Nullch;
10757 PL_reg_sv = Nullsv;
10758 PL_reg_match_utf8 = FALSE;
10759 PL_reg_magic = (MAGIC*)NULL;
10761 PL_reg_oldcurpm = (PMOP*)NULL;
10762 PL_reg_curpm = (PMOP*)NULL;
10763 PL_reg_oldsaved = Nullch;
10764 PL_reg_oldsavedlen = 0;
10765 #ifdef PERL_OLD_COPY_ON_WRITE
10768 PL_reg_maxiter = 0;
10769 PL_reg_leftiter = 0;
10770 PL_reg_poscache = Nullch;
10771 PL_reg_poscache_size= 0;
10773 /* RE engine - function pointers */
10774 PL_regcompp = proto_perl->Tregcompp;
10775 PL_regexecp = proto_perl->Tregexecp;
10776 PL_regint_start = proto_perl->Tregint_start;
10777 PL_regint_string = proto_perl->Tregint_string;
10778 PL_regfree = proto_perl->Tregfree;
10780 PL_reginterp_cnt = 0;
10781 PL_reg_starttry = 0;
10783 /* Pluggable optimizer */
10784 PL_peepp = proto_perl->Tpeepp;
10786 PL_stashcache = newHV();
10788 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10789 ptr_table_free(PL_ptr_table);
10790 PL_ptr_table = NULL;
10793 /* Call the ->CLONE method, if it exists, for each of the stashes
10794 identified by sv_dup() above.
10796 while(av_len(param->stashes) != -1) {
10797 HV* const stash = (HV*) av_shift(param->stashes);
10798 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10799 if (cloner && GvCV(cloner)) {
10804 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10806 call_sv((SV*)GvCV(cloner), G_DISCARD);
10812 SvREFCNT_dec(param->stashes);
10814 /* orphaned? eg threads->new inside BEGIN or use */
10815 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10816 (void)SvREFCNT_inc(PL_compcv);
10817 SAVEFREESV(PL_compcv);
10823 #endif /* USE_ITHREADS */
10826 =head1 Unicode Support
10828 =for apidoc sv_recode_to_utf8
10830 The encoding is assumed to be an Encode object, on entry the PV
10831 of the sv is assumed to be octets in that encoding, and the sv
10832 will be converted into Unicode (and UTF-8).
10834 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10835 is not a reference, nothing is done to the sv. If the encoding is not
10836 an C<Encode::XS> Encoding object, bad things will happen.
10837 (See F<lib/encoding.pm> and L<Encode>).
10839 The PV of the sv is returned.
10844 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10847 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10861 Passing sv_yes is wrong - it needs to be or'ed set of constants
10862 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10863 remove converted chars from source.
10865 Both will default the value - let them.
10867 XPUSHs(&PL_sv_yes);
10870 call_method("decode", G_SCALAR);
10874 s = SvPV_const(uni, len);
10875 if (s != SvPVX_const(sv)) {
10876 SvGROW(sv, len + 1);
10877 Move(s, SvPVX(sv), len + 1, char);
10878 SvCUR_set(sv, len);
10885 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10889 =for apidoc sv_cat_decode
10891 The encoding is assumed to be an Encode object, the PV of the ssv is
10892 assumed to be octets in that encoding and decoding the input starts
10893 from the position which (PV + *offset) pointed to. The dsv will be
10894 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10895 when the string tstr appears in decoding output or the input ends on
10896 the PV of the ssv. The value which the offset points will be modified
10897 to the last input position on the ssv.
10899 Returns TRUE if the terminator was found, else returns FALSE.
10904 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10905 SV *ssv, int *offset, char *tstr, int tlen)
10909 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10920 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10921 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10923 call_method("cat_decode", G_SCALAR);
10925 ret = SvTRUE(TOPs);
10926 *offset = SvIV(offsv);
10932 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10937 /* ---------------------------------------------------------------------
10939 * support functions for report_uninit()
10942 /* the maxiumum size of array or hash where we will scan looking
10943 * for the undefined element that triggered the warning */
10945 #define FUV_MAX_SEARCH_SIZE 1000
10947 /* Look for an entry in the hash whose value has the same SV as val;
10948 * If so, return a mortal copy of the key. */
10951 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10954 register HE **array;
10957 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10958 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10961 array = HvARRAY(hv);
10963 for (i=HvMAX(hv); i>0; i--) {
10964 register HE *entry;
10965 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10966 if (HeVAL(entry) != val)
10968 if ( HeVAL(entry) == &PL_sv_undef ||
10969 HeVAL(entry) == &PL_sv_placeholder)
10973 if (HeKLEN(entry) == HEf_SVKEY)
10974 return sv_mortalcopy(HeKEY_sv(entry));
10975 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10981 /* Look for an entry in the array whose value has the same SV as val;
10982 * If so, return the index, otherwise return -1. */
10985 S_find_array_subscript(pTHX_ AV *av, SV* val)
10989 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10990 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10994 for (i=AvFILLp(av); i>=0; i--) {
10995 if (svp[i] == val && svp[i] != &PL_sv_undef)
11001 /* S_varname(): return the name of a variable, optionally with a subscript.
11002 * If gv is non-zero, use the name of that global, along with gvtype (one
11003 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11004 * targ. Depending on the value of the subscript_type flag, return:
11007 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11008 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11009 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11010 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11013 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11014 SV* keyname, I32 aindex, int subscript_type)
11017 SV * const name = sv_newmortal();
11020 buffer[0] = gvtype;
11023 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11025 gv_fullname4(name, gv, buffer, 0);
11027 if ((unsigned int)SvPVX(name)[1] <= 26) {
11029 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11031 /* Swap the 1 unprintable control character for the 2 byte pretty
11032 version - ie substr($name, 1, 1) = $buffer; */
11033 sv_insert(name, 1, 1, buffer, 2);
11038 CV * const cv = find_runcv(&unused);
11042 if (!cv || !CvPADLIST(cv))
11044 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11045 sv = *av_fetch(av, targ, FALSE);
11046 /* SvLEN in a pad name is not to be trusted */
11047 sv_setpv(name, SvPV_nolen_const(sv));
11050 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11051 SV * const sv = NEWSV(0,0);
11052 *SvPVX(name) = '$';
11053 Perl_sv_catpvf(aTHX_ name, "{%s}",
11054 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11057 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11058 *SvPVX(name) = '$';
11059 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11061 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11062 sv_insert(name, 0, 0, "within ", 7);
11069 =for apidoc find_uninit_var
11071 Find the name of the undefined variable (if any) that caused the operator o
11072 to issue a "Use of uninitialized value" warning.
11073 If match is true, only return a name if it's value matches uninit_sv.
11074 So roughly speaking, if a unary operator (such as OP_COS) generates a
11075 warning, then following the direct child of the op may yield an
11076 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11077 other hand, with OP_ADD there are two branches to follow, so we only print
11078 the variable name if we get an exact match.
11080 The name is returned as a mortal SV.
11082 Assumes that PL_op is the op that originally triggered the error, and that
11083 PL_comppad/PL_curpad points to the currently executing pad.
11089 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11097 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11098 uninit_sv == &PL_sv_placeholder)))
11101 switch (obase->op_type) {
11108 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11109 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11111 SV *keysv = Nullsv;
11112 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11114 if (pad) { /* @lex, %lex */
11115 sv = PAD_SVl(obase->op_targ);
11119 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11120 /* @global, %global */
11121 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11124 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11126 else /* @{expr}, %{expr} */
11127 return find_uninit_var(cUNOPx(obase)->op_first,
11131 /* attempt to find a match within the aggregate */
11133 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11135 subscript_type = FUV_SUBSCRIPT_HASH;
11138 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11140 subscript_type = FUV_SUBSCRIPT_ARRAY;
11143 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11146 return varname(gv, hash ? '%' : '@', obase->op_targ,
11147 keysv, index, subscript_type);
11151 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11153 return varname(Nullgv, '$', obase->op_targ,
11154 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11157 gv = cGVOPx_gv(obase);
11158 if (!gv || (match && GvSV(gv) != uninit_sv))
11160 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11163 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11166 av = (AV*)PAD_SV(obase->op_targ);
11167 if (!av || SvRMAGICAL(av))
11169 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11170 if (!svp || *svp != uninit_sv)
11173 return varname(Nullgv, '$', obase->op_targ,
11174 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11177 gv = cGVOPx_gv(obase);
11183 if (!av || SvRMAGICAL(av))
11185 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11186 if (!svp || *svp != uninit_sv)
11189 return varname(gv, '$', 0,
11190 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11195 o = cUNOPx(obase)->op_first;
11196 if (!o || o->op_type != OP_NULL ||
11197 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11199 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11203 if (PL_op == obase)
11204 /* $a[uninit_expr] or $h{uninit_expr} */
11205 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11208 o = cBINOPx(obase)->op_first;
11209 kid = cBINOPx(obase)->op_last;
11211 /* get the av or hv, and optionally the gv */
11213 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11214 sv = PAD_SV(o->op_targ);
11216 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11217 && cUNOPo->op_first->op_type == OP_GV)
11219 gv = cGVOPx_gv(cUNOPo->op_first);
11222 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11227 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11228 /* index is constant */
11232 if (obase->op_type == OP_HELEM) {
11233 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11234 if (!he || HeVAL(he) != uninit_sv)
11238 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11239 if (!svp || *svp != uninit_sv)
11243 if (obase->op_type == OP_HELEM)
11244 return varname(gv, '%', o->op_targ,
11245 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11247 return varname(gv, '@', o->op_targ, Nullsv,
11248 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11251 /* index is an expression;
11252 * attempt to find a match within the aggregate */
11253 if (obase->op_type == OP_HELEM) {
11254 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11256 return varname(gv, '%', o->op_targ,
11257 keysv, 0, FUV_SUBSCRIPT_HASH);
11260 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11262 return varname(gv, '@', o->op_targ,
11263 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11268 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11270 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11276 /* only examine RHS */
11277 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11280 o = cUNOPx(obase)->op_first;
11281 if (o->op_type == OP_PUSHMARK)
11284 if (!o->op_sibling) {
11285 /* one-arg version of open is highly magical */
11287 if (o->op_type == OP_GV) { /* open FOO; */
11289 if (match && GvSV(gv) != uninit_sv)
11291 return varname(gv, '$', 0,
11292 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11294 /* other possibilities not handled are:
11295 * open $x; or open my $x; should return '${*$x}'
11296 * open expr; should return '$'.expr ideally
11302 /* ops where $_ may be an implicit arg */
11306 if ( !(obase->op_flags & OPf_STACKED)) {
11307 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11308 ? PAD_SVl(obase->op_targ)
11311 sv = sv_newmortal();
11312 sv_setpvn(sv, "$_", 2);
11320 /* skip filehandle as it can't produce 'undef' warning */
11321 o = cUNOPx(obase)->op_first;
11322 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11323 o = o->op_sibling->op_sibling;
11330 match = 1; /* XS or custom code could trigger random warnings */
11335 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11336 return sv_2mortal(newSVpvn("${$/}", 5));
11341 if (!(obase->op_flags & OPf_KIDS))
11343 o = cUNOPx(obase)->op_first;
11349 /* if all except one arg are constant, or have no side-effects,
11350 * or are optimized away, then it's unambiguous */
11352 for (kid=o; kid; kid = kid->op_sibling) {
11354 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11355 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11356 || (kid->op_type == OP_PUSHMARK)
11360 if (o2) { /* more than one found */
11367 return find_uninit_var(o2, uninit_sv, match);
11369 /* scan all args */
11371 sv = find_uninit_var(o, uninit_sv, 1);
11383 =for apidoc report_uninit
11385 Print appropriate "Use of uninitialized variable" warning
11391 Perl_report_uninit(pTHX_ SV* uninit_sv)
11394 SV* varname = Nullsv;
11396 varname = find_uninit_var(PL_op, uninit_sv,0);
11398 sv_insert(varname, 0, 0, " ", 1);
11400 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11401 varname ? SvPV_nolen_const(varname) : "",
11402 " in ", OP_DESC(PL_op));
11405 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11411 * c-indentation-style: bsd
11412 * c-basic-offset: 4
11413 * indent-tabs-mode: t
11416 * ex: set ts=8 sts=4 sw=4 noet: