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_allocated, XPV, xpv_cur),
813 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
819 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
835 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
841 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s = SvPVX_const(sv);
1417 const char * const end = s + SvCUR(sv);
1418 for ( ; s < end && d < limit; s++ ) {
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 S_sv_2iuv_common(pTHX_ SV *sv) {
1631 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1632 * without also getting a cached IV/UV from it at the same time
1633 * (ie PV->NV conversion should detect loss of accuracy and cache
1634 * IV or UV at same time to avoid this. */
1635 /* IV-over-UV optimisation - choose to cache IV if possible */
1637 if (SvTYPE(sv) == SVt_NV)
1638 sv_upgrade(sv, SVt_PVNV);
1640 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1641 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1642 certainly cast into the IV range at IV_MAX, whereas the correct
1643 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1645 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1646 SvIV_set(sv, I_V(SvNVX(sv)));
1647 if (SvNVX(sv) == (NV) SvIVX(sv)
1648 #ifndef NV_PRESERVES_UV
1649 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1650 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1651 /* Don't flag it as "accurately an integer" if the number
1652 came from a (by definition imprecise) NV operation, and
1653 we're outside the range of NV integer precision */
1656 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1657 DEBUG_c(PerlIO_printf(Perl_debug_log,
1658 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1664 /* IV not precise. No need to convert from PV, as NV
1665 conversion would already have cached IV if it detected
1666 that PV->IV would be better than PV->NV->IV
1667 flags already correct - don't set public IOK. */
1668 DEBUG_c(PerlIO_printf(Perl_debug_log,
1669 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1674 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1675 but the cast (NV)IV_MIN rounds to a the value less (more
1676 negative) than IV_MIN which happens to be equal to SvNVX ??
1677 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1678 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1679 (NV)UVX == NVX are both true, but the values differ. :-(
1680 Hopefully for 2s complement IV_MIN is something like
1681 0x8000000000000000 which will be exact. NWC */
1684 SvUV_set(sv, U_V(SvNVX(sv)));
1686 (SvNVX(sv) == (NV) SvUVX(sv))
1687 #ifndef NV_PRESERVES_UV
1688 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1689 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1690 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1691 /* Don't flag it as "accurately an integer" if the number
1692 came from a (by definition imprecise) NV operation, and
1693 we're outside the range of NV integer precision */
1698 DEBUG_c(PerlIO_printf(Perl_debug_log,
1699 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1705 else if (SvPOKp(sv) && SvLEN(sv)) {
1707 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1708 /* We want to avoid a possible problem when we cache an IV/ a UV which
1709 may be later translated to an NV, and the resulting NV is not
1710 the same as the direct translation of the initial string
1711 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1712 be careful to ensure that the value with the .456 is around if the
1713 NV value is requested in the future).
1715 This means that if we cache such an IV/a UV, we need to cache the
1716 NV as well. Moreover, we trade speed for space, and do not
1717 cache the NV if we are sure it's not needed.
1720 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1721 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1722 == IS_NUMBER_IN_UV) {
1723 /* It's definitely an integer, only upgrade to PVIV */
1724 if (SvTYPE(sv) < SVt_PVIV)
1725 sv_upgrade(sv, SVt_PVIV);
1727 } else if (SvTYPE(sv) < SVt_PVNV)
1728 sv_upgrade(sv, SVt_PVNV);
1730 /* If NV preserves UV then we only use the UV value if we know that
1731 we aren't going to call atof() below. If NVs don't preserve UVs
1732 then the value returned may have more precision than atof() will
1733 return, even though value isn't perfectly accurate. */
1734 if ((numtype & (IS_NUMBER_IN_UV
1735 #ifdef NV_PRESERVES_UV
1738 )) == IS_NUMBER_IN_UV) {
1739 /* This won't turn off the public IOK flag if it was set above */
1740 (void)SvIOKp_on(sv);
1742 if (!(numtype & IS_NUMBER_NEG)) {
1744 if (value <= (UV)IV_MAX) {
1745 SvIV_set(sv, (IV)value);
1747 /* it didn't overflow, and it was positive. */
1748 SvUV_set(sv, value);
1752 /* 2s complement assumption */
1753 if (value <= (UV)IV_MIN) {
1754 SvIV_set(sv, -(IV)value);
1756 /* Too negative for an IV. This is a double upgrade, but
1757 I'm assuming it will be rare. */
1758 if (SvTYPE(sv) < SVt_PVNV)
1759 sv_upgrade(sv, SVt_PVNV);
1763 SvNV_set(sv, -(NV)value);
1764 SvIV_set(sv, IV_MIN);
1768 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1769 will be in the previous block to set the IV slot, and the next
1770 block to set the NV slot. So no else here. */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 != IS_NUMBER_IN_UV) {
1774 /* It wasn't an (integer that doesn't overflow the UV). */
1775 SvNV_set(sv, Atof(SvPVX_const(sv)));
1777 if (! numtype && ckWARN(WARN_NUMERIC))
1780 #if defined(USE_LONG_DOUBLE)
1781 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1782 PTR2UV(sv), SvNVX(sv)));
1784 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1785 PTR2UV(sv), SvNVX(sv)));
1788 #ifdef NV_PRESERVES_UV
1789 (void)SvIOKp_on(sv);
1791 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1792 SvIV_set(sv, I_V(SvNVX(sv)));
1793 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1796 /* Integer is imprecise. NOK, IOKp */
1798 /* UV will not work better than IV */
1800 if (SvNVX(sv) > (NV)UV_MAX) {
1802 /* Integer is inaccurate. NOK, IOKp, is UV */
1803 SvUV_set(sv, UV_MAX);
1805 SvUV_set(sv, U_V(SvNVX(sv)));
1806 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1807 NV preservse UV so can do correct comparison. */
1808 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1811 /* Integer is imprecise. NOK, IOKp, is UV */
1816 #else /* NV_PRESERVES_UV */
1817 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1818 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1819 /* The IV/UV slot will have been set from value returned by
1820 grok_number above. The NV slot has just been set using
1823 assert (SvIOKp(sv));
1825 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1826 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1827 /* Small enough to preserve all bits. */
1828 (void)SvIOKp_on(sv);
1830 SvIV_set(sv, I_V(SvNVX(sv)));
1831 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1833 /* Assumption: first non-preserved integer is < IV_MAX,
1834 this NV is in the preserved range, therefore: */
1835 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1837 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1841 0 0 already failed to read UV.
1842 0 1 already failed to read UV.
1843 1 0 you won't get here in this case. IV/UV
1844 slot set, public IOK, Atof() unneeded.
1845 1 1 already read UV.
1846 so there's no point in sv_2iuv_non_preserve() attempting
1847 to use atol, strtol, strtoul etc. */
1848 sv_2iuv_non_preserve (sv, numtype);
1851 #endif /* NV_PRESERVES_UV */
1855 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1856 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1859 if (SvTYPE(sv) < SVt_IV)
1860 /* Typically the caller expects that sv_any is not NULL now. */
1861 sv_upgrade(sv, SVt_IV);
1862 /* Return 0 from the caller. */
1869 =for apidoc sv_2iv_flags
1871 Return the integer value of an SV, doing any necessary string
1872 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1873 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1879 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1883 if (SvGMAGICAL(sv)) {
1884 if (flags & SV_GMAGIC)
1889 return I_V(SvNVX(sv));
1891 if (SvPOKp(sv) && SvLEN(sv)) {
1894 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 == IS_NUMBER_IN_UV) {
1898 /* It's definitely an integer */
1899 if (numtype & IS_NUMBER_NEG) {
1900 if (value < (UV)IV_MIN)
1903 if (value < (UV)IV_MAX)
1908 if (ckWARN(WARN_NUMERIC))
1911 return I_V(Atof(SvPVX_const(sv)));
1916 assert(SvTYPE(sv) >= SVt_PVMG);
1917 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1918 } else if (SvTHINKFIRST(sv)) {
1922 SV * const tmpstr=AMG_CALLun(sv,numer);
1923 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1924 return SvIV(tmpstr);
1927 return PTR2IV(SvRV(sv));
1930 sv_force_normal_flags(sv, 0);
1932 if (SvREADONLY(sv) && !SvOK(sv)) {
1933 if (ckWARN(WARN_UNINITIALIZED))
1939 if (S_sv_2iuv_common(aTHX_ sv))
1942 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1943 PTR2UV(sv),SvIVX(sv)));
1944 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1948 =for apidoc sv_2uv_flags
1950 Return the unsigned integer value of an SV, doing any necessary string
1951 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1952 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1958 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1962 if (SvGMAGICAL(sv)) {
1963 if (flags & SV_GMAGIC)
1968 return U_V(SvNVX(sv));
1969 if (SvPOKp(sv) && SvLEN(sv)) {
1972 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1974 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1975 == IS_NUMBER_IN_UV) {
1976 /* It's definitely an integer */
1977 if (!(numtype & IS_NUMBER_NEG))
1981 if (ckWARN(WARN_NUMERIC))
1984 return U_V(Atof(SvPVX_const(sv)));
1989 assert(SvTYPE(sv) >= SVt_PVMG);
1990 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
1991 } else if (SvTHINKFIRST(sv)) {
1995 SV *const tmpstr = AMG_CALLun(sv,numer);
1996 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1997 return SvUV(tmpstr);
2000 return PTR2UV(SvRV(sv));
2003 sv_force_normal_flags(sv, 0);
2005 if (SvREADONLY(sv) && !SvOK(sv)) {
2006 if (ckWARN(WARN_UNINITIALIZED))
2012 if (S_sv_2iuv_common(aTHX_ sv))
2016 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2017 PTR2UV(sv),SvUVX(sv)));
2018 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2024 Return the num value of an SV, doing any necessary string or integer
2025 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2032 Perl_sv_2nv(pTHX_ register SV *sv)
2036 if (SvGMAGICAL(sv)) {
2040 if (SvPOKp(sv) && SvLEN(sv)) {
2041 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2042 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2044 return Atof(SvPVX_const(sv));
2048 return (NV)SvUVX(sv);
2050 return (NV)SvIVX(sv);
2055 assert(SvTYPE(sv) >= SVt_PVMG);
2056 /* This falls through to the report_uninit near the end of the
2058 } else if (SvTHINKFIRST(sv)) {
2062 SV *const tmpstr = AMG_CALLun(sv,numer);
2063 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2064 return SvNV(tmpstr);
2067 return PTR2NV(SvRV(sv));
2070 sv_force_normal_flags(sv, 0);
2072 if (SvREADONLY(sv) && !SvOK(sv)) {
2073 if (ckWARN(WARN_UNINITIALIZED))
2078 if (SvTYPE(sv) < SVt_NV) {
2079 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2080 sv_upgrade(sv, SVt_NV);
2081 #ifdef USE_LONG_DOUBLE
2083 STORE_NUMERIC_LOCAL_SET_STANDARD();
2084 PerlIO_printf(Perl_debug_log,
2085 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2086 PTR2UV(sv), SvNVX(sv));
2087 RESTORE_NUMERIC_LOCAL();
2091 STORE_NUMERIC_LOCAL_SET_STANDARD();
2092 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2093 PTR2UV(sv), SvNVX(sv));
2094 RESTORE_NUMERIC_LOCAL();
2098 else if (SvTYPE(sv) < SVt_PVNV)
2099 sv_upgrade(sv, SVt_PVNV);
2104 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2105 #ifdef NV_PRESERVES_UV
2108 /* Only set the public NV OK flag if this NV preserves the IV */
2109 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2110 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2111 : (SvIVX(sv) == I_V(SvNVX(sv))))
2117 else if (SvPOKp(sv) && SvLEN(sv)) {
2119 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2120 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2122 #ifdef NV_PRESERVES_UV
2123 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2124 == IS_NUMBER_IN_UV) {
2125 /* It's definitely an integer */
2126 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2128 SvNV_set(sv, Atof(SvPVX_const(sv)));
2131 SvNV_set(sv, Atof(SvPVX_const(sv)));
2132 /* Only set the public NV OK flag if this NV preserves the value in
2133 the PV at least as well as an IV/UV would.
2134 Not sure how to do this 100% reliably. */
2135 /* if that shift count is out of range then Configure's test is
2136 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2138 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2139 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2140 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2141 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2142 /* Can't use strtol etc to convert this string, so don't try.
2143 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2146 /* value has been set. It may not be precise. */
2147 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2148 /* 2s complement assumption for (UV)IV_MIN */
2149 SvNOK_on(sv); /* Integer is too negative. */
2154 if (numtype & IS_NUMBER_NEG) {
2155 SvIV_set(sv, -(IV)value);
2156 } else if (value <= (UV)IV_MAX) {
2157 SvIV_set(sv, (IV)value);
2159 SvUV_set(sv, value);
2163 if (numtype & IS_NUMBER_NOT_INT) {
2164 /* I believe that even if the original PV had decimals,
2165 they are lost beyond the limit of the FP precision.
2166 However, neither is canonical, so both only get p
2167 flags. NWC, 2000/11/25 */
2168 /* Both already have p flags, so do nothing */
2170 const NV nv = SvNVX(sv);
2171 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2172 if (SvIVX(sv) == I_V(nv)) {
2175 /* It had no "." so it must be integer. */
2179 /* between IV_MAX and NV(UV_MAX).
2180 Could be slightly > UV_MAX */
2182 if (numtype & IS_NUMBER_NOT_INT) {
2183 /* UV and NV both imprecise. */
2185 const UV nv_as_uv = U_V(nv);
2187 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2196 #endif /* NV_PRESERVES_UV */
2199 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2201 assert (SvTYPE(sv) >= SVt_NV);
2202 /* Typically the caller expects that sv_any is not NULL now. */
2203 /* XXX Ilya implies that this is a bug in callers that assume this
2204 and ideally should be fixed. */
2207 #if defined(USE_LONG_DOUBLE)
2209 STORE_NUMERIC_LOCAL_SET_STANDARD();
2210 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2211 PTR2UV(sv), SvNVX(sv));
2212 RESTORE_NUMERIC_LOCAL();
2216 STORE_NUMERIC_LOCAL_SET_STANDARD();
2217 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2218 PTR2UV(sv), SvNVX(sv));
2219 RESTORE_NUMERIC_LOCAL();
2225 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2226 * UV as a string towards the end of buf, and return pointers to start and
2229 * We assume that buf is at least TYPE_CHARS(UV) long.
2233 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2235 char *ptr = buf + TYPE_CHARS(UV);
2236 char * const ebuf = ptr;
2249 *--ptr = '0' + (char)(uv % 10);
2257 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2258 * a regexp to its stringified form.
2262 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2263 const regexp * const re = (regexp *)mg->mg_obj;
2266 const char *fptr = "msix";
2271 bool need_newline = 0;
2272 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2274 while((ch = *fptr++)) {
2276 reflags[left++] = ch;
2279 reflags[right--] = ch;
2284 reflags[left] = '-';
2288 mg->mg_len = re->prelen + 4 + left;
2290 * If /x was used, we have to worry about a regex ending with a
2291 * comment later being embedded within another regex. If so, we don't
2292 * want this regex's "commentization" to leak out to the right part of
2293 * the enclosing regex, we must cap it with a newline.
2295 * So, if /x was used, we scan backwards from the end of the regex. If
2296 * we find a '#' before we find a newline, we need to add a newline
2297 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2298 * we don't need to add anything. -jfriedl
2300 if (PMf_EXTENDED & re->reganch) {
2301 const char *endptr = re->precomp + re->prelen;
2302 while (endptr >= re->precomp) {
2303 const char c = *(endptr--);
2305 break; /* don't need another */
2307 /* we end while in a comment, so we need a newline */
2308 mg->mg_len++; /* save space for it */
2309 need_newline = 1; /* note to add it */
2315 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2316 mg->mg_ptr[0] = '(';
2317 mg->mg_ptr[1] = '?';
2318 Copy(reflags, mg->mg_ptr+2, left, char);
2319 *(mg->mg_ptr+left+2) = ':';
2320 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2322 mg->mg_ptr[mg->mg_len - 2] = '\n';
2323 mg->mg_ptr[mg->mg_len - 1] = ')';
2324 mg->mg_ptr[mg->mg_len] = 0;
2326 PL_reginterp_cnt += re->program[0].next_off;
2328 if (re->reganch & ROPT_UTF8)
2338 =for apidoc sv_2pv_flags
2340 Returns a pointer to the string value of an SV, and sets *lp to its length.
2341 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2343 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2344 usually end up here too.
2350 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2359 if (SvGMAGICAL(sv)) {
2360 if (flags & SV_GMAGIC)
2365 if (flags & SV_MUTABLE_RETURN)
2366 return SvPVX_mutable(sv);
2367 if (flags & SV_CONST_RETURN)
2368 return (char *)SvPVX_const(sv);
2371 if (SvIOKp(sv) || SvNOKp(sv)) {
2372 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2376 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2377 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2379 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2382 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2383 /* Sneaky stuff here */
2384 SV * const tsv = newSVpvn(tbuf, len);
2394 #ifdef FIXNEGATIVEZERO
2395 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2401 SvUPGRADE(sv, SVt_PV);
2404 s = SvGROW_mutable(sv, len + 1);
2407 return memcpy(s, tbuf, len + 1);
2413 assert(SvTYPE(sv) >= SVt_PVMG);
2414 /* This falls through to the report_uninit near the end of the
2416 } else if (SvTHINKFIRST(sv)) {
2420 SV *const tmpstr = AMG_CALLun(sv,string);
2421 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2423 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2427 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2428 if (flags & SV_CONST_RETURN) {
2429 pv = (char *) SvPVX_const(tmpstr);
2431 pv = (flags & SV_MUTABLE_RETURN)
2432 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2435 *lp = SvCUR(tmpstr);
2437 pv = sv_2pv_flags(tmpstr, lp, flags);
2449 const SV *const referent = (SV*)SvRV(sv);
2452 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2453 } else if (SvTYPE(referent) == SVt_PVMG
2454 && ((SvFLAGS(referent) &
2455 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2456 == (SVs_OBJECT|SVs_SMG))
2457 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2458 return stringify_regexp(sv, mg, lp);
2460 const char *const typestr = sv_reftype(referent, 0);
2462 tsv = sv_newmortal();
2463 if (SvOBJECT(referent)) {
2464 const char *const name = HvNAME_get(SvSTASH(referent));
2465 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2466 name ? name : "__ANON__" , typestr,
2470 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2478 if (SvREADONLY(sv) && !SvOK(sv)) {
2479 if (ckWARN(WARN_UNINITIALIZED))
2486 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2487 /* I'm assuming that if both IV and NV are equally valid then
2488 converting the IV is going to be more efficient */
2489 const U32 isIOK = SvIOK(sv);
2490 const U32 isUIOK = SvIsUV(sv);
2491 char buf[TYPE_CHARS(UV)];
2494 if (SvTYPE(sv) < SVt_PVIV)
2495 sv_upgrade(sv, SVt_PVIV);
2496 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2497 /* inlined from sv_setpvn */
2498 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2499 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2500 SvCUR_set(sv, ebuf - ptr);
2510 else if (SvNOKp(sv)) {
2511 const int olderrno = errno;
2512 if (SvTYPE(sv) < SVt_PVNV)
2513 sv_upgrade(sv, SVt_PVNV);
2514 /* The +20 is pure guesswork. Configure test needed. --jhi */
2515 s = SvGROW_mutable(sv, NV_DIG + 20);
2516 /* some Xenix systems wipe out errno here */
2518 if (SvNVX(sv) == 0.0)
2519 (void)strcpy(s,"0");
2523 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2526 #ifdef FIXNEGATIVEZERO
2527 if (*s == '-' && s[1] == '0' && !s[2])
2537 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2541 if (SvTYPE(sv) < SVt_PV)
2542 /* Typically the caller expects that sv_any is not NULL now. */
2543 sv_upgrade(sv, SVt_PV);
2547 const STRLEN len = s - SvPVX_const(sv);
2553 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2554 PTR2UV(sv),SvPVX_const(sv)));
2555 if (flags & SV_CONST_RETURN)
2556 return (char *)SvPVX_const(sv);
2557 if (flags & SV_MUTABLE_RETURN)
2558 return SvPVX_mutable(sv);
2563 =for apidoc sv_copypv
2565 Copies a stringified representation of the source SV into the
2566 destination SV. Automatically performs any necessary mg_get and
2567 coercion of numeric values into strings. Guaranteed to preserve
2568 UTF-8 flag even from overloaded objects. Similar in nature to
2569 sv_2pv[_flags] but operates directly on an SV instead of just the
2570 string. Mostly uses sv_2pv_flags to do its work, except when that
2571 would lose the UTF-8'ness of the PV.
2577 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2580 const char * const s = SvPV_const(ssv,len);
2581 sv_setpvn(dsv,s,len);
2589 =for apidoc sv_2pvbyte
2591 Return a pointer to the byte-encoded representation of the SV, and set *lp
2592 to its length. May cause the SV to be downgraded from UTF-8 as a
2595 Usually accessed via the C<SvPVbyte> macro.
2601 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2603 sv_utf8_downgrade(sv,0);
2604 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2608 =for apidoc sv_2pvutf8
2610 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2611 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2613 Usually accessed via the C<SvPVutf8> macro.
2619 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2621 sv_utf8_upgrade(sv);
2622 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2627 =for apidoc sv_2bool
2629 This function is only called on magical items, and is only used by
2630 sv_true() or its macro equivalent.
2636 Perl_sv_2bool(pTHX_ register SV *sv)
2644 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2645 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2646 return (bool)SvTRUE(tmpsv);
2647 return SvRV(sv) != 0;
2650 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2652 (*sv->sv_u.svu_pv > '0' ||
2653 Xpvtmp->xpv_cur > 1 ||
2654 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2661 return SvIVX(sv) != 0;
2664 return SvNVX(sv) != 0.0;
2672 =for apidoc sv_utf8_upgrade
2674 Converts the PV of an SV to its UTF-8-encoded form.
2675 Forces the SV to string form if it is not already.
2676 Always sets the SvUTF8 flag to avoid future validity checks even
2677 if all the bytes have hibit clear.
2679 This is not as a general purpose byte encoding to Unicode interface:
2680 use the Encode extension for that.
2682 =for apidoc sv_utf8_upgrade_flags
2684 Converts the PV of an SV to its UTF-8-encoded form.
2685 Forces the SV to string form if it is not already.
2686 Always sets the SvUTF8 flag to avoid future validity checks even
2687 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2688 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2689 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2691 This is not as a general purpose byte encoding to Unicode interface:
2692 use the Encode extension for that.
2698 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2700 if (sv == &PL_sv_undef)
2704 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2705 (void) sv_2pv_flags(sv,&len, flags);
2709 (void) SvPV_force(sv,len);
2718 sv_force_normal_flags(sv, 0);
2721 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2722 sv_recode_to_utf8(sv, PL_encoding);
2723 else { /* Assume Latin-1/EBCDIC */
2724 /* This function could be much more efficient if we
2725 * had a FLAG in SVs to signal if there are any hibit
2726 * chars in the PV. Given that there isn't such a flag
2727 * make the loop as fast as possible. */
2728 const U8 * const s = (U8 *) SvPVX_const(sv);
2729 const U8 * const e = (U8 *) SvEND(sv);
2734 /* Check for hi bit */
2735 if (!NATIVE_IS_INVARIANT(ch)) {
2736 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2737 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2739 SvPV_free(sv); /* No longer using what was there before. */
2740 SvPV_set(sv, (char*)recoded);
2741 SvCUR_set(sv, len - 1);
2742 SvLEN_set(sv, len); /* No longer know the real size. */
2746 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2753 =for apidoc sv_utf8_downgrade
2755 Attempts to convert the PV of an SV from characters to bytes.
2756 If the PV contains a character beyond byte, this conversion will fail;
2757 in this case, either returns false or, if C<fail_ok> is not
2760 This is not as a general purpose Unicode to byte encoding interface:
2761 use the Encode extension for that.
2767 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2769 if (SvPOKp(sv) && SvUTF8(sv)) {
2775 sv_force_normal_flags(sv, 0);
2777 s = (U8 *) SvPV(sv, len);
2778 if (!utf8_to_bytes(s, &len)) {
2783 Perl_croak(aTHX_ "Wide character in %s",
2786 Perl_croak(aTHX_ "Wide character");
2797 =for apidoc sv_utf8_encode
2799 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2800 flag off so that it looks like octets again.
2806 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2808 (void) sv_utf8_upgrade(sv);
2810 sv_force_normal_flags(sv, 0);
2812 if (SvREADONLY(sv)) {
2813 Perl_croak(aTHX_ PL_no_modify);
2819 =for apidoc sv_utf8_decode
2821 If the PV of the SV is an octet sequence in UTF-8
2822 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2823 so that it looks like a character. If the PV contains only single-byte
2824 characters, the C<SvUTF8> flag stays being off.
2825 Scans PV for validity and returns false if the PV is invalid UTF-8.
2831 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2837 /* The octets may have got themselves encoded - get them back as
2840 if (!sv_utf8_downgrade(sv, TRUE))
2843 /* it is actually just a matter of turning the utf8 flag on, but
2844 * we want to make sure everything inside is valid utf8 first.
2846 c = (const U8 *) SvPVX_const(sv);
2847 if (!is_utf8_string(c, SvCUR(sv)+1))
2849 e = (const U8 *) SvEND(sv);
2852 if (!UTF8_IS_INVARIANT(ch)) {
2862 =for apidoc sv_setsv
2864 Copies the contents of the source SV C<ssv> into the destination SV
2865 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2866 function if the source SV needs to be reused. Does not handle 'set' magic.
2867 Loosely speaking, it performs a copy-by-value, obliterating any previous
2868 content of the destination.
2870 You probably want to use one of the assortment of wrappers, such as
2871 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2872 C<SvSetMagicSV_nosteal>.
2874 =for apidoc sv_setsv_flags
2876 Copies the contents of the source SV C<ssv> into the destination SV
2877 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2878 function if the source SV needs to be reused. Does not handle 'set' magic.
2879 Loosely speaking, it performs a copy-by-value, obliterating any previous
2880 content of the destination.
2881 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
2882 C<ssv> if appropriate, else not. If the C<flags> parameter has the
2883 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
2884 and C<sv_setsv_nomg> are implemented in terms of this function.
2886 You probably want to use one of the assortment of wrappers, such as
2887 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
2888 C<SvSetMagicSV_nosteal>.
2890 This is the primary function for copying scalars, and most other
2891 copy-ish functions and macros use this underneath.
2897 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
2899 register U32 sflags;
2905 SV_CHECK_THINKFIRST_COW_DROP(dstr);
2907 sstr = &PL_sv_undef;
2908 stype = SvTYPE(sstr);
2909 dtype = SvTYPE(dstr);
2914 /* need to nuke the magic */
2916 SvRMAGICAL_off(dstr);
2919 /* There's a lot of redundancy below but we're going for speed here */
2924 if (dtype != SVt_PVGV) {
2925 (void)SvOK_off(dstr);
2933 sv_upgrade(dstr, SVt_IV);
2936 sv_upgrade(dstr, SVt_PVNV);
2940 sv_upgrade(dstr, SVt_PVIV);
2943 (void)SvIOK_only(dstr);
2944 SvIV_set(dstr, SvIVX(sstr));
2947 if (SvTAINTED(sstr))
2958 sv_upgrade(dstr, SVt_NV);
2963 sv_upgrade(dstr, SVt_PVNV);
2966 SvNV_set(dstr, SvNVX(sstr));
2967 (void)SvNOK_only(dstr);
2968 if (SvTAINTED(sstr))
2976 sv_upgrade(dstr, SVt_RV);
2977 else if (dtype == SVt_PVGV &&
2978 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
2981 if (GvIMPORTED(dstr) != GVf_IMPORTED
2982 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
2984 GvIMPORTED_on(dstr);
2993 #ifdef PERL_OLD_COPY_ON_WRITE
2994 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
2995 if (dtype < SVt_PVIV)
2996 sv_upgrade(dstr, SVt_PVIV);
3003 sv_upgrade(dstr, SVt_PV);
3006 if (dtype < SVt_PVIV)
3007 sv_upgrade(dstr, SVt_PVIV);
3010 if (dtype < SVt_PVNV)
3011 sv_upgrade(dstr, SVt_PVNV);
3018 const char * const type = sv_reftype(sstr,0);
3020 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3022 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3027 if (dtype <= SVt_PVGV) {
3029 if (dtype != SVt_PVGV) {
3030 const char * const name = GvNAME(sstr);
3031 const STRLEN len = GvNAMELEN(sstr);
3032 /* don't upgrade SVt_PVLV: it can hold a glob */
3033 if (dtype != SVt_PVLV)
3034 sv_upgrade(dstr, SVt_PVGV);
3035 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3036 GvSTASH(dstr) = GvSTASH(sstr);
3038 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3039 GvNAME(dstr) = savepvn(name, len);
3040 GvNAMELEN(dstr) = len;
3041 SvFAKE_on(dstr); /* can coerce to non-glob */
3044 #ifdef GV_UNIQUE_CHECK
3045 if (GvUNIQUE((GV*)dstr)) {
3046 Perl_croak(aTHX_ PL_no_modify);
3050 (void)SvOK_off(dstr);
3051 GvINTRO_off(dstr); /* one-shot flag */
3053 GvGP(dstr) = gp_ref(GvGP(sstr));
3054 if (SvTAINTED(sstr))
3056 if (GvIMPORTED(dstr) != GVf_IMPORTED
3057 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3059 GvIMPORTED_on(dstr);
3067 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3069 if ((int)SvTYPE(sstr) != stype) {
3070 stype = SvTYPE(sstr);
3071 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3075 if (stype == SVt_PVLV)
3076 SvUPGRADE(dstr, SVt_PVNV);
3078 SvUPGRADE(dstr, (U32)stype);
3081 sflags = SvFLAGS(sstr);
3083 if (sflags & SVf_ROK) {
3084 if (dtype >= SVt_PV) {
3085 if (dtype == SVt_PVGV) {
3086 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3088 const int intro = GvINTRO(dstr);
3090 #ifdef GV_UNIQUE_CHECK
3091 if (GvUNIQUE((GV*)dstr)) {
3092 Perl_croak(aTHX_ PL_no_modify);
3097 GvINTRO_off(dstr); /* one-shot flag */
3098 GvLINE(dstr) = CopLINE(PL_curcop);
3099 GvEGV(dstr) = (GV*)dstr;
3102 switch (SvTYPE(sref)) {
3105 SAVEGENERICSV(GvAV(dstr));
3107 dref = (SV*)GvAV(dstr);
3108 GvAV(dstr) = (AV*)sref;
3109 if (!GvIMPORTED_AV(dstr)
3110 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3112 GvIMPORTED_AV_on(dstr);
3117 SAVEGENERICSV(GvHV(dstr));
3119 dref = (SV*)GvHV(dstr);
3120 GvHV(dstr) = (HV*)sref;
3121 if (!GvIMPORTED_HV(dstr)
3122 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3124 GvIMPORTED_HV_on(dstr);
3129 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3130 SvREFCNT_dec(GvCV(dstr));
3131 GvCV(dstr) = Nullcv;
3132 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3133 PL_sub_generation++;
3135 SAVEGENERICSV(GvCV(dstr));
3138 dref = (SV*)GvCV(dstr);
3139 if (GvCV(dstr) != (CV*)sref) {
3140 CV* const cv = GvCV(dstr);
3142 if (!GvCVGEN((GV*)dstr) &&
3143 (CvROOT(cv) || CvXSUB(cv)))
3145 /* Redefining a sub - warning is mandatory if
3146 it was a const and its value changed. */
3147 if (CvCONST(cv) && CvCONST((CV*)sref)
3149 == cv_const_sv((CV*)sref)) {
3150 /* They are 2 constant subroutines
3151 generated from the same constant.
3152 This probably means that they are
3153 really the "same" proxy subroutine
3154 instantiated in 2 places. Most likely
3155 this is when a constant is exported
3156 twice. Don't warn. */
3158 else if (ckWARN(WARN_REDEFINE)
3160 && (!CvCONST((CV*)sref)
3161 || sv_cmp(cv_const_sv(cv),
3162 cv_const_sv((CV*)sref)))))
3164 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3166 ? "Constant subroutine %s::%s redefined"
3167 : "Subroutine %s::%s redefined",
3168 HvNAME_get(GvSTASH((GV*)dstr)),
3169 GvENAME((GV*)dstr));
3173 cv_ckproto(cv, (GV*)dstr,
3175 ? SvPVX_const(sref) : Nullch);
3177 GvCV(dstr) = (CV*)sref;
3178 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3179 GvASSUMECV_on(dstr);
3180 PL_sub_generation++;
3182 if (!GvIMPORTED_CV(dstr)
3183 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3185 GvIMPORTED_CV_on(dstr);
3190 SAVEGENERICSV(GvIOp(dstr));
3192 dref = (SV*)GvIOp(dstr);
3193 GvIOp(dstr) = (IO*)sref;
3197 SAVEGENERICSV(GvFORM(dstr));
3199 dref = (SV*)GvFORM(dstr);
3200 GvFORM(dstr) = (CV*)sref;
3204 SAVEGENERICSV(GvSV(dstr));
3206 dref = (SV*)GvSV(dstr);
3208 if (!GvIMPORTED_SV(dstr)
3209 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3211 GvIMPORTED_SV_on(dstr);
3217 if (SvTAINTED(sstr))
3221 if (SvPVX_const(dstr)) {
3227 (void)SvOK_off(dstr);
3228 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3230 if (sflags & SVp_NOK) {
3232 /* Only set the public OK flag if the source has public OK. */
3233 if (sflags & SVf_NOK)
3234 SvFLAGS(dstr) |= SVf_NOK;
3235 SvNV_set(dstr, SvNVX(sstr));
3237 if (sflags & SVp_IOK) {
3238 (void)SvIOKp_on(dstr);
3239 if (sflags & SVf_IOK)
3240 SvFLAGS(dstr) |= SVf_IOK;
3241 if (sflags & SVf_IVisUV)
3243 SvIV_set(dstr, SvIVX(sstr));
3245 if (SvAMAGIC(sstr)) {
3249 else if (sflags & SVp_POK) {
3253 * Check to see if we can just swipe the string. If so, it's a
3254 * possible small lose on short strings, but a big win on long ones.
3255 * It might even be a win on short strings if SvPVX_const(dstr)
3256 * has to be allocated and SvPVX_const(sstr) has to be freed.
3259 /* Whichever path we take through the next code, we want this true,
3260 and doing it now facilitates the COW check. */
3261 (void)SvPOK_only(dstr);
3264 /* We're not already COW */
3265 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3266 #ifndef PERL_OLD_COPY_ON_WRITE
3267 /* or we are, but dstr isn't a suitable target. */
3268 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3273 (sflags & SVs_TEMP) && /* slated for free anyway? */
3274 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3275 (!(flags & SV_NOSTEAL)) &&
3276 /* and we're allowed to steal temps */
3277 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3278 SvLEN(sstr) && /* and really is a string */
3279 /* and won't be needed again, potentially */
3280 !(PL_op && PL_op->op_type == OP_AASSIGN))
3281 #ifdef PERL_OLD_COPY_ON_WRITE
3282 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3283 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3284 && SvTYPE(sstr) >= SVt_PVIV)
3287 /* Failed the swipe test, and it's not a shared hash key either.
3288 Have to copy the string. */
3289 STRLEN len = SvCUR(sstr);
3290 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3291 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3292 SvCUR_set(dstr, len);
3293 *SvEND(dstr) = '\0';
3295 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3297 /* Either it's a shared hash key, or it's suitable for
3298 copy-on-write or we can swipe the string. */
3300 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3304 #ifdef PERL_OLD_COPY_ON_WRITE
3306 /* I believe I should acquire a global SV mutex if
3307 it's a COW sv (not a shared hash key) to stop
3308 it going un copy-on-write.
3309 If the source SV has gone un copy on write between up there
3310 and down here, then (assert() that) it is of the correct
3311 form to make it copy on write again */
3312 if ((sflags & (SVf_FAKE | SVf_READONLY))
3313 != (SVf_FAKE | SVf_READONLY)) {
3314 SvREADONLY_on(sstr);
3316 /* Make the source SV into a loop of 1.
3317 (about to become 2) */
3318 SV_COW_NEXT_SV_SET(sstr, sstr);
3322 /* Initial code is common. */
3323 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3328 /* making another shared SV. */
3329 STRLEN cur = SvCUR(sstr);
3330 STRLEN len = SvLEN(sstr);
3331 #ifdef PERL_OLD_COPY_ON_WRITE
3333 assert (SvTYPE(dstr) >= SVt_PVIV);
3334 /* SvIsCOW_normal */
3335 /* splice us in between source and next-after-source. */
3336 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3337 SV_COW_NEXT_SV_SET(sstr, dstr);
3338 SvPV_set(dstr, SvPVX_mutable(sstr));
3342 /* SvIsCOW_shared_hash */
3343 DEBUG_C(PerlIO_printf(Perl_debug_log,
3344 "Copy on write: Sharing hash\n"));
3346 assert (SvTYPE(dstr) >= SVt_PV);
3348 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3350 SvLEN_set(dstr, len);
3351 SvCUR_set(dstr, cur);
3352 SvREADONLY_on(dstr);
3354 /* Relesase a global SV mutex. */
3357 { /* Passes the swipe test. */
3358 SvPV_set(dstr, SvPVX_mutable(sstr));
3359 SvLEN_set(dstr, SvLEN(sstr));
3360 SvCUR_set(dstr, SvCUR(sstr));
3363 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3364 SvPV_set(sstr, Nullch);
3370 if (sflags & SVf_UTF8)
3372 if (sflags & SVp_NOK) {
3374 if (sflags & SVf_NOK)
3375 SvFLAGS(dstr) |= SVf_NOK;
3376 SvNV_set(dstr, SvNVX(sstr));
3378 if (sflags & SVp_IOK) {
3379 (void)SvIOKp_on(dstr);
3380 if (sflags & SVf_IOK)
3381 SvFLAGS(dstr) |= SVf_IOK;
3382 if (sflags & SVf_IVisUV)
3384 SvIV_set(dstr, SvIVX(sstr));
3387 const MAGIC * const smg = mg_find(sstr,PERL_MAGIC_vstring);
3388 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3389 smg->mg_ptr, smg->mg_len);
3390 SvRMAGICAL_on(dstr);
3393 else if (sflags & SVp_IOK) {
3394 if (sflags & SVf_IOK)
3395 (void)SvIOK_only(dstr);
3397 (void)SvOK_off(dstr);
3398 (void)SvIOKp_on(dstr);
3400 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3401 if (sflags & SVf_IVisUV)
3403 SvIV_set(dstr, SvIVX(sstr));
3404 if (sflags & SVp_NOK) {
3405 if (sflags & SVf_NOK)
3406 (void)SvNOK_on(dstr);
3408 (void)SvNOKp_on(dstr);
3409 SvNV_set(dstr, SvNVX(sstr));
3412 else if (sflags & SVp_NOK) {
3413 if (sflags & SVf_NOK)
3414 (void)SvNOK_only(dstr);
3416 (void)SvOK_off(dstr);
3419 SvNV_set(dstr, SvNVX(sstr));
3422 if (dtype == SVt_PVGV) {
3423 if (ckWARN(WARN_MISC))
3424 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3427 (void)SvOK_off(dstr);
3429 if (SvTAINTED(sstr))
3434 =for apidoc sv_setsv_mg
3436 Like C<sv_setsv>, but also handles 'set' magic.
3442 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3444 sv_setsv(dstr,sstr);
3448 #ifdef PERL_OLD_COPY_ON_WRITE
3450 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3452 STRLEN cur = SvCUR(sstr);
3453 STRLEN len = SvLEN(sstr);
3454 register char *new_pv;
3457 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3465 if (SvTHINKFIRST(dstr))
3466 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3467 else if (SvPVX_const(dstr))
3468 Safefree(SvPVX_const(dstr));
3472 SvUPGRADE(dstr, SVt_PVIV);
3474 assert (SvPOK(sstr));
3475 assert (SvPOKp(sstr));
3476 assert (!SvIOK(sstr));
3477 assert (!SvIOKp(sstr));
3478 assert (!SvNOK(sstr));
3479 assert (!SvNOKp(sstr));
3481 if (SvIsCOW(sstr)) {
3483 if (SvLEN(sstr) == 0) {
3484 /* source is a COW shared hash key. */
3485 DEBUG_C(PerlIO_printf(Perl_debug_log,
3486 "Fast copy on write: Sharing hash\n"));
3487 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3490 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3492 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3493 SvUPGRADE(sstr, SVt_PVIV);
3494 SvREADONLY_on(sstr);
3496 DEBUG_C(PerlIO_printf(Perl_debug_log,
3497 "Fast copy on write: Converting sstr to COW\n"));
3498 SV_COW_NEXT_SV_SET(dstr, sstr);
3500 SV_COW_NEXT_SV_SET(sstr, dstr);
3501 new_pv = SvPVX_mutable(sstr);
3504 SvPV_set(dstr, new_pv);
3505 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3508 SvLEN_set(dstr, len);
3509 SvCUR_set(dstr, cur);
3518 =for apidoc sv_setpvn
3520 Copies a string into an SV. The C<len> parameter indicates the number of
3521 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3522 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3528 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3530 register char *dptr;
3532 SV_CHECK_THINKFIRST_COW_DROP(sv);
3538 /* len is STRLEN which is unsigned, need to copy to signed */
3541 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3543 SvUPGRADE(sv, SVt_PV);
3545 dptr = SvGROW(sv, len + 1);
3546 Move(ptr,dptr,len,char);
3549 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3554 =for apidoc sv_setpvn_mg
3556 Like C<sv_setpvn>, but also handles 'set' magic.
3562 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3564 sv_setpvn(sv,ptr,len);
3569 =for apidoc sv_setpv
3571 Copies a string into an SV. The string must be null-terminated. Does not
3572 handle 'set' magic. See C<sv_setpv_mg>.
3578 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3580 register STRLEN len;
3582 SV_CHECK_THINKFIRST_COW_DROP(sv);
3588 SvUPGRADE(sv, SVt_PV);
3590 SvGROW(sv, len + 1);
3591 Move(ptr,SvPVX(sv),len+1,char);
3593 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3598 =for apidoc sv_setpv_mg
3600 Like C<sv_setpv>, but also handles 'set' magic.
3606 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3613 =for apidoc sv_usepvn
3615 Tells an SV to use C<ptr> to find its string value. Normally the string is
3616 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3617 The C<ptr> should point to memory that was allocated by C<malloc>. The
3618 string length, C<len>, must be supplied. This function will realloc the
3619 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3620 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3621 See C<sv_usepvn_mg>.
3627 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3630 SV_CHECK_THINKFIRST_COW_DROP(sv);
3631 SvUPGRADE(sv, SVt_PV);
3636 if (SvPVX_const(sv))
3639 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3640 ptr = saferealloc (ptr, allocate);
3643 SvLEN_set(sv, allocate);
3645 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3650 =for apidoc sv_usepvn_mg
3652 Like C<sv_usepvn>, but also handles 'set' magic.
3658 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3660 sv_usepvn(sv,ptr,len);
3664 #ifdef PERL_OLD_COPY_ON_WRITE
3665 /* Need to do this *after* making the SV normal, as we need the buffer
3666 pointer to remain valid until after we've copied it. If we let go too early,
3667 another thread could invalidate it by unsharing last of the same hash key
3668 (which it can do by means other than releasing copy-on-write Svs)
3669 or by changing the other copy-on-write SVs in the loop. */
3671 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3673 if (len) { /* this SV was SvIsCOW_normal(sv) */
3674 /* we need to find the SV pointing to us. */
3675 SV * const current = SV_COW_NEXT_SV(after);
3677 if (current == sv) {
3678 /* The SV we point to points back to us (there were only two of us
3680 Hence other SV is no longer copy on write either. */
3682 SvREADONLY_off(after);
3684 /* We need to follow the pointers around the loop. */
3686 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3689 /* don't loop forever if the structure is bust, and we have
3690 a pointer into a closed loop. */
3691 assert (current != after);
3692 assert (SvPVX_const(current) == pvx);
3694 /* Make the SV before us point to the SV after us. */
3695 SV_COW_NEXT_SV_SET(current, after);
3698 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3703 Perl_sv_release_IVX(pTHX_ register SV *sv)
3706 sv_force_normal_flags(sv, 0);
3712 =for apidoc sv_force_normal_flags
3714 Undo various types of fakery on an SV: if the PV is a shared string, make
3715 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3716 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3717 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3718 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3719 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3720 set to some other value.) In addition, the C<flags> parameter gets passed to
3721 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3722 with flags set to 0.
3728 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3730 #ifdef PERL_OLD_COPY_ON_WRITE
3731 if (SvREADONLY(sv)) {
3732 /* At this point I believe I should acquire a global SV mutex. */
3734 const char * const pvx = SvPVX_const(sv);
3735 const STRLEN len = SvLEN(sv);
3736 const STRLEN cur = SvCUR(sv);
3737 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3739 PerlIO_printf(Perl_debug_log,
3740 "Copy on write: Force normal %ld\n",
3746 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3747 SvPV_set(sv, (char*)0);
3749 if (flags & SV_COW_DROP_PV) {
3750 /* OK, so we don't need to copy our buffer. */
3753 SvGROW(sv, cur + 1);
3754 Move(pvx,SvPVX(sv),cur,char);
3758 sv_release_COW(sv, pvx, len, next);
3763 else if (IN_PERL_RUNTIME)
3764 Perl_croak(aTHX_ PL_no_modify);
3765 /* At this point I believe that I can drop the global SV mutex. */
3768 if (SvREADONLY(sv)) {
3770 const char * const pvx = SvPVX_const(sv);
3771 const STRLEN len = SvCUR(sv);
3774 SvPV_set(sv, Nullch);
3776 SvGROW(sv, len + 1);
3777 Move(pvx,SvPVX(sv),len,char);
3779 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3781 else if (IN_PERL_RUNTIME)
3782 Perl_croak(aTHX_ PL_no_modify);
3786 sv_unref_flags(sv, flags);
3787 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3794 Efficient removal of characters from the beginning of the string buffer.
3795 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3796 the string buffer. The C<ptr> becomes the first character of the adjusted
3797 string. Uses the "OOK hack".
3798 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3799 refer to the same chunk of data.
3805 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3807 register STRLEN delta;
3808 if (!ptr || !SvPOKp(sv))
3810 delta = ptr - SvPVX_const(sv);
3811 SV_CHECK_THINKFIRST(sv);
3812 if (SvTYPE(sv) < SVt_PVIV)
3813 sv_upgrade(sv,SVt_PVIV);
3816 if (!SvLEN(sv)) { /* make copy of shared string */
3817 const char *pvx = SvPVX_const(sv);
3818 const STRLEN len = SvCUR(sv);
3819 SvGROW(sv, len + 1);
3820 Move(pvx,SvPVX(sv),len,char);
3824 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3825 and we do that anyway inside the SvNIOK_off
3827 SvFLAGS(sv) |= SVf_OOK;
3830 SvLEN_set(sv, SvLEN(sv) - delta);
3831 SvCUR_set(sv, SvCUR(sv) - delta);
3832 SvPV_set(sv, SvPVX(sv) + delta);
3833 SvIV_set(sv, SvIVX(sv) + delta);
3837 =for apidoc sv_catpvn
3839 Concatenates the string onto the end of the string which is in the SV. The
3840 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3841 status set, then the bytes appended should be valid UTF-8.
3842 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3844 =for apidoc sv_catpvn_flags
3846 Concatenates the string onto the end of the string which is in the SV. The
3847 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3848 status set, then the bytes appended should be valid UTF-8.
3849 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3850 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3851 in terms of this function.
3857 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3860 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
3862 SvGROW(dsv, dlen + slen + 1);
3864 sstr = SvPVX_const(dsv);
3865 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3866 SvCUR_set(dsv, SvCUR(dsv) + slen);
3868 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3870 if (flags & SV_SMAGIC)
3875 =for apidoc sv_catsv
3877 Concatenates the string from SV C<ssv> onto the end of the string in
3878 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3879 not 'set' magic. See C<sv_catsv_mg>.
3881 =for apidoc sv_catsv_flags
3883 Concatenates the string from SV C<ssv> onto the end of the string in
3884 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
3885 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3886 and C<sv_catsv_nomg> are implemented in terms of this function.
3891 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
3895 const char *spv = SvPV_const(ssv, slen);
3897 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
3898 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
3899 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
3900 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
3901 dsv->sv_flags doesn't have that bit set.
3902 Andy Dougherty 12 Oct 2001
3904 const I32 sutf8 = DO_UTF8(ssv);
3907 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
3909 dutf8 = DO_UTF8(dsv);
3911 if (dutf8 != sutf8) {
3913 /* Not modifying source SV, so taking a temporary copy. */
3914 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
3916 sv_utf8_upgrade(csv);
3917 spv = SvPV_const(csv, slen);
3920 sv_utf8_upgrade_nomg(dsv);
3922 sv_catpvn_nomg(dsv, spv, slen);
3925 if (flags & SV_SMAGIC)
3930 =for apidoc sv_catpv
3932 Concatenates the string onto the end of the string which is in the SV.
3933 If the SV has the UTF-8 status set, then the bytes appended should be
3934 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
3939 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
3941 register STRLEN len;
3947 junk = SvPV_force(sv, tlen);
3949 SvGROW(sv, tlen + len + 1);
3951 ptr = SvPVX_const(sv);
3952 Move(ptr,SvPVX(sv)+tlen,len+1,char);
3953 SvCUR_set(sv, SvCUR(sv) + len);
3954 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3959 =for apidoc sv_catpv_mg
3961 Like C<sv_catpv>, but also handles 'set' magic.
3967 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
3976 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
3977 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
3984 Perl_newSV(pTHX_ STRLEN len)
3990 sv_upgrade(sv, SVt_PV);
3991 SvGROW(sv, len + 1);
3996 =for apidoc sv_magicext
3998 Adds magic to an SV, upgrading it if necessary. Applies the
3999 supplied vtable and returns a pointer to the magic added.
4001 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4002 In particular, you can add magic to SvREADONLY SVs, and add more than
4003 one instance of the same 'how'.
4005 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4006 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4007 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4008 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4010 (This is now used as a subroutine by C<sv_magic>.)
4015 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4016 const char* name, I32 namlen)
4020 if (SvTYPE(sv) < SVt_PVMG) {
4021 SvUPGRADE(sv, SVt_PVMG);
4023 Newxz(mg, 1, MAGIC);
4024 mg->mg_moremagic = SvMAGIC(sv);
4025 SvMAGIC_set(sv, mg);
4027 /* Sometimes a magic contains a reference loop, where the sv and
4028 object refer to each other. To prevent a reference loop that
4029 would prevent such objects being freed, we look for such loops
4030 and if we find one we avoid incrementing the object refcount.
4032 Note we cannot do this to avoid self-tie loops as intervening RV must
4033 have its REFCNT incremented to keep it in existence.
4036 if (!obj || obj == sv ||
4037 how == PERL_MAGIC_arylen ||
4038 how == PERL_MAGIC_qr ||
4039 how == PERL_MAGIC_symtab ||
4040 (SvTYPE(obj) == SVt_PVGV &&
4041 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4042 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4043 GvFORM(obj) == (CV*)sv)))
4048 mg->mg_obj = SvREFCNT_inc(obj);
4049 mg->mg_flags |= MGf_REFCOUNTED;
4052 /* Normal self-ties simply pass a null object, and instead of
4053 using mg_obj directly, use the SvTIED_obj macro to produce a
4054 new RV as needed. For glob "self-ties", we are tieing the PVIO
4055 with an RV obj pointing to the glob containing the PVIO. In
4056 this case, to avoid a reference loop, we need to weaken the
4060 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4061 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4067 mg->mg_len = namlen;
4070 mg->mg_ptr = savepvn(name, namlen);
4071 else if (namlen == HEf_SVKEY)
4072 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4074 mg->mg_ptr = (char *) name;
4076 mg->mg_virtual = vtable;
4080 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4085 =for apidoc sv_magic
4087 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4088 then adds a new magic item of type C<how> to the head of the magic list.
4090 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4091 handling of the C<name> and C<namlen> arguments.
4093 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4094 to add more than one instance of the same 'how'.
4100 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4102 const MGVTBL *vtable;
4105 #ifdef PERL_OLD_COPY_ON_WRITE
4107 sv_force_normal_flags(sv, 0);
4109 if (SvREADONLY(sv)) {
4111 /* its okay to attach magic to shared strings; the subsequent
4112 * upgrade to PVMG will unshare the string */
4113 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4116 && how != PERL_MAGIC_regex_global
4117 && how != PERL_MAGIC_bm
4118 && how != PERL_MAGIC_fm
4119 && how != PERL_MAGIC_sv
4120 && how != PERL_MAGIC_backref
4123 Perl_croak(aTHX_ PL_no_modify);
4126 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4127 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4128 /* sv_magic() refuses to add a magic of the same 'how' as an
4131 if (how == PERL_MAGIC_taint)
4139 vtable = &PL_vtbl_sv;
4141 case PERL_MAGIC_overload:
4142 vtable = &PL_vtbl_amagic;
4144 case PERL_MAGIC_overload_elem:
4145 vtable = &PL_vtbl_amagicelem;
4147 case PERL_MAGIC_overload_table:
4148 vtable = &PL_vtbl_ovrld;
4151 vtable = &PL_vtbl_bm;
4153 case PERL_MAGIC_regdata:
4154 vtable = &PL_vtbl_regdata;
4156 case PERL_MAGIC_regdatum:
4157 vtable = &PL_vtbl_regdatum;
4159 case PERL_MAGIC_env:
4160 vtable = &PL_vtbl_env;
4163 vtable = &PL_vtbl_fm;
4165 case PERL_MAGIC_envelem:
4166 vtable = &PL_vtbl_envelem;
4168 case PERL_MAGIC_regex_global:
4169 vtable = &PL_vtbl_mglob;
4171 case PERL_MAGIC_isa:
4172 vtable = &PL_vtbl_isa;
4174 case PERL_MAGIC_isaelem:
4175 vtable = &PL_vtbl_isaelem;
4177 case PERL_MAGIC_nkeys:
4178 vtable = &PL_vtbl_nkeys;
4180 case PERL_MAGIC_dbfile:
4183 case PERL_MAGIC_dbline:
4184 vtable = &PL_vtbl_dbline;
4186 #ifdef USE_LOCALE_COLLATE
4187 case PERL_MAGIC_collxfrm:
4188 vtable = &PL_vtbl_collxfrm;
4190 #endif /* USE_LOCALE_COLLATE */
4191 case PERL_MAGIC_tied:
4192 vtable = &PL_vtbl_pack;
4194 case PERL_MAGIC_tiedelem:
4195 case PERL_MAGIC_tiedscalar:
4196 vtable = &PL_vtbl_packelem;
4199 vtable = &PL_vtbl_regexp;
4201 case PERL_MAGIC_sig:
4202 vtable = &PL_vtbl_sig;
4204 case PERL_MAGIC_sigelem:
4205 vtable = &PL_vtbl_sigelem;
4207 case PERL_MAGIC_taint:
4208 vtable = &PL_vtbl_taint;
4210 case PERL_MAGIC_uvar:
4211 vtable = &PL_vtbl_uvar;
4213 case PERL_MAGIC_vec:
4214 vtable = &PL_vtbl_vec;
4216 case PERL_MAGIC_arylen_p:
4217 case PERL_MAGIC_rhash:
4218 case PERL_MAGIC_symtab:
4219 case PERL_MAGIC_vstring:
4222 case PERL_MAGIC_utf8:
4223 vtable = &PL_vtbl_utf8;
4225 case PERL_MAGIC_substr:
4226 vtable = &PL_vtbl_substr;
4228 case PERL_MAGIC_defelem:
4229 vtable = &PL_vtbl_defelem;
4231 case PERL_MAGIC_glob:
4232 vtable = &PL_vtbl_glob;
4234 case PERL_MAGIC_arylen:
4235 vtable = &PL_vtbl_arylen;
4237 case PERL_MAGIC_pos:
4238 vtable = &PL_vtbl_pos;
4240 case PERL_MAGIC_backref:
4241 vtable = &PL_vtbl_backref;
4243 case PERL_MAGIC_ext:
4244 /* Reserved for use by extensions not perl internals. */
4245 /* Useful for attaching extension internal data to perl vars. */
4246 /* Note that multiple extensions may clash if magical scalars */
4247 /* etc holding private data from one are passed to another. */
4251 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4254 /* Rest of work is done else where */
4255 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4258 case PERL_MAGIC_taint:
4261 case PERL_MAGIC_ext:
4262 case PERL_MAGIC_dbfile:
4269 =for apidoc sv_unmagic
4271 Removes all magic of type C<type> from an SV.
4277 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4281 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4284 for (mg = *mgp; mg; mg = *mgp) {
4285 if (mg->mg_type == type) {
4286 const MGVTBL* const vtbl = mg->mg_virtual;
4287 *mgp = mg->mg_moremagic;
4288 if (vtbl && vtbl->svt_free)
4289 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4290 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4292 Safefree(mg->mg_ptr);
4293 else if (mg->mg_len == HEf_SVKEY)
4294 SvREFCNT_dec((SV*)mg->mg_ptr);
4295 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4296 Safefree(mg->mg_ptr);
4298 if (mg->mg_flags & MGf_REFCOUNTED)
4299 SvREFCNT_dec(mg->mg_obj);
4303 mgp = &mg->mg_moremagic;
4307 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4314 =for apidoc sv_rvweaken
4316 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4317 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4318 push a back-reference to this RV onto the array of backreferences
4319 associated with that magic.
4325 Perl_sv_rvweaken(pTHX_ SV *sv)
4328 if (!SvOK(sv)) /* let undefs pass */
4331 Perl_croak(aTHX_ "Can't weaken a nonreference");
4332 else if (SvWEAKREF(sv)) {
4333 if (ckWARN(WARN_MISC))
4334 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4338 Perl_sv_add_backref(aTHX_ tsv, sv);
4344 /* Give tsv backref magic if it hasn't already got it, then push a
4345 * back-reference to sv onto the array associated with the backref magic.
4349 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4353 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4354 av = (AV*)mg->mg_obj;
4357 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4358 /* av now has a refcnt of 2, which avoids it getting freed
4359 * before us during global cleanup. The extra ref is removed
4360 * by magic_killbackrefs() when tsv is being freed */
4362 if (AvFILLp(av) >= AvMAX(av)) {
4363 av_extend(av, AvFILLp(av)+1);
4365 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4368 /* delete a back-reference to ourselves from the backref magic associated
4369 * with the SV we point to.
4373 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4379 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4380 if (PL_in_clean_all)
4383 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4384 Perl_croak(aTHX_ "panic: del_backref");
4385 av = (AV *)mg->mg_obj;
4387 /* We shouldn't be in here more than once, but for paranoia reasons lets
4389 for (i = AvFILLp(av); i >= 0; i--) {
4391 const SSize_t fill = AvFILLp(av);
4393 /* We weren't the last entry.
4394 An unordered list has this property that you can take the
4395 last element off the end to fill the hole, and it's still
4396 an unordered list :-)
4401 AvFILLp(av) = fill - 1;
4407 =for apidoc sv_insert
4409 Inserts a string at the specified offset/length within the SV. Similar to
4410 the Perl substr() function.
4416 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4420 register char *midend;
4421 register char *bigend;
4427 Perl_croak(aTHX_ "Can't modify non-existent substring");
4428 SvPV_force(bigstr, curlen);
4429 (void)SvPOK_only_UTF8(bigstr);
4430 if (offset + len > curlen) {
4431 SvGROW(bigstr, offset+len+1);
4432 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4433 SvCUR_set(bigstr, offset+len);
4437 i = littlelen - len;
4438 if (i > 0) { /* string might grow */
4439 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4440 mid = big + offset + len;
4441 midend = bigend = big + SvCUR(bigstr);
4444 while (midend > mid) /* shove everything down */
4445 *--bigend = *--midend;
4446 Move(little,big+offset,littlelen,char);
4447 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4452 Move(little,SvPVX(bigstr)+offset,len,char);
4457 big = SvPVX(bigstr);
4460 bigend = big + SvCUR(bigstr);
4462 if (midend > bigend)
4463 Perl_croak(aTHX_ "panic: sv_insert");
4465 if (mid - big > bigend - midend) { /* faster to shorten from end */
4467 Move(little, mid, littlelen,char);
4470 i = bigend - midend;
4472 Move(midend, mid, i,char);
4476 SvCUR_set(bigstr, mid - big);
4478 else if ((i = mid - big)) { /* faster from front */
4479 midend -= littlelen;
4481 sv_chop(bigstr,midend-i);
4486 Move(little, mid, littlelen,char);
4488 else if (littlelen) {
4489 midend -= littlelen;
4490 sv_chop(bigstr,midend);
4491 Move(little,midend,littlelen,char);
4494 sv_chop(bigstr,midend);
4500 =for apidoc sv_replace
4502 Make the first argument a copy of the second, then delete the original.
4503 The target SV physically takes over ownership of the body of the source SV
4504 and inherits its flags; however, the target keeps any magic it owns,
4505 and any magic in the source is discarded.
4506 Note that this is a rather specialist SV copying operation; most of the
4507 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4513 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4515 const U32 refcnt = SvREFCNT(sv);
4516 SV_CHECK_THINKFIRST_COW_DROP(sv);
4517 if (SvREFCNT(nsv) != 1) {
4518 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4519 UVuf " != 1)", (UV) SvREFCNT(nsv));
4521 if (SvMAGICAL(sv)) {
4525 sv_upgrade(nsv, SVt_PVMG);
4526 SvMAGIC_set(nsv, SvMAGIC(sv));
4527 SvFLAGS(nsv) |= SvMAGICAL(sv);
4529 SvMAGIC_set(sv, NULL);
4533 assert(!SvREFCNT(sv));
4534 #ifdef DEBUG_LEAKING_SCALARS
4535 sv->sv_flags = nsv->sv_flags;
4536 sv->sv_any = nsv->sv_any;
4537 sv->sv_refcnt = nsv->sv_refcnt;
4538 sv->sv_u = nsv->sv_u;
4540 StructCopy(nsv,sv,SV);
4542 /* Currently could join these into one piece of pointer arithmetic, but
4543 it would be unclear. */
4544 if(SvTYPE(sv) == SVt_IV)
4546 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4547 else if (SvTYPE(sv) == SVt_RV) {
4548 SvANY(sv) = &sv->sv_u.svu_rv;
4552 #ifdef PERL_OLD_COPY_ON_WRITE
4553 if (SvIsCOW_normal(nsv)) {
4554 /* We need to follow the pointers around the loop to make the
4555 previous SV point to sv, rather than nsv. */
4558 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4561 assert(SvPVX_const(current) == SvPVX_const(nsv));
4563 /* Make the SV before us point to the SV after us. */
4565 PerlIO_printf(Perl_debug_log, "previous is\n");
4567 PerlIO_printf(Perl_debug_log,
4568 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4569 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4571 SV_COW_NEXT_SV_SET(current, sv);
4574 SvREFCNT(sv) = refcnt;
4575 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4581 =for apidoc sv_clear
4583 Clear an SV: call any destructors, free up any memory used by the body,
4584 and free the body itself. The SV's head is I<not> freed, although
4585 its type is set to all 1's so that it won't inadvertently be assumed
4586 to be live during global destruction etc.
4587 This function should only be called when REFCNT is zero. Most of the time
4588 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4595 Perl_sv_clear(pTHX_ register SV *sv)
4598 const U32 type = SvTYPE(sv);
4599 const struct body_details *const sv_type_details
4600 = bodies_by_type + type;
4603 assert(SvREFCNT(sv) == 0);
4609 if (PL_defstash) { /* Still have a symbol table? */
4614 stash = SvSTASH(sv);
4615 destructor = StashHANDLER(stash,DESTROY);
4617 SV* const tmpref = newRV(sv);
4618 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4620 PUSHSTACKi(PERLSI_DESTROY);
4625 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4631 if(SvREFCNT(tmpref) < 2) {
4632 /* tmpref is not kept alive! */
4634 SvRV_set(tmpref, NULL);
4637 SvREFCNT_dec(tmpref);
4639 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4643 if (PL_in_clean_objs)
4644 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4646 /* DESTROY gave object new lease on life */
4652 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4653 SvOBJECT_off(sv); /* Curse the object. */
4654 if (type != SVt_PVIO)
4655 --PL_sv_objcount; /* XXX Might want something more general */
4658 if (type >= SVt_PVMG) {
4661 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4662 SvREFCNT_dec(SvSTASH(sv));
4667 IoIFP(sv) != PerlIO_stdin() &&
4668 IoIFP(sv) != PerlIO_stdout() &&
4669 IoIFP(sv) != PerlIO_stderr())
4671 io_close((IO*)sv, FALSE);
4673 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4674 PerlDir_close(IoDIRP(sv));
4675 IoDIRP(sv) = (DIR*)NULL;
4676 Safefree(IoTOP_NAME(sv));
4677 Safefree(IoFMT_NAME(sv));
4678 Safefree(IoBOTTOM_NAME(sv));
4693 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4694 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4695 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4696 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4698 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4699 SvREFCNT_dec(LvTARG(sv));
4703 Safefree(GvNAME(sv));
4704 /* If we're in a stash, we don't own a reference to it. However it does
4705 have a back reference to us, which needs to be cleared. */
4707 sv_del_backref((SV*)GvSTASH(sv), sv);
4712 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4714 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4715 /* Don't even bother with turning off the OOK flag. */
4720 SV *target = SvRV(sv);
4722 sv_del_backref(target, sv);
4724 SvREFCNT_dec(target);
4726 #ifdef PERL_OLD_COPY_ON_WRITE
4727 else if (SvPVX_const(sv)) {
4729 /* I believe I need to grab the global SV mutex here and
4730 then recheck the COW status. */
4732 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4735 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4736 SV_COW_NEXT_SV(sv));
4737 /* And drop it here. */
4739 } else if (SvLEN(sv)) {
4740 Safefree(SvPVX_const(sv));
4744 else if (SvPVX_const(sv) && SvLEN(sv))
4745 Safefree(SvPVX_mutable(sv));
4746 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4747 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4756 SvFLAGS(sv) &= SVf_BREAK;
4757 SvFLAGS(sv) |= SVTYPEMASK;
4759 if (sv_type_details->arena) {
4760 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4761 &PL_body_roots[type]);
4763 else if (sv_type_details->size) {
4764 my_safefree(SvANY(sv));
4769 =for apidoc sv_newref
4771 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4778 Perl_sv_newref(pTHX_ SV *sv)
4788 Decrement an SV's reference count, and if it drops to zero, call
4789 C<sv_clear> to invoke destructors and free up any memory used by
4790 the body; finally, deallocate the SV's head itself.
4791 Normally called via a wrapper macro C<SvREFCNT_dec>.
4797 Perl_sv_free(pTHX_ SV *sv)
4802 if (SvREFCNT(sv) == 0) {
4803 if (SvFLAGS(sv) & SVf_BREAK)
4804 /* this SV's refcnt has been artificially decremented to
4805 * trigger cleanup */
4807 if (PL_in_clean_all) /* All is fair */
4809 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4810 /* make sure SvREFCNT(sv)==0 happens very seldom */
4811 SvREFCNT(sv) = (~(U32)0)/2;
4814 if (ckWARN_d(WARN_INTERNAL)) {
4815 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
4816 "Attempt to free unreferenced scalar: SV 0x%"UVxf
4817 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4818 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4819 Perl_dump_sv_child(aTHX_ sv);
4824 if (--(SvREFCNT(sv)) > 0)
4826 Perl_sv_free2(aTHX_ sv);
4830 Perl_sv_free2(pTHX_ SV *sv)
4835 if (ckWARN_d(WARN_DEBUGGING))
4836 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
4837 "Attempt to free temp prematurely: SV 0x%"UVxf
4838 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
4842 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
4843 /* make sure SvREFCNT(sv)==0 happens very seldom */
4844 SvREFCNT(sv) = (~(U32)0)/2;
4855 Returns the length of the string in the SV. Handles magic and type
4856 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
4862 Perl_sv_len(pTHX_ register SV *sv)
4870 len = mg_length(sv);
4872 (void)SvPV_const(sv, len);
4877 =for apidoc sv_len_utf8
4879 Returns the number of characters in the string in an SV, counting wide
4880 UTF-8 bytes as a single character. Handles magic and type coercion.
4886 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
4887 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
4888 * (Note that the mg_len is not the length of the mg_ptr field.)
4893 Perl_sv_len_utf8(pTHX_ register SV *sv)
4899 return mg_length(sv);
4903 const U8 *s = (U8*)SvPV_const(sv, len);
4904 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
4906 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
4908 #ifdef PERL_UTF8_CACHE_ASSERT
4909 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
4913 ulen = Perl_utf8_length(aTHX_ s, s + len);
4914 if (!mg && !SvREADONLY(sv)) {
4915 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
4916 mg = mg_find(sv, PERL_MAGIC_utf8);
4926 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
4927 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4928 * between UTF-8 and byte offsets. There are two (substr offset and substr
4929 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
4930 * and byte offset) cache positions.
4932 * The mg_len field is used by sv_len_utf8(), see its comments.
4933 * Note that the mg_len is not the length of the mg_ptr field.
4937 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
4938 I32 offsetp, const U8 *s, const U8 *start)
4942 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4944 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
4948 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4950 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
4951 (*mgp)->mg_ptr = (char *) *cachep;
4955 (*cachep)[i] = offsetp;
4956 (*cachep)[i+1] = s - start;
4964 * S_utf8_mg_pos() is used to query and update mg_ptr field of
4965 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
4966 * between UTF-8 and byte offsets. See also the comments of
4967 * S_utf8_mg_pos_init().
4971 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)
4975 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
4977 *mgp = mg_find(sv, PERL_MAGIC_utf8);
4978 if (*mgp && (*mgp)->mg_ptr) {
4979 *cachep = (STRLEN *) (*mgp)->mg_ptr;
4980 ASSERT_UTF8_CACHE(*cachep);
4981 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
4983 else { /* We will skip to the right spot. */
4988 /* The assumption is that going backward is half
4989 * the speed of going forward (that's where the
4990 * 2 * backw in the below comes from). (The real
4991 * figure of course depends on the UTF-8 data.) */
4993 if ((*cachep)[i] > (STRLEN)uoff) {
4995 backw = (*cachep)[i] - (STRLEN)uoff;
4997 if (forw < 2 * backw)
5000 p = start + (*cachep)[i+1];
5002 /* Try this only for the substr offset (i == 0),
5003 * not for the substr length (i == 2). */
5004 else if (i == 0) { /* (*cachep)[i] < uoff */
5005 const STRLEN ulen = sv_len_utf8(sv);
5007 if ((STRLEN)uoff < ulen) {
5008 forw = (STRLEN)uoff - (*cachep)[i];
5009 backw = ulen - (STRLEN)uoff;
5011 if (forw < 2 * backw)
5012 p = start + (*cachep)[i+1];
5017 /* If the string is not long enough for uoff,
5018 * we could extend it, but not at this low a level. */
5022 if (forw < 2 * backw) {
5029 while (UTF8_IS_CONTINUATION(*p))
5034 /* Update the cache. */
5035 (*cachep)[i] = (STRLEN)uoff;
5036 (*cachep)[i+1] = p - start;
5038 /* Drop the stale "length" cache */
5047 if (found) { /* Setup the return values. */
5048 *offsetp = (*cachep)[i+1];
5049 *sp = start + *offsetp;
5052 *offsetp = send - start;
5054 else if (*sp < start) {
5060 #ifdef PERL_UTF8_CACHE_ASSERT
5065 while (n-- && s < send)
5069 assert(*offsetp == s - start);
5070 assert((*cachep)[0] == (STRLEN)uoff);
5071 assert((*cachep)[1] == *offsetp);
5073 ASSERT_UTF8_CACHE(*cachep);
5082 =for apidoc sv_pos_u2b
5084 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5085 the start of the string, to a count of the equivalent number of bytes; if
5086 lenp is non-zero, it does the same to lenp, but this time starting from
5087 the offset, rather than from the start of the string. Handles magic and
5094 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5095 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5096 * byte offsets. See also the comments of S_utf8_mg_pos().
5101 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5109 start = (U8*)SvPV_const(sv, len);
5113 const U8 *s = start;
5114 I32 uoffset = *offsetp;
5115 const U8 * const send = s + len;
5119 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5121 if (!found && uoffset > 0) {
5122 while (s < send && uoffset--)
5126 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5128 *offsetp = s - start;
5133 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5137 if (!found && *lenp > 0) {
5140 while (s < send && ulen--)
5144 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5148 ASSERT_UTF8_CACHE(cache);
5160 =for apidoc sv_pos_b2u
5162 Converts the value pointed to by offsetp from a count of bytes from the
5163 start of the string, to a count of the equivalent number of UTF-8 chars.
5164 Handles magic and type coercion.
5170 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5171 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5172 * byte offsets. See also the comments of S_utf8_mg_pos().
5177 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5185 s = (const U8*)SvPV_const(sv, len);
5186 if ((I32)len < *offsetp)
5187 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5189 const U8* send = s + *offsetp;
5191 STRLEN *cache = NULL;
5195 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5196 mg = mg_find(sv, PERL_MAGIC_utf8);
5197 if (mg && mg->mg_ptr) {
5198 cache = (STRLEN *) mg->mg_ptr;
5199 if (cache[1] == (STRLEN)*offsetp) {
5200 /* An exact match. */
5201 *offsetp = cache[0];
5205 else if (cache[1] < (STRLEN)*offsetp) {
5206 /* We already know part of the way. */
5209 /* Let the below loop do the rest. */
5211 else { /* cache[1] > *offsetp */
5212 /* We already know all of the way, now we may
5213 * be able to walk back. The same assumption
5214 * is made as in S_utf8_mg_pos(), namely that
5215 * walking backward is twice slower than
5216 * walking forward. */
5217 const STRLEN forw = *offsetp;
5218 STRLEN backw = cache[1] - *offsetp;
5220 if (!(forw < 2 * backw)) {
5221 const U8 *p = s + cache[1];
5228 while (UTF8_IS_CONTINUATION(*p)) {
5236 *offsetp = cache[0];
5238 /* Drop the stale "length" cache */
5246 ASSERT_UTF8_CACHE(cache);
5252 /* Call utf8n_to_uvchr() to validate the sequence
5253 * (unless a simple non-UTF character) */
5254 if (!UTF8_IS_INVARIANT(*s))
5255 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5264 if (!SvREADONLY(sv)) {
5266 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5267 mg = mg_find(sv, PERL_MAGIC_utf8);
5272 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5273 mg->mg_ptr = (char *) cache;
5278 cache[1] = *offsetp;
5279 /* Drop the stale "length" cache */
5292 Returns a boolean indicating whether the strings in the two SVs are
5293 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5294 coerce its args to strings if necessary.
5300 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5308 SV* svrecode = Nullsv;
5315 pv1 = SvPV_const(sv1, cur1);
5322 pv2 = SvPV_const(sv2, cur2);
5324 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5325 /* Differing utf8ness.
5326 * Do not UTF8size the comparands as a side-effect. */
5329 svrecode = newSVpvn(pv2, cur2);
5330 sv_recode_to_utf8(svrecode, PL_encoding);
5331 pv2 = SvPV_const(svrecode, cur2);
5334 svrecode = newSVpvn(pv1, cur1);
5335 sv_recode_to_utf8(svrecode, PL_encoding);
5336 pv1 = SvPV_const(svrecode, cur1);
5338 /* Now both are in UTF-8. */
5340 SvREFCNT_dec(svrecode);
5345 bool is_utf8 = TRUE;
5348 /* sv1 is the UTF-8 one,
5349 * if is equal it must be downgrade-able */
5350 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5356 /* sv2 is the UTF-8 one,
5357 * if is equal it must be downgrade-able */
5358 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5364 /* Downgrade not possible - cannot be eq */
5372 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5375 SvREFCNT_dec(svrecode);
5386 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5387 string in C<sv1> is less than, equal to, or greater than the string in
5388 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5389 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5395 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5398 const char *pv1, *pv2;
5401 SV *svrecode = Nullsv;
5408 pv1 = SvPV_const(sv1, cur1);
5415 pv2 = SvPV_const(sv2, cur2);
5417 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5418 /* Differing utf8ness.
5419 * Do not UTF8size the comparands as a side-effect. */
5422 svrecode = newSVpvn(pv2, cur2);
5423 sv_recode_to_utf8(svrecode, PL_encoding);
5424 pv2 = SvPV_const(svrecode, cur2);
5427 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5432 svrecode = newSVpvn(pv1, cur1);
5433 sv_recode_to_utf8(svrecode, PL_encoding);
5434 pv1 = SvPV_const(svrecode, cur1);
5437 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5443 cmp = cur2 ? -1 : 0;
5447 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5450 cmp = retval < 0 ? -1 : 1;
5451 } else if (cur1 == cur2) {
5454 cmp = cur1 < cur2 ? -1 : 1;
5459 SvREFCNT_dec(svrecode);
5468 =for apidoc sv_cmp_locale
5470 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5471 'use bytes' aware, handles get magic, and will coerce its args to strings
5472 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5478 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5480 #ifdef USE_LOCALE_COLLATE
5486 if (PL_collation_standard)
5490 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5492 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5494 if (!pv1 || !len1) {
5505 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5508 return retval < 0 ? -1 : 1;
5511 * When the result of collation is equality, that doesn't mean
5512 * that there are no differences -- some locales exclude some
5513 * characters from consideration. So to avoid false equalities,
5514 * we use the raw string as a tiebreaker.
5520 #endif /* USE_LOCALE_COLLATE */
5522 return sv_cmp(sv1, sv2);
5526 #ifdef USE_LOCALE_COLLATE
5529 =for apidoc sv_collxfrm
5531 Add Collate Transform magic to an SV if it doesn't already have it.
5533 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5534 scalar data of the variable, but transformed to such a format that a normal
5535 memory comparison can be used to compare the data according to the locale
5542 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5546 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5547 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5553 Safefree(mg->mg_ptr);
5554 s = SvPV_const(sv, len);
5555 if ((xf = mem_collxfrm(s, len, &xlen))) {
5556 if (SvREADONLY(sv)) {
5559 return xf + sizeof(PL_collation_ix);
5562 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5563 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5576 if (mg && mg->mg_ptr) {
5578 return mg->mg_ptr + sizeof(PL_collation_ix);
5586 #endif /* USE_LOCALE_COLLATE */
5591 Get a line from the filehandle and store it into the SV, optionally
5592 appending to the currently-stored string.
5598 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5602 register STDCHAR rslast;
5603 register STDCHAR *bp;
5609 if (SvTHINKFIRST(sv))
5610 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5611 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5613 However, perlbench says it's slower, because the existing swipe code
5614 is faster than copy on write.
5615 Swings and roundabouts. */
5616 SvUPGRADE(sv, SVt_PV);
5621 if (PerlIO_isutf8(fp)) {
5623 sv_utf8_upgrade_nomg(sv);
5624 sv_pos_u2b(sv,&append,0);
5626 } else if (SvUTF8(sv)) {
5627 SV * const tsv = NEWSV(0,0);
5628 sv_gets(tsv, fp, 0);
5629 sv_utf8_upgrade_nomg(tsv);
5630 SvCUR_set(sv,append);
5633 goto return_string_or_null;
5638 if (PerlIO_isutf8(fp))
5641 if (IN_PERL_COMPILETIME) {
5642 /* we always read code in line mode */
5646 else if (RsSNARF(PL_rs)) {
5647 /* If it is a regular disk file use size from stat() as estimate
5648 of amount we are going to read - may result in malloc-ing
5649 more memory than we realy need if layers bellow reduce
5650 size we read (e.g. CRLF or a gzip layer)
5653 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5654 const Off_t offset = PerlIO_tell(fp);
5655 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5656 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5662 else if (RsRECORD(PL_rs)) {
5666 /* Grab the size of the record we're getting */
5667 recsize = SvIV(SvRV(PL_rs));
5668 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5671 /* VMS wants read instead of fread, because fread doesn't respect */
5672 /* RMS record boundaries. This is not necessarily a good thing to be */
5673 /* doing, but we've got no other real choice - except avoid stdio
5674 as implementation - perhaps write a :vms layer ?
5676 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5678 bytesread = PerlIO_read(fp, buffer, recsize);
5682 SvCUR_set(sv, bytesread += append);
5683 buffer[bytesread] = '\0';
5684 goto return_string_or_null;
5686 else if (RsPARA(PL_rs)) {
5692 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5693 if (PerlIO_isutf8(fp)) {
5694 rsptr = SvPVutf8(PL_rs, rslen);
5697 if (SvUTF8(PL_rs)) {
5698 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5699 Perl_croak(aTHX_ "Wide character in $/");
5702 rsptr = SvPV_const(PL_rs, rslen);
5706 rslast = rslen ? rsptr[rslen - 1] : '\0';
5708 if (rspara) { /* have to do this both before and after */
5709 do { /* to make sure file boundaries work right */
5712 i = PerlIO_getc(fp);
5716 PerlIO_ungetc(fp,i);
5722 /* See if we know enough about I/O mechanism to cheat it ! */
5724 /* This used to be #ifdef test - it is made run-time test for ease
5725 of abstracting out stdio interface. One call should be cheap
5726 enough here - and may even be a macro allowing compile
5730 if (PerlIO_fast_gets(fp)) {
5733 * We're going to steal some values from the stdio struct
5734 * and put EVERYTHING in the innermost loop into registers.
5736 register STDCHAR *ptr;
5740 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5741 /* An ungetc()d char is handled separately from the regular
5742 * buffer, so we getc() it back out and stuff it in the buffer.
5744 i = PerlIO_getc(fp);
5745 if (i == EOF) return 0;
5746 *(--((*fp)->_ptr)) = (unsigned char) i;
5750 /* Here is some breathtakingly efficient cheating */
5752 cnt = PerlIO_get_cnt(fp); /* get count into register */
5753 /* make sure we have the room */
5754 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5755 /* Not room for all of it
5756 if we are looking for a separator and room for some
5758 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5759 /* just process what we have room for */
5760 shortbuffered = cnt - SvLEN(sv) + append + 1;
5761 cnt -= shortbuffered;
5765 /* remember that cnt can be negative */
5766 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5771 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5772 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5773 DEBUG_P(PerlIO_printf(Perl_debug_log,
5774 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5775 DEBUG_P(PerlIO_printf(Perl_debug_log,
5776 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5777 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5778 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
5783 while (cnt > 0) { /* this | eat */
5785 if ((*bp++ = *ptr++) == rslast) /* really | dust */
5786 goto thats_all_folks; /* screams | sed :-) */
5790 Copy(ptr, bp, cnt, char); /* this | eat */
5791 bp += cnt; /* screams | dust */
5792 ptr += cnt; /* louder | sed :-) */
5797 if (shortbuffered) { /* oh well, must extend */
5798 cnt = shortbuffered;
5800 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5802 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
5803 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5807 DEBUG_P(PerlIO_printf(Perl_debug_log,
5808 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
5809 PTR2UV(ptr),(long)cnt));
5810 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
5812 DEBUG_P(PerlIO_printf(Perl_debug_log,
5813 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5814 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5815 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5817 /* This used to call 'filbuf' in stdio form, but as that behaves like
5818 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
5819 another abstraction. */
5820 i = PerlIO_getc(fp); /* get more characters */
5822 DEBUG_P(PerlIO_printf(Perl_debug_log,
5823 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5824 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5825 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5827 cnt = PerlIO_get_cnt(fp);
5828 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
5829 DEBUG_P(PerlIO_printf(Perl_debug_log,
5830 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5832 if (i == EOF) /* all done for ever? */
5833 goto thats_really_all_folks;
5835 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
5837 SvGROW(sv, bpx + cnt + 2);
5838 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
5840 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
5842 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
5843 goto thats_all_folks;
5847 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
5848 memNE((char*)bp - rslen, rsptr, rslen))
5849 goto screamer; /* go back to the fray */
5850 thats_really_all_folks:
5852 cnt += shortbuffered;
5853 DEBUG_P(PerlIO_printf(Perl_debug_log,
5854 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5855 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
5856 DEBUG_P(PerlIO_printf(Perl_debug_log,
5857 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5858 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5859 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
5861 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
5862 DEBUG_P(PerlIO_printf(Perl_debug_log,
5863 "Screamer: done, len=%ld, string=|%.*s|\n",
5864 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
5868 /*The big, slow, and stupid way. */
5869 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
5871 Newx(buf, 8192, STDCHAR);
5879 register const STDCHAR * const bpe = buf + sizeof(buf);
5881 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
5882 ; /* keep reading */
5886 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
5887 /* Accomodate broken VAXC compiler, which applies U8 cast to
5888 * both args of ?: operator, causing EOF to change into 255
5891 i = (U8)buf[cnt - 1];
5897 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
5899 sv_catpvn(sv, (char *) buf, cnt);
5901 sv_setpvn(sv, (char *) buf, cnt);
5903 if (i != EOF && /* joy */
5905 SvCUR(sv) < rslen ||
5906 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
5910 * If we're reading from a TTY and we get a short read,
5911 * indicating that the user hit his EOF character, we need
5912 * to notice it now, because if we try to read from the TTY
5913 * again, the EOF condition will disappear.
5915 * The comparison of cnt to sizeof(buf) is an optimization
5916 * that prevents unnecessary calls to feof().
5920 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
5924 #ifdef USE_HEAP_INSTEAD_OF_STACK
5929 if (rspara) { /* have to do this both before and after */
5930 while (i != EOF) { /* to make sure file boundaries work right */
5931 i = PerlIO_getc(fp);
5933 PerlIO_ungetc(fp,i);
5939 return_string_or_null:
5940 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
5946 Auto-increment of the value in the SV, doing string to numeric conversion
5947 if necessary. Handles 'get' magic.
5953 Perl_sv_inc(pTHX_ register SV *sv)
5961 if (SvTHINKFIRST(sv)) {
5963 sv_force_normal_flags(sv, 0);
5964 if (SvREADONLY(sv)) {
5965 if (IN_PERL_RUNTIME)
5966 Perl_croak(aTHX_ PL_no_modify);
5970 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
5972 i = PTR2IV(SvRV(sv));
5977 flags = SvFLAGS(sv);
5978 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
5979 /* It's (privately or publicly) a float, but not tested as an
5980 integer, so test it to see. */
5982 flags = SvFLAGS(sv);
5984 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
5985 /* It's publicly an integer, or privately an integer-not-float */
5986 #ifdef PERL_PRESERVE_IVUV
5990 if (SvUVX(sv) == UV_MAX)
5991 sv_setnv(sv, UV_MAX_P1);
5993 (void)SvIOK_only_UV(sv);
5994 SvUV_set(sv, SvUVX(sv) + 1);
5996 if (SvIVX(sv) == IV_MAX)
5997 sv_setuv(sv, (UV)IV_MAX + 1);
5999 (void)SvIOK_only(sv);
6000 SvIV_set(sv, SvIVX(sv) + 1);
6005 if (flags & SVp_NOK) {
6006 (void)SvNOK_only(sv);
6007 SvNV_set(sv, SvNVX(sv) + 1.0);
6011 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6012 if ((flags & SVTYPEMASK) < SVt_PVIV)
6013 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6014 (void)SvIOK_only(sv);
6019 while (isALPHA(*d)) d++;
6020 while (isDIGIT(*d)) d++;
6022 #ifdef PERL_PRESERVE_IVUV
6023 /* Got to punt this as an integer if needs be, but we don't issue
6024 warnings. Probably ought to make the sv_iv_please() that does
6025 the conversion if possible, and silently. */
6026 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6027 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6028 /* Need to try really hard to see if it's an integer.
6029 9.22337203685478e+18 is an integer.
6030 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6031 so $a="9.22337203685478e+18"; $a+0; $a++
6032 needs to be the same as $a="9.22337203685478e+18"; $a++
6039 /* sv_2iv *should* have made this an NV */
6040 if (flags & SVp_NOK) {
6041 (void)SvNOK_only(sv);
6042 SvNV_set(sv, SvNVX(sv) + 1.0);
6045 /* I don't think we can get here. Maybe I should assert this
6046 And if we do get here I suspect that sv_setnv will croak. NWC
6048 #if defined(USE_LONG_DOUBLE)
6049 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",
6050 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6052 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6053 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6056 #endif /* PERL_PRESERVE_IVUV */
6057 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6061 while (d >= SvPVX_const(sv)) {
6069 /* MKS: The original code here died if letters weren't consecutive.
6070 * at least it didn't have to worry about non-C locales. The
6071 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6072 * arranged in order (although not consecutively) and that only
6073 * [A-Za-z] are accepted by isALPHA in the C locale.
6075 if (*d != 'z' && *d != 'Z') {
6076 do { ++*d; } while (!isALPHA(*d));
6079 *(d--) -= 'z' - 'a';
6084 *(d--) -= 'z' - 'a' + 1;
6088 /* oh,oh, the number grew */
6089 SvGROW(sv, SvCUR(sv) + 2);
6090 SvCUR_set(sv, SvCUR(sv) + 1);
6091 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6102 Auto-decrement of the value in the SV, doing string to numeric conversion
6103 if necessary. Handles 'get' magic.
6109 Perl_sv_dec(pTHX_ register SV *sv)
6116 if (SvTHINKFIRST(sv)) {
6118 sv_force_normal_flags(sv, 0);
6119 if (SvREADONLY(sv)) {
6120 if (IN_PERL_RUNTIME)
6121 Perl_croak(aTHX_ PL_no_modify);
6125 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6127 i = PTR2IV(SvRV(sv));
6132 /* Unlike sv_inc we don't have to worry about string-never-numbers
6133 and keeping them magic. But we mustn't warn on punting */
6134 flags = SvFLAGS(sv);
6135 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6136 /* It's publicly an integer, or privately an integer-not-float */
6137 #ifdef PERL_PRESERVE_IVUV
6141 if (SvUVX(sv) == 0) {
6142 (void)SvIOK_only(sv);
6146 (void)SvIOK_only_UV(sv);
6147 SvUV_set(sv, SvUVX(sv) - 1);
6150 if (SvIVX(sv) == IV_MIN)
6151 sv_setnv(sv, (NV)IV_MIN - 1.0);
6153 (void)SvIOK_only(sv);
6154 SvIV_set(sv, SvIVX(sv) - 1);
6159 if (flags & SVp_NOK) {
6160 SvNV_set(sv, SvNVX(sv) - 1.0);
6161 (void)SvNOK_only(sv);
6164 if (!(flags & SVp_POK)) {
6165 if ((flags & SVTYPEMASK) < SVt_PVIV)
6166 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6168 (void)SvIOK_only(sv);
6171 #ifdef PERL_PRESERVE_IVUV
6173 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6174 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6175 /* Need to try really hard to see if it's an integer.
6176 9.22337203685478e+18 is an integer.
6177 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6178 so $a="9.22337203685478e+18"; $a+0; $a--
6179 needs to be the same as $a="9.22337203685478e+18"; $a--
6186 /* sv_2iv *should* have made this an NV */
6187 if (flags & SVp_NOK) {
6188 (void)SvNOK_only(sv);
6189 SvNV_set(sv, SvNVX(sv) - 1.0);
6192 /* I don't think we can get here. Maybe I should assert this
6193 And if we do get here I suspect that sv_setnv will croak. NWC
6195 #if defined(USE_LONG_DOUBLE)
6196 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",
6197 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6199 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6200 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6204 #endif /* PERL_PRESERVE_IVUV */
6205 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6209 =for apidoc sv_mortalcopy
6211 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6212 The new SV is marked as mortal. It will be destroyed "soon", either by an
6213 explicit call to FREETMPS, or by an implicit call at places such as
6214 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6219 /* Make a string that will exist for the duration of the expression
6220 * evaluation. Actually, it may have to last longer than that, but
6221 * hopefully we won't free it until it has been assigned to a
6222 * permanent location. */
6225 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6230 sv_setsv(sv,oldstr);
6232 PL_tmps_stack[++PL_tmps_ix] = sv;
6238 =for apidoc sv_newmortal
6240 Creates a new null SV which is mortal. The reference count of the SV is
6241 set to 1. It will be destroyed "soon", either by an explicit call to
6242 FREETMPS, or by an implicit call at places such as statement boundaries.
6243 See also C<sv_mortalcopy> and C<sv_2mortal>.
6249 Perl_sv_newmortal(pTHX)
6254 SvFLAGS(sv) = SVs_TEMP;
6256 PL_tmps_stack[++PL_tmps_ix] = sv;
6261 =for apidoc sv_2mortal
6263 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6264 by an explicit call to FREETMPS, or by an implicit call at places such as
6265 statement boundaries. SvTEMP() is turned on which means that the SV's
6266 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6267 and C<sv_mortalcopy>.
6273 Perl_sv_2mortal(pTHX_ register SV *sv)
6278 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6281 PL_tmps_stack[++PL_tmps_ix] = sv;
6289 Creates a new SV and copies a string into it. The reference count for the
6290 SV is set to 1. If C<len> is zero, Perl will compute the length using
6291 strlen(). For efficiency, consider using C<newSVpvn> instead.
6297 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6302 sv_setpvn(sv,s,len ? len : strlen(s));
6307 =for apidoc newSVpvn
6309 Creates a new SV and copies a string into it. The reference count for the
6310 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6311 string. You are responsible for ensuring that the source string is at least
6312 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6318 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6323 sv_setpvn(sv,s,len);
6329 =for apidoc newSVhek
6331 Creates a new SV from the hash key structure. It will generate scalars that
6332 point to the shared string table where possible. Returns a new (undefined)
6333 SV if the hek is NULL.
6339 Perl_newSVhek(pTHX_ const HEK *hek)
6348 if (HEK_LEN(hek) == HEf_SVKEY) {
6349 return newSVsv(*(SV**)HEK_KEY(hek));
6351 const int flags = HEK_FLAGS(hek);
6352 if (flags & HVhek_WASUTF8) {
6354 Andreas would like keys he put in as utf8 to come back as utf8
6356 STRLEN utf8_len = HEK_LEN(hek);
6357 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6358 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6361 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6363 } else if (flags & HVhek_REHASH) {
6364 /* We don't have a pointer to the hv, so we have to replicate the
6365 flag into every HEK. This hv is using custom a hasing
6366 algorithm. Hence we can't return a shared string scalar, as
6367 that would contain the (wrong) hash value, and might get passed
6368 into an hv routine with a regular hash */
6370 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6375 /* This will be overwhelminly the most common case. */
6376 return newSVpvn_share(HEK_KEY(hek),
6377 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6383 =for apidoc newSVpvn_share
6385 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6386 table. If the string does not already exist in the table, it is created
6387 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6388 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6389 otherwise the hash is computed. The idea here is that as the string table
6390 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6391 hash lookup will avoid string compare.
6397 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6400 bool is_utf8 = FALSE;
6402 STRLEN tmplen = -len;
6404 /* See the note in hv.c:hv_fetch() --jhi */
6405 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6409 PERL_HASH(hash, src, len);
6411 sv_upgrade(sv, SVt_PV);
6412 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6424 #if defined(PERL_IMPLICIT_CONTEXT)
6426 /* pTHX_ magic can't cope with varargs, so this is a no-context
6427 * version of the main function, (which may itself be aliased to us).
6428 * Don't access this version directly.
6432 Perl_newSVpvf_nocontext(const char* pat, ...)
6437 va_start(args, pat);
6438 sv = vnewSVpvf(pat, &args);
6445 =for apidoc newSVpvf
6447 Creates a new SV and initializes it with the string formatted like
6454 Perl_newSVpvf(pTHX_ const char* pat, ...)
6458 va_start(args, pat);
6459 sv = vnewSVpvf(pat, &args);
6464 /* backend for newSVpvf() and newSVpvf_nocontext() */
6467 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6471 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6478 Creates a new SV and copies a floating point value into it.
6479 The reference count for the SV is set to 1.
6485 Perl_newSVnv(pTHX_ NV n)
6497 Creates a new SV and copies an integer into it. The reference count for the
6504 Perl_newSViv(pTHX_ IV i)
6516 Creates a new SV and copies an unsigned integer into it.
6517 The reference count for the SV is set to 1.
6523 Perl_newSVuv(pTHX_ UV u)
6533 =for apidoc newRV_noinc
6535 Creates an RV wrapper for an SV. The reference count for the original
6536 SV is B<not> incremented.
6542 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6547 sv_upgrade(sv, SVt_RV);
6549 SvRV_set(sv, tmpRef);
6554 /* newRV_inc is the official function name to use now.
6555 * newRV_inc is in fact #defined to newRV in sv.h
6559 Perl_newRV(pTHX_ SV *tmpRef)
6561 return newRV_noinc(SvREFCNT_inc(tmpRef));
6567 Creates a new SV which is an exact duplicate of the original SV.
6574 Perl_newSVsv(pTHX_ register SV *old)
6580 if (SvTYPE(old) == SVTYPEMASK) {
6581 if (ckWARN_d(WARN_INTERNAL))
6582 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6586 /* SV_GMAGIC is the default for sv_setv()
6587 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6588 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6589 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6594 =for apidoc sv_reset
6596 Underlying implementation for the C<reset> Perl function.
6597 Note that the perl-level function is vaguely deprecated.
6603 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6606 char todo[PERL_UCHAR_MAX+1];
6611 if (!*s) { /* reset ?? searches */
6612 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6614 PMOP *pm = (PMOP *) mg->mg_obj;
6616 pm->op_pmdynflags &= ~PMdf_USED;
6623 /* reset variables */
6625 if (!HvARRAY(stash))
6628 Zero(todo, 256, char);
6631 I32 i = (unsigned char)*s;
6635 max = (unsigned char)*s++;
6636 for ( ; i <= max; i++) {
6639 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6641 for (entry = HvARRAY(stash)[i];
6643 entry = HeNEXT(entry))
6648 if (!todo[(U8)*HeKEY(entry)])
6650 gv = (GV*)HeVAL(entry);
6653 if (SvTHINKFIRST(sv)) {
6654 if (!SvREADONLY(sv) && SvROK(sv))
6656 /* XXX Is this continue a bug? Why should THINKFIRST
6657 exempt us from resetting arrays and hashes? */
6661 if (SvTYPE(sv) >= SVt_PV) {
6663 if (SvPVX_const(sv) != Nullch)
6671 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6673 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6676 # if defined(USE_ENVIRON_ARRAY)
6679 # endif /* USE_ENVIRON_ARRAY */
6690 Using various gambits, try to get an IO from an SV: the IO slot if its a
6691 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6692 named after the PV if we're a string.
6698 Perl_sv_2io(pTHX_ SV *sv)
6703 switch (SvTYPE(sv)) {
6711 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6715 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6717 return sv_2io(SvRV(sv));
6718 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6724 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6733 Using various gambits, try to get a CV from an SV; in addition, try if
6734 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6735 The flags in C<lref> are passed to sv_fetchsv.
6741 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6748 return *st = NULL, *gvp = Nullgv, Nullcv;
6749 switch (SvTYPE(sv)) {
6768 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6769 tryAMAGICunDEREF(to_cv);
6772 if (SvTYPE(sv) == SVt_PVCV) {
6781 Perl_croak(aTHX_ "Not a subroutine reference");
6786 gv = gv_fetchsv(sv, lref, SVt_PVCV);
6792 /* Some flags to gv_fetchsv mean don't really create the GV */
6793 if (SvTYPE(gv) != SVt_PVGV) {
6799 if (lref && !GvCVu(gv)) {
6802 tmpsv = NEWSV(704,0);
6803 gv_efullname3(tmpsv, gv, Nullch);
6804 /* XXX this is probably not what they think they're getting.
6805 * It has the same effect as "sub name;", i.e. just a forward
6807 newSUB(start_subparse(FALSE, 0),
6808 newSVOP(OP_CONST, 0, tmpsv),
6813 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
6823 Returns true if the SV has a true value by Perl's rules.
6824 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
6825 instead use an in-line version.
6831 Perl_sv_true(pTHX_ register SV *sv)
6836 register const XPV* const tXpv = (XPV*)SvANY(sv);
6838 (tXpv->xpv_cur > 1 ||
6839 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
6846 return SvIVX(sv) != 0;
6849 return SvNVX(sv) != 0.0;
6851 return sv_2bool(sv);
6857 =for apidoc sv_pvn_force
6859 Get a sensible string out of the SV somehow.
6860 A private implementation of the C<SvPV_force> macro for compilers which
6861 can't cope with complex macro expressions. Always use the macro instead.
6863 =for apidoc sv_pvn_force_flags
6865 Get a sensible string out of the SV somehow.
6866 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
6867 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
6868 implemented in terms of this function.
6869 You normally want to use the various wrapper macros instead: see
6870 C<SvPV_force> and C<SvPV_force_nomg>
6876 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
6879 if (SvTHINKFIRST(sv) && !SvROK(sv))
6880 sv_force_normal_flags(sv, 0);
6890 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
6891 const char * const ref = sv_reftype(sv,0);
6893 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
6894 ref, OP_NAME(PL_op));
6896 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
6898 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
6899 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
6901 s = sv_2pv_flags(sv, &len, flags);
6905 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
6908 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
6909 SvGROW(sv, len + 1);
6910 Move(s,SvPVX(sv),len,char);
6915 SvPOK_on(sv); /* validate pointer */
6917 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
6918 PTR2UV(sv),SvPVX_const(sv)));
6921 return SvPVX_mutable(sv);
6925 =for apidoc sv_pvbyten_force
6927 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
6933 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
6935 sv_pvn_force(sv,lp);
6936 sv_utf8_downgrade(sv,0);
6942 =for apidoc sv_pvutf8n_force
6944 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
6950 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
6952 sv_pvn_force(sv,lp);
6953 sv_utf8_upgrade(sv);
6959 =for apidoc sv_reftype
6961 Returns a string describing what the SV is a reference to.
6967 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
6969 /* The fact that I don't need to downcast to char * everywhere, only in ?:
6970 inside return suggests a const propagation bug in g++. */
6971 if (ob && SvOBJECT(sv)) {
6972 char * const name = HvNAME_get(SvSTASH(sv));
6973 return name ? name : (char *) "__ANON__";
6976 switch (SvTYPE(sv)) {
6993 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
6994 /* tied lvalues should appear to be
6995 * scalars for backwards compatitbility */
6996 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
6997 ? "SCALAR" : "LVALUE");
6998 case SVt_PVAV: return "ARRAY";
6999 case SVt_PVHV: return "HASH";
7000 case SVt_PVCV: return "CODE";
7001 case SVt_PVGV: return "GLOB";
7002 case SVt_PVFM: return "FORMAT";
7003 case SVt_PVIO: return "IO";
7004 default: return "UNKNOWN";
7010 =for apidoc sv_isobject
7012 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7013 object. If the SV is not an RV, or if the object is not blessed, then this
7020 Perl_sv_isobject(pTHX_ SV *sv)
7036 Returns a boolean indicating whether the SV is blessed into the specified
7037 class. This does not check for subtypes; use C<sv_derived_from> to verify
7038 an inheritance relationship.
7044 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7055 hvname = HvNAME_get(SvSTASH(sv));
7059 return strEQ(hvname, name);
7065 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7066 it will be upgraded to one. If C<classname> is non-null then the new SV will
7067 be blessed in the specified package. The new SV is returned and its
7068 reference count is 1.
7074 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7080 SV_CHECK_THINKFIRST_COW_DROP(rv);
7083 if (SvTYPE(rv) >= SVt_PVMG) {
7084 const U32 refcnt = SvREFCNT(rv);
7088 SvREFCNT(rv) = refcnt;
7091 if (SvTYPE(rv) < SVt_RV)
7092 sv_upgrade(rv, SVt_RV);
7093 else if (SvTYPE(rv) > SVt_RV) {
7104 HV* const stash = gv_stashpv(classname, TRUE);
7105 (void)sv_bless(rv, stash);
7111 =for apidoc sv_setref_pv
7113 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7114 argument will be upgraded to an RV. That RV will be modified to point to
7115 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7116 into the SV. The C<classname> argument indicates the package for the
7117 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7118 will have a reference count of 1, and the RV will be returned.
7120 Do not use with other Perl types such as HV, AV, SV, CV, because those
7121 objects will become corrupted by the pointer copy process.
7123 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7129 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7132 sv_setsv(rv, &PL_sv_undef);
7136 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7141 =for apidoc sv_setref_iv
7143 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7144 argument will be upgraded to an RV. That RV will be modified to point to
7145 the new SV. The C<classname> argument indicates the package for the
7146 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7147 will have a reference count of 1, and the RV will be returned.
7153 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7155 sv_setiv(newSVrv(rv,classname), iv);
7160 =for apidoc sv_setref_uv
7162 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7163 argument will be upgraded to an RV. That RV will be modified to point to
7164 the new SV. The C<classname> argument indicates the package for the
7165 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7166 will have a reference count of 1, and the RV will be returned.
7172 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7174 sv_setuv(newSVrv(rv,classname), uv);
7179 =for apidoc sv_setref_nv
7181 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7182 argument will be upgraded to an RV. That RV will be modified to point to
7183 the new SV. The C<classname> argument indicates the package for the
7184 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7185 will have a reference count of 1, and the RV will be returned.
7191 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7193 sv_setnv(newSVrv(rv,classname), nv);
7198 =for apidoc sv_setref_pvn
7200 Copies a string into a new SV, optionally blessing the SV. The length of the
7201 string must be specified with C<n>. The C<rv> argument will be upgraded to
7202 an RV. That RV will be modified to point to the new SV. The C<classname>
7203 argument indicates the package for the blessing. Set C<classname> to
7204 C<Nullch> to avoid the blessing. The new SV will have a reference count
7205 of 1, and the RV will be returned.
7207 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7213 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7215 sv_setpvn(newSVrv(rv,classname), pv, n);
7220 =for apidoc sv_bless
7222 Blesses an SV into a specified package. The SV must be an RV. The package
7223 must be designated by its stash (see C<gv_stashpv()>). The reference count
7224 of the SV is unaffected.
7230 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7234 Perl_croak(aTHX_ "Can't bless non-reference value");
7236 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7237 if (SvREADONLY(tmpRef))
7238 Perl_croak(aTHX_ PL_no_modify);
7239 if (SvOBJECT(tmpRef)) {
7240 if (SvTYPE(tmpRef) != SVt_PVIO)
7242 SvREFCNT_dec(SvSTASH(tmpRef));
7245 SvOBJECT_on(tmpRef);
7246 if (SvTYPE(tmpRef) != SVt_PVIO)
7248 SvUPGRADE(tmpRef, SVt_PVMG);
7249 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7256 if(SvSMAGICAL(tmpRef))
7257 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7265 /* Downgrades a PVGV to a PVMG.
7269 S_sv_unglob(pTHX_ SV *sv)
7273 assert(SvTYPE(sv) == SVt_PVGV);
7278 sv_del_backref((SV*)GvSTASH(sv), sv);
7281 sv_unmagic(sv, PERL_MAGIC_glob);
7282 Safefree(GvNAME(sv));
7285 /* need to keep SvANY(sv) in the right arena */
7286 xpvmg = new_XPVMG();
7287 StructCopy(SvANY(sv), xpvmg, XPVMG);
7288 del_XPVGV(SvANY(sv));
7291 SvFLAGS(sv) &= ~SVTYPEMASK;
7292 SvFLAGS(sv) |= SVt_PVMG;
7296 =for apidoc sv_unref_flags
7298 Unsets the RV status of the SV, and decrements the reference count of
7299 whatever was being referenced by the RV. This can almost be thought of
7300 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7301 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7302 (otherwise the decrementing is conditional on the reference count being
7303 different from one or the reference being a readonly SV).
7310 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7312 SV* const target = SvRV(ref);
7314 if (SvWEAKREF(ref)) {
7315 sv_del_backref(target, ref);
7317 SvRV_set(ref, NULL);
7320 SvRV_set(ref, NULL);
7322 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7323 assigned to as BEGIN {$a = \"Foo"} will fail. */
7324 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7325 SvREFCNT_dec(target);
7326 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7327 sv_2mortal(target); /* Schedule for freeing later */
7331 =for apidoc sv_untaint
7333 Untaint an SV. Use C<SvTAINTED_off> instead.
7338 Perl_sv_untaint(pTHX_ SV *sv)
7340 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7341 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7348 =for apidoc sv_tainted
7350 Test an SV for taintedness. Use C<SvTAINTED> instead.
7355 Perl_sv_tainted(pTHX_ SV *sv)
7357 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7358 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7359 if (mg && (mg->mg_len & 1) )
7366 =for apidoc sv_setpviv
7368 Copies an integer into the given SV, also updating its string value.
7369 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7375 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7377 char buf[TYPE_CHARS(UV)];
7379 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7381 sv_setpvn(sv, ptr, ebuf - ptr);
7385 =for apidoc sv_setpviv_mg
7387 Like C<sv_setpviv>, but also handles 'set' magic.
7393 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7399 #if defined(PERL_IMPLICIT_CONTEXT)
7401 /* pTHX_ magic can't cope with varargs, so this is a no-context
7402 * version of the main function, (which may itself be aliased to us).
7403 * Don't access this version directly.
7407 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7411 va_start(args, pat);
7412 sv_vsetpvf(sv, pat, &args);
7416 /* pTHX_ magic can't cope with varargs, so this is a no-context
7417 * version of the main function, (which may itself be aliased to us).
7418 * Don't access this version directly.
7422 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7426 va_start(args, pat);
7427 sv_vsetpvf_mg(sv, pat, &args);
7433 =for apidoc sv_setpvf
7435 Works like C<sv_catpvf> but copies the text into the SV instead of
7436 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7442 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7445 va_start(args, pat);
7446 sv_vsetpvf(sv, pat, &args);
7451 =for apidoc sv_vsetpvf
7453 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7454 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7456 Usually used via its frontend C<sv_setpvf>.
7462 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7464 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7468 =for apidoc sv_setpvf_mg
7470 Like C<sv_setpvf>, but also handles 'set' magic.
7476 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7479 va_start(args, pat);
7480 sv_vsetpvf_mg(sv, pat, &args);
7485 =for apidoc sv_vsetpvf_mg
7487 Like C<sv_vsetpvf>, but also handles 'set' magic.
7489 Usually used via its frontend C<sv_setpvf_mg>.
7495 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7497 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7501 #if defined(PERL_IMPLICIT_CONTEXT)
7503 /* pTHX_ magic can't cope with varargs, so this is a no-context
7504 * version of the main function, (which may itself be aliased to us).
7505 * Don't access this version directly.
7509 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7513 va_start(args, pat);
7514 sv_vcatpvf(sv, pat, &args);
7518 /* pTHX_ magic can't cope with varargs, so this is a no-context
7519 * version of the main function, (which may itself be aliased to us).
7520 * Don't access this version directly.
7524 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7528 va_start(args, pat);
7529 sv_vcatpvf_mg(sv, pat, &args);
7535 =for apidoc sv_catpvf
7537 Processes its arguments like C<sprintf> and appends the formatted
7538 output to an SV. If the appended data contains "wide" characters
7539 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7540 and characters >255 formatted with %c), the original SV might get
7541 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7542 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7543 valid UTF-8; if the original SV was bytes, the pattern should be too.
7548 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7551 va_start(args, pat);
7552 sv_vcatpvf(sv, pat, &args);
7557 =for apidoc sv_vcatpvf
7559 Processes its arguments like C<vsprintf> and appends the formatted output
7560 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7562 Usually used via its frontend C<sv_catpvf>.
7568 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7570 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7574 =for apidoc sv_catpvf_mg
7576 Like C<sv_catpvf>, but also handles 'set' magic.
7582 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7585 va_start(args, pat);
7586 sv_vcatpvf_mg(sv, pat, &args);
7591 =for apidoc sv_vcatpvf_mg
7593 Like C<sv_vcatpvf>, but also handles 'set' magic.
7595 Usually used via its frontend C<sv_catpvf_mg>.
7601 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7603 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7608 =for apidoc sv_vsetpvfn
7610 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7613 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7619 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7621 sv_setpvn(sv, "", 0);
7622 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7626 S_expect_number(pTHX_ char** pattern)
7629 switch (**pattern) {
7630 case '1': case '2': case '3':
7631 case '4': case '5': case '6':
7632 case '7': case '8': case '9':
7633 var = *(*pattern)++ - '0';
7634 while (isDIGIT(**pattern)) {
7635 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7637 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7645 S_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;
7794 const I32 osvix = svix;
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 n = expect_number(&q);
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 ( (width = expect_number(&q)) ) {
7951 if ( (ewix = expect_number(&q)) )
7960 if ((vectorarg = asterisk)) {
7973 width = expect_number(&q);
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);
8006 /* if this is a version object, we need to convert
8007 * back into v-string notation and then let the
8008 * vectorize happen normally
8010 if (sv_derived_from(vecsv, "version")) {
8011 char *version = savesvpv(vecsv);
8012 vecsv = sv_newmortal();
8013 /* scan_vstring is expected to be called during
8014 * tokenization, so we need to fake up the end
8015 * of the buffer for it
8017 PL_bufend = version + veclen;
8018 scan_vstring(version, vecsv);
8019 vecstr = (U8*)SvPV_const(vecsv, veclen);
8020 vec_utf8 = DO_UTF8(vecsv);
8032 i = va_arg(*args, int);
8034 i = (ewix ? ewix <= svmax : svix < svmax) ?
8035 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8037 width = (i < 0) ? -i : i;
8047 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8049 /* XXX: todo, support specified precision parameter */
8053 i = va_arg(*args, int);
8055 i = (ewix ? ewix <= svmax : svix < svmax)
8056 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8057 precis = (i < 0) ? 0 : i;
8062 precis = precis * 10 + (*q++ - '0');
8071 case 'I': /* Ix, I32x, and I64x */
8073 if (q[1] == '6' && q[2] == '4') {
8079 if (q[1] == '3' && q[2] == '2') {
8089 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8100 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8101 if (*(q + 1) == 'l') { /* lld, llf */
8127 if (!vectorize && !args) {
8129 const I32 i = efix-1;
8130 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8132 argsv = (svix >= 0 && svix < svmax)
8133 ? svargs[svix++] : &PL_sv_undef;
8144 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8146 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8148 eptr = (char*)utf8buf;
8149 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8163 eptr = va_arg(*args, char*);
8165 #ifdef MACOS_TRADITIONAL
8166 /* On MacOS, %#s format is used for Pascal strings */
8171 elen = strlen(eptr);
8173 eptr = (char *)nullstr;
8174 elen = sizeof nullstr - 1;
8178 eptr = SvPVx_const(argsv, elen);
8179 if (DO_UTF8(argsv)) {
8180 if (has_precis && precis < elen) {
8182 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8185 if (width) { /* fudge width (can't fudge elen) */
8186 width += elen - sv_len_utf8(argsv);
8193 if (has_precis && elen > precis)
8200 if (alt || vectorize)
8202 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8223 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8232 esignbuf[esignlen++] = plus;
8236 case 'h': iv = (short)va_arg(*args, int); break;
8237 case 'l': iv = va_arg(*args, long); break;
8238 case 'V': iv = va_arg(*args, IV); break;
8239 default: iv = va_arg(*args, int); break;
8241 case 'q': iv = va_arg(*args, Quad_t); break;
8246 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8248 case 'h': iv = (short)tiv; break;
8249 case 'l': iv = (long)tiv; break;
8251 default: iv = tiv; break;
8253 case 'q': iv = (Quad_t)tiv; break;
8257 if ( !vectorize ) /* we already set uv above */
8262 esignbuf[esignlen++] = plus;
8266 esignbuf[esignlen++] = '-';
8309 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8320 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8321 case 'l': uv = va_arg(*args, unsigned long); break;
8322 case 'V': uv = va_arg(*args, UV); break;
8323 default: uv = va_arg(*args, unsigned); break;
8325 case 'q': uv = va_arg(*args, Uquad_t); break;
8330 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8332 case 'h': uv = (unsigned short)tuv; break;
8333 case 'l': uv = (unsigned long)tuv; break;
8335 default: uv = tuv; break;
8337 case 'q': uv = (Uquad_t)tuv; break;
8344 char *ptr = ebuf + sizeof ebuf;
8350 p = (char*)((c == 'X')
8351 ? "0123456789ABCDEF" : "0123456789abcdef");
8357 esignbuf[esignlen++] = '0';
8358 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8366 if (alt && *ptr != '0')
8377 esignbuf[esignlen++] = '0';
8378 esignbuf[esignlen++] = 'b';
8381 default: /* it had better be ten or less */
8385 } while (uv /= base);
8388 elen = (ebuf + sizeof ebuf) - ptr;
8392 zeros = precis - elen;
8393 else if (precis == 0 && elen == 1 && *eptr == '0')
8399 /* FLOATING POINT */
8402 c = 'f'; /* maybe %F isn't supported here */
8410 /* This is evil, but floating point is even more evil */
8412 /* for SV-style calling, we can only get NV
8413 for C-style calling, we assume %f is double;
8414 for simplicity we allow any of %Lf, %llf, %qf for long double
8418 #if defined(USE_LONG_DOUBLE)
8422 /* [perl #20339] - we should accept and ignore %lf rather than die */
8426 #if defined(USE_LONG_DOUBLE)
8427 intsize = args ? 0 : 'q';
8431 #if defined(HAS_LONG_DOUBLE)
8440 /* now we need (long double) if intsize == 'q', else (double) */
8442 #if LONG_DOUBLESIZE > DOUBLESIZE
8444 va_arg(*args, long double) :
8445 va_arg(*args, double)
8447 va_arg(*args, double)
8452 if (c != 'e' && c != 'E') {
8454 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8455 will cast our (long double) to (double) */
8456 (void)Perl_frexp(nv, &i);
8457 if (i == PERL_INT_MIN)
8458 Perl_die(aTHX_ "panic: frexp");
8460 need = BIT_DIGITS(i);
8462 need += has_precis ? precis : 6; /* known default */
8467 #ifdef HAS_LDBL_SPRINTF_BUG
8468 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8469 with sfio - Allen <allens@cpan.org> */
8472 # define MY_DBL_MAX DBL_MAX
8473 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8474 # if DOUBLESIZE >= 8
8475 # define MY_DBL_MAX 1.7976931348623157E+308L
8477 # define MY_DBL_MAX 3.40282347E+38L
8481 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8482 # define MY_DBL_MAX_BUG 1L
8484 # define MY_DBL_MAX_BUG MY_DBL_MAX
8488 # define MY_DBL_MIN DBL_MIN
8489 # else /* XXX guessing! -Allen */
8490 # if DOUBLESIZE >= 8
8491 # define MY_DBL_MIN 2.2250738585072014E-308L
8493 # define MY_DBL_MIN 1.17549435E-38L
8497 if ((intsize == 'q') && (c == 'f') &&
8498 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8500 /* it's going to be short enough that
8501 * long double precision is not needed */
8503 if ((nv <= 0L) && (nv >= -0L))
8504 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8506 /* would use Perl_fp_class as a double-check but not
8507 * functional on IRIX - see perl.h comments */
8509 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8510 /* It's within the range that a double can represent */
8511 #if defined(DBL_MAX) && !defined(DBL_MIN)
8512 if ((nv >= ((long double)1/DBL_MAX)) ||
8513 (nv <= (-(long double)1/DBL_MAX)))
8515 fix_ldbl_sprintf_bug = TRUE;
8518 if (fix_ldbl_sprintf_bug == TRUE) {
8528 # undef MY_DBL_MAX_BUG
8531 #endif /* HAS_LDBL_SPRINTF_BUG */
8533 need += 20; /* fudge factor */
8534 if (PL_efloatsize < need) {
8535 Safefree(PL_efloatbuf);
8536 PL_efloatsize = need + 20; /* more fudge */
8537 Newx(PL_efloatbuf, PL_efloatsize, char);
8538 PL_efloatbuf[0] = '\0';
8541 if ( !(width || left || plus || alt) && fill != '0'
8542 && has_precis && intsize != 'q' ) { /* Shortcuts */
8543 /* See earlier comment about buggy Gconvert when digits,
8545 if ( c == 'g' && precis) {
8546 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8547 /* May return an empty string for digits==0 */
8548 if (*PL_efloatbuf) {
8549 elen = strlen(PL_efloatbuf);
8550 goto float_converted;
8552 } else if ( c == 'f' && !precis) {
8553 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8558 char *ptr = ebuf + sizeof ebuf;
8561 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8562 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8563 if (intsize == 'q') {
8564 /* Copy the one or more characters in a long double
8565 * format before the 'base' ([efgEFG]) character to
8566 * the format string. */
8567 static char const prifldbl[] = PERL_PRIfldbl;
8568 char const *p = prifldbl + sizeof(prifldbl) - 3;
8569 while (p >= prifldbl) { *--ptr = *p--; }
8574 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8579 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8591 /* No taint. Otherwise we are in the strange situation
8592 * where printf() taints but print($float) doesn't.
8594 #if defined(HAS_LONG_DOUBLE)
8595 elen = ((intsize == 'q')
8596 ? my_sprintf(PL_efloatbuf, ptr, nv)
8597 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8599 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8603 eptr = PL_efloatbuf;
8611 i = SvCUR(sv) - origlen;
8614 case 'h': *(va_arg(*args, short*)) = i; break;
8615 default: *(va_arg(*args, int*)) = i; break;
8616 case 'l': *(va_arg(*args, long*)) = i; break;
8617 case 'V': *(va_arg(*args, IV*)) = i; break;
8619 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8624 sv_setuv_mg(argsv, (UV)i);
8625 continue; /* not "break" */
8632 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8633 && ckWARN(WARN_PRINTF))
8635 SV * const msg = sv_newmortal();
8636 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8637 (PL_op->op_type == OP_PRTF) ? "" : "s");
8640 Perl_sv_catpvf(aTHX_ msg,
8641 "\"%%%c\"", c & 0xFF);
8643 Perl_sv_catpvf(aTHX_ msg,
8644 "\"%%\\%03"UVof"\"",
8647 sv_catpv(msg, "end of string");
8648 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8651 /* output mangled stuff ... */
8657 /* ... right here, because formatting flags should not apply */
8658 SvGROW(sv, SvCUR(sv) + elen + 1);
8660 Copy(eptr, p, elen, char);
8663 SvCUR_set(sv, p - SvPVX_const(sv));
8665 continue; /* not "break" */
8668 /* calculate width before utf8_upgrade changes it */
8669 have = esignlen + zeros + elen;
8671 Perl_croak_nocontext(PL_memory_wrap);
8673 if (is_utf8 != has_utf8) {
8676 sv_utf8_upgrade(sv);
8679 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8680 sv_utf8_upgrade(nsv);
8681 eptr = SvPVX_const(nsv);
8684 SvGROW(sv, SvCUR(sv) + elen + 1);
8689 need = (have > width ? have : width);
8692 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8693 Perl_croak_nocontext(PL_memory_wrap);
8694 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8696 if (esignlen && fill == '0') {
8698 for (i = 0; i < (int)esignlen; i++)
8702 memset(p, fill, gap);
8705 if (esignlen && fill != '0') {
8707 for (i = 0; i < (int)esignlen; i++)
8712 for (i = zeros; i; i--)
8716 Copy(eptr, p, elen, char);
8720 memset(p, ' ', gap);
8725 Copy(dotstr, p, dotstrlen, char);
8729 vectorize = FALSE; /* done iterating over vecstr */
8736 SvCUR_set(sv, p - SvPVX_const(sv));
8744 /* =========================================================================
8746 =head1 Cloning an interpreter
8748 All the macros and functions in this section are for the private use of
8749 the main function, perl_clone().
8751 The foo_dup() functions make an exact copy of an existing foo thinngy.
8752 During the course of a cloning, a hash table is used to map old addresses
8753 to new addresses. The table is created and manipulated with the
8754 ptr_table_* functions.
8758 ============================================================================*/
8761 #if defined(USE_ITHREADS)
8763 #ifndef GpREFCNT_inc
8764 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8768 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8769 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8770 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8771 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8772 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8773 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8774 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8775 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8776 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8777 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8778 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8779 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8780 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8783 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8784 regcomp.c. AMS 20010712 */
8787 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8792 struct reg_substr_datum *s;
8795 return (REGEXP *)NULL;
8797 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8800 len = r->offsets[0];
8801 npar = r->nparens+1;
8803 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8804 Copy(r->program, ret->program, len+1, regnode);
8806 Newx(ret->startp, npar, I32);
8807 Copy(r->startp, ret->startp, npar, I32);
8808 Newx(ret->endp, npar, I32);
8809 Copy(r->startp, ret->startp, npar, I32);
8811 Newx(ret->substrs, 1, struct reg_substr_data);
8812 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8813 s->min_offset = r->substrs->data[i].min_offset;
8814 s->max_offset = r->substrs->data[i].max_offset;
8815 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8816 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8819 ret->regstclass = NULL;
8822 const int count = r->data->count;
8825 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8826 char, struct reg_data);
8827 Newx(d->what, count, U8);
8830 for (i = 0; i < count; i++) {
8831 d->what[i] = r->data->what[i];
8832 switch (d->what[i]) {
8833 /* legal options are one of: sfpont
8834 see also regcomp.h and pregfree() */
8836 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8839 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8842 /* This is cheating. */
8843 Newx(d->data[i], 1, struct regnode_charclass_class);
8844 StructCopy(r->data->data[i], d->data[i],
8845 struct regnode_charclass_class);
8846 ret->regstclass = (regnode*)d->data[i];
8849 /* Compiled op trees are readonly, and can thus be
8850 shared without duplication. */
8852 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8856 d->data[i] = r->data->data[i];
8859 d->data[i] = r->data->data[i];
8861 ((reg_trie_data*)d->data[i])->refcount++;
8865 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8874 Newx(ret->offsets, 2*len+1, U32);
8875 Copy(r->offsets, ret->offsets, 2*len+1, U32);
8877 ret->precomp = SAVEPVN(r->precomp, r->prelen);
8878 ret->refcnt = r->refcnt;
8879 ret->minlen = r->minlen;
8880 ret->prelen = r->prelen;
8881 ret->nparens = r->nparens;
8882 ret->lastparen = r->lastparen;
8883 ret->lastcloseparen = r->lastcloseparen;
8884 ret->reganch = r->reganch;
8886 ret->sublen = r->sublen;
8888 if (RX_MATCH_COPIED(ret))
8889 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
8891 ret->subbeg = Nullch;
8892 #ifdef PERL_OLD_COPY_ON_WRITE
8893 ret->saved_copy = Nullsv;
8896 ptr_table_store(PL_ptr_table, r, ret);
8900 /* duplicate a file handle */
8903 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
8907 PERL_UNUSED_ARG(type);
8910 return (PerlIO*)NULL;
8912 /* look for it in the table first */
8913 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
8917 /* create anew and remember what it is */
8918 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
8919 ptr_table_store(PL_ptr_table, fp, ret);
8923 /* duplicate a directory handle */
8926 Perl_dirp_dup(pTHX_ DIR *dp)
8934 /* duplicate a typeglob */
8937 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
8942 /* look for it in the table first */
8943 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
8947 /* create anew and remember what it is */
8949 ptr_table_store(PL_ptr_table, gp, ret);
8952 ret->gp_refcnt = 0; /* must be before any other dups! */
8953 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
8954 ret->gp_io = io_dup_inc(gp->gp_io, param);
8955 ret->gp_form = cv_dup_inc(gp->gp_form, param);
8956 ret->gp_av = av_dup_inc(gp->gp_av, param);
8957 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
8958 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
8959 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
8960 ret->gp_cvgen = gp->gp_cvgen;
8961 ret->gp_line = gp->gp_line;
8962 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
8966 /* duplicate a chain of magic */
8969 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
8971 MAGIC *mgprev = (MAGIC*)NULL;
8974 return (MAGIC*)NULL;
8975 /* look for it in the table first */
8976 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
8980 for (; mg; mg = mg->mg_moremagic) {
8982 Newxz(nmg, 1, MAGIC);
8984 mgprev->mg_moremagic = nmg;
8987 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
8988 nmg->mg_private = mg->mg_private;
8989 nmg->mg_type = mg->mg_type;
8990 nmg->mg_flags = mg->mg_flags;
8991 if (mg->mg_type == PERL_MAGIC_qr) {
8992 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
8994 else if(mg->mg_type == PERL_MAGIC_backref) {
8995 const AV * const av = (AV*) mg->mg_obj;
8998 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9000 for (i = AvFILLp(av); i >= 0; i--) {
9001 if (!svp[i]) continue;
9002 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9005 else if (mg->mg_type == PERL_MAGIC_symtab) {
9006 nmg->mg_obj = mg->mg_obj;
9009 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9010 ? sv_dup_inc(mg->mg_obj, param)
9011 : sv_dup(mg->mg_obj, param);
9013 nmg->mg_len = mg->mg_len;
9014 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9015 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9016 if (mg->mg_len > 0) {
9017 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9018 if (mg->mg_type == PERL_MAGIC_overload_table &&
9019 AMT_AMAGIC((AMT*)mg->mg_ptr))
9021 const AMT * const amtp = (AMT*)mg->mg_ptr;
9022 AMT * const namtp = (AMT*)nmg->mg_ptr;
9024 for (i = 1; i < NofAMmeth; i++) {
9025 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9029 else if (mg->mg_len == HEf_SVKEY)
9030 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9032 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9033 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9040 /* create a new pointer-mapping table */
9043 Perl_ptr_table_new(pTHX)
9046 Newxz(tbl, 1, PTR_TBL_t);
9049 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9053 #define PTR_TABLE_HASH(ptr) \
9054 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9057 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9058 following define) and at call to new_body_inline made below in
9059 Perl_ptr_table_store()
9062 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9064 /* map an existing pointer using a table */
9066 STATIC PTR_TBL_ENT_t *
9067 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9068 PTR_TBL_ENT_t *tblent;
9069 const UV hash = PTR_TABLE_HASH(sv);
9071 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9072 for (; tblent; tblent = tblent->next) {
9073 if (tblent->oldval == sv)
9080 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9082 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9083 return tblent ? tblent->newval : (void *) 0;
9086 /* add a new entry to a pointer-mapping table */
9089 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9091 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9094 tblent->newval = newsv;
9096 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9098 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9099 tblent->oldval = oldsv;
9100 tblent->newval = newsv;
9101 tblent->next = tbl->tbl_ary[entry];
9102 tbl->tbl_ary[entry] = tblent;
9104 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9105 ptr_table_split(tbl);
9109 /* double the hash bucket size of an existing ptr table */
9112 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9114 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9115 const UV oldsize = tbl->tbl_max + 1;
9116 UV newsize = oldsize * 2;
9119 Renew(ary, newsize, PTR_TBL_ENT_t*);
9120 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9121 tbl->tbl_max = --newsize;
9123 for (i=0; i < oldsize; i++, ary++) {
9124 PTR_TBL_ENT_t **curentp, **entp, *ent;
9127 curentp = ary + oldsize;
9128 for (entp = ary, ent = *ary; ent; ent = *entp) {
9129 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9131 ent->next = *curentp;
9141 /* remove all the entries from a ptr table */
9144 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9146 if (tbl && tbl->tbl_items) {
9147 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9148 UV riter = tbl->tbl_max;
9151 PTR_TBL_ENT_t *entry = array[riter];
9154 PTR_TBL_ENT_t * const oentry = entry;
9155 entry = entry->next;
9164 /* clear and free a ptr table */
9167 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9172 ptr_table_clear(tbl);
9173 Safefree(tbl->tbl_ary);
9179 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9182 SvRV_set(dstr, SvWEAKREF(sstr)
9183 ? sv_dup(SvRV(sstr), param)
9184 : sv_dup_inc(SvRV(sstr), param));
9187 else if (SvPVX_const(sstr)) {
9188 /* Has something there */
9190 /* Normal PV - clone whole allocated space */
9191 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9192 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9193 /* Not that normal - actually sstr is copy on write.
9194 But we are a true, independant SV, so: */
9195 SvREADONLY_off(dstr);
9200 /* Special case - not normally malloced for some reason */
9201 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9202 /* A "shared" PV - clone it as "shared" PV */
9204 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9208 /* Some other special case - random pointer */
9209 SvPV_set(dstr, SvPVX(sstr));
9215 if (SvTYPE(dstr) == SVt_RV)
9216 SvRV_set(dstr, NULL);
9222 /* duplicate an SV of any type (including AV, HV etc) */
9225 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9230 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9232 /* look for it in the table first */
9233 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9237 if(param->flags & CLONEf_JOIN_IN) {
9238 /** We are joining here so we don't want do clone
9239 something that is bad **/
9242 if(SvTYPE(sstr) == SVt_PVHV &&
9243 (hvname = HvNAME_get(sstr))) {
9244 /** don't clone stashes if they already exist **/
9245 return (SV*)gv_stashpv(hvname,0);
9249 /* create anew and remember what it is */
9252 #ifdef DEBUG_LEAKING_SCALARS
9253 dstr->sv_debug_optype = sstr->sv_debug_optype;
9254 dstr->sv_debug_line = sstr->sv_debug_line;
9255 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9256 dstr->sv_debug_cloned = 1;
9258 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9260 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9264 ptr_table_store(PL_ptr_table, sstr, dstr);
9267 SvFLAGS(dstr) = SvFLAGS(sstr);
9268 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9269 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9272 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9273 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9274 PL_watch_pvx, SvPVX_const(sstr));
9277 /* don't clone objects whose class has asked us not to */
9278 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9279 SvFLAGS(dstr) &= ~SVTYPEMASK;
9284 switch (SvTYPE(sstr)) {
9289 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9290 SvIV_set(dstr, SvIVX(sstr));
9293 SvANY(dstr) = new_XNV();
9294 SvNV_set(dstr, SvNVX(sstr));
9297 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9298 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9302 /* These are all the types that need complex bodies allocating. */
9304 const svtype sv_type = SvTYPE(sstr);
9305 const struct body_details *const sv_type_details
9306 = bodies_by_type + sv_type;
9310 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9315 if (GvUNIQUE((GV*)sstr)) {
9316 /* Do sharing here, and fall through */
9329 assert(sv_type_details->size);
9330 if (sv_type_details->arena) {
9331 new_body_inline(new_body, sv_type_details->size, sv_type);
9333 = (void*)((char*)new_body - sv_type_details->offset);
9335 new_body = new_NOARENA(sv_type_details);
9339 SvANY(dstr) = new_body;
9342 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9343 ((char*)SvANY(dstr)) + sv_type_details->offset,
9344 sv_type_details->copy, char);
9346 Copy(((char*)SvANY(sstr)),
9347 ((char*)SvANY(dstr)),
9348 sv_type_details->size + sv_type_details->offset, char);
9351 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9352 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9354 /* The Copy above means that all the source (unduplicated) pointers
9355 are now in the destination. We can check the flags and the
9356 pointers in either, but it's possible that there's less cache
9357 missing by always going for the destination.
9358 FIXME - instrument and check that assumption */
9359 if (sv_type >= SVt_PVMG) {
9361 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9363 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9366 /* The cast silences a GCC warning about unhandled types. */
9367 switch ((int)sv_type) {
9379 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9380 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9381 LvTARG(dstr) = dstr;
9382 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9383 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9385 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9388 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9389 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9390 /* Don't call sv_add_backref here as it's going to be created
9391 as part of the magic cloning of the symbol table. */
9392 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9393 (void)GpREFCNT_inc(GvGP(dstr));
9396 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9397 if (IoOFP(dstr) == IoIFP(sstr))
9398 IoOFP(dstr) = IoIFP(dstr);
9400 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9401 /* PL_rsfp_filters entries have fake IoDIRP() */
9402 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9403 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9404 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9405 /* I have no idea why fake dirp (rsfps)
9406 should be treated differently but otherwise
9407 we end up with leaks -- sky*/
9408 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9409 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9410 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9412 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9413 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9414 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9416 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9417 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9418 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9421 if (AvARRAY((AV*)sstr)) {
9422 SV **dst_ary, **src_ary;
9423 SSize_t items = AvFILLp((AV*)sstr) + 1;
9425 src_ary = AvARRAY((AV*)sstr);
9426 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9427 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9428 SvPV_set(dstr, (char*)dst_ary);
9429 AvALLOC((AV*)dstr) = dst_ary;
9430 if (AvREAL((AV*)sstr)) {
9432 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9436 *dst_ary++ = sv_dup(*src_ary++, param);
9438 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9439 while (items-- > 0) {
9440 *dst_ary++ = &PL_sv_undef;
9444 SvPV_set(dstr, Nullch);
9445 AvALLOC((AV*)dstr) = (SV**)NULL;
9452 if (HvARRAY((HV*)sstr)) {
9454 const bool sharekeys = !!HvSHAREKEYS(sstr);
9455 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9456 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9458 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9459 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9461 HvARRAY(dstr) = (HE**)darray;
9462 while (i <= sxhv->xhv_max) {
9463 const HE *source = HvARRAY(sstr)[i];
9464 HvARRAY(dstr)[i] = source
9465 ? he_dup(source, sharekeys, param) : 0;
9469 struct xpvhv_aux * const saux = HvAUX(sstr);
9470 struct xpvhv_aux * const daux = HvAUX(dstr);
9471 /* This flag isn't copied. */
9472 /* SvOOK_on(hv) attacks the IV flags. */
9473 SvFLAGS(dstr) |= SVf_OOK;
9475 hvname = saux->xhv_name;
9477 = hvname ? hek_dup(hvname, param) : hvname;
9479 daux->xhv_riter = saux->xhv_riter;
9480 daux->xhv_eiter = saux->xhv_eiter
9481 ? he_dup(saux->xhv_eiter,
9482 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9486 SvPV_set(dstr, Nullch);
9488 /* Record stashes for possible cloning in Perl_clone(). */
9490 av_push(param->stashes, dstr);
9495 /* NOTE: not refcounted */
9496 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9498 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9500 if (CvCONST(dstr)) {
9501 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9502 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9503 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9505 /* don't dup if copying back - CvGV isn't refcounted, so the
9506 * duped GV may never be freed. A bit of a hack! DAPM */
9507 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9508 Nullgv : gv_dup(CvGV(dstr), param) ;
9509 if (!(param->flags & CLONEf_COPY_STACKS)) {
9512 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9515 ? cv_dup( CvOUTSIDE(dstr), param)
9516 : cv_dup_inc(CvOUTSIDE(dstr), param);
9518 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9524 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9530 /* duplicate a context */
9533 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9538 return (PERL_CONTEXT*)NULL;
9540 /* look for it in the table first */
9541 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9545 /* create anew and remember what it is */
9546 Newxz(ncxs, max + 1, PERL_CONTEXT);
9547 ptr_table_store(PL_ptr_table, cxs, ncxs);
9550 PERL_CONTEXT * const cx = &cxs[ix];
9551 PERL_CONTEXT * const ncx = &ncxs[ix];
9552 ncx->cx_type = cx->cx_type;
9553 if (CxTYPE(cx) == CXt_SUBST) {
9554 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9557 ncx->blk_oldsp = cx->blk_oldsp;
9558 ncx->blk_oldcop = cx->blk_oldcop;
9559 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9560 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9561 ncx->blk_oldpm = cx->blk_oldpm;
9562 ncx->blk_gimme = cx->blk_gimme;
9563 switch (CxTYPE(cx)) {
9565 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9566 ? cv_dup_inc(cx->blk_sub.cv, param)
9567 : cv_dup(cx->blk_sub.cv,param));
9568 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9569 ? av_dup_inc(cx->blk_sub.argarray, param)
9571 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9572 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9573 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9574 ncx->blk_sub.lval = cx->blk_sub.lval;
9575 ncx->blk_sub.retop = cx->blk_sub.retop;
9578 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9579 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9580 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9581 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9582 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9583 ncx->blk_eval.retop = cx->blk_eval.retop;
9586 ncx->blk_loop.label = cx->blk_loop.label;
9587 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9588 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9589 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9590 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9591 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9592 ? cx->blk_loop.iterdata
9593 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9594 ncx->blk_loop.oldcomppad
9595 = (PAD*)ptr_table_fetch(PL_ptr_table,
9596 cx->blk_loop.oldcomppad);
9597 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9598 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9599 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9600 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9601 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9604 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9605 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9606 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9607 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9608 ncx->blk_sub.retop = cx->blk_sub.retop;
9620 /* duplicate a stack info structure */
9623 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9628 return (PERL_SI*)NULL;
9630 /* look for it in the table first */
9631 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9635 /* create anew and remember what it is */
9636 Newxz(nsi, 1, PERL_SI);
9637 ptr_table_store(PL_ptr_table, si, nsi);
9639 nsi->si_stack = av_dup_inc(si->si_stack, param);
9640 nsi->si_cxix = si->si_cxix;
9641 nsi->si_cxmax = si->si_cxmax;
9642 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9643 nsi->si_type = si->si_type;
9644 nsi->si_prev = si_dup(si->si_prev, param);
9645 nsi->si_next = si_dup(si->si_next, param);
9646 nsi->si_markoff = si->si_markoff;
9651 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9652 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9653 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9654 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9655 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9656 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9657 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9658 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9659 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9660 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9661 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9662 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9663 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9664 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9667 #define pv_dup_inc(p) SAVEPV(p)
9668 #define pv_dup(p) SAVEPV(p)
9669 #define svp_dup_inc(p,pp) any_dup(p,pp)
9671 /* map any object to the new equivent - either something in the
9672 * ptr table, or something in the interpreter structure
9676 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9683 /* look for it in the table first */
9684 ret = ptr_table_fetch(PL_ptr_table, v);
9688 /* see if it is part of the interpreter structure */
9689 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9690 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9698 /* duplicate the save stack */
9701 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9703 ANY * const ss = proto_perl->Tsavestack;
9704 const I32 max = proto_perl->Tsavestack_max;
9705 I32 ix = proto_perl->Tsavestack_ix;
9717 void (*dptr) (void*);
9718 void (*dxptr) (pTHX_ void*);
9720 Newxz(nss, max, ANY);
9723 I32 i = POPINT(ss,ix);
9726 case SAVEt_ITEM: /* normal string */
9727 sv = (SV*)POPPTR(ss,ix);
9728 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9729 sv = (SV*)POPPTR(ss,ix);
9730 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9732 case SAVEt_SV: /* scalar reference */
9733 sv = (SV*)POPPTR(ss,ix);
9734 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9735 gv = (GV*)POPPTR(ss,ix);
9736 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9738 case SAVEt_GENERIC_PVREF: /* generic char* */
9739 c = (char*)POPPTR(ss,ix);
9740 TOPPTR(nss,ix) = pv_dup(c);
9741 ptr = POPPTR(ss,ix);
9742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9744 case SAVEt_SHARED_PVREF: /* char* in shared space */
9745 c = (char*)POPPTR(ss,ix);
9746 TOPPTR(nss,ix) = savesharedpv(c);
9747 ptr = POPPTR(ss,ix);
9748 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9750 case SAVEt_GENERIC_SVREF: /* generic sv */
9751 case SAVEt_SVREF: /* scalar reference */
9752 sv = (SV*)POPPTR(ss,ix);
9753 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9754 ptr = POPPTR(ss,ix);
9755 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9757 case SAVEt_AV: /* array reference */
9758 av = (AV*)POPPTR(ss,ix);
9759 TOPPTR(nss,ix) = av_dup_inc(av, param);
9760 gv = (GV*)POPPTR(ss,ix);
9761 TOPPTR(nss,ix) = gv_dup(gv, param);
9763 case SAVEt_HV: /* hash reference */
9764 hv = (HV*)POPPTR(ss,ix);
9765 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9766 gv = (GV*)POPPTR(ss,ix);
9767 TOPPTR(nss,ix) = gv_dup(gv, param);
9769 case SAVEt_INT: /* int reference */
9770 ptr = POPPTR(ss,ix);
9771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9772 intval = (int)POPINT(ss,ix);
9773 TOPINT(nss,ix) = intval;
9775 case SAVEt_LONG: /* long reference */
9776 ptr = POPPTR(ss,ix);
9777 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9778 longval = (long)POPLONG(ss,ix);
9779 TOPLONG(nss,ix) = longval;
9781 case SAVEt_I32: /* I32 reference */
9782 case SAVEt_I16: /* I16 reference */
9783 case SAVEt_I8: /* I8 reference */
9784 ptr = POPPTR(ss,ix);
9785 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9789 case SAVEt_IV: /* IV reference */
9790 ptr = POPPTR(ss,ix);
9791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9795 case SAVEt_SPTR: /* SV* reference */
9796 ptr = POPPTR(ss,ix);
9797 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9798 sv = (SV*)POPPTR(ss,ix);
9799 TOPPTR(nss,ix) = sv_dup(sv, param);
9801 case SAVEt_VPTR: /* random* reference */
9802 ptr = POPPTR(ss,ix);
9803 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9804 ptr = POPPTR(ss,ix);
9805 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9807 case SAVEt_PPTR: /* char* reference */
9808 ptr = POPPTR(ss,ix);
9809 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9810 c = (char*)POPPTR(ss,ix);
9811 TOPPTR(nss,ix) = pv_dup(c);
9813 case SAVEt_HPTR: /* HV* reference */
9814 ptr = POPPTR(ss,ix);
9815 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9816 hv = (HV*)POPPTR(ss,ix);
9817 TOPPTR(nss,ix) = hv_dup(hv, param);
9819 case SAVEt_APTR: /* AV* reference */
9820 ptr = POPPTR(ss,ix);
9821 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9822 av = (AV*)POPPTR(ss,ix);
9823 TOPPTR(nss,ix) = av_dup(av, param);
9826 gv = (GV*)POPPTR(ss,ix);
9827 TOPPTR(nss,ix) = gv_dup(gv, param);
9829 case SAVEt_GP: /* scalar reference */
9830 gp = (GP*)POPPTR(ss,ix);
9831 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
9832 (void)GpREFCNT_inc(gp);
9833 gv = (GV*)POPPTR(ss,ix);
9834 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9835 c = (char*)POPPTR(ss,ix);
9836 TOPPTR(nss,ix) = pv_dup(c);
9843 case SAVEt_MORTALIZESV:
9844 sv = (SV*)POPPTR(ss,ix);
9845 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9848 ptr = POPPTR(ss,ix);
9849 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
9850 /* these are assumed to be refcounted properly */
9852 switch (((OP*)ptr)->op_type) {
9859 TOPPTR(nss,ix) = ptr;
9864 TOPPTR(nss,ix) = Nullop;
9869 TOPPTR(nss,ix) = Nullop;
9872 c = (char*)POPPTR(ss,ix);
9873 TOPPTR(nss,ix) = pv_dup_inc(c);
9876 longval = POPLONG(ss,ix);
9877 TOPLONG(nss,ix) = longval;
9880 hv = (HV*)POPPTR(ss,ix);
9881 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9882 c = (char*)POPPTR(ss,ix);
9883 TOPPTR(nss,ix) = pv_dup_inc(c);
9887 case SAVEt_DESTRUCTOR:
9888 ptr = POPPTR(ss,ix);
9889 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9890 dptr = POPDPTR(ss,ix);
9891 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
9892 any_dup(FPTR2DPTR(void *, dptr),
9895 case SAVEt_DESTRUCTOR_X:
9896 ptr = POPPTR(ss,ix);
9897 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
9898 dxptr = POPDXPTR(ss,ix);
9899 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
9900 any_dup(FPTR2DPTR(void *, dxptr),
9903 case SAVEt_REGCONTEXT:
9909 case SAVEt_STACK_POS: /* Position on Perl stack */
9913 case SAVEt_AELEM: /* array element */
9914 sv = (SV*)POPPTR(ss,ix);
9915 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9918 av = (AV*)POPPTR(ss,ix);
9919 TOPPTR(nss,ix) = av_dup_inc(av, param);
9921 case SAVEt_HELEM: /* hash element */
9922 sv = (SV*)POPPTR(ss,ix);
9923 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9924 sv = (SV*)POPPTR(ss,ix);
9925 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9926 hv = (HV*)POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9930 ptr = POPPTR(ss,ix);
9931 TOPPTR(nss,ix) = ptr;
9938 av = (AV*)POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = av_dup(av, param);
9942 longval = (long)POPLONG(ss,ix);
9943 TOPLONG(nss,ix) = longval;
9944 ptr = POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9946 sv = (SV*)POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = sv_dup(sv, param);
9950 ptr = POPPTR(ss,ix);
9951 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9952 longval = (long)POPBOOL(ss,ix);
9953 TOPBOOL(nss,ix) = (bool)longval;
9955 case SAVEt_SET_SVFLAGS:
9960 sv = (SV*)POPPTR(ss,ix);
9961 TOPPTR(nss,ix) = sv_dup(sv, param);
9964 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
9972 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
9973 * flag to the result. This is done for each stash before cloning starts,
9974 * so we know which stashes want their objects cloned */
9977 do_mark_cloneable_stash(pTHX_ SV *sv)
9979 const HEK * const hvname = HvNAME_HEK((HV*)sv);
9981 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
9982 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
9983 if (cloner && GvCV(cloner)) {
9990 XPUSHs(sv_2mortal(newSVhek(hvname)));
9992 call_sv((SV*)GvCV(cloner), G_SCALAR);
9999 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10007 =for apidoc perl_clone
10009 Create and return a new interpreter by cloning the current one.
10011 perl_clone takes these flags as parameters:
10013 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10014 without it we only clone the data and zero the stacks,
10015 with it we copy the stacks and the new perl interpreter is
10016 ready to run at the exact same point as the previous one.
10017 The pseudo-fork code uses COPY_STACKS while the
10018 threads->new doesn't.
10020 CLONEf_KEEP_PTR_TABLE
10021 perl_clone keeps a ptr_table with the pointer of the old
10022 variable as a key and the new variable as a value,
10023 this allows it to check if something has been cloned and not
10024 clone it again but rather just use the value and increase the
10025 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10026 the ptr_table using the function
10027 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10028 reason to keep it around is if you want to dup some of your own
10029 variable who are outside the graph perl scans, example of this
10030 code is in threads.xs create
10033 This is a win32 thing, it is ignored on unix, it tells perls
10034 win32host code (which is c++) to clone itself, this is needed on
10035 win32 if you want to run two threads at the same time,
10036 if you just want to do some stuff in a separate perl interpreter
10037 and then throw it away and return to the original one,
10038 you don't need to do anything.
10043 /* XXX the above needs expanding by someone who actually understands it ! */
10044 EXTERN_C PerlInterpreter *
10045 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10048 perl_clone(PerlInterpreter *proto_perl, UV flags)
10051 #ifdef PERL_IMPLICIT_SYS
10053 /* perlhost.h so we need to call into it
10054 to clone the host, CPerlHost should have a c interface, sky */
10056 if (flags & CLONEf_CLONE_HOST) {
10057 return perl_clone_host(proto_perl,flags);
10059 return perl_clone_using(proto_perl, flags,
10061 proto_perl->IMemShared,
10062 proto_perl->IMemParse,
10064 proto_perl->IStdIO,
10068 proto_perl->IProc);
10072 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10073 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10074 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10075 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10076 struct IPerlDir* ipD, struct IPerlSock* ipS,
10077 struct IPerlProc* ipP)
10079 /* XXX many of the string copies here can be optimized if they're
10080 * constants; they need to be allocated as common memory and just
10081 * their pointers copied. */
10084 CLONE_PARAMS clone_params;
10085 CLONE_PARAMS* param = &clone_params;
10087 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10088 /* for each stash, determine whether its objects should be cloned */
10089 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10090 PERL_SET_THX(my_perl);
10093 Poison(my_perl, 1, PerlInterpreter);
10095 PL_curcop = (COP *)Nullop;
10099 PL_savestack_ix = 0;
10100 PL_savestack_max = -1;
10101 PL_sig_pending = 0;
10102 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10103 # else /* !DEBUGGING */
10104 Zero(my_perl, 1, PerlInterpreter);
10105 # endif /* DEBUGGING */
10107 /* host pointers */
10109 PL_MemShared = ipMS;
10110 PL_MemParse = ipMP;
10117 #else /* !PERL_IMPLICIT_SYS */
10119 CLONE_PARAMS clone_params;
10120 CLONE_PARAMS* param = &clone_params;
10121 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10122 /* for each stash, determine whether its objects should be cloned */
10123 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10124 PERL_SET_THX(my_perl);
10127 Poison(my_perl, 1, PerlInterpreter);
10129 PL_curcop = (COP *)Nullop;
10133 PL_savestack_ix = 0;
10134 PL_savestack_max = -1;
10135 PL_sig_pending = 0;
10136 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10137 # else /* !DEBUGGING */
10138 Zero(my_perl, 1, PerlInterpreter);
10139 # endif /* DEBUGGING */
10140 #endif /* PERL_IMPLICIT_SYS */
10141 param->flags = flags;
10142 param->proto_perl = proto_perl;
10144 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10145 Zero(&PL_body_roots, 1, PL_body_roots);
10147 PL_nice_chunk = NULL;
10148 PL_nice_chunk_size = 0;
10150 PL_sv_objcount = 0;
10151 PL_sv_root = Nullsv;
10152 PL_sv_arenaroot = Nullsv;
10154 PL_debug = proto_perl->Idebug;
10156 PL_hash_seed = proto_perl->Ihash_seed;
10157 PL_rehash_seed = proto_perl->Irehash_seed;
10159 #ifdef USE_REENTRANT_API
10160 /* XXX: things like -Dm will segfault here in perlio, but doing
10161 * PERL_SET_CONTEXT(proto_perl);
10162 * breaks too many other things
10164 Perl_reentrant_init(aTHX);
10167 /* create SV map for pointer relocation */
10168 PL_ptr_table = ptr_table_new();
10170 /* initialize these special pointers as early as possible */
10171 SvANY(&PL_sv_undef) = NULL;
10172 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10173 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10174 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10176 SvANY(&PL_sv_no) = new_XPVNV();
10177 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10178 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10179 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10180 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10181 SvCUR_set(&PL_sv_no, 0);
10182 SvLEN_set(&PL_sv_no, 1);
10183 SvIV_set(&PL_sv_no, 0);
10184 SvNV_set(&PL_sv_no, 0);
10185 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10187 SvANY(&PL_sv_yes) = new_XPVNV();
10188 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10189 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10190 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10191 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10192 SvCUR_set(&PL_sv_yes, 1);
10193 SvLEN_set(&PL_sv_yes, 2);
10194 SvIV_set(&PL_sv_yes, 1);
10195 SvNV_set(&PL_sv_yes, 1);
10196 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10198 /* create (a non-shared!) shared string table */
10199 PL_strtab = newHV();
10200 HvSHAREKEYS_off(PL_strtab);
10201 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10202 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10204 PL_compiling = proto_perl->Icompiling;
10206 /* These two PVs will be free'd special way so must set them same way op.c does */
10207 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10208 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10210 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10211 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10213 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10214 if (!specialWARN(PL_compiling.cop_warnings))
10215 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10216 if (!specialCopIO(PL_compiling.cop_io))
10217 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10218 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10220 /* pseudo environmental stuff */
10221 PL_origargc = proto_perl->Iorigargc;
10222 PL_origargv = proto_perl->Iorigargv;
10224 param->stashes = newAV(); /* Setup array of objects to call clone on */
10226 /* Set tainting stuff before PerlIO_debug can possibly get called */
10227 PL_tainting = proto_perl->Itainting;
10228 PL_taint_warn = proto_perl->Itaint_warn;
10230 #ifdef PERLIO_LAYERS
10231 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10232 PerlIO_clone(aTHX_ proto_perl, param);
10235 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10236 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10237 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10238 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10239 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10240 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10243 PL_minus_c = proto_perl->Iminus_c;
10244 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10245 PL_localpatches = proto_perl->Ilocalpatches;
10246 PL_splitstr = proto_perl->Isplitstr;
10247 PL_preprocess = proto_perl->Ipreprocess;
10248 PL_minus_n = proto_perl->Iminus_n;
10249 PL_minus_p = proto_perl->Iminus_p;
10250 PL_minus_l = proto_perl->Iminus_l;
10251 PL_minus_a = proto_perl->Iminus_a;
10252 PL_minus_E = proto_perl->Iminus_E;
10253 PL_minus_F = proto_perl->Iminus_F;
10254 PL_doswitches = proto_perl->Idoswitches;
10255 PL_dowarn = proto_perl->Idowarn;
10256 PL_doextract = proto_perl->Idoextract;
10257 PL_sawampersand = proto_perl->Isawampersand;
10258 PL_unsafe = proto_perl->Iunsafe;
10259 PL_inplace = SAVEPV(proto_perl->Iinplace);
10260 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10261 PL_perldb = proto_perl->Iperldb;
10262 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10263 PL_exit_flags = proto_perl->Iexit_flags;
10265 /* magical thingies */
10266 /* XXX time(&PL_basetime) when asked for? */
10267 PL_basetime = proto_perl->Ibasetime;
10268 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10270 PL_maxsysfd = proto_perl->Imaxsysfd;
10271 PL_multiline = proto_perl->Imultiline;
10272 PL_statusvalue = proto_perl->Istatusvalue;
10274 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10276 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10278 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10280 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10281 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10282 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10284 /* Clone the regex array */
10285 PL_regex_padav = newAV();
10287 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10288 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10290 av_push(PL_regex_padav,
10291 sv_dup_inc(regexen[0],param));
10292 for(i = 1; i <= len; i++) {
10293 if(SvREPADTMP(regexen[i])) {
10294 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10296 av_push(PL_regex_padav,
10298 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10299 SvIVX(regexen[i])), param)))
10304 PL_regex_pad = AvARRAY(PL_regex_padav);
10306 /* shortcuts to various I/O objects */
10307 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10308 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10309 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10310 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10311 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10312 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10314 /* shortcuts to regexp stuff */
10315 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10317 /* shortcuts to misc objects */
10318 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10320 /* shortcuts to debugging objects */
10321 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10322 PL_DBline = gv_dup(proto_perl->IDBline, param);
10323 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10324 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10325 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10326 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10327 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10328 PL_lineary = av_dup(proto_perl->Ilineary, param);
10329 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10331 /* symbol tables */
10332 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10333 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10334 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10335 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10336 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10338 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10339 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10340 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10341 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10342 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10343 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10345 PL_sub_generation = proto_perl->Isub_generation;
10347 /* funky return mechanisms */
10348 PL_forkprocess = proto_perl->Iforkprocess;
10350 /* subprocess state */
10351 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10353 /* internal state */
10354 PL_maxo = proto_perl->Imaxo;
10355 if (proto_perl->Iop_mask)
10356 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10358 PL_op_mask = Nullch;
10359 /* PL_asserting = proto_perl->Iasserting; */
10361 /* current interpreter roots */
10362 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10363 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10364 PL_main_start = proto_perl->Imain_start;
10365 PL_eval_root = proto_perl->Ieval_root;
10366 PL_eval_start = proto_perl->Ieval_start;
10368 /* runtime control stuff */
10369 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10370 PL_copline = proto_perl->Icopline;
10372 PL_filemode = proto_perl->Ifilemode;
10373 PL_lastfd = proto_perl->Ilastfd;
10374 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10377 PL_gensym = proto_perl->Igensym;
10378 PL_preambled = proto_perl->Ipreambled;
10379 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10380 PL_laststatval = proto_perl->Ilaststatval;
10381 PL_laststype = proto_perl->Ilaststype;
10382 PL_mess_sv = Nullsv;
10384 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10386 /* interpreter atexit processing */
10387 PL_exitlistlen = proto_perl->Iexitlistlen;
10388 if (PL_exitlistlen) {
10389 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10390 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10393 PL_exitlist = (PerlExitListEntry*)NULL;
10394 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10395 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10396 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10398 PL_profiledata = NULL;
10399 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10400 /* PL_rsfp_filters entries have fake IoDIRP() */
10401 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10403 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10405 PAD_CLONE_VARS(proto_perl, param);
10407 #ifdef HAVE_INTERP_INTERN
10408 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10411 /* more statics moved here */
10412 PL_generation = proto_perl->Igeneration;
10413 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10415 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10416 PL_in_clean_all = proto_perl->Iin_clean_all;
10418 PL_uid = proto_perl->Iuid;
10419 PL_euid = proto_perl->Ieuid;
10420 PL_gid = proto_perl->Igid;
10421 PL_egid = proto_perl->Iegid;
10422 PL_nomemok = proto_perl->Inomemok;
10423 PL_an = proto_perl->Ian;
10424 PL_evalseq = proto_perl->Ievalseq;
10425 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10426 PL_origalen = proto_perl->Iorigalen;
10427 #ifdef PERL_USES_PL_PIDSTATUS
10428 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10430 PL_osname = SAVEPV(proto_perl->Iosname);
10431 PL_sighandlerp = proto_perl->Isighandlerp;
10433 PL_runops = proto_perl->Irunops;
10435 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10438 PL_cshlen = proto_perl->Icshlen;
10439 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10442 PL_lex_state = proto_perl->Ilex_state;
10443 PL_lex_defer = proto_perl->Ilex_defer;
10444 PL_lex_expect = proto_perl->Ilex_expect;
10445 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10446 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10447 PL_lex_starts = proto_perl->Ilex_starts;
10448 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10449 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10450 PL_lex_op = proto_perl->Ilex_op;
10451 PL_lex_inpat = proto_perl->Ilex_inpat;
10452 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10453 PL_lex_brackets = proto_perl->Ilex_brackets;
10454 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10455 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10456 PL_lex_casemods = proto_perl->Ilex_casemods;
10457 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10458 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10460 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10461 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10462 PL_nexttoke = proto_perl->Inexttoke;
10464 /* XXX This is probably masking the deeper issue of why
10465 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10466 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10467 * (A little debugging with a watchpoint on it may help.)
10469 if (SvANY(proto_perl->Ilinestr)) {
10470 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10471 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10472 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10473 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10474 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10475 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10476 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10477 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10478 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10481 PL_linestr = NEWSV(65,79);
10482 sv_upgrade(PL_linestr,SVt_PVIV);
10483 sv_setpvn(PL_linestr,"",0);
10484 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10486 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10487 PL_pending_ident = proto_perl->Ipending_ident;
10488 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10490 PL_expect = proto_perl->Iexpect;
10492 PL_multi_start = proto_perl->Imulti_start;
10493 PL_multi_end = proto_perl->Imulti_end;
10494 PL_multi_open = proto_perl->Imulti_open;
10495 PL_multi_close = proto_perl->Imulti_close;
10497 PL_error_count = proto_perl->Ierror_count;
10498 PL_subline = proto_perl->Isubline;
10499 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10501 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10502 if (SvANY(proto_perl->Ilinestr)) {
10503 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10504 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10505 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10506 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10507 PL_last_lop_op = proto_perl->Ilast_lop_op;
10510 PL_last_uni = SvPVX(PL_linestr);
10511 PL_last_lop = SvPVX(PL_linestr);
10512 PL_last_lop_op = 0;
10514 PL_in_my = proto_perl->Iin_my;
10515 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10517 PL_cryptseen = proto_perl->Icryptseen;
10520 PL_hints = proto_perl->Ihints;
10522 PL_amagic_generation = proto_perl->Iamagic_generation;
10524 #ifdef USE_LOCALE_COLLATE
10525 PL_collation_ix = proto_perl->Icollation_ix;
10526 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10527 PL_collation_standard = proto_perl->Icollation_standard;
10528 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10529 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10530 #endif /* USE_LOCALE_COLLATE */
10532 #ifdef USE_LOCALE_NUMERIC
10533 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10534 PL_numeric_standard = proto_perl->Inumeric_standard;
10535 PL_numeric_local = proto_perl->Inumeric_local;
10536 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10537 #endif /* !USE_LOCALE_NUMERIC */
10539 /* utf8 character classes */
10540 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10541 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10542 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10543 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10544 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10545 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10546 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10547 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10548 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10549 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10550 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10551 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10552 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10553 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10554 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10555 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10556 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10557 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10558 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10559 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10561 /* Did the locale setup indicate UTF-8? */
10562 PL_utf8locale = proto_perl->Iutf8locale;
10563 /* Unicode features (see perlrun/-C) */
10564 PL_unicode = proto_perl->Iunicode;
10566 /* Pre-5.8 signals control */
10567 PL_signals = proto_perl->Isignals;
10569 /* times() ticks per second */
10570 PL_clocktick = proto_perl->Iclocktick;
10572 /* Recursion stopper for PerlIO_find_layer */
10573 PL_in_load_module = proto_perl->Iin_load_module;
10575 /* sort() routine */
10576 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10578 /* Not really needed/useful since the reenrant_retint is "volatile",
10579 * but do it for consistency's sake. */
10580 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10582 /* Hooks to shared SVs and locks. */
10583 PL_sharehook = proto_perl->Isharehook;
10584 PL_lockhook = proto_perl->Ilockhook;
10585 PL_unlockhook = proto_perl->Iunlockhook;
10586 PL_threadhook = proto_perl->Ithreadhook;
10588 PL_runops_std = proto_perl->Irunops_std;
10589 PL_runops_dbg = proto_perl->Irunops_dbg;
10591 #ifdef THREADS_HAVE_PIDS
10592 PL_ppid = proto_perl->Ippid;
10596 PL_last_swash_hv = NULL; /* reinits on demand */
10597 PL_last_swash_klen = 0;
10598 PL_last_swash_key[0]= '\0';
10599 PL_last_swash_tmps = (U8*)NULL;
10600 PL_last_swash_slen = 0;
10602 PL_glob_index = proto_perl->Iglob_index;
10603 PL_srand_called = proto_perl->Isrand_called;
10604 PL_uudmap['M'] = 0; /* reinits on demand */
10605 PL_bitcount = Nullch; /* reinits on demand */
10607 if (proto_perl->Ipsig_pend) {
10608 Newxz(PL_psig_pend, SIG_SIZE, int);
10611 PL_psig_pend = (int*)NULL;
10614 if (proto_perl->Ipsig_ptr) {
10615 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10616 Newxz(PL_psig_name, SIG_SIZE, SV*);
10617 for (i = 1; i < SIG_SIZE; i++) {
10618 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10619 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10623 PL_psig_ptr = (SV**)NULL;
10624 PL_psig_name = (SV**)NULL;
10627 /* thrdvar.h stuff */
10629 if (flags & CLONEf_COPY_STACKS) {
10630 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10631 PL_tmps_ix = proto_perl->Ttmps_ix;
10632 PL_tmps_max = proto_perl->Ttmps_max;
10633 PL_tmps_floor = proto_perl->Ttmps_floor;
10634 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10636 while (i <= PL_tmps_ix) {
10637 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10641 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10642 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10643 Newxz(PL_markstack, i, I32);
10644 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10645 - proto_perl->Tmarkstack);
10646 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10647 - proto_perl->Tmarkstack);
10648 Copy(proto_perl->Tmarkstack, PL_markstack,
10649 PL_markstack_ptr - PL_markstack + 1, I32);
10651 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10652 * NOTE: unlike the others! */
10653 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10654 PL_scopestack_max = proto_perl->Tscopestack_max;
10655 Newxz(PL_scopestack, PL_scopestack_max, I32);
10656 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10658 /* NOTE: si_dup() looks at PL_markstack */
10659 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10661 /* PL_curstack = PL_curstackinfo->si_stack; */
10662 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10663 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10665 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10666 PL_stack_base = AvARRAY(PL_curstack);
10667 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10668 - proto_perl->Tstack_base);
10669 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10671 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10672 * NOTE: unlike the others! */
10673 PL_savestack_ix = proto_perl->Tsavestack_ix;
10674 PL_savestack_max = proto_perl->Tsavestack_max;
10675 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10676 PL_savestack = ss_dup(proto_perl, param);
10680 ENTER; /* perl_destruct() wants to LEAVE; */
10683 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10684 PL_top_env = &PL_start_env;
10686 PL_op = proto_perl->Top;
10689 PL_Xpv = (XPV*)NULL;
10690 PL_na = proto_perl->Tna;
10692 PL_statbuf = proto_perl->Tstatbuf;
10693 PL_statcache = proto_perl->Tstatcache;
10694 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10695 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10697 PL_timesbuf = proto_perl->Ttimesbuf;
10700 PL_tainted = proto_perl->Ttainted;
10701 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10702 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10703 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10704 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10705 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10706 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10707 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10708 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10709 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10711 PL_restartop = proto_perl->Trestartop;
10712 PL_in_eval = proto_perl->Tin_eval;
10713 PL_delaymagic = proto_perl->Tdelaymagic;
10714 PL_dirty = proto_perl->Tdirty;
10715 PL_localizing = proto_perl->Tlocalizing;
10717 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10718 PL_hv_fetch_ent_mh = Nullhe;
10719 PL_modcount = proto_perl->Tmodcount;
10720 PL_lastgotoprobe = Nullop;
10721 PL_dumpindent = proto_perl->Tdumpindent;
10723 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10724 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10725 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10726 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10727 PL_efloatbuf = Nullch; /* reinits on demand */
10728 PL_efloatsize = 0; /* reinits on demand */
10732 PL_screamfirst = NULL;
10733 PL_screamnext = NULL;
10734 PL_maxscream = -1; /* reinits on demand */
10735 PL_lastscream = Nullsv;
10737 PL_watchaddr = NULL;
10738 PL_watchok = Nullch;
10740 PL_regdummy = proto_perl->Tregdummy;
10741 PL_regprecomp = Nullch;
10744 PL_colorset = 0; /* reinits PL_colors[] */
10745 /*PL_colors[6] = {0,0,0,0,0,0};*/
10746 PL_reginput = Nullch;
10747 PL_regbol = Nullch;
10748 PL_regeol = Nullch;
10749 PL_regstartp = (I32*)NULL;
10750 PL_regendp = (I32*)NULL;
10751 PL_reglastparen = (U32*)NULL;
10752 PL_reglastcloseparen = (U32*)NULL;
10753 PL_regtill = Nullch;
10754 PL_reg_start_tmp = (char**)NULL;
10755 PL_reg_start_tmpl = 0;
10756 PL_regdata = (struct reg_data*)NULL;
10759 PL_reg_eval_set = 0;
10761 PL_regprogram = (regnode*)NULL;
10763 PL_regcc = (CURCUR*)NULL;
10764 PL_reg_call_cc = (struct re_cc_state*)NULL;
10765 PL_reg_re = (regexp*)NULL;
10766 PL_reg_ganch = Nullch;
10767 PL_reg_sv = Nullsv;
10768 PL_reg_match_utf8 = FALSE;
10769 PL_reg_magic = (MAGIC*)NULL;
10771 PL_reg_oldcurpm = (PMOP*)NULL;
10772 PL_reg_curpm = (PMOP*)NULL;
10773 PL_reg_oldsaved = Nullch;
10774 PL_reg_oldsavedlen = 0;
10775 #ifdef PERL_OLD_COPY_ON_WRITE
10778 PL_reg_maxiter = 0;
10779 PL_reg_leftiter = 0;
10780 PL_reg_poscache = Nullch;
10781 PL_reg_poscache_size= 0;
10783 /* RE engine - function pointers */
10784 PL_regcompp = proto_perl->Tregcompp;
10785 PL_regexecp = proto_perl->Tregexecp;
10786 PL_regint_start = proto_perl->Tregint_start;
10787 PL_regint_string = proto_perl->Tregint_string;
10788 PL_regfree = proto_perl->Tregfree;
10790 PL_reginterp_cnt = 0;
10791 PL_reg_starttry = 0;
10793 /* Pluggable optimizer */
10794 PL_peepp = proto_perl->Tpeepp;
10796 PL_stashcache = newHV();
10798 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10799 ptr_table_free(PL_ptr_table);
10800 PL_ptr_table = NULL;
10803 /* Call the ->CLONE method, if it exists, for each of the stashes
10804 identified by sv_dup() above.
10806 while(av_len(param->stashes) != -1) {
10807 HV* const stash = (HV*) av_shift(param->stashes);
10808 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
10809 if (cloner && GvCV(cloner)) {
10814 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
10816 call_sv((SV*)GvCV(cloner), G_DISCARD);
10822 SvREFCNT_dec(param->stashes);
10824 /* orphaned? eg threads->new inside BEGIN or use */
10825 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
10826 (void)SvREFCNT_inc(PL_compcv);
10827 SAVEFREESV(PL_compcv);
10833 #endif /* USE_ITHREADS */
10836 =head1 Unicode Support
10838 =for apidoc sv_recode_to_utf8
10840 The encoding is assumed to be an Encode object, on entry the PV
10841 of the sv is assumed to be octets in that encoding, and the sv
10842 will be converted into Unicode (and UTF-8).
10844 If the sv already is UTF-8 (or if it is not POK), or if the encoding
10845 is not a reference, nothing is done to the sv. If the encoding is not
10846 an C<Encode::XS> Encoding object, bad things will happen.
10847 (See F<lib/encoding.pm> and L<Encode>).
10849 The PV of the sv is returned.
10854 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
10857 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
10871 Passing sv_yes is wrong - it needs to be or'ed set of constants
10872 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
10873 remove converted chars from source.
10875 Both will default the value - let them.
10877 XPUSHs(&PL_sv_yes);
10880 call_method("decode", G_SCALAR);
10884 s = SvPV_const(uni, len);
10885 if (s != SvPVX_const(sv)) {
10886 SvGROW(sv, len + 1);
10887 Move(s, SvPVX(sv), len + 1, char);
10888 SvCUR_set(sv, len);
10895 return SvPOKp(sv) ? SvPVX(sv) : NULL;
10899 =for apidoc sv_cat_decode
10901 The encoding is assumed to be an Encode object, the PV of the ssv is
10902 assumed to be octets in that encoding and decoding the input starts
10903 from the position which (PV + *offset) pointed to. The dsv will be
10904 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
10905 when the string tstr appears in decoding output or the input ends on
10906 the PV of the ssv. The value which the offset points will be modified
10907 to the last input position on the ssv.
10909 Returns TRUE if the terminator was found, else returns FALSE.
10914 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
10915 SV *ssv, int *offset, char *tstr, int tlen)
10919 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
10930 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
10931 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
10933 call_method("cat_decode", G_SCALAR);
10935 ret = SvTRUE(TOPs);
10936 *offset = SvIV(offsv);
10942 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
10947 /* ---------------------------------------------------------------------
10949 * support functions for report_uninit()
10952 /* the maxiumum size of array or hash where we will scan looking
10953 * for the undefined element that triggered the warning */
10955 #define FUV_MAX_SEARCH_SIZE 1000
10957 /* Look for an entry in the hash whose value has the same SV as val;
10958 * If so, return a mortal copy of the key. */
10961 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
10964 register HE **array;
10967 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
10968 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
10971 array = HvARRAY(hv);
10973 for (i=HvMAX(hv); i>0; i--) {
10974 register HE *entry;
10975 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
10976 if (HeVAL(entry) != val)
10978 if ( HeVAL(entry) == &PL_sv_undef ||
10979 HeVAL(entry) == &PL_sv_placeholder)
10983 if (HeKLEN(entry) == HEf_SVKEY)
10984 return sv_mortalcopy(HeKEY_sv(entry));
10985 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
10991 /* Look for an entry in the array whose value has the same SV as val;
10992 * If so, return the index, otherwise return -1. */
10995 S_find_array_subscript(pTHX_ AV *av, SV* val)
10999 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11000 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11004 for (i=AvFILLp(av); i>=0; i--) {
11005 if (svp[i] == val && svp[i] != &PL_sv_undef)
11011 /* S_varname(): return the name of a variable, optionally with a subscript.
11012 * If gv is non-zero, use the name of that global, along with gvtype (one
11013 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11014 * targ. Depending on the value of the subscript_type flag, return:
11017 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11018 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11019 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11020 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11023 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11024 SV* keyname, I32 aindex, int subscript_type)
11027 SV * const name = sv_newmortal();
11030 buffer[0] = gvtype;
11033 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11035 gv_fullname4(name, gv, buffer, 0);
11037 if ((unsigned int)SvPVX(name)[1] <= 26) {
11039 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11041 /* Swap the 1 unprintable control character for the 2 byte pretty
11042 version - ie substr($name, 1, 1) = $buffer; */
11043 sv_insert(name, 1, 1, buffer, 2);
11048 CV * const cv = find_runcv(&unused);
11052 if (!cv || !CvPADLIST(cv))
11054 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11055 sv = *av_fetch(av, targ, FALSE);
11056 /* SvLEN in a pad name is not to be trusted */
11057 sv_setpv(name, SvPV_nolen_const(sv));
11060 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11061 SV * const sv = NEWSV(0,0);
11062 *SvPVX(name) = '$';
11063 Perl_sv_catpvf(aTHX_ name, "{%s}",
11064 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11067 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11068 *SvPVX(name) = '$';
11069 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11071 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11072 sv_insert(name, 0, 0, "within ", 7);
11079 =for apidoc find_uninit_var
11081 Find the name of the undefined variable (if any) that caused the operator o
11082 to issue a "Use of uninitialized value" warning.
11083 If match is true, only return a name if it's value matches uninit_sv.
11084 So roughly speaking, if a unary operator (such as OP_COS) generates a
11085 warning, then following the direct child of the op may yield an
11086 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11087 other hand, with OP_ADD there are two branches to follow, so we only print
11088 the variable name if we get an exact match.
11090 The name is returned as a mortal SV.
11092 Assumes that PL_op is the op that originally triggered the error, and that
11093 PL_comppad/PL_curpad points to the currently executing pad.
11099 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11107 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11108 uninit_sv == &PL_sv_placeholder)))
11111 switch (obase->op_type) {
11118 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11119 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11121 SV *keysv = Nullsv;
11122 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11124 if (pad) { /* @lex, %lex */
11125 sv = PAD_SVl(obase->op_targ);
11129 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11130 /* @global, %global */
11131 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11134 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11136 else /* @{expr}, %{expr} */
11137 return find_uninit_var(cUNOPx(obase)->op_first,
11141 /* attempt to find a match within the aggregate */
11143 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11145 subscript_type = FUV_SUBSCRIPT_HASH;
11148 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11150 subscript_type = FUV_SUBSCRIPT_ARRAY;
11153 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11156 return varname(gv, hash ? '%' : '@', obase->op_targ,
11157 keysv, index, subscript_type);
11161 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11163 return varname(Nullgv, '$', obase->op_targ,
11164 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11167 gv = cGVOPx_gv(obase);
11168 if (!gv || (match && GvSV(gv) != uninit_sv))
11170 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11173 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11176 av = (AV*)PAD_SV(obase->op_targ);
11177 if (!av || SvRMAGICAL(av))
11179 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11180 if (!svp || *svp != uninit_sv)
11183 return varname(Nullgv, '$', obase->op_targ,
11184 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11187 gv = cGVOPx_gv(obase);
11193 if (!av || SvRMAGICAL(av))
11195 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11196 if (!svp || *svp != uninit_sv)
11199 return varname(gv, '$', 0,
11200 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11205 o = cUNOPx(obase)->op_first;
11206 if (!o || o->op_type != OP_NULL ||
11207 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11209 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11213 if (PL_op == obase)
11214 /* $a[uninit_expr] or $h{uninit_expr} */
11215 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11218 o = cBINOPx(obase)->op_first;
11219 kid = cBINOPx(obase)->op_last;
11221 /* get the av or hv, and optionally the gv */
11223 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11224 sv = PAD_SV(o->op_targ);
11226 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11227 && cUNOPo->op_first->op_type == OP_GV)
11229 gv = cGVOPx_gv(cUNOPo->op_first);
11232 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11237 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11238 /* index is constant */
11242 if (obase->op_type == OP_HELEM) {
11243 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11244 if (!he || HeVAL(he) != uninit_sv)
11248 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11249 if (!svp || *svp != uninit_sv)
11253 if (obase->op_type == OP_HELEM)
11254 return varname(gv, '%', o->op_targ,
11255 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11257 return varname(gv, '@', o->op_targ, Nullsv,
11258 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11261 /* index is an expression;
11262 * attempt to find a match within the aggregate */
11263 if (obase->op_type == OP_HELEM) {
11264 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11266 return varname(gv, '%', o->op_targ,
11267 keysv, 0, FUV_SUBSCRIPT_HASH);
11270 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11272 return varname(gv, '@', o->op_targ,
11273 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11278 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11280 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11286 /* only examine RHS */
11287 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11290 o = cUNOPx(obase)->op_first;
11291 if (o->op_type == OP_PUSHMARK)
11294 if (!o->op_sibling) {
11295 /* one-arg version of open is highly magical */
11297 if (o->op_type == OP_GV) { /* open FOO; */
11299 if (match && GvSV(gv) != uninit_sv)
11301 return varname(gv, '$', 0,
11302 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11304 /* other possibilities not handled are:
11305 * open $x; or open my $x; should return '${*$x}'
11306 * open expr; should return '$'.expr ideally
11312 /* ops where $_ may be an implicit arg */
11316 if ( !(obase->op_flags & OPf_STACKED)) {
11317 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11318 ? PAD_SVl(obase->op_targ)
11321 sv = sv_newmortal();
11322 sv_setpvn(sv, "$_", 2);
11330 /* skip filehandle as it can't produce 'undef' warning */
11331 o = cUNOPx(obase)->op_first;
11332 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11333 o = o->op_sibling->op_sibling;
11340 match = 1; /* XS or custom code could trigger random warnings */
11345 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11346 return sv_2mortal(newSVpvn("${$/}", 5));
11351 if (!(obase->op_flags & OPf_KIDS))
11353 o = cUNOPx(obase)->op_first;
11359 /* if all except one arg are constant, or have no side-effects,
11360 * or are optimized away, then it's unambiguous */
11362 for (kid=o; kid; kid = kid->op_sibling) {
11364 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11365 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11366 || (kid->op_type == OP_PUSHMARK)
11370 if (o2) { /* more than one found */
11377 return find_uninit_var(o2, uninit_sv, match);
11379 /* scan all args */
11381 sv = find_uninit_var(o, uninit_sv, 1);
11393 =for apidoc report_uninit
11395 Print appropriate "Use of uninitialized variable" warning
11401 Perl_report_uninit(pTHX_ SV* uninit_sv)
11404 SV* varname = Nullsv;
11406 varname = find_uninit_var(PL_op, uninit_sv,0);
11408 sv_insert(varname, 0, 0, " ", 1);
11410 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11411 varname ? SvPV_nolen_const(varname) : "",
11412 " in ", OP_DESC(PL_op));
11415 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11421 * c-indentation-style: bsd
11422 * c-basic-offset: 4
11423 * indent-tabs-mode: t
11426 * ex: set ts=8 sts=4 sw=4 noet: