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)
587 #define ARENAS_PER_SET 256+64 /* x 3words/arena_desc -> ~ 4kb/arena_set */
590 struct arena_set* next;
591 int set_size; /* ie ARENAS_PER_SET */
592 int curr; /* index of next available arena-desc */
593 struct arena_desc set[ARENAS_PER_SET];
599 S_free_arena(pTHX_ void **root) {
601 void ** const next = *(void **)root;
609 =for apidoc sv_free_arenas
611 Deallocate the memory used by all arenas. Note that all the individual SV
612 heads and bodies within the arenas must already have been freed.
617 Perl_sv_free_arenas(pTHX)
624 /* Free arenas here, but be careful about fake ones. (We assume
625 contiguity of the fake ones with the corresponding real ones.) */
627 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
628 svanext = (SV*) SvANY(sva);
629 while (svanext && SvFAKE(svanext))
630 svanext = (SV*) SvANY(svanext);
638 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
640 for (; aroot; aroot = next) {
641 int max = aroot->curr;
642 for (i=0; i<max; i++) {
643 assert(aroot->set[i].arena);
644 Safefree(aroot->set[i].arena);
651 S_free_arena(aTHX_ (void**) PL_body_arenas);
654 for (i=0; i<SVt_LAST; i++)
655 PL_body_roots[i] = 0;
657 Safefree(PL_nice_chunk);
658 PL_nice_chunk = NULL;
659 PL_nice_chunk_size = 0;
665 Here are mid-level routines that manage the allocation of bodies out
666 of the various arenas. There are 5 kinds of arenas:
668 1. SV-head arenas, which are discussed and handled above
669 2. regular body arenas
670 3. arenas for reduced-size bodies
672 5. pte arenas (thread related)
674 Arena types 2 & 3 are chained by body-type off an array of
675 arena-root pointers, which is indexed by svtype. Some of the
676 larger/less used body types are malloced singly, since a large
677 unused block of them is wasteful. Also, several svtypes dont have
678 bodies; the data fits into the sv-head itself. The arena-root
679 pointer thus has a few unused root-pointers (which may be hijacked
680 later for arena types 4,5)
682 3 differs from 2 as an optimization; some body types have several
683 unused fields in the front of the structure (which are kept in-place
684 for consistency). These bodies can be allocated in smaller chunks,
685 because the leading fields arent accessed. Pointers to such bodies
686 are decremented to point at the unused 'ghost' memory, knowing that
687 the pointers are used with offsets to the real memory.
689 HE, HEK arenas are managed separately, with separate code, but may
690 be merge-able later..
692 PTE arenas are not sv-bodies, but they share these mid-level
693 mechanics, so are considered here. The new mid-level mechanics rely
694 on the sv_type of the body being allocated, so we just reserve one
695 of the unused body-slots for PTEs, then use it in those (2) PTE
696 contexts below (line ~10k)
699 /* get_arena(size): when ARENASETS is enabled, this creates
700 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
702 TBD: export properly for hv.c: S_more_he().
705 Perl_get_arena(pTHX_ int arena_size)
710 /* allocate and attach arena */
711 Newx(arp, PERL_ARENA_SIZE, char);
712 arp->next = PL_body_arenas;
713 PL_body_arenas = arp;
717 struct arena_desc* adesc;
718 struct arena_set *newroot, *aroot = (struct arena_set*) PL_body_arenas;
722 arena_size = PERL_ARENA_SIZE;
724 /* may need new arena-set to hold new arena */
725 if (!aroot || aroot->curr >= aroot->set_size) {
726 Newxz(newroot, 1, struct arena_set);
727 newroot->set_size = ARENAS_PER_SET;
728 newroot->next = aroot;
730 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", aroot));
733 /* ok, now have arena-set with at least 1 empty/available arena-desc */
734 curr = aroot->curr++;
735 adesc = &aroot->set[curr];
736 assert(!adesc->arena);
738 /* old fixed-size way
739 Newxz(adesc->arena, 1, union arena);
740 adesc->size = sizeof(union arena);
743 Newxz(adesc->arena, arena_size, char);
744 adesc->size = arena_size;
746 /* adesc->count = sizeof(struct 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); /* get a raw arena */
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)\
967 - bodies_by_type[sv_type].offset)
969 #define del_body_type(p, sv_type) \
970 del_body(p, &PL_body_roots[sv_type])
973 #define new_body_allocated(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
975 - bodies_by_type[sv_type].offset)
977 #define del_body_allocated(p, sv_type) \
978 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
981 #define my_safemalloc(s) (void*)safemalloc(s)
982 #define my_safecalloc(s) (void*)safecalloc(s, 1)
983 #define my_safefree(p) safefree((char*)p)
987 #define new_XNV() my_safemalloc(sizeof(XPVNV))
988 #define del_XNV(p) my_safefree(p)
990 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XPVNV(p) my_safefree(p)
993 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
994 #define del_XPVAV(p) my_safefree(p)
996 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
997 #define del_XPVHV(p) my_safefree(p)
999 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1000 #define del_XPVMG(p) my_safefree(p)
1002 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1003 #define del_XPVGV(p) my_safefree(p)
1007 #define new_XNV() new_body_type(SVt_NV)
1008 #define del_XNV(p) del_body_type(p, SVt_NV)
1010 #define new_XPVNV() new_body_type(SVt_PVNV)
1011 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1013 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1014 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1016 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1017 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1019 #define new_XPVMG() new_body_type(SVt_PVMG)
1020 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1022 #define new_XPVGV() new_body_type(SVt_PVGV)
1023 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1027 /* no arena for you! */
1029 #define new_NOARENA(details) \
1030 my_safemalloc((details)->size + (details)->offset)
1031 #define new_NOARENAZ(details) \
1032 my_safecalloc((details)->size + (details)->offset)
1035 =for apidoc sv_upgrade
1037 Upgrade an SV to a more complex form. Generally adds a new body type to the
1038 SV, then copies across as much information as possible from the old body.
1039 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1045 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1050 const U32 old_type = SvTYPE(sv);
1051 const struct body_details *const old_type_details
1052 = bodies_by_type + old_type;
1053 const struct body_details *new_type_details = bodies_by_type + new_type;
1055 if (new_type != SVt_PV && SvIsCOW(sv)) {
1056 sv_force_normal_flags(sv, 0);
1059 if (old_type == new_type)
1062 if (old_type > new_type)
1063 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1064 (int)old_type, (int)new_type);
1067 old_body = SvANY(sv);
1069 /* Copying structures onto other structures that have been neatly zeroed
1070 has a subtle gotcha. Consider XPVMG
1072 +------+------+------+------+------+-------+-------+
1073 | NV | CUR | LEN | IV | MAGIC | STASH |
1074 +------+------+------+------+------+-------+-------+
1075 0 4 8 12 16 20 24 28
1077 where NVs are aligned to 8 bytes, so that sizeof that structure is
1078 actually 32 bytes long, with 4 bytes of padding at the end:
1080 +------+------+------+------+------+-------+-------+------+
1081 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1082 +------+------+------+------+------+-------+-------+------+
1083 0 4 8 12 16 20 24 28 32
1085 so what happens if you allocate memory for this structure:
1087 +------+------+------+------+------+-------+-------+------+------+...
1088 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1089 +------+------+------+------+------+-------+-------+------+------+...
1090 0 4 8 12 16 20 24 28 32 36
1092 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1093 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1094 started out as zero once, but it's quite possible that it isn't. So now,
1095 rather than a nicely zeroed GP, you have it pointing somewhere random.
1098 (In fact, GP ends up pointing at a previous GP structure, because the
1099 principle cause of the padding in XPVMG getting garbage is a copy of
1100 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1102 So we are careful and work out the size of used parts of all the
1109 if (new_type < SVt_PVIV) {
1110 new_type = (new_type == SVt_NV)
1111 ? SVt_PVNV : SVt_PVIV;
1112 new_type_details = bodies_by_type + new_type;
1116 if (new_type < SVt_PVNV) {
1117 new_type = SVt_PVNV;
1118 new_type_details = bodies_by_type + new_type;
1124 assert(new_type > SVt_PV);
1125 assert(SVt_IV < SVt_PV);
1126 assert(SVt_NV < SVt_PV);
1133 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1134 there's no way that it can be safely upgraded, because perl.c
1135 expects to Safefree(SvANY(PL_mess_sv)) */
1136 assert(sv != PL_mess_sv);
1137 /* This flag bit is used to mean other things in other scalar types.
1138 Given that it only has meaning inside the pad, it shouldn't be set
1139 on anything that can get upgraded. */
1140 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1143 if (old_type_details->cant_upgrade)
1144 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1147 SvFLAGS(sv) &= ~SVTYPEMASK;
1148 SvFLAGS(sv) |= new_type;
1152 Perl_croak(aTHX_ "Can't upgrade to undef");
1154 assert(old_type == SVt_NULL);
1155 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1159 assert(old_type == SVt_NULL);
1160 SvANY(sv) = new_XNV();
1164 assert(old_type == SVt_NULL);
1165 SvANY(sv) = &sv->sv_u.svu_rv;
1169 SvANY(sv) = new_XPVHV();
1172 HvTOTALKEYS(sv) = 0;
1177 SvANY(sv) = new_XPVAV();
1184 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1185 The target created by newSVrv also is, and it can have magic.
1186 However, it never has SvPVX set.
1188 if (old_type >= SVt_RV) {
1189 assert(SvPVX_const(sv) == 0);
1192 /* Could put this in the else clause below, as PVMG must have SvPVX
1193 0 already (the assertion above) */
1196 if (old_type >= SVt_PVMG) {
1197 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1198 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1200 SvMAGIC_set(sv, NULL);
1201 SvSTASH_set(sv, NULL);
1207 /* XXX Is this still needed? Was it ever needed? Surely as there is
1208 no route from NV to PVIV, NOK can never be true */
1209 assert(!SvNOKp(sv));
1221 assert(new_type_details->size);
1222 /* We always allocated the full length item with PURIFY. To do this
1223 we fake things so that arena is false for all 16 types.. */
1224 if(new_type_details->arena) {
1225 /* This points to the start of the allocated area. */
1226 new_body_inline(new_body, new_type_details->size, new_type);
1227 Zero(new_body, new_type_details->size, char);
1228 new_body = ((char *)new_body) - new_type_details->offset;
1230 new_body = new_NOARENAZ(new_type_details);
1232 SvANY(sv) = new_body;
1234 if (old_type_details->copy) {
1235 Copy((char *)old_body + old_type_details->offset,
1236 (char *)new_body + old_type_details->offset,
1237 old_type_details->copy, char);
1240 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1241 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1242 * correct 0.0 for us. Otherwise, if the old body didn't have an
1243 * NV slot, but the new one does, then we need to initialise the
1244 * freshly created NV slot with whatever the correct bit pattern is
1246 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1250 if (new_type == SVt_PVIO)
1251 IoPAGE_LEN(sv) = 60;
1252 if (old_type < SVt_RV)
1256 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1257 (unsigned long)new_type);
1260 if (old_type_details->size) {
1261 /* If the old body had an allocated size, then we need to free it. */
1263 my_safefree(old_body);
1265 del_body((void*)((char*)old_body + old_type_details->offset),
1266 &PL_body_roots[old_type]);
1272 =for apidoc sv_backoff
1274 Remove any string offset. You should normally use the C<SvOOK_off> macro
1281 Perl_sv_backoff(pTHX_ register SV *sv)
1284 assert(SvTYPE(sv) != SVt_PVHV);
1285 assert(SvTYPE(sv) != SVt_PVAV);
1287 const char * const s = SvPVX_const(sv);
1288 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1289 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1291 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1293 SvFLAGS(sv) &= ~SVf_OOK;
1300 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1301 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1302 Use the C<SvGROW> wrapper instead.
1308 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1312 #ifdef HAS_64K_LIMIT
1313 if (newlen >= 0x10000) {
1314 PerlIO_printf(Perl_debug_log,
1315 "Allocation too large: %"UVxf"\n", (UV)newlen);
1318 #endif /* HAS_64K_LIMIT */
1321 if (SvTYPE(sv) < SVt_PV) {
1322 sv_upgrade(sv, SVt_PV);
1323 s = SvPVX_mutable(sv);
1325 else if (SvOOK(sv)) { /* pv is offset? */
1327 s = SvPVX_mutable(sv);
1328 if (newlen > SvLEN(sv))
1329 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1330 #ifdef HAS_64K_LIMIT
1331 if (newlen >= 0x10000)
1336 s = SvPVX_mutable(sv);
1338 if (newlen > SvLEN(sv)) { /* need more room? */
1339 newlen = PERL_STRLEN_ROUNDUP(newlen);
1340 if (SvLEN(sv) && s) {
1342 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1348 s = saferealloc(s, newlen);
1351 s = safemalloc(newlen);
1352 if (SvPVX_const(sv) && SvCUR(sv)) {
1353 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1357 SvLEN_set(sv, newlen);
1363 =for apidoc sv_setiv
1365 Copies an integer into the given SV, upgrading first if necessary.
1366 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1372 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1375 SV_CHECK_THINKFIRST_COW_DROP(sv);
1376 switch (SvTYPE(sv)) {
1378 sv_upgrade(sv, SVt_IV);
1381 sv_upgrade(sv, SVt_PVNV);
1385 sv_upgrade(sv, SVt_PVIV);
1394 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1397 (void)SvIOK_only(sv); /* validate number */
1403 =for apidoc sv_setiv_mg
1405 Like C<sv_setiv>, but also handles 'set' magic.
1411 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1418 =for apidoc sv_setuv
1420 Copies an unsigned integer into the given SV, upgrading first if necessary.
1421 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1427 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1429 /* With these two if statements:
1430 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1433 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1435 If you wish to remove them, please benchmark to see what the effect is
1437 if (u <= (UV)IV_MAX) {
1438 sv_setiv(sv, (IV)u);
1447 =for apidoc sv_setuv_mg
1449 Like C<sv_setuv>, but also handles 'set' magic.
1455 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1464 =for apidoc sv_setnv
1466 Copies a double into the given SV, upgrading first if necessary.
1467 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1473 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1476 SV_CHECK_THINKFIRST_COW_DROP(sv);
1477 switch (SvTYPE(sv)) {
1480 sv_upgrade(sv, SVt_NV);
1485 sv_upgrade(sv, SVt_PVNV);
1494 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1498 (void)SvNOK_only(sv); /* validate number */
1503 =for apidoc sv_setnv_mg
1505 Like C<sv_setnv>, but also handles 'set' magic.
1511 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1517 /* Print an "isn't numeric" warning, using a cleaned-up,
1518 * printable version of the offending string
1522 S_not_a_number(pTHX_ SV *sv)
1530 dsv = sv_2mortal(newSVpvs(""));
1531 pv = sv_uni_display(dsv, sv, 10, 0);
1534 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1535 /* each *s can expand to 4 chars + "...\0",
1536 i.e. need room for 8 chars */
1538 const char *s = SvPVX_const(sv);
1539 const char * const end = s + SvCUR(sv);
1540 for ( ; s < end && d < limit; s++ ) {
1542 if (ch & 128 && !isPRINT_LC(ch)) {
1551 else if (ch == '\r') {
1555 else if (ch == '\f') {
1559 else if (ch == '\\') {
1563 else if (ch == '\0') {
1567 else if (isPRINT_LC(ch))
1584 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1585 "Argument \"%s\" isn't numeric in %s", pv,
1588 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1589 "Argument \"%s\" isn't numeric", pv);
1593 =for apidoc looks_like_number
1595 Test if the content of an SV looks like a number (or is a number).
1596 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1597 non-numeric warning), even if your atof() doesn't grok them.
1603 Perl_looks_like_number(pTHX_ SV *sv)
1605 register const char *sbegin;
1609 sbegin = SvPVX_const(sv);
1612 else if (SvPOKp(sv))
1613 sbegin = SvPV_const(sv, len);
1615 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1616 return grok_number(sbegin, len, NULL);
1619 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1620 until proven guilty, assume that things are not that bad... */
1625 As 64 bit platforms often have an NV that doesn't preserve all bits of
1626 an IV (an assumption perl has been based on to date) it becomes necessary
1627 to remove the assumption that the NV always carries enough precision to
1628 recreate the IV whenever needed, and that the NV is the canonical form.
1629 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1630 precision as a side effect of conversion (which would lead to insanity
1631 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1632 1) to distinguish between IV/UV/NV slots that have cached a valid
1633 conversion where precision was lost and IV/UV/NV slots that have a
1634 valid conversion which has lost no precision
1635 2) to ensure that if a numeric conversion to one form is requested that
1636 would lose precision, the precise conversion (or differently
1637 imprecise conversion) is also performed and cached, to prevent
1638 requests for different numeric formats on the same SV causing
1639 lossy conversion chains. (lossless conversion chains are perfectly
1644 SvIOKp is true if the IV slot contains a valid value
1645 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1646 SvNOKp is true if the NV slot contains a valid value
1647 SvNOK is true only if the NV value is accurate
1650 while converting from PV to NV, check to see if converting that NV to an
1651 IV(or UV) would lose accuracy over a direct conversion from PV to
1652 IV(or UV). If it would, cache both conversions, return NV, but mark
1653 SV as IOK NOKp (ie not NOK).
1655 While converting from PV to IV, check to see if converting that IV to an
1656 NV would lose accuracy over a direct conversion from PV to NV. If it
1657 would, cache both conversions, flag similarly.
1659 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1660 correctly because if IV & NV were set NV *always* overruled.
1661 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1662 changes - now IV and NV together means that the two are interchangeable:
1663 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1665 The benefit of this is that operations such as pp_add know that if
1666 SvIOK is true for both left and right operands, then integer addition
1667 can be used instead of floating point (for cases where the result won't
1668 overflow). Before, floating point was always used, which could lead to
1669 loss of precision compared with integer addition.
1671 * making IV and NV equal status should make maths accurate on 64 bit
1673 * may speed up maths somewhat if pp_add and friends start to use
1674 integers when possible instead of fp. (Hopefully the overhead in
1675 looking for SvIOK and checking for overflow will not outweigh the
1676 fp to integer speedup)
1677 * will slow down integer operations (callers of SvIV) on "inaccurate"
1678 values, as the change from SvIOK to SvIOKp will cause a call into
1679 sv_2iv each time rather than a macro access direct to the IV slot
1680 * should speed up number->string conversion on integers as IV is
1681 favoured when IV and NV are equally accurate
1683 ####################################################################
1684 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1685 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1686 On the other hand, SvUOK is true iff UV.
1687 ####################################################################
1689 Your mileage will vary depending your CPU's relative fp to integer
1693 #ifndef NV_PRESERVES_UV
1694 # define IS_NUMBER_UNDERFLOW_IV 1
1695 # define IS_NUMBER_UNDERFLOW_UV 2
1696 # define IS_NUMBER_IV_AND_UV 2
1697 # define IS_NUMBER_OVERFLOW_IV 4
1698 # define IS_NUMBER_OVERFLOW_UV 5
1700 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1702 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1704 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1707 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));
1708 if (SvNVX(sv) < (NV)IV_MIN) {
1709 (void)SvIOKp_on(sv);
1711 SvIV_set(sv, IV_MIN);
1712 return IS_NUMBER_UNDERFLOW_IV;
1714 if (SvNVX(sv) > (NV)UV_MAX) {
1715 (void)SvIOKp_on(sv);
1718 SvUV_set(sv, UV_MAX);
1719 return IS_NUMBER_OVERFLOW_UV;
1721 (void)SvIOKp_on(sv);
1723 /* Can't use strtol etc to convert this string. (See truth table in
1725 if (SvNVX(sv) <= (UV)IV_MAX) {
1726 SvIV_set(sv, I_V(SvNVX(sv)));
1727 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1728 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1730 /* Integer is imprecise. NOK, IOKp */
1732 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1735 SvUV_set(sv, U_V(SvNVX(sv)));
1736 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1737 if (SvUVX(sv) == UV_MAX) {
1738 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1739 possibly be preserved by NV. Hence, it must be overflow.
1741 return IS_NUMBER_OVERFLOW_UV;
1743 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1745 /* Integer is imprecise. NOK, IOKp */
1747 return IS_NUMBER_OVERFLOW_IV;
1749 #endif /* !NV_PRESERVES_UV*/
1752 S_sv_2iuv_common(pTHX_ SV *sv) {
1755 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1756 * without also getting a cached IV/UV from it at the same time
1757 * (ie PV->NV conversion should detect loss of accuracy and cache
1758 * IV or UV at same time to avoid this. */
1759 /* IV-over-UV optimisation - choose to cache IV if possible */
1761 if (SvTYPE(sv) == SVt_NV)
1762 sv_upgrade(sv, SVt_PVNV);
1764 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1765 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1766 certainly cast into the IV range at IV_MAX, whereas the correct
1767 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1769 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1770 SvIV_set(sv, I_V(SvNVX(sv)));
1771 if (SvNVX(sv) == (NV) SvIVX(sv)
1772 #ifndef NV_PRESERVES_UV
1773 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1774 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1775 /* Don't flag it as "accurately an integer" if the number
1776 came from a (by definition imprecise) NV operation, and
1777 we're outside the range of NV integer precision */
1780 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1781 DEBUG_c(PerlIO_printf(Perl_debug_log,
1782 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1788 /* IV not precise. No need to convert from PV, as NV
1789 conversion would already have cached IV if it detected
1790 that PV->IV would be better than PV->NV->IV
1791 flags already correct - don't set public IOK. */
1792 DEBUG_c(PerlIO_printf(Perl_debug_log,
1793 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1798 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1799 but the cast (NV)IV_MIN rounds to a the value less (more
1800 negative) than IV_MIN which happens to be equal to SvNVX ??
1801 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1802 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1803 (NV)UVX == NVX are both true, but the values differ. :-(
1804 Hopefully for 2s complement IV_MIN is something like
1805 0x8000000000000000 which will be exact. NWC */
1808 SvUV_set(sv, U_V(SvNVX(sv)));
1810 (SvNVX(sv) == (NV) SvUVX(sv))
1811 #ifndef NV_PRESERVES_UV
1812 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1813 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1814 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1815 /* Don't flag it as "accurately an integer" if the number
1816 came from a (by definition imprecise) NV operation, and
1817 we're outside the range of NV integer precision */
1822 DEBUG_c(PerlIO_printf(Perl_debug_log,
1823 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1829 else if (SvPOKp(sv) && SvLEN(sv)) {
1831 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1832 /* We want to avoid a possible problem when we cache an IV/ a UV which
1833 may be later translated to an NV, and the resulting NV is not
1834 the same as the direct translation of the initial string
1835 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1836 be careful to ensure that the value with the .456 is around if the
1837 NV value is requested in the future).
1839 This means that if we cache such an IV/a UV, we need to cache the
1840 NV as well. Moreover, we trade speed for space, and do not
1841 cache the NV if we are sure it's not needed.
1844 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1845 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1846 == IS_NUMBER_IN_UV) {
1847 /* It's definitely an integer, only upgrade to PVIV */
1848 if (SvTYPE(sv) < SVt_PVIV)
1849 sv_upgrade(sv, SVt_PVIV);
1851 } else if (SvTYPE(sv) < SVt_PVNV)
1852 sv_upgrade(sv, SVt_PVNV);
1854 /* If NVs preserve UVs then we only use the UV value if we know that
1855 we aren't going to call atof() below. If NVs don't preserve UVs
1856 then the value returned may have more precision than atof() will
1857 return, even though value isn't perfectly accurate. */
1858 if ((numtype & (IS_NUMBER_IN_UV
1859 #ifdef NV_PRESERVES_UV
1862 )) == IS_NUMBER_IN_UV) {
1863 /* This won't turn off the public IOK flag if it was set above */
1864 (void)SvIOKp_on(sv);
1866 if (!(numtype & IS_NUMBER_NEG)) {
1868 if (value <= (UV)IV_MAX) {
1869 SvIV_set(sv, (IV)value);
1871 /* it didn't overflow, and it was positive. */
1872 SvUV_set(sv, value);
1876 /* 2s complement assumption */
1877 if (value <= (UV)IV_MIN) {
1878 SvIV_set(sv, -(IV)value);
1880 /* Too negative for an IV. This is a double upgrade, but
1881 I'm assuming it will be rare. */
1882 if (SvTYPE(sv) < SVt_PVNV)
1883 sv_upgrade(sv, SVt_PVNV);
1887 SvNV_set(sv, -(NV)value);
1888 SvIV_set(sv, IV_MIN);
1892 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1893 will be in the previous block to set the IV slot, and the next
1894 block to set the NV slot. So no else here. */
1896 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1897 != IS_NUMBER_IN_UV) {
1898 /* It wasn't an (integer that doesn't overflow the UV). */
1899 SvNV_set(sv, Atof(SvPVX_const(sv)));
1901 if (! numtype && ckWARN(WARN_NUMERIC))
1904 #if defined(USE_LONG_DOUBLE)
1905 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1906 PTR2UV(sv), SvNVX(sv)));
1908 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1909 PTR2UV(sv), SvNVX(sv)));
1912 #ifdef NV_PRESERVES_UV
1913 (void)SvIOKp_on(sv);
1915 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1916 SvIV_set(sv, I_V(SvNVX(sv)));
1917 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1920 /* Integer is imprecise. NOK, IOKp */
1922 /* UV will not work better than IV */
1924 if (SvNVX(sv) > (NV)UV_MAX) {
1926 /* Integer is inaccurate. NOK, IOKp, is UV */
1927 SvUV_set(sv, UV_MAX);
1929 SvUV_set(sv, U_V(SvNVX(sv)));
1930 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1931 NV preservse UV so can do correct comparison. */
1932 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1935 /* Integer is imprecise. NOK, IOKp, is UV */
1940 #else /* NV_PRESERVES_UV */
1941 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1942 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1943 /* The IV/UV slot will have been set from value returned by
1944 grok_number above. The NV slot has just been set using
1947 assert (SvIOKp(sv));
1949 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1950 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1951 /* Small enough to preserve all bits. */
1952 (void)SvIOKp_on(sv);
1954 SvIV_set(sv, I_V(SvNVX(sv)));
1955 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1957 /* Assumption: first non-preserved integer is < IV_MAX,
1958 this NV is in the preserved range, therefore: */
1959 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1961 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);
1965 0 0 already failed to read UV.
1966 0 1 already failed to read UV.
1967 1 0 you won't get here in this case. IV/UV
1968 slot set, public IOK, Atof() unneeded.
1969 1 1 already read UV.
1970 so there's no point in sv_2iuv_non_preserve() attempting
1971 to use atol, strtol, strtoul etc. */
1972 sv_2iuv_non_preserve (sv, numtype);
1975 #endif /* NV_PRESERVES_UV */
1979 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1980 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1983 if (SvTYPE(sv) < SVt_IV)
1984 /* Typically the caller expects that sv_any is not NULL now. */
1985 sv_upgrade(sv, SVt_IV);
1986 /* Return 0 from the caller. */
1993 =for apidoc sv_2iv_flags
1995 Return the integer value of an SV, doing any necessary string
1996 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
1997 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2003 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2008 if (SvGMAGICAL(sv)) {
2009 if (flags & SV_GMAGIC)
2014 return I_V(SvNVX(sv));
2016 if (SvPOKp(sv) && SvLEN(sv)) {
2019 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2021 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2022 == IS_NUMBER_IN_UV) {
2023 /* It's definitely an integer */
2024 if (numtype & IS_NUMBER_NEG) {
2025 if (value < (UV)IV_MIN)
2028 if (value < (UV)IV_MAX)
2033 if (ckWARN(WARN_NUMERIC))
2036 return I_V(Atof(SvPVX_const(sv)));
2041 assert(SvTYPE(sv) >= SVt_PVMG);
2042 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2043 } else if (SvTHINKFIRST(sv)) {
2047 SV * const tmpstr=AMG_CALLun(sv,numer);
2048 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2049 return SvIV(tmpstr);
2052 return PTR2IV(SvRV(sv));
2055 sv_force_normal_flags(sv, 0);
2057 if (SvREADONLY(sv) && !SvOK(sv)) {
2058 if (ckWARN(WARN_UNINITIALIZED))
2064 if (S_sv_2iuv_common(aTHX_ sv))
2067 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2068 PTR2UV(sv),SvIVX(sv)));
2069 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2073 =for apidoc sv_2uv_flags
2075 Return the unsigned integer value of an SV, doing any necessary string
2076 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2077 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2083 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2088 if (SvGMAGICAL(sv)) {
2089 if (flags & SV_GMAGIC)
2094 return U_V(SvNVX(sv));
2095 if (SvPOKp(sv) && SvLEN(sv)) {
2098 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2100 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2101 == IS_NUMBER_IN_UV) {
2102 /* It's definitely an integer */
2103 if (!(numtype & IS_NUMBER_NEG))
2107 if (ckWARN(WARN_NUMERIC))
2110 return U_V(Atof(SvPVX_const(sv)));
2115 assert(SvTYPE(sv) >= SVt_PVMG);
2116 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2117 } else if (SvTHINKFIRST(sv)) {
2121 SV *const tmpstr = AMG_CALLun(sv,numer);
2122 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2123 return SvUV(tmpstr);
2126 return PTR2UV(SvRV(sv));
2129 sv_force_normal_flags(sv, 0);
2131 if (SvREADONLY(sv) && !SvOK(sv)) {
2132 if (ckWARN(WARN_UNINITIALIZED))
2138 if (S_sv_2iuv_common(aTHX_ sv))
2142 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2143 PTR2UV(sv),SvUVX(sv)));
2144 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2150 Return the num value of an SV, doing any necessary string or integer
2151 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2158 Perl_sv_2nv(pTHX_ register SV *sv)
2163 if (SvGMAGICAL(sv)) {
2167 if (SvPOKp(sv) && SvLEN(sv)) {
2168 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2169 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2171 return Atof(SvPVX_const(sv));
2175 return (NV)SvUVX(sv);
2177 return (NV)SvIVX(sv);
2182 assert(SvTYPE(sv) >= SVt_PVMG);
2183 /* This falls through to the report_uninit near the end of the
2185 } else if (SvTHINKFIRST(sv)) {
2189 SV *const tmpstr = AMG_CALLun(sv,numer);
2190 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2191 return SvNV(tmpstr);
2194 return PTR2NV(SvRV(sv));
2197 sv_force_normal_flags(sv, 0);
2199 if (SvREADONLY(sv) && !SvOK(sv)) {
2200 if (ckWARN(WARN_UNINITIALIZED))
2205 if (SvTYPE(sv) < SVt_NV) {
2206 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2207 sv_upgrade(sv, SVt_NV);
2208 #ifdef USE_LONG_DOUBLE
2210 STORE_NUMERIC_LOCAL_SET_STANDARD();
2211 PerlIO_printf(Perl_debug_log,
2212 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2213 PTR2UV(sv), SvNVX(sv));
2214 RESTORE_NUMERIC_LOCAL();
2218 STORE_NUMERIC_LOCAL_SET_STANDARD();
2219 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2220 PTR2UV(sv), SvNVX(sv));
2221 RESTORE_NUMERIC_LOCAL();
2225 else if (SvTYPE(sv) < SVt_PVNV)
2226 sv_upgrade(sv, SVt_PVNV);
2231 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2232 #ifdef NV_PRESERVES_UV
2235 /* Only set the public NV OK flag if this NV preserves the IV */
2236 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2237 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2238 : (SvIVX(sv) == I_V(SvNVX(sv))))
2244 else if (SvPOKp(sv) && SvLEN(sv)) {
2246 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2247 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2249 #ifdef NV_PRESERVES_UV
2250 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2251 == IS_NUMBER_IN_UV) {
2252 /* It's definitely an integer */
2253 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2255 SvNV_set(sv, Atof(SvPVX_const(sv)));
2258 SvNV_set(sv, Atof(SvPVX_const(sv)));
2259 /* Only set the public NV OK flag if this NV preserves the value in
2260 the PV at least as well as an IV/UV would.
2261 Not sure how to do this 100% reliably. */
2262 /* if that shift count is out of range then Configure's test is
2263 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2265 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2266 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2267 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2268 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2269 /* Can't use strtol etc to convert this string, so don't try.
2270 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2273 /* value has been set. It may not be precise. */
2274 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2275 /* 2s complement assumption for (UV)IV_MIN */
2276 SvNOK_on(sv); /* Integer is too negative. */
2281 if (numtype & IS_NUMBER_NEG) {
2282 SvIV_set(sv, -(IV)value);
2283 } else if (value <= (UV)IV_MAX) {
2284 SvIV_set(sv, (IV)value);
2286 SvUV_set(sv, value);
2290 if (numtype & IS_NUMBER_NOT_INT) {
2291 /* I believe that even if the original PV had decimals,
2292 they are lost beyond the limit of the FP precision.
2293 However, neither is canonical, so both only get p
2294 flags. NWC, 2000/11/25 */
2295 /* Both already have p flags, so do nothing */
2297 const NV nv = SvNVX(sv);
2298 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2299 if (SvIVX(sv) == I_V(nv)) {
2302 /* It had no "." so it must be integer. */
2306 /* between IV_MAX and NV(UV_MAX).
2307 Could be slightly > UV_MAX */
2309 if (numtype & IS_NUMBER_NOT_INT) {
2310 /* UV and NV both imprecise. */
2312 const UV nv_as_uv = U_V(nv);
2314 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2323 #endif /* NV_PRESERVES_UV */
2326 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2328 assert (SvTYPE(sv) >= SVt_NV);
2329 /* Typically the caller expects that sv_any is not NULL now. */
2330 /* XXX Ilya implies that this is a bug in callers that assume this
2331 and ideally should be fixed. */
2334 #if defined(USE_LONG_DOUBLE)
2336 STORE_NUMERIC_LOCAL_SET_STANDARD();
2337 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2338 PTR2UV(sv), SvNVX(sv));
2339 RESTORE_NUMERIC_LOCAL();
2343 STORE_NUMERIC_LOCAL_SET_STANDARD();
2344 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2345 PTR2UV(sv), SvNVX(sv));
2346 RESTORE_NUMERIC_LOCAL();
2352 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2353 * UV as a string towards the end of buf, and return pointers to start and
2356 * We assume that buf is at least TYPE_CHARS(UV) long.
2360 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2362 char *ptr = buf + TYPE_CHARS(UV);
2363 char * const ebuf = ptr;
2376 *--ptr = '0' + (char)(uv % 10);
2384 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2385 * a regexp to its stringified form.
2389 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2391 const regexp * const re = (regexp *)mg->mg_obj;
2394 const char *fptr = "msix";
2399 bool need_newline = 0;
2400 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2402 while((ch = *fptr++)) {
2404 reflags[left++] = ch;
2407 reflags[right--] = ch;
2412 reflags[left] = '-';
2416 mg->mg_len = re->prelen + 4 + left;
2418 * If /x was used, we have to worry about a regex ending with a
2419 * comment later being embedded within another regex. If so, we don't
2420 * want this regex's "commentization" to leak out to the right part of
2421 * the enclosing regex, we must cap it with a newline.
2423 * So, if /x was used, we scan backwards from the end of the regex. If
2424 * we find a '#' before we find a newline, we need to add a newline
2425 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2426 * we don't need to add anything. -jfriedl
2428 if (PMf_EXTENDED & re->reganch) {
2429 const char *endptr = re->precomp + re->prelen;
2430 while (endptr >= re->precomp) {
2431 const char c = *(endptr--);
2433 break; /* don't need another */
2435 /* we end while in a comment, so we need a newline */
2436 mg->mg_len++; /* save space for it */
2437 need_newline = 1; /* note to add it */
2443 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2444 mg->mg_ptr[0] = '(';
2445 mg->mg_ptr[1] = '?';
2446 Copy(reflags, mg->mg_ptr+2, left, char);
2447 *(mg->mg_ptr+left+2) = ':';
2448 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2450 mg->mg_ptr[mg->mg_len - 2] = '\n';
2451 mg->mg_ptr[mg->mg_len - 1] = ')';
2452 mg->mg_ptr[mg->mg_len] = 0;
2454 PL_reginterp_cnt += re->program[0].next_off;
2456 if (re->reganch & ROPT_UTF8)
2466 =for apidoc sv_2pv_flags
2468 Returns a pointer to the string value of an SV, and sets *lp to its length.
2469 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2471 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2472 usually end up here too.
2478 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2488 if (SvGMAGICAL(sv)) {
2489 if (flags & SV_GMAGIC)
2494 if (flags & SV_MUTABLE_RETURN)
2495 return SvPVX_mutable(sv);
2496 if (flags & SV_CONST_RETURN)
2497 return (char *)SvPVX_const(sv);
2500 if (SvIOKp(sv) || SvNOKp(sv)) {
2501 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2505 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2506 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2508 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2511 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2512 /* Sneaky stuff here */
2513 SV * const tsv = newSVpvn(tbuf, len);
2523 #ifdef FIXNEGATIVEZERO
2524 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2530 SvUPGRADE(sv, SVt_PV);
2533 s = SvGROW_mutable(sv, len + 1);
2536 return memcpy(s, tbuf, len + 1);
2542 assert(SvTYPE(sv) >= SVt_PVMG);
2543 /* This falls through to the report_uninit near the end of the
2545 } else if (SvTHINKFIRST(sv)) {
2549 SV *const tmpstr = AMG_CALLun(sv,string);
2550 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2552 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2556 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2557 if (flags & SV_CONST_RETURN) {
2558 pv = (char *) SvPVX_const(tmpstr);
2560 pv = (flags & SV_MUTABLE_RETURN)
2561 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2564 *lp = SvCUR(tmpstr);
2566 pv = sv_2pv_flags(tmpstr, lp, flags);
2578 const SV *const referent = (SV*)SvRV(sv);
2581 tsv = sv_2mortal(newSVpvs("NULLREF"));
2582 } else if (SvTYPE(referent) == SVt_PVMG
2583 && ((SvFLAGS(referent) &
2584 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2585 == (SVs_OBJECT|SVs_SMG))
2586 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2587 return stringify_regexp(sv, mg, lp);
2589 const char *const typestr = sv_reftype(referent, 0);
2591 tsv = sv_newmortal();
2592 if (SvOBJECT(referent)) {
2593 const char *const name = HvNAME_get(SvSTASH(referent));
2594 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2595 name ? name : "__ANON__" , typestr,
2599 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2607 if (SvREADONLY(sv) && !SvOK(sv)) {
2608 if (ckWARN(WARN_UNINITIALIZED))
2615 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2616 /* I'm assuming that if both IV and NV are equally valid then
2617 converting the IV is going to be more efficient */
2618 const U32 isIOK = SvIOK(sv);
2619 const U32 isUIOK = SvIsUV(sv);
2620 char buf[TYPE_CHARS(UV)];
2623 if (SvTYPE(sv) < SVt_PVIV)
2624 sv_upgrade(sv, SVt_PVIV);
2625 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2626 /* inlined from sv_setpvn */
2627 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2628 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2629 SvCUR_set(sv, ebuf - ptr);
2639 else if (SvNOKp(sv)) {
2640 const int olderrno = errno;
2641 if (SvTYPE(sv) < SVt_PVNV)
2642 sv_upgrade(sv, SVt_PVNV);
2643 /* The +20 is pure guesswork. Configure test needed. --jhi */
2644 s = SvGROW_mutable(sv, NV_DIG + 20);
2645 /* some Xenix systems wipe out errno here */
2647 if (SvNVX(sv) == 0.0)
2648 (void)strcpy(s,"0");
2652 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2655 #ifdef FIXNEGATIVEZERO
2656 if (*s == '-' && s[1] == '0' && !s[2])
2666 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2670 if (SvTYPE(sv) < SVt_PV)
2671 /* Typically the caller expects that sv_any is not NULL now. */
2672 sv_upgrade(sv, SVt_PV);
2676 const STRLEN len = s - SvPVX_const(sv);
2682 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2683 PTR2UV(sv),SvPVX_const(sv)));
2684 if (flags & SV_CONST_RETURN)
2685 return (char *)SvPVX_const(sv);
2686 if (flags & SV_MUTABLE_RETURN)
2687 return SvPVX_mutable(sv);
2692 =for apidoc sv_copypv
2694 Copies a stringified representation of the source SV into the
2695 destination SV. Automatically performs any necessary mg_get and
2696 coercion of numeric values into strings. Guaranteed to preserve
2697 UTF-8 flag even from overloaded objects. Similar in nature to
2698 sv_2pv[_flags] but operates directly on an SV instead of just the
2699 string. Mostly uses sv_2pv_flags to do its work, except when that
2700 would lose the UTF-8'ness of the PV.
2706 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2709 const char * const s = SvPV_const(ssv,len);
2710 sv_setpvn(dsv,s,len);
2718 =for apidoc sv_2pvbyte
2720 Return a pointer to the byte-encoded representation of the SV, and set *lp
2721 to its length. May cause the SV to be downgraded from UTF-8 as a
2724 Usually accessed via the C<SvPVbyte> macro.
2730 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2732 sv_utf8_downgrade(sv,0);
2733 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2737 =for apidoc sv_2pvutf8
2739 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2740 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2742 Usually accessed via the C<SvPVutf8> macro.
2748 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2750 sv_utf8_upgrade(sv);
2751 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2756 =for apidoc sv_2bool
2758 This function is only called on magical items, and is only used by
2759 sv_true() or its macro equivalent.
2765 Perl_sv_2bool(pTHX_ register SV *sv)
2774 SV * const tmpsv = AMG_CALLun(sv,bool_);
2775 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2776 return (bool)SvTRUE(tmpsv);
2778 return SvRV(sv) != 0;
2781 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2783 (*sv->sv_u.svu_pv > '0' ||
2784 Xpvtmp->xpv_cur > 1 ||
2785 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2792 return SvIVX(sv) != 0;
2795 return SvNVX(sv) != 0.0;
2803 =for apidoc sv_utf8_upgrade
2805 Converts the PV of an SV to its UTF-8-encoded form.
2806 Forces the SV to string form if it is not already.
2807 Always sets the SvUTF8 flag to avoid future validity checks even
2808 if all the bytes have hibit clear.
2810 This is not as a general purpose byte encoding to Unicode interface:
2811 use the Encode extension for that.
2813 =for apidoc sv_utf8_upgrade_flags
2815 Converts the PV of an SV to its UTF-8-encoded form.
2816 Forces the SV to string form if it is not already.
2817 Always sets the SvUTF8 flag to avoid future validity checks even
2818 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2819 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2820 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2822 This is not as a general purpose byte encoding to Unicode interface:
2823 use the Encode extension for that.
2829 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2832 if (sv == &PL_sv_undef)
2836 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2837 (void) sv_2pv_flags(sv,&len, flags);
2841 (void) SvPV_force(sv,len);
2850 sv_force_normal_flags(sv, 0);
2853 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2854 sv_recode_to_utf8(sv, PL_encoding);
2855 else { /* Assume Latin-1/EBCDIC */
2856 /* This function could be much more efficient if we
2857 * had a FLAG in SVs to signal if there are any hibit
2858 * chars in the PV. Given that there isn't such a flag
2859 * make the loop as fast as possible. */
2860 const U8 * const s = (U8 *) SvPVX_const(sv);
2861 const U8 * const e = (U8 *) SvEND(sv);
2866 /* Check for hi bit */
2867 if (!NATIVE_IS_INVARIANT(ch)) {
2868 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2869 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2871 SvPV_free(sv); /* No longer using what was there before. */
2872 SvPV_set(sv, (char*)recoded);
2873 SvCUR_set(sv, len - 1);
2874 SvLEN_set(sv, len); /* No longer know the real size. */
2878 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2885 =for apidoc sv_utf8_downgrade
2887 Attempts to convert the PV of an SV from characters to bytes.
2888 If the PV contains a character beyond byte, this conversion will fail;
2889 in this case, either returns false or, if C<fail_ok> is not
2892 This is not as a general purpose Unicode to byte encoding interface:
2893 use the Encode extension for that.
2899 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2902 if (SvPOKp(sv) && SvUTF8(sv)) {
2908 sv_force_normal_flags(sv, 0);
2910 s = (U8 *) SvPV(sv, len);
2911 if (!utf8_to_bytes(s, &len)) {
2916 Perl_croak(aTHX_ "Wide character in %s",
2919 Perl_croak(aTHX_ "Wide character");
2930 =for apidoc sv_utf8_encode
2932 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2933 flag off so that it looks like octets again.
2939 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2941 (void) sv_utf8_upgrade(sv);
2943 sv_force_normal_flags(sv, 0);
2945 if (SvREADONLY(sv)) {
2946 Perl_croak(aTHX_ PL_no_modify);
2952 =for apidoc sv_utf8_decode
2954 If the PV of the SV is an octet sequence in UTF-8
2955 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2956 so that it looks like a character. If the PV contains only single-byte
2957 characters, the C<SvUTF8> flag stays being off.
2958 Scans PV for validity and returns false if the PV is invalid UTF-8.
2964 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2970 /* The octets may have got themselves encoded - get them back as
2973 if (!sv_utf8_downgrade(sv, TRUE))
2976 /* it is actually just a matter of turning the utf8 flag on, but
2977 * we want to make sure everything inside is valid utf8 first.
2979 c = (const U8 *) SvPVX_const(sv);
2980 if (!is_utf8_string(c, SvCUR(sv)+1))
2982 e = (const U8 *) SvEND(sv);
2985 if (!UTF8_IS_INVARIANT(ch)) {
2995 =for apidoc sv_setsv
2997 Copies the contents of the source SV C<ssv> into the destination SV
2998 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
2999 function if the source SV needs to be reused. Does not handle 'set' magic.
3000 Loosely speaking, it performs a copy-by-value, obliterating any previous
3001 content of the destination.
3003 You probably want to use one of the assortment of wrappers, such as
3004 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3005 C<SvSetMagicSV_nosteal>.
3007 =for apidoc sv_setsv_flags
3009 Copies the contents of the source SV C<ssv> into the destination SV
3010 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3011 function if the source SV needs to be reused. Does not handle 'set' magic.
3012 Loosely speaking, it performs a copy-by-value, obliterating any previous
3013 content of the destination.
3014 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3015 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3016 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3017 and C<sv_setsv_nomg> are implemented in terms of this function.
3019 You probably want to use one of the assortment of wrappers, such as
3020 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3021 C<SvSetMagicSV_nosteal>.
3023 This is the primary function for copying scalars, and most other
3024 copy-ish functions and macros use this underneath.
3030 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
3032 if (dtype != SVt_PVGV) {
3033 const char * const name = GvNAME(sstr);
3034 const STRLEN len = GvNAMELEN(sstr);
3035 /* don't upgrade SVt_PVLV: it can hold a glob */
3036 if (dtype != SVt_PVLV)
3037 sv_upgrade(dstr, SVt_PVGV);
3038 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3039 GvSTASH(dstr) = GvSTASH(sstr);
3041 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3042 GvNAME(dstr) = savepvn(name, len);
3043 GvNAMELEN(dstr) = len;
3044 SvFAKE_on(dstr); /* can coerce to non-glob */
3047 #ifdef GV_UNIQUE_CHECK
3048 if (GvUNIQUE((GV*)dstr)) {
3049 Perl_croak(aTHX_ PL_no_modify);
3053 (void)SvOK_off(dstr);
3054 GvINTRO_off(dstr); /* one-shot flag */
3056 GvGP(dstr) = gp_ref(GvGP(sstr));
3057 if (SvTAINTED(sstr))
3059 if (GvIMPORTED(dstr) != GVf_IMPORTED
3060 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3062 GvIMPORTED_on(dstr);
3069 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
3070 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3072 const int intro = GvINTRO(dstr);
3074 #ifdef GV_UNIQUE_CHECK
3075 if (GvUNIQUE((GV*)dstr)) {
3076 Perl_croak(aTHX_ PL_no_modify);
3081 GvINTRO_off(dstr); /* one-shot flag */
3082 GvLINE(dstr) = CopLINE(PL_curcop);
3083 GvEGV(dstr) = (GV*)dstr;
3086 switch (SvTYPE(sref)) {
3089 SAVEGENERICSV(GvAV(dstr));
3091 dref = (SV*)GvAV(dstr);
3092 GvAV(dstr) = (AV*)sref;
3093 if (!GvIMPORTED_AV(dstr)
3094 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3096 GvIMPORTED_AV_on(dstr);
3101 SAVEGENERICSV(GvHV(dstr));
3103 dref = (SV*)GvHV(dstr);
3104 GvHV(dstr) = (HV*)sref;
3105 if (!GvIMPORTED_HV(dstr)
3106 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3108 GvIMPORTED_HV_on(dstr);
3113 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3114 SvREFCNT_dec(GvCV(dstr));
3116 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3117 PL_sub_generation++;
3119 SAVEGENERICSV(GvCV(dstr));
3122 dref = (SV*)GvCV(dstr);
3123 if (GvCV(dstr) != (CV*)sref) {
3124 CV* const cv = GvCV(dstr);
3126 if (!GvCVGEN((GV*)dstr) &&
3127 (CvROOT(cv) || CvXSUB(cv)))
3129 /* Redefining a sub - warning is mandatory if
3130 it was a const and its value changed. */
3131 if (CvCONST(cv) && CvCONST((CV*)sref)
3132 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3133 /* They are 2 constant subroutines generated from
3134 the same constant. This probably means that
3135 they are really the "same" proxy subroutine
3136 instantiated in 2 places. Most likely this is
3137 when a constant is exported twice. Don't warn.
3140 else if (ckWARN(WARN_REDEFINE)
3142 && (!CvCONST((CV*)sref)
3143 || sv_cmp(cv_const_sv(cv),
3144 cv_const_sv((CV*)sref))))) {
3145 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3147 ? "Constant subroutine %s::%s redefined"
3148 : "Subroutine %s::%s redefined",
3149 HvNAME_get(GvSTASH((GV*)dstr)),
3150 GvENAME((GV*)dstr));
3154 cv_ckproto(cv, (GV*)dstr,
3155 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3157 GvCV(dstr) = (CV*)sref;
3158 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3159 GvASSUMECV_on(dstr);
3160 PL_sub_generation++;
3162 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3163 GvIMPORTED_CV_on(dstr);
3168 SAVEGENERICSV(GvIOp(dstr));
3170 dref = (SV*)GvIOp(dstr);
3171 GvIOp(dstr) = (IO*)sref;
3175 SAVEGENERICSV(GvFORM(dstr));
3177 dref = (SV*)GvFORM(dstr);
3178 GvFORM(dstr) = (CV*)sref;
3182 SAVEGENERICSV(GvSV(dstr));
3184 dref = (SV*)GvSV(dstr);
3186 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3187 GvIMPORTED_SV_on(dstr);
3193 if (SvTAINTED(sstr))
3199 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3202 register U32 sflags;
3208 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3210 sstr = &PL_sv_undef;
3211 stype = SvTYPE(sstr);
3212 dtype = SvTYPE(dstr);
3217 /* need to nuke the magic */
3219 SvRMAGICAL_off(dstr);
3222 /* There's a lot of redundancy below but we're going for speed here */
3227 if (dtype != SVt_PVGV) {
3228 (void)SvOK_off(dstr);
3236 sv_upgrade(dstr, SVt_IV);
3239 sv_upgrade(dstr, SVt_PVNV);
3243 sv_upgrade(dstr, SVt_PVIV);
3246 (void)SvIOK_only(dstr);
3247 SvIV_set(dstr, SvIVX(sstr));
3250 /* SvTAINTED can only be true if the SV has taint magic, which in
3251 turn means that the SV type is PVMG (or greater). This is the
3252 case statement for SVt_IV, so this cannot be true (whatever gcov
3254 assert(!SvTAINTED(sstr));
3264 sv_upgrade(dstr, SVt_NV);
3269 sv_upgrade(dstr, SVt_PVNV);
3272 SvNV_set(dstr, SvNVX(sstr));
3273 (void)SvNOK_only(dstr);
3274 /* SvTAINTED can only be true if the SV has taint magic, which in
3275 turn means that the SV type is PVMG (or greater). This is the
3276 case statement for SVt_NV, so this cannot be true (whatever gcov
3278 assert(!SvTAINTED(sstr));
3285 sv_upgrade(dstr, SVt_RV);
3286 else if (dtype == SVt_PVGV &&
3287 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3290 if (GvIMPORTED(dstr) != GVf_IMPORTED
3291 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3293 GvIMPORTED_on(dstr);
3298 S_glob_assign(aTHX_ dstr, sstr, dtype);
3303 #ifdef PERL_OLD_COPY_ON_WRITE
3304 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3305 if (dtype < SVt_PVIV)
3306 sv_upgrade(dstr, SVt_PVIV);
3313 sv_upgrade(dstr, SVt_PV);
3316 if (dtype < SVt_PVIV)
3317 sv_upgrade(dstr, SVt_PVIV);
3320 if (dtype < SVt_PVNV)
3321 sv_upgrade(dstr, SVt_PVNV);
3328 const char * const type = sv_reftype(sstr,0);
3330 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3332 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3337 if (dtype <= SVt_PVGV) {
3338 S_glob_assign(aTHX_ dstr, sstr, dtype);
3344 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3346 if ((int)SvTYPE(sstr) != stype) {
3347 stype = SvTYPE(sstr);
3348 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3349 S_glob_assign(aTHX_ dstr, sstr, dtype);
3354 if (stype == SVt_PVLV)
3355 SvUPGRADE(dstr, SVt_PVNV);
3357 SvUPGRADE(dstr, (U32)stype);
3360 sflags = SvFLAGS(sstr);
3362 if (sflags & SVf_ROK) {
3363 if (dtype >= SVt_PV) {
3364 if (dtype == SVt_PVGV) {
3365 S_pvgv_assign(aTHX_ dstr, sstr);
3368 if (SvPVX_const(dstr)) {
3374 (void)SvOK_off(dstr);
3375 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3376 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3377 assert(!(sflags & SVp_NOK));
3378 assert(!(sflags & SVp_IOK));
3379 assert(!(sflags & SVf_NOK));
3380 assert(!(sflags & SVf_IOK));
3382 else if (sflags & SVp_POK) {
3386 * Check to see if we can just swipe the string. If so, it's a
3387 * possible small lose on short strings, but a big win on long ones.
3388 * It might even be a win on short strings if SvPVX_const(dstr)
3389 * has to be allocated and SvPVX_const(sstr) has to be freed.
3392 /* Whichever path we take through the next code, we want this true,
3393 and doing it now facilitates the COW check. */
3394 (void)SvPOK_only(dstr);
3397 /* We're not already COW */
3398 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3399 #ifndef PERL_OLD_COPY_ON_WRITE
3400 /* or we are, but dstr isn't a suitable target. */
3401 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3406 (sflags & SVs_TEMP) && /* slated for free anyway? */
3407 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3408 (!(flags & SV_NOSTEAL)) &&
3409 /* and we're allowed to steal temps */
3410 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3411 SvLEN(sstr) && /* and really is a string */
3412 /* and won't be needed again, potentially */
3413 !(PL_op && PL_op->op_type == OP_AASSIGN))
3414 #ifdef PERL_OLD_COPY_ON_WRITE
3415 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3416 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3417 && SvTYPE(sstr) >= SVt_PVIV)
3420 /* Failed the swipe test, and it's not a shared hash key either.
3421 Have to copy the string. */
3422 STRLEN len = SvCUR(sstr);
3423 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3424 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3425 SvCUR_set(dstr, len);
3426 *SvEND(dstr) = '\0';
3428 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3430 /* Either it's a shared hash key, or it's suitable for
3431 copy-on-write or we can swipe the string. */
3433 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3437 #ifdef PERL_OLD_COPY_ON_WRITE
3439 /* I believe I should acquire a global SV mutex if
3440 it's a COW sv (not a shared hash key) to stop
3441 it going un copy-on-write.
3442 If the source SV has gone un copy on write between up there
3443 and down here, then (assert() that) it is of the correct
3444 form to make it copy on write again */
3445 if ((sflags & (SVf_FAKE | SVf_READONLY))
3446 != (SVf_FAKE | SVf_READONLY)) {
3447 SvREADONLY_on(sstr);
3449 /* Make the source SV into a loop of 1.
3450 (about to become 2) */
3451 SV_COW_NEXT_SV_SET(sstr, sstr);
3455 /* Initial code is common. */
3456 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3461 /* making another shared SV. */
3462 STRLEN cur = SvCUR(sstr);
3463 STRLEN len = SvLEN(sstr);
3464 #ifdef PERL_OLD_COPY_ON_WRITE
3466 assert (SvTYPE(dstr) >= SVt_PVIV);
3467 /* SvIsCOW_normal */
3468 /* splice us in between source and next-after-source. */
3469 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3470 SV_COW_NEXT_SV_SET(sstr, dstr);
3471 SvPV_set(dstr, SvPVX_mutable(sstr));
3475 /* SvIsCOW_shared_hash */
3476 DEBUG_C(PerlIO_printf(Perl_debug_log,
3477 "Copy on write: Sharing hash\n"));
3479 assert (SvTYPE(dstr) >= SVt_PV);
3481 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3483 SvLEN_set(dstr, len);
3484 SvCUR_set(dstr, cur);
3485 SvREADONLY_on(dstr);
3487 /* Relesase a global SV mutex. */
3490 { /* Passes the swipe test. */
3491 SvPV_set(dstr, SvPVX_mutable(sstr));
3492 SvLEN_set(dstr, SvLEN(sstr));
3493 SvCUR_set(dstr, SvCUR(sstr));
3496 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3497 SvPV_set(sstr, NULL);
3503 if (sflags & SVp_NOK) {
3504 SvNV_set(dstr, SvNVX(sstr));
3506 if (sflags & SVp_IOK) {
3507 SvRELEASE_IVX(dstr);
3508 SvIV_set(dstr, SvIVX(sstr));
3509 /* Must do this otherwise some other overloaded use of 0x80000000
3510 gets confused. I guess SVpbm_VALID */
3511 if (sflags & SVf_IVisUV)
3514 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3516 const MAGIC * const smg = SvVOK(sstr);
3518 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3519 smg->mg_ptr, smg->mg_len);
3520 SvRMAGICAL_on(dstr);
3524 else if (sflags & (SVp_IOK|SVp_NOK)) {
3525 (void)SvOK_off(dstr);
3526 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3527 if (sflags & SVp_IOK) {
3528 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3529 SvIV_set(dstr, SvIVX(sstr));
3531 if (sflags & SVp_NOK) {
3532 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3533 SvNV_set(dstr, SvNVX(sstr));
3537 if (dtype == SVt_PVGV) {
3538 if (ckWARN(WARN_MISC))
3539 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3542 (void)SvOK_off(dstr);
3544 if (SvTAINTED(sstr))
3549 =for apidoc sv_setsv_mg
3551 Like C<sv_setsv>, but also handles 'set' magic.
3557 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3559 sv_setsv(dstr,sstr);
3563 #ifdef PERL_OLD_COPY_ON_WRITE
3565 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3567 STRLEN cur = SvCUR(sstr);
3568 STRLEN len = SvLEN(sstr);
3569 register char *new_pv;
3572 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3580 if (SvTHINKFIRST(dstr))
3581 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3582 else if (SvPVX_const(dstr))
3583 Safefree(SvPVX_const(dstr));
3587 SvUPGRADE(dstr, SVt_PVIV);
3589 assert (SvPOK(sstr));
3590 assert (SvPOKp(sstr));
3591 assert (!SvIOK(sstr));
3592 assert (!SvIOKp(sstr));
3593 assert (!SvNOK(sstr));
3594 assert (!SvNOKp(sstr));
3596 if (SvIsCOW(sstr)) {
3598 if (SvLEN(sstr) == 0) {
3599 /* source is a COW shared hash key. */
3600 DEBUG_C(PerlIO_printf(Perl_debug_log,
3601 "Fast copy on write: Sharing hash\n"));
3602 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3605 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3607 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3608 SvUPGRADE(sstr, SVt_PVIV);
3609 SvREADONLY_on(sstr);
3611 DEBUG_C(PerlIO_printf(Perl_debug_log,
3612 "Fast copy on write: Converting sstr to COW\n"));
3613 SV_COW_NEXT_SV_SET(dstr, sstr);
3615 SV_COW_NEXT_SV_SET(sstr, dstr);
3616 new_pv = SvPVX_mutable(sstr);
3619 SvPV_set(dstr, new_pv);
3620 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3623 SvLEN_set(dstr, len);
3624 SvCUR_set(dstr, cur);
3633 =for apidoc sv_setpvn
3635 Copies a string into an SV. The C<len> parameter indicates the number of
3636 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3637 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3643 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3646 register char *dptr;
3648 SV_CHECK_THINKFIRST_COW_DROP(sv);
3654 /* len is STRLEN which is unsigned, need to copy to signed */
3657 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3659 SvUPGRADE(sv, SVt_PV);
3661 dptr = SvGROW(sv, len + 1);
3662 Move(ptr,dptr,len,char);
3665 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3670 =for apidoc sv_setpvn_mg
3672 Like C<sv_setpvn>, but also handles 'set' magic.
3678 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3680 sv_setpvn(sv,ptr,len);
3685 =for apidoc sv_setpv
3687 Copies a string into an SV. The string must be null-terminated. Does not
3688 handle 'set' magic. See C<sv_setpv_mg>.
3694 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3697 register STRLEN len;
3699 SV_CHECK_THINKFIRST_COW_DROP(sv);
3705 SvUPGRADE(sv, SVt_PV);
3707 SvGROW(sv, len + 1);
3708 Move(ptr,SvPVX(sv),len+1,char);
3710 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3715 =for apidoc sv_setpv_mg
3717 Like C<sv_setpv>, but also handles 'set' magic.
3723 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3730 =for apidoc sv_usepvn
3732 Tells an SV to use C<ptr> to find its string value. Normally the string is
3733 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3734 The C<ptr> should point to memory that was allocated by C<malloc>. The
3735 string length, C<len>, must be supplied. This function will realloc the
3736 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3737 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3738 See C<sv_usepvn_mg>.
3744 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3748 SV_CHECK_THINKFIRST_COW_DROP(sv);
3749 SvUPGRADE(sv, SVt_PV);
3754 if (SvPVX_const(sv))
3757 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3758 ptr = saferealloc (ptr, allocate);
3761 SvLEN_set(sv, allocate);
3763 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3768 =for apidoc sv_usepvn_mg
3770 Like C<sv_usepvn>, but also handles 'set' magic.
3776 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3778 sv_usepvn(sv,ptr,len);
3782 #ifdef PERL_OLD_COPY_ON_WRITE
3783 /* Need to do this *after* making the SV normal, as we need the buffer
3784 pointer to remain valid until after we've copied it. If we let go too early,
3785 another thread could invalidate it by unsharing last of the same hash key
3786 (which it can do by means other than releasing copy-on-write Svs)
3787 or by changing the other copy-on-write SVs in the loop. */
3789 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3791 if (len) { /* this SV was SvIsCOW_normal(sv) */
3792 /* we need to find the SV pointing to us. */
3793 SV *current = SV_COW_NEXT_SV(after);
3795 if (current == sv) {
3796 /* The SV we point to points back to us (there were only two of us
3798 Hence other SV is no longer copy on write either. */
3800 SvREADONLY_off(after);
3802 /* We need to follow the pointers around the loop. */
3804 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3807 /* don't loop forever if the structure is bust, and we have
3808 a pointer into a closed loop. */
3809 assert (current != after);
3810 assert (SvPVX_const(current) == pvx);
3812 /* Make the SV before us point to the SV after us. */
3813 SV_COW_NEXT_SV_SET(current, after);
3816 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3821 Perl_sv_release_IVX(pTHX_ register SV *sv)
3824 sv_force_normal_flags(sv, 0);
3830 =for apidoc sv_force_normal_flags
3832 Undo various types of fakery on an SV: if the PV is a shared string, make
3833 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3834 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3835 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3836 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3837 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3838 set to some other value.) In addition, the C<flags> parameter gets passed to
3839 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3840 with flags set to 0.
3846 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3849 #ifdef PERL_OLD_COPY_ON_WRITE
3850 if (SvREADONLY(sv)) {
3851 /* At this point I believe I should acquire a global SV mutex. */
3853 const char * const pvx = SvPVX_const(sv);
3854 const STRLEN len = SvLEN(sv);
3855 const STRLEN cur = SvCUR(sv);
3856 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3858 PerlIO_printf(Perl_debug_log,
3859 "Copy on write: Force normal %ld\n",
3865 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3868 if (flags & SV_COW_DROP_PV) {
3869 /* OK, so we don't need to copy our buffer. */
3872 SvGROW(sv, cur + 1);
3873 Move(pvx,SvPVX(sv),cur,char);
3877 sv_release_COW(sv, pvx, len, next);
3882 else if (IN_PERL_RUNTIME)
3883 Perl_croak(aTHX_ PL_no_modify);
3884 /* At this point I believe that I can drop the global SV mutex. */
3887 if (SvREADONLY(sv)) {
3889 const char * const pvx = SvPVX_const(sv);
3890 const STRLEN len = SvCUR(sv);
3895 SvGROW(sv, len + 1);
3896 Move(pvx,SvPVX(sv),len,char);
3898 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3900 else if (IN_PERL_RUNTIME)
3901 Perl_croak(aTHX_ PL_no_modify);
3905 sv_unref_flags(sv, flags);
3906 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3913 Efficient removal of characters from the beginning of the string buffer.
3914 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3915 the string buffer. The C<ptr> becomes the first character of the adjusted
3916 string. Uses the "OOK hack".
3917 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3918 refer to the same chunk of data.
3924 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3926 register STRLEN delta;
3927 if (!ptr || !SvPOKp(sv))
3929 delta = ptr - SvPVX_const(sv);
3930 SV_CHECK_THINKFIRST(sv);
3931 if (SvTYPE(sv) < SVt_PVIV)
3932 sv_upgrade(sv,SVt_PVIV);
3935 if (!SvLEN(sv)) { /* make copy of shared string */
3936 const char *pvx = SvPVX_const(sv);
3937 const STRLEN len = SvCUR(sv);
3938 SvGROW(sv, len + 1);
3939 Move(pvx,SvPVX(sv),len,char);
3943 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3944 and we do that anyway inside the SvNIOK_off
3946 SvFLAGS(sv) |= SVf_OOK;
3949 SvLEN_set(sv, SvLEN(sv) - delta);
3950 SvCUR_set(sv, SvCUR(sv) - delta);
3951 SvPV_set(sv, SvPVX(sv) + delta);
3952 SvIV_set(sv, SvIVX(sv) + delta);
3956 =for apidoc sv_catpvn
3958 Concatenates the string onto the end of the string which is in the SV. The
3959 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3960 status set, then the bytes appended should be valid UTF-8.
3961 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3963 =for apidoc sv_catpvn_flags
3965 Concatenates the string onto the end of the string which is in the SV. The
3966 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3967 status set, then the bytes appended should be valid UTF-8.
3968 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3969 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3970 in terms of this function.
3976 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3980 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3982 SvGROW(dsv, dlen + slen + 1);
3984 sstr = SvPVX_const(dsv);
3985 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3986 SvCUR_set(dsv, SvCUR(dsv) + slen);
3988 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3990 if (flags & SV_SMAGIC)
3995 =for apidoc sv_catsv
3997 Concatenates the string from SV C<ssv> onto the end of the string in
3998 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
3999 not 'set' magic. See C<sv_catsv_mg>.
4001 =for apidoc sv_catsv_flags
4003 Concatenates the string from SV C<ssv> onto the end of the string in
4004 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4005 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4006 and C<sv_catsv_nomg> are implemented in terms of this function.
4011 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4016 const char *spv = SvPV_const(ssv, slen);
4018 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4019 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4020 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4021 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4022 dsv->sv_flags doesn't have that bit set.
4023 Andy Dougherty 12 Oct 2001
4025 const I32 sutf8 = DO_UTF8(ssv);
4028 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4030 dutf8 = DO_UTF8(dsv);
4032 if (dutf8 != sutf8) {
4034 /* Not modifying source SV, so taking a temporary copy. */
4035 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4037 sv_utf8_upgrade(csv);
4038 spv = SvPV_const(csv, slen);
4041 sv_utf8_upgrade_nomg(dsv);
4043 sv_catpvn_nomg(dsv, spv, slen);
4046 if (flags & SV_SMAGIC)
4051 =for apidoc sv_catpv
4053 Concatenates the string onto the end of the string which is in the SV.
4054 If the SV has the UTF-8 status set, then the bytes appended should be
4055 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4060 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4063 register STRLEN len;
4069 junk = SvPV_force(sv, tlen);
4071 SvGROW(sv, tlen + len + 1);
4073 ptr = SvPVX_const(sv);
4074 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4075 SvCUR_set(sv, SvCUR(sv) + len);
4076 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4081 =for apidoc sv_catpv_mg
4083 Like C<sv_catpv>, but also handles 'set' magic.
4089 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4098 Creates a new SV. A non-zero C<len> parameter indicates the number of
4099 bytes of preallocated string space the SV should have. An extra byte for a
4100 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4101 space is allocated.) The reference count for the new SV is set to 1.
4103 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4104 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4105 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4106 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4107 modules supporting older perls.
4113 Perl_newSV(pTHX_ STRLEN len)
4120 sv_upgrade(sv, SVt_PV);
4121 SvGROW(sv, len + 1);
4126 =for apidoc sv_magicext
4128 Adds magic to an SV, upgrading it if necessary. Applies the
4129 supplied vtable and returns a pointer to the magic added.
4131 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4132 In particular, you can add magic to SvREADONLY SVs, and add more than
4133 one instance of the same 'how'.
4135 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4136 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4137 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4138 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4140 (This is now used as a subroutine by C<sv_magic>.)
4145 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4146 const char* name, I32 namlen)
4151 if (SvTYPE(sv) < SVt_PVMG) {
4152 SvUPGRADE(sv, SVt_PVMG);
4154 Newxz(mg, 1, MAGIC);
4155 mg->mg_moremagic = SvMAGIC(sv);
4156 SvMAGIC_set(sv, mg);
4158 /* Sometimes a magic contains a reference loop, where the sv and
4159 object refer to each other. To prevent a reference loop that
4160 would prevent such objects being freed, we look for such loops
4161 and if we find one we avoid incrementing the object refcount.
4163 Note we cannot do this to avoid self-tie loops as intervening RV must
4164 have its REFCNT incremented to keep it in existence.
4167 if (!obj || obj == sv ||
4168 how == PERL_MAGIC_arylen ||
4169 how == PERL_MAGIC_qr ||
4170 how == PERL_MAGIC_symtab ||
4171 (SvTYPE(obj) == SVt_PVGV &&
4172 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4173 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4174 GvFORM(obj) == (CV*)sv)))
4179 mg->mg_obj = SvREFCNT_inc(obj);
4180 mg->mg_flags |= MGf_REFCOUNTED;
4183 /* Normal self-ties simply pass a null object, and instead of
4184 using mg_obj directly, use the SvTIED_obj macro to produce a
4185 new RV as needed. For glob "self-ties", we are tieing the PVIO
4186 with an RV obj pointing to the glob containing the PVIO. In
4187 this case, to avoid a reference loop, we need to weaken the
4191 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4192 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4198 mg->mg_len = namlen;
4201 mg->mg_ptr = savepvn(name, namlen);
4202 else if (namlen == HEf_SVKEY)
4203 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4205 mg->mg_ptr = (char *) name;
4207 mg->mg_virtual = vtable;
4211 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4216 =for apidoc sv_magic
4218 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4219 then adds a new magic item of type C<how> to the head of the magic list.
4221 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4222 handling of the C<name> and C<namlen> arguments.
4224 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4225 to add more than one instance of the same 'how'.
4231 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4237 #ifdef PERL_OLD_COPY_ON_WRITE
4239 sv_force_normal_flags(sv, 0);
4241 if (SvREADONLY(sv)) {
4243 /* its okay to attach magic to shared strings; the subsequent
4244 * upgrade to PVMG will unshare the string */
4245 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4248 && how != PERL_MAGIC_regex_global
4249 && how != PERL_MAGIC_bm
4250 && how != PERL_MAGIC_fm
4251 && how != PERL_MAGIC_sv
4252 && how != PERL_MAGIC_backref
4255 Perl_croak(aTHX_ PL_no_modify);
4258 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4259 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4260 /* sv_magic() refuses to add a magic of the same 'how' as an
4263 if (how == PERL_MAGIC_taint)
4271 vtable = &PL_vtbl_sv;
4273 case PERL_MAGIC_overload:
4274 vtable = &PL_vtbl_amagic;
4276 case PERL_MAGIC_overload_elem:
4277 vtable = &PL_vtbl_amagicelem;
4279 case PERL_MAGIC_overload_table:
4280 vtable = &PL_vtbl_ovrld;
4283 vtable = &PL_vtbl_bm;
4285 case PERL_MAGIC_regdata:
4286 vtable = &PL_vtbl_regdata;
4288 case PERL_MAGIC_regdatum:
4289 vtable = &PL_vtbl_regdatum;
4291 case PERL_MAGIC_env:
4292 vtable = &PL_vtbl_env;
4295 vtable = &PL_vtbl_fm;
4297 case PERL_MAGIC_envelem:
4298 vtable = &PL_vtbl_envelem;
4300 case PERL_MAGIC_regex_global:
4301 vtable = &PL_vtbl_mglob;
4303 case PERL_MAGIC_isa:
4304 vtable = &PL_vtbl_isa;
4306 case PERL_MAGIC_isaelem:
4307 vtable = &PL_vtbl_isaelem;
4309 case PERL_MAGIC_nkeys:
4310 vtable = &PL_vtbl_nkeys;
4312 case PERL_MAGIC_dbfile:
4315 case PERL_MAGIC_dbline:
4316 vtable = &PL_vtbl_dbline;
4318 #ifdef USE_LOCALE_COLLATE
4319 case PERL_MAGIC_collxfrm:
4320 vtable = &PL_vtbl_collxfrm;
4322 #endif /* USE_LOCALE_COLLATE */
4323 case PERL_MAGIC_tied:
4324 vtable = &PL_vtbl_pack;
4326 case PERL_MAGIC_tiedelem:
4327 case PERL_MAGIC_tiedscalar:
4328 vtable = &PL_vtbl_packelem;
4331 vtable = &PL_vtbl_regexp;
4333 case PERL_MAGIC_sig:
4334 vtable = &PL_vtbl_sig;
4336 case PERL_MAGIC_sigelem:
4337 vtable = &PL_vtbl_sigelem;
4339 case PERL_MAGIC_taint:
4340 vtable = &PL_vtbl_taint;
4342 case PERL_MAGIC_uvar:
4343 vtable = &PL_vtbl_uvar;
4345 case PERL_MAGIC_vec:
4346 vtable = &PL_vtbl_vec;
4348 case PERL_MAGIC_arylen_p:
4349 case PERL_MAGIC_rhash:
4350 case PERL_MAGIC_symtab:
4351 case PERL_MAGIC_vstring:
4354 case PERL_MAGIC_utf8:
4355 vtable = &PL_vtbl_utf8;
4357 case PERL_MAGIC_substr:
4358 vtable = &PL_vtbl_substr;
4360 case PERL_MAGIC_defelem:
4361 vtable = &PL_vtbl_defelem;
4363 case PERL_MAGIC_glob:
4364 vtable = &PL_vtbl_glob;
4366 case PERL_MAGIC_arylen:
4367 vtable = &PL_vtbl_arylen;
4369 case PERL_MAGIC_pos:
4370 vtable = &PL_vtbl_pos;
4372 case PERL_MAGIC_backref:
4373 vtable = &PL_vtbl_backref;
4375 case PERL_MAGIC_ext:
4376 /* Reserved for use by extensions not perl internals. */
4377 /* Useful for attaching extension internal data to perl vars. */
4378 /* Note that multiple extensions may clash if magical scalars */
4379 /* etc holding private data from one are passed to another. */
4383 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4386 /* Rest of work is done else where */
4387 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4390 case PERL_MAGIC_taint:
4393 case PERL_MAGIC_ext:
4394 case PERL_MAGIC_dbfile:
4401 =for apidoc sv_unmagic
4403 Removes all magic of type C<type> from an SV.
4409 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4413 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4416 for (mg = *mgp; mg; mg = *mgp) {
4417 if (mg->mg_type == type) {
4418 const MGVTBL* const vtbl = mg->mg_virtual;
4419 *mgp = mg->mg_moremagic;
4420 if (vtbl && vtbl->svt_free)
4421 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4422 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4424 Safefree(mg->mg_ptr);
4425 else if (mg->mg_len == HEf_SVKEY)
4426 SvREFCNT_dec((SV*)mg->mg_ptr);
4427 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4428 Safefree(mg->mg_ptr);
4430 if (mg->mg_flags & MGf_REFCOUNTED)
4431 SvREFCNT_dec(mg->mg_obj);
4435 mgp = &mg->mg_moremagic;
4439 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4440 SvMAGIC_set(sv, NULL);
4447 =for apidoc sv_rvweaken
4449 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4450 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4451 push a back-reference to this RV onto the array of backreferences
4452 associated with that magic.
4458 Perl_sv_rvweaken(pTHX_ SV *sv)
4461 if (!SvOK(sv)) /* let undefs pass */
4464 Perl_croak(aTHX_ "Can't weaken a nonreference");
4465 else if (SvWEAKREF(sv)) {
4466 if (ckWARN(WARN_MISC))
4467 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4471 Perl_sv_add_backref(aTHX_ tsv, sv);
4477 /* Give tsv backref magic if it hasn't already got it, then push a
4478 * back-reference to sv onto the array associated with the backref magic.
4482 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4487 if (SvTYPE(tsv) == SVt_PVHV) {
4488 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4492 /* There is no AV in the offical place - try a fixup. */
4493 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4496 /* Aha. They've got it stowed in magic. Bring it back. */
4497 av = (AV*)mg->mg_obj;
4498 /* Stop mg_free decreasing the refernce count. */
4500 /* Stop mg_free even calling the destructor, given that
4501 there's no AV to free up. */
4503 sv_unmagic(tsv, PERL_MAGIC_backref);
4512 const MAGIC *const mg
4513 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4515 av = (AV*)mg->mg_obj;
4519 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4520 /* av now has a refcnt of 2, which avoids it getting freed
4521 * before us during global cleanup. The extra ref is removed
4522 * by magic_killbackrefs() when tsv is being freed */
4525 if (AvFILLp(av) >= AvMAX(av)) {
4526 av_extend(av, AvFILLp(av)+1);
4528 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4531 /* delete a back-reference to ourselves from the backref magic associated
4532 * with the SV we point to.
4536 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4543 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4544 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4545 /* We mustn't attempt to "fix up" the hash here by moving the
4546 backreference array back to the hv_aux structure, as that is stored
4547 in the main HvARRAY(), and hfreentries assumes that no-one
4548 reallocates HvARRAY() while it is running. */
4551 const MAGIC *const mg
4552 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4554 av = (AV *)mg->mg_obj;
4557 if (PL_in_clean_all)
4559 Perl_croak(aTHX_ "panic: del_backref");
4566 /* We shouldn't be in here more than once, but for paranoia reasons lets
4568 for (i = AvFILLp(av); i >= 0; i--) {
4570 const SSize_t fill = AvFILLp(av);
4572 /* We weren't the last entry.
4573 An unordered list has this property that you can take the
4574 last element off the end to fill the hole, and it's still
4575 an unordered list :-)
4580 AvFILLp(av) = fill - 1;
4586 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4588 SV **svp = AvARRAY(av);
4590 PERL_UNUSED_ARG(sv);
4592 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4593 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4594 if (svp && !SvIS_FREED(av)) {
4595 SV *const *const last = svp + AvFILLp(av);
4597 while (svp <= last) {
4599 SV *const referrer = *svp;
4600 if (SvWEAKREF(referrer)) {
4601 /* XXX Should we check that it hasn't changed? */
4602 SvRV_set(referrer, 0);
4604 SvWEAKREF_off(referrer);
4605 } else if (SvTYPE(referrer) == SVt_PVGV ||
4606 SvTYPE(referrer) == SVt_PVLV) {
4607 /* You lookin' at me? */
4608 assert(GvSTASH(referrer));
4609 assert(GvSTASH(referrer) == (HV*)sv);
4610 GvSTASH(referrer) = 0;
4613 "panic: magic_killbackrefs (flags=%"UVxf")",
4614 (UV)SvFLAGS(referrer));
4622 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4627 =for apidoc sv_insert
4629 Inserts a string at the specified offset/length within the SV. Similar to
4630 the Perl substr() function.
4636 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4641 register char *midend;
4642 register char *bigend;
4648 Perl_croak(aTHX_ "Can't modify non-existent substring");
4649 SvPV_force(bigstr, curlen);
4650 (void)SvPOK_only_UTF8(bigstr);
4651 if (offset + len > curlen) {
4652 SvGROW(bigstr, offset+len+1);
4653 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4654 SvCUR_set(bigstr, offset+len);
4658 i = littlelen - len;
4659 if (i > 0) { /* string might grow */
4660 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4661 mid = big + offset + len;
4662 midend = bigend = big + SvCUR(bigstr);
4665 while (midend > mid) /* shove everything down */
4666 *--bigend = *--midend;
4667 Move(little,big+offset,littlelen,char);
4668 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4673 Move(little,SvPVX(bigstr)+offset,len,char);
4678 big = SvPVX(bigstr);
4681 bigend = big + SvCUR(bigstr);
4683 if (midend > bigend)
4684 Perl_croak(aTHX_ "panic: sv_insert");
4686 if (mid - big > bigend - midend) { /* faster to shorten from end */
4688 Move(little, mid, littlelen,char);
4691 i = bigend - midend;
4693 Move(midend, mid, i,char);
4697 SvCUR_set(bigstr, mid - big);
4699 else if ((i = mid - big)) { /* faster from front */
4700 midend -= littlelen;
4702 sv_chop(bigstr,midend-i);
4707 Move(little, mid, littlelen,char);
4709 else if (littlelen) {
4710 midend -= littlelen;
4711 sv_chop(bigstr,midend);
4712 Move(little,midend,littlelen,char);
4715 sv_chop(bigstr,midend);
4721 =for apidoc sv_replace
4723 Make the first argument a copy of the second, then delete the original.
4724 The target SV physically takes over ownership of the body of the source SV
4725 and inherits its flags; however, the target keeps any magic it owns,
4726 and any magic in the source is discarded.
4727 Note that this is a rather specialist SV copying operation; most of the
4728 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4734 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4737 const U32 refcnt = SvREFCNT(sv);
4738 SV_CHECK_THINKFIRST_COW_DROP(sv);
4739 if (SvREFCNT(nsv) != 1) {
4740 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4741 UVuf " != 1)", (UV) SvREFCNT(nsv));
4743 if (SvMAGICAL(sv)) {
4747 sv_upgrade(nsv, SVt_PVMG);
4748 SvMAGIC_set(nsv, SvMAGIC(sv));
4749 SvFLAGS(nsv) |= SvMAGICAL(sv);
4751 SvMAGIC_set(sv, NULL);
4755 assert(!SvREFCNT(sv));
4756 #ifdef DEBUG_LEAKING_SCALARS
4757 sv->sv_flags = nsv->sv_flags;
4758 sv->sv_any = nsv->sv_any;
4759 sv->sv_refcnt = nsv->sv_refcnt;
4760 sv->sv_u = nsv->sv_u;
4762 StructCopy(nsv,sv,SV);
4764 /* Currently could join these into one piece of pointer arithmetic, but
4765 it would be unclear. */
4766 if(SvTYPE(sv) == SVt_IV)
4768 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4769 else if (SvTYPE(sv) == SVt_RV) {
4770 SvANY(sv) = &sv->sv_u.svu_rv;
4774 #ifdef PERL_OLD_COPY_ON_WRITE
4775 if (SvIsCOW_normal(nsv)) {
4776 /* We need to follow the pointers around the loop to make the
4777 previous SV point to sv, rather than nsv. */
4780 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4783 assert(SvPVX_const(current) == SvPVX_const(nsv));
4785 /* Make the SV before us point to the SV after us. */
4787 PerlIO_printf(Perl_debug_log, "previous is\n");
4789 PerlIO_printf(Perl_debug_log,
4790 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4791 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4793 SV_COW_NEXT_SV_SET(current, sv);
4796 SvREFCNT(sv) = refcnt;
4797 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4803 =for apidoc sv_clear
4805 Clear an SV: call any destructors, free up any memory used by the body,
4806 and free the body itself. The SV's head is I<not> freed, although
4807 its type is set to all 1's so that it won't inadvertently be assumed
4808 to be live during global destruction etc.
4809 This function should only be called when REFCNT is zero. Most of the time
4810 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4817 Perl_sv_clear(pTHX_ register SV *sv)
4820 const U32 type = SvTYPE(sv);
4821 const struct body_details *const sv_type_details
4822 = bodies_by_type + type;
4825 assert(SvREFCNT(sv) == 0);
4831 if (PL_defstash) { /* Still have a symbol table? */
4836 stash = SvSTASH(sv);
4837 destructor = StashHANDLER(stash,DESTROY);
4839 SV* const tmpref = newRV(sv);
4840 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4842 PUSHSTACKi(PERLSI_DESTROY);
4847 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4853 if(SvREFCNT(tmpref) < 2) {
4854 /* tmpref is not kept alive! */
4856 SvRV_set(tmpref, NULL);
4859 SvREFCNT_dec(tmpref);
4861 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4865 if (PL_in_clean_objs)
4866 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4868 /* DESTROY gave object new lease on life */
4874 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4875 SvOBJECT_off(sv); /* Curse the object. */
4876 if (type != SVt_PVIO)
4877 --PL_sv_objcount; /* XXX Might want something more general */
4880 if (type >= SVt_PVMG) {
4883 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4884 SvREFCNT_dec(SvSTASH(sv));
4889 IoIFP(sv) != PerlIO_stdin() &&
4890 IoIFP(sv) != PerlIO_stdout() &&
4891 IoIFP(sv) != PerlIO_stderr())
4893 io_close((IO*)sv, FALSE);
4895 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4896 PerlDir_close(IoDIRP(sv));
4897 IoDIRP(sv) = (DIR*)NULL;
4898 Safefree(IoTOP_NAME(sv));
4899 Safefree(IoFMT_NAME(sv));
4900 Safefree(IoBOTTOM_NAME(sv));
4909 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4916 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4917 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4918 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4919 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4921 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4922 SvREFCNT_dec(LvTARG(sv));
4926 Safefree(GvNAME(sv));
4927 /* If we're in a stash, we don't own a reference to it. However it does
4928 have a back reference to us, which needs to be cleared. */
4930 sv_del_backref((SV*)GvSTASH(sv), sv);
4935 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4937 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4938 /* Don't even bother with turning off the OOK flag. */
4943 SV *target = SvRV(sv);
4945 sv_del_backref(target, sv);
4947 SvREFCNT_dec(target);
4949 #ifdef PERL_OLD_COPY_ON_WRITE
4950 else if (SvPVX_const(sv)) {
4952 /* I believe I need to grab the global SV mutex here and
4953 then recheck the COW status. */
4955 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4958 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4959 SV_COW_NEXT_SV(sv));
4960 /* And drop it here. */
4962 } else if (SvLEN(sv)) {
4963 Safefree(SvPVX_const(sv));
4967 else if (SvPVX_const(sv) && SvLEN(sv))
4968 Safefree(SvPVX_mutable(sv));
4969 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4970 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4979 SvFLAGS(sv) &= SVf_BREAK;
4980 SvFLAGS(sv) |= SVTYPEMASK;
4982 if (sv_type_details->arena) {
4983 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4984 &PL_body_roots[type]);
4986 else if (sv_type_details->size) {
4987 my_safefree(SvANY(sv));
4992 =for apidoc sv_newref
4994 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5001 Perl_sv_newref(pTHX_ SV *sv)
5011 Decrement an SV's reference count, and if it drops to zero, call
5012 C<sv_clear> to invoke destructors and free up any memory used by
5013 the body; finally, deallocate the SV's head itself.
5014 Normally called via a wrapper macro C<SvREFCNT_dec>.
5020 Perl_sv_free(pTHX_ SV *sv)
5025 if (SvREFCNT(sv) == 0) {
5026 if (SvFLAGS(sv) & SVf_BREAK)
5027 /* this SV's refcnt has been artificially decremented to
5028 * trigger cleanup */
5030 if (PL_in_clean_all) /* All is fair */
5032 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5033 /* make sure SvREFCNT(sv)==0 happens very seldom */
5034 SvREFCNT(sv) = (~(U32)0)/2;
5037 if (ckWARN_d(WARN_INTERNAL)) {
5038 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5039 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5040 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5041 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5042 Perl_dump_sv_child(aTHX_ sv);
5047 if (--(SvREFCNT(sv)) > 0)
5049 Perl_sv_free2(aTHX_ sv);
5053 Perl_sv_free2(pTHX_ SV *sv)
5058 if (ckWARN_d(WARN_DEBUGGING))
5059 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5060 "Attempt to free temp prematurely: SV 0x%"UVxf
5061 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5065 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5066 /* make sure SvREFCNT(sv)==0 happens very seldom */
5067 SvREFCNT(sv) = (~(U32)0)/2;
5078 Returns the length of the string in the SV. Handles magic and type
5079 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5085 Perl_sv_len(pTHX_ register SV *sv)
5093 len = mg_length(sv);
5095 (void)SvPV_const(sv, len);
5100 =for apidoc sv_len_utf8
5102 Returns the number of characters in the string in an SV, counting wide
5103 UTF-8 bytes as a single character. Handles magic and type coercion.
5109 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5110 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5111 * (Note that the mg_len is not the length of the mg_ptr field.)
5116 Perl_sv_len_utf8(pTHX_ register SV *sv)
5122 return mg_length(sv);
5126 const U8 *s = (U8*)SvPV_const(sv, len);
5127 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5129 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5131 #ifdef PERL_UTF8_CACHE_ASSERT
5132 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5136 ulen = Perl_utf8_length(aTHX_ s, s + len);
5137 if (!mg && !SvREADONLY(sv)) {
5138 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5139 mg = mg_find(sv, PERL_MAGIC_utf8);
5149 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5150 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5151 * between UTF-8 and byte offsets. There are two (substr offset and substr
5152 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5153 * and byte offset) cache positions.
5155 * The mg_len field is used by sv_len_utf8(), see its comments.
5156 * Note that the mg_len is not the length of the mg_ptr field.
5160 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5161 I32 offsetp, const U8 *s, const U8 *start)
5165 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5167 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5171 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5173 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5174 (*mgp)->mg_ptr = (char *) *cachep;
5178 (*cachep)[i] = offsetp;
5179 (*cachep)[i+1] = s - start;
5187 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5188 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5189 * between UTF-8 and byte offsets. See also the comments of
5190 * S_utf8_mg_pos_init().
5194 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)
5198 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5200 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5201 if (*mgp && (*mgp)->mg_ptr) {
5202 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5203 ASSERT_UTF8_CACHE(*cachep);
5204 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5206 else { /* We will skip to the right spot. */
5211 /* The assumption is that going backward is half
5212 * the speed of going forward (that's where the
5213 * 2 * backw in the below comes from). (The real
5214 * figure of course depends on the UTF-8 data.) */
5216 if ((*cachep)[i] > (STRLEN)uoff) {
5218 backw = (*cachep)[i] - (STRLEN)uoff;
5220 if (forw < 2 * backw)
5223 p = start + (*cachep)[i+1];
5225 /* Try this only for the substr offset (i == 0),
5226 * not for the substr length (i == 2). */
5227 else if (i == 0) { /* (*cachep)[i] < uoff */
5228 const STRLEN ulen = sv_len_utf8(sv);
5230 if ((STRLEN)uoff < ulen) {
5231 forw = (STRLEN)uoff - (*cachep)[i];
5232 backw = ulen - (STRLEN)uoff;
5234 if (forw < 2 * backw)
5235 p = start + (*cachep)[i+1];
5240 /* If the string is not long enough for uoff,
5241 * we could extend it, but not at this low a level. */
5245 if (forw < 2 * backw) {
5252 while (UTF8_IS_CONTINUATION(*p))
5257 /* Update the cache. */
5258 (*cachep)[i] = (STRLEN)uoff;
5259 (*cachep)[i+1] = p - start;
5261 /* Drop the stale "length" cache */
5270 if (found) { /* Setup the return values. */
5271 *offsetp = (*cachep)[i+1];
5272 *sp = start + *offsetp;
5275 *offsetp = send - start;
5277 else if (*sp < start) {
5283 #ifdef PERL_UTF8_CACHE_ASSERT
5288 while (n-- && s < send)
5292 assert(*offsetp == s - start);
5293 assert((*cachep)[0] == (STRLEN)uoff);
5294 assert((*cachep)[1] == *offsetp);
5296 ASSERT_UTF8_CACHE(*cachep);
5305 =for apidoc sv_pos_u2b
5307 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5308 the start of the string, to a count of the equivalent number of bytes; if
5309 lenp is non-zero, it does the same to lenp, but this time starting from
5310 the offset, rather than from the start of the string. Handles magic and
5317 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5318 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5319 * byte offsets. See also the comments of S_utf8_mg_pos().
5324 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5332 start = (U8*)SvPV_const(sv, len);
5335 STRLEN *cache = NULL;
5336 const U8 *s = start;
5337 I32 uoffset = *offsetp;
5338 const U8 * const send = s + len;
5340 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5342 if (!found && uoffset > 0) {
5343 while (s < send && uoffset--)
5347 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5349 *offsetp = s - start;
5354 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5358 if (!found && *lenp > 0) {
5361 while (s < send && ulen--)
5365 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5369 ASSERT_UTF8_CACHE(cache);
5381 =for apidoc sv_pos_b2u
5383 Converts the value pointed to by offsetp from a count of bytes from the
5384 start of the string, to a count of the equivalent number of UTF-8 chars.
5385 Handles magic and type coercion.
5391 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5392 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5393 * byte offsets. See also the comments of S_utf8_mg_pos().
5398 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5406 s = (const U8*)SvPV_const(sv, len);
5407 if ((I32)len < *offsetp)
5408 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5410 const U8* send = s + *offsetp;
5412 STRLEN *cache = NULL;
5416 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5417 mg = mg_find(sv, PERL_MAGIC_utf8);
5418 if (mg && mg->mg_ptr) {
5419 cache = (STRLEN *) mg->mg_ptr;
5420 if (cache[1] == (STRLEN)*offsetp) {
5421 /* An exact match. */
5422 *offsetp = cache[0];
5426 else if (cache[1] < (STRLEN)*offsetp) {
5427 /* We already know part of the way. */
5430 /* Let the below loop do the rest. */
5432 else { /* cache[1] > *offsetp */
5433 /* We already know all of the way, now we may
5434 * be able to walk back. The same assumption
5435 * is made as in S_utf8_mg_pos(), namely that
5436 * walking backward is twice slower than
5437 * walking forward. */
5438 const STRLEN forw = *offsetp;
5439 STRLEN backw = cache[1] - *offsetp;
5441 if (!(forw < 2 * backw)) {
5442 const U8 *p = s + cache[1];
5449 while (UTF8_IS_CONTINUATION(*p)) {
5457 *offsetp = cache[0];
5459 /* Drop the stale "length" cache */
5467 ASSERT_UTF8_CACHE(cache);
5473 /* Call utf8n_to_uvchr() to validate the sequence
5474 * (unless a simple non-UTF character) */
5475 if (!UTF8_IS_INVARIANT(*s))
5476 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5485 if (!SvREADONLY(sv)) {
5487 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5488 mg = mg_find(sv, PERL_MAGIC_utf8);
5493 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5494 mg->mg_ptr = (char *) cache;
5499 cache[1] = *offsetp;
5500 /* Drop the stale "length" cache */
5513 Returns a boolean indicating whether the strings in the two SVs are
5514 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5515 coerce its args to strings if necessary.
5521 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5530 SV* svrecode = NULL;
5537 pv1 = SvPV_const(sv1, cur1);
5544 pv2 = SvPV_const(sv2, cur2);
5546 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5547 /* Differing utf8ness.
5548 * Do not UTF8size the comparands as a side-effect. */
5551 svrecode = newSVpvn(pv2, cur2);
5552 sv_recode_to_utf8(svrecode, PL_encoding);
5553 pv2 = SvPV_const(svrecode, cur2);
5556 svrecode = newSVpvn(pv1, cur1);
5557 sv_recode_to_utf8(svrecode, PL_encoding);
5558 pv1 = SvPV_const(svrecode, cur1);
5560 /* Now both are in UTF-8. */
5562 SvREFCNT_dec(svrecode);
5567 bool is_utf8 = TRUE;
5570 /* sv1 is the UTF-8 one,
5571 * if is equal it must be downgrade-able */
5572 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5578 /* sv2 is the UTF-8 one,
5579 * if is equal it must be downgrade-able */
5580 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5586 /* Downgrade not possible - cannot be eq */
5594 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5597 SvREFCNT_dec(svrecode);
5608 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5609 string in C<sv1> is less than, equal to, or greater than the string in
5610 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5611 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5617 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5621 const char *pv1, *pv2;
5624 SV *svrecode = NULL;
5631 pv1 = SvPV_const(sv1, cur1);
5638 pv2 = SvPV_const(sv2, cur2);
5640 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5641 /* Differing utf8ness.
5642 * Do not UTF8size the comparands as a side-effect. */
5645 svrecode = newSVpvn(pv2, cur2);
5646 sv_recode_to_utf8(svrecode, PL_encoding);
5647 pv2 = SvPV_const(svrecode, cur2);
5650 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5655 svrecode = newSVpvn(pv1, cur1);
5656 sv_recode_to_utf8(svrecode, PL_encoding);
5657 pv1 = SvPV_const(svrecode, cur1);
5660 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5666 cmp = cur2 ? -1 : 0;
5670 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5673 cmp = retval < 0 ? -1 : 1;
5674 } else if (cur1 == cur2) {
5677 cmp = cur1 < cur2 ? -1 : 1;
5682 SvREFCNT_dec(svrecode);
5691 =for apidoc sv_cmp_locale
5693 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5694 'use bytes' aware, handles get magic, and will coerce its args to strings
5695 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5701 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5704 #ifdef USE_LOCALE_COLLATE
5710 if (PL_collation_standard)
5714 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5716 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5718 if (!pv1 || !len1) {
5729 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5732 return retval < 0 ? -1 : 1;
5735 * When the result of collation is equality, that doesn't mean
5736 * that there are no differences -- some locales exclude some
5737 * characters from consideration. So to avoid false equalities,
5738 * we use the raw string as a tiebreaker.
5744 #endif /* USE_LOCALE_COLLATE */
5746 return sv_cmp(sv1, sv2);
5750 #ifdef USE_LOCALE_COLLATE
5753 =for apidoc sv_collxfrm
5755 Add Collate Transform magic to an SV if it doesn't already have it.
5757 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5758 scalar data of the variable, but transformed to such a format that a normal
5759 memory comparison can be used to compare the data according to the locale
5766 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5771 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5772 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5778 Safefree(mg->mg_ptr);
5779 s = SvPV_const(sv, len);
5780 if ((xf = mem_collxfrm(s, len, &xlen))) {
5781 if (SvREADONLY(sv)) {
5784 return xf + sizeof(PL_collation_ix);
5787 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5788 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5801 if (mg && mg->mg_ptr) {
5803 return mg->mg_ptr + sizeof(PL_collation_ix);
5811 #endif /* USE_LOCALE_COLLATE */
5816 Get a line from the filehandle and store it into the SV, optionally
5817 appending to the currently-stored string.
5823 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5828 register STDCHAR rslast;
5829 register STDCHAR *bp;
5835 if (SvTHINKFIRST(sv))
5836 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5837 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5839 However, perlbench says it's slower, because the existing swipe code
5840 is faster than copy on write.
5841 Swings and roundabouts. */
5842 SvUPGRADE(sv, SVt_PV);
5847 if (PerlIO_isutf8(fp)) {
5849 sv_utf8_upgrade_nomg(sv);
5850 sv_pos_u2b(sv,&append,0);
5852 } else if (SvUTF8(sv)) {
5853 SV * const tsv = newSV(0);
5854 sv_gets(tsv, fp, 0);
5855 sv_utf8_upgrade_nomg(tsv);
5856 SvCUR_set(sv,append);
5859 goto return_string_or_null;
5864 if (PerlIO_isutf8(fp))
5867 if (IN_PERL_COMPILETIME) {
5868 /* we always read code in line mode */
5872 else if (RsSNARF(PL_rs)) {
5873 /* If it is a regular disk file use size from stat() as estimate
5874 of amount we are going to read - may result in malloc-ing
5875 more memory than we realy need if layers bellow reduce
5876 size we read (e.g. CRLF or a gzip layer)
5879 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5880 const Off_t offset = PerlIO_tell(fp);
5881 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5882 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5888 else if (RsRECORD(PL_rs)) {
5892 /* Grab the size of the record we're getting */
5893 recsize = SvIV(SvRV(PL_rs));
5894 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5897 /* VMS wants read instead of fread, because fread doesn't respect */
5898 /* RMS record boundaries. This is not necessarily a good thing to be */
5899 /* doing, but we've got no other real choice - except avoid stdio
5900 as implementation - perhaps write a :vms layer ?
5902 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5904 bytesread = PerlIO_read(fp, buffer, recsize);
5908 SvCUR_set(sv, bytesread += append);
5909 buffer[bytesread] = '\0';
5910 goto return_string_or_null;
5912 else if (RsPARA(PL_rs)) {
5918 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5919 if (PerlIO_isutf8(fp)) {
5920 rsptr = SvPVutf8(PL_rs, rslen);
5923 if (SvUTF8(PL_rs)) {
5924 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5925 Perl_croak(aTHX_ "Wide character in $/");
5928 rsptr = SvPV_const(PL_rs, rslen);
5932 rslast = rslen ? rsptr[rslen - 1] : '\0';
5934 if (rspara) { /* have to do this both before and after */
5935 do { /* to make sure file boundaries work right */
5938 i = PerlIO_getc(fp);
5942 PerlIO_ungetc(fp,i);
5948 /* See if we know enough about I/O mechanism to cheat it ! */
5950 /* This used to be #ifdef test - it is made run-time test for ease
5951 of abstracting out stdio interface. One call should be cheap
5952 enough here - and may even be a macro allowing compile
5956 if (PerlIO_fast_gets(fp)) {
5959 * We're going to steal some values from the stdio struct
5960 * and put EVERYTHING in the innermost loop into registers.
5962 register STDCHAR *ptr;
5966 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5967 /* An ungetc()d char is handled separately from the regular
5968 * buffer, so we getc() it back out and stuff it in the buffer.
5970 i = PerlIO_getc(fp);
5971 if (i == EOF) return 0;
5972 *(--((*fp)->_ptr)) = (unsigned char) i;
5976 /* Here is some breathtakingly efficient cheating */
5978 cnt = PerlIO_get_cnt(fp); /* get count into register */
5979 /* make sure we have the room */
5980 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5981 /* Not room for all of it
5982 if we are looking for a separator and room for some
5984 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5985 /* just process what we have room for */
5986 shortbuffered = cnt - SvLEN(sv) + append + 1;
5987 cnt -= shortbuffered;
5991 /* remember that cnt can be negative */
5992 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
5997 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
5998 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
5999 DEBUG_P(PerlIO_printf(Perl_debug_log,
6000 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6001 DEBUG_P(PerlIO_printf(Perl_debug_log,
6002 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6003 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6004 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6009 while (cnt > 0) { /* this | eat */
6011 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6012 goto thats_all_folks; /* screams | sed :-) */
6016 Copy(ptr, bp, cnt, char); /* this | eat */
6017 bp += cnt; /* screams | dust */
6018 ptr += cnt; /* louder | sed :-) */
6023 if (shortbuffered) { /* oh well, must extend */
6024 cnt = shortbuffered;
6026 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6028 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6029 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6033 DEBUG_P(PerlIO_printf(Perl_debug_log,
6034 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6035 PTR2UV(ptr),(long)cnt));
6036 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6038 DEBUG_P(PerlIO_printf(Perl_debug_log,
6039 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6040 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6041 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6043 /* This used to call 'filbuf' in stdio form, but as that behaves like
6044 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6045 another abstraction. */
6046 i = PerlIO_getc(fp); /* get more characters */
6048 DEBUG_P(PerlIO_printf(Perl_debug_log,
6049 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6050 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6051 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6053 cnt = PerlIO_get_cnt(fp);
6054 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6055 DEBUG_P(PerlIO_printf(Perl_debug_log,
6056 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6058 if (i == EOF) /* all done for ever? */
6059 goto thats_really_all_folks;
6061 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6063 SvGROW(sv, bpx + cnt + 2);
6064 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6066 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6068 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6069 goto thats_all_folks;
6073 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6074 memNE((char*)bp - rslen, rsptr, rslen))
6075 goto screamer; /* go back to the fray */
6076 thats_really_all_folks:
6078 cnt += shortbuffered;
6079 DEBUG_P(PerlIO_printf(Perl_debug_log,
6080 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6081 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6082 DEBUG_P(PerlIO_printf(Perl_debug_log,
6083 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6084 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6085 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6087 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6088 DEBUG_P(PerlIO_printf(Perl_debug_log,
6089 "Screamer: done, len=%ld, string=|%.*s|\n",
6090 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6094 /*The big, slow, and stupid way. */
6095 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6096 STDCHAR *buf = NULL;
6097 Newx(buf, 8192, STDCHAR);
6105 register const STDCHAR * const bpe = buf + sizeof(buf);
6107 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6108 ; /* keep reading */
6112 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6113 /* Accomodate broken VAXC compiler, which applies U8 cast to
6114 * both args of ?: operator, causing EOF to change into 255
6117 i = (U8)buf[cnt - 1];
6123 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6125 sv_catpvn(sv, (char *) buf, cnt);
6127 sv_setpvn(sv, (char *) buf, cnt);
6129 if (i != EOF && /* joy */
6131 SvCUR(sv) < rslen ||
6132 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6136 * If we're reading from a TTY and we get a short read,
6137 * indicating that the user hit his EOF character, we need
6138 * to notice it now, because if we try to read from the TTY
6139 * again, the EOF condition will disappear.
6141 * The comparison of cnt to sizeof(buf) is an optimization
6142 * that prevents unnecessary calls to feof().
6146 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6150 #ifdef USE_HEAP_INSTEAD_OF_STACK
6155 if (rspara) { /* have to do this both before and after */
6156 while (i != EOF) { /* to make sure file boundaries work right */
6157 i = PerlIO_getc(fp);
6159 PerlIO_ungetc(fp,i);
6165 return_string_or_null:
6166 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6172 Auto-increment of the value in the SV, doing string to numeric conversion
6173 if necessary. Handles 'get' magic.
6179 Perl_sv_inc(pTHX_ register SV *sv)
6188 if (SvTHINKFIRST(sv)) {
6190 sv_force_normal_flags(sv, 0);
6191 if (SvREADONLY(sv)) {
6192 if (IN_PERL_RUNTIME)
6193 Perl_croak(aTHX_ PL_no_modify);
6197 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6199 i = PTR2IV(SvRV(sv));
6204 flags = SvFLAGS(sv);
6205 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6206 /* It's (privately or publicly) a float, but not tested as an
6207 integer, so test it to see. */
6209 flags = SvFLAGS(sv);
6211 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6212 /* It's publicly an integer, or privately an integer-not-float */
6213 #ifdef PERL_PRESERVE_IVUV
6217 if (SvUVX(sv) == UV_MAX)
6218 sv_setnv(sv, UV_MAX_P1);
6220 (void)SvIOK_only_UV(sv);
6221 SvUV_set(sv, SvUVX(sv) + 1);
6223 if (SvIVX(sv) == IV_MAX)
6224 sv_setuv(sv, (UV)IV_MAX + 1);
6226 (void)SvIOK_only(sv);
6227 SvIV_set(sv, SvIVX(sv) + 1);
6232 if (flags & SVp_NOK) {
6233 (void)SvNOK_only(sv);
6234 SvNV_set(sv, SvNVX(sv) + 1.0);
6238 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6239 if ((flags & SVTYPEMASK) < SVt_PVIV)
6240 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6241 (void)SvIOK_only(sv);
6246 while (isALPHA(*d)) d++;
6247 while (isDIGIT(*d)) d++;
6249 #ifdef PERL_PRESERVE_IVUV
6250 /* Got to punt this as an integer if needs be, but we don't issue
6251 warnings. Probably ought to make the sv_iv_please() that does
6252 the conversion if possible, and silently. */
6253 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6254 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6255 /* Need to try really hard to see if it's an integer.
6256 9.22337203685478e+18 is an integer.
6257 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6258 so $a="9.22337203685478e+18"; $a+0; $a++
6259 needs to be the same as $a="9.22337203685478e+18"; $a++
6266 /* sv_2iv *should* have made this an NV */
6267 if (flags & SVp_NOK) {
6268 (void)SvNOK_only(sv);
6269 SvNV_set(sv, SvNVX(sv) + 1.0);
6272 /* I don't think we can get here. Maybe I should assert this
6273 And if we do get here I suspect that sv_setnv will croak. NWC
6275 #if defined(USE_LONG_DOUBLE)
6276 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",
6277 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6279 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6280 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6283 #endif /* PERL_PRESERVE_IVUV */
6284 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6288 while (d >= SvPVX_const(sv)) {
6296 /* MKS: The original code here died if letters weren't consecutive.
6297 * at least it didn't have to worry about non-C locales. The
6298 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6299 * arranged in order (although not consecutively) and that only
6300 * [A-Za-z] are accepted by isALPHA in the C locale.
6302 if (*d != 'z' && *d != 'Z') {
6303 do { ++*d; } while (!isALPHA(*d));
6306 *(d--) -= 'z' - 'a';
6311 *(d--) -= 'z' - 'a' + 1;
6315 /* oh,oh, the number grew */
6316 SvGROW(sv, SvCUR(sv) + 2);
6317 SvCUR_set(sv, SvCUR(sv) + 1);
6318 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6329 Auto-decrement of the value in the SV, doing string to numeric conversion
6330 if necessary. Handles 'get' magic.
6336 Perl_sv_dec(pTHX_ register SV *sv)
6344 if (SvTHINKFIRST(sv)) {
6346 sv_force_normal_flags(sv, 0);
6347 if (SvREADONLY(sv)) {
6348 if (IN_PERL_RUNTIME)
6349 Perl_croak(aTHX_ PL_no_modify);
6353 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6355 i = PTR2IV(SvRV(sv));
6360 /* Unlike sv_inc we don't have to worry about string-never-numbers
6361 and keeping them magic. But we mustn't warn on punting */
6362 flags = SvFLAGS(sv);
6363 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6364 /* It's publicly an integer, or privately an integer-not-float */
6365 #ifdef PERL_PRESERVE_IVUV
6369 if (SvUVX(sv) == 0) {
6370 (void)SvIOK_only(sv);
6374 (void)SvIOK_only_UV(sv);
6375 SvUV_set(sv, SvUVX(sv) - 1);
6378 if (SvIVX(sv) == IV_MIN)
6379 sv_setnv(sv, (NV)IV_MIN - 1.0);
6381 (void)SvIOK_only(sv);
6382 SvIV_set(sv, SvIVX(sv) - 1);
6387 if (flags & SVp_NOK) {
6388 SvNV_set(sv, SvNVX(sv) - 1.0);
6389 (void)SvNOK_only(sv);
6392 if (!(flags & SVp_POK)) {
6393 if ((flags & SVTYPEMASK) < SVt_PVIV)
6394 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6396 (void)SvIOK_only(sv);
6399 #ifdef PERL_PRESERVE_IVUV
6401 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6402 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6403 /* Need to try really hard to see if it's an integer.
6404 9.22337203685478e+18 is an integer.
6405 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6406 so $a="9.22337203685478e+18"; $a+0; $a--
6407 needs to be the same as $a="9.22337203685478e+18"; $a--
6414 /* sv_2iv *should* have made this an NV */
6415 if (flags & SVp_NOK) {
6416 (void)SvNOK_only(sv);
6417 SvNV_set(sv, SvNVX(sv) - 1.0);
6420 /* I don't think we can get here. Maybe I should assert this
6421 And if we do get here I suspect that sv_setnv will croak. NWC
6423 #if defined(USE_LONG_DOUBLE)
6424 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",
6425 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6427 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6428 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6432 #endif /* PERL_PRESERVE_IVUV */
6433 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6437 =for apidoc sv_mortalcopy
6439 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6440 The new SV is marked as mortal. It will be destroyed "soon", either by an
6441 explicit call to FREETMPS, or by an implicit call at places such as
6442 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6447 /* Make a string that will exist for the duration of the expression
6448 * evaluation. Actually, it may have to last longer than that, but
6449 * hopefully we won't free it until it has been assigned to a
6450 * permanent location. */
6453 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6459 sv_setsv(sv,oldstr);
6461 PL_tmps_stack[++PL_tmps_ix] = sv;
6467 =for apidoc sv_newmortal
6469 Creates a new null SV which is mortal. The reference count of the SV is
6470 set to 1. It will be destroyed "soon", either by an explicit call to
6471 FREETMPS, or by an implicit call at places such as statement boundaries.
6472 See also C<sv_mortalcopy> and C<sv_2mortal>.
6478 Perl_sv_newmortal(pTHX)
6484 SvFLAGS(sv) = SVs_TEMP;
6486 PL_tmps_stack[++PL_tmps_ix] = sv;
6491 =for apidoc sv_2mortal
6493 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6494 by an explicit call to FREETMPS, or by an implicit call at places such as
6495 statement boundaries. SvTEMP() is turned on which means that the SV's
6496 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6497 and C<sv_mortalcopy>.
6503 Perl_sv_2mortal(pTHX_ register SV *sv)
6508 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6511 PL_tmps_stack[++PL_tmps_ix] = sv;
6519 Creates a new SV and copies a string into it. The reference count for the
6520 SV is set to 1. If C<len> is zero, Perl will compute the length using
6521 strlen(). For efficiency, consider using C<newSVpvn> instead.
6527 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6533 sv_setpvn(sv,s,len ? len : strlen(s));
6538 =for apidoc newSVpvn
6540 Creates a new SV and copies a string into it. The reference count for the
6541 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6542 string. You are responsible for ensuring that the source string is at least
6543 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6549 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6555 sv_setpvn(sv,s,len);
6561 =for apidoc newSVhek
6563 Creates a new SV from the hash key structure. It will generate scalars that
6564 point to the shared string table where possible. Returns a new (undefined)
6565 SV if the hek is NULL.
6571 Perl_newSVhek(pTHX_ const HEK *hek)
6581 if (HEK_LEN(hek) == HEf_SVKEY) {
6582 return newSVsv(*(SV**)HEK_KEY(hek));
6584 const int flags = HEK_FLAGS(hek);
6585 if (flags & HVhek_WASUTF8) {
6587 Andreas would like keys he put in as utf8 to come back as utf8
6589 STRLEN utf8_len = HEK_LEN(hek);
6590 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6591 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6594 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6596 } else if (flags & HVhek_REHASH) {
6597 /* We don't have a pointer to the hv, so we have to replicate the
6598 flag into every HEK. This hv is using custom a hasing
6599 algorithm. Hence we can't return a shared string scalar, as
6600 that would contain the (wrong) hash value, and might get passed
6601 into an hv routine with a regular hash */
6603 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6608 /* This will be overwhelminly the most common case. */
6609 return newSVpvn_share(HEK_KEY(hek),
6610 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6616 =for apidoc newSVpvn_share
6618 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6619 table. If the string does not already exist in the table, it is created
6620 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6621 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6622 otherwise the hash is computed. The idea here is that as the string table
6623 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6624 hash lookup will avoid string compare.
6630 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6634 bool is_utf8 = FALSE;
6636 STRLEN tmplen = -len;
6638 /* See the note in hv.c:hv_fetch() --jhi */
6639 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6643 PERL_HASH(hash, src, len);
6645 sv_upgrade(sv, SVt_PV);
6646 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6658 #if defined(PERL_IMPLICIT_CONTEXT)
6660 /* pTHX_ magic can't cope with varargs, so this is a no-context
6661 * version of the main function, (which may itself be aliased to us).
6662 * Don't access this version directly.
6666 Perl_newSVpvf_nocontext(const char* pat, ...)
6671 va_start(args, pat);
6672 sv = vnewSVpvf(pat, &args);
6679 =for apidoc newSVpvf
6681 Creates a new SV and initializes it with the string formatted like
6688 Perl_newSVpvf(pTHX_ const char* pat, ...)
6692 va_start(args, pat);
6693 sv = vnewSVpvf(pat, &args);
6698 /* backend for newSVpvf() and newSVpvf_nocontext() */
6701 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6706 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6713 Creates a new SV and copies a floating point value into it.
6714 The reference count for the SV is set to 1.
6720 Perl_newSVnv(pTHX_ NV n)
6733 Creates a new SV and copies an integer into it. The reference count for the
6740 Perl_newSViv(pTHX_ IV i)
6753 Creates a new SV and copies an unsigned integer into it.
6754 The reference count for the SV is set to 1.
6760 Perl_newSVuv(pTHX_ UV u)
6771 =for apidoc newRV_noinc
6773 Creates an RV wrapper for an SV. The reference count for the original
6774 SV is B<not> incremented.
6780 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6786 sv_upgrade(sv, SVt_RV);
6788 SvRV_set(sv, tmpRef);
6793 /* newRV_inc is the official function name to use now.
6794 * newRV_inc is in fact #defined to newRV in sv.h
6798 Perl_newRV(pTHX_ SV *tmpRef)
6801 return newRV_noinc(SvREFCNT_inc(tmpRef));
6807 Creates a new SV which is an exact duplicate of the original SV.
6814 Perl_newSVsv(pTHX_ register SV *old)
6821 if (SvTYPE(old) == SVTYPEMASK) {
6822 if (ckWARN_d(WARN_INTERNAL))
6823 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6827 /* SV_GMAGIC is the default for sv_setv()
6828 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6829 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6830 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6835 =for apidoc sv_reset
6837 Underlying implementation for the C<reset> Perl function.
6838 Note that the perl-level function is vaguely deprecated.
6844 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6847 char todo[PERL_UCHAR_MAX+1];
6852 if (!*s) { /* reset ?? searches */
6853 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6855 PMOP *pm = (PMOP *) mg->mg_obj;
6857 pm->op_pmdynflags &= ~PMdf_USED;
6864 /* reset variables */
6866 if (!HvARRAY(stash))
6869 Zero(todo, 256, char);
6872 I32 i = (unsigned char)*s;
6876 max = (unsigned char)*s++;
6877 for ( ; i <= max; i++) {
6880 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6882 for (entry = HvARRAY(stash)[i];
6884 entry = HeNEXT(entry))
6889 if (!todo[(U8)*HeKEY(entry)])
6891 gv = (GV*)HeVAL(entry);
6894 if (SvTHINKFIRST(sv)) {
6895 if (!SvREADONLY(sv) && SvROK(sv))
6897 /* XXX Is this continue a bug? Why should THINKFIRST
6898 exempt us from resetting arrays and hashes? */
6902 if (SvTYPE(sv) >= SVt_PV) {
6904 if (SvPVX_const(sv) != NULL)
6912 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6914 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6917 # if defined(USE_ENVIRON_ARRAY)
6920 # endif /* USE_ENVIRON_ARRAY */
6931 Using various gambits, try to get an IO from an SV: the IO slot if its a
6932 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6933 named after the PV if we're a string.
6939 Perl_sv_2io(pTHX_ SV *sv)
6944 switch (SvTYPE(sv)) {
6952 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6956 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6958 return sv_2io(SvRV(sv));
6959 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6965 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6974 Using various gambits, try to get a CV from an SV; in addition, try if
6975 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6976 The flags in C<lref> are passed to sv_fetchsv.
6982 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6989 return *st = NULL, *gvp = NULL, NULL;
6990 switch (SvTYPE(sv)) {
7009 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7010 tryAMAGICunDEREF(to_cv);
7013 if (SvTYPE(sv) == SVt_PVCV) {
7022 Perl_croak(aTHX_ "Not a subroutine reference");
7027 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7033 /* Some flags to gv_fetchsv mean don't really create the GV */
7034 if (SvTYPE(gv) != SVt_PVGV) {
7040 if (lref && !GvCVu(gv)) {
7044 gv_efullname3(tmpsv, gv, NULL);
7045 /* XXX this is probably not what they think they're getting.
7046 * It has the same effect as "sub name;", i.e. just a forward
7048 newSUB(start_subparse(FALSE, 0),
7049 newSVOP(OP_CONST, 0, tmpsv),
7054 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7064 Returns true if the SV has a true value by Perl's rules.
7065 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7066 instead use an in-line version.
7072 Perl_sv_true(pTHX_ register SV *sv)
7077 register const XPV* const tXpv = (XPV*)SvANY(sv);
7079 (tXpv->xpv_cur > 1 ||
7080 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7087 return SvIVX(sv) != 0;
7090 return SvNVX(sv) != 0.0;
7092 return sv_2bool(sv);
7098 =for apidoc sv_pvn_force
7100 Get a sensible string out of the SV somehow.
7101 A private implementation of the C<SvPV_force> macro for compilers which
7102 can't cope with complex macro expressions. Always use the macro instead.
7104 =for apidoc sv_pvn_force_flags
7106 Get a sensible string out of the SV somehow.
7107 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7108 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7109 implemented in terms of this function.
7110 You normally want to use the various wrapper macros instead: see
7111 C<SvPV_force> and C<SvPV_force_nomg>
7117 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7120 if (SvTHINKFIRST(sv) && !SvROK(sv))
7121 sv_force_normal_flags(sv, 0);
7131 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7132 const char * const ref = sv_reftype(sv,0);
7134 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7135 ref, OP_NAME(PL_op));
7137 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7139 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7140 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7142 s = sv_2pv_flags(sv, &len, flags);
7146 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7149 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7150 SvGROW(sv, len + 1);
7151 Move(s,SvPVX(sv),len,char);
7156 SvPOK_on(sv); /* validate pointer */
7158 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7159 PTR2UV(sv),SvPVX_const(sv)));
7162 return SvPVX_mutable(sv);
7166 =for apidoc sv_pvbyten_force
7168 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7174 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7176 sv_pvn_force(sv,lp);
7177 sv_utf8_downgrade(sv,0);
7183 =for apidoc sv_pvutf8n_force
7185 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7191 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7193 sv_pvn_force(sv,lp);
7194 sv_utf8_upgrade(sv);
7200 =for apidoc sv_reftype
7202 Returns a string describing what the SV is a reference to.
7208 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7210 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7211 inside return suggests a const propagation bug in g++. */
7212 if (ob && SvOBJECT(sv)) {
7213 char * const name = HvNAME_get(SvSTASH(sv));
7214 return name ? name : (char *) "__ANON__";
7217 switch (SvTYPE(sv)) {
7234 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7235 /* tied lvalues should appear to be
7236 * scalars for backwards compatitbility */
7237 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7238 ? "SCALAR" : "LVALUE");
7239 case SVt_PVAV: return "ARRAY";
7240 case SVt_PVHV: return "HASH";
7241 case SVt_PVCV: return "CODE";
7242 case SVt_PVGV: return "GLOB";
7243 case SVt_PVFM: return "FORMAT";
7244 case SVt_PVIO: return "IO";
7245 default: return "UNKNOWN";
7251 =for apidoc sv_isobject
7253 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7254 object. If the SV is not an RV, or if the object is not blessed, then this
7261 Perl_sv_isobject(pTHX_ SV *sv)
7277 Returns a boolean indicating whether the SV is blessed into the specified
7278 class. This does not check for subtypes; use C<sv_derived_from> to verify
7279 an inheritance relationship.
7285 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7296 hvname = HvNAME_get(SvSTASH(sv));
7300 return strEQ(hvname, name);
7306 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7307 it will be upgraded to one. If C<classname> is non-null then the new SV will
7308 be blessed in the specified package. The new SV is returned and its
7309 reference count is 1.
7315 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7322 SV_CHECK_THINKFIRST_COW_DROP(rv);
7325 if (SvTYPE(rv) >= SVt_PVMG) {
7326 const U32 refcnt = SvREFCNT(rv);
7330 SvREFCNT(rv) = refcnt;
7333 if (SvTYPE(rv) < SVt_RV)
7334 sv_upgrade(rv, SVt_RV);
7335 else if (SvTYPE(rv) > SVt_RV) {
7346 HV* const stash = gv_stashpv(classname, TRUE);
7347 (void)sv_bless(rv, stash);
7353 =for apidoc sv_setref_pv
7355 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7356 argument will be upgraded to an RV. That RV will be modified to point to
7357 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7358 into the SV. The C<classname> argument indicates the package for the
7359 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7360 will have a reference count of 1, and the RV will be returned.
7362 Do not use with other Perl types such as HV, AV, SV, CV, because those
7363 objects will become corrupted by the pointer copy process.
7365 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7371 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7375 sv_setsv(rv, &PL_sv_undef);
7379 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7384 =for apidoc sv_setref_iv
7386 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7387 argument will be upgraded to an RV. That RV will be modified to point to
7388 the new SV. The C<classname> argument indicates the package for the
7389 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7390 will have a reference count of 1, and the RV will be returned.
7396 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7398 sv_setiv(newSVrv(rv,classname), iv);
7403 =for apidoc sv_setref_uv
7405 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7406 argument will be upgraded to an RV. That RV will be modified to point to
7407 the new SV. The C<classname> argument indicates the package for the
7408 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7409 will have a reference count of 1, and the RV will be returned.
7415 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7417 sv_setuv(newSVrv(rv,classname), uv);
7422 =for apidoc sv_setref_nv
7424 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7425 argument will be upgraded to an RV. That RV will be modified to point to
7426 the new SV. The C<classname> argument indicates the package for the
7427 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7428 will have a reference count of 1, and the RV will be returned.
7434 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7436 sv_setnv(newSVrv(rv,classname), nv);
7441 =for apidoc sv_setref_pvn
7443 Copies a string into a new SV, optionally blessing the SV. The length of the
7444 string must be specified with C<n>. The C<rv> argument will be upgraded to
7445 an RV. That RV will be modified to point to the new SV. The C<classname>
7446 argument indicates the package for the blessing. Set C<classname> to
7447 C<NULL> to avoid the blessing. The new SV will have a reference count
7448 of 1, and the RV will be returned.
7450 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7456 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7458 sv_setpvn(newSVrv(rv,classname), pv, n);
7463 =for apidoc sv_bless
7465 Blesses an SV into a specified package. The SV must be an RV. The package
7466 must be designated by its stash (see C<gv_stashpv()>). The reference count
7467 of the SV is unaffected.
7473 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7478 Perl_croak(aTHX_ "Can't bless non-reference value");
7480 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7481 if (SvREADONLY(tmpRef))
7482 Perl_croak(aTHX_ PL_no_modify);
7483 if (SvOBJECT(tmpRef)) {
7484 if (SvTYPE(tmpRef) != SVt_PVIO)
7486 SvREFCNT_dec(SvSTASH(tmpRef));
7489 SvOBJECT_on(tmpRef);
7490 if (SvTYPE(tmpRef) != SVt_PVIO)
7492 SvUPGRADE(tmpRef, SVt_PVMG);
7493 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7500 if(SvSMAGICAL(tmpRef))
7501 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7509 /* Downgrades a PVGV to a PVMG.
7513 S_sv_unglob(pTHX_ SV *sv)
7518 assert(SvTYPE(sv) == SVt_PVGV);
7523 sv_del_backref((SV*)GvSTASH(sv), sv);
7526 sv_unmagic(sv, PERL_MAGIC_glob);
7527 Safefree(GvNAME(sv));
7530 /* need to keep SvANY(sv) in the right arena */
7531 xpvmg = new_XPVMG();
7532 StructCopy(SvANY(sv), xpvmg, XPVMG);
7533 del_XPVGV(SvANY(sv));
7536 SvFLAGS(sv) &= ~SVTYPEMASK;
7537 SvFLAGS(sv) |= SVt_PVMG;
7541 =for apidoc sv_unref_flags
7543 Unsets the RV status of the SV, and decrements the reference count of
7544 whatever was being referenced by the RV. This can almost be thought of
7545 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7546 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7547 (otherwise the decrementing is conditional on the reference count being
7548 different from one or the reference being a readonly SV).
7555 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7557 SV* const target = SvRV(ref);
7559 if (SvWEAKREF(ref)) {
7560 sv_del_backref(target, ref);
7562 SvRV_set(ref, NULL);
7565 SvRV_set(ref, NULL);
7567 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7568 assigned to as BEGIN {$a = \"Foo"} will fail. */
7569 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7570 SvREFCNT_dec(target);
7571 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7572 sv_2mortal(target); /* Schedule for freeing later */
7576 =for apidoc sv_untaint
7578 Untaint an SV. Use C<SvTAINTED_off> instead.
7583 Perl_sv_untaint(pTHX_ SV *sv)
7585 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7586 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7593 =for apidoc sv_tainted
7595 Test an SV for taintedness. Use C<SvTAINTED> instead.
7600 Perl_sv_tainted(pTHX_ SV *sv)
7602 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7603 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7604 if (mg && (mg->mg_len & 1) )
7611 =for apidoc sv_setpviv
7613 Copies an integer into the given SV, also updating its string value.
7614 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7620 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7622 char buf[TYPE_CHARS(UV)];
7624 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7626 sv_setpvn(sv, ptr, ebuf - ptr);
7630 =for apidoc sv_setpviv_mg
7632 Like C<sv_setpviv>, but also handles 'set' magic.
7638 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7644 #if defined(PERL_IMPLICIT_CONTEXT)
7646 /* pTHX_ magic can't cope with varargs, so this is a no-context
7647 * version of the main function, (which may itself be aliased to us).
7648 * Don't access this version directly.
7652 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7656 va_start(args, pat);
7657 sv_vsetpvf(sv, pat, &args);
7661 /* pTHX_ magic can't cope with varargs, so this is a no-context
7662 * version of the main function, (which may itself be aliased to us).
7663 * Don't access this version directly.
7667 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7671 va_start(args, pat);
7672 sv_vsetpvf_mg(sv, pat, &args);
7678 =for apidoc sv_setpvf
7680 Works like C<sv_catpvf> but copies the text into the SV instead of
7681 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7687 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7690 va_start(args, pat);
7691 sv_vsetpvf(sv, pat, &args);
7696 =for apidoc sv_vsetpvf
7698 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7699 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7701 Usually used via its frontend C<sv_setpvf>.
7707 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7709 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7713 =for apidoc sv_setpvf_mg
7715 Like C<sv_setpvf>, but also handles 'set' magic.
7721 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7724 va_start(args, pat);
7725 sv_vsetpvf_mg(sv, pat, &args);
7730 =for apidoc sv_vsetpvf_mg
7732 Like C<sv_vsetpvf>, but also handles 'set' magic.
7734 Usually used via its frontend C<sv_setpvf_mg>.
7740 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7742 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7746 #if defined(PERL_IMPLICIT_CONTEXT)
7748 /* pTHX_ magic can't cope with varargs, so this is a no-context
7749 * version of the main function, (which may itself be aliased to us).
7750 * Don't access this version directly.
7754 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7758 va_start(args, pat);
7759 sv_vcatpvf(sv, pat, &args);
7763 /* pTHX_ magic can't cope with varargs, so this is a no-context
7764 * version of the main function, (which may itself be aliased to us).
7765 * Don't access this version directly.
7769 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7773 va_start(args, pat);
7774 sv_vcatpvf_mg(sv, pat, &args);
7780 =for apidoc sv_catpvf
7782 Processes its arguments like C<sprintf> and appends the formatted
7783 output to an SV. If the appended data contains "wide" characters
7784 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7785 and characters >255 formatted with %c), the original SV might get
7786 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7787 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7788 valid UTF-8; if the original SV was bytes, the pattern should be too.
7793 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7796 va_start(args, pat);
7797 sv_vcatpvf(sv, pat, &args);
7802 =for apidoc sv_vcatpvf
7804 Processes its arguments like C<vsprintf> and appends the formatted output
7805 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7807 Usually used via its frontend C<sv_catpvf>.
7813 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7815 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7819 =for apidoc sv_catpvf_mg
7821 Like C<sv_catpvf>, but also handles 'set' magic.
7827 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7830 va_start(args, pat);
7831 sv_vcatpvf_mg(sv, pat, &args);
7836 =for apidoc sv_vcatpvf_mg
7838 Like C<sv_vcatpvf>, but also handles 'set' magic.
7840 Usually used via its frontend C<sv_catpvf_mg>.
7846 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7848 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7853 =for apidoc sv_vsetpvfn
7855 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7858 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7864 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7866 sv_setpvn(sv, "", 0);
7867 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7871 S_expect_number(pTHX_ char** pattern)
7875 switch (**pattern) {
7876 case '1': case '2': case '3':
7877 case '4': case '5': case '6':
7878 case '7': case '8': case '9':
7879 var = *(*pattern)++ - '0';
7880 while (isDIGIT(**pattern)) {
7881 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7883 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7891 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7893 const int neg = nv < 0;
7902 if (uv & 1 && uv == nv)
7903 uv--; /* Round to even */
7905 const unsigned dig = uv % 10;
7918 =for apidoc sv_vcatpvfn
7920 Processes its arguments like C<vsprintf> and appends the formatted output
7921 to an SV. Uses an array of SVs if the C style variable argument list is
7922 missing (NULL). When running with taint checks enabled, indicates via
7923 C<maybe_tainted> if results are untrustworthy (often due to the use of
7926 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7932 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7933 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7934 vec_utf8 = DO_UTF8(vecsv);
7936 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7939 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7947 static const char nullstr[] = "(null)";
7949 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7950 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7952 /* Times 4: a decimal digit takes more than 3 binary digits.
7953 * NV_DIG: mantissa takes than many decimal digits.
7954 * Plus 32: Playing safe. */
7955 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7956 /* large enough for "%#.#f" --chip */
7957 /* what about long double NVs? --jhi */
7959 PERL_UNUSED_ARG(maybe_tainted);
7961 /* no matter what, this is a string now */
7962 (void)SvPV_force(sv, origlen);
7964 /* special-case "", "%s", and "%-p" (SVf - see below) */
7967 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7969 const char * const s = va_arg(*args, char*);
7970 sv_catpv(sv, s ? s : nullstr);
7972 else if (svix < svmax) {
7973 sv_catsv(sv, *svargs);
7977 if (args && patlen == 3 && pat[0] == '%' &&
7978 pat[1] == '-' && pat[2] == 'p') {
7979 argsv = va_arg(*args, SV*);
7980 sv_catsv(sv, argsv);
7984 #ifndef USE_LONG_DOUBLE
7985 /* special-case "%.<number>[gf]" */
7986 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7987 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7988 unsigned digits = 0;
7992 while (*pp >= '0' && *pp <= '9')
7993 digits = 10 * digits + (*pp++ - '0');
7994 if (pp - pat == (int)patlen - 1) {
8002 /* Add check for digits != 0 because it seems that some
8003 gconverts are buggy in this case, and we don't yet have
8004 a Configure test for this. */
8005 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8006 /* 0, point, slack */
8007 Gconvert(nv, (int)digits, 0, ebuf);
8009 if (*ebuf) /* May return an empty string for digits==0 */
8012 } else if (!digits) {
8015 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8016 sv_catpvn(sv, p, l);
8022 #endif /* !USE_LONG_DOUBLE */
8024 if (!args && svix < svmax && DO_UTF8(*svargs))
8027 patend = (char*)pat + patlen;
8028 for (p = (char*)pat; p < patend; p = q) {
8031 bool vectorize = FALSE;
8032 bool vectorarg = FALSE;
8033 bool vec_utf8 = FALSE;
8039 bool has_precis = FALSE;
8041 const I32 osvix = svix;
8042 bool is_utf8 = FALSE; /* is this item utf8? */
8043 #ifdef HAS_LDBL_SPRINTF_BUG
8044 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8045 with sfio - Allen <allens@cpan.org> */
8046 bool fix_ldbl_sprintf_bug = FALSE;
8050 U8 utf8buf[UTF8_MAXBYTES+1];
8051 STRLEN esignlen = 0;
8053 const char *eptr = NULL;
8056 const U8 *vecstr = Null(U8*);
8063 /* we need a long double target in case HAS_LONG_DOUBLE but
8066 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8074 const char *dotstr = ".";
8075 STRLEN dotstrlen = 1;
8076 I32 efix = 0; /* explicit format parameter index */
8077 I32 ewix = 0; /* explicit width index */
8078 I32 epix = 0; /* explicit precision index */
8079 I32 evix = 0; /* explicit vector index */
8080 bool asterisk = FALSE;
8082 /* echo everything up to the next format specification */
8083 for (q = p; q < patend && *q != '%'; ++q) ;
8085 if (has_utf8 && !pat_utf8)
8086 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8088 sv_catpvn(sv, p, q - p);
8095 We allow format specification elements in this order:
8096 \d+\$ explicit format parameter index
8098 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8099 0 flag (as above): repeated to allow "v02"
8100 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8101 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8103 [%bcdefginopsuxDFOUX] format (mandatory)
8108 As of perl5.9.3, printf format checking is on by default.
8109 Internally, perl uses %p formats to provide an escape to
8110 some extended formatting. This block deals with those
8111 extensions: if it does not match, (char*)q is reset and
8112 the normal format processing code is used.
8114 Currently defined extensions are:
8115 %p include pointer address (standard)
8116 %-p (SVf) include an SV (previously %_)
8117 %-<num>p include an SV with precision <num>
8118 %1p (VDf) include a v-string (as %vd)
8119 %<num>p reserved for future extensions
8121 Robin Barker 2005-07-14
8128 n = expect_number(&q);
8135 argsv = va_arg(*args, SV*);
8136 eptr = SvPVx_const(argsv, elen);
8142 else if (n == vdNUMBER) { /* VDf */
8149 if (ckWARN_d(WARN_INTERNAL))
8150 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8151 "internal %%<num>p might conflict with future printf extensions");
8157 if ( (width = expect_number(&q)) ) {
8198 if ( (ewix = expect_number(&q)) )
8207 if ((vectorarg = asterisk)) {
8220 width = expect_number(&q);
8226 vecsv = va_arg(*args, SV*);
8228 vecsv = (evix > 0 && evix <= svmax)
8229 ? svargs[evix-1] : &PL_sv_undef;
8231 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8233 dotstr = SvPV_const(vecsv, dotstrlen);
8234 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8235 bad with tied or overloaded values that return UTF8. */
8238 else if (has_utf8) {
8239 vecsv = sv_mortalcopy(vecsv);
8240 sv_utf8_upgrade(vecsv);
8241 dotstr = SvPV_const(vecsv, dotstrlen);
8248 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8249 vecsv = svargs[efix ? efix-1 : svix++];
8250 vecstr = (U8*)SvPV_const(vecsv,veclen);
8251 vec_utf8 = DO_UTF8(vecsv);
8253 /* if this is a version object, we need to convert
8254 * back into v-string notation and then let the
8255 * vectorize happen normally
8257 if (sv_derived_from(vecsv, "version")) {
8258 char *version = savesvpv(vecsv);
8259 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8260 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8261 "vector argument not supported with alpha versions");
8264 vecsv = sv_newmortal();
8265 /* scan_vstring is expected to be called during
8266 * tokenization, so we need to fake up the end
8267 * of the buffer for it
8269 PL_bufend = version + veclen;
8270 scan_vstring(version, vecsv);
8271 vecstr = (U8*)SvPV_const(vecsv, veclen);
8272 vec_utf8 = DO_UTF8(vecsv);
8284 i = va_arg(*args, int);
8286 i = (ewix ? ewix <= svmax : svix < svmax) ?
8287 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8289 width = (i < 0) ? -i : i;
8299 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8301 /* XXX: todo, support specified precision parameter */
8305 i = va_arg(*args, int);
8307 i = (ewix ? ewix <= svmax : svix < svmax)
8308 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8309 precis = (i < 0) ? 0 : i;
8314 precis = precis * 10 + (*q++ - '0');
8323 case 'I': /* Ix, I32x, and I64x */
8325 if (q[1] == '6' && q[2] == '4') {
8331 if (q[1] == '3' && q[2] == '2') {
8341 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8352 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8353 if (*(q + 1) == 'l') { /* lld, llf */
8379 if (!vectorize && !args) {
8381 const I32 i = efix-1;
8382 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8384 argsv = (svix >= 0 && svix < svmax)
8385 ? svargs[svix++] : &PL_sv_undef;
8396 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8398 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8400 eptr = (char*)utf8buf;
8401 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8415 eptr = va_arg(*args, char*);
8417 #ifdef MACOS_TRADITIONAL
8418 /* On MacOS, %#s format is used for Pascal strings */
8423 elen = strlen(eptr);
8425 eptr = (char *)nullstr;
8426 elen = sizeof nullstr - 1;
8430 eptr = SvPVx_const(argsv, elen);
8431 if (DO_UTF8(argsv)) {
8432 if (has_precis && precis < elen) {
8434 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8437 if (width) { /* fudge width (can't fudge elen) */
8438 width += elen - sv_len_utf8(argsv);
8445 if (has_precis && elen > precis)
8452 if (alt || vectorize)
8454 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8475 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8484 esignbuf[esignlen++] = plus;
8488 case 'h': iv = (short)va_arg(*args, int); break;
8489 case 'l': iv = va_arg(*args, long); break;
8490 case 'V': iv = va_arg(*args, IV); break;
8491 default: iv = va_arg(*args, int); break;
8493 case 'q': iv = va_arg(*args, Quad_t); break;
8498 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8500 case 'h': iv = (short)tiv; break;
8501 case 'l': iv = (long)tiv; break;
8503 default: iv = tiv; break;
8505 case 'q': iv = (Quad_t)tiv; break;
8509 if ( !vectorize ) /* we already set uv above */
8514 esignbuf[esignlen++] = plus;
8518 esignbuf[esignlen++] = '-';
8561 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8572 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8573 case 'l': uv = va_arg(*args, unsigned long); break;
8574 case 'V': uv = va_arg(*args, UV); break;
8575 default: uv = va_arg(*args, unsigned); break;
8577 case 'q': uv = va_arg(*args, Uquad_t); break;
8582 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8584 case 'h': uv = (unsigned short)tuv; break;
8585 case 'l': uv = (unsigned long)tuv; break;
8587 default: uv = tuv; break;
8589 case 'q': uv = (Uquad_t)tuv; break;
8596 char *ptr = ebuf + sizeof ebuf;
8602 p = (char*)((c == 'X')
8603 ? "0123456789ABCDEF" : "0123456789abcdef");
8609 esignbuf[esignlen++] = '0';
8610 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8618 if (alt && *ptr != '0')
8629 esignbuf[esignlen++] = '0';
8630 esignbuf[esignlen++] = 'b';
8633 default: /* it had better be ten or less */
8637 } while (uv /= base);
8640 elen = (ebuf + sizeof ebuf) - ptr;
8644 zeros = precis - elen;
8645 else if (precis == 0 && elen == 1 && *eptr == '0')
8651 /* FLOATING POINT */
8654 c = 'f'; /* maybe %F isn't supported here */
8662 /* This is evil, but floating point is even more evil */
8664 /* for SV-style calling, we can only get NV
8665 for C-style calling, we assume %f is double;
8666 for simplicity we allow any of %Lf, %llf, %qf for long double
8670 #if defined(USE_LONG_DOUBLE)
8674 /* [perl #20339] - we should accept and ignore %lf rather than die */
8678 #if defined(USE_LONG_DOUBLE)
8679 intsize = args ? 0 : 'q';
8683 #if defined(HAS_LONG_DOUBLE)
8692 /* now we need (long double) if intsize == 'q', else (double) */
8694 #if LONG_DOUBLESIZE > DOUBLESIZE
8696 va_arg(*args, long double) :
8697 va_arg(*args, double)
8699 va_arg(*args, double)
8704 if (c != 'e' && c != 'E') {
8706 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8707 will cast our (long double) to (double) */
8708 (void)Perl_frexp(nv, &i);
8709 if (i == PERL_INT_MIN)
8710 Perl_die(aTHX_ "panic: frexp");
8712 need = BIT_DIGITS(i);
8714 need += has_precis ? precis : 6; /* known default */
8719 #ifdef HAS_LDBL_SPRINTF_BUG
8720 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8721 with sfio - Allen <allens@cpan.org> */
8724 # define MY_DBL_MAX DBL_MAX
8725 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8726 # if DOUBLESIZE >= 8
8727 # define MY_DBL_MAX 1.7976931348623157E+308L
8729 # define MY_DBL_MAX 3.40282347E+38L
8733 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8734 # define MY_DBL_MAX_BUG 1L
8736 # define MY_DBL_MAX_BUG MY_DBL_MAX
8740 # define MY_DBL_MIN DBL_MIN
8741 # else /* XXX guessing! -Allen */
8742 # if DOUBLESIZE >= 8
8743 # define MY_DBL_MIN 2.2250738585072014E-308L
8745 # define MY_DBL_MIN 1.17549435E-38L
8749 if ((intsize == 'q') && (c == 'f') &&
8750 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8752 /* it's going to be short enough that
8753 * long double precision is not needed */
8755 if ((nv <= 0L) && (nv >= -0L))
8756 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8758 /* would use Perl_fp_class as a double-check but not
8759 * functional on IRIX - see perl.h comments */
8761 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8762 /* It's within the range that a double can represent */
8763 #if defined(DBL_MAX) && !defined(DBL_MIN)
8764 if ((nv >= ((long double)1/DBL_MAX)) ||
8765 (nv <= (-(long double)1/DBL_MAX)))
8767 fix_ldbl_sprintf_bug = TRUE;
8770 if (fix_ldbl_sprintf_bug == TRUE) {
8780 # undef MY_DBL_MAX_BUG
8783 #endif /* HAS_LDBL_SPRINTF_BUG */
8785 need += 20; /* fudge factor */
8786 if (PL_efloatsize < need) {
8787 Safefree(PL_efloatbuf);
8788 PL_efloatsize = need + 20; /* more fudge */
8789 Newx(PL_efloatbuf, PL_efloatsize, char);
8790 PL_efloatbuf[0] = '\0';
8793 if ( !(width || left || plus || alt) && fill != '0'
8794 && has_precis && intsize != 'q' ) { /* Shortcuts */
8795 /* See earlier comment about buggy Gconvert when digits,
8797 if ( c == 'g' && precis) {
8798 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8799 /* May return an empty string for digits==0 */
8800 if (*PL_efloatbuf) {
8801 elen = strlen(PL_efloatbuf);
8802 goto float_converted;
8804 } else if ( c == 'f' && !precis) {
8805 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8810 char *ptr = ebuf + sizeof ebuf;
8813 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8814 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8815 if (intsize == 'q') {
8816 /* Copy the one or more characters in a long double
8817 * format before the 'base' ([efgEFG]) character to
8818 * the format string. */
8819 static char const prifldbl[] = PERL_PRIfldbl;
8820 char const *p = prifldbl + sizeof(prifldbl) - 3;
8821 while (p >= prifldbl) { *--ptr = *p--; }
8826 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8831 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8843 /* No taint. Otherwise we are in the strange situation
8844 * where printf() taints but print($float) doesn't.
8846 #if defined(HAS_LONG_DOUBLE)
8847 elen = ((intsize == 'q')
8848 ? my_sprintf(PL_efloatbuf, ptr, nv)
8849 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8851 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8855 eptr = PL_efloatbuf;
8863 i = SvCUR(sv) - origlen;
8866 case 'h': *(va_arg(*args, short*)) = i; break;
8867 default: *(va_arg(*args, int*)) = i; break;
8868 case 'l': *(va_arg(*args, long*)) = i; break;
8869 case 'V': *(va_arg(*args, IV*)) = i; break;
8871 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8876 sv_setuv_mg(argsv, (UV)i);
8877 continue; /* not "break" */
8884 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8885 && ckWARN(WARN_PRINTF))
8887 SV * const msg = sv_newmortal();
8888 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8889 (PL_op->op_type == OP_PRTF) ? "" : "s");
8892 Perl_sv_catpvf(aTHX_ msg,
8893 "\"%%%c\"", c & 0xFF);
8895 Perl_sv_catpvf(aTHX_ msg,
8896 "\"%%\\%03"UVof"\"",
8899 sv_catpvs(msg, "end of string");
8900 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8903 /* output mangled stuff ... */
8909 /* ... right here, because formatting flags should not apply */
8910 SvGROW(sv, SvCUR(sv) + elen + 1);
8912 Copy(eptr, p, elen, char);
8915 SvCUR_set(sv, p - SvPVX_const(sv));
8917 continue; /* not "break" */
8920 /* calculate width before utf8_upgrade changes it */
8921 have = esignlen + zeros + elen;
8923 Perl_croak_nocontext(PL_memory_wrap);
8925 if (is_utf8 != has_utf8) {
8928 sv_utf8_upgrade(sv);
8931 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8932 sv_utf8_upgrade(nsv);
8933 eptr = SvPVX_const(nsv);
8936 SvGROW(sv, SvCUR(sv) + elen + 1);
8941 need = (have > width ? have : width);
8944 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8945 Perl_croak_nocontext(PL_memory_wrap);
8946 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8948 if (esignlen && fill == '0') {
8950 for (i = 0; i < (int)esignlen; i++)
8954 memset(p, fill, gap);
8957 if (esignlen && fill != '0') {
8959 for (i = 0; i < (int)esignlen; i++)
8964 for (i = zeros; i; i--)
8968 Copy(eptr, p, elen, char);
8972 memset(p, ' ', gap);
8977 Copy(dotstr, p, dotstrlen, char);
8981 vectorize = FALSE; /* done iterating over vecstr */
8988 SvCUR_set(sv, p - SvPVX_const(sv));
8996 /* =========================================================================
8998 =head1 Cloning an interpreter
9000 All the macros and functions in this section are for the private use of
9001 the main function, perl_clone().
9003 The foo_dup() functions make an exact copy of an existing foo thinngy.
9004 During the course of a cloning, a hash table is used to map old addresses
9005 to new addresses. The table is created and manipulated with the
9006 ptr_table_* functions.
9010 ============================================================================*/
9013 #if defined(USE_ITHREADS)
9015 #ifndef GpREFCNT_inc
9016 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9020 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9021 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9022 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9023 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9024 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9025 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9026 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9027 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9028 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9029 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9030 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9031 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9032 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9035 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9036 regcomp.c. AMS 20010712 */
9039 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9044 struct reg_substr_datum *s;
9047 return (REGEXP *)NULL;
9049 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9052 len = r->offsets[0];
9053 npar = r->nparens+1;
9055 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9056 Copy(r->program, ret->program, len+1, regnode);
9058 Newx(ret->startp, npar, I32);
9059 Copy(r->startp, ret->startp, npar, I32);
9060 Newx(ret->endp, npar, I32);
9061 Copy(r->startp, ret->startp, npar, I32);
9063 Newx(ret->substrs, 1, struct reg_substr_data);
9064 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9065 s->min_offset = r->substrs->data[i].min_offset;
9066 s->max_offset = r->substrs->data[i].max_offset;
9067 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9068 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9071 ret->regstclass = NULL;
9074 const int count = r->data->count;
9077 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9078 char, struct reg_data);
9079 Newx(d->what, count, U8);
9082 for (i = 0; i < count; i++) {
9083 d->what[i] = r->data->what[i];
9084 switch (d->what[i]) {
9085 /* legal options are one of: sfpont
9086 see also regcomp.h and pregfree() */
9088 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9091 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9094 /* This is cheating. */
9095 Newx(d->data[i], 1, struct regnode_charclass_class);
9096 StructCopy(r->data->data[i], d->data[i],
9097 struct regnode_charclass_class);
9098 ret->regstclass = (regnode*)d->data[i];
9101 /* Compiled op trees are readonly, and can thus be
9102 shared without duplication. */
9104 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9108 d->data[i] = r->data->data[i];
9111 d->data[i] = r->data->data[i];
9113 ((reg_trie_data*)d->data[i])->refcount++;
9117 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9126 Newx(ret->offsets, 2*len+1, U32);
9127 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9129 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9130 ret->refcnt = r->refcnt;
9131 ret->minlen = r->minlen;
9132 ret->prelen = r->prelen;
9133 ret->nparens = r->nparens;
9134 ret->lastparen = r->lastparen;
9135 ret->lastcloseparen = r->lastcloseparen;
9136 ret->reganch = r->reganch;
9138 ret->sublen = r->sublen;
9140 if (RX_MATCH_COPIED(ret))
9141 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9144 #ifdef PERL_OLD_COPY_ON_WRITE
9145 ret->saved_copy = NULL;
9148 ptr_table_store(PL_ptr_table, r, ret);
9152 /* duplicate a file handle */
9155 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9159 PERL_UNUSED_ARG(type);
9162 return (PerlIO*)NULL;
9164 /* look for it in the table first */
9165 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9169 /* create anew and remember what it is */
9170 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9171 ptr_table_store(PL_ptr_table, fp, ret);
9175 /* duplicate a directory handle */
9178 Perl_dirp_dup(pTHX_ DIR *dp)
9186 /* duplicate a typeglob */
9189 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9194 /* look for it in the table first */
9195 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9199 /* create anew and remember what it is */
9201 ptr_table_store(PL_ptr_table, gp, ret);
9204 ret->gp_refcnt = 0; /* must be before any other dups! */
9205 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9206 ret->gp_io = io_dup_inc(gp->gp_io, param);
9207 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9208 ret->gp_av = av_dup_inc(gp->gp_av, param);
9209 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9210 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9211 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9212 ret->gp_cvgen = gp->gp_cvgen;
9213 ret->gp_line = gp->gp_line;
9214 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9218 /* duplicate a chain of magic */
9221 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9223 MAGIC *mgprev = (MAGIC*)NULL;
9226 return (MAGIC*)NULL;
9227 /* look for it in the table first */
9228 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9232 for (; mg; mg = mg->mg_moremagic) {
9234 Newxz(nmg, 1, MAGIC);
9236 mgprev->mg_moremagic = nmg;
9239 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9240 nmg->mg_private = mg->mg_private;
9241 nmg->mg_type = mg->mg_type;
9242 nmg->mg_flags = mg->mg_flags;
9243 if (mg->mg_type == PERL_MAGIC_qr) {
9244 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9246 else if(mg->mg_type == PERL_MAGIC_backref) {
9247 /* The backref AV has its reference count deliberately bumped by
9249 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9251 else if (mg->mg_type == PERL_MAGIC_symtab) {
9252 nmg->mg_obj = mg->mg_obj;
9255 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9256 ? sv_dup_inc(mg->mg_obj, param)
9257 : sv_dup(mg->mg_obj, param);
9259 nmg->mg_len = mg->mg_len;
9260 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9261 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9262 if (mg->mg_len > 0) {
9263 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9264 if (mg->mg_type == PERL_MAGIC_overload_table &&
9265 AMT_AMAGIC((AMT*)mg->mg_ptr))
9267 const AMT * const amtp = (AMT*)mg->mg_ptr;
9268 AMT * const namtp = (AMT*)nmg->mg_ptr;
9270 for (i = 1; i < NofAMmeth; i++) {
9271 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9275 else if (mg->mg_len == HEf_SVKEY)
9276 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9278 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9279 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9286 /* create a new pointer-mapping table */
9289 Perl_ptr_table_new(pTHX)
9292 Newxz(tbl, 1, PTR_TBL_t);
9295 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9299 #define PTR_TABLE_HASH(ptr) \
9300 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9303 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9304 following define) and at call to new_body_inline made below in
9305 Perl_ptr_table_store()
9308 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9310 /* map an existing pointer using a table */
9312 STATIC PTR_TBL_ENT_t *
9313 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9314 PTR_TBL_ENT_t *tblent;
9315 const UV hash = PTR_TABLE_HASH(sv);
9317 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9318 for (; tblent; tblent = tblent->next) {
9319 if (tblent->oldval == sv)
9326 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9328 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9329 return tblent ? tblent->newval : (void *) 0;
9332 /* add a new entry to a pointer-mapping table */
9335 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9337 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9340 tblent->newval = newsv;
9342 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9344 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9345 tblent->oldval = oldsv;
9346 tblent->newval = newsv;
9347 tblent->next = tbl->tbl_ary[entry];
9348 tbl->tbl_ary[entry] = tblent;
9350 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9351 ptr_table_split(tbl);
9355 /* double the hash bucket size of an existing ptr table */
9358 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9360 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9361 const UV oldsize = tbl->tbl_max + 1;
9362 UV newsize = oldsize * 2;
9365 Renew(ary, newsize, PTR_TBL_ENT_t*);
9366 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9367 tbl->tbl_max = --newsize;
9369 for (i=0; i < oldsize; i++, ary++) {
9370 PTR_TBL_ENT_t **curentp, **entp, *ent;
9373 curentp = ary + oldsize;
9374 for (entp = ary, ent = *ary; ent; ent = *entp) {
9375 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9377 ent->next = *curentp;
9387 /* remove all the entries from a ptr table */
9390 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9392 if (tbl && tbl->tbl_items) {
9393 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9394 UV riter = tbl->tbl_max;
9397 PTR_TBL_ENT_t *entry = array[riter];
9400 PTR_TBL_ENT_t * const oentry = entry;
9401 entry = entry->next;
9410 /* clear and free a ptr table */
9413 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9418 ptr_table_clear(tbl);
9419 Safefree(tbl->tbl_ary);
9425 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9428 SvRV_set(dstr, SvWEAKREF(sstr)
9429 ? sv_dup(SvRV(sstr), param)
9430 : sv_dup_inc(SvRV(sstr), param));
9433 else if (SvPVX_const(sstr)) {
9434 /* Has something there */
9436 /* Normal PV - clone whole allocated space */
9437 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9438 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9439 /* Not that normal - actually sstr is copy on write.
9440 But we are a true, independant SV, so: */
9441 SvREADONLY_off(dstr);
9446 /* Special case - not normally malloced for some reason */
9447 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9448 /* A "shared" PV - clone it as "shared" PV */
9450 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9454 /* Some other special case - random pointer */
9455 SvPV_set(dstr, SvPVX(sstr));
9461 if (SvTYPE(dstr) == SVt_RV)
9462 SvRV_set(dstr, NULL);
9464 SvPV_set(dstr, NULL);
9468 /* duplicate an SV of any type (including AV, HV etc) */
9471 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9476 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9478 /* look for it in the table first */
9479 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9483 if(param->flags & CLONEf_JOIN_IN) {
9484 /** We are joining here so we don't want do clone
9485 something that is bad **/
9486 if (SvTYPE(sstr) == SVt_PVHV) {
9487 const char * const hvname = HvNAME_get(sstr);
9489 /** don't clone stashes if they already exist **/
9490 return (SV*)gv_stashpv(hvname,0);
9494 /* create anew and remember what it is */
9497 #ifdef DEBUG_LEAKING_SCALARS
9498 dstr->sv_debug_optype = sstr->sv_debug_optype;
9499 dstr->sv_debug_line = sstr->sv_debug_line;
9500 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9501 dstr->sv_debug_cloned = 1;
9502 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9505 ptr_table_store(PL_ptr_table, sstr, dstr);
9508 SvFLAGS(dstr) = SvFLAGS(sstr);
9509 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9510 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9513 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9514 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9515 PL_watch_pvx, SvPVX_const(sstr));
9518 /* don't clone objects whose class has asked us not to */
9519 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9520 SvFLAGS(dstr) &= ~SVTYPEMASK;
9525 switch (SvTYPE(sstr)) {
9530 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9531 SvIV_set(dstr, SvIVX(sstr));
9534 SvANY(dstr) = new_XNV();
9535 SvNV_set(dstr, SvNVX(sstr));
9538 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9539 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9543 /* These are all the types that need complex bodies allocating. */
9545 const svtype sv_type = SvTYPE(sstr);
9546 const struct body_details *const sv_type_details
9547 = bodies_by_type + sv_type;
9551 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9556 if (GvUNIQUE((GV*)sstr)) {
9557 /* Do sharing here, and fall through */
9570 assert(sv_type_details->size);
9571 if (sv_type_details->arena) {
9572 new_body_inline(new_body, sv_type_details->size, sv_type);
9574 = (void*)((char*)new_body - sv_type_details->offset);
9576 new_body = new_NOARENA(sv_type_details);
9580 SvANY(dstr) = new_body;
9583 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9584 ((char*)SvANY(dstr)) + sv_type_details->offset,
9585 sv_type_details->copy, char);
9587 Copy(((char*)SvANY(sstr)),
9588 ((char*)SvANY(dstr)),
9589 sv_type_details->size + sv_type_details->offset, char);
9592 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9593 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9595 /* The Copy above means that all the source (unduplicated) pointers
9596 are now in the destination. We can check the flags and the
9597 pointers in either, but it's possible that there's less cache
9598 missing by always going for the destination.
9599 FIXME - instrument and check that assumption */
9600 if (sv_type >= SVt_PVMG) {
9602 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9604 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9607 /* The cast silences a GCC warning about unhandled types. */
9608 switch ((int)sv_type) {
9620 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9621 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9622 LvTARG(dstr) = dstr;
9623 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9624 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9626 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9629 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9630 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9631 /* Don't call sv_add_backref here as it's going to be created
9632 as part of the magic cloning of the symbol table. */
9633 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9634 (void)GpREFCNT_inc(GvGP(dstr));
9637 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9638 if (IoOFP(dstr) == IoIFP(sstr))
9639 IoOFP(dstr) = IoIFP(dstr);
9641 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9642 /* PL_rsfp_filters entries have fake IoDIRP() */
9643 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9644 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9645 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9646 /* I have no idea why fake dirp (rsfps)
9647 should be treated differently but otherwise
9648 we end up with leaks -- sky*/
9649 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9650 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9651 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9653 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9654 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9655 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9657 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9658 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9659 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9662 if (AvARRAY((AV*)sstr)) {
9663 SV **dst_ary, **src_ary;
9664 SSize_t items = AvFILLp((AV*)sstr) + 1;
9666 src_ary = AvARRAY((AV*)sstr);
9667 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9668 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9669 SvPV_set(dstr, (char*)dst_ary);
9670 AvALLOC((AV*)dstr) = dst_ary;
9671 if (AvREAL((AV*)sstr)) {
9673 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9677 *dst_ary++ = sv_dup(*src_ary++, param);
9679 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9680 while (items-- > 0) {
9681 *dst_ary++ = &PL_sv_undef;
9685 SvPV_set(dstr, NULL);
9686 AvALLOC((AV*)dstr) = (SV**)NULL;
9693 if (HvARRAY((HV*)sstr)) {
9695 const bool sharekeys = !!HvSHAREKEYS(sstr);
9696 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9697 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9699 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9700 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9702 HvARRAY(dstr) = (HE**)darray;
9703 while (i <= sxhv->xhv_max) {
9704 const HE *source = HvARRAY(sstr)[i];
9705 HvARRAY(dstr)[i] = source
9706 ? he_dup(source, sharekeys, param) : 0;
9710 struct xpvhv_aux * const saux = HvAUX(sstr);
9711 struct xpvhv_aux * const daux = HvAUX(dstr);
9712 /* This flag isn't copied. */
9713 /* SvOOK_on(hv) attacks the IV flags. */
9714 SvFLAGS(dstr) |= SVf_OOK;
9716 hvname = saux->xhv_name;
9718 = hvname ? hek_dup(hvname, param) : hvname;
9720 daux->xhv_riter = saux->xhv_riter;
9721 daux->xhv_eiter = saux->xhv_eiter
9722 ? he_dup(saux->xhv_eiter,
9723 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9724 daux->xhv_backreferences = saux->xhv_backreferences
9725 ? (AV*) SvREFCNT_inc(
9733 SvPV_set(dstr, NULL);
9735 /* Record stashes for possible cloning in Perl_clone(). */
9737 av_push(param->stashes, dstr);
9742 /* NOTE: not refcounted */
9743 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9745 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9747 if (CvCONST(dstr)) {
9748 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9749 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9750 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9752 /* don't dup if copying back - CvGV isn't refcounted, so the
9753 * duped GV may never be freed. A bit of a hack! DAPM */
9754 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9755 NULL : gv_dup(CvGV(dstr), param) ;
9756 if (!(param->flags & CLONEf_COPY_STACKS)) {
9759 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9762 ? cv_dup( CvOUTSIDE(dstr), param)
9763 : cv_dup_inc(CvOUTSIDE(dstr), param);
9765 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9771 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9777 /* duplicate a context */
9780 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9785 return (PERL_CONTEXT*)NULL;
9787 /* look for it in the table first */
9788 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9792 /* create anew and remember what it is */
9793 Newxz(ncxs, max + 1, PERL_CONTEXT);
9794 ptr_table_store(PL_ptr_table, cxs, ncxs);
9797 PERL_CONTEXT * const cx = &cxs[ix];
9798 PERL_CONTEXT * const ncx = &ncxs[ix];
9799 ncx->cx_type = cx->cx_type;
9800 if (CxTYPE(cx) == CXt_SUBST) {
9801 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9804 ncx->blk_oldsp = cx->blk_oldsp;
9805 ncx->blk_oldcop = cx->blk_oldcop;
9806 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9807 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9808 ncx->blk_oldpm = cx->blk_oldpm;
9809 ncx->blk_gimme = cx->blk_gimme;
9810 switch (CxTYPE(cx)) {
9812 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9813 ? cv_dup_inc(cx->blk_sub.cv, param)
9814 : cv_dup(cx->blk_sub.cv,param));
9815 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9816 ? av_dup_inc(cx->blk_sub.argarray, param)
9818 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9819 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9820 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9821 ncx->blk_sub.lval = cx->blk_sub.lval;
9822 ncx->blk_sub.retop = cx->blk_sub.retop;
9825 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9826 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9827 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9828 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9829 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9830 ncx->blk_eval.retop = cx->blk_eval.retop;
9833 ncx->blk_loop.label = cx->blk_loop.label;
9834 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9835 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9836 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9837 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9838 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9839 ? cx->blk_loop.iterdata
9840 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9841 ncx->blk_loop.oldcomppad
9842 = (PAD*)ptr_table_fetch(PL_ptr_table,
9843 cx->blk_loop.oldcomppad);
9844 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9845 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9846 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9847 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9848 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9851 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9852 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9853 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9854 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9855 ncx->blk_sub.retop = cx->blk_sub.retop;
9867 /* duplicate a stack info structure */
9870 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9875 return (PERL_SI*)NULL;
9877 /* look for it in the table first */
9878 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9882 /* create anew and remember what it is */
9883 Newxz(nsi, 1, PERL_SI);
9884 ptr_table_store(PL_ptr_table, si, nsi);
9886 nsi->si_stack = av_dup_inc(si->si_stack, param);
9887 nsi->si_cxix = si->si_cxix;
9888 nsi->si_cxmax = si->si_cxmax;
9889 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9890 nsi->si_type = si->si_type;
9891 nsi->si_prev = si_dup(si->si_prev, param);
9892 nsi->si_next = si_dup(si->si_next, param);
9893 nsi->si_markoff = si->si_markoff;
9898 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9899 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9900 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9901 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9902 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9903 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9904 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9905 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9906 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9907 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9908 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9909 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9910 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9911 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9914 #define pv_dup_inc(p) SAVEPV(p)
9915 #define pv_dup(p) SAVEPV(p)
9916 #define svp_dup_inc(p,pp) any_dup(p,pp)
9918 /* map any object to the new equivent - either something in the
9919 * ptr table, or something in the interpreter structure
9923 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9930 /* look for it in the table first */
9931 ret = ptr_table_fetch(PL_ptr_table, v);
9935 /* see if it is part of the interpreter structure */
9936 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9937 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9945 /* duplicate the save stack */
9948 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9950 ANY * const ss = proto_perl->Tsavestack;
9951 const I32 max = proto_perl->Tsavestack_max;
9952 I32 ix = proto_perl->Tsavestack_ix;
9964 void (*dptr) (void*);
9965 void (*dxptr) (pTHX_ void*);
9967 Newxz(nss, max, ANY);
9970 I32 i = POPINT(ss,ix);
9973 case SAVEt_ITEM: /* normal string */
9974 sv = (SV*)POPPTR(ss,ix);
9975 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9976 sv = (SV*)POPPTR(ss,ix);
9977 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9979 case SAVEt_SV: /* scalar reference */
9980 sv = (SV*)POPPTR(ss,ix);
9981 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9982 gv = (GV*)POPPTR(ss,ix);
9983 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9985 case SAVEt_GENERIC_PVREF: /* generic char* */
9986 c = (char*)POPPTR(ss,ix);
9987 TOPPTR(nss,ix) = pv_dup(c);
9988 ptr = POPPTR(ss,ix);
9989 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9991 case SAVEt_SHARED_PVREF: /* char* in shared space */
9992 c = (char*)POPPTR(ss,ix);
9993 TOPPTR(nss,ix) = savesharedpv(c);
9994 ptr = POPPTR(ss,ix);
9995 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9997 case SAVEt_GENERIC_SVREF: /* generic sv */
9998 case SAVEt_SVREF: /* scalar reference */
9999 sv = (SV*)POPPTR(ss,ix);
10000 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10001 ptr = POPPTR(ss,ix);
10002 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10004 case SAVEt_AV: /* array reference */
10005 av = (AV*)POPPTR(ss,ix);
10006 TOPPTR(nss,ix) = av_dup_inc(av, param);
10007 gv = (GV*)POPPTR(ss,ix);
10008 TOPPTR(nss,ix) = gv_dup(gv, param);
10010 case SAVEt_HV: /* hash reference */
10011 hv = (HV*)POPPTR(ss,ix);
10012 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10013 gv = (GV*)POPPTR(ss,ix);
10014 TOPPTR(nss,ix) = gv_dup(gv, param);
10016 case SAVEt_INT: /* int reference */
10017 ptr = POPPTR(ss,ix);
10018 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10019 intval = (int)POPINT(ss,ix);
10020 TOPINT(nss,ix) = intval;
10022 case SAVEt_LONG: /* long reference */
10023 ptr = POPPTR(ss,ix);
10024 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10025 longval = (long)POPLONG(ss,ix);
10026 TOPLONG(nss,ix) = longval;
10028 case SAVEt_I32: /* I32 reference */
10029 case SAVEt_I16: /* I16 reference */
10030 case SAVEt_I8: /* I8 reference */
10031 ptr = POPPTR(ss,ix);
10032 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10034 TOPINT(nss,ix) = i;
10036 case SAVEt_IV: /* IV reference */
10037 ptr = POPPTR(ss,ix);
10038 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10040 TOPIV(nss,ix) = iv;
10042 case SAVEt_SPTR: /* SV* reference */
10043 ptr = POPPTR(ss,ix);
10044 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10045 sv = (SV*)POPPTR(ss,ix);
10046 TOPPTR(nss,ix) = sv_dup(sv, param);
10048 case SAVEt_VPTR: /* random* reference */
10049 ptr = POPPTR(ss,ix);
10050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10051 ptr = POPPTR(ss,ix);
10052 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10054 case SAVEt_PPTR: /* char* reference */
10055 ptr = POPPTR(ss,ix);
10056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10057 c = (char*)POPPTR(ss,ix);
10058 TOPPTR(nss,ix) = pv_dup(c);
10060 case SAVEt_HPTR: /* HV* reference */
10061 ptr = POPPTR(ss,ix);
10062 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10063 hv = (HV*)POPPTR(ss,ix);
10064 TOPPTR(nss,ix) = hv_dup(hv, param);
10066 case SAVEt_APTR: /* AV* reference */
10067 ptr = POPPTR(ss,ix);
10068 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10069 av = (AV*)POPPTR(ss,ix);
10070 TOPPTR(nss,ix) = av_dup(av, param);
10073 gv = (GV*)POPPTR(ss,ix);
10074 TOPPTR(nss,ix) = gv_dup(gv, param);
10076 case SAVEt_GP: /* scalar reference */
10077 gp = (GP*)POPPTR(ss,ix);
10078 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10079 (void)GpREFCNT_inc(gp);
10080 gv = (GV*)POPPTR(ss,ix);
10081 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10082 c = (char*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = pv_dup(c);
10085 TOPIV(nss,ix) = iv;
10087 TOPIV(nss,ix) = iv;
10090 case SAVEt_MORTALIZESV:
10091 sv = (SV*)POPPTR(ss,ix);
10092 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10095 ptr = POPPTR(ss,ix);
10096 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10097 /* these are assumed to be refcounted properly */
10099 switch (((OP*)ptr)->op_type) {
10101 case OP_LEAVESUBLV:
10105 case OP_LEAVEWRITE:
10106 TOPPTR(nss,ix) = ptr;
10111 TOPPTR(nss,ix) = Nullop;
10116 TOPPTR(nss,ix) = Nullop;
10119 c = (char*)POPPTR(ss,ix);
10120 TOPPTR(nss,ix) = pv_dup_inc(c);
10122 case SAVEt_CLEARSV:
10123 longval = POPLONG(ss,ix);
10124 TOPLONG(nss,ix) = longval;
10127 hv = (HV*)POPPTR(ss,ix);
10128 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10129 c = (char*)POPPTR(ss,ix);
10130 TOPPTR(nss,ix) = pv_dup_inc(c);
10132 TOPINT(nss,ix) = i;
10134 case SAVEt_DESTRUCTOR:
10135 ptr = POPPTR(ss,ix);
10136 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10137 dptr = POPDPTR(ss,ix);
10138 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10139 any_dup(FPTR2DPTR(void *, dptr),
10142 case SAVEt_DESTRUCTOR_X:
10143 ptr = POPPTR(ss,ix);
10144 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10145 dxptr = POPDXPTR(ss,ix);
10146 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10147 any_dup(FPTR2DPTR(void *, dxptr),
10150 case SAVEt_REGCONTEXT:
10153 TOPINT(nss,ix) = i;
10156 case SAVEt_STACK_POS: /* Position on Perl stack */
10158 TOPINT(nss,ix) = i;
10160 case SAVEt_AELEM: /* array element */
10161 sv = (SV*)POPPTR(ss,ix);
10162 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10164 TOPINT(nss,ix) = i;
10165 av = (AV*)POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = av_dup_inc(av, param);
10168 case SAVEt_HELEM: /* hash element */
10169 sv = (SV*)POPPTR(ss,ix);
10170 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10171 sv = (SV*)POPPTR(ss,ix);
10172 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10173 hv = (HV*)POPPTR(ss,ix);
10174 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10177 ptr = POPPTR(ss,ix);
10178 TOPPTR(nss,ix) = ptr;
10182 TOPINT(nss,ix) = i;
10184 case SAVEt_COMPPAD:
10185 av = (AV*)POPPTR(ss,ix);
10186 TOPPTR(nss,ix) = av_dup(av, param);
10189 longval = (long)POPLONG(ss,ix);
10190 TOPLONG(nss,ix) = longval;
10191 ptr = POPPTR(ss,ix);
10192 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10193 sv = (SV*)POPPTR(ss,ix);
10194 TOPPTR(nss,ix) = sv_dup(sv, param);
10197 ptr = POPPTR(ss,ix);
10198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10199 longval = (long)POPBOOL(ss,ix);
10200 TOPBOOL(nss,ix) = (bool)longval;
10202 case SAVEt_SET_SVFLAGS:
10204 TOPINT(nss,ix) = i;
10206 TOPINT(nss,ix) = i;
10207 sv = (SV*)POPPTR(ss,ix);
10208 TOPPTR(nss,ix) = sv_dup(sv, param);
10211 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10219 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10220 * flag to the result. This is done for each stash before cloning starts,
10221 * so we know which stashes want their objects cloned */
10224 do_mark_cloneable_stash(pTHX_ SV *sv)
10226 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10228 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10229 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10230 if (cloner && GvCV(cloner)) {
10237 XPUSHs(sv_2mortal(newSVhek(hvname)));
10239 call_sv((SV*)GvCV(cloner), G_SCALAR);
10246 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10254 =for apidoc perl_clone
10256 Create and return a new interpreter by cloning the current one.
10258 perl_clone takes these flags as parameters:
10260 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10261 without it we only clone the data and zero the stacks,
10262 with it we copy the stacks and the new perl interpreter is
10263 ready to run at the exact same point as the previous one.
10264 The pseudo-fork code uses COPY_STACKS while the
10265 threads->new doesn't.
10267 CLONEf_KEEP_PTR_TABLE
10268 perl_clone keeps a ptr_table with the pointer of the old
10269 variable as a key and the new variable as a value,
10270 this allows it to check if something has been cloned and not
10271 clone it again but rather just use the value and increase the
10272 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10273 the ptr_table using the function
10274 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10275 reason to keep it around is if you want to dup some of your own
10276 variable who are outside the graph perl scans, example of this
10277 code is in threads.xs create
10280 This is a win32 thing, it is ignored on unix, it tells perls
10281 win32host code (which is c++) to clone itself, this is needed on
10282 win32 if you want to run two threads at the same time,
10283 if you just want to do some stuff in a separate perl interpreter
10284 and then throw it away and return to the original one,
10285 you don't need to do anything.
10290 /* XXX the above needs expanding by someone who actually understands it ! */
10291 EXTERN_C PerlInterpreter *
10292 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10295 perl_clone(PerlInterpreter *proto_perl, UV flags)
10298 #ifdef PERL_IMPLICIT_SYS
10300 /* perlhost.h so we need to call into it
10301 to clone the host, CPerlHost should have a c interface, sky */
10303 if (flags & CLONEf_CLONE_HOST) {
10304 return perl_clone_host(proto_perl,flags);
10306 return perl_clone_using(proto_perl, flags,
10308 proto_perl->IMemShared,
10309 proto_perl->IMemParse,
10311 proto_perl->IStdIO,
10315 proto_perl->IProc);
10319 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10320 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10321 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10322 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10323 struct IPerlDir* ipD, struct IPerlSock* ipS,
10324 struct IPerlProc* ipP)
10326 /* XXX many of the string copies here can be optimized if they're
10327 * constants; they need to be allocated as common memory and just
10328 * their pointers copied. */
10331 CLONE_PARAMS clone_params;
10332 CLONE_PARAMS* param = &clone_params;
10334 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10335 /* for each stash, determine whether its objects should be cloned */
10336 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10337 PERL_SET_THX(my_perl);
10340 Poison(my_perl, 1, PerlInterpreter);
10342 PL_curcop = (COP *)Nullop;
10346 PL_savestack_ix = 0;
10347 PL_savestack_max = -1;
10348 PL_sig_pending = 0;
10349 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10350 # else /* !DEBUGGING */
10351 Zero(my_perl, 1, PerlInterpreter);
10352 # endif /* DEBUGGING */
10354 /* host pointers */
10356 PL_MemShared = ipMS;
10357 PL_MemParse = ipMP;
10364 #else /* !PERL_IMPLICIT_SYS */
10366 CLONE_PARAMS clone_params;
10367 CLONE_PARAMS* param = &clone_params;
10368 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10369 /* for each stash, determine whether its objects should be cloned */
10370 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10371 PERL_SET_THX(my_perl);
10374 Poison(my_perl, 1, PerlInterpreter);
10376 PL_curcop = (COP *)Nullop;
10380 PL_savestack_ix = 0;
10381 PL_savestack_max = -1;
10382 PL_sig_pending = 0;
10383 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10384 # else /* !DEBUGGING */
10385 Zero(my_perl, 1, PerlInterpreter);
10386 # endif /* DEBUGGING */
10387 #endif /* PERL_IMPLICIT_SYS */
10388 param->flags = flags;
10389 param->proto_perl = proto_perl;
10391 PL_body_arenas = NULL;
10392 Zero(&PL_body_roots, 1, PL_body_roots);
10394 PL_nice_chunk = NULL;
10395 PL_nice_chunk_size = 0;
10397 PL_sv_objcount = 0;
10399 PL_sv_arenaroot = NULL;
10401 PL_debug = proto_perl->Idebug;
10403 PL_hash_seed = proto_perl->Ihash_seed;
10404 PL_rehash_seed = proto_perl->Irehash_seed;
10406 #ifdef USE_REENTRANT_API
10407 /* XXX: things like -Dm will segfault here in perlio, but doing
10408 * PERL_SET_CONTEXT(proto_perl);
10409 * breaks too many other things
10411 Perl_reentrant_init(aTHX);
10414 /* create SV map for pointer relocation */
10415 PL_ptr_table = ptr_table_new();
10417 /* initialize these special pointers as early as possible */
10418 SvANY(&PL_sv_undef) = NULL;
10419 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10420 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10421 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10423 SvANY(&PL_sv_no) = new_XPVNV();
10424 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10425 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10426 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10427 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10428 SvCUR_set(&PL_sv_no, 0);
10429 SvLEN_set(&PL_sv_no, 1);
10430 SvIV_set(&PL_sv_no, 0);
10431 SvNV_set(&PL_sv_no, 0);
10432 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10434 SvANY(&PL_sv_yes) = new_XPVNV();
10435 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10436 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10437 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10438 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10439 SvCUR_set(&PL_sv_yes, 1);
10440 SvLEN_set(&PL_sv_yes, 2);
10441 SvIV_set(&PL_sv_yes, 1);
10442 SvNV_set(&PL_sv_yes, 1);
10443 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10445 /* create (a non-shared!) shared string table */
10446 PL_strtab = newHV();
10447 HvSHAREKEYS_off(PL_strtab);
10448 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10449 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10451 PL_compiling = proto_perl->Icompiling;
10453 /* These two PVs will be free'd special way so must set them same way op.c does */
10454 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10455 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10457 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10458 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10460 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10461 if (!specialWARN(PL_compiling.cop_warnings))
10462 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10463 if (!specialCopIO(PL_compiling.cop_io))
10464 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10465 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10467 /* pseudo environmental stuff */
10468 PL_origargc = proto_perl->Iorigargc;
10469 PL_origargv = proto_perl->Iorigargv;
10471 param->stashes = newAV(); /* Setup array of objects to call clone on */
10473 /* Set tainting stuff before PerlIO_debug can possibly get called */
10474 PL_tainting = proto_perl->Itainting;
10475 PL_taint_warn = proto_perl->Itaint_warn;
10477 #ifdef PERLIO_LAYERS
10478 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10479 PerlIO_clone(aTHX_ proto_perl, param);
10482 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10483 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10484 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10485 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10486 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10487 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10490 PL_minus_c = proto_perl->Iminus_c;
10491 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10492 PL_localpatches = proto_perl->Ilocalpatches;
10493 PL_splitstr = proto_perl->Isplitstr;
10494 PL_preprocess = proto_perl->Ipreprocess;
10495 PL_minus_n = proto_perl->Iminus_n;
10496 PL_minus_p = proto_perl->Iminus_p;
10497 PL_minus_l = proto_perl->Iminus_l;
10498 PL_minus_a = proto_perl->Iminus_a;
10499 PL_minus_E = proto_perl->Iminus_E;
10500 PL_minus_F = proto_perl->Iminus_F;
10501 PL_doswitches = proto_perl->Idoswitches;
10502 PL_dowarn = proto_perl->Idowarn;
10503 PL_doextract = proto_perl->Idoextract;
10504 PL_sawampersand = proto_perl->Isawampersand;
10505 PL_unsafe = proto_perl->Iunsafe;
10506 PL_inplace = SAVEPV(proto_perl->Iinplace);
10507 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10508 PL_perldb = proto_perl->Iperldb;
10509 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10510 PL_exit_flags = proto_perl->Iexit_flags;
10512 /* magical thingies */
10513 /* XXX time(&PL_basetime) when asked for? */
10514 PL_basetime = proto_perl->Ibasetime;
10515 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10517 PL_maxsysfd = proto_perl->Imaxsysfd;
10518 PL_multiline = proto_perl->Imultiline;
10519 PL_statusvalue = proto_perl->Istatusvalue;
10521 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10523 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10525 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10527 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10528 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10529 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10531 /* Clone the regex array */
10532 PL_regex_padav = newAV();
10534 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10535 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10537 av_push(PL_regex_padav,
10538 sv_dup_inc(regexen[0],param));
10539 for(i = 1; i <= len; i++) {
10540 const SV * const regex = regexen[i];
10543 ? sv_dup_inc(regex, param)
10545 newSViv(PTR2IV(re_dup(
10546 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10548 av_push(PL_regex_padav, sv);
10551 PL_regex_pad = AvARRAY(PL_regex_padav);
10553 /* shortcuts to various I/O objects */
10554 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10555 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10556 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10557 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10558 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10559 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10561 /* shortcuts to regexp stuff */
10562 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10564 /* shortcuts to misc objects */
10565 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10567 /* shortcuts to debugging objects */
10568 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10569 PL_DBline = gv_dup(proto_perl->IDBline, param);
10570 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10571 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10572 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10573 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10574 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10575 PL_lineary = av_dup(proto_perl->Ilineary, param);
10576 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10578 /* symbol tables */
10579 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10580 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10581 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10582 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10583 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10585 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10586 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10587 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10588 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10589 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10590 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10592 PL_sub_generation = proto_perl->Isub_generation;
10594 /* funky return mechanisms */
10595 PL_forkprocess = proto_perl->Iforkprocess;
10597 /* subprocess state */
10598 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10600 /* internal state */
10601 PL_maxo = proto_perl->Imaxo;
10602 if (proto_perl->Iop_mask)
10603 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10606 /* PL_asserting = proto_perl->Iasserting; */
10608 /* current interpreter roots */
10609 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10610 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10611 PL_main_start = proto_perl->Imain_start;
10612 PL_eval_root = proto_perl->Ieval_root;
10613 PL_eval_start = proto_perl->Ieval_start;
10615 /* runtime control stuff */
10616 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10617 PL_copline = proto_perl->Icopline;
10619 PL_filemode = proto_perl->Ifilemode;
10620 PL_lastfd = proto_perl->Ilastfd;
10621 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10624 PL_gensym = proto_perl->Igensym;
10625 PL_preambled = proto_perl->Ipreambled;
10626 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10627 PL_laststatval = proto_perl->Ilaststatval;
10628 PL_laststype = proto_perl->Ilaststype;
10631 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10633 /* interpreter atexit processing */
10634 PL_exitlistlen = proto_perl->Iexitlistlen;
10635 if (PL_exitlistlen) {
10636 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10637 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10640 PL_exitlist = (PerlExitListEntry*)NULL;
10642 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10643 if (PL_my_cxt_size) {
10644 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10645 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10648 PL_my_cxt_list = (void**)NULL;
10649 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10650 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10651 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10653 PL_profiledata = NULL;
10654 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10655 /* PL_rsfp_filters entries have fake IoDIRP() */
10656 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10658 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10660 PAD_CLONE_VARS(proto_perl, param);
10662 #ifdef HAVE_INTERP_INTERN
10663 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10666 /* more statics moved here */
10667 PL_generation = proto_perl->Igeneration;
10668 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10670 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10671 PL_in_clean_all = proto_perl->Iin_clean_all;
10673 PL_uid = proto_perl->Iuid;
10674 PL_euid = proto_perl->Ieuid;
10675 PL_gid = proto_perl->Igid;
10676 PL_egid = proto_perl->Iegid;
10677 PL_nomemok = proto_perl->Inomemok;
10678 PL_an = proto_perl->Ian;
10679 PL_evalseq = proto_perl->Ievalseq;
10680 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10681 PL_origalen = proto_perl->Iorigalen;
10682 #ifdef PERL_USES_PL_PIDSTATUS
10683 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10685 PL_osname = SAVEPV(proto_perl->Iosname);
10686 PL_sighandlerp = proto_perl->Isighandlerp;
10688 PL_runops = proto_perl->Irunops;
10690 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10693 PL_cshlen = proto_perl->Icshlen;
10694 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10697 PL_lex_state = proto_perl->Ilex_state;
10698 PL_lex_defer = proto_perl->Ilex_defer;
10699 PL_lex_expect = proto_perl->Ilex_expect;
10700 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10701 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10702 PL_lex_starts = proto_perl->Ilex_starts;
10703 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10704 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10705 PL_lex_op = proto_perl->Ilex_op;
10706 PL_lex_inpat = proto_perl->Ilex_inpat;
10707 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10708 PL_lex_brackets = proto_perl->Ilex_brackets;
10709 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10710 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10711 PL_lex_casemods = proto_perl->Ilex_casemods;
10712 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10713 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10715 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10716 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10717 PL_nexttoke = proto_perl->Inexttoke;
10719 /* XXX This is probably masking the deeper issue of why
10720 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10721 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10722 * (A little debugging with a watchpoint on it may help.)
10724 if (SvANY(proto_perl->Ilinestr)) {
10725 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10726 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10727 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10728 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10729 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10730 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10731 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10732 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10733 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10736 PL_linestr = newSV(79);
10737 sv_upgrade(PL_linestr,SVt_PVIV);
10738 sv_setpvn(PL_linestr,"",0);
10739 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10741 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10742 PL_pending_ident = proto_perl->Ipending_ident;
10743 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10745 PL_expect = proto_perl->Iexpect;
10747 PL_multi_start = proto_perl->Imulti_start;
10748 PL_multi_end = proto_perl->Imulti_end;
10749 PL_multi_open = proto_perl->Imulti_open;
10750 PL_multi_close = proto_perl->Imulti_close;
10752 PL_error_count = proto_perl->Ierror_count;
10753 PL_subline = proto_perl->Isubline;
10754 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10756 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10757 if (SvANY(proto_perl->Ilinestr)) {
10758 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10759 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10760 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10761 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10762 PL_last_lop_op = proto_perl->Ilast_lop_op;
10765 PL_last_uni = SvPVX(PL_linestr);
10766 PL_last_lop = SvPVX(PL_linestr);
10767 PL_last_lop_op = 0;
10769 PL_in_my = proto_perl->Iin_my;
10770 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10772 PL_cryptseen = proto_perl->Icryptseen;
10775 PL_hints = proto_perl->Ihints;
10777 PL_amagic_generation = proto_perl->Iamagic_generation;
10779 #ifdef USE_LOCALE_COLLATE
10780 PL_collation_ix = proto_perl->Icollation_ix;
10781 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10782 PL_collation_standard = proto_perl->Icollation_standard;
10783 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10784 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10785 #endif /* USE_LOCALE_COLLATE */
10787 #ifdef USE_LOCALE_NUMERIC
10788 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10789 PL_numeric_standard = proto_perl->Inumeric_standard;
10790 PL_numeric_local = proto_perl->Inumeric_local;
10791 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10792 #endif /* !USE_LOCALE_NUMERIC */
10794 /* utf8 character classes */
10795 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10796 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10797 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10798 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10799 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10800 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10801 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10802 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10803 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10804 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10805 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10806 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10807 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10808 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10809 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10810 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10811 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10812 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10813 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10814 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10816 /* Did the locale setup indicate UTF-8? */
10817 PL_utf8locale = proto_perl->Iutf8locale;
10818 /* Unicode features (see perlrun/-C) */
10819 PL_unicode = proto_perl->Iunicode;
10821 /* Pre-5.8 signals control */
10822 PL_signals = proto_perl->Isignals;
10824 /* times() ticks per second */
10825 PL_clocktick = proto_perl->Iclocktick;
10827 /* Recursion stopper for PerlIO_find_layer */
10828 PL_in_load_module = proto_perl->Iin_load_module;
10830 /* sort() routine */
10831 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10833 /* Not really needed/useful since the reenrant_retint is "volatile",
10834 * but do it for consistency's sake. */
10835 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10837 /* Hooks to shared SVs and locks. */
10838 PL_sharehook = proto_perl->Isharehook;
10839 PL_lockhook = proto_perl->Ilockhook;
10840 PL_unlockhook = proto_perl->Iunlockhook;
10841 PL_threadhook = proto_perl->Ithreadhook;
10843 PL_runops_std = proto_perl->Irunops_std;
10844 PL_runops_dbg = proto_perl->Irunops_dbg;
10846 #ifdef THREADS_HAVE_PIDS
10847 PL_ppid = proto_perl->Ippid;
10851 PL_last_swash_hv = NULL; /* reinits on demand */
10852 PL_last_swash_klen = 0;
10853 PL_last_swash_key[0]= '\0';
10854 PL_last_swash_tmps = (U8*)NULL;
10855 PL_last_swash_slen = 0;
10857 PL_glob_index = proto_perl->Iglob_index;
10858 PL_srand_called = proto_perl->Isrand_called;
10859 PL_uudmap['M'] = 0; /* reinits on demand */
10860 PL_bitcount = NULL; /* reinits on demand */
10862 if (proto_perl->Ipsig_pend) {
10863 Newxz(PL_psig_pend, SIG_SIZE, int);
10866 PL_psig_pend = (int*)NULL;
10869 if (proto_perl->Ipsig_ptr) {
10870 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10871 Newxz(PL_psig_name, SIG_SIZE, SV*);
10872 for (i = 1; i < SIG_SIZE; i++) {
10873 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10874 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10878 PL_psig_ptr = (SV**)NULL;
10879 PL_psig_name = (SV**)NULL;
10882 /* thrdvar.h stuff */
10884 if (flags & CLONEf_COPY_STACKS) {
10885 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10886 PL_tmps_ix = proto_perl->Ttmps_ix;
10887 PL_tmps_max = proto_perl->Ttmps_max;
10888 PL_tmps_floor = proto_perl->Ttmps_floor;
10889 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10891 while (i <= PL_tmps_ix) {
10892 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10896 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10897 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10898 Newxz(PL_markstack, i, I32);
10899 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10900 - proto_perl->Tmarkstack);
10901 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10902 - proto_perl->Tmarkstack);
10903 Copy(proto_perl->Tmarkstack, PL_markstack,
10904 PL_markstack_ptr - PL_markstack + 1, I32);
10906 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10907 * NOTE: unlike the others! */
10908 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10909 PL_scopestack_max = proto_perl->Tscopestack_max;
10910 Newxz(PL_scopestack, PL_scopestack_max, I32);
10911 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10913 /* NOTE: si_dup() looks at PL_markstack */
10914 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10916 /* PL_curstack = PL_curstackinfo->si_stack; */
10917 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10918 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10920 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10921 PL_stack_base = AvARRAY(PL_curstack);
10922 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10923 - proto_perl->Tstack_base);
10924 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10926 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10927 * NOTE: unlike the others! */
10928 PL_savestack_ix = proto_perl->Tsavestack_ix;
10929 PL_savestack_max = proto_perl->Tsavestack_max;
10930 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10931 PL_savestack = ss_dup(proto_perl, param);
10935 ENTER; /* perl_destruct() wants to LEAVE; */
10937 /* although we're not duplicating the tmps stack, we should still
10938 * add entries for any SVs on the tmps stack that got cloned by a
10939 * non-refcount means (eg a temp in @_); otherwise they will be
10942 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10943 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10944 proto_perl->Ttmps_stack[i]);
10945 if (nsv && !SvREFCNT(nsv)) {
10947 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10952 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10953 PL_top_env = &PL_start_env;
10955 PL_op = proto_perl->Top;
10958 PL_Xpv = (XPV*)NULL;
10959 PL_na = proto_perl->Tna;
10961 PL_statbuf = proto_perl->Tstatbuf;
10962 PL_statcache = proto_perl->Tstatcache;
10963 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10964 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10966 PL_timesbuf = proto_perl->Ttimesbuf;
10969 PL_tainted = proto_perl->Ttainted;
10970 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10971 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10972 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10973 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10974 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10975 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10976 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10977 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10978 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10980 PL_restartop = proto_perl->Trestartop;
10981 PL_in_eval = proto_perl->Tin_eval;
10982 PL_delaymagic = proto_perl->Tdelaymagic;
10983 PL_dirty = proto_perl->Tdirty;
10984 PL_localizing = proto_perl->Tlocalizing;
10986 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10987 PL_hv_fetch_ent_mh = Nullhe;
10988 PL_modcount = proto_perl->Tmodcount;
10989 PL_lastgotoprobe = Nullop;
10990 PL_dumpindent = proto_perl->Tdumpindent;
10992 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10993 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10994 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
10995 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
10996 PL_efloatbuf = NULL; /* reinits on demand */
10997 PL_efloatsize = 0; /* reinits on demand */
11001 PL_screamfirst = NULL;
11002 PL_screamnext = NULL;
11003 PL_maxscream = -1; /* reinits on demand */
11004 PL_lastscream = NULL;
11006 PL_watchaddr = NULL;
11009 PL_regdummy = proto_perl->Tregdummy;
11010 PL_regprecomp = NULL;
11013 PL_colorset = 0; /* reinits PL_colors[] */
11014 /*PL_colors[6] = {0,0,0,0,0,0};*/
11015 PL_reginput = NULL;
11018 PL_regstartp = (I32*)NULL;
11019 PL_regendp = (I32*)NULL;
11020 PL_reglastparen = (U32*)NULL;
11021 PL_reglastcloseparen = (U32*)NULL;
11023 PL_reg_start_tmp = (char**)NULL;
11024 PL_reg_start_tmpl = 0;
11025 PL_regdata = (struct reg_data*)NULL;
11028 PL_reg_eval_set = 0;
11030 PL_regprogram = (regnode*)NULL;
11032 PL_regcc = (CURCUR*)NULL;
11033 PL_reg_call_cc = (struct re_cc_state*)NULL;
11034 PL_reg_re = (regexp*)NULL;
11035 PL_reg_ganch = NULL;
11037 PL_reg_match_utf8 = FALSE;
11038 PL_reg_magic = (MAGIC*)NULL;
11040 PL_reg_oldcurpm = (PMOP*)NULL;
11041 PL_reg_curpm = (PMOP*)NULL;
11042 PL_reg_oldsaved = NULL;
11043 PL_reg_oldsavedlen = 0;
11044 #ifdef PERL_OLD_COPY_ON_WRITE
11047 PL_reg_maxiter = 0;
11048 PL_reg_leftiter = 0;
11049 PL_reg_poscache = NULL;
11050 PL_reg_poscache_size= 0;
11052 /* RE engine - function pointers */
11053 PL_regcompp = proto_perl->Tregcompp;
11054 PL_regexecp = proto_perl->Tregexecp;
11055 PL_regint_start = proto_perl->Tregint_start;
11056 PL_regint_string = proto_perl->Tregint_string;
11057 PL_regfree = proto_perl->Tregfree;
11059 PL_reginterp_cnt = 0;
11060 PL_reg_starttry = 0;
11062 /* Pluggable optimizer */
11063 PL_peepp = proto_perl->Tpeepp;
11065 PL_stashcache = newHV();
11067 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11068 ptr_table_free(PL_ptr_table);
11069 PL_ptr_table = NULL;
11072 /* Call the ->CLONE method, if it exists, for each of the stashes
11073 identified by sv_dup() above.
11075 while(av_len(param->stashes) != -1) {
11076 HV* const stash = (HV*) av_shift(param->stashes);
11077 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11078 if (cloner && GvCV(cloner)) {
11083 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11085 call_sv((SV*)GvCV(cloner), G_DISCARD);
11091 SvREFCNT_dec(param->stashes);
11093 /* orphaned? eg threads->new inside BEGIN or use */
11094 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11095 (void)SvREFCNT_inc(PL_compcv);
11096 SAVEFREESV(PL_compcv);
11102 #endif /* USE_ITHREADS */
11105 =head1 Unicode Support
11107 =for apidoc sv_recode_to_utf8
11109 The encoding is assumed to be an Encode object, on entry the PV
11110 of the sv is assumed to be octets in that encoding, and the sv
11111 will be converted into Unicode (and UTF-8).
11113 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11114 is not a reference, nothing is done to the sv. If the encoding is not
11115 an C<Encode::XS> Encoding object, bad things will happen.
11116 (See F<lib/encoding.pm> and L<Encode>).
11118 The PV of the sv is returned.
11123 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11126 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11140 Passing sv_yes is wrong - it needs to be or'ed set of constants
11141 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11142 remove converted chars from source.
11144 Both will default the value - let them.
11146 XPUSHs(&PL_sv_yes);
11149 call_method("decode", G_SCALAR);
11153 s = SvPV_const(uni, len);
11154 if (s != SvPVX_const(sv)) {
11155 SvGROW(sv, len + 1);
11156 Move(s, SvPVX(sv), len + 1, char);
11157 SvCUR_set(sv, len);
11164 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11168 =for apidoc sv_cat_decode
11170 The encoding is assumed to be an Encode object, the PV of the ssv is
11171 assumed to be octets in that encoding and decoding the input starts
11172 from the position which (PV + *offset) pointed to. The dsv will be
11173 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11174 when the string tstr appears in decoding output or the input ends on
11175 the PV of the ssv. The value which the offset points will be modified
11176 to the last input position on the ssv.
11178 Returns TRUE if the terminator was found, else returns FALSE.
11183 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11184 SV *ssv, int *offset, char *tstr, int tlen)
11188 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11199 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11200 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11202 call_method("cat_decode", G_SCALAR);
11204 ret = SvTRUE(TOPs);
11205 *offset = SvIV(offsv);
11211 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11216 /* ---------------------------------------------------------------------
11218 * support functions for report_uninit()
11221 /* the maxiumum size of array or hash where we will scan looking
11222 * for the undefined element that triggered the warning */
11224 #define FUV_MAX_SEARCH_SIZE 1000
11226 /* Look for an entry in the hash whose value has the same SV as val;
11227 * If so, return a mortal copy of the key. */
11230 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11233 register HE **array;
11236 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11237 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11240 array = HvARRAY(hv);
11242 for (i=HvMAX(hv); i>0; i--) {
11243 register HE *entry;
11244 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11245 if (HeVAL(entry) != val)
11247 if ( HeVAL(entry) == &PL_sv_undef ||
11248 HeVAL(entry) == &PL_sv_placeholder)
11252 if (HeKLEN(entry) == HEf_SVKEY)
11253 return sv_mortalcopy(HeKEY_sv(entry));
11254 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11260 /* Look for an entry in the array whose value has the same SV as val;
11261 * If so, return the index, otherwise return -1. */
11264 S_find_array_subscript(pTHX_ AV *av, SV* val)
11269 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11270 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11274 for (i=AvFILLp(av); i>=0; i--) {
11275 if (svp[i] == val && svp[i] != &PL_sv_undef)
11281 /* S_varname(): return the name of a variable, optionally with a subscript.
11282 * If gv is non-zero, use the name of that global, along with gvtype (one
11283 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11284 * targ. Depending on the value of the subscript_type flag, return:
11287 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11288 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11289 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11290 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11293 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11294 SV* keyname, I32 aindex, int subscript_type)
11297 SV * const name = sv_newmortal();
11300 buffer[0] = gvtype;
11303 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11305 gv_fullname4(name, gv, buffer, 0);
11307 if ((unsigned int)SvPVX(name)[1] <= 26) {
11309 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11311 /* Swap the 1 unprintable control character for the 2 byte pretty
11312 version - ie substr($name, 1, 1) = $buffer; */
11313 sv_insert(name, 1, 1, buffer, 2);
11318 CV * const cv = find_runcv(&unused);
11322 if (!cv || !CvPADLIST(cv))
11324 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11325 sv = *av_fetch(av, targ, FALSE);
11326 /* SvLEN in a pad name is not to be trusted */
11327 sv_setpv(name, SvPV_nolen_const(sv));
11330 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11331 SV * const sv = newSV(0);
11332 *SvPVX(name) = '$';
11333 Perl_sv_catpvf(aTHX_ name, "{%s}",
11334 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11337 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11338 *SvPVX(name) = '$';
11339 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11341 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11342 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11349 =for apidoc find_uninit_var
11351 Find the name of the undefined variable (if any) that caused the operator o
11352 to issue a "Use of uninitialized value" warning.
11353 If match is true, only return a name if it's value matches uninit_sv.
11354 So roughly speaking, if a unary operator (such as OP_COS) generates a
11355 warning, then following the direct child of the op may yield an
11356 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11357 other hand, with OP_ADD there are two branches to follow, so we only print
11358 the variable name if we get an exact match.
11360 The name is returned as a mortal SV.
11362 Assumes that PL_op is the op that originally triggered the error, and that
11363 PL_comppad/PL_curpad points to the currently executing pad.
11369 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11377 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11378 uninit_sv == &PL_sv_placeholder)))
11381 switch (obase->op_type) {
11388 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11389 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11392 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11394 if (pad) { /* @lex, %lex */
11395 sv = PAD_SVl(obase->op_targ);
11399 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11400 /* @global, %global */
11401 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11404 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11406 else /* @{expr}, %{expr} */
11407 return find_uninit_var(cUNOPx(obase)->op_first,
11411 /* attempt to find a match within the aggregate */
11413 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11415 subscript_type = FUV_SUBSCRIPT_HASH;
11418 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11420 subscript_type = FUV_SUBSCRIPT_ARRAY;
11423 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11426 return varname(gv, hash ? '%' : '@', obase->op_targ,
11427 keysv, index, subscript_type);
11431 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11433 return varname(NULL, '$', obase->op_targ,
11434 NULL, 0, FUV_SUBSCRIPT_NONE);
11437 gv = cGVOPx_gv(obase);
11438 if (!gv || (match && GvSV(gv) != uninit_sv))
11440 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11443 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11446 av = (AV*)PAD_SV(obase->op_targ);
11447 if (!av || SvRMAGICAL(av))
11449 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11450 if (!svp || *svp != uninit_sv)
11453 return varname(NULL, '$', obase->op_targ,
11454 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11457 gv = cGVOPx_gv(obase);
11463 if (!av || SvRMAGICAL(av))
11465 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11466 if (!svp || *svp != uninit_sv)
11469 return varname(gv, '$', 0,
11470 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11475 o = cUNOPx(obase)->op_first;
11476 if (!o || o->op_type != OP_NULL ||
11477 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11479 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11483 if (PL_op == obase)
11484 /* $a[uninit_expr] or $h{uninit_expr} */
11485 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11488 o = cBINOPx(obase)->op_first;
11489 kid = cBINOPx(obase)->op_last;
11491 /* get the av or hv, and optionally the gv */
11493 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11494 sv = PAD_SV(o->op_targ);
11496 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11497 && cUNOPo->op_first->op_type == OP_GV)
11499 gv = cGVOPx_gv(cUNOPo->op_first);
11502 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11507 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11508 /* index is constant */
11512 if (obase->op_type == OP_HELEM) {
11513 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11514 if (!he || HeVAL(he) != uninit_sv)
11518 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11519 if (!svp || *svp != uninit_sv)
11523 if (obase->op_type == OP_HELEM)
11524 return varname(gv, '%', o->op_targ,
11525 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11527 return varname(gv, '@', o->op_targ, NULL,
11528 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11531 /* index is an expression;
11532 * attempt to find a match within the aggregate */
11533 if (obase->op_type == OP_HELEM) {
11534 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11536 return varname(gv, '%', o->op_targ,
11537 keysv, 0, FUV_SUBSCRIPT_HASH);
11540 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11542 return varname(gv, '@', o->op_targ,
11543 NULL, index, FUV_SUBSCRIPT_ARRAY);
11548 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11550 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11556 /* only examine RHS */
11557 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11560 o = cUNOPx(obase)->op_first;
11561 if (o->op_type == OP_PUSHMARK)
11564 if (!o->op_sibling) {
11565 /* one-arg version of open is highly magical */
11567 if (o->op_type == OP_GV) { /* open FOO; */
11569 if (match && GvSV(gv) != uninit_sv)
11571 return varname(gv, '$', 0,
11572 NULL, 0, FUV_SUBSCRIPT_NONE);
11574 /* other possibilities not handled are:
11575 * open $x; or open my $x; should return '${*$x}'
11576 * open expr; should return '$'.expr ideally
11582 /* ops where $_ may be an implicit arg */
11586 if ( !(obase->op_flags & OPf_STACKED)) {
11587 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11588 ? PAD_SVl(obase->op_targ)
11591 sv = sv_newmortal();
11592 sv_setpvn(sv, "$_", 2);
11600 /* skip filehandle as it can't produce 'undef' warning */
11601 o = cUNOPx(obase)->op_first;
11602 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11603 o = o->op_sibling->op_sibling;
11610 match = 1; /* XS or custom code could trigger random warnings */
11615 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11616 return sv_2mortal(newSVpvs("${$/}"));
11621 if (!(obase->op_flags & OPf_KIDS))
11623 o = cUNOPx(obase)->op_first;
11629 /* if all except one arg are constant, or have no side-effects,
11630 * or are optimized away, then it's unambiguous */
11632 for (kid=o; kid; kid = kid->op_sibling) {
11634 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11635 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11636 || (kid->op_type == OP_PUSHMARK)
11640 if (o2) { /* more than one found */
11647 return find_uninit_var(o2, uninit_sv, match);
11649 /* scan all args */
11651 sv = find_uninit_var(o, uninit_sv, 1);
11663 =for apidoc report_uninit
11665 Print appropriate "Use of uninitialized variable" warning
11671 Perl_report_uninit(pTHX_ SV* uninit_sv)
11675 SV* varname = NULL;
11677 varname = find_uninit_var(PL_op, uninit_sv,0);
11679 sv_insert(varname, 0, 0, " ", 1);
11681 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11682 varname ? SvPV_nolen_const(varname) : "",
11683 " in ", OP_DESC(PL_op));
11686 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11692 * c-indentation-style: bsd
11693 * c-basic-offset: 4
11694 * indent-tabs-mode: t
11697 * ex: set ts=8 sts=4 sw=4 noet: