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);
2059 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2060 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2065 /* Else this will drop through into the SvROK case just below, which
2066 will return within the {} for all code paths. */
2068 if (SvTHINKFIRST(sv)) {
2071 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2072 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2073 return SvNV(tmpstr);
2074 return PTR2NV(SvRV(sv));
2077 sv_force_normal_flags(sv, 0);
2079 if (SvREADONLY(sv) && !SvOK(sv)) {
2080 if (ckWARN(WARN_UNINITIALIZED))
2085 if (SvTYPE(sv) < SVt_NV) {
2086 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2087 sv_upgrade(sv, SVt_NV);
2088 #ifdef USE_LONG_DOUBLE
2090 STORE_NUMERIC_LOCAL_SET_STANDARD();
2091 PerlIO_printf(Perl_debug_log,
2092 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2093 PTR2UV(sv), SvNVX(sv));
2094 RESTORE_NUMERIC_LOCAL();
2098 STORE_NUMERIC_LOCAL_SET_STANDARD();
2099 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2100 PTR2UV(sv), SvNVX(sv));
2101 RESTORE_NUMERIC_LOCAL();
2105 else if (SvTYPE(sv) < SVt_PVNV)
2106 sv_upgrade(sv, SVt_PVNV);
2111 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2112 #ifdef NV_PRESERVES_UV
2115 /* Only set the public NV OK flag if this NV preserves the IV */
2116 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2117 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2118 : (SvIVX(sv) == I_V(SvNVX(sv))))
2124 else if (SvPOKp(sv) && SvLEN(sv)) {
2126 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2127 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2129 #ifdef NV_PRESERVES_UV
2130 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2131 == IS_NUMBER_IN_UV) {
2132 /* It's definitely an integer */
2133 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2135 SvNV_set(sv, Atof(SvPVX_const(sv)));
2138 SvNV_set(sv, Atof(SvPVX_const(sv)));
2139 /* Only set the public NV OK flag if this NV preserves the value in
2140 the PV at least as well as an IV/UV would.
2141 Not sure how to do this 100% reliably. */
2142 /* if that shift count is out of range then Configure's test is
2143 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2145 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2146 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2147 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2148 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2149 /* Can't use strtol etc to convert this string, so don't try.
2150 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2153 /* value has been set. It may not be precise. */
2154 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2155 /* 2s complement assumption for (UV)IV_MIN */
2156 SvNOK_on(sv); /* Integer is too negative. */
2161 if (numtype & IS_NUMBER_NEG) {
2162 SvIV_set(sv, -(IV)value);
2163 } else if (value <= (UV)IV_MAX) {
2164 SvIV_set(sv, (IV)value);
2166 SvUV_set(sv, value);
2170 if (numtype & IS_NUMBER_NOT_INT) {
2171 /* I believe that even if the original PV had decimals,
2172 they are lost beyond the limit of the FP precision.
2173 However, neither is canonical, so both only get p
2174 flags. NWC, 2000/11/25 */
2175 /* Both already have p flags, so do nothing */
2177 const NV nv = SvNVX(sv);
2178 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2179 if (SvIVX(sv) == I_V(nv)) {
2182 /* It had no "." so it must be integer. */
2186 /* between IV_MAX and NV(UV_MAX).
2187 Could be slightly > UV_MAX */
2189 if (numtype & IS_NUMBER_NOT_INT) {
2190 /* UV and NV both imprecise. */
2192 const UV nv_as_uv = U_V(nv);
2194 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2203 #endif /* NV_PRESERVES_UV */
2206 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2208 assert (SvTYPE(sv) >= SVt_NV);
2209 /* Typically the caller expects that sv_any is not NULL now. */
2210 /* XXX Ilya implies that this is a bug in callers that assume this
2211 and ideally should be fixed. */
2214 #if defined(USE_LONG_DOUBLE)
2216 STORE_NUMERIC_LOCAL_SET_STANDARD();
2217 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2218 PTR2UV(sv), SvNVX(sv));
2219 RESTORE_NUMERIC_LOCAL();
2223 STORE_NUMERIC_LOCAL_SET_STANDARD();
2224 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2225 PTR2UV(sv), SvNVX(sv));
2226 RESTORE_NUMERIC_LOCAL();
2232 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2233 * UV as a string towards the end of buf, and return pointers to start and
2236 * We assume that buf is at least TYPE_CHARS(UV) long.
2240 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2242 char *ptr = buf + TYPE_CHARS(UV);
2243 char * const ebuf = ptr;
2256 *--ptr = '0' + (char)(uv % 10);
2264 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2265 * a regexp to its stringified form.
2269 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2270 const regexp * const re = (regexp *)mg->mg_obj;
2273 const char *fptr = "msix";
2278 bool need_newline = 0;
2279 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2281 while((ch = *fptr++)) {
2283 reflags[left++] = ch;
2286 reflags[right--] = ch;
2291 reflags[left] = '-';
2295 mg->mg_len = re->prelen + 4 + left;
2297 * If /x was used, we have to worry about a regex ending with a
2298 * comment later being embedded within another regex. If so, we don't
2299 * want this regex's "commentization" to leak out to the right part of
2300 * the enclosing regex, we must cap it with a newline.
2302 * So, if /x was used, we scan backwards from the end of the regex. If
2303 * we find a '#' before we find a newline, we need to add a newline
2304 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2305 * we don't need to add anything. -jfriedl
2307 if (PMf_EXTENDED & re->reganch) {
2308 const char *endptr = re->precomp + re->prelen;
2309 while (endptr >= re->precomp) {
2310 const char c = *(endptr--);
2312 break; /* don't need another */
2314 /* we end while in a comment, so we need a newline */
2315 mg->mg_len++; /* save space for it */
2316 need_newline = 1; /* note to add it */
2322 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2323 mg->mg_ptr[0] = '(';
2324 mg->mg_ptr[1] = '?';
2325 Copy(reflags, mg->mg_ptr+2, left, char);
2326 *(mg->mg_ptr+left+2) = ':';
2327 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2329 mg->mg_ptr[mg->mg_len - 2] = '\n';
2330 mg->mg_ptr[mg->mg_len - 1] = ')';
2331 mg->mg_ptr[mg->mg_len] = 0;
2333 PL_reginterp_cnt += re->program[0].next_off;
2335 if (re->reganch & ROPT_UTF8)
2345 =for apidoc sv_2pv_flags
2347 Returns a pointer to the string value of an SV, and sets *lp to its length.
2348 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2350 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2351 usually end up here too.
2357 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2367 if (SvGMAGICAL(sv)) {
2368 if (flags & SV_GMAGIC)
2373 if (flags & SV_MUTABLE_RETURN)
2374 return SvPVX_mutable(sv);
2375 if (flags & SV_CONST_RETURN)
2376 return (char *)SvPVX_const(sv);
2379 if (SvIOKp(sv) || SvNOKp(sv)) {
2380 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2384 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2385 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2387 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2390 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2391 /* Sneaky stuff here */
2392 SV * const tsv = newSVpvn(tbuf, len);
2402 #ifdef FIXNEGATIVEZERO
2403 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2409 SvUPGRADE(sv, SVt_PV);
2412 s = SvGROW_mutable(sv, len + 1);
2415 return memcpy(s, tbuf, len + 1);
2419 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2420 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2427 /* Else this will drop through into the SvROK case just below, which
2428 will return within the {} for all code paths. */
2430 if (SvTHINKFIRST(sv)) {
2434 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2435 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2437 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2440 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2441 if (flags & SV_CONST_RETURN) {
2442 pv = (char *) SvPVX_const(tmpstr);
2444 pv = (flags & SV_MUTABLE_RETURN)
2445 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2448 *lp = SvCUR(tmpstr);
2450 pv = sv_2pv_flags(tmpstr, lp, flags);
2460 const SV *const referent = (SV*)SvRV(sv);
2463 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2464 } else if (SvTYPE(referent) == SVt_PVMG
2465 && ((SvFLAGS(referent) &
2466 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2467 == (SVs_OBJECT|SVs_SMG))
2468 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2469 return S_stringify_regexp(aTHX_ sv, mg, lp);
2471 const char *const typestr = sv_reftype(referent, 0);
2473 tsv = sv_newmortal();
2474 if (SvOBJECT(referent)) {
2475 const char *const name = HvNAME_get(SvSTASH(referent));
2476 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2477 name ? name : "__ANON__" , typestr,
2481 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2489 if (SvREADONLY(sv) && !SvOK(sv)) {
2490 if (ckWARN(WARN_UNINITIALIZED))
2497 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2498 /* I'm assuming that if both IV and NV are equally valid then
2499 converting the IV is going to be more efficient */
2500 const U32 isIOK = SvIOK(sv);
2501 const U32 isUIOK = SvIsUV(sv);
2502 char buf[TYPE_CHARS(UV)];
2505 if (SvTYPE(sv) < SVt_PVIV)
2506 sv_upgrade(sv, SVt_PVIV);
2508 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2510 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2511 /* inlined from sv_setpvn */
2512 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2513 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2514 SvCUR_set(sv, ebuf - ptr);
2524 else if (SvNOKp(sv)) {
2525 if (SvTYPE(sv) < SVt_PVNV)
2526 sv_upgrade(sv, SVt_PVNV);
2527 /* The +20 is pure guesswork. Configure test needed. --jhi */
2528 s = SvGROW_mutable(sv, NV_DIG + 20);
2529 olderrno = errno; /* some Xenix systems wipe out errno here */
2531 if (SvNVX(sv) == 0.0)
2532 (void)strcpy(s,"0");
2536 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2539 #ifdef FIXNEGATIVEZERO
2540 if (*s == '-' && s[1] == '0' && !s[2])
2550 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2554 if (SvTYPE(sv) < SVt_PV)
2555 /* Typically the caller expects that sv_any is not NULL now. */
2556 sv_upgrade(sv, SVt_PV);
2560 const STRLEN len = s - SvPVX_const(sv);
2566 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2567 PTR2UV(sv),SvPVX_const(sv)));
2568 if (flags & SV_CONST_RETURN)
2569 return (char *)SvPVX_const(sv);
2570 if (flags & SV_MUTABLE_RETURN)
2571 return SvPVX_mutable(sv);
2576 =for apidoc sv_copypv
2578 Copies a stringified representation of the source SV into the
2579 destination SV. Automatically performs any necessary mg_get and
2580 coercion of numeric values into strings. Guaranteed to preserve
2581 UTF-8 flag even from overloaded objects. Similar in nature to
2582 sv_2pv[_flags] but operates directly on an SV instead of just the
2583 string. Mostly uses sv_2pv_flags to do its work, except when that
2584 would lose the UTF-8'ness of the PV.
2590 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2593 const char * const s = SvPV_const(ssv,len);
2594 sv_setpvn(dsv,s,len);
2602 =for apidoc sv_2pvbyte
2604 Return a pointer to the byte-encoded representation of the SV, and set *lp
2605 to its length. May cause the SV to be downgraded from UTF-8 as a
2608 Usually accessed via the C<SvPVbyte> macro.
2614 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2616 sv_utf8_downgrade(sv,0);
2617 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2621 =for apidoc sv_2pvutf8
2623 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2624 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2626 Usually accessed via the C<SvPVutf8> macro.
2632 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2634 sv_utf8_upgrade(sv);
2635 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2640 =for apidoc sv_2bool
2642 This function is only called on magical items, and is only used by
2643 sv_true() or its macro equivalent.
2649 Perl_sv_2bool(pTHX_ register SV *sv)
2657 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2658 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2659 return (bool)SvTRUE(tmpsv);
2660 return SvRV(sv) != 0;
2663 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2665 (*sv->sv_u.svu_pv > '0' ||
2666 Xpvtmp->xpv_cur > 1 ||
2667 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2674 return SvIVX(sv) != 0;
2677 return SvNVX(sv) != 0.0;
2685 =for apidoc sv_utf8_upgrade
2687 Converts the PV of an SV to its UTF-8-encoded form.
2688 Forces the SV to string form if it is not already.
2689 Always sets the SvUTF8 flag to avoid future validity checks even
2690 if all the bytes have hibit clear.
2692 This is not as a general purpose byte encoding to Unicode interface:
2693 use the Encode extension for that.
2695 =for apidoc sv_utf8_upgrade_flags
2697 Converts the PV of an SV to its UTF-8-encoded form.
2698 Forces the SV to string form if it is not already.
2699 Always sets the SvUTF8 flag to avoid future validity checks even
2700 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2701 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2702 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2704 This is not as a general purpose byte encoding to Unicode interface:
2705 use the Encode extension for that.
2711 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2713 if (sv == &PL_sv_undef)
2717 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2718 (void) sv_2pv_flags(sv,&len, flags);
2722 (void) SvPV_force(sv,len);
2731 sv_force_normal_flags(sv, 0);
2734 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2735 sv_recode_to_utf8(sv, PL_encoding);
2736 else { /* Assume Latin-1/EBCDIC */
2737 /* This function could be much more efficient if we
2738 * had a FLAG in SVs to signal if there are any hibit
2739 * chars in the PV. Given that there isn't such a flag
2740 * make the loop as fast as possible. */
2741 const U8 * const s = (U8 *) SvPVX_const(sv);
2742 const U8 * const e = (U8 *) SvEND(sv);
2747 /* Check for hi bit */
2748 if (!NATIVE_IS_INVARIANT(ch)) {
2749 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2750 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2752 SvPV_free(sv); /* No longer using what was there before. */
2753 SvPV_set(sv, (char*)recoded);
2754 SvCUR_set(sv, len - 1);
2755 SvLEN_set(sv, len); /* No longer know the real size. */
2759 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2766 =for apidoc sv_utf8_downgrade
2768 Attempts to convert the PV of an SV from characters to bytes.
2769 If the PV contains a character beyond byte, this conversion will fail;
2770 in this case, either returns false or, if C<fail_ok> is not
2773 This is not as a general purpose Unicode to byte encoding interface:
2774 use the Encode extension for that.
2780 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2782 if (SvPOKp(sv) && SvUTF8(sv)) {
2788 sv_force_normal_flags(sv, 0);
2790 s = (U8 *) SvPV(sv, len);
2791 if (!utf8_to_bytes(s, &len)) {
2796 Perl_croak(aTHX_ "Wide character in %s",
2799 Perl_croak(aTHX_ "Wide character");
2810 =for apidoc sv_utf8_encode
2812 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2813 flag off so that it looks like octets again.
2819 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2821 (void) sv_utf8_upgrade(sv);
2823 sv_force_normal_flags(sv, 0);
2825 if (SvREADONLY(sv)) {
2826 Perl_croak(aTHX_ PL_no_modify);
2832 =for apidoc sv_utf8_decode
2834 If the PV of the SV is an octet sequence in UTF-8
2835 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2836 so that it looks like a character. If the PV contains only single-byte
2837 characters, the C<SvUTF8> flag stays being off.
2838 Scans PV for validity and returns false if the PV is invalid UTF-8.
2844 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2850 /* The octets may have got themselves encoded - get them back as
2853 if (!sv_utf8_downgrade(sv, TRUE))
2856 /* it is actually just a matter of turning the utf8 flag on, but
2857 * we want to make sure everything inside is valid utf8 first.
2859 c = (const U8 *) SvPVX_const(sv);
2860 if (!is_utf8_string(c, SvCUR(sv)+1))
2862 e = (const U8 *) SvEND(sv);
2865 if (!UTF8_IS_INVARIANT(ch)) {
2875 =for apidoc sv_setsv
2877 Copies the contents of the source SV C<ssv> into the destination SV
2878 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2879 function if the source SV needs to be reused. Does not handle 'set' magic.
2880 Loosely speaking, it performs a copy-by-value, obliterating any previous
2881 content of the destination.
2883 You probably want to use one of the assortment of wrappers, such as
2884 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2885 C<SvSetMagicSV_nosteal>.
2887 =for apidoc sv_setsv_flags
2889 Copies the contents of the source SV C<ssv> into the destination SV
2890 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2891 function if the source SV needs to be reused. Does not handle 'set' magic.
2892 Loosely speaking, it performs a copy-by-value, obliterating any previous
2893 content of the destination.
2894 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2895 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2896 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2897 and C<sv_setsv_nomg> are implemented in terms of this function.
2899 You probably want to use one of the assortment of wrappers, such as
2900 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2901 C<SvSetMagicSV_nosteal>.
2903 This is the primary function for copying scalars, and most other
2904 copy-ish functions and macros use this underneath.
2910 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2912 register U32 sflags;
2918 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2920 sstr = &PL_sv_undef;
2921 stype = SvTYPE(sstr);
2922 dtype = SvTYPE(dstr);
2927 /* need to nuke the magic */
2929 SvRMAGICAL_off(dstr);
2932 /* There's a lot of redundancy below but we're going for speed here */
2937 if (dtype != SVt_PVGV) {
2938 (void)SvOK_off(dstr);
2946 sv_upgrade(dstr, SVt_IV);
2949 sv_upgrade(dstr, SVt_PVNV);
2953 sv_upgrade(dstr, SVt_PVIV);
2956 (void)SvIOK_only(dstr);
2957 SvIV_set(dstr, SvIVX(sstr));
2960 if (SvTAINTED(sstr))
2971 sv_upgrade(dstr, SVt_NV);
2976 sv_upgrade(dstr, SVt_PVNV);
2979 SvNV_set(dstr, SvNVX(sstr));
2980 (void)SvNOK_only(dstr);
2981 if (SvTAINTED(sstr))
2989 sv_upgrade(dstr, SVt_RV);
2990 else if (dtype == SVt_PVGV &&
2991 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2994 if (GvIMPORTED(dstr) != GVf_IMPORTED
2995 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2997 GvIMPORTED_on(dstr);
3006 #ifdef PERL_OLD_COPY_ON_WRITE
3007 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3008 if (dtype < SVt_PVIV)
3009 sv_upgrade(dstr, SVt_PVIV);
3016 sv_upgrade(dstr, SVt_PV);
3019 if (dtype < SVt_PVIV)
3020 sv_upgrade(dstr, SVt_PVIV);
3023 if (dtype < SVt_PVNV)
3024 sv_upgrade(dstr, SVt_PVNV);
3031 const char * const type = sv_reftype(sstr,0);
3033 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3035 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3040 if (dtype <= SVt_PVGV) {
3042 if (dtype != SVt_PVGV) {
3043 const char * const name = GvNAME(sstr);
3044 const STRLEN len = GvNAMELEN(sstr);
3045 /* don't upgrade SVt_PVLV: it can hold a glob */
3046 if (dtype != SVt_PVLV)
3047 sv_upgrade(dstr, SVt_PVGV);
3048 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3049 GvSTASH(dstr) = GvSTASH(sstr);
3051 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3052 GvNAME(dstr) = savepvn(name, len);
3053 GvNAMELEN(dstr) = len;
3054 SvFAKE_on(dstr); /* can coerce to non-glob */
3057 #ifdef GV_UNIQUE_CHECK
3058 if (GvUNIQUE((GV*)dstr)) {
3059 Perl_croak(aTHX_ PL_no_modify);
3063 (void)SvOK_off(dstr);
3064 GvINTRO_off(dstr); /* one-shot flag */
3066 GvGP(dstr) = gp_ref(GvGP(sstr));
3067 if (SvTAINTED(sstr))
3069 if (GvIMPORTED(dstr) != GVf_IMPORTED
3070 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3072 GvIMPORTED_on(dstr);
3080 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3082 if ((int)SvTYPE(sstr) != stype) {
3083 stype = SvTYPE(sstr);
3084 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3088 if (stype == SVt_PVLV)
3089 SvUPGRADE(dstr, SVt_PVNV);
3091 SvUPGRADE(dstr, (U32)stype);
3094 sflags = SvFLAGS(sstr);
3096 if (sflags & SVf_ROK) {
3097 if (dtype >= SVt_PV) {
3098 if (dtype == SVt_PVGV) {
3099 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3101 const int intro = GvINTRO(dstr);
3103 #ifdef GV_UNIQUE_CHECK
3104 if (GvUNIQUE((GV*)dstr)) {
3105 Perl_croak(aTHX_ PL_no_modify);
3110 GvINTRO_off(dstr); /* one-shot flag */
3111 GvLINE(dstr) = CopLINE(PL_curcop);
3112 GvEGV(dstr) = (GV*)dstr;
3115 switch (SvTYPE(sref)) {
3118 SAVEGENERICSV(GvAV(dstr));
3120 dref = (SV*)GvAV(dstr);
3121 GvAV(dstr) = (AV*)sref;
3122 if (!GvIMPORTED_AV(dstr)
3123 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3125 GvIMPORTED_AV_on(dstr);
3130 SAVEGENERICSV(GvHV(dstr));
3132 dref = (SV*)GvHV(dstr);
3133 GvHV(dstr) = (HV*)sref;
3134 if (!GvIMPORTED_HV(dstr)
3135 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3137 GvIMPORTED_HV_on(dstr);
3142 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3143 SvREFCNT_dec(GvCV(dstr));
3144 GvCV(dstr) = Nullcv;
3145 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3146 PL_sub_generation++;
3148 SAVEGENERICSV(GvCV(dstr));
3151 dref = (SV*)GvCV(dstr);
3152 if (GvCV(dstr) != (CV*)sref) {
3153 CV* const cv = GvCV(dstr);
3155 if (!GvCVGEN((GV*)dstr) &&
3156 (CvROOT(cv) || CvXSUB(cv)))
3158 /* Redefining a sub - warning is mandatory if
3159 it was a const and its value changed. */
3160 if (ckWARN(WARN_REDEFINE)
3162 && (!CvCONST((CV*)sref)
3163 || sv_cmp(cv_const_sv(cv),
3164 cv_const_sv((CV*)sref)))))
3166 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3168 ? "Constant subroutine %s::%s redefined"
3169 : "Subroutine %s::%s redefined",
3170 HvNAME_get(GvSTASH((GV*)dstr)),
3171 GvENAME((GV*)dstr));
3175 cv_ckproto(cv, (GV*)dstr,
3177 ? SvPVX_const(sref) : Nullch);
3179 GvCV(dstr) = (CV*)sref;
3180 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3181 GvASSUMECV_on(dstr);
3182 PL_sub_generation++;
3184 if (!GvIMPORTED_CV(dstr)
3185 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3187 GvIMPORTED_CV_on(dstr);
3192 SAVEGENERICSV(GvIOp(dstr));
3194 dref = (SV*)GvIOp(dstr);
3195 GvIOp(dstr) = (IO*)sref;
3199 SAVEGENERICSV(GvFORM(dstr));
3201 dref = (SV*)GvFORM(dstr);
3202 GvFORM(dstr) = (CV*)sref;
3206 SAVEGENERICSV(GvSV(dstr));
3208 dref = (SV*)GvSV(dstr);
3210 if (!GvIMPORTED_SV(dstr)
3211 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3213 GvIMPORTED_SV_on(dstr);
3219 if (SvTAINTED(sstr))
3223 if (SvPVX_const(dstr)) {
3229 (void)SvOK_off(dstr);
3230 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3232 if (sflags & SVp_NOK) {
3234 /* Only set the public OK flag if the source has public OK. */
3235 if (sflags & SVf_NOK)
3236 SvFLAGS(dstr) |= SVf_NOK;
3237 SvNV_set(dstr, SvNVX(sstr));
3239 if (sflags & SVp_IOK) {
3240 (void)SvIOKp_on(dstr);
3241 if (sflags & SVf_IOK)
3242 SvFLAGS(dstr) |= SVf_IOK;
3243 if (sflags & SVf_IVisUV)
3245 SvIV_set(dstr, SvIVX(sstr));
3247 if (SvAMAGIC(sstr)) {
3251 else if (sflags & SVp_POK) {
3255 * Check to see if we can just swipe the string. If so, it's a
3256 * possible small lose on short strings, but a big win on long ones.
3257 * It might even be a win on short strings if SvPVX_const(dstr)
3258 * has to be allocated and SvPVX_const(sstr) has to be freed.
3261 /* Whichever path we take through the next code, we want this true,
3262 and doing it now facilitates the COW check. */
3263 (void)SvPOK_only(dstr);
3266 /* We're not already COW */
3267 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3268 #ifndef PERL_OLD_COPY_ON_WRITE
3269 /* or we are, but dstr isn't a suitable target. */
3270 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3275 (sflags & SVs_TEMP) && /* slated for free anyway? */
3276 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3277 (!(flags & SV_NOSTEAL)) &&
3278 /* and we're allowed to steal temps */
3279 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3280 SvLEN(sstr) && /* and really is a string */
3281 /* and won't be needed again, potentially */
3282 !(PL_op && PL_op->op_type == OP_AASSIGN))
3283 #ifdef PERL_OLD_COPY_ON_WRITE
3284 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3285 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3286 && SvTYPE(sstr) >= SVt_PVIV)
3289 /* Failed the swipe test, and it's not a shared hash key either.
3290 Have to copy the string. */
3291 STRLEN len = SvCUR(sstr);
3292 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3293 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3294 SvCUR_set(dstr, len);
3295 *SvEND(dstr) = '\0';
3297 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3299 /* Either it's a shared hash key, or it's suitable for
3300 copy-on-write or we can swipe the string. */
3302 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3306 #ifdef PERL_OLD_COPY_ON_WRITE
3308 /* I believe I should acquire a global SV mutex if
3309 it's a COW sv (not a shared hash key) to stop
3310 it going un copy-on-write.
3311 If the source SV has gone un copy on write between up there
3312 and down here, then (assert() that) it is of the correct
3313 form to make it copy on write again */
3314 if ((sflags & (SVf_FAKE | SVf_READONLY))
3315 != (SVf_FAKE | SVf_READONLY)) {
3316 SvREADONLY_on(sstr);
3318 /* Make the source SV into a loop of 1.
3319 (about to become 2) */
3320 SV_COW_NEXT_SV_SET(sstr, sstr);
3324 /* Initial code is common. */
3325 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3330 /* making another shared SV. */
3331 STRLEN cur = SvCUR(sstr);
3332 STRLEN len = SvLEN(sstr);
3333 #ifdef PERL_OLD_COPY_ON_WRITE
3335 assert (SvTYPE(dstr) >= SVt_PVIV);
3336 /* SvIsCOW_normal */
3337 /* splice us in between source and next-after-source. */
3338 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3339 SV_COW_NEXT_SV_SET(sstr, dstr);
3340 SvPV_set(dstr, SvPVX_mutable(sstr));
3344 /* SvIsCOW_shared_hash */
3345 DEBUG_C(PerlIO_printf(Perl_debug_log,
3346 "Copy on write: Sharing hash\n"));
3348 assert (SvTYPE(dstr) >= SVt_PV);
3350 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3352 SvLEN_set(dstr, len);
3353 SvCUR_set(dstr, cur);
3354 SvREADONLY_on(dstr);
3356 /* Relesase a global SV mutex. */
3359 { /* Passes the swipe test. */
3360 SvPV_set(dstr, SvPVX_mutable(sstr));
3361 SvLEN_set(dstr, SvLEN(sstr));
3362 SvCUR_set(dstr, SvCUR(sstr));
3365 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3366 SvPV_set(sstr, Nullch);
3372 if (sflags & SVf_UTF8)
3374 if (sflags & SVp_NOK) {
3376 if (sflags & SVf_NOK)
3377 SvFLAGS(dstr) |= SVf_NOK;
3378 SvNV_set(dstr, SvNVX(sstr));
3380 if (sflags & SVp_IOK) {
3381 (void)SvIOKp_on(dstr);
3382 if (sflags & SVf_IOK)
3383 SvFLAGS(dstr) |= SVf_IOK;
3384 if (sflags & SVf_IVisUV)
3386 SvIV_set(dstr, SvIVX(sstr));
3389 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3390 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3391 smg->mg_ptr, smg->mg_len);
3392 SvRMAGICAL_on(dstr);
3395 else if (sflags & SVp_IOK) {
3396 if (sflags & SVf_IOK)
3397 (void)SvIOK_only(dstr);
3399 (void)SvOK_off(dstr);
3400 (void)SvIOKp_on(dstr);
3402 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3403 if (sflags & SVf_IVisUV)
3405 SvIV_set(dstr, SvIVX(sstr));
3406 if (sflags & SVp_NOK) {
3407 if (sflags & SVf_NOK)
3408 (void)SvNOK_on(dstr);
3410 (void)SvNOKp_on(dstr);
3411 SvNV_set(dstr, SvNVX(sstr));
3414 else if (sflags & SVp_NOK) {
3415 if (sflags & SVf_NOK)
3416 (void)SvNOK_only(dstr);
3418 (void)SvOK_off(dstr);
3421 SvNV_set(dstr, SvNVX(sstr));
3424 if (dtype == SVt_PVGV) {
3425 if (ckWARN(WARN_MISC))
3426 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3429 (void)SvOK_off(dstr);
3431 if (SvTAINTED(sstr))
3436 =for apidoc sv_setsv_mg
3438 Like C<sv_setsv>, but also handles 'set' magic.
3444 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3446 sv_setsv(dstr,sstr);
3450 #ifdef PERL_OLD_COPY_ON_WRITE
3452 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3454 STRLEN cur = SvCUR(sstr);
3455 STRLEN len = SvLEN(sstr);
3456 register char *new_pv;
3459 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3467 if (SvTHINKFIRST(dstr))
3468 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3469 else if (SvPVX_const(dstr))
3470 Safefree(SvPVX_const(dstr));
3474 SvUPGRADE(dstr, SVt_PVIV);
3476 assert (SvPOK(sstr));
3477 assert (SvPOKp(sstr));
3478 assert (!SvIOK(sstr));
3479 assert (!SvIOKp(sstr));
3480 assert (!SvNOK(sstr));
3481 assert (!SvNOKp(sstr));
3483 if (SvIsCOW(sstr)) {
3485 if (SvLEN(sstr) == 0) {
3486 /* source is a COW shared hash key. */
3487 DEBUG_C(PerlIO_printf(Perl_debug_log,
3488 "Fast copy on write: Sharing hash\n"));
3489 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3492 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3494 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3495 SvUPGRADE(sstr, SVt_PVIV);
3496 SvREADONLY_on(sstr);
3498 DEBUG_C(PerlIO_printf(Perl_debug_log,
3499 "Fast copy on write: Converting sstr to COW\n"));
3500 SV_COW_NEXT_SV_SET(dstr, sstr);
3502 SV_COW_NEXT_SV_SET(sstr, dstr);
3503 new_pv = SvPVX_mutable(sstr);
3506 SvPV_set(dstr, new_pv);
3507 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3510 SvLEN_set(dstr, len);
3511 SvCUR_set(dstr, cur);
3520 =for apidoc sv_setpvn
3522 Copies a string into an SV. The C<len> parameter indicates the number of
3523 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3524 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3530 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3532 register char *dptr;
3534 SV_CHECK_THINKFIRST_COW_DROP(sv);
3540 /* len is STRLEN which is unsigned, need to copy to signed */
3543 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3545 SvUPGRADE(sv, SVt_PV);
3547 dptr = SvGROW(sv, len + 1);
3548 Move(ptr,dptr,len,char);
3551 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3556 =for apidoc sv_setpvn_mg
3558 Like C<sv_setpvn>, but also handles 'set' magic.
3564 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3566 sv_setpvn(sv,ptr,len);
3571 =for apidoc sv_setpv
3573 Copies a string into an SV. The string must be null-terminated. Does not
3574 handle 'set' magic. See C<sv_setpv_mg>.
3580 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3582 register STRLEN len;
3584 SV_CHECK_THINKFIRST_COW_DROP(sv);
3590 SvUPGRADE(sv, SVt_PV);
3592 SvGROW(sv, len + 1);
3593 Move(ptr,SvPVX(sv),len+1,char);
3595 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3600 =for apidoc sv_setpv_mg
3602 Like C<sv_setpv>, but also handles 'set' magic.
3608 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3615 =for apidoc sv_usepvn
3617 Tells an SV to use C<ptr> to find its string value. Normally the string is
3618 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3619 The C<ptr> should point to memory that was allocated by C<malloc>. The
3620 string length, C<len>, must be supplied. This function will realloc the
3621 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3622 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3623 See C<sv_usepvn_mg>.
3629 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3632 SV_CHECK_THINKFIRST_COW_DROP(sv);
3633 SvUPGRADE(sv, SVt_PV);
3638 if (SvPVX_const(sv))
3641 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3642 ptr = saferealloc (ptr, allocate);
3645 SvLEN_set(sv, allocate);
3647 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3652 =for apidoc sv_usepvn_mg
3654 Like C<sv_usepvn>, but also handles 'set' magic.
3660 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3662 sv_usepvn(sv,ptr,len);
3666 #ifdef PERL_OLD_COPY_ON_WRITE
3667 /* Need to do this *after* making the SV normal, as we need the buffer
3668 pointer to remain valid until after we've copied it. If we let go too early,
3669 another thread could invalidate it by unsharing last of the same hash key
3670 (which it can do by means other than releasing copy-on-write Svs)
3671 or by changing the other copy-on-write SVs in the loop. */
3673 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3675 if (len) { /* this SV was SvIsCOW_normal(sv) */
3676 /* we need to find the SV pointing to us. */
3677 SV * const current = SV_COW_NEXT_SV(after);
3679 if (current == sv) {
3680 /* The SV we point to points back to us (there were only two of us
3682 Hence other SV is no longer copy on write either. */
3684 SvREADONLY_off(after);
3686 /* We need to follow the pointers around the loop. */
3688 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3691 /* don't loop forever if the structure is bust, and we have
3692 a pointer into a closed loop. */
3693 assert (current != after);
3694 assert (SvPVX_const(current) == pvx);
3696 /* Make the SV before us point to the SV after us. */
3697 SV_COW_NEXT_SV_SET(current, after);
3700 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3705 Perl_sv_release_IVX(pTHX_ register SV *sv)
3708 sv_force_normal_flags(sv, 0);
3714 =for apidoc sv_force_normal_flags
3716 Undo various types of fakery on an SV: if the PV is a shared string, make
3717 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3718 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3719 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3720 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3721 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3722 set to some other value.) In addition, the C<flags> parameter gets passed to
3723 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3724 with flags set to 0.
3730 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3732 #ifdef PERL_OLD_COPY_ON_WRITE
3733 if (SvREADONLY(sv)) {
3734 /* At this point I believe I should acquire a global SV mutex. */
3736 const char * const pvx = SvPVX_const(sv);
3737 const STRLEN len = SvLEN(sv);
3738 const STRLEN cur = SvCUR(sv);
3739 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3741 PerlIO_printf(Perl_debug_log,
3742 "Copy on write: Force normal %ld\n",
3748 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3749 SvPV_set(sv, (char*)0);
3751 if (flags & SV_COW_DROP_PV) {
3752 /* OK, so we don't need to copy our buffer. */
3755 SvGROW(sv, cur + 1);
3756 Move(pvx,SvPVX(sv),cur,char);
3760 sv_release_COW(sv, pvx, len, next);
3765 else if (IN_PERL_RUNTIME)
3766 Perl_croak(aTHX_ PL_no_modify);
3767 /* At this point I believe that I can drop the global SV mutex. */
3770 if (SvREADONLY(sv)) {
3772 const char * const pvx = SvPVX_const(sv);
3773 const STRLEN len = SvCUR(sv);
3776 SvPV_set(sv, Nullch);
3778 SvGROW(sv, len + 1);
3779 Move(pvx,SvPVX(sv),len,char);
3781 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3783 else if (IN_PERL_RUNTIME)
3784 Perl_croak(aTHX_ PL_no_modify);
3788 sv_unref_flags(sv, flags);
3789 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3796 Efficient removal of characters from the beginning of the string buffer.
3797 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3798 the string buffer. The C<ptr> becomes the first character of the adjusted
3799 string. Uses the "OOK hack".
3800 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3801 refer to the same chunk of data.
3807 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3809 register STRLEN delta;
3810 if (!ptr || !SvPOKp(sv))
3812 delta = ptr - SvPVX_const(sv);
3813 SV_CHECK_THINKFIRST(sv);
3814 if (SvTYPE(sv) < SVt_PVIV)
3815 sv_upgrade(sv,SVt_PVIV);
3818 if (!SvLEN(sv)) { /* make copy of shared string */
3819 const char *pvx = SvPVX_const(sv);
3820 const STRLEN len = SvCUR(sv);
3821 SvGROW(sv, len + 1);
3822 Move(pvx,SvPVX(sv),len,char);
3826 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3827 and we do that anyway inside the SvNIOK_off
3829 SvFLAGS(sv) |= SVf_OOK;
3832 SvLEN_set(sv, SvLEN(sv) - delta);
3833 SvCUR_set(sv, SvCUR(sv) - delta);
3834 SvPV_set(sv, SvPVX(sv) + delta);
3835 SvIV_set(sv, SvIVX(sv) + delta);
3839 =for apidoc sv_catpvn
3841 Concatenates the string onto the end of the string which is in the SV. The
3842 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3843 status set, then the bytes appended should be valid UTF-8.
3844 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3846 =for apidoc sv_catpvn_flags
3848 Concatenates the string onto the end of the string which is in the SV. The
3849 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3850 status set, then the bytes appended should be valid UTF-8.
3851 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3852 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3853 in terms of this function.
3859 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3862 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3864 SvGROW(dsv, dlen + slen + 1);
3866 sstr = SvPVX_const(dsv);
3867 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3868 SvCUR_set(dsv, SvCUR(dsv) + slen);
3870 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3872 if (flags & SV_SMAGIC)
3877 =for apidoc sv_catsv
3879 Concatenates the string from SV C<ssv> onto the end of the string in
3880 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3881 not 'set' magic. See C<sv_catsv_mg>.
3883 =for apidoc sv_catsv_flags
3885 Concatenates the string from SV C<ssv> onto the end of the string in
3886 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3887 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3888 and C<sv_catsv_nomg> are implemented in terms of this function.
3893 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3897 const char *spv = SvPV_const(ssv, slen);
3899 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3900 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3901 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3902 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3903 dsv->sv_flags doesn't have that bit set.
3904 Andy Dougherty 12 Oct 2001
3906 const I32 sutf8 = DO_UTF8(ssv);
3909 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3911 dutf8 = DO_UTF8(dsv);
3913 if (dutf8 != sutf8) {
3915 /* Not modifying source SV, so taking a temporary copy. */
3916 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3918 sv_utf8_upgrade(csv);
3919 spv = SvPV_const(csv, slen);
3922 sv_utf8_upgrade_nomg(dsv);
3924 sv_catpvn_nomg(dsv, spv, slen);
3927 if (flags & SV_SMAGIC)
3932 =for apidoc sv_catpv
3934 Concatenates the string onto the end of the string which is in the SV.
3935 If the SV has the UTF-8 status set, then the bytes appended should be
3936 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3941 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3943 register STRLEN len;
3949 junk = SvPV_force(sv, tlen);
3951 SvGROW(sv, tlen + len + 1);
3953 ptr = SvPVX_const(sv);
3954 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3955 SvCUR_set(sv, SvCUR(sv) + len);
3956 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3961 =for apidoc sv_catpv_mg
3963 Like C<sv_catpv>, but also handles 'set' magic.
3969 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3978 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3979 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3986 Perl_newSV(pTHX_ STRLEN len)
3992 sv_upgrade(sv, SVt_PV);
3993 SvGROW(sv, len + 1);
3998 =for apidoc sv_magicext
4000 Adds magic to an SV, upgrading it if necessary. Applies the
4001 supplied vtable and returns a pointer to the magic added.
4003 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4004 In particular, you can add magic to SvREADONLY SVs, and add more than
4005 one instance of the same 'how'.
4007 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4008 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4009 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4010 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4012 (This is now used as a subroutine by C<sv_magic>.)
4017 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4018 const char* name, I32 namlen)
4022 if (SvTYPE(sv) < SVt_PVMG) {
4023 SvUPGRADE(sv, SVt_PVMG);
4025 Newxz(mg, 1, MAGIC);
4026 mg->mg_moremagic = SvMAGIC(sv);
4027 SvMAGIC_set(sv, mg);
4029 /* Sometimes a magic contains a reference loop, where the sv and
4030 object refer to each other. To prevent a reference loop that
4031 would prevent such objects being freed, we look for such loops
4032 and if we find one we avoid incrementing the object refcount.
4034 Note we cannot do this to avoid self-tie loops as intervening RV must
4035 have its REFCNT incremented to keep it in existence.
4038 if (!obj || obj == sv ||
4039 how == PERL_MAGIC_arylen ||
4040 how == PERL_MAGIC_qr ||
4041 how == PERL_MAGIC_symtab ||
4042 (SvTYPE(obj) == SVt_PVGV &&
4043 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4044 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4045 GvFORM(obj) == (CV*)sv)))
4050 mg->mg_obj = SvREFCNT_inc(obj);
4051 mg->mg_flags |= MGf_REFCOUNTED;
4054 /* Normal self-ties simply pass a null object, and instead of
4055 using mg_obj directly, use the SvTIED_obj macro to produce a
4056 new RV as needed. For glob "self-ties", we are tieing the PVIO
4057 with an RV obj pointing to the glob containing the PVIO. In
4058 this case, to avoid a reference loop, we need to weaken the
4062 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4063 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4069 mg->mg_len = namlen;
4072 mg->mg_ptr = savepvn(name, namlen);
4073 else if (namlen == HEf_SVKEY)
4074 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4076 mg->mg_ptr = (char *) name;
4078 mg->mg_virtual = vtable;
4082 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4087 =for apidoc sv_magic
4089 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4090 then adds a new magic item of type C<how> to the head of the magic list.
4092 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4093 handling of the C<name> and C<namlen> arguments.
4095 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4096 to add more than one instance of the same 'how'.
4102 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4104 const MGVTBL *vtable;
4107 #ifdef PERL_OLD_COPY_ON_WRITE
4109 sv_force_normal_flags(sv, 0);
4111 if (SvREADONLY(sv)) {
4113 /* its okay to attach magic to shared strings; the subsequent
4114 * upgrade to PVMG will unshare the string */
4115 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4118 && how != PERL_MAGIC_regex_global
4119 && how != PERL_MAGIC_bm
4120 && how != PERL_MAGIC_fm
4121 && how != PERL_MAGIC_sv
4122 && how != PERL_MAGIC_backref
4125 Perl_croak(aTHX_ PL_no_modify);
4128 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4129 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4130 /* sv_magic() refuses to add a magic of the same 'how' as an
4133 if (how == PERL_MAGIC_taint)
4141 vtable = &PL_vtbl_sv;
4143 case PERL_MAGIC_overload:
4144 vtable = &PL_vtbl_amagic;
4146 case PERL_MAGIC_overload_elem:
4147 vtable = &PL_vtbl_amagicelem;
4149 case PERL_MAGIC_overload_table:
4150 vtable = &PL_vtbl_ovrld;
4153 vtable = &PL_vtbl_bm;
4155 case PERL_MAGIC_regdata:
4156 vtable = &PL_vtbl_regdata;
4158 case PERL_MAGIC_regdatum:
4159 vtable = &PL_vtbl_regdatum;
4161 case PERL_MAGIC_env:
4162 vtable = &PL_vtbl_env;
4165 vtable = &PL_vtbl_fm;
4167 case PERL_MAGIC_envelem:
4168 vtable = &PL_vtbl_envelem;
4170 case PERL_MAGIC_regex_global:
4171 vtable = &PL_vtbl_mglob;
4173 case PERL_MAGIC_isa:
4174 vtable = &PL_vtbl_isa;
4176 case PERL_MAGIC_isaelem:
4177 vtable = &PL_vtbl_isaelem;
4179 case PERL_MAGIC_nkeys:
4180 vtable = &PL_vtbl_nkeys;
4182 case PERL_MAGIC_dbfile:
4185 case PERL_MAGIC_dbline:
4186 vtable = &PL_vtbl_dbline;
4188 #ifdef USE_LOCALE_COLLATE
4189 case PERL_MAGIC_collxfrm:
4190 vtable = &PL_vtbl_collxfrm;
4192 #endif /* USE_LOCALE_COLLATE */
4193 case PERL_MAGIC_tied:
4194 vtable = &PL_vtbl_pack;
4196 case PERL_MAGIC_tiedelem:
4197 case PERL_MAGIC_tiedscalar:
4198 vtable = &PL_vtbl_packelem;
4201 vtable = &PL_vtbl_regexp;
4203 case PERL_MAGIC_sig:
4204 vtable = &PL_vtbl_sig;
4206 case PERL_MAGIC_sigelem:
4207 vtable = &PL_vtbl_sigelem;
4209 case PERL_MAGIC_taint:
4210 vtable = &PL_vtbl_taint;
4212 case PERL_MAGIC_uvar:
4213 vtable = &PL_vtbl_uvar;
4215 case PERL_MAGIC_vec:
4216 vtable = &PL_vtbl_vec;
4218 case PERL_MAGIC_arylen_p:
4219 case PERL_MAGIC_rhash:
4220 case PERL_MAGIC_symtab:
4221 case PERL_MAGIC_vstring:
4224 case PERL_MAGIC_utf8:
4225 vtable = &PL_vtbl_utf8;
4227 case PERL_MAGIC_substr:
4228 vtable = &PL_vtbl_substr;
4230 case PERL_MAGIC_defelem:
4231 vtable = &PL_vtbl_defelem;
4233 case PERL_MAGIC_glob:
4234 vtable = &PL_vtbl_glob;
4236 case PERL_MAGIC_arylen:
4237 vtable = &PL_vtbl_arylen;
4239 case PERL_MAGIC_pos:
4240 vtable = &PL_vtbl_pos;
4242 case PERL_MAGIC_backref:
4243 vtable = &PL_vtbl_backref;
4245 case PERL_MAGIC_ext:
4246 /* Reserved for use by extensions not perl internals. */
4247 /* Useful for attaching extension internal data to perl vars. */
4248 /* Note that multiple extensions may clash if magical scalars */
4249 /* etc holding private data from one are passed to another. */
4253 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4256 /* Rest of work is done else where */
4257 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4260 case PERL_MAGIC_taint:
4263 case PERL_MAGIC_ext:
4264 case PERL_MAGIC_dbfile:
4271 =for apidoc sv_unmagic
4273 Removes all magic of type C<type> from an SV.
4279 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4283 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4286 for (mg = *mgp; mg; mg = *mgp) {
4287 if (mg->mg_type == type) {
4288 const MGVTBL* const vtbl = mg->mg_virtual;
4289 *mgp = mg->mg_moremagic;
4290 if (vtbl && vtbl->svt_free)
4291 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4292 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4294 Safefree(mg->mg_ptr);
4295 else if (mg->mg_len == HEf_SVKEY)
4296 SvREFCNT_dec((SV*)mg->mg_ptr);
4297 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4298 Safefree(mg->mg_ptr);
4300 if (mg->mg_flags & MGf_REFCOUNTED)
4301 SvREFCNT_dec(mg->mg_obj);
4305 mgp = &mg->mg_moremagic;
4309 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4316 =for apidoc sv_rvweaken
4318 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4319 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4320 push a back-reference to this RV onto the array of backreferences
4321 associated with that magic.
4327 Perl_sv_rvweaken(pTHX_ SV *sv)
4330 if (!SvOK(sv)) /* let undefs pass */
4333 Perl_croak(aTHX_ "Can't weaken a nonreference");
4334 else if (SvWEAKREF(sv)) {
4335 if (ckWARN(WARN_MISC))
4336 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4340 Perl_sv_add_backref(aTHX_ tsv, sv);
4346 /* Give tsv backref magic if it hasn't already got it, then push a
4347 * back-reference to sv onto the array associated with the backref magic.
4351 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4355 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4356 av = (AV*)mg->mg_obj;
4359 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4360 /* av now has a refcnt of 2, which avoids it getting freed
4361 * before us during global cleanup. The extra ref is removed
4362 * by magic_killbackrefs() when tsv is being freed */
4364 if (AvFILLp(av) >= AvMAX(av)) {
4365 av_extend(av, AvFILLp(av)+1);
4367 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4370 /* delete a back-reference to ourselves from the backref magic associated
4371 * with the SV we point to.
4375 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4381 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4382 if (PL_in_clean_all)
4385 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4386 Perl_croak(aTHX_ "panic: del_backref");
4387 av = (AV *)mg->mg_obj;
4389 /* We shouldn't be in here more than once, but for paranoia reasons lets
4391 for (i = AvFILLp(av); i >= 0; i--) {
4393 const SSize_t fill = AvFILLp(av);
4395 /* We weren't the last entry.
4396 An unordered list has this property that you can take the
4397 last element off the end to fill the hole, and it's still
4398 an unordered list :-)
4403 AvFILLp(av) = fill - 1;
4409 =for apidoc sv_insert
4411 Inserts a string at the specified offset/length within the SV. Similar to
4412 the Perl substr() function.
4418 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4422 register char *midend;
4423 register char *bigend;
4429 Perl_croak(aTHX_ "Can't modify non-existent substring");
4430 SvPV_force(bigstr, curlen);
4431 (void)SvPOK_only_UTF8(bigstr);
4432 if (offset + len > curlen) {
4433 SvGROW(bigstr, offset+len+1);
4434 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4435 SvCUR_set(bigstr, offset+len);
4439 i = littlelen - len;
4440 if (i > 0) { /* string might grow */
4441 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4442 mid = big + offset + len;
4443 midend = bigend = big + SvCUR(bigstr);
4446 while (midend > mid) /* shove everything down */
4447 *--bigend = *--midend;
4448 Move(little,big+offset,littlelen,char);
4449 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4454 Move(little,SvPVX(bigstr)+offset,len,char);
4459 big = SvPVX(bigstr);
4462 bigend = big + SvCUR(bigstr);
4464 if (midend > bigend)
4465 Perl_croak(aTHX_ "panic: sv_insert");
4467 if (mid - big > bigend - midend) { /* faster to shorten from end */
4469 Move(little, mid, littlelen,char);
4472 i = bigend - midend;
4474 Move(midend, mid, i,char);
4478 SvCUR_set(bigstr, mid - big);
4480 else if ((i = mid - big)) { /* faster from front */
4481 midend -= littlelen;
4483 sv_chop(bigstr,midend-i);
4488 Move(little, mid, littlelen,char);
4490 else if (littlelen) {
4491 midend -= littlelen;
4492 sv_chop(bigstr,midend);
4493 Move(little,midend,littlelen,char);
4496 sv_chop(bigstr,midend);
4502 =for apidoc sv_replace
4504 Make the first argument a copy of the second, then delete the original.
4505 The target SV physically takes over ownership of the body of the source SV
4506 and inherits its flags; however, the target keeps any magic it owns,
4507 and any magic in the source is discarded.
4508 Note that this is a rather specialist SV copying operation; most of the
4509 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4515 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4517 const U32 refcnt = SvREFCNT(sv);
4518 SV_CHECK_THINKFIRST_COW_DROP(sv);
4519 if (SvREFCNT(nsv) != 1) {
4520 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4521 UVuf " != 1)", (UV) SvREFCNT(nsv));
4523 if (SvMAGICAL(sv)) {
4527 sv_upgrade(nsv, SVt_PVMG);
4528 SvMAGIC_set(nsv, SvMAGIC(sv));
4529 SvFLAGS(nsv) |= SvMAGICAL(sv);
4531 SvMAGIC_set(sv, NULL);
4535 assert(!SvREFCNT(sv));
4536 #ifdef DEBUG_LEAKING_SCALARS
4537 sv->sv_flags = nsv->sv_flags;
4538 sv->sv_any = nsv->sv_any;
4539 sv->sv_refcnt = nsv->sv_refcnt;
4540 sv->sv_u = nsv->sv_u;
4542 StructCopy(nsv,sv,SV);
4544 /* Currently could join these into one piece of pointer arithmetic, but
4545 it would be unclear. */
4546 if(SvTYPE(sv) == SVt_IV)
4548 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4549 else if (SvTYPE(sv) == SVt_RV) {
4550 SvANY(sv) = &sv->sv_u.svu_rv;
4554 #ifdef PERL_OLD_COPY_ON_WRITE
4555 if (SvIsCOW_normal(nsv)) {
4556 /* We need to follow the pointers around the loop to make the
4557 previous SV point to sv, rather than nsv. */
4560 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4563 assert(SvPVX_const(current) == SvPVX_const(nsv));
4565 /* Make the SV before us point to the SV after us. */
4567 PerlIO_printf(Perl_debug_log, "previous is\n");
4569 PerlIO_printf(Perl_debug_log,
4570 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4571 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4573 SV_COW_NEXT_SV_SET(current, sv);
4576 SvREFCNT(sv) = refcnt;
4577 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4583 =for apidoc sv_clear
4585 Clear an SV: call any destructors, free up any memory used by the body,
4586 and free the body itself. The SV's head is I<not> freed, although
4587 its type is set to all 1's so that it won't inadvertently be assumed
4588 to be live during global destruction etc.
4589 This function should only be called when REFCNT is zero. Most of the time
4590 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4597 Perl_sv_clear(pTHX_ register SV *sv)
4600 const U32 type = SvTYPE(sv);
4601 const struct body_details *const sv_type_details
4602 = bodies_by_type + type;
4605 assert(SvREFCNT(sv) == 0);
4611 if (PL_defstash) { /* Still have a symbol table? */
4616 stash = SvSTASH(sv);
4617 destructor = StashHANDLER(stash,DESTROY);
4619 SV* const tmpref = newRV(sv);
4620 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4622 PUSHSTACKi(PERLSI_DESTROY);
4627 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4633 if(SvREFCNT(tmpref) < 2) {
4634 /* tmpref is not kept alive! */
4636 SvRV_set(tmpref, NULL);
4639 SvREFCNT_dec(tmpref);
4641 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4645 if (PL_in_clean_objs)
4646 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4648 /* DESTROY gave object new lease on life */
4654 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4655 SvOBJECT_off(sv); /* Curse the object. */
4656 if (type != SVt_PVIO)
4657 --PL_sv_objcount; /* XXX Might want something more general */
4660 if (type >= SVt_PVMG) {
4663 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4664 SvREFCNT_dec(SvSTASH(sv));
4669 IoIFP(sv) != PerlIO_stdin() &&
4670 IoIFP(sv) != PerlIO_stdout() &&
4671 IoIFP(sv) != PerlIO_stderr())
4673 io_close((IO*)sv, FALSE);
4675 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4676 PerlDir_close(IoDIRP(sv));
4677 IoDIRP(sv) = (DIR*)NULL;
4678 Safefree(IoTOP_NAME(sv));
4679 Safefree(IoFMT_NAME(sv));
4680 Safefree(IoBOTTOM_NAME(sv));
4695 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4696 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4697 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4698 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4700 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4701 SvREFCNT_dec(LvTARG(sv));
4705 Safefree(GvNAME(sv));
4706 /* If we're in a stash, we don't own a reference to it. However it does
4707 have a back reference to us, which needs to be cleared. */
4709 sv_del_backref((SV*)GvSTASH(sv), sv);
4714 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4716 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4717 /* Don't even bother with turning off the OOK flag. */
4722 SV *target = SvRV(sv);
4724 sv_del_backref(target, sv);
4726 SvREFCNT_dec(target);
4728 #ifdef PERL_OLD_COPY_ON_WRITE
4729 else if (SvPVX_const(sv)) {
4731 /* I believe I need to grab the global SV mutex here and
4732 then recheck the COW status. */
4734 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4737 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4738 SV_COW_NEXT_SV(sv));
4739 /* And drop it here. */
4741 } else if (SvLEN(sv)) {
4742 Safefree(SvPVX_const(sv));
4746 else if (SvPVX_const(sv) && SvLEN(sv))
4747 Safefree(SvPVX_mutable(sv));
4748 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4749 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4758 SvFLAGS(sv) &= SVf_BREAK;
4759 SvFLAGS(sv) |= SVTYPEMASK;
4761 if (sv_type_details->arena) {
4762 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4763 &PL_body_roots[type]);
4765 else if (sv_type_details->size) {
4766 my_safefree(SvANY(sv));
4771 =for apidoc sv_newref
4773 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4780 Perl_sv_newref(pTHX_ SV *sv)
4790 Decrement an SV's reference count, and if it drops to zero, call
4791 C<sv_clear> to invoke destructors and free up any memory used by
4792 the body; finally, deallocate the SV's head itself.
4793 Normally called via a wrapper macro C<SvREFCNT_dec>.
4799 Perl_sv_free(pTHX_ SV *sv)
4804 if (SvREFCNT(sv) == 0) {
4805 if (SvFLAGS(sv) & SVf_BREAK)
4806 /* this SV's refcnt has been artificially decremented to
4807 * trigger cleanup */
4809 if (PL_in_clean_all) /* All is fair */
4811 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4812 /* make sure SvREFCNT(sv)==0 happens very seldom */
4813 SvREFCNT(sv) = (~(U32)0)/2;
4816 if (ckWARN_d(WARN_INTERNAL)) {
4817 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4818 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4819 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4820 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4821 Perl_dump_sv_child(aTHX_ sv);
4826 if (--(SvREFCNT(sv)) > 0)
4828 Perl_sv_free2(aTHX_ sv);
4832 Perl_sv_free2(pTHX_ SV *sv)
4837 if (ckWARN_d(WARN_DEBUGGING))
4838 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4839 "Attempt to free temp prematurely: SV 0x%"UVxf
4840 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4844 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4845 /* make sure SvREFCNT(sv)==0 happens very seldom */
4846 SvREFCNT(sv) = (~(U32)0)/2;
4857 Returns the length of the string in the SV. Handles magic and type
4858 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4864 Perl_sv_len(pTHX_ register SV *sv)
4872 len = mg_length(sv);
4874 (void)SvPV_const(sv, len);
4879 =for apidoc sv_len_utf8
4881 Returns the number of characters in the string in an SV, counting wide
4882 UTF-8 bytes as a single character. Handles magic and type coercion.
4888 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4889 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4890 * (Note that the mg_len is not the length of the mg_ptr field.)
4895 Perl_sv_len_utf8(pTHX_ register SV *sv)
4901 return mg_length(sv);
4905 const U8 *s = (U8*)SvPV_const(sv, len);
4906 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4908 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4910 #ifdef PERL_UTF8_CACHE_ASSERT
4911 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4915 ulen = Perl_utf8_length(aTHX_ s, s + len);
4916 if (!mg && !SvREADONLY(sv)) {
4917 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4918 mg = mg_find(sv, PERL_MAGIC_utf8);
4928 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4929 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4930 * between UTF-8 and byte offsets. There are two (substr offset and substr
4931 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4932 * and byte offset) cache positions.
4934 * The mg_len field is used by sv_len_utf8(), see its comments.
4935 * Note that the mg_len is not the length of the mg_ptr field.
4939 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4940 I32 offsetp, const U8 *s, const U8 *start)
4944 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4946 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4950 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4952 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4953 (*mgp)->mg_ptr = (char *) *cachep;
4957 (*cachep)[i] = offsetp;
4958 (*cachep)[i+1] = s - start;
4966 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4967 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4968 * between UTF-8 and byte offsets. See also the comments of
4969 * S_utf8_mg_pos_init().
4973 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)
4977 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4979 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4980 if (*mgp && (*mgp)->mg_ptr) {
4981 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4982 ASSERT_UTF8_CACHE(*cachep);
4983 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4985 else { /* We will skip to the right spot. */
4990 /* The assumption is that going backward is half
4991 * the speed of going forward (that's where the
4992 * 2 * backw in the below comes from). (The real
4993 * figure of course depends on the UTF-8 data.) */
4995 if ((*cachep)[i] > (STRLEN)uoff) {
4997 backw = (*cachep)[i] - (STRLEN)uoff;
4999 if (forw < 2 * backw)
5002 p = start + (*cachep)[i+1];
5004 /* Try this only for the substr offset (i == 0),
5005 * not for the substr length (i == 2). */
5006 else if (i == 0) { /* (*cachep)[i] < uoff */
5007 const STRLEN ulen = sv_len_utf8(sv);
5009 if ((STRLEN)uoff < ulen) {
5010 forw = (STRLEN)uoff - (*cachep)[i];
5011 backw = ulen - (STRLEN)uoff;
5013 if (forw < 2 * backw)
5014 p = start + (*cachep)[i+1];
5019 /* If the string is not long enough for uoff,
5020 * we could extend it, but not at this low a level. */
5024 if (forw < 2 * backw) {
5031 while (UTF8_IS_CONTINUATION(*p))
5036 /* Update the cache. */
5037 (*cachep)[i] = (STRLEN)uoff;
5038 (*cachep)[i+1] = p - start;
5040 /* Drop the stale "length" cache */
5049 if (found) { /* Setup the return values. */
5050 *offsetp = (*cachep)[i+1];
5051 *sp = start + *offsetp;
5054 *offsetp = send - start;
5056 else if (*sp < start) {
5062 #ifdef PERL_UTF8_CACHE_ASSERT
5067 while (n-- && s < send)
5071 assert(*offsetp == s - start);
5072 assert((*cachep)[0] == (STRLEN)uoff);
5073 assert((*cachep)[1] == *offsetp);
5075 ASSERT_UTF8_CACHE(*cachep);
5084 =for apidoc sv_pos_u2b
5086 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5087 the start of the string, to a count of the equivalent number of bytes; if
5088 lenp is non-zero, it does the same to lenp, but this time starting from
5089 the offset, rather than from the start of the string. Handles magic and
5096 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5097 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5098 * byte offsets. See also the comments of S_utf8_mg_pos().
5103 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5111 start = (U8*)SvPV_const(sv, len);
5115 const U8 *s = start;
5116 I32 uoffset = *offsetp;
5117 const U8 * const send = s + len;
5121 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5123 if (!found && uoffset > 0) {
5124 while (s < send && uoffset--)
5128 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5130 *offsetp = s - start;
5135 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5139 if (!found && *lenp > 0) {
5142 while (s < send && ulen--)
5146 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5150 ASSERT_UTF8_CACHE(cache);
5162 =for apidoc sv_pos_b2u
5164 Converts the value pointed to by offsetp from a count of bytes from the
5165 start of the string, to a count of the equivalent number of UTF-8 chars.
5166 Handles magic and type coercion.
5172 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5173 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5174 * byte offsets. See also the comments of S_utf8_mg_pos().
5179 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5187 s = (const U8*)SvPV_const(sv, len);
5188 if ((I32)len < *offsetp)
5189 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5191 const U8* send = s + *offsetp;
5193 STRLEN *cache = NULL;
5197 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5198 mg = mg_find(sv, PERL_MAGIC_utf8);
5199 if (mg && mg->mg_ptr) {
5200 cache = (STRLEN *) mg->mg_ptr;
5201 if (cache[1] == (STRLEN)*offsetp) {
5202 /* An exact match. */
5203 *offsetp = cache[0];
5207 else if (cache[1] < (STRLEN)*offsetp) {
5208 /* We already know part of the way. */
5211 /* Let the below loop do the rest. */
5213 else { /* cache[1] > *offsetp */
5214 /* We already know all of the way, now we may
5215 * be able to walk back. The same assumption
5216 * is made as in S_utf8_mg_pos(), namely that
5217 * walking backward is twice slower than
5218 * walking forward. */
5219 const STRLEN forw = *offsetp;
5220 STRLEN backw = cache[1] - *offsetp;
5222 if (!(forw < 2 * backw)) {
5223 const U8 *p = s + cache[1];
5230 while (UTF8_IS_CONTINUATION(*p)) {
5238 *offsetp = cache[0];
5240 /* Drop the stale "length" cache */
5248 ASSERT_UTF8_CACHE(cache);
5254 /* Call utf8n_to_uvchr() to validate the sequence
5255 * (unless a simple non-UTF character) */
5256 if (!UTF8_IS_INVARIANT(*s))
5257 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5266 if (!SvREADONLY(sv)) {
5268 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5269 mg = mg_find(sv, PERL_MAGIC_utf8);
5274 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5275 mg->mg_ptr = (char *) cache;
5280 cache[1] = *offsetp;
5281 /* Drop the stale "length" cache */
5294 Returns a boolean indicating whether the strings in the two SVs are
5295 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5296 coerce its args to strings if necessary.
5302 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5310 SV* svrecode = Nullsv;
5317 pv1 = SvPV_const(sv1, cur1);
5324 pv2 = SvPV_const(sv2, cur2);
5326 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5327 /* Differing utf8ness.
5328 * Do not UTF8size the comparands as a side-effect. */
5331 svrecode = newSVpvn(pv2, cur2);
5332 sv_recode_to_utf8(svrecode, PL_encoding);
5333 pv2 = SvPV_const(svrecode, cur2);
5336 svrecode = newSVpvn(pv1, cur1);
5337 sv_recode_to_utf8(svrecode, PL_encoding);
5338 pv1 = SvPV_const(svrecode, cur1);
5340 /* Now both are in UTF-8. */
5342 SvREFCNT_dec(svrecode);
5347 bool is_utf8 = TRUE;
5350 /* sv1 is the UTF-8 one,
5351 * if is equal it must be downgrade-able */
5352 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5358 /* sv2 is the UTF-8 one,
5359 * if is equal it must be downgrade-able */
5360 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5366 /* Downgrade not possible - cannot be eq */
5374 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5377 SvREFCNT_dec(svrecode);
5388 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5389 string in C<sv1> is less than, equal to, or greater than the string in
5390 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5391 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5397 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5400 const char *pv1, *pv2;
5403 SV *svrecode = Nullsv;
5410 pv1 = SvPV_const(sv1, cur1);
5417 pv2 = SvPV_const(sv2, cur2);
5419 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5420 /* Differing utf8ness.
5421 * Do not UTF8size the comparands as a side-effect. */
5424 svrecode = newSVpvn(pv2, cur2);
5425 sv_recode_to_utf8(svrecode, PL_encoding);
5426 pv2 = SvPV_const(svrecode, cur2);
5429 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5434 svrecode = newSVpvn(pv1, cur1);
5435 sv_recode_to_utf8(svrecode, PL_encoding);
5436 pv1 = SvPV_const(svrecode, cur1);
5439 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5445 cmp = cur2 ? -1 : 0;
5449 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5452 cmp = retval < 0 ? -1 : 1;
5453 } else if (cur1 == cur2) {
5456 cmp = cur1 < cur2 ? -1 : 1;
5461 SvREFCNT_dec(svrecode);
5470 =for apidoc sv_cmp_locale
5472 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5473 'use bytes' aware, handles get magic, and will coerce its args to strings
5474 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5480 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5482 #ifdef USE_LOCALE_COLLATE
5488 if (PL_collation_standard)
5492 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5494 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5496 if (!pv1 || !len1) {
5507 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5510 return retval < 0 ? -1 : 1;
5513 * When the result of collation is equality, that doesn't mean
5514 * that there are no differences -- some locales exclude some
5515 * characters from consideration. So to avoid false equalities,
5516 * we use the raw string as a tiebreaker.
5522 #endif /* USE_LOCALE_COLLATE */
5524 return sv_cmp(sv1, sv2);
5528 #ifdef USE_LOCALE_COLLATE
5531 =for apidoc sv_collxfrm
5533 Add Collate Transform magic to an SV if it doesn't already have it.
5535 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5536 scalar data of the variable, but transformed to such a format that a normal
5537 memory comparison can be used to compare the data according to the locale
5544 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5548 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5549 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5555 Safefree(mg->mg_ptr);
5556 s = SvPV_const(sv, len);
5557 if ((xf = mem_collxfrm(s, len, &xlen))) {
5558 if (SvREADONLY(sv)) {
5561 return xf + sizeof(PL_collation_ix);
5564 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5565 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5578 if (mg && mg->mg_ptr) {
5580 return mg->mg_ptr + sizeof(PL_collation_ix);
5588 #endif /* USE_LOCALE_COLLATE */
5593 Get a line from the filehandle and store it into the SV, optionally
5594 appending to the currently-stored string.
5600 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5604 register STDCHAR rslast;
5605 register STDCHAR *bp;
5611 if (SvTHINKFIRST(sv))
5612 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5613 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5615 However, perlbench says it's slower, because the existing swipe code
5616 is faster than copy on write.
5617 Swings and roundabouts. */
5618 SvUPGRADE(sv, SVt_PV);
5623 if (PerlIO_isutf8(fp)) {
5625 sv_utf8_upgrade_nomg(sv);
5626 sv_pos_u2b(sv,&append,0);
5628 } else if (SvUTF8(sv)) {
5629 SV * const tsv = NEWSV(0,0);
5630 sv_gets(tsv, fp, 0);
5631 sv_utf8_upgrade_nomg(tsv);
5632 SvCUR_set(sv,append);
5635 goto return_string_or_null;
5640 if (PerlIO_isutf8(fp))
5643 if (IN_PERL_COMPILETIME) {
5644 /* we always read code in line mode */
5648 else if (RsSNARF(PL_rs)) {
5649 /* If it is a regular disk file use size from stat() as estimate
5650 of amount we are going to read - may result in malloc-ing
5651 more memory than we realy need if layers bellow reduce
5652 size we read (e.g. CRLF or a gzip layer)
5655 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5656 const Off_t offset = PerlIO_tell(fp);
5657 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5658 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5664 else if (RsRECORD(PL_rs)) {
5668 /* Grab the size of the record we're getting */
5669 recsize = SvIV(SvRV(PL_rs));
5670 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5673 /* VMS wants read instead of fread, because fread doesn't respect */
5674 /* RMS record boundaries. This is not necessarily a good thing to be */
5675 /* doing, but we've got no other real choice - except avoid stdio
5676 as implementation - perhaps write a :vms layer ?
5678 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5680 bytesread = PerlIO_read(fp, buffer, recsize);
5684 SvCUR_set(sv, bytesread += append);
5685 buffer[bytesread] = '\0';
5686 goto return_string_or_null;
5688 else if (RsPARA(PL_rs)) {
5694 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5695 if (PerlIO_isutf8(fp)) {
5696 rsptr = SvPVutf8(PL_rs, rslen);
5699 if (SvUTF8(PL_rs)) {
5700 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5701 Perl_croak(aTHX_ "Wide character in $/");
5704 rsptr = SvPV_const(PL_rs, rslen);
5708 rslast = rslen ? rsptr[rslen - 1] : '\0';
5710 if (rspara) { /* have to do this both before and after */
5711 do { /* to make sure file boundaries work right */
5714 i = PerlIO_getc(fp);
5718 PerlIO_ungetc(fp,i);
5724 /* See if we know enough about I/O mechanism to cheat it ! */
5726 /* This used to be #ifdef test - it is made run-time test for ease
5727 of abstracting out stdio interface. One call should be cheap
5728 enough here - and may even be a macro allowing compile
5732 if (PerlIO_fast_gets(fp)) {
5735 * We're going to steal some values from the stdio struct
5736 * and put EVERYTHING in the innermost loop into registers.
5738 register STDCHAR *ptr;
5742 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5743 /* An ungetc()d char is handled separately from the regular
5744 * buffer, so we getc() it back out and stuff it in the buffer.
5746 i = PerlIO_getc(fp);
5747 if (i == EOF) return 0;
5748 *(--((*fp)->_ptr)) = (unsigned char) i;
5752 /* Here is some breathtakingly efficient cheating */
5754 cnt = PerlIO_get_cnt(fp); /* get count into register */
5755 /* make sure we have the room */
5756 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5757 /* Not room for all of it
5758 if we are looking for a separator and room for some
5760 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5761 /* just process what we have room for */
5762 shortbuffered = cnt - SvLEN(sv) + append + 1;
5763 cnt -= shortbuffered;
5767 /* remember that cnt can be negative */
5768 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5773 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5774 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5775 DEBUG_P(PerlIO_printf(Perl_debug_log,
5776 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5777 DEBUG_P(PerlIO_printf(Perl_debug_log,
5778 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5779 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5780 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5785 while (cnt > 0) { /* this | eat */
5787 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5788 goto thats_all_folks; /* screams | sed :-) */
5792 Copy(ptr, bp, cnt, char); /* this | eat */
5793 bp += cnt; /* screams | dust */
5794 ptr += cnt; /* louder | sed :-) */
5799 if (shortbuffered) { /* oh well, must extend */
5800 cnt = shortbuffered;
5802 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5804 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5805 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5809 DEBUG_P(PerlIO_printf(Perl_debug_log,
5810 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5811 PTR2UV(ptr),(long)cnt));
5812 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5814 DEBUG_P(PerlIO_printf(Perl_debug_log,
5815 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5816 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5817 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5819 /* This used to call 'filbuf' in stdio form, but as that behaves like
5820 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5821 another abstraction. */
5822 i = PerlIO_getc(fp); /* get more characters */
5824 DEBUG_P(PerlIO_printf(Perl_debug_log,
5825 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5826 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5827 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5829 cnt = PerlIO_get_cnt(fp);
5830 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5831 DEBUG_P(PerlIO_printf(Perl_debug_log,
5832 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5834 if (i == EOF) /* all done for ever? */
5835 goto thats_really_all_folks;
5837 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5839 SvGROW(sv, bpx + cnt + 2);
5840 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5842 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5844 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5845 goto thats_all_folks;
5849 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5850 memNE((char*)bp - rslen, rsptr, rslen))
5851 goto screamer; /* go back to the fray */
5852 thats_really_all_folks:
5854 cnt += shortbuffered;
5855 DEBUG_P(PerlIO_printf(Perl_debug_log,
5856 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5857 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5858 DEBUG_P(PerlIO_printf(Perl_debug_log,
5859 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5860 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5861 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5863 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5864 DEBUG_P(PerlIO_printf(Perl_debug_log,
5865 "Screamer: done, len=%ld, string=|%.*s|\n",
5866 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5870 /*The big, slow, and stupid way. */
5871 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5873 Newx(buf, 8192, STDCHAR);
5881 register const STDCHAR * const bpe = buf + sizeof(buf);
5883 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5884 ; /* keep reading */
5888 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5889 /* Accomodate broken VAXC compiler, which applies U8 cast to
5890 * both args of ?: operator, causing EOF to change into 255
5893 i = (U8)buf[cnt - 1];
5899 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5901 sv_catpvn(sv, (char *) buf, cnt);
5903 sv_setpvn(sv, (char *) buf, cnt);
5905 if (i != EOF && /* joy */
5907 SvCUR(sv) < rslen ||
5908 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5912 * If we're reading from a TTY and we get a short read,
5913 * indicating that the user hit his EOF character, we need
5914 * to notice it now, because if we try to read from the TTY
5915 * again, the EOF condition will disappear.
5917 * The comparison of cnt to sizeof(buf) is an optimization
5918 * that prevents unnecessary calls to feof().
5922 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5926 #ifdef USE_HEAP_INSTEAD_OF_STACK
5931 if (rspara) { /* have to do this both before and after */
5932 while (i != EOF) { /* to make sure file boundaries work right */
5933 i = PerlIO_getc(fp);
5935 PerlIO_ungetc(fp,i);
5941 return_string_or_null:
5942 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5948 Auto-increment of the value in the SV, doing string to numeric conversion
5949 if necessary. Handles 'get' magic.
5955 Perl_sv_inc(pTHX_ register SV *sv)
5963 if (SvTHINKFIRST(sv)) {
5965 sv_force_normal_flags(sv, 0);
5966 if (SvREADONLY(sv)) {
5967 if (IN_PERL_RUNTIME)
5968 Perl_croak(aTHX_ PL_no_modify);
5972 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5974 i = PTR2IV(SvRV(sv));
5979 flags = SvFLAGS(sv);
5980 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5981 /* It's (privately or publicly) a float, but not tested as an
5982 integer, so test it to see. */
5984 flags = SvFLAGS(sv);
5986 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5987 /* It's publicly an integer, or privately an integer-not-float */
5988 #ifdef PERL_PRESERVE_IVUV
5992 if (SvUVX(sv) == UV_MAX)
5993 sv_setnv(sv, UV_MAX_P1);
5995 (void)SvIOK_only_UV(sv);
5996 SvUV_set(sv, SvUVX(sv) + 1);
5998 if (SvIVX(sv) == IV_MAX)
5999 sv_setuv(sv, (UV)IV_MAX + 1);
6001 (void)SvIOK_only(sv);
6002 SvIV_set(sv, SvIVX(sv) + 1);
6007 if (flags & SVp_NOK) {
6008 (void)SvNOK_only(sv);
6009 SvNV_set(sv, SvNVX(sv) + 1.0);
6013 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6014 if ((flags & SVTYPEMASK) < SVt_PVIV)
6015 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6016 (void)SvIOK_only(sv);
6021 while (isALPHA(*d)) d++;
6022 while (isDIGIT(*d)) d++;
6024 #ifdef PERL_PRESERVE_IVUV
6025 /* Got to punt this as an integer if needs be, but we don't issue
6026 warnings. Probably ought to make the sv_iv_please() that does
6027 the conversion if possible, and silently. */
6028 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6029 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6030 /* Need to try really hard to see if it's an integer.
6031 9.22337203685478e+18 is an integer.
6032 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6033 so $a="9.22337203685478e+18"; $a+0; $a++
6034 needs to be the same as $a="9.22337203685478e+18"; $a++
6041 /* sv_2iv *should* have made this an NV */
6042 if (flags & SVp_NOK) {
6043 (void)SvNOK_only(sv);
6044 SvNV_set(sv, SvNVX(sv) + 1.0);
6047 /* I don't think we can get here. Maybe I should assert this
6048 And if we do get here I suspect that sv_setnv will croak. NWC
6050 #if defined(USE_LONG_DOUBLE)
6051 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",
6052 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6054 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6055 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6058 #endif /* PERL_PRESERVE_IVUV */
6059 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6063 while (d >= SvPVX_const(sv)) {
6071 /* MKS: The original code here died if letters weren't consecutive.
6072 * at least it didn't have to worry about non-C locales. The
6073 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6074 * arranged in order (although not consecutively) and that only
6075 * [A-Za-z] are accepted by isALPHA in the C locale.
6077 if (*d != 'z' && *d != 'Z') {
6078 do { ++*d; } while (!isALPHA(*d));
6081 *(d--) -= 'z' - 'a';
6086 *(d--) -= 'z' - 'a' + 1;
6090 /* oh,oh, the number grew */
6091 SvGROW(sv, SvCUR(sv) + 2);
6092 SvCUR_set(sv, SvCUR(sv) + 1);
6093 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6104 Auto-decrement of the value in the SV, doing string to numeric conversion
6105 if necessary. Handles 'get' magic.
6111 Perl_sv_dec(pTHX_ register SV *sv)
6118 if (SvTHINKFIRST(sv)) {
6120 sv_force_normal_flags(sv, 0);
6121 if (SvREADONLY(sv)) {
6122 if (IN_PERL_RUNTIME)
6123 Perl_croak(aTHX_ PL_no_modify);
6127 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6129 i = PTR2IV(SvRV(sv));
6134 /* Unlike sv_inc we don't have to worry about string-never-numbers
6135 and keeping them magic. But we mustn't warn on punting */
6136 flags = SvFLAGS(sv);
6137 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6138 /* It's publicly an integer, or privately an integer-not-float */
6139 #ifdef PERL_PRESERVE_IVUV
6143 if (SvUVX(sv) == 0) {
6144 (void)SvIOK_only(sv);
6148 (void)SvIOK_only_UV(sv);
6149 SvUV_set(sv, SvUVX(sv) - 1);
6152 if (SvIVX(sv) == IV_MIN)
6153 sv_setnv(sv, (NV)IV_MIN - 1.0);
6155 (void)SvIOK_only(sv);
6156 SvIV_set(sv, SvIVX(sv) - 1);
6161 if (flags & SVp_NOK) {
6162 SvNV_set(sv, SvNVX(sv) - 1.0);
6163 (void)SvNOK_only(sv);
6166 if (!(flags & SVp_POK)) {
6167 if ((flags & SVTYPEMASK) < SVt_PVIV)
6168 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6170 (void)SvIOK_only(sv);
6173 #ifdef PERL_PRESERVE_IVUV
6175 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6176 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6177 /* Need to try really hard to see if it's an integer.
6178 9.22337203685478e+18 is an integer.
6179 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6180 so $a="9.22337203685478e+18"; $a+0; $a--
6181 needs to be the same as $a="9.22337203685478e+18"; $a--
6188 /* sv_2iv *should* have made this an NV */
6189 if (flags & SVp_NOK) {
6190 (void)SvNOK_only(sv);
6191 SvNV_set(sv, SvNVX(sv) - 1.0);
6194 /* I don't think we can get here. Maybe I should assert this
6195 And if we do get here I suspect that sv_setnv will croak. NWC
6197 #if defined(USE_LONG_DOUBLE)
6198 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",
6199 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6201 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6202 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6206 #endif /* PERL_PRESERVE_IVUV */
6207 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6211 =for apidoc sv_mortalcopy
6213 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6214 The new SV is marked as mortal. It will be destroyed "soon", either by an
6215 explicit call to FREETMPS, or by an implicit call at places such as
6216 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6221 /* Make a string that will exist for the duration of the expression
6222 * evaluation. Actually, it may have to last longer than that, but
6223 * hopefully we won't free it until it has been assigned to a
6224 * permanent location. */
6227 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6232 sv_setsv(sv,oldstr);
6234 PL_tmps_stack[++PL_tmps_ix] = sv;
6240 =for apidoc sv_newmortal
6242 Creates a new null SV which is mortal. The reference count of the SV is
6243 set to 1. It will be destroyed "soon", either by an explicit call to
6244 FREETMPS, or by an implicit call at places such as statement boundaries.
6245 See also C<sv_mortalcopy> and C<sv_2mortal>.
6251 Perl_sv_newmortal(pTHX)
6256 SvFLAGS(sv) = SVs_TEMP;
6258 PL_tmps_stack[++PL_tmps_ix] = sv;
6263 =for apidoc sv_2mortal
6265 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6266 by an explicit call to FREETMPS, or by an implicit call at places such as
6267 statement boundaries. SvTEMP() is turned on which means that the SV's
6268 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6269 and C<sv_mortalcopy>.
6275 Perl_sv_2mortal(pTHX_ register SV *sv)
6280 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6283 PL_tmps_stack[++PL_tmps_ix] = sv;
6291 Creates a new SV and copies a string into it. The reference count for the
6292 SV is set to 1. If C<len> is zero, Perl will compute the length using
6293 strlen(). For efficiency, consider using C<newSVpvn> instead.
6299 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6304 sv_setpvn(sv,s,len ? len : strlen(s));
6309 =for apidoc newSVpvn
6311 Creates a new SV and copies a string into it. The reference count for the
6312 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6313 string. You are responsible for ensuring that the source string is at least
6314 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6320 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6325 sv_setpvn(sv,s,len);
6331 =for apidoc newSVhek
6333 Creates a new SV from the hash key structure. It will generate scalars that
6334 point to the shared string table where possible. Returns a new (undefined)
6335 SV if the hek is NULL.
6341 Perl_newSVhek(pTHX_ const HEK *hek)
6350 if (HEK_LEN(hek) == HEf_SVKEY) {
6351 return newSVsv(*(SV**)HEK_KEY(hek));
6353 const int flags = HEK_FLAGS(hek);
6354 if (flags & HVhek_WASUTF8) {
6356 Andreas would like keys he put in as utf8 to come back as utf8
6358 STRLEN utf8_len = HEK_LEN(hek);
6359 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6360 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6363 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6365 } else if (flags & HVhek_REHASH) {
6366 /* We don't have a pointer to the hv, so we have to replicate the
6367 flag into every HEK. This hv is using custom a hasing
6368 algorithm. Hence we can't return a shared string scalar, as
6369 that would contain the (wrong) hash value, and might get passed
6370 into an hv routine with a regular hash */
6372 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6377 /* This will be overwhelminly the most common case. */
6378 return newSVpvn_share(HEK_KEY(hek),
6379 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6385 =for apidoc newSVpvn_share
6387 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6388 table. If the string does not already exist in the table, it is created
6389 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6390 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6391 otherwise the hash is computed. The idea here is that as the string table
6392 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6393 hash lookup will avoid string compare.
6399 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6402 bool is_utf8 = FALSE;
6404 STRLEN tmplen = -len;
6406 /* See the note in hv.c:hv_fetch() --jhi */
6407 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6411 PERL_HASH(hash, src, len);
6413 sv_upgrade(sv, SVt_PV);
6414 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6426 #if defined(PERL_IMPLICIT_CONTEXT)
6428 /* pTHX_ magic can't cope with varargs, so this is a no-context
6429 * version of the main function, (which may itself be aliased to us).
6430 * Don't access this version directly.
6434 Perl_newSVpvf_nocontext(const char* pat, ...)
6439 va_start(args, pat);
6440 sv = vnewSVpvf(pat, &args);
6447 =for apidoc newSVpvf
6449 Creates a new SV and initializes it with the string formatted like
6456 Perl_newSVpvf(pTHX_ const char* pat, ...)
6460 va_start(args, pat);
6461 sv = vnewSVpvf(pat, &args);
6466 /* backend for newSVpvf() and newSVpvf_nocontext() */
6469 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6473 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6480 Creates a new SV and copies a floating point value into it.
6481 The reference count for the SV is set to 1.
6487 Perl_newSVnv(pTHX_ NV n)
6499 Creates a new SV and copies an integer into it. The reference count for the
6506 Perl_newSViv(pTHX_ IV i)
6518 Creates a new SV and copies an unsigned integer into it.
6519 The reference count for the SV is set to 1.
6525 Perl_newSVuv(pTHX_ UV u)
6535 =for apidoc newRV_noinc
6537 Creates an RV wrapper for an SV. The reference count for the original
6538 SV is B<not> incremented.
6544 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6549 sv_upgrade(sv, SVt_RV);
6551 SvRV_set(sv, tmpRef);
6556 /* newRV_inc is the official function name to use now.
6557 * newRV_inc is in fact #defined to newRV in sv.h
6561 Perl_newRV(pTHX_ SV *tmpRef)
6563 return newRV_noinc(SvREFCNT_inc(tmpRef));
6569 Creates a new SV which is an exact duplicate of the original SV.
6576 Perl_newSVsv(pTHX_ register SV *old)
6582 if (SvTYPE(old) == SVTYPEMASK) {
6583 if (ckWARN_d(WARN_INTERNAL))
6584 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6588 /* SV_GMAGIC is the default for sv_setv()
6589 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6590 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6591 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6596 =for apidoc sv_reset
6598 Underlying implementation for the C<reset> Perl function.
6599 Note that the perl-level function is vaguely deprecated.
6605 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6608 char todo[PERL_UCHAR_MAX+1];
6613 if (!*s) { /* reset ?? searches */
6614 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6616 PMOP *pm = (PMOP *) mg->mg_obj;
6618 pm->op_pmdynflags &= ~PMdf_USED;
6625 /* reset variables */
6627 if (!HvARRAY(stash))
6630 Zero(todo, 256, char);
6633 I32 i = (unsigned char)*s;
6637 max = (unsigned char)*s++;
6638 for ( ; i <= max; i++) {
6641 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6643 for (entry = HvARRAY(stash)[i];
6645 entry = HeNEXT(entry))
6650 if (!todo[(U8)*HeKEY(entry)])
6652 gv = (GV*)HeVAL(entry);
6655 if (SvTHINKFIRST(sv)) {
6656 if (!SvREADONLY(sv) && SvROK(sv))
6658 /* XXX Is this continue a bug? Why should THINKFIRST
6659 exempt us from resetting arrays and hashes? */
6663 if (SvTYPE(sv) >= SVt_PV) {
6665 if (SvPVX_const(sv) != Nullch)
6673 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6675 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6678 # if defined(USE_ENVIRON_ARRAY)
6681 # endif /* USE_ENVIRON_ARRAY */
6692 Using various gambits, try to get an IO from an SV: the IO slot if its a
6693 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6694 named after the PV if we're a string.
6700 Perl_sv_2io(pTHX_ SV *sv)
6705 switch (SvTYPE(sv)) {
6713 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6717 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6719 return sv_2io(SvRV(sv));
6720 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6726 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6735 Using various gambits, try to get a CV from an SV; in addition, try if
6736 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6742 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6749 return *gvp = Nullgv, Nullcv;
6750 switch (SvTYPE(sv)) {
6768 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6769 tryAMAGICunDEREF(to_cv);
6772 if (SvTYPE(sv) == SVt_PVCV) {
6781 Perl_croak(aTHX_ "Not a subroutine reference");
6786 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6792 if (lref && !GvCVu(gv)) {
6795 tmpsv = NEWSV(704,0);
6796 gv_efullname3(tmpsv, gv, Nullch);
6797 /* XXX this is probably not what they think they're getting.
6798 * It has the same effect as "sub name;", i.e. just a forward
6800 newSUB(start_subparse(FALSE, 0),
6801 newSVOP(OP_CONST, 0, tmpsv),
6806 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6816 Returns true if the SV has a true value by Perl's rules.
6817 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6818 instead use an in-line version.
6824 Perl_sv_true(pTHX_ register SV *sv)
6829 register const XPV* const tXpv = (XPV*)SvANY(sv);
6831 (tXpv->xpv_cur > 1 ||
6832 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6839 return SvIVX(sv) != 0;
6842 return SvNVX(sv) != 0.0;
6844 return sv_2bool(sv);
6850 =for apidoc sv_pvn_force
6852 Get a sensible string out of the SV somehow.
6853 A private implementation of the C<SvPV_force> macro for compilers which
6854 can't cope with complex macro expressions. Always use the macro instead.
6856 =for apidoc sv_pvn_force_flags
6858 Get a sensible string out of the SV somehow.
6859 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6860 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6861 implemented in terms of this function.
6862 You normally want to use the various wrapper macros instead: see
6863 C<SvPV_force> and C<SvPV_force_nomg>
6869 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6872 if (SvTHINKFIRST(sv) && !SvROK(sv))
6873 sv_force_normal_flags(sv, 0);
6883 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6884 const char * const ref = sv_reftype(sv,0);
6886 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6887 ref, OP_NAME(PL_op));
6889 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6891 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6892 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6894 s = sv_2pv_flags(sv, &len, flags);
6898 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6901 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6902 SvGROW(sv, len + 1);
6903 Move(s,SvPVX(sv),len,char);
6908 SvPOK_on(sv); /* validate pointer */
6910 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6911 PTR2UV(sv),SvPVX_const(sv)));
6914 return SvPVX_mutable(sv);
6918 =for apidoc sv_pvbyten_force
6920 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6926 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6928 sv_pvn_force(sv,lp);
6929 sv_utf8_downgrade(sv,0);
6935 =for apidoc sv_pvutf8n_force
6937 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6943 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6945 sv_pvn_force(sv,lp);
6946 sv_utf8_upgrade(sv);
6952 =for apidoc sv_reftype
6954 Returns a string describing what the SV is a reference to.
6960 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6962 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6963 inside return suggests a const propagation bug in g++. */
6964 if (ob && SvOBJECT(sv)) {
6965 char * const name = HvNAME_get(SvSTASH(sv));
6966 return name ? name : (char *) "__ANON__";
6969 switch (SvTYPE(sv)) {
6986 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6987 /* tied lvalues should appear to be
6988 * scalars for backwards compatitbility */
6989 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6990 ? "SCALAR" : "LVALUE");
6991 case SVt_PVAV: return "ARRAY";
6992 case SVt_PVHV: return "HASH";
6993 case SVt_PVCV: return "CODE";
6994 case SVt_PVGV: return "GLOB";
6995 case SVt_PVFM: return "FORMAT";
6996 case SVt_PVIO: return "IO";
6997 default: return "UNKNOWN";
7003 =for apidoc sv_isobject
7005 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7006 object. If the SV is not an RV, or if the object is not blessed, then this
7013 Perl_sv_isobject(pTHX_ SV *sv)
7029 Returns a boolean indicating whether the SV is blessed into the specified
7030 class. This does not check for subtypes; use C<sv_derived_from> to verify
7031 an inheritance relationship.
7037 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7048 hvname = HvNAME_get(SvSTASH(sv));
7052 return strEQ(hvname, name);
7058 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7059 it will be upgraded to one. If C<classname> is non-null then the new SV will
7060 be blessed in the specified package. The new SV is returned and its
7061 reference count is 1.
7067 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7073 SV_CHECK_THINKFIRST_COW_DROP(rv);
7076 if (SvTYPE(rv) >= SVt_PVMG) {
7077 const U32 refcnt = SvREFCNT(rv);
7081 SvREFCNT(rv) = refcnt;
7084 if (SvTYPE(rv) < SVt_RV)
7085 sv_upgrade(rv, SVt_RV);
7086 else if (SvTYPE(rv) > SVt_RV) {
7097 HV* const stash = gv_stashpv(classname, TRUE);
7098 (void)sv_bless(rv, stash);
7104 =for apidoc sv_setref_pv
7106 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7107 argument will be upgraded to an RV. That RV will be modified to point to
7108 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7109 into the SV. The C<classname> argument indicates the package for the
7110 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7111 will have a reference count of 1, and the RV will be returned.
7113 Do not use with other Perl types such as HV, AV, SV, CV, because those
7114 objects will become corrupted by the pointer copy process.
7116 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7122 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7125 sv_setsv(rv, &PL_sv_undef);
7129 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7134 =for apidoc sv_setref_iv
7136 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7137 argument will be upgraded to an RV. That RV will be modified to point to
7138 the new SV. The C<classname> argument indicates the package for the
7139 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7140 will have a reference count of 1, and the RV will be returned.
7146 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7148 sv_setiv(newSVrv(rv,classname), iv);
7153 =for apidoc sv_setref_uv
7155 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7156 argument will be upgraded to an RV. That RV will be modified to point to
7157 the new SV. The C<classname> argument indicates the package for the
7158 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7159 will have a reference count of 1, and the RV will be returned.
7165 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7167 sv_setuv(newSVrv(rv,classname), uv);
7172 =for apidoc sv_setref_nv
7174 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7175 argument will be upgraded to an RV. That RV will be modified to point to
7176 the new SV. The C<classname> argument indicates the package for the
7177 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7178 will have a reference count of 1, and the RV will be returned.
7184 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7186 sv_setnv(newSVrv(rv,classname), nv);
7191 =for apidoc sv_setref_pvn
7193 Copies a string into a new SV, optionally blessing the SV. The length of the
7194 string must be specified with C<n>. The C<rv> argument will be upgraded to
7195 an RV. That RV will be modified to point to the new SV. The C<classname>
7196 argument indicates the package for the blessing. Set C<classname> to
7197 C<Nullch> to avoid the blessing. The new SV will have a reference count
7198 of 1, and the RV will be returned.
7200 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7206 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7208 sv_setpvn(newSVrv(rv,classname), pv, n);
7213 =for apidoc sv_bless
7215 Blesses an SV into a specified package. The SV must be an RV. The package
7216 must be designated by its stash (see C<gv_stashpv()>). The reference count
7217 of the SV is unaffected.
7223 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7227 Perl_croak(aTHX_ "Can't bless non-reference value");
7229 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7230 if (SvREADONLY(tmpRef))
7231 Perl_croak(aTHX_ PL_no_modify);
7232 if (SvOBJECT(tmpRef)) {
7233 if (SvTYPE(tmpRef) != SVt_PVIO)
7235 SvREFCNT_dec(SvSTASH(tmpRef));
7238 SvOBJECT_on(tmpRef);
7239 if (SvTYPE(tmpRef) != SVt_PVIO)
7241 SvUPGRADE(tmpRef, SVt_PVMG);
7242 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7249 if(SvSMAGICAL(tmpRef))
7250 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7258 /* Downgrades a PVGV to a PVMG.
7262 S_sv_unglob(pTHX_ SV *sv)
7266 assert(SvTYPE(sv) == SVt_PVGV);
7271 sv_del_backref((SV*)GvSTASH(sv), sv);
7272 GvSTASH(sv) = Nullhv;
7274 sv_unmagic(sv, PERL_MAGIC_glob);
7275 Safefree(GvNAME(sv));
7278 /* need to keep SvANY(sv) in the right arena */
7279 xpvmg = new_XPVMG();
7280 StructCopy(SvANY(sv), xpvmg, XPVMG);
7281 del_XPVGV(SvANY(sv));
7284 SvFLAGS(sv) &= ~SVTYPEMASK;
7285 SvFLAGS(sv) |= SVt_PVMG;
7289 =for apidoc sv_unref_flags
7291 Unsets the RV status of the SV, and decrements the reference count of
7292 whatever was being referenced by the RV. This can almost be thought of
7293 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7294 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7295 (otherwise the decrementing is conditional on the reference count being
7296 different from one or the reference being a readonly SV).
7303 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7305 SV* const target = SvRV(ref);
7307 if (SvWEAKREF(ref)) {
7308 sv_del_backref(target, ref);
7310 SvRV_set(ref, NULL);
7313 SvRV_set(ref, NULL);
7315 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7316 assigned to as BEGIN {$a = \"Foo"} will fail. */
7317 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7318 SvREFCNT_dec(target);
7319 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7320 sv_2mortal(target); /* Schedule for freeing later */
7324 =for apidoc sv_untaint
7326 Untaint an SV. Use C<SvTAINTED_off> instead.
7331 Perl_sv_untaint(pTHX_ SV *sv)
7333 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7334 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7341 =for apidoc sv_tainted
7343 Test an SV for taintedness. Use C<SvTAINTED> instead.
7348 Perl_sv_tainted(pTHX_ SV *sv)
7350 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7351 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7352 if (mg && (mg->mg_len & 1) )
7359 =for apidoc sv_setpviv
7361 Copies an integer into the given SV, also updating its string value.
7362 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7368 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7370 char buf[TYPE_CHARS(UV)];
7372 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7374 sv_setpvn(sv, ptr, ebuf - ptr);
7378 =for apidoc sv_setpviv_mg
7380 Like C<sv_setpviv>, but also handles 'set' magic.
7386 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7392 #if defined(PERL_IMPLICIT_CONTEXT)
7394 /* pTHX_ magic can't cope with varargs, so this is a no-context
7395 * version of the main function, (which may itself be aliased to us).
7396 * Don't access this version directly.
7400 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7404 va_start(args, pat);
7405 sv_vsetpvf(sv, pat, &args);
7409 /* pTHX_ magic can't cope with varargs, so this is a no-context
7410 * version of the main function, (which may itself be aliased to us).
7411 * Don't access this version directly.
7415 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7419 va_start(args, pat);
7420 sv_vsetpvf_mg(sv, pat, &args);
7426 =for apidoc sv_setpvf
7428 Works like C<sv_catpvf> but copies the text into the SV instead of
7429 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7435 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7438 va_start(args, pat);
7439 sv_vsetpvf(sv, pat, &args);
7444 =for apidoc sv_vsetpvf
7446 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7447 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7449 Usually used via its frontend C<sv_setpvf>.
7455 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7457 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7461 =for apidoc sv_setpvf_mg
7463 Like C<sv_setpvf>, but also handles 'set' magic.
7469 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7472 va_start(args, pat);
7473 sv_vsetpvf_mg(sv, pat, &args);
7478 =for apidoc sv_vsetpvf_mg
7480 Like C<sv_vsetpvf>, but also handles 'set' magic.
7482 Usually used via its frontend C<sv_setpvf_mg>.
7488 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7490 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7494 #if defined(PERL_IMPLICIT_CONTEXT)
7496 /* pTHX_ magic can't cope with varargs, so this is a no-context
7497 * version of the main function, (which may itself be aliased to us).
7498 * Don't access this version directly.
7502 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7506 va_start(args, pat);
7507 sv_vcatpvf(sv, pat, &args);
7511 /* pTHX_ magic can't cope with varargs, so this is a no-context
7512 * version of the main function, (which may itself be aliased to us).
7513 * Don't access this version directly.
7517 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7521 va_start(args, pat);
7522 sv_vcatpvf_mg(sv, pat, &args);
7528 =for apidoc sv_catpvf
7530 Processes its arguments like C<sprintf> and appends the formatted
7531 output to an SV. If the appended data contains "wide" characters
7532 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7533 and characters >255 formatted with %c), the original SV might get
7534 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7535 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7536 valid UTF-8; if the original SV was bytes, the pattern should be too.
7541 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7544 va_start(args, pat);
7545 sv_vcatpvf(sv, pat, &args);
7550 =for apidoc sv_vcatpvf
7552 Processes its arguments like C<vsprintf> and appends the formatted output
7553 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7555 Usually used via its frontend C<sv_catpvf>.
7561 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7563 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7567 =for apidoc sv_catpvf_mg
7569 Like C<sv_catpvf>, but also handles 'set' magic.
7575 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7578 va_start(args, pat);
7579 sv_vcatpvf_mg(sv, pat, &args);
7584 =for apidoc sv_vcatpvf_mg
7586 Like C<sv_vcatpvf>, but also handles 'set' magic.
7588 Usually used via its frontend C<sv_catpvf_mg>.
7594 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7596 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7601 =for apidoc sv_vsetpvfn
7603 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7606 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7612 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7614 sv_setpvn(sv, "", 0);
7615 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7618 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7621 S_expect_number(pTHX_ char** pattern)
7624 switch (**pattern) {
7625 case '1': case '2': case '3':
7626 case '4': case '5': case '6':
7627 case '7': case '8': case '9':
7628 var = *(*pattern)++ - '0';
7629 while (isDIGIT(**pattern)) {
7630 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7632 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7638 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7641 F0convert(NV nv, char *endbuf, STRLEN *len)
7643 const int neg = nv < 0;
7652 if (uv & 1 && uv == nv)
7653 uv--; /* Round to even */
7655 const unsigned dig = uv % 10;
7668 =for apidoc sv_vcatpvfn
7670 Processes its arguments like C<vsprintf> and appends the formatted output
7671 to an SV. Uses an array of SVs if the C style variable argument list is
7672 missing (NULL). When running with taint checks enabled, indicates via
7673 C<maybe_tainted> if results are untrustworthy (often due to the use of
7676 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7682 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7683 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7684 vec_utf8 = DO_UTF8(vecsv);
7686 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7689 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7696 static const char nullstr[] = "(null)";
7698 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7699 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7701 /* Times 4: a decimal digit takes more than 3 binary digits.
7702 * NV_DIG: mantissa takes than many decimal digits.
7703 * Plus 32: Playing safe. */
7704 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7705 /* large enough for "%#.#f" --chip */
7706 /* what about long double NVs? --jhi */
7708 PERL_UNUSED_ARG(maybe_tainted);
7710 /* no matter what, this is a string now */
7711 (void)SvPV_force(sv, origlen);
7713 /* special-case "", "%s", and "%-p" (SVf - see below) */
7716 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7718 const char * const s = va_arg(*args, char*);
7719 sv_catpv(sv, s ? s : nullstr);
7721 else if (svix < svmax) {
7722 sv_catsv(sv, *svargs);
7726 if (args && patlen == 3 && pat[0] == '%' &&
7727 pat[1] == '-' && pat[2] == 'p') {
7728 argsv = va_arg(*args, SV*);
7729 sv_catsv(sv, argsv);
7733 #ifndef USE_LONG_DOUBLE
7734 /* special-case "%.<number>[gf]" */
7735 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7736 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7737 unsigned digits = 0;
7741 while (*pp >= '0' && *pp <= '9')
7742 digits = 10 * digits + (*pp++ - '0');
7743 if (pp - pat == (int)patlen - 1) {
7751 /* Add check for digits != 0 because it seems that some
7752 gconverts are buggy in this case, and we don't yet have
7753 a Configure test for this. */
7754 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7755 /* 0, point, slack */
7756 Gconvert(nv, (int)digits, 0, ebuf);
7758 if (*ebuf) /* May return an empty string for digits==0 */
7761 } else if (!digits) {
7764 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7765 sv_catpvn(sv, p, l);
7771 #endif /* !USE_LONG_DOUBLE */
7773 if (!args && svix < svmax && DO_UTF8(*svargs))
7776 patend = (char*)pat + patlen;
7777 for (p = (char*)pat; p < patend; p = q) {
7780 bool vectorize = FALSE;
7781 bool vectorarg = FALSE;
7782 bool vec_utf8 = FALSE;
7788 bool has_precis = FALSE;
7791 bool is_utf8 = FALSE; /* is this item utf8? */
7792 #ifdef HAS_LDBL_SPRINTF_BUG
7793 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7794 with sfio - Allen <allens@cpan.org> */
7795 bool fix_ldbl_sprintf_bug = FALSE;
7799 U8 utf8buf[UTF8_MAXBYTES+1];
7800 STRLEN esignlen = 0;
7802 const char *eptr = Nullch;
7805 const U8 *vecstr = Null(U8*);
7812 /* we need a long double target in case HAS_LONG_DOUBLE but
7815 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7823 const char *dotstr = ".";
7824 STRLEN dotstrlen = 1;
7825 I32 efix = 0; /* explicit format parameter index */
7826 I32 ewix = 0; /* explicit width index */
7827 I32 epix = 0; /* explicit precision index */
7828 I32 evix = 0; /* explicit vector index */
7829 bool asterisk = FALSE;
7831 /* echo everything up to the next format specification */
7832 for (q = p; q < patend && *q != '%'; ++q) ;
7834 if (has_utf8 && !pat_utf8)
7835 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7837 sv_catpvn(sv, p, q - p);
7844 We allow format specification elements in this order:
7845 \d+\$ explicit format parameter index
7847 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7848 0 flag (as above): repeated to allow "v02"
7849 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7850 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7852 [%bcdefginopsuxDFOUX] format (mandatory)
7857 As of perl5.9.3, printf format checking is on by default.
7858 Internally, perl uses %p formats to provide an escape to
7859 some extended formatting. This block deals with those
7860 extensions: if it does not match, (char*)q is reset and
7861 the normal format processing code is used.
7863 Currently defined extensions are:
7864 %p include pointer address (standard)
7865 %-p (SVf) include an SV (previously %_)
7866 %-<num>p include an SV with precision <num>
7867 %1p (VDf) include a v-string (as %vd)
7868 %<num>p reserved for future extensions
7870 Robin Barker 2005-07-14
7877 EXPECT_NUMBER(q, n);
7884 argsv = va_arg(*args, SV*);
7885 eptr = SvPVx_const(argsv, elen);
7891 else if (n == vdNUMBER) { /* VDf */
7898 if (ckWARN_d(WARN_INTERNAL))
7899 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7900 "internal %%<num>p might conflict with future printf extensions");
7906 if (EXPECT_NUMBER(q, width)) {
7947 if (EXPECT_NUMBER(q, ewix))
7956 if ((vectorarg = asterisk)) {
7969 EXPECT_NUMBER(q, width);
7975 vecsv = va_arg(*args, SV*);
7977 vecsv = (evix > 0 && evix <= svmax)
7978 ? svargs[evix-1] : &PL_sv_undef;
7980 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7982 dotstr = SvPV_const(vecsv, dotstrlen);
7983 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7984 bad with tied or overloaded values that return UTF8. */
7987 else if (has_utf8) {
7988 vecsv = sv_mortalcopy(vecsv);
7989 sv_utf8_upgrade(vecsv);
7990 dotstr = SvPV_const(vecsv, dotstrlen);
7997 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
7998 vecsv = svargs[efix ? efix-1 : svix++];
7999 vecstr = (U8*)SvPV_const(vecsv,veclen);
8000 vec_utf8 = DO_UTF8(vecsv);
8001 /* if this is a version object, we need to return the
8002 * stringified representation (which the SvPVX_const has
8003 * already done for us), but not vectorize the args
8005 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8007 q++; /* skip past the rest of the %vd format */
8008 eptr = (const char *) vecstr;
8010 if (elen && *eptr == 'v') {
8026 i = va_arg(*args, int);
8028 i = (ewix ? ewix <= svmax : svix < svmax) ?
8029 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8031 width = (i < 0) ? -i : i;
8041 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8043 /* XXX: todo, support specified precision parameter */
8047 i = va_arg(*args, int);
8049 i = (ewix ? ewix <= svmax : svix < svmax)
8050 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8051 precis = (i < 0) ? 0 : i;
8056 precis = precis * 10 + (*q++ - '0');
8065 case 'I': /* Ix, I32x, and I64x */
8067 if (q[1] == '6' && q[2] == '4') {
8073 if (q[1] == '3' && q[2] == '2') {
8083 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8094 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8095 if (*(q + 1) == 'l') { /* lld, llf */
8121 if (!vectorize && !args) {
8123 const I32 i = efix-1;
8124 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8126 argsv = (svix >= 0 && svix < svmax)
8127 ? svargs[svix++] : &PL_sv_undef;
8138 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8140 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8142 eptr = (char*)utf8buf;
8143 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8157 eptr = va_arg(*args, char*);
8159 #ifdef MACOS_TRADITIONAL
8160 /* On MacOS, %#s format is used for Pascal strings */
8165 elen = strlen(eptr);
8167 eptr = (char *)nullstr;
8168 elen = sizeof nullstr - 1;
8172 eptr = SvPVx_const(argsv, elen);
8173 if (DO_UTF8(argsv)) {
8174 if (has_precis && precis < elen) {
8176 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8179 if (width) { /* fudge width (can't fudge elen) */
8180 width += elen - sv_len_utf8(argsv);
8187 if (has_precis && elen > precis)
8194 if (alt || vectorize)
8196 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8217 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8226 esignbuf[esignlen++] = plus;
8230 case 'h': iv = (short)va_arg(*args, int); break;
8231 case 'l': iv = va_arg(*args, long); break;
8232 case 'V': iv = va_arg(*args, IV); break;
8233 default: iv = va_arg(*args, int); break;
8235 case 'q': iv = va_arg(*args, Quad_t); break;
8240 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8242 case 'h': iv = (short)tiv; break;
8243 case 'l': iv = (long)tiv; break;
8245 default: iv = tiv; break;
8247 case 'q': iv = (Quad_t)tiv; break;
8251 if ( !vectorize ) /* we already set uv above */
8256 esignbuf[esignlen++] = plus;
8260 esignbuf[esignlen++] = '-';
8303 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8314 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8315 case 'l': uv = va_arg(*args, unsigned long); break;
8316 case 'V': uv = va_arg(*args, UV); break;
8317 default: uv = va_arg(*args, unsigned); break;
8319 case 'q': uv = va_arg(*args, Uquad_t); break;
8324 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8326 case 'h': uv = (unsigned short)tuv; break;
8327 case 'l': uv = (unsigned long)tuv; break;
8329 default: uv = tuv; break;
8331 case 'q': uv = (Uquad_t)tuv; break;
8338 char *ptr = ebuf + sizeof ebuf;
8344 p = (char*)((c == 'X')
8345 ? "0123456789ABCDEF" : "0123456789abcdef");
8351 esignbuf[esignlen++] = '0';
8352 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8360 if (alt && *ptr != '0')
8371 esignbuf[esignlen++] = '0';
8372 esignbuf[esignlen++] = 'b';
8375 default: /* it had better be ten or less */
8379 } while (uv /= base);
8382 elen = (ebuf + sizeof ebuf) - ptr;
8386 zeros = precis - elen;
8387 else if (precis == 0 && elen == 1 && *eptr == '0')
8393 /* FLOATING POINT */
8396 c = 'f'; /* maybe %F isn't supported here */
8404 /* This is evil, but floating point is even more evil */
8406 /* for SV-style calling, we can only get NV
8407 for C-style calling, we assume %f is double;
8408 for simplicity we allow any of %Lf, %llf, %qf for long double
8412 #if defined(USE_LONG_DOUBLE)
8416 /* [perl #20339] - we should accept and ignore %lf rather than die */
8420 #if defined(USE_LONG_DOUBLE)
8421 intsize = args ? 0 : 'q';
8425 #if defined(HAS_LONG_DOUBLE)
8434 /* now we need (long double) if intsize == 'q', else (double) */
8436 #if LONG_DOUBLESIZE > DOUBLESIZE
8438 va_arg(*args, long double) :
8439 va_arg(*args, double)
8441 va_arg(*args, double)
8446 if (c != 'e' && c != 'E') {
8448 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8449 will cast our (long double) to (double) */
8450 (void)Perl_frexp(nv, &i);
8451 if (i == PERL_INT_MIN)
8452 Perl_die(aTHX_ "panic: frexp");
8454 need = BIT_DIGITS(i);
8456 need += has_precis ? precis : 6; /* known default */
8461 #ifdef HAS_LDBL_SPRINTF_BUG
8462 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8463 with sfio - Allen <allens@cpan.org> */
8466 # define MY_DBL_MAX DBL_MAX
8467 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8468 # if DOUBLESIZE >= 8
8469 # define MY_DBL_MAX 1.7976931348623157E+308L
8471 # define MY_DBL_MAX 3.40282347E+38L
8475 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8476 # define MY_DBL_MAX_BUG 1L
8478 # define MY_DBL_MAX_BUG MY_DBL_MAX
8482 # define MY_DBL_MIN DBL_MIN
8483 # else /* XXX guessing! -Allen */
8484 # if DOUBLESIZE >= 8
8485 # define MY_DBL_MIN 2.2250738585072014E-308L
8487 # define MY_DBL_MIN 1.17549435E-38L
8491 if ((intsize == 'q') && (c == 'f') &&
8492 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8494 /* it's going to be short enough that
8495 * long double precision is not needed */
8497 if ((nv <= 0L) && (nv >= -0L))
8498 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8500 /* would use Perl_fp_class as a double-check but not
8501 * functional on IRIX - see perl.h comments */
8503 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8504 /* It's within the range that a double can represent */
8505 #if defined(DBL_MAX) && !defined(DBL_MIN)
8506 if ((nv >= ((long double)1/DBL_MAX)) ||
8507 (nv <= (-(long double)1/DBL_MAX)))
8509 fix_ldbl_sprintf_bug = TRUE;
8512 if (fix_ldbl_sprintf_bug == TRUE) {
8522 # undef MY_DBL_MAX_BUG
8525 #endif /* HAS_LDBL_SPRINTF_BUG */
8527 need += 20; /* fudge factor */
8528 if (PL_efloatsize < need) {
8529 Safefree(PL_efloatbuf);
8530 PL_efloatsize = need + 20; /* more fudge */
8531 Newx(PL_efloatbuf, PL_efloatsize, char);
8532 PL_efloatbuf[0] = '\0';
8535 if ( !(width || left || plus || alt) && fill != '0'
8536 && has_precis && intsize != 'q' ) { /* Shortcuts */
8537 /* See earlier comment about buggy Gconvert when digits,
8539 if ( c == 'g' && precis) {
8540 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8541 /* May return an empty string for digits==0 */
8542 if (*PL_efloatbuf) {
8543 elen = strlen(PL_efloatbuf);
8544 goto float_converted;
8546 } else if ( c == 'f' && !precis) {
8547 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8552 char *ptr = ebuf + sizeof ebuf;
8555 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8556 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8557 if (intsize == 'q') {
8558 /* Copy the one or more characters in a long double
8559 * format before the 'base' ([efgEFG]) character to
8560 * the format string. */
8561 static char const prifldbl[] = PERL_PRIfldbl;
8562 char const *p = prifldbl + sizeof(prifldbl) - 3;
8563 while (p >= prifldbl) { *--ptr = *p--; }
8568 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8573 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8585 /* No taint. Otherwise we are in the strange situation
8586 * where printf() taints but print($float) doesn't.
8588 #if defined(HAS_LONG_DOUBLE)
8589 elen = ((intsize == 'q')
8590 ? my_sprintf(PL_efloatbuf, ptr, nv)
8591 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8593 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8597 eptr = PL_efloatbuf;
8605 i = SvCUR(sv) - origlen;
8608 case 'h': *(va_arg(*args, short*)) = i; break;
8609 default: *(va_arg(*args, int*)) = i; break;
8610 case 'l': *(va_arg(*args, long*)) = i; break;
8611 case 'V': *(va_arg(*args, IV*)) = i; break;
8613 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8618 sv_setuv_mg(argsv, (UV)i);
8619 continue; /* not "break" */
8626 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8627 && ckWARN(WARN_PRINTF))
8629 SV * const msg = sv_newmortal();
8630 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8631 (PL_op->op_type == OP_PRTF) ? "" : "s");
8634 Perl_sv_catpvf(aTHX_ msg,
8635 "\"%%%c\"", c & 0xFF);
8637 Perl_sv_catpvf(aTHX_ msg,
8638 "\"%%\\%03"UVof"\"",
8641 sv_catpv(msg, "end of string");
8642 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8645 /* output mangled stuff ... */
8651 /* ... right here, because formatting flags should not apply */
8652 SvGROW(sv, SvCUR(sv) + elen + 1);
8654 Copy(eptr, p, elen, char);
8657 SvCUR_set(sv, p - SvPVX_const(sv));
8659 continue; /* not "break" */
8662 /* calculate width before utf8_upgrade changes it */
8663 have = esignlen + zeros + elen;
8665 Perl_croak_nocontext(PL_memory_wrap);
8667 if (is_utf8 != has_utf8) {
8670 sv_utf8_upgrade(sv);
8673 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8674 sv_utf8_upgrade(nsv);
8675 eptr = SvPVX_const(nsv);
8678 SvGROW(sv, SvCUR(sv) + elen + 1);
8683 need = (have > width ? have : width);
8686 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8687 Perl_croak_nocontext(PL_memory_wrap);
8688 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8690 if (esignlen && fill == '0') {
8692 for (i = 0; i < (int)esignlen; i++)
8696 memset(p, fill, gap);
8699 if (esignlen && fill != '0') {
8701 for (i = 0; i < (int)esignlen; i++)
8706 for (i = zeros; i; i--)
8710 Copy(eptr, p, elen, char);
8714 memset(p, ' ', gap);
8719 Copy(dotstr, p, dotstrlen, char);
8723 vectorize = FALSE; /* done iterating over vecstr */
8730 SvCUR_set(sv, p - SvPVX_const(sv));
8738 /* =========================================================================
8740 =head1 Cloning an interpreter
8742 All the macros and functions in this section are for the private use of
8743 the main function, perl_clone().
8745 The foo_dup() functions make an exact copy of an existing foo thinngy.
8746 During the course of a cloning, a hash table is used to map old addresses
8747 to new addresses. The table is created and manipulated with the
8748 ptr_table_* functions.
8752 ============================================================================*/
8755 #if defined(USE_ITHREADS)
8757 #ifndef GpREFCNT_inc
8758 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8762 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8763 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8764 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8765 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8766 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8767 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8768 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8769 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8770 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8771 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8772 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8773 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8774 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8777 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8778 regcomp.c. AMS 20010712 */
8781 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8786 struct reg_substr_datum *s;
8789 return (REGEXP *)NULL;
8791 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8794 len = r->offsets[0];
8795 npar = r->nparens+1;
8797 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8798 Copy(r->program, ret->program, len+1, regnode);
8800 Newx(ret->startp, npar, I32);
8801 Copy(r->startp, ret->startp, npar, I32);
8802 Newx(ret->endp, npar, I32);
8803 Copy(r->startp, ret->startp, npar, I32);
8805 Newx(ret->substrs, 1, struct reg_substr_data);
8806 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8807 s->min_offset = r->substrs->data[i].min_offset;
8808 s->max_offset = r->substrs->data[i].max_offset;
8809 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8810 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8813 ret->regstclass = NULL;
8816 const int count = r->data->count;
8819 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8820 char, struct reg_data);
8821 Newx(d->what, count, U8);
8824 for (i = 0; i < count; i++) {
8825 d->what[i] = r->data->what[i];
8826 switch (d->what[i]) {
8827 /* legal options are one of: sfpont
8828 see also regcomp.h and pregfree() */
8830 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8833 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8836 /* This is cheating. */
8837 Newx(d->data[i], 1, struct regnode_charclass_class);
8838 StructCopy(r->data->data[i], d->data[i],
8839 struct regnode_charclass_class);
8840 ret->regstclass = (regnode*)d->data[i];
8843 /* Compiled op trees are readonly, and can thus be
8844 shared without duplication. */
8846 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8850 d->data[i] = r->data->data[i];
8853 d->data[i] = r->data->data[i];
8855 ((reg_trie_data*)d->data[i])->refcount++;
8859 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8868 Newx(ret->offsets, 2*len+1, U32);
8869 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8871 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8872 ret->refcnt = r->refcnt;
8873 ret->minlen = r->minlen;
8874 ret->prelen = r->prelen;
8875 ret->nparens = r->nparens;
8876 ret->lastparen = r->lastparen;
8877 ret->lastcloseparen = r->lastcloseparen;
8878 ret->reganch = r->reganch;
8880 ret->sublen = r->sublen;
8882 if (RX_MATCH_COPIED(ret))
8883 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8885 ret->subbeg = Nullch;
8886 #ifdef PERL_OLD_COPY_ON_WRITE
8887 ret->saved_copy = Nullsv;
8890 ptr_table_store(PL_ptr_table, r, ret);
8894 /* duplicate a file handle */
8897 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8901 PERL_UNUSED_ARG(type);
8904 return (PerlIO*)NULL;
8906 /* look for it in the table first */
8907 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8911 /* create anew and remember what it is */
8912 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8913 ptr_table_store(PL_ptr_table, fp, ret);
8917 /* duplicate a directory handle */
8920 Perl_dirp_dup(pTHX_ DIR *dp)
8928 /* duplicate a typeglob */
8931 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8936 /* look for it in the table first */
8937 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8941 /* create anew and remember what it is */
8943 ptr_table_store(PL_ptr_table, gp, ret);
8946 ret->gp_refcnt = 0; /* must be before any other dups! */
8947 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8948 ret->gp_io = io_dup_inc(gp->gp_io, param);
8949 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8950 ret->gp_av = av_dup_inc(gp->gp_av, param);
8951 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8952 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8953 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8954 ret->gp_cvgen = gp->gp_cvgen;
8955 ret->gp_line = gp->gp_line;
8956 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8960 /* duplicate a chain of magic */
8963 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8965 MAGIC *mgprev = (MAGIC*)NULL;
8968 return (MAGIC*)NULL;
8969 /* look for it in the table first */
8970 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8974 for (; mg; mg = mg->mg_moremagic) {
8976 Newxz(nmg, 1, MAGIC);
8978 mgprev->mg_moremagic = nmg;
8981 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8982 nmg->mg_private = mg->mg_private;
8983 nmg->mg_type = mg->mg_type;
8984 nmg->mg_flags = mg->mg_flags;
8985 if (mg->mg_type == PERL_MAGIC_qr) {
8986 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8988 else if(mg->mg_type == PERL_MAGIC_backref) {
8989 const AV * const av = (AV*) mg->mg_obj;
8992 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8994 for (i = AvFILLp(av); i >= 0; i--) {
8995 if (!svp[i]) continue;
8996 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8999 else if (mg->mg_type == PERL_MAGIC_symtab) {
9000 nmg->mg_obj = mg->mg_obj;
9003 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9004 ? sv_dup_inc(mg->mg_obj, param)
9005 : sv_dup(mg->mg_obj, param);
9007 nmg->mg_len = mg->mg_len;
9008 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9009 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9010 if (mg->mg_len > 0) {
9011 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9012 if (mg->mg_type == PERL_MAGIC_overload_table &&
9013 AMT_AMAGIC((AMT*)mg->mg_ptr))
9015 AMT * const amtp = (AMT*)mg->mg_ptr;
9016 AMT * const namtp = (AMT*)nmg->mg_ptr;
9018 for (i = 1; i < NofAMmeth; i++) {
9019 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9023 else if (mg->mg_len == HEf_SVKEY)
9024 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9026 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9027 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9034 /* create a new pointer-mapping table */
9037 Perl_ptr_table_new(pTHX)
9040 Newxz(tbl, 1, PTR_TBL_t);
9043 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9047 #define PTR_TABLE_HASH(ptr) \
9048 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9051 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9052 following define) and at call to new_body_inline made below in
9053 Perl_ptr_table_store()
9056 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9058 /* map an existing pointer using a table */
9060 STATIC PTR_TBL_ENT_t *
9061 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9062 PTR_TBL_ENT_t *tblent;
9063 const UV hash = PTR_TABLE_HASH(sv);
9065 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9066 for (; tblent; tblent = tblent->next) {
9067 if (tblent->oldval == sv)
9074 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9076 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9077 return tblent ? tblent->newval : (void *) 0;
9080 /* add a new entry to a pointer-mapping table */
9083 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9085 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9088 tblent->newval = newsv;
9090 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9092 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9093 tblent->oldval = oldsv;
9094 tblent->newval = newsv;
9095 tblent->next = tbl->tbl_ary[entry];
9096 tbl->tbl_ary[entry] = tblent;
9098 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9099 ptr_table_split(tbl);
9103 /* double the hash bucket size of an existing ptr table */
9106 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9108 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9109 const UV oldsize = tbl->tbl_max + 1;
9110 UV newsize = oldsize * 2;
9113 Renew(ary, newsize, PTR_TBL_ENT_t*);
9114 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9115 tbl->tbl_max = --newsize;
9117 for (i=0; i < oldsize; i++, ary++) {
9118 PTR_TBL_ENT_t **curentp, **entp, *ent;
9121 curentp = ary + oldsize;
9122 for (entp = ary, ent = *ary; ent; ent = *entp) {
9123 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9125 ent->next = *curentp;
9135 /* remove all the entries from a ptr table */
9138 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9140 if (tbl && tbl->tbl_items) {
9141 register PTR_TBL_ENT_t **array = tbl->tbl_ary;
9142 UV riter = tbl->tbl_max;
9145 PTR_TBL_ENT_t *entry = array[riter];
9148 PTR_TBL_ENT_t * const oentry = entry;
9149 entry = entry->next;
9158 /* clear and free a ptr table */
9161 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9166 ptr_table_clear(tbl);
9167 Safefree(tbl->tbl_ary);
9173 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9176 SvRV_set(dstr, SvWEAKREF(sstr)
9177 ? sv_dup(SvRV(sstr), param)
9178 : sv_dup_inc(SvRV(sstr), param));
9181 else if (SvPVX_const(sstr)) {
9182 /* Has something there */
9184 /* Normal PV - clone whole allocated space */
9185 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9186 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9187 /* Not that normal - actually sstr is copy on write.
9188 But we are a true, independant SV, so: */
9189 SvREADONLY_off(dstr);
9194 /* Special case - not normally malloced for some reason */
9195 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9196 /* A "shared" PV - clone it as "shared" PV */
9198 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9202 /* Some other special case - random pointer */
9203 SvPV_set(dstr, SvPVX(sstr));
9209 if (SvTYPE(dstr) == SVt_RV)
9210 SvRV_set(dstr, NULL);
9216 /* duplicate an SV of any type (including AV, HV etc) */
9219 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9224 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9226 /* look for it in the table first */
9227 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9231 if(param->flags & CLONEf_JOIN_IN) {
9232 /** We are joining here so we don't want do clone
9233 something that is bad **/
9236 if(SvTYPE(sstr) == SVt_PVHV &&
9237 (hvname = HvNAME_get(sstr))) {
9238 /** don't clone stashes if they already exist **/
9239 return (SV*)gv_stashpv(hvname,0);
9243 /* create anew and remember what it is */
9246 #ifdef DEBUG_LEAKING_SCALARS
9247 dstr->sv_debug_optype = sstr->sv_debug_optype;
9248 dstr->sv_debug_line = sstr->sv_debug_line;
9249 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9250 dstr->sv_debug_cloned = 1;
9252 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9254 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9258 ptr_table_store(PL_ptr_table, sstr, dstr);
9261 SvFLAGS(dstr) = SvFLAGS(sstr);
9262 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9263 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9266 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9267 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9268 PL_watch_pvx, SvPVX_const(sstr));
9271 /* don't clone objects whose class has asked us not to */
9272 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9273 SvFLAGS(dstr) &= ~SVTYPEMASK;
9278 switch (SvTYPE(sstr)) {
9283 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9284 SvIV_set(dstr, SvIVX(sstr));
9287 SvANY(dstr) = new_XNV();
9288 SvNV_set(dstr, SvNVX(sstr));
9291 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9292 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9296 /* These are all the types that need complex bodies allocating. */
9298 const svtype sv_type = SvTYPE(sstr);
9299 const struct body_details *const sv_type_details
9300 = bodies_by_type + sv_type;
9304 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9309 if (GvUNIQUE((GV*)sstr)) {
9310 /* Do sharing here, and fall through */
9323 assert(sv_type_details->copy);
9324 if (sv_type_details->arena) {
9325 new_body_inline(new_body, sv_type_details->copy, sv_type);
9327 = (void*)((char*)new_body - sv_type_details->offset);
9329 new_body = new_NOARENA(sv_type_details);
9333 SvANY(dstr) = new_body;
9336 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9337 ((char*)SvANY(dstr)) + sv_type_details->offset,
9338 sv_type_details->copy, char);
9340 Copy(((char*)SvANY(sstr)),
9341 ((char*)SvANY(dstr)),
9342 sv_type_details->size + sv_type_details->offset, char);
9345 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9346 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9348 /* The Copy above means that all the source (unduplicated) pointers
9349 are now in the destination. We can check the flags and the
9350 pointers in either, but it's possible that there's less cache
9351 missing by always going for the destination.
9352 FIXME - instrument and check that assumption */
9353 if (sv_type >= SVt_PVMG) {
9355 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9357 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9360 /* The cast silences a GCC warning about unhandled types. */
9361 switch ((int)sv_type) {
9373 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9374 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9375 LvTARG(dstr) = dstr;
9376 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9377 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9379 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9382 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9383 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9384 /* Don't call sv_add_backref here as it's going to be created
9385 as part of the magic cloning of the symbol table. */
9386 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9387 (void)GpREFCNT_inc(GvGP(dstr));
9390 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9391 if (IoOFP(dstr) == IoIFP(sstr))
9392 IoOFP(dstr) = IoIFP(dstr);
9394 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9395 /* PL_rsfp_filters entries have fake IoDIRP() */
9396 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9397 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9398 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9399 /* I have no idea why fake dirp (rsfps)
9400 should be treated differently but otherwise
9401 we end up with leaks -- sky*/
9402 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9403 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9404 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9406 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9407 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9408 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9410 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9411 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9412 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9415 if (AvARRAY((AV*)sstr)) {
9416 SV **dst_ary, **src_ary;
9417 SSize_t items = AvFILLp((AV*)sstr) + 1;
9419 src_ary = AvARRAY((AV*)sstr);
9420 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9421 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9422 SvPV_set(dstr, (char*)dst_ary);
9423 AvALLOC((AV*)dstr) = dst_ary;
9424 if (AvREAL((AV*)sstr)) {
9426 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9430 *dst_ary++ = sv_dup(*src_ary++, param);
9432 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9433 while (items-- > 0) {
9434 *dst_ary++ = &PL_sv_undef;
9438 SvPV_set(dstr, Nullch);
9439 AvALLOC((AV*)dstr) = (SV**)NULL;
9446 if (HvARRAY((HV*)sstr)) {
9448 const bool sharekeys = !!HvSHAREKEYS(sstr);
9449 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9450 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9452 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9453 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9455 HvARRAY(dstr) = (HE**)darray;
9456 while (i <= sxhv->xhv_max) {
9457 const HE *source = HvARRAY(sstr)[i];
9458 HvARRAY(dstr)[i] = source
9459 ? he_dup(source, sharekeys, param) : 0;
9463 struct xpvhv_aux * const saux = HvAUX(sstr);
9464 struct xpvhv_aux * const daux = HvAUX(dstr);
9465 /* This flag isn't copied. */
9466 /* SvOOK_on(hv) attacks the IV flags. */
9467 SvFLAGS(dstr) |= SVf_OOK;
9469 hvname = saux->xhv_name;
9471 = hvname ? hek_dup(hvname, param) : hvname;
9473 daux->xhv_riter = saux->xhv_riter;
9474 daux->xhv_eiter = saux->xhv_eiter
9475 ? he_dup(saux->xhv_eiter,
9476 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9480 SvPV_set(dstr, Nullch);
9482 /* Record stashes for possible cloning in Perl_clone(). */
9484 av_push(param->stashes, dstr);
9489 /* NOTE: not refcounted */
9490 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9492 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9494 if (CvCONST(dstr)) {
9495 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9496 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9497 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9499 /* don't dup if copying back - CvGV isn't refcounted, so the
9500 * duped GV may never be freed. A bit of a hack! DAPM */
9501 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9502 Nullgv : gv_dup(CvGV(dstr), param) ;
9503 if (!(param->flags & CLONEf_COPY_STACKS)) {
9506 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9509 ? cv_dup( CvOUTSIDE(dstr), param)
9510 : cv_dup_inc(CvOUTSIDE(dstr), param);
9512 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9518 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9524 /* duplicate a context */
9527 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9532 return (PERL_CONTEXT*)NULL;
9534 /* look for it in the table first */
9535 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9539 /* create anew and remember what it is */
9540 Newxz(ncxs, max + 1, PERL_CONTEXT);
9541 ptr_table_store(PL_ptr_table, cxs, ncxs);
9544 PERL_CONTEXT *cx = &cxs[ix];
9545 PERL_CONTEXT *ncx = &ncxs[ix];
9546 ncx->cx_type = cx->cx_type;
9547 if (CxTYPE(cx) == CXt_SUBST) {
9548 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9551 ncx->blk_oldsp = cx->blk_oldsp;
9552 ncx->blk_oldcop = cx->blk_oldcop;
9553 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9554 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9555 ncx->blk_oldpm = cx->blk_oldpm;
9556 ncx->blk_gimme = cx->blk_gimme;
9557 switch (CxTYPE(cx)) {
9559 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9560 ? cv_dup_inc(cx->blk_sub.cv, param)
9561 : cv_dup(cx->blk_sub.cv,param));
9562 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9563 ? av_dup_inc(cx->blk_sub.argarray, param)
9565 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9566 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9567 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9568 ncx->blk_sub.lval = cx->blk_sub.lval;
9569 ncx->blk_sub.retop = cx->blk_sub.retop;
9572 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9573 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9574 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9575 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9576 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9577 ncx->blk_eval.retop = cx->blk_eval.retop;
9580 ncx->blk_loop.label = cx->blk_loop.label;
9581 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9582 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9583 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9584 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9585 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9586 ? cx->blk_loop.iterdata
9587 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9588 ncx->blk_loop.oldcomppad
9589 = (PAD*)ptr_table_fetch(PL_ptr_table,
9590 cx->blk_loop.oldcomppad);
9591 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9592 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9593 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9594 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9595 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9598 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9599 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9600 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9601 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9602 ncx->blk_sub.retop = cx->blk_sub.retop;
9614 /* duplicate a stack info structure */
9617 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9622 return (PERL_SI*)NULL;
9624 /* look for it in the table first */
9625 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9629 /* create anew and remember what it is */
9630 Newxz(nsi, 1, PERL_SI);
9631 ptr_table_store(PL_ptr_table, si, nsi);
9633 nsi->si_stack = av_dup_inc(si->si_stack, param);
9634 nsi->si_cxix = si->si_cxix;
9635 nsi->si_cxmax = si->si_cxmax;
9636 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9637 nsi->si_type = si->si_type;
9638 nsi->si_prev = si_dup(si->si_prev, param);
9639 nsi->si_next = si_dup(si->si_next, param);
9640 nsi->si_markoff = si->si_markoff;
9645 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9646 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9647 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9648 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9649 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9650 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9651 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9652 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9653 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9654 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9655 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9656 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9657 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9658 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9661 #define pv_dup_inc(p) SAVEPV(p)
9662 #define pv_dup(p) SAVEPV(p)
9663 #define svp_dup_inc(p,pp) any_dup(p,pp)
9665 /* map any object to the new equivent - either something in the
9666 * ptr table, or something in the interpreter structure
9670 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9677 /* look for it in the table first */
9678 ret = ptr_table_fetch(PL_ptr_table, v);
9682 /* see if it is part of the interpreter structure */
9683 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9684 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9692 /* duplicate the save stack */
9695 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9697 ANY * const ss = proto_perl->Tsavestack;
9698 const I32 max = proto_perl->Tsavestack_max;
9699 I32 ix = proto_perl->Tsavestack_ix;
9711 void (*dptr) (void*);
9712 void (*dxptr) (pTHX_ void*);
9714 Newxz(nss, max, ANY);
9717 I32 i = POPINT(ss,ix);
9720 case SAVEt_ITEM: /* normal string */
9721 sv = (SV*)POPPTR(ss,ix);
9722 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9723 sv = (SV*)POPPTR(ss,ix);
9724 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9726 case SAVEt_SV: /* scalar reference */
9727 sv = (SV*)POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9729 gv = (GV*)POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9732 case SAVEt_GENERIC_PVREF: /* generic char* */
9733 c = (char*)POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = pv_dup(c);
9735 ptr = POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9738 case SAVEt_SHARED_PVREF: /* char* in shared space */
9739 c = (char*)POPPTR(ss,ix);
9740 TOPPTR(nss,ix) = savesharedpv(c);
9741 ptr = POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9744 case SAVEt_GENERIC_SVREF: /* generic sv */
9745 case SAVEt_SVREF: /* scalar reference */
9746 sv = (SV*)POPPTR(ss,ix);
9747 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9748 ptr = POPPTR(ss,ix);
9749 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9751 case SAVEt_AV: /* array reference */
9752 av = (AV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = av_dup_inc(av, param);
9754 gv = (GV*)POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = gv_dup(gv, param);
9757 case SAVEt_HV: /* hash reference */
9758 hv = (HV*)POPPTR(ss,ix);
9759 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9760 gv = (GV*)POPPTR(ss,ix);
9761 TOPPTR(nss,ix) = gv_dup(gv, param);
9763 case SAVEt_INT: /* int reference */
9764 ptr = POPPTR(ss,ix);
9765 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9766 intval = (int)POPINT(ss,ix);
9767 TOPINT(nss,ix) = intval;
9769 case SAVEt_LONG: /* long reference */
9770 ptr = POPPTR(ss,ix);
9771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9772 longval = (long)POPLONG(ss,ix);
9773 TOPLONG(nss,ix) = longval;
9775 case SAVEt_I32: /* I32 reference */
9776 case SAVEt_I16: /* I16 reference */
9777 case SAVEt_I8: /* I8 reference */
9778 ptr = POPPTR(ss,ix);
9779 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9783 case SAVEt_IV: /* IV reference */
9784 ptr = POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9789 case SAVEt_SPTR: /* SV* reference */
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9792 sv = (SV*)POPPTR(ss,ix);
9793 TOPPTR(nss,ix) = sv_dup(sv, param);
9795 case SAVEt_VPTR: /* random* reference */
9796 ptr = POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 ptr = POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9801 case SAVEt_PPTR: /* char* reference */
9802 ptr = POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9804 c = (char*)POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = pv_dup(c);
9807 case SAVEt_HPTR: /* HV* reference */
9808 ptr = POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9810 hv = (HV*)POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = hv_dup(hv, param);
9813 case SAVEt_APTR: /* AV* reference */
9814 ptr = POPPTR(ss,ix);
9815 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9816 av = (AV*)POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = av_dup(av, param);
9820 gv = (GV*)POPPTR(ss,ix);
9821 TOPPTR(nss,ix) = gv_dup(gv, param);
9823 case SAVEt_GP: /* scalar reference */
9824 gp = (GP*)POPPTR(ss,ix);
9825 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9826 (void)GpREFCNT_inc(gp);
9827 gv = (GV*)POPPTR(ss,ix);
9828 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9829 c = (char*)POPPTR(ss,ix);
9830 TOPPTR(nss,ix) = pv_dup(c);
9837 case SAVEt_MORTALIZESV:
9838 sv = (SV*)POPPTR(ss,ix);
9839 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9842 ptr = POPPTR(ss,ix);
9843 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9844 /* these are assumed to be refcounted properly */
9846 switch (((OP*)ptr)->op_type) {
9853 TOPPTR(nss,ix) = ptr;
9858 TOPPTR(nss,ix) = Nullop;
9863 TOPPTR(nss,ix) = Nullop;
9866 c = (char*)POPPTR(ss,ix);
9867 TOPPTR(nss,ix) = pv_dup_inc(c);
9870 longval = POPLONG(ss,ix);
9871 TOPLONG(nss,ix) = longval;
9874 hv = (HV*)POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9876 c = (char*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = pv_dup_inc(c);
9881 case SAVEt_DESTRUCTOR:
9882 ptr = POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9884 dptr = POPDPTR(ss,ix);
9885 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9886 any_dup(FPTR2DPTR(void *, dptr),
9889 case SAVEt_DESTRUCTOR_X:
9890 ptr = POPPTR(ss,ix);
9891 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9892 dxptr = POPDXPTR(ss,ix);
9893 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9894 any_dup(FPTR2DPTR(void *, dxptr),
9897 case SAVEt_REGCONTEXT:
9903 case SAVEt_STACK_POS: /* Position on Perl stack */
9907 case SAVEt_AELEM: /* array element */
9908 sv = (SV*)POPPTR(ss,ix);
9909 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 av = (AV*)POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = av_dup_inc(av, param);
9915 case SAVEt_HELEM: /* hash element */
9916 sv = (SV*)POPPTR(ss,ix);
9917 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9918 sv = (SV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9920 hv = (HV*)POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9924 ptr = POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = ptr;
9932 av = (AV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = av_dup(av, param);
9936 longval = (long)POPLONG(ss,ix);
9937 TOPLONG(nss,ix) = longval;
9938 ptr = POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9940 sv = (SV*)POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = sv_dup(sv, param);
9944 ptr = POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 longval = (long)POPBOOL(ss,ix);
9947 TOPBOOL(nss,ix) = (bool)longval;
9949 case SAVEt_SET_SVFLAGS:
9954 sv = (SV*)POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = sv_dup(sv, param);
9958 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9966 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9967 * flag to the result. This is done for each stash before cloning starts,
9968 * so we know which stashes want their objects cloned */
9971 do_mark_cloneable_stash(pTHX_ SV *sv)
9973 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9975 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9976 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9977 if (cloner && GvCV(cloner)) {
9984 XPUSHs(sv_2mortal(newSVhek(hvname)));
9986 call_sv((SV*)GvCV(cloner), G_SCALAR);
9993 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10001 =for apidoc perl_clone
10003 Create and return a new interpreter by cloning the current one.
10005 perl_clone takes these flags as parameters:
10007 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10008 without it we only clone the data and zero the stacks,
10009 with it we copy the stacks and the new perl interpreter is
10010 ready to run at the exact same point as the previous one.
10011 The pseudo-fork code uses COPY_STACKS while the
10012 threads->new doesn't.
10014 CLONEf_KEEP_PTR_TABLE
10015 perl_clone keeps a ptr_table with the pointer of the old
10016 variable as a key and the new variable as a value,
10017 this allows it to check if something has been cloned and not
10018 clone it again but rather just use the value and increase the
10019 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10020 the ptr_table using the function
10021 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10022 reason to keep it around is if you want to dup some of your own
10023 variable who are outside the graph perl scans, example of this
10024 code is in threads.xs create
10027 This is a win32 thing, it is ignored on unix, it tells perls
10028 win32host code (which is c++) to clone itself, this is needed on
10029 win32 if you want to run two threads at the same time,
10030 if you just want to do some stuff in a separate perl interpreter
10031 and then throw it away and return to the original one,
10032 you don't need to do anything.
10037 /* XXX the above needs expanding by someone who actually understands it ! */
10038 EXTERN_C PerlInterpreter *
10039 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10042 perl_clone(PerlInterpreter *proto_perl, UV flags)
10045 #ifdef PERL_IMPLICIT_SYS
10047 /* perlhost.h so we need to call into it
10048 to clone the host, CPerlHost should have a c interface, sky */
10050 if (flags & CLONEf_CLONE_HOST) {
10051 return perl_clone_host(proto_perl,flags);
10053 return perl_clone_using(proto_perl, flags,
10055 proto_perl->IMemShared,
10056 proto_perl->IMemParse,
10058 proto_perl->IStdIO,
10062 proto_perl->IProc);
10066 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10067 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10068 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10069 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10070 struct IPerlDir* ipD, struct IPerlSock* ipS,
10071 struct IPerlProc* ipP)
10073 /* XXX many of the string copies here can be optimized if they're
10074 * constants; they need to be allocated as common memory and just
10075 * their pointers copied. */
10078 CLONE_PARAMS clone_params;
10079 CLONE_PARAMS* param = &clone_params;
10081 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10082 /* for each stash, determine whether its objects should be cloned */
10083 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10084 PERL_SET_THX(my_perl);
10087 Poison(my_perl, 1, PerlInterpreter);
10089 PL_curcop = (COP *)Nullop;
10093 PL_savestack_ix = 0;
10094 PL_savestack_max = -1;
10095 PL_sig_pending = 0;
10096 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10097 # else /* !DEBUGGING */
10098 Zero(my_perl, 1, PerlInterpreter);
10099 # endif /* DEBUGGING */
10101 /* host pointers */
10103 PL_MemShared = ipMS;
10104 PL_MemParse = ipMP;
10111 #else /* !PERL_IMPLICIT_SYS */
10113 CLONE_PARAMS clone_params;
10114 CLONE_PARAMS* param = &clone_params;
10115 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10116 /* for each stash, determine whether its objects should be cloned */
10117 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10118 PERL_SET_THX(my_perl);
10121 Poison(my_perl, 1, PerlInterpreter);
10123 PL_curcop = (COP *)Nullop;
10127 PL_savestack_ix = 0;
10128 PL_savestack_max = -1;
10129 PL_sig_pending = 0;
10130 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10131 # else /* !DEBUGGING */
10132 Zero(my_perl, 1, PerlInterpreter);
10133 # endif /* DEBUGGING */
10134 #endif /* PERL_IMPLICIT_SYS */
10135 param->flags = flags;
10136 param->proto_perl = proto_perl;
10138 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10139 Zero(&PL_body_roots, 1, PL_body_roots);
10141 PL_nice_chunk = NULL;
10142 PL_nice_chunk_size = 0;
10144 PL_sv_objcount = 0;
10145 PL_sv_root = Nullsv;
10146 PL_sv_arenaroot = Nullsv;
10148 PL_debug = proto_perl->Idebug;
10150 PL_hash_seed = proto_perl->Ihash_seed;
10151 PL_rehash_seed = proto_perl->Irehash_seed;
10153 #ifdef USE_REENTRANT_API
10154 /* XXX: things like -Dm will segfault here in perlio, but doing
10155 * PERL_SET_CONTEXT(proto_perl);
10156 * breaks too many other things
10158 Perl_reentrant_init(aTHX);
10161 /* create SV map for pointer relocation */
10162 PL_ptr_table = ptr_table_new();
10164 /* initialize these special pointers as early as possible */
10165 SvANY(&PL_sv_undef) = NULL;
10166 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10167 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10168 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10170 SvANY(&PL_sv_no) = new_XPVNV();
10171 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10172 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10173 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10174 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10175 SvCUR_set(&PL_sv_no, 0);
10176 SvLEN_set(&PL_sv_no, 1);
10177 SvIV_set(&PL_sv_no, 0);
10178 SvNV_set(&PL_sv_no, 0);
10179 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10181 SvANY(&PL_sv_yes) = new_XPVNV();
10182 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10183 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10184 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10185 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10186 SvCUR_set(&PL_sv_yes, 1);
10187 SvLEN_set(&PL_sv_yes, 2);
10188 SvIV_set(&PL_sv_yes, 1);
10189 SvNV_set(&PL_sv_yes, 1);
10190 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10192 /* create (a non-shared!) shared string table */
10193 PL_strtab = newHV();
10194 HvSHAREKEYS_off(PL_strtab);
10195 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10196 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10198 PL_compiling = proto_perl->Icompiling;
10200 /* These two PVs will be free'd special way so must set them same way op.c does */
10201 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10202 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10204 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10205 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10207 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10208 if (!specialWARN(PL_compiling.cop_warnings))
10209 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10210 if (!specialCopIO(PL_compiling.cop_io))
10211 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10212 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10214 /* pseudo environmental stuff */
10215 PL_origargc = proto_perl->Iorigargc;
10216 PL_origargv = proto_perl->Iorigargv;
10218 param->stashes = newAV(); /* Setup array of objects to call clone on */
10220 /* Set tainting stuff before PerlIO_debug can possibly get called */
10221 PL_tainting = proto_perl->Itainting;
10222 PL_taint_warn = proto_perl->Itaint_warn;
10224 #ifdef PERLIO_LAYERS
10225 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10226 PerlIO_clone(aTHX_ proto_perl, param);
10229 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10230 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10231 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10232 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10233 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10234 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10237 PL_minus_c = proto_perl->Iminus_c;
10238 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10239 PL_localpatches = proto_perl->Ilocalpatches;
10240 PL_splitstr = proto_perl->Isplitstr;
10241 PL_preprocess = proto_perl->Ipreprocess;
10242 PL_minus_n = proto_perl->Iminus_n;
10243 PL_minus_p = proto_perl->Iminus_p;
10244 PL_minus_l = proto_perl->Iminus_l;
10245 PL_minus_a = proto_perl->Iminus_a;
10246 PL_minus_F = proto_perl->Iminus_F;
10247 PL_doswitches = proto_perl->Idoswitches;
10248 PL_dowarn = proto_perl->Idowarn;
10249 PL_doextract = proto_perl->Idoextract;
10250 PL_sawampersand = proto_perl->Isawampersand;
10251 PL_unsafe = proto_perl->Iunsafe;
10252 PL_inplace = SAVEPV(proto_perl->Iinplace);
10253 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10254 PL_perldb = proto_perl->Iperldb;
10255 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10256 PL_exit_flags = proto_perl->Iexit_flags;
10258 /* magical thingies */
10259 /* XXX time(&PL_basetime) when asked for? */
10260 PL_basetime = proto_perl->Ibasetime;
10261 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10263 PL_maxsysfd = proto_perl->Imaxsysfd;
10264 PL_multiline = proto_perl->Imultiline;
10265 PL_statusvalue = proto_perl->Istatusvalue;
10267 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10269 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10271 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10273 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10274 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10275 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10277 /* Clone the regex array */
10278 PL_regex_padav = newAV();
10280 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10281 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10283 av_push(PL_regex_padav,
10284 sv_dup_inc(regexen[0],param));
10285 for(i = 1; i <= len; i++) {
10286 if(SvREPADTMP(regexen[i])) {
10287 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10289 av_push(PL_regex_padav,
10291 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10292 SvIVX(regexen[i])), param)))
10297 PL_regex_pad = AvARRAY(PL_regex_padav);
10299 /* shortcuts to various I/O objects */
10300 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10301 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10302 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10303 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10304 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10305 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10307 /* shortcuts to regexp stuff */
10308 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10310 /* shortcuts to misc objects */
10311 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10313 /* shortcuts to debugging objects */
10314 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10315 PL_DBline = gv_dup(proto_perl->IDBline, param);
10316 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10317 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10318 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10319 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10320 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10321 PL_lineary = av_dup(proto_perl->Ilineary, param);
10322 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10324 /* symbol tables */
10325 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10326 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10327 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10328 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10329 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10331 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10332 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10333 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10334 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10335 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10336 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10338 PL_sub_generation = proto_perl->Isub_generation;
10340 /* funky return mechanisms */
10341 PL_forkprocess = proto_perl->Iforkprocess;
10343 /* subprocess state */
10344 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10346 /* internal state */
10347 PL_maxo = proto_perl->Imaxo;
10348 if (proto_perl->Iop_mask)
10349 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10351 PL_op_mask = Nullch;
10352 /* PL_asserting = proto_perl->Iasserting; */
10354 /* current interpreter roots */
10355 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10356 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10357 PL_main_start = proto_perl->Imain_start;
10358 PL_eval_root = proto_perl->Ieval_root;
10359 PL_eval_start = proto_perl->Ieval_start;
10361 /* runtime control stuff */
10362 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10363 PL_copline = proto_perl->Icopline;
10365 PL_filemode = proto_perl->Ifilemode;
10366 PL_lastfd = proto_perl->Ilastfd;
10367 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10370 PL_gensym = proto_perl->Igensym;
10371 PL_preambled = proto_perl->Ipreambled;
10372 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10373 PL_laststatval = proto_perl->Ilaststatval;
10374 PL_laststype = proto_perl->Ilaststype;
10375 PL_mess_sv = Nullsv;
10377 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10379 /* interpreter atexit processing */
10380 PL_exitlistlen = proto_perl->Iexitlistlen;
10381 if (PL_exitlistlen) {
10382 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10383 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10386 PL_exitlist = (PerlExitListEntry*)NULL;
10387 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10388 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10389 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10391 PL_profiledata = NULL;
10392 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10393 /* PL_rsfp_filters entries have fake IoDIRP() */
10394 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10396 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10398 PAD_CLONE_VARS(proto_perl, param);
10400 #ifdef HAVE_INTERP_INTERN
10401 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10404 /* more statics moved here */
10405 PL_generation = proto_perl->Igeneration;
10406 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10408 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10409 PL_in_clean_all = proto_perl->Iin_clean_all;
10411 PL_uid = proto_perl->Iuid;
10412 PL_euid = proto_perl->Ieuid;
10413 PL_gid = proto_perl->Igid;
10414 PL_egid = proto_perl->Iegid;
10415 PL_nomemok = proto_perl->Inomemok;
10416 PL_an = proto_perl->Ian;
10417 PL_evalseq = proto_perl->Ievalseq;
10418 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10419 PL_origalen = proto_perl->Iorigalen;
10420 #ifdef PERL_USES_PL_PIDSTATUS
10421 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10423 PL_osname = SAVEPV(proto_perl->Iosname);
10424 PL_sighandlerp = proto_perl->Isighandlerp;
10426 PL_runops = proto_perl->Irunops;
10428 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10431 PL_cshlen = proto_perl->Icshlen;
10432 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10435 PL_lex_state = proto_perl->Ilex_state;
10436 PL_lex_defer = proto_perl->Ilex_defer;
10437 PL_lex_expect = proto_perl->Ilex_expect;
10438 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10439 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10440 PL_lex_starts = proto_perl->Ilex_starts;
10441 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10442 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10443 PL_lex_op = proto_perl->Ilex_op;
10444 PL_lex_inpat = proto_perl->Ilex_inpat;
10445 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10446 PL_lex_brackets = proto_perl->Ilex_brackets;
10447 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10448 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10449 PL_lex_casemods = proto_perl->Ilex_casemods;
10450 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10451 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10453 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10454 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10455 PL_nexttoke = proto_perl->Inexttoke;
10457 /* XXX This is probably masking the deeper issue of why
10458 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10459 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10460 * (A little debugging with a watchpoint on it may help.)
10462 if (SvANY(proto_perl->Ilinestr)) {
10463 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10464 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10465 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10466 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10467 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10468 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10469 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10470 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10471 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10474 PL_linestr = NEWSV(65,79);
10475 sv_upgrade(PL_linestr,SVt_PVIV);
10476 sv_setpvn(PL_linestr,"",0);
10477 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10479 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10480 PL_pending_ident = proto_perl->Ipending_ident;
10481 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10483 PL_expect = proto_perl->Iexpect;
10485 PL_multi_start = proto_perl->Imulti_start;
10486 PL_multi_end = proto_perl->Imulti_end;
10487 PL_multi_open = proto_perl->Imulti_open;
10488 PL_multi_close = proto_perl->Imulti_close;
10490 PL_error_count = proto_perl->Ierror_count;
10491 PL_subline = proto_perl->Isubline;
10492 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10494 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10495 if (SvANY(proto_perl->Ilinestr)) {
10496 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10497 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10498 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10499 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10500 PL_last_lop_op = proto_perl->Ilast_lop_op;
10503 PL_last_uni = SvPVX(PL_linestr);
10504 PL_last_lop = SvPVX(PL_linestr);
10505 PL_last_lop_op = 0;
10507 PL_in_my = proto_perl->Iin_my;
10508 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10510 PL_cryptseen = proto_perl->Icryptseen;
10513 PL_hints = proto_perl->Ihints;
10515 PL_amagic_generation = proto_perl->Iamagic_generation;
10517 #ifdef USE_LOCALE_COLLATE
10518 PL_collation_ix = proto_perl->Icollation_ix;
10519 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10520 PL_collation_standard = proto_perl->Icollation_standard;
10521 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10522 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10523 #endif /* USE_LOCALE_COLLATE */
10525 #ifdef USE_LOCALE_NUMERIC
10526 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10527 PL_numeric_standard = proto_perl->Inumeric_standard;
10528 PL_numeric_local = proto_perl->Inumeric_local;
10529 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10530 #endif /* !USE_LOCALE_NUMERIC */
10532 /* utf8 character classes */
10533 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10534 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10535 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10536 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10537 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10538 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10539 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10540 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10541 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10542 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10543 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10544 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10545 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10546 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10547 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10548 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10549 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10550 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10551 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10552 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10554 /* Did the locale setup indicate UTF-8? */
10555 PL_utf8locale = proto_perl->Iutf8locale;
10556 /* Unicode features (see perlrun/-C) */
10557 PL_unicode = proto_perl->Iunicode;
10559 /* Pre-5.8 signals control */
10560 PL_signals = proto_perl->Isignals;
10562 /* times() ticks per second */
10563 PL_clocktick = proto_perl->Iclocktick;
10565 /* Recursion stopper for PerlIO_find_layer */
10566 PL_in_load_module = proto_perl->Iin_load_module;
10568 /* sort() routine */
10569 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10571 /* Not really needed/useful since the reenrant_retint is "volatile",
10572 * but do it for consistency's sake. */
10573 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10575 /* Hooks to shared SVs and locks. */
10576 PL_sharehook = proto_perl->Isharehook;
10577 PL_lockhook = proto_perl->Ilockhook;
10578 PL_unlockhook = proto_perl->Iunlockhook;
10579 PL_threadhook = proto_perl->Ithreadhook;
10581 PL_runops_std = proto_perl->Irunops_std;
10582 PL_runops_dbg = proto_perl->Irunops_dbg;
10584 #ifdef THREADS_HAVE_PIDS
10585 PL_ppid = proto_perl->Ippid;
10589 PL_last_swash_hv = Nullhv; /* reinits on demand */
10590 PL_last_swash_klen = 0;
10591 PL_last_swash_key[0]= '\0';
10592 PL_last_swash_tmps = (U8*)NULL;
10593 PL_last_swash_slen = 0;
10595 PL_glob_index = proto_perl->Iglob_index;
10596 PL_srand_called = proto_perl->Isrand_called;
10597 PL_uudmap['M'] = 0; /* reinits on demand */
10598 PL_bitcount = Nullch; /* reinits on demand */
10600 if (proto_perl->Ipsig_pend) {
10601 Newxz(PL_psig_pend, SIG_SIZE, int);
10604 PL_psig_pend = (int*)NULL;
10607 if (proto_perl->Ipsig_ptr) {
10608 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10609 Newxz(PL_psig_name, SIG_SIZE, SV*);
10610 for (i = 1; i < SIG_SIZE; i++) {
10611 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10612 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10616 PL_psig_ptr = (SV**)NULL;
10617 PL_psig_name = (SV**)NULL;
10620 /* thrdvar.h stuff */
10622 if (flags & CLONEf_COPY_STACKS) {
10623 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10624 PL_tmps_ix = proto_perl->Ttmps_ix;
10625 PL_tmps_max = proto_perl->Ttmps_max;
10626 PL_tmps_floor = proto_perl->Ttmps_floor;
10627 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10629 while (i <= PL_tmps_ix) {
10630 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10634 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10635 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10636 Newxz(PL_markstack, i, I32);
10637 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10638 - proto_perl->Tmarkstack);
10639 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10640 - proto_perl->Tmarkstack);
10641 Copy(proto_perl->Tmarkstack, PL_markstack,
10642 PL_markstack_ptr - PL_markstack + 1, I32);
10644 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10645 * NOTE: unlike the others! */
10646 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10647 PL_scopestack_max = proto_perl->Tscopestack_max;
10648 Newxz(PL_scopestack, PL_scopestack_max, I32);
10649 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10651 /* NOTE: si_dup() looks at PL_markstack */
10652 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10654 /* PL_curstack = PL_curstackinfo->si_stack; */
10655 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10656 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10658 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10659 PL_stack_base = AvARRAY(PL_curstack);
10660 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10661 - proto_perl->Tstack_base);
10662 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10664 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10665 * NOTE: unlike the others! */
10666 PL_savestack_ix = proto_perl->Tsavestack_ix;
10667 PL_savestack_max = proto_perl->Tsavestack_max;
10668 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10669 PL_savestack = ss_dup(proto_perl, param);
10673 ENTER; /* perl_destruct() wants to LEAVE; */
10676 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10677 PL_top_env = &PL_start_env;
10679 PL_op = proto_perl->Top;
10682 PL_Xpv = (XPV*)NULL;
10683 PL_na = proto_perl->Tna;
10685 PL_statbuf = proto_perl->Tstatbuf;
10686 PL_statcache = proto_perl->Tstatcache;
10687 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10688 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10690 PL_timesbuf = proto_perl->Ttimesbuf;
10693 PL_tainted = proto_perl->Ttainted;
10694 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10695 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10696 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10697 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10698 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10699 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10700 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10701 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10702 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10704 PL_restartop = proto_perl->Trestartop;
10705 PL_in_eval = proto_perl->Tin_eval;
10706 PL_delaymagic = proto_perl->Tdelaymagic;
10707 PL_dirty = proto_perl->Tdirty;
10708 PL_localizing = proto_perl->Tlocalizing;
10710 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10711 PL_hv_fetch_ent_mh = Nullhe;
10712 PL_modcount = proto_perl->Tmodcount;
10713 PL_lastgotoprobe = Nullop;
10714 PL_dumpindent = proto_perl->Tdumpindent;
10716 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10717 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10718 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10719 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10720 PL_efloatbuf = Nullch; /* reinits on demand */
10721 PL_efloatsize = 0; /* reinits on demand */
10725 PL_screamfirst = NULL;
10726 PL_screamnext = NULL;
10727 PL_maxscream = -1; /* reinits on demand */
10728 PL_lastscream = Nullsv;
10730 PL_watchaddr = NULL;
10731 PL_watchok = Nullch;
10733 PL_regdummy = proto_perl->Tregdummy;
10734 PL_regprecomp = Nullch;
10737 PL_colorset = 0; /* reinits PL_colors[] */
10738 /*PL_colors[6] = {0,0,0,0,0,0};*/
10739 PL_reginput = Nullch;
10740 PL_regbol = Nullch;
10741 PL_regeol = Nullch;
10742 PL_regstartp = (I32*)NULL;
10743 PL_regendp = (I32*)NULL;
10744 PL_reglastparen = (U32*)NULL;
10745 PL_reglastcloseparen = (U32*)NULL;
10746 PL_regtill = Nullch;
10747 PL_reg_start_tmp = (char**)NULL;
10748 PL_reg_start_tmpl = 0;
10749 PL_regdata = (struct reg_data*)NULL;
10752 PL_reg_eval_set = 0;
10754 PL_regprogram = (regnode*)NULL;
10756 PL_regcc = (CURCUR*)NULL;
10757 PL_reg_call_cc = (struct re_cc_state*)NULL;
10758 PL_reg_re = (regexp*)NULL;
10759 PL_reg_ganch = Nullch;
10760 PL_reg_sv = Nullsv;
10761 PL_reg_match_utf8 = FALSE;
10762 PL_reg_magic = (MAGIC*)NULL;
10764 PL_reg_oldcurpm = (PMOP*)NULL;
10765 PL_reg_curpm = (PMOP*)NULL;
10766 PL_reg_oldsaved = Nullch;
10767 PL_reg_oldsavedlen = 0;
10768 #ifdef PERL_OLD_COPY_ON_WRITE
10771 PL_reg_maxiter = 0;
10772 PL_reg_leftiter = 0;
10773 PL_reg_poscache = Nullch;
10774 PL_reg_poscache_size= 0;
10776 /* RE engine - function pointers */
10777 PL_regcompp = proto_perl->Tregcompp;
10778 PL_regexecp = proto_perl->Tregexecp;
10779 PL_regint_start = proto_perl->Tregint_start;
10780 PL_regint_string = proto_perl->Tregint_string;
10781 PL_regfree = proto_perl->Tregfree;
10783 PL_reginterp_cnt = 0;
10784 PL_reg_starttry = 0;
10786 /* Pluggable optimizer */
10787 PL_peepp = proto_perl->Tpeepp;
10789 PL_stashcache = newHV();
10791 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10792 ptr_table_free(PL_ptr_table);
10793 PL_ptr_table = NULL;
10796 /* Call the ->CLONE method, if it exists, for each of the stashes
10797 identified by sv_dup() above.
10799 while(av_len(param->stashes) != -1) {
10800 HV* const stash = (HV*) av_shift(param->stashes);
10801 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10802 if (cloner && GvCV(cloner)) {
10807 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10809 call_sv((SV*)GvCV(cloner), G_DISCARD);
10815 SvREFCNT_dec(param->stashes);
10817 /* orphaned? eg threads->new inside BEGIN or use */
10818 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10819 (void)SvREFCNT_inc(PL_compcv);
10820 SAVEFREESV(PL_compcv);
10826 #endif /* USE_ITHREADS */
10829 =head1 Unicode Support
10831 =for apidoc sv_recode_to_utf8
10833 The encoding is assumed to be an Encode object, on entry the PV
10834 of the sv is assumed to be octets in that encoding, and the sv
10835 will be converted into Unicode (and UTF-8).
10837 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10838 is not a reference, nothing is done to the sv. If the encoding is not
10839 an C<Encode::XS> Encoding object, bad things will happen.
10840 (See F<lib/encoding.pm> and L<Encode>).
10842 The PV of the sv is returned.
10847 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10850 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10864 Passing sv_yes is wrong - it needs to be or'ed set of constants
10865 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10866 remove converted chars from source.
10868 Both will default the value - let them.
10870 XPUSHs(&PL_sv_yes);
10873 call_method("decode", G_SCALAR);
10877 s = SvPV_const(uni, len);
10878 if (s != SvPVX_const(sv)) {
10879 SvGROW(sv, len + 1);
10880 Move(s, SvPVX(sv), len + 1, char);
10881 SvCUR_set(sv, len);
10888 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10892 =for apidoc sv_cat_decode
10894 The encoding is assumed to be an Encode object, the PV of the ssv is
10895 assumed to be octets in that encoding and decoding the input starts
10896 from the position which (PV + *offset) pointed to. The dsv will be
10897 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10898 when the string tstr appears in decoding output or the input ends on
10899 the PV of the ssv. The value which the offset points will be modified
10900 to the last input position on the ssv.
10902 Returns TRUE if the terminator was found, else returns FALSE.
10907 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10908 SV *ssv, int *offset, char *tstr, int tlen)
10912 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10923 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10924 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10926 call_method("cat_decode", G_SCALAR);
10928 ret = SvTRUE(TOPs);
10929 *offset = SvIV(offsv);
10935 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10940 /* ---------------------------------------------------------------------
10942 * support functions for report_uninit()
10945 /* the maxiumum size of array or hash where we will scan looking
10946 * for the undefined element that triggered the warning */
10948 #define FUV_MAX_SEARCH_SIZE 1000
10950 /* Look for an entry in the hash whose value has the same SV as val;
10951 * If so, return a mortal copy of the key. */
10954 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10957 register HE **array;
10960 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10961 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10964 array = HvARRAY(hv);
10966 for (i=HvMAX(hv); i>0; i--) {
10967 register HE *entry;
10968 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10969 if (HeVAL(entry) != val)
10971 if ( HeVAL(entry) == &PL_sv_undef ||
10972 HeVAL(entry) == &PL_sv_placeholder)
10976 if (HeKLEN(entry) == HEf_SVKEY)
10977 return sv_mortalcopy(HeKEY_sv(entry));
10978 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10984 /* Look for an entry in the array whose value has the same SV as val;
10985 * If so, return the index, otherwise return -1. */
10988 S_find_array_subscript(pTHX_ AV *av, SV* val)
10992 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10993 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10997 for (i=AvFILLp(av); i>=0; i--) {
10998 if (svp[i] == val && svp[i] != &PL_sv_undef)
11004 /* S_varname(): return the name of a variable, optionally with a subscript.
11005 * If gv is non-zero, use the name of that global, along with gvtype (one
11006 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11007 * targ. Depending on the value of the subscript_type flag, return:
11010 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11011 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11012 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11013 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11016 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11017 SV* keyname, I32 aindex, int subscript_type)
11020 SV * const name = sv_newmortal();
11023 buffer[0] = gvtype;
11026 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11028 gv_fullname4(name, gv, buffer, 0);
11030 if ((unsigned int)SvPVX(name)[1] <= 26) {
11032 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11034 /* Swap the 1 unprintable control character for the 2 byte pretty
11035 version - ie substr($name, 1, 1) = $buffer; */
11036 sv_insert(name, 1, 1, buffer, 2);
11041 CV * const cv = find_runcv(&unused);
11045 if (!cv || !CvPADLIST(cv))
11047 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11048 sv = *av_fetch(av, targ, FALSE);
11049 /* SvLEN in a pad name is not to be trusted */
11050 sv_setpv(name, SvPV_nolen_const(sv));
11053 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11054 SV * const sv = NEWSV(0,0);
11055 *SvPVX(name) = '$';
11056 Perl_sv_catpvf(aTHX_ name, "{%s}",
11057 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11060 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11061 *SvPVX(name) = '$';
11062 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11064 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11065 sv_insert(name, 0, 0, "within ", 7);
11072 =for apidoc find_uninit_var
11074 Find the name of the undefined variable (if any) that caused the operator o
11075 to issue a "Use of uninitialized value" warning.
11076 If match is true, only return a name if it's value matches uninit_sv.
11077 So roughly speaking, if a unary operator (such as OP_COS) generates a
11078 warning, then following the direct child of the op may yield an
11079 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11080 other hand, with OP_ADD there are two branches to follow, so we only print
11081 the variable name if we get an exact match.
11083 The name is returned as a mortal SV.
11085 Assumes that PL_op is the op that originally triggered the error, and that
11086 PL_comppad/PL_curpad points to the currently executing pad.
11092 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11100 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11101 uninit_sv == &PL_sv_placeholder)))
11104 switch (obase->op_type) {
11111 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11112 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11114 SV *keysv = Nullsv;
11115 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11117 if (pad) { /* @lex, %lex */
11118 sv = PAD_SVl(obase->op_targ);
11122 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11123 /* @global, %global */
11124 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11127 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11129 else /* @{expr}, %{expr} */
11130 return find_uninit_var(cUNOPx(obase)->op_first,
11134 /* attempt to find a match within the aggregate */
11136 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11138 subscript_type = FUV_SUBSCRIPT_HASH;
11141 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11143 subscript_type = FUV_SUBSCRIPT_ARRAY;
11146 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11149 return varname(gv, hash ? '%' : '@', obase->op_targ,
11150 keysv, index, subscript_type);
11154 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11156 return varname(Nullgv, '$', obase->op_targ,
11157 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11160 gv = cGVOPx_gv(obase);
11161 if (!gv || (match && GvSV(gv) != uninit_sv))
11163 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11166 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11169 av = (AV*)PAD_SV(obase->op_targ);
11170 if (!av || SvRMAGICAL(av))
11172 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11173 if (!svp || *svp != uninit_sv)
11176 return varname(Nullgv, '$', obase->op_targ,
11177 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11180 gv = cGVOPx_gv(obase);
11186 if (!av || SvRMAGICAL(av))
11188 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11189 if (!svp || *svp != uninit_sv)
11192 return varname(gv, '$', 0,
11193 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11198 o = cUNOPx(obase)->op_first;
11199 if (!o || o->op_type != OP_NULL ||
11200 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11202 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11206 if (PL_op == obase)
11207 /* $a[uninit_expr] or $h{uninit_expr} */
11208 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11211 o = cBINOPx(obase)->op_first;
11212 kid = cBINOPx(obase)->op_last;
11214 /* get the av or hv, and optionally the gv */
11216 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11217 sv = PAD_SV(o->op_targ);
11219 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11220 && cUNOPo->op_first->op_type == OP_GV)
11222 gv = cGVOPx_gv(cUNOPo->op_first);
11225 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11230 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11231 /* index is constant */
11235 if (obase->op_type == OP_HELEM) {
11236 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11237 if (!he || HeVAL(he) != uninit_sv)
11241 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11242 if (!svp || *svp != uninit_sv)
11246 if (obase->op_type == OP_HELEM)
11247 return varname(gv, '%', o->op_targ,
11248 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11250 return varname(gv, '@', o->op_targ, Nullsv,
11251 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11254 /* index is an expression;
11255 * attempt to find a match within the aggregate */
11256 if (obase->op_type == OP_HELEM) {
11257 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11259 return varname(gv, '%', o->op_targ,
11260 keysv, 0, FUV_SUBSCRIPT_HASH);
11263 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11265 return varname(gv, '@', o->op_targ,
11266 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11271 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11273 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11279 /* only examine RHS */
11280 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11283 o = cUNOPx(obase)->op_first;
11284 if (o->op_type == OP_PUSHMARK)
11287 if (!o->op_sibling) {
11288 /* one-arg version of open is highly magical */
11290 if (o->op_type == OP_GV) { /* open FOO; */
11292 if (match && GvSV(gv) != uninit_sv)
11294 return varname(gv, '$', 0,
11295 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11297 /* other possibilities not handled are:
11298 * open $x; or open my $x; should return '${*$x}'
11299 * open expr; should return '$'.expr ideally
11305 /* ops where $_ may be an implicit arg */
11309 if ( !(obase->op_flags & OPf_STACKED)) {
11310 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11311 ? PAD_SVl(obase->op_targ)
11314 sv = sv_newmortal();
11315 sv_setpvn(sv, "$_", 2);
11323 /* skip filehandle as it can't produce 'undef' warning */
11324 o = cUNOPx(obase)->op_first;
11325 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11326 o = o->op_sibling->op_sibling;
11333 match = 1; /* XS or custom code could trigger random warnings */
11338 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11339 return sv_2mortal(newSVpvn("${$/}", 5));
11344 if (!(obase->op_flags & OPf_KIDS))
11346 o = cUNOPx(obase)->op_first;
11352 /* if all except one arg are constant, or have no side-effects,
11353 * or are optimized away, then it's unambiguous */
11355 for (kid=o; kid; kid = kid->op_sibling) {
11357 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11358 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11359 || (kid->op_type == OP_PUSHMARK)
11363 if (o2) { /* more than one found */
11370 return find_uninit_var(o2, uninit_sv, match);
11372 /* scan all args */
11374 sv = find_uninit_var(o, uninit_sv, 1);
11386 =for apidoc report_uninit
11388 Print appropriate "Use of uninitialized variable" warning
11394 Perl_report_uninit(pTHX_ SV* uninit_sv)
11397 SV* varname = Nullsv;
11399 varname = find_uninit_var(PL_op, uninit_sv,0);
11401 sv_insert(varname, 0, 0, " ", 1);
11403 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11404 varname ? SvPV_nolen_const(varname) : "",
11405 " in ", OP_DESC(PL_op));
11408 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11414 * c-indentation-style: bsd
11415 * c-basic-offset: 4
11416 * indent-tabs-mode: t
11419 * ex: set ts=8 sts=4 sw=4 noet: