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);
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));
2686 *lp = strlen(typestr);
2687 return (char *)typestr;
2689 if (SvREADONLY(sv) && !SvOK(sv)) {
2690 if (ckWARN(WARN_UNINITIALIZED))
2697 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2698 /* I'm assuming that if both IV and NV are equally valid then
2699 converting the IV is going to be more efficient */
2700 const U32 isIOK = SvIOK(sv);
2701 const U32 isUIOK = SvIsUV(sv);
2702 char buf[TYPE_CHARS(UV)];
2705 if (SvTYPE(sv) < SVt_PVIV)
2706 sv_upgrade(sv, SVt_PVIV);
2708 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
2710 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
2711 /* inlined from sv_setpvn */
2712 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2713 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2714 SvCUR_set(sv, ebuf - ptr);
2724 else if (SvNOKp(sv)) {
2725 if (SvTYPE(sv) < SVt_PVNV)
2726 sv_upgrade(sv, SVt_PVNV);
2727 /* The +20 is pure guesswork. Configure test needed. --jhi */
2728 s = SvGROW_mutable(sv, NV_DIG + 20);
2729 olderrno = errno; /* some Xenix systems wipe out errno here */
2731 if (SvNVX(sv) == 0.0)
2732 (void)strcpy(s,"0");
2736 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2739 #ifdef FIXNEGATIVEZERO
2740 if (*s == '-' && s[1] == '0' && !s[2])
2750 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2754 if (SvTYPE(sv) < SVt_PV)
2755 /* Typically the caller expects that sv_any is not NULL now. */
2756 sv_upgrade(sv, SVt_PV);
2760 const STRLEN len = s - SvPVX_const(sv);
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2767 PTR2UV(sv),SvPVX_const(sv)));
2768 if (flags & SV_CONST_RETURN)
2769 return (char *)SvPVX_const(sv);
2770 if (flags & SV_MUTABLE_RETURN)
2771 return SvPVX_mutable(sv);
2775 len = strlen(tmpbuf);
2778 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2779 /* Sneaky stuff here */
2783 tsv = newSVpvn(tmpbuf, len);
2792 #ifdef FIXNEGATIVEZERO
2793 if (len == 2 && tmpbuf[0] == '-' && tmpbuf[1] == '0') {
2799 SvUPGRADE(sv, SVt_PV);
2802 s = SvGROW_mutable(sv, len + 1);
2805 return memcpy(s, tmpbuf, len + 1);
2810 =for apidoc sv_copypv
2812 Copies a stringified representation of the source SV into the
2813 destination SV. Automatically performs any necessary mg_get and
2814 coercion of numeric values into strings. Guaranteed to preserve
2815 UTF-8 flag even from overloaded objects. Similar in nature to
2816 sv_2pv[_flags] but operates directly on an SV instead of just the
2817 string. Mostly uses sv_2pv_flags to do its work, except when that
2818 would lose the UTF-8'ness of the PV.
2824 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2827 const char * const s = SvPV_const(ssv,len);
2828 sv_setpvn(dsv,s,len);
2836 =for apidoc sv_2pvbyte
2838 Return a pointer to the byte-encoded representation of the SV, and set *lp
2839 to its length. May cause the SV to be downgraded from UTF-8 as a
2842 Usually accessed via the C<SvPVbyte> macro.
2848 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2850 sv_utf8_downgrade(sv,0);
2851 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2855 =for apidoc sv_2pvutf8
2857 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2858 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2860 Usually accessed via the C<SvPVutf8> macro.
2866 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2868 sv_utf8_upgrade(sv);
2869 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2874 =for apidoc sv_2bool
2876 This function is only called on magical items, and is only used by
2877 sv_true() or its macro equivalent.
2883 Perl_sv_2bool(pTHX_ register SV *sv)
2891 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
2892 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2893 return (bool)SvTRUE(tmpsv);
2894 return SvRV(sv) != 0;
2897 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2899 (*sv->sv_u.svu_pv > '0' ||
2900 Xpvtmp->xpv_cur > 1 ||
2901 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2908 return SvIVX(sv) != 0;
2911 return SvNVX(sv) != 0.0;
2919 =for apidoc sv_utf8_upgrade
2921 Converts the PV of an SV to its UTF-8-encoded form.
2922 Forces the SV to string form if it is not already.
2923 Always sets the SvUTF8 flag to avoid future validity checks even
2924 if all the bytes have hibit clear.
2926 This is not as a general purpose byte encoding to Unicode interface:
2927 use the Encode extension for that.
2929 =for apidoc sv_utf8_upgrade_flags
2931 Converts the PV of an SV to its UTF-8-encoded form.
2932 Forces the SV to string form if it is not already.
2933 Always sets the SvUTF8 flag to avoid future validity checks even
2934 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2935 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2936 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2938 This is not as a general purpose byte encoding to Unicode interface:
2939 use the Encode extension for that.
2945 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2947 if (sv == &PL_sv_undef)
2951 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2952 (void) sv_2pv_flags(sv,&len, flags);
2956 (void) SvPV_force(sv,len);
2965 sv_force_normal_flags(sv, 0);
2968 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2969 sv_recode_to_utf8(sv, PL_encoding);
2970 else { /* Assume Latin-1/EBCDIC */
2971 /* This function could be much more efficient if we
2972 * had a FLAG in SVs to signal if there are any hibit
2973 * chars in the PV. Given that there isn't such a flag
2974 * make the loop as fast as possible. */
2975 const U8 *s = (U8 *) SvPVX_const(sv);
2976 const U8 * const e = (U8 *) SvEND(sv);
2982 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
2986 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2987 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2989 SvPV_free(sv); /* No longer using what was there before. */
2991 SvPV_set(sv, (char*)recoded);
2992 SvCUR_set(sv, len - 1);
2993 SvLEN_set(sv, len); /* No longer know the real size. */
2995 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3002 =for apidoc sv_utf8_downgrade
3004 Attempts to convert the PV of an SV from characters to bytes.
3005 If the PV contains a character beyond byte, this conversion will fail;
3006 in this case, either returns false or, if C<fail_ok> is not
3009 This is not as a general purpose Unicode to byte encoding interface:
3010 use the Encode extension for that.
3016 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3018 if (SvPOKp(sv) && SvUTF8(sv)) {
3024 sv_force_normal_flags(sv, 0);
3026 s = (U8 *) SvPV(sv, len);
3027 if (!utf8_to_bytes(s, &len)) {
3032 Perl_croak(aTHX_ "Wide character in %s",
3035 Perl_croak(aTHX_ "Wide character");
3046 =for apidoc sv_utf8_encode
3048 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3049 flag off so that it looks like octets again.
3055 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3057 (void) sv_utf8_upgrade(sv);
3059 sv_force_normal_flags(sv, 0);
3061 if (SvREADONLY(sv)) {
3062 Perl_croak(aTHX_ PL_no_modify);
3068 =for apidoc sv_utf8_decode
3070 If the PV of the SV is an octet sequence in UTF-8
3071 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3072 so that it looks like a character. If the PV contains only single-byte
3073 characters, the C<SvUTF8> flag stays being off.
3074 Scans PV for validity and returns false if the PV is invalid UTF-8.
3080 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3086 /* The octets may have got themselves encoded - get them back as
3089 if (!sv_utf8_downgrade(sv, TRUE))
3092 /* it is actually just a matter of turning the utf8 flag on, but
3093 * we want to make sure everything inside is valid utf8 first.
3095 c = (const U8 *) SvPVX_const(sv);
3096 if (!is_utf8_string(c, SvCUR(sv)+1))
3098 e = (const U8 *) SvEND(sv);
3101 if (!UTF8_IS_INVARIANT(ch)) {
3111 =for apidoc sv_setsv
3113 Copies the contents of the source SV C<ssv> into the destination SV
3114 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3115 function if the source SV needs to be reused. Does not handle 'set' magic.
3116 Loosely speaking, it performs a copy-by-value, obliterating any previous
3117 content of the destination.
3119 You probably want to use one of the assortment of wrappers, such as
3120 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3121 C<SvSetMagicSV_nosteal>.
3123 =for apidoc sv_setsv_flags
3125 Copies the contents of the source SV C<ssv> into the destination SV
3126 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3127 function if the source SV needs to be reused. Does not handle 'set' magic.
3128 Loosely speaking, it performs a copy-by-value, obliterating any previous
3129 content of the destination.
3130 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3131 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3132 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3133 and C<sv_setsv_nomg> are implemented in terms of this function.
3135 You probably want to use one of the assortment of wrappers, such as
3136 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3137 C<SvSetMagicSV_nosteal>.
3139 This is the primary function for copying scalars, and most other
3140 copy-ish functions and macros use this underneath.
3146 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3148 register U32 sflags;
3154 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3156 sstr = &PL_sv_undef;
3157 stype = SvTYPE(sstr);
3158 dtype = SvTYPE(dstr);
3163 /* need to nuke the magic */
3165 SvRMAGICAL_off(dstr);
3168 /* There's a lot of redundancy below but we're going for speed here */
3173 if (dtype != SVt_PVGV) {
3174 (void)SvOK_off(dstr);
3182 sv_upgrade(dstr, SVt_IV);
3185 sv_upgrade(dstr, SVt_PVNV);
3189 sv_upgrade(dstr, SVt_PVIV);
3192 (void)SvIOK_only(dstr);
3193 SvIV_set(dstr, SvIVX(sstr));
3196 if (SvTAINTED(sstr))
3207 sv_upgrade(dstr, SVt_NV);
3212 sv_upgrade(dstr, SVt_PVNV);
3215 SvNV_set(dstr, SvNVX(sstr));
3216 (void)SvNOK_only(dstr);
3217 if (SvTAINTED(sstr))
3225 sv_upgrade(dstr, SVt_RV);
3226 else if (dtype == SVt_PVGV &&
3227 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3230 if (GvIMPORTED(dstr) != GVf_IMPORTED
3231 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3233 GvIMPORTED_on(dstr);
3242 #ifdef PERL_OLD_COPY_ON_WRITE
3243 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3244 if (dtype < SVt_PVIV)
3245 sv_upgrade(dstr, SVt_PVIV);
3252 sv_upgrade(dstr, SVt_PV);
3255 if (dtype < SVt_PVIV)
3256 sv_upgrade(dstr, SVt_PVIV);
3259 if (dtype < SVt_PVNV)
3260 sv_upgrade(dstr, SVt_PVNV);
3267 const char * const type = sv_reftype(sstr,0);
3269 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3271 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3276 if (dtype <= SVt_PVGV) {
3278 if (dtype != SVt_PVGV) {
3279 const char * const name = GvNAME(sstr);
3280 const STRLEN len = GvNAMELEN(sstr);
3281 /* don't upgrade SVt_PVLV: it can hold a glob */
3282 if (dtype != SVt_PVLV)
3283 sv_upgrade(dstr, SVt_PVGV);
3284 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
3285 GvSTASH(dstr) = GvSTASH(sstr);
3287 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3288 GvNAME(dstr) = savepvn(name, len);
3289 GvNAMELEN(dstr) = len;
3290 SvFAKE_on(dstr); /* can coerce to non-glob */
3293 #ifdef GV_UNIQUE_CHECK
3294 if (GvUNIQUE((GV*)dstr)) {
3295 Perl_croak(aTHX_ PL_no_modify);
3299 (void)SvOK_off(dstr);
3300 GvINTRO_off(dstr); /* one-shot flag */
3302 GvGP(dstr) = gp_ref(GvGP(sstr));
3303 if (SvTAINTED(sstr))
3305 if (GvIMPORTED(dstr) != GVf_IMPORTED
3306 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3308 GvIMPORTED_on(dstr);
3316 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3318 if ((int)SvTYPE(sstr) != stype) {
3319 stype = SvTYPE(sstr);
3320 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3324 if (stype == SVt_PVLV)
3325 SvUPGRADE(dstr, SVt_PVNV);
3327 SvUPGRADE(dstr, (U32)stype);
3330 sflags = SvFLAGS(sstr);
3332 if (sflags & SVf_ROK) {
3333 if (dtype >= SVt_PV) {
3334 if (dtype == SVt_PVGV) {
3335 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3337 const int intro = GvINTRO(dstr);
3339 #ifdef GV_UNIQUE_CHECK
3340 if (GvUNIQUE((GV*)dstr)) {
3341 Perl_croak(aTHX_ PL_no_modify);
3346 GvINTRO_off(dstr); /* one-shot flag */
3347 GvLINE(dstr) = CopLINE(PL_curcop);
3348 GvEGV(dstr) = (GV*)dstr;
3351 switch (SvTYPE(sref)) {
3354 SAVEGENERICSV(GvAV(dstr));
3356 dref = (SV*)GvAV(dstr);
3357 GvAV(dstr) = (AV*)sref;
3358 if (!GvIMPORTED_AV(dstr)
3359 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3361 GvIMPORTED_AV_on(dstr);
3366 SAVEGENERICSV(GvHV(dstr));
3368 dref = (SV*)GvHV(dstr);
3369 GvHV(dstr) = (HV*)sref;
3370 if (!GvIMPORTED_HV(dstr)
3371 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3373 GvIMPORTED_HV_on(dstr);
3378 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3379 SvREFCNT_dec(GvCV(dstr));
3380 GvCV(dstr) = Nullcv;
3381 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3382 PL_sub_generation++;
3384 SAVEGENERICSV(GvCV(dstr));
3387 dref = (SV*)GvCV(dstr);
3388 if (GvCV(dstr) != (CV*)sref) {
3389 CV* const cv = GvCV(dstr);
3391 if (!GvCVGEN((GV*)dstr) &&
3392 (CvROOT(cv) || CvXSUB(cv)))
3394 /* Redefining a sub - warning is mandatory if
3395 it was a const and its value changed. */
3396 if (ckWARN(WARN_REDEFINE)
3398 && (!CvCONST((CV*)sref)
3399 || sv_cmp(cv_const_sv(cv),
3400 cv_const_sv((CV*)sref)))))
3402 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3404 ? "Constant subroutine %s::%s redefined"
3405 : "Subroutine %s::%s redefined",
3406 HvNAME_get(GvSTASH((GV*)dstr)),
3407 GvENAME((GV*)dstr));
3411 cv_ckproto(cv, (GV*)dstr,
3413 ? SvPVX_const(sref) : Nullch);
3415 GvCV(dstr) = (CV*)sref;
3416 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3417 GvASSUMECV_on(dstr);
3418 PL_sub_generation++;
3420 if (!GvIMPORTED_CV(dstr)
3421 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3423 GvIMPORTED_CV_on(dstr);
3428 SAVEGENERICSV(GvIOp(dstr));
3430 dref = (SV*)GvIOp(dstr);
3431 GvIOp(dstr) = (IO*)sref;
3435 SAVEGENERICSV(GvFORM(dstr));
3437 dref = (SV*)GvFORM(dstr);
3438 GvFORM(dstr) = (CV*)sref;
3442 SAVEGENERICSV(GvSV(dstr));
3444 dref = (SV*)GvSV(dstr);
3446 if (!GvIMPORTED_SV(dstr)
3447 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3449 GvIMPORTED_SV_on(dstr);
3455 if (SvTAINTED(sstr))
3459 if (SvPVX_const(dstr)) {
3465 (void)SvOK_off(dstr);
3466 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3468 if (sflags & SVp_NOK) {
3470 /* Only set the public OK flag if the source has public OK. */
3471 if (sflags & SVf_NOK)
3472 SvFLAGS(dstr) |= SVf_NOK;
3473 SvNV_set(dstr, SvNVX(sstr));
3475 if (sflags & SVp_IOK) {
3476 (void)SvIOKp_on(dstr);
3477 if (sflags & SVf_IOK)
3478 SvFLAGS(dstr) |= SVf_IOK;
3479 if (sflags & SVf_IVisUV)
3481 SvIV_set(dstr, SvIVX(sstr));
3483 if (SvAMAGIC(sstr)) {
3487 else if (sflags & SVp_POK) {
3491 * Check to see if we can just swipe the string. If so, it's a
3492 * possible small lose on short strings, but a big win on long ones.
3493 * It might even be a win on short strings if SvPVX_const(dstr)
3494 * has to be allocated and SvPVX_const(sstr) has to be freed.
3497 /* Whichever path we take through the next code, we want this true,
3498 and doing it now facilitates the COW check. */
3499 (void)SvPOK_only(dstr);
3502 /* We're not already COW */
3503 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3504 #ifndef PERL_OLD_COPY_ON_WRITE
3505 /* or we are, but dstr isn't a suitable target. */
3506 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3511 (sflags & SVs_TEMP) && /* slated for free anyway? */
3512 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3513 (!(flags & SV_NOSTEAL)) &&
3514 /* and we're allowed to steal temps */
3515 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3516 SvLEN(sstr) && /* and really is a string */
3517 /* and won't be needed again, potentially */
3518 !(PL_op && PL_op->op_type == OP_AASSIGN))
3519 #ifdef PERL_OLD_COPY_ON_WRITE
3520 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3521 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3522 && SvTYPE(sstr) >= SVt_PVIV)
3525 /* Failed the swipe test, and it's not a shared hash key either.
3526 Have to copy the string. */
3527 STRLEN len = SvCUR(sstr);
3528 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3529 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3530 SvCUR_set(dstr, len);
3531 *SvEND(dstr) = '\0';
3533 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3535 /* Either it's a shared hash key, or it's suitable for
3536 copy-on-write or we can swipe the string. */
3538 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3542 #ifdef PERL_OLD_COPY_ON_WRITE
3544 /* I believe I should acquire a global SV mutex if
3545 it's a COW sv (not a shared hash key) to stop
3546 it going un copy-on-write.
3547 If the source SV has gone un copy on write between up there
3548 and down here, then (assert() that) it is of the correct
3549 form to make it copy on write again */
3550 if ((sflags & (SVf_FAKE | SVf_READONLY))
3551 != (SVf_FAKE | SVf_READONLY)) {
3552 SvREADONLY_on(sstr);
3554 /* Make the source SV into a loop of 1.
3555 (about to become 2) */
3556 SV_COW_NEXT_SV_SET(sstr, sstr);
3560 /* Initial code is common. */
3561 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3566 /* making another shared SV. */
3567 STRLEN cur = SvCUR(sstr);
3568 STRLEN len = SvLEN(sstr);
3569 #ifdef PERL_OLD_COPY_ON_WRITE
3571 assert (SvTYPE(dstr) >= SVt_PVIV);
3572 /* SvIsCOW_normal */
3573 /* splice us in between source and next-after-source. */
3574 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3575 SV_COW_NEXT_SV_SET(sstr, dstr);
3576 SvPV_set(dstr, SvPVX_mutable(sstr));
3580 /* SvIsCOW_shared_hash */
3581 DEBUG_C(PerlIO_printf(Perl_debug_log,
3582 "Copy on write: Sharing hash\n"));
3584 assert (SvTYPE(dstr) >= SVt_PV);
3586 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3588 SvLEN_set(dstr, len);
3589 SvCUR_set(dstr, cur);
3590 SvREADONLY_on(dstr);
3592 /* Relesase a global SV mutex. */
3595 { /* Passes the swipe test. */
3596 SvPV_set(dstr, SvPVX_mutable(sstr));
3597 SvLEN_set(dstr, SvLEN(sstr));
3598 SvCUR_set(dstr, SvCUR(sstr));
3601 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3602 SvPV_set(sstr, Nullch);
3608 if (sflags & SVf_UTF8)
3610 if (sflags & SVp_NOK) {
3612 if (sflags & SVf_NOK)
3613 SvFLAGS(dstr) |= SVf_NOK;
3614 SvNV_set(dstr, SvNVX(sstr));
3616 if (sflags & SVp_IOK) {
3617 (void)SvIOKp_on(dstr);
3618 if (sflags & SVf_IOK)
3619 SvFLAGS(dstr) |= SVf_IOK;
3620 if (sflags & SVf_IVisUV)
3622 SvIV_set(dstr, SvIVX(sstr));
3625 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
3626 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3627 smg->mg_ptr, smg->mg_len);
3628 SvRMAGICAL_on(dstr);
3631 else if (sflags & SVp_IOK) {
3632 if (sflags & SVf_IOK)
3633 (void)SvIOK_only(dstr);
3635 (void)SvOK_off(dstr);
3636 (void)SvIOKp_on(dstr);
3638 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3639 if (sflags & SVf_IVisUV)
3641 SvIV_set(dstr, SvIVX(sstr));
3642 if (sflags & SVp_NOK) {
3643 if (sflags & SVf_NOK)
3644 (void)SvNOK_on(dstr);
3646 (void)SvNOKp_on(dstr);
3647 SvNV_set(dstr, SvNVX(sstr));
3650 else if (sflags & SVp_NOK) {
3651 if (sflags & SVf_NOK)
3652 (void)SvNOK_only(dstr);
3654 (void)SvOK_off(dstr);
3657 SvNV_set(dstr, SvNVX(sstr));
3660 if (dtype == SVt_PVGV) {
3661 if (ckWARN(WARN_MISC))
3662 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3665 (void)SvOK_off(dstr);
3667 if (SvTAINTED(sstr))
3672 =for apidoc sv_setsv_mg
3674 Like C<sv_setsv>, but also handles 'set' magic.
3680 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3682 sv_setsv(dstr,sstr);
3686 #ifdef PERL_OLD_COPY_ON_WRITE
3688 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3690 STRLEN cur = SvCUR(sstr);
3691 STRLEN len = SvLEN(sstr);
3692 register char *new_pv;
3695 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3703 if (SvTHINKFIRST(dstr))
3704 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3705 else if (SvPVX_const(dstr))
3706 Safefree(SvPVX_const(dstr));
3710 SvUPGRADE(dstr, SVt_PVIV);
3712 assert (SvPOK(sstr));
3713 assert (SvPOKp(sstr));
3714 assert (!SvIOK(sstr));
3715 assert (!SvIOKp(sstr));
3716 assert (!SvNOK(sstr));
3717 assert (!SvNOKp(sstr));
3719 if (SvIsCOW(sstr)) {
3721 if (SvLEN(sstr) == 0) {
3722 /* source is a COW shared hash key. */
3723 DEBUG_C(PerlIO_printf(Perl_debug_log,
3724 "Fast copy on write: Sharing hash\n"));
3725 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3728 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3730 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3731 SvUPGRADE(sstr, SVt_PVIV);
3732 SvREADONLY_on(sstr);
3734 DEBUG_C(PerlIO_printf(Perl_debug_log,
3735 "Fast copy on write: Converting sstr to COW\n"));
3736 SV_COW_NEXT_SV_SET(dstr, sstr);
3738 SV_COW_NEXT_SV_SET(sstr, dstr);
3739 new_pv = SvPVX_mutable(sstr);
3742 SvPV_set(dstr, new_pv);
3743 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3746 SvLEN_set(dstr, len);
3747 SvCUR_set(dstr, cur);
3756 =for apidoc sv_setpvn
3758 Copies a string into an SV. The C<len> parameter indicates the number of
3759 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3760 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3766 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3768 register char *dptr;
3770 SV_CHECK_THINKFIRST_COW_DROP(sv);
3776 /* len is STRLEN which is unsigned, need to copy to signed */
3779 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3781 SvUPGRADE(sv, SVt_PV);
3783 dptr = SvGROW(sv, len + 1);
3784 Move(ptr,dptr,len,char);
3787 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3792 =for apidoc sv_setpvn_mg
3794 Like C<sv_setpvn>, but also handles 'set' magic.
3800 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3802 sv_setpvn(sv,ptr,len);
3807 =for apidoc sv_setpv
3809 Copies a string into an SV. The string must be null-terminated. Does not
3810 handle 'set' magic. See C<sv_setpv_mg>.
3816 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3818 register STRLEN len;
3820 SV_CHECK_THINKFIRST_COW_DROP(sv);
3826 SvUPGRADE(sv, SVt_PV);
3828 SvGROW(sv, len + 1);
3829 Move(ptr,SvPVX(sv),len+1,char);
3831 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3836 =for apidoc sv_setpv_mg
3838 Like C<sv_setpv>, but also handles 'set' magic.
3844 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3851 =for apidoc sv_usepvn
3853 Tells an SV to use C<ptr> to find its string value. Normally the string is
3854 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3855 The C<ptr> should point to memory that was allocated by C<malloc>. The
3856 string length, C<len>, must be supplied. This function will realloc the
3857 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3858 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3859 See C<sv_usepvn_mg>.
3865 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3868 SV_CHECK_THINKFIRST_COW_DROP(sv);
3869 SvUPGRADE(sv, SVt_PV);
3874 if (SvPVX_const(sv))
3877 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3878 ptr = saferealloc (ptr, allocate);
3881 SvLEN_set(sv, allocate);
3883 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3888 =for apidoc sv_usepvn_mg
3890 Like C<sv_usepvn>, but also handles 'set' magic.
3896 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3898 sv_usepvn(sv,ptr,len);
3902 #ifdef PERL_OLD_COPY_ON_WRITE
3903 /* Need to do this *after* making the SV normal, as we need the buffer
3904 pointer to remain valid until after we've copied it. If we let go too early,
3905 another thread could invalidate it by unsharing last of the same hash key
3906 (which it can do by means other than releasing copy-on-write Svs)
3907 or by changing the other copy-on-write SVs in the loop. */
3909 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3911 if (len) { /* this SV was SvIsCOW_normal(sv) */
3912 /* we need to find the SV pointing to us. */
3913 SV * const current = SV_COW_NEXT_SV(after);
3915 if (current == sv) {
3916 /* The SV we point to points back to us (there were only two of us
3918 Hence other SV is no longer copy on write either. */
3920 SvREADONLY_off(after);
3922 /* We need to follow the pointers around the loop. */
3924 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3927 /* don't loop forever if the structure is bust, and we have
3928 a pointer into a closed loop. */
3929 assert (current != after);
3930 assert (SvPVX_const(current) == pvx);
3932 /* Make the SV before us point to the SV after us. */
3933 SV_COW_NEXT_SV_SET(current, after);
3936 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3941 Perl_sv_release_IVX(pTHX_ register SV *sv)
3944 sv_force_normal_flags(sv, 0);
3950 =for apidoc sv_force_normal_flags
3952 Undo various types of fakery on an SV: if the PV is a shared string, make
3953 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3954 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3955 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3956 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3957 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3958 set to some other value.) In addition, the C<flags> parameter gets passed to
3959 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3960 with flags set to 0.
3966 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3968 #ifdef PERL_OLD_COPY_ON_WRITE
3969 if (SvREADONLY(sv)) {
3970 /* At this point I believe I should acquire a global SV mutex. */
3972 const char * const pvx = SvPVX_const(sv);
3973 const STRLEN len = SvLEN(sv);
3974 const STRLEN cur = SvCUR(sv);
3975 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3977 PerlIO_printf(Perl_debug_log,
3978 "Copy on write: Force normal %ld\n",
3984 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3985 SvPV_set(sv, (char*)0);
3987 if (flags & SV_COW_DROP_PV) {
3988 /* OK, so we don't need to copy our buffer. */
3991 SvGROW(sv, cur + 1);
3992 Move(pvx,SvPVX(sv),cur,char);
3996 sv_release_COW(sv, pvx, len, next);
4001 else if (IN_PERL_RUNTIME)
4002 Perl_croak(aTHX_ PL_no_modify);
4003 /* At this point I believe that I can drop the global SV mutex. */
4006 if (SvREADONLY(sv)) {
4008 const char * const pvx = SvPVX_const(sv);
4009 const STRLEN len = SvCUR(sv);
4012 SvPV_set(sv, Nullch);
4014 SvGROW(sv, len + 1);
4015 Move(pvx,SvPVX(sv),len,char);
4017 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4019 else if (IN_PERL_RUNTIME)
4020 Perl_croak(aTHX_ PL_no_modify);
4024 sv_unref_flags(sv, flags);
4025 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4032 Efficient removal of characters from the beginning of the string buffer.
4033 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4034 the string buffer. The C<ptr> becomes the first character of the adjusted
4035 string. Uses the "OOK hack".
4036 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4037 refer to the same chunk of data.
4043 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4045 register STRLEN delta;
4046 if (!ptr || !SvPOKp(sv))
4048 delta = ptr - SvPVX_const(sv);
4049 SV_CHECK_THINKFIRST(sv);
4050 if (SvTYPE(sv) < SVt_PVIV)
4051 sv_upgrade(sv,SVt_PVIV);
4054 if (!SvLEN(sv)) { /* make copy of shared string */
4055 const char *pvx = SvPVX_const(sv);
4056 const STRLEN len = SvCUR(sv);
4057 SvGROW(sv, len + 1);
4058 Move(pvx,SvPVX(sv),len,char);
4062 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4063 and we do that anyway inside the SvNIOK_off
4065 SvFLAGS(sv) |= SVf_OOK;
4068 SvLEN_set(sv, SvLEN(sv) - delta);
4069 SvCUR_set(sv, SvCUR(sv) - delta);
4070 SvPV_set(sv, SvPVX(sv) + delta);
4071 SvIV_set(sv, SvIVX(sv) + delta);
4075 =for apidoc sv_catpvn
4077 Concatenates the string onto the end of the string which is in the SV. The
4078 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4079 status set, then the bytes appended should be valid UTF-8.
4080 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4082 =for apidoc sv_catpvn_flags
4084 Concatenates the string onto the end of the string which is in the SV. The
4085 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4086 status set, then the bytes appended should be valid UTF-8.
4087 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4088 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4089 in terms of this function.
4095 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4098 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
4100 SvGROW(dsv, dlen + slen + 1);
4102 sstr = SvPVX_const(dsv);
4103 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4104 SvCUR_set(dsv, SvCUR(dsv) + slen);
4106 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4108 if (flags & SV_SMAGIC)
4113 =for apidoc sv_catsv
4115 Concatenates the string from SV C<ssv> onto the end of the string in
4116 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4117 not 'set' magic. See C<sv_catsv_mg>.
4119 =for apidoc sv_catsv_flags
4121 Concatenates the string from SV C<ssv> onto the end of the string in
4122 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4123 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4124 and C<sv_catsv_nomg> are implemented in terms of this function.
4129 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4134 if ((spv = SvPV_const(ssv, slen))) {
4135 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4136 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4137 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4138 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4139 dsv->sv_flags doesn't have that bit set.
4140 Andy Dougherty 12 Oct 2001
4142 const I32 sutf8 = DO_UTF8(ssv);
4145 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4147 dutf8 = DO_UTF8(dsv);
4149 if (dutf8 != sutf8) {
4151 /* Not modifying source SV, so taking a temporary copy. */
4152 SV* csv = sv_2mortal(newSVpvn(spv, slen));
4154 sv_utf8_upgrade(csv);
4155 spv = SvPV_const(csv, slen);
4158 sv_utf8_upgrade_nomg(dsv);
4160 sv_catpvn_nomg(dsv, spv, slen);
4163 if (flags & SV_SMAGIC)
4168 =for apidoc sv_catpv
4170 Concatenates the string onto the end of the string which is in the SV.
4171 If the SV has the UTF-8 status set, then the bytes appended should be
4172 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4177 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4179 register STRLEN len;
4185 junk = SvPV_force(sv, tlen);
4187 SvGROW(sv, tlen + len + 1);
4189 ptr = SvPVX_const(sv);
4190 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4191 SvCUR_set(sv, SvCUR(sv) + len);
4192 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4197 =for apidoc sv_catpv_mg
4199 Like C<sv_catpv>, but also handles 'set' magic.
4205 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4214 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4215 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4222 Perl_newSV(pTHX_ STRLEN len)
4228 sv_upgrade(sv, SVt_PV);
4229 SvGROW(sv, len + 1);
4234 =for apidoc sv_magicext
4236 Adds magic to an SV, upgrading it if necessary. Applies the
4237 supplied vtable and returns a pointer to the magic added.
4239 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4240 In particular, you can add magic to SvREADONLY SVs, and add more than
4241 one instance of the same 'how'.
4243 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4244 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4245 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4246 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4248 (This is now used as a subroutine by C<sv_magic>.)
4253 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4254 const char* name, I32 namlen)
4258 if (SvTYPE(sv) < SVt_PVMG) {
4259 SvUPGRADE(sv, SVt_PVMG);
4261 Newxz(mg, 1, MAGIC);
4262 mg->mg_moremagic = SvMAGIC(sv);
4263 SvMAGIC_set(sv, mg);
4265 /* Sometimes a magic contains a reference loop, where the sv and
4266 object refer to each other. To prevent a reference loop that
4267 would prevent such objects being freed, we look for such loops
4268 and if we find one we avoid incrementing the object refcount.
4270 Note we cannot do this to avoid self-tie loops as intervening RV must
4271 have its REFCNT incremented to keep it in existence.
4274 if (!obj || obj == sv ||
4275 how == PERL_MAGIC_arylen ||
4276 how == PERL_MAGIC_qr ||
4277 how == PERL_MAGIC_symtab ||
4278 (SvTYPE(obj) == SVt_PVGV &&
4279 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4280 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4281 GvFORM(obj) == (CV*)sv)))
4286 mg->mg_obj = SvREFCNT_inc(obj);
4287 mg->mg_flags |= MGf_REFCOUNTED;
4290 /* Normal self-ties simply pass a null object, and instead of
4291 using mg_obj directly, use the SvTIED_obj macro to produce a
4292 new RV as needed. For glob "self-ties", we are tieing the PVIO
4293 with an RV obj pointing to the glob containing the PVIO. In
4294 this case, to avoid a reference loop, we need to weaken the
4298 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4299 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4305 mg->mg_len = namlen;
4308 mg->mg_ptr = savepvn(name, namlen);
4309 else if (namlen == HEf_SVKEY)
4310 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4312 mg->mg_ptr = (char *) name;
4314 mg->mg_virtual = vtable;
4318 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4323 =for apidoc sv_magic
4325 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4326 then adds a new magic item of type C<how> to the head of the magic list.
4328 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4329 handling of the C<name> and C<namlen> arguments.
4331 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4332 to add more than one instance of the same 'how'.
4338 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4340 const MGVTBL *vtable;
4343 #ifdef PERL_OLD_COPY_ON_WRITE
4345 sv_force_normal_flags(sv, 0);
4347 if (SvREADONLY(sv)) {
4349 /* its okay to attach magic to shared strings; the subsequent
4350 * upgrade to PVMG will unshare the string */
4351 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4354 && how != PERL_MAGIC_regex_global
4355 && how != PERL_MAGIC_bm
4356 && how != PERL_MAGIC_fm
4357 && how != PERL_MAGIC_sv
4358 && how != PERL_MAGIC_backref
4361 Perl_croak(aTHX_ PL_no_modify);
4364 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4365 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4366 /* sv_magic() refuses to add a magic of the same 'how' as an
4369 if (how == PERL_MAGIC_taint)
4377 vtable = &PL_vtbl_sv;
4379 case PERL_MAGIC_overload:
4380 vtable = &PL_vtbl_amagic;
4382 case PERL_MAGIC_overload_elem:
4383 vtable = &PL_vtbl_amagicelem;
4385 case PERL_MAGIC_overload_table:
4386 vtable = &PL_vtbl_ovrld;
4389 vtable = &PL_vtbl_bm;
4391 case PERL_MAGIC_regdata:
4392 vtable = &PL_vtbl_regdata;
4394 case PERL_MAGIC_regdatum:
4395 vtable = &PL_vtbl_regdatum;
4397 case PERL_MAGIC_env:
4398 vtable = &PL_vtbl_env;
4401 vtable = &PL_vtbl_fm;
4403 case PERL_MAGIC_envelem:
4404 vtable = &PL_vtbl_envelem;
4406 case PERL_MAGIC_regex_global:
4407 vtable = &PL_vtbl_mglob;
4409 case PERL_MAGIC_isa:
4410 vtable = &PL_vtbl_isa;
4412 case PERL_MAGIC_isaelem:
4413 vtable = &PL_vtbl_isaelem;
4415 case PERL_MAGIC_nkeys:
4416 vtable = &PL_vtbl_nkeys;
4418 case PERL_MAGIC_dbfile:
4421 case PERL_MAGIC_dbline:
4422 vtable = &PL_vtbl_dbline;
4424 #ifdef USE_LOCALE_COLLATE
4425 case PERL_MAGIC_collxfrm:
4426 vtable = &PL_vtbl_collxfrm;
4428 #endif /* USE_LOCALE_COLLATE */
4429 case PERL_MAGIC_tied:
4430 vtable = &PL_vtbl_pack;
4432 case PERL_MAGIC_tiedelem:
4433 case PERL_MAGIC_tiedscalar:
4434 vtable = &PL_vtbl_packelem;
4437 vtable = &PL_vtbl_regexp;
4439 case PERL_MAGIC_sig:
4440 vtable = &PL_vtbl_sig;
4442 case PERL_MAGIC_sigelem:
4443 vtable = &PL_vtbl_sigelem;
4445 case PERL_MAGIC_taint:
4446 vtable = &PL_vtbl_taint;
4448 case PERL_MAGIC_uvar:
4449 vtable = &PL_vtbl_uvar;
4451 case PERL_MAGIC_vec:
4452 vtable = &PL_vtbl_vec;
4454 case PERL_MAGIC_arylen_p:
4455 case PERL_MAGIC_rhash:
4456 case PERL_MAGIC_symtab:
4457 case PERL_MAGIC_vstring:
4460 case PERL_MAGIC_utf8:
4461 vtable = &PL_vtbl_utf8;
4463 case PERL_MAGIC_substr:
4464 vtable = &PL_vtbl_substr;
4466 case PERL_MAGIC_defelem:
4467 vtable = &PL_vtbl_defelem;
4469 case PERL_MAGIC_glob:
4470 vtable = &PL_vtbl_glob;
4472 case PERL_MAGIC_arylen:
4473 vtable = &PL_vtbl_arylen;
4475 case PERL_MAGIC_pos:
4476 vtable = &PL_vtbl_pos;
4478 case PERL_MAGIC_backref:
4479 vtable = &PL_vtbl_backref;
4481 case PERL_MAGIC_ext:
4482 /* Reserved for use by extensions not perl internals. */
4483 /* Useful for attaching extension internal data to perl vars. */
4484 /* Note that multiple extensions may clash if magical scalars */
4485 /* etc holding private data from one are passed to another. */
4489 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4492 /* Rest of work is done else where */
4493 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4496 case PERL_MAGIC_taint:
4499 case PERL_MAGIC_ext:
4500 case PERL_MAGIC_dbfile:
4507 =for apidoc sv_unmagic
4509 Removes all magic of type C<type> from an SV.
4515 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4519 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4522 for (mg = *mgp; mg; mg = *mgp) {
4523 if (mg->mg_type == type) {
4524 const MGVTBL* const vtbl = mg->mg_virtual;
4525 *mgp = mg->mg_moremagic;
4526 if (vtbl && vtbl->svt_free)
4527 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4528 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4530 Safefree(mg->mg_ptr);
4531 else if (mg->mg_len == HEf_SVKEY)
4532 SvREFCNT_dec((SV*)mg->mg_ptr);
4533 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4534 Safefree(mg->mg_ptr);
4536 if (mg->mg_flags & MGf_REFCOUNTED)
4537 SvREFCNT_dec(mg->mg_obj);
4541 mgp = &mg->mg_moremagic;
4545 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4552 =for apidoc sv_rvweaken
4554 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4555 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4556 push a back-reference to this RV onto the array of backreferences
4557 associated with that magic.
4563 Perl_sv_rvweaken(pTHX_ SV *sv)
4566 if (!SvOK(sv)) /* let undefs pass */
4569 Perl_croak(aTHX_ "Can't weaken a nonreference");
4570 else if (SvWEAKREF(sv)) {
4571 if (ckWARN(WARN_MISC))
4572 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4576 Perl_sv_add_backref(aTHX_ tsv, sv);
4582 /* Give tsv backref magic if it hasn't already got it, then push a
4583 * back-reference to sv onto the array associated with the backref magic.
4587 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4591 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
4592 av = (AV*)mg->mg_obj;
4595 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4596 /* av now has a refcnt of 2, which avoids it getting freed
4597 * before us during global cleanup. The extra ref is removed
4598 * by magic_killbackrefs() when tsv is being freed */
4600 if (AvFILLp(av) >= AvMAX(av)) {
4601 av_extend(av, AvFILLp(av)+1);
4603 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4606 /* delete a back-reference to ourselves from the backref magic associated
4607 * with the SV we point to.
4611 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4617 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref))) {
4618 if (PL_in_clean_all)
4621 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
4622 Perl_croak(aTHX_ "panic: del_backref");
4623 av = (AV *)mg->mg_obj;
4625 /* We shouldn't be in here more than once, but for paranoia reasons lets
4627 for (i = AvFILLp(av); i >= 0; i--) {
4629 const SSize_t fill = AvFILLp(av);
4631 /* We weren't the last entry.
4632 An unordered list has this property that you can take the
4633 last element off the end to fill the hole, and it's still
4634 an unordered list :-)
4639 AvFILLp(av) = fill - 1;
4645 =for apidoc sv_insert
4647 Inserts a string at the specified offset/length within the SV. Similar to
4648 the Perl substr() function.
4654 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4658 register char *midend;
4659 register char *bigend;
4665 Perl_croak(aTHX_ "Can't modify non-existent substring");
4666 SvPV_force(bigstr, curlen);
4667 (void)SvPOK_only_UTF8(bigstr);
4668 if (offset + len > curlen) {
4669 SvGROW(bigstr, offset+len+1);
4670 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4671 SvCUR_set(bigstr, offset+len);
4675 i = littlelen - len;
4676 if (i > 0) { /* string might grow */
4677 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4678 mid = big + offset + len;
4679 midend = bigend = big + SvCUR(bigstr);
4682 while (midend > mid) /* shove everything down */
4683 *--bigend = *--midend;
4684 Move(little,big+offset,littlelen,char);
4685 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4690 Move(little,SvPVX(bigstr)+offset,len,char);
4695 big = SvPVX(bigstr);
4698 bigend = big + SvCUR(bigstr);
4700 if (midend > bigend)
4701 Perl_croak(aTHX_ "panic: sv_insert");
4703 if (mid - big > bigend - midend) { /* faster to shorten from end */
4705 Move(little, mid, littlelen,char);
4708 i = bigend - midend;
4710 Move(midend, mid, i,char);
4714 SvCUR_set(bigstr, mid - big);
4716 else if ((i = mid - big)) { /* faster from front */
4717 midend -= littlelen;
4719 sv_chop(bigstr,midend-i);
4724 Move(little, mid, littlelen,char);
4726 else if (littlelen) {
4727 midend -= littlelen;
4728 sv_chop(bigstr,midend);
4729 Move(little,midend,littlelen,char);
4732 sv_chop(bigstr,midend);
4738 =for apidoc sv_replace
4740 Make the first argument a copy of the second, then delete the original.
4741 The target SV physically takes over ownership of the body of the source SV
4742 and inherits its flags; however, the target keeps any magic it owns,
4743 and any magic in the source is discarded.
4744 Note that this is a rather specialist SV copying operation; most of the
4745 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4751 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4753 const U32 refcnt = SvREFCNT(sv);
4754 SV_CHECK_THINKFIRST_COW_DROP(sv);
4755 if (SvREFCNT(nsv) != 1) {
4756 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4757 UVuf " != 1)", (UV) SvREFCNT(nsv));
4759 if (SvMAGICAL(sv)) {
4763 sv_upgrade(nsv, SVt_PVMG);
4764 SvMAGIC_set(nsv, SvMAGIC(sv));
4765 SvFLAGS(nsv) |= SvMAGICAL(sv);
4767 SvMAGIC_set(sv, NULL);
4771 assert(!SvREFCNT(sv));
4772 #ifdef DEBUG_LEAKING_SCALARS
4773 sv->sv_flags = nsv->sv_flags;
4774 sv->sv_any = nsv->sv_any;
4775 sv->sv_refcnt = nsv->sv_refcnt;
4776 sv->sv_u = nsv->sv_u;
4778 StructCopy(nsv,sv,SV);
4780 /* Currently could join these into one piece of pointer arithmetic, but
4781 it would be unclear. */
4782 if(SvTYPE(sv) == SVt_IV)
4784 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4785 else if (SvTYPE(sv) == SVt_RV) {
4786 SvANY(sv) = &sv->sv_u.svu_rv;
4790 #ifdef PERL_OLD_COPY_ON_WRITE
4791 if (SvIsCOW_normal(nsv)) {
4792 /* We need to follow the pointers around the loop to make the
4793 previous SV point to sv, rather than nsv. */
4796 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4799 assert(SvPVX_const(current) == SvPVX_const(nsv));
4801 /* Make the SV before us point to the SV after us. */
4803 PerlIO_printf(Perl_debug_log, "previous is\n");
4805 PerlIO_printf(Perl_debug_log,
4806 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4807 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4809 SV_COW_NEXT_SV_SET(current, sv);
4812 SvREFCNT(sv) = refcnt;
4813 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4819 =for apidoc sv_clear
4821 Clear an SV: call any destructors, free up any memory used by the body,
4822 and free the body itself. The SV's head is I<not> freed, although
4823 its type is set to all 1's so that it won't inadvertently be assumed
4824 to be live during global destruction etc.
4825 This function should only be called when REFCNT is zero. Most of the time
4826 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4833 Perl_sv_clear(pTHX_ register SV *sv)
4836 const U32 type = SvTYPE(sv);
4837 const struct body_details *const sv_type_details
4838 = bodies_by_type + type;
4841 assert(SvREFCNT(sv) == 0);
4847 if (PL_defstash) { /* Still have a symbol table? */
4852 stash = SvSTASH(sv);
4853 destructor = StashHANDLER(stash,DESTROY);
4855 SV* const tmpref = newRV(sv);
4856 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4858 PUSHSTACKi(PERLSI_DESTROY);
4863 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4869 if(SvREFCNT(tmpref) < 2) {
4870 /* tmpref is not kept alive! */
4872 SvRV_set(tmpref, NULL);
4875 SvREFCNT_dec(tmpref);
4877 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4881 if (PL_in_clean_objs)
4882 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4884 /* DESTROY gave object new lease on life */
4890 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4891 SvOBJECT_off(sv); /* Curse the object. */
4892 if (type != SVt_PVIO)
4893 --PL_sv_objcount; /* XXX Might want something more general */
4896 if (type >= SVt_PVMG) {
4899 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4900 SvREFCNT_dec(SvSTASH(sv));
4905 IoIFP(sv) != PerlIO_stdin() &&
4906 IoIFP(sv) != PerlIO_stdout() &&
4907 IoIFP(sv) != PerlIO_stderr())
4909 io_close((IO*)sv, FALSE);
4911 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4912 PerlDir_close(IoDIRP(sv));
4913 IoDIRP(sv) = (DIR*)NULL;
4914 Safefree(IoTOP_NAME(sv));
4915 Safefree(IoFMT_NAME(sv));
4916 Safefree(IoBOTTOM_NAME(sv));
4931 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4932 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4933 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4934 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4936 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4937 SvREFCNT_dec(LvTARG(sv));
4941 Safefree(GvNAME(sv));
4942 /* If we're in a stash, we don't own a reference to it. However it does
4943 have a back reference to us, which needs to be cleared. */
4945 sv_del_backref((SV*)GvSTASH(sv), sv);
4950 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4952 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4953 /* Don't even bother with turning off the OOK flag. */
4958 SV *target = SvRV(sv);
4960 sv_del_backref(target, sv);
4962 SvREFCNT_dec(target);
4964 #ifdef PERL_OLD_COPY_ON_WRITE
4965 else if (SvPVX_const(sv)) {
4967 /* I believe I need to grab the global SV mutex here and
4968 then recheck the COW status. */
4970 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4973 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4974 SV_COW_NEXT_SV(sv));
4975 /* And drop it here. */
4977 } else if (SvLEN(sv)) {
4978 Safefree(SvPVX_const(sv));
4982 else if (SvPVX_const(sv) && SvLEN(sv))
4983 Safefree(SvPVX_mutable(sv));
4984 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4985 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4994 SvFLAGS(sv) &= SVf_BREAK;
4995 SvFLAGS(sv) |= SVTYPEMASK;
4997 if (sv_type_details->arena) {
4998 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4999 &PL_body_roots[type]);
5001 else if (sv_type_details->size) {
5002 my_safefree(SvANY(sv));
5007 =for apidoc sv_newref
5009 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5016 Perl_sv_newref(pTHX_ SV *sv)
5026 Decrement an SV's reference count, and if it drops to zero, call
5027 C<sv_clear> to invoke destructors and free up any memory used by
5028 the body; finally, deallocate the SV's head itself.
5029 Normally called via a wrapper macro C<SvREFCNT_dec>.
5035 Perl_sv_free(pTHX_ SV *sv)
5040 if (SvREFCNT(sv) == 0) {
5041 if (SvFLAGS(sv) & SVf_BREAK)
5042 /* this SV's refcnt has been artificially decremented to
5043 * trigger cleanup */
5045 if (PL_in_clean_all) /* All is fair */
5047 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5048 /* make sure SvREFCNT(sv)==0 happens very seldom */
5049 SvREFCNT(sv) = (~(U32)0)/2;
5052 if (ckWARN_d(WARN_INTERNAL)) {
5053 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5054 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5055 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5056 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5057 Perl_dump_sv_child(aTHX_ sv);
5062 if (--(SvREFCNT(sv)) > 0)
5064 Perl_sv_free2(aTHX_ sv);
5068 Perl_sv_free2(pTHX_ SV *sv)
5073 if (ckWARN_d(WARN_DEBUGGING))
5074 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5075 "Attempt to free temp prematurely: SV 0x%"UVxf
5076 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5080 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5081 /* make sure SvREFCNT(sv)==0 happens very seldom */
5082 SvREFCNT(sv) = (~(U32)0)/2;
5093 Returns the length of the string in the SV. Handles magic and type
5094 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5100 Perl_sv_len(pTHX_ register SV *sv)
5108 len = mg_length(sv);
5110 (void)SvPV_const(sv, len);
5115 =for apidoc sv_len_utf8
5117 Returns the number of characters in the string in an SV, counting wide
5118 UTF-8 bytes as a single character. Handles magic and type coercion.
5124 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5125 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5126 * (Note that the mg_len is not the length of the mg_ptr field.)
5131 Perl_sv_len_utf8(pTHX_ register SV *sv)
5137 return mg_length(sv);
5141 const U8 *s = (U8*)SvPV_const(sv, len);
5142 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5144 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5146 #ifdef PERL_UTF8_CACHE_ASSERT
5147 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5151 ulen = Perl_utf8_length(aTHX_ s, s + len);
5152 if (!mg && !SvREADONLY(sv)) {
5153 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5154 mg = mg_find(sv, PERL_MAGIC_utf8);
5164 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5165 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5166 * between UTF-8 and byte offsets. There are two (substr offset and substr
5167 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5168 * and byte offset) cache positions.
5170 * The mg_len field is used by sv_len_utf8(), see its comments.
5171 * Note that the mg_len is not the length of the mg_ptr field.
5175 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5176 I32 offsetp, const U8 *s, const U8 *start)
5180 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5182 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5186 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5188 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5189 (*mgp)->mg_ptr = (char *) *cachep;
5193 (*cachep)[i] = offsetp;
5194 (*cachep)[i+1] = s - start;
5202 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5203 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5204 * between UTF-8 and byte offsets. See also the comments of
5205 * S_utf8_mg_pos_init().
5209 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)
5213 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5215 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5216 if (*mgp && (*mgp)->mg_ptr) {
5217 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5218 ASSERT_UTF8_CACHE(*cachep);
5219 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5221 else { /* We will skip to the right spot. */
5226 /* The assumption is that going backward is half
5227 * the speed of going forward (that's where the
5228 * 2 * backw in the below comes from). (The real
5229 * figure of course depends on the UTF-8 data.) */
5231 if ((*cachep)[i] > (STRLEN)uoff) {
5233 backw = (*cachep)[i] - (STRLEN)uoff;
5235 if (forw < 2 * backw)
5238 p = start + (*cachep)[i+1];
5240 /* Try this only for the substr offset (i == 0),
5241 * not for the substr length (i == 2). */
5242 else if (i == 0) { /* (*cachep)[i] < uoff */
5243 const STRLEN ulen = sv_len_utf8(sv);
5245 if ((STRLEN)uoff < ulen) {
5246 forw = (STRLEN)uoff - (*cachep)[i];
5247 backw = ulen - (STRLEN)uoff;
5249 if (forw < 2 * backw)
5250 p = start + (*cachep)[i+1];
5255 /* If the string is not long enough for uoff,
5256 * we could extend it, but not at this low a level. */
5260 if (forw < 2 * backw) {
5267 while (UTF8_IS_CONTINUATION(*p))
5272 /* Update the cache. */
5273 (*cachep)[i] = (STRLEN)uoff;
5274 (*cachep)[i+1] = p - start;
5276 /* Drop the stale "length" cache */
5285 if (found) { /* Setup the return values. */
5286 *offsetp = (*cachep)[i+1];
5287 *sp = start + *offsetp;
5290 *offsetp = send - start;
5292 else if (*sp < start) {
5298 #ifdef PERL_UTF8_CACHE_ASSERT
5303 while (n-- && s < send)
5307 assert(*offsetp == s - start);
5308 assert((*cachep)[0] == (STRLEN)uoff);
5309 assert((*cachep)[1] == *offsetp);
5311 ASSERT_UTF8_CACHE(*cachep);
5320 =for apidoc sv_pos_u2b
5322 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5323 the start of the string, to a count of the equivalent number of bytes; if
5324 lenp is non-zero, it does the same to lenp, but this time starting from
5325 the offset, rather than from the start of the string. Handles magic and
5332 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5333 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5334 * byte offsets. See also the comments of S_utf8_mg_pos().
5339 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5347 start = (U8*)SvPV_const(sv, len);
5351 const U8 *s = start;
5352 I32 uoffset = *offsetp;
5353 const U8 * const send = s + len;
5357 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
5359 if (!found && uoffset > 0) {
5360 while (s < send && uoffset--)
5364 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5366 *offsetp = s - start;
5371 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5375 if (!found && *lenp > 0) {
5378 while (s < send && ulen--)
5382 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5386 ASSERT_UTF8_CACHE(cache);
5398 =for apidoc sv_pos_b2u
5400 Converts the value pointed to by offsetp from a count of bytes from the
5401 start of the string, to a count of the equivalent number of UTF-8 chars.
5402 Handles magic and type coercion.
5408 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5409 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5410 * byte offsets. See also the comments of S_utf8_mg_pos().
5415 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5423 s = (const U8*)SvPV_const(sv, len);
5424 if ((I32)len < *offsetp)
5425 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5427 const U8* send = s + *offsetp;
5429 STRLEN *cache = NULL;
5433 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5434 mg = mg_find(sv, PERL_MAGIC_utf8);
5435 if (mg && mg->mg_ptr) {
5436 cache = (STRLEN *) mg->mg_ptr;
5437 if (cache[1] == (STRLEN)*offsetp) {
5438 /* An exact match. */
5439 *offsetp = cache[0];
5443 else if (cache[1] < (STRLEN)*offsetp) {
5444 /* We already know part of the way. */
5447 /* Let the below loop do the rest. */
5449 else { /* cache[1] > *offsetp */
5450 /* We already know all of the way, now we may
5451 * be able to walk back. The same assumption
5452 * is made as in S_utf8_mg_pos(), namely that
5453 * walking backward is twice slower than
5454 * walking forward. */
5455 const STRLEN forw = *offsetp;
5456 STRLEN backw = cache[1] - *offsetp;
5458 if (!(forw < 2 * backw)) {
5459 const U8 *p = s + cache[1];
5466 while (UTF8_IS_CONTINUATION(*p)) {
5474 *offsetp = cache[0];
5476 /* Drop the stale "length" cache */
5484 ASSERT_UTF8_CACHE(cache);
5490 /* Call utf8n_to_uvchr() to validate the sequence
5491 * (unless a simple non-UTF character) */
5492 if (!UTF8_IS_INVARIANT(*s))
5493 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5502 if (!SvREADONLY(sv)) {
5504 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5505 mg = mg_find(sv, PERL_MAGIC_utf8);
5510 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5511 mg->mg_ptr = (char *) cache;
5516 cache[1] = *offsetp;
5517 /* Drop the stale "length" cache */
5530 Returns a boolean indicating whether the strings in the two SVs are
5531 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5532 coerce its args to strings if necessary.
5538 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5546 SV* svrecode = Nullsv;
5553 pv1 = SvPV_const(sv1, cur1);
5560 pv2 = SvPV_const(sv2, cur2);
5562 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5563 /* Differing utf8ness.
5564 * Do not UTF8size the comparands as a side-effect. */
5567 svrecode = newSVpvn(pv2, cur2);
5568 sv_recode_to_utf8(svrecode, PL_encoding);
5569 pv2 = SvPV_const(svrecode, cur2);
5572 svrecode = newSVpvn(pv1, cur1);
5573 sv_recode_to_utf8(svrecode, PL_encoding);
5574 pv1 = SvPV_const(svrecode, cur1);
5576 /* Now both are in UTF-8. */
5578 SvREFCNT_dec(svrecode);
5583 bool is_utf8 = TRUE;
5586 /* sv1 is the UTF-8 one,
5587 * if is equal it must be downgrade-able */
5588 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5594 /* sv2 is the UTF-8 one,
5595 * if is equal it must be downgrade-able */
5596 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5602 /* Downgrade not possible - cannot be eq */
5610 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5613 SvREFCNT_dec(svrecode);
5624 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5625 string in C<sv1> is less than, equal to, or greater than the string in
5626 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5627 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5633 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5636 const char *pv1, *pv2;
5639 SV *svrecode = Nullsv;
5646 pv1 = SvPV_const(sv1, cur1);
5653 pv2 = SvPV_const(sv2, cur2);
5655 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5656 /* Differing utf8ness.
5657 * Do not UTF8size the comparands as a side-effect. */
5660 svrecode = newSVpvn(pv2, cur2);
5661 sv_recode_to_utf8(svrecode, PL_encoding);
5662 pv2 = SvPV_const(svrecode, cur2);
5665 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5670 svrecode = newSVpvn(pv1, cur1);
5671 sv_recode_to_utf8(svrecode, PL_encoding);
5672 pv1 = SvPV_const(svrecode, cur1);
5675 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5681 cmp = cur2 ? -1 : 0;
5685 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5688 cmp = retval < 0 ? -1 : 1;
5689 } else if (cur1 == cur2) {
5692 cmp = cur1 < cur2 ? -1 : 1;
5697 SvREFCNT_dec(svrecode);
5706 =for apidoc sv_cmp_locale
5708 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5709 'use bytes' aware, handles get magic, and will coerce its args to strings
5710 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5716 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5718 #ifdef USE_LOCALE_COLLATE
5724 if (PL_collation_standard)
5728 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5730 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5732 if (!pv1 || !len1) {
5743 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5746 return retval < 0 ? -1 : 1;
5749 * When the result of collation is equality, that doesn't mean
5750 * that there are no differences -- some locales exclude some
5751 * characters from consideration. So to avoid false equalities,
5752 * we use the raw string as a tiebreaker.
5758 #endif /* USE_LOCALE_COLLATE */
5760 return sv_cmp(sv1, sv2);
5764 #ifdef USE_LOCALE_COLLATE
5767 =for apidoc sv_collxfrm
5769 Add Collate Transform magic to an SV if it doesn't already have it.
5771 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5772 scalar data of the variable, but transformed to such a format that a normal
5773 memory comparison can be used to compare the data according to the locale
5780 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5784 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5785 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5791 Safefree(mg->mg_ptr);
5792 s = SvPV_const(sv, len);
5793 if ((xf = mem_collxfrm(s, len, &xlen))) {
5794 if (SvREADONLY(sv)) {
5797 return xf + sizeof(PL_collation_ix);
5800 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5801 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5814 if (mg && mg->mg_ptr) {
5816 return mg->mg_ptr + sizeof(PL_collation_ix);
5824 #endif /* USE_LOCALE_COLLATE */
5829 Get a line from the filehandle and store it into the SV, optionally
5830 appending to the currently-stored string.
5836 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5840 register STDCHAR rslast;
5841 register STDCHAR *bp;
5847 if (SvTHINKFIRST(sv))
5848 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5849 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5851 However, perlbench says it's slower, because the existing swipe code
5852 is faster than copy on write.
5853 Swings and roundabouts. */
5854 SvUPGRADE(sv, SVt_PV);
5859 if (PerlIO_isutf8(fp)) {
5861 sv_utf8_upgrade_nomg(sv);
5862 sv_pos_u2b(sv,&append,0);
5864 } else if (SvUTF8(sv)) {
5865 SV * const tsv = NEWSV(0,0);
5866 sv_gets(tsv, fp, 0);
5867 sv_utf8_upgrade_nomg(tsv);
5868 SvCUR_set(sv,append);
5871 goto return_string_or_null;
5876 if (PerlIO_isutf8(fp))
5879 if (IN_PERL_COMPILETIME) {
5880 /* we always read code in line mode */
5884 else if (RsSNARF(PL_rs)) {
5885 /* If it is a regular disk file use size from stat() as estimate
5886 of amount we are going to read - may result in malloc-ing
5887 more memory than we realy need if layers bellow reduce
5888 size we read (e.g. CRLF or a gzip layer)
5891 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5892 const Off_t offset = PerlIO_tell(fp);
5893 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5894 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5900 else if (RsRECORD(PL_rs)) {
5904 /* Grab the size of the record we're getting */
5905 recsize = SvIV(SvRV(PL_rs));
5906 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5909 /* VMS wants read instead of fread, because fread doesn't respect */
5910 /* RMS record boundaries. This is not necessarily a good thing to be */
5911 /* doing, but we've got no other real choice - except avoid stdio
5912 as implementation - perhaps write a :vms layer ?
5914 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5916 bytesread = PerlIO_read(fp, buffer, recsize);
5920 SvCUR_set(sv, bytesread += append);
5921 buffer[bytesread] = '\0';
5922 goto return_string_or_null;
5924 else if (RsPARA(PL_rs)) {
5930 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5931 if (PerlIO_isutf8(fp)) {
5932 rsptr = SvPVutf8(PL_rs, rslen);
5935 if (SvUTF8(PL_rs)) {
5936 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5937 Perl_croak(aTHX_ "Wide character in $/");
5940 rsptr = SvPV_const(PL_rs, rslen);
5944 rslast = rslen ? rsptr[rslen - 1] : '\0';
5946 if (rspara) { /* have to do this both before and after */
5947 do { /* to make sure file boundaries work right */
5950 i = PerlIO_getc(fp);
5954 PerlIO_ungetc(fp,i);
5960 /* See if we know enough about I/O mechanism to cheat it ! */
5962 /* This used to be #ifdef test - it is made run-time test for ease
5963 of abstracting out stdio interface. One call should be cheap
5964 enough here - and may even be a macro allowing compile
5968 if (PerlIO_fast_gets(fp)) {
5971 * We're going to steal some values from the stdio struct
5972 * and put EVERYTHING in the innermost loop into registers.
5974 register STDCHAR *ptr;
5978 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5979 /* An ungetc()d char is handled separately from the regular
5980 * buffer, so we getc() it back out and stuff it in the buffer.
5982 i = PerlIO_getc(fp);
5983 if (i == EOF) return 0;
5984 *(--((*fp)->_ptr)) = (unsigned char) i;
5988 /* Here is some breathtakingly efficient cheating */
5990 cnt = PerlIO_get_cnt(fp); /* get count into register */
5991 /* make sure we have the room */
5992 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5993 /* Not room for all of it
5994 if we are looking for a separator and room for some
5996 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5997 /* just process what we have room for */
5998 shortbuffered = cnt - SvLEN(sv) + append + 1;
5999 cnt -= shortbuffered;
6003 /* remember that cnt can be negative */
6004 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6009 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6010 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6011 DEBUG_P(PerlIO_printf(Perl_debug_log,
6012 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6013 DEBUG_P(PerlIO_printf(Perl_debug_log,
6014 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6015 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6016 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6021 while (cnt > 0) { /* this | eat */
6023 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6024 goto thats_all_folks; /* screams | sed :-) */
6028 Copy(ptr, bp, cnt, char); /* this | eat */
6029 bp += cnt; /* screams | dust */
6030 ptr += cnt; /* louder | sed :-) */
6035 if (shortbuffered) { /* oh well, must extend */
6036 cnt = shortbuffered;
6038 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6040 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6041 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6045 DEBUG_P(PerlIO_printf(Perl_debug_log,
6046 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6047 PTR2UV(ptr),(long)cnt));
6048 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6050 DEBUG_P(PerlIO_printf(Perl_debug_log,
6051 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6052 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6053 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6055 /* This used to call 'filbuf' in stdio form, but as that behaves like
6056 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6057 another abstraction. */
6058 i = PerlIO_getc(fp); /* get more characters */
6060 DEBUG_P(PerlIO_printf(Perl_debug_log,
6061 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6062 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6063 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6065 cnt = PerlIO_get_cnt(fp);
6066 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6067 DEBUG_P(PerlIO_printf(Perl_debug_log,
6068 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6070 if (i == EOF) /* all done for ever? */
6071 goto thats_really_all_folks;
6073 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6075 SvGROW(sv, bpx + cnt + 2);
6076 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6078 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6080 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6081 goto thats_all_folks;
6085 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6086 memNE((char*)bp - rslen, rsptr, rslen))
6087 goto screamer; /* go back to the fray */
6088 thats_really_all_folks:
6090 cnt += shortbuffered;
6091 DEBUG_P(PerlIO_printf(Perl_debug_log,
6092 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6093 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6094 DEBUG_P(PerlIO_printf(Perl_debug_log,
6095 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6096 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6097 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6099 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6100 DEBUG_P(PerlIO_printf(Perl_debug_log,
6101 "Screamer: done, len=%ld, string=|%.*s|\n",
6102 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6106 /*The big, slow, and stupid way. */
6107 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6109 Newx(buf, 8192, STDCHAR);
6117 register const STDCHAR *bpe = buf + sizeof(buf);
6119 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6120 ; /* keep reading */
6124 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6125 /* Accomodate broken VAXC compiler, which applies U8 cast to
6126 * both args of ?: operator, causing EOF to change into 255
6129 i = (U8)buf[cnt - 1];
6135 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6137 sv_catpvn(sv, (char *) buf, cnt);
6139 sv_setpvn(sv, (char *) buf, cnt);
6141 if (i != EOF && /* joy */
6143 SvCUR(sv) < rslen ||
6144 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6148 * If we're reading from a TTY and we get a short read,
6149 * indicating that the user hit his EOF character, we need
6150 * to notice it now, because if we try to read from the TTY
6151 * again, the EOF condition will disappear.
6153 * The comparison of cnt to sizeof(buf) is an optimization
6154 * that prevents unnecessary calls to feof().
6158 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6162 #ifdef USE_HEAP_INSTEAD_OF_STACK
6167 if (rspara) { /* have to do this both before and after */
6168 while (i != EOF) { /* to make sure file boundaries work right */
6169 i = PerlIO_getc(fp);
6171 PerlIO_ungetc(fp,i);
6177 return_string_or_null:
6178 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
6184 Auto-increment of the value in the SV, doing string to numeric conversion
6185 if necessary. Handles 'get' magic.
6191 Perl_sv_inc(pTHX_ register SV *sv)
6199 if (SvTHINKFIRST(sv)) {
6201 sv_force_normal_flags(sv, 0);
6202 if (SvREADONLY(sv)) {
6203 if (IN_PERL_RUNTIME)
6204 Perl_croak(aTHX_ PL_no_modify);
6208 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6210 i = PTR2IV(SvRV(sv));
6215 flags = SvFLAGS(sv);
6216 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6217 /* It's (privately or publicly) a float, but not tested as an
6218 integer, so test it to see. */
6220 flags = SvFLAGS(sv);
6222 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6223 /* It's publicly an integer, or privately an integer-not-float */
6224 #ifdef PERL_PRESERVE_IVUV
6228 if (SvUVX(sv) == UV_MAX)
6229 sv_setnv(sv, UV_MAX_P1);
6231 (void)SvIOK_only_UV(sv);
6232 SvUV_set(sv, SvUVX(sv) + 1);
6234 if (SvIVX(sv) == IV_MAX)
6235 sv_setuv(sv, (UV)IV_MAX + 1);
6237 (void)SvIOK_only(sv);
6238 SvIV_set(sv, SvIVX(sv) + 1);
6243 if (flags & SVp_NOK) {
6244 (void)SvNOK_only(sv);
6245 SvNV_set(sv, SvNVX(sv) + 1.0);
6249 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6250 if ((flags & SVTYPEMASK) < SVt_PVIV)
6251 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6252 (void)SvIOK_only(sv);
6257 while (isALPHA(*d)) d++;
6258 while (isDIGIT(*d)) d++;
6260 #ifdef PERL_PRESERVE_IVUV
6261 /* Got to punt this as an integer if needs be, but we don't issue
6262 warnings. Probably ought to make the sv_iv_please() that does
6263 the conversion if possible, and silently. */
6264 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6265 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6266 /* Need to try really hard to see if it's an integer.
6267 9.22337203685478e+18 is an integer.
6268 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6269 so $a="9.22337203685478e+18"; $a+0; $a++
6270 needs to be the same as $a="9.22337203685478e+18"; $a++
6277 /* sv_2iv *should* have made this an NV */
6278 if (flags & SVp_NOK) {
6279 (void)SvNOK_only(sv);
6280 SvNV_set(sv, SvNVX(sv) + 1.0);
6283 /* I don't think we can get here. Maybe I should assert this
6284 And if we do get here I suspect that sv_setnv will croak. NWC
6286 #if defined(USE_LONG_DOUBLE)
6287 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",
6288 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6290 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6291 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6294 #endif /* PERL_PRESERVE_IVUV */
6295 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6299 while (d >= SvPVX_const(sv)) {
6307 /* MKS: The original code here died if letters weren't consecutive.
6308 * at least it didn't have to worry about non-C locales. The
6309 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6310 * arranged in order (although not consecutively) and that only
6311 * [A-Za-z] are accepted by isALPHA in the C locale.
6313 if (*d != 'z' && *d != 'Z') {
6314 do { ++*d; } while (!isALPHA(*d));
6317 *(d--) -= 'z' - 'a';
6322 *(d--) -= 'z' - 'a' + 1;
6326 /* oh,oh, the number grew */
6327 SvGROW(sv, SvCUR(sv) + 2);
6328 SvCUR_set(sv, SvCUR(sv) + 1);
6329 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6340 Auto-decrement of the value in the SV, doing string to numeric conversion
6341 if necessary. Handles 'get' magic.
6347 Perl_sv_dec(pTHX_ register SV *sv)
6354 if (SvTHINKFIRST(sv)) {
6356 sv_force_normal_flags(sv, 0);
6357 if (SvREADONLY(sv)) {
6358 if (IN_PERL_RUNTIME)
6359 Perl_croak(aTHX_ PL_no_modify);
6363 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6365 i = PTR2IV(SvRV(sv));
6370 /* Unlike sv_inc we don't have to worry about string-never-numbers
6371 and keeping them magic. But we mustn't warn on punting */
6372 flags = SvFLAGS(sv);
6373 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6374 /* It's publicly an integer, or privately an integer-not-float */
6375 #ifdef PERL_PRESERVE_IVUV
6379 if (SvUVX(sv) == 0) {
6380 (void)SvIOK_only(sv);
6384 (void)SvIOK_only_UV(sv);
6385 SvUV_set(sv, SvUVX(sv) - 1);
6388 if (SvIVX(sv) == IV_MIN)
6389 sv_setnv(sv, (NV)IV_MIN - 1.0);
6391 (void)SvIOK_only(sv);
6392 SvIV_set(sv, SvIVX(sv) - 1);
6397 if (flags & SVp_NOK) {
6398 SvNV_set(sv, SvNVX(sv) - 1.0);
6399 (void)SvNOK_only(sv);
6402 if (!(flags & SVp_POK)) {
6403 if ((flags & SVTYPEMASK) < SVt_PVIV)
6404 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6406 (void)SvIOK_only(sv);
6409 #ifdef PERL_PRESERVE_IVUV
6411 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6412 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6413 /* Need to try really hard to see if it's an integer.
6414 9.22337203685478e+18 is an integer.
6415 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6416 so $a="9.22337203685478e+18"; $a+0; $a--
6417 needs to be the same as $a="9.22337203685478e+18"; $a--
6424 /* sv_2iv *should* have made this an NV */
6425 if (flags & SVp_NOK) {
6426 (void)SvNOK_only(sv);
6427 SvNV_set(sv, SvNVX(sv) - 1.0);
6430 /* I don't think we can get here. Maybe I should assert this
6431 And if we do get here I suspect that sv_setnv will croak. NWC
6433 #if defined(USE_LONG_DOUBLE)
6434 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",
6435 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6437 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6438 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6442 #endif /* PERL_PRESERVE_IVUV */
6443 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6447 =for apidoc sv_mortalcopy
6449 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6450 The new SV is marked as mortal. It will be destroyed "soon", either by an
6451 explicit call to FREETMPS, or by an implicit call at places such as
6452 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6457 /* Make a string that will exist for the duration of the expression
6458 * evaluation. Actually, it may have to last longer than that, but
6459 * hopefully we won't free it until it has been assigned to a
6460 * permanent location. */
6463 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6468 sv_setsv(sv,oldstr);
6470 PL_tmps_stack[++PL_tmps_ix] = sv;
6476 =for apidoc sv_newmortal
6478 Creates a new null SV which is mortal. The reference count of the SV is
6479 set to 1. It will be destroyed "soon", either by an explicit call to
6480 FREETMPS, or by an implicit call at places such as statement boundaries.
6481 See also C<sv_mortalcopy> and C<sv_2mortal>.
6487 Perl_sv_newmortal(pTHX)
6492 SvFLAGS(sv) = SVs_TEMP;
6494 PL_tmps_stack[++PL_tmps_ix] = sv;
6499 =for apidoc sv_2mortal
6501 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6502 by an explicit call to FREETMPS, or by an implicit call at places such as
6503 statement boundaries. SvTEMP() is turned on which means that the SV's
6504 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6505 and C<sv_mortalcopy>.
6511 Perl_sv_2mortal(pTHX_ register SV *sv)
6516 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6519 PL_tmps_stack[++PL_tmps_ix] = sv;
6527 Creates a new SV and copies a string into it. The reference count for the
6528 SV is set to 1. If C<len> is zero, Perl will compute the length using
6529 strlen(). For efficiency, consider using C<newSVpvn> instead.
6535 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6540 sv_setpvn(sv,s,len ? len : strlen(s));
6545 =for apidoc newSVpvn
6547 Creates a new SV and copies a string into it. The reference count for the
6548 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6549 string. You are responsible for ensuring that the source string is at least
6550 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6556 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6561 sv_setpvn(sv,s,len);
6567 =for apidoc newSVhek
6569 Creates a new SV from the hash key structure. It will generate scalars that
6570 point to the shared string table where possible. Returns a new (undefined)
6571 SV if the hek is NULL.
6577 Perl_newSVhek(pTHX_ const HEK *hek)
6586 if (HEK_LEN(hek) == HEf_SVKEY) {
6587 return newSVsv(*(SV**)HEK_KEY(hek));
6589 const int flags = HEK_FLAGS(hek);
6590 if (flags & HVhek_WASUTF8) {
6592 Andreas would like keys he put in as utf8 to come back as utf8
6594 STRLEN utf8_len = HEK_LEN(hek);
6595 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6596 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6599 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6601 } else if (flags & HVhek_REHASH) {
6602 /* We don't have a pointer to the hv, so we have to replicate the
6603 flag into every HEK. This hv is using custom a hasing
6604 algorithm. Hence we can't return a shared string scalar, as
6605 that would contain the (wrong) hash value, and might get passed
6606 into an hv routine with a regular hash */
6608 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6613 /* This will be overwhelminly the most common case. */
6614 return newSVpvn_share(HEK_KEY(hek),
6615 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6621 =for apidoc newSVpvn_share
6623 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6624 table. If the string does not already exist in the table, it is created
6625 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6626 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6627 otherwise the hash is computed. The idea here is that as the string table
6628 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6629 hash lookup will avoid string compare.
6635 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6638 bool is_utf8 = FALSE;
6640 STRLEN tmplen = -len;
6642 /* See the note in hv.c:hv_fetch() --jhi */
6643 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6647 PERL_HASH(hash, src, len);
6649 sv_upgrade(sv, SVt_PV);
6650 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6662 #if defined(PERL_IMPLICIT_CONTEXT)
6664 /* pTHX_ magic can't cope with varargs, so this is a no-context
6665 * version of the main function, (which may itself be aliased to us).
6666 * Don't access this version directly.
6670 Perl_newSVpvf_nocontext(const char* pat, ...)
6675 va_start(args, pat);
6676 sv = vnewSVpvf(pat, &args);
6683 =for apidoc newSVpvf
6685 Creates a new SV and initializes it with the string formatted like
6692 Perl_newSVpvf(pTHX_ const char* pat, ...)
6696 va_start(args, pat);
6697 sv = vnewSVpvf(pat, &args);
6702 /* backend for newSVpvf() and newSVpvf_nocontext() */
6705 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6709 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6716 Creates a new SV and copies a floating point value into it.
6717 The reference count for the SV is set to 1.
6723 Perl_newSVnv(pTHX_ NV n)
6735 Creates a new SV and copies an integer into it. The reference count for the
6742 Perl_newSViv(pTHX_ IV i)
6754 Creates a new SV and copies an unsigned integer into it.
6755 The reference count for the SV is set to 1.
6761 Perl_newSVuv(pTHX_ UV u)
6771 =for apidoc newRV_noinc
6773 Creates an RV wrapper for an SV. The reference count for the original
6774 SV is B<not> incremented.
6780 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6785 sv_upgrade(sv, SVt_RV);
6787 SvRV_set(sv, tmpRef);
6792 /* newRV_inc is the official function name to use now.
6793 * newRV_inc is in fact #defined to newRV in sv.h
6797 Perl_newRV(pTHX_ SV *tmpRef)
6799 return newRV_noinc(SvREFCNT_inc(tmpRef));
6805 Creates a new SV which is an exact duplicate of the original SV.
6812 Perl_newSVsv(pTHX_ register SV *old)
6818 if (SvTYPE(old) == SVTYPEMASK) {
6819 if (ckWARN_d(WARN_INTERNAL))
6820 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6824 /* SV_GMAGIC is the default for sv_setv()
6825 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6826 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6827 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6832 =for apidoc sv_reset
6834 Underlying implementation for the C<reset> Perl function.
6835 Note that the perl-level function is vaguely deprecated.
6841 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6844 char todo[PERL_UCHAR_MAX+1];
6849 if (!*s) { /* reset ?? searches */
6850 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6852 PMOP *pm = (PMOP *) mg->mg_obj;
6854 pm->op_pmdynflags &= ~PMdf_USED;
6861 /* reset variables */
6863 if (!HvARRAY(stash))
6866 Zero(todo, 256, char);
6869 I32 i = (unsigned char)*s;
6873 max = (unsigned char)*s++;
6874 for ( ; i <= max; i++) {
6877 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6879 for (entry = HvARRAY(stash)[i];
6881 entry = HeNEXT(entry))
6886 if (!todo[(U8)*HeKEY(entry)])
6888 gv = (GV*)HeVAL(entry);
6891 if (SvTHINKFIRST(sv)) {
6892 if (!SvREADONLY(sv) && SvROK(sv))
6894 /* XXX Is this continue a bug? Why should THINKFIRST
6895 exempt us from resetting arrays and hashes? */
6899 if (SvTYPE(sv) >= SVt_PV) {
6901 if (SvPVX_const(sv) != Nullch)
6909 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6911 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6914 # if defined(USE_ENVIRON_ARRAY)
6917 # endif /* USE_ENVIRON_ARRAY */
6928 Using various gambits, try to get an IO from an SV: the IO slot if its a
6929 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6930 named after the PV if we're a string.
6936 Perl_sv_2io(pTHX_ SV *sv)
6941 switch (SvTYPE(sv)) {
6949 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6953 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6955 return sv_2io(SvRV(sv));
6956 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
6962 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6971 Using various gambits, try to get a CV from an SV; in addition, try if
6972 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6978 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6985 return *gvp = Nullgv, Nullcv;
6986 switch (SvTYPE(sv)) {
7004 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7005 tryAMAGICunDEREF(to_cv);
7008 if (SvTYPE(sv) == SVt_PVCV) {
7017 Perl_croak(aTHX_ "Not a subroutine reference");
7022 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7028 if (lref && !GvCVu(gv)) {
7031 tmpsv = NEWSV(704,0);
7032 gv_efullname3(tmpsv, gv, Nullch);
7033 /* XXX this is probably not what they think they're getting.
7034 * It has the same effect as "sub name;", i.e. just a forward
7036 newSUB(start_subparse(FALSE, 0),
7037 newSVOP(OP_CONST, 0, tmpsv),
7042 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7052 Returns true if the SV has a true value by Perl's rules.
7053 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7054 instead use an in-line version.
7060 Perl_sv_true(pTHX_ register SV *sv)
7065 register const XPV* const tXpv = (XPV*)SvANY(sv);
7067 (tXpv->xpv_cur > 1 ||
7068 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7075 return SvIVX(sv) != 0;
7078 return SvNVX(sv) != 0.0;
7080 return sv_2bool(sv);
7086 =for apidoc sv_pvn_force
7088 Get a sensible string out of the SV somehow.
7089 A private implementation of the C<SvPV_force> macro for compilers which
7090 can't cope with complex macro expressions. Always use the macro instead.
7092 =for apidoc sv_pvn_force_flags
7094 Get a sensible string out of the SV somehow.
7095 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7096 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7097 implemented in terms of this function.
7098 You normally want to use the various wrapper macros instead: see
7099 C<SvPV_force> and C<SvPV_force_nomg>
7105 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7108 if (SvTHINKFIRST(sv) && !SvROK(sv))
7109 sv_force_normal_flags(sv, 0);
7119 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7120 const char * const ref = sv_reftype(sv,0);
7122 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7123 ref, OP_NAME(PL_op));
7125 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7127 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7128 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7130 s = sv_2pv_flags(sv, &len, flags);
7134 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7137 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7138 SvGROW(sv, len + 1);
7139 Move(s,SvPVX(sv),len,char);
7144 SvPOK_on(sv); /* validate pointer */
7146 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7147 PTR2UV(sv),SvPVX_const(sv)));
7150 return SvPVX_mutable(sv);
7154 =for apidoc sv_pvbyten_force
7156 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7162 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7164 sv_pvn_force(sv,lp);
7165 sv_utf8_downgrade(sv,0);
7171 =for apidoc sv_pvutf8n_force
7173 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7179 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7181 sv_pvn_force(sv,lp);
7182 sv_utf8_upgrade(sv);
7188 =for apidoc sv_reftype
7190 Returns a string describing what the SV is a reference to.
7196 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7198 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7199 inside return suggests a const propagation bug in g++. */
7200 if (ob && SvOBJECT(sv)) {
7201 char * const name = HvNAME_get(SvSTASH(sv));
7202 return name ? name : (char *) "__ANON__";
7205 switch (SvTYPE(sv)) {
7222 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7223 /* tied lvalues should appear to be
7224 * scalars for backwards compatitbility */
7225 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7226 ? "SCALAR" : "LVALUE");
7227 case SVt_PVAV: return "ARRAY";
7228 case SVt_PVHV: return "HASH";
7229 case SVt_PVCV: return "CODE";
7230 case SVt_PVGV: return "GLOB";
7231 case SVt_PVFM: return "FORMAT";
7232 case SVt_PVIO: return "IO";
7233 default: return "UNKNOWN";
7239 =for apidoc sv_isobject
7241 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7242 object. If the SV is not an RV, or if the object is not blessed, then this
7249 Perl_sv_isobject(pTHX_ SV *sv)
7265 Returns a boolean indicating whether the SV is blessed into the specified
7266 class. This does not check for subtypes; use C<sv_derived_from> to verify
7267 an inheritance relationship.
7273 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7284 hvname = HvNAME_get(SvSTASH(sv));
7288 return strEQ(hvname, name);
7294 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7295 it will be upgraded to one. If C<classname> is non-null then the new SV will
7296 be blessed in the specified package. The new SV is returned and its
7297 reference count is 1.
7303 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7309 SV_CHECK_THINKFIRST_COW_DROP(rv);
7312 if (SvTYPE(rv) >= SVt_PVMG) {
7313 const U32 refcnt = SvREFCNT(rv);
7317 SvREFCNT(rv) = refcnt;
7320 if (SvTYPE(rv) < SVt_RV)
7321 sv_upgrade(rv, SVt_RV);
7322 else if (SvTYPE(rv) > SVt_RV) {
7333 HV* const stash = gv_stashpv(classname, TRUE);
7334 (void)sv_bless(rv, stash);
7340 =for apidoc sv_setref_pv
7342 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7343 argument will be upgraded to an RV. That RV will be modified to point to
7344 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7345 into the SV. The C<classname> argument indicates the package for the
7346 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7347 will have a reference count of 1, and the RV will be returned.
7349 Do not use with other Perl types such as HV, AV, SV, CV, because those
7350 objects will become corrupted by the pointer copy process.
7352 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7358 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7361 sv_setsv(rv, &PL_sv_undef);
7365 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7370 =for apidoc sv_setref_iv
7372 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7373 argument will be upgraded to an RV. That RV will be modified to point to
7374 the new SV. The C<classname> argument indicates the package for the
7375 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7376 will have a reference count of 1, and the RV will be returned.
7382 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7384 sv_setiv(newSVrv(rv,classname), iv);
7389 =for apidoc sv_setref_uv
7391 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7392 argument will be upgraded to an RV. That RV will be modified to point to
7393 the new SV. The C<classname> argument indicates the package for the
7394 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7395 will have a reference count of 1, and the RV will be returned.
7401 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7403 sv_setuv(newSVrv(rv,classname), uv);
7408 =for apidoc sv_setref_nv
7410 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7411 argument will be upgraded to an RV. That RV will be modified to point to
7412 the new SV. The C<classname> argument indicates the package for the
7413 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7414 will have a reference count of 1, and the RV will be returned.
7420 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7422 sv_setnv(newSVrv(rv,classname), nv);
7427 =for apidoc sv_setref_pvn
7429 Copies a string into a new SV, optionally blessing the SV. The length of the
7430 string must be specified with C<n>. The C<rv> argument will be upgraded to
7431 an RV. That RV will be modified to point to the new SV. The C<classname>
7432 argument indicates the package for the blessing. Set C<classname> to
7433 C<Nullch> to avoid the blessing. The new SV will have a reference count
7434 of 1, and the RV will be returned.
7436 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7442 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7444 sv_setpvn(newSVrv(rv,classname), pv, n);
7449 =for apidoc sv_bless
7451 Blesses an SV into a specified package. The SV must be an RV. The package
7452 must be designated by its stash (see C<gv_stashpv()>). The reference count
7453 of the SV is unaffected.
7459 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7463 Perl_croak(aTHX_ "Can't bless non-reference value");
7465 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7466 if (SvREADONLY(tmpRef))
7467 Perl_croak(aTHX_ PL_no_modify);
7468 if (SvOBJECT(tmpRef)) {
7469 if (SvTYPE(tmpRef) != SVt_PVIO)
7471 SvREFCNT_dec(SvSTASH(tmpRef));
7474 SvOBJECT_on(tmpRef);
7475 if (SvTYPE(tmpRef) != SVt_PVIO)
7477 SvUPGRADE(tmpRef, SVt_PVMG);
7478 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7485 if(SvSMAGICAL(tmpRef))
7486 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7494 /* Downgrades a PVGV to a PVMG.
7498 S_sv_unglob(pTHX_ SV *sv)
7502 assert(SvTYPE(sv) == SVt_PVGV);
7507 sv_del_backref((SV*)GvSTASH(sv), sv);
7508 GvSTASH(sv) = Nullhv;
7510 sv_unmagic(sv, PERL_MAGIC_glob);
7511 Safefree(GvNAME(sv));
7514 /* need to keep SvANY(sv) in the right arena */
7515 xpvmg = new_XPVMG();
7516 StructCopy(SvANY(sv), xpvmg, XPVMG);
7517 del_XPVGV(SvANY(sv));
7520 SvFLAGS(sv) &= ~SVTYPEMASK;
7521 SvFLAGS(sv) |= SVt_PVMG;
7525 =for apidoc sv_unref_flags
7527 Unsets the RV status of the SV, and decrements the reference count of
7528 whatever was being referenced by the RV. This can almost be thought of
7529 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7530 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7531 (otherwise the decrementing is conditional on the reference count being
7532 different from one or the reference being a readonly SV).
7539 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7541 SV* const target = SvRV(ref);
7543 if (SvWEAKREF(ref)) {
7544 sv_del_backref(target, ref);
7546 SvRV_set(ref, NULL);
7549 SvRV_set(ref, NULL);
7551 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7552 assigned to as BEGIN {$a = \"Foo"} will fail. */
7553 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7554 SvREFCNT_dec(target);
7555 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7556 sv_2mortal(target); /* Schedule for freeing later */
7560 =for apidoc sv_untaint
7562 Untaint an SV. Use C<SvTAINTED_off> instead.
7567 Perl_sv_untaint(pTHX_ SV *sv)
7569 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7570 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7577 =for apidoc sv_tainted
7579 Test an SV for taintedness. Use C<SvTAINTED> instead.
7584 Perl_sv_tainted(pTHX_ SV *sv)
7586 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7587 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7588 if (mg && (mg->mg_len & 1) )
7595 =for apidoc sv_setpviv
7597 Copies an integer into the given SV, also updating its string value.
7598 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7604 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7606 char buf[TYPE_CHARS(UV)];
7608 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7610 sv_setpvn(sv, ptr, ebuf - ptr);
7614 =for apidoc sv_setpviv_mg
7616 Like C<sv_setpviv>, but also handles 'set' magic.
7622 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7628 #if defined(PERL_IMPLICIT_CONTEXT)
7630 /* pTHX_ magic can't cope with varargs, so this is a no-context
7631 * version of the main function, (which may itself be aliased to us).
7632 * Don't access this version directly.
7636 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7640 va_start(args, pat);
7641 sv_vsetpvf(sv, pat, &args);
7645 /* pTHX_ magic can't cope with varargs, so this is a no-context
7646 * version of the main function, (which may itself be aliased to us).
7647 * Don't access this version directly.
7651 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7655 va_start(args, pat);
7656 sv_vsetpvf_mg(sv, pat, &args);
7662 =for apidoc sv_setpvf
7664 Works like C<sv_catpvf> but copies the text into the SV instead of
7665 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7671 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7674 va_start(args, pat);
7675 sv_vsetpvf(sv, pat, &args);
7680 =for apidoc sv_vsetpvf
7682 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7683 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7685 Usually used via its frontend C<sv_setpvf>.
7691 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7693 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7697 =for apidoc sv_setpvf_mg
7699 Like C<sv_setpvf>, but also handles 'set' magic.
7705 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7708 va_start(args, pat);
7709 sv_vsetpvf_mg(sv, pat, &args);
7714 =for apidoc sv_vsetpvf_mg
7716 Like C<sv_vsetpvf>, but also handles 'set' magic.
7718 Usually used via its frontend C<sv_setpvf_mg>.
7724 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7726 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7730 #if defined(PERL_IMPLICIT_CONTEXT)
7732 /* pTHX_ magic can't cope with varargs, so this is a no-context
7733 * version of the main function, (which may itself be aliased to us).
7734 * Don't access this version directly.
7738 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7742 va_start(args, pat);
7743 sv_vcatpvf(sv, pat, &args);
7747 /* pTHX_ magic can't cope with varargs, so this is a no-context
7748 * version of the main function, (which may itself be aliased to us).
7749 * Don't access this version directly.
7753 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7757 va_start(args, pat);
7758 sv_vcatpvf_mg(sv, pat, &args);
7764 =for apidoc sv_catpvf
7766 Processes its arguments like C<sprintf> and appends the formatted
7767 output to an SV. If the appended data contains "wide" characters
7768 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7769 and characters >255 formatted with %c), the original SV might get
7770 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7771 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7772 valid UTF-8; if the original SV was bytes, the pattern should be too.
7777 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7780 va_start(args, pat);
7781 sv_vcatpvf(sv, pat, &args);
7786 =for apidoc sv_vcatpvf
7788 Processes its arguments like C<vsprintf> and appends the formatted output
7789 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7791 Usually used via its frontend C<sv_catpvf>.
7797 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7799 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7803 =for apidoc sv_catpvf_mg
7805 Like C<sv_catpvf>, but also handles 'set' magic.
7811 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7814 va_start(args, pat);
7815 sv_vcatpvf_mg(sv, pat, &args);
7820 =for apidoc sv_vcatpvf_mg
7822 Like C<sv_vcatpvf>, but also handles 'set' magic.
7824 Usually used via its frontend C<sv_catpvf_mg>.
7830 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7832 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7837 =for apidoc sv_vsetpvfn
7839 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7842 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7848 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7850 sv_setpvn(sv, "", 0);
7851 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7854 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
7857 S_expect_number(pTHX_ char** pattern)
7860 switch (**pattern) {
7861 case '1': case '2': case '3':
7862 case '4': case '5': case '6':
7863 case '7': case '8': case '9':
7864 while (isDIGIT(**pattern))
7865 var = var * 10 + (*(*pattern)++ - '0');
7869 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
7872 F0convert(NV nv, char *endbuf, STRLEN *len)
7874 const int neg = nv < 0;
7883 if (uv & 1 && uv == nv)
7884 uv--; /* Round to even */
7886 const unsigned dig = uv % 10;
7899 =for apidoc sv_vcatpvfn
7901 Processes its arguments like C<vsprintf> and appends the formatted output
7902 to an SV. Uses an array of SVs if the C style variable argument list is
7903 missing (NULL). When running with taint checks enabled, indicates via
7904 C<maybe_tainted> if results are untrustworthy (often due to the use of
7907 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7913 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7914 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7915 vec_utf8 = DO_UTF8(vecsv);
7917 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7920 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7927 static const char nullstr[] = "(null)";
7929 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7930 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7932 /* Times 4: a decimal digit takes more than 3 binary digits.
7933 * NV_DIG: mantissa takes than many decimal digits.
7934 * Plus 32: Playing safe. */
7935 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7936 /* large enough for "%#.#f" --chip */
7937 /* what about long double NVs? --jhi */
7939 PERL_UNUSED_ARG(maybe_tainted);
7941 /* no matter what, this is a string now */
7942 (void)SvPV_force(sv, origlen);
7944 /* special-case "", "%s", and "%-p" (SVf - see below) */
7947 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7949 const char * const s = va_arg(*args, char*);
7950 sv_catpv(sv, s ? s : nullstr);
7952 else if (svix < svmax) {
7953 sv_catsv(sv, *svargs);
7957 if (args && patlen == 3 && pat[0] == '%' &&
7958 pat[1] == '-' && pat[2] == 'p') {
7959 argsv = va_arg(*args, SV*);
7960 sv_catsv(sv, argsv);
7964 #ifndef USE_LONG_DOUBLE
7965 /* special-case "%.<number>[gf]" */
7966 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7967 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7968 unsigned digits = 0;
7972 while (*pp >= '0' && *pp <= '9')
7973 digits = 10 * digits + (*pp++ - '0');
7974 if (pp - pat == (int)patlen - 1) {
7982 /* Add check for digits != 0 because it seems that some
7983 gconverts are buggy in this case, and we don't yet have
7984 a Configure test for this. */
7985 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
7986 /* 0, point, slack */
7987 Gconvert(nv, (int)digits, 0, ebuf);
7989 if (*ebuf) /* May return an empty string for digits==0 */
7992 } else if (!digits) {
7995 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
7996 sv_catpvn(sv, p, l);
8002 #endif /* !USE_LONG_DOUBLE */
8004 if (!args && svix < svmax && DO_UTF8(*svargs))
8007 patend = (char*)pat + patlen;
8008 for (p = (char*)pat; p < patend; p = q) {
8011 bool vectorize = FALSE;
8012 bool vectorarg = FALSE;
8013 bool vec_utf8 = FALSE;
8019 bool has_precis = FALSE;
8022 bool is_utf8 = FALSE; /* is this item utf8? */
8023 #ifdef HAS_LDBL_SPRINTF_BUG
8024 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8025 with sfio - Allen <allens@cpan.org> */
8026 bool fix_ldbl_sprintf_bug = FALSE;
8030 U8 utf8buf[UTF8_MAXBYTES+1];
8031 STRLEN esignlen = 0;
8033 const char *eptr = Nullch;
8036 const U8 *vecstr = Null(U8*);
8043 /* we need a long double target in case HAS_LONG_DOUBLE but
8046 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8054 const char *dotstr = ".";
8055 STRLEN dotstrlen = 1;
8056 I32 efix = 0; /* explicit format parameter index */
8057 I32 ewix = 0; /* explicit width index */
8058 I32 epix = 0; /* explicit precision index */
8059 I32 evix = 0; /* explicit vector index */
8060 bool asterisk = FALSE;
8062 /* echo everything up to the next format specification */
8063 for (q = p; q < patend && *q != '%'; ++q) ;
8065 if (has_utf8 && !pat_utf8)
8066 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8068 sv_catpvn(sv, p, q - p);
8075 We allow format specification elements in this order:
8076 \d+\$ explicit format parameter index
8078 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8079 0 flag (as above): repeated to allow "v02"
8080 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8081 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8083 [%bcdefginopsuxDFOUX] format (mandatory)
8088 As of perl5.9.3, printf format checking is on by default.
8089 Internally, perl uses %p formats to provide an escape to
8090 some extended formatting. This block deals with those
8091 extensions: if it does not match, (char*)q is reset and
8092 the normal format processing code is used.
8094 Currently defined extensions are:
8095 %p include pointer address (standard)
8096 %-p (SVf) include an SV (previously %_)
8097 %-<num>p include an SV with precision <num>
8098 %1p (VDf) include a v-string (as %vd)
8099 %<num>p reserved for future extensions
8101 Robin Barker 2005-07-14
8108 EXPECT_NUMBER(q, n);
8115 argsv = va_arg(*args, SV*);
8116 eptr = SvPVx_const(argsv, elen);
8122 else if (n == vdNUMBER) { /* VDf */
8129 if (ckWARN_d(WARN_INTERNAL))
8130 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8131 "internal %%<num>p might conflict with future printf extensions");
8137 if (EXPECT_NUMBER(q, width)) {
8178 if (EXPECT_NUMBER(q, ewix))
8187 if ((vectorarg = asterisk)) {
8200 EXPECT_NUMBER(q, width);
8206 vecsv = va_arg(*args, SV*);
8208 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8209 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
8210 dotstr = SvPV_const(vecsv, dotstrlen);
8217 else if (efix ? efix <= svmax : svix < svmax) {
8218 vecsv = svargs[efix ? efix-1 : svix++];
8219 vecstr = (U8*)SvPV_const(vecsv,veclen);
8220 vec_utf8 = DO_UTF8(vecsv);
8221 /* if this is a version object, we need to return the
8222 * stringified representation (which the SvPVX_const has
8223 * already done for us), but not vectorize the args
8225 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
8227 q++; /* skip past the rest of the %vd format */
8228 eptr = (const char *) vecstr;
8242 i = va_arg(*args, int);
8244 i = (ewix ? ewix <= svmax : svix < svmax) ?
8245 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8247 width = (i < 0) ? -i : i;
8257 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8259 /* XXX: todo, support specified precision parameter */
8263 i = va_arg(*args, int);
8265 i = (ewix ? ewix <= svmax : svix < svmax)
8266 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8267 precis = (i < 0) ? 0 : i;
8272 precis = precis * 10 + (*q++ - '0');
8281 case 'I': /* Ix, I32x, and I64x */
8283 if (q[1] == '6' && q[2] == '4') {
8289 if (q[1] == '3' && q[2] == '2') {
8299 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8310 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8311 if (*(q + 1) == 'l') { /* lld, llf */
8337 const I32 i = efix-1;
8338 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8340 argsv = (svix >= 0 && svix < svmax)
8341 ? svargs[svix++] : &PL_sv_undef;
8350 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
8352 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8354 eptr = (char*)utf8buf;
8355 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8366 if (args && !vectorize) {
8367 eptr = va_arg(*args, char*);
8369 #ifdef MACOS_TRADITIONAL
8370 /* On MacOS, %#s format is used for Pascal strings */
8375 elen = strlen(eptr);
8377 eptr = (char *)nullstr;
8378 elen = sizeof nullstr - 1;
8382 eptr = SvPVx_const(argsv, elen);
8383 if (DO_UTF8(argsv)) {
8384 if (has_precis && precis < elen) {
8386 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8389 if (width) { /* fudge width (can't fudge elen) */
8390 width += elen - sv_len_utf8(argsv);
8398 if (has_precis && elen > precis)
8405 if (alt || vectorize)
8407 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8428 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8437 esignbuf[esignlen++] = plus;
8441 case 'h': iv = (short)va_arg(*args, int); break;
8442 case 'l': iv = va_arg(*args, long); break;
8443 case 'V': iv = va_arg(*args, IV); break;
8444 default: iv = va_arg(*args, int); break;
8446 case 'q': iv = va_arg(*args, Quad_t); break;
8451 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8453 case 'h': iv = (short)tiv; break;
8454 case 'l': iv = (long)tiv; break;
8456 default: iv = tiv; break;
8458 case 'q': iv = (Quad_t)tiv; break;
8462 if ( !vectorize ) /* we already set uv above */
8467 esignbuf[esignlen++] = plus;
8471 esignbuf[esignlen++] = '-';
8514 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8525 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8526 case 'l': uv = va_arg(*args, unsigned long); break;
8527 case 'V': uv = va_arg(*args, UV); break;
8528 default: uv = va_arg(*args, unsigned); break;
8530 case 'q': uv = va_arg(*args, Uquad_t); break;
8535 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8537 case 'h': uv = (unsigned short)tuv; break;
8538 case 'l': uv = (unsigned long)tuv; break;
8540 default: uv = tuv; break;
8542 case 'q': uv = (Uquad_t)tuv; break;
8549 char *ptr = ebuf + sizeof ebuf;
8555 p = (char*)((c == 'X')
8556 ? "0123456789ABCDEF" : "0123456789abcdef");
8562 esignbuf[esignlen++] = '0';
8563 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8571 if (alt && *ptr != '0')
8582 esignbuf[esignlen++] = '0';
8583 esignbuf[esignlen++] = 'b';
8586 default: /* it had better be ten or less */
8590 } while (uv /= base);
8593 elen = (ebuf + sizeof ebuf) - ptr;
8597 zeros = precis - elen;
8598 else if (precis == 0 && elen == 1 && *eptr == '0')
8604 /* FLOATING POINT */
8607 c = 'f'; /* maybe %F isn't supported here */
8613 /* This is evil, but floating point is even more evil */
8615 /* for SV-style calling, we can only get NV
8616 for C-style calling, we assume %f is double;
8617 for simplicity we allow any of %Lf, %llf, %qf for long double
8621 #if defined(USE_LONG_DOUBLE)
8625 /* [perl #20339] - we should accept and ignore %lf rather than die */
8629 #if defined(USE_LONG_DOUBLE)
8630 intsize = args ? 0 : 'q';
8634 #if defined(HAS_LONG_DOUBLE)
8643 /* now we need (long double) if intsize == 'q', else (double) */
8644 nv = (args && !vectorize) ?
8645 #if LONG_DOUBLESIZE > DOUBLESIZE
8647 va_arg(*args, long double) :
8648 va_arg(*args, double)
8650 va_arg(*args, double)
8656 if (c != 'e' && c != 'E') {
8658 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8659 will cast our (long double) to (double) */
8660 (void)Perl_frexp(nv, &i);
8661 if (i == PERL_INT_MIN)
8662 Perl_die(aTHX_ "panic: frexp");
8664 need = BIT_DIGITS(i);
8666 need += has_precis ? precis : 6; /* known default */
8671 #ifdef HAS_LDBL_SPRINTF_BUG
8672 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8673 with sfio - Allen <allens@cpan.org> */
8676 # define MY_DBL_MAX DBL_MAX
8677 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8678 # if DOUBLESIZE >= 8
8679 # define MY_DBL_MAX 1.7976931348623157E+308L
8681 # define MY_DBL_MAX 3.40282347E+38L
8685 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8686 # define MY_DBL_MAX_BUG 1L
8688 # define MY_DBL_MAX_BUG MY_DBL_MAX
8692 # define MY_DBL_MIN DBL_MIN
8693 # else /* XXX guessing! -Allen */
8694 # if DOUBLESIZE >= 8
8695 # define MY_DBL_MIN 2.2250738585072014E-308L
8697 # define MY_DBL_MIN 1.17549435E-38L
8701 if ((intsize == 'q') && (c == 'f') &&
8702 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8704 /* it's going to be short enough that
8705 * long double precision is not needed */
8707 if ((nv <= 0L) && (nv >= -0L))
8708 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8710 /* would use Perl_fp_class as a double-check but not
8711 * functional on IRIX - see perl.h comments */
8713 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8714 /* It's within the range that a double can represent */
8715 #if defined(DBL_MAX) && !defined(DBL_MIN)
8716 if ((nv >= ((long double)1/DBL_MAX)) ||
8717 (nv <= (-(long double)1/DBL_MAX)))
8719 fix_ldbl_sprintf_bug = TRUE;
8722 if (fix_ldbl_sprintf_bug == TRUE) {
8732 # undef MY_DBL_MAX_BUG
8735 #endif /* HAS_LDBL_SPRINTF_BUG */
8737 need += 20; /* fudge factor */
8738 if (PL_efloatsize < need) {
8739 Safefree(PL_efloatbuf);
8740 PL_efloatsize = need + 20; /* more fudge */
8741 Newx(PL_efloatbuf, PL_efloatsize, char);
8742 PL_efloatbuf[0] = '\0';
8745 if ( !(width || left || plus || alt) && fill != '0'
8746 && has_precis && intsize != 'q' ) { /* Shortcuts */
8747 /* See earlier comment about buggy Gconvert when digits,
8749 if ( c == 'g' && precis) {
8750 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8751 /* May return an empty string for digits==0 */
8752 if (*PL_efloatbuf) {
8753 elen = strlen(PL_efloatbuf);
8754 goto float_converted;
8756 } else if ( c == 'f' && !precis) {
8757 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8762 char *ptr = ebuf + sizeof ebuf;
8765 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8766 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8767 if (intsize == 'q') {
8768 /* Copy the one or more characters in a long double
8769 * format before the 'base' ([efgEFG]) character to
8770 * the format string. */
8771 static char const prifldbl[] = PERL_PRIfldbl;
8772 char const *p = prifldbl + sizeof(prifldbl) - 3;
8773 while (p >= prifldbl) { *--ptr = *p--; }
8778 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8783 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8795 /* No taint. Otherwise we are in the strange situation
8796 * where printf() taints but print($float) doesn't.
8798 #if defined(HAS_LONG_DOUBLE)
8799 elen = ((intsize == 'q')
8800 ? my_sprintf(PL_efloatbuf, ptr, nv)
8801 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8803 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8807 eptr = PL_efloatbuf;
8813 i = SvCUR(sv) - origlen;
8814 if (args && !vectorize) {
8816 case 'h': *(va_arg(*args, short*)) = i; break;
8817 default: *(va_arg(*args, int*)) = i; break;
8818 case 'l': *(va_arg(*args, long*)) = i; break;
8819 case 'V': *(va_arg(*args, IV*)) = i; break;
8821 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8826 sv_setuv_mg(argsv, (UV)i);
8828 continue; /* not "break" */
8835 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8836 && ckWARN(WARN_PRINTF))
8838 SV * const msg = sv_newmortal();
8839 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8840 (PL_op->op_type == OP_PRTF) ? "" : "s");
8843 Perl_sv_catpvf(aTHX_ msg,
8844 "\"%%%c\"", c & 0xFF);
8846 Perl_sv_catpvf(aTHX_ msg,
8847 "\"%%\\%03"UVof"\"",
8850 sv_catpv(msg, "end of string");
8851 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8854 /* output mangled stuff ... */
8860 /* ... right here, because formatting flags should not apply */
8861 SvGROW(sv, SvCUR(sv) + elen + 1);
8863 Copy(eptr, p, elen, char);
8866 SvCUR_set(sv, p - SvPVX_const(sv));
8868 continue; /* not "break" */
8871 /* calculate width before utf8_upgrade changes it */
8872 have = esignlen + zeros + elen;
8874 Perl_croak_nocontext(PL_memory_wrap);
8876 if (is_utf8 != has_utf8) {
8879 sv_utf8_upgrade(sv);
8882 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8883 sv_utf8_upgrade(nsv);
8884 eptr = SvPVX_const(nsv);
8887 SvGROW(sv, SvCUR(sv) + elen + 1);
8892 need = (have > width ? have : width);
8895 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8896 Perl_croak_nocontext(PL_memory_wrap);
8897 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8899 if (esignlen && fill == '0') {
8901 for (i = 0; i < (int)esignlen; i++)
8905 memset(p, fill, gap);
8908 if (esignlen && fill != '0') {
8910 for (i = 0; i < (int)esignlen; i++)
8915 for (i = zeros; i; i--)
8919 Copy(eptr, p, elen, char);
8923 memset(p, ' ', gap);
8928 Copy(dotstr, p, dotstrlen, char);
8932 vectorize = FALSE; /* done iterating over vecstr */
8939 SvCUR_set(sv, p - SvPVX_const(sv));
8947 /* =========================================================================
8949 =head1 Cloning an interpreter
8951 All the macros and functions in this section are for the private use of
8952 the main function, perl_clone().
8954 The foo_dup() functions make an exact copy of an existing foo thinngy.
8955 During the course of a cloning, a hash table is used to map old addresses
8956 to new addresses. The table is created and manipulated with the
8957 ptr_table_* functions.
8961 ============================================================================*/
8964 #if defined(USE_ITHREADS)
8966 #ifndef GpREFCNT_inc
8967 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
8971 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8972 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
8973 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8974 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
8975 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8976 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
8977 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8978 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
8979 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
8980 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
8981 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8982 #define SAVEPV(p) (p ? savepv(p) : Nullch)
8983 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8986 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
8987 regcomp.c. AMS 20010712 */
8990 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
8995 struct reg_substr_datum *s;
8998 return (REGEXP *)NULL;
9000 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9003 len = r->offsets[0];
9004 npar = r->nparens+1;
9006 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9007 Copy(r->program, ret->program, len+1, regnode);
9009 Newx(ret->startp, npar, I32);
9010 Copy(r->startp, ret->startp, npar, I32);
9011 Newx(ret->endp, npar, I32);
9012 Copy(r->startp, ret->startp, npar, I32);
9014 Newx(ret->substrs, 1, struct reg_substr_data);
9015 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9016 s->min_offset = r->substrs->data[i].min_offset;
9017 s->max_offset = r->substrs->data[i].max_offset;
9018 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9019 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9022 ret->regstclass = NULL;
9025 const int count = r->data->count;
9028 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9029 char, struct reg_data);
9030 Newx(d->what, count, U8);
9033 for (i = 0; i < count; i++) {
9034 d->what[i] = r->data->what[i];
9035 switch (d->what[i]) {
9036 /* legal options are one of: sfpont
9037 see also regcomp.h and pregfree() */
9039 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9042 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9045 /* This is cheating. */
9046 Newx(d->data[i], 1, struct regnode_charclass_class);
9047 StructCopy(r->data->data[i], d->data[i],
9048 struct regnode_charclass_class);
9049 ret->regstclass = (regnode*)d->data[i];
9052 /* Compiled op trees are readonly, and can thus be
9053 shared without duplication. */
9055 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9059 d->data[i] = r->data->data[i];
9062 d->data[i] = r->data->data[i];
9064 ((reg_trie_data*)d->data[i])->refcount++;
9068 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9077 Newx(ret->offsets, 2*len+1, U32);
9078 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9080 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9081 ret->refcnt = r->refcnt;
9082 ret->minlen = r->minlen;
9083 ret->prelen = r->prelen;
9084 ret->nparens = r->nparens;
9085 ret->lastparen = r->lastparen;
9086 ret->lastcloseparen = r->lastcloseparen;
9087 ret->reganch = r->reganch;
9089 ret->sublen = r->sublen;
9091 if (RX_MATCH_COPIED(ret))
9092 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9094 ret->subbeg = Nullch;
9095 #ifdef PERL_OLD_COPY_ON_WRITE
9096 ret->saved_copy = Nullsv;
9099 ptr_table_store(PL_ptr_table, r, ret);
9103 /* duplicate a file handle */
9106 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9110 PERL_UNUSED_ARG(type);
9113 return (PerlIO*)NULL;
9115 /* look for it in the table first */
9116 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9120 /* create anew and remember what it is */
9121 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9122 ptr_table_store(PL_ptr_table, fp, ret);
9126 /* duplicate a directory handle */
9129 Perl_dirp_dup(pTHX_ DIR *dp)
9137 /* duplicate a typeglob */
9140 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9145 /* look for it in the table first */
9146 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9150 /* create anew and remember what it is */
9152 ptr_table_store(PL_ptr_table, gp, ret);
9155 ret->gp_refcnt = 0; /* must be before any other dups! */
9156 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9157 ret->gp_io = io_dup_inc(gp->gp_io, param);
9158 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9159 ret->gp_av = av_dup_inc(gp->gp_av, param);
9160 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9161 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9162 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9163 ret->gp_cvgen = gp->gp_cvgen;
9164 ret->gp_line = gp->gp_line;
9165 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9169 /* duplicate a chain of magic */
9172 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9174 MAGIC *mgprev = (MAGIC*)NULL;
9177 return (MAGIC*)NULL;
9178 /* look for it in the table first */
9179 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9183 for (; mg; mg = mg->mg_moremagic) {
9185 Newxz(nmg, 1, MAGIC);
9187 mgprev->mg_moremagic = nmg;
9190 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9191 nmg->mg_private = mg->mg_private;
9192 nmg->mg_type = mg->mg_type;
9193 nmg->mg_flags = mg->mg_flags;
9194 if (mg->mg_type == PERL_MAGIC_qr) {
9195 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9197 else if(mg->mg_type == PERL_MAGIC_backref) {
9198 const AV * const av = (AV*) mg->mg_obj;
9201 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
9203 for (i = AvFILLp(av); i >= 0; i--) {
9204 if (!svp[i]) continue;
9205 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9208 else if (mg->mg_type == PERL_MAGIC_symtab) {
9209 nmg->mg_obj = mg->mg_obj;
9212 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9213 ? sv_dup_inc(mg->mg_obj, param)
9214 : sv_dup(mg->mg_obj, param);
9216 nmg->mg_len = mg->mg_len;
9217 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9218 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9219 if (mg->mg_len > 0) {
9220 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9221 if (mg->mg_type == PERL_MAGIC_overload_table &&
9222 AMT_AMAGIC((AMT*)mg->mg_ptr))
9224 AMT * const amtp = (AMT*)mg->mg_ptr;
9225 AMT * const namtp = (AMT*)nmg->mg_ptr;
9227 for (i = 1; i < NofAMmeth; i++) {
9228 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9232 else if (mg->mg_len == HEf_SVKEY)
9233 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9235 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9236 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9243 /* create a new pointer-mapping table */
9246 Perl_ptr_table_new(pTHX)
9249 Newxz(tbl, 1, PTR_TBL_t);
9252 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9257 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
9259 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
9263 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9264 following define) and at call to new_body_inline made below in
9265 Perl_ptr_table_store()
9268 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9270 /* map an existing pointer using a table */
9273 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9275 PTR_TBL_ENT_t *tblent;
9276 const UV hash = PTR_TABLE_HASH(sv);
9278 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9279 for (; tblent; tblent = tblent->next) {
9280 if (tblent->oldval == sv)
9281 return tblent->newval;
9286 /* add a new entry to a pointer-mapping table */
9289 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9291 PTR_TBL_ENT_t *tblent, **otblent;
9292 /* XXX this may be pessimal on platforms where pointers aren't good
9293 * hash values e.g. if they grow faster in the most significant
9295 const UV hash = PTR_TABLE_HASH(oldsv);
9299 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9300 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
9301 if (tblent->oldval == oldsv) {
9302 tblent->newval = newsv;
9306 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9307 tblent->oldval = oldsv;
9308 tblent->newval = newsv;
9309 tblent->next = *otblent;
9312 if (!empty && tbl->tbl_items > tbl->tbl_max)
9313 ptr_table_split(tbl);
9316 /* double the hash bucket size of an existing ptr table */
9319 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9321 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9322 const UV oldsize = tbl->tbl_max + 1;
9323 UV newsize = oldsize * 2;
9326 Renew(ary, newsize, PTR_TBL_ENT_t*);
9327 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9328 tbl->tbl_max = --newsize;
9330 for (i=0; i < oldsize; i++, ary++) {
9331 PTR_TBL_ENT_t **curentp, **entp, *ent;
9334 curentp = ary + oldsize;
9335 for (entp = ary, ent = *ary; ent; ent = *entp) {
9336 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9338 ent->next = *curentp;
9348 /* remove all the entries from a ptr table */
9351 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9353 register PTR_TBL_ENT_t **array;
9354 register PTR_TBL_ENT_t *entry;
9358 if (!tbl || !tbl->tbl_items) {
9362 array = tbl->tbl_ary;
9368 PTR_TBL_ENT_t *oentry = entry;
9369 entry = entry->next;
9373 if (++riter > max) {
9376 entry = array[riter];
9383 /* clear and free a ptr table */
9386 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9391 ptr_table_clear(tbl);
9392 Safefree(tbl->tbl_ary);
9398 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9401 SvRV_set(dstr, SvWEAKREF(sstr)
9402 ? sv_dup(SvRV(sstr), param)
9403 : sv_dup_inc(SvRV(sstr), param));
9406 else if (SvPVX_const(sstr)) {
9407 /* Has something there */
9409 /* Normal PV - clone whole allocated space */
9410 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9411 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9412 /* Not that normal - actually sstr is copy on write.
9413 But we are a true, independant SV, so: */
9414 SvREADONLY_off(dstr);
9419 /* Special case - not normally malloced for some reason */
9420 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9421 /* A "shared" PV - clone it as "shared" PV */
9423 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9427 /* Some other special case - random pointer */
9428 SvPV_set(dstr, SvPVX(sstr));
9434 if (SvTYPE(dstr) == SVt_RV)
9435 SvRV_set(dstr, NULL);
9441 /* duplicate an SV of any type (including AV, HV etc) */
9444 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
9449 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9451 /* look for it in the table first */
9452 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9456 if(param->flags & CLONEf_JOIN_IN) {
9457 /** We are joining here so we don't want do clone
9458 something that is bad **/
9461 if(SvTYPE(sstr) == SVt_PVHV &&
9462 (hvname = HvNAME_get(sstr))) {
9463 /** don't clone stashes if they already exist **/
9464 return (SV*)gv_stashpv(hvname,0);
9468 /* create anew and remember what it is */
9471 #ifdef DEBUG_LEAKING_SCALARS
9472 dstr->sv_debug_optype = sstr->sv_debug_optype;
9473 dstr->sv_debug_line = sstr->sv_debug_line;
9474 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9475 dstr->sv_debug_cloned = 1;
9477 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9479 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
9483 ptr_table_store(PL_ptr_table, sstr, dstr);
9486 SvFLAGS(dstr) = SvFLAGS(sstr);
9487 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9488 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9491 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9492 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9493 PL_watch_pvx, SvPVX_const(sstr));
9496 /* don't clone objects whose class has asked us not to */
9497 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9498 SvFLAGS(dstr) &= ~SVTYPEMASK;
9503 switch (SvTYPE(sstr)) {
9508 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9509 SvIV_set(dstr, SvIVX(sstr));
9512 SvANY(dstr) = new_XNV();
9513 SvNV_set(dstr, SvNVX(sstr));
9516 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9517 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9521 /* These are all the types that need complex bodies allocating. */
9523 const svtype sv_type = SvTYPE(sstr);
9524 const struct body_details *const sv_type_details
9525 = bodies_by_type + sv_type;
9529 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9534 if (GvUNIQUE((GV*)sstr)) {
9535 /* Do sharing here, and fall through */
9548 assert(sv_type_details->copy);
9549 if (sv_type_details->arena) {
9550 new_body_inline(new_body, sv_type_details->copy, sv_type);
9552 = (void*)((char*)new_body - sv_type_details->offset);
9554 new_body = new_NOARENA(sv_type_details);
9558 SvANY(dstr) = new_body;
9561 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9562 ((char*)SvANY(dstr)) + sv_type_details->offset,
9563 sv_type_details->copy, char);
9565 Copy(((char*)SvANY(sstr)),
9566 ((char*)SvANY(dstr)),
9567 sv_type_details->size + sv_type_details->offset, char);
9570 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9571 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9573 /* The Copy above means that all the source (unduplicated) pointers
9574 are now in the destination. We can check the flags and the
9575 pointers in either, but it's possible that there's less cache
9576 missing by always going for the destination.
9577 FIXME - instrument and check that assumption */
9578 if (sv_type >= SVt_PVMG) {
9580 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9582 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9585 /* The cast silences a GCC warning about unhandled types. */
9586 switch ((int)sv_type) {
9598 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9599 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9600 LvTARG(dstr) = dstr;
9601 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9602 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9604 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9607 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9608 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9609 /* Don't call sv_add_backref here as it's going to be created
9610 as part of the magic cloning of the symbol table. */
9611 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9612 (void)GpREFCNT_inc(GvGP(dstr));
9615 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9616 if (IoOFP(dstr) == IoIFP(sstr))
9617 IoOFP(dstr) = IoIFP(dstr);
9619 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9620 /* PL_rsfp_filters entries have fake IoDIRP() */
9621 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9622 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9623 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9624 /* I have no idea why fake dirp (rsfps)
9625 should be treated differently but otherwise
9626 we end up with leaks -- sky*/
9627 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9628 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9629 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9631 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9632 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9633 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9635 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9636 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9637 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9640 if (AvARRAY((AV*)sstr)) {
9641 SV **dst_ary, **src_ary;
9642 SSize_t items = AvFILLp((AV*)sstr) + 1;
9644 src_ary = AvARRAY((AV*)sstr);
9645 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9646 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9647 SvPV_set(dstr, (char*)dst_ary);
9648 AvALLOC((AV*)dstr) = dst_ary;
9649 if (AvREAL((AV*)sstr)) {
9651 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9655 *dst_ary++ = sv_dup(*src_ary++, param);
9657 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9658 while (items-- > 0) {
9659 *dst_ary++ = &PL_sv_undef;
9663 SvPV_set(dstr, Nullch);
9664 AvALLOC((AV*)dstr) = (SV**)NULL;
9671 if (HvARRAY((HV*)sstr)) {
9673 const bool sharekeys = !!HvSHAREKEYS(sstr);
9674 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9675 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9677 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9678 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9680 HvARRAY(dstr) = (HE**)darray;
9681 while (i <= sxhv->xhv_max) {
9682 const HE *source = HvARRAY(sstr)[i];
9683 HvARRAY(dstr)[i] = source
9684 ? he_dup(source, sharekeys, param) : 0;
9688 struct xpvhv_aux *saux = HvAUX(sstr);
9689 struct xpvhv_aux *daux = HvAUX(dstr);
9690 /* This flag isn't copied. */
9691 /* SvOOK_on(hv) attacks the IV flags. */
9692 SvFLAGS(dstr) |= SVf_OOK;
9694 hvname = saux->xhv_name;
9696 = hvname ? hek_dup(hvname, param) : hvname;
9698 daux->xhv_riter = saux->xhv_riter;
9699 daux->xhv_eiter = saux->xhv_eiter
9700 ? he_dup(saux->xhv_eiter,
9701 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9705 SvPV_set(dstr, Nullch);
9707 /* Record stashes for possible cloning in Perl_clone(). */
9709 av_push(param->stashes, dstr);
9714 /* NOTE: not refcounted */
9715 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9717 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9719 if (CvCONST(dstr)) {
9720 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9721 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9722 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9724 /* don't dup if copying back - CvGV isn't refcounted, so the
9725 * duped GV may never be freed. A bit of a hack! DAPM */
9726 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9727 Nullgv : gv_dup(CvGV(dstr), param) ;
9728 if (!(param->flags & CLONEf_COPY_STACKS)) {
9731 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9734 ? cv_dup( CvOUTSIDE(dstr), param)
9735 : cv_dup_inc(CvOUTSIDE(dstr), param);
9737 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9743 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9749 /* duplicate a context */
9752 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9757 return (PERL_CONTEXT*)NULL;
9759 /* look for it in the table first */
9760 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9764 /* create anew and remember what it is */
9765 Newxz(ncxs, max + 1, PERL_CONTEXT);
9766 ptr_table_store(PL_ptr_table, cxs, ncxs);
9769 PERL_CONTEXT *cx = &cxs[ix];
9770 PERL_CONTEXT *ncx = &ncxs[ix];
9771 ncx->cx_type = cx->cx_type;
9772 if (CxTYPE(cx) == CXt_SUBST) {
9773 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9776 ncx->blk_oldsp = cx->blk_oldsp;
9777 ncx->blk_oldcop = cx->blk_oldcop;
9778 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9779 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9780 ncx->blk_oldpm = cx->blk_oldpm;
9781 ncx->blk_gimme = cx->blk_gimme;
9782 switch (CxTYPE(cx)) {
9784 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9785 ? cv_dup_inc(cx->blk_sub.cv, param)
9786 : cv_dup(cx->blk_sub.cv,param));
9787 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9788 ? av_dup_inc(cx->blk_sub.argarray, param)
9790 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9791 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9792 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9793 ncx->blk_sub.lval = cx->blk_sub.lval;
9794 ncx->blk_sub.retop = cx->blk_sub.retop;
9797 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9798 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9799 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9800 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9801 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9802 ncx->blk_eval.retop = cx->blk_eval.retop;
9805 ncx->blk_loop.label = cx->blk_loop.label;
9806 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9807 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9808 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9809 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9810 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9811 ? cx->blk_loop.iterdata
9812 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9813 ncx->blk_loop.oldcomppad
9814 = (PAD*)ptr_table_fetch(PL_ptr_table,
9815 cx->blk_loop.oldcomppad);
9816 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9817 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9818 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9819 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9820 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9823 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9824 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9825 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9826 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9827 ncx->blk_sub.retop = cx->blk_sub.retop;
9839 /* duplicate a stack info structure */
9842 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9847 return (PERL_SI*)NULL;
9849 /* look for it in the table first */
9850 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9854 /* create anew and remember what it is */
9855 Newxz(nsi, 1, PERL_SI);
9856 ptr_table_store(PL_ptr_table, si, nsi);
9858 nsi->si_stack = av_dup_inc(si->si_stack, param);
9859 nsi->si_cxix = si->si_cxix;
9860 nsi->si_cxmax = si->si_cxmax;
9861 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9862 nsi->si_type = si->si_type;
9863 nsi->si_prev = si_dup(si->si_prev, param);
9864 nsi->si_next = si_dup(si->si_next, param);
9865 nsi->si_markoff = si->si_markoff;
9870 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9871 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9872 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9873 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9874 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9875 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9876 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9877 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9878 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9879 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9880 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9881 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9882 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9883 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9886 #define pv_dup_inc(p) SAVEPV(p)
9887 #define pv_dup(p) SAVEPV(p)
9888 #define svp_dup_inc(p,pp) any_dup(p,pp)
9890 /* map any object to the new equivent - either something in the
9891 * ptr table, or something in the interpreter structure
9895 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9902 /* look for it in the table first */
9903 ret = ptr_table_fetch(PL_ptr_table, v);
9907 /* see if it is part of the interpreter structure */
9908 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9909 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9917 /* duplicate the save stack */
9920 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9922 ANY * const ss = proto_perl->Tsavestack;
9923 const I32 max = proto_perl->Tsavestack_max;
9924 I32 ix = proto_perl->Tsavestack_ix;
9936 void (*dptr) (void*);
9937 void (*dxptr) (pTHX_ void*);
9939 Newxz(nss, max, ANY);
9942 I32 i = POPINT(ss,ix);
9945 case SAVEt_ITEM: /* normal string */
9946 sv = (SV*)POPPTR(ss,ix);
9947 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9948 sv = (SV*)POPPTR(ss,ix);
9949 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9951 case SAVEt_SV: /* scalar reference */
9952 sv = (SV*)POPPTR(ss,ix);
9953 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9954 gv = (GV*)POPPTR(ss,ix);
9955 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9957 case SAVEt_GENERIC_PVREF: /* generic char* */
9958 c = (char*)POPPTR(ss,ix);
9959 TOPPTR(nss,ix) = pv_dup(c);
9960 ptr = POPPTR(ss,ix);
9961 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9963 case SAVEt_SHARED_PVREF: /* char* in shared space */
9964 c = (char*)POPPTR(ss,ix);
9965 TOPPTR(nss,ix) = savesharedpv(c);
9966 ptr = POPPTR(ss,ix);
9967 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9969 case SAVEt_GENERIC_SVREF: /* generic sv */
9970 case SAVEt_SVREF: /* scalar reference */
9971 sv = (SV*)POPPTR(ss,ix);
9972 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9973 ptr = POPPTR(ss,ix);
9974 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
9976 case SAVEt_AV: /* array reference */
9977 av = (AV*)POPPTR(ss,ix);
9978 TOPPTR(nss,ix) = av_dup_inc(av, param);
9979 gv = (GV*)POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = gv_dup(gv, param);
9982 case SAVEt_HV: /* hash reference */
9983 hv = (HV*)POPPTR(ss,ix);
9984 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
9985 gv = (GV*)POPPTR(ss,ix);
9986 TOPPTR(nss,ix) = gv_dup(gv, param);
9988 case SAVEt_INT: /* int reference */
9989 ptr = POPPTR(ss,ix);
9990 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9991 intval = (int)POPINT(ss,ix);
9992 TOPINT(nss,ix) = intval;
9994 case SAVEt_LONG: /* long reference */
9995 ptr = POPPTR(ss,ix);
9996 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9997 longval = (long)POPLONG(ss,ix);
9998 TOPLONG(nss,ix) = longval;
10000 case SAVEt_I32: /* I32 reference */
10001 case SAVEt_I16: /* I16 reference */
10002 case SAVEt_I8: /* I8 reference */
10003 ptr = POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10006 TOPINT(nss,ix) = i;
10008 case SAVEt_IV: /* IV reference */
10009 ptr = POPPTR(ss,ix);
10010 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10012 TOPIV(nss,ix) = iv;
10014 case SAVEt_SPTR: /* SV* reference */
10015 ptr = POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10017 sv = (SV*)POPPTR(ss,ix);
10018 TOPPTR(nss,ix) = sv_dup(sv, param);
10020 case SAVEt_VPTR: /* random* reference */
10021 ptr = POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10023 ptr = POPPTR(ss,ix);
10024 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10026 case SAVEt_PPTR: /* char* reference */
10027 ptr = POPPTR(ss,ix);
10028 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10029 c = (char*)POPPTR(ss,ix);
10030 TOPPTR(nss,ix) = pv_dup(c);
10032 case SAVEt_HPTR: /* HV* reference */
10033 ptr = POPPTR(ss,ix);
10034 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10035 hv = (HV*)POPPTR(ss,ix);
10036 TOPPTR(nss,ix) = hv_dup(hv, param);
10038 case SAVEt_APTR: /* AV* reference */
10039 ptr = POPPTR(ss,ix);
10040 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10041 av = (AV*)POPPTR(ss,ix);
10042 TOPPTR(nss,ix) = av_dup(av, param);
10045 gv = (GV*)POPPTR(ss,ix);
10046 TOPPTR(nss,ix) = gv_dup(gv, param);
10048 case SAVEt_GP: /* scalar reference */
10049 gp = (GP*)POPPTR(ss,ix);
10050 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10051 (void)GpREFCNT_inc(gp);
10052 gv = (GV*)POPPTR(ss,ix);
10053 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10054 c = (char*)POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = pv_dup(c);
10057 TOPIV(nss,ix) = iv;
10059 TOPIV(nss,ix) = iv;
10062 case SAVEt_MORTALIZESV:
10063 sv = (SV*)POPPTR(ss,ix);
10064 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10067 ptr = POPPTR(ss,ix);
10068 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10069 /* these are assumed to be refcounted properly */
10071 switch (((OP*)ptr)->op_type) {
10073 case OP_LEAVESUBLV:
10077 case OP_LEAVEWRITE:
10078 TOPPTR(nss,ix) = ptr;
10083 TOPPTR(nss,ix) = Nullop;
10088 TOPPTR(nss,ix) = Nullop;
10091 c = (char*)POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = pv_dup_inc(c);
10094 case SAVEt_CLEARSV:
10095 longval = POPLONG(ss,ix);
10096 TOPLONG(nss,ix) = longval;
10099 hv = (HV*)POPPTR(ss,ix);
10100 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10101 c = (char*)POPPTR(ss,ix);
10102 TOPPTR(nss,ix) = pv_dup_inc(c);
10104 TOPINT(nss,ix) = i;
10106 case SAVEt_DESTRUCTOR:
10107 ptr = POPPTR(ss,ix);
10108 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10109 dptr = POPDPTR(ss,ix);
10110 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10111 any_dup(FPTR2DPTR(void *, dptr),
10114 case SAVEt_DESTRUCTOR_X:
10115 ptr = POPPTR(ss,ix);
10116 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10117 dxptr = POPDXPTR(ss,ix);
10118 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10119 any_dup(FPTR2DPTR(void *, dxptr),
10122 case SAVEt_REGCONTEXT:
10125 TOPINT(nss,ix) = i;
10128 case SAVEt_STACK_POS: /* Position on Perl stack */
10130 TOPINT(nss,ix) = i;
10132 case SAVEt_AELEM: /* array element */
10133 sv = (SV*)POPPTR(ss,ix);
10134 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10136 TOPINT(nss,ix) = i;
10137 av = (AV*)POPPTR(ss,ix);
10138 TOPPTR(nss,ix) = av_dup_inc(av, param);
10140 case SAVEt_HELEM: /* hash element */
10141 sv = (SV*)POPPTR(ss,ix);
10142 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10143 sv = (SV*)POPPTR(ss,ix);
10144 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10145 hv = (HV*)POPPTR(ss,ix);
10146 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = ptr;
10154 TOPINT(nss,ix) = i;
10156 case SAVEt_COMPPAD:
10157 av = (AV*)POPPTR(ss,ix);
10158 TOPPTR(nss,ix) = av_dup(av, param);
10161 longval = (long)POPLONG(ss,ix);
10162 TOPLONG(nss,ix) = longval;
10163 ptr = POPPTR(ss,ix);
10164 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10165 sv = (SV*)POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = sv_dup(sv, param);
10169 ptr = POPPTR(ss,ix);
10170 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10171 longval = (long)POPBOOL(ss,ix);
10172 TOPBOOL(nss,ix) = (bool)longval;
10174 case SAVEt_SET_SVFLAGS:
10176 TOPINT(nss,ix) = i;
10178 TOPINT(nss,ix) = i;
10179 sv = (SV*)POPPTR(ss,ix);
10180 TOPPTR(nss,ix) = sv_dup(sv, param);
10183 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10191 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10192 * flag to the result. This is done for each stash before cloning starts,
10193 * so we know which stashes want their objects cloned */
10196 do_mark_cloneable_stash(pTHX_ SV *sv)
10198 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10200 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10201 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10202 if (cloner && GvCV(cloner)) {
10209 XPUSHs(sv_2mortal(newSVhek(hvname)));
10211 call_sv((SV*)GvCV(cloner), G_SCALAR);
10218 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10226 =for apidoc perl_clone
10228 Create and return a new interpreter by cloning the current one.
10230 perl_clone takes these flags as parameters:
10232 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10233 without it we only clone the data and zero the stacks,
10234 with it we copy the stacks and the new perl interpreter is
10235 ready to run at the exact same point as the previous one.
10236 The pseudo-fork code uses COPY_STACKS while the
10237 threads->new doesn't.
10239 CLONEf_KEEP_PTR_TABLE
10240 perl_clone keeps a ptr_table with the pointer of the old
10241 variable as a key and the new variable as a value,
10242 this allows it to check if something has been cloned and not
10243 clone it again but rather just use the value and increase the
10244 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10245 the ptr_table using the function
10246 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10247 reason to keep it around is if you want to dup some of your own
10248 variable who are outside the graph perl scans, example of this
10249 code is in threads.xs create
10252 This is a win32 thing, it is ignored on unix, it tells perls
10253 win32host code (which is c++) to clone itself, this is needed on
10254 win32 if you want to run two threads at the same time,
10255 if you just want to do some stuff in a separate perl interpreter
10256 and then throw it away and return to the original one,
10257 you don't need to do anything.
10262 /* XXX the above needs expanding by someone who actually understands it ! */
10263 EXTERN_C PerlInterpreter *
10264 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10267 perl_clone(PerlInterpreter *proto_perl, UV flags)
10270 #ifdef PERL_IMPLICIT_SYS
10272 /* perlhost.h so we need to call into it
10273 to clone the host, CPerlHost should have a c interface, sky */
10275 if (flags & CLONEf_CLONE_HOST) {
10276 return perl_clone_host(proto_perl,flags);
10278 return perl_clone_using(proto_perl, flags,
10280 proto_perl->IMemShared,
10281 proto_perl->IMemParse,
10283 proto_perl->IStdIO,
10287 proto_perl->IProc);
10291 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10292 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10293 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10294 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10295 struct IPerlDir* ipD, struct IPerlSock* ipS,
10296 struct IPerlProc* ipP)
10298 /* XXX many of the string copies here can be optimized if they're
10299 * constants; they need to be allocated as common memory and just
10300 * their pointers copied. */
10303 CLONE_PARAMS clone_params;
10304 CLONE_PARAMS* param = &clone_params;
10306 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10307 /* for each stash, determine whether its objects should be cloned */
10308 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10309 PERL_SET_THX(my_perl);
10312 Poison(my_perl, 1, PerlInterpreter);
10314 PL_curcop = (COP *)Nullop;
10318 PL_savestack_ix = 0;
10319 PL_savestack_max = -1;
10320 PL_sig_pending = 0;
10321 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10322 # else /* !DEBUGGING */
10323 Zero(my_perl, 1, PerlInterpreter);
10324 # endif /* DEBUGGING */
10326 /* host pointers */
10328 PL_MemShared = ipMS;
10329 PL_MemParse = ipMP;
10336 #else /* !PERL_IMPLICIT_SYS */
10338 CLONE_PARAMS clone_params;
10339 CLONE_PARAMS* param = &clone_params;
10340 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10341 /* for each stash, determine whether its objects should be cloned */
10342 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10343 PERL_SET_THX(my_perl);
10346 Poison(my_perl, 1, PerlInterpreter);
10348 PL_curcop = (COP *)Nullop;
10352 PL_savestack_ix = 0;
10353 PL_savestack_max = -1;
10354 PL_sig_pending = 0;
10355 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10356 # else /* !DEBUGGING */
10357 Zero(my_perl, 1, PerlInterpreter);
10358 # endif /* DEBUGGING */
10359 #endif /* PERL_IMPLICIT_SYS */
10360 param->flags = flags;
10361 param->proto_perl = proto_perl;
10363 Zero(&PL_body_arenaroots, 1, PL_body_arenaroots);
10364 Zero(&PL_body_roots, 1, PL_body_roots);
10366 PL_nice_chunk = NULL;
10367 PL_nice_chunk_size = 0;
10369 PL_sv_objcount = 0;
10370 PL_sv_root = Nullsv;
10371 PL_sv_arenaroot = Nullsv;
10373 PL_debug = proto_perl->Idebug;
10375 PL_hash_seed = proto_perl->Ihash_seed;
10376 PL_rehash_seed = proto_perl->Irehash_seed;
10378 #ifdef USE_REENTRANT_API
10379 /* XXX: things like -Dm will segfault here in perlio, but doing
10380 * PERL_SET_CONTEXT(proto_perl);
10381 * breaks too many other things
10383 Perl_reentrant_init(aTHX);
10386 /* create SV map for pointer relocation */
10387 PL_ptr_table = ptr_table_new();
10389 /* initialize these special pointers as early as possible */
10390 SvANY(&PL_sv_undef) = NULL;
10391 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10392 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10393 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10395 SvANY(&PL_sv_no) = new_XPVNV();
10396 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10397 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10398 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10399 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10400 SvCUR_set(&PL_sv_no, 0);
10401 SvLEN_set(&PL_sv_no, 1);
10402 SvIV_set(&PL_sv_no, 0);
10403 SvNV_set(&PL_sv_no, 0);
10404 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10406 SvANY(&PL_sv_yes) = new_XPVNV();
10407 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10408 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10409 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10410 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10411 SvCUR_set(&PL_sv_yes, 1);
10412 SvLEN_set(&PL_sv_yes, 2);
10413 SvIV_set(&PL_sv_yes, 1);
10414 SvNV_set(&PL_sv_yes, 1);
10415 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10417 /* create (a non-shared!) shared string table */
10418 PL_strtab = newHV();
10419 HvSHAREKEYS_off(PL_strtab);
10420 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10421 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10423 PL_compiling = proto_perl->Icompiling;
10425 /* These two PVs will be free'd special way so must set them same way op.c does */
10426 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10427 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10429 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10430 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10432 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10433 if (!specialWARN(PL_compiling.cop_warnings))
10434 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10435 if (!specialCopIO(PL_compiling.cop_io))
10436 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10437 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10439 /* pseudo environmental stuff */
10440 PL_origargc = proto_perl->Iorigargc;
10441 PL_origargv = proto_perl->Iorigargv;
10443 param->stashes = newAV(); /* Setup array of objects to call clone on */
10445 /* Set tainting stuff before PerlIO_debug can possibly get called */
10446 PL_tainting = proto_perl->Itainting;
10447 PL_taint_warn = proto_perl->Itaint_warn;
10449 #ifdef PERLIO_LAYERS
10450 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10451 PerlIO_clone(aTHX_ proto_perl, param);
10454 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10455 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10456 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10457 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10458 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10459 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10462 PL_minus_c = proto_perl->Iminus_c;
10463 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10464 PL_localpatches = proto_perl->Ilocalpatches;
10465 PL_splitstr = proto_perl->Isplitstr;
10466 PL_preprocess = proto_perl->Ipreprocess;
10467 PL_minus_n = proto_perl->Iminus_n;
10468 PL_minus_p = proto_perl->Iminus_p;
10469 PL_minus_l = proto_perl->Iminus_l;
10470 PL_minus_a = proto_perl->Iminus_a;
10471 PL_minus_F = proto_perl->Iminus_F;
10472 PL_doswitches = proto_perl->Idoswitches;
10473 PL_dowarn = proto_perl->Idowarn;
10474 PL_doextract = proto_perl->Idoextract;
10475 PL_sawampersand = proto_perl->Isawampersand;
10476 PL_unsafe = proto_perl->Iunsafe;
10477 PL_inplace = SAVEPV(proto_perl->Iinplace);
10478 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10479 PL_perldb = proto_perl->Iperldb;
10480 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10481 PL_exit_flags = proto_perl->Iexit_flags;
10483 /* magical thingies */
10484 /* XXX time(&PL_basetime) when asked for? */
10485 PL_basetime = proto_perl->Ibasetime;
10486 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10488 PL_maxsysfd = proto_perl->Imaxsysfd;
10489 PL_multiline = proto_perl->Imultiline;
10490 PL_statusvalue = proto_perl->Istatusvalue;
10492 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10494 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10496 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10498 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10499 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10500 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10502 /* Clone the regex array */
10503 PL_regex_padav = newAV();
10505 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10506 SV** const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10508 av_push(PL_regex_padav,
10509 sv_dup_inc(regexen[0],param));
10510 for(i = 1; i <= len; i++) {
10511 if(SvREPADTMP(regexen[i])) {
10512 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
10514 av_push(PL_regex_padav,
10516 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
10517 SvIVX(regexen[i])), param)))
10522 PL_regex_pad = AvARRAY(PL_regex_padav);
10524 /* shortcuts to various I/O objects */
10525 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10526 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10527 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10528 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10529 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10530 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10532 /* shortcuts to regexp stuff */
10533 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10535 /* shortcuts to misc objects */
10536 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10538 /* shortcuts to debugging objects */
10539 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10540 PL_DBline = gv_dup(proto_perl->IDBline, param);
10541 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10542 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10543 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10544 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10545 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10546 PL_lineary = av_dup(proto_perl->Ilineary, param);
10547 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10549 /* symbol tables */
10550 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10551 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10552 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10553 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10554 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10556 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10557 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10558 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10559 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10560 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10561 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10563 PL_sub_generation = proto_perl->Isub_generation;
10565 /* funky return mechanisms */
10566 PL_forkprocess = proto_perl->Iforkprocess;
10568 /* subprocess state */
10569 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10571 /* internal state */
10572 PL_maxo = proto_perl->Imaxo;
10573 if (proto_perl->Iop_mask)
10574 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10576 PL_op_mask = Nullch;
10577 /* PL_asserting = proto_perl->Iasserting; */
10579 /* current interpreter roots */
10580 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10581 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10582 PL_main_start = proto_perl->Imain_start;
10583 PL_eval_root = proto_perl->Ieval_root;
10584 PL_eval_start = proto_perl->Ieval_start;
10586 /* runtime control stuff */
10587 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10588 PL_copline = proto_perl->Icopline;
10590 PL_filemode = proto_perl->Ifilemode;
10591 PL_lastfd = proto_perl->Ilastfd;
10592 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10595 PL_gensym = proto_perl->Igensym;
10596 PL_preambled = proto_perl->Ipreambled;
10597 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10598 PL_laststatval = proto_perl->Ilaststatval;
10599 PL_laststype = proto_perl->Ilaststype;
10600 PL_mess_sv = Nullsv;
10602 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10604 /* interpreter atexit processing */
10605 PL_exitlistlen = proto_perl->Iexitlistlen;
10606 if (PL_exitlistlen) {
10607 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10608 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10611 PL_exitlist = (PerlExitListEntry*)NULL;
10612 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10613 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10614 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10616 PL_profiledata = NULL;
10617 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10618 /* PL_rsfp_filters entries have fake IoDIRP() */
10619 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10621 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10623 PAD_CLONE_VARS(proto_perl, param);
10625 #ifdef HAVE_INTERP_INTERN
10626 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10629 /* more statics moved here */
10630 PL_generation = proto_perl->Igeneration;
10631 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10633 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10634 PL_in_clean_all = proto_perl->Iin_clean_all;
10636 PL_uid = proto_perl->Iuid;
10637 PL_euid = proto_perl->Ieuid;
10638 PL_gid = proto_perl->Igid;
10639 PL_egid = proto_perl->Iegid;
10640 PL_nomemok = proto_perl->Inomemok;
10641 PL_an = proto_perl->Ian;
10642 PL_evalseq = proto_perl->Ievalseq;
10643 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10644 PL_origalen = proto_perl->Iorigalen;
10645 #ifdef PERL_USES_PL_PIDSTATUS
10646 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10648 PL_osname = SAVEPV(proto_perl->Iosname);
10649 PL_sighandlerp = proto_perl->Isighandlerp;
10651 PL_runops = proto_perl->Irunops;
10653 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10656 PL_cshlen = proto_perl->Icshlen;
10657 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10660 PL_lex_state = proto_perl->Ilex_state;
10661 PL_lex_defer = proto_perl->Ilex_defer;
10662 PL_lex_expect = proto_perl->Ilex_expect;
10663 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10664 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10665 PL_lex_starts = proto_perl->Ilex_starts;
10666 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10667 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10668 PL_lex_op = proto_perl->Ilex_op;
10669 PL_lex_inpat = proto_perl->Ilex_inpat;
10670 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10671 PL_lex_brackets = proto_perl->Ilex_brackets;
10672 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10673 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10674 PL_lex_casemods = proto_perl->Ilex_casemods;
10675 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10676 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10678 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10679 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10680 PL_nexttoke = proto_perl->Inexttoke;
10682 /* XXX This is probably masking the deeper issue of why
10683 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10684 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10685 * (A little debugging with a watchpoint on it may help.)
10687 if (SvANY(proto_perl->Ilinestr)) {
10688 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10689 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10690 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10691 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10692 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10693 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10694 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10695 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10696 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10699 PL_linestr = NEWSV(65,79);
10700 sv_upgrade(PL_linestr,SVt_PVIV);
10701 sv_setpvn(PL_linestr,"",0);
10702 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10704 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10705 PL_pending_ident = proto_perl->Ipending_ident;
10706 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10708 PL_expect = proto_perl->Iexpect;
10710 PL_multi_start = proto_perl->Imulti_start;
10711 PL_multi_end = proto_perl->Imulti_end;
10712 PL_multi_open = proto_perl->Imulti_open;
10713 PL_multi_close = proto_perl->Imulti_close;
10715 PL_error_count = proto_perl->Ierror_count;
10716 PL_subline = proto_perl->Isubline;
10717 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10719 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10720 if (SvANY(proto_perl->Ilinestr)) {
10721 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10722 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10723 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10724 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10725 PL_last_lop_op = proto_perl->Ilast_lop_op;
10728 PL_last_uni = SvPVX(PL_linestr);
10729 PL_last_lop = SvPVX(PL_linestr);
10730 PL_last_lop_op = 0;
10732 PL_in_my = proto_perl->Iin_my;
10733 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10735 PL_cryptseen = proto_perl->Icryptseen;
10738 PL_hints = proto_perl->Ihints;
10740 PL_amagic_generation = proto_perl->Iamagic_generation;
10742 #ifdef USE_LOCALE_COLLATE
10743 PL_collation_ix = proto_perl->Icollation_ix;
10744 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10745 PL_collation_standard = proto_perl->Icollation_standard;
10746 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10747 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10748 #endif /* USE_LOCALE_COLLATE */
10750 #ifdef USE_LOCALE_NUMERIC
10751 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10752 PL_numeric_standard = proto_perl->Inumeric_standard;
10753 PL_numeric_local = proto_perl->Inumeric_local;
10754 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10755 #endif /* !USE_LOCALE_NUMERIC */
10757 /* utf8 character classes */
10758 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10759 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10760 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10761 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10762 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10763 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10764 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10765 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10766 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10767 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10768 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10769 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10770 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10771 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10772 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10773 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10774 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10775 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10776 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10777 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10779 /* Did the locale setup indicate UTF-8? */
10780 PL_utf8locale = proto_perl->Iutf8locale;
10781 /* Unicode features (see perlrun/-C) */
10782 PL_unicode = proto_perl->Iunicode;
10784 /* Pre-5.8 signals control */
10785 PL_signals = proto_perl->Isignals;
10787 /* times() ticks per second */
10788 PL_clocktick = proto_perl->Iclocktick;
10790 /* Recursion stopper for PerlIO_find_layer */
10791 PL_in_load_module = proto_perl->Iin_load_module;
10793 /* sort() routine */
10794 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10796 /* Not really needed/useful since the reenrant_retint is "volatile",
10797 * but do it for consistency's sake. */
10798 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10800 /* Hooks to shared SVs and locks. */
10801 PL_sharehook = proto_perl->Isharehook;
10802 PL_lockhook = proto_perl->Ilockhook;
10803 PL_unlockhook = proto_perl->Iunlockhook;
10804 PL_threadhook = proto_perl->Ithreadhook;
10806 PL_runops_std = proto_perl->Irunops_std;
10807 PL_runops_dbg = proto_perl->Irunops_dbg;
10809 #ifdef THREADS_HAVE_PIDS
10810 PL_ppid = proto_perl->Ippid;
10814 PL_last_swash_hv = Nullhv; /* reinits on demand */
10815 PL_last_swash_klen = 0;
10816 PL_last_swash_key[0]= '\0';
10817 PL_last_swash_tmps = (U8*)NULL;
10818 PL_last_swash_slen = 0;
10820 PL_glob_index = proto_perl->Iglob_index;
10821 PL_srand_called = proto_perl->Isrand_called;
10822 PL_uudmap['M'] = 0; /* reinits on demand */
10823 PL_bitcount = Nullch; /* reinits on demand */
10825 if (proto_perl->Ipsig_pend) {
10826 Newxz(PL_psig_pend, SIG_SIZE, int);
10829 PL_psig_pend = (int*)NULL;
10832 if (proto_perl->Ipsig_ptr) {
10833 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10834 Newxz(PL_psig_name, SIG_SIZE, SV*);
10835 for (i = 1; i < SIG_SIZE; i++) {
10836 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10837 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10841 PL_psig_ptr = (SV**)NULL;
10842 PL_psig_name = (SV**)NULL;
10845 /* thrdvar.h stuff */
10847 if (flags & CLONEf_COPY_STACKS) {
10848 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10849 PL_tmps_ix = proto_perl->Ttmps_ix;
10850 PL_tmps_max = proto_perl->Ttmps_max;
10851 PL_tmps_floor = proto_perl->Ttmps_floor;
10852 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10854 while (i <= PL_tmps_ix) {
10855 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10859 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10860 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10861 Newxz(PL_markstack, i, I32);
10862 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10863 - proto_perl->Tmarkstack);
10864 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10865 - proto_perl->Tmarkstack);
10866 Copy(proto_perl->Tmarkstack, PL_markstack,
10867 PL_markstack_ptr - PL_markstack + 1, I32);
10869 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10870 * NOTE: unlike the others! */
10871 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10872 PL_scopestack_max = proto_perl->Tscopestack_max;
10873 Newxz(PL_scopestack, PL_scopestack_max, I32);
10874 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10876 /* NOTE: si_dup() looks at PL_markstack */
10877 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10879 /* PL_curstack = PL_curstackinfo->si_stack; */
10880 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10881 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10883 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10884 PL_stack_base = AvARRAY(PL_curstack);
10885 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10886 - proto_perl->Tstack_base);
10887 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10889 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10890 * NOTE: unlike the others! */
10891 PL_savestack_ix = proto_perl->Tsavestack_ix;
10892 PL_savestack_max = proto_perl->Tsavestack_max;
10893 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10894 PL_savestack = ss_dup(proto_perl, param);
10898 ENTER; /* perl_destruct() wants to LEAVE; */
10901 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10902 PL_top_env = &PL_start_env;
10904 PL_op = proto_perl->Top;
10907 PL_Xpv = (XPV*)NULL;
10908 PL_na = proto_perl->Tna;
10910 PL_statbuf = proto_perl->Tstatbuf;
10911 PL_statcache = proto_perl->Tstatcache;
10912 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10913 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10915 PL_timesbuf = proto_perl->Ttimesbuf;
10918 PL_tainted = proto_perl->Ttainted;
10919 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10920 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10921 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10922 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10923 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10924 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10925 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10926 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10927 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10929 PL_restartop = proto_perl->Trestartop;
10930 PL_in_eval = proto_perl->Tin_eval;
10931 PL_delaymagic = proto_perl->Tdelaymagic;
10932 PL_dirty = proto_perl->Tdirty;
10933 PL_localizing = proto_perl->Tlocalizing;
10935 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10936 PL_hv_fetch_ent_mh = Nullhe;
10937 PL_modcount = proto_perl->Tmodcount;
10938 PL_lastgotoprobe = Nullop;
10939 PL_dumpindent = proto_perl->Tdumpindent;
10941 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10942 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10943 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10944 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10945 PL_efloatbuf = Nullch; /* reinits on demand */
10946 PL_efloatsize = 0; /* reinits on demand */
10950 PL_screamfirst = NULL;
10951 PL_screamnext = NULL;
10952 PL_maxscream = -1; /* reinits on demand */
10953 PL_lastscream = Nullsv;
10955 PL_watchaddr = NULL;
10956 PL_watchok = Nullch;
10958 PL_regdummy = proto_perl->Tregdummy;
10959 PL_regprecomp = Nullch;
10962 PL_colorset = 0; /* reinits PL_colors[] */
10963 /*PL_colors[6] = {0,0,0,0,0,0};*/
10964 PL_reginput = Nullch;
10965 PL_regbol = Nullch;
10966 PL_regeol = Nullch;
10967 PL_regstartp = (I32*)NULL;
10968 PL_regendp = (I32*)NULL;
10969 PL_reglastparen = (U32*)NULL;
10970 PL_reglastcloseparen = (U32*)NULL;
10971 PL_regtill = Nullch;
10972 PL_reg_start_tmp = (char**)NULL;
10973 PL_reg_start_tmpl = 0;
10974 PL_regdata = (struct reg_data*)NULL;
10977 PL_reg_eval_set = 0;
10979 PL_regprogram = (regnode*)NULL;
10981 PL_regcc = (CURCUR*)NULL;
10982 PL_reg_call_cc = (struct re_cc_state*)NULL;
10983 PL_reg_re = (regexp*)NULL;
10984 PL_reg_ganch = Nullch;
10985 PL_reg_sv = Nullsv;
10986 PL_reg_match_utf8 = FALSE;
10987 PL_reg_magic = (MAGIC*)NULL;
10989 PL_reg_oldcurpm = (PMOP*)NULL;
10990 PL_reg_curpm = (PMOP*)NULL;
10991 PL_reg_oldsaved = Nullch;
10992 PL_reg_oldsavedlen = 0;
10993 #ifdef PERL_OLD_COPY_ON_WRITE
10996 PL_reg_maxiter = 0;
10997 PL_reg_leftiter = 0;
10998 PL_reg_poscache = Nullch;
10999 PL_reg_poscache_size= 0;
11001 /* RE engine - function pointers */
11002 PL_regcompp = proto_perl->Tregcompp;
11003 PL_regexecp = proto_perl->Tregexecp;
11004 PL_regint_start = proto_perl->Tregint_start;
11005 PL_regint_string = proto_perl->Tregint_string;
11006 PL_regfree = proto_perl->Tregfree;
11008 PL_reginterp_cnt = 0;
11009 PL_reg_starttry = 0;
11011 /* Pluggable optimizer */
11012 PL_peepp = proto_perl->Tpeepp;
11014 PL_stashcache = newHV();
11016 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11017 ptr_table_free(PL_ptr_table);
11018 PL_ptr_table = NULL;
11021 /* Call the ->CLONE method, if it exists, for each of the stashes
11022 identified by sv_dup() above.
11024 while(av_len(param->stashes) != -1) {
11025 HV* const stash = (HV*) av_shift(param->stashes);
11026 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11027 if (cloner && GvCV(cloner)) {
11032 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11034 call_sv((SV*)GvCV(cloner), G_DISCARD);
11040 SvREFCNT_dec(param->stashes);
11042 /* orphaned? eg threads->new inside BEGIN or use */
11043 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11044 (void)SvREFCNT_inc(PL_compcv);
11045 SAVEFREESV(PL_compcv);
11051 #endif /* USE_ITHREADS */
11054 =head1 Unicode Support
11056 =for apidoc sv_recode_to_utf8
11058 The encoding is assumed to be an Encode object, on entry the PV
11059 of the sv is assumed to be octets in that encoding, and the sv
11060 will be converted into Unicode (and UTF-8).
11062 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11063 is not a reference, nothing is done to the sv. If the encoding is not
11064 an C<Encode::XS> Encoding object, bad things will happen.
11065 (See F<lib/encoding.pm> and L<Encode>).
11067 The PV of the sv is returned.
11072 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11075 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11089 Passing sv_yes is wrong - it needs to be or'ed set of constants
11090 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11091 remove converted chars from source.
11093 Both will default the value - let them.
11095 XPUSHs(&PL_sv_yes);
11098 call_method("decode", G_SCALAR);
11102 s = SvPV_const(uni, len);
11103 if (s != SvPVX_const(sv)) {
11104 SvGROW(sv, len + 1);
11105 Move(s, SvPVX(sv), len + 1, char);
11106 SvCUR_set(sv, len);
11113 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11117 =for apidoc sv_cat_decode
11119 The encoding is assumed to be an Encode object, the PV of the ssv is
11120 assumed to be octets in that encoding and decoding the input starts
11121 from the position which (PV + *offset) pointed to. The dsv will be
11122 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11123 when the string tstr appears in decoding output or the input ends on
11124 the PV of the ssv. The value which the offset points will be modified
11125 to the last input position on the ssv.
11127 Returns TRUE if the terminator was found, else returns FALSE.
11132 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11133 SV *ssv, int *offset, char *tstr, int tlen)
11137 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11148 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11149 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11151 call_method("cat_decode", G_SCALAR);
11153 ret = SvTRUE(TOPs);
11154 *offset = SvIV(offsv);
11160 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11165 /* ---------------------------------------------------------------------
11167 * support functions for report_uninit()
11170 /* the maxiumum size of array or hash where we will scan looking
11171 * for the undefined element that triggered the warning */
11173 #define FUV_MAX_SEARCH_SIZE 1000
11175 /* Look for an entry in the hash whose value has the same SV as val;
11176 * If so, return a mortal copy of the key. */
11179 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11182 register HE **array;
11185 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11186 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11189 array = HvARRAY(hv);
11191 for (i=HvMAX(hv); i>0; i--) {
11192 register HE *entry;
11193 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11194 if (HeVAL(entry) != val)
11196 if ( HeVAL(entry) == &PL_sv_undef ||
11197 HeVAL(entry) == &PL_sv_placeholder)
11201 if (HeKLEN(entry) == HEf_SVKEY)
11202 return sv_mortalcopy(HeKEY_sv(entry));
11203 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11209 /* Look for an entry in the array whose value has the same SV as val;
11210 * If so, return the index, otherwise return -1. */
11213 S_find_array_subscript(pTHX_ AV *av, SV* val)
11217 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11218 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11222 for (i=AvFILLp(av); i>=0; i--) {
11223 if (svp[i] == val && svp[i] != &PL_sv_undef)
11229 /* S_varname(): return the name of a variable, optionally with a subscript.
11230 * If gv is non-zero, use the name of that global, along with gvtype (one
11231 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11232 * targ. Depending on the value of the subscript_type flag, return:
11235 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11236 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11237 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11238 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11241 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11242 SV* keyname, I32 aindex, int subscript_type)
11245 SV * const name = sv_newmortal();
11248 buffer[0] = gvtype;
11251 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11253 gv_fullname4(name, gv, buffer, 0);
11255 if ((unsigned int)SvPVX(name)[1] <= 26) {
11257 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11259 /* Swap the 1 unprintable control character for the 2 byte pretty
11260 version - ie substr($name, 1, 1) = $buffer; */
11261 sv_insert(name, 1, 1, buffer, 2);
11266 CV * const cv = find_runcv(&unused);
11270 if (!cv || !CvPADLIST(cv))
11272 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11273 sv = *av_fetch(av, targ, FALSE);
11274 /* SvLEN in a pad name is not to be trusted */
11275 sv_setpv(name, SvPV_nolen_const(sv));
11278 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11279 SV * const sv = NEWSV(0,0);
11280 *SvPVX(name) = '$';
11281 Perl_sv_catpvf(aTHX_ name, "{%s}",
11282 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11285 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11286 *SvPVX(name) = '$';
11287 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11289 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11290 sv_insert(name, 0, 0, "within ", 7);
11297 =for apidoc find_uninit_var
11299 Find the name of the undefined variable (if any) that caused the operator o
11300 to issue a "Use of uninitialized value" warning.
11301 If match is true, only return a name if it's value matches uninit_sv.
11302 So roughly speaking, if a unary operator (such as OP_COS) generates a
11303 warning, then following the direct child of the op may yield an
11304 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11305 other hand, with OP_ADD there are two branches to follow, so we only print
11306 the variable name if we get an exact match.
11308 The name is returned as a mortal SV.
11310 Assumes that PL_op is the op that originally triggered the error, and that
11311 PL_comppad/PL_curpad points to the currently executing pad.
11317 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11325 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11326 uninit_sv == &PL_sv_placeholder)))
11329 switch (obase->op_type) {
11336 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11337 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11339 SV *keysv = Nullsv;
11340 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11342 if (pad) { /* @lex, %lex */
11343 sv = PAD_SVl(obase->op_targ);
11347 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11348 /* @global, %global */
11349 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11352 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11354 else /* @{expr}, %{expr} */
11355 return find_uninit_var(cUNOPx(obase)->op_first,
11359 /* attempt to find a match within the aggregate */
11361 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11363 subscript_type = FUV_SUBSCRIPT_HASH;
11366 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11368 subscript_type = FUV_SUBSCRIPT_ARRAY;
11371 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11374 return varname(gv, hash ? '%' : '@', obase->op_targ,
11375 keysv, index, subscript_type);
11379 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11381 return varname(Nullgv, '$', obase->op_targ,
11382 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11385 gv = cGVOPx_gv(obase);
11386 if (!gv || (match && GvSV(gv) != uninit_sv))
11388 return varname(gv, '$', 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
11391 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11394 av = (AV*)PAD_SV(obase->op_targ);
11395 if (!av || SvRMAGICAL(av))
11397 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11398 if (!svp || *svp != uninit_sv)
11401 return varname(Nullgv, '$', obase->op_targ,
11402 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11405 gv = cGVOPx_gv(obase);
11411 if (!av || SvRMAGICAL(av))
11413 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11414 if (!svp || *svp != uninit_sv)
11417 return varname(gv, '$', 0,
11418 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11423 o = cUNOPx(obase)->op_first;
11424 if (!o || o->op_type != OP_NULL ||
11425 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11427 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11431 if (PL_op == obase)
11432 /* $a[uninit_expr] or $h{uninit_expr} */
11433 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11436 o = cBINOPx(obase)->op_first;
11437 kid = cBINOPx(obase)->op_last;
11439 /* get the av or hv, and optionally the gv */
11441 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11442 sv = PAD_SV(o->op_targ);
11444 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11445 && cUNOPo->op_first->op_type == OP_GV)
11447 gv = cGVOPx_gv(cUNOPo->op_first);
11450 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11455 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11456 /* index is constant */
11460 if (obase->op_type == OP_HELEM) {
11461 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11462 if (!he || HeVAL(he) != uninit_sv)
11466 SV ** const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11467 if (!svp || *svp != uninit_sv)
11471 if (obase->op_type == OP_HELEM)
11472 return varname(gv, '%', o->op_targ,
11473 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11475 return varname(gv, '@', o->op_targ, Nullsv,
11476 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11480 /* index is an expression;
11481 * attempt to find a match within the aggregate */
11482 if (obase->op_type == OP_HELEM) {
11483 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11485 return varname(gv, '%', o->op_targ,
11486 keysv, 0, FUV_SUBSCRIPT_HASH);
11489 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11491 return varname(gv, '@', o->op_targ,
11492 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
11497 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11499 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
11505 /* only examine RHS */
11506 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11509 o = cUNOPx(obase)->op_first;
11510 if (o->op_type == OP_PUSHMARK)
11513 if (!o->op_sibling) {
11514 /* one-arg version of open is highly magical */
11516 if (o->op_type == OP_GV) { /* open FOO; */
11518 if (match && GvSV(gv) != uninit_sv)
11520 return varname(gv, '$', 0,
11521 Nullsv, 0, FUV_SUBSCRIPT_NONE);
11523 /* other possibilities not handled are:
11524 * open $x; or open my $x; should return '${*$x}'
11525 * open expr; should return '$'.expr ideally
11531 /* ops where $_ may be an implicit arg */
11535 if ( !(obase->op_flags & OPf_STACKED)) {
11536 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11537 ? PAD_SVl(obase->op_targ)
11540 sv = sv_newmortal();
11541 sv_setpvn(sv, "$_", 2);
11549 /* skip filehandle as it can't produce 'undef' warning */
11550 o = cUNOPx(obase)->op_first;
11551 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11552 o = o->op_sibling->op_sibling;
11559 match = 1; /* XS or custom code could trigger random warnings */
11564 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11565 return sv_2mortal(newSVpvn("${$/}", 5));
11570 if (!(obase->op_flags & OPf_KIDS))
11572 o = cUNOPx(obase)->op_first;
11578 /* if all except one arg are constant, or have no side-effects,
11579 * or are optimized away, then it's unambiguous */
11581 for (kid=o; kid; kid = kid->op_sibling) {
11583 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11584 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11585 || (kid->op_type == OP_PUSHMARK)
11589 if (o2) { /* more than one found */
11596 return find_uninit_var(o2, uninit_sv, match);
11598 /* scan all args */
11600 sv = find_uninit_var(o, uninit_sv, 1);
11612 =for apidoc report_uninit
11614 Print appropriate "Use of uninitialized variable" warning
11620 Perl_report_uninit(pTHX_ SV* uninit_sv)
11623 SV* varname = Nullsv;
11625 varname = find_uninit_var(PL_op, uninit_sv,0);
11627 sv_insert(varname, 0, 0, " ", 1);
11629 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11630 varname ? SvPV_nolen_const(varname) : "",
11631 " in ", OP_DESC(PL_op));
11634 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11640 * c-indentation-style: bsd
11641 * c-basic-offset: 4
11642 * indent-tabs-mode: t
11645 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob