3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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)
184 new_chunk = (void *)(chunk);
185 new_chunk_size = (chunk_size);
186 if (new_chunk_size > PL_nice_chunk_size) {
187 Safefree(PL_nice_chunk);
188 PL_nice_chunk = (char *) new_chunk;
189 PL_nice_chunk_size = new_chunk_size;
196 #ifdef DEBUG_LEAKING_SCALARS
197 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
199 # define FREE_SV_DEBUG_FILE(sv)
203 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
204 /* Whilst I'd love to do this, it seems that things like to check on
206 # define POSION_SV_HEAD(sv) Poison(sv, 1, struct STRUCT_SV)
208 # define POSION_SV_HEAD(sv) Poison(&SvANY(sv), 1, void *), \
209 Poison(&SvREFCNT(sv), 1, U32)
211 # define SvARENA_CHAIN(sv) SvANY(sv)
212 # define POSION_SV_HEAD(sv)
215 #define plant_SV(p) \
217 FREE_SV_DEBUG_FILE(p); \
219 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
220 SvFLAGS(p) = SVTYPEMASK; \
225 /* sv_mutex must be held while calling uproot_SV() */
226 #define uproot_SV(p) \
229 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
234 /* make some more SVs by adding another arena */
236 /* sv_mutex must be held while calling more_sv() */
244 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
245 PL_nice_chunk = NULL;
246 PL_nice_chunk_size = 0;
249 char *chunk; /* must use New here to match call to */
250 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
251 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
257 /* new_SV(): return a new, empty SV head */
259 #ifdef DEBUG_LEAKING_SCALARS
260 /* provide a real function for a debugger to play with */
270 sv = S_more_sv(aTHX);
275 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
276 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
277 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
278 sv->sv_debug_inpad = 0;
279 sv->sv_debug_cloned = 0;
280 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
284 # define new_SV(p) (p)=S_new_SV(aTHX)
293 (p) = S_more_sv(aTHX); \
302 /* del_SV(): return an empty SV head to the free list */
317 S_del_sv(pTHX_ SV *p)
323 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
324 const SV * const sv = sva + 1;
325 const SV * const svend = &sva[SvREFCNT(sva)];
326 if (p >= sv && p < svend) {
332 if (ckWARN_d(WARN_INTERNAL))
333 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
334 "Attempt to free non-arena SV: 0x%"UVxf
335 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
342 #else /* ! DEBUGGING */
344 #define del_SV(p) plant_SV(p)
346 #endif /* DEBUGGING */
350 =head1 SV Manipulation Functions
352 =for apidoc sv_add_arena
354 Given a chunk of memory, link it to the head of the list of arenas,
355 and split it into a list of free SVs.
361 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
364 SV* const sva = (SV*)ptr;
368 /* The first SV in an arena isn't an SV. */
369 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
370 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
371 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
373 PL_sv_arenaroot = sva;
374 PL_sv_root = sva + 1;
376 svend = &sva[SvREFCNT(sva) - 1];
379 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
383 /* Must always set typemask because it's awlays checked in on cleanup
384 when the arenas are walked looking for objects. */
385 SvFLAGS(sv) = SVTYPEMASK;
388 SvARENA_CHAIN(sv) = 0;
392 SvFLAGS(sv) = SVTYPEMASK;
395 /* visit(): call the named function for each non-free SV in the arenas
396 * whose flags field matches the flags/mask args. */
399 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
405 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
406 register const SV * const svend = &sva[SvREFCNT(sva)];
408 for (sv = sva + 1; sv < svend; ++sv) {
409 if (SvTYPE(sv) != SVTYPEMASK
410 && (sv->sv_flags & mask) == flags
423 /* called by sv_report_used() for each live SV */
426 do_report_used(pTHX_ SV *sv)
428 if (SvTYPE(sv) != SVTYPEMASK) {
429 PerlIO_printf(Perl_debug_log, "****\n");
436 =for apidoc sv_report_used
438 Dump the contents of all SVs not yet freed. (Debugging aid).
444 Perl_sv_report_used(pTHX)
447 visit(do_report_used, 0, 0);
451 /* called by sv_clean_objs() for each live SV */
454 do_clean_objs(pTHX_ SV *ref)
458 SV * const target = SvRV(ref);
459 if (SvOBJECT(target)) {
460 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
461 if (SvWEAKREF(ref)) {
462 sv_del_backref(target, ref);
468 SvREFCNT_dec(target);
473 /* XXX Might want to check arrays, etc. */
476 /* called by sv_clean_objs() for each live SV */
478 #ifndef DISABLE_DESTRUCTOR_KLUDGE
480 do_clean_named_objs(pTHX_ SV *sv)
483 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
485 #ifdef PERL_DONT_CREATE_GVSV
488 SvOBJECT(GvSV(sv))) ||
489 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
490 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
491 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
492 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
494 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
495 SvFLAGS(sv) |= SVf_BREAK;
503 =for apidoc sv_clean_objs
505 Attempt to destroy all objects not yet freed
511 Perl_sv_clean_objs(pTHX)
514 PL_in_clean_objs = TRUE;
515 visit(do_clean_objs, SVf_ROK, SVf_ROK);
516 #ifndef DISABLE_DESTRUCTOR_KLUDGE
517 /* some barnacles may yet remain, clinging to typeglobs */
518 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
520 PL_in_clean_objs = FALSE;
523 /* called by sv_clean_all() for each live SV */
526 do_clean_all(pTHX_ SV *sv)
529 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
530 SvFLAGS(sv) |= SVf_BREAK;
531 if (PL_comppad == (AV*)sv) {
533 PL_curpad = Null(SV**);
539 =for apidoc sv_clean_all
541 Decrement the refcnt of each remaining SV, possibly triggering a
542 cleanup. This function may have to be called multiple times to free
543 SVs which are in complex self-referential hierarchies.
549 Perl_sv_clean_all(pTHX)
553 PL_in_clean_all = TRUE;
554 cleaned = visit(do_clean_all, 0,0);
555 PL_in_clean_all = FALSE;
560 ARENASETS: a meta-arena implementation which separates arena-info
561 into struct arena_set, which contains an array of struct
562 arena_descs, each holding info for a single arena. By separating
563 the meta-info from the arena, we recover the 1st slot, formerly
564 borrowed for list management. The arena_set is about the size of an
565 arena, avoiding the needless malloc overhead of a naive linked-list
567 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
568 memory in the last arena-set (1/2 on average). In trade, we get
569 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
572 union arena is declared with a fixed size, but is intended to vary
573 by type, allowing their use for big, rare body-types where theres
574 currently too much wastage (unused arena slots)
579 char *arena; /* the raw storage, allocated aligned */
580 size_t size; /* its size ~4k typ */
581 int unit_type; /* useful for arena audits */
582 /* info for sv-heads (eventually)
589 /* Get the maximum number of elements in set[] such that struct arena_set
590 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
591 therefore likely to be 1 aligned memory page. */
593 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
594 - 2 * sizeof(int)) / sizeof (struct arena_desc))
597 struct arena_set* next;
598 int set_size; /* ie ARENAS_PER_SET */
599 int curr; /* index of next available arena-desc */
600 struct arena_desc set[ARENAS_PER_SET];
606 S_free_arena(pTHX_ void **root) {
608 void ** const next = *(void **)root;
616 =for apidoc sv_free_arenas
618 Deallocate the memory used by all arenas. Note that all the individual SV
619 heads and bodies within the arenas must already have been freed.
624 Perl_sv_free_arenas(pTHX)
631 /* Free arenas here, but be careful about fake ones. (We assume
632 contiguity of the fake ones with the corresponding real ones.) */
634 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
635 svanext = (SV*) SvANY(sva);
636 while (svanext && SvFAKE(svanext))
637 svanext = (SV*) SvANY(svanext);
645 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
647 for (; aroot; aroot = next) {
648 int max = aroot->curr;
649 for (i=0; i<max; i++) {
650 assert(aroot->set[i].arena);
651 Safefree(aroot->set[i].arena);
658 S_free_arena(aTHX_ (void**) PL_body_arenas);
661 for (i=0; i<SVt_LAST; i++)
662 PL_body_roots[i] = 0;
664 Safefree(PL_nice_chunk);
665 PL_nice_chunk = NULL;
666 PL_nice_chunk_size = 0;
672 Here are mid-level routines that manage the allocation of bodies out
673 of the various arenas. There are 5 kinds of arenas:
675 1. SV-head arenas, which are discussed and handled above
676 2. regular body arenas
677 3. arenas for reduced-size bodies
679 5. pte arenas (thread related)
681 Arena types 2 & 3 are chained by body-type off an array of
682 arena-root pointers, which is indexed by svtype. Some of the
683 larger/less used body types are malloced singly, since a large
684 unused block of them is wasteful. Also, several svtypes dont have
685 bodies; the data fits into the sv-head itself. The arena-root
686 pointer thus has a few unused root-pointers (which may be hijacked
687 later for arena types 4,5)
689 3 differs from 2 as an optimization; some body types have several
690 unused fields in the front of the structure (which are kept in-place
691 for consistency). These bodies can be allocated in smaller chunks,
692 because the leading fields arent accessed. Pointers to such bodies
693 are decremented to point at the unused 'ghost' memory, knowing that
694 the pointers are used with offsets to the real memory.
696 HE, HEK arenas are managed separately, with separate code, but may
697 be merge-able later..
699 PTE arenas are not sv-bodies, but they share these mid-level
700 mechanics, so are considered here. The new mid-level mechanics rely
701 on the sv_type of the body being allocated, so we just reserve one
702 of the unused body-slots for PTEs, then use it in those (2) PTE
703 contexts below (line ~10k)
706 /* get_arena(size): when ARENASETS is enabled, this creates
707 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
709 TBD: export properly for hv.c: S_more_he().
712 Perl_get_arena(pTHX_ int arena_size)
717 /* allocate and attach arena */
718 Newx(arp, PERL_ARENA_SIZE, char);
719 arp->next = PL_body_arenas;
720 PL_body_arenas = arp;
724 struct arena_desc* adesc;
725 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
728 /* shouldnt need this
729 if (!arena_size) arena_size = PERL_ARENA_SIZE;
732 /* may need new arena-set to hold new arena */
733 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
734 Newxz(newroot, 1, struct arena_set);
735 newroot->set_size = ARENAS_PER_SET;
736 newroot->next = *aroot;
738 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
741 /* ok, now have arena-set with at least 1 empty/available arena-desc */
742 curr = (*aroot)->curr++;
743 adesc = &((*aroot)->set[curr]);
744 assert(!adesc->arena);
746 Newxz(adesc->arena, arena_size, char);
747 adesc->size = arena_size;
748 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p\n", curr, aroot));
755 S_more_bodies (pTHX_ size_t size, svtype sv_type)
758 void ** const root = &PL_body_roots[sv_type];
761 const size_t count = PERL_ARENA_SIZE / size;
763 start = (char*) Perl_get_arena(aTHX_ PERL_ARENA_SIZE);
765 end = start + (count-1) * size;
768 /* The initial slot is used to link the arenas together, so it isn't to be
769 linked into the list of ready-to-use bodies. */
773 *root = (void *)start;
775 while (start < end) {
776 char * const next = start + size;
777 *(void**) start = (void *)next;
785 /* grab a new thing from the free list, allocating more if necessary */
787 /* 1st, the inline version */
789 #define new_body_inline(xpv, size, sv_type) \
791 void ** const r3wt = &PL_body_roots[sv_type]; \
793 xpv = *((void **)(r3wt)) \
794 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
795 *(r3wt) = *(void**)(xpv); \
799 /* now use the inline version in the proper function */
803 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
804 compilers issue warnings. */
807 S_new_body(pTHX_ size_t size, svtype sv_type)
811 new_body_inline(xpv, size, sv_type);
817 /* return a thing to the free list */
819 #define del_body(thing, root) \
821 void ** const thing_copy = (void **)thing;\
823 *thing_copy = *root; \
824 *root = (void*)thing_copy; \
829 Revisiting type 3 arenas, there are 4 body-types which have some
830 members that are never accessed. They are XPV, XPVIV, XPVAV,
831 XPVHV, which have corresponding types: xpv_allocated,
832 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
834 For these types, the arenas are carved up into *_allocated size
835 chunks, we thus avoid wasted memory for those unaccessed members.
836 When bodies are allocated, we adjust the pointer back in memory by
837 the size of the bit not allocated, so it's as if we allocated the
838 full structure. (But things will all go boom if you write to the
839 part that is "not there", because you'll be overwriting the last
840 members of the preceding structure in memory.)
842 We calculate the correction using the STRUCT_OFFSET macro. For example, if
843 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
844 and the pointer is unchanged. If the allocated structure is smaller (no
845 initial NV actually allocated) then the net effect is to subtract the size
846 of the NV from the pointer, to return a new pointer as if an initial NV were
849 This is the same trick as was used for NV and IV bodies. Ironically it
850 doesn't need to be used for NV bodies any more, because NV is now at the
851 start of the structure. IV bodies don't need it either, because they are
852 no longer allocated. */
854 /* The following 2 arrays hide the above details in a pair of
855 lookup-tables, allowing us to be body-type agnostic.
857 size maps svtype to its body's allocated size.
858 offset maps svtype to the body-pointer adjustment needed
860 NB: elements in latter are 0 or <0, and are added during
861 allocation, and subtracted during deallocation. It may be clearer
862 to invert the values, and call it shrinkage_by_svtype.
865 struct body_details {
866 size_t size; /* Size to allocate */
867 size_t copy; /* Size of structure to copy (may be shorter) */
869 bool cant_upgrade; /* Can upgrade this type */
870 bool zero_nv; /* zero the NV when upgrading from this */
871 bool arena; /* Allocated from an arena */
878 /* With -DPURFIY we allocate everything directly, and don't use arenas.
879 This seems a rather elegant way to simplify some of the code below. */
880 #define HASARENA FALSE
882 #define HASARENA TRUE
884 #define NOARENA FALSE
886 /* A macro to work out the offset needed to subtract from a pointer to (say)
893 to make its members accessible via a pointer to (say)
903 #define relative_STRUCT_OFFSET(longer, shorter, member) \
904 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
906 /* Calculate the length to copy. Specifically work out the length less any
907 final padding the compiler needed to add. See the comment in sv_upgrade
908 for why copying the padding proved to be a bug. */
910 #define copy_length(type, last_member) \
911 STRUCT_OFFSET(type, last_member) \
912 + sizeof (((type*)SvANY((SV*)0))->last_member)
914 static const struct body_details bodies_by_type[] = {
915 {0, 0, 0, FALSE, NONV, NOARENA},
916 /* IVs are in the head, so the allocation size is 0 */
917 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
918 /* 8 bytes on most ILP32 with IEEE doubles */
919 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
920 /* RVs are in the head now */
921 /* However, this slot is overloaded and used by the pte */
922 {0, 0, 0, FALSE, NONV, NOARENA},
923 /* 8 bytes on most ILP32 with IEEE doubles */
924 {sizeof(xpv_allocated),
925 copy_length(XPV, xpv_len)
926 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
927 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
928 FALSE, NONV, HASARENA},
930 {sizeof(xpviv_allocated),
931 copy_length(XPVIV, xiv_u)
932 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
933 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
934 FALSE, NONV, HASARENA},
936 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
938 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
940 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
942 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
944 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
946 {sizeof(xpvav_allocated),
947 copy_length(XPVAV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
949 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 TRUE, HADNV, HASARENA},
952 {sizeof(xpvhv_allocated),
953 copy_length(XPVHV, xmg_stash)
954 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
955 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 TRUE, HADNV, HASARENA},
958 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
960 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
962 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
965 #define new_body_type(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type))
968 #define del_body_type(p, sv_type) \
969 del_body(p, &PL_body_roots[sv_type])
972 #define new_body_allocated(sv_type) \
973 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
974 - bodies_by_type[sv_type].offset)
976 #define del_body_allocated(p, sv_type) \
977 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
980 #define my_safemalloc(s) (void*)safemalloc(s)
981 #define my_safecalloc(s) (void*)safecalloc(s, 1)
982 #define my_safefree(p) safefree((char*)p)
986 #define new_XNV() my_safemalloc(sizeof(XPVNV))
987 #define del_XNV(p) my_safefree(p)
989 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
990 #define del_XPVNV(p) my_safefree(p)
992 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
993 #define del_XPVAV(p) my_safefree(p)
995 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
996 #define del_XPVHV(p) my_safefree(p)
998 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
999 #define del_XPVMG(p) my_safefree(p)
1001 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1002 #define del_XPVGV(p) my_safefree(p)
1006 #define new_XNV() new_body_type(SVt_NV)
1007 #define del_XNV(p) del_body_type(p, SVt_NV)
1009 #define new_XPVNV() new_body_type(SVt_PVNV)
1010 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1012 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1013 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1015 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1016 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1018 #define new_XPVMG() new_body_type(SVt_PVMG)
1019 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1021 #define new_XPVGV() new_body_type(SVt_PVGV)
1022 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1026 /* no arena for you! */
1028 #define new_NOARENA(details) \
1029 my_safemalloc((details)->size + (details)->offset)
1030 #define new_NOARENAZ(details) \
1031 my_safecalloc((details)->size + (details)->offset)
1034 =for apidoc sv_upgrade
1036 Upgrade an SV to a more complex form. Generally adds a new body type to the
1037 SV, then copies across as much information as possible from the old body.
1038 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1044 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1049 const U32 old_type = SvTYPE(sv);
1050 const struct body_details *const old_type_details
1051 = bodies_by_type + old_type;
1052 const struct body_details *new_type_details = bodies_by_type + new_type;
1054 if (new_type != SVt_PV && SvIsCOW(sv)) {
1055 sv_force_normal_flags(sv, 0);
1058 if (old_type == new_type)
1061 if (old_type > new_type)
1062 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1063 (int)old_type, (int)new_type);
1066 old_body = SvANY(sv);
1068 /* Copying structures onto other structures that have been neatly zeroed
1069 has a subtle gotcha. Consider XPVMG
1071 +------+------+------+------+------+-------+-------+
1072 | NV | CUR | LEN | IV | MAGIC | STASH |
1073 +------+------+------+------+------+-------+-------+
1074 0 4 8 12 16 20 24 28
1076 where NVs are aligned to 8 bytes, so that sizeof that structure is
1077 actually 32 bytes long, with 4 bytes of padding at the end:
1079 +------+------+------+------+------+-------+-------+------+
1080 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1081 +------+------+------+------+------+-------+-------+------+
1082 0 4 8 12 16 20 24 28 32
1084 so what happens if you allocate memory for this structure:
1086 +------+------+------+------+------+-------+-------+------+------+...
1087 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1088 +------+------+------+------+------+-------+-------+------+------+...
1089 0 4 8 12 16 20 24 28 32 36
1091 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1092 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1093 started out as zero once, but it's quite possible that it isn't. So now,
1094 rather than a nicely zeroed GP, you have it pointing somewhere random.
1097 (In fact, GP ends up pointing at a previous GP structure, because the
1098 principle cause of the padding in XPVMG getting garbage is a copy of
1099 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1101 So we are careful and work out the size of used parts of all the
1108 if (new_type < SVt_PVIV) {
1109 new_type = (new_type == SVt_NV)
1110 ? SVt_PVNV : SVt_PVIV;
1111 new_type_details = bodies_by_type + new_type;
1115 if (new_type < SVt_PVNV) {
1116 new_type = SVt_PVNV;
1117 new_type_details = bodies_by_type + new_type;
1123 assert(new_type > SVt_PV);
1124 assert(SVt_IV < SVt_PV);
1125 assert(SVt_NV < SVt_PV);
1132 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1133 there's no way that it can be safely upgraded, because perl.c
1134 expects to Safefree(SvANY(PL_mess_sv)) */
1135 assert(sv != PL_mess_sv);
1136 /* This flag bit is used to mean other things in other scalar types.
1137 Given that it only has meaning inside the pad, it shouldn't be set
1138 on anything that can get upgraded. */
1139 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1142 if (old_type_details->cant_upgrade)
1143 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1144 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1147 SvFLAGS(sv) &= ~SVTYPEMASK;
1148 SvFLAGS(sv) |= new_type;
1150 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1151 the return statements above will have triggered. */
1152 assert (new_type != SVt_NULL);
1155 assert(old_type == SVt_NULL);
1156 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1160 assert(old_type == SVt_NULL);
1161 SvANY(sv) = new_XNV();
1165 assert(old_type == SVt_NULL);
1166 SvANY(sv) = &sv->sv_u.svu_rv;
1171 assert(new_type_details->size);
1174 assert(new_type_details->arena);
1175 /* This points to the start of the allocated area. */
1176 new_body_inline(new_body, new_type_details->size, new_type);
1177 Zero(new_body, new_type_details->size, char);
1178 new_body = ((char *)new_body) - new_type_details->offset;
1180 /* We always allocated the full length item with PURIFY. To do this
1181 we fake things so that arena is false for all 16 types.. */
1182 new_body = new_NOARENAZ(new_type_details);
1184 SvANY(sv) = new_body;
1185 if (new_type == SVt_PVAV) {
1191 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1192 The target created by newSVrv also is, and it can have magic.
1193 However, it never has SvPVX set.
1195 if (old_type >= SVt_RV) {
1196 assert(SvPVX_const(sv) == 0);
1199 /* Could put this in the else clause below, as PVMG must have SvPVX
1200 0 already (the assertion above) */
1203 if (old_type >= SVt_PVMG) {
1204 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1205 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1211 /* XXX Is this still needed? Was it ever needed? Surely as there is
1212 no route from NV to PVIV, NOK can never be true */
1213 assert(!SvNOKp(sv));
1225 assert(new_type_details->size);
1226 /* We always allocated the full length item with PURIFY. To do this
1227 we fake things so that arena is false for all 16 types.. */
1228 if(new_type_details->arena) {
1229 /* This points to the start of the allocated area. */
1230 new_body_inline(new_body, new_type_details->size, new_type);
1231 Zero(new_body, new_type_details->size, char);
1232 new_body = ((char *)new_body) - new_type_details->offset;
1234 new_body = new_NOARENAZ(new_type_details);
1236 SvANY(sv) = new_body;
1238 if (old_type_details->copy) {
1239 Copy((char *)old_body + old_type_details->offset,
1240 (char *)new_body + old_type_details->offset,
1241 old_type_details->copy, char);
1244 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1245 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1246 * correct 0.0 for us. Otherwise, if the old body didn't have an
1247 * NV slot, but the new one does, then we need to initialise the
1248 * freshly created NV slot with whatever the correct bit pattern is
1250 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1254 if (new_type == SVt_PVIO)
1255 IoPAGE_LEN(sv) = 60;
1256 if (old_type < SVt_RV)
1260 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1261 (unsigned long)new_type);
1264 if (old_type_details->size) {
1265 /* If the old body had an allocated size, then we need to free it. */
1267 my_safefree(old_body);
1269 del_body((void*)((char*)old_body + old_type_details->offset),
1270 &PL_body_roots[old_type]);
1276 =for apidoc sv_backoff
1278 Remove any string offset. You should normally use the C<SvOOK_off> macro
1285 Perl_sv_backoff(pTHX_ register SV *sv)
1288 assert(SvTYPE(sv) != SVt_PVHV);
1289 assert(SvTYPE(sv) != SVt_PVAV);
1291 const char * const s = SvPVX_const(sv);
1292 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1293 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1295 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1297 SvFLAGS(sv) &= ~SVf_OOK;
1304 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1305 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1306 Use the C<SvGROW> wrapper instead.
1312 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1316 #ifdef HAS_64K_LIMIT
1317 if (newlen >= 0x10000) {
1318 PerlIO_printf(Perl_debug_log,
1319 "Allocation too large: %"UVxf"\n", (UV)newlen);
1322 #endif /* HAS_64K_LIMIT */
1325 if (SvTYPE(sv) < SVt_PV) {
1326 sv_upgrade(sv, SVt_PV);
1327 s = SvPVX_mutable(sv);
1329 else if (SvOOK(sv)) { /* pv is offset? */
1331 s = SvPVX_mutable(sv);
1332 if (newlen > SvLEN(sv))
1333 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1334 #ifdef HAS_64K_LIMIT
1335 if (newlen >= 0x10000)
1340 s = SvPVX_mutable(sv);
1342 if (newlen > SvLEN(sv)) { /* need more room? */
1343 newlen = PERL_STRLEN_ROUNDUP(newlen);
1344 if (SvLEN(sv) && s) {
1346 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1352 s = saferealloc(s, newlen);
1355 s = safemalloc(newlen);
1356 if (SvPVX_const(sv) && SvCUR(sv)) {
1357 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1361 SvLEN_set(sv, newlen);
1367 =for apidoc sv_setiv
1369 Copies an integer into the given SV, upgrading first if necessary.
1370 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1376 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1379 SV_CHECK_THINKFIRST_COW_DROP(sv);
1380 switch (SvTYPE(sv)) {
1382 sv_upgrade(sv, SVt_IV);
1385 sv_upgrade(sv, SVt_PVNV);
1389 sv_upgrade(sv, SVt_PVIV);
1398 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1401 (void)SvIOK_only(sv); /* validate number */
1407 =for apidoc sv_setiv_mg
1409 Like C<sv_setiv>, but also handles 'set' magic.
1415 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1422 =for apidoc sv_setuv
1424 Copies an unsigned integer into the given SV, upgrading first if necessary.
1425 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1431 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1433 /* With these two if statements:
1434 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1437 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1439 If you wish to remove them, please benchmark to see what the effect is
1441 if (u <= (UV)IV_MAX) {
1442 sv_setiv(sv, (IV)u);
1451 =for apidoc sv_setuv_mg
1453 Like C<sv_setuv>, but also handles 'set' magic.
1459 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1468 =for apidoc sv_setnv
1470 Copies a double into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1477 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1484 sv_upgrade(sv, SVt_NV);
1489 sv_upgrade(sv, SVt_PVNV);
1498 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1502 (void)SvNOK_only(sv); /* validate number */
1507 =for apidoc sv_setnv_mg
1509 Like C<sv_setnv>, but also handles 'set' magic.
1515 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1521 /* Print an "isn't numeric" warning, using a cleaned-up,
1522 * printable version of the offending string
1526 S_not_a_number(pTHX_ SV *sv)
1534 dsv = sv_2mortal(newSVpvs(""));
1535 pv = sv_uni_display(dsv, sv, 10, 0);
1538 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1539 /* each *s can expand to 4 chars + "...\0",
1540 i.e. need room for 8 chars */
1542 const char *s = SvPVX_const(sv);
1543 const char * const end = s + SvCUR(sv);
1544 for ( ; s < end && d < limit; s++ ) {
1546 if (ch & 128 && !isPRINT_LC(ch)) {
1555 else if (ch == '\r') {
1559 else if (ch == '\f') {
1563 else if (ch == '\\') {
1567 else if (ch == '\0') {
1571 else if (isPRINT_LC(ch))
1588 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1589 "Argument \"%s\" isn't numeric in %s", pv,
1592 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1593 "Argument \"%s\" isn't numeric", pv);
1597 =for apidoc looks_like_number
1599 Test if the content of an SV looks like a number (or is a number).
1600 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1601 non-numeric warning), even if your atof() doesn't grok them.
1607 Perl_looks_like_number(pTHX_ SV *sv)
1609 register const char *sbegin;
1613 sbegin = SvPVX_const(sv);
1616 else if (SvPOKp(sv))
1617 sbegin = SvPV_const(sv, len);
1619 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1620 return grok_number(sbegin, len, NULL);
1623 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1624 until proven guilty, assume that things are not that bad... */
1629 As 64 bit platforms often have an NV that doesn't preserve all bits of
1630 an IV (an assumption perl has been based on to date) it becomes necessary
1631 to remove the assumption that the NV always carries enough precision to
1632 recreate the IV whenever needed, and that the NV is the canonical form.
1633 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1634 precision as a side effect of conversion (which would lead to insanity
1635 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1636 1) to distinguish between IV/UV/NV slots that have cached a valid
1637 conversion where precision was lost and IV/UV/NV slots that have a
1638 valid conversion which has lost no precision
1639 2) to ensure that if a numeric conversion to one form is requested that
1640 would lose precision, the precise conversion (or differently
1641 imprecise conversion) is also performed and cached, to prevent
1642 requests for different numeric formats on the same SV causing
1643 lossy conversion chains. (lossless conversion chains are perfectly
1648 SvIOKp is true if the IV slot contains a valid value
1649 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1650 SvNOKp is true if the NV slot contains a valid value
1651 SvNOK is true only if the NV value is accurate
1654 while converting from PV to NV, check to see if converting that NV to an
1655 IV(or UV) would lose accuracy over a direct conversion from PV to
1656 IV(or UV). If it would, cache both conversions, return NV, but mark
1657 SV as IOK NOKp (ie not NOK).
1659 While converting from PV to IV, check to see if converting that IV to an
1660 NV would lose accuracy over a direct conversion from PV to NV. If it
1661 would, cache both conversions, flag similarly.
1663 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1664 correctly because if IV & NV were set NV *always* overruled.
1665 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1666 changes - now IV and NV together means that the two are interchangeable:
1667 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1669 The benefit of this is that operations such as pp_add know that if
1670 SvIOK is true for both left and right operands, then integer addition
1671 can be used instead of floating point (for cases where the result won't
1672 overflow). Before, floating point was always used, which could lead to
1673 loss of precision compared with integer addition.
1675 * making IV and NV equal status should make maths accurate on 64 bit
1677 * may speed up maths somewhat if pp_add and friends start to use
1678 integers when possible instead of fp. (Hopefully the overhead in
1679 looking for SvIOK and checking for overflow will not outweigh the
1680 fp to integer speedup)
1681 * will slow down integer operations (callers of SvIV) on "inaccurate"
1682 values, as the change from SvIOK to SvIOKp will cause a call into
1683 sv_2iv each time rather than a macro access direct to the IV slot
1684 * should speed up number->string conversion on integers as IV is
1685 favoured when IV and NV are equally accurate
1687 ####################################################################
1688 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1689 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1690 On the other hand, SvUOK is true iff UV.
1691 ####################################################################
1693 Your mileage will vary depending your CPU's relative fp to integer
1697 #ifndef NV_PRESERVES_UV
1698 # define IS_NUMBER_UNDERFLOW_IV 1
1699 # define IS_NUMBER_UNDERFLOW_UV 2
1700 # define IS_NUMBER_IV_AND_UV 2
1701 # define IS_NUMBER_OVERFLOW_IV 4
1702 # define IS_NUMBER_OVERFLOW_UV 5
1704 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1706 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1708 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1711 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));
1712 if (SvNVX(sv) < (NV)IV_MIN) {
1713 (void)SvIOKp_on(sv);
1715 SvIV_set(sv, IV_MIN);
1716 return IS_NUMBER_UNDERFLOW_IV;
1718 if (SvNVX(sv) > (NV)UV_MAX) {
1719 (void)SvIOKp_on(sv);
1722 SvUV_set(sv, UV_MAX);
1723 return IS_NUMBER_OVERFLOW_UV;
1725 (void)SvIOKp_on(sv);
1727 /* Can't use strtol etc to convert this string. (See truth table in
1729 if (SvNVX(sv) <= (UV)IV_MAX) {
1730 SvIV_set(sv, I_V(SvNVX(sv)));
1731 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1732 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1734 /* Integer is imprecise. NOK, IOKp */
1736 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1739 SvUV_set(sv, U_V(SvNVX(sv)));
1740 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1741 if (SvUVX(sv) == UV_MAX) {
1742 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1743 possibly be preserved by NV. Hence, it must be overflow.
1745 return IS_NUMBER_OVERFLOW_UV;
1747 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1749 /* Integer is imprecise. NOK, IOKp */
1751 return IS_NUMBER_OVERFLOW_IV;
1753 #endif /* !NV_PRESERVES_UV*/
1756 S_sv_2iuv_common(pTHX_ SV *sv) {
1759 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1760 * without also getting a cached IV/UV from it at the same time
1761 * (ie PV->NV conversion should detect loss of accuracy and cache
1762 * IV or UV at same time to avoid this. */
1763 /* IV-over-UV optimisation - choose to cache IV if possible */
1765 if (SvTYPE(sv) == SVt_NV)
1766 sv_upgrade(sv, SVt_PVNV);
1768 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1769 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1770 certainly cast into the IV range at IV_MAX, whereas the correct
1771 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1773 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1774 SvIV_set(sv, I_V(SvNVX(sv)));
1775 if (SvNVX(sv) == (NV) SvIVX(sv)
1776 #ifndef NV_PRESERVES_UV
1777 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1778 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1779 /* Don't flag it as "accurately an integer" if the number
1780 came from a (by definition imprecise) NV operation, and
1781 we're outside the range of NV integer precision */
1784 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1785 DEBUG_c(PerlIO_printf(Perl_debug_log,
1786 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1792 /* IV not precise. No need to convert from PV, as NV
1793 conversion would already have cached IV if it detected
1794 that PV->IV would be better than PV->NV->IV
1795 flags already correct - don't set public IOK. */
1796 DEBUG_c(PerlIO_printf(Perl_debug_log,
1797 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1802 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1803 but the cast (NV)IV_MIN rounds to a the value less (more
1804 negative) than IV_MIN which happens to be equal to SvNVX ??
1805 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1806 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1807 (NV)UVX == NVX are both true, but the values differ. :-(
1808 Hopefully for 2s complement IV_MIN is something like
1809 0x8000000000000000 which will be exact. NWC */
1812 SvUV_set(sv, U_V(SvNVX(sv)));
1814 (SvNVX(sv) == (NV) SvUVX(sv))
1815 #ifndef NV_PRESERVES_UV
1816 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1817 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1818 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1819 /* Don't flag it as "accurately an integer" if the number
1820 came from a (by definition imprecise) NV operation, and
1821 we're outside the range of NV integer precision */
1826 DEBUG_c(PerlIO_printf(Perl_debug_log,
1827 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1833 else if (SvPOKp(sv) && SvLEN(sv)) {
1835 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1836 /* We want to avoid a possible problem when we cache an IV/ a UV which
1837 may be later translated to an NV, and the resulting NV is not
1838 the same as the direct translation of the initial string
1839 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1840 be careful to ensure that the value with the .456 is around if the
1841 NV value is requested in the future).
1843 This means that if we cache such an IV/a UV, we need to cache the
1844 NV as well. Moreover, we trade speed for space, and do not
1845 cache the NV if we are sure it's not needed.
1848 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1849 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1850 == IS_NUMBER_IN_UV) {
1851 /* It's definitely an integer, only upgrade to PVIV */
1852 if (SvTYPE(sv) < SVt_PVIV)
1853 sv_upgrade(sv, SVt_PVIV);
1855 } else if (SvTYPE(sv) < SVt_PVNV)
1856 sv_upgrade(sv, SVt_PVNV);
1858 /* If NVs preserve UVs then we only use the UV value if we know that
1859 we aren't going to call atof() below. If NVs don't preserve UVs
1860 then the value returned may have more precision than atof() will
1861 return, even though value isn't perfectly accurate. */
1862 if ((numtype & (IS_NUMBER_IN_UV
1863 #ifdef NV_PRESERVES_UV
1866 )) == IS_NUMBER_IN_UV) {
1867 /* This won't turn off the public IOK flag if it was set above */
1868 (void)SvIOKp_on(sv);
1870 if (!(numtype & IS_NUMBER_NEG)) {
1872 if (value <= (UV)IV_MAX) {
1873 SvIV_set(sv, (IV)value);
1875 /* it didn't overflow, and it was positive. */
1876 SvUV_set(sv, value);
1880 /* 2s complement assumption */
1881 if (value <= (UV)IV_MIN) {
1882 SvIV_set(sv, -(IV)value);
1884 /* Too negative for an IV. This is a double upgrade, but
1885 I'm assuming it will be rare. */
1886 if (SvTYPE(sv) < SVt_PVNV)
1887 sv_upgrade(sv, SVt_PVNV);
1891 SvNV_set(sv, -(NV)value);
1892 SvIV_set(sv, IV_MIN);
1896 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1897 will be in the previous block to set the IV slot, and the next
1898 block to set the NV slot. So no else here. */
1900 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1901 != IS_NUMBER_IN_UV) {
1902 /* It wasn't an (integer that doesn't overflow the UV). */
1903 SvNV_set(sv, Atof(SvPVX_const(sv)));
1905 if (! numtype && ckWARN(WARN_NUMERIC))
1908 #if defined(USE_LONG_DOUBLE)
1909 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1910 PTR2UV(sv), SvNVX(sv)));
1912 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1913 PTR2UV(sv), SvNVX(sv)));
1916 #ifdef NV_PRESERVES_UV
1917 (void)SvIOKp_on(sv);
1919 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1920 SvIV_set(sv, I_V(SvNVX(sv)));
1921 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1924 /* Integer is imprecise. NOK, IOKp */
1926 /* UV will not work better than IV */
1928 if (SvNVX(sv) > (NV)UV_MAX) {
1930 /* Integer is inaccurate. NOK, IOKp, is UV */
1931 SvUV_set(sv, UV_MAX);
1933 SvUV_set(sv, U_V(SvNVX(sv)));
1934 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1935 NV preservse UV so can do correct comparison. */
1936 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1939 /* Integer is imprecise. NOK, IOKp, is UV */
1944 #else /* NV_PRESERVES_UV */
1945 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1946 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1947 /* The IV/UV slot will have been set from value returned by
1948 grok_number above. The NV slot has just been set using
1951 assert (SvIOKp(sv));
1953 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1954 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1955 /* Small enough to preserve all bits. */
1956 (void)SvIOKp_on(sv);
1958 SvIV_set(sv, I_V(SvNVX(sv)));
1959 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1961 /* Assumption: first non-preserved integer is < IV_MAX,
1962 this NV is in the preserved range, therefore: */
1963 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1965 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);
1969 0 0 already failed to read UV.
1970 0 1 already failed to read UV.
1971 1 0 you won't get here in this case. IV/UV
1972 slot set, public IOK, Atof() unneeded.
1973 1 1 already read UV.
1974 so there's no point in sv_2iuv_non_preserve() attempting
1975 to use atol, strtol, strtoul etc. */
1976 sv_2iuv_non_preserve (sv, numtype);
1979 #endif /* NV_PRESERVES_UV */
1983 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1984 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1987 if (SvTYPE(sv) < SVt_IV)
1988 /* Typically the caller expects that sv_any is not NULL now. */
1989 sv_upgrade(sv, SVt_IV);
1990 /* Return 0 from the caller. */
1997 =for apidoc sv_2iv_flags
1999 Return the integer value of an SV, doing any necessary string
2000 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2001 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2007 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2012 if (SvGMAGICAL(sv)) {
2013 if (flags & SV_GMAGIC)
2018 return I_V(SvNVX(sv));
2020 if (SvPOKp(sv) && SvLEN(sv)) {
2023 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2025 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2026 == IS_NUMBER_IN_UV) {
2027 /* It's definitely an integer */
2028 if (numtype & IS_NUMBER_NEG) {
2029 if (value < (UV)IV_MIN)
2032 if (value < (UV)IV_MAX)
2037 if (ckWARN(WARN_NUMERIC))
2040 return I_V(Atof(SvPVX_const(sv)));
2045 assert(SvTYPE(sv) >= SVt_PVMG);
2046 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2047 } else if (SvTHINKFIRST(sv)) {
2051 SV * const tmpstr=AMG_CALLun(sv,numer);
2052 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2053 return SvIV(tmpstr);
2056 return PTR2IV(SvRV(sv));
2059 sv_force_normal_flags(sv, 0);
2061 if (SvREADONLY(sv) && !SvOK(sv)) {
2062 if (ckWARN(WARN_UNINITIALIZED))
2068 if (S_sv_2iuv_common(aTHX_ sv))
2071 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2072 PTR2UV(sv),SvIVX(sv)));
2073 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2077 =for apidoc sv_2uv_flags
2079 Return the unsigned integer value of an SV, doing any necessary string
2080 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2081 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2087 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2092 if (SvGMAGICAL(sv)) {
2093 if (flags & SV_GMAGIC)
2098 return U_V(SvNVX(sv));
2099 if (SvPOKp(sv) && SvLEN(sv)) {
2102 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2104 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2105 == IS_NUMBER_IN_UV) {
2106 /* It's definitely an integer */
2107 if (!(numtype & IS_NUMBER_NEG))
2111 if (ckWARN(WARN_NUMERIC))
2114 return U_V(Atof(SvPVX_const(sv)));
2119 assert(SvTYPE(sv) >= SVt_PVMG);
2120 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2121 } else if (SvTHINKFIRST(sv)) {
2125 SV *const tmpstr = AMG_CALLun(sv,numer);
2126 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2127 return SvUV(tmpstr);
2130 return PTR2UV(SvRV(sv));
2133 sv_force_normal_flags(sv, 0);
2135 if (SvREADONLY(sv) && !SvOK(sv)) {
2136 if (ckWARN(WARN_UNINITIALIZED))
2142 if (S_sv_2iuv_common(aTHX_ sv))
2146 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2147 PTR2UV(sv),SvUVX(sv)));
2148 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2154 Return the num value of an SV, doing any necessary string or integer
2155 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2162 Perl_sv_2nv(pTHX_ register SV *sv)
2167 if (SvGMAGICAL(sv)) {
2171 if (SvPOKp(sv) && SvLEN(sv)) {
2172 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2173 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2175 return Atof(SvPVX_const(sv));
2179 return (NV)SvUVX(sv);
2181 return (NV)SvIVX(sv);
2186 assert(SvTYPE(sv) >= SVt_PVMG);
2187 /* This falls through to the report_uninit near the end of the
2189 } else if (SvTHINKFIRST(sv)) {
2193 SV *const tmpstr = AMG_CALLun(sv,numer);
2194 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2195 return SvNV(tmpstr);
2198 return PTR2NV(SvRV(sv));
2201 sv_force_normal_flags(sv, 0);
2203 if (SvREADONLY(sv) && !SvOK(sv)) {
2204 if (ckWARN(WARN_UNINITIALIZED))
2209 if (SvTYPE(sv) < SVt_NV) {
2210 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2211 sv_upgrade(sv, SVt_NV);
2212 #ifdef USE_LONG_DOUBLE
2214 STORE_NUMERIC_LOCAL_SET_STANDARD();
2215 PerlIO_printf(Perl_debug_log,
2216 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2217 PTR2UV(sv), SvNVX(sv));
2218 RESTORE_NUMERIC_LOCAL();
2222 STORE_NUMERIC_LOCAL_SET_STANDARD();
2223 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2224 PTR2UV(sv), SvNVX(sv));
2225 RESTORE_NUMERIC_LOCAL();
2229 else if (SvTYPE(sv) < SVt_PVNV)
2230 sv_upgrade(sv, SVt_PVNV);
2235 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2236 #ifdef NV_PRESERVES_UV
2239 /* Only set the public NV OK flag if this NV preserves the IV */
2240 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2241 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2242 : (SvIVX(sv) == I_V(SvNVX(sv))))
2248 else if (SvPOKp(sv) && SvLEN(sv)) {
2250 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2251 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2253 #ifdef NV_PRESERVES_UV
2254 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2255 == IS_NUMBER_IN_UV) {
2256 /* It's definitely an integer */
2257 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2259 SvNV_set(sv, Atof(SvPVX_const(sv)));
2262 SvNV_set(sv, Atof(SvPVX_const(sv)));
2263 /* Only set the public NV OK flag if this NV preserves the value in
2264 the PV at least as well as an IV/UV would.
2265 Not sure how to do this 100% reliably. */
2266 /* if that shift count is out of range then Configure's test is
2267 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2269 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2270 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2271 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2272 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2273 /* Can't use strtol etc to convert this string, so don't try.
2274 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2277 /* value has been set. It may not be precise. */
2278 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2279 /* 2s complement assumption for (UV)IV_MIN */
2280 SvNOK_on(sv); /* Integer is too negative. */
2285 if (numtype & IS_NUMBER_NEG) {
2286 SvIV_set(sv, -(IV)value);
2287 } else if (value <= (UV)IV_MAX) {
2288 SvIV_set(sv, (IV)value);
2290 SvUV_set(sv, value);
2294 if (numtype & IS_NUMBER_NOT_INT) {
2295 /* I believe that even if the original PV had decimals,
2296 they are lost beyond the limit of the FP precision.
2297 However, neither is canonical, so both only get p
2298 flags. NWC, 2000/11/25 */
2299 /* Both already have p flags, so do nothing */
2301 const NV nv = SvNVX(sv);
2302 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2303 if (SvIVX(sv) == I_V(nv)) {
2306 /* It had no "." so it must be integer. */
2310 /* between IV_MAX and NV(UV_MAX).
2311 Could be slightly > UV_MAX */
2313 if (numtype & IS_NUMBER_NOT_INT) {
2314 /* UV and NV both imprecise. */
2316 const UV nv_as_uv = U_V(nv);
2318 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2327 #endif /* NV_PRESERVES_UV */
2330 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2332 assert (SvTYPE(sv) >= SVt_NV);
2333 /* Typically the caller expects that sv_any is not NULL now. */
2334 /* XXX Ilya implies that this is a bug in callers that assume this
2335 and ideally should be fixed. */
2338 #if defined(USE_LONG_DOUBLE)
2340 STORE_NUMERIC_LOCAL_SET_STANDARD();
2341 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2342 PTR2UV(sv), SvNVX(sv));
2343 RESTORE_NUMERIC_LOCAL();
2347 STORE_NUMERIC_LOCAL_SET_STANDARD();
2348 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2349 PTR2UV(sv), SvNVX(sv));
2350 RESTORE_NUMERIC_LOCAL();
2356 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2357 * UV as a string towards the end of buf, and return pointers to start and
2360 * We assume that buf is at least TYPE_CHARS(UV) long.
2364 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2366 char *ptr = buf + TYPE_CHARS(UV);
2367 char * const ebuf = ptr;
2380 *--ptr = '0' + (char)(uv % 10);
2388 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2389 * a regexp to its stringified form.
2393 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2395 const regexp * const re = (regexp *)mg->mg_obj;
2398 const char *fptr = "msix";
2403 bool need_newline = 0;
2404 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2406 while((ch = *fptr++)) {
2408 reflags[left++] = ch;
2411 reflags[right--] = ch;
2416 reflags[left] = '-';
2420 mg->mg_len = re->prelen + 4 + left;
2422 * If /x was used, we have to worry about a regex ending with a
2423 * comment later being embedded within another regex. If so, we don't
2424 * want this regex's "commentization" to leak out to the right part of
2425 * the enclosing regex, we must cap it with a newline.
2427 * So, if /x was used, we scan backwards from the end of the regex. If
2428 * we find a '#' before we find a newline, we need to add a newline
2429 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2430 * we don't need to add anything. -jfriedl
2432 if (PMf_EXTENDED & re->reganch) {
2433 const char *endptr = re->precomp + re->prelen;
2434 while (endptr >= re->precomp) {
2435 const char c = *(endptr--);
2437 break; /* don't need another */
2439 /* we end while in a comment, so we need a newline */
2440 mg->mg_len++; /* save space for it */
2441 need_newline = 1; /* note to add it */
2447 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2448 mg->mg_ptr[0] = '(';
2449 mg->mg_ptr[1] = '?';
2450 Copy(reflags, mg->mg_ptr+2, left, char);
2451 *(mg->mg_ptr+left+2) = ':';
2452 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2454 mg->mg_ptr[mg->mg_len - 2] = '\n';
2455 mg->mg_ptr[mg->mg_len - 1] = ')';
2456 mg->mg_ptr[mg->mg_len] = 0;
2458 PL_reginterp_cnt += re->program[0].next_off;
2460 if (re->reganch & ROPT_UTF8)
2470 =for apidoc sv_2pv_flags
2472 Returns a pointer to the string value of an SV, and sets *lp to its length.
2473 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2475 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2476 usually end up here too.
2482 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2492 if (SvGMAGICAL(sv)) {
2493 if (flags & SV_GMAGIC)
2498 if (flags & SV_MUTABLE_RETURN)
2499 return SvPVX_mutable(sv);
2500 if (flags & SV_CONST_RETURN)
2501 return (char *)SvPVX_const(sv);
2504 if (SvIOKp(sv) || SvNOKp(sv)) {
2505 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2509 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2510 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2512 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2515 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2516 /* Sneaky stuff here */
2517 SV * const tsv = newSVpvn(tbuf, len);
2527 #ifdef FIXNEGATIVEZERO
2528 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2534 SvUPGRADE(sv, SVt_PV);
2537 s = SvGROW_mutable(sv, len + 1);
2540 return memcpy(s, tbuf, len + 1);
2546 assert(SvTYPE(sv) >= SVt_PVMG);
2547 /* This falls through to the report_uninit near the end of the
2549 } else if (SvTHINKFIRST(sv)) {
2553 SV *const tmpstr = AMG_CALLun(sv,string);
2554 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2556 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2560 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2561 if (flags & SV_CONST_RETURN) {
2562 pv = (char *) SvPVX_const(tmpstr);
2564 pv = (flags & SV_MUTABLE_RETURN)
2565 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2568 *lp = SvCUR(tmpstr);
2570 pv = sv_2pv_flags(tmpstr, lp, flags);
2582 const SV *const referent = (SV*)SvRV(sv);
2585 tsv = sv_2mortal(newSVpvs("NULLREF"));
2586 } else if (SvTYPE(referent) == SVt_PVMG
2587 && ((SvFLAGS(referent) &
2588 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2589 == (SVs_OBJECT|SVs_SMG))
2590 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2591 return stringify_regexp(sv, mg, lp);
2593 const char *const typestr = sv_reftype(referent, 0);
2595 tsv = sv_newmortal();
2596 if (SvOBJECT(referent)) {
2597 const char *const name = HvNAME_get(SvSTASH(referent));
2598 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2599 name ? name : "__ANON__" , typestr,
2603 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2611 if (SvREADONLY(sv) && !SvOK(sv)) {
2612 if (ckWARN(WARN_UNINITIALIZED))
2619 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2620 /* I'm assuming that if both IV and NV are equally valid then
2621 converting the IV is going to be more efficient */
2622 const U32 isIOK = SvIOK(sv);
2623 const U32 isUIOK = SvIsUV(sv);
2624 char buf[TYPE_CHARS(UV)];
2627 if (SvTYPE(sv) < SVt_PVIV)
2628 sv_upgrade(sv, SVt_PVIV);
2629 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2630 /* inlined from sv_setpvn */
2631 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2632 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2633 SvCUR_set(sv, ebuf - ptr);
2643 else if (SvNOKp(sv)) {
2644 const int olderrno = errno;
2645 if (SvTYPE(sv) < SVt_PVNV)
2646 sv_upgrade(sv, SVt_PVNV);
2647 /* The +20 is pure guesswork. Configure test needed. --jhi */
2648 s = SvGROW_mutable(sv, NV_DIG + 20);
2649 /* some Xenix systems wipe out errno here */
2651 if (SvNVX(sv) == 0.0)
2652 (void)strcpy(s,"0");
2656 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2659 #ifdef FIXNEGATIVEZERO
2660 if (*s == '-' && s[1] == '0' && !s[2])
2670 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2674 if (SvTYPE(sv) < SVt_PV)
2675 /* Typically the caller expects that sv_any is not NULL now. */
2676 sv_upgrade(sv, SVt_PV);
2680 const STRLEN len = s - SvPVX_const(sv);
2686 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2687 PTR2UV(sv),SvPVX_const(sv)));
2688 if (flags & SV_CONST_RETURN)
2689 return (char *)SvPVX_const(sv);
2690 if (flags & SV_MUTABLE_RETURN)
2691 return SvPVX_mutable(sv);
2696 =for apidoc sv_copypv
2698 Copies a stringified representation of the source SV into the
2699 destination SV. Automatically performs any necessary mg_get and
2700 coercion of numeric values into strings. Guaranteed to preserve
2701 UTF-8 flag even from overloaded objects. Similar in nature to
2702 sv_2pv[_flags] but operates directly on an SV instead of just the
2703 string. Mostly uses sv_2pv_flags to do its work, except when that
2704 would lose the UTF-8'ness of the PV.
2710 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2713 const char * const s = SvPV_const(ssv,len);
2714 sv_setpvn(dsv,s,len);
2722 =for apidoc sv_2pvbyte
2724 Return a pointer to the byte-encoded representation of the SV, and set *lp
2725 to its length. May cause the SV to be downgraded from UTF-8 as a
2728 Usually accessed via the C<SvPVbyte> macro.
2734 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2736 sv_utf8_downgrade(sv,0);
2737 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2741 =for apidoc sv_2pvutf8
2743 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2744 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2746 Usually accessed via the C<SvPVutf8> macro.
2752 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2754 sv_utf8_upgrade(sv);
2755 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2760 =for apidoc sv_2bool
2762 This function is only called on magical items, and is only used by
2763 sv_true() or its macro equivalent.
2769 Perl_sv_2bool(pTHX_ register SV *sv)
2778 SV * const tmpsv = AMG_CALLun(sv,bool_);
2779 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2780 return (bool)SvTRUE(tmpsv);
2782 return SvRV(sv) != 0;
2785 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2787 (*sv->sv_u.svu_pv > '0' ||
2788 Xpvtmp->xpv_cur > 1 ||
2789 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2796 return SvIVX(sv) != 0;
2799 return SvNVX(sv) != 0.0;
2807 =for apidoc sv_utf8_upgrade
2809 Converts the PV of an SV to its UTF-8-encoded form.
2810 Forces the SV to string form if it is not already.
2811 Always sets the SvUTF8 flag to avoid future validity checks even
2812 if all the bytes have hibit clear.
2814 This is not as a general purpose byte encoding to Unicode interface:
2815 use the Encode extension for that.
2817 =for apidoc sv_utf8_upgrade_flags
2819 Converts the PV of an SV to its UTF-8-encoded form.
2820 Forces the SV to string form if it is not already.
2821 Always sets the SvUTF8 flag to avoid future validity checks even
2822 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2823 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2824 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2826 This is not as a general purpose byte encoding to Unicode interface:
2827 use the Encode extension for that.
2833 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2836 if (sv == &PL_sv_undef)
2840 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2841 (void) sv_2pv_flags(sv,&len, flags);
2845 (void) SvPV_force(sv,len);
2854 sv_force_normal_flags(sv, 0);
2857 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2858 sv_recode_to_utf8(sv, PL_encoding);
2859 else { /* Assume Latin-1/EBCDIC */
2860 /* This function could be much more efficient if we
2861 * had a FLAG in SVs to signal if there are any hibit
2862 * chars in the PV. Given that there isn't such a flag
2863 * make the loop as fast as possible. */
2864 const U8 * const s = (U8 *) SvPVX_const(sv);
2865 const U8 * const e = (U8 *) SvEND(sv);
2870 /* Check for hi bit */
2871 if (!NATIVE_IS_INVARIANT(ch)) {
2872 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2873 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2875 SvPV_free(sv); /* No longer using what was there before. */
2876 SvPV_set(sv, (char*)recoded);
2877 SvCUR_set(sv, len - 1);
2878 SvLEN_set(sv, len); /* No longer know the real size. */
2882 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2889 =for apidoc sv_utf8_downgrade
2891 Attempts to convert the PV of an SV from characters to bytes.
2892 If the PV contains a character beyond byte, this conversion will fail;
2893 in this case, either returns false or, if C<fail_ok> is not
2896 This is not as a general purpose Unicode to byte encoding interface:
2897 use the Encode extension for that.
2903 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2906 if (SvPOKp(sv) && SvUTF8(sv)) {
2912 sv_force_normal_flags(sv, 0);
2914 s = (U8 *) SvPV(sv, len);
2915 if (!utf8_to_bytes(s, &len)) {
2920 Perl_croak(aTHX_ "Wide character in %s",
2923 Perl_croak(aTHX_ "Wide character");
2934 =for apidoc sv_utf8_encode
2936 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2937 flag off so that it looks like octets again.
2943 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2945 (void) sv_utf8_upgrade(sv);
2947 sv_force_normal_flags(sv, 0);
2949 if (SvREADONLY(sv)) {
2950 Perl_croak(aTHX_ PL_no_modify);
2956 =for apidoc sv_utf8_decode
2958 If the PV of the SV is an octet sequence in UTF-8
2959 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2960 so that it looks like a character. If the PV contains only single-byte
2961 characters, the C<SvUTF8> flag stays being off.
2962 Scans PV for validity and returns false if the PV is invalid UTF-8.
2968 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2974 /* The octets may have got themselves encoded - get them back as
2977 if (!sv_utf8_downgrade(sv, TRUE))
2980 /* it is actually just a matter of turning the utf8 flag on, but
2981 * we want to make sure everything inside is valid utf8 first.
2983 c = (const U8 *) SvPVX_const(sv);
2984 if (!is_utf8_string(c, SvCUR(sv)+1))
2986 e = (const U8 *) SvEND(sv);
2989 if (!UTF8_IS_INVARIANT(ch)) {
2999 =for apidoc sv_setsv
3001 Copies the contents of the source SV C<ssv> into the destination SV
3002 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3003 function if the source SV needs to be reused. Does not handle 'set' magic.
3004 Loosely speaking, it performs a copy-by-value, obliterating any previous
3005 content of the destination.
3007 You probably want to use one of the assortment of wrappers, such as
3008 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3009 C<SvSetMagicSV_nosteal>.
3011 =for apidoc sv_setsv_flags
3013 Copies the contents of the source SV C<ssv> into the destination SV
3014 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3015 function if the source SV needs to be reused. Does not handle 'set' magic.
3016 Loosely speaking, it performs a copy-by-value, obliterating any previous
3017 content of the destination.
3018 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3019 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3020 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3021 and C<sv_setsv_nomg> are implemented in terms of this function.
3023 You probably want to use one of the assortment of wrappers, such as
3024 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3025 C<SvSetMagicSV_nosteal>.
3027 This is the primary function for copying scalars, and most other
3028 copy-ish functions and macros use this underneath.
3034 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
3036 if (dtype != SVt_PVGV) {
3037 const char * const name = GvNAME(sstr);
3038 const STRLEN len = GvNAMELEN(sstr);
3039 /* don't upgrade SVt_PVLV: it can hold a glob */
3040 if (dtype != SVt_PVLV)
3041 sv_upgrade(dstr, SVt_PVGV);
3042 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3043 GvSTASH(dstr) = GvSTASH(sstr);
3045 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3046 GvNAME(dstr) = savepvn(name, len);
3047 GvNAMELEN(dstr) = len;
3048 SvFAKE_on(dstr); /* can coerce to non-glob */
3051 #ifdef GV_UNIQUE_CHECK
3052 if (GvUNIQUE((GV*)dstr)) {
3053 Perl_croak(aTHX_ PL_no_modify);
3057 (void)SvOK_off(dstr);
3058 GvINTRO_off(dstr); /* one-shot flag */
3060 GvGP(dstr) = gp_ref(GvGP(sstr));
3061 if (SvTAINTED(sstr))
3063 if (GvIMPORTED(dstr) != GVf_IMPORTED
3064 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3066 GvIMPORTED_on(dstr);
3073 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
3074 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3076 const int intro = GvINTRO(dstr);
3080 #ifdef GV_UNIQUE_CHECK
3081 if (GvUNIQUE((GV*)dstr)) {
3082 Perl_croak(aTHX_ PL_no_modify);
3087 GvINTRO_off(dstr); /* one-shot flag */
3088 GvLINE(dstr) = CopLINE(PL_curcop);
3089 GvEGV(dstr) = (GV*)dstr;
3092 switch (SvTYPE(sref)) {
3095 SAVEGENERICSV(GvAV(dstr));
3097 dref = (SV*)GvAV(dstr);
3098 GvAV(dstr) = (AV*)sref;
3099 if (!GvIMPORTED_AV(dstr)
3100 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3102 GvIMPORTED_AV_on(dstr);
3107 SAVEGENERICSV(GvHV(dstr));
3109 dref = (SV*)GvHV(dstr);
3110 GvHV(dstr) = (HV*)sref;
3111 if (!GvIMPORTED_HV(dstr)
3112 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3114 GvIMPORTED_HV_on(dstr);
3119 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3120 SvREFCNT_dec(GvCV(dstr));
3122 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3123 PL_sub_generation++;
3125 SAVEGENERICSV(GvCV(dstr));
3128 dref = (SV*)GvCV(dstr);
3129 if (GvCV(dstr) != (CV*)sref) {
3130 CV* const cv = GvCV(dstr);
3132 if (!GvCVGEN((GV*)dstr) &&
3133 (CvROOT(cv) || CvXSUB(cv)))
3135 /* Redefining a sub - warning is mandatory if
3136 it was a const and its value changed. */
3137 if (CvCONST(cv) && CvCONST((CV*)sref)
3138 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3139 /* They are 2 constant subroutines generated from
3140 the same constant. This probably means that
3141 they are really the "same" proxy subroutine
3142 instantiated in 2 places. Most likely this is
3143 when a constant is exported twice. Don't warn.
3146 else if (ckWARN(WARN_REDEFINE)
3148 && (!CvCONST((CV*)sref)
3149 || sv_cmp(cv_const_sv(cv),
3150 cv_const_sv((CV*)sref))))) {
3151 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3153 ? "Constant subroutine %s::%s redefined"
3154 : "Subroutine %s::%s redefined",
3155 HvNAME_get(GvSTASH((GV*)dstr)),
3156 GvENAME((GV*)dstr));
3160 cv_ckproto(cv, (GV*)dstr,
3161 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3163 GvCV(dstr) = (CV*)sref;
3164 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3165 GvASSUMECV_on(dstr);
3166 PL_sub_generation++;
3168 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3169 GvIMPORTED_CV_on(dstr);
3173 location = (SV **) &GvIOp(dstr);
3176 location = (SV **) &GvFORM(dstr);
3178 location = &GvSV(dstr);
3179 import_flag = GVf_IMPORTED_SV;
3182 SAVEGENERICSV(*location);
3186 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3187 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3188 GvFLAGS(dstr) |= import_flag;
3194 if (SvTAINTED(sstr))
3200 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3203 register U32 sflags;
3209 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3211 sstr = &PL_sv_undef;
3212 stype = SvTYPE(sstr);
3213 dtype = SvTYPE(dstr);
3218 /* need to nuke the magic */
3220 SvRMAGICAL_off(dstr);
3223 /* There's a lot of redundancy below but we're going for speed here */
3228 if (dtype != SVt_PVGV) {
3229 (void)SvOK_off(dstr);
3237 sv_upgrade(dstr, SVt_IV);
3240 sv_upgrade(dstr, SVt_PVNV);
3244 sv_upgrade(dstr, SVt_PVIV);
3247 (void)SvIOK_only(dstr);
3248 SvIV_set(dstr, SvIVX(sstr));
3251 /* SvTAINTED can only be true if the SV has taint magic, which in
3252 turn means that the SV type is PVMG (or greater). This is the
3253 case statement for SVt_IV, so this cannot be true (whatever gcov
3255 assert(!SvTAINTED(sstr));
3265 sv_upgrade(dstr, SVt_NV);
3270 sv_upgrade(dstr, SVt_PVNV);
3273 SvNV_set(dstr, SvNVX(sstr));
3274 (void)SvNOK_only(dstr);
3275 /* SvTAINTED can only be true if the SV has taint magic, which in
3276 turn means that the SV type is PVMG (or greater). This is the
3277 case statement for SVt_NV, so this cannot be true (whatever gcov
3279 assert(!SvTAINTED(sstr));
3286 sv_upgrade(dstr, SVt_RV);
3287 else if (dtype == SVt_PVGV &&
3288 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3291 if (GvIMPORTED(dstr) != GVf_IMPORTED
3292 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3294 GvIMPORTED_on(dstr);
3299 S_glob_assign(aTHX_ dstr, sstr, dtype);
3304 #ifdef PERL_OLD_COPY_ON_WRITE
3305 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3306 if (dtype < SVt_PVIV)
3307 sv_upgrade(dstr, SVt_PVIV);
3314 sv_upgrade(dstr, SVt_PV);
3317 if (dtype < SVt_PVIV)
3318 sv_upgrade(dstr, SVt_PVIV);
3321 if (dtype < SVt_PVNV)
3322 sv_upgrade(dstr, SVt_PVNV);
3329 const char * const type = sv_reftype(sstr,0);
3331 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3333 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3338 if (dtype <= SVt_PVGV) {
3339 S_glob_assign(aTHX_ dstr, sstr, dtype);
3345 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3347 if ((int)SvTYPE(sstr) != stype) {
3348 stype = SvTYPE(sstr);
3349 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3350 S_glob_assign(aTHX_ dstr, sstr, dtype);
3355 if (stype == SVt_PVLV)
3356 SvUPGRADE(dstr, SVt_PVNV);
3358 SvUPGRADE(dstr, (U32)stype);
3361 sflags = SvFLAGS(sstr);
3363 if (sflags & SVf_ROK) {
3364 if (dtype >= SVt_PV) {
3365 if (dtype == SVt_PVGV) {
3366 S_pvgv_assign(aTHX_ dstr, sstr);
3369 if (SvPVX_const(dstr)) {
3375 (void)SvOK_off(dstr);
3376 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3377 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3378 assert(!(sflags & SVp_NOK));
3379 assert(!(sflags & SVp_IOK));
3380 assert(!(sflags & SVf_NOK));
3381 assert(!(sflags & SVf_IOK));
3383 else if (sflags & SVp_POK) {
3387 * Check to see if we can just swipe the string. If so, it's a
3388 * possible small lose on short strings, but a big win on long ones.
3389 * It might even be a win on short strings if SvPVX_const(dstr)
3390 * has to be allocated and SvPVX_const(sstr) has to be freed.
3393 /* Whichever path we take through the next code, we want this true,
3394 and doing it now facilitates the COW check. */
3395 (void)SvPOK_only(dstr);
3398 /* We're not already COW */
3399 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3400 #ifndef PERL_OLD_COPY_ON_WRITE
3401 /* or we are, but dstr isn't a suitable target. */
3402 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3407 (sflags & SVs_TEMP) && /* slated for free anyway? */
3408 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3409 (!(flags & SV_NOSTEAL)) &&
3410 /* and we're allowed to steal temps */
3411 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3412 SvLEN(sstr) && /* and really is a string */
3413 /* and won't be needed again, potentially */
3414 !(PL_op && PL_op->op_type == OP_AASSIGN))
3415 #ifdef PERL_OLD_COPY_ON_WRITE
3416 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3417 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3418 && SvTYPE(sstr) >= SVt_PVIV)
3421 /* Failed the swipe test, and it's not a shared hash key either.
3422 Have to copy the string. */
3423 STRLEN len = SvCUR(sstr);
3424 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3425 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3426 SvCUR_set(dstr, len);
3427 *SvEND(dstr) = '\0';
3429 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3431 /* Either it's a shared hash key, or it's suitable for
3432 copy-on-write or we can swipe the string. */
3434 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3438 #ifdef PERL_OLD_COPY_ON_WRITE
3440 /* I believe I should acquire a global SV mutex if
3441 it's a COW sv (not a shared hash key) to stop
3442 it going un copy-on-write.
3443 If the source SV has gone un copy on write between up there
3444 and down here, then (assert() that) it is of the correct
3445 form to make it copy on write again */
3446 if ((sflags & (SVf_FAKE | SVf_READONLY))
3447 != (SVf_FAKE | SVf_READONLY)) {
3448 SvREADONLY_on(sstr);
3450 /* Make the source SV into a loop of 1.
3451 (about to become 2) */
3452 SV_COW_NEXT_SV_SET(sstr, sstr);
3456 /* Initial code is common. */
3457 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3462 /* making another shared SV. */
3463 STRLEN cur = SvCUR(sstr);
3464 STRLEN len = SvLEN(sstr);
3465 #ifdef PERL_OLD_COPY_ON_WRITE
3467 assert (SvTYPE(dstr) >= SVt_PVIV);
3468 /* SvIsCOW_normal */
3469 /* splice us in between source and next-after-source. */
3470 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3471 SV_COW_NEXT_SV_SET(sstr, dstr);
3472 SvPV_set(dstr, SvPVX_mutable(sstr));
3476 /* SvIsCOW_shared_hash */
3477 DEBUG_C(PerlIO_printf(Perl_debug_log,
3478 "Copy on write: Sharing hash\n"));
3480 assert (SvTYPE(dstr) >= SVt_PV);
3482 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3484 SvLEN_set(dstr, len);
3485 SvCUR_set(dstr, cur);
3486 SvREADONLY_on(dstr);
3488 /* Relesase a global SV mutex. */
3491 { /* Passes the swipe test. */
3492 SvPV_set(dstr, SvPVX_mutable(sstr));
3493 SvLEN_set(dstr, SvLEN(sstr));
3494 SvCUR_set(dstr, SvCUR(sstr));
3497 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3498 SvPV_set(sstr, NULL);
3504 if (sflags & SVp_NOK) {
3505 SvNV_set(dstr, SvNVX(sstr));
3507 if (sflags & SVp_IOK) {
3508 SvRELEASE_IVX(dstr);
3509 SvIV_set(dstr, SvIVX(sstr));
3510 /* Must do this otherwise some other overloaded use of 0x80000000
3511 gets confused. I guess SVpbm_VALID */
3512 if (sflags & SVf_IVisUV)
3515 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3517 const MAGIC * const smg = SvVOK(sstr);
3519 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3520 smg->mg_ptr, smg->mg_len);
3521 SvRMAGICAL_on(dstr);
3525 else if (sflags & (SVp_IOK|SVp_NOK)) {
3526 (void)SvOK_off(dstr);
3527 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3528 if (sflags & SVp_IOK) {
3529 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3530 SvIV_set(dstr, SvIVX(sstr));
3532 if (sflags & SVp_NOK) {
3533 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3534 SvNV_set(dstr, SvNVX(sstr));
3538 if (dtype == SVt_PVGV) {
3539 if (ckWARN(WARN_MISC))
3540 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3543 (void)SvOK_off(dstr);
3545 if (SvTAINTED(sstr))
3550 =for apidoc sv_setsv_mg
3552 Like C<sv_setsv>, but also handles 'set' magic.
3558 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3560 sv_setsv(dstr,sstr);
3564 #ifdef PERL_OLD_COPY_ON_WRITE
3566 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3568 STRLEN cur = SvCUR(sstr);
3569 STRLEN len = SvLEN(sstr);
3570 register char *new_pv;
3573 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3581 if (SvTHINKFIRST(dstr))
3582 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3583 else if (SvPVX_const(dstr))
3584 Safefree(SvPVX_const(dstr));
3588 SvUPGRADE(dstr, SVt_PVIV);
3590 assert (SvPOK(sstr));
3591 assert (SvPOKp(sstr));
3592 assert (!SvIOK(sstr));
3593 assert (!SvIOKp(sstr));
3594 assert (!SvNOK(sstr));
3595 assert (!SvNOKp(sstr));
3597 if (SvIsCOW(sstr)) {
3599 if (SvLEN(sstr) == 0) {
3600 /* source is a COW shared hash key. */
3601 DEBUG_C(PerlIO_printf(Perl_debug_log,
3602 "Fast copy on write: Sharing hash\n"));
3603 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3606 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3608 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3609 SvUPGRADE(sstr, SVt_PVIV);
3610 SvREADONLY_on(sstr);
3612 DEBUG_C(PerlIO_printf(Perl_debug_log,
3613 "Fast copy on write: Converting sstr to COW\n"));
3614 SV_COW_NEXT_SV_SET(dstr, sstr);
3616 SV_COW_NEXT_SV_SET(sstr, dstr);
3617 new_pv = SvPVX_mutable(sstr);
3620 SvPV_set(dstr, new_pv);
3621 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3624 SvLEN_set(dstr, len);
3625 SvCUR_set(dstr, cur);
3634 =for apidoc sv_setpvn
3636 Copies a string into an SV. The C<len> parameter indicates the number of
3637 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3638 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3644 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3647 register char *dptr;
3649 SV_CHECK_THINKFIRST_COW_DROP(sv);
3655 /* len is STRLEN which is unsigned, need to copy to signed */
3658 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3660 SvUPGRADE(sv, SVt_PV);
3662 dptr = SvGROW(sv, len + 1);
3663 Move(ptr,dptr,len,char);
3666 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3671 =for apidoc sv_setpvn_mg
3673 Like C<sv_setpvn>, but also handles 'set' magic.
3679 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3681 sv_setpvn(sv,ptr,len);
3686 =for apidoc sv_setpv
3688 Copies a string into an SV. The string must be null-terminated. Does not
3689 handle 'set' magic. See C<sv_setpv_mg>.
3695 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3698 register STRLEN len;
3700 SV_CHECK_THINKFIRST_COW_DROP(sv);
3706 SvUPGRADE(sv, SVt_PV);
3708 SvGROW(sv, len + 1);
3709 Move(ptr,SvPVX(sv),len+1,char);
3711 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3716 =for apidoc sv_setpv_mg
3718 Like C<sv_setpv>, but also handles 'set' magic.
3724 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3731 =for apidoc sv_usepvn
3733 Tells an SV to use C<ptr> to find its string value. Normally the string is
3734 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3735 The C<ptr> should point to memory that was allocated by C<malloc>. The
3736 string length, C<len>, must be supplied. This function will realloc the
3737 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3738 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3739 See C<sv_usepvn_mg>.
3745 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3749 SV_CHECK_THINKFIRST_COW_DROP(sv);
3750 SvUPGRADE(sv, SVt_PV);
3755 if (SvPVX_const(sv))
3758 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3759 ptr = saferealloc (ptr, allocate);
3762 SvLEN_set(sv, allocate);
3764 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3769 =for apidoc sv_usepvn_mg
3771 Like C<sv_usepvn>, but also handles 'set' magic.
3777 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3779 sv_usepvn(sv,ptr,len);
3783 #ifdef PERL_OLD_COPY_ON_WRITE
3784 /* Need to do this *after* making the SV normal, as we need the buffer
3785 pointer to remain valid until after we've copied it. If we let go too early,
3786 another thread could invalidate it by unsharing last of the same hash key
3787 (which it can do by means other than releasing copy-on-write Svs)
3788 or by changing the other copy-on-write SVs in the loop. */
3790 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3792 if (len) { /* this SV was SvIsCOW_normal(sv) */
3793 /* we need to find the SV pointing to us. */
3794 SV *current = SV_COW_NEXT_SV(after);
3796 if (current == sv) {
3797 /* The SV we point to points back to us (there were only two of us
3799 Hence other SV is no longer copy on write either. */
3801 SvREADONLY_off(after);
3803 /* We need to follow the pointers around the loop. */
3805 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3808 /* don't loop forever if the structure is bust, and we have
3809 a pointer into a closed loop. */
3810 assert (current != after);
3811 assert (SvPVX_const(current) == pvx);
3813 /* Make the SV before us point to the SV after us. */
3814 SV_COW_NEXT_SV_SET(current, after);
3817 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3822 Perl_sv_release_IVX(pTHX_ register SV *sv)
3825 sv_force_normal_flags(sv, 0);
3831 =for apidoc sv_force_normal_flags
3833 Undo various types of fakery on an SV: if the PV is a shared string, make
3834 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3835 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3836 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3837 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3838 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3839 set to some other value.) In addition, the C<flags> parameter gets passed to
3840 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3841 with flags set to 0.
3847 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3850 #ifdef PERL_OLD_COPY_ON_WRITE
3851 if (SvREADONLY(sv)) {
3852 /* At this point I believe I should acquire a global SV mutex. */
3854 const char * const pvx = SvPVX_const(sv);
3855 const STRLEN len = SvLEN(sv);
3856 const STRLEN cur = SvCUR(sv);
3857 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3859 PerlIO_printf(Perl_debug_log,
3860 "Copy on write: Force normal %ld\n",
3866 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3869 if (flags & SV_COW_DROP_PV) {
3870 /* OK, so we don't need to copy our buffer. */
3873 SvGROW(sv, cur + 1);
3874 Move(pvx,SvPVX(sv),cur,char);
3878 sv_release_COW(sv, pvx, len, next);
3883 else if (IN_PERL_RUNTIME)
3884 Perl_croak(aTHX_ PL_no_modify);
3885 /* At this point I believe that I can drop the global SV mutex. */
3888 if (SvREADONLY(sv)) {
3890 const char * const pvx = SvPVX_const(sv);
3891 const STRLEN len = SvCUR(sv);
3896 SvGROW(sv, len + 1);
3897 Move(pvx,SvPVX(sv),len,char);
3899 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3901 else if (IN_PERL_RUNTIME)
3902 Perl_croak(aTHX_ PL_no_modify);
3906 sv_unref_flags(sv, flags);
3907 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3914 Efficient removal of characters from the beginning of the string buffer.
3915 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3916 the string buffer. The C<ptr> becomes the first character of the adjusted
3917 string. Uses the "OOK hack".
3918 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3919 refer to the same chunk of data.
3925 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3927 register STRLEN delta;
3928 if (!ptr || !SvPOKp(sv))
3930 delta = ptr - SvPVX_const(sv);
3931 SV_CHECK_THINKFIRST(sv);
3932 if (SvTYPE(sv) < SVt_PVIV)
3933 sv_upgrade(sv,SVt_PVIV);
3936 if (!SvLEN(sv)) { /* make copy of shared string */
3937 const char *pvx = SvPVX_const(sv);
3938 const STRLEN len = SvCUR(sv);
3939 SvGROW(sv, len + 1);
3940 Move(pvx,SvPVX(sv),len,char);
3944 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3945 and we do that anyway inside the SvNIOK_off
3947 SvFLAGS(sv) |= SVf_OOK;
3950 SvLEN_set(sv, SvLEN(sv) - delta);
3951 SvCUR_set(sv, SvCUR(sv) - delta);
3952 SvPV_set(sv, SvPVX(sv) + delta);
3953 SvIV_set(sv, SvIVX(sv) + delta);
3957 =for apidoc sv_catpvn
3959 Concatenates the string onto the end of the string which is in the SV. The
3960 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3961 status set, then the bytes appended should be valid UTF-8.
3962 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3964 =for apidoc sv_catpvn_flags
3966 Concatenates the string onto the end of the string which is in the SV. The
3967 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3968 status set, then the bytes appended should be valid UTF-8.
3969 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3970 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3971 in terms of this function.
3977 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3981 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3983 SvGROW(dsv, dlen + slen + 1);
3985 sstr = SvPVX_const(dsv);
3986 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3987 SvCUR_set(dsv, SvCUR(dsv) + slen);
3989 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3991 if (flags & SV_SMAGIC)
3996 =for apidoc sv_catsv
3998 Concatenates the string from SV C<ssv> onto the end of the string in
3999 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4000 not 'set' magic. See C<sv_catsv_mg>.
4002 =for apidoc sv_catsv_flags
4004 Concatenates the string from SV C<ssv> onto the end of the string in
4005 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4006 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4007 and C<sv_catsv_nomg> are implemented in terms of this function.
4012 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4017 const char *spv = SvPV_const(ssv, slen);
4019 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4020 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4021 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4022 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4023 dsv->sv_flags doesn't have that bit set.
4024 Andy Dougherty 12 Oct 2001
4026 const I32 sutf8 = DO_UTF8(ssv);
4029 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4031 dutf8 = DO_UTF8(dsv);
4033 if (dutf8 != sutf8) {
4035 /* Not modifying source SV, so taking a temporary copy. */
4036 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4038 sv_utf8_upgrade(csv);
4039 spv = SvPV_const(csv, slen);
4042 sv_utf8_upgrade_nomg(dsv);
4044 sv_catpvn_nomg(dsv, spv, slen);
4047 if (flags & SV_SMAGIC)
4052 =for apidoc sv_catpv
4054 Concatenates the string onto the end of the string which is in the SV.
4055 If the SV has the UTF-8 status set, then the bytes appended should be
4056 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4061 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4064 register STRLEN len;
4070 junk = SvPV_force(sv, tlen);
4072 SvGROW(sv, tlen + len + 1);
4074 ptr = SvPVX_const(sv);
4075 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4076 SvCUR_set(sv, SvCUR(sv) + len);
4077 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4082 =for apidoc sv_catpv_mg
4084 Like C<sv_catpv>, but also handles 'set' magic.
4090 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4099 Creates a new SV. A non-zero C<len> parameter indicates the number of
4100 bytes of preallocated string space the SV should have. An extra byte for a
4101 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4102 space is allocated.) The reference count for the new SV is set to 1.
4104 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4105 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4106 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4107 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4108 modules supporting older perls.
4114 Perl_newSV(pTHX_ STRLEN len)
4121 sv_upgrade(sv, SVt_PV);
4122 SvGROW(sv, len + 1);
4127 =for apidoc sv_magicext
4129 Adds magic to an SV, upgrading it if necessary. Applies the
4130 supplied vtable and returns a pointer to the magic added.
4132 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4133 In particular, you can add magic to SvREADONLY SVs, and add more than
4134 one instance of the same 'how'.
4136 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4137 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4138 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4139 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4141 (This is now used as a subroutine by C<sv_magic>.)
4146 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4147 const char* name, I32 namlen)
4152 if (SvTYPE(sv) < SVt_PVMG) {
4153 SvUPGRADE(sv, SVt_PVMG);
4155 Newxz(mg, 1, MAGIC);
4156 mg->mg_moremagic = SvMAGIC(sv);
4157 SvMAGIC_set(sv, mg);
4159 /* Sometimes a magic contains a reference loop, where the sv and
4160 object refer to each other. To prevent a reference loop that
4161 would prevent such objects being freed, we look for such loops
4162 and if we find one we avoid incrementing the object refcount.
4164 Note we cannot do this to avoid self-tie loops as intervening RV must
4165 have its REFCNT incremented to keep it in existence.
4168 if (!obj || obj == sv ||
4169 how == PERL_MAGIC_arylen ||
4170 how == PERL_MAGIC_qr ||
4171 how == PERL_MAGIC_symtab ||
4172 (SvTYPE(obj) == SVt_PVGV &&
4173 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4174 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4175 GvFORM(obj) == (CV*)sv)))
4180 mg->mg_obj = SvREFCNT_inc(obj);
4181 mg->mg_flags |= MGf_REFCOUNTED;
4184 /* Normal self-ties simply pass a null object, and instead of
4185 using mg_obj directly, use the SvTIED_obj macro to produce a
4186 new RV as needed. For glob "self-ties", we are tieing the PVIO
4187 with an RV obj pointing to the glob containing the PVIO. In
4188 this case, to avoid a reference loop, we need to weaken the
4192 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4193 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4199 mg->mg_len = namlen;
4202 mg->mg_ptr = savepvn(name, namlen);
4203 else if (namlen == HEf_SVKEY)
4204 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4206 mg->mg_ptr = (char *) name;
4208 mg->mg_virtual = vtable;
4212 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4217 =for apidoc sv_magic
4219 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4220 then adds a new magic item of type C<how> to the head of the magic list.
4222 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4223 handling of the C<name> and C<namlen> arguments.
4225 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4226 to add more than one instance of the same 'how'.
4232 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4238 #ifdef PERL_OLD_COPY_ON_WRITE
4240 sv_force_normal_flags(sv, 0);
4242 if (SvREADONLY(sv)) {
4244 /* its okay to attach magic to shared strings; the subsequent
4245 * upgrade to PVMG will unshare the string */
4246 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4249 && how != PERL_MAGIC_regex_global
4250 && how != PERL_MAGIC_bm
4251 && how != PERL_MAGIC_fm
4252 && how != PERL_MAGIC_sv
4253 && how != PERL_MAGIC_backref
4256 Perl_croak(aTHX_ PL_no_modify);
4259 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4260 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4261 /* sv_magic() refuses to add a magic of the same 'how' as an
4264 if (how == PERL_MAGIC_taint)
4272 vtable = &PL_vtbl_sv;
4274 case PERL_MAGIC_overload:
4275 vtable = &PL_vtbl_amagic;
4277 case PERL_MAGIC_overload_elem:
4278 vtable = &PL_vtbl_amagicelem;
4280 case PERL_MAGIC_overload_table:
4281 vtable = &PL_vtbl_ovrld;
4284 vtable = &PL_vtbl_bm;
4286 case PERL_MAGIC_regdata:
4287 vtable = &PL_vtbl_regdata;
4289 case PERL_MAGIC_regdatum:
4290 vtable = &PL_vtbl_regdatum;
4292 case PERL_MAGIC_env:
4293 vtable = &PL_vtbl_env;
4296 vtable = &PL_vtbl_fm;
4298 case PERL_MAGIC_envelem:
4299 vtable = &PL_vtbl_envelem;
4301 case PERL_MAGIC_regex_global:
4302 vtable = &PL_vtbl_mglob;
4304 case PERL_MAGIC_isa:
4305 vtable = &PL_vtbl_isa;
4307 case PERL_MAGIC_isaelem:
4308 vtable = &PL_vtbl_isaelem;
4310 case PERL_MAGIC_nkeys:
4311 vtable = &PL_vtbl_nkeys;
4313 case PERL_MAGIC_dbfile:
4316 case PERL_MAGIC_dbline:
4317 vtable = &PL_vtbl_dbline;
4319 #ifdef USE_LOCALE_COLLATE
4320 case PERL_MAGIC_collxfrm:
4321 vtable = &PL_vtbl_collxfrm;
4323 #endif /* USE_LOCALE_COLLATE */
4324 case PERL_MAGIC_tied:
4325 vtable = &PL_vtbl_pack;
4327 case PERL_MAGIC_tiedelem:
4328 case PERL_MAGIC_tiedscalar:
4329 vtable = &PL_vtbl_packelem;
4332 vtable = &PL_vtbl_regexp;
4334 case PERL_MAGIC_sig:
4335 vtable = &PL_vtbl_sig;
4337 case PERL_MAGIC_sigelem:
4338 vtable = &PL_vtbl_sigelem;
4340 case PERL_MAGIC_taint:
4341 vtable = &PL_vtbl_taint;
4343 case PERL_MAGIC_uvar:
4344 vtable = &PL_vtbl_uvar;
4346 case PERL_MAGIC_vec:
4347 vtable = &PL_vtbl_vec;
4349 case PERL_MAGIC_arylen_p:
4350 case PERL_MAGIC_rhash:
4351 case PERL_MAGIC_symtab:
4352 case PERL_MAGIC_vstring:
4355 case PERL_MAGIC_utf8:
4356 vtable = &PL_vtbl_utf8;
4358 case PERL_MAGIC_substr:
4359 vtable = &PL_vtbl_substr;
4361 case PERL_MAGIC_defelem:
4362 vtable = &PL_vtbl_defelem;
4364 case PERL_MAGIC_glob:
4365 vtable = &PL_vtbl_glob;
4367 case PERL_MAGIC_arylen:
4368 vtable = &PL_vtbl_arylen;
4370 case PERL_MAGIC_pos:
4371 vtable = &PL_vtbl_pos;
4373 case PERL_MAGIC_backref:
4374 vtable = &PL_vtbl_backref;
4376 case PERL_MAGIC_ext:
4377 /* Reserved for use by extensions not perl internals. */
4378 /* Useful for attaching extension internal data to perl vars. */
4379 /* Note that multiple extensions may clash if magical scalars */
4380 /* etc holding private data from one are passed to another. */
4384 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4387 /* Rest of work is done else where */
4388 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4391 case PERL_MAGIC_taint:
4394 case PERL_MAGIC_ext:
4395 case PERL_MAGIC_dbfile:
4402 =for apidoc sv_unmagic
4404 Removes all magic of type C<type> from an SV.
4410 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4414 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4417 for (mg = *mgp; mg; mg = *mgp) {
4418 if (mg->mg_type == type) {
4419 const MGVTBL* const vtbl = mg->mg_virtual;
4420 *mgp = mg->mg_moremagic;
4421 if (vtbl && vtbl->svt_free)
4422 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4423 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4425 Safefree(mg->mg_ptr);
4426 else if (mg->mg_len == HEf_SVKEY)
4427 SvREFCNT_dec((SV*)mg->mg_ptr);
4428 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4429 Safefree(mg->mg_ptr);
4431 if (mg->mg_flags & MGf_REFCOUNTED)
4432 SvREFCNT_dec(mg->mg_obj);
4436 mgp = &mg->mg_moremagic;
4440 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4441 SvMAGIC_set(sv, NULL);
4448 =for apidoc sv_rvweaken
4450 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4451 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4452 push a back-reference to this RV onto the array of backreferences
4453 associated with that magic.
4459 Perl_sv_rvweaken(pTHX_ SV *sv)
4462 if (!SvOK(sv)) /* let undefs pass */
4465 Perl_croak(aTHX_ "Can't weaken a nonreference");
4466 else if (SvWEAKREF(sv)) {
4467 if (ckWARN(WARN_MISC))
4468 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4472 Perl_sv_add_backref(aTHX_ tsv, sv);
4478 /* Give tsv backref magic if it hasn't already got it, then push a
4479 * back-reference to sv onto the array associated with the backref magic.
4483 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4488 if (SvTYPE(tsv) == SVt_PVHV) {
4489 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4493 /* There is no AV in the offical place - try a fixup. */
4494 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4497 /* Aha. They've got it stowed in magic. Bring it back. */
4498 av = (AV*)mg->mg_obj;
4499 /* Stop mg_free decreasing the refernce count. */
4501 /* Stop mg_free even calling the destructor, given that
4502 there's no AV to free up. */
4504 sv_unmagic(tsv, PERL_MAGIC_backref);
4513 const MAGIC *const mg
4514 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4516 av = (AV*)mg->mg_obj;
4520 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4521 /* av now has a refcnt of 2, which avoids it getting freed
4522 * before us during global cleanup. The extra ref is removed
4523 * by magic_killbackrefs() when tsv is being freed */
4526 if (AvFILLp(av) >= AvMAX(av)) {
4527 av_extend(av, AvFILLp(av)+1);
4529 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4532 /* delete a back-reference to ourselves from the backref magic associated
4533 * with the SV we point to.
4537 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4544 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4545 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4546 /* We mustn't attempt to "fix up" the hash here by moving the
4547 backreference array back to the hv_aux structure, as that is stored
4548 in the main HvARRAY(), and hfreentries assumes that no-one
4549 reallocates HvARRAY() while it is running. */
4552 const MAGIC *const mg
4553 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4555 av = (AV *)mg->mg_obj;
4558 if (PL_in_clean_all)
4560 Perl_croak(aTHX_ "panic: del_backref");
4567 /* We shouldn't be in here more than once, but for paranoia reasons lets
4569 for (i = AvFILLp(av); i >= 0; i--) {
4571 const SSize_t fill = AvFILLp(av);
4573 /* We weren't the last entry.
4574 An unordered list has this property that you can take the
4575 last element off the end to fill the hole, and it's still
4576 an unordered list :-)
4581 AvFILLp(av) = fill - 1;
4587 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4589 SV **svp = AvARRAY(av);
4591 PERL_UNUSED_ARG(sv);
4593 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4594 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4595 if (svp && !SvIS_FREED(av)) {
4596 SV *const *const last = svp + AvFILLp(av);
4598 while (svp <= last) {
4600 SV *const referrer = *svp;
4601 if (SvWEAKREF(referrer)) {
4602 /* XXX Should we check that it hasn't changed? */
4603 SvRV_set(referrer, 0);
4605 SvWEAKREF_off(referrer);
4606 } else if (SvTYPE(referrer) == SVt_PVGV ||
4607 SvTYPE(referrer) == SVt_PVLV) {
4608 /* You lookin' at me? */
4609 assert(GvSTASH(referrer));
4610 assert(GvSTASH(referrer) == (HV*)sv);
4611 GvSTASH(referrer) = 0;
4614 "panic: magic_killbackrefs (flags=%"UVxf")",
4615 (UV)SvFLAGS(referrer));
4623 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4628 =for apidoc sv_insert
4630 Inserts a string at the specified offset/length within the SV. Similar to
4631 the Perl substr() function.
4637 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4642 register char *midend;
4643 register char *bigend;
4649 Perl_croak(aTHX_ "Can't modify non-existent substring");
4650 SvPV_force(bigstr, curlen);
4651 (void)SvPOK_only_UTF8(bigstr);
4652 if (offset + len > curlen) {
4653 SvGROW(bigstr, offset+len+1);
4654 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4655 SvCUR_set(bigstr, offset+len);
4659 i = littlelen - len;
4660 if (i > 0) { /* string might grow */
4661 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4662 mid = big + offset + len;
4663 midend = bigend = big + SvCUR(bigstr);
4666 while (midend > mid) /* shove everything down */
4667 *--bigend = *--midend;
4668 Move(little,big+offset,littlelen,char);
4669 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4674 Move(little,SvPVX(bigstr)+offset,len,char);
4679 big = SvPVX(bigstr);
4682 bigend = big + SvCUR(bigstr);
4684 if (midend > bigend)
4685 Perl_croak(aTHX_ "panic: sv_insert");
4687 if (mid - big > bigend - midend) { /* faster to shorten from end */
4689 Move(little, mid, littlelen,char);
4692 i = bigend - midend;
4694 Move(midend, mid, i,char);
4698 SvCUR_set(bigstr, mid - big);
4700 else if ((i = mid - big)) { /* faster from front */
4701 midend -= littlelen;
4703 sv_chop(bigstr,midend-i);
4708 Move(little, mid, littlelen,char);
4710 else if (littlelen) {
4711 midend -= littlelen;
4712 sv_chop(bigstr,midend);
4713 Move(little,midend,littlelen,char);
4716 sv_chop(bigstr,midend);
4722 =for apidoc sv_replace
4724 Make the first argument a copy of the second, then delete the original.
4725 The target SV physically takes over ownership of the body of the source SV
4726 and inherits its flags; however, the target keeps any magic it owns,
4727 and any magic in the source is discarded.
4728 Note that this is a rather specialist SV copying operation; most of the
4729 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4735 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4738 const U32 refcnt = SvREFCNT(sv);
4739 SV_CHECK_THINKFIRST_COW_DROP(sv);
4740 if (SvREFCNT(nsv) != 1) {
4741 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4742 UVuf " != 1)", (UV) SvREFCNT(nsv));
4744 if (SvMAGICAL(sv)) {
4748 sv_upgrade(nsv, SVt_PVMG);
4749 SvMAGIC_set(nsv, SvMAGIC(sv));
4750 SvFLAGS(nsv) |= SvMAGICAL(sv);
4752 SvMAGIC_set(sv, NULL);
4756 assert(!SvREFCNT(sv));
4757 #ifdef DEBUG_LEAKING_SCALARS
4758 sv->sv_flags = nsv->sv_flags;
4759 sv->sv_any = nsv->sv_any;
4760 sv->sv_refcnt = nsv->sv_refcnt;
4761 sv->sv_u = nsv->sv_u;
4763 StructCopy(nsv,sv,SV);
4765 /* Currently could join these into one piece of pointer arithmetic, but
4766 it would be unclear. */
4767 if(SvTYPE(sv) == SVt_IV)
4769 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4770 else if (SvTYPE(sv) == SVt_RV) {
4771 SvANY(sv) = &sv->sv_u.svu_rv;
4775 #ifdef PERL_OLD_COPY_ON_WRITE
4776 if (SvIsCOW_normal(nsv)) {
4777 /* We need to follow the pointers around the loop to make the
4778 previous SV point to sv, rather than nsv. */
4781 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4784 assert(SvPVX_const(current) == SvPVX_const(nsv));
4786 /* Make the SV before us point to the SV after us. */
4788 PerlIO_printf(Perl_debug_log, "previous is\n");
4790 PerlIO_printf(Perl_debug_log,
4791 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4792 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4794 SV_COW_NEXT_SV_SET(current, sv);
4797 SvREFCNT(sv) = refcnt;
4798 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4804 =for apidoc sv_clear
4806 Clear an SV: call any destructors, free up any memory used by the body,
4807 and free the body itself. The SV's head is I<not> freed, although
4808 its type is set to all 1's so that it won't inadvertently be assumed
4809 to be live during global destruction etc.
4810 This function should only be called when REFCNT is zero. Most of the time
4811 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4818 Perl_sv_clear(pTHX_ register SV *sv)
4821 const U32 type = SvTYPE(sv);
4822 const struct body_details *const sv_type_details
4823 = bodies_by_type + type;
4826 assert(SvREFCNT(sv) == 0);
4832 if (PL_defstash) { /* Still have a symbol table? */
4837 stash = SvSTASH(sv);
4838 destructor = StashHANDLER(stash,DESTROY);
4840 SV* const tmpref = newRV(sv);
4841 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4843 PUSHSTACKi(PERLSI_DESTROY);
4848 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4854 if(SvREFCNT(tmpref) < 2) {
4855 /* tmpref is not kept alive! */
4857 SvRV_set(tmpref, NULL);
4860 SvREFCNT_dec(tmpref);
4862 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4866 if (PL_in_clean_objs)
4867 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4869 /* DESTROY gave object new lease on life */
4875 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4876 SvOBJECT_off(sv); /* Curse the object. */
4877 if (type != SVt_PVIO)
4878 --PL_sv_objcount; /* XXX Might want something more general */
4881 if (type >= SVt_PVMG) {
4884 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4885 SvREFCNT_dec(SvSTASH(sv));
4890 IoIFP(sv) != PerlIO_stdin() &&
4891 IoIFP(sv) != PerlIO_stdout() &&
4892 IoIFP(sv) != PerlIO_stderr())
4894 io_close((IO*)sv, FALSE);
4896 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4897 PerlDir_close(IoDIRP(sv));
4898 IoDIRP(sv) = (DIR*)NULL;
4899 Safefree(IoTOP_NAME(sv));
4900 Safefree(IoFMT_NAME(sv));
4901 Safefree(IoBOTTOM_NAME(sv));
4910 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4917 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4918 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4919 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4920 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4922 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4923 SvREFCNT_dec(LvTARG(sv));
4927 Safefree(GvNAME(sv));
4928 /* If we're in a stash, we don't own a reference to it. However it does
4929 have a back reference to us, which needs to be cleared. */
4931 sv_del_backref((SV*)GvSTASH(sv), sv);
4936 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4938 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4939 /* Don't even bother with turning off the OOK flag. */
4944 SV *target = SvRV(sv);
4946 sv_del_backref(target, sv);
4948 SvREFCNT_dec(target);
4950 #ifdef PERL_OLD_COPY_ON_WRITE
4951 else if (SvPVX_const(sv)) {
4953 /* I believe I need to grab the global SV mutex here and
4954 then recheck the COW status. */
4956 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4959 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4960 SV_COW_NEXT_SV(sv));
4961 /* And drop it here. */
4963 } else if (SvLEN(sv)) {
4964 Safefree(SvPVX_const(sv));
4968 else if (SvPVX_const(sv) && SvLEN(sv))
4969 Safefree(SvPVX_mutable(sv));
4970 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4971 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4980 SvFLAGS(sv) &= SVf_BREAK;
4981 SvFLAGS(sv) |= SVTYPEMASK;
4983 if (sv_type_details->arena) {
4984 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4985 &PL_body_roots[type]);
4987 else if (sv_type_details->size) {
4988 my_safefree(SvANY(sv));
4993 =for apidoc sv_newref
4995 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5002 Perl_sv_newref(pTHX_ SV *sv)
5012 Decrement an SV's reference count, and if it drops to zero, call
5013 C<sv_clear> to invoke destructors and free up any memory used by
5014 the body; finally, deallocate the SV's head itself.
5015 Normally called via a wrapper macro C<SvREFCNT_dec>.
5021 Perl_sv_free(pTHX_ SV *sv)
5026 if (SvREFCNT(sv) == 0) {
5027 if (SvFLAGS(sv) & SVf_BREAK)
5028 /* this SV's refcnt has been artificially decremented to
5029 * trigger cleanup */
5031 if (PL_in_clean_all) /* All is fair */
5033 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5034 /* make sure SvREFCNT(sv)==0 happens very seldom */
5035 SvREFCNT(sv) = (~(U32)0)/2;
5038 if (ckWARN_d(WARN_INTERNAL)) {
5039 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5040 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5041 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5042 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5043 Perl_dump_sv_child(aTHX_ sv);
5048 if (--(SvREFCNT(sv)) > 0)
5050 Perl_sv_free2(aTHX_ sv);
5054 Perl_sv_free2(pTHX_ SV *sv)
5059 if (ckWARN_d(WARN_DEBUGGING))
5060 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5061 "Attempt to free temp prematurely: SV 0x%"UVxf
5062 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5066 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5067 /* make sure SvREFCNT(sv)==0 happens very seldom */
5068 SvREFCNT(sv) = (~(U32)0)/2;
5079 Returns the length of the string in the SV. Handles magic and type
5080 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5086 Perl_sv_len(pTHX_ register SV *sv)
5094 len = mg_length(sv);
5096 (void)SvPV_const(sv, len);
5101 =for apidoc sv_len_utf8
5103 Returns the number of characters in the string in an SV, counting wide
5104 UTF-8 bytes as a single character. Handles magic and type coercion.
5110 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5111 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5112 * (Note that the mg_len is not the length of the mg_ptr field.)
5117 Perl_sv_len_utf8(pTHX_ register SV *sv)
5123 return mg_length(sv);
5127 const U8 *s = (U8*)SvPV_const(sv, len);
5128 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5130 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5132 #ifdef PERL_UTF8_CACHE_ASSERT
5133 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5137 ulen = Perl_utf8_length(aTHX_ s, s + len);
5138 if (!mg && !SvREADONLY(sv)) {
5139 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5140 mg = mg_find(sv, PERL_MAGIC_utf8);
5150 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5151 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5152 * between UTF-8 and byte offsets. There are two (substr offset and substr
5153 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5154 * and byte offset) cache positions.
5156 * The mg_len field is used by sv_len_utf8(), see its comments.
5157 * Note that the mg_len is not the length of the mg_ptr field.
5161 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5162 I32 offsetp, const U8 *s, const U8 *start)
5166 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5168 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5172 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5174 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5175 (*mgp)->mg_ptr = (char *) *cachep;
5179 (*cachep)[i] = offsetp;
5180 (*cachep)[i+1] = s - start;
5188 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5189 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5190 * between UTF-8 and byte offsets. See also the comments of
5191 * S_utf8_mg_pos_init().
5195 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)
5199 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5201 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5202 if (*mgp && (*mgp)->mg_ptr) {
5203 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5204 ASSERT_UTF8_CACHE(*cachep);
5205 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5207 else { /* We will skip to the right spot. */
5212 /* The assumption is that going backward is half
5213 * the speed of going forward (that's where the
5214 * 2 * backw in the below comes from). (The real
5215 * figure of course depends on the UTF-8 data.) */
5217 if ((*cachep)[i] > (STRLEN)uoff) {
5219 backw = (*cachep)[i] - (STRLEN)uoff;
5221 if (forw < 2 * backw)
5224 p = start + (*cachep)[i+1];
5226 /* Try this only for the substr offset (i == 0),
5227 * not for the substr length (i == 2). */
5228 else if (i == 0) { /* (*cachep)[i] < uoff */
5229 const STRLEN ulen = sv_len_utf8(sv);
5231 if ((STRLEN)uoff < ulen) {
5232 forw = (STRLEN)uoff - (*cachep)[i];
5233 backw = ulen - (STRLEN)uoff;
5235 if (forw < 2 * backw)
5236 p = start + (*cachep)[i+1];
5241 /* If the string is not long enough for uoff,
5242 * we could extend it, but not at this low a level. */
5246 if (forw < 2 * backw) {
5253 while (UTF8_IS_CONTINUATION(*p))
5258 /* Update the cache. */
5259 (*cachep)[i] = (STRLEN)uoff;
5260 (*cachep)[i+1] = p - start;
5262 /* Drop the stale "length" cache */
5271 if (found) { /* Setup the return values. */
5272 *offsetp = (*cachep)[i+1];
5273 *sp = start + *offsetp;
5276 *offsetp = send - start;
5278 else if (*sp < start) {
5284 #ifdef PERL_UTF8_CACHE_ASSERT
5289 while (n-- && s < send)
5293 assert(*offsetp == s - start);
5294 assert((*cachep)[0] == (STRLEN)uoff);
5295 assert((*cachep)[1] == *offsetp);
5297 ASSERT_UTF8_CACHE(*cachep);
5306 =for apidoc sv_pos_u2b
5308 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5309 the start of the string, to a count of the equivalent number of bytes; if
5310 lenp is non-zero, it does the same to lenp, but this time starting from
5311 the offset, rather than from the start of the string. Handles magic and
5318 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5319 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5320 * byte offsets. See also the comments of S_utf8_mg_pos().
5325 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5333 start = (U8*)SvPV_const(sv, len);
5336 STRLEN *cache = NULL;
5337 const U8 *s = start;
5338 I32 uoffset = *offsetp;
5339 const U8 * const send = s + len;
5341 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5343 if (!found && uoffset > 0) {
5344 while (s < send && uoffset--)
5348 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5350 *offsetp = s - start;
5355 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5359 if (!found && *lenp > 0) {
5362 while (s < send && ulen--)
5366 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5370 ASSERT_UTF8_CACHE(cache);
5382 =for apidoc sv_pos_b2u
5384 Converts the value pointed to by offsetp from a count of bytes from the
5385 start of the string, to a count of the equivalent number of UTF-8 chars.
5386 Handles magic and type coercion.
5392 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5393 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5394 * byte offsets. See also the comments of S_utf8_mg_pos().
5399 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5407 s = (const U8*)SvPV_const(sv, len);
5408 if ((I32)len < *offsetp)
5409 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5411 const U8* send = s + *offsetp;
5413 STRLEN *cache = NULL;
5417 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5418 mg = mg_find(sv, PERL_MAGIC_utf8);
5419 if (mg && mg->mg_ptr) {
5420 cache = (STRLEN *) mg->mg_ptr;
5421 if (cache[1] == (STRLEN)*offsetp) {
5422 /* An exact match. */
5423 *offsetp = cache[0];
5427 else if (cache[1] < (STRLEN)*offsetp) {
5428 /* We already know part of the way. */
5431 /* Let the below loop do the rest. */
5433 else { /* cache[1] > *offsetp */
5434 /* We already know all of the way, now we may
5435 * be able to walk back. The same assumption
5436 * is made as in S_utf8_mg_pos(), namely that
5437 * walking backward is twice slower than
5438 * walking forward. */
5439 const STRLEN forw = *offsetp;
5440 STRLEN backw = cache[1] - *offsetp;
5442 if (!(forw < 2 * backw)) {
5443 const U8 *p = s + cache[1];
5450 while (UTF8_IS_CONTINUATION(*p)) {
5458 *offsetp = cache[0];
5460 /* Drop the stale "length" cache */
5468 ASSERT_UTF8_CACHE(cache);
5474 /* Call utf8n_to_uvchr() to validate the sequence
5475 * (unless a simple non-UTF character) */
5476 if (!UTF8_IS_INVARIANT(*s))
5477 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5486 if (!SvREADONLY(sv)) {
5488 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5489 mg = mg_find(sv, PERL_MAGIC_utf8);
5494 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5495 mg->mg_ptr = (char *) cache;
5500 cache[1] = *offsetp;
5501 /* Drop the stale "length" cache */
5514 Returns a boolean indicating whether the strings in the two SVs are
5515 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5516 coerce its args to strings if necessary.
5522 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5531 SV* svrecode = NULL;
5538 pv1 = SvPV_const(sv1, cur1);
5545 pv2 = SvPV_const(sv2, cur2);
5547 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5548 /* Differing utf8ness.
5549 * Do not UTF8size the comparands as a side-effect. */
5552 svrecode = newSVpvn(pv2, cur2);
5553 sv_recode_to_utf8(svrecode, PL_encoding);
5554 pv2 = SvPV_const(svrecode, cur2);
5557 svrecode = newSVpvn(pv1, cur1);
5558 sv_recode_to_utf8(svrecode, PL_encoding);
5559 pv1 = SvPV_const(svrecode, cur1);
5561 /* Now both are in UTF-8. */
5563 SvREFCNT_dec(svrecode);
5568 bool is_utf8 = TRUE;
5571 /* sv1 is the UTF-8 one,
5572 * if is equal it must be downgrade-able */
5573 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5579 /* sv2 is the UTF-8 one,
5580 * if is equal it must be downgrade-able */
5581 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5587 /* Downgrade not possible - cannot be eq */
5595 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5598 SvREFCNT_dec(svrecode);
5609 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5610 string in C<sv1> is less than, equal to, or greater than the string in
5611 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5612 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5618 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5622 const char *pv1, *pv2;
5625 SV *svrecode = NULL;
5632 pv1 = SvPV_const(sv1, cur1);
5639 pv2 = SvPV_const(sv2, cur2);
5641 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5642 /* Differing utf8ness.
5643 * Do not UTF8size the comparands as a side-effect. */
5646 svrecode = newSVpvn(pv2, cur2);
5647 sv_recode_to_utf8(svrecode, PL_encoding);
5648 pv2 = SvPV_const(svrecode, cur2);
5651 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5656 svrecode = newSVpvn(pv1, cur1);
5657 sv_recode_to_utf8(svrecode, PL_encoding);
5658 pv1 = SvPV_const(svrecode, cur1);
5661 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5667 cmp = cur2 ? -1 : 0;
5671 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5674 cmp = retval < 0 ? -1 : 1;
5675 } else if (cur1 == cur2) {
5678 cmp = cur1 < cur2 ? -1 : 1;
5683 SvREFCNT_dec(svrecode);
5692 =for apidoc sv_cmp_locale
5694 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5695 'use bytes' aware, handles get magic, and will coerce its args to strings
5696 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5702 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5705 #ifdef USE_LOCALE_COLLATE
5711 if (PL_collation_standard)
5715 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5717 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5719 if (!pv1 || !len1) {
5730 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5733 return retval < 0 ? -1 : 1;
5736 * When the result of collation is equality, that doesn't mean
5737 * that there are no differences -- some locales exclude some
5738 * characters from consideration. So to avoid false equalities,
5739 * we use the raw string as a tiebreaker.
5745 #endif /* USE_LOCALE_COLLATE */
5747 return sv_cmp(sv1, sv2);
5751 #ifdef USE_LOCALE_COLLATE
5754 =for apidoc sv_collxfrm
5756 Add Collate Transform magic to an SV if it doesn't already have it.
5758 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5759 scalar data of the variable, but transformed to such a format that a normal
5760 memory comparison can be used to compare the data according to the locale
5767 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5772 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5773 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5779 Safefree(mg->mg_ptr);
5780 s = SvPV_const(sv, len);
5781 if ((xf = mem_collxfrm(s, len, &xlen))) {
5782 if (SvREADONLY(sv)) {
5785 return xf + sizeof(PL_collation_ix);
5788 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5789 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5802 if (mg && mg->mg_ptr) {
5804 return mg->mg_ptr + sizeof(PL_collation_ix);
5812 #endif /* USE_LOCALE_COLLATE */
5817 Get a line from the filehandle and store it into the SV, optionally
5818 appending to the currently-stored string.
5824 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5829 register STDCHAR rslast;
5830 register STDCHAR *bp;
5836 if (SvTHINKFIRST(sv))
5837 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5838 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5840 However, perlbench says it's slower, because the existing swipe code
5841 is faster than copy on write.
5842 Swings and roundabouts. */
5843 SvUPGRADE(sv, SVt_PV);
5848 if (PerlIO_isutf8(fp)) {
5850 sv_utf8_upgrade_nomg(sv);
5851 sv_pos_u2b(sv,&append,0);
5853 } else if (SvUTF8(sv)) {
5854 SV * const tsv = newSV(0);
5855 sv_gets(tsv, fp, 0);
5856 sv_utf8_upgrade_nomg(tsv);
5857 SvCUR_set(sv,append);
5860 goto return_string_or_null;
5865 if (PerlIO_isutf8(fp))
5868 if (IN_PERL_COMPILETIME) {
5869 /* we always read code in line mode */
5873 else if (RsSNARF(PL_rs)) {
5874 /* If it is a regular disk file use size from stat() as estimate
5875 of amount we are going to read - may result in malloc-ing
5876 more memory than we realy need if layers bellow reduce
5877 size we read (e.g. CRLF or a gzip layer)
5880 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5881 const Off_t offset = PerlIO_tell(fp);
5882 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5883 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5889 else if (RsRECORD(PL_rs)) {
5893 /* Grab the size of the record we're getting */
5894 recsize = SvIV(SvRV(PL_rs));
5895 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5898 /* VMS wants read instead of fread, because fread doesn't respect */
5899 /* RMS record boundaries. This is not necessarily a good thing to be */
5900 /* doing, but we've got no other real choice - except avoid stdio
5901 as implementation - perhaps write a :vms layer ?
5903 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5905 bytesread = PerlIO_read(fp, buffer, recsize);
5909 SvCUR_set(sv, bytesread += append);
5910 buffer[bytesread] = '\0';
5911 goto return_string_or_null;
5913 else if (RsPARA(PL_rs)) {
5919 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5920 if (PerlIO_isutf8(fp)) {
5921 rsptr = SvPVutf8(PL_rs, rslen);
5924 if (SvUTF8(PL_rs)) {
5925 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5926 Perl_croak(aTHX_ "Wide character in $/");
5929 rsptr = SvPV_const(PL_rs, rslen);
5933 rslast = rslen ? rsptr[rslen - 1] : '\0';
5935 if (rspara) { /* have to do this both before and after */
5936 do { /* to make sure file boundaries work right */
5939 i = PerlIO_getc(fp);
5943 PerlIO_ungetc(fp,i);
5949 /* See if we know enough about I/O mechanism to cheat it ! */
5951 /* This used to be #ifdef test - it is made run-time test for ease
5952 of abstracting out stdio interface. One call should be cheap
5953 enough here - and may even be a macro allowing compile
5957 if (PerlIO_fast_gets(fp)) {
5960 * We're going to steal some values from the stdio struct
5961 * and put EVERYTHING in the innermost loop into registers.
5963 register STDCHAR *ptr;
5967 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5968 /* An ungetc()d char is handled separately from the regular
5969 * buffer, so we getc() it back out and stuff it in the buffer.
5971 i = PerlIO_getc(fp);
5972 if (i == EOF) return 0;
5973 *(--((*fp)->_ptr)) = (unsigned char) i;
5977 /* Here is some breathtakingly efficient cheating */
5979 cnt = PerlIO_get_cnt(fp); /* get count into register */
5980 /* make sure we have the room */
5981 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5982 /* Not room for all of it
5983 if we are looking for a separator and room for some
5985 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5986 /* just process what we have room for */
5987 shortbuffered = cnt - SvLEN(sv) + append + 1;
5988 cnt -= shortbuffered;
5992 /* remember that cnt can be negative */
5993 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5998 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5999 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6000 DEBUG_P(PerlIO_printf(Perl_debug_log,
6001 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6002 DEBUG_P(PerlIO_printf(Perl_debug_log,
6003 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6004 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6005 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6010 while (cnt > 0) { /* this | eat */
6012 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6013 goto thats_all_folks; /* screams | sed :-) */
6017 Copy(ptr, bp, cnt, char); /* this | eat */
6018 bp += cnt; /* screams | dust */
6019 ptr += cnt; /* louder | sed :-) */
6024 if (shortbuffered) { /* oh well, must extend */
6025 cnt = shortbuffered;
6027 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6029 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6030 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6034 DEBUG_P(PerlIO_printf(Perl_debug_log,
6035 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6036 PTR2UV(ptr),(long)cnt));
6037 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6039 DEBUG_P(PerlIO_printf(Perl_debug_log,
6040 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6041 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6042 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6044 /* This used to call 'filbuf' in stdio form, but as that behaves like
6045 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6046 another abstraction. */
6047 i = PerlIO_getc(fp); /* get more characters */
6049 DEBUG_P(PerlIO_printf(Perl_debug_log,
6050 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6051 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6052 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6054 cnt = PerlIO_get_cnt(fp);
6055 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6056 DEBUG_P(PerlIO_printf(Perl_debug_log,
6057 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6059 if (i == EOF) /* all done for ever? */
6060 goto thats_really_all_folks;
6062 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6064 SvGROW(sv, bpx + cnt + 2);
6065 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6067 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6069 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6070 goto thats_all_folks;
6074 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6075 memNE((char*)bp - rslen, rsptr, rslen))
6076 goto screamer; /* go back to the fray */
6077 thats_really_all_folks:
6079 cnt += shortbuffered;
6080 DEBUG_P(PerlIO_printf(Perl_debug_log,
6081 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6082 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6083 DEBUG_P(PerlIO_printf(Perl_debug_log,
6084 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6085 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6086 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6088 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6089 DEBUG_P(PerlIO_printf(Perl_debug_log,
6090 "Screamer: done, len=%ld, string=|%.*s|\n",
6091 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6095 /*The big, slow, and stupid way. */
6096 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6097 STDCHAR *buf = NULL;
6098 Newx(buf, 8192, STDCHAR);
6106 register const STDCHAR * const bpe = buf + sizeof(buf);
6108 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6109 ; /* keep reading */
6113 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6114 /* Accomodate broken VAXC compiler, which applies U8 cast to
6115 * both args of ?: operator, causing EOF to change into 255
6118 i = (U8)buf[cnt - 1];
6124 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6126 sv_catpvn(sv, (char *) buf, cnt);
6128 sv_setpvn(sv, (char *) buf, cnt);
6130 if (i != EOF && /* joy */
6132 SvCUR(sv) < rslen ||
6133 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6137 * If we're reading from a TTY and we get a short read,
6138 * indicating that the user hit his EOF character, we need
6139 * to notice it now, because if we try to read from the TTY
6140 * again, the EOF condition will disappear.
6142 * The comparison of cnt to sizeof(buf) is an optimization
6143 * that prevents unnecessary calls to feof().
6147 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6151 #ifdef USE_HEAP_INSTEAD_OF_STACK
6156 if (rspara) { /* have to do this both before and after */
6157 while (i != EOF) { /* to make sure file boundaries work right */
6158 i = PerlIO_getc(fp);
6160 PerlIO_ungetc(fp,i);
6166 return_string_or_null:
6167 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6173 Auto-increment of the value in the SV, doing string to numeric conversion
6174 if necessary. Handles 'get' magic.
6180 Perl_sv_inc(pTHX_ register SV *sv)
6189 if (SvTHINKFIRST(sv)) {
6191 sv_force_normal_flags(sv, 0);
6192 if (SvREADONLY(sv)) {
6193 if (IN_PERL_RUNTIME)
6194 Perl_croak(aTHX_ PL_no_modify);
6198 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6200 i = PTR2IV(SvRV(sv));
6205 flags = SvFLAGS(sv);
6206 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6207 /* It's (privately or publicly) a float, but not tested as an
6208 integer, so test it to see. */
6210 flags = SvFLAGS(sv);
6212 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6213 /* It's publicly an integer, or privately an integer-not-float */
6214 #ifdef PERL_PRESERVE_IVUV
6218 if (SvUVX(sv) == UV_MAX)
6219 sv_setnv(sv, UV_MAX_P1);
6221 (void)SvIOK_only_UV(sv);
6222 SvUV_set(sv, SvUVX(sv) + 1);
6224 if (SvIVX(sv) == IV_MAX)
6225 sv_setuv(sv, (UV)IV_MAX + 1);
6227 (void)SvIOK_only(sv);
6228 SvIV_set(sv, SvIVX(sv) + 1);
6233 if (flags & SVp_NOK) {
6234 (void)SvNOK_only(sv);
6235 SvNV_set(sv, SvNVX(sv) + 1.0);
6239 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6240 if ((flags & SVTYPEMASK) < SVt_PVIV)
6241 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6242 (void)SvIOK_only(sv);
6247 while (isALPHA(*d)) d++;
6248 while (isDIGIT(*d)) d++;
6250 #ifdef PERL_PRESERVE_IVUV
6251 /* Got to punt this as an integer if needs be, but we don't issue
6252 warnings. Probably ought to make the sv_iv_please() that does
6253 the conversion if possible, and silently. */
6254 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6255 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6256 /* Need to try really hard to see if it's an integer.
6257 9.22337203685478e+18 is an integer.
6258 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6259 so $a="9.22337203685478e+18"; $a+0; $a++
6260 needs to be the same as $a="9.22337203685478e+18"; $a++
6267 /* sv_2iv *should* have made this an NV */
6268 if (flags & SVp_NOK) {
6269 (void)SvNOK_only(sv);
6270 SvNV_set(sv, SvNVX(sv) + 1.0);
6273 /* I don't think we can get here. Maybe I should assert this
6274 And if we do get here I suspect that sv_setnv will croak. NWC
6276 #if defined(USE_LONG_DOUBLE)
6277 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",
6278 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6280 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6281 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6284 #endif /* PERL_PRESERVE_IVUV */
6285 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6289 while (d >= SvPVX_const(sv)) {
6297 /* MKS: The original code here died if letters weren't consecutive.
6298 * at least it didn't have to worry about non-C locales. The
6299 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6300 * arranged in order (although not consecutively) and that only
6301 * [A-Za-z] are accepted by isALPHA in the C locale.
6303 if (*d != 'z' && *d != 'Z') {
6304 do { ++*d; } while (!isALPHA(*d));
6307 *(d--) -= 'z' - 'a';
6312 *(d--) -= 'z' - 'a' + 1;
6316 /* oh,oh, the number grew */
6317 SvGROW(sv, SvCUR(sv) + 2);
6318 SvCUR_set(sv, SvCUR(sv) + 1);
6319 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6330 Auto-decrement of the value in the SV, doing string to numeric conversion
6331 if necessary. Handles 'get' magic.
6337 Perl_sv_dec(pTHX_ register SV *sv)
6345 if (SvTHINKFIRST(sv)) {
6347 sv_force_normal_flags(sv, 0);
6348 if (SvREADONLY(sv)) {
6349 if (IN_PERL_RUNTIME)
6350 Perl_croak(aTHX_ PL_no_modify);
6354 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6356 i = PTR2IV(SvRV(sv));
6361 /* Unlike sv_inc we don't have to worry about string-never-numbers
6362 and keeping them magic. But we mustn't warn on punting */
6363 flags = SvFLAGS(sv);
6364 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6365 /* It's publicly an integer, or privately an integer-not-float */
6366 #ifdef PERL_PRESERVE_IVUV
6370 if (SvUVX(sv) == 0) {
6371 (void)SvIOK_only(sv);
6375 (void)SvIOK_only_UV(sv);
6376 SvUV_set(sv, SvUVX(sv) - 1);
6379 if (SvIVX(sv) == IV_MIN)
6380 sv_setnv(sv, (NV)IV_MIN - 1.0);
6382 (void)SvIOK_only(sv);
6383 SvIV_set(sv, SvIVX(sv) - 1);
6388 if (flags & SVp_NOK) {
6389 SvNV_set(sv, SvNVX(sv) - 1.0);
6390 (void)SvNOK_only(sv);
6393 if (!(flags & SVp_POK)) {
6394 if ((flags & SVTYPEMASK) < SVt_PVIV)
6395 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6397 (void)SvIOK_only(sv);
6400 #ifdef PERL_PRESERVE_IVUV
6402 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6403 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6404 /* Need to try really hard to see if it's an integer.
6405 9.22337203685478e+18 is an integer.
6406 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6407 so $a="9.22337203685478e+18"; $a+0; $a--
6408 needs to be the same as $a="9.22337203685478e+18"; $a--
6415 /* sv_2iv *should* have made this an NV */
6416 if (flags & SVp_NOK) {
6417 (void)SvNOK_only(sv);
6418 SvNV_set(sv, SvNVX(sv) - 1.0);
6421 /* I don't think we can get here. Maybe I should assert this
6422 And if we do get here I suspect that sv_setnv will croak. NWC
6424 #if defined(USE_LONG_DOUBLE)
6425 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6426 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6428 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6429 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6433 #endif /* PERL_PRESERVE_IVUV */
6434 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6438 =for apidoc sv_mortalcopy
6440 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6441 The new SV is marked as mortal. It will be destroyed "soon", either by an
6442 explicit call to FREETMPS, or by an implicit call at places such as
6443 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6448 /* Make a string that will exist for the duration of the expression
6449 * evaluation. Actually, it may have to last longer than that, but
6450 * hopefully we won't free it until it has been assigned to a
6451 * permanent location. */
6454 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6460 sv_setsv(sv,oldstr);
6462 PL_tmps_stack[++PL_tmps_ix] = sv;
6468 =for apidoc sv_newmortal
6470 Creates a new null SV which is mortal. The reference count of the SV is
6471 set to 1. It will be destroyed "soon", either by an explicit call to
6472 FREETMPS, or by an implicit call at places such as statement boundaries.
6473 See also C<sv_mortalcopy> and C<sv_2mortal>.
6479 Perl_sv_newmortal(pTHX)
6485 SvFLAGS(sv) = SVs_TEMP;
6487 PL_tmps_stack[++PL_tmps_ix] = sv;
6492 =for apidoc sv_2mortal
6494 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6495 by an explicit call to FREETMPS, or by an implicit call at places such as
6496 statement boundaries. SvTEMP() is turned on which means that the SV's
6497 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6498 and C<sv_mortalcopy>.
6504 Perl_sv_2mortal(pTHX_ register SV *sv)
6509 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6512 PL_tmps_stack[++PL_tmps_ix] = sv;
6520 Creates a new SV and copies a string into it. The reference count for the
6521 SV is set to 1. If C<len> is zero, Perl will compute the length using
6522 strlen(). For efficiency, consider using C<newSVpvn> instead.
6528 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6534 sv_setpvn(sv,s,len ? len : strlen(s));
6539 =for apidoc newSVpvn
6541 Creates a new SV and copies a string into it. The reference count for the
6542 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6543 string. You are responsible for ensuring that the source string is at least
6544 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6550 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6556 sv_setpvn(sv,s,len);
6562 =for apidoc newSVhek
6564 Creates a new SV from the hash key structure. It will generate scalars that
6565 point to the shared string table where possible. Returns a new (undefined)
6566 SV if the hek is NULL.
6572 Perl_newSVhek(pTHX_ const HEK *hek)
6582 if (HEK_LEN(hek) == HEf_SVKEY) {
6583 return newSVsv(*(SV**)HEK_KEY(hek));
6585 const int flags = HEK_FLAGS(hek);
6586 if (flags & HVhek_WASUTF8) {
6588 Andreas would like keys he put in as utf8 to come back as utf8
6590 STRLEN utf8_len = HEK_LEN(hek);
6591 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6592 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6595 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6597 } else if (flags & HVhek_REHASH) {
6598 /* We don't have a pointer to the hv, so we have to replicate the
6599 flag into every HEK. This hv is using custom a hasing
6600 algorithm. Hence we can't return a shared string scalar, as
6601 that would contain the (wrong) hash value, and might get passed
6602 into an hv routine with a regular hash */
6604 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6609 /* This will be overwhelminly the most common case. */
6610 return newSVpvn_share(HEK_KEY(hek),
6611 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6617 =for apidoc newSVpvn_share
6619 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6620 table. If the string does not already exist in the table, it is created
6621 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6622 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6623 otherwise the hash is computed. The idea here is that as the string table
6624 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6625 hash lookup will avoid string compare.
6631 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6635 bool is_utf8 = FALSE;
6637 STRLEN tmplen = -len;
6639 /* See the note in hv.c:hv_fetch() --jhi */
6640 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6644 PERL_HASH(hash, src, len);
6646 sv_upgrade(sv, SVt_PV);
6647 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6659 #if defined(PERL_IMPLICIT_CONTEXT)
6661 /* pTHX_ magic can't cope with varargs, so this is a no-context
6662 * version of the main function, (which may itself be aliased to us).
6663 * Don't access this version directly.
6667 Perl_newSVpvf_nocontext(const char* pat, ...)
6672 va_start(args, pat);
6673 sv = vnewSVpvf(pat, &args);
6680 =for apidoc newSVpvf
6682 Creates a new SV and initializes it with the string formatted like
6689 Perl_newSVpvf(pTHX_ const char* pat, ...)
6693 va_start(args, pat);
6694 sv = vnewSVpvf(pat, &args);
6699 /* backend for newSVpvf() and newSVpvf_nocontext() */
6702 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6707 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6714 Creates a new SV and copies a floating point value into it.
6715 The reference count for the SV is set to 1.
6721 Perl_newSVnv(pTHX_ NV n)
6734 Creates a new SV and copies an integer into it. The reference count for the
6741 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)
6772 =for apidoc newRV_noinc
6774 Creates an RV wrapper for an SV. The reference count for the original
6775 SV is B<not> incremented.
6781 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6787 sv_upgrade(sv, SVt_RV);
6789 SvRV_set(sv, tmpRef);
6794 /* newRV_inc is the official function name to use now.
6795 * newRV_inc is in fact #defined to newRV in sv.h
6799 Perl_newRV(pTHX_ SV *tmpRef)
6802 return newRV_noinc(SvREFCNT_inc(tmpRef));
6808 Creates a new SV which is an exact duplicate of the original SV.
6815 Perl_newSVsv(pTHX_ register SV *old)
6822 if (SvTYPE(old) == SVTYPEMASK) {
6823 if (ckWARN_d(WARN_INTERNAL))
6824 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6828 /* SV_GMAGIC is the default for sv_setv()
6829 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6830 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6831 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6836 =for apidoc sv_reset
6838 Underlying implementation for the C<reset> Perl function.
6839 Note that the perl-level function is vaguely deprecated.
6845 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6848 char todo[PERL_UCHAR_MAX+1];
6853 if (!*s) { /* reset ?? searches */
6854 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6856 PMOP *pm = (PMOP *) mg->mg_obj;
6858 pm->op_pmdynflags &= ~PMdf_USED;
6865 /* reset variables */
6867 if (!HvARRAY(stash))
6870 Zero(todo, 256, char);
6873 I32 i = (unsigned char)*s;
6877 max = (unsigned char)*s++;
6878 for ( ; i <= max; i++) {
6881 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6883 for (entry = HvARRAY(stash)[i];
6885 entry = HeNEXT(entry))
6890 if (!todo[(U8)*HeKEY(entry)])
6892 gv = (GV*)HeVAL(entry);
6895 if (SvTHINKFIRST(sv)) {
6896 if (!SvREADONLY(sv) && SvROK(sv))
6898 /* XXX Is this continue a bug? Why should THINKFIRST
6899 exempt us from resetting arrays and hashes? */
6903 if (SvTYPE(sv) >= SVt_PV) {
6905 if (SvPVX_const(sv) != NULL)
6913 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6915 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6918 # if defined(USE_ENVIRON_ARRAY)
6921 # endif /* USE_ENVIRON_ARRAY */
6932 Using various gambits, try to get an IO from an SV: the IO slot if its a
6933 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6934 named after the PV if we're a string.
6940 Perl_sv_2io(pTHX_ SV *sv)
6945 switch (SvTYPE(sv)) {
6953 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6957 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6959 return sv_2io(SvRV(sv));
6960 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6966 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6975 Using various gambits, try to get a CV from an SV; in addition, try if
6976 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6977 The flags in C<lref> are passed to sv_fetchsv.
6983 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6994 switch (SvTYPE(sv)) {
7013 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7014 tryAMAGICunDEREF(to_cv);
7017 if (SvTYPE(sv) == SVt_PVCV) {
7026 Perl_croak(aTHX_ "Not a subroutine reference");
7031 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7037 /* Some flags to gv_fetchsv mean don't really create the GV */
7038 if (SvTYPE(gv) != SVt_PVGV) {
7044 if (lref && !GvCVu(gv)) {
7048 gv_efullname3(tmpsv, gv, NULL);
7049 /* XXX this is probably not what they think they're getting.
7050 * It has the same effect as "sub name;", i.e. just a forward
7052 newSUB(start_subparse(FALSE, 0),
7053 newSVOP(OP_CONST, 0, tmpsv),
7058 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7068 Returns true if the SV has a true value by Perl's rules.
7069 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7070 instead use an in-line version.
7076 Perl_sv_true(pTHX_ register SV *sv)
7081 register const XPV* const tXpv = (XPV*)SvANY(sv);
7083 (tXpv->xpv_cur > 1 ||
7084 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7091 return SvIVX(sv) != 0;
7094 return SvNVX(sv) != 0.0;
7096 return sv_2bool(sv);
7102 =for apidoc sv_pvn_force
7104 Get a sensible string out of the SV somehow.
7105 A private implementation of the C<SvPV_force> macro for compilers which
7106 can't cope with complex macro expressions. Always use the macro instead.
7108 =for apidoc sv_pvn_force_flags
7110 Get a sensible string out of the SV somehow.
7111 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7112 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7113 implemented in terms of this function.
7114 You normally want to use the various wrapper macros instead: see
7115 C<SvPV_force> and C<SvPV_force_nomg>
7121 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7124 if (SvTHINKFIRST(sv) && !SvROK(sv))
7125 sv_force_normal_flags(sv, 0);
7135 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7136 const char * const ref = sv_reftype(sv,0);
7138 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7139 ref, OP_NAME(PL_op));
7141 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7143 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7144 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7146 s = sv_2pv_flags(sv, &len, flags);
7150 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7153 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7154 SvGROW(sv, len + 1);
7155 Move(s,SvPVX(sv),len,char);
7160 SvPOK_on(sv); /* validate pointer */
7162 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7163 PTR2UV(sv),SvPVX_const(sv)));
7166 return SvPVX_mutable(sv);
7170 =for apidoc sv_pvbyten_force
7172 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7178 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7180 sv_pvn_force(sv,lp);
7181 sv_utf8_downgrade(sv,0);
7187 =for apidoc sv_pvutf8n_force
7189 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7195 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7197 sv_pvn_force(sv,lp);
7198 sv_utf8_upgrade(sv);
7204 =for apidoc sv_reftype
7206 Returns a string describing what the SV is a reference to.
7212 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7214 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7215 inside return suggests a const propagation bug in g++. */
7216 if (ob && SvOBJECT(sv)) {
7217 char * const name = HvNAME_get(SvSTASH(sv));
7218 return name ? name : (char *) "__ANON__";
7221 switch (SvTYPE(sv)) {
7238 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7239 /* tied lvalues should appear to be
7240 * scalars for backwards compatitbility */
7241 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7242 ? "SCALAR" : "LVALUE");
7243 case SVt_PVAV: return "ARRAY";
7244 case SVt_PVHV: return "HASH";
7245 case SVt_PVCV: return "CODE";
7246 case SVt_PVGV: return "GLOB";
7247 case SVt_PVFM: return "FORMAT";
7248 case SVt_PVIO: return "IO";
7249 default: return "UNKNOWN";
7255 =for apidoc sv_isobject
7257 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7258 object. If the SV is not an RV, or if the object is not blessed, then this
7265 Perl_sv_isobject(pTHX_ SV *sv)
7281 Returns a boolean indicating whether the SV is blessed into the specified
7282 class. This does not check for subtypes; use C<sv_derived_from> to verify
7283 an inheritance relationship.
7289 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7300 hvname = HvNAME_get(SvSTASH(sv));
7304 return strEQ(hvname, name);
7310 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7311 it will be upgraded to one. If C<classname> is non-null then the new SV will
7312 be blessed in the specified package. The new SV is returned and its
7313 reference count is 1.
7319 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7326 SV_CHECK_THINKFIRST_COW_DROP(rv);
7329 if (SvTYPE(rv) >= SVt_PVMG) {
7330 const U32 refcnt = SvREFCNT(rv);
7334 SvREFCNT(rv) = refcnt;
7337 if (SvTYPE(rv) < SVt_RV)
7338 sv_upgrade(rv, SVt_RV);
7339 else if (SvTYPE(rv) > SVt_RV) {
7350 HV* const stash = gv_stashpv(classname, TRUE);
7351 (void)sv_bless(rv, stash);
7357 =for apidoc sv_setref_pv
7359 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7360 argument will be upgraded to an RV. That RV will be modified to point to
7361 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7362 into the SV. The C<classname> argument indicates the package for the
7363 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7364 will have a reference count of 1, and the RV will be returned.
7366 Do not use with other Perl types such as HV, AV, SV, CV, because those
7367 objects will become corrupted by the pointer copy process.
7369 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7375 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7379 sv_setsv(rv, &PL_sv_undef);
7383 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7388 =for apidoc sv_setref_iv
7390 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7391 argument will be upgraded to an RV. That RV will be modified to point to
7392 the new SV. The C<classname> argument indicates the package for the
7393 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7394 will have a reference count of 1, and the RV will be returned.
7400 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7402 sv_setiv(newSVrv(rv,classname), iv);
7407 =for apidoc sv_setref_uv
7409 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7410 argument will be upgraded to an RV. That RV will be modified to point to
7411 the new SV. The C<classname> argument indicates the package for the
7412 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7413 will have a reference count of 1, and the RV will be returned.
7419 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7421 sv_setuv(newSVrv(rv,classname), uv);
7426 =for apidoc sv_setref_nv
7428 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7429 argument will be upgraded to an RV. That RV will be modified to point to
7430 the new SV. The C<classname> argument indicates the package for the
7431 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7432 will have a reference count of 1, and the RV will be returned.
7438 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7440 sv_setnv(newSVrv(rv,classname), nv);
7445 =for apidoc sv_setref_pvn
7447 Copies a string into a new SV, optionally blessing the SV. The length of the
7448 string must be specified with C<n>. The C<rv> argument will be upgraded to
7449 an RV. That RV will be modified to point to the new SV. The C<classname>
7450 argument indicates the package for the blessing. Set C<classname> to
7451 C<NULL> to avoid the blessing. The new SV will have a reference count
7452 of 1, and the RV will be returned.
7454 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7460 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7462 sv_setpvn(newSVrv(rv,classname), pv, n);
7467 =for apidoc sv_bless
7469 Blesses an SV into a specified package. The SV must be an RV. The package
7470 must be designated by its stash (see C<gv_stashpv()>). The reference count
7471 of the SV is unaffected.
7477 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7482 Perl_croak(aTHX_ "Can't bless non-reference value");
7484 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7485 if (SvREADONLY(tmpRef))
7486 Perl_croak(aTHX_ PL_no_modify);
7487 if (SvOBJECT(tmpRef)) {
7488 if (SvTYPE(tmpRef) != SVt_PVIO)
7490 SvREFCNT_dec(SvSTASH(tmpRef));
7493 SvOBJECT_on(tmpRef);
7494 if (SvTYPE(tmpRef) != SVt_PVIO)
7496 SvUPGRADE(tmpRef, SVt_PVMG);
7497 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7504 if(SvSMAGICAL(tmpRef))
7505 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7513 /* Downgrades a PVGV to a PVMG.
7517 S_sv_unglob(pTHX_ SV *sv)
7522 assert(SvTYPE(sv) == SVt_PVGV);
7527 sv_del_backref((SV*)GvSTASH(sv), sv);
7530 sv_unmagic(sv, PERL_MAGIC_glob);
7531 Safefree(GvNAME(sv));
7534 /* need to keep SvANY(sv) in the right arena */
7535 xpvmg = new_XPVMG();
7536 StructCopy(SvANY(sv), xpvmg, XPVMG);
7537 del_XPVGV(SvANY(sv));
7540 SvFLAGS(sv) &= ~SVTYPEMASK;
7541 SvFLAGS(sv) |= SVt_PVMG;
7545 =for apidoc sv_unref_flags
7547 Unsets the RV status of the SV, and decrements the reference count of
7548 whatever was being referenced by the RV. This can almost be thought of
7549 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7550 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7551 (otherwise the decrementing is conditional on the reference count being
7552 different from one or the reference being a readonly SV).
7559 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7561 SV* const target = SvRV(ref);
7563 if (SvWEAKREF(ref)) {
7564 sv_del_backref(target, ref);
7566 SvRV_set(ref, NULL);
7569 SvRV_set(ref, NULL);
7571 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7572 assigned to as BEGIN {$a = \"Foo"} will fail. */
7573 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7574 SvREFCNT_dec(target);
7575 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7576 sv_2mortal(target); /* Schedule for freeing later */
7580 =for apidoc sv_untaint
7582 Untaint an SV. Use C<SvTAINTED_off> instead.
7587 Perl_sv_untaint(pTHX_ SV *sv)
7589 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7590 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7597 =for apidoc sv_tainted
7599 Test an SV for taintedness. Use C<SvTAINTED> instead.
7604 Perl_sv_tainted(pTHX_ SV *sv)
7606 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7607 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7608 if (mg && (mg->mg_len & 1) )
7615 =for apidoc sv_setpviv
7617 Copies an integer into the given SV, also updating its string value.
7618 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7624 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7626 char buf[TYPE_CHARS(UV)];
7628 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7630 sv_setpvn(sv, ptr, ebuf - ptr);
7634 =for apidoc sv_setpviv_mg
7636 Like C<sv_setpviv>, but also handles 'set' magic.
7642 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7648 #if defined(PERL_IMPLICIT_CONTEXT)
7650 /* pTHX_ magic can't cope with varargs, so this is a no-context
7651 * version of the main function, (which may itself be aliased to us).
7652 * Don't access this version directly.
7656 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7660 va_start(args, pat);
7661 sv_vsetpvf(sv, pat, &args);
7665 /* pTHX_ magic can't cope with varargs, so this is a no-context
7666 * version of the main function, (which may itself be aliased to us).
7667 * Don't access this version directly.
7671 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7675 va_start(args, pat);
7676 sv_vsetpvf_mg(sv, pat, &args);
7682 =for apidoc sv_setpvf
7684 Works like C<sv_catpvf> but copies the text into the SV instead of
7685 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7691 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7694 va_start(args, pat);
7695 sv_vsetpvf(sv, pat, &args);
7700 =for apidoc sv_vsetpvf
7702 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7703 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7705 Usually used via its frontend C<sv_setpvf>.
7711 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7713 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7717 =for apidoc sv_setpvf_mg
7719 Like C<sv_setpvf>, but also handles 'set' magic.
7725 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7728 va_start(args, pat);
7729 sv_vsetpvf_mg(sv, pat, &args);
7734 =for apidoc sv_vsetpvf_mg
7736 Like C<sv_vsetpvf>, but also handles 'set' magic.
7738 Usually used via its frontend C<sv_setpvf_mg>.
7744 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7746 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7750 #if defined(PERL_IMPLICIT_CONTEXT)
7752 /* pTHX_ magic can't cope with varargs, so this is a no-context
7753 * version of the main function, (which may itself be aliased to us).
7754 * Don't access this version directly.
7758 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7762 va_start(args, pat);
7763 sv_vcatpvf(sv, pat, &args);
7767 /* pTHX_ magic can't cope with varargs, so this is a no-context
7768 * version of the main function, (which may itself be aliased to us).
7769 * Don't access this version directly.
7773 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7777 va_start(args, pat);
7778 sv_vcatpvf_mg(sv, pat, &args);
7784 =for apidoc sv_catpvf
7786 Processes its arguments like C<sprintf> and appends the formatted
7787 output to an SV. If the appended data contains "wide" characters
7788 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7789 and characters >255 formatted with %c), the original SV might get
7790 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7791 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7792 valid UTF-8; if the original SV was bytes, the pattern should be too.
7797 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7800 va_start(args, pat);
7801 sv_vcatpvf(sv, pat, &args);
7806 =for apidoc sv_vcatpvf
7808 Processes its arguments like C<vsprintf> and appends the formatted output
7809 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7811 Usually used via its frontend C<sv_catpvf>.
7817 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7819 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7823 =for apidoc sv_catpvf_mg
7825 Like C<sv_catpvf>, but also handles 'set' magic.
7831 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7834 va_start(args, pat);
7835 sv_vcatpvf_mg(sv, pat, &args);
7840 =for apidoc sv_vcatpvf_mg
7842 Like C<sv_vcatpvf>, but also handles 'set' magic.
7844 Usually used via its frontend C<sv_catpvf_mg>.
7850 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7852 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7857 =for apidoc sv_vsetpvfn
7859 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7862 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7868 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7870 sv_setpvn(sv, "", 0);
7871 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7875 S_expect_number(pTHX_ char** pattern)
7879 switch (**pattern) {
7880 case '1': case '2': case '3':
7881 case '4': case '5': case '6':
7882 case '7': case '8': case '9':
7883 var = *(*pattern)++ - '0';
7884 while (isDIGIT(**pattern)) {
7885 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7887 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7895 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7897 const int neg = nv < 0;
7906 if (uv & 1 && uv == nv)
7907 uv--; /* Round to even */
7909 const unsigned dig = uv % 10;
7922 =for apidoc sv_vcatpvfn
7924 Processes its arguments like C<vsprintf> and appends the formatted output
7925 to an SV. Uses an array of SVs if the C style variable argument list is
7926 missing (NULL). When running with taint checks enabled, indicates via
7927 C<maybe_tainted> if results are untrustworthy (often due to the use of
7930 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7936 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7937 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7938 vec_utf8 = DO_UTF8(vecsv);
7940 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7943 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7951 static const char nullstr[] = "(null)";
7953 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7954 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7956 /* Times 4: a decimal digit takes more than 3 binary digits.
7957 * NV_DIG: mantissa takes than many decimal digits.
7958 * Plus 32: Playing safe. */
7959 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7960 /* large enough for "%#.#f" --chip */
7961 /* what about long double NVs? --jhi */
7963 PERL_UNUSED_ARG(maybe_tainted);
7965 /* no matter what, this is a string now */
7966 (void)SvPV_force(sv, origlen);
7968 /* special-case "", "%s", and "%-p" (SVf - see below) */
7971 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7973 const char * const s = va_arg(*args, char*);
7974 sv_catpv(sv, s ? s : nullstr);
7976 else if (svix < svmax) {
7977 sv_catsv(sv, *svargs);
7981 if (args && patlen == 3 && pat[0] == '%' &&
7982 pat[1] == '-' && pat[2] == 'p') {
7983 argsv = va_arg(*args, SV*);
7984 sv_catsv(sv, argsv);
7988 #ifndef USE_LONG_DOUBLE
7989 /* special-case "%.<number>[gf]" */
7990 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7991 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7992 unsigned digits = 0;
7996 while (*pp >= '0' && *pp <= '9')
7997 digits = 10 * digits + (*pp++ - '0');
7998 if (pp - pat == (int)patlen - 1) {
8006 /* Add check for digits != 0 because it seems that some
8007 gconverts are buggy in this case, and we don't yet have
8008 a Configure test for this. */
8009 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8010 /* 0, point, slack */
8011 Gconvert(nv, (int)digits, 0, ebuf);
8013 if (*ebuf) /* May return an empty string for digits==0 */
8016 } else if (!digits) {
8019 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8020 sv_catpvn(sv, p, l);
8026 #endif /* !USE_LONG_DOUBLE */
8028 if (!args && svix < svmax && DO_UTF8(*svargs))
8031 patend = (char*)pat + patlen;
8032 for (p = (char*)pat; p < patend; p = q) {
8035 bool vectorize = FALSE;
8036 bool vectorarg = FALSE;
8037 bool vec_utf8 = FALSE;
8043 bool has_precis = FALSE;
8045 const I32 osvix = svix;
8046 bool is_utf8 = FALSE; /* is this item utf8? */
8047 #ifdef HAS_LDBL_SPRINTF_BUG
8048 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8049 with sfio - Allen <allens@cpan.org> */
8050 bool fix_ldbl_sprintf_bug = FALSE;
8054 U8 utf8buf[UTF8_MAXBYTES+1];
8055 STRLEN esignlen = 0;
8057 const char *eptr = NULL;
8060 const U8 *vecstr = Null(U8*);
8067 /* we need a long double target in case HAS_LONG_DOUBLE but
8070 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8078 const char *dotstr = ".";
8079 STRLEN dotstrlen = 1;
8080 I32 efix = 0; /* explicit format parameter index */
8081 I32 ewix = 0; /* explicit width index */
8082 I32 epix = 0; /* explicit precision index */
8083 I32 evix = 0; /* explicit vector index */
8084 bool asterisk = FALSE;
8086 /* echo everything up to the next format specification */
8087 for (q = p; q < patend && *q != '%'; ++q) ;
8089 if (has_utf8 && !pat_utf8)
8090 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8092 sv_catpvn(sv, p, q - p);
8099 We allow format specification elements in this order:
8100 \d+\$ explicit format parameter index
8102 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8103 0 flag (as above): repeated to allow "v02"
8104 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8105 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8107 [%bcdefginopsuxDFOUX] format (mandatory)
8112 As of perl5.9.3, printf format checking is on by default.
8113 Internally, perl uses %p formats to provide an escape to
8114 some extended formatting. This block deals with those
8115 extensions: if it does not match, (char*)q is reset and
8116 the normal format processing code is used.
8118 Currently defined extensions are:
8119 %p include pointer address (standard)
8120 %-p (SVf) include an SV (previously %_)
8121 %-<num>p include an SV with precision <num>
8122 %1p (VDf) include a v-string (as %vd)
8123 %<num>p reserved for future extensions
8125 Robin Barker 2005-07-14
8132 n = expect_number(&q);
8139 argsv = va_arg(*args, SV*);
8140 eptr = SvPVx_const(argsv, elen);
8146 else if (n == vdNUMBER) { /* VDf */
8153 if (ckWARN_d(WARN_INTERNAL))
8154 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8155 "internal %%<num>p might conflict with future printf extensions");
8161 if ( (width = expect_number(&q)) ) {
8202 if ( (ewix = expect_number(&q)) )
8211 if ((vectorarg = asterisk)) {
8224 width = expect_number(&q);
8230 vecsv = va_arg(*args, SV*);
8232 vecsv = (evix > 0 && evix <= svmax)
8233 ? svargs[evix-1] : &PL_sv_undef;
8235 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8237 dotstr = SvPV_const(vecsv, dotstrlen);
8238 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8239 bad with tied or overloaded values that return UTF8. */
8242 else if (has_utf8) {
8243 vecsv = sv_mortalcopy(vecsv);
8244 sv_utf8_upgrade(vecsv);
8245 dotstr = SvPV_const(vecsv, dotstrlen);
8252 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8253 vecsv = svargs[efix ? efix-1 : svix++];
8254 vecstr = (U8*)SvPV_const(vecsv,veclen);
8255 vec_utf8 = DO_UTF8(vecsv);
8257 /* if this is a version object, we need to convert
8258 * back into v-string notation and then let the
8259 * vectorize happen normally
8261 if (sv_derived_from(vecsv, "version")) {
8262 char *version = savesvpv(vecsv);
8263 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8264 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8265 "vector argument not supported with alpha versions");
8268 vecsv = sv_newmortal();
8269 /* scan_vstring is expected to be called during
8270 * tokenization, so we need to fake up the end
8271 * of the buffer for it
8273 PL_bufend = version + veclen;
8274 scan_vstring(version, vecsv);
8275 vecstr = (U8*)SvPV_const(vecsv, veclen);
8276 vec_utf8 = DO_UTF8(vecsv);
8288 i = va_arg(*args, int);
8290 i = (ewix ? ewix <= svmax : svix < svmax) ?
8291 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8293 width = (i < 0) ? -i : i;
8303 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8305 /* XXX: todo, support specified precision parameter */
8309 i = va_arg(*args, int);
8311 i = (ewix ? ewix <= svmax : svix < svmax)
8312 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8313 precis = (i < 0) ? 0 : i;
8318 precis = precis * 10 + (*q++ - '0');
8327 case 'I': /* Ix, I32x, and I64x */
8329 if (q[1] == '6' && q[2] == '4') {
8335 if (q[1] == '3' && q[2] == '2') {
8345 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8356 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8357 if (*(q + 1) == 'l') { /* lld, llf */
8383 if (!vectorize && !args) {
8385 const I32 i = efix-1;
8386 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8388 argsv = (svix >= 0 && svix < svmax)
8389 ? svargs[svix++] : &PL_sv_undef;
8400 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8402 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8404 eptr = (char*)utf8buf;
8405 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8419 eptr = va_arg(*args, char*);
8421 #ifdef MACOS_TRADITIONAL
8422 /* On MacOS, %#s format is used for Pascal strings */
8427 elen = strlen(eptr);
8429 eptr = (char *)nullstr;
8430 elen = sizeof nullstr - 1;
8434 eptr = SvPVx_const(argsv, elen);
8435 if (DO_UTF8(argsv)) {
8436 if (has_precis && precis < elen) {
8438 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8441 if (width) { /* fudge width (can't fudge elen) */
8442 width += elen - sv_len_utf8(argsv);
8449 if (has_precis && elen > precis)
8456 if (alt || vectorize)
8458 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8479 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8488 esignbuf[esignlen++] = plus;
8492 case 'h': iv = (short)va_arg(*args, int); break;
8493 case 'l': iv = va_arg(*args, long); break;
8494 case 'V': iv = va_arg(*args, IV); break;
8495 default: iv = va_arg(*args, int); break;
8497 case 'q': iv = va_arg(*args, Quad_t); break;
8502 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8504 case 'h': iv = (short)tiv; break;
8505 case 'l': iv = (long)tiv; break;
8507 default: iv = tiv; break;
8509 case 'q': iv = (Quad_t)tiv; break;
8513 if ( !vectorize ) /* we already set uv above */
8518 esignbuf[esignlen++] = plus;
8522 esignbuf[esignlen++] = '-';
8565 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8576 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8577 case 'l': uv = va_arg(*args, unsigned long); break;
8578 case 'V': uv = va_arg(*args, UV); break;
8579 default: uv = va_arg(*args, unsigned); break;
8581 case 'q': uv = va_arg(*args, Uquad_t); break;
8586 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8588 case 'h': uv = (unsigned short)tuv; break;
8589 case 'l': uv = (unsigned long)tuv; break;
8591 default: uv = tuv; break;
8593 case 'q': uv = (Uquad_t)tuv; break;
8600 char *ptr = ebuf + sizeof ebuf;
8606 p = (char*)((c == 'X')
8607 ? "0123456789ABCDEF" : "0123456789abcdef");
8613 esignbuf[esignlen++] = '0';
8614 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8622 if (alt && *ptr != '0')
8633 esignbuf[esignlen++] = '0';
8634 esignbuf[esignlen++] = 'b';
8637 default: /* it had better be ten or less */
8641 } while (uv /= base);
8644 elen = (ebuf + sizeof ebuf) - ptr;
8648 zeros = precis - elen;
8649 else if (precis == 0 && elen == 1 && *eptr == '0')
8655 /* FLOATING POINT */
8658 c = 'f'; /* maybe %F isn't supported here */
8666 /* This is evil, but floating point is even more evil */
8668 /* for SV-style calling, we can only get NV
8669 for C-style calling, we assume %f is double;
8670 for simplicity we allow any of %Lf, %llf, %qf for long double
8674 #if defined(USE_LONG_DOUBLE)
8678 /* [perl #20339] - we should accept and ignore %lf rather than die */
8682 #if defined(USE_LONG_DOUBLE)
8683 intsize = args ? 0 : 'q';
8687 #if defined(HAS_LONG_DOUBLE)
8696 /* now we need (long double) if intsize == 'q', else (double) */
8698 #if LONG_DOUBLESIZE > DOUBLESIZE
8700 va_arg(*args, long double) :
8701 va_arg(*args, double)
8703 va_arg(*args, double)
8708 if (c != 'e' && c != 'E') {
8710 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8711 will cast our (long double) to (double) */
8712 (void)Perl_frexp(nv, &i);
8713 if (i == PERL_INT_MIN)
8714 Perl_die(aTHX_ "panic: frexp");
8716 need = BIT_DIGITS(i);
8718 need += has_precis ? precis : 6; /* known default */
8723 #ifdef HAS_LDBL_SPRINTF_BUG
8724 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8725 with sfio - Allen <allens@cpan.org> */
8728 # define MY_DBL_MAX DBL_MAX
8729 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8730 # if DOUBLESIZE >= 8
8731 # define MY_DBL_MAX 1.7976931348623157E+308L
8733 # define MY_DBL_MAX 3.40282347E+38L
8737 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8738 # define MY_DBL_MAX_BUG 1L
8740 # define MY_DBL_MAX_BUG MY_DBL_MAX
8744 # define MY_DBL_MIN DBL_MIN
8745 # else /* XXX guessing! -Allen */
8746 # if DOUBLESIZE >= 8
8747 # define MY_DBL_MIN 2.2250738585072014E-308L
8749 # define MY_DBL_MIN 1.17549435E-38L
8753 if ((intsize == 'q') && (c == 'f') &&
8754 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8756 /* it's going to be short enough that
8757 * long double precision is not needed */
8759 if ((nv <= 0L) && (nv >= -0L))
8760 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8762 /* would use Perl_fp_class as a double-check but not
8763 * functional on IRIX - see perl.h comments */
8765 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8766 /* It's within the range that a double can represent */
8767 #if defined(DBL_MAX) && !defined(DBL_MIN)
8768 if ((nv >= ((long double)1/DBL_MAX)) ||
8769 (nv <= (-(long double)1/DBL_MAX)))
8771 fix_ldbl_sprintf_bug = TRUE;
8774 if (fix_ldbl_sprintf_bug == TRUE) {
8784 # undef MY_DBL_MAX_BUG
8787 #endif /* HAS_LDBL_SPRINTF_BUG */
8789 need += 20; /* fudge factor */
8790 if (PL_efloatsize < need) {
8791 Safefree(PL_efloatbuf);
8792 PL_efloatsize = need + 20; /* more fudge */
8793 Newx(PL_efloatbuf, PL_efloatsize, char);
8794 PL_efloatbuf[0] = '\0';
8797 if ( !(width || left || plus || alt) && fill != '0'
8798 && has_precis && intsize != 'q' ) { /* Shortcuts */
8799 /* See earlier comment about buggy Gconvert when digits,
8801 if ( c == 'g' && precis) {
8802 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8803 /* May return an empty string for digits==0 */
8804 if (*PL_efloatbuf) {
8805 elen = strlen(PL_efloatbuf);
8806 goto float_converted;
8808 } else if ( c == 'f' && !precis) {
8809 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8814 char *ptr = ebuf + sizeof ebuf;
8817 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8818 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8819 if (intsize == 'q') {
8820 /* Copy the one or more characters in a long double
8821 * format before the 'base' ([efgEFG]) character to
8822 * the format string. */
8823 static char const prifldbl[] = PERL_PRIfldbl;
8824 char const *p = prifldbl + sizeof(prifldbl) - 3;
8825 while (p >= prifldbl) { *--ptr = *p--; }
8830 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8835 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8847 /* No taint. Otherwise we are in the strange situation
8848 * where printf() taints but print($float) doesn't.
8850 #if defined(HAS_LONG_DOUBLE)
8851 elen = ((intsize == 'q')
8852 ? my_sprintf(PL_efloatbuf, ptr, nv)
8853 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8855 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8859 eptr = PL_efloatbuf;
8867 i = SvCUR(sv) - origlen;
8870 case 'h': *(va_arg(*args, short*)) = i; break;
8871 default: *(va_arg(*args, int*)) = i; break;
8872 case 'l': *(va_arg(*args, long*)) = i; break;
8873 case 'V': *(va_arg(*args, IV*)) = i; break;
8875 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8880 sv_setuv_mg(argsv, (UV)i);
8881 continue; /* not "break" */
8888 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8889 && ckWARN(WARN_PRINTF))
8891 SV * const msg = sv_newmortal();
8892 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8893 (PL_op->op_type == OP_PRTF) ? "" : "s");
8896 Perl_sv_catpvf(aTHX_ msg,
8897 "\"%%%c\"", c & 0xFF);
8899 Perl_sv_catpvf(aTHX_ msg,
8900 "\"%%\\%03"UVof"\"",
8903 sv_catpvs(msg, "end of string");
8904 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8907 /* output mangled stuff ... */
8913 /* ... right here, because formatting flags should not apply */
8914 SvGROW(sv, SvCUR(sv) + elen + 1);
8916 Copy(eptr, p, elen, char);
8919 SvCUR_set(sv, p - SvPVX_const(sv));
8921 continue; /* not "break" */
8924 /* calculate width before utf8_upgrade changes it */
8925 have = esignlen + zeros + elen;
8927 Perl_croak_nocontext(PL_memory_wrap);
8929 if (is_utf8 != has_utf8) {
8932 sv_utf8_upgrade(sv);
8935 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8936 sv_utf8_upgrade(nsv);
8937 eptr = SvPVX_const(nsv);
8940 SvGROW(sv, SvCUR(sv) + elen + 1);
8945 need = (have > width ? have : width);
8948 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8949 Perl_croak_nocontext(PL_memory_wrap);
8950 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8952 if (esignlen && fill == '0') {
8954 for (i = 0; i < (int)esignlen; i++)
8958 memset(p, fill, gap);
8961 if (esignlen && fill != '0') {
8963 for (i = 0; i < (int)esignlen; i++)
8968 for (i = zeros; i; i--)
8972 Copy(eptr, p, elen, char);
8976 memset(p, ' ', gap);
8981 Copy(dotstr, p, dotstrlen, char);
8985 vectorize = FALSE; /* done iterating over vecstr */
8992 SvCUR_set(sv, p - SvPVX_const(sv));
9000 /* =========================================================================
9002 =head1 Cloning an interpreter
9004 All the macros and functions in this section are for the private use of
9005 the main function, perl_clone().
9007 The foo_dup() functions make an exact copy of an existing foo thinngy.
9008 During the course of a cloning, a hash table is used to map old addresses
9009 to new addresses. The table is created and manipulated with the
9010 ptr_table_* functions.
9014 ============================================================================*/
9017 #if defined(USE_ITHREADS)
9019 #ifndef GpREFCNT_inc
9020 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9024 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9025 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9026 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9027 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9028 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9029 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9030 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9031 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9032 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9033 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9034 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9035 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9036 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9039 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9040 regcomp.c. AMS 20010712 */
9043 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9048 struct reg_substr_datum *s;
9051 return (REGEXP *)NULL;
9053 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9056 len = r->offsets[0];
9057 npar = r->nparens+1;
9059 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9060 Copy(r->program, ret->program, len+1, regnode);
9062 Newx(ret->startp, npar, I32);
9063 Copy(r->startp, ret->startp, npar, I32);
9064 Newx(ret->endp, npar, I32);
9065 Copy(r->startp, ret->startp, npar, I32);
9067 Newx(ret->substrs, 1, struct reg_substr_data);
9068 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9069 s->min_offset = r->substrs->data[i].min_offset;
9070 s->max_offset = r->substrs->data[i].max_offset;
9071 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9072 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9075 ret->regstclass = NULL;
9078 const int count = r->data->count;
9081 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9082 char, struct reg_data);
9083 Newx(d->what, count, U8);
9086 for (i = 0; i < count; i++) {
9087 d->what[i] = r->data->what[i];
9088 switch (d->what[i]) {
9089 /* legal options are one of: sfpont
9090 see also regcomp.h and pregfree() */
9092 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9095 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9098 /* This is cheating. */
9099 Newx(d->data[i], 1, struct regnode_charclass_class);
9100 StructCopy(r->data->data[i], d->data[i],
9101 struct regnode_charclass_class);
9102 ret->regstclass = (regnode*)d->data[i];
9105 /* Compiled op trees are readonly, and can thus be
9106 shared without duplication. */
9108 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9112 d->data[i] = r->data->data[i];
9115 d->data[i] = r->data->data[i];
9117 ((reg_trie_data*)d->data[i])->refcount++;
9121 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9130 Newx(ret->offsets, 2*len+1, U32);
9131 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9133 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9134 ret->refcnt = r->refcnt;
9135 ret->minlen = r->minlen;
9136 ret->prelen = r->prelen;
9137 ret->nparens = r->nparens;
9138 ret->lastparen = r->lastparen;
9139 ret->lastcloseparen = r->lastcloseparen;
9140 ret->reganch = r->reganch;
9142 ret->sublen = r->sublen;
9144 if (RX_MATCH_COPIED(ret))
9145 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9148 #ifdef PERL_OLD_COPY_ON_WRITE
9149 ret->saved_copy = NULL;
9152 ptr_table_store(PL_ptr_table, r, ret);
9156 /* duplicate a file handle */
9159 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9163 PERL_UNUSED_ARG(type);
9166 return (PerlIO*)NULL;
9168 /* look for it in the table first */
9169 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9173 /* create anew and remember what it is */
9174 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9175 ptr_table_store(PL_ptr_table, fp, ret);
9179 /* duplicate a directory handle */
9182 Perl_dirp_dup(pTHX_ DIR *dp)
9190 /* duplicate a typeglob */
9193 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9198 /* look for it in the table first */
9199 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9203 /* create anew and remember what it is */
9205 ptr_table_store(PL_ptr_table, gp, ret);
9208 ret->gp_refcnt = 0; /* must be before any other dups! */
9209 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9210 ret->gp_io = io_dup_inc(gp->gp_io, param);
9211 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9212 ret->gp_av = av_dup_inc(gp->gp_av, param);
9213 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9214 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9215 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9216 ret->gp_cvgen = gp->gp_cvgen;
9217 ret->gp_line = gp->gp_line;
9218 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9222 /* duplicate a chain of magic */
9225 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9227 MAGIC *mgprev = (MAGIC*)NULL;
9230 return (MAGIC*)NULL;
9231 /* look for it in the table first */
9232 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9236 for (; mg; mg = mg->mg_moremagic) {
9238 Newxz(nmg, 1, MAGIC);
9240 mgprev->mg_moremagic = nmg;
9243 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9244 nmg->mg_private = mg->mg_private;
9245 nmg->mg_type = mg->mg_type;
9246 nmg->mg_flags = mg->mg_flags;
9247 if (mg->mg_type == PERL_MAGIC_qr) {
9248 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9250 else if(mg->mg_type == PERL_MAGIC_backref) {
9251 /* The backref AV has its reference count deliberately bumped by
9253 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9255 else if (mg->mg_type == PERL_MAGIC_symtab) {
9256 nmg->mg_obj = mg->mg_obj;
9259 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9260 ? sv_dup_inc(mg->mg_obj, param)
9261 : sv_dup(mg->mg_obj, param);
9263 nmg->mg_len = mg->mg_len;
9264 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9265 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9266 if (mg->mg_len > 0) {
9267 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9268 if (mg->mg_type == PERL_MAGIC_overload_table &&
9269 AMT_AMAGIC((AMT*)mg->mg_ptr))
9271 const AMT * const amtp = (AMT*)mg->mg_ptr;
9272 AMT * const namtp = (AMT*)nmg->mg_ptr;
9274 for (i = 1; i < NofAMmeth; i++) {
9275 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9279 else if (mg->mg_len == HEf_SVKEY)
9280 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9282 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9283 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9290 /* create a new pointer-mapping table */
9293 Perl_ptr_table_new(pTHX)
9296 Newxz(tbl, 1, PTR_TBL_t);
9299 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9303 #define PTR_TABLE_HASH(ptr) \
9304 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9307 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9308 following define) and at call to new_body_inline made below in
9309 Perl_ptr_table_store()
9312 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9314 /* map an existing pointer using a table */
9316 STATIC PTR_TBL_ENT_t *
9317 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9318 PTR_TBL_ENT_t *tblent;
9319 const UV hash = PTR_TABLE_HASH(sv);
9321 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9322 for (; tblent; tblent = tblent->next) {
9323 if (tblent->oldval == sv)
9330 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9332 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9333 return tblent ? tblent->newval : (void *) 0;
9336 /* add a new entry to a pointer-mapping table */
9339 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9341 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9344 tblent->newval = newsv;
9346 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9348 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9349 tblent->oldval = oldsv;
9350 tblent->newval = newsv;
9351 tblent->next = tbl->tbl_ary[entry];
9352 tbl->tbl_ary[entry] = tblent;
9354 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9355 ptr_table_split(tbl);
9359 /* double the hash bucket size of an existing ptr table */
9362 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9364 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9365 const UV oldsize = tbl->tbl_max + 1;
9366 UV newsize = oldsize * 2;
9369 Renew(ary, newsize, PTR_TBL_ENT_t*);
9370 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9371 tbl->tbl_max = --newsize;
9373 for (i=0; i < oldsize; i++, ary++) {
9374 PTR_TBL_ENT_t **curentp, **entp, *ent;
9377 curentp = ary + oldsize;
9378 for (entp = ary, ent = *ary; ent; ent = *entp) {
9379 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9381 ent->next = *curentp;
9391 /* remove all the entries from a ptr table */
9394 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9396 if (tbl && tbl->tbl_items) {
9397 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9398 UV riter = tbl->tbl_max;
9401 PTR_TBL_ENT_t *entry = array[riter];
9404 PTR_TBL_ENT_t * const oentry = entry;
9405 entry = entry->next;
9414 /* clear and free a ptr table */
9417 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9422 ptr_table_clear(tbl);
9423 Safefree(tbl->tbl_ary);
9429 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9432 SvRV_set(dstr, SvWEAKREF(sstr)
9433 ? sv_dup(SvRV(sstr), param)
9434 : sv_dup_inc(SvRV(sstr), param));
9437 else if (SvPVX_const(sstr)) {
9438 /* Has something there */
9440 /* Normal PV - clone whole allocated space */
9441 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9442 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9443 /* Not that normal - actually sstr is copy on write.
9444 But we are a true, independant SV, so: */
9445 SvREADONLY_off(dstr);
9450 /* Special case - not normally malloced for some reason */
9451 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9452 /* A "shared" PV - clone it as "shared" PV */
9454 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9458 /* Some other special case - random pointer */
9459 SvPV_set(dstr, SvPVX(sstr));
9465 if (SvTYPE(dstr) == SVt_RV)
9466 SvRV_set(dstr, NULL);
9468 SvPV_set(dstr, NULL);
9472 /* duplicate an SV of any type (including AV, HV etc) */
9475 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9480 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9482 /* look for it in the table first */
9483 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9487 if(param->flags & CLONEf_JOIN_IN) {
9488 /** We are joining here so we don't want do clone
9489 something that is bad **/
9490 if (SvTYPE(sstr) == SVt_PVHV) {
9491 const char * const hvname = HvNAME_get(sstr);
9493 /** don't clone stashes if they already exist **/
9494 return (SV*)gv_stashpv(hvname,0);
9498 /* create anew and remember what it is */
9501 #ifdef DEBUG_LEAKING_SCALARS
9502 dstr->sv_debug_optype = sstr->sv_debug_optype;
9503 dstr->sv_debug_line = sstr->sv_debug_line;
9504 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9505 dstr->sv_debug_cloned = 1;
9506 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9509 ptr_table_store(PL_ptr_table, sstr, dstr);
9512 SvFLAGS(dstr) = SvFLAGS(sstr);
9513 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9514 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9517 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9518 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9519 PL_watch_pvx, SvPVX_const(sstr));
9522 /* don't clone objects whose class has asked us not to */
9523 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9524 SvFLAGS(dstr) &= ~SVTYPEMASK;
9529 switch (SvTYPE(sstr)) {
9534 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9535 SvIV_set(dstr, SvIVX(sstr));
9538 SvANY(dstr) = new_XNV();
9539 SvNV_set(dstr, SvNVX(sstr));
9542 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9543 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9547 /* These are all the types that need complex bodies allocating. */
9549 const svtype sv_type = SvTYPE(sstr);
9550 const struct body_details *const sv_type_details
9551 = bodies_by_type + sv_type;
9555 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9560 if (GvUNIQUE((GV*)sstr)) {
9561 /* Do sharing here, and fall through */
9574 assert(sv_type_details->size);
9575 if (sv_type_details->arena) {
9576 new_body_inline(new_body, sv_type_details->size, sv_type);
9578 = (void*)((char*)new_body - sv_type_details->offset);
9580 new_body = new_NOARENA(sv_type_details);
9584 SvANY(dstr) = new_body;
9587 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9588 ((char*)SvANY(dstr)) + sv_type_details->offset,
9589 sv_type_details->copy, char);
9591 Copy(((char*)SvANY(sstr)),
9592 ((char*)SvANY(dstr)),
9593 sv_type_details->size + sv_type_details->offset, char);
9596 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9597 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9599 /* The Copy above means that all the source (unduplicated) pointers
9600 are now in the destination. We can check the flags and the
9601 pointers in either, but it's possible that there's less cache
9602 missing by always going for the destination.
9603 FIXME - instrument and check that assumption */
9604 if (sv_type >= SVt_PVMG) {
9606 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9608 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9611 /* The cast silences a GCC warning about unhandled types. */
9612 switch ((int)sv_type) {
9624 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9625 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9626 LvTARG(dstr) = dstr;
9627 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9628 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9630 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9633 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9634 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9635 /* Don't call sv_add_backref here as it's going to be created
9636 as part of the magic cloning of the symbol table. */
9637 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9638 (void)GpREFCNT_inc(GvGP(dstr));
9641 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9642 if (IoOFP(dstr) == IoIFP(sstr))
9643 IoOFP(dstr) = IoIFP(dstr);
9645 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9646 /* PL_rsfp_filters entries have fake IoDIRP() */
9647 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9648 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9649 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9650 /* I have no idea why fake dirp (rsfps)
9651 should be treated differently but otherwise
9652 we end up with leaks -- sky*/
9653 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9654 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9655 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9657 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9658 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9659 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9661 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9662 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9663 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9666 if (AvARRAY((AV*)sstr)) {
9667 SV **dst_ary, **src_ary;
9668 SSize_t items = AvFILLp((AV*)sstr) + 1;
9670 src_ary = AvARRAY((AV*)sstr);
9671 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9672 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9673 SvPV_set(dstr, (char*)dst_ary);
9674 AvALLOC((AV*)dstr) = dst_ary;
9675 if (AvREAL((AV*)sstr)) {
9677 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9681 *dst_ary++ = sv_dup(*src_ary++, param);
9683 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9684 while (items-- > 0) {
9685 *dst_ary++ = &PL_sv_undef;
9689 SvPV_set(dstr, NULL);
9690 AvALLOC((AV*)dstr) = (SV**)NULL;
9697 if (HvARRAY((HV*)sstr)) {
9699 const bool sharekeys = !!HvSHAREKEYS(sstr);
9700 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9701 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9703 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9704 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9706 HvARRAY(dstr) = (HE**)darray;
9707 while (i <= sxhv->xhv_max) {
9708 const HE *source = HvARRAY(sstr)[i];
9709 HvARRAY(dstr)[i] = source
9710 ? he_dup(source, sharekeys, param) : 0;
9714 struct xpvhv_aux * const saux = HvAUX(sstr);
9715 struct xpvhv_aux * const daux = HvAUX(dstr);
9716 /* This flag isn't copied. */
9717 /* SvOOK_on(hv) attacks the IV flags. */
9718 SvFLAGS(dstr) |= SVf_OOK;
9720 hvname = saux->xhv_name;
9722 = hvname ? hek_dup(hvname, param) : hvname;
9724 daux->xhv_riter = saux->xhv_riter;
9725 daux->xhv_eiter = saux->xhv_eiter
9726 ? he_dup(saux->xhv_eiter,
9727 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9728 daux->xhv_backreferences = saux->xhv_backreferences
9729 ? (AV*) SvREFCNT_inc(
9737 SvPV_set(dstr, NULL);
9739 /* Record stashes for possible cloning in Perl_clone(). */
9741 av_push(param->stashes, dstr);
9746 /* NOTE: not refcounted */
9747 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9749 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9751 if (CvCONST(dstr)) {
9752 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9753 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9754 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9756 /* don't dup if copying back - CvGV isn't refcounted, so the
9757 * duped GV may never be freed. A bit of a hack! DAPM */
9758 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9759 NULL : gv_dup(CvGV(dstr), param) ;
9760 if (!(param->flags & CLONEf_COPY_STACKS)) {
9763 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9766 ? cv_dup( CvOUTSIDE(dstr), param)
9767 : cv_dup_inc(CvOUTSIDE(dstr), param);
9769 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9775 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9781 /* duplicate a context */
9784 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9789 return (PERL_CONTEXT*)NULL;
9791 /* look for it in the table first */
9792 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9796 /* create anew and remember what it is */
9797 Newxz(ncxs, max + 1, PERL_CONTEXT);
9798 ptr_table_store(PL_ptr_table, cxs, ncxs);
9801 PERL_CONTEXT * const cx = &cxs[ix];
9802 PERL_CONTEXT * const ncx = &ncxs[ix];
9803 ncx->cx_type = cx->cx_type;
9804 if (CxTYPE(cx) == CXt_SUBST) {
9805 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9808 ncx->blk_oldsp = cx->blk_oldsp;
9809 ncx->blk_oldcop = cx->blk_oldcop;
9810 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9811 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9812 ncx->blk_oldpm = cx->blk_oldpm;
9813 ncx->blk_gimme = cx->blk_gimme;
9814 switch (CxTYPE(cx)) {
9816 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9817 ? cv_dup_inc(cx->blk_sub.cv, param)
9818 : cv_dup(cx->blk_sub.cv,param));
9819 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9820 ? av_dup_inc(cx->blk_sub.argarray, param)
9822 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9823 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9824 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9825 ncx->blk_sub.lval = cx->blk_sub.lval;
9826 ncx->blk_sub.retop = cx->blk_sub.retop;
9829 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9830 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9831 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9832 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9833 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9834 ncx->blk_eval.retop = cx->blk_eval.retop;
9837 ncx->blk_loop.label = cx->blk_loop.label;
9838 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9839 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9840 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9841 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9842 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9843 ? cx->blk_loop.iterdata
9844 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9845 ncx->blk_loop.oldcomppad
9846 = (PAD*)ptr_table_fetch(PL_ptr_table,
9847 cx->blk_loop.oldcomppad);
9848 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9849 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9850 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9851 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9852 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9855 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9856 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9857 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9858 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9859 ncx->blk_sub.retop = cx->blk_sub.retop;
9871 /* duplicate a stack info structure */
9874 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9879 return (PERL_SI*)NULL;
9881 /* look for it in the table first */
9882 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9886 /* create anew and remember what it is */
9887 Newxz(nsi, 1, PERL_SI);
9888 ptr_table_store(PL_ptr_table, si, nsi);
9890 nsi->si_stack = av_dup_inc(si->si_stack, param);
9891 nsi->si_cxix = si->si_cxix;
9892 nsi->si_cxmax = si->si_cxmax;
9893 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9894 nsi->si_type = si->si_type;
9895 nsi->si_prev = si_dup(si->si_prev, param);
9896 nsi->si_next = si_dup(si->si_next, param);
9897 nsi->si_markoff = si->si_markoff;
9902 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9903 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9904 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9905 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9906 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9907 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9908 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9909 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9910 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9911 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9912 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9913 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9914 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9915 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9918 #define pv_dup_inc(p) SAVEPV(p)
9919 #define pv_dup(p) SAVEPV(p)
9920 #define svp_dup_inc(p,pp) any_dup(p,pp)
9922 /* map any object to the new equivent - either something in the
9923 * ptr table, or something in the interpreter structure
9927 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9934 /* look for it in the table first */
9935 ret = ptr_table_fetch(PL_ptr_table, v);
9939 /* see if it is part of the interpreter structure */
9940 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9941 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9949 /* duplicate the save stack */
9952 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9954 ANY * const ss = proto_perl->Tsavestack;
9955 const I32 max = proto_perl->Tsavestack_max;
9956 I32 ix = proto_perl->Tsavestack_ix;
9968 void (*dptr) (void*);
9969 void (*dxptr) (pTHX_ void*);
9971 Newxz(nss, max, ANY);
9974 I32 i = POPINT(ss,ix);
9977 case SAVEt_ITEM: /* normal string */
9978 sv = (SV*)POPPTR(ss,ix);
9979 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9980 sv = (SV*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9983 case SAVEt_SV: /* scalar reference */
9984 sv = (SV*)POPPTR(ss,ix);
9985 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9986 gv = (GV*)POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9989 case SAVEt_GENERIC_PVREF: /* generic char* */
9990 c = (char*)POPPTR(ss,ix);
9991 TOPPTR(nss,ix) = pv_dup(c);
9992 ptr = POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9995 case SAVEt_SHARED_PVREF: /* char* in shared space */
9996 c = (char*)POPPTR(ss,ix);
9997 TOPPTR(nss,ix) = savesharedpv(c);
9998 ptr = POPPTR(ss,ix);
9999 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10001 case SAVEt_GENERIC_SVREF: /* generic sv */
10002 case SAVEt_SVREF: /* scalar reference */
10003 sv = (SV*)POPPTR(ss,ix);
10004 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10005 ptr = POPPTR(ss,ix);
10006 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10008 case SAVEt_AV: /* array reference */
10009 av = (AV*)POPPTR(ss,ix);
10010 TOPPTR(nss,ix) = av_dup_inc(av, param);
10011 gv = (GV*)POPPTR(ss,ix);
10012 TOPPTR(nss,ix) = gv_dup(gv, param);
10014 case SAVEt_HV: /* hash reference */
10015 hv = (HV*)POPPTR(ss,ix);
10016 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10017 gv = (GV*)POPPTR(ss,ix);
10018 TOPPTR(nss,ix) = gv_dup(gv, param);
10020 case SAVEt_INT: /* int reference */
10021 ptr = POPPTR(ss,ix);
10022 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10023 intval = (int)POPINT(ss,ix);
10024 TOPINT(nss,ix) = intval;
10026 case SAVEt_LONG: /* long reference */
10027 ptr = POPPTR(ss,ix);
10028 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10029 longval = (long)POPLONG(ss,ix);
10030 TOPLONG(nss,ix) = longval;
10032 case SAVEt_I32: /* I32 reference */
10033 case SAVEt_I16: /* I16 reference */
10034 case SAVEt_I8: /* I8 reference */
10035 ptr = POPPTR(ss,ix);
10036 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10038 TOPINT(nss,ix) = i;
10040 case SAVEt_IV: /* IV reference */
10041 ptr = POPPTR(ss,ix);
10042 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10044 TOPIV(nss,ix) = iv;
10046 case SAVEt_SPTR: /* SV* reference */
10047 ptr = POPPTR(ss,ix);
10048 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10049 sv = (SV*)POPPTR(ss,ix);
10050 TOPPTR(nss,ix) = sv_dup(sv, param);
10052 case SAVEt_VPTR: /* random* reference */
10053 ptr = POPPTR(ss,ix);
10054 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10055 ptr = POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10058 case SAVEt_PPTR: /* char* reference */
10059 ptr = POPPTR(ss,ix);
10060 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10061 c = (char*)POPPTR(ss,ix);
10062 TOPPTR(nss,ix) = pv_dup(c);
10064 case SAVEt_HPTR: /* HV* reference */
10065 ptr = POPPTR(ss,ix);
10066 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10067 hv = (HV*)POPPTR(ss,ix);
10068 TOPPTR(nss,ix) = hv_dup(hv, param);
10070 case SAVEt_APTR: /* AV* reference */
10071 ptr = POPPTR(ss,ix);
10072 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10073 av = (AV*)POPPTR(ss,ix);
10074 TOPPTR(nss,ix) = av_dup(av, param);
10077 gv = (GV*)POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = gv_dup(gv, param);
10080 case SAVEt_GP: /* scalar reference */
10081 gp = (GP*)POPPTR(ss,ix);
10082 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10083 (void)GpREFCNT_inc(gp);
10084 gv = (GV*)POPPTR(ss,ix);
10085 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10086 c = (char*)POPPTR(ss,ix);
10087 TOPPTR(nss,ix) = pv_dup(c);
10089 TOPIV(nss,ix) = iv;
10091 TOPIV(nss,ix) = iv;
10094 case SAVEt_MORTALIZESV:
10095 sv = (SV*)POPPTR(ss,ix);
10096 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10099 ptr = POPPTR(ss,ix);
10100 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10101 /* these are assumed to be refcounted properly */
10103 switch (((OP*)ptr)->op_type) {
10105 case OP_LEAVESUBLV:
10109 case OP_LEAVEWRITE:
10110 TOPPTR(nss,ix) = ptr;
10115 TOPPTR(nss,ix) = Nullop;
10120 TOPPTR(nss,ix) = Nullop;
10123 c = (char*)POPPTR(ss,ix);
10124 TOPPTR(nss,ix) = pv_dup_inc(c);
10126 case SAVEt_CLEARSV:
10127 longval = POPLONG(ss,ix);
10128 TOPLONG(nss,ix) = longval;
10131 hv = (HV*)POPPTR(ss,ix);
10132 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10133 c = (char*)POPPTR(ss,ix);
10134 TOPPTR(nss,ix) = pv_dup_inc(c);
10136 TOPINT(nss,ix) = i;
10138 case SAVEt_DESTRUCTOR:
10139 ptr = POPPTR(ss,ix);
10140 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10141 dptr = POPDPTR(ss,ix);
10142 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10143 any_dup(FPTR2DPTR(void *, dptr),
10146 case SAVEt_DESTRUCTOR_X:
10147 ptr = POPPTR(ss,ix);
10148 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10149 dxptr = POPDXPTR(ss,ix);
10150 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10151 any_dup(FPTR2DPTR(void *, dxptr),
10154 case SAVEt_REGCONTEXT:
10157 TOPINT(nss,ix) = i;
10160 case SAVEt_STACK_POS: /* Position on Perl stack */
10162 TOPINT(nss,ix) = i;
10164 case SAVEt_AELEM: /* array element */
10165 sv = (SV*)POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10168 TOPINT(nss,ix) = i;
10169 av = (AV*)POPPTR(ss,ix);
10170 TOPPTR(nss,ix) = av_dup_inc(av, param);
10172 case SAVEt_HELEM: /* hash element */
10173 sv = (SV*)POPPTR(ss,ix);
10174 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10175 sv = (SV*)POPPTR(ss,ix);
10176 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10177 hv = (HV*)POPPTR(ss,ix);
10178 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10181 ptr = POPPTR(ss,ix);
10182 TOPPTR(nss,ix) = ptr;
10186 TOPINT(nss,ix) = i;
10188 case SAVEt_COMPPAD:
10189 av = (AV*)POPPTR(ss,ix);
10190 TOPPTR(nss,ix) = av_dup(av, param);
10193 longval = (long)POPLONG(ss,ix);
10194 TOPLONG(nss,ix) = longval;
10195 ptr = POPPTR(ss,ix);
10196 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10197 sv = (SV*)POPPTR(ss,ix);
10198 TOPPTR(nss,ix) = sv_dup(sv, param);
10201 ptr = POPPTR(ss,ix);
10202 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10203 longval = (long)POPBOOL(ss,ix);
10204 TOPBOOL(nss,ix) = (bool)longval;
10206 case SAVEt_SET_SVFLAGS:
10208 TOPINT(nss,ix) = i;
10210 TOPINT(nss,ix) = i;
10211 sv = (SV*)POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = sv_dup(sv, param);
10215 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10223 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10224 * flag to the result. This is done for each stash before cloning starts,
10225 * so we know which stashes want their objects cloned */
10228 do_mark_cloneable_stash(pTHX_ SV *sv)
10230 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10232 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10233 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10234 if (cloner && GvCV(cloner)) {
10241 XPUSHs(sv_2mortal(newSVhek(hvname)));
10243 call_sv((SV*)GvCV(cloner), G_SCALAR);
10250 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10258 =for apidoc perl_clone
10260 Create and return a new interpreter by cloning the current one.
10262 perl_clone takes these flags as parameters:
10264 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10265 without it we only clone the data and zero the stacks,
10266 with it we copy the stacks and the new perl interpreter is
10267 ready to run at the exact same point as the previous one.
10268 The pseudo-fork code uses COPY_STACKS while the
10269 threads->new doesn't.
10271 CLONEf_KEEP_PTR_TABLE
10272 perl_clone keeps a ptr_table with the pointer of the old
10273 variable as a key and the new variable as a value,
10274 this allows it to check if something has been cloned and not
10275 clone it again but rather just use the value and increase the
10276 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10277 the ptr_table using the function
10278 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10279 reason to keep it around is if you want to dup some of your own
10280 variable who are outside the graph perl scans, example of this
10281 code is in threads.xs create
10284 This is a win32 thing, it is ignored on unix, it tells perls
10285 win32host code (which is c++) to clone itself, this is needed on
10286 win32 if you want to run two threads at the same time,
10287 if you just want to do some stuff in a separate perl interpreter
10288 and then throw it away and return to the original one,
10289 you don't need to do anything.
10294 /* XXX the above needs expanding by someone who actually understands it ! */
10295 EXTERN_C PerlInterpreter *
10296 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10299 perl_clone(PerlInterpreter *proto_perl, UV flags)
10302 #ifdef PERL_IMPLICIT_SYS
10304 /* perlhost.h so we need to call into it
10305 to clone the host, CPerlHost should have a c interface, sky */
10307 if (flags & CLONEf_CLONE_HOST) {
10308 return perl_clone_host(proto_perl,flags);
10310 return perl_clone_using(proto_perl, flags,
10312 proto_perl->IMemShared,
10313 proto_perl->IMemParse,
10315 proto_perl->IStdIO,
10319 proto_perl->IProc);
10323 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10324 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10325 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10326 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10327 struct IPerlDir* ipD, struct IPerlSock* ipS,
10328 struct IPerlProc* ipP)
10330 /* XXX many of the string copies here can be optimized if they're
10331 * constants; they need to be allocated as common memory and just
10332 * their pointers copied. */
10335 CLONE_PARAMS clone_params;
10336 CLONE_PARAMS* param = &clone_params;
10338 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10339 /* for each stash, determine whether its objects should be cloned */
10340 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10341 PERL_SET_THX(my_perl);
10344 Poison(my_perl, 1, PerlInterpreter);
10346 PL_curcop = (COP *)Nullop;
10350 PL_savestack_ix = 0;
10351 PL_savestack_max = -1;
10352 PL_sig_pending = 0;
10353 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10354 # else /* !DEBUGGING */
10355 Zero(my_perl, 1, PerlInterpreter);
10356 # endif /* DEBUGGING */
10358 /* host pointers */
10360 PL_MemShared = ipMS;
10361 PL_MemParse = ipMP;
10368 #else /* !PERL_IMPLICIT_SYS */
10370 CLONE_PARAMS clone_params;
10371 CLONE_PARAMS* param = &clone_params;
10372 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10373 /* for each stash, determine whether its objects should be cloned */
10374 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10375 PERL_SET_THX(my_perl);
10378 Poison(my_perl, 1, PerlInterpreter);
10380 PL_curcop = (COP *)Nullop;
10384 PL_savestack_ix = 0;
10385 PL_savestack_max = -1;
10386 PL_sig_pending = 0;
10387 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10388 # else /* !DEBUGGING */
10389 Zero(my_perl, 1, PerlInterpreter);
10390 # endif /* DEBUGGING */
10391 #endif /* PERL_IMPLICIT_SYS */
10392 param->flags = flags;
10393 param->proto_perl = proto_perl;
10395 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10397 PL_body_arenas = NULL;
10398 Zero(&PL_body_roots, 1, PL_body_roots);
10400 PL_nice_chunk = NULL;
10401 PL_nice_chunk_size = 0;
10403 PL_sv_objcount = 0;
10405 PL_sv_arenaroot = NULL;
10407 PL_debug = proto_perl->Idebug;
10409 PL_hash_seed = proto_perl->Ihash_seed;
10410 PL_rehash_seed = proto_perl->Irehash_seed;
10412 #ifdef USE_REENTRANT_API
10413 /* XXX: things like -Dm will segfault here in perlio, but doing
10414 * PERL_SET_CONTEXT(proto_perl);
10415 * breaks too many other things
10417 Perl_reentrant_init(aTHX);
10420 /* create SV map for pointer relocation */
10421 PL_ptr_table = ptr_table_new();
10423 /* initialize these special pointers as early as possible */
10424 SvANY(&PL_sv_undef) = NULL;
10425 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10426 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10427 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10429 SvANY(&PL_sv_no) = new_XPVNV();
10430 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10431 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10432 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10433 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10434 SvCUR_set(&PL_sv_no, 0);
10435 SvLEN_set(&PL_sv_no, 1);
10436 SvIV_set(&PL_sv_no, 0);
10437 SvNV_set(&PL_sv_no, 0);
10438 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10440 SvANY(&PL_sv_yes) = new_XPVNV();
10441 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10442 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10443 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10444 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10445 SvCUR_set(&PL_sv_yes, 1);
10446 SvLEN_set(&PL_sv_yes, 2);
10447 SvIV_set(&PL_sv_yes, 1);
10448 SvNV_set(&PL_sv_yes, 1);
10449 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10451 /* create (a non-shared!) shared string table */
10452 PL_strtab = newHV();
10453 HvSHAREKEYS_off(PL_strtab);
10454 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10455 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10457 PL_compiling = proto_perl->Icompiling;
10459 /* These two PVs will be free'd special way so must set them same way op.c does */
10460 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10461 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10463 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10464 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10466 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10467 if (!specialWARN(PL_compiling.cop_warnings))
10468 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10469 if (!specialCopIO(PL_compiling.cop_io))
10470 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10471 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10473 /* pseudo environmental stuff */
10474 PL_origargc = proto_perl->Iorigargc;
10475 PL_origargv = proto_perl->Iorigargv;
10477 param->stashes = newAV(); /* Setup array of objects to call clone on */
10479 /* Set tainting stuff before PerlIO_debug can possibly get called */
10480 PL_tainting = proto_perl->Itainting;
10481 PL_taint_warn = proto_perl->Itaint_warn;
10483 #ifdef PERLIO_LAYERS
10484 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10485 PerlIO_clone(aTHX_ proto_perl, param);
10488 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10489 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10490 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10491 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10492 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10493 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10496 PL_minus_c = proto_perl->Iminus_c;
10497 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10498 PL_localpatches = proto_perl->Ilocalpatches;
10499 PL_splitstr = proto_perl->Isplitstr;
10500 PL_preprocess = proto_perl->Ipreprocess;
10501 PL_minus_n = proto_perl->Iminus_n;
10502 PL_minus_p = proto_perl->Iminus_p;
10503 PL_minus_l = proto_perl->Iminus_l;
10504 PL_minus_a = proto_perl->Iminus_a;
10505 PL_minus_E = proto_perl->Iminus_E;
10506 PL_minus_F = proto_perl->Iminus_F;
10507 PL_doswitches = proto_perl->Idoswitches;
10508 PL_dowarn = proto_perl->Idowarn;
10509 PL_doextract = proto_perl->Idoextract;
10510 PL_sawampersand = proto_perl->Isawampersand;
10511 PL_unsafe = proto_perl->Iunsafe;
10512 PL_inplace = SAVEPV(proto_perl->Iinplace);
10513 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10514 PL_perldb = proto_perl->Iperldb;
10515 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10516 PL_exit_flags = proto_perl->Iexit_flags;
10518 /* magical thingies */
10519 /* XXX time(&PL_basetime) when asked for? */
10520 PL_basetime = proto_perl->Ibasetime;
10521 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10523 PL_maxsysfd = proto_perl->Imaxsysfd;
10524 PL_multiline = proto_perl->Imultiline;
10525 PL_statusvalue = proto_perl->Istatusvalue;
10527 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10529 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10531 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10533 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10534 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10535 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10537 /* Clone the regex array */
10538 PL_regex_padav = newAV();
10540 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10541 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10543 av_push(PL_regex_padav,
10544 sv_dup_inc(regexen[0],param));
10545 for(i = 1; i <= len; i++) {
10546 const SV * const regex = regexen[i];
10549 ? sv_dup_inc(regex, param)
10551 newSViv(PTR2IV(re_dup(
10552 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10554 av_push(PL_regex_padav, sv);
10557 PL_regex_pad = AvARRAY(PL_regex_padav);
10559 /* shortcuts to various I/O objects */
10560 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10561 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10562 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10563 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10564 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10565 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10567 /* shortcuts to regexp stuff */
10568 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10570 /* shortcuts to misc objects */
10571 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10573 /* shortcuts to debugging objects */
10574 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10575 PL_DBline = gv_dup(proto_perl->IDBline, param);
10576 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10577 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10578 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10579 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10580 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10581 PL_lineary = av_dup(proto_perl->Ilineary, param);
10582 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10584 /* symbol tables */
10585 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10586 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10587 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10588 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10589 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10591 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10592 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10593 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10594 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10595 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10596 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10598 PL_sub_generation = proto_perl->Isub_generation;
10600 /* funky return mechanisms */
10601 PL_forkprocess = proto_perl->Iforkprocess;
10603 /* subprocess state */
10604 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10606 /* internal state */
10607 PL_maxo = proto_perl->Imaxo;
10608 if (proto_perl->Iop_mask)
10609 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10612 /* PL_asserting = proto_perl->Iasserting; */
10614 /* current interpreter roots */
10615 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10616 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10617 PL_main_start = proto_perl->Imain_start;
10618 PL_eval_root = proto_perl->Ieval_root;
10619 PL_eval_start = proto_perl->Ieval_start;
10621 /* runtime control stuff */
10622 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10623 PL_copline = proto_perl->Icopline;
10625 PL_filemode = proto_perl->Ifilemode;
10626 PL_lastfd = proto_perl->Ilastfd;
10627 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10630 PL_gensym = proto_perl->Igensym;
10631 PL_preambled = proto_perl->Ipreambled;
10632 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10633 PL_laststatval = proto_perl->Ilaststatval;
10634 PL_laststype = proto_perl->Ilaststype;
10637 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10639 /* interpreter atexit processing */
10640 PL_exitlistlen = proto_perl->Iexitlistlen;
10641 if (PL_exitlistlen) {
10642 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10643 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10646 PL_exitlist = (PerlExitListEntry*)NULL;
10648 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10649 if (PL_my_cxt_size) {
10650 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10651 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10654 PL_my_cxt_list = (void**)NULL;
10655 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10656 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10657 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10659 PL_profiledata = NULL;
10660 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10661 /* PL_rsfp_filters entries have fake IoDIRP() */
10662 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10664 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10666 PAD_CLONE_VARS(proto_perl, param);
10668 #ifdef HAVE_INTERP_INTERN
10669 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10672 /* more statics moved here */
10673 PL_generation = proto_perl->Igeneration;
10674 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10676 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10677 PL_in_clean_all = proto_perl->Iin_clean_all;
10679 PL_uid = proto_perl->Iuid;
10680 PL_euid = proto_perl->Ieuid;
10681 PL_gid = proto_perl->Igid;
10682 PL_egid = proto_perl->Iegid;
10683 PL_nomemok = proto_perl->Inomemok;
10684 PL_an = proto_perl->Ian;
10685 PL_evalseq = proto_perl->Ievalseq;
10686 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10687 PL_origalen = proto_perl->Iorigalen;
10688 #ifdef PERL_USES_PL_PIDSTATUS
10689 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10691 PL_osname = SAVEPV(proto_perl->Iosname);
10692 PL_sighandlerp = proto_perl->Isighandlerp;
10694 PL_runops = proto_perl->Irunops;
10696 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10699 PL_cshlen = proto_perl->Icshlen;
10700 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10703 PL_lex_state = proto_perl->Ilex_state;
10704 PL_lex_defer = proto_perl->Ilex_defer;
10705 PL_lex_expect = proto_perl->Ilex_expect;
10706 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10707 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10708 PL_lex_starts = proto_perl->Ilex_starts;
10709 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10710 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10711 PL_lex_op = proto_perl->Ilex_op;
10712 PL_lex_inpat = proto_perl->Ilex_inpat;
10713 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10714 PL_lex_brackets = proto_perl->Ilex_brackets;
10715 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10716 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10717 PL_lex_casemods = proto_perl->Ilex_casemods;
10718 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10719 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10721 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10722 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10723 PL_nexttoke = proto_perl->Inexttoke;
10725 /* XXX This is probably masking the deeper issue of why
10726 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10727 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10728 * (A little debugging with a watchpoint on it may help.)
10730 if (SvANY(proto_perl->Ilinestr)) {
10731 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10732 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10733 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10734 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10735 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10736 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10737 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10738 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10739 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10742 PL_linestr = newSV(79);
10743 sv_upgrade(PL_linestr,SVt_PVIV);
10744 sv_setpvn(PL_linestr,"",0);
10745 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10747 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10748 PL_pending_ident = proto_perl->Ipending_ident;
10749 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10751 PL_expect = proto_perl->Iexpect;
10753 PL_multi_start = proto_perl->Imulti_start;
10754 PL_multi_end = proto_perl->Imulti_end;
10755 PL_multi_open = proto_perl->Imulti_open;
10756 PL_multi_close = proto_perl->Imulti_close;
10758 PL_error_count = proto_perl->Ierror_count;
10759 PL_subline = proto_perl->Isubline;
10760 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10762 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10763 if (SvANY(proto_perl->Ilinestr)) {
10764 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10765 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10766 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10767 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10768 PL_last_lop_op = proto_perl->Ilast_lop_op;
10771 PL_last_uni = SvPVX(PL_linestr);
10772 PL_last_lop = SvPVX(PL_linestr);
10773 PL_last_lop_op = 0;
10775 PL_in_my = proto_perl->Iin_my;
10776 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10778 PL_cryptseen = proto_perl->Icryptseen;
10781 PL_hints = proto_perl->Ihints;
10783 PL_amagic_generation = proto_perl->Iamagic_generation;
10785 #ifdef USE_LOCALE_COLLATE
10786 PL_collation_ix = proto_perl->Icollation_ix;
10787 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10788 PL_collation_standard = proto_perl->Icollation_standard;
10789 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10790 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10791 #endif /* USE_LOCALE_COLLATE */
10793 #ifdef USE_LOCALE_NUMERIC
10794 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10795 PL_numeric_standard = proto_perl->Inumeric_standard;
10796 PL_numeric_local = proto_perl->Inumeric_local;
10797 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10798 #endif /* !USE_LOCALE_NUMERIC */
10800 /* utf8 character classes */
10801 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10802 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10803 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10804 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10805 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10806 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10807 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10808 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10809 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10810 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10811 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10812 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10813 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10814 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10815 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10816 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10817 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10818 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10819 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10820 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10822 /* Did the locale setup indicate UTF-8? */
10823 PL_utf8locale = proto_perl->Iutf8locale;
10824 /* Unicode features (see perlrun/-C) */
10825 PL_unicode = proto_perl->Iunicode;
10827 /* Pre-5.8 signals control */
10828 PL_signals = proto_perl->Isignals;
10830 /* times() ticks per second */
10831 PL_clocktick = proto_perl->Iclocktick;
10833 /* Recursion stopper for PerlIO_find_layer */
10834 PL_in_load_module = proto_perl->Iin_load_module;
10836 /* sort() routine */
10837 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10839 /* Not really needed/useful since the reenrant_retint is "volatile",
10840 * but do it for consistency's sake. */
10841 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10843 /* Hooks to shared SVs and locks. */
10844 PL_sharehook = proto_perl->Isharehook;
10845 PL_lockhook = proto_perl->Ilockhook;
10846 PL_unlockhook = proto_perl->Iunlockhook;
10847 PL_threadhook = proto_perl->Ithreadhook;
10849 PL_runops_std = proto_perl->Irunops_std;
10850 PL_runops_dbg = proto_perl->Irunops_dbg;
10852 #ifdef THREADS_HAVE_PIDS
10853 PL_ppid = proto_perl->Ippid;
10857 PL_last_swash_hv = NULL; /* reinits on demand */
10858 PL_last_swash_klen = 0;
10859 PL_last_swash_key[0]= '\0';
10860 PL_last_swash_tmps = (U8*)NULL;
10861 PL_last_swash_slen = 0;
10863 PL_glob_index = proto_perl->Iglob_index;
10864 PL_srand_called = proto_perl->Isrand_called;
10865 PL_uudmap['M'] = 0; /* reinits on demand */
10866 PL_bitcount = NULL; /* reinits on demand */
10868 if (proto_perl->Ipsig_pend) {
10869 Newxz(PL_psig_pend, SIG_SIZE, int);
10872 PL_psig_pend = (int*)NULL;
10875 if (proto_perl->Ipsig_ptr) {
10876 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10877 Newxz(PL_psig_name, SIG_SIZE, SV*);
10878 for (i = 1; i < SIG_SIZE; i++) {
10879 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10880 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10884 PL_psig_ptr = (SV**)NULL;
10885 PL_psig_name = (SV**)NULL;
10888 /* thrdvar.h stuff */
10890 if (flags & CLONEf_COPY_STACKS) {
10891 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10892 PL_tmps_ix = proto_perl->Ttmps_ix;
10893 PL_tmps_max = proto_perl->Ttmps_max;
10894 PL_tmps_floor = proto_perl->Ttmps_floor;
10895 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10897 while (i <= PL_tmps_ix) {
10898 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10902 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10903 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10904 Newxz(PL_markstack, i, I32);
10905 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10906 - proto_perl->Tmarkstack);
10907 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10908 - proto_perl->Tmarkstack);
10909 Copy(proto_perl->Tmarkstack, PL_markstack,
10910 PL_markstack_ptr - PL_markstack + 1, I32);
10912 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10913 * NOTE: unlike the others! */
10914 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10915 PL_scopestack_max = proto_perl->Tscopestack_max;
10916 Newxz(PL_scopestack, PL_scopestack_max, I32);
10917 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10919 /* NOTE: si_dup() looks at PL_markstack */
10920 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10922 /* PL_curstack = PL_curstackinfo->si_stack; */
10923 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10924 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10926 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10927 PL_stack_base = AvARRAY(PL_curstack);
10928 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10929 - proto_perl->Tstack_base);
10930 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10932 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10933 * NOTE: unlike the others! */
10934 PL_savestack_ix = proto_perl->Tsavestack_ix;
10935 PL_savestack_max = proto_perl->Tsavestack_max;
10936 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10937 PL_savestack = ss_dup(proto_perl, param);
10941 ENTER; /* perl_destruct() wants to LEAVE; */
10943 /* although we're not duplicating the tmps stack, we should still
10944 * add entries for any SVs on the tmps stack that got cloned by a
10945 * non-refcount means (eg a temp in @_); otherwise they will be
10948 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10949 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10950 proto_perl->Ttmps_stack[i]);
10951 if (nsv && !SvREFCNT(nsv)) {
10953 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10958 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10959 PL_top_env = &PL_start_env;
10961 PL_op = proto_perl->Top;
10964 PL_Xpv = (XPV*)NULL;
10965 PL_na = proto_perl->Tna;
10967 PL_statbuf = proto_perl->Tstatbuf;
10968 PL_statcache = proto_perl->Tstatcache;
10969 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10970 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10972 PL_timesbuf = proto_perl->Ttimesbuf;
10975 PL_tainted = proto_perl->Ttainted;
10976 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10977 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10978 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10979 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10980 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10981 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10982 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10983 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10984 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10986 PL_restartop = proto_perl->Trestartop;
10987 PL_in_eval = proto_perl->Tin_eval;
10988 PL_delaymagic = proto_perl->Tdelaymagic;
10989 PL_dirty = proto_perl->Tdirty;
10990 PL_localizing = proto_perl->Tlocalizing;
10992 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10993 PL_hv_fetch_ent_mh = Nullhe;
10994 PL_modcount = proto_perl->Tmodcount;
10995 PL_lastgotoprobe = Nullop;
10996 PL_dumpindent = proto_perl->Tdumpindent;
10998 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10999 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11000 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11001 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11002 PL_efloatbuf = NULL; /* reinits on demand */
11003 PL_efloatsize = 0; /* reinits on demand */
11007 PL_screamfirst = NULL;
11008 PL_screamnext = NULL;
11009 PL_maxscream = -1; /* reinits on demand */
11010 PL_lastscream = NULL;
11012 PL_watchaddr = NULL;
11015 PL_regdummy = proto_perl->Tregdummy;
11016 PL_regprecomp = NULL;
11019 PL_colorset = 0; /* reinits PL_colors[] */
11020 /*PL_colors[6] = {0,0,0,0,0,0};*/
11021 PL_reginput = NULL;
11024 PL_regstartp = (I32*)NULL;
11025 PL_regendp = (I32*)NULL;
11026 PL_reglastparen = (U32*)NULL;
11027 PL_reglastcloseparen = (U32*)NULL;
11029 PL_reg_start_tmp = (char**)NULL;
11030 PL_reg_start_tmpl = 0;
11031 PL_regdata = (struct reg_data*)NULL;
11034 PL_reg_eval_set = 0;
11036 PL_regprogram = (regnode*)NULL;
11038 PL_regcc = (CURCUR*)NULL;
11039 PL_reg_call_cc = (struct re_cc_state*)NULL;
11040 PL_reg_re = (regexp*)NULL;
11041 PL_reg_ganch = NULL;
11043 PL_reg_match_utf8 = FALSE;
11044 PL_reg_magic = (MAGIC*)NULL;
11046 PL_reg_oldcurpm = (PMOP*)NULL;
11047 PL_reg_curpm = (PMOP*)NULL;
11048 PL_reg_oldsaved = NULL;
11049 PL_reg_oldsavedlen = 0;
11050 #ifdef PERL_OLD_COPY_ON_WRITE
11053 PL_reg_maxiter = 0;
11054 PL_reg_leftiter = 0;
11055 PL_reg_poscache = NULL;
11056 PL_reg_poscache_size= 0;
11058 /* RE engine - function pointers */
11059 PL_regcompp = proto_perl->Tregcompp;
11060 PL_regexecp = proto_perl->Tregexecp;
11061 PL_regint_start = proto_perl->Tregint_start;
11062 PL_regint_string = proto_perl->Tregint_string;
11063 PL_regfree = proto_perl->Tregfree;
11065 PL_reginterp_cnt = 0;
11066 PL_reg_starttry = 0;
11068 /* Pluggable optimizer */
11069 PL_peepp = proto_perl->Tpeepp;
11071 PL_stashcache = newHV();
11073 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11074 ptr_table_free(PL_ptr_table);
11075 PL_ptr_table = NULL;
11078 /* Call the ->CLONE method, if it exists, for each of the stashes
11079 identified by sv_dup() above.
11081 while(av_len(param->stashes) != -1) {
11082 HV* const stash = (HV*) av_shift(param->stashes);
11083 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11084 if (cloner && GvCV(cloner)) {
11089 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11091 call_sv((SV*)GvCV(cloner), G_DISCARD);
11097 SvREFCNT_dec(param->stashes);
11099 /* orphaned? eg threads->new inside BEGIN or use */
11100 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11101 (void)SvREFCNT_inc(PL_compcv);
11102 SAVEFREESV(PL_compcv);
11108 #endif /* USE_ITHREADS */
11111 =head1 Unicode Support
11113 =for apidoc sv_recode_to_utf8
11115 The encoding is assumed to be an Encode object, on entry the PV
11116 of the sv is assumed to be octets in that encoding, and the sv
11117 will be converted into Unicode (and UTF-8).
11119 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11120 is not a reference, nothing is done to the sv. If the encoding is not
11121 an C<Encode::XS> Encoding object, bad things will happen.
11122 (See F<lib/encoding.pm> and L<Encode>).
11124 The PV of the sv is returned.
11129 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11132 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11146 Passing sv_yes is wrong - it needs to be or'ed set of constants
11147 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11148 remove converted chars from source.
11150 Both will default the value - let them.
11152 XPUSHs(&PL_sv_yes);
11155 call_method("decode", G_SCALAR);
11159 s = SvPV_const(uni, len);
11160 if (s != SvPVX_const(sv)) {
11161 SvGROW(sv, len + 1);
11162 Move(s, SvPVX(sv), len + 1, char);
11163 SvCUR_set(sv, len);
11170 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11174 =for apidoc sv_cat_decode
11176 The encoding is assumed to be an Encode object, the PV of the ssv is
11177 assumed to be octets in that encoding and decoding the input starts
11178 from the position which (PV + *offset) pointed to. The dsv will be
11179 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11180 when the string tstr appears in decoding output or the input ends on
11181 the PV of the ssv. The value which the offset points will be modified
11182 to the last input position on the ssv.
11184 Returns TRUE if the terminator was found, else returns FALSE.
11189 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11190 SV *ssv, int *offset, char *tstr, int tlen)
11194 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11205 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11206 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11208 call_method("cat_decode", G_SCALAR);
11210 ret = SvTRUE(TOPs);
11211 *offset = SvIV(offsv);
11217 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11222 /* ---------------------------------------------------------------------
11224 * support functions for report_uninit()
11227 /* the maxiumum size of array or hash where we will scan looking
11228 * for the undefined element that triggered the warning */
11230 #define FUV_MAX_SEARCH_SIZE 1000
11232 /* Look for an entry in the hash whose value has the same SV as val;
11233 * If so, return a mortal copy of the key. */
11236 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11239 register HE **array;
11242 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11243 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11246 array = HvARRAY(hv);
11248 for (i=HvMAX(hv); i>0; i--) {
11249 register HE *entry;
11250 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11251 if (HeVAL(entry) != val)
11253 if ( HeVAL(entry) == &PL_sv_undef ||
11254 HeVAL(entry) == &PL_sv_placeholder)
11258 if (HeKLEN(entry) == HEf_SVKEY)
11259 return sv_mortalcopy(HeKEY_sv(entry));
11260 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11266 /* Look for an entry in the array whose value has the same SV as val;
11267 * If so, return the index, otherwise return -1. */
11270 S_find_array_subscript(pTHX_ AV *av, SV* val)
11275 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11276 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11280 for (i=AvFILLp(av); i>=0; i--) {
11281 if (svp[i] == val && svp[i] != &PL_sv_undef)
11287 /* S_varname(): return the name of a variable, optionally with a subscript.
11288 * If gv is non-zero, use the name of that global, along with gvtype (one
11289 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11290 * targ. Depending on the value of the subscript_type flag, return:
11293 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11294 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11295 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11296 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11299 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11300 SV* keyname, I32 aindex, int subscript_type)
11303 SV * const name = sv_newmortal();
11306 buffer[0] = gvtype;
11309 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11311 gv_fullname4(name, gv, buffer, 0);
11313 if ((unsigned int)SvPVX(name)[1] <= 26) {
11315 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11317 /* Swap the 1 unprintable control character for the 2 byte pretty
11318 version - ie substr($name, 1, 1) = $buffer; */
11319 sv_insert(name, 1, 1, buffer, 2);
11324 CV * const cv = find_runcv(&unused);
11328 if (!cv || !CvPADLIST(cv))
11330 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11331 sv = *av_fetch(av, targ, FALSE);
11332 /* SvLEN in a pad name is not to be trusted */
11333 sv_setpv(name, SvPV_nolen_const(sv));
11336 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11337 SV * const sv = newSV(0);
11338 *SvPVX(name) = '$';
11339 Perl_sv_catpvf(aTHX_ name, "{%s}",
11340 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11343 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11344 *SvPVX(name) = '$';
11345 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11347 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11348 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11355 =for apidoc find_uninit_var
11357 Find the name of the undefined variable (if any) that caused the operator o
11358 to issue a "Use of uninitialized value" warning.
11359 If match is true, only return a name if it's value matches uninit_sv.
11360 So roughly speaking, if a unary operator (such as OP_COS) generates a
11361 warning, then following the direct child of the op may yield an
11362 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11363 other hand, with OP_ADD there are two branches to follow, so we only print
11364 the variable name if we get an exact match.
11366 The name is returned as a mortal SV.
11368 Assumes that PL_op is the op that originally triggered the error, and that
11369 PL_comppad/PL_curpad points to the currently executing pad.
11375 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11383 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11384 uninit_sv == &PL_sv_placeholder)))
11387 switch (obase->op_type) {
11394 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11395 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11398 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11400 if (pad) { /* @lex, %lex */
11401 sv = PAD_SVl(obase->op_targ);
11405 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11406 /* @global, %global */
11407 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11410 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11412 else /* @{expr}, %{expr} */
11413 return find_uninit_var(cUNOPx(obase)->op_first,
11417 /* attempt to find a match within the aggregate */
11419 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11421 subscript_type = FUV_SUBSCRIPT_HASH;
11424 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11426 subscript_type = FUV_SUBSCRIPT_ARRAY;
11429 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11432 return varname(gv, hash ? '%' : '@', obase->op_targ,
11433 keysv, index, subscript_type);
11437 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11439 return varname(NULL, '$', obase->op_targ,
11440 NULL, 0, FUV_SUBSCRIPT_NONE);
11443 gv = cGVOPx_gv(obase);
11444 if (!gv || (match && GvSV(gv) != uninit_sv))
11446 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11449 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11452 av = (AV*)PAD_SV(obase->op_targ);
11453 if (!av || SvRMAGICAL(av))
11455 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11456 if (!svp || *svp != uninit_sv)
11459 return varname(NULL, '$', obase->op_targ,
11460 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11463 gv = cGVOPx_gv(obase);
11469 if (!av || SvRMAGICAL(av))
11471 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11472 if (!svp || *svp != uninit_sv)
11475 return varname(gv, '$', 0,
11476 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11481 o = cUNOPx(obase)->op_first;
11482 if (!o || o->op_type != OP_NULL ||
11483 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11485 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11489 if (PL_op == obase)
11490 /* $a[uninit_expr] or $h{uninit_expr} */
11491 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11494 o = cBINOPx(obase)->op_first;
11495 kid = cBINOPx(obase)->op_last;
11497 /* get the av or hv, and optionally the gv */
11499 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11500 sv = PAD_SV(o->op_targ);
11502 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11503 && cUNOPo->op_first->op_type == OP_GV)
11505 gv = cGVOPx_gv(cUNOPo->op_first);
11508 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11513 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11514 /* index is constant */
11518 if (obase->op_type == OP_HELEM) {
11519 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11520 if (!he || HeVAL(he) != uninit_sv)
11524 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11525 if (!svp || *svp != uninit_sv)
11529 if (obase->op_type == OP_HELEM)
11530 return varname(gv, '%', o->op_targ,
11531 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11533 return varname(gv, '@', o->op_targ, NULL,
11534 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11537 /* index is an expression;
11538 * attempt to find a match within the aggregate */
11539 if (obase->op_type == OP_HELEM) {
11540 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11542 return varname(gv, '%', o->op_targ,
11543 keysv, 0, FUV_SUBSCRIPT_HASH);
11546 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11548 return varname(gv, '@', o->op_targ,
11549 NULL, index, FUV_SUBSCRIPT_ARRAY);
11554 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11556 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11562 /* only examine RHS */
11563 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11566 o = cUNOPx(obase)->op_first;
11567 if (o->op_type == OP_PUSHMARK)
11570 if (!o->op_sibling) {
11571 /* one-arg version of open is highly magical */
11573 if (o->op_type == OP_GV) { /* open FOO; */
11575 if (match && GvSV(gv) != uninit_sv)
11577 return varname(gv, '$', 0,
11578 NULL, 0, FUV_SUBSCRIPT_NONE);
11580 /* other possibilities not handled are:
11581 * open $x; or open my $x; should return '${*$x}'
11582 * open expr; should return '$'.expr ideally
11588 /* ops where $_ may be an implicit arg */
11592 if ( !(obase->op_flags & OPf_STACKED)) {
11593 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11594 ? PAD_SVl(obase->op_targ)
11597 sv = sv_newmortal();
11598 sv_setpvn(sv, "$_", 2);
11606 /* skip filehandle as it can't produce 'undef' warning */
11607 o = cUNOPx(obase)->op_first;
11608 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11609 o = o->op_sibling->op_sibling;
11616 match = 1; /* XS or custom code could trigger random warnings */
11621 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11622 return sv_2mortal(newSVpvs("${$/}"));
11627 if (!(obase->op_flags & OPf_KIDS))
11629 o = cUNOPx(obase)->op_first;
11635 /* if all except one arg are constant, or have no side-effects,
11636 * or are optimized away, then it's unambiguous */
11638 for (kid=o; kid; kid = kid->op_sibling) {
11640 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11641 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11642 || (kid->op_type == OP_PUSHMARK)
11646 if (o2) { /* more than one found */
11653 return find_uninit_var(o2, uninit_sv, match);
11655 /* scan all args */
11657 sv = find_uninit_var(o, uninit_sv, 1);
11669 =for apidoc report_uninit
11671 Print appropriate "Use of uninitialized variable" warning
11677 Perl_report_uninit(pTHX_ SV* uninit_sv)
11681 SV* varname = NULL;
11683 varname = find_uninit_var(PL_op, uninit_sv,0);
11685 sv_insert(varname, 0, 0, " ", 1);
11687 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11688 varname ? SvPV_nolen_const(varname) : "",
11689 " in ", OP_DESC(PL_op));
11692 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11698 * c-indentation-style: bsd
11699 * c-basic-offset: 4
11700 * indent-tabs-mode: t
11703 * ex: set ts=8 sts=4 sw=4 noet: