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)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void ** const arena_root = &PL_body_arenaroots[sv_type];
644 void ** const root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void ** const r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
813 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
819 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
835 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
841 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1127 * correct 0.0 for us. Otherwise, if the old body didn't have an
1128 * NV slot, but the new one does, then we need to initialise the
1129 * freshly created NV slot with whatever the correct bit pattern is
1131 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1135 if (new_type == SVt_PVIO)
1136 IoPAGE_LEN(sv) = 60;
1137 if (old_type < SVt_RV)
1141 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1144 if (old_type_details->size) {
1145 /* If the old body had an allocated size, then we need to free it. */
1147 my_safefree(old_body);
1149 del_body((void*)((char*)old_body + old_type_details->offset),
1150 &PL_body_roots[old_type]);
1156 =for apidoc sv_backoff
1158 Remove any string offset. You should normally use the C<SvOOK_off> macro
1165 Perl_sv_backoff(pTHX_ register SV *sv)
1168 assert(SvTYPE(sv) != SVt_PVHV);
1169 assert(SvTYPE(sv) != SVt_PVAV);
1171 const char * const s = SvPVX_const(sv);
1172 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1173 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1175 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1177 SvFLAGS(sv) &= ~SVf_OOK;
1184 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1185 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1186 Use the C<SvGROW> wrapper instead.
1192 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1196 #ifdef HAS_64K_LIMIT
1197 if (newlen >= 0x10000) {
1198 PerlIO_printf(Perl_debug_log,
1199 "Allocation too large: %"UVxf"\n", (UV)newlen);
1202 #endif /* HAS_64K_LIMIT */
1205 if (SvTYPE(sv) < SVt_PV) {
1206 sv_upgrade(sv, SVt_PV);
1207 s = SvPVX_mutable(sv);
1209 else if (SvOOK(sv)) { /* pv is offset? */
1211 s = SvPVX_mutable(sv);
1212 if (newlen > SvLEN(sv))
1213 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1214 #ifdef HAS_64K_LIMIT
1215 if (newlen >= 0x10000)
1220 s = SvPVX_mutable(sv);
1222 if (newlen > SvLEN(sv)) { /* need more room? */
1223 newlen = PERL_STRLEN_ROUNDUP(newlen);
1224 if (SvLEN(sv) && s) {
1226 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1232 s = saferealloc(s, newlen);
1235 s = safemalloc(newlen);
1236 if (SvPVX_const(sv) && SvCUR(sv)) {
1237 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1241 SvLEN_set(sv, newlen);
1247 =for apidoc sv_setiv
1249 Copies an integer into the given SV, upgrading first if necessary.
1250 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1256 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1258 SV_CHECK_THINKFIRST_COW_DROP(sv);
1259 switch (SvTYPE(sv)) {
1261 sv_upgrade(sv, SVt_IV);
1264 sv_upgrade(sv, SVt_PVNV);
1268 sv_upgrade(sv, SVt_PVIV);
1277 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1280 (void)SvIOK_only(sv); /* validate number */
1286 =for apidoc sv_setiv_mg
1288 Like C<sv_setiv>, but also handles 'set' magic.
1294 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1301 =for apidoc sv_setuv
1303 Copies an unsigned integer into the given SV, upgrading first if necessary.
1304 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1310 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1312 /* With these two if statements:
1313 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1316 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1318 If you wish to remove them, please benchmark to see what the effect is
1320 if (u <= (UV)IV_MAX) {
1321 sv_setiv(sv, (IV)u);
1330 =for apidoc sv_setuv_mg
1332 Like C<sv_setuv>, but also handles 'set' magic.
1338 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1347 =for apidoc sv_setnv
1349 Copies a double into the given SV, upgrading first if necessary.
1350 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1356 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1358 SV_CHECK_THINKFIRST_COW_DROP(sv);
1359 switch (SvTYPE(sv)) {
1362 sv_upgrade(sv, SVt_NV);
1367 sv_upgrade(sv, SVt_PVNV);
1376 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1380 (void)SvNOK_only(sv); /* validate number */
1385 =for apidoc sv_setnv_mg
1387 Like C<sv_setnv>, but also handles 'set' magic.
1393 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1399 /* Print an "isn't numeric" warning, using a cleaned-up,
1400 * printable version of the offending string
1404 S_not_a_number(pTHX_ SV *sv)
1411 dsv = sv_2mortal(newSVpvs(""));
1412 pv = sv_uni_display(dsv, sv, 10, 0);
1415 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1416 /* each *s can expand to 4 chars + "...\0",
1417 i.e. need room for 8 chars */
1419 const char *s = SvPVX_const(sv);
1420 const char * const end = s + SvCUR(sv);
1421 for ( ; s < end && d < limit; s++ ) {
1423 if (ch & 128 && !isPRINT_LC(ch)) {
1432 else if (ch == '\r') {
1436 else if (ch == '\f') {
1440 else if (ch == '\\') {
1444 else if (ch == '\0') {
1448 else if (isPRINT_LC(ch))
1465 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1466 "Argument \"%s\" isn't numeric in %s", pv,
1469 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1470 "Argument \"%s\" isn't numeric", pv);
1474 =for apidoc looks_like_number
1476 Test if the content of an SV looks like a number (or is a number).
1477 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1478 non-numeric warning), even if your atof() doesn't grok them.
1484 Perl_looks_like_number(pTHX_ SV *sv)
1486 register const char *sbegin;
1490 sbegin = SvPVX_const(sv);
1493 else if (SvPOKp(sv))
1494 sbegin = SvPV_const(sv, len);
1496 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1497 return grok_number(sbegin, len, NULL);
1500 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1501 until proven guilty, assume that things are not that bad... */
1506 As 64 bit platforms often have an NV that doesn't preserve all bits of
1507 an IV (an assumption perl has been based on to date) it becomes necessary
1508 to remove the assumption that the NV always carries enough precision to
1509 recreate the IV whenever needed, and that the NV is the canonical form.
1510 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1511 precision as a side effect of conversion (which would lead to insanity
1512 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1513 1) to distinguish between IV/UV/NV slots that have cached a valid
1514 conversion where precision was lost and IV/UV/NV slots that have a
1515 valid conversion which has lost no precision
1516 2) to ensure that if a numeric conversion to one form is requested that
1517 would lose precision, the precise conversion (or differently
1518 imprecise conversion) is also performed and cached, to prevent
1519 requests for different numeric formats on the same SV causing
1520 lossy conversion chains. (lossless conversion chains are perfectly
1525 SvIOKp is true if the IV slot contains a valid value
1526 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1527 SvNOKp is true if the NV slot contains a valid value
1528 SvNOK is true only if the NV value is accurate
1531 while converting from PV to NV, check to see if converting that NV to an
1532 IV(or UV) would lose accuracy over a direct conversion from PV to
1533 IV(or UV). If it would, cache both conversions, return NV, but mark
1534 SV as IOK NOKp (ie not NOK).
1536 While converting from PV to IV, check to see if converting that IV to an
1537 NV would lose accuracy over a direct conversion from PV to NV. If it
1538 would, cache both conversions, flag similarly.
1540 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1541 correctly because if IV & NV were set NV *always* overruled.
1542 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1543 changes - now IV and NV together means that the two are interchangeable:
1544 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1546 The benefit of this is that operations such as pp_add know that if
1547 SvIOK is true for both left and right operands, then integer addition
1548 can be used instead of floating point (for cases where the result won't
1549 overflow). Before, floating point was always used, which could lead to
1550 loss of precision compared with integer addition.
1552 * making IV and NV equal status should make maths accurate on 64 bit
1554 * may speed up maths somewhat if pp_add and friends start to use
1555 integers when possible instead of fp. (Hopefully the overhead in
1556 looking for SvIOK and checking for overflow will not outweigh the
1557 fp to integer speedup)
1558 * will slow down integer operations (callers of SvIV) on "inaccurate"
1559 values, as the change from SvIOK to SvIOKp will cause a call into
1560 sv_2iv each time rather than a macro access direct to the IV slot
1561 * should speed up number->string conversion on integers as IV is
1562 favoured when IV and NV are equally accurate
1564 ####################################################################
1565 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1566 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1567 On the other hand, SvUOK is true iff UV.
1568 ####################################################################
1570 Your mileage will vary depending your CPU's relative fp to integer
1574 #ifndef NV_PRESERVES_UV
1575 # define IS_NUMBER_UNDERFLOW_IV 1
1576 # define IS_NUMBER_UNDERFLOW_UV 2
1577 # define IS_NUMBER_IV_AND_UV 2
1578 # define IS_NUMBER_OVERFLOW_IV 4
1579 # define IS_NUMBER_OVERFLOW_UV 5
1581 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1583 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1585 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1587 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));
1588 if (SvNVX(sv) < (NV)IV_MIN) {
1589 (void)SvIOKp_on(sv);
1591 SvIV_set(sv, IV_MIN);
1592 return IS_NUMBER_UNDERFLOW_IV;
1594 if (SvNVX(sv) > (NV)UV_MAX) {
1595 (void)SvIOKp_on(sv);
1598 SvUV_set(sv, UV_MAX);
1599 return IS_NUMBER_OVERFLOW_UV;
1601 (void)SvIOKp_on(sv);
1603 /* Can't use strtol etc to convert this string. (See truth table in
1605 if (SvNVX(sv) <= (UV)IV_MAX) {
1606 SvIV_set(sv, I_V(SvNVX(sv)));
1607 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1608 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1610 /* Integer is imprecise. NOK, IOKp */
1612 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1615 SvUV_set(sv, U_V(SvNVX(sv)));
1616 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1617 if (SvUVX(sv) == UV_MAX) {
1618 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1619 possibly be preserved by NV. Hence, it must be overflow.
1621 return IS_NUMBER_OVERFLOW_UV;
1623 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1625 /* Integer is imprecise. NOK, IOKp */
1627 return IS_NUMBER_OVERFLOW_IV;
1629 #endif /* !NV_PRESERVES_UV*/
1632 S_sv_2iuv_common(pTHX_ SV *sv) {
1634 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1635 * without also getting a cached IV/UV from it at the same time
1636 * (ie PV->NV conversion should detect loss of accuracy and cache
1637 * IV or UV at same time to avoid this. */
1638 /* IV-over-UV optimisation - choose to cache IV if possible */
1640 if (SvTYPE(sv) == SVt_NV)
1641 sv_upgrade(sv, SVt_PVNV);
1643 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1644 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1645 certainly cast into the IV range at IV_MAX, whereas the correct
1646 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1648 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1649 SvIV_set(sv, I_V(SvNVX(sv)));
1650 if (SvNVX(sv) == (NV) SvIVX(sv)
1651 #ifndef NV_PRESERVES_UV
1652 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1653 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1654 /* Don't flag it as "accurately an integer" if the number
1655 came from a (by definition imprecise) NV operation, and
1656 we're outside the range of NV integer precision */
1659 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1660 DEBUG_c(PerlIO_printf(Perl_debug_log,
1661 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1667 /* IV not precise. No need to convert from PV, as NV
1668 conversion would already have cached IV if it detected
1669 that PV->IV would be better than PV->NV->IV
1670 flags already correct - don't set public IOK. */
1671 DEBUG_c(PerlIO_printf(Perl_debug_log,
1672 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1677 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1678 but the cast (NV)IV_MIN rounds to a the value less (more
1679 negative) than IV_MIN which happens to be equal to SvNVX ??
1680 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1681 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1682 (NV)UVX == NVX are both true, but the values differ. :-(
1683 Hopefully for 2s complement IV_MIN is something like
1684 0x8000000000000000 which will be exact. NWC */
1687 SvUV_set(sv, U_V(SvNVX(sv)));
1689 (SvNVX(sv) == (NV) SvUVX(sv))
1690 #ifndef NV_PRESERVES_UV
1691 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1692 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1693 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1694 /* Don't flag it as "accurately an integer" if the number
1695 came from a (by definition imprecise) NV operation, and
1696 we're outside the range of NV integer precision */
1701 DEBUG_c(PerlIO_printf(Perl_debug_log,
1702 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1708 else if (SvPOKp(sv) && SvLEN(sv)) {
1710 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1711 /* We want to avoid a possible problem when we cache an IV/ a UV which
1712 may be later translated to an NV, and the resulting NV is not
1713 the same as the direct translation of the initial string
1714 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1715 be careful to ensure that the value with the .456 is around if the
1716 NV value is requested in the future).
1718 This means that if we cache such an IV/a UV, we need to cache the
1719 NV as well. Moreover, we trade speed for space, and do not
1720 cache the NV if we are sure it's not needed.
1723 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1724 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1725 == IS_NUMBER_IN_UV) {
1726 /* It's definitely an integer, only upgrade to PVIV */
1727 if (SvTYPE(sv) < SVt_PVIV)
1728 sv_upgrade(sv, SVt_PVIV);
1730 } else if (SvTYPE(sv) < SVt_PVNV)
1731 sv_upgrade(sv, SVt_PVNV);
1733 /* If NVs preserve UVs then we only use the UV value if we know that
1734 we aren't going to call atof() below. If NVs don't preserve UVs
1735 then the value returned may have more precision than atof() will
1736 return, even though value isn't perfectly accurate. */
1737 if ((numtype & (IS_NUMBER_IN_UV
1738 #ifdef NV_PRESERVES_UV
1741 )) == IS_NUMBER_IN_UV) {
1742 /* This won't turn off the public IOK flag if it was set above */
1743 (void)SvIOKp_on(sv);
1745 if (!(numtype & IS_NUMBER_NEG)) {
1747 if (value <= (UV)IV_MAX) {
1748 SvIV_set(sv, (IV)value);
1750 /* it didn't overflow, and it was positive. */
1751 SvUV_set(sv, value);
1755 /* 2s complement assumption */
1756 if (value <= (UV)IV_MIN) {
1757 SvIV_set(sv, -(IV)value);
1759 /* Too negative for an IV. This is a double upgrade, but
1760 I'm assuming it will be rare. */
1761 if (SvTYPE(sv) < SVt_PVNV)
1762 sv_upgrade(sv, SVt_PVNV);
1766 SvNV_set(sv, -(NV)value);
1767 SvIV_set(sv, IV_MIN);
1771 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1772 will be in the previous block to set the IV slot, and the next
1773 block to set the NV slot. So no else here. */
1775 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1776 != IS_NUMBER_IN_UV) {
1777 /* It wasn't an (integer that doesn't overflow the UV). */
1778 SvNV_set(sv, Atof(SvPVX_const(sv)));
1780 if (! numtype && ckWARN(WARN_NUMERIC))
1783 #if defined(USE_LONG_DOUBLE)
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1787 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1788 PTR2UV(sv), SvNVX(sv)));
1791 #ifdef NV_PRESERVES_UV
1792 (void)SvIOKp_on(sv);
1794 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1795 SvIV_set(sv, I_V(SvNVX(sv)));
1796 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1799 /* Integer is imprecise. NOK, IOKp */
1801 /* UV will not work better than IV */
1803 if (SvNVX(sv) > (NV)UV_MAX) {
1805 /* Integer is inaccurate. NOK, IOKp, is UV */
1806 SvUV_set(sv, UV_MAX);
1808 SvUV_set(sv, U_V(SvNVX(sv)));
1809 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1810 NV preservse UV so can do correct comparison. */
1811 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1814 /* Integer is imprecise. NOK, IOKp, is UV */
1819 #else /* NV_PRESERVES_UV */
1820 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1821 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1822 /* The IV/UV slot will have been set from value returned by
1823 grok_number above. The NV slot has just been set using
1826 assert (SvIOKp(sv));
1828 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1829 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1830 /* Small enough to preserve all bits. */
1831 (void)SvIOKp_on(sv);
1833 SvIV_set(sv, I_V(SvNVX(sv)));
1834 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1836 /* Assumption: first non-preserved integer is < IV_MAX,
1837 this NV is in the preserved range, therefore: */
1838 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1840 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);
1844 0 0 already failed to read UV.
1845 0 1 already failed to read UV.
1846 1 0 you won't get here in this case. IV/UV
1847 slot set, public IOK, Atof() unneeded.
1848 1 1 already read UV.
1849 so there's no point in sv_2iuv_non_preserve() attempting
1850 to use atol, strtol, strtoul etc. */
1851 sv_2iuv_non_preserve (sv, numtype);
1854 #endif /* NV_PRESERVES_UV */
1858 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1859 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1862 if (SvTYPE(sv) < SVt_IV)
1863 /* Typically the caller expects that sv_any is not NULL now. */
1864 sv_upgrade(sv, SVt_IV);
1865 /* Return 0 from the caller. */
1872 =for apidoc sv_2iv_flags
1874 Return the integer value of an SV, doing any necessary string
1875 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1876 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1882 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1886 if (SvGMAGICAL(sv)) {
1887 if (flags & SV_GMAGIC)
1892 return I_V(SvNVX(sv));
1894 if (SvPOKp(sv) && SvLEN(sv)) {
1897 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1899 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1900 == IS_NUMBER_IN_UV) {
1901 /* It's definitely an integer */
1902 if (numtype & IS_NUMBER_NEG) {
1903 if (value < (UV)IV_MIN)
1906 if (value < (UV)IV_MAX)
1911 if (ckWARN(WARN_NUMERIC))
1914 return I_V(Atof(SvPVX_const(sv)));
1919 assert(SvTYPE(sv) >= SVt_PVMG);
1920 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1921 } else if (SvTHINKFIRST(sv)) {
1925 SV * const tmpstr=AMG_CALLun(sv,numer);
1926 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1927 return SvIV(tmpstr);
1930 return PTR2IV(SvRV(sv));
1933 sv_force_normal_flags(sv, 0);
1935 if (SvREADONLY(sv) && !SvOK(sv)) {
1936 if (ckWARN(WARN_UNINITIALIZED))
1942 if (S_sv_2iuv_common(aTHX_ sv))
1945 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1946 PTR2UV(sv),SvIVX(sv)));
1947 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1951 =for apidoc sv_2uv_flags
1953 Return the unsigned integer value of an SV, doing any necessary string
1954 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1955 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1961 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1965 if (SvGMAGICAL(sv)) {
1966 if (flags & SV_GMAGIC)
1971 return U_V(SvNVX(sv));
1972 if (SvPOKp(sv) && SvLEN(sv)) {
1975 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1977 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1978 == IS_NUMBER_IN_UV) {
1979 /* It's definitely an integer */
1980 if (!(numtype & IS_NUMBER_NEG))
1984 if (ckWARN(WARN_NUMERIC))
1987 return U_V(Atof(SvPVX_const(sv)));
1992 assert(SvTYPE(sv) >= SVt_PVMG);
1993 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1994 } else if (SvTHINKFIRST(sv)) {
1998 SV *const tmpstr = AMG_CALLun(sv,numer);
1999 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2000 return SvUV(tmpstr);
2003 return PTR2UV(SvRV(sv));
2006 sv_force_normal_flags(sv, 0);
2008 if (SvREADONLY(sv) && !SvOK(sv)) {
2009 if (ckWARN(WARN_UNINITIALIZED))
2015 if (S_sv_2iuv_common(aTHX_ sv))
2019 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2020 PTR2UV(sv),SvUVX(sv)));
2021 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2027 Return the num value of an SV, doing any necessary string or integer
2028 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2035 Perl_sv_2nv(pTHX_ register SV *sv)
2039 if (SvGMAGICAL(sv)) {
2043 if (SvPOKp(sv) && SvLEN(sv)) {
2044 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2045 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2047 return Atof(SvPVX_const(sv));
2051 return (NV)SvUVX(sv);
2053 return (NV)SvIVX(sv);
2058 assert(SvTYPE(sv) >= SVt_PVMG);
2059 /* This falls through to the report_uninit near the end of the
2061 } else if (SvTHINKFIRST(sv)) {
2065 SV *const tmpstr = AMG_CALLun(sv,numer);
2066 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2067 return SvNV(tmpstr);
2070 return PTR2NV(SvRV(sv));
2073 sv_force_normal_flags(sv, 0);
2075 if (SvREADONLY(sv) && !SvOK(sv)) {
2076 if (ckWARN(WARN_UNINITIALIZED))
2081 if (SvTYPE(sv) < SVt_NV) {
2082 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2083 sv_upgrade(sv, SVt_NV);
2084 #ifdef USE_LONG_DOUBLE
2086 STORE_NUMERIC_LOCAL_SET_STANDARD();
2087 PerlIO_printf(Perl_debug_log,
2088 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2089 PTR2UV(sv), SvNVX(sv));
2090 RESTORE_NUMERIC_LOCAL();
2094 STORE_NUMERIC_LOCAL_SET_STANDARD();
2095 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2096 PTR2UV(sv), SvNVX(sv));
2097 RESTORE_NUMERIC_LOCAL();
2101 else if (SvTYPE(sv) < SVt_PVNV)
2102 sv_upgrade(sv, SVt_PVNV);
2107 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2108 #ifdef NV_PRESERVES_UV
2111 /* Only set the public NV OK flag if this NV preserves the IV */
2112 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2113 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2114 : (SvIVX(sv) == I_V(SvNVX(sv))))
2120 else if (SvPOKp(sv) && SvLEN(sv)) {
2122 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2123 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2125 #ifdef NV_PRESERVES_UV
2126 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2127 == IS_NUMBER_IN_UV) {
2128 /* It's definitely an integer */
2129 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2131 SvNV_set(sv, Atof(SvPVX_const(sv)));
2134 SvNV_set(sv, Atof(SvPVX_const(sv)));
2135 /* Only set the public NV OK flag if this NV preserves the value in
2136 the PV at least as well as an IV/UV would.
2137 Not sure how to do this 100% reliably. */
2138 /* if that shift count is out of range then Configure's test is
2139 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2141 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2142 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2143 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2144 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2145 /* Can't use strtol etc to convert this string, so don't try.
2146 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2149 /* value has been set. It may not be precise. */
2150 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2151 /* 2s complement assumption for (UV)IV_MIN */
2152 SvNOK_on(sv); /* Integer is too negative. */
2157 if (numtype & IS_NUMBER_NEG) {
2158 SvIV_set(sv, -(IV)value);
2159 } else if (value <= (UV)IV_MAX) {
2160 SvIV_set(sv, (IV)value);
2162 SvUV_set(sv, value);
2166 if (numtype & IS_NUMBER_NOT_INT) {
2167 /* I believe that even if the original PV had decimals,
2168 they are lost beyond the limit of the FP precision.
2169 However, neither is canonical, so both only get p
2170 flags. NWC, 2000/11/25 */
2171 /* Both already have p flags, so do nothing */
2173 const NV nv = SvNVX(sv);
2174 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2175 if (SvIVX(sv) == I_V(nv)) {
2178 /* It had no "." so it must be integer. */
2182 /* between IV_MAX and NV(UV_MAX).
2183 Could be slightly > UV_MAX */
2185 if (numtype & IS_NUMBER_NOT_INT) {
2186 /* UV and NV both imprecise. */
2188 const UV nv_as_uv = U_V(nv);
2190 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2199 #endif /* NV_PRESERVES_UV */
2202 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2204 assert (SvTYPE(sv) >= SVt_NV);
2205 /* Typically the caller expects that sv_any is not NULL now. */
2206 /* XXX Ilya implies that this is a bug in callers that assume this
2207 and ideally should be fixed. */
2210 #if defined(USE_LONG_DOUBLE)
2212 STORE_NUMERIC_LOCAL_SET_STANDARD();
2213 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2214 PTR2UV(sv), SvNVX(sv));
2215 RESTORE_NUMERIC_LOCAL();
2219 STORE_NUMERIC_LOCAL_SET_STANDARD();
2220 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2221 PTR2UV(sv), SvNVX(sv));
2222 RESTORE_NUMERIC_LOCAL();
2228 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2229 * UV as a string towards the end of buf, and return pointers to start and
2232 * We assume that buf is at least TYPE_CHARS(UV) long.
2236 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2238 char *ptr = buf + TYPE_CHARS(UV);
2239 char * const ebuf = ptr;
2252 *--ptr = '0' + (char)(uv % 10);
2260 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2261 * a regexp to its stringified form.
2265 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2266 const regexp * const re = (regexp *)mg->mg_obj;
2269 const char *fptr = "msix";
2274 bool need_newline = 0;
2275 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2277 while((ch = *fptr++)) {
2279 reflags[left++] = ch;
2282 reflags[right--] = ch;
2287 reflags[left] = '-';
2291 mg->mg_len = re->prelen + 4 + left;
2293 * If /x was used, we have to worry about a regex ending with a
2294 * comment later being embedded within another regex. If so, we don't
2295 * want this regex's "commentization" to leak out to the right part of
2296 * the enclosing regex, we must cap it with a newline.
2298 * So, if /x was used, we scan backwards from the end of the regex. If
2299 * we find a '#' before we find a newline, we need to add a newline
2300 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2301 * we don't need to add anything. -jfriedl
2303 if (PMf_EXTENDED & re->reganch) {
2304 const char *endptr = re->precomp + re->prelen;
2305 while (endptr >= re->precomp) {
2306 const char c = *(endptr--);
2308 break; /* don't need another */
2310 /* we end while in a comment, so we need a newline */
2311 mg->mg_len++; /* save space for it */
2312 need_newline = 1; /* note to add it */
2318 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2319 mg->mg_ptr[0] = '(';
2320 mg->mg_ptr[1] = '?';
2321 Copy(reflags, mg->mg_ptr+2, left, char);
2322 *(mg->mg_ptr+left+2) = ':';
2323 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2325 mg->mg_ptr[mg->mg_len - 2] = '\n';
2326 mg->mg_ptr[mg->mg_len - 1] = ')';
2327 mg->mg_ptr[mg->mg_len] = 0;
2329 PL_reginterp_cnt += re->program[0].next_off;
2331 if (re->reganch & ROPT_UTF8)
2341 =for apidoc sv_2pv_flags
2343 Returns a pointer to the string value of an SV, and sets *lp to its length.
2344 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2346 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2347 usually end up here too.
2353 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2362 if (SvGMAGICAL(sv)) {
2363 if (flags & SV_GMAGIC)
2368 if (flags & SV_MUTABLE_RETURN)
2369 return SvPVX_mutable(sv);
2370 if (flags & SV_CONST_RETURN)
2371 return (char *)SvPVX_const(sv);
2374 if (SvIOKp(sv) || SvNOKp(sv)) {
2375 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2379 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2380 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2382 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2385 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2386 /* Sneaky stuff here */
2387 SV * const tsv = newSVpvn(tbuf, len);
2397 #ifdef FIXNEGATIVEZERO
2398 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2404 SvUPGRADE(sv, SVt_PV);
2407 s = SvGROW_mutable(sv, len + 1);
2410 return memcpy(s, tbuf, len + 1);
2416 assert(SvTYPE(sv) >= SVt_PVMG);
2417 /* This falls through to the report_uninit near the end of the
2419 } else if (SvTHINKFIRST(sv)) {
2423 SV *const tmpstr = AMG_CALLun(sv,string);
2424 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2426 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2430 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2431 if (flags & SV_CONST_RETURN) {
2432 pv = (char *) SvPVX_const(tmpstr);
2434 pv = (flags & SV_MUTABLE_RETURN)
2435 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2438 *lp = SvCUR(tmpstr);
2440 pv = sv_2pv_flags(tmpstr, lp, flags);
2452 const SV *const referent = (SV*)SvRV(sv);
2455 tsv = sv_2mortal(newSVpvs("NULLREF"));
2456 } else if (SvTYPE(referent) == SVt_PVMG
2457 && ((SvFLAGS(referent) &
2458 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2459 == (SVs_OBJECT|SVs_SMG))
2460 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2461 return stringify_regexp(sv, mg, lp);
2463 const char *const typestr = sv_reftype(referent, 0);
2465 tsv = sv_newmortal();
2466 if (SvOBJECT(referent)) {
2467 const char *const name = HvNAME_get(SvSTASH(referent));
2468 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2469 name ? name : "__ANON__" , typestr,
2473 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2481 if (SvREADONLY(sv) && !SvOK(sv)) {
2482 if (ckWARN(WARN_UNINITIALIZED))
2489 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2490 /* I'm assuming that if both IV and NV are equally valid then
2491 converting the IV is going to be more efficient */
2492 const U32 isIOK = SvIOK(sv);
2493 const U32 isUIOK = SvIsUV(sv);
2494 char buf[TYPE_CHARS(UV)];
2497 if (SvTYPE(sv) < SVt_PVIV)
2498 sv_upgrade(sv, SVt_PVIV);
2499 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2500 /* inlined from sv_setpvn */
2501 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2502 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2503 SvCUR_set(sv, ebuf - ptr);
2513 else if (SvNOKp(sv)) {
2514 const int olderrno = errno;
2515 if (SvTYPE(sv) < SVt_PVNV)
2516 sv_upgrade(sv, SVt_PVNV);
2517 /* The +20 is pure guesswork. Configure test needed. --jhi */
2518 s = SvGROW_mutable(sv, NV_DIG + 20);
2519 /* some Xenix systems wipe out errno here */
2521 if (SvNVX(sv) == 0.0)
2522 (void)strcpy(s,"0");
2526 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2529 #ifdef FIXNEGATIVEZERO
2530 if (*s == '-' && s[1] == '0' && !s[2])
2540 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2544 if (SvTYPE(sv) < SVt_PV)
2545 /* Typically the caller expects that sv_any is not NULL now. */
2546 sv_upgrade(sv, SVt_PV);
2550 const STRLEN len = s - SvPVX_const(sv);
2556 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2557 PTR2UV(sv),SvPVX_const(sv)));
2558 if (flags & SV_CONST_RETURN)
2559 return (char *)SvPVX_const(sv);
2560 if (flags & SV_MUTABLE_RETURN)
2561 return SvPVX_mutable(sv);
2566 =for apidoc sv_copypv
2568 Copies a stringified representation of the source SV into the
2569 destination SV. Automatically performs any necessary mg_get and
2570 coercion of numeric values into strings. Guaranteed to preserve
2571 UTF-8 flag even from overloaded objects. Similar in nature to
2572 sv_2pv[_flags] but operates directly on an SV instead of just the
2573 string. Mostly uses sv_2pv_flags to do its work, except when that
2574 would lose the UTF-8'ness of the PV.
2580 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2583 const char * const s = SvPV_const(ssv,len);
2584 sv_setpvn(dsv,s,len);
2592 =for apidoc sv_2pvbyte
2594 Return a pointer to the byte-encoded representation of the SV, and set *lp
2595 to its length. May cause the SV to be downgraded from UTF-8 as a
2598 Usually accessed via the C<SvPVbyte> macro.
2604 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2606 sv_utf8_downgrade(sv,0);
2607 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2611 =for apidoc sv_2pvutf8
2613 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2614 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2616 Usually accessed via the C<SvPVutf8> macro.
2622 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2624 sv_utf8_upgrade(sv);
2625 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2630 =for apidoc sv_2bool
2632 This function is only called on magical items, and is only used by
2633 sv_true() or its macro equivalent.
2639 Perl_sv_2bool(pTHX_ register SV *sv)
2647 SV * const tmpsv = AMG_CALLun(sv,bool_);
2648 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2649 return (bool)SvTRUE(tmpsv);
2651 return SvRV(sv) != 0;
2654 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2656 (*sv->sv_u.svu_pv > '0' ||
2657 Xpvtmp->xpv_cur > 1 ||
2658 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2665 return SvIVX(sv) != 0;
2668 return SvNVX(sv) != 0.0;
2676 =for apidoc sv_utf8_upgrade
2678 Converts the PV of an SV to its UTF-8-encoded form.
2679 Forces the SV to string form if it is not already.
2680 Always sets the SvUTF8 flag to avoid future validity checks even
2681 if all the bytes have hibit clear.
2683 This is not as a general purpose byte encoding to Unicode interface:
2684 use the Encode extension for that.
2686 =for apidoc sv_utf8_upgrade_flags
2688 Converts the PV of an SV to its UTF-8-encoded form.
2689 Forces the SV to string form if it is not already.
2690 Always sets the SvUTF8 flag to avoid future validity checks even
2691 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2692 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2693 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2695 This is not as a general purpose byte encoding to Unicode interface:
2696 use the Encode extension for that.
2702 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2704 if (sv == &PL_sv_undef)
2708 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2709 (void) sv_2pv_flags(sv,&len, flags);
2713 (void) SvPV_force(sv,len);
2722 sv_force_normal_flags(sv, 0);
2725 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2726 sv_recode_to_utf8(sv, PL_encoding);
2727 else { /* Assume Latin-1/EBCDIC */
2728 /* This function could be much more efficient if we
2729 * had a FLAG in SVs to signal if there are any hibit
2730 * chars in the PV. Given that there isn't such a flag
2731 * make the loop as fast as possible. */
2732 const U8 * const s = (U8 *) SvPVX_const(sv);
2733 const U8 * const e = (U8 *) SvEND(sv);
2738 /* Check for hi bit */
2739 if (!NATIVE_IS_INVARIANT(ch)) {
2740 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2741 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2743 SvPV_free(sv); /* No longer using what was there before. */
2744 SvPV_set(sv, (char*)recoded);
2745 SvCUR_set(sv, len - 1);
2746 SvLEN_set(sv, len); /* No longer know the real size. */
2750 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2757 =for apidoc sv_utf8_downgrade
2759 Attempts to convert the PV of an SV from characters to bytes.
2760 If the PV contains a character beyond byte, this conversion will fail;
2761 in this case, either returns false or, if C<fail_ok> is not
2764 This is not as a general purpose Unicode to byte encoding interface:
2765 use the Encode extension for that.
2771 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2773 if (SvPOKp(sv) && SvUTF8(sv)) {
2779 sv_force_normal_flags(sv, 0);
2781 s = (U8 *) SvPV(sv, len);
2782 if (!utf8_to_bytes(s, &len)) {
2787 Perl_croak(aTHX_ "Wide character in %s",
2790 Perl_croak(aTHX_ "Wide character");
2801 =for apidoc sv_utf8_encode
2803 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2804 flag off so that it looks like octets again.
2810 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2812 (void) sv_utf8_upgrade(sv);
2814 sv_force_normal_flags(sv, 0);
2816 if (SvREADONLY(sv)) {
2817 Perl_croak(aTHX_ PL_no_modify);
2823 =for apidoc sv_utf8_decode
2825 If the PV of the SV is an octet sequence in UTF-8
2826 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2827 so that it looks like a character. If the PV contains only single-byte
2828 characters, the C<SvUTF8> flag stays being off.
2829 Scans PV for validity and returns false if the PV is invalid UTF-8.
2835 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2841 /* The octets may have got themselves encoded - get them back as
2844 if (!sv_utf8_downgrade(sv, TRUE))
2847 /* it is actually just a matter of turning the utf8 flag on, but
2848 * we want to make sure everything inside is valid utf8 first.
2850 c = (const U8 *) SvPVX_const(sv);
2851 if (!is_utf8_string(c, SvCUR(sv)+1))
2853 e = (const U8 *) SvEND(sv);
2856 if (!UTF8_IS_INVARIANT(ch)) {
2866 =for apidoc sv_setsv
2868 Copies the contents of the source SV C<ssv> into the destination SV
2869 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2870 function if the source SV needs to be reused. Does not handle 'set' magic.
2871 Loosely speaking, it performs a copy-by-value, obliterating any previous
2872 content of the destination.
2874 You probably want to use one of the assortment of wrappers, such as
2875 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2876 C<SvSetMagicSV_nosteal>.
2878 =for apidoc sv_setsv_flags
2880 Copies the contents of the source SV C<ssv> into the destination SV
2881 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2882 function if the source SV needs to be reused. Does not handle 'set' magic.
2883 Loosely speaking, it performs a copy-by-value, obliterating any previous
2884 content of the destination.
2885 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2886 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2887 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2888 and C<sv_setsv_nomg> are implemented in terms of this function.
2890 You probably want to use one of the assortment of wrappers, such as
2891 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2892 C<SvSetMagicSV_nosteal>.
2894 This is the primary function for copying scalars, and most other
2895 copy-ish functions and macros use this underneath.
2901 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2903 register U32 sflags;
2909 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2911 sstr = &PL_sv_undef;
2912 stype = SvTYPE(sstr);
2913 dtype = SvTYPE(dstr);
2918 /* need to nuke the magic */
2920 SvRMAGICAL_off(dstr);
2923 /* There's a lot of redundancy below but we're going for speed here */
2928 if (dtype != SVt_PVGV) {
2929 (void)SvOK_off(dstr);
2937 sv_upgrade(dstr, SVt_IV);
2940 sv_upgrade(dstr, SVt_PVNV);
2944 sv_upgrade(dstr, SVt_PVIV);
2947 (void)SvIOK_only(dstr);
2948 SvIV_set(dstr, SvIVX(sstr));
2951 if (SvTAINTED(sstr))
2962 sv_upgrade(dstr, SVt_NV);
2967 sv_upgrade(dstr, SVt_PVNV);
2970 SvNV_set(dstr, SvNVX(sstr));
2971 (void)SvNOK_only(dstr);
2972 if (SvTAINTED(sstr))
2980 sv_upgrade(dstr, SVt_RV);
2981 else if (dtype == SVt_PVGV &&
2982 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2985 if (GvIMPORTED(dstr) != GVf_IMPORTED
2986 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2988 GvIMPORTED_on(dstr);
2997 #ifdef PERL_OLD_COPY_ON_WRITE
2998 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
2999 if (dtype < SVt_PVIV)
3000 sv_upgrade(dstr, SVt_PVIV);
3007 sv_upgrade(dstr, SVt_PV);
3010 if (dtype < SVt_PVIV)
3011 sv_upgrade(dstr, SVt_PVIV);
3014 if (dtype < SVt_PVNV)
3015 sv_upgrade(dstr, SVt_PVNV);
3022 const char * const type = sv_reftype(sstr,0);
3024 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3026 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3031 if (dtype <= SVt_PVGV) {
3033 if (dtype != SVt_PVGV) {
3034 const char * const name = GvNAME(sstr);
3035 const STRLEN len = GvNAMELEN(sstr);
3036 /* don't upgrade SVt_PVLV: it can hold a glob */
3037 if (dtype != SVt_PVLV)
3038 sv_upgrade(dstr, SVt_PVGV);
3039 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3040 GvSTASH(dstr) = GvSTASH(sstr);
3042 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3043 GvNAME(dstr) = savepvn(name, len);
3044 GvNAMELEN(dstr) = len;
3045 SvFAKE_on(dstr); /* can coerce to non-glob */
3048 #ifdef GV_UNIQUE_CHECK
3049 if (GvUNIQUE((GV*)dstr)) {
3050 Perl_croak(aTHX_ PL_no_modify);
3054 (void)SvOK_off(dstr);
3055 GvINTRO_off(dstr); /* one-shot flag */
3057 GvGP(dstr) = gp_ref(GvGP(sstr));
3058 if (SvTAINTED(sstr))
3060 if (GvIMPORTED(dstr) != GVf_IMPORTED
3061 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3063 GvIMPORTED_on(dstr);
3071 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3073 if ((int)SvTYPE(sstr) != stype) {
3074 stype = SvTYPE(sstr);
3075 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3079 if (stype == SVt_PVLV)
3080 SvUPGRADE(dstr, SVt_PVNV);
3082 SvUPGRADE(dstr, (U32)stype);
3085 sflags = SvFLAGS(sstr);
3087 if (sflags & SVf_ROK) {
3088 if (dtype >= SVt_PV) {
3089 if (dtype == SVt_PVGV) {
3090 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3092 const int intro = GvINTRO(dstr);
3094 #ifdef GV_UNIQUE_CHECK
3095 if (GvUNIQUE((GV*)dstr)) {
3096 Perl_croak(aTHX_ PL_no_modify);
3101 GvINTRO_off(dstr); /* one-shot flag */
3102 GvLINE(dstr) = CopLINE(PL_curcop);
3103 GvEGV(dstr) = (GV*)dstr;
3106 switch (SvTYPE(sref)) {
3109 SAVEGENERICSV(GvAV(dstr));
3111 dref = (SV*)GvAV(dstr);
3112 GvAV(dstr) = (AV*)sref;
3113 if (!GvIMPORTED_AV(dstr)
3114 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3116 GvIMPORTED_AV_on(dstr);
3121 SAVEGENERICSV(GvHV(dstr));
3123 dref = (SV*)GvHV(dstr);
3124 GvHV(dstr) = (HV*)sref;
3125 if (!GvIMPORTED_HV(dstr)
3126 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3128 GvIMPORTED_HV_on(dstr);
3133 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3134 SvREFCNT_dec(GvCV(dstr));
3135 GvCV(dstr) = Nullcv;
3136 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3137 PL_sub_generation++;
3139 SAVEGENERICSV(GvCV(dstr));
3142 dref = (SV*)GvCV(dstr);
3143 if (GvCV(dstr) != (CV*)sref) {
3144 CV* const cv = GvCV(dstr);
3146 if (!GvCVGEN((GV*)dstr) &&
3147 (CvROOT(cv) || CvXSUB(cv)))
3149 /* Redefining a sub - warning is mandatory if
3150 it was a const and its value changed. */
3151 if (CvCONST(cv) && CvCONST((CV*)sref)
3153 == cv_const_sv((CV*)sref)) {
3154 /* They are 2 constant subroutines
3155 generated from the same constant.
3156 This probably means that they are
3157 really the "same" proxy subroutine
3158 instantiated in 2 places. Most likely
3159 this is when a constant is exported
3160 twice. Don't warn. */
3162 else if (ckWARN(WARN_REDEFINE)
3164 && (!CvCONST((CV*)sref)
3165 || sv_cmp(cv_const_sv(cv),
3166 cv_const_sv((CV*)sref)))))
3168 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3170 ? "Constant subroutine %s::%s redefined"
3171 : "Subroutine %s::%s redefined",
3172 HvNAME_get(GvSTASH((GV*)dstr)),
3173 GvENAME((GV*)dstr));
3177 cv_ckproto(cv, (GV*)dstr,
3179 ? SvPVX_const(sref) : Nullch);
3181 GvCV(dstr) = (CV*)sref;
3182 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3183 GvASSUMECV_on(dstr);
3184 PL_sub_generation++;
3186 if (!GvIMPORTED_CV(dstr)
3187 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3189 GvIMPORTED_CV_on(dstr);
3194 SAVEGENERICSV(GvIOp(dstr));
3196 dref = (SV*)GvIOp(dstr);
3197 GvIOp(dstr) = (IO*)sref;
3201 SAVEGENERICSV(GvFORM(dstr));
3203 dref = (SV*)GvFORM(dstr);
3204 GvFORM(dstr) = (CV*)sref;
3208 SAVEGENERICSV(GvSV(dstr));
3210 dref = (SV*)GvSV(dstr);
3212 if (!GvIMPORTED_SV(dstr)
3213 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3215 GvIMPORTED_SV_on(dstr);
3221 if (SvTAINTED(sstr))
3225 if (SvPVX_const(dstr)) {
3231 (void)SvOK_off(dstr);
3232 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3234 if (sflags & SVp_NOK) {
3236 /* Only set the public OK flag if the source has public OK. */
3237 if (sflags & SVf_NOK)
3238 SvFLAGS(dstr) |= SVf_NOK;
3239 SvNV_set(dstr, SvNVX(sstr));
3241 if (sflags & SVp_IOK) {
3242 (void)SvIOKp_on(dstr);
3243 if (sflags & SVf_IOK)
3244 SvFLAGS(dstr) |= SVf_IOK;
3245 if (sflags & SVf_IVisUV)
3247 SvIV_set(dstr, SvIVX(sstr));
3249 if (SvAMAGIC(sstr)) {
3253 else if (sflags & SVp_POK) {
3257 * Check to see if we can just swipe the string. If so, it's a
3258 * possible small lose on short strings, but a big win on long ones.
3259 * It might even be a win on short strings if SvPVX_const(dstr)
3260 * has to be allocated and SvPVX_const(sstr) has to be freed.
3263 /* Whichever path we take through the next code, we want this true,
3264 and doing it now facilitates the COW check. */
3265 (void)SvPOK_only(dstr);
3268 /* We're not already COW */
3269 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3270 #ifndef PERL_OLD_COPY_ON_WRITE
3271 /* or we are, but dstr isn't a suitable target. */
3272 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3277 (sflags & SVs_TEMP) && /* slated for free anyway? */
3278 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3279 (!(flags & SV_NOSTEAL)) &&
3280 /* and we're allowed to steal temps */
3281 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3282 SvLEN(sstr) && /* and really is a string */
3283 /* and won't be needed again, potentially */
3284 !(PL_op && PL_op->op_type == OP_AASSIGN))
3285 #ifdef PERL_OLD_COPY_ON_WRITE
3286 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3287 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3288 && SvTYPE(sstr) >= SVt_PVIV)
3291 /* Failed the swipe test, and it's not a shared hash key either.
3292 Have to copy the string. */
3293 STRLEN len = SvCUR(sstr);
3294 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3295 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3296 SvCUR_set(dstr, len);
3297 *SvEND(dstr) = '\0';
3299 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3301 /* Either it's a shared hash key, or it's suitable for
3302 copy-on-write or we can swipe the string. */
3304 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3308 #ifdef PERL_OLD_COPY_ON_WRITE
3310 /* I believe I should acquire a global SV mutex if
3311 it's a COW sv (not a shared hash key) to stop
3312 it going un copy-on-write.
3313 If the source SV has gone un copy on write between up there
3314 and down here, then (assert() that) it is of the correct
3315 form to make it copy on write again */
3316 if ((sflags & (SVf_FAKE | SVf_READONLY))
3317 != (SVf_FAKE | SVf_READONLY)) {
3318 SvREADONLY_on(sstr);
3320 /* Make the source SV into a loop of 1.
3321 (about to become 2) */
3322 SV_COW_NEXT_SV_SET(sstr, sstr);
3326 /* Initial code is common. */
3327 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3332 /* making another shared SV. */
3333 STRLEN cur = SvCUR(sstr);
3334 STRLEN len = SvLEN(sstr);
3335 #ifdef PERL_OLD_COPY_ON_WRITE
3337 assert (SvTYPE(dstr) >= SVt_PVIV);
3338 /* SvIsCOW_normal */
3339 /* splice us in between source and next-after-source. */
3340 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3341 SV_COW_NEXT_SV_SET(sstr, dstr);
3342 SvPV_set(dstr, SvPVX_mutable(sstr));
3346 /* SvIsCOW_shared_hash */
3347 DEBUG_C(PerlIO_printf(Perl_debug_log,
3348 "Copy on write: Sharing hash\n"));
3350 assert (SvTYPE(dstr) >= SVt_PV);
3352 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3354 SvLEN_set(dstr, len);
3355 SvCUR_set(dstr, cur);
3356 SvREADONLY_on(dstr);
3358 /* Relesase a global SV mutex. */
3361 { /* Passes the swipe test. */
3362 SvPV_set(dstr, SvPVX_mutable(sstr));
3363 SvLEN_set(dstr, SvLEN(sstr));
3364 SvCUR_set(dstr, SvCUR(sstr));
3367 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3368 SvPV_set(sstr, Nullch);
3374 if (sflags & SVf_UTF8)
3376 if (sflags & SVp_NOK) {
3378 if (sflags & SVf_NOK)
3379 SvFLAGS(dstr) |= SVf_NOK;
3380 SvNV_set(dstr, SvNVX(sstr));
3382 if (sflags & SVp_IOK) {
3383 (void)SvIOKp_on(dstr);
3384 if (sflags & SVf_IOK)
3385 SvFLAGS(dstr) |= SVf_IOK;
3386 if (sflags & SVf_IVisUV)
3388 SvIV_set(dstr, SvIVX(sstr));
3391 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3392 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3393 smg->mg_ptr, smg->mg_len);
3394 SvRMAGICAL_on(dstr);
3397 else if (sflags & SVp_IOK) {
3398 if (sflags & SVf_IOK)
3399 (void)SvIOK_only(dstr);
3401 (void)SvOK_off(dstr);
3402 (void)SvIOKp_on(dstr);
3404 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3405 if (sflags & SVf_IVisUV)
3407 SvIV_set(dstr, SvIVX(sstr));
3408 if (sflags & SVp_NOK) {
3409 if (sflags & SVf_NOK)
3410 (void)SvNOK_on(dstr);
3412 (void)SvNOKp_on(dstr);
3413 SvNV_set(dstr, SvNVX(sstr));
3416 else if (sflags & SVp_NOK) {
3417 if (sflags & SVf_NOK)
3418 (void)SvNOK_only(dstr);
3420 (void)SvOK_off(dstr);
3423 SvNV_set(dstr, SvNVX(sstr));
3426 if (dtype == SVt_PVGV) {
3427 if (ckWARN(WARN_MISC))
3428 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3431 (void)SvOK_off(dstr);
3433 if (SvTAINTED(sstr))
3438 =for apidoc sv_setsv_mg
3440 Like C<sv_setsv>, but also handles 'set' magic.
3446 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3448 sv_setsv(dstr,sstr);
3452 #ifdef PERL_OLD_COPY_ON_WRITE
3454 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3456 STRLEN cur = SvCUR(sstr);
3457 STRLEN len = SvLEN(sstr);
3458 register char *new_pv;
3461 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3469 if (SvTHINKFIRST(dstr))
3470 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3471 else if (SvPVX_const(dstr))
3472 Safefree(SvPVX_const(dstr));
3476 SvUPGRADE(dstr, SVt_PVIV);
3478 assert (SvPOK(sstr));
3479 assert (SvPOKp(sstr));
3480 assert (!SvIOK(sstr));
3481 assert (!SvIOKp(sstr));
3482 assert (!SvNOK(sstr));
3483 assert (!SvNOKp(sstr));
3485 if (SvIsCOW(sstr)) {
3487 if (SvLEN(sstr) == 0) {
3488 /* source is a COW shared hash key. */
3489 DEBUG_C(PerlIO_printf(Perl_debug_log,
3490 "Fast copy on write: Sharing hash\n"));
3491 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3494 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3496 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3497 SvUPGRADE(sstr, SVt_PVIV);
3498 SvREADONLY_on(sstr);
3500 DEBUG_C(PerlIO_printf(Perl_debug_log,
3501 "Fast copy on write: Converting sstr to COW\n"));
3502 SV_COW_NEXT_SV_SET(dstr, sstr);
3504 SV_COW_NEXT_SV_SET(sstr, dstr);
3505 new_pv = SvPVX_mutable(sstr);
3508 SvPV_set(dstr, new_pv);
3509 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3512 SvLEN_set(dstr, len);
3513 SvCUR_set(dstr, cur);
3522 =for apidoc sv_setpvn
3524 Copies a string into an SV. The C<len> parameter indicates the number of
3525 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3526 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3532 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3534 register char *dptr;
3536 SV_CHECK_THINKFIRST_COW_DROP(sv);
3542 /* len is STRLEN which is unsigned, need to copy to signed */
3545 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3547 SvUPGRADE(sv, SVt_PV);
3549 dptr = SvGROW(sv, len + 1);
3550 Move(ptr,dptr,len,char);
3553 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3558 =for apidoc sv_setpvn_mg
3560 Like C<sv_setpvn>, but also handles 'set' magic.
3566 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3568 sv_setpvn(sv,ptr,len);
3573 =for apidoc sv_setpv
3575 Copies a string into an SV. The string must be null-terminated. Does not
3576 handle 'set' magic. See C<sv_setpv_mg>.
3582 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3584 register STRLEN len;
3586 SV_CHECK_THINKFIRST_COW_DROP(sv);
3592 SvUPGRADE(sv, SVt_PV);
3594 SvGROW(sv, len + 1);
3595 Move(ptr,SvPVX(sv),len+1,char);
3597 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3602 =for apidoc sv_setpv_mg
3604 Like C<sv_setpv>, but also handles 'set' magic.
3610 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3617 =for apidoc sv_usepvn
3619 Tells an SV to use C<ptr> to find its string value. Normally the string is
3620 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3621 The C<ptr> should point to memory that was allocated by C<malloc>. The
3622 string length, C<len>, must be supplied. This function will realloc the
3623 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3624 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3625 See C<sv_usepvn_mg>.
3631 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3634 SV_CHECK_THINKFIRST_COW_DROP(sv);
3635 SvUPGRADE(sv, SVt_PV);
3640 if (SvPVX_const(sv))
3643 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3644 ptr = saferealloc (ptr, allocate);
3647 SvLEN_set(sv, allocate);
3649 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3654 =for apidoc sv_usepvn_mg
3656 Like C<sv_usepvn>, but also handles 'set' magic.
3662 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3664 sv_usepvn(sv,ptr,len);
3668 #ifdef PERL_OLD_COPY_ON_WRITE
3669 /* Need to do this *after* making the SV normal, as we need the buffer
3670 pointer to remain valid until after we've copied it. If we let go too early,
3671 another thread could invalidate it by unsharing last of the same hash key
3672 (which it can do by means other than releasing copy-on-write Svs)
3673 or by changing the other copy-on-write SVs in the loop. */
3675 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3677 if (len) { /* this SV was SvIsCOW_normal(sv) */
3678 /* we need to find the SV pointing to us. */
3679 SV * const current = SV_COW_NEXT_SV(after);
3681 if (current == sv) {
3682 /* The SV we point to points back to us (there were only two of us
3684 Hence other SV is no longer copy on write either. */
3686 SvREADONLY_off(after);
3688 /* We need to follow the pointers around the loop. */
3690 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3693 /* don't loop forever if the structure is bust, and we have
3694 a pointer into a closed loop. */
3695 assert (current != after);
3696 assert (SvPVX_const(current) == pvx);
3698 /* Make the SV before us point to the SV after us. */
3699 SV_COW_NEXT_SV_SET(current, after);
3702 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3707 Perl_sv_release_IVX(pTHX_ register SV *sv)
3710 sv_force_normal_flags(sv, 0);
3716 =for apidoc sv_force_normal_flags
3718 Undo various types of fakery on an SV: if the PV is a shared string, make
3719 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3720 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3721 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3722 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3723 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3724 set to some other value.) In addition, the C<flags> parameter gets passed to
3725 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3726 with flags set to 0.
3732 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3734 #ifdef PERL_OLD_COPY_ON_WRITE
3735 if (SvREADONLY(sv)) {
3736 /* At this point I believe I should acquire a global SV mutex. */
3738 const char * const pvx = SvPVX_const(sv);
3739 const STRLEN len = SvLEN(sv);
3740 const STRLEN cur = SvCUR(sv);
3741 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3743 PerlIO_printf(Perl_debug_log,
3744 "Copy on write: Force normal %ld\n",
3750 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3751 SvPV_set(sv, (char*)0);
3753 if (flags & SV_COW_DROP_PV) {
3754 /* OK, so we don't need to copy our buffer. */
3757 SvGROW(sv, cur + 1);
3758 Move(pvx,SvPVX(sv),cur,char);
3762 sv_release_COW(sv, pvx, len, next);
3767 else if (IN_PERL_RUNTIME)
3768 Perl_croak(aTHX_ PL_no_modify);
3769 /* At this point I believe that I can drop the global SV mutex. */
3772 if (SvREADONLY(sv)) {
3774 const char * const pvx = SvPVX_const(sv);
3775 const STRLEN len = SvCUR(sv);
3778 SvPV_set(sv, Nullch);
3780 SvGROW(sv, len + 1);
3781 Move(pvx,SvPVX(sv),len,char);
3783 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3785 else if (IN_PERL_RUNTIME)
3786 Perl_croak(aTHX_ PL_no_modify);
3790 sv_unref_flags(sv, flags);
3791 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3798 Efficient removal of characters from the beginning of the string buffer.
3799 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3800 the string buffer. The C<ptr> becomes the first character of the adjusted
3801 string. Uses the "OOK hack".
3802 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3803 refer to the same chunk of data.
3809 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3811 register STRLEN delta;
3812 if (!ptr || !SvPOKp(sv))
3814 delta = ptr - SvPVX_const(sv);
3815 SV_CHECK_THINKFIRST(sv);
3816 if (SvTYPE(sv) < SVt_PVIV)
3817 sv_upgrade(sv,SVt_PVIV);
3820 if (!SvLEN(sv)) { /* make copy of shared string */
3821 const char *pvx = SvPVX_const(sv);
3822 const STRLEN len = SvCUR(sv);
3823 SvGROW(sv, len + 1);
3824 Move(pvx,SvPVX(sv),len,char);
3828 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3829 and we do that anyway inside the SvNIOK_off
3831 SvFLAGS(sv) |= SVf_OOK;
3834 SvLEN_set(sv, SvLEN(sv) - delta);
3835 SvCUR_set(sv, SvCUR(sv) - delta);
3836 SvPV_set(sv, SvPVX(sv) + delta);
3837 SvIV_set(sv, SvIVX(sv) + delta);
3841 =for apidoc sv_catpvn
3843 Concatenates the string onto the end of the string which is in the SV. The
3844 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3845 status set, then the bytes appended should be valid UTF-8.
3846 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3848 =for apidoc sv_catpvn_flags
3850 Concatenates the string onto the end of the string which is in the SV. The
3851 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3852 status set, then the bytes appended should be valid UTF-8.
3853 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3854 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3855 in terms of this function.
3861 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3864 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3866 SvGROW(dsv, dlen + slen + 1);
3868 sstr = SvPVX_const(dsv);
3869 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3870 SvCUR_set(dsv, SvCUR(dsv) + slen);
3872 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3874 if (flags & SV_SMAGIC)
3879 =for apidoc sv_catsv
3881 Concatenates the string from SV C<ssv> onto the end of the string in
3882 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3883 not 'set' magic. See C<sv_catsv_mg>.
3885 =for apidoc sv_catsv_flags
3887 Concatenates the string from SV C<ssv> onto the end of the string in
3888 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3889 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3890 and C<sv_catsv_nomg> are implemented in terms of this function.
3895 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3899 const char *spv = SvPV_const(ssv, slen);
3901 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3902 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3903 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3904 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3905 dsv->sv_flags doesn't have that bit set.
3906 Andy Dougherty 12 Oct 2001
3908 const I32 sutf8 = DO_UTF8(ssv);
3911 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3913 dutf8 = DO_UTF8(dsv);
3915 if (dutf8 != sutf8) {
3917 /* Not modifying source SV, so taking a temporary copy. */
3918 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3920 sv_utf8_upgrade(csv);
3921 spv = SvPV_const(csv, slen);
3924 sv_utf8_upgrade_nomg(dsv);
3926 sv_catpvn_nomg(dsv, spv, slen);
3929 if (flags & SV_SMAGIC)
3934 =for apidoc sv_catpv
3936 Concatenates the string onto the end of the string which is in the SV.
3937 If the SV has the UTF-8 status set, then the bytes appended should be
3938 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3943 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3945 register STRLEN len;
3951 junk = SvPV_force(sv, tlen);
3953 SvGROW(sv, tlen + len + 1);
3955 ptr = SvPVX_const(sv);
3956 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3957 SvCUR_set(sv, SvCUR(sv) + len);
3958 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3963 =for apidoc sv_catpv_mg
3965 Like C<sv_catpv>, but also handles 'set' magic.
3971 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3980 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3981 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3988 Perl_newSV(pTHX_ STRLEN len)
3994 sv_upgrade(sv, SVt_PV);
3995 SvGROW(sv, len + 1);
4000 =for apidoc sv_magicext
4002 Adds magic to an SV, upgrading it if necessary. Applies the
4003 supplied vtable and returns a pointer to the magic added.
4005 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4006 In particular, you can add magic to SvREADONLY SVs, and add more than
4007 one instance of the same 'how'.
4009 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4010 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4011 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4012 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4014 (This is now used as a subroutine by C<sv_magic>.)
4019 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4020 const char* name, I32 namlen)
4024 if (SvTYPE(sv) < SVt_PVMG) {
4025 SvUPGRADE(sv, SVt_PVMG);
4027 Newxz(mg, 1, MAGIC);
4028 mg->mg_moremagic = SvMAGIC(sv);
4029 SvMAGIC_set(sv, mg);
4031 /* Sometimes a magic contains a reference loop, where the sv and
4032 object refer to each other. To prevent a reference loop that
4033 would prevent such objects being freed, we look for such loops
4034 and if we find one we avoid incrementing the object refcount.
4036 Note we cannot do this to avoid self-tie loops as intervening RV must
4037 have its REFCNT incremented to keep it in existence.
4040 if (!obj || obj == sv ||
4041 how == PERL_MAGIC_arylen ||
4042 how == PERL_MAGIC_qr ||
4043 how == PERL_MAGIC_symtab ||
4044 (SvTYPE(obj) == SVt_PVGV &&
4045 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4046 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4047 GvFORM(obj) == (CV*)sv)))
4052 mg->mg_obj = SvREFCNT_inc(obj);
4053 mg->mg_flags |= MGf_REFCOUNTED;
4056 /* Normal self-ties simply pass a null object, and instead of
4057 using mg_obj directly, use the SvTIED_obj macro to produce a
4058 new RV as needed. For glob "self-ties", we are tieing the PVIO
4059 with an RV obj pointing to the glob containing the PVIO. In
4060 this case, to avoid a reference loop, we need to weaken the
4064 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4065 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4071 mg->mg_len = namlen;
4074 mg->mg_ptr = savepvn(name, namlen);
4075 else if (namlen == HEf_SVKEY)
4076 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4078 mg->mg_ptr = (char *) name;
4080 mg->mg_virtual = vtable;
4084 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4089 =for apidoc sv_magic
4091 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4092 then adds a new magic item of type C<how> to the head of the magic list.
4094 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4095 handling of the C<name> and C<namlen> arguments.
4097 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4098 to add more than one instance of the same 'how'.
4104 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4106 const MGVTBL *vtable;
4109 #ifdef PERL_OLD_COPY_ON_WRITE
4111 sv_force_normal_flags(sv, 0);
4113 if (SvREADONLY(sv)) {
4115 /* its okay to attach magic to shared strings; the subsequent
4116 * upgrade to PVMG will unshare the string */
4117 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4120 && how != PERL_MAGIC_regex_global
4121 && how != PERL_MAGIC_bm
4122 && how != PERL_MAGIC_fm
4123 && how != PERL_MAGIC_sv
4124 && how != PERL_MAGIC_backref
4127 Perl_croak(aTHX_ PL_no_modify);
4130 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4131 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4132 /* sv_magic() refuses to add a magic of the same 'how' as an
4135 if (how == PERL_MAGIC_taint)
4143 vtable = &PL_vtbl_sv;
4145 case PERL_MAGIC_overload:
4146 vtable = &PL_vtbl_amagic;
4148 case PERL_MAGIC_overload_elem:
4149 vtable = &PL_vtbl_amagicelem;
4151 case PERL_MAGIC_overload_table:
4152 vtable = &PL_vtbl_ovrld;
4155 vtable = &PL_vtbl_bm;
4157 case PERL_MAGIC_regdata:
4158 vtable = &PL_vtbl_regdata;
4160 case PERL_MAGIC_regdatum:
4161 vtable = &PL_vtbl_regdatum;
4163 case PERL_MAGIC_env:
4164 vtable = &PL_vtbl_env;
4167 vtable = &PL_vtbl_fm;
4169 case PERL_MAGIC_envelem:
4170 vtable = &PL_vtbl_envelem;
4172 case PERL_MAGIC_regex_global:
4173 vtable = &PL_vtbl_mglob;
4175 case PERL_MAGIC_isa:
4176 vtable = &PL_vtbl_isa;
4178 case PERL_MAGIC_isaelem:
4179 vtable = &PL_vtbl_isaelem;
4181 case PERL_MAGIC_nkeys:
4182 vtable = &PL_vtbl_nkeys;
4184 case PERL_MAGIC_dbfile:
4187 case PERL_MAGIC_dbline:
4188 vtable = &PL_vtbl_dbline;
4190 #ifdef USE_LOCALE_COLLATE
4191 case PERL_MAGIC_collxfrm:
4192 vtable = &PL_vtbl_collxfrm;
4194 #endif /* USE_LOCALE_COLLATE */
4195 case PERL_MAGIC_tied:
4196 vtable = &PL_vtbl_pack;
4198 case PERL_MAGIC_tiedelem:
4199 case PERL_MAGIC_tiedscalar:
4200 vtable = &PL_vtbl_packelem;
4203 vtable = &PL_vtbl_regexp;
4205 case PERL_MAGIC_sig:
4206 vtable = &PL_vtbl_sig;
4208 case PERL_MAGIC_sigelem:
4209 vtable = &PL_vtbl_sigelem;
4211 case PERL_MAGIC_taint:
4212 vtable = &PL_vtbl_taint;
4214 case PERL_MAGIC_uvar:
4215 vtable = &PL_vtbl_uvar;
4217 case PERL_MAGIC_vec:
4218 vtable = &PL_vtbl_vec;
4220 case PERL_MAGIC_arylen_p:
4221 case PERL_MAGIC_rhash:
4222 case PERL_MAGIC_symtab:
4223 case PERL_MAGIC_vstring:
4226 case PERL_MAGIC_utf8:
4227 vtable = &PL_vtbl_utf8;
4229 case PERL_MAGIC_substr:
4230 vtable = &PL_vtbl_substr;
4232 case PERL_MAGIC_defelem:
4233 vtable = &PL_vtbl_defelem;
4235 case PERL_MAGIC_glob:
4236 vtable = &PL_vtbl_glob;
4238 case PERL_MAGIC_arylen:
4239 vtable = &PL_vtbl_arylen;
4241 case PERL_MAGIC_pos:
4242 vtable = &PL_vtbl_pos;
4244 case PERL_MAGIC_backref:
4245 vtable = &PL_vtbl_backref;
4247 case PERL_MAGIC_ext:
4248 /* Reserved for use by extensions not perl internals. */
4249 /* Useful for attaching extension internal data to perl vars. */
4250 /* Note that multiple extensions may clash if magical scalars */
4251 /* etc holding private data from one are passed to another. */
4255 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4258 /* Rest of work is done else where */
4259 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4262 case PERL_MAGIC_taint:
4265 case PERL_MAGIC_ext:
4266 case PERL_MAGIC_dbfile:
4273 =for apidoc sv_unmagic
4275 Removes all magic of type C<type> from an SV.
4281 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4285 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4288 for (mg = *mgp; mg; mg = *mgp) {
4289 if (mg->mg_type == type) {
4290 const MGVTBL* const vtbl = mg->mg_virtual;
4291 *mgp = mg->mg_moremagic;
4292 if (vtbl && vtbl->svt_free)
4293 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4294 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4296 Safefree(mg->mg_ptr);
4297 else if (mg->mg_len == HEf_SVKEY)
4298 SvREFCNT_dec((SV*)mg->mg_ptr);
4299 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4300 Safefree(mg->mg_ptr);
4302 if (mg->mg_flags & MGf_REFCOUNTED)
4303 SvREFCNT_dec(mg->mg_obj);
4307 mgp = &mg->mg_moremagic;
4311 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4312 SvMAGIC_set(sv, NULL);
4319 =for apidoc sv_rvweaken
4321 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4322 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4323 push a back-reference to this RV onto the array of backreferences
4324 associated with that magic.
4330 Perl_sv_rvweaken(pTHX_ SV *sv)
4333 if (!SvOK(sv)) /* let undefs pass */
4336 Perl_croak(aTHX_ "Can't weaken a nonreference");
4337 else if (SvWEAKREF(sv)) {
4338 if (ckWARN(WARN_MISC))
4339 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4343 Perl_sv_add_backref(aTHX_ tsv, sv);
4349 /* Give tsv backref magic if it hasn't already got it, then push a
4350 * back-reference to sv onto the array associated with the backref magic.
4354 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4358 if (SvTYPE(tsv) == SVt_PVHV) {
4359 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4363 /* There is no AV in the offical place - try a fixup. */
4364 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4367 /* Aha. They've got it stowed in magic. Bring it back. */
4368 av = (AV*)mg->mg_obj;
4369 /* Stop mg_free decreasing the refernce count. */
4371 /* Stop mg_free even calling the destructor, given that
4372 there's no AV to free up. */
4374 sv_unmagic(tsv, PERL_MAGIC_backref);
4383 const MAGIC *const mg
4384 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4386 av = (AV*)mg->mg_obj;
4390 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4391 /* av now has a refcnt of 2, which avoids it getting freed
4392 * before us during global cleanup. The extra ref is removed
4393 * by magic_killbackrefs() when tsv is being freed */
4396 if (AvFILLp(av) >= AvMAX(av)) {
4397 av_extend(av, AvFILLp(av)+1);
4399 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4402 /* delete a back-reference to ourselves from the backref magic associated
4403 * with the SV we point to.
4407 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4413 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4414 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4415 /* We mustn't attempt to "fix up" the hash here by moving the
4416 backreference array back to the hv_aux structure, as that is stored
4417 in the main HvARRAY(), and hfreentries assumes that no-one
4418 reallocates HvARRAY() while it is running. */
4421 const MAGIC *const mg
4422 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4424 av = (AV *)mg->mg_obj;
4427 if (PL_in_clean_all)
4429 Perl_croak(aTHX_ "panic: del_backref");
4436 /* We shouldn't be in here more than once, but for paranoia reasons lets
4438 for (i = AvFILLp(av); i >= 0; i--) {
4440 const SSize_t fill = AvFILLp(av);
4442 /* We weren't the last entry.
4443 An unordered list has this property that you can take the
4444 last element off the end to fill the hole, and it's still
4445 an unordered list :-)
4450 AvFILLp(av) = fill - 1;
4456 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4458 SV **svp = AvARRAY(av);
4460 PERL_UNUSED_ARG(sv);
4462 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4463 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4464 if (svp && !SvIS_FREED(av)) {
4465 SV *const *const last = svp + AvFILLp(av);
4467 while (svp <= last) {
4469 SV *const referrer = *svp;
4470 if (SvWEAKREF(referrer)) {
4471 /* XXX Should we check that it hasn't changed? */
4472 SvRV_set(referrer, 0);
4474 SvWEAKREF_off(referrer);
4475 } else if (SvTYPE(referrer) == SVt_PVGV ||
4476 SvTYPE(referrer) == SVt_PVLV) {
4477 /* You lookin' at me? */
4478 assert(GvSTASH(referrer));
4479 assert(GvSTASH(referrer) == (HV*)sv);
4480 GvSTASH(referrer) = 0;
4483 "panic: magic_killbackrefs (flags=%"UVxf")",
4484 (UV)SvFLAGS(referrer));
4492 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4497 =for apidoc sv_insert
4499 Inserts a string at the specified offset/length within the SV. Similar to
4500 the Perl substr() function.
4506 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4510 register char *midend;
4511 register char *bigend;
4517 Perl_croak(aTHX_ "Can't modify non-existent substring");
4518 SvPV_force(bigstr, curlen);
4519 (void)SvPOK_only_UTF8(bigstr);
4520 if (offset + len > curlen) {
4521 SvGROW(bigstr, offset+len+1);
4522 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4523 SvCUR_set(bigstr, offset+len);
4527 i = littlelen - len;
4528 if (i > 0) { /* string might grow */
4529 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4530 mid = big + offset + len;
4531 midend = bigend = big + SvCUR(bigstr);
4534 while (midend > mid) /* shove everything down */
4535 *--bigend = *--midend;
4536 Move(little,big+offset,littlelen,char);
4537 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4542 Move(little,SvPVX(bigstr)+offset,len,char);
4547 big = SvPVX(bigstr);
4550 bigend = big + SvCUR(bigstr);
4552 if (midend > bigend)
4553 Perl_croak(aTHX_ "panic: sv_insert");
4555 if (mid - big > bigend - midend) { /* faster to shorten from end */
4557 Move(little, mid, littlelen,char);
4560 i = bigend - midend;
4562 Move(midend, mid, i,char);
4566 SvCUR_set(bigstr, mid - big);
4568 else if ((i = mid - big)) { /* faster from front */
4569 midend -= littlelen;
4571 sv_chop(bigstr,midend-i);
4576 Move(little, mid, littlelen,char);
4578 else if (littlelen) {
4579 midend -= littlelen;
4580 sv_chop(bigstr,midend);
4581 Move(little,midend,littlelen,char);
4584 sv_chop(bigstr,midend);
4590 =for apidoc sv_replace
4592 Make the first argument a copy of the second, then delete the original.
4593 The target SV physically takes over ownership of the body of the source SV
4594 and inherits its flags; however, the target keeps any magic it owns,
4595 and any magic in the source is discarded.
4596 Note that this is a rather specialist SV copying operation; most of the
4597 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4603 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4605 const U32 refcnt = SvREFCNT(sv);
4606 SV_CHECK_THINKFIRST_COW_DROP(sv);
4607 if (SvREFCNT(nsv) != 1) {
4608 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4609 UVuf " != 1)", (UV) SvREFCNT(nsv));
4611 if (SvMAGICAL(sv)) {
4615 sv_upgrade(nsv, SVt_PVMG);
4616 SvMAGIC_set(nsv, SvMAGIC(sv));
4617 SvFLAGS(nsv) |= SvMAGICAL(sv);
4619 SvMAGIC_set(sv, NULL);
4623 assert(!SvREFCNT(sv));
4624 #ifdef DEBUG_LEAKING_SCALARS
4625 sv->sv_flags = nsv->sv_flags;
4626 sv->sv_any = nsv->sv_any;
4627 sv->sv_refcnt = nsv->sv_refcnt;
4628 sv->sv_u = nsv->sv_u;
4630 StructCopy(nsv,sv,SV);
4632 /* Currently could join these into one piece of pointer arithmetic, but
4633 it would be unclear. */
4634 if(SvTYPE(sv) == SVt_IV)
4636 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4637 else if (SvTYPE(sv) == SVt_RV) {
4638 SvANY(sv) = &sv->sv_u.svu_rv;
4642 #ifdef PERL_OLD_COPY_ON_WRITE
4643 if (SvIsCOW_normal(nsv)) {
4644 /* We need to follow the pointers around the loop to make the
4645 previous SV point to sv, rather than nsv. */
4648 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4651 assert(SvPVX_const(current) == SvPVX_const(nsv));
4653 /* Make the SV before us point to the SV after us. */
4655 PerlIO_printf(Perl_debug_log, "previous is\n");
4657 PerlIO_printf(Perl_debug_log,
4658 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4659 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4661 SV_COW_NEXT_SV_SET(current, sv);
4664 SvREFCNT(sv) = refcnt;
4665 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4671 =for apidoc sv_clear
4673 Clear an SV: call any destructors, free up any memory used by the body,
4674 and free the body itself. The SV's head is I<not> freed, although
4675 its type is set to all 1's so that it won't inadvertently be assumed
4676 to be live during global destruction etc.
4677 This function should only be called when REFCNT is zero. Most of the time
4678 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4685 Perl_sv_clear(pTHX_ register SV *sv)
4688 const U32 type = SvTYPE(sv);
4689 const struct body_details *const sv_type_details
4690 = bodies_by_type + type;
4693 assert(SvREFCNT(sv) == 0);
4699 if (PL_defstash) { /* Still have a symbol table? */
4704 stash = SvSTASH(sv);
4705 destructor = StashHANDLER(stash,DESTROY);
4707 SV* const tmpref = newRV(sv);
4708 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4710 PUSHSTACKi(PERLSI_DESTROY);
4715 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4721 if(SvREFCNT(tmpref) < 2) {
4722 /* tmpref is not kept alive! */
4724 SvRV_set(tmpref, NULL);
4727 SvREFCNT_dec(tmpref);
4729 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4733 if (PL_in_clean_objs)
4734 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4736 /* DESTROY gave object new lease on life */
4742 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4743 SvOBJECT_off(sv); /* Curse the object. */
4744 if (type != SVt_PVIO)
4745 --PL_sv_objcount; /* XXX Might want something more general */
4748 if (type >= SVt_PVMG) {
4751 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4752 SvREFCNT_dec(SvSTASH(sv));
4757 IoIFP(sv) != PerlIO_stdin() &&
4758 IoIFP(sv) != PerlIO_stdout() &&
4759 IoIFP(sv) != PerlIO_stderr())
4761 io_close((IO*)sv, FALSE);
4763 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4764 PerlDir_close(IoDIRP(sv));
4765 IoDIRP(sv) = (DIR*)NULL;
4766 Safefree(IoTOP_NAME(sv));
4767 Safefree(IoFMT_NAME(sv));
4768 Safefree(IoBOTTOM_NAME(sv));
4777 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4784 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4785 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4786 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4787 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4789 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4790 SvREFCNT_dec(LvTARG(sv));
4794 Safefree(GvNAME(sv));
4795 /* If we're in a stash, we don't own a reference to it. However it does
4796 have a back reference to us, which needs to be cleared. */
4798 sv_del_backref((SV*)GvSTASH(sv), sv);
4803 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4805 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4806 /* Don't even bother with turning off the OOK flag. */
4811 SV *target = SvRV(sv);
4813 sv_del_backref(target, sv);
4815 SvREFCNT_dec(target);
4817 #ifdef PERL_OLD_COPY_ON_WRITE
4818 else if (SvPVX_const(sv)) {
4820 /* I believe I need to grab the global SV mutex here and
4821 then recheck the COW status. */
4823 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4826 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4827 SV_COW_NEXT_SV(sv));
4828 /* And drop it here. */
4830 } else if (SvLEN(sv)) {
4831 Safefree(SvPVX_const(sv));
4835 else if (SvPVX_const(sv) && SvLEN(sv))
4836 Safefree(SvPVX_mutable(sv));
4837 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4838 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4847 SvFLAGS(sv) &= SVf_BREAK;
4848 SvFLAGS(sv) |= SVTYPEMASK;
4850 if (sv_type_details->arena) {
4851 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4852 &PL_body_roots[type]);
4854 else if (sv_type_details->size) {
4855 my_safefree(SvANY(sv));
4860 =for apidoc sv_newref
4862 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4869 Perl_sv_newref(pTHX_ SV *sv)
4879 Decrement an SV's reference count, and if it drops to zero, call
4880 C<sv_clear> to invoke destructors and free up any memory used by
4881 the body; finally, deallocate the SV's head itself.
4882 Normally called via a wrapper macro C<SvREFCNT_dec>.
4888 Perl_sv_free(pTHX_ SV *sv)
4893 if (SvREFCNT(sv) == 0) {
4894 if (SvFLAGS(sv) & SVf_BREAK)
4895 /* this SV's refcnt has been artificially decremented to
4896 * trigger cleanup */
4898 if (PL_in_clean_all) /* All is fair */
4900 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4901 /* make sure SvREFCNT(sv)==0 happens very seldom */
4902 SvREFCNT(sv) = (~(U32)0)/2;
4905 if (ckWARN_d(WARN_INTERNAL)) {
4906 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4907 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4908 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4909 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4910 Perl_dump_sv_child(aTHX_ sv);
4915 if (--(SvREFCNT(sv)) > 0)
4917 Perl_sv_free2(aTHX_ sv);
4921 Perl_sv_free2(pTHX_ SV *sv)
4926 if (ckWARN_d(WARN_DEBUGGING))
4927 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4928 "Attempt to free temp prematurely: SV 0x%"UVxf
4929 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4933 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4934 /* make sure SvREFCNT(sv)==0 happens very seldom */
4935 SvREFCNT(sv) = (~(U32)0)/2;
4946 Returns the length of the string in the SV. Handles magic and type
4947 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4953 Perl_sv_len(pTHX_ register SV *sv)
4961 len = mg_length(sv);
4963 (void)SvPV_const(sv, len);
4968 =for apidoc sv_len_utf8
4970 Returns the number of characters in the string in an SV, counting wide
4971 UTF-8 bytes as a single character. Handles magic and type coercion.
4977 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4978 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4979 * (Note that the mg_len is not the length of the mg_ptr field.)
4984 Perl_sv_len_utf8(pTHX_ register SV *sv)
4990 return mg_length(sv);
4994 const U8 *s = (U8*)SvPV_const(sv, len);
4995 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4997 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4999 #ifdef PERL_UTF8_CACHE_ASSERT
5000 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5004 ulen = Perl_utf8_length(aTHX_ s, s + len);
5005 if (!mg && !SvREADONLY(sv)) {
5006 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5007 mg = mg_find(sv, PERL_MAGIC_utf8);
5017 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5018 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5019 * between UTF-8 and byte offsets. There are two (substr offset and substr
5020 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5021 * and byte offset) cache positions.
5023 * The mg_len field is used by sv_len_utf8(), see its comments.
5024 * Note that the mg_len is not the length of the mg_ptr field.
5028 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5029 I32 offsetp, const U8 *s, const U8 *start)
5033 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5035 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5039 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5041 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5042 (*mgp)->mg_ptr = (char *) *cachep;
5046 (*cachep)[i] = offsetp;
5047 (*cachep)[i+1] = s - start;
5055 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5056 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5057 * between UTF-8 and byte offsets. See also the comments of
5058 * S_utf8_mg_pos_init().
5062 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)
5066 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5068 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5069 if (*mgp && (*mgp)->mg_ptr) {
5070 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5071 ASSERT_UTF8_CACHE(*cachep);
5072 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5074 else { /* We will skip to the right spot. */
5079 /* The assumption is that going backward is half
5080 * the speed of going forward (that's where the
5081 * 2 * backw in the below comes from). (The real
5082 * figure of course depends on the UTF-8 data.) */
5084 if ((*cachep)[i] > (STRLEN)uoff) {
5086 backw = (*cachep)[i] - (STRLEN)uoff;
5088 if (forw < 2 * backw)
5091 p = start + (*cachep)[i+1];
5093 /* Try this only for the substr offset (i == 0),
5094 * not for the substr length (i == 2). */
5095 else if (i == 0) { /* (*cachep)[i] < uoff */
5096 const STRLEN ulen = sv_len_utf8(sv);
5098 if ((STRLEN)uoff < ulen) {
5099 forw = (STRLEN)uoff - (*cachep)[i];
5100 backw = ulen - (STRLEN)uoff;
5102 if (forw < 2 * backw)
5103 p = start + (*cachep)[i+1];
5108 /* If the string is not long enough for uoff,
5109 * we could extend it, but not at this low a level. */
5113 if (forw < 2 * backw) {
5120 while (UTF8_IS_CONTINUATION(*p))
5125 /* Update the cache. */
5126 (*cachep)[i] = (STRLEN)uoff;
5127 (*cachep)[i+1] = p - start;
5129 /* Drop the stale "length" cache */
5138 if (found) { /* Setup the return values. */
5139 *offsetp = (*cachep)[i+1];
5140 *sp = start + *offsetp;
5143 *offsetp = send - start;
5145 else if (*sp < start) {
5151 #ifdef PERL_UTF8_CACHE_ASSERT
5156 while (n-- && s < send)
5160 assert(*offsetp == s - start);
5161 assert((*cachep)[0] == (STRLEN)uoff);
5162 assert((*cachep)[1] == *offsetp);
5164 ASSERT_UTF8_CACHE(*cachep);
5173 =for apidoc sv_pos_u2b
5175 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5176 the start of the string, to a count of the equivalent number of bytes; if
5177 lenp is non-zero, it does the same to lenp, but this time starting from
5178 the offset, rather than from the start of the string. Handles magic and
5185 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5186 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5187 * byte offsets. See also the comments of S_utf8_mg_pos().
5192 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5200 start = (U8*)SvPV_const(sv, len);
5203 STRLEN *cache = NULL;
5204 const U8 *s = start;
5205 I32 uoffset = *offsetp;
5206 const U8 * const send = s + len;
5208 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5210 if (!found && uoffset > 0) {
5211 while (s < send && uoffset--)
5215 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5217 *offsetp = s - start;
5222 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5226 if (!found && *lenp > 0) {
5229 while (s < send && ulen--)
5233 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5237 ASSERT_UTF8_CACHE(cache);
5249 =for apidoc sv_pos_b2u
5251 Converts the value pointed to by offsetp from a count of bytes from the
5252 start of the string, to a count of the equivalent number of UTF-8 chars.
5253 Handles magic and type coercion.
5259 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5260 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5261 * byte offsets. See also the comments of S_utf8_mg_pos().
5266 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5274 s = (const U8*)SvPV_const(sv, len);
5275 if ((I32)len < *offsetp)
5276 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5278 const U8* send = s + *offsetp;
5280 STRLEN *cache = NULL;
5284 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5285 mg = mg_find(sv, PERL_MAGIC_utf8);
5286 if (mg && mg->mg_ptr) {
5287 cache = (STRLEN *) mg->mg_ptr;
5288 if (cache[1] == (STRLEN)*offsetp) {
5289 /* An exact match. */
5290 *offsetp = cache[0];
5294 else if (cache[1] < (STRLEN)*offsetp) {
5295 /* We already know part of the way. */
5298 /* Let the below loop do the rest. */
5300 else { /* cache[1] > *offsetp */
5301 /* We already know all of the way, now we may
5302 * be able to walk back. The same assumption
5303 * is made as in S_utf8_mg_pos(), namely that
5304 * walking backward is twice slower than
5305 * walking forward. */
5306 const STRLEN forw = *offsetp;
5307 STRLEN backw = cache[1] - *offsetp;
5309 if (!(forw < 2 * backw)) {
5310 const U8 *p = s + cache[1];
5317 while (UTF8_IS_CONTINUATION(*p)) {
5325 *offsetp = cache[0];
5327 /* Drop the stale "length" cache */
5335 ASSERT_UTF8_CACHE(cache);
5341 /* Call utf8n_to_uvchr() to validate the sequence
5342 * (unless a simple non-UTF character) */
5343 if (!UTF8_IS_INVARIANT(*s))
5344 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5353 if (!SvREADONLY(sv)) {
5355 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5356 mg = mg_find(sv, PERL_MAGIC_utf8);
5361 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5362 mg->mg_ptr = (char *) cache;
5367 cache[1] = *offsetp;
5368 /* Drop the stale "length" cache */
5381 Returns a boolean indicating whether the strings in the two SVs are
5382 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5383 coerce its args to strings if necessary.
5389 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5397 SV* svrecode = Nullsv;
5404 pv1 = SvPV_const(sv1, cur1);
5411 pv2 = SvPV_const(sv2, cur2);
5413 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5414 /* Differing utf8ness.
5415 * Do not UTF8size the comparands as a side-effect. */
5418 svrecode = newSVpvn(pv2, cur2);
5419 sv_recode_to_utf8(svrecode, PL_encoding);
5420 pv2 = SvPV_const(svrecode, cur2);
5423 svrecode = newSVpvn(pv1, cur1);
5424 sv_recode_to_utf8(svrecode, PL_encoding);
5425 pv1 = SvPV_const(svrecode, cur1);
5427 /* Now both are in UTF-8. */
5429 SvREFCNT_dec(svrecode);
5434 bool is_utf8 = TRUE;
5437 /* sv1 is the UTF-8 one,
5438 * if is equal it must be downgrade-able */
5439 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5445 /* sv2 is the UTF-8 one,
5446 * if is equal it must be downgrade-able */
5447 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5453 /* Downgrade not possible - cannot be eq */
5461 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5464 SvREFCNT_dec(svrecode);
5475 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5476 string in C<sv1> is less than, equal to, or greater than the string in
5477 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5478 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5484 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5487 const char *pv1, *pv2;
5490 SV *svrecode = Nullsv;
5497 pv1 = SvPV_const(sv1, cur1);
5504 pv2 = SvPV_const(sv2, cur2);
5506 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5507 /* Differing utf8ness.
5508 * Do not UTF8size the comparands as a side-effect. */
5511 svrecode = newSVpvn(pv2, cur2);
5512 sv_recode_to_utf8(svrecode, PL_encoding);
5513 pv2 = SvPV_const(svrecode, cur2);
5516 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5521 svrecode = newSVpvn(pv1, cur1);
5522 sv_recode_to_utf8(svrecode, PL_encoding);
5523 pv1 = SvPV_const(svrecode, cur1);
5526 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5532 cmp = cur2 ? -1 : 0;
5536 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5539 cmp = retval < 0 ? -1 : 1;
5540 } else if (cur1 == cur2) {
5543 cmp = cur1 < cur2 ? -1 : 1;
5548 SvREFCNT_dec(svrecode);
5557 =for apidoc sv_cmp_locale
5559 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5560 'use bytes' aware, handles get magic, and will coerce its args to strings
5561 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5567 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5569 #ifdef USE_LOCALE_COLLATE
5575 if (PL_collation_standard)
5579 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5581 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5583 if (!pv1 || !len1) {
5594 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5597 return retval < 0 ? -1 : 1;
5600 * When the result of collation is equality, that doesn't mean
5601 * that there are no differences -- some locales exclude some
5602 * characters from consideration. So to avoid false equalities,
5603 * we use the raw string as a tiebreaker.
5609 #endif /* USE_LOCALE_COLLATE */
5611 return sv_cmp(sv1, sv2);
5615 #ifdef USE_LOCALE_COLLATE
5618 =for apidoc sv_collxfrm
5620 Add Collate Transform magic to an SV if it doesn't already have it.
5622 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5623 scalar data of the variable, but transformed to such a format that a normal
5624 memory comparison can be used to compare the data according to the locale
5631 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5635 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5636 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5642 Safefree(mg->mg_ptr);
5643 s = SvPV_const(sv, len);
5644 if ((xf = mem_collxfrm(s, len, &xlen))) {
5645 if (SvREADONLY(sv)) {
5648 return xf + sizeof(PL_collation_ix);
5651 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5652 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5665 if (mg && mg->mg_ptr) {
5667 return mg->mg_ptr + sizeof(PL_collation_ix);
5675 #endif /* USE_LOCALE_COLLATE */
5680 Get a line from the filehandle and store it into the SV, optionally
5681 appending to the currently-stored string.
5687 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5691 register STDCHAR rslast;
5692 register STDCHAR *bp;
5698 if (SvTHINKFIRST(sv))
5699 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5700 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5702 However, perlbench says it's slower, because the existing swipe code
5703 is faster than copy on write.
5704 Swings and roundabouts. */
5705 SvUPGRADE(sv, SVt_PV);
5710 if (PerlIO_isutf8(fp)) {
5712 sv_utf8_upgrade_nomg(sv);
5713 sv_pos_u2b(sv,&append,0);
5715 } else if (SvUTF8(sv)) {
5716 SV * const tsv = NEWSV(0,0);
5717 sv_gets(tsv, fp, 0);
5718 sv_utf8_upgrade_nomg(tsv);
5719 SvCUR_set(sv,append);
5722 goto return_string_or_null;
5727 if (PerlIO_isutf8(fp))
5730 if (IN_PERL_COMPILETIME) {
5731 /* we always read code in line mode */
5735 else if (RsSNARF(PL_rs)) {
5736 /* If it is a regular disk file use size from stat() as estimate
5737 of amount we are going to read - may result in malloc-ing
5738 more memory than we realy need if layers bellow reduce
5739 size we read (e.g. CRLF or a gzip layer)
5742 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5743 const Off_t offset = PerlIO_tell(fp);
5744 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5745 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5751 else if (RsRECORD(PL_rs)) {
5755 /* Grab the size of the record we're getting */
5756 recsize = SvIV(SvRV(PL_rs));
5757 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5760 /* VMS wants read instead of fread, because fread doesn't respect */
5761 /* RMS record boundaries. This is not necessarily a good thing to be */
5762 /* doing, but we've got no other real choice - except avoid stdio
5763 as implementation - perhaps write a :vms layer ?
5765 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5767 bytesread = PerlIO_read(fp, buffer, recsize);
5771 SvCUR_set(sv, bytesread += append);
5772 buffer[bytesread] = '\0';
5773 goto return_string_or_null;
5775 else if (RsPARA(PL_rs)) {
5781 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5782 if (PerlIO_isutf8(fp)) {
5783 rsptr = SvPVutf8(PL_rs, rslen);
5786 if (SvUTF8(PL_rs)) {
5787 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5788 Perl_croak(aTHX_ "Wide character in $/");
5791 rsptr = SvPV_const(PL_rs, rslen);
5795 rslast = rslen ? rsptr[rslen - 1] : '\0';
5797 if (rspara) { /* have to do this both before and after */
5798 do { /* to make sure file boundaries work right */
5801 i = PerlIO_getc(fp);
5805 PerlIO_ungetc(fp,i);
5811 /* See if we know enough about I/O mechanism to cheat it ! */
5813 /* This used to be #ifdef test - it is made run-time test for ease
5814 of abstracting out stdio interface. One call should be cheap
5815 enough here - and may even be a macro allowing compile
5819 if (PerlIO_fast_gets(fp)) {
5822 * We're going to steal some values from the stdio struct
5823 * and put EVERYTHING in the innermost loop into registers.
5825 register STDCHAR *ptr;
5829 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5830 /* An ungetc()d char is handled separately from the regular
5831 * buffer, so we getc() it back out and stuff it in the buffer.
5833 i = PerlIO_getc(fp);
5834 if (i == EOF) return 0;
5835 *(--((*fp)->_ptr)) = (unsigned char) i;
5839 /* Here is some breathtakingly efficient cheating */
5841 cnt = PerlIO_get_cnt(fp); /* get count into register */
5842 /* make sure we have the room */
5843 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5844 /* Not room for all of it
5845 if we are looking for a separator and room for some
5847 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5848 /* just process what we have room for */
5849 shortbuffered = cnt - SvLEN(sv) + append + 1;
5850 cnt -= shortbuffered;
5854 /* remember that cnt can be negative */
5855 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5860 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5861 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5862 DEBUG_P(PerlIO_printf(Perl_debug_log,
5863 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5864 DEBUG_P(PerlIO_printf(Perl_debug_log,
5865 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5866 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5867 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5872 while (cnt > 0) { /* this | eat */
5874 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5875 goto thats_all_folks; /* screams | sed :-) */
5879 Copy(ptr, bp, cnt, char); /* this | eat */
5880 bp += cnt; /* screams | dust */
5881 ptr += cnt; /* louder | sed :-) */
5886 if (shortbuffered) { /* oh well, must extend */
5887 cnt = shortbuffered;
5889 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5891 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5892 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5896 DEBUG_P(PerlIO_printf(Perl_debug_log,
5897 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5898 PTR2UV(ptr),(long)cnt));
5899 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5901 DEBUG_P(PerlIO_printf(Perl_debug_log,
5902 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5903 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5904 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5906 /* This used to call 'filbuf' in stdio form, but as that behaves like
5907 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5908 another abstraction. */
5909 i = PerlIO_getc(fp); /* get more characters */
5911 DEBUG_P(PerlIO_printf(Perl_debug_log,
5912 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5913 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5914 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5916 cnt = PerlIO_get_cnt(fp);
5917 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5918 DEBUG_P(PerlIO_printf(Perl_debug_log,
5919 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5921 if (i == EOF) /* all done for ever? */
5922 goto thats_really_all_folks;
5924 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5926 SvGROW(sv, bpx + cnt + 2);
5927 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5929 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5931 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5932 goto thats_all_folks;
5936 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5937 memNE((char*)bp - rslen, rsptr, rslen))
5938 goto screamer; /* go back to the fray */
5939 thats_really_all_folks:
5941 cnt += shortbuffered;
5942 DEBUG_P(PerlIO_printf(Perl_debug_log,
5943 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5944 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5945 DEBUG_P(PerlIO_printf(Perl_debug_log,
5946 "Screamer: end: 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 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5951 DEBUG_P(PerlIO_printf(Perl_debug_log,
5952 "Screamer: done, len=%ld, string=|%.*s|\n",
5953 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5957 /*The big, slow, and stupid way. */
5958 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5959 STDCHAR *buf = NULL;
5960 Newx(buf, 8192, STDCHAR);
5968 register const STDCHAR * const bpe = buf + sizeof(buf);
5970 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5971 ; /* keep reading */
5975 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5976 /* Accomodate broken VAXC compiler, which applies U8 cast to
5977 * both args of ?: operator, causing EOF to change into 255
5980 i = (U8)buf[cnt - 1];
5986 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5988 sv_catpvn(sv, (char *) buf, cnt);
5990 sv_setpvn(sv, (char *) buf, cnt);
5992 if (i != EOF && /* joy */
5994 SvCUR(sv) < rslen ||
5995 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5999 * If we're reading from a TTY and we get a short read,
6000 * indicating that the user hit his EOF character, we need
6001 * to notice it now, because if we try to read from the TTY
6002 * again, the EOF condition will disappear.
6004 * The comparison of cnt to sizeof(buf) is an optimization
6005 * that prevents unnecessary calls to feof().
6009 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6013 #ifdef USE_HEAP_INSTEAD_OF_STACK
6018 if (rspara) { /* have to do this both before and after */
6019 while (i != EOF) { /* to make sure file boundaries work right */
6020 i = PerlIO_getc(fp);
6022 PerlIO_ungetc(fp,i);
6028 return_string_or_null:
6029 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6035 Auto-increment of the value in the SV, doing string to numeric conversion
6036 if necessary. Handles 'get' magic.
6042 Perl_sv_inc(pTHX_ register SV *sv)
6050 if (SvTHINKFIRST(sv)) {
6052 sv_force_normal_flags(sv, 0);
6053 if (SvREADONLY(sv)) {
6054 if (IN_PERL_RUNTIME)
6055 Perl_croak(aTHX_ PL_no_modify);
6059 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6061 i = PTR2IV(SvRV(sv));
6066 flags = SvFLAGS(sv);
6067 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6068 /* It's (privately or publicly) a float, but not tested as an
6069 integer, so test it to see. */
6071 flags = SvFLAGS(sv);
6073 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6074 /* It's publicly an integer, or privately an integer-not-float */
6075 #ifdef PERL_PRESERVE_IVUV
6079 if (SvUVX(sv) == UV_MAX)
6080 sv_setnv(sv, UV_MAX_P1);
6082 (void)SvIOK_only_UV(sv);
6083 SvUV_set(sv, SvUVX(sv) + 1);
6085 if (SvIVX(sv) == IV_MAX)
6086 sv_setuv(sv, (UV)IV_MAX + 1);
6088 (void)SvIOK_only(sv);
6089 SvIV_set(sv, SvIVX(sv) + 1);
6094 if (flags & SVp_NOK) {
6095 (void)SvNOK_only(sv);
6096 SvNV_set(sv, SvNVX(sv) + 1.0);
6100 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6101 if ((flags & SVTYPEMASK) < SVt_PVIV)
6102 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6103 (void)SvIOK_only(sv);
6108 while (isALPHA(*d)) d++;
6109 while (isDIGIT(*d)) d++;
6111 #ifdef PERL_PRESERVE_IVUV
6112 /* Got to punt this as an integer if needs be, but we don't issue
6113 warnings. Probably ought to make the sv_iv_please() that does
6114 the conversion if possible, and silently. */
6115 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6116 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6117 /* Need to try really hard to see if it's an integer.
6118 9.22337203685478e+18 is an integer.
6119 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6120 so $a="9.22337203685478e+18"; $a+0; $a++
6121 needs to be the same as $a="9.22337203685478e+18"; $a++
6128 /* sv_2iv *should* have made this an NV */
6129 if (flags & SVp_NOK) {
6130 (void)SvNOK_only(sv);
6131 SvNV_set(sv, SvNVX(sv) + 1.0);
6134 /* I don't think we can get here. Maybe I should assert this
6135 And if we do get here I suspect that sv_setnv will croak. NWC
6137 #if defined(USE_LONG_DOUBLE)
6138 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",
6139 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6141 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6142 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6145 #endif /* PERL_PRESERVE_IVUV */
6146 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6150 while (d >= SvPVX_const(sv)) {
6158 /* MKS: The original code here died if letters weren't consecutive.
6159 * at least it didn't have to worry about non-C locales. The
6160 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6161 * arranged in order (although not consecutively) and that only
6162 * [A-Za-z] are accepted by isALPHA in the C locale.
6164 if (*d != 'z' && *d != 'Z') {
6165 do { ++*d; } while (!isALPHA(*d));
6168 *(d--) -= 'z' - 'a';
6173 *(d--) -= 'z' - 'a' + 1;
6177 /* oh,oh, the number grew */
6178 SvGROW(sv, SvCUR(sv) + 2);
6179 SvCUR_set(sv, SvCUR(sv) + 1);
6180 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6191 Auto-decrement of the value in the SV, doing string to numeric conversion
6192 if necessary. Handles 'get' magic.
6198 Perl_sv_dec(pTHX_ register SV *sv)
6205 if (SvTHINKFIRST(sv)) {
6207 sv_force_normal_flags(sv, 0);
6208 if (SvREADONLY(sv)) {
6209 if (IN_PERL_RUNTIME)
6210 Perl_croak(aTHX_ PL_no_modify);
6214 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6216 i = PTR2IV(SvRV(sv));
6221 /* Unlike sv_inc we don't have to worry about string-never-numbers
6222 and keeping them magic. But we mustn't warn on punting */
6223 flags = SvFLAGS(sv);
6224 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6225 /* It's publicly an integer, or privately an integer-not-float */
6226 #ifdef PERL_PRESERVE_IVUV
6230 if (SvUVX(sv) == 0) {
6231 (void)SvIOK_only(sv);
6235 (void)SvIOK_only_UV(sv);
6236 SvUV_set(sv, SvUVX(sv) - 1);
6239 if (SvIVX(sv) == IV_MIN)
6240 sv_setnv(sv, (NV)IV_MIN - 1.0);
6242 (void)SvIOK_only(sv);
6243 SvIV_set(sv, SvIVX(sv) - 1);
6248 if (flags & SVp_NOK) {
6249 SvNV_set(sv, SvNVX(sv) - 1.0);
6250 (void)SvNOK_only(sv);
6253 if (!(flags & SVp_POK)) {
6254 if ((flags & SVTYPEMASK) < SVt_PVIV)
6255 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6257 (void)SvIOK_only(sv);
6260 #ifdef PERL_PRESERVE_IVUV
6262 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6263 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6264 /* Need to try really hard to see if it's an integer.
6265 9.22337203685478e+18 is an integer.
6266 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6267 so $a="9.22337203685478e+18"; $a+0; $a--
6268 needs to be the same as $a="9.22337203685478e+18"; $a--
6275 /* sv_2iv *should* have made this an NV */
6276 if (flags & SVp_NOK) {
6277 (void)SvNOK_only(sv);
6278 SvNV_set(sv, SvNVX(sv) - 1.0);
6281 /* I don't think we can get here. Maybe I should assert this
6282 And if we do get here I suspect that sv_setnv will croak. NWC
6284 #if defined(USE_LONG_DOUBLE)
6285 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",
6286 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6288 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6289 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6293 #endif /* PERL_PRESERVE_IVUV */
6294 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6298 =for apidoc sv_mortalcopy
6300 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6301 The new SV is marked as mortal. It will be destroyed "soon", either by an
6302 explicit call to FREETMPS, or by an implicit call at places such as
6303 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6308 /* Make a string that will exist for the duration of the expression
6309 * evaluation. Actually, it may have to last longer than that, but
6310 * hopefully we won't free it until it has been assigned to a
6311 * permanent location. */
6314 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6319 sv_setsv(sv,oldstr);
6321 PL_tmps_stack[++PL_tmps_ix] = sv;
6327 =for apidoc sv_newmortal
6329 Creates a new null SV which is mortal. The reference count of the SV is
6330 set to 1. It will be destroyed "soon", either by an explicit call to
6331 FREETMPS, or by an implicit call at places such as statement boundaries.
6332 See also C<sv_mortalcopy> and C<sv_2mortal>.
6338 Perl_sv_newmortal(pTHX)
6343 SvFLAGS(sv) = SVs_TEMP;
6345 PL_tmps_stack[++PL_tmps_ix] = sv;
6350 =for apidoc sv_2mortal
6352 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6353 by an explicit call to FREETMPS, or by an implicit call at places such as
6354 statement boundaries. SvTEMP() is turned on which means that the SV's
6355 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6356 and C<sv_mortalcopy>.
6362 Perl_sv_2mortal(pTHX_ register SV *sv)
6367 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6370 PL_tmps_stack[++PL_tmps_ix] = sv;
6378 Creates a new SV and copies a string into it. The reference count for the
6379 SV is set to 1. If C<len> is zero, Perl will compute the length using
6380 strlen(). For efficiency, consider using C<newSVpvn> instead.
6386 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6391 sv_setpvn(sv,s,len ? len : strlen(s));
6396 =for apidoc newSVpvn
6398 Creates a new SV and copies a string into it. The reference count for the
6399 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6400 string. You are responsible for ensuring that the source string is at least
6401 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6407 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6412 sv_setpvn(sv,s,len);
6418 =for apidoc newSVhek
6420 Creates a new SV from the hash key structure. It will generate scalars that
6421 point to the shared string table where possible. Returns a new (undefined)
6422 SV if the hek is NULL.
6428 Perl_newSVhek(pTHX_ const HEK *hek)
6437 if (HEK_LEN(hek) == HEf_SVKEY) {
6438 return newSVsv(*(SV**)HEK_KEY(hek));
6440 const int flags = HEK_FLAGS(hek);
6441 if (flags & HVhek_WASUTF8) {
6443 Andreas would like keys he put in as utf8 to come back as utf8
6445 STRLEN utf8_len = HEK_LEN(hek);
6446 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6447 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6450 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6452 } else if (flags & HVhek_REHASH) {
6453 /* We don't have a pointer to the hv, so we have to replicate the
6454 flag into every HEK. This hv is using custom a hasing
6455 algorithm. Hence we can't return a shared string scalar, as
6456 that would contain the (wrong) hash value, and might get passed
6457 into an hv routine with a regular hash */
6459 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6464 /* This will be overwhelminly the most common case. */
6465 return newSVpvn_share(HEK_KEY(hek),
6466 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6472 =for apidoc newSVpvn_share
6474 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6475 table. If the string does not already exist in the table, it is created
6476 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6477 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6478 otherwise the hash is computed. The idea here is that as the string table
6479 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6480 hash lookup will avoid string compare.
6486 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6489 bool is_utf8 = FALSE;
6491 STRLEN tmplen = -len;
6493 /* See the note in hv.c:hv_fetch() --jhi */
6494 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6498 PERL_HASH(hash, src, len);
6500 sv_upgrade(sv, SVt_PV);
6501 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6513 #if defined(PERL_IMPLICIT_CONTEXT)
6515 /* pTHX_ magic can't cope with varargs, so this is a no-context
6516 * version of the main function, (which may itself be aliased to us).
6517 * Don't access this version directly.
6521 Perl_newSVpvf_nocontext(const char* pat, ...)
6526 va_start(args, pat);
6527 sv = vnewSVpvf(pat, &args);
6534 =for apidoc newSVpvf
6536 Creates a new SV and initializes it with the string formatted like
6543 Perl_newSVpvf(pTHX_ const char* pat, ...)
6547 va_start(args, pat);
6548 sv = vnewSVpvf(pat, &args);
6553 /* backend for newSVpvf() and newSVpvf_nocontext() */
6556 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6560 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6567 Creates a new SV and copies a floating point value into it.
6568 The reference count for the SV is set to 1.
6574 Perl_newSVnv(pTHX_ NV n)
6586 Creates a new SV and copies an integer into it. The reference count for the
6593 Perl_newSViv(pTHX_ IV i)
6605 Creates a new SV and copies an unsigned integer into it.
6606 The reference count for the SV is set to 1.
6612 Perl_newSVuv(pTHX_ UV u)
6622 =for apidoc newRV_noinc
6624 Creates an RV wrapper for an SV. The reference count for the original
6625 SV is B<not> incremented.
6631 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6636 sv_upgrade(sv, SVt_RV);
6638 SvRV_set(sv, tmpRef);
6643 /* newRV_inc is the official function name to use now.
6644 * newRV_inc is in fact #defined to newRV in sv.h
6648 Perl_newRV(pTHX_ SV *tmpRef)
6650 return newRV_noinc(SvREFCNT_inc(tmpRef));
6656 Creates a new SV which is an exact duplicate of the original SV.
6663 Perl_newSVsv(pTHX_ register SV *old)
6669 if (SvTYPE(old) == SVTYPEMASK) {
6670 if (ckWARN_d(WARN_INTERNAL))
6671 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6675 /* SV_GMAGIC is the default for sv_setv()
6676 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6677 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6678 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6683 =for apidoc sv_reset
6685 Underlying implementation for the C<reset> Perl function.
6686 Note that the perl-level function is vaguely deprecated.
6692 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6695 char todo[PERL_UCHAR_MAX+1];
6700 if (!*s) { /* reset ?? searches */
6701 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6703 PMOP *pm = (PMOP *) mg->mg_obj;
6705 pm->op_pmdynflags &= ~PMdf_USED;
6712 /* reset variables */
6714 if (!HvARRAY(stash))
6717 Zero(todo, 256, char);
6720 I32 i = (unsigned char)*s;
6724 max = (unsigned char)*s++;
6725 for ( ; i <= max; i++) {
6728 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6730 for (entry = HvARRAY(stash)[i];
6732 entry = HeNEXT(entry))
6737 if (!todo[(U8)*HeKEY(entry)])
6739 gv = (GV*)HeVAL(entry);
6742 if (SvTHINKFIRST(sv)) {
6743 if (!SvREADONLY(sv) && SvROK(sv))
6745 /* XXX Is this continue a bug? Why should THINKFIRST
6746 exempt us from resetting arrays and hashes? */
6750 if (SvTYPE(sv) >= SVt_PV) {
6752 if (SvPVX_const(sv) != Nullch)
6760 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6762 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6765 # if defined(USE_ENVIRON_ARRAY)
6768 # endif /* USE_ENVIRON_ARRAY */
6779 Using various gambits, try to get an IO from an SV: the IO slot if its a
6780 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6781 named after the PV if we're a string.
6787 Perl_sv_2io(pTHX_ SV *sv)
6792 switch (SvTYPE(sv)) {
6800 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6804 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6806 return sv_2io(SvRV(sv));
6807 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6813 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6822 Using various gambits, try to get a CV from an SV; in addition, try if
6823 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6824 The flags in C<lref> are passed to sv_fetchsv.
6830 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6837 return *st = NULL, *gvp = Nullgv, Nullcv;
6838 switch (SvTYPE(sv)) {
6857 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6858 tryAMAGICunDEREF(to_cv);
6861 if (SvTYPE(sv) == SVt_PVCV) {
6870 Perl_croak(aTHX_ "Not a subroutine reference");
6875 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6881 /* Some flags to gv_fetchsv mean don't really create the GV */
6882 if (SvTYPE(gv) != SVt_PVGV) {
6888 if (lref && !GvCVu(gv)) {
6891 tmpsv = NEWSV(704,0);
6892 gv_efullname3(tmpsv, gv, Nullch);
6893 /* XXX this is probably not what they think they're getting.
6894 * It has the same effect as "sub name;", i.e. just a forward
6896 newSUB(start_subparse(FALSE, 0),
6897 newSVOP(OP_CONST, 0, tmpsv),
6902 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6912 Returns true if the SV has a true value by Perl's rules.
6913 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6914 instead use an in-line version.
6920 Perl_sv_true(pTHX_ register SV *sv)
6925 register const XPV* const tXpv = (XPV*)SvANY(sv);
6927 (tXpv->xpv_cur > 1 ||
6928 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6935 return SvIVX(sv) != 0;
6938 return SvNVX(sv) != 0.0;
6940 return sv_2bool(sv);
6946 =for apidoc sv_pvn_force
6948 Get a sensible string out of the SV somehow.
6949 A private implementation of the C<SvPV_force> macro for compilers which
6950 can't cope with complex macro expressions. Always use the macro instead.
6952 =for apidoc sv_pvn_force_flags
6954 Get a sensible string out of the SV somehow.
6955 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6956 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6957 implemented in terms of this function.
6958 You normally want to use the various wrapper macros instead: see
6959 C<SvPV_force> and C<SvPV_force_nomg>
6965 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6968 if (SvTHINKFIRST(sv) && !SvROK(sv))
6969 sv_force_normal_flags(sv, 0);
6979 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6980 const char * const ref = sv_reftype(sv,0);
6982 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6983 ref, OP_NAME(PL_op));
6985 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6987 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6988 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6990 s = sv_2pv_flags(sv, &len, flags);
6994 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6997 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6998 SvGROW(sv, len + 1);
6999 Move(s,SvPVX(sv),len,char);
7004 SvPOK_on(sv); /* validate pointer */
7006 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7007 PTR2UV(sv),SvPVX_const(sv)));
7010 return SvPVX_mutable(sv);
7014 =for apidoc sv_pvbyten_force
7016 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7022 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7024 sv_pvn_force(sv,lp);
7025 sv_utf8_downgrade(sv,0);
7031 =for apidoc sv_pvutf8n_force
7033 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7039 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7041 sv_pvn_force(sv,lp);
7042 sv_utf8_upgrade(sv);
7048 =for apidoc sv_reftype
7050 Returns a string describing what the SV is a reference to.
7056 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7058 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7059 inside return suggests a const propagation bug in g++. */
7060 if (ob && SvOBJECT(sv)) {
7061 char * const name = HvNAME_get(SvSTASH(sv));
7062 return name ? name : (char *) "__ANON__";
7065 switch (SvTYPE(sv)) {
7082 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7083 /* tied lvalues should appear to be
7084 * scalars for backwards compatitbility */
7085 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7086 ? "SCALAR" : "LVALUE");
7087 case SVt_PVAV: return "ARRAY";
7088 case SVt_PVHV: return "HASH";
7089 case SVt_PVCV: return "CODE";
7090 case SVt_PVGV: return "GLOB";
7091 case SVt_PVFM: return "FORMAT";
7092 case SVt_PVIO: return "IO";
7093 default: return "UNKNOWN";
7099 =for apidoc sv_isobject
7101 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7102 object. If the SV is not an RV, or if the object is not blessed, then this
7109 Perl_sv_isobject(pTHX_ SV *sv)
7125 Returns a boolean indicating whether the SV is blessed into the specified
7126 class. This does not check for subtypes; use C<sv_derived_from> to verify
7127 an inheritance relationship.
7133 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7144 hvname = HvNAME_get(SvSTASH(sv));
7148 return strEQ(hvname, name);
7154 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7155 it will be upgraded to one. If C<classname> is non-null then the new SV will
7156 be blessed in the specified package. The new SV is returned and its
7157 reference count is 1.
7163 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7169 SV_CHECK_THINKFIRST_COW_DROP(rv);
7172 if (SvTYPE(rv) >= SVt_PVMG) {
7173 const U32 refcnt = SvREFCNT(rv);
7177 SvREFCNT(rv) = refcnt;
7180 if (SvTYPE(rv) < SVt_RV)
7181 sv_upgrade(rv, SVt_RV);
7182 else if (SvTYPE(rv) > SVt_RV) {
7193 HV* const stash = gv_stashpv(classname, TRUE);
7194 (void)sv_bless(rv, stash);
7200 =for apidoc sv_setref_pv
7202 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7203 argument will be upgraded to an RV. That RV will be modified to point to
7204 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7205 into the SV. The C<classname> argument indicates the package for the
7206 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7207 will have a reference count of 1, and the RV will be returned.
7209 Do not use with other Perl types such as HV, AV, SV, CV, because those
7210 objects will become corrupted by the pointer copy process.
7212 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7218 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7221 sv_setsv(rv, &PL_sv_undef);
7225 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7230 =for apidoc sv_setref_iv
7232 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7233 argument will be upgraded to an RV. That RV will be modified to point to
7234 the new SV. The C<classname> argument indicates the package for the
7235 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7236 will have a reference count of 1, and the RV will be returned.
7242 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7244 sv_setiv(newSVrv(rv,classname), iv);
7249 =for apidoc sv_setref_uv
7251 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7252 argument will be upgraded to an RV. That RV will be modified to point to
7253 the new SV. The C<classname> argument indicates the package for the
7254 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7255 will have a reference count of 1, and the RV will be returned.
7261 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7263 sv_setuv(newSVrv(rv,classname), uv);
7268 =for apidoc sv_setref_nv
7270 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7271 argument will be upgraded to an RV. That RV will be modified to point to
7272 the new SV. The C<classname> argument indicates the package for the
7273 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7274 will have a reference count of 1, and the RV will be returned.
7280 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7282 sv_setnv(newSVrv(rv,classname), nv);
7287 =for apidoc sv_setref_pvn
7289 Copies a string into a new SV, optionally blessing the SV. The length of the
7290 string must be specified with C<n>. The C<rv> argument will be upgraded to
7291 an RV. That RV will be modified to point to the new SV. The C<classname>
7292 argument indicates the package for the blessing. Set C<classname> to
7293 C<Nullch> to avoid the blessing. The new SV will have a reference count
7294 of 1, and the RV will be returned.
7296 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7302 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7304 sv_setpvn(newSVrv(rv,classname), pv, n);
7309 =for apidoc sv_bless
7311 Blesses an SV into a specified package. The SV must be an RV. The package
7312 must be designated by its stash (see C<gv_stashpv()>). The reference count
7313 of the SV is unaffected.
7319 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7323 Perl_croak(aTHX_ "Can't bless non-reference value");
7325 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7326 if (SvREADONLY(tmpRef))
7327 Perl_croak(aTHX_ PL_no_modify);
7328 if (SvOBJECT(tmpRef)) {
7329 if (SvTYPE(tmpRef) != SVt_PVIO)
7331 SvREFCNT_dec(SvSTASH(tmpRef));
7334 SvOBJECT_on(tmpRef);
7335 if (SvTYPE(tmpRef) != SVt_PVIO)
7337 SvUPGRADE(tmpRef, SVt_PVMG);
7338 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7345 if(SvSMAGICAL(tmpRef))
7346 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7354 /* Downgrades a PVGV to a PVMG.
7358 S_sv_unglob(pTHX_ SV *sv)
7362 assert(SvTYPE(sv) == SVt_PVGV);
7367 sv_del_backref((SV*)GvSTASH(sv), sv);
7370 sv_unmagic(sv, PERL_MAGIC_glob);
7371 Safefree(GvNAME(sv));
7374 /* need to keep SvANY(sv) in the right arena */
7375 xpvmg = new_XPVMG();
7376 StructCopy(SvANY(sv), xpvmg, XPVMG);
7377 del_XPVGV(SvANY(sv));
7380 SvFLAGS(sv) &= ~SVTYPEMASK;
7381 SvFLAGS(sv) |= SVt_PVMG;
7385 =for apidoc sv_unref_flags
7387 Unsets the RV status of the SV, and decrements the reference count of
7388 whatever was being referenced by the RV. This can almost be thought of
7389 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7390 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7391 (otherwise the decrementing is conditional on the reference count being
7392 different from one or the reference being a readonly SV).
7399 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7401 SV* const target = SvRV(ref);
7403 if (SvWEAKREF(ref)) {
7404 sv_del_backref(target, ref);
7406 SvRV_set(ref, NULL);
7409 SvRV_set(ref, NULL);
7411 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7412 assigned to as BEGIN {$a = \"Foo"} will fail. */
7413 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7414 SvREFCNT_dec(target);
7415 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7416 sv_2mortal(target); /* Schedule for freeing later */
7420 =for apidoc sv_untaint
7422 Untaint an SV. Use C<SvTAINTED_off> instead.
7427 Perl_sv_untaint(pTHX_ SV *sv)
7429 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7430 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7437 =for apidoc sv_tainted
7439 Test an SV for taintedness. Use C<SvTAINTED> instead.
7444 Perl_sv_tainted(pTHX_ SV *sv)
7446 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7447 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7448 if (mg && (mg->mg_len & 1) )
7455 =for apidoc sv_setpviv
7457 Copies an integer into the given SV, also updating its string value.
7458 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7464 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7466 char buf[TYPE_CHARS(UV)];
7468 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7470 sv_setpvn(sv, ptr, ebuf - ptr);
7474 =for apidoc sv_setpviv_mg
7476 Like C<sv_setpviv>, but also handles 'set' magic.
7482 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7488 #if defined(PERL_IMPLICIT_CONTEXT)
7490 /* pTHX_ magic can't cope with varargs, so this is a no-context
7491 * version of the main function, (which may itself be aliased to us).
7492 * Don't access this version directly.
7496 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7500 va_start(args, pat);
7501 sv_vsetpvf(sv, pat, &args);
7505 /* pTHX_ magic can't cope with varargs, so this is a no-context
7506 * version of the main function, (which may itself be aliased to us).
7507 * Don't access this version directly.
7511 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7515 va_start(args, pat);
7516 sv_vsetpvf_mg(sv, pat, &args);
7522 =for apidoc sv_setpvf
7524 Works like C<sv_catpvf> but copies the text into the SV instead of
7525 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7531 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7534 va_start(args, pat);
7535 sv_vsetpvf(sv, pat, &args);
7540 =for apidoc sv_vsetpvf
7542 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7543 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7545 Usually used via its frontend C<sv_setpvf>.
7551 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7553 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7557 =for apidoc sv_setpvf_mg
7559 Like C<sv_setpvf>, but also handles 'set' magic.
7565 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7568 va_start(args, pat);
7569 sv_vsetpvf_mg(sv, pat, &args);
7574 =for apidoc sv_vsetpvf_mg
7576 Like C<sv_vsetpvf>, but also handles 'set' magic.
7578 Usually used via its frontend C<sv_setpvf_mg>.
7584 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7586 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7590 #if defined(PERL_IMPLICIT_CONTEXT)
7592 /* pTHX_ magic can't cope with varargs, so this is a no-context
7593 * version of the main function, (which may itself be aliased to us).
7594 * Don't access this version directly.
7598 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7602 va_start(args, pat);
7603 sv_vcatpvf(sv, pat, &args);
7607 /* pTHX_ magic can't cope with varargs, so this is a no-context
7608 * version of the main function, (which may itself be aliased to us).
7609 * Don't access this version directly.
7613 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7617 va_start(args, pat);
7618 sv_vcatpvf_mg(sv, pat, &args);
7624 =for apidoc sv_catpvf
7626 Processes its arguments like C<sprintf> and appends the formatted
7627 output to an SV. If the appended data contains "wide" characters
7628 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7629 and characters >255 formatted with %c), the original SV might get
7630 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7631 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7632 valid UTF-8; if the original SV was bytes, the pattern should be too.
7637 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7640 va_start(args, pat);
7641 sv_vcatpvf(sv, pat, &args);
7646 =for apidoc sv_vcatpvf
7648 Processes its arguments like C<vsprintf> and appends the formatted output
7649 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7651 Usually used via its frontend C<sv_catpvf>.
7657 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7659 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7663 =for apidoc sv_catpvf_mg
7665 Like C<sv_catpvf>, but also handles 'set' magic.
7671 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7674 va_start(args, pat);
7675 sv_vcatpvf_mg(sv, pat, &args);
7680 =for apidoc sv_vcatpvf_mg
7682 Like C<sv_vcatpvf>, but also handles 'set' magic.
7684 Usually used via its frontend C<sv_catpvf_mg>.
7690 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7692 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7697 =for apidoc sv_vsetpvfn
7699 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7702 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7708 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7710 sv_setpvn(sv, "", 0);
7711 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7715 S_expect_number(pTHX_ char** pattern)
7718 switch (**pattern) {
7719 case '1': case '2': case '3':
7720 case '4': case '5': case '6':
7721 case '7': case '8': case '9':
7722 var = *(*pattern)++ - '0';
7723 while (isDIGIT(**pattern)) {
7724 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7726 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7734 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7736 const int neg = nv < 0;
7745 if (uv & 1 && uv == nv)
7746 uv--; /* Round to even */
7748 const unsigned dig = uv % 10;
7761 =for apidoc sv_vcatpvfn
7763 Processes its arguments like C<vsprintf> and appends the formatted output
7764 to an SV. Uses an array of SVs if the C style variable argument list is
7765 missing (NULL). When running with taint checks enabled, indicates via
7766 C<maybe_tainted> if results are untrustworthy (often due to the use of
7769 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7775 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7776 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7777 vec_utf8 = DO_UTF8(vecsv);
7779 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7782 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7789 static const char nullstr[] = "(null)";
7791 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7792 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7794 /* Times 4: a decimal digit takes more than 3 binary digits.
7795 * NV_DIG: mantissa takes than many decimal digits.
7796 * Plus 32: Playing safe. */
7797 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7798 /* large enough for "%#.#f" --chip */
7799 /* what about long double NVs? --jhi */
7801 PERL_UNUSED_ARG(maybe_tainted);
7803 /* no matter what, this is a string now */
7804 (void)SvPV_force(sv, origlen);
7806 /* special-case "", "%s", and "%-p" (SVf - see below) */
7809 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7811 const char * const s = va_arg(*args, char*);
7812 sv_catpv(sv, s ? s : nullstr);
7814 else if (svix < svmax) {
7815 sv_catsv(sv, *svargs);
7819 if (args && patlen == 3 && pat[0] == '%' &&
7820 pat[1] == '-' && pat[2] == 'p') {
7821 argsv = va_arg(*args, SV*);
7822 sv_catsv(sv, argsv);
7826 #ifndef USE_LONG_DOUBLE
7827 /* special-case "%.<number>[gf]" */
7828 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7829 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7830 unsigned digits = 0;
7834 while (*pp >= '0' && *pp <= '9')
7835 digits = 10 * digits + (*pp++ - '0');
7836 if (pp - pat == (int)patlen - 1) {
7844 /* Add check for digits != 0 because it seems that some
7845 gconverts are buggy in this case, and we don't yet have
7846 a Configure test for this. */
7847 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7848 /* 0, point, slack */
7849 Gconvert(nv, (int)digits, 0, ebuf);
7851 if (*ebuf) /* May return an empty string for digits==0 */
7854 } else if (!digits) {
7857 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7858 sv_catpvn(sv, p, l);
7864 #endif /* !USE_LONG_DOUBLE */
7866 if (!args && svix < svmax && DO_UTF8(*svargs))
7869 patend = (char*)pat + patlen;
7870 for (p = (char*)pat; p < patend; p = q) {
7873 bool vectorize = FALSE;
7874 bool vectorarg = FALSE;
7875 bool vec_utf8 = FALSE;
7881 bool has_precis = FALSE;
7883 const I32 osvix = svix;
7884 bool is_utf8 = FALSE; /* is this item utf8? */
7885 #ifdef HAS_LDBL_SPRINTF_BUG
7886 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7887 with sfio - Allen <allens@cpan.org> */
7888 bool fix_ldbl_sprintf_bug = FALSE;
7892 U8 utf8buf[UTF8_MAXBYTES+1];
7893 STRLEN esignlen = 0;
7895 const char *eptr = Nullch;
7898 const U8 *vecstr = Null(U8*);
7905 /* we need a long double target in case HAS_LONG_DOUBLE but
7908 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7916 const char *dotstr = ".";
7917 STRLEN dotstrlen = 1;
7918 I32 efix = 0; /* explicit format parameter index */
7919 I32 ewix = 0; /* explicit width index */
7920 I32 epix = 0; /* explicit precision index */
7921 I32 evix = 0; /* explicit vector index */
7922 bool asterisk = FALSE;
7924 /* echo everything up to the next format specification */
7925 for (q = p; q < patend && *q != '%'; ++q) ;
7927 if (has_utf8 && !pat_utf8)
7928 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7930 sv_catpvn(sv, p, q - p);
7937 We allow format specification elements in this order:
7938 \d+\$ explicit format parameter index
7940 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7941 0 flag (as above): repeated to allow "v02"
7942 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7943 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7945 [%bcdefginopsuxDFOUX] format (mandatory)
7950 As of perl5.9.3, printf format checking is on by default.
7951 Internally, perl uses %p formats to provide an escape to
7952 some extended formatting. This block deals with those
7953 extensions: if it does not match, (char*)q is reset and
7954 the normal format processing code is used.
7956 Currently defined extensions are:
7957 %p include pointer address (standard)
7958 %-p (SVf) include an SV (previously %_)
7959 %-<num>p include an SV with precision <num>
7960 %1p (VDf) include a v-string (as %vd)
7961 %<num>p reserved for future extensions
7963 Robin Barker 2005-07-14
7970 n = expect_number(&q);
7977 argsv = va_arg(*args, SV*);
7978 eptr = SvPVx_const(argsv, elen);
7984 else if (n == vdNUMBER) { /* VDf */
7991 if (ckWARN_d(WARN_INTERNAL))
7992 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7993 "internal %%<num>p might conflict with future printf extensions");
7999 if ( (width = expect_number(&q)) ) {
8040 if ( (ewix = expect_number(&q)) )
8049 if ((vectorarg = asterisk)) {
8062 width = expect_number(&q);
8068 vecsv = va_arg(*args, SV*);
8070 vecsv = (evix > 0 && evix <= svmax)
8071 ? svargs[evix-1] : &PL_sv_undef;
8073 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8075 dotstr = SvPV_const(vecsv, dotstrlen);
8076 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8077 bad with tied or overloaded values that return UTF8. */
8080 else if (has_utf8) {
8081 vecsv = sv_mortalcopy(vecsv);
8082 sv_utf8_upgrade(vecsv);
8083 dotstr = SvPV_const(vecsv, dotstrlen);
8090 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8091 vecsv = svargs[efix ? efix-1 : svix++];
8092 vecstr = (U8*)SvPV_const(vecsv,veclen);
8093 vec_utf8 = DO_UTF8(vecsv);
8095 /* if this is a version object, we need to convert
8096 * back into v-string notation and then let the
8097 * vectorize happen normally
8099 if (sv_derived_from(vecsv, "version")) {
8100 char *version = savesvpv(vecsv);
8101 vecsv = sv_newmortal();
8102 /* scan_vstring is expected to be called during
8103 * tokenization, so we need to fake up the end
8104 * of the buffer for it
8106 PL_bufend = version + veclen;
8107 scan_vstring(version, vecsv);
8108 vecstr = (U8*)SvPV_const(vecsv, veclen);
8109 vec_utf8 = DO_UTF8(vecsv);
8121 i = va_arg(*args, int);
8123 i = (ewix ? ewix <= svmax : svix < svmax) ?
8124 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8126 width = (i < 0) ? -i : i;
8136 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8138 /* XXX: todo, support specified precision parameter */
8142 i = va_arg(*args, int);
8144 i = (ewix ? ewix <= svmax : svix < svmax)
8145 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8146 precis = (i < 0) ? 0 : i;
8151 precis = precis * 10 + (*q++ - '0');
8160 case 'I': /* Ix, I32x, and I64x */
8162 if (q[1] == '6' && q[2] == '4') {
8168 if (q[1] == '3' && q[2] == '2') {
8178 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8189 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8190 if (*(q + 1) == 'l') { /* lld, llf */
8216 if (!vectorize && !args) {
8218 const I32 i = efix-1;
8219 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8221 argsv = (svix >= 0 && svix < svmax)
8222 ? svargs[svix++] : &PL_sv_undef;
8233 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8235 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8237 eptr = (char*)utf8buf;
8238 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8252 eptr = va_arg(*args, char*);
8254 #ifdef MACOS_TRADITIONAL
8255 /* On MacOS, %#s format is used for Pascal strings */
8260 elen = strlen(eptr);
8262 eptr = (char *)nullstr;
8263 elen = sizeof nullstr - 1;
8267 eptr = SvPVx_const(argsv, elen);
8268 if (DO_UTF8(argsv)) {
8269 if (has_precis && precis < elen) {
8271 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8274 if (width) { /* fudge width (can't fudge elen) */
8275 width += elen - sv_len_utf8(argsv);
8282 if (has_precis && elen > precis)
8289 if (alt || vectorize)
8291 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8312 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8321 esignbuf[esignlen++] = plus;
8325 case 'h': iv = (short)va_arg(*args, int); break;
8326 case 'l': iv = va_arg(*args, long); break;
8327 case 'V': iv = va_arg(*args, IV); break;
8328 default: iv = va_arg(*args, int); break;
8330 case 'q': iv = va_arg(*args, Quad_t); break;
8335 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8337 case 'h': iv = (short)tiv; break;
8338 case 'l': iv = (long)tiv; break;
8340 default: iv = tiv; break;
8342 case 'q': iv = (Quad_t)tiv; break;
8346 if ( !vectorize ) /* we already set uv above */
8351 esignbuf[esignlen++] = plus;
8355 esignbuf[esignlen++] = '-';
8398 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8409 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8410 case 'l': uv = va_arg(*args, unsigned long); break;
8411 case 'V': uv = va_arg(*args, UV); break;
8412 default: uv = va_arg(*args, unsigned); break;
8414 case 'q': uv = va_arg(*args, Uquad_t); break;
8419 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8421 case 'h': uv = (unsigned short)tuv; break;
8422 case 'l': uv = (unsigned long)tuv; break;
8424 default: uv = tuv; break;
8426 case 'q': uv = (Uquad_t)tuv; break;
8433 char *ptr = ebuf + sizeof ebuf;
8439 p = (char*)((c == 'X')
8440 ? "0123456789ABCDEF" : "0123456789abcdef");
8446 esignbuf[esignlen++] = '0';
8447 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8455 if (alt && *ptr != '0')
8466 esignbuf[esignlen++] = '0';
8467 esignbuf[esignlen++] = 'b';
8470 default: /* it had better be ten or less */
8474 } while (uv /= base);
8477 elen = (ebuf + sizeof ebuf) - ptr;
8481 zeros = precis - elen;
8482 else if (precis == 0 && elen == 1 && *eptr == '0')
8488 /* FLOATING POINT */
8491 c = 'f'; /* maybe %F isn't supported here */
8499 /* This is evil, but floating point is even more evil */
8501 /* for SV-style calling, we can only get NV
8502 for C-style calling, we assume %f is double;
8503 for simplicity we allow any of %Lf, %llf, %qf for long double
8507 #if defined(USE_LONG_DOUBLE)
8511 /* [perl #20339] - we should accept and ignore %lf rather than die */
8515 #if defined(USE_LONG_DOUBLE)
8516 intsize = args ? 0 : 'q';
8520 #if defined(HAS_LONG_DOUBLE)
8529 /* now we need (long double) if intsize == 'q', else (double) */
8531 #if LONG_DOUBLESIZE > DOUBLESIZE
8533 va_arg(*args, long double) :
8534 va_arg(*args, double)
8536 va_arg(*args, double)
8541 if (c != 'e' && c != 'E') {
8543 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8544 will cast our (long double) to (double) */
8545 (void)Perl_frexp(nv, &i);
8546 if (i == PERL_INT_MIN)
8547 Perl_die(aTHX_ "panic: frexp");
8549 need = BIT_DIGITS(i);
8551 need += has_precis ? precis : 6; /* known default */
8556 #ifdef HAS_LDBL_SPRINTF_BUG
8557 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8558 with sfio - Allen <allens@cpan.org> */
8561 # define MY_DBL_MAX DBL_MAX
8562 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8563 # if DOUBLESIZE >= 8
8564 # define MY_DBL_MAX 1.7976931348623157E+308L
8566 # define MY_DBL_MAX 3.40282347E+38L
8570 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8571 # define MY_DBL_MAX_BUG 1L
8573 # define MY_DBL_MAX_BUG MY_DBL_MAX
8577 # define MY_DBL_MIN DBL_MIN
8578 # else /* XXX guessing! -Allen */
8579 # if DOUBLESIZE >= 8
8580 # define MY_DBL_MIN 2.2250738585072014E-308L
8582 # define MY_DBL_MIN 1.17549435E-38L
8586 if ((intsize == 'q') && (c == 'f') &&
8587 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8589 /* it's going to be short enough that
8590 * long double precision is not needed */
8592 if ((nv <= 0L) && (nv >= -0L))
8593 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8595 /* would use Perl_fp_class as a double-check but not
8596 * functional on IRIX - see perl.h comments */
8598 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8599 /* It's within the range that a double can represent */
8600 #if defined(DBL_MAX) && !defined(DBL_MIN)
8601 if ((nv >= ((long double)1/DBL_MAX)) ||
8602 (nv <= (-(long double)1/DBL_MAX)))
8604 fix_ldbl_sprintf_bug = TRUE;
8607 if (fix_ldbl_sprintf_bug == TRUE) {
8617 # undef MY_DBL_MAX_BUG
8620 #endif /* HAS_LDBL_SPRINTF_BUG */
8622 need += 20; /* fudge factor */
8623 if (PL_efloatsize < need) {
8624 Safefree(PL_efloatbuf);
8625 PL_efloatsize = need + 20; /* more fudge */
8626 Newx(PL_efloatbuf, PL_efloatsize, char);
8627 PL_efloatbuf[0] = '\0';
8630 if ( !(width || left || plus || alt) && fill != '0'
8631 && has_precis && intsize != 'q' ) { /* Shortcuts */
8632 /* See earlier comment about buggy Gconvert when digits,
8634 if ( c == 'g' && precis) {
8635 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8636 /* May return an empty string for digits==0 */
8637 if (*PL_efloatbuf) {
8638 elen = strlen(PL_efloatbuf);
8639 goto float_converted;
8641 } else if ( c == 'f' && !precis) {
8642 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8647 char *ptr = ebuf + sizeof ebuf;
8650 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8651 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8652 if (intsize == 'q') {
8653 /* Copy the one or more characters in a long double
8654 * format before the 'base' ([efgEFG]) character to
8655 * the format string. */
8656 static char const prifldbl[] = PERL_PRIfldbl;
8657 char const *p = prifldbl + sizeof(prifldbl) - 3;
8658 while (p >= prifldbl) { *--ptr = *p--; }
8663 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8668 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8680 /* No taint. Otherwise we are in the strange situation
8681 * where printf() taints but print($float) doesn't.
8683 #if defined(HAS_LONG_DOUBLE)
8684 elen = ((intsize == 'q')
8685 ? my_sprintf(PL_efloatbuf, ptr, nv)
8686 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8688 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8692 eptr = PL_efloatbuf;
8700 i = SvCUR(sv) - origlen;
8703 case 'h': *(va_arg(*args, short*)) = i; break;
8704 default: *(va_arg(*args, int*)) = i; break;
8705 case 'l': *(va_arg(*args, long*)) = i; break;
8706 case 'V': *(va_arg(*args, IV*)) = i; break;
8708 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8713 sv_setuv_mg(argsv, (UV)i);
8714 continue; /* not "break" */
8721 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8722 && ckWARN(WARN_PRINTF))
8724 SV * const msg = sv_newmortal();
8725 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8726 (PL_op->op_type == OP_PRTF) ? "" : "s");
8729 Perl_sv_catpvf(aTHX_ msg,
8730 "\"%%%c\"", c & 0xFF);
8732 Perl_sv_catpvf(aTHX_ msg,
8733 "\"%%\\%03"UVof"\"",
8736 sv_catpvs(msg, "end of string");
8737 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8740 /* output mangled stuff ... */
8746 /* ... right here, because formatting flags should not apply */
8747 SvGROW(sv, SvCUR(sv) + elen + 1);
8749 Copy(eptr, p, elen, char);
8752 SvCUR_set(sv, p - SvPVX_const(sv));
8754 continue; /* not "break" */
8757 /* calculate width before utf8_upgrade changes it */
8758 have = esignlen + zeros + elen;
8760 Perl_croak_nocontext(PL_memory_wrap);
8762 if (is_utf8 != has_utf8) {
8765 sv_utf8_upgrade(sv);
8768 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8769 sv_utf8_upgrade(nsv);
8770 eptr = SvPVX_const(nsv);
8773 SvGROW(sv, SvCUR(sv) + elen + 1);
8778 need = (have > width ? have : width);
8781 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8782 Perl_croak_nocontext(PL_memory_wrap);
8783 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8785 if (esignlen && fill == '0') {
8787 for (i = 0; i < (int)esignlen; i++)
8791 memset(p, fill, gap);
8794 if (esignlen && fill != '0') {
8796 for (i = 0; i < (int)esignlen; i++)
8801 for (i = zeros; i; i--)
8805 Copy(eptr, p, elen, char);
8809 memset(p, ' ', gap);
8814 Copy(dotstr, p, dotstrlen, char);
8818 vectorize = FALSE; /* done iterating over vecstr */
8825 SvCUR_set(sv, p - SvPVX_const(sv));
8833 /* =========================================================================
8835 =head1 Cloning an interpreter
8837 All the macros and functions in this section are for the private use of
8838 the main function, perl_clone().
8840 The foo_dup() functions make an exact copy of an existing foo thinngy.
8841 During the course of a cloning, a hash table is used to map old addresses
8842 to new addresses. The table is created and manipulated with the
8843 ptr_table_* functions.
8847 ============================================================================*/
8850 #if defined(USE_ITHREADS)
8852 #ifndef GpREFCNT_inc
8853 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8857 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8858 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8859 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8860 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8861 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8862 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8863 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8864 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8865 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8866 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8867 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8868 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8869 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8872 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8873 regcomp.c. AMS 20010712 */
8876 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8881 struct reg_substr_datum *s;
8884 return (REGEXP *)NULL;
8886 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8889 len = r->offsets[0];
8890 npar = r->nparens+1;
8892 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8893 Copy(r->program, ret->program, len+1, regnode);
8895 Newx(ret->startp, npar, I32);
8896 Copy(r->startp, ret->startp, npar, I32);
8897 Newx(ret->endp, npar, I32);
8898 Copy(r->startp, ret->startp, npar, I32);
8900 Newx(ret->substrs, 1, struct reg_substr_data);
8901 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8902 s->min_offset = r->substrs->data[i].min_offset;
8903 s->max_offset = r->substrs->data[i].max_offset;
8904 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8905 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8908 ret->regstclass = NULL;
8911 const int count = r->data->count;
8914 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8915 char, struct reg_data);
8916 Newx(d->what, count, U8);
8919 for (i = 0; i < count; i++) {
8920 d->what[i] = r->data->what[i];
8921 switch (d->what[i]) {
8922 /* legal options are one of: sfpont
8923 see also regcomp.h and pregfree() */
8925 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8928 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8931 /* This is cheating. */
8932 Newx(d->data[i], 1, struct regnode_charclass_class);
8933 StructCopy(r->data->data[i], d->data[i],
8934 struct regnode_charclass_class);
8935 ret->regstclass = (regnode*)d->data[i];
8938 /* Compiled op trees are readonly, and can thus be
8939 shared without duplication. */
8941 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8945 d->data[i] = r->data->data[i];
8948 d->data[i] = r->data->data[i];
8950 ((reg_trie_data*)d->data[i])->refcount++;
8954 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8963 Newx(ret->offsets, 2*len+1, U32);
8964 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8966 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8967 ret->refcnt = r->refcnt;
8968 ret->minlen = r->minlen;
8969 ret->prelen = r->prelen;
8970 ret->nparens = r->nparens;
8971 ret->lastparen = r->lastparen;
8972 ret->lastcloseparen = r->lastcloseparen;
8973 ret->reganch = r->reganch;
8975 ret->sublen = r->sublen;
8977 if (RX_MATCH_COPIED(ret))
8978 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8980 ret->subbeg = Nullch;
8981 #ifdef PERL_OLD_COPY_ON_WRITE
8982 ret->saved_copy = Nullsv;
8985 ptr_table_store(PL_ptr_table, r, ret);
8989 /* duplicate a file handle */
8992 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8996 PERL_UNUSED_ARG(type);
8999 return (PerlIO*)NULL;
9001 /* look for it in the table first */
9002 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9006 /* create anew and remember what it is */
9007 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9008 ptr_table_store(PL_ptr_table, fp, ret);
9012 /* duplicate a directory handle */
9015 Perl_dirp_dup(pTHX_ DIR *dp)
9023 /* duplicate a typeglob */
9026 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9031 /* look for it in the table first */
9032 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9036 /* create anew and remember what it is */
9038 ptr_table_store(PL_ptr_table, gp, ret);
9041 ret->gp_refcnt = 0; /* must be before any other dups! */
9042 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9043 ret->gp_io = io_dup_inc(gp->gp_io, param);
9044 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9045 ret->gp_av = av_dup_inc(gp->gp_av, param);
9046 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9047 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9048 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9049 ret->gp_cvgen = gp->gp_cvgen;
9050 ret->gp_line = gp->gp_line;
9051 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9055 /* duplicate a chain of magic */
9058 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9060 MAGIC *mgprev = (MAGIC*)NULL;
9063 return (MAGIC*)NULL;
9064 /* look for it in the table first */
9065 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9069 for (; mg; mg = mg->mg_moremagic) {
9071 Newxz(nmg, 1, MAGIC);
9073 mgprev->mg_moremagic = nmg;
9076 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9077 nmg->mg_private = mg->mg_private;
9078 nmg->mg_type = mg->mg_type;
9079 nmg->mg_flags = mg->mg_flags;
9080 if (mg->mg_type == PERL_MAGIC_qr) {
9081 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9083 else if(mg->mg_type == PERL_MAGIC_backref) {
9084 /* The backref AV has its reference count deliberately bumped by
9086 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9088 else if (mg->mg_type == PERL_MAGIC_symtab) {
9089 nmg->mg_obj = mg->mg_obj;
9092 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9093 ? sv_dup_inc(mg->mg_obj, param)
9094 : sv_dup(mg->mg_obj, param);
9096 nmg->mg_len = mg->mg_len;
9097 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9098 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9099 if (mg->mg_len > 0) {
9100 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9101 if (mg->mg_type == PERL_MAGIC_overload_table &&
9102 AMT_AMAGIC((AMT*)mg->mg_ptr))
9104 const AMT * const amtp = (AMT*)mg->mg_ptr;
9105 AMT * const namtp = (AMT*)nmg->mg_ptr;
9107 for (i = 1; i < NofAMmeth; i++) {
9108 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9112 else if (mg->mg_len == HEf_SVKEY)
9113 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9115 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9116 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9123 /* create a new pointer-mapping table */
9126 Perl_ptr_table_new(pTHX)
9129 Newxz(tbl, 1, PTR_TBL_t);
9132 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9136 #define PTR_TABLE_HASH(ptr) \
9137 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9140 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9141 following define) and at call to new_body_inline made below in
9142 Perl_ptr_table_store()
9145 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9147 /* map an existing pointer using a table */
9149 STATIC PTR_TBL_ENT_t *
9150 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9151 PTR_TBL_ENT_t *tblent;
9152 const UV hash = PTR_TABLE_HASH(sv);
9154 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9155 for (; tblent; tblent = tblent->next) {
9156 if (tblent->oldval == sv)
9163 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9165 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9166 return tblent ? tblent->newval : (void *) 0;
9169 /* add a new entry to a pointer-mapping table */
9172 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9174 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9177 tblent->newval = newsv;
9179 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9181 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9182 tblent->oldval = oldsv;
9183 tblent->newval = newsv;
9184 tblent->next = tbl->tbl_ary[entry];
9185 tbl->tbl_ary[entry] = tblent;
9187 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9188 ptr_table_split(tbl);
9192 /* double the hash bucket size of an existing ptr table */
9195 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9197 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9198 const UV oldsize = tbl->tbl_max + 1;
9199 UV newsize = oldsize * 2;
9202 Renew(ary, newsize, PTR_TBL_ENT_t*);
9203 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9204 tbl->tbl_max = --newsize;
9206 for (i=0; i < oldsize; i++, ary++) {
9207 PTR_TBL_ENT_t **curentp, **entp, *ent;
9210 curentp = ary + oldsize;
9211 for (entp = ary, ent = *ary; ent; ent = *entp) {
9212 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9214 ent->next = *curentp;
9224 /* remove all the entries from a ptr table */
9227 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9229 if (tbl && tbl->tbl_items) {
9230 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9231 UV riter = tbl->tbl_max;
9234 PTR_TBL_ENT_t *entry = array[riter];
9237 PTR_TBL_ENT_t * const oentry = entry;
9238 entry = entry->next;
9247 /* clear and free a ptr table */
9250 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9255 ptr_table_clear(tbl);
9256 Safefree(tbl->tbl_ary);
9262 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9265 SvRV_set(dstr, SvWEAKREF(sstr)
9266 ? sv_dup(SvRV(sstr), param)
9267 : sv_dup_inc(SvRV(sstr), param));
9270 else if (SvPVX_const(sstr)) {
9271 /* Has something there */
9273 /* Normal PV - clone whole allocated space */
9274 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9275 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9276 /* Not that normal - actually sstr is copy on write.
9277 But we are a true, independant SV, so: */
9278 SvREADONLY_off(dstr);
9283 /* Special case - not normally malloced for some reason */
9284 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9285 /* A "shared" PV - clone it as "shared" PV */
9287 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9291 /* Some other special case - random pointer */
9292 SvPV_set(dstr, SvPVX(sstr));
9298 if (SvTYPE(dstr) == SVt_RV)
9299 SvRV_set(dstr, NULL);
9305 /* duplicate an SV of any type (including AV, HV etc) */
9308 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9313 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9315 /* look for it in the table first */
9316 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9320 if(param->flags & CLONEf_JOIN_IN) {
9321 /** We are joining here so we don't want do clone
9322 something that is bad **/
9323 if (SvTYPE(sstr) == SVt_PVHV) {
9324 const char * const hvname = HvNAME_get(sstr);
9326 /** don't clone stashes if they already exist **/
9327 return (SV*)gv_stashpv(hvname,0);
9331 /* create anew and remember what it is */
9334 #ifdef DEBUG_LEAKING_SCALARS
9335 dstr->sv_debug_optype = sstr->sv_debug_optype;
9336 dstr->sv_debug_line = sstr->sv_debug_line;
9337 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9338 dstr->sv_debug_cloned = 1;
9339 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9342 ptr_table_store(PL_ptr_table, sstr, dstr);
9345 SvFLAGS(dstr) = SvFLAGS(sstr);
9346 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9347 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9350 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9351 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9352 PL_watch_pvx, SvPVX_const(sstr));
9355 /* don't clone objects whose class has asked us not to */
9356 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9357 SvFLAGS(dstr) &= ~SVTYPEMASK;
9362 switch (SvTYPE(sstr)) {
9367 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9368 SvIV_set(dstr, SvIVX(sstr));
9371 SvANY(dstr) = new_XNV();
9372 SvNV_set(dstr, SvNVX(sstr));
9375 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9376 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9380 /* These are all the types that need complex bodies allocating. */
9382 const svtype sv_type = SvTYPE(sstr);
9383 const struct body_details *const sv_type_details
9384 = bodies_by_type + sv_type;
9388 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9393 if (GvUNIQUE((GV*)sstr)) {
9394 /* Do sharing here, and fall through */
9407 assert(sv_type_details->size);
9408 if (sv_type_details->arena) {
9409 new_body_inline(new_body, sv_type_details->size, sv_type);
9411 = (void*)((char*)new_body - sv_type_details->offset);
9413 new_body = new_NOARENA(sv_type_details);
9417 SvANY(dstr) = new_body;
9420 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9421 ((char*)SvANY(dstr)) + sv_type_details->offset,
9422 sv_type_details->copy, char);
9424 Copy(((char*)SvANY(sstr)),
9425 ((char*)SvANY(dstr)),
9426 sv_type_details->size + sv_type_details->offset, char);
9429 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9430 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9432 /* The Copy above means that all the source (unduplicated) pointers
9433 are now in the destination. We can check the flags and the
9434 pointers in either, but it's possible that there's less cache
9435 missing by always going for the destination.
9436 FIXME - instrument and check that assumption */
9437 if (sv_type >= SVt_PVMG) {
9439 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9441 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9444 /* The cast silences a GCC warning about unhandled types. */
9445 switch ((int)sv_type) {
9457 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9458 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9459 LvTARG(dstr) = dstr;
9460 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9461 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9463 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9466 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9467 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9468 /* Don't call sv_add_backref here as it's going to be created
9469 as part of the magic cloning of the symbol table. */
9470 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9471 (void)GpREFCNT_inc(GvGP(dstr));
9474 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9475 if (IoOFP(dstr) == IoIFP(sstr))
9476 IoOFP(dstr) = IoIFP(dstr);
9478 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9479 /* PL_rsfp_filters entries have fake IoDIRP() */
9480 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9481 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9482 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9483 /* I have no idea why fake dirp (rsfps)
9484 should be treated differently but otherwise
9485 we end up with leaks -- sky*/
9486 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9487 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9488 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9490 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9491 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9492 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9494 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9495 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9496 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9499 if (AvARRAY((AV*)sstr)) {
9500 SV **dst_ary, **src_ary;
9501 SSize_t items = AvFILLp((AV*)sstr) + 1;
9503 src_ary = AvARRAY((AV*)sstr);
9504 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9505 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9506 SvPV_set(dstr, (char*)dst_ary);
9507 AvALLOC((AV*)dstr) = dst_ary;
9508 if (AvREAL((AV*)sstr)) {
9510 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9514 *dst_ary++ = sv_dup(*src_ary++, param);
9516 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9517 while (items-- > 0) {
9518 *dst_ary++ = &PL_sv_undef;
9522 SvPV_set(dstr, Nullch);
9523 AvALLOC((AV*)dstr) = (SV**)NULL;
9530 if (HvARRAY((HV*)sstr)) {
9532 const bool sharekeys = !!HvSHAREKEYS(sstr);
9533 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9534 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9536 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9537 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9539 HvARRAY(dstr) = (HE**)darray;
9540 while (i <= sxhv->xhv_max) {
9541 const HE *source = HvARRAY(sstr)[i];
9542 HvARRAY(dstr)[i] = source
9543 ? he_dup(source, sharekeys, param) : 0;
9547 struct xpvhv_aux * const saux = HvAUX(sstr);
9548 struct xpvhv_aux * const daux = HvAUX(dstr);
9549 /* This flag isn't copied. */
9550 /* SvOOK_on(hv) attacks the IV flags. */
9551 SvFLAGS(dstr) |= SVf_OOK;
9553 hvname = saux->xhv_name;
9555 = hvname ? hek_dup(hvname, param) : hvname;
9557 daux->xhv_riter = saux->xhv_riter;
9558 daux->xhv_eiter = saux->xhv_eiter
9559 ? he_dup(saux->xhv_eiter,
9560 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9561 daux->xhv_backreferences = saux->xhv_backreferences
9562 ? (AV*) SvREFCNT_inc(
9570 SvPV_set(dstr, Nullch);
9572 /* Record stashes for possible cloning in Perl_clone(). */
9574 av_push(param->stashes, dstr);
9579 /* NOTE: not refcounted */
9580 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9582 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9584 if (CvCONST(dstr)) {
9585 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9586 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9587 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9589 /* don't dup if copying back - CvGV isn't refcounted, so the
9590 * duped GV may never be freed. A bit of a hack! DAPM */
9591 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9592 Nullgv : gv_dup(CvGV(dstr), param) ;
9593 if (!(param->flags & CLONEf_COPY_STACKS)) {
9596 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9599 ? cv_dup( CvOUTSIDE(dstr), param)
9600 : cv_dup_inc(CvOUTSIDE(dstr), param);
9602 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9608 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9614 /* duplicate a context */
9617 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9622 return (PERL_CONTEXT*)NULL;
9624 /* look for it in the table first */
9625 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9629 /* create anew and remember what it is */
9630 Newxz(ncxs, max + 1, PERL_CONTEXT);
9631 ptr_table_store(PL_ptr_table, cxs, ncxs);
9634 PERL_CONTEXT * const cx = &cxs[ix];
9635 PERL_CONTEXT * const ncx = &ncxs[ix];
9636 ncx->cx_type = cx->cx_type;
9637 if (CxTYPE(cx) == CXt_SUBST) {
9638 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9641 ncx->blk_oldsp = cx->blk_oldsp;
9642 ncx->blk_oldcop = cx->blk_oldcop;
9643 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9644 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9645 ncx->blk_oldpm = cx->blk_oldpm;
9646 ncx->blk_gimme = cx->blk_gimme;
9647 switch (CxTYPE(cx)) {
9649 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9650 ? cv_dup_inc(cx->blk_sub.cv, param)
9651 : cv_dup(cx->blk_sub.cv,param));
9652 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9653 ? av_dup_inc(cx->blk_sub.argarray, param)
9655 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9656 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9657 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9658 ncx->blk_sub.lval = cx->blk_sub.lval;
9659 ncx->blk_sub.retop = cx->blk_sub.retop;
9662 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9663 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9664 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9665 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9666 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9667 ncx->blk_eval.retop = cx->blk_eval.retop;
9670 ncx->blk_loop.label = cx->blk_loop.label;
9671 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9672 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9673 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9674 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9675 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9676 ? cx->blk_loop.iterdata
9677 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9678 ncx->blk_loop.oldcomppad
9679 = (PAD*)ptr_table_fetch(PL_ptr_table,
9680 cx->blk_loop.oldcomppad);
9681 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9682 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9683 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9684 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9685 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9688 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9689 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9690 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9691 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9692 ncx->blk_sub.retop = cx->blk_sub.retop;
9704 /* duplicate a stack info structure */
9707 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9712 return (PERL_SI*)NULL;
9714 /* look for it in the table first */
9715 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9719 /* create anew and remember what it is */
9720 Newxz(nsi, 1, PERL_SI);
9721 ptr_table_store(PL_ptr_table, si, nsi);
9723 nsi->si_stack = av_dup_inc(si->si_stack, param);
9724 nsi->si_cxix = si->si_cxix;
9725 nsi->si_cxmax = si->si_cxmax;
9726 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9727 nsi->si_type = si->si_type;
9728 nsi->si_prev = si_dup(si->si_prev, param);
9729 nsi->si_next = si_dup(si->si_next, param);
9730 nsi->si_markoff = si->si_markoff;
9735 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9736 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9737 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9738 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9739 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9740 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9741 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9742 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9743 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9744 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9745 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9746 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9747 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9748 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9751 #define pv_dup_inc(p) SAVEPV(p)
9752 #define pv_dup(p) SAVEPV(p)
9753 #define svp_dup_inc(p,pp) any_dup(p,pp)
9755 /* map any object to the new equivent - either something in the
9756 * ptr table, or something in the interpreter structure
9760 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9767 /* look for it in the table first */
9768 ret = ptr_table_fetch(PL_ptr_table, v);
9772 /* see if it is part of the interpreter structure */
9773 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9774 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9782 /* duplicate the save stack */
9785 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9787 ANY * const ss = proto_perl->Tsavestack;
9788 const I32 max = proto_perl->Tsavestack_max;
9789 I32 ix = proto_perl->Tsavestack_ix;
9801 void (*dptr) (void*);
9802 void (*dxptr) (pTHX_ void*);
9804 Newxz(nss, max, ANY);
9807 I32 i = POPINT(ss,ix);
9810 case SAVEt_ITEM: /* normal string */
9811 sv = (SV*)POPPTR(ss,ix);
9812 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9813 sv = (SV*)POPPTR(ss,ix);
9814 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9816 case SAVEt_SV: /* scalar reference */
9817 sv = (SV*)POPPTR(ss,ix);
9818 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9819 gv = (GV*)POPPTR(ss,ix);
9820 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9822 case SAVEt_GENERIC_PVREF: /* generic char* */
9823 c = (char*)POPPTR(ss,ix);
9824 TOPPTR(nss,ix) = pv_dup(c);
9825 ptr = POPPTR(ss,ix);
9826 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9828 case SAVEt_SHARED_PVREF: /* char* in shared space */
9829 c = (char*)POPPTR(ss,ix);
9830 TOPPTR(nss,ix) = savesharedpv(c);
9831 ptr = POPPTR(ss,ix);
9832 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9834 case SAVEt_GENERIC_SVREF: /* generic sv */
9835 case SAVEt_SVREF: /* scalar reference */
9836 sv = (SV*)POPPTR(ss,ix);
9837 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9838 ptr = POPPTR(ss,ix);
9839 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9841 case SAVEt_AV: /* array reference */
9842 av = (AV*)POPPTR(ss,ix);
9843 TOPPTR(nss,ix) = av_dup_inc(av, param);
9844 gv = (GV*)POPPTR(ss,ix);
9845 TOPPTR(nss,ix) = gv_dup(gv, param);
9847 case SAVEt_HV: /* hash reference */
9848 hv = (HV*)POPPTR(ss,ix);
9849 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9850 gv = (GV*)POPPTR(ss,ix);
9851 TOPPTR(nss,ix) = gv_dup(gv, param);
9853 case SAVEt_INT: /* int reference */
9854 ptr = POPPTR(ss,ix);
9855 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9856 intval = (int)POPINT(ss,ix);
9857 TOPINT(nss,ix) = intval;
9859 case SAVEt_LONG: /* long reference */
9860 ptr = POPPTR(ss,ix);
9861 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9862 longval = (long)POPLONG(ss,ix);
9863 TOPLONG(nss,ix) = longval;
9865 case SAVEt_I32: /* I32 reference */
9866 case SAVEt_I16: /* I16 reference */
9867 case SAVEt_I8: /* I8 reference */
9868 ptr = POPPTR(ss,ix);
9869 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9873 case SAVEt_IV: /* IV reference */
9874 ptr = POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9879 case SAVEt_SPTR: /* SV* reference */
9880 ptr = POPPTR(ss,ix);
9881 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9882 sv = (SV*)POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = sv_dup(sv, param);
9885 case SAVEt_VPTR: /* random* reference */
9886 ptr = POPPTR(ss,ix);
9887 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9888 ptr = POPPTR(ss,ix);
9889 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9891 case SAVEt_PPTR: /* char* reference */
9892 ptr = POPPTR(ss,ix);
9893 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9894 c = (char*)POPPTR(ss,ix);
9895 TOPPTR(nss,ix) = pv_dup(c);
9897 case SAVEt_HPTR: /* HV* reference */
9898 ptr = POPPTR(ss,ix);
9899 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9900 hv = (HV*)POPPTR(ss,ix);
9901 TOPPTR(nss,ix) = hv_dup(hv, param);
9903 case SAVEt_APTR: /* AV* reference */
9904 ptr = POPPTR(ss,ix);
9905 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9906 av = (AV*)POPPTR(ss,ix);
9907 TOPPTR(nss,ix) = av_dup(av, param);
9910 gv = (GV*)POPPTR(ss,ix);
9911 TOPPTR(nss,ix) = gv_dup(gv, param);
9913 case SAVEt_GP: /* scalar reference */
9914 gp = (GP*)POPPTR(ss,ix);
9915 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9916 (void)GpREFCNT_inc(gp);
9917 gv = (GV*)POPPTR(ss,ix);
9918 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9919 c = (char*)POPPTR(ss,ix);
9920 TOPPTR(nss,ix) = pv_dup(c);
9927 case SAVEt_MORTALIZESV:
9928 sv = (SV*)POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9932 ptr = POPPTR(ss,ix);
9933 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9934 /* these are assumed to be refcounted properly */
9936 switch (((OP*)ptr)->op_type) {
9943 TOPPTR(nss,ix) = ptr;
9948 TOPPTR(nss,ix) = Nullop;
9953 TOPPTR(nss,ix) = Nullop;
9956 c = (char*)POPPTR(ss,ix);
9957 TOPPTR(nss,ix) = pv_dup_inc(c);
9960 longval = POPLONG(ss,ix);
9961 TOPLONG(nss,ix) = longval;
9964 hv = (HV*)POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9966 c = (char*)POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = pv_dup_inc(c);
9971 case SAVEt_DESTRUCTOR:
9972 ptr = POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9974 dptr = POPDPTR(ss,ix);
9975 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9976 any_dup(FPTR2DPTR(void *, dptr),
9979 case SAVEt_DESTRUCTOR_X:
9980 ptr = POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9982 dxptr = POPDXPTR(ss,ix);
9983 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9984 any_dup(FPTR2DPTR(void *, dxptr),
9987 case SAVEt_REGCONTEXT:
9993 case SAVEt_STACK_POS: /* Position on Perl stack */
9997 case SAVEt_AELEM: /* array element */
9998 sv = (SV*)POPPTR(ss,ix);
9999 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10001 TOPINT(nss,ix) = i;
10002 av = (AV*)POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = av_dup_inc(av, param);
10005 case SAVEt_HELEM: /* hash element */
10006 sv = (SV*)POPPTR(ss,ix);
10007 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10008 sv = (SV*)POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10010 hv = (HV*)POPPTR(ss,ix);
10011 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10014 ptr = POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = ptr;
10019 TOPINT(nss,ix) = i;
10021 case SAVEt_COMPPAD:
10022 av = (AV*)POPPTR(ss,ix);
10023 TOPPTR(nss,ix) = av_dup(av, param);
10026 longval = (long)POPLONG(ss,ix);
10027 TOPLONG(nss,ix) = longval;
10028 ptr = POPPTR(ss,ix);
10029 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10030 sv = (SV*)POPPTR(ss,ix);
10031 TOPPTR(nss,ix) = sv_dup(sv, param);
10034 ptr = POPPTR(ss,ix);
10035 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10036 longval = (long)POPBOOL(ss,ix);
10037 TOPBOOL(nss,ix) = (bool)longval;
10039 case SAVEt_SET_SVFLAGS:
10041 TOPINT(nss,ix) = i;
10043 TOPINT(nss,ix) = i;
10044 sv = (SV*)POPPTR(ss,ix);
10045 TOPPTR(nss,ix) = sv_dup(sv, param);
10048 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10056 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10057 * flag to the result. This is done for each stash before cloning starts,
10058 * so we know which stashes want their objects cloned */
10061 do_mark_cloneable_stash(pTHX_ SV *sv)
10063 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10065 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10066 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10067 if (cloner && GvCV(cloner)) {
10074 XPUSHs(sv_2mortal(newSVhek(hvname)));
10076 call_sv((SV*)GvCV(cloner), G_SCALAR);
10083 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10091 =for apidoc perl_clone
10093 Create and return a new interpreter by cloning the current one.
10095 perl_clone takes these flags as parameters:
10097 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10098 without it we only clone the data and zero the stacks,
10099 with it we copy the stacks and the new perl interpreter is
10100 ready to run at the exact same point as the previous one.
10101 The pseudo-fork code uses COPY_STACKS while the
10102 threads->new doesn't.
10104 CLONEf_KEEP_PTR_TABLE
10105 perl_clone keeps a ptr_table with the pointer of the old
10106 variable as a key and the new variable as a value,
10107 this allows it to check if something has been cloned and not
10108 clone it again but rather just use the value and increase the
10109 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10110 the ptr_table using the function
10111 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10112 reason to keep it around is if you want to dup some of your own
10113 variable who are outside the graph perl scans, example of this
10114 code is in threads.xs create
10117 This is a win32 thing, it is ignored on unix, it tells perls
10118 win32host code (which is c++) to clone itself, this is needed on
10119 win32 if you want to run two threads at the same time,
10120 if you just want to do some stuff in a separate perl interpreter
10121 and then throw it away and return to the original one,
10122 you don't need to do anything.
10127 /* XXX the above needs expanding by someone who actually understands it ! */
10128 EXTERN_C PerlInterpreter *
10129 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10132 perl_clone(PerlInterpreter *proto_perl, UV flags)
10135 #ifdef PERL_IMPLICIT_SYS
10137 /* perlhost.h so we need to call into it
10138 to clone the host, CPerlHost should have a c interface, sky */
10140 if (flags & CLONEf_CLONE_HOST) {
10141 return perl_clone_host(proto_perl,flags);
10143 return perl_clone_using(proto_perl, flags,
10145 proto_perl->IMemShared,
10146 proto_perl->IMemParse,
10148 proto_perl->IStdIO,
10152 proto_perl->IProc);
10156 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10157 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10158 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10159 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10160 struct IPerlDir* ipD, struct IPerlSock* ipS,
10161 struct IPerlProc* ipP)
10163 /* XXX many of the string copies here can be optimized if they're
10164 * constants; they need to be allocated as common memory and just
10165 * their pointers copied. */
10168 CLONE_PARAMS clone_params;
10169 CLONE_PARAMS* param = &clone_params;
10171 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10172 /* for each stash, determine whether its objects should be cloned */
10173 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10174 PERL_SET_THX(my_perl);
10177 Poison(my_perl, 1, PerlInterpreter);
10179 PL_curcop = (COP *)Nullop;
10183 PL_savestack_ix = 0;
10184 PL_savestack_max = -1;
10185 PL_sig_pending = 0;
10186 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10187 # else /* !DEBUGGING */
10188 Zero(my_perl, 1, PerlInterpreter);
10189 # endif /* DEBUGGING */
10191 /* host pointers */
10193 PL_MemShared = ipMS;
10194 PL_MemParse = ipMP;
10201 #else /* !PERL_IMPLICIT_SYS */
10203 CLONE_PARAMS clone_params;
10204 CLONE_PARAMS* param = &clone_params;
10205 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10206 /* for each stash, determine whether its objects should be cloned */
10207 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10208 PERL_SET_THX(my_perl);
10211 Poison(my_perl, 1, PerlInterpreter);
10213 PL_curcop = (COP *)Nullop;
10217 PL_savestack_ix = 0;
10218 PL_savestack_max = -1;
10219 PL_sig_pending = 0;
10220 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10221 # else /* !DEBUGGING */
10222 Zero(my_perl, 1, PerlInterpreter);
10223 # endif /* DEBUGGING */
10224 #endif /* PERL_IMPLICIT_SYS */
10225 param->flags = flags;
10226 param->proto_perl = proto_perl;
10228 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10229 Zero(&PL_body_roots, 1, PL_body_roots);
10231 PL_nice_chunk = NULL;
10232 PL_nice_chunk_size = 0;
10234 PL_sv_objcount = 0;
10235 PL_sv_root = Nullsv;
10236 PL_sv_arenaroot = Nullsv;
10238 PL_debug = proto_perl->Idebug;
10240 PL_hash_seed = proto_perl->Ihash_seed;
10241 PL_rehash_seed = proto_perl->Irehash_seed;
10243 #ifdef USE_REENTRANT_API
10244 /* XXX: things like -Dm will segfault here in perlio, but doing
10245 * PERL_SET_CONTEXT(proto_perl);
10246 * breaks too many other things
10248 Perl_reentrant_init(aTHX);
10251 /* create SV map for pointer relocation */
10252 PL_ptr_table = ptr_table_new();
10254 /* initialize these special pointers as early as possible */
10255 SvANY(&PL_sv_undef) = NULL;
10256 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10257 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10258 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10260 SvANY(&PL_sv_no) = new_XPVNV();
10261 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10262 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10263 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10264 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10265 SvCUR_set(&PL_sv_no, 0);
10266 SvLEN_set(&PL_sv_no, 1);
10267 SvIV_set(&PL_sv_no, 0);
10268 SvNV_set(&PL_sv_no, 0);
10269 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10271 SvANY(&PL_sv_yes) = new_XPVNV();
10272 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10273 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10274 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10275 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10276 SvCUR_set(&PL_sv_yes, 1);
10277 SvLEN_set(&PL_sv_yes, 2);
10278 SvIV_set(&PL_sv_yes, 1);
10279 SvNV_set(&PL_sv_yes, 1);
10280 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10282 /* create (a non-shared!) shared string table */
10283 PL_strtab = newHV();
10284 HvSHAREKEYS_off(PL_strtab);
10285 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10286 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10288 PL_compiling = proto_perl->Icompiling;
10290 /* These two PVs will be free'd special way so must set them same way op.c does */
10291 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10292 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10294 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10295 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10297 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10298 if (!specialWARN(PL_compiling.cop_warnings))
10299 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10300 if (!specialCopIO(PL_compiling.cop_io))
10301 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10302 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10304 /* pseudo environmental stuff */
10305 PL_origargc = proto_perl->Iorigargc;
10306 PL_origargv = proto_perl->Iorigargv;
10308 param->stashes = newAV(); /* Setup array of objects to call clone on */
10310 /* Set tainting stuff before PerlIO_debug can possibly get called */
10311 PL_tainting = proto_perl->Itainting;
10312 PL_taint_warn = proto_perl->Itaint_warn;
10314 #ifdef PERLIO_LAYERS
10315 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10316 PerlIO_clone(aTHX_ proto_perl, param);
10319 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10320 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10321 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10322 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10323 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10324 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10327 PL_minus_c = proto_perl->Iminus_c;
10328 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10329 PL_localpatches = proto_perl->Ilocalpatches;
10330 PL_splitstr = proto_perl->Isplitstr;
10331 PL_preprocess = proto_perl->Ipreprocess;
10332 PL_minus_n = proto_perl->Iminus_n;
10333 PL_minus_p = proto_perl->Iminus_p;
10334 PL_minus_l = proto_perl->Iminus_l;
10335 PL_minus_a = proto_perl->Iminus_a;
10336 PL_minus_E = proto_perl->Iminus_E;
10337 PL_minus_F = proto_perl->Iminus_F;
10338 PL_doswitches = proto_perl->Idoswitches;
10339 PL_dowarn = proto_perl->Idowarn;
10340 PL_doextract = proto_perl->Idoextract;
10341 PL_sawampersand = proto_perl->Isawampersand;
10342 PL_unsafe = proto_perl->Iunsafe;
10343 PL_inplace = SAVEPV(proto_perl->Iinplace);
10344 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10345 PL_perldb = proto_perl->Iperldb;
10346 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10347 PL_exit_flags = proto_perl->Iexit_flags;
10349 /* magical thingies */
10350 /* XXX time(&PL_basetime) when asked for? */
10351 PL_basetime = proto_perl->Ibasetime;
10352 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10354 PL_maxsysfd = proto_perl->Imaxsysfd;
10355 PL_multiline = proto_perl->Imultiline;
10356 PL_statusvalue = proto_perl->Istatusvalue;
10358 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10360 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10362 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10364 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10365 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10366 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10368 /* Clone the regex array */
10369 PL_regex_padav = newAV();
10371 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10372 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10374 av_push(PL_regex_padav,
10375 sv_dup_inc(regexen[0],param));
10376 for(i = 1; i <= len; i++) {
10377 const SV * const regex = regexen[i];
10380 ? sv_dup_inc(regex, param)
10382 newSViv(PTR2IV(re_dup(
10383 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10385 av_push(PL_regex_padav, sv);
10388 PL_regex_pad = AvARRAY(PL_regex_padav);
10390 /* shortcuts to various I/O objects */
10391 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10392 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10393 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10394 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10395 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10396 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10398 /* shortcuts to regexp stuff */
10399 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10401 /* shortcuts to misc objects */
10402 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10404 /* shortcuts to debugging objects */
10405 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10406 PL_DBline = gv_dup(proto_perl->IDBline, param);
10407 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10408 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10409 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10410 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10411 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10412 PL_lineary = av_dup(proto_perl->Ilineary, param);
10413 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10415 /* symbol tables */
10416 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10417 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10418 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10419 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10420 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10422 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10423 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10424 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10425 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10426 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10427 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10429 PL_sub_generation = proto_perl->Isub_generation;
10431 /* funky return mechanisms */
10432 PL_forkprocess = proto_perl->Iforkprocess;
10434 /* subprocess state */
10435 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10437 /* internal state */
10438 PL_maxo = proto_perl->Imaxo;
10439 if (proto_perl->Iop_mask)
10440 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10442 PL_op_mask = Nullch;
10443 /* PL_asserting = proto_perl->Iasserting; */
10445 /* current interpreter roots */
10446 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10447 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10448 PL_main_start = proto_perl->Imain_start;
10449 PL_eval_root = proto_perl->Ieval_root;
10450 PL_eval_start = proto_perl->Ieval_start;
10452 /* runtime control stuff */
10453 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10454 PL_copline = proto_perl->Icopline;
10456 PL_filemode = proto_perl->Ifilemode;
10457 PL_lastfd = proto_perl->Ilastfd;
10458 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10461 PL_gensym = proto_perl->Igensym;
10462 PL_preambled = proto_perl->Ipreambled;
10463 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10464 PL_laststatval = proto_perl->Ilaststatval;
10465 PL_laststype = proto_perl->Ilaststype;
10466 PL_mess_sv = Nullsv;
10468 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10470 /* interpreter atexit processing */
10471 PL_exitlistlen = proto_perl->Iexitlistlen;
10472 if (PL_exitlistlen) {
10473 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10474 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10477 PL_exitlist = (PerlExitListEntry*)NULL;
10479 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10480 if (PL_my_cxt_size) {
10481 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10482 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10485 PL_my_cxt_list = (void**)NULL;
10486 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10487 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10488 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10490 PL_profiledata = NULL;
10491 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10492 /* PL_rsfp_filters entries have fake IoDIRP() */
10493 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10495 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10497 PAD_CLONE_VARS(proto_perl, param);
10499 #ifdef HAVE_INTERP_INTERN
10500 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10503 /* more statics moved here */
10504 PL_generation = proto_perl->Igeneration;
10505 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10507 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10508 PL_in_clean_all = proto_perl->Iin_clean_all;
10510 PL_uid = proto_perl->Iuid;
10511 PL_euid = proto_perl->Ieuid;
10512 PL_gid = proto_perl->Igid;
10513 PL_egid = proto_perl->Iegid;
10514 PL_nomemok = proto_perl->Inomemok;
10515 PL_an = proto_perl->Ian;
10516 PL_evalseq = proto_perl->Ievalseq;
10517 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10518 PL_origalen = proto_perl->Iorigalen;
10519 #ifdef PERL_USES_PL_PIDSTATUS
10520 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10522 PL_osname = SAVEPV(proto_perl->Iosname);
10523 PL_sighandlerp = proto_perl->Isighandlerp;
10525 PL_runops = proto_perl->Irunops;
10527 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10530 PL_cshlen = proto_perl->Icshlen;
10531 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10534 PL_lex_state = proto_perl->Ilex_state;
10535 PL_lex_defer = proto_perl->Ilex_defer;
10536 PL_lex_expect = proto_perl->Ilex_expect;
10537 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10538 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10539 PL_lex_starts = proto_perl->Ilex_starts;
10540 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10541 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10542 PL_lex_op = proto_perl->Ilex_op;
10543 PL_lex_inpat = proto_perl->Ilex_inpat;
10544 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10545 PL_lex_brackets = proto_perl->Ilex_brackets;
10546 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10547 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10548 PL_lex_casemods = proto_perl->Ilex_casemods;
10549 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10550 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10552 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10553 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10554 PL_nexttoke = proto_perl->Inexttoke;
10556 /* XXX This is probably masking the deeper issue of why
10557 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10558 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10559 * (A little debugging with a watchpoint on it may help.)
10561 if (SvANY(proto_perl->Ilinestr)) {
10562 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10563 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10564 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10565 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10566 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10567 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10568 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10569 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10570 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10573 PL_linestr = NEWSV(65,79);
10574 sv_upgrade(PL_linestr,SVt_PVIV);
10575 sv_setpvn(PL_linestr,"",0);
10576 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10578 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10579 PL_pending_ident = proto_perl->Ipending_ident;
10580 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10582 PL_expect = proto_perl->Iexpect;
10584 PL_multi_start = proto_perl->Imulti_start;
10585 PL_multi_end = proto_perl->Imulti_end;
10586 PL_multi_open = proto_perl->Imulti_open;
10587 PL_multi_close = proto_perl->Imulti_close;
10589 PL_error_count = proto_perl->Ierror_count;
10590 PL_subline = proto_perl->Isubline;
10591 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10593 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10594 if (SvANY(proto_perl->Ilinestr)) {
10595 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10596 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10597 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10598 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10599 PL_last_lop_op = proto_perl->Ilast_lop_op;
10602 PL_last_uni = SvPVX(PL_linestr);
10603 PL_last_lop = SvPVX(PL_linestr);
10604 PL_last_lop_op = 0;
10606 PL_in_my = proto_perl->Iin_my;
10607 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10609 PL_cryptseen = proto_perl->Icryptseen;
10612 PL_hints = proto_perl->Ihints;
10614 PL_amagic_generation = proto_perl->Iamagic_generation;
10616 #ifdef USE_LOCALE_COLLATE
10617 PL_collation_ix = proto_perl->Icollation_ix;
10618 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10619 PL_collation_standard = proto_perl->Icollation_standard;
10620 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10621 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10622 #endif /* USE_LOCALE_COLLATE */
10624 #ifdef USE_LOCALE_NUMERIC
10625 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10626 PL_numeric_standard = proto_perl->Inumeric_standard;
10627 PL_numeric_local = proto_perl->Inumeric_local;
10628 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10629 #endif /* !USE_LOCALE_NUMERIC */
10631 /* utf8 character classes */
10632 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10633 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10634 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10635 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10636 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10637 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10638 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10639 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10640 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10641 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10642 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10643 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10644 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10645 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10646 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10647 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10648 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10649 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10650 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10651 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10653 /* Did the locale setup indicate UTF-8? */
10654 PL_utf8locale = proto_perl->Iutf8locale;
10655 /* Unicode features (see perlrun/-C) */
10656 PL_unicode = proto_perl->Iunicode;
10658 /* Pre-5.8 signals control */
10659 PL_signals = proto_perl->Isignals;
10661 /* times() ticks per second */
10662 PL_clocktick = proto_perl->Iclocktick;
10664 /* Recursion stopper for PerlIO_find_layer */
10665 PL_in_load_module = proto_perl->Iin_load_module;
10667 /* sort() routine */
10668 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10670 /* Not really needed/useful since the reenrant_retint is "volatile",
10671 * but do it for consistency's sake. */
10672 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10674 /* Hooks to shared SVs and locks. */
10675 PL_sharehook = proto_perl->Isharehook;
10676 PL_lockhook = proto_perl->Ilockhook;
10677 PL_unlockhook = proto_perl->Iunlockhook;
10678 PL_threadhook = proto_perl->Ithreadhook;
10680 PL_runops_std = proto_perl->Irunops_std;
10681 PL_runops_dbg = proto_perl->Irunops_dbg;
10683 #ifdef THREADS_HAVE_PIDS
10684 PL_ppid = proto_perl->Ippid;
10688 PL_last_swash_hv = NULL; /* reinits on demand */
10689 PL_last_swash_klen = 0;
10690 PL_last_swash_key[0]= '\0';
10691 PL_last_swash_tmps = (U8*)NULL;
10692 PL_last_swash_slen = 0;
10694 PL_glob_index = proto_perl->Iglob_index;
10695 PL_srand_called = proto_perl->Isrand_called;
10696 PL_uudmap['M'] = 0; /* reinits on demand */
10697 PL_bitcount = Nullch; /* reinits on demand */
10699 if (proto_perl->Ipsig_pend) {
10700 Newxz(PL_psig_pend, SIG_SIZE, int);
10703 PL_psig_pend = (int*)NULL;
10706 if (proto_perl->Ipsig_ptr) {
10707 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10708 Newxz(PL_psig_name, SIG_SIZE, SV*);
10709 for (i = 1; i < SIG_SIZE; i++) {
10710 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10711 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10715 PL_psig_ptr = (SV**)NULL;
10716 PL_psig_name = (SV**)NULL;
10719 /* thrdvar.h stuff */
10721 if (flags & CLONEf_COPY_STACKS) {
10722 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10723 PL_tmps_ix = proto_perl->Ttmps_ix;
10724 PL_tmps_max = proto_perl->Ttmps_max;
10725 PL_tmps_floor = proto_perl->Ttmps_floor;
10726 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10728 while (i <= PL_tmps_ix) {
10729 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10733 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10734 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10735 Newxz(PL_markstack, i, I32);
10736 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10737 - proto_perl->Tmarkstack);
10738 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10739 - proto_perl->Tmarkstack);
10740 Copy(proto_perl->Tmarkstack, PL_markstack,
10741 PL_markstack_ptr - PL_markstack + 1, I32);
10743 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10744 * NOTE: unlike the others! */
10745 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10746 PL_scopestack_max = proto_perl->Tscopestack_max;
10747 Newxz(PL_scopestack, PL_scopestack_max, I32);
10748 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10750 /* NOTE: si_dup() looks at PL_markstack */
10751 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10753 /* PL_curstack = PL_curstackinfo->si_stack; */
10754 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10755 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10757 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10758 PL_stack_base = AvARRAY(PL_curstack);
10759 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10760 - proto_perl->Tstack_base);
10761 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10763 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10764 * NOTE: unlike the others! */
10765 PL_savestack_ix = proto_perl->Tsavestack_ix;
10766 PL_savestack_max = proto_perl->Tsavestack_max;
10767 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10768 PL_savestack = ss_dup(proto_perl, param);
10772 ENTER; /* perl_destruct() wants to LEAVE; */
10774 /* although we're not duplicating the tmps stack, we should still
10775 * add entries for any SVs on the tmps stack that got cloned by a
10776 * non-refcount means (eg a temp in @_); otherwise they will be
10779 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10780 SV *nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10781 proto_perl->Ttmps_stack[i]);
10782 if (nsv && !SvREFCNT(nsv)) {
10784 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10789 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10790 PL_top_env = &PL_start_env;
10792 PL_op = proto_perl->Top;
10795 PL_Xpv = (XPV*)NULL;
10796 PL_na = proto_perl->Tna;
10798 PL_statbuf = proto_perl->Tstatbuf;
10799 PL_statcache = proto_perl->Tstatcache;
10800 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10801 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10803 PL_timesbuf = proto_perl->Ttimesbuf;
10806 PL_tainted = proto_perl->Ttainted;
10807 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10808 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10809 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10810 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10811 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10812 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10813 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10814 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10815 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10817 PL_restartop = proto_perl->Trestartop;
10818 PL_in_eval = proto_perl->Tin_eval;
10819 PL_delaymagic = proto_perl->Tdelaymagic;
10820 PL_dirty = proto_perl->Tdirty;
10821 PL_localizing = proto_perl->Tlocalizing;
10823 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10824 PL_hv_fetch_ent_mh = Nullhe;
10825 PL_modcount = proto_perl->Tmodcount;
10826 PL_lastgotoprobe = Nullop;
10827 PL_dumpindent = proto_perl->Tdumpindent;
10829 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10830 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10831 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10832 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10833 PL_efloatbuf = Nullch; /* reinits on demand */
10834 PL_efloatsize = 0; /* reinits on demand */
10838 PL_screamfirst = NULL;
10839 PL_screamnext = NULL;
10840 PL_maxscream = -1; /* reinits on demand */
10841 PL_lastscream = Nullsv;
10843 PL_watchaddr = NULL;
10844 PL_watchok = Nullch;
10846 PL_regdummy = proto_perl->Tregdummy;
10847 PL_regprecomp = Nullch;
10850 PL_colorset = 0; /* reinits PL_colors[] */
10851 /*PL_colors[6] = {0,0,0,0,0,0};*/
10852 PL_reginput = Nullch;
10853 PL_regbol = Nullch;
10854 PL_regeol = Nullch;
10855 PL_regstartp = (I32*)NULL;
10856 PL_regendp = (I32*)NULL;
10857 PL_reglastparen = (U32*)NULL;
10858 PL_reglastcloseparen = (U32*)NULL;
10859 PL_regtill = Nullch;
10860 PL_reg_start_tmp = (char**)NULL;
10861 PL_reg_start_tmpl = 0;
10862 PL_regdata = (struct reg_data*)NULL;
10865 PL_reg_eval_set = 0;
10867 PL_regprogram = (regnode*)NULL;
10869 PL_regcc = (CURCUR*)NULL;
10870 PL_reg_call_cc = (struct re_cc_state*)NULL;
10871 PL_reg_re = (regexp*)NULL;
10872 PL_reg_ganch = Nullch;
10873 PL_reg_sv = Nullsv;
10874 PL_reg_match_utf8 = FALSE;
10875 PL_reg_magic = (MAGIC*)NULL;
10877 PL_reg_oldcurpm = (PMOP*)NULL;
10878 PL_reg_curpm = (PMOP*)NULL;
10879 PL_reg_oldsaved = Nullch;
10880 PL_reg_oldsavedlen = 0;
10881 #ifdef PERL_OLD_COPY_ON_WRITE
10884 PL_reg_maxiter = 0;
10885 PL_reg_leftiter = 0;
10886 PL_reg_poscache = Nullch;
10887 PL_reg_poscache_size= 0;
10889 /* RE engine - function pointers */
10890 PL_regcompp = proto_perl->Tregcompp;
10891 PL_regexecp = proto_perl->Tregexecp;
10892 PL_regint_start = proto_perl->Tregint_start;
10893 PL_regint_string = proto_perl->Tregint_string;
10894 PL_regfree = proto_perl->Tregfree;
10896 PL_reginterp_cnt = 0;
10897 PL_reg_starttry = 0;
10899 /* Pluggable optimizer */
10900 PL_peepp = proto_perl->Tpeepp;
10902 PL_stashcache = newHV();
10904 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10905 ptr_table_free(PL_ptr_table);
10906 PL_ptr_table = NULL;
10909 /* Call the ->CLONE method, if it exists, for each of the stashes
10910 identified by sv_dup() above.
10912 while(av_len(param->stashes) != -1) {
10913 HV* const stash = (HV*) av_shift(param->stashes);
10914 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10915 if (cloner && GvCV(cloner)) {
10920 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10922 call_sv((SV*)GvCV(cloner), G_DISCARD);
10928 SvREFCNT_dec(param->stashes);
10930 /* orphaned? eg threads->new inside BEGIN or use */
10931 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10932 (void)SvREFCNT_inc(PL_compcv);
10933 SAVEFREESV(PL_compcv);
10939 #endif /* USE_ITHREADS */
10942 =head1 Unicode Support
10944 =for apidoc sv_recode_to_utf8
10946 The encoding is assumed to be an Encode object, on entry the PV
10947 of the sv is assumed to be octets in that encoding, and the sv
10948 will be converted into Unicode (and UTF-8).
10950 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10951 is not a reference, nothing is done to the sv. If the encoding is not
10952 an C<Encode::XS> Encoding object, bad things will happen.
10953 (See F<lib/encoding.pm> and L<Encode>).
10955 The PV of the sv is returned.
10960 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10963 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10977 Passing sv_yes is wrong - it needs to be or'ed set of constants
10978 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10979 remove converted chars from source.
10981 Both will default the value - let them.
10983 XPUSHs(&PL_sv_yes);
10986 call_method("decode", G_SCALAR);
10990 s = SvPV_const(uni, len);
10991 if (s != SvPVX_const(sv)) {
10992 SvGROW(sv, len + 1);
10993 Move(s, SvPVX(sv), len + 1, char);
10994 SvCUR_set(sv, len);
11001 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11005 =for apidoc sv_cat_decode
11007 The encoding is assumed to be an Encode object, the PV of the ssv is
11008 assumed to be octets in that encoding and decoding the input starts
11009 from the position which (PV + *offset) pointed to. The dsv will be
11010 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11011 when the string tstr appears in decoding output or the input ends on
11012 the PV of the ssv. The value which the offset points will be modified
11013 to the last input position on the ssv.
11015 Returns TRUE if the terminator was found, else returns FALSE.
11020 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11021 SV *ssv, int *offset, char *tstr, int tlen)
11025 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11036 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11037 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11039 call_method("cat_decode", G_SCALAR);
11041 ret = SvTRUE(TOPs);
11042 *offset = SvIV(offsv);
11048 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11053 /* ---------------------------------------------------------------------
11055 * support functions for report_uninit()
11058 /* the maxiumum size of array or hash where we will scan looking
11059 * for the undefined element that triggered the warning */
11061 #define FUV_MAX_SEARCH_SIZE 1000
11063 /* Look for an entry in the hash whose value has the same SV as val;
11064 * If so, return a mortal copy of the key. */
11067 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11070 register HE **array;
11073 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11074 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11077 array = HvARRAY(hv);
11079 for (i=HvMAX(hv); i>0; i--) {
11080 register HE *entry;
11081 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11082 if (HeVAL(entry) != val)
11084 if ( HeVAL(entry) == &PL_sv_undef ||
11085 HeVAL(entry) == &PL_sv_placeholder)
11089 if (HeKLEN(entry) == HEf_SVKEY)
11090 return sv_mortalcopy(HeKEY_sv(entry));
11091 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11097 /* Look for an entry in the array whose value has the same SV as val;
11098 * If so, return the index, otherwise return -1. */
11101 S_find_array_subscript(pTHX_ AV *av, SV* val)
11105 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11106 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11110 for (i=AvFILLp(av); i>=0; i--) {
11111 if (svp[i] == val && svp[i] != &PL_sv_undef)
11117 /* S_varname(): return the name of a variable, optionally with a subscript.
11118 * If gv is non-zero, use the name of that global, along with gvtype (one
11119 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11120 * targ. Depending on the value of the subscript_type flag, return:
11123 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11124 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11125 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11126 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11129 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11130 SV* keyname, I32 aindex, int subscript_type)
11133 SV * const name = sv_newmortal();
11136 buffer[0] = gvtype;
11139 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11141 gv_fullname4(name, gv, buffer, 0);
11143 if ((unsigned int)SvPVX(name)[1] <= 26) {
11145 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11147 /* Swap the 1 unprintable control character for the 2 byte pretty
11148 version - ie substr($name, 1, 1) = $buffer; */
11149 sv_insert(name, 1, 1, buffer, 2);
11154 CV * const cv = find_runcv(&unused);
11158 if (!cv || !CvPADLIST(cv))
11160 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11161 sv = *av_fetch(av, targ, FALSE);
11162 /* SvLEN in a pad name is not to be trusted */
11163 sv_setpv(name, SvPV_nolen_const(sv));
11166 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11167 SV * const sv = NEWSV(0,0);
11168 *SvPVX(name) = '$';
11169 Perl_sv_catpvf(aTHX_ name, "{%s}",
11170 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11173 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11174 *SvPVX(name) = '$';
11175 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11177 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11178 sv_insert(name, 0, 0, STR_WITH_LEN("within "));
11185 =for apidoc find_uninit_var
11187 Find the name of the undefined variable (if any) that caused the operator o
11188 to issue a "Use of uninitialized value" warning.
11189 If match is true, only return a name if it's value matches uninit_sv.
11190 So roughly speaking, if a unary operator (such as OP_COS) generates a
11191 warning, then following the direct child of the op may yield an
11192 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11193 other hand, with OP_ADD there are two branches to follow, so we only print
11194 the variable name if we get an exact match.
11196 The name is returned as a mortal SV.
11198 Assumes that PL_op is the op that originally triggered the error, and that
11199 PL_comppad/PL_curpad points to the currently executing pad.
11205 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11213 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11214 uninit_sv == &PL_sv_placeholder)))
11217 switch (obase->op_type) {
11224 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11225 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11227 SV *keysv = Nullsv;
11228 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11230 if (pad) { /* @lex, %lex */
11231 sv = PAD_SVl(obase->op_targ);
11235 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11236 /* @global, %global */
11237 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11240 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11242 else /* @{expr}, %{expr} */
11243 return find_uninit_var(cUNOPx(obase)->op_first,
11247 /* attempt to find a match within the aggregate */
11249 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11251 subscript_type = FUV_SUBSCRIPT_HASH;
11254 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11256 subscript_type = FUV_SUBSCRIPT_ARRAY;
11259 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11262 return varname(gv, hash ? '%' : '@', obase->op_targ,
11263 keysv, index, subscript_type);
11267 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11269 return varname(Nullgv, '$', obase->op_targ,
11270 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11273 gv = cGVOPx_gv(obase);
11274 if (!gv || (match && GvSV(gv) != uninit_sv))
11276 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11279 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11282 av = (AV*)PAD_SV(obase->op_targ);
11283 if (!av || SvRMAGICAL(av))
11285 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11286 if (!svp || *svp != uninit_sv)
11289 return varname(Nullgv, '$', obase->op_targ,
11290 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11293 gv = cGVOPx_gv(obase);
11299 if (!av || SvRMAGICAL(av))
11301 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11302 if (!svp || *svp != uninit_sv)
11305 return varname(gv, '$', 0,
11306 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11311 o = cUNOPx(obase)->op_first;
11312 if (!o || o->op_type != OP_NULL ||
11313 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11315 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11319 if (PL_op == obase)
11320 /* $a[uninit_expr] or $h{uninit_expr} */
11321 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11324 o = cBINOPx(obase)->op_first;
11325 kid = cBINOPx(obase)->op_last;
11327 /* get the av or hv, and optionally the gv */
11329 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11330 sv = PAD_SV(o->op_targ);
11332 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11333 && cUNOPo->op_first->op_type == OP_GV)
11335 gv = cGVOPx_gv(cUNOPo->op_first);
11338 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11343 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11344 /* index is constant */
11348 if (obase->op_type == OP_HELEM) {
11349 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11350 if (!he || HeVAL(he) != uninit_sv)
11354 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11355 if (!svp || *svp != uninit_sv)
11359 if (obase->op_type == OP_HELEM)
11360 return varname(gv, '%', o->op_targ,
11361 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11363 return varname(gv, '@', o->op_targ, Nullsv,
11364 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11367 /* index is an expression;
11368 * attempt to find a match within the aggregate */
11369 if (obase->op_type == OP_HELEM) {
11370 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11372 return varname(gv, '%', o->op_targ,
11373 keysv, 0, FUV_SUBSCRIPT_HASH);
11376 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11378 return varname(gv, '@', o->op_targ,
11379 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11384 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11386 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11392 /* only examine RHS */
11393 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11396 o = cUNOPx(obase)->op_first;
11397 if (o->op_type == OP_PUSHMARK)
11400 if (!o->op_sibling) {
11401 /* one-arg version of open is highly magical */
11403 if (o->op_type == OP_GV) { /* open FOO; */
11405 if (match && GvSV(gv) != uninit_sv)
11407 return varname(gv, '$', 0,
11408 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11410 /* other possibilities not handled are:
11411 * open $x; or open my $x; should return '${*$x}'
11412 * open expr; should return '$'.expr ideally
11418 /* ops where $_ may be an implicit arg */
11422 if ( !(obase->op_flags & OPf_STACKED)) {
11423 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11424 ? PAD_SVl(obase->op_targ)
11427 sv = sv_newmortal();
11428 sv_setpvn(sv, "$_", 2);
11436 /* skip filehandle as it can't produce 'undef' warning */
11437 o = cUNOPx(obase)->op_first;
11438 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11439 o = o->op_sibling->op_sibling;
11446 match = 1; /* XS or custom code could trigger random warnings */
11451 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11452 return sv_2mortal(newSVpvs("${$/}"));
11457 if (!(obase->op_flags & OPf_KIDS))
11459 o = cUNOPx(obase)->op_first;
11465 /* if all except one arg are constant, or have no side-effects,
11466 * or are optimized away, then it's unambiguous */
11468 for (kid=o; kid; kid = kid->op_sibling) {
11470 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11471 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11472 || (kid->op_type == OP_PUSHMARK)
11476 if (o2) { /* more than one found */
11483 return find_uninit_var(o2, uninit_sv, match);
11485 /* scan all args */
11487 sv = find_uninit_var(o, uninit_sv, 1);
11499 =for apidoc report_uninit
11501 Print appropriate "Use of uninitialized variable" warning
11507 Perl_report_uninit(pTHX_ SV* uninit_sv)
11510 SV* varname = Nullsv;
11512 varname = find_uninit_var(PL_op, uninit_sv,0);
11514 sv_insert(varname, 0, 0, " ", 1);
11516 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11517 varname ? SvPV_nolen_const(varname) : "",
11518 " in ", OP_DESC(PL_op));
11521 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11527 * c-indentation-style: bsd
11528 * c-basic-offset: 4
11529 * indent-tabs-mode: t
11532 * ex: set ts=8 sts=4 sw=4 noet: