3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
360 SV* const sva = (SV*)ptr;
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void **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 else if (SvNOKp(sv)) {
1683 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1684 * without also getting a cached IV/UV from it at the same time
1685 * (ie PV->NV conversion should detect loss of accuracy and cache
1686 * IV or UV at same time to avoid this. NWC */
1688 if (SvTYPE(sv) == SVt_NV)
1689 sv_upgrade(sv, SVt_PVNV);
1691 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1692 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1693 certainly cast into the IV range at IV_MAX, whereas the correct
1694 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1696 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1697 SvIV_set(sv, I_V(SvNVX(sv)));
1698 if (SvNVX(sv) == (NV) SvIVX(sv)
1699 #ifndef NV_PRESERVES_UV
1700 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1701 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1702 /* Don't flag it as "accurately an integer" if the number
1703 came from a (by definition imprecise) NV operation, and
1704 we're outside the range of NV integer precision */
1707 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1708 DEBUG_c(PerlIO_printf(Perl_debug_log,
1709 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1715 /* IV not precise. No need to convert from PV, as NV
1716 conversion would already have cached IV if it detected
1717 that PV->IV would be better than PV->NV->IV
1718 flags already correct - don't set public IOK. */
1719 DEBUG_c(PerlIO_printf(Perl_debug_log,
1720 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1725 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1726 but the cast (NV)IV_MIN rounds to a the value less (more
1727 negative) than IV_MIN which happens to be equal to SvNVX ??
1728 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1729 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1730 (NV)UVX == NVX are both true, but the values differ. :-(
1731 Hopefully for 2s complement IV_MIN is something like
1732 0x8000000000000000 which will be exact. NWC */
1735 SvUV_set(sv, U_V(SvNVX(sv)));
1737 (SvNVX(sv) == (NV) SvUVX(sv))
1738 #ifndef NV_PRESERVES_UV
1739 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1740 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1741 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1742 /* Don't flag it as "accurately an integer" if the number
1743 came from a (by definition imprecise) NV operation, and
1744 we're outside the range of NV integer precision */
1749 DEBUG_c(PerlIO_printf(Perl_debug_log,
1750 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1756 else if (SvPOKp(sv) && SvLEN(sv)) {
1758 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1759 /* We want to avoid a possible problem when we cache an IV which
1760 may be later translated to an NV, and the resulting NV is not
1761 the same as the direct translation of the initial string
1762 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1763 be careful to ensure that the value with the .456 is around if the
1764 NV value is requested in the future).
1766 This means that if we cache such an IV, we need to cache the
1767 NV as well. Moreover, we trade speed for space, and do not
1768 cache the NV if we are sure it's not needed.
1771 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1772 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1773 == IS_NUMBER_IN_UV) {
1774 /* It's definitely an integer, only upgrade to PVIV */
1775 if (SvTYPE(sv) < SVt_PVIV)
1776 sv_upgrade(sv, SVt_PVIV);
1778 } else if (SvTYPE(sv) < SVt_PVNV)
1779 sv_upgrade(sv, SVt_PVNV);
1781 /* If NV preserves UV then we only use the UV value if we know that
1782 we aren't going to call atof() below. If NVs don't preserve UVs
1783 then the value returned may have more precision than atof() will
1784 return, even though value isn't perfectly accurate. */
1785 if ((numtype & (IS_NUMBER_IN_UV
1786 #ifdef NV_PRESERVES_UV
1789 )) == IS_NUMBER_IN_UV) {
1790 /* This won't turn off the public IOK flag if it was set above */
1791 (void)SvIOKp_on(sv);
1793 if (!(numtype & IS_NUMBER_NEG)) {
1795 if (value <= (UV)IV_MAX) {
1796 SvIV_set(sv, (IV)value);
1798 SvUV_set(sv, value);
1802 /* 2s complement assumption */
1803 if (value <= (UV)IV_MIN) {
1804 SvIV_set(sv, -(IV)value);
1806 /* Too negative for an IV. This is a double upgrade, but
1807 I'm assuming it will be rare. */
1808 if (SvTYPE(sv) < SVt_PVNV)
1809 sv_upgrade(sv, SVt_PVNV);
1813 SvNV_set(sv, -(NV)value);
1814 SvIV_set(sv, IV_MIN);
1818 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1819 will be in the previous block to set the IV slot, and the next
1820 block to set the NV slot. So no else here. */
1822 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1823 != IS_NUMBER_IN_UV) {
1824 /* It wasn't an (integer that doesn't overflow the UV). */
1825 SvNV_set(sv, Atof(SvPVX_const(sv)));
1827 if (! numtype && ckWARN(WARN_NUMERIC))
1830 #if defined(USE_LONG_DOUBLE)
1831 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1832 PTR2UV(sv), SvNVX(sv)));
1834 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1835 PTR2UV(sv), SvNVX(sv)));
1839 #ifdef NV_PRESERVES_UV
1840 (void)SvIOKp_on(sv);
1842 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1843 SvIV_set(sv, I_V(SvNVX(sv)));
1844 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1847 /* Integer is imprecise. NOK, IOKp */
1849 /* UV will not work better than IV */
1851 if (SvNVX(sv) > (NV)UV_MAX) {
1853 /* Integer is inaccurate. NOK, IOKp, is UV */
1854 SvUV_set(sv, UV_MAX);
1857 SvUV_set(sv, U_V(SvNVX(sv)));
1858 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1859 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1863 /* Integer is imprecise. NOK, IOKp, is UV */
1868 #else /* NV_PRESERVES_UV */
1869 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1870 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1871 /* The IV slot will have been set from value returned by
1872 grok_number above. The NV slot has just been set using
1875 assert (SvIOKp(sv));
1877 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1878 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1879 /* Small enough to preserve all bits. */
1880 (void)SvIOKp_on(sv);
1882 SvIV_set(sv, I_V(SvNVX(sv)));
1883 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1885 /* Assumption: first non-preserved integer is < IV_MAX,
1886 this NV is in the preserved range, therefore: */
1887 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1889 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);
1893 0 0 already failed to read UV.
1894 0 1 already failed to read UV.
1895 1 0 you won't get here in this case. IV/UV
1896 slot set, public IOK, Atof() unneeded.
1897 1 1 already read UV.
1898 so there's no point in sv_2iuv_non_preserve() attempting
1899 to use atol, strtol, strtoul etc. */
1900 sv_2iuv_non_preserve (sv, numtype);
1903 #endif /* NV_PRESERVES_UV */
1906 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1908 if (SvTYPE(sv) < SVt_IV)
1909 /* Typically the caller expects that sv_any is not NULL now. */
1910 sv_upgrade(sv, SVt_IV);
1913 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1914 PTR2UV(sv),SvIVX(sv)));
1915 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1919 =for apidoc sv_2uv_flags
1921 Return the unsigned integer value of an SV, doing any necessary string
1922 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1923 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1929 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1933 if (SvGMAGICAL(sv)) {
1934 if (flags & SV_GMAGIC)
1939 return U_V(SvNVX(sv));
1940 if (SvPOKp(sv) && SvLEN(sv))
1943 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1944 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1950 if (SvTHINKFIRST(sv)) {
1953 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1954 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1955 return SvUV(tmpstr);
1956 return PTR2UV(SvRV(sv));
1959 sv_force_normal_flags(sv, 0);
1961 if (SvREADONLY(sv) && !SvOK(sv)) {
1962 if (ckWARN(WARN_UNINITIALIZED))
1969 else if (SvNOKp(sv)) {
1970 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1971 * without also getting a cached IV/UV from it at the same time
1972 * (ie PV->NV conversion should detect loss of accuracy and cache
1973 * IV or UV at same time to avoid this. */
1974 /* IV-over-UV optimisation - choose to cache IV if possible */
1976 if (SvTYPE(sv) == SVt_NV)
1977 sv_upgrade(sv, SVt_PVNV);
1979 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1980 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1981 SvIV_set(sv, I_V(SvNVX(sv)));
1982 if (SvNVX(sv) == (NV) SvIVX(sv)
1983 #ifndef NV_PRESERVES_UV
1984 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1985 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1986 /* Don't flag it as "accurately an integer" if the number
1987 came from a (by definition imprecise) NV operation, and
1988 we're outside the range of NV integer precision */
1991 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1992 DEBUG_c(PerlIO_printf(Perl_debug_log,
1993 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
1999 /* IV not precise. No need to convert from PV, as NV
2000 conversion would already have cached IV if it detected
2001 that PV->IV would be better than PV->NV->IV
2002 flags already correct - don't set public IOK. */
2003 DEBUG_c(PerlIO_printf(Perl_debug_log,
2004 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2009 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2010 but the cast (NV)IV_MIN rounds to a the value less (more
2011 negative) than IV_MIN which happens to be equal to SvNVX ??
2012 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2013 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2014 (NV)UVX == NVX are both true, but the values differ. :-(
2015 Hopefully for 2s complement IV_MIN is something like
2016 0x8000000000000000 which will be exact. NWC */
2019 SvUV_set(sv, U_V(SvNVX(sv)));
2021 (SvNVX(sv) == (NV) SvUVX(sv))
2022 #ifndef NV_PRESERVES_UV
2023 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2024 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2025 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2026 /* Don't flag it as "accurately an integer" if the number
2027 came from a (by definition imprecise) NV operation, and
2028 we're outside the range of NV integer precision */
2033 DEBUG_c(PerlIO_printf(Perl_debug_log,
2034 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2040 else if (SvPOKp(sv) && SvLEN(sv)) {
2042 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2044 /* We want to avoid a possible problem when we cache a UV which
2045 may be later translated to an NV, and the resulting NV is not
2046 the translation of the initial data.
2048 This means that if we cache such a UV, we need to cache the
2049 NV as well. Moreover, we trade speed for space, and do not
2050 cache the NV if not needed.
2053 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2054 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2055 == IS_NUMBER_IN_UV) {
2056 /* It's definitely an integer, only upgrade to PVIV */
2057 if (SvTYPE(sv) < SVt_PVIV)
2058 sv_upgrade(sv, SVt_PVIV);
2060 } else if (SvTYPE(sv) < SVt_PVNV)
2061 sv_upgrade(sv, SVt_PVNV);
2063 /* If NV preserves UV then we only use the UV value if we know that
2064 we aren't going to call atof() below. If NVs don't preserve UVs
2065 then the value returned may have more precision than atof() will
2066 return, even though it isn't accurate. */
2067 if ((numtype & (IS_NUMBER_IN_UV
2068 #ifdef NV_PRESERVES_UV
2071 )) == IS_NUMBER_IN_UV) {
2072 /* This won't turn off the public IOK flag if it was set above */
2073 (void)SvIOKp_on(sv);
2075 if (!(numtype & IS_NUMBER_NEG)) {
2077 if (value <= (UV)IV_MAX) {
2078 SvIV_set(sv, (IV)value);
2080 /* it didn't overflow, and it was positive. */
2081 SvUV_set(sv, value);
2085 /* 2s complement assumption */
2086 if (value <= (UV)IV_MIN) {
2087 SvIV_set(sv, -(IV)value);
2089 /* Too negative for an IV. This is a double upgrade, but
2090 I'm assuming it will be rare. */
2091 if (SvTYPE(sv) < SVt_PVNV)
2092 sv_upgrade(sv, SVt_PVNV);
2096 SvNV_set(sv, -(NV)value);
2097 SvIV_set(sv, IV_MIN);
2102 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2103 != IS_NUMBER_IN_UV) {
2104 /* It wasn't an integer, or it overflowed the UV. */
2105 SvNV_set(sv, Atof(SvPVX_const(sv)));
2107 if (! numtype && ckWARN(WARN_NUMERIC))
2110 #if defined(USE_LONG_DOUBLE)
2111 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2112 PTR2UV(sv), SvNVX(sv)));
2114 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2115 PTR2UV(sv), SvNVX(sv)));
2118 #ifdef NV_PRESERVES_UV
2119 (void)SvIOKp_on(sv);
2121 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2122 SvIV_set(sv, I_V(SvNVX(sv)));
2123 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2126 /* Integer is imprecise. NOK, IOKp */
2128 /* UV will not work better than IV */
2130 if (SvNVX(sv) > (NV)UV_MAX) {
2132 /* Integer is inaccurate. NOK, IOKp, is UV */
2133 SvUV_set(sv, UV_MAX);
2136 SvUV_set(sv, U_V(SvNVX(sv)));
2137 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2138 NV preservse UV so can do correct comparison. */
2139 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2143 /* Integer is imprecise. NOK, IOKp, is UV */
2148 #else /* NV_PRESERVES_UV */
2149 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2150 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2151 /* The UV slot will have been set from value returned by
2152 grok_number above. The NV slot has just been set using
2155 assert (SvIOKp(sv));
2157 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2158 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2159 /* Small enough to preserve all bits. */
2160 (void)SvIOKp_on(sv);
2162 SvIV_set(sv, I_V(SvNVX(sv)));
2163 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2165 /* Assumption: first non-preserved integer is < IV_MAX,
2166 this NV is in the preserved range, therefore: */
2167 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2169 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);
2172 sv_2iuv_non_preserve (sv, numtype);
2174 #endif /* NV_PRESERVES_UV */
2178 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2179 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2182 if (SvTYPE(sv) < SVt_IV)
2183 /* Typically the caller expects that sv_any is not NULL now. */
2184 sv_upgrade(sv, SVt_IV);
2188 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2189 PTR2UV(sv),SvUVX(sv)));
2190 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2196 Return the num value of an SV, doing any necessary string or integer
2197 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2204 Perl_sv_2nv(pTHX_ register SV *sv)
2208 if (SvGMAGICAL(sv)) {
2212 if (SvPOKp(sv) && SvLEN(sv)) {
2213 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2214 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2216 return Atof(SvPVX_const(sv));
2220 return (NV)SvUVX(sv);
2222 return (NV)SvIVX(sv);
2225 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2226 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2232 if (SvTHINKFIRST(sv)) {
2235 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2236 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2237 return SvNV(tmpstr);
2238 return PTR2NV(SvRV(sv));
2241 sv_force_normal_flags(sv, 0);
2243 if (SvREADONLY(sv) && !SvOK(sv)) {
2244 if (ckWARN(WARN_UNINITIALIZED))
2249 if (SvTYPE(sv) < SVt_NV) {
2250 if (SvTYPE(sv) == SVt_IV)
2251 sv_upgrade(sv, SVt_PVNV);
2253 sv_upgrade(sv, SVt_NV);
2254 #ifdef USE_LONG_DOUBLE
2256 STORE_NUMERIC_LOCAL_SET_STANDARD();
2257 PerlIO_printf(Perl_debug_log,
2258 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2259 PTR2UV(sv), SvNVX(sv));
2260 RESTORE_NUMERIC_LOCAL();
2264 STORE_NUMERIC_LOCAL_SET_STANDARD();
2265 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2266 PTR2UV(sv), SvNVX(sv));
2267 RESTORE_NUMERIC_LOCAL();
2271 else if (SvTYPE(sv) < SVt_PVNV)
2272 sv_upgrade(sv, SVt_PVNV);
2277 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2278 #ifdef NV_PRESERVES_UV
2281 /* Only set the public NV OK flag if this NV preserves the IV */
2282 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2283 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2284 : (SvIVX(sv) == I_V(SvNVX(sv))))
2290 else if (SvPOKp(sv) && SvLEN(sv)) {
2292 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2293 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2295 #ifdef NV_PRESERVES_UV
2296 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2297 == IS_NUMBER_IN_UV) {
2298 /* It's definitely an integer */
2299 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2301 SvNV_set(sv, Atof(SvPVX_const(sv)));
2304 SvNV_set(sv, Atof(SvPVX_const(sv)));
2305 /* Only set the public NV OK flag if this NV preserves the value in
2306 the PV at least as well as an IV/UV would.
2307 Not sure how to do this 100% reliably. */
2308 /* if that shift count is out of range then Configure's test is
2309 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2311 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2312 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2313 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2314 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2315 /* Can't use strtol etc to convert this string, so don't try.
2316 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2319 /* value has been set. It may not be precise. */
2320 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2321 /* 2s complement assumption for (UV)IV_MIN */
2322 SvNOK_on(sv); /* Integer is too negative. */
2327 if (numtype & IS_NUMBER_NEG) {
2328 SvIV_set(sv, -(IV)value);
2329 } else if (value <= (UV)IV_MAX) {
2330 SvIV_set(sv, (IV)value);
2332 SvUV_set(sv, value);
2336 if (numtype & IS_NUMBER_NOT_INT) {
2337 /* I believe that even if the original PV had decimals,
2338 they are lost beyond the limit of the FP precision.
2339 However, neither is canonical, so both only get p
2340 flags. NWC, 2000/11/25 */
2341 /* Both already have p flags, so do nothing */
2343 const NV nv = SvNVX(sv);
2344 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2345 if (SvIVX(sv) == I_V(nv)) {
2350 /* It had no "." so it must be integer. */
2353 /* between IV_MAX and NV(UV_MAX).
2354 Could be slightly > UV_MAX */
2356 if (numtype & IS_NUMBER_NOT_INT) {
2357 /* UV and NV both imprecise. */
2359 const UV nv_as_uv = U_V(nv);
2361 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2372 #endif /* NV_PRESERVES_UV */
2375 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2377 if (SvTYPE(sv) < SVt_NV)
2378 /* Typically the caller expects that sv_any is not NULL now. */
2379 /* XXX Ilya implies that this is a bug in callers that assume this
2380 and ideally should be fixed. */
2381 sv_upgrade(sv, SVt_NV);
2384 #if defined(USE_LONG_DOUBLE)
2386 STORE_NUMERIC_LOCAL_SET_STANDARD();
2387 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2388 PTR2UV(sv), SvNVX(sv));
2389 RESTORE_NUMERIC_LOCAL();
2393 STORE_NUMERIC_LOCAL_SET_STANDARD();
2394 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2395 PTR2UV(sv), SvNVX(sv));
2396 RESTORE_NUMERIC_LOCAL();
2402 /* asIV(): extract an integer from the string value of an SV.
2403 * Caller must validate PVX */
2406 S_asIV(pTHX_ SV *sv)
2409 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2411 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2412 == IS_NUMBER_IN_UV) {
2413 /* It's definitely an integer */
2414 if (numtype & IS_NUMBER_NEG) {
2415 if (value < (UV)IV_MIN)
2418 if (value < (UV)IV_MAX)
2423 if (ckWARN(WARN_NUMERIC))
2426 return I_V(Atof(SvPVX_const(sv)));
2429 /* asUV(): extract an unsigned integer from the string value of an SV
2430 * Caller must validate PVX */
2433 S_asUV(pTHX_ SV *sv)
2436 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2438 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2439 == IS_NUMBER_IN_UV) {
2440 /* It's definitely an integer */
2441 if (!(numtype & IS_NUMBER_NEG))
2445 if (ckWARN(WARN_NUMERIC))
2448 return U_V(Atof(SvPVX_const(sv)));
2451 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2452 * UV as a string towards the end of buf, and return pointers to start and
2455 * We assume that buf is at least TYPE_CHARS(UV) long.
2459 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2461 char *ptr = buf + TYPE_CHARS(UV);
2462 char * const ebuf = ptr;
2475 *--ptr = '0' + (char)(uv % 10);
2484 =for apidoc sv_2pv_flags
2486 Returns a pointer to the string value of an SV, and sets *lp to its length.
2487 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2489 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2490 usually end up here too.
2496 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2506 if (SvGMAGICAL(sv)) {
2507 if (flags & SV_GMAGIC)
2512 if (flags & SV_MUTABLE_RETURN)
2513 return SvPVX_mutable(sv);
2514 if (flags & SV_CONST_RETURN)
2515 return (char *)SvPVX_const(sv);
2518 if (SvIOKp(sv) || SvNOKp(sv)) {
2519 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2523 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2524 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2526 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2529 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2530 /* Sneaky stuff here */
2531 SV *tsv = newSVpvn(tbuf, len);
2541 #ifdef FIXNEGATIVEZERO
2542 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2548 SvUPGRADE(sv, SVt_PV);
2551 s = SvGROW_mutable(sv, len + 1);
2554 return memcpy(s, tbuf, len + 1);
2558 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2559 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2567 if (SvTHINKFIRST(sv)) {
2571 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2572 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2574 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2577 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2578 if (flags & SV_CONST_RETURN) {
2579 pv = (char *) SvPVX_const(tmpstr);
2581 pv = (flags & SV_MUTABLE_RETURN)
2582 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2585 *lp = SvCUR(tmpstr);
2587 pv = sv_2pv_flags(tmpstr, lp, flags);
2597 const SV *const referent = (SV*)SvRV(sv);
2600 tsv = sv_2mortal(newSVpvn("NULLREF", 7));
2601 } else if (SvTYPE(referent) == SVt_PVMG
2602 && ((SvFLAGS(referent) &
2603 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2604 == (SVs_OBJECT|SVs_SMG))
2605 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2606 const regexp *re = (regexp *)mg->mg_obj;
2609 const char *fptr = "msix";
2614 char need_newline = 0;
2616 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2618 while((ch = *fptr++)) {
2620 reflags[left++] = ch;
2623 reflags[right--] = ch;
2628 reflags[left] = '-';
2632 mg->mg_len = re->prelen + 4 + left;
2634 * If /x was used, we have to worry about a regex
2635 * ending with a comment later being embedded
2636 * within another regex. If so, we don't want this
2637 * regex's "commentization" to leak out to the
2638 * right part of the enclosing regex, we must cap
2639 * it with a newline.
2641 * So, if /x was used, we scan backwards from the
2642 * end of the regex. If we find a '#' before we
2643 * find a newline, we need to add a newline
2644 * ourself. If we find a '\n' first (or if we
2645 * don't find '#' or '\n'), we don't need to add
2646 * anything. -jfriedl
2648 if (PMf_EXTENDED & re->reganch) {
2649 const char *endptr = re->precomp + re->prelen;
2650 while (endptr >= re->precomp) {
2651 const char c = *(endptr--);
2653 break; /* don't need another */
2655 /* we end while in a comment, so we
2657 mg->mg_len++; /* save space for it */
2658 need_newline = 1; /* note to add it */
2664 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2665 mg->mg_ptr[0] = '(';
2666 mg->mg_ptr[1] = '?';
2667 Copy(reflags, mg->mg_ptr+2, left, char);
2668 *(mg->mg_ptr+left+2) = ':';
2669 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2671 mg->mg_ptr[mg->mg_len - 2] = '\n';
2672 mg->mg_ptr[mg->mg_len - 1] = ')';
2673 mg->mg_ptr[mg->mg_len] = 0;
2675 PL_reginterp_cnt += re->program[0].next_off;
2677 if (re->reganch & ROPT_UTF8)
2685 const char *const typestr = sv_reftype(referent, 0);
2687 tsv = sv_newmortal();
2688 if (SvOBJECT(referent)) {
2689 const char *const name = HvNAME_get(SvSTASH(referent));
2690 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2691 name ? name : "__ANON__" , typestr,
2695 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2703 if (SvREADONLY(sv) && !SvOK(sv)) {
2704 if (ckWARN(WARN_UNINITIALIZED))
2711 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2712 /* I'm assuming that if both IV and NV are equally valid then
2713 converting the IV is going to be more efficient */
2714 const U32 isIOK = SvIOK(sv);
2715 const U32 isUIOK = SvIsUV(sv);
2716 char buf[TYPE_CHARS(UV)];
2719 if (SvTYPE(sv) < SVt_PVIV)
2720 sv_upgrade(sv, SVt_PVIV);
2722 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2724 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2725 /* inlined from sv_setpvn */
2726 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2727 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2728 SvCUR_set(sv, ebuf - ptr);
2738 else if (SvNOKp(sv)) {
2739 if (SvTYPE(sv) < SVt_PVNV)
2740 sv_upgrade(sv, SVt_PVNV);
2741 /* The +20 is pure guesswork. Configure test needed. --jhi */
2742 s = SvGROW_mutable(sv, NV_DIG + 20);
2743 olderrno = errno; /* some Xenix systems wipe out errno here */
2745 if (SvNVX(sv) == 0.0)
2746 (void)strcpy(s,"0");
2750 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2753 #ifdef FIXNEGATIVEZERO
2754 if (*s == '-' && s[1] == '0' && !s[2])
2764 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2768 if (SvTYPE(sv) < SVt_PV)
2769 /* Typically the caller expects that sv_any is not NULL now. */
2770 sv_upgrade(sv, SVt_PV);
2774 const STRLEN len = s - SvPVX_const(sv);
2780 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2781 PTR2UV(sv),SvPVX_const(sv)));
2782 if (flags & SV_CONST_RETURN)
2783 return (char *)SvPVX_const(sv);
2784 if (flags & SV_MUTABLE_RETURN)
2785 return SvPVX_mutable(sv);
2790 =for apidoc sv_copypv
2792 Copies a stringified representation of the source SV into the
2793 destination SV. Automatically performs any necessary mg_get and
2794 coercion of numeric values into strings. Guaranteed to preserve
2795 UTF-8 flag even from overloaded objects. Similar in nature to
2796 sv_2pv[_flags] but operates directly on an SV instead of just the
2797 string. Mostly uses sv_2pv_flags to do its work, except when that
2798 would lose the UTF-8'ness of the PV.
2804 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2807 const char * const s = SvPV_const(ssv,len);
2808 sv_setpvn(dsv,s,len);
2816 =for apidoc sv_2pvbyte
2818 Return a pointer to the byte-encoded representation of the SV, and set *lp
2819 to its length. May cause the SV to be downgraded from UTF-8 as a
2822 Usually accessed via the C<SvPVbyte> macro.
2828 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2830 sv_utf8_downgrade(sv,0);
2831 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2835 =for apidoc sv_2pvutf8
2837 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2838 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2840 Usually accessed via the C<SvPVutf8> macro.
2846 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2848 sv_utf8_upgrade(sv);
2849 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2854 =for apidoc sv_2bool
2856 This function is only called on magical items, and is only used by
2857 sv_true() or its macro equivalent.
2863 Perl_sv_2bool(pTHX_ register SV *sv)
2871 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2872 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2873 return (bool)SvTRUE(tmpsv);
2874 return SvRV(sv) != 0;
2877 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2879 (*sv->sv_u.svu_pv > '0' ||
2880 Xpvtmp->xpv_cur > 1 ||
2881 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2888 return SvIVX(sv) != 0;
2891 return SvNVX(sv) != 0.0;
2899 =for apidoc sv_utf8_upgrade
2901 Converts the PV of an SV to its UTF-8-encoded form.
2902 Forces the SV to string form if it is not already.
2903 Always sets the SvUTF8 flag to avoid future validity checks even
2904 if all the bytes have hibit clear.
2906 This is not as a general purpose byte encoding to Unicode interface:
2907 use the Encode extension for that.
2909 =for apidoc sv_utf8_upgrade_flags
2911 Converts the PV of an SV to its UTF-8-encoded form.
2912 Forces the SV to string form if it is not already.
2913 Always sets the SvUTF8 flag to avoid future validity checks even
2914 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2915 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2916 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2918 This is not as a general purpose byte encoding to Unicode interface:
2919 use the Encode extension for that.
2925 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2927 if (sv == &PL_sv_undef)
2931 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2932 (void) sv_2pv_flags(sv,&len, flags);
2936 (void) SvPV_force(sv,len);
2945 sv_force_normal_flags(sv, 0);
2948 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2949 sv_recode_to_utf8(sv, PL_encoding);
2950 else { /* Assume Latin-1/EBCDIC */
2951 /* This function could be much more efficient if we
2952 * had a FLAG in SVs to signal if there are any hibit
2953 * chars in the PV. Given that there isn't such a flag
2954 * make the loop as fast as possible. */
2955 const U8 *s = (U8 *) SvPVX_const(sv);
2956 const U8 * const e = (U8 *) SvEND(sv);
2962 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2966 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2967 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2969 SvPV_free(sv); /* No longer using what was there before. */
2971 SvPV_set(sv, (char*)recoded);
2972 SvCUR_set(sv, len - 1);
2973 SvLEN_set(sv, len); /* No longer know the real size. */
2975 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2982 =for apidoc sv_utf8_downgrade
2984 Attempts to convert the PV of an SV from characters to bytes.
2985 If the PV contains a character beyond byte, this conversion will fail;
2986 in this case, either returns false or, if C<fail_ok> is not
2989 This is not as a general purpose Unicode to byte encoding interface:
2990 use the Encode extension for that.
2996 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2998 if (SvPOKp(sv) && SvUTF8(sv)) {
3004 sv_force_normal_flags(sv, 0);
3006 s = (U8 *) SvPV(sv, len);
3007 if (!utf8_to_bytes(s, &len)) {
3012 Perl_croak(aTHX_ "Wide character in %s",
3015 Perl_croak(aTHX_ "Wide character");
3026 =for apidoc sv_utf8_encode
3028 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3029 flag off so that it looks like octets again.
3035 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3037 (void) sv_utf8_upgrade(sv);
3039 sv_force_normal_flags(sv, 0);
3041 if (SvREADONLY(sv)) {
3042 Perl_croak(aTHX_ PL_no_modify);
3048 =for apidoc sv_utf8_decode
3050 If the PV of the SV is an octet sequence in UTF-8
3051 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3052 so that it looks like a character. If the PV contains only single-byte
3053 characters, the C<SvUTF8> flag stays being off.
3054 Scans PV for validity and returns false if the PV is invalid UTF-8.
3060 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3066 /* The octets may have got themselves encoded - get them back as
3069 if (!sv_utf8_downgrade(sv, TRUE))
3072 /* it is actually just a matter of turning the utf8 flag on, but
3073 * we want to make sure everything inside is valid utf8 first.
3075 c = (const U8 *) SvPVX_const(sv);
3076 if (!is_utf8_string(c, SvCUR(sv)+1))
3078 e = (const U8 *) SvEND(sv);
3081 if (!UTF8_IS_INVARIANT(ch)) {
3091 =for apidoc sv_setsv
3093 Copies the contents of the source SV C<ssv> into the destination SV
3094 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3095 function if the source SV needs to be reused. Does not handle 'set' magic.
3096 Loosely speaking, it performs a copy-by-value, obliterating any previous
3097 content of the destination.
3099 You probably want to use one of the assortment of wrappers, such as
3100 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3101 C<SvSetMagicSV_nosteal>.
3103 =for apidoc sv_setsv_flags
3105 Copies the contents of the source SV C<ssv> into the destination SV
3106 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3107 function if the source SV needs to be reused. Does not handle 'set' magic.
3108 Loosely speaking, it performs a copy-by-value, obliterating any previous
3109 content of the destination.
3110 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3111 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3112 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3113 and C<sv_setsv_nomg> are implemented in terms of this function.
3115 You probably want to use one of the assortment of wrappers, such as
3116 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3117 C<SvSetMagicSV_nosteal>.
3119 This is the primary function for copying scalars, and most other
3120 copy-ish functions and macros use this underneath.
3126 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3128 register U32 sflags;
3134 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3136 sstr = &PL_sv_undef;
3137 stype = SvTYPE(sstr);
3138 dtype = SvTYPE(dstr);
3143 /* need to nuke the magic */
3145 SvRMAGICAL_off(dstr);
3148 /* There's a lot of redundancy below but we're going for speed here */
3153 if (dtype != SVt_PVGV) {
3154 (void)SvOK_off(dstr);
3162 sv_upgrade(dstr, SVt_IV);
3165 sv_upgrade(dstr, SVt_PVNV);
3169 sv_upgrade(dstr, SVt_PVIV);
3172 (void)SvIOK_only(dstr);
3173 SvIV_set(dstr, SvIVX(sstr));
3176 if (SvTAINTED(sstr))
3187 sv_upgrade(dstr, SVt_NV);
3192 sv_upgrade(dstr, SVt_PVNV);
3195 SvNV_set(dstr, SvNVX(sstr));
3196 (void)SvNOK_only(dstr);
3197 if (SvTAINTED(sstr))
3205 sv_upgrade(dstr, SVt_RV);
3206 else if (dtype == SVt_PVGV &&
3207 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3210 if (GvIMPORTED(dstr) != GVf_IMPORTED
3211 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3213 GvIMPORTED_on(dstr);
3222 #ifdef PERL_OLD_COPY_ON_WRITE
3223 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3224 if (dtype < SVt_PVIV)
3225 sv_upgrade(dstr, SVt_PVIV);
3232 sv_upgrade(dstr, SVt_PV);
3235 if (dtype < SVt_PVIV)
3236 sv_upgrade(dstr, SVt_PVIV);
3239 if (dtype < SVt_PVNV)
3240 sv_upgrade(dstr, SVt_PVNV);
3247 const char * const type = sv_reftype(sstr,0);
3249 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3251 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3256 if (dtype <= SVt_PVGV) {
3258 if (dtype != SVt_PVGV) {
3259 const char * const name = GvNAME(sstr);
3260 const STRLEN len = GvNAMELEN(sstr);
3261 /* don't upgrade SVt_PVLV: it can hold a glob */
3262 if (dtype != SVt_PVLV)
3263 sv_upgrade(dstr, SVt_PVGV);
3264 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3265 GvSTASH(dstr) = GvSTASH(sstr);
3267 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3268 GvNAME(dstr) = savepvn(name, len);
3269 GvNAMELEN(dstr) = len;
3270 SvFAKE_on(dstr); /* can coerce to non-glob */
3273 #ifdef GV_UNIQUE_CHECK
3274 if (GvUNIQUE((GV*)dstr)) {
3275 Perl_croak(aTHX_ PL_no_modify);
3279 (void)SvOK_off(dstr);
3280 GvINTRO_off(dstr); /* one-shot flag */
3282 GvGP(dstr) = gp_ref(GvGP(sstr));
3283 if (SvTAINTED(sstr))
3285 if (GvIMPORTED(dstr) != GVf_IMPORTED
3286 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3288 GvIMPORTED_on(dstr);
3296 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3298 if ((int)SvTYPE(sstr) != stype) {
3299 stype = SvTYPE(sstr);
3300 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3304 if (stype == SVt_PVLV)
3305 SvUPGRADE(dstr, SVt_PVNV);
3307 SvUPGRADE(dstr, (U32)stype);
3310 sflags = SvFLAGS(sstr);
3312 if (sflags & SVf_ROK) {
3313 if (dtype >= SVt_PV) {
3314 if (dtype == SVt_PVGV) {
3315 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3317 const int intro = GvINTRO(dstr);
3319 #ifdef GV_UNIQUE_CHECK
3320 if (GvUNIQUE((GV*)dstr)) {
3321 Perl_croak(aTHX_ PL_no_modify);
3326 GvINTRO_off(dstr); /* one-shot flag */
3327 GvLINE(dstr) = CopLINE(PL_curcop);
3328 GvEGV(dstr) = (GV*)dstr;
3331 switch (SvTYPE(sref)) {
3334 SAVEGENERICSV(GvAV(dstr));
3336 dref = (SV*)GvAV(dstr);
3337 GvAV(dstr) = (AV*)sref;
3338 if (!GvIMPORTED_AV(dstr)
3339 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3341 GvIMPORTED_AV_on(dstr);
3346 SAVEGENERICSV(GvHV(dstr));
3348 dref = (SV*)GvHV(dstr);
3349 GvHV(dstr) = (HV*)sref;
3350 if (!GvIMPORTED_HV(dstr)
3351 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3353 GvIMPORTED_HV_on(dstr);
3358 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3359 SvREFCNT_dec(GvCV(dstr));
3360 GvCV(dstr) = Nullcv;
3361 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3362 PL_sub_generation++;
3364 SAVEGENERICSV(GvCV(dstr));
3367 dref = (SV*)GvCV(dstr);
3368 if (GvCV(dstr) != (CV*)sref) {
3369 CV* const cv = GvCV(dstr);
3371 if (!GvCVGEN((GV*)dstr) &&
3372 (CvROOT(cv) || CvXSUB(cv)))
3374 /* Redefining a sub - warning is mandatory if
3375 it was a const and its value changed. */
3376 if (ckWARN(WARN_REDEFINE)
3378 && (!CvCONST((CV*)sref)
3379 || sv_cmp(cv_const_sv(cv),
3380 cv_const_sv((CV*)sref)))))
3382 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3384 ? "Constant subroutine %s::%s redefined"
3385 : "Subroutine %s::%s redefined",
3386 HvNAME_get(GvSTASH((GV*)dstr)),
3387 GvENAME((GV*)dstr));
3391 cv_ckproto(cv, (GV*)dstr,
3393 ? SvPVX_const(sref) : Nullch);
3395 GvCV(dstr) = (CV*)sref;
3396 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3397 GvASSUMECV_on(dstr);
3398 PL_sub_generation++;
3400 if (!GvIMPORTED_CV(dstr)
3401 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3403 GvIMPORTED_CV_on(dstr);
3408 SAVEGENERICSV(GvIOp(dstr));
3410 dref = (SV*)GvIOp(dstr);
3411 GvIOp(dstr) = (IO*)sref;
3415 SAVEGENERICSV(GvFORM(dstr));
3417 dref = (SV*)GvFORM(dstr);
3418 GvFORM(dstr) = (CV*)sref;
3422 SAVEGENERICSV(GvSV(dstr));
3424 dref = (SV*)GvSV(dstr);
3426 if (!GvIMPORTED_SV(dstr)
3427 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3429 GvIMPORTED_SV_on(dstr);
3435 if (SvTAINTED(sstr))
3439 if (SvPVX_const(dstr)) {
3445 (void)SvOK_off(dstr);
3446 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3448 if (sflags & SVp_NOK) {
3450 /* Only set the public OK flag if the source has public OK. */
3451 if (sflags & SVf_NOK)
3452 SvFLAGS(dstr) |= SVf_NOK;
3453 SvNV_set(dstr, SvNVX(sstr));
3455 if (sflags & SVp_IOK) {
3456 (void)SvIOKp_on(dstr);
3457 if (sflags & SVf_IOK)
3458 SvFLAGS(dstr) |= SVf_IOK;
3459 if (sflags & SVf_IVisUV)
3461 SvIV_set(dstr, SvIVX(sstr));
3463 if (SvAMAGIC(sstr)) {
3467 else if (sflags & SVp_POK) {
3471 * Check to see if we can just swipe the string. If so, it's a
3472 * possible small lose on short strings, but a big win on long ones.
3473 * It might even be a win on short strings if SvPVX_const(dstr)
3474 * has to be allocated and SvPVX_const(sstr) has to be freed.
3477 /* Whichever path we take through the next code, we want this true,
3478 and doing it now facilitates the COW check. */
3479 (void)SvPOK_only(dstr);
3482 /* We're not already COW */
3483 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3484 #ifndef PERL_OLD_COPY_ON_WRITE
3485 /* or we are, but dstr isn't a suitable target. */
3486 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3491 (sflags & SVs_TEMP) && /* slated for free anyway? */
3492 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3493 (!(flags & SV_NOSTEAL)) &&
3494 /* and we're allowed to steal temps */
3495 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3496 SvLEN(sstr) && /* and really is a string */
3497 /* and won't be needed again, potentially */
3498 !(PL_op && PL_op->op_type == OP_AASSIGN))
3499 #ifdef PERL_OLD_COPY_ON_WRITE
3500 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3501 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3502 && SvTYPE(sstr) >= SVt_PVIV)
3505 /* Failed the swipe test, and it's not a shared hash key either.
3506 Have to copy the string. */
3507 STRLEN len = SvCUR(sstr);
3508 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3509 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3510 SvCUR_set(dstr, len);
3511 *SvEND(dstr) = '\0';
3513 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3515 /* Either it's a shared hash key, or it's suitable for
3516 copy-on-write or we can swipe the string. */
3518 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3522 #ifdef PERL_OLD_COPY_ON_WRITE
3524 /* I believe I should acquire a global SV mutex if
3525 it's a COW sv (not a shared hash key) to stop
3526 it going un copy-on-write.
3527 If the source SV has gone un copy on write between up there
3528 and down here, then (assert() that) it is of the correct
3529 form to make it copy on write again */
3530 if ((sflags & (SVf_FAKE | SVf_READONLY))
3531 != (SVf_FAKE | SVf_READONLY)) {
3532 SvREADONLY_on(sstr);
3534 /* Make the source SV into a loop of 1.
3535 (about to become 2) */
3536 SV_COW_NEXT_SV_SET(sstr, sstr);
3540 /* Initial code is common. */
3541 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3546 /* making another shared SV. */
3547 STRLEN cur = SvCUR(sstr);
3548 STRLEN len = SvLEN(sstr);
3549 #ifdef PERL_OLD_COPY_ON_WRITE
3551 assert (SvTYPE(dstr) >= SVt_PVIV);
3552 /* SvIsCOW_normal */
3553 /* splice us in between source and next-after-source. */
3554 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3555 SV_COW_NEXT_SV_SET(sstr, dstr);
3556 SvPV_set(dstr, SvPVX_mutable(sstr));
3560 /* SvIsCOW_shared_hash */
3561 DEBUG_C(PerlIO_printf(Perl_debug_log,
3562 "Copy on write: Sharing hash\n"));
3564 assert (SvTYPE(dstr) >= SVt_PV);
3566 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3568 SvLEN_set(dstr, len);
3569 SvCUR_set(dstr, cur);
3570 SvREADONLY_on(dstr);
3572 /* Relesase a global SV mutex. */
3575 { /* Passes the swipe test. */
3576 SvPV_set(dstr, SvPVX_mutable(sstr));
3577 SvLEN_set(dstr, SvLEN(sstr));
3578 SvCUR_set(dstr, SvCUR(sstr));
3581 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3582 SvPV_set(sstr, Nullch);
3588 if (sflags & SVf_UTF8)
3590 if (sflags & SVp_NOK) {
3592 if (sflags & SVf_NOK)
3593 SvFLAGS(dstr) |= SVf_NOK;
3594 SvNV_set(dstr, SvNVX(sstr));
3596 if (sflags & SVp_IOK) {
3597 (void)SvIOKp_on(dstr);
3598 if (sflags & SVf_IOK)
3599 SvFLAGS(dstr) |= SVf_IOK;
3600 if (sflags & SVf_IVisUV)
3602 SvIV_set(dstr, SvIVX(sstr));
3605 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3606 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3607 smg->mg_ptr, smg->mg_len);
3608 SvRMAGICAL_on(dstr);
3611 else if (sflags & SVp_IOK) {
3612 if (sflags & SVf_IOK)
3613 (void)SvIOK_only(dstr);
3615 (void)SvOK_off(dstr);
3616 (void)SvIOKp_on(dstr);
3618 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3619 if (sflags & SVf_IVisUV)
3621 SvIV_set(dstr, SvIVX(sstr));
3622 if (sflags & SVp_NOK) {
3623 if (sflags & SVf_NOK)
3624 (void)SvNOK_on(dstr);
3626 (void)SvNOKp_on(dstr);
3627 SvNV_set(dstr, SvNVX(sstr));
3630 else if (sflags & SVp_NOK) {
3631 if (sflags & SVf_NOK)
3632 (void)SvNOK_only(dstr);
3634 (void)SvOK_off(dstr);
3637 SvNV_set(dstr, SvNVX(sstr));
3640 if (dtype == SVt_PVGV) {
3641 if (ckWARN(WARN_MISC))
3642 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3645 (void)SvOK_off(dstr);
3647 if (SvTAINTED(sstr))
3652 =for apidoc sv_setsv_mg
3654 Like C<sv_setsv>, but also handles 'set' magic.
3660 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3662 sv_setsv(dstr,sstr);
3666 #ifdef PERL_OLD_COPY_ON_WRITE
3668 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3670 STRLEN cur = SvCUR(sstr);
3671 STRLEN len = SvLEN(sstr);
3672 register char *new_pv;
3675 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3683 if (SvTHINKFIRST(dstr))
3684 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3685 else if (SvPVX_const(dstr))
3686 Safefree(SvPVX_const(dstr));
3690 SvUPGRADE(dstr, SVt_PVIV);
3692 assert (SvPOK(sstr));
3693 assert (SvPOKp(sstr));
3694 assert (!SvIOK(sstr));
3695 assert (!SvIOKp(sstr));
3696 assert (!SvNOK(sstr));
3697 assert (!SvNOKp(sstr));
3699 if (SvIsCOW(sstr)) {
3701 if (SvLEN(sstr) == 0) {
3702 /* source is a COW shared hash key. */
3703 DEBUG_C(PerlIO_printf(Perl_debug_log,
3704 "Fast copy on write: Sharing hash\n"));
3705 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3708 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3710 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3711 SvUPGRADE(sstr, SVt_PVIV);
3712 SvREADONLY_on(sstr);
3714 DEBUG_C(PerlIO_printf(Perl_debug_log,
3715 "Fast copy on write: Converting sstr to COW\n"));
3716 SV_COW_NEXT_SV_SET(dstr, sstr);
3718 SV_COW_NEXT_SV_SET(sstr, dstr);
3719 new_pv = SvPVX_mutable(sstr);
3722 SvPV_set(dstr, new_pv);
3723 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3726 SvLEN_set(dstr, len);
3727 SvCUR_set(dstr, cur);
3736 =for apidoc sv_setpvn
3738 Copies a string into an SV. The C<len> parameter indicates the number of
3739 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3740 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3746 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3748 register char *dptr;
3750 SV_CHECK_THINKFIRST_COW_DROP(sv);
3756 /* len is STRLEN which is unsigned, need to copy to signed */
3759 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3761 SvUPGRADE(sv, SVt_PV);
3763 dptr = SvGROW(sv, len + 1);
3764 Move(ptr,dptr,len,char);
3767 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3772 =for apidoc sv_setpvn_mg
3774 Like C<sv_setpvn>, but also handles 'set' magic.
3780 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3782 sv_setpvn(sv,ptr,len);
3787 =for apidoc sv_setpv
3789 Copies a string into an SV. The string must be null-terminated. Does not
3790 handle 'set' magic. See C<sv_setpv_mg>.
3796 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3798 register STRLEN len;
3800 SV_CHECK_THINKFIRST_COW_DROP(sv);
3806 SvUPGRADE(sv, SVt_PV);
3808 SvGROW(sv, len + 1);
3809 Move(ptr,SvPVX(sv),len+1,char);
3811 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3816 =for apidoc sv_setpv_mg
3818 Like C<sv_setpv>, but also handles 'set' magic.
3824 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3831 =for apidoc sv_usepvn
3833 Tells an SV to use C<ptr> to find its string value. Normally the string is
3834 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3835 The C<ptr> should point to memory that was allocated by C<malloc>. The
3836 string length, C<len>, must be supplied. This function will realloc the
3837 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3838 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3839 See C<sv_usepvn_mg>.
3845 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3848 SV_CHECK_THINKFIRST_COW_DROP(sv);
3849 SvUPGRADE(sv, SVt_PV);
3854 if (SvPVX_const(sv))
3857 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3858 ptr = saferealloc (ptr, allocate);
3861 SvLEN_set(sv, allocate);
3863 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3868 =for apidoc sv_usepvn_mg
3870 Like C<sv_usepvn>, but also handles 'set' magic.
3876 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3878 sv_usepvn(sv,ptr,len);
3882 #ifdef PERL_OLD_COPY_ON_WRITE
3883 /* Need to do this *after* making the SV normal, as we need the buffer
3884 pointer to remain valid until after we've copied it. If we let go too early,
3885 another thread could invalidate it by unsharing last of the same hash key
3886 (which it can do by means other than releasing copy-on-write Svs)
3887 or by changing the other copy-on-write SVs in the loop. */
3889 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3891 if (len) { /* this SV was SvIsCOW_normal(sv) */
3892 /* we need to find the SV pointing to us. */
3893 SV * const current = SV_COW_NEXT_SV(after);
3895 if (current == sv) {
3896 /* The SV we point to points back to us (there were only two of us
3898 Hence other SV is no longer copy on write either. */
3900 SvREADONLY_off(after);
3902 /* We need to follow the pointers around the loop. */
3904 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3907 /* don't loop forever if the structure is bust, and we have
3908 a pointer into a closed loop. */
3909 assert (current != after);
3910 assert (SvPVX_const(current) == pvx);
3912 /* Make the SV before us point to the SV after us. */
3913 SV_COW_NEXT_SV_SET(current, after);
3916 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3921 Perl_sv_release_IVX(pTHX_ register SV *sv)
3924 sv_force_normal_flags(sv, 0);
3930 =for apidoc sv_force_normal_flags
3932 Undo various types of fakery on an SV: if the PV is a shared string, make
3933 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3934 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3935 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3936 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3937 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3938 set to some other value.) In addition, the C<flags> parameter gets passed to
3939 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3940 with flags set to 0.
3946 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3948 #ifdef PERL_OLD_COPY_ON_WRITE
3949 if (SvREADONLY(sv)) {
3950 /* At this point I believe I should acquire a global SV mutex. */
3952 const char * const pvx = SvPVX_const(sv);
3953 const STRLEN len = SvLEN(sv);
3954 const STRLEN cur = SvCUR(sv);
3955 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3957 PerlIO_printf(Perl_debug_log,
3958 "Copy on write: Force normal %ld\n",
3964 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3965 SvPV_set(sv, (char*)0);
3967 if (flags & SV_COW_DROP_PV) {
3968 /* OK, so we don't need to copy our buffer. */
3971 SvGROW(sv, cur + 1);
3972 Move(pvx,SvPVX(sv),cur,char);
3976 sv_release_COW(sv, pvx, len, next);
3981 else if (IN_PERL_RUNTIME)
3982 Perl_croak(aTHX_ PL_no_modify);
3983 /* At this point I believe that I can drop the global SV mutex. */
3986 if (SvREADONLY(sv)) {
3988 const char * const pvx = SvPVX_const(sv);
3989 const STRLEN len = SvCUR(sv);
3992 SvPV_set(sv, Nullch);
3994 SvGROW(sv, len + 1);
3995 Move(pvx,SvPVX(sv),len,char);
3997 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3999 else if (IN_PERL_RUNTIME)
4000 Perl_croak(aTHX_ PL_no_modify);
4004 sv_unref_flags(sv, flags);
4005 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4012 Efficient removal of characters from the beginning of the string buffer.
4013 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4014 the string buffer. The C<ptr> becomes the first character of the adjusted
4015 string. Uses the "OOK hack".
4016 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4017 refer to the same chunk of data.
4023 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4025 register STRLEN delta;
4026 if (!ptr || !SvPOKp(sv))
4028 delta = ptr - SvPVX_const(sv);
4029 SV_CHECK_THINKFIRST(sv);
4030 if (SvTYPE(sv) < SVt_PVIV)
4031 sv_upgrade(sv,SVt_PVIV);
4034 if (!SvLEN(sv)) { /* make copy of shared string */
4035 const char *pvx = SvPVX_const(sv);
4036 const STRLEN len = SvCUR(sv);
4037 SvGROW(sv, len + 1);
4038 Move(pvx,SvPVX(sv),len,char);
4042 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4043 and we do that anyway inside the SvNIOK_off
4045 SvFLAGS(sv) |= SVf_OOK;
4048 SvLEN_set(sv, SvLEN(sv) - delta);
4049 SvCUR_set(sv, SvCUR(sv) - delta);
4050 SvPV_set(sv, SvPVX(sv) + delta);
4051 SvIV_set(sv, SvIVX(sv) + delta);
4055 =for apidoc sv_catpvn
4057 Concatenates the string onto the end of the string which is in the SV. The
4058 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4059 status set, then the bytes appended should be valid UTF-8.
4060 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4062 =for apidoc sv_catpvn_flags
4064 Concatenates the string onto the end of the string which is in the SV. The
4065 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4066 status set, then the bytes appended should be valid UTF-8.
4067 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4068 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4069 in terms of this function.
4075 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4078 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4080 SvGROW(dsv, dlen + slen + 1);
4082 sstr = SvPVX_const(dsv);
4083 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4084 SvCUR_set(dsv, SvCUR(dsv) + slen);
4086 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4088 if (flags & SV_SMAGIC)
4093 =for apidoc sv_catsv
4095 Concatenates the string from SV C<ssv> onto the end of the string in
4096 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4097 not 'set' magic. See C<sv_catsv_mg>.
4099 =for apidoc sv_catsv_flags
4101 Concatenates the string from SV C<ssv> onto the end of the string in
4102 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4103 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4104 and C<sv_catsv_nomg> are implemented in terms of this function.
4109 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4114 if ((spv = SvPV_const(ssv, slen))) {
4115 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4116 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4117 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4118 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4119 dsv->sv_flags doesn't have that bit set.
4120 Andy Dougherty 12 Oct 2001
4122 const I32 sutf8 = DO_UTF8(ssv);
4125 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4127 dutf8 = DO_UTF8(dsv);
4129 if (dutf8 != sutf8) {
4131 /* Not modifying source SV, so taking a temporary copy. */
4132 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4134 sv_utf8_upgrade(csv);
4135 spv = SvPV_const(csv, slen);
4138 sv_utf8_upgrade_nomg(dsv);
4140 sv_catpvn_nomg(dsv, spv, slen);
4143 if (flags & SV_SMAGIC)
4148 =for apidoc sv_catpv
4150 Concatenates the string onto the end of the string which is in the SV.
4151 If the SV has the UTF-8 status set, then the bytes appended should be
4152 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4157 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4159 register STRLEN len;
4165 junk = SvPV_force(sv, tlen);
4167 SvGROW(sv, tlen + len + 1);
4169 ptr = SvPVX_const(sv);
4170 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4171 SvCUR_set(sv, SvCUR(sv) + len);
4172 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4177 =for apidoc sv_catpv_mg
4179 Like C<sv_catpv>, but also handles 'set' magic.
4185 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4194 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4195 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4202 Perl_newSV(pTHX_ STRLEN len)
4208 sv_upgrade(sv, SVt_PV);
4209 SvGROW(sv, len + 1);
4214 =for apidoc sv_magicext
4216 Adds magic to an SV, upgrading it if necessary. Applies the
4217 supplied vtable and returns a pointer to the magic added.
4219 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4220 In particular, you can add magic to SvREADONLY SVs, and add more than
4221 one instance of the same 'how'.
4223 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4224 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4225 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4226 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4228 (This is now used as a subroutine by C<sv_magic>.)
4233 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4234 const char* name, I32 namlen)
4238 if (SvTYPE(sv) < SVt_PVMG) {
4239 SvUPGRADE(sv, SVt_PVMG);
4241 Newxz(mg, 1, MAGIC);
4242 mg->mg_moremagic = SvMAGIC(sv);
4243 SvMAGIC_set(sv, mg);
4245 /* Sometimes a magic contains a reference loop, where the sv and
4246 object refer to each other. To prevent a reference loop that
4247 would prevent such objects being freed, we look for such loops
4248 and if we find one we avoid incrementing the object refcount.
4250 Note we cannot do this to avoid self-tie loops as intervening RV must
4251 have its REFCNT incremented to keep it in existence.
4254 if (!obj || obj == sv ||
4255 how == PERL_MAGIC_arylen ||
4256 how == PERL_MAGIC_qr ||
4257 how == PERL_MAGIC_symtab ||
4258 (SvTYPE(obj) == SVt_PVGV &&
4259 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4260 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4261 GvFORM(obj) == (CV*)sv)))
4266 mg->mg_obj = SvREFCNT_inc(obj);
4267 mg->mg_flags |= MGf_REFCOUNTED;
4270 /* Normal self-ties simply pass a null object, and instead of
4271 using mg_obj directly, use the SvTIED_obj macro to produce a
4272 new RV as needed. For glob "self-ties", we are tieing the PVIO
4273 with an RV obj pointing to the glob containing the PVIO. In
4274 this case, to avoid a reference loop, we need to weaken the
4278 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4279 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4285 mg->mg_len = namlen;
4288 mg->mg_ptr = savepvn(name, namlen);
4289 else if (namlen == HEf_SVKEY)
4290 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4292 mg->mg_ptr = (char *) name;
4294 mg->mg_virtual = vtable;
4298 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4303 =for apidoc sv_magic
4305 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4306 then adds a new magic item of type C<how> to the head of the magic list.
4308 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4309 handling of the C<name> and C<namlen> arguments.
4311 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4312 to add more than one instance of the same 'how'.
4318 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4320 const MGVTBL *vtable;
4323 #ifdef PERL_OLD_COPY_ON_WRITE
4325 sv_force_normal_flags(sv, 0);
4327 if (SvREADONLY(sv)) {
4329 /* its okay to attach magic to shared strings; the subsequent
4330 * upgrade to PVMG will unshare the string */
4331 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4334 && how != PERL_MAGIC_regex_global
4335 && how != PERL_MAGIC_bm
4336 && how != PERL_MAGIC_fm
4337 && how != PERL_MAGIC_sv
4338 && how != PERL_MAGIC_backref
4341 Perl_croak(aTHX_ PL_no_modify);
4344 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4345 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4346 /* sv_magic() refuses to add a magic of the same 'how' as an
4349 if (how == PERL_MAGIC_taint)
4357 vtable = &PL_vtbl_sv;
4359 case PERL_MAGIC_overload:
4360 vtable = &PL_vtbl_amagic;
4362 case PERL_MAGIC_overload_elem:
4363 vtable = &PL_vtbl_amagicelem;
4365 case PERL_MAGIC_overload_table:
4366 vtable = &PL_vtbl_ovrld;
4369 vtable = &PL_vtbl_bm;
4371 case PERL_MAGIC_regdata:
4372 vtable = &PL_vtbl_regdata;
4374 case PERL_MAGIC_regdatum:
4375 vtable = &PL_vtbl_regdatum;
4377 case PERL_MAGIC_env:
4378 vtable = &PL_vtbl_env;
4381 vtable = &PL_vtbl_fm;
4383 case PERL_MAGIC_envelem:
4384 vtable = &PL_vtbl_envelem;
4386 case PERL_MAGIC_regex_global:
4387 vtable = &PL_vtbl_mglob;
4389 case PERL_MAGIC_isa:
4390 vtable = &PL_vtbl_isa;
4392 case PERL_MAGIC_isaelem:
4393 vtable = &PL_vtbl_isaelem;
4395 case PERL_MAGIC_nkeys:
4396 vtable = &PL_vtbl_nkeys;
4398 case PERL_MAGIC_dbfile:
4401 case PERL_MAGIC_dbline:
4402 vtable = &PL_vtbl_dbline;
4404 #ifdef USE_LOCALE_COLLATE
4405 case PERL_MAGIC_collxfrm:
4406 vtable = &PL_vtbl_collxfrm;
4408 #endif /* USE_LOCALE_COLLATE */
4409 case PERL_MAGIC_tied:
4410 vtable = &PL_vtbl_pack;
4412 case PERL_MAGIC_tiedelem:
4413 case PERL_MAGIC_tiedscalar:
4414 vtable = &PL_vtbl_packelem;
4417 vtable = &PL_vtbl_regexp;
4419 case PERL_MAGIC_sig:
4420 vtable = &PL_vtbl_sig;
4422 case PERL_MAGIC_sigelem:
4423 vtable = &PL_vtbl_sigelem;
4425 case PERL_MAGIC_taint:
4426 vtable = &PL_vtbl_taint;
4428 case PERL_MAGIC_uvar:
4429 vtable = &PL_vtbl_uvar;
4431 case PERL_MAGIC_vec:
4432 vtable = &PL_vtbl_vec;
4434 case PERL_MAGIC_arylen_p:
4435 case PERL_MAGIC_rhash:
4436 case PERL_MAGIC_symtab:
4437 case PERL_MAGIC_vstring:
4440 case PERL_MAGIC_utf8:
4441 vtable = &PL_vtbl_utf8;
4443 case PERL_MAGIC_substr:
4444 vtable = &PL_vtbl_substr;
4446 case PERL_MAGIC_defelem:
4447 vtable = &PL_vtbl_defelem;
4449 case PERL_MAGIC_glob:
4450 vtable = &PL_vtbl_glob;
4452 case PERL_MAGIC_arylen:
4453 vtable = &PL_vtbl_arylen;
4455 case PERL_MAGIC_pos:
4456 vtable = &PL_vtbl_pos;
4458 case PERL_MAGIC_backref:
4459 vtable = &PL_vtbl_backref;
4461 case PERL_MAGIC_ext:
4462 /* Reserved for use by extensions not perl internals. */
4463 /* Useful for attaching extension internal data to perl vars. */
4464 /* Note that multiple extensions may clash if magical scalars */
4465 /* etc holding private data from one are passed to another. */
4469 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4472 /* Rest of work is done else where */
4473 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4476 case PERL_MAGIC_taint:
4479 case PERL_MAGIC_ext:
4480 case PERL_MAGIC_dbfile:
4487 =for apidoc sv_unmagic
4489 Removes all magic of type C<type> from an SV.
4495 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4499 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4502 for (mg = *mgp; mg; mg = *mgp) {
4503 if (mg->mg_type == type) {
4504 const MGVTBL* const vtbl = mg->mg_virtual;
4505 *mgp = mg->mg_moremagic;
4506 if (vtbl && vtbl->svt_free)
4507 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4508 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4510 Safefree(mg->mg_ptr);
4511 else if (mg->mg_len == HEf_SVKEY)
4512 SvREFCNT_dec((SV*)mg->mg_ptr);
4513 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4514 Safefree(mg->mg_ptr);
4516 if (mg->mg_flags & MGf_REFCOUNTED)
4517 SvREFCNT_dec(mg->mg_obj);
4521 mgp = &mg->mg_moremagic;
4525 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4532 =for apidoc sv_rvweaken
4534 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4535 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4536 push a back-reference to this RV onto the array of backreferences
4537 associated with that magic.
4543 Perl_sv_rvweaken(pTHX_ SV *sv)
4546 if (!SvOK(sv)) /* let undefs pass */
4549 Perl_croak(aTHX_ "Can't weaken a nonreference");
4550 else if (SvWEAKREF(sv)) {
4551 if (ckWARN(WARN_MISC))
4552 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4556 Perl_sv_add_backref(aTHX_ tsv, sv);
4562 /* Give tsv backref magic if it hasn't already got it, then push a
4563 * back-reference to sv onto the array associated with the backref magic.
4567 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4571 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4572 av = (AV*)mg->mg_obj;
4575 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4576 /* av now has a refcnt of 2, which avoids it getting freed
4577 * before us during global cleanup. The extra ref is removed
4578 * by magic_killbackrefs() when tsv is being freed */
4580 if (AvFILLp(av) >= AvMAX(av)) {
4581 av_extend(av, AvFILLp(av)+1);
4583 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4586 /* delete a back-reference to ourselves from the backref magic associated
4587 * with the SV we point to.
4591 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4597 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4598 if (PL_in_clean_all)
4601 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4602 Perl_croak(aTHX_ "panic: del_backref");
4603 av = (AV *)mg->mg_obj;
4605 /* We shouldn't be in here more than once, but for paranoia reasons lets
4607 for (i = AvFILLp(av); i >= 0; i--) {
4609 const SSize_t fill = AvFILLp(av);
4611 /* We weren't the last entry.
4612 An unordered list has this property that you can take the
4613 last element off the end to fill the hole, and it's still
4614 an unordered list :-)
4619 AvFILLp(av) = fill - 1;
4625 =for apidoc sv_insert
4627 Inserts a string at the specified offset/length within the SV. Similar to
4628 the Perl substr() function.
4634 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4638 register char *midend;
4639 register char *bigend;
4645 Perl_croak(aTHX_ "Can't modify non-existent substring");
4646 SvPV_force(bigstr, curlen);
4647 (void)SvPOK_only_UTF8(bigstr);
4648 if (offset + len > curlen) {
4649 SvGROW(bigstr, offset+len+1);
4650 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4651 SvCUR_set(bigstr, offset+len);
4655 i = littlelen - len;
4656 if (i > 0) { /* string might grow */
4657 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4658 mid = big + offset + len;
4659 midend = bigend = big + SvCUR(bigstr);
4662 while (midend > mid) /* shove everything down */
4663 *--bigend = *--midend;
4664 Move(little,big+offset,littlelen,char);
4665 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4670 Move(little,SvPVX(bigstr)+offset,len,char);
4675 big = SvPVX(bigstr);
4678 bigend = big + SvCUR(bigstr);
4680 if (midend > bigend)
4681 Perl_croak(aTHX_ "panic: sv_insert");
4683 if (mid - big > bigend - midend) { /* faster to shorten from end */
4685 Move(little, mid, littlelen,char);
4688 i = bigend - midend;
4690 Move(midend, mid, i,char);
4694 SvCUR_set(bigstr, mid - big);
4696 else if ((i = mid - big)) { /* faster from front */
4697 midend -= littlelen;
4699 sv_chop(bigstr,midend-i);
4704 Move(little, mid, littlelen,char);
4706 else if (littlelen) {
4707 midend -= littlelen;
4708 sv_chop(bigstr,midend);
4709 Move(little,midend,littlelen,char);
4712 sv_chop(bigstr,midend);
4718 =for apidoc sv_replace
4720 Make the first argument a copy of the second, then delete the original.
4721 The target SV physically takes over ownership of the body of the source SV
4722 and inherits its flags; however, the target keeps any magic it owns,
4723 and any magic in the source is discarded.
4724 Note that this is a rather specialist SV copying operation; most of the
4725 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4731 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4733 const U32 refcnt = SvREFCNT(sv);
4734 SV_CHECK_THINKFIRST_COW_DROP(sv);
4735 if (SvREFCNT(nsv) != 1) {
4736 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4737 UVuf " != 1)", (UV) SvREFCNT(nsv));
4739 if (SvMAGICAL(sv)) {
4743 sv_upgrade(nsv, SVt_PVMG);
4744 SvMAGIC_set(nsv, SvMAGIC(sv));
4745 SvFLAGS(nsv) |= SvMAGICAL(sv);
4747 SvMAGIC_set(sv, NULL);
4751 assert(!SvREFCNT(sv));
4752 #ifdef DEBUG_LEAKING_SCALARS
4753 sv->sv_flags = nsv->sv_flags;
4754 sv->sv_any = nsv->sv_any;
4755 sv->sv_refcnt = nsv->sv_refcnt;
4756 sv->sv_u = nsv->sv_u;
4758 StructCopy(nsv,sv,SV);
4760 /* Currently could join these into one piece of pointer arithmetic, but
4761 it would be unclear. */
4762 if(SvTYPE(sv) == SVt_IV)
4764 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4765 else if (SvTYPE(sv) == SVt_RV) {
4766 SvANY(sv) = &sv->sv_u.svu_rv;
4770 #ifdef PERL_OLD_COPY_ON_WRITE
4771 if (SvIsCOW_normal(nsv)) {
4772 /* We need to follow the pointers around the loop to make the
4773 previous SV point to sv, rather than nsv. */
4776 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4779 assert(SvPVX_const(current) == SvPVX_const(nsv));
4781 /* Make the SV before us point to the SV after us. */
4783 PerlIO_printf(Perl_debug_log, "previous is\n");
4785 PerlIO_printf(Perl_debug_log,
4786 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4787 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4789 SV_COW_NEXT_SV_SET(current, sv);
4792 SvREFCNT(sv) = refcnt;
4793 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4799 =for apidoc sv_clear
4801 Clear an SV: call any destructors, free up any memory used by the body,
4802 and free the body itself. The SV's head is I<not> freed, although
4803 its type is set to all 1's so that it won't inadvertently be assumed
4804 to be live during global destruction etc.
4805 This function should only be called when REFCNT is zero. Most of the time
4806 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4813 Perl_sv_clear(pTHX_ register SV *sv)
4816 const U32 type = SvTYPE(sv);
4817 const struct body_details *const sv_type_details
4818 = bodies_by_type + type;
4821 assert(SvREFCNT(sv) == 0);
4827 if (PL_defstash) { /* Still have a symbol table? */
4832 stash = SvSTASH(sv);
4833 destructor = StashHANDLER(stash,DESTROY);
4835 SV* const tmpref = newRV(sv);
4836 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4838 PUSHSTACKi(PERLSI_DESTROY);
4843 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4849 if(SvREFCNT(tmpref) < 2) {
4850 /* tmpref is not kept alive! */
4852 SvRV_set(tmpref, NULL);
4855 SvREFCNT_dec(tmpref);
4857 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4861 if (PL_in_clean_objs)
4862 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4864 /* DESTROY gave object new lease on life */
4870 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4871 SvOBJECT_off(sv); /* Curse the object. */
4872 if (type != SVt_PVIO)
4873 --PL_sv_objcount; /* XXX Might want something more general */
4876 if (type >= SVt_PVMG) {
4879 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4880 SvREFCNT_dec(SvSTASH(sv));
4885 IoIFP(sv) != PerlIO_stdin() &&
4886 IoIFP(sv) != PerlIO_stdout() &&
4887 IoIFP(sv) != PerlIO_stderr())
4889 io_close((IO*)sv, FALSE);
4891 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4892 PerlDir_close(IoDIRP(sv));
4893 IoDIRP(sv) = (DIR*)NULL;
4894 Safefree(IoTOP_NAME(sv));
4895 Safefree(IoFMT_NAME(sv));
4896 Safefree(IoBOTTOM_NAME(sv));
4911 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4912 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4913 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4914 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4916 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4917 SvREFCNT_dec(LvTARG(sv));
4921 Safefree(GvNAME(sv));
4922 /* If we're in a stash, we don't own a reference to it. However it does
4923 have a back reference to us, which needs to be cleared. */
4925 sv_del_backref((SV*)GvSTASH(sv), sv);
4930 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4932 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4933 /* Don't even bother with turning off the OOK flag. */
4938 SV *target = SvRV(sv);
4940 sv_del_backref(target, sv);
4942 SvREFCNT_dec(target);
4944 #ifdef PERL_OLD_COPY_ON_WRITE
4945 else if (SvPVX_const(sv)) {
4947 /* I believe I need to grab the global SV mutex here and
4948 then recheck the COW status. */
4950 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4953 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4954 SV_COW_NEXT_SV(sv));
4955 /* And drop it here. */
4957 } else if (SvLEN(sv)) {
4958 Safefree(SvPVX_const(sv));
4962 else if (SvPVX_const(sv) && SvLEN(sv))
4963 Safefree(SvPVX_mutable(sv));
4964 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4965 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4974 SvFLAGS(sv) &= SVf_BREAK;
4975 SvFLAGS(sv) |= SVTYPEMASK;
4977 if (sv_type_details->arena) {
4978 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4979 &PL_body_roots[type]);
4981 else if (sv_type_details->size) {
4982 my_safefree(SvANY(sv));
4987 =for apidoc sv_newref
4989 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4996 Perl_sv_newref(pTHX_ SV *sv)
5006 Decrement an SV's reference count, and if it drops to zero, call
5007 C<sv_clear> to invoke destructors and free up any memory used by
5008 the body; finally, deallocate the SV's head itself.
5009 Normally called via a wrapper macro C<SvREFCNT_dec>.
5015 Perl_sv_free(pTHX_ SV *sv)
5020 if (SvREFCNT(sv) == 0) {
5021 if (SvFLAGS(sv) & SVf_BREAK)
5022 /* this SV's refcnt has been artificially decremented to
5023 * trigger cleanup */
5025 if (PL_in_clean_all) /* All is fair */
5027 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5028 /* make sure SvREFCNT(sv)==0 happens very seldom */
5029 SvREFCNT(sv) = (~(U32)0)/2;
5032 if (ckWARN_d(WARN_INTERNAL)) {
5033 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5034 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5035 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5036 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5037 Perl_dump_sv_child(aTHX_ sv);
5042 if (--(SvREFCNT(sv)) > 0)
5044 Perl_sv_free2(aTHX_ sv);
5048 Perl_sv_free2(pTHX_ SV *sv)
5053 if (ckWARN_d(WARN_DEBUGGING))
5054 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5055 "Attempt to free temp prematurely: SV 0x%"UVxf
5056 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5060 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5061 /* make sure SvREFCNT(sv)==0 happens very seldom */
5062 SvREFCNT(sv) = (~(U32)0)/2;
5073 Returns the length of the string in the SV. Handles magic and type
5074 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5080 Perl_sv_len(pTHX_ register SV *sv)
5088 len = mg_length(sv);
5090 (void)SvPV_const(sv, len);
5095 =for apidoc sv_len_utf8
5097 Returns the number of characters in the string in an SV, counting wide
5098 UTF-8 bytes as a single character. Handles magic and type coercion.
5104 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5105 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5106 * (Note that the mg_len is not the length of the mg_ptr field.)
5111 Perl_sv_len_utf8(pTHX_ register SV *sv)
5117 return mg_length(sv);
5121 const U8 *s = (U8*)SvPV_const(sv, len);
5122 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5124 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5126 #ifdef PERL_UTF8_CACHE_ASSERT
5127 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5131 ulen = Perl_utf8_length(aTHX_ s, s + len);
5132 if (!mg && !SvREADONLY(sv)) {
5133 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5134 mg = mg_find(sv, PERL_MAGIC_utf8);
5144 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5145 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5146 * between UTF-8 and byte offsets. There are two (substr offset and substr
5147 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5148 * and byte offset) cache positions.
5150 * The mg_len field is used by sv_len_utf8(), see its comments.
5151 * Note that the mg_len is not the length of the mg_ptr field.
5155 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5156 I32 offsetp, const U8 *s, const U8 *start)
5160 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5162 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5166 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5168 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5169 (*mgp)->mg_ptr = (char *) *cachep;
5173 (*cachep)[i] = offsetp;
5174 (*cachep)[i+1] = s - start;
5182 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5183 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5184 * between UTF-8 and byte offsets. See also the comments of
5185 * S_utf8_mg_pos_init().
5189 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)
5193 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5195 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5196 if (*mgp && (*mgp)->mg_ptr) {
5197 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5198 ASSERT_UTF8_CACHE(*cachep);
5199 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5201 else { /* We will skip to the right spot. */
5206 /* The assumption is that going backward is half
5207 * the speed of going forward (that's where the
5208 * 2 * backw in the below comes from). (The real
5209 * figure of course depends on the UTF-8 data.) */
5211 if ((*cachep)[i] > (STRLEN)uoff) {
5213 backw = (*cachep)[i] - (STRLEN)uoff;
5215 if (forw < 2 * backw)
5218 p = start + (*cachep)[i+1];
5220 /* Try this only for the substr offset (i == 0),
5221 * not for the substr length (i == 2). */
5222 else if (i == 0) { /* (*cachep)[i] < uoff */
5223 const STRLEN ulen = sv_len_utf8(sv);
5225 if ((STRLEN)uoff < ulen) {
5226 forw = (STRLEN)uoff - (*cachep)[i];
5227 backw = ulen - (STRLEN)uoff;
5229 if (forw < 2 * backw)
5230 p = start + (*cachep)[i+1];
5235 /* If the string is not long enough for uoff,
5236 * we could extend it, but not at this low a level. */
5240 if (forw < 2 * backw) {
5247 while (UTF8_IS_CONTINUATION(*p))
5252 /* Update the cache. */
5253 (*cachep)[i] = (STRLEN)uoff;
5254 (*cachep)[i+1] = p - start;
5256 /* Drop the stale "length" cache */
5265 if (found) { /* Setup the return values. */
5266 *offsetp = (*cachep)[i+1];
5267 *sp = start + *offsetp;
5270 *offsetp = send - start;
5272 else if (*sp < start) {
5278 #ifdef PERL_UTF8_CACHE_ASSERT
5283 while (n-- && s < send)
5287 assert(*offsetp == s - start);
5288 assert((*cachep)[0] == (STRLEN)uoff);
5289 assert((*cachep)[1] == *offsetp);
5291 ASSERT_UTF8_CACHE(*cachep);
5300 =for apidoc sv_pos_u2b
5302 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5303 the start of the string, to a count of the equivalent number of bytes; if
5304 lenp is non-zero, it does the same to lenp, but this time starting from
5305 the offset, rather than from the start of the string. Handles magic and
5312 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5313 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5314 * byte offsets. See also the comments of S_utf8_mg_pos().
5319 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5327 start = (U8*)SvPV_const(sv, len);
5331 const U8 *s = start;
5332 I32 uoffset = *offsetp;
5333 const U8 * const send = s + len;
5337 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5339 if (!found && uoffset > 0) {
5340 while (s < send && uoffset--)
5344 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5346 *offsetp = s - start;
5351 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5355 if (!found && *lenp > 0) {
5358 while (s < send && ulen--)
5362 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5366 ASSERT_UTF8_CACHE(cache);
5378 =for apidoc sv_pos_b2u
5380 Converts the value pointed to by offsetp from a count of bytes from the
5381 start of the string, to a count of the equivalent number of UTF-8 chars.
5382 Handles magic and type coercion.
5388 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5389 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5390 * byte offsets. See also the comments of S_utf8_mg_pos().
5395 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5403 s = (const U8*)SvPV_const(sv, len);
5404 if ((I32)len < *offsetp)
5405 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5407 const U8* send = s + *offsetp;
5409 STRLEN *cache = NULL;
5413 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5414 mg = mg_find(sv, PERL_MAGIC_utf8);
5415 if (mg && mg->mg_ptr) {
5416 cache = (STRLEN *) mg->mg_ptr;
5417 if (cache[1] == (STRLEN)*offsetp) {
5418 /* An exact match. */
5419 *offsetp = cache[0];
5423 else if (cache[1] < (STRLEN)*offsetp) {
5424 /* We already know part of the way. */
5427 /* Let the below loop do the rest. */
5429 else { /* cache[1] > *offsetp */
5430 /* We already know all of the way, now we may
5431 * be able to walk back. The same assumption
5432 * is made as in S_utf8_mg_pos(), namely that
5433 * walking backward is twice slower than
5434 * walking forward. */
5435 const STRLEN forw = *offsetp;
5436 STRLEN backw = cache[1] - *offsetp;
5438 if (!(forw < 2 * backw)) {
5439 const U8 *p = s + cache[1];
5446 while (UTF8_IS_CONTINUATION(*p)) {
5454 *offsetp = cache[0];
5456 /* Drop the stale "length" cache */
5464 ASSERT_UTF8_CACHE(cache);
5470 /* Call utf8n_to_uvchr() to validate the sequence
5471 * (unless a simple non-UTF character) */
5472 if (!UTF8_IS_INVARIANT(*s))
5473 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5482 if (!SvREADONLY(sv)) {
5484 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5485 mg = mg_find(sv, PERL_MAGIC_utf8);
5490 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5491 mg->mg_ptr = (char *) cache;
5496 cache[1] = *offsetp;
5497 /* Drop the stale "length" cache */
5510 Returns a boolean indicating whether the strings in the two SVs are
5511 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5512 coerce its args to strings if necessary.
5518 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5526 SV* svrecode = Nullsv;
5533 pv1 = SvPV_const(sv1, cur1);
5540 pv2 = SvPV_const(sv2, cur2);
5542 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5543 /* Differing utf8ness.
5544 * Do not UTF8size the comparands as a side-effect. */
5547 svrecode = newSVpvn(pv2, cur2);
5548 sv_recode_to_utf8(svrecode, PL_encoding);
5549 pv2 = SvPV_const(svrecode, cur2);
5552 svrecode = newSVpvn(pv1, cur1);
5553 sv_recode_to_utf8(svrecode, PL_encoding);
5554 pv1 = SvPV_const(svrecode, cur1);
5556 /* Now both are in UTF-8. */
5558 SvREFCNT_dec(svrecode);
5563 bool is_utf8 = TRUE;
5566 /* sv1 is the UTF-8 one,
5567 * if is equal it must be downgrade-able */
5568 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5574 /* sv2 is the UTF-8 one,
5575 * if is equal it must be downgrade-able */
5576 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5582 /* Downgrade not possible - cannot be eq */
5590 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5593 SvREFCNT_dec(svrecode);
5604 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5605 string in C<sv1> is less than, equal to, or greater than the string in
5606 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5607 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5613 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5616 const char *pv1, *pv2;
5619 SV *svrecode = Nullsv;
5626 pv1 = SvPV_const(sv1, cur1);
5633 pv2 = SvPV_const(sv2, cur2);
5635 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5636 /* Differing utf8ness.
5637 * Do not UTF8size the comparands as a side-effect. */
5640 svrecode = newSVpvn(pv2, cur2);
5641 sv_recode_to_utf8(svrecode, PL_encoding);
5642 pv2 = SvPV_const(svrecode, cur2);
5645 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5650 svrecode = newSVpvn(pv1, cur1);
5651 sv_recode_to_utf8(svrecode, PL_encoding);
5652 pv1 = SvPV_const(svrecode, cur1);
5655 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5661 cmp = cur2 ? -1 : 0;
5665 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5668 cmp = retval < 0 ? -1 : 1;
5669 } else if (cur1 == cur2) {
5672 cmp = cur1 < cur2 ? -1 : 1;
5677 SvREFCNT_dec(svrecode);
5686 =for apidoc sv_cmp_locale
5688 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5689 'use bytes' aware, handles get magic, and will coerce its args to strings
5690 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5696 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5698 #ifdef USE_LOCALE_COLLATE
5704 if (PL_collation_standard)
5708 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5710 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5712 if (!pv1 || !len1) {
5723 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5726 return retval < 0 ? -1 : 1;
5729 * When the result of collation is equality, that doesn't mean
5730 * that there are no differences -- some locales exclude some
5731 * characters from consideration. So to avoid false equalities,
5732 * we use the raw string as a tiebreaker.
5738 #endif /* USE_LOCALE_COLLATE */
5740 return sv_cmp(sv1, sv2);
5744 #ifdef USE_LOCALE_COLLATE
5747 =for apidoc sv_collxfrm
5749 Add Collate Transform magic to an SV if it doesn't already have it.
5751 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5752 scalar data of the variable, but transformed to such a format that a normal
5753 memory comparison can be used to compare the data according to the locale
5760 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5764 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5765 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5771 Safefree(mg->mg_ptr);
5772 s = SvPV_const(sv, len);
5773 if ((xf = mem_collxfrm(s, len, &xlen))) {
5774 if (SvREADONLY(sv)) {
5777 return xf + sizeof(PL_collation_ix);
5780 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5781 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5794 if (mg && mg->mg_ptr) {
5796 return mg->mg_ptr + sizeof(PL_collation_ix);
5804 #endif /* USE_LOCALE_COLLATE */
5809 Get a line from the filehandle and store it into the SV, optionally
5810 appending to the currently-stored string.
5816 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5820 register STDCHAR rslast;
5821 register STDCHAR *bp;
5827 if (SvTHINKFIRST(sv))
5828 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5829 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5831 However, perlbench says it's slower, because the existing swipe code
5832 is faster than copy on write.
5833 Swings and roundabouts. */
5834 SvUPGRADE(sv, SVt_PV);
5839 if (PerlIO_isutf8(fp)) {
5841 sv_utf8_upgrade_nomg(sv);
5842 sv_pos_u2b(sv,&append,0);
5844 } else if (SvUTF8(sv)) {
5845 SV * const tsv = NEWSV(0,0);
5846 sv_gets(tsv, fp, 0);
5847 sv_utf8_upgrade_nomg(tsv);
5848 SvCUR_set(sv,append);
5851 goto return_string_or_null;
5856 if (PerlIO_isutf8(fp))
5859 if (IN_PERL_COMPILETIME) {
5860 /* we always read code in line mode */
5864 else if (RsSNARF(PL_rs)) {
5865 /* If it is a regular disk file use size from stat() as estimate
5866 of amount we are going to read - may result in malloc-ing
5867 more memory than we realy need if layers bellow reduce
5868 size we read (e.g. CRLF or a gzip layer)
5871 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5872 const Off_t offset = PerlIO_tell(fp);
5873 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5874 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5880 else if (RsRECORD(PL_rs)) {
5884 /* Grab the size of the record we're getting */
5885 recsize = SvIV(SvRV(PL_rs));
5886 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5889 /* VMS wants read instead of fread, because fread doesn't respect */
5890 /* RMS record boundaries. This is not necessarily a good thing to be */
5891 /* doing, but we've got no other real choice - except avoid stdio
5892 as implementation - perhaps write a :vms layer ?
5894 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5896 bytesread = PerlIO_read(fp, buffer, recsize);
5900 SvCUR_set(sv, bytesread += append);
5901 buffer[bytesread] = '\0';
5902 goto return_string_or_null;
5904 else if (RsPARA(PL_rs)) {
5910 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5911 if (PerlIO_isutf8(fp)) {
5912 rsptr = SvPVutf8(PL_rs, rslen);
5915 if (SvUTF8(PL_rs)) {
5916 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5917 Perl_croak(aTHX_ "Wide character in $/");
5920 rsptr = SvPV_const(PL_rs, rslen);
5924 rslast = rslen ? rsptr[rslen - 1] : '\0';
5926 if (rspara) { /* have to do this both before and after */
5927 do { /* to make sure file boundaries work right */
5930 i = PerlIO_getc(fp);
5934 PerlIO_ungetc(fp,i);
5940 /* See if we know enough about I/O mechanism to cheat it ! */
5942 /* This used to be #ifdef test - it is made run-time test for ease
5943 of abstracting out stdio interface. One call should be cheap
5944 enough here - and may even be a macro allowing compile
5948 if (PerlIO_fast_gets(fp)) {
5951 * We're going to steal some values from the stdio struct
5952 * and put EVERYTHING in the innermost loop into registers.
5954 register STDCHAR *ptr;
5958 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5959 /* An ungetc()d char is handled separately from the regular
5960 * buffer, so we getc() it back out and stuff it in the buffer.
5962 i = PerlIO_getc(fp);
5963 if (i == EOF) return 0;
5964 *(--((*fp)->_ptr)) = (unsigned char) i;
5968 /* Here is some breathtakingly efficient cheating */
5970 cnt = PerlIO_get_cnt(fp); /* get count into register */
5971 /* make sure we have the room */
5972 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5973 /* Not room for all of it
5974 if we are looking for a separator and room for some
5976 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5977 /* just process what we have room for */
5978 shortbuffered = cnt - SvLEN(sv) + append + 1;
5979 cnt -= shortbuffered;
5983 /* remember that cnt can be negative */
5984 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5989 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5990 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5991 DEBUG_P(PerlIO_printf(Perl_debug_log,
5992 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
5993 DEBUG_P(PerlIO_printf(Perl_debug_log,
5994 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
5995 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
5996 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6001 while (cnt > 0) { /* this | eat */
6003 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6004 goto thats_all_folks; /* screams | sed :-) */
6008 Copy(ptr, bp, cnt, char); /* this | eat */
6009 bp += cnt; /* screams | dust */
6010 ptr += cnt; /* louder | sed :-) */
6015 if (shortbuffered) { /* oh well, must extend */
6016 cnt = shortbuffered;
6018 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6020 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6021 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6025 DEBUG_P(PerlIO_printf(Perl_debug_log,
6026 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6027 PTR2UV(ptr),(long)cnt));
6028 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6030 DEBUG_P(PerlIO_printf(Perl_debug_log,
6031 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6032 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6033 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6035 /* This used to call 'filbuf' in stdio form, but as that behaves like
6036 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6037 another abstraction. */
6038 i = PerlIO_getc(fp); /* get more characters */
6040 DEBUG_P(PerlIO_printf(Perl_debug_log,
6041 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6042 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6043 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6045 cnt = PerlIO_get_cnt(fp);
6046 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6047 DEBUG_P(PerlIO_printf(Perl_debug_log,
6048 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6050 if (i == EOF) /* all done for ever? */
6051 goto thats_really_all_folks;
6053 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6055 SvGROW(sv, bpx + cnt + 2);
6056 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6058 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6060 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6061 goto thats_all_folks;
6065 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6066 memNE((char*)bp - rslen, rsptr, rslen))
6067 goto screamer; /* go back to the fray */
6068 thats_really_all_folks:
6070 cnt += shortbuffered;
6071 DEBUG_P(PerlIO_printf(Perl_debug_log,
6072 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6073 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6074 DEBUG_P(PerlIO_printf(Perl_debug_log,
6075 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6076 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6077 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6079 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6080 DEBUG_P(PerlIO_printf(Perl_debug_log,
6081 "Screamer: done, len=%ld, string=|%.*s|\n",
6082 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6086 /*The big, slow, and stupid way. */
6087 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6089 Newx(buf, 8192, STDCHAR);
6097 register const STDCHAR *bpe = buf + sizeof(buf);
6099 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6100 ; /* keep reading */
6104 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6105 /* Accomodate broken VAXC compiler, which applies U8 cast to
6106 * both args of ?: operator, causing EOF to change into 255
6109 i = (U8)buf[cnt - 1];
6115 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6117 sv_catpvn(sv, (char *) buf, cnt);
6119 sv_setpvn(sv, (char *) buf, cnt);
6121 if (i != EOF && /* joy */
6123 SvCUR(sv) < rslen ||
6124 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6128 * If we're reading from a TTY and we get a short read,
6129 * indicating that the user hit his EOF character, we need
6130 * to notice it now, because if we try to read from the TTY
6131 * again, the EOF condition will disappear.
6133 * The comparison of cnt to sizeof(buf) is an optimization
6134 * that prevents unnecessary calls to feof().
6138 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6142 #ifdef USE_HEAP_INSTEAD_OF_STACK
6147 if (rspara) { /* have to do this both before and after */
6148 while (i != EOF) { /* to make sure file boundaries work right */
6149 i = PerlIO_getc(fp);
6151 PerlIO_ungetc(fp,i);
6157 return_string_or_null:
6158 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6164 Auto-increment of the value in the SV, doing string to numeric conversion
6165 if necessary. Handles 'get' magic.
6171 Perl_sv_inc(pTHX_ register SV *sv)
6179 if (SvTHINKFIRST(sv)) {
6181 sv_force_normal_flags(sv, 0);
6182 if (SvREADONLY(sv)) {
6183 if (IN_PERL_RUNTIME)
6184 Perl_croak(aTHX_ PL_no_modify);
6188 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6190 i = PTR2IV(SvRV(sv));
6195 flags = SvFLAGS(sv);
6196 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6197 /* It's (privately or publicly) a float, but not tested as an
6198 integer, so test it to see. */
6200 flags = SvFLAGS(sv);
6202 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6203 /* It's publicly an integer, or privately an integer-not-float */
6204 #ifdef PERL_PRESERVE_IVUV
6208 if (SvUVX(sv) == UV_MAX)
6209 sv_setnv(sv, UV_MAX_P1);
6211 (void)SvIOK_only_UV(sv);
6212 SvUV_set(sv, SvUVX(sv) + 1);
6214 if (SvIVX(sv) == IV_MAX)
6215 sv_setuv(sv, (UV)IV_MAX + 1);
6217 (void)SvIOK_only(sv);
6218 SvIV_set(sv, SvIVX(sv) + 1);
6223 if (flags & SVp_NOK) {
6224 (void)SvNOK_only(sv);
6225 SvNV_set(sv, SvNVX(sv) + 1.0);
6229 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6230 if ((flags & SVTYPEMASK) < SVt_PVIV)
6231 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6232 (void)SvIOK_only(sv);
6237 while (isALPHA(*d)) d++;
6238 while (isDIGIT(*d)) d++;
6240 #ifdef PERL_PRESERVE_IVUV
6241 /* Got to punt this as an integer if needs be, but we don't issue
6242 warnings. Probably ought to make the sv_iv_please() that does
6243 the conversion if possible, and silently. */
6244 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6245 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6246 /* Need to try really hard to see if it's an integer.
6247 9.22337203685478e+18 is an integer.
6248 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6249 so $a="9.22337203685478e+18"; $a+0; $a++
6250 needs to be the same as $a="9.22337203685478e+18"; $a++
6257 /* sv_2iv *should* have made this an NV */
6258 if (flags & SVp_NOK) {
6259 (void)SvNOK_only(sv);
6260 SvNV_set(sv, SvNVX(sv) + 1.0);
6263 /* I don't think we can get here. Maybe I should assert this
6264 And if we do get here I suspect that sv_setnv will croak. NWC
6266 #if defined(USE_LONG_DOUBLE)
6267 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",
6268 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6270 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6271 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6274 #endif /* PERL_PRESERVE_IVUV */
6275 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6279 while (d >= SvPVX_const(sv)) {
6287 /* MKS: The original code here died if letters weren't consecutive.
6288 * at least it didn't have to worry about non-C locales. The
6289 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6290 * arranged in order (although not consecutively) and that only
6291 * [A-Za-z] are accepted by isALPHA in the C locale.
6293 if (*d != 'z' && *d != 'Z') {
6294 do { ++*d; } while (!isALPHA(*d));
6297 *(d--) -= 'z' - 'a';
6302 *(d--) -= 'z' - 'a' + 1;
6306 /* oh,oh, the number grew */
6307 SvGROW(sv, SvCUR(sv) + 2);
6308 SvCUR_set(sv, SvCUR(sv) + 1);
6309 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6320 Auto-decrement of the value in the SV, doing string to numeric conversion
6321 if necessary. Handles 'get' magic.
6327 Perl_sv_dec(pTHX_ register SV *sv)
6334 if (SvTHINKFIRST(sv)) {
6336 sv_force_normal_flags(sv, 0);
6337 if (SvREADONLY(sv)) {
6338 if (IN_PERL_RUNTIME)
6339 Perl_croak(aTHX_ PL_no_modify);
6343 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6345 i = PTR2IV(SvRV(sv));
6350 /* Unlike sv_inc we don't have to worry about string-never-numbers
6351 and keeping them magic. But we mustn't warn on punting */
6352 flags = SvFLAGS(sv);
6353 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6354 /* It's publicly an integer, or privately an integer-not-float */
6355 #ifdef PERL_PRESERVE_IVUV
6359 if (SvUVX(sv) == 0) {
6360 (void)SvIOK_only(sv);
6364 (void)SvIOK_only_UV(sv);
6365 SvUV_set(sv, SvUVX(sv) - 1);
6368 if (SvIVX(sv) == IV_MIN)
6369 sv_setnv(sv, (NV)IV_MIN - 1.0);
6371 (void)SvIOK_only(sv);
6372 SvIV_set(sv, SvIVX(sv) - 1);
6377 if (flags & SVp_NOK) {
6378 SvNV_set(sv, SvNVX(sv) - 1.0);
6379 (void)SvNOK_only(sv);
6382 if (!(flags & SVp_POK)) {
6383 if ((flags & SVTYPEMASK) < SVt_PVIV)
6384 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6386 (void)SvIOK_only(sv);
6389 #ifdef PERL_PRESERVE_IVUV
6391 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6392 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6393 /* Need to try really hard to see if it's an integer.
6394 9.22337203685478e+18 is an integer.
6395 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6396 so $a="9.22337203685478e+18"; $a+0; $a--
6397 needs to be the same as $a="9.22337203685478e+18"; $a--
6404 /* sv_2iv *should* have made this an NV */
6405 if (flags & SVp_NOK) {
6406 (void)SvNOK_only(sv);
6407 SvNV_set(sv, SvNVX(sv) - 1.0);
6410 /* I don't think we can get here. Maybe I should assert this
6411 And if we do get here I suspect that sv_setnv will croak. NWC
6413 #if defined(USE_LONG_DOUBLE)
6414 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",
6415 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6417 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6418 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6422 #endif /* PERL_PRESERVE_IVUV */
6423 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6427 =for apidoc sv_mortalcopy
6429 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6430 The new SV is marked as mortal. It will be destroyed "soon", either by an
6431 explicit call to FREETMPS, or by an implicit call at places such as
6432 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6437 /* Make a string that will exist for the duration of the expression
6438 * evaluation. Actually, it may have to last longer than that, but
6439 * hopefully we won't free it until it has been assigned to a
6440 * permanent location. */
6443 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6448 sv_setsv(sv,oldstr);
6450 PL_tmps_stack[++PL_tmps_ix] = sv;
6456 =for apidoc sv_newmortal
6458 Creates a new null SV which is mortal. The reference count of the SV is
6459 set to 1. It will be destroyed "soon", either by an explicit call to
6460 FREETMPS, or by an implicit call at places such as statement boundaries.
6461 See also C<sv_mortalcopy> and C<sv_2mortal>.
6467 Perl_sv_newmortal(pTHX)
6472 SvFLAGS(sv) = SVs_TEMP;
6474 PL_tmps_stack[++PL_tmps_ix] = sv;
6479 =for apidoc sv_2mortal
6481 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6482 by an explicit call to FREETMPS, or by an implicit call at places such as
6483 statement boundaries. SvTEMP() is turned on which means that the SV's
6484 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6485 and C<sv_mortalcopy>.
6491 Perl_sv_2mortal(pTHX_ register SV *sv)
6496 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6499 PL_tmps_stack[++PL_tmps_ix] = sv;
6507 Creates a new SV and copies a string into it. The reference count for the
6508 SV is set to 1. If C<len> is zero, Perl will compute the length using
6509 strlen(). For efficiency, consider using C<newSVpvn> instead.
6515 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6520 sv_setpvn(sv,s,len ? len : strlen(s));
6525 =for apidoc newSVpvn
6527 Creates a new SV and copies a string into it. The reference count for the
6528 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6529 string. You are responsible for ensuring that the source string is at least
6530 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6536 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6541 sv_setpvn(sv,s,len);
6547 =for apidoc newSVhek
6549 Creates a new SV from the hash key structure. It will generate scalars that
6550 point to the shared string table where possible. Returns a new (undefined)
6551 SV if the hek is NULL.
6557 Perl_newSVhek(pTHX_ const HEK *hek)
6566 if (HEK_LEN(hek) == HEf_SVKEY) {
6567 return newSVsv(*(SV**)HEK_KEY(hek));
6569 const int flags = HEK_FLAGS(hek);
6570 if (flags & HVhek_WASUTF8) {
6572 Andreas would like keys he put in as utf8 to come back as utf8
6574 STRLEN utf8_len = HEK_LEN(hek);
6575 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6576 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6579 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6581 } else if (flags & HVhek_REHASH) {
6582 /* We don't have a pointer to the hv, so we have to replicate the
6583 flag into every HEK. This hv is using custom a hasing
6584 algorithm. Hence we can't return a shared string scalar, as
6585 that would contain the (wrong) hash value, and might get passed
6586 into an hv routine with a regular hash */
6588 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6593 /* This will be overwhelminly the most common case. */
6594 return newSVpvn_share(HEK_KEY(hek),
6595 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6601 =for apidoc newSVpvn_share
6603 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6604 table. If the string does not already exist in the table, it is created
6605 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6606 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6607 otherwise the hash is computed. The idea here is that as the string table
6608 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6609 hash lookup will avoid string compare.
6615 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6618 bool is_utf8 = FALSE;
6620 STRLEN tmplen = -len;
6622 /* See the note in hv.c:hv_fetch() --jhi */
6623 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6627 PERL_HASH(hash, src, len);
6629 sv_upgrade(sv, SVt_PV);
6630 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6642 #if defined(PERL_IMPLICIT_CONTEXT)
6644 /* pTHX_ magic can't cope with varargs, so this is a no-context
6645 * version of the main function, (which may itself be aliased to us).
6646 * Don't access this version directly.
6650 Perl_newSVpvf_nocontext(const char* pat, ...)
6655 va_start(args, pat);
6656 sv = vnewSVpvf(pat, &args);
6663 =for apidoc newSVpvf
6665 Creates a new SV and initializes it with the string formatted like
6672 Perl_newSVpvf(pTHX_ const char* pat, ...)
6676 va_start(args, pat);
6677 sv = vnewSVpvf(pat, &args);
6682 /* backend for newSVpvf() and newSVpvf_nocontext() */
6685 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6689 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6696 Creates a new SV and copies a floating point value into it.
6697 The reference count for the SV is set to 1.
6703 Perl_newSVnv(pTHX_ NV n)
6715 Creates a new SV and copies an integer into it. The reference count for the
6722 Perl_newSViv(pTHX_ IV i)
6734 Creates a new SV and copies an unsigned integer into it.
6735 The reference count for the SV is set to 1.
6741 Perl_newSVuv(pTHX_ UV u)
6751 =for apidoc newRV_noinc
6753 Creates an RV wrapper for an SV. The reference count for the original
6754 SV is B<not> incremented.
6760 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6765 sv_upgrade(sv, SVt_RV);
6767 SvRV_set(sv, tmpRef);
6772 /* newRV_inc is the official function name to use now.
6773 * newRV_inc is in fact #defined to newRV in sv.h
6777 Perl_newRV(pTHX_ SV *tmpRef)
6779 return newRV_noinc(SvREFCNT_inc(tmpRef));
6785 Creates a new SV which is an exact duplicate of the original SV.
6792 Perl_newSVsv(pTHX_ register SV *old)
6798 if (SvTYPE(old) == SVTYPEMASK) {
6799 if (ckWARN_d(WARN_INTERNAL))
6800 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6804 /* SV_GMAGIC is the default for sv_setv()
6805 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6806 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6807 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6812 =for apidoc sv_reset
6814 Underlying implementation for the C<reset> Perl function.
6815 Note that the perl-level function is vaguely deprecated.
6821 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6824 char todo[PERL_UCHAR_MAX+1];
6829 if (!*s) { /* reset ?? searches */
6830 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6832 PMOP *pm = (PMOP *) mg->mg_obj;
6834 pm->op_pmdynflags &= ~PMdf_USED;
6841 /* reset variables */
6843 if (!HvARRAY(stash))
6846 Zero(todo, 256, char);
6849 I32 i = (unsigned char)*s;
6853 max = (unsigned char)*s++;
6854 for ( ; i <= max; i++) {
6857 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6859 for (entry = HvARRAY(stash)[i];
6861 entry = HeNEXT(entry))
6866 if (!todo[(U8)*HeKEY(entry)])
6868 gv = (GV*)HeVAL(entry);
6871 if (SvTHINKFIRST(sv)) {
6872 if (!SvREADONLY(sv) && SvROK(sv))
6874 /* XXX Is this continue a bug? Why should THINKFIRST
6875 exempt us from resetting arrays and hashes? */
6879 if (SvTYPE(sv) >= SVt_PV) {
6881 if (SvPVX_const(sv) != Nullch)
6889 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6891 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6894 # if defined(USE_ENVIRON_ARRAY)
6897 # endif /* USE_ENVIRON_ARRAY */
6908 Using various gambits, try to get an IO from an SV: the IO slot if its a
6909 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6910 named after the PV if we're a string.
6916 Perl_sv_2io(pTHX_ SV *sv)
6921 switch (SvTYPE(sv)) {
6929 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6933 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6935 return sv_2io(SvRV(sv));
6936 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6942 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6951 Using various gambits, try to get a CV from an SV; in addition, try if
6952 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6958 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6965 return *gvp = Nullgv, Nullcv;
6966 switch (SvTYPE(sv)) {
6984 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
6985 tryAMAGICunDEREF(to_cv);
6988 if (SvTYPE(sv) == SVt_PVCV) {
6997 Perl_croak(aTHX_ "Not a subroutine reference");
7002 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7008 if (lref && !GvCVu(gv)) {
7011 tmpsv = NEWSV(704,0);
7012 gv_efullname3(tmpsv, gv, Nullch);
7013 /* XXX this is probably not what they think they're getting.
7014 * It has the same effect as "sub name;", i.e. just a forward
7016 newSUB(start_subparse(FALSE, 0),
7017 newSVOP(OP_CONST, 0, tmpsv),
7022 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7032 Returns true if the SV has a true value by Perl's rules.
7033 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7034 instead use an in-line version.
7040 Perl_sv_true(pTHX_ register SV *sv)
7045 register const XPV* const tXpv = (XPV*)SvANY(sv);
7047 (tXpv->xpv_cur > 1 ||
7048 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7055 return SvIVX(sv) != 0;
7058 return SvNVX(sv) != 0.0;
7060 return sv_2bool(sv);
7066 =for apidoc sv_pvn_force
7068 Get a sensible string out of the SV somehow.
7069 A private implementation of the C<SvPV_force> macro for compilers which
7070 can't cope with complex macro expressions. Always use the macro instead.
7072 =for apidoc sv_pvn_force_flags
7074 Get a sensible string out of the SV somehow.
7075 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7076 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7077 implemented in terms of this function.
7078 You normally want to use the various wrapper macros instead: see
7079 C<SvPV_force> and C<SvPV_force_nomg>
7085 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7088 if (SvTHINKFIRST(sv) && !SvROK(sv))
7089 sv_force_normal_flags(sv, 0);
7099 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7100 const char * const ref = sv_reftype(sv,0);
7102 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7103 ref, OP_NAME(PL_op));
7105 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7107 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7108 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7110 s = sv_2pv_flags(sv, &len, flags);
7114 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7117 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7118 SvGROW(sv, len + 1);
7119 Move(s,SvPVX(sv),len,char);
7124 SvPOK_on(sv); /* validate pointer */
7126 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7127 PTR2UV(sv),SvPVX_const(sv)));
7130 return SvPVX_mutable(sv);
7134 =for apidoc sv_pvbyten_force
7136 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7142 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7144 sv_pvn_force(sv,lp);
7145 sv_utf8_downgrade(sv,0);
7151 =for apidoc sv_pvutf8n_force
7153 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7159 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7161 sv_pvn_force(sv,lp);
7162 sv_utf8_upgrade(sv);
7168 =for apidoc sv_reftype
7170 Returns a string describing what the SV is a reference to.
7176 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7178 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7179 inside return suggests a const propagation bug in g++. */
7180 if (ob && SvOBJECT(sv)) {
7181 char * const name = HvNAME_get(SvSTASH(sv));
7182 return name ? name : (char *) "__ANON__";
7185 switch (SvTYPE(sv)) {
7202 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7203 /* tied lvalues should appear to be
7204 * scalars for backwards compatitbility */
7205 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7206 ? "SCALAR" : "LVALUE");
7207 case SVt_PVAV: return "ARRAY";
7208 case SVt_PVHV: return "HASH";
7209 case SVt_PVCV: return "CODE";
7210 case SVt_PVGV: return "GLOB";
7211 case SVt_PVFM: return "FORMAT";
7212 case SVt_PVIO: return "IO";
7213 default: return "UNKNOWN";
7219 =for apidoc sv_isobject
7221 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7222 object. If the SV is not an RV, or if the object is not blessed, then this
7229 Perl_sv_isobject(pTHX_ SV *sv)
7245 Returns a boolean indicating whether the SV is blessed into the specified
7246 class. This does not check for subtypes; use C<sv_derived_from> to verify
7247 an inheritance relationship.
7253 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7264 hvname = HvNAME_get(SvSTASH(sv));
7268 return strEQ(hvname, name);
7274 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7275 it will be upgraded to one. If C<classname> is non-null then the new SV will
7276 be blessed in the specified package. The new SV is returned and its
7277 reference count is 1.
7283 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7289 SV_CHECK_THINKFIRST_COW_DROP(rv);
7292 if (SvTYPE(rv) >= SVt_PVMG) {
7293 const U32 refcnt = SvREFCNT(rv);
7297 SvREFCNT(rv) = refcnt;
7300 if (SvTYPE(rv) < SVt_RV)
7301 sv_upgrade(rv, SVt_RV);
7302 else if (SvTYPE(rv) > SVt_RV) {
7313 HV* const stash = gv_stashpv(classname, TRUE);
7314 (void)sv_bless(rv, stash);
7320 =for apidoc sv_setref_pv
7322 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7323 argument will be upgraded to an RV. That RV will be modified to point to
7324 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7325 into the SV. The C<classname> argument indicates the package for the
7326 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7327 will have a reference count of 1, and the RV will be returned.
7329 Do not use with other Perl types such as HV, AV, SV, CV, because those
7330 objects will become corrupted by the pointer copy process.
7332 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7338 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7341 sv_setsv(rv, &PL_sv_undef);
7345 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7350 =for apidoc sv_setref_iv
7352 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7353 argument will be upgraded to an RV. That RV will be modified to point to
7354 the new SV. The C<classname> argument indicates the package for the
7355 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7356 will have a reference count of 1, and the RV will be returned.
7362 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7364 sv_setiv(newSVrv(rv,classname), iv);
7369 =for apidoc sv_setref_uv
7371 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7372 argument will be upgraded to an RV. That RV will be modified to point to
7373 the new SV. The C<classname> argument indicates the package for the
7374 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7375 will have a reference count of 1, and the RV will be returned.
7381 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7383 sv_setuv(newSVrv(rv,classname), uv);
7388 =for apidoc sv_setref_nv
7390 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7391 argument will be upgraded to an RV. That RV will be modified to point to
7392 the new SV. The C<classname> argument indicates the package for the
7393 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7394 will have a reference count of 1, and the RV will be returned.
7400 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7402 sv_setnv(newSVrv(rv,classname), nv);
7407 =for apidoc sv_setref_pvn
7409 Copies a string into a new SV, optionally blessing the SV. The length of the
7410 string must be specified with C<n>. The C<rv> argument will be upgraded to
7411 an RV. That RV will be modified to point to the new SV. The C<classname>
7412 argument indicates the package for the blessing. Set C<classname> to
7413 C<Nullch> to avoid the blessing. The new SV will have a reference count
7414 of 1, and the RV will be returned.
7416 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7422 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7424 sv_setpvn(newSVrv(rv,classname), pv, n);
7429 =for apidoc sv_bless
7431 Blesses an SV into a specified package. The SV must be an RV. The package
7432 must be designated by its stash (see C<gv_stashpv()>). The reference count
7433 of the SV is unaffected.
7439 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7443 Perl_croak(aTHX_ "Can't bless non-reference value");
7445 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7446 if (SvREADONLY(tmpRef))
7447 Perl_croak(aTHX_ PL_no_modify);
7448 if (SvOBJECT(tmpRef)) {
7449 if (SvTYPE(tmpRef) != SVt_PVIO)
7451 SvREFCNT_dec(SvSTASH(tmpRef));
7454 SvOBJECT_on(tmpRef);
7455 if (SvTYPE(tmpRef) != SVt_PVIO)
7457 SvUPGRADE(tmpRef, SVt_PVMG);
7458 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7465 if(SvSMAGICAL(tmpRef))
7466 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7474 /* Downgrades a PVGV to a PVMG.
7478 S_sv_unglob(pTHX_ SV *sv)
7482 assert(SvTYPE(sv) == SVt_PVGV);
7487 sv_del_backref((SV*)GvSTASH(sv), sv);
7488 GvSTASH(sv) = Nullhv;
7490 sv_unmagic(sv, PERL_MAGIC_glob);
7491 Safefree(GvNAME(sv));
7494 /* need to keep SvANY(sv) in the right arena */
7495 xpvmg = new_XPVMG();
7496 StructCopy(SvANY(sv), xpvmg, XPVMG);
7497 del_XPVGV(SvANY(sv));
7500 SvFLAGS(sv) &= ~SVTYPEMASK;
7501 SvFLAGS(sv) |= SVt_PVMG;
7505 =for apidoc sv_unref_flags
7507 Unsets the RV status of the SV, and decrements the reference count of
7508 whatever was being referenced by the RV. This can almost be thought of
7509 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7510 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7511 (otherwise the decrementing is conditional on the reference count being
7512 different from one or the reference being a readonly SV).
7519 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7521 SV* const target = SvRV(ref);
7523 if (SvWEAKREF(ref)) {
7524 sv_del_backref(target, ref);
7526 SvRV_set(ref, NULL);
7529 SvRV_set(ref, NULL);
7531 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7532 assigned to as BEGIN {$a = \"Foo"} will fail. */
7533 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7534 SvREFCNT_dec(target);
7535 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7536 sv_2mortal(target); /* Schedule for freeing later */
7540 =for apidoc sv_untaint
7542 Untaint an SV. Use C<SvTAINTED_off> instead.
7547 Perl_sv_untaint(pTHX_ SV *sv)
7549 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7550 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7557 =for apidoc sv_tainted
7559 Test an SV for taintedness. Use C<SvTAINTED> instead.
7564 Perl_sv_tainted(pTHX_ SV *sv)
7566 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7567 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7568 if (mg && (mg->mg_len & 1) )
7575 =for apidoc sv_setpviv
7577 Copies an integer into the given SV, also updating its string value.
7578 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7584 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7586 char buf[TYPE_CHARS(UV)];
7588 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7590 sv_setpvn(sv, ptr, ebuf - ptr);
7594 =for apidoc sv_setpviv_mg
7596 Like C<sv_setpviv>, but also handles 'set' magic.
7602 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7608 #if defined(PERL_IMPLICIT_CONTEXT)
7610 /* pTHX_ magic can't cope with varargs, so this is a no-context
7611 * version of the main function, (which may itself be aliased to us).
7612 * Don't access this version directly.
7616 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7620 va_start(args, pat);
7621 sv_vsetpvf(sv, pat, &args);
7625 /* pTHX_ magic can't cope with varargs, so this is a no-context
7626 * version of the main function, (which may itself be aliased to us).
7627 * Don't access this version directly.
7631 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7635 va_start(args, pat);
7636 sv_vsetpvf_mg(sv, pat, &args);
7642 =for apidoc sv_setpvf
7644 Works like C<sv_catpvf> but copies the text into the SV instead of
7645 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7651 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7654 va_start(args, pat);
7655 sv_vsetpvf(sv, pat, &args);
7660 =for apidoc sv_vsetpvf
7662 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7663 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7665 Usually used via its frontend C<sv_setpvf>.
7671 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7673 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7677 =for apidoc sv_setpvf_mg
7679 Like C<sv_setpvf>, but also handles 'set' magic.
7685 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7688 va_start(args, pat);
7689 sv_vsetpvf_mg(sv, pat, &args);
7694 =for apidoc sv_vsetpvf_mg
7696 Like C<sv_vsetpvf>, but also handles 'set' magic.
7698 Usually used via its frontend C<sv_setpvf_mg>.
7704 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7706 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7710 #if defined(PERL_IMPLICIT_CONTEXT)
7712 /* pTHX_ magic can't cope with varargs, so this is a no-context
7713 * version of the main function, (which may itself be aliased to us).
7714 * Don't access this version directly.
7718 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7722 va_start(args, pat);
7723 sv_vcatpvf(sv, pat, &args);
7727 /* pTHX_ magic can't cope with varargs, so this is a no-context
7728 * version of the main function, (which may itself be aliased to us).
7729 * Don't access this version directly.
7733 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7737 va_start(args, pat);
7738 sv_vcatpvf_mg(sv, pat, &args);
7744 =for apidoc sv_catpvf
7746 Processes its arguments like C<sprintf> and appends the formatted
7747 output to an SV. If the appended data contains "wide" characters
7748 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7749 and characters >255 formatted with %c), the original SV might get
7750 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7751 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7752 valid UTF-8; if the original SV was bytes, the pattern should be too.
7757 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7760 va_start(args, pat);
7761 sv_vcatpvf(sv, pat, &args);
7766 =for apidoc sv_vcatpvf
7768 Processes its arguments like C<vsprintf> and appends the formatted output
7769 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7771 Usually used via its frontend C<sv_catpvf>.
7777 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7779 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7783 =for apidoc sv_catpvf_mg
7785 Like C<sv_catpvf>, but also handles 'set' magic.
7791 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7794 va_start(args, pat);
7795 sv_vcatpvf_mg(sv, pat, &args);
7800 =for apidoc sv_vcatpvf_mg
7802 Like C<sv_vcatpvf>, but also handles 'set' magic.
7804 Usually used via its frontend C<sv_catpvf_mg>.
7810 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7812 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7817 =for apidoc sv_vsetpvfn
7819 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7822 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7828 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7830 sv_setpvn(sv, "", 0);
7831 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7834 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7837 S_expect_number(pTHX_ char** pattern)
7840 switch (**pattern) {
7841 case '1': case '2': case '3':
7842 case '4': case '5': case '6':
7843 case '7': case '8': case '9':
7844 while (isDIGIT(**pattern))
7845 var = var * 10 + (*(*pattern)++ - '0');
7849 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7852 F0convert(NV nv, char *endbuf, STRLEN *len)
7854 const int neg = nv < 0;
7863 if (uv & 1 && uv == nv)
7864 uv--; /* Round to even */
7866 const unsigned dig = uv % 10;
7879 =for apidoc sv_vcatpvfn
7881 Processes its arguments like C<vsprintf> and appends the formatted output
7882 to an SV. Uses an array of SVs if the C style variable argument list is
7883 missing (NULL). When running with taint checks enabled, indicates via
7884 C<maybe_tainted> if results are untrustworthy (often due to the use of
7887 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7893 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7894 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7895 vec_utf8 = DO_UTF8(vecsv);
7897 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7900 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7907 static const char nullstr[] = "(null)";
7909 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7910 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7912 /* Times 4: a decimal digit takes more than 3 binary digits.
7913 * NV_DIG: mantissa takes than many decimal digits.
7914 * Plus 32: Playing safe. */
7915 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7916 /* large enough for "%#.#f" --chip */
7917 /* what about long double NVs? --jhi */
7919 PERL_UNUSED_ARG(maybe_tainted);
7921 /* no matter what, this is a string now */
7922 (void)SvPV_force(sv, origlen);
7924 /* special-case "", "%s", and "%-p" (SVf - see below) */
7927 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7929 const char * const s = va_arg(*args, char*);
7930 sv_catpv(sv, s ? s : nullstr);
7932 else if (svix < svmax) {
7933 sv_catsv(sv, *svargs);
7937 if (args && patlen == 3 && pat[0] == '%' &&
7938 pat[1] == '-' && pat[2] == 'p') {
7939 argsv = va_arg(*args, SV*);
7940 sv_catsv(sv, argsv);
7944 #ifndef USE_LONG_DOUBLE
7945 /* special-case "%.<number>[gf]" */
7946 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7947 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7948 unsigned digits = 0;
7952 while (*pp >= '0' && *pp <= '9')
7953 digits = 10 * digits + (*pp++ - '0');
7954 if (pp - pat == (int)patlen - 1) {
7962 /* Add check for digits != 0 because it seems that some
7963 gconverts are buggy in this case, and we don't yet have
7964 a Configure test for this. */
7965 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7966 /* 0, point, slack */
7967 Gconvert(nv, (int)digits, 0, ebuf);
7969 if (*ebuf) /* May return an empty string for digits==0 */
7972 } else if (!digits) {
7975 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7976 sv_catpvn(sv, p, l);
7982 #endif /* !USE_LONG_DOUBLE */
7984 if (!args && svix < svmax && DO_UTF8(*svargs))
7987 patend = (char*)pat + patlen;
7988 for (p = (char*)pat; p < patend; p = q) {
7991 bool vectorize = FALSE;
7992 bool vectorarg = FALSE;
7993 bool vec_utf8 = FALSE;
7999 bool has_precis = FALSE;
8002 bool is_utf8 = FALSE; /* is this item utf8? */
8003 #ifdef HAS_LDBL_SPRINTF_BUG
8004 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8005 with sfio - Allen <allens@cpan.org> */
8006 bool fix_ldbl_sprintf_bug = FALSE;
8010 U8 utf8buf[UTF8_MAXBYTES+1];
8011 STRLEN esignlen = 0;
8013 const char *eptr = Nullch;
8016 const U8 *vecstr = Null(U8*);
8023 /* we need a long double target in case HAS_LONG_DOUBLE but
8026 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8034 const char *dotstr = ".";
8035 STRLEN dotstrlen = 1;
8036 I32 efix = 0; /* explicit format parameter index */
8037 I32 ewix = 0; /* explicit width index */
8038 I32 epix = 0; /* explicit precision index */
8039 I32 evix = 0; /* explicit vector index */
8040 bool asterisk = FALSE;
8042 /* echo everything up to the next format specification */
8043 for (q = p; q < patend && *q != '%'; ++q) ;
8045 if (has_utf8 && !pat_utf8)
8046 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8048 sv_catpvn(sv, p, q - p);
8055 We allow format specification elements in this order:
8056 \d+\$ explicit format parameter index
8058 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8059 0 flag (as above): repeated to allow "v02"
8060 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8061 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8063 [%bcdefginopsuxDFOUX] format (mandatory)
8068 As of perl5.9.3, printf format checking is on by default.
8069 Internally, perl uses %p formats to provide an escape to
8070 some extended formatting. This block deals with those
8071 extensions: if it does not match, (char*)q is reset and
8072 the normal format processing code is used.
8074 Currently defined extensions are:
8075 %p include pointer address (standard)
8076 %-p (SVf) include an SV (previously %_)
8077 %-<num>p include an SV with precision <num>
8078 %1p (VDf) include a v-string (as %vd)
8079 %<num>p reserved for future extensions
8081 Robin Barker 2005-07-14
8088 EXPECT_NUMBER(q, n);
8095 argsv = va_arg(*args, SV*);
8096 eptr = SvPVx_const(argsv, elen);
8102 else if (n == vdNUMBER) { /* VDf */
8109 if (ckWARN_d(WARN_INTERNAL))
8110 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8111 "internal %%<num>p might conflict with future printf extensions");
8117 if (EXPECT_NUMBER(q, width)) {
8158 if (EXPECT_NUMBER(q, ewix))
8167 if ((vectorarg = asterisk)) {
8180 EXPECT_NUMBER(q, width);
8186 vecsv = va_arg(*args, SV*);
8188 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8189 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8190 dotstr = SvPV_const(vecsv, dotstrlen);
8197 else if (efix ? efix <= svmax : svix < svmax) {
8198 vecsv = svargs[efix ? efix-1 : svix++];
8199 vecstr = (U8*)SvPV_const(vecsv,veclen);
8200 vec_utf8 = DO_UTF8(vecsv);
8201 /* if this is a version object, we need to return the
8202 * stringified representation (which the SvPVX_const has
8203 * already done for us), but not vectorize the args
8205 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8207 q++; /* skip past the rest of the %vd format */
8208 eptr = (const char *) vecstr;
8222 i = va_arg(*args, int);
8224 i = (ewix ? ewix <= svmax : svix < svmax) ?
8225 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8227 width = (i < 0) ? -i : i;
8237 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8239 /* XXX: todo, support specified precision parameter */
8243 i = va_arg(*args, int);
8245 i = (ewix ? ewix <= svmax : svix < svmax)
8246 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8247 precis = (i < 0) ? 0 : i;
8252 precis = precis * 10 + (*q++ - '0');
8261 case 'I': /* Ix, I32x, and I64x */
8263 if (q[1] == '6' && q[2] == '4') {
8269 if (q[1] == '3' && q[2] == '2') {
8279 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8290 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8291 if (*(q + 1) == 'l') { /* lld, llf */
8317 const I32 i = efix-1;
8318 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8320 argsv = (svix >= 0 && svix < svmax)
8321 ? svargs[svix++] : &PL_sv_undef;
8330 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8332 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8334 eptr = (char*)utf8buf;
8335 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8346 if (args && !vectorize) {
8347 eptr = va_arg(*args, char*);
8349 #ifdef MACOS_TRADITIONAL
8350 /* On MacOS, %#s format is used for Pascal strings */
8355 elen = strlen(eptr);
8357 eptr = (char *)nullstr;
8358 elen = sizeof nullstr - 1;
8362 eptr = SvPVx_const(argsv, elen);
8363 if (DO_UTF8(argsv)) {
8364 if (has_precis && precis < elen) {
8366 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8369 if (width) { /* fudge width (can't fudge elen) */
8370 width += elen - sv_len_utf8(argsv);
8378 if (has_precis && elen > precis)
8385 if (alt || vectorize)
8387 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8408 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8417 esignbuf[esignlen++] = plus;
8421 case 'h': iv = (short)va_arg(*args, int); break;
8422 case 'l': iv = va_arg(*args, long); break;
8423 case 'V': iv = va_arg(*args, IV); break;
8424 default: iv = va_arg(*args, int); break;
8426 case 'q': iv = va_arg(*args, Quad_t); break;
8431 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8433 case 'h': iv = (short)tiv; break;
8434 case 'l': iv = (long)tiv; break;
8436 default: iv = tiv; break;
8438 case 'q': iv = (Quad_t)tiv; break;
8442 if ( !vectorize ) /* we already set uv above */
8447 esignbuf[esignlen++] = plus;
8451 esignbuf[esignlen++] = '-';
8494 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8505 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8506 case 'l': uv = va_arg(*args, unsigned long); break;
8507 case 'V': uv = va_arg(*args, UV); break;
8508 default: uv = va_arg(*args, unsigned); break;
8510 case 'q': uv = va_arg(*args, Uquad_t); break;
8515 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8517 case 'h': uv = (unsigned short)tuv; break;
8518 case 'l': uv = (unsigned long)tuv; break;
8520 default: uv = tuv; break;
8522 case 'q': uv = (Uquad_t)tuv; break;
8529 char *ptr = ebuf + sizeof ebuf;
8535 p = (char*)((c == 'X')
8536 ? "0123456789ABCDEF" : "0123456789abcdef");
8542 esignbuf[esignlen++] = '0';
8543 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8551 if (alt && *ptr != '0')
8562 esignbuf[esignlen++] = '0';
8563 esignbuf[esignlen++] = 'b';
8566 default: /* it had better be ten or less */
8570 } while (uv /= base);
8573 elen = (ebuf + sizeof ebuf) - ptr;
8577 zeros = precis - elen;
8578 else if (precis == 0 && elen == 1 && *eptr == '0')
8584 /* FLOATING POINT */
8587 c = 'f'; /* maybe %F isn't supported here */
8593 /* This is evil, but floating point is even more evil */
8595 /* for SV-style calling, we can only get NV
8596 for C-style calling, we assume %f is double;
8597 for simplicity we allow any of %Lf, %llf, %qf for long double
8601 #if defined(USE_LONG_DOUBLE)
8605 /* [perl #20339] - we should accept and ignore %lf rather than die */
8609 #if defined(USE_LONG_DOUBLE)
8610 intsize = args ? 0 : 'q';
8614 #if defined(HAS_LONG_DOUBLE)
8623 /* now we need (long double) if intsize == 'q', else (double) */
8624 nv = (args && !vectorize) ?
8625 #if LONG_DOUBLESIZE > DOUBLESIZE
8627 va_arg(*args, long double) :
8628 va_arg(*args, double)
8630 va_arg(*args, double)
8636 if (c != 'e' && c != 'E') {
8638 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8639 will cast our (long double) to (double) */
8640 (void)Perl_frexp(nv, &i);
8641 if (i == PERL_INT_MIN)
8642 Perl_die(aTHX_ "panic: frexp");
8644 need = BIT_DIGITS(i);
8646 need += has_precis ? precis : 6; /* known default */
8651 #ifdef HAS_LDBL_SPRINTF_BUG
8652 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8653 with sfio - Allen <allens@cpan.org> */
8656 # define MY_DBL_MAX DBL_MAX
8657 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8658 # if DOUBLESIZE >= 8
8659 # define MY_DBL_MAX 1.7976931348623157E+308L
8661 # define MY_DBL_MAX 3.40282347E+38L
8665 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8666 # define MY_DBL_MAX_BUG 1L
8668 # define MY_DBL_MAX_BUG MY_DBL_MAX
8672 # define MY_DBL_MIN DBL_MIN
8673 # else /* XXX guessing! -Allen */
8674 # if DOUBLESIZE >= 8
8675 # define MY_DBL_MIN 2.2250738585072014E-308L
8677 # define MY_DBL_MIN 1.17549435E-38L
8681 if ((intsize == 'q') && (c == 'f') &&
8682 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8684 /* it's going to be short enough that
8685 * long double precision is not needed */
8687 if ((nv <= 0L) && (nv >= -0L))
8688 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8690 /* would use Perl_fp_class as a double-check but not
8691 * functional on IRIX - see perl.h comments */
8693 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8694 /* It's within the range that a double can represent */
8695 #if defined(DBL_MAX) && !defined(DBL_MIN)
8696 if ((nv >= ((long double)1/DBL_MAX)) ||
8697 (nv <= (-(long double)1/DBL_MAX)))
8699 fix_ldbl_sprintf_bug = TRUE;
8702 if (fix_ldbl_sprintf_bug == TRUE) {
8712 # undef MY_DBL_MAX_BUG
8715 #endif /* HAS_LDBL_SPRINTF_BUG */
8717 need += 20; /* fudge factor */
8718 if (PL_efloatsize < need) {
8719 Safefree(PL_efloatbuf);
8720 PL_efloatsize = need + 20; /* more fudge */
8721 Newx(PL_efloatbuf, PL_efloatsize, char);
8722 PL_efloatbuf[0] = '\0';
8725 if ( !(width || left || plus || alt) && fill != '0'
8726 && has_precis && intsize != 'q' ) { /* Shortcuts */
8727 /* See earlier comment about buggy Gconvert when digits,
8729 if ( c == 'g' && precis) {
8730 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8731 /* May return an empty string for digits==0 */
8732 if (*PL_efloatbuf) {
8733 elen = strlen(PL_efloatbuf);
8734 goto float_converted;
8736 } else if ( c == 'f' && !precis) {
8737 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8742 char *ptr = ebuf + sizeof ebuf;
8745 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8746 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8747 if (intsize == 'q') {
8748 /* Copy the one or more characters in a long double
8749 * format before the 'base' ([efgEFG]) character to
8750 * the format string. */
8751 static char const prifldbl[] = PERL_PRIfldbl;
8752 char const *p = prifldbl + sizeof(prifldbl) - 3;
8753 while (p >= prifldbl) { *--ptr = *p--; }
8758 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8763 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8775 /* No taint. Otherwise we are in the strange situation
8776 * where printf() taints but print($float) doesn't.
8778 #if defined(HAS_LONG_DOUBLE)
8779 elen = ((intsize == 'q')
8780 ? my_sprintf(PL_efloatbuf, ptr, nv)
8781 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8783 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8787 eptr = PL_efloatbuf;
8793 i = SvCUR(sv) - origlen;
8794 if (args && !vectorize) {
8796 case 'h': *(va_arg(*args, short*)) = i; break;
8797 default: *(va_arg(*args, int*)) = i; break;
8798 case 'l': *(va_arg(*args, long*)) = i; break;
8799 case 'V': *(va_arg(*args, IV*)) = i; break;
8801 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8806 sv_setuv_mg(argsv, (UV)i);
8808 continue; /* not "break" */
8815 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8816 && ckWARN(WARN_PRINTF))
8818 SV * const msg = sv_newmortal();
8819 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8820 (PL_op->op_type == OP_PRTF) ? "" : "s");
8823 Perl_sv_catpvf(aTHX_ msg,
8824 "\"%%%c\"", c & 0xFF);
8826 Perl_sv_catpvf(aTHX_ msg,
8827 "\"%%\\%03"UVof"\"",
8830 sv_catpv(msg, "end of string");
8831 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8834 /* output mangled stuff ... */
8840 /* ... right here, because formatting flags should not apply */
8841 SvGROW(sv, SvCUR(sv) + elen + 1);
8843 Copy(eptr, p, elen, char);
8846 SvCUR_set(sv, p - SvPVX_const(sv));
8848 continue; /* not "break" */
8851 /* calculate width before utf8_upgrade changes it */
8852 have = esignlen + zeros + elen;
8854 Perl_croak_nocontext(PL_memory_wrap);
8856 if (is_utf8 != has_utf8) {
8859 sv_utf8_upgrade(sv);
8862 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8863 sv_utf8_upgrade(nsv);
8864 eptr = SvPVX_const(nsv);
8867 SvGROW(sv, SvCUR(sv) + elen + 1);
8872 need = (have > width ? have : width);
8875 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8876 Perl_croak_nocontext(PL_memory_wrap);
8877 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8879 if (esignlen && fill == '0') {
8881 for (i = 0; i < (int)esignlen; i++)
8885 memset(p, fill, gap);
8888 if (esignlen && fill != '0') {
8890 for (i = 0; i < (int)esignlen; i++)
8895 for (i = zeros; i; i--)
8899 Copy(eptr, p, elen, char);
8903 memset(p, ' ', gap);
8908 Copy(dotstr, p, dotstrlen, char);
8912 vectorize = FALSE; /* done iterating over vecstr */
8919 SvCUR_set(sv, p - SvPVX_const(sv));
8927 /* =========================================================================
8929 =head1 Cloning an interpreter
8931 All the macros and functions in this section are for the private use of
8932 the main function, perl_clone().
8934 The foo_dup() functions make an exact copy of an existing foo thinngy.
8935 During the course of a cloning, a hash table is used to map old addresses
8936 to new addresses. The table is created and manipulated with the
8937 ptr_table_* functions.
8941 ============================================================================*/
8944 #if defined(USE_ITHREADS)
8946 #ifndef GpREFCNT_inc
8947 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8951 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8952 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8953 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8954 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8955 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8956 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8957 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8958 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8959 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8960 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8961 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8962 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8963 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8966 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8967 regcomp.c. AMS 20010712 */
8970 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8975 struct reg_substr_datum *s;
8978 return (REGEXP *)NULL;
8980 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8983 len = r->offsets[0];
8984 npar = r->nparens+1;
8986 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8987 Copy(r->program, ret->program, len+1, regnode);
8989 Newx(ret->startp, npar, I32);
8990 Copy(r->startp, ret->startp, npar, I32);
8991 Newx(ret->endp, npar, I32);
8992 Copy(r->startp, ret->startp, npar, I32);
8994 Newx(ret->substrs, 1, struct reg_substr_data);
8995 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8996 s->min_offset = r->substrs->data[i].min_offset;
8997 s->max_offset = r->substrs->data[i].max_offset;
8998 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
8999 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9002 ret->regstclass = NULL;
9005 const int count = r->data->count;
9008 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9009 char, struct reg_data);
9010 Newx(d->what, count, U8);
9013 for (i = 0; i < count; i++) {
9014 d->what[i] = r->data->what[i];
9015 switch (d->what[i]) {
9016 /* legal options are one of: sfpont
9017 see also regcomp.h and pregfree() */
9019 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9022 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9025 /* This is cheating. */
9026 Newx(d->data[i], 1, struct regnode_charclass_class);
9027 StructCopy(r->data->data[i], d->data[i],
9028 struct regnode_charclass_class);
9029 ret->regstclass = (regnode*)d->data[i];
9032 /* Compiled op trees are readonly, and can thus be
9033 shared without duplication. */
9035 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9039 d->data[i] = r->data->data[i];
9042 d->data[i] = r->data->data[i];
9044 ((reg_trie_data*)d->data[i])->refcount++;
9048 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9057 Newx(ret->offsets, 2*len+1, U32);
9058 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9060 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9061 ret->refcnt = r->refcnt;
9062 ret->minlen = r->minlen;
9063 ret->prelen = r->prelen;
9064 ret->nparens = r->nparens;
9065 ret->lastparen = r->lastparen;
9066 ret->lastcloseparen = r->lastcloseparen;
9067 ret->reganch = r->reganch;
9069 ret->sublen = r->sublen;
9071 if (RX_MATCH_COPIED(ret))
9072 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9074 ret->subbeg = Nullch;
9075 #ifdef PERL_OLD_COPY_ON_WRITE
9076 ret->saved_copy = Nullsv;
9079 ptr_table_store(PL_ptr_table, r, ret);
9083 /* duplicate a file handle */
9086 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9090 PERL_UNUSED_ARG(type);
9093 return (PerlIO*)NULL;
9095 /* look for it in the table first */
9096 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9100 /* create anew and remember what it is */
9101 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9102 ptr_table_store(PL_ptr_table, fp, ret);
9106 /* duplicate a directory handle */
9109 Perl_dirp_dup(pTHX_ DIR *dp)
9117 /* duplicate a typeglob */
9120 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9125 /* look for it in the table first */
9126 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9130 /* create anew and remember what it is */
9132 ptr_table_store(PL_ptr_table, gp, ret);
9135 ret->gp_refcnt = 0; /* must be before any other dups! */
9136 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9137 ret->gp_io = io_dup_inc(gp->gp_io, param);
9138 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9139 ret->gp_av = av_dup_inc(gp->gp_av, param);
9140 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9141 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9142 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9143 ret->gp_cvgen = gp->gp_cvgen;
9144 ret->gp_line = gp->gp_line;
9145 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9149 /* duplicate a chain of magic */
9152 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9154 MAGIC *mgprev = (MAGIC*)NULL;
9157 return (MAGIC*)NULL;
9158 /* look for it in the table first */
9159 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9163 for (; mg; mg = mg->mg_moremagic) {
9165 Newxz(nmg, 1, MAGIC);
9167 mgprev->mg_moremagic = nmg;
9170 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9171 nmg->mg_private = mg->mg_private;
9172 nmg->mg_type = mg->mg_type;
9173 nmg->mg_flags = mg->mg_flags;
9174 if (mg->mg_type == PERL_MAGIC_qr) {
9175 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9177 else if(mg->mg_type == PERL_MAGIC_backref) {
9178 const AV * const av = (AV*) mg->mg_obj;
9181 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9183 for (i = AvFILLp(av); i >= 0; i--) {
9184 if (!svp[i]) continue;
9185 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9188 else if (mg->mg_type == PERL_MAGIC_symtab) {
9189 nmg->mg_obj = mg->mg_obj;
9192 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9193 ? sv_dup_inc(mg->mg_obj, param)
9194 : sv_dup(mg->mg_obj, param);
9196 nmg->mg_len = mg->mg_len;
9197 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9198 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9199 if (mg->mg_len > 0) {
9200 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9201 if (mg->mg_type == PERL_MAGIC_overload_table &&
9202 AMT_AMAGIC((AMT*)mg->mg_ptr))
9204 AMT * const amtp = (AMT*)mg->mg_ptr;
9205 AMT * const namtp = (AMT*)nmg->mg_ptr;
9207 for (i = 1; i < NofAMmeth; i++) {
9208 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9212 else if (mg->mg_len == HEf_SVKEY)
9213 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9215 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9216 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9223 /* create a new pointer-mapping table */
9226 Perl_ptr_table_new(pTHX)
9229 Newxz(tbl, 1, PTR_TBL_t);
9232 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9237 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9239 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9243 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9244 following define) and at call to new_body_inline made below in
9245 Perl_ptr_table_store()
9248 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9250 /* map an existing pointer using a table */
9253 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9255 PTR_TBL_ENT_t *tblent;
9256 const UV hash = PTR_TABLE_HASH(sv);
9258 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9259 for (; tblent; tblent = tblent->next) {
9260 if (tblent->oldval == sv)
9261 return tblent->newval;
9266 /* add a new entry to a pointer-mapping table */
9269 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9271 PTR_TBL_ENT_t *tblent, **otblent;
9272 /* XXX this may be pessimal on platforms where pointers aren't good
9273 * hash values e.g. if they grow faster in the most significant
9275 const UV hash = PTR_TABLE_HASH(oldsv);
9279 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9280 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9281 if (tblent->oldval == oldsv) {
9282 tblent->newval = newsv;
9286 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9287 tblent->oldval = oldsv;
9288 tblent->newval = newsv;
9289 tblent->next = *otblent;
9292 if (!empty && tbl->tbl_items > tbl->tbl_max)
9293 ptr_table_split(tbl);
9296 /* double the hash bucket size of an existing ptr table */
9299 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9301 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9302 const UV oldsize = tbl->tbl_max + 1;
9303 UV newsize = oldsize * 2;
9306 Renew(ary, newsize, PTR_TBL_ENT_t*);
9307 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9308 tbl->tbl_max = --newsize;
9310 for (i=0; i < oldsize; i++, ary++) {
9311 PTR_TBL_ENT_t **curentp, **entp, *ent;
9314 curentp = ary + oldsize;
9315 for (entp = ary, ent = *ary; ent; ent = *entp) {
9316 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9318 ent->next = *curentp;
9328 /* remove all the entries from a ptr table */
9331 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9333 register PTR_TBL_ENT_t **array;
9334 register PTR_TBL_ENT_t *entry;
9338 if (!tbl || !tbl->tbl_items) {
9342 array = tbl->tbl_ary;
9348 PTR_TBL_ENT_t *oentry = entry;
9349 entry = entry->next;
9353 if (++riter > max) {
9356 entry = array[riter];
9363 /* clear and free a ptr table */
9366 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9371 ptr_table_clear(tbl);
9372 Safefree(tbl->tbl_ary);
9378 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9381 SvRV_set(dstr, SvWEAKREF(sstr)
9382 ? sv_dup(SvRV(sstr), param)
9383 : sv_dup_inc(SvRV(sstr), param));
9386 else if (SvPVX_const(sstr)) {
9387 /* Has something there */
9389 /* Normal PV - clone whole allocated space */
9390 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9391 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9392 /* Not that normal - actually sstr is copy on write.
9393 But we are a true, independant SV, so: */
9394 SvREADONLY_off(dstr);
9399 /* Special case - not normally malloced for some reason */
9400 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9401 /* A "shared" PV - clone it as "shared" PV */
9403 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9407 /* Some other special case - random pointer */
9408 SvPV_set(dstr, SvPVX(sstr));
9414 if (SvTYPE(dstr) == SVt_RV)
9415 SvRV_set(dstr, NULL);
9421 /* duplicate an SV of any type (including AV, HV etc) */
9424 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9429 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9431 /* look for it in the table first */
9432 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9436 if(param->flags & CLONEf_JOIN_IN) {
9437 /** We are joining here so we don't want do clone
9438 something that is bad **/
9441 if(SvTYPE(sstr) == SVt_PVHV &&
9442 (hvname = HvNAME_get(sstr))) {
9443 /** don't clone stashes if they already exist **/
9444 return (SV*)gv_stashpv(hvname,0);
9448 /* create anew and remember what it is */
9451 #ifdef DEBUG_LEAKING_SCALARS
9452 dstr->sv_debug_optype = sstr->sv_debug_optype;
9453 dstr->sv_debug_line = sstr->sv_debug_line;
9454 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9455 dstr->sv_debug_cloned = 1;
9457 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9459 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9463 ptr_table_store(PL_ptr_table, sstr, dstr);
9466 SvFLAGS(dstr) = SvFLAGS(sstr);
9467 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9468 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9471 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9472 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9473 PL_watch_pvx, SvPVX_const(sstr));
9476 /* don't clone objects whose class has asked us not to */
9477 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9478 SvFLAGS(dstr) &= ~SVTYPEMASK;
9483 switch (SvTYPE(sstr)) {
9488 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9489 SvIV_set(dstr, SvIVX(sstr));
9492 SvANY(dstr) = new_XNV();
9493 SvNV_set(dstr, SvNVX(sstr));
9496 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9497 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9501 /* These are all the types that need complex bodies allocating. */
9503 const svtype sv_type = SvTYPE(sstr);
9504 const struct body_details *const sv_type_details
9505 = bodies_by_type + sv_type;
9509 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9514 if (GvUNIQUE((GV*)sstr)) {
9515 /* Do sharing here, and fall through */
9528 assert(sv_type_details->copy);
9529 if (sv_type_details->arena) {
9530 new_body_inline(new_body, sv_type_details->copy, sv_type);
9532 = (void*)((char*)new_body - sv_type_details->offset);
9534 new_body = new_NOARENA(sv_type_details);
9538 SvANY(dstr) = new_body;
9541 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9542 ((char*)SvANY(dstr)) + sv_type_details->offset,
9543 sv_type_details->copy, char);
9545 Copy(((char*)SvANY(sstr)),
9546 ((char*)SvANY(dstr)),
9547 sv_type_details->size + sv_type_details->offset, char);
9550 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9551 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9553 /* The Copy above means that all the source (unduplicated) pointers
9554 are now in the destination. We can check the flags and the
9555 pointers in either, but it's possible that there's less cache
9556 missing by always going for the destination.
9557 FIXME - instrument and check that assumption */
9558 if (sv_type >= SVt_PVMG) {
9560 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9562 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9565 /* The cast silences a GCC warning about unhandled types. */
9566 switch ((int)sv_type) {
9578 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9579 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9580 LvTARG(dstr) = dstr;
9581 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9582 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9584 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9587 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9588 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9589 /* Don't call sv_add_backref here as it's going to be created
9590 as part of the magic cloning of the symbol table. */
9591 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9592 (void)GpREFCNT_inc(GvGP(dstr));
9595 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9596 if (IoOFP(dstr) == IoIFP(sstr))
9597 IoOFP(dstr) = IoIFP(dstr);
9599 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9600 /* PL_rsfp_filters entries have fake IoDIRP() */
9601 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9602 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9603 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9604 /* I have no idea why fake dirp (rsfps)
9605 should be treated differently but otherwise
9606 we end up with leaks -- sky*/
9607 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9608 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9609 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9611 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9612 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9613 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9615 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9616 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9617 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9620 if (AvARRAY((AV*)sstr)) {
9621 SV **dst_ary, **src_ary;
9622 SSize_t items = AvFILLp((AV*)sstr) + 1;
9624 src_ary = AvARRAY((AV*)sstr);
9625 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9626 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9627 SvPV_set(dstr, (char*)dst_ary);
9628 AvALLOC((AV*)dstr) = dst_ary;
9629 if (AvREAL((AV*)sstr)) {
9631 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9635 *dst_ary++ = sv_dup(*src_ary++, param);
9637 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9638 while (items-- > 0) {
9639 *dst_ary++ = &PL_sv_undef;
9643 SvPV_set(dstr, Nullch);
9644 AvALLOC((AV*)dstr) = (SV**)NULL;
9651 if (HvARRAY((HV*)sstr)) {
9653 const bool sharekeys = !!HvSHAREKEYS(sstr);
9654 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9655 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9657 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9658 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9660 HvARRAY(dstr) = (HE**)darray;
9661 while (i <= sxhv->xhv_max) {
9662 const HE *source = HvARRAY(sstr)[i];
9663 HvARRAY(dstr)[i] = source
9664 ? he_dup(source, sharekeys, param) : 0;
9668 struct xpvhv_aux *saux = HvAUX(sstr);
9669 struct xpvhv_aux *daux = HvAUX(dstr);
9670 /* This flag isn't copied. */
9671 /* SvOOK_on(hv) attacks the IV flags. */
9672 SvFLAGS(dstr) |= SVf_OOK;
9674 hvname = saux->xhv_name;
9676 = hvname ? hek_dup(hvname, param) : hvname;
9678 daux->xhv_riter = saux->xhv_riter;
9679 daux->xhv_eiter = saux->xhv_eiter
9680 ? he_dup(saux->xhv_eiter,
9681 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9685 SvPV_set(dstr, Nullch);
9687 /* Record stashes for possible cloning in Perl_clone(). */
9689 av_push(param->stashes, dstr);
9694 /* NOTE: not refcounted */
9695 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9697 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9699 if (CvCONST(dstr)) {
9700 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9701 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9702 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9704 /* don't dup if copying back - CvGV isn't refcounted, so the
9705 * duped GV may never be freed. A bit of a hack! DAPM */
9706 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9707 Nullgv : gv_dup(CvGV(dstr), param) ;
9708 if (!(param->flags & CLONEf_COPY_STACKS)) {
9711 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9714 ? cv_dup( CvOUTSIDE(dstr), param)
9715 : cv_dup_inc(CvOUTSIDE(dstr), param);
9717 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9723 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9729 /* duplicate a context */
9732 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9737 return (PERL_CONTEXT*)NULL;
9739 /* look for it in the table first */
9740 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9744 /* create anew and remember what it is */
9745 Newxz(ncxs, max + 1, PERL_CONTEXT);
9746 ptr_table_store(PL_ptr_table, cxs, ncxs);
9749 PERL_CONTEXT *cx = &cxs[ix];
9750 PERL_CONTEXT *ncx = &ncxs[ix];
9751 ncx->cx_type = cx->cx_type;
9752 if (CxTYPE(cx) == CXt_SUBST) {
9753 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9756 ncx->blk_oldsp = cx->blk_oldsp;
9757 ncx->blk_oldcop = cx->blk_oldcop;
9758 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9759 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9760 ncx->blk_oldpm = cx->blk_oldpm;
9761 ncx->blk_gimme = cx->blk_gimme;
9762 switch (CxTYPE(cx)) {
9764 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9765 ? cv_dup_inc(cx->blk_sub.cv, param)
9766 : cv_dup(cx->blk_sub.cv,param));
9767 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9768 ? av_dup_inc(cx->blk_sub.argarray, param)
9770 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9771 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9772 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9773 ncx->blk_sub.lval = cx->blk_sub.lval;
9774 ncx->blk_sub.retop = cx->blk_sub.retop;
9777 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9778 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9779 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9780 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9781 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9782 ncx->blk_eval.retop = cx->blk_eval.retop;
9785 ncx->blk_loop.label = cx->blk_loop.label;
9786 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9787 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9788 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9789 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9790 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9791 ? cx->blk_loop.iterdata
9792 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9793 ncx->blk_loop.oldcomppad
9794 = (PAD*)ptr_table_fetch(PL_ptr_table,
9795 cx->blk_loop.oldcomppad);
9796 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9797 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9798 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9799 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9800 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9803 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9804 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9805 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9806 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9807 ncx->blk_sub.retop = cx->blk_sub.retop;
9819 /* duplicate a stack info structure */
9822 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9827 return (PERL_SI*)NULL;
9829 /* look for it in the table first */
9830 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9834 /* create anew and remember what it is */
9835 Newxz(nsi, 1, PERL_SI);
9836 ptr_table_store(PL_ptr_table, si, nsi);
9838 nsi->si_stack = av_dup_inc(si->si_stack, param);
9839 nsi->si_cxix = si->si_cxix;
9840 nsi->si_cxmax = si->si_cxmax;
9841 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9842 nsi->si_type = si->si_type;
9843 nsi->si_prev = si_dup(si->si_prev, param);
9844 nsi->si_next = si_dup(si->si_next, param);
9845 nsi->si_markoff = si->si_markoff;
9850 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9851 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9852 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9853 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9854 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9855 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9856 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9857 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9858 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9859 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9860 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9861 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9862 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9863 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9866 #define pv_dup_inc(p) SAVEPV(p)
9867 #define pv_dup(p) SAVEPV(p)
9868 #define svp_dup_inc(p,pp) any_dup(p,pp)
9870 /* map any object to the new equivent - either something in the
9871 * ptr table, or something in the interpreter structure
9875 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9882 /* look for it in the table first */
9883 ret = ptr_table_fetch(PL_ptr_table, v);
9887 /* see if it is part of the interpreter structure */
9888 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9889 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9897 /* duplicate the save stack */
9900 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9902 ANY * const ss = proto_perl->Tsavestack;
9903 const I32 max = proto_perl->Tsavestack_max;
9904 I32 ix = proto_perl->Tsavestack_ix;
9916 void (*dptr) (void*);
9917 void (*dxptr) (pTHX_ void*);
9919 Newxz(nss, max, ANY);
9922 I32 i = POPINT(ss,ix);
9925 case SAVEt_ITEM: /* normal string */
9926 sv = (SV*)POPPTR(ss,ix);
9927 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9928 sv = (SV*)POPPTR(ss,ix);
9929 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9931 case SAVEt_SV: /* scalar reference */
9932 sv = (SV*)POPPTR(ss,ix);
9933 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9934 gv = (GV*)POPPTR(ss,ix);
9935 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9937 case SAVEt_GENERIC_PVREF: /* generic char* */
9938 c = (char*)POPPTR(ss,ix);
9939 TOPPTR(nss,ix) = pv_dup(c);
9940 ptr = POPPTR(ss,ix);
9941 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9943 case SAVEt_SHARED_PVREF: /* char* in shared space */
9944 c = (char*)POPPTR(ss,ix);
9945 TOPPTR(nss,ix) = savesharedpv(c);
9946 ptr = POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9949 case SAVEt_GENERIC_SVREF: /* generic sv */
9950 case SAVEt_SVREF: /* scalar reference */
9951 sv = (SV*)POPPTR(ss,ix);
9952 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9953 ptr = POPPTR(ss,ix);
9954 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9956 case SAVEt_AV: /* array reference */
9957 av = (AV*)POPPTR(ss,ix);
9958 TOPPTR(nss,ix) = av_dup_inc(av, param);
9959 gv = (GV*)POPPTR(ss,ix);
9960 TOPPTR(nss,ix) = gv_dup(gv, param);
9962 case SAVEt_HV: /* hash reference */
9963 hv = (HV*)POPPTR(ss,ix);
9964 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9965 gv = (GV*)POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = gv_dup(gv, param);
9968 case SAVEt_INT: /* int reference */
9969 ptr = POPPTR(ss,ix);
9970 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9971 intval = (int)POPINT(ss,ix);
9972 TOPINT(nss,ix) = intval;
9974 case SAVEt_LONG: /* long reference */
9975 ptr = POPPTR(ss,ix);
9976 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9977 longval = (long)POPLONG(ss,ix);
9978 TOPLONG(nss,ix) = longval;
9980 case SAVEt_I32: /* I32 reference */
9981 case SAVEt_I16: /* I16 reference */
9982 case SAVEt_I8: /* I8 reference */
9983 ptr = POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9988 case SAVEt_IV: /* IV reference */
9989 ptr = POPPTR(ss,ix);
9990 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9994 case SAVEt_SPTR: /* SV* reference */
9995 ptr = POPPTR(ss,ix);
9996 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9997 sv = (SV*)POPPTR(ss,ix);
9998 TOPPTR(nss,ix) = sv_dup(sv, param);
10000 case SAVEt_VPTR: /* random* reference */
10001 ptr = POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10003 ptr = POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10006 case SAVEt_PPTR: /* char* reference */
10007 ptr = POPPTR(ss,ix);
10008 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10009 c = (char*)POPPTR(ss,ix);
10010 TOPPTR(nss,ix) = pv_dup(c);
10012 case SAVEt_HPTR: /* HV* reference */
10013 ptr = POPPTR(ss,ix);
10014 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10015 hv = (HV*)POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = hv_dup(hv, param);
10018 case SAVEt_APTR: /* AV* reference */
10019 ptr = POPPTR(ss,ix);
10020 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10021 av = (AV*)POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = av_dup(av, param);
10025 gv = (GV*)POPPTR(ss,ix);
10026 TOPPTR(nss,ix) = gv_dup(gv, param);
10028 case SAVEt_GP: /* scalar reference */
10029 gp = (GP*)POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10031 (void)GpREFCNT_inc(gp);
10032 gv = (GV*)POPPTR(ss,ix);
10033 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10034 c = (char*)POPPTR(ss,ix);
10035 TOPPTR(nss,ix) = pv_dup(c);
10037 TOPIV(nss,ix) = iv;
10039 TOPIV(nss,ix) = iv;
10042 case SAVEt_MORTALIZESV:
10043 sv = (SV*)POPPTR(ss,ix);
10044 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10047 ptr = POPPTR(ss,ix);
10048 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10049 /* these are assumed to be refcounted properly */
10051 switch (((OP*)ptr)->op_type) {
10053 case OP_LEAVESUBLV:
10057 case OP_LEAVEWRITE:
10058 TOPPTR(nss,ix) = ptr;
10063 TOPPTR(nss,ix) = Nullop;
10068 TOPPTR(nss,ix) = Nullop;
10071 c = (char*)POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = pv_dup_inc(c);
10074 case SAVEt_CLEARSV:
10075 longval = POPLONG(ss,ix);
10076 TOPLONG(nss,ix) = longval;
10079 hv = (HV*)POPPTR(ss,ix);
10080 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10081 c = (char*)POPPTR(ss,ix);
10082 TOPPTR(nss,ix) = pv_dup_inc(c);
10084 TOPINT(nss,ix) = i;
10086 case SAVEt_DESTRUCTOR:
10087 ptr = POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10089 dptr = POPDPTR(ss,ix);
10090 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10091 any_dup(FPTR2DPTR(void *, dptr),
10094 case SAVEt_DESTRUCTOR_X:
10095 ptr = POPPTR(ss,ix);
10096 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10097 dxptr = POPDXPTR(ss,ix);
10098 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10099 any_dup(FPTR2DPTR(void *, dxptr),
10102 case SAVEt_REGCONTEXT:
10105 TOPINT(nss,ix) = i;
10108 case SAVEt_STACK_POS: /* Position on Perl stack */
10110 TOPINT(nss,ix) = i;
10112 case SAVEt_AELEM: /* array element */
10113 sv = (SV*)POPPTR(ss,ix);
10114 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10116 TOPINT(nss,ix) = i;
10117 av = (AV*)POPPTR(ss,ix);
10118 TOPPTR(nss,ix) = av_dup_inc(av, param);
10120 case SAVEt_HELEM: /* hash element */
10121 sv = (SV*)POPPTR(ss,ix);
10122 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10123 sv = (SV*)POPPTR(ss,ix);
10124 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10125 hv = (HV*)POPPTR(ss,ix);
10126 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10129 ptr = POPPTR(ss,ix);
10130 TOPPTR(nss,ix) = ptr;
10134 TOPINT(nss,ix) = i;
10136 case SAVEt_COMPPAD:
10137 av = (AV*)POPPTR(ss,ix);
10138 TOPPTR(nss,ix) = av_dup(av, param);
10141 longval = (long)POPLONG(ss,ix);
10142 TOPLONG(nss,ix) = longval;
10143 ptr = POPPTR(ss,ix);
10144 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10145 sv = (SV*)POPPTR(ss,ix);
10146 TOPPTR(nss,ix) = sv_dup(sv, param);
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10151 longval = (long)POPBOOL(ss,ix);
10152 TOPBOOL(nss,ix) = (bool)longval;
10154 case SAVEt_SET_SVFLAGS:
10156 TOPINT(nss,ix) = i;
10158 TOPINT(nss,ix) = i;
10159 sv = (SV*)POPPTR(ss,ix);
10160 TOPPTR(nss,ix) = sv_dup(sv, param);
10163 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10171 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10172 * flag to the result. This is done for each stash before cloning starts,
10173 * so we know which stashes want their objects cloned */
10176 do_mark_cloneable_stash(pTHX_ SV *sv)
10178 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10180 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10181 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10182 if (cloner && GvCV(cloner)) {
10189 XPUSHs(sv_2mortal(newSVhek(hvname)));
10191 call_sv((SV*)GvCV(cloner), G_SCALAR);
10198 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10206 =for apidoc perl_clone
10208 Create and return a new interpreter by cloning the current one.
10210 perl_clone takes these flags as parameters:
10212 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10213 without it we only clone the data and zero the stacks,
10214 with it we copy the stacks and the new perl interpreter is
10215 ready to run at the exact same point as the previous one.
10216 The pseudo-fork code uses COPY_STACKS while the
10217 threads->new doesn't.
10219 CLONEf_KEEP_PTR_TABLE
10220 perl_clone keeps a ptr_table with the pointer of the old
10221 variable as a key and the new variable as a value,
10222 this allows it to check if something has been cloned and not
10223 clone it again but rather just use the value and increase the
10224 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10225 the ptr_table using the function
10226 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10227 reason to keep it around is if you want to dup some of your own
10228 variable who are outside the graph perl scans, example of this
10229 code is in threads.xs create
10232 This is a win32 thing, it is ignored on unix, it tells perls
10233 win32host code (which is c++) to clone itself, this is needed on
10234 win32 if you want to run two threads at the same time,
10235 if you just want to do some stuff in a separate perl interpreter
10236 and then throw it away and return to the original one,
10237 you don't need to do anything.
10242 /* XXX the above needs expanding by someone who actually understands it ! */
10243 EXTERN_C PerlInterpreter *
10244 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10247 perl_clone(PerlInterpreter *proto_perl, UV flags)
10250 #ifdef PERL_IMPLICIT_SYS
10252 /* perlhost.h so we need to call into it
10253 to clone the host, CPerlHost should have a c interface, sky */
10255 if (flags & CLONEf_CLONE_HOST) {
10256 return perl_clone_host(proto_perl,flags);
10258 return perl_clone_using(proto_perl, flags,
10260 proto_perl->IMemShared,
10261 proto_perl->IMemParse,
10263 proto_perl->IStdIO,
10267 proto_perl->IProc);
10271 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10272 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10273 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10274 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10275 struct IPerlDir* ipD, struct IPerlSock* ipS,
10276 struct IPerlProc* ipP)
10278 /* XXX many of the string copies here can be optimized if they're
10279 * constants; they need to be allocated as common memory and just
10280 * their pointers copied. */
10283 CLONE_PARAMS clone_params;
10284 CLONE_PARAMS* param = &clone_params;
10286 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10287 /* for each stash, determine whether its objects should be cloned */
10288 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10289 PERL_SET_THX(my_perl);
10292 Poison(my_perl, 1, PerlInterpreter);
10294 PL_curcop = (COP *)Nullop;
10298 PL_savestack_ix = 0;
10299 PL_savestack_max = -1;
10300 PL_sig_pending = 0;
10301 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10302 # else /* !DEBUGGING */
10303 Zero(my_perl, 1, PerlInterpreter);
10304 # endif /* DEBUGGING */
10306 /* host pointers */
10308 PL_MemShared = ipMS;
10309 PL_MemParse = ipMP;
10316 #else /* !PERL_IMPLICIT_SYS */
10318 CLONE_PARAMS clone_params;
10319 CLONE_PARAMS* param = &clone_params;
10320 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10321 /* for each stash, determine whether its objects should be cloned */
10322 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10323 PERL_SET_THX(my_perl);
10326 Poison(my_perl, 1, PerlInterpreter);
10328 PL_curcop = (COP *)Nullop;
10332 PL_savestack_ix = 0;
10333 PL_savestack_max = -1;
10334 PL_sig_pending = 0;
10335 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10336 # else /* !DEBUGGING */
10337 Zero(my_perl, 1, PerlInterpreter);
10338 # endif /* DEBUGGING */
10339 #endif /* PERL_IMPLICIT_SYS */
10340 param->flags = flags;
10341 param->proto_perl = proto_perl;
10343 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10344 Zero(&PL_body_roots, 1, PL_body_roots);
10346 PL_nice_chunk = NULL;
10347 PL_nice_chunk_size = 0;
10349 PL_sv_objcount = 0;
10350 PL_sv_root = Nullsv;
10351 PL_sv_arenaroot = Nullsv;
10353 PL_debug = proto_perl->Idebug;
10355 PL_hash_seed = proto_perl->Ihash_seed;
10356 PL_rehash_seed = proto_perl->Irehash_seed;
10358 #ifdef USE_REENTRANT_API
10359 /* XXX: things like -Dm will segfault here in perlio, but doing
10360 * PERL_SET_CONTEXT(proto_perl);
10361 * breaks too many other things
10363 Perl_reentrant_init(aTHX);
10366 /* create SV map for pointer relocation */
10367 PL_ptr_table = ptr_table_new();
10369 /* initialize these special pointers as early as possible */
10370 SvANY(&PL_sv_undef) = NULL;
10371 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10372 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10373 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10375 SvANY(&PL_sv_no) = new_XPVNV();
10376 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10377 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10378 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10379 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10380 SvCUR_set(&PL_sv_no, 0);
10381 SvLEN_set(&PL_sv_no, 1);
10382 SvIV_set(&PL_sv_no, 0);
10383 SvNV_set(&PL_sv_no, 0);
10384 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10386 SvANY(&PL_sv_yes) = new_XPVNV();
10387 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10388 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10389 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10390 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10391 SvCUR_set(&PL_sv_yes, 1);
10392 SvLEN_set(&PL_sv_yes, 2);
10393 SvIV_set(&PL_sv_yes, 1);
10394 SvNV_set(&PL_sv_yes, 1);
10395 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10397 /* create (a non-shared!) shared string table */
10398 PL_strtab = newHV();
10399 HvSHAREKEYS_off(PL_strtab);
10400 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10401 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10403 PL_compiling = proto_perl->Icompiling;
10405 /* These two PVs will be free'd special way so must set them same way op.c does */
10406 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10407 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10409 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10410 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10412 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10413 if (!specialWARN(PL_compiling.cop_warnings))
10414 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10415 if (!specialCopIO(PL_compiling.cop_io))
10416 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10417 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10419 /* pseudo environmental stuff */
10420 PL_origargc = proto_perl->Iorigargc;
10421 PL_origargv = proto_perl->Iorigargv;
10423 param->stashes = newAV(); /* Setup array of objects to call clone on */
10425 /* Set tainting stuff before PerlIO_debug can possibly get called */
10426 PL_tainting = proto_perl->Itainting;
10427 PL_taint_warn = proto_perl->Itaint_warn;
10429 #ifdef PERLIO_LAYERS
10430 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10431 PerlIO_clone(aTHX_ proto_perl, param);
10434 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10435 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10436 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10437 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10438 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10439 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10442 PL_minus_c = proto_perl->Iminus_c;
10443 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10444 PL_localpatches = proto_perl->Ilocalpatches;
10445 PL_splitstr = proto_perl->Isplitstr;
10446 PL_preprocess = proto_perl->Ipreprocess;
10447 PL_minus_n = proto_perl->Iminus_n;
10448 PL_minus_p = proto_perl->Iminus_p;
10449 PL_minus_l = proto_perl->Iminus_l;
10450 PL_minus_a = proto_perl->Iminus_a;
10451 PL_minus_F = proto_perl->Iminus_F;
10452 PL_doswitches = proto_perl->Idoswitches;
10453 PL_dowarn = proto_perl->Idowarn;
10454 PL_doextract = proto_perl->Idoextract;
10455 PL_sawampersand = proto_perl->Isawampersand;
10456 PL_unsafe = proto_perl->Iunsafe;
10457 PL_inplace = SAVEPV(proto_perl->Iinplace);
10458 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10459 PL_perldb = proto_perl->Iperldb;
10460 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10461 PL_exit_flags = proto_perl->Iexit_flags;
10463 /* magical thingies */
10464 /* XXX time(&PL_basetime) when asked for? */
10465 PL_basetime = proto_perl->Ibasetime;
10466 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10468 PL_maxsysfd = proto_perl->Imaxsysfd;
10469 PL_multiline = proto_perl->Imultiline;
10470 PL_statusvalue = proto_perl->Istatusvalue;
10472 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10474 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10476 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10478 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10479 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10480 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10482 /* Clone the regex array */
10483 PL_regex_padav = newAV();
10485 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10486 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10488 av_push(PL_regex_padav,
10489 sv_dup_inc(regexen[0],param));
10490 for(i = 1; i <= len; i++) {
10491 if(SvREPADTMP(regexen[i])) {
10492 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10494 av_push(PL_regex_padav,
10496 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10497 SvIVX(regexen[i])), param)))
10502 PL_regex_pad = AvARRAY(PL_regex_padav);
10504 /* shortcuts to various I/O objects */
10505 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10506 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10507 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10508 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10509 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10510 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10512 /* shortcuts to regexp stuff */
10513 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10515 /* shortcuts to misc objects */
10516 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10518 /* shortcuts to debugging objects */
10519 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10520 PL_DBline = gv_dup(proto_perl->IDBline, param);
10521 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10522 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10523 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10524 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10525 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10526 PL_lineary = av_dup(proto_perl->Ilineary, param);
10527 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10529 /* symbol tables */
10530 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10531 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10532 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10533 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10534 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10536 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10537 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10538 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10539 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10540 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10541 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10543 PL_sub_generation = proto_perl->Isub_generation;
10545 /* funky return mechanisms */
10546 PL_forkprocess = proto_perl->Iforkprocess;
10548 /* subprocess state */
10549 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10551 /* internal state */
10552 PL_maxo = proto_perl->Imaxo;
10553 if (proto_perl->Iop_mask)
10554 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10556 PL_op_mask = Nullch;
10557 /* PL_asserting = proto_perl->Iasserting; */
10559 /* current interpreter roots */
10560 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10561 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10562 PL_main_start = proto_perl->Imain_start;
10563 PL_eval_root = proto_perl->Ieval_root;
10564 PL_eval_start = proto_perl->Ieval_start;
10566 /* runtime control stuff */
10567 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10568 PL_copline = proto_perl->Icopline;
10570 PL_filemode = proto_perl->Ifilemode;
10571 PL_lastfd = proto_perl->Ilastfd;
10572 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10575 PL_gensym = proto_perl->Igensym;
10576 PL_preambled = proto_perl->Ipreambled;
10577 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10578 PL_laststatval = proto_perl->Ilaststatval;
10579 PL_laststype = proto_perl->Ilaststype;
10580 PL_mess_sv = Nullsv;
10582 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10584 /* interpreter atexit processing */
10585 PL_exitlistlen = proto_perl->Iexitlistlen;
10586 if (PL_exitlistlen) {
10587 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10588 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10591 PL_exitlist = (PerlExitListEntry*)NULL;
10592 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10593 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10594 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10596 PL_profiledata = NULL;
10597 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10598 /* PL_rsfp_filters entries have fake IoDIRP() */
10599 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10601 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10603 PAD_CLONE_VARS(proto_perl, param);
10605 #ifdef HAVE_INTERP_INTERN
10606 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10609 /* more statics moved here */
10610 PL_generation = proto_perl->Igeneration;
10611 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10613 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10614 PL_in_clean_all = proto_perl->Iin_clean_all;
10616 PL_uid = proto_perl->Iuid;
10617 PL_euid = proto_perl->Ieuid;
10618 PL_gid = proto_perl->Igid;
10619 PL_egid = proto_perl->Iegid;
10620 PL_nomemok = proto_perl->Inomemok;
10621 PL_an = proto_perl->Ian;
10622 PL_evalseq = proto_perl->Ievalseq;
10623 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10624 PL_origalen = proto_perl->Iorigalen;
10625 #ifdef PERL_USES_PL_PIDSTATUS
10626 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10628 PL_osname = SAVEPV(proto_perl->Iosname);
10629 PL_sighandlerp = proto_perl->Isighandlerp;
10631 PL_runops = proto_perl->Irunops;
10633 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10636 PL_cshlen = proto_perl->Icshlen;
10637 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10640 PL_lex_state = proto_perl->Ilex_state;
10641 PL_lex_defer = proto_perl->Ilex_defer;
10642 PL_lex_expect = proto_perl->Ilex_expect;
10643 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10644 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10645 PL_lex_starts = proto_perl->Ilex_starts;
10646 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10647 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10648 PL_lex_op = proto_perl->Ilex_op;
10649 PL_lex_inpat = proto_perl->Ilex_inpat;
10650 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10651 PL_lex_brackets = proto_perl->Ilex_brackets;
10652 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10653 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10654 PL_lex_casemods = proto_perl->Ilex_casemods;
10655 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10656 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10658 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10659 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10660 PL_nexttoke = proto_perl->Inexttoke;
10662 /* XXX This is probably masking the deeper issue of why
10663 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10664 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10665 * (A little debugging with a watchpoint on it may help.)
10667 if (SvANY(proto_perl->Ilinestr)) {
10668 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10669 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10670 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10671 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10672 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10673 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10674 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10675 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10676 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10679 PL_linestr = NEWSV(65,79);
10680 sv_upgrade(PL_linestr,SVt_PVIV);
10681 sv_setpvn(PL_linestr,"",0);
10682 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10684 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10685 PL_pending_ident = proto_perl->Ipending_ident;
10686 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10688 PL_expect = proto_perl->Iexpect;
10690 PL_multi_start = proto_perl->Imulti_start;
10691 PL_multi_end = proto_perl->Imulti_end;
10692 PL_multi_open = proto_perl->Imulti_open;
10693 PL_multi_close = proto_perl->Imulti_close;
10695 PL_error_count = proto_perl->Ierror_count;
10696 PL_subline = proto_perl->Isubline;
10697 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10699 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10700 if (SvANY(proto_perl->Ilinestr)) {
10701 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10702 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10703 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10704 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10705 PL_last_lop_op = proto_perl->Ilast_lop_op;
10708 PL_last_uni = SvPVX(PL_linestr);
10709 PL_last_lop = SvPVX(PL_linestr);
10710 PL_last_lop_op = 0;
10712 PL_in_my = proto_perl->Iin_my;
10713 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10715 PL_cryptseen = proto_perl->Icryptseen;
10718 PL_hints = proto_perl->Ihints;
10720 PL_amagic_generation = proto_perl->Iamagic_generation;
10722 #ifdef USE_LOCALE_COLLATE
10723 PL_collation_ix = proto_perl->Icollation_ix;
10724 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10725 PL_collation_standard = proto_perl->Icollation_standard;
10726 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10727 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10728 #endif /* USE_LOCALE_COLLATE */
10730 #ifdef USE_LOCALE_NUMERIC
10731 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10732 PL_numeric_standard = proto_perl->Inumeric_standard;
10733 PL_numeric_local = proto_perl->Inumeric_local;
10734 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10735 #endif /* !USE_LOCALE_NUMERIC */
10737 /* utf8 character classes */
10738 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10739 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10740 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10741 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10742 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10743 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10744 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10745 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10746 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10747 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10748 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10749 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10750 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10751 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10752 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10753 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10754 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10755 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10756 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10757 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10759 /* Did the locale setup indicate UTF-8? */
10760 PL_utf8locale = proto_perl->Iutf8locale;
10761 /* Unicode features (see perlrun/-C) */
10762 PL_unicode = proto_perl->Iunicode;
10764 /* Pre-5.8 signals control */
10765 PL_signals = proto_perl->Isignals;
10767 /* times() ticks per second */
10768 PL_clocktick = proto_perl->Iclocktick;
10770 /* Recursion stopper for PerlIO_find_layer */
10771 PL_in_load_module = proto_perl->Iin_load_module;
10773 /* sort() routine */
10774 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10776 /* Not really needed/useful since the reenrant_retint is "volatile",
10777 * but do it for consistency's sake. */
10778 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10780 /* Hooks to shared SVs and locks. */
10781 PL_sharehook = proto_perl->Isharehook;
10782 PL_lockhook = proto_perl->Ilockhook;
10783 PL_unlockhook = proto_perl->Iunlockhook;
10784 PL_threadhook = proto_perl->Ithreadhook;
10786 PL_runops_std = proto_perl->Irunops_std;
10787 PL_runops_dbg = proto_perl->Irunops_dbg;
10789 #ifdef THREADS_HAVE_PIDS
10790 PL_ppid = proto_perl->Ippid;
10794 PL_last_swash_hv = Nullhv; /* reinits on demand */
10795 PL_last_swash_klen = 0;
10796 PL_last_swash_key[0]= '\0';
10797 PL_last_swash_tmps = (U8*)NULL;
10798 PL_last_swash_slen = 0;
10800 PL_glob_index = proto_perl->Iglob_index;
10801 PL_srand_called = proto_perl->Isrand_called;
10802 PL_uudmap['M'] = 0; /* reinits on demand */
10803 PL_bitcount = Nullch; /* reinits on demand */
10805 if (proto_perl->Ipsig_pend) {
10806 Newxz(PL_psig_pend, SIG_SIZE, int);
10809 PL_psig_pend = (int*)NULL;
10812 if (proto_perl->Ipsig_ptr) {
10813 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10814 Newxz(PL_psig_name, SIG_SIZE, SV*);
10815 for (i = 1; i < SIG_SIZE; i++) {
10816 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10817 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10821 PL_psig_ptr = (SV**)NULL;
10822 PL_psig_name = (SV**)NULL;
10825 /* thrdvar.h stuff */
10827 if (flags & CLONEf_COPY_STACKS) {
10828 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10829 PL_tmps_ix = proto_perl->Ttmps_ix;
10830 PL_tmps_max = proto_perl->Ttmps_max;
10831 PL_tmps_floor = proto_perl->Ttmps_floor;
10832 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10834 while (i <= PL_tmps_ix) {
10835 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10839 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10840 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10841 Newxz(PL_markstack, i, I32);
10842 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10843 - proto_perl->Tmarkstack);
10844 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10845 - proto_perl->Tmarkstack);
10846 Copy(proto_perl->Tmarkstack, PL_markstack,
10847 PL_markstack_ptr - PL_markstack + 1, I32);
10849 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10850 * NOTE: unlike the others! */
10851 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10852 PL_scopestack_max = proto_perl->Tscopestack_max;
10853 Newxz(PL_scopestack, PL_scopestack_max, I32);
10854 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10856 /* NOTE: si_dup() looks at PL_markstack */
10857 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10859 /* PL_curstack = PL_curstackinfo->si_stack; */
10860 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10861 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10863 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10864 PL_stack_base = AvARRAY(PL_curstack);
10865 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10866 - proto_perl->Tstack_base);
10867 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10869 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10870 * NOTE: unlike the others! */
10871 PL_savestack_ix = proto_perl->Tsavestack_ix;
10872 PL_savestack_max = proto_perl->Tsavestack_max;
10873 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10874 PL_savestack = ss_dup(proto_perl, param);
10878 ENTER; /* perl_destruct() wants to LEAVE; */
10881 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10882 PL_top_env = &PL_start_env;
10884 PL_op = proto_perl->Top;
10887 PL_Xpv = (XPV*)NULL;
10888 PL_na = proto_perl->Tna;
10890 PL_statbuf = proto_perl->Tstatbuf;
10891 PL_statcache = proto_perl->Tstatcache;
10892 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10893 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10895 PL_timesbuf = proto_perl->Ttimesbuf;
10898 PL_tainted = proto_perl->Ttainted;
10899 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10900 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10901 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10902 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10903 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10904 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10905 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10906 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10907 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10909 PL_restartop = proto_perl->Trestartop;
10910 PL_in_eval = proto_perl->Tin_eval;
10911 PL_delaymagic = proto_perl->Tdelaymagic;
10912 PL_dirty = proto_perl->Tdirty;
10913 PL_localizing = proto_perl->Tlocalizing;
10915 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10916 PL_hv_fetch_ent_mh = Nullhe;
10917 PL_modcount = proto_perl->Tmodcount;
10918 PL_lastgotoprobe = Nullop;
10919 PL_dumpindent = proto_perl->Tdumpindent;
10921 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10922 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10923 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10924 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10925 PL_efloatbuf = Nullch; /* reinits on demand */
10926 PL_efloatsize = 0; /* reinits on demand */
10930 PL_screamfirst = NULL;
10931 PL_screamnext = NULL;
10932 PL_maxscream = -1; /* reinits on demand */
10933 PL_lastscream = Nullsv;
10935 PL_watchaddr = NULL;
10936 PL_watchok = Nullch;
10938 PL_regdummy = proto_perl->Tregdummy;
10939 PL_regprecomp = Nullch;
10942 PL_colorset = 0; /* reinits PL_colors[] */
10943 /*PL_colors[6] = {0,0,0,0,0,0};*/
10944 PL_reginput = Nullch;
10945 PL_regbol = Nullch;
10946 PL_regeol = Nullch;
10947 PL_regstartp = (I32*)NULL;
10948 PL_regendp = (I32*)NULL;
10949 PL_reglastparen = (U32*)NULL;
10950 PL_reglastcloseparen = (U32*)NULL;
10951 PL_regtill = Nullch;
10952 PL_reg_start_tmp = (char**)NULL;
10953 PL_reg_start_tmpl = 0;
10954 PL_regdata = (struct reg_data*)NULL;
10957 PL_reg_eval_set = 0;
10959 PL_regprogram = (regnode*)NULL;
10961 PL_regcc = (CURCUR*)NULL;
10962 PL_reg_call_cc = (struct re_cc_state*)NULL;
10963 PL_reg_re = (regexp*)NULL;
10964 PL_reg_ganch = Nullch;
10965 PL_reg_sv = Nullsv;
10966 PL_reg_match_utf8 = FALSE;
10967 PL_reg_magic = (MAGIC*)NULL;
10969 PL_reg_oldcurpm = (PMOP*)NULL;
10970 PL_reg_curpm = (PMOP*)NULL;
10971 PL_reg_oldsaved = Nullch;
10972 PL_reg_oldsavedlen = 0;
10973 #ifdef PERL_OLD_COPY_ON_WRITE
10976 PL_reg_maxiter = 0;
10977 PL_reg_leftiter = 0;
10978 PL_reg_poscache = Nullch;
10979 PL_reg_poscache_size= 0;
10981 /* RE engine - function pointers */
10982 PL_regcompp = proto_perl->Tregcompp;
10983 PL_regexecp = proto_perl->Tregexecp;
10984 PL_regint_start = proto_perl->Tregint_start;
10985 PL_regint_string = proto_perl->Tregint_string;
10986 PL_regfree = proto_perl->Tregfree;
10988 PL_reginterp_cnt = 0;
10989 PL_reg_starttry = 0;
10991 /* Pluggable optimizer */
10992 PL_peepp = proto_perl->Tpeepp;
10994 PL_stashcache = newHV();
10996 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
10997 ptr_table_free(PL_ptr_table);
10998 PL_ptr_table = NULL;
11001 /* Call the ->CLONE method, if it exists, for each of the stashes
11002 identified by sv_dup() above.
11004 while(av_len(param->stashes) != -1) {
11005 HV* const stash = (HV*) av_shift(param->stashes);
11006 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11007 if (cloner && GvCV(cloner)) {
11012 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11014 call_sv((SV*)GvCV(cloner), G_DISCARD);
11020 SvREFCNT_dec(param->stashes);
11022 /* orphaned? eg threads->new inside BEGIN or use */
11023 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11024 (void)SvREFCNT_inc(PL_compcv);
11025 SAVEFREESV(PL_compcv);
11031 #endif /* USE_ITHREADS */
11034 =head1 Unicode Support
11036 =for apidoc sv_recode_to_utf8
11038 The encoding is assumed to be an Encode object, on entry the PV
11039 of the sv is assumed to be octets in that encoding, and the sv
11040 will be converted into Unicode (and UTF-8).
11042 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11043 is not a reference, nothing is done to the sv. If the encoding is not
11044 an C<Encode::XS> Encoding object, bad things will happen.
11045 (See F<lib/encoding.pm> and L<Encode>).
11047 The PV of the sv is returned.
11052 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11055 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11069 Passing sv_yes is wrong - it needs to be or'ed set of constants
11070 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11071 remove converted chars from source.
11073 Both will default the value - let them.
11075 XPUSHs(&PL_sv_yes);
11078 call_method("decode", G_SCALAR);
11082 s = SvPV_const(uni, len);
11083 if (s != SvPVX_const(sv)) {
11084 SvGROW(sv, len + 1);
11085 Move(s, SvPVX(sv), len + 1, char);
11086 SvCUR_set(sv, len);
11093 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11097 =for apidoc sv_cat_decode
11099 The encoding is assumed to be an Encode object, the PV of the ssv is
11100 assumed to be octets in that encoding and decoding the input starts
11101 from the position which (PV + *offset) pointed to. The dsv will be
11102 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11103 when the string tstr appears in decoding output or the input ends on
11104 the PV of the ssv. The value which the offset points will be modified
11105 to the last input position on the ssv.
11107 Returns TRUE if the terminator was found, else returns FALSE.
11112 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11113 SV *ssv, int *offset, char *tstr, int tlen)
11117 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11128 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11129 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11131 call_method("cat_decode", G_SCALAR);
11133 ret = SvTRUE(TOPs);
11134 *offset = SvIV(offsv);
11140 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11145 /* ---------------------------------------------------------------------
11147 * support functions for report_uninit()
11150 /* the maxiumum size of array or hash where we will scan looking
11151 * for the undefined element that triggered the warning */
11153 #define FUV_MAX_SEARCH_SIZE 1000
11155 /* Look for an entry in the hash whose value has the same SV as val;
11156 * If so, return a mortal copy of the key. */
11159 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11162 register HE **array;
11165 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11166 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11169 array = HvARRAY(hv);
11171 for (i=HvMAX(hv); i>0; i--) {
11172 register HE *entry;
11173 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11174 if (HeVAL(entry) != val)
11176 if ( HeVAL(entry) == &PL_sv_undef ||
11177 HeVAL(entry) == &PL_sv_placeholder)
11181 if (HeKLEN(entry) == HEf_SVKEY)
11182 return sv_mortalcopy(HeKEY_sv(entry));
11183 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11189 /* Look for an entry in the array whose value has the same SV as val;
11190 * If so, return the index, otherwise return -1. */
11193 S_find_array_subscript(pTHX_ AV *av, SV* val)
11197 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11198 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11202 for (i=AvFILLp(av); i>=0; i--) {
11203 if (svp[i] == val && svp[i] != &PL_sv_undef)
11209 /* S_varname(): return the name of a variable, optionally with a subscript.
11210 * If gv is non-zero, use the name of that global, along with gvtype (one
11211 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11212 * targ. Depending on the value of the subscript_type flag, return:
11215 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11216 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11217 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11218 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11221 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11222 SV* keyname, I32 aindex, int subscript_type)
11225 SV * const name = sv_newmortal();
11228 buffer[0] = gvtype;
11231 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11233 gv_fullname4(name, gv, buffer, 0);
11235 if ((unsigned int)SvPVX(name)[1] <= 26) {
11237 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11239 /* Swap the 1 unprintable control character for the 2 byte pretty
11240 version - ie substr($name, 1, 1) = $buffer; */
11241 sv_insert(name, 1, 1, buffer, 2);
11246 CV * const cv = find_runcv(&unused);
11250 if (!cv || !CvPADLIST(cv))
11252 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11253 sv = *av_fetch(av, targ, FALSE);
11254 /* SvLEN in a pad name is not to be trusted */
11255 sv_setpv(name, SvPV_nolen_const(sv));
11258 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11259 SV * const sv = NEWSV(0,0);
11260 *SvPVX(name) = '$';
11261 Perl_sv_catpvf(aTHX_ name, "{%s}",
11262 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11265 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11266 *SvPVX(name) = '$';
11267 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11269 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11270 sv_insert(name, 0, 0, "within ", 7);
11277 =for apidoc find_uninit_var
11279 Find the name of the undefined variable (if any) that caused the operator o
11280 to issue a "Use of uninitialized value" warning.
11281 If match is true, only return a name if it's value matches uninit_sv.
11282 So roughly speaking, if a unary operator (such as OP_COS) generates a
11283 warning, then following the direct child of the op may yield an
11284 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11285 other hand, with OP_ADD there are two branches to follow, so we only print
11286 the variable name if we get an exact match.
11288 The name is returned as a mortal SV.
11290 Assumes that PL_op is the op that originally triggered the error, and that
11291 PL_comppad/PL_curpad points to the currently executing pad.
11297 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11305 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11306 uninit_sv == &PL_sv_placeholder)))
11309 switch (obase->op_type) {
11316 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11317 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11319 SV *keysv = Nullsv;
11320 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11322 if (pad) { /* @lex, %lex */
11323 sv = PAD_SVl(obase->op_targ);
11327 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11328 /* @global, %global */
11329 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11332 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11334 else /* @{expr}, %{expr} */
11335 return find_uninit_var(cUNOPx(obase)->op_first,
11339 /* attempt to find a match within the aggregate */
11341 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11343 subscript_type = FUV_SUBSCRIPT_HASH;
11346 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11348 subscript_type = FUV_SUBSCRIPT_ARRAY;
11351 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11354 return varname(gv, hash ? '%' : '@', obase->op_targ,
11355 keysv, index, subscript_type);
11359 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11361 return varname(Nullgv, '$', obase->op_targ,
11362 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11365 gv = cGVOPx_gv(obase);
11366 if (!gv || (match && GvSV(gv) != uninit_sv))
11368 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11371 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11374 av = (AV*)PAD_SV(obase->op_targ);
11375 if (!av || SvRMAGICAL(av))
11377 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11378 if (!svp || *svp != uninit_sv)
11381 return varname(Nullgv, '$', obase->op_targ,
11382 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11385 gv = cGVOPx_gv(obase);
11391 if (!av || SvRMAGICAL(av))
11393 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11394 if (!svp || *svp != uninit_sv)
11397 return varname(gv, '$', 0,
11398 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11403 o = cUNOPx(obase)->op_first;
11404 if (!o || o->op_type != OP_NULL ||
11405 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11407 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11411 if (PL_op == obase)
11412 /* $a[uninit_expr] or $h{uninit_expr} */
11413 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11416 o = cBINOPx(obase)->op_first;
11417 kid = cBINOPx(obase)->op_last;
11419 /* get the av or hv, and optionally the gv */
11421 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11422 sv = PAD_SV(o->op_targ);
11424 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11425 && cUNOPo->op_first->op_type == OP_GV)
11427 gv = cGVOPx_gv(cUNOPo->op_first);
11430 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11435 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11436 /* index is constant */
11440 if (obase->op_type == OP_HELEM) {
11441 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11442 if (!he || HeVAL(he) != uninit_sv)
11446 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11447 if (!svp || *svp != uninit_sv)
11451 if (obase->op_type == OP_HELEM)
11452 return varname(gv, '%', o->op_targ,
11453 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11455 return varname(gv, '@', o->op_targ, Nullsv,
11456 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11460 /* index is an expression;
11461 * attempt to find a match within the aggregate */
11462 if (obase->op_type == OP_HELEM) {
11463 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11465 return varname(gv, '%', o->op_targ,
11466 keysv, 0, FUV_SUBSCRIPT_HASH);
11469 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11471 return varname(gv, '@', o->op_targ,
11472 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11477 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11479 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11485 /* only examine RHS */
11486 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11489 o = cUNOPx(obase)->op_first;
11490 if (o->op_type == OP_PUSHMARK)
11493 if (!o->op_sibling) {
11494 /* one-arg version of open is highly magical */
11496 if (o->op_type == OP_GV) { /* open FOO; */
11498 if (match && GvSV(gv) != uninit_sv)
11500 return varname(gv, '$', 0,
11501 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11503 /* other possibilities not handled are:
11504 * open $x; or open my $x; should return '${*$x}'
11505 * open expr; should return '$'.expr ideally
11511 /* ops where $_ may be an implicit arg */
11515 if ( !(obase->op_flags & OPf_STACKED)) {
11516 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11517 ? PAD_SVl(obase->op_targ)
11520 sv = sv_newmortal();
11521 sv_setpvn(sv, "$_", 2);
11529 /* skip filehandle as it can't produce 'undef' warning */
11530 o = cUNOPx(obase)->op_first;
11531 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11532 o = o->op_sibling->op_sibling;
11539 match = 1; /* XS or custom code could trigger random warnings */
11544 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11545 return sv_2mortal(newSVpvn("${$/}", 5));
11550 if (!(obase->op_flags & OPf_KIDS))
11552 o = cUNOPx(obase)->op_first;
11558 /* if all except one arg are constant, or have no side-effects,
11559 * or are optimized away, then it's unambiguous */
11561 for (kid=o; kid; kid = kid->op_sibling) {
11563 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11564 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11565 || (kid->op_type == OP_PUSHMARK)
11569 if (o2) { /* more than one found */
11576 return find_uninit_var(o2, uninit_sv, match);
11578 /* scan all args */
11580 sv = find_uninit_var(o, uninit_sv, 1);
11592 =for apidoc report_uninit
11594 Print appropriate "Use of uninitialized variable" warning
11600 Perl_report_uninit(pTHX_ SV* uninit_sv)
11603 SV* varname = Nullsv;
11605 varname = find_uninit_var(PL_op, uninit_sv,0);
11607 sv_insert(varname, 0, 0, " ", 1);
11609 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11610 varname ? SvPV_nolen_const(varname) : "",
11611 " in ", OP_DESC(PL_op));
11614 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11620 * c-indentation-style: bsd
11621 * c-basic-offset: 4
11622 * indent-tabs-mode: t
11625 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob