3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_OLD_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 In all but the most memory-paranoid configuations (ex: PURIFY), this
67 allocation is done using arenas, which by default are approximately 4K
68 chunks of memory parcelled up into N heads or bodies (of same size).
69 Sv-bodies are allocated by their sv-type, guaranteeing size
70 consistency needed to allocate safely from arrays.
72 The first slot in each arena is reserved, and is used to hold a link
73 to the next arena. In the case of heads, the unused first slot also
74 contains some flags and a note of the number of slots. Snaked through
75 each arena chain is a linked list of free items; when this becomes
76 empty, an extra arena is allocated and divided up into N items which
77 are threaded into the free list.
79 The following global variables are associated with arenas:
81 PL_sv_arenaroot pointer to list of SV arenas
82 PL_sv_root pointer to list of free SV structures
84 PL_body_arenaroots[] array of pointers to list of arenas, 1 per svtype
85 PL_body_roots[] array of pointers to list of free bodies of svtype
86 arrays are indexed by the svtype needed
88 Note that some of the larger and more rarely used body types (eg
89 xpvio) are not allocated using arenas, but are instead just
90 malloc()/free()ed as required.
92 In addition, a few SV heads are not allocated from an arena, but are
93 instead directly created as static or auto variables, eg PL_sv_undef.
94 The size of arenas can be changed from the default by setting
95 PERL_ARENA_SIZE appropriately at compile time.
97 The SV arena serves the secondary purpose of allowing still-live SVs
98 to be located and destroyed during final cleanup.
100 At the lowest level, the macros new_SV() and del_SV() grab and free
101 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
102 to return the SV to the free list with error checking.) new_SV() calls
103 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
104 SVs in the free list have their SvTYPE field set to all ones.
106 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
107 that allocate and return individual body types. Normally these are mapped
108 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
109 instead mapped directly to malloc()/free() if PURIFY is defined. The
110 new/del functions remove from, or add to, the appropriate PL_foo_root
111 list, and call more_xiv() etc to add a new arena if the list is empty.
113 At the time of very final cleanup, sv_free_arenas() is called from
114 perl_destruct() to physically free all the arenas allocated since the
115 start of the interpreter.
117 Manipulation of any of the PL_*root pointers is protected by enclosing
118 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
119 if threads are enabled.
121 The function visit() scans the SV arenas list, and calls a specified
122 function for each SV it finds which is still live - ie which has an SvTYPE
123 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
124 following functions (specified as [function that calls visit()] / [function
125 called by visit() for each SV]):
127 sv_report_used() / do_report_used()
128 dump all remaining SVs (debugging aid)
130 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
131 Attempt to free all objects pointed to by RVs,
132 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
133 try to do the same for all objects indirectly
134 referenced by typeglobs too. Called once from
135 perl_destruct(), prior to calling sv_clean_all()
138 sv_clean_all() / do_clean_all()
139 SvREFCNT_dec(sv) each remaining SV, possibly
140 triggering an sv_free(). It also sets the
141 SVf_BREAK flag on the SV to indicate that the
142 refcnt has been artificially lowered, and thus
143 stopping sv_free() from giving spurious warnings
144 about SVs which unexpectedly have a refcnt
145 of zero. called repeatedly from perl_destruct()
146 until there are no SVs left.
148 =head2 Arena allocator API Summary
150 Private API to rest of sv.c
154 new_XIV(), del_XIV(),
155 new_XNV(), del_XNV(),
160 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
165 ============================================================================ */
170 * "A time to plant, and a time to uproot what was planted..."
174 * nice_chunk and nice_chunk size need to be set
175 * and queried under the protection of sv_mutex
178 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
183 new_chunk = (void *)(chunk);
184 new_chunk_size = (chunk_size);
185 if (new_chunk_size > PL_nice_chunk_size) {
186 Safefree(PL_nice_chunk);
187 PL_nice_chunk = (char *) new_chunk;
188 PL_nice_chunk_size = new_chunk_size;
195 #ifdef DEBUG_LEAKING_SCALARS
196 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
198 # define FREE_SV_DEBUG_FILE(sv)
202 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
203 /* Whilst I'd love to do this, it seems that things like to check on
205 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
207 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
208 Poison(&SvREFCNT(sv), 1, U32)
210 # define SvARENA_CHAIN(sv) SvANY(sv)
211 # define POSION_SV_HEAD(sv)
214 #define plant_SV(p) \
216 FREE_SV_DEBUG_FILE(p); \
218 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
219 SvFLAGS(p) = SVTYPEMASK; \
224 /* sv_mutex must be held while calling uproot_SV() */
225 #define uproot_SV(p) \
228 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
233 /* make some more SVs by adding another arena */
235 /* sv_mutex must be held while calling more_sv() */
242 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
243 PL_nice_chunk = Nullch;
244 PL_nice_chunk_size = 0;
247 char *chunk; /* must use New here to match call to */
248 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
249 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
255 /* new_SV(): return a new, empty SV head */
257 #ifdef DEBUG_LEAKING_SCALARS
258 /* provide a real function for a debugger to play with */
268 sv = S_more_sv(aTHX);
273 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
274 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
275 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
276 sv->sv_debug_inpad = 0;
277 sv->sv_debug_cloned = 0;
278 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
282 # define new_SV(p) (p)=S_new_SV(aTHX)
291 (p) = S_more_sv(aTHX); \
300 /* del_SV(): return an empty SV head to the free list */
315 S_del_sv(pTHX_ SV *p)
320 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
321 const SV * const sv = sva + 1;
322 const SV * const svend = &sva[SvREFCNT(sva)];
323 if (p >= sv && p < svend) {
329 if (ckWARN_d(WARN_INTERNAL))
330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
331 "Attempt to free non-arena SV: 0x%"UVxf
332 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
339 #else /* ! DEBUGGING */
341 #define del_SV(p) plant_SV(p)
343 #endif /* DEBUGGING */
347 =head1 SV Manipulation Functions
349 =for apidoc sv_add_arena
351 Given a chunk of memory, link it to the head of the list of arenas,
352 and split it into a list of free SVs.
358 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 /* The first SV in an arena isn't an SV. */
365 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
366 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
367 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
369 PL_sv_arenaroot = sva;
370 PL_sv_root = sva + 1;
372 svend = &sva[SvREFCNT(sva) - 1];
375 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
379 /* Must always set typemask because it's awlays checked in on cleanup
380 when the arenas are walked looking for objects. */
381 SvFLAGS(sv) = SVTYPEMASK;
384 SvARENA_CHAIN(sv) = 0;
388 SvFLAGS(sv) = SVTYPEMASK;
391 /* visit(): call the named function for each non-free SV in the arenas
392 * whose flags field matches the flags/mask args. */
395 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
400 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
401 register const SV * const svend = &sva[SvREFCNT(sva)];
403 for (sv = sva + 1; sv < svend; ++sv) {
404 if (SvTYPE(sv) != SVTYPEMASK
405 && (sv->sv_flags & mask) == flags
418 /* called by sv_report_used() for each live SV */
421 do_report_used(pTHX_ SV *sv)
423 if (SvTYPE(sv) != SVTYPEMASK) {
424 PerlIO_printf(Perl_debug_log, "****\n");
431 =for apidoc sv_report_used
433 Dump the contents of all SVs not yet freed. (Debugging aid).
439 Perl_sv_report_used(pTHX)
442 visit(do_report_used, 0, 0);
446 /* called by sv_clean_objs() for each live SV */
449 do_clean_objs(pTHX_ SV *ref)
452 SV * const target = SvRV(ref);
453 if (SvOBJECT(target)) {
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
455 if (SvWEAKREF(ref)) {
456 sv_del_backref(target, ref);
462 SvREFCNT_dec(target);
467 /* XXX Might want to check arrays, etc. */
470 /* called by sv_clean_objs() for each live SV */
472 #ifndef DISABLE_DESTRUCTOR_KLUDGE
474 do_clean_named_objs(pTHX_ SV *sv)
476 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
478 #ifdef PERL_DONT_CREATE_GVSV
481 SvOBJECT(GvSV(sv))) ||
482 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
483 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
484 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
485 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
487 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
488 SvFLAGS(sv) |= SVf_BREAK;
496 =for apidoc sv_clean_objs
498 Attempt to destroy all objects not yet freed
504 Perl_sv_clean_objs(pTHX)
506 PL_in_clean_objs = TRUE;
507 visit(do_clean_objs, SVf_ROK, SVf_ROK);
508 #ifndef DISABLE_DESTRUCTOR_KLUDGE
509 /* some barnacles may yet remain, clinging to typeglobs */
510 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
512 PL_in_clean_objs = FALSE;
515 /* called by sv_clean_all() for each live SV */
518 do_clean_all(pTHX_ SV *sv)
520 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
521 SvFLAGS(sv) |= SVf_BREAK;
522 if (PL_comppad == (AV*)sv) {
524 PL_curpad = Null(SV**);
530 =for apidoc sv_clean_all
532 Decrement the refcnt of each remaining SV, possibly triggering a
533 cleanup. This function may have to be called multiple times to free
534 SVs which are in complex self-referential hierarchies.
540 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 S_free_arena(pTHX_ void **root) {
552 void ** const next = *(void **)root;
559 =for apidoc sv_free_arenas
561 Deallocate the memory used by all arenas. Note that all the individual SV
562 heads and bodies within the arenas must already have been freed.
566 #define free_arena(name) \
568 S_free_arena(aTHX_ (void**) PL_ ## name ## _arenaroot); \
569 PL_ ## name ## _arenaroot = 0; \
570 PL_ ## name ## _root = 0; \
574 Perl_sv_free_arenas(pTHX)
580 /* Free arenas here, but be careful about fake ones. (We assume
581 contiguity of the fake ones with the corresponding real ones.) */
583 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
584 svanext = (SV*) SvANY(sva);
585 while (svanext && SvFAKE(svanext))
586 svanext = (SV*) SvANY(svanext);
592 for (i=0; i<SVt_LAST; i++) {
593 S_free_arena(aTHX_ (void**) PL_body_arenaroots[i]);
594 PL_body_arenaroots[i] = 0;
595 PL_body_roots[i] = 0;
598 Safefree(PL_nice_chunk);
599 PL_nice_chunk = Nullch;
600 PL_nice_chunk_size = 0;
606 Here are mid-level routines that manage the allocation of bodies out
607 of the various arenas. There are 5 kinds of arenas:
609 1. SV-head arenas, which are discussed and handled above
610 2. regular body arenas
611 3. arenas for reduced-size bodies
613 5. pte arenas (thread related)
615 Arena types 2 & 3 are chained by body-type off an array of
616 arena-root pointers, which is indexed by svtype. Some of the
617 larger/less used body types are malloced singly, since a large
618 unused block of them is wasteful. Also, several svtypes dont have
619 bodies; the data fits into the sv-head itself. The arena-root
620 pointer thus has a few unused root-pointers (which may be hijacked
621 later for arena types 4,5)
623 3 differs from 2 as an optimization; some body types have several
624 unused fields in the front of the structure (which are kept in-place
625 for consistency). These bodies can be allocated in smaller chunks,
626 because the leading fields arent accessed. Pointers to such bodies
627 are decremented to point at the unused 'ghost' memory, knowing that
628 the pointers are used with offsets to the real memory.
630 HE, HEK arenas are managed separately, with separate code, but may
631 be merge-able later..
633 PTE arenas are not sv-bodies, but they share these mid-level
634 mechanics, so are considered here. The new mid-level mechanics rely
635 on the sv_type of the body being allocated, so we just reserve one
636 of the unused body-slots for PTEs, then use it in those (2) PTE
637 contexts below (line ~10k)
641 S_more_bodies (pTHX_ size_t size, svtype sv_type)
643 void **arena_root = &PL_body_arenaroots[sv_type];
644 void **root = &PL_body_roots[sv_type];
647 const size_t count = PERL_ARENA_SIZE / size;
649 Newx(start, count*size, char);
650 *((void **) start) = *arena_root;
651 *arena_root = (void *)start;
653 end = start + (count-1) * size;
655 /* The initial slot is used to link the arenas together, so it isn't to be
656 linked into the list of ready-to-use bodies. */
660 *root = (void *)start;
662 while (start < end) {
663 char * const next = start + size;
664 *(void**) start = (void *)next;
672 /* grab a new thing from the free list, allocating more if necessary */
674 /* 1st, the inline version */
676 #define new_body_inline(xpv, size, sv_type) \
678 void **r3wt = &PL_body_roots[sv_type]; \
680 xpv = *((void **)(r3wt)) \
681 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
682 *(r3wt) = *(void**)(xpv); \
686 /* now use the inline version in the proper function */
690 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
691 compilers issue warnings. */
694 S_new_body(pTHX_ size_t size, svtype sv_type)
697 new_body_inline(xpv, size, sv_type);
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void **thing_copy = (void **)thing; \
709 *thing_copy = *root; \
710 *root = (void*)thing_copy; \
715 Revisiting type 3 arenas, there are 4 body-types which have some
716 members that are never accessed. They are XPV, XPVIV, XPVAV,
717 XPVHV, which have corresponding types: xpv_allocated,
718 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
720 For these types, the arenas are carved up into *_allocated size
721 chunks, we thus avoid wasted memory for those unaccessed members.
722 When bodies are allocated, we adjust the pointer back in memory by
723 the size of the bit not allocated, so it's as if we allocated the
724 full structure. (But things will all go boom if you write to the
725 part that is "not there", because you'll be overwriting the last
726 members of the preceding structure in memory.)
728 We calculate the correction using the STRUCT_OFFSET macro. For example, if
729 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
730 and the pointer is unchanged. If the allocated structure is smaller (no
731 initial NV actually allocated) then the net effect is to subtract the size
732 of the NV from the pointer, to return a new pointer as if an initial NV were
735 This is the same trick as was used for NV and IV bodies. Ironically it
736 doesn't need to be used for NV bodies any more, because NV is now at the
737 start of the structure. IV bodies don't need it either, because they are
738 no longer allocated. */
740 /* The following 2 arrays hide the above details in a pair of
741 lookup-tables, allowing us to be body-type agnostic.
743 size maps svtype to its body's allocated size.
744 offset maps svtype to the body-pointer adjustment needed
746 NB: elements in latter are 0 or <0, and are added during
747 allocation, and subtracted during deallocation. It may be clearer
748 to invert the values, and call it shrinkage_by_svtype.
751 struct body_details {
752 size_t size; /* Size to allocate */
753 size_t copy; /* Size of structure to copy (may be shorter) */
755 bool cant_upgrade; /* Can upgrade this type */
756 bool zero_nv; /* zero the NV when upgrading from this */
757 bool arena; /* Allocated from an arena */
764 /* With -DPURFIY we allocate everything directly, and don't use arenas.
765 This seems a rather elegant way to simplify some of the code below. */
766 #define HASARENA FALSE
768 #define HASARENA TRUE
770 #define NOARENA FALSE
772 /* A macro to work out the offset needed to subtract from a pointer to (say)
779 to make its members accessible via a pointer to (say)
789 #define relative_STRUCT_OFFSET(longer, shorter, member) \
790 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
792 /* Calculate the length to copy. Specifically work out the length less any
793 final padding the compiler needed to add. See the comment in sv_upgrade
794 for why copying the padding proved to be a bug. */
796 #define copy_length(type, last_member) \
797 STRUCT_OFFSET(type, last_member) \
798 + sizeof (((type*)SvANY((SV*)0))->last_member)
800 static const struct body_details bodies_by_type[] = {
801 {0, 0, 0, FALSE, NONV, NOARENA},
802 /* IVs are in the head, so the allocation size is 0 */
803 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
804 /* 8 bytes on most ILP32 with IEEE doubles */
805 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
806 /* RVs are in the head now */
807 /* However, this slot is overloaded and used by the pte */
808 {0, 0, 0, FALSE, NONV, NOARENA},
809 /* 8 bytes on most ILP32 with IEEE doubles */
810 {sizeof(xpv_allocated),
811 copy_length(XPV, xpv_len)
812 + relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
813 - relative_STRUCT_OFFSET(XPV, xpv_allocated, xpv_cur),
814 FALSE, NONV, HASARENA},
816 {sizeof(xpviv_allocated),
817 copy_length(XPVIV, xiv_u)
818 + relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
819 - relative_STRUCT_OFFSET(XPVIV, xpviv_allocated, xpv_cur),
820 FALSE, NONV, HASARENA},
822 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
824 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
826 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
828 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
830 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
832 {sizeof(xpvav_allocated),
833 copy_length(XPVAV, xmg_stash)
834 + relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
835 - relative_STRUCT_OFFSET(XPVAV, xpvav_allocated, xav_fill),
836 TRUE, HADNV, HASARENA},
838 {sizeof(xpvhv_allocated),
839 copy_length(XPVHV, xmg_stash)
840 + relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
841 - relative_STRUCT_OFFSET(XPVHV, xpvhv_allocated, xhv_fill),
842 TRUE, HADNV, HASARENA},
844 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
846 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
848 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
851 #define new_body_type(sv_type) \
852 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
853 - bodies_by_type[sv_type].offset)
855 #define del_body_type(p, sv_type) \
856 del_body(p, &PL_body_roots[sv_type])
859 #define new_body_allocated(sv_type) \
860 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
861 - bodies_by_type[sv_type].offset)
863 #define del_body_allocated(p, sv_type) \
864 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
867 #define my_safemalloc(s) (void*)safemalloc(s)
868 #define my_safecalloc(s) (void*)safecalloc(s, 1)
869 #define my_safefree(p) safefree((char*)p)
873 #define new_XNV() my_safemalloc(sizeof(XPVNV))
874 #define del_XNV(p) my_safefree(p)
876 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
877 #define del_XPVNV(p) my_safefree(p)
879 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
880 #define del_XPVAV(p) my_safefree(p)
882 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
883 #define del_XPVHV(p) my_safefree(p)
885 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
886 #define del_XPVMG(p) my_safefree(p)
888 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
889 #define del_XPVGV(p) my_safefree(p)
893 #define new_XNV() new_body_type(SVt_NV)
894 #define del_XNV(p) del_body_type(p, SVt_NV)
896 #define new_XPVNV() new_body_type(SVt_PVNV)
897 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
899 #define new_XPVAV() new_body_allocated(SVt_PVAV)
900 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
902 #define new_XPVHV() new_body_allocated(SVt_PVHV)
903 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
905 #define new_XPVMG() new_body_type(SVt_PVMG)
906 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
908 #define new_XPVGV() new_body_type(SVt_PVGV)
909 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
913 /* no arena for you! */
915 #define new_NOARENA(details) \
916 my_safemalloc((details)->size + (details)->offset)
917 #define new_NOARENAZ(details) \
918 my_safecalloc((details)->size + (details)->offset)
921 =for apidoc sv_upgrade
923 Upgrade an SV to a more complex form. Generally adds a new body type to the
924 SV, then copies across as much information as possible from the old body.
925 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
931 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
935 const U32 old_type = SvTYPE(sv);
936 const struct body_details *const old_type_details
937 = bodies_by_type + old_type;
938 const struct body_details *new_type_details = bodies_by_type + new_type;
940 if (new_type != SVt_PV && SvIsCOW(sv)) {
941 sv_force_normal_flags(sv, 0);
944 if (old_type == new_type)
947 if (old_type > new_type)
948 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
949 (int)old_type, (int)new_type);
952 old_body = SvANY(sv);
954 /* Copying structures onto other structures that have been neatly zeroed
955 has a subtle gotcha. Consider XPVMG
957 +------+------+------+------+------+-------+-------+
958 | NV | CUR | LEN | IV | MAGIC | STASH |
959 +------+------+------+------+------+-------+-------+
962 where NVs are aligned to 8 bytes, so that sizeof that structure is
963 actually 32 bytes long, with 4 bytes of padding at the end:
965 +------+------+------+------+------+-------+-------+------+
966 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
967 +------+------+------+------+------+-------+-------+------+
968 0 4 8 12 16 20 24 28 32
970 so what happens if you allocate memory for this structure:
972 +------+------+------+------+------+-------+-------+------+------+...
973 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
974 +------+------+------+------+------+-------+-------+------+------+...
975 0 4 8 12 16 20 24 28 32 36
977 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
978 expect, because you copy the area marked ??? onto GP. Now, ??? may have
979 started out as zero once, but it's quite possible that it isn't. So now,
980 rather than a nicely zeroed GP, you have it pointing somewhere random.
983 (In fact, GP ends up pointing at a previous GP structure, because the
984 principle cause of the padding in XPVMG getting garbage is a copy of
985 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
987 So we are careful and work out the size of used parts of all the
994 if (new_type < SVt_PVIV) {
995 new_type = (new_type == SVt_NV)
996 ? SVt_PVNV : SVt_PVIV;
997 new_type_details = bodies_by_type + new_type;
1001 if (new_type < SVt_PVNV) {
1002 new_type = SVt_PVNV;
1003 new_type_details = bodies_by_type + new_type;
1009 assert(new_type > SVt_PV);
1010 assert(SVt_IV < SVt_PV);
1011 assert(SVt_NV < SVt_PV);
1018 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1019 there's no way that it can be safely upgraded, because perl.c
1020 expects to Safefree(SvANY(PL_mess_sv)) */
1021 assert(sv != PL_mess_sv);
1022 /* This flag bit is used to mean other things in other scalar types.
1023 Given that it only has meaning inside the pad, it shouldn't be set
1024 on anything that can get upgraded. */
1025 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1028 if (old_type_details->cant_upgrade)
1029 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1032 SvFLAGS(sv) &= ~SVTYPEMASK;
1033 SvFLAGS(sv) |= new_type;
1037 Perl_croak(aTHX_ "Can't upgrade to undef");
1039 assert(old_type == SVt_NULL);
1040 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1044 assert(old_type == SVt_NULL);
1045 SvANY(sv) = new_XNV();
1049 assert(old_type == SVt_NULL);
1050 SvANY(sv) = &sv->sv_u.svu_rv;
1054 SvANY(sv) = new_XPVHV();
1057 HvTOTALKEYS(sv) = 0;
1062 SvANY(sv) = new_XPVAV();
1069 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1070 The target created by newSVrv also is, and it can have magic.
1071 However, it never has SvPVX set.
1073 if (old_type >= SVt_RV) {
1074 assert(SvPVX_const(sv) == 0);
1077 /* Could put this in the else clause below, as PVMG must have SvPVX
1078 0 already (the assertion above) */
1079 SvPV_set(sv, (char*)0);
1081 if (old_type >= SVt_PVMG) {
1082 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1083 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1092 /* XXX Is this still needed? Was it ever needed? Surely as there is
1093 no route from NV to PVIV, NOK can never be true */
1094 assert(!SvNOKp(sv));
1106 assert(new_type_details->size);
1107 /* We always allocated the full length item with PURIFY. To do this
1108 we fake things so that arena is false for all 16 types.. */
1109 if(new_type_details->arena) {
1110 /* This points to the start of the allocated area. */
1111 new_body_inline(new_body, new_type_details->size, new_type);
1112 Zero(new_body, new_type_details->size, char);
1113 new_body = ((char *)new_body) - new_type_details->offset;
1115 new_body = new_NOARENAZ(new_type_details);
1117 SvANY(sv) = new_body;
1119 if (old_type_details->copy) {
1120 Copy((char *)old_body + old_type_details->offset,
1121 (char *)new_body + old_type_details->offset,
1122 old_type_details->copy, char);
1125 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1126 /* If NV 0.0 is store as all bits 0 then Zero() already creates a correct
1128 if (old_type_details->zero_nv)
1132 if (new_type == SVt_PVIO)
1133 IoPAGE_LEN(sv) = 60;
1134 if (old_type < SVt_RV)
1138 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu", new_type);
1141 if (old_type_details->size) {
1142 /* If the old body had an allocated size, then we need to free it. */
1144 my_safefree(old_body);
1146 del_body((void*)((char*)old_body + old_type_details->offset),
1147 &PL_body_roots[old_type]);
1153 =for apidoc sv_backoff
1155 Remove any string offset. You should normally use the C<SvOOK_off> macro
1162 Perl_sv_backoff(pTHX_ register SV *sv)
1165 assert(SvTYPE(sv) != SVt_PVHV);
1166 assert(SvTYPE(sv) != SVt_PVAV);
1168 const char * const s = SvPVX_const(sv);
1169 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1170 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1172 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1174 SvFLAGS(sv) &= ~SVf_OOK;
1181 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1182 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1183 Use the C<SvGROW> wrapper instead.
1189 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1193 #ifdef HAS_64K_LIMIT
1194 if (newlen >= 0x10000) {
1195 PerlIO_printf(Perl_debug_log,
1196 "Allocation too large: %"UVxf"\n", (UV)newlen);
1199 #endif /* HAS_64K_LIMIT */
1202 if (SvTYPE(sv) < SVt_PV) {
1203 sv_upgrade(sv, SVt_PV);
1204 s = SvPVX_mutable(sv);
1206 else if (SvOOK(sv)) { /* pv is offset? */
1208 s = SvPVX_mutable(sv);
1209 if (newlen > SvLEN(sv))
1210 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1211 #ifdef HAS_64K_LIMIT
1212 if (newlen >= 0x10000)
1217 s = SvPVX_mutable(sv);
1219 if (newlen > SvLEN(sv)) { /* need more room? */
1220 newlen = PERL_STRLEN_ROUNDUP(newlen);
1221 if (SvLEN(sv) && s) {
1223 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1229 s = saferealloc(s, newlen);
1232 s = safemalloc(newlen);
1233 if (SvPVX_const(sv) && SvCUR(sv)) {
1234 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1238 SvLEN_set(sv, newlen);
1244 =for apidoc sv_setiv
1246 Copies an integer into the given SV, upgrading first if necessary.
1247 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1253 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1255 SV_CHECK_THINKFIRST_COW_DROP(sv);
1256 switch (SvTYPE(sv)) {
1258 sv_upgrade(sv, SVt_IV);
1261 sv_upgrade(sv, SVt_PVNV);
1265 sv_upgrade(sv, SVt_PVIV);
1274 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1277 (void)SvIOK_only(sv); /* validate number */
1283 =for apidoc sv_setiv_mg
1285 Like C<sv_setiv>, but also handles 'set' magic.
1291 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1298 =for apidoc sv_setuv
1300 Copies an unsigned integer into the given SV, upgrading first if necessary.
1301 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1307 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1309 /* With these two if statements:
1310 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1313 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1315 If you wish to remove them, please benchmark to see what the effect is
1317 if (u <= (UV)IV_MAX) {
1318 sv_setiv(sv, (IV)u);
1327 =for apidoc sv_setuv_mg
1329 Like C<sv_setuv>, but also handles 'set' magic.
1335 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1344 =for apidoc sv_setnv
1346 Copies a double into the given SV, upgrading first if necessary.
1347 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1353 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1355 SV_CHECK_THINKFIRST_COW_DROP(sv);
1356 switch (SvTYPE(sv)) {
1359 sv_upgrade(sv, SVt_NV);
1364 sv_upgrade(sv, SVt_PVNV);
1373 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1377 (void)SvNOK_only(sv); /* validate number */
1382 =for apidoc sv_setnv_mg
1384 Like C<sv_setnv>, but also handles 'set' magic.
1390 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1396 /* Print an "isn't numeric" warning, using a cleaned-up,
1397 * printable version of the offending string
1401 S_not_a_number(pTHX_ SV *sv)
1408 dsv = sv_2mortal(newSVpvn("", 0));
1409 pv = sv_uni_display(dsv, sv, 10, 0);
1412 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1413 /* each *s can expand to 4 chars + "...\0",
1414 i.e. need room for 8 chars */
1416 const char *s, *end;
1417 for (s = SvPVX_const(sv), end = s + SvCUR(sv); s < end && d < limit;
1420 if (ch & 128 && !isPRINT_LC(ch)) {
1429 else if (ch == '\r') {
1433 else if (ch == '\f') {
1437 else if (ch == '\\') {
1441 else if (ch == '\0') {
1445 else if (isPRINT_LC(ch))
1462 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1463 "Argument \"%s\" isn't numeric in %s", pv,
1466 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1467 "Argument \"%s\" isn't numeric", pv);
1471 =for apidoc looks_like_number
1473 Test if the content of an SV looks like a number (or is a number).
1474 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1475 non-numeric warning), even if your atof() doesn't grok them.
1481 Perl_looks_like_number(pTHX_ SV *sv)
1483 register const char *sbegin;
1487 sbegin = SvPVX_const(sv);
1490 else if (SvPOKp(sv))
1491 sbegin = SvPV_const(sv, len);
1493 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1494 return grok_number(sbegin, len, NULL);
1497 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1498 until proven guilty, assume that things are not that bad... */
1503 As 64 bit platforms often have an NV that doesn't preserve all bits of
1504 an IV (an assumption perl has been based on to date) it becomes necessary
1505 to remove the assumption that the NV always carries enough precision to
1506 recreate the IV whenever needed, and that the NV is the canonical form.
1507 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1508 precision as a side effect of conversion (which would lead to insanity
1509 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1510 1) to distinguish between IV/UV/NV slots that have cached a valid
1511 conversion where precision was lost and IV/UV/NV slots that have a
1512 valid conversion which has lost no precision
1513 2) to ensure that if a numeric conversion to one form is requested that
1514 would lose precision, the precise conversion (or differently
1515 imprecise conversion) is also performed and cached, to prevent
1516 requests for different numeric formats on the same SV causing
1517 lossy conversion chains. (lossless conversion chains are perfectly
1522 SvIOKp is true if the IV slot contains a valid value
1523 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1524 SvNOKp is true if the NV slot contains a valid value
1525 SvNOK is true only if the NV value is accurate
1528 while converting from PV to NV, check to see if converting that NV to an
1529 IV(or UV) would lose accuracy over a direct conversion from PV to
1530 IV(or UV). If it would, cache both conversions, return NV, but mark
1531 SV as IOK NOKp (ie not NOK).
1533 While converting from PV to IV, check to see if converting that IV to an
1534 NV would lose accuracy over a direct conversion from PV to NV. If it
1535 would, cache both conversions, flag similarly.
1537 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1538 correctly because if IV & NV were set NV *always* overruled.
1539 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1540 changes - now IV and NV together means that the two are interchangeable:
1541 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1543 The benefit of this is that operations such as pp_add know that if
1544 SvIOK is true for both left and right operands, then integer addition
1545 can be used instead of floating point (for cases where the result won't
1546 overflow). Before, floating point was always used, which could lead to
1547 loss of precision compared with integer addition.
1549 * making IV and NV equal status should make maths accurate on 64 bit
1551 * may speed up maths somewhat if pp_add and friends start to use
1552 integers when possible instead of fp. (Hopefully the overhead in
1553 looking for SvIOK and checking for overflow will not outweigh the
1554 fp to integer speedup)
1555 * will slow down integer operations (callers of SvIV) on "inaccurate"
1556 values, as the change from SvIOK to SvIOKp will cause a call into
1557 sv_2iv each time rather than a macro access direct to the IV slot
1558 * should speed up number->string conversion on integers as IV is
1559 favoured when IV and NV are equally accurate
1561 ####################################################################
1562 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1563 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1564 On the other hand, SvUOK is true iff UV.
1565 ####################################################################
1567 Your mileage will vary depending your CPU's relative fp to integer
1571 #ifndef NV_PRESERVES_UV
1572 # define IS_NUMBER_UNDERFLOW_IV 1
1573 # define IS_NUMBER_UNDERFLOW_UV 2
1574 # define IS_NUMBER_IV_AND_UV 2
1575 # define IS_NUMBER_OVERFLOW_IV 4
1576 # define IS_NUMBER_OVERFLOW_UV 5
1578 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1580 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1582 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1584 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1585 if (SvNVX(sv) < (NV)IV_MIN) {
1586 (void)SvIOKp_on(sv);
1588 SvIV_set(sv, IV_MIN);
1589 return IS_NUMBER_UNDERFLOW_IV;
1591 if (SvNVX(sv) > (NV)UV_MAX) {
1592 (void)SvIOKp_on(sv);
1595 SvUV_set(sv, UV_MAX);
1596 return IS_NUMBER_OVERFLOW_UV;
1598 (void)SvIOKp_on(sv);
1600 /* Can't use strtol etc to convert this string. (See truth table in
1602 if (SvNVX(sv) <= (UV)IV_MAX) {
1603 SvIV_set(sv, I_V(SvNVX(sv)));
1604 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1605 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1607 /* Integer is imprecise. NOK, IOKp */
1609 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1612 SvUV_set(sv, U_V(SvNVX(sv)));
1613 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1614 if (SvUVX(sv) == UV_MAX) {
1615 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1616 possibly be preserved by NV. Hence, it must be overflow.
1618 return IS_NUMBER_OVERFLOW_UV;
1620 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1622 /* Integer is imprecise. NOK, IOKp */
1624 return IS_NUMBER_OVERFLOW_IV;
1626 #endif /* !NV_PRESERVES_UV*/
1629 =for apidoc sv_2iv_flags
1631 Return the integer value of an SV, doing any necessary string
1632 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1633 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
1639 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
1643 if (SvGMAGICAL(sv)) {
1644 if (flags & SV_GMAGIC)
1649 return I_V(SvNVX(sv));
1651 if (SvPOKp(sv) && SvLEN(sv))
1654 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1655 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1661 if (SvTHINKFIRST(sv)) {
1664 SV * const tmpstr=AMG_CALLun(sv,numer);
1665 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
1666 return SvIV(tmpstr);
1669 return PTR2IV(SvRV(sv));
1672 sv_force_normal_flags(sv, 0);
1674 if (SvREADONLY(sv) && !SvOK(sv)) {
1675 if (ckWARN(WARN_UNINITIALIZED))
1682 return (IV)(SvUVX(sv));
1689 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1690 * without also getting a cached IV/UV from it at the same time
1691 * (ie PV->NV conversion should detect loss of accuracy and cache
1692 * IV or UV at same time to avoid this. NWC */
1694 if (SvTYPE(sv) == SVt_NV)
1695 sv_upgrade(sv, SVt_PVNV);
1697 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1698 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1699 certainly cast into the IV range at IV_MAX, whereas the correct
1700 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1702 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1703 SvIV_set(sv, I_V(SvNVX(sv)));
1704 if (SvNVX(sv) == (NV) SvIVX(sv)
1705 #ifndef NV_PRESERVES_UV
1706 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1707 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1708 /* Don't flag it as "accurately an integer" if the number
1709 came from a (by definition imprecise) NV operation, and
1710 we're outside the range of NV integer precision */
1713 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1714 DEBUG_c(PerlIO_printf(Perl_debug_log,
1715 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1721 /* IV not precise. No need to convert from PV, as NV
1722 conversion would already have cached IV if it detected
1723 that PV->IV would be better than PV->NV->IV
1724 flags already correct - don't set public IOK. */
1725 DEBUG_c(PerlIO_printf(Perl_debug_log,
1726 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1731 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1732 but the cast (NV)IV_MIN rounds to a the value less (more
1733 negative) than IV_MIN which happens to be equal to SvNVX ??
1734 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1735 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1736 (NV)UVX == NVX are both true, but the values differ. :-(
1737 Hopefully for 2s complement IV_MIN is something like
1738 0x8000000000000000 which will be exact. NWC */
1741 SvUV_set(sv, U_V(SvNVX(sv)));
1743 (SvNVX(sv) == (NV) SvUVX(sv))
1744 #ifndef NV_PRESERVES_UV
1745 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1746 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1747 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1748 /* Don't flag it as "accurately an integer" if the number
1749 came from a (by definition imprecise) NV operation, and
1750 we're outside the range of NV integer precision */
1755 DEBUG_c(PerlIO_printf(Perl_debug_log,
1756 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1762 else if (SvPOKp(sv) && SvLEN(sv)) {
1764 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1765 /* We want to avoid a possible problem when we cache an IV which
1766 may be later translated to an NV, and the resulting NV is not
1767 the same as the direct translation of the initial string
1768 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1769 be careful to ensure that the value with the .456 is around if the
1770 NV value is requested in the future).
1772 This means that if we cache such an IV, we need to cache the
1773 NV as well. Moreover, we trade speed for space, and do not
1774 cache the NV if we are sure it's not needed.
1777 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1778 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1779 == IS_NUMBER_IN_UV) {
1780 /* It's definitely an integer, only upgrade to PVIV */
1781 if (SvTYPE(sv) < SVt_PVIV)
1782 sv_upgrade(sv, SVt_PVIV);
1784 } else if (SvTYPE(sv) < SVt_PVNV)
1785 sv_upgrade(sv, SVt_PVNV);
1787 /* If NV preserves UV then we only use the UV value if we know that
1788 we aren't going to call atof() below. If NVs don't preserve UVs
1789 then the value returned may have more precision than atof() will
1790 return, even though value isn't perfectly accurate. */
1791 if ((numtype & (IS_NUMBER_IN_UV
1792 #ifdef NV_PRESERVES_UV
1795 )) == IS_NUMBER_IN_UV) {
1796 /* This won't turn off the public IOK flag if it was set above */
1797 (void)SvIOKp_on(sv);
1799 if (!(numtype & IS_NUMBER_NEG)) {
1801 if (value <= (UV)IV_MAX) {
1802 SvIV_set(sv, (IV)value);
1804 SvUV_set(sv, value);
1808 /* 2s complement assumption */
1809 if (value <= (UV)IV_MIN) {
1810 SvIV_set(sv, -(IV)value);
1812 /* Too negative for an IV. This is a double upgrade, but
1813 I'm assuming it will be rare. */
1814 if (SvTYPE(sv) < SVt_PVNV)
1815 sv_upgrade(sv, SVt_PVNV);
1819 SvNV_set(sv, -(NV)value);
1820 SvIV_set(sv, IV_MIN);
1824 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1825 will be in the previous block to set the IV slot, and the next
1826 block to set the NV slot. So no else here. */
1828 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1829 != IS_NUMBER_IN_UV) {
1830 /* It wasn't an (integer that doesn't overflow the UV). */
1831 SvNV_set(sv, Atof(SvPVX_const(sv)));
1833 if (! numtype && ckWARN(WARN_NUMERIC))
1836 #if defined(USE_LONG_DOUBLE)
1837 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1838 PTR2UV(sv), SvNVX(sv)));
1840 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1841 PTR2UV(sv), SvNVX(sv)));
1845 #ifdef NV_PRESERVES_UV
1846 (void)SvIOKp_on(sv);
1848 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1849 SvIV_set(sv, I_V(SvNVX(sv)));
1850 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1853 /* Integer is imprecise. NOK, IOKp */
1855 /* UV will not work better than IV */
1857 if (SvNVX(sv) > (NV)UV_MAX) {
1859 /* Integer is inaccurate. NOK, IOKp, is UV */
1860 SvUV_set(sv, UV_MAX);
1863 SvUV_set(sv, U_V(SvNVX(sv)));
1864 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1869 /* Integer is imprecise. NOK, IOKp, is UV */
1874 #else /* NV_PRESERVES_UV */
1875 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1876 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1877 /* The IV slot will have been set from value returned by
1878 grok_number above. The NV slot has just been set using
1881 assert (SvIOKp(sv));
1883 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1884 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1885 /* Small enough to preserve all bits. */
1886 (void)SvIOKp_on(sv);
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1891 /* Assumption: first non-preserved integer is < IV_MAX,
1892 this NV is in the preserved range, therefore: */
1893 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1895 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
1899 0 0 already failed to read UV.
1900 0 1 already failed to read UV.
1901 1 0 you won't get here in this case. IV/UV
1902 slot set, public IOK, Atof() unneeded.
1903 1 1 already read UV.
1904 so there's no point in sv_2iuv_non_preserve() attempting
1905 to use atol, strtol, strtoul etc. */
1906 sv_2iuv_non_preserve (sv, numtype);
1909 #endif /* NV_PRESERVES_UV */
1912 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
1914 if (SvTYPE(sv) < SVt_IV)
1915 /* Typically the caller expects that sv_any is not NULL now. */
1916 sv_upgrade(sv, SVt_IV);
1919 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
1920 PTR2UV(sv),SvIVX(sv)));
1921 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
1925 =for apidoc sv_2uv_flags
1927 Return the unsigned integer value of an SV, doing any necessary string
1928 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1929 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
1935 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
1939 if (SvGMAGICAL(sv)) {
1940 if (flags & SV_GMAGIC)
1945 return U_V(SvNVX(sv));
1946 if (SvPOKp(sv) && SvLEN(sv))
1949 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1950 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1956 if (SvTHINKFIRST(sv)) {
1959 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
1960 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
1961 return SvUV(tmpstr);
1962 return PTR2UV(SvRV(sv));
1965 sv_force_normal_flags(sv, 0);
1967 if (SvREADONLY(sv) && !SvOK(sv)) {
1968 if (ckWARN(WARN_UNINITIALIZED))
1978 return (UV)SvIVX(sv);
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1993 SvIV_set(sv, I_V(SvNVX(sv)));
1994 if (SvNVX(sv) == (NV) SvIVX(sv)
1995 #ifndef NV_PRESERVES_UV
1996 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1997 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1998 /* Don't flag it as "accurately an integer" if the number
1999 came from a (by definition imprecise) NV operation, and
2000 we're outside the range of NV integer precision */
2003 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2004 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2011 /* IV not precise. No need to convert from PV, as NV
2012 conversion would already have cached IV if it detected
2013 that PV->IV would be better than PV->NV->IV
2014 flags already correct - don't set public IOK. */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2021 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022 but the cast (NV)IV_MIN rounds to a the value less (more
2023 negative) than IV_MIN which happens to be equal to SvNVX ??
2024 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026 (NV)UVX == NVX are both true, but the values differ. :-(
2027 Hopefully for 2s complement IV_MIN is something like
2028 0x8000000000000000 which will be exact. NWC */
2031 SvUV_set(sv, U_V(SvNVX(sv)));
2033 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef NV_PRESERVES_UV
2035 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038 /* Don't flag it as "accurately an integer" if the number
2039 came from a (by definition imprecise) NV operation, and
2040 we're outside the range of NV integer precision */
2045 DEBUG_c(PerlIO_printf(Perl_debug_log,
2046 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2052 else if (SvPOKp(sv) && SvLEN(sv)) {
2054 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2056 /* We want to avoid a possible problem when we cache a UV which
2057 may be later translated to an NV, and the resulting NV is not
2058 the translation of the initial data.
2060 This means that if we cache such a UV, we need to cache the
2061 NV as well. Moreover, we trade speed for space, and do not
2062 cache the NV if not needed.
2065 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2066 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2067 == IS_NUMBER_IN_UV) {
2068 /* It's definitely an integer, only upgrade to PVIV */
2069 if (SvTYPE(sv) < SVt_PVIV)
2070 sv_upgrade(sv, SVt_PVIV);
2072 } else if (SvTYPE(sv) < SVt_PVNV)
2073 sv_upgrade(sv, SVt_PVNV);
2075 /* If NV preserves UV then we only use the UV value if we know that
2076 we aren't going to call atof() below. If NVs don't preserve UVs
2077 then the value returned may have more precision than atof() will
2078 return, even though it isn't accurate. */
2079 if ((numtype & (IS_NUMBER_IN_UV
2080 #ifdef NV_PRESERVES_UV
2083 )) == IS_NUMBER_IN_UV) {
2084 /* This won't turn off the public IOK flag if it was set above */
2085 (void)SvIOKp_on(sv);
2087 if (!(numtype & IS_NUMBER_NEG)) {
2089 if (value <= (UV)IV_MAX) {
2090 SvIV_set(sv, (IV)value);
2092 /* it didn't overflow, and it was positive. */
2093 SvUV_set(sv, value);
2097 /* 2s complement assumption */
2098 if (value <= (UV)IV_MIN) {
2099 SvIV_set(sv, -(IV)value);
2101 /* Too negative for an IV. This is a double upgrade, but
2102 I'm assuming it will be rare. */
2103 if (SvTYPE(sv) < SVt_PVNV)
2104 sv_upgrade(sv, SVt_PVNV);
2108 SvNV_set(sv, -(NV)value);
2109 SvIV_set(sv, IV_MIN);
2114 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2115 != IS_NUMBER_IN_UV) {
2116 /* It wasn't an integer, or it overflowed the UV. */
2117 SvNV_set(sv, Atof(SvPVX_const(sv)));
2119 if (! numtype && ckWARN(WARN_NUMERIC))
2122 #if defined(USE_LONG_DOUBLE)
2123 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2124 PTR2UV(sv), SvNVX(sv)));
2126 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2127 PTR2UV(sv), SvNVX(sv)));
2130 #ifdef NV_PRESERVES_UV
2131 (void)SvIOKp_on(sv);
2133 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2134 SvIV_set(sv, I_V(SvNVX(sv)));
2135 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2138 /* Integer is imprecise. NOK, IOKp */
2140 /* UV will not work better than IV */
2142 if (SvNVX(sv) > (NV)UV_MAX) {
2144 /* Integer is inaccurate. NOK, IOKp, is UV */
2145 SvUV_set(sv, UV_MAX);
2148 SvUV_set(sv, U_V(SvNVX(sv)));
2149 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2150 NV preservse UV so can do correct comparison. */
2151 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2155 /* Integer is imprecise. NOK, IOKp, is UV */
2160 #else /* NV_PRESERVES_UV */
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2163 /* The UV slot will have been set from value returned by
2164 grok_number above. The NV slot has just been set using
2167 assert (SvIOKp(sv));
2169 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2170 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2171 /* Small enough to preserve all bits. */
2172 (void)SvIOKp_on(sv);
2174 SvIV_set(sv, I_V(SvNVX(sv)));
2175 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2177 /* Assumption: first non-preserved integer is < IV_MAX,
2178 this NV is in the preserved range, therefore: */
2179 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2181 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2184 sv_2iuv_non_preserve (sv, numtype);
2186 #endif /* NV_PRESERVES_UV */
2190 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2191 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2194 if (SvTYPE(sv) < SVt_IV)
2195 /* Typically the caller expects that sv_any is not NULL now. */
2196 sv_upgrade(sv, SVt_IV);
2200 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2201 PTR2UV(sv),SvUVX(sv)));
2202 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2208 Return the num value of an SV, doing any necessary string or integer
2209 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2216 Perl_sv_2nv(pTHX_ register SV *sv)
2220 if (SvGMAGICAL(sv)) {
2224 if (SvPOKp(sv) && SvLEN(sv)) {
2225 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2226 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2228 return Atof(SvPVX_const(sv));
2232 return (NV)SvUVX(sv);
2234 return (NV)SvIVX(sv);
2237 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2238 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2244 if (SvTHINKFIRST(sv)) {
2247 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2248 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2249 return SvNV(tmpstr);
2250 return PTR2NV(SvRV(sv));
2253 sv_force_normal_flags(sv, 0);
2255 if (SvREADONLY(sv) && !SvOK(sv)) {
2256 if (ckWARN(WARN_UNINITIALIZED))
2261 if (SvTYPE(sv) < SVt_NV) {
2262 if (SvTYPE(sv) == SVt_IV)
2263 sv_upgrade(sv, SVt_PVNV);
2265 sv_upgrade(sv, SVt_NV);
2266 #ifdef USE_LONG_DOUBLE
2268 STORE_NUMERIC_LOCAL_SET_STANDARD();
2269 PerlIO_printf(Perl_debug_log,
2270 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2271 PTR2UV(sv), SvNVX(sv));
2272 RESTORE_NUMERIC_LOCAL();
2276 STORE_NUMERIC_LOCAL_SET_STANDARD();
2277 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2278 PTR2UV(sv), SvNVX(sv));
2279 RESTORE_NUMERIC_LOCAL();
2283 else if (SvTYPE(sv) < SVt_PVNV)
2284 sv_upgrade(sv, SVt_PVNV);
2289 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2290 #ifdef NV_PRESERVES_UV
2293 /* Only set the public NV OK flag if this NV preserves the IV */
2294 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2295 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2296 : (SvIVX(sv) == I_V(SvNVX(sv))))
2302 else if (SvPOKp(sv) && SvLEN(sv)) {
2304 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2305 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2307 #ifdef NV_PRESERVES_UV
2308 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2309 == IS_NUMBER_IN_UV) {
2310 /* It's definitely an integer */
2311 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2313 SvNV_set(sv, Atof(SvPVX_const(sv)));
2316 SvNV_set(sv, Atof(SvPVX_const(sv)));
2317 /* Only set the public NV OK flag if this NV preserves the value in
2318 the PV at least as well as an IV/UV would.
2319 Not sure how to do this 100% reliably. */
2320 /* if that shift count is out of range then Configure's test is
2321 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2323 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2324 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2325 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2326 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2327 /* Can't use strtol etc to convert this string, so don't try.
2328 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2331 /* value has been set. It may not be precise. */
2332 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2333 /* 2s complement assumption for (UV)IV_MIN */
2334 SvNOK_on(sv); /* Integer is too negative. */
2339 if (numtype & IS_NUMBER_NEG) {
2340 SvIV_set(sv, -(IV)value);
2341 } else if (value <= (UV)IV_MAX) {
2342 SvIV_set(sv, (IV)value);
2344 SvUV_set(sv, value);
2348 if (numtype & IS_NUMBER_NOT_INT) {
2349 /* I believe that even if the original PV had decimals,
2350 they are lost beyond the limit of the FP precision.
2351 However, neither is canonical, so both only get p
2352 flags. NWC, 2000/11/25 */
2353 /* Both already have p flags, so do nothing */
2355 const NV nv = SvNVX(sv);
2356 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2357 if (SvIVX(sv) == I_V(nv)) {
2362 /* It had no "." so it must be integer. */
2365 /* between IV_MAX and NV(UV_MAX).
2366 Could be slightly > UV_MAX */
2368 if (numtype & IS_NUMBER_NOT_INT) {
2369 /* UV and NV both imprecise. */
2371 const UV nv_as_uv = U_V(nv);
2373 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2384 #endif /* NV_PRESERVES_UV */
2387 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2389 if (SvTYPE(sv) < SVt_NV)
2390 /* Typically the caller expects that sv_any is not NULL now. */
2391 /* XXX Ilya implies that this is a bug in callers that assume this
2392 and ideally should be fixed. */
2393 sv_upgrade(sv, SVt_NV);
2396 #if defined(USE_LONG_DOUBLE)
2398 STORE_NUMERIC_LOCAL_SET_STANDARD();
2399 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 STORE_NUMERIC_LOCAL_SET_STANDARD();
2406 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2407 PTR2UV(sv), SvNVX(sv));
2408 RESTORE_NUMERIC_LOCAL();
2414 /* asIV(): extract an integer from the string value of an SV.
2415 * Caller must validate PVX */
2418 S_asIV(pTHX_ SV *sv)
2421 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2424 == IS_NUMBER_IN_UV) {
2425 /* It's definitely an integer */
2426 if (numtype & IS_NUMBER_NEG) {
2427 if (value < (UV)IV_MIN)
2430 if (value < (UV)IV_MAX)
2435 if (ckWARN(WARN_NUMERIC))
2438 return I_V(Atof(SvPVX_const(sv)));
2441 /* asUV(): extract an unsigned integer from the string value of an SV
2442 * Caller must validate PVX */
2445 S_asUV(pTHX_ SV *sv)
2448 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2450 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2451 == IS_NUMBER_IN_UV) {
2452 /* It's definitely an integer */
2453 if (!(numtype & IS_NUMBER_NEG))
2457 if (ckWARN(WARN_NUMERIC))
2460 return U_V(Atof(SvPVX_const(sv)));
2463 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2464 * UV as a string towards the end of buf, and return pointers to start and
2467 * We assume that buf is at least TYPE_CHARS(UV) long.
2471 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2473 char *ptr = buf + TYPE_CHARS(UV);
2474 char * const ebuf = ptr;
2487 *--ptr = '0' + (char)(uv % 10);
2496 =for apidoc sv_2pv_flags
2498 Returns a pointer to the string value of an SV, and sets *lp to its length.
2499 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2501 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2502 usually end up here too.
2508 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2513 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2514 char *tmpbuf = tbuf;
2515 STRLEN len = 0; /* Hush gcc. len is always initialised before use. */
2522 if (SvGMAGICAL(sv)) {
2523 if (flags & SV_GMAGIC)
2528 if (flags & SV_MUTABLE_RETURN)
2529 return SvPVX_mutable(sv);
2530 if (flags & SV_CONST_RETURN)
2531 return (char *)SvPVX_const(sv);
2535 len = SvIsUV(sv) ? my_sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv))
2536 : my_sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
2538 goto tokensave_has_len;
2541 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
2546 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2547 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2555 if (SvTHINKFIRST(sv)) {
2558 register const char *typestr;
2559 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
2560 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2562 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr); */
2565 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2566 if (flags & SV_CONST_RETURN) {
2567 pv = (char *) SvPVX_const(tmpstr);
2569 pv = (flags & SV_MUTABLE_RETURN)
2570 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2573 *lp = SvCUR(tmpstr);
2575 pv = sv_2pv_flags(tmpstr, lp, flags);
2586 typestr = "NULLREF";
2590 if (SvTYPE(sv) == SVt_PVMG && ((SvFLAGS(sv) &
2591 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2592 == (SVs_OBJECT|SVs_SMG))
2593 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2594 const regexp *re = (regexp *)mg->mg_obj;
2597 const char *fptr = "msix";
2602 char need_newline = 0;
2604 (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2606 while((ch = *fptr++)) {
2608 reflags[left++] = ch;
2611 reflags[right--] = ch;
2616 reflags[left] = '-';
2620 mg->mg_len = re->prelen + 4 + left;
2622 * If /x was used, we have to worry about a regex
2623 * ending with a comment later being embedded
2624 * within another regex. If so, we don't want this
2625 * regex's "commentization" to leak out to the
2626 * right part of the enclosing regex, we must cap
2627 * it with a newline.
2629 * So, if /x was used, we scan backwards from the
2630 * end of the regex. If we find a '#' before we
2631 * find a newline, we need to add a newline
2632 * ourself. If we find a '\n' first (or if we
2633 * don't find '#' or '\n'), we don't need to add
2634 * anything. -jfriedl
2636 if (PMf_EXTENDED & re->reganch) {
2637 const char *endptr = re->precomp + re->prelen;
2638 while (endptr >= re->precomp) {
2639 const char c = *(endptr--);
2641 break; /* don't need another */
2643 /* we end while in a comment, so we
2645 mg->mg_len++; /* save space for it */
2646 need_newline = 1; /* note to add it */
2652 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2653 Copy("(?", mg->mg_ptr, 2, char);
2654 Copy(reflags, mg->mg_ptr+2, left, char);
2655 Copy(":", mg->mg_ptr+left+2, 1, char);
2656 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2658 mg->mg_ptr[mg->mg_len - 2] = '\n';
2659 mg->mg_ptr[mg->mg_len - 1] = ')';
2660 mg->mg_ptr[mg->mg_len] = 0;
2662 PL_reginterp_cnt += re->program[0].next_off;
2664 if (re->reganch & ROPT_UTF8)
2673 typestr = sv_reftype(sv, 0);
2675 tsv = sv_newmortal();
2677 const char * const name = HvNAME_get(SvSTASH(sv));
2678 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2679 name ? name : "__ANON__" , typestr, PTR2UV(sv));
2682 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
2688 *lp = strlen(typestr);
2689 return (char *)typestr;
2691 if (SvREADONLY(sv) && !SvOK(sv)) {
2692 if (ckWARN(WARN_UNINITIALIZED))
2699 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2700 /* I'm assuming that if both IV and NV are equally valid then
2701 converting the IV is going to be more efficient */
2702 const U32 isIOK = SvIOK(sv);
2703 const U32 isUIOK = SvIsUV(sv);
2704 char buf[TYPE_CHARS(UV)];
2707 if (SvTYPE(sv) < SVt_PVIV)
2708 sv_upgrade(sv, SVt_PVIV);
2710 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2712 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2713 /* inlined from sv_setpvn */
2714 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2715 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2716 SvCUR_set(sv, ebuf - ptr);
2726 else if (SvNOKp(sv)) {
2727 if (SvTYPE(sv) < SVt_PVNV)
2728 sv_upgrade(sv, SVt_PVNV);
2729 /* The +20 is pure guesswork. Configure test needed. --jhi */
2730 s = SvGROW_mutable(sv, NV_DIG + 20);
2731 olderrno = errno; /* some Xenix systems wipe out errno here */
2733 if (SvNVX(sv) == 0.0)
2734 (void)strcpy(s,"0");
2738 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2741 #ifdef FIXNEGATIVEZERO
2742 if (*s == '-' && s[1] == '0' && !s[2])
2752 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2756 if (SvTYPE(sv) < SVt_PV)
2757 /* Typically the caller expects that sv_any is not NULL now. */
2758 sv_upgrade(sv, SVt_PV);
2762 const STRLEN len = s - SvPVX_const(sv);
2768 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2769 PTR2UV(sv),SvPVX_const(sv)));
2770 if (flags & SV_CONST_RETURN)
2771 return (char *)SvPVX_const(sv);
2772 if (flags & SV_MUTABLE_RETURN)
2773 return SvPVX_mutable(sv);
2777 len = strlen(tmpbuf);
2780 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2781 /* Sneaky stuff here */
2784 tsv = newSVpvn(tmpbuf, len);
2793 #ifdef FIXNEGATIVEZERO
2794 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2800 SvUPGRADE(sv, SVt_PV);
2803 s = SvGROW_mutable(sv, len + 1);
2806 return memcpy(s, tmpbuf, len + 1);
2811 =for apidoc sv_copypv
2813 Copies a stringified representation of the source SV into the
2814 destination SV. Automatically performs any necessary mg_get and
2815 coercion of numeric values into strings. Guaranteed to preserve
2816 UTF-8 flag even from overloaded objects. Similar in nature to
2817 sv_2pv[_flags] but operates directly on an SV instead of just the
2818 string. Mostly uses sv_2pv_flags to do its work, except when that
2819 would lose the UTF-8'ness of the PV.
2825 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2828 const char * const s = SvPV_const(ssv,len);
2829 sv_setpvn(dsv,s,len);
2837 =for apidoc sv_2pvbyte
2839 Return a pointer to the byte-encoded representation of the SV, and set *lp
2840 to its length. May cause the SV to be downgraded from UTF-8 as a
2843 Usually accessed via the C<SvPVbyte> macro.
2849 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2851 sv_utf8_downgrade(sv,0);
2852 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2856 =for apidoc sv_2pvutf8
2858 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2861 Usually accessed via the C<SvPVutf8> macro.
2867 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2869 sv_utf8_upgrade(sv);
2870 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2bool
2877 This function is only called on magical items, and is only used by
2878 sv_true() or its macro equivalent.
2884 Perl_sv_2bool(pTHX_ register SV *sv)
2892 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2893 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2894 return (bool)SvTRUE(tmpsv);
2895 return SvRV(sv) != 0;
2898 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2900 (*sv->sv_u.svu_pv > '0' ||
2901 Xpvtmp->xpv_cur > 1 ||
2902 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2909 return SvIVX(sv) != 0;
2912 return SvNVX(sv) != 0.0;
2920 =for apidoc sv_utf8_upgrade
2922 Converts the PV of an SV to its UTF-8-encoded form.
2923 Forces the SV to string form if it is not already.
2924 Always sets the SvUTF8 flag to avoid future validity checks even
2925 if all the bytes have hibit clear.
2927 This is not as a general purpose byte encoding to Unicode interface:
2928 use the Encode extension for that.
2930 =for apidoc sv_utf8_upgrade_flags
2932 Converts the PV of an SV to its UTF-8-encoded form.
2933 Forces the SV to string form if it is not already.
2934 Always sets the SvUTF8 flag to avoid future validity checks even
2935 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2936 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2937 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2939 This is not as a general purpose byte encoding to Unicode interface:
2940 use the Encode extension for that.
2946 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2948 if (sv == &PL_sv_undef)
2952 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2953 (void) sv_2pv_flags(sv,&len, flags);
2957 (void) SvPV_force(sv,len);
2966 sv_force_normal_flags(sv, 0);
2969 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2970 sv_recode_to_utf8(sv, PL_encoding);
2971 else { /* Assume Latin-1/EBCDIC */
2972 /* This function could be much more efficient if we
2973 * had a FLAG in SVs to signal if there are any hibit
2974 * chars in the PV. Given that there isn't such a flag
2975 * make the loop as fast as possible. */
2976 const U8 *s = (U8 *) SvPVX_const(sv);
2977 const U8 * const e = (U8 *) SvEND(sv);
2983 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2987 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2988 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2990 SvPV_free(sv); /* No longer using what was there before. */
2992 SvPV_set(sv, (char*)recoded);
2993 SvCUR_set(sv, len - 1);
2994 SvLEN_set(sv, len); /* No longer know the real size. */
2996 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3003 =for apidoc sv_utf8_downgrade
3005 Attempts to convert the PV of an SV from characters to bytes.
3006 If the PV contains a character beyond byte, this conversion will fail;
3007 in this case, either returns false or, if C<fail_ok> is not
3010 This is not as a general purpose Unicode to byte encoding interface:
3011 use the Encode extension for that.
3017 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3019 if (SvPOKp(sv) && SvUTF8(sv)) {
3025 sv_force_normal_flags(sv, 0);
3027 s = (U8 *) SvPV(sv, len);
3028 if (!utf8_to_bytes(s, &len)) {
3033 Perl_croak(aTHX_ "Wide character in %s",
3036 Perl_croak(aTHX_ "Wide character");
3047 =for apidoc sv_utf8_encode
3049 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3050 flag off so that it looks like octets again.
3056 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3058 (void) sv_utf8_upgrade(sv);
3060 sv_force_normal_flags(sv, 0);
3062 if (SvREADONLY(sv)) {
3063 Perl_croak(aTHX_ PL_no_modify);
3069 =for apidoc sv_utf8_decode
3071 If the PV of the SV is an octet sequence in UTF-8
3072 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3073 so that it looks like a character. If the PV contains only single-byte
3074 characters, the C<SvUTF8> flag stays being off.
3075 Scans PV for validity and returns false if the PV is invalid UTF-8.
3081 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3087 /* The octets may have got themselves encoded - get them back as
3090 if (!sv_utf8_downgrade(sv, TRUE))
3093 /* it is actually just a matter of turning the utf8 flag on, but
3094 * we want to make sure everything inside is valid utf8 first.
3096 c = (const U8 *) SvPVX_const(sv);
3097 if (!is_utf8_string(c, SvCUR(sv)+1))
3099 e = (const U8 *) SvEND(sv);
3102 if (!UTF8_IS_INVARIANT(ch)) {
3112 =for apidoc sv_setsv
3114 Copies the contents of the source SV C<ssv> into the destination SV
3115 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3116 function if the source SV needs to be reused. Does not handle 'set' magic.
3117 Loosely speaking, it performs a copy-by-value, obliterating any previous
3118 content of the destination.
3120 You probably want to use one of the assortment of wrappers, such as
3121 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3122 C<SvSetMagicSV_nosteal>.
3124 =for apidoc sv_setsv_flags
3126 Copies the contents of the source SV C<ssv> into the destination SV
3127 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3128 function if the source SV needs to be reused. Does not handle 'set' magic.
3129 Loosely speaking, it performs a copy-by-value, obliterating any previous
3130 content of the destination.
3131 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3132 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3133 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3134 and C<sv_setsv_nomg> are implemented in terms of this function.
3136 You probably want to use one of the assortment of wrappers, such as
3137 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3138 C<SvSetMagicSV_nosteal>.
3140 This is the primary function for copying scalars, and most other
3141 copy-ish functions and macros use this underneath.
3147 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3149 register U32 sflags;
3155 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3157 sstr = &PL_sv_undef;
3158 stype = SvTYPE(sstr);
3159 dtype = SvTYPE(dstr);
3164 /* need to nuke the magic */
3166 SvRMAGICAL_off(dstr);
3169 /* There's a lot of redundancy below but we're going for speed here */
3174 if (dtype != SVt_PVGV) {
3175 (void)SvOK_off(dstr);
3183 sv_upgrade(dstr, SVt_IV);
3186 sv_upgrade(dstr, SVt_PVNV);
3190 sv_upgrade(dstr, SVt_PVIV);
3193 (void)SvIOK_only(dstr);
3194 SvIV_set(dstr, SvIVX(sstr));
3197 if (SvTAINTED(sstr))
3208 sv_upgrade(dstr, SVt_NV);
3213 sv_upgrade(dstr, SVt_PVNV);
3216 SvNV_set(dstr, SvNVX(sstr));
3217 (void)SvNOK_only(dstr);
3218 if (SvTAINTED(sstr))
3226 sv_upgrade(dstr, SVt_RV);
3227 else if (dtype == SVt_PVGV &&
3228 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3231 if (GvIMPORTED(dstr) != GVf_IMPORTED
3232 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3234 GvIMPORTED_on(dstr);
3243 #ifdef PERL_OLD_COPY_ON_WRITE
3244 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3245 if (dtype < SVt_PVIV)
3246 sv_upgrade(dstr, SVt_PVIV);
3253 sv_upgrade(dstr, SVt_PV);
3256 if (dtype < SVt_PVIV)
3257 sv_upgrade(dstr, SVt_PVIV);
3260 if (dtype < SVt_PVNV)
3261 sv_upgrade(dstr, SVt_PVNV);
3268 const char * const type = sv_reftype(sstr,0);
3270 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3272 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3277 if (dtype <= SVt_PVGV) {
3279 if (dtype != SVt_PVGV) {
3280 const char * const name = GvNAME(sstr);
3281 const STRLEN len = GvNAMELEN(sstr);
3282 /* don't upgrade SVt_PVLV: it can hold a glob */
3283 if (dtype != SVt_PVLV)
3284 sv_upgrade(dstr, SVt_PVGV);
3285 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3286 GvSTASH(dstr) = GvSTASH(sstr);
3288 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3289 GvNAME(dstr) = savepvn(name, len);
3290 GvNAMELEN(dstr) = len;
3291 SvFAKE_on(dstr); /* can coerce to non-glob */
3294 #ifdef GV_UNIQUE_CHECK
3295 if (GvUNIQUE((GV*)dstr)) {
3296 Perl_croak(aTHX_ PL_no_modify);
3300 (void)SvOK_off(dstr);
3301 GvINTRO_off(dstr); /* one-shot flag */
3303 GvGP(dstr) = gp_ref(GvGP(sstr));
3304 if (SvTAINTED(sstr))
3306 if (GvIMPORTED(dstr) != GVf_IMPORTED
3307 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3309 GvIMPORTED_on(dstr);
3317 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3319 if ((int)SvTYPE(sstr) != stype) {
3320 stype = SvTYPE(sstr);
3321 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3325 if (stype == SVt_PVLV)
3326 SvUPGRADE(dstr, SVt_PVNV);
3328 SvUPGRADE(dstr, (U32)stype);
3331 sflags = SvFLAGS(sstr);
3333 if (sflags & SVf_ROK) {
3334 if (dtype >= SVt_PV) {
3335 if (dtype == SVt_PVGV) {
3336 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3338 const int intro = GvINTRO(dstr);
3340 #ifdef GV_UNIQUE_CHECK
3341 if (GvUNIQUE((GV*)dstr)) {
3342 Perl_croak(aTHX_ PL_no_modify);
3347 GvINTRO_off(dstr); /* one-shot flag */
3348 GvLINE(dstr) = CopLINE(PL_curcop);
3349 GvEGV(dstr) = (GV*)dstr;
3352 switch (SvTYPE(sref)) {
3355 SAVEGENERICSV(GvAV(dstr));
3357 dref = (SV*)GvAV(dstr);
3358 GvAV(dstr) = (AV*)sref;
3359 if (!GvIMPORTED_AV(dstr)
3360 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3362 GvIMPORTED_AV_on(dstr);
3367 SAVEGENERICSV(GvHV(dstr));
3369 dref = (SV*)GvHV(dstr);
3370 GvHV(dstr) = (HV*)sref;
3371 if (!GvIMPORTED_HV(dstr)
3372 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3374 GvIMPORTED_HV_on(dstr);
3379 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3380 SvREFCNT_dec(GvCV(dstr));
3381 GvCV(dstr) = Nullcv;
3382 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3383 PL_sub_generation++;
3385 SAVEGENERICSV(GvCV(dstr));
3388 dref = (SV*)GvCV(dstr);
3389 if (GvCV(dstr) != (CV*)sref) {
3390 CV* const cv = GvCV(dstr);
3392 if (!GvCVGEN((GV*)dstr) &&
3393 (CvROOT(cv) || CvXSUB(cv)))
3395 /* Redefining a sub - warning is mandatory if
3396 it was a const and its value changed. */
3397 if (ckWARN(WARN_REDEFINE)
3399 && (!CvCONST((CV*)sref)
3400 || sv_cmp(cv_const_sv(cv),
3401 cv_const_sv((CV*)sref)))))
3403 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3405 ? "Constant subroutine %s::%s redefined"
3406 : "Subroutine %s::%s redefined",
3407 HvNAME_get(GvSTASH((GV*)dstr)),
3408 GvENAME((GV*)dstr));
3412 cv_ckproto(cv, (GV*)dstr,
3414 ? SvPVX_const(sref) : Nullch);
3416 GvCV(dstr) = (CV*)sref;
3417 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3418 GvASSUMECV_on(dstr);
3419 PL_sub_generation++;
3421 if (!GvIMPORTED_CV(dstr)
3422 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3424 GvIMPORTED_CV_on(dstr);
3429 SAVEGENERICSV(GvIOp(dstr));
3431 dref = (SV*)GvIOp(dstr);
3432 GvIOp(dstr) = (IO*)sref;
3436 SAVEGENERICSV(GvFORM(dstr));
3438 dref = (SV*)GvFORM(dstr);
3439 GvFORM(dstr) = (CV*)sref;
3443 SAVEGENERICSV(GvSV(dstr));
3445 dref = (SV*)GvSV(dstr);
3447 if (!GvIMPORTED_SV(dstr)
3448 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3450 GvIMPORTED_SV_on(dstr);
3456 if (SvTAINTED(sstr))
3460 if (SvPVX_const(dstr)) {
3466 (void)SvOK_off(dstr);
3467 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3469 if (sflags & SVp_NOK) {
3471 /* Only set the public OK flag if the source has public OK. */
3472 if (sflags & SVf_NOK)
3473 SvFLAGS(dstr) |= SVf_NOK;
3474 SvNV_set(dstr, SvNVX(sstr));
3476 if (sflags & SVp_IOK) {
3477 (void)SvIOKp_on(dstr);
3478 if (sflags & SVf_IOK)
3479 SvFLAGS(dstr) |= SVf_IOK;
3480 if (sflags & SVf_IVisUV)
3482 SvIV_set(dstr, SvIVX(sstr));
3484 if (SvAMAGIC(sstr)) {
3488 else if (sflags & SVp_POK) {
3492 * Check to see if we can just swipe the string. If so, it's a
3493 * possible small lose on short strings, but a big win on long ones.
3494 * It might even be a win on short strings if SvPVX_const(dstr)
3495 * has to be allocated and SvPVX_const(sstr) has to be freed.
3498 /* Whichever path we take through the next code, we want this true,
3499 and doing it now facilitates the COW check. */
3500 (void)SvPOK_only(dstr);
3503 /* We're not already COW */
3504 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3505 #ifndef PERL_OLD_COPY_ON_WRITE
3506 /* or we are, but dstr isn't a suitable target. */
3507 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3512 (sflags & SVs_TEMP) && /* slated for free anyway? */
3513 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3514 (!(flags & SV_NOSTEAL)) &&
3515 /* and we're allowed to steal temps */
3516 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3517 SvLEN(sstr) && /* and really is a string */
3518 /* and won't be needed again, potentially */
3519 !(PL_op && PL_op->op_type == OP_AASSIGN))
3520 #ifdef PERL_OLD_COPY_ON_WRITE
3521 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3522 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3523 && SvTYPE(sstr) >= SVt_PVIV)
3526 /* Failed the swipe test, and it's not a shared hash key either.
3527 Have to copy the string. */
3528 STRLEN len = SvCUR(sstr);
3529 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3530 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3531 SvCUR_set(dstr, len);
3532 *SvEND(dstr) = '\0';
3534 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3536 /* Either it's a shared hash key, or it's suitable for
3537 copy-on-write or we can swipe the string. */
3539 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3543 #ifdef PERL_OLD_COPY_ON_WRITE
3545 /* I believe I should acquire a global SV mutex if
3546 it's a COW sv (not a shared hash key) to stop
3547 it going un copy-on-write.
3548 If the source SV has gone un copy on write between up there
3549 and down here, then (assert() that) it is of the correct
3550 form to make it copy on write again */
3551 if ((sflags & (SVf_FAKE | SVf_READONLY))
3552 != (SVf_FAKE | SVf_READONLY)) {
3553 SvREADONLY_on(sstr);
3555 /* Make the source SV into a loop of 1.
3556 (about to become 2) */
3557 SV_COW_NEXT_SV_SET(sstr, sstr);
3561 /* Initial code is common. */
3562 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3567 /* making another shared SV. */
3568 STRLEN cur = SvCUR(sstr);
3569 STRLEN len = SvLEN(sstr);
3570 #ifdef PERL_OLD_COPY_ON_WRITE
3572 assert (SvTYPE(dstr) >= SVt_PVIV);
3573 /* SvIsCOW_normal */
3574 /* splice us in between source and next-after-source. */
3575 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3576 SV_COW_NEXT_SV_SET(sstr, dstr);
3577 SvPV_set(dstr, SvPVX_mutable(sstr));
3581 /* SvIsCOW_shared_hash */
3582 DEBUG_C(PerlIO_printf(Perl_debug_log,
3583 "Copy on write: Sharing hash\n"));
3585 assert (SvTYPE(dstr) >= SVt_PV);
3587 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3589 SvLEN_set(dstr, len);
3590 SvCUR_set(dstr, cur);
3591 SvREADONLY_on(dstr);
3593 /* Relesase a global SV mutex. */
3596 { /* Passes the swipe test. */
3597 SvPV_set(dstr, SvPVX_mutable(sstr));
3598 SvLEN_set(dstr, SvLEN(sstr));
3599 SvCUR_set(dstr, SvCUR(sstr));
3602 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3603 SvPV_set(sstr, Nullch);
3609 if (sflags & SVf_UTF8)
3611 if (sflags & SVp_NOK) {
3613 if (sflags & SVf_NOK)
3614 SvFLAGS(dstr) |= SVf_NOK;
3615 SvNV_set(dstr, SvNVX(sstr));
3617 if (sflags & SVp_IOK) {
3618 (void)SvIOKp_on(dstr);
3619 if (sflags & SVf_IOK)
3620 SvFLAGS(dstr) |= SVf_IOK;
3621 if (sflags & SVf_IVisUV)
3623 SvIV_set(dstr, SvIVX(sstr));
3626 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3627 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3628 smg->mg_ptr, smg->mg_len);
3629 SvRMAGICAL_on(dstr);
3632 else if (sflags & SVp_IOK) {
3633 if (sflags & SVf_IOK)
3634 (void)SvIOK_only(dstr);
3636 (void)SvOK_off(dstr);
3637 (void)SvIOKp_on(dstr);
3639 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3640 if (sflags & SVf_IVisUV)
3642 SvIV_set(dstr, SvIVX(sstr));
3643 if (sflags & SVp_NOK) {
3644 if (sflags & SVf_NOK)
3645 (void)SvNOK_on(dstr);
3647 (void)SvNOKp_on(dstr);
3648 SvNV_set(dstr, SvNVX(sstr));
3651 else if (sflags & SVp_NOK) {
3652 if (sflags & SVf_NOK)
3653 (void)SvNOK_only(dstr);
3655 (void)SvOK_off(dstr);
3658 SvNV_set(dstr, SvNVX(sstr));
3661 if (dtype == SVt_PVGV) {
3662 if (ckWARN(WARN_MISC))
3663 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3666 (void)SvOK_off(dstr);
3668 if (SvTAINTED(sstr))
3673 =for apidoc sv_setsv_mg
3675 Like C<sv_setsv>, but also handles 'set' magic.
3681 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3683 sv_setsv(dstr,sstr);
3687 #ifdef PERL_OLD_COPY_ON_WRITE
3689 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3691 STRLEN cur = SvCUR(sstr);
3692 STRLEN len = SvLEN(sstr);
3693 register char *new_pv;
3696 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3704 if (SvTHINKFIRST(dstr))
3705 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3706 else if (SvPVX_const(dstr))
3707 Safefree(SvPVX_const(dstr));
3711 SvUPGRADE(dstr, SVt_PVIV);
3713 assert (SvPOK(sstr));
3714 assert (SvPOKp(sstr));
3715 assert (!SvIOK(sstr));
3716 assert (!SvIOKp(sstr));
3717 assert (!SvNOK(sstr));
3718 assert (!SvNOKp(sstr));
3720 if (SvIsCOW(sstr)) {
3722 if (SvLEN(sstr) == 0) {
3723 /* source is a COW shared hash key. */
3724 DEBUG_C(PerlIO_printf(Perl_debug_log,
3725 "Fast copy on write: Sharing hash\n"));
3726 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3729 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3731 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3732 SvUPGRADE(sstr, SVt_PVIV);
3733 SvREADONLY_on(sstr);
3735 DEBUG_C(PerlIO_printf(Perl_debug_log,
3736 "Fast copy on write: Converting sstr to COW\n"));
3737 SV_COW_NEXT_SV_SET(dstr, sstr);
3739 SV_COW_NEXT_SV_SET(sstr, dstr);
3740 new_pv = SvPVX_mutable(sstr);
3743 SvPV_set(dstr, new_pv);
3744 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3747 SvLEN_set(dstr, len);
3748 SvCUR_set(dstr, cur);
3757 =for apidoc sv_setpvn
3759 Copies a string into an SV. The C<len> parameter indicates the number of
3760 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3761 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3767 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3769 register char *dptr;
3771 SV_CHECK_THINKFIRST_COW_DROP(sv);
3777 /* len is STRLEN which is unsigned, need to copy to signed */
3780 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3782 SvUPGRADE(sv, SVt_PV);
3784 dptr = SvGROW(sv, len + 1);
3785 Move(ptr,dptr,len,char);
3788 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3793 =for apidoc sv_setpvn_mg
3795 Like C<sv_setpvn>, but also handles 'set' magic.
3801 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3803 sv_setpvn(sv,ptr,len);
3808 =for apidoc sv_setpv
3810 Copies a string into an SV. The string must be null-terminated. Does not
3811 handle 'set' magic. See C<sv_setpv_mg>.
3817 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3819 register STRLEN len;
3821 SV_CHECK_THINKFIRST_COW_DROP(sv);
3827 SvUPGRADE(sv, SVt_PV);
3829 SvGROW(sv, len + 1);
3830 Move(ptr,SvPVX(sv),len+1,char);
3832 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3837 =for apidoc sv_setpv_mg
3839 Like C<sv_setpv>, but also handles 'set' magic.
3845 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3852 =for apidoc sv_usepvn
3854 Tells an SV to use C<ptr> to find its string value. Normally the string is
3855 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3856 The C<ptr> should point to memory that was allocated by C<malloc>. The
3857 string length, C<len>, must be supplied. This function will realloc the
3858 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3859 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3860 See C<sv_usepvn_mg>.
3866 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3869 SV_CHECK_THINKFIRST_COW_DROP(sv);
3870 SvUPGRADE(sv, SVt_PV);
3875 if (SvPVX_const(sv))
3878 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3879 ptr = saferealloc (ptr, allocate);
3882 SvLEN_set(sv, allocate);
3884 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3889 =for apidoc sv_usepvn_mg
3891 Like C<sv_usepvn>, but also handles 'set' magic.
3897 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3899 sv_usepvn(sv,ptr,len);
3903 #ifdef PERL_OLD_COPY_ON_WRITE
3904 /* Need to do this *after* making the SV normal, as we need the buffer
3905 pointer to remain valid until after we've copied it. If we let go too early,
3906 another thread could invalidate it by unsharing last of the same hash key
3907 (which it can do by means other than releasing copy-on-write Svs)
3908 or by changing the other copy-on-write SVs in the loop. */
3910 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3912 if (len) { /* this SV was SvIsCOW_normal(sv) */
3913 /* we need to find the SV pointing to us. */
3914 SV * const current = SV_COW_NEXT_SV(after);
3916 if (current == sv) {
3917 /* The SV we point to points back to us (there were only two of us
3919 Hence other SV is no longer copy on write either. */
3921 SvREADONLY_off(after);
3923 /* We need to follow the pointers around the loop. */
3925 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3928 /* don't loop forever if the structure is bust, and we have
3929 a pointer into a closed loop. */
3930 assert (current != after);
3931 assert (SvPVX_const(current) == pvx);
3933 /* Make the SV before us point to the SV after us. */
3934 SV_COW_NEXT_SV_SET(current, after);
3937 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3942 Perl_sv_release_IVX(pTHX_ register SV *sv)
3945 sv_force_normal_flags(sv, 0);
3951 =for apidoc sv_force_normal_flags
3953 Undo various types of fakery on an SV: if the PV is a shared string, make
3954 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3955 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3956 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3957 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3958 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3959 set to some other value.) In addition, the C<flags> parameter gets passed to
3960 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3961 with flags set to 0.
3967 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3969 #ifdef PERL_OLD_COPY_ON_WRITE
3970 if (SvREADONLY(sv)) {
3971 /* At this point I believe I should acquire a global SV mutex. */
3973 const char * const pvx = SvPVX_const(sv);
3974 const STRLEN len = SvLEN(sv);
3975 const STRLEN cur = SvCUR(sv);
3976 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3978 PerlIO_printf(Perl_debug_log,
3979 "Copy on write: Force normal %ld\n",
3985 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3986 SvPV_set(sv, (char*)0);
3988 if (flags & SV_COW_DROP_PV) {
3989 /* OK, so we don't need to copy our buffer. */
3992 SvGROW(sv, cur + 1);
3993 Move(pvx,SvPVX(sv),cur,char);
3997 sv_release_COW(sv, pvx, len, next);
4002 else if (IN_PERL_RUNTIME)
4003 Perl_croak(aTHX_ PL_no_modify);
4004 /* At this point I believe that I can drop the global SV mutex. */
4007 if (SvREADONLY(sv)) {
4009 const char * const pvx = SvPVX_const(sv);
4010 const STRLEN len = SvCUR(sv);
4013 SvPV_set(sv, Nullch);
4015 SvGROW(sv, len + 1);
4016 Move(pvx,SvPVX(sv),len,char);
4018 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4020 else if (IN_PERL_RUNTIME)
4021 Perl_croak(aTHX_ PL_no_modify);
4025 sv_unref_flags(sv, flags);
4026 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4033 Efficient removal of characters from the beginning of the string buffer.
4034 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4035 the string buffer. The C<ptr> becomes the first character of the adjusted
4036 string. Uses the "OOK hack".
4037 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4038 refer to the same chunk of data.
4044 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4046 register STRLEN delta;
4047 if (!ptr || !SvPOKp(sv))
4049 delta = ptr - SvPVX_const(sv);
4050 SV_CHECK_THINKFIRST(sv);
4051 if (SvTYPE(sv) < SVt_PVIV)
4052 sv_upgrade(sv,SVt_PVIV);
4055 if (!SvLEN(sv)) { /* make copy of shared string */
4056 const char *pvx = SvPVX_const(sv);
4057 const STRLEN len = SvCUR(sv);
4058 SvGROW(sv, len + 1);
4059 Move(pvx,SvPVX(sv),len,char);
4063 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4064 and we do that anyway inside the SvNIOK_off
4066 SvFLAGS(sv) |= SVf_OOK;
4069 SvLEN_set(sv, SvLEN(sv) - delta);
4070 SvCUR_set(sv, SvCUR(sv) - delta);
4071 SvPV_set(sv, SvPVX(sv) + delta);
4072 SvIV_set(sv, SvIVX(sv) + delta);
4076 =for apidoc sv_catpvn
4078 Concatenates the string onto the end of the string which is in the SV. The
4079 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4080 status set, then the bytes appended should be valid UTF-8.
4081 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4083 =for apidoc sv_catpvn_flags
4085 Concatenates the string onto the end of the string which is in the SV. The
4086 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4087 status set, then the bytes appended should be valid UTF-8.
4088 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4089 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4090 in terms of this function.
4096 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4099 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4101 SvGROW(dsv, dlen + slen + 1);
4103 sstr = SvPVX_const(dsv);
4104 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4105 SvCUR_set(dsv, SvCUR(dsv) + slen);
4107 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4109 if (flags & SV_SMAGIC)
4114 =for apidoc sv_catsv
4116 Concatenates the string from SV C<ssv> onto the end of the string in
4117 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4118 not 'set' magic. See C<sv_catsv_mg>.
4120 =for apidoc sv_catsv_flags
4122 Concatenates the string from SV C<ssv> onto the end of the string in
4123 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4124 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4125 and C<sv_catsv_nomg> are implemented in terms of this function.
4130 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4135 if ((spv = SvPV_const(ssv, slen))) {
4136 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4137 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4138 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4139 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4140 dsv->sv_flags doesn't have that bit set.
4141 Andy Dougherty 12 Oct 2001
4143 const I32 sutf8 = DO_UTF8(ssv);
4146 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4148 dutf8 = DO_UTF8(dsv);
4150 if (dutf8 != sutf8) {
4152 /* Not modifying source SV, so taking a temporary copy. */
4153 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4155 sv_utf8_upgrade(csv);
4156 spv = SvPV_const(csv, slen);
4159 sv_utf8_upgrade_nomg(dsv);
4161 sv_catpvn_nomg(dsv, spv, slen);
4164 if (flags & SV_SMAGIC)
4169 =for apidoc sv_catpv
4171 Concatenates the string onto the end of the string which is in the SV.
4172 If the SV has the UTF-8 status set, then the bytes appended should be
4173 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4178 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4180 register STRLEN len;
4186 junk = SvPV_force(sv, tlen);
4188 SvGROW(sv, tlen + len + 1);
4190 ptr = SvPVX_const(sv);
4191 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4192 SvCUR_set(sv, SvCUR(sv) + len);
4193 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4198 =for apidoc sv_catpv_mg
4200 Like C<sv_catpv>, but also handles 'set' magic.
4206 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4215 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4216 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4223 Perl_newSV(pTHX_ STRLEN len)
4229 sv_upgrade(sv, SVt_PV);
4230 SvGROW(sv, len + 1);
4235 =for apidoc sv_magicext
4237 Adds magic to an SV, upgrading it if necessary. Applies the
4238 supplied vtable and returns a pointer to the magic added.
4240 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4241 In particular, you can add magic to SvREADONLY SVs, and add more than
4242 one instance of the same 'how'.
4244 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4245 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4246 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4247 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4249 (This is now used as a subroutine by C<sv_magic>.)
4254 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4255 const char* name, I32 namlen)
4259 if (SvTYPE(sv) < SVt_PVMG) {
4260 SvUPGRADE(sv, SVt_PVMG);
4262 Newxz(mg, 1, MAGIC);
4263 mg->mg_moremagic = SvMAGIC(sv);
4264 SvMAGIC_set(sv, mg);
4266 /* Sometimes a magic contains a reference loop, where the sv and
4267 object refer to each other. To prevent a reference loop that
4268 would prevent such objects being freed, we look for such loops
4269 and if we find one we avoid incrementing the object refcount.
4271 Note we cannot do this to avoid self-tie loops as intervening RV must
4272 have its REFCNT incremented to keep it in existence.
4275 if (!obj || obj == sv ||
4276 how == PERL_MAGIC_arylen ||
4277 how == PERL_MAGIC_qr ||
4278 how == PERL_MAGIC_symtab ||
4279 (SvTYPE(obj) == SVt_PVGV &&
4280 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4281 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4282 GvFORM(obj) == (CV*)sv)))
4287 mg->mg_obj = SvREFCNT_inc(obj);
4288 mg->mg_flags |= MGf_REFCOUNTED;
4291 /* Normal self-ties simply pass a null object, and instead of
4292 using mg_obj directly, use the SvTIED_obj macro to produce a
4293 new RV as needed. For glob "self-ties", we are tieing the PVIO
4294 with an RV obj pointing to the glob containing the PVIO. In
4295 this case, to avoid a reference loop, we need to weaken the
4299 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4300 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4306 mg->mg_len = namlen;
4309 mg->mg_ptr = savepvn(name, namlen);
4310 else if (namlen == HEf_SVKEY)
4311 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4313 mg->mg_ptr = (char *) name;
4315 mg->mg_virtual = vtable;
4319 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4324 =for apidoc sv_magic
4326 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4327 then adds a new magic item of type C<how> to the head of the magic list.
4329 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4330 handling of the C<name> and C<namlen> arguments.
4332 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4333 to add more than one instance of the same 'how'.
4339 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4341 const MGVTBL *vtable;
4344 #ifdef PERL_OLD_COPY_ON_WRITE
4346 sv_force_normal_flags(sv, 0);
4348 if (SvREADONLY(sv)) {
4350 /* its okay to attach magic to shared strings; the subsequent
4351 * upgrade to PVMG will unshare the string */
4352 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4355 && how != PERL_MAGIC_regex_global
4356 && how != PERL_MAGIC_bm
4357 && how != PERL_MAGIC_fm
4358 && how != PERL_MAGIC_sv
4359 && how != PERL_MAGIC_backref
4362 Perl_croak(aTHX_ PL_no_modify);
4365 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4366 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4367 /* sv_magic() refuses to add a magic of the same 'how' as an
4370 if (how == PERL_MAGIC_taint)
4378 vtable = &PL_vtbl_sv;
4380 case PERL_MAGIC_overload:
4381 vtable = &PL_vtbl_amagic;
4383 case PERL_MAGIC_overload_elem:
4384 vtable = &PL_vtbl_amagicelem;
4386 case PERL_MAGIC_overload_table:
4387 vtable = &PL_vtbl_ovrld;
4390 vtable = &PL_vtbl_bm;
4392 case PERL_MAGIC_regdata:
4393 vtable = &PL_vtbl_regdata;
4395 case PERL_MAGIC_regdatum:
4396 vtable = &PL_vtbl_regdatum;
4398 case PERL_MAGIC_env:
4399 vtable = &PL_vtbl_env;
4402 vtable = &PL_vtbl_fm;
4404 case PERL_MAGIC_envelem:
4405 vtable = &PL_vtbl_envelem;
4407 case PERL_MAGIC_regex_global:
4408 vtable = &PL_vtbl_mglob;
4410 case PERL_MAGIC_isa:
4411 vtable = &PL_vtbl_isa;
4413 case PERL_MAGIC_isaelem:
4414 vtable = &PL_vtbl_isaelem;
4416 case PERL_MAGIC_nkeys:
4417 vtable = &PL_vtbl_nkeys;
4419 case PERL_MAGIC_dbfile:
4422 case PERL_MAGIC_dbline:
4423 vtable = &PL_vtbl_dbline;
4425 #ifdef USE_LOCALE_COLLATE
4426 case PERL_MAGIC_collxfrm:
4427 vtable = &PL_vtbl_collxfrm;
4429 #endif /* USE_LOCALE_COLLATE */
4430 case PERL_MAGIC_tied:
4431 vtable = &PL_vtbl_pack;
4433 case PERL_MAGIC_tiedelem:
4434 case PERL_MAGIC_tiedscalar:
4435 vtable = &PL_vtbl_packelem;
4438 vtable = &PL_vtbl_regexp;
4440 case PERL_MAGIC_sig:
4441 vtable = &PL_vtbl_sig;
4443 case PERL_MAGIC_sigelem:
4444 vtable = &PL_vtbl_sigelem;
4446 case PERL_MAGIC_taint:
4447 vtable = &PL_vtbl_taint;
4449 case PERL_MAGIC_uvar:
4450 vtable = &PL_vtbl_uvar;
4452 case PERL_MAGIC_vec:
4453 vtable = &PL_vtbl_vec;
4455 case PERL_MAGIC_arylen_p:
4456 case PERL_MAGIC_rhash:
4457 case PERL_MAGIC_symtab:
4458 case PERL_MAGIC_vstring:
4461 case PERL_MAGIC_utf8:
4462 vtable = &PL_vtbl_utf8;
4464 case PERL_MAGIC_substr:
4465 vtable = &PL_vtbl_substr;
4467 case PERL_MAGIC_defelem:
4468 vtable = &PL_vtbl_defelem;
4470 case PERL_MAGIC_glob:
4471 vtable = &PL_vtbl_glob;
4473 case PERL_MAGIC_arylen:
4474 vtable = &PL_vtbl_arylen;
4476 case PERL_MAGIC_pos:
4477 vtable = &PL_vtbl_pos;
4479 case PERL_MAGIC_backref:
4480 vtable = &PL_vtbl_backref;
4482 case PERL_MAGIC_ext:
4483 /* Reserved for use by extensions not perl internals. */
4484 /* Useful for attaching extension internal data to perl vars. */
4485 /* Note that multiple extensions may clash if magical scalars */
4486 /* etc holding private data from one are passed to another. */
4490 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4493 /* Rest of work is done else where */
4494 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4497 case PERL_MAGIC_taint:
4500 case PERL_MAGIC_ext:
4501 case PERL_MAGIC_dbfile:
4508 =for apidoc sv_unmagic
4510 Removes all magic of type C<type> from an SV.
4516 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4520 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4523 for (mg = *mgp; mg; mg = *mgp) {
4524 if (mg->mg_type == type) {
4525 const MGVTBL* const vtbl = mg->mg_virtual;
4526 *mgp = mg->mg_moremagic;
4527 if (vtbl && vtbl->svt_free)
4528 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4529 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4531 Safefree(mg->mg_ptr);
4532 else if (mg->mg_len == HEf_SVKEY)
4533 SvREFCNT_dec((SV*)mg->mg_ptr);
4534 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4535 Safefree(mg->mg_ptr);
4537 if (mg->mg_flags & MGf_REFCOUNTED)
4538 SvREFCNT_dec(mg->mg_obj);
4542 mgp = &mg->mg_moremagic;
4546 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4553 =for apidoc sv_rvweaken
4555 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4556 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4557 push a back-reference to this RV onto the array of backreferences
4558 associated with that magic.
4564 Perl_sv_rvweaken(pTHX_ SV *sv)
4567 if (!SvOK(sv)) /* let undefs pass */
4570 Perl_croak(aTHX_ "Can't weaken a nonreference");
4571 else if (SvWEAKREF(sv)) {
4572 if (ckWARN(WARN_MISC))
4573 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4577 Perl_sv_add_backref(aTHX_ tsv, sv);
4583 /* Give tsv backref magic if it hasn't already got it, then push a
4584 * back-reference to sv onto the array associated with the backref magic.
4588 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4592 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4593 av = (AV*)mg->mg_obj;
4596 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4597 /* av now has a refcnt of 2, which avoids it getting freed
4598 * before us during global cleanup. The extra ref is removed
4599 * by magic_killbackrefs() when tsv is being freed */
4601 if (AvFILLp(av) >= AvMAX(av)) {
4602 av_extend(av, AvFILLp(av)+1);
4604 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4607 /* delete a back-reference to ourselves from the backref magic associated
4608 * with the SV we point to.
4612 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4618 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4619 if (PL_in_clean_all)
4622 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4623 Perl_croak(aTHX_ "panic: del_backref");
4624 av = (AV *)mg->mg_obj;
4626 /* We shouldn't be in here more than once, but for paranoia reasons lets
4628 for (i = AvFILLp(av); i >= 0; i--) {
4630 const SSize_t fill = AvFILLp(av);
4632 /* We weren't the last entry.
4633 An unordered list has this property that you can take the
4634 last element off the end to fill the hole, and it's still
4635 an unordered list :-)
4640 AvFILLp(av) = fill - 1;
4646 =for apidoc sv_insert
4648 Inserts a string at the specified offset/length within the SV. Similar to
4649 the Perl substr() function.
4655 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4659 register char *midend;
4660 register char *bigend;
4666 Perl_croak(aTHX_ "Can't modify non-existent substring");
4667 SvPV_force(bigstr, curlen);
4668 (void)SvPOK_only_UTF8(bigstr);
4669 if (offset + len > curlen) {
4670 SvGROW(bigstr, offset+len+1);
4671 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4672 SvCUR_set(bigstr, offset+len);
4676 i = littlelen - len;
4677 if (i > 0) { /* string might grow */
4678 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4679 mid = big + offset + len;
4680 midend = bigend = big + SvCUR(bigstr);
4683 while (midend > mid) /* shove everything down */
4684 *--bigend = *--midend;
4685 Move(little,big+offset,littlelen,char);
4686 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4691 Move(little,SvPVX(bigstr)+offset,len,char);
4696 big = SvPVX(bigstr);
4699 bigend = big + SvCUR(bigstr);
4701 if (midend > bigend)
4702 Perl_croak(aTHX_ "panic: sv_insert");
4704 if (mid - big > bigend - midend) { /* faster to shorten from end */
4706 Move(little, mid, littlelen,char);
4709 i = bigend - midend;
4711 Move(midend, mid, i,char);
4715 SvCUR_set(bigstr, mid - big);
4717 else if ((i = mid - big)) { /* faster from front */
4718 midend -= littlelen;
4720 sv_chop(bigstr,midend-i);
4725 Move(little, mid, littlelen,char);
4727 else if (littlelen) {
4728 midend -= littlelen;
4729 sv_chop(bigstr,midend);
4730 Move(little,midend,littlelen,char);
4733 sv_chop(bigstr,midend);
4739 =for apidoc sv_replace
4741 Make the first argument a copy of the second, then delete the original.
4742 The target SV physically takes over ownership of the body of the source SV
4743 and inherits its flags; however, the target keeps any magic it owns,
4744 and any magic in the source is discarded.
4745 Note that this is a rather specialist SV copying operation; most of the
4746 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4752 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4754 const U32 refcnt = SvREFCNT(sv);
4755 SV_CHECK_THINKFIRST_COW_DROP(sv);
4756 if (SvREFCNT(nsv) != 1) {
4757 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4758 UVuf " != 1)", (UV) SvREFCNT(nsv));
4760 if (SvMAGICAL(sv)) {
4764 sv_upgrade(nsv, SVt_PVMG);
4765 SvMAGIC_set(nsv, SvMAGIC(sv));
4766 SvFLAGS(nsv) |= SvMAGICAL(sv);
4768 SvMAGIC_set(sv, NULL);
4772 assert(!SvREFCNT(sv));
4773 #ifdef DEBUG_LEAKING_SCALARS
4774 sv->sv_flags = nsv->sv_flags;
4775 sv->sv_any = nsv->sv_any;
4776 sv->sv_refcnt = nsv->sv_refcnt;
4777 sv->sv_u = nsv->sv_u;
4779 StructCopy(nsv,sv,SV);
4781 /* Currently could join these into one piece of pointer arithmetic, but
4782 it would be unclear. */
4783 if(SvTYPE(sv) == SVt_IV)
4785 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4786 else if (SvTYPE(sv) == SVt_RV) {
4787 SvANY(sv) = &sv->sv_u.svu_rv;
4791 #ifdef PERL_OLD_COPY_ON_WRITE
4792 if (SvIsCOW_normal(nsv)) {
4793 /* We need to follow the pointers around the loop to make the
4794 previous SV point to sv, rather than nsv. */
4797 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4800 assert(SvPVX_const(current) == SvPVX_const(nsv));
4802 /* Make the SV before us point to the SV after us. */
4804 PerlIO_printf(Perl_debug_log, "previous is\n");
4806 PerlIO_printf(Perl_debug_log,
4807 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4808 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4810 SV_COW_NEXT_SV_SET(current, sv);
4813 SvREFCNT(sv) = refcnt;
4814 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4820 =for apidoc sv_clear
4822 Clear an SV: call any destructors, free up any memory used by the body,
4823 and free the body itself. The SV's head is I<not> freed, although
4824 its type is set to all 1's so that it won't inadvertently be assumed
4825 to be live during global destruction etc.
4826 This function should only be called when REFCNT is zero. Most of the time
4827 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4834 Perl_sv_clear(pTHX_ register SV *sv)
4837 const U32 type = SvTYPE(sv);
4838 const struct body_details *const sv_type_details
4839 = bodies_by_type + type;
4842 assert(SvREFCNT(sv) == 0);
4848 if (PL_defstash) { /* Still have a symbol table? */
4853 stash = SvSTASH(sv);
4854 destructor = StashHANDLER(stash,DESTROY);
4856 SV* const tmpref = newRV(sv);
4857 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4859 PUSHSTACKi(PERLSI_DESTROY);
4864 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4870 if(SvREFCNT(tmpref) < 2) {
4871 /* tmpref is not kept alive! */
4873 SvRV_set(tmpref, NULL);
4876 SvREFCNT_dec(tmpref);
4878 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4882 if (PL_in_clean_objs)
4883 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4885 /* DESTROY gave object new lease on life */
4891 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4892 SvOBJECT_off(sv); /* Curse the object. */
4893 if (type != SVt_PVIO)
4894 --PL_sv_objcount; /* XXX Might want something more general */
4897 if (type >= SVt_PVMG) {
4900 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4901 SvREFCNT_dec(SvSTASH(sv));
4906 IoIFP(sv) != PerlIO_stdin() &&
4907 IoIFP(sv) != PerlIO_stdout() &&
4908 IoIFP(sv) != PerlIO_stderr())
4910 io_close((IO*)sv, FALSE);
4912 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4913 PerlDir_close(IoDIRP(sv));
4914 IoDIRP(sv) = (DIR*)NULL;
4915 Safefree(IoTOP_NAME(sv));
4916 Safefree(IoFMT_NAME(sv));
4917 Safefree(IoBOTTOM_NAME(sv));
4932 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4933 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4934 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4935 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4937 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4938 SvREFCNT_dec(LvTARG(sv));
4942 Safefree(GvNAME(sv));
4943 /* If we're in a stash, we don't own a reference to it. However it does
4944 have a back reference to us, which needs to be cleared. */
4946 sv_del_backref((SV*)GvSTASH(sv), sv);
4951 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4953 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4954 /* Don't even bother with turning off the OOK flag. */
4959 SV *target = SvRV(sv);
4961 sv_del_backref(target, sv);
4963 SvREFCNT_dec(target);
4965 #ifdef PERL_OLD_COPY_ON_WRITE
4966 else if (SvPVX_const(sv)) {
4968 /* I believe I need to grab the global SV mutex here and
4969 then recheck the COW status. */
4971 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4974 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4975 SV_COW_NEXT_SV(sv));
4976 /* And drop it here. */
4978 } else if (SvLEN(sv)) {
4979 Safefree(SvPVX_const(sv));
4983 else if (SvPVX_const(sv) && SvLEN(sv))
4984 Safefree(SvPVX_mutable(sv));
4985 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4986 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4995 SvFLAGS(sv) &= SVf_BREAK;
4996 SvFLAGS(sv) |= SVTYPEMASK;
4998 if (sv_type_details->arena) {
4999 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5000 &PL_body_roots[type]);
5002 else if (sv_type_details->size) {
5003 my_safefree(SvANY(sv));
5008 =for apidoc sv_newref
5010 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5017 Perl_sv_newref(pTHX_ SV *sv)
5027 Decrement an SV's reference count, and if it drops to zero, call
5028 C<sv_clear> to invoke destructors and free up any memory used by
5029 the body; finally, deallocate the SV's head itself.
5030 Normally called via a wrapper macro C<SvREFCNT_dec>.
5036 Perl_sv_free(pTHX_ SV *sv)
5041 if (SvREFCNT(sv) == 0) {
5042 if (SvFLAGS(sv) & SVf_BREAK)
5043 /* this SV's refcnt has been artificially decremented to
5044 * trigger cleanup */
5046 if (PL_in_clean_all) /* All is fair */
5048 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5049 /* make sure SvREFCNT(sv)==0 happens very seldom */
5050 SvREFCNT(sv) = (~(U32)0)/2;
5053 if (ckWARN_d(WARN_INTERNAL)) {
5054 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5055 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5056 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5057 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5058 Perl_dump_sv_child(aTHX_ sv);
5063 if (--(SvREFCNT(sv)) > 0)
5065 Perl_sv_free2(aTHX_ sv);
5069 Perl_sv_free2(pTHX_ SV *sv)
5074 if (ckWARN_d(WARN_DEBUGGING))
5075 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5076 "Attempt to free temp prematurely: SV 0x%"UVxf
5077 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5081 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5082 /* make sure SvREFCNT(sv)==0 happens very seldom */
5083 SvREFCNT(sv) = (~(U32)0)/2;
5094 Returns the length of the string in the SV. Handles magic and type
5095 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5101 Perl_sv_len(pTHX_ register SV *sv)
5109 len = mg_length(sv);
5111 (void)SvPV_const(sv, len);
5116 =for apidoc sv_len_utf8
5118 Returns the number of characters in the string in an SV, counting wide
5119 UTF-8 bytes as a single character. Handles magic and type coercion.
5125 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5126 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5127 * (Note that the mg_len is not the length of the mg_ptr field.)
5132 Perl_sv_len_utf8(pTHX_ register SV *sv)
5138 return mg_length(sv);
5142 const U8 *s = (U8*)SvPV_const(sv, len);
5143 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5145 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5147 #ifdef PERL_UTF8_CACHE_ASSERT
5148 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5152 ulen = Perl_utf8_length(aTHX_ s, s + len);
5153 if (!mg && !SvREADONLY(sv)) {
5154 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5155 mg = mg_find(sv, PERL_MAGIC_utf8);
5165 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5166 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5167 * between UTF-8 and byte offsets. There are two (substr offset and substr
5168 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5169 * and byte offset) cache positions.
5171 * The mg_len field is used by sv_len_utf8(), see its comments.
5172 * Note that the mg_len is not the length of the mg_ptr field.
5176 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5177 I32 offsetp, const U8 *s, const U8 *start)
5181 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5183 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5187 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5189 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5190 (*mgp)->mg_ptr = (char *) *cachep;
5194 (*cachep)[i] = offsetp;
5195 (*cachep)[i+1] = s - start;
5203 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5204 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5205 * between UTF-8 and byte offsets. See also the comments of
5206 * S_utf8_mg_pos_init().
5210 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)
5214 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5216 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5217 if (*mgp && (*mgp)->mg_ptr) {
5218 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5219 ASSERT_UTF8_CACHE(*cachep);
5220 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5222 else { /* We will skip to the right spot. */
5227 /* The assumption is that going backward is half
5228 * the speed of going forward (that's where the
5229 * 2 * backw in the below comes from). (The real
5230 * figure of course depends on the UTF-8 data.) */
5232 if ((*cachep)[i] > (STRLEN)uoff) {
5234 backw = (*cachep)[i] - (STRLEN)uoff;
5236 if (forw < 2 * backw)
5239 p = start + (*cachep)[i+1];
5241 /* Try this only for the substr offset (i == 0),
5242 * not for the substr length (i == 2). */
5243 else if (i == 0) { /* (*cachep)[i] < uoff */
5244 const STRLEN ulen = sv_len_utf8(sv);
5246 if ((STRLEN)uoff < ulen) {
5247 forw = (STRLEN)uoff - (*cachep)[i];
5248 backw = ulen - (STRLEN)uoff;
5250 if (forw < 2 * backw)
5251 p = start + (*cachep)[i+1];
5256 /* If the string is not long enough for uoff,
5257 * we could extend it, but not at this low a level. */
5261 if (forw < 2 * backw) {
5268 while (UTF8_IS_CONTINUATION(*p))
5273 /* Update the cache. */
5274 (*cachep)[i] = (STRLEN)uoff;
5275 (*cachep)[i+1] = p - start;
5277 /* Drop the stale "length" cache */
5286 if (found) { /* Setup the return values. */
5287 *offsetp = (*cachep)[i+1];
5288 *sp = start + *offsetp;
5291 *offsetp = send - start;
5293 else if (*sp < start) {
5299 #ifdef PERL_UTF8_CACHE_ASSERT
5304 while (n-- && s < send)
5308 assert(*offsetp == s - start);
5309 assert((*cachep)[0] == (STRLEN)uoff);
5310 assert((*cachep)[1] == *offsetp);
5312 ASSERT_UTF8_CACHE(*cachep);
5321 =for apidoc sv_pos_u2b
5323 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5324 the start of the string, to a count of the equivalent number of bytes; if
5325 lenp is non-zero, it does the same to lenp, but this time starting from
5326 the offset, rather than from the start of the string. Handles magic and
5333 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5334 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5335 * byte offsets. See also the comments of S_utf8_mg_pos().
5340 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5348 start = (U8*)SvPV_const(sv, len);
5352 const U8 *s = start;
5353 I32 uoffset = *offsetp;
5354 const U8 * const send = s + len;
5358 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5360 if (!found && uoffset > 0) {
5361 while (s < send && uoffset--)
5365 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5367 *offsetp = s - start;
5372 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5376 if (!found && *lenp > 0) {
5379 while (s < send && ulen--)
5383 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5387 ASSERT_UTF8_CACHE(cache);
5399 =for apidoc sv_pos_b2u
5401 Converts the value pointed to by offsetp from a count of bytes from the
5402 start of the string, to a count of the equivalent number of UTF-8 chars.
5403 Handles magic and type coercion.
5409 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5410 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5411 * byte offsets. See also the comments of S_utf8_mg_pos().
5416 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5424 s = (const U8*)SvPV_const(sv, len);
5425 if ((I32)len < *offsetp)
5426 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5428 const U8* send = s + *offsetp;
5430 STRLEN *cache = NULL;
5434 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5435 mg = mg_find(sv, PERL_MAGIC_utf8);
5436 if (mg && mg->mg_ptr) {
5437 cache = (STRLEN *) mg->mg_ptr;
5438 if (cache[1] == (STRLEN)*offsetp) {
5439 /* An exact match. */
5440 *offsetp = cache[0];
5444 else if (cache[1] < (STRLEN)*offsetp) {
5445 /* We already know part of the way. */
5448 /* Let the below loop do the rest. */
5450 else { /* cache[1] > *offsetp */
5451 /* We already know all of the way, now we may
5452 * be able to walk back. The same assumption
5453 * is made as in S_utf8_mg_pos(), namely that
5454 * walking backward is twice slower than
5455 * walking forward. */
5456 const STRLEN forw = *offsetp;
5457 STRLEN backw = cache[1] - *offsetp;
5459 if (!(forw < 2 * backw)) {
5460 const U8 *p = s + cache[1];
5467 while (UTF8_IS_CONTINUATION(*p)) {
5475 *offsetp = cache[0];
5477 /* Drop the stale "length" cache */
5485 ASSERT_UTF8_CACHE(cache);
5491 /* Call utf8n_to_uvchr() to validate the sequence
5492 * (unless a simple non-UTF character) */
5493 if (!UTF8_IS_INVARIANT(*s))
5494 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5503 if (!SvREADONLY(sv)) {
5505 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5506 mg = mg_find(sv, PERL_MAGIC_utf8);
5511 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5512 mg->mg_ptr = (char *) cache;
5517 cache[1] = *offsetp;
5518 /* Drop the stale "length" cache */
5531 Returns a boolean indicating whether the strings in the two SVs are
5532 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5533 coerce its args to strings if necessary.
5539 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5547 SV* svrecode = Nullsv;
5554 pv1 = SvPV_const(sv1, cur1);
5561 pv2 = SvPV_const(sv2, cur2);
5563 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5564 /* Differing utf8ness.
5565 * Do not UTF8size the comparands as a side-effect. */
5568 svrecode = newSVpvn(pv2, cur2);
5569 sv_recode_to_utf8(svrecode, PL_encoding);
5570 pv2 = SvPV_const(svrecode, cur2);
5573 svrecode = newSVpvn(pv1, cur1);
5574 sv_recode_to_utf8(svrecode, PL_encoding);
5575 pv1 = SvPV_const(svrecode, cur1);
5577 /* Now both are in UTF-8. */
5579 SvREFCNT_dec(svrecode);
5584 bool is_utf8 = TRUE;
5587 /* sv1 is the UTF-8 one,
5588 * if is equal it must be downgrade-able */
5589 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5595 /* sv2 is the UTF-8 one,
5596 * if is equal it must be downgrade-able */
5597 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5603 /* Downgrade not possible - cannot be eq */
5611 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5614 SvREFCNT_dec(svrecode);
5625 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5626 string in C<sv1> is less than, equal to, or greater than the string in
5627 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5628 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5634 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5637 const char *pv1, *pv2;
5640 SV *svrecode = Nullsv;
5647 pv1 = SvPV_const(sv1, cur1);
5654 pv2 = SvPV_const(sv2, cur2);
5656 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5657 /* Differing utf8ness.
5658 * Do not UTF8size the comparands as a side-effect. */
5661 svrecode = newSVpvn(pv2, cur2);
5662 sv_recode_to_utf8(svrecode, PL_encoding);
5663 pv2 = SvPV_const(svrecode, cur2);
5666 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5671 svrecode = newSVpvn(pv1, cur1);
5672 sv_recode_to_utf8(svrecode, PL_encoding);
5673 pv1 = SvPV_const(svrecode, cur1);
5676 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5682 cmp = cur2 ? -1 : 0;
5686 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5689 cmp = retval < 0 ? -1 : 1;
5690 } else if (cur1 == cur2) {
5693 cmp = cur1 < cur2 ? -1 : 1;
5698 SvREFCNT_dec(svrecode);
5707 =for apidoc sv_cmp_locale
5709 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5710 'use bytes' aware, handles get magic, and will coerce its args to strings
5711 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5717 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5719 #ifdef USE_LOCALE_COLLATE
5725 if (PL_collation_standard)
5729 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5731 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5733 if (!pv1 || !len1) {
5744 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5747 return retval < 0 ? -1 : 1;
5750 * When the result of collation is equality, that doesn't mean
5751 * that there are no differences -- some locales exclude some
5752 * characters from consideration. So to avoid false equalities,
5753 * we use the raw string as a tiebreaker.
5759 #endif /* USE_LOCALE_COLLATE */
5761 return sv_cmp(sv1, sv2);
5765 #ifdef USE_LOCALE_COLLATE
5768 =for apidoc sv_collxfrm
5770 Add Collate Transform magic to an SV if it doesn't already have it.
5772 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5773 scalar data of the variable, but transformed to such a format that a normal
5774 memory comparison can be used to compare the data according to the locale
5781 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5785 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5786 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5792 Safefree(mg->mg_ptr);
5793 s = SvPV_const(sv, len);
5794 if ((xf = mem_collxfrm(s, len, &xlen))) {
5795 if (SvREADONLY(sv)) {
5798 return xf + sizeof(PL_collation_ix);
5801 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5802 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5815 if (mg && mg->mg_ptr) {
5817 return mg->mg_ptr + sizeof(PL_collation_ix);
5825 #endif /* USE_LOCALE_COLLATE */
5830 Get a line from the filehandle and store it into the SV, optionally
5831 appending to the currently-stored string.
5837 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5841 register STDCHAR rslast;
5842 register STDCHAR *bp;
5848 if (SvTHINKFIRST(sv))
5849 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5850 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5852 However, perlbench says it's slower, because the existing swipe code
5853 is faster than copy on write.
5854 Swings and roundabouts. */
5855 SvUPGRADE(sv, SVt_PV);
5860 if (PerlIO_isutf8(fp)) {
5862 sv_utf8_upgrade_nomg(sv);
5863 sv_pos_u2b(sv,&append,0);
5865 } else if (SvUTF8(sv)) {
5866 SV * const tsv = NEWSV(0,0);
5867 sv_gets(tsv, fp, 0);
5868 sv_utf8_upgrade_nomg(tsv);
5869 SvCUR_set(sv,append);
5872 goto return_string_or_null;
5877 if (PerlIO_isutf8(fp))
5880 if (IN_PERL_COMPILETIME) {
5881 /* we always read code in line mode */
5885 else if (RsSNARF(PL_rs)) {
5886 /* If it is a regular disk file use size from stat() as estimate
5887 of amount we are going to read - may result in malloc-ing
5888 more memory than we realy need if layers bellow reduce
5889 size we read (e.g. CRLF or a gzip layer)
5892 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5893 const Off_t offset = PerlIO_tell(fp);
5894 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5895 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5901 else if (RsRECORD(PL_rs)) {
5905 /* Grab the size of the record we're getting */
5906 recsize = SvIV(SvRV(PL_rs));
5907 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5910 /* VMS wants read instead of fread, because fread doesn't respect */
5911 /* RMS record boundaries. This is not necessarily a good thing to be */
5912 /* doing, but we've got no other real choice - except avoid stdio
5913 as implementation - perhaps write a :vms layer ?
5915 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5917 bytesread = PerlIO_read(fp, buffer, recsize);
5921 SvCUR_set(sv, bytesread += append);
5922 buffer[bytesread] = '\0';
5923 goto return_string_or_null;
5925 else if (RsPARA(PL_rs)) {
5931 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5932 if (PerlIO_isutf8(fp)) {
5933 rsptr = SvPVutf8(PL_rs, rslen);
5936 if (SvUTF8(PL_rs)) {
5937 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5938 Perl_croak(aTHX_ "Wide character in $/");
5941 rsptr = SvPV_const(PL_rs, rslen);
5945 rslast = rslen ? rsptr[rslen - 1] : '\0';
5947 if (rspara) { /* have to do this both before and after */
5948 do { /* to make sure file boundaries work right */
5951 i = PerlIO_getc(fp);
5955 PerlIO_ungetc(fp,i);
5961 /* See if we know enough about I/O mechanism to cheat it ! */
5963 /* This used to be #ifdef test - it is made run-time test for ease
5964 of abstracting out stdio interface. One call should be cheap
5965 enough here - and may even be a macro allowing compile
5969 if (PerlIO_fast_gets(fp)) {
5972 * We're going to steal some values from the stdio struct
5973 * and put EVERYTHING in the innermost loop into registers.
5975 register STDCHAR *ptr;
5979 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5980 /* An ungetc()d char is handled separately from the regular
5981 * buffer, so we getc() it back out and stuff it in the buffer.
5983 i = PerlIO_getc(fp);
5984 if (i == EOF) return 0;
5985 *(--((*fp)->_ptr)) = (unsigned char) i;
5989 /* Here is some breathtakingly efficient cheating */
5991 cnt = PerlIO_get_cnt(fp); /* get count into register */
5992 /* make sure we have the room */
5993 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5994 /* Not room for all of it
5995 if we are looking for a separator and room for some
5997 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5998 /* just process what we have room for */
5999 shortbuffered = cnt - SvLEN(sv) + append + 1;
6000 cnt -= shortbuffered;
6004 /* remember that cnt can be negative */
6005 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6010 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6011 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6012 DEBUG_P(PerlIO_printf(Perl_debug_log,
6013 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6014 DEBUG_P(PerlIO_printf(Perl_debug_log,
6015 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6016 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6017 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6022 while (cnt > 0) { /* this | eat */
6024 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6025 goto thats_all_folks; /* screams | sed :-) */
6029 Copy(ptr, bp, cnt, char); /* this | eat */
6030 bp += cnt; /* screams | dust */
6031 ptr += cnt; /* louder | sed :-) */
6036 if (shortbuffered) { /* oh well, must extend */
6037 cnt = shortbuffered;
6039 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6041 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6042 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6046 DEBUG_P(PerlIO_printf(Perl_debug_log,
6047 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6048 PTR2UV(ptr),(long)cnt));
6049 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6051 DEBUG_P(PerlIO_printf(Perl_debug_log,
6052 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6053 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6054 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6056 /* This used to call 'filbuf' in stdio form, but as that behaves like
6057 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6058 another abstraction. */
6059 i = PerlIO_getc(fp); /* get more characters */
6061 DEBUG_P(PerlIO_printf(Perl_debug_log,
6062 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6063 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6064 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6066 cnt = PerlIO_get_cnt(fp);
6067 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6068 DEBUG_P(PerlIO_printf(Perl_debug_log,
6069 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6071 if (i == EOF) /* all done for ever? */
6072 goto thats_really_all_folks;
6074 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6076 SvGROW(sv, bpx + cnt + 2);
6077 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6079 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6081 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6082 goto thats_all_folks;
6086 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6087 memNE((char*)bp - rslen, rsptr, rslen))
6088 goto screamer; /* go back to the fray */
6089 thats_really_all_folks:
6091 cnt += shortbuffered;
6092 DEBUG_P(PerlIO_printf(Perl_debug_log,
6093 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6094 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6095 DEBUG_P(PerlIO_printf(Perl_debug_log,
6096 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6097 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6098 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6100 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6101 DEBUG_P(PerlIO_printf(Perl_debug_log,
6102 "Screamer: done, len=%ld, string=|%.*s|\n",
6103 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6107 /*The big, slow, and stupid way. */
6108 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6110 Newx(buf, 8192, STDCHAR);
6118 register const STDCHAR *bpe = buf + sizeof(buf);
6120 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6121 ; /* keep reading */
6125 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6126 /* Accomodate broken VAXC compiler, which applies U8 cast to
6127 * both args of ?: operator, causing EOF to change into 255
6130 i = (U8)buf[cnt - 1];
6136 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6138 sv_catpvn(sv, (char *) buf, cnt);
6140 sv_setpvn(sv, (char *) buf, cnt);
6142 if (i != EOF && /* joy */
6144 SvCUR(sv) < rslen ||
6145 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6149 * If we're reading from a TTY and we get a short read,
6150 * indicating that the user hit his EOF character, we need
6151 * to notice it now, because if we try to read from the TTY
6152 * again, the EOF condition will disappear.
6154 * The comparison of cnt to sizeof(buf) is an optimization
6155 * that prevents unnecessary calls to feof().
6159 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6163 #ifdef USE_HEAP_INSTEAD_OF_STACK
6168 if (rspara) { /* have to do this both before and after */
6169 while (i != EOF) { /* to make sure file boundaries work right */
6170 i = PerlIO_getc(fp);
6172 PerlIO_ungetc(fp,i);
6178 return_string_or_null:
6179 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6185 Auto-increment of the value in the SV, doing string to numeric conversion
6186 if necessary. Handles 'get' magic.
6192 Perl_sv_inc(pTHX_ register SV *sv)
6200 if (SvTHINKFIRST(sv)) {
6202 sv_force_normal_flags(sv, 0);
6203 if (SvREADONLY(sv)) {
6204 if (IN_PERL_RUNTIME)
6205 Perl_croak(aTHX_ PL_no_modify);
6209 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6211 i = PTR2IV(SvRV(sv));
6216 flags = SvFLAGS(sv);
6217 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6218 /* It's (privately or publicly) a float, but not tested as an
6219 integer, so test it to see. */
6221 flags = SvFLAGS(sv);
6223 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6224 /* It's publicly an integer, or privately an integer-not-float */
6225 #ifdef PERL_PRESERVE_IVUV
6229 if (SvUVX(sv) == UV_MAX)
6230 sv_setnv(sv, UV_MAX_P1);
6232 (void)SvIOK_only_UV(sv);
6233 SvUV_set(sv, SvUVX(sv) + 1);
6235 if (SvIVX(sv) == IV_MAX)
6236 sv_setuv(sv, (UV)IV_MAX + 1);
6238 (void)SvIOK_only(sv);
6239 SvIV_set(sv, SvIVX(sv) + 1);
6244 if (flags & SVp_NOK) {
6245 (void)SvNOK_only(sv);
6246 SvNV_set(sv, SvNVX(sv) + 1.0);
6250 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6251 if ((flags & SVTYPEMASK) < SVt_PVIV)
6252 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6253 (void)SvIOK_only(sv);
6258 while (isALPHA(*d)) d++;
6259 while (isDIGIT(*d)) d++;
6261 #ifdef PERL_PRESERVE_IVUV
6262 /* Got to punt this as an integer if needs be, but we don't issue
6263 warnings. Probably ought to make the sv_iv_please() that does
6264 the conversion if possible, and silently. */
6265 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6266 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6267 /* Need to try really hard to see if it's an integer.
6268 9.22337203685478e+18 is an integer.
6269 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6270 so $a="9.22337203685478e+18"; $a+0; $a++
6271 needs to be the same as $a="9.22337203685478e+18"; $a++
6278 /* sv_2iv *should* have made this an NV */
6279 if (flags & SVp_NOK) {
6280 (void)SvNOK_only(sv);
6281 SvNV_set(sv, SvNVX(sv) + 1.0);
6284 /* I don't think we can get here. Maybe I should assert this
6285 And if we do get here I suspect that sv_setnv will croak. NWC
6287 #if defined(USE_LONG_DOUBLE)
6288 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",
6289 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6291 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6292 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6295 #endif /* PERL_PRESERVE_IVUV */
6296 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6300 while (d >= SvPVX_const(sv)) {
6308 /* MKS: The original code here died if letters weren't consecutive.
6309 * at least it didn't have to worry about non-C locales. The
6310 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6311 * arranged in order (although not consecutively) and that only
6312 * [A-Za-z] are accepted by isALPHA in the C locale.
6314 if (*d != 'z' && *d != 'Z') {
6315 do { ++*d; } while (!isALPHA(*d));
6318 *(d--) -= 'z' - 'a';
6323 *(d--) -= 'z' - 'a' + 1;
6327 /* oh,oh, the number grew */
6328 SvGROW(sv, SvCUR(sv) + 2);
6329 SvCUR_set(sv, SvCUR(sv) + 1);
6330 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6341 Auto-decrement of the value in the SV, doing string to numeric conversion
6342 if necessary. Handles 'get' magic.
6348 Perl_sv_dec(pTHX_ register SV *sv)
6355 if (SvTHINKFIRST(sv)) {
6357 sv_force_normal_flags(sv, 0);
6358 if (SvREADONLY(sv)) {
6359 if (IN_PERL_RUNTIME)
6360 Perl_croak(aTHX_ PL_no_modify);
6364 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6366 i = PTR2IV(SvRV(sv));
6371 /* Unlike sv_inc we don't have to worry about string-never-numbers
6372 and keeping them magic. But we mustn't warn on punting */
6373 flags = SvFLAGS(sv);
6374 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6375 /* It's publicly an integer, or privately an integer-not-float */
6376 #ifdef PERL_PRESERVE_IVUV
6380 if (SvUVX(sv) == 0) {
6381 (void)SvIOK_only(sv);
6385 (void)SvIOK_only_UV(sv);
6386 SvUV_set(sv, SvUVX(sv) - 1);
6389 if (SvIVX(sv) == IV_MIN)
6390 sv_setnv(sv, (NV)IV_MIN - 1.0);
6392 (void)SvIOK_only(sv);
6393 SvIV_set(sv, SvIVX(sv) - 1);
6398 if (flags & SVp_NOK) {
6399 SvNV_set(sv, SvNVX(sv) - 1.0);
6400 (void)SvNOK_only(sv);
6403 if (!(flags & SVp_POK)) {
6404 if ((flags & SVTYPEMASK) < SVt_PVIV)
6405 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6407 (void)SvIOK_only(sv);
6410 #ifdef PERL_PRESERVE_IVUV
6412 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6413 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6414 /* Need to try really hard to see if it's an integer.
6415 9.22337203685478e+18 is an integer.
6416 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6417 so $a="9.22337203685478e+18"; $a+0; $a--
6418 needs to be the same as $a="9.22337203685478e+18"; $a--
6425 /* sv_2iv *should* have made this an NV */
6426 if (flags & SVp_NOK) {
6427 (void)SvNOK_only(sv);
6428 SvNV_set(sv, SvNVX(sv) - 1.0);
6431 /* I don't think we can get here. Maybe I should assert this
6432 And if we do get here I suspect that sv_setnv will croak. NWC
6434 #if defined(USE_LONG_DOUBLE)
6435 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",
6436 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6438 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6439 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6443 #endif /* PERL_PRESERVE_IVUV */
6444 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6448 =for apidoc sv_mortalcopy
6450 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6451 The new SV is marked as mortal. It will be destroyed "soon", either by an
6452 explicit call to FREETMPS, or by an implicit call at places such as
6453 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6458 /* Make a string that will exist for the duration of the expression
6459 * evaluation. Actually, it may have to last longer than that, but
6460 * hopefully we won't free it until it has been assigned to a
6461 * permanent location. */
6464 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6469 sv_setsv(sv,oldstr);
6471 PL_tmps_stack[++PL_tmps_ix] = sv;
6477 =for apidoc sv_newmortal
6479 Creates a new null SV which is mortal. The reference count of the SV is
6480 set to 1. It will be destroyed "soon", either by an explicit call to
6481 FREETMPS, or by an implicit call at places such as statement boundaries.
6482 See also C<sv_mortalcopy> and C<sv_2mortal>.
6488 Perl_sv_newmortal(pTHX)
6493 SvFLAGS(sv) = SVs_TEMP;
6495 PL_tmps_stack[++PL_tmps_ix] = sv;
6500 =for apidoc sv_2mortal
6502 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6503 by an explicit call to FREETMPS, or by an implicit call at places such as
6504 statement boundaries. SvTEMP() is turned on which means that the SV's
6505 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6506 and C<sv_mortalcopy>.
6512 Perl_sv_2mortal(pTHX_ register SV *sv)
6517 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6520 PL_tmps_stack[++PL_tmps_ix] = sv;
6528 Creates a new SV and copies a string into it. The reference count for the
6529 SV is set to 1. If C<len> is zero, Perl will compute the length using
6530 strlen(). For efficiency, consider using C<newSVpvn> instead.
6536 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6541 sv_setpvn(sv,s,len ? len : strlen(s));
6546 =for apidoc newSVpvn
6548 Creates a new SV and copies a string into it. The reference count for the
6549 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6550 string. You are responsible for ensuring that the source string is at least
6551 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6557 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6562 sv_setpvn(sv,s,len);
6568 =for apidoc newSVhek
6570 Creates a new SV from the hash key structure. It will generate scalars that
6571 point to the shared string table where possible. Returns a new (undefined)
6572 SV if the hek is NULL.
6578 Perl_newSVhek(pTHX_ const HEK *hek)
6587 if (HEK_LEN(hek) == HEf_SVKEY) {
6588 return newSVsv(*(SV**)HEK_KEY(hek));
6590 const int flags = HEK_FLAGS(hek);
6591 if (flags & HVhek_WASUTF8) {
6593 Andreas would like keys he put in as utf8 to come back as utf8
6595 STRLEN utf8_len = HEK_LEN(hek);
6596 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6597 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6600 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6602 } else if (flags & HVhek_REHASH) {
6603 /* We don't have a pointer to the hv, so we have to replicate the
6604 flag into every HEK. This hv is using custom a hasing
6605 algorithm. Hence we can't return a shared string scalar, as
6606 that would contain the (wrong) hash value, and might get passed
6607 into an hv routine with a regular hash */
6609 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6614 /* This will be overwhelminly the most common case. */
6615 return newSVpvn_share(HEK_KEY(hek),
6616 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6622 =for apidoc newSVpvn_share
6624 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6625 table. If the string does not already exist in the table, it is created
6626 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6627 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6628 otherwise the hash is computed. The idea here is that as the string table
6629 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6630 hash lookup will avoid string compare.
6636 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6639 bool is_utf8 = FALSE;
6641 STRLEN tmplen = -len;
6643 /* See the note in hv.c:hv_fetch() --jhi */
6644 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6648 PERL_HASH(hash, src, len);
6650 sv_upgrade(sv, SVt_PV);
6651 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6663 #if defined(PERL_IMPLICIT_CONTEXT)
6665 /* pTHX_ magic can't cope with varargs, so this is a no-context
6666 * version of the main function, (which may itself be aliased to us).
6667 * Don't access this version directly.
6671 Perl_newSVpvf_nocontext(const char* pat, ...)
6676 va_start(args, pat);
6677 sv = vnewSVpvf(pat, &args);
6684 =for apidoc newSVpvf
6686 Creates a new SV and initializes it with the string formatted like
6693 Perl_newSVpvf(pTHX_ const char* pat, ...)
6697 va_start(args, pat);
6698 sv = vnewSVpvf(pat, &args);
6703 /* backend for newSVpvf() and newSVpvf_nocontext() */
6706 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6710 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6717 Creates a new SV and copies a floating point value into it.
6718 The reference count for the SV is set to 1.
6724 Perl_newSVnv(pTHX_ NV n)
6736 Creates a new SV and copies an integer into it. The reference count for the
6743 Perl_newSViv(pTHX_ IV i)
6755 Creates a new SV and copies an unsigned integer into it.
6756 The reference count for the SV is set to 1.
6762 Perl_newSVuv(pTHX_ UV u)
6772 =for apidoc newRV_noinc
6774 Creates an RV wrapper for an SV. The reference count for the original
6775 SV is B<not> incremented.
6781 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6786 sv_upgrade(sv, SVt_RV);
6788 SvRV_set(sv, tmpRef);
6793 /* newRV_inc is the official function name to use now.
6794 * newRV_inc is in fact #defined to newRV in sv.h
6798 Perl_newRV(pTHX_ SV *tmpRef)
6800 return newRV_noinc(SvREFCNT_inc(tmpRef));
6806 Creates a new SV which is an exact duplicate of the original SV.
6813 Perl_newSVsv(pTHX_ register SV *old)
6819 if (SvTYPE(old) == SVTYPEMASK) {
6820 if (ckWARN_d(WARN_INTERNAL))
6821 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6825 /* SV_GMAGIC is the default for sv_setv()
6826 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6827 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6828 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6833 =for apidoc sv_reset
6835 Underlying implementation for the C<reset> Perl function.
6836 Note that the perl-level function is vaguely deprecated.
6842 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6845 char todo[PERL_UCHAR_MAX+1];
6850 if (!*s) { /* reset ?? searches */
6851 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6853 PMOP *pm = (PMOP *) mg->mg_obj;
6855 pm->op_pmdynflags &= ~PMdf_USED;
6862 /* reset variables */
6864 if (!HvARRAY(stash))
6867 Zero(todo, 256, char);
6870 I32 i = (unsigned char)*s;
6874 max = (unsigned char)*s++;
6875 for ( ; i <= max; i++) {
6878 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6880 for (entry = HvARRAY(stash)[i];
6882 entry = HeNEXT(entry))
6887 if (!todo[(U8)*HeKEY(entry)])
6889 gv = (GV*)HeVAL(entry);
6892 if (SvTHINKFIRST(sv)) {
6893 if (!SvREADONLY(sv) && SvROK(sv))
6895 /* XXX Is this continue a bug? Why should THINKFIRST
6896 exempt us from resetting arrays and hashes? */
6900 if (SvTYPE(sv) >= SVt_PV) {
6902 if (SvPVX_const(sv) != Nullch)
6910 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6912 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6915 # if defined(USE_ENVIRON_ARRAY)
6918 # endif /* USE_ENVIRON_ARRAY */
6929 Using various gambits, try to get an IO from an SV: the IO slot if its a
6930 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6931 named after the PV if we're a string.
6937 Perl_sv_2io(pTHX_ SV *sv)
6942 switch (SvTYPE(sv)) {
6950 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6954 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6956 return sv_2io(SvRV(sv));
6957 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6963 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6972 Using various gambits, try to get a CV from an SV; in addition, try if
6973 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6979 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6986 return *gvp = Nullgv, Nullcv;
6987 switch (SvTYPE(sv)) {
7005 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7006 tryAMAGICunDEREF(to_cv);
7009 if (SvTYPE(sv) == SVt_PVCV) {
7018 Perl_croak(aTHX_ "Not a subroutine reference");
7023 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7029 if (lref && !GvCVu(gv)) {
7032 tmpsv = NEWSV(704,0);
7033 gv_efullname3(tmpsv, gv, Nullch);
7034 /* XXX this is probably not what they think they're getting.
7035 * It has the same effect as "sub name;", i.e. just a forward
7037 newSUB(start_subparse(FALSE, 0),
7038 newSVOP(OP_CONST, 0, tmpsv),
7043 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7053 Returns true if the SV has a true value by Perl's rules.
7054 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7055 instead use an in-line version.
7061 Perl_sv_true(pTHX_ register SV *sv)
7066 register const XPV* const tXpv = (XPV*)SvANY(sv);
7068 (tXpv->xpv_cur > 1 ||
7069 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7076 return SvIVX(sv) != 0;
7079 return SvNVX(sv) != 0.0;
7081 return sv_2bool(sv);
7087 =for apidoc sv_pvn_force
7089 Get a sensible string out of the SV somehow.
7090 A private implementation of the C<SvPV_force> macro for compilers which
7091 can't cope with complex macro expressions. Always use the macro instead.
7093 =for apidoc sv_pvn_force_flags
7095 Get a sensible string out of the SV somehow.
7096 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7097 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7098 implemented in terms of this function.
7099 You normally want to use the various wrapper macros instead: see
7100 C<SvPV_force> and C<SvPV_force_nomg>
7106 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7109 if (SvTHINKFIRST(sv) && !SvROK(sv))
7110 sv_force_normal_flags(sv, 0);
7120 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7121 const char * const ref = sv_reftype(sv,0);
7123 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7124 ref, OP_NAME(PL_op));
7126 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7128 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7129 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7131 s = sv_2pv_flags(sv, &len, flags);
7135 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7138 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7139 SvGROW(sv, len + 1);
7140 Move(s,SvPVX(sv),len,char);
7145 SvPOK_on(sv); /* validate pointer */
7147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7148 PTR2UV(sv),SvPVX_const(sv)));
7151 return SvPVX_mutable(sv);
7155 =for apidoc sv_pvbyten_force
7157 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7163 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7165 sv_pvn_force(sv,lp);
7166 sv_utf8_downgrade(sv,0);
7172 =for apidoc sv_pvutf8n_force
7174 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7180 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7182 sv_pvn_force(sv,lp);
7183 sv_utf8_upgrade(sv);
7189 =for apidoc sv_reftype
7191 Returns a string describing what the SV is a reference to.
7197 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7199 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7200 inside return suggests a const propagation bug in g++. */
7201 if (ob && SvOBJECT(sv)) {
7202 char * const name = HvNAME_get(SvSTASH(sv));
7203 return name ? name : (char *) "__ANON__";
7206 switch (SvTYPE(sv)) {
7223 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7224 /* tied lvalues should appear to be
7225 * scalars for backwards compatitbility */
7226 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7227 ? "SCALAR" : "LVALUE");
7228 case SVt_PVAV: return "ARRAY";
7229 case SVt_PVHV: return "HASH";
7230 case SVt_PVCV: return "CODE";
7231 case SVt_PVGV: return "GLOB";
7232 case SVt_PVFM: return "FORMAT";
7233 case SVt_PVIO: return "IO";
7234 default: return "UNKNOWN";
7240 =for apidoc sv_isobject
7242 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7243 object. If the SV is not an RV, or if the object is not blessed, then this
7250 Perl_sv_isobject(pTHX_ SV *sv)
7266 Returns a boolean indicating whether the SV is blessed into the specified
7267 class. This does not check for subtypes; use C<sv_derived_from> to verify
7268 an inheritance relationship.
7274 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7285 hvname = HvNAME_get(SvSTASH(sv));
7289 return strEQ(hvname, name);
7295 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7296 it will be upgraded to one. If C<classname> is non-null then the new SV will
7297 be blessed in the specified package. The new SV is returned and its
7298 reference count is 1.
7304 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7310 SV_CHECK_THINKFIRST_COW_DROP(rv);
7313 if (SvTYPE(rv) >= SVt_PVMG) {
7314 const U32 refcnt = SvREFCNT(rv);
7318 SvREFCNT(rv) = refcnt;
7321 if (SvTYPE(rv) < SVt_RV)
7322 sv_upgrade(rv, SVt_RV);
7323 else if (SvTYPE(rv) > SVt_RV) {
7334 HV* const stash = gv_stashpv(classname, TRUE);
7335 (void)sv_bless(rv, stash);
7341 =for apidoc sv_setref_pv
7343 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7344 argument will be upgraded to an RV. That RV will be modified to point to
7345 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7346 into the SV. The C<classname> argument indicates the package for the
7347 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7348 will have a reference count of 1, and the RV will be returned.
7350 Do not use with other Perl types such as HV, AV, SV, CV, because those
7351 objects will become corrupted by the pointer copy process.
7353 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7359 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7362 sv_setsv(rv, &PL_sv_undef);
7366 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7371 =for apidoc sv_setref_iv
7373 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7374 argument will be upgraded to an RV. That RV will be modified to point to
7375 the new SV. The C<classname> argument indicates the package for the
7376 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7377 will have a reference count of 1, and the RV will be returned.
7383 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7385 sv_setiv(newSVrv(rv,classname), iv);
7390 =for apidoc sv_setref_uv
7392 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7393 argument will be upgraded to an RV. That RV will be modified to point to
7394 the new SV. The C<classname> argument indicates the package for the
7395 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7396 will have a reference count of 1, and the RV will be returned.
7402 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7404 sv_setuv(newSVrv(rv,classname), uv);
7409 =for apidoc sv_setref_nv
7411 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7412 argument will be upgraded to an RV. That RV will be modified to point to
7413 the new SV. The C<classname> argument indicates the package for the
7414 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7415 will have a reference count of 1, and the RV will be returned.
7421 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7423 sv_setnv(newSVrv(rv,classname), nv);
7428 =for apidoc sv_setref_pvn
7430 Copies a string into a new SV, optionally blessing the SV. The length of the
7431 string must be specified with C<n>. The C<rv> argument will be upgraded to
7432 an RV. That RV will be modified to point to the new SV. The C<classname>
7433 argument indicates the package for the blessing. Set C<classname> to
7434 C<Nullch> to avoid the blessing. The new SV will have a reference count
7435 of 1, and the RV will be returned.
7437 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7443 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7445 sv_setpvn(newSVrv(rv,classname), pv, n);
7450 =for apidoc sv_bless
7452 Blesses an SV into a specified package. The SV must be an RV. The package
7453 must be designated by its stash (see C<gv_stashpv()>). The reference count
7454 of the SV is unaffected.
7460 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7464 Perl_croak(aTHX_ "Can't bless non-reference value");
7466 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7467 if (SvREADONLY(tmpRef))
7468 Perl_croak(aTHX_ PL_no_modify);
7469 if (SvOBJECT(tmpRef)) {
7470 if (SvTYPE(tmpRef) != SVt_PVIO)
7472 SvREFCNT_dec(SvSTASH(tmpRef));
7475 SvOBJECT_on(tmpRef);
7476 if (SvTYPE(tmpRef) != SVt_PVIO)
7478 SvUPGRADE(tmpRef, SVt_PVMG);
7479 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7486 if(SvSMAGICAL(tmpRef))
7487 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7495 /* Downgrades a PVGV to a PVMG.
7499 S_sv_unglob(pTHX_ SV *sv)
7503 assert(SvTYPE(sv) == SVt_PVGV);
7508 sv_del_backref((SV*)GvSTASH(sv), sv);
7509 GvSTASH(sv) = Nullhv;
7511 sv_unmagic(sv, PERL_MAGIC_glob);
7512 Safefree(GvNAME(sv));
7515 /* need to keep SvANY(sv) in the right arena */
7516 xpvmg = new_XPVMG();
7517 StructCopy(SvANY(sv), xpvmg, XPVMG);
7518 del_XPVGV(SvANY(sv));
7521 SvFLAGS(sv) &= ~SVTYPEMASK;
7522 SvFLAGS(sv) |= SVt_PVMG;
7526 =for apidoc sv_unref_flags
7528 Unsets the RV status of the SV, and decrements the reference count of
7529 whatever was being referenced by the RV. This can almost be thought of
7530 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7531 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7532 (otherwise the decrementing is conditional on the reference count being
7533 different from one or the reference being a readonly SV).
7540 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7542 SV* const target = SvRV(ref);
7544 if (SvWEAKREF(ref)) {
7545 sv_del_backref(target, ref);
7547 SvRV_set(ref, NULL);
7550 SvRV_set(ref, NULL);
7552 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7553 assigned to as BEGIN {$a = \"Foo"} will fail. */
7554 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7555 SvREFCNT_dec(target);
7556 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7557 sv_2mortal(target); /* Schedule for freeing later */
7561 =for apidoc sv_untaint
7563 Untaint an SV. Use C<SvTAINTED_off> instead.
7568 Perl_sv_untaint(pTHX_ SV *sv)
7570 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7571 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7578 =for apidoc sv_tainted
7580 Test an SV for taintedness. Use C<SvTAINTED> instead.
7585 Perl_sv_tainted(pTHX_ SV *sv)
7587 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7588 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7589 if (mg && (mg->mg_len & 1) )
7596 =for apidoc sv_setpviv
7598 Copies an integer into the given SV, also updating its string value.
7599 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7605 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7607 char buf[TYPE_CHARS(UV)];
7609 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7611 sv_setpvn(sv, ptr, ebuf - ptr);
7615 =for apidoc sv_setpviv_mg
7617 Like C<sv_setpviv>, but also handles 'set' magic.
7623 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7629 #if defined(PERL_IMPLICIT_CONTEXT)
7631 /* pTHX_ magic can't cope with varargs, so this is a no-context
7632 * version of the main function, (which may itself be aliased to us).
7633 * Don't access this version directly.
7637 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7641 va_start(args, pat);
7642 sv_vsetpvf(sv, pat, &args);
7646 /* pTHX_ magic can't cope with varargs, so this is a no-context
7647 * version of the main function, (which may itself be aliased to us).
7648 * Don't access this version directly.
7652 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7656 va_start(args, pat);
7657 sv_vsetpvf_mg(sv, pat, &args);
7663 =for apidoc sv_setpvf
7665 Works like C<sv_catpvf> but copies the text into the SV instead of
7666 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7672 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7675 va_start(args, pat);
7676 sv_vsetpvf(sv, pat, &args);
7681 =for apidoc sv_vsetpvf
7683 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7684 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7686 Usually used via its frontend C<sv_setpvf>.
7692 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7694 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7698 =for apidoc sv_setpvf_mg
7700 Like C<sv_setpvf>, but also handles 'set' magic.
7706 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7709 va_start(args, pat);
7710 sv_vsetpvf_mg(sv, pat, &args);
7715 =for apidoc sv_vsetpvf_mg
7717 Like C<sv_vsetpvf>, but also handles 'set' magic.
7719 Usually used via its frontend C<sv_setpvf_mg>.
7725 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7727 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7731 #if defined(PERL_IMPLICIT_CONTEXT)
7733 /* pTHX_ magic can't cope with varargs, so this is a no-context
7734 * version of the main function, (which may itself be aliased to us).
7735 * Don't access this version directly.
7739 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7743 va_start(args, pat);
7744 sv_vcatpvf(sv, pat, &args);
7748 /* pTHX_ magic can't cope with varargs, so this is a no-context
7749 * version of the main function, (which may itself be aliased to us).
7750 * Don't access this version directly.
7754 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7758 va_start(args, pat);
7759 sv_vcatpvf_mg(sv, pat, &args);
7765 =for apidoc sv_catpvf
7767 Processes its arguments like C<sprintf> and appends the formatted
7768 output to an SV. If the appended data contains "wide" characters
7769 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7770 and characters >255 formatted with %c), the original SV might get
7771 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7772 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7773 valid UTF-8; if the original SV was bytes, the pattern should be too.
7778 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7781 va_start(args, pat);
7782 sv_vcatpvf(sv, pat, &args);
7787 =for apidoc sv_vcatpvf
7789 Processes its arguments like C<vsprintf> and appends the formatted output
7790 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7792 Usually used via its frontend C<sv_catpvf>.
7798 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7800 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7804 =for apidoc sv_catpvf_mg
7806 Like C<sv_catpvf>, but also handles 'set' magic.
7812 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7815 va_start(args, pat);
7816 sv_vcatpvf_mg(sv, pat, &args);
7821 =for apidoc sv_vcatpvf_mg
7823 Like C<sv_vcatpvf>, but also handles 'set' magic.
7825 Usually used via its frontend C<sv_catpvf_mg>.
7831 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7833 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7838 =for apidoc sv_vsetpvfn
7840 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7843 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7849 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7851 sv_setpvn(sv, "", 0);
7852 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7855 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7858 S_expect_number(pTHX_ char** pattern)
7861 switch (**pattern) {
7862 case '1': case '2': case '3':
7863 case '4': case '5': case '6':
7864 case '7': case '8': case '9':
7865 while (isDIGIT(**pattern))
7866 var = var * 10 + (*(*pattern)++ - '0');
7870 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7873 F0convert(NV nv, char *endbuf, STRLEN *len)
7875 const int neg = nv < 0;
7884 if (uv & 1 && uv == nv)
7885 uv--; /* Round to even */
7887 const unsigned dig = uv % 10;
7900 =for apidoc sv_vcatpvfn
7902 Processes its arguments like C<vsprintf> and appends the formatted output
7903 to an SV. Uses an array of SVs if the C style variable argument list is
7904 missing (NULL). When running with taint checks enabled, indicates via
7905 C<maybe_tainted> if results are untrustworthy (often due to the use of
7908 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7914 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7915 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7916 vec_utf8 = DO_UTF8(vecsv);
7918 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7921 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7928 static const char nullstr[] = "(null)";
7930 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7931 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7933 /* Times 4: a decimal digit takes more than 3 binary digits.
7934 * NV_DIG: mantissa takes than many decimal digits.
7935 * Plus 32: Playing safe. */
7936 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7937 /* large enough for "%#.#f" --chip */
7938 /* what about long double NVs? --jhi */
7940 PERL_UNUSED_ARG(maybe_tainted);
7942 /* no matter what, this is a string now */
7943 (void)SvPV_force(sv, origlen);
7945 /* special-case "", "%s", and "%-p" (SVf - see below) */
7948 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7950 const char * const s = va_arg(*args, char*);
7951 sv_catpv(sv, s ? s : nullstr);
7953 else if (svix < svmax) {
7954 sv_catsv(sv, *svargs);
7958 if (args && patlen == 3 && pat[0] == '%' &&
7959 pat[1] == '-' && pat[2] == 'p') {
7960 argsv = va_arg(*args, SV*);
7961 sv_catsv(sv, argsv);
7965 #ifndef USE_LONG_DOUBLE
7966 /* special-case "%.<number>[gf]" */
7967 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7968 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7969 unsigned digits = 0;
7973 while (*pp >= '0' && *pp <= '9')
7974 digits = 10 * digits + (*pp++ - '0');
7975 if (pp - pat == (int)patlen - 1) {
7983 /* Add check for digits != 0 because it seems that some
7984 gconverts are buggy in this case, and we don't yet have
7985 a Configure test for this. */
7986 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7987 /* 0, point, slack */
7988 Gconvert(nv, (int)digits, 0, ebuf);
7990 if (*ebuf) /* May return an empty string for digits==0 */
7993 } else if (!digits) {
7996 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7997 sv_catpvn(sv, p, l);
8003 #endif /* !USE_LONG_DOUBLE */
8005 if (!args && svix < svmax && DO_UTF8(*svargs))
8008 patend = (char*)pat + patlen;
8009 for (p = (char*)pat; p < patend; p = q) {
8012 bool vectorize = FALSE;
8013 bool vectorarg = FALSE;
8014 bool vec_utf8 = FALSE;
8020 bool has_precis = FALSE;
8023 bool is_utf8 = FALSE; /* is this item utf8? */
8024 #ifdef HAS_LDBL_SPRINTF_BUG
8025 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8026 with sfio - Allen <allens@cpan.org> */
8027 bool fix_ldbl_sprintf_bug = FALSE;
8031 U8 utf8buf[UTF8_MAXBYTES+1];
8032 STRLEN esignlen = 0;
8034 const char *eptr = Nullch;
8037 const U8 *vecstr = Null(U8*);
8044 /* we need a long double target in case HAS_LONG_DOUBLE but
8047 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8055 const char *dotstr = ".";
8056 STRLEN dotstrlen = 1;
8057 I32 efix = 0; /* explicit format parameter index */
8058 I32 ewix = 0; /* explicit width index */
8059 I32 epix = 0; /* explicit precision index */
8060 I32 evix = 0; /* explicit vector index */
8061 bool asterisk = FALSE;
8063 /* echo everything up to the next format specification */
8064 for (q = p; q < patend && *q != '%'; ++q) ;
8066 if (has_utf8 && !pat_utf8)
8067 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8069 sv_catpvn(sv, p, q - p);
8076 We allow format specification elements in this order:
8077 \d+\$ explicit format parameter index
8079 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8080 0 flag (as above): repeated to allow "v02"
8081 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8082 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8084 [%bcdefginopsuxDFOUX] format (mandatory)
8089 As of perl5.9.3, printf format checking is on by default.
8090 Internally, perl uses %p formats to provide an escape to
8091 some extended formatting. This block deals with those
8092 extensions: if it does not match, (char*)q is reset and
8093 the normal format processing code is used.
8095 Currently defined extensions are:
8096 %p include pointer address (standard)
8097 %-p (SVf) include an SV (previously %_)
8098 %-<num>p include an SV with precision <num>
8099 %1p (VDf) include a v-string (as %vd)
8100 %<num>p reserved for future extensions
8102 Robin Barker 2005-07-14
8109 EXPECT_NUMBER(q, n);
8116 argsv = va_arg(*args, SV*);
8117 eptr = SvPVx_const(argsv, elen);
8123 else if (n == vdNUMBER) { /* VDf */
8130 if (ckWARN_d(WARN_INTERNAL))
8131 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8132 "internal %%<num>p might conflict with future printf extensions");
8138 if (EXPECT_NUMBER(q, width)) {
8179 if (EXPECT_NUMBER(q, ewix))
8188 if ((vectorarg = asterisk)) {
8201 EXPECT_NUMBER(q, width);
8207 vecsv = va_arg(*args, SV*);
8209 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8210 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8211 dotstr = SvPV_const(vecsv, dotstrlen);
8218 else if (efix ? efix <= svmax : svix < svmax) {
8219 vecsv = svargs[efix ? efix-1 : svix++];
8220 vecstr = (U8*)SvPV_const(vecsv,veclen);
8221 vec_utf8 = DO_UTF8(vecsv);
8222 /* if this is a version object, we need to return the
8223 * stringified representation (which the SvPVX_const has
8224 * already done for us), but not vectorize the args
8226 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8228 q++; /* skip past the rest of the %vd format */
8229 eptr = (const char *) vecstr;
8243 i = va_arg(*args, int);
8245 i = (ewix ? ewix <= svmax : svix < svmax) ?
8246 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8248 width = (i < 0) ? -i : i;
8258 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8260 /* XXX: todo, support specified precision parameter */
8264 i = va_arg(*args, int);
8266 i = (ewix ? ewix <= svmax : svix < svmax)
8267 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8268 precis = (i < 0) ? 0 : i;
8273 precis = precis * 10 + (*q++ - '0');
8282 case 'I': /* Ix, I32x, and I64x */
8284 if (q[1] == '6' && q[2] == '4') {
8290 if (q[1] == '3' && q[2] == '2') {
8300 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8311 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8312 if (*(q + 1) == 'l') { /* lld, llf */
8338 const I32 i = efix-1;
8339 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8341 argsv = (svix >= 0 && svix < svmax)
8342 ? svargs[svix++] : &PL_sv_undef;
8351 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8353 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8355 eptr = (char*)utf8buf;
8356 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8367 if (args && !vectorize) {
8368 eptr = va_arg(*args, char*);
8370 #ifdef MACOS_TRADITIONAL
8371 /* On MacOS, %#s format is used for Pascal strings */
8376 elen = strlen(eptr);
8378 eptr = (char *)nullstr;
8379 elen = sizeof nullstr - 1;
8383 eptr = SvPVx_const(argsv, elen);
8384 if (DO_UTF8(argsv)) {
8385 if (has_precis && precis < elen) {
8387 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8390 if (width) { /* fudge width (can't fudge elen) */
8391 width += elen - sv_len_utf8(argsv);
8399 if (has_precis && elen > precis)
8406 if (alt || vectorize)
8408 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8429 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8438 esignbuf[esignlen++] = plus;
8442 case 'h': iv = (short)va_arg(*args, int); break;
8443 case 'l': iv = va_arg(*args, long); break;
8444 case 'V': iv = va_arg(*args, IV); break;
8445 default: iv = va_arg(*args, int); break;
8447 case 'q': iv = va_arg(*args, Quad_t); break;
8452 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8454 case 'h': iv = (short)tiv; break;
8455 case 'l': iv = (long)tiv; break;
8457 default: iv = tiv; break;
8459 case 'q': iv = (Quad_t)tiv; break;
8463 if ( !vectorize ) /* we already set uv above */
8468 esignbuf[esignlen++] = plus;
8472 esignbuf[esignlen++] = '-';
8515 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8526 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8527 case 'l': uv = va_arg(*args, unsigned long); break;
8528 case 'V': uv = va_arg(*args, UV); break;
8529 default: uv = va_arg(*args, unsigned); break;
8531 case 'q': uv = va_arg(*args, Uquad_t); break;
8536 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8538 case 'h': uv = (unsigned short)tuv; break;
8539 case 'l': uv = (unsigned long)tuv; break;
8541 default: uv = tuv; break;
8543 case 'q': uv = (Uquad_t)tuv; break;
8550 char *ptr = ebuf + sizeof ebuf;
8556 p = (char*)((c == 'X')
8557 ? "0123456789ABCDEF" : "0123456789abcdef");
8563 esignbuf[esignlen++] = '0';
8564 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8572 if (alt && *ptr != '0')
8583 esignbuf[esignlen++] = '0';
8584 esignbuf[esignlen++] = 'b';
8587 default: /* it had better be ten or less */
8591 } while (uv /= base);
8594 elen = (ebuf + sizeof ebuf) - ptr;
8598 zeros = precis - elen;
8599 else if (precis == 0 && elen == 1 && *eptr == '0')
8605 /* FLOATING POINT */
8608 c = 'f'; /* maybe %F isn't supported here */
8614 /* This is evil, but floating point is even more evil */
8616 /* for SV-style calling, we can only get NV
8617 for C-style calling, we assume %f is double;
8618 for simplicity we allow any of %Lf, %llf, %qf for long double
8622 #if defined(USE_LONG_DOUBLE)
8626 /* [perl #20339] - we should accept and ignore %lf rather than die */
8630 #if defined(USE_LONG_DOUBLE)
8631 intsize = args ? 0 : 'q';
8635 #if defined(HAS_LONG_DOUBLE)
8644 /* now we need (long double) if intsize == 'q', else (double) */
8645 nv = (args && !vectorize) ?
8646 #if LONG_DOUBLESIZE > DOUBLESIZE
8648 va_arg(*args, long double) :
8649 va_arg(*args, double)
8651 va_arg(*args, double)
8657 if (c != 'e' && c != 'E') {
8659 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8660 will cast our (long double) to (double) */
8661 (void)Perl_frexp(nv, &i);
8662 if (i == PERL_INT_MIN)
8663 Perl_die(aTHX_ "panic: frexp");
8665 need = BIT_DIGITS(i);
8667 need += has_precis ? precis : 6; /* known default */
8672 #ifdef HAS_LDBL_SPRINTF_BUG
8673 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8674 with sfio - Allen <allens@cpan.org> */
8677 # define MY_DBL_MAX DBL_MAX
8678 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8679 # if DOUBLESIZE >= 8
8680 # define MY_DBL_MAX 1.7976931348623157E+308L
8682 # define MY_DBL_MAX 3.40282347E+38L
8686 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8687 # define MY_DBL_MAX_BUG 1L
8689 # define MY_DBL_MAX_BUG MY_DBL_MAX
8693 # define MY_DBL_MIN DBL_MIN
8694 # else /* XXX guessing! -Allen */
8695 # if DOUBLESIZE >= 8
8696 # define MY_DBL_MIN 2.2250738585072014E-308L
8698 # define MY_DBL_MIN 1.17549435E-38L
8702 if ((intsize == 'q') && (c == 'f') &&
8703 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8705 /* it's going to be short enough that
8706 * long double precision is not needed */
8708 if ((nv <= 0L) && (nv >= -0L))
8709 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8711 /* would use Perl_fp_class as a double-check but not
8712 * functional on IRIX - see perl.h comments */
8714 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8715 /* It's within the range that a double can represent */
8716 #if defined(DBL_MAX) && !defined(DBL_MIN)
8717 if ((nv >= ((long double)1/DBL_MAX)) ||
8718 (nv <= (-(long double)1/DBL_MAX)))
8720 fix_ldbl_sprintf_bug = TRUE;
8723 if (fix_ldbl_sprintf_bug == TRUE) {
8733 # undef MY_DBL_MAX_BUG
8736 #endif /* HAS_LDBL_SPRINTF_BUG */
8738 need += 20; /* fudge factor */
8739 if (PL_efloatsize < need) {
8740 Safefree(PL_efloatbuf);
8741 PL_efloatsize = need + 20; /* more fudge */
8742 Newx(PL_efloatbuf, PL_efloatsize, char);
8743 PL_efloatbuf[0] = '\0';
8746 if ( !(width || left || plus || alt) && fill != '0'
8747 && has_precis && intsize != 'q' ) { /* Shortcuts */
8748 /* See earlier comment about buggy Gconvert when digits,
8750 if ( c == 'g' && precis) {
8751 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8752 /* May return an empty string for digits==0 */
8753 if (*PL_efloatbuf) {
8754 elen = strlen(PL_efloatbuf);
8755 goto float_converted;
8757 } else if ( c == 'f' && !precis) {
8758 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8763 char *ptr = ebuf + sizeof ebuf;
8766 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8767 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8768 if (intsize == 'q') {
8769 /* Copy the one or more characters in a long double
8770 * format before the 'base' ([efgEFG]) character to
8771 * the format string. */
8772 static char const prifldbl[] = PERL_PRIfldbl;
8773 char const *p = prifldbl + sizeof(prifldbl) - 3;
8774 while (p >= prifldbl) { *--ptr = *p--; }
8779 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8784 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8796 /* No taint. Otherwise we are in the strange situation
8797 * where printf() taints but print($float) doesn't.
8799 #if defined(HAS_LONG_DOUBLE)
8800 elen = ((intsize == 'q')
8801 ? my_sprintf(PL_efloatbuf, ptr, nv)
8802 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8804 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8808 eptr = PL_efloatbuf;
8814 i = SvCUR(sv) - origlen;
8815 if (args && !vectorize) {
8817 case 'h': *(va_arg(*args, short*)) = i; break;
8818 default: *(va_arg(*args, int*)) = i; break;
8819 case 'l': *(va_arg(*args, long*)) = i; break;
8820 case 'V': *(va_arg(*args, IV*)) = i; break;
8822 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8827 sv_setuv_mg(argsv, (UV)i);
8829 continue; /* not "break" */
8836 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8837 && ckWARN(WARN_PRINTF))
8839 SV * const msg = sv_newmortal();
8840 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8841 (PL_op->op_type == OP_PRTF) ? "" : "s");
8844 Perl_sv_catpvf(aTHX_ msg,
8845 "\"%%%c\"", c & 0xFF);
8847 Perl_sv_catpvf(aTHX_ msg,
8848 "\"%%\\%03"UVof"\"",
8851 sv_catpv(msg, "end of string");
8852 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8855 /* output mangled stuff ... */
8861 /* ... right here, because formatting flags should not apply */
8862 SvGROW(sv, SvCUR(sv) + elen + 1);
8864 Copy(eptr, p, elen, char);
8867 SvCUR_set(sv, p - SvPVX_const(sv));
8869 continue; /* not "break" */
8872 /* calculate width before utf8_upgrade changes it */
8873 have = esignlen + zeros + elen;
8875 Perl_croak_nocontext(PL_memory_wrap);
8877 if (is_utf8 != has_utf8) {
8880 sv_utf8_upgrade(sv);
8883 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8884 sv_utf8_upgrade(nsv);
8885 eptr = SvPVX_const(nsv);
8888 SvGROW(sv, SvCUR(sv) + elen + 1);
8893 need = (have > width ? have : width);
8896 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8897 Perl_croak_nocontext(PL_memory_wrap);
8898 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8900 if (esignlen && fill == '0') {
8902 for (i = 0; i < (int)esignlen; i++)
8906 memset(p, fill, gap);
8909 if (esignlen && fill != '0') {
8911 for (i = 0; i < (int)esignlen; i++)
8916 for (i = zeros; i; i--)
8920 Copy(eptr, p, elen, char);
8924 memset(p, ' ', gap);
8929 Copy(dotstr, p, dotstrlen, char);
8933 vectorize = FALSE; /* done iterating over vecstr */
8940 SvCUR_set(sv, p - SvPVX_const(sv));
8948 /* =========================================================================
8950 =head1 Cloning an interpreter
8952 All the macros and functions in this section are for the private use of
8953 the main function, perl_clone().
8955 The foo_dup() functions make an exact copy of an existing foo thinngy.
8956 During the course of a cloning, a hash table is used to map old addresses
8957 to new addresses. The table is created and manipulated with the
8958 ptr_table_* functions.
8962 ============================================================================*/
8965 #if defined(USE_ITHREADS)
8967 #ifndef GpREFCNT_inc
8968 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8972 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8973 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8974 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8975 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8976 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8977 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8978 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8979 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8980 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8981 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8982 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8983 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8984 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8987 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8988 regcomp.c. AMS 20010712 */
8991 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8996 struct reg_substr_datum *s;
8999 return (REGEXP *)NULL;
9001 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9004 len = r->offsets[0];
9005 npar = r->nparens+1;
9007 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9008 Copy(r->program, ret->program, len+1, regnode);
9010 Newx(ret->startp, npar, I32);
9011 Copy(r->startp, ret->startp, npar, I32);
9012 Newx(ret->endp, npar, I32);
9013 Copy(r->startp, ret->startp, npar, I32);
9015 Newx(ret->substrs, 1, struct reg_substr_data);
9016 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9017 s->min_offset = r->substrs->data[i].min_offset;
9018 s->max_offset = r->substrs->data[i].max_offset;
9019 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9020 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9023 ret->regstclass = NULL;
9026 const int count = r->data->count;
9029 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9030 char, struct reg_data);
9031 Newx(d->what, count, U8);
9034 for (i = 0; i < count; i++) {
9035 d->what[i] = r->data->what[i];
9036 switch (d->what[i]) {
9037 /* legal options are one of: sfpont
9038 see also regcomp.h and pregfree() */
9040 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9043 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9046 /* This is cheating. */
9047 Newx(d->data[i], 1, struct regnode_charclass_class);
9048 StructCopy(r->data->data[i], d->data[i],
9049 struct regnode_charclass_class);
9050 ret->regstclass = (regnode*)d->data[i];
9053 /* Compiled op trees are readonly, and can thus be
9054 shared without duplication. */
9056 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9060 d->data[i] = r->data->data[i];
9063 d->data[i] = r->data->data[i];
9065 ((reg_trie_data*)d->data[i])->refcount++;
9069 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9078 Newx(ret->offsets, 2*len+1, U32);
9079 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9081 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9082 ret->refcnt = r->refcnt;
9083 ret->minlen = r->minlen;
9084 ret->prelen = r->prelen;
9085 ret->nparens = r->nparens;
9086 ret->lastparen = r->lastparen;
9087 ret->lastcloseparen = r->lastcloseparen;
9088 ret->reganch = r->reganch;
9090 ret->sublen = r->sublen;
9092 if (RX_MATCH_COPIED(ret))
9093 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9095 ret->subbeg = Nullch;
9096 #ifdef PERL_OLD_COPY_ON_WRITE
9097 ret->saved_copy = Nullsv;
9100 ptr_table_store(PL_ptr_table, r, ret);
9104 /* duplicate a file handle */
9107 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9111 PERL_UNUSED_ARG(type);
9114 return (PerlIO*)NULL;
9116 /* look for it in the table first */
9117 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9121 /* create anew and remember what it is */
9122 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9123 ptr_table_store(PL_ptr_table, fp, ret);
9127 /* duplicate a directory handle */
9130 Perl_dirp_dup(pTHX_ DIR *dp)
9138 /* duplicate a typeglob */
9141 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9146 /* look for it in the table first */
9147 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9151 /* create anew and remember what it is */
9153 ptr_table_store(PL_ptr_table, gp, ret);
9156 ret->gp_refcnt = 0; /* must be before any other dups! */
9157 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9158 ret->gp_io = io_dup_inc(gp->gp_io, param);
9159 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9160 ret->gp_av = av_dup_inc(gp->gp_av, param);
9161 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9162 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9163 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9164 ret->gp_cvgen = gp->gp_cvgen;
9165 ret->gp_line = gp->gp_line;
9166 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9170 /* duplicate a chain of magic */
9173 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9175 MAGIC *mgprev = (MAGIC*)NULL;
9178 return (MAGIC*)NULL;
9179 /* look for it in the table first */
9180 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9184 for (; mg; mg = mg->mg_moremagic) {
9186 Newxz(nmg, 1, MAGIC);
9188 mgprev->mg_moremagic = nmg;
9191 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9192 nmg->mg_private = mg->mg_private;
9193 nmg->mg_type = mg->mg_type;
9194 nmg->mg_flags = mg->mg_flags;
9195 if (mg->mg_type == PERL_MAGIC_qr) {
9196 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9198 else if(mg->mg_type == PERL_MAGIC_backref) {
9199 const AV * const av = (AV*) mg->mg_obj;
9202 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9204 for (i = AvFILLp(av); i >= 0; i--) {
9205 if (!svp[i]) continue;
9206 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9209 else if (mg->mg_type == PERL_MAGIC_symtab) {
9210 nmg->mg_obj = mg->mg_obj;
9213 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9214 ? sv_dup_inc(mg->mg_obj, param)
9215 : sv_dup(mg->mg_obj, param);
9217 nmg->mg_len = mg->mg_len;
9218 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9219 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9220 if (mg->mg_len > 0) {
9221 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9222 if (mg->mg_type == PERL_MAGIC_overload_table &&
9223 AMT_AMAGIC((AMT*)mg->mg_ptr))
9225 AMT * const amtp = (AMT*)mg->mg_ptr;
9226 AMT * const namtp = (AMT*)nmg->mg_ptr;
9228 for (i = 1; i < NofAMmeth; i++) {
9229 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9233 else if (mg->mg_len == HEf_SVKEY)
9234 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9236 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9237 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9244 /* create a new pointer-mapping table */
9247 Perl_ptr_table_new(pTHX)
9250 Newxz(tbl, 1, PTR_TBL_t);
9253 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9258 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9260 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9264 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9265 following define) and at call to new_body_inline made below in
9266 Perl_ptr_table_store()
9269 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9271 /* map an existing pointer using a table */
9274 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9276 PTR_TBL_ENT_t *tblent;
9277 const UV hash = PTR_TABLE_HASH(sv);
9279 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9280 for (; tblent; tblent = tblent->next) {
9281 if (tblent->oldval == sv)
9282 return tblent->newval;
9287 /* add a new entry to a pointer-mapping table */
9290 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9292 PTR_TBL_ENT_t *tblent, **otblent;
9293 /* XXX this may be pessimal on platforms where pointers aren't good
9294 * hash values e.g. if they grow faster in the most significant
9296 const UV hash = PTR_TABLE_HASH(oldsv);
9300 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9301 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9302 if (tblent->oldval == oldsv) {
9303 tblent->newval = newsv;
9307 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9308 tblent->oldval = oldsv;
9309 tblent->newval = newsv;
9310 tblent->next = *otblent;
9313 if (!empty && tbl->tbl_items > tbl->tbl_max)
9314 ptr_table_split(tbl);
9317 /* double the hash bucket size of an existing ptr table */
9320 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9322 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9323 const UV oldsize = tbl->tbl_max + 1;
9324 UV newsize = oldsize * 2;
9327 Renew(ary, newsize, PTR_TBL_ENT_t*);
9328 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9329 tbl->tbl_max = --newsize;
9331 for (i=0; i < oldsize; i++, ary++) {
9332 PTR_TBL_ENT_t **curentp, **entp, *ent;
9335 curentp = ary + oldsize;
9336 for (entp = ary, ent = *ary; ent; ent = *entp) {
9337 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9339 ent->next = *curentp;
9349 /* remove all the entries from a ptr table */
9352 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9354 register PTR_TBL_ENT_t **array;
9355 register PTR_TBL_ENT_t *entry;
9359 if (!tbl || !tbl->tbl_items) {
9363 array = tbl->tbl_ary;
9369 PTR_TBL_ENT_t *oentry = entry;
9370 entry = entry->next;
9374 if (++riter > max) {
9377 entry = array[riter];
9384 /* clear and free a ptr table */
9387 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9392 ptr_table_clear(tbl);
9393 Safefree(tbl->tbl_ary);
9399 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9402 SvRV_set(dstr, SvWEAKREF(sstr)
9403 ? sv_dup(SvRV(sstr), param)
9404 : sv_dup_inc(SvRV(sstr), param));
9407 else if (SvPVX_const(sstr)) {
9408 /* Has something there */
9410 /* Normal PV - clone whole allocated space */
9411 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9412 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9413 /* Not that normal - actually sstr is copy on write.
9414 But we are a true, independant SV, so: */
9415 SvREADONLY_off(dstr);
9420 /* Special case - not normally malloced for some reason */
9421 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9422 /* A "shared" PV - clone it as "shared" PV */
9424 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9428 /* Some other special case - random pointer */
9429 SvPV_set(dstr, SvPVX(sstr));
9435 if (SvTYPE(dstr) == SVt_RV)
9436 SvRV_set(dstr, NULL);
9442 /* duplicate an SV of any type (including AV, HV etc) */
9445 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9450 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9452 /* look for it in the table first */
9453 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9457 if(param->flags & CLONEf_JOIN_IN) {
9458 /** We are joining here so we don't want do clone
9459 something that is bad **/
9462 if(SvTYPE(sstr) == SVt_PVHV &&
9463 (hvname = HvNAME_get(sstr))) {
9464 /** don't clone stashes if they already exist **/
9465 return (SV*)gv_stashpv(hvname,0);
9469 /* create anew and remember what it is */
9472 #ifdef DEBUG_LEAKING_SCALARS
9473 dstr->sv_debug_optype = sstr->sv_debug_optype;
9474 dstr->sv_debug_line = sstr->sv_debug_line;
9475 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9476 dstr->sv_debug_cloned = 1;
9478 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9480 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9484 ptr_table_store(PL_ptr_table, sstr, dstr);
9487 SvFLAGS(dstr) = SvFLAGS(sstr);
9488 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9489 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9492 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9493 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9494 PL_watch_pvx, SvPVX_const(sstr));
9497 /* don't clone objects whose class has asked us not to */
9498 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9499 SvFLAGS(dstr) &= ~SVTYPEMASK;
9504 switch (SvTYPE(sstr)) {
9509 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9510 SvIV_set(dstr, SvIVX(sstr));
9513 SvANY(dstr) = new_XNV();
9514 SvNV_set(dstr, SvNVX(sstr));
9517 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9518 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9522 /* These are all the types that need complex bodies allocating. */
9524 const svtype sv_type = SvTYPE(sstr);
9525 const struct body_details *const sv_type_details
9526 = bodies_by_type + sv_type;
9530 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9535 if (GvUNIQUE((GV*)sstr)) {
9536 /* Do sharing here, and fall through */
9549 assert(sv_type_details->copy);
9550 if (sv_type_details->arena) {
9551 new_body_inline(new_body, sv_type_details->copy, sv_type);
9553 = (void*)((char*)new_body - sv_type_details->offset);
9555 new_body = new_NOARENA(sv_type_details);
9559 SvANY(dstr) = new_body;
9562 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9563 ((char*)SvANY(dstr)) + sv_type_details->offset,
9564 sv_type_details->copy, char);
9566 Copy(((char*)SvANY(sstr)),
9567 ((char*)SvANY(dstr)),
9568 sv_type_details->size + sv_type_details->offset, char);
9571 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9572 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9574 /* The Copy above means that all the source (unduplicated) pointers
9575 are now in the destination. We can check the flags and the
9576 pointers in either, but it's possible that there's less cache
9577 missing by always going for the destination.
9578 FIXME - instrument and check that assumption */
9579 if (sv_type >= SVt_PVMG) {
9581 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9583 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9586 /* The cast silences a GCC warning about unhandled types. */
9587 switch ((int)sv_type) {
9599 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9600 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9601 LvTARG(dstr) = dstr;
9602 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9603 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9605 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9608 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9609 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9610 /* Don't call sv_add_backref here as it's going to be created
9611 as part of the magic cloning of the symbol table. */
9612 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9613 (void)GpREFCNT_inc(GvGP(dstr));
9616 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9617 if (IoOFP(dstr) == IoIFP(sstr))
9618 IoOFP(dstr) = IoIFP(dstr);
9620 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9621 /* PL_rsfp_filters entries have fake IoDIRP() */
9622 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9623 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9624 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9625 /* I have no idea why fake dirp (rsfps)
9626 should be treated differently but otherwise
9627 we end up with leaks -- sky*/
9628 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9629 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9630 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9632 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9633 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9634 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9636 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9637 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9638 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9641 if (AvARRAY((AV*)sstr)) {
9642 SV **dst_ary, **src_ary;
9643 SSize_t items = AvFILLp((AV*)sstr) + 1;
9645 src_ary = AvARRAY((AV*)sstr);
9646 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9647 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9648 SvPV_set(dstr, (char*)dst_ary);
9649 AvALLOC((AV*)dstr) = dst_ary;
9650 if (AvREAL((AV*)sstr)) {
9652 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9656 *dst_ary++ = sv_dup(*src_ary++, param);
9658 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9659 while (items-- > 0) {
9660 *dst_ary++ = &PL_sv_undef;
9664 SvPV_set(dstr, Nullch);
9665 AvALLOC((AV*)dstr) = (SV**)NULL;
9672 if (HvARRAY((HV*)sstr)) {
9674 const bool sharekeys = !!HvSHAREKEYS(sstr);
9675 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9676 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9678 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9679 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9681 HvARRAY(dstr) = (HE**)darray;
9682 while (i <= sxhv->xhv_max) {
9683 const HE *source = HvARRAY(sstr)[i];
9684 HvARRAY(dstr)[i] = source
9685 ? he_dup(source, sharekeys, param) : 0;
9689 struct xpvhv_aux *saux = HvAUX(sstr);
9690 struct xpvhv_aux *daux = HvAUX(dstr);
9691 /* This flag isn't copied. */
9692 /* SvOOK_on(hv) attacks the IV flags. */
9693 SvFLAGS(dstr) |= SVf_OOK;
9695 hvname = saux->xhv_name;
9697 = hvname ? hek_dup(hvname, param) : hvname;
9699 daux->xhv_riter = saux->xhv_riter;
9700 daux->xhv_eiter = saux->xhv_eiter
9701 ? he_dup(saux->xhv_eiter,
9702 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9706 SvPV_set(dstr, Nullch);
9708 /* Record stashes for possible cloning in Perl_clone(). */
9710 av_push(param->stashes, dstr);
9715 /* NOTE: not refcounted */
9716 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9718 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9720 if (CvCONST(dstr)) {
9721 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9722 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9723 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9725 /* don't dup if copying back - CvGV isn't refcounted, so the
9726 * duped GV may never be freed. A bit of a hack! DAPM */
9727 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9728 Nullgv : gv_dup(CvGV(dstr), param) ;
9729 if (!(param->flags & CLONEf_COPY_STACKS)) {
9732 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9735 ? cv_dup( CvOUTSIDE(dstr), param)
9736 : cv_dup_inc(CvOUTSIDE(dstr), param);
9738 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9744 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9750 /* duplicate a context */
9753 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9758 return (PERL_CONTEXT*)NULL;
9760 /* look for it in the table first */
9761 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9765 /* create anew and remember what it is */
9766 Newxz(ncxs, max + 1, PERL_CONTEXT);
9767 ptr_table_store(PL_ptr_table, cxs, ncxs);
9770 PERL_CONTEXT *cx = &cxs[ix];
9771 PERL_CONTEXT *ncx = &ncxs[ix];
9772 ncx->cx_type = cx->cx_type;
9773 if (CxTYPE(cx) == CXt_SUBST) {
9774 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9777 ncx->blk_oldsp = cx->blk_oldsp;
9778 ncx->blk_oldcop = cx->blk_oldcop;
9779 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9780 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9781 ncx->blk_oldpm = cx->blk_oldpm;
9782 ncx->blk_gimme = cx->blk_gimme;
9783 switch (CxTYPE(cx)) {
9785 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9786 ? cv_dup_inc(cx->blk_sub.cv, param)
9787 : cv_dup(cx->blk_sub.cv,param));
9788 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9789 ? av_dup_inc(cx->blk_sub.argarray, param)
9791 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9792 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9793 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9794 ncx->blk_sub.lval = cx->blk_sub.lval;
9795 ncx->blk_sub.retop = cx->blk_sub.retop;
9798 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9799 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9800 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9801 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9802 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9803 ncx->blk_eval.retop = cx->blk_eval.retop;
9806 ncx->blk_loop.label = cx->blk_loop.label;
9807 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9808 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9809 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9810 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9811 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9812 ? cx->blk_loop.iterdata
9813 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9814 ncx->blk_loop.oldcomppad
9815 = (PAD*)ptr_table_fetch(PL_ptr_table,
9816 cx->blk_loop.oldcomppad);
9817 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9818 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9819 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9820 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9821 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9824 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9825 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9826 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9827 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9828 ncx->blk_sub.retop = cx->blk_sub.retop;
9840 /* duplicate a stack info structure */
9843 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9848 return (PERL_SI*)NULL;
9850 /* look for it in the table first */
9851 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9855 /* create anew and remember what it is */
9856 Newxz(nsi, 1, PERL_SI);
9857 ptr_table_store(PL_ptr_table, si, nsi);
9859 nsi->si_stack = av_dup_inc(si->si_stack, param);
9860 nsi->si_cxix = si->si_cxix;
9861 nsi->si_cxmax = si->si_cxmax;
9862 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9863 nsi->si_type = si->si_type;
9864 nsi->si_prev = si_dup(si->si_prev, param);
9865 nsi->si_next = si_dup(si->si_next, param);
9866 nsi->si_markoff = si->si_markoff;
9871 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9872 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9873 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9874 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9875 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9876 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9877 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9878 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9879 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9880 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9881 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9882 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9883 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9884 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9887 #define pv_dup_inc(p) SAVEPV(p)
9888 #define pv_dup(p) SAVEPV(p)
9889 #define svp_dup_inc(p,pp) any_dup(p,pp)
9891 /* map any object to the new equivent - either something in the
9892 * ptr table, or something in the interpreter structure
9896 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9903 /* look for it in the table first */
9904 ret = ptr_table_fetch(PL_ptr_table, v);
9908 /* see if it is part of the interpreter structure */
9909 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9910 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9918 /* duplicate the save stack */
9921 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9923 ANY * const ss = proto_perl->Tsavestack;
9924 const I32 max = proto_perl->Tsavestack_max;
9925 I32 ix = proto_perl->Tsavestack_ix;
9937 void (*dptr) (void*);
9938 void (*dxptr) (pTHX_ void*);
9940 Newxz(nss, max, ANY);
9943 I32 i = POPINT(ss,ix);
9946 case SAVEt_ITEM: /* normal string */
9947 sv = (SV*)POPPTR(ss,ix);
9948 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9949 sv = (SV*)POPPTR(ss,ix);
9950 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9952 case SAVEt_SV: /* scalar reference */
9953 sv = (SV*)POPPTR(ss,ix);
9954 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9955 gv = (GV*)POPPTR(ss,ix);
9956 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9958 case SAVEt_GENERIC_PVREF: /* generic char* */
9959 c = (char*)POPPTR(ss,ix);
9960 TOPPTR(nss,ix) = pv_dup(c);
9961 ptr = POPPTR(ss,ix);
9962 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9964 case SAVEt_SHARED_PVREF: /* char* in shared space */
9965 c = (char*)POPPTR(ss,ix);
9966 TOPPTR(nss,ix) = savesharedpv(c);
9967 ptr = POPPTR(ss,ix);
9968 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9970 case SAVEt_GENERIC_SVREF: /* generic sv */
9971 case SAVEt_SVREF: /* scalar reference */
9972 sv = (SV*)POPPTR(ss,ix);
9973 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9974 ptr = POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9977 case SAVEt_AV: /* array reference */
9978 av = (AV*)POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = av_dup_inc(av, param);
9980 gv = (GV*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = gv_dup(gv, param);
9983 case SAVEt_HV: /* hash reference */
9984 hv = (HV*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9986 gv = (GV*)POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = gv_dup(gv, param);
9989 case SAVEt_INT: /* int reference */
9990 ptr = POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9992 intval = (int)POPINT(ss,ix);
9993 TOPINT(nss,ix) = intval;
9995 case SAVEt_LONG: /* long reference */
9996 ptr = POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9998 longval = (long)POPLONG(ss,ix);
9999 TOPLONG(nss,ix) = longval;
10001 case SAVEt_I32: /* I32 reference */
10002 case SAVEt_I16: /* I16 reference */
10003 case SAVEt_I8: /* I8 reference */
10004 ptr = POPPTR(ss,ix);
10005 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10007 TOPINT(nss,ix) = i;
10009 case SAVEt_IV: /* IV reference */
10010 ptr = POPPTR(ss,ix);
10011 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10013 TOPIV(nss,ix) = iv;
10015 case SAVEt_SPTR: /* SV* reference */
10016 ptr = POPPTR(ss,ix);
10017 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10018 sv = (SV*)POPPTR(ss,ix);
10019 TOPPTR(nss,ix) = sv_dup(sv, param);
10021 case SAVEt_VPTR: /* random* reference */
10022 ptr = POPPTR(ss,ix);
10023 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10024 ptr = POPPTR(ss,ix);
10025 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10027 case SAVEt_PPTR: /* char* reference */
10028 ptr = POPPTR(ss,ix);
10029 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10030 c = (char*)POPPTR(ss,ix);
10031 TOPPTR(nss,ix) = pv_dup(c);
10033 case SAVEt_HPTR: /* HV* reference */
10034 ptr = POPPTR(ss,ix);
10035 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10036 hv = (HV*)POPPTR(ss,ix);
10037 TOPPTR(nss,ix) = hv_dup(hv, param);
10039 case SAVEt_APTR: /* AV* reference */
10040 ptr = POPPTR(ss,ix);
10041 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10042 av = (AV*)POPPTR(ss,ix);
10043 TOPPTR(nss,ix) = av_dup(av, param);
10046 gv = (GV*)POPPTR(ss,ix);
10047 TOPPTR(nss,ix) = gv_dup(gv, param);
10049 case SAVEt_GP: /* scalar reference */
10050 gp = (GP*)POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10052 (void)GpREFCNT_inc(gp);
10053 gv = (GV*)POPPTR(ss,ix);
10054 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10055 c = (char*)POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = pv_dup(c);
10058 TOPIV(nss,ix) = iv;
10060 TOPIV(nss,ix) = iv;
10063 case SAVEt_MORTALIZESV:
10064 sv = (SV*)POPPTR(ss,ix);
10065 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10068 ptr = POPPTR(ss,ix);
10069 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10070 /* these are assumed to be refcounted properly */
10072 switch (((OP*)ptr)->op_type) {
10074 case OP_LEAVESUBLV:
10078 case OP_LEAVEWRITE:
10079 TOPPTR(nss,ix) = ptr;
10084 TOPPTR(nss,ix) = Nullop;
10089 TOPPTR(nss,ix) = Nullop;
10092 c = (char*)POPPTR(ss,ix);
10093 TOPPTR(nss,ix) = pv_dup_inc(c);
10095 case SAVEt_CLEARSV:
10096 longval = POPLONG(ss,ix);
10097 TOPLONG(nss,ix) = longval;
10100 hv = (HV*)POPPTR(ss,ix);
10101 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10102 c = (char*)POPPTR(ss,ix);
10103 TOPPTR(nss,ix) = pv_dup_inc(c);
10105 TOPINT(nss,ix) = i;
10107 case SAVEt_DESTRUCTOR:
10108 ptr = POPPTR(ss,ix);
10109 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10110 dptr = POPDPTR(ss,ix);
10111 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10112 any_dup(FPTR2DPTR(void *, dptr),
10115 case SAVEt_DESTRUCTOR_X:
10116 ptr = POPPTR(ss,ix);
10117 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10118 dxptr = POPDXPTR(ss,ix);
10119 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10120 any_dup(FPTR2DPTR(void *, dxptr),
10123 case SAVEt_REGCONTEXT:
10126 TOPINT(nss,ix) = i;
10129 case SAVEt_STACK_POS: /* Position on Perl stack */
10131 TOPINT(nss,ix) = i;
10133 case SAVEt_AELEM: /* array element */
10134 sv = (SV*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10137 TOPINT(nss,ix) = i;
10138 av = (AV*)POPPTR(ss,ix);
10139 TOPPTR(nss,ix) = av_dup_inc(av, param);
10141 case SAVEt_HELEM: /* hash element */
10142 sv = (SV*)POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10144 sv = (SV*)POPPTR(ss,ix);
10145 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10146 hv = (HV*)POPPTR(ss,ix);
10147 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10150 ptr = POPPTR(ss,ix);
10151 TOPPTR(nss,ix) = ptr;
10155 TOPINT(nss,ix) = i;
10157 case SAVEt_COMPPAD:
10158 av = (AV*)POPPTR(ss,ix);
10159 TOPPTR(nss,ix) = av_dup(av, param);
10162 longval = (long)POPLONG(ss,ix);
10163 TOPLONG(nss,ix) = longval;
10164 ptr = POPPTR(ss,ix);
10165 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10166 sv = (SV*)POPPTR(ss,ix);
10167 TOPPTR(nss,ix) = sv_dup(sv, param);
10170 ptr = POPPTR(ss,ix);
10171 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10172 longval = (long)POPBOOL(ss,ix);
10173 TOPBOOL(nss,ix) = (bool)longval;
10175 case SAVEt_SET_SVFLAGS:
10177 TOPINT(nss,ix) = i;
10179 TOPINT(nss,ix) = i;
10180 sv = (SV*)POPPTR(ss,ix);
10181 TOPPTR(nss,ix) = sv_dup(sv, param);
10184 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10192 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10193 * flag to the result. This is done for each stash before cloning starts,
10194 * so we know which stashes want their objects cloned */
10197 do_mark_cloneable_stash(pTHX_ SV *sv)
10199 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10201 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10202 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10203 if (cloner && GvCV(cloner)) {
10210 XPUSHs(sv_2mortal(newSVhek(hvname)));
10212 call_sv((SV*)GvCV(cloner), G_SCALAR);
10219 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10227 =for apidoc perl_clone
10229 Create and return a new interpreter by cloning the current one.
10231 perl_clone takes these flags as parameters:
10233 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10234 without it we only clone the data and zero the stacks,
10235 with it we copy the stacks and the new perl interpreter is
10236 ready to run at the exact same point as the previous one.
10237 The pseudo-fork code uses COPY_STACKS while the
10238 threads->new doesn't.
10240 CLONEf_KEEP_PTR_TABLE
10241 perl_clone keeps a ptr_table with the pointer of the old
10242 variable as a key and the new variable as a value,
10243 this allows it to check if something has been cloned and not
10244 clone it again but rather just use the value and increase the
10245 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10246 the ptr_table using the function
10247 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10248 reason to keep it around is if you want to dup some of your own
10249 variable who are outside the graph perl scans, example of this
10250 code is in threads.xs create
10253 This is a win32 thing, it is ignored on unix, it tells perls
10254 win32host code (which is c++) to clone itself, this is needed on
10255 win32 if you want to run two threads at the same time,
10256 if you just want to do some stuff in a separate perl interpreter
10257 and then throw it away and return to the original one,
10258 you don't need to do anything.
10263 /* XXX the above needs expanding by someone who actually understands it ! */
10264 EXTERN_C PerlInterpreter *
10265 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10268 perl_clone(PerlInterpreter *proto_perl, UV flags)
10271 #ifdef PERL_IMPLICIT_SYS
10273 /* perlhost.h so we need to call into it
10274 to clone the host, CPerlHost should have a c interface, sky */
10276 if (flags & CLONEf_CLONE_HOST) {
10277 return perl_clone_host(proto_perl,flags);
10279 return perl_clone_using(proto_perl, flags,
10281 proto_perl->IMemShared,
10282 proto_perl->IMemParse,
10284 proto_perl->IStdIO,
10288 proto_perl->IProc);
10292 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10293 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10294 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10295 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10296 struct IPerlDir* ipD, struct IPerlSock* ipS,
10297 struct IPerlProc* ipP)
10299 /* XXX many of the string copies here can be optimized if they're
10300 * constants; they need to be allocated as common memory and just
10301 * their pointers copied. */
10304 CLONE_PARAMS clone_params;
10305 CLONE_PARAMS* param = &clone_params;
10307 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10308 /* for each stash, determine whether its objects should be cloned */
10309 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10310 PERL_SET_THX(my_perl);
10313 Poison(my_perl, 1, PerlInterpreter);
10315 PL_curcop = (COP *)Nullop;
10319 PL_savestack_ix = 0;
10320 PL_savestack_max = -1;
10321 PL_sig_pending = 0;
10322 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10323 # else /* !DEBUGGING */
10324 Zero(my_perl, 1, PerlInterpreter);
10325 # endif /* DEBUGGING */
10327 /* host pointers */
10329 PL_MemShared = ipMS;
10330 PL_MemParse = ipMP;
10337 #else /* !PERL_IMPLICIT_SYS */
10339 CLONE_PARAMS clone_params;
10340 CLONE_PARAMS* param = &clone_params;
10341 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10342 /* for each stash, determine whether its objects should be cloned */
10343 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10344 PERL_SET_THX(my_perl);
10347 Poison(my_perl, 1, PerlInterpreter);
10349 PL_curcop = (COP *)Nullop;
10353 PL_savestack_ix = 0;
10354 PL_savestack_max = -1;
10355 PL_sig_pending = 0;
10356 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10357 # else /* !DEBUGGING */
10358 Zero(my_perl, 1, PerlInterpreter);
10359 # endif /* DEBUGGING */
10360 #endif /* PERL_IMPLICIT_SYS */
10361 param->flags = flags;
10362 param->proto_perl = proto_perl;
10364 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10365 Zero(&PL_body_roots, 1, PL_body_roots);
10367 PL_nice_chunk = NULL;
10368 PL_nice_chunk_size = 0;
10370 PL_sv_objcount = 0;
10371 PL_sv_root = Nullsv;
10372 PL_sv_arenaroot = Nullsv;
10374 PL_debug = proto_perl->Idebug;
10376 PL_hash_seed = proto_perl->Ihash_seed;
10377 PL_rehash_seed = proto_perl->Irehash_seed;
10379 #ifdef USE_REENTRANT_API
10380 /* XXX: things like -Dm will segfault here in perlio, but doing
10381 * PERL_SET_CONTEXT(proto_perl);
10382 * breaks too many other things
10384 Perl_reentrant_init(aTHX);
10387 /* create SV map for pointer relocation */
10388 PL_ptr_table = ptr_table_new();
10390 /* initialize these special pointers as early as possible */
10391 SvANY(&PL_sv_undef) = NULL;
10392 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10393 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10394 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10396 SvANY(&PL_sv_no) = new_XPVNV();
10397 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10398 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10399 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10400 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10401 SvCUR_set(&PL_sv_no, 0);
10402 SvLEN_set(&PL_sv_no, 1);
10403 SvIV_set(&PL_sv_no, 0);
10404 SvNV_set(&PL_sv_no, 0);
10405 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10407 SvANY(&PL_sv_yes) = new_XPVNV();
10408 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10409 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10410 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10411 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10412 SvCUR_set(&PL_sv_yes, 1);
10413 SvLEN_set(&PL_sv_yes, 2);
10414 SvIV_set(&PL_sv_yes, 1);
10415 SvNV_set(&PL_sv_yes, 1);
10416 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10418 /* create (a non-shared!) shared string table */
10419 PL_strtab = newHV();
10420 HvSHAREKEYS_off(PL_strtab);
10421 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10422 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10424 PL_compiling = proto_perl->Icompiling;
10426 /* These two PVs will be free'd special way so must set them same way op.c does */
10427 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10428 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10430 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10431 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10433 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10434 if (!specialWARN(PL_compiling.cop_warnings))
10435 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10436 if (!specialCopIO(PL_compiling.cop_io))
10437 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10438 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10440 /* pseudo environmental stuff */
10441 PL_origargc = proto_perl->Iorigargc;
10442 PL_origargv = proto_perl->Iorigargv;
10444 param->stashes = newAV(); /* Setup array of objects to call clone on */
10446 /* Set tainting stuff before PerlIO_debug can possibly get called */
10447 PL_tainting = proto_perl->Itainting;
10448 PL_taint_warn = proto_perl->Itaint_warn;
10450 #ifdef PERLIO_LAYERS
10451 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10452 PerlIO_clone(aTHX_ proto_perl, param);
10455 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10456 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10457 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10458 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10459 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10460 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10463 PL_minus_c = proto_perl->Iminus_c;
10464 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10465 PL_localpatches = proto_perl->Ilocalpatches;
10466 PL_splitstr = proto_perl->Isplitstr;
10467 PL_preprocess = proto_perl->Ipreprocess;
10468 PL_minus_n = proto_perl->Iminus_n;
10469 PL_minus_p = proto_perl->Iminus_p;
10470 PL_minus_l = proto_perl->Iminus_l;
10471 PL_minus_a = proto_perl->Iminus_a;
10472 PL_minus_F = proto_perl->Iminus_F;
10473 PL_doswitches = proto_perl->Idoswitches;
10474 PL_dowarn = proto_perl->Idowarn;
10475 PL_doextract = proto_perl->Idoextract;
10476 PL_sawampersand = proto_perl->Isawampersand;
10477 PL_unsafe = proto_perl->Iunsafe;
10478 PL_inplace = SAVEPV(proto_perl->Iinplace);
10479 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10480 PL_perldb = proto_perl->Iperldb;
10481 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10482 PL_exit_flags = proto_perl->Iexit_flags;
10484 /* magical thingies */
10485 /* XXX time(&PL_basetime) when asked for? */
10486 PL_basetime = proto_perl->Ibasetime;
10487 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10489 PL_maxsysfd = proto_perl->Imaxsysfd;
10490 PL_multiline = proto_perl->Imultiline;
10491 PL_statusvalue = proto_perl->Istatusvalue;
10493 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10495 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10497 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10499 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10500 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10501 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10503 /* Clone the regex array */
10504 PL_regex_padav = newAV();
10506 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10507 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10509 av_push(PL_regex_padav,
10510 sv_dup_inc(regexen[0],param));
10511 for(i = 1; i <= len; i++) {
10512 if(SvREPADTMP(regexen[i])) {
10513 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10515 av_push(PL_regex_padav,
10517 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10518 SvIVX(regexen[i])), param)))
10523 PL_regex_pad = AvARRAY(PL_regex_padav);
10525 /* shortcuts to various I/O objects */
10526 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10527 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10528 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10529 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10530 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10531 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10533 /* shortcuts to regexp stuff */
10534 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10536 /* shortcuts to misc objects */
10537 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10539 /* shortcuts to debugging objects */
10540 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10541 PL_DBline = gv_dup(proto_perl->IDBline, param);
10542 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10543 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10544 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10545 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10546 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10547 PL_lineary = av_dup(proto_perl->Ilineary, param);
10548 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10550 /* symbol tables */
10551 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10552 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10553 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10554 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10555 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10557 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10558 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10559 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10560 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10561 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10562 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10564 PL_sub_generation = proto_perl->Isub_generation;
10566 /* funky return mechanisms */
10567 PL_forkprocess = proto_perl->Iforkprocess;
10569 /* subprocess state */
10570 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10572 /* internal state */
10573 PL_maxo = proto_perl->Imaxo;
10574 if (proto_perl->Iop_mask)
10575 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10577 PL_op_mask = Nullch;
10578 /* PL_asserting = proto_perl->Iasserting; */
10580 /* current interpreter roots */
10581 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10582 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10583 PL_main_start = proto_perl->Imain_start;
10584 PL_eval_root = proto_perl->Ieval_root;
10585 PL_eval_start = proto_perl->Ieval_start;
10587 /* runtime control stuff */
10588 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10589 PL_copline = proto_perl->Icopline;
10591 PL_filemode = proto_perl->Ifilemode;
10592 PL_lastfd = proto_perl->Ilastfd;
10593 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10596 PL_gensym = proto_perl->Igensym;
10597 PL_preambled = proto_perl->Ipreambled;
10598 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10599 PL_laststatval = proto_perl->Ilaststatval;
10600 PL_laststype = proto_perl->Ilaststype;
10601 PL_mess_sv = Nullsv;
10603 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10605 /* interpreter atexit processing */
10606 PL_exitlistlen = proto_perl->Iexitlistlen;
10607 if (PL_exitlistlen) {
10608 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10609 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10612 PL_exitlist = (PerlExitListEntry*)NULL;
10613 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10614 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10615 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10617 PL_profiledata = NULL;
10618 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10619 /* PL_rsfp_filters entries have fake IoDIRP() */
10620 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10622 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10624 PAD_CLONE_VARS(proto_perl, param);
10626 #ifdef HAVE_INTERP_INTERN
10627 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10630 /* more statics moved here */
10631 PL_generation = proto_perl->Igeneration;
10632 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10634 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10635 PL_in_clean_all = proto_perl->Iin_clean_all;
10637 PL_uid = proto_perl->Iuid;
10638 PL_euid = proto_perl->Ieuid;
10639 PL_gid = proto_perl->Igid;
10640 PL_egid = proto_perl->Iegid;
10641 PL_nomemok = proto_perl->Inomemok;
10642 PL_an = proto_perl->Ian;
10643 PL_evalseq = proto_perl->Ievalseq;
10644 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10645 PL_origalen = proto_perl->Iorigalen;
10646 #ifdef PERL_USES_PL_PIDSTATUS
10647 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10649 PL_osname = SAVEPV(proto_perl->Iosname);
10650 PL_sighandlerp = proto_perl->Isighandlerp;
10652 PL_runops = proto_perl->Irunops;
10654 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10657 PL_cshlen = proto_perl->Icshlen;
10658 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10661 PL_lex_state = proto_perl->Ilex_state;
10662 PL_lex_defer = proto_perl->Ilex_defer;
10663 PL_lex_expect = proto_perl->Ilex_expect;
10664 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10665 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10666 PL_lex_starts = proto_perl->Ilex_starts;
10667 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10668 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10669 PL_lex_op = proto_perl->Ilex_op;
10670 PL_lex_inpat = proto_perl->Ilex_inpat;
10671 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10672 PL_lex_brackets = proto_perl->Ilex_brackets;
10673 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10674 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10675 PL_lex_casemods = proto_perl->Ilex_casemods;
10676 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10677 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10679 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10680 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10681 PL_nexttoke = proto_perl->Inexttoke;
10683 /* XXX This is probably masking the deeper issue of why
10684 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10685 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10686 * (A little debugging with a watchpoint on it may help.)
10688 if (SvANY(proto_perl->Ilinestr)) {
10689 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10690 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10691 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10692 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10693 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10694 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10695 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10696 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10697 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10700 PL_linestr = NEWSV(65,79);
10701 sv_upgrade(PL_linestr,SVt_PVIV);
10702 sv_setpvn(PL_linestr,"",0);
10703 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10705 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10706 PL_pending_ident = proto_perl->Ipending_ident;
10707 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10709 PL_expect = proto_perl->Iexpect;
10711 PL_multi_start = proto_perl->Imulti_start;
10712 PL_multi_end = proto_perl->Imulti_end;
10713 PL_multi_open = proto_perl->Imulti_open;
10714 PL_multi_close = proto_perl->Imulti_close;
10716 PL_error_count = proto_perl->Ierror_count;
10717 PL_subline = proto_perl->Isubline;
10718 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10720 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10721 if (SvANY(proto_perl->Ilinestr)) {
10722 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10723 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10724 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10725 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10726 PL_last_lop_op = proto_perl->Ilast_lop_op;
10729 PL_last_uni = SvPVX(PL_linestr);
10730 PL_last_lop = SvPVX(PL_linestr);
10731 PL_last_lop_op = 0;
10733 PL_in_my = proto_perl->Iin_my;
10734 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10736 PL_cryptseen = proto_perl->Icryptseen;
10739 PL_hints = proto_perl->Ihints;
10741 PL_amagic_generation = proto_perl->Iamagic_generation;
10743 #ifdef USE_LOCALE_COLLATE
10744 PL_collation_ix = proto_perl->Icollation_ix;
10745 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10746 PL_collation_standard = proto_perl->Icollation_standard;
10747 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10748 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10749 #endif /* USE_LOCALE_COLLATE */
10751 #ifdef USE_LOCALE_NUMERIC
10752 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10753 PL_numeric_standard = proto_perl->Inumeric_standard;
10754 PL_numeric_local = proto_perl->Inumeric_local;
10755 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10756 #endif /* !USE_LOCALE_NUMERIC */
10758 /* utf8 character classes */
10759 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10760 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10761 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10762 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10763 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10764 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10765 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10766 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10767 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10768 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10769 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10770 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10771 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10772 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10773 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10774 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10775 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10776 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10777 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10778 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10780 /* Did the locale setup indicate UTF-8? */
10781 PL_utf8locale = proto_perl->Iutf8locale;
10782 /* Unicode features (see perlrun/-C) */
10783 PL_unicode = proto_perl->Iunicode;
10785 /* Pre-5.8 signals control */
10786 PL_signals = proto_perl->Isignals;
10788 /* times() ticks per second */
10789 PL_clocktick = proto_perl->Iclocktick;
10791 /* Recursion stopper for PerlIO_find_layer */
10792 PL_in_load_module = proto_perl->Iin_load_module;
10794 /* sort() routine */
10795 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10797 /* Not really needed/useful since the reenrant_retint is "volatile",
10798 * but do it for consistency's sake. */
10799 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10801 /* Hooks to shared SVs and locks. */
10802 PL_sharehook = proto_perl->Isharehook;
10803 PL_lockhook = proto_perl->Ilockhook;
10804 PL_unlockhook = proto_perl->Iunlockhook;
10805 PL_threadhook = proto_perl->Ithreadhook;
10807 PL_runops_std = proto_perl->Irunops_std;
10808 PL_runops_dbg = proto_perl->Irunops_dbg;
10810 #ifdef THREADS_HAVE_PIDS
10811 PL_ppid = proto_perl->Ippid;
10815 PL_last_swash_hv = Nullhv; /* reinits on demand */
10816 PL_last_swash_klen = 0;
10817 PL_last_swash_key[0]= '\0';
10818 PL_last_swash_tmps = (U8*)NULL;
10819 PL_last_swash_slen = 0;
10821 PL_glob_index = proto_perl->Iglob_index;
10822 PL_srand_called = proto_perl->Isrand_called;
10823 PL_uudmap['M'] = 0; /* reinits on demand */
10824 PL_bitcount = Nullch; /* reinits on demand */
10826 if (proto_perl->Ipsig_pend) {
10827 Newxz(PL_psig_pend, SIG_SIZE, int);
10830 PL_psig_pend = (int*)NULL;
10833 if (proto_perl->Ipsig_ptr) {
10834 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10835 Newxz(PL_psig_name, SIG_SIZE, SV*);
10836 for (i = 1; i < SIG_SIZE; i++) {
10837 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10838 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10842 PL_psig_ptr = (SV**)NULL;
10843 PL_psig_name = (SV**)NULL;
10846 /* thrdvar.h stuff */
10848 if (flags & CLONEf_COPY_STACKS) {
10849 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10850 PL_tmps_ix = proto_perl->Ttmps_ix;
10851 PL_tmps_max = proto_perl->Ttmps_max;
10852 PL_tmps_floor = proto_perl->Ttmps_floor;
10853 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10855 while (i <= PL_tmps_ix) {
10856 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10860 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10861 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10862 Newxz(PL_markstack, i, I32);
10863 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10864 - proto_perl->Tmarkstack);
10865 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10866 - proto_perl->Tmarkstack);
10867 Copy(proto_perl->Tmarkstack, PL_markstack,
10868 PL_markstack_ptr - PL_markstack + 1, I32);
10870 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10871 * NOTE: unlike the others! */
10872 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10873 PL_scopestack_max = proto_perl->Tscopestack_max;
10874 Newxz(PL_scopestack, PL_scopestack_max, I32);
10875 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10877 /* NOTE: si_dup() looks at PL_markstack */
10878 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10880 /* PL_curstack = PL_curstackinfo->si_stack; */
10881 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10882 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10884 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10885 PL_stack_base = AvARRAY(PL_curstack);
10886 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10887 - proto_perl->Tstack_base);
10888 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10890 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10891 * NOTE: unlike the others! */
10892 PL_savestack_ix = proto_perl->Tsavestack_ix;
10893 PL_savestack_max = proto_perl->Tsavestack_max;
10894 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10895 PL_savestack = ss_dup(proto_perl, param);
10899 ENTER; /* perl_destruct() wants to LEAVE; */
10902 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10903 PL_top_env = &PL_start_env;
10905 PL_op = proto_perl->Top;
10908 PL_Xpv = (XPV*)NULL;
10909 PL_na = proto_perl->Tna;
10911 PL_statbuf = proto_perl->Tstatbuf;
10912 PL_statcache = proto_perl->Tstatcache;
10913 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10914 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10916 PL_timesbuf = proto_perl->Ttimesbuf;
10919 PL_tainted = proto_perl->Ttainted;
10920 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10921 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10922 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10923 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10924 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10925 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10926 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10927 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10928 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10930 PL_restartop = proto_perl->Trestartop;
10931 PL_in_eval = proto_perl->Tin_eval;
10932 PL_delaymagic = proto_perl->Tdelaymagic;
10933 PL_dirty = proto_perl->Tdirty;
10934 PL_localizing = proto_perl->Tlocalizing;
10936 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10937 PL_hv_fetch_ent_mh = Nullhe;
10938 PL_modcount = proto_perl->Tmodcount;
10939 PL_lastgotoprobe = Nullop;
10940 PL_dumpindent = proto_perl->Tdumpindent;
10942 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10943 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10944 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10945 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10946 PL_efloatbuf = Nullch; /* reinits on demand */
10947 PL_efloatsize = 0; /* reinits on demand */
10951 PL_screamfirst = NULL;
10952 PL_screamnext = NULL;
10953 PL_maxscream = -1; /* reinits on demand */
10954 PL_lastscream = Nullsv;
10956 PL_watchaddr = NULL;
10957 PL_watchok = Nullch;
10959 PL_regdummy = proto_perl->Tregdummy;
10960 PL_regprecomp = Nullch;
10963 PL_colorset = 0; /* reinits PL_colors[] */
10964 /*PL_colors[6] = {0,0,0,0,0,0};*/
10965 PL_reginput = Nullch;
10966 PL_regbol = Nullch;
10967 PL_regeol = Nullch;
10968 PL_regstartp = (I32*)NULL;
10969 PL_regendp = (I32*)NULL;
10970 PL_reglastparen = (U32*)NULL;
10971 PL_reglastcloseparen = (U32*)NULL;
10972 PL_regtill = Nullch;
10973 PL_reg_start_tmp = (char**)NULL;
10974 PL_reg_start_tmpl = 0;
10975 PL_regdata = (struct reg_data*)NULL;
10978 PL_reg_eval_set = 0;
10980 PL_regprogram = (regnode*)NULL;
10982 PL_regcc = (CURCUR*)NULL;
10983 PL_reg_call_cc = (struct re_cc_state*)NULL;
10984 PL_reg_re = (regexp*)NULL;
10985 PL_reg_ganch = Nullch;
10986 PL_reg_sv = Nullsv;
10987 PL_reg_match_utf8 = FALSE;
10988 PL_reg_magic = (MAGIC*)NULL;
10990 PL_reg_oldcurpm = (PMOP*)NULL;
10991 PL_reg_curpm = (PMOP*)NULL;
10992 PL_reg_oldsaved = Nullch;
10993 PL_reg_oldsavedlen = 0;
10994 #ifdef PERL_OLD_COPY_ON_WRITE
10997 PL_reg_maxiter = 0;
10998 PL_reg_leftiter = 0;
10999 PL_reg_poscache = Nullch;
11000 PL_reg_poscache_size= 0;
11002 /* RE engine - function pointers */
11003 PL_regcompp = proto_perl->Tregcompp;
11004 PL_regexecp = proto_perl->Tregexecp;
11005 PL_regint_start = proto_perl->Tregint_start;
11006 PL_regint_string = proto_perl->Tregint_string;
11007 PL_regfree = proto_perl->Tregfree;
11009 PL_reginterp_cnt = 0;
11010 PL_reg_starttry = 0;
11012 /* Pluggable optimizer */
11013 PL_peepp = proto_perl->Tpeepp;
11015 PL_stashcache = newHV();
11017 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11018 ptr_table_free(PL_ptr_table);
11019 PL_ptr_table = NULL;
11022 /* Call the ->CLONE method, if it exists, for each of the stashes
11023 identified by sv_dup() above.
11025 while(av_len(param->stashes) != -1) {
11026 HV* const stash = (HV*) av_shift(param->stashes);
11027 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11028 if (cloner && GvCV(cloner)) {
11033 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11035 call_sv((SV*)GvCV(cloner), G_DISCARD);
11041 SvREFCNT_dec(param->stashes);
11043 /* orphaned? eg threads->new inside BEGIN or use */
11044 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11045 (void)SvREFCNT_inc(PL_compcv);
11046 SAVEFREESV(PL_compcv);
11052 #endif /* USE_ITHREADS */
11055 =head1 Unicode Support
11057 =for apidoc sv_recode_to_utf8
11059 The encoding is assumed to be an Encode object, on entry the PV
11060 of the sv is assumed to be octets in that encoding, and the sv
11061 will be converted into Unicode (and UTF-8).
11063 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11064 is not a reference, nothing is done to the sv. If the encoding is not
11065 an C<Encode::XS> Encoding object, bad things will happen.
11066 (See F<lib/encoding.pm> and L<Encode>).
11068 The PV of the sv is returned.
11073 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11076 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11090 Passing sv_yes is wrong - it needs to be or'ed set of constants
11091 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11092 remove converted chars from source.
11094 Both will default the value - let them.
11096 XPUSHs(&PL_sv_yes);
11099 call_method("decode", G_SCALAR);
11103 s = SvPV_const(uni, len);
11104 if (s != SvPVX_const(sv)) {
11105 SvGROW(sv, len + 1);
11106 Move(s, SvPVX(sv), len + 1, char);
11107 SvCUR_set(sv, len);
11114 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11118 =for apidoc sv_cat_decode
11120 The encoding is assumed to be an Encode object, the PV of the ssv is
11121 assumed to be octets in that encoding and decoding the input starts
11122 from the position which (PV + *offset) pointed to. The dsv will be
11123 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11124 when the string tstr appears in decoding output or the input ends on
11125 the PV of the ssv. The value which the offset points will be modified
11126 to the last input position on the ssv.
11128 Returns TRUE if the terminator was found, else returns FALSE.
11133 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11134 SV *ssv, int *offset, char *tstr, int tlen)
11138 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11149 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11150 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11152 call_method("cat_decode", G_SCALAR);
11154 ret = SvTRUE(TOPs);
11155 *offset = SvIV(offsv);
11161 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11166 /* ---------------------------------------------------------------------
11168 * support functions for report_uninit()
11171 /* the maxiumum size of array or hash where we will scan looking
11172 * for the undefined element that triggered the warning */
11174 #define FUV_MAX_SEARCH_SIZE 1000
11176 /* Look for an entry in the hash whose value has the same SV as val;
11177 * If so, return a mortal copy of the key. */
11180 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11183 register HE **array;
11186 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11187 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11190 array = HvARRAY(hv);
11192 for (i=HvMAX(hv); i>0; i--) {
11193 register HE *entry;
11194 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11195 if (HeVAL(entry) != val)
11197 if ( HeVAL(entry) == &PL_sv_undef ||
11198 HeVAL(entry) == &PL_sv_placeholder)
11202 if (HeKLEN(entry) == HEf_SVKEY)
11203 return sv_mortalcopy(HeKEY_sv(entry));
11204 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11210 /* Look for an entry in the array whose value has the same SV as val;
11211 * If so, return the index, otherwise return -1. */
11214 S_find_array_subscript(pTHX_ AV *av, SV* val)
11218 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11219 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11223 for (i=AvFILLp(av); i>=0; i--) {
11224 if (svp[i] == val && svp[i] != &PL_sv_undef)
11230 /* S_varname(): return the name of a variable, optionally with a subscript.
11231 * If gv is non-zero, use the name of that global, along with gvtype (one
11232 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11233 * targ. Depending on the value of the subscript_type flag, return:
11236 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11237 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11238 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11239 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11242 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11243 SV* keyname, I32 aindex, int subscript_type)
11246 SV * const name = sv_newmortal();
11249 buffer[0] = gvtype;
11252 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11254 gv_fullname4(name, gv, buffer, 0);
11256 if ((unsigned int)SvPVX(name)[1] <= 26) {
11258 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11260 /* Swap the 1 unprintable control character for the 2 byte pretty
11261 version - ie substr($name, 1, 1) = $buffer; */
11262 sv_insert(name, 1, 1, buffer, 2);
11267 CV * const cv = find_runcv(&unused);
11271 if (!cv || !CvPADLIST(cv))
11273 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11274 sv = *av_fetch(av, targ, FALSE);
11275 /* SvLEN in a pad name is not to be trusted */
11276 sv_setpv(name, SvPV_nolen_const(sv));
11279 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11280 SV * const sv = NEWSV(0,0);
11281 *SvPVX(name) = '$';
11282 Perl_sv_catpvf(aTHX_ name, "{%s}",
11283 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11286 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11287 *SvPVX(name) = '$';
11288 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11290 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11291 sv_insert(name, 0, 0, "within ", 7);
11298 =for apidoc find_uninit_var
11300 Find the name of the undefined variable (if any) that caused the operator o
11301 to issue a "Use of uninitialized value" warning.
11302 If match is true, only return a name if it's value matches uninit_sv.
11303 So roughly speaking, if a unary operator (such as OP_COS) generates a
11304 warning, then following the direct child of the op may yield an
11305 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11306 other hand, with OP_ADD there are two branches to follow, so we only print
11307 the variable name if we get an exact match.
11309 The name is returned as a mortal SV.
11311 Assumes that PL_op is the op that originally triggered the error, and that
11312 PL_comppad/PL_curpad points to the currently executing pad.
11318 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11326 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11327 uninit_sv == &PL_sv_placeholder)))
11330 switch (obase->op_type) {
11337 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11338 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11340 SV *keysv = Nullsv;
11341 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11343 if (pad) { /* @lex, %lex */
11344 sv = PAD_SVl(obase->op_targ);
11348 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11349 /* @global, %global */
11350 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11353 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11355 else /* @{expr}, %{expr} */
11356 return find_uninit_var(cUNOPx(obase)->op_first,
11360 /* attempt to find a match within the aggregate */
11362 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11364 subscript_type = FUV_SUBSCRIPT_HASH;
11367 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11369 subscript_type = FUV_SUBSCRIPT_ARRAY;
11372 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11375 return varname(gv, hash ? '%' : '@', obase->op_targ,
11376 keysv, index, subscript_type);
11380 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11382 return varname(Nullgv, '$', obase->op_targ,
11383 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11386 gv = cGVOPx_gv(obase);
11387 if (!gv || (match && GvSV(gv) != uninit_sv))
11389 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11392 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11395 av = (AV*)PAD_SV(obase->op_targ);
11396 if (!av || SvRMAGICAL(av))
11398 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11399 if (!svp || *svp != uninit_sv)
11402 return varname(Nullgv, '$', obase->op_targ,
11403 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11406 gv = cGVOPx_gv(obase);
11412 if (!av || SvRMAGICAL(av))
11414 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11415 if (!svp || *svp != uninit_sv)
11418 return varname(gv, '$', 0,
11419 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11424 o = cUNOPx(obase)->op_first;
11425 if (!o || o->op_type != OP_NULL ||
11426 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11428 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11432 if (PL_op == obase)
11433 /* $a[uninit_expr] or $h{uninit_expr} */
11434 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11437 o = cBINOPx(obase)->op_first;
11438 kid = cBINOPx(obase)->op_last;
11440 /* get the av or hv, and optionally the gv */
11442 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11443 sv = PAD_SV(o->op_targ);
11445 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11446 && cUNOPo->op_first->op_type == OP_GV)
11448 gv = cGVOPx_gv(cUNOPo->op_first);
11451 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11456 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11457 /* index is constant */
11461 if (obase->op_type == OP_HELEM) {
11462 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11463 if (!he || HeVAL(he) != uninit_sv)
11467 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11468 if (!svp || *svp != uninit_sv)
11472 if (obase->op_type == OP_HELEM)
11473 return varname(gv, '%', o->op_targ,
11474 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11476 return varname(gv, '@', o->op_targ, Nullsv,
11477 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11481 /* index is an expression;
11482 * attempt to find a match within the aggregate */
11483 if (obase->op_type == OP_HELEM) {
11484 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11486 return varname(gv, '%', o->op_targ,
11487 keysv, 0, FUV_SUBSCRIPT_HASH);
11490 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11492 return varname(gv, '@', o->op_targ,
11493 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11498 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11500 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11506 /* only examine RHS */
11507 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11510 o = cUNOPx(obase)->op_first;
11511 if (o->op_type == OP_PUSHMARK)
11514 if (!o->op_sibling) {
11515 /* one-arg version of open is highly magical */
11517 if (o->op_type == OP_GV) { /* open FOO; */
11519 if (match && GvSV(gv) != uninit_sv)
11521 return varname(gv, '$', 0,
11522 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11524 /* other possibilities not handled are:
11525 * open $x; or open my $x; should return '${*$x}'
11526 * open expr; should return '$'.expr ideally
11532 /* ops where $_ may be an implicit arg */
11536 if ( !(obase->op_flags & OPf_STACKED)) {
11537 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11538 ? PAD_SVl(obase->op_targ)
11541 sv = sv_newmortal();
11542 sv_setpvn(sv, "$_", 2);
11550 /* skip filehandle as it can't produce 'undef' warning */
11551 o = cUNOPx(obase)->op_first;
11552 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11553 o = o->op_sibling->op_sibling;
11560 match = 1; /* XS or custom code could trigger random warnings */
11565 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11566 return sv_2mortal(newSVpvn("${$/}", 5));
11571 if (!(obase->op_flags & OPf_KIDS))
11573 o = cUNOPx(obase)->op_first;
11579 /* if all except one arg are constant, or have no side-effects,
11580 * or are optimized away, then it's unambiguous */
11582 for (kid=o; kid; kid = kid->op_sibling) {
11584 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11585 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11586 || (kid->op_type == OP_PUSHMARK)
11590 if (o2) { /* more than one found */
11597 return find_uninit_var(o2, uninit_sv, match);
11599 /* scan all args */
11601 sv = find_uninit_var(o, uninit_sv, 1);
11613 =for apidoc report_uninit
11615 Print appropriate "Use of uninitialized variable" warning
11621 Perl_report_uninit(pTHX_ SV* uninit_sv)
11624 SV* varname = Nullsv;
11626 varname = find_uninit_var(PL_op, uninit_sv,0);
11628 sv_insert(varname, 0, 0, " ", 1);
11630 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11631 varname ? SvPV_nolen_const(varname) : "",
11632 " in ", OP_DESC(PL_op));
11635 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11641 * c-indentation-style: bsd
11642 * c-basic-offset: 4
11643 * indent-tabs-mode: t
11646 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob