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 */
1756 DEBUG_c(PerlIO_printf(Perl_debug_log,
1757 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1761 return (IV)SvUVX(sv);
1764 else if (SvPOKp(sv) && SvLEN(sv)) {
1766 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1767 /* We want to avoid a possible problem when we cache an IV which
1768 may be later translated to an NV, and the resulting NV is not
1769 the same as the direct translation of the initial string
1770 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1771 be careful to ensure that the value with the .456 is around if the
1772 NV value is requested in the future).
1774 This means that if we cache such an IV, we need to cache the
1775 NV as well. Moreover, we trade speed for space, and do not
1776 cache the NV if we are sure it's not needed.
1779 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1780 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1781 == IS_NUMBER_IN_UV) {
1782 /* It's definitely an integer, only upgrade to PVIV */
1783 if (SvTYPE(sv) < SVt_PVIV)
1784 sv_upgrade(sv, SVt_PVIV);
1786 } else if (SvTYPE(sv) < SVt_PVNV)
1787 sv_upgrade(sv, SVt_PVNV);
1789 /* If NV preserves UV then we only use the UV value if we know that
1790 we aren't going to call atof() below. If NVs don't preserve UVs
1791 then the value returned may have more precision than atof() will
1792 return, even though value isn't perfectly accurate. */
1793 if ((numtype & (IS_NUMBER_IN_UV
1794 #ifdef NV_PRESERVES_UV
1797 )) == IS_NUMBER_IN_UV) {
1798 /* This won't turn off the public IOK flag if it was set above */
1799 (void)SvIOKp_on(sv);
1801 if (!(numtype & IS_NUMBER_NEG)) {
1803 if (value <= (UV)IV_MAX) {
1804 SvIV_set(sv, (IV)value);
1806 SvUV_set(sv, value);
1810 /* 2s complement assumption */
1811 if (value <= (UV)IV_MIN) {
1812 SvIV_set(sv, -(IV)value);
1814 /* Too negative for an IV. This is a double upgrade, but
1815 I'm assuming it will be rare. */
1816 if (SvTYPE(sv) < SVt_PVNV)
1817 sv_upgrade(sv, SVt_PVNV);
1821 SvNV_set(sv, -(NV)value);
1822 SvIV_set(sv, IV_MIN);
1826 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1827 will be in the previous block to set the IV slot, and the next
1828 block to set the NV slot. So no else here. */
1830 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1831 != IS_NUMBER_IN_UV) {
1832 /* It wasn't an (integer that doesn't overflow the UV). */
1833 SvNV_set(sv, Atof(SvPVX_const(sv)));
1835 if (! numtype && ckWARN(WARN_NUMERIC))
1838 #if defined(USE_LONG_DOUBLE)
1839 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1840 PTR2UV(sv), SvNVX(sv)));
1842 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1843 PTR2UV(sv), SvNVX(sv)));
1847 #ifdef NV_PRESERVES_UV
1848 (void)SvIOKp_on(sv);
1850 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1851 SvIV_set(sv, I_V(SvNVX(sv)));
1852 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1855 /* Integer is imprecise. NOK, IOKp */
1857 /* UV will not work better than IV */
1859 if (SvNVX(sv) > (NV)UV_MAX) {
1861 /* Integer is inaccurate. NOK, IOKp, is UV */
1862 SvUV_set(sv, UV_MAX);
1865 SvUV_set(sv, U_V(SvNVX(sv)));
1866 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1867 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1871 /* Integer is imprecise. NOK, IOKp, is UV */
1877 #else /* NV_PRESERVES_UV */
1878 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1879 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1880 /* The IV slot will have been set from value returned by
1881 grok_number above. The NV slot has just been set using
1884 assert (SvIOKp(sv));
1886 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1887 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1888 /* Small enough to preserve all bits. */
1889 (void)SvIOKp_on(sv);
1891 SvIV_set(sv, I_V(SvNVX(sv)));
1892 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1894 /* Assumption: first non-preserved integer is < IV_MAX,
1895 this NV is in the preserved range, therefore: */
1896 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1898 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);
1902 0 0 already failed to read UV.
1903 0 1 already failed to read UV.
1904 1 0 you won't get here in this case. IV/UV
1905 slot set, public IOK, Atof() unneeded.
1906 1 1 already read UV.
1907 so there's no point in sv_2iuv_non_preserve() attempting
1908 to use atol, strtol, strtoul etc. */
1909 if (sv_2iuv_non_preserve (sv, numtype)
1910 >= IS_NUMBER_OVERFLOW_IV)
1914 #endif /* NV_PRESERVES_UV */
1917 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1919 if (SvTYPE(sv) < SVt_IV)
1920 /* Typically the caller expects that sv_any is not NULL now. */
1921 sv_upgrade(sv, SVt_IV);
1924 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1925 PTR2UV(sv),SvIVX(sv)));
1926 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1930 =for apidoc sv_2uv_flags
1932 Return the unsigned integer value of an SV, doing any necessary string
1933 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1934 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1940 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1944 if (SvGMAGICAL(sv)) {
1945 if (flags & SV_GMAGIC)
1950 return U_V(SvNVX(sv));
1951 if (SvPOKp(sv) && SvLEN(sv))
1954 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1955 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1961 if (SvTHINKFIRST(sv)) {
1964 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1965 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1966 return SvUV(tmpstr);
1967 return PTR2UV(SvRV(sv));
1970 sv_force_normal_flags(sv, 0);
1972 if (SvREADONLY(sv) && !SvOK(sv)) {
1973 if (ckWARN(WARN_UNINITIALIZED))
1983 return (UV)SvIVX(sv);
1987 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1988 * without also getting a cached IV/UV from it at the same time
1989 * (ie PV->NV conversion should detect loss of accuracy and cache
1990 * IV or UV at same time to avoid this. */
1991 /* IV-over-UV optimisation - choose to cache IV if possible */
1993 if (SvTYPE(sv) == SVt_NV)
1994 sv_upgrade(sv, SVt_PVNV);
1996 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1997 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1998 SvIV_set(sv, I_V(SvNVX(sv)));
1999 if (SvNVX(sv) == (NV) SvIVX(sv)
2000 #ifndef NV_PRESERVES_UV
2001 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2002 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2003 /* Don't flag it as "accurately an integer" if the number
2004 came from a (by definition imprecise) NV operation, and
2005 we're outside the range of NV integer precision */
2008 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2009 DEBUG_c(PerlIO_printf(Perl_debug_log,
2010 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2016 /* IV not precise. No need to convert from PV, as NV
2017 conversion would already have cached IV if it detected
2018 that PV->IV would be better than PV->NV->IV
2019 flags already correct - don't set public IOK. */
2020 DEBUG_c(PerlIO_printf(Perl_debug_log,
2021 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2026 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2027 but the cast (NV)IV_MIN rounds to a the value less (more
2028 negative) than IV_MIN which happens to be equal to SvNVX ??
2029 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2030 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2031 (NV)UVX == NVX are both true, but the values differ. :-(
2032 Hopefully for 2s complement IV_MIN is something like
2033 0x8000000000000000 which will be exact. NWC */
2036 SvUV_set(sv, U_V(SvNVX(sv)));
2038 (SvNVX(sv) == (NV) SvUVX(sv))
2039 #ifndef NV_PRESERVES_UV
2040 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2041 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2042 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2043 /* Don't flag it as "accurately an integer" if the number
2044 came from a (by definition imprecise) NV operation, and
2045 we're outside the range of NV integer precision */
2050 DEBUG_c(PerlIO_printf(Perl_debug_log,
2051 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2057 else if (SvPOKp(sv) && SvLEN(sv)) {
2059 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2061 /* We want to avoid a possible problem when we cache a UV which
2062 may be later translated to an NV, and the resulting NV is not
2063 the translation of the initial data.
2065 This means that if we cache such a UV, we need to cache the
2066 NV as well. Moreover, we trade speed for space, and do not
2067 cache the NV if not needed.
2070 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2071 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2072 == IS_NUMBER_IN_UV) {
2073 /* It's definitely an integer, only upgrade to PVIV */
2074 if (SvTYPE(sv) < SVt_PVIV)
2075 sv_upgrade(sv, SVt_PVIV);
2077 } else if (SvTYPE(sv) < SVt_PVNV)
2078 sv_upgrade(sv, SVt_PVNV);
2080 /* If NV preserves UV then we only use the UV value if we know that
2081 we aren't going to call atof() below. If NVs don't preserve UVs
2082 then the value returned may have more precision than atof() will
2083 return, even though it isn't accurate. */
2084 if ((numtype & (IS_NUMBER_IN_UV
2085 #ifdef NV_PRESERVES_UV
2088 )) == IS_NUMBER_IN_UV) {
2089 /* This won't turn off the public IOK flag if it was set above */
2090 (void)SvIOKp_on(sv);
2092 if (!(numtype & IS_NUMBER_NEG)) {
2094 if (value <= (UV)IV_MAX) {
2095 SvIV_set(sv, (IV)value);
2097 /* it didn't overflow, and it was positive. */
2098 SvUV_set(sv, value);
2102 /* 2s complement assumption */
2103 if (value <= (UV)IV_MIN) {
2104 SvIV_set(sv, -(IV)value);
2106 /* Too negative for an IV. This is a double upgrade, but
2107 I'm assuming it will be rare. */
2108 if (SvTYPE(sv) < SVt_PVNV)
2109 sv_upgrade(sv, SVt_PVNV);
2113 SvNV_set(sv, -(NV)value);
2114 SvIV_set(sv, IV_MIN);
2119 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2120 != IS_NUMBER_IN_UV) {
2121 /* It wasn't an integer, or it overflowed the UV. */
2122 SvNV_set(sv, Atof(SvPVX_const(sv)));
2124 if (! numtype && ckWARN(WARN_NUMERIC))
2127 #if defined(USE_LONG_DOUBLE)
2128 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2129 PTR2UV(sv), SvNVX(sv)));
2131 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2132 PTR2UV(sv), SvNVX(sv)));
2135 #ifdef NV_PRESERVES_UV
2136 (void)SvIOKp_on(sv);
2138 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2139 SvIV_set(sv, I_V(SvNVX(sv)));
2140 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2143 /* Integer is imprecise. NOK, IOKp */
2145 /* UV will not work better than IV */
2147 if (SvNVX(sv) > (NV)UV_MAX) {
2149 /* Integer is inaccurate. NOK, IOKp, is UV */
2150 SvUV_set(sv, UV_MAX);
2153 SvUV_set(sv, U_V(SvNVX(sv)));
2154 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2155 NV preservse UV so can do correct comparison. */
2156 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2160 /* Integer is imprecise. NOK, IOKp, is UV */
2165 #else /* NV_PRESERVES_UV */
2166 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2167 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2168 /* The UV slot will have been set from value returned by
2169 grok_number above. The NV slot has just been set using
2172 assert (SvIOKp(sv));
2174 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2175 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2176 /* Small enough to preserve all bits. */
2177 (void)SvIOKp_on(sv);
2179 SvIV_set(sv, I_V(SvNVX(sv)));
2180 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2182 /* Assumption: first non-preserved integer is < IV_MAX,
2183 this NV is in the preserved range, therefore: */
2184 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2186 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);
2189 sv_2iuv_non_preserve (sv, numtype);
2191 #endif /* NV_PRESERVES_UV */
2195 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2196 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2199 if (SvTYPE(sv) < SVt_IV)
2200 /* Typically the caller expects that sv_any is not NULL now. */
2201 sv_upgrade(sv, SVt_IV);
2205 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2206 PTR2UV(sv),SvUVX(sv)));
2207 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2213 Return the num value of an SV, doing any necessary string or integer
2214 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2221 Perl_sv_2nv(pTHX_ register SV *sv)
2225 if (SvGMAGICAL(sv)) {
2229 if (SvPOKp(sv) && SvLEN(sv)) {
2230 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2231 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2233 return Atof(SvPVX_const(sv));
2237 return (NV)SvUVX(sv);
2239 return (NV)SvIVX(sv);
2242 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2243 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2249 if (SvTHINKFIRST(sv)) {
2252 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2253 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2254 return SvNV(tmpstr);
2255 return PTR2NV(SvRV(sv));
2258 sv_force_normal_flags(sv, 0);
2260 if (SvREADONLY(sv) && !SvOK(sv)) {
2261 if (ckWARN(WARN_UNINITIALIZED))
2266 if (SvTYPE(sv) < SVt_NV) {
2267 if (SvTYPE(sv) == SVt_IV)
2268 sv_upgrade(sv, SVt_PVNV);
2270 sv_upgrade(sv, SVt_NV);
2271 #ifdef USE_LONG_DOUBLE
2273 STORE_NUMERIC_LOCAL_SET_STANDARD();
2274 PerlIO_printf(Perl_debug_log,
2275 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2276 PTR2UV(sv), SvNVX(sv));
2277 RESTORE_NUMERIC_LOCAL();
2281 STORE_NUMERIC_LOCAL_SET_STANDARD();
2282 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2283 PTR2UV(sv), SvNVX(sv));
2284 RESTORE_NUMERIC_LOCAL();
2288 else if (SvTYPE(sv) < SVt_PVNV)
2289 sv_upgrade(sv, SVt_PVNV);
2294 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2295 #ifdef NV_PRESERVES_UV
2298 /* Only set the public NV OK flag if this NV preserves the IV */
2299 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2300 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2301 : (SvIVX(sv) == I_V(SvNVX(sv))))
2307 else if (SvPOKp(sv) && SvLEN(sv)) {
2309 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2310 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2312 #ifdef NV_PRESERVES_UV
2313 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2314 == IS_NUMBER_IN_UV) {
2315 /* It's definitely an integer */
2316 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2318 SvNV_set(sv, Atof(SvPVX_const(sv)));
2321 SvNV_set(sv, Atof(SvPVX_const(sv)));
2322 /* Only set the public NV OK flag if this NV preserves the value in
2323 the PV at least as well as an IV/UV would.
2324 Not sure how to do this 100% reliably. */
2325 /* if that shift count is out of range then Configure's test is
2326 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2328 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2329 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2330 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2331 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2332 /* Can't use strtol etc to convert this string, so don't try.
2333 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2336 /* value has been set. It may not be precise. */
2337 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2338 /* 2s complement assumption for (UV)IV_MIN */
2339 SvNOK_on(sv); /* Integer is too negative. */
2344 if (numtype & IS_NUMBER_NEG) {
2345 SvIV_set(sv, -(IV)value);
2346 } else if (value <= (UV)IV_MAX) {
2347 SvIV_set(sv, (IV)value);
2349 SvUV_set(sv, value);
2353 if (numtype & IS_NUMBER_NOT_INT) {
2354 /* I believe that even if the original PV had decimals,
2355 they are lost beyond the limit of the FP precision.
2356 However, neither is canonical, so both only get p
2357 flags. NWC, 2000/11/25 */
2358 /* Both already have p flags, so do nothing */
2360 const NV nv = SvNVX(sv);
2361 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2362 if (SvIVX(sv) == I_V(nv)) {
2367 /* It had no "." so it must be integer. */
2370 /* between IV_MAX and NV(UV_MAX).
2371 Could be slightly > UV_MAX */
2373 if (numtype & IS_NUMBER_NOT_INT) {
2374 /* UV and NV both imprecise. */
2376 const UV nv_as_uv = U_V(nv);
2378 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2389 #endif /* NV_PRESERVES_UV */
2392 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2394 if (SvTYPE(sv) < SVt_NV)
2395 /* Typically the caller expects that sv_any is not NULL now. */
2396 /* XXX Ilya implies that this is a bug in callers that assume this
2397 and ideally should be fixed. */
2398 sv_upgrade(sv, SVt_NV);
2401 #if defined(USE_LONG_DOUBLE)
2403 STORE_NUMERIC_LOCAL_SET_STANDARD();
2404 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2405 PTR2UV(sv), SvNVX(sv));
2406 RESTORE_NUMERIC_LOCAL();
2410 STORE_NUMERIC_LOCAL_SET_STANDARD();
2411 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2412 PTR2UV(sv), SvNVX(sv));
2413 RESTORE_NUMERIC_LOCAL();
2419 /* asIV(): extract an integer from the string value of an SV.
2420 * Caller must validate PVX */
2423 S_asIV(pTHX_ SV *sv)
2426 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2428 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2429 == IS_NUMBER_IN_UV) {
2430 /* It's definitely an integer */
2431 if (numtype & IS_NUMBER_NEG) {
2432 if (value < (UV)IV_MIN)
2435 if (value < (UV)IV_MAX)
2440 if (ckWARN(WARN_NUMERIC))
2443 return I_V(Atof(SvPVX_const(sv)));
2446 /* asUV(): extract an unsigned integer from the string value of an SV
2447 * Caller must validate PVX */
2450 S_asUV(pTHX_ SV *sv)
2453 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2455 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2456 == IS_NUMBER_IN_UV) {
2457 /* It's definitely an integer */
2458 if (!(numtype & IS_NUMBER_NEG))
2462 if (ckWARN(WARN_NUMERIC))
2465 return U_V(Atof(SvPVX_const(sv)));
2468 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2469 * UV as a string towards the end of buf, and return pointers to start and
2472 * We assume that buf is at least TYPE_CHARS(UV) long.
2476 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2478 char *ptr = buf + TYPE_CHARS(UV);
2479 char * const ebuf = ptr;
2492 *--ptr = '0' + (char)(uv % 10);
2501 =for apidoc sv_2pv_flags
2503 Returns a pointer to the string value of an SV, and sets *lp to its length.
2504 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2506 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2507 usually end up here too.
2513 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2518 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2519 char *tmpbuf = tbuf;
2520 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
2527 if (SvGMAGICAL(sv)) {
2528 if (flags & SV_GMAGIC)
2533 if (flags & SV_MUTABLE_RETURN)
2534 return SvPVX_mutable(sv);
2535 if (flags & SV_CONST_RETURN)
2536 return (char *)SvPVX_const(sv);
2540 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2541 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2543 goto tokensave_has_len;
2546 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2551 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2552 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2560 if (SvTHINKFIRST(sv)) {
2563 register const char *typestr;
2564 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2565 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2567 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2570 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2571 if (flags & SV_CONST_RETURN) {
2572 pv = (char *) SvPVX_const(tmpstr);
2574 pv = (flags & SV_MUTABLE_RETURN)
2575 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2578 *lp = SvCUR(tmpstr);
2580 pv = sv_2pv_flags(tmpstr, lp, flags);
2591 typestr = "NULLREF";
2595 switch (SvTYPE(sv)) {
2597 if ( ((SvFLAGS(sv) &
2598 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2599 == (SVs_OBJECT|SVs_SMG))
2600 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2601 const regexp *re = (regexp *)mg->mg_obj;
2604 const char *fptr = "msix";
2609 char need_newline = 0;
2610 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2612 while((ch = *fptr++)) {
2614 reflags[left++] = ch;
2617 reflags[right--] = ch;
2622 reflags[left] = '-';
2626 mg->mg_len = re->prelen + 4 + left;
2628 * If /x was used, we have to worry about a regex
2629 * ending with a comment later being embedded
2630 * within another regex. If so, we don't want this
2631 * regex's "commentization" to leak out to the
2632 * right part of the enclosing regex, we must cap
2633 * it with a newline.
2635 * So, if /x was used, we scan backwards from the
2636 * end of the regex. If we find a '#' before we
2637 * find a newline, we need to add a newline
2638 * ourself. If we find a '\n' first (or if we
2639 * don't find '#' or '\n'), we don't need to add
2640 * anything. -jfriedl
2642 if (PMf_EXTENDED & re->reganch)
2644 const char *endptr = re->precomp + re->prelen;
2645 while (endptr >= re->precomp)
2647 const char c = *(endptr--);
2649 break; /* don't need another */
2651 /* we end while in a comment, so we
2653 mg->mg_len++; /* save space for it */
2654 need_newline = 1; /* note to add it */
2660 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2661 Copy("(?", mg->mg_ptr, 2, char);
2662 Copy(reflags, mg->mg_ptr+2, left, char);
2663 Copy(":", mg->mg_ptr+left+2, 1, char);
2664 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2666 mg->mg_ptr[mg->mg_len - 2] = '\n';
2667 mg->mg_ptr[mg->mg_len - 1] = ')';
2668 mg->mg_ptr[mg->mg_len] = 0;
2670 PL_reginterp_cnt += re->program[0].next_off;
2672 if (re->reganch & ROPT_UTF8)
2688 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
2689 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
2690 /* tied lvalues should appear to be
2691 * scalars for backwards compatitbility */
2692 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
2693 ? "SCALAR" : "LVALUE"; break;
2694 case SVt_PVAV: typestr = "ARRAY"; break;
2695 case SVt_PVHV: typestr = "HASH"; break;
2696 case SVt_PVCV: typestr = "CODE"; break;
2697 case SVt_PVGV: typestr = "GLOB"; break;
2698 case SVt_PVFM: typestr = "FORMAT"; break;
2699 case SVt_PVIO: typestr = "IO"; break;
2700 default: typestr = "UNKNOWN"; break;
2704 const char * const name = HvNAME_get(SvSTASH(sv));
2705 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2706 name ? name : "__ANON__" , typestr, PTR2UV(sv));
2709 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
2713 *lp = strlen(typestr);
2714 return (char *)typestr;
2716 if (SvREADONLY(sv) && !SvOK(sv)) {
2717 if (ckWARN(WARN_UNINITIALIZED))
2724 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2725 /* I'm assuming that if both IV and NV are equally valid then
2726 converting the IV is going to be more efficient */
2727 const U32 isIOK = SvIOK(sv);
2728 const U32 isUIOK = SvIsUV(sv);
2729 char buf[TYPE_CHARS(UV)];
2732 if (SvTYPE(sv) < SVt_PVIV)
2733 sv_upgrade(sv, SVt_PVIV);
2735 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2737 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2738 /* inlined from sv_setpvn */
2739 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2740 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2741 SvCUR_set(sv, ebuf - ptr);
2751 else if (SvNOKp(sv)) {
2752 if (SvTYPE(sv) < SVt_PVNV)
2753 sv_upgrade(sv, SVt_PVNV);
2754 /* The +20 is pure guesswork. Configure test needed. --jhi */
2755 s = SvGROW_mutable(sv, NV_DIG + 20);
2756 olderrno = errno; /* some Xenix systems wipe out errno here */
2758 if (SvNVX(sv) == 0.0)
2759 (void)strcpy(s,"0");
2763 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2766 #ifdef FIXNEGATIVEZERO
2767 if (*s == '-' && s[1] == '0' && !s[2])
2777 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2781 if (SvTYPE(sv) < SVt_PV)
2782 /* Typically the caller expects that sv_any is not NULL now. */
2783 sv_upgrade(sv, SVt_PV);
2787 const STRLEN len = s - SvPVX_const(sv);
2793 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2794 PTR2UV(sv),SvPVX_const(sv)));
2795 if (flags & SV_CONST_RETURN)
2796 return (char *)SvPVX_const(sv);
2797 if (flags & SV_MUTABLE_RETURN)
2798 return SvPVX_mutable(sv);
2802 len = strlen(tmpbuf);
2805 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2806 /* Sneaky stuff here */
2810 tsv = newSVpvn(tmpbuf, len);
2819 #ifdef FIXNEGATIVEZERO
2820 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2826 SvUPGRADE(sv, SVt_PV);
2829 s = SvGROW_mutable(sv, len + 1);
2832 return memcpy(s, tmpbuf, len + 1);
2837 =for apidoc sv_copypv
2839 Copies a stringified representation of the source SV into the
2840 destination SV. Automatically performs any necessary mg_get and
2841 coercion of numeric values into strings. Guaranteed to preserve
2842 UTF-8 flag even from overloaded objects. Similar in nature to
2843 sv_2pv[_flags] but operates directly on an SV instead of just the
2844 string. Mostly uses sv_2pv_flags to do its work, except when that
2845 would lose the UTF-8'ness of the PV.
2851 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2854 const char * const s = SvPV_const(ssv,len);
2855 sv_setpvn(dsv,s,len);
2863 =for apidoc sv_2pvbyte
2865 Return a pointer to the byte-encoded representation of the SV, and set *lp
2866 to its length. May cause the SV to be downgraded from UTF-8 as a
2869 Usually accessed via the C<SvPVbyte> macro.
2875 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2877 sv_utf8_downgrade(sv,0);
2878 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2882 =for apidoc sv_2pvutf8
2884 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2885 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2887 Usually accessed via the C<SvPVutf8> macro.
2893 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2895 sv_utf8_upgrade(sv);
2896 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2901 =for apidoc sv_2bool
2903 This function is only called on magical items, and is only used by
2904 sv_true() or its macro equivalent.
2910 Perl_sv_2bool(pTHX_ register SV *sv)
2918 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2919 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2920 return (bool)SvTRUE(tmpsv);
2921 return SvRV(sv) != 0;
2924 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2926 (*sv->sv_u.svu_pv > '0' ||
2927 Xpvtmp->xpv_cur > 1 ||
2928 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2935 return SvIVX(sv) != 0;
2938 return SvNVX(sv) != 0.0;
2946 =for apidoc sv_utf8_upgrade
2948 Converts the PV of an SV to its UTF-8-encoded form.
2949 Forces the SV to string form if it is not already.
2950 Always sets the SvUTF8 flag to avoid future validity checks even
2951 if all the bytes have hibit clear.
2953 This is not as a general purpose byte encoding to Unicode interface:
2954 use the Encode extension for that.
2956 =for apidoc sv_utf8_upgrade_flags
2958 Converts the PV of an SV to its UTF-8-encoded form.
2959 Forces the SV to string form if it is not already.
2960 Always sets the SvUTF8 flag to avoid future validity checks even
2961 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2962 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2963 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2965 This is not as a general purpose byte encoding to Unicode interface:
2966 use the Encode extension for that.
2972 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2974 if (sv == &PL_sv_undef)
2978 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2979 (void) sv_2pv_flags(sv,&len, flags);
2983 (void) SvPV_force(sv,len);
2992 sv_force_normal_flags(sv, 0);
2995 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2996 sv_recode_to_utf8(sv, PL_encoding);
2997 else { /* Assume Latin-1/EBCDIC */
2998 /* This function could be much more efficient if we
2999 * had a FLAG in SVs to signal if there are any hibit
3000 * chars in the PV. Given that there isn't such a flag
3001 * make the loop as fast as possible. */
3002 const U8 *s = (U8 *) SvPVX_const(sv);
3003 const U8 * const e = (U8 *) SvEND(sv);
3009 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3013 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3014 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3016 SvPV_free(sv); /* No longer using what was there before. */
3018 SvPV_set(sv, (char*)recoded);
3019 SvCUR_set(sv, len - 1);
3020 SvLEN_set(sv, len); /* No longer know the real size. */
3022 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3029 =for apidoc sv_utf8_downgrade
3031 Attempts to convert the PV of an SV from characters to bytes.
3032 If the PV contains a character beyond byte, this conversion will fail;
3033 in this case, either returns false or, if C<fail_ok> is not
3036 This is not as a general purpose Unicode to byte encoding interface:
3037 use the Encode extension for that.
3043 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3045 if (SvPOKp(sv) && SvUTF8(sv)) {
3051 sv_force_normal_flags(sv, 0);
3053 s = (U8 *) SvPV(sv, len);
3054 if (!utf8_to_bytes(s, &len)) {
3059 Perl_croak(aTHX_ "Wide character in %s",
3062 Perl_croak(aTHX_ "Wide character");
3073 =for apidoc sv_utf8_encode
3075 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3076 flag off so that it looks like octets again.
3082 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3084 (void) sv_utf8_upgrade(sv);
3086 sv_force_normal_flags(sv, 0);
3088 if (SvREADONLY(sv)) {
3089 Perl_croak(aTHX_ PL_no_modify);
3095 =for apidoc sv_utf8_decode
3097 If the PV of the SV is an octet sequence in UTF-8
3098 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3099 so that it looks like a character. If the PV contains only single-byte
3100 characters, the C<SvUTF8> flag stays being off.
3101 Scans PV for validity and returns false if the PV is invalid UTF-8.
3107 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3113 /* The octets may have got themselves encoded - get them back as
3116 if (!sv_utf8_downgrade(sv, TRUE))
3119 /* it is actually just a matter of turning the utf8 flag on, but
3120 * we want to make sure everything inside is valid utf8 first.
3122 c = (const U8 *) SvPVX_const(sv);
3123 if (!is_utf8_string(c, SvCUR(sv)+1))
3125 e = (const U8 *) SvEND(sv);
3128 if (!UTF8_IS_INVARIANT(ch)) {
3138 =for apidoc sv_setsv
3140 Copies the contents of the source SV C<ssv> into the destination SV
3141 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3142 function if the source SV needs to be reused. Does not handle 'set' magic.
3143 Loosely speaking, it performs a copy-by-value, obliterating any previous
3144 content of the destination.
3146 You probably want to use one of the assortment of wrappers, such as
3147 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3148 C<SvSetMagicSV_nosteal>.
3150 =for apidoc sv_setsv_flags
3152 Copies the contents of the source SV C<ssv> into the destination SV
3153 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3154 function if the source SV needs to be reused. Does not handle 'set' magic.
3155 Loosely speaking, it performs a copy-by-value, obliterating any previous
3156 content of the destination.
3157 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3158 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3159 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3160 and C<sv_setsv_nomg> are implemented in terms of this function.
3162 You probably want to use one of the assortment of wrappers, such as
3163 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3164 C<SvSetMagicSV_nosteal>.
3166 This is the primary function for copying scalars, and most other
3167 copy-ish functions and macros use this underneath.
3173 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3175 register U32 sflags;
3181 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3183 sstr = &PL_sv_undef;
3184 stype = SvTYPE(sstr);
3185 dtype = SvTYPE(dstr);
3190 /* need to nuke the magic */
3192 SvRMAGICAL_off(dstr);
3195 /* There's a lot of redundancy below but we're going for speed here */
3200 if (dtype != SVt_PVGV) {
3201 (void)SvOK_off(dstr);
3209 sv_upgrade(dstr, SVt_IV);
3212 sv_upgrade(dstr, SVt_PVNV);
3216 sv_upgrade(dstr, SVt_PVIV);
3219 (void)SvIOK_only(dstr);
3220 SvIV_set(dstr, SvIVX(sstr));
3223 if (SvTAINTED(sstr))
3234 sv_upgrade(dstr, SVt_NV);
3239 sv_upgrade(dstr, SVt_PVNV);
3242 SvNV_set(dstr, SvNVX(sstr));
3243 (void)SvNOK_only(dstr);
3244 if (SvTAINTED(sstr))
3252 sv_upgrade(dstr, SVt_RV);
3253 else if (dtype == SVt_PVGV &&
3254 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3257 if (GvIMPORTED(dstr) != GVf_IMPORTED
3258 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3260 GvIMPORTED_on(dstr);
3269 #ifdef PERL_OLD_COPY_ON_WRITE
3270 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3271 if (dtype < SVt_PVIV)
3272 sv_upgrade(dstr, SVt_PVIV);
3279 sv_upgrade(dstr, SVt_PV);
3282 if (dtype < SVt_PVIV)
3283 sv_upgrade(dstr, SVt_PVIV);
3286 if (dtype < SVt_PVNV)
3287 sv_upgrade(dstr, SVt_PVNV);
3294 const char * const type = sv_reftype(sstr,0);
3296 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3298 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3303 if (dtype <= SVt_PVGV) {
3305 if (dtype != SVt_PVGV) {
3306 const char * const name = GvNAME(sstr);
3307 const STRLEN len = GvNAMELEN(sstr);
3308 /* don't upgrade SVt_PVLV: it can hold a glob */
3309 if (dtype != SVt_PVLV)
3310 sv_upgrade(dstr, SVt_PVGV);
3311 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3312 GvSTASH(dstr) = GvSTASH(sstr);
3314 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3315 GvNAME(dstr) = savepvn(name, len);
3316 GvNAMELEN(dstr) = len;
3317 SvFAKE_on(dstr); /* can coerce to non-glob */
3320 #ifdef GV_UNIQUE_CHECK
3321 if (GvUNIQUE((GV*)dstr)) {
3322 Perl_croak(aTHX_ PL_no_modify);
3326 (void)SvOK_off(dstr);
3327 GvINTRO_off(dstr); /* one-shot flag */
3329 GvGP(dstr) = gp_ref(GvGP(sstr));
3330 if (SvTAINTED(sstr))
3332 if (GvIMPORTED(dstr) != GVf_IMPORTED
3333 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3335 GvIMPORTED_on(dstr);
3343 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3345 if ((int)SvTYPE(sstr) != stype) {
3346 stype = SvTYPE(sstr);
3347 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3351 if (stype == SVt_PVLV)
3352 SvUPGRADE(dstr, SVt_PVNV);
3354 SvUPGRADE(dstr, (U32)stype);
3357 sflags = SvFLAGS(sstr);
3359 if (sflags & SVf_ROK) {
3360 if (dtype >= SVt_PV) {
3361 if (dtype == SVt_PVGV) {
3362 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3364 const int intro = GvINTRO(dstr);
3366 #ifdef GV_UNIQUE_CHECK
3367 if (GvUNIQUE((GV*)dstr)) {
3368 Perl_croak(aTHX_ PL_no_modify);
3373 GvINTRO_off(dstr); /* one-shot flag */
3374 GvLINE(dstr) = CopLINE(PL_curcop);
3375 GvEGV(dstr) = (GV*)dstr;
3378 switch (SvTYPE(sref)) {
3381 SAVEGENERICSV(GvAV(dstr));
3383 dref = (SV*)GvAV(dstr);
3384 GvAV(dstr) = (AV*)sref;
3385 if (!GvIMPORTED_AV(dstr)
3386 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3388 GvIMPORTED_AV_on(dstr);
3393 SAVEGENERICSV(GvHV(dstr));
3395 dref = (SV*)GvHV(dstr);
3396 GvHV(dstr) = (HV*)sref;
3397 if (!GvIMPORTED_HV(dstr)
3398 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3400 GvIMPORTED_HV_on(dstr);
3405 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3406 SvREFCNT_dec(GvCV(dstr));
3407 GvCV(dstr) = Nullcv;
3408 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3409 PL_sub_generation++;
3411 SAVEGENERICSV(GvCV(dstr));
3414 dref = (SV*)GvCV(dstr);
3415 if (GvCV(dstr) != (CV*)sref) {
3416 CV* const cv = GvCV(dstr);
3418 if (!GvCVGEN((GV*)dstr) &&
3419 (CvROOT(cv) || CvXSUB(cv)))
3421 /* Redefining a sub - warning is mandatory if
3422 it was a const and its value changed. */
3423 if (ckWARN(WARN_REDEFINE)
3425 && (!CvCONST((CV*)sref)
3426 || sv_cmp(cv_const_sv(cv),
3427 cv_const_sv((CV*)sref)))))
3429 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3431 ? "Constant subroutine %s::%s redefined"
3432 : "Subroutine %s::%s redefined",
3433 HvNAME_get(GvSTASH((GV*)dstr)),
3434 GvENAME((GV*)dstr));
3438 cv_ckproto(cv, (GV*)dstr,
3440 ? SvPVX_const(sref) : Nullch);
3442 GvCV(dstr) = (CV*)sref;
3443 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3444 GvASSUMECV_on(dstr);
3445 PL_sub_generation++;
3447 if (!GvIMPORTED_CV(dstr)
3448 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3450 GvIMPORTED_CV_on(dstr);
3455 SAVEGENERICSV(GvIOp(dstr));
3457 dref = (SV*)GvIOp(dstr);
3458 GvIOp(dstr) = (IO*)sref;
3462 SAVEGENERICSV(GvFORM(dstr));
3464 dref = (SV*)GvFORM(dstr);
3465 GvFORM(dstr) = (CV*)sref;
3469 SAVEGENERICSV(GvSV(dstr));
3471 dref = (SV*)GvSV(dstr);
3473 if (!GvIMPORTED_SV(dstr)
3474 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3476 GvIMPORTED_SV_on(dstr);
3482 if (SvTAINTED(sstr))
3486 if (SvPVX_const(dstr)) {
3492 (void)SvOK_off(dstr);
3493 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3495 if (sflags & SVp_NOK) {
3497 /* Only set the public OK flag if the source has public OK. */
3498 if (sflags & SVf_NOK)
3499 SvFLAGS(dstr) |= SVf_NOK;
3500 SvNV_set(dstr, SvNVX(sstr));
3502 if (sflags & SVp_IOK) {
3503 (void)SvIOKp_on(dstr);
3504 if (sflags & SVf_IOK)
3505 SvFLAGS(dstr) |= SVf_IOK;
3506 if (sflags & SVf_IVisUV)
3508 SvIV_set(dstr, SvIVX(sstr));
3510 if (SvAMAGIC(sstr)) {
3514 else if (sflags & SVp_POK) {
3518 * Check to see if we can just swipe the string. If so, it's a
3519 * possible small lose on short strings, but a big win on long ones.
3520 * It might even be a win on short strings if SvPVX_const(dstr)
3521 * has to be allocated and SvPVX_const(sstr) has to be freed.
3524 /* Whichever path we take through the next code, we want this true,
3525 and doing it now facilitates the COW check. */
3526 (void)SvPOK_only(dstr);
3529 /* We're not already COW */
3530 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3531 #ifndef PERL_OLD_COPY_ON_WRITE
3532 /* or we are, but dstr isn't a suitable target. */
3533 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3538 (sflags & SVs_TEMP) && /* slated for free anyway? */
3539 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3540 (!(flags & SV_NOSTEAL)) &&
3541 /* and we're allowed to steal temps */
3542 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3543 SvLEN(sstr) && /* and really is a string */
3544 /* and won't be needed again, potentially */
3545 !(PL_op && PL_op->op_type == OP_AASSIGN))
3546 #ifdef PERL_OLD_COPY_ON_WRITE
3547 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3548 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3549 && SvTYPE(sstr) >= SVt_PVIV)
3552 /* Failed the swipe test, and it's not a shared hash key either.
3553 Have to copy the string. */
3554 STRLEN len = SvCUR(sstr);
3555 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3556 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3557 SvCUR_set(dstr, len);
3558 *SvEND(dstr) = '\0';
3560 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3562 /* Either it's a shared hash key, or it's suitable for
3563 copy-on-write or we can swipe the string. */
3565 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3569 #ifdef PERL_OLD_COPY_ON_WRITE
3571 /* I believe I should acquire a global SV mutex if
3572 it's a COW sv (not a shared hash key) to stop
3573 it going un copy-on-write.
3574 If the source SV has gone un copy on write between up there
3575 and down here, then (assert() that) it is of the correct
3576 form to make it copy on write again */
3577 if ((sflags & (SVf_FAKE | SVf_READONLY))
3578 != (SVf_FAKE | SVf_READONLY)) {
3579 SvREADONLY_on(sstr);
3581 /* Make the source SV into a loop of 1.
3582 (about to become 2) */
3583 SV_COW_NEXT_SV_SET(sstr, sstr);
3587 /* Initial code is common. */
3588 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3593 /* making another shared SV. */
3594 STRLEN cur = SvCUR(sstr);
3595 STRLEN len = SvLEN(sstr);
3596 #ifdef PERL_OLD_COPY_ON_WRITE
3598 assert (SvTYPE(dstr) >= SVt_PVIV);
3599 /* SvIsCOW_normal */
3600 /* splice us in between source and next-after-source. */
3601 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3602 SV_COW_NEXT_SV_SET(sstr, dstr);
3603 SvPV_set(dstr, SvPVX_mutable(sstr));
3607 /* SvIsCOW_shared_hash */
3608 DEBUG_C(PerlIO_printf(Perl_debug_log,
3609 "Copy on write: Sharing hash\n"));
3611 assert (SvTYPE(dstr) >= SVt_PV);
3613 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3615 SvLEN_set(dstr, len);
3616 SvCUR_set(dstr, cur);
3617 SvREADONLY_on(dstr);
3619 /* Relesase a global SV mutex. */
3622 { /* Passes the swipe test. */
3623 SvPV_set(dstr, SvPVX_mutable(sstr));
3624 SvLEN_set(dstr, SvLEN(sstr));
3625 SvCUR_set(dstr, SvCUR(sstr));
3628 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3629 SvPV_set(sstr, Nullch);
3635 if (sflags & SVf_UTF8)
3637 if (sflags & SVp_NOK) {
3639 if (sflags & SVf_NOK)
3640 SvFLAGS(dstr) |= SVf_NOK;
3641 SvNV_set(dstr, SvNVX(sstr));
3643 if (sflags & SVp_IOK) {
3644 (void)SvIOKp_on(dstr);
3645 if (sflags & SVf_IOK)
3646 SvFLAGS(dstr) |= SVf_IOK;
3647 if (sflags & SVf_IVisUV)
3649 SvIV_set(dstr, SvIVX(sstr));
3652 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3653 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3654 smg->mg_ptr, smg->mg_len);
3655 SvRMAGICAL_on(dstr);
3658 else if (sflags & SVp_IOK) {
3659 if (sflags & SVf_IOK)
3660 (void)SvIOK_only(dstr);
3662 (void)SvOK_off(dstr);
3663 (void)SvIOKp_on(dstr);
3665 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3666 if (sflags & SVf_IVisUV)
3668 SvIV_set(dstr, SvIVX(sstr));
3669 if (sflags & SVp_NOK) {
3670 if (sflags & SVf_NOK)
3671 (void)SvNOK_on(dstr);
3673 (void)SvNOKp_on(dstr);
3674 SvNV_set(dstr, SvNVX(sstr));
3677 else if (sflags & SVp_NOK) {
3678 if (sflags & SVf_NOK)
3679 (void)SvNOK_only(dstr);
3681 (void)SvOK_off(dstr);
3684 SvNV_set(dstr, SvNVX(sstr));
3687 if (dtype == SVt_PVGV) {
3688 if (ckWARN(WARN_MISC))
3689 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3692 (void)SvOK_off(dstr);
3694 if (SvTAINTED(sstr))
3699 =for apidoc sv_setsv_mg
3701 Like C<sv_setsv>, but also handles 'set' magic.
3707 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3709 sv_setsv(dstr,sstr);
3713 #ifdef PERL_OLD_COPY_ON_WRITE
3715 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3717 STRLEN cur = SvCUR(sstr);
3718 STRLEN len = SvLEN(sstr);
3719 register char *new_pv;
3722 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3730 if (SvTHINKFIRST(dstr))
3731 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3732 else if (SvPVX_const(dstr))
3733 Safefree(SvPVX_const(dstr));
3737 SvUPGRADE(dstr, SVt_PVIV);
3739 assert (SvPOK(sstr));
3740 assert (SvPOKp(sstr));
3741 assert (!SvIOK(sstr));
3742 assert (!SvIOKp(sstr));
3743 assert (!SvNOK(sstr));
3744 assert (!SvNOKp(sstr));
3746 if (SvIsCOW(sstr)) {
3748 if (SvLEN(sstr) == 0) {
3749 /* source is a COW shared hash key. */
3750 DEBUG_C(PerlIO_printf(Perl_debug_log,
3751 "Fast copy on write: Sharing hash\n"));
3752 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3755 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3757 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3758 SvUPGRADE(sstr, SVt_PVIV);
3759 SvREADONLY_on(sstr);
3761 DEBUG_C(PerlIO_printf(Perl_debug_log,
3762 "Fast copy on write: Converting sstr to COW\n"));
3763 SV_COW_NEXT_SV_SET(dstr, sstr);
3765 SV_COW_NEXT_SV_SET(sstr, dstr);
3766 new_pv = SvPVX_mutable(sstr);
3769 SvPV_set(dstr, new_pv);
3770 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3773 SvLEN_set(dstr, len);
3774 SvCUR_set(dstr, cur);
3783 =for apidoc sv_setpvn
3785 Copies a string into an SV. The C<len> parameter indicates the number of
3786 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3787 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3793 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3795 register char *dptr;
3797 SV_CHECK_THINKFIRST_COW_DROP(sv);
3803 /* len is STRLEN which is unsigned, need to copy to signed */
3806 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3808 SvUPGRADE(sv, SVt_PV);
3810 dptr = SvGROW(sv, len + 1);
3811 Move(ptr,dptr,len,char);
3814 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3819 =for apidoc sv_setpvn_mg
3821 Like C<sv_setpvn>, but also handles 'set' magic.
3827 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3829 sv_setpvn(sv,ptr,len);
3834 =for apidoc sv_setpv
3836 Copies a string into an SV. The string must be null-terminated. Does not
3837 handle 'set' magic. See C<sv_setpv_mg>.
3843 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3845 register STRLEN len;
3847 SV_CHECK_THINKFIRST_COW_DROP(sv);
3853 SvUPGRADE(sv, SVt_PV);
3855 SvGROW(sv, len + 1);
3856 Move(ptr,SvPVX(sv),len+1,char);
3858 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3863 =for apidoc sv_setpv_mg
3865 Like C<sv_setpv>, but also handles 'set' magic.
3871 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3878 =for apidoc sv_usepvn
3880 Tells an SV to use C<ptr> to find its string value. Normally the string is
3881 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3882 The C<ptr> should point to memory that was allocated by C<malloc>. The
3883 string length, C<len>, must be supplied. This function will realloc the
3884 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3885 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3886 See C<sv_usepvn_mg>.
3892 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3895 SV_CHECK_THINKFIRST_COW_DROP(sv);
3896 SvUPGRADE(sv, SVt_PV);
3901 if (SvPVX_const(sv))
3904 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3905 ptr = saferealloc (ptr, allocate);
3908 SvLEN_set(sv, allocate);
3910 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3915 =for apidoc sv_usepvn_mg
3917 Like C<sv_usepvn>, but also handles 'set' magic.
3923 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3925 sv_usepvn(sv,ptr,len);
3929 #ifdef PERL_OLD_COPY_ON_WRITE
3930 /* Need to do this *after* making the SV normal, as we need the buffer
3931 pointer to remain valid until after we've copied it. If we let go too early,
3932 another thread could invalidate it by unsharing last of the same hash key
3933 (which it can do by means other than releasing copy-on-write Svs)
3934 or by changing the other copy-on-write SVs in the loop. */
3936 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3938 if (len) { /* this SV was SvIsCOW_normal(sv) */
3939 /* we need to find the SV pointing to us. */
3940 SV * const current = SV_COW_NEXT_SV(after);
3942 if (current == sv) {
3943 /* The SV we point to points back to us (there were only two of us
3945 Hence other SV is no longer copy on write either. */
3947 SvREADONLY_off(after);
3949 /* We need to follow the pointers around the loop. */
3951 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3954 /* don't loop forever if the structure is bust, and we have
3955 a pointer into a closed loop. */
3956 assert (current != after);
3957 assert (SvPVX_const(current) == pvx);
3959 /* Make the SV before us point to the SV after us. */
3960 SV_COW_NEXT_SV_SET(current, after);
3963 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3968 Perl_sv_release_IVX(pTHX_ register SV *sv)
3971 sv_force_normal_flags(sv, 0);
3977 =for apidoc sv_force_normal_flags
3979 Undo various types of fakery on an SV: if the PV is a shared string, make
3980 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3981 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3982 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3983 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3984 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3985 set to some other value.) In addition, the C<flags> parameter gets passed to
3986 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3987 with flags set to 0.
3993 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3995 #ifdef PERL_OLD_COPY_ON_WRITE
3996 if (SvREADONLY(sv)) {
3997 /* At this point I believe I should acquire a global SV mutex. */
3999 const char * const pvx = SvPVX_const(sv);
4000 const STRLEN len = SvLEN(sv);
4001 const STRLEN cur = SvCUR(sv);
4002 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4004 PerlIO_printf(Perl_debug_log,
4005 "Copy on write: Force normal %ld\n",
4011 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4012 SvPV_set(sv, (char*)0);
4014 if (flags & SV_COW_DROP_PV) {
4015 /* OK, so we don't need to copy our buffer. */
4018 SvGROW(sv, cur + 1);
4019 Move(pvx,SvPVX(sv),cur,char);
4023 sv_release_COW(sv, pvx, len, next);
4028 else if (IN_PERL_RUNTIME)
4029 Perl_croak(aTHX_ PL_no_modify);
4030 /* At this point I believe that I can drop the global SV mutex. */
4033 if (SvREADONLY(sv)) {
4035 const char * const pvx = SvPVX_const(sv);
4036 const STRLEN len = SvCUR(sv);
4039 SvPV_set(sv, Nullch);
4041 SvGROW(sv, len + 1);
4042 Move(pvx,SvPVX(sv),len,char);
4044 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4046 else if (IN_PERL_RUNTIME)
4047 Perl_croak(aTHX_ PL_no_modify);
4051 sv_unref_flags(sv, flags);
4052 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4059 Efficient removal of characters from the beginning of the string buffer.
4060 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4061 the string buffer. The C<ptr> becomes the first character of the adjusted
4062 string. Uses the "OOK hack".
4063 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4064 refer to the same chunk of data.
4070 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4072 register STRLEN delta;
4073 if (!ptr || !SvPOKp(sv))
4075 delta = ptr - SvPVX_const(sv);
4076 SV_CHECK_THINKFIRST(sv);
4077 if (SvTYPE(sv) < SVt_PVIV)
4078 sv_upgrade(sv,SVt_PVIV);
4081 if (!SvLEN(sv)) { /* make copy of shared string */
4082 const char *pvx = SvPVX_const(sv);
4083 const STRLEN len = SvCUR(sv);
4084 SvGROW(sv, len + 1);
4085 Move(pvx,SvPVX(sv),len,char);
4089 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4090 and we do that anyway inside the SvNIOK_off
4092 SvFLAGS(sv) |= SVf_OOK;
4095 SvLEN_set(sv, SvLEN(sv) - delta);
4096 SvCUR_set(sv, SvCUR(sv) - delta);
4097 SvPV_set(sv, SvPVX(sv) + delta);
4098 SvIV_set(sv, SvIVX(sv) + delta);
4102 =for apidoc sv_catpvn
4104 Concatenates the string onto the end of the string which is in the SV. The
4105 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4106 status set, then the bytes appended should be valid UTF-8.
4107 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4109 =for apidoc sv_catpvn_flags
4111 Concatenates the string onto the end of the string which is in the SV. The
4112 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4113 status set, then the bytes appended should be valid UTF-8.
4114 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4115 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4116 in terms of this function.
4122 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4125 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4127 SvGROW(dsv, dlen + slen + 1);
4129 sstr = SvPVX_const(dsv);
4130 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4131 SvCUR_set(dsv, SvCUR(dsv) + slen);
4133 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4135 if (flags & SV_SMAGIC)
4140 =for apidoc sv_catsv
4142 Concatenates the string from SV C<ssv> onto the end of the string in
4143 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4144 not 'set' magic. See C<sv_catsv_mg>.
4146 =for apidoc sv_catsv_flags
4148 Concatenates the string from SV C<ssv> onto the end of the string in
4149 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4150 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4151 and C<sv_catsv_nomg> are implemented in terms of this function.
4156 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4161 if ((spv = SvPV_const(ssv, slen))) {
4162 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4163 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4164 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4165 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4166 dsv->sv_flags doesn't have that bit set.
4167 Andy Dougherty 12 Oct 2001
4169 const I32 sutf8 = DO_UTF8(ssv);
4172 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4174 dutf8 = DO_UTF8(dsv);
4176 if (dutf8 != sutf8) {
4178 /* Not modifying source SV, so taking a temporary copy. */
4179 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4181 sv_utf8_upgrade(csv);
4182 spv = SvPV_const(csv, slen);
4185 sv_utf8_upgrade_nomg(dsv);
4187 sv_catpvn_nomg(dsv, spv, slen);
4190 if (flags & SV_SMAGIC)
4195 =for apidoc sv_catpv
4197 Concatenates the string onto the end of the string which is in the SV.
4198 If the SV has the UTF-8 status set, then the bytes appended should be
4199 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4204 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4206 register STRLEN len;
4212 junk = SvPV_force(sv, tlen);
4214 SvGROW(sv, tlen + len + 1);
4216 ptr = SvPVX_const(sv);
4217 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4218 SvCUR_set(sv, SvCUR(sv) + len);
4219 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4224 =for apidoc sv_catpv_mg
4226 Like C<sv_catpv>, but also handles 'set' magic.
4232 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4241 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4242 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4249 Perl_newSV(pTHX_ STRLEN len)
4255 sv_upgrade(sv, SVt_PV);
4256 SvGROW(sv, len + 1);
4261 =for apidoc sv_magicext
4263 Adds magic to an SV, upgrading it if necessary. Applies the
4264 supplied vtable and returns a pointer to the magic added.
4266 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4267 In particular, you can add magic to SvREADONLY SVs, and add more than
4268 one instance of the same 'how'.
4270 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4271 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4272 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4273 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4275 (This is now used as a subroutine by C<sv_magic>.)
4280 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4281 const char* name, I32 namlen)
4285 if (SvTYPE(sv) < SVt_PVMG) {
4286 SvUPGRADE(sv, SVt_PVMG);
4288 Newxz(mg, 1, MAGIC);
4289 mg->mg_moremagic = SvMAGIC(sv);
4290 SvMAGIC_set(sv, mg);
4292 /* Sometimes a magic contains a reference loop, where the sv and
4293 object refer to each other. To prevent a reference loop that
4294 would prevent such objects being freed, we look for such loops
4295 and if we find one we avoid incrementing the object refcount.
4297 Note we cannot do this to avoid self-tie loops as intervening RV must
4298 have its REFCNT incremented to keep it in existence.
4301 if (!obj || obj == sv ||
4302 how == PERL_MAGIC_arylen ||
4303 how == PERL_MAGIC_qr ||
4304 how == PERL_MAGIC_symtab ||
4305 (SvTYPE(obj) == SVt_PVGV &&
4306 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4307 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4308 GvFORM(obj) == (CV*)sv)))
4313 mg->mg_obj = SvREFCNT_inc(obj);
4314 mg->mg_flags |= MGf_REFCOUNTED;
4317 /* Normal self-ties simply pass a null object, and instead of
4318 using mg_obj directly, use the SvTIED_obj macro to produce a
4319 new RV as needed. For glob "self-ties", we are tieing the PVIO
4320 with an RV obj pointing to the glob containing the PVIO. In
4321 this case, to avoid a reference loop, we need to weaken the
4325 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4326 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4332 mg->mg_len = namlen;
4335 mg->mg_ptr = savepvn(name, namlen);
4336 else if (namlen == HEf_SVKEY)
4337 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4339 mg->mg_ptr = (char *) name;
4341 mg->mg_virtual = vtable;
4345 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4350 =for apidoc sv_magic
4352 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4353 then adds a new magic item of type C<how> to the head of the magic list.
4355 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4356 handling of the C<name> and C<namlen> arguments.
4358 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4359 to add more than one instance of the same 'how'.
4365 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4367 const MGVTBL *vtable;
4370 #ifdef PERL_OLD_COPY_ON_WRITE
4372 sv_force_normal_flags(sv, 0);
4374 if (SvREADONLY(sv)) {
4376 /* its okay to attach magic to shared strings; the subsequent
4377 * upgrade to PVMG will unshare the string */
4378 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4381 && how != PERL_MAGIC_regex_global
4382 && how != PERL_MAGIC_bm
4383 && how != PERL_MAGIC_fm
4384 && how != PERL_MAGIC_sv
4385 && how != PERL_MAGIC_backref
4388 Perl_croak(aTHX_ PL_no_modify);
4391 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4392 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4393 /* sv_magic() refuses to add a magic of the same 'how' as an
4396 if (how == PERL_MAGIC_taint)
4404 vtable = &PL_vtbl_sv;
4406 case PERL_MAGIC_overload:
4407 vtable = &PL_vtbl_amagic;
4409 case PERL_MAGIC_overload_elem:
4410 vtable = &PL_vtbl_amagicelem;
4412 case PERL_MAGIC_overload_table:
4413 vtable = &PL_vtbl_ovrld;
4416 vtable = &PL_vtbl_bm;
4418 case PERL_MAGIC_regdata:
4419 vtable = &PL_vtbl_regdata;
4421 case PERL_MAGIC_regdatum:
4422 vtable = &PL_vtbl_regdatum;
4424 case PERL_MAGIC_env:
4425 vtable = &PL_vtbl_env;
4428 vtable = &PL_vtbl_fm;
4430 case PERL_MAGIC_envelem:
4431 vtable = &PL_vtbl_envelem;
4433 case PERL_MAGIC_regex_global:
4434 vtable = &PL_vtbl_mglob;
4436 case PERL_MAGIC_isa:
4437 vtable = &PL_vtbl_isa;
4439 case PERL_MAGIC_isaelem:
4440 vtable = &PL_vtbl_isaelem;
4442 case PERL_MAGIC_nkeys:
4443 vtable = &PL_vtbl_nkeys;
4445 case PERL_MAGIC_dbfile:
4448 case PERL_MAGIC_dbline:
4449 vtable = &PL_vtbl_dbline;
4451 #ifdef USE_LOCALE_COLLATE
4452 case PERL_MAGIC_collxfrm:
4453 vtable = &PL_vtbl_collxfrm;
4455 #endif /* USE_LOCALE_COLLATE */
4456 case PERL_MAGIC_tied:
4457 vtable = &PL_vtbl_pack;
4459 case PERL_MAGIC_tiedelem:
4460 case PERL_MAGIC_tiedscalar:
4461 vtable = &PL_vtbl_packelem;
4464 vtable = &PL_vtbl_regexp;
4466 case PERL_MAGIC_sig:
4467 vtable = &PL_vtbl_sig;
4469 case PERL_MAGIC_sigelem:
4470 vtable = &PL_vtbl_sigelem;
4472 case PERL_MAGIC_taint:
4473 vtable = &PL_vtbl_taint;
4475 case PERL_MAGIC_uvar:
4476 vtable = &PL_vtbl_uvar;
4478 case PERL_MAGIC_vec:
4479 vtable = &PL_vtbl_vec;
4481 case PERL_MAGIC_arylen_p:
4482 case PERL_MAGIC_rhash:
4483 case PERL_MAGIC_symtab:
4484 case PERL_MAGIC_vstring:
4487 case PERL_MAGIC_utf8:
4488 vtable = &PL_vtbl_utf8;
4490 case PERL_MAGIC_substr:
4491 vtable = &PL_vtbl_substr;
4493 case PERL_MAGIC_defelem:
4494 vtable = &PL_vtbl_defelem;
4496 case PERL_MAGIC_glob:
4497 vtable = &PL_vtbl_glob;
4499 case PERL_MAGIC_arylen:
4500 vtable = &PL_vtbl_arylen;
4502 case PERL_MAGIC_pos:
4503 vtable = &PL_vtbl_pos;
4505 case PERL_MAGIC_backref:
4506 vtable = &PL_vtbl_backref;
4508 case PERL_MAGIC_ext:
4509 /* Reserved for use by extensions not perl internals. */
4510 /* Useful for attaching extension internal data to perl vars. */
4511 /* Note that multiple extensions may clash if magical scalars */
4512 /* etc holding private data from one are passed to another. */
4516 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4519 /* Rest of work is done else where */
4520 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4523 case PERL_MAGIC_taint:
4526 case PERL_MAGIC_ext:
4527 case PERL_MAGIC_dbfile:
4534 =for apidoc sv_unmagic
4536 Removes all magic of type C<type> from an SV.
4542 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4546 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4549 for (mg = *mgp; mg; mg = *mgp) {
4550 if (mg->mg_type == type) {
4551 const MGVTBL* const vtbl = mg->mg_virtual;
4552 *mgp = mg->mg_moremagic;
4553 if (vtbl && vtbl->svt_free)
4554 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4555 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4557 Safefree(mg->mg_ptr);
4558 else if (mg->mg_len == HEf_SVKEY)
4559 SvREFCNT_dec((SV*)mg->mg_ptr);
4560 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4561 Safefree(mg->mg_ptr);
4563 if (mg->mg_flags & MGf_REFCOUNTED)
4564 SvREFCNT_dec(mg->mg_obj);
4568 mgp = &mg->mg_moremagic;
4572 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4579 =for apidoc sv_rvweaken
4581 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4582 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4583 push a back-reference to this RV onto the array of backreferences
4584 associated with that magic.
4590 Perl_sv_rvweaken(pTHX_ SV *sv)
4593 if (!SvOK(sv)) /* let undefs pass */
4596 Perl_croak(aTHX_ "Can't weaken a nonreference");
4597 else if (SvWEAKREF(sv)) {
4598 if (ckWARN(WARN_MISC))
4599 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4603 Perl_sv_add_backref(aTHX_ tsv, sv);
4609 /* Give tsv backref magic if it hasn't already got it, then push a
4610 * back-reference to sv onto the array associated with the backref magic.
4614 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4618 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4619 av = (AV*)mg->mg_obj;
4622 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4623 /* av now has a refcnt of 2, which avoids it getting freed
4624 * before us during global cleanup. The extra ref is removed
4625 * by magic_killbackrefs() when tsv is being freed */
4627 if (AvFILLp(av) >= AvMAX(av)) {
4628 av_extend(av, AvFILLp(av)+1);
4630 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4633 /* delete a back-reference to ourselves from the backref magic associated
4634 * with the SV we point to.
4638 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4644 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4645 if (PL_in_clean_all)
4648 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4649 Perl_croak(aTHX_ "panic: del_backref");
4650 av = (AV *)mg->mg_obj;
4652 /* We shouldn't be in here more than once, but for paranoia reasons lets
4654 for (i = AvFILLp(av); i >= 0; i--) {
4656 const SSize_t fill = AvFILLp(av);
4658 /* We weren't the last entry.
4659 An unordered list has this property that you can take the
4660 last element off the end to fill the hole, and it's still
4661 an unordered list :-)
4666 AvFILLp(av) = fill - 1;
4672 =for apidoc sv_insert
4674 Inserts a string at the specified offset/length within the SV. Similar to
4675 the Perl substr() function.
4681 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4685 register char *midend;
4686 register char *bigend;
4692 Perl_croak(aTHX_ "Can't modify non-existent substring");
4693 SvPV_force(bigstr, curlen);
4694 (void)SvPOK_only_UTF8(bigstr);
4695 if (offset + len > curlen) {
4696 SvGROW(bigstr, offset+len+1);
4697 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4698 SvCUR_set(bigstr, offset+len);
4702 i = littlelen - len;
4703 if (i > 0) { /* string might grow */
4704 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4705 mid = big + offset + len;
4706 midend = bigend = big + SvCUR(bigstr);
4709 while (midend > mid) /* shove everything down */
4710 *--bigend = *--midend;
4711 Move(little,big+offset,littlelen,char);
4712 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4717 Move(little,SvPVX(bigstr)+offset,len,char);
4722 big = SvPVX(bigstr);
4725 bigend = big + SvCUR(bigstr);
4727 if (midend > bigend)
4728 Perl_croak(aTHX_ "panic: sv_insert");
4730 if (mid - big > bigend - midend) { /* faster to shorten from end */
4732 Move(little, mid, littlelen,char);
4735 i = bigend - midend;
4737 Move(midend, mid, i,char);
4741 SvCUR_set(bigstr, mid - big);
4743 else if ((i = mid - big)) { /* faster from front */
4744 midend -= littlelen;
4746 sv_chop(bigstr,midend-i);
4751 Move(little, mid, littlelen,char);
4753 else if (littlelen) {
4754 midend -= littlelen;
4755 sv_chop(bigstr,midend);
4756 Move(little,midend,littlelen,char);
4759 sv_chop(bigstr,midend);
4765 =for apidoc sv_replace
4767 Make the first argument a copy of the second, then delete the original.
4768 The target SV physically takes over ownership of the body of the source SV
4769 and inherits its flags; however, the target keeps any magic it owns,
4770 and any magic in the source is discarded.
4771 Note that this is a rather specialist SV copying operation; most of the
4772 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4778 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4780 const U32 refcnt = SvREFCNT(sv);
4781 SV_CHECK_THINKFIRST_COW_DROP(sv);
4782 if (SvREFCNT(nsv) != 1) {
4783 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4784 UVuf " != 1)", (UV) SvREFCNT(nsv));
4786 if (SvMAGICAL(sv)) {
4790 sv_upgrade(nsv, SVt_PVMG);
4791 SvMAGIC_set(nsv, SvMAGIC(sv));
4792 SvFLAGS(nsv) |= SvMAGICAL(sv);
4794 SvMAGIC_set(sv, NULL);
4798 assert(!SvREFCNT(sv));
4799 #ifdef DEBUG_LEAKING_SCALARS
4800 sv->sv_flags = nsv->sv_flags;
4801 sv->sv_any = nsv->sv_any;
4802 sv->sv_refcnt = nsv->sv_refcnt;
4803 sv->sv_u = nsv->sv_u;
4805 StructCopy(nsv,sv,SV);
4807 /* Currently could join these into one piece of pointer arithmetic, but
4808 it would be unclear. */
4809 if(SvTYPE(sv) == SVt_IV)
4811 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4812 else if (SvTYPE(sv) == SVt_RV) {
4813 SvANY(sv) = &sv->sv_u.svu_rv;
4817 #ifdef PERL_OLD_COPY_ON_WRITE
4818 if (SvIsCOW_normal(nsv)) {
4819 /* We need to follow the pointers around the loop to make the
4820 previous SV point to sv, rather than nsv. */
4823 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4826 assert(SvPVX_const(current) == SvPVX_const(nsv));
4828 /* Make the SV before us point to the SV after us. */
4830 PerlIO_printf(Perl_debug_log, "previous is\n");
4832 PerlIO_printf(Perl_debug_log,
4833 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4834 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4836 SV_COW_NEXT_SV_SET(current, sv);
4839 SvREFCNT(sv) = refcnt;
4840 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4846 =for apidoc sv_clear
4848 Clear an SV: call any destructors, free up any memory used by the body,
4849 and free the body itself. The SV's head is I<not> freed, although
4850 its type is set to all 1's so that it won't inadvertently be assumed
4851 to be live during global destruction etc.
4852 This function should only be called when REFCNT is zero. Most of the time
4853 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4860 Perl_sv_clear(pTHX_ register SV *sv)
4863 const U32 type = SvTYPE(sv);
4864 const struct body_details *const sv_type_details
4865 = bodies_by_type + type;
4868 assert(SvREFCNT(sv) == 0);
4874 if (PL_defstash) { /* Still have a symbol table? */
4879 stash = SvSTASH(sv);
4880 destructor = StashHANDLER(stash,DESTROY);
4882 SV* const tmpref = newRV(sv);
4883 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4885 PUSHSTACKi(PERLSI_DESTROY);
4890 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4896 if(SvREFCNT(tmpref) < 2) {
4897 /* tmpref is not kept alive! */
4899 SvRV_set(tmpref, NULL);
4902 SvREFCNT_dec(tmpref);
4904 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4908 if (PL_in_clean_objs)
4909 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4911 /* DESTROY gave object new lease on life */
4917 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4918 SvOBJECT_off(sv); /* Curse the object. */
4919 if (type != SVt_PVIO)
4920 --PL_sv_objcount; /* XXX Might want something more general */
4923 if (type >= SVt_PVMG) {
4926 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4927 SvREFCNT_dec(SvSTASH(sv));
4932 IoIFP(sv) != PerlIO_stdin() &&
4933 IoIFP(sv) != PerlIO_stdout() &&
4934 IoIFP(sv) != PerlIO_stderr())
4936 io_close((IO*)sv, FALSE);
4938 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4939 PerlDir_close(IoDIRP(sv));
4940 IoDIRP(sv) = (DIR*)NULL;
4941 Safefree(IoTOP_NAME(sv));
4942 Safefree(IoFMT_NAME(sv));
4943 Safefree(IoBOTTOM_NAME(sv));
4958 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4959 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4960 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4961 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4963 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4964 SvREFCNT_dec(LvTARG(sv));
4968 Safefree(GvNAME(sv));
4969 /* If we're in a stash, we don't own a reference to it. However it does
4970 have a back reference to us, which needs to be cleared. */
4972 sv_del_backref((SV*)GvSTASH(sv), sv);
4977 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4979 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4980 /* Don't even bother with turning off the OOK flag. */
4985 SV *target = SvRV(sv);
4987 sv_del_backref(target, sv);
4989 SvREFCNT_dec(target);
4991 #ifdef PERL_OLD_COPY_ON_WRITE
4992 else if (SvPVX_const(sv)) {
4994 /* I believe I need to grab the global SV mutex here and
4995 then recheck the COW status. */
4997 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5000 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5001 SV_COW_NEXT_SV(sv));
5002 /* And drop it here. */
5004 } else if (SvLEN(sv)) {
5005 Safefree(SvPVX_const(sv));
5009 else if (SvPVX_const(sv) && SvLEN(sv))
5010 Safefree(SvPVX_mutable(sv));
5011 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5012 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5021 SvFLAGS(sv) &= SVf_BREAK;
5022 SvFLAGS(sv) |= SVTYPEMASK;
5024 if (sv_type_details->arena) {
5025 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5026 &PL_body_roots[type]);
5028 else if (sv_type_details->size) {
5029 my_safefree(SvANY(sv));
5034 =for apidoc sv_newref
5036 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5043 Perl_sv_newref(pTHX_ SV *sv)
5053 Decrement an SV's reference count, and if it drops to zero, call
5054 C<sv_clear> to invoke destructors and free up any memory used by
5055 the body; finally, deallocate the SV's head itself.
5056 Normally called via a wrapper macro C<SvREFCNT_dec>.
5062 Perl_sv_free(pTHX_ SV *sv)
5067 if (SvREFCNT(sv) == 0) {
5068 if (SvFLAGS(sv) & SVf_BREAK)
5069 /* this SV's refcnt has been artificially decremented to
5070 * trigger cleanup */
5072 if (PL_in_clean_all) /* All is fair */
5074 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5075 /* make sure SvREFCNT(sv)==0 happens very seldom */
5076 SvREFCNT(sv) = (~(U32)0)/2;
5079 if (ckWARN_d(WARN_INTERNAL)) {
5080 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5081 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5082 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5083 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5084 Perl_dump_sv_child(aTHX_ sv);
5089 if (--(SvREFCNT(sv)) > 0)
5091 Perl_sv_free2(aTHX_ sv);
5095 Perl_sv_free2(pTHX_ SV *sv)
5100 if (ckWARN_d(WARN_DEBUGGING))
5101 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5102 "Attempt to free temp prematurely: SV 0x%"UVxf
5103 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5107 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5108 /* make sure SvREFCNT(sv)==0 happens very seldom */
5109 SvREFCNT(sv) = (~(U32)0)/2;
5120 Returns the length of the string in the SV. Handles magic and type
5121 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5127 Perl_sv_len(pTHX_ register SV *sv)
5135 len = mg_length(sv);
5137 (void)SvPV_const(sv, len);
5142 =for apidoc sv_len_utf8
5144 Returns the number of characters in the string in an SV, counting wide
5145 UTF-8 bytes as a single character. Handles magic and type coercion.
5151 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5152 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5153 * (Note that the mg_len is not the length of the mg_ptr field.)
5158 Perl_sv_len_utf8(pTHX_ register SV *sv)
5164 return mg_length(sv);
5168 const U8 *s = (U8*)SvPV_const(sv, len);
5169 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5171 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5173 #ifdef PERL_UTF8_CACHE_ASSERT
5174 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5178 ulen = Perl_utf8_length(aTHX_ s, s + len);
5179 if (!mg && !SvREADONLY(sv)) {
5180 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5181 mg = mg_find(sv, PERL_MAGIC_utf8);
5191 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5192 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5193 * between UTF-8 and byte offsets. There are two (substr offset and substr
5194 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5195 * and byte offset) cache positions.
5197 * The mg_len field is used by sv_len_utf8(), see its comments.
5198 * Note that the mg_len is not the length of the mg_ptr field.
5202 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5203 I32 offsetp, const U8 *s, const U8 *start)
5207 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5209 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5213 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5215 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5216 (*mgp)->mg_ptr = (char *) *cachep;
5220 (*cachep)[i] = offsetp;
5221 (*cachep)[i+1] = s - start;
5229 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5230 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5231 * between UTF-8 and byte offsets. See also the comments of
5232 * S_utf8_mg_pos_init().
5236 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)
5240 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5242 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5243 if (*mgp && (*mgp)->mg_ptr) {
5244 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5245 ASSERT_UTF8_CACHE(*cachep);
5246 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5248 else { /* We will skip to the right spot. */
5253 /* The assumption is that going backward is half
5254 * the speed of going forward (that's where the
5255 * 2 * backw in the below comes from). (The real
5256 * figure of course depends on the UTF-8 data.) */
5258 if ((*cachep)[i] > (STRLEN)uoff) {
5260 backw = (*cachep)[i] - (STRLEN)uoff;
5262 if (forw < 2 * backw)
5265 p = start + (*cachep)[i+1];
5267 /* Try this only for the substr offset (i == 0),
5268 * not for the substr length (i == 2). */
5269 else if (i == 0) { /* (*cachep)[i] < uoff */
5270 const STRLEN ulen = sv_len_utf8(sv);
5272 if ((STRLEN)uoff < ulen) {
5273 forw = (STRLEN)uoff - (*cachep)[i];
5274 backw = ulen - (STRLEN)uoff;
5276 if (forw < 2 * backw)
5277 p = start + (*cachep)[i+1];
5282 /* If the string is not long enough for uoff,
5283 * we could extend it, but not at this low a level. */
5287 if (forw < 2 * backw) {
5294 while (UTF8_IS_CONTINUATION(*p))
5299 /* Update the cache. */
5300 (*cachep)[i] = (STRLEN)uoff;
5301 (*cachep)[i+1] = p - start;
5303 /* Drop the stale "length" cache */
5312 if (found) { /* Setup the return values. */
5313 *offsetp = (*cachep)[i+1];
5314 *sp = start + *offsetp;
5317 *offsetp = send - start;
5319 else if (*sp < start) {
5325 #ifdef PERL_UTF8_CACHE_ASSERT
5330 while (n-- && s < send)
5334 assert(*offsetp == s - start);
5335 assert((*cachep)[0] == (STRLEN)uoff);
5336 assert((*cachep)[1] == *offsetp);
5338 ASSERT_UTF8_CACHE(*cachep);
5347 =for apidoc sv_pos_u2b
5349 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5350 the start of the string, to a count of the equivalent number of bytes; if
5351 lenp is non-zero, it does the same to lenp, but this time starting from
5352 the offset, rather than from the start of the string. Handles magic and
5359 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5360 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5361 * byte offsets. See also the comments of S_utf8_mg_pos().
5366 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5374 start = (U8*)SvPV_const(sv, len);
5378 const U8 *s = start;
5379 I32 uoffset = *offsetp;
5380 const U8 * const send = s + len;
5384 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5386 if (!found && uoffset > 0) {
5387 while (s < send && uoffset--)
5391 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5393 *offsetp = s - start;
5398 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5402 if (!found && *lenp > 0) {
5405 while (s < send && ulen--)
5409 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5413 ASSERT_UTF8_CACHE(cache);
5425 =for apidoc sv_pos_b2u
5427 Converts the value pointed to by offsetp from a count of bytes from the
5428 start of the string, to a count of the equivalent number of UTF-8 chars.
5429 Handles magic and type coercion.
5435 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5436 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5437 * byte offsets. See also the comments of S_utf8_mg_pos().
5442 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5450 s = (const U8*)SvPV_const(sv, len);
5451 if ((I32)len < *offsetp)
5452 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5454 const U8* send = s + *offsetp;
5456 STRLEN *cache = NULL;
5460 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5461 mg = mg_find(sv, PERL_MAGIC_utf8);
5462 if (mg && mg->mg_ptr) {
5463 cache = (STRLEN *) mg->mg_ptr;
5464 if (cache[1] == (STRLEN)*offsetp) {
5465 /* An exact match. */
5466 *offsetp = cache[0];
5470 else if (cache[1] < (STRLEN)*offsetp) {
5471 /* We already know part of the way. */
5474 /* Let the below loop do the rest. */
5476 else { /* cache[1] > *offsetp */
5477 /* We already know all of the way, now we may
5478 * be able to walk back. The same assumption
5479 * is made as in S_utf8_mg_pos(), namely that
5480 * walking backward is twice slower than
5481 * walking forward. */
5482 const STRLEN forw = *offsetp;
5483 STRLEN backw = cache[1] - *offsetp;
5485 if (!(forw < 2 * backw)) {
5486 const U8 *p = s + cache[1];
5493 while (UTF8_IS_CONTINUATION(*p)) {
5501 *offsetp = cache[0];
5503 /* Drop the stale "length" cache */
5511 ASSERT_UTF8_CACHE(cache);
5517 /* Call utf8n_to_uvchr() to validate the sequence
5518 * (unless a simple non-UTF character) */
5519 if (!UTF8_IS_INVARIANT(*s))
5520 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5529 if (!SvREADONLY(sv)) {
5531 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5532 mg = mg_find(sv, PERL_MAGIC_utf8);
5537 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5538 mg->mg_ptr = (char *) cache;
5543 cache[1] = *offsetp;
5544 /* Drop the stale "length" cache */
5557 Returns a boolean indicating whether the strings in the two SVs are
5558 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5559 coerce its args to strings if necessary.
5565 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5573 SV* svrecode = Nullsv;
5580 pv1 = SvPV_const(sv1, cur1);
5587 pv2 = SvPV_const(sv2, cur2);
5589 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5590 /* Differing utf8ness.
5591 * Do not UTF8size the comparands as a side-effect. */
5594 svrecode = newSVpvn(pv2, cur2);
5595 sv_recode_to_utf8(svrecode, PL_encoding);
5596 pv2 = SvPV_const(svrecode, cur2);
5599 svrecode = newSVpvn(pv1, cur1);
5600 sv_recode_to_utf8(svrecode, PL_encoding);
5601 pv1 = SvPV_const(svrecode, cur1);
5603 /* Now both are in UTF-8. */
5605 SvREFCNT_dec(svrecode);
5610 bool is_utf8 = TRUE;
5613 /* sv1 is the UTF-8 one,
5614 * if is equal it must be downgrade-able */
5615 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5621 /* sv2 is the UTF-8 one,
5622 * if is equal it must be downgrade-able */
5623 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5629 /* Downgrade not possible - cannot be eq */
5637 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5640 SvREFCNT_dec(svrecode);
5651 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5652 string in C<sv1> is less than, equal to, or greater than the string in
5653 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5654 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5660 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5663 const char *pv1, *pv2;
5666 SV *svrecode = Nullsv;
5673 pv1 = SvPV_const(sv1, cur1);
5680 pv2 = SvPV_const(sv2, cur2);
5682 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5683 /* Differing utf8ness.
5684 * Do not UTF8size the comparands as a side-effect. */
5687 svrecode = newSVpvn(pv2, cur2);
5688 sv_recode_to_utf8(svrecode, PL_encoding);
5689 pv2 = SvPV_const(svrecode, cur2);
5692 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5697 svrecode = newSVpvn(pv1, cur1);
5698 sv_recode_to_utf8(svrecode, PL_encoding);
5699 pv1 = SvPV_const(svrecode, cur1);
5702 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5708 cmp = cur2 ? -1 : 0;
5712 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5715 cmp = retval < 0 ? -1 : 1;
5716 } else if (cur1 == cur2) {
5719 cmp = cur1 < cur2 ? -1 : 1;
5724 SvREFCNT_dec(svrecode);
5733 =for apidoc sv_cmp_locale
5735 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5736 'use bytes' aware, handles get magic, and will coerce its args to strings
5737 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5743 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5745 #ifdef USE_LOCALE_COLLATE
5751 if (PL_collation_standard)
5755 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5757 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5759 if (!pv1 || !len1) {
5770 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5773 return retval < 0 ? -1 : 1;
5776 * When the result of collation is equality, that doesn't mean
5777 * that there are no differences -- some locales exclude some
5778 * characters from consideration. So to avoid false equalities,
5779 * we use the raw string as a tiebreaker.
5785 #endif /* USE_LOCALE_COLLATE */
5787 return sv_cmp(sv1, sv2);
5791 #ifdef USE_LOCALE_COLLATE
5794 =for apidoc sv_collxfrm
5796 Add Collate Transform magic to an SV if it doesn't already have it.
5798 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5799 scalar data of the variable, but transformed to such a format that a normal
5800 memory comparison can be used to compare the data according to the locale
5807 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5811 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5812 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5818 Safefree(mg->mg_ptr);
5819 s = SvPV_const(sv, len);
5820 if ((xf = mem_collxfrm(s, len, &xlen))) {
5821 if (SvREADONLY(sv)) {
5824 return xf + sizeof(PL_collation_ix);
5827 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5828 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5841 if (mg && mg->mg_ptr) {
5843 return mg->mg_ptr + sizeof(PL_collation_ix);
5851 #endif /* USE_LOCALE_COLLATE */
5856 Get a line from the filehandle and store it into the SV, optionally
5857 appending to the currently-stored string.
5863 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5867 register STDCHAR rslast;
5868 register STDCHAR *bp;
5874 if (SvTHINKFIRST(sv))
5875 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5876 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5878 However, perlbench says it's slower, because the existing swipe code
5879 is faster than copy on write.
5880 Swings and roundabouts. */
5881 SvUPGRADE(sv, SVt_PV);
5886 if (PerlIO_isutf8(fp)) {
5888 sv_utf8_upgrade_nomg(sv);
5889 sv_pos_u2b(sv,&append,0);
5891 } else if (SvUTF8(sv)) {
5892 SV * const tsv = NEWSV(0,0);
5893 sv_gets(tsv, fp, 0);
5894 sv_utf8_upgrade_nomg(tsv);
5895 SvCUR_set(sv,append);
5898 goto return_string_or_null;
5903 if (PerlIO_isutf8(fp))
5906 if (IN_PERL_COMPILETIME) {
5907 /* we always read code in line mode */
5911 else if (RsSNARF(PL_rs)) {
5912 /* If it is a regular disk file use size from stat() as estimate
5913 of amount we are going to read - may result in malloc-ing
5914 more memory than we realy need if layers bellow reduce
5915 size we read (e.g. CRLF or a gzip layer)
5918 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5919 const Off_t offset = PerlIO_tell(fp);
5920 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5921 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5927 else if (RsRECORD(PL_rs)) {
5931 /* Grab the size of the record we're getting */
5932 recsize = SvIV(SvRV(PL_rs));
5933 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5936 /* VMS wants read instead of fread, because fread doesn't respect */
5937 /* RMS record boundaries. This is not necessarily a good thing to be */
5938 /* doing, but we've got no other real choice - except avoid stdio
5939 as implementation - perhaps write a :vms layer ?
5941 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5943 bytesread = PerlIO_read(fp, buffer, recsize);
5947 SvCUR_set(sv, bytesread += append);
5948 buffer[bytesread] = '\0';
5949 goto return_string_or_null;
5951 else if (RsPARA(PL_rs)) {
5957 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5958 if (PerlIO_isutf8(fp)) {
5959 rsptr = SvPVutf8(PL_rs, rslen);
5962 if (SvUTF8(PL_rs)) {
5963 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5964 Perl_croak(aTHX_ "Wide character in $/");
5967 rsptr = SvPV_const(PL_rs, rslen);
5971 rslast = rslen ? rsptr[rslen - 1] : '\0';
5973 if (rspara) { /* have to do this both before and after */
5974 do { /* to make sure file boundaries work right */
5977 i = PerlIO_getc(fp);
5981 PerlIO_ungetc(fp,i);
5987 /* See if we know enough about I/O mechanism to cheat it ! */
5989 /* This used to be #ifdef test - it is made run-time test for ease
5990 of abstracting out stdio interface. One call should be cheap
5991 enough here - and may even be a macro allowing compile
5995 if (PerlIO_fast_gets(fp)) {
5998 * We're going to steal some values from the stdio struct
5999 * and put EVERYTHING in the innermost loop into registers.
6001 register STDCHAR *ptr;
6005 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6006 /* An ungetc()d char is handled separately from the regular
6007 * buffer, so we getc() it back out and stuff it in the buffer.
6009 i = PerlIO_getc(fp);
6010 if (i == EOF) return 0;
6011 *(--((*fp)->_ptr)) = (unsigned char) i;
6015 /* Here is some breathtakingly efficient cheating */
6017 cnt = PerlIO_get_cnt(fp); /* get count into register */
6018 /* make sure we have the room */
6019 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6020 /* Not room for all of it
6021 if we are looking for a separator and room for some
6023 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6024 /* just process what we have room for */
6025 shortbuffered = cnt - SvLEN(sv) + append + 1;
6026 cnt -= shortbuffered;
6030 /* remember that cnt can be negative */
6031 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6036 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6037 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6038 DEBUG_P(PerlIO_printf(Perl_debug_log,
6039 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6040 DEBUG_P(PerlIO_printf(Perl_debug_log,
6041 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6042 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6043 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6048 while (cnt > 0) { /* this | eat */
6050 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6051 goto thats_all_folks; /* screams | sed :-) */
6055 Copy(ptr, bp, cnt, char); /* this | eat */
6056 bp += cnt; /* screams | dust */
6057 ptr += cnt; /* louder | sed :-) */
6062 if (shortbuffered) { /* oh well, must extend */
6063 cnt = shortbuffered;
6065 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6067 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6068 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6072 DEBUG_P(PerlIO_printf(Perl_debug_log,
6073 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6074 PTR2UV(ptr),(long)cnt));
6075 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6077 DEBUG_P(PerlIO_printf(Perl_debug_log,
6078 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6079 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6080 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6082 /* This used to call 'filbuf' in stdio form, but as that behaves like
6083 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6084 another abstraction. */
6085 i = PerlIO_getc(fp); /* get more characters */
6087 DEBUG_P(PerlIO_printf(Perl_debug_log,
6088 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6089 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6090 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6092 cnt = PerlIO_get_cnt(fp);
6093 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6094 DEBUG_P(PerlIO_printf(Perl_debug_log,
6095 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6097 if (i == EOF) /* all done for ever? */
6098 goto thats_really_all_folks;
6100 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6102 SvGROW(sv, bpx + cnt + 2);
6103 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6105 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6107 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6108 goto thats_all_folks;
6112 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6113 memNE((char*)bp - rslen, rsptr, rslen))
6114 goto screamer; /* go back to the fray */
6115 thats_really_all_folks:
6117 cnt += shortbuffered;
6118 DEBUG_P(PerlIO_printf(Perl_debug_log,
6119 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6120 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6121 DEBUG_P(PerlIO_printf(Perl_debug_log,
6122 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6123 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6124 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6126 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6127 DEBUG_P(PerlIO_printf(Perl_debug_log,
6128 "Screamer: done, len=%ld, string=|%.*s|\n",
6129 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6133 /*The big, slow, and stupid way. */
6134 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6136 Newx(buf, 8192, STDCHAR);
6144 register const STDCHAR *bpe = buf + sizeof(buf);
6146 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6147 ; /* keep reading */
6151 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6152 /* Accomodate broken VAXC compiler, which applies U8 cast to
6153 * both args of ?: operator, causing EOF to change into 255
6156 i = (U8)buf[cnt - 1];
6162 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6164 sv_catpvn(sv, (char *) buf, cnt);
6166 sv_setpvn(sv, (char *) buf, cnt);
6168 if (i != EOF && /* joy */
6170 SvCUR(sv) < rslen ||
6171 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6175 * If we're reading from a TTY and we get a short read,
6176 * indicating that the user hit his EOF character, we need
6177 * to notice it now, because if we try to read from the TTY
6178 * again, the EOF condition will disappear.
6180 * The comparison of cnt to sizeof(buf) is an optimization
6181 * that prevents unnecessary calls to feof().
6185 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6189 #ifdef USE_HEAP_INSTEAD_OF_STACK
6194 if (rspara) { /* have to do this both before and after */
6195 while (i != EOF) { /* to make sure file boundaries work right */
6196 i = PerlIO_getc(fp);
6198 PerlIO_ungetc(fp,i);
6204 return_string_or_null:
6205 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6211 Auto-increment of the value in the SV, doing string to numeric conversion
6212 if necessary. Handles 'get' magic.
6218 Perl_sv_inc(pTHX_ register SV *sv)
6226 if (SvTHINKFIRST(sv)) {
6228 sv_force_normal_flags(sv, 0);
6229 if (SvREADONLY(sv)) {
6230 if (IN_PERL_RUNTIME)
6231 Perl_croak(aTHX_ PL_no_modify);
6235 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6237 i = PTR2IV(SvRV(sv));
6242 flags = SvFLAGS(sv);
6243 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6244 /* It's (privately or publicly) a float, but not tested as an
6245 integer, so test it to see. */
6247 flags = SvFLAGS(sv);
6249 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6250 /* It's publicly an integer, or privately an integer-not-float */
6251 #ifdef PERL_PRESERVE_IVUV
6255 if (SvUVX(sv) == UV_MAX)
6256 sv_setnv(sv, UV_MAX_P1);
6258 (void)SvIOK_only_UV(sv);
6259 SvUV_set(sv, SvUVX(sv) + 1);
6261 if (SvIVX(sv) == IV_MAX)
6262 sv_setuv(sv, (UV)IV_MAX + 1);
6264 (void)SvIOK_only(sv);
6265 SvIV_set(sv, SvIVX(sv) + 1);
6270 if (flags & SVp_NOK) {
6271 (void)SvNOK_only(sv);
6272 SvNV_set(sv, SvNVX(sv) + 1.0);
6276 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6277 if ((flags & SVTYPEMASK) < SVt_PVIV)
6278 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6279 (void)SvIOK_only(sv);
6284 while (isALPHA(*d)) d++;
6285 while (isDIGIT(*d)) d++;
6287 #ifdef PERL_PRESERVE_IVUV
6288 /* Got to punt this as an integer if needs be, but we don't issue
6289 warnings. Probably ought to make the sv_iv_please() that does
6290 the conversion if possible, and silently. */
6291 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6292 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6293 /* Need to try really hard to see if it's an integer.
6294 9.22337203685478e+18 is an integer.
6295 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6296 so $a="9.22337203685478e+18"; $a+0; $a++
6297 needs to be the same as $a="9.22337203685478e+18"; $a++
6304 /* sv_2iv *should* have made this an NV */
6305 if (flags & SVp_NOK) {
6306 (void)SvNOK_only(sv);
6307 SvNV_set(sv, SvNVX(sv) + 1.0);
6310 /* I don't think we can get here. Maybe I should assert this
6311 And if we do get here I suspect that sv_setnv will croak. NWC
6313 #if defined(USE_LONG_DOUBLE)
6314 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",
6315 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6317 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6318 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6321 #endif /* PERL_PRESERVE_IVUV */
6322 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6326 while (d >= SvPVX_const(sv)) {
6334 /* MKS: The original code here died if letters weren't consecutive.
6335 * at least it didn't have to worry about non-C locales. The
6336 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6337 * arranged in order (although not consecutively) and that only
6338 * [A-Za-z] are accepted by isALPHA in the C locale.
6340 if (*d != 'z' && *d != 'Z') {
6341 do { ++*d; } while (!isALPHA(*d));
6344 *(d--) -= 'z' - 'a';
6349 *(d--) -= 'z' - 'a' + 1;
6353 /* oh,oh, the number grew */
6354 SvGROW(sv, SvCUR(sv) + 2);
6355 SvCUR_set(sv, SvCUR(sv) + 1);
6356 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6367 Auto-decrement of the value in the SV, doing string to numeric conversion
6368 if necessary. Handles 'get' magic.
6374 Perl_sv_dec(pTHX_ register SV *sv)
6381 if (SvTHINKFIRST(sv)) {
6383 sv_force_normal_flags(sv, 0);
6384 if (SvREADONLY(sv)) {
6385 if (IN_PERL_RUNTIME)
6386 Perl_croak(aTHX_ PL_no_modify);
6390 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6392 i = PTR2IV(SvRV(sv));
6397 /* Unlike sv_inc we don't have to worry about string-never-numbers
6398 and keeping them magic. But we mustn't warn on punting */
6399 flags = SvFLAGS(sv);
6400 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6401 /* It's publicly an integer, or privately an integer-not-float */
6402 #ifdef PERL_PRESERVE_IVUV
6406 if (SvUVX(sv) == 0) {
6407 (void)SvIOK_only(sv);
6411 (void)SvIOK_only_UV(sv);
6412 SvUV_set(sv, SvUVX(sv) - 1);
6415 if (SvIVX(sv) == IV_MIN)
6416 sv_setnv(sv, (NV)IV_MIN - 1.0);
6418 (void)SvIOK_only(sv);
6419 SvIV_set(sv, SvIVX(sv) - 1);
6424 if (flags & SVp_NOK) {
6425 SvNV_set(sv, SvNVX(sv) - 1.0);
6426 (void)SvNOK_only(sv);
6429 if (!(flags & SVp_POK)) {
6430 if ((flags & SVTYPEMASK) < SVt_PVIV)
6431 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6433 (void)SvIOK_only(sv);
6436 #ifdef PERL_PRESERVE_IVUV
6438 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6439 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6440 /* Need to try really hard to see if it's an integer.
6441 9.22337203685478e+18 is an integer.
6442 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6443 so $a="9.22337203685478e+18"; $a+0; $a--
6444 needs to be the same as $a="9.22337203685478e+18"; $a--
6451 /* sv_2iv *should* have made this an NV */
6452 if (flags & SVp_NOK) {
6453 (void)SvNOK_only(sv);
6454 SvNV_set(sv, SvNVX(sv) - 1.0);
6457 /* I don't think we can get here. Maybe I should assert this
6458 And if we do get here I suspect that sv_setnv will croak. NWC
6460 #if defined(USE_LONG_DOUBLE)
6461 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",
6462 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6464 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6465 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6469 #endif /* PERL_PRESERVE_IVUV */
6470 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6474 =for apidoc sv_mortalcopy
6476 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6477 The new SV is marked as mortal. It will be destroyed "soon", either by an
6478 explicit call to FREETMPS, or by an implicit call at places such as
6479 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6484 /* Make a string that will exist for the duration of the expression
6485 * evaluation. Actually, it may have to last longer than that, but
6486 * hopefully we won't free it until it has been assigned to a
6487 * permanent location. */
6490 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6495 sv_setsv(sv,oldstr);
6497 PL_tmps_stack[++PL_tmps_ix] = sv;
6503 =for apidoc sv_newmortal
6505 Creates a new null SV which is mortal. The reference count of the SV is
6506 set to 1. It will be destroyed "soon", either by an explicit call to
6507 FREETMPS, or by an implicit call at places such as statement boundaries.
6508 See also C<sv_mortalcopy> and C<sv_2mortal>.
6514 Perl_sv_newmortal(pTHX)
6519 SvFLAGS(sv) = SVs_TEMP;
6521 PL_tmps_stack[++PL_tmps_ix] = sv;
6526 =for apidoc sv_2mortal
6528 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6529 by an explicit call to FREETMPS, or by an implicit call at places such as
6530 statement boundaries. SvTEMP() is turned on which means that the SV's
6531 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6532 and C<sv_mortalcopy>.
6538 Perl_sv_2mortal(pTHX_ register SV *sv)
6543 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6546 PL_tmps_stack[++PL_tmps_ix] = sv;
6554 Creates a new SV and copies a string into it. The reference count for the
6555 SV is set to 1. If C<len> is zero, Perl will compute the length using
6556 strlen(). For efficiency, consider using C<newSVpvn> instead.
6562 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6567 sv_setpvn(sv,s,len ? len : strlen(s));
6572 =for apidoc newSVpvn
6574 Creates a new SV and copies a string into it. The reference count for the
6575 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6576 string. You are responsible for ensuring that the source string is at least
6577 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6583 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6588 sv_setpvn(sv,s,len);
6594 =for apidoc newSVhek
6596 Creates a new SV from the hash key structure. It will generate scalars that
6597 point to the shared string table where possible. Returns a new (undefined)
6598 SV if the hek is NULL.
6604 Perl_newSVhek(pTHX_ const HEK *hek)
6613 if (HEK_LEN(hek) == HEf_SVKEY) {
6614 return newSVsv(*(SV**)HEK_KEY(hek));
6616 const int flags = HEK_FLAGS(hek);
6617 if (flags & HVhek_WASUTF8) {
6619 Andreas would like keys he put in as utf8 to come back as utf8
6621 STRLEN utf8_len = HEK_LEN(hek);
6622 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6623 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6626 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6628 } else if (flags & HVhek_REHASH) {
6629 /* We don't have a pointer to the hv, so we have to replicate the
6630 flag into every HEK. This hv is using custom a hasing
6631 algorithm. Hence we can't return a shared string scalar, as
6632 that would contain the (wrong) hash value, and might get passed
6633 into an hv routine with a regular hash */
6635 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6640 /* This will be overwhelminly the most common case. */
6641 return newSVpvn_share(HEK_KEY(hek),
6642 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6648 =for apidoc newSVpvn_share
6650 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6651 table. If the string does not already exist in the table, it is created
6652 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6653 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6654 otherwise the hash is computed. The idea here is that as the string table
6655 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6656 hash lookup will avoid string compare.
6662 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6665 bool is_utf8 = FALSE;
6667 STRLEN tmplen = -len;
6669 /* See the note in hv.c:hv_fetch() --jhi */
6670 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6674 PERL_HASH(hash, src, len);
6676 sv_upgrade(sv, SVt_PV);
6677 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6689 #if defined(PERL_IMPLICIT_CONTEXT)
6691 /* pTHX_ magic can't cope with varargs, so this is a no-context
6692 * version of the main function, (which may itself be aliased to us).
6693 * Don't access this version directly.
6697 Perl_newSVpvf_nocontext(const char* pat, ...)
6702 va_start(args, pat);
6703 sv = vnewSVpvf(pat, &args);
6710 =for apidoc newSVpvf
6712 Creates a new SV and initializes it with the string formatted like
6719 Perl_newSVpvf(pTHX_ const char* pat, ...)
6723 va_start(args, pat);
6724 sv = vnewSVpvf(pat, &args);
6729 /* backend for newSVpvf() and newSVpvf_nocontext() */
6732 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6736 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6743 Creates a new SV and copies a floating point value into it.
6744 The reference count for the SV is set to 1.
6750 Perl_newSVnv(pTHX_ NV n)
6762 Creates a new SV and copies an integer into it. The reference count for the
6769 Perl_newSViv(pTHX_ IV i)
6781 Creates a new SV and copies an unsigned integer into it.
6782 The reference count for the SV is set to 1.
6788 Perl_newSVuv(pTHX_ UV u)
6798 =for apidoc newRV_noinc
6800 Creates an RV wrapper for an SV. The reference count for the original
6801 SV is B<not> incremented.
6807 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6812 sv_upgrade(sv, SVt_RV);
6814 SvRV_set(sv, tmpRef);
6819 /* newRV_inc is the official function name to use now.
6820 * newRV_inc is in fact #defined to newRV in sv.h
6824 Perl_newRV(pTHX_ SV *tmpRef)
6826 return newRV_noinc(SvREFCNT_inc(tmpRef));
6832 Creates a new SV which is an exact duplicate of the original SV.
6839 Perl_newSVsv(pTHX_ register SV *old)
6845 if (SvTYPE(old) == SVTYPEMASK) {
6846 if (ckWARN_d(WARN_INTERNAL))
6847 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6851 /* SV_GMAGIC is the default for sv_setv()
6852 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6853 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6854 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6859 =for apidoc sv_reset
6861 Underlying implementation for the C<reset> Perl function.
6862 Note that the perl-level function is vaguely deprecated.
6868 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6871 char todo[PERL_UCHAR_MAX+1];
6876 if (!*s) { /* reset ?? searches */
6877 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6879 PMOP *pm = (PMOP *) mg->mg_obj;
6881 pm->op_pmdynflags &= ~PMdf_USED;
6888 /* reset variables */
6890 if (!HvARRAY(stash))
6893 Zero(todo, 256, char);
6896 I32 i = (unsigned char)*s;
6900 max = (unsigned char)*s++;
6901 for ( ; i <= max; i++) {
6904 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6906 for (entry = HvARRAY(stash)[i];
6908 entry = HeNEXT(entry))
6913 if (!todo[(U8)*HeKEY(entry)])
6915 gv = (GV*)HeVAL(entry);
6918 if (SvTHINKFIRST(sv)) {
6919 if (!SvREADONLY(sv) && SvROK(sv))
6921 /* XXX Is this continue a bug? Why should THINKFIRST
6922 exempt us from resetting arrays and hashes? */
6926 if (SvTYPE(sv) >= SVt_PV) {
6928 if (SvPVX_const(sv) != Nullch)
6936 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6938 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6941 # if defined(USE_ENVIRON_ARRAY)
6944 # endif /* USE_ENVIRON_ARRAY */
6955 Using various gambits, try to get an IO from an SV: the IO slot if its a
6956 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6957 named after the PV if we're a string.
6963 Perl_sv_2io(pTHX_ SV *sv)
6968 switch (SvTYPE(sv)) {
6976 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6980 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6982 return sv_2io(SvRV(sv));
6983 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6989 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6998 Using various gambits, try to get a CV from an SV; in addition, try if
6999 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7005 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7012 return *gvp = Nullgv, Nullcv;
7013 switch (SvTYPE(sv)) {
7031 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7032 tryAMAGICunDEREF(to_cv);
7035 if (SvTYPE(sv) == SVt_PVCV) {
7044 Perl_croak(aTHX_ "Not a subroutine reference");
7049 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7055 if (lref && !GvCVu(gv)) {
7058 tmpsv = NEWSV(704,0);
7059 gv_efullname3(tmpsv, gv, Nullch);
7060 /* XXX this is probably not what they think they're getting.
7061 * It has the same effect as "sub name;", i.e. just a forward
7063 newSUB(start_subparse(FALSE, 0),
7064 newSVOP(OP_CONST, 0, tmpsv),
7069 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7079 Returns true if the SV has a true value by Perl's rules.
7080 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7081 instead use an in-line version.
7087 Perl_sv_true(pTHX_ register SV *sv)
7092 register const XPV* const tXpv = (XPV*)SvANY(sv);
7094 (tXpv->xpv_cur > 1 ||
7095 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7102 return SvIVX(sv) != 0;
7105 return SvNVX(sv) != 0.0;
7107 return sv_2bool(sv);
7113 =for apidoc sv_pvn_force
7115 Get a sensible string out of the SV somehow.
7116 A private implementation of the C<SvPV_force> macro for compilers which
7117 can't cope with complex macro expressions. Always use the macro instead.
7119 =for apidoc sv_pvn_force_flags
7121 Get a sensible string out of the SV somehow.
7122 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7123 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7124 implemented in terms of this function.
7125 You normally want to use the various wrapper macros instead: see
7126 C<SvPV_force> and C<SvPV_force_nomg>
7132 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7135 if (SvTHINKFIRST(sv) && !SvROK(sv))
7136 sv_force_normal_flags(sv, 0);
7146 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7147 const char * const ref = sv_reftype(sv,0);
7149 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7150 ref, OP_NAME(PL_op));
7152 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7154 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7155 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7157 s = sv_2pv_flags(sv, &len, flags);
7161 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7164 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7165 SvGROW(sv, len + 1);
7166 Move(s,SvPVX(sv),len,char);
7171 SvPOK_on(sv); /* validate pointer */
7173 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7174 PTR2UV(sv),SvPVX_const(sv)));
7177 return SvPVX_mutable(sv);
7181 =for apidoc sv_pvbyten_force
7183 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7189 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7191 sv_pvn_force(sv,lp);
7192 sv_utf8_downgrade(sv,0);
7198 =for apidoc sv_pvutf8n_force
7200 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7206 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7208 sv_pvn_force(sv,lp);
7209 sv_utf8_upgrade(sv);
7215 =for apidoc sv_reftype
7217 Returns a string describing what the SV is a reference to.
7223 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7225 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7226 inside return suggests a const propagation bug in g++. */
7227 if (ob && SvOBJECT(sv)) {
7228 char * const name = HvNAME_get(SvSTASH(sv));
7229 return name ? name : (char *) "__ANON__";
7232 switch (SvTYPE(sv)) {
7249 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7250 /* tied lvalues should appear to be
7251 * scalars for backwards compatitbility */
7252 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7253 ? "SCALAR" : "LVALUE");
7254 case SVt_PVAV: return "ARRAY";
7255 case SVt_PVHV: return "HASH";
7256 case SVt_PVCV: return "CODE";
7257 case SVt_PVGV: return "GLOB";
7258 case SVt_PVFM: return "FORMAT";
7259 case SVt_PVIO: return "IO";
7260 default: return "UNKNOWN";
7266 =for apidoc sv_isobject
7268 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7269 object. If the SV is not an RV, or if the object is not blessed, then this
7276 Perl_sv_isobject(pTHX_ SV *sv)
7292 Returns a boolean indicating whether the SV is blessed into the specified
7293 class. This does not check for subtypes; use C<sv_derived_from> to verify
7294 an inheritance relationship.
7300 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7311 hvname = HvNAME_get(SvSTASH(sv));
7315 return strEQ(hvname, name);
7321 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7322 it will be upgraded to one. If C<classname> is non-null then the new SV will
7323 be blessed in the specified package. The new SV is returned and its
7324 reference count is 1.
7330 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7336 SV_CHECK_THINKFIRST_COW_DROP(rv);
7339 if (SvTYPE(rv) >= SVt_PVMG) {
7340 const U32 refcnt = SvREFCNT(rv);
7344 SvREFCNT(rv) = refcnt;
7347 if (SvTYPE(rv) < SVt_RV)
7348 sv_upgrade(rv, SVt_RV);
7349 else if (SvTYPE(rv) > SVt_RV) {
7360 HV* const stash = gv_stashpv(classname, TRUE);
7361 (void)sv_bless(rv, stash);
7367 =for apidoc sv_setref_pv
7369 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7370 argument will be upgraded to an RV. That RV will be modified to point to
7371 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7372 into the SV. The C<classname> argument indicates the package for the
7373 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7374 will have a reference count of 1, and the RV will be returned.
7376 Do not use with other Perl types such as HV, AV, SV, CV, because those
7377 objects will become corrupted by the pointer copy process.
7379 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7385 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7388 sv_setsv(rv, &PL_sv_undef);
7392 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7397 =for apidoc sv_setref_iv
7399 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7400 argument will be upgraded to an RV. That RV will be modified to point to
7401 the new SV. The C<classname> argument indicates the package for the
7402 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7403 will have a reference count of 1, and the RV will be returned.
7409 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7411 sv_setiv(newSVrv(rv,classname), iv);
7416 =for apidoc sv_setref_uv
7418 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7419 argument will be upgraded to an RV. That RV will be modified to point to
7420 the new SV. The C<classname> argument indicates the package for the
7421 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7422 will have a reference count of 1, and the RV will be returned.
7428 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7430 sv_setuv(newSVrv(rv,classname), uv);
7435 =for apidoc sv_setref_nv
7437 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7438 argument will be upgraded to an RV. That RV will be modified to point to
7439 the new SV. The C<classname> argument indicates the package for the
7440 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7441 will have a reference count of 1, and the RV will be returned.
7447 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7449 sv_setnv(newSVrv(rv,classname), nv);
7454 =for apidoc sv_setref_pvn
7456 Copies a string into a new SV, optionally blessing the SV. The length of the
7457 string must be specified with C<n>. The C<rv> argument will be upgraded to
7458 an RV. That RV will be modified to point to the new SV. The C<classname>
7459 argument indicates the package for the blessing. Set C<classname> to
7460 C<Nullch> to avoid the blessing. The new SV will have a reference count
7461 of 1, and the RV will be returned.
7463 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7469 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7471 sv_setpvn(newSVrv(rv,classname), pv, n);
7476 =for apidoc sv_bless
7478 Blesses an SV into a specified package. The SV must be an RV. The package
7479 must be designated by its stash (see C<gv_stashpv()>). The reference count
7480 of the SV is unaffected.
7486 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7490 Perl_croak(aTHX_ "Can't bless non-reference value");
7492 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7493 if (SvREADONLY(tmpRef))
7494 Perl_croak(aTHX_ PL_no_modify);
7495 if (SvOBJECT(tmpRef)) {
7496 if (SvTYPE(tmpRef) != SVt_PVIO)
7498 SvREFCNT_dec(SvSTASH(tmpRef));
7501 SvOBJECT_on(tmpRef);
7502 if (SvTYPE(tmpRef) != SVt_PVIO)
7504 SvUPGRADE(tmpRef, SVt_PVMG);
7505 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7512 if(SvSMAGICAL(tmpRef))
7513 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7521 /* Downgrades a PVGV to a PVMG.
7525 S_sv_unglob(pTHX_ SV *sv)
7529 assert(SvTYPE(sv) == SVt_PVGV);
7534 sv_del_backref((SV*)GvSTASH(sv), sv);
7535 GvSTASH(sv) = Nullhv;
7537 sv_unmagic(sv, PERL_MAGIC_glob);
7538 Safefree(GvNAME(sv));
7541 /* need to keep SvANY(sv) in the right arena */
7542 xpvmg = new_XPVMG();
7543 StructCopy(SvANY(sv), xpvmg, XPVMG);
7544 del_XPVGV(SvANY(sv));
7547 SvFLAGS(sv) &= ~SVTYPEMASK;
7548 SvFLAGS(sv) |= SVt_PVMG;
7552 =for apidoc sv_unref_flags
7554 Unsets the RV status of the SV, and decrements the reference count of
7555 whatever was being referenced by the RV. This can almost be thought of
7556 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7557 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7558 (otherwise the decrementing is conditional on the reference count being
7559 different from one or the reference being a readonly SV).
7566 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7568 SV* const target = SvRV(ref);
7570 if (SvWEAKREF(ref)) {
7571 sv_del_backref(target, ref);
7573 SvRV_set(ref, NULL);
7576 SvRV_set(ref, NULL);
7578 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7579 assigned to as BEGIN {$a = \"Foo"} will fail. */
7580 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7581 SvREFCNT_dec(target);
7582 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7583 sv_2mortal(target); /* Schedule for freeing later */
7587 =for apidoc sv_untaint
7589 Untaint an SV. Use C<SvTAINTED_off> instead.
7594 Perl_sv_untaint(pTHX_ SV *sv)
7596 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7597 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7604 =for apidoc sv_tainted
7606 Test an SV for taintedness. Use C<SvTAINTED> instead.
7611 Perl_sv_tainted(pTHX_ SV *sv)
7613 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7614 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7615 if (mg && (mg->mg_len & 1) )
7622 =for apidoc sv_setpviv
7624 Copies an integer into the given SV, also updating its string value.
7625 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7631 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7633 char buf[TYPE_CHARS(UV)];
7635 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7637 sv_setpvn(sv, ptr, ebuf - ptr);
7641 =for apidoc sv_setpviv_mg
7643 Like C<sv_setpviv>, but also handles 'set' magic.
7649 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7655 #if defined(PERL_IMPLICIT_CONTEXT)
7657 /* pTHX_ magic can't cope with varargs, so this is a no-context
7658 * version of the main function, (which may itself be aliased to us).
7659 * Don't access this version directly.
7663 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7667 va_start(args, pat);
7668 sv_vsetpvf(sv, pat, &args);
7672 /* pTHX_ magic can't cope with varargs, so this is a no-context
7673 * version of the main function, (which may itself be aliased to us).
7674 * Don't access this version directly.
7678 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7682 va_start(args, pat);
7683 sv_vsetpvf_mg(sv, pat, &args);
7689 =for apidoc sv_setpvf
7691 Works like C<sv_catpvf> but copies the text into the SV instead of
7692 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7698 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7701 va_start(args, pat);
7702 sv_vsetpvf(sv, pat, &args);
7707 =for apidoc sv_vsetpvf
7709 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7710 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7712 Usually used via its frontend C<sv_setpvf>.
7718 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7720 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7724 =for apidoc sv_setpvf_mg
7726 Like C<sv_setpvf>, but also handles 'set' magic.
7732 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7735 va_start(args, pat);
7736 sv_vsetpvf_mg(sv, pat, &args);
7741 =for apidoc sv_vsetpvf_mg
7743 Like C<sv_vsetpvf>, but also handles 'set' magic.
7745 Usually used via its frontend C<sv_setpvf_mg>.
7751 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7753 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7757 #if defined(PERL_IMPLICIT_CONTEXT)
7759 /* pTHX_ magic can't cope with varargs, so this is a no-context
7760 * version of the main function, (which may itself be aliased to us).
7761 * Don't access this version directly.
7765 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7769 va_start(args, pat);
7770 sv_vcatpvf(sv, pat, &args);
7774 /* pTHX_ magic can't cope with varargs, so this is a no-context
7775 * version of the main function, (which may itself be aliased to us).
7776 * Don't access this version directly.
7780 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7784 va_start(args, pat);
7785 sv_vcatpvf_mg(sv, pat, &args);
7791 =for apidoc sv_catpvf
7793 Processes its arguments like C<sprintf> and appends the formatted
7794 output to an SV. If the appended data contains "wide" characters
7795 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7796 and characters >255 formatted with %c), the original SV might get
7797 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7798 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7799 valid UTF-8; if the original SV was bytes, the pattern should be too.
7804 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7807 va_start(args, pat);
7808 sv_vcatpvf(sv, pat, &args);
7813 =for apidoc sv_vcatpvf
7815 Processes its arguments like C<vsprintf> and appends the formatted output
7816 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7818 Usually used via its frontend C<sv_catpvf>.
7824 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7826 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7830 =for apidoc sv_catpvf_mg
7832 Like C<sv_catpvf>, but also handles 'set' magic.
7838 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7841 va_start(args, pat);
7842 sv_vcatpvf_mg(sv, pat, &args);
7847 =for apidoc sv_vcatpvf_mg
7849 Like C<sv_vcatpvf>, but also handles 'set' magic.
7851 Usually used via its frontend C<sv_catpvf_mg>.
7857 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7859 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7864 =for apidoc sv_vsetpvfn
7866 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7869 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7875 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7877 sv_setpvn(sv, "", 0);
7878 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7881 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7884 S_expect_number(pTHX_ char** pattern)
7887 switch (**pattern) {
7888 case '1': case '2': case '3':
7889 case '4': case '5': case '6':
7890 case '7': case '8': case '9':
7891 while (isDIGIT(**pattern))
7892 var = var * 10 + (*(*pattern)++ - '0');
7896 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7899 F0convert(NV nv, char *endbuf, STRLEN *len)
7901 const int neg = nv < 0;
7910 if (uv & 1 && uv == nv)
7911 uv--; /* Round to even */
7913 const unsigned dig = uv % 10;
7926 =for apidoc sv_vcatpvfn
7928 Processes its arguments like C<vsprintf> and appends the formatted output
7929 to an SV. Uses an array of SVs if the C style variable argument list is
7930 missing (NULL). When running with taint checks enabled, indicates via
7931 C<maybe_tainted> if results are untrustworthy (often due to the use of
7934 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7940 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7941 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7942 vec_utf8 = DO_UTF8(vecsv);
7944 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7947 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7954 static const char nullstr[] = "(null)";
7956 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7957 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7959 /* Times 4: a decimal digit takes more than 3 binary digits.
7960 * NV_DIG: mantissa takes than many decimal digits.
7961 * Plus 32: Playing safe. */
7962 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7963 /* large enough for "%#.#f" --chip */
7964 /* what about long double NVs? --jhi */
7966 PERL_UNUSED_ARG(maybe_tainted);
7968 /* no matter what, this is a string now */
7969 (void)SvPV_force(sv, origlen);
7971 /* special-case "", "%s", and "%-p" (SVf - see below) */
7974 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7976 const char * const s = va_arg(*args, char*);
7977 sv_catpv(sv, s ? s : nullstr);
7979 else if (svix < svmax) {
7980 sv_catsv(sv, *svargs);
7981 if (DO_UTF8(*svargs))
7986 if (args && patlen == 3 && pat[0] == '%' &&
7987 pat[1] == '-' && pat[2] == 'p') {
7988 argsv = va_arg(*args, SV*);
7989 sv_catsv(sv, argsv);
7995 #ifndef USE_LONG_DOUBLE
7996 /* special-case "%.<number>[gf]" */
7997 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7998 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7999 unsigned digits = 0;
8003 while (*pp >= '0' && *pp <= '9')
8004 digits = 10 * digits + (*pp++ - '0');
8005 if (pp - pat == (int)patlen - 1) {
8013 /* Add check for digits != 0 because it seems that some
8014 gconverts are buggy in this case, and we don't yet have
8015 a Configure test for this. */
8016 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8017 /* 0, point, slack */
8018 Gconvert(nv, (int)digits, 0, ebuf);
8020 if (*ebuf) /* May return an empty string for digits==0 */
8023 } else if (!digits) {
8026 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8027 sv_catpvn(sv, p, l);
8033 #endif /* !USE_LONG_DOUBLE */
8035 if (!args && svix < svmax && DO_UTF8(*svargs))
8038 patend = (char*)pat + patlen;
8039 for (p = (char*)pat; p < patend; p = q) {
8042 bool vectorize = FALSE;
8043 bool vectorarg = FALSE;
8044 bool vec_utf8 = FALSE;
8050 bool has_precis = FALSE;
8053 bool is_utf8 = FALSE; /* is this item utf8? */
8054 #ifdef HAS_LDBL_SPRINTF_BUG
8055 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8056 with sfio - Allen <allens@cpan.org> */
8057 bool fix_ldbl_sprintf_bug = FALSE;
8061 U8 utf8buf[UTF8_MAXBYTES+1];
8062 STRLEN esignlen = 0;
8064 const char *eptr = Nullch;
8067 const U8 *vecstr = Null(U8*);
8074 /* we need a long double target in case HAS_LONG_DOUBLE but
8077 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8085 const char *dotstr = ".";
8086 STRLEN dotstrlen = 1;
8087 I32 efix = 0; /* explicit format parameter index */
8088 I32 ewix = 0; /* explicit width index */
8089 I32 epix = 0; /* explicit precision index */
8090 I32 evix = 0; /* explicit vector index */
8091 bool asterisk = FALSE;
8093 /* echo everything up to the next format specification */
8094 for (q = p; q < patend && *q != '%'; ++q) ;
8096 if (has_utf8 && !pat_utf8)
8097 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8099 sv_catpvn(sv, p, q - p);
8106 We allow format specification elements in this order:
8107 \d+\$ explicit format parameter index
8109 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8110 0 flag (as above): repeated to allow "v02"
8111 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8112 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8114 [%bcdefginopsuxDFOUX] format (mandatory)
8119 As of perl5.9.3, printf format checking is on by default.
8120 Internally, perl uses %p formats to provide an escape to
8121 some extended formatting. This block deals with those
8122 extensions: if it does not match, (char*)q is reset and
8123 the normal format processing code is used.
8125 Currently defined extensions are:
8126 %p include pointer address (standard)
8127 %-p (SVf) include an SV (previously %_)
8128 %-<num>p include an SV with precision <num>
8129 %1p (VDf) include a v-string (as %vd)
8130 %<num>p reserved for future extensions
8132 Robin Barker 2005-07-14
8139 EXPECT_NUMBER(q, n);
8146 argsv = va_arg(*args, SV*);
8147 eptr = SvPVx_const(argsv, elen);
8153 else if (n == vdNUMBER) { /* VDf */
8160 if (ckWARN_d(WARN_INTERNAL))
8161 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8162 "internal %%<num>p might conflict with future printf extensions");
8168 if (EXPECT_NUMBER(q, width)) {
8209 if (EXPECT_NUMBER(q, ewix))
8218 if ((vectorarg = asterisk)) {
8231 EXPECT_NUMBER(q, width);
8237 vecsv = va_arg(*args, SV*);
8239 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8240 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8241 dotstr = SvPV_const(vecsv, dotstrlen);
8248 else if (efix ? efix <= svmax : svix < svmax) {
8249 vecsv = svargs[efix ? efix-1 : svix++];
8250 vecstr = (U8*)SvPV_const(vecsv,veclen);
8251 vec_utf8 = DO_UTF8(vecsv);
8252 /* if this is a version object, we need to return the
8253 * stringified representation (which the SvPVX_const has
8254 * already done for us), but not vectorize the args
8256 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8258 q++; /* skip past the rest of the %vd format */
8259 eptr = (const char *) vecstr;
8273 i = va_arg(*args, int);
8275 i = (ewix ? ewix <= svmax : svix < svmax) ?
8276 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8278 width = (i < 0) ? -i : i;
8288 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8290 /* XXX: todo, support specified precision parameter */
8294 i = va_arg(*args, int);
8296 i = (ewix ? ewix <= svmax : svix < svmax)
8297 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8298 precis = (i < 0) ? 0 : i;
8303 precis = precis * 10 + (*q++ - '0');
8312 case 'I': /* Ix, I32x, and I64x */
8314 if (q[1] == '6' && q[2] == '4') {
8320 if (q[1] == '3' && q[2] == '2') {
8330 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8341 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8342 if (*(q + 1) == 'l') { /* lld, llf */
8367 argsv = (efix ? efix <= svmax : svix < svmax) ?
8368 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8375 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8377 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8379 eptr = (char*)utf8buf;
8380 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8391 if (args && !vectorize) {
8392 eptr = va_arg(*args, char*);
8394 #ifdef MACOS_TRADITIONAL
8395 /* On MacOS, %#s format is used for Pascal strings */
8400 elen = strlen(eptr);
8402 eptr = (char *)nullstr;
8403 elen = sizeof nullstr - 1;
8407 eptr = SvPVx_const(argsv, elen);
8408 if (DO_UTF8(argsv)) {
8409 if (has_precis && precis < elen) {
8411 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8414 if (width) { /* fudge width (can't fudge elen) */
8415 width += elen - sv_len_utf8(argsv);
8423 if (has_precis && elen > precis)
8430 if (alt || vectorize)
8432 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8453 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8462 esignbuf[esignlen++] = plus;
8466 case 'h': iv = (short)va_arg(*args, int); break;
8467 case 'l': iv = va_arg(*args, long); break;
8468 case 'V': iv = va_arg(*args, IV); break;
8469 default: iv = va_arg(*args, int); break;
8471 case 'q': iv = va_arg(*args, Quad_t); break;
8476 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8478 case 'h': iv = (short)tiv; break;
8479 case 'l': iv = (long)tiv; break;
8481 default: iv = tiv; break;
8483 case 'q': iv = (Quad_t)tiv; break;
8487 if ( !vectorize ) /* we already set uv above */
8492 esignbuf[esignlen++] = plus;
8496 esignbuf[esignlen++] = '-';
8539 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8550 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8551 case 'l': uv = va_arg(*args, unsigned long); break;
8552 case 'V': uv = va_arg(*args, UV); break;
8553 default: uv = va_arg(*args, unsigned); break;
8555 case 'q': uv = va_arg(*args, Uquad_t); break;
8560 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8562 case 'h': uv = (unsigned short)tuv; break;
8563 case 'l': uv = (unsigned long)tuv; break;
8565 default: uv = tuv; break;
8567 case 'q': uv = (Uquad_t)tuv; break;
8574 char *ptr = ebuf + sizeof ebuf;
8580 p = (char*)((c == 'X')
8581 ? "0123456789ABCDEF" : "0123456789abcdef");
8587 esignbuf[esignlen++] = '0';
8588 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8596 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 if (is_utf8 != has_utf8) {
8900 sv_utf8_upgrade(sv);
8903 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8904 sv_utf8_upgrade(nsv);
8905 eptr = SvPVX_const(nsv);
8908 SvGROW(sv, SvCUR(sv) + elen + 1);
8913 need = (have > width ? have : width);
8916 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8918 if (esignlen && fill == '0') {
8920 for (i = 0; i < (int)esignlen; i++)
8924 memset(p, fill, gap);
8927 if (esignlen && fill != '0') {
8929 for (i = 0; i < (int)esignlen; i++)
8934 for (i = zeros; i; i--)
8938 Copy(eptr, p, elen, char);
8942 memset(p, ' ', gap);
8947 Copy(dotstr, p, dotstrlen, char);
8951 vectorize = FALSE; /* done iterating over vecstr */
8958 SvCUR_set(sv, p - SvPVX_const(sv));
8966 /* =========================================================================
8968 =head1 Cloning an interpreter
8970 All the macros and functions in this section are for the private use of
8971 the main function, perl_clone().
8973 The foo_dup() functions make an exact copy of an existing foo thinngy.
8974 During the course of a cloning, a hash table is used to map old addresses
8975 to new addresses. The table is created and manipulated with the
8976 ptr_table_* functions.
8980 ============================================================================*/
8983 #if defined(USE_ITHREADS)
8985 #ifndef GpREFCNT_inc
8986 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8990 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8991 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8992 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8993 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8994 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8995 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8996 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8997 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8998 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8999 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9000 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9001 #define SAVEPV(p) (p ? savepv(p) : Nullch)
9002 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
9005 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9006 regcomp.c. AMS 20010712 */
9009 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9014 struct reg_substr_datum *s;
9017 return (REGEXP *)NULL;
9019 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9022 len = r->offsets[0];
9023 npar = r->nparens+1;
9025 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9026 Copy(r->program, ret->program, len+1, regnode);
9028 Newx(ret->startp, npar, I32);
9029 Copy(r->startp, ret->startp, npar, I32);
9030 Newx(ret->endp, npar, I32);
9031 Copy(r->startp, ret->startp, npar, I32);
9033 Newx(ret->substrs, 1, struct reg_substr_data);
9034 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9035 s->min_offset = r->substrs->data[i].min_offset;
9036 s->max_offset = r->substrs->data[i].max_offset;
9037 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9038 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9041 ret->regstclass = NULL;
9044 const int count = r->data->count;
9047 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9048 char, struct reg_data);
9049 Newx(d->what, count, U8);
9052 for (i = 0; i < count; i++) {
9053 d->what[i] = r->data->what[i];
9054 switch (d->what[i]) {
9055 /* legal options are one of: sfpont
9056 see also regcomp.h and pregfree() */
9058 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9061 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9064 /* This is cheating. */
9065 Newx(d->data[i], 1, struct regnode_charclass_class);
9066 StructCopy(r->data->data[i], d->data[i],
9067 struct regnode_charclass_class);
9068 ret->regstclass = (regnode*)d->data[i];
9071 /* Compiled op trees are readonly, and can thus be
9072 shared without duplication. */
9074 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9078 d->data[i] = r->data->data[i];
9081 d->data[i] = r->data->data[i];
9083 ((reg_trie_data*)d->data[i])->refcount++;
9087 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9096 Newx(ret->offsets, 2*len+1, U32);
9097 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9099 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9100 ret->refcnt = r->refcnt;
9101 ret->minlen = r->minlen;
9102 ret->prelen = r->prelen;
9103 ret->nparens = r->nparens;
9104 ret->lastparen = r->lastparen;
9105 ret->lastcloseparen = r->lastcloseparen;
9106 ret->reganch = r->reganch;
9108 ret->sublen = r->sublen;
9110 if (RX_MATCH_COPIED(ret))
9111 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9113 ret->subbeg = Nullch;
9114 #ifdef PERL_OLD_COPY_ON_WRITE
9115 ret->saved_copy = Nullsv;
9118 ptr_table_store(PL_ptr_table, r, ret);
9122 /* duplicate a file handle */
9125 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9129 PERL_UNUSED_ARG(type);
9132 return (PerlIO*)NULL;
9134 /* look for it in the table first */
9135 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9139 /* create anew and remember what it is */
9140 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9141 ptr_table_store(PL_ptr_table, fp, ret);
9145 /* duplicate a directory handle */
9148 Perl_dirp_dup(pTHX_ DIR *dp)
9156 /* duplicate a typeglob */
9159 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9164 /* look for it in the table first */
9165 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9169 /* create anew and remember what it is */
9171 ptr_table_store(PL_ptr_table, gp, ret);
9174 ret->gp_refcnt = 0; /* must be before any other dups! */
9175 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9176 ret->gp_io = io_dup_inc(gp->gp_io, param);
9177 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9178 ret->gp_av = av_dup_inc(gp->gp_av, param);
9179 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9180 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9181 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9182 ret->gp_cvgen = gp->gp_cvgen;
9183 ret->gp_line = gp->gp_line;
9184 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9188 /* duplicate a chain of magic */
9191 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9193 MAGIC *mgprev = (MAGIC*)NULL;
9196 return (MAGIC*)NULL;
9197 /* look for it in the table first */
9198 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9202 for (; mg; mg = mg->mg_moremagic) {
9204 Newxz(nmg, 1, MAGIC);
9206 mgprev->mg_moremagic = nmg;
9209 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9210 nmg->mg_private = mg->mg_private;
9211 nmg->mg_type = mg->mg_type;
9212 nmg->mg_flags = mg->mg_flags;
9213 if (mg->mg_type == PERL_MAGIC_qr) {
9214 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9216 else if(mg->mg_type == PERL_MAGIC_backref) {
9217 const AV * const av = (AV*) mg->mg_obj;
9220 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9222 for (i = AvFILLp(av); i >= 0; i--) {
9223 if (!svp[i]) continue;
9224 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9227 else if (mg->mg_type == PERL_MAGIC_symtab) {
9228 nmg->mg_obj = mg->mg_obj;
9231 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9232 ? sv_dup_inc(mg->mg_obj, param)
9233 : sv_dup(mg->mg_obj, param);
9235 nmg->mg_len = mg->mg_len;
9236 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9237 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9238 if (mg->mg_len > 0) {
9239 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9240 if (mg->mg_type == PERL_MAGIC_overload_table &&
9241 AMT_AMAGIC((AMT*)mg->mg_ptr))
9243 AMT * const amtp = (AMT*)mg->mg_ptr;
9244 AMT * const namtp = (AMT*)nmg->mg_ptr;
9246 for (i = 1; i < NofAMmeth; i++) {
9247 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9251 else if (mg->mg_len == HEf_SVKEY)
9252 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9254 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9255 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9262 /* create a new pointer-mapping table */
9265 Perl_ptr_table_new(pTHX)
9268 Newxz(tbl, 1, PTR_TBL_t);
9271 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9276 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9278 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9282 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9283 following define) and at call to new_body_inline made below in
9284 Perl_ptr_table_store()
9287 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9289 /* map an existing pointer using a table */
9292 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9294 PTR_TBL_ENT_t *tblent;
9295 const UV hash = PTR_TABLE_HASH(sv);
9297 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9298 for (; tblent; tblent = tblent->next) {
9299 if (tblent->oldval == sv)
9300 return tblent->newval;
9305 /* add a new entry to a pointer-mapping table */
9308 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9310 PTR_TBL_ENT_t *tblent, **otblent;
9311 /* XXX this may be pessimal on platforms where pointers aren't good
9312 * hash values e.g. if they grow faster in the most significant
9314 const UV hash = PTR_TABLE_HASH(oldsv);
9318 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9319 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9320 if (tblent->oldval == oldsv) {
9321 tblent->newval = newsv;
9325 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9326 tblent->oldval = oldsv;
9327 tblent->newval = newsv;
9328 tblent->next = *otblent;
9331 if (!empty && tbl->tbl_items > tbl->tbl_max)
9332 ptr_table_split(tbl);
9335 /* double the hash bucket size of an existing ptr table */
9338 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9340 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9341 const UV oldsize = tbl->tbl_max + 1;
9342 UV newsize = oldsize * 2;
9345 Renew(ary, newsize, PTR_TBL_ENT_t*);
9346 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9347 tbl->tbl_max = --newsize;
9349 for (i=0; i < oldsize; i++, ary++) {
9350 PTR_TBL_ENT_t **curentp, **entp, *ent;
9353 curentp = ary + oldsize;
9354 for (entp = ary, ent = *ary; ent; ent = *entp) {
9355 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9357 ent->next = *curentp;
9367 /* remove all the entries from a ptr table */
9370 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9372 register PTR_TBL_ENT_t **array;
9373 register PTR_TBL_ENT_t *entry;
9377 if (!tbl || !tbl->tbl_items) {
9381 array = tbl->tbl_ary;
9387 PTR_TBL_ENT_t *oentry = entry;
9388 entry = entry->next;
9392 if (++riter > max) {
9395 entry = array[riter];
9402 /* clear and free a ptr table */
9405 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9410 ptr_table_clear(tbl);
9411 Safefree(tbl->tbl_ary);
9417 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9420 SvRV_set(dstr, SvWEAKREF(sstr)
9421 ? sv_dup(SvRV(sstr), param)
9422 : sv_dup_inc(SvRV(sstr), param));
9425 else if (SvPVX_const(sstr)) {
9426 /* Has something there */
9428 /* Normal PV - clone whole allocated space */
9429 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9430 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9431 /* Not that normal - actually sstr is copy on write.
9432 But we are a true, independant SV, so: */
9433 SvREADONLY_off(dstr);
9438 /* Special case - not normally malloced for some reason */
9439 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9440 /* A "shared" PV - clone it as "shared" PV */
9442 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9446 /* Some other special case - random pointer */
9447 SvPV_set(dstr, SvPVX(sstr));
9453 if (SvTYPE(dstr) == SVt_RV)
9454 SvRV_set(dstr, NULL);
9460 /* duplicate an SV of any type (including AV, HV etc) */
9463 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9468 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9470 /* look for it in the table first */
9471 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9475 if(param->flags & CLONEf_JOIN_IN) {
9476 /** We are joining here so we don't want do clone
9477 something that is bad **/
9480 if(SvTYPE(sstr) == SVt_PVHV &&
9481 (hvname = HvNAME_get(sstr))) {
9482 /** don't clone stashes if they already exist **/
9483 return (SV*)gv_stashpv(hvname,0);
9487 /* create anew and remember what it is */
9490 #ifdef DEBUG_LEAKING_SCALARS
9491 dstr->sv_debug_optype = sstr->sv_debug_optype;
9492 dstr->sv_debug_line = sstr->sv_debug_line;
9493 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9494 dstr->sv_debug_cloned = 1;
9496 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9498 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9502 ptr_table_store(PL_ptr_table, sstr, dstr);
9505 SvFLAGS(dstr) = SvFLAGS(sstr);
9506 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9507 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9510 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9511 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9512 PL_watch_pvx, SvPVX_const(sstr));
9515 /* don't clone objects whose class has asked us not to */
9516 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9517 SvFLAGS(dstr) &= ~SVTYPEMASK;
9522 switch (SvTYPE(sstr)) {
9527 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9528 SvIV_set(dstr, SvIVX(sstr));
9531 SvANY(dstr) = new_XNV();
9532 SvNV_set(dstr, SvNVX(sstr));
9535 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9536 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9540 /* These are all the types that need complex bodies allocating. */
9542 const svtype sv_type = SvTYPE(sstr);
9543 const struct body_details *const sv_type_details
9544 = bodies_by_type + sv_type;
9548 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9553 if (GvUNIQUE((GV*)sstr)) {
9554 /* Do sharing here, and fall through */
9567 assert(sv_type_details->copy);
9568 if (sv_type_details->arena) {
9569 new_body_inline(new_body, sv_type_details->copy, sv_type);
9571 = (void*)((char*)new_body - sv_type_details->offset);
9573 new_body = new_NOARENA(sv_type_details);
9577 SvANY(dstr) = new_body;
9580 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9581 ((char*)SvANY(dstr)) + sv_type_details->offset,
9582 sv_type_details->copy, char);
9584 Copy(((char*)SvANY(sstr)),
9585 ((char*)SvANY(dstr)),
9586 sv_type_details->size + sv_type_details->offset, char);
9589 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9590 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9592 /* The Copy above means that all the source (unduplicated) pointers
9593 are now in the destination. We can check the flags and the
9594 pointers in either, but it's possible that there's less cache
9595 missing by always going for the destination.
9596 FIXME - instrument and check that assumption */
9597 if (sv_type >= SVt_PVMG) {
9599 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9601 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9604 /* The cast silences a GCC warning about unhandled types. */
9605 switch ((int)sv_type) {
9617 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9618 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9619 LvTARG(dstr) = dstr;
9620 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9621 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9623 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9626 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9627 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9628 /* Don't call sv_add_backref here as it's going to be created
9629 as part of the magic cloning of the symbol table. */
9630 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9631 (void)GpREFCNT_inc(GvGP(dstr));
9634 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9635 if (IoOFP(dstr) == IoIFP(sstr))
9636 IoOFP(dstr) = IoIFP(dstr);
9638 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9639 /* PL_rsfp_filters entries have fake IoDIRP() */
9640 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9641 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9642 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9643 /* I have no idea why fake dirp (rsfps)
9644 should be treated differently but otherwise
9645 we end up with leaks -- sky*/
9646 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9647 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9648 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9650 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9651 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9652 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9654 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9655 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9656 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9659 if (AvARRAY((AV*)sstr)) {
9660 SV **dst_ary, **src_ary;
9661 SSize_t items = AvFILLp((AV*)sstr) + 1;
9663 src_ary = AvARRAY((AV*)sstr);
9664 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9665 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9666 SvPV_set(dstr, (char*)dst_ary);
9667 AvALLOC((AV*)dstr) = dst_ary;
9668 if (AvREAL((AV*)sstr)) {
9670 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9674 *dst_ary++ = sv_dup(*src_ary++, param);
9676 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9677 while (items-- > 0) {
9678 *dst_ary++ = &PL_sv_undef;
9682 SvPV_set(dstr, Nullch);
9683 AvALLOC((AV*)dstr) = (SV**)NULL;
9690 if (HvARRAY((HV*)sstr)) {
9692 const bool sharekeys = !!HvSHAREKEYS(sstr);
9693 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9694 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9696 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9697 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9699 HvARRAY(dstr) = (HE**)darray;
9700 while (i <= sxhv->xhv_max) {
9701 const HE *source = HvARRAY(sstr)[i];
9702 HvARRAY(dstr)[i] = source
9703 ? he_dup(source, sharekeys, param) : 0;
9707 struct xpvhv_aux *saux = HvAUX(sstr);
9708 struct xpvhv_aux *daux = HvAUX(dstr);
9709 /* This flag isn't copied. */
9710 /* SvOOK_on(hv) attacks the IV flags. */
9711 SvFLAGS(dstr) |= SVf_OOK;
9713 hvname = saux->xhv_name;
9715 = hvname ? hek_dup(hvname, param) : hvname;
9717 daux->xhv_riter = saux->xhv_riter;
9718 daux->xhv_eiter = saux->xhv_eiter
9719 ? he_dup(saux->xhv_eiter,
9720 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9724 SvPV_set(dstr, Nullch);
9726 /* Record stashes for possible cloning in Perl_clone(). */
9728 av_push(param->stashes, dstr);
9733 /* NOTE: not refcounted */
9734 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9736 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9738 if (CvCONST(dstr)) {
9739 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9740 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9741 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9743 /* don't dup if copying back - CvGV isn't refcounted, so the
9744 * duped GV may never be freed. A bit of a hack! DAPM */
9745 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9746 Nullgv : gv_dup(CvGV(dstr), param) ;
9747 if (!(param->flags & CLONEf_COPY_STACKS)) {
9750 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9753 ? cv_dup( CvOUTSIDE(dstr), param)
9754 : cv_dup_inc(CvOUTSIDE(dstr), param);
9756 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9762 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9768 /* duplicate a context */
9771 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9776 return (PERL_CONTEXT*)NULL;
9778 /* look for it in the table first */
9779 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9783 /* create anew and remember what it is */
9784 Newxz(ncxs, max + 1, PERL_CONTEXT);
9785 ptr_table_store(PL_ptr_table, cxs, ncxs);
9788 PERL_CONTEXT *cx = &cxs[ix];
9789 PERL_CONTEXT *ncx = &ncxs[ix];
9790 ncx->cx_type = cx->cx_type;
9791 if (CxTYPE(cx) == CXt_SUBST) {
9792 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9795 ncx->blk_oldsp = cx->blk_oldsp;
9796 ncx->blk_oldcop = cx->blk_oldcop;
9797 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9798 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9799 ncx->blk_oldpm = cx->blk_oldpm;
9800 ncx->blk_gimme = cx->blk_gimme;
9801 switch (CxTYPE(cx)) {
9803 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9804 ? cv_dup_inc(cx->blk_sub.cv, param)
9805 : cv_dup(cx->blk_sub.cv,param));
9806 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9807 ? av_dup_inc(cx->blk_sub.argarray, param)
9809 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9810 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9811 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9812 ncx->blk_sub.lval = cx->blk_sub.lval;
9813 ncx->blk_sub.retop = cx->blk_sub.retop;
9816 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9817 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9818 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9819 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9820 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9821 ncx->blk_eval.retop = cx->blk_eval.retop;
9824 ncx->blk_loop.label = cx->blk_loop.label;
9825 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9826 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9827 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9828 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9829 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9830 ? cx->blk_loop.iterdata
9831 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9832 ncx->blk_loop.oldcomppad
9833 = (PAD*)ptr_table_fetch(PL_ptr_table,
9834 cx->blk_loop.oldcomppad);
9835 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9836 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9837 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9838 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9839 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9842 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9843 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9844 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9845 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9846 ncx->blk_sub.retop = cx->blk_sub.retop;
9858 /* duplicate a stack info structure */
9861 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9866 return (PERL_SI*)NULL;
9868 /* look for it in the table first */
9869 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9873 /* create anew and remember what it is */
9874 Newxz(nsi, 1, PERL_SI);
9875 ptr_table_store(PL_ptr_table, si, nsi);
9877 nsi->si_stack = av_dup_inc(si->si_stack, param);
9878 nsi->si_cxix = si->si_cxix;
9879 nsi->si_cxmax = si->si_cxmax;
9880 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9881 nsi->si_type = si->si_type;
9882 nsi->si_prev = si_dup(si->si_prev, param);
9883 nsi->si_next = si_dup(si->si_next, param);
9884 nsi->si_markoff = si->si_markoff;
9889 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9890 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9891 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9892 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9893 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9894 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9895 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9896 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9897 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9898 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9899 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9900 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9901 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9902 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9905 #define pv_dup_inc(p) SAVEPV(p)
9906 #define pv_dup(p) SAVEPV(p)
9907 #define svp_dup_inc(p,pp) any_dup(p,pp)
9909 /* map any object to the new equivent - either something in the
9910 * ptr table, or something in the interpreter structure
9914 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9921 /* look for it in the table first */
9922 ret = ptr_table_fetch(PL_ptr_table, v);
9926 /* see if it is part of the interpreter structure */
9927 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9928 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9936 /* duplicate the save stack */
9939 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9941 ANY * const ss = proto_perl->Tsavestack;
9942 const I32 max = proto_perl->Tsavestack_max;
9943 I32 ix = proto_perl->Tsavestack_ix;
9955 void (*dptr) (void*);
9956 void (*dxptr) (pTHX_ void*);
9958 Newxz(nss, max, ANY);
9961 I32 i = POPINT(ss,ix);
9964 case SAVEt_ITEM: /* normal string */
9965 sv = (SV*)POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9967 sv = (SV*)POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9970 case SAVEt_SV: /* scalar reference */
9971 sv = (SV*)POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9973 gv = (GV*)POPPTR(ss,ix);
9974 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9976 case SAVEt_GENERIC_PVREF: /* generic char* */
9977 c = (char*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = pv_dup(c);
9979 ptr = POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9982 case SAVEt_SHARED_PVREF: /* char* in shared space */
9983 c = (char*)POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = savesharedpv(c);
9985 ptr = POPPTR(ss,ix);
9986 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9988 case SAVEt_GENERIC_SVREF: /* generic sv */
9989 case SAVEt_SVREF: /* scalar reference */
9990 sv = (SV*)POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9992 ptr = POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9995 case SAVEt_AV: /* array reference */
9996 av = (AV*)POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = av_dup_inc(av, param);
9998 gv = (GV*)POPPTR(ss,ix);
9999 TOPPTR(nss,ix) = gv_dup(gv, param);
10001 case SAVEt_HV: /* hash reference */
10002 hv = (HV*)POPPTR(ss,ix);
10003 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10004 gv = (GV*)POPPTR(ss,ix);
10005 TOPPTR(nss,ix) = gv_dup(gv, param);
10007 case SAVEt_INT: /* int reference */
10008 ptr = POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10010 intval = (int)POPINT(ss,ix);
10011 TOPINT(nss,ix) = intval;
10013 case SAVEt_LONG: /* long reference */
10014 ptr = POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10016 longval = (long)POPLONG(ss,ix);
10017 TOPLONG(nss,ix) = longval;
10019 case SAVEt_I32: /* I32 reference */
10020 case SAVEt_I16: /* I16 reference */
10021 case SAVEt_I8: /* I8 reference */
10022 ptr = POPPTR(ss,ix);
10023 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10025 TOPINT(nss,ix) = i;
10027 case SAVEt_IV: /* IV reference */
10028 ptr = POPPTR(ss,ix);
10029 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10031 TOPIV(nss,ix) = iv;
10033 case SAVEt_SPTR: /* SV* reference */
10034 ptr = POPPTR(ss,ix);
10035 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10036 sv = (SV*)POPPTR(ss,ix);
10037 TOPPTR(nss,ix) = sv_dup(sv, param);
10039 case SAVEt_VPTR: /* random* reference */
10040 ptr = POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10042 ptr = POPPTR(ss,ix);
10043 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10045 case SAVEt_PPTR: /* char* reference */
10046 ptr = POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10048 c = (char*)POPPTR(ss,ix);
10049 TOPPTR(nss,ix) = pv_dup(c);
10051 case SAVEt_HPTR: /* HV* reference */
10052 ptr = POPPTR(ss,ix);
10053 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10054 hv = (HV*)POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = hv_dup(hv, param);
10057 case SAVEt_APTR: /* AV* reference */
10058 ptr = POPPTR(ss,ix);
10059 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10060 av = (AV*)POPPTR(ss,ix);
10061 TOPPTR(nss,ix) = av_dup(av, param);
10064 gv = (GV*)POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = gv_dup(gv, param);
10067 case SAVEt_GP: /* scalar reference */
10068 gp = (GP*)POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10070 (void)GpREFCNT_inc(gp);
10071 gv = (GV*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10073 c = (char*)POPPTR(ss,ix);
10074 TOPPTR(nss,ix) = pv_dup(c);
10076 TOPIV(nss,ix) = iv;
10078 TOPIV(nss,ix) = iv;
10081 case SAVEt_MORTALIZESV:
10082 sv = (SV*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10086 ptr = POPPTR(ss,ix);
10087 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10088 /* these are assumed to be refcounted properly */
10090 switch (((OP*)ptr)->op_type) {
10092 case OP_LEAVESUBLV:
10096 case OP_LEAVEWRITE:
10097 TOPPTR(nss,ix) = ptr;
10102 TOPPTR(nss,ix) = Nullop;
10107 TOPPTR(nss,ix) = Nullop;
10110 c = (char*)POPPTR(ss,ix);
10111 TOPPTR(nss,ix) = pv_dup_inc(c);
10113 case SAVEt_CLEARSV:
10114 longval = POPLONG(ss,ix);
10115 TOPLONG(nss,ix) = longval;
10118 hv = (HV*)POPPTR(ss,ix);
10119 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10120 c = (char*)POPPTR(ss,ix);
10121 TOPPTR(nss,ix) = pv_dup_inc(c);
10123 TOPINT(nss,ix) = i;
10125 case SAVEt_DESTRUCTOR:
10126 ptr = POPPTR(ss,ix);
10127 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10128 dptr = POPDPTR(ss,ix);
10129 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10130 any_dup(FPTR2DPTR(void *, dptr),
10133 case SAVEt_DESTRUCTOR_X:
10134 ptr = POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10136 dxptr = POPDXPTR(ss,ix);
10137 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10138 any_dup(FPTR2DPTR(void *, dxptr),
10141 case SAVEt_REGCONTEXT:
10144 TOPINT(nss,ix) = i;
10147 case SAVEt_STACK_POS: /* Position on Perl stack */
10149 TOPINT(nss,ix) = i;
10151 case SAVEt_AELEM: /* array element */
10152 sv = (SV*)POPPTR(ss,ix);
10153 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10155 TOPINT(nss,ix) = i;
10156 av = (AV*)POPPTR(ss,ix);
10157 TOPPTR(nss,ix) = av_dup_inc(av, param);
10159 case SAVEt_HELEM: /* hash element */
10160 sv = (SV*)POPPTR(ss,ix);
10161 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10162 sv = (SV*)POPPTR(ss,ix);
10163 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10164 hv = (HV*)POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10168 ptr = POPPTR(ss,ix);
10169 TOPPTR(nss,ix) = ptr;
10173 TOPINT(nss,ix) = i;
10175 case SAVEt_COMPPAD:
10176 av = (AV*)POPPTR(ss,ix);
10177 TOPPTR(nss,ix) = av_dup(av, param);
10180 longval = (long)POPLONG(ss,ix);
10181 TOPLONG(nss,ix) = longval;
10182 ptr = POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10184 sv = (SV*)POPPTR(ss,ix);
10185 TOPPTR(nss,ix) = sv_dup(sv, param);
10188 ptr = POPPTR(ss,ix);
10189 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10190 longval = (long)POPBOOL(ss,ix);
10191 TOPBOOL(nss,ix) = (bool)longval;
10193 case SAVEt_SET_SVFLAGS:
10195 TOPINT(nss,ix) = i;
10197 TOPINT(nss,ix) = i;
10198 sv = (SV*)POPPTR(ss,ix);
10199 TOPPTR(nss,ix) = sv_dup(sv, param);
10202 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10210 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10211 * flag to the result. This is done for each stash before cloning starts,
10212 * so we know which stashes want their objects cloned */
10215 do_mark_cloneable_stash(pTHX_ SV *sv)
10217 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10219 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10220 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10221 if (cloner && GvCV(cloner)) {
10228 XPUSHs(sv_2mortal(newSVhek(hvname)));
10230 call_sv((SV*)GvCV(cloner), G_SCALAR);
10237 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10245 =for apidoc perl_clone
10247 Create and return a new interpreter by cloning the current one.
10249 perl_clone takes these flags as parameters:
10251 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10252 without it we only clone the data and zero the stacks,
10253 with it we copy the stacks and the new perl interpreter is
10254 ready to run at the exact same point as the previous one.
10255 The pseudo-fork code uses COPY_STACKS while the
10256 threads->new doesn't.
10258 CLONEf_KEEP_PTR_TABLE
10259 perl_clone keeps a ptr_table with the pointer of the old
10260 variable as a key and the new variable as a value,
10261 this allows it to check if something has been cloned and not
10262 clone it again but rather just use the value and increase the
10263 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10264 the ptr_table using the function
10265 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10266 reason to keep it around is if you want to dup some of your own
10267 variable who are outside the graph perl scans, example of this
10268 code is in threads.xs create
10271 This is a win32 thing, it is ignored on unix, it tells perls
10272 win32host code (which is c++) to clone itself, this is needed on
10273 win32 if you want to run two threads at the same time,
10274 if you just want to do some stuff in a separate perl interpreter
10275 and then throw it away and return to the original one,
10276 you don't need to do anything.
10281 /* XXX the above needs expanding by someone who actually understands it ! */
10282 EXTERN_C PerlInterpreter *
10283 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10286 perl_clone(PerlInterpreter *proto_perl, UV flags)
10289 #ifdef PERL_IMPLICIT_SYS
10291 /* perlhost.h so we need to call into it
10292 to clone the host, CPerlHost should have a c interface, sky */
10294 if (flags & CLONEf_CLONE_HOST) {
10295 return perl_clone_host(proto_perl,flags);
10297 return perl_clone_using(proto_perl, flags,
10299 proto_perl->IMemShared,
10300 proto_perl->IMemParse,
10302 proto_perl->IStdIO,
10306 proto_perl->IProc);
10310 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10311 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10312 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10313 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10314 struct IPerlDir* ipD, struct IPerlSock* ipS,
10315 struct IPerlProc* ipP)
10317 /* XXX many of the string copies here can be optimized if they're
10318 * constants; they need to be allocated as common memory and just
10319 * their pointers copied. */
10322 CLONE_PARAMS clone_params;
10323 CLONE_PARAMS* param = &clone_params;
10325 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10326 /* for each stash, determine whether its objects should be cloned */
10327 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10328 PERL_SET_THX(my_perl);
10331 Poison(my_perl, 1, PerlInterpreter);
10333 PL_curcop = (COP *)Nullop;
10337 PL_savestack_ix = 0;
10338 PL_savestack_max = -1;
10339 PL_sig_pending = 0;
10340 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10341 # else /* !DEBUGGING */
10342 Zero(my_perl, 1, PerlInterpreter);
10343 # endif /* DEBUGGING */
10345 /* host pointers */
10347 PL_MemShared = ipMS;
10348 PL_MemParse = ipMP;
10355 #else /* !PERL_IMPLICIT_SYS */
10357 CLONE_PARAMS clone_params;
10358 CLONE_PARAMS* param = &clone_params;
10359 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10360 /* for each stash, determine whether its objects should be cloned */
10361 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10362 PERL_SET_THX(my_perl);
10365 Poison(my_perl, 1, PerlInterpreter);
10367 PL_curcop = (COP *)Nullop;
10371 PL_savestack_ix = 0;
10372 PL_savestack_max = -1;
10373 PL_sig_pending = 0;
10374 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10375 # else /* !DEBUGGING */
10376 Zero(my_perl, 1, PerlInterpreter);
10377 # endif /* DEBUGGING */
10378 #endif /* PERL_IMPLICIT_SYS */
10379 param->flags = flags;
10380 param->proto_perl = proto_perl;
10382 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10383 Zero(&PL_body_roots, 1, PL_body_roots);
10385 PL_nice_chunk = NULL;
10386 PL_nice_chunk_size = 0;
10388 PL_sv_objcount = 0;
10389 PL_sv_root = Nullsv;
10390 PL_sv_arenaroot = Nullsv;
10392 PL_debug = proto_perl->Idebug;
10394 PL_hash_seed = proto_perl->Ihash_seed;
10395 PL_rehash_seed = proto_perl->Irehash_seed;
10397 #ifdef USE_REENTRANT_API
10398 /* XXX: things like -Dm will segfault here in perlio, but doing
10399 * PERL_SET_CONTEXT(proto_perl);
10400 * breaks too many other things
10402 Perl_reentrant_init(aTHX);
10405 /* create SV map for pointer relocation */
10406 PL_ptr_table = ptr_table_new();
10408 /* initialize these special pointers as early as possible */
10409 SvANY(&PL_sv_undef) = NULL;
10410 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10411 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10412 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10414 SvANY(&PL_sv_no) = new_XPVNV();
10415 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10416 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10417 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10418 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10419 SvCUR_set(&PL_sv_no, 0);
10420 SvLEN_set(&PL_sv_no, 1);
10421 SvIV_set(&PL_sv_no, 0);
10422 SvNV_set(&PL_sv_no, 0);
10423 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10425 SvANY(&PL_sv_yes) = new_XPVNV();
10426 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10427 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10428 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10429 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10430 SvCUR_set(&PL_sv_yes, 1);
10431 SvLEN_set(&PL_sv_yes, 2);
10432 SvIV_set(&PL_sv_yes, 1);
10433 SvNV_set(&PL_sv_yes, 1);
10434 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10436 /* create (a non-shared!) shared string table */
10437 PL_strtab = newHV();
10438 HvSHAREKEYS_off(PL_strtab);
10439 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10440 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10442 PL_compiling = proto_perl->Icompiling;
10444 /* These two PVs will be free'd special way so must set them same way op.c does */
10445 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10446 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10448 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10449 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10451 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10452 if (!specialWARN(PL_compiling.cop_warnings))
10453 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10454 if (!specialCopIO(PL_compiling.cop_io))
10455 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10456 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10458 /* pseudo environmental stuff */
10459 PL_origargc = proto_perl->Iorigargc;
10460 PL_origargv = proto_perl->Iorigargv;
10462 param->stashes = newAV(); /* Setup array of objects to call clone on */
10464 /* Set tainting stuff before PerlIO_debug can possibly get called */
10465 PL_tainting = proto_perl->Itainting;
10466 PL_taint_warn = proto_perl->Itaint_warn;
10468 #ifdef PERLIO_LAYERS
10469 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10470 PerlIO_clone(aTHX_ proto_perl, param);
10473 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10474 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10475 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10476 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10477 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10478 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10481 PL_minus_c = proto_perl->Iminus_c;
10482 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10483 PL_localpatches = proto_perl->Ilocalpatches;
10484 PL_splitstr = proto_perl->Isplitstr;
10485 PL_preprocess = proto_perl->Ipreprocess;
10486 PL_minus_n = proto_perl->Iminus_n;
10487 PL_minus_p = proto_perl->Iminus_p;
10488 PL_minus_l = proto_perl->Iminus_l;
10489 PL_minus_a = proto_perl->Iminus_a;
10490 PL_minus_F = proto_perl->Iminus_F;
10491 PL_doswitches = proto_perl->Idoswitches;
10492 PL_dowarn = proto_perl->Idowarn;
10493 PL_doextract = proto_perl->Idoextract;
10494 PL_sawampersand = proto_perl->Isawampersand;
10495 PL_unsafe = proto_perl->Iunsafe;
10496 PL_inplace = SAVEPV(proto_perl->Iinplace);
10497 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10498 PL_perldb = proto_perl->Iperldb;
10499 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10500 PL_exit_flags = proto_perl->Iexit_flags;
10502 /* magical thingies */
10503 /* XXX time(&PL_basetime) when asked for? */
10504 PL_basetime = proto_perl->Ibasetime;
10505 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10507 PL_maxsysfd = proto_perl->Imaxsysfd;
10508 PL_multiline = proto_perl->Imultiline;
10509 PL_statusvalue = proto_perl->Istatusvalue;
10511 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10513 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10515 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10517 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10518 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10519 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10521 /* Clone the regex array */
10522 PL_regex_padav = newAV();
10524 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10525 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10527 av_push(PL_regex_padav,
10528 sv_dup_inc(regexen[0],param));
10529 for(i = 1; i <= len; i++) {
10530 if(SvREPADTMP(regexen[i])) {
10531 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10533 av_push(PL_regex_padav,
10535 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10536 SvIVX(regexen[i])), param)))
10541 PL_regex_pad = AvARRAY(PL_regex_padav);
10543 /* shortcuts to various I/O objects */
10544 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10545 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10546 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10547 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10548 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10549 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10551 /* shortcuts to regexp stuff */
10552 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10554 /* shortcuts to misc objects */
10555 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10557 /* shortcuts to debugging objects */
10558 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10559 PL_DBline = gv_dup(proto_perl->IDBline, param);
10560 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10561 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10562 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10563 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10564 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10565 PL_lineary = av_dup(proto_perl->Ilineary, param);
10566 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10568 /* symbol tables */
10569 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10570 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10571 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10572 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10573 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10575 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10576 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10577 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10578 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10579 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10580 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10582 PL_sub_generation = proto_perl->Isub_generation;
10584 /* funky return mechanisms */
10585 PL_forkprocess = proto_perl->Iforkprocess;
10587 /* subprocess state */
10588 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10590 /* internal state */
10591 PL_maxo = proto_perl->Imaxo;
10592 if (proto_perl->Iop_mask)
10593 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10595 PL_op_mask = Nullch;
10596 /* PL_asserting = proto_perl->Iasserting; */
10598 /* current interpreter roots */
10599 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10600 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10601 PL_main_start = proto_perl->Imain_start;
10602 PL_eval_root = proto_perl->Ieval_root;
10603 PL_eval_start = proto_perl->Ieval_start;
10605 /* runtime control stuff */
10606 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10607 PL_copline = proto_perl->Icopline;
10609 PL_filemode = proto_perl->Ifilemode;
10610 PL_lastfd = proto_perl->Ilastfd;
10611 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10614 PL_gensym = proto_perl->Igensym;
10615 PL_preambled = proto_perl->Ipreambled;
10616 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10617 PL_laststatval = proto_perl->Ilaststatval;
10618 PL_laststype = proto_perl->Ilaststype;
10619 PL_mess_sv = Nullsv;
10621 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10623 /* interpreter atexit processing */
10624 PL_exitlistlen = proto_perl->Iexitlistlen;
10625 if (PL_exitlistlen) {
10626 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10627 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10630 PL_exitlist = (PerlExitListEntry*)NULL;
10631 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10632 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10633 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10635 PL_profiledata = NULL;
10636 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10637 /* PL_rsfp_filters entries have fake IoDIRP() */
10638 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10640 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10642 PAD_CLONE_VARS(proto_perl, param);
10644 #ifdef HAVE_INTERP_INTERN
10645 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10648 /* more statics moved here */
10649 PL_generation = proto_perl->Igeneration;
10650 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10652 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10653 PL_in_clean_all = proto_perl->Iin_clean_all;
10655 PL_uid = proto_perl->Iuid;
10656 PL_euid = proto_perl->Ieuid;
10657 PL_gid = proto_perl->Igid;
10658 PL_egid = proto_perl->Iegid;
10659 PL_nomemok = proto_perl->Inomemok;
10660 PL_an = proto_perl->Ian;
10661 PL_evalseq = proto_perl->Ievalseq;
10662 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10663 PL_origalen = proto_perl->Iorigalen;
10664 #ifdef PERL_USES_PL_PIDSTATUS
10665 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10667 PL_osname = SAVEPV(proto_perl->Iosname);
10668 PL_sighandlerp = proto_perl->Isighandlerp;
10670 PL_runops = proto_perl->Irunops;
10672 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10675 PL_cshlen = proto_perl->Icshlen;
10676 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10679 PL_lex_state = proto_perl->Ilex_state;
10680 PL_lex_defer = proto_perl->Ilex_defer;
10681 PL_lex_expect = proto_perl->Ilex_expect;
10682 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10683 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10684 PL_lex_starts = proto_perl->Ilex_starts;
10685 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10686 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10687 PL_lex_op = proto_perl->Ilex_op;
10688 PL_lex_inpat = proto_perl->Ilex_inpat;
10689 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10690 PL_lex_brackets = proto_perl->Ilex_brackets;
10691 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10692 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10693 PL_lex_casemods = proto_perl->Ilex_casemods;
10694 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10695 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10697 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10698 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10699 PL_nexttoke = proto_perl->Inexttoke;
10701 /* XXX This is probably masking the deeper issue of why
10702 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10703 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10704 * (A little debugging with a watchpoint on it may help.)
10706 if (SvANY(proto_perl->Ilinestr)) {
10707 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10708 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10709 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10710 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10711 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10712 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10713 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10714 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10715 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10718 PL_linestr = NEWSV(65,79);
10719 sv_upgrade(PL_linestr,SVt_PVIV);
10720 sv_setpvn(PL_linestr,"",0);
10721 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10723 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10724 PL_pending_ident = proto_perl->Ipending_ident;
10725 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10727 PL_expect = proto_perl->Iexpect;
10729 PL_multi_start = proto_perl->Imulti_start;
10730 PL_multi_end = proto_perl->Imulti_end;
10731 PL_multi_open = proto_perl->Imulti_open;
10732 PL_multi_close = proto_perl->Imulti_close;
10734 PL_error_count = proto_perl->Ierror_count;
10735 PL_subline = proto_perl->Isubline;
10736 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10738 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10739 if (SvANY(proto_perl->Ilinestr)) {
10740 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10741 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10742 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10743 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10744 PL_last_lop_op = proto_perl->Ilast_lop_op;
10747 PL_last_uni = SvPVX(PL_linestr);
10748 PL_last_lop = SvPVX(PL_linestr);
10749 PL_last_lop_op = 0;
10751 PL_in_my = proto_perl->Iin_my;
10752 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10754 PL_cryptseen = proto_perl->Icryptseen;
10757 PL_hints = proto_perl->Ihints;
10759 PL_amagic_generation = proto_perl->Iamagic_generation;
10761 #ifdef USE_LOCALE_COLLATE
10762 PL_collation_ix = proto_perl->Icollation_ix;
10763 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10764 PL_collation_standard = proto_perl->Icollation_standard;
10765 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10766 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10767 #endif /* USE_LOCALE_COLLATE */
10769 #ifdef USE_LOCALE_NUMERIC
10770 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10771 PL_numeric_standard = proto_perl->Inumeric_standard;
10772 PL_numeric_local = proto_perl->Inumeric_local;
10773 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10774 #endif /* !USE_LOCALE_NUMERIC */
10776 /* utf8 character classes */
10777 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10778 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10779 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10780 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10781 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10782 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10783 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10784 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10785 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10786 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10787 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10788 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10789 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10790 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10791 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10792 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10793 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10794 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10795 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10796 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10798 /* Did the locale setup indicate UTF-8? */
10799 PL_utf8locale = proto_perl->Iutf8locale;
10800 /* Unicode features (see perlrun/-C) */
10801 PL_unicode = proto_perl->Iunicode;
10803 /* Pre-5.8 signals control */
10804 PL_signals = proto_perl->Isignals;
10806 /* times() ticks per second */
10807 PL_clocktick = proto_perl->Iclocktick;
10809 /* Recursion stopper for PerlIO_find_layer */
10810 PL_in_load_module = proto_perl->Iin_load_module;
10812 /* sort() routine */
10813 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10815 /* Not really needed/useful since the reenrant_retint is "volatile",
10816 * but do it for consistency's sake. */
10817 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10819 /* Hooks to shared SVs and locks. */
10820 PL_sharehook = proto_perl->Isharehook;
10821 PL_lockhook = proto_perl->Ilockhook;
10822 PL_unlockhook = proto_perl->Iunlockhook;
10823 PL_threadhook = proto_perl->Ithreadhook;
10825 PL_runops_std = proto_perl->Irunops_std;
10826 PL_runops_dbg = proto_perl->Irunops_dbg;
10828 #ifdef THREADS_HAVE_PIDS
10829 PL_ppid = proto_perl->Ippid;
10833 PL_last_swash_hv = Nullhv; /* reinits on demand */
10834 PL_last_swash_klen = 0;
10835 PL_last_swash_key[0]= '\0';
10836 PL_last_swash_tmps = (U8*)NULL;
10837 PL_last_swash_slen = 0;
10839 PL_glob_index = proto_perl->Iglob_index;
10840 PL_srand_called = proto_perl->Isrand_called;
10841 PL_uudmap['M'] = 0; /* reinits on demand */
10842 PL_bitcount = Nullch; /* reinits on demand */
10844 if (proto_perl->Ipsig_pend) {
10845 Newxz(PL_psig_pend, SIG_SIZE, int);
10848 PL_psig_pend = (int*)NULL;
10851 if (proto_perl->Ipsig_ptr) {
10852 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10853 Newxz(PL_psig_name, SIG_SIZE, SV*);
10854 for (i = 1; i < SIG_SIZE; i++) {
10855 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10856 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10860 PL_psig_ptr = (SV**)NULL;
10861 PL_psig_name = (SV**)NULL;
10864 /* thrdvar.h stuff */
10866 if (flags & CLONEf_COPY_STACKS) {
10867 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10868 PL_tmps_ix = proto_perl->Ttmps_ix;
10869 PL_tmps_max = proto_perl->Ttmps_max;
10870 PL_tmps_floor = proto_perl->Ttmps_floor;
10871 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10873 while (i <= PL_tmps_ix) {
10874 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10878 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10879 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10880 Newxz(PL_markstack, i, I32);
10881 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10882 - proto_perl->Tmarkstack);
10883 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10884 - proto_perl->Tmarkstack);
10885 Copy(proto_perl->Tmarkstack, PL_markstack,
10886 PL_markstack_ptr - PL_markstack + 1, I32);
10888 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10889 * NOTE: unlike the others! */
10890 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10891 PL_scopestack_max = proto_perl->Tscopestack_max;
10892 Newxz(PL_scopestack, PL_scopestack_max, I32);
10893 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10895 /* NOTE: si_dup() looks at PL_markstack */
10896 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10898 /* PL_curstack = PL_curstackinfo->si_stack; */
10899 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10900 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10902 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10903 PL_stack_base = AvARRAY(PL_curstack);
10904 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10905 - proto_perl->Tstack_base);
10906 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10908 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10909 * NOTE: unlike the others! */
10910 PL_savestack_ix = proto_perl->Tsavestack_ix;
10911 PL_savestack_max = proto_perl->Tsavestack_max;
10912 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10913 PL_savestack = ss_dup(proto_perl, param);
10917 ENTER; /* perl_destruct() wants to LEAVE; */
10920 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10921 PL_top_env = &PL_start_env;
10923 PL_op = proto_perl->Top;
10926 PL_Xpv = (XPV*)NULL;
10927 PL_na = proto_perl->Tna;
10929 PL_statbuf = proto_perl->Tstatbuf;
10930 PL_statcache = proto_perl->Tstatcache;
10931 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10932 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10934 PL_timesbuf = proto_perl->Ttimesbuf;
10937 PL_tainted = proto_perl->Ttainted;
10938 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10939 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10940 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10941 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10942 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10943 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10944 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10945 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10946 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10948 PL_restartop = proto_perl->Trestartop;
10949 PL_in_eval = proto_perl->Tin_eval;
10950 PL_delaymagic = proto_perl->Tdelaymagic;
10951 PL_dirty = proto_perl->Tdirty;
10952 PL_localizing = proto_perl->Tlocalizing;
10954 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10955 PL_hv_fetch_ent_mh = Nullhe;
10956 PL_modcount = proto_perl->Tmodcount;
10957 PL_lastgotoprobe = Nullop;
10958 PL_dumpindent = proto_perl->Tdumpindent;
10960 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10961 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10962 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10963 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10964 PL_efloatbuf = Nullch; /* reinits on demand */
10965 PL_efloatsize = 0; /* reinits on demand */
10969 PL_screamfirst = NULL;
10970 PL_screamnext = NULL;
10971 PL_maxscream = -1; /* reinits on demand */
10972 PL_lastscream = Nullsv;
10974 PL_watchaddr = NULL;
10975 PL_watchok = Nullch;
10977 PL_regdummy = proto_perl->Tregdummy;
10978 PL_regprecomp = Nullch;
10981 PL_colorset = 0; /* reinits PL_colors[] */
10982 /*PL_colors[6] = {0,0,0,0,0,0};*/
10983 PL_reginput = Nullch;
10984 PL_regbol = Nullch;
10985 PL_regeol = Nullch;
10986 PL_regstartp = (I32*)NULL;
10987 PL_regendp = (I32*)NULL;
10988 PL_reglastparen = (U32*)NULL;
10989 PL_reglastcloseparen = (U32*)NULL;
10990 PL_regtill = Nullch;
10991 PL_reg_start_tmp = (char**)NULL;
10992 PL_reg_start_tmpl = 0;
10993 PL_regdata = (struct reg_data*)NULL;
10996 PL_reg_eval_set = 0;
10998 PL_regprogram = (regnode*)NULL;
11000 PL_regcc = (CURCUR*)NULL;
11001 PL_reg_call_cc = (struct re_cc_state*)NULL;
11002 PL_reg_re = (regexp*)NULL;
11003 PL_reg_ganch = Nullch;
11004 PL_reg_sv = Nullsv;
11005 PL_reg_match_utf8 = FALSE;
11006 PL_reg_magic = (MAGIC*)NULL;
11008 PL_reg_oldcurpm = (PMOP*)NULL;
11009 PL_reg_curpm = (PMOP*)NULL;
11010 PL_reg_oldsaved = Nullch;
11011 PL_reg_oldsavedlen = 0;
11012 #ifdef PERL_OLD_COPY_ON_WRITE
11015 PL_reg_maxiter = 0;
11016 PL_reg_leftiter = 0;
11017 PL_reg_poscache = Nullch;
11018 PL_reg_poscache_size= 0;
11020 /* RE engine - function pointers */
11021 PL_regcompp = proto_perl->Tregcompp;
11022 PL_regexecp = proto_perl->Tregexecp;
11023 PL_regint_start = proto_perl->Tregint_start;
11024 PL_regint_string = proto_perl->Tregint_string;
11025 PL_regfree = proto_perl->Tregfree;
11027 PL_reginterp_cnt = 0;
11028 PL_reg_starttry = 0;
11030 /* Pluggable optimizer */
11031 PL_peepp = proto_perl->Tpeepp;
11033 PL_stashcache = newHV();
11035 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11036 ptr_table_free(PL_ptr_table);
11037 PL_ptr_table = NULL;
11040 /* Call the ->CLONE method, if it exists, for each of the stashes
11041 identified by sv_dup() above.
11043 while(av_len(param->stashes) != -1) {
11044 HV* const stash = (HV*) av_shift(param->stashes);
11045 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11046 if (cloner && GvCV(cloner)) {
11051 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11053 call_sv((SV*)GvCV(cloner), G_DISCARD);
11059 SvREFCNT_dec(param->stashes);
11061 /* orphaned? eg threads->new inside BEGIN or use */
11062 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11063 (void)SvREFCNT_inc(PL_compcv);
11064 SAVEFREESV(PL_compcv);
11070 #endif /* USE_ITHREADS */
11073 =head1 Unicode Support
11075 =for apidoc sv_recode_to_utf8
11077 The encoding is assumed to be an Encode object, on entry the PV
11078 of the sv is assumed to be octets in that encoding, and the sv
11079 will be converted into Unicode (and UTF-8).
11081 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11082 is not a reference, nothing is done to the sv. If the encoding is not
11083 an C<Encode::XS> Encoding object, bad things will happen.
11084 (See F<lib/encoding.pm> and L<Encode>).
11086 The PV of the sv is returned.
11091 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11094 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11108 Passing sv_yes is wrong - it needs to be or'ed set of constants
11109 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11110 remove converted chars from source.
11112 Both will default the value - let them.
11114 XPUSHs(&PL_sv_yes);
11117 call_method("decode", G_SCALAR);
11121 s = SvPV_const(uni, len);
11122 if (s != SvPVX_const(sv)) {
11123 SvGROW(sv, len + 1);
11124 Move(s, SvPVX(sv), len + 1, char);
11125 SvCUR_set(sv, len);
11132 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11136 =for apidoc sv_cat_decode
11138 The encoding is assumed to be an Encode object, the PV of the ssv is
11139 assumed to be octets in that encoding and decoding the input starts
11140 from the position which (PV + *offset) pointed to. The dsv will be
11141 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11142 when the string tstr appears in decoding output or the input ends on
11143 the PV of the ssv. The value which the offset points will be modified
11144 to the last input position on the ssv.
11146 Returns TRUE if the terminator was found, else returns FALSE.
11151 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11152 SV *ssv, int *offset, char *tstr, int tlen)
11156 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11167 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11168 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11170 call_method("cat_decode", G_SCALAR);
11172 ret = SvTRUE(TOPs);
11173 *offset = SvIV(offsv);
11179 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11184 /* ---------------------------------------------------------------------
11186 * support functions for report_uninit()
11189 /* the maxiumum size of array or hash where we will scan looking
11190 * for the undefined element that triggered the warning */
11192 #define FUV_MAX_SEARCH_SIZE 1000
11194 /* Look for an entry in the hash whose value has the same SV as val;
11195 * If so, return a mortal copy of the key. */
11198 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11201 register HE **array;
11204 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11205 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11208 array = HvARRAY(hv);
11210 for (i=HvMAX(hv); i>0; i--) {
11211 register HE *entry;
11212 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11213 if (HeVAL(entry) != val)
11215 if ( HeVAL(entry) == &PL_sv_undef ||
11216 HeVAL(entry) == &PL_sv_placeholder)
11220 if (HeKLEN(entry) == HEf_SVKEY)
11221 return sv_mortalcopy(HeKEY_sv(entry));
11222 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11228 /* Look for an entry in the array whose value has the same SV as val;
11229 * If so, return the index, otherwise return -1. */
11232 S_find_array_subscript(pTHX_ AV *av, SV* val)
11236 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11237 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11241 for (i=AvFILLp(av); i>=0; i--) {
11242 if (svp[i] == val && svp[i] != &PL_sv_undef)
11248 /* S_varname(): return the name of a variable, optionally with a subscript.
11249 * If gv is non-zero, use the name of that global, along with gvtype (one
11250 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11251 * targ. Depending on the value of the subscript_type flag, return:
11254 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11255 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11256 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11257 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11260 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11261 SV* keyname, I32 aindex, int subscript_type)
11264 SV * const name = sv_newmortal();
11267 buffer[0] = gvtype;
11270 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11272 gv_fullname4(name, gv, buffer, 0);
11274 if ((unsigned int)SvPVX(name)[1] <= 26) {
11276 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11278 /* Swap the 1 unprintable control character for the 2 byte pretty
11279 version - ie substr($name, 1, 1) = $buffer; */
11280 sv_insert(name, 1, 1, buffer, 2);
11285 CV * const cv = find_runcv(&unused);
11289 if (!cv || !CvPADLIST(cv))
11291 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11292 sv = *av_fetch(av, targ, FALSE);
11293 /* SvLEN in a pad name is not to be trusted */
11294 sv_setpv(name, SvPV_nolen_const(sv));
11297 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11298 SV * const sv = NEWSV(0,0);
11299 *SvPVX(name) = '$';
11300 Perl_sv_catpvf(aTHX_ name, "{%s}",
11301 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11304 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11305 *SvPVX(name) = '$';
11306 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11308 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11309 sv_insert(name, 0, 0, "within ", 7);
11316 =for apidoc find_uninit_var
11318 Find the name of the undefined variable (if any) that caused the operator o
11319 to issue a "Use of uninitialized value" warning.
11320 If match is true, only return a name if it's value matches uninit_sv.
11321 So roughly speaking, if a unary operator (such as OP_COS) generates a
11322 warning, then following the direct child of the op may yield an
11323 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11324 other hand, with OP_ADD there are two branches to follow, so we only print
11325 the variable name if we get an exact match.
11327 The name is returned as a mortal SV.
11329 Assumes that PL_op is the op that originally triggered the error, and that
11330 PL_comppad/PL_curpad points to the currently executing pad.
11336 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11344 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11345 uninit_sv == &PL_sv_placeholder)))
11348 switch (obase->op_type) {
11355 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11356 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11358 SV *keysv = Nullsv;
11359 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11361 if (pad) { /* @lex, %lex */
11362 sv = PAD_SVl(obase->op_targ);
11366 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11367 /* @global, %global */
11368 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11371 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11373 else /* @{expr}, %{expr} */
11374 return find_uninit_var(cUNOPx(obase)->op_first,
11378 /* attempt to find a match within the aggregate */
11380 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11382 subscript_type = FUV_SUBSCRIPT_HASH;
11385 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11387 subscript_type = FUV_SUBSCRIPT_ARRAY;
11390 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11393 return varname(gv, hash ? '%' : '@', obase->op_targ,
11394 keysv, index, subscript_type);
11398 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11400 return varname(Nullgv, '$', obase->op_targ,
11401 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11404 gv = cGVOPx_gv(obase);
11405 if (!gv || (match && GvSV(gv) != uninit_sv))
11407 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11410 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11413 av = (AV*)PAD_SV(obase->op_targ);
11414 if (!av || SvRMAGICAL(av))
11416 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11417 if (!svp || *svp != uninit_sv)
11420 return varname(Nullgv, '$', obase->op_targ,
11421 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11424 gv = cGVOPx_gv(obase);
11430 if (!av || SvRMAGICAL(av))
11432 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11433 if (!svp || *svp != uninit_sv)
11436 return varname(gv, '$', 0,
11437 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11442 o = cUNOPx(obase)->op_first;
11443 if (!o || o->op_type != OP_NULL ||
11444 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11446 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11450 if (PL_op == obase)
11451 /* $a[uninit_expr] or $h{uninit_expr} */
11452 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11455 o = cBINOPx(obase)->op_first;
11456 kid = cBINOPx(obase)->op_last;
11458 /* get the av or hv, and optionally the gv */
11460 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11461 sv = PAD_SV(o->op_targ);
11463 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11464 && cUNOPo->op_first->op_type == OP_GV)
11466 gv = cGVOPx_gv(cUNOPo->op_first);
11469 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11474 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11475 /* index is constant */
11479 if (obase->op_type == OP_HELEM) {
11480 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11481 if (!he || HeVAL(he) != uninit_sv)
11485 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11486 if (!svp || *svp != uninit_sv)
11490 if (obase->op_type == OP_HELEM)
11491 return varname(gv, '%', o->op_targ,
11492 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11494 return varname(gv, '@', o->op_targ, Nullsv,
11495 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11499 /* index is an expression;
11500 * attempt to find a match within the aggregate */
11501 if (obase->op_type == OP_HELEM) {
11502 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11504 return varname(gv, '%', o->op_targ,
11505 keysv, 0, FUV_SUBSCRIPT_HASH);
11508 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11510 return varname(gv, '@', o->op_targ,
11511 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11516 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11518 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11524 /* only examine RHS */
11525 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11528 o = cUNOPx(obase)->op_first;
11529 if (o->op_type == OP_PUSHMARK)
11532 if (!o->op_sibling) {
11533 /* one-arg version of open is highly magical */
11535 if (o->op_type == OP_GV) { /* open FOO; */
11537 if (match && GvSV(gv) != uninit_sv)
11539 return varname(gv, '$', 0,
11540 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11542 /* other possibilities not handled are:
11543 * open $x; or open my $x; should return '${*$x}'
11544 * open expr; should return '$'.expr ideally
11550 /* ops where $_ may be an implicit arg */
11554 if ( !(obase->op_flags & OPf_STACKED)) {
11555 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11556 ? PAD_SVl(obase->op_targ)
11559 sv = sv_newmortal();
11560 sv_setpvn(sv, "$_", 2);
11568 /* skip filehandle as it can't produce 'undef' warning */
11569 o = cUNOPx(obase)->op_first;
11570 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11571 o = o->op_sibling->op_sibling;
11578 match = 1; /* XS or custom code could trigger random warnings */
11583 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11584 return sv_2mortal(newSVpvn("${$/}", 5));
11589 if (!(obase->op_flags & OPf_KIDS))
11591 o = cUNOPx(obase)->op_first;
11597 /* if all except one arg are constant, or have no side-effects,
11598 * or are optimized away, then it's unambiguous */
11600 for (kid=o; kid; kid = kid->op_sibling) {
11602 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11603 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11604 || (kid->op_type == OP_PUSHMARK)
11608 if (o2) { /* more than one found */
11615 return find_uninit_var(o2, uninit_sv, match);
11617 /* scan all args */
11619 sv = find_uninit_var(o, uninit_sv, 1);
11631 =for apidoc report_uninit
11633 Print appropriate "Use of uninitialized variable" warning
11639 Perl_report_uninit(pTHX_ SV* uninit_sv)
11642 SV* varname = Nullsv;
11644 varname = find_uninit_var(PL_op, uninit_sv,0);
11646 sv_insert(varname, 0, 0, " ", 1);
11648 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11649 varname ? SvPV_nolen_const(varname) : "",
11650 " in ", OP_DESC(PL_op));
11653 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11659 * c-indentation-style: bsd
11660 * c-basic-offset: 4
11661 * indent-tabs-mode: t
11664 * ex: set ts=8 sts=4 sw=4 noet:
https://perl5.git.perl.org / perl5.git / blob