3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = Nullch;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 S_free_arena(pTHX_ void **root) {
562 void ** const next = *(void **)root;
569 =for apidoc sv_free_arenas
571 Deallocate the memory used by all arenas. Note that all the individual SV
572 heads and bodies within the arenas must already have been freed.
577 Perl_sv_free_arenas(pTHX)
584 /* Free arenas here, but be careful about fake ones. (We assume
585 contiguity of the fake ones with the corresponding real ones.) */
587 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
588 svanext = (SV*) SvANY(sva);
589 while (svanext && SvFAKE(svanext))
590 svanext = (SV*) SvANY(svanext);
596 S_free_arena(aTHX_ (void**) PL_body_arenas);
598 for (i=0; i<SVt_LAST; i++)
599 PL_body_roots[i] = 0;
601 Safefree(PL_nice_chunk);
602 PL_nice_chunk = Nullch;
603 PL_nice_chunk_size = 0;
609 Here are mid-level routines that manage the allocation of bodies out
610 of the various arenas. There are 5 kinds of arenas:
612 1. SV-head arenas, which are discussed and handled above
613 2. regular body arenas
614 3. arenas for reduced-size bodies
616 5. pte arenas (thread related)
618 Arena types 2 & 3 are chained by body-type off an array of
619 arena-root pointers, which is indexed by svtype. Some of the
620 larger/less used body types are malloced singly, since a large
621 unused block of them is wasteful. Also, several svtypes dont have
622 bodies; the data fits into the sv-head itself. The arena-root
623 pointer thus has a few unused root-pointers (which may be hijacked
624 later for arena types 4,5)
626 3 differs from 2 as an optimization; some body types have several
627 unused fields in the front of the structure (which are kept in-place
628 for consistency). These bodies can be allocated in smaller chunks,
629 because the leading fields arent accessed. Pointers to such bodies
630 are decremented to point at the unused 'ghost' memory, knowing that
631 the pointers are used with offsets to the real memory.
633 HE, HEK arenas are managed separately, with separate code, but may
634 be merge-able later..
636 PTE arenas are not sv-bodies, but they share these mid-level
637 mechanics, so are considered here. The new mid-level mechanics rely
638 on the sv_type of the body being allocated, so we just reserve one
639 of the unused body-slots for PTEs, then use it in those (2) PTE
640 contexts below (line ~10k)
644 S_more_bodies (pTHX_ size_t size, svtype sv_type)
647 void ** const root = &PL_body_roots[sv_type];
650 const size_t count = PERL_ARENA_SIZE / size;
652 Newx(start, count*size, char);
653 *((void **) start) = PL_body_arenas;
654 PL_body_arenas = (void *)start;
656 end = start + (count-1) * size;
658 /* The initial slot is used to link the arenas together, so it isn't to be
659 linked into the list of ready-to-use bodies. */
663 *root = (void *)start;
665 while (start < end) {
666 char * const next = start + size;
667 *(void**) start = (void *)next;
675 /* grab a new thing from the free list, allocating more if necessary */
677 /* 1st, the inline version */
679 #define new_body_inline(xpv, size, sv_type) \
681 void ** const r3wt = &PL_body_roots[sv_type]; \
683 xpv = *((void **)(r3wt)) \
684 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
685 *(r3wt) = *(void**)(xpv); \
689 /* now use the inline version in the proper function */
693 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
694 compilers issue warnings. */
697 S_new_body(pTHX_ size_t size, svtype sv_type)
701 new_body_inline(xpv, size, sv_type);
707 /* return a thing to the free list */
709 #define del_body(thing, root) \
711 void ** const thing_copy = (void **)thing;\
713 *thing_copy = *root; \
714 *root = (void*)thing_copy; \
719 Revisiting type 3 arenas, there are 4 body-types which have some
720 members that are never accessed. They are XPV, XPVIV, XPVAV,
721 XPVHV, which have corresponding types: xpv_allocated,
722 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
724 For these types, the arenas are carved up into *_allocated size
725 chunks, we thus avoid wasted memory for those unaccessed members.
726 When bodies are allocated, we adjust the pointer back in memory by
727 the size of the bit not allocated, so it's as if we allocated the
728 full structure. (But things will all go boom if you write to the
729 part that is "not there", because you'll be overwriting the last
730 members of the preceding structure in memory.)
732 We calculate the correction using the STRUCT_OFFSET macro. For example, if
733 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
734 and the pointer is unchanged. If the allocated structure is smaller (no
735 initial NV actually allocated) then the net effect is to subtract the size
736 of the NV from the pointer, to return a new pointer as if an initial NV were
739 This is the same trick as was used for NV and IV bodies. Ironically it
740 doesn't need to be used for NV bodies any more, because NV is now at the
741 start of the structure. IV bodies don't need it either, because they are
742 no longer allocated. */
744 /* The following 2 arrays hide the above details in a pair of
745 lookup-tables, allowing us to be body-type agnostic.
747 size maps svtype to its body's allocated size.
748 offset maps svtype to the body-pointer adjustment needed
750 NB: elements in latter are 0 or <0, and are added during
751 allocation, and subtracted during deallocation. It may be clearer
752 to invert the values, and call it shrinkage_by_svtype.
755 struct body_details {
756 size_t size; /* Size to allocate */
757 size_t copy; /* Size of structure to copy (may be shorter) */
759 bool cant_upgrade; /* Can upgrade this type */
760 bool zero_nv; /* zero the NV when upgrading from this */
761 bool arena; /* Allocated from an arena */
768 /* With -DPURFIY we allocate everything directly, and don't use arenas.
769 This seems a rather elegant way to simplify some of the code below. */
770 #define HASARENA FALSE
772 #define HASARENA TRUE
774 #define NOARENA FALSE
776 /* A macro to work out the offset needed to subtract from a pointer to (say)
783 to make its members accessible via a pointer to (say)
793 #define relative_STRUCT_OFFSET(longer, shorter, member) \
794 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
796 /* Calculate the length to copy. Specifically work out the length less any
797 final padding the compiler needed to add. See the comment in sv_upgrade
798 for why copying the padding proved to be a bug. */
800 #define copy_length(type, last_member) \
801 STRUCT_OFFSET(type, last_member) \
802 + sizeof (((type*)SvANY((SV*)0))->last_member)
804 static const struct body_details bodies_by_type[] = {
805 {0, 0, 0, FALSE, NONV, NOARENA},
806 /* IVs are in the head, so the allocation size is 0 */
807 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
808 /* 8 bytes on most ILP32 with IEEE doubles */
809 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
810 /* RVs are in the head now */
811 /* However, this slot is overloaded and used by the pte */
812 {0, 0, 0, FALSE, NONV, NOARENA},
813 /* 8 bytes on most ILP32 with IEEE doubles */
814 {sizeof(xpv_allocated),
815 copy_length(XPV, xpv_len)
816 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
817 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
818 FALSE, NONV, HASARENA},
820 {sizeof(xpviv_allocated),
821 copy_length(XPVIV, xiv_u)
822 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
823 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
824 FALSE, NONV, HASARENA},
826 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
828 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
830 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
832 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
834 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
836 {sizeof(xpvav_allocated),
837 copy_length(XPVAV, xmg_stash)
838 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
839 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
840 TRUE, HADNV, HASARENA},
842 {sizeof(xpvhv_allocated),
843 copy_length(XPVHV, xmg_stash)
844 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
845 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
846 TRUE, HADNV, HASARENA},
848 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
850 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
852 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
855 #define new_body_type(sv_type) \
856 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
857 - bodies_by_type[sv_type].offset)
859 #define del_body_type(p, sv_type) \
860 del_body(p, &PL_body_roots[sv_type])
863 #define new_body_allocated(sv_type) \
864 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
865 - bodies_by_type[sv_type].offset)
867 #define del_body_allocated(p, sv_type) \
868 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
871 #define my_safemalloc(s) (void*)safemalloc(s)
872 #define my_safecalloc(s) (void*)safecalloc(s, 1)
873 #define my_safefree(p) safefree((char*)p)
877 #define new_XNV() my_safemalloc(sizeof(XPVNV))
878 #define del_XNV(p) my_safefree(p)
880 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
881 #define del_XPVNV(p) my_safefree(p)
883 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
884 #define del_XPVAV(p) my_safefree(p)
886 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
887 #define del_XPVHV(p) my_safefree(p)
889 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
890 #define del_XPVMG(p) my_safefree(p)
892 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
893 #define del_XPVGV(p) my_safefree(p)
897 #define new_XNV() new_body_type(SVt_NV)
898 #define del_XNV(p) del_body_type(p, SVt_NV)
900 #define new_XPVNV() new_body_type(SVt_PVNV)
901 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
903 #define new_XPVAV() new_body_allocated(SVt_PVAV)
904 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
906 #define new_XPVHV() new_body_allocated(SVt_PVHV)
907 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
909 #define new_XPVMG() new_body_type(SVt_PVMG)
910 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
912 #define new_XPVGV() new_body_type(SVt_PVGV)
913 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
917 /* no arena for you! */
919 #define new_NOARENA(details) \
920 my_safemalloc((details)->size + (details)->offset)
921 #define new_NOARENAZ(details) \
922 my_safecalloc((details)->size + (details)->offset)
925 =for apidoc sv_upgrade
927 Upgrade an SV to a more complex form. Generally adds a new body type to the
928 SV, then copies across as much information as possible from the old body.
929 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
935 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
940 const U32 old_type = SvTYPE(sv);
941 const struct body_details *const old_type_details
942 = bodies_by_type + old_type;
943 const struct body_details *new_type_details = bodies_by_type + new_type;
945 if (new_type != SVt_PV && SvIsCOW(sv)) {
946 sv_force_normal_flags(sv, 0);
949 if (old_type == new_type)
952 if (old_type > new_type)
953 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
954 (int)old_type, (int)new_type);
957 old_body = SvANY(sv);
959 /* Copying structures onto other structures that have been neatly zeroed
960 has a subtle gotcha. Consider XPVMG
962 +------+------+------+------+------+-------+-------+
963 | NV | CUR | LEN | IV | MAGIC | STASH |
964 +------+------+------+------+------+-------+-------+
967 where NVs are aligned to 8 bytes, so that sizeof that structure is
968 actually 32 bytes long, with 4 bytes of padding at the end:
970 +------+------+------+------+------+-------+-------+------+
971 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
972 +------+------+------+------+------+-------+-------+------+
973 0 4 8 12 16 20 24 28 32
975 so what happens if you allocate memory for this structure:
977 +------+------+------+------+------+-------+-------+------+------+...
978 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
979 +------+------+------+------+------+-------+-------+------+------+...
980 0 4 8 12 16 20 24 28 32 36
982 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
983 expect, because you copy the area marked ??? onto GP. Now, ??? may have
984 started out as zero once, but it's quite possible that it isn't. So now,
985 rather than a nicely zeroed GP, you have it pointing somewhere random.
988 (In fact, GP ends up pointing at a previous GP structure, because the
989 principle cause of the padding in XPVMG getting garbage is a copy of
990 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
992 So we are careful and work out the size of used parts of all the
999 if (new_type < SVt_PVIV) {
1000 new_type = (new_type == SVt_NV)
1001 ? SVt_PVNV : SVt_PVIV;
1002 new_type_details = bodies_by_type + new_type;
1006 if (new_type < SVt_PVNV) {
1007 new_type = SVt_PVNV;
1008 new_type_details = bodies_by_type + new_type;
1014 assert(new_type > SVt_PV);
1015 assert(SVt_IV < SVt_PV);
1016 assert(SVt_NV < SVt_PV);
1023 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1024 there's no way that it can be safely upgraded, because perl.c
1025 expects to Safefree(SvANY(PL_mess_sv)) */
1026 assert(sv != PL_mess_sv);
1027 /* This flag bit is used to mean other things in other scalar types.
1028 Given that it only has meaning inside the pad, it shouldn't be set
1029 on anything that can get upgraded. */
1030 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1033 if (old_type_details->cant_upgrade)
1034 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1037 SvFLAGS(sv) &= ~SVTYPEMASK;
1038 SvFLAGS(sv) |= new_type;
1042 Perl_croak(aTHX_ "Can't upgrade to undef");
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = new_XNV();
1054 assert(old_type == SVt_NULL);
1055 SvANY(sv) = &sv->sv_u.svu_rv;
1059 SvANY(sv) = new_XPVHV();
1062 HvTOTALKEYS(sv) = 0;
1067 SvANY(sv) = new_XPVAV();
1074 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1075 The target created by newSVrv also is, and it can have magic.
1076 However, it never has SvPVX set.
1078 if (old_type >= SVt_RV) {
1079 assert(SvPVX_const(sv) == 0);
1082 /* Could put this in the else clause below, as PVMG must have SvPVX
1083 0 already (the assertion above) */
1086 if (old_type >= SVt_PVMG) {
1087 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1088 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1090 SvMAGIC_set(sv, NULL);
1091 SvSTASH_set(sv, NULL);
1097 /* XXX Is this still needed? Was it ever needed? Surely as there is
1098 no route from NV to PVIV, NOK can never be true */
1099 assert(!SvNOKp(sv));
1111 assert(new_type_details->size);
1112 /* We always allocated the full length item with PURIFY. To do this
1113 we fake things so that arena is false for all 16 types.. */
1114 if(new_type_details->arena) {
1115 /* This points to the start of the allocated area. */
1116 new_body_inline(new_body, new_type_details->size, new_type);
1117 Zero(new_body, new_type_details->size, char);
1118 new_body = ((char *)new_body) - new_type_details->offset;
1120 new_body = new_NOARENAZ(new_type_details);
1122 SvANY(sv) = new_body;
1124 if (old_type_details->copy) {
1125 Copy((char *)old_body + old_type_details->offset,
1126 (char *)new_body + old_type_details->offset,
1127 old_type_details->copy, char);
1130 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1131 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1132 * correct 0.0 for us. Otherwise, if the old body didn't have an
1133 * NV slot, but the new one does, then we need to initialise the
1134 * freshly created NV slot with whatever the correct bit pattern is
1136 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1140 if (new_type == SVt_PVIO)
1141 IoPAGE_LEN(sv) = 60;
1142 if (old_type < SVt_RV)
1146 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1147 (unsigned long)new_type);
1150 if (old_type_details->size) {
1151 /* If the old body had an allocated size, then we need to free it. */
1153 my_safefree(old_body);
1155 del_body((void*)((char*)old_body + old_type_details->offset),
1156 &PL_body_roots[old_type]);
1162 =for apidoc sv_backoff
1164 Remove any string offset. You should normally use the C<SvOOK_off> macro
1171 Perl_sv_backoff(pTHX_ register SV *sv)
1174 assert(SvTYPE(sv) != SVt_PVHV);
1175 assert(SvTYPE(sv) != SVt_PVAV);
1177 const char * const s = SvPVX_const(sv);
1178 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1179 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1181 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1183 SvFLAGS(sv) &= ~SVf_OOK;
1190 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1191 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1192 Use the C<SvGROW> wrapper instead.
1198 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1202 #ifdef HAS_64K_LIMIT
1203 if (newlen >= 0x10000) {
1204 PerlIO_printf(Perl_debug_log,
1205 "Allocation too large: %"UVxf"\n", (UV)newlen);
1208 #endif /* HAS_64K_LIMIT */
1211 if (SvTYPE(sv) < SVt_PV) {
1212 sv_upgrade(sv, SVt_PV);
1213 s = SvPVX_mutable(sv);
1215 else if (SvOOK(sv)) { /* pv is offset? */
1217 s = SvPVX_mutable(sv);
1218 if (newlen > SvLEN(sv))
1219 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1220 #ifdef HAS_64K_LIMIT
1221 if (newlen >= 0x10000)
1226 s = SvPVX_mutable(sv);
1228 if (newlen > SvLEN(sv)) { /* need more room? */
1229 newlen = PERL_STRLEN_ROUNDUP(newlen);
1230 if (SvLEN(sv) && s) {
1232 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1238 s = saferealloc(s, newlen);
1241 s = safemalloc(newlen);
1242 if (SvPVX_const(sv) && SvCUR(sv)) {
1243 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1247 SvLEN_set(sv, newlen);
1253 =for apidoc sv_setiv
1255 Copies an integer into the given SV, upgrading first if necessary.
1256 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1262 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1265 SV_CHECK_THINKFIRST_COW_DROP(sv);
1266 switch (SvTYPE(sv)) {
1268 sv_upgrade(sv, SVt_IV);
1271 sv_upgrade(sv, SVt_PVNV);
1275 sv_upgrade(sv, SVt_PVIV);
1284 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1287 (void)SvIOK_only(sv); /* validate number */
1293 =for apidoc sv_setiv_mg
1295 Like C<sv_setiv>, but also handles 'set' magic.
1301 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1308 =for apidoc sv_setuv
1310 Copies an unsigned integer into the given SV, upgrading first if necessary.
1311 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1317 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1319 /* With these two if statements:
1320 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1323 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1325 If you wish to remove them, please benchmark to see what the effect is
1327 if (u <= (UV)IV_MAX) {
1328 sv_setiv(sv, (IV)u);
1337 =for apidoc sv_setuv_mg
1339 Like C<sv_setuv>, but also handles 'set' magic.
1345 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1354 =for apidoc sv_setnv
1356 Copies a double into the given SV, upgrading first if necessary.
1357 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1363 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1366 SV_CHECK_THINKFIRST_COW_DROP(sv);
1367 switch (SvTYPE(sv)) {
1370 sv_upgrade(sv, SVt_NV);
1375 sv_upgrade(sv, SVt_PVNV);
1384 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1388 (void)SvNOK_only(sv); /* validate number */
1393 =for apidoc sv_setnv_mg
1395 Like C<sv_setnv>, but also handles 'set' magic.
1401 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1407 /* Print an "isn't numeric" warning, using a cleaned-up,
1408 * printable version of the offending string
1412 S_not_a_number(pTHX_ SV *sv)
1420 dsv = sv_2mortal(newSVpvs(""));
1421 pv = sv_uni_display(dsv, sv, 10, 0);
1424 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1425 /* each *s can expand to 4 chars + "...\0",
1426 i.e. need room for 8 chars */
1428 const char *s = SvPVX_const(sv);
1429 const char * const end = s + SvCUR(sv);
1430 for ( ; s < end && d < limit; s++ ) {
1432 if (ch & 128 && !isPRINT_LC(ch)) {
1441 else if (ch == '\r') {
1445 else if (ch == '\f') {
1449 else if (ch == '\\') {
1453 else if (ch == '\0') {
1457 else if (isPRINT_LC(ch))
1474 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1475 "Argument \"%s\" isn't numeric in %s", pv,
1478 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1479 "Argument \"%s\" isn't numeric", pv);
1483 =for apidoc looks_like_number
1485 Test if the content of an SV looks like a number (or is a number).
1486 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1487 non-numeric warning), even if your atof() doesn't grok them.
1493 Perl_looks_like_number(pTHX_ SV *sv)
1495 register const char *sbegin;
1499 sbegin = SvPVX_const(sv);
1502 else if (SvPOKp(sv))
1503 sbegin = SvPV_const(sv, len);
1505 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1506 return grok_number(sbegin, len, NULL);
1509 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1510 until proven guilty, assume that things are not that bad... */
1515 As 64 bit platforms often have an NV that doesn't preserve all bits of
1516 an IV (an assumption perl has been based on to date) it becomes necessary
1517 to remove the assumption that the NV always carries enough precision to
1518 recreate the IV whenever needed, and that the NV is the canonical form.
1519 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1520 precision as a side effect of conversion (which would lead to insanity
1521 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1522 1) to distinguish between IV/UV/NV slots that have cached a valid
1523 conversion where precision was lost and IV/UV/NV slots that have a
1524 valid conversion which has lost no precision
1525 2) to ensure that if a numeric conversion to one form is requested that
1526 would lose precision, the precise conversion (or differently
1527 imprecise conversion) is also performed and cached, to prevent
1528 requests for different numeric formats on the same SV causing
1529 lossy conversion chains. (lossless conversion chains are perfectly
1534 SvIOKp is true if the IV slot contains a valid value
1535 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1536 SvNOKp is true if the NV slot contains a valid value
1537 SvNOK is true only if the NV value is accurate
1540 while converting from PV to NV, check to see if converting that NV to an
1541 IV(or UV) would lose accuracy over a direct conversion from PV to
1542 IV(or UV). If it would, cache both conversions, return NV, but mark
1543 SV as IOK NOKp (ie not NOK).
1545 While converting from PV to IV, check to see if converting that IV to an
1546 NV would lose accuracy over a direct conversion from PV to NV. If it
1547 would, cache both conversions, flag similarly.
1549 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1550 correctly because if IV & NV were set NV *always* overruled.
1551 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1552 changes - now IV and NV together means that the two are interchangeable:
1553 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1555 The benefit of this is that operations such as pp_add know that if
1556 SvIOK is true for both left and right operands, then integer addition
1557 can be used instead of floating point (for cases where the result won't
1558 overflow). Before, floating point was always used, which could lead to
1559 loss of precision compared with integer addition.
1561 * making IV and NV equal status should make maths accurate on 64 bit
1563 * may speed up maths somewhat if pp_add and friends start to use
1564 integers when possible instead of fp. (Hopefully the overhead in
1565 looking for SvIOK and checking for overflow will not outweigh the
1566 fp to integer speedup)
1567 * will slow down integer operations (callers of SvIV) on "inaccurate"
1568 values, as the change from SvIOK to SvIOKp will cause a call into
1569 sv_2iv each time rather than a macro access direct to the IV slot
1570 * should speed up number->string conversion on integers as IV is
1571 favoured when IV and NV are equally accurate
1573 ####################################################################
1574 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1575 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1576 On the other hand, SvUOK is true iff UV.
1577 ####################################################################
1579 Your mileage will vary depending your CPU's relative fp to integer
1583 #ifndef NV_PRESERVES_UV
1584 # define IS_NUMBER_UNDERFLOW_IV 1
1585 # define IS_NUMBER_UNDERFLOW_UV 2
1586 # define IS_NUMBER_IV_AND_UV 2
1587 # define IS_NUMBER_OVERFLOW_IV 4
1588 # define IS_NUMBER_OVERFLOW_UV 5
1590 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1592 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1594 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1597 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));
1598 if (SvNVX(sv) < (NV)IV_MIN) {
1599 (void)SvIOKp_on(sv);
1601 SvIV_set(sv, IV_MIN);
1602 return IS_NUMBER_UNDERFLOW_IV;
1604 if (SvNVX(sv) > (NV)UV_MAX) {
1605 (void)SvIOKp_on(sv);
1608 SvUV_set(sv, UV_MAX);
1609 return IS_NUMBER_OVERFLOW_UV;
1611 (void)SvIOKp_on(sv);
1613 /* Can't use strtol etc to convert this string. (See truth table in
1615 if (SvNVX(sv) <= (UV)IV_MAX) {
1616 SvIV_set(sv, I_V(SvNVX(sv)));
1617 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1618 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1620 /* Integer is imprecise. NOK, IOKp */
1622 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1625 SvUV_set(sv, U_V(SvNVX(sv)));
1626 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1627 if (SvUVX(sv) == UV_MAX) {
1628 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1629 possibly be preserved by NV. Hence, it must be overflow.
1631 return IS_NUMBER_OVERFLOW_UV;
1633 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1635 /* Integer is imprecise. NOK, IOKp */
1637 return IS_NUMBER_OVERFLOW_IV;
1639 #endif /* !NV_PRESERVES_UV*/
1642 S_sv_2iuv_common(pTHX_ SV *sv) {
1645 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1646 * without also getting a cached IV/UV from it at the same time
1647 * (ie PV->NV conversion should detect loss of accuracy and cache
1648 * IV or UV at same time to avoid this. */
1649 /* IV-over-UV optimisation - choose to cache IV if possible */
1651 if (SvTYPE(sv) == SVt_NV)
1652 sv_upgrade(sv, SVt_PVNV);
1654 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1655 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1656 certainly cast into the IV range at IV_MAX, whereas the correct
1657 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1659 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1660 SvIV_set(sv, I_V(SvNVX(sv)));
1661 if (SvNVX(sv) == (NV) SvIVX(sv)
1662 #ifndef NV_PRESERVES_UV
1663 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1664 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1665 /* Don't flag it as "accurately an integer" if the number
1666 came from a (by definition imprecise) NV operation, and
1667 we're outside the range of NV integer precision */
1670 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1671 DEBUG_c(PerlIO_printf(Perl_debug_log,
1672 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1678 /* IV not precise. No need to convert from PV, as NV
1679 conversion would already have cached IV if it detected
1680 that PV->IV would be better than PV->NV->IV
1681 flags already correct - don't set public IOK. */
1682 DEBUG_c(PerlIO_printf(Perl_debug_log,
1683 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1688 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1689 but the cast (NV)IV_MIN rounds to a the value less (more
1690 negative) than IV_MIN which happens to be equal to SvNVX ??
1691 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1692 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1693 (NV)UVX == NVX are both true, but the values differ. :-(
1694 Hopefully for 2s complement IV_MIN is something like
1695 0x8000000000000000 which will be exact. NWC */
1698 SvUV_set(sv, U_V(SvNVX(sv)));
1700 (SvNVX(sv) == (NV) SvUVX(sv))
1701 #ifndef NV_PRESERVES_UV
1702 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1703 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1704 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1705 /* Don't flag it as "accurately an integer" if the number
1706 came from a (by definition imprecise) NV operation, and
1707 we're outside the range of NV integer precision */
1712 DEBUG_c(PerlIO_printf(Perl_debug_log,
1713 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1719 else if (SvPOKp(sv) && SvLEN(sv)) {
1721 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1722 /* We want to avoid a possible problem when we cache an IV/ a UV which
1723 may be later translated to an NV, and the resulting NV is not
1724 the same as the direct translation of the initial string
1725 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1726 be careful to ensure that the value with the .456 is around if the
1727 NV value is requested in the future).
1729 This means that if we cache such an IV/a UV, we need to cache the
1730 NV as well. Moreover, we trade speed for space, and do not
1731 cache the NV if we are sure it's not needed.
1734 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1735 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1736 == IS_NUMBER_IN_UV) {
1737 /* It's definitely an integer, only upgrade to PVIV */
1738 if (SvTYPE(sv) < SVt_PVIV)
1739 sv_upgrade(sv, SVt_PVIV);
1741 } else if (SvTYPE(sv) < SVt_PVNV)
1742 sv_upgrade(sv, SVt_PVNV);
1744 /* If NVs preserve UVs then we only use the UV value if we know that
1745 we aren't going to call atof() below. If NVs don't preserve UVs
1746 then the value returned may have more precision than atof() will
1747 return, even though value isn't perfectly accurate. */
1748 if ((numtype & (IS_NUMBER_IN_UV
1749 #ifdef NV_PRESERVES_UV
1752 )) == IS_NUMBER_IN_UV) {
1753 /* This won't turn off the public IOK flag if it was set above */
1754 (void)SvIOKp_on(sv);
1756 if (!(numtype & IS_NUMBER_NEG)) {
1758 if (value <= (UV)IV_MAX) {
1759 SvIV_set(sv, (IV)value);
1761 /* it didn't overflow, and it was positive. */
1762 SvUV_set(sv, value);
1766 /* 2s complement assumption */
1767 if (value <= (UV)IV_MIN) {
1768 SvIV_set(sv, -(IV)value);
1770 /* Too negative for an IV. This is a double upgrade, but
1771 I'm assuming it will be rare. */
1772 if (SvTYPE(sv) < SVt_PVNV)
1773 sv_upgrade(sv, SVt_PVNV);
1777 SvNV_set(sv, -(NV)value);
1778 SvIV_set(sv, IV_MIN);
1782 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1783 will be in the previous block to set the IV slot, and the next
1784 block to set the NV slot. So no else here. */
1786 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1787 != IS_NUMBER_IN_UV) {
1788 /* It wasn't an (integer that doesn't overflow the UV). */
1789 SvNV_set(sv, Atof(SvPVX_const(sv)));
1791 if (! numtype && ckWARN(WARN_NUMERIC))
1794 #if defined(USE_LONG_DOUBLE)
1795 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1796 PTR2UV(sv), SvNVX(sv)));
1798 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1799 PTR2UV(sv), SvNVX(sv)));
1802 #ifdef NV_PRESERVES_UV
1803 (void)SvIOKp_on(sv);
1805 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1806 SvIV_set(sv, I_V(SvNVX(sv)));
1807 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1810 /* Integer is imprecise. NOK, IOKp */
1812 /* UV will not work better than IV */
1814 if (SvNVX(sv) > (NV)UV_MAX) {
1816 /* Integer is inaccurate. NOK, IOKp, is UV */
1817 SvUV_set(sv, UV_MAX);
1819 SvUV_set(sv, U_V(SvNVX(sv)));
1820 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1821 NV preservse UV so can do correct comparison. */
1822 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1825 /* Integer is imprecise. NOK, IOKp, is UV */
1830 #else /* NV_PRESERVES_UV */
1831 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1832 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1833 /* The IV/UV slot will have been set from value returned by
1834 grok_number above. The NV slot has just been set using
1837 assert (SvIOKp(sv));
1839 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1840 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1841 /* Small enough to preserve all bits. */
1842 (void)SvIOKp_on(sv);
1844 SvIV_set(sv, I_V(SvNVX(sv)));
1845 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1847 /* Assumption: first non-preserved integer is < IV_MAX,
1848 this NV is in the preserved range, therefore: */
1849 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1851 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);
1855 0 0 already failed to read UV.
1856 0 1 already failed to read UV.
1857 1 0 you won't get here in this case. IV/UV
1858 slot set, public IOK, Atof() unneeded.
1859 1 1 already read UV.
1860 so there's no point in sv_2iuv_non_preserve() attempting
1861 to use atol, strtol, strtoul etc. */
1862 sv_2iuv_non_preserve (sv, numtype);
1865 #endif /* NV_PRESERVES_UV */
1869 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1870 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1873 if (SvTYPE(sv) < SVt_IV)
1874 /* Typically the caller expects that sv_any is not NULL now. */
1875 sv_upgrade(sv, SVt_IV);
1876 /* Return 0 from the caller. */
1883 =for apidoc sv_2iv_flags
1885 Return the integer value of an SV, doing any necessary string
1886 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1887 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1893 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1898 if (SvGMAGICAL(sv)) {
1899 if (flags & SV_GMAGIC)
1904 return I_V(SvNVX(sv));
1906 if (SvPOKp(sv) && SvLEN(sv)) {
1909 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1911 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1912 == IS_NUMBER_IN_UV) {
1913 /* It's definitely an integer */
1914 if (numtype & IS_NUMBER_NEG) {
1915 if (value < (UV)IV_MIN)
1918 if (value < (UV)IV_MAX)
1923 if (ckWARN(WARN_NUMERIC))
1926 return I_V(Atof(SvPVX_const(sv)));
1931 assert(SvTYPE(sv) >= SVt_PVMG);
1932 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1933 } else if (SvTHINKFIRST(sv)) {
1937 SV * const tmpstr=AMG_CALLun(sv,numer);
1938 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1939 return SvIV(tmpstr);
1942 return PTR2IV(SvRV(sv));
1945 sv_force_normal_flags(sv, 0);
1947 if (SvREADONLY(sv) && !SvOK(sv)) {
1948 if (ckWARN(WARN_UNINITIALIZED))
1954 if (S_sv_2iuv_common(aTHX_ sv))
1957 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1958 PTR2UV(sv),SvIVX(sv)));
1959 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1963 =for apidoc sv_2uv_flags
1965 Return the unsigned integer value of an SV, doing any necessary string
1966 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1967 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1973 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1978 if (SvGMAGICAL(sv)) {
1979 if (flags & SV_GMAGIC)
1984 return U_V(SvNVX(sv));
1985 if (SvPOKp(sv) && SvLEN(sv)) {
1988 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1990 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1991 == IS_NUMBER_IN_UV) {
1992 /* It's definitely an integer */
1993 if (!(numtype & IS_NUMBER_NEG))
1997 if (ckWARN(WARN_NUMERIC))
2000 return U_V(Atof(SvPVX_const(sv)));
2005 assert(SvTYPE(sv) >= SVt_PVMG);
2006 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2007 } else if (SvTHINKFIRST(sv)) {
2011 SV *const tmpstr = AMG_CALLun(sv,numer);
2012 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2013 return SvUV(tmpstr);
2016 return PTR2UV(SvRV(sv));
2019 sv_force_normal_flags(sv, 0);
2021 if (SvREADONLY(sv) && !SvOK(sv)) {
2022 if (ckWARN(WARN_UNINITIALIZED))
2028 if (S_sv_2iuv_common(aTHX_ sv))
2032 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2033 PTR2UV(sv),SvUVX(sv)));
2034 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2040 Return the num value of an SV, doing any necessary string or integer
2041 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2048 Perl_sv_2nv(pTHX_ register SV *sv)
2053 if (SvGMAGICAL(sv)) {
2057 if (SvPOKp(sv) && SvLEN(sv)) {
2058 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2059 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2061 return Atof(SvPVX_const(sv));
2065 return (NV)SvUVX(sv);
2067 return (NV)SvIVX(sv);
2072 assert(SvTYPE(sv) >= SVt_PVMG);
2073 /* This falls through to the report_uninit near the end of the
2075 } else if (SvTHINKFIRST(sv)) {
2079 SV *const tmpstr = AMG_CALLun(sv,numer);
2080 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2081 return SvNV(tmpstr);
2084 return PTR2NV(SvRV(sv));
2087 sv_force_normal_flags(sv, 0);
2089 if (SvREADONLY(sv) && !SvOK(sv)) {
2090 if (ckWARN(WARN_UNINITIALIZED))
2095 if (SvTYPE(sv) < SVt_NV) {
2096 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2097 sv_upgrade(sv, SVt_NV);
2098 #ifdef USE_LONG_DOUBLE
2100 STORE_NUMERIC_LOCAL_SET_STANDARD();
2101 PerlIO_printf(Perl_debug_log,
2102 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2103 PTR2UV(sv), SvNVX(sv));
2104 RESTORE_NUMERIC_LOCAL();
2108 STORE_NUMERIC_LOCAL_SET_STANDARD();
2109 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2110 PTR2UV(sv), SvNVX(sv));
2111 RESTORE_NUMERIC_LOCAL();
2115 else if (SvTYPE(sv) < SVt_PVNV)
2116 sv_upgrade(sv, SVt_PVNV);
2121 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2122 #ifdef NV_PRESERVES_UV
2125 /* Only set the public NV OK flag if this NV preserves the IV */
2126 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2127 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2128 : (SvIVX(sv) == I_V(SvNVX(sv))))
2134 else if (SvPOKp(sv) && SvLEN(sv)) {
2136 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2137 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2139 #ifdef NV_PRESERVES_UV
2140 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2141 == IS_NUMBER_IN_UV) {
2142 /* It's definitely an integer */
2143 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2145 SvNV_set(sv, Atof(SvPVX_const(sv)));
2148 SvNV_set(sv, Atof(SvPVX_const(sv)));
2149 /* Only set the public NV OK flag if this NV preserves the value in
2150 the PV at least as well as an IV/UV would.
2151 Not sure how to do this 100% reliably. */
2152 /* if that shift count is out of range then Configure's test is
2153 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2155 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2156 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2157 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2158 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2159 /* Can't use strtol etc to convert this string, so don't try.
2160 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2163 /* value has been set. It may not be precise. */
2164 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2165 /* 2s complement assumption for (UV)IV_MIN */
2166 SvNOK_on(sv); /* Integer is too negative. */
2171 if (numtype & IS_NUMBER_NEG) {
2172 SvIV_set(sv, -(IV)value);
2173 } else if (value <= (UV)IV_MAX) {
2174 SvIV_set(sv, (IV)value);
2176 SvUV_set(sv, value);
2180 if (numtype & IS_NUMBER_NOT_INT) {
2181 /* I believe that even if the original PV had decimals,
2182 they are lost beyond the limit of the FP precision.
2183 However, neither is canonical, so both only get p
2184 flags. NWC, 2000/11/25 */
2185 /* Both already have p flags, so do nothing */
2187 const NV nv = SvNVX(sv);
2188 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2189 if (SvIVX(sv) == I_V(nv)) {
2192 /* It had no "." so it must be integer. */
2196 /* between IV_MAX and NV(UV_MAX).
2197 Could be slightly > UV_MAX */
2199 if (numtype & IS_NUMBER_NOT_INT) {
2200 /* UV and NV both imprecise. */
2202 const UV nv_as_uv = U_V(nv);
2204 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2213 #endif /* NV_PRESERVES_UV */
2216 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2218 assert (SvTYPE(sv) >= SVt_NV);
2219 /* Typically the caller expects that sv_any is not NULL now. */
2220 /* XXX Ilya implies that this is a bug in callers that assume this
2221 and ideally should be fixed. */
2224 #if defined(USE_LONG_DOUBLE)
2226 STORE_NUMERIC_LOCAL_SET_STANDARD();
2227 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2228 PTR2UV(sv), SvNVX(sv));
2229 RESTORE_NUMERIC_LOCAL();
2233 STORE_NUMERIC_LOCAL_SET_STANDARD();
2234 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2235 PTR2UV(sv), SvNVX(sv));
2236 RESTORE_NUMERIC_LOCAL();
2242 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2243 * UV as a string towards the end of buf, and return pointers to start and
2246 * We assume that buf is at least TYPE_CHARS(UV) long.
2250 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2252 char *ptr = buf + TYPE_CHARS(UV);
2253 char * const ebuf = ptr;
2266 *--ptr = '0' + (char)(uv % 10);
2274 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2275 * a regexp to its stringified form.
2279 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2281 const regexp * const re = (regexp *)mg->mg_obj;
2284 const char *fptr = "msix";
2289 bool need_newline = 0;
2290 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2292 while((ch = *fptr++)) {
2294 reflags[left++] = ch;
2297 reflags[right--] = ch;
2302 reflags[left] = '-';
2306 mg->mg_len = re->prelen + 4 + left;
2308 * If /x was used, we have to worry about a regex ending with a
2309 * comment later being embedded within another regex. If so, we don't
2310 * want this regex's "commentization" to leak out to the right part of
2311 * the enclosing regex, we must cap it with a newline.
2313 * So, if /x was used, we scan backwards from the end of the regex. If
2314 * we find a '#' before we find a newline, we need to add a newline
2315 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2316 * we don't need to add anything. -jfriedl
2318 if (PMf_EXTENDED & re->reganch) {
2319 const char *endptr = re->precomp + re->prelen;
2320 while (endptr >= re->precomp) {
2321 const char c = *(endptr--);
2323 break; /* don't need another */
2325 /* we end while in a comment, so we need a newline */
2326 mg->mg_len++; /* save space for it */
2327 need_newline = 1; /* note to add it */
2333 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2334 mg->mg_ptr[0] = '(';
2335 mg->mg_ptr[1] = '?';
2336 Copy(reflags, mg->mg_ptr+2, left, char);
2337 *(mg->mg_ptr+left+2) = ':';
2338 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2340 mg->mg_ptr[mg->mg_len - 2] = '\n';
2341 mg->mg_ptr[mg->mg_len - 1] = ')';
2342 mg->mg_ptr[mg->mg_len] = 0;
2344 PL_reginterp_cnt += re->program[0].next_off;
2346 if (re->reganch & ROPT_UTF8)
2356 =for apidoc sv_2pv_flags
2358 Returns a pointer to the string value of an SV, and sets *lp to its length.
2359 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2361 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2362 usually end up here too.
2368 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2378 if (SvGMAGICAL(sv)) {
2379 if (flags & SV_GMAGIC)
2384 if (flags & SV_MUTABLE_RETURN)
2385 return SvPVX_mutable(sv);
2386 if (flags & SV_CONST_RETURN)
2387 return (char *)SvPVX_const(sv);
2390 if (SvIOKp(sv) || SvNOKp(sv)) {
2391 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2395 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2396 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2398 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2401 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2402 /* Sneaky stuff here */
2403 SV * const tsv = newSVpvn(tbuf, len);
2413 #ifdef FIXNEGATIVEZERO
2414 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2420 SvUPGRADE(sv, SVt_PV);
2423 s = SvGROW_mutable(sv, len + 1);
2426 return memcpy(s, tbuf, len + 1);
2432 assert(SvTYPE(sv) >= SVt_PVMG);
2433 /* This falls through to the report_uninit near the end of the
2435 } else if (SvTHINKFIRST(sv)) {
2439 SV *const tmpstr = AMG_CALLun(sv,string);
2440 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2442 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2446 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2447 if (flags & SV_CONST_RETURN) {
2448 pv = (char *) SvPVX_const(tmpstr);
2450 pv = (flags & SV_MUTABLE_RETURN)
2451 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2454 *lp = SvCUR(tmpstr);
2456 pv = sv_2pv_flags(tmpstr, lp, flags);
2468 const SV *const referent = (SV*)SvRV(sv);
2471 tsv = sv_2mortal(newSVpvs("NULLREF"));
2472 } else if (SvTYPE(referent) == SVt_PVMG
2473 && ((SvFLAGS(referent) &
2474 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2475 == (SVs_OBJECT|SVs_SMG))
2476 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2477 return stringify_regexp(sv, mg, lp);
2479 const char *const typestr = sv_reftype(referent, 0);
2481 tsv = sv_newmortal();
2482 if (SvOBJECT(referent)) {
2483 const char *const name = HvNAME_get(SvSTASH(referent));
2484 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2485 name ? name : "__ANON__" , typestr,
2489 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2497 if (SvREADONLY(sv) && !SvOK(sv)) {
2498 if (ckWARN(WARN_UNINITIALIZED))
2505 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2506 /* I'm assuming that if both IV and NV are equally valid then
2507 converting the IV is going to be more efficient */
2508 const U32 isIOK = SvIOK(sv);
2509 const U32 isUIOK = SvIsUV(sv);
2510 char buf[TYPE_CHARS(UV)];
2513 if (SvTYPE(sv) < SVt_PVIV)
2514 sv_upgrade(sv, SVt_PVIV);
2515 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2516 /* inlined from sv_setpvn */
2517 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2518 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2519 SvCUR_set(sv, ebuf - ptr);
2529 else if (SvNOKp(sv)) {
2530 const int olderrno = errno;
2531 if (SvTYPE(sv) < SVt_PVNV)
2532 sv_upgrade(sv, SVt_PVNV);
2533 /* The +20 is pure guesswork. Configure test needed. --jhi */
2534 s = SvGROW_mutable(sv, NV_DIG + 20);
2535 /* some Xenix systems wipe out errno here */
2537 if (SvNVX(sv) == 0.0)
2538 (void)strcpy(s,"0");
2542 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2545 #ifdef FIXNEGATIVEZERO
2546 if (*s == '-' && s[1] == '0' && !s[2])
2556 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2560 if (SvTYPE(sv) < SVt_PV)
2561 /* Typically the caller expects that sv_any is not NULL now. */
2562 sv_upgrade(sv, SVt_PV);
2566 const STRLEN len = s - SvPVX_const(sv);
2572 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2573 PTR2UV(sv),SvPVX_const(sv)));
2574 if (flags & SV_CONST_RETURN)
2575 return (char *)SvPVX_const(sv);
2576 if (flags & SV_MUTABLE_RETURN)
2577 return SvPVX_mutable(sv);
2582 =for apidoc sv_copypv
2584 Copies a stringified representation of the source SV into the
2585 destination SV. Automatically performs any necessary mg_get and
2586 coercion of numeric values into strings. Guaranteed to preserve
2587 UTF-8 flag even from overloaded objects. Similar in nature to
2588 sv_2pv[_flags] but operates directly on an SV instead of just the
2589 string. Mostly uses sv_2pv_flags to do its work, except when that
2590 would lose the UTF-8'ness of the PV.
2596 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2599 const char * const s = SvPV_const(ssv,len);
2600 sv_setpvn(dsv,s,len);
2608 =for apidoc sv_2pvbyte
2610 Return a pointer to the byte-encoded representation of the SV, and set *lp
2611 to its length. May cause the SV to be downgraded from UTF-8 as a
2614 Usually accessed via the C<SvPVbyte> macro.
2620 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2622 sv_utf8_downgrade(sv,0);
2623 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2627 =for apidoc sv_2pvutf8
2629 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2630 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2632 Usually accessed via the C<SvPVutf8> macro.
2638 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2640 sv_utf8_upgrade(sv);
2641 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2646 =for apidoc sv_2bool
2648 This function is only called on magical items, and is only used by
2649 sv_true() or its macro equivalent.
2655 Perl_sv_2bool(pTHX_ register SV *sv)
2664 SV * const tmpsv = AMG_CALLun(sv,bool_);
2665 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2666 return (bool)SvTRUE(tmpsv);
2668 return SvRV(sv) != 0;
2671 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2673 (*sv->sv_u.svu_pv > '0' ||
2674 Xpvtmp->xpv_cur > 1 ||
2675 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2682 return SvIVX(sv) != 0;
2685 return SvNVX(sv) != 0.0;
2693 =for apidoc sv_utf8_upgrade
2695 Converts the PV of an SV to its UTF-8-encoded form.
2696 Forces the SV to string form if it is not already.
2697 Always sets the SvUTF8 flag to avoid future validity checks even
2698 if all the bytes have hibit clear.
2700 This is not as a general purpose byte encoding to Unicode interface:
2701 use the Encode extension for that.
2703 =for apidoc sv_utf8_upgrade_flags
2705 Converts the PV of an SV to its UTF-8-encoded form.
2706 Forces the SV to string form if it is not already.
2707 Always sets the SvUTF8 flag to avoid future validity checks even
2708 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2709 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2710 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2712 This is not as a general purpose byte encoding to Unicode interface:
2713 use the Encode extension for that.
2719 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2722 if (sv == &PL_sv_undef)
2726 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2727 (void) sv_2pv_flags(sv,&len, flags);
2731 (void) SvPV_force(sv,len);
2740 sv_force_normal_flags(sv, 0);
2743 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2744 sv_recode_to_utf8(sv, PL_encoding);
2745 else { /* Assume Latin-1/EBCDIC */
2746 /* This function could be much more efficient if we
2747 * had a FLAG in SVs to signal if there are any hibit
2748 * chars in the PV. Given that there isn't such a flag
2749 * make the loop as fast as possible. */
2750 const U8 * const s = (U8 *) SvPVX_const(sv);
2751 const U8 * const e = (U8 *) SvEND(sv);
2756 /* Check for hi bit */
2757 if (!NATIVE_IS_INVARIANT(ch)) {
2758 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2759 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2761 SvPV_free(sv); /* No longer using what was there before. */
2762 SvPV_set(sv, (char*)recoded);
2763 SvCUR_set(sv, len - 1);
2764 SvLEN_set(sv, len); /* No longer know the real size. */
2768 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2775 =for apidoc sv_utf8_downgrade
2777 Attempts to convert the PV of an SV from characters to bytes.
2778 If the PV contains a character beyond byte, this conversion will fail;
2779 in this case, either returns false or, if C<fail_ok> is not
2782 This is not as a general purpose Unicode to byte encoding interface:
2783 use the Encode extension for that.
2789 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2792 if (SvPOKp(sv) && SvUTF8(sv)) {
2798 sv_force_normal_flags(sv, 0);
2800 s = (U8 *) SvPV(sv, len);
2801 if (!utf8_to_bytes(s, &len)) {
2806 Perl_croak(aTHX_ "Wide character in %s",
2809 Perl_croak(aTHX_ "Wide character");
2820 =for apidoc sv_utf8_encode
2822 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2823 flag off so that it looks like octets again.
2829 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2831 (void) sv_utf8_upgrade(sv);
2833 sv_force_normal_flags(sv, 0);
2835 if (SvREADONLY(sv)) {
2836 Perl_croak(aTHX_ PL_no_modify);
2842 =for apidoc sv_utf8_decode
2844 If the PV of the SV is an octet sequence in UTF-8
2845 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2846 so that it looks like a character. If the PV contains only single-byte
2847 characters, the C<SvUTF8> flag stays being off.
2848 Scans PV for validity and returns false if the PV is invalid UTF-8.
2854 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2860 /* The octets may have got themselves encoded - get them back as
2863 if (!sv_utf8_downgrade(sv, TRUE))
2866 /* it is actually just a matter of turning the utf8 flag on, but
2867 * we want to make sure everything inside is valid utf8 first.
2869 c = (const U8 *) SvPVX_const(sv);
2870 if (!is_utf8_string(c, SvCUR(sv)+1))
2872 e = (const U8 *) SvEND(sv);
2875 if (!UTF8_IS_INVARIANT(ch)) {
2885 =for apidoc sv_setsv
2887 Copies the contents of the source SV C<ssv> into the destination SV
2888 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2889 function if the source SV needs to be reused. Does not handle 'set' magic.
2890 Loosely speaking, it performs a copy-by-value, obliterating any previous
2891 content of the destination.
2893 You probably want to use one of the assortment of wrappers, such as
2894 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2895 C<SvSetMagicSV_nosteal>.
2897 =for apidoc sv_setsv_flags
2899 Copies the contents of the source SV C<ssv> into the destination SV
2900 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2901 function if the source SV needs to be reused. Does not handle 'set' magic.
2902 Loosely speaking, it performs a copy-by-value, obliterating any previous
2903 content of the destination.
2904 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2905 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2906 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2907 and C<sv_setsv_nomg> are implemented in terms of this function.
2909 You probably want to use one of the assortment of wrappers, such as
2910 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2911 C<SvSetMagicSV_nosteal>.
2913 This is the primary function for copying scalars, and most other
2914 copy-ish functions and macros use this underneath.
2920 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
2922 if (dtype != SVt_PVGV) {
2923 const char * const name = GvNAME(sstr);
2924 const STRLEN len = GvNAMELEN(sstr);
2925 /* don't upgrade SVt_PVLV: it can hold a glob */
2926 if (dtype != SVt_PVLV)
2927 sv_upgrade(dstr, SVt_PVGV);
2928 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
2929 GvSTASH(dstr) = GvSTASH(sstr);
2931 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
2932 GvNAME(dstr) = savepvn(name, len);
2933 GvNAMELEN(dstr) = len;
2934 SvFAKE_on(dstr); /* can coerce to non-glob */
2937 #ifdef GV_UNIQUE_CHECK
2938 if (GvUNIQUE((GV*)dstr)) {
2939 Perl_croak(aTHX_ PL_no_modify);
2943 (void)SvOK_off(dstr);
2944 GvINTRO_off(dstr); /* one-shot flag */
2946 GvGP(dstr) = gp_ref(GvGP(sstr));
2947 if (SvTAINTED(sstr))
2949 if (GvIMPORTED(dstr) != GVf_IMPORTED
2950 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2952 GvIMPORTED_on(dstr);
2959 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
2960 SV * const sref = SvREFCNT_inc(SvRV(sstr));
2962 const int intro = GvINTRO(dstr);
2964 #ifdef GV_UNIQUE_CHECK
2965 if (GvUNIQUE((GV*)dstr)) {
2966 Perl_croak(aTHX_ PL_no_modify);
2971 GvINTRO_off(dstr); /* one-shot flag */
2972 GvLINE(dstr) = CopLINE(PL_curcop);
2973 GvEGV(dstr) = (GV*)dstr;
2976 switch (SvTYPE(sref)) {
2979 SAVEGENERICSV(GvAV(dstr));
2981 dref = (SV*)GvAV(dstr);
2982 GvAV(dstr) = (AV*)sref;
2983 if (!GvIMPORTED_AV(dstr)
2984 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2986 GvIMPORTED_AV_on(dstr);
2991 SAVEGENERICSV(GvHV(dstr));
2993 dref = (SV*)GvHV(dstr);
2994 GvHV(dstr) = (HV*)sref;
2995 if (!GvIMPORTED_HV(dstr)
2996 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2998 GvIMPORTED_HV_on(dstr);
3003 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3004 SvREFCNT_dec(GvCV(dstr));
3005 GvCV(dstr) = Nullcv;
3006 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3007 PL_sub_generation++;
3009 SAVEGENERICSV(GvCV(dstr));
3012 dref = (SV*)GvCV(dstr);
3013 if (GvCV(dstr) != (CV*)sref) {
3014 CV* const cv = GvCV(dstr);
3016 if (!GvCVGEN((GV*)dstr) &&
3017 (CvROOT(cv) || CvXSUB(cv)))
3019 /* Redefining a sub - warning is mandatory if
3020 it was a const and its value changed. */
3021 if (CvCONST(cv) && CvCONST((CV*)sref)
3022 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3023 /* They are 2 constant subroutines generated from
3024 the same constant. This probably means that
3025 they are really the "same" proxy subroutine
3026 instantiated in 2 places. Most likely this is
3027 when a constant is exported twice. Don't warn.
3030 else if (ckWARN(WARN_REDEFINE)
3032 && (!CvCONST((CV*)sref)
3033 || sv_cmp(cv_const_sv(cv),
3034 cv_const_sv((CV*)sref))))) {
3035 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3037 ? "Constant subroutine %s::%s redefined"
3038 : "Subroutine %s::%s redefined",
3039 HvNAME_get(GvSTASH((GV*)dstr)),
3040 GvENAME((GV*)dstr));
3044 cv_ckproto(cv, (GV*)dstr,
3045 SvPOK(sref) ? SvPVX_const(sref) : Nullch);
3047 GvCV(dstr) = (CV*)sref;
3048 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3049 GvASSUMECV_on(dstr);
3050 PL_sub_generation++;
3052 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3053 GvIMPORTED_CV_on(dstr);
3058 SAVEGENERICSV(GvIOp(dstr));
3060 dref = (SV*)GvIOp(dstr);
3061 GvIOp(dstr) = (IO*)sref;
3065 SAVEGENERICSV(GvFORM(dstr));
3067 dref = (SV*)GvFORM(dstr);
3068 GvFORM(dstr) = (CV*)sref;
3072 SAVEGENERICSV(GvSV(dstr));
3074 dref = (SV*)GvSV(dstr);
3076 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3077 GvIMPORTED_SV_on(dstr);
3083 if (SvTAINTED(sstr))
3089 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3092 register U32 sflags;
3098 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3100 sstr = &PL_sv_undef;
3101 stype = SvTYPE(sstr);
3102 dtype = SvTYPE(dstr);
3107 /* need to nuke the magic */
3109 SvRMAGICAL_off(dstr);
3112 /* There's a lot of redundancy below but we're going for speed here */
3117 if (dtype != SVt_PVGV) {
3118 (void)SvOK_off(dstr);
3126 sv_upgrade(dstr, SVt_IV);
3129 sv_upgrade(dstr, SVt_PVNV);
3133 sv_upgrade(dstr, SVt_PVIV);
3136 (void)SvIOK_only(dstr);
3137 SvIV_set(dstr, SvIVX(sstr));
3140 /* SvTAINTED can only be true if the SV has taint magic, which in
3141 turn means that the SV type is PVMG (or greater). This is the
3142 case statement for SVt_IV, so this cannot be true (whatever gcov
3144 assert(!SvTAINTED(sstr));
3154 sv_upgrade(dstr, SVt_NV);
3159 sv_upgrade(dstr, SVt_PVNV);
3162 SvNV_set(dstr, SvNVX(sstr));
3163 (void)SvNOK_only(dstr);
3164 /* SvTAINTED can only be true if the SV has taint magic, which in
3165 turn means that the SV type is PVMG (or greater). This is the
3166 case statement for SVt_NV, so this cannot be true (whatever gcov
3168 assert(!SvTAINTED(sstr));
3175 sv_upgrade(dstr, SVt_RV);
3176 else if (dtype == SVt_PVGV &&
3177 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3180 if (GvIMPORTED(dstr) != GVf_IMPORTED
3181 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3183 GvIMPORTED_on(dstr);
3188 S_glob_assign(aTHX_ dstr, sstr, dtype);
3193 #ifdef PERL_OLD_COPY_ON_WRITE
3194 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3195 if (dtype < SVt_PVIV)
3196 sv_upgrade(dstr, SVt_PVIV);
3203 sv_upgrade(dstr, SVt_PV);
3206 if (dtype < SVt_PVIV)
3207 sv_upgrade(dstr, SVt_PVIV);
3210 if (dtype < SVt_PVNV)
3211 sv_upgrade(dstr, SVt_PVNV);
3218 const char * const type = sv_reftype(sstr,0);
3220 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3222 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3227 if (dtype <= SVt_PVGV) {
3228 S_glob_assign(aTHX_ dstr, sstr, dtype);
3234 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3236 if ((int)SvTYPE(sstr) != stype) {
3237 stype = SvTYPE(sstr);
3238 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3239 S_glob_assign(aTHX_ dstr, sstr, dtype);
3244 if (stype == SVt_PVLV)
3245 SvUPGRADE(dstr, SVt_PVNV);
3247 SvUPGRADE(dstr, (U32)stype);
3250 sflags = SvFLAGS(sstr);
3252 if (sflags & SVf_ROK) {
3253 if (dtype >= SVt_PV) {
3254 if (dtype == SVt_PVGV) {
3255 S_pvgv_assign(aTHX_ dstr, sstr);
3258 if (SvPVX_const(dstr)) {
3264 (void)SvOK_off(dstr);
3265 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3266 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_ROK
3268 if (sflags & SVp_NOK) {
3269 SvNV_set(dstr, SvNVX(sstr));
3271 if (sflags & SVp_IOK) {
3272 /* Must do this otherwise some other overloaded use of 0x80000000
3273 gets confused. Probably 0x80000000 */
3274 if (sflags & SVf_IVisUV)
3276 SvIV_set(dstr, SvIVX(sstr));
3279 else if (sflags & SVp_POK) {
3283 * Check to see if we can just swipe the string. If so, it's a
3284 * possible small lose on short strings, but a big win on long ones.
3285 * It might even be a win on short strings if SvPVX_const(dstr)
3286 * has to be allocated and SvPVX_const(sstr) has to be freed.
3289 /* Whichever path we take through the next code, we want this true,
3290 and doing it now facilitates the COW check. */
3291 (void)SvPOK_only(dstr);
3294 /* We're not already COW */
3295 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3296 #ifndef PERL_OLD_COPY_ON_WRITE
3297 /* or we are, but dstr isn't a suitable target. */
3298 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3303 (sflags & SVs_TEMP) && /* slated for free anyway? */
3304 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3305 (!(flags & SV_NOSTEAL)) &&
3306 /* and we're allowed to steal temps */
3307 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3308 SvLEN(sstr) && /* and really is a string */
3309 /* and won't be needed again, potentially */
3310 !(PL_op && PL_op->op_type == OP_AASSIGN))
3311 #ifdef PERL_OLD_COPY_ON_WRITE
3312 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3313 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3314 && SvTYPE(sstr) >= SVt_PVIV)
3317 /* Failed the swipe test, and it's not a shared hash key either.
3318 Have to copy the string. */
3319 STRLEN len = SvCUR(sstr);
3320 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3321 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3322 SvCUR_set(dstr, len);
3323 *SvEND(dstr) = '\0';
3325 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3327 /* Either it's a shared hash key, or it's suitable for
3328 copy-on-write or we can swipe the string. */
3330 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3334 #ifdef PERL_OLD_COPY_ON_WRITE
3336 /* I believe I should acquire a global SV mutex if
3337 it's a COW sv (not a shared hash key) to stop
3338 it going un copy-on-write.
3339 If the source SV has gone un copy on write between up there
3340 and down here, then (assert() that) it is of the correct
3341 form to make it copy on write again */
3342 if ((sflags & (SVf_FAKE | SVf_READONLY))
3343 != (SVf_FAKE | SVf_READONLY)) {
3344 SvREADONLY_on(sstr);
3346 /* Make the source SV into a loop of 1.
3347 (about to become 2) */
3348 SV_COW_NEXT_SV_SET(sstr, sstr);
3352 /* Initial code is common. */
3353 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3358 /* making another shared SV. */
3359 STRLEN cur = SvCUR(sstr);
3360 STRLEN len = SvLEN(sstr);
3361 #ifdef PERL_OLD_COPY_ON_WRITE
3363 assert (SvTYPE(dstr) >= SVt_PVIV);
3364 /* SvIsCOW_normal */
3365 /* splice us in between source and next-after-source. */
3366 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3367 SV_COW_NEXT_SV_SET(sstr, dstr);
3368 SvPV_set(dstr, SvPVX_mutable(sstr));
3372 /* SvIsCOW_shared_hash */
3373 DEBUG_C(PerlIO_printf(Perl_debug_log,
3374 "Copy on write: Sharing hash\n"));
3376 assert (SvTYPE(dstr) >= SVt_PV);
3378 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3380 SvLEN_set(dstr, len);
3381 SvCUR_set(dstr, cur);
3382 SvREADONLY_on(dstr);
3384 /* Relesase a global SV mutex. */
3387 { /* Passes the swipe test. */
3388 SvPV_set(dstr, SvPVX_mutable(sstr));
3389 SvLEN_set(dstr, SvLEN(sstr));
3390 SvCUR_set(dstr, SvCUR(sstr));
3393 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3394 SvPV_set(sstr, NULL);
3400 if (sflags & SVp_NOK) {
3401 SvNV_set(dstr, SvNVX(sstr));
3403 if (sflags & SVp_IOK) {
3404 SvRELEASE_IVX(dstr);
3405 SvIV_set(dstr, SvIVX(sstr));
3406 /* Must do this otherwise some other overloaded use of 0x80000000
3407 gets confused. I guess SVpbm_VALID */
3408 if (sflags & SVf_IVisUV)
3411 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3413 const MAGIC * const smg = SvVOK(sstr);
3415 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3416 smg->mg_ptr, smg->mg_len);
3417 SvRMAGICAL_on(dstr);
3421 else if (sflags & (SVp_IOK|SVp_NOK)) {
3422 (void)SvOK_off(dstr);
3423 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3424 if (sflags & SVp_IOK) {
3425 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3426 SvIV_set(dstr, SvIVX(sstr));
3428 if (sflags & SVp_NOK) {
3429 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3430 SvNV_set(dstr, SvNVX(sstr));
3434 if (dtype == SVt_PVGV) {
3435 if (ckWARN(WARN_MISC))
3436 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3439 (void)SvOK_off(dstr);
3441 if (SvTAINTED(sstr))
3446 =for apidoc sv_setsv_mg
3448 Like C<sv_setsv>, but also handles 'set' magic.
3454 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3456 sv_setsv(dstr,sstr);
3460 #ifdef PERL_OLD_COPY_ON_WRITE
3462 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3464 STRLEN cur = SvCUR(sstr);
3465 STRLEN len = SvLEN(sstr);
3466 register char *new_pv;
3469 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3477 if (SvTHINKFIRST(dstr))
3478 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3479 else if (SvPVX_const(dstr))
3480 Safefree(SvPVX_const(dstr));
3484 SvUPGRADE(dstr, SVt_PVIV);
3486 assert (SvPOK(sstr));
3487 assert (SvPOKp(sstr));
3488 assert (!SvIOK(sstr));
3489 assert (!SvIOKp(sstr));
3490 assert (!SvNOK(sstr));
3491 assert (!SvNOKp(sstr));
3493 if (SvIsCOW(sstr)) {
3495 if (SvLEN(sstr) == 0) {
3496 /* source is a COW shared hash key. */
3497 DEBUG_C(PerlIO_printf(Perl_debug_log,
3498 "Fast copy on write: Sharing hash\n"));
3499 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3502 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3504 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3505 SvUPGRADE(sstr, SVt_PVIV);
3506 SvREADONLY_on(sstr);
3508 DEBUG_C(PerlIO_printf(Perl_debug_log,
3509 "Fast copy on write: Converting sstr to COW\n"));
3510 SV_COW_NEXT_SV_SET(dstr, sstr);
3512 SV_COW_NEXT_SV_SET(sstr, dstr);
3513 new_pv = SvPVX_mutable(sstr);
3516 SvPV_set(dstr, new_pv);
3517 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3520 SvLEN_set(dstr, len);
3521 SvCUR_set(dstr, cur);
3530 =for apidoc sv_setpvn
3532 Copies a string into an SV. The C<len> parameter indicates the number of
3533 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3534 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3540 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3543 register char *dptr;
3545 SV_CHECK_THINKFIRST_COW_DROP(sv);
3551 /* len is STRLEN which is unsigned, need to copy to signed */
3554 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3556 SvUPGRADE(sv, SVt_PV);
3558 dptr = SvGROW(sv, len + 1);
3559 Move(ptr,dptr,len,char);
3562 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3567 =for apidoc sv_setpvn_mg
3569 Like C<sv_setpvn>, but also handles 'set' magic.
3575 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3577 sv_setpvn(sv,ptr,len);
3582 =for apidoc sv_setpv
3584 Copies a string into an SV. The string must be null-terminated. Does not
3585 handle 'set' magic. See C<sv_setpv_mg>.
3591 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3594 register STRLEN len;
3596 SV_CHECK_THINKFIRST_COW_DROP(sv);
3602 SvUPGRADE(sv, SVt_PV);
3604 SvGROW(sv, len + 1);
3605 Move(ptr,SvPVX(sv),len+1,char);
3607 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3612 =for apidoc sv_setpv_mg
3614 Like C<sv_setpv>, but also handles 'set' magic.
3620 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3627 =for apidoc sv_usepvn
3629 Tells an SV to use C<ptr> to find its string value. Normally the string is
3630 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3631 The C<ptr> should point to memory that was allocated by C<malloc>. The
3632 string length, C<len>, must be supplied. This function will realloc the
3633 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3634 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3635 See C<sv_usepvn_mg>.
3641 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3645 SV_CHECK_THINKFIRST_COW_DROP(sv);
3646 SvUPGRADE(sv, SVt_PV);
3651 if (SvPVX_const(sv))
3654 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3655 ptr = saferealloc (ptr, allocate);
3658 SvLEN_set(sv, allocate);
3660 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3665 =for apidoc sv_usepvn_mg
3667 Like C<sv_usepvn>, but also handles 'set' magic.
3673 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3675 sv_usepvn(sv,ptr,len);
3679 #ifdef PERL_OLD_COPY_ON_WRITE
3680 /* Need to do this *after* making the SV normal, as we need the buffer
3681 pointer to remain valid until after we've copied it. If we let go too early,
3682 another thread could invalidate it by unsharing last of the same hash key
3683 (which it can do by means other than releasing copy-on-write Svs)
3684 or by changing the other copy-on-write SVs in the loop. */
3686 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3688 if (len) { /* this SV was SvIsCOW_normal(sv) */
3689 /* we need to find the SV pointing to us. */
3690 SV * const current = SV_COW_NEXT_SV(after);
3692 if (current == sv) {
3693 /* The SV we point to points back to us (there were only two of us
3695 Hence other SV is no longer copy on write either. */
3697 SvREADONLY_off(after);
3699 /* We need to follow the pointers around the loop. */
3701 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3704 /* don't loop forever if the structure is bust, and we have
3705 a pointer into a closed loop. */
3706 assert (current != after);
3707 assert (SvPVX_const(current) == pvx);
3709 /* Make the SV before us point to the SV after us. */
3710 SV_COW_NEXT_SV_SET(current, after);
3713 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3718 Perl_sv_release_IVX(pTHX_ register SV *sv)
3721 sv_force_normal_flags(sv, 0);
3727 =for apidoc sv_force_normal_flags
3729 Undo various types of fakery on an SV: if the PV is a shared string, make
3730 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3731 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3732 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3733 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3734 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3735 set to some other value.) In addition, the C<flags> parameter gets passed to
3736 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3737 with flags set to 0.
3743 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3746 #ifdef PERL_OLD_COPY_ON_WRITE
3747 if (SvREADONLY(sv)) {
3748 /* At this point I believe I should acquire a global SV mutex. */
3750 const char * const pvx = SvPVX_const(sv);
3751 const STRLEN len = SvLEN(sv);
3752 const STRLEN cur = SvCUR(sv);
3753 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3755 PerlIO_printf(Perl_debug_log,
3756 "Copy on write: Force normal %ld\n",
3762 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3765 if (flags & SV_COW_DROP_PV) {
3766 /* OK, so we don't need to copy our buffer. */
3769 SvGROW(sv, cur + 1);
3770 Move(pvx,SvPVX(sv),cur,char);
3774 sv_release_COW(sv, pvx, len, next);
3779 else if (IN_PERL_RUNTIME)
3780 Perl_croak(aTHX_ PL_no_modify);
3781 /* At this point I believe that I can drop the global SV mutex. */
3784 if (SvREADONLY(sv)) {
3786 const char * const pvx = SvPVX_const(sv);
3787 const STRLEN len = SvCUR(sv);
3790 SvPV_set(sv, Nullch);
3792 SvGROW(sv, len + 1);
3793 Move(pvx,SvPVX(sv),len,char);
3795 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3797 else if (IN_PERL_RUNTIME)
3798 Perl_croak(aTHX_ PL_no_modify);
3802 sv_unref_flags(sv, flags);
3803 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3810 Efficient removal of characters from the beginning of the string buffer.
3811 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3812 the string buffer. The C<ptr> becomes the first character of the adjusted
3813 string. Uses the "OOK hack".
3814 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3815 refer to the same chunk of data.
3821 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3823 register STRLEN delta;
3824 if (!ptr || !SvPOKp(sv))
3826 delta = ptr - SvPVX_const(sv);
3827 SV_CHECK_THINKFIRST(sv);
3828 if (SvTYPE(sv) < SVt_PVIV)
3829 sv_upgrade(sv,SVt_PVIV);
3832 if (!SvLEN(sv)) { /* make copy of shared string */
3833 const char *pvx = SvPVX_const(sv);
3834 const STRLEN len = SvCUR(sv);
3835 SvGROW(sv, len + 1);
3836 Move(pvx,SvPVX(sv),len,char);
3840 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3841 and we do that anyway inside the SvNIOK_off
3843 SvFLAGS(sv) |= SVf_OOK;
3846 SvLEN_set(sv, SvLEN(sv) - delta);
3847 SvCUR_set(sv, SvCUR(sv) - delta);
3848 SvPV_set(sv, SvPVX(sv) + delta);
3849 SvIV_set(sv, SvIVX(sv) + delta);
3853 =for apidoc sv_catpvn
3855 Concatenates the string onto the end of the string which is in the SV. The
3856 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3857 status set, then the bytes appended should be valid UTF-8.
3858 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3860 =for apidoc sv_catpvn_flags
3862 Concatenates the string onto the end of the string which is in the SV. The
3863 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3864 status set, then the bytes appended should be valid UTF-8.
3865 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3866 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3867 in terms of this function.
3873 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3877 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3879 SvGROW(dsv, dlen + slen + 1);
3881 sstr = SvPVX_const(dsv);
3882 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3883 SvCUR_set(dsv, SvCUR(dsv) + slen);
3885 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3887 if (flags & SV_SMAGIC)
3892 =for apidoc sv_catsv
3894 Concatenates the string from SV C<ssv> onto the end of the string in
3895 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3896 not 'set' magic. See C<sv_catsv_mg>.
3898 =for apidoc sv_catsv_flags
3900 Concatenates the string from SV C<ssv> onto the end of the string in
3901 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3902 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3903 and C<sv_catsv_nomg> are implemented in terms of this function.
3908 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3913 const char *spv = SvPV_const(ssv, slen);
3915 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3916 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3917 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3918 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3919 dsv->sv_flags doesn't have that bit set.
3920 Andy Dougherty 12 Oct 2001
3922 const I32 sutf8 = DO_UTF8(ssv);
3925 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3927 dutf8 = DO_UTF8(dsv);
3929 if (dutf8 != sutf8) {
3931 /* Not modifying source SV, so taking a temporary copy. */
3932 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3934 sv_utf8_upgrade(csv);
3935 spv = SvPV_const(csv, slen);
3938 sv_utf8_upgrade_nomg(dsv);
3940 sv_catpvn_nomg(dsv, spv, slen);
3943 if (flags & SV_SMAGIC)
3948 =for apidoc sv_catpv
3950 Concatenates the string onto the end of the string which is in the SV.
3951 If the SV has the UTF-8 status set, then the bytes appended should be
3952 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3957 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3960 register STRLEN len;
3966 junk = SvPV_force(sv, tlen);
3968 SvGROW(sv, tlen + len + 1);
3970 ptr = SvPVX_const(sv);
3971 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3972 SvCUR_set(sv, SvCUR(sv) + len);
3973 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3978 =for apidoc sv_catpv_mg
3980 Like C<sv_catpv>, but also handles 'set' magic.
3986 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3995 Creates a new SV. A non-zero C<len> parameter indicates the number of
3996 bytes of preallocated string space the SV should have. An extra byte for a
3997 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
3998 space is allocated.) The reference count for the new SV is set to 1.
4000 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4001 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4002 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4003 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4004 modules supporting older perls.
4010 Perl_newSV(pTHX_ STRLEN len)
4017 sv_upgrade(sv, SVt_PV);
4018 SvGROW(sv, len + 1);
4023 =for apidoc sv_magicext
4025 Adds magic to an SV, upgrading it if necessary. Applies the
4026 supplied vtable and returns a pointer to the magic added.
4028 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4029 In particular, you can add magic to SvREADONLY SVs, and add more than
4030 one instance of the same 'how'.
4032 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4033 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4034 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4035 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4037 (This is now used as a subroutine by C<sv_magic>.)
4042 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4043 const char* name, I32 namlen)
4048 if (SvTYPE(sv) < SVt_PVMG) {
4049 SvUPGRADE(sv, SVt_PVMG);
4051 Newxz(mg, 1, MAGIC);
4052 mg->mg_moremagic = SvMAGIC(sv);
4053 SvMAGIC_set(sv, mg);
4055 /* Sometimes a magic contains a reference loop, where the sv and
4056 object refer to each other. To prevent a reference loop that
4057 would prevent such objects being freed, we look for such loops
4058 and if we find one we avoid incrementing the object refcount.
4060 Note we cannot do this to avoid self-tie loops as intervening RV must
4061 have its REFCNT incremented to keep it in existence.
4064 if (!obj || obj == sv ||
4065 how == PERL_MAGIC_arylen ||
4066 how == PERL_MAGIC_qr ||
4067 how == PERL_MAGIC_symtab ||
4068 (SvTYPE(obj) == SVt_PVGV &&
4069 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4070 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4071 GvFORM(obj) == (CV*)sv)))
4076 mg->mg_obj = SvREFCNT_inc(obj);
4077 mg->mg_flags |= MGf_REFCOUNTED;
4080 /* Normal self-ties simply pass a null object, and instead of
4081 using mg_obj directly, use the SvTIED_obj macro to produce a
4082 new RV as needed. For glob "self-ties", we are tieing the PVIO
4083 with an RV obj pointing to the glob containing the PVIO. In
4084 this case, to avoid a reference loop, we need to weaken the
4088 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4089 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4095 mg->mg_len = namlen;
4098 mg->mg_ptr = savepvn(name, namlen);
4099 else if (namlen == HEf_SVKEY)
4100 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4102 mg->mg_ptr = (char *) name;
4104 mg->mg_virtual = vtable;
4108 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4113 =for apidoc sv_magic
4115 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4116 then adds a new magic item of type C<how> to the head of the magic list.
4118 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4119 handling of the C<name> and C<namlen> arguments.
4121 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4122 to add more than one instance of the same 'how'.
4128 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4134 #ifdef PERL_OLD_COPY_ON_WRITE
4136 sv_force_normal_flags(sv, 0);
4138 if (SvREADONLY(sv)) {
4140 /* its okay to attach magic to shared strings; the subsequent
4141 * upgrade to PVMG will unshare the string */
4142 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4145 && how != PERL_MAGIC_regex_global
4146 && how != PERL_MAGIC_bm
4147 && how != PERL_MAGIC_fm
4148 && how != PERL_MAGIC_sv
4149 && how != PERL_MAGIC_backref
4152 Perl_croak(aTHX_ PL_no_modify);
4155 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4156 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4157 /* sv_magic() refuses to add a magic of the same 'how' as an
4160 if (how == PERL_MAGIC_taint)
4168 vtable = &PL_vtbl_sv;
4170 case PERL_MAGIC_overload:
4171 vtable = &PL_vtbl_amagic;
4173 case PERL_MAGIC_overload_elem:
4174 vtable = &PL_vtbl_amagicelem;
4176 case PERL_MAGIC_overload_table:
4177 vtable = &PL_vtbl_ovrld;
4180 vtable = &PL_vtbl_bm;
4182 case PERL_MAGIC_regdata:
4183 vtable = &PL_vtbl_regdata;
4185 case PERL_MAGIC_regdatum:
4186 vtable = &PL_vtbl_regdatum;
4188 case PERL_MAGIC_env:
4189 vtable = &PL_vtbl_env;
4192 vtable = &PL_vtbl_fm;
4194 case PERL_MAGIC_envelem:
4195 vtable = &PL_vtbl_envelem;
4197 case PERL_MAGIC_regex_global:
4198 vtable = &PL_vtbl_mglob;
4200 case PERL_MAGIC_isa:
4201 vtable = &PL_vtbl_isa;
4203 case PERL_MAGIC_isaelem:
4204 vtable = &PL_vtbl_isaelem;
4206 case PERL_MAGIC_nkeys:
4207 vtable = &PL_vtbl_nkeys;
4209 case PERL_MAGIC_dbfile:
4212 case PERL_MAGIC_dbline:
4213 vtable = &PL_vtbl_dbline;
4215 #ifdef USE_LOCALE_COLLATE
4216 case PERL_MAGIC_collxfrm:
4217 vtable = &PL_vtbl_collxfrm;
4219 #endif /* USE_LOCALE_COLLATE */
4220 case PERL_MAGIC_tied:
4221 vtable = &PL_vtbl_pack;
4223 case PERL_MAGIC_tiedelem:
4224 case PERL_MAGIC_tiedscalar:
4225 vtable = &PL_vtbl_packelem;
4228 vtable = &PL_vtbl_regexp;
4230 case PERL_MAGIC_sig:
4231 vtable = &PL_vtbl_sig;
4233 case PERL_MAGIC_sigelem:
4234 vtable = &PL_vtbl_sigelem;
4236 case PERL_MAGIC_taint:
4237 vtable = &PL_vtbl_taint;
4239 case PERL_MAGIC_uvar:
4240 vtable = &PL_vtbl_uvar;
4242 case PERL_MAGIC_vec:
4243 vtable = &PL_vtbl_vec;
4245 case PERL_MAGIC_arylen_p:
4246 case PERL_MAGIC_rhash:
4247 case PERL_MAGIC_symtab:
4248 case PERL_MAGIC_vstring:
4251 case PERL_MAGIC_utf8:
4252 vtable = &PL_vtbl_utf8;
4254 case PERL_MAGIC_substr:
4255 vtable = &PL_vtbl_substr;
4257 case PERL_MAGIC_defelem:
4258 vtable = &PL_vtbl_defelem;
4260 case PERL_MAGIC_glob:
4261 vtable = &PL_vtbl_glob;
4263 case PERL_MAGIC_arylen:
4264 vtable = &PL_vtbl_arylen;
4266 case PERL_MAGIC_pos:
4267 vtable = &PL_vtbl_pos;
4269 case PERL_MAGIC_backref:
4270 vtable = &PL_vtbl_backref;
4272 case PERL_MAGIC_ext:
4273 /* Reserved for use by extensions not perl internals. */
4274 /* Useful for attaching extension internal data to perl vars. */
4275 /* Note that multiple extensions may clash if magical scalars */
4276 /* etc holding private data from one are passed to another. */
4280 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4283 /* Rest of work is done else where */
4284 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4287 case PERL_MAGIC_taint:
4290 case PERL_MAGIC_ext:
4291 case PERL_MAGIC_dbfile:
4298 =for apidoc sv_unmagic
4300 Removes all magic of type C<type> from an SV.
4306 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4310 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4313 for (mg = *mgp; mg; mg = *mgp) {
4314 if (mg->mg_type == type) {
4315 const MGVTBL* const vtbl = mg->mg_virtual;
4316 *mgp = mg->mg_moremagic;
4317 if (vtbl && vtbl->svt_free)
4318 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4319 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4321 Safefree(mg->mg_ptr);
4322 else if (mg->mg_len == HEf_SVKEY)
4323 SvREFCNT_dec((SV*)mg->mg_ptr);
4324 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4325 Safefree(mg->mg_ptr);
4327 if (mg->mg_flags & MGf_REFCOUNTED)
4328 SvREFCNT_dec(mg->mg_obj);
4332 mgp = &mg->mg_moremagic;
4336 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4337 SvMAGIC_set(sv, NULL);
4344 =for apidoc sv_rvweaken
4346 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4347 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4348 push a back-reference to this RV onto the array of backreferences
4349 associated with that magic.
4355 Perl_sv_rvweaken(pTHX_ SV *sv)
4358 if (!SvOK(sv)) /* let undefs pass */
4361 Perl_croak(aTHX_ "Can't weaken a nonreference");
4362 else if (SvWEAKREF(sv)) {
4363 if (ckWARN(WARN_MISC))
4364 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4368 Perl_sv_add_backref(aTHX_ tsv, sv);
4374 /* Give tsv backref magic if it hasn't already got it, then push a
4375 * back-reference to sv onto the array associated with the backref magic.
4379 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4384 if (SvTYPE(tsv) == SVt_PVHV) {
4385 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4389 /* There is no AV in the offical place - try a fixup. */
4390 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4393 /* Aha. They've got it stowed in magic. Bring it back. */
4394 av = (AV*)mg->mg_obj;
4395 /* Stop mg_free decreasing the refernce count. */
4397 /* Stop mg_free even calling the destructor, given that
4398 there's no AV to free up. */
4400 sv_unmagic(tsv, PERL_MAGIC_backref);
4409 const MAGIC *const mg
4410 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4412 av = (AV*)mg->mg_obj;
4416 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4417 /* av now has a refcnt of 2, which avoids it getting freed
4418 * before us during global cleanup. The extra ref is removed
4419 * by magic_killbackrefs() when tsv is being freed */
4422 if (AvFILLp(av) >= AvMAX(av)) {
4423 av_extend(av, AvFILLp(av)+1);
4425 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4428 /* delete a back-reference to ourselves from the backref magic associated
4429 * with the SV we point to.
4433 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4440 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4441 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4442 /* We mustn't attempt to "fix up" the hash here by moving the
4443 backreference array back to the hv_aux structure, as that is stored
4444 in the main HvARRAY(), and hfreentries assumes that no-one
4445 reallocates HvARRAY() while it is running. */
4448 const MAGIC *const mg
4449 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4451 av = (AV *)mg->mg_obj;
4454 if (PL_in_clean_all)
4456 Perl_croak(aTHX_ "panic: del_backref");
4463 /* We shouldn't be in here more than once, but for paranoia reasons lets
4465 for (i = AvFILLp(av); i >= 0; i--) {
4467 const SSize_t fill = AvFILLp(av);
4469 /* We weren't the last entry.
4470 An unordered list has this property that you can take the
4471 last element off the end to fill the hole, and it's still
4472 an unordered list :-)
4477 AvFILLp(av) = fill - 1;
4483 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4485 SV **svp = AvARRAY(av);
4487 PERL_UNUSED_ARG(sv);
4489 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4490 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4491 if (svp && !SvIS_FREED(av)) {
4492 SV *const *const last = svp + AvFILLp(av);
4494 while (svp <= last) {
4496 SV *const referrer = *svp;
4497 if (SvWEAKREF(referrer)) {
4498 /* XXX Should we check that it hasn't changed? */
4499 SvRV_set(referrer, 0);
4501 SvWEAKREF_off(referrer);
4502 } else if (SvTYPE(referrer) == SVt_PVGV ||
4503 SvTYPE(referrer) == SVt_PVLV) {
4504 /* You lookin' at me? */
4505 assert(GvSTASH(referrer));
4506 assert(GvSTASH(referrer) == (HV*)sv);
4507 GvSTASH(referrer) = 0;
4510 "panic: magic_killbackrefs (flags=%"UVxf")",
4511 (UV)SvFLAGS(referrer));
4519 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4524 =for apidoc sv_insert
4526 Inserts a string at the specified offset/length within the SV. Similar to
4527 the Perl substr() function.
4533 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4538 register char *midend;
4539 register char *bigend;
4545 Perl_croak(aTHX_ "Can't modify non-existent substring");
4546 SvPV_force(bigstr, curlen);
4547 (void)SvPOK_only_UTF8(bigstr);
4548 if (offset + len > curlen) {
4549 SvGROW(bigstr, offset+len+1);
4550 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4551 SvCUR_set(bigstr, offset+len);
4555 i = littlelen - len;
4556 if (i > 0) { /* string might grow */
4557 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4558 mid = big + offset + len;
4559 midend = bigend = big + SvCUR(bigstr);
4562 while (midend > mid) /* shove everything down */
4563 *--bigend = *--midend;
4564 Move(little,big+offset,littlelen,char);
4565 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4570 Move(little,SvPVX(bigstr)+offset,len,char);
4575 big = SvPVX(bigstr);
4578 bigend = big + SvCUR(bigstr);
4580 if (midend > bigend)
4581 Perl_croak(aTHX_ "panic: sv_insert");
4583 if (mid - big > bigend - midend) { /* faster to shorten from end */
4585 Move(little, mid, littlelen,char);
4588 i = bigend - midend;
4590 Move(midend, mid, i,char);
4594 SvCUR_set(bigstr, mid - big);
4596 else if ((i = mid - big)) { /* faster from front */
4597 midend -= littlelen;
4599 sv_chop(bigstr,midend-i);
4604 Move(little, mid, littlelen,char);
4606 else if (littlelen) {
4607 midend -= littlelen;
4608 sv_chop(bigstr,midend);
4609 Move(little,midend,littlelen,char);
4612 sv_chop(bigstr,midend);
4618 =for apidoc sv_replace
4620 Make the first argument a copy of the second, then delete the original.
4621 The target SV physically takes over ownership of the body of the source SV
4622 and inherits its flags; however, the target keeps any magic it owns,
4623 and any magic in the source is discarded.
4624 Note that this is a rather specialist SV copying operation; most of the
4625 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4631 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4634 const U32 refcnt = SvREFCNT(sv);
4635 SV_CHECK_THINKFIRST_COW_DROP(sv);
4636 if (SvREFCNT(nsv) != 1) {
4637 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4638 UVuf " != 1)", (UV) SvREFCNT(nsv));
4640 if (SvMAGICAL(sv)) {
4644 sv_upgrade(nsv, SVt_PVMG);
4645 SvMAGIC_set(nsv, SvMAGIC(sv));
4646 SvFLAGS(nsv) |= SvMAGICAL(sv);
4648 SvMAGIC_set(sv, NULL);
4652 assert(!SvREFCNT(sv));
4653 #ifdef DEBUG_LEAKING_SCALARS
4654 sv->sv_flags = nsv->sv_flags;
4655 sv->sv_any = nsv->sv_any;
4656 sv->sv_refcnt = nsv->sv_refcnt;
4657 sv->sv_u = nsv->sv_u;
4659 StructCopy(nsv,sv,SV);
4661 /* Currently could join these into one piece of pointer arithmetic, but
4662 it would be unclear. */
4663 if(SvTYPE(sv) == SVt_IV)
4665 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4666 else if (SvTYPE(sv) == SVt_RV) {
4667 SvANY(sv) = &sv->sv_u.svu_rv;
4671 #ifdef PERL_OLD_COPY_ON_WRITE
4672 if (SvIsCOW_normal(nsv)) {
4673 /* We need to follow the pointers around the loop to make the
4674 previous SV point to sv, rather than nsv. */
4677 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4680 assert(SvPVX_const(current) == SvPVX_const(nsv));
4682 /* Make the SV before us point to the SV after us. */
4684 PerlIO_printf(Perl_debug_log, "previous is\n");
4686 PerlIO_printf(Perl_debug_log,
4687 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4688 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4690 SV_COW_NEXT_SV_SET(current, sv);
4693 SvREFCNT(sv) = refcnt;
4694 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4700 =for apidoc sv_clear
4702 Clear an SV: call any destructors, free up any memory used by the body,
4703 and free the body itself. The SV's head is I<not> freed, although
4704 its type is set to all 1's so that it won't inadvertently be assumed
4705 to be live during global destruction etc.
4706 This function should only be called when REFCNT is zero. Most of the time
4707 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4714 Perl_sv_clear(pTHX_ register SV *sv)
4717 const U32 type = SvTYPE(sv);
4718 const struct body_details *const sv_type_details
4719 = bodies_by_type + type;
4722 assert(SvREFCNT(sv) == 0);
4728 if (PL_defstash) { /* Still have a symbol table? */
4733 stash = SvSTASH(sv);
4734 destructor = StashHANDLER(stash,DESTROY);
4736 SV* const tmpref = newRV(sv);
4737 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4739 PUSHSTACKi(PERLSI_DESTROY);
4744 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4750 if(SvREFCNT(tmpref) < 2) {
4751 /* tmpref is not kept alive! */
4753 SvRV_set(tmpref, NULL);
4756 SvREFCNT_dec(tmpref);
4758 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4762 if (PL_in_clean_objs)
4763 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4765 /* DESTROY gave object new lease on life */
4771 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4772 SvOBJECT_off(sv); /* Curse the object. */
4773 if (type != SVt_PVIO)
4774 --PL_sv_objcount; /* XXX Might want something more general */
4777 if (type >= SVt_PVMG) {
4780 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4781 SvREFCNT_dec(SvSTASH(sv));
4786 IoIFP(sv) != PerlIO_stdin() &&
4787 IoIFP(sv) != PerlIO_stdout() &&
4788 IoIFP(sv) != PerlIO_stderr())
4790 io_close((IO*)sv, FALSE);
4792 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4793 PerlDir_close(IoDIRP(sv));
4794 IoDIRP(sv) = (DIR*)NULL;
4795 Safefree(IoTOP_NAME(sv));
4796 Safefree(IoFMT_NAME(sv));
4797 Safefree(IoBOTTOM_NAME(sv));
4806 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4813 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4814 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4815 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4816 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4818 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4819 SvREFCNT_dec(LvTARG(sv));
4823 Safefree(GvNAME(sv));
4824 /* If we're in a stash, we don't own a reference to it. However it does
4825 have a back reference to us, which needs to be cleared. */
4827 sv_del_backref((SV*)GvSTASH(sv), sv);
4832 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4834 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4835 /* Don't even bother with turning off the OOK flag. */
4840 SV *target = SvRV(sv);
4842 sv_del_backref(target, sv);
4844 SvREFCNT_dec(target);
4846 #ifdef PERL_OLD_COPY_ON_WRITE
4847 else if (SvPVX_const(sv)) {
4849 /* I believe I need to grab the global SV mutex here and
4850 then recheck the COW status. */
4852 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4855 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4856 SV_COW_NEXT_SV(sv));
4857 /* And drop it here. */
4859 } else if (SvLEN(sv)) {
4860 Safefree(SvPVX_const(sv));
4864 else if (SvPVX_const(sv) && SvLEN(sv))
4865 Safefree(SvPVX_mutable(sv));
4866 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4867 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4876 SvFLAGS(sv) &= SVf_BREAK;
4877 SvFLAGS(sv) |= SVTYPEMASK;
4879 if (sv_type_details->arena) {
4880 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4881 &PL_body_roots[type]);
4883 else if (sv_type_details->size) {
4884 my_safefree(SvANY(sv));
4889 =for apidoc sv_newref
4891 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4898 Perl_sv_newref(pTHX_ SV *sv)
4908 Decrement an SV's reference count, and if it drops to zero, call
4909 C<sv_clear> to invoke destructors and free up any memory used by
4910 the body; finally, deallocate the SV's head itself.
4911 Normally called via a wrapper macro C<SvREFCNT_dec>.
4917 Perl_sv_free(pTHX_ SV *sv)
4922 if (SvREFCNT(sv) == 0) {
4923 if (SvFLAGS(sv) & SVf_BREAK)
4924 /* this SV's refcnt has been artificially decremented to
4925 * trigger cleanup */
4927 if (PL_in_clean_all) /* All is fair */
4929 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4930 /* make sure SvREFCNT(sv)==0 happens very seldom */
4931 SvREFCNT(sv) = (~(U32)0)/2;
4934 if (ckWARN_d(WARN_INTERNAL)) {
4935 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4936 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4937 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4938 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4939 Perl_dump_sv_child(aTHX_ sv);
4944 if (--(SvREFCNT(sv)) > 0)
4946 Perl_sv_free2(aTHX_ sv);
4950 Perl_sv_free2(pTHX_ SV *sv)
4955 if (ckWARN_d(WARN_DEBUGGING))
4956 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4957 "Attempt to free temp prematurely: SV 0x%"UVxf
4958 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4962 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4963 /* make sure SvREFCNT(sv)==0 happens very seldom */
4964 SvREFCNT(sv) = (~(U32)0)/2;
4975 Returns the length of the string in the SV. Handles magic and type
4976 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4982 Perl_sv_len(pTHX_ register SV *sv)
4990 len = mg_length(sv);
4992 (void)SvPV_const(sv, len);
4997 =for apidoc sv_len_utf8
4999 Returns the number of characters in the string in an SV, counting wide
5000 UTF-8 bytes as a single character. Handles magic and type coercion.
5006 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5007 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5008 * (Note that the mg_len is not the length of the mg_ptr field.)
5013 Perl_sv_len_utf8(pTHX_ register SV *sv)
5019 return mg_length(sv);
5023 const U8 *s = (U8*)SvPV_const(sv, len);
5024 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5026 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5028 #ifdef PERL_UTF8_CACHE_ASSERT
5029 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5033 ulen = Perl_utf8_length(aTHX_ s, s + len);
5034 if (!mg && !SvREADONLY(sv)) {
5035 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5036 mg = mg_find(sv, PERL_MAGIC_utf8);
5046 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5047 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5048 * between UTF-8 and byte offsets. There are two (substr offset and substr
5049 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5050 * and byte offset) cache positions.
5052 * The mg_len field is used by sv_len_utf8(), see its comments.
5053 * Note that the mg_len is not the length of the mg_ptr field.
5057 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5058 I32 offsetp, const U8 *s, const U8 *start)
5062 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5064 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5068 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5070 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5071 (*mgp)->mg_ptr = (char *) *cachep;
5075 (*cachep)[i] = offsetp;
5076 (*cachep)[i+1] = s - start;
5084 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5085 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5086 * between UTF-8 and byte offsets. See also the comments of
5087 * S_utf8_mg_pos_init().
5091 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)
5095 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5097 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5098 if (*mgp && (*mgp)->mg_ptr) {
5099 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5100 ASSERT_UTF8_CACHE(*cachep);
5101 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5103 else { /* We will skip to the right spot. */
5108 /* The assumption is that going backward is half
5109 * the speed of going forward (that's where the
5110 * 2 * backw in the below comes from). (The real
5111 * figure of course depends on the UTF-8 data.) */
5113 if ((*cachep)[i] > (STRLEN)uoff) {
5115 backw = (*cachep)[i] - (STRLEN)uoff;
5117 if (forw < 2 * backw)
5120 p = start + (*cachep)[i+1];
5122 /* Try this only for the substr offset (i == 0),
5123 * not for the substr length (i == 2). */
5124 else if (i == 0) { /* (*cachep)[i] < uoff */
5125 const STRLEN ulen = sv_len_utf8(sv);
5127 if ((STRLEN)uoff < ulen) {
5128 forw = (STRLEN)uoff - (*cachep)[i];
5129 backw = ulen - (STRLEN)uoff;
5131 if (forw < 2 * backw)
5132 p = start + (*cachep)[i+1];
5137 /* If the string is not long enough for uoff,
5138 * we could extend it, but not at this low a level. */
5142 if (forw < 2 * backw) {
5149 while (UTF8_IS_CONTINUATION(*p))
5154 /* Update the cache. */
5155 (*cachep)[i] = (STRLEN)uoff;
5156 (*cachep)[i+1] = p - start;
5158 /* Drop the stale "length" cache */
5167 if (found) { /* Setup the return values. */
5168 *offsetp = (*cachep)[i+1];
5169 *sp = start + *offsetp;
5172 *offsetp = send - start;
5174 else if (*sp < start) {
5180 #ifdef PERL_UTF8_CACHE_ASSERT
5185 while (n-- && s < send)
5189 assert(*offsetp == s - start);
5190 assert((*cachep)[0] == (STRLEN)uoff);
5191 assert((*cachep)[1] == *offsetp);
5193 ASSERT_UTF8_CACHE(*cachep);
5202 =for apidoc sv_pos_u2b
5204 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5205 the start of the string, to a count of the equivalent number of bytes; if
5206 lenp is non-zero, it does the same to lenp, but this time starting from
5207 the offset, rather than from the start of the string. Handles magic and
5214 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5215 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5216 * byte offsets. See also the comments of S_utf8_mg_pos().
5221 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5229 start = (U8*)SvPV_const(sv, len);
5232 STRLEN *cache = NULL;
5233 const U8 *s = start;
5234 I32 uoffset = *offsetp;
5235 const U8 * const send = s + len;
5237 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5239 if (!found && uoffset > 0) {
5240 while (s < send && uoffset--)
5244 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5246 *offsetp = s - start;
5251 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5255 if (!found && *lenp > 0) {
5258 while (s < send && ulen--)
5262 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5266 ASSERT_UTF8_CACHE(cache);
5278 =for apidoc sv_pos_b2u
5280 Converts the value pointed to by offsetp from a count of bytes from the
5281 start of the string, to a count of the equivalent number of UTF-8 chars.
5282 Handles magic and type coercion.
5288 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5289 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5290 * byte offsets. See also the comments of S_utf8_mg_pos().
5295 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5303 s = (const U8*)SvPV_const(sv, len);
5304 if ((I32)len < *offsetp)
5305 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5307 const U8* send = s + *offsetp;
5309 STRLEN *cache = NULL;
5313 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5314 mg = mg_find(sv, PERL_MAGIC_utf8);
5315 if (mg && mg->mg_ptr) {
5316 cache = (STRLEN *) mg->mg_ptr;
5317 if (cache[1] == (STRLEN)*offsetp) {
5318 /* An exact match. */
5319 *offsetp = cache[0];
5323 else if (cache[1] < (STRLEN)*offsetp) {
5324 /* We already know part of the way. */
5327 /* Let the below loop do the rest. */
5329 else { /* cache[1] > *offsetp */
5330 /* We already know all of the way, now we may
5331 * be able to walk back. The same assumption
5332 * is made as in S_utf8_mg_pos(), namely that
5333 * walking backward is twice slower than
5334 * walking forward. */
5335 const STRLEN forw = *offsetp;
5336 STRLEN backw = cache[1] - *offsetp;
5338 if (!(forw < 2 * backw)) {
5339 const U8 *p = s + cache[1];
5346 while (UTF8_IS_CONTINUATION(*p)) {
5354 *offsetp = cache[0];
5356 /* Drop the stale "length" cache */
5364 ASSERT_UTF8_CACHE(cache);
5370 /* Call utf8n_to_uvchr() to validate the sequence
5371 * (unless a simple non-UTF character) */
5372 if (!UTF8_IS_INVARIANT(*s))
5373 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5382 if (!SvREADONLY(sv)) {
5384 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5385 mg = mg_find(sv, PERL_MAGIC_utf8);
5390 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5391 mg->mg_ptr = (char *) cache;
5396 cache[1] = *offsetp;
5397 /* Drop the stale "length" cache */
5410 Returns a boolean indicating whether the strings in the two SVs are
5411 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5412 coerce its args to strings if necessary.
5418 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5427 SV* svrecode = Nullsv;
5434 pv1 = SvPV_const(sv1, cur1);
5441 pv2 = SvPV_const(sv2, cur2);
5443 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5444 /* Differing utf8ness.
5445 * Do not UTF8size the comparands as a side-effect. */
5448 svrecode = newSVpvn(pv2, cur2);
5449 sv_recode_to_utf8(svrecode, PL_encoding);
5450 pv2 = SvPV_const(svrecode, cur2);
5453 svrecode = newSVpvn(pv1, cur1);
5454 sv_recode_to_utf8(svrecode, PL_encoding);
5455 pv1 = SvPV_const(svrecode, cur1);
5457 /* Now both are in UTF-8. */
5459 SvREFCNT_dec(svrecode);
5464 bool is_utf8 = TRUE;
5467 /* sv1 is the UTF-8 one,
5468 * if is equal it must be downgrade-able */
5469 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5475 /* sv2 is the UTF-8 one,
5476 * if is equal it must be downgrade-able */
5477 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5483 /* Downgrade not possible - cannot be eq */
5491 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5494 SvREFCNT_dec(svrecode);
5505 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5506 string in C<sv1> is less than, equal to, or greater than the string in
5507 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5508 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5514 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5518 const char *pv1, *pv2;
5521 SV *svrecode = Nullsv;
5528 pv1 = SvPV_const(sv1, cur1);
5535 pv2 = SvPV_const(sv2, cur2);
5537 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5538 /* Differing utf8ness.
5539 * Do not UTF8size the comparands as a side-effect. */
5542 svrecode = newSVpvn(pv2, cur2);
5543 sv_recode_to_utf8(svrecode, PL_encoding);
5544 pv2 = SvPV_const(svrecode, cur2);
5547 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5552 svrecode = newSVpvn(pv1, cur1);
5553 sv_recode_to_utf8(svrecode, PL_encoding);
5554 pv1 = SvPV_const(svrecode, cur1);
5557 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5563 cmp = cur2 ? -1 : 0;
5567 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5570 cmp = retval < 0 ? -1 : 1;
5571 } else if (cur1 == cur2) {
5574 cmp = cur1 < cur2 ? -1 : 1;
5579 SvREFCNT_dec(svrecode);
5588 =for apidoc sv_cmp_locale
5590 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5591 'use bytes' aware, handles get magic, and will coerce its args to strings
5592 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5598 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5601 #ifdef USE_LOCALE_COLLATE
5607 if (PL_collation_standard)
5611 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5613 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5615 if (!pv1 || !len1) {
5626 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5629 return retval < 0 ? -1 : 1;
5632 * When the result of collation is equality, that doesn't mean
5633 * that there are no differences -- some locales exclude some
5634 * characters from consideration. So to avoid false equalities,
5635 * we use the raw string as a tiebreaker.
5641 #endif /* USE_LOCALE_COLLATE */
5643 return sv_cmp(sv1, sv2);
5647 #ifdef USE_LOCALE_COLLATE
5650 =for apidoc sv_collxfrm
5652 Add Collate Transform magic to an SV if it doesn't already have it.
5654 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5655 scalar data of the variable, but transformed to such a format that a normal
5656 memory comparison can be used to compare the data according to the locale
5663 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5668 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5669 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5675 Safefree(mg->mg_ptr);
5676 s = SvPV_const(sv, len);
5677 if ((xf = mem_collxfrm(s, len, &xlen))) {
5678 if (SvREADONLY(sv)) {
5681 return xf + sizeof(PL_collation_ix);
5684 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5685 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5698 if (mg && mg->mg_ptr) {
5700 return mg->mg_ptr + sizeof(PL_collation_ix);
5708 #endif /* USE_LOCALE_COLLATE */
5713 Get a line from the filehandle and store it into the SV, optionally
5714 appending to the currently-stored string.
5720 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5725 register STDCHAR rslast;
5726 register STDCHAR *bp;
5732 if (SvTHINKFIRST(sv))
5733 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5734 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5736 However, perlbench says it's slower, because the existing swipe code
5737 is faster than copy on write.
5738 Swings and roundabouts. */
5739 SvUPGRADE(sv, SVt_PV);
5744 if (PerlIO_isutf8(fp)) {
5746 sv_utf8_upgrade_nomg(sv);
5747 sv_pos_u2b(sv,&append,0);
5749 } else if (SvUTF8(sv)) {
5750 SV * const tsv = newSV(0);
5751 sv_gets(tsv, fp, 0);
5752 sv_utf8_upgrade_nomg(tsv);
5753 SvCUR_set(sv,append);
5756 goto return_string_or_null;
5761 if (PerlIO_isutf8(fp))
5764 if (IN_PERL_COMPILETIME) {
5765 /* we always read code in line mode */
5769 else if (RsSNARF(PL_rs)) {
5770 /* If it is a regular disk file use size from stat() as estimate
5771 of amount we are going to read - may result in malloc-ing
5772 more memory than we realy need if layers bellow reduce
5773 size we read (e.g. CRLF or a gzip layer)
5776 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5777 const Off_t offset = PerlIO_tell(fp);
5778 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5779 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5785 else if (RsRECORD(PL_rs)) {
5789 /* Grab the size of the record we're getting */
5790 recsize = SvIV(SvRV(PL_rs));
5791 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5794 /* VMS wants read instead of fread, because fread doesn't respect */
5795 /* RMS record boundaries. This is not necessarily a good thing to be */
5796 /* doing, but we've got no other real choice - except avoid stdio
5797 as implementation - perhaps write a :vms layer ?
5799 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5801 bytesread = PerlIO_read(fp, buffer, recsize);
5805 SvCUR_set(sv, bytesread += append);
5806 buffer[bytesread] = '\0';
5807 goto return_string_or_null;
5809 else if (RsPARA(PL_rs)) {
5815 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5816 if (PerlIO_isutf8(fp)) {
5817 rsptr = SvPVutf8(PL_rs, rslen);
5820 if (SvUTF8(PL_rs)) {
5821 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5822 Perl_croak(aTHX_ "Wide character in $/");
5825 rsptr = SvPV_const(PL_rs, rslen);
5829 rslast = rslen ? rsptr[rslen - 1] : '\0';
5831 if (rspara) { /* have to do this both before and after */
5832 do { /* to make sure file boundaries work right */
5835 i = PerlIO_getc(fp);
5839 PerlIO_ungetc(fp,i);
5845 /* See if we know enough about I/O mechanism to cheat it ! */
5847 /* This used to be #ifdef test - it is made run-time test for ease
5848 of abstracting out stdio interface. One call should be cheap
5849 enough here - and may even be a macro allowing compile
5853 if (PerlIO_fast_gets(fp)) {
5856 * We're going to steal some values from the stdio struct
5857 * and put EVERYTHING in the innermost loop into registers.
5859 register STDCHAR *ptr;
5863 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5864 /* An ungetc()d char is handled separately from the regular
5865 * buffer, so we getc() it back out and stuff it in the buffer.
5867 i = PerlIO_getc(fp);
5868 if (i == EOF) return 0;
5869 *(--((*fp)->_ptr)) = (unsigned char) i;
5873 /* Here is some breathtakingly efficient cheating */
5875 cnt = PerlIO_get_cnt(fp); /* get count into register */
5876 /* make sure we have the room */
5877 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5878 /* Not room for all of it
5879 if we are looking for a separator and room for some
5881 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5882 /* just process what we have room for */
5883 shortbuffered = cnt - SvLEN(sv) + append + 1;
5884 cnt -= shortbuffered;
5888 /* remember that cnt can be negative */
5889 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5894 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5895 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5896 DEBUG_P(PerlIO_printf(Perl_debug_log,
5897 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5898 DEBUG_P(PerlIO_printf(Perl_debug_log,
5899 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5900 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5901 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5906 while (cnt > 0) { /* this | eat */
5908 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5909 goto thats_all_folks; /* screams | sed :-) */
5913 Copy(ptr, bp, cnt, char); /* this | eat */
5914 bp += cnt; /* screams | dust */
5915 ptr += cnt; /* louder | sed :-) */
5920 if (shortbuffered) { /* oh well, must extend */
5921 cnt = shortbuffered;
5923 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5925 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5926 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5930 DEBUG_P(PerlIO_printf(Perl_debug_log,
5931 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5932 PTR2UV(ptr),(long)cnt));
5933 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5935 DEBUG_P(PerlIO_printf(Perl_debug_log,
5936 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5937 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5938 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5940 /* This used to call 'filbuf' in stdio form, but as that behaves like
5941 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5942 another abstraction. */
5943 i = PerlIO_getc(fp); /* get more characters */
5945 DEBUG_P(PerlIO_printf(Perl_debug_log,
5946 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5947 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5948 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5950 cnt = PerlIO_get_cnt(fp);
5951 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5952 DEBUG_P(PerlIO_printf(Perl_debug_log,
5953 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5955 if (i == EOF) /* all done for ever? */
5956 goto thats_really_all_folks;
5958 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5960 SvGROW(sv, bpx + cnt + 2);
5961 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5963 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5965 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5966 goto thats_all_folks;
5970 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5971 memNE((char*)bp - rslen, rsptr, rslen))
5972 goto screamer; /* go back to the fray */
5973 thats_really_all_folks:
5975 cnt += shortbuffered;
5976 DEBUG_P(PerlIO_printf(Perl_debug_log,
5977 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5978 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5979 DEBUG_P(PerlIO_printf(Perl_debug_log,
5980 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5981 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5982 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5984 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5985 DEBUG_P(PerlIO_printf(Perl_debug_log,
5986 "Screamer: done, len=%ld, string=|%.*s|\n",
5987 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5991 /*The big, slow, and stupid way. */
5992 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5993 STDCHAR *buf = NULL;
5994 Newx(buf, 8192, STDCHAR);
6002 register const STDCHAR * const bpe = buf + sizeof(buf);
6004 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6005 ; /* keep reading */
6009 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6010 /* Accomodate broken VAXC compiler, which applies U8 cast to
6011 * both args of ?: operator, causing EOF to change into 255
6014 i = (U8)buf[cnt - 1];
6020 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6022 sv_catpvn(sv, (char *) buf, cnt);
6024 sv_setpvn(sv, (char *) buf, cnt);
6026 if (i != EOF && /* joy */
6028 SvCUR(sv) < rslen ||
6029 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6033 * If we're reading from a TTY and we get a short read,
6034 * indicating that the user hit his EOF character, we need
6035 * to notice it now, because if we try to read from the TTY
6036 * again, the EOF condition will disappear.
6038 * The comparison of cnt to sizeof(buf) is an optimization
6039 * that prevents unnecessary calls to feof().
6043 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6047 #ifdef USE_HEAP_INSTEAD_OF_STACK
6052 if (rspara) { /* have to do this both before and after */
6053 while (i != EOF) { /* to make sure file boundaries work right */
6054 i = PerlIO_getc(fp);
6056 PerlIO_ungetc(fp,i);
6062 return_string_or_null:
6063 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6069 Auto-increment of the value in the SV, doing string to numeric conversion
6070 if necessary. Handles 'get' magic.
6076 Perl_sv_inc(pTHX_ register SV *sv)
6085 if (SvTHINKFIRST(sv)) {
6087 sv_force_normal_flags(sv, 0);
6088 if (SvREADONLY(sv)) {
6089 if (IN_PERL_RUNTIME)
6090 Perl_croak(aTHX_ PL_no_modify);
6094 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6096 i = PTR2IV(SvRV(sv));
6101 flags = SvFLAGS(sv);
6102 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6103 /* It's (privately or publicly) a float, but not tested as an
6104 integer, so test it to see. */
6106 flags = SvFLAGS(sv);
6108 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6109 /* It's publicly an integer, or privately an integer-not-float */
6110 #ifdef PERL_PRESERVE_IVUV
6114 if (SvUVX(sv) == UV_MAX)
6115 sv_setnv(sv, UV_MAX_P1);
6117 (void)SvIOK_only_UV(sv);
6118 SvUV_set(sv, SvUVX(sv) + 1);
6120 if (SvIVX(sv) == IV_MAX)
6121 sv_setuv(sv, (UV)IV_MAX + 1);
6123 (void)SvIOK_only(sv);
6124 SvIV_set(sv, SvIVX(sv) + 1);
6129 if (flags & SVp_NOK) {
6130 (void)SvNOK_only(sv);
6131 SvNV_set(sv, SvNVX(sv) + 1.0);
6135 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6136 if ((flags & SVTYPEMASK) < SVt_PVIV)
6137 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6138 (void)SvIOK_only(sv);
6143 while (isALPHA(*d)) d++;
6144 while (isDIGIT(*d)) d++;
6146 #ifdef PERL_PRESERVE_IVUV
6147 /* Got to punt this as an integer if needs be, but we don't issue
6148 warnings. Probably ought to make the sv_iv_please() that does
6149 the conversion if possible, and silently. */
6150 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6151 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6152 /* Need to try really hard to see if it's an integer.
6153 9.22337203685478e+18 is an integer.
6154 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6155 so $a="9.22337203685478e+18"; $a+0; $a++
6156 needs to be the same as $a="9.22337203685478e+18"; $a++
6163 /* sv_2iv *should* have made this an NV */
6164 if (flags & SVp_NOK) {
6165 (void)SvNOK_only(sv);
6166 SvNV_set(sv, SvNVX(sv) + 1.0);
6169 /* I don't think we can get here. Maybe I should assert this
6170 And if we do get here I suspect that sv_setnv will croak. NWC
6172 #if defined(USE_LONG_DOUBLE)
6173 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",
6174 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6176 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6177 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6180 #endif /* PERL_PRESERVE_IVUV */
6181 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6185 while (d >= SvPVX_const(sv)) {
6193 /* MKS: The original code here died if letters weren't consecutive.
6194 * at least it didn't have to worry about non-C locales. The
6195 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6196 * arranged in order (although not consecutively) and that only
6197 * [A-Za-z] are accepted by isALPHA in the C locale.
6199 if (*d != 'z' && *d != 'Z') {
6200 do { ++*d; } while (!isALPHA(*d));
6203 *(d--) -= 'z' - 'a';
6208 *(d--) -= 'z' - 'a' + 1;
6212 /* oh,oh, the number grew */
6213 SvGROW(sv, SvCUR(sv) + 2);
6214 SvCUR_set(sv, SvCUR(sv) + 1);
6215 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6226 Auto-decrement of the value in the SV, doing string to numeric conversion
6227 if necessary. Handles 'get' magic.
6233 Perl_sv_dec(pTHX_ register SV *sv)
6241 if (SvTHINKFIRST(sv)) {
6243 sv_force_normal_flags(sv, 0);
6244 if (SvREADONLY(sv)) {
6245 if (IN_PERL_RUNTIME)
6246 Perl_croak(aTHX_ PL_no_modify);
6250 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6252 i = PTR2IV(SvRV(sv));
6257 /* Unlike sv_inc we don't have to worry about string-never-numbers
6258 and keeping them magic. But we mustn't warn on punting */
6259 flags = SvFLAGS(sv);
6260 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6261 /* It's publicly an integer, or privately an integer-not-float */
6262 #ifdef PERL_PRESERVE_IVUV
6266 if (SvUVX(sv) == 0) {
6267 (void)SvIOK_only(sv);
6271 (void)SvIOK_only_UV(sv);
6272 SvUV_set(sv, SvUVX(sv) - 1);
6275 if (SvIVX(sv) == IV_MIN)
6276 sv_setnv(sv, (NV)IV_MIN - 1.0);
6278 (void)SvIOK_only(sv);
6279 SvIV_set(sv, SvIVX(sv) - 1);
6284 if (flags & SVp_NOK) {
6285 SvNV_set(sv, SvNVX(sv) - 1.0);
6286 (void)SvNOK_only(sv);
6289 if (!(flags & SVp_POK)) {
6290 if ((flags & SVTYPEMASK) < SVt_PVIV)
6291 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6293 (void)SvIOK_only(sv);
6296 #ifdef PERL_PRESERVE_IVUV
6298 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6299 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6300 /* Need to try really hard to see if it's an integer.
6301 9.22337203685478e+18 is an integer.
6302 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6303 so $a="9.22337203685478e+18"; $a+0; $a--
6304 needs to be the same as $a="9.22337203685478e+18"; $a--
6311 /* sv_2iv *should* have made this an NV */
6312 if (flags & SVp_NOK) {
6313 (void)SvNOK_only(sv);
6314 SvNV_set(sv, SvNVX(sv) - 1.0);
6317 /* I don't think we can get here. Maybe I should assert this
6318 And if we do get here I suspect that sv_setnv will croak. NWC
6320 #if defined(USE_LONG_DOUBLE)
6321 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",
6322 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6324 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6325 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6329 #endif /* PERL_PRESERVE_IVUV */
6330 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6334 =for apidoc sv_mortalcopy
6336 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6337 The new SV is marked as mortal. It will be destroyed "soon", either by an
6338 explicit call to FREETMPS, or by an implicit call at places such as
6339 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6344 /* Make a string that will exist for the duration of the expression
6345 * evaluation. Actually, it may have to last longer than that, but
6346 * hopefully we won't free it until it has been assigned to a
6347 * permanent location. */
6350 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6356 sv_setsv(sv,oldstr);
6358 PL_tmps_stack[++PL_tmps_ix] = sv;
6364 =for apidoc sv_newmortal
6366 Creates a new null SV which is mortal. The reference count of the SV is
6367 set to 1. It will be destroyed "soon", either by an explicit call to
6368 FREETMPS, or by an implicit call at places such as statement boundaries.
6369 See also C<sv_mortalcopy> and C<sv_2mortal>.
6375 Perl_sv_newmortal(pTHX)
6381 SvFLAGS(sv) = SVs_TEMP;
6383 PL_tmps_stack[++PL_tmps_ix] = sv;
6388 =for apidoc sv_2mortal
6390 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6391 by an explicit call to FREETMPS, or by an implicit call at places such as
6392 statement boundaries. SvTEMP() is turned on which means that the SV's
6393 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6394 and C<sv_mortalcopy>.
6400 Perl_sv_2mortal(pTHX_ register SV *sv)
6405 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6408 PL_tmps_stack[++PL_tmps_ix] = sv;
6416 Creates a new SV and copies a string into it. The reference count for the
6417 SV is set to 1. If C<len> is zero, Perl will compute the length using
6418 strlen(). For efficiency, consider using C<newSVpvn> instead.
6424 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6430 sv_setpvn(sv,s,len ? len : strlen(s));
6435 =for apidoc newSVpvn
6437 Creates a new SV and copies a string into it. The reference count for the
6438 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6439 string. You are responsible for ensuring that the source string is at least
6440 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6446 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6452 sv_setpvn(sv,s,len);
6458 =for apidoc newSVhek
6460 Creates a new SV from the hash key structure. It will generate scalars that
6461 point to the shared string table where possible. Returns a new (undefined)
6462 SV if the hek is NULL.
6468 Perl_newSVhek(pTHX_ const HEK *hek)
6478 if (HEK_LEN(hek) == HEf_SVKEY) {
6479 return newSVsv(*(SV**)HEK_KEY(hek));
6481 const int flags = HEK_FLAGS(hek);
6482 if (flags & HVhek_WASUTF8) {
6484 Andreas would like keys he put in as utf8 to come back as utf8
6486 STRLEN utf8_len = HEK_LEN(hek);
6487 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6488 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6491 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6493 } else if (flags & HVhek_REHASH) {
6494 /* We don't have a pointer to the hv, so we have to replicate the
6495 flag into every HEK. This hv is using custom a hasing
6496 algorithm. Hence we can't return a shared string scalar, as
6497 that would contain the (wrong) hash value, and might get passed
6498 into an hv routine with a regular hash */
6500 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6505 /* This will be overwhelminly the most common case. */
6506 return newSVpvn_share(HEK_KEY(hek),
6507 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6513 =for apidoc newSVpvn_share
6515 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6516 table. If the string does not already exist in the table, it is created
6517 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6518 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6519 otherwise the hash is computed. The idea here is that as the string table
6520 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6521 hash lookup will avoid string compare.
6527 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6531 bool is_utf8 = FALSE;
6533 STRLEN tmplen = -len;
6535 /* See the note in hv.c:hv_fetch() --jhi */
6536 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6540 PERL_HASH(hash, src, len);
6542 sv_upgrade(sv, SVt_PV);
6543 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6555 #if defined(PERL_IMPLICIT_CONTEXT)
6557 /* pTHX_ magic can't cope with varargs, so this is a no-context
6558 * version of the main function, (which may itself be aliased to us).
6559 * Don't access this version directly.
6563 Perl_newSVpvf_nocontext(const char* pat, ...)
6568 va_start(args, pat);
6569 sv = vnewSVpvf(pat, &args);
6576 =for apidoc newSVpvf
6578 Creates a new SV and initializes it with the string formatted like
6585 Perl_newSVpvf(pTHX_ const char* pat, ...)
6589 va_start(args, pat);
6590 sv = vnewSVpvf(pat, &args);
6595 /* backend for newSVpvf() and newSVpvf_nocontext() */
6598 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6603 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6610 Creates a new SV and copies a floating point value into it.
6611 The reference count for the SV is set to 1.
6617 Perl_newSVnv(pTHX_ NV n)
6630 Creates a new SV and copies an integer into it. The reference count for the
6637 Perl_newSViv(pTHX_ IV i)
6650 Creates a new SV and copies an unsigned integer into it.
6651 The reference count for the SV is set to 1.
6657 Perl_newSVuv(pTHX_ UV u)
6668 =for apidoc newRV_noinc
6670 Creates an RV wrapper for an SV. The reference count for the original
6671 SV is B<not> incremented.
6677 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6683 sv_upgrade(sv, SVt_RV);
6685 SvRV_set(sv, tmpRef);
6690 /* newRV_inc is the official function name to use now.
6691 * newRV_inc is in fact #defined to newRV in sv.h
6695 Perl_newRV(pTHX_ SV *tmpRef)
6698 return newRV_noinc(SvREFCNT_inc(tmpRef));
6704 Creates a new SV which is an exact duplicate of the original SV.
6711 Perl_newSVsv(pTHX_ register SV *old)
6718 if (SvTYPE(old) == SVTYPEMASK) {
6719 if (ckWARN_d(WARN_INTERNAL))
6720 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6724 /* SV_GMAGIC is the default for sv_setv()
6725 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6726 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6727 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6732 =for apidoc sv_reset
6734 Underlying implementation for the C<reset> Perl function.
6735 Note that the perl-level function is vaguely deprecated.
6741 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6744 char todo[PERL_UCHAR_MAX+1];
6749 if (!*s) { /* reset ?? searches */
6750 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6752 PMOP *pm = (PMOP *) mg->mg_obj;
6754 pm->op_pmdynflags &= ~PMdf_USED;
6761 /* reset variables */
6763 if (!HvARRAY(stash))
6766 Zero(todo, 256, char);
6769 I32 i = (unsigned char)*s;
6773 max = (unsigned char)*s++;
6774 for ( ; i <= max; i++) {
6777 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6779 for (entry = HvARRAY(stash)[i];
6781 entry = HeNEXT(entry))
6786 if (!todo[(U8)*HeKEY(entry)])
6788 gv = (GV*)HeVAL(entry);
6791 if (SvTHINKFIRST(sv)) {
6792 if (!SvREADONLY(sv) && SvROK(sv))
6794 /* XXX Is this continue a bug? Why should THINKFIRST
6795 exempt us from resetting arrays and hashes? */
6799 if (SvTYPE(sv) >= SVt_PV) {
6801 if (SvPVX_const(sv) != Nullch)
6809 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6811 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6814 # if defined(USE_ENVIRON_ARRAY)
6817 # endif /* USE_ENVIRON_ARRAY */
6828 Using various gambits, try to get an IO from an SV: the IO slot if its a
6829 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6830 named after the PV if we're a string.
6836 Perl_sv_2io(pTHX_ SV *sv)
6841 switch (SvTYPE(sv)) {
6849 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6853 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6855 return sv_2io(SvRV(sv));
6856 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6862 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6871 Using various gambits, try to get a CV from an SV; in addition, try if
6872 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6873 The flags in C<lref> are passed to sv_fetchsv.
6879 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6886 return *st = NULL, *gvp = Nullgv, Nullcv;
6887 switch (SvTYPE(sv)) {
6906 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6907 tryAMAGICunDEREF(to_cv);
6910 if (SvTYPE(sv) == SVt_PVCV) {
6919 Perl_croak(aTHX_ "Not a subroutine reference");
6924 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6930 /* Some flags to gv_fetchsv mean don't really create the GV */
6931 if (SvTYPE(gv) != SVt_PVGV) {
6937 if (lref && !GvCVu(gv)) {
6941 gv_efullname3(tmpsv, gv, Nullch);
6942 /* XXX this is probably not what they think they're getting.
6943 * It has the same effect as "sub name;", i.e. just a forward
6945 newSUB(start_subparse(FALSE, 0),
6946 newSVOP(OP_CONST, 0, tmpsv),
6951 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6961 Returns true if the SV has a true value by Perl's rules.
6962 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6963 instead use an in-line version.
6969 Perl_sv_true(pTHX_ register SV *sv)
6974 register const XPV* const tXpv = (XPV*)SvANY(sv);
6976 (tXpv->xpv_cur > 1 ||
6977 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6984 return SvIVX(sv) != 0;
6987 return SvNVX(sv) != 0.0;
6989 return sv_2bool(sv);
6995 =for apidoc sv_pvn_force
6997 Get a sensible string out of the SV somehow.
6998 A private implementation of the C<SvPV_force> macro for compilers which
6999 can't cope with complex macro expressions. Always use the macro instead.
7001 =for apidoc sv_pvn_force_flags
7003 Get a sensible string out of the SV somehow.
7004 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7005 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7006 implemented in terms of this function.
7007 You normally want to use the various wrapper macros instead: see
7008 C<SvPV_force> and C<SvPV_force_nomg>
7014 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7017 if (SvTHINKFIRST(sv) && !SvROK(sv))
7018 sv_force_normal_flags(sv, 0);
7028 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7029 const char * const ref = sv_reftype(sv,0);
7031 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7032 ref, OP_NAME(PL_op));
7034 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7036 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7037 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7039 s = sv_2pv_flags(sv, &len, flags);
7043 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7046 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7047 SvGROW(sv, len + 1);
7048 Move(s,SvPVX(sv),len,char);
7053 SvPOK_on(sv); /* validate pointer */
7055 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7056 PTR2UV(sv),SvPVX_const(sv)));
7059 return SvPVX_mutable(sv);
7063 =for apidoc sv_pvbyten_force
7065 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7071 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7073 sv_pvn_force(sv,lp);
7074 sv_utf8_downgrade(sv,0);
7080 =for apidoc sv_pvutf8n_force
7082 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7088 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7090 sv_pvn_force(sv,lp);
7091 sv_utf8_upgrade(sv);
7097 =for apidoc sv_reftype
7099 Returns a string describing what the SV is a reference to.
7105 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7107 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7108 inside return suggests a const propagation bug in g++. */
7109 if (ob && SvOBJECT(sv)) {
7110 char * const name = HvNAME_get(SvSTASH(sv));
7111 return name ? name : (char *) "__ANON__";
7114 switch (SvTYPE(sv)) {
7131 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7132 /* tied lvalues should appear to be
7133 * scalars for backwards compatitbility */
7134 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7135 ? "SCALAR" : "LVALUE");
7136 case SVt_PVAV: return "ARRAY";
7137 case SVt_PVHV: return "HASH";
7138 case SVt_PVCV: return "CODE";
7139 case SVt_PVGV: return "GLOB";
7140 case SVt_PVFM: return "FORMAT";
7141 case SVt_PVIO: return "IO";
7142 default: return "UNKNOWN";
7148 =for apidoc sv_isobject
7150 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7151 object. If the SV is not an RV, or if the object is not blessed, then this
7158 Perl_sv_isobject(pTHX_ SV *sv)
7174 Returns a boolean indicating whether the SV is blessed into the specified
7175 class. This does not check for subtypes; use C<sv_derived_from> to verify
7176 an inheritance relationship.
7182 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7193 hvname = HvNAME_get(SvSTASH(sv));
7197 return strEQ(hvname, name);
7203 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7204 it will be upgraded to one. If C<classname> is non-null then the new SV will
7205 be blessed in the specified package. The new SV is returned and its
7206 reference count is 1.
7212 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7219 SV_CHECK_THINKFIRST_COW_DROP(rv);
7222 if (SvTYPE(rv) >= SVt_PVMG) {
7223 const U32 refcnt = SvREFCNT(rv);
7227 SvREFCNT(rv) = refcnt;
7230 if (SvTYPE(rv) < SVt_RV)
7231 sv_upgrade(rv, SVt_RV);
7232 else if (SvTYPE(rv) > SVt_RV) {
7243 HV* const stash = gv_stashpv(classname, TRUE);
7244 (void)sv_bless(rv, stash);
7250 =for apidoc sv_setref_pv
7252 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7253 argument will be upgraded to an RV. That RV will be modified to point to
7254 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7255 into the SV. The C<classname> argument indicates the package for the
7256 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7257 will have a reference count of 1, and the RV will be returned.
7259 Do not use with other Perl types such as HV, AV, SV, CV, because those
7260 objects will become corrupted by the pointer copy process.
7262 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7268 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7272 sv_setsv(rv, &PL_sv_undef);
7276 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7281 =for apidoc sv_setref_iv
7283 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7284 argument will be upgraded to an RV. That RV will be modified to point to
7285 the new SV. The C<classname> argument indicates the package for the
7286 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7287 will have a reference count of 1, and the RV will be returned.
7293 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7295 sv_setiv(newSVrv(rv,classname), iv);
7300 =for apidoc sv_setref_uv
7302 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7303 argument will be upgraded to an RV. That RV will be modified to point to
7304 the new SV. The C<classname> argument indicates the package for the
7305 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7306 will have a reference count of 1, and the RV will be returned.
7312 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7314 sv_setuv(newSVrv(rv,classname), uv);
7319 =for apidoc sv_setref_nv
7321 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7322 argument will be upgraded to an RV. That RV will be modified to point to
7323 the new SV. The C<classname> argument indicates the package for the
7324 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7325 will have a reference count of 1, and the RV will be returned.
7331 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7333 sv_setnv(newSVrv(rv,classname), nv);
7338 =for apidoc sv_setref_pvn
7340 Copies a string into a new SV, optionally blessing the SV. The length of the
7341 string must be specified with C<n>. The C<rv> argument will be upgraded to
7342 an RV. That RV will be modified to point to the new SV. The C<classname>
7343 argument indicates the package for the blessing. Set C<classname> to
7344 C<Nullch> to avoid the blessing. The new SV will have a reference count
7345 of 1, and the RV will be returned.
7347 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7353 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7355 sv_setpvn(newSVrv(rv,classname), pv, n);
7360 =for apidoc sv_bless
7362 Blesses an SV into a specified package. The SV must be an RV. The package
7363 must be designated by its stash (see C<gv_stashpv()>). The reference count
7364 of the SV is unaffected.
7370 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7375 Perl_croak(aTHX_ "Can't bless non-reference value");
7377 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7378 if (SvREADONLY(tmpRef))
7379 Perl_croak(aTHX_ PL_no_modify);
7380 if (SvOBJECT(tmpRef)) {
7381 if (SvTYPE(tmpRef) != SVt_PVIO)
7383 SvREFCNT_dec(SvSTASH(tmpRef));
7386 SvOBJECT_on(tmpRef);
7387 if (SvTYPE(tmpRef) != SVt_PVIO)
7389 SvUPGRADE(tmpRef, SVt_PVMG);
7390 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7397 if(SvSMAGICAL(tmpRef))
7398 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7406 /* Downgrades a PVGV to a PVMG.
7410 S_sv_unglob(pTHX_ SV *sv)
7415 assert(SvTYPE(sv) == SVt_PVGV);
7420 sv_del_backref((SV*)GvSTASH(sv), sv);
7423 sv_unmagic(sv, PERL_MAGIC_glob);
7424 Safefree(GvNAME(sv));
7427 /* need to keep SvANY(sv) in the right arena */
7428 xpvmg = new_XPVMG();
7429 StructCopy(SvANY(sv), xpvmg, XPVMG);
7430 del_XPVGV(SvANY(sv));
7433 SvFLAGS(sv) &= ~SVTYPEMASK;
7434 SvFLAGS(sv) |= SVt_PVMG;
7438 =for apidoc sv_unref_flags
7440 Unsets the RV status of the SV, and decrements the reference count of
7441 whatever was being referenced by the RV. This can almost be thought of
7442 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7443 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7444 (otherwise the decrementing is conditional on the reference count being
7445 different from one or the reference being a readonly SV).
7452 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7454 SV* const target = SvRV(ref);
7456 if (SvWEAKREF(ref)) {
7457 sv_del_backref(target, ref);
7459 SvRV_set(ref, NULL);
7462 SvRV_set(ref, NULL);
7464 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7465 assigned to as BEGIN {$a = \"Foo"} will fail. */
7466 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7467 SvREFCNT_dec(target);
7468 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7469 sv_2mortal(target); /* Schedule for freeing later */
7473 =for apidoc sv_untaint
7475 Untaint an SV. Use C<SvTAINTED_off> instead.
7480 Perl_sv_untaint(pTHX_ SV *sv)
7482 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7483 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7490 =for apidoc sv_tainted
7492 Test an SV for taintedness. Use C<SvTAINTED> instead.
7497 Perl_sv_tainted(pTHX_ SV *sv)
7499 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7500 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7501 if (mg && (mg->mg_len & 1) )
7508 =for apidoc sv_setpviv
7510 Copies an integer into the given SV, also updating its string value.
7511 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7517 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7519 char buf[TYPE_CHARS(UV)];
7521 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7523 sv_setpvn(sv, ptr, ebuf - ptr);
7527 =for apidoc sv_setpviv_mg
7529 Like C<sv_setpviv>, but also handles 'set' magic.
7535 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7541 #if defined(PERL_IMPLICIT_CONTEXT)
7543 /* pTHX_ magic can't cope with varargs, so this is a no-context
7544 * version of the main function, (which may itself be aliased to us).
7545 * Don't access this version directly.
7549 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7553 va_start(args, pat);
7554 sv_vsetpvf(sv, pat, &args);
7558 /* pTHX_ magic can't cope with varargs, so this is a no-context
7559 * version of the main function, (which may itself be aliased to us).
7560 * Don't access this version directly.
7564 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7568 va_start(args, pat);
7569 sv_vsetpvf_mg(sv, pat, &args);
7575 =for apidoc sv_setpvf
7577 Works like C<sv_catpvf> but copies the text into the SV instead of
7578 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7584 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7587 va_start(args, pat);
7588 sv_vsetpvf(sv, pat, &args);
7593 =for apidoc sv_vsetpvf
7595 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7596 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7598 Usually used via its frontend C<sv_setpvf>.
7604 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7606 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7610 =for apidoc sv_setpvf_mg
7612 Like C<sv_setpvf>, but also handles 'set' magic.
7618 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7621 va_start(args, pat);
7622 sv_vsetpvf_mg(sv, pat, &args);
7627 =for apidoc sv_vsetpvf_mg
7629 Like C<sv_vsetpvf>, but also handles 'set' magic.
7631 Usually used via its frontend C<sv_setpvf_mg>.
7637 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7639 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7643 #if defined(PERL_IMPLICIT_CONTEXT)
7645 /* pTHX_ magic can't cope with varargs, so this is a no-context
7646 * version of the main function, (which may itself be aliased to us).
7647 * Don't access this version directly.
7651 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7655 va_start(args, pat);
7656 sv_vcatpvf(sv, pat, &args);
7660 /* pTHX_ magic can't cope with varargs, so this is a no-context
7661 * version of the main function, (which may itself be aliased to us).
7662 * Don't access this version directly.
7666 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7670 va_start(args, pat);
7671 sv_vcatpvf_mg(sv, pat, &args);
7677 =for apidoc sv_catpvf
7679 Processes its arguments like C<sprintf> and appends the formatted
7680 output to an SV. If the appended data contains "wide" characters
7681 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7682 and characters >255 formatted with %c), the original SV might get
7683 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7684 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7685 valid UTF-8; if the original SV was bytes, the pattern should be too.
7690 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7693 va_start(args, pat);
7694 sv_vcatpvf(sv, pat, &args);
7699 =for apidoc sv_vcatpvf
7701 Processes its arguments like C<vsprintf> and appends the formatted output
7702 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7704 Usually used via its frontend C<sv_catpvf>.
7710 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7712 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7716 =for apidoc sv_catpvf_mg
7718 Like C<sv_catpvf>, but also handles 'set' magic.
7724 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7727 va_start(args, pat);
7728 sv_vcatpvf_mg(sv, pat, &args);
7733 =for apidoc sv_vcatpvf_mg
7735 Like C<sv_vcatpvf>, but also handles 'set' magic.
7737 Usually used via its frontend C<sv_catpvf_mg>.
7743 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7745 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7750 =for apidoc sv_vsetpvfn
7752 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7755 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7761 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7763 sv_setpvn(sv, "", 0);
7764 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7768 S_expect_number(pTHX_ char** pattern)
7772 switch (**pattern) {
7773 case '1': case '2': case '3':
7774 case '4': case '5': case '6':
7775 case '7': case '8': case '9':
7776 var = *(*pattern)++ - '0';
7777 while (isDIGIT(**pattern)) {
7778 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7780 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7788 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7790 const int neg = nv < 0;
7799 if (uv & 1 && uv == nv)
7800 uv--; /* Round to even */
7802 const unsigned dig = uv % 10;
7815 =for apidoc sv_vcatpvfn
7817 Processes its arguments like C<vsprintf> and appends the formatted output
7818 to an SV. Uses an array of SVs if the C style variable argument list is
7819 missing (NULL). When running with taint checks enabled, indicates via
7820 C<maybe_tainted> if results are untrustworthy (often due to the use of
7823 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7829 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7830 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7831 vec_utf8 = DO_UTF8(vecsv);
7833 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7836 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7844 static const char nullstr[] = "(null)";
7846 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7847 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7849 /* Times 4: a decimal digit takes more than 3 binary digits.
7850 * NV_DIG: mantissa takes than many decimal digits.
7851 * Plus 32: Playing safe. */
7852 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7853 /* large enough for "%#.#f" --chip */
7854 /* what about long double NVs? --jhi */
7856 PERL_UNUSED_ARG(maybe_tainted);
7858 /* no matter what, this is a string now */
7859 (void)SvPV_force(sv, origlen);
7861 /* special-case "", "%s", and "%-p" (SVf - see below) */
7864 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7866 const char * const s = va_arg(*args, char*);
7867 sv_catpv(sv, s ? s : nullstr);
7869 else if (svix < svmax) {
7870 sv_catsv(sv, *svargs);
7874 if (args && patlen == 3 && pat[0] == '%' &&
7875 pat[1] == '-' && pat[2] == 'p') {
7876 argsv = va_arg(*args, SV*);
7877 sv_catsv(sv, argsv);
7881 #ifndef USE_LONG_DOUBLE
7882 /* special-case "%.<number>[gf]" */
7883 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7884 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7885 unsigned digits = 0;
7889 while (*pp >= '0' && *pp <= '9')
7890 digits = 10 * digits + (*pp++ - '0');
7891 if (pp - pat == (int)patlen - 1) {
7899 /* Add check for digits != 0 because it seems that some
7900 gconverts are buggy in this case, and we don't yet have
7901 a Configure test for this. */
7902 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7903 /* 0, point, slack */
7904 Gconvert(nv, (int)digits, 0, ebuf);
7906 if (*ebuf) /* May return an empty string for digits==0 */
7909 } else if (!digits) {
7912 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7913 sv_catpvn(sv, p, l);
7919 #endif /* !USE_LONG_DOUBLE */
7921 if (!args && svix < svmax && DO_UTF8(*svargs))
7924 patend = (char*)pat + patlen;
7925 for (p = (char*)pat; p < patend; p = q) {
7928 bool vectorize = FALSE;
7929 bool vectorarg = FALSE;
7930 bool vec_utf8 = FALSE;
7936 bool has_precis = FALSE;
7938 const I32 osvix = svix;
7939 bool is_utf8 = FALSE; /* is this item utf8? */
7940 #ifdef HAS_LDBL_SPRINTF_BUG
7941 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7942 with sfio - Allen <allens@cpan.org> */
7943 bool fix_ldbl_sprintf_bug = FALSE;
7947 U8 utf8buf[UTF8_MAXBYTES+1];
7948 STRLEN esignlen = 0;
7950 const char *eptr = Nullch;
7953 const U8 *vecstr = Null(U8*);
7960 /* we need a long double target in case HAS_LONG_DOUBLE but
7963 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7971 const char *dotstr = ".";
7972 STRLEN dotstrlen = 1;
7973 I32 efix = 0; /* explicit format parameter index */
7974 I32 ewix = 0; /* explicit width index */
7975 I32 epix = 0; /* explicit precision index */
7976 I32 evix = 0; /* explicit vector index */
7977 bool asterisk = FALSE;
7979 /* echo everything up to the next format specification */
7980 for (q = p; q < patend && *q != '%'; ++q) ;
7982 if (has_utf8 && !pat_utf8)
7983 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7985 sv_catpvn(sv, p, q - p);
7992 We allow format specification elements in this order:
7993 \d+\$ explicit format parameter index
7995 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7996 0 flag (as above): repeated to allow "v02"
7997 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7998 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8000 [%bcdefginopsuxDFOUX] format (mandatory)
8005 As of perl5.9.3, printf format checking is on by default.
8006 Internally, perl uses %p formats to provide an escape to
8007 some extended formatting. This block deals with those
8008 extensions: if it does not match, (char*)q is reset and
8009 the normal format processing code is used.
8011 Currently defined extensions are:
8012 %p include pointer address (standard)
8013 %-p (SVf) include an SV (previously %_)
8014 %-<num>p include an SV with precision <num>
8015 %1p (VDf) include a v-string (as %vd)
8016 %<num>p reserved for future extensions
8018 Robin Barker 2005-07-14
8025 n = expect_number(&q);
8032 argsv = va_arg(*args, SV*);
8033 eptr = SvPVx_const(argsv, elen);
8039 else if (n == vdNUMBER) { /* VDf */
8046 if (ckWARN_d(WARN_INTERNAL))
8047 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8048 "internal %%<num>p might conflict with future printf extensions");
8054 if ( (width = expect_number(&q)) ) {
8095 if ( (ewix = expect_number(&q)) )
8104 if ((vectorarg = asterisk)) {
8117 width = expect_number(&q);
8123 vecsv = va_arg(*args, SV*);
8125 vecsv = (evix > 0 && evix <= svmax)
8126 ? svargs[evix-1] : &PL_sv_undef;
8128 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8130 dotstr = SvPV_const(vecsv, dotstrlen);
8131 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8132 bad with tied or overloaded values that return UTF8. */
8135 else if (has_utf8) {
8136 vecsv = sv_mortalcopy(vecsv);
8137 sv_utf8_upgrade(vecsv);
8138 dotstr = SvPV_const(vecsv, dotstrlen);
8145 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8146 vecsv = svargs[efix ? efix-1 : svix++];
8147 vecstr = (U8*)SvPV_const(vecsv,veclen);
8148 vec_utf8 = DO_UTF8(vecsv);
8150 /* if this is a version object, we need to convert
8151 * back into v-string notation and then let the
8152 * vectorize happen normally
8154 if (sv_derived_from(vecsv, "version")) {
8155 char *version = savesvpv(vecsv);
8156 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8157 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8158 "vector argument not supported with alpha versions");
8161 vecsv = sv_newmortal();
8162 /* scan_vstring is expected to be called during
8163 * tokenization, so we need to fake up the end
8164 * of the buffer for it
8166 PL_bufend = version + veclen;
8167 scan_vstring(version, vecsv);
8168 vecstr = (U8*)SvPV_const(vecsv, veclen);
8169 vec_utf8 = DO_UTF8(vecsv);
8181 i = va_arg(*args, int);
8183 i = (ewix ? ewix <= svmax : svix < svmax) ?
8184 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8186 width = (i < 0) ? -i : i;
8196 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8198 /* XXX: todo, support specified precision parameter */
8202 i = va_arg(*args, int);
8204 i = (ewix ? ewix <= svmax : svix < svmax)
8205 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8206 precis = (i < 0) ? 0 : i;
8211 precis = precis * 10 + (*q++ - '0');
8220 case 'I': /* Ix, I32x, and I64x */
8222 if (q[1] == '6' && q[2] == '4') {
8228 if (q[1] == '3' && q[2] == '2') {
8238 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8249 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8250 if (*(q + 1) == 'l') { /* lld, llf */
8276 if (!vectorize && !args) {
8278 const I32 i = efix-1;
8279 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8281 argsv = (svix >= 0 && svix < svmax)
8282 ? svargs[svix++] : &PL_sv_undef;
8293 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8295 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8297 eptr = (char*)utf8buf;
8298 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8312 eptr = va_arg(*args, char*);
8314 #ifdef MACOS_TRADITIONAL
8315 /* On MacOS, %#s format is used for Pascal strings */
8320 elen = strlen(eptr);
8322 eptr = (char *)nullstr;
8323 elen = sizeof nullstr - 1;
8327 eptr = SvPVx_const(argsv, elen);
8328 if (DO_UTF8(argsv)) {
8329 if (has_precis && precis < elen) {
8331 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8334 if (width) { /* fudge width (can't fudge elen) */
8335 width += elen - sv_len_utf8(argsv);
8342 if (has_precis && elen > precis)
8349 if (alt || vectorize)
8351 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8372 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8381 esignbuf[esignlen++] = plus;
8385 case 'h': iv = (short)va_arg(*args, int); break;
8386 case 'l': iv = va_arg(*args, long); break;
8387 case 'V': iv = va_arg(*args, IV); break;
8388 default: iv = va_arg(*args, int); break;
8390 case 'q': iv = va_arg(*args, Quad_t); break;
8395 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8397 case 'h': iv = (short)tiv; break;
8398 case 'l': iv = (long)tiv; break;
8400 default: iv = tiv; break;
8402 case 'q': iv = (Quad_t)tiv; break;
8406 if ( !vectorize ) /* we already set uv above */
8411 esignbuf[esignlen++] = plus;
8415 esignbuf[esignlen++] = '-';
8458 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8469 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8470 case 'l': uv = va_arg(*args, unsigned long); break;
8471 case 'V': uv = va_arg(*args, UV); break;
8472 default: uv = va_arg(*args, unsigned); break;
8474 case 'q': uv = va_arg(*args, Uquad_t); break;
8479 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8481 case 'h': uv = (unsigned short)tuv; break;
8482 case 'l': uv = (unsigned long)tuv; break;
8484 default: uv = tuv; break;
8486 case 'q': uv = (Uquad_t)tuv; break;
8493 char *ptr = ebuf + sizeof ebuf;
8499 p = (char*)((c == 'X')
8500 ? "0123456789ABCDEF" : "0123456789abcdef");
8506 esignbuf[esignlen++] = '0';
8507 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8515 if (alt && *ptr != '0')
8526 esignbuf[esignlen++] = '0';
8527 esignbuf[esignlen++] = 'b';
8530 default: /* it had better be ten or less */
8534 } while (uv /= base);
8537 elen = (ebuf + sizeof ebuf) - ptr;
8541 zeros = precis - elen;
8542 else if (precis == 0 && elen == 1 && *eptr == '0')
8548 /* FLOATING POINT */
8551 c = 'f'; /* maybe %F isn't supported here */
8559 /* This is evil, but floating point is even more evil */
8561 /* for SV-style calling, we can only get NV
8562 for C-style calling, we assume %f is double;
8563 for simplicity we allow any of %Lf, %llf, %qf for long double
8567 #if defined(USE_LONG_DOUBLE)
8571 /* [perl #20339] - we should accept and ignore %lf rather than die */
8575 #if defined(USE_LONG_DOUBLE)
8576 intsize = args ? 0 : 'q';
8580 #if defined(HAS_LONG_DOUBLE)
8589 /* now we need (long double) if intsize == 'q', else (double) */
8591 #if LONG_DOUBLESIZE > DOUBLESIZE
8593 va_arg(*args, long double) :
8594 va_arg(*args, double)
8596 va_arg(*args, double)
8601 if (c != 'e' && c != 'E') {
8603 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8604 will cast our (long double) to (double) */
8605 (void)Perl_frexp(nv, &i);
8606 if (i == PERL_INT_MIN)
8607 Perl_die(aTHX_ "panic: frexp");
8609 need = BIT_DIGITS(i);
8611 need += has_precis ? precis : 6; /* known default */
8616 #ifdef HAS_LDBL_SPRINTF_BUG
8617 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8618 with sfio - Allen <allens@cpan.org> */
8621 # define MY_DBL_MAX DBL_MAX
8622 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8623 # if DOUBLESIZE >= 8
8624 # define MY_DBL_MAX 1.7976931348623157E+308L
8626 # define MY_DBL_MAX 3.40282347E+38L
8630 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8631 # define MY_DBL_MAX_BUG 1L
8633 # define MY_DBL_MAX_BUG MY_DBL_MAX
8637 # define MY_DBL_MIN DBL_MIN
8638 # else /* XXX guessing! -Allen */
8639 # if DOUBLESIZE >= 8
8640 # define MY_DBL_MIN 2.2250738585072014E-308L
8642 # define MY_DBL_MIN 1.17549435E-38L
8646 if ((intsize == 'q') && (c == 'f') &&
8647 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8649 /* it's going to be short enough that
8650 * long double precision is not needed */
8652 if ((nv <= 0L) && (nv >= -0L))
8653 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8655 /* would use Perl_fp_class as a double-check but not
8656 * functional on IRIX - see perl.h comments */
8658 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8659 /* It's within the range that a double can represent */
8660 #if defined(DBL_MAX) && !defined(DBL_MIN)
8661 if ((nv >= ((long double)1/DBL_MAX)) ||
8662 (nv <= (-(long double)1/DBL_MAX)))
8664 fix_ldbl_sprintf_bug = TRUE;
8667 if (fix_ldbl_sprintf_bug == TRUE) {
8677 # undef MY_DBL_MAX_BUG
8680 #endif /* HAS_LDBL_SPRINTF_BUG */
8682 need += 20; /* fudge factor */
8683 if (PL_efloatsize < need) {
8684 Safefree(PL_efloatbuf);
8685 PL_efloatsize = need + 20; /* more fudge */
8686 Newx(PL_efloatbuf, PL_efloatsize, char);
8687 PL_efloatbuf[0] = '\0';
8690 if ( !(width || left || plus || alt) && fill != '0'
8691 && has_precis && intsize != 'q' ) { /* Shortcuts */
8692 /* See earlier comment about buggy Gconvert when digits,
8694 if ( c == 'g' && precis) {
8695 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8696 /* May return an empty string for digits==0 */
8697 if (*PL_efloatbuf) {
8698 elen = strlen(PL_efloatbuf);
8699 goto float_converted;
8701 } else if ( c == 'f' && !precis) {
8702 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8707 char *ptr = ebuf + sizeof ebuf;
8710 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8711 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8712 if (intsize == 'q') {
8713 /* Copy the one or more characters in a long double
8714 * format before the 'base' ([efgEFG]) character to
8715 * the format string. */
8716 static char const prifldbl[] = PERL_PRIfldbl;
8717 char const *p = prifldbl + sizeof(prifldbl) - 3;
8718 while (p >= prifldbl) { *--ptr = *p--; }
8723 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8728 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8740 /* No taint. Otherwise we are in the strange situation
8741 * where printf() taints but print($float) doesn't.
8743 #if defined(HAS_LONG_DOUBLE)
8744 elen = ((intsize == 'q')
8745 ? my_sprintf(PL_efloatbuf, ptr, nv)
8746 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8748 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8752 eptr = PL_efloatbuf;
8760 i = SvCUR(sv) - origlen;
8763 case 'h': *(va_arg(*args, short*)) = i; break;
8764 default: *(va_arg(*args, int*)) = i; break;
8765 case 'l': *(va_arg(*args, long*)) = i; break;
8766 case 'V': *(va_arg(*args, IV*)) = i; break;
8768 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8773 sv_setuv_mg(argsv, (UV)i);
8774 continue; /* not "break" */
8781 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8782 && ckWARN(WARN_PRINTF))
8784 SV * const msg = sv_newmortal();
8785 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8786 (PL_op->op_type == OP_PRTF) ? "" : "s");
8789 Perl_sv_catpvf(aTHX_ msg,
8790 "\"%%%c\"", c & 0xFF);
8792 Perl_sv_catpvf(aTHX_ msg,
8793 "\"%%\\%03"UVof"\"",
8796 sv_catpvs(msg, "end of string");
8797 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8800 /* output mangled stuff ... */
8806 /* ... right here, because formatting flags should not apply */
8807 SvGROW(sv, SvCUR(sv) + elen + 1);
8809 Copy(eptr, p, elen, char);
8812 SvCUR_set(sv, p - SvPVX_const(sv));
8814 continue; /* not "break" */
8817 /* calculate width before utf8_upgrade changes it */
8818 have = esignlen + zeros + elen;
8820 Perl_croak_nocontext(PL_memory_wrap);
8822 if (is_utf8 != has_utf8) {
8825 sv_utf8_upgrade(sv);
8828 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8829 sv_utf8_upgrade(nsv);
8830 eptr = SvPVX_const(nsv);
8833 SvGROW(sv, SvCUR(sv) + elen + 1);
8838 need = (have > width ? have : width);
8841 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8842 Perl_croak_nocontext(PL_memory_wrap);
8843 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8845 if (esignlen && fill == '0') {
8847 for (i = 0; i < (int)esignlen; i++)
8851 memset(p, fill, gap);
8854 if (esignlen && fill != '0') {
8856 for (i = 0; i < (int)esignlen; i++)
8861 for (i = zeros; i; i--)
8865 Copy(eptr, p, elen, char);
8869 memset(p, ' ', gap);
8874 Copy(dotstr, p, dotstrlen, char);
8878 vectorize = FALSE; /* done iterating over vecstr */
8885 SvCUR_set(sv, p - SvPVX_const(sv));
8893 /* =========================================================================
8895 =head1 Cloning an interpreter
8897 All the macros and functions in this section are for the private use of
8898 the main function, perl_clone().
8900 The foo_dup() functions make an exact copy of an existing foo thinngy.
8901 During the course of a cloning, a hash table is used to map old addresses
8902 to new addresses. The table is created and manipulated with the
8903 ptr_table_* functions.
8907 ============================================================================*/
8910 #if defined(USE_ITHREADS)
8912 #ifndef GpREFCNT_inc
8913 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8917 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8918 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8919 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8920 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8921 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8922 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8923 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8924 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8925 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8926 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8927 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8928 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
8929 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
8932 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8933 regcomp.c. AMS 20010712 */
8936 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8941 struct reg_substr_datum *s;
8944 return (REGEXP *)NULL;
8946 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8949 len = r->offsets[0];
8950 npar = r->nparens+1;
8952 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8953 Copy(r->program, ret->program, len+1, regnode);
8955 Newx(ret->startp, npar, I32);
8956 Copy(r->startp, ret->startp, npar, I32);
8957 Newx(ret->endp, npar, I32);
8958 Copy(r->startp, ret->startp, npar, I32);
8960 Newx(ret->substrs, 1, struct reg_substr_data);
8961 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8962 s->min_offset = r->substrs->data[i].min_offset;
8963 s->max_offset = r->substrs->data[i].max_offset;
8964 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8965 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8968 ret->regstclass = NULL;
8971 const int count = r->data->count;
8974 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8975 char, struct reg_data);
8976 Newx(d->what, count, U8);
8979 for (i = 0; i < count; i++) {
8980 d->what[i] = r->data->what[i];
8981 switch (d->what[i]) {
8982 /* legal options are one of: sfpont
8983 see also regcomp.h and pregfree() */
8985 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8988 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8991 /* This is cheating. */
8992 Newx(d->data[i], 1, struct regnode_charclass_class);
8993 StructCopy(r->data->data[i], d->data[i],
8994 struct regnode_charclass_class);
8995 ret->regstclass = (regnode*)d->data[i];
8998 /* Compiled op trees are readonly, and can thus be
8999 shared without duplication. */
9001 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9005 d->data[i] = r->data->data[i];
9008 d->data[i] = r->data->data[i];
9010 ((reg_trie_data*)d->data[i])->refcount++;
9014 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9023 Newx(ret->offsets, 2*len+1, U32);
9024 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9026 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9027 ret->refcnt = r->refcnt;
9028 ret->minlen = r->minlen;
9029 ret->prelen = r->prelen;
9030 ret->nparens = r->nparens;
9031 ret->lastparen = r->lastparen;
9032 ret->lastcloseparen = r->lastcloseparen;
9033 ret->reganch = r->reganch;
9035 ret->sublen = r->sublen;
9037 if (RX_MATCH_COPIED(ret))
9038 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9040 ret->subbeg = Nullch;
9041 #ifdef PERL_OLD_COPY_ON_WRITE
9042 ret->saved_copy = Nullsv;
9045 ptr_table_store(PL_ptr_table, r, ret);
9049 /* duplicate a file handle */
9052 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9056 PERL_UNUSED_ARG(type);
9059 return (PerlIO*)NULL;
9061 /* look for it in the table first */
9062 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9066 /* create anew and remember what it is */
9067 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9068 ptr_table_store(PL_ptr_table, fp, ret);
9072 /* duplicate a directory handle */
9075 Perl_dirp_dup(pTHX_ DIR *dp)
9083 /* duplicate a typeglob */
9086 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9091 /* look for it in the table first */
9092 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9096 /* create anew and remember what it is */
9098 ptr_table_store(PL_ptr_table, gp, ret);
9101 ret->gp_refcnt = 0; /* must be before any other dups! */
9102 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9103 ret->gp_io = io_dup_inc(gp->gp_io, param);
9104 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9105 ret->gp_av = av_dup_inc(gp->gp_av, param);
9106 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9107 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9108 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9109 ret->gp_cvgen = gp->gp_cvgen;
9110 ret->gp_line = gp->gp_line;
9111 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9115 /* duplicate a chain of magic */
9118 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9120 MAGIC *mgprev = (MAGIC*)NULL;
9123 return (MAGIC*)NULL;
9124 /* look for it in the table first */
9125 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9129 for (; mg; mg = mg->mg_moremagic) {
9131 Newxz(nmg, 1, MAGIC);
9133 mgprev->mg_moremagic = nmg;
9136 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9137 nmg->mg_private = mg->mg_private;
9138 nmg->mg_type = mg->mg_type;
9139 nmg->mg_flags = mg->mg_flags;
9140 if (mg->mg_type == PERL_MAGIC_qr) {
9141 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9143 else if(mg->mg_type == PERL_MAGIC_backref) {
9144 /* The backref AV has its reference count deliberately bumped by
9146 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9148 else if (mg->mg_type == PERL_MAGIC_symtab) {
9149 nmg->mg_obj = mg->mg_obj;
9152 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9153 ? sv_dup_inc(mg->mg_obj, param)
9154 : sv_dup(mg->mg_obj, param);
9156 nmg->mg_len = mg->mg_len;
9157 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9158 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9159 if (mg->mg_len > 0) {
9160 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9161 if (mg->mg_type == PERL_MAGIC_overload_table &&
9162 AMT_AMAGIC((AMT*)mg->mg_ptr))
9164 const AMT * const amtp = (AMT*)mg->mg_ptr;
9165 AMT * const namtp = (AMT*)nmg->mg_ptr;
9167 for (i = 1; i < NofAMmeth; i++) {
9168 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9172 else if (mg->mg_len == HEf_SVKEY)
9173 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9175 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9176 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9183 /* create a new pointer-mapping table */
9186 Perl_ptr_table_new(pTHX)
9189 Newxz(tbl, 1, PTR_TBL_t);
9192 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9196 #define PTR_TABLE_HASH(ptr) \
9197 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9200 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9201 following define) and at call to new_body_inline made below in
9202 Perl_ptr_table_store()
9205 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9207 /* map an existing pointer using a table */
9209 STATIC PTR_TBL_ENT_t *
9210 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9211 PTR_TBL_ENT_t *tblent;
9212 const UV hash = PTR_TABLE_HASH(sv);
9214 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9215 for (; tblent; tblent = tblent->next) {
9216 if (tblent->oldval == sv)
9223 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9225 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9226 return tblent ? tblent->newval : (void *) 0;
9229 /* add a new entry to a pointer-mapping table */
9232 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9234 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9237 tblent->newval = newsv;
9239 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9241 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9242 tblent->oldval = oldsv;
9243 tblent->newval = newsv;
9244 tblent->next = tbl->tbl_ary[entry];
9245 tbl->tbl_ary[entry] = tblent;
9247 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9248 ptr_table_split(tbl);
9252 /* double the hash bucket size of an existing ptr table */
9255 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9257 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9258 const UV oldsize = tbl->tbl_max + 1;
9259 UV newsize = oldsize * 2;
9262 Renew(ary, newsize, PTR_TBL_ENT_t*);
9263 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9264 tbl->tbl_max = --newsize;
9266 for (i=0; i < oldsize; i++, ary++) {
9267 PTR_TBL_ENT_t **curentp, **entp, *ent;
9270 curentp = ary + oldsize;
9271 for (entp = ary, ent = *ary; ent; ent = *entp) {
9272 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9274 ent->next = *curentp;
9284 /* remove all the entries from a ptr table */
9287 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9289 if (tbl && tbl->tbl_items) {
9290 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9291 UV riter = tbl->tbl_max;
9294 PTR_TBL_ENT_t *entry = array[riter];
9297 PTR_TBL_ENT_t * const oentry = entry;
9298 entry = entry->next;
9307 /* clear and free a ptr table */
9310 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9315 ptr_table_clear(tbl);
9316 Safefree(tbl->tbl_ary);
9322 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9325 SvRV_set(dstr, SvWEAKREF(sstr)
9326 ? sv_dup(SvRV(sstr), param)
9327 : sv_dup_inc(SvRV(sstr), param));
9330 else if (SvPVX_const(sstr)) {
9331 /* Has something there */
9333 /* Normal PV - clone whole allocated space */
9334 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9335 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9336 /* Not that normal - actually sstr is copy on write.
9337 But we are a true, independant SV, so: */
9338 SvREADONLY_off(dstr);
9343 /* Special case - not normally malloced for some reason */
9344 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9345 /* A "shared" PV - clone it as "shared" PV */
9347 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9351 /* Some other special case - random pointer */
9352 SvPV_set(dstr, SvPVX(sstr));
9358 if (SvTYPE(dstr) == SVt_RV)
9359 SvRV_set(dstr, NULL);
9361 SvPV_set(dstr, NULL);
9365 /* duplicate an SV of any type (including AV, HV etc) */
9368 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9373 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9375 /* look for it in the table first */
9376 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9380 if(param->flags & CLONEf_JOIN_IN) {
9381 /** We are joining here so we don't want do clone
9382 something that is bad **/
9383 if (SvTYPE(sstr) == SVt_PVHV) {
9384 const char * const hvname = HvNAME_get(sstr);
9386 /** don't clone stashes if they already exist **/
9387 return (SV*)gv_stashpv(hvname,0);
9391 /* create anew and remember what it is */
9394 #ifdef DEBUG_LEAKING_SCALARS
9395 dstr->sv_debug_optype = sstr->sv_debug_optype;
9396 dstr->sv_debug_line = sstr->sv_debug_line;
9397 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9398 dstr->sv_debug_cloned = 1;
9399 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9402 ptr_table_store(PL_ptr_table, sstr, dstr);
9405 SvFLAGS(dstr) = SvFLAGS(sstr);
9406 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9407 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9410 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9411 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9412 PL_watch_pvx, SvPVX_const(sstr));
9415 /* don't clone objects whose class has asked us not to */
9416 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9417 SvFLAGS(dstr) &= ~SVTYPEMASK;
9422 switch (SvTYPE(sstr)) {
9427 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9428 SvIV_set(dstr, SvIVX(sstr));
9431 SvANY(dstr) = new_XNV();
9432 SvNV_set(dstr, SvNVX(sstr));
9435 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9436 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9440 /* These are all the types that need complex bodies allocating. */
9442 const svtype sv_type = SvTYPE(sstr);
9443 const struct body_details *const sv_type_details
9444 = bodies_by_type + sv_type;
9448 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9453 if (GvUNIQUE((GV*)sstr)) {
9454 /* Do sharing here, and fall through */
9467 assert(sv_type_details->size);
9468 if (sv_type_details->arena) {
9469 new_body_inline(new_body, sv_type_details->size, sv_type);
9471 = (void*)((char*)new_body - sv_type_details->offset);
9473 new_body = new_NOARENA(sv_type_details);
9477 SvANY(dstr) = new_body;
9480 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9481 ((char*)SvANY(dstr)) + sv_type_details->offset,
9482 sv_type_details->copy, char);
9484 Copy(((char*)SvANY(sstr)),
9485 ((char*)SvANY(dstr)),
9486 sv_type_details->size + sv_type_details->offset, char);
9489 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9490 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9492 /* The Copy above means that all the source (unduplicated) pointers
9493 are now in the destination. We can check the flags and the
9494 pointers in either, but it's possible that there's less cache
9495 missing by always going for the destination.
9496 FIXME - instrument and check that assumption */
9497 if (sv_type >= SVt_PVMG) {
9499 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9501 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9504 /* The cast silences a GCC warning about unhandled types. */
9505 switch ((int)sv_type) {
9517 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9518 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9519 LvTARG(dstr) = dstr;
9520 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9521 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9523 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9526 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9527 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9528 /* Don't call sv_add_backref here as it's going to be created
9529 as part of the magic cloning of the symbol table. */
9530 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9531 (void)GpREFCNT_inc(GvGP(dstr));
9534 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9535 if (IoOFP(dstr) == IoIFP(sstr))
9536 IoOFP(dstr) = IoIFP(dstr);
9538 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9539 /* PL_rsfp_filters entries have fake IoDIRP() */
9540 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9541 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9542 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9543 /* I have no idea why fake dirp (rsfps)
9544 should be treated differently but otherwise
9545 we end up with leaks -- sky*/
9546 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9547 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9548 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9550 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9551 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9552 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9554 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9555 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9556 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9559 if (AvARRAY((AV*)sstr)) {
9560 SV **dst_ary, **src_ary;
9561 SSize_t items = AvFILLp((AV*)sstr) + 1;
9563 src_ary = AvARRAY((AV*)sstr);
9564 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9565 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9566 SvPV_set(dstr, (char*)dst_ary);
9567 AvALLOC((AV*)dstr) = dst_ary;
9568 if (AvREAL((AV*)sstr)) {
9570 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9574 *dst_ary++ = sv_dup(*src_ary++, param);
9576 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9577 while (items-- > 0) {
9578 *dst_ary++ = &PL_sv_undef;
9582 SvPV_set(dstr, Nullch);
9583 AvALLOC((AV*)dstr) = (SV**)NULL;
9590 if (HvARRAY((HV*)sstr)) {
9592 const bool sharekeys = !!HvSHAREKEYS(sstr);
9593 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9594 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9596 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9597 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9599 HvARRAY(dstr) = (HE**)darray;
9600 while (i <= sxhv->xhv_max) {
9601 const HE *source = HvARRAY(sstr)[i];
9602 HvARRAY(dstr)[i] = source
9603 ? he_dup(source, sharekeys, param) : 0;
9607 struct xpvhv_aux * const saux = HvAUX(sstr);
9608 struct xpvhv_aux * const daux = HvAUX(dstr);
9609 /* This flag isn't copied. */
9610 /* SvOOK_on(hv) attacks the IV flags. */
9611 SvFLAGS(dstr) |= SVf_OOK;
9613 hvname = saux->xhv_name;
9615 = hvname ? hek_dup(hvname, param) : hvname;
9617 daux->xhv_riter = saux->xhv_riter;
9618 daux->xhv_eiter = saux->xhv_eiter
9619 ? he_dup(saux->xhv_eiter,
9620 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9621 daux->xhv_backreferences = saux->xhv_backreferences
9622 ? (AV*) SvREFCNT_inc(
9630 SvPV_set(dstr, Nullch);
9632 /* Record stashes for possible cloning in Perl_clone(). */
9634 av_push(param->stashes, dstr);
9639 /* NOTE: not refcounted */
9640 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9642 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9644 if (CvCONST(dstr)) {
9645 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9646 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9647 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9649 /* don't dup if copying back - CvGV isn't refcounted, so the
9650 * duped GV may never be freed. A bit of a hack! DAPM */
9651 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9652 Nullgv : gv_dup(CvGV(dstr), param) ;
9653 if (!(param->flags & CLONEf_COPY_STACKS)) {
9656 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9659 ? cv_dup( CvOUTSIDE(dstr), param)
9660 : cv_dup_inc(CvOUTSIDE(dstr), param);
9662 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9668 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9674 /* duplicate a context */
9677 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9682 return (PERL_CONTEXT*)NULL;
9684 /* look for it in the table first */
9685 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9689 /* create anew and remember what it is */
9690 Newxz(ncxs, max + 1, PERL_CONTEXT);
9691 ptr_table_store(PL_ptr_table, cxs, ncxs);
9694 PERL_CONTEXT * const cx = &cxs[ix];
9695 PERL_CONTEXT * const ncx = &ncxs[ix];
9696 ncx->cx_type = cx->cx_type;
9697 if (CxTYPE(cx) == CXt_SUBST) {
9698 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9701 ncx->blk_oldsp = cx->blk_oldsp;
9702 ncx->blk_oldcop = cx->blk_oldcop;
9703 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9704 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9705 ncx->blk_oldpm = cx->blk_oldpm;
9706 ncx->blk_gimme = cx->blk_gimme;
9707 switch (CxTYPE(cx)) {
9709 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9710 ? cv_dup_inc(cx->blk_sub.cv, param)
9711 : cv_dup(cx->blk_sub.cv,param));
9712 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9713 ? av_dup_inc(cx->blk_sub.argarray, param)
9715 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9716 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9717 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9718 ncx->blk_sub.lval = cx->blk_sub.lval;
9719 ncx->blk_sub.retop = cx->blk_sub.retop;
9722 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9723 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9724 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9725 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9726 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9727 ncx->blk_eval.retop = cx->blk_eval.retop;
9730 ncx->blk_loop.label = cx->blk_loop.label;
9731 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9732 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9733 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9734 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9735 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9736 ? cx->blk_loop.iterdata
9737 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9738 ncx->blk_loop.oldcomppad
9739 = (PAD*)ptr_table_fetch(PL_ptr_table,
9740 cx->blk_loop.oldcomppad);
9741 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9742 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9743 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9744 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9745 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9748 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9749 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9750 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9751 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9752 ncx->blk_sub.retop = cx->blk_sub.retop;
9764 /* duplicate a stack info structure */
9767 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9772 return (PERL_SI*)NULL;
9774 /* look for it in the table first */
9775 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9779 /* create anew and remember what it is */
9780 Newxz(nsi, 1, PERL_SI);
9781 ptr_table_store(PL_ptr_table, si, nsi);
9783 nsi->si_stack = av_dup_inc(si->si_stack, param);
9784 nsi->si_cxix = si->si_cxix;
9785 nsi->si_cxmax = si->si_cxmax;
9786 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9787 nsi->si_type = si->si_type;
9788 nsi->si_prev = si_dup(si->si_prev, param);
9789 nsi->si_next = si_dup(si->si_next, param);
9790 nsi->si_markoff = si->si_markoff;
9795 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9796 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9797 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9798 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9799 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9800 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9801 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9802 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9803 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9804 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9805 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9806 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9807 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9808 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9811 #define pv_dup_inc(p) SAVEPV(p)
9812 #define pv_dup(p) SAVEPV(p)
9813 #define svp_dup_inc(p,pp) any_dup(p,pp)
9815 /* map any object to the new equivent - either something in the
9816 * ptr table, or something in the interpreter structure
9820 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9827 /* look for it in the table first */
9828 ret = ptr_table_fetch(PL_ptr_table, v);
9832 /* see if it is part of the interpreter structure */
9833 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9834 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9842 /* duplicate the save stack */
9845 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9847 ANY * const ss = proto_perl->Tsavestack;
9848 const I32 max = proto_perl->Tsavestack_max;
9849 I32 ix = proto_perl->Tsavestack_ix;
9861 void (*dptr) (void*);
9862 void (*dxptr) (pTHX_ void*);
9864 Newxz(nss, max, ANY);
9867 I32 i = POPINT(ss,ix);
9870 case SAVEt_ITEM: /* normal string */
9871 sv = (SV*)POPPTR(ss,ix);
9872 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9873 sv = (SV*)POPPTR(ss,ix);
9874 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9876 case SAVEt_SV: /* scalar reference */
9877 sv = (SV*)POPPTR(ss,ix);
9878 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9879 gv = (GV*)POPPTR(ss,ix);
9880 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9882 case SAVEt_GENERIC_PVREF: /* generic char* */
9883 c = (char*)POPPTR(ss,ix);
9884 TOPPTR(nss,ix) = pv_dup(c);
9885 ptr = POPPTR(ss,ix);
9886 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9888 case SAVEt_SHARED_PVREF: /* char* in shared space */
9889 c = (char*)POPPTR(ss,ix);
9890 TOPPTR(nss,ix) = savesharedpv(c);
9891 ptr = POPPTR(ss,ix);
9892 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9894 case SAVEt_GENERIC_SVREF: /* generic sv */
9895 case SAVEt_SVREF: /* scalar reference */
9896 sv = (SV*)POPPTR(ss,ix);
9897 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9898 ptr = POPPTR(ss,ix);
9899 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9901 case SAVEt_AV: /* array reference */
9902 av = (AV*)POPPTR(ss,ix);
9903 TOPPTR(nss,ix) = av_dup_inc(av, param);
9904 gv = (GV*)POPPTR(ss,ix);
9905 TOPPTR(nss,ix) = gv_dup(gv, param);
9907 case SAVEt_HV: /* hash reference */
9908 hv = (HV*)POPPTR(ss,ix);
9909 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9910 gv = (GV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = gv_dup(gv, param);
9913 case SAVEt_INT: /* int reference */
9914 ptr = POPPTR(ss,ix);
9915 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9916 intval = (int)POPINT(ss,ix);
9917 TOPINT(nss,ix) = intval;
9919 case SAVEt_LONG: /* long reference */
9920 ptr = POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9922 longval = (long)POPLONG(ss,ix);
9923 TOPLONG(nss,ix) = longval;
9925 case SAVEt_I32: /* I32 reference */
9926 case SAVEt_I16: /* I16 reference */
9927 case SAVEt_I8: /* I8 reference */
9928 ptr = POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9933 case SAVEt_IV: /* IV reference */
9934 ptr = POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9939 case SAVEt_SPTR: /* SV* reference */
9940 ptr = POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9942 sv = (SV*)POPPTR(ss,ix);
9943 TOPPTR(nss,ix) = sv_dup(sv, param);
9945 case SAVEt_VPTR: /* random* reference */
9946 ptr = POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9948 ptr = POPPTR(ss,ix);
9949 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9951 case SAVEt_PPTR: /* char* reference */
9952 ptr = POPPTR(ss,ix);
9953 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9954 c = (char*)POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = pv_dup(c);
9957 case SAVEt_HPTR: /* HV* reference */
9958 ptr = POPPTR(ss,ix);
9959 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9960 hv = (HV*)POPPTR(ss,ix);
9961 TOPPTR(nss,ix) = hv_dup(hv, param);
9963 case SAVEt_APTR: /* AV* reference */
9964 ptr = POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9966 av = (AV*)POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = av_dup(av, param);
9970 gv = (GV*)POPPTR(ss,ix);
9971 TOPPTR(nss,ix) = gv_dup(gv, param);
9973 case SAVEt_GP: /* scalar reference */
9974 gp = (GP*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9976 (void)GpREFCNT_inc(gp);
9977 gv = (GV*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9979 c = (char*)POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = pv_dup(c);
9987 case SAVEt_MORTALIZESV:
9988 sv = (SV*)POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9992 ptr = POPPTR(ss,ix);
9993 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9994 /* these are assumed to be refcounted properly */
9996 switch (((OP*)ptr)->op_type) {
10002 case OP_LEAVEWRITE:
10003 TOPPTR(nss,ix) = ptr;
10008 TOPPTR(nss,ix) = Nullop;
10013 TOPPTR(nss,ix) = Nullop;
10016 c = (char*)POPPTR(ss,ix);
10017 TOPPTR(nss,ix) = pv_dup_inc(c);
10019 case SAVEt_CLEARSV:
10020 longval = POPLONG(ss,ix);
10021 TOPLONG(nss,ix) = longval;
10024 hv = (HV*)POPPTR(ss,ix);
10025 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10026 c = (char*)POPPTR(ss,ix);
10027 TOPPTR(nss,ix) = pv_dup_inc(c);
10029 TOPINT(nss,ix) = i;
10031 case SAVEt_DESTRUCTOR:
10032 ptr = POPPTR(ss,ix);
10033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10034 dptr = POPDPTR(ss,ix);
10035 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10036 any_dup(FPTR2DPTR(void *, dptr),
10039 case SAVEt_DESTRUCTOR_X:
10040 ptr = POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10042 dxptr = POPDXPTR(ss,ix);
10043 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10044 any_dup(FPTR2DPTR(void *, dxptr),
10047 case SAVEt_REGCONTEXT:
10050 TOPINT(nss,ix) = i;
10053 case SAVEt_STACK_POS: /* Position on Perl stack */
10055 TOPINT(nss,ix) = i;
10057 case SAVEt_AELEM: /* array element */
10058 sv = (SV*)POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10061 TOPINT(nss,ix) = i;
10062 av = (AV*)POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = av_dup_inc(av, param);
10065 case SAVEt_HELEM: /* hash element */
10066 sv = (SV*)POPPTR(ss,ix);
10067 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10068 sv = (SV*)POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10070 hv = (HV*)POPPTR(ss,ix);
10071 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10074 ptr = POPPTR(ss,ix);
10075 TOPPTR(nss,ix) = ptr;
10079 TOPINT(nss,ix) = i;
10081 case SAVEt_COMPPAD:
10082 av = (AV*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = av_dup(av, param);
10086 longval = (long)POPLONG(ss,ix);
10087 TOPLONG(nss,ix) = longval;
10088 ptr = POPPTR(ss,ix);
10089 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10090 sv = (SV*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = sv_dup(sv, param);
10094 ptr = POPPTR(ss,ix);
10095 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10096 longval = (long)POPBOOL(ss,ix);
10097 TOPBOOL(nss,ix) = (bool)longval;
10099 case SAVEt_SET_SVFLAGS:
10101 TOPINT(nss,ix) = i;
10103 TOPINT(nss,ix) = i;
10104 sv = (SV*)POPPTR(ss,ix);
10105 TOPPTR(nss,ix) = sv_dup(sv, param);
10108 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10116 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10117 * flag to the result. This is done for each stash before cloning starts,
10118 * so we know which stashes want their objects cloned */
10121 do_mark_cloneable_stash(pTHX_ SV *sv)
10123 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10125 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10126 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10127 if (cloner && GvCV(cloner)) {
10134 XPUSHs(sv_2mortal(newSVhek(hvname)));
10136 call_sv((SV*)GvCV(cloner), G_SCALAR);
10143 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10151 =for apidoc perl_clone
10153 Create and return a new interpreter by cloning the current one.
10155 perl_clone takes these flags as parameters:
10157 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10158 without it we only clone the data and zero the stacks,
10159 with it we copy the stacks and the new perl interpreter is
10160 ready to run at the exact same point as the previous one.
10161 The pseudo-fork code uses COPY_STACKS while the
10162 threads->new doesn't.
10164 CLONEf_KEEP_PTR_TABLE
10165 perl_clone keeps a ptr_table with the pointer of the old
10166 variable as a key and the new variable as a value,
10167 this allows it to check if something has been cloned and not
10168 clone it again but rather just use the value and increase the
10169 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10170 the ptr_table using the function
10171 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10172 reason to keep it around is if you want to dup some of your own
10173 variable who are outside the graph perl scans, example of this
10174 code is in threads.xs create
10177 This is a win32 thing, it is ignored on unix, it tells perls
10178 win32host code (which is c++) to clone itself, this is needed on
10179 win32 if you want to run two threads at the same time,
10180 if you just want to do some stuff in a separate perl interpreter
10181 and then throw it away and return to the original one,
10182 you don't need to do anything.
10187 /* XXX the above needs expanding by someone who actually understands it ! */
10188 EXTERN_C PerlInterpreter *
10189 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10192 perl_clone(PerlInterpreter *proto_perl, UV flags)
10195 #ifdef PERL_IMPLICIT_SYS
10197 /* perlhost.h so we need to call into it
10198 to clone the host, CPerlHost should have a c interface, sky */
10200 if (flags & CLONEf_CLONE_HOST) {
10201 return perl_clone_host(proto_perl,flags);
10203 return perl_clone_using(proto_perl, flags,
10205 proto_perl->IMemShared,
10206 proto_perl->IMemParse,
10208 proto_perl->IStdIO,
10212 proto_perl->IProc);
10216 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10217 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10218 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10219 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10220 struct IPerlDir* ipD, struct IPerlSock* ipS,
10221 struct IPerlProc* ipP)
10223 /* XXX many of the string copies here can be optimized if they're
10224 * constants; they need to be allocated as common memory and just
10225 * their pointers copied. */
10228 CLONE_PARAMS clone_params;
10229 CLONE_PARAMS* param = &clone_params;
10231 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10232 /* for each stash, determine whether its objects should be cloned */
10233 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10234 PERL_SET_THX(my_perl);
10237 Poison(my_perl, 1, PerlInterpreter);
10239 PL_curcop = (COP *)Nullop;
10243 PL_savestack_ix = 0;
10244 PL_savestack_max = -1;
10245 PL_sig_pending = 0;
10246 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10247 # else /* !DEBUGGING */
10248 Zero(my_perl, 1, PerlInterpreter);
10249 # endif /* DEBUGGING */
10251 /* host pointers */
10253 PL_MemShared = ipMS;
10254 PL_MemParse = ipMP;
10261 #else /* !PERL_IMPLICIT_SYS */
10263 CLONE_PARAMS clone_params;
10264 CLONE_PARAMS* param = &clone_params;
10265 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10266 /* for each stash, determine whether its objects should be cloned */
10267 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10268 PERL_SET_THX(my_perl);
10271 Poison(my_perl, 1, PerlInterpreter);
10273 PL_curcop = (COP *)Nullop;
10277 PL_savestack_ix = 0;
10278 PL_savestack_max = -1;
10279 PL_sig_pending = 0;
10280 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10281 # else /* !DEBUGGING */
10282 Zero(my_perl, 1, PerlInterpreter);
10283 # endif /* DEBUGGING */
10284 #endif /* PERL_IMPLICIT_SYS */
10285 param->flags = flags;
10286 param->proto_perl = proto_perl;
10288 PL_body_arenas = NULL;
10289 Zero(&PL_body_roots, 1, PL_body_roots);
10291 PL_nice_chunk = NULL;
10292 PL_nice_chunk_size = 0;
10294 PL_sv_objcount = 0;
10295 PL_sv_root = Nullsv;
10296 PL_sv_arenaroot = Nullsv;
10298 PL_debug = proto_perl->Idebug;
10300 PL_hash_seed = proto_perl->Ihash_seed;
10301 PL_rehash_seed = proto_perl->Irehash_seed;
10303 #ifdef USE_REENTRANT_API
10304 /* XXX: things like -Dm will segfault here in perlio, but doing
10305 * PERL_SET_CONTEXT(proto_perl);
10306 * breaks too many other things
10308 Perl_reentrant_init(aTHX);
10311 /* create SV map for pointer relocation */
10312 PL_ptr_table = ptr_table_new();
10314 /* initialize these special pointers as early as possible */
10315 SvANY(&PL_sv_undef) = NULL;
10316 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10317 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10318 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10320 SvANY(&PL_sv_no) = new_XPVNV();
10321 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10322 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10323 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10324 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10325 SvCUR_set(&PL_sv_no, 0);
10326 SvLEN_set(&PL_sv_no, 1);
10327 SvIV_set(&PL_sv_no, 0);
10328 SvNV_set(&PL_sv_no, 0);
10329 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10331 SvANY(&PL_sv_yes) = new_XPVNV();
10332 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10333 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10334 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10335 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10336 SvCUR_set(&PL_sv_yes, 1);
10337 SvLEN_set(&PL_sv_yes, 2);
10338 SvIV_set(&PL_sv_yes, 1);
10339 SvNV_set(&PL_sv_yes, 1);
10340 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10342 /* create (a non-shared!) shared string table */
10343 PL_strtab = newHV();
10344 HvSHAREKEYS_off(PL_strtab);
10345 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10346 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10348 PL_compiling = proto_perl->Icompiling;
10350 /* These two PVs will be free'd special way so must set them same way op.c does */
10351 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10352 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10354 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10355 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10357 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10358 if (!specialWARN(PL_compiling.cop_warnings))
10359 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10360 if (!specialCopIO(PL_compiling.cop_io))
10361 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10362 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10364 /* pseudo environmental stuff */
10365 PL_origargc = proto_perl->Iorigargc;
10366 PL_origargv = proto_perl->Iorigargv;
10368 param->stashes = newAV(); /* Setup array of objects to call clone on */
10370 /* Set tainting stuff before PerlIO_debug can possibly get called */
10371 PL_tainting = proto_perl->Itainting;
10372 PL_taint_warn = proto_perl->Itaint_warn;
10374 #ifdef PERLIO_LAYERS
10375 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10376 PerlIO_clone(aTHX_ proto_perl, param);
10379 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10380 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10381 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10382 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10383 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10384 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10387 PL_minus_c = proto_perl->Iminus_c;
10388 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10389 PL_localpatches = proto_perl->Ilocalpatches;
10390 PL_splitstr = proto_perl->Isplitstr;
10391 PL_preprocess = proto_perl->Ipreprocess;
10392 PL_minus_n = proto_perl->Iminus_n;
10393 PL_minus_p = proto_perl->Iminus_p;
10394 PL_minus_l = proto_perl->Iminus_l;
10395 PL_minus_a = proto_perl->Iminus_a;
10396 PL_minus_E = proto_perl->Iminus_E;
10397 PL_minus_F = proto_perl->Iminus_F;
10398 PL_doswitches = proto_perl->Idoswitches;
10399 PL_dowarn = proto_perl->Idowarn;
10400 PL_doextract = proto_perl->Idoextract;
10401 PL_sawampersand = proto_perl->Isawampersand;
10402 PL_unsafe = proto_perl->Iunsafe;
10403 PL_inplace = SAVEPV(proto_perl->Iinplace);
10404 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10405 PL_perldb = proto_perl->Iperldb;
10406 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10407 PL_exit_flags = proto_perl->Iexit_flags;
10409 /* magical thingies */
10410 /* XXX time(&PL_basetime) when asked for? */
10411 PL_basetime = proto_perl->Ibasetime;
10412 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10414 PL_maxsysfd = proto_perl->Imaxsysfd;
10415 PL_multiline = proto_perl->Imultiline;
10416 PL_statusvalue = proto_perl->Istatusvalue;
10418 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10420 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10422 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10424 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10425 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10426 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10428 /* Clone the regex array */
10429 PL_regex_padav = newAV();
10431 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10432 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10434 av_push(PL_regex_padav,
10435 sv_dup_inc(regexen[0],param));
10436 for(i = 1; i <= len; i++) {
10437 const SV * const regex = regexen[i];
10440 ? sv_dup_inc(regex, param)
10442 newSViv(PTR2IV(re_dup(
10443 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10445 av_push(PL_regex_padav, sv);
10448 PL_regex_pad = AvARRAY(PL_regex_padav);
10450 /* shortcuts to various I/O objects */
10451 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10452 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10453 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10454 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10455 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10456 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10458 /* shortcuts to regexp stuff */
10459 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10461 /* shortcuts to misc objects */
10462 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10464 /* shortcuts to debugging objects */
10465 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10466 PL_DBline = gv_dup(proto_perl->IDBline, param);
10467 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10468 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10469 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10470 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10471 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10472 PL_lineary = av_dup(proto_perl->Ilineary, param);
10473 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10475 /* symbol tables */
10476 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10477 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10478 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10479 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10480 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10482 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10483 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10484 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10485 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10486 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10487 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10489 PL_sub_generation = proto_perl->Isub_generation;
10491 /* funky return mechanisms */
10492 PL_forkprocess = proto_perl->Iforkprocess;
10494 /* subprocess state */
10495 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10497 /* internal state */
10498 PL_maxo = proto_perl->Imaxo;
10499 if (proto_perl->Iop_mask)
10500 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10502 PL_op_mask = Nullch;
10503 /* PL_asserting = proto_perl->Iasserting; */
10505 /* current interpreter roots */
10506 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10507 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10508 PL_main_start = proto_perl->Imain_start;
10509 PL_eval_root = proto_perl->Ieval_root;
10510 PL_eval_start = proto_perl->Ieval_start;
10512 /* runtime control stuff */
10513 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10514 PL_copline = proto_perl->Icopline;
10516 PL_filemode = proto_perl->Ifilemode;
10517 PL_lastfd = proto_perl->Ilastfd;
10518 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10521 PL_gensym = proto_perl->Igensym;
10522 PL_preambled = proto_perl->Ipreambled;
10523 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10524 PL_laststatval = proto_perl->Ilaststatval;
10525 PL_laststype = proto_perl->Ilaststype;
10526 PL_mess_sv = Nullsv;
10528 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10530 /* interpreter atexit processing */
10531 PL_exitlistlen = proto_perl->Iexitlistlen;
10532 if (PL_exitlistlen) {
10533 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10534 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10537 PL_exitlist = (PerlExitListEntry*)NULL;
10539 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10540 if (PL_my_cxt_size) {
10541 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10542 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10545 PL_my_cxt_list = (void**)NULL;
10546 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10547 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10548 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10550 PL_profiledata = NULL;
10551 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10552 /* PL_rsfp_filters entries have fake IoDIRP() */
10553 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10555 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10557 PAD_CLONE_VARS(proto_perl, param);
10559 #ifdef HAVE_INTERP_INTERN
10560 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10563 /* more statics moved here */
10564 PL_generation = proto_perl->Igeneration;
10565 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10567 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10568 PL_in_clean_all = proto_perl->Iin_clean_all;
10570 PL_uid = proto_perl->Iuid;
10571 PL_euid = proto_perl->Ieuid;
10572 PL_gid = proto_perl->Igid;
10573 PL_egid = proto_perl->Iegid;
10574 PL_nomemok = proto_perl->Inomemok;
10575 PL_an = proto_perl->Ian;
10576 PL_evalseq = proto_perl->Ievalseq;
10577 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10578 PL_origalen = proto_perl->Iorigalen;
10579 #ifdef PERL_USES_PL_PIDSTATUS
10580 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10582 PL_osname = SAVEPV(proto_perl->Iosname);
10583 PL_sighandlerp = proto_perl->Isighandlerp;
10585 PL_runops = proto_perl->Irunops;
10587 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10590 PL_cshlen = proto_perl->Icshlen;
10591 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10594 PL_lex_state = proto_perl->Ilex_state;
10595 PL_lex_defer = proto_perl->Ilex_defer;
10596 PL_lex_expect = proto_perl->Ilex_expect;
10597 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10598 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10599 PL_lex_starts = proto_perl->Ilex_starts;
10600 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10601 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10602 PL_lex_op = proto_perl->Ilex_op;
10603 PL_lex_inpat = proto_perl->Ilex_inpat;
10604 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10605 PL_lex_brackets = proto_perl->Ilex_brackets;
10606 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10607 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10608 PL_lex_casemods = proto_perl->Ilex_casemods;
10609 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10610 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10612 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10613 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10614 PL_nexttoke = proto_perl->Inexttoke;
10616 /* XXX This is probably masking the deeper issue of why
10617 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10618 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10619 * (A little debugging with a watchpoint on it may help.)
10621 if (SvANY(proto_perl->Ilinestr)) {
10622 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10623 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10624 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10625 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10626 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10627 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10628 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10629 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10630 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10633 PL_linestr = newSV(79);
10634 sv_upgrade(PL_linestr,SVt_PVIV);
10635 sv_setpvn(PL_linestr,"",0);
10636 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10638 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10639 PL_pending_ident = proto_perl->Ipending_ident;
10640 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10642 PL_expect = proto_perl->Iexpect;
10644 PL_multi_start = proto_perl->Imulti_start;
10645 PL_multi_end = proto_perl->Imulti_end;
10646 PL_multi_open = proto_perl->Imulti_open;
10647 PL_multi_close = proto_perl->Imulti_close;
10649 PL_error_count = proto_perl->Ierror_count;
10650 PL_subline = proto_perl->Isubline;
10651 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10653 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10654 if (SvANY(proto_perl->Ilinestr)) {
10655 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10656 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10657 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10658 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10659 PL_last_lop_op = proto_perl->Ilast_lop_op;
10662 PL_last_uni = SvPVX(PL_linestr);
10663 PL_last_lop = SvPVX(PL_linestr);
10664 PL_last_lop_op = 0;
10666 PL_in_my = proto_perl->Iin_my;
10667 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10669 PL_cryptseen = proto_perl->Icryptseen;
10672 PL_hints = proto_perl->Ihints;
10674 PL_amagic_generation = proto_perl->Iamagic_generation;
10676 #ifdef USE_LOCALE_COLLATE
10677 PL_collation_ix = proto_perl->Icollation_ix;
10678 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10679 PL_collation_standard = proto_perl->Icollation_standard;
10680 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10681 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10682 #endif /* USE_LOCALE_COLLATE */
10684 #ifdef USE_LOCALE_NUMERIC
10685 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10686 PL_numeric_standard = proto_perl->Inumeric_standard;
10687 PL_numeric_local = proto_perl->Inumeric_local;
10688 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10689 #endif /* !USE_LOCALE_NUMERIC */
10691 /* utf8 character classes */
10692 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10693 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10694 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10695 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10696 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10697 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10698 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10699 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10700 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10701 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10702 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10703 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10704 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10705 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10706 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10707 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10708 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10709 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10710 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10711 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10713 /* Did the locale setup indicate UTF-8? */
10714 PL_utf8locale = proto_perl->Iutf8locale;
10715 /* Unicode features (see perlrun/-C) */
10716 PL_unicode = proto_perl->Iunicode;
10718 /* Pre-5.8 signals control */
10719 PL_signals = proto_perl->Isignals;
10721 /* times() ticks per second */
10722 PL_clocktick = proto_perl->Iclocktick;
10724 /* Recursion stopper for PerlIO_find_layer */
10725 PL_in_load_module = proto_perl->Iin_load_module;
10727 /* sort() routine */
10728 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10730 /* Not really needed/useful since the reenrant_retint is "volatile",
10731 * but do it for consistency's sake. */
10732 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10734 /* Hooks to shared SVs and locks. */
10735 PL_sharehook = proto_perl->Isharehook;
10736 PL_lockhook = proto_perl->Ilockhook;
10737 PL_unlockhook = proto_perl->Iunlockhook;
10738 PL_threadhook = proto_perl->Ithreadhook;
10740 PL_runops_std = proto_perl->Irunops_std;
10741 PL_runops_dbg = proto_perl->Irunops_dbg;
10743 #ifdef THREADS_HAVE_PIDS
10744 PL_ppid = proto_perl->Ippid;
10748 PL_last_swash_hv = NULL; /* reinits on demand */
10749 PL_last_swash_klen = 0;
10750 PL_last_swash_key[0]= '\0';
10751 PL_last_swash_tmps = (U8*)NULL;
10752 PL_last_swash_slen = 0;
10754 PL_glob_index = proto_perl->Iglob_index;
10755 PL_srand_called = proto_perl->Isrand_called;
10756 PL_uudmap['M'] = 0; /* reinits on demand */
10757 PL_bitcount = Nullch; /* reinits on demand */
10759 if (proto_perl->Ipsig_pend) {
10760 Newxz(PL_psig_pend, SIG_SIZE, int);
10763 PL_psig_pend = (int*)NULL;
10766 if (proto_perl->Ipsig_ptr) {
10767 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10768 Newxz(PL_psig_name, SIG_SIZE, SV*);
10769 for (i = 1; i < SIG_SIZE; i++) {
10770 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10771 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10775 PL_psig_ptr = (SV**)NULL;
10776 PL_psig_name = (SV**)NULL;
10779 /* thrdvar.h stuff */
10781 if (flags & CLONEf_COPY_STACKS) {
10782 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10783 PL_tmps_ix = proto_perl->Ttmps_ix;
10784 PL_tmps_max = proto_perl->Ttmps_max;
10785 PL_tmps_floor = proto_perl->Ttmps_floor;
10786 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10788 while (i <= PL_tmps_ix) {
10789 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10793 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10794 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10795 Newxz(PL_markstack, i, I32);
10796 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10797 - proto_perl->Tmarkstack);
10798 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10799 - proto_perl->Tmarkstack);
10800 Copy(proto_perl->Tmarkstack, PL_markstack,
10801 PL_markstack_ptr - PL_markstack + 1, I32);
10803 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10804 * NOTE: unlike the others! */
10805 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10806 PL_scopestack_max = proto_perl->Tscopestack_max;
10807 Newxz(PL_scopestack, PL_scopestack_max, I32);
10808 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10810 /* NOTE: si_dup() looks at PL_markstack */
10811 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10813 /* PL_curstack = PL_curstackinfo->si_stack; */
10814 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10815 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10817 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10818 PL_stack_base = AvARRAY(PL_curstack);
10819 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10820 - proto_perl->Tstack_base);
10821 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10823 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10824 * NOTE: unlike the others! */
10825 PL_savestack_ix = proto_perl->Tsavestack_ix;
10826 PL_savestack_max = proto_perl->Tsavestack_max;
10827 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10828 PL_savestack = ss_dup(proto_perl, param);
10832 ENTER; /* perl_destruct() wants to LEAVE; */
10834 /* although we're not duplicating the tmps stack, we should still
10835 * add entries for any SVs on the tmps stack that got cloned by a
10836 * non-refcount means (eg a temp in @_); otherwise they will be
10839 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10840 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10841 proto_perl->Ttmps_stack[i]);
10842 if (nsv && !SvREFCNT(nsv)) {
10844 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10849 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10850 PL_top_env = &PL_start_env;
10852 PL_op = proto_perl->Top;
10855 PL_Xpv = (XPV*)NULL;
10856 PL_na = proto_perl->Tna;
10858 PL_statbuf = proto_perl->Tstatbuf;
10859 PL_statcache = proto_perl->Tstatcache;
10860 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10861 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10863 PL_timesbuf = proto_perl->Ttimesbuf;
10866 PL_tainted = proto_perl->Ttainted;
10867 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10868 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10869 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10870 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10871 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10872 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10873 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10874 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10875 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10877 PL_restartop = proto_perl->Trestartop;
10878 PL_in_eval = proto_perl->Tin_eval;
10879 PL_delaymagic = proto_perl->Tdelaymagic;
10880 PL_dirty = proto_perl->Tdirty;
10881 PL_localizing = proto_perl->Tlocalizing;
10883 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10884 PL_hv_fetch_ent_mh = Nullhe;
10885 PL_modcount = proto_perl->Tmodcount;
10886 PL_lastgotoprobe = Nullop;
10887 PL_dumpindent = proto_perl->Tdumpindent;
10889 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10890 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10891 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10892 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10893 PL_efloatbuf = Nullch; /* reinits on demand */
10894 PL_efloatsize = 0; /* reinits on demand */
10898 PL_screamfirst = NULL;
10899 PL_screamnext = NULL;
10900 PL_maxscream = -1; /* reinits on demand */
10901 PL_lastscream = Nullsv;
10903 PL_watchaddr = NULL;
10904 PL_watchok = Nullch;
10906 PL_regdummy = proto_perl->Tregdummy;
10907 PL_regprecomp = Nullch;
10910 PL_colorset = 0; /* reinits PL_colors[] */
10911 /*PL_colors[6] = {0,0,0,0,0,0};*/
10912 PL_reginput = Nullch;
10913 PL_regbol = Nullch;
10914 PL_regeol = Nullch;
10915 PL_regstartp = (I32*)NULL;
10916 PL_regendp = (I32*)NULL;
10917 PL_reglastparen = (U32*)NULL;
10918 PL_reglastcloseparen = (U32*)NULL;
10919 PL_regtill = Nullch;
10920 PL_reg_start_tmp = (char**)NULL;
10921 PL_reg_start_tmpl = 0;
10922 PL_regdata = (struct reg_data*)NULL;
10925 PL_reg_eval_set = 0;
10927 PL_regprogram = (regnode*)NULL;
10929 PL_regcc = (CURCUR*)NULL;
10930 PL_reg_call_cc = (struct re_cc_state*)NULL;
10931 PL_reg_re = (regexp*)NULL;
10932 PL_reg_ganch = Nullch;
10933 PL_reg_sv = Nullsv;
10934 PL_reg_match_utf8 = FALSE;
10935 PL_reg_magic = (MAGIC*)NULL;
10937 PL_reg_oldcurpm = (PMOP*)NULL;
10938 PL_reg_curpm = (PMOP*)NULL;
10939 PL_reg_oldsaved = Nullch;
10940 PL_reg_oldsavedlen = 0;
10941 #ifdef PERL_OLD_COPY_ON_WRITE
10944 PL_reg_maxiter = 0;
10945 PL_reg_leftiter = 0;
10946 PL_reg_poscache = Nullch;
10947 PL_reg_poscache_size= 0;
10949 /* RE engine - function pointers */
10950 PL_regcompp = proto_perl->Tregcompp;
10951 PL_regexecp = proto_perl->Tregexecp;
10952 PL_regint_start = proto_perl->Tregint_start;
10953 PL_regint_string = proto_perl->Tregint_string;
10954 PL_regfree = proto_perl->Tregfree;
10956 PL_reginterp_cnt = 0;
10957 PL_reg_starttry = 0;
10959 /* Pluggable optimizer */
10960 PL_peepp = proto_perl->Tpeepp;
10962 PL_stashcache = newHV();
10964 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10965 ptr_table_free(PL_ptr_table);
10966 PL_ptr_table = NULL;
10969 /* Call the ->CLONE method, if it exists, for each of the stashes
10970 identified by sv_dup() above.
10972 while(av_len(param->stashes) != -1) {
10973 HV* const stash = (HV*) av_shift(param->stashes);
10974 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10975 if (cloner && GvCV(cloner)) {
10980 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10982 call_sv((SV*)GvCV(cloner), G_DISCARD);
10988 SvREFCNT_dec(param->stashes);
10990 /* orphaned? eg threads->new inside BEGIN or use */
10991 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10992 (void)SvREFCNT_inc(PL_compcv);
10993 SAVEFREESV(PL_compcv);
10999 #endif /* USE_ITHREADS */
11002 =head1 Unicode Support
11004 =for apidoc sv_recode_to_utf8
11006 The encoding is assumed to be an Encode object, on entry the PV
11007 of the sv is assumed to be octets in that encoding, and the sv
11008 will be converted into Unicode (and UTF-8).
11010 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11011 is not a reference, nothing is done to the sv. If the encoding is not
11012 an C<Encode::XS> Encoding object, bad things will happen.
11013 (See F<lib/encoding.pm> and L<Encode>).
11015 The PV of the sv is returned.
11020 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11023 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11037 Passing sv_yes is wrong - it needs to be or'ed set of constants
11038 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11039 remove converted chars from source.
11041 Both will default the value - let them.
11043 XPUSHs(&PL_sv_yes);
11046 call_method("decode", G_SCALAR);
11050 s = SvPV_const(uni, len);
11051 if (s != SvPVX_const(sv)) {
11052 SvGROW(sv, len + 1);
11053 Move(s, SvPVX(sv), len + 1, char);
11054 SvCUR_set(sv, len);
11061 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11065 =for apidoc sv_cat_decode
11067 The encoding is assumed to be an Encode object, the PV of the ssv is
11068 assumed to be octets in that encoding and decoding the input starts
11069 from the position which (PV + *offset) pointed to. The dsv will be
11070 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11071 when the string tstr appears in decoding output or the input ends on
11072 the PV of the ssv. The value which the offset points will be modified
11073 to the last input position on the ssv.
11075 Returns TRUE if the terminator was found, else returns FALSE.
11080 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11081 SV *ssv, int *offset, char *tstr, int tlen)
11085 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11096 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11097 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11099 call_method("cat_decode", G_SCALAR);
11101 ret = SvTRUE(TOPs);
11102 *offset = SvIV(offsv);
11108 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11113 /* ---------------------------------------------------------------------
11115 * support functions for report_uninit()
11118 /* the maxiumum size of array or hash where we will scan looking
11119 * for the undefined element that triggered the warning */
11121 #define FUV_MAX_SEARCH_SIZE 1000
11123 /* Look for an entry in the hash whose value has the same SV as val;
11124 * If so, return a mortal copy of the key. */
11127 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11130 register HE **array;
11133 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11134 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11137 array = HvARRAY(hv);
11139 for (i=HvMAX(hv); i>0; i--) {
11140 register HE *entry;
11141 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11142 if (HeVAL(entry) != val)
11144 if ( HeVAL(entry) == &PL_sv_undef ||
11145 HeVAL(entry) == &PL_sv_placeholder)
11149 if (HeKLEN(entry) == HEf_SVKEY)
11150 return sv_mortalcopy(HeKEY_sv(entry));
11151 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11157 /* Look for an entry in the array whose value has the same SV as val;
11158 * If so, return the index, otherwise return -1. */
11161 S_find_array_subscript(pTHX_ AV *av, SV* val)
11166 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11167 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11171 for (i=AvFILLp(av); i>=0; i--) {
11172 if (svp[i] == val && svp[i] != &PL_sv_undef)
11178 /* S_varname(): return the name of a variable, optionally with a subscript.
11179 * If gv is non-zero, use the name of that global, along with gvtype (one
11180 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11181 * targ. Depending on the value of the subscript_type flag, return:
11184 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11185 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11186 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11187 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11190 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11191 SV* keyname, I32 aindex, int subscript_type)
11194 SV * const name = sv_newmortal();
11197 buffer[0] = gvtype;
11200 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11202 gv_fullname4(name, gv, buffer, 0);
11204 if ((unsigned int)SvPVX(name)[1] <= 26) {
11206 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11208 /* Swap the 1 unprintable control character for the 2 byte pretty
11209 version - ie substr($name, 1, 1) = $buffer; */
11210 sv_insert(name, 1, 1, buffer, 2);
11215 CV * const cv = find_runcv(&unused);
11219 if (!cv || !CvPADLIST(cv))
11221 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11222 sv = *av_fetch(av, targ, FALSE);
11223 /* SvLEN in a pad name is not to be trusted */
11224 sv_setpv(name, SvPV_nolen_const(sv));
11227 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11228 SV * const sv = newSV(0);
11229 *SvPVX(name) = '$';
11230 Perl_sv_catpvf(aTHX_ name, "{%s}",
11231 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11234 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11235 *SvPVX(name) = '$';
11236 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11238 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11239 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11246 =for apidoc find_uninit_var
11248 Find the name of the undefined variable (if any) that caused the operator o
11249 to issue a "Use of uninitialized value" warning.
11250 If match is true, only return a name if it's value matches uninit_sv.
11251 So roughly speaking, if a unary operator (such as OP_COS) generates a
11252 warning, then following the direct child of the op may yield an
11253 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11254 other hand, with OP_ADD there are two branches to follow, so we only print
11255 the variable name if we get an exact match.
11257 The name is returned as a mortal SV.
11259 Assumes that PL_op is the op that originally triggered the error, and that
11260 PL_comppad/PL_curpad points to the currently executing pad.
11266 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11274 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11275 uninit_sv == &PL_sv_placeholder)))
11278 switch (obase->op_type) {
11285 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11286 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11288 SV *keysv = Nullsv;
11289 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11291 if (pad) { /* @lex, %lex */
11292 sv = PAD_SVl(obase->op_targ);
11296 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11297 /* @global, %global */
11298 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11301 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11303 else /* @{expr}, %{expr} */
11304 return find_uninit_var(cUNOPx(obase)->op_first,
11308 /* attempt to find a match within the aggregate */
11310 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11312 subscript_type = FUV_SUBSCRIPT_HASH;
11315 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11317 subscript_type = FUV_SUBSCRIPT_ARRAY;
11320 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11323 return varname(gv, hash ? '%' : '@', obase->op_targ,
11324 keysv, index, subscript_type);
11328 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11330 return varname(Nullgv, '$', obase->op_targ,
11331 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11334 gv = cGVOPx_gv(obase);
11335 if (!gv || (match && GvSV(gv) != uninit_sv))
11337 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11340 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11343 av = (AV*)PAD_SV(obase->op_targ);
11344 if (!av || SvRMAGICAL(av))
11346 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11347 if (!svp || *svp != uninit_sv)
11350 return varname(Nullgv, '$', obase->op_targ,
11351 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11354 gv = cGVOPx_gv(obase);
11360 if (!av || SvRMAGICAL(av))
11362 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11363 if (!svp || *svp != uninit_sv)
11366 return varname(gv, '$', 0,
11367 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11372 o = cUNOPx(obase)->op_first;
11373 if (!o || o->op_type != OP_NULL ||
11374 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11376 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11380 if (PL_op == obase)
11381 /* $a[uninit_expr] or $h{uninit_expr} */
11382 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11385 o = cBINOPx(obase)->op_first;
11386 kid = cBINOPx(obase)->op_last;
11388 /* get the av or hv, and optionally the gv */
11390 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11391 sv = PAD_SV(o->op_targ);
11393 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11394 && cUNOPo->op_first->op_type == OP_GV)
11396 gv = cGVOPx_gv(cUNOPo->op_first);
11399 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11404 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11405 /* index is constant */
11409 if (obase->op_type == OP_HELEM) {
11410 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11411 if (!he || HeVAL(he) != uninit_sv)
11415 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11416 if (!svp || *svp != uninit_sv)
11420 if (obase->op_type == OP_HELEM)
11421 return varname(gv, '%', o->op_targ,
11422 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11424 return varname(gv, '@', o->op_targ, Nullsv,
11425 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11428 /* index is an expression;
11429 * attempt to find a match within the aggregate */
11430 if (obase->op_type == OP_HELEM) {
11431 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11433 return varname(gv, '%', o->op_targ,
11434 keysv, 0, FUV_SUBSCRIPT_HASH);
11437 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11439 return varname(gv, '@', o->op_targ,
11440 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11445 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11447 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11453 /* only examine RHS */
11454 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11457 o = cUNOPx(obase)->op_first;
11458 if (o->op_type == OP_PUSHMARK)
11461 if (!o->op_sibling) {
11462 /* one-arg version of open is highly magical */
11464 if (o->op_type == OP_GV) { /* open FOO; */
11466 if (match && GvSV(gv) != uninit_sv)
11468 return varname(gv, '$', 0,
11469 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11471 /* other possibilities not handled are:
11472 * open $x; or open my $x; should return '${*$x}'
11473 * open expr; should return '$'.expr ideally
11479 /* ops where $_ may be an implicit arg */
11483 if ( !(obase->op_flags & OPf_STACKED)) {
11484 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11485 ? PAD_SVl(obase->op_targ)
11488 sv = sv_newmortal();
11489 sv_setpvn(sv, "$_", 2);
11497 /* skip filehandle as it can't produce 'undef' warning */
11498 o = cUNOPx(obase)->op_first;
11499 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11500 o = o->op_sibling->op_sibling;
11507 match = 1; /* XS or custom code could trigger random warnings */
11512 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11513 return sv_2mortal(newSVpvs("${$/}"));
11518 if (!(obase->op_flags & OPf_KIDS))
11520 o = cUNOPx(obase)->op_first;
11526 /* if all except one arg are constant, or have no side-effects,
11527 * or are optimized away, then it's unambiguous */
11529 for (kid=o; kid; kid = kid->op_sibling) {
11531 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11532 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11533 || (kid->op_type == OP_PUSHMARK)
11537 if (o2) { /* more than one found */
11544 return find_uninit_var(o2, uninit_sv, match);
11546 /* scan all args */
11548 sv = find_uninit_var(o, uninit_sv, 1);
11560 =for apidoc report_uninit
11562 Print appropriate "Use of uninitialized variable" warning
11568 Perl_report_uninit(pTHX_ SV* uninit_sv)
11572 SV* varname = Nullsv;
11574 varname = find_uninit_var(PL_op, uninit_sv,0);
11576 sv_insert(varname, 0, 0, " ", 1);
11578 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11579 varname ? SvPV_nolen_const(varname) : "",
11580 " in ", OP_DESC(PL_op));
11583 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11589 * c-indentation-style: bsd
11590 * c-basic-offset: 4
11591 * indent-tabs-mode: t
11594 * ex: set ts=8 sts=4 sw=4 noet: