3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void **arena_root = &PL_body_arenaroots[sv_type];
644 void **root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void **r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void **thing_copy = (void **)thing; \
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s, *end;
1417 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 =for apidoc sv_2iv_flags
1631 Return the integer value of an SV, doing any necessary string
1632 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1633 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1639 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1643 if (SvGMAGICAL(sv)) {
1644 if (flags & SV_GMAGIC)
1649 return I_V(SvNVX(sv));
1651 if (SvPOKp(sv) && SvLEN(sv))
1654 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1655 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1661 if (SvTHINKFIRST(sv)) {
1664 SV * const tmpstr=AMG_CALLun(sv,numer);
1665 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1666 return SvIV(tmpstr);
1669 return PTR2IV(SvRV(sv));
1672 sv_force_normal_flags(sv, 0);
1674 if (SvREADONLY(sv) && !SvOK(sv)) {
1675 if (ckWARN(WARN_UNINITIALIZED))
1682 return (IV)(SvUVX(sv));
1689 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1690 * without also getting a cached IV/UV from it at the same time
1691 * (ie PV->NV conversion should detect loss of accuracy and cache
1692 * IV or UV at same time to avoid this. NWC */
1694 if (SvTYPE(sv) == SVt_NV)
1695 sv_upgrade(sv, SVt_PVNV);
1697 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1698 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1699 certainly cast into the IV range at IV_MAX, whereas the correct
1700 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1702 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1703 SvIV_set(sv, I_V(SvNVX(sv)));
1704 if (SvNVX(sv) == (NV) SvIVX(sv)
1705 #ifndef NV_PRESERVES_UV
1706 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1707 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1708 /* Don't flag it as "accurately an integer" if the number
1709 came from a (by definition imprecise) NV operation, and
1710 we're outside the range of NV integer precision */
1713 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1714 DEBUG_c(PerlIO_printf(Perl_debug_log,
1715 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1721 /* IV not precise. No need to convert from PV, as NV
1722 conversion would already have cached IV if it detected
1723 that PV->IV would be better than PV->NV->IV
1724 flags already correct - don't set public IOK. */
1725 DEBUG_c(PerlIO_printf(Perl_debug_log,
1726 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1731 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1732 but the cast (NV)IV_MIN rounds to a the value less (more
1733 negative) than IV_MIN which happens to be equal to SvNVX ??
1734 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1735 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1736 (NV)UVX == NVX are both true, but the values differ. :-(
1737 Hopefully for 2s complement IV_MIN is something like
1738 0x8000000000000000 which will be exact. NWC */
1741 SvUV_set(sv, U_V(SvNVX(sv)));
1743 (SvNVX(sv) == (NV) SvUVX(sv))
1744 #ifndef NV_PRESERVES_UV
1745 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1746 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1747 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1748 /* Don't flag it as "accurately an integer" if the number
1749 came from a (by definition imprecise) NV operation, and
1750 we're outside the range of NV integer precision */
1755 DEBUG_c(PerlIO_printf(Perl_debug_log,
1756 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1762 else if (SvPOKp(sv) && SvLEN(sv)) {
1764 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1765 /* We want to avoid a possible problem when we cache an IV which
1766 may be later translated to an NV, and the resulting NV is not
1767 the same as the direct translation of the initial string
1768 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1769 be careful to ensure that the value with the .456 is around if the
1770 NV value is requested in the future).
1772 This means that if we cache such an IV, we need to cache the
1773 NV as well. Moreover, we trade speed for space, and do not
1774 cache the NV if we are sure it's not needed.
1777 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1778 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1779 == IS_NUMBER_IN_UV) {
1780 /* It's definitely an integer, only upgrade to PVIV */
1781 if (SvTYPE(sv) < SVt_PVIV)
1782 sv_upgrade(sv, SVt_PVIV);
1784 } else if (SvTYPE(sv) < SVt_PVNV)
1785 sv_upgrade(sv, SVt_PVNV);
1787 /* If NV preserves UV then we only use the UV value if we know that
1788 we aren't going to call atof() below. If NVs don't preserve UVs
1789 then the value returned may have more precision than atof() will
1790 return, even though value isn't perfectly accurate. */
1791 if ((numtype & (IS_NUMBER_IN_UV
1792 #ifdef NV_PRESERVES_UV
1795 )) == IS_NUMBER_IN_UV) {
1796 /* This won't turn off the public IOK flag if it was set above */
1797 (void)SvIOKp_on(sv);
1799 if (!(numtype & IS_NUMBER_NEG)) {
1801 if (value <= (UV)IV_MAX) {
1802 SvIV_set(sv, (IV)value);
1804 SvUV_set(sv, value);
1808 /* 2s complement assumption */
1809 if (value <= (UV)IV_MIN) {
1810 SvIV_set(sv, -(IV)value);
1812 /* Too negative for an IV. This is a double upgrade, but
1813 I'm assuming it will be rare. */
1814 if (SvTYPE(sv) < SVt_PVNV)
1815 sv_upgrade(sv, SVt_PVNV);
1819 SvNV_set(sv, -(NV)value);
1820 SvIV_set(sv, IV_MIN);
1824 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1825 will be in the previous block to set the IV slot, and the next
1826 block to set the NV slot. So no else here. */
1828 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1829 != IS_NUMBER_IN_UV) {
1830 /* It wasn't an (integer that doesn't overflow the UV). */
1831 SvNV_set(sv, Atof(SvPVX_const(sv)));
1833 if (! numtype && ckWARN(WARN_NUMERIC))
1836 #if defined(USE_LONG_DOUBLE)
1837 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1838 PTR2UV(sv), SvNVX(sv)));
1840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1841 PTR2UV(sv), SvNVX(sv)));
1845 #ifdef NV_PRESERVES_UV
1846 (void)SvIOKp_on(sv);
1848 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1849 SvIV_set(sv, I_V(SvNVX(sv)));
1850 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1853 /* Integer is imprecise. NOK, IOKp */
1855 /* UV will not work better than IV */
1857 if (SvNVX(sv) > (NV)UV_MAX) {
1859 /* Integer is inaccurate. NOK, IOKp, is UV */
1860 SvUV_set(sv, UV_MAX);
1863 SvUV_set(sv, U_V(SvNVX(sv)));
1864 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1869 /* Integer is imprecise. NOK, IOKp, is UV */
1874 #else /* NV_PRESERVES_UV */
1875 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1876 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1877 /* The IV slot will have been set from value returned by
1878 grok_number above. The NV slot has just been set using
1881 assert (SvIOKp(sv));
1883 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1884 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1885 /* Small enough to preserve all bits. */
1886 (void)SvIOKp_on(sv);
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1891 /* Assumption: first non-preserved integer is < IV_MAX,
1892 this NV is in the preserved range, therefore: */
1893 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1895 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1899 0 0 already failed to read UV.
1900 0 1 already failed to read UV.
1901 1 0 you won't get here in this case. IV/UV
1902 slot set, public IOK, Atof() unneeded.
1903 1 1 already read UV.
1904 so there's no point in sv_2iuv_non_preserve() attempting
1905 to use atol, strtol, strtoul etc. */
1906 sv_2iuv_non_preserve (sv, numtype);
1909 #endif /* NV_PRESERVES_UV */
1912 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1914 if (SvTYPE(sv) < SVt_IV)
1915 /* Typically the caller expects that sv_any is not NULL now. */
1916 sv_upgrade(sv, SVt_IV);
1919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1920 PTR2UV(sv),SvIVX(sv)));
1921 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1925 =for apidoc sv_2uv_flags
1927 Return the unsigned integer value of an SV, doing any necessary string
1928 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1929 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1935 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1939 if (SvGMAGICAL(sv)) {
1940 if (flags & SV_GMAGIC)
1945 return U_V(SvNVX(sv));
1946 if (SvPOKp(sv) && SvLEN(sv))
1949 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1950 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1956 if (SvTHINKFIRST(sv)) {
1959 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1960 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1961 return SvUV(tmpstr);
1962 return PTR2UV(SvRV(sv));
1965 sv_force_normal_flags(sv, 0);
1967 if (SvREADONLY(sv) && !SvOK(sv)) {
1968 if (ckWARN(WARN_UNINITIALIZED))
1978 return (UV)SvIVX(sv);
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1993 SvIV_set(sv, I_V(SvNVX(sv)));
1994 if (SvNVX(sv) == (NV) SvIVX(sv)
1995 #ifndef NV_PRESERVES_UV
1996 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1997 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1998 /* Don't flag it as "accurately an integer" if the number
1999 came from a (by definition imprecise) NV operation, and
2000 we're outside the range of NV integer precision */
2003 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2004 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2011 /* IV not precise. No need to convert from PV, as NV
2012 conversion would already have cached IV if it detected
2013 that PV->IV would be better than PV->NV->IV
2014 flags already correct - don't set public IOK. */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2021 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022 but the cast (NV)IV_MIN rounds to a the value less (more
2023 negative) than IV_MIN which happens to be equal to SvNVX ??
2024 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026 (NV)UVX == NVX are both true, but the values differ. :-(
2027 Hopefully for 2s complement IV_MIN is something like
2028 0x8000000000000000 which will be exact. NWC */
2031 SvUV_set(sv, U_V(SvNVX(sv)));
2033 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef NV_PRESERVES_UV
2035 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038 /* Don't flag it as "accurately an integer" if the number
2039 came from a (by definition imprecise) NV operation, and
2040 we're outside the range of NV integer precision */
2045 DEBUG_c(PerlIO_printf(Perl_debug_log,
2046 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2052 else if (SvPOKp(sv) && SvLEN(sv)) {
2054 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2056 /* We want to avoid a possible problem when we cache a UV which
2057 may be later translated to an NV, and the resulting NV is not
2058 the translation of the initial data.
2060 This means that if we cache such a UV, we need to cache the
2061 NV as well. Moreover, we trade speed for space, and do not
2062 cache the NV if not needed.
2065 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2066 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2067 == IS_NUMBER_IN_UV) {
2068 /* It's definitely an integer, only upgrade to PVIV */
2069 if (SvTYPE(sv) < SVt_PVIV)
2070 sv_upgrade(sv, SVt_PVIV);
2072 } else if (SvTYPE(sv) < SVt_PVNV)
2073 sv_upgrade(sv, SVt_PVNV);
2075 /* If NV preserves UV then we only use the UV value if we know that
2076 we aren't going to call atof() below. If NVs don't preserve UVs
2077 then the value returned may have more precision than atof() will
2078 return, even though it isn't accurate. */
2079 if ((numtype & (IS_NUMBER_IN_UV
2080 #ifdef NV_PRESERVES_UV
2083 )) == IS_NUMBER_IN_UV) {
2084 /* This won't turn off the public IOK flag if it was set above */
2085 (void)SvIOKp_on(sv);
2087 if (!(numtype & IS_NUMBER_NEG)) {
2089 if (value <= (UV)IV_MAX) {
2090 SvIV_set(sv, (IV)value);
2092 /* it didn't overflow, and it was positive. */
2093 SvUV_set(sv, value);
2097 /* 2s complement assumption */
2098 if (value <= (UV)IV_MIN) {
2099 SvIV_set(sv, -(IV)value);
2101 /* Too negative for an IV. This is a double upgrade, but
2102 I'm assuming it will be rare. */
2103 if (SvTYPE(sv) < SVt_PVNV)
2104 sv_upgrade(sv, SVt_PVNV);
2108 SvNV_set(sv, -(NV)value);
2109 SvIV_set(sv, IV_MIN);
2114 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2115 != IS_NUMBER_IN_UV) {
2116 /* It wasn't an integer, or it overflowed the UV. */
2117 SvNV_set(sv, Atof(SvPVX_const(sv)));
2119 if (! numtype && ckWARN(WARN_NUMERIC))
2122 #if defined(USE_LONG_DOUBLE)
2123 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2124 PTR2UV(sv), SvNVX(sv)));
2126 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2127 PTR2UV(sv), SvNVX(sv)));
2130 #ifdef NV_PRESERVES_UV
2131 (void)SvIOKp_on(sv);
2133 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2134 SvIV_set(sv, I_V(SvNVX(sv)));
2135 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2138 /* Integer is imprecise. NOK, IOKp */
2140 /* UV will not work better than IV */
2142 if (SvNVX(sv) > (NV)UV_MAX) {
2144 /* Integer is inaccurate. NOK, IOKp, is UV */
2145 SvUV_set(sv, UV_MAX);
2148 SvUV_set(sv, U_V(SvNVX(sv)));
2149 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2150 NV preservse UV so can do correct comparison. */
2151 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2155 /* Integer is imprecise. NOK, IOKp, is UV */
2160 #else /* NV_PRESERVES_UV */
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2163 /* The UV slot will have been set from value returned by
2164 grok_number above. The NV slot has just been set using
2167 assert (SvIOKp(sv));
2169 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2170 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2171 /* Small enough to preserve all bits. */
2172 (void)SvIOKp_on(sv);
2174 SvIV_set(sv, I_V(SvNVX(sv)));
2175 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2177 /* Assumption: first non-preserved integer is < IV_MAX,
2178 this NV is in the preserved range, therefore: */
2179 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2181 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2184 sv_2iuv_non_preserve (sv, numtype);
2186 #endif /* NV_PRESERVES_UV */
2190 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2191 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2194 if (SvTYPE(sv) < SVt_IV)
2195 /* Typically the caller expects that sv_any is not NULL now. */
2196 sv_upgrade(sv, SVt_IV);
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2201 PTR2UV(sv),SvUVX(sv)));
2202 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2208 Return the num value of an SV, doing any necessary string or integer
2209 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2216 Perl_sv_2nv(pTHX_ register SV *sv)
2220 if (SvGMAGICAL(sv)) {
2224 if (SvPOKp(sv) && SvLEN(sv)) {
2225 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2226 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2228 return Atof(SvPVX_const(sv));
2232 return (NV)SvUVX(sv);
2234 return (NV)SvIVX(sv);
2237 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2238 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2244 if (SvTHINKFIRST(sv)) {
2247 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2248 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2249 return SvNV(tmpstr);
2250 return PTR2NV(SvRV(sv));
2253 sv_force_normal_flags(sv, 0);
2255 if (SvREADONLY(sv) && !SvOK(sv)) {
2256 if (ckWARN(WARN_UNINITIALIZED))
2261 if (SvTYPE(sv) < SVt_NV) {
2262 if (SvTYPE(sv) == SVt_IV)
2263 sv_upgrade(sv, SVt_PVNV);
2265 sv_upgrade(sv, SVt_NV);
2266 #ifdef USE_LONG_DOUBLE
2268 STORE_NUMERIC_LOCAL_SET_STANDARD();
2269 PerlIO_printf(Perl_debug_log,
2270 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2271 PTR2UV(sv), SvNVX(sv));
2272 RESTORE_NUMERIC_LOCAL();
2276 STORE_NUMERIC_LOCAL_SET_STANDARD();
2277 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2278 PTR2UV(sv), SvNVX(sv));
2279 RESTORE_NUMERIC_LOCAL();
2283 else if (SvTYPE(sv) < SVt_PVNV)
2284 sv_upgrade(sv, SVt_PVNV);
2289 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2290 #ifdef NV_PRESERVES_UV
2293 /* Only set the public NV OK flag if this NV preserves the IV */
2294 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2295 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2296 : (SvIVX(sv) == I_V(SvNVX(sv))))
2302 else if (SvPOKp(sv) && SvLEN(sv)) {
2304 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2305 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2307 #ifdef NV_PRESERVES_UV
2308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2309 == IS_NUMBER_IN_UV) {
2310 /* It's definitely an integer */
2311 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2313 SvNV_set(sv, Atof(SvPVX_const(sv)));
2316 SvNV_set(sv, Atof(SvPVX_const(sv)));
2317 /* Only set the public NV OK flag if this NV preserves the value in
2318 the PV at least as well as an IV/UV would.
2319 Not sure how to do this 100% reliably. */
2320 /* if that shift count is out of range then Configure's test is
2321 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2323 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2324 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2325 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2326 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2327 /* Can't use strtol etc to convert this string, so don't try.
2328 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2331 /* value has been set. It may not be precise. */
2332 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2333 /* 2s complement assumption for (UV)IV_MIN */
2334 SvNOK_on(sv); /* Integer is too negative. */
2339 if (numtype & IS_NUMBER_NEG) {
2340 SvIV_set(sv, -(IV)value);
2341 } else if (value <= (UV)IV_MAX) {
2342 SvIV_set(sv, (IV)value);
2344 SvUV_set(sv, value);
2348 if (numtype & IS_NUMBER_NOT_INT) {
2349 /* I believe that even if the original PV had decimals,
2350 they are lost beyond the limit of the FP precision.
2351 However, neither is canonical, so both only get p
2352 flags. NWC, 2000/11/25 */
2353 /* Both already have p flags, so do nothing */
2355 const NV nv = SvNVX(sv);
2356 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2357 if (SvIVX(sv) == I_V(nv)) {
2362 /* It had no "." so it must be integer. */
2365 /* between IV_MAX and NV(UV_MAX).
2366 Could be slightly > UV_MAX */
2368 if (numtype & IS_NUMBER_NOT_INT) {
2369 /* UV and NV both imprecise. */
2371 const UV nv_as_uv = U_V(nv);
2373 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2384 #endif /* NV_PRESERVES_UV */
2387 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2389 if (SvTYPE(sv) < SVt_NV)
2390 /* Typically the caller expects that sv_any is not NULL now. */
2391 /* XXX Ilya implies that this is a bug in callers that assume this
2392 and ideally should be fixed. */
2393 sv_upgrade(sv, SVt_NV);
2396 #if defined(USE_LONG_DOUBLE)
2398 STORE_NUMERIC_LOCAL_SET_STANDARD();
2399 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 STORE_NUMERIC_LOCAL_SET_STANDARD();
2406 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2407 PTR2UV(sv), SvNVX(sv));
2408 RESTORE_NUMERIC_LOCAL();
2414 /* asIV(): extract an integer from the string value of an SV.
2415 * Caller must validate PVX */
2418 S_asIV(pTHX_ SV *sv)
2421 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2424 == IS_NUMBER_IN_UV) {
2425 /* It's definitely an integer */
2426 if (numtype & IS_NUMBER_NEG) {
2427 if (value < (UV)IV_MIN)
2430 if (value < (UV)IV_MAX)
2435 if (ckWARN(WARN_NUMERIC))
2438 return I_V(Atof(SvPVX_const(sv)));
2441 /* asUV(): extract an unsigned integer from the string value of an SV
2442 * Caller must validate PVX */
2445 S_asUV(pTHX_ SV *sv)
2448 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2450 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2451 == IS_NUMBER_IN_UV) {
2452 /* It's definitely an integer */
2453 if (!(numtype & IS_NUMBER_NEG))
2457 if (ckWARN(WARN_NUMERIC))
2460 return U_V(Atof(SvPVX_const(sv)));
2463 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2464 * UV as a string towards the end of buf, and return pointers to start and
2467 * We assume that buf is at least TYPE_CHARS(UV) long.
2471 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2473 char *ptr = buf + TYPE_CHARS(UV);
2474 char * const ebuf = ptr;
2487 *--ptr = '0' + (char)(uv % 10);
2496 =for apidoc sv_2pv_flags
2498 Returns a pointer to the string value of an SV, and sets *lp to its length.
2499 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2501 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2502 usually end up here too.
2508 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2518 if (SvGMAGICAL(sv)) {
2519 if (flags & SV_GMAGIC)
2524 if (flags & SV_MUTABLE_RETURN)
2525 return SvPVX_mutable(sv);
2526 if (flags & SV_CONST_RETURN)
2527 return (char *)SvPVX_const(sv);
2530 if (SvIOKp(sv) || SvNOKp(sv)) {
2531 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2535 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2536 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2538 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2541 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2542 /* Sneaky stuff here */
2543 SV *tsv = newSVpvn(tbuf, len);
2553 #ifdef FIXNEGATIVEZERO
2554 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2560 SvUPGRADE(sv, SVt_PV);
2563 s = SvGROW_mutable(sv, len + 1);
2566 return memcpy(s, tbuf, len + 1);
2570 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2571 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2579 if (SvTHINKFIRST(sv)) {
2583 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2584 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2586 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2589 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2590 if (flags & SV_CONST_RETURN) {
2591 pv = (char *) SvPVX_const(tmpstr);
2593 pv = (flags & SV_MUTABLE_RETURN)
2594 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2597 *lp = SvCUR(tmpstr);
2599 pv = sv_2pv_flags(tmpstr, lp, flags);
2609 const SV *const referent = (SV*)SvRV(sv);
2612 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2613 } else if (SvTYPE(referent) == SVt_PVMG
2614 && ((SvFLAGS(referent) &
2615 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2616 == (SVs_OBJECT|SVs_SMG))
2617 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2618 const regexp *re = (regexp *)mg->mg_obj;
2621 const char *fptr = "msix";
2626 char need_newline = 0;
2628 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2630 while((ch = *fptr++)) {
2632 reflags[left++] = ch;
2635 reflags[right--] = ch;
2640 reflags[left] = '-';
2644 mg->mg_len = re->prelen + 4 + left;
2646 * If /x was used, we have to worry about a regex
2647 * ending with a comment later being embedded
2648 * within another regex. If so, we don't want this
2649 * regex's "commentization" to leak out to the
2650 * right part of the enclosing regex, we must cap
2651 * it with a newline.
2653 * So, if /x was used, we scan backwards from the
2654 * end of the regex. If we find a '#' before we
2655 * find a newline, we need to add a newline
2656 * ourself. If we find a '\n' first (or if we
2657 * don't find '#' or '\n'), we don't need to add
2658 * anything. -jfriedl
2660 if (PMf_EXTENDED & re->reganch) {
2661 const char *endptr = re->precomp + re->prelen;
2662 while (endptr >= re->precomp) {
2663 const char c = *(endptr--);
2665 break; /* don't need another */
2667 /* we end while in a comment, so we
2669 mg->mg_len++; /* save space for it */
2670 need_newline = 1; /* note to add it */
2676 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2677 Copy("(?", mg->mg_ptr, 2, char);
2678 Copy(reflags, mg->mg_ptr+2, left, char);
2679 Copy(":", mg->mg_ptr+left+2, 1, char);
2680 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2682 mg->mg_ptr[mg->mg_len - 2] = '\n';
2683 mg->mg_ptr[mg->mg_len - 1] = ')';
2684 mg->mg_ptr[mg->mg_len] = 0;
2686 PL_reginterp_cnt += re->program[0].next_off;
2688 if (re->reganch & ROPT_UTF8)
2696 const char *const typestr = sv_reftype(referent, 0);
2698 tsv = sv_newmortal();
2699 if (SvOBJECT(referent)) {
2700 const char *const name = HvNAME_get(SvSTASH(referent));
2701 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2702 name ? name : "__ANON__" , typestr,
2706 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2714 if (SvREADONLY(sv) && !SvOK(sv)) {
2715 if (ckWARN(WARN_UNINITIALIZED))
2722 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2723 /* I'm assuming that if both IV and NV are equally valid then
2724 converting the IV is going to be more efficient */
2725 const U32 isIOK = SvIOK(sv);
2726 const U32 isUIOK = SvIsUV(sv);
2727 char buf[TYPE_CHARS(UV)];
2730 if (SvTYPE(sv) < SVt_PVIV)
2731 sv_upgrade(sv, SVt_PVIV);
2733 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2735 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2736 /* inlined from sv_setpvn */
2737 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2738 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2739 SvCUR_set(sv, ebuf - ptr);
2749 else if (SvNOKp(sv)) {
2750 if (SvTYPE(sv) < SVt_PVNV)
2751 sv_upgrade(sv, SVt_PVNV);
2752 /* The +20 is pure guesswork. Configure test needed. --jhi */
2753 s = SvGROW_mutable(sv, NV_DIG + 20);
2754 olderrno = errno; /* some Xenix systems wipe out errno here */
2756 if (SvNVX(sv) == 0.0)
2757 (void)strcpy(s,"0");
2761 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2764 #ifdef FIXNEGATIVEZERO
2765 if (*s == '-' && s[1] == '0' && !s[2])
2775 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2779 if (SvTYPE(sv) < SVt_PV)
2780 /* Typically the caller expects that sv_any is not NULL now. */
2781 sv_upgrade(sv, SVt_PV);
2785 const STRLEN len = s - SvPVX_const(sv);
2791 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2792 PTR2UV(sv),SvPVX_const(sv)));
2793 if (flags & SV_CONST_RETURN)
2794 return (char *)SvPVX_const(sv);
2795 if (flags & SV_MUTABLE_RETURN)
2796 return SvPVX_mutable(sv);
2801 =for apidoc sv_copypv
2803 Copies a stringified representation of the source SV into the
2804 destination SV. Automatically performs any necessary mg_get and
2805 coercion of numeric values into strings. Guaranteed to preserve
2806 UTF-8 flag even from overloaded objects. Similar in nature to
2807 sv_2pv[_flags] but operates directly on an SV instead of just the
2808 string. Mostly uses sv_2pv_flags to do its work, except when that
2809 would lose the UTF-8'ness of the PV.
2815 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2818 const char * const s = SvPV_const(ssv,len);
2819 sv_setpvn(dsv,s,len);
2827 =for apidoc sv_2pvbyte
2829 Return a pointer to the byte-encoded representation of the SV, and set *lp
2830 to its length. May cause the SV to be downgraded from UTF-8 as a
2833 Usually accessed via the C<SvPVbyte> macro.
2839 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2841 sv_utf8_downgrade(sv,0);
2842 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2846 =for apidoc sv_2pvutf8
2848 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2849 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2851 Usually accessed via the C<SvPVutf8> macro.
2857 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2859 sv_utf8_upgrade(sv);
2860 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2865 =for apidoc sv_2bool
2867 This function is only called on magical items, and is only used by
2868 sv_true() or its macro equivalent.
2874 Perl_sv_2bool(pTHX_ register SV *sv)
2882 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2883 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2884 return (bool)SvTRUE(tmpsv);
2885 return SvRV(sv) != 0;
2888 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2890 (*sv->sv_u.svu_pv > '0' ||
2891 Xpvtmp->xpv_cur > 1 ||
2892 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2899 return SvIVX(sv) != 0;
2902 return SvNVX(sv) != 0.0;
2910 =for apidoc sv_utf8_upgrade
2912 Converts the PV of an SV to its UTF-8-encoded form.
2913 Forces the SV to string form if it is not already.
2914 Always sets the SvUTF8 flag to avoid future validity checks even
2915 if all the bytes have hibit clear.
2917 This is not as a general purpose byte encoding to Unicode interface:
2918 use the Encode extension for that.
2920 =for apidoc sv_utf8_upgrade_flags
2922 Converts the PV of an SV to its UTF-8-encoded form.
2923 Forces the SV to string form if it is not already.
2924 Always sets the SvUTF8 flag to avoid future validity checks even
2925 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2926 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2927 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2929 This is not as a general purpose byte encoding to Unicode interface:
2930 use the Encode extension for that.
2936 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2938 if (sv == &PL_sv_undef)
2942 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2943 (void) sv_2pv_flags(sv,&len, flags);
2947 (void) SvPV_force(sv,len);
2956 sv_force_normal_flags(sv, 0);
2959 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2960 sv_recode_to_utf8(sv, PL_encoding);
2961 else { /* Assume Latin-1/EBCDIC */
2962 /* This function could be much more efficient if we
2963 * had a FLAG in SVs to signal if there are any hibit
2964 * chars in the PV. Given that there isn't such a flag
2965 * make the loop as fast as possible. */
2966 const U8 *s = (U8 *) SvPVX_const(sv);
2967 const U8 * const e = (U8 *) SvEND(sv);
2973 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2977 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2978 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2980 SvPV_free(sv); /* No longer using what was there before. */
2982 SvPV_set(sv, (char*)recoded);
2983 SvCUR_set(sv, len - 1);
2984 SvLEN_set(sv, len); /* No longer know the real size. */
2986 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2993 =for apidoc sv_utf8_downgrade
2995 Attempts to convert the PV of an SV from characters to bytes.
2996 If the PV contains a character beyond byte, this conversion will fail;
2997 in this case, either returns false or, if C<fail_ok> is not
3000 This is not as a general purpose Unicode to byte encoding interface:
3001 use the Encode extension for that.
3007 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3009 if (SvPOKp(sv) && SvUTF8(sv)) {
3015 sv_force_normal_flags(sv, 0);
3017 s = (U8 *) SvPV(sv, len);
3018 if (!utf8_to_bytes(s, &len)) {
3023 Perl_croak(aTHX_ "Wide character in %s",
3026 Perl_croak(aTHX_ "Wide character");
3037 =for apidoc sv_utf8_encode
3039 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3040 flag off so that it looks like octets again.
3046 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3048 (void) sv_utf8_upgrade(sv);
3050 sv_force_normal_flags(sv, 0);
3052 if (SvREADONLY(sv)) {
3053 Perl_croak(aTHX_ PL_no_modify);
3059 =for apidoc sv_utf8_decode
3061 If the PV of the SV is an octet sequence in UTF-8
3062 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3063 so that it looks like a character. If the PV contains only single-byte
3064 characters, the C<SvUTF8> flag stays being off.
3065 Scans PV for validity and returns false if the PV is invalid UTF-8.
3071 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3077 /* The octets may have got themselves encoded - get them back as
3080 if (!sv_utf8_downgrade(sv, TRUE))
3083 /* it is actually just a matter of turning the utf8 flag on, but
3084 * we want to make sure everything inside is valid utf8 first.
3086 c = (const U8 *) SvPVX_const(sv);
3087 if (!is_utf8_string(c, SvCUR(sv)+1))
3089 e = (const U8 *) SvEND(sv);
3092 if (!UTF8_IS_INVARIANT(ch)) {
3102 =for apidoc sv_setsv
3104 Copies the contents of the source SV C<ssv> into the destination SV
3105 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3106 function if the source SV needs to be reused. Does not handle 'set' magic.
3107 Loosely speaking, it performs a copy-by-value, obliterating any previous
3108 content of the destination.
3110 You probably want to use one of the assortment of wrappers, such as
3111 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3112 C<SvSetMagicSV_nosteal>.
3114 =for apidoc sv_setsv_flags
3116 Copies the contents of the source SV C<ssv> into the destination SV
3117 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3118 function if the source SV needs to be reused. Does not handle 'set' magic.
3119 Loosely speaking, it performs a copy-by-value, obliterating any previous
3120 content of the destination.
3121 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3122 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3123 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3124 and C<sv_setsv_nomg> are implemented in terms of this function.
3126 You probably want to use one of the assortment of wrappers, such as
3127 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3128 C<SvSetMagicSV_nosteal>.
3130 This is the primary function for copying scalars, and most other
3131 copy-ish functions and macros use this underneath.
3137 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3139 register U32 sflags;
3145 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3147 sstr = &PL_sv_undef;
3148 stype = SvTYPE(sstr);
3149 dtype = SvTYPE(dstr);
3154 /* need to nuke the magic */
3156 SvRMAGICAL_off(dstr);
3159 /* There's a lot of redundancy below but we're going for speed here */
3164 if (dtype != SVt_PVGV) {
3165 (void)SvOK_off(dstr);
3173 sv_upgrade(dstr, SVt_IV);
3176 sv_upgrade(dstr, SVt_PVNV);
3180 sv_upgrade(dstr, SVt_PVIV);
3183 (void)SvIOK_only(dstr);
3184 SvIV_set(dstr, SvIVX(sstr));
3187 if (SvTAINTED(sstr))
3198 sv_upgrade(dstr, SVt_NV);
3203 sv_upgrade(dstr, SVt_PVNV);
3206 SvNV_set(dstr, SvNVX(sstr));
3207 (void)SvNOK_only(dstr);
3208 if (SvTAINTED(sstr))
3216 sv_upgrade(dstr, SVt_RV);
3217 else if (dtype == SVt_PVGV &&
3218 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3221 if (GvIMPORTED(dstr) != GVf_IMPORTED
3222 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3224 GvIMPORTED_on(dstr);
3233 #ifdef PERL_OLD_COPY_ON_WRITE
3234 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3235 if (dtype < SVt_PVIV)
3236 sv_upgrade(dstr, SVt_PVIV);
3243 sv_upgrade(dstr, SVt_PV);
3246 if (dtype < SVt_PVIV)
3247 sv_upgrade(dstr, SVt_PVIV);
3250 if (dtype < SVt_PVNV)
3251 sv_upgrade(dstr, SVt_PVNV);
3258 const char * const type = sv_reftype(sstr,0);
3260 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3262 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3267 if (dtype <= SVt_PVGV) {
3269 if (dtype != SVt_PVGV) {
3270 const char * const name = GvNAME(sstr);
3271 const STRLEN len = GvNAMELEN(sstr);
3272 /* don't upgrade SVt_PVLV: it can hold a glob */
3273 if (dtype != SVt_PVLV)
3274 sv_upgrade(dstr, SVt_PVGV);
3275 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3276 GvSTASH(dstr) = GvSTASH(sstr);
3278 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3279 GvNAME(dstr) = savepvn(name, len);
3280 GvNAMELEN(dstr) = len;
3281 SvFAKE_on(dstr); /* can coerce to non-glob */
3284 #ifdef GV_UNIQUE_CHECK
3285 if (GvUNIQUE((GV*)dstr)) {
3286 Perl_croak(aTHX_ PL_no_modify);
3290 (void)SvOK_off(dstr);
3291 GvINTRO_off(dstr); /* one-shot flag */
3293 GvGP(dstr) = gp_ref(GvGP(sstr));
3294 if (SvTAINTED(sstr))
3296 if (GvIMPORTED(dstr) != GVf_IMPORTED
3297 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3299 GvIMPORTED_on(dstr);
3307 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3309 if ((int)SvTYPE(sstr) != stype) {
3310 stype = SvTYPE(sstr);
3311 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3315 if (stype == SVt_PVLV)
3316 SvUPGRADE(dstr, SVt_PVNV);
3318 SvUPGRADE(dstr, (U32)stype);
3321 sflags = SvFLAGS(sstr);
3323 if (sflags & SVf_ROK) {
3324 if (dtype >= SVt_PV) {
3325 if (dtype == SVt_PVGV) {
3326 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3328 const int intro = GvINTRO(dstr);
3330 #ifdef GV_UNIQUE_CHECK
3331 if (GvUNIQUE((GV*)dstr)) {
3332 Perl_croak(aTHX_ PL_no_modify);
3337 GvINTRO_off(dstr); /* one-shot flag */
3338 GvLINE(dstr) = CopLINE(PL_curcop);
3339 GvEGV(dstr) = (GV*)dstr;
3342 switch (SvTYPE(sref)) {
3345 SAVEGENERICSV(GvAV(dstr));
3347 dref = (SV*)GvAV(dstr);
3348 GvAV(dstr) = (AV*)sref;
3349 if (!GvIMPORTED_AV(dstr)
3350 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3352 GvIMPORTED_AV_on(dstr);
3357 SAVEGENERICSV(GvHV(dstr));
3359 dref = (SV*)GvHV(dstr);
3360 GvHV(dstr) = (HV*)sref;
3361 if (!GvIMPORTED_HV(dstr)
3362 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3364 GvIMPORTED_HV_on(dstr);
3369 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3370 SvREFCNT_dec(GvCV(dstr));
3371 GvCV(dstr) = Nullcv;
3372 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3373 PL_sub_generation++;
3375 SAVEGENERICSV(GvCV(dstr));
3378 dref = (SV*)GvCV(dstr);
3379 if (GvCV(dstr) != (CV*)sref) {
3380 CV* const cv = GvCV(dstr);
3382 if (!GvCVGEN((GV*)dstr) &&
3383 (CvROOT(cv) || CvXSUB(cv)))
3385 /* Redefining a sub - warning is mandatory if
3386 it was a const and its value changed. */
3387 if (ckWARN(WARN_REDEFINE)
3389 && (!CvCONST((CV*)sref)
3390 || sv_cmp(cv_const_sv(cv),
3391 cv_const_sv((CV*)sref)))))
3393 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3395 ? "Constant subroutine %s::%s redefined"
3396 : "Subroutine %s::%s redefined",
3397 HvNAME_get(GvSTASH((GV*)dstr)),
3398 GvENAME((GV*)dstr));
3402 cv_ckproto(cv, (GV*)dstr,
3404 ? SvPVX_const(sref) : Nullch);
3406 GvCV(dstr) = (CV*)sref;
3407 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3408 GvASSUMECV_on(dstr);
3409 PL_sub_generation++;
3411 if (!GvIMPORTED_CV(dstr)
3412 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3414 GvIMPORTED_CV_on(dstr);
3419 SAVEGENERICSV(GvIOp(dstr));
3421 dref = (SV*)GvIOp(dstr);
3422 GvIOp(dstr) = (IO*)sref;
3426 SAVEGENERICSV(GvFORM(dstr));
3428 dref = (SV*)GvFORM(dstr);
3429 GvFORM(dstr) = (CV*)sref;
3433 SAVEGENERICSV(GvSV(dstr));
3435 dref = (SV*)GvSV(dstr);
3437 if (!GvIMPORTED_SV(dstr)
3438 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3440 GvIMPORTED_SV_on(dstr);
3446 if (SvTAINTED(sstr))
3450 if (SvPVX_const(dstr)) {
3456 (void)SvOK_off(dstr);
3457 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3459 if (sflags & SVp_NOK) {
3461 /* Only set the public OK flag if the source has public OK. */
3462 if (sflags & SVf_NOK)
3463 SvFLAGS(dstr) |= SVf_NOK;
3464 SvNV_set(dstr, SvNVX(sstr));
3466 if (sflags & SVp_IOK) {
3467 (void)SvIOKp_on(dstr);
3468 if (sflags & SVf_IOK)
3469 SvFLAGS(dstr) |= SVf_IOK;
3470 if (sflags & SVf_IVisUV)
3472 SvIV_set(dstr, SvIVX(sstr));
3474 if (SvAMAGIC(sstr)) {
3478 else if (sflags & SVp_POK) {
3482 * Check to see if we can just swipe the string. If so, it's a
3483 * possible small lose on short strings, but a big win on long ones.
3484 * It might even be a win on short strings if SvPVX_const(dstr)
3485 * has to be allocated and SvPVX_const(sstr) has to be freed.
3488 /* Whichever path we take through the next code, we want this true,
3489 and doing it now facilitates the COW check. */
3490 (void)SvPOK_only(dstr);
3493 /* We're not already COW */
3494 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3495 #ifndef PERL_OLD_COPY_ON_WRITE
3496 /* or we are, but dstr isn't a suitable target. */
3497 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3502 (sflags & SVs_TEMP) && /* slated for free anyway? */
3503 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3504 (!(flags & SV_NOSTEAL)) &&
3505 /* and we're allowed to steal temps */
3506 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3507 SvLEN(sstr) && /* and really is a string */
3508 /* and won't be needed again, potentially */
3509 !(PL_op && PL_op->op_type == OP_AASSIGN))
3510 #ifdef PERL_OLD_COPY_ON_WRITE
3511 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3512 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3513 && SvTYPE(sstr) >= SVt_PVIV)
3516 /* Failed the swipe test, and it's not a shared hash key either.
3517 Have to copy the string. */
3518 STRLEN len = SvCUR(sstr);
3519 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3520 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3521 SvCUR_set(dstr, len);
3522 *SvEND(dstr) = '\0';
3524 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3526 /* Either it's a shared hash key, or it's suitable for
3527 copy-on-write or we can swipe the string. */
3529 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3533 #ifdef PERL_OLD_COPY_ON_WRITE
3535 /* I believe I should acquire a global SV mutex if
3536 it's a COW sv (not a shared hash key) to stop
3537 it going un copy-on-write.
3538 If the source SV has gone un copy on write between up there
3539 and down here, then (assert() that) it is of the correct
3540 form to make it copy on write again */
3541 if ((sflags & (SVf_FAKE | SVf_READONLY))
3542 != (SVf_FAKE | SVf_READONLY)) {
3543 SvREADONLY_on(sstr);
3545 /* Make the source SV into a loop of 1.
3546 (about to become 2) */
3547 SV_COW_NEXT_SV_SET(sstr, sstr);
3551 /* Initial code is common. */
3552 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3557 /* making another shared SV. */
3558 STRLEN cur = SvCUR(sstr);
3559 STRLEN len = SvLEN(sstr);
3560 #ifdef PERL_OLD_COPY_ON_WRITE
3562 assert (SvTYPE(dstr) >= SVt_PVIV);
3563 /* SvIsCOW_normal */
3564 /* splice us in between source and next-after-source. */
3565 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3566 SV_COW_NEXT_SV_SET(sstr, dstr);
3567 SvPV_set(dstr, SvPVX_mutable(sstr));
3571 /* SvIsCOW_shared_hash */
3572 DEBUG_C(PerlIO_printf(Perl_debug_log,
3573 "Copy on write: Sharing hash\n"));
3575 assert (SvTYPE(dstr) >= SVt_PV);
3577 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3579 SvLEN_set(dstr, len);
3580 SvCUR_set(dstr, cur);
3581 SvREADONLY_on(dstr);
3583 /* Relesase a global SV mutex. */
3586 { /* Passes the swipe test. */
3587 SvPV_set(dstr, SvPVX_mutable(sstr));
3588 SvLEN_set(dstr, SvLEN(sstr));
3589 SvCUR_set(dstr, SvCUR(sstr));
3592 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3593 SvPV_set(sstr, Nullch);
3599 if (sflags & SVf_UTF8)
3601 if (sflags & SVp_NOK) {
3603 if (sflags & SVf_NOK)
3604 SvFLAGS(dstr) |= SVf_NOK;
3605 SvNV_set(dstr, SvNVX(sstr));
3607 if (sflags & SVp_IOK) {
3608 (void)SvIOKp_on(dstr);
3609 if (sflags & SVf_IOK)
3610 SvFLAGS(dstr) |= SVf_IOK;
3611 if (sflags & SVf_IVisUV)
3613 SvIV_set(dstr, SvIVX(sstr));
3616 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3617 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3618 smg->mg_ptr, smg->mg_len);
3619 SvRMAGICAL_on(dstr);
3622 else if (sflags & SVp_IOK) {
3623 if (sflags & SVf_IOK)
3624 (void)SvIOK_only(dstr);
3626 (void)SvOK_off(dstr);
3627 (void)SvIOKp_on(dstr);
3629 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3630 if (sflags & SVf_IVisUV)
3632 SvIV_set(dstr, SvIVX(sstr));
3633 if (sflags & SVp_NOK) {
3634 if (sflags & SVf_NOK)
3635 (void)SvNOK_on(dstr);
3637 (void)SvNOKp_on(dstr);
3638 SvNV_set(dstr, SvNVX(sstr));
3641 else if (sflags & SVp_NOK) {
3642 if (sflags & SVf_NOK)
3643 (void)SvNOK_only(dstr);
3645 (void)SvOK_off(dstr);
3648 SvNV_set(dstr, SvNVX(sstr));
3651 if (dtype == SVt_PVGV) {
3652 if (ckWARN(WARN_MISC))
3653 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3656 (void)SvOK_off(dstr);
3658 if (SvTAINTED(sstr))
3663 =for apidoc sv_setsv_mg
3665 Like C<sv_setsv>, but also handles 'set' magic.
3671 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3673 sv_setsv(dstr,sstr);
3677 #ifdef PERL_OLD_COPY_ON_WRITE
3679 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3681 STRLEN cur = SvCUR(sstr);
3682 STRLEN len = SvLEN(sstr);
3683 register char *new_pv;
3686 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3694 if (SvTHINKFIRST(dstr))
3695 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3696 else if (SvPVX_const(dstr))
3697 Safefree(SvPVX_const(dstr));
3701 SvUPGRADE(dstr, SVt_PVIV);
3703 assert (SvPOK(sstr));
3704 assert (SvPOKp(sstr));
3705 assert (!SvIOK(sstr));
3706 assert (!SvIOKp(sstr));
3707 assert (!SvNOK(sstr));
3708 assert (!SvNOKp(sstr));
3710 if (SvIsCOW(sstr)) {
3712 if (SvLEN(sstr) == 0) {
3713 /* source is a COW shared hash key. */
3714 DEBUG_C(PerlIO_printf(Perl_debug_log,
3715 "Fast copy on write: Sharing hash\n"));
3716 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3719 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3721 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3722 SvUPGRADE(sstr, SVt_PVIV);
3723 SvREADONLY_on(sstr);
3725 DEBUG_C(PerlIO_printf(Perl_debug_log,
3726 "Fast copy on write: Converting sstr to COW\n"));
3727 SV_COW_NEXT_SV_SET(dstr, sstr);
3729 SV_COW_NEXT_SV_SET(sstr, dstr);
3730 new_pv = SvPVX_mutable(sstr);
3733 SvPV_set(dstr, new_pv);
3734 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3737 SvLEN_set(dstr, len);
3738 SvCUR_set(dstr, cur);
3747 =for apidoc sv_setpvn
3749 Copies a string into an SV. The C<len> parameter indicates the number of
3750 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3751 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3757 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3759 register char *dptr;
3761 SV_CHECK_THINKFIRST_COW_DROP(sv);
3767 /* len is STRLEN which is unsigned, need to copy to signed */
3770 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3772 SvUPGRADE(sv, SVt_PV);
3774 dptr = SvGROW(sv, len + 1);
3775 Move(ptr,dptr,len,char);
3778 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3783 =for apidoc sv_setpvn_mg
3785 Like C<sv_setpvn>, but also handles 'set' magic.
3791 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3793 sv_setpvn(sv,ptr,len);
3798 =for apidoc sv_setpv
3800 Copies a string into an SV. The string must be null-terminated. Does not
3801 handle 'set' magic. See C<sv_setpv_mg>.
3807 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3809 register STRLEN len;
3811 SV_CHECK_THINKFIRST_COW_DROP(sv);
3817 SvUPGRADE(sv, SVt_PV);
3819 SvGROW(sv, len + 1);
3820 Move(ptr,SvPVX(sv),len+1,char);
3822 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3827 =for apidoc sv_setpv_mg
3829 Like C<sv_setpv>, but also handles 'set' magic.
3835 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3842 =for apidoc sv_usepvn
3844 Tells an SV to use C<ptr> to find its string value. Normally the string is
3845 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3846 The C<ptr> should point to memory that was allocated by C<malloc>. The
3847 string length, C<len>, must be supplied. This function will realloc the
3848 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3849 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3850 See C<sv_usepvn_mg>.
3856 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3859 SV_CHECK_THINKFIRST_COW_DROP(sv);
3860 SvUPGRADE(sv, SVt_PV);
3865 if (SvPVX_const(sv))
3868 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3869 ptr = saferealloc (ptr, allocate);
3872 SvLEN_set(sv, allocate);
3874 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3879 =for apidoc sv_usepvn_mg
3881 Like C<sv_usepvn>, but also handles 'set' magic.
3887 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3889 sv_usepvn(sv,ptr,len);
3893 #ifdef PERL_OLD_COPY_ON_WRITE
3894 /* Need to do this *after* making the SV normal, as we need the buffer
3895 pointer to remain valid until after we've copied it. If we let go too early,
3896 another thread could invalidate it by unsharing last of the same hash key
3897 (which it can do by means other than releasing copy-on-write Svs)
3898 or by changing the other copy-on-write SVs in the loop. */
3900 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3902 if (len) { /* this SV was SvIsCOW_normal(sv) */
3903 /* we need to find the SV pointing to us. */
3904 SV * const current = SV_COW_NEXT_SV(after);
3906 if (current == sv) {
3907 /* The SV we point to points back to us (there were only two of us
3909 Hence other SV is no longer copy on write either. */
3911 SvREADONLY_off(after);
3913 /* We need to follow the pointers around the loop. */
3915 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3918 /* don't loop forever if the structure is bust, and we have
3919 a pointer into a closed loop. */
3920 assert (current != after);
3921 assert (SvPVX_const(current) == pvx);
3923 /* Make the SV before us point to the SV after us. */
3924 SV_COW_NEXT_SV_SET(current, after);
3927 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3932 Perl_sv_release_IVX(pTHX_ register SV *sv)
3935 sv_force_normal_flags(sv, 0);
3941 =for apidoc sv_force_normal_flags
3943 Undo various types of fakery on an SV: if the PV is a shared string, make
3944 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3945 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3946 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3947 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3948 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3949 set to some other value.) In addition, the C<flags> parameter gets passed to
3950 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3951 with flags set to 0.
3957 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3959 #ifdef PERL_OLD_COPY_ON_WRITE
3960 if (SvREADONLY(sv)) {
3961 /* At this point I believe I should acquire a global SV mutex. */
3963 const char * const pvx = SvPVX_const(sv);
3964 const STRLEN len = SvLEN(sv);
3965 const STRLEN cur = SvCUR(sv);
3966 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3968 PerlIO_printf(Perl_debug_log,
3969 "Copy on write: Force normal %ld\n",
3975 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3976 SvPV_set(sv, (char*)0);
3978 if (flags & SV_COW_DROP_PV) {
3979 /* OK, so we don't need to copy our buffer. */
3982 SvGROW(sv, cur + 1);
3983 Move(pvx,SvPVX(sv),cur,char);
3987 sv_release_COW(sv, pvx, len, next);
3992 else if (IN_PERL_RUNTIME)
3993 Perl_croak(aTHX_ PL_no_modify);
3994 /* At this point I believe that I can drop the global SV mutex. */
3997 if (SvREADONLY(sv)) {
3999 const char * const pvx = SvPVX_const(sv);
4000 const STRLEN len = SvCUR(sv);
4003 SvPV_set(sv, Nullch);
4005 SvGROW(sv, len + 1);
4006 Move(pvx,SvPVX(sv),len,char);
4008 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4010 else if (IN_PERL_RUNTIME)
4011 Perl_croak(aTHX_ PL_no_modify);
4015 sv_unref_flags(sv, flags);
4016 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4023 Efficient removal of characters from the beginning of the string buffer.
4024 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4025 the string buffer. The C<ptr> becomes the first character of the adjusted
4026 string. Uses the "OOK hack".
4027 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4028 refer to the same chunk of data.
4034 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4036 register STRLEN delta;
4037 if (!ptr || !SvPOKp(sv))
4039 delta = ptr - SvPVX_const(sv);
4040 SV_CHECK_THINKFIRST(sv);
4041 if (SvTYPE(sv) < SVt_PVIV)
4042 sv_upgrade(sv,SVt_PVIV);
4045 if (!SvLEN(sv)) { /* make copy of shared string */
4046 const char *pvx = SvPVX_const(sv);
4047 const STRLEN len = SvCUR(sv);
4048 SvGROW(sv, len + 1);
4049 Move(pvx,SvPVX(sv),len,char);
4053 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4054 and we do that anyway inside the SvNIOK_off
4056 SvFLAGS(sv) |= SVf_OOK;
4059 SvLEN_set(sv, SvLEN(sv) - delta);
4060 SvCUR_set(sv, SvCUR(sv) - delta);
4061 SvPV_set(sv, SvPVX(sv) + delta);
4062 SvIV_set(sv, SvIVX(sv) + delta);
4066 =for apidoc sv_catpvn
4068 Concatenates the string onto the end of the string which is in the SV. The
4069 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4070 status set, then the bytes appended should be valid UTF-8.
4071 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4073 =for apidoc sv_catpvn_flags
4075 Concatenates the string onto the end of the string which is in the SV. The
4076 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4077 status set, then the bytes appended should be valid UTF-8.
4078 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4079 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4080 in terms of this function.
4086 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4089 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4091 SvGROW(dsv, dlen + slen + 1);
4093 sstr = SvPVX_const(dsv);
4094 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4095 SvCUR_set(dsv, SvCUR(dsv) + slen);
4097 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4099 if (flags & SV_SMAGIC)
4104 =for apidoc sv_catsv
4106 Concatenates the string from SV C<ssv> onto the end of the string in
4107 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4108 not 'set' magic. See C<sv_catsv_mg>.
4110 =for apidoc sv_catsv_flags
4112 Concatenates the string from SV C<ssv> onto the end of the string in
4113 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4114 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4115 and C<sv_catsv_nomg> are implemented in terms of this function.
4120 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4125 if ((spv = SvPV_const(ssv, slen))) {
4126 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4127 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4128 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4129 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4130 dsv->sv_flags doesn't have that bit set.
4131 Andy Dougherty 12 Oct 2001
4133 const I32 sutf8 = DO_UTF8(ssv);
4136 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4138 dutf8 = DO_UTF8(dsv);
4140 if (dutf8 != sutf8) {
4142 /* Not modifying source SV, so taking a temporary copy. */
4143 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4145 sv_utf8_upgrade(csv);
4146 spv = SvPV_const(csv, slen);
4149 sv_utf8_upgrade_nomg(dsv);
4151 sv_catpvn_nomg(dsv, spv, slen);
4154 if (flags & SV_SMAGIC)
4159 =for apidoc sv_catpv
4161 Concatenates the string onto the end of the string which is in the SV.
4162 If the SV has the UTF-8 status set, then the bytes appended should be
4163 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4168 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4170 register STRLEN len;
4176 junk = SvPV_force(sv, tlen);
4178 SvGROW(sv, tlen + len + 1);
4180 ptr = SvPVX_const(sv);
4181 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4182 SvCUR_set(sv, SvCUR(sv) + len);
4183 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4188 =for apidoc sv_catpv_mg
4190 Like C<sv_catpv>, but also handles 'set' magic.
4196 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4205 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4206 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4213 Perl_newSV(pTHX_ STRLEN len)
4219 sv_upgrade(sv, SVt_PV);
4220 SvGROW(sv, len + 1);
4225 =for apidoc sv_magicext
4227 Adds magic to an SV, upgrading it if necessary. Applies the
4228 supplied vtable and returns a pointer to the magic added.
4230 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4231 In particular, you can add magic to SvREADONLY SVs, and add more than
4232 one instance of the same 'how'.
4234 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4235 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4236 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4237 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4239 (This is now used as a subroutine by C<sv_magic>.)
4244 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4245 const char* name, I32 namlen)
4249 if (SvTYPE(sv) < SVt_PVMG) {
4250 SvUPGRADE(sv, SVt_PVMG);
4252 Newxz(mg, 1, MAGIC);
4253 mg->mg_moremagic = SvMAGIC(sv);
4254 SvMAGIC_set(sv, mg);
4256 /* Sometimes a magic contains a reference loop, where the sv and
4257 object refer to each other. To prevent a reference loop that
4258 would prevent such objects being freed, we look for such loops
4259 and if we find one we avoid incrementing the object refcount.
4261 Note we cannot do this to avoid self-tie loops as intervening RV must
4262 have its REFCNT incremented to keep it in existence.
4265 if (!obj || obj == sv ||
4266 how == PERL_MAGIC_arylen ||
4267 how == PERL_MAGIC_qr ||
4268 how == PERL_MAGIC_symtab ||
4269 (SvTYPE(obj) == SVt_PVGV &&
4270 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4271 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4272 GvFORM(obj) == (CV*)sv)))
4277 mg->mg_obj = SvREFCNT_inc(obj);
4278 mg->mg_flags |= MGf_REFCOUNTED;
4281 /* Normal self-ties simply pass a null object, and instead of
4282 using mg_obj directly, use the SvTIED_obj macro to produce a
4283 new RV as needed. For glob "self-ties", we are tieing the PVIO
4284 with an RV obj pointing to the glob containing the PVIO. In
4285 this case, to avoid a reference loop, we need to weaken the
4289 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4290 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4296 mg->mg_len = namlen;
4299 mg->mg_ptr = savepvn(name, namlen);
4300 else if (namlen == HEf_SVKEY)
4301 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4303 mg->mg_ptr = (char *) name;
4305 mg->mg_virtual = vtable;
4309 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4314 =for apidoc sv_magic
4316 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4317 then adds a new magic item of type C<how> to the head of the magic list.
4319 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4320 handling of the C<name> and C<namlen> arguments.
4322 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4323 to add more than one instance of the same 'how'.
4329 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4331 const MGVTBL *vtable;
4334 #ifdef PERL_OLD_COPY_ON_WRITE
4336 sv_force_normal_flags(sv, 0);
4338 if (SvREADONLY(sv)) {
4340 /* its okay to attach magic to shared strings; the subsequent
4341 * upgrade to PVMG will unshare the string */
4342 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4345 && how != PERL_MAGIC_regex_global
4346 && how != PERL_MAGIC_bm
4347 && how != PERL_MAGIC_fm
4348 && how != PERL_MAGIC_sv
4349 && how != PERL_MAGIC_backref
4352 Perl_croak(aTHX_ PL_no_modify);
4355 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4356 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4357 /* sv_magic() refuses to add a magic of the same 'how' as an
4360 if (how == PERL_MAGIC_taint)
4368 vtable = &PL_vtbl_sv;
4370 case PERL_MAGIC_overload:
4371 vtable = &PL_vtbl_amagic;
4373 case PERL_MAGIC_overload_elem:
4374 vtable = &PL_vtbl_amagicelem;
4376 case PERL_MAGIC_overload_table:
4377 vtable = &PL_vtbl_ovrld;
4380 vtable = &PL_vtbl_bm;
4382 case PERL_MAGIC_regdata:
4383 vtable = &PL_vtbl_regdata;
4385 case PERL_MAGIC_regdatum:
4386 vtable = &PL_vtbl_regdatum;
4388 case PERL_MAGIC_env:
4389 vtable = &PL_vtbl_env;
4392 vtable = &PL_vtbl_fm;
4394 case PERL_MAGIC_envelem:
4395 vtable = &PL_vtbl_envelem;
4397 case PERL_MAGIC_regex_global:
4398 vtable = &PL_vtbl_mglob;
4400 case PERL_MAGIC_isa:
4401 vtable = &PL_vtbl_isa;
4403 case PERL_MAGIC_isaelem:
4404 vtable = &PL_vtbl_isaelem;
4406 case PERL_MAGIC_nkeys:
4407 vtable = &PL_vtbl_nkeys;
4409 case PERL_MAGIC_dbfile:
4412 case PERL_MAGIC_dbline:
4413 vtable = &PL_vtbl_dbline;
4415 #ifdef USE_LOCALE_COLLATE
4416 case PERL_MAGIC_collxfrm:
4417 vtable = &PL_vtbl_collxfrm;
4419 #endif /* USE_LOCALE_COLLATE */
4420 case PERL_MAGIC_tied:
4421 vtable = &PL_vtbl_pack;
4423 case PERL_MAGIC_tiedelem:
4424 case PERL_MAGIC_tiedscalar:
4425 vtable = &PL_vtbl_packelem;
4428 vtable = &PL_vtbl_regexp;
4430 case PERL_MAGIC_sig:
4431 vtable = &PL_vtbl_sig;
4433 case PERL_MAGIC_sigelem:
4434 vtable = &PL_vtbl_sigelem;
4436 case PERL_MAGIC_taint:
4437 vtable = &PL_vtbl_taint;
4439 case PERL_MAGIC_uvar:
4440 vtable = &PL_vtbl_uvar;
4442 case PERL_MAGIC_vec:
4443 vtable = &PL_vtbl_vec;
4445 case PERL_MAGIC_arylen_p:
4446 case PERL_MAGIC_rhash:
4447 case PERL_MAGIC_symtab:
4448 case PERL_MAGIC_vstring:
4451 case PERL_MAGIC_utf8:
4452 vtable = &PL_vtbl_utf8;
4454 case PERL_MAGIC_substr:
4455 vtable = &PL_vtbl_substr;
4457 case PERL_MAGIC_defelem:
4458 vtable = &PL_vtbl_defelem;
4460 case PERL_MAGIC_glob:
4461 vtable = &PL_vtbl_glob;
4463 case PERL_MAGIC_arylen:
4464 vtable = &PL_vtbl_arylen;
4466 case PERL_MAGIC_pos:
4467 vtable = &PL_vtbl_pos;
4469 case PERL_MAGIC_backref:
4470 vtable = &PL_vtbl_backref;
4472 case PERL_MAGIC_ext:
4473 /* Reserved for use by extensions not perl internals. */
4474 /* Useful for attaching extension internal data to perl vars. */
4475 /* Note that multiple extensions may clash if magical scalars */
4476 /* etc holding private data from one are passed to another. */
4480 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4483 /* Rest of work is done else where */
4484 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4487 case PERL_MAGIC_taint:
4490 case PERL_MAGIC_ext:
4491 case PERL_MAGIC_dbfile:
4498 =for apidoc sv_unmagic
4500 Removes all magic of type C<type> from an SV.
4506 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4510 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4513 for (mg = *mgp; mg; mg = *mgp) {
4514 if (mg->mg_type == type) {
4515 const MGVTBL* const vtbl = mg->mg_virtual;
4516 *mgp = mg->mg_moremagic;
4517 if (vtbl && vtbl->svt_free)
4518 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4519 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4521 Safefree(mg->mg_ptr);
4522 else if (mg->mg_len == HEf_SVKEY)
4523 SvREFCNT_dec((SV*)mg->mg_ptr);
4524 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4525 Safefree(mg->mg_ptr);
4527 if (mg->mg_flags & MGf_REFCOUNTED)
4528 SvREFCNT_dec(mg->mg_obj);
4532 mgp = &mg->mg_moremagic;
4536 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4543 =for apidoc sv_rvweaken
4545 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4546 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4547 push a back-reference to this RV onto the array of backreferences
4548 associated with that magic.
4554 Perl_sv_rvweaken(pTHX_ SV *sv)
4557 if (!SvOK(sv)) /* let undefs pass */
4560 Perl_croak(aTHX_ "Can't weaken a nonreference");
4561 else if (SvWEAKREF(sv)) {
4562 if (ckWARN(WARN_MISC))
4563 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4567 Perl_sv_add_backref(aTHX_ tsv, sv);
4573 /* Give tsv backref magic if it hasn't already got it, then push a
4574 * back-reference to sv onto the array associated with the backref magic.
4578 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4582 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4583 av = (AV*)mg->mg_obj;
4586 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4587 /* av now has a refcnt of 2, which avoids it getting freed
4588 * before us during global cleanup. The extra ref is removed
4589 * by magic_killbackrefs() when tsv is being freed */
4591 if (AvFILLp(av) >= AvMAX(av)) {
4592 av_extend(av, AvFILLp(av)+1);
4594 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4597 /* delete a back-reference to ourselves from the backref magic associated
4598 * with the SV we point to.
4602 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4608 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4609 if (PL_in_clean_all)
4612 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4613 Perl_croak(aTHX_ "panic: del_backref");
4614 av = (AV *)mg->mg_obj;
4616 /* We shouldn't be in here more than once, but for paranoia reasons lets
4618 for (i = AvFILLp(av); i >= 0; i--) {
4620 const SSize_t fill = AvFILLp(av);
4622 /* We weren't the last entry.
4623 An unordered list has this property that you can take the
4624 last element off the end to fill the hole, and it's still
4625 an unordered list :-)
4630 AvFILLp(av) = fill - 1;
4636 =for apidoc sv_insert
4638 Inserts a string at the specified offset/length within the SV. Similar to
4639 the Perl substr() function.
4645 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4649 register char *midend;
4650 register char *bigend;
4656 Perl_croak(aTHX_ "Can't modify non-existent substring");
4657 SvPV_force(bigstr, curlen);
4658 (void)SvPOK_only_UTF8(bigstr);
4659 if (offset + len > curlen) {
4660 SvGROW(bigstr, offset+len+1);
4661 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4662 SvCUR_set(bigstr, offset+len);
4666 i = littlelen - len;
4667 if (i > 0) { /* string might grow */
4668 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4669 mid = big + offset + len;
4670 midend = bigend = big + SvCUR(bigstr);
4673 while (midend > mid) /* shove everything down */
4674 *--bigend = *--midend;
4675 Move(little,big+offset,littlelen,char);
4676 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4681 Move(little,SvPVX(bigstr)+offset,len,char);
4686 big = SvPVX(bigstr);
4689 bigend = big + SvCUR(bigstr);
4691 if (midend > bigend)
4692 Perl_croak(aTHX_ "panic: sv_insert");
4694 if (mid - big > bigend - midend) { /* faster to shorten from end */
4696 Move(little, mid, littlelen,char);
4699 i = bigend - midend;
4701 Move(midend, mid, i,char);
4705 SvCUR_set(bigstr, mid - big);
4707 else if ((i = mid - big)) { /* faster from front */
4708 midend -= littlelen;
4710 sv_chop(bigstr,midend-i);
4715 Move(little, mid, littlelen,char);
4717 else if (littlelen) {
4718 midend -= littlelen;
4719 sv_chop(bigstr,midend);
4720 Move(little,midend,littlelen,char);
4723 sv_chop(bigstr,midend);
4729 =for apidoc sv_replace
4731 Make the first argument a copy of the second, then delete the original.
4732 The target SV physically takes over ownership of the body of the source SV
4733 and inherits its flags; however, the target keeps any magic it owns,
4734 and any magic in the source is discarded.
4735 Note that this is a rather specialist SV copying operation; most of the
4736 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4742 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4744 const U32 refcnt = SvREFCNT(sv);
4745 SV_CHECK_THINKFIRST_COW_DROP(sv);
4746 if (SvREFCNT(nsv) != 1) {
4747 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4748 UVuf " != 1)", (UV) SvREFCNT(nsv));
4750 if (SvMAGICAL(sv)) {
4754 sv_upgrade(nsv, SVt_PVMG);
4755 SvMAGIC_set(nsv, SvMAGIC(sv));
4756 SvFLAGS(nsv) |= SvMAGICAL(sv);
4758 SvMAGIC_set(sv, NULL);
4762 assert(!SvREFCNT(sv));
4763 #ifdef DEBUG_LEAKING_SCALARS
4764 sv->sv_flags = nsv->sv_flags;
4765 sv->sv_any = nsv->sv_any;
4766 sv->sv_refcnt = nsv->sv_refcnt;
4767 sv->sv_u = nsv->sv_u;
4769 StructCopy(nsv,sv,SV);
4771 /* Currently could join these into one piece of pointer arithmetic, but
4772 it would be unclear. */
4773 if(SvTYPE(sv) == SVt_IV)
4775 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4776 else if (SvTYPE(sv) == SVt_RV) {
4777 SvANY(sv) = &sv->sv_u.svu_rv;
4781 #ifdef PERL_OLD_COPY_ON_WRITE
4782 if (SvIsCOW_normal(nsv)) {
4783 /* We need to follow the pointers around the loop to make the
4784 previous SV point to sv, rather than nsv. */
4787 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4790 assert(SvPVX_const(current) == SvPVX_const(nsv));
4792 /* Make the SV before us point to the SV after us. */
4794 PerlIO_printf(Perl_debug_log, "previous is\n");
4796 PerlIO_printf(Perl_debug_log,
4797 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4798 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4800 SV_COW_NEXT_SV_SET(current, sv);
4803 SvREFCNT(sv) = refcnt;
4804 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4810 =for apidoc sv_clear
4812 Clear an SV: call any destructors, free up any memory used by the body,
4813 and free the body itself. The SV's head is I<not> freed, although
4814 its type is set to all 1's so that it won't inadvertently be assumed
4815 to be live during global destruction etc.
4816 This function should only be called when REFCNT is zero. Most of the time
4817 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4824 Perl_sv_clear(pTHX_ register SV *sv)
4827 const U32 type = SvTYPE(sv);
4828 const struct body_details *const sv_type_details
4829 = bodies_by_type + type;
4832 assert(SvREFCNT(sv) == 0);
4838 if (PL_defstash) { /* Still have a symbol table? */
4843 stash = SvSTASH(sv);
4844 destructor = StashHANDLER(stash,DESTROY);
4846 SV* const tmpref = newRV(sv);
4847 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4849 PUSHSTACKi(PERLSI_DESTROY);
4854 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4860 if(SvREFCNT(tmpref) < 2) {
4861 /* tmpref is not kept alive! */
4863 SvRV_set(tmpref, NULL);
4866 SvREFCNT_dec(tmpref);
4868 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4872 if (PL_in_clean_objs)
4873 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4875 /* DESTROY gave object new lease on life */
4881 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4882 SvOBJECT_off(sv); /* Curse the object. */
4883 if (type != SVt_PVIO)
4884 --PL_sv_objcount; /* XXX Might want something more general */
4887 if (type >= SVt_PVMG) {
4890 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4891 SvREFCNT_dec(SvSTASH(sv));
4896 IoIFP(sv) != PerlIO_stdin() &&
4897 IoIFP(sv) != PerlIO_stdout() &&
4898 IoIFP(sv) != PerlIO_stderr())
4900 io_close((IO*)sv, FALSE);
4902 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4903 PerlDir_close(IoDIRP(sv));
4904 IoDIRP(sv) = (DIR*)NULL;
4905 Safefree(IoTOP_NAME(sv));
4906 Safefree(IoFMT_NAME(sv));
4907 Safefree(IoBOTTOM_NAME(sv));
4922 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4923 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4924 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4925 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4927 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4928 SvREFCNT_dec(LvTARG(sv));
4932 Safefree(GvNAME(sv));
4933 /* If we're in a stash, we don't own a reference to it. However it does
4934 have a back reference to us, which needs to be cleared. */
4936 sv_del_backref((SV*)GvSTASH(sv), sv);
4941 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4943 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4944 /* Don't even bother with turning off the OOK flag. */
4949 SV *target = SvRV(sv);
4951 sv_del_backref(target, sv);
4953 SvREFCNT_dec(target);
4955 #ifdef PERL_OLD_COPY_ON_WRITE
4956 else if (SvPVX_const(sv)) {
4958 /* I believe I need to grab the global SV mutex here and
4959 then recheck the COW status. */
4961 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4964 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4965 SV_COW_NEXT_SV(sv));
4966 /* And drop it here. */
4968 } else if (SvLEN(sv)) {
4969 Safefree(SvPVX_const(sv));
4973 else if (SvPVX_const(sv) && SvLEN(sv))
4974 Safefree(SvPVX_mutable(sv));
4975 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4976 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4985 SvFLAGS(sv) &= SVf_BREAK;
4986 SvFLAGS(sv) |= SVTYPEMASK;
4988 if (sv_type_details->arena) {
4989 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4990 &PL_body_roots[type]);
4992 else if (sv_type_details->size) {
4993 my_safefree(SvANY(sv));
4998 =for apidoc sv_newref
5000 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5007 Perl_sv_newref(pTHX_ SV *sv)
5017 Decrement an SV's reference count, and if it drops to zero, call
5018 C<sv_clear> to invoke destructors and free up any memory used by
5019 the body; finally, deallocate the SV's head itself.
5020 Normally called via a wrapper macro C<SvREFCNT_dec>.
5026 Perl_sv_free(pTHX_ SV *sv)
5031 if (SvREFCNT(sv) == 0) {
5032 if (SvFLAGS(sv) & SVf_BREAK)
5033 /* this SV's refcnt has been artificially decremented to
5034 * trigger cleanup */
5036 if (PL_in_clean_all) /* All is fair */
5038 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5039 /* make sure SvREFCNT(sv)==0 happens very seldom */
5040 SvREFCNT(sv) = (~(U32)0)/2;
5043 if (ckWARN_d(WARN_INTERNAL)) {
5044 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5045 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5046 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5047 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5048 Perl_dump_sv_child(aTHX_ sv);
5053 if (--(SvREFCNT(sv)) > 0)
5055 Perl_sv_free2(aTHX_ sv);
5059 Perl_sv_free2(pTHX_ SV *sv)
5064 if (ckWARN_d(WARN_DEBUGGING))
5065 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5066 "Attempt to free temp prematurely: SV 0x%"UVxf
5067 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5071 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5072 /* make sure SvREFCNT(sv)==0 happens very seldom */
5073 SvREFCNT(sv) = (~(U32)0)/2;
5084 Returns the length of the string in the SV. Handles magic and type
5085 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5091 Perl_sv_len(pTHX_ register SV *sv)
5099 len = mg_length(sv);
5101 (void)SvPV_const(sv, len);
5106 =for apidoc sv_len_utf8
5108 Returns the number of characters in the string in an SV, counting wide
5109 UTF-8 bytes as a single character. Handles magic and type coercion.
5115 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5116 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5117 * (Note that the mg_len is not the length of the mg_ptr field.)
5122 Perl_sv_len_utf8(pTHX_ register SV *sv)
5128 return mg_length(sv);
5132 const U8 *s = (U8*)SvPV_const(sv, len);
5133 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5135 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5137 #ifdef PERL_UTF8_CACHE_ASSERT
5138 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5142 ulen = Perl_utf8_length(aTHX_ s, s + len);
5143 if (!mg && !SvREADONLY(sv)) {
5144 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5145 mg = mg_find(sv, PERL_MAGIC_utf8);
5155 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5156 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5157 * between UTF-8 and byte offsets. There are two (substr offset and substr
5158 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5159 * and byte offset) cache positions.
5161 * The mg_len field is used by sv_len_utf8(), see its comments.
5162 * Note that the mg_len is not the length of the mg_ptr field.
5166 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5167 I32 offsetp, const U8 *s, const U8 *start)
5171 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5173 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5177 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5179 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5180 (*mgp)->mg_ptr = (char *) *cachep;
5184 (*cachep)[i] = offsetp;
5185 (*cachep)[i+1] = s - start;
5193 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5194 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5195 * between UTF-8 and byte offsets. See also the comments of
5196 * S_utf8_mg_pos_init().
5200 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)
5204 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5206 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5207 if (*mgp && (*mgp)->mg_ptr) {
5208 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5209 ASSERT_UTF8_CACHE(*cachep);
5210 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5212 else { /* We will skip to the right spot. */
5217 /* The assumption is that going backward is half
5218 * the speed of going forward (that's where the
5219 * 2 * backw in the below comes from). (The real
5220 * figure of course depends on the UTF-8 data.) */
5222 if ((*cachep)[i] > (STRLEN)uoff) {
5224 backw = (*cachep)[i] - (STRLEN)uoff;
5226 if (forw < 2 * backw)
5229 p = start + (*cachep)[i+1];
5231 /* Try this only for the substr offset (i == 0),
5232 * not for the substr length (i == 2). */
5233 else if (i == 0) { /* (*cachep)[i] < uoff */
5234 const STRLEN ulen = sv_len_utf8(sv);
5236 if ((STRLEN)uoff < ulen) {
5237 forw = (STRLEN)uoff - (*cachep)[i];
5238 backw = ulen - (STRLEN)uoff;
5240 if (forw < 2 * backw)
5241 p = start + (*cachep)[i+1];
5246 /* If the string is not long enough for uoff,
5247 * we could extend it, but not at this low a level. */
5251 if (forw < 2 * backw) {
5258 while (UTF8_IS_CONTINUATION(*p))
5263 /* Update the cache. */
5264 (*cachep)[i] = (STRLEN)uoff;
5265 (*cachep)[i+1] = p - start;
5267 /* Drop the stale "length" cache */
5276 if (found) { /* Setup the return values. */
5277 *offsetp = (*cachep)[i+1];
5278 *sp = start + *offsetp;
5281 *offsetp = send - start;
5283 else if (*sp < start) {
5289 #ifdef PERL_UTF8_CACHE_ASSERT
5294 while (n-- && s < send)
5298 assert(*offsetp == s - start);
5299 assert((*cachep)[0] == (STRLEN)uoff);
5300 assert((*cachep)[1] == *offsetp);
5302 ASSERT_UTF8_CACHE(*cachep);
5311 =for apidoc sv_pos_u2b
5313 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5314 the start of the string, to a count of the equivalent number of bytes; if
5315 lenp is non-zero, it does the same to lenp, but this time starting from
5316 the offset, rather than from the start of the string. Handles magic and
5323 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5324 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5325 * byte offsets. See also the comments of S_utf8_mg_pos().
5330 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5338 start = (U8*)SvPV_const(sv, len);
5342 const U8 *s = start;
5343 I32 uoffset = *offsetp;
5344 const U8 * const send = s + len;
5348 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5350 if (!found && uoffset > 0) {
5351 while (s < send && uoffset--)
5355 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5357 *offsetp = s - start;
5362 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5366 if (!found && *lenp > 0) {
5369 while (s < send && ulen--)
5373 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5377 ASSERT_UTF8_CACHE(cache);
5389 =for apidoc sv_pos_b2u
5391 Converts the value pointed to by offsetp from a count of bytes from the
5392 start of the string, to a count of the equivalent number of UTF-8 chars.
5393 Handles magic and type coercion.
5399 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5400 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5401 * byte offsets. See also the comments of S_utf8_mg_pos().
5406 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5414 s = (const U8*)SvPV_const(sv, len);
5415 if ((I32)len < *offsetp)
5416 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5418 const U8* send = s + *offsetp;
5420 STRLEN *cache = NULL;
5424 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5425 mg = mg_find(sv, PERL_MAGIC_utf8);
5426 if (mg && mg->mg_ptr) {
5427 cache = (STRLEN *) mg->mg_ptr;
5428 if (cache[1] == (STRLEN)*offsetp) {
5429 /* An exact match. */
5430 *offsetp = cache[0];
5434 else if (cache[1] < (STRLEN)*offsetp) {
5435 /* We already know part of the way. */
5438 /* Let the below loop do the rest. */
5440 else { /* cache[1] > *offsetp */
5441 /* We already know all of the way, now we may
5442 * be able to walk back. The same assumption
5443 * is made as in S_utf8_mg_pos(), namely that
5444 * walking backward is twice slower than
5445 * walking forward. */
5446 const STRLEN forw = *offsetp;
5447 STRLEN backw = cache[1] - *offsetp;
5449 if (!(forw < 2 * backw)) {
5450 const U8 *p = s + cache[1];
5457 while (UTF8_IS_CONTINUATION(*p)) {
5465 *offsetp = cache[0];
5467 /* Drop the stale "length" cache */
5475 ASSERT_UTF8_CACHE(cache);
5481 /* Call utf8n_to_uvchr() to validate the sequence
5482 * (unless a simple non-UTF character) */
5483 if (!UTF8_IS_INVARIANT(*s))
5484 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5493 if (!SvREADONLY(sv)) {
5495 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5496 mg = mg_find(sv, PERL_MAGIC_utf8);
5501 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5502 mg->mg_ptr = (char *) cache;
5507 cache[1] = *offsetp;
5508 /* Drop the stale "length" cache */
5521 Returns a boolean indicating whether the strings in the two SVs are
5522 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5523 coerce its args to strings if necessary.
5529 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5537 SV* svrecode = Nullsv;
5544 pv1 = SvPV_const(sv1, cur1);
5551 pv2 = SvPV_const(sv2, cur2);
5553 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5554 /* Differing utf8ness.
5555 * Do not UTF8size the comparands as a side-effect. */
5558 svrecode = newSVpvn(pv2, cur2);
5559 sv_recode_to_utf8(svrecode, PL_encoding);
5560 pv2 = SvPV_const(svrecode, cur2);
5563 svrecode = newSVpvn(pv1, cur1);
5564 sv_recode_to_utf8(svrecode, PL_encoding);
5565 pv1 = SvPV_const(svrecode, cur1);
5567 /* Now both are in UTF-8. */
5569 SvREFCNT_dec(svrecode);
5574 bool is_utf8 = TRUE;
5577 /* sv1 is the UTF-8 one,
5578 * if is equal it must be downgrade-able */
5579 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5585 /* sv2 is the UTF-8 one,
5586 * if is equal it must be downgrade-able */
5587 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5593 /* Downgrade not possible - cannot be eq */
5601 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5604 SvREFCNT_dec(svrecode);
5615 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5616 string in C<sv1> is less than, equal to, or greater than the string in
5617 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5618 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5624 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5627 const char *pv1, *pv2;
5630 SV *svrecode = Nullsv;
5637 pv1 = SvPV_const(sv1, cur1);
5644 pv2 = SvPV_const(sv2, cur2);
5646 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5647 /* Differing utf8ness.
5648 * Do not UTF8size the comparands as a side-effect. */
5651 svrecode = newSVpvn(pv2, cur2);
5652 sv_recode_to_utf8(svrecode, PL_encoding);
5653 pv2 = SvPV_const(svrecode, cur2);
5656 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5661 svrecode = newSVpvn(pv1, cur1);
5662 sv_recode_to_utf8(svrecode, PL_encoding);
5663 pv1 = SvPV_const(svrecode, cur1);
5666 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5672 cmp = cur2 ? -1 : 0;
5676 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5679 cmp = retval < 0 ? -1 : 1;
5680 } else if (cur1 == cur2) {
5683 cmp = cur1 < cur2 ? -1 : 1;
5688 SvREFCNT_dec(svrecode);
5697 =for apidoc sv_cmp_locale
5699 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5700 'use bytes' aware, handles get magic, and will coerce its args to strings
5701 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5707 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5709 #ifdef USE_LOCALE_COLLATE
5715 if (PL_collation_standard)
5719 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5721 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5723 if (!pv1 || !len1) {
5734 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5737 return retval < 0 ? -1 : 1;
5740 * When the result of collation is equality, that doesn't mean
5741 * that there are no differences -- some locales exclude some
5742 * characters from consideration. So to avoid false equalities,
5743 * we use the raw string as a tiebreaker.
5749 #endif /* USE_LOCALE_COLLATE */
5751 return sv_cmp(sv1, sv2);
5755 #ifdef USE_LOCALE_COLLATE
5758 =for apidoc sv_collxfrm
5760 Add Collate Transform magic to an SV if it doesn't already have it.
5762 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5763 scalar data of the variable, but transformed to such a format that a normal
5764 memory comparison can be used to compare the data according to the locale
5771 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5775 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5776 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5782 Safefree(mg->mg_ptr);
5783 s = SvPV_const(sv, len);
5784 if ((xf = mem_collxfrm(s, len, &xlen))) {
5785 if (SvREADONLY(sv)) {
5788 return xf + sizeof(PL_collation_ix);
5791 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5792 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5805 if (mg && mg->mg_ptr) {
5807 return mg->mg_ptr + sizeof(PL_collation_ix);
5815 #endif /* USE_LOCALE_COLLATE */
5820 Get a line from the filehandle and store it into the SV, optionally
5821 appending to the currently-stored string.
5827 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5831 register STDCHAR rslast;
5832 register STDCHAR *bp;
5838 if (SvTHINKFIRST(sv))
5839 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5840 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5842 However, perlbench says it's slower, because the existing swipe code
5843 is faster than copy on write.
5844 Swings and roundabouts. */
5845 SvUPGRADE(sv, SVt_PV);
5850 if (PerlIO_isutf8(fp)) {
5852 sv_utf8_upgrade_nomg(sv);
5853 sv_pos_u2b(sv,&append,0);
5855 } else if (SvUTF8(sv)) {
5856 SV * const tsv = NEWSV(0,0);
5857 sv_gets(tsv, fp, 0);
5858 sv_utf8_upgrade_nomg(tsv);
5859 SvCUR_set(sv,append);
5862 goto return_string_or_null;
5867 if (PerlIO_isutf8(fp))
5870 if (IN_PERL_COMPILETIME) {
5871 /* we always read code in line mode */
5875 else if (RsSNARF(PL_rs)) {
5876 /* If it is a regular disk file use size from stat() as estimate
5877 of amount we are going to read - may result in malloc-ing
5878 more memory than we realy need if layers bellow reduce
5879 size we read (e.g. CRLF or a gzip layer)
5882 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5883 const Off_t offset = PerlIO_tell(fp);
5884 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5885 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5891 else if (RsRECORD(PL_rs)) {
5895 /* Grab the size of the record we're getting */
5896 recsize = SvIV(SvRV(PL_rs));
5897 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5900 /* VMS wants read instead of fread, because fread doesn't respect */
5901 /* RMS record boundaries. This is not necessarily a good thing to be */
5902 /* doing, but we've got no other real choice - except avoid stdio
5903 as implementation - perhaps write a :vms layer ?
5905 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5907 bytesread = PerlIO_read(fp, buffer, recsize);
5911 SvCUR_set(sv, bytesread += append);
5912 buffer[bytesread] = '\0';
5913 goto return_string_or_null;
5915 else if (RsPARA(PL_rs)) {
5921 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5922 if (PerlIO_isutf8(fp)) {
5923 rsptr = SvPVutf8(PL_rs, rslen);
5926 if (SvUTF8(PL_rs)) {
5927 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5928 Perl_croak(aTHX_ "Wide character in $/");
5931 rsptr = SvPV_const(PL_rs, rslen);
5935 rslast = rslen ? rsptr[rslen - 1] : '\0';
5937 if (rspara) { /* have to do this both before and after */
5938 do { /* to make sure file boundaries work right */
5941 i = PerlIO_getc(fp);
5945 PerlIO_ungetc(fp,i);
5951 /* See if we know enough about I/O mechanism to cheat it ! */
5953 /* This used to be #ifdef test - it is made run-time test for ease
5954 of abstracting out stdio interface. One call should be cheap
5955 enough here - and may even be a macro allowing compile
5959 if (PerlIO_fast_gets(fp)) {
5962 * We're going to steal some values from the stdio struct
5963 * and put EVERYTHING in the innermost loop into registers.
5965 register STDCHAR *ptr;
5969 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5970 /* An ungetc()d char is handled separately from the regular
5971 * buffer, so we getc() it back out and stuff it in the buffer.
5973 i = PerlIO_getc(fp);
5974 if (i == EOF) return 0;
5975 *(--((*fp)->_ptr)) = (unsigned char) i;
5979 /* Here is some breathtakingly efficient cheating */
5981 cnt = PerlIO_get_cnt(fp); /* get count into register */
5982 /* make sure we have the room */
5983 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5984 /* Not room for all of it
5985 if we are looking for a separator and room for some
5987 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5988 /* just process what we have room for */
5989 shortbuffered = cnt - SvLEN(sv) + append + 1;
5990 cnt -= shortbuffered;
5994 /* remember that cnt can be negative */
5995 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6000 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6001 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6002 DEBUG_P(PerlIO_printf(Perl_debug_log,
6003 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6004 DEBUG_P(PerlIO_printf(Perl_debug_log,
6005 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6006 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6007 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6012 while (cnt > 0) { /* this | eat */
6014 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6015 goto thats_all_folks; /* screams | sed :-) */
6019 Copy(ptr, bp, cnt, char); /* this | eat */
6020 bp += cnt; /* screams | dust */
6021 ptr += cnt; /* louder | sed :-) */
6026 if (shortbuffered) { /* oh well, must extend */
6027 cnt = shortbuffered;
6029 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6031 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6032 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6036 DEBUG_P(PerlIO_printf(Perl_debug_log,
6037 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6038 PTR2UV(ptr),(long)cnt));
6039 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6041 DEBUG_P(PerlIO_printf(Perl_debug_log,
6042 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6043 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6044 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6046 /* This used to call 'filbuf' in stdio form, but as that behaves like
6047 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6048 another abstraction. */
6049 i = PerlIO_getc(fp); /* get more characters */
6051 DEBUG_P(PerlIO_printf(Perl_debug_log,
6052 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6053 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6054 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6056 cnt = PerlIO_get_cnt(fp);
6057 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6058 DEBUG_P(PerlIO_printf(Perl_debug_log,
6059 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6061 if (i == EOF) /* all done for ever? */
6062 goto thats_really_all_folks;
6064 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6066 SvGROW(sv, bpx + cnt + 2);
6067 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6069 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6071 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6072 goto thats_all_folks;
6076 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6077 memNE((char*)bp - rslen, rsptr, rslen))
6078 goto screamer; /* go back to the fray */
6079 thats_really_all_folks:
6081 cnt += shortbuffered;
6082 DEBUG_P(PerlIO_printf(Perl_debug_log,
6083 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6084 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6085 DEBUG_P(PerlIO_printf(Perl_debug_log,
6086 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6087 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6088 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6090 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6091 DEBUG_P(PerlIO_printf(Perl_debug_log,
6092 "Screamer: done, len=%ld, string=|%.*s|\n",
6093 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6097 /*The big, slow, and stupid way. */
6098 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6100 Newx(buf, 8192, STDCHAR);
6108 register const STDCHAR *bpe = buf + sizeof(buf);
6110 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6111 ; /* keep reading */
6115 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6116 /* Accomodate broken VAXC compiler, which applies U8 cast to
6117 * both args of ?: operator, causing EOF to change into 255
6120 i = (U8)buf[cnt - 1];
6126 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6128 sv_catpvn(sv, (char *) buf, cnt);
6130 sv_setpvn(sv, (char *) buf, cnt);
6132 if (i != EOF && /* joy */
6134 SvCUR(sv) < rslen ||
6135 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6139 * If we're reading from a TTY and we get a short read,
6140 * indicating that the user hit his EOF character, we need
6141 * to notice it now, because if we try to read from the TTY
6142 * again, the EOF condition will disappear.
6144 * The comparison of cnt to sizeof(buf) is an optimization
6145 * that prevents unnecessary calls to feof().
6149 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6153 #ifdef USE_HEAP_INSTEAD_OF_STACK
6158 if (rspara) { /* have to do this both before and after */
6159 while (i != EOF) { /* to make sure file boundaries work right */
6160 i = PerlIO_getc(fp);
6162 PerlIO_ungetc(fp,i);
6168 return_string_or_null:
6169 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6175 Auto-increment of the value in the SV, doing string to numeric conversion
6176 if necessary. Handles 'get' magic.
6182 Perl_sv_inc(pTHX_ register SV *sv)
6190 if (SvTHINKFIRST(sv)) {
6192 sv_force_normal_flags(sv, 0);
6193 if (SvREADONLY(sv)) {
6194 if (IN_PERL_RUNTIME)
6195 Perl_croak(aTHX_ PL_no_modify);
6199 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6201 i = PTR2IV(SvRV(sv));
6206 flags = SvFLAGS(sv);
6207 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6208 /* It's (privately or publicly) a float, but not tested as an
6209 integer, so test it to see. */
6211 flags = SvFLAGS(sv);
6213 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6214 /* It's publicly an integer, or privately an integer-not-float */
6215 #ifdef PERL_PRESERVE_IVUV
6219 if (SvUVX(sv) == UV_MAX)
6220 sv_setnv(sv, UV_MAX_P1);
6222 (void)SvIOK_only_UV(sv);
6223 SvUV_set(sv, SvUVX(sv) + 1);
6225 if (SvIVX(sv) == IV_MAX)
6226 sv_setuv(sv, (UV)IV_MAX + 1);
6228 (void)SvIOK_only(sv);
6229 SvIV_set(sv, SvIVX(sv) + 1);
6234 if (flags & SVp_NOK) {
6235 (void)SvNOK_only(sv);
6236 SvNV_set(sv, SvNVX(sv) + 1.0);
6240 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6241 if ((flags & SVTYPEMASK) < SVt_PVIV)
6242 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6243 (void)SvIOK_only(sv);
6248 while (isALPHA(*d)) d++;
6249 while (isDIGIT(*d)) d++;
6251 #ifdef PERL_PRESERVE_IVUV
6252 /* Got to punt this as an integer if needs be, but we don't issue
6253 warnings. Probably ought to make the sv_iv_please() that does
6254 the conversion if possible, and silently. */
6255 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6256 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6257 /* Need to try really hard to see if it's an integer.
6258 9.22337203685478e+18 is an integer.
6259 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6260 so $a="9.22337203685478e+18"; $a+0; $a++
6261 needs to be the same as $a="9.22337203685478e+18"; $a++
6268 /* sv_2iv *should* have made this an NV */
6269 if (flags & SVp_NOK) {
6270 (void)SvNOK_only(sv);
6271 SvNV_set(sv, SvNVX(sv) + 1.0);
6274 /* I don't think we can get here. Maybe I should assert this
6275 And if we do get here I suspect that sv_setnv will croak. NWC
6277 #if defined(USE_LONG_DOUBLE)
6278 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",
6279 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6281 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6282 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6285 #endif /* PERL_PRESERVE_IVUV */
6286 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6290 while (d >= SvPVX_const(sv)) {
6298 /* MKS: The original code here died if letters weren't consecutive.
6299 * at least it didn't have to worry about non-C locales. The
6300 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6301 * arranged in order (although not consecutively) and that only
6302 * [A-Za-z] are accepted by isALPHA in the C locale.
6304 if (*d != 'z' && *d != 'Z') {
6305 do { ++*d; } while (!isALPHA(*d));
6308 *(d--) -= 'z' - 'a';
6313 *(d--) -= 'z' - 'a' + 1;
6317 /* oh,oh, the number grew */
6318 SvGROW(sv, SvCUR(sv) + 2);
6319 SvCUR_set(sv, SvCUR(sv) + 1);
6320 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6331 Auto-decrement of the value in the SV, doing string to numeric conversion
6332 if necessary. Handles 'get' magic.
6338 Perl_sv_dec(pTHX_ register SV *sv)
6345 if (SvTHINKFIRST(sv)) {
6347 sv_force_normal_flags(sv, 0);
6348 if (SvREADONLY(sv)) {
6349 if (IN_PERL_RUNTIME)
6350 Perl_croak(aTHX_ PL_no_modify);
6354 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6356 i = PTR2IV(SvRV(sv));
6361 /* Unlike sv_inc we don't have to worry about string-never-numbers
6362 and keeping them magic. But we mustn't warn on punting */
6363 flags = SvFLAGS(sv);
6364 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6365 /* It's publicly an integer, or privately an integer-not-float */
6366 #ifdef PERL_PRESERVE_IVUV
6370 if (SvUVX(sv) == 0) {
6371 (void)SvIOK_only(sv);
6375 (void)SvIOK_only_UV(sv);
6376 SvUV_set(sv, SvUVX(sv) - 1);
6379 if (SvIVX(sv) == IV_MIN)
6380 sv_setnv(sv, (NV)IV_MIN - 1.0);
6382 (void)SvIOK_only(sv);
6383 SvIV_set(sv, SvIVX(sv) - 1);
6388 if (flags & SVp_NOK) {
6389 SvNV_set(sv, SvNVX(sv) - 1.0);
6390 (void)SvNOK_only(sv);
6393 if (!(flags & SVp_POK)) {
6394 if ((flags & SVTYPEMASK) < SVt_PVIV)
6395 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6397 (void)SvIOK_only(sv);
6400 #ifdef PERL_PRESERVE_IVUV
6402 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6403 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6404 /* Need to try really hard to see if it's an integer.
6405 9.22337203685478e+18 is an integer.
6406 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6407 so $a="9.22337203685478e+18"; $a+0; $a--
6408 needs to be the same as $a="9.22337203685478e+18"; $a--
6415 /* sv_2iv *should* have made this an NV */
6416 if (flags & SVp_NOK) {
6417 (void)SvNOK_only(sv);
6418 SvNV_set(sv, SvNVX(sv) - 1.0);
6421 /* I don't think we can get here. Maybe I should assert this
6422 And if we do get here I suspect that sv_setnv will croak. NWC
6424 #if defined(USE_LONG_DOUBLE)
6425 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",
6426 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6428 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6429 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6433 #endif /* PERL_PRESERVE_IVUV */
6434 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6438 =for apidoc sv_mortalcopy
6440 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6441 The new SV is marked as mortal. It will be destroyed "soon", either by an
6442 explicit call to FREETMPS, or by an implicit call at places such as
6443 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6448 /* Make a string that will exist for the duration of the expression
6449 * evaluation. Actually, it may have to last longer than that, but
6450 * hopefully we won't free it until it has been assigned to a
6451 * permanent location. */
6454 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6459 sv_setsv(sv,oldstr);
6461 PL_tmps_stack[++PL_tmps_ix] = sv;
6467 =for apidoc sv_newmortal
6469 Creates a new null SV which is mortal. The reference count of the SV is
6470 set to 1. It will be destroyed "soon", either by an explicit call to
6471 FREETMPS, or by an implicit call at places such as statement boundaries.
6472 See also C<sv_mortalcopy> and C<sv_2mortal>.
6478 Perl_sv_newmortal(pTHX)
6483 SvFLAGS(sv) = SVs_TEMP;
6485 PL_tmps_stack[++PL_tmps_ix] = sv;
6490 =for apidoc sv_2mortal
6492 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6493 by an explicit call to FREETMPS, or by an implicit call at places such as
6494 statement boundaries. SvTEMP() is turned on which means that the SV's
6495 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6496 and C<sv_mortalcopy>.
6502 Perl_sv_2mortal(pTHX_ register SV *sv)
6507 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6510 PL_tmps_stack[++PL_tmps_ix] = sv;
6518 Creates a new SV and copies a string into it. The reference count for the
6519 SV is set to 1. If C<len> is zero, Perl will compute the length using
6520 strlen(). For efficiency, consider using C<newSVpvn> instead.
6526 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6531 sv_setpvn(sv,s,len ? len : strlen(s));
6536 =for apidoc newSVpvn
6538 Creates a new SV and copies a string into it. The reference count for the
6539 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6540 string. You are responsible for ensuring that the source string is at least
6541 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6547 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6552 sv_setpvn(sv,s,len);
6558 =for apidoc newSVhek
6560 Creates a new SV from the hash key structure. It will generate scalars that
6561 point to the shared string table where possible. Returns a new (undefined)
6562 SV if the hek is NULL.
6568 Perl_newSVhek(pTHX_ const HEK *hek)
6577 if (HEK_LEN(hek) == HEf_SVKEY) {
6578 return newSVsv(*(SV**)HEK_KEY(hek));
6580 const int flags = HEK_FLAGS(hek);
6581 if (flags & HVhek_WASUTF8) {
6583 Andreas would like keys he put in as utf8 to come back as utf8
6585 STRLEN utf8_len = HEK_LEN(hek);
6586 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6587 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6590 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6592 } else if (flags & HVhek_REHASH) {
6593 /* We don't have a pointer to the hv, so we have to replicate the
6594 flag into every HEK. This hv is using custom a hasing
6595 algorithm. Hence we can't return a shared string scalar, as
6596 that would contain the (wrong) hash value, and might get passed
6597 into an hv routine with a regular hash */
6599 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6604 /* This will be overwhelminly the most common case. */
6605 return newSVpvn_share(HEK_KEY(hek),
6606 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6612 =for apidoc newSVpvn_share
6614 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6615 table. If the string does not already exist in the table, it is created
6616 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6617 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6618 otherwise the hash is computed. The idea here is that as the string table
6619 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6620 hash lookup will avoid string compare.
6626 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6629 bool is_utf8 = FALSE;
6631 STRLEN tmplen = -len;
6633 /* See the note in hv.c:hv_fetch() --jhi */
6634 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6638 PERL_HASH(hash, src, len);
6640 sv_upgrade(sv, SVt_PV);
6641 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6653 #if defined(PERL_IMPLICIT_CONTEXT)
6655 /* pTHX_ magic can't cope with varargs, so this is a no-context
6656 * version of the main function, (which may itself be aliased to us).
6657 * Don't access this version directly.
6661 Perl_newSVpvf_nocontext(const char* pat, ...)
6666 va_start(args, pat);
6667 sv = vnewSVpvf(pat, &args);
6674 =for apidoc newSVpvf
6676 Creates a new SV and initializes it with the string formatted like
6683 Perl_newSVpvf(pTHX_ const char* pat, ...)
6687 va_start(args, pat);
6688 sv = vnewSVpvf(pat, &args);
6693 /* backend for newSVpvf() and newSVpvf_nocontext() */
6696 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6700 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6707 Creates a new SV and copies a floating point value into it.
6708 The reference count for the SV is set to 1.
6714 Perl_newSVnv(pTHX_ NV n)
6726 Creates a new SV and copies an integer into it. The reference count for the
6733 Perl_newSViv(pTHX_ IV i)
6745 Creates a new SV and copies an unsigned integer into it.
6746 The reference count for the SV is set to 1.
6752 Perl_newSVuv(pTHX_ UV u)
6762 =for apidoc newRV_noinc
6764 Creates an RV wrapper for an SV. The reference count for the original
6765 SV is B<not> incremented.
6771 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6776 sv_upgrade(sv, SVt_RV);
6778 SvRV_set(sv, tmpRef);
6783 /* newRV_inc is the official function name to use now.
6784 * newRV_inc is in fact #defined to newRV in sv.h
6788 Perl_newRV(pTHX_ SV *tmpRef)
6790 return newRV_noinc(SvREFCNT_inc(tmpRef));
6796 Creates a new SV which is an exact duplicate of the original SV.
6803 Perl_newSVsv(pTHX_ register SV *old)
6809 if (SvTYPE(old) == SVTYPEMASK) {
6810 if (ckWARN_d(WARN_INTERNAL))
6811 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6815 /* SV_GMAGIC is the default for sv_setv()
6816 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6817 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6818 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6823 =for apidoc sv_reset
6825 Underlying implementation for the C<reset> Perl function.
6826 Note that the perl-level function is vaguely deprecated.
6832 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6835 char todo[PERL_UCHAR_MAX+1];
6840 if (!*s) { /* reset ?? searches */
6841 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6843 PMOP *pm = (PMOP *) mg->mg_obj;
6845 pm->op_pmdynflags &= ~PMdf_USED;
6852 /* reset variables */
6854 if (!HvARRAY(stash))
6857 Zero(todo, 256, char);
6860 I32 i = (unsigned char)*s;
6864 max = (unsigned char)*s++;
6865 for ( ; i <= max; i++) {
6868 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6870 for (entry = HvARRAY(stash)[i];
6872 entry = HeNEXT(entry))
6877 if (!todo[(U8)*HeKEY(entry)])
6879 gv = (GV*)HeVAL(entry);
6882 if (SvTHINKFIRST(sv)) {
6883 if (!SvREADONLY(sv) && SvROK(sv))
6885 /* XXX Is this continue a bug? Why should THINKFIRST
6886 exempt us from resetting arrays and hashes? */
6890 if (SvTYPE(sv) >= SVt_PV) {
6892 if (SvPVX_const(sv) != Nullch)
6900 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6902 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6905 # if defined(USE_ENVIRON_ARRAY)
6908 # endif /* USE_ENVIRON_ARRAY */
6919 Using various gambits, try to get an IO from an SV: the IO slot if its a
6920 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6921 named after the PV if we're a string.
6927 Perl_sv_2io(pTHX_ SV *sv)
6932 switch (SvTYPE(sv)) {
6940 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6944 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6946 return sv_2io(SvRV(sv));
6947 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6953 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6962 Using various gambits, try to get a CV from an SV; in addition, try if
6963 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6969 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6976 return *gvp = Nullgv, Nullcv;
6977 switch (SvTYPE(sv)) {
6995 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6996 tryAMAGICunDEREF(to_cv);
6999 if (SvTYPE(sv) == SVt_PVCV) {
7008 Perl_croak(aTHX_ "Not a subroutine reference");
7013 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7019 if (lref && !GvCVu(gv)) {
7022 tmpsv = NEWSV(704,0);
7023 gv_efullname3(tmpsv, gv, Nullch);
7024 /* XXX this is probably not what they think they're getting.
7025 * It has the same effect as "sub name;", i.e. just a forward
7027 newSUB(start_subparse(FALSE, 0),
7028 newSVOP(OP_CONST, 0, tmpsv),
7033 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7043 Returns true if the SV has a true value by Perl's rules.
7044 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7045 instead use an in-line version.
7051 Perl_sv_true(pTHX_ register SV *sv)
7056 register const XPV* const tXpv = (XPV*)SvANY(sv);
7058 (tXpv->xpv_cur > 1 ||
7059 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7066 return SvIVX(sv) != 0;
7069 return SvNVX(sv) != 0.0;
7071 return sv_2bool(sv);
7077 =for apidoc sv_pvn_force
7079 Get a sensible string out of the SV somehow.
7080 A private implementation of the C<SvPV_force> macro for compilers which
7081 can't cope with complex macro expressions. Always use the macro instead.
7083 =for apidoc sv_pvn_force_flags
7085 Get a sensible string out of the SV somehow.
7086 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7087 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7088 implemented in terms of this function.
7089 You normally want to use the various wrapper macros instead: see
7090 C<SvPV_force> and C<SvPV_force_nomg>
7096 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7099 if (SvTHINKFIRST(sv) && !SvROK(sv))
7100 sv_force_normal_flags(sv, 0);
7110 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7111 const char * const ref = sv_reftype(sv,0);
7113 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7114 ref, OP_NAME(PL_op));
7116 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7118 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7119 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7121 s = sv_2pv_flags(sv, &len, flags);
7125 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7128 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7129 SvGROW(sv, len + 1);
7130 Move(s,SvPVX(sv),len,char);
7135 SvPOK_on(sv); /* validate pointer */
7137 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7138 PTR2UV(sv),SvPVX_const(sv)));
7141 return SvPVX_mutable(sv);
7145 =for apidoc sv_pvbyten_force
7147 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7153 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7155 sv_pvn_force(sv,lp);
7156 sv_utf8_downgrade(sv,0);
7162 =for apidoc sv_pvutf8n_force
7164 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7170 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7172 sv_pvn_force(sv,lp);
7173 sv_utf8_upgrade(sv);
7179 =for apidoc sv_reftype
7181 Returns a string describing what the SV is a reference to.
7187 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7189 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7190 inside return suggests a const propagation bug in g++. */
7191 if (ob && SvOBJECT(sv)) {
7192 char * const name = HvNAME_get(SvSTASH(sv));
7193 return name ? name : (char *) "__ANON__";
7196 switch (SvTYPE(sv)) {
7213 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7214 /* tied lvalues should appear to be
7215 * scalars for backwards compatitbility */
7216 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7217 ? "SCALAR" : "LVALUE");
7218 case SVt_PVAV: return "ARRAY";
7219 case SVt_PVHV: return "HASH";
7220 case SVt_PVCV: return "CODE";
7221 case SVt_PVGV: return "GLOB";
7222 case SVt_PVFM: return "FORMAT";
7223 case SVt_PVIO: return "IO";
7224 default: return "UNKNOWN";
7230 =for apidoc sv_isobject
7232 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7233 object. If the SV is not an RV, or if the object is not blessed, then this
7240 Perl_sv_isobject(pTHX_ SV *sv)
7256 Returns a boolean indicating whether the SV is blessed into the specified
7257 class. This does not check for subtypes; use C<sv_derived_from> to verify
7258 an inheritance relationship.
7264 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7275 hvname = HvNAME_get(SvSTASH(sv));
7279 return strEQ(hvname, name);
7285 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7286 it will be upgraded to one. If C<classname> is non-null then the new SV will
7287 be blessed in the specified package. The new SV is returned and its
7288 reference count is 1.
7294 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7300 SV_CHECK_THINKFIRST_COW_DROP(rv);
7303 if (SvTYPE(rv) >= SVt_PVMG) {
7304 const U32 refcnt = SvREFCNT(rv);
7308 SvREFCNT(rv) = refcnt;
7311 if (SvTYPE(rv) < SVt_RV)
7312 sv_upgrade(rv, SVt_RV);
7313 else if (SvTYPE(rv) > SVt_RV) {
7324 HV* const stash = gv_stashpv(classname, TRUE);
7325 (void)sv_bless(rv, stash);
7331 =for apidoc sv_setref_pv
7333 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7334 argument will be upgraded to an RV. That RV will be modified to point to
7335 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7336 into the SV. The C<classname> argument indicates the package for the
7337 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7338 will have a reference count of 1, and the RV will be returned.
7340 Do not use with other Perl types such as HV, AV, SV, CV, because those
7341 objects will become corrupted by the pointer copy process.
7343 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7349 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7352 sv_setsv(rv, &PL_sv_undef);
7356 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7361 =for apidoc sv_setref_iv
7363 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7364 argument will be upgraded to an RV. That RV will be modified to point to
7365 the new SV. The C<classname> argument indicates the package for the
7366 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7367 will have a reference count of 1, and the RV will be returned.
7373 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7375 sv_setiv(newSVrv(rv,classname), iv);
7380 =for apidoc sv_setref_uv
7382 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7383 argument will be upgraded to an RV. That RV will be modified to point to
7384 the new SV. The C<classname> argument indicates the package for the
7385 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7386 will have a reference count of 1, and the RV will be returned.
7392 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7394 sv_setuv(newSVrv(rv,classname), uv);
7399 =for apidoc sv_setref_nv
7401 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7402 argument will be upgraded to an RV. That RV will be modified to point to
7403 the new SV. The C<classname> argument indicates the package for the
7404 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7405 will have a reference count of 1, and the RV will be returned.
7411 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7413 sv_setnv(newSVrv(rv,classname), nv);
7418 =for apidoc sv_setref_pvn
7420 Copies a string into a new SV, optionally blessing the SV. The length of the
7421 string must be specified with C<n>. The C<rv> argument will be upgraded to
7422 an RV. That RV will be modified to point to the new SV. The C<classname>
7423 argument indicates the package for the blessing. Set C<classname> to
7424 C<Nullch> to avoid the blessing. The new SV will have a reference count
7425 of 1, and the RV will be returned.
7427 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7433 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7435 sv_setpvn(newSVrv(rv,classname), pv, n);
7440 =for apidoc sv_bless
7442 Blesses an SV into a specified package. The SV must be an RV. The package
7443 must be designated by its stash (see C<gv_stashpv()>). The reference count
7444 of the SV is unaffected.
7450 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7454 Perl_croak(aTHX_ "Can't bless non-reference value");
7456 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7457 if (SvREADONLY(tmpRef))
7458 Perl_croak(aTHX_ PL_no_modify);
7459 if (SvOBJECT(tmpRef)) {
7460 if (SvTYPE(tmpRef) != SVt_PVIO)
7462 SvREFCNT_dec(SvSTASH(tmpRef));
7465 SvOBJECT_on(tmpRef);
7466 if (SvTYPE(tmpRef) != SVt_PVIO)
7468 SvUPGRADE(tmpRef, SVt_PVMG);
7469 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7476 if(SvSMAGICAL(tmpRef))
7477 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7485 /* Downgrades a PVGV to a PVMG.
7489 S_sv_unglob(pTHX_ SV *sv)
7493 assert(SvTYPE(sv) == SVt_PVGV);
7498 sv_del_backref((SV*)GvSTASH(sv), sv);
7499 GvSTASH(sv) = Nullhv;
7501 sv_unmagic(sv, PERL_MAGIC_glob);
7502 Safefree(GvNAME(sv));
7505 /* need to keep SvANY(sv) in the right arena */
7506 xpvmg = new_XPVMG();
7507 StructCopy(SvANY(sv), xpvmg, XPVMG);
7508 del_XPVGV(SvANY(sv));
7511 SvFLAGS(sv) &= ~SVTYPEMASK;
7512 SvFLAGS(sv) |= SVt_PVMG;
7516 =for apidoc sv_unref_flags
7518 Unsets the RV status of the SV, and decrements the reference count of
7519 whatever was being referenced by the RV. This can almost be thought of
7520 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7521 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7522 (otherwise the decrementing is conditional on the reference count being
7523 different from one or the reference being a readonly SV).
7530 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7532 SV* const target = SvRV(ref);
7534 if (SvWEAKREF(ref)) {
7535 sv_del_backref(target, ref);
7537 SvRV_set(ref, NULL);
7540 SvRV_set(ref, NULL);
7542 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7543 assigned to as BEGIN {$a = \"Foo"} will fail. */
7544 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7545 SvREFCNT_dec(target);
7546 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7547 sv_2mortal(target); /* Schedule for freeing later */
7551 =for apidoc sv_untaint
7553 Untaint an SV. Use C<SvTAINTED_off> instead.
7558 Perl_sv_untaint(pTHX_ SV *sv)
7560 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7561 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7568 =for apidoc sv_tainted
7570 Test an SV for taintedness. Use C<SvTAINTED> instead.
7575 Perl_sv_tainted(pTHX_ SV *sv)
7577 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7578 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7579 if (mg && (mg->mg_len & 1) )
7586 =for apidoc sv_setpviv
7588 Copies an integer into the given SV, also updating its string value.
7589 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7595 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7597 char buf[TYPE_CHARS(UV)];
7599 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7601 sv_setpvn(sv, ptr, ebuf - ptr);
7605 =for apidoc sv_setpviv_mg
7607 Like C<sv_setpviv>, but also handles 'set' magic.
7613 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7619 #if defined(PERL_IMPLICIT_CONTEXT)
7621 /* pTHX_ magic can't cope with varargs, so this is a no-context
7622 * version of the main function, (which may itself be aliased to us).
7623 * Don't access this version directly.
7627 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7631 va_start(args, pat);
7632 sv_vsetpvf(sv, pat, &args);
7636 /* pTHX_ magic can't cope with varargs, so this is a no-context
7637 * version of the main function, (which may itself be aliased to us).
7638 * Don't access this version directly.
7642 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7646 va_start(args, pat);
7647 sv_vsetpvf_mg(sv, pat, &args);
7653 =for apidoc sv_setpvf
7655 Works like C<sv_catpvf> but copies the text into the SV instead of
7656 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7662 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7665 va_start(args, pat);
7666 sv_vsetpvf(sv, pat, &args);
7671 =for apidoc sv_vsetpvf
7673 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7674 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7676 Usually used via its frontend C<sv_setpvf>.
7682 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7684 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7688 =for apidoc sv_setpvf_mg
7690 Like C<sv_setpvf>, but also handles 'set' magic.
7696 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7699 va_start(args, pat);
7700 sv_vsetpvf_mg(sv, pat, &args);
7705 =for apidoc sv_vsetpvf_mg
7707 Like C<sv_vsetpvf>, but also handles 'set' magic.
7709 Usually used via its frontend C<sv_setpvf_mg>.
7715 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7717 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7721 #if defined(PERL_IMPLICIT_CONTEXT)
7723 /* pTHX_ magic can't cope with varargs, so this is a no-context
7724 * version of the main function, (which may itself be aliased to us).
7725 * Don't access this version directly.
7729 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7733 va_start(args, pat);
7734 sv_vcatpvf(sv, pat, &args);
7738 /* pTHX_ magic can't cope with varargs, so this is a no-context
7739 * version of the main function, (which may itself be aliased to us).
7740 * Don't access this version directly.
7744 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7748 va_start(args, pat);
7749 sv_vcatpvf_mg(sv, pat, &args);
7755 =for apidoc sv_catpvf
7757 Processes its arguments like C<sprintf> and appends the formatted
7758 output to an SV. If the appended data contains "wide" characters
7759 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7760 and characters >255 formatted with %c), the original SV might get
7761 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7762 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7763 valid UTF-8; if the original SV was bytes, the pattern should be too.
7768 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7771 va_start(args, pat);
7772 sv_vcatpvf(sv, pat, &args);
7777 =for apidoc sv_vcatpvf
7779 Processes its arguments like C<vsprintf> and appends the formatted output
7780 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7782 Usually used via its frontend C<sv_catpvf>.
7788 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7790 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7794 =for apidoc sv_catpvf_mg
7796 Like C<sv_catpvf>, but also handles 'set' magic.
7802 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7805 va_start(args, pat);
7806 sv_vcatpvf_mg(sv, pat, &args);
7811 =for apidoc sv_vcatpvf_mg
7813 Like C<sv_vcatpvf>, but also handles 'set' magic.
7815 Usually used via its frontend C<sv_catpvf_mg>.
7821 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7823 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7828 =for apidoc sv_vsetpvfn
7830 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7833 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7839 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7841 sv_setpvn(sv, "", 0);
7842 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7845 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7848 S_expect_number(pTHX_ char** pattern)
7851 switch (**pattern) {
7852 case '1': case '2': case '3':
7853 case '4': case '5': case '6':
7854 case '7': case '8': case '9':
7855 while (isDIGIT(**pattern))
7856 var = var * 10 + (*(*pattern)++ - '0');
7860 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7863 F0convert(NV nv, char *endbuf, STRLEN *len)
7865 const int neg = nv < 0;
7874 if (uv & 1 && uv == nv)
7875 uv--; /* Round to even */
7877 const unsigned dig = uv % 10;
7890 =for apidoc sv_vcatpvfn
7892 Processes its arguments like C<vsprintf> and appends the formatted output
7893 to an SV. Uses an array of SVs if the C style variable argument list is
7894 missing (NULL). When running with taint checks enabled, indicates via
7895 C<maybe_tainted> if results are untrustworthy (often due to the use of
7898 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7904 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7905 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7906 vec_utf8 = DO_UTF8(vecsv);
7908 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7911 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7918 static const char nullstr[] = "(null)";
7920 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7921 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7923 /* Times 4: a decimal digit takes more than 3 binary digits.
7924 * NV_DIG: mantissa takes than many decimal digits.
7925 * Plus 32: Playing safe. */
7926 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7927 /* large enough for "%#.#f" --chip */
7928 /* what about long double NVs? --jhi */
7930 PERL_UNUSED_ARG(maybe_tainted);
7932 /* no matter what, this is a string now */
7933 (void)SvPV_force(sv, origlen);
7935 /* special-case "", "%s", and "%-p" (SVf - see below) */
7938 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7940 const char * const s = va_arg(*args, char*);
7941 sv_catpv(sv, s ? s : nullstr);
7943 else if (svix < svmax) {
7944 sv_catsv(sv, *svargs);
7948 if (args && patlen == 3 && pat[0] == '%' &&
7949 pat[1] == '-' && pat[2] == 'p') {
7950 argsv = va_arg(*args, SV*);
7951 sv_catsv(sv, argsv);
7955 #ifndef USE_LONG_DOUBLE
7956 /* special-case "%.<number>[gf]" */
7957 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7958 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7959 unsigned digits = 0;
7963 while (*pp >= '0' && *pp <= '9')
7964 digits = 10 * digits + (*pp++ - '0');
7965 if (pp - pat == (int)patlen - 1) {
7973 /* Add check for digits != 0 because it seems that some
7974 gconverts are buggy in this case, and we don't yet have
7975 a Configure test for this. */
7976 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7977 /* 0, point, slack */
7978 Gconvert(nv, (int)digits, 0, ebuf);
7980 if (*ebuf) /* May return an empty string for digits==0 */
7983 } else if (!digits) {
7986 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7987 sv_catpvn(sv, p, l);
7993 #endif /* !USE_LONG_DOUBLE */
7995 if (!args && svix < svmax && DO_UTF8(*svargs))
7998 patend = (char*)pat + patlen;
7999 for (p = (char*)pat; p < patend; p = q) {
8002 bool vectorize = FALSE;
8003 bool vectorarg = FALSE;
8004 bool vec_utf8 = FALSE;
8010 bool has_precis = FALSE;
8013 bool is_utf8 = FALSE; /* is this item utf8? */
8014 #ifdef HAS_LDBL_SPRINTF_BUG
8015 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8016 with sfio - Allen <allens@cpan.org> */
8017 bool fix_ldbl_sprintf_bug = FALSE;
8021 U8 utf8buf[UTF8_MAXBYTES+1];
8022 STRLEN esignlen = 0;
8024 const char *eptr = Nullch;
8027 const U8 *vecstr = Null(U8*);
8034 /* we need a long double target in case HAS_LONG_DOUBLE but
8037 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8045 const char *dotstr = ".";
8046 STRLEN dotstrlen = 1;
8047 I32 efix = 0; /* explicit format parameter index */
8048 I32 ewix = 0; /* explicit width index */
8049 I32 epix = 0; /* explicit precision index */
8050 I32 evix = 0; /* explicit vector index */
8051 bool asterisk = FALSE;
8053 /* echo everything up to the next format specification */
8054 for (q = p; q < patend && *q != '%'; ++q) ;
8056 if (has_utf8 && !pat_utf8)
8057 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8059 sv_catpvn(sv, p, q - p);
8066 We allow format specification elements in this order:
8067 \d+\$ explicit format parameter index
8069 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8070 0 flag (as above): repeated to allow "v02"
8071 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8072 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8074 [%bcdefginopsuxDFOUX] format (mandatory)
8079 As of perl5.9.3, printf format checking is on by default.
8080 Internally, perl uses %p formats to provide an escape to
8081 some extended formatting. This block deals with those
8082 extensions: if it does not match, (char*)q is reset and
8083 the normal format processing code is used.
8085 Currently defined extensions are:
8086 %p include pointer address (standard)
8087 %-p (SVf) include an SV (previously %_)
8088 %-<num>p include an SV with precision <num>
8089 %1p (VDf) include a v-string (as %vd)
8090 %<num>p reserved for future extensions
8092 Robin Barker 2005-07-14
8099 EXPECT_NUMBER(q, n);
8106 argsv = va_arg(*args, SV*);
8107 eptr = SvPVx_const(argsv, elen);
8113 else if (n == vdNUMBER) { /* VDf */
8120 if (ckWARN_d(WARN_INTERNAL))
8121 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8122 "internal %%<num>p might conflict with future printf extensions");
8128 if (EXPECT_NUMBER(q, width)) {
8169 if (EXPECT_NUMBER(q, ewix))
8178 if ((vectorarg = asterisk)) {
8191 EXPECT_NUMBER(q, width);
8197 vecsv = va_arg(*args, SV*);
8199 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8200 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8201 dotstr = SvPV_const(vecsv, dotstrlen);
8208 else if (efix ? efix <= svmax : svix < svmax) {
8209 vecsv = svargs[efix ? efix-1 : svix++];
8210 vecstr = (U8*)SvPV_const(vecsv,veclen);
8211 vec_utf8 = DO_UTF8(vecsv);
8212 /* if this is a version object, we need to return the
8213 * stringified representation (which the SvPVX_const has
8214 * already done for us), but not vectorize the args
8216 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8218 q++; /* skip past the rest of the %vd format */
8219 eptr = (const char *) vecstr;
8233 i = va_arg(*args, int);
8235 i = (ewix ? ewix <= svmax : svix < svmax) ?
8236 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8238 width = (i < 0) ? -i : i;
8248 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8250 /* XXX: todo, support specified precision parameter */
8254 i = va_arg(*args, int);
8256 i = (ewix ? ewix <= svmax : svix < svmax)
8257 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8258 precis = (i < 0) ? 0 : i;
8263 precis = precis * 10 + (*q++ - '0');
8272 case 'I': /* Ix, I32x, and I64x */
8274 if (q[1] == '6' && q[2] == '4') {
8280 if (q[1] == '3' && q[2] == '2') {
8290 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8301 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8302 if (*(q + 1) == 'l') { /* lld, llf */
8328 const I32 i = efix-1;
8329 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8331 argsv = (svix >= 0 && svix < svmax)
8332 ? svargs[svix++] : &PL_sv_undef;
8341 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8343 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8345 eptr = (char*)utf8buf;
8346 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8357 if (args && !vectorize) {
8358 eptr = va_arg(*args, char*);
8360 #ifdef MACOS_TRADITIONAL
8361 /* On MacOS, %#s format is used for Pascal strings */
8366 elen = strlen(eptr);
8368 eptr = (char *)nullstr;
8369 elen = sizeof nullstr - 1;
8373 eptr = SvPVx_const(argsv, elen);
8374 if (DO_UTF8(argsv)) {
8375 if (has_precis && precis < elen) {
8377 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8380 if (width) { /* fudge width (can't fudge elen) */
8381 width += elen - sv_len_utf8(argsv);
8389 if (has_precis && elen > precis)
8396 if (alt || vectorize)
8398 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8419 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8428 esignbuf[esignlen++] = plus;
8432 case 'h': iv = (short)va_arg(*args, int); break;
8433 case 'l': iv = va_arg(*args, long); break;
8434 case 'V': iv = va_arg(*args, IV); break;
8435 default: iv = va_arg(*args, int); break;
8437 case 'q': iv = va_arg(*args, Quad_t); break;
8442 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8444 case 'h': iv = (short)tiv; break;
8445 case 'l': iv = (long)tiv; break;
8447 default: iv = tiv; break;
8449 case 'q': iv = (Quad_t)tiv; break;
8453 if ( !vectorize ) /* we already set uv above */
8458 esignbuf[esignlen++] = plus;
8462 esignbuf[esignlen++] = '-';
8505 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8516 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8517 case 'l': uv = va_arg(*args, unsigned long); break;
8518 case 'V': uv = va_arg(*args, UV); break;
8519 default: uv = va_arg(*args, unsigned); break;
8521 case 'q': uv = va_arg(*args, Uquad_t); break;
8526 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8528 case 'h': uv = (unsigned short)tuv; break;
8529 case 'l': uv = (unsigned long)tuv; break;
8531 default: uv = tuv; break;
8533 case 'q': uv = (Uquad_t)tuv; break;
8540 char *ptr = ebuf + sizeof ebuf;
8546 p = (char*)((c == 'X')
8547 ? "0123456789ABCDEF" : "0123456789abcdef");
8553 esignbuf[esignlen++] = '0';
8554 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8562 if (alt && *ptr != '0')
8573 esignbuf[esignlen++] = '0';
8574 esignbuf[esignlen++] = 'b';
8577 default: /* it had better be ten or less */
8581 } while (uv /= base);
8584 elen = (ebuf + sizeof ebuf) - ptr;
8588 zeros = precis - elen;
8589 else if (precis == 0 && elen == 1 && *eptr == '0')
8595 /* FLOATING POINT */
8598 c = 'f'; /* maybe %F isn't supported here */
8604 /* This is evil, but floating point is even more evil */
8606 /* for SV-style calling, we can only get NV
8607 for C-style calling, we assume %f is double;
8608 for simplicity we allow any of %Lf, %llf, %qf for long double
8612 #if defined(USE_LONG_DOUBLE)
8616 /* [perl #20339] - we should accept and ignore %lf rather than die */
8620 #if defined(USE_LONG_DOUBLE)
8621 intsize = args ? 0 : 'q';
8625 #if defined(HAS_LONG_DOUBLE)
8634 /* now we need (long double) if intsize == 'q', else (double) */
8635 nv = (args && !vectorize) ?
8636 #if LONG_DOUBLESIZE > DOUBLESIZE
8638 va_arg(*args, long double) :
8639 va_arg(*args, double)
8641 va_arg(*args, double)
8647 if (c != 'e' && c != 'E') {
8649 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8650 will cast our (long double) to (double) */
8651 (void)Perl_frexp(nv, &i);
8652 if (i == PERL_INT_MIN)
8653 Perl_die(aTHX_ "panic: frexp");
8655 need = BIT_DIGITS(i);
8657 need += has_precis ? precis : 6; /* known default */
8662 #ifdef HAS_LDBL_SPRINTF_BUG
8663 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8664 with sfio - Allen <allens@cpan.org> */
8667 # define MY_DBL_MAX DBL_MAX
8668 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8669 # if DOUBLESIZE >= 8
8670 # define MY_DBL_MAX 1.7976931348623157E+308L
8672 # define MY_DBL_MAX 3.40282347E+38L
8676 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8677 # define MY_DBL_MAX_BUG 1L
8679 # define MY_DBL_MAX_BUG MY_DBL_MAX
8683 # define MY_DBL_MIN DBL_MIN
8684 # else /* XXX guessing! -Allen */
8685 # if DOUBLESIZE >= 8
8686 # define MY_DBL_MIN 2.2250738585072014E-308L
8688 # define MY_DBL_MIN 1.17549435E-38L
8692 if ((intsize == 'q') && (c == 'f') &&
8693 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8695 /* it's going to be short enough that
8696 * long double precision is not needed */
8698 if ((nv <= 0L) && (nv >= -0L))
8699 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8701 /* would use Perl_fp_class as a double-check but not
8702 * functional on IRIX - see perl.h comments */
8704 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8705 /* It's within the range that a double can represent */
8706 #if defined(DBL_MAX) && !defined(DBL_MIN)
8707 if ((nv >= ((long double)1/DBL_MAX)) ||
8708 (nv <= (-(long double)1/DBL_MAX)))
8710 fix_ldbl_sprintf_bug = TRUE;
8713 if (fix_ldbl_sprintf_bug == TRUE) {
8723 # undef MY_DBL_MAX_BUG
8726 #endif /* HAS_LDBL_SPRINTF_BUG */
8728 need += 20; /* fudge factor */
8729 if (PL_efloatsize < need) {
8730 Safefree(PL_efloatbuf);
8731 PL_efloatsize = need + 20; /* more fudge */
8732 Newx(PL_efloatbuf, PL_efloatsize, char);
8733 PL_efloatbuf[0] = '\0';
8736 if ( !(width || left || plus || alt) && fill != '0'
8737 && has_precis && intsize != 'q' ) { /* Shortcuts */
8738 /* See earlier comment about buggy Gconvert when digits,
8740 if ( c == 'g' && precis) {
8741 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8742 /* May return an empty string for digits==0 */
8743 if (*PL_efloatbuf) {
8744 elen = strlen(PL_efloatbuf);
8745 goto float_converted;
8747 } else if ( c == 'f' && !precis) {
8748 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8753 char *ptr = ebuf + sizeof ebuf;
8756 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8757 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8758 if (intsize == 'q') {
8759 /* Copy the one or more characters in a long double
8760 * format before the 'base' ([efgEFG]) character to
8761 * the format string. */
8762 static char const prifldbl[] = PERL_PRIfldbl;
8763 char const *p = prifldbl + sizeof(prifldbl) - 3;
8764 while (p >= prifldbl) { *--ptr = *p--; }
8769 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8774 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8786 /* No taint. Otherwise we are in the strange situation
8787 * where printf() taints but print($float) doesn't.
8789 #if defined(HAS_LONG_DOUBLE)
8790 elen = ((intsize == 'q')
8791 ? my_sprintf(PL_efloatbuf, ptr, nv)
8792 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8794 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8798 eptr = PL_efloatbuf;
8804 i = SvCUR(sv) - origlen;
8805 if (args && !vectorize) {
8807 case 'h': *(va_arg(*args, short*)) = i; break;
8808 default: *(va_arg(*args, int*)) = i; break;
8809 case 'l': *(va_arg(*args, long*)) = i; break;
8810 case 'V': *(va_arg(*args, IV*)) = i; break;
8812 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8817 sv_setuv_mg(argsv, (UV)i);
8819 continue; /* not "break" */
8826 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8827 && ckWARN(WARN_PRINTF))
8829 SV * const msg = sv_newmortal();
8830 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8831 (PL_op->op_type == OP_PRTF) ? "" : "s");
8834 Perl_sv_catpvf(aTHX_ msg,
8835 "\"%%%c\"", c & 0xFF);
8837 Perl_sv_catpvf(aTHX_ msg,
8838 "\"%%\\%03"UVof"\"",
8841 sv_catpv(msg, "end of string");
8842 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8845 /* output mangled stuff ... */
8851 /* ... right here, because formatting flags should not apply */
8852 SvGROW(sv, SvCUR(sv) + elen + 1);
8854 Copy(eptr, p, elen, char);
8857 SvCUR_set(sv, p - SvPVX_const(sv));
8859 continue; /* not "break" */
8862 /* calculate width before utf8_upgrade changes it */
8863 have = esignlen + zeros + elen;
8865 Perl_croak_nocontext(PL_memory_wrap);
8867 if (is_utf8 != has_utf8) {
8870 sv_utf8_upgrade(sv);
8873 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8874 sv_utf8_upgrade(nsv);
8875 eptr = SvPVX_const(nsv);
8878 SvGROW(sv, SvCUR(sv) + elen + 1);
8883 need = (have > width ? have : width);
8886 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8887 Perl_croak_nocontext(PL_memory_wrap);
8888 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8890 if (esignlen && fill == '0') {
8892 for (i = 0; i < (int)esignlen; i++)
8896 memset(p, fill, gap);
8899 if (esignlen && fill != '0') {
8901 for (i = 0; i < (int)esignlen; i++)
8906 for (i = zeros; i; i--)
8910 Copy(eptr, p, elen, char);
8914 memset(p, ' ', gap);
8919 Copy(dotstr, p, dotstrlen, char);
8923 vectorize = FALSE; /* done iterating over vecstr */
8930 SvCUR_set(sv, p - SvPVX_const(sv));
8938 /* =========================================================================
8940 =head1 Cloning an interpreter
8942 All the macros and functions in this section are for the private use of
8943 the main function, perl_clone().
8945 The foo_dup() functions make an exact copy of an existing foo thinngy.
8946 During the course of a cloning, a hash table is used to map old addresses
8947 to new addresses. The table is created and manipulated with the
8948 ptr_table_* functions.
8952 ============================================================================*/
8955 #if defined(USE_ITHREADS)
8957 #ifndef GpREFCNT_inc
8958 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8962 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8963 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8964 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8965 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8966 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8967 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8968 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8969 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8970 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8971 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8972 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8973 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8974 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8977 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8978 regcomp.c. AMS 20010712 */
8981 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8986 struct reg_substr_datum *s;
8989 return (REGEXP *)NULL;
8991 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8994 len = r->offsets[0];
8995 npar = r->nparens+1;
8997 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8998 Copy(r->program, ret->program, len+1, regnode);
9000 Newx(ret->startp, npar, I32);
9001 Copy(r->startp, ret->startp, npar, I32);
9002 Newx(ret->endp, npar, I32);
9003 Copy(r->startp, ret->startp, npar, I32);
9005 Newx(ret->substrs, 1, struct reg_substr_data);
9006 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9007 s->min_offset = r->substrs->data[i].min_offset;
9008 s->max_offset = r->substrs->data[i].max_offset;
9009 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9010 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9013 ret->regstclass = NULL;
9016 const int count = r->data->count;
9019 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9020 char, struct reg_data);
9021 Newx(d->what, count, U8);
9024 for (i = 0; i < count; i++) {
9025 d->what[i] = r->data->what[i];
9026 switch (d->what[i]) {
9027 /* legal options are one of: sfpont
9028 see also regcomp.h and pregfree() */
9030 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9033 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9036 /* This is cheating. */
9037 Newx(d->data[i], 1, struct regnode_charclass_class);
9038 StructCopy(r->data->data[i], d->data[i],
9039 struct regnode_charclass_class);
9040 ret->regstclass = (regnode*)d->data[i];
9043 /* Compiled op trees are readonly, and can thus be
9044 shared without duplication. */
9046 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9050 d->data[i] = r->data->data[i];
9053 d->data[i] = r->data->data[i];
9055 ((reg_trie_data*)d->data[i])->refcount++;
9059 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9068 Newx(ret->offsets, 2*len+1, U32);
9069 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9071 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9072 ret->refcnt = r->refcnt;
9073 ret->minlen = r->minlen;
9074 ret->prelen = r->prelen;
9075 ret->nparens = r->nparens;
9076 ret->lastparen = r->lastparen;
9077 ret->lastcloseparen = r->lastcloseparen;
9078 ret->reganch = r->reganch;
9080 ret->sublen = r->sublen;
9082 if (RX_MATCH_COPIED(ret))
9083 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9085 ret->subbeg = Nullch;
9086 #ifdef PERL_OLD_COPY_ON_WRITE
9087 ret->saved_copy = Nullsv;
9090 ptr_table_store(PL_ptr_table, r, ret);
9094 /* duplicate a file handle */
9097 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9101 PERL_UNUSED_ARG(type);
9104 return (PerlIO*)NULL;
9106 /* look for it in the table first */
9107 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9111 /* create anew and remember what it is */
9112 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9113 ptr_table_store(PL_ptr_table, fp, ret);
9117 /* duplicate a directory handle */
9120 Perl_dirp_dup(pTHX_ DIR *dp)
9128 /* duplicate a typeglob */
9131 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9136 /* look for it in the table first */
9137 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9141 /* create anew and remember what it is */
9143 ptr_table_store(PL_ptr_table, gp, ret);
9146 ret->gp_refcnt = 0; /* must be before any other dups! */
9147 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9148 ret->gp_io = io_dup_inc(gp->gp_io, param);
9149 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9150 ret->gp_av = av_dup_inc(gp->gp_av, param);
9151 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9152 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9153 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9154 ret->gp_cvgen = gp->gp_cvgen;
9155 ret->gp_line = gp->gp_line;
9156 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9160 /* duplicate a chain of magic */
9163 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9165 MAGIC *mgprev = (MAGIC*)NULL;
9168 return (MAGIC*)NULL;
9169 /* look for it in the table first */
9170 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9174 for (; mg; mg = mg->mg_moremagic) {
9176 Newxz(nmg, 1, MAGIC);
9178 mgprev->mg_moremagic = nmg;
9181 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9182 nmg->mg_private = mg->mg_private;
9183 nmg->mg_type = mg->mg_type;
9184 nmg->mg_flags = mg->mg_flags;
9185 if (mg->mg_type == PERL_MAGIC_qr) {
9186 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9188 else if(mg->mg_type == PERL_MAGIC_backref) {
9189 const AV * const av = (AV*) mg->mg_obj;
9192 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9194 for (i = AvFILLp(av); i >= 0; i--) {
9195 if (!svp[i]) continue;
9196 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9199 else if (mg->mg_type == PERL_MAGIC_symtab) {
9200 nmg->mg_obj = mg->mg_obj;
9203 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9204 ? sv_dup_inc(mg->mg_obj, param)
9205 : sv_dup(mg->mg_obj, param);
9207 nmg->mg_len = mg->mg_len;
9208 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9209 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9210 if (mg->mg_len > 0) {
9211 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9212 if (mg->mg_type == PERL_MAGIC_overload_table &&
9213 AMT_AMAGIC((AMT*)mg->mg_ptr))
9215 AMT * const amtp = (AMT*)mg->mg_ptr;
9216 AMT * const namtp = (AMT*)nmg->mg_ptr;
9218 for (i = 1; i < NofAMmeth; i++) {
9219 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9223 else if (mg->mg_len == HEf_SVKEY)
9224 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9226 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9227 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9234 /* create a new pointer-mapping table */
9237 Perl_ptr_table_new(pTHX)
9240 Newxz(tbl, 1, PTR_TBL_t);
9243 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9248 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9250 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9254 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9255 following define) and at call to new_body_inline made below in
9256 Perl_ptr_table_store()
9259 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9261 /* map an existing pointer using a table */
9264 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9266 PTR_TBL_ENT_t *tblent;
9267 const UV hash = PTR_TABLE_HASH(sv);
9269 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9270 for (; tblent; tblent = tblent->next) {
9271 if (tblent->oldval == sv)
9272 return tblent->newval;
9277 /* add a new entry to a pointer-mapping table */
9280 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9282 PTR_TBL_ENT_t *tblent, **otblent;
9283 /* XXX this may be pessimal on platforms where pointers aren't good
9284 * hash values e.g. if they grow faster in the most significant
9286 const UV hash = PTR_TABLE_HASH(oldsv);
9290 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9291 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9292 if (tblent->oldval == oldsv) {
9293 tblent->newval = newsv;
9297 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9298 tblent->oldval = oldsv;
9299 tblent->newval = newsv;
9300 tblent->next = *otblent;
9303 if (!empty && tbl->tbl_items > tbl->tbl_max)
9304 ptr_table_split(tbl);
9307 /* double the hash bucket size of an existing ptr table */
9310 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9312 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9313 const UV oldsize = tbl->tbl_max + 1;
9314 UV newsize = oldsize * 2;
9317 Renew(ary, newsize, PTR_TBL_ENT_t*);
9318 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9319 tbl->tbl_max = --newsize;
9321 for (i=0; i < oldsize; i++, ary++) {
9322 PTR_TBL_ENT_t **curentp, **entp, *ent;
9325 curentp = ary + oldsize;
9326 for (entp = ary, ent = *ary; ent; ent = *entp) {
9327 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9329 ent->next = *curentp;
9339 /* remove all the entries from a ptr table */
9342 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9344 register PTR_TBL_ENT_t **array;
9345 register PTR_TBL_ENT_t *entry;
9349 if (!tbl || !tbl->tbl_items) {
9353 array = tbl->tbl_ary;
9359 PTR_TBL_ENT_t *oentry = entry;
9360 entry = entry->next;
9364 if (++riter > max) {
9367 entry = array[riter];
9374 /* clear and free a ptr table */
9377 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9382 ptr_table_clear(tbl);
9383 Safefree(tbl->tbl_ary);
9389 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9392 SvRV_set(dstr, SvWEAKREF(sstr)
9393 ? sv_dup(SvRV(sstr), param)
9394 : sv_dup_inc(SvRV(sstr), param));
9397 else if (SvPVX_const(sstr)) {
9398 /* Has something there */
9400 /* Normal PV - clone whole allocated space */
9401 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9402 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9403 /* Not that normal - actually sstr is copy on write.
9404 But we are a true, independant SV, so: */
9405 SvREADONLY_off(dstr);
9410 /* Special case - not normally malloced for some reason */
9411 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9412 /* A "shared" PV - clone it as "shared" PV */
9414 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9418 /* Some other special case - random pointer */
9419 SvPV_set(dstr, SvPVX(sstr));
9425 if (SvTYPE(dstr) == SVt_RV)
9426 SvRV_set(dstr, NULL);
9432 /* duplicate an SV of any type (including AV, HV etc) */
9435 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9440 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9442 /* look for it in the table first */
9443 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9447 if(param->flags & CLONEf_JOIN_IN) {
9448 /** We are joining here so we don't want do clone
9449 something that is bad **/
9452 if(SvTYPE(sstr) == SVt_PVHV &&
9453 (hvname = HvNAME_get(sstr))) {
9454 /** don't clone stashes if they already exist **/
9455 return (SV*)gv_stashpv(hvname,0);
9459 /* create anew and remember what it is */
9462 #ifdef DEBUG_LEAKING_SCALARS
9463 dstr->sv_debug_optype = sstr->sv_debug_optype;
9464 dstr->sv_debug_line = sstr->sv_debug_line;
9465 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9466 dstr->sv_debug_cloned = 1;
9468 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9470 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9474 ptr_table_store(PL_ptr_table, sstr, dstr);
9477 SvFLAGS(dstr) = SvFLAGS(sstr);
9478 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9479 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9482 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9483 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9484 PL_watch_pvx, SvPVX_const(sstr));
9487 /* don't clone objects whose class has asked us not to */
9488 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9489 SvFLAGS(dstr) &= ~SVTYPEMASK;
9494 switch (SvTYPE(sstr)) {
9499 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9500 SvIV_set(dstr, SvIVX(sstr));
9503 SvANY(dstr) = new_XNV();
9504 SvNV_set(dstr, SvNVX(sstr));
9507 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9508 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9512 /* These are all the types that need complex bodies allocating. */
9514 const svtype sv_type = SvTYPE(sstr);
9515 const struct body_details *const sv_type_details
9516 = bodies_by_type + sv_type;
9520 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9525 if (GvUNIQUE((GV*)sstr)) {
9526 /* Do sharing here, and fall through */
9539 assert(sv_type_details->copy);
9540 if (sv_type_details->arena) {
9541 new_body_inline(new_body, sv_type_details->copy, sv_type);
9543 = (void*)((char*)new_body - sv_type_details->offset);
9545 new_body = new_NOARENA(sv_type_details);
9549 SvANY(dstr) = new_body;
9552 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9553 ((char*)SvANY(dstr)) + sv_type_details->offset,
9554 sv_type_details->copy, char);
9556 Copy(((char*)SvANY(sstr)),
9557 ((char*)SvANY(dstr)),
9558 sv_type_details->size + sv_type_details->offset, char);
9561 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9562 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9564 /* The Copy above means that all the source (unduplicated) pointers
9565 are now in the destination. We can check the flags and the
9566 pointers in either, but it's possible that there's less cache
9567 missing by always going for the destination.
9568 FIXME - instrument and check that assumption */
9569 if (sv_type >= SVt_PVMG) {
9571 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9573 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9576 /* The cast silences a GCC warning about unhandled types. */
9577 switch ((int)sv_type) {
9589 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9590 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9591 LvTARG(dstr) = dstr;
9592 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9593 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9595 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9598 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9599 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9600 /* Don't call sv_add_backref here as it's going to be created
9601 as part of the magic cloning of the symbol table. */
9602 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9603 (void)GpREFCNT_inc(GvGP(dstr));
9606 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9607 if (IoOFP(dstr) == IoIFP(sstr))
9608 IoOFP(dstr) = IoIFP(dstr);
9610 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9611 /* PL_rsfp_filters entries have fake IoDIRP() */
9612 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9613 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9614 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9615 /* I have no idea why fake dirp (rsfps)
9616 should be treated differently but otherwise
9617 we end up with leaks -- sky*/
9618 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9619 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9620 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9622 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9623 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9624 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9626 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9627 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9628 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9631 if (AvARRAY((AV*)sstr)) {
9632 SV **dst_ary, **src_ary;
9633 SSize_t items = AvFILLp((AV*)sstr) + 1;
9635 src_ary = AvARRAY((AV*)sstr);
9636 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9637 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9638 SvPV_set(dstr, (char*)dst_ary);
9639 AvALLOC((AV*)dstr) = dst_ary;
9640 if (AvREAL((AV*)sstr)) {
9642 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9646 *dst_ary++ = sv_dup(*src_ary++, param);
9648 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9649 while (items-- > 0) {
9650 *dst_ary++ = &PL_sv_undef;
9654 SvPV_set(dstr, Nullch);
9655 AvALLOC((AV*)dstr) = (SV**)NULL;
9662 if (HvARRAY((HV*)sstr)) {
9664 const bool sharekeys = !!HvSHAREKEYS(sstr);
9665 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9666 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9668 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9669 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9671 HvARRAY(dstr) = (HE**)darray;
9672 while (i <= sxhv->xhv_max) {
9673 const HE *source = HvARRAY(sstr)[i];
9674 HvARRAY(dstr)[i] = source
9675 ? he_dup(source, sharekeys, param) : 0;
9679 struct xpvhv_aux *saux = HvAUX(sstr);
9680 struct xpvhv_aux *daux = HvAUX(dstr);
9681 /* This flag isn't copied. */
9682 /* SvOOK_on(hv) attacks the IV flags. */
9683 SvFLAGS(dstr) |= SVf_OOK;
9685 hvname = saux->xhv_name;
9687 = hvname ? hek_dup(hvname, param) : hvname;
9689 daux->xhv_riter = saux->xhv_riter;
9690 daux->xhv_eiter = saux->xhv_eiter
9691 ? he_dup(saux->xhv_eiter,
9692 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9696 SvPV_set(dstr, Nullch);
9698 /* Record stashes for possible cloning in Perl_clone(). */
9700 av_push(param->stashes, dstr);
9705 /* NOTE: not refcounted */
9706 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9708 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9710 if (CvCONST(dstr)) {
9711 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9712 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9713 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9715 /* don't dup if copying back - CvGV isn't refcounted, so the
9716 * duped GV may never be freed. A bit of a hack! DAPM */
9717 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9718 Nullgv : gv_dup(CvGV(dstr), param) ;
9719 if (!(param->flags & CLONEf_COPY_STACKS)) {
9722 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9725 ? cv_dup( CvOUTSIDE(dstr), param)
9726 : cv_dup_inc(CvOUTSIDE(dstr), param);
9728 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9734 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9740 /* duplicate a context */
9743 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9748 return (PERL_CONTEXT*)NULL;
9750 /* look for it in the table first */
9751 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9755 /* create anew and remember what it is */
9756 Newxz(ncxs, max + 1, PERL_CONTEXT);
9757 ptr_table_store(PL_ptr_table, cxs, ncxs);
9760 PERL_CONTEXT *cx = &cxs[ix];
9761 PERL_CONTEXT *ncx = &ncxs[ix];
9762 ncx->cx_type = cx->cx_type;
9763 if (CxTYPE(cx) == CXt_SUBST) {
9764 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9767 ncx->blk_oldsp = cx->blk_oldsp;
9768 ncx->blk_oldcop = cx->blk_oldcop;
9769 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9770 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9771 ncx->blk_oldpm = cx->blk_oldpm;
9772 ncx->blk_gimme = cx->blk_gimme;
9773 switch (CxTYPE(cx)) {
9775 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9776 ? cv_dup_inc(cx->blk_sub.cv, param)
9777 : cv_dup(cx->blk_sub.cv,param));
9778 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9779 ? av_dup_inc(cx->blk_sub.argarray, param)
9781 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9782 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9783 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9784 ncx->blk_sub.lval = cx->blk_sub.lval;
9785 ncx->blk_sub.retop = cx->blk_sub.retop;
9788 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9789 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9790 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9791 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9792 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9793 ncx->blk_eval.retop = cx->blk_eval.retop;
9796 ncx->blk_loop.label = cx->blk_loop.label;
9797 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9798 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9799 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9800 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9801 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9802 ? cx->blk_loop.iterdata
9803 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9804 ncx->blk_loop.oldcomppad
9805 = (PAD*)ptr_table_fetch(PL_ptr_table,
9806 cx->blk_loop.oldcomppad);
9807 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9808 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9809 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9810 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9811 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9814 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9815 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9816 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9817 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9818 ncx->blk_sub.retop = cx->blk_sub.retop;
9830 /* duplicate a stack info structure */
9833 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9838 return (PERL_SI*)NULL;
9840 /* look for it in the table first */
9841 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9845 /* create anew and remember what it is */
9846 Newxz(nsi, 1, PERL_SI);
9847 ptr_table_store(PL_ptr_table, si, nsi);
9849 nsi->si_stack = av_dup_inc(si->si_stack, param);
9850 nsi->si_cxix = si->si_cxix;
9851 nsi->si_cxmax = si->si_cxmax;
9852 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9853 nsi->si_type = si->si_type;
9854 nsi->si_prev = si_dup(si->si_prev, param);
9855 nsi->si_next = si_dup(si->si_next, param);
9856 nsi->si_markoff = si->si_markoff;
9861 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9862 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9863 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9864 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9865 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9866 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9867 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9868 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9869 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9870 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9871 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9872 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9873 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9874 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9877 #define pv_dup_inc(p) SAVEPV(p)
9878 #define pv_dup(p) SAVEPV(p)
9879 #define svp_dup_inc(p,pp) any_dup(p,pp)
9881 /* map any object to the new equivent - either something in the
9882 * ptr table, or something in the interpreter structure
9886 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9893 /* look for it in the table first */
9894 ret = ptr_table_fetch(PL_ptr_table, v);
9898 /* see if it is part of the interpreter structure */
9899 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9900 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9908 /* duplicate the save stack */
9911 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9913 ANY * const ss = proto_perl->Tsavestack;
9914 const I32 max = proto_perl->Tsavestack_max;
9915 I32 ix = proto_perl->Tsavestack_ix;
9927 void (*dptr) (void*);
9928 void (*dxptr) (pTHX_ void*);
9930 Newxz(nss, max, ANY);
9933 I32 i = POPINT(ss,ix);
9936 case SAVEt_ITEM: /* normal string */
9937 sv = (SV*)POPPTR(ss,ix);
9938 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9939 sv = (SV*)POPPTR(ss,ix);
9940 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9942 case SAVEt_SV: /* scalar reference */
9943 sv = (SV*)POPPTR(ss,ix);
9944 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9945 gv = (GV*)POPPTR(ss,ix);
9946 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9948 case SAVEt_GENERIC_PVREF: /* generic char* */
9949 c = (char*)POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = pv_dup(c);
9951 ptr = POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9954 case SAVEt_SHARED_PVREF: /* char* in shared space */
9955 c = (char*)POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = savesharedpv(c);
9957 ptr = POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9960 case SAVEt_GENERIC_SVREF: /* generic sv */
9961 case SAVEt_SVREF: /* scalar reference */
9962 sv = (SV*)POPPTR(ss,ix);
9963 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9964 ptr = POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9967 case SAVEt_AV: /* array reference */
9968 av = (AV*)POPPTR(ss,ix);
9969 TOPPTR(nss,ix) = av_dup_inc(av, param);
9970 gv = (GV*)POPPTR(ss,ix);
9971 TOPPTR(nss,ix) = gv_dup(gv, param);
9973 case SAVEt_HV: /* hash reference */
9974 hv = (HV*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9976 gv = (GV*)POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = gv_dup(gv, param);
9979 case SAVEt_INT: /* int reference */
9980 ptr = POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9982 intval = (int)POPINT(ss,ix);
9983 TOPINT(nss,ix) = intval;
9985 case SAVEt_LONG: /* long reference */
9986 ptr = POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9988 longval = (long)POPLONG(ss,ix);
9989 TOPLONG(nss,ix) = longval;
9991 case SAVEt_I32: /* I32 reference */
9992 case SAVEt_I16: /* I16 reference */
9993 case SAVEt_I8: /* I8 reference */
9994 ptr = POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9999 case SAVEt_IV: /* IV reference */
10000 ptr = POPPTR(ss,ix);
10001 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10003 TOPIV(nss,ix) = iv;
10005 case SAVEt_SPTR: /* SV* reference */
10006 ptr = POPPTR(ss,ix);
10007 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10008 sv = (SV*)POPPTR(ss,ix);
10009 TOPPTR(nss,ix) = sv_dup(sv, param);
10011 case SAVEt_VPTR: /* random* reference */
10012 ptr = POPPTR(ss,ix);
10013 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10014 ptr = POPPTR(ss,ix);
10015 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10017 case SAVEt_PPTR: /* char* reference */
10018 ptr = POPPTR(ss,ix);
10019 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10020 c = (char*)POPPTR(ss,ix);
10021 TOPPTR(nss,ix) = pv_dup(c);
10023 case SAVEt_HPTR: /* HV* reference */
10024 ptr = POPPTR(ss,ix);
10025 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10026 hv = (HV*)POPPTR(ss,ix);
10027 TOPPTR(nss,ix) = hv_dup(hv, param);
10029 case SAVEt_APTR: /* AV* reference */
10030 ptr = POPPTR(ss,ix);
10031 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10032 av = (AV*)POPPTR(ss,ix);
10033 TOPPTR(nss,ix) = av_dup(av, param);
10036 gv = (GV*)POPPTR(ss,ix);
10037 TOPPTR(nss,ix) = gv_dup(gv, param);
10039 case SAVEt_GP: /* scalar reference */
10040 gp = (GP*)POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10042 (void)GpREFCNT_inc(gp);
10043 gv = (GV*)POPPTR(ss,ix);
10044 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10045 c = (char*)POPPTR(ss,ix);
10046 TOPPTR(nss,ix) = pv_dup(c);
10048 TOPIV(nss,ix) = iv;
10050 TOPIV(nss,ix) = iv;
10053 case SAVEt_MORTALIZESV:
10054 sv = (SV*)POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10058 ptr = POPPTR(ss,ix);
10059 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10060 /* these are assumed to be refcounted properly */
10062 switch (((OP*)ptr)->op_type) {
10064 case OP_LEAVESUBLV:
10068 case OP_LEAVEWRITE:
10069 TOPPTR(nss,ix) = ptr;
10074 TOPPTR(nss,ix) = Nullop;
10079 TOPPTR(nss,ix) = Nullop;
10082 c = (char*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = pv_dup_inc(c);
10085 case SAVEt_CLEARSV:
10086 longval = POPLONG(ss,ix);
10087 TOPLONG(nss,ix) = longval;
10090 hv = (HV*)POPPTR(ss,ix);
10091 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10092 c = (char*)POPPTR(ss,ix);
10093 TOPPTR(nss,ix) = pv_dup_inc(c);
10095 TOPINT(nss,ix) = i;
10097 case SAVEt_DESTRUCTOR:
10098 ptr = POPPTR(ss,ix);
10099 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10100 dptr = POPDPTR(ss,ix);
10101 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10102 any_dup(FPTR2DPTR(void *, dptr),
10105 case SAVEt_DESTRUCTOR_X:
10106 ptr = POPPTR(ss,ix);
10107 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10108 dxptr = POPDXPTR(ss,ix);
10109 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10110 any_dup(FPTR2DPTR(void *, dxptr),
10113 case SAVEt_REGCONTEXT:
10116 TOPINT(nss,ix) = i;
10119 case SAVEt_STACK_POS: /* Position on Perl stack */
10121 TOPINT(nss,ix) = i;
10123 case SAVEt_AELEM: /* array element */
10124 sv = (SV*)POPPTR(ss,ix);
10125 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10127 TOPINT(nss,ix) = i;
10128 av = (AV*)POPPTR(ss,ix);
10129 TOPPTR(nss,ix) = av_dup_inc(av, param);
10131 case SAVEt_HELEM: /* hash element */
10132 sv = (SV*)POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10134 sv = (SV*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10136 hv = (HV*)POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10140 ptr = POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = ptr;
10145 TOPINT(nss,ix) = i;
10147 case SAVEt_COMPPAD:
10148 av = (AV*)POPPTR(ss,ix);
10149 TOPPTR(nss,ix) = av_dup(av, param);
10152 longval = (long)POPLONG(ss,ix);
10153 TOPLONG(nss,ix) = longval;
10154 ptr = POPPTR(ss,ix);
10155 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10156 sv = (SV*)POPPTR(ss,ix);
10157 TOPPTR(nss,ix) = sv_dup(sv, param);
10160 ptr = POPPTR(ss,ix);
10161 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10162 longval = (long)POPBOOL(ss,ix);
10163 TOPBOOL(nss,ix) = (bool)longval;
10165 case SAVEt_SET_SVFLAGS:
10167 TOPINT(nss,ix) = i;
10169 TOPINT(nss,ix) = i;
10170 sv = (SV*)POPPTR(ss,ix);
10171 TOPPTR(nss,ix) = sv_dup(sv, param);
10174 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10182 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10183 * flag to the result. This is done for each stash before cloning starts,
10184 * so we know which stashes want their objects cloned */
10187 do_mark_cloneable_stash(pTHX_ SV *sv)
10189 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10191 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10192 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10193 if (cloner && GvCV(cloner)) {
10200 XPUSHs(sv_2mortal(newSVhek(hvname)));
10202 call_sv((SV*)GvCV(cloner), G_SCALAR);
10209 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10217 =for apidoc perl_clone
10219 Create and return a new interpreter by cloning the current one.
10221 perl_clone takes these flags as parameters:
10223 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10224 without it we only clone the data and zero the stacks,
10225 with it we copy the stacks and the new perl interpreter is
10226 ready to run at the exact same point as the previous one.
10227 The pseudo-fork code uses COPY_STACKS while the
10228 threads->new doesn't.
10230 CLONEf_KEEP_PTR_TABLE
10231 perl_clone keeps a ptr_table with the pointer of the old
10232 variable as a key and the new variable as a value,
10233 this allows it to check if something has been cloned and not
10234 clone it again but rather just use the value and increase the
10235 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10236 the ptr_table using the function
10237 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10238 reason to keep it around is if you want to dup some of your own
10239 variable who are outside the graph perl scans, example of this
10240 code is in threads.xs create
10243 This is a win32 thing, it is ignored on unix, it tells perls
10244 win32host code (which is c++) to clone itself, this is needed on
10245 win32 if you want to run two threads at the same time,
10246 if you just want to do some stuff in a separate perl interpreter
10247 and then throw it away and return to the original one,
10248 you don't need to do anything.
10253 /* XXX the above needs expanding by someone who actually understands it ! */
10254 EXTERN_C PerlInterpreter *
10255 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10258 perl_clone(PerlInterpreter *proto_perl, UV flags)
10261 #ifdef PERL_IMPLICIT_SYS
10263 /* perlhost.h so we need to call into it
10264 to clone the host, CPerlHost should have a c interface, sky */
10266 if (flags & CLONEf_CLONE_HOST) {
10267 return perl_clone_host(proto_perl,flags);
10269 return perl_clone_using(proto_perl, flags,
10271 proto_perl->IMemShared,
10272 proto_perl->IMemParse,
10274 proto_perl->IStdIO,
10278 proto_perl->IProc);
10282 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10283 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10284 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10285 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10286 struct IPerlDir* ipD, struct IPerlSock* ipS,
10287 struct IPerlProc* ipP)
10289 /* XXX many of the string copies here can be optimized if they're
10290 * constants; they need to be allocated as common memory and just
10291 * their pointers copied. */
10294 CLONE_PARAMS clone_params;
10295 CLONE_PARAMS* param = &clone_params;
10297 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10298 /* for each stash, determine whether its objects should be cloned */
10299 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10300 PERL_SET_THX(my_perl);
10303 Poison(my_perl, 1, PerlInterpreter);
10305 PL_curcop = (COP *)Nullop;
10309 PL_savestack_ix = 0;
10310 PL_savestack_max = -1;
10311 PL_sig_pending = 0;
10312 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10313 # else /* !DEBUGGING */
10314 Zero(my_perl, 1, PerlInterpreter);
10315 # endif /* DEBUGGING */
10317 /* host pointers */
10319 PL_MemShared = ipMS;
10320 PL_MemParse = ipMP;
10327 #else /* !PERL_IMPLICIT_SYS */
10329 CLONE_PARAMS clone_params;
10330 CLONE_PARAMS* param = &clone_params;
10331 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10332 /* for each stash, determine whether its objects should be cloned */
10333 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10334 PERL_SET_THX(my_perl);
10337 Poison(my_perl, 1, PerlInterpreter);
10339 PL_curcop = (COP *)Nullop;
10343 PL_savestack_ix = 0;
10344 PL_savestack_max = -1;
10345 PL_sig_pending = 0;
10346 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10347 # else /* !DEBUGGING */
10348 Zero(my_perl, 1, PerlInterpreter);
10349 # endif /* DEBUGGING */
10350 #endif /* PERL_IMPLICIT_SYS */
10351 param->flags = flags;
10352 param->proto_perl = proto_perl;
10354 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10355 Zero(&PL_body_roots, 1, PL_body_roots);
10357 PL_nice_chunk = NULL;
10358 PL_nice_chunk_size = 0;
10360 PL_sv_objcount = 0;
10361 PL_sv_root = Nullsv;
10362 PL_sv_arenaroot = Nullsv;
10364 PL_debug = proto_perl->Idebug;
10366 PL_hash_seed = proto_perl->Ihash_seed;
10367 PL_rehash_seed = proto_perl->Irehash_seed;
10369 #ifdef USE_REENTRANT_API
10370 /* XXX: things like -Dm will segfault here in perlio, but doing
10371 * PERL_SET_CONTEXT(proto_perl);
10372 * breaks too many other things
10374 Perl_reentrant_init(aTHX);
10377 /* create SV map for pointer relocation */
10378 PL_ptr_table = ptr_table_new();
10380 /* initialize these special pointers as early as possible */
10381 SvANY(&PL_sv_undef) = NULL;
10382 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10383 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10384 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10386 SvANY(&PL_sv_no) = new_XPVNV();
10387 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10388 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10389 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10390 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10391 SvCUR_set(&PL_sv_no, 0);
10392 SvLEN_set(&PL_sv_no, 1);
10393 SvIV_set(&PL_sv_no, 0);
10394 SvNV_set(&PL_sv_no, 0);
10395 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10397 SvANY(&PL_sv_yes) = new_XPVNV();
10398 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10399 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10400 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10401 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10402 SvCUR_set(&PL_sv_yes, 1);
10403 SvLEN_set(&PL_sv_yes, 2);
10404 SvIV_set(&PL_sv_yes, 1);
10405 SvNV_set(&PL_sv_yes, 1);
10406 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10408 /* create (a non-shared!) shared string table */
10409 PL_strtab = newHV();
10410 HvSHAREKEYS_off(PL_strtab);
10411 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10412 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10414 PL_compiling = proto_perl->Icompiling;
10416 /* These two PVs will be free'd special way so must set them same way op.c does */
10417 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10418 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10420 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10421 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10423 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10424 if (!specialWARN(PL_compiling.cop_warnings))
10425 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10426 if (!specialCopIO(PL_compiling.cop_io))
10427 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10428 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10430 /* pseudo environmental stuff */
10431 PL_origargc = proto_perl->Iorigargc;
10432 PL_origargv = proto_perl->Iorigargv;
10434 param->stashes = newAV(); /* Setup array of objects to call clone on */
10436 /* Set tainting stuff before PerlIO_debug can possibly get called */
10437 PL_tainting = proto_perl->Itainting;
10438 PL_taint_warn = proto_perl->Itaint_warn;
10440 #ifdef PERLIO_LAYERS
10441 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10442 PerlIO_clone(aTHX_ proto_perl, param);
10445 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10446 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10447 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10448 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10449 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10450 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10453 PL_minus_c = proto_perl->Iminus_c;
10454 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10455 PL_localpatches = proto_perl->Ilocalpatches;
10456 PL_splitstr = proto_perl->Isplitstr;
10457 PL_preprocess = proto_perl->Ipreprocess;
10458 PL_minus_n = proto_perl->Iminus_n;
10459 PL_minus_p = proto_perl->Iminus_p;
10460 PL_minus_l = proto_perl->Iminus_l;
10461 PL_minus_a = proto_perl->Iminus_a;
10462 PL_minus_F = proto_perl->Iminus_F;
10463 PL_doswitches = proto_perl->Idoswitches;
10464 PL_dowarn = proto_perl->Idowarn;
10465 PL_doextract = proto_perl->Idoextract;
10466 PL_sawampersand = proto_perl->Isawampersand;
10467 PL_unsafe = proto_perl->Iunsafe;
10468 PL_inplace = SAVEPV(proto_perl->Iinplace);
10469 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10470 PL_perldb = proto_perl->Iperldb;
10471 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10472 PL_exit_flags = proto_perl->Iexit_flags;
10474 /* magical thingies */
10475 /* XXX time(&PL_basetime) when asked for? */
10476 PL_basetime = proto_perl->Ibasetime;
10477 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10479 PL_maxsysfd = proto_perl->Imaxsysfd;
10480 PL_multiline = proto_perl->Imultiline;
10481 PL_statusvalue = proto_perl->Istatusvalue;
10483 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10485 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10487 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10489 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10490 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10491 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10493 /* Clone the regex array */
10494 PL_regex_padav = newAV();
10496 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10497 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10499 av_push(PL_regex_padav,
10500 sv_dup_inc(regexen[0],param));
10501 for(i = 1; i <= len; i++) {
10502 if(SvREPADTMP(regexen[i])) {
10503 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10505 av_push(PL_regex_padav,
10507 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10508 SvIVX(regexen[i])), param)))
10513 PL_regex_pad = AvARRAY(PL_regex_padav);
10515 /* shortcuts to various I/O objects */
10516 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10517 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10518 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10519 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10520 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10521 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10523 /* shortcuts to regexp stuff */
10524 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10526 /* shortcuts to misc objects */
10527 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10529 /* shortcuts to debugging objects */
10530 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10531 PL_DBline = gv_dup(proto_perl->IDBline, param);
10532 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10533 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10534 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10535 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10536 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10537 PL_lineary = av_dup(proto_perl->Ilineary, param);
10538 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10540 /* symbol tables */
10541 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10542 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10543 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10544 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10545 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10547 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10548 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10549 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10550 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10551 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10552 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10554 PL_sub_generation = proto_perl->Isub_generation;
10556 /* funky return mechanisms */
10557 PL_forkprocess = proto_perl->Iforkprocess;
10559 /* subprocess state */
10560 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10562 /* internal state */
10563 PL_maxo = proto_perl->Imaxo;
10564 if (proto_perl->Iop_mask)
10565 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10567 PL_op_mask = Nullch;
10568 /* PL_asserting = proto_perl->Iasserting; */
10570 /* current interpreter roots */
10571 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10572 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10573 PL_main_start = proto_perl->Imain_start;
10574 PL_eval_root = proto_perl->Ieval_root;
10575 PL_eval_start = proto_perl->Ieval_start;
10577 /* runtime control stuff */
10578 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10579 PL_copline = proto_perl->Icopline;
10581 PL_filemode = proto_perl->Ifilemode;
10582 PL_lastfd = proto_perl->Ilastfd;
10583 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10586 PL_gensym = proto_perl->Igensym;
10587 PL_preambled = proto_perl->Ipreambled;
10588 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10589 PL_laststatval = proto_perl->Ilaststatval;
10590 PL_laststype = proto_perl->Ilaststype;
10591 PL_mess_sv = Nullsv;
10593 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10595 /* interpreter atexit processing */
10596 PL_exitlistlen = proto_perl->Iexitlistlen;
10597 if (PL_exitlistlen) {
10598 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10599 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10602 PL_exitlist = (PerlExitListEntry*)NULL;
10603 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10604 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10605 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10607 PL_profiledata = NULL;
10608 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10609 /* PL_rsfp_filters entries have fake IoDIRP() */
10610 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10612 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10614 PAD_CLONE_VARS(proto_perl, param);
10616 #ifdef HAVE_INTERP_INTERN
10617 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10620 /* more statics moved here */
10621 PL_generation = proto_perl->Igeneration;
10622 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10624 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10625 PL_in_clean_all = proto_perl->Iin_clean_all;
10627 PL_uid = proto_perl->Iuid;
10628 PL_euid = proto_perl->Ieuid;
10629 PL_gid = proto_perl->Igid;
10630 PL_egid = proto_perl->Iegid;
10631 PL_nomemok = proto_perl->Inomemok;
10632 PL_an = proto_perl->Ian;
10633 PL_evalseq = proto_perl->Ievalseq;
10634 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10635 PL_origalen = proto_perl->Iorigalen;
10636 #ifdef PERL_USES_PL_PIDSTATUS
10637 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10639 PL_osname = SAVEPV(proto_perl->Iosname);
10640 PL_sighandlerp = proto_perl->Isighandlerp;
10642 PL_runops = proto_perl->Irunops;
10644 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10647 PL_cshlen = proto_perl->Icshlen;
10648 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10651 PL_lex_state = proto_perl->Ilex_state;
10652 PL_lex_defer = proto_perl->Ilex_defer;
10653 PL_lex_expect = proto_perl->Ilex_expect;
10654 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10655 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10656 PL_lex_starts = proto_perl->Ilex_starts;
10657 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10658 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10659 PL_lex_op = proto_perl->Ilex_op;
10660 PL_lex_inpat = proto_perl->Ilex_inpat;
10661 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10662 PL_lex_brackets = proto_perl->Ilex_brackets;
10663 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10664 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10665 PL_lex_casemods = proto_perl->Ilex_casemods;
10666 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10667 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10669 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10670 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10671 PL_nexttoke = proto_perl->Inexttoke;
10673 /* XXX This is probably masking the deeper issue of why
10674 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10675 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10676 * (A little debugging with a watchpoint on it may help.)
10678 if (SvANY(proto_perl->Ilinestr)) {
10679 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10680 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10681 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10682 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10683 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10684 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10685 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10686 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10687 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10690 PL_linestr = NEWSV(65,79);
10691 sv_upgrade(PL_linestr,SVt_PVIV);
10692 sv_setpvn(PL_linestr,"",0);
10693 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10695 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10696 PL_pending_ident = proto_perl->Ipending_ident;
10697 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10699 PL_expect = proto_perl->Iexpect;
10701 PL_multi_start = proto_perl->Imulti_start;
10702 PL_multi_end = proto_perl->Imulti_end;
10703 PL_multi_open = proto_perl->Imulti_open;
10704 PL_multi_close = proto_perl->Imulti_close;
10706 PL_error_count = proto_perl->Ierror_count;
10707 PL_subline = proto_perl->Isubline;
10708 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10710 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10711 if (SvANY(proto_perl->Ilinestr)) {
10712 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10713 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10714 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10715 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10716 PL_last_lop_op = proto_perl->Ilast_lop_op;
10719 PL_last_uni = SvPVX(PL_linestr);
10720 PL_last_lop = SvPVX(PL_linestr);
10721 PL_last_lop_op = 0;
10723 PL_in_my = proto_perl->Iin_my;
10724 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10726 PL_cryptseen = proto_perl->Icryptseen;
10729 PL_hints = proto_perl->Ihints;
10731 PL_amagic_generation = proto_perl->Iamagic_generation;
10733 #ifdef USE_LOCALE_COLLATE
10734 PL_collation_ix = proto_perl->Icollation_ix;
10735 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10736 PL_collation_standard = proto_perl->Icollation_standard;
10737 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10738 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10739 #endif /* USE_LOCALE_COLLATE */
10741 #ifdef USE_LOCALE_NUMERIC
10742 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10743 PL_numeric_standard = proto_perl->Inumeric_standard;
10744 PL_numeric_local = proto_perl->Inumeric_local;
10745 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10746 #endif /* !USE_LOCALE_NUMERIC */
10748 /* utf8 character classes */
10749 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10750 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10751 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10752 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10753 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10754 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10755 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10756 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10757 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10758 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10759 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10760 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10761 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10762 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10763 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10764 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10765 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10766 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10767 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10768 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10770 /* Did the locale setup indicate UTF-8? */
10771 PL_utf8locale = proto_perl->Iutf8locale;
10772 /* Unicode features (see perlrun/-C) */
10773 PL_unicode = proto_perl->Iunicode;
10775 /* Pre-5.8 signals control */
10776 PL_signals = proto_perl->Isignals;
10778 /* times() ticks per second */
10779 PL_clocktick = proto_perl->Iclocktick;
10781 /* Recursion stopper for PerlIO_find_layer */
10782 PL_in_load_module = proto_perl->Iin_load_module;
10784 /* sort() routine */
10785 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10787 /* Not really needed/useful since the reenrant_retint is "volatile",
10788 * but do it for consistency's sake. */
10789 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10791 /* Hooks to shared SVs and locks. */
10792 PL_sharehook = proto_perl->Isharehook;
10793 PL_lockhook = proto_perl->Ilockhook;
10794 PL_unlockhook = proto_perl->Iunlockhook;
10795 PL_threadhook = proto_perl->Ithreadhook;
10797 PL_runops_std = proto_perl->Irunops_std;
10798 PL_runops_dbg = proto_perl->Irunops_dbg;
10800 #ifdef THREADS_HAVE_PIDS
10801 PL_ppid = proto_perl->Ippid;
10805 PL_last_swash_hv = Nullhv; /* reinits on demand */
10806 PL_last_swash_klen = 0;
10807 PL_last_swash_key[0]= '\0';
10808 PL_last_swash_tmps = (U8*)NULL;
10809 PL_last_swash_slen = 0;
10811 PL_glob_index = proto_perl->Iglob_index;
10812 PL_srand_called = proto_perl->Isrand_called;
10813 PL_uudmap['M'] = 0; /* reinits on demand */
10814 PL_bitcount = Nullch; /* reinits on demand */
10816 if (proto_perl->Ipsig_pend) {
10817 Newxz(PL_psig_pend, SIG_SIZE, int);
10820 PL_psig_pend = (int*)NULL;
10823 if (proto_perl->Ipsig_ptr) {
10824 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10825 Newxz(PL_psig_name, SIG_SIZE, SV*);
10826 for (i = 1; i < SIG_SIZE; i++) {
10827 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10828 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10832 PL_psig_ptr = (SV**)NULL;
10833 PL_psig_name = (SV**)NULL;
10836 /* thrdvar.h stuff */
10838 if (flags & CLONEf_COPY_STACKS) {
10839 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10840 PL_tmps_ix = proto_perl->Ttmps_ix;
10841 PL_tmps_max = proto_perl->Ttmps_max;
10842 PL_tmps_floor = proto_perl->Ttmps_floor;
10843 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10845 while (i <= PL_tmps_ix) {
10846 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10850 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10851 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10852 Newxz(PL_markstack, i, I32);
10853 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10854 - proto_perl->Tmarkstack);
10855 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10856 - proto_perl->Tmarkstack);
10857 Copy(proto_perl->Tmarkstack, PL_markstack,
10858 PL_markstack_ptr - PL_markstack + 1, I32);
10860 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10861 * NOTE: unlike the others! */
10862 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10863 PL_scopestack_max = proto_perl->Tscopestack_max;
10864 Newxz(PL_scopestack, PL_scopestack_max, I32);
10865 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10867 /* NOTE: si_dup() looks at PL_markstack */
10868 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10870 /* PL_curstack = PL_curstackinfo->si_stack; */
10871 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10872 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10874 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10875 PL_stack_base = AvARRAY(PL_curstack);
10876 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10877 - proto_perl->Tstack_base);
10878 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10880 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10881 * NOTE: unlike the others! */
10882 PL_savestack_ix = proto_perl->Tsavestack_ix;
10883 PL_savestack_max = proto_perl->Tsavestack_max;
10884 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10885 PL_savestack = ss_dup(proto_perl, param);
10889 ENTER; /* perl_destruct() wants to LEAVE; */
10892 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10893 PL_top_env = &PL_start_env;
10895 PL_op = proto_perl->Top;
10898 PL_Xpv = (XPV*)NULL;
10899 PL_na = proto_perl->Tna;
10901 PL_statbuf = proto_perl->Tstatbuf;
10902 PL_statcache = proto_perl->Tstatcache;
10903 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10904 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10906 PL_timesbuf = proto_perl->Ttimesbuf;
10909 PL_tainted = proto_perl->Ttainted;
10910 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10911 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10912 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10913 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10914 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10915 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10916 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10917 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10918 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10920 PL_restartop = proto_perl->Trestartop;
10921 PL_in_eval = proto_perl->Tin_eval;
10922 PL_delaymagic = proto_perl->Tdelaymagic;
10923 PL_dirty = proto_perl->Tdirty;
10924 PL_localizing = proto_perl->Tlocalizing;
10926 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10927 PL_hv_fetch_ent_mh = Nullhe;
10928 PL_modcount = proto_perl->Tmodcount;
10929 PL_lastgotoprobe = Nullop;
10930 PL_dumpindent = proto_perl->Tdumpindent;
10932 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10933 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10934 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10935 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10936 PL_efloatbuf = Nullch; /* reinits on demand */
10937 PL_efloatsize = 0; /* reinits on demand */
10941 PL_screamfirst = NULL;
10942 PL_screamnext = NULL;
10943 PL_maxscream = -1; /* reinits on demand */
10944 PL_lastscream = Nullsv;
10946 PL_watchaddr = NULL;
10947 PL_watchok = Nullch;
10949 PL_regdummy = proto_perl->Tregdummy;
10950 PL_regprecomp = Nullch;
10953 PL_colorset = 0; /* reinits PL_colors[] */
10954 /*PL_colors[6] = {0,0,0,0,0,0};*/
10955 PL_reginput = Nullch;
10956 PL_regbol = Nullch;
10957 PL_regeol = Nullch;
10958 PL_regstartp = (I32*)NULL;
10959 PL_regendp = (I32*)NULL;
10960 PL_reglastparen = (U32*)NULL;
10961 PL_reglastcloseparen = (U32*)NULL;
10962 PL_regtill = Nullch;
10963 PL_reg_start_tmp = (char**)NULL;
10964 PL_reg_start_tmpl = 0;
10965 PL_regdata = (struct reg_data*)NULL;
10968 PL_reg_eval_set = 0;
10970 PL_regprogram = (regnode*)NULL;
10972 PL_regcc = (CURCUR*)NULL;
10973 PL_reg_call_cc = (struct re_cc_state*)NULL;
10974 PL_reg_re = (regexp*)NULL;
10975 PL_reg_ganch = Nullch;
10976 PL_reg_sv = Nullsv;
10977 PL_reg_match_utf8 = FALSE;
10978 PL_reg_magic = (MAGIC*)NULL;
10980 PL_reg_oldcurpm = (PMOP*)NULL;
10981 PL_reg_curpm = (PMOP*)NULL;
10982 PL_reg_oldsaved = Nullch;
10983 PL_reg_oldsavedlen = 0;
10984 #ifdef PERL_OLD_COPY_ON_WRITE
10987 PL_reg_maxiter = 0;
10988 PL_reg_leftiter = 0;
10989 PL_reg_poscache = Nullch;
10990 PL_reg_poscache_size= 0;
10992 /* RE engine - function pointers */
10993 PL_regcompp = proto_perl->Tregcompp;
10994 PL_regexecp = proto_perl->Tregexecp;
10995 PL_regint_start = proto_perl->Tregint_start;
10996 PL_regint_string = proto_perl->Tregint_string;
10997 PL_regfree = proto_perl->Tregfree;
10999 PL_reginterp_cnt = 0;
11000 PL_reg_starttry = 0;
11002 /* Pluggable optimizer */
11003 PL_peepp = proto_perl->Tpeepp;
11005 PL_stashcache = newHV();
11007 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11008 ptr_table_free(PL_ptr_table);
11009 PL_ptr_table = NULL;
11012 /* Call the ->CLONE method, if it exists, for each of the stashes
11013 identified by sv_dup() above.
11015 while(av_len(param->stashes) != -1) {
11016 HV* const stash = (HV*) av_shift(param->stashes);
11017 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11018 if (cloner && GvCV(cloner)) {
11023 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11025 call_sv((SV*)GvCV(cloner), G_DISCARD);
11031 SvREFCNT_dec(param->stashes);
11033 /* orphaned? eg threads->new inside BEGIN or use */
11034 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11035 (void)SvREFCNT_inc(PL_compcv);
11036 SAVEFREESV(PL_compcv);
11042 #endif /* USE_ITHREADS */
11045 =head1 Unicode Support
11047 =for apidoc sv_recode_to_utf8
11049 The encoding is assumed to be an Encode object, on entry the PV
11050 of the sv is assumed to be octets in that encoding, and the sv
11051 will be converted into Unicode (and UTF-8).
11053 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11054 is not a reference, nothing is done to the sv. If the encoding is not
11055 an C<Encode::XS> Encoding object, bad things will happen.
11056 (See F<lib/encoding.pm> and L<Encode>).
11058 The PV of the sv is returned.
11063 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11066 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11080 Passing sv_yes is wrong - it needs to be or'ed set of constants
11081 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11082 remove converted chars from source.
11084 Both will default the value - let them.
11086 XPUSHs(&PL_sv_yes);
11089 call_method("decode", G_SCALAR);
11093 s = SvPV_const(uni, len);
11094 if (s != SvPVX_const(sv)) {
11095 SvGROW(sv, len + 1);
11096 Move(s, SvPVX(sv), len + 1, char);
11097 SvCUR_set(sv, len);
11104 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11108 =for apidoc sv_cat_decode
11110 The encoding is assumed to be an Encode object, the PV of the ssv is
11111 assumed to be octets in that encoding and decoding the input starts
11112 from the position which (PV + *offset) pointed to. The dsv will be
11113 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11114 when the string tstr appears in decoding output or the input ends on
11115 the PV of the ssv. The value which the offset points will be modified
11116 to the last input position on the ssv.
11118 Returns TRUE if the terminator was found, else returns FALSE.
11123 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11124 SV *ssv, int *offset, char *tstr, int tlen)
11128 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11139 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11140 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11142 call_method("cat_decode", G_SCALAR);
11144 ret = SvTRUE(TOPs);
11145 *offset = SvIV(offsv);
11151 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11156 /* ---------------------------------------------------------------------
11158 * support functions for report_uninit()
11161 /* the maxiumum size of array or hash where we will scan looking
11162 * for the undefined element that triggered the warning */
11164 #define FUV_MAX_SEARCH_SIZE 1000
11166 /* Look for an entry in the hash whose value has the same SV as val;
11167 * If so, return a mortal copy of the key. */
11170 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11173 register HE **array;
11176 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11177 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11180 array = HvARRAY(hv);
11182 for (i=HvMAX(hv); i>0; i--) {
11183 register HE *entry;
11184 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11185 if (HeVAL(entry) != val)
11187 if ( HeVAL(entry) == &PL_sv_undef ||
11188 HeVAL(entry) == &PL_sv_placeholder)
11192 if (HeKLEN(entry) == HEf_SVKEY)
11193 return sv_mortalcopy(HeKEY_sv(entry));
11194 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11200 /* Look for an entry in the array whose value has the same SV as val;
11201 * If so, return the index, otherwise return -1. */
11204 S_find_array_subscript(pTHX_ AV *av, SV* val)
11208 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11209 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11213 for (i=AvFILLp(av); i>=0; i--) {
11214 if (svp[i] == val && svp[i] != &PL_sv_undef)
11220 /* S_varname(): return the name of a variable, optionally with a subscript.
11221 * If gv is non-zero, use the name of that global, along with gvtype (one
11222 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11223 * targ. Depending on the value of the subscript_type flag, return:
11226 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11227 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11228 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11229 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11232 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11233 SV* keyname, I32 aindex, int subscript_type)
11236 SV * const name = sv_newmortal();
11239 buffer[0] = gvtype;
11242 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11244 gv_fullname4(name, gv, buffer, 0);
11246 if ((unsigned int)SvPVX(name)[1] <= 26) {
11248 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11250 /* Swap the 1 unprintable control character for the 2 byte pretty
11251 version - ie substr($name, 1, 1) = $buffer; */
11252 sv_insert(name, 1, 1, buffer, 2);
11257 CV * const cv = find_runcv(&unused);
11261 if (!cv || !CvPADLIST(cv))
11263 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11264 sv = *av_fetch(av, targ, FALSE);
11265 /* SvLEN in a pad name is not to be trusted */
11266 sv_setpv(name, SvPV_nolen_const(sv));
11269 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11270 SV * const sv = NEWSV(0,0);
11271 *SvPVX(name) = '$';
11272 Perl_sv_catpvf(aTHX_ name, "{%s}",
11273 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11276 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11277 *SvPVX(name) = '$';
11278 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11280 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11281 sv_insert(name, 0, 0, "within ", 7);
11288 =for apidoc find_uninit_var
11290 Find the name of the undefined variable (if any) that caused the operator o
11291 to issue a "Use of uninitialized value" warning.
11292 If match is true, only return a name if it's value matches uninit_sv.
11293 So roughly speaking, if a unary operator (such as OP_COS) generates a
11294 warning, then following the direct child of the op may yield an
11295 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11296 other hand, with OP_ADD there are two branches to follow, so we only print
11297 the variable name if we get an exact match.
11299 The name is returned as a mortal SV.
11301 Assumes that PL_op is the op that originally triggered the error, and that
11302 PL_comppad/PL_curpad points to the currently executing pad.
11308 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11316 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11317 uninit_sv == &PL_sv_placeholder)))
11320 switch (obase->op_type) {
11327 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11328 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11330 SV *keysv = Nullsv;
11331 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11333 if (pad) { /* @lex, %lex */
11334 sv = PAD_SVl(obase->op_targ);
11338 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11339 /* @global, %global */
11340 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11343 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11345 else /* @{expr}, %{expr} */
11346 return find_uninit_var(cUNOPx(obase)->op_first,
11350 /* attempt to find a match within the aggregate */
11352 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11354 subscript_type = FUV_SUBSCRIPT_HASH;
11357 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11359 subscript_type = FUV_SUBSCRIPT_ARRAY;
11362 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11365 return varname(gv, hash ? '%' : '@', obase->op_targ,
11366 keysv, index, subscript_type);
11370 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11372 return varname(Nullgv, '$', obase->op_targ,
11373 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11376 gv = cGVOPx_gv(obase);
11377 if (!gv || (match && GvSV(gv) != uninit_sv))
11379 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11382 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11385 av = (AV*)PAD_SV(obase->op_targ);
11386 if (!av || SvRMAGICAL(av))
11388 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11389 if (!svp || *svp != uninit_sv)
11392 return varname(Nullgv, '$', obase->op_targ,
11393 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11396 gv = cGVOPx_gv(obase);
11402 if (!av || SvRMAGICAL(av))
11404 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11405 if (!svp || *svp != uninit_sv)
11408 return varname(gv, '$', 0,
11409 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11414 o = cUNOPx(obase)->op_first;
11415 if (!o || o->op_type != OP_NULL ||
11416 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11418 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11422 if (PL_op == obase)
11423 /* $a[uninit_expr] or $h{uninit_expr} */
11424 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11427 o = cBINOPx(obase)->op_first;
11428 kid = cBINOPx(obase)->op_last;
11430 /* get the av or hv, and optionally the gv */
11432 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11433 sv = PAD_SV(o->op_targ);
11435 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11436 && cUNOPo->op_first->op_type == OP_GV)
11438 gv = cGVOPx_gv(cUNOPo->op_first);
11441 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11446 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11447 /* index is constant */
11451 if (obase->op_type == OP_HELEM) {
11452 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11453 if (!he || HeVAL(he) != uninit_sv)
11457 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11458 if (!svp || *svp != uninit_sv)
11462 if (obase->op_type == OP_HELEM)
11463 return varname(gv, '%', o->op_targ,
11464 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11466 return varname(gv, '@', o->op_targ, Nullsv,
11467 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11471 /* index is an expression;
11472 * attempt to find a match within the aggregate */
11473 if (obase->op_type == OP_HELEM) {
11474 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11476 return varname(gv, '%', o->op_targ,
11477 keysv, 0, FUV_SUBSCRIPT_HASH);
11480 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11482 return varname(gv, '@', o->op_targ,
11483 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11488 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11490 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11496 /* only examine RHS */
11497 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11500 o = cUNOPx(obase)->op_first;
11501 if (o->op_type == OP_PUSHMARK)
11504 if (!o->op_sibling) {
11505 /* one-arg version of open is highly magical */
11507 if (o->op_type == OP_GV) { /* open FOO; */
11509 if (match && GvSV(gv) != uninit_sv)
11511 return varname(gv, '$', 0,
11512 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11514 /* other possibilities not handled are:
11515 * open $x; or open my $x; should return '${*$x}'
11516 * open expr; should return '$'.expr ideally
11522 /* ops where $_ may be an implicit arg */
11526 if ( !(obase->op_flags & OPf_STACKED)) {
11527 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11528 ? PAD_SVl(obase->op_targ)
11531 sv = sv_newmortal();
11532 sv_setpvn(sv, "$_", 2);
11540 /* skip filehandle as it can't produce 'undef' warning */
11541 o = cUNOPx(obase)->op_first;
11542 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11543 o = o->op_sibling->op_sibling;
11550 match = 1; /* XS or custom code could trigger random warnings */
11555 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11556 return sv_2mortal(newSVpvn("${$/}", 5));
11561 if (!(obase->op_flags & OPf_KIDS))
11563 o = cUNOPx(obase)->op_first;
11569 /* if all except one arg are constant, or have no side-effects,
11570 * or are optimized away, then it's unambiguous */
11572 for (kid=o; kid; kid = kid->op_sibling) {
11574 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11575 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11576 || (kid->op_type == OP_PUSHMARK)
11580 if (o2) { /* more than one found */
11587 return find_uninit_var(o2, uninit_sv, match);
11589 /* scan all args */
11591 sv = find_uninit_var(o, uninit_sv, 1);
11603 =for apidoc report_uninit
11605 Print appropriate "Use of uninitialized variable" warning
11611 Perl_report_uninit(pTHX_ SV* uninit_sv)
11614 SV* varname = Nullsv;
11616 varname = find_uninit_var(PL_op, uninit_sv,0);
11618 sv_insert(varname, 0, 0, " ", 1);
11620 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11621 varname ? SvPV_nolen_const(varname) : "",
11622 " in ", OP_DESC(PL_op));
11625 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11631 * c-indentation-style: bsd
11632 * c-basic-offset: 4
11633 * indent-tabs-mode: t
11636 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob