3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void ** const arena_root = &PL_body_arenaroots[sv_type];
644 void ** const root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void ** const r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv))
1894 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1895 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1901 if (SvTHINKFIRST(sv)) {
1904 SV * const tmpstr=AMG_CALLun(sv,numer);
1905 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1906 return SvIV(tmpstr);
1909 return PTR2IV(SvRV(sv));
1912 sv_force_normal_flags(sv, 0);
1914 if (SvREADONLY(sv) && !SvOK(sv)) {
1915 if (ckWARN(WARN_UNINITIALIZED))
1921 if (S_sv_2iuv_common(aTHX_ sv))
1924 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1925 PTR2UV(sv),SvIVX(sv)));
1926 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1930 =for apidoc sv_2uv_flags
1932 Return the unsigned integer value of an SV, doing any necessary string
1933 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1934 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1940 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1944 if (SvGMAGICAL(sv)) {
1945 if (flags & SV_GMAGIC)
1950 return U_V(SvNVX(sv));
1951 if (SvPOKp(sv) && SvLEN(sv))
1954 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1955 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1961 if (SvTHINKFIRST(sv)) {
1964 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1965 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1966 return SvUV(tmpstr);
1967 return PTR2UV(SvRV(sv));
1970 sv_force_normal_flags(sv, 0);
1972 if (SvREADONLY(sv) && !SvOK(sv)) {
1973 if (ckWARN(WARN_UNINITIALIZED))
1979 if (S_sv_2iuv_common(aTHX_ sv))
1983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
1984 PTR2UV(sv),SvUVX(sv)));
1985 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
1991 Return the num value of an SV, doing any necessary string or integer
1992 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
1999 Perl_sv_2nv(pTHX_ register SV *sv)
2003 if (SvGMAGICAL(sv)) {
2007 if (SvPOKp(sv) && SvLEN(sv)) {
2008 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2009 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2011 return Atof(SvPVX_const(sv));
2015 return (NV)SvUVX(sv);
2017 return (NV)SvIVX(sv);
2020 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2021 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2027 if (SvTHINKFIRST(sv)) {
2030 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2031 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2032 return SvNV(tmpstr);
2033 return PTR2NV(SvRV(sv));
2036 sv_force_normal_flags(sv, 0);
2038 if (SvREADONLY(sv) && !SvOK(sv)) {
2039 if (ckWARN(WARN_UNINITIALIZED))
2044 if (SvTYPE(sv) < SVt_NV) {
2045 if (SvTYPE(sv) == SVt_IV)
2046 sv_upgrade(sv, SVt_PVNV);
2048 sv_upgrade(sv, SVt_NV);
2049 #ifdef USE_LONG_DOUBLE
2051 STORE_NUMERIC_LOCAL_SET_STANDARD();
2052 PerlIO_printf(Perl_debug_log,
2053 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2054 PTR2UV(sv), SvNVX(sv));
2055 RESTORE_NUMERIC_LOCAL();
2059 STORE_NUMERIC_LOCAL_SET_STANDARD();
2060 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2061 PTR2UV(sv), SvNVX(sv));
2062 RESTORE_NUMERIC_LOCAL();
2066 else if (SvTYPE(sv) < SVt_PVNV)
2067 sv_upgrade(sv, SVt_PVNV);
2072 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2073 #ifdef NV_PRESERVES_UV
2076 /* Only set the public NV OK flag if this NV preserves the IV */
2077 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2078 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2079 : (SvIVX(sv) == I_V(SvNVX(sv))))
2085 else if (SvPOKp(sv) && SvLEN(sv)) {
2087 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2088 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2090 #ifdef NV_PRESERVES_UV
2091 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2092 == IS_NUMBER_IN_UV) {
2093 /* It's definitely an integer */
2094 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2096 SvNV_set(sv, Atof(SvPVX_const(sv)));
2099 SvNV_set(sv, Atof(SvPVX_const(sv)));
2100 /* Only set the public NV OK flag if this NV preserves the value in
2101 the PV at least as well as an IV/UV would.
2102 Not sure how to do this 100% reliably. */
2103 /* if that shift count is out of range then Configure's test is
2104 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2106 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2107 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2108 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2109 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2110 /* Can't use strtol etc to convert this string, so don't try.
2111 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2114 /* value has been set. It may not be precise. */
2115 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2116 /* 2s complement assumption for (UV)IV_MIN */
2117 SvNOK_on(sv); /* Integer is too negative. */
2122 if (numtype & IS_NUMBER_NEG) {
2123 SvIV_set(sv, -(IV)value);
2124 } else if (value <= (UV)IV_MAX) {
2125 SvIV_set(sv, (IV)value);
2127 SvUV_set(sv, value);
2131 if (numtype & IS_NUMBER_NOT_INT) {
2132 /* I believe that even if the original PV had decimals,
2133 they are lost beyond the limit of the FP precision.
2134 However, neither is canonical, so both only get p
2135 flags. NWC, 2000/11/25 */
2136 /* Both already have p flags, so do nothing */
2138 const NV nv = SvNVX(sv);
2139 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2140 if (SvIVX(sv) == I_V(nv)) {
2143 /* It had no "." so it must be integer. */
2147 /* between IV_MAX and NV(UV_MAX).
2148 Could be slightly > UV_MAX */
2150 if (numtype & IS_NUMBER_NOT_INT) {
2151 /* UV and NV both imprecise. */
2153 const UV nv_as_uv = U_V(nv);
2155 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2164 #endif /* NV_PRESERVES_UV */
2167 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2169 if (SvTYPE(sv) < SVt_NV)
2170 /* Typically the caller expects that sv_any is not NULL now. */
2171 /* XXX Ilya implies that this is a bug in callers that assume this
2172 and ideally should be fixed. */
2173 sv_upgrade(sv, SVt_NV);
2176 #if defined(USE_LONG_DOUBLE)
2178 STORE_NUMERIC_LOCAL_SET_STANDARD();
2179 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2180 PTR2UV(sv), SvNVX(sv));
2181 RESTORE_NUMERIC_LOCAL();
2185 STORE_NUMERIC_LOCAL_SET_STANDARD();
2186 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2187 PTR2UV(sv), SvNVX(sv));
2188 RESTORE_NUMERIC_LOCAL();
2194 /* asIV(): extract an integer from the string value of an SV.
2195 * Caller must validate PVX */
2198 S_asIV(pTHX_ SV *sv)
2201 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2203 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2204 == IS_NUMBER_IN_UV) {
2205 /* It's definitely an integer */
2206 if (numtype & IS_NUMBER_NEG) {
2207 if (value < (UV)IV_MIN)
2210 if (value < (UV)IV_MAX)
2215 if (ckWARN(WARN_NUMERIC))
2218 return I_V(Atof(SvPVX_const(sv)));
2221 /* asUV(): extract an unsigned integer from the string value of an SV
2222 * Caller must validate PVX */
2225 S_asUV(pTHX_ SV *sv)
2228 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2230 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2231 == IS_NUMBER_IN_UV) {
2232 /* It's definitely an integer */
2233 if (!(numtype & IS_NUMBER_NEG))
2237 if (ckWARN(WARN_NUMERIC))
2240 return U_V(Atof(SvPVX_const(sv)));
2243 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2244 * UV as a string towards the end of buf, and return pointers to start and
2247 * We assume that buf is at least TYPE_CHARS(UV) long.
2251 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2253 char *ptr = buf + TYPE_CHARS(UV);
2254 char * const ebuf = ptr;
2267 *--ptr = '0' + (char)(uv % 10);
2275 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2276 * a regexp to its stringified form.
2280 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2281 const regexp * const re = (regexp *)mg->mg_obj;
2284 const char *fptr = "msix";
2289 bool need_newline = 0;
2290 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2292 while((ch = *fptr++)) {
2294 reflags[left++] = ch;
2297 reflags[right--] = ch;
2302 reflags[left] = '-';
2306 mg->mg_len = re->prelen + 4 + left;
2308 * If /x was used, we have to worry about a regex ending with a
2309 * comment later being embedded within another regex. If so, we don't
2310 * want this regex's "commentization" to leak out to the right part of
2311 * the enclosing regex, we must cap it with a newline.
2313 * So, if /x was used, we scan backwards from the end of the regex. If
2314 * we find a '#' before we find a newline, we need to add a newline
2315 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2316 * we don't need to add anything. -jfriedl
2318 if (PMf_EXTENDED & re->reganch) {
2319 const char *endptr = re->precomp + re->prelen;
2320 while (endptr >= re->precomp) {
2321 const char c = *(endptr--);
2323 break; /* don't need another */
2325 /* we end while in a comment, so we need a newline */
2326 mg->mg_len++; /* save space for it */
2327 need_newline = 1; /* note to add it */
2333 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2334 mg->mg_ptr[0] = '(';
2335 mg->mg_ptr[1] = '?';
2336 Copy(reflags, mg->mg_ptr+2, left, char);
2337 *(mg->mg_ptr+left+2) = ':';
2338 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2340 mg->mg_ptr[mg->mg_len - 2] = '\n';
2341 mg->mg_ptr[mg->mg_len - 1] = ')';
2342 mg->mg_ptr[mg->mg_len] = 0;
2344 PL_reginterp_cnt += re->program[0].next_off;
2346 if (re->reganch & ROPT_UTF8)
2356 =for apidoc sv_2pv_flags
2358 Returns a pointer to the string value of an SV, and sets *lp to its length.
2359 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2361 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2362 usually end up here too.
2368 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2378 if (SvGMAGICAL(sv)) {
2379 if (flags & SV_GMAGIC)
2384 if (flags & SV_MUTABLE_RETURN)
2385 return SvPVX_mutable(sv);
2386 if (flags & SV_CONST_RETURN)
2387 return (char *)SvPVX_const(sv);
2390 if (SvIOKp(sv) || SvNOKp(sv)) {
2391 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2395 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2396 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2398 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2401 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2402 /* Sneaky stuff here */
2403 SV * const tsv = newSVpvn(tbuf, len);
2413 #ifdef FIXNEGATIVEZERO
2414 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2420 SvUPGRADE(sv, SVt_PV);
2423 s = SvGROW_mutable(sv, len + 1);
2426 return memcpy(s, tbuf, len + 1);
2430 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2431 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2439 if (SvTHINKFIRST(sv)) {
2443 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2444 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2446 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2449 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2450 if (flags & SV_CONST_RETURN) {
2451 pv = (char *) SvPVX_const(tmpstr);
2453 pv = (flags & SV_MUTABLE_RETURN)
2454 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2457 *lp = SvCUR(tmpstr);
2459 pv = sv_2pv_flags(tmpstr, lp, flags);
2469 const SV *const referent = (SV*)SvRV(sv);
2472 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2473 } else if (SvTYPE(referent) == SVt_PVMG
2474 && ((SvFLAGS(referent) &
2475 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2476 == (SVs_OBJECT|SVs_SMG))
2477 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2478 return S_stringify_regexp(aTHX_ sv, mg, lp);
2480 const char *const typestr = sv_reftype(referent, 0);
2482 tsv = sv_newmortal();
2483 if (SvOBJECT(referent)) {
2484 const char *const name = HvNAME_get(SvSTASH(referent));
2485 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2486 name ? name : "__ANON__" , typestr,
2490 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2498 if (SvREADONLY(sv) && !SvOK(sv)) {
2499 if (ckWARN(WARN_UNINITIALIZED))
2506 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2507 /* I'm assuming that if both IV and NV are equally valid then
2508 converting the IV is going to be more efficient */
2509 const U32 isIOK = SvIOK(sv);
2510 const U32 isUIOK = SvIsUV(sv);
2511 char buf[TYPE_CHARS(UV)];
2514 if (SvTYPE(sv) < SVt_PVIV)
2515 sv_upgrade(sv, SVt_PVIV);
2517 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2519 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2520 /* inlined from sv_setpvn */
2521 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2522 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2523 SvCUR_set(sv, ebuf - ptr);
2533 else if (SvNOKp(sv)) {
2534 if (SvTYPE(sv) < SVt_PVNV)
2535 sv_upgrade(sv, SVt_PVNV);
2536 /* The +20 is pure guesswork. Configure test needed. --jhi */
2537 s = SvGROW_mutable(sv, NV_DIG + 20);
2538 olderrno = errno; /* some Xenix systems wipe out errno here */
2540 if (SvNVX(sv) == 0.0)
2541 (void)strcpy(s,"0");
2545 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2548 #ifdef FIXNEGATIVEZERO
2549 if (*s == '-' && s[1] == '0' && !s[2])
2559 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2563 if (SvTYPE(sv) < SVt_PV)
2564 /* Typically the caller expects that sv_any is not NULL now. */
2565 sv_upgrade(sv, SVt_PV);
2569 const STRLEN len = s - SvPVX_const(sv);
2575 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2576 PTR2UV(sv),SvPVX_const(sv)));
2577 if (flags & SV_CONST_RETURN)
2578 return (char *)SvPVX_const(sv);
2579 if (flags & SV_MUTABLE_RETURN)
2580 return SvPVX_mutable(sv);
2585 =for apidoc sv_copypv
2587 Copies a stringified representation of the source SV into the
2588 destination SV. Automatically performs any necessary mg_get and
2589 coercion of numeric values into strings. Guaranteed to preserve
2590 UTF-8 flag even from overloaded objects. Similar in nature to
2591 sv_2pv[_flags] but operates directly on an SV instead of just the
2592 string. Mostly uses sv_2pv_flags to do its work, except when that
2593 would lose the UTF-8'ness of the PV.
2599 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2602 const char * const s = SvPV_const(ssv,len);
2603 sv_setpvn(dsv,s,len);
2611 =for apidoc sv_2pvbyte
2613 Return a pointer to the byte-encoded representation of the SV, and set *lp
2614 to its length. May cause the SV to be downgraded from UTF-8 as a
2617 Usually accessed via the C<SvPVbyte> macro.
2623 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2625 sv_utf8_downgrade(sv,0);
2626 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2630 =for apidoc sv_2pvutf8
2632 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2633 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2635 Usually accessed via the C<SvPVutf8> macro.
2641 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2643 sv_utf8_upgrade(sv);
2644 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2649 =for apidoc sv_2bool
2651 This function is only called on magical items, and is only used by
2652 sv_true() or its macro equivalent.
2658 Perl_sv_2bool(pTHX_ register SV *sv)
2666 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2667 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2668 return (bool)SvTRUE(tmpsv);
2669 return SvRV(sv) != 0;
2672 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2674 (*sv->sv_u.svu_pv > '0' ||
2675 Xpvtmp->xpv_cur > 1 ||
2676 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2683 return SvIVX(sv) != 0;
2686 return SvNVX(sv) != 0.0;
2694 =for apidoc sv_utf8_upgrade
2696 Converts the PV of an SV to its UTF-8-encoded form.
2697 Forces the SV to string form if it is not already.
2698 Always sets the SvUTF8 flag to avoid future validity checks even
2699 if all the bytes have hibit clear.
2701 This is not as a general purpose byte encoding to Unicode interface:
2702 use the Encode extension for that.
2704 =for apidoc sv_utf8_upgrade_flags
2706 Converts the PV of an SV to its UTF-8-encoded form.
2707 Forces the SV to string form if it is not already.
2708 Always sets the SvUTF8 flag to avoid future validity checks even
2709 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2710 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2711 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2713 This is not as a general purpose byte encoding to Unicode interface:
2714 use the Encode extension for that.
2720 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2722 if (sv == &PL_sv_undef)
2726 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2727 (void) sv_2pv_flags(sv,&len, flags);
2731 (void) SvPV_force(sv,len);
2740 sv_force_normal_flags(sv, 0);
2743 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2744 sv_recode_to_utf8(sv, PL_encoding);
2745 else { /* Assume Latin-1/EBCDIC */
2746 /* This function could be much more efficient if we
2747 * had a FLAG in SVs to signal if there are any hibit
2748 * chars in the PV. Given that there isn't such a flag
2749 * make the loop as fast as possible. */
2750 const U8 * const s = (U8 *) SvPVX_const(sv);
2751 const U8 * const e = (U8 *) SvEND(sv);
2756 /* Check for hi bit */
2757 if (!NATIVE_IS_INVARIANT(ch)) {
2758 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2759 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2761 SvPV_free(sv); /* No longer using what was there before. */
2762 SvPV_set(sv, (char*)recoded);
2763 SvCUR_set(sv, len - 1);
2764 SvLEN_set(sv, len); /* No longer know the real size. */
2768 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2775 =for apidoc sv_utf8_downgrade
2777 Attempts to convert the PV of an SV from characters to bytes.
2778 If the PV contains a character beyond byte, this conversion will fail;
2779 in this case, either returns false or, if C<fail_ok> is not
2782 This is not as a general purpose Unicode to byte encoding interface:
2783 use the Encode extension for that.
2789 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2791 if (SvPOKp(sv) && SvUTF8(sv)) {
2797 sv_force_normal_flags(sv, 0);
2799 s = (U8 *) SvPV(sv, len);
2800 if (!utf8_to_bytes(s, &len)) {
2805 Perl_croak(aTHX_ "Wide character in %s",
2808 Perl_croak(aTHX_ "Wide character");
2819 =for apidoc sv_utf8_encode
2821 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2822 flag off so that it looks like octets again.
2828 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2830 (void) sv_utf8_upgrade(sv);
2832 sv_force_normal_flags(sv, 0);
2834 if (SvREADONLY(sv)) {
2835 Perl_croak(aTHX_ PL_no_modify);
2841 =for apidoc sv_utf8_decode
2843 If the PV of the SV is an octet sequence in UTF-8
2844 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2845 so that it looks like a character. If the PV contains only single-byte
2846 characters, the C<SvUTF8> flag stays being off.
2847 Scans PV for validity and returns false if the PV is invalid UTF-8.
2853 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2859 /* The octets may have got themselves encoded - get them back as
2862 if (!sv_utf8_downgrade(sv, TRUE))
2865 /* it is actually just a matter of turning the utf8 flag on, but
2866 * we want to make sure everything inside is valid utf8 first.
2868 c = (const U8 *) SvPVX_const(sv);
2869 if (!is_utf8_string(c, SvCUR(sv)+1))
2871 e = (const U8 *) SvEND(sv);
2874 if (!UTF8_IS_INVARIANT(ch)) {
2884 =for apidoc sv_setsv
2886 Copies the contents of the source SV C<ssv> into the destination SV
2887 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2888 function if the source SV needs to be reused. Does not handle 'set' magic.
2889 Loosely speaking, it performs a copy-by-value, obliterating any previous
2890 content of the destination.
2892 You probably want to use one of the assortment of wrappers, such as
2893 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2894 C<SvSetMagicSV_nosteal>.
2896 =for apidoc sv_setsv_flags
2898 Copies the contents of the source SV C<ssv> into the destination SV
2899 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2900 function if the source SV needs to be reused. Does not handle 'set' magic.
2901 Loosely speaking, it performs a copy-by-value, obliterating any previous
2902 content of the destination.
2903 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2904 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2905 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2906 and C<sv_setsv_nomg> are implemented in terms of this function.
2908 You probably want to use one of the assortment of wrappers, such as
2909 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2910 C<SvSetMagicSV_nosteal>.
2912 This is the primary function for copying scalars, and most other
2913 copy-ish functions and macros use this underneath.
2919 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2921 register U32 sflags;
2927 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2929 sstr = &PL_sv_undef;
2930 stype = SvTYPE(sstr);
2931 dtype = SvTYPE(dstr);
2936 /* need to nuke the magic */
2938 SvRMAGICAL_off(dstr);
2941 /* There's a lot of redundancy below but we're going for speed here */
2946 if (dtype != SVt_PVGV) {
2947 (void)SvOK_off(dstr);
2955 sv_upgrade(dstr, SVt_IV);
2958 sv_upgrade(dstr, SVt_PVNV);
2962 sv_upgrade(dstr, SVt_PVIV);
2965 (void)SvIOK_only(dstr);
2966 SvIV_set(dstr, SvIVX(sstr));
2969 if (SvTAINTED(sstr))
2980 sv_upgrade(dstr, SVt_NV);
2985 sv_upgrade(dstr, SVt_PVNV);
2988 SvNV_set(dstr, SvNVX(sstr));
2989 (void)SvNOK_only(dstr);
2990 if (SvTAINTED(sstr))
2998 sv_upgrade(dstr, SVt_RV);
2999 else if (dtype == SVt_PVGV &&
3000 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3003 if (GvIMPORTED(dstr) != GVf_IMPORTED
3004 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3006 GvIMPORTED_on(dstr);
3015 #ifdef PERL_OLD_COPY_ON_WRITE
3016 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3017 if (dtype < SVt_PVIV)
3018 sv_upgrade(dstr, SVt_PVIV);
3025 sv_upgrade(dstr, SVt_PV);
3028 if (dtype < SVt_PVIV)
3029 sv_upgrade(dstr, SVt_PVIV);
3032 if (dtype < SVt_PVNV)
3033 sv_upgrade(dstr, SVt_PVNV);
3040 const char * const type = sv_reftype(sstr,0);
3042 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3044 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3049 if (dtype <= SVt_PVGV) {
3051 if (dtype != SVt_PVGV) {
3052 const char * const name = GvNAME(sstr);
3053 const STRLEN len = GvNAMELEN(sstr);
3054 /* don't upgrade SVt_PVLV: it can hold a glob */
3055 if (dtype != SVt_PVLV)
3056 sv_upgrade(dstr, SVt_PVGV);
3057 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3058 GvSTASH(dstr) = GvSTASH(sstr);
3060 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3061 GvNAME(dstr) = savepvn(name, len);
3062 GvNAMELEN(dstr) = len;
3063 SvFAKE_on(dstr); /* can coerce to non-glob */
3066 #ifdef GV_UNIQUE_CHECK
3067 if (GvUNIQUE((GV*)dstr)) {
3068 Perl_croak(aTHX_ PL_no_modify);
3072 (void)SvOK_off(dstr);
3073 GvINTRO_off(dstr); /* one-shot flag */
3075 GvGP(dstr) = gp_ref(GvGP(sstr));
3076 if (SvTAINTED(sstr))
3078 if (GvIMPORTED(dstr) != GVf_IMPORTED
3079 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3081 GvIMPORTED_on(dstr);
3089 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3091 if ((int)SvTYPE(sstr) != stype) {
3092 stype = SvTYPE(sstr);
3093 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3097 if (stype == SVt_PVLV)
3098 SvUPGRADE(dstr, SVt_PVNV);
3100 SvUPGRADE(dstr, (U32)stype);
3103 sflags = SvFLAGS(sstr);
3105 if (sflags & SVf_ROK) {
3106 if (dtype >= SVt_PV) {
3107 if (dtype == SVt_PVGV) {
3108 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3110 const int intro = GvINTRO(dstr);
3112 #ifdef GV_UNIQUE_CHECK
3113 if (GvUNIQUE((GV*)dstr)) {
3114 Perl_croak(aTHX_ PL_no_modify);
3119 GvINTRO_off(dstr); /* one-shot flag */
3120 GvLINE(dstr) = CopLINE(PL_curcop);
3121 GvEGV(dstr) = (GV*)dstr;
3124 switch (SvTYPE(sref)) {
3127 SAVEGENERICSV(GvAV(dstr));
3129 dref = (SV*)GvAV(dstr);
3130 GvAV(dstr) = (AV*)sref;
3131 if (!GvIMPORTED_AV(dstr)
3132 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3134 GvIMPORTED_AV_on(dstr);
3139 SAVEGENERICSV(GvHV(dstr));
3141 dref = (SV*)GvHV(dstr);
3142 GvHV(dstr) = (HV*)sref;
3143 if (!GvIMPORTED_HV(dstr)
3144 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3146 GvIMPORTED_HV_on(dstr);
3151 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3152 SvREFCNT_dec(GvCV(dstr));
3153 GvCV(dstr) = Nullcv;
3154 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3155 PL_sub_generation++;
3157 SAVEGENERICSV(GvCV(dstr));
3160 dref = (SV*)GvCV(dstr);
3161 if (GvCV(dstr) != (CV*)sref) {
3162 CV* const cv = GvCV(dstr);
3164 if (!GvCVGEN((GV*)dstr) &&
3165 (CvROOT(cv) || CvXSUB(cv)))
3167 /* Redefining a sub - warning is mandatory if
3168 it was a const and its value changed. */
3169 if (ckWARN(WARN_REDEFINE)
3171 && (!CvCONST((CV*)sref)
3172 || sv_cmp(cv_const_sv(cv),
3173 cv_const_sv((CV*)sref)))))
3175 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3177 ? "Constant subroutine %s::%s redefined"
3178 : "Subroutine %s::%s redefined",
3179 HvNAME_get(GvSTASH((GV*)dstr)),
3180 GvENAME((GV*)dstr));
3184 cv_ckproto(cv, (GV*)dstr,
3186 ? SvPVX_const(sref) : Nullch);
3188 GvCV(dstr) = (CV*)sref;
3189 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3190 GvASSUMECV_on(dstr);
3191 PL_sub_generation++;
3193 if (!GvIMPORTED_CV(dstr)
3194 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3196 GvIMPORTED_CV_on(dstr);
3201 SAVEGENERICSV(GvIOp(dstr));
3203 dref = (SV*)GvIOp(dstr);
3204 GvIOp(dstr) = (IO*)sref;
3208 SAVEGENERICSV(GvFORM(dstr));
3210 dref = (SV*)GvFORM(dstr);
3211 GvFORM(dstr) = (CV*)sref;
3215 SAVEGENERICSV(GvSV(dstr));
3217 dref = (SV*)GvSV(dstr);
3219 if (!GvIMPORTED_SV(dstr)
3220 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3222 GvIMPORTED_SV_on(dstr);
3228 if (SvTAINTED(sstr))
3232 if (SvPVX_const(dstr)) {
3238 (void)SvOK_off(dstr);
3239 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3241 if (sflags & SVp_NOK) {
3243 /* Only set the public OK flag if the source has public OK. */
3244 if (sflags & SVf_NOK)
3245 SvFLAGS(dstr) |= SVf_NOK;
3246 SvNV_set(dstr, SvNVX(sstr));
3248 if (sflags & SVp_IOK) {
3249 (void)SvIOKp_on(dstr);
3250 if (sflags & SVf_IOK)
3251 SvFLAGS(dstr) |= SVf_IOK;
3252 if (sflags & SVf_IVisUV)
3254 SvIV_set(dstr, SvIVX(sstr));
3256 if (SvAMAGIC(sstr)) {
3260 else if (sflags & SVp_POK) {
3264 * Check to see if we can just swipe the string. If so, it's a
3265 * possible small lose on short strings, but a big win on long ones.
3266 * It might even be a win on short strings if SvPVX_const(dstr)
3267 * has to be allocated and SvPVX_const(sstr) has to be freed.
3270 /* Whichever path we take through the next code, we want this true,
3271 and doing it now facilitates the COW check. */
3272 (void)SvPOK_only(dstr);
3275 /* We're not already COW */
3276 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3277 #ifndef PERL_OLD_COPY_ON_WRITE
3278 /* or we are, but dstr isn't a suitable target. */
3279 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3284 (sflags & SVs_TEMP) && /* slated for free anyway? */
3285 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3286 (!(flags & SV_NOSTEAL)) &&
3287 /* and we're allowed to steal temps */
3288 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3289 SvLEN(sstr) && /* and really is a string */
3290 /* and won't be needed again, potentially */
3291 !(PL_op && PL_op->op_type == OP_AASSIGN))
3292 #ifdef PERL_OLD_COPY_ON_WRITE
3293 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3294 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3295 && SvTYPE(sstr) >= SVt_PVIV)
3298 /* Failed the swipe test, and it's not a shared hash key either.
3299 Have to copy the string. */
3300 STRLEN len = SvCUR(sstr);
3301 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3302 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3303 SvCUR_set(dstr, len);
3304 *SvEND(dstr) = '\0';
3306 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3308 /* Either it's a shared hash key, or it's suitable for
3309 copy-on-write or we can swipe the string. */
3311 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3315 #ifdef PERL_OLD_COPY_ON_WRITE
3317 /* I believe I should acquire a global SV mutex if
3318 it's a COW sv (not a shared hash key) to stop
3319 it going un copy-on-write.
3320 If the source SV has gone un copy on write between up there
3321 and down here, then (assert() that) it is of the correct
3322 form to make it copy on write again */
3323 if ((sflags & (SVf_FAKE | SVf_READONLY))
3324 != (SVf_FAKE | SVf_READONLY)) {
3325 SvREADONLY_on(sstr);
3327 /* Make the source SV into a loop of 1.
3328 (about to become 2) */
3329 SV_COW_NEXT_SV_SET(sstr, sstr);
3333 /* Initial code is common. */
3334 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3339 /* making another shared SV. */
3340 STRLEN cur = SvCUR(sstr);
3341 STRLEN len = SvLEN(sstr);
3342 #ifdef PERL_OLD_COPY_ON_WRITE
3344 assert (SvTYPE(dstr) >= SVt_PVIV);
3345 /* SvIsCOW_normal */
3346 /* splice us in between source and next-after-source. */
3347 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3348 SV_COW_NEXT_SV_SET(sstr, dstr);
3349 SvPV_set(dstr, SvPVX_mutable(sstr));
3353 /* SvIsCOW_shared_hash */
3354 DEBUG_C(PerlIO_printf(Perl_debug_log,
3355 "Copy on write: Sharing hash\n"));
3357 assert (SvTYPE(dstr) >= SVt_PV);
3359 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3361 SvLEN_set(dstr, len);
3362 SvCUR_set(dstr, cur);
3363 SvREADONLY_on(dstr);
3365 /* Relesase a global SV mutex. */
3368 { /* Passes the swipe test. */
3369 SvPV_set(dstr, SvPVX_mutable(sstr));
3370 SvLEN_set(dstr, SvLEN(sstr));
3371 SvCUR_set(dstr, SvCUR(sstr));
3374 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3375 SvPV_set(sstr, Nullch);
3381 if (sflags & SVf_UTF8)
3383 if (sflags & SVp_NOK) {
3385 if (sflags & SVf_NOK)
3386 SvFLAGS(dstr) |= SVf_NOK;
3387 SvNV_set(dstr, SvNVX(sstr));
3389 if (sflags & SVp_IOK) {
3390 (void)SvIOKp_on(dstr);
3391 if (sflags & SVf_IOK)
3392 SvFLAGS(dstr) |= SVf_IOK;
3393 if (sflags & SVf_IVisUV)
3395 SvIV_set(dstr, SvIVX(sstr));
3398 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3399 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3400 smg->mg_ptr, smg->mg_len);
3401 SvRMAGICAL_on(dstr);
3404 else if (sflags & SVp_IOK) {
3405 if (sflags & SVf_IOK)
3406 (void)SvIOK_only(dstr);
3408 (void)SvOK_off(dstr);
3409 (void)SvIOKp_on(dstr);
3411 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3412 if (sflags & SVf_IVisUV)
3414 SvIV_set(dstr, SvIVX(sstr));
3415 if (sflags & SVp_NOK) {
3416 if (sflags & SVf_NOK)
3417 (void)SvNOK_on(dstr);
3419 (void)SvNOKp_on(dstr);
3420 SvNV_set(dstr, SvNVX(sstr));
3423 else if (sflags & SVp_NOK) {
3424 if (sflags & SVf_NOK)
3425 (void)SvNOK_only(dstr);
3427 (void)SvOK_off(dstr);
3430 SvNV_set(dstr, SvNVX(sstr));
3433 if (dtype == SVt_PVGV) {
3434 if (ckWARN(WARN_MISC))
3435 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3438 (void)SvOK_off(dstr);
3440 if (SvTAINTED(sstr))
3445 =for apidoc sv_setsv_mg
3447 Like C<sv_setsv>, but also handles 'set' magic.
3453 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3455 sv_setsv(dstr,sstr);
3459 #ifdef PERL_OLD_COPY_ON_WRITE
3461 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3463 STRLEN cur = SvCUR(sstr);
3464 STRLEN len = SvLEN(sstr);
3465 register char *new_pv;
3468 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3476 if (SvTHINKFIRST(dstr))
3477 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3478 else if (SvPVX_const(dstr))
3479 Safefree(SvPVX_const(dstr));
3483 SvUPGRADE(dstr, SVt_PVIV);
3485 assert (SvPOK(sstr));
3486 assert (SvPOKp(sstr));
3487 assert (!SvIOK(sstr));
3488 assert (!SvIOKp(sstr));
3489 assert (!SvNOK(sstr));
3490 assert (!SvNOKp(sstr));
3492 if (SvIsCOW(sstr)) {
3494 if (SvLEN(sstr) == 0) {
3495 /* source is a COW shared hash key. */
3496 DEBUG_C(PerlIO_printf(Perl_debug_log,
3497 "Fast copy on write: Sharing hash\n"));
3498 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3501 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3503 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3504 SvUPGRADE(sstr, SVt_PVIV);
3505 SvREADONLY_on(sstr);
3507 DEBUG_C(PerlIO_printf(Perl_debug_log,
3508 "Fast copy on write: Converting sstr to COW\n"));
3509 SV_COW_NEXT_SV_SET(dstr, sstr);
3511 SV_COW_NEXT_SV_SET(sstr, dstr);
3512 new_pv = SvPVX_mutable(sstr);
3515 SvPV_set(dstr, new_pv);
3516 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3519 SvLEN_set(dstr, len);
3520 SvCUR_set(dstr, cur);
3529 =for apidoc sv_setpvn
3531 Copies a string into an SV. The C<len> parameter indicates the number of
3532 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3533 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3539 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3541 register char *dptr;
3543 SV_CHECK_THINKFIRST_COW_DROP(sv);
3549 /* len is STRLEN which is unsigned, need to copy to signed */
3552 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3554 SvUPGRADE(sv, SVt_PV);
3556 dptr = SvGROW(sv, len + 1);
3557 Move(ptr,dptr,len,char);
3560 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3565 =for apidoc sv_setpvn_mg
3567 Like C<sv_setpvn>, but also handles 'set' magic.
3573 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3575 sv_setpvn(sv,ptr,len);
3580 =for apidoc sv_setpv
3582 Copies a string into an SV. The string must be null-terminated. Does not
3583 handle 'set' magic. See C<sv_setpv_mg>.
3589 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3591 register STRLEN len;
3593 SV_CHECK_THINKFIRST_COW_DROP(sv);
3599 SvUPGRADE(sv, SVt_PV);
3601 SvGROW(sv, len + 1);
3602 Move(ptr,SvPVX(sv),len+1,char);
3604 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3609 =for apidoc sv_setpv_mg
3611 Like C<sv_setpv>, but also handles 'set' magic.
3617 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3624 =for apidoc sv_usepvn
3626 Tells an SV to use C<ptr> to find its string value. Normally the string is
3627 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3628 The C<ptr> should point to memory that was allocated by C<malloc>. The
3629 string length, C<len>, must be supplied. This function will realloc the
3630 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3631 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3632 See C<sv_usepvn_mg>.
3638 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3641 SV_CHECK_THINKFIRST_COW_DROP(sv);
3642 SvUPGRADE(sv, SVt_PV);
3647 if (SvPVX_const(sv))
3650 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3651 ptr = saferealloc (ptr, allocate);
3654 SvLEN_set(sv, allocate);
3656 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3661 =for apidoc sv_usepvn_mg
3663 Like C<sv_usepvn>, but also handles 'set' magic.
3669 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3671 sv_usepvn(sv,ptr,len);
3675 #ifdef PERL_OLD_COPY_ON_WRITE
3676 /* Need to do this *after* making the SV normal, as we need the buffer
3677 pointer to remain valid until after we've copied it. If we let go too early,
3678 another thread could invalidate it by unsharing last of the same hash key
3679 (which it can do by means other than releasing copy-on-write Svs)
3680 or by changing the other copy-on-write SVs in the loop. */
3682 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3684 if (len) { /* this SV was SvIsCOW_normal(sv) */
3685 /* we need to find the SV pointing to us. */
3686 SV * const current = SV_COW_NEXT_SV(after);
3688 if (current == sv) {
3689 /* The SV we point to points back to us (there were only two of us
3691 Hence other SV is no longer copy on write either. */
3693 SvREADONLY_off(after);
3695 /* We need to follow the pointers around the loop. */
3697 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3700 /* don't loop forever if the structure is bust, and we have
3701 a pointer into a closed loop. */
3702 assert (current != after);
3703 assert (SvPVX_const(current) == pvx);
3705 /* Make the SV before us point to the SV after us. */
3706 SV_COW_NEXT_SV_SET(current, after);
3709 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3714 Perl_sv_release_IVX(pTHX_ register SV *sv)
3717 sv_force_normal_flags(sv, 0);
3723 =for apidoc sv_force_normal_flags
3725 Undo various types of fakery on an SV: if the PV is a shared string, make
3726 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3727 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3728 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3729 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3730 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3731 set to some other value.) In addition, the C<flags> parameter gets passed to
3732 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3733 with flags set to 0.
3739 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3741 #ifdef PERL_OLD_COPY_ON_WRITE
3742 if (SvREADONLY(sv)) {
3743 /* At this point I believe I should acquire a global SV mutex. */
3745 const char * const pvx = SvPVX_const(sv);
3746 const STRLEN len = SvLEN(sv);
3747 const STRLEN cur = SvCUR(sv);
3748 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3750 PerlIO_printf(Perl_debug_log,
3751 "Copy on write: Force normal %ld\n",
3757 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3758 SvPV_set(sv, (char*)0);
3760 if (flags & SV_COW_DROP_PV) {
3761 /* OK, so we don't need to copy our buffer. */
3764 SvGROW(sv, cur + 1);
3765 Move(pvx,SvPVX(sv),cur,char);
3769 sv_release_COW(sv, pvx, len, next);
3774 else if (IN_PERL_RUNTIME)
3775 Perl_croak(aTHX_ PL_no_modify);
3776 /* At this point I believe that I can drop the global SV mutex. */
3779 if (SvREADONLY(sv)) {
3781 const char * const pvx = SvPVX_const(sv);
3782 const STRLEN len = SvCUR(sv);
3785 SvPV_set(sv, Nullch);
3787 SvGROW(sv, len + 1);
3788 Move(pvx,SvPVX(sv),len,char);
3790 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3792 else if (IN_PERL_RUNTIME)
3793 Perl_croak(aTHX_ PL_no_modify);
3797 sv_unref_flags(sv, flags);
3798 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3805 Efficient removal of characters from the beginning of the string buffer.
3806 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3807 the string buffer. The C<ptr> becomes the first character of the adjusted
3808 string. Uses the "OOK hack".
3809 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3810 refer to the same chunk of data.
3816 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3818 register STRLEN delta;
3819 if (!ptr || !SvPOKp(sv))
3821 delta = ptr - SvPVX_const(sv);
3822 SV_CHECK_THINKFIRST(sv);
3823 if (SvTYPE(sv) < SVt_PVIV)
3824 sv_upgrade(sv,SVt_PVIV);
3827 if (!SvLEN(sv)) { /* make copy of shared string */
3828 const char *pvx = SvPVX_const(sv);
3829 const STRLEN len = SvCUR(sv);
3830 SvGROW(sv, len + 1);
3831 Move(pvx,SvPVX(sv),len,char);
3835 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3836 and we do that anyway inside the SvNIOK_off
3838 SvFLAGS(sv) |= SVf_OOK;
3841 SvLEN_set(sv, SvLEN(sv) - delta);
3842 SvCUR_set(sv, SvCUR(sv) - delta);
3843 SvPV_set(sv, SvPVX(sv) + delta);
3844 SvIV_set(sv, SvIVX(sv) + delta);
3848 =for apidoc sv_catpvn
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 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3855 =for apidoc sv_catpvn_flags
3857 Concatenates the string onto the end of the string which is in the SV. The
3858 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3859 status set, then the bytes appended should be valid UTF-8.
3860 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3861 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3862 in terms of this function.
3868 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3871 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3873 SvGROW(dsv, dlen + slen + 1);
3875 sstr = SvPVX_const(dsv);
3876 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3877 SvCUR_set(dsv, SvCUR(dsv) + slen);
3879 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3881 if (flags & SV_SMAGIC)
3886 =for apidoc sv_catsv
3888 Concatenates the string from SV C<ssv> onto the end of the string in
3889 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3890 not 'set' magic. See C<sv_catsv_mg>.
3892 =for apidoc sv_catsv_flags
3894 Concatenates the string from SV C<ssv> onto the end of the string in
3895 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3896 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3897 and C<sv_catsv_nomg> are implemented in terms of this function.
3902 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3906 const char *spv = SvPV_const(ssv, slen);
3908 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3909 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3910 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3911 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3912 dsv->sv_flags doesn't have that bit set.
3913 Andy Dougherty 12 Oct 2001
3915 const I32 sutf8 = DO_UTF8(ssv);
3918 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3920 dutf8 = DO_UTF8(dsv);
3922 if (dutf8 != sutf8) {
3924 /* Not modifying source SV, so taking a temporary copy. */
3925 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3927 sv_utf8_upgrade(csv);
3928 spv = SvPV_const(csv, slen);
3931 sv_utf8_upgrade_nomg(dsv);
3933 sv_catpvn_nomg(dsv, spv, slen);
3936 if (flags & SV_SMAGIC)
3941 =for apidoc sv_catpv
3943 Concatenates the string onto the end of the string which is in the SV.
3944 If the SV has the UTF-8 status set, then the bytes appended should be
3945 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3950 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3952 register STRLEN len;
3958 junk = SvPV_force(sv, tlen);
3960 SvGROW(sv, tlen + len + 1);
3962 ptr = SvPVX_const(sv);
3963 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3964 SvCUR_set(sv, SvCUR(sv) + len);
3965 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3970 =for apidoc sv_catpv_mg
3972 Like C<sv_catpv>, but also handles 'set' magic.
3978 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3987 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3988 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3995 Perl_newSV(pTHX_ STRLEN len)
4001 sv_upgrade(sv, SVt_PV);
4002 SvGROW(sv, len + 1);
4007 =for apidoc sv_magicext
4009 Adds magic to an SV, upgrading it if necessary. Applies the
4010 supplied vtable and returns a pointer to the magic added.
4012 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4013 In particular, you can add magic to SvREADONLY SVs, and add more than
4014 one instance of the same 'how'.
4016 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4017 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4018 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4019 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4021 (This is now used as a subroutine by C<sv_magic>.)
4026 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4027 const char* name, I32 namlen)
4031 if (SvTYPE(sv) < SVt_PVMG) {
4032 SvUPGRADE(sv, SVt_PVMG);
4034 Newxz(mg, 1, MAGIC);
4035 mg->mg_moremagic = SvMAGIC(sv);
4036 SvMAGIC_set(sv, mg);
4038 /* Sometimes a magic contains a reference loop, where the sv and
4039 object refer to each other. To prevent a reference loop that
4040 would prevent such objects being freed, we look for such loops
4041 and if we find one we avoid incrementing the object refcount.
4043 Note we cannot do this to avoid self-tie loops as intervening RV must
4044 have its REFCNT incremented to keep it in existence.
4047 if (!obj || obj == sv ||
4048 how == PERL_MAGIC_arylen ||
4049 how == PERL_MAGIC_qr ||
4050 how == PERL_MAGIC_symtab ||
4051 (SvTYPE(obj) == SVt_PVGV &&
4052 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4053 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4054 GvFORM(obj) == (CV*)sv)))
4059 mg->mg_obj = SvREFCNT_inc(obj);
4060 mg->mg_flags |= MGf_REFCOUNTED;
4063 /* Normal self-ties simply pass a null object, and instead of
4064 using mg_obj directly, use the SvTIED_obj macro to produce a
4065 new RV as needed. For glob "self-ties", we are tieing the PVIO
4066 with an RV obj pointing to the glob containing the PVIO. In
4067 this case, to avoid a reference loop, we need to weaken the
4071 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4072 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4078 mg->mg_len = namlen;
4081 mg->mg_ptr = savepvn(name, namlen);
4082 else if (namlen == HEf_SVKEY)
4083 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4085 mg->mg_ptr = (char *) name;
4087 mg->mg_virtual = vtable;
4091 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4096 =for apidoc sv_magic
4098 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4099 then adds a new magic item of type C<how> to the head of the magic list.
4101 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4102 handling of the C<name> and C<namlen> arguments.
4104 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4105 to add more than one instance of the same 'how'.
4111 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4113 const MGVTBL *vtable;
4116 #ifdef PERL_OLD_COPY_ON_WRITE
4118 sv_force_normal_flags(sv, 0);
4120 if (SvREADONLY(sv)) {
4122 /* its okay to attach magic to shared strings; the subsequent
4123 * upgrade to PVMG will unshare the string */
4124 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4127 && how != PERL_MAGIC_regex_global
4128 && how != PERL_MAGIC_bm
4129 && how != PERL_MAGIC_fm
4130 && how != PERL_MAGIC_sv
4131 && how != PERL_MAGIC_backref
4134 Perl_croak(aTHX_ PL_no_modify);
4137 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4138 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4139 /* sv_magic() refuses to add a magic of the same 'how' as an
4142 if (how == PERL_MAGIC_taint)
4150 vtable = &PL_vtbl_sv;
4152 case PERL_MAGIC_overload:
4153 vtable = &PL_vtbl_amagic;
4155 case PERL_MAGIC_overload_elem:
4156 vtable = &PL_vtbl_amagicelem;
4158 case PERL_MAGIC_overload_table:
4159 vtable = &PL_vtbl_ovrld;
4162 vtable = &PL_vtbl_bm;
4164 case PERL_MAGIC_regdata:
4165 vtable = &PL_vtbl_regdata;
4167 case PERL_MAGIC_regdatum:
4168 vtable = &PL_vtbl_regdatum;
4170 case PERL_MAGIC_env:
4171 vtable = &PL_vtbl_env;
4174 vtable = &PL_vtbl_fm;
4176 case PERL_MAGIC_envelem:
4177 vtable = &PL_vtbl_envelem;
4179 case PERL_MAGIC_regex_global:
4180 vtable = &PL_vtbl_mglob;
4182 case PERL_MAGIC_isa:
4183 vtable = &PL_vtbl_isa;
4185 case PERL_MAGIC_isaelem:
4186 vtable = &PL_vtbl_isaelem;
4188 case PERL_MAGIC_nkeys:
4189 vtable = &PL_vtbl_nkeys;
4191 case PERL_MAGIC_dbfile:
4194 case PERL_MAGIC_dbline:
4195 vtable = &PL_vtbl_dbline;
4197 #ifdef USE_LOCALE_COLLATE
4198 case PERL_MAGIC_collxfrm:
4199 vtable = &PL_vtbl_collxfrm;
4201 #endif /* USE_LOCALE_COLLATE */
4202 case PERL_MAGIC_tied:
4203 vtable = &PL_vtbl_pack;
4205 case PERL_MAGIC_tiedelem:
4206 case PERL_MAGIC_tiedscalar:
4207 vtable = &PL_vtbl_packelem;
4210 vtable = &PL_vtbl_regexp;
4212 case PERL_MAGIC_sig:
4213 vtable = &PL_vtbl_sig;
4215 case PERL_MAGIC_sigelem:
4216 vtable = &PL_vtbl_sigelem;
4218 case PERL_MAGIC_taint:
4219 vtable = &PL_vtbl_taint;
4221 case PERL_MAGIC_uvar:
4222 vtable = &PL_vtbl_uvar;
4224 case PERL_MAGIC_vec:
4225 vtable = &PL_vtbl_vec;
4227 case PERL_MAGIC_arylen_p:
4228 case PERL_MAGIC_rhash:
4229 case PERL_MAGIC_symtab:
4230 case PERL_MAGIC_vstring:
4233 case PERL_MAGIC_utf8:
4234 vtable = &PL_vtbl_utf8;
4236 case PERL_MAGIC_substr:
4237 vtable = &PL_vtbl_substr;
4239 case PERL_MAGIC_defelem:
4240 vtable = &PL_vtbl_defelem;
4242 case PERL_MAGIC_glob:
4243 vtable = &PL_vtbl_glob;
4245 case PERL_MAGIC_arylen:
4246 vtable = &PL_vtbl_arylen;
4248 case PERL_MAGIC_pos:
4249 vtable = &PL_vtbl_pos;
4251 case PERL_MAGIC_backref:
4252 vtable = &PL_vtbl_backref;
4254 case PERL_MAGIC_ext:
4255 /* Reserved for use by extensions not perl internals. */
4256 /* Useful for attaching extension internal data to perl vars. */
4257 /* Note that multiple extensions may clash if magical scalars */
4258 /* etc holding private data from one are passed to another. */
4262 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4265 /* Rest of work is done else where */
4266 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4269 case PERL_MAGIC_taint:
4272 case PERL_MAGIC_ext:
4273 case PERL_MAGIC_dbfile:
4280 =for apidoc sv_unmagic
4282 Removes all magic of type C<type> from an SV.
4288 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4292 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4295 for (mg = *mgp; mg; mg = *mgp) {
4296 if (mg->mg_type == type) {
4297 const MGVTBL* const vtbl = mg->mg_virtual;
4298 *mgp = mg->mg_moremagic;
4299 if (vtbl && vtbl->svt_free)
4300 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4301 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4303 Safefree(mg->mg_ptr);
4304 else if (mg->mg_len == HEf_SVKEY)
4305 SvREFCNT_dec((SV*)mg->mg_ptr);
4306 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4307 Safefree(mg->mg_ptr);
4309 if (mg->mg_flags & MGf_REFCOUNTED)
4310 SvREFCNT_dec(mg->mg_obj);
4314 mgp = &mg->mg_moremagic;
4318 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4325 =for apidoc sv_rvweaken
4327 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4328 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4329 push a back-reference to this RV onto the array of backreferences
4330 associated with that magic.
4336 Perl_sv_rvweaken(pTHX_ SV *sv)
4339 if (!SvOK(sv)) /* let undefs pass */
4342 Perl_croak(aTHX_ "Can't weaken a nonreference");
4343 else if (SvWEAKREF(sv)) {
4344 if (ckWARN(WARN_MISC))
4345 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4349 Perl_sv_add_backref(aTHX_ tsv, sv);
4355 /* Give tsv backref magic if it hasn't already got it, then push a
4356 * back-reference to sv onto the array associated with the backref magic.
4360 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4364 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4365 av = (AV*)mg->mg_obj;
4368 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4369 /* av now has a refcnt of 2, which avoids it getting freed
4370 * before us during global cleanup. The extra ref is removed
4371 * by magic_killbackrefs() when tsv is being freed */
4373 if (AvFILLp(av) >= AvMAX(av)) {
4374 av_extend(av, AvFILLp(av)+1);
4376 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4379 /* delete a back-reference to ourselves from the backref magic associated
4380 * with the SV we point to.
4384 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4390 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4391 if (PL_in_clean_all)
4394 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4395 Perl_croak(aTHX_ "panic: del_backref");
4396 av = (AV *)mg->mg_obj;
4398 /* We shouldn't be in here more than once, but for paranoia reasons lets
4400 for (i = AvFILLp(av); i >= 0; i--) {
4402 const SSize_t fill = AvFILLp(av);
4404 /* We weren't the last entry.
4405 An unordered list has this property that you can take the
4406 last element off the end to fill the hole, and it's still
4407 an unordered list :-)
4412 AvFILLp(av) = fill - 1;
4418 =for apidoc sv_insert
4420 Inserts a string at the specified offset/length within the SV. Similar to
4421 the Perl substr() function.
4427 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4431 register char *midend;
4432 register char *bigend;
4438 Perl_croak(aTHX_ "Can't modify non-existent substring");
4439 SvPV_force(bigstr, curlen);
4440 (void)SvPOK_only_UTF8(bigstr);
4441 if (offset + len > curlen) {
4442 SvGROW(bigstr, offset+len+1);
4443 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4444 SvCUR_set(bigstr, offset+len);
4448 i = littlelen - len;
4449 if (i > 0) { /* string might grow */
4450 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4451 mid = big + offset + len;
4452 midend = bigend = big + SvCUR(bigstr);
4455 while (midend > mid) /* shove everything down */
4456 *--bigend = *--midend;
4457 Move(little,big+offset,littlelen,char);
4458 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4463 Move(little,SvPVX(bigstr)+offset,len,char);
4468 big = SvPVX(bigstr);
4471 bigend = big + SvCUR(bigstr);
4473 if (midend > bigend)
4474 Perl_croak(aTHX_ "panic: sv_insert");
4476 if (mid - big > bigend - midend) { /* faster to shorten from end */
4478 Move(little, mid, littlelen,char);
4481 i = bigend - midend;
4483 Move(midend, mid, i,char);
4487 SvCUR_set(bigstr, mid - big);
4489 else if ((i = mid - big)) { /* faster from front */
4490 midend -= littlelen;
4492 sv_chop(bigstr,midend-i);
4497 Move(little, mid, littlelen,char);
4499 else if (littlelen) {
4500 midend -= littlelen;
4501 sv_chop(bigstr,midend);
4502 Move(little,midend,littlelen,char);
4505 sv_chop(bigstr,midend);
4511 =for apidoc sv_replace
4513 Make the first argument a copy of the second, then delete the original.
4514 The target SV physically takes over ownership of the body of the source SV
4515 and inherits its flags; however, the target keeps any magic it owns,
4516 and any magic in the source is discarded.
4517 Note that this is a rather specialist SV copying operation; most of the
4518 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4524 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4526 const U32 refcnt = SvREFCNT(sv);
4527 SV_CHECK_THINKFIRST_COW_DROP(sv);
4528 if (SvREFCNT(nsv) != 1) {
4529 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4530 UVuf " != 1)", (UV) SvREFCNT(nsv));
4532 if (SvMAGICAL(sv)) {
4536 sv_upgrade(nsv, SVt_PVMG);
4537 SvMAGIC_set(nsv, SvMAGIC(sv));
4538 SvFLAGS(nsv) |= SvMAGICAL(sv);
4540 SvMAGIC_set(sv, NULL);
4544 assert(!SvREFCNT(sv));
4545 #ifdef DEBUG_LEAKING_SCALARS
4546 sv->sv_flags = nsv->sv_flags;
4547 sv->sv_any = nsv->sv_any;
4548 sv->sv_refcnt = nsv->sv_refcnt;
4549 sv->sv_u = nsv->sv_u;
4551 StructCopy(nsv,sv,SV);
4553 /* Currently could join these into one piece of pointer arithmetic, but
4554 it would be unclear. */
4555 if(SvTYPE(sv) == SVt_IV)
4557 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4558 else if (SvTYPE(sv) == SVt_RV) {
4559 SvANY(sv) = &sv->sv_u.svu_rv;
4563 #ifdef PERL_OLD_COPY_ON_WRITE
4564 if (SvIsCOW_normal(nsv)) {
4565 /* We need to follow the pointers around the loop to make the
4566 previous SV point to sv, rather than nsv. */
4569 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4572 assert(SvPVX_const(current) == SvPVX_const(nsv));
4574 /* Make the SV before us point to the SV after us. */
4576 PerlIO_printf(Perl_debug_log, "previous is\n");
4578 PerlIO_printf(Perl_debug_log,
4579 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4580 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4582 SV_COW_NEXT_SV_SET(current, sv);
4585 SvREFCNT(sv) = refcnt;
4586 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4592 =for apidoc sv_clear
4594 Clear an SV: call any destructors, free up any memory used by the body,
4595 and free the body itself. The SV's head is I<not> freed, although
4596 its type is set to all 1's so that it won't inadvertently be assumed
4597 to be live during global destruction etc.
4598 This function should only be called when REFCNT is zero. Most of the time
4599 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4606 Perl_sv_clear(pTHX_ register SV *sv)
4609 const U32 type = SvTYPE(sv);
4610 const struct body_details *const sv_type_details
4611 = bodies_by_type + type;
4614 assert(SvREFCNT(sv) == 0);
4620 if (PL_defstash) { /* Still have a symbol table? */
4625 stash = SvSTASH(sv);
4626 destructor = StashHANDLER(stash,DESTROY);
4628 SV* const tmpref = newRV(sv);
4629 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4631 PUSHSTACKi(PERLSI_DESTROY);
4636 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4642 if(SvREFCNT(tmpref) < 2) {
4643 /* tmpref is not kept alive! */
4645 SvRV_set(tmpref, NULL);
4648 SvREFCNT_dec(tmpref);
4650 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4654 if (PL_in_clean_objs)
4655 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4657 /* DESTROY gave object new lease on life */
4663 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4664 SvOBJECT_off(sv); /* Curse the object. */
4665 if (type != SVt_PVIO)
4666 --PL_sv_objcount; /* XXX Might want something more general */
4669 if (type >= SVt_PVMG) {
4672 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4673 SvREFCNT_dec(SvSTASH(sv));
4678 IoIFP(sv) != PerlIO_stdin() &&
4679 IoIFP(sv) != PerlIO_stdout() &&
4680 IoIFP(sv) != PerlIO_stderr())
4682 io_close((IO*)sv, FALSE);
4684 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4685 PerlDir_close(IoDIRP(sv));
4686 IoDIRP(sv) = (DIR*)NULL;
4687 Safefree(IoTOP_NAME(sv));
4688 Safefree(IoFMT_NAME(sv));
4689 Safefree(IoBOTTOM_NAME(sv));
4704 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4705 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4706 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4707 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4709 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4710 SvREFCNT_dec(LvTARG(sv));
4714 Safefree(GvNAME(sv));
4715 /* If we're in a stash, we don't own a reference to it. However it does
4716 have a back reference to us, which needs to be cleared. */
4718 sv_del_backref((SV*)GvSTASH(sv), sv);
4723 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4725 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4726 /* Don't even bother with turning off the OOK flag. */
4731 SV *target = SvRV(sv);
4733 sv_del_backref(target, sv);
4735 SvREFCNT_dec(target);
4737 #ifdef PERL_OLD_COPY_ON_WRITE
4738 else if (SvPVX_const(sv)) {
4740 /* I believe I need to grab the global SV mutex here and
4741 then recheck the COW status. */
4743 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4746 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4747 SV_COW_NEXT_SV(sv));
4748 /* And drop it here. */
4750 } else if (SvLEN(sv)) {
4751 Safefree(SvPVX_const(sv));
4755 else if (SvPVX_const(sv) && SvLEN(sv))
4756 Safefree(SvPVX_mutable(sv));
4757 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4758 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4767 SvFLAGS(sv) &= SVf_BREAK;
4768 SvFLAGS(sv) |= SVTYPEMASK;
4770 if (sv_type_details->arena) {
4771 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4772 &PL_body_roots[type]);
4774 else if (sv_type_details->size) {
4775 my_safefree(SvANY(sv));
4780 =for apidoc sv_newref
4782 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4789 Perl_sv_newref(pTHX_ SV *sv)
4799 Decrement an SV's reference count, and if it drops to zero, call
4800 C<sv_clear> to invoke destructors and free up any memory used by
4801 the body; finally, deallocate the SV's head itself.
4802 Normally called via a wrapper macro C<SvREFCNT_dec>.
4808 Perl_sv_free(pTHX_ SV *sv)
4813 if (SvREFCNT(sv) == 0) {
4814 if (SvFLAGS(sv) & SVf_BREAK)
4815 /* this SV's refcnt has been artificially decremented to
4816 * trigger cleanup */
4818 if (PL_in_clean_all) /* All is fair */
4820 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4821 /* make sure SvREFCNT(sv)==0 happens very seldom */
4822 SvREFCNT(sv) = (~(U32)0)/2;
4825 if (ckWARN_d(WARN_INTERNAL)) {
4826 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4827 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4828 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4829 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4830 Perl_dump_sv_child(aTHX_ sv);
4835 if (--(SvREFCNT(sv)) > 0)
4837 Perl_sv_free2(aTHX_ sv);
4841 Perl_sv_free2(pTHX_ SV *sv)
4846 if (ckWARN_d(WARN_DEBUGGING))
4847 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4848 "Attempt to free temp prematurely: SV 0x%"UVxf
4849 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4853 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4854 /* make sure SvREFCNT(sv)==0 happens very seldom */
4855 SvREFCNT(sv) = (~(U32)0)/2;
4866 Returns the length of the string in the SV. Handles magic and type
4867 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4873 Perl_sv_len(pTHX_ register SV *sv)
4881 len = mg_length(sv);
4883 (void)SvPV_const(sv, len);
4888 =for apidoc sv_len_utf8
4890 Returns the number of characters in the string in an SV, counting wide
4891 UTF-8 bytes as a single character. Handles magic and type coercion.
4897 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4898 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4899 * (Note that the mg_len is not the length of the mg_ptr field.)
4904 Perl_sv_len_utf8(pTHX_ register SV *sv)
4910 return mg_length(sv);
4914 const U8 *s = (U8*)SvPV_const(sv, len);
4915 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4917 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4919 #ifdef PERL_UTF8_CACHE_ASSERT
4920 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4924 ulen = Perl_utf8_length(aTHX_ s, s + len);
4925 if (!mg && !SvREADONLY(sv)) {
4926 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4927 mg = mg_find(sv, PERL_MAGIC_utf8);
4937 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4938 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4939 * between UTF-8 and byte offsets. There are two (substr offset and substr
4940 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4941 * and byte offset) cache positions.
4943 * The mg_len field is used by sv_len_utf8(), see its comments.
4944 * Note that the mg_len is not the length of the mg_ptr field.
4948 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4949 I32 offsetp, const U8 *s, const U8 *start)
4953 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4955 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4959 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4961 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4962 (*mgp)->mg_ptr = (char *) *cachep;
4966 (*cachep)[i] = offsetp;
4967 (*cachep)[i+1] = s - start;
4975 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4976 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4977 * between UTF-8 and byte offsets. See also the comments of
4978 * S_utf8_mg_pos_init().
4982 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)
4986 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4988 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4989 if (*mgp && (*mgp)->mg_ptr) {
4990 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4991 ASSERT_UTF8_CACHE(*cachep);
4992 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4994 else { /* We will skip to the right spot. */
4999 /* The assumption is that going backward is half
5000 * the speed of going forward (that's where the
5001 * 2 * backw in the below comes from). (The real
5002 * figure of course depends on the UTF-8 data.) */
5004 if ((*cachep)[i] > (STRLEN)uoff) {
5006 backw = (*cachep)[i] - (STRLEN)uoff;
5008 if (forw < 2 * backw)
5011 p = start + (*cachep)[i+1];
5013 /* Try this only for the substr offset (i == 0),
5014 * not for the substr length (i == 2). */
5015 else if (i == 0) { /* (*cachep)[i] < uoff */
5016 const STRLEN ulen = sv_len_utf8(sv);
5018 if ((STRLEN)uoff < ulen) {
5019 forw = (STRLEN)uoff - (*cachep)[i];
5020 backw = ulen - (STRLEN)uoff;
5022 if (forw < 2 * backw)
5023 p = start + (*cachep)[i+1];
5028 /* If the string is not long enough for uoff,
5029 * we could extend it, but not at this low a level. */
5033 if (forw < 2 * backw) {
5040 while (UTF8_IS_CONTINUATION(*p))
5045 /* Update the cache. */
5046 (*cachep)[i] = (STRLEN)uoff;
5047 (*cachep)[i+1] = p - start;
5049 /* Drop the stale "length" cache */
5058 if (found) { /* Setup the return values. */
5059 *offsetp = (*cachep)[i+1];
5060 *sp = start + *offsetp;
5063 *offsetp = send - start;
5065 else if (*sp < start) {
5071 #ifdef PERL_UTF8_CACHE_ASSERT
5076 while (n-- && s < send)
5080 assert(*offsetp == s - start);
5081 assert((*cachep)[0] == (STRLEN)uoff);
5082 assert((*cachep)[1] == *offsetp);
5084 ASSERT_UTF8_CACHE(*cachep);
5093 =for apidoc sv_pos_u2b
5095 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5096 the start of the string, to a count of the equivalent number of bytes; if
5097 lenp is non-zero, it does the same to lenp, but this time starting from
5098 the offset, rather than from the start of the string. Handles magic and
5105 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5106 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5107 * byte offsets. See also the comments of S_utf8_mg_pos().
5112 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5120 start = (U8*)SvPV_const(sv, len);
5124 const U8 *s = start;
5125 I32 uoffset = *offsetp;
5126 const U8 * const send = s + len;
5130 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5132 if (!found && uoffset > 0) {
5133 while (s < send && uoffset--)
5137 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5139 *offsetp = s - start;
5144 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5148 if (!found && *lenp > 0) {
5151 while (s < send && ulen--)
5155 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5159 ASSERT_UTF8_CACHE(cache);
5171 =for apidoc sv_pos_b2u
5173 Converts the value pointed to by offsetp from a count of bytes from the
5174 start of the string, to a count of the equivalent number of UTF-8 chars.
5175 Handles magic and type coercion.
5181 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5182 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5183 * byte offsets. See also the comments of S_utf8_mg_pos().
5188 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5196 s = (const U8*)SvPV_const(sv, len);
5197 if ((I32)len < *offsetp)
5198 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5200 const U8* send = s + *offsetp;
5202 STRLEN *cache = NULL;
5206 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5207 mg = mg_find(sv, PERL_MAGIC_utf8);
5208 if (mg && mg->mg_ptr) {
5209 cache = (STRLEN *) mg->mg_ptr;
5210 if (cache[1] == (STRLEN)*offsetp) {
5211 /* An exact match. */
5212 *offsetp = cache[0];
5216 else if (cache[1] < (STRLEN)*offsetp) {
5217 /* We already know part of the way. */
5220 /* Let the below loop do the rest. */
5222 else { /* cache[1] > *offsetp */
5223 /* We already know all of the way, now we may
5224 * be able to walk back. The same assumption
5225 * is made as in S_utf8_mg_pos(), namely that
5226 * walking backward is twice slower than
5227 * walking forward. */
5228 const STRLEN forw = *offsetp;
5229 STRLEN backw = cache[1] - *offsetp;
5231 if (!(forw < 2 * backw)) {
5232 const U8 *p = s + cache[1];
5239 while (UTF8_IS_CONTINUATION(*p)) {
5247 *offsetp = cache[0];
5249 /* Drop the stale "length" cache */
5257 ASSERT_UTF8_CACHE(cache);
5263 /* Call utf8n_to_uvchr() to validate the sequence
5264 * (unless a simple non-UTF character) */
5265 if (!UTF8_IS_INVARIANT(*s))
5266 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5275 if (!SvREADONLY(sv)) {
5277 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5278 mg = mg_find(sv, PERL_MAGIC_utf8);
5283 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5284 mg->mg_ptr = (char *) cache;
5289 cache[1] = *offsetp;
5290 /* Drop the stale "length" cache */
5303 Returns a boolean indicating whether the strings in the two SVs are
5304 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5305 coerce its args to strings if necessary.
5311 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5319 SV* svrecode = Nullsv;
5326 pv1 = SvPV_const(sv1, cur1);
5333 pv2 = SvPV_const(sv2, cur2);
5335 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5336 /* Differing utf8ness.
5337 * Do not UTF8size the comparands as a side-effect. */
5340 svrecode = newSVpvn(pv2, cur2);
5341 sv_recode_to_utf8(svrecode, PL_encoding);
5342 pv2 = SvPV_const(svrecode, cur2);
5345 svrecode = newSVpvn(pv1, cur1);
5346 sv_recode_to_utf8(svrecode, PL_encoding);
5347 pv1 = SvPV_const(svrecode, cur1);
5349 /* Now both are in UTF-8. */
5351 SvREFCNT_dec(svrecode);
5356 bool is_utf8 = TRUE;
5359 /* sv1 is the UTF-8 one,
5360 * if is equal it must be downgrade-able */
5361 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5367 /* sv2 is the UTF-8 one,
5368 * if is equal it must be downgrade-able */
5369 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5375 /* Downgrade not possible - cannot be eq */
5383 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5386 SvREFCNT_dec(svrecode);
5397 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5398 string in C<sv1> is less than, equal to, or greater than the string in
5399 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5400 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5406 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5409 const char *pv1, *pv2;
5412 SV *svrecode = Nullsv;
5419 pv1 = SvPV_const(sv1, cur1);
5426 pv2 = SvPV_const(sv2, cur2);
5428 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5429 /* Differing utf8ness.
5430 * Do not UTF8size the comparands as a side-effect. */
5433 svrecode = newSVpvn(pv2, cur2);
5434 sv_recode_to_utf8(svrecode, PL_encoding);
5435 pv2 = SvPV_const(svrecode, cur2);
5438 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5443 svrecode = newSVpvn(pv1, cur1);
5444 sv_recode_to_utf8(svrecode, PL_encoding);
5445 pv1 = SvPV_const(svrecode, cur1);
5448 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5454 cmp = cur2 ? -1 : 0;
5458 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5461 cmp = retval < 0 ? -1 : 1;
5462 } else if (cur1 == cur2) {
5465 cmp = cur1 < cur2 ? -1 : 1;
5470 SvREFCNT_dec(svrecode);
5479 =for apidoc sv_cmp_locale
5481 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5482 'use bytes' aware, handles get magic, and will coerce its args to strings
5483 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5489 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5491 #ifdef USE_LOCALE_COLLATE
5497 if (PL_collation_standard)
5501 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5503 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5505 if (!pv1 || !len1) {
5516 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5519 return retval < 0 ? -1 : 1;
5522 * When the result of collation is equality, that doesn't mean
5523 * that there are no differences -- some locales exclude some
5524 * characters from consideration. So to avoid false equalities,
5525 * we use the raw string as a tiebreaker.
5531 #endif /* USE_LOCALE_COLLATE */
5533 return sv_cmp(sv1, sv2);
5537 #ifdef USE_LOCALE_COLLATE
5540 =for apidoc sv_collxfrm
5542 Add Collate Transform magic to an SV if it doesn't already have it.
5544 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5545 scalar data of the variable, but transformed to such a format that a normal
5546 memory comparison can be used to compare the data according to the locale
5553 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5557 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5558 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5564 Safefree(mg->mg_ptr);
5565 s = SvPV_const(sv, len);
5566 if ((xf = mem_collxfrm(s, len, &xlen))) {
5567 if (SvREADONLY(sv)) {
5570 return xf + sizeof(PL_collation_ix);
5573 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5574 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5587 if (mg && mg->mg_ptr) {
5589 return mg->mg_ptr + sizeof(PL_collation_ix);
5597 #endif /* USE_LOCALE_COLLATE */
5602 Get a line from the filehandle and store it into the SV, optionally
5603 appending to the currently-stored string.
5609 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5613 register STDCHAR rslast;
5614 register STDCHAR *bp;
5620 if (SvTHINKFIRST(sv))
5621 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5622 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5624 However, perlbench says it's slower, because the existing swipe code
5625 is faster than copy on write.
5626 Swings and roundabouts. */
5627 SvUPGRADE(sv, SVt_PV);
5632 if (PerlIO_isutf8(fp)) {
5634 sv_utf8_upgrade_nomg(sv);
5635 sv_pos_u2b(sv,&append,0);
5637 } else if (SvUTF8(sv)) {
5638 SV * const tsv = NEWSV(0,0);
5639 sv_gets(tsv, fp, 0);
5640 sv_utf8_upgrade_nomg(tsv);
5641 SvCUR_set(sv,append);
5644 goto return_string_or_null;
5649 if (PerlIO_isutf8(fp))
5652 if (IN_PERL_COMPILETIME) {
5653 /* we always read code in line mode */
5657 else if (RsSNARF(PL_rs)) {
5658 /* If it is a regular disk file use size from stat() as estimate
5659 of amount we are going to read - may result in malloc-ing
5660 more memory than we realy need if layers bellow reduce
5661 size we read (e.g. CRLF or a gzip layer)
5664 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5665 const Off_t offset = PerlIO_tell(fp);
5666 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5667 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5673 else if (RsRECORD(PL_rs)) {
5677 /* Grab the size of the record we're getting */
5678 recsize = SvIV(SvRV(PL_rs));
5679 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5682 /* VMS wants read instead of fread, because fread doesn't respect */
5683 /* RMS record boundaries. This is not necessarily a good thing to be */
5684 /* doing, but we've got no other real choice - except avoid stdio
5685 as implementation - perhaps write a :vms layer ?
5687 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5689 bytesread = PerlIO_read(fp, buffer, recsize);
5693 SvCUR_set(sv, bytesread += append);
5694 buffer[bytesread] = '\0';
5695 goto return_string_or_null;
5697 else if (RsPARA(PL_rs)) {
5703 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5704 if (PerlIO_isutf8(fp)) {
5705 rsptr = SvPVutf8(PL_rs, rslen);
5708 if (SvUTF8(PL_rs)) {
5709 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5710 Perl_croak(aTHX_ "Wide character in $/");
5713 rsptr = SvPV_const(PL_rs, rslen);
5717 rslast = rslen ? rsptr[rslen - 1] : '\0';
5719 if (rspara) { /* have to do this both before and after */
5720 do { /* to make sure file boundaries work right */
5723 i = PerlIO_getc(fp);
5727 PerlIO_ungetc(fp,i);
5733 /* See if we know enough about I/O mechanism to cheat it ! */
5735 /* This used to be #ifdef test - it is made run-time test for ease
5736 of abstracting out stdio interface. One call should be cheap
5737 enough here - and may even be a macro allowing compile
5741 if (PerlIO_fast_gets(fp)) {
5744 * We're going to steal some values from the stdio struct
5745 * and put EVERYTHING in the innermost loop into registers.
5747 register STDCHAR *ptr;
5751 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5752 /* An ungetc()d char is handled separately from the regular
5753 * buffer, so we getc() it back out and stuff it in the buffer.
5755 i = PerlIO_getc(fp);
5756 if (i == EOF) return 0;
5757 *(--((*fp)->_ptr)) = (unsigned char) i;
5761 /* Here is some breathtakingly efficient cheating */
5763 cnt = PerlIO_get_cnt(fp); /* get count into register */
5764 /* make sure we have the room */
5765 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5766 /* Not room for all of it
5767 if we are looking for a separator and room for some
5769 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5770 /* just process what we have room for */
5771 shortbuffered = cnt - SvLEN(sv) + append + 1;
5772 cnt -= shortbuffered;
5776 /* remember that cnt can be negative */
5777 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5782 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5783 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5784 DEBUG_P(PerlIO_printf(Perl_debug_log,
5785 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5786 DEBUG_P(PerlIO_printf(Perl_debug_log,
5787 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5788 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5789 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5794 while (cnt > 0) { /* this | eat */
5796 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5797 goto thats_all_folks; /* screams | sed :-) */
5801 Copy(ptr, bp, cnt, char); /* this | eat */
5802 bp += cnt; /* screams | dust */
5803 ptr += cnt; /* louder | sed :-) */
5808 if (shortbuffered) { /* oh well, must extend */
5809 cnt = shortbuffered;
5811 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5813 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5814 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5818 DEBUG_P(PerlIO_printf(Perl_debug_log,
5819 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5820 PTR2UV(ptr),(long)cnt));
5821 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5823 DEBUG_P(PerlIO_printf(Perl_debug_log,
5824 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5825 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5826 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5828 /* This used to call 'filbuf' in stdio form, but as that behaves like
5829 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5830 another abstraction. */
5831 i = PerlIO_getc(fp); /* get more characters */
5833 DEBUG_P(PerlIO_printf(Perl_debug_log,
5834 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5835 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5836 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5838 cnt = PerlIO_get_cnt(fp);
5839 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5840 DEBUG_P(PerlIO_printf(Perl_debug_log,
5841 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5843 if (i == EOF) /* all done for ever? */
5844 goto thats_really_all_folks;
5846 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5848 SvGROW(sv, bpx + cnt + 2);
5849 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5851 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5853 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5854 goto thats_all_folks;
5858 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5859 memNE((char*)bp - rslen, rsptr, rslen))
5860 goto screamer; /* go back to the fray */
5861 thats_really_all_folks:
5863 cnt += shortbuffered;
5864 DEBUG_P(PerlIO_printf(Perl_debug_log,
5865 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5866 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5867 DEBUG_P(PerlIO_printf(Perl_debug_log,
5868 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5869 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5870 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5872 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5873 DEBUG_P(PerlIO_printf(Perl_debug_log,
5874 "Screamer: done, len=%ld, string=|%.*s|\n",
5875 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5879 /*The big, slow, and stupid way. */
5880 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5882 Newx(buf, 8192, STDCHAR);
5890 register const STDCHAR * const bpe = buf + sizeof(buf);
5892 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5893 ; /* keep reading */
5897 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5898 /* Accomodate broken VAXC compiler, which applies U8 cast to
5899 * both args of ?: operator, causing EOF to change into 255
5902 i = (U8)buf[cnt - 1];
5908 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5910 sv_catpvn(sv, (char *) buf, cnt);
5912 sv_setpvn(sv, (char *) buf, cnt);
5914 if (i != EOF && /* joy */
5916 SvCUR(sv) < rslen ||
5917 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5921 * If we're reading from a TTY and we get a short read,
5922 * indicating that the user hit his EOF character, we need
5923 * to notice it now, because if we try to read from the TTY
5924 * again, the EOF condition will disappear.
5926 * The comparison of cnt to sizeof(buf) is an optimization
5927 * that prevents unnecessary calls to feof().
5931 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5935 #ifdef USE_HEAP_INSTEAD_OF_STACK
5940 if (rspara) { /* have to do this both before and after */
5941 while (i != EOF) { /* to make sure file boundaries work right */
5942 i = PerlIO_getc(fp);
5944 PerlIO_ungetc(fp,i);
5950 return_string_or_null:
5951 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5957 Auto-increment of the value in the SV, doing string to numeric conversion
5958 if necessary. Handles 'get' magic.
5964 Perl_sv_inc(pTHX_ register SV *sv)
5972 if (SvTHINKFIRST(sv)) {
5974 sv_force_normal_flags(sv, 0);
5975 if (SvREADONLY(sv)) {
5976 if (IN_PERL_RUNTIME)
5977 Perl_croak(aTHX_ PL_no_modify);
5981 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5983 i = PTR2IV(SvRV(sv));
5988 flags = SvFLAGS(sv);
5989 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5990 /* It's (privately or publicly) a float, but not tested as an
5991 integer, so test it to see. */
5993 flags = SvFLAGS(sv);
5995 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5996 /* It's publicly an integer, or privately an integer-not-float */
5997 #ifdef PERL_PRESERVE_IVUV
6001 if (SvUVX(sv) == UV_MAX)
6002 sv_setnv(sv, UV_MAX_P1);
6004 (void)SvIOK_only_UV(sv);
6005 SvUV_set(sv, SvUVX(sv) + 1);
6007 if (SvIVX(sv) == IV_MAX)
6008 sv_setuv(sv, (UV)IV_MAX + 1);
6010 (void)SvIOK_only(sv);
6011 SvIV_set(sv, SvIVX(sv) + 1);
6016 if (flags & SVp_NOK) {
6017 (void)SvNOK_only(sv);
6018 SvNV_set(sv, SvNVX(sv) + 1.0);
6022 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6023 if ((flags & SVTYPEMASK) < SVt_PVIV)
6024 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6025 (void)SvIOK_only(sv);
6030 while (isALPHA(*d)) d++;
6031 while (isDIGIT(*d)) d++;
6033 #ifdef PERL_PRESERVE_IVUV
6034 /* Got to punt this as an integer if needs be, but we don't issue
6035 warnings. Probably ought to make the sv_iv_please() that does
6036 the conversion if possible, and silently. */
6037 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6038 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6039 /* Need to try really hard to see if it's an integer.
6040 9.22337203685478e+18 is an integer.
6041 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6042 so $a="9.22337203685478e+18"; $a+0; $a++
6043 needs to be the same as $a="9.22337203685478e+18"; $a++
6050 /* sv_2iv *should* have made this an NV */
6051 if (flags & SVp_NOK) {
6052 (void)SvNOK_only(sv);
6053 SvNV_set(sv, SvNVX(sv) + 1.0);
6056 /* I don't think we can get here. Maybe I should assert this
6057 And if we do get here I suspect that sv_setnv will croak. NWC
6059 #if defined(USE_LONG_DOUBLE)
6060 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",
6061 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6063 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6064 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6067 #endif /* PERL_PRESERVE_IVUV */
6068 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6072 while (d >= SvPVX_const(sv)) {
6080 /* MKS: The original code here died if letters weren't consecutive.
6081 * at least it didn't have to worry about non-C locales. The
6082 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6083 * arranged in order (although not consecutively) and that only
6084 * [A-Za-z] are accepted by isALPHA in the C locale.
6086 if (*d != 'z' && *d != 'Z') {
6087 do { ++*d; } while (!isALPHA(*d));
6090 *(d--) -= 'z' - 'a';
6095 *(d--) -= 'z' - 'a' + 1;
6099 /* oh,oh, the number grew */
6100 SvGROW(sv, SvCUR(sv) + 2);
6101 SvCUR_set(sv, SvCUR(sv) + 1);
6102 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6113 Auto-decrement of the value in the SV, doing string to numeric conversion
6114 if necessary. Handles 'get' magic.
6120 Perl_sv_dec(pTHX_ register SV *sv)
6127 if (SvTHINKFIRST(sv)) {
6129 sv_force_normal_flags(sv, 0);
6130 if (SvREADONLY(sv)) {
6131 if (IN_PERL_RUNTIME)
6132 Perl_croak(aTHX_ PL_no_modify);
6136 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6138 i = PTR2IV(SvRV(sv));
6143 /* Unlike sv_inc we don't have to worry about string-never-numbers
6144 and keeping them magic. But we mustn't warn on punting */
6145 flags = SvFLAGS(sv);
6146 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6147 /* It's publicly an integer, or privately an integer-not-float */
6148 #ifdef PERL_PRESERVE_IVUV
6152 if (SvUVX(sv) == 0) {
6153 (void)SvIOK_only(sv);
6157 (void)SvIOK_only_UV(sv);
6158 SvUV_set(sv, SvUVX(sv) - 1);
6161 if (SvIVX(sv) == IV_MIN)
6162 sv_setnv(sv, (NV)IV_MIN - 1.0);
6164 (void)SvIOK_only(sv);
6165 SvIV_set(sv, SvIVX(sv) - 1);
6170 if (flags & SVp_NOK) {
6171 SvNV_set(sv, SvNVX(sv) - 1.0);
6172 (void)SvNOK_only(sv);
6175 if (!(flags & SVp_POK)) {
6176 if ((flags & SVTYPEMASK) < SVt_PVIV)
6177 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6179 (void)SvIOK_only(sv);
6182 #ifdef PERL_PRESERVE_IVUV
6184 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6185 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6186 /* Need to try really hard to see if it's an integer.
6187 9.22337203685478e+18 is an integer.
6188 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6189 so $a="9.22337203685478e+18"; $a+0; $a--
6190 needs to be the same as $a="9.22337203685478e+18"; $a--
6197 /* sv_2iv *should* have made this an NV */
6198 if (flags & SVp_NOK) {
6199 (void)SvNOK_only(sv);
6200 SvNV_set(sv, SvNVX(sv) - 1.0);
6203 /* I don't think we can get here. Maybe I should assert this
6204 And if we do get here I suspect that sv_setnv will croak. NWC
6206 #if defined(USE_LONG_DOUBLE)
6207 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",
6208 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6210 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6211 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6215 #endif /* PERL_PRESERVE_IVUV */
6216 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6220 =for apidoc sv_mortalcopy
6222 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6223 The new SV is marked as mortal. It will be destroyed "soon", either by an
6224 explicit call to FREETMPS, or by an implicit call at places such as
6225 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6230 /* Make a string that will exist for the duration of the expression
6231 * evaluation. Actually, it may have to last longer than that, but
6232 * hopefully we won't free it until it has been assigned to a
6233 * permanent location. */
6236 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6241 sv_setsv(sv,oldstr);
6243 PL_tmps_stack[++PL_tmps_ix] = sv;
6249 =for apidoc sv_newmortal
6251 Creates a new null SV which is mortal. The reference count of the SV is
6252 set to 1. It will be destroyed "soon", either by an explicit call to
6253 FREETMPS, or by an implicit call at places such as statement boundaries.
6254 See also C<sv_mortalcopy> and C<sv_2mortal>.
6260 Perl_sv_newmortal(pTHX)
6265 SvFLAGS(sv) = SVs_TEMP;
6267 PL_tmps_stack[++PL_tmps_ix] = sv;
6272 =for apidoc sv_2mortal
6274 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6275 by an explicit call to FREETMPS, or by an implicit call at places such as
6276 statement boundaries. SvTEMP() is turned on which means that the SV's
6277 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6278 and C<sv_mortalcopy>.
6284 Perl_sv_2mortal(pTHX_ register SV *sv)
6289 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6292 PL_tmps_stack[++PL_tmps_ix] = sv;
6300 Creates a new SV and copies a string into it. The reference count for the
6301 SV is set to 1. If C<len> is zero, Perl will compute the length using
6302 strlen(). For efficiency, consider using C<newSVpvn> instead.
6308 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6313 sv_setpvn(sv,s,len ? len : strlen(s));
6318 =for apidoc newSVpvn
6320 Creates a new SV and copies a string into it. The reference count for the
6321 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6322 string. You are responsible for ensuring that the source string is at least
6323 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6329 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6334 sv_setpvn(sv,s,len);
6340 =for apidoc newSVhek
6342 Creates a new SV from the hash key structure. It will generate scalars that
6343 point to the shared string table where possible. Returns a new (undefined)
6344 SV if the hek is NULL.
6350 Perl_newSVhek(pTHX_ const HEK *hek)
6359 if (HEK_LEN(hek) == HEf_SVKEY) {
6360 return newSVsv(*(SV**)HEK_KEY(hek));
6362 const int flags = HEK_FLAGS(hek);
6363 if (flags & HVhek_WASUTF8) {
6365 Andreas would like keys he put in as utf8 to come back as utf8
6367 STRLEN utf8_len = HEK_LEN(hek);
6368 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6369 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6372 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6374 } else if (flags & HVhek_REHASH) {
6375 /* We don't have a pointer to the hv, so we have to replicate the
6376 flag into every HEK. This hv is using custom a hasing
6377 algorithm. Hence we can't return a shared string scalar, as
6378 that would contain the (wrong) hash value, and might get passed
6379 into an hv routine with a regular hash */
6381 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6386 /* This will be overwhelminly the most common case. */
6387 return newSVpvn_share(HEK_KEY(hek),
6388 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6394 =for apidoc newSVpvn_share
6396 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6397 table. If the string does not already exist in the table, it is created
6398 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6399 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6400 otherwise the hash is computed. The idea here is that as the string table
6401 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6402 hash lookup will avoid string compare.
6408 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6411 bool is_utf8 = FALSE;
6413 STRLEN tmplen = -len;
6415 /* See the note in hv.c:hv_fetch() --jhi */
6416 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6420 PERL_HASH(hash, src, len);
6422 sv_upgrade(sv, SVt_PV);
6423 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6435 #if defined(PERL_IMPLICIT_CONTEXT)
6437 /* pTHX_ magic can't cope with varargs, so this is a no-context
6438 * version of the main function, (which may itself be aliased to us).
6439 * Don't access this version directly.
6443 Perl_newSVpvf_nocontext(const char* pat, ...)
6448 va_start(args, pat);
6449 sv = vnewSVpvf(pat, &args);
6456 =for apidoc newSVpvf
6458 Creates a new SV and initializes it with the string formatted like
6465 Perl_newSVpvf(pTHX_ const char* pat, ...)
6469 va_start(args, pat);
6470 sv = vnewSVpvf(pat, &args);
6475 /* backend for newSVpvf() and newSVpvf_nocontext() */
6478 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6482 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6489 Creates a new SV and copies a floating point value into it.
6490 The reference count for the SV is set to 1.
6496 Perl_newSVnv(pTHX_ NV n)
6508 Creates a new SV and copies an integer into it. The reference count for the
6515 Perl_newSViv(pTHX_ IV i)
6527 Creates a new SV and copies an unsigned integer into it.
6528 The reference count for the SV is set to 1.
6534 Perl_newSVuv(pTHX_ UV u)
6544 =for apidoc newRV_noinc
6546 Creates an RV wrapper for an SV. The reference count for the original
6547 SV is B<not> incremented.
6553 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6558 sv_upgrade(sv, SVt_RV);
6560 SvRV_set(sv, tmpRef);
6565 /* newRV_inc is the official function name to use now.
6566 * newRV_inc is in fact #defined to newRV in sv.h
6570 Perl_newRV(pTHX_ SV *tmpRef)
6572 return newRV_noinc(SvREFCNT_inc(tmpRef));
6578 Creates a new SV which is an exact duplicate of the original SV.
6585 Perl_newSVsv(pTHX_ register SV *old)
6591 if (SvTYPE(old) == SVTYPEMASK) {
6592 if (ckWARN_d(WARN_INTERNAL))
6593 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6597 /* SV_GMAGIC is the default for sv_setv()
6598 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6599 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6600 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6605 =for apidoc sv_reset
6607 Underlying implementation for the C<reset> Perl function.
6608 Note that the perl-level function is vaguely deprecated.
6614 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6617 char todo[PERL_UCHAR_MAX+1];
6622 if (!*s) { /* reset ?? searches */
6623 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6625 PMOP *pm = (PMOP *) mg->mg_obj;
6627 pm->op_pmdynflags &= ~PMdf_USED;
6634 /* reset variables */
6636 if (!HvARRAY(stash))
6639 Zero(todo, 256, char);
6642 I32 i = (unsigned char)*s;
6646 max = (unsigned char)*s++;
6647 for ( ; i <= max; i++) {
6650 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6652 for (entry = HvARRAY(stash)[i];
6654 entry = HeNEXT(entry))
6659 if (!todo[(U8)*HeKEY(entry)])
6661 gv = (GV*)HeVAL(entry);
6664 if (SvTHINKFIRST(sv)) {
6665 if (!SvREADONLY(sv) && SvROK(sv))
6667 /* XXX Is this continue a bug? Why should THINKFIRST
6668 exempt us from resetting arrays and hashes? */
6672 if (SvTYPE(sv) >= SVt_PV) {
6674 if (SvPVX_const(sv) != Nullch)
6682 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6684 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6687 # if defined(USE_ENVIRON_ARRAY)
6690 # endif /* USE_ENVIRON_ARRAY */
6701 Using various gambits, try to get an IO from an SV: the IO slot if its a
6702 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6703 named after the PV if we're a string.
6709 Perl_sv_2io(pTHX_ SV *sv)
6714 switch (SvTYPE(sv)) {
6722 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6726 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6728 return sv_2io(SvRV(sv));
6729 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6735 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6744 Using various gambits, try to get a CV from an SV; in addition, try if
6745 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6751 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6758 return *gvp = Nullgv, Nullcv;
6759 switch (SvTYPE(sv)) {
6777 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6778 tryAMAGICunDEREF(to_cv);
6781 if (SvTYPE(sv) == SVt_PVCV) {
6790 Perl_croak(aTHX_ "Not a subroutine reference");
6795 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6801 if (lref && !GvCVu(gv)) {
6804 tmpsv = NEWSV(704,0);
6805 gv_efullname3(tmpsv, gv, Nullch);
6806 /* XXX this is probably not what they think they're getting.
6807 * It has the same effect as "sub name;", i.e. just a forward
6809 newSUB(start_subparse(FALSE, 0),
6810 newSVOP(OP_CONST, 0, tmpsv),
6815 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6825 Returns true if the SV has a true value by Perl's rules.
6826 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6827 instead use an in-line version.
6833 Perl_sv_true(pTHX_ register SV *sv)
6838 register const XPV* const tXpv = (XPV*)SvANY(sv);
6840 (tXpv->xpv_cur > 1 ||
6841 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6848 return SvIVX(sv) != 0;
6851 return SvNVX(sv) != 0.0;
6853 return sv_2bool(sv);
6859 =for apidoc sv_pvn_force
6861 Get a sensible string out of the SV somehow.
6862 A private implementation of the C<SvPV_force> macro for compilers which
6863 can't cope with complex macro expressions. Always use the macro instead.
6865 =for apidoc sv_pvn_force_flags
6867 Get a sensible string out of the SV somehow.
6868 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6869 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6870 implemented in terms of this function.
6871 You normally want to use the various wrapper macros instead: see
6872 C<SvPV_force> and C<SvPV_force_nomg>
6878 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6881 if (SvTHINKFIRST(sv) && !SvROK(sv))
6882 sv_force_normal_flags(sv, 0);
6892 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6893 const char * const ref = sv_reftype(sv,0);
6895 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6896 ref, OP_NAME(PL_op));
6898 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6900 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6901 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6903 s = sv_2pv_flags(sv, &len, flags);
6907 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6910 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6911 SvGROW(sv, len + 1);
6912 Move(s,SvPVX(sv),len,char);
6917 SvPOK_on(sv); /* validate pointer */
6919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6920 PTR2UV(sv),SvPVX_const(sv)));
6923 return SvPVX_mutable(sv);
6927 =for apidoc sv_pvbyten_force
6929 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6935 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6937 sv_pvn_force(sv,lp);
6938 sv_utf8_downgrade(sv,0);
6944 =for apidoc sv_pvutf8n_force
6946 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6952 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6954 sv_pvn_force(sv,lp);
6955 sv_utf8_upgrade(sv);
6961 =for apidoc sv_reftype
6963 Returns a string describing what the SV is a reference to.
6969 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6971 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6972 inside return suggests a const propagation bug in g++. */
6973 if (ob && SvOBJECT(sv)) {
6974 char * const name = HvNAME_get(SvSTASH(sv));
6975 return name ? name : (char *) "__ANON__";
6978 switch (SvTYPE(sv)) {
6995 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6996 /* tied lvalues should appear to be
6997 * scalars for backwards compatitbility */
6998 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6999 ? "SCALAR" : "LVALUE");
7000 case SVt_PVAV: return "ARRAY";
7001 case SVt_PVHV: return "HASH";
7002 case SVt_PVCV: return "CODE";
7003 case SVt_PVGV: return "GLOB";
7004 case SVt_PVFM: return "FORMAT";
7005 case SVt_PVIO: return "IO";
7006 default: return "UNKNOWN";
7012 =for apidoc sv_isobject
7014 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7015 object. If the SV is not an RV, or if the object is not blessed, then this
7022 Perl_sv_isobject(pTHX_ SV *sv)
7038 Returns a boolean indicating whether the SV is blessed into the specified
7039 class. This does not check for subtypes; use C<sv_derived_from> to verify
7040 an inheritance relationship.
7046 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7057 hvname = HvNAME_get(SvSTASH(sv));
7061 return strEQ(hvname, name);
7067 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7068 it will be upgraded to one. If C<classname> is non-null then the new SV will
7069 be blessed in the specified package. The new SV is returned and its
7070 reference count is 1.
7076 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7082 SV_CHECK_THINKFIRST_COW_DROP(rv);
7085 if (SvTYPE(rv) >= SVt_PVMG) {
7086 const U32 refcnt = SvREFCNT(rv);
7090 SvREFCNT(rv) = refcnt;
7093 if (SvTYPE(rv) < SVt_RV)
7094 sv_upgrade(rv, SVt_RV);
7095 else if (SvTYPE(rv) > SVt_RV) {
7106 HV* const stash = gv_stashpv(classname, TRUE);
7107 (void)sv_bless(rv, stash);
7113 =for apidoc sv_setref_pv
7115 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7116 argument will be upgraded to an RV. That RV will be modified to point to
7117 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7118 into the SV. The C<classname> argument indicates the package for the
7119 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7120 will have a reference count of 1, and the RV will be returned.
7122 Do not use with other Perl types such as HV, AV, SV, CV, because those
7123 objects will become corrupted by the pointer copy process.
7125 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7131 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7134 sv_setsv(rv, &PL_sv_undef);
7138 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7143 =for apidoc sv_setref_iv
7145 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7146 argument will be upgraded to an RV. That RV will be modified to point to
7147 the new SV. The C<classname> argument indicates the package for the
7148 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7149 will have a reference count of 1, and the RV will be returned.
7155 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7157 sv_setiv(newSVrv(rv,classname), iv);
7162 =for apidoc sv_setref_uv
7164 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7165 argument will be upgraded to an RV. That RV will be modified to point to
7166 the new SV. The C<classname> argument indicates the package for the
7167 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7168 will have a reference count of 1, and the RV will be returned.
7174 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7176 sv_setuv(newSVrv(rv,classname), uv);
7181 =for apidoc sv_setref_nv
7183 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7184 argument will be upgraded to an RV. That RV will be modified to point to
7185 the new SV. The C<classname> argument indicates the package for the
7186 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7187 will have a reference count of 1, and the RV will be returned.
7193 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7195 sv_setnv(newSVrv(rv,classname), nv);
7200 =for apidoc sv_setref_pvn
7202 Copies a string into a new SV, optionally blessing the SV. The length of the
7203 string must be specified with C<n>. The C<rv> argument will be upgraded to
7204 an RV. That RV will be modified to point to the new SV. The C<classname>
7205 argument indicates the package for the blessing. Set C<classname> to
7206 C<Nullch> to avoid the blessing. The new SV will have a reference count
7207 of 1, and the RV will be returned.
7209 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7215 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7217 sv_setpvn(newSVrv(rv,classname), pv, n);
7222 =for apidoc sv_bless
7224 Blesses an SV into a specified package. The SV must be an RV. The package
7225 must be designated by its stash (see C<gv_stashpv()>). The reference count
7226 of the SV is unaffected.
7232 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7236 Perl_croak(aTHX_ "Can't bless non-reference value");
7238 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7239 if (SvREADONLY(tmpRef))
7240 Perl_croak(aTHX_ PL_no_modify);
7241 if (SvOBJECT(tmpRef)) {
7242 if (SvTYPE(tmpRef) != SVt_PVIO)
7244 SvREFCNT_dec(SvSTASH(tmpRef));
7247 SvOBJECT_on(tmpRef);
7248 if (SvTYPE(tmpRef) != SVt_PVIO)
7250 SvUPGRADE(tmpRef, SVt_PVMG);
7251 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7258 if(SvSMAGICAL(tmpRef))
7259 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7267 /* Downgrades a PVGV to a PVMG.
7271 S_sv_unglob(pTHX_ SV *sv)
7275 assert(SvTYPE(sv) == SVt_PVGV);
7280 sv_del_backref((SV*)GvSTASH(sv), sv);
7281 GvSTASH(sv) = Nullhv;
7283 sv_unmagic(sv, PERL_MAGIC_glob);
7284 Safefree(GvNAME(sv));
7287 /* need to keep SvANY(sv) in the right arena */
7288 xpvmg = new_XPVMG();
7289 StructCopy(SvANY(sv), xpvmg, XPVMG);
7290 del_XPVGV(SvANY(sv));
7293 SvFLAGS(sv) &= ~SVTYPEMASK;
7294 SvFLAGS(sv) |= SVt_PVMG;
7298 =for apidoc sv_unref_flags
7300 Unsets the RV status of the SV, and decrements the reference count of
7301 whatever was being referenced by the RV. This can almost be thought of
7302 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7303 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7304 (otherwise the decrementing is conditional on the reference count being
7305 different from one or the reference being a readonly SV).
7312 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7314 SV* const target = SvRV(ref);
7316 if (SvWEAKREF(ref)) {
7317 sv_del_backref(target, ref);
7319 SvRV_set(ref, NULL);
7322 SvRV_set(ref, NULL);
7324 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7325 assigned to as BEGIN {$a = \"Foo"} will fail. */
7326 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7327 SvREFCNT_dec(target);
7328 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7329 sv_2mortal(target); /* Schedule for freeing later */
7333 =for apidoc sv_untaint
7335 Untaint an SV. Use C<SvTAINTED_off> instead.
7340 Perl_sv_untaint(pTHX_ SV *sv)
7342 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7343 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7350 =for apidoc sv_tainted
7352 Test an SV for taintedness. Use C<SvTAINTED> instead.
7357 Perl_sv_tainted(pTHX_ SV *sv)
7359 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7360 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7361 if (mg && (mg->mg_len & 1) )
7368 =for apidoc sv_setpviv
7370 Copies an integer into the given SV, also updating its string value.
7371 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7377 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7379 char buf[TYPE_CHARS(UV)];
7381 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7383 sv_setpvn(sv, ptr, ebuf - ptr);
7387 =for apidoc sv_setpviv_mg
7389 Like C<sv_setpviv>, but also handles 'set' magic.
7395 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7401 #if defined(PERL_IMPLICIT_CONTEXT)
7403 /* pTHX_ magic can't cope with varargs, so this is a no-context
7404 * version of the main function, (which may itself be aliased to us).
7405 * Don't access this version directly.
7409 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7413 va_start(args, pat);
7414 sv_vsetpvf(sv, pat, &args);
7418 /* pTHX_ magic can't cope with varargs, so this is a no-context
7419 * version of the main function, (which may itself be aliased to us).
7420 * Don't access this version directly.
7424 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7428 va_start(args, pat);
7429 sv_vsetpvf_mg(sv, pat, &args);
7435 =for apidoc sv_setpvf
7437 Works like C<sv_catpvf> but copies the text into the SV instead of
7438 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7444 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7447 va_start(args, pat);
7448 sv_vsetpvf(sv, pat, &args);
7453 =for apidoc sv_vsetpvf
7455 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7456 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7458 Usually used via its frontend C<sv_setpvf>.
7464 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7466 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7470 =for apidoc sv_setpvf_mg
7472 Like C<sv_setpvf>, but also handles 'set' magic.
7478 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7481 va_start(args, pat);
7482 sv_vsetpvf_mg(sv, pat, &args);
7487 =for apidoc sv_vsetpvf_mg
7489 Like C<sv_vsetpvf>, but also handles 'set' magic.
7491 Usually used via its frontend C<sv_setpvf_mg>.
7497 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7499 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7503 #if defined(PERL_IMPLICIT_CONTEXT)
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_catpvf_nocontext(SV *sv, const char* pat, ...)
7515 va_start(args, pat);
7516 sv_vcatpvf(sv, pat, &args);
7520 /* pTHX_ magic can't cope with varargs, so this is a no-context
7521 * version of the main function, (which may itself be aliased to us).
7522 * Don't access this version directly.
7526 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7530 va_start(args, pat);
7531 sv_vcatpvf_mg(sv, pat, &args);
7537 =for apidoc sv_catpvf
7539 Processes its arguments like C<sprintf> and appends the formatted
7540 output to an SV. If the appended data contains "wide" characters
7541 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7542 and characters >255 formatted with %c), the original SV might get
7543 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7544 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7545 valid UTF-8; if the original SV was bytes, the pattern should be too.
7550 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7553 va_start(args, pat);
7554 sv_vcatpvf(sv, pat, &args);
7559 =for apidoc sv_vcatpvf
7561 Processes its arguments like C<vsprintf> and appends the formatted output
7562 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7564 Usually used via its frontend C<sv_catpvf>.
7570 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7572 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7576 =for apidoc sv_catpvf_mg
7578 Like C<sv_catpvf>, but also handles 'set' magic.
7584 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7587 va_start(args, pat);
7588 sv_vcatpvf_mg(sv, pat, &args);
7593 =for apidoc sv_vcatpvf_mg
7595 Like C<sv_vcatpvf>, but also handles 'set' magic.
7597 Usually used via its frontend C<sv_catpvf_mg>.
7603 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7605 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7610 =for apidoc sv_vsetpvfn
7612 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7615 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7621 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7623 sv_setpvn(sv, "", 0);
7624 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7627 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7630 S_expect_number(pTHX_ char** pattern)
7633 switch (**pattern) {
7634 case '1': case '2': case '3':
7635 case '4': case '5': case '6':
7636 case '7': case '8': case '9':
7637 while (isDIGIT(**pattern))
7638 var = var * 10 + (*(*pattern)++ - '0');
7642 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7645 F0convert(NV nv, char *endbuf, STRLEN *len)
7647 const int neg = nv < 0;
7656 if (uv & 1 && uv == nv)
7657 uv--; /* Round to even */
7659 const unsigned dig = uv % 10;
7672 =for apidoc sv_vcatpvfn
7674 Processes its arguments like C<vsprintf> and appends the formatted output
7675 to an SV. Uses an array of SVs if the C style variable argument list is
7676 missing (NULL). When running with taint checks enabled, indicates via
7677 C<maybe_tainted> if results are untrustworthy (often due to the use of
7680 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7686 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7687 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7688 vec_utf8 = DO_UTF8(vecsv);
7690 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7693 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7700 static const char nullstr[] = "(null)";
7702 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7703 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7705 /* Times 4: a decimal digit takes more than 3 binary digits.
7706 * NV_DIG: mantissa takes than many decimal digits.
7707 * Plus 32: Playing safe. */
7708 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7709 /* large enough for "%#.#f" --chip */
7710 /* what about long double NVs? --jhi */
7712 PERL_UNUSED_ARG(maybe_tainted);
7714 /* no matter what, this is a string now */
7715 (void)SvPV_force(sv, origlen);
7717 /* special-case "", "%s", and "%-p" (SVf - see below) */
7720 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7722 const char * const s = va_arg(*args, char*);
7723 sv_catpv(sv, s ? s : nullstr);
7725 else if (svix < svmax) {
7726 sv_catsv(sv, *svargs);
7730 if (args && patlen == 3 && pat[0] == '%' &&
7731 pat[1] == '-' && pat[2] == 'p') {
7732 argsv = va_arg(*args, SV*);
7733 sv_catsv(sv, argsv);
7737 #ifndef USE_LONG_DOUBLE
7738 /* special-case "%.<number>[gf]" */
7739 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7740 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7741 unsigned digits = 0;
7745 while (*pp >= '0' && *pp <= '9')
7746 digits = 10 * digits + (*pp++ - '0');
7747 if (pp - pat == (int)patlen - 1) {
7755 /* Add check for digits != 0 because it seems that some
7756 gconverts are buggy in this case, and we don't yet have
7757 a Configure test for this. */
7758 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7759 /* 0, point, slack */
7760 Gconvert(nv, (int)digits, 0, ebuf);
7762 if (*ebuf) /* May return an empty string for digits==0 */
7765 } else if (!digits) {
7768 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7769 sv_catpvn(sv, p, l);
7775 #endif /* !USE_LONG_DOUBLE */
7777 if (!args && svix < svmax && DO_UTF8(*svargs))
7780 patend = (char*)pat + patlen;
7781 for (p = (char*)pat; p < patend; p = q) {
7784 bool vectorize = FALSE;
7785 bool vectorarg = FALSE;
7786 bool vec_utf8 = FALSE;
7792 bool has_precis = FALSE;
7795 bool is_utf8 = FALSE; /* is this item utf8? */
7796 #ifdef HAS_LDBL_SPRINTF_BUG
7797 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
7798 with sfio - Allen <allens@cpan.org> */
7799 bool fix_ldbl_sprintf_bug = FALSE;
7803 U8 utf8buf[UTF8_MAXBYTES+1];
7804 STRLEN esignlen = 0;
7806 const char *eptr = Nullch;
7809 const U8 *vecstr = Null(U8*);
7816 /* we need a long double target in case HAS_LONG_DOUBLE but
7819 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
7827 const char *dotstr = ".";
7828 STRLEN dotstrlen = 1;
7829 I32 efix = 0; /* explicit format parameter index */
7830 I32 ewix = 0; /* explicit width index */
7831 I32 epix = 0; /* explicit precision index */
7832 I32 evix = 0; /* explicit vector index */
7833 bool asterisk = FALSE;
7835 /* echo everything up to the next format specification */
7836 for (q = p; q < patend && *q != '%'; ++q) ;
7838 if (has_utf8 && !pat_utf8)
7839 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
7841 sv_catpvn(sv, p, q - p);
7848 We allow format specification elements in this order:
7849 \d+\$ explicit format parameter index
7851 v|\*(\d+\$)?v vector with optional (optionally specified) arg
7852 0 flag (as above): repeated to allow "v02"
7853 \d+|\*(\d+\$)? width using optional (optionally specified) arg
7854 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
7856 [%bcdefginopsuxDFOUX] format (mandatory)
7861 As of perl5.9.3, printf format checking is on by default.
7862 Internally, perl uses %p formats to provide an escape to
7863 some extended formatting. This block deals with those
7864 extensions: if it does not match, (char*)q is reset and
7865 the normal format processing code is used.
7867 Currently defined extensions are:
7868 %p include pointer address (standard)
7869 %-p (SVf) include an SV (previously %_)
7870 %-<num>p include an SV with precision <num>
7871 %1p (VDf) include a v-string (as %vd)
7872 %<num>p reserved for future extensions
7874 Robin Barker 2005-07-14
7881 EXPECT_NUMBER(q, n);
7888 argsv = va_arg(*args, SV*);
7889 eptr = SvPVx_const(argsv, elen);
7895 else if (n == vdNUMBER) { /* VDf */
7902 if (ckWARN_d(WARN_INTERNAL))
7903 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
7904 "internal %%<num>p might conflict with future printf extensions");
7910 if (EXPECT_NUMBER(q, width)) {
7951 if (EXPECT_NUMBER(q, ewix))
7960 if ((vectorarg = asterisk)) {
7973 EXPECT_NUMBER(q, width);
7979 vecsv = va_arg(*args, SV*);
7981 vecsv = (evix > 0 && evix <= svmax)
7982 ? svargs[evix-1] : &PL_sv_undef;
7984 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
7986 dotstr = SvPV_const(vecsv, dotstrlen);
7987 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
7988 bad with tied or overloaded values that return UTF8. */
7991 else if (has_utf8) {
7992 vecsv = sv_mortalcopy(vecsv);
7993 sv_utf8_upgrade(vecsv);
7994 dotstr = SvPV_const(vecsv, dotstrlen);
8001 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8002 vecsv = svargs[efix ? efix-1 : svix++];
8003 vecstr = (U8*)SvPV_const(vecsv,veclen);
8004 vec_utf8 = DO_UTF8(vecsv);
8005 /* if this is a version object, we need to return the
8006 * stringified representation (which the SvPVX_const has
8007 * already done for us), but not vectorize the args
8009 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8011 q++; /* skip past the rest of the %vd format */
8012 eptr = (const char *) vecstr;
8026 i = va_arg(*args, int);
8028 i = (ewix ? ewix <= svmax : svix < svmax) ?
8029 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8031 width = (i < 0) ? -i : i;
8041 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8043 /* XXX: todo, support specified precision parameter */
8047 i = va_arg(*args, int);
8049 i = (ewix ? ewix <= svmax : svix < svmax)
8050 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8051 precis = (i < 0) ? 0 : i;
8056 precis = precis * 10 + (*q++ - '0');
8065 case 'I': /* Ix, I32x, and I64x */
8067 if (q[1] == '6' && q[2] == '4') {
8073 if (q[1] == '3' && q[2] == '2') {
8083 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8094 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8095 if (*(q + 1) == 'l') { /* lld, llf */
8121 if (!vectorize && !args) {
8123 const I32 i = efix-1;
8124 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8126 argsv = (svix >= 0 && svix < svmax)
8127 ? svargs[svix++] : &PL_sv_undef;
8138 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8140 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8142 eptr = (char*)utf8buf;
8143 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8157 eptr = va_arg(*args, char*);
8159 #ifdef MACOS_TRADITIONAL
8160 /* On MacOS, %#s format is used for Pascal strings */
8165 elen = strlen(eptr);
8167 eptr = (char *)nullstr;
8168 elen = sizeof nullstr - 1;
8172 eptr = SvPVx_const(argsv, elen);
8173 if (DO_UTF8(argsv)) {
8174 if (has_precis && precis < elen) {
8176 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8179 if (width) { /* fudge width (can't fudge elen) */
8180 width += elen - sv_len_utf8(argsv);
8187 if (has_precis && elen > precis)
8194 if (alt || vectorize)
8196 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8217 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8226 esignbuf[esignlen++] = plus;
8230 case 'h': iv = (short)va_arg(*args, int); break;
8231 case 'l': iv = va_arg(*args, long); break;
8232 case 'V': iv = va_arg(*args, IV); break;
8233 default: iv = va_arg(*args, int); break;
8235 case 'q': iv = va_arg(*args, Quad_t); break;
8240 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8242 case 'h': iv = (short)tiv; break;
8243 case 'l': iv = (long)tiv; break;
8245 default: iv = tiv; break;
8247 case 'q': iv = (Quad_t)tiv; break;
8251 if ( !vectorize ) /* we already set uv above */
8256 esignbuf[esignlen++] = plus;
8260 esignbuf[esignlen++] = '-';
8303 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8314 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8315 case 'l': uv = va_arg(*args, unsigned long); break;
8316 case 'V': uv = va_arg(*args, UV); break;
8317 default: uv = va_arg(*args, unsigned); break;
8319 case 'q': uv = va_arg(*args, Uquad_t); break;
8324 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8326 case 'h': uv = (unsigned short)tuv; break;
8327 case 'l': uv = (unsigned long)tuv; break;
8329 default: uv = tuv; break;
8331 case 'q': uv = (Uquad_t)tuv; break;
8338 char *ptr = ebuf + sizeof ebuf;
8344 p = (char*)((c == 'X')
8345 ? "0123456789ABCDEF" : "0123456789abcdef");
8351 esignbuf[esignlen++] = '0';
8352 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8360 if (alt && *ptr != '0')
8371 esignbuf[esignlen++] = '0';
8372 esignbuf[esignlen++] = 'b';
8375 default: /* it had better be ten or less */
8379 } while (uv /= base);
8382 elen = (ebuf + sizeof ebuf) - ptr;
8386 zeros = precis - elen;
8387 else if (precis == 0 && elen == 1 && *eptr == '0')
8393 /* FLOATING POINT */
8396 c = 'f'; /* maybe %F isn't supported here */
8404 /* This is evil, but floating point is even more evil */
8406 /* for SV-style calling, we can only get NV
8407 for C-style calling, we assume %f is double;
8408 for simplicity we allow any of %Lf, %llf, %qf for long double
8412 #if defined(USE_LONG_DOUBLE)
8416 /* [perl #20339] - we should accept and ignore %lf rather than die */
8420 #if defined(USE_LONG_DOUBLE)
8421 intsize = args ? 0 : 'q';
8425 #if defined(HAS_LONG_DOUBLE)
8434 /* now we need (long double) if intsize == 'q', else (double) */
8436 #if LONG_DOUBLESIZE > DOUBLESIZE
8438 va_arg(*args, long double) :
8439 va_arg(*args, double)
8441 va_arg(*args, double)
8446 if (c != 'e' && c != 'E') {
8448 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8449 will cast our (long double) to (double) */
8450 (void)Perl_frexp(nv, &i);
8451 if (i == PERL_INT_MIN)
8452 Perl_die(aTHX_ "panic: frexp");
8454 need = BIT_DIGITS(i);
8456 need += has_precis ? precis : 6; /* known default */
8461 #ifdef HAS_LDBL_SPRINTF_BUG
8462 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8463 with sfio - Allen <allens@cpan.org> */
8466 # define MY_DBL_MAX DBL_MAX
8467 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8468 # if DOUBLESIZE >= 8
8469 # define MY_DBL_MAX 1.7976931348623157E+308L
8471 # define MY_DBL_MAX 3.40282347E+38L
8475 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8476 # define MY_DBL_MAX_BUG 1L
8478 # define MY_DBL_MAX_BUG MY_DBL_MAX
8482 # define MY_DBL_MIN DBL_MIN
8483 # else /* XXX guessing! -Allen */
8484 # if DOUBLESIZE >= 8
8485 # define MY_DBL_MIN 2.2250738585072014E-308L
8487 # define MY_DBL_MIN 1.17549435E-38L
8491 if ((intsize == 'q') && (c == 'f') &&
8492 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8494 /* it's going to be short enough that
8495 * long double precision is not needed */
8497 if ((nv <= 0L) && (nv >= -0L))
8498 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8500 /* would use Perl_fp_class as a double-check but not
8501 * functional on IRIX - see perl.h comments */
8503 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8504 /* It's within the range that a double can represent */
8505 #if defined(DBL_MAX) && !defined(DBL_MIN)
8506 if ((nv >= ((long double)1/DBL_MAX)) ||
8507 (nv <= (-(long double)1/DBL_MAX)))
8509 fix_ldbl_sprintf_bug = TRUE;
8512 if (fix_ldbl_sprintf_bug == TRUE) {
8522 # undef MY_DBL_MAX_BUG
8525 #endif /* HAS_LDBL_SPRINTF_BUG */
8527 need += 20; /* fudge factor */
8528 if (PL_efloatsize < need) {
8529 Safefree(PL_efloatbuf);
8530 PL_efloatsize = need + 20; /* more fudge */
8531 Newx(PL_efloatbuf, PL_efloatsize, char);
8532 PL_efloatbuf[0] = '\0';
8535 if ( !(width || left || plus || alt) && fill != '0'
8536 && has_precis && intsize != 'q' ) { /* Shortcuts */
8537 /* See earlier comment about buggy Gconvert when digits,
8539 if ( c == 'g' && precis) {
8540 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8541 /* May return an empty string for digits==0 */
8542 if (*PL_efloatbuf) {
8543 elen = strlen(PL_efloatbuf);
8544 goto float_converted;
8546 } else if ( c == 'f' && !precis) {
8547 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8552 char *ptr = ebuf + sizeof ebuf;
8555 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8556 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8557 if (intsize == 'q') {
8558 /* Copy the one or more characters in a long double
8559 * format before the 'base' ([efgEFG]) character to
8560 * the format string. */
8561 static char const prifldbl[] = PERL_PRIfldbl;
8562 char const *p = prifldbl + sizeof(prifldbl) - 3;
8563 while (p >= prifldbl) { *--ptr = *p--; }
8568 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8573 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8585 /* No taint. Otherwise we are in the strange situation
8586 * where printf() taints but print($float) doesn't.
8588 #if defined(HAS_LONG_DOUBLE)
8589 elen = ((intsize == 'q')
8590 ? my_sprintf(PL_efloatbuf, ptr, nv)
8591 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8593 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8597 eptr = PL_efloatbuf;
8605 i = SvCUR(sv) - origlen;
8608 case 'h': *(va_arg(*args, short*)) = i; break;
8609 default: *(va_arg(*args, int*)) = i; break;
8610 case 'l': *(va_arg(*args, long*)) = i; break;
8611 case 'V': *(va_arg(*args, IV*)) = i; break;
8613 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8618 sv_setuv_mg(argsv, (UV)i);
8619 continue; /* not "break" */
8626 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8627 && ckWARN(WARN_PRINTF))
8629 SV * const msg = sv_newmortal();
8630 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8631 (PL_op->op_type == OP_PRTF) ? "" : "s");
8634 Perl_sv_catpvf(aTHX_ msg,
8635 "\"%%%c\"", c & 0xFF);
8637 Perl_sv_catpvf(aTHX_ msg,
8638 "\"%%\\%03"UVof"\"",
8641 sv_catpv(msg, "end of string");
8642 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8645 /* output mangled stuff ... */
8651 /* ... right here, because formatting flags should not apply */
8652 SvGROW(sv, SvCUR(sv) + elen + 1);
8654 Copy(eptr, p, elen, char);
8657 SvCUR_set(sv, p - SvPVX_const(sv));
8659 continue; /* not "break" */
8662 /* calculate width before utf8_upgrade changes it */
8663 have = esignlen + zeros + elen;
8665 Perl_croak_nocontext(PL_memory_wrap);
8667 if (is_utf8 != has_utf8) {
8670 sv_utf8_upgrade(sv);
8673 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8674 sv_utf8_upgrade(nsv);
8675 eptr = SvPVX_const(nsv);
8678 SvGROW(sv, SvCUR(sv) + elen + 1);
8683 need = (have > width ? have : width);
8686 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8687 Perl_croak_nocontext(PL_memory_wrap);
8688 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8690 if (esignlen && fill == '0') {
8692 for (i = 0; i < (int)esignlen; i++)
8696 memset(p, fill, gap);
8699 if (esignlen && fill != '0') {
8701 for (i = 0; i < (int)esignlen; i++)
8706 for (i = zeros; i; i--)
8710 Copy(eptr, p, elen, char);
8714 memset(p, ' ', gap);
8719 Copy(dotstr, p, dotstrlen, char);
8723 vectorize = FALSE; /* done iterating over vecstr */
8730 SvCUR_set(sv, p - SvPVX_const(sv));
8738 /* =========================================================================
8740 =head1 Cloning an interpreter
8742 All the macros and functions in this section are for the private use of
8743 the main function, perl_clone().
8745 The foo_dup() functions make an exact copy of an existing foo thinngy.
8746 During the course of a cloning, a hash table is used to map old addresses
8747 to new addresses. The table is created and manipulated with the
8748 ptr_table_* functions.
8752 ============================================================================*/
8755 #if defined(USE_ITHREADS)
8757 #ifndef GpREFCNT_inc
8758 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8762 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8763 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8764 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8765 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8766 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8767 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8768 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8769 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8770 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8771 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8772 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8773 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8774 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8777 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8778 regcomp.c. AMS 20010712 */
8781 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8786 struct reg_substr_datum *s;
8789 return (REGEXP *)NULL;
8791 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8794 len = r->offsets[0];
8795 npar = r->nparens+1;
8797 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8798 Copy(r->program, ret->program, len+1, regnode);
8800 Newx(ret->startp, npar, I32);
8801 Copy(r->startp, ret->startp, npar, I32);
8802 Newx(ret->endp, npar, I32);
8803 Copy(r->startp, ret->startp, npar, I32);
8805 Newx(ret->substrs, 1, struct reg_substr_data);
8806 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8807 s->min_offset = r->substrs->data[i].min_offset;
8808 s->max_offset = r->substrs->data[i].max_offset;
8809 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8810 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8813 ret->regstclass = NULL;
8816 const int count = r->data->count;
8819 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8820 char, struct reg_data);
8821 Newx(d->what, count, U8);
8824 for (i = 0; i < count; i++) {
8825 d->what[i] = r->data->what[i];
8826 switch (d->what[i]) {
8827 /* legal options are one of: sfpont
8828 see also regcomp.h and pregfree() */
8830 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8833 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8836 /* This is cheating. */
8837 Newx(d->data[i], 1, struct regnode_charclass_class);
8838 StructCopy(r->data->data[i], d->data[i],
8839 struct regnode_charclass_class);
8840 ret->regstclass = (regnode*)d->data[i];
8843 /* Compiled op trees are readonly, and can thus be
8844 shared without duplication. */
8846 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8850 d->data[i] = r->data->data[i];
8853 d->data[i] = r->data->data[i];
8855 ((reg_trie_data*)d->data[i])->refcount++;
8859 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8868 Newx(ret->offsets, 2*len+1, U32);
8869 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8871 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8872 ret->refcnt = r->refcnt;
8873 ret->minlen = r->minlen;
8874 ret->prelen = r->prelen;
8875 ret->nparens = r->nparens;
8876 ret->lastparen = r->lastparen;
8877 ret->lastcloseparen = r->lastcloseparen;
8878 ret->reganch = r->reganch;
8880 ret->sublen = r->sublen;
8882 if (RX_MATCH_COPIED(ret))
8883 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8885 ret->subbeg = Nullch;
8886 #ifdef PERL_OLD_COPY_ON_WRITE
8887 ret->saved_copy = Nullsv;
8890 ptr_table_store(PL_ptr_table, r, ret);
8894 /* duplicate a file handle */
8897 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8901 PERL_UNUSED_ARG(type);
8904 return (PerlIO*)NULL;
8906 /* look for it in the table first */
8907 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8911 /* create anew and remember what it is */
8912 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8913 ptr_table_store(PL_ptr_table, fp, ret);
8917 /* duplicate a directory handle */
8920 Perl_dirp_dup(pTHX_ DIR *dp)
8928 /* duplicate a typeglob */
8931 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8936 /* look for it in the table first */
8937 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8941 /* create anew and remember what it is */
8943 ptr_table_store(PL_ptr_table, gp, ret);
8946 ret->gp_refcnt = 0; /* must be before any other dups! */
8947 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8948 ret->gp_io = io_dup_inc(gp->gp_io, param);
8949 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8950 ret->gp_av = av_dup_inc(gp->gp_av, param);
8951 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8952 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8953 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8954 ret->gp_cvgen = gp->gp_cvgen;
8955 ret->gp_line = gp->gp_line;
8956 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8960 /* duplicate a chain of magic */
8963 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8965 MAGIC *mgprev = (MAGIC*)NULL;
8968 return (MAGIC*)NULL;
8969 /* look for it in the table first */
8970 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8974 for (; mg; mg = mg->mg_moremagic) {
8976 Newxz(nmg, 1, MAGIC);
8978 mgprev->mg_moremagic = nmg;
8981 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8982 nmg->mg_private = mg->mg_private;
8983 nmg->mg_type = mg->mg_type;
8984 nmg->mg_flags = mg->mg_flags;
8985 if (mg->mg_type == PERL_MAGIC_qr) {
8986 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8988 else if(mg->mg_type == PERL_MAGIC_backref) {
8989 const AV * const av = (AV*) mg->mg_obj;
8992 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
8994 for (i = AvFILLp(av); i >= 0; i--) {
8995 if (!svp[i]) continue;
8996 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
8999 else if (mg->mg_type == PERL_MAGIC_symtab) {
9000 nmg->mg_obj = mg->mg_obj;
9003 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9004 ? sv_dup_inc(mg->mg_obj, param)
9005 : sv_dup(mg->mg_obj, param);
9007 nmg->mg_len = mg->mg_len;
9008 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9009 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9010 if (mg->mg_len > 0) {
9011 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9012 if (mg->mg_type == PERL_MAGIC_overload_table &&
9013 AMT_AMAGIC((AMT*)mg->mg_ptr))
9015 AMT * const amtp = (AMT*)mg->mg_ptr;
9016 AMT * const namtp = (AMT*)nmg->mg_ptr;
9018 for (i = 1; i < NofAMmeth; i++) {
9019 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9023 else if (mg->mg_len == HEf_SVKEY)
9024 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9026 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9027 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9034 /* create a new pointer-mapping table */
9037 Perl_ptr_table_new(pTHX)
9040 Newxz(tbl, 1, PTR_TBL_t);
9043 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9047 #define PTR_TABLE_HASH(ptr) \
9048 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9051 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9052 following define) and at call to new_body_inline made below in
9053 Perl_ptr_table_store()
9056 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9058 /* map an existing pointer using a table */
9060 STATIC PTR_TBL_ENT_t *
9061 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9062 PTR_TBL_ENT_t *tblent;
9063 const UV hash = PTR_TABLE_HASH(sv);
9065 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9066 for (; tblent; tblent = tblent->next) {
9067 if (tblent->oldval == sv)
9074 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9076 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9077 return tblent ? tblent->newval : (void *) 0;
9080 /* add a new entry to a pointer-mapping table */
9083 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9085 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9088 tblent->newval = newsv;
9090 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9092 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9093 tblent->oldval = oldsv;
9094 tblent->newval = newsv;
9095 tblent->next = tbl->tbl_ary[entry];
9096 tbl->tbl_ary[entry] = tblent;
9098 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9099 ptr_table_split(tbl);
9103 /* double the hash bucket size of an existing ptr table */
9106 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9108 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9109 const UV oldsize = tbl->tbl_max + 1;
9110 UV newsize = oldsize * 2;
9113 Renew(ary, newsize, PTR_TBL_ENT_t*);
9114 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9115 tbl->tbl_max = --newsize;
9117 for (i=0; i < oldsize; i++, ary++) {
9118 PTR_TBL_ENT_t **curentp, **entp, *ent;
9121 curentp = ary + oldsize;
9122 for (entp = ary, ent = *ary; ent; ent = *entp) {
9123 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9125 ent->next = *curentp;
9135 /* remove all the entries from a ptr table */
9138 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9140 if (tbl && tbl->tbl_items) {
9141 register PTR_TBL_ENT_t **array = tbl->tbl_ary;
9142 UV riter = tbl->tbl_max;
9145 PTR_TBL_ENT_t *entry = array[riter];
9148 PTR_TBL_ENT_t * const oentry = entry;
9149 entry = entry->next;
9158 /* clear and free a ptr table */
9161 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9166 ptr_table_clear(tbl);
9167 Safefree(tbl->tbl_ary);
9173 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9176 SvRV_set(dstr, SvWEAKREF(sstr)
9177 ? sv_dup(SvRV(sstr), param)
9178 : sv_dup_inc(SvRV(sstr), param));
9181 else if (SvPVX_const(sstr)) {
9182 /* Has something there */
9184 /* Normal PV - clone whole allocated space */
9185 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9186 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9187 /* Not that normal - actually sstr is copy on write.
9188 But we are a true, independant SV, so: */
9189 SvREADONLY_off(dstr);
9194 /* Special case - not normally malloced for some reason */
9195 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9196 /* A "shared" PV - clone it as "shared" PV */
9198 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9202 /* Some other special case - random pointer */
9203 SvPV_set(dstr, SvPVX(sstr));
9209 if (SvTYPE(dstr) == SVt_RV)
9210 SvRV_set(dstr, NULL);
9216 /* duplicate an SV of any type (including AV, HV etc) */
9219 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9224 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9226 /* look for it in the table first */
9227 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9231 if(param->flags & CLONEf_JOIN_IN) {
9232 /** We are joining here so we don't want do clone
9233 something that is bad **/
9236 if(SvTYPE(sstr) == SVt_PVHV &&
9237 (hvname = HvNAME_get(sstr))) {
9238 /** don't clone stashes if they already exist **/
9239 return (SV*)gv_stashpv(hvname,0);
9243 /* create anew and remember what it is */
9246 #ifdef DEBUG_LEAKING_SCALARS
9247 dstr->sv_debug_optype = sstr->sv_debug_optype;
9248 dstr->sv_debug_line = sstr->sv_debug_line;
9249 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9250 dstr->sv_debug_cloned = 1;
9252 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9254 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9258 ptr_table_store(PL_ptr_table, sstr, dstr);
9261 SvFLAGS(dstr) = SvFLAGS(sstr);
9262 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9263 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9266 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9267 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9268 PL_watch_pvx, SvPVX_const(sstr));
9271 /* don't clone objects whose class has asked us not to */
9272 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9273 SvFLAGS(dstr) &= ~SVTYPEMASK;
9278 switch (SvTYPE(sstr)) {
9283 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9284 SvIV_set(dstr, SvIVX(sstr));
9287 SvANY(dstr) = new_XNV();
9288 SvNV_set(dstr, SvNVX(sstr));
9291 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9292 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9296 /* These are all the types that need complex bodies allocating. */
9298 const svtype sv_type = SvTYPE(sstr);
9299 const struct body_details *const sv_type_details
9300 = bodies_by_type + sv_type;
9304 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9309 if (GvUNIQUE((GV*)sstr)) {
9310 /* Do sharing here, and fall through */
9323 assert(sv_type_details->copy);
9324 if (sv_type_details->arena) {
9325 new_body_inline(new_body, sv_type_details->copy, sv_type);
9327 = (void*)((char*)new_body - sv_type_details->offset);
9329 new_body = new_NOARENA(sv_type_details);
9333 SvANY(dstr) = new_body;
9336 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9337 ((char*)SvANY(dstr)) + sv_type_details->offset,
9338 sv_type_details->copy, char);
9340 Copy(((char*)SvANY(sstr)),
9341 ((char*)SvANY(dstr)),
9342 sv_type_details->size + sv_type_details->offset, char);
9345 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9346 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9348 /* The Copy above means that all the source (unduplicated) pointers
9349 are now in the destination. We can check the flags and the
9350 pointers in either, but it's possible that there's less cache
9351 missing by always going for the destination.
9352 FIXME - instrument and check that assumption */
9353 if (sv_type >= SVt_PVMG) {
9355 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9357 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9360 /* The cast silences a GCC warning about unhandled types. */
9361 switch ((int)sv_type) {
9373 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9374 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9375 LvTARG(dstr) = dstr;
9376 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9377 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9379 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9382 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9383 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9384 /* Don't call sv_add_backref here as it's going to be created
9385 as part of the magic cloning of the symbol table. */
9386 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9387 (void)GpREFCNT_inc(GvGP(dstr));
9390 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9391 if (IoOFP(dstr) == IoIFP(sstr))
9392 IoOFP(dstr) = IoIFP(dstr);
9394 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9395 /* PL_rsfp_filters entries have fake IoDIRP() */
9396 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9397 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9398 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9399 /* I have no idea why fake dirp (rsfps)
9400 should be treated differently but otherwise
9401 we end up with leaks -- sky*/
9402 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9403 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9404 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9406 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9407 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9408 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9410 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9411 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9412 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9415 if (AvARRAY((AV*)sstr)) {
9416 SV **dst_ary, **src_ary;
9417 SSize_t items = AvFILLp((AV*)sstr) + 1;
9419 src_ary = AvARRAY((AV*)sstr);
9420 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9421 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9422 SvPV_set(dstr, (char*)dst_ary);
9423 AvALLOC((AV*)dstr) = dst_ary;
9424 if (AvREAL((AV*)sstr)) {
9426 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9430 *dst_ary++ = sv_dup(*src_ary++, param);
9432 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9433 while (items-- > 0) {
9434 *dst_ary++ = &PL_sv_undef;
9438 SvPV_set(dstr, Nullch);
9439 AvALLOC((AV*)dstr) = (SV**)NULL;
9446 if (HvARRAY((HV*)sstr)) {
9448 const bool sharekeys = !!HvSHAREKEYS(sstr);
9449 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9450 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9452 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9453 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9455 HvARRAY(dstr) = (HE**)darray;
9456 while (i <= sxhv->xhv_max) {
9457 const HE *source = HvARRAY(sstr)[i];
9458 HvARRAY(dstr)[i] = source
9459 ? he_dup(source, sharekeys, param) : 0;
9463 struct xpvhv_aux * const saux = HvAUX(sstr);
9464 struct xpvhv_aux * const daux = HvAUX(dstr);
9465 /* This flag isn't copied. */
9466 /* SvOOK_on(hv) attacks the IV flags. */
9467 SvFLAGS(dstr) |= SVf_OOK;
9469 hvname = saux->xhv_name;
9471 = hvname ? hek_dup(hvname, param) : hvname;
9473 daux->xhv_riter = saux->xhv_riter;
9474 daux->xhv_eiter = saux->xhv_eiter
9475 ? he_dup(saux->xhv_eiter,
9476 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9480 SvPV_set(dstr, Nullch);
9482 /* Record stashes for possible cloning in Perl_clone(). */
9484 av_push(param->stashes, dstr);
9489 /* NOTE: not refcounted */
9490 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9492 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9494 if (CvCONST(dstr)) {
9495 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9496 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9497 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9499 /* don't dup if copying back - CvGV isn't refcounted, so the
9500 * duped GV may never be freed. A bit of a hack! DAPM */
9501 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9502 Nullgv : gv_dup(CvGV(dstr), param) ;
9503 if (!(param->flags & CLONEf_COPY_STACKS)) {
9506 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9509 ? cv_dup( CvOUTSIDE(dstr), param)
9510 : cv_dup_inc(CvOUTSIDE(dstr), param);
9512 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9518 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9524 /* duplicate a context */
9527 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9532 return (PERL_CONTEXT*)NULL;
9534 /* look for it in the table first */
9535 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9539 /* create anew and remember what it is */
9540 Newxz(ncxs, max + 1, PERL_CONTEXT);
9541 ptr_table_store(PL_ptr_table, cxs, ncxs);
9544 PERL_CONTEXT *cx = &cxs[ix];
9545 PERL_CONTEXT *ncx = &ncxs[ix];
9546 ncx->cx_type = cx->cx_type;
9547 if (CxTYPE(cx) == CXt_SUBST) {
9548 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9551 ncx->blk_oldsp = cx->blk_oldsp;
9552 ncx->blk_oldcop = cx->blk_oldcop;
9553 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9554 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9555 ncx->blk_oldpm = cx->blk_oldpm;
9556 ncx->blk_gimme = cx->blk_gimme;
9557 switch (CxTYPE(cx)) {
9559 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9560 ? cv_dup_inc(cx->blk_sub.cv, param)
9561 : cv_dup(cx->blk_sub.cv,param));
9562 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9563 ? av_dup_inc(cx->blk_sub.argarray, param)
9565 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9566 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9567 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9568 ncx->blk_sub.lval = cx->blk_sub.lval;
9569 ncx->blk_sub.retop = cx->blk_sub.retop;
9572 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9573 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9574 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9575 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9576 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9577 ncx->blk_eval.retop = cx->blk_eval.retop;
9580 ncx->blk_loop.label = cx->blk_loop.label;
9581 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9582 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9583 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9584 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9585 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9586 ? cx->blk_loop.iterdata
9587 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9588 ncx->blk_loop.oldcomppad
9589 = (PAD*)ptr_table_fetch(PL_ptr_table,
9590 cx->blk_loop.oldcomppad);
9591 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9592 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9593 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9594 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9595 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9598 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9599 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9600 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9601 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9602 ncx->blk_sub.retop = cx->blk_sub.retop;
9614 /* duplicate a stack info structure */
9617 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9622 return (PERL_SI*)NULL;
9624 /* look for it in the table first */
9625 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9629 /* create anew and remember what it is */
9630 Newxz(nsi, 1, PERL_SI);
9631 ptr_table_store(PL_ptr_table, si, nsi);
9633 nsi->si_stack = av_dup_inc(si->si_stack, param);
9634 nsi->si_cxix = si->si_cxix;
9635 nsi->si_cxmax = si->si_cxmax;
9636 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9637 nsi->si_type = si->si_type;
9638 nsi->si_prev = si_dup(si->si_prev, param);
9639 nsi->si_next = si_dup(si->si_next, param);
9640 nsi->si_markoff = si->si_markoff;
9645 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9646 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9647 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9648 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9649 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9650 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9651 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9652 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9653 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9654 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9655 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9656 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9657 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9658 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9661 #define pv_dup_inc(p) SAVEPV(p)
9662 #define pv_dup(p) SAVEPV(p)
9663 #define svp_dup_inc(p,pp) any_dup(p,pp)
9665 /* map any object to the new equivent - either something in the
9666 * ptr table, or something in the interpreter structure
9670 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9677 /* look for it in the table first */
9678 ret = ptr_table_fetch(PL_ptr_table, v);
9682 /* see if it is part of the interpreter structure */
9683 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9684 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9692 /* duplicate the save stack */
9695 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9697 ANY * const ss = proto_perl->Tsavestack;
9698 const I32 max = proto_perl->Tsavestack_max;
9699 I32 ix = proto_perl->Tsavestack_ix;
9711 void (*dptr) (void*);
9712 void (*dxptr) (pTHX_ void*);
9714 Newxz(nss, max, ANY);
9717 I32 i = POPINT(ss,ix);
9720 case SAVEt_ITEM: /* normal string */
9721 sv = (SV*)POPPTR(ss,ix);
9722 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9723 sv = (SV*)POPPTR(ss,ix);
9724 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9726 case SAVEt_SV: /* scalar reference */
9727 sv = (SV*)POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9729 gv = (GV*)POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9732 case SAVEt_GENERIC_PVREF: /* generic char* */
9733 c = (char*)POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = pv_dup(c);
9735 ptr = POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9738 case SAVEt_SHARED_PVREF: /* char* in shared space */
9739 c = (char*)POPPTR(ss,ix);
9740 TOPPTR(nss,ix) = savesharedpv(c);
9741 ptr = POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9744 case SAVEt_GENERIC_SVREF: /* generic sv */
9745 case SAVEt_SVREF: /* scalar reference */
9746 sv = (SV*)POPPTR(ss,ix);
9747 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9748 ptr = POPPTR(ss,ix);
9749 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9751 case SAVEt_AV: /* array reference */
9752 av = (AV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = av_dup_inc(av, param);
9754 gv = (GV*)POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = gv_dup(gv, param);
9757 case SAVEt_HV: /* hash reference */
9758 hv = (HV*)POPPTR(ss,ix);
9759 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9760 gv = (GV*)POPPTR(ss,ix);
9761 TOPPTR(nss,ix) = gv_dup(gv, param);
9763 case SAVEt_INT: /* int reference */
9764 ptr = POPPTR(ss,ix);
9765 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9766 intval = (int)POPINT(ss,ix);
9767 TOPINT(nss,ix) = intval;
9769 case SAVEt_LONG: /* long reference */
9770 ptr = POPPTR(ss,ix);
9771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9772 longval = (long)POPLONG(ss,ix);
9773 TOPLONG(nss,ix) = longval;
9775 case SAVEt_I32: /* I32 reference */
9776 case SAVEt_I16: /* I16 reference */
9777 case SAVEt_I8: /* I8 reference */
9778 ptr = POPPTR(ss,ix);
9779 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9783 case SAVEt_IV: /* IV reference */
9784 ptr = POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9789 case SAVEt_SPTR: /* SV* reference */
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9792 sv = (SV*)POPPTR(ss,ix);
9793 TOPPTR(nss,ix) = sv_dup(sv, param);
9795 case SAVEt_VPTR: /* random* reference */
9796 ptr = POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 ptr = POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9801 case SAVEt_PPTR: /* char* reference */
9802 ptr = POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9804 c = (char*)POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = pv_dup(c);
9807 case SAVEt_HPTR: /* HV* reference */
9808 ptr = POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9810 hv = (HV*)POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = hv_dup(hv, param);
9813 case SAVEt_APTR: /* AV* reference */
9814 ptr = POPPTR(ss,ix);
9815 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9816 av = (AV*)POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = av_dup(av, param);
9820 gv = (GV*)POPPTR(ss,ix);
9821 TOPPTR(nss,ix) = gv_dup(gv, param);
9823 case SAVEt_GP: /* scalar reference */
9824 gp = (GP*)POPPTR(ss,ix);
9825 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9826 (void)GpREFCNT_inc(gp);
9827 gv = (GV*)POPPTR(ss,ix);
9828 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9829 c = (char*)POPPTR(ss,ix);
9830 TOPPTR(nss,ix) = pv_dup(c);
9837 case SAVEt_MORTALIZESV:
9838 sv = (SV*)POPPTR(ss,ix);
9839 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9842 ptr = POPPTR(ss,ix);
9843 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9844 /* these are assumed to be refcounted properly */
9846 switch (((OP*)ptr)->op_type) {
9853 TOPPTR(nss,ix) = ptr;
9858 TOPPTR(nss,ix) = Nullop;
9863 TOPPTR(nss,ix) = Nullop;
9866 c = (char*)POPPTR(ss,ix);
9867 TOPPTR(nss,ix) = pv_dup_inc(c);
9870 longval = POPLONG(ss,ix);
9871 TOPLONG(nss,ix) = longval;
9874 hv = (HV*)POPPTR(ss,ix);
9875 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9876 c = (char*)POPPTR(ss,ix);
9877 TOPPTR(nss,ix) = pv_dup_inc(c);
9881 case SAVEt_DESTRUCTOR:
9882 ptr = POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9884 dptr = POPDPTR(ss,ix);
9885 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9886 any_dup(FPTR2DPTR(void *, dptr),
9889 case SAVEt_DESTRUCTOR_X:
9890 ptr = POPPTR(ss,ix);
9891 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9892 dxptr = POPDXPTR(ss,ix);
9893 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9894 any_dup(FPTR2DPTR(void *, dxptr),
9897 case SAVEt_REGCONTEXT:
9903 case SAVEt_STACK_POS: /* Position on Perl stack */
9907 case SAVEt_AELEM: /* array element */
9908 sv = (SV*)POPPTR(ss,ix);
9909 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9912 av = (AV*)POPPTR(ss,ix);
9913 TOPPTR(nss,ix) = av_dup_inc(av, param);
9915 case SAVEt_HELEM: /* hash element */
9916 sv = (SV*)POPPTR(ss,ix);
9917 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9918 sv = (SV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9920 hv = (HV*)POPPTR(ss,ix);
9921 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9924 ptr = POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = ptr;
9932 av = (AV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = av_dup(av, param);
9936 longval = (long)POPLONG(ss,ix);
9937 TOPLONG(nss,ix) = longval;
9938 ptr = POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9940 sv = (SV*)POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = sv_dup(sv, param);
9944 ptr = POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 longval = (long)POPBOOL(ss,ix);
9947 TOPBOOL(nss,ix) = (bool)longval;
9949 case SAVEt_SET_SVFLAGS:
9954 sv = (SV*)POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = sv_dup(sv, param);
9958 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9966 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9967 * flag to the result. This is done for each stash before cloning starts,
9968 * so we know which stashes want their objects cloned */
9971 do_mark_cloneable_stash(pTHX_ SV *sv)
9973 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9975 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9976 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9977 if (cloner && GvCV(cloner)) {
9984 XPUSHs(sv_2mortal(newSVhek(hvname)));
9986 call_sv((SV*)GvCV(cloner), G_SCALAR);
9993 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10001 =for apidoc perl_clone
10003 Create and return a new interpreter by cloning the current one.
10005 perl_clone takes these flags as parameters:
10007 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10008 without it we only clone the data and zero the stacks,
10009 with it we copy the stacks and the new perl interpreter is
10010 ready to run at the exact same point as the previous one.
10011 The pseudo-fork code uses COPY_STACKS while the
10012 threads->new doesn't.
10014 CLONEf_KEEP_PTR_TABLE
10015 perl_clone keeps a ptr_table with the pointer of the old
10016 variable as a key and the new variable as a value,
10017 this allows it to check if something has been cloned and not
10018 clone it again but rather just use the value and increase the
10019 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10020 the ptr_table using the function
10021 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10022 reason to keep it around is if you want to dup some of your own
10023 variable who are outside the graph perl scans, example of this
10024 code is in threads.xs create
10027 This is a win32 thing, it is ignored on unix, it tells perls
10028 win32host code (which is c++) to clone itself, this is needed on
10029 win32 if you want to run two threads at the same time,
10030 if you just want to do some stuff in a separate perl interpreter
10031 and then throw it away and return to the original one,
10032 you don't need to do anything.
10037 /* XXX the above needs expanding by someone who actually understands it ! */
10038 EXTERN_C PerlInterpreter *
10039 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10042 perl_clone(PerlInterpreter *proto_perl, UV flags)
10045 #ifdef PERL_IMPLICIT_SYS
10047 /* perlhost.h so we need to call into it
10048 to clone the host, CPerlHost should have a c interface, sky */
10050 if (flags & CLONEf_CLONE_HOST) {
10051 return perl_clone_host(proto_perl,flags);
10053 return perl_clone_using(proto_perl, flags,
10055 proto_perl->IMemShared,
10056 proto_perl->IMemParse,
10058 proto_perl->IStdIO,
10062 proto_perl->IProc);
10066 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10067 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10068 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10069 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10070 struct IPerlDir* ipD, struct IPerlSock* ipS,
10071 struct IPerlProc* ipP)
10073 /* XXX many of the string copies here can be optimized if they're
10074 * constants; they need to be allocated as common memory and just
10075 * their pointers copied. */
10078 CLONE_PARAMS clone_params;
10079 CLONE_PARAMS* param = &clone_params;
10081 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10082 /* for each stash, determine whether its objects should be cloned */
10083 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10084 PERL_SET_THX(my_perl);
10087 Poison(my_perl, 1, PerlInterpreter);
10089 PL_curcop = (COP *)Nullop;
10093 PL_savestack_ix = 0;
10094 PL_savestack_max = -1;
10095 PL_sig_pending = 0;
10096 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10097 # else /* !DEBUGGING */
10098 Zero(my_perl, 1, PerlInterpreter);
10099 # endif /* DEBUGGING */
10101 /* host pointers */
10103 PL_MemShared = ipMS;
10104 PL_MemParse = ipMP;
10111 #else /* !PERL_IMPLICIT_SYS */
10113 CLONE_PARAMS clone_params;
10114 CLONE_PARAMS* param = &clone_params;
10115 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10116 /* for each stash, determine whether its objects should be cloned */
10117 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10118 PERL_SET_THX(my_perl);
10121 Poison(my_perl, 1, PerlInterpreter);
10123 PL_curcop = (COP *)Nullop;
10127 PL_savestack_ix = 0;
10128 PL_savestack_max = -1;
10129 PL_sig_pending = 0;
10130 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10131 # else /* !DEBUGGING */
10132 Zero(my_perl, 1, PerlInterpreter);
10133 # endif /* DEBUGGING */
10134 #endif /* PERL_IMPLICIT_SYS */
10135 param->flags = flags;
10136 param->proto_perl = proto_perl;
10138 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10139 Zero(&PL_body_roots, 1, PL_body_roots);
10141 PL_nice_chunk = NULL;
10142 PL_nice_chunk_size = 0;
10144 PL_sv_objcount = 0;
10145 PL_sv_root = Nullsv;
10146 PL_sv_arenaroot = Nullsv;
10148 PL_debug = proto_perl->Idebug;
10150 PL_hash_seed = proto_perl->Ihash_seed;
10151 PL_rehash_seed = proto_perl->Irehash_seed;
10153 #ifdef USE_REENTRANT_API
10154 /* XXX: things like -Dm will segfault here in perlio, but doing
10155 * PERL_SET_CONTEXT(proto_perl);
10156 * breaks too many other things
10158 Perl_reentrant_init(aTHX);
10161 /* create SV map for pointer relocation */
10162 PL_ptr_table = ptr_table_new();
10164 /* initialize these special pointers as early as possible */
10165 SvANY(&PL_sv_undef) = NULL;
10166 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10167 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10168 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10170 SvANY(&PL_sv_no) = new_XPVNV();
10171 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10172 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10173 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10174 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10175 SvCUR_set(&PL_sv_no, 0);
10176 SvLEN_set(&PL_sv_no, 1);
10177 SvIV_set(&PL_sv_no, 0);
10178 SvNV_set(&PL_sv_no, 0);
10179 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10181 SvANY(&PL_sv_yes) = new_XPVNV();
10182 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10183 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10184 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10185 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10186 SvCUR_set(&PL_sv_yes, 1);
10187 SvLEN_set(&PL_sv_yes, 2);
10188 SvIV_set(&PL_sv_yes, 1);
10189 SvNV_set(&PL_sv_yes, 1);
10190 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10192 /* create (a non-shared!) shared string table */
10193 PL_strtab = newHV();
10194 HvSHAREKEYS_off(PL_strtab);
10195 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10196 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10198 PL_compiling = proto_perl->Icompiling;
10200 /* These two PVs will be free'd special way so must set them same way op.c does */
10201 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10202 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10204 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10205 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10207 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10208 if (!specialWARN(PL_compiling.cop_warnings))
10209 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10210 if (!specialCopIO(PL_compiling.cop_io))
10211 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10212 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10214 /* pseudo environmental stuff */
10215 PL_origargc = proto_perl->Iorigargc;
10216 PL_origargv = proto_perl->Iorigargv;
10218 param->stashes = newAV(); /* Setup array of objects to call clone on */
10220 /* Set tainting stuff before PerlIO_debug can possibly get called */
10221 PL_tainting = proto_perl->Itainting;
10222 PL_taint_warn = proto_perl->Itaint_warn;
10224 #ifdef PERLIO_LAYERS
10225 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10226 PerlIO_clone(aTHX_ proto_perl, param);
10229 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10230 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10231 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10232 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10233 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10234 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10237 PL_minus_c = proto_perl->Iminus_c;
10238 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10239 PL_localpatches = proto_perl->Ilocalpatches;
10240 PL_splitstr = proto_perl->Isplitstr;
10241 PL_preprocess = proto_perl->Ipreprocess;
10242 PL_minus_n = proto_perl->Iminus_n;
10243 PL_minus_p = proto_perl->Iminus_p;
10244 PL_minus_l = proto_perl->Iminus_l;
10245 PL_minus_a = proto_perl->Iminus_a;
10246 PL_minus_F = proto_perl->Iminus_F;
10247 PL_doswitches = proto_perl->Idoswitches;
10248 PL_dowarn = proto_perl->Idowarn;
10249 PL_doextract = proto_perl->Idoextract;
10250 PL_sawampersand = proto_perl->Isawampersand;
10251 PL_unsafe = proto_perl->Iunsafe;
10252 PL_inplace = SAVEPV(proto_perl->Iinplace);
10253 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10254 PL_perldb = proto_perl->Iperldb;
10255 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10256 PL_exit_flags = proto_perl->Iexit_flags;
10258 /* magical thingies */
10259 /* XXX time(&PL_basetime) when asked for? */
10260 PL_basetime = proto_perl->Ibasetime;
10261 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10263 PL_maxsysfd = proto_perl->Imaxsysfd;
10264 PL_multiline = proto_perl->Imultiline;
10265 PL_statusvalue = proto_perl->Istatusvalue;
10267 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10269 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10271 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10273 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10274 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10275 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10277 /* Clone the regex array */
10278 PL_regex_padav = newAV();
10280 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10281 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10283 av_push(PL_regex_padav,
10284 sv_dup_inc(regexen[0],param));
10285 for(i = 1; i <= len; i++) {
10286 if(SvREPADTMP(regexen[i])) {
10287 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10289 av_push(PL_regex_padav,
10291 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10292 SvIVX(regexen[i])), param)))
10297 PL_regex_pad = AvARRAY(PL_regex_padav);
10299 /* shortcuts to various I/O objects */
10300 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10301 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10302 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10303 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10304 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10305 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10307 /* shortcuts to regexp stuff */
10308 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10310 /* shortcuts to misc objects */
10311 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10313 /* shortcuts to debugging objects */
10314 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10315 PL_DBline = gv_dup(proto_perl->IDBline, param);
10316 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10317 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10318 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10319 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10320 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10321 PL_lineary = av_dup(proto_perl->Ilineary, param);
10322 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10324 /* symbol tables */
10325 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10326 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10327 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10328 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10329 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10331 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10332 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10333 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10334 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10335 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10336 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10338 PL_sub_generation = proto_perl->Isub_generation;
10340 /* funky return mechanisms */
10341 PL_forkprocess = proto_perl->Iforkprocess;
10343 /* subprocess state */
10344 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10346 /* internal state */
10347 PL_maxo = proto_perl->Imaxo;
10348 if (proto_perl->Iop_mask)
10349 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10351 PL_op_mask = Nullch;
10352 /* PL_asserting = proto_perl->Iasserting; */
10354 /* current interpreter roots */
10355 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10356 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10357 PL_main_start = proto_perl->Imain_start;
10358 PL_eval_root = proto_perl->Ieval_root;
10359 PL_eval_start = proto_perl->Ieval_start;
10361 /* runtime control stuff */
10362 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10363 PL_copline = proto_perl->Icopline;
10365 PL_filemode = proto_perl->Ifilemode;
10366 PL_lastfd = proto_perl->Ilastfd;
10367 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10370 PL_gensym = proto_perl->Igensym;
10371 PL_preambled = proto_perl->Ipreambled;
10372 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10373 PL_laststatval = proto_perl->Ilaststatval;
10374 PL_laststype = proto_perl->Ilaststype;
10375 PL_mess_sv = Nullsv;
10377 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10379 /* interpreter atexit processing */
10380 PL_exitlistlen = proto_perl->Iexitlistlen;
10381 if (PL_exitlistlen) {
10382 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10383 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10386 PL_exitlist = (PerlExitListEntry*)NULL;
10387 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10388 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10389 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10391 PL_profiledata = NULL;
10392 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10393 /* PL_rsfp_filters entries have fake IoDIRP() */
10394 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10396 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10398 PAD_CLONE_VARS(proto_perl, param);
10400 #ifdef HAVE_INTERP_INTERN
10401 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10404 /* more statics moved here */
10405 PL_generation = proto_perl->Igeneration;
10406 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10408 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10409 PL_in_clean_all = proto_perl->Iin_clean_all;
10411 PL_uid = proto_perl->Iuid;
10412 PL_euid = proto_perl->Ieuid;
10413 PL_gid = proto_perl->Igid;
10414 PL_egid = proto_perl->Iegid;
10415 PL_nomemok = proto_perl->Inomemok;
10416 PL_an = proto_perl->Ian;
10417 PL_evalseq = proto_perl->Ievalseq;
10418 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10419 PL_origalen = proto_perl->Iorigalen;
10420 #ifdef PERL_USES_PL_PIDSTATUS
10421 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10423 PL_osname = SAVEPV(proto_perl->Iosname);
10424 PL_sighandlerp = proto_perl->Isighandlerp;
10426 PL_runops = proto_perl->Irunops;
10428 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10431 PL_cshlen = proto_perl->Icshlen;
10432 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10435 PL_lex_state = proto_perl->Ilex_state;
10436 PL_lex_defer = proto_perl->Ilex_defer;
10437 PL_lex_expect = proto_perl->Ilex_expect;
10438 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10439 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10440 PL_lex_starts = proto_perl->Ilex_starts;
10441 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10442 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10443 PL_lex_op = proto_perl->Ilex_op;
10444 PL_lex_inpat = proto_perl->Ilex_inpat;
10445 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10446 PL_lex_brackets = proto_perl->Ilex_brackets;
10447 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10448 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10449 PL_lex_casemods = proto_perl->Ilex_casemods;
10450 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10451 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10453 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10454 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10455 PL_nexttoke = proto_perl->Inexttoke;
10457 /* XXX This is probably masking the deeper issue of why
10458 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10459 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10460 * (A little debugging with a watchpoint on it may help.)
10462 if (SvANY(proto_perl->Ilinestr)) {
10463 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10464 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10465 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10466 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10467 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10468 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10469 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10470 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10471 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10474 PL_linestr = NEWSV(65,79);
10475 sv_upgrade(PL_linestr,SVt_PVIV);
10476 sv_setpvn(PL_linestr,"",0);
10477 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10479 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10480 PL_pending_ident = proto_perl->Ipending_ident;
10481 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10483 PL_expect = proto_perl->Iexpect;
10485 PL_multi_start = proto_perl->Imulti_start;
10486 PL_multi_end = proto_perl->Imulti_end;
10487 PL_multi_open = proto_perl->Imulti_open;
10488 PL_multi_close = proto_perl->Imulti_close;
10490 PL_error_count = proto_perl->Ierror_count;
10491 PL_subline = proto_perl->Isubline;
10492 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10494 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10495 if (SvANY(proto_perl->Ilinestr)) {
10496 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10497 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10498 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10499 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10500 PL_last_lop_op = proto_perl->Ilast_lop_op;
10503 PL_last_uni = SvPVX(PL_linestr);
10504 PL_last_lop = SvPVX(PL_linestr);
10505 PL_last_lop_op = 0;
10507 PL_in_my = proto_perl->Iin_my;
10508 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10510 PL_cryptseen = proto_perl->Icryptseen;
10513 PL_hints = proto_perl->Ihints;
10515 PL_amagic_generation = proto_perl->Iamagic_generation;
10517 #ifdef USE_LOCALE_COLLATE
10518 PL_collation_ix = proto_perl->Icollation_ix;
10519 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10520 PL_collation_standard = proto_perl->Icollation_standard;
10521 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10522 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10523 #endif /* USE_LOCALE_COLLATE */
10525 #ifdef USE_LOCALE_NUMERIC
10526 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10527 PL_numeric_standard = proto_perl->Inumeric_standard;
10528 PL_numeric_local = proto_perl->Inumeric_local;
10529 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10530 #endif /* !USE_LOCALE_NUMERIC */
10532 /* utf8 character classes */
10533 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10534 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10535 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10536 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10537 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10538 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10539 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10540 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10541 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10542 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10543 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10544 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10545 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10546 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10547 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10548 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10549 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10550 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10551 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10552 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10554 /* Did the locale setup indicate UTF-8? */
10555 PL_utf8locale = proto_perl->Iutf8locale;
10556 /* Unicode features (see perlrun/-C) */
10557 PL_unicode = proto_perl->Iunicode;
10559 /* Pre-5.8 signals control */
10560 PL_signals = proto_perl->Isignals;
10562 /* times() ticks per second */
10563 PL_clocktick = proto_perl->Iclocktick;
10565 /* Recursion stopper for PerlIO_find_layer */
10566 PL_in_load_module = proto_perl->Iin_load_module;
10568 /* sort() routine */
10569 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10571 /* Not really needed/useful since the reenrant_retint is "volatile",
10572 * but do it for consistency's sake. */
10573 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10575 /* Hooks to shared SVs and locks. */
10576 PL_sharehook = proto_perl->Isharehook;
10577 PL_lockhook = proto_perl->Ilockhook;
10578 PL_unlockhook = proto_perl->Iunlockhook;
10579 PL_threadhook = proto_perl->Ithreadhook;
10581 PL_runops_std = proto_perl->Irunops_std;
10582 PL_runops_dbg = proto_perl->Irunops_dbg;
10584 #ifdef THREADS_HAVE_PIDS
10585 PL_ppid = proto_perl->Ippid;
10589 PL_last_swash_hv = Nullhv; /* reinits on demand */
10590 PL_last_swash_klen = 0;
10591 PL_last_swash_key[0]= '\0';
10592 PL_last_swash_tmps = (U8*)NULL;
10593 PL_last_swash_slen = 0;
10595 PL_glob_index = proto_perl->Iglob_index;
10596 PL_srand_called = proto_perl->Isrand_called;
10597 PL_uudmap['M'] = 0; /* reinits on demand */
10598 PL_bitcount = Nullch; /* reinits on demand */
10600 if (proto_perl->Ipsig_pend) {
10601 Newxz(PL_psig_pend, SIG_SIZE, int);
10604 PL_psig_pend = (int*)NULL;
10607 if (proto_perl->Ipsig_ptr) {
10608 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10609 Newxz(PL_psig_name, SIG_SIZE, SV*);
10610 for (i = 1; i < SIG_SIZE; i++) {
10611 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10612 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10616 PL_psig_ptr = (SV**)NULL;
10617 PL_psig_name = (SV**)NULL;
10620 /* thrdvar.h stuff */
10622 if (flags & CLONEf_COPY_STACKS) {
10623 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10624 PL_tmps_ix = proto_perl->Ttmps_ix;
10625 PL_tmps_max = proto_perl->Ttmps_max;
10626 PL_tmps_floor = proto_perl->Ttmps_floor;
10627 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10629 while (i <= PL_tmps_ix) {
10630 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10634 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10635 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10636 Newxz(PL_markstack, i, I32);
10637 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10638 - proto_perl->Tmarkstack);
10639 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10640 - proto_perl->Tmarkstack);
10641 Copy(proto_perl->Tmarkstack, PL_markstack,
10642 PL_markstack_ptr - PL_markstack + 1, I32);
10644 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10645 * NOTE: unlike the others! */
10646 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10647 PL_scopestack_max = proto_perl->Tscopestack_max;
10648 Newxz(PL_scopestack, PL_scopestack_max, I32);
10649 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10651 /* NOTE: si_dup() looks at PL_markstack */
10652 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10654 /* PL_curstack = PL_curstackinfo->si_stack; */
10655 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10656 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10658 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10659 PL_stack_base = AvARRAY(PL_curstack);
10660 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10661 - proto_perl->Tstack_base);
10662 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10664 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10665 * NOTE: unlike the others! */
10666 PL_savestack_ix = proto_perl->Tsavestack_ix;
10667 PL_savestack_max = proto_perl->Tsavestack_max;
10668 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10669 PL_savestack = ss_dup(proto_perl, param);
10673 ENTER; /* perl_destruct() wants to LEAVE; */
10676 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10677 PL_top_env = &PL_start_env;
10679 PL_op = proto_perl->Top;
10682 PL_Xpv = (XPV*)NULL;
10683 PL_na = proto_perl->Tna;
10685 PL_statbuf = proto_perl->Tstatbuf;
10686 PL_statcache = proto_perl->Tstatcache;
10687 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10688 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10690 PL_timesbuf = proto_perl->Ttimesbuf;
10693 PL_tainted = proto_perl->Ttainted;
10694 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10695 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10696 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10697 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10698 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10699 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10700 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10701 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10702 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10704 PL_restartop = proto_perl->Trestartop;
10705 PL_in_eval = proto_perl->Tin_eval;
10706 PL_delaymagic = proto_perl->Tdelaymagic;
10707 PL_dirty = proto_perl->Tdirty;
10708 PL_localizing = proto_perl->Tlocalizing;
10710 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10711 PL_hv_fetch_ent_mh = Nullhe;
10712 PL_modcount = proto_perl->Tmodcount;
10713 PL_lastgotoprobe = Nullop;
10714 PL_dumpindent = proto_perl->Tdumpindent;
10716 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10717 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10718 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10719 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10720 PL_efloatbuf = Nullch; /* reinits on demand */
10721 PL_efloatsize = 0; /* reinits on demand */
10725 PL_screamfirst = NULL;
10726 PL_screamnext = NULL;
10727 PL_maxscream = -1; /* reinits on demand */
10728 PL_lastscream = Nullsv;
10730 PL_watchaddr = NULL;
10731 PL_watchok = Nullch;
10733 PL_regdummy = proto_perl->Tregdummy;
10734 PL_regprecomp = Nullch;
10737 PL_colorset = 0; /* reinits PL_colors[] */
10738 /*PL_colors[6] = {0,0,0,0,0,0};*/
10739 PL_reginput = Nullch;
10740 PL_regbol = Nullch;
10741 PL_regeol = Nullch;
10742 PL_regstartp = (I32*)NULL;
10743 PL_regendp = (I32*)NULL;
10744 PL_reglastparen = (U32*)NULL;
10745 PL_reglastcloseparen = (U32*)NULL;
10746 PL_regtill = Nullch;
10747 PL_reg_start_tmp = (char**)NULL;
10748 PL_reg_start_tmpl = 0;
10749 PL_regdata = (struct reg_data*)NULL;
10752 PL_reg_eval_set = 0;
10754 PL_regprogram = (regnode*)NULL;
10756 PL_regcc = (CURCUR*)NULL;
10757 PL_reg_call_cc = (struct re_cc_state*)NULL;
10758 PL_reg_re = (regexp*)NULL;
10759 PL_reg_ganch = Nullch;
10760 PL_reg_sv = Nullsv;
10761 PL_reg_match_utf8 = FALSE;
10762 PL_reg_magic = (MAGIC*)NULL;
10764 PL_reg_oldcurpm = (PMOP*)NULL;
10765 PL_reg_curpm = (PMOP*)NULL;
10766 PL_reg_oldsaved = Nullch;
10767 PL_reg_oldsavedlen = 0;
10768 #ifdef PERL_OLD_COPY_ON_WRITE
10771 PL_reg_maxiter = 0;
10772 PL_reg_leftiter = 0;
10773 PL_reg_poscache = Nullch;
10774 PL_reg_poscache_size= 0;
10776 /* RE engine - function pointers */
10777 PL_regcompp = proto_perl->Tregcompp;
10778 PL_regexecp = proto_perl->Tregexecp;
10779 PL_regint_start = proto_perl->Tregint_start;
10780 PL_regint_string = proto_perl->Tregint_string;
10781 PL_regfree = proto_perl->Tregfree;
10783 PL_reginterp_cnt = 0;
10784 PL_reg_starttry = 0;
10786 /* Pluggable optimizer */
10787 PL_peepp = proto_perl->Tpeepp;
10789 PL_stashcache = newHV();
10791 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10792 ptr_table_free(PL_ptr_table);
10793 PL_ptr_table = NULL;
10796 /* Call the ->CLONE method, if it exists, for each of the stashes
10797 identified by sv_dup() above.
10799 while(av_len(param->stashes) != -1) {
10800 HV* const stash = (HV*) av_shift(param->stashes);
10801 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10802 if (cloner && GvCV(cloner)) {
10807 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10809 call_sv((SV*)GvCV(cloner), G_DISCARD);
10815 SvREFCNT_dec(param->stashes);
10817 /* orphaned? eg threads->new inside BEGIN or use */
10818 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10819 (void)SvREFCNT_inc(PL_compcv);
10820 SAVEFREESV(PL_compcv);
10826 #endif /* USE_ITHREADS */
10829 =head1 Unicode Support
10831 =for apidoc sv_recode_to_utf8
10833 The encoding is assumed to be an Encode object, on entry the PV
10834 of the sv is assumed to be octets in that encoding, and the sv
10835 will be converted into Unicode (and UTF-8).
10837 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10838 is not a reference, nothing is done to the sv. If the encoding is not
10839 an C<Encode::XS> Encoding object, bad things will happen.
10840 (See F<lib/encoding.pm> and L<Encode>).
10842 The PV of the sv is returned.
10847 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10850 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10864 Passing sv_yes is wrong - it needs to be or'ed set of constants
10865 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10866 remove converted chars from source.
10868 Both will default the value - let them.
10870 XPUSHs(&PL_sv_yes);
10873 call_method("decode", G_SCALAR);
10877 s = SvPV_const(uni, len);
10878 if (s != SvPVX_const(sv)) {
10879 SvGROW(sv, len + 1);
10880 Move(s, SvPVX(sv), len + 1, char);
10881 SvCUR_set(sv, len);
10888 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10892 =for apidoc sv_cat_decode
10894 The encoding is assumed to be an Encode object, the PV of the ssv is
10895 assumed to be octets in that encoding and decoding the input starts
10896 from the position which (PV + *offset) pointed to. The dsv will be
10897 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10898 when the string tstr appears in decoding output or the input ends on
10899 the PV of the ssv. The value which the offset points will be modified
10900 to the last input position on the ssv.
10902 Returns TRUE if the terminator was found, else returns FALSE.
10907 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10908 SV *ssv, int *offset, char *tstr, int tlen)
10912 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10923 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10924 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10926 call_method("cat_decode", G_SCALAR);
10928 ret = SvTRUE(TOPs);
10929 *offset = SvIV(offsv);
10935 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10940 /* ---------------------------------------------------------------------
10942 * support functions for report_uninit()
10945 /* the maxiumum size of array or hash where we will scan looking
10946 * for the undefined element that triggered the warning */
10948 #define FUV_MAX_SEARCH_SIZE 1000
10950 /* Look for an entry in the hash whose value has the same SV as val;
10951 * If so, return a mortal copy of the key. */
10954 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10957 register HE **array;
10960 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10961 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10964 array = HvARRAY(hv);
10966 for (i=HvMAX(hv); i>0; i--) {
10967 register HE *entry;
10968 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10969 if (HeVAL(entry) != val)
10971 if ( HeVAL(entry) == &PL_sv_undef ||
10972 HeVAL(entry) == &PL_sv_placeholder)
10976 if (HeKLEN(entry) == HEf_SVKEY)
10977 return sv_mortalcopy(HeKEY_sv(entry));
10978 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10984 /* Look for an entry in the array whose value has the same SV as val;
10985 * If so, return the index, otherwise return -1. */
10988 S_find_array_subscript(pTHX_ AV *av, SV* val)
10992 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
10993 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
10997 for (i=AvFILLp(av); i>=0; i--) {
10998 if (svp[i] == val && svp[i] != &PL_sv_undef)
11004 /* S_varname(): return the name of a variable, optionally with a subscript.
11005 * If gv is non-zero, use the name of that global, along with gvtype (one
11006 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11007 * targ. Depending on the value of the subscript_type flag, return:
11010 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11011 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11012 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11013 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11016 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11017 SV* keyname, I32 aindex, int subscript_type)
11020 SV * const name = sv_newmortal();
11023 buffer[0] = gvtype;
11026 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11028 gv_fullname4(name, gv, buffer, 0);
11030 if ((unsigned int)SvPVX(name)[1] <= 26) {
11032 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11034 /* Swap the 1 unprintable control character for the 2 byte pretty
11035 version - ie substr($name, 1, 1) = $buffer; */
11036 sv_insert(name, 1, 1, buffer, 2);
11041 CV * const cv = find_runcv(&unused);
11045 if (!cv || !CvPADLIST(cv))
11047 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11048 sv = *av_fetch(av, targ, FALSE);
11049 /* SvLEN in a pad name is not to be trusted */
11050 sv_setpv(name, SvPV_nolen_const(sv));
11053 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11054 SV * const sv = NEWSV(0,0);
11055 *SvPVX(name) = '$';
11056 Perl_sv_catpvf(aTHX_ name, "{%s}",
11057 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11060 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11061 *SvPVX(name) = '$';
11062 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11064 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11065 sv_insert(name, 0, 0, "within ", 7);
11072 =for apidoc find_uninit_var
11074 Find the name of the undefined variable (if any) that caused the operator o
11075 to issue a "Use of uninitialized value" warning.
11076 If match is true, only return a name if it's value matches uninit_sv.
11077 So roughly speaking, if a unary operator (such as OP_COS) generates a
11078 warning, then following the direct child of the op may yield an
11079 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11080 other hand, with OP_ADD there are two branches to follow, so we only print
11081 the variable name if we get an exact match.
11083 The name is returned as a mortal SV.
11085 Assumes that PL_op is the op that originally triggered the error, and that
11086 PL_comppad/PL_curpad points to the currently executing pad.
11092 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11100 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11101 uninit_sv == &PL_sv_placeholder)))
11104 switch (obase->op_type) {
11111 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11112 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11114 SV *keysv = Nullsv;
11115 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11117 if (pad) { /* @lex, %lex */
11118 sv = PAD_SVl(obase->op_targ);
11122 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11123 /* @global, %global */
11124 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11127 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11129 else /* @{expr}, %{expr} */
11130 return find_uninit_var(cUNOPx(obase)->op_first,
11134 /* attempt to find a match within the aggregate */
11136 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11138 subscript_type = FUV_SUBSCRIPT_HASH;
11141 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11143 subscript_type = FUV_SUBSCRIPT_ARRAY;
11146 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11149 return varname(gv, hash ? '%' : '@', obase->op_targ,
11150 keysv, index, subscript_type);
11154 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11156 return varname(Nullgv, '$', obase->op_targ,
11157 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11160 gv = cGVOPx_gv(obase);
11161 if (!gv || (match && GvSV(gv) != uninit_sv))
11163 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11166 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11169 av = (AV*)PAD_SV(obase->op_targ);
11170 if (!av || SvRMAGICAL(av))
11172 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11173 if (!svp || *svp != uninit_sv)
11176 return varname(Nullgv, '$', obase->op_targ,
11177 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11180 gv = cGVOPx_gv(obase);
11186 if (!av || SvRMAGICAL(av))
11188 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11189 if (!svp || *svp != uninit_sv)
11192 return varname(gv, '$', 0,
11193 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11198 o = cUNOPx(obase)->op_first;
11199 if (!o || o->op_type != OP_NULL ||
11200 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11202 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11206 if (PL_op == obase)
11207 /* $a[uninit_expr] or $h{uninit_expr} */
11208 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11211 o = cBINOPx(obase)->op_first;
11212 kid = cBINOPx(obase)->op_last;
11214 /* get the av or hv, and optionally the gv */
11216 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11217 sv = PAD_SV(o->op_targ);
11219 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11220 && cUNOPo->op_first->op_type == OP_GV)
11222 gv = cGVOPx_gv(cUNOPo->op_first);
11225 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11230 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11231 /* index is constant */
11235 if (obase->op_type == OP_HELEM) {
11236 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11237 if (!he || HeVAL(he) != uninit_sv)
11241 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11242 if (!svp || *svp != uninit_sv)
11246 if (obase->op_type == OP_HELEM)
11247 return varname(gv, '%', o->op_targ,
11248 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11250 return varname(gv, '@', o->op_targ, Nullsv,
11251 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11254 /* index is an expression;
11255 * attempt to find a match within the aggregate */
11256 if (obase->op_type == OP_HELEM) {
11257 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11259 return varname(gv, '%', o->op_targ,
11260 keysv, 0, FUV_SUBSCRIPT_HASH);
11263 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11265 return varname(gv, '@', o->op_targ,
11266 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11271 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11273 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11279 /* only examine RHS */
11280 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11283 o = cUNOPx(obase)->op_first;
11284 if (o->op_type == OP_PUSHMARK)
11287 if (!o->op_sibling) {
11288 /* one-arg version of open is highly magical */
11290 if (o->op_type == OP_GV) { /* open FOO; */
11292 if (match && GvSV(gv) != uninit_sv)
11294 return varname(gv, '$', 0,
11295 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11297 /* other possibilities not handled are:
11298 * open $x; or open my $x; should return '${*$x}'
11299 * open expr; should return '$'.expr ideally
11305 /* ops where $_ may be an implicit arg */
11309 if ( !(obase->op_flags & OPf_STACKED)) {
11310 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11311 ? PAD_SVl(obase->op_targ)
11314 sv = sv_newmortal();
11315 sv_setpvn(sv, "$_", 2);
11323 /* skip filehandle as it can't produce 'undef' warning */
11324 o = cUNOPx(obase)->op_first;
11325 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11326 o = o->op_sibling->op_sibling;
11333 match = 1; /* XS or custom code could trigger random warnings */
11338 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11339 return sv_2mortal(newSVpvn("${$/}", 5));
11344 if (!(obase->op_flags & OPf_KIDS))
11346 o = cUNOPx(obase)->op_first;
11352 /* if all except one arg are constant, or have no side-effects,
11353 * or are optimized away, then it's unambiguous */
11355 for (kid=o; kid; kid = kid->op_sibling) {
11357 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11358 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11359 || (kid->op_type == OP_PUSHMARK)
11363 if (o2) { /* more than one found */
11370 return find_uninit_var(o2, uninit_sv, match);
11372 /* scan all args */
11374 sv = find_uninit_var(o, uninit_sv, 1);
11386 =for apidoc report_uninit
11388 Print appropriate "Use of uninitialized variable" warning
11394 Perl_report_uninit(pTHX_ SV* uninit_sv)
11397 SV* varname = Nullsv;
11399 varname = find_uninit_var(PL_op, uninit_sv,0);
11401 sv_insert(varname, 0, 0, " ", 1);
11403 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11404 varname ? SvPV_nolen_const(varname) : "",
11405 " in ", OP_DESC(PL_op));
11408 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11414 * c-indentation-style: bsd
11415 * c-basic-offset: 4
11416 * indent-tabs-mode: t
11419 * ex: set ts=8 sts=4 sw=4 noet: