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)
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 **arena_root = &PL_body_arenaroots[sv_type];
644 void **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 **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 **thing_copy = (void **)thing; \
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s, *end;
1417 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
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 =for apidoc sv_2iv_flags
1631 Return the integer value of an SV, doing any necessary string
1632 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1633 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1639 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1643 if (SvGMAGICAL(sv)) {
1644 if (flags & SV_GMAGIC)
1649 return I_V(SvNVX(sv));
1651 if (SvPOKp(sv) && SvLEN(sv))
1654 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1655 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1661 if (SvTHINKFIRST(sv)) {
1664 SV * const tmpstr=AMG_CALLun(sv,numer);
1665 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1666 return SvIV(tmpstr);
1669 return PTR2IV(SvRV(sv));
1672 sv_force_normal_flags(sv, 0);
1674 if (SvREADONLY(sv) && !SvOK(sv)) {
1675 if (ckWARN(WARN_UNINITIALIZED))
1682 return (IV)(SvUVX(sv));
1689 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1690 * without also getting a cached IV/UV from it at the same time
1691 * (ie PV->NV conversion should detect loss of accuracy and cache
1692 * IV or UV at same time to avoid this. NWC */
1694 if (SvTYPE(sv) == SVt_NV)
1695 sv_upgrade(sv, SVt_PVNV);
1697 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1698 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1699 certainly cast into the IV range at IV_MAX, whereas the correct
1700 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1702 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1703 SvIV_set(sv, I_V(SvNVX(sv)));
1704 if (SvNVX(sv) == (NV) SvIVX(sv)
1705 #ifndef NV_PRESERVES_UV
1706 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1707 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1708 /* Don't flag it as "accurately an integer" if the number
1709 came from a (by definition imprecise) NV operation, and
1710 we're outside the range of NV integer precision */
1713 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1714 DEBUG_c(PerlIO_printf(Perl_debug_log,
1715 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1721 /* IV not precise. No need to convert from PV, as NV
1722 conversion would already have cached IV if it detected
1723 that PV->IV would be better than PV->NV->IV
1724 flags already correct - don't set public IOK. */
1725 DEBUG_c(PerlIO_printf(Perl_debug_log,
1726 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1731 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1732 but the cast (NV)IV_MIN rounds to a the value less (more
1733 negative) than IV_MIN which happens to be equal to SvNVX ??
1734 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1735 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1736 (NV)UVX == NVX are both true, but the values differ. :-(
1737 Hopefully for 2s complement IV_MIN is something like
1738 0x8000000000000000 which will be exact. NWC */
1741 SvUV_set(sv, U_V(SvNVX(sv)));
1743 (SvNVX(sv) == (NV) SvUVX(sv))
1744 #ifndef NV_PRESERVES_UV
1745 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1746 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1747 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1748 /* Don't flag it as "accurately an integer" if the number
1749 came from a (by definition imprecise) NV operation, and
1750 we're outside the range of NV integer precision */
1755 DEBUG_c(PerlIO_printf(Perl_debug_log,
1756 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1762 else if (SvPOKp(sv) && SvLEN(sv)) {
1764 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1765 /* We want to avoid a possible problem when we cache an IV which
1766 may be later translated to an NV, and the resulting NV is not
1767 the same as the direct translation of the initial string
1768 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1769 be careful to ensure that the value with the .456 is around if the
1770 NV value is requested in the future).
1772 This means that if we cache such an IV, we need to cache the
1773 NV as well. Moreover, we trade speed for space, and do not
1774 cache the NV if we are sure it's not needed.
1777 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1778 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1779 == IS_NUMBER_IN_UV) {
1780 /* It's definitely an integer, only upgrade to PVIV */
1781 if (SvTYPE(sv) < SVt_PVIV)
1782 sv_upgrade(sv, SVt_PVIV);
1784 } else if (SvTYPE(sv) < SVt_PVNV)
1785 sv_upgrade(sv, SVt_PVNV);
1787 /* If NV preserves UV then we only use the UV value if we know that
1788 we aren't going to call atof() below. If NVs don't preserve UVs
1789 then the value returned may have more precision than atof() will
1790 return, even though value isn't perfectly accurate. */
1791 if ((numtype & (IS_NUMBER_IN_UV
1792 #ifdef NV_PRESERVES_UV
1795 )) == IS_NUMBER_IN_UV) {
1796 /* This won't turn off the public IOK flag if it was set above */
1797 (void)SvIOKp_on(sv);
1799 if (!(numtype & IS_NUMBER_NEG)) {
1801 if (value <= (UV)IV_MAX) {
1802 SvIV_set(sv, (IV)value);
1804 SvUV_set(sv, value);
1808 /* 2s complement assumption */
1809 if (value <= (UV)IV_MIN) {
1810 SvIV_set(sv, -(IV)value);
1812 /* Too negative for an IV. This is a double upgrade, but
1813 I'm assuming it will be rare. */
1814 if (SvTYPE(sv) < SVt_PVNV)
1815 sv_upgrade(sv, SVt_PVNV);
1819 SvNV_set(sv, -(NV)value);
1820 SvIV_set(sv, IV_MIN);
1824 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1825 will be in the previous block to set the IV slot, and the next
1826 block to set the NV slot. So no else here. */
1828 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1829 != IS_NUMBER_IN_UV) {
1830 /* It wasn't an (integer that doesn't overflow the UV). */
1831 SvNV_set(sv, Atof(SvPVX_const(sv)));
1833 if (! numtype && ckWARN(WARN_NUMERIC))
1836 #if defined(USE_LONG_DOUBLE)
1837 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1838 PTR2UV(sv), SvNVX(sv)));
1840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1841 PTR2UV(sv), SvNVX(sv)));
1845 #ifdef NV_PRESERVES_UV
1846 (void)SvIOKp_on(sv);
1848 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1849 SvIV_set(sv, I_V(SvNVX(sv)));
1850 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1853 /* Integer is imprecise. NOK, IOKp */
1855 /* UV will not work better than IV */
1857 if (SvNVX(sv) > (NV)UV_MAX) {
1859 /* Integer is inaccurate. NOK, IOKp, is UV */
1860 SvUV_set(sv, UV_MAX);
1863 SvUV_set(sv, U_V(SvNVX(sv)));
1864 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1869 /* Integer is imprecise. NOK, IOKp, is UV */
1874 #else /* NV_PRESERVES_UV */
1875 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1876 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1877 /* The IV slot will have been set from value returned by
1878 grok_number above. The NV slot has just been set using
1881 assert (SvIOKp(sv));
1883 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1884 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1885 /* Small enough to preserve all bits. */
1886 (void)SvIOKp_on(sv);
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1891 /* Assumption: first non-preserved integer is < IV_MAX,
1892 this NV is in the preserved range, therefore: */
1893 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1895 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);
1899 0 0 already failed to read UV.
1900 0 1 already failed to read UV.
1901 1 0 you won't get here in this case. IV/UV
1902 slot set, public IOK, Atof() unneeded.
1903 1 1 already read UV.
1904 so there's no point in sv_2iuv_non_preserve() attempting
1905 to use atol, strtol, strtoul etc. */
1906 sv_2iuv_non_preserve (sv, numtype);
1909 #endif /* NV_PRESERVES_UV */
1912 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1914 if (SvTYPE(sv) < SVt_IV)
1915 /* Typically the caller expects that sv_any is not NULL now. */
1916 sv_upgrade(sv, SVt_IV);
1919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1920 PTR2UV(sv),SvIVX(sv)));
1921 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1925 =for apidoc sv_2uv_flags
1927 Return the unsigned integer value of an SV, doing any necessary string
1928 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1929 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1935 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1939 if (SvGMAGICAL(sv)) {
1940 if (flags & SV_GMAGIC)
1945 return U_V(SvNVX(sv));
1946 if (SvPOKp(sv) && SvLEN(sv))
1949 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1950 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1956 if (SvTHINKFIRST(sv)) {
1959 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1960 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1961 return SvUV(tmpstr);
1962 return PTR2UV(SvRV(sv));
1965 sv_force_normal_flags(sv, 0);
1967 if (SvREADONLY(sv) && !SvOK(sv)) {
1968 if (ckWARN(WARN_UNINITIALIZED))
1978 return (UV)SvIVX(sv);
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1993 SvIV_set(sv, I_V(SvNVX(sv)));
1994 if (SvNVX(sv) == (NV) SvIVX(sv)
1995 #ifndef NV_PRESERVES_UV
1996 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1997 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1998 /* Don't flag it as "accurately an integer" if the number
1999 came from a (by definition imprecise) NV operation, and
2000 we're outside the range of NV integer precision */
2003 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2004 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2011 /* IV not precise. No need to convert from PV, as NV
2012 conversion would already have cached IV if it detected
2013 that PV->IV would be better than PV->NV->IV
2014 flags already correct - don't set public IOK. */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2021 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022 but the cast (NV)IV_MIN rounds to a the value less (more
2023 negative) than IV_MIN which happens to be equal to SvNVX ??
2024 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026 (NV)UVX == NVX are both true, but the values differ. :-(
2027 Hopefully for 2s complement IV_MIN is something like
2028 0x8000000000000000 which will be exact. NWC */
2031 SvUV_set(sv, U_V(SvNVX(sv)));
2033 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef NV_PRESERVES_UV
2035 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038 /* Don't flag it as "accurately an integer" if the number
2039 came from a (by definition imprecise) NV operation, and
2040 we're outside the range of NV integer precision */
2045 DEBUG_c(PerlIO_printf(Perl_debug_log,
2046 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2052 else if (SvPOKp(sv) && SvLEN(sv)) {
2054 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2056 /* We want to avoid a possible problem when we cache a UV which
2057 may be later translated to an NV, and the resulting NV is not
2058 the translation of the initial data.
2060 This means that if we cache such a UV, we need to cache the
2061 NV as well. Moreover, we trade speed for space, and do not
2062 cache the NV if not needed.
2065 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2066 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2067 == IS_NUMBER_IN_UV) {
2068 /* It's definitely an integer, only upgrade to PVIV */
2069 if (SvTYPE(sv) < SVt_PVIV)
2070 sv_upgrade(sv, SVt_PVIV);
2072 } else if (SvTYPE(sv) < SVt_PVNV)
2073 sv_upgrade(sv, SVt_PVNV);
2075 /* If NV preserves UV then we only use the UV value if we know that
2076 we aren't going to call atof() below. If NVs don't preserve UVs
2077 then the value returned may have more precision than atof() will
2078 return, even though it isn't accurate. */
2079 if ((numtype & (IS_NUMBER_IN_UV
2080 #ifdef NV_PRESERVES_UV
2083 )) == IS_NUMBER_IN_UV) {
2084 /* This won't turn off the public IOK flag if it was set above */
2085 (void)SvIOKp_on(sv);
2087 if (!(numtype & IS_NUMBER_NEG)) {
2089 if (value <= (UV)IV_MAX) {
2090 SvIV_set(sv, (IV)value);
2092 /* it didn't overflow, and it was positive. */
2093 SvUV_set(sv, value);
2097 /* 2s complement assumption */
2098 if (value <= (UV)IV_MIN) {
2099 SvIV_set(sv, -(IV)value);
2101 /* Too negative for an IV. This is a double upgrade, but
2102 I'm assuming it will be rare. */
2103 if (SvTYPE(sv) < SVt_PVNV)
2104 sv_upgrade(sv, SVt_PVNV);
2108 SvNV_set(sv, -(NV)value);
2109 SvIV_set(sv, IV_MIN);
2114 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2115 != IS_NUMBER_IN_UV) {
2116 /* It wasn't an integer, or it overflowed the UV. */
2117 SvNV_set(sv, Atof(SvPVX_const(sv)));
2119 if (! numtype && ckWARN(WARN_NUMERIC))
2122 #if defined(USE_LONG_DOUBLE)
2123 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2124 PTR2UV(sv), SvNVX(sv)));
2126 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2127 PTR2UV(sv), SvNVX(sv)));
2130 #ifdef NV_PRESERVES_UV
2131 (void)SvIOKp_on(sv);
2133 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2134 SvIV_set(sv, I_V(SvNVX(sv)));
2135 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2138 /* Integer is imprecise. NOK, IOKp */
2140 /* UV will not work better than IV */
2142 if (SvNVX(sv) > (NV)UV_MAX) {
2144 /* Integer is inaccurate. NOK, IOKp, is UV */
2145 SvUV_set(sv, UV_MAX);
2148 SvUV_set(sv, U_V(SvNVX(sv)));
2149 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2150 NV preservse UV so can do correct comparison. */
2151 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2155 /* Integer is imprecise. NOK, IOKp, is UV */
2160 #else /* NV_PRESERVES_UV */
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2163 /* The UV slot will have been set from value returned by
2164 grok_number above. The NV slot has just been set using
2167 assert (SvIOKp(sv));
2169 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2170 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2171 /* Small enough to preserve all bits. */
2172 (void)SvIOKp_on(sv);
2174 SvIV_set(sv, I_V(SvNVX(sv)));
2175 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2177 /* Assumption: first non-preserved integer is < IV_MAX,
2178 this NV is in the preserved range, therefore: */
2179 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2181 Perl_croak(aTHX_ "sv_2uv 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);
2184 sv_2iuv_non_preserve (sv, numtype);
2186 #endif /* NV_PRESERVES_UV */
2190 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2191 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2194 if (SvTYPE(sv) < SVt_IV)
2195 /* Typically the caller expects that sv_any is not NULL now. */
2196 sv_upgrade(sv, SVt_IV);
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2201 PTR2UV(sv),SvUVX(sv)));
2202 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2208 Return the num value of an SV, doing any necessary string or integer
2209 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2216 Perl_sv_2nv(pTHX_ register SV *sv)
2220 if (SvGMAGICAL(sv)) {
2224 if (SvPOKp(sv) && SvLEN(sv)) {
2225 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2226 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2228 return Atof(SvPVX_const(sv));
2232 return (NV)SvUVX(sv);
2234 return (NV)SvIVX(sv);
2237 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2238 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2244 if (SvTHINKFIRST(sv)) {
2247 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2248 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2249 return SvNV(tmpstr);
2250 return PTR2NV(SvRV(sv));
2253 sv_force_normal_flags(sv, 0);
2255 if (SvREADONLY(sv) && !SvOK(sv)) {
2256 if (ckWARN(WARN_UNINITIALIZED))
2261 if (SvTYPE(sv) < SVt_NV) {
2262 if (SvTYPE(sv) == SVt_IV)
2263 sv_upgrade(sv, SVt_PVNV);
2265 sv_upgrade(sv, SVt_NV);
2266 #ifdef USE_LONG_DOUBLE
2268 STORE_NUMERIC_LOCAL_SET_STANDARD();
2269 PerlIO_printf(Perl_debug_log,
2270 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2271 PTR2UV(sv), SvNVX(sv));
2272 RESTORE_NUMERIC_LOCAL();
2276 STORE_NUMERIC_LOCAL_SET_STANDARD();
2277 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2278 PTR2UV(sv), SvNVX(sv));
2279 RESTORE_NUMERIC_LOCAL();
2283 else if (SvTYPE(sv) < SVt_PVNV)
2284 sv_upgrade(sv, SVt_PVNV);
2289 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2290 #ifdef NV_PRESERVES_UV
2293 /* Only set the public NV OK flag if this NV preserves the IV */
2294 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2295 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2296 : (SvIVX(sv) == I_V(SvNVX(sv))))
2302 else if (SvPOKp(sv) && SvLEN(sv)) {
2304 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2305 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2307 #ifdef NV_PRESERVES_UV
2308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2309 == IS_NUMBER_IN_UV) {
2310 /* It's definitely an integer */
2311 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2313 SvNV_set(sv, Atof(SvPVX_const(sv)));
2316 SvNV_set(sv, Atof(SvPVX_const(sv)));
2317 /* Only set the public NV OK flag if this NV preserves the value in
2318 the PV at least as well as an IV/UV would.
2319 Not sure how to do this 100% reliably. */
2320 /* if that shift count is out of range then Configure's test is
2321 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2323 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2324 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2325 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2326 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2327 /* Can't use strtol etc to convert this string, so don't try.
2328 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2331 /* value has been set. It may not be precise. */
2332 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2333 /* 2s complement assumption for (UV)IV_MIN */
2334 SvNOK_on(sv); /* Integer is too negative. */
2339 if (numtype & IS_NUMBER_NEG) {
2340 SvIV_set(sv, -(IV)value);
2341 } else if (value <= (UV)IV_MAX) {
2342 SvIV_set(sv, (IV)value);
2344 SvUV_set(sv, value);
2348 if (numtype & IS_NUMBER_NOT_INT) {
2349 /* I believe that even if the original PV had decimals,
2350 they are lost beyond the limit of the FP precision.
2351 However, neither is canonical, so both only get p
2352 flags. NWC, 2000/11/25 */
2353 /* Both already have p flags, so do nothing */
2355 const NV nv = SvNVX(sv);
2356 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2357 if (SvIVX(sv) == I_V(nv)) {
2362 /* It had no "." so it must be integer. */
2365 /* between IV_MAX and NV(UV_MAX).
2366 Could be slightly > UV_MAX */
2368 if (numtype & IS_NUMBER_NOT_INT) {
2369 /* UV and NV both imprecise. */
2371 const UV nv_as_uv = U_V(nv);
2373 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2384 #endif /* NV_PRESERVES_UV */
2387 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2389 if (SvTYPE(sv) < SVt_NV)
2390 /* Typically the caller expects that sv_any is not NULL now. */
2391 /* XXX Ilya implies that this is a bug in callers that assume this
2392 and ideally should be fixed. */
2393 sv_upgrade(sv, SVt_NV);
2396 #if defined(USE_LONG_DOUBLE)
2398 STORE_NUMERIC_LOCAL_SET_STANDARD();
2399 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 STORE_NUMERIC_LOCAL_SET_STANDARD();
2406 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2407 PTR2UV(sv), SvNVX(sv));
2408 RESTORE_NUMERIC_LOCAL();
2414 /* asIV(): extract an integer from the string value of an SV.
2415 * Caller must validate PVX */
2418 S_asIV(pTHX_ SV *sv)
2421 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2424 == IS_NUMBER_IN_UV) {
2425 /* It's definitely an integer */
2426 if (numtype & IS_NUMBER_NEG) {
2427 if (value < (UV)IV_MIN)
2430 if (value < (UV)IV_MAX)
2435 if (ckWARN(WARN_NUMERIC))
2438 return I_V(Atof(SvPVX_const(sv)));
2441 /* asUV(): extract an unsigned integer from the string value of an SV
2442 * Caller must validate PVX */
2445 S_asUV(pTHX_ SV *sv)
2448 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2450 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2451 == IS_NUMBER_IN_UV) {
2452 /* It's definitely an integer */
2453 if (!(numtype & IS_NUMBER_NEG))
2457 if (ckWARN(WARN_NUMERIC))
2460 return U_V(Atof(SvPVX_const(sv)));
2463 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2464 * UV as a string towards the end of buf, and return pointers to start and
2467 * We assume that buf is at least TYPE_CHARS(UV) long.
2471 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2473 char *ptr = buf + TYPE_CHARS(UV);
2474 char * const ebuf = ptr;
2487 *--ptr = '0' + (char)(uv % 10);
2496 =for apidoc sv_2pv_flags
2498 Returns a pointer to the string value of an SV, and sets *lp to its length.
2499 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2501 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2502 usually end up here too.
2508 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2513 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2514 char *tmpbuf = tbuf;
2515 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
2522 if (SvGMAGICAL(sv)) {
2523 if (flags & SV_GMAGIC)
2528 if (flags & SV_MUTABLE_RETURN)
2529 return SvPVX_mutable(sv);
2530 if (flags & SV_CONST_RETURN)
2531 return (char *)SvPVX_const(sv);
2535 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2536 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2538 goto tokensave_has_len;
2541 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2546 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2547 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2555 if (SvTHINKFIRST(sv)) {
2558 register const char *typestr;
2559 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2560 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2562 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2565 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2566 if (flags & SV_CONST_RETURN) {
2567 pv = (char *) SvPVX_const(tmpstr);
2569 pv = (flags & SV_MUTABLE_RETURN)
2570 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2573 *lp = SvCUR(tmpstr);
2575 pv = sv_2pv_flags(tmpstr, lp, flags);
2586 typestr = "NULLREF";
2590 switch (SvTYPE(sv)) {
2592 if ( ((SvFLAGS(sv) &
2593 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2594 == (SVs_OBJECT|SVs_SMG))
2595 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2596 const regexp *re = (regexp *)mg->mg_obj;
2599 const char *fptr = "msix";
2604 char need_newline = 0;
2605 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2607 while((ch = *fptr++)) {
2609 reflags[left++] = ch;
2612 reflags[right--] = ch;
2617 reflags[left] = '-';
2621 mg->mg_len = re->prelen + 4 + left;
2623 * If /x was used, we have to worry about a regex
2624 * ending with a comment later being embedded
2625 * within another regex. If so, we don't want this
2626 * regex's "commentization" to leak out to the
2627 * right part of the enclosing regex, we must cap
2628 * it with a newline.
2630 * So, if /x was used, we scan backwards from the
2631 * end of the regex. If we find a '#' before we
2632 * find a newline, we need to add a newline
2633 * ourself. If we find a '\n' first (or if we
2634 * don't find '#' or '\n'), we don't need to add
2635 * anything. -jfriedl
2637 if (PMf_EXTENDED & re->reganch)
2639 const char *endptr = re->precomp + re->prelen;
2640 while (endptr >= re->precomp)
2642 const char c = *(endptr--);
2644 break; /* don't need another */
2646 /* we end while in a comment, so we
2648 mg->mg_len++; /* save space for it */
2649 need_newline = 1; /* note to add it */
2655 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2656 Copy("(?", mg->mg_ptr, 2, char);
2657 Copy(reflags, mg->mg_ptr+2, left, char);
2658 Copy(":", mg->mg_ptr+left+2, 1, char);
2659 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2661 mg->mg_ptr[mg->mg_len - 2] = '\n';
2662 mg->mg_ptr[mg->mg_len - 1] = ')';
2663 mg->mg_ptr[mg->mg_len] = 0;
2665 PL_reginterp_cnt += re->program[0].next_off;
2667 if (re->reganch & ROPT_UTF8)
2683 case SVt_PVBM: typestr = SvVOK(sv) ? "VSTRING"
2684 : SvROK(sv) ? "REF" : "SCALAR"; break;
2685 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
2686 /* tied lvalues should appear to be
2687 * scalars for backwards compatitbility */
2688 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
2689 ? "SCALAR" : "LVALUE"; break;
2690 case SVt_PVAV: typestr = "ARRAY"; break;
2691 case SVt_PVHV: typestr = "HASH"; break;
2692 case SVt_PVCV: typestr = "CODE"; break;
2693 case SVt_PVGV: typestr = "GLOB"; break;
2694 case SVt_PVFM: typestr = "FORMAT"; break;
2695 case SVt_PVIO: typestr = "IO"; break;
2696 default: typestr = "UNKNOWN"; break;
2700 const char * const name = HvNAME_get(SvSTASH(sv));
2701 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2702 name ? name : "__ANON__" , typestr, PTR2UV(sv));
2705 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
2709 *lp = strlen(typestr);
2710 return (char *)typestr;
2712 if (SvREADONLY(sv) && !SvOK(sv)) {
2713 if (ckWARN(WARN_UNINITIALIZED))
2720 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2721 /* I'm assuming that if both IV and NV are equally valid then
2722 converting the IV is going to be more efficient */
2723 const U32 isIOK = SvIOK(sv);
2724 const U32 isUIOK = SvIsUV(sv);
2725 char buf[TYPE_CHARS(UV)];
2728 if (SvTYPE(sv) < SVt_PVIV)
2729 sv_upgrade(sv, SVt_PVIV);
2731 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2733 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2734 /* inlined from sv_setpvn */
2735 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2736 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2737 SvCUR_set(sv, ebuf - ptr);
2747 else if (SvNOKp(sv)) {
2748 if (SvTYPE(sv) < SVt_PVNV)
2749 sv_upgrade(sv, SVt_PVNV);
2750 /* The +20 is pure guesswork. Configure test needed. --jhi */
2751 s = SvGROW_mutable(sv, NV_DIG + 20);
2752 olderrno = errno; /* some Xenix systems wipe out errno here */
2754 if (SvNVX(sv) == 0.0)
2755 (void)strcpy(s,"0");
2759 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2762 #ifdef FIXNEGATIVEZERO
2763 if (*s == '-' && s[1] == '0' && !s[2])
2773 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2777 if (SvTYPE(sv) < SVt_PV)
2778 /* Typically the caller expects that sv_any is not NULL now. */
2779 sv_upgrade(sv, SVt_PV);
2783 const STRLEN len = s - SvPVX_const(sv);
2789 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2790 PTR2UV(sv),SvPVX_const(sv)));
2791 if (flags & SV_CONST_RETURN)
2792 return (char *)SvPVX_const(sv);
2793 if (flags & SV_MUTABLE_RETURN)
2794 return SvPVX_mutable(sv);
2798 len = strlen(tmpbuf);
2801 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2802 /* Sneaky stuff here */
2806 tsv = newSVpvn(tmpbuf, len);
2815 #ifdef FIXNEGATIVEZERO
2816 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2822 SvUPGRADE(sv, SVt_PV);
2825 s = SvGROW_mutable(sv, len + 1);
2828 return memcpy(s, tmpbuf, len + 1);
2833 =for apidoc sv_copypv
2835 Copies a stringified representation of the source SV into the
2836 destination SV. Automatically performs any necessary mg_get and
2837 coercion of numeric values into strings. Guaranteed to preserve
2838 UTF-8 flag even from overloaded objects. Similar in nature to
2839 sv_2pv[_flags] but operates directly on an SV instead of just the
2840 string. Mostly uses sv_2pv_flags to do its work, except when that
2841 would lose the UTF-8'ness of the PV.
2847 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2850 const char * const s = SvPV_const(ssv,len);
2851 sv_setpvn(dsv,s,len);
2859 =for apidoc sv_2pvbyte
2861 Return a pointer to the byte-encoded representation of the SV, and set *lp
2862 to its length. May cause the SV to be downgraded from UTF-8 as a
2865 Usually accessed via the C<SvPVbyte> macro.
2871 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2873 sv_utf8_downgrade(sv,0);
2874 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2878 =for apidoc sv_2pvutf8
2880 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2881 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2883 Usually accessed via the C<SvPVutf8> macro.
2889 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2891 sv_utf8_upgrade(sv);
2892 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2897 =for apidoc sv_2bool
2899 This function is only called on magical items, and is only used by
2900 sv_true() or its macro equivalent.
2906 Perl_sv_2bool(pTHX_ register SV *sv)
2914 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2915 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2916 return (bool)SvTRUE(tmpsv);
2917 return SvRV(sv) != 0;
2920 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2922 (*sv->sv_u.svu_pv > '0' ||
2923 Xpvtmp->xpv_cur > 1 ||
2924 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2931 return SvIVX(sv) != 0;
2934 return SvNVX(sv) != 0.0;
2942 =for apidoc sv_utf8_upgrade
2944 Converts the PV of an SV to its UTF-8-encoded form.
2945 Forces the SV to string form if it is not already.
2946 Always sets the SvUTF8 flag to avoid future validity checks even
2947 if all the bytes have hibit clear.
2949 This is not as a general purpose byte encoding to Unicode interface:
2950 use the Encode extension for that.
2952 =for apidoc sv_utf8_upgrade_flags
2954 Converts the PV of an SV to its UTF-8-encoded form.
2955 Forces the SV to string form if it is not already.
2956 Always sets the SvUTF8 flag to avoid future validity checks even
2957 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2958 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2959 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2961 This is not as a general purpose byte encoding to Unicode interface:
2962 use the Encode extension for that.
2968 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2970 if (sv == &PL_sv_undef)
2974 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2975 (void) sv_2pv_flags(sv,&len, flags);
2979 (void) SvPV_force(sv,len);
2988 sv_force_normal_flags(sv, 0);
2991 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2992 sv_recode_to_utf8(sv, PL_encoding);
2993 else { /* Assume Latin-1/EBCDIC */
2994 /* This function could be much more efficient if we
2995 * had a FLAG in SVs to signal if there are any hibit
2996 * chars in the PV. Given that there isn't such a flag
2997 * make the loop as fast as possible. */
2998 const U8 *s = (U8 *) SvPVX_const(sv);
2999 const U8 * const e = (U8 *) SvEND(sv);
3005 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3009 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3010 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3012 SvPV_free(sv); /* No longer using what was there before. */
3014 SvPV_set(sv, (char*)recoded);
3015 SvCUR_set(sv, len - 1);
3016 SvLEN_set(sv, len); /* No longer know the real size. */
3018 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3025 =for apidoc sv_utf8_downgrade
3027 Attempts to convert the PV of an SV from characters to bytes.
3028 If the PV contains a character beyond byte, this conversion will fail;
3029 in this case, either returns false or, if C<fail_ok> is not
3032 This is not as a general purpose Unicode to byte encoding interface:
3033 use the Encode extension for that.
3039 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3041 if (SvPOKp(sv) && SvUTF8(sv)) {
3047 sv_force_normal_flags(sv, 0);
3049 s = (U8 *) SvPV(sv, len);
3050 if (!utf8_to_bytes(s, &len)) {
3055 Perl_croak(aTHX_ "Wide character in %s",
3058 Perl_croak(aTHX_ "Wide character");
3069 =for apidoc sv_utf8_encode
3071 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3072 flag off so that it looks like octets again.
3078 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3080 (void) sv_utf8_upgrade(sv);
3082 sv_force_normal_flags(sv, 0);
3084 if (SvREADONLY(sv)) {
3085 Perl_croak(aTHX_ PL_no_modify);
3091 =for apidoc sv_utf8_decode
3093 If the PV of the SV is an octet sequence in UTF-8
3094 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3095 so that it looks like a character. If the PV contains only single-byte
3096 characters, the C<SvUTF8> flag stays being off.
3097 Scans PV for validity and returns false if the PV is invalid UTF-8.
3103 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3109 /* The octets may have got themselves encoded - get them back as
3112 if (!sv_utf8_downgrade(sv, TRUE))
3115 /* it is actually just a matter of turning the utf8 flag on, but
3116 * we want to make sure everything inside is valid utf8 first.
3118 c = (const U8 *) SvPVX_const(sv);
3119 if (!is_utf8_string(c, SvCUR(sv)+1))
3121 e = (const U8 *) SvEND(sv);
3124 if (!UTF8_IS_INVARIANT(ch)) {
3134 =for apidoc sv_setsv
3136 Copies the contents of the source SV C<ssv> into the destination SV
3137 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3138 function if the source SV needs to be reused. Does not handle 'set' magic.
3139 Loosely speaking, it performs a copy-by-value, obliterating any previous
3140 content of the destination.
3142 You probably want to use one of the assortment of wrappers, such as
3143 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3144 C<SvSetMagicSV_nosteal>.
3146 =for apidoc sv_setsv_flags
3148 Copies the contents of the source SV C<ssv> into the destination SV
3149 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3150 function if the source SV needs to be reused. Does not handle 'set' magic.
3151 Loosely speaking, it performs a copy-by-value, obliterating any previous
3152 content of the destination.
3153 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3154 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3155 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3156 and C<sv_setsv_nomg> are implemented in terms of this function.
3158 You probably want to use one of the assortment of wrappers, such as
3159 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3160 C<SvSetMagicSV_nosteal>.
3162 This is the primary function for copying scalars, and most other
3163 copy-ish functions and macros use this underneath.
3169 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3171 register U32 sflags;
3177 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3179 sstr = &PL_sv_undef;
3180 stype = SvTYPE(sstr);
3181 dtype = SvTYPE(dstr);
3186 /* need to nuke the magic */
3188 SvRMAGICAL_off(dstr);
3191 /* There's a lot of redundancy below but we're going for speed here */
3196 if (dtype != SVt_PVGV) {
3197 (void)SvOK_off(dstr);
3205 sv_upgrade(dstr, SVt_IV);
3208 sv_upgrade(dstr, SVt_PVNV);
3212 sv_upgrade(dstr, SVt_PVIV);
3215 (void)SvIOK_only(dstr);
3216 SvIV_set(dstr, SvIVX(sstr));
3219 if (SvTAINTED(sstr))
3230 sv_upgrade(dstr, SVt_NV);
3235 sv_upgrade(dstr, SVt_PVNV);
3238 SvNV_set(dstr, SvNVX(sstr));
3239 (void)SvNOK_only(dstr);
3240 if (SvTAINTED(sstr))
3248 sv_upgrade(dstr, SVt_RV);
3249 else if (dtype == SVt_PVGV &&
3250 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3253 if (GvIMPORTED(dstr) != GVf_IMPORTED
3254 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3256 GvIMPORTED_on(dstr);
3265 #ifdef PERL_OLD_COPY_ON_WRITE
3266 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3267 if (dtype < SVt_PVIV)
3268 sv_upgrade(dstr, SVt_PVIV);
3275 sv_upgrade(dstr, SVt_PV);
3278 if (dtype < SVt_PVIV)
3279 sv_upgrade(dstr, SVt_PVIV);
3282 if (dtype < SVt_PVNV)
3283 sv_upgrade(dstr, SVt_PVNV);
3290 const char * const type = sv_reftype(sstr,0);
3292 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3294 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3299 if (dtype <= SVt_PVGV) {
3301 if (dtype != SVt_PVGV) {
3302 const char * const name = GvNAME(sstr);
3303 const STRLEN len = GvNAMELEN(sstr);
3304 /* don't upgrade SVt_PVLV: it can hold a glob */
3305 if (dtype != SVt_PVLV)
3306 sv_upgrade(dstr, SVt_PVGV);
3307 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3308 GvSTASH(dstr) = GvSTASH(sstr);
3310 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3311 GvNAME(dstr) = savepvn(name, len);
3312 GvNAMELEN(dstr) = len;
3313 SvFAKE_on(dstr); /* can coerce to non-glob */
3316 #ifdef GV_UNIQUE_CHECK
3317 if (GvUNIQUE((GV*)dstr)) {
3318 Perl_croak(aTHX_ PL_no_modify);
3322 (void)SvOK_off(dstr);
3323 GvINTRO_off(dstr); /* one-shot flag */
3325 GvGP(dstr) = gp_ref(GvGP(sstr));
3326 if (SvTAINTED(sstr))
3328 if (GvIMPORTED(dstr) != GVf_IMPORTED
3329 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3331 GvIMPORTED_on(dstr);
3339 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3341 if ((int)SvTYPE(sstr) != stype) {
3342 stype = SvTYPE(sstr);
3343 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3347 if (stype == SVt_PVLV)
3348 SvUPGRADE(dstr, SVt_PVNV);
3350 SvUPGRADE(dstr, (U32)stype);
3353 sflags = SvFLAGS(sstr);
3355 if (sflags & SVf_ROK) {
3356 if (dtype >= SVt_PV) {
3357 if (dtype == SVt_PVGV) {
3358 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3360 const int intro = GvINTRO(dstr);
3362 #ifdef GV_UNIQUE_CHECK
3363 if (GvUNIQUE((GV*)dstr)) {
3364 Perl_croak(aTHX_ PL_no_modify);
3369 GvINTRO_off(dstr); /* one-shot flag */
3370 GvLINE(dstr) = CopLINE(PL_curcop);
3371 GvEGV(dstr) = (GV*)dstr;
3374 switch (SvTYPE(sref)) {
3377 SAVEGENERICSV(GvAV(dstr));
3379 dref = (SV*)GvAV(dstr);
3380 GvAV(dstr) = (AV*)sref;
3381 if (!GvIMPORTED_AV(dstr)
3382 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3384 GvIMPORTED_AV_on(dstr);
3389 SAVEGENERICSV(GvHV(dstr));
3391 dref = (SV*)GvHV(dstr);
3392 GvHV(dstr) = (HV*)sref;
3393 if (!GvIMPORTED_HV(dstr)
3394 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3396 GvIMPORTED_HV_on(dstr);
3401 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3402 SvREFCNT_dec(GvCV(dstr));
3403 GvCV(dstr) = Nullcv;
3404 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3405 PL_sub_generation++;
3407 SAVEGENERICSV(GvCV(dstr));
3410 dref = (SV*)GvCV(dstr);
3411 if (GvCV(dstr) != (CV*)sref) {
3412 CV* const cv = GvCV(dstr);
3414 if (!GvCVGEN((GV*)dstr) &&
3415 (CvROOT(cv) || CvXSUB(cv)))
3417 /* Redefining a sub - warning is mandatory if
3418 it was a const and its value changed. */
3419 if (ckWARN(WARN_REDEFINE)
3421 && (!CvCONST((CV*)sref)
3422 || sv_cmp(cv_const_sv(cv),
3423 cv_const_sv((CV*)sref)))))
3425 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3427 ? "Constant subroutine %s::%s redefined"
3428 : "Subroutine %s::%s redefined",
3429 HvNAME_get(GvSTASH((GV*)dstr)),
3430 GvENAME((GV*)dstr));
3434 cv_ckproto(cv, (GV*)dstr,
3436 ? SvPVX_const(sref) : Nullch);
3438 GvCV(dstr) = (CV*)sref;
3439 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3440 GvASSUMECV_on(dstr);
3441 PL_sub_generation++;
3443 if (!GvIMPORTED_CV(dstr)
3444 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3446 GvIMPORTED_CV_on(dstr);
3451 SAVEGENERICSV(GvIOp(dstr));
3453 dref = (SV*)GvIOp(dstr);
3454 GvIOp(dstr) = (IO*)sref;
3458 SAVEGENERICSV(GvFORM(dstr));
3460 dref = (SV*)GvFORM(dstr);
3461 GvFORM(dstr) = (CV*)sref;
3465 SAVEGENERICSV(GvSV(dstr));
3467 dref = (SV*)GvSV(dstr);
3469 if (!GvIMPORTED_SV(dstr)
3470 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3472 GvIMPORTED_SV_on(dstr);
3478 if (SvTAINTED(sstr))
3482 if (SvPVX_const(dstr)) {
3488 (void)SvOK_off(dstr);
3489 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3491 if (sflags & SVp_NOK) {
3493 /* Only set the public OK flag if the source has public OK. */
3494 if (sflags & SVf_NOK)
3495 SvFLAGS(dstr) |= SVf_NOK;
3496 SvNV_set(dstr, SvNVX(sstr));
3498 if (sflags & SVp_IOK) {
3499 (void)SvIOKp_on(dstr);
3500 if (sflags & SVf_IOK)
3501 SvFLAGS(dstr) |= SVf_IOK;
3502 if (sflags & SVf_IVisUV)
3504 SvIV_set(dstr, SvIVX(sstr));
3506 if (SvAMAGIC(sstr)) {
3510 else if (sflags & SVp_POK) {
3514 * Check to see if we can just swipe the string. If so, it's a
3515 * possible small lose on short strings, but a big win on long ones.
3516 * It might even be a win on short strings if SvPVX_const(dstr)
3517 * has to be allocated and SvPVX_const(sstr) has to be freed.
3520 /* Whichever path we take through the next code, we want this true,
3521 and doing it now facilitates the COW check. */
3522 (void)SvPOK_only(dstr);
3525 /* We're not already COW */
3526 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3527 #ifndef PERL_OLD_COPY_ON_WRITE
3528 /* or we are, but dstr isn't a suitable target. */
3529 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3534 (sflags & SVs_TEMP) && /* slated for free anyway? */
3535 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3536 (!(flags & SV_NOSTEAL)) &&
3537 /* and we're allowed to steal temps */
3538 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3539 SvLEN(sstr) && /* and really is a string */
3540 /* and won't be needed again, potentially */
3541 !(PL_op && PL_op->op_type == OP_AASSIGN))
3542 #ifdef PERL_OLD_COPY_ON_WRITE
3543 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3544 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3545 && SvTYPE(sstr) >= SVt_PVIV)
3548 /* Failed the swipe test, and it's not a shared hash key either.
3549 Have to copy the string. */
3550 STRLEN len = SvCUR(sstr);
3551 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3552 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3553 SvCUR_set(dstr, len);
3554 *SvEND(dstr) = '\0';
3556 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3558 /* Either it's a shared hash key, or it's suitable for
3559 copy-on-write or we can swipe the string. */
3561 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3565 #ifdef PERL_OLD_COPY_ON_WRITE
3567 /* I believe I should acquire a global SV mutex if
3568 it's a COW sv (not a shared hash key) to stop
3569 it going un copy-on-write.
3570 If the source SV has gone un copy on write between up there
3571 and down here, then (assert() that) it is of the correct
3572 form to make it copy on write again */
3573 if ((sflags & (SVf_FAKE | SVf_READONLY))
3574 != (SVf_FAKE | SVf_READONLY)) {
3575 SvREADONLY_on(sstr);
3577 /* Make the source SV into a loop of 1.
3578 (about to become 2) */
3579 SV_COW_NEXT_SV_SET(sstr, sstr);
3583 /* Initial code is common. */
3584 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3589 /* making another shared SV. */
3590 STRLEN cur = SvCUR(sstr);
3591 STRLEN len = SvLEN(sstr);
3592 #ifdef PERL_OLD_COPY_ON_WRITE
3594 assert (SvTYPE(dstr) >= SVt_PVIV);
3595 /* SvIsCOW_normal */
3596 /* splice us in between source and next-after-source. */
3597 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3598 SV_COW_NEXT_SV_SET(sstr, dstr);
3599 SvPV_set(dstr, SvPVX_mutable(sstr));
3603 /* SvIsCOW_shared_hash */
3604 DEBUG_C(PerlIO_printf(Perl_debug_log,
3605 "Copy on write: Sharing hash\n"));
3607 assert (SvTYPE(dstr) >= SVt_PV);
3609 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3611 SvLEN_set(dstr, len);
3612 SvCUR_set(dstr, cur);
3613 SvREADONLY_on(dstr);
3615 /* Relesase a global SV mutex. */
3618 { /* Passes the swipe test. */
3619 SvPV_set(dstr, SvPVX_mutable(sstr));
3620 SvLEN_set(dstr, SvLEN(sstr));
3621 SvCUR_set(dstr, SvCUR(sstr));
3624 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3625 SvPV_set(sstr, Nullch);
3631 if (sflags & SVf_UTF8)
3633 if (sflags & SVp_NOK) {
3635 if (sflags & SVf_NOK)
3636 SvFLAGS(dstr) |= SVf_NOK;
3637 SvNV_set(dstr, SvNVX(sstr));
3639 if (sflags & SVp_IOK) {
3640 (void)SvIOKp_on(dstr);
3641 if (sflags & SVf_IOK)
3642 SvFLAGS(dstr) |= SVf_IOK;
3643 if (sflags & SVf_IVisUV)
3645 SvIV_set(dstr, SvIVX(sstr));
3648 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3649 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3650 smg->mg_ptr, smg->mg_len);
3651 SvRMAGICAL_on(dstr);
3654 else if (sflags & SVp_IOK) {
3655 if (sflags & SVf_IOK)
3656 (void)SvIOK_only(dstr);
3658 (void)SvOK_off(dstr);
3659 (void)SvIOKp_on(dstr);
3661 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3662 if (sflags & SVf_IVisUV)
3664 SvIV_set(dstr, SvIVX(sstr));
3665 if (sflags & SVp_NOK) {
3666 if (sflags & SVf_NOK)
3667 (void)SvNOK_on(dstr);
3669 (void)SvNOKp_on(dstr);
3670 SvNV_set(dstr, SvNVX(sstr));
3673 else if (sflags & SVp_NOK) {
3674 if (sflags & SVf_NOK)
3675 (void)SvNOK_only(dstr);
3677 (void)SvOK_off(dstr);
3680 SvNV_set(dstr, SvNVX(sstr));
3683 if (dtype == SVt_PVGV) {
3684 if (ckWARN(WARN_MISC))
3685 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3688 (void)SvOK_off(dstr);
3690 if (SvTAINTED(sstr))
3695 =for apidoc sv_setsv_mg
3697 Like C<sv_setsv>, but also handles 'set' magic.
3703 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3705 sv_setsv(dstr,sstr);
3709 #ifdef PERL_OLD_COPY_ON_WRITE
3711 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3713 STRLEN cur = SvCUR(sstr);
3714 STRLEN len = SvLEN(sstr);
3715 register char *new_pv;
3718 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3726 if (SvTHINKFIRST(dstr))
3727 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3728 else if (SvPVX_const(dstr))
3729 Safefree(SvPVX_const(dstr));
3733 SvUPGRADE(dstr, SVt_PVIV);
3735 assert (SvPOK(sstr));
3736 assert (SvPOKp(sstr));
3737 assert (!SvIOK(sstr));
3738 assert (!SvIOKp(sstr));
3739 assert (!SvNOK(sstr));
3740 assert (!SvNOKp(sstr));
3742 if (SvIsCOW(sstr)) {
3744 if (SvLEN(sstr) == 0) {
3745 /* source is a COW shared hash key. */
3746 DEBUG_C(PerlIO_printf(Perl_debug_log,
3747 "Fast copy on write: Sharing hash\n"));
3748 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3751 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3753 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3754 SvUPGRADE(sstr, SVt_PVIV);
3755 SvREADONLY_on(sstr);
3757 DEBUG_C(PerlIO_printf(Perl_debug_log,
3758 "Fast copy on write: Converting sstr to COW\n"));
3759 SV_COW_NEXT_SV_SET(dstr, sstr);
3761 SV_COW_NEXT_SV_SET(sstr, dstr);
3762 new_pv = SvPVX_mutable(sstr);
3765 SvPV_set(dstr, new_pv);
3766 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3769 SvLEN_set(dstr, len);
3770 SvCUR_set(dstr, cur);
3779 =for apidoc sv_setpvn
3781 Copies a string into an SV. The C<len> parameter indicates the number of
3782 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3783 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3789 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3791 register char *dptr;
3793 SV_CHECK_THINKFIRST_COW_DROP(sv);
3799 /* len is STRLEN which is unsigned, need to copy to signed */
3802 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3804 SvUPGRADE(sv, SVt_PV);
3806 dptr = SvGROW(sv, len + 1);
3807 Move(ptr,dptr,len,char);
3810 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3815 =for apidoc sv_setpvn_mg
3817 Like C<sv_setpvn>, but also handles 'set' magic.
3823 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3825 sv_setpvn(sv,ptr,len);
3830 =for apidoc sv_setpv
3832 Copies a string into an SV. The string must be null-terminated. Does not
3833 handle 'set' magic. See C<sv_setpv_mg>.
3839 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3841 register STRLEN len;
3843 SV_CHECK_THINKFIRST_COW_DROP(sv);
3849 SvUPGRADE(sv, SVt_PV);
3851 SvGROW(sv, len + 1);
3852 Move(ptr,SvPVX(sv),len+1,char);
3854 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3859 =for apidoc sv_setpv_mg
3861 Like C<sv_setpv>, but also handles 'set' magic.
3867 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3874 =for apidoc sv_usepvn
3876 Tells an SV to use C<ptr> to find its string value. Normally the string is
3877 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3878 The C<ptr> should point to memory that was allocated by C<malloc>. The
3879 string length, C<len>, must be supplied. This function will realloc the
3880 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3881 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3882 See C<sv_usepvn_mg>.
3888 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3891 SV_CHECK_THINKFIRST_COW_DROP(sv);
3892 SvUPGRADE(sv, SVt_PV);
3897 if (SvPVX_const(sv))
3900 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3901 ptr = saferealloc (ptr, allocate);
3904 SvLEN_set(sv, allocate);
3906 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3911 =for apidoc sv_usepvn_mg
3913 Like C<sv_usepvn>, but also handles 'set' magic.
3919 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3921 sv_usepvn(sv,ptr,len);
3925 #ifdef PERL_OLD_COPY_ON_WRITE
3926 /* Need to do this *after* making the SV normal, as we need the buffer
3927 pointer to remain valid until after we've copied it. If we let go too early,
3928 another thread could invalidate it by unsharing last of the same hash key
3929 (which it can do by means other than releasing copy-on-write Svs)
3930 or by changing the other copy-on-write SVs in the loop. */
3932 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3934 if (len) { /* this SV was SvIsCOW_normal(sv) */
3935 /* we need to find the SV pointing to us. */
3936 SV * const current = SV_COW_NEXT_SV(after);
3938 if (current == sv) {
3939 /* The SV we point to points back to us (there were only two of us
3941 Hence other SV is no longer copy on write either. */
3943 SvREADONLY_off(after);
3945 /* We need to follow the pointers around the loop. */
3947 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3950 /* don't loop forever if the structure is bust, and we have
3951 a pointer into a closed loop. */
3952 assert (current != after);
3953 assert (SvPVX_const(current) == pvx);
3955 /* Make the SV before us point to the SV after us. */
3956 SV_COW_NEXT_SV_SET(current, after);
3959 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3964 Perl_sv_release_IVX(pTHX_ register SV *sv)
3967 sv_force_normal_flags(sv, 0);
3973 =for apidoc sv_force_normal_flags
3975 Undo various types of fakery on an SV: if the PV is a shared string, make
3976 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3977 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3978 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3979 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3980 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3981 set to some other value.) In addition, the C<flags> parameter gets passed to
3982 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3983 with flags set to 0.
3989 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3991 #ifdef PERL_OLD_COPY_ON_WRITE
3992 if (SvREADONLY(sv)) {
3993 /* At this point I believe I should acquire a global SV mutex. */
3995 const char * const pvx = SvPVX_const(sv);
3996 const STRLEN len = SvLEN(sv);
3997 const STRLEN cur = SvCUR(sv);
3998 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4000 PerlIO_printf(Perl_debug_log,
4001 "Copy on write: Force normal %ld\n",
4007 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4008 SvPV_set(sv, (char*)0);
4010 if (flags & SV_COW_DROP_PV) {
4011 /* OK, so we don't need to copy our buffer. */
4014 SvGROW(sv, cur + 1);
4015 Move(pvx,SvPVX(sv),cur,char);
4019 sv_release_COW(sv, pvx, len, next);
4024 else if (IN_PERL_RUNTIME)
4025 Perl_croak(aTHX_ PL_no_modify);
4026 /* At this point I believe that I can drop the global SV mutex. */
4029 if (SvREADONLY(sv)) {
4031 const char * const pvx = SvPVX_const(sv);
4032 const STRLEN len = SvCUR(sv);
4035 SvPV_set(sv, Nullch);
4037 SvGROW(sv, len + 1);
4038 Move(pvx,SvPVX(sv),len,char);
4040 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4042 else if (IN_PERL_RUNTIME)
4043 Perl_croak(aTHX_ PL_no_modify);
4047 sv_unref_flags(sv, flags);
4048 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4055 Efficient removal of characters from the beginning of the string buffer.
4056 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4057 the string buffer. The C<ptr> becomes the first character of the adjusted
4058 string. Uses the "OOK hack".
4059 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4060 refer to the same chunk of data.
4066 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4068 register STRLEN delta;
4069 if (!ptr || !SvPOKp(sv))
4071 delta = ptr - SvPVX_const(sv);
4072 SV_CHECK_THINKFIRST(sv);
4073 if (SvTYPE(sv) < SVt_PVIV)
4074 sv_upgrade(sv,SVt_PVIV);
4077 if (!SvLEN(sv)) { /* make copy of shared string */
4078 const char *pvx = SvPVX_const(sv);
4079 const STRLEN len = SvCUR(sv);
4080 SvGROW(sv, len + 1);
4081 Move(pvx,SvPVX(sv),len,char);
4085 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4086 and we do that anyway inside the SvNIOK_off
4088 SvFLAGS(sv) |= SVf_OOK;
4091 SvLEN_set(sv, SvLEN(sv) - delta);
4092 SvCUR_set(sv, SvCUR(sv) - delta);
4093 SvPV_set(sv, SvPVX(sv) + delta);
4094 SvIV_set(sv, SvIVX(sv) + delta);
4098 =for apidoc sv_catpvn
4100 Concatenates the string onto the end of the string which is in the SV. The
4101 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4102 status set, then the bytes appended should be valid UTF-8.
4103 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4105 =for apidoc sv_catpvn_flags
4107 Concatenates the string onto the end of the string which is in the SV. The
4108 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4109 status set, then the bytes appended should be valid UTF-8.
4110 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4111 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4112 in terms of this function.
4118 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4121 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4123 SvGROW(dsv, dlen + slen + 1);
4125 sstr = SvPVX_const(dsv);
4126 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4127 SvCUR_set(dsv, SvCUR(dsv) + slen);
4129 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4131 if (flags & SV_SMAGIC)
4136 =for apidoc sv_catsv
4138 Concatenates the string from SV C<ssv> onto the end of the string in
4139 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4140 not 'set' magic. See C<sv_catsv_mg>.
4142 =for apidoc sv_catsv_flags
4144 Concatenates the string from SV C<ssv> onto the end of the string in
4145 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4146 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4147 and C<sv_catsv_nomg> are implemented in terms of this function.
4152 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4157 if ((spv = SvPV_const(ssv, slen))) {
4158 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4159 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4160 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4161 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4162 dsv->sv_flags doesn't have that bit set.
4163 Andy Dougherty 12 Oct 2001
4165 const I32 sutf8 = DO_UTF8(ssv);
4168 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4170 dutf8 = DO_UTF8(dsv);
4172 if (dutf8 != sutf8) {
4174 /* Not modifying source SV, so taking a temporary copy. */
4175 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4177 sv_utf8_upgrade(csv);
4178 spv = SvPV_const(csv, slen);
4181 sv_utf8_upgrade_nomg(dsv);
4183 sv_catpvn_nomg(dsv, spv, slen);
4186 if (flags & SV_SMAGIC)
4191 =for apidoc sv_catpv
4193 Concatenates the string onto the end of the string which is in the SV.
4194 If the SV has the UTF-8 status set, then the bytes appended should be
4195 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4200 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4202 register STRLEN len;
4208 junk = SvPV_force(sv, tlen);
4210 SvGROW(sv, tlen + len + 1);
4212 ptr = SvPVX_const(sv);
4213 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4214 SvCUR_set(sv, SvCUR(sv) + len);
4215 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4220 =for apidoc sv_catpv_mg
4222 Like C<sv_catpv>, but also handles 'set' magic.
4228 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4237 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4238 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4245 Perl_newSV(pTHX_ STRLEN len)
4251 sv_upgrade(sv, SVt_PV);
4252 SvGROW(sv, len + 1);
4257 =for apidoc sv_magicext
4259 Adds magic to an SV, upgrading it if necessary. Applies the
4260 supplied vtable and returns a pointer to the magic added.
4262 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4263 In particular, you can add magic to SvREADONLY SVs, and add more than
4264 one instance of the same 'how'.
4266 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4267 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4268 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4269 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4271 (This is now used as a subroutine by C<sv_magic>.)
4276 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4277 const char* name, I32 namlen)
4281 if (SvTYPE(sv) < SVt_PVMG) {
4282 SvUPGRADE(sv, SVt_PVMG);
4284 Newxz(mg, 1, MAGIC);
4285 mg->mg_moremagic = SvMAGIC(sv);
4286 SvMAGIC_set(sv, mg);
4288 /* Sometimes a magic contains a reference loop, where the sv and
4289 object refer to each other. To prevent a reference loop that
4290 would prevent such objects being freed, we look for such loops
4291 and if we find one we avoid incrementing the object refcount.
4293 Note we cannot do this to avoid self-tie loops as intervening RV must
4294 have its REFCNT incremented to keep it in existence.
4297 if (!obj || obj == sv ||
4298 how == PERL_MAGIC_arylen ||
4299 how == PERL_MAGIC_qr ||
4300 how == PERL_MAGIC_symtab ||
4301 (SvTYPE(obj) == SVt_PVGV &&
4302 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4303 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4304 GvFORM(obj) == (CV*)sv)))
4309 mg->mg_obj = SvREFCNT_inc(obj);
4310 mg->mg_flags |= MGf_REFCOUNTED;
4313 /* Normal self-ties simply pass a null object, and instead of
4314 using mg_obj directly, use the SvTIED_obj macro to produce a
4315 new RV as needed. For glob "self-ties", we are tieing the PVIO
4316 with an RV obj pointing to the glob containing the PVIO. In
4317 this case, to avoid a reference loop, we need to weaken the
4321 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4322 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4328 mg->mg_len = namlen;
4331 mg->mg_ptr = savepvn(name, namlen);
4332 else if (namlen == HEf_SVKEY)
4333 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4335 mg->mg_ptr = (char *) name;
4337 mg->mg_virtual = vtable;
4341 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4346 =for apidoc sv_magic
4348 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4349 then adds a new magic item of type C<how> to the head of the magic list.
4351 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4352 handling of the C<name> and C<namlen> arguments.
4354 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4355 to add more than one instance of the same 'how'.
4361 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4363 const MGVTBL *vtable;
4366 #ifdef PERL_OLD_COPY_ON_WRITE
4368 sv_force_normal_flags(sv, 0);
4370 if (SvREADONLY(sv)) {
4372 /* its okay to attach magic to shared strings; the subsequent
4373 * upgrade to PVMG will unshare the string */
4374 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4377 && how != PERL_MAGIC_regex_global
4378 && how != PERL_MAGIC_bm
4379 && how != PERL_MAGIC_fm
4380 && how != PERL_MAGIC_sv
4381 && how != PERL_MAGIC_backref
4384 Perl_croak(aTHX_ PL_no_modify);
4387 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4388 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4389 /* sv_magic() refuses to add a magic of the same 'how' as an
4392 if (how == PERL_MAGIC_taint)
4400 vtable = &PL_vtbl_sv;
4402 case PERL_MAGIC_overload:
4403 vtable = &PL_vtbl_amagic;
4405 case PERL_MAGIC_overload_elem:
4406 vtable = &PL_vtbl_amagicelem;
4408 case PERL_MAGIC_overload_table:
4409 vtable = &PL_vtbl_ovrld;
4412 vtable = &PL_vtbl_bm;
4414 case PERL_MAGIC_regdata:
4415 vtable = &PL_vtbl_regdata;
4417 case PERL_MAGIC_regdatum:
4418 vtable = &PL_vtbl_regdatum;
4420 case PERL_MAGIC_env:
4421 vtable = &PL_vtbl_env;
4424 vtable = &PL_vtbl_fm;
4426 case PERL_MAGIC_envelem:
4427 vtable = &PL_vtbl_envelem;
4429 case PERL_MAGIC_regex_global:
4430 vtable = &PL_vtbl_mglob;
4432 case PERL_MAGIC_isa:
4433 vtable = &PL_vtbl_isa;
4435 case PERL_MAGIC_isaelem:
4436 vtable = &PL_vtbl_isaelem;
4438 case PERL_MAGIC_nkeys:
4439 vtable = &PL_vtbl_nkeys;
4441 case PERL_MAGIC_dbfile:
4444 case PERL_MAGIC_dbline:
4445 vtable = &PL_vtbl_dbline;
4447 #ifdef USE_LOCALE_COLLATE
4448 case PERL_MAGIC_collxfrm:
4449 vtable = &PL_vtbl_collxfrm;
4451 #endif /* USE_LOCALE_COLLATE */
4452 case PERL_MAGIC_tied:
4453 vtable = &PL_vtbl_pack;
4455 case PERL_MAGIC_tiedelem:
4456 case PERL_MAGIC_tiedscalar:
4457 vtable = &PL_vtbl_packelem;
4460 vtable = &PL_vtbl_regexp;
4462 case PERL_MAGIC_sig:
4463 vtable = &PL_vtbl_sig;
4465 case PERL_MAGIC_sigelem:
4466 vtable = &PL_vtbl_sigelem;
4468 case PERL_MAGIC_taint:
4469 vtable = &PL_vtbl_taint;
4471 case PERL_MAGIC_uvar:
4472 vtable = &PL_vtbl_uvar;
4474 case PERL_MAGIC_vec:
4475 vtable = &PL_vtbl_vec;
4477 case PERL_MAGIC_arylen_p:
4478 case PERL_MAGIC_rhash:
4479 case PERL_MAGIC_symtab:
4480 case PERL_MAGIC_vstring:
4483 case PERL_MAGIC_utf8:
4484 vtable = &PL_vtbl_utf8;
4486 case PERL_MAGIC_substr:
4487 vtable = &PL_vtbl_substr;
4489 case PERL_MAGIC_defelem:
4490 vtable = &PL_vtbl_defelem;
4492 case PERL_MAGIC_glob:
4493 vtable = &PL_vtbl_glob;
4495 case PERL_MAGIC_arylen:
4496 vtable = &PL_vtbl_arylen;
4498 case PERL_MAGIC_pos:
4499 vtable = &PL_vtbl_pos;
4501 case PERL_MAGIC_backref:
4502 vtable = &PL_vtbl_backref;
4504 case PERL_MAGIC_ext:
4505 /* Reserved for use by extensions not perl internals. */
4506 /* Useful for attaching extension internal data to perl vars. */
4507 /* Note that multiple extensions may clash if magical scalars */
4508 /* etc holding private data from one are passed to another. */
4512 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4515 /* Rest of work is done else where */
4516 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4519 case PERL_MAGIC_taint:
4522 case PERL_MAGIC_ext:
4523 case PERL_MAGIC_dbfile:
4530 =for apidoc sv_unmagic
4532 Removes all magic of type C<type> from an SV.
4538 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4542 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4545 for (mg = *mgp; mg; mg = *mgp) {
4546 if (mg->mg_type == type) {
4547 const MGVTBL* const vtbl = mg->mg_virtual;
4548 *mgp = mg->mg_moremagic;
4549 if (vtbl && vtbl->svt_free)
4550 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4551 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4553 Safefree(mg->mg_ptr);
4554 else if (mg->mg_len == HEf_SVKEY)
4555 SvREFCNT_dec((SV*)mg->mg_ptr);
4556 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4557 Safefree(mg->mg_ptr);
4559 if (mg->mg_flags & MGf_REFCOUNTED)
4560 SvREFCNT_dec(mg->mg_obj);
4564 mgp = &mg->mg_moremagic;
4568 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4575 =for apidoc sv_rvweaken
4577 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4578 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4579 push a back-reference to this RV onto the array of backreferences
4580 associated with that magic.
4586 Perl_sv_rvweaken(pTHX_ SV *sv)
4589 if (!SvOK(sv)) /* let undefs pass */
4592 Perl_croak(aTHX_ "Can't weaken a nonreference");
4593 else if (SvWEAKREF(sv)) {
4594 if (ckWARN(WARN_MISC))
4595 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4599 Perl_sv_add_backref(aTHX_ tsv, sv);
4605 /* Give tsv backref magic if it hasn't already got it, then push a
4606 * back-reference to sv onto the array associated with the backref magic.
4610 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4614 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4615 av = (AV*)mg->mg_obj;
4618 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4619 /* av now has a refcnt of 2, which avoids it getting freed
4620 * before us during global cleanup. The extra ref is removed
4621 * by magic_killbackrefs() when tsv is being freed */
4623 if (AvFILLp(av) >= AvMAX(av)) {
4624 av_extend(av, AvFILLp(av)+1);
4626 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4629 /* delete a back-reference to ourselves from the backref magic associated
4630 * with the SV we point to.
4634 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4640 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4641 if (PL_in_clean_all)
4644 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4645 Perl_croak(aTHX_ "panic: del_backref");
4646 av = (AV *)mg->mg_obj;
4648 /* We shouldn't be in here more than once, but for paranoia reasons lets
4650 for (i = AvFILLp(av); i >= 0; i--) {
4652 const SSize_t fill = AvFILLp(av);
4654 /* We weren't the last entry.
4655 An unordered list has this property that you can take the
4656 last element off the end to fill the hole, and it's still
4657 an unordered list :-)
4662 AvFILLp(av) = fill - 1;
4668 =for apidoc sv_insert
4670 Inserts a string at the specified offset/length within the SV. Similar to
4671 the Perl substr() function.
4677 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4681 register char *midend;
4682 register char *bigend;
4688 Perl_croak(aTHX_ "Can't modify non-existent substring");
4689 SvPV_force(bigstr, curlen);
4690 (void)SvPOK_only_UTF8(bigstr);
4691 if (offset + len > curlen) {
4692 SvGROW(bigstr, offset+len+1);
4693 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4694 SvCUR_set(bigstr, offset+len);
4698 i = littlelen - len;
4699 if (i > 0) { /* string might grow */
4700 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4701 mid = big + offset + len;
4702 midend = bigend = big + SvCUR(bigstr);
4705 while (midend > mid) /* shove everything down */
4706 *--bigend = *--midend;
4707 Move(little,big+offset,littlelen,char);
4708 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4713 Move(little,SvPVX(bigstr)+offset,len,char);
4718 big = SvPVX(bigstr);
4721 bigend = big + SvCUR(bigstr);
4723 if (midend > bigend)
4724 Perl_croak(aTHX_ "panic: sv_insert");
4726 if (mid - big > bigend - midend) { /* faster to shorten from end */
4728 Move(little, mid, littlelen,char);
4731 i = bigend - midend;
4733 Move(midend, mid, i,char);
4737 SvCUR_set(bigstr, mid - big);
4739 else if ((i = mid - big)) { /* faster from front */
4740 midend -= littlelen;
4742 sv_chop(bigstr,midend-i);
4747 Move(little, mid, littlelen,char);
4749 else if (littlelen) {
4750 midend -= littlelen;
4751 sv_chop(bigstr,midend);
4752 Move(little,midend,littlelen,char);
4755 sv_chop(bigstr,midend);
4761 =for apidoc sv_replace
4763 Make the first argument a copy of the second, then delete the original.
4764 The target SV physically takes over ownership of the body of the source SV
4765 and inherits its flags; however, the target keeps any magic it owns,
4766 and any magic in the source is discarded.
4767 Note that this is a rather specialist SV copying operation; most of the
4768 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4774 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4776 const U32 refcnt = SvREFCNT(sv);
4777 SV_CHECK_THINKFIRST_COW_DROP(sv);
4778 if (SvREFCNT(nsv) != 1) {
4779 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4780 UVuf " != 1)", (UV) SvREFCNT(nsv));
4782 if (SvMAGICAL(sv)) {
4786 sv_upgrade(nsv, SVt_PVMG);
4787 SvMAGIC_set(nsv, SvMAGIC(sv));
4788 SvFLAGS(nsv) |= SvMAGICAL(sv);
4790 SvMAGIC_set(sv, NULL);
4794 assert(!SvREFCNT(sv));
4795 #ifdef DEBUG_LEAKING_SCALARS
4796 sv->sv_flags = nsv->sv_flags;
4797 sv->sv_any = nsv->sv_any;
4798 sv->sv_refcnt = nsv->sv_refcnt;
4799 sv->sv_u = nsv->sv_u;
4801 StructCopy(nsv,sv,SV);
4803 /* Currently could join these into one piece of pointer arithmetic, but
4804 it would be unclear. */
4805 if(SvTYPE(sv) == SVt_IV)
4807 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4808 else if (SvTYPE(sv) == SVt_RV) {
4809 SvANY(sv) = &sv->sv_u.svu_rv;
4813 #ifdef PERL_OLD_COPY_ON_WRITE
4814 if (SvIsCOW_normal(nsv)) {
4815 /* We need to follow the pointers around the loop to make the
4816 previous SV point to sv, rather than nsv. */
4819 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4822 assert(SvPVX_const(current) == SvPVX_const(nsv));
4824 /* Make the SV before us point to the SV after us. */
4826 PerlIO_printf(Perl_debug_log, "previous is\n");
4828 PerlIO_printf(Perl_debug_log,
4829 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4830 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4832 SV_COW_NEXT_SV_SET(current, sv);
4835 SvREFCNT(sv) = refcnt;
4836 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4842 =for apidoc sv_clear
4844 Clear an SV: call any destructors, free up any memory used by the body,
4845 and free the body itself. The SV's head is I<not> freed, although
4846 its type is set to all 1's so that it won't inadvertently be assumed
4847 to be live during global destruction etc.
4848 This function should only be called when REFCNT is zero. Most of the time
4849 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4856 Perl_sv_clear(pTHX_ register SV *sv)
4859 const U32 type = SvTYPE(sv);
4860 const struct body_details *const sv_type_details
4861 = bodies_by_type + type;
4864 assert(SvREFCNT(sv) == 0);
4870 if (PL_defstash) { /* Still have a symbol table? */
4875 stash = SvSTASH(sv);
4876 destructor = StashHANDLER(stash,DESTROY);
4878 SV* const tmpref = newRV(sv);
4879 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4881 PUSHSTACKi(PERLSI_DESTROY);
4886 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4892 if(SvREFCNT(tmpref) < 2) {
4893 /* tmpref is not kept alive! */
4895 SvRV_set(tmpref, NULL);
4898 SvREFCNT_dec(tmpref);
4900 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4904 if (PL_in_clean_objs)
4905 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4907 /* DESTROY gave object new lease on life */
4913 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4914 SvOBJECT_off(sv); /* Curse the object. */
4915 if (type != SVt_PVIO)
4916 --PL_sv_objcount; /* XXX Might want something more general */
4919 if (type >= SVt_PVMG) {
4922 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4923 SvREFCNT_dec(SvSTASH(sv));
4928 IoIFP(sv) != PerlIO_stdin() &&
4929 IoIFP(sv) != PerlIO_stdout() &&
4930 IoIFP(sv) != PerlIO_stderr())
4932 io_close((IO*)sv, FALSE);
4934 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4935 PerlDir_close(IoDIRP(sv));
4936 IoDIRP(sv) = (DIR*)NULL;
4937 Safefree(IoTOP_NAME(sv));
4938 Safefree(IoFMT_NAME(sv));
4939 Safefree(IoBOTTOM_NAME(sv));
4954 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4955 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4956 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4957 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4959 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4960 SvREFCNT_dec(LvTARG(sv));
4964 Safefree(GvNAME(sv));
4965 /* If we're in a stash, we don't own a reference to it. However it does
4966 have a back reference to us, which needs to be cleared. */
4968 sv_del_backref((SV*)GvSTASH(sv), sv);
4973 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4975 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4976 /* Don't even bother with turning off the OOK flag. */
4981 SV *target = SvRV(sv);
4983 sv_del_backref(target, sv);
4985 SvREFCNT_dec(target);
4987 #ifdef PERL_OLD_COPY_ON_WRITE
4988 else if (SvPVX_const(sv)) {
4990 /* I believe I need to grab the global SV mutex here and
4991 then recheck the COW status. */
4993 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4996 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4997 SV_COW_NEXT_SV(sv));
4998 /* And drop it here. */
5000 } else if (SvLEN(sv)) {
5001 Safefree(SvPVX_const(sv));
5005 else if (SvPVX_const(sv) && SvLEN(sv))
5006 Safefree(SvPVX_mutable(sv));
5007 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5008 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5017 SvFLAGS(sv) &= SVf_BREAK;
5018 SvFLAGS(sv) |= SVTYPEMASK;
5020 if (sv_type_details->arena) {
5021 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5022 &PL_body_roots[type]);
5024 else if (sv_type_details->size) {
5025 my_safefree(SvANY(sv));
5030 =for apidoc sv_newref
5032 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5039 Perl_sv_newref(pTHX_ SV *sv)
5049 Decrement an SV's reference count, and if it drops to zero, call
5050 C<sv_clear> to invoke destructors and free up any memory used by
5051 the body; finally, deallocate the SV's head itself.
5052 Normally called via a wrapper macro C<SvREFCNT_dec>.
5058 Perl_sv_free(pTHX_ SV *sv)
5063 if (SvREFCNT(sv) == 0) {
5064 if (SvFLAGS(sv) & SVf_BREAK)
5065 /* this SV's refcnt has been artificially decremented to
5066 * trigger cleanup */
5068 if (PL_in_clean_all) /* All is fair */
5070 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5071 /* make sure SvREFCNT(sv)==0 happens very seldom */
5072 SvREFCNT(sv) = (~(U32)0)/2;
5075 if (ckWARN_d(WARN_INTERNAL)) {
5076 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5077 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5078 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5079 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5080 Perl_dump_sv_child(aTHX_ sv);
5085 if (--(SvREFCNT(sv)) > 0)
5087 Perl_sv_free2(aTHX_ sv);
5091 Perl_sv_free2(pTHX_ SV *sv)
5096 if (ckWARN_d(WARN_DEBUGGING))
5097 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5098 "Attempt to free temp prematurely: SV 0x%"UVxf
5099 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5103 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5104 /* make sure SvREFCNT(sv)==0 happens very seldom */
5105 SvREFCNT(sv) = (~(U32)0)/2;
5116 Returns the length of the string in the SV. Handles magic and type
5117 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5123 Perl_sv_len(pTHX_ register SV *sv)
5131 len = mg_length(sv);
5133 (void)SvPV_const(sv, len);
5138 =for apidoc sv_len_utf8
5140 Returns the number of characters in the string in an SV, counting wide
5141 UTF-8 bytes as a single character. Handles magic and type coercion.
5147 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5148 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5149 * (Note that the mg_len is not the length of the mg_ptr field.)
5154 Perl_sv_len_utf8(pTHX_ register SV *sv)
5160 return mg_length(sv);
5164 const U8 *s = (U8*)SvPV_const(sv, len);
5165 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5167 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5169 #ifdef PERL_UTF8_CACHE_ASSERT
5170 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5174 ulen = Perl_utf8_length(aTHX_ s, s + len);
5175 if (!mg && !SvREADONLY(sv)) {
5176 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5177 mg = mg_find(sv, PERL_MAGIC_utf8);
5187 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5188 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5189 * between UTF-8 and byte offsets. There are two (substr offset and substr
5190 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5191 * and byte offset) cache positions.
5193 * The mg_len field is used by sv_len_utf8(), see its comments.
5194 * Note that the mg_len is not the length of the mg_ptr field.
5198 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5199 I32 offsetp, const U8 *s, const U8 *start)
5203 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5205 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5209 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5211 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5212 (*mgp)->mg_ptr = (char *) *cachep;
5216 (*cachep)[i] = offsetp;
5217 (*cachep)[i+1] = s - start;
5225 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5226 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5227 * between UTF-8 and byte offsets. See also the comments of
5228 * S_utf8_mg_pos_init().
5232 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)
5236 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5238 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5239 if (*mgp && (*mgp)->mg_ptr) {
5240 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5241 ASSERT_UTF8_CACHE(*cachep);
5242 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5244 else { /* We will skip to the right spot. */
5249 /* The assumption is that going backward is half
5250 * the speed of going forward (that's where the
5251 * 2 * backw in the below comes from). (The real
5252 * figure of course depends on the UTF-8 data.) */
5254 if ((*cachep)[i] > (STRLEN)uoff) {
5256 backw = (*cachep)[i] - (STRLEN)uoff;
5258 if (forw < 2 * backw)
5261 p = start + (*cachep)[i+1];
5263 /* Try this only for the substr offset (i == 0),
5264 * not for the substr length (i == 2). */
5265 else if (i == 0) { /* (*cachep)[i] < uoff */
5266 const STRLEN ulen = sv_len_utf8(sv);
5268 if ((STRLEN)uoff < ulen) {
5269 forw = (STRLEN)uoff - (*cachep)[i];
5270 backw = ulen - (STRLEN)uoff;
5272 if (forw < 2 * backw)
5273 p = start + (*cachep)[i+1];
5278 /* If the string is not long enough for uoff,
5279 * we could extend it, but not at this low a level. */
5283 if (forw < 2 * backw) {
5290 while (UTF8_IS_CONTINUATION(*p))
5295 /* Update the cache. */
5296 (*cachep)[i] = (STRLEN)uoff;
5297 (*cachep)[i+1] = p - start;
5299 /* Drop the stale "length" cache */
5308 if (found) { /* Setup the return values. */
5309 *offsetp = (*cachep)[i+1];
5310 *sp = start + *offsetp;
5313 *offsetp = send - start;
5315 else if (*sp < start) {
5321 #ifdef PERL_UTF8_CACHE_ASSERT
5326 while (n-- && s < send)
5330 assert(*offsetp == s - start);
5331 assert((*cachep)[0] == (STRLEN)uoff);
5332 assert((*cachep)[1] == *offsetp);
5334 ASSERT_UTF8_CACHE(*cachep);
5343 =for apidoc sv_pos_u2b
5345 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5346 the start of the string, to a count of the equivalent number of bytes; if
5347 lenp is non-zero, it does the same to lenp, but this time starting from
5348 the offset, rather than from the start of the string. Handles magic and
5355 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5356 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5357 * byte offsets. See also the comments of S_utf8_mg_pos().
5362 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5370 start = (U8*)SvPV_const(sv, len);
5374 const U8 *s = start;
5375 I32 uoffset = *offsetp;
5376 const U8 * const send = s + len;
5380 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5382 if (!found && uoffset > 0) {
5383 while (s < send && uoffset--)
5387 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5389 *offsetp = s - start;
5394 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5398 if (!found && *lenp > 0) {
5401 while (s < send && ulen--)
5405 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5409 ASSERT_UTF8_CACHE(cache);
5421 =for apidoc sv_pos_b2u
5423 Converts the value pointed to by offsetp from a count of bytes from the
5424 start of the string, to a count of the equivalent number of UTF-8 chars.
5425 Handles magic and type coercion.
5431 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5432 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5433 * byte offsets. See also the comments of S_utf8_mg_pos().
5438 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5446 s = (const U8*)SvPV_const(sv, len);
5447 if ((I32)len < *offsetp)
5448 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5450 const U8* send = s + *offsetp;
5452 STRLEN *cache = NULL;
5456 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5457 mg = mg_find(sv, PERL_MAGIC_utf8);
5458 if (mg && mg->mg_ptr) {
5459 cache = (STRLEN *) mg->mg_ptr;
5460 if (cache[1] == (STRLEN)*offsetp) {
5461 /* An exact match. */
5462 *offsetp = cache[0];
5466 else if (cache[1] < (STRLEN)*offsetp) {
5467 /* We already know part of the way. */
5470 /* Let the below loop do the rest. */
5472 else { /* cache[1] > *offsetp */
5473 /* We already know all of the way, now we may
5474 * be able to walk back. The same assumption
5475 * is made as in S_utf8_mg_pos(), namely that
5476 * walking backward is twice slower than
5477 * walking forward. */
5478 const STRLEN forw = *offsetp;
5479 STRLEN backw = cache[1] - *offsetp;
5481 if (!(forw < 2 * backw)) {
5482 const U8 *p = s + cache[1];
5489 while (UTF8_IS_CONTINUATION(*p)) {
5497 *offsetp = cache[0];
5499 /* Drop the stale "length" cache */
5507 ASSERT_UTF8_CACHE(cache);
5513 /* Call utf8n_to_uvchr() to validate the sequence
5514 * (unless a simple non-UTF character) */
5515 if (!UTF8_IS_INVARIANT(*s))
5516 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5525 if (!SvREADONLY(sv)) {
5527 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5528 mg = mg_find(sv, PERL_MAGIC_utf8);
5533 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5534 mg->mg_ptr = (char *) cache;
5539 cache[1] = *offsetp;
5540 /* Drop the stale "length" cache */
5553 Returns a boolean indicating whether the strings in the two SVs are
5554 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5555 coerce its args to strings if necessary.
5561 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5569 SV* svrecode = Nullsv;
5576 pv1 = SvPV_const(sv1, cur1);
5583 pv2 = SvPV_const(sv2, cur2);
5585 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5586 /* Differing utf8ness.
5587 * Do not UTF8size the comparands as a side-effect. */
5590 svrecode = newSVpvn(pv2, cur2);
5591 sv_recode_to_utf8(svrecode, PL_encoding);
5592 pv2 = SvPV_const(svrecode, cur2);
5595 svrecode = newSVpvn(pv1, cur1);
5596 sv_recode_to_utf8(svrecode, PL_encoding);
5597 pv1 = SvPV_const(svrecode, cur1);
5599 /* Now both are in UTF-8. */
5601 SvREFCNT_dec(svrecode);
5606 bool is_utf8 = TRUE;
5609 /* sv1 is the UTF-8 one,
5610 * if is equal it must be downgrade-able */
5611 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5617 /* sv2 is the UTF-8 one,
5618 * if is equal it must be downgrade-able */
5619 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5625 /* Downgrade not possible - cannot be eq */
5633 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5636 SvREFCNT_dec(svrecode);
5647 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5648 string in C<sv1> is less than, equal to, or greater than the string in
5649 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5650 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5656 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5659 const char *pv1, *pv2;
5662 SV *svrecode = Nullsv;
5669 pv1 = SvPV_const(sv1, cur1);
5676 pv2 = SvPV_const(sv2, cur2);
5678 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5679 /* Differing utf8ness.
5680 * Do not UTF8size the comparands as a side-effect. */
5683 svrecode = newSVpvn(pv2, cur2);
5684 sv_recode_to_utf8(svrecode, PL_encoding);
5685 pv2 = SvPV_const(svrecode, cur2);
5688 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5693 svrecode = newSVpvn(pv1, cur1);
5694 sv_recode_to_utf8(svrecode, PL_encoding);
5695 pv1 = SvPV_const(svrecode, cur1);
5698 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5704 cmp = cur2 ? -1 : 0;
5708 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5711 cmp = retval < 0 ? -1 : 1;
5712 } else if (cur1 == cur2) {
5715 cmp = cur1 < cur2 ? -1 : 1;
5720 SvREFCNT_dec(svrecode);
5729 =for apidoc sv_cmp_locale
5731 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5732 'use bytes' aware, handles get magic, and will coerce its args to strings
5733 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5739 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5741 #ifdef USE_LOCALE_COLLATE
5747 if (PL_collation_standard)
5751 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5753 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5755 if (!pv1 || !len1) {
5766 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5769 return retval < 0 ? -1 : 1;
5772 * When the result of collation is equality, that doesn't mean
5773 * that there are no differences -- some locales exclude some
5774 * characters from consideration. So to avoid false equalities,
5775 * we use the raw string as a tiebreaker.
5781 #endif /* USE_LOCALE_COLLATE */
5783 return sv_cmp(sv1, sv2);
5787 #ifdef USE_LOCALE_COLLATE
5790 =for apidoc sv_collxfrm
5792 Add Collate Transform magic to an SV if it doesn't already have it.
5794 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5795 scalar data of the variable, but transformed to such a format that a normal
5796 memory comparison can be used to compare the data according to the locale
5803 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5807 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5808 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5814 Safefree(mg->mg_ptr);
5815 s = SvPV_const(sv, len);
5816 if ((xf = mem_collxfrm(s, len, &xlen))) {
5817 if (SvREADONLY(sv)) {
5820 return xf + sizeof(PL_collation_ix);
5823 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5824 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5837 if (mg && mg->mg_ptr) {
5839 return mg->mg_ptr + sizeof(PL_collation_ix);
5847 #endif /* USE_LOCALE_COLLATE */
5852 Get a line from the filehandle and store it into the SV, optionally
5853 appending to the currently-stored string.
5859 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5863 register STDCHAR rslast;
5864 register STDCHAR *bp;
5870 if (SvTHINKFIRST(sv))
5871 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5872 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5874 However, perlbench says it's slower, because the existing swipe code
5875 is faster than copy on write.
5876 Swings and roundabouts. */
5877 SvUPGRADE(sv, SVt_PV);
5882 if (PerlIO_isutf8(fp)) {
5884 sv_utf8_upgrade_nomg(sv);
5885 sv_pos_u2b(sv,&append,0);
5887 } else if (SvUTF8(sv)) {
5888 SV * const tsv = NEWSV(0,0);
5889 sv_gets(tsv, fp, 0);
5890 sv_utf8_upgrade_nomg(tsv);
5891 SvCUR_set(sv,append);
5894 goto return_string_or_null;
5899 if (PerlIO_isutf8(fp))
5902 if (IN_PERL_COMPILETIME) {
5903 /* we always read code in line mode */
5907 else if (RsSNARF(PL_rs)) {
5908 /* If it is a regular disk file use size from stat() as estimate
5909 of amount we are going to read - may result in malloc-ing
5910 more memory than we realy need if layers bellow reduce
5911 size we read (e.g. CRLF or a gzip layer)
5914 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5915 const Off_t offset = PerlIO_tell(fp);
5916 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5917 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5923 else if (RsRECORD(PL_rs)) {
5927 /* Grab the size of the record we're getting */
5928 recsize = SvIV(SvRV(PL_rs));
5929 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5932 /* VMS wants read instead of fread, because fread doesn't respect */
5933 /* RMS record boundaries. This is not necessarily a good thing to be */
5934 /* doing, but we've got no other real choice - except avoid stdio
5935 as implementation - perhaps write a :vms layer ?
5937 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5939 bytesread = PerlIO_read(fp, buffer, recsize);
5943 SvCUR_set(sv, bytesread += append);
5944 buffer[bytesread] = '\0';
5945 goto return_string_or_null;
5947 else if (RsPARA(PL_rs)) {
5953 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5954 if (PerlIO_isutf8(fp)) {
5955 rsptr = SvPVutf8(PL_rs, rslen);
5958 if (SvUTF8(PL_rs)) {
5959 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5960 Perl_croak(aTHX_ "Wide character in $/");
5963 rsptr = SvPV_const(PL_rs, rslen);
5967 rslast = rslen ? rsptr[rslen - 1] : '\0';
5969 if (rspara) { /* have to do this both before and after */
5970 do { /* to make sure file boundaries work right */
5973 i = PerlIO_getc(fp);
5977 PerlIO_ungetc(fp,i);
5983 /* See if we know enough about I/O mechanism to cheat it ! */
5985 /* This used to be #ifdef test - it is made run-time test for ease
5986 of abstracting out stdio interface. One call should be cheap
5987 enough here - and may even be a macro allowing compile
5991 if (PerlIO_fast_gets(fp)) {
5994 * We're going to steal some values from the stdio struct
5995 * and put EVERYTHING in the innermost loop into registers.
5997 register STDCHAR *ptr;
6001 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6002 /* An ungetc()d char is handled separately from the regular
6003 * buffer, so we getc() it back out and stuff it in the buffer.
6005 i = PerlIO_getc(fp);
6006 if (i == EOF) return 0;
6007 *(--((*fp)->_ptr)) = (unsigned char) i;
6011 /* Here is some breathtakingly efficient cheating */
6013 cnt = PerlIO_get_cnt(fp); /* get count into register */
6014 /* make sure we have the room */
6015 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6016 /* Not room for all of it
6017 if we are looking for a separator and room for some
6019 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6020 /* just process what we have room for */
6021 shortbuffered = cnt - SvLEN(sv) + append + 1;
6022 cnt -= shortbuffered;
6026 /* remember that cnt can be negative */
6027 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6032 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6033 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6034 DEBUG_P(PerlIO_printf(Perl_debug_log,
6035 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6036 DEBUG_P(PerlIO_printf(Perl_debug_log,
6037 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6038 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6039 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6044 while (cnt > 0) { /* this | eat */
6046 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6047 goto thats_all_folks; /* screams | sed :-) */
6051 Copy(ptr, bp, cnt, char); /* this | eat */
6052 bp += cnt; /* screams | dust */
6053 ptr += cnt; /* louder | sed :-) */
6058 if (shortbuffered) { /* oh well, must extend */
6059 cnt = shortbuffered;
6061 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6063 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6064 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6068 DEBUG_P(PerlIO_printf(Perl_debug_log,
6069 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6070 PTR2UV(ptr),(long)cnt));
6071 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6073 DEBUG_P(PerlIO_printf(Perl_debug_log,
6074 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6075 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6076 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6078 /* This used to call 'filbuf' in stdio form, but as that behaves like
6079 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6080 another abstraction. */
6081 i = PerlIO_getc(fp); /* get more characters */
6083 DEBUG_P(PerlIO_printf(Perl_debug_log,
6084 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6085 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6086 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6088 cnt = PerlIO_get_cnt(fp);
6089 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6090 DEBUG_P(PerlIO_printf(Perl_debug_log,
6091 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6093 if (i == EOF) /* all done for ever? */
6094 goto thats_really_all_folks;
6096 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6098 SvGROW(sv, bpx + cnt + 2);
6099 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6101 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6103 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6104 goto thats_all_folks;
6108 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6109 memNE((char*)bp - rslen, rsptr, rslen))
6110 goto screamer; /* go back to the fray */
6111 thats_really_all_folks:
6113 cnt += shortbuffered;
6114 DEBUG_P(PerlIO_printf(Perl_debug_log,
6115 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6116 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6117 DEBUG_P(PerlIO_printf(Perl_debug_log,
6118 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6119 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6120 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6122 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6123 DEBUG_P(PerlIO_printf(Perl_debug_log,
6124 "Screamer: done, len=%ld, string=|%.*s|\n",
6125 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6129 /*The big, slow, and stupid way. */
6130 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6132 Newx(buf, 8192, STDCHAR);
6140 register const STDCHAR *bpe = buf + sizeof(buf);
6142 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6143 ; /* keep reading */
6147 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6148 /* Accomodate broken VAXC compiler, which applies U8 cast to
6149 * both args of ?: operator, causing EOF to change into 255
6152 i = (U8)buf[cnt - 1];
6158 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6160 sv_catpvn(sv, (char *) buf, cnt);
6162 sv_setpvn(sv, (char *) buf, cnt);
6164 if (i != EOF && /* joy */
6166 SvCUR(sv) < rslen ||
6167 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6171 * If we're reading from a TTY and we get a short read,
6172 * indicating that the user hit his EOF character, we need
6173 * to notice it now, because if we try to read from the TTY
6174 * again, the EOF condition will disappear.
6176 * The comparison of cnt to sizeof(buf) is an optimization
6177 * that prevents unnecessary calls to feof().
6181 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6185 #ifdef USE_HEAP_INSTEAD_OF_STACK
6190 if (rspara) { /* have to do this both before and after */
6191 while (i != EOF) { /* to make sure file boundaries work right */
6192 i = PerlIO_getc(fp);
6194 PerlIO_ungetc(fp,i);
6200 return_string_or_null:
6201 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6207 Auto-increment of the value in the SV, doing string to numeric conversion
6208 if necessary. Handles 'get' magic.
6214 Perl_sv_inc(pTHX_ register SV *sv)
6222 if (SvTHINKFIRST(sv)) {
6224 sv_force_normal_flags(sv, 0);
6225 if (SvREADONLY(sv)) {
6226 if (IN_PERL_RUNTIME)
6227 Perl_croak(aTHX_ PL_no_modify);
6231 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6233 i = PTR2IV(SvRV(sv));
6238 flags = SvFLAGS(sv);
6239 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6240 /* It's (privately or publicly) a float, but not tested as an
6241 integer, so test it to see. */
6243 flags = SvFLAGS(sv);
6245 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6246 /* It's publicly an integer, or privately an integer-not-float */
6247 #ifdef PERL_PRESERVE_IVUV
6251 if (SvUVX(sv) == UV_MAX)
6252 sv_setnv(sv, UV_MAX_P1);
6254 (void)SvIOK_only_UV(sv);
6255 SvUV_set(sv, SvUVX(sv) + 1);
6257 if (SvIVX(sv) == IV_MAX)
6258 sv_setuv(sv, (UV)IV_MAX + 1);
6260 (void)SvIOK_only(sv);
6261 SvIV_set(sv, SvIVX(sv) + 1);
6266 if (flags & SVp_NOK) {
6267 (void)SvNOK_only(sv);
6268 SvNV_set(sv, SvNVX(sv) + 1.0);
6272 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6273 if ((flags & SVTYPEMASK) < SVt_PVIV)
6274 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6275 (void)SvIOK_only(sv);
6280 while (isALPHA(*d)) d++;
6281 while (isDIGIT(*d)) d++;
6283 #ifdef PERL_PRESERVE_IVUV
6284 /* Got to punt this as an integer if needs be, but we don't issue
6285 warnings. Probably ought to make the sv_iv_please() that does
6286 the conversion if possible, and silently. */
6287 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6288 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6289 /* Need to try really hard to see if it's an integer.
6290 9.22337203685478e+18 is an integer.
6291 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6292 so $a="9.22337203685478e+18"; $a+0; $a++
6293 needs to be the same as $a="9.22337203685478e+18"; $a++
6300 /* sv_2iv *should* have made this an NV */
6301 if (flags & SVp_NOK) {
6302 (void)SvNOK_only(sv);
6303 SvNV_set(sv, SvNVX(sv) + 1.0);
6306 /* I don't think we can get here. Maybe I should assert this
6307 And if we do get here I suspect that sv_setnv will croak. NWC
6309 #if defined(USE_LONG_DOUBLE)
6310 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",
6311 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6313 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6314 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6317 #endif /* PERL_PRESERVE_IVUV */
6318 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6322 while (d >= SvPVX_const(sv)) {
6330 /* MKS: The original code here died if letters weren't consecutive.
6331 * at least it didn't have to worry about non-C locales. The
6332 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6333 * arranged in order (although not consecutively) and that only
6334 * [A-Za-z] are accepted by isALPHA in the C locale.
6336 if (*d != 'z' && *d != 'Z') {
6337 do { ++*d; } while (!isALPHA(*d));
6340 *(d--) -= 'z' - 'a';
6345 *(d--) -= 'z' - 'a' + 1;
6349 /* oh,oh, the number grew */
6350 SvGROW(sv, SvCUR(sv) + 2);
6351 SvCUR_set(sv, SvCUR(sv) + 1);
6352 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6363 Auto-decrement of the value in the SV, doing string to numeric conversion
6364 if necessary. Handles 'get' magic.
6370 Perl_sv_dec(pTHX_ register SV *sv)
6377 if (SvTHINKFIRST(sv)) {
6379 sv_force_normal_flags(sv, 0);
6380 if (SvREADONLY(sv)) {
6381 if (IN_PERL_RUNTIME)
6382 Perl_croak(aTHX_ PL_no_modify);
6386 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6388 i = PTR2IV(SvRV(sv));
6393 /* Unlike sv_inc we don't have to worry about string-never-numbers
6394 and keeping them magic. But we mustn't warn on punting */
6395 flags = SvFLAGS(sv);
6396 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6397 /* It's publicly an integer, or privately an integer-not-float */
6398 #ifdef PERL_PRESERVE_IVUV
6402 if (SvUVX(sv) == 0) {
6403 (void)SvIOK_only(sv);
6407 (void)SvIOK_only_UV(sv);
6408 SvUV_set(sv, SvUVX(sv) - 1);
6411 if (SvIVX(sv) == IV_MIN)
6412 sv_setnv(sv, (NV)IV_MIN - 1.0);
6414 (void)SvIOK_only(sv);
6415 SvIV_set(sv, SvIVX(sv) - 1);
6420 if (flags & SVp_NOK) {
6421 SvNV_set(sv, SvNVX(sv) - 1.0);
6422 (void)SvNOK_only(sv);
6425 if (!(flags & SVp_POK)) {
6426 if ((flags & SVTYPEMASK) < SVt_PVIV)
6427 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6429 (void)SvIOK_only(sv);
6432 #ifdef PERL_PRESERVE_IVUV
6434 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6435 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6436 /* Need to try really hard to see if it's an integer.
6437 9.22337203685478e+18 is an integer.
6438 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6439 so $a="9.22337203685478e+18"; $a+0; $a--
6440 needs to be the same as $a="9.22337203685478e+18"; $a--
6447 /* sv_2iv *should* have made this an NV */
6448 if (flags & SVp_NOK) {
6449 (void)SvNOK_only(sv);
6450 SvNV_set(sv, SvNVX(sv) - 1.0);
6453 /* I don't think we can get here. Maybe I should assert this
6454 And if we do get here I suspect that sv_setnv will croak. NWC
6456 #if defined(USE_LONG_DOUBLE)
6457 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",
6458 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6460 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6461 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6465 #endif /* PERL_PRESERVE_IVUV */
6466 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6470 =for apidoc sv_mortalcopy
6472 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6473 The new SV is marked as mortal. It will be destroyed "soon", either by an
6474 explicit call to FREETMPS, or by an implicit call at places such as
6475 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6480 /* Make a string that will exist for the duration of the expression
6481 * evaluation. Actually, it may have to last longer than that, but
6482 * hopefully we won't free it until it has been assigned to a
6483 * permanent location. */
6486 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6491 sv_setsv(sv,oldstr);
6493 PL_tmps_stack[++PL_tmps_ix] = sv;
6499 =for apidoc sv_newmortal
6501 Creates a new null SV which is mortal. The reference count of the SV is
6502 set to 1. It will be destroyed "soon", either by an explicit call to
6503 FREETMPS, or by an implicit call at places such as statement boundaries.
6504 See also C<sv_mortalcopy> and C<sv_2mortal>.
6510 Perl_sv_newmortal(pTHX)
6515 SvFLAGS(sv) = SVs_TEMP;
6517 PL_tmps_stack[++PL_tmps_ix] = sv;
6522 =for apidoc sv_2mortal
6524 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6525 by an explicit call to FREETMPS, or by an implicit call at places such as
6526 statement boundaries. SvTEMP() is turned on which means that the SV's
6527 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6528 and C<sv_mortalcopy>.
6534 Perl_sv_2mortal(pTHX_ register SV *sv)
6539 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6542 PL_tmps_stack[++PL_tmps_ix] = sv;
6550 Creates a new SV and copies a string into it. The reference count for the
6551 SV is set to 1. If C<len> is zero, Perl will compute the length using
6552 strlen(). For efficiency, consider using C<newSVpvn> instead.
6558 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6563 sv_setpvn(sv,s,len ? len : strlen(s));
6568 =for apidoc newSVpvn
6570 Creates a new SV and copies a string into it. The reference count for the
6571 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6572 string. You are responsible for ensuring that the source string is at least
6573 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6579 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6584 sv_setpvn(sv,s,len);
6590 =for apidoc newSVhek
6592 Creates a new SV from the hash key structure. It will generate scalars that
6593 point to the shared string table where possible. Returns a new (undefined)
6594 SV if the hek is NULL.
6600 Perl_newSVhek(pTHX_ const HEK *hek)
6609 if (HEK_LEN(hek) == HEf_SVKEY) {
6610 return newSVsv(*(SV**)HEK_KEY(hek));
6612 const int flags = HEK_FLAGS(hek);
6613 if (flags & HVhek_WASUTF8) {
6615 Andreas would like keys he put in as utf8 to come back as utf8
6617 STRLEN utf8_len = HEK_LEN(hek);
6618 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6619 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6622 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6624 } else if (flags & HVhek_REHASH) {
6625 /* We don't have a pointer to the hv, so we have to replicate the
6626 flag into every HEK. This hv is using custom a hasing
6627 algorithm. Hence we can't return a shared string scalar, as
6628 that would contain the (wrong) hash value, and might get passed
6629 into an hv routine with a regular hash */
6631 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6636 /* This will be overwhelminly the most common case. */
6637 return newSVpvn_share(HEK_KEY(hek),
6638 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6644 =for apidoc newSVpvn_share
6646 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6647 table. If the string does not already exist in the table, it is created
6648 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6649 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6650 otherwise the hash is computed. The idea here is that as the string table
6651 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6652 hash lookup will avoid string compare.
6658 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6661 bool is_utf8 = FALSE;
6663 STRLEN tmplen = -len;
6665 /* See the note in hv.c:hv_fetch() --jhi */
6666 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6670 PERL_HASH(hash, src, len);
6672 sv_upgrade(sv, SVt_PV);
6673 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6685 #if defined(PERL_IMPLICIT_CONTEXT)
6687 /* pTHX_ magic can't cope with varargs, so this is a no-context
6688 * version of the main function, (which may itself be aliased to us).
6689 * Don't access this version directly.
6693 Perl_newSVpvf_nocontext(const char* pat, ...)
6698 va_start(args, pat);
6699 sv = vnewSVpvf(pat, &args);
6706 =for apidoc newSVpvf
6708 Creates a new SV and initializes it with the string formatted like
6715 Perl_newSVpvf(pTHX_ const char* pat, ...)
6719 va_start(args, pat);
6720 sv = vnewSVpvf(pat, &args);
6725 /* backend for newSVpvf() and newSVpvf_nocontext() */
6728 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6732 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6739 Creates a new SV and copies a floating point value into it.
6740 The reference count for the SV is set to 1.
6746 Perl_newSVnv(pTHX_ NV n)
6758 Creates a new SV and copies an integer into it. The reference count for the
6765 Perl_newSViv(pTHX_ IV i)
6777 Creates a new SV and copies an unsigned integer into it.
6778 The reference count for the SV is set to 1.
6784 Perl_newSVuv(pTHX_ UV u)
6794 =for apidoc newRV_noinc
6796 Creates an RV wrapper for an SV. The reference count for the original
6797 SV is B<not> incremented.
6803 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6808 sv_upgrade(sv, SVt_RV);
6810 SvRV_set(sv, tmpRef);
6815 /* newRV_inc is the official function name to use now.
6816 * newRV_inc is in fact #defined to newRV in sv.h
6820 Perl_newRV(pTHX_ SV *tmpRef)
6822 return newRV_noinc(SvREFCNT_inc(tmpRef));
6828 Creates a new SV which is an exact duplicate of the original SV.
6835 Perl_newSVsv(pTHX_ register SV *old)
6841 if (SvTYPE(old) == SVTYPEMASK) {
6842 if (ckWARN_d(WARN_INTERNAL))
6843 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6847 /* SV_GMAGIC is the default for sv_setv()
6848 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6849 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6850 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6855 =for apidoc sv_reset
6857 Underlying implementation for the C<reset> Perl function.
6858 Note that the perl-level function is vaguely deprecated.
6864 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6867 char todo[PERL_UCHAR_MAX+1];
6872 if (!*s) { /* reset ?? searches */
6873 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6875 PMOP *pm = (PMOP *) mg->mg_obj;
6877 pm->op_pmdynflags &= ~PMdf_USED;
6884 /* reset variables */
6886 if (!HvARRAY(stash))
6889 Zero(todo, 256, char);
6892 I32 i = (unsigned char)*s;
6896 max = (unsigned char)*s++;
6897 for ( ; i <= max; i++) {
6900 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6902 for (entry = HvARRAY(stash)[i];
6904 entry = HeNEXT(entry))
6909 if (!todo[(U8)*HeKEY(entry)])
6911 gv = (GV*)HeVAL(entry);
6914 if (SvTHINKFIRST(sv)) {
6915 if (!SvREADONLY(sv) && SvROK(sv))
6917 /* XXX Is this continue a bug? Why should THINKFIRST
6918 exempt us from resetting arrays and hashes? */
6922 if (SvTYPE(sv) >= SVt_PV) {
6924 if (SvPVX_const(sv) != Nullch)
6932 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6934 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6937 # if defined(USE_ENVIRON_ARRAY)
6940 # endif /* USE_ENVIRON_ARRAY */
6951 Using various gambits, try to get an IO from an SV: the IO slot if its a
6952 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6953 named after the PV if we're a string.
6959 Perl_sv_2io(pTHX_ SV *sv)
6964 switch (SvTYPE(sv)) {
6972 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6976 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6978 return sv_2io(SvRV(sv));
6979 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6985 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6994 Using various gambits, try to get a CV from an SV; in addition, try if
6995 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7001 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7008 return *gvp = Nullgv, Nullcv;
7009 switch (SvTYPE(sv)) {
7027 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7028 tryAMAGICunDEREF(to_cv);
7031 if (SvTYPE(sv) == SVt_PVCV) {
7040 Perl_croak(aTHX_ "Not a subroutine reference");
7045 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7051 if (lref && !GvCVu(gv)) {
7054 tmpsv = NEWSV(704,0);
7055 gv_efullname3(tmpsv, gv, Nullch);
7056 /* XXX this is probably not what they think they're getting.
7057 * It has the same effect as "sub name;", i.e. just a forward
7059 newSUB(start_subparse(FALSE, 0),
7060 newSVOP(OP_CONST, 0, tmpsv),
7065 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7075 Returns true if the SV has a true value by Perl's rules.
7076 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7077 instead use an in-line version.
7083 Perl_sv_true(pTHX_ register SV *sv)
7088 register const XPV* const tXpv = (XPV*)SvANY(sv);
7090 (tXpv->xpv_cur > 1 ||
7091 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7098 return SvIVX(sv) != 0;
7101 return SvNVX(sv) != 0.0;
7103 return sv_2bool(sv);
7109 =for apidoc sv_pvn_force
7111 Get a sensible string out of the SV somehow.
7112 A private implementation of the C<SvPV_force> macro for compilers which
7113 can't cope with complex macro expressions. Always use the macro instead.
7115 =for apidoc sv_pvn_force_flags
7117 Get a sensible string out of the SV somehow.
7118 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7119 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7120 implemented in terms of this function.
7121 You normally want to use the various wrapper macros instead: see
7122 C<SvPV_force> and C<SvPV_force_nomg>
7128 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7131 if (SvTHINKFIRST(sv) && !SvROK(sv))
7132 sv_force_normal_flags(sv, 0);
7142 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7143 const char * const ref = sv_reftype(sv,0);
7145 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7146 ref, OP_NAME(PL_op));
7148 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7150 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7151 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7153 s = sv_2pv_flags(sv, &len, flags);
7157 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7160 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7161 SvGROW(sv, len + 1);
7162 Move(s,SvPVX(sv),len,char);
7167 SvPOK_on(sv); /* validate pointer */
7169 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7170 PTR2UV(sv),SvPVX_const(sv)));
7173 return SvPVX_mutable(sv);
7177 =for apidoc sv_pvbyten_force
7179 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7185 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7187 sv_pvn_force(sv,lp);
7188 sv_utf8_downgrade(sv,0);
7194 =for apidoc sv_pvutf8n_force
7196 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7202 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7204 sv_pvn_force(sv,lp);
7205 sv_utf8_upgrade(sv);
7211 =for apidoc sv_reftype
7213 Returns a string describing what the SV is a reference to.
7219 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7221 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7222 inside return suggests a const propagation bug in g++. */
7223 if (ob && SvOBJECT(sv)) {
7224 char * const name = HvNAME_get(SvSTASH(sv));
7225 return name ? name : (char *) "__ANON__";
7228 switch (SvTYPE(sv)) {
7245 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7246 /* tied lvalues should appear to be
7247 * scalars for backwards compatitbility */
7248 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7249 ? "SCALAR" : "LVALUE");
7250 case SVt_PVAV: return "ARRAY";
7251 case SVt_PVHV: return "HASH";
7252 case SVt_PVCV: return "CODE";
7253 case SVt_PVGV: return "GLOB";
7254 case SVt_PVFM: return "FORMAT";
7255 case SVt_PVIO: return "IO";
7256 default: return "UNKNOWN";
7262 =for apidoc sv_isobject
7264 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7265 object. If the SV is not an RV, or if the object is not blessed, then this
7272 Perl_sv_isobject(pTHX_ SV *sv)
7288 Returns a boolean indicating whether the SV is blessed into the specified
7289 class. This does not check for subtypes; use C<sv_derived_from> to verify
7290 an inheritance relationship.
7296 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7307 hvname = HvNAME_get(SvSTASH(sv));
7311 return strEQ(hvname, name);
7317 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7318 it will be upgraded to one. If C<classname> is non-null then the new SV will
7319 be blessed in the specified package. The new SV is returned and its
7320 reference count is 1.
7326 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7332 SV_CHECK_THINKFIRST_COW_DROP(rv);
7335 if (SvTYPE(rv) >= SVt_PVMG) {
7336 const U32 refcnt = SvREFCNT(rv);
7340 SvREFCNT(rv) = refcnt;
7343 if (SvTYPE(rv) < SVt_RV)
7344 sv_upgrade(rv, SVt_RV);
7345 else if (SvTYPE(rv) > SVt_RV) {
7356 HV* const stash = gv_stashpv(classname, TRUE);
7357 (void)sv_bless(rv, stash);
7363 =for apidoc sv_setref_pv
7365 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7366 argument will be upgraded to an RV. That RV will be modified to point to
7367 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7368 into the SV. The C<classname> argument indicates the package for the
7369 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7370 will have a reference count of 1, and the RV will be returned.
7372 Do not use with other Perl types such as HV, AV, SV, CV, because those
7373 objects will become corrupted by the pointer copy process.
7375 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7381 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7384 sv_setsv(rv, &PL_sv_undef);
7388 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7393 =for apidoc sv_setref_iv
7395 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7396 argument will be upgraded to an RV. That RV will be modified to point to
7397 the new SV. The C<classname> argument indicates the package for the
7398 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7399 will have a reference count of 1, and the RV will be returned.
7405 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7407 sv_setiv(newSVrv(rv,classname), iv);
7412 =for apidoc sv_setref_uv
7414 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7415 argument will be upgraded to an RV. That RV will be modified to point to
7416 the new SV. The C<classname> argument indicates the package for the
7417 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7418 will have a reference count of 1, and the RV will be returned.
7424 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7426 sv_setuv(newSVrv(rv,classname), uv);
7431 =for apidoc sv_setref_nv
7433 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7434 argument will be upgraded to an RV. That RV will be modified to point to
7435 the new SV. The C<classname> argument indicates the package for the
7436 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7437 will have a reference count of 1, and the RV will be returned.
7443 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7445 sv_setnv(newSVrv(rv,classname), nv);
7450 =for apidoc sv_setref_pvn
7452 Copies a string into a new SV, optionally blessing the SV. The length of the
7453 string must be specified with C<n>. The C<rv> argument will be upgraded to
7454 an RV. That RV will be modified to point to the new SV. The C<classname>
7455 argument indicates the package for the blessing. Set C<classname> to
7456 C<Nullch> to avoid the blessing. The new SV will have a reference count
7457 of 1, and the RV will be returned.
7459 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7465 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7467 sv_setpvn(newSVrv(rv,classname), pv, n);
7472 =for apidoc sv_bless
7474 Blesses an SV into a specified package. The SV must be an RV. The package
7475 must be designated by its stash (see C<gv_stashpv()>). The reference count
7476 of the SV is unaffected.
7482 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7486 Perl_croak(aTHX_ "Can't bless non-reference value");
7488 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7489 if (SvREADONLY(tmpRef))
7490 Perl_croak(aTHX_ PL_no_modify);
7491 if (SvOBJECT(tmpRef)) {
7492 if (SvTYPE(tmpRef) != SVt_PVIO)
7494 SvREFCNT_dec(SvSTASH(tmpRef));
7497 SvOBJECT_on(tmpRef);
7498 if (SvTYPE(tmpRef) != SVt_PVIO)
7500 SvUPGRADE(tmpRef, SVt_PVMG);
7501 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7508 if(SvSMAGICAL(tmpRef))
7509 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7517 /* Downgrades a PVGV to a PVMG.
7521 S_sv_unglob(pTHX_ SV *sv)
7525 assert(SvTYPE(sv) == SVt_PVGV);
7530 sv_del_backref((SV*)GvSTASH(sv), sv);
7531 GvSTASH(sv) = Nullhv;
7533 sv_unmagic(sv, PERL_MAGIC_glob);
7534 Safefree(GvNAME(sv));
7537 /* need to keep SvANY(sv) in the right arena */
7538 xpvmg = new_XPVMG();
7539 StructCopy(SvANY(sv), xpvmg, XPVMG);
7540 del_XPVGV(SvANY(sv));
7543 SvFLAGS(sv) &= ~SVTYPEMASK;
7544 SvFLAGS(sv) |= SVt_PVMG;
7548 =for apidoc sv_unref_flags
7550 Unsets the RV status of the SV, and decrements the reference count of
7551 whatever was being referenced by the RV. This can almost be thought of
7552 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7553 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7554 (otherwise the decrementing is conditional on the reference count being
7555 different from one or the reference being a readonly SV).
7562 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7564 SV* const target = SvRV(ref);
7566 if (SvWEAKREF(ref)) {
7567 sv_del_backref(target, ref);
7569 SvRV_set(ref, NULL);
7572 SvRV_set(ref, NULL);
7574 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7575 assigned to as BEGIN {$a = \"Foo"} will fail. */
7576 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7577 SvREFCNT_dec(target);
7578 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7579 sv_2mortal(target); /* Schedule for freeing later */
7583 =for apidoc sv_untaint
7585 Untaint an SV. Use C<SvTAINTED_off> instead.
7590 Perl_sv_untaint(pTHX_ SV *sv)
7592 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7593 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7600 =for apidoc sv_tainted
7602 Test an SV for taintedness. Use C<SvTAINTED> instead.
7607 Perl_sv_tainted(pTHX_ SV *sv)
7609 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7610 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7611 if (mg && (mg->mg_len & 1) )
7618 =for apidoc sv_setpviv
7620 Copies an integer into the given SV, also updating its string value.
7621 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7627 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7629 char buf[TYPE_CHARS(UV)];
7631 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7633 sv_setpvn(sv, ptr, ebuf - ptr);
7637 =for apidoc sv_setpviv_mg
7639 Like C<sv_setpviv>, but also handles 'set' magic.
7645 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7651 #if defined(PERL_IMPLICIT_CONTEXT)
7653 /* pTHX_ magic can't cope with varargs, so this is a no-context
7654 * version of the main function, (which may itself be aliased to us).
7655 * Don't access this version directly.
7659 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7663 va_start(args, pat);
7664 sv_vsetpvf(sv, pat, &args);
7668 /* pTHX_ magic can't cope with varargs, so this is a no-context
7669 * version of the main function, (which may itself be aliased to us).
7670 * Don't access this version directly.
7674 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7678 va_start(args, pat);
7679 sv_vsetpvf_mg(sv, pat, &args);
7685 =for apidoc sv_setpvf
7687 Works like C<sv_catpvf> but copies the text into the SV instead of
7688 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7694 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7697 va_start(args, pat);
7698 sv_vsetpvf(sv, pat, &args);
7703 =for apidoc sv_vsetpvf
7705 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7706 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7708 Usually used via its frontend C<sv_setpvf>.
7714 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7716 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7720 =for apidoc sv_setpvf_mg
7722 Like C<sv_setpvf>, but also handles 'set' magic.
7728 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7731 va_start(args, pat);
7732 sv_vsetpvf_mg(sv, pat, &args);
7737 =for apidoc sv_vsetpvf_mg
7739 Like C<sv_vsetpvf>, but also handles 'set' magic.
7741 Usually used via its frontend C<sv_setpvf_mg>.
7747 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7749 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7753 #if defined(PERL_IMPLICIT_CONTEXT)
7755 /* pTHX_ magic can't cope with varargs, so this is a no-context
7756 * version of the main function, (which may itself be aliased to us).
7757 * Don't access this version directly.
7761 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7765 va_start(args, pat);
7766 sv_vcatpvf(sv, pat, &args);
7770 /* pTHX_ magic can't cope with varargs, so this is a no-context
7771 * version of the main function, (which may itself be aliased to us).
7772 * Don't access this version directly.
7776 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7780 va_start(args, pat);
7781 sv_vcatpvf_mg(sv, pat, &args);
7787 =for apidoc sv_catpvf
7789 Processes its arguments like C<sprintf> and appends the formatted
7790 output to an SV. If the appended data contains "wide" characters
7791 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7792 and characters >255 formatted with %c), the original SV might get
7793 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7794 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7795 valid UTF-8; if the original SV was bytes, the pattern should be too.
7800 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7803 va_start(args, pat);
7804 sv_vcatpvf(sv, pat, &args);
7809 =for apidoc sv_vcatpvf
7811 Processes its arguments like C<vsprintf> and appends the formatted output
7812 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7814 Usually used via its frontend C<sv_catpvf>.
7820 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7822 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7826 =for apidoc sv_catpvf_mg
7828 Like C<sv_catpvf>, but also handles 'set' magic.
7834 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7837 va_start(args, pat);
7838 sv_vcatpvf_mg(sv, pat, &args);
7843 =for apidoc sv_vcatpvf_mg
7845 Like C<sv_vcatpvf>, but also handles 'set' magic.
7847 Usually used via its frontend C<sv_catpvf_mg>.
7853 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7855 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7860 =for apidoc sv_vsetpvfn
7862 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7865 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7871 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7873 sv_setpvn(sv, "", 0);
7874 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7877 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7880 S_expect_number(pTHX_ char** pattern)
7883 switch (**pattern) {
7884 case '1': case '2': case '3':
7885 case '4': case '5': case '6':
7886 case '7': case '8': case '9':
7887 while (isDIGIT(**pattern))
7888 var = var * 10 + (*(*pattern)++ - '0');
7892 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7895 F0convert(NV nv, char *endbuf, STRLEN *len)
7897 const int neg = nv < 0;
7906 if (uv & 1 && uv == nv)
7907 uv--; /* Round to even */
7909 const unsigned dig = uv % 10;
7922 =for apidoc sv_vcatpvfn
7924 Processes its arguments like C<vsprintf> and appends the formatted output
7925 to an SV. Uses an array of SVs if the C style variable argument list is
7926 missing (NULL). When running with taint checks enabled, indicates via
7927 C<maybe_tainted> if results are untrustworthy (often due to the use of
7930 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7936 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7937 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7938 vec_utf8 = DO_UTF8(vecsv);
7940 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7943 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7950 static const char nullstr[] = "(null)";
7952 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7953 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7955 /* Times 4: a decimal digit takes more than 3 binary digits.
7956 * NV_DIG: mantissa takes than many decimal digits.
7957 * Plus 32: Playing safe. */
7958 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7959 /* large enough for "%#.#f" --chip */
7960 /* what about long double NVs? --jhi */
7962 PERL_UNUSED_ARG(maybe_tainted);
7964 /* no matter what, this is a string now */
7965 (void)SvPV_force(sv, origlen);
7967 /* special-case "", "%s", and "%-p" (SVf - see below) */
7970 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7972 const char * const s = va_arg(*args, char*);
7973 sv_catpv(sv, s ? s : nullstr);
7975 else if (svix < svmax) {
7976 sv_catsv(sv, *svargs);
7980 if (args && patlen == 3 && pat[0] == '%' &&
7981 pat[1] == '-' && pat[2] == 'p') {
7982 argsv = va_arg(*args, SV*);
7983 sv_catsv(sv, argsv);
7987 #ifndef USE_LONG_DOUBLE
7988 /* special-case "%.<number>[gf]" */
7989 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7990 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7991 unsigned digits = 0;
7995 while (*pp >= '0' && *pp <= '9')
7996 digits = 10 * digits + (*pp++ - '0');
7997 if (pp - pat == (int)patlen - 1) {
8005 /* Add check for digits != 0 because it seems that some
8006 gconverts are buggy in this case, and we don't yet have
8007 a Configure test for this. */
8008 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8009 /* 0, point, slack */
8010 Gconvert(nv, (int)digits, 0, ebuf);
8012 if (*ebuf) /* May return an empty string for digits==0 */
8015 } else if (!digits) {
8018 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8019 sv_catpvn(sv, p, l);
8025 #endif /* !USE_LONG_DOUBLE */
8027 if (!args && svix < svmax && DO_UTF8(*svargs))
8030 patend = (char*)pat + patlen;
8031 for (p = (char*)pat; p < patend; p = q) {
8034 bool vectorize = FALSE;
8035 bool vectorarg = FALSE;
8036 bool vec_utf8 = FALSE;
8042 bool has_precis = FALSE;
8045 bool is_utf8 = FALSE; /* is this item utf8? */
8046 #ifdef HAS_LDBL_SPRINTF_BUG
8047 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8048 with sfio - Allen <allens@cpan.org> */
8049 bool fix_ldbl_sprintf_bug = FALSE;
8053 U8 utf8buf[UTF8_MAXBYTES+1];
8054 STRLEN esignlen = 0;
8056 const char *eptr = Nullch;
8059 const U8 *vecstr = Null(U8*);
8066 /* we need a long double target in case HAS_LONG_DOUBLE but
8069 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8077 const char *dotstr = ".";
8078 STRLEN dotstrlen = 1;
8079 I32 efix = 0; /* explicit format parameter index */
8080 I32 ewix = 0; /* explicit width index */
8081 I32 epix = 0; /* explicit precision index */
8082 I32 evix = 0; /* explicit vector index */
8083 bool asterisk = FALSE;
8085 /* echo everything up to the next format specification */
8086 for (q = p; q < patend && *q != '%'; ++q) ;
8088 if (has_utf8 && !pat_utf8)
8089 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8091 sv_catpvn(sv, p, q - p);
8098 We allow format specification elements in this order:
8099 \d+\$ explicit format parameter index
8101 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8102 0 flag (as above): repeated to allow "v02"
8103 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8104 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8106 [%bcdefginopsuxDFOUX] format (mandatory)
8111 As of perl5.9.3, printf format checking is on by default.
8112 Internally, perl uses %p formats to provide an escape to
8113 some extended formatting. This block deals with those
8114 extensions: if it does not match, (char*)q is reset and
8115 the normal format processing code is used.
8117 Currently defined extensions are:
8118 %p include pointer address (standard)
8119 %-p (SVf) include an SV (previously %_)
8120 %-<num>p include an SV with precision <num>
8121 %1p (VDf) include a v-string (as %vd)
8122 %<num>p reserved for future extensions
8124 Robin Barker 2005-07-14
8131 EXPECT_NUMBER(q, n);
8138 argsv = va_arg(*args, SV*);
8139 eptr = SvPVx_const(argsv, elen);
8145 else if (n == vdNUMBER) { /* VDf */
8152 if (ckWARN_d(WARN_INTERNAL))
8153 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8154 "internal %%<num>p might conflict with future printf extensions");
8160 if (EXPECT_NUMBER(q, width)) {
8201 if (EXPECT_NUMBER(q, ewix))
8210 if ((vectorarg = asterisk)) {
8223 EXPECT_NUMBER(q, width);
8229 vecsv = va_arg(*args, SV*);
8231 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8232 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8233 dotstr = SvPV_const(vecsv, dotstrlen);
8240 else if (efix ? efix <= svmax : svix < svmax) {
8241 vecsv = svargs[efix ? efix-1 : svix++];
8242 vecstr = (U8*)SvPV_const(vecsv,veclen);
8243 vec_utf8 = DO_UTF8(vecsv);
8244 /* if this is a version object, we need to return the
8245 * stringified representation (which the SvPVX_const has
8246 * already done for us), but not vectorize the args
8248 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8250 q++; /* skip past the rest of the %vd format */
8251 eptr = (const char *) vecstr;
8265 i = va_arg(*args, int);
8267 i = (ewix ? ewix <= svmax : svix < svmax) ?
8268 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8270 width = (i < 0) ? -i : i;
8280 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8282 /* XXX: todo, support specified precision parameter */
8286 i = va_arg(*args, int);
8288 i = (ewix ? ewix <= svmax : svix < svmax)
8289 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8290 precis = (i < 0) ? 0 : i;
8295 precis = precis * 10 + (*q++ - '0');
8304 case 'I': /* Ix, I32x, and I64x */
8306 if (q[1] == '6' && q[2] == '4') {
8312 if (q[1] == '3' && q[2] == '2') {
8322 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8333 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8334 if (*(q + 1) == 'l') { /* lld, llf */
8360 const I32 i = efix-1;
8361 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8363 argsv = (svix >= 0 && svix < svmax)
8364 ? svargs[svix++] : &PL_sv_undef;
8373 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8375 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8377 eptr = (char*)utf8buf;
8378 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8389 if (args && !vectorize) {
8390 eptr = va_arg(*args, char*);
8392 #ifdef MACOS_TRADITIONAL
8393 /* On MacOS, %#s format is used for Pascal strings */
8398 elen = strlen(eptr);
8400 eptr = (char *)nullstr;
8401 elen = sizeof nullstr - 1;
8405 eptr = SvPVx_const(argsv, elen);
8406 if (DO_UTF8(argsv)) {
8407 if (has_precis && precis < elen) {
8409 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8412 if (width) { /* fudge width (can't fudge elen) */
8413 width += elen - sv_len_utf8(argsv);
8421 if (has_precis && elen > precis)
8428 if (alt || vectorize)
8430 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8451 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8460 esignbuf[esignlen++] = plus;
8464 case 'h': iv = (short)va_arg(*args, int); break;
8465 case 'l': iv = va_arg(*args, long); break;
8466 case 'V': iv = va_arg(*args, IV); break;
8467 default: iv = va_arg(*args, int); break;
8469 case 'q': iv = va_arg(*args, Quad_t); break;
8474 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8476 case 'h': iv = (short)tiv; break;
8477 case 'l': iv = (long)tiv; break;
8479 default: iv = tiv; break;
8481 case 'q': iv = (Quad_t)tiv; break;
8485 if ( !vectorize ) /* we already set uv above */
8490 esignbuf[esignlen++] = plus;
8494 esignbuf[esignlen++] = '-';
8537 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8548 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8549 case 'l': uv = va_arg(*args, unsigned long); break;
8550 case 'V': uv = va_arg(*args, UV); break;
8551 default: uv = va_arg(*args, unsigned); break;
8553 case 'q': uv = va_arg(*args, Uquad_t); break;
8558 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8560 case 'h': uv = (unsigned short)tuv; break;
8561 case 'l': uv = (unsigned long)tuv; break;
8563 default: uv = tuv; break;
8565 case 'q': uv = (Uquad_t)tuv; break;
8572 char *ptr = ebuf + sizeof ebuf;
8578 p = (char*)((c == 'X')
8579 ? "0123456789ABCDEF" : "0123456789abcdef");
8585 esignbuf[esignlen++] = '0';
8586 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8594 if (alt && *ptr != '0')
8605 esignbuf[esignlen++] = '0';
8606 esignbuf[esignlen++] = 'b';
8609 default: /* it had better be ten or less */
8613 } while (uv /= base);
8616 elen = (ebuf + sizeof ebuf) - ptr;
8620 zeros = precis - elen;
8621 else if (precis == 0 && elen == 1 && *eptr == '0')
8627 /* FLOATING POINT */
8630 c = 'f'; /* maybe %F isn't supported here */
8636 /* This is evil, but floating point is even more evil */
8638 /* for SV-style calling, we can only get NV
8639 for C-style calling, we assume %f is double;
8640 for simplicity we allow any of %Lf, %llf, %qf for long double
8644 #if defined(USE_LONG_DOUBLE)
8648 /* [perl #20339] - we should accept and ignore %lf rather than die */
8652 #if defined(USE_LONG_DOUBLE)
8653 intsize = args ? 0 : 'q';
8657 #if defined(HAS_LONG_DOUBLE)
8666 /* now we need (long double) if intsize == 'q', else (double) */
8667 nv = (args && !vectorize) ?
8668 #if LONG_DOUBLESIZE > DOUBLESIZE
8670 va_arg(*args, long double) :
8671 va_arg(*args, double)
8673 va_arg(*args, double)
8679 if (c != 'e' && c != 'E') {
8681 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8682 will cast our (long double) to (double) */
8683 (void)Perl_frexp(nv, &i);
8684 if (i == PERL_INT_MIN)
8685 Perl_die(aTHX_ "panic: frexp");
8687 need = BIT_DIGITS(i);
8689 need += has_precis ? precis : 6; /* known default */
8694 #ifdef HAS_LDBL_SPRINTF_BUG
8695 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8696 with sfio - Allen <allens@cpan.org> */
8699 # define MY_DBL_MAX DBL_MAX
8700 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8701 # if DOUBLESIZE >= 8
8702 # define MY_DBL_MAX 1.7976931348623157E+308L
8704 # define MY_DBL_MAX 3.40282347E+38L
8708 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8709 # define MY_DBL_MAX_BUG 1L
8711 # define MY_DBL_MAX_BUG MY_DBL_MAX
8715 # define MY_DBL_MIN DBL_MIN
8716 # else /* XXX guessing! -Allen */
8717 # if DOUBLESIZE >= 8
8718 # define MY_DBL_MIN 2.2250738585072014E-308L
8720 # define MY_DBL_MIN 1.17549435E-38L
8724 if ((intsize == 'q') && (c == 'f') &&
8725 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8727 /* it's going to be short enough that
8728 * long double precision is not needed */
8730 if ((nv <= 0L) && (nv >= -0L))
8731 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8733 /* would use Perl_fp_class as a double-check but not
8734 * functional on IRIX - see perl.h comments */
8736 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8737 /* It's within the range that a double can represent */
8738 #if defined(DBL_MAX) && !defined(DBL_MIN)
8739 if ((nv >= ((long double)1/DBL_MAX)) ||
8740 (nv <= (-(long double)1/DBL_MAX)))
8742 fix_ldbl_sprintf_bug = TRUE;
8745 if (fix_ldbl_sprintf_bug == TRUE) {
8755 # undef MY_DBL_MAX_BUG
8758 #endif /* HAS_LDBL_SPRINTF_BUG */
8760 need += 20; /* fudge factor */
8761 if (PL_efloatsize < need) {
8762 Safefree(PL_efloatbuf);
8763 PL_efloatsize = need + 20; /* more fudge */
8764 Newx(PL_efloatbuf, PL_efloatsize, char);
8765 PL_efloatbuf[0] = '\0';
8768 if ( !(width || left || plus || alt) && fill != '0'
8769 && has_precis && intsize != 'q' ) { /* Shortcuts */
8770 /* See earlier comment about buggy Gconvert when digits,
8772 if ( c == 'g' && precis) {
8773 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8774 /* May return an empty string for digits==0 */
8775 if (*PL_efloatbuf) {
8776 elen = strlen(PL_efloatbuf);
8777 goto float_converted;
8779 } else if ( c == 'f' && !precis) {
8780 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8785 char *ptr = ebuf + sizeof ebuf;
8788 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8789 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8790 if (intsize == 'q') {
8791 /* Copy the one or more characters in a long double
8792 * format before the 'base' ([efgEFG]) character to
8793 * the format string. */
8794 static char const prifldbl[] = PERL_PRIfldbl;
8795 char const *p = prifldbl + sizeof(prifldbl) - 3;
8796 while (p >= prifldbl) { *--ptr = *p--; }
8801 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8806 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8818 /* No taint. Otherwise we are in the strange situation
8819 * where printf() taints but print($float) doesn't.
8821 #if defined(HAS_LONG_DOUBLE)
8822 elen = ((intsize == 'q')
8823 ? my_sprintf(PL_efloatbuf, ptr, nv)
8824 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8826 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8830 eptr = PL_efloatbuf;
8836 i = SvCUR(sv) - origlen;
8837 if (args && !vectorize) {
8839 case 'h': *(va_arg(*args, short*)) = i; break;
8840 default: *(va_arg(*args, int*)) = i; break;
8841 case 'l': *(va_arg(*args, long*)) = i; break;
8842 case 'V': *(va_arg(*args, IV*)) = i; break;
8844 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8849 sv_setuv_mg(argsv, (UV)i);
8851 continue; /* not "break" */
8858 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8859 && ckWARN(WARN_PRINTF))
8861 SV * const msg = sv_newmortal();
8862 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8863 (PL_op->op_type == OP_PRTF) ? "" : "s");
8866 Perl_sv_catpvf(aTHX_ msg,
8867 "\"%%%c\"", c & 0xFF);
8869 Perl_sv_catpvf(aTHX_ msg,
8870 "\"%%\\%03"UVof"\"",
8873 sv_catpv(msg, "end of string");
8874 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8877 /* output mangled stuff ... */
8883 /* ... right here, because formatting flags should not apply */
8884 SvGROW(sv, SvCUR(sv) + elen + 1);
8886 Copy(eptr, p, elen, char);
8889 SvCUR_set(sv, p - SvPVX_const(sv));
8891 continue; /* not "break" */
8894 /* calculate width before utf8_upgrade changes it */
8895 have = esignlen + zeros + elen;
8897 Perl_croak_nocontext(PL_memory_wrap);
8899 if (is_utf8 != has_utf8) {
8902 sv_utf8_upgrade(sv);
8905 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8906 sv_utf8_upgrade(nsv);
8907 eptr = SvPVX_const(nsv);
8910 SvGROW(sv, SvCUR(sv) + elen + 1);
8915 need = (have > width ? have : width);
8918 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8919 Perl_croak_nocontext(PL_memory_wrap);
8920 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8922 if (esignlen && fill == '0') {
8924 for (i = 0; i < (int)esignlen; i++)
8928 memset(p, fill, gap);
8931 if (esignlen && fill != '0') {
8933 for (i = 0; i < (int)esignlen; i++)
8938 for (i = zeros; i; i--)
8942 Copy(eptr, p, elen, char);
8946 memset(p, ' ', gap);
8951 Copy(dotstr, p, dotstrlen, char);
8955 vectorize = FALSE; /* done iterating over vecstr */
8962 SvCUR_set(sv, p - SvPVX_const(sv));
8970 /* =========================================================================
8972 =head1 Cloning an interpreter
8974 All the macros and functions in this section are for the private use of
8975 the main function, perl_clone().
8977 The foo_dup() functions make an exact copy of an existing foo thinngy.
8978 During the course of a cloning, a hash table is used to map old addresses
8979 to new addresses. The table is created and manipulated with the
8980 ptr_table_* functions.
8984 ============================================================================*/
8987 #if defined(USE_ITHREADS)
8989 #ifndef GpREFCNT_inc
8990 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8994 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8995 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8996 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8997 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8998 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8999 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9000 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9001 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9002 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9003 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9004 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9005 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9006 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9009 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9010 regcomp.c. AMS 20010712 */
9013 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9018 struct reg_substr_datum *s;
9021 return (REGEXP *)NULL;
9023 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9026 len = r->offsets[0];
9027 npar = r->nparens+1;
9029 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9030 Copy(r->program, ret->program, len+1, regnode);
9032 Newx(ret->startp, npar, I32);
9033 Copy(r->startp, ret->startp, npar, I32);
9034 Newx(ret->endp, npar, I32);
9035 Copy(r->startp, ret->startp, npar, I32);
9037 Newx(ret->substrs, 1, struct reg_substr_data);
9038 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9039 s->min_offset = r->substrs->data[i].min_offset;
9040 s->max_offset = r->substrs->data[i].max_offset;
9041 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9042 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9045 ret->regstclass = NULL;
9048 const int count = r->data->count;
9051 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9052 char, struct reg_data);
9053 Newx(d->what, count, U8);
9056 for (i = 0; i < count; i++) {
9057 d->what[i] = r->data->what[i];
9058 switch (d->what[i]) {
9059 /* legal options are one of: sfpont
9060 see also regcomp.h and pregfree() */
9062 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9065 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9068 /* This is cheating. */
9069 Newx(d->data[i], 1, struct regnode_charclass_class);
9070 StructCopy(r->data->data[i], d->data[i],
9071 struct regnode_charclass_class);
9072 ret->regstclass = (regnode*)d->data[i];
9075 /* Compiled op trees are readonly, and can thus be
9076 shared without duplication. */
9078 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9082 d->data[i] = r->data->data[i];
9085 d->data[i] = r->data->data[i];
9087 ((reg_trie_data*)d->data[i])->refcount++;
9091 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9100 Newx(ret->offsets, 2*len+1, U32);
9101 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9103 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9104 ret->refcnt = r->refcnt;
9105 ret->minlen = r->minlen;
9106 ret->prelen = r->prelen;
9107 ret->nparens = r->nparens;
9108 ret->lastparen = r->lastparen;
9109 ret->lastcloseparen = r->lastcloseparen;
9110 ret->reganch = r->reganch;
9112 ret->sublen = r->sublen;
9114 if (RX_MATCH_COPIED(ret))
9115 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9117 ret->subbeg = Nullch;
9118 #ifdef PERL_OLD_COPY_ON_WRITE
9119 ret->saved_copy = Nullsv;
9122 ptr_table_store(PL_ptr_table, r, ret);
9126 /* duplicate a file handle */
9129 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9133 PERL_UNUSED_ARG(type);
9136 return (PerlIO*)NULL;
9138 /* look for it in the table first */
9139 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9143 /* create anew and remember what it is */
9144 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9145 ptr_table_store(PL_ptr_table, fp, ret);
9149 /* duplicate a directory handle */
9152 Perl_dirp_dup(pTHX_ DIR *dp)
9160 /* duplicate a typeglob */
9163 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9168 /* look for it in the table first */
9169 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9173 /* create anew and remember what it is */
9175 ptr_table_store(PL_ptr_table, gp, ret);
9178 ret->gp_refcnt = 0; /* must be before any other dups! */
9179 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9180 ret->gp_io = io_dup_inc(gp->gp_io, param);
9181 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9182 ret->gp_av = av_dup_inc(gp->gp_av, param);
9183 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9184 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9185 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9186 ret->gp_cvgen = gp->gp_cvgen;
9187 ret->gp_line = gp->gp_line;
9188 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9192 /* duplicate a chain of magic */
9195 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9197 MAGIC *mgprev = (MAGIC*)NULL;
9200 return (MAGIC*)NULL;
9201 /* look for it in the table first */
9202 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9206 for (; mg; mg = mg->mg_moremagic) {
9208 Newxz(nmg, 1, MAGIC);
9210 mgprev->mg_moremagic = nmg;
9213 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9214 nmg->mg_private = mg->mg_private;
9215 nmg->mg_type = mg->mg_type;
9216 nmg->mg_flags = mg->mg_flags;
9217 if (mg->mg_type == PERL_MAGIC_qr) {
9218 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9220 else if(mg->mg_type == PERL_MAGIC_backref) {
9221 const AV * const av = (AV*) mg->mg_obj;
9224 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9226 for (i = AvFILLp(av); i >= 0; i--) {
9227 if (!svp[i]) continue;
9228 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9231 else if (mg->mg_type == PERL_MAGIC_symtab) {
9232 nmg->mg_obj = mg->mg_obj;
9235 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9236 ? sv_dup_inc(mg->mg_obj, param)
9237 : sv_dup(mg->mg_obj, param);
9239 nmg->mg_len = mg->mg_len;
9240 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9241 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9242 if (mg->mg_len > 0) {
9243 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9244 if (mg->mg_type == PERL_MAGIC_overload_table &&
9245 AMT_AMAGIC((AMT*)mg->mg_ptr))
9247 AMT * const amtp = (AMT*)mg->mg_ptr;
9248 AMT * const namtp = (AMT*)nmg->mg_ptr;
9250 for (i = 1; i < NofAMmeth; i++) {
9251 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9255 else if (mg->mg_len == HEf_SVKEY)
9256 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9258 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9259 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9266 /* create a new pointer-mapping table */
9269 Perl_ptr_table_new(pTHX)
9272 Newxz(tbl, 1, PTR_TBL_t);
9275 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9280 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9282 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9286 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9287 following define) and at call to new_body_inline made below in
9288 Perl_ptr_table_store()
9291 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9293 /* map an existing pointer using a table */
9296 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9298 PTR_TBL_ENT_t *tblent;
9299 const UV hash = PTR_TABLE_HASH(sv);
9301 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9302 for (; tblent; tblent = tblent->next) {
9303 if (tblent->oldval == sv)
9304 return tblent->newval;
9309 /* add a new entry to a pointer-mapping table */
9312 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9314 PTR_TBL_ENT_t *tblent, **otblent;
9315 /* XXX this may be pessimal on platforms where pointers aren't good
9316 * hash values e.g. if they grow faster in the most significant
9318 const UV hash = PTR_TABLE_HASH(oldsv);
9322 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9323 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9324 if (tblent->oldval == oldsv) {
9325 tblent->newval = newsv;
9329 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9330 tblent->oldval = oldsv;
9331 tblent->newval = newsv;
9332 tblent->next = *otblent;
9335 if (!empty && tbl->tbl_items > tbl->tbl_max)
9336 ptr_table_split(tbl);
9339 /* double the hash bucket size of an existing ptr table */
9342 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9344 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9345 const UV oldsize = tbl->tbl_max + 1;
9346 UV newsize = oldsize * 2;
9349 Renew(ary, newsize, PTR_TBL_ENT_t*);
9350 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9351 tbl->tbl_max = --newsize;
9353 for (i=0; i < oldsize; i++, ary++) {
9354 PTR_TBL_ENT_t **curentp, **entp, *ent;
9357 curentp = ary + oldsize;
9358 for (entp = ary, ent = *ary; ent; ent = *entp) {
9359 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9361 ent->next = *curentp;
9371 /* remove all the entries from a ptr table */
9374 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9376 register PTR_TBL_ENT_t **array;
9377 register PTR_TBL_ENT_t *entry;
9381 if (!tbl || !tbl->tbl_items) {
9385 array = tbl->tbl_ary;
9391 PTR_TBL_ENT_t *oentry = entry;
9392 entry = entry->next;
9396 if (++riter > max) {
9399 entry = array[riter];
9406 /* clear and free a ptr table */
9409 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9414 ptr_table_clear(tbl);
9415 Safefree(tbl->tbl_ary);
9421 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9424 SvRV_set(dstr, SvWEAKREF(sstr)
9425 ? sv_dup(SvRV(sstr), param)
9426 : sv_dup_inc(SvRV(sstr), param));
9429 else if (SvPVX_const(sstr)) {
9430 /* Has something there */
9432 /* Normal PV - clone whole allocated space */
9433 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9434 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9435 /* Not that normal - actually sstr is copy on write.
9436 But we are a true, independant SV, so: */
9437 SvREADONLY_off(dstr);
9442 /* Special case - not normally malloced for some reason */
9443 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9444 /* A "shared" PV - clone it as "shared" PV */
9446 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9450 /* Some other special case - random pointer */
9451 SvPV_set(dstr, SvPVX(sstr));
9457 if (SvTYPE(dstr) == SVt_RV)
9458 SvRV_set(dstr, NULL);
9464 /* duplicate an SV of any type (including AV, HV etc) */
9467 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9472 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9474 /* look for it in the table first */
9475 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9479 if(param->flags & CLONEf_JOIN_IN) {
9480 /** We are joining here so we don't want do clone
9481 something that is bad **/
9484 if(SvTYPE(sstr) == SVt_PVHV &&
9485 (hvname = HvNAME_get(sstr))) {
9486 /** don't clone stashes if they already exist **/
9487 return (SV*)gv_stashpv(hvname,0);
9491 /* create anew and remember what it is */
9494 #ifdef DEBUG_LEAKING_SCALARS
9495 dstr->sv_debug_optype = sstr->sv_debug_optype;
9496 dstr->sv_debug_line = sstr->sv_debug_line;
9497 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9498 dstr->sv_debug_cloned = 1;
9500 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9502 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9506 ptr_table_store(PL_ptr_table, sstr, dstr);
9509 SvFLAGS(dstr) = SvFLAGS(sstr);
9510 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9511 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9514 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9515 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9516 PL_watch_pvx, SvPVX_const(sstr));
9519 /* don't clone objects whose class has asked us not to */
9520 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9521 SvFLAGS(dstr) &= ~SVTYPEMASK;
9526 switch (SvTYPE(sstr)) {
9531 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9532 SvIV_set(dstr, SvIVX(sstr));
9535 SvANY(dstr) = new_XNV();
9536 SvNV_set(dstr, SvNVX(sstr));
9539 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9540 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9544 /* These are all the types that need complex bodies allocating. */
9546 const svtype sv_type = SvTYPE(sstr);
9547 const struct body_details *const sv_type_details
9548 = bodies_by_type + sv_type;
9552 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9557 if (GvUNIQUE((GV*)sstr)) {
9558 /* Do sharing here, and fall through */
9571 assert(sv_type_details->copy);
9572 if (sv_type_details->arena) {
9573 new_body_inline(new_body, sv_type_details->copy, sv_type);
9575 = (void*)((char*)new_body - sv_type_details->offset);
9577 new_body = new_NOARENA(sv_type_details);
9581 SvANY(dstr) = new_body;
9584 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9585 ((char*)SvANY(dstr)) + sv_type_details->offset,
9586 sv_type_details->copy, char);
9588 Copy(((char*)SvANY(sstr)),
9589 ((char*)SvANY(dstr)),
9590 sv_type_details->size + sv_type_details->offset, char);
9593 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9594 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9596 /* The Copy above means that all the source (unduplicated) pointers
9597 are now in the destination. We can check the flags and the
9598 pointers in either, but it's possible that there's less cache
9599 missing by always going for the destination.
9600 FIXME - instrument and check that assumption */
9601 if (sv_type >= SVt_PVMG) {
9603 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9605 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9608 /* The cast silences a GCC warning about unhandled types. */
9609 switch ((int)sv_type) {
9621 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9622 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9623 LvTARG(dstr) = dstr;
9624 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9625 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9627 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9630 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9631 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9632 /* Don't call sv_add_backref here as it's going to be created
9633 as part of the magic cloning of the symbol table. */
9634 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9635 (void)GpREFCNT_inc(GvGP(dstr));
9638 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9639 if (IoOFP(dstr) == IoIFP(sstr))
9640 IoOFP(dstr) = IoIFP(dstr);
9642 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9643 /* PL_rsfp_filters entries have fake IoDIRP() */
9644 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9645 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9646 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9647 /* I have no idea why fake dirp (rsfps)
9648 should be treated differently but otherwise
9649 we end up with leaks -- sky*/
9650 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9651 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9652 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9654 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9655 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9656 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9658 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9659 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9660 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9663 if (AvARRAY((AV*)sstr)) {
9664 SV **dst_ary, **src_ary;
9665 SSize_t items = AvFILLp((AV*)sstr) + 1;
9667 src_ary = AvARRAY((AV*)sstr);
9668 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9669 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9670 SvPV_set(dstr, (char*)dst_ary);
9671 AvALLOC((AV*)dstr) = dst_ary;
9672 if (AvREAL((AV*)sstr)) {
9674 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9678 *dst_ary++ = sv_dup(*src_ary++, param);
9680 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9681 while (items-- > 0) {
9682 *dst_ary++ = &PL_sv_undef;
9686 SvPV_set(dstr, Nullch);
9687 AvALLOC((AV*)dstr) = (SV**)NULL;
9694 if (HvARRAY((HV*)sstr)) {
9696 const bool sharekeys = !!HvSHAREKEYS(sstr);
9697 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9698 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9700 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9701 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9703 HvARRAY(dstr) = (HE**)darray;
9704 while (i <= sxhv->xhv_max) {
9705 const HE *source = HvARRAY(sstr)[i];
9706 HvARRAY(dstr)[i] = source
9707 ? he_dup(source, sharekeys, param) : 0;
9711 struct xpvhv_aux *saux = HvAUX(sstr);
9712 struct xpvhv_aux *daux = HvAUX(dstr);
9713 /* This flag isn't copied. */
9714 /* SvOOK_on(hv) attacks the IV flags. */
9715 SvFLAGS(dstr) |= SVf_OOK;
9717 hvname = saux->xhv_name;
9719 = hvname ? hek_dup(hvname, param) : hvname;
9721 daux->xhv_riter = saux->xhv_riter;
9722 daux->xhv_eiter = saux->xhv_eiter
9723 ? he_dup(saux->xhv_eiter,
9724 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9728 SvPV_set(dstr, Nullch);
9730 /* Record stashes for possible cloning in Perl_clone(). */
9732 av_push(param->stashes, dstr);
9737 /* NOTE: not refcounted */
9738 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9740 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9742 if (CvCONST(dstr)) {
9743 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9744 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9745 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9747 /* don't dup if copying back - CvGV isn't refcounted, so the
9748 * duped GV may never be freed. A bit of a hack! DAPM */
9749 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9750 Nullgv : gv_dup(CvGV(dstr), param) ;
9751 if (!(param->flags & CLONEf_COPY_STACKS)) {
9754 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9757 ? cv_dup( CvOUTSIDE(dstr), param)
9758 : cv_dup_inc(CvOUTSIDE(dstr), param);
9760 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9766 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9772 /* duplicate a context */
9775 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9780 return (PERL_CONTEXT*)NULL;
9782 /* look for it in the table first */
9783 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9787 /* create anew and remember what it is */
9788 Newxz(ncxs, max + 1, PERL_CONTEXT);
9789 ptr_table_store(PL_ptr_table, cxs, ncxs);
9792 PERL_CONTEXT *cx = &cxs[ix];
9793 PERL_CONTEXT *ncx = &ncxs[ix];
9794 ncx->cx_type = cx->cx_type;
9795 if (CxTYPE(cx) == CXt_SUBST) {
9796 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9799 ncx->blk_oldsp = cx->blk_oldsp;
9800 ncx->blk_oldcop = cx->blk_oldcop;
9801 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9802 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9803 ncx->blk_oldpm = cx->blk_oldpm;
9804 ncx->blk_gimme = cx->blk_gimme;
9805 switch (CxTYPE(cx)) {
9807 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9808 ? cv_dup_inc(cx->blk_sub.cv, param)
9809 : cv_dup(cx->blk_sub.cv,param));
9810 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9811 ? av_dup_inc(cx->blk_sub.argarray, param)
9813 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9814 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9815 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9816 ncx->blk_sub.lval = cx->blk_sub.lval;
9817 ncx->blk_sub.retop = cx->blk_sub.retop;
9820 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9821 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9822 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9823 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9824 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9825 ncx->blk_eval.retop = cx->blk_eval.retop;
9828 ncx->blk_loop.label = cx->blk_loop.label;
9829 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9830 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9831 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9832 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9833 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9834 ? cx->blk_loop.iterdata
9835 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9836 ncx->blk_loop.oldcomppad
9837 = (PAD*)ptr_table_fetch(PL_ptr_table,
9838 cx->blk_loop.oldcomppad);
9839 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9840 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9841 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9842 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9843 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9846 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9847 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9848 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9849 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9850 ncx->blk_sub.retop = cx->blk_sub.retop;
9862 /* duplicate a stack info structure */
9865 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9870 return (PERL_SI*)NULL;
9872 /* look for it in the table first */
9873 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9877 /* create anew and remember what it is */
9878 Newxz(nsi, 1, PERL_SI);
9879 ptr_table_store(PL_ptr_table, si, nsi);
9881 nsi->si_stack = av_dup_inc(si->si_stack, param);
9882 nsi->si_cxix = si->si_cxix;
9883 nsi->si_cxmax = si->si_cxmax;
9884 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9885 nsi->si_type = si->si_type;
9886 nsi->si_prev = si_dup(si->si_prev, param);
9887 nsi->si_next = si_dup(si->si_next, param);
9888 nsi->si_markoff = si->si_markoff;
9893 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9894 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9895 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9896 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9897 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9898 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9899 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9900 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9901 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9902 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9903 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9904 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9905 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9906 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9909 #define pv_dup_inc(p) SAVEPV(p)
9910 #define pv_dup(p) SAVEPV(p)
9911 #define svp_dup_inc(p,pp) any_dup(p,pp)
9913 /* map any object to the new equivent - either something in the
9914 * ptr table, or something in the interpreter structure
9918 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9925 /* look for it in the table first */
9926 ret = ptr_table_fetch(PL_ptr_table, v);
9930 /* see if it is part of the interpreter structure */
9931 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9932 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9940 /* duplicate the save stack */
9943 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9945 ANY * const ss = proto_perl->Tsavestack;
9946 const I32 max = proto_perl->Tsavestack_max;
9947 I32 ix = proto_perl->Tsavestack_ix;
9959 void (*dptr) (void*);
9960 void (*dxptr) (pTHX_ void*);
9962 Newxz(nss, max, ANY);
9965 I32 i = POPINT(ss,ix);
9968 case SAVEt_ITEM: /* normal string */
9969 sv = (SV*)POPPTR(ss,ix);
9970 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9971 sv = (SV*)POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9974 case SAVEt_SV: /* scalar reference */
9975 sv = (SV*)POPPTR(ss,ix);
9976 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9977 gv = (GV*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9980 case SAVEt_GENERIC_PVREF: /* generic char* */
9981 c = (char*)POPPTR(ss,ix);
9982 TOPPTR(nss,ix) = pv_dup(c);
9983 ptr = POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9986 case SAVEt_SHARED_PVREF: /* char* in shared space */
9987 c = (char*)POPPTR(ss,ix);
9988 TOPPTR(nss,ix) = savesharedpv(c);
9989 ptr = POPPTR(ss,ix);
9990 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9992 case SAVEt_GENERIC_SVREF: /* generic sv */
9993 case SAVEt_SVREF: /* scalar reference */
9994 sv = (SV*)POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9996 ptr = POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9999 case SAVEt_AV: /* array reference */
10000 av = (AV*)POPPTR(ss,ix);
10001 TOPPTR(nss,ix) = av_dup_inc(av, param);
10002 gv = (GV*)POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = gv_dup(gv, param);
10005 case SAVEt_HV: /* hash reference */
10006 hv = (HV*)POPPTR(ss,ix);
10007 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10008 gv = (GV*)POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = gv_dup(gv, param);
10011 case SAVEt_INT: /* int reference */
10012 ptr = POPPTR(ss,ix);
10013 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10014 intval = (int)POPINT(ss,ix);
10015 TOPINT(nss,ix) = intval;
10017 case SAVEt_LONG: /* long reference */
10018 ptr = POPPTR(ss,ix);
10019 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10020 longval = (long)POPLONG(ss,ix);
10021 TOPLONG(nss,ix) = longval;
10023 case SAVEt_I32: /* I32 reference */
10024 case SAVEt_I16: /* I16 reference */
10025 case SAVEt_I8: /* I8 reference */
10026 ptr = POPPTR(ss,ix);
10027 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10029 TOPINT(nss,ix) = i;
10031 case SAVEt_IV: /* IV reference */
10032 ptr = POPPTR(ss,ix);
10033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10035 TOPIV(nss,ix) = iv;
10037 case SAVEt_SPTR: /* SV* reference */
10038 ptr = POPPTR(ss,ix);
10039 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10040 sv = (SV*)POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = sv_dup(sv, param);
10043 case SAVEt_VPTR: /* random* reference */
10044 ptr = POPPTR(ss,ix);
10045 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10046 ptr = POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10049 case SAVEt_PPTR: /* char* reference */
10050 ptr = POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10052 c = (char*)POPPTR(ss,ix);
10053 TOPPTR(nss,ix) = pv_dup(c);
10055 case SAVEt_HPTR: /* HV* reference */
10056 ptr = POPPTR(ss,ix);
10057 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10058 hv = (HV*)POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = hv_dup(hv, param);
10061 case SAVEt_APTR: /* AV* reference */
10062 ptr = POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10064 av = (AV*)POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = av_dup(av, param);
10068 gv = (GV*)POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = gv_dup(gv, param);
10071 case SAVEt_GP: /* scalar reference */
10072 gp = (GP*)POPPTR(ss,ix);
10073 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10074 (void)GpREFCNT_inc(gp);
10075 gv = (GV*)POPPTR(ss,ix);
10076 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10077 c = (char*)POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = pv_dup(c);
10080 TOPIV(nss,ix) = iv;
10082 TOPIV(nss,ix) = iv;
10085 case SAVEt_MORTALIZESV:
10086 sv = (SV*)POPPTR(ss,ix);
10087 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10090 ptr = POPPTR(ss,ix);
10091 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10092 /* these are assumed to be refcounted properly */
10094 switch (((OP*)ptr)->op_type) {
10096 case OP_LEAVESUBLV:
10100 case OP_LEAVEWRITE:
10101 TOPPTR(nss,ix) = ptr;
10106 TOPPTR(nss,ix) = Nullop;
10111 TOPPTR(nss,ix) = Nullop;
10114 c = (char*)POPPTR(ss,ix);
10115 TOPPTR(nss,ix) = pv_dup_inc(c);
10117 case SAVEt_CLEARSV:
10118 longval = POPLONG(ss,ix);
10119 TOPLONG(nss,ix) = longval;
10122 hv = (HV*)POPPTR(ss,ix);
10123 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10124 c = (char*)POPPTR(ss,ix);
10125 TOPPTR(nss,ix) = pv_dup_inc(c);
10127 TOPINT(nss,ix) = i;
10129 case SAVEt_DESTRUCTOR:
10130 ptr = POPPTR(ss,ix);
10131 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10132 dptr = POPDPTR(ss,ix);
10133 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10134 any_dup(FPTR2DPTR(void *, dptr),
10137 case SAVEt_DESTRUCTOR_X:
10138 ptr = POPPTR(ss,ix);
10139 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10140 dxptr = POPDXPTR(ss,ix);
10141 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10142 any_dup(FPTR2DPTR(void *, dxptr),
10145 case SAVEt_REGCONTEXT:
10148 TOPINT(nss,ix) = i;
10151 case SAVEt_STACK_POS: /* Position on Perl stack */
10153 TOPINT(nss,ix) = i;
10155 case SAVEt_AELEM: /* array element */
10156 sv = (SV*)POPPTR(ss,ix);
10157 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10159 TOPINT(nss,ix) = i;
10160 av = (AV*)POPPTR(ss,ix);
10161 TOPPTR(nss,ix) = av_dup_inc(av, param);
10163 case SAVEt_HELEM: /* hash element */
10164 sv = (SV*)POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10166 sv = (SV*)POPPTR(ss,ix);
10167 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10168 hv = (HV*)POPPTR(ss,ix);
10169 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10172 ptr = POPPTR(ss,ix);
10173 TOPPTR(nss,ix) = ptr;
10177 TOPINT(nss,ix) = i;
10179 case SAVEt_COMPPAD:
10180 av = (AV*)POPPTR(ss,ix);
10181 TOPPTR(nss,ix) = av_dup(av, param);
10184 longval = (long)POPLONG(ss,ix);
10185 TOPLONG(nss,ix) = longval;
10186 ptr = POPPTR(ss,ix);
10187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10188 sv = (SV*)POPPTR(ss,ix);
10189 TOPPTR(nss,ix) = sv_dup(sv, param);
10192 ptr = POPPTR(ss,ix);
10193 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10194 longval = (long)POPBOOL(ss,ix);
10195 TOPBOOL(nss,ix) = (bool)longval;
10197 case SAVEt_SET_SVFLAGS:
10199 TOPINT(nss,ix) = i;
10201 TOPINT(nss,ix) = i;
10202 sv = (SV*)POPPTR(ss,ix);
10203 TOPPTR(nss,ix) = sv_dup(sv, param);
10206 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10214 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10215 * flag to the result. This is done for each stash before cloning starts,
10216 * so we know which stashes want their objects cloned */
10219 do_mark_cloneable_stash(pTHX_ SV *sv)
10221 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10223 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10224 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10225 if (cloner && GvCV(cloner)) {
10232 XPUSHs(sv_2mortal(newSVhek(hvname)));
10234 call_sv((SV*)GvCV(cloner), G_SCALAR);
10241 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10249 =for apidoc perl_clone
10251 Create and return a new interpreter by cloning the current one.
10253 perl_clone takes these flags as parameters:
10255 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10256 without it we only clone the data and zero the stacks,
10257 with it we copy the stacks and the new perl interpreter is
10258 ready to run at the exact same point as the previous one.
10259 The pseudo-fork code uses COPY_STACKS while the
10260 threads->new doesn't.
10262 CLONEf_KEEP_PTR_TABLE
10263 perl_clone keeps a ptr_table with the pointer of the old
10264 variable as a key and the new variable as a value,
10265 this allows it to check if something has been cloned and not
10266 clone it again but rather just use the value and increase the
10267 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10268 the ptr_table using the function
10269 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10270 reason to keep it around is if you want to dup some of your own
10271 variable who are outside the graph perl scans, example of this
10272 code is in threads.xs create
10275 This is a win32 thing, it is ignored on unix, it tells perls
10276 win32host code (which is c++) to clone itself, this is needed on
10277 win32 if you want to run two threads at the same time,
10278 if you just want to do some stuff in a separate perl interpreter
10279 and then throw it away and return to the original one,
10280 you don't need to do anything.
10285 /* XXX the above needs expanding by someone who actually understands it ! */
10286 EXTERN_C PerlInterpreter *
10287 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10290 perl_clone(PerlInterpreter *proto_perl, UV flags)
10293 #ifdef PERL_IMPLICIT_SYS
10295 /* perlhost.h so we need to call into it
10296 to clone the host, CPerlHost should have a c interface, sky */
10298 if (flags & CLONEf_CLONE_HOST) {
10299 return perl_clone_host(proto_perl,flags);
10301 return perl_clone_using(proto_perl, flags,
10303 proto_perl->IMemShared,
10304 proto_perl->IMemParse,
10306 proto_perl->IStdIO,
10310 proto_perl->IProc);
10314 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10315 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10316 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10317 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10318 struct IPerlDir* ipD, struct IPerlSock* ipS,
10319 struct IPerlProc* ipP)
10321 /* XXX many of the string copies here can be optimized if they're
10322 * constants; they need to be allocated as common memory and just
10323 * their pointers copied. */
10326 CLONE_PARAMS clone_params;
10327 CLONE_PARAMS* param = &clone_params;
10329 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10330 /* for each stash, determine whether its objects should be cloned */
10331 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10332 PERL_SET_THX(my_perl);
10335 Poison(my_perl, 1, PerlInterpreter);
10337 PL_curcop = (COP *)Nullop;
10341 PL_savestack_ix = 0;
10342 PL_savestack_max = -1;
10343 PL_sig_pending = 0;
10344 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10345 # else /* !DEBUGGING */
10346 Zero(my_perl, 1, PerlInterpreter);
10347 # endif /* DEBUGGING */
10349 /* host pointers */
10351 PL_MemShared = ipMS;
10352 PL_MemParse = ipMP;
10359 #else /* !PERL_IMPLICIT_SYS */
10361 CLONE_PARAMS clone_params;
10362 CLONE_PARAMS* param = &clone_params;
10363 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10364 /* for each stash, determine whether its objects should be cloned */
10365 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10366 PERL_SET_THX(my_perl);
10369 Poison(my_perl, 1, PerlInterpreter);
10371 PL_curcop = (COP *)Nullop;
10375 PL_savestack_ix = 0;
10376 PL_savestack_max = -1;
10377 PL_sig_pending = 0;
10378 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10379 # else /* !DEBUGGING */
10380 Zero(my_perl, 1, PerlInterpreter);
10381 # endif /* DEBUGGING */
10382 #endif /* PERL_IMPLICIT_SYS */
10383 param->flags = flags;
10384 param->proto_perl = proto_perl;
10386 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10387 Zero(&PL_body_roots, 1, PL_body_roots);
10389 PL_nice_chunk = NULL;
10390 PL_nice_chunk_size = 0;
10392 PL_sv_objcount = 0;
10393 PL_sv_root = Nullsv;
10394 PL_sv_arenaroot = Nullsv;
10396 PL_debug = proto_perl->Idebug;
10398 PL_hash_seed = proto_perl->Ihash_seed;
10399 PL_rehash_seed = proto_perl->Irehash_seed;
10401 #ifdef USE_REENTRANT_API
10402 /* XXX: things like -Dm will segfault here in perlio, but doing
10403 * PERL_SET_CONTEXT(proto_perl);
10404 * breaks too many other things
10406 Perl_reentrant_init(aTHX);
10409 /* create SV map for pointer relocation */
10410 PL_ptr_table = ptr_table_new();
10412 /* initialize these special pointers as early as possible */
10413 SvANY(&PL_sv_undef) = NULL;
10414 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10415 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10416 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10418 SvANY(&PL_sv_no) = new_XPVNV();
10419 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10420 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10421 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10422 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10423 SvCUR_set(&PL_sv_no, 0);
10424 SvLEN_set(&PL_sv_no, 1);
10425 SvIV_set(&PL_sv_no, 0);
10426 SvNV_set(&PL_sv_no, 0);
10427 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10429 SvANY(&PL_sv_yes) = new_XPVNV();
10430 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10431 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10432 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10433 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10434 SvCUR_set(&PL_sv_yes, 1);
10435 SvLEN_set(&PL_sv_yes, 2);
10436 SvIV_set(&PL_sv_yes, 1);
10437 SvNV_set(&PL_sv_yes, 1);
10438 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10440 /* create (a non-shared!) shared string table */
10441 PL_strtab = newHV();
10442 HvSHAREKEYS_off(PL_strtab);
10443 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10444 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10446 PL_compiling = proto_perl->Icompiling;
10448 /* These two PVs will be free'd special way so must set them same way op.c does */
10449 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10450 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10452 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10453 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10455 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10456 if (!specialWARN(PL_compiling.cop_warnings))
10457 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10458 if (!specialCopIO(PL_compiling.cop_io))
10459 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10460 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10462 /* pseudo environmental stuff */
10463 PL_origargc = proto_perl->Iorigargc;
10464 PL_origargv = proto_perl->Iorigargv;
10466 param->stashes = newAV(); /* Setup array of objects to call clone on */
10468 /* Set tainting stuff before PerlIO_debug can possibly get called */
10469 PL_tainting = proto_perl->Itainting;
10470 PL_taint_warn = proto_perl->Itaint_warn;
10472 #ifdef PERLIO_LAYERS
10473 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10474 PerlIO_clone(aTHX_ proto_perl, param);
10477 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10478 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10479 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10480 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10481 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10482 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10485 PL_minus_c = proto_perl->Iminus_c;
10486 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10487 PL_localpatches = proto_perl->Ilocalpatches;
10488 PL_splitstr = proto_perl->Isplitstr;
10489 PL_preprocess = proto_perl->Ipreprocess;
10490 PL_minus_n = proto_perl->Iminus_n;
10491 PL_minus_p = proto_perl->Iminus_p;
10492 PL_minus_l = proto_perl->Iminus_l;
10493 PL_minus_a = proto_perl->Iminus_a;
10494 PL_minus_F = proto_perl->Iminus_F;
10495 PL_doswitches = proto_perl->Idoswitches;
10496 PL_dowarn = proto_perl->Idowarn;
10497 PL_doextract = proto_perl->Idoextract;
10498 PL_sawampersand = proto_perl->Isawampersand;
10499 PL_unsafe = proto_perl->Iunsafe;
10500 PL_inplace = SAVEPV(proto_perl->Iinplace);
10501 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10502 PL_perldb = proto_perl->Iperldb;
10503 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10504 PL_exit_flags = proto_perl->Iexit_flags;
10506 /* magical thingies */
10507 /* XXX time(&PL_basetime) when asked for? */
10508 PL_basetime = proto_perl->Ibasetime;
10509 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10511 PL_maxsysfd = proto_perl->Imaxsysfd;
10512 PL_multiline = proto_perl->Imultiline;
10513 PL_statusvalue = proto_perl->Istatusvalue;
10515 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10517 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10519 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10521 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10522 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10523 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10525 /* Clone the regex array */
10526 PL_regex_padav = newAV();
10528 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10529 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10531 av_push(PL_regex_padav,
10532 sv_dup_inc(regexen[0],param));
10533 for(i = 1; i <= len; i++) {
10534 if(SvREPADTMP(regexen[i])) {
10535 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10537 av_push(PL_regex_padav,
10539 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10540 SvIVX(regexen[i])), param)))
10545 PL_regex_pad = AvARRAY(PL_regex_padav);
10547 /* shortcuts to various I/O objects */
10548 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10549 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10550 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10551 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10552 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10553 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10555 /* shortcuts to regexp stuff */
10556 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10558 /* shortcuts to misc objects */
10559 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10561 /* shortcuts to debugging objects */
10562 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10563 PL_DBline = gv_dup(proto_perl->IDBline, param);
10564 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10565 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10566 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10567 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10568 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10569 PL_lineary = av_dup(proto_perl->Ilineary, param);
10570 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10572 /* symbol tables */
10573 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10574 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10575 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10576 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10577 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10579 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10580 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10581 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10582 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10583 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10584 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10586 PL_sub_generation = proto_perl->Isub_generation;
10588 /* funky return mechanisms */
10589 PL_forkprocess = proto_perl->Iforkprocess;
10591 /* subprocess state */
10592 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10594 /* internal state */
10595 PL_maxo = proto_perl->Imaxo;
10596 if (proto_perl->Iop_mask)
10597 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10599 PL_op_mask = Nullch;
10600 /* PL_asserting = proto_perl->Iasserting; */
10602 /* current interpreter roots */
10603 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10604 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10605 PL_main_start = proto_perl->Imain_start;
10606 PL_eval_root = proto_perl->Ieval_root;
10607 PL_eval_start = proto_perl->Ieval_start;
10609 /* runtime control stuff */
10610 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10611 PL_copline = proto_perl->Icopline;
10613 PL_filemode = proto_perl->Ifilemode;
10614 PL_lastfd = proto_perl->Ilastfd;
10615 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10618 PL_gensym = proto_perl->Igensym;
10619 PL_preambled = proto_perl->Ipreambled;
10620 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10621 PL_laststatval = proto_perl->Ilaststatval;
10622 PL_laststype = proto_perl->Ilaststype;
10623 PL_mess_sv = Nullsv;
10625 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10627 /* interpreter atexit processing */
10628 PL_exitlistlen = proto_perl->Iexitlistlen;
10629 if (PL_exitlistlen) {
10630 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10631 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10634 PL_exitlist = (PerlExitListEntry*)NULL;
10635 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10636 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10637 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10639 PL_profiledata = NULL;
10640 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10641 /* PL_rsfp_filters entries have fake IoDIRP() */
10642 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10644 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10646 PAD_CLONE_VARS(proto_perl, param);
10648 #ifdef HAVE_INTERP_INTERN
10649 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10652 /* more statics moved here */
10653 PL_generation = proto_perl->Igeneration;
10654 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10656 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10657 PL_in_clean_all = proto_perl->Iin_clean_all;
10659 PL_uid = proto_perl->Iuid;
10660 PL_euid = proto_perl->Ieuid;
10661 PL_gid = proto_perl->Igid;
10662 PL_egid = proto_perl->Iegid;
10663 PL_nomemok = proto_perl->Inomemok;
10664 PL_an = proto_perl->Ian;
10665 PL_evalseq = proto_perl->Ievalseq;
10666 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10667 PL_origalen = proto_perl->Iorigalen;
10668 #ifdef PERL_USES_PL_PIDSTATUS
10669 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10671 PL_osname = SAVEPV(proto_perl->Iosname);
10672 PL_sighandlerp = proto_perl->Isighandlerp;
10674 PL_runops = proto_perl->Irunops;
10676 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10679 PL_cshlen = proto_perl->Icshlen;
10680 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10683 PL_lex_state = proto_perl->Ilex_state;
10684 PL_lex_defer = proto_perl->Ilex_defer;
10685 PL_lex_expect = proto_perl->Ilex_expect;
10686 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10687 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10688 PL_lex_starts = proto_perl->Ilex_starts;
10689 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10690 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10691 PL_lex_op = proto_perl->Ilex_op;
10692 PL_lex_inpat = proto_perl->Ilex_inpat;
10693 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10694 PL_lex_brackets = proto_perl->Ilex_brackets;
10695 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10696 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10697 PL_lex_casemods = proto_perl->Ilex_casemods;
10698 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10699 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10701 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10702 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10703 PL_nexttoke = proto_perl->Inexttoke;
10705 /* XXX This is probably masking the deeper issue of why
10706 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10707 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10708 * (A little debugging with a watchpoint on it may help.)
10710 if (SvANY(proto_perl->Ilinestr)) {
10711 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10712 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10713 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10714 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10715 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10716 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10717 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10718 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10719 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10722 PL_linestr = NEWSV(65,79);
10723 sv_upgrade(PL_linestr,SVt_PVIV);
10724 sv_setpvn(PL_linestr,"",0);
10725 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10727 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10728 PL_pending_ident = proto_perl->Ipending_ident;
10729 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10731 PL_expect = proto_perl->Iexpect;
10733 PL_multi_start = proto_perl->Imulti_start;
10734 PL_multi_end = proto_perl->Imulti_end;
10735 PL_multi_open = proto_perl->Imulti_open;
10736 PL_multi_close = proto_perl->Imulti_close;
10738 PL_error_count = proto_perl->Ierror_count;
10739 PL_subline = proto_perl->Isubline;
10740 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10742 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10743 if (SvANY(proto_perl->Ilinestr)) {
10744 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10745 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10746 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10747 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10748 PL_last_lop_op = proto_perl->Ilast_lop_op;
10751 PL_last_uni = SvPVX(PL_linestr);
10752 PL_last_lop = SvPVX(PL_linestr);
10753 PL_last_lop_op = 0;
10755 PL_in_my = proto_perl->Iin_my;
10756 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10758 PL_cryptseen = proto_perl->Icryptseen;
10761 PL_hints = proto_perl->Ihints;
10763 PL_amagic_generation = proto_perl->Iamagic_generation;
10765 #ifdef USE_LOCALE_COLLATE
10766 PL_collation_ix = proto_perl->Icollation_ix;
10767 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10768 PL_collation_standard = proto_perl->Icollation_standard;
10769 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10770 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10771 #endif /* USE_LOCALE_COLLATE */
10773 #ifdef USE_LOCALE_NUMERIC
10774 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10775 PL_numeric_standard = proto_perl->Inumeric_standard;
10776 PL_numeric_local = proto_perl->Inumeric_local;
10777 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10778 #endif /* !USE_LOCALE_NUMERIC */
10780 /* utf8 character classes */
10781 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10782 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10783 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10784 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10785 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10786 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10787 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10788 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10789 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10790 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10791 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10792 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10793 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10794 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10795 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10796 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10797 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10798 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10799 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10800 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10802 /* Did the locale setup indicate UTF-8? */
10803 PL_utf8locale = proto_perl->Iutf8locale;
10804 /* Unicode features (see perlrun/-C) */
10805 PL_unicode = proto_perl->Iunicode;
10807 /* Pre-5.8 signals control */
10808 PL_signals = proto_perl->Isignals;
10810 /* times() ticks per second */
10811 PL_clocktick = proto_perl->Iclocktick;
10813 /* Recursion stopper for PerlIO_find_layer */
10814 PL_in_load_module = proto_perl->Iin_load_module;
10816 /* sort() routine */
10817 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10819 /* Not really needed/useful since the reenrant_retint is "volatile",
10820 * but do it for consistency's sake. */
10821 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10823 /* Hooks to shared SVs and locks. */
10824 PL_sharehook = proto_perl->Isharehook;
10825 PL_lockhook = proto_perl->Ilockhook;
10826 PL_unlockhook = proto_perl->Iunlockhook;
10827 PL_threadhook = proto_perl->Ithreadhook;
10829 PL_runops_std = proto_perl->Irunops_std;
10830 PL_runops_dbg = proto_perl->Irunops_dbg;
10832 #ifdef THREADS_HAVE_PIDS
10833 PL_ppid = proto_perl->Ippid;
10837 PL_last_swash_hv = Nullhv; /* reinits on demand */
10838 PL_last_swash_klen = 0;
10839 PL_last_swash_key[0]= '\0';
10840 PL_last_swash_tmps = (U8*)NULL;
10841 PL_last_swash_slen = 0;
10843 PL_glob_index = proto_perl->Iglob_index;
10844 PL_srand_called = proto_perl->Isrand_called;
10845 PL_uudmap['M'] = 0; /* reinits on demand */
10846 PL_bitcount = Nullch; /* reinits on demand */
10848 if (proto_perl->Ipsig_pend) {
10849 Newxz(PL_psig_pend, SIG_SIZE, int);
10852 PL_psig_pend = (int*)NULL;
10855 if (proto_perl->Ipsig_ptr) {
10856 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10857 Newxz(PL_psig_name, SIG_SIZE, SV*);
10858 for (i = 1; i < SIG_SIZE; i++) {
10859 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10860 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10864 PL_psig_ptr = (SV**)NULL;
10865 PL_psig_name = (SV**)NULL;
10868 /* thrdvar.h stuff */
10870 if (flags & CLONEf_COPY_STACKS) {
10871 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10872 PL_tmps_ix = proto_perl->Ttmps_ix;
10873 PL_tmps_max = proto_perl->Ttmps_max;
10874 PL_tmps_floor = proto_perl->Ttmps_floor;
10875 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10877 while (i <= PL_tmps_ix) {
10878 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10882 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10883 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10884 Newxz(PL_markstack, i, I32);
10885 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10886 - proto_perl->Tmarkstack);
10887 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10888 - proto_perl->Tmarkstack);
10889 Copy(proto_perl->Tmarkstack, PL_markstack,
10890 PL_markstack_ptr - PL_markstack + 1, I32);
10892 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10893 * NOTE: unlike the others! */
10894 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10895 PL_scopestack_max = proto_perl->Tscopestack_max;
10896 Newxz(PL_scopestack, PL_scopestack_max, I32);
10897 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10899 /* NOTE: si_dup() looks at PL_markstack */
10900 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10902 /* PL_curstack = PL_curstackinfo->si_stack; */
10903 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10904 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10906 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10907 PL_stack_base = AvARRAY(PL_curstack);
10908 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10909 - proto_perl->Tstack_base);
10910 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10912 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10913 * NOTE: unlike the others! */
10914 PL_savestack_ix = proto_perl->Tsavestack_ix;
10915 PL_savestack_max = proto_perl->Tsavestack_max;
10916 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10917 PL_savestack = ss_dup(proto_perl, param);
10921 ENTER; /* perl_destruct() wants to LEAVE; */
10924 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10925 PL_top_env = &PL_start_env;
10927 PL_op = proto_perl->Top;
10930 PL_Xpv = (XPV*)NULL;
10931 PL_na = proto_perl->Tna;
10933 PL_statbuf = proto_perl->Tstatbuf;
10934 PL_statcache = proto_perl->Tstatcache;
10935 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10936 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10938 PL_timesbuf = proto_perl->Ttimesbuf;
10941 PL_tainted = proto_perl->Ttainted;
10942 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10943 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10944 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10945 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10946 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10947 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10948 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10949 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10950 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10952 PL_restartop = proto_perl->Trestartop;
10953 PL_in_eval = proto_perl->Tin_eval;
10954 PL_delaymagic = proto_perl->Tdelaymagic;
10955 PL_dirty = proto_perl->Tdirty;
10956 PL_localizing = proto_perl->Tlocalizing;
10958 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10959 PL_hv_fetch_ent_mh = Nullhe;
10960 PL_modcount = proto_perl->Tmodcount;
10961 PL_lastgotoprobe = Nullop;
10962 PL_dumpindent = proto_perl->Tdumpindent;
10964 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10965 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10966 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10967 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10968 PL_efloatbuf = Nullch; /* reinits on demand */
10969 PL_efloatsize = 0; /* reinits on demand */
10973 PL_screamfirst = NULL;
10974 PL_screamnext = NULL;
10975 PL_maxscream = -1; /* reinits on demand */
10976 PL_lastscream = Nullsv;
10978 PL_watchaddr = NULL;
10979 PL_watchok = Nullch;
10981 PL_regdummy = proto_perl->Tregdummy;
10982 PL_regprecomp = Nullch;
10985 PL_colorset = 0; /* reinits PL_colors[] */
10986 /*PL_colors[6] = {0,0,0,0,0,0};*/
10987 PL_reginput = Nullch;
10988 PL_regbol = Nullch;
10989 PL_regeol = Nullch;
10990 PL_regstartp = (I32*)NULL;
10991 PL_regendp = (I32*)NULL;
10992 PL_reglastparen = (U32*)NULL;
10993 PL_reglastcloseparen = (U32*)NULL;
10994 PL_regtill = Nullch;
10995 PL_reg_start_tmp = (char**)NULL;
10996 PL_reg_start_tmpl = 0;
10997 PL_regdata = (struct reg_data*)NULL;
11000 PL_reg_eval_set = 0;
11002 PL_regprogram = (regnode*)NULL;
11004 PL_regcc = (CURCUR*)NULL;
11005 PL_reg_call_cc = (struct re_cc_state*)NULL;
11006 PL_reg_re = (regexp*)NULL;
11007 PL_reg_ganch = Nullch;
11008 PL_reg_sv = Nullsv;
11009 PL_reg_match_utf8 = FALSE;
11010 PL_reg_magic = (MAGIC*)NULL;
11012 PL_reg_oldcurpm = (PMOP*)NULL;
11013 PL_reg_curpm = (PMOP*)NULL;
11014 PL_reg_oldsaved = Nullch;
11015 PL_reg_oldsavedlen = 0;
11016 #ifdef PERL_OLD_COPY_ON_WRITE
11019 PL_reg_maxiter = 0;
11020 PL_reg_leftiter = 0;
11021 PL_reg_poscache = Nullch;
11022 PL_reg_poscache_size= 0;
11024 /* RE engine - function pointers */
11025 PL_regcompp = proto_perl->Tregcompp;
11026 PL_regexecp = proto_perl->Tregexecp;
11027 PL_regint_start = proto_perl->Tregint_start;
11028 PL_regint_string = proto_perl->Tregint_string;
11029 PL_regfree = proto_perl->Tregfree;
11031 PL_reginterp_cnt = 0;
11032 PL_reg_starttry = 0;
11034 /* Pluggable optimizer */
11035 PL_peepp = proto_perl->Tpeepp;
11037 PL_stashcache = newHV();
11039 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11040 ptr_table_free(PL_ptr_table);
11041 PL_ptr_table = NULL;
11044 /* Call the ->CLONE method, if it exists, for each of the stashes
11045 identified by sv_dup() above.
11047 while(av_len(param->stashes) != -1) {
11048 HV* const stash = (HV*) av_shift(param->stashes);
11049 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11050 if (cloner && GvCV(cloner)) {
11055 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11057 call_sv((SV*)GvCV(cloner), G_DISCARD);
11063 SvREFCNT_dec(param->stashes);
11065 /* orphaned? eg threads->new inside BEGIN or use */
11066 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11067 (void)SvREFCNT_inc(PL_compcv);
11068 SAVEFREESV(PL_compcv);
11074 #endif /* USE_ITHREADS */
11077 =head1 Unicode Support
11079 =for apidoc sv_recode_to_utf8
11081 The encoding is assumed to be an Encode object, on entry the PV
11082 of the sv is assumed to be octets in that encoding, and the sv
11083 will be converted into Unicode (and UTF-8).
11085 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11086 is not a reference, nothing is done to the sv. If the encoding is not
11087 an C<Encode::XS> Encoding object, bad things will happen.
11088 (See F<lib/encoding.pm> and L<Encode>).
11090 The PV of the sv is returned.
11095 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11098 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11112 Passing sv_yes is wrong - it needs to be or'ed set of constants
11113 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11114 remove converted chars from source.
11116 Both will default the value - let them.
11118 XPUSHs(&PL_sv_yes);
11121 call_method("decode", G_SCALAR);
11125 s = SvPV_const(uni, len);
11126 if (s != SvPVX_const(sv)) {
11127 SvGROW(sv, len + 1);
11128 Move(s, SvPVX(sv), len + 1, char);
11129 SvCUR_set(sv, len);
11136 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11140 =for apidoc sv_cat_decode
11142 The encoding is assumed to be an Encode object, the PV of the ssv is
11143 assumed to be octets in that encoding and decoding the input starts
11144 from the position which (PV + *offset) pointed to. The dsv will be
11145 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11146 when the string tstr appears in decoding output or the input ends on
11147 the PV of the ssv. The value which the offset points will be modified
11148 to the last input position on the ssv.
11150 Returns TRUE if the terminator was found, else returns FALSE.
11155 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11156 SV *ssv, int *offset, char *tstr, int tlen)
11160 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11171 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11172 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11174 call_method("cat_decode", G_SCALAR);
11176 ret = SvTRUE(TOPs);
11177 *offset = SvIV(offsv);
11183 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11188 /* ---------------------------------------------------------------------
11190 * support functions for report_uninit()
11193 /* the maxiumum size of array or hash where we will scan looking
11194 * for the undefined element that triggered the warning */
11196 #define FUV_MAX_SEARCH_SIZE 1000
11198 /* Look for an entry in the hash whose value has the same SV as val;
11199 * If so, return a mortal copy of the key. */
11202 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11205 register HE **array;
11208 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11209 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11212 array = HvARRAY(hv);
11214 for (i=HvMAX(hv); i>0; i--) {
11215 register HE *entry;
11216 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11217 if (HeVAL(entry) != val)
11219 if ( HeVAL(entry) == &PL_sv_undef ||
11220 HeVAL(entry) == &PL_sv_placeholder)
11224 if (HeKLEN(entry) == HEf_SVKEY)
11225 return sv_mortalcopy(HeKEY_sv(entry));
11226 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11232 /* Look for an entry in the array whose value has the same SV as val;
11233 * If so, return the index, otherwise return -1. */
11236 S_find_array_subscript(pTHX_ AV *av, SV* val)
11240 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11241 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11245 for (i=AvFILLp(av); i>=0; i--) {
11246 if (svp[i] == val && svp[i] != &PL_sv_undef)
11252 /* S_varname(): return the name of a variable, optionally with a subscript.
11253 * If gv is non-zero, use the name of that global, along with gvtype (one
11254 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11255 * targ. Depending on the value of the subscript_type flag, return:
11258 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11259 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11260 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11261 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11264 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11265 SV* keyname, I32 aindex, int subscript_type)
11268 SV * const name = sv_newmortal();
11271 buffer[0] = gvtype;
11274 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11276 gv_fullname4(name, gv, buffer, 0);
11278 if ((unsigned int)SvPVX(name)[1] <= 26) {
11280 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11282 /* Swap the 1 unprintable control character for the 2 byte pretty
11283 version - ie substr($name, 1, 1) = $buffer; */
11284 sv_insert(name, 1, 1, buffer, 2);
11289 CV * const cv = find_runcv(&unused);
11293 if (!cv || !CvPADLIST(cv))
11295 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11296 sv = *av_fetch(av, targ, FALSE);
11297 /* SvLEN in a pad name is not to be trusted */
11298 sv_setpv(name, SvPV_nolen_const(sv));
11301 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11302 SV * const sv = NEWSV(0,0);
11303 *SvPVX(name) = '$';
11304 Perl_sv_catpvf(aTHX_ name, "{%s}",
11305 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11308 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11309 *SvPVX(name) = '$';
11310 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11312 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11313 sv_insert(name, 0, 0, "within ", 7);
11320 =for apidoc find_uninit_var
11322 Find the name of the undefined variable (if any) that caused the operator o
11323 to issue a "Use of uninitialized value" warning.
11324 If match is true, only return a name if it's value matches uninit_sv.
11325 So roughly speaking, if a unary operator (such as OP_COS) generates a
11326 warning, then following the direct child of the op may yield an
11327 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11328 other hand, with OP_ADD there are two branches to follow, so we only print
11329 the variable name if we get an exact match.
11331 The name is returned as a mortal SV.
11333 Assumes that PL_op is the op that originally triggered the error, and that
11334 PL_comppad/PL_curpad points to the currently executing pad.
11340 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11348 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11349 uninit_sv == &PL_sv_placeholder)))
11352 switch (obase->op_type) {
11359 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11360 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11362 SV *keysv = Nullsv;
11363 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11365 if (pad) { /* @lex, %lex */
11366 sv = PAD_SVl(obase->op_targ);
11370 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11371 /* @global, %global */
11372 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11375 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11377 else /* @{expr}, %{expr} */
11378 return find_uninit_var(cUNOPx(obase)->op_first,
11382 /* attempt to find a match within the aggregate */
11384 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11386 subscript_type = FUV_SUBSCRIPT_HASH;
11389 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11391 subscript_type = FUV_SUBSCRIPT_ARRAY;
11394 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11397 return varname(gv, hash ? '%' : '@', obase->op_targ,
11398 keysv, index, subscript_type);
11402 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11404 return varname(Nullgv, '$', obase->op_targ,
11405 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11408 gv = cGVOPx_gv(obase);
11409 if (!gv || (match && GvSV(gv) != uninit_sv))
11411 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11414 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11417 av = (AV*)PAD_SV(obase->op_targ);
11418 if (!av || SvRMAGICAL(av))
11420 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11421 if (!svp || *svp != uninit_sv)
11424 return varname(Nullgv, '$', obase->op_targ,
11425 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11428 gv = cGVOPx_gv(obase);
11434 if (!av || SvRMAGICAL(av))
11436 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11437 if (!svp || *svp != uninit_sv)
11440 return varname(gv, '$', 0,
11441 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11446 o = cUNOPx(obase)->op_first;
11447 if (!o || o->op_type != OP_NULL ||
11448 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11450 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11454 if (PL_op == obase)
11455 /* $a[uninit_expr] or $h{uninit_expr} */
11456 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11459 o = cBINOPx(obase)->op_first;
11460 kid = cBINOPx(obase)->op_last;
11462 /* get the av or hv, and optionally the gv */
11464 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11465 sv = PAD_SV(o->op_targ);
11467 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11468 && cUNOPo->op_first->op_type == OP_GV)
11470 gv = cGVOPx_gv(cUNOPo->op_first);
11473 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11478 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11479 /* index is constant */
11483 if (obase->op_type == OP_HELEM) {
11484 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11485 if (!he || HeVAL(he) != uninit_sv)
11489 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11490 if (!svp || *svp != uninit_sv)
11494 if (obase->op_type == OP_HELEM)
11495 return varname(gv, '%', o->op_targ,
11496 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11498 return varname(gv, '@', o->op_targ, Nullsv,
11499 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11503 /* index is an expression;
11504 * attempt to find a match within the aggregate */
11505 if (obase->op_type == OP_HELEM) {
11506 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11508 return varname(gv, '%', o->op_targ,
11509 keysv, 0, FUV_SUBSCRIPT_HASH);
11512 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11514 return varname(gv, '@', o->op_targ,
11515 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11520 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11522 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11528 /* only examine RHS */
11529 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11532 o = cUNOPx(obase)->op_first;
11533 if (o->op_type == OP_PUSHMARK)
11536 if (!o->op_sibling) {
11537 /* one-arg version of open is highly magical */
11539 if (o->op_type == OP_GV) { /* open FOO; */
11541 if (match && GvSV(gv) != uninit_sv)
11543 return varname(gv, '$', 0,
11544 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11546 /* other possibilities not handled are:
11547 * open $x; or open my $x; should return '${*$x}'
11548 * open expr; should return '$'.expr ideally
11554 /* ops where $_ may be an implicit arg */
11558 if ( !(obase->op_flags & OPf_STACKED)) {
11559 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11560 ? PAD_SVl(obase->op_targ)
11563 sv = sv_newmortal();
11564 sv_setpvn(sv, "$_", 2);
11572 /* skip filehandle as it can't produce 'undef' warning */
11573 o = cUNOPx(obase)->op_first;
11574 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11575 o = o->op_sibling->op_sibling;
11582 match = 1; /* XS or custom code could trigger random warnings */
11587 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11588 return sv_2mortal(newSVpvn("${$/}", 5));
11593 if (!(obase->op_flags & OPf_KIDS))
11595 o = cUNOPx(obase)->op_first;
11601 /* if all except one arg are constant, or have no side-effects,
11602 * or are optimized away, then it's unambiguous */
11604 for (kid=o; kid; kid = kid->op_sibling) {
11606 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11607 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11608 || (kid->op_type == OP_PUSHMARK)
11612 if (o2) { /* more than one found */
11619 return find_uninit_var(o2, uninit_sv, match);
11621 /* scan all args */
11623 sv = find_uninit_var(o, uninit_sv, 1);
11635 =for apidoc report_uninit
11637 Print appropriate "Use of uninitialized variable" warning
11643 Perl_report_uninit(pTHX_ SV* uninit_sv)
11646 SV* varname = Nullsv;
11648 varname = find_uninit_var(PL_op, uninit_sv,0);
11650 sv_insert(varname, 0, 0, " ", 1);
11652 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11653 varname ? SvPV_nolen_const(varname) : "",
11654 " in ", OP_DESC(PL_op));
11657 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11663 * c-indentation-style: bsd
11664 * c-basic-offset: 4
11665 * indent-tabs-mode: t
11668 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob