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 double alignthis; /* maybe too big, NV instead ? */
580 unsigned char data[PERL_ARENA_SIZE];
584 union arena* arena; /* the raw storage */
585 size_t size; /* its size ~4k typ */
586 int unit_type; /* useful for arena audits */
587 /* info for sv-heads (eventually)
592 #define ARENAS_PER_SET 256+64 /* x 3words/arena_desc -> ~ 4kb/arena_set */
595 struct arena_set* next;
596 int set_size; /* ie ARENAS_PER_SET */
597 int curr; /* index of next available arena-desc */
598 struct arena_desc set[ARENAS_PER_SET];
604 S_free_arena(pTHX_ void **root) {
606 void ** const next = *(void **)root;
614 =for apidoc sv_free_arenas
616 Deallocate the memory used by all arenas. Note that all the individual SV
617 heads and bodies within the arenas must already have been freed.
622 Perl_sv_free_arenas(pTHX)
629 /* Free arenas here, but be careful about fake ones. (We assume
630 contiguity of the fake ones with the corresponding real ones.) */
632 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
633 svanext = (SV*) SvANY(sva);
634 while (svanext && SvFAKE(svanext))
635 svanext = (SV*) SvANY(svanext);
643 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
645 for (; aroot; aroot = next) {
646 int max = aroot->curr;
647 for (i=0; i<max; i++) {
648 assert(aroot->set[i].arena);
649 Safefree(aroot->set[i].arena);
656 S_free_arena(aTHX_ (void**) PL_body_arenas);
659 for (i=0; i<SVt_LAST; i++)
660 PL_body_roots[i] = 0;
662 Safefree(PL_nice_chunk);
663 PL_nice_chunk = NULL;
664 PL_nice_chunk_size = 0;
670 Here are mid-level routines that manage the allocation of bodies out
671 of the various arenas. There are 5 kinds of arenas:
673 1. SV-head arenas, which are discussed and handled above
674 2. regular body arenas
675 3. arenas for reduced-size bodies
677 5. pte arenas (thread related)
679 Arena types 2 & 3 are chained by body-type off an array of
680 arena-root pointers, which is indexed by svtype. Some of the
681 larger/less used body types are malloced singly, since a large
682 unused block of them is wasteful. Also, several svtypes dont have
683 bodies; the data fits into the sv-head itself. The arena-root
684 pointer thus has a few unused root-pointers (which may be hijacked
685 later for arena types 4,5)
687 3 differs from 2 as an optimization; some body types have several
688 unused fields in the front of the structure (which are kept in-place
689 for consistency). These bodies can be allocated in smaller chunks,
690 because the leading fields arent accessed. Pointers to such bodies
691 are decremented to point at the unused 'ghost' memory, knowing that
692 the pointers are used with offsets to the real memory.
694 HE, HEK arenas are managed separately, with separate code, but may
695 be merge-able later..
697 PTE arenas are not sv-bodies, but they share these mid-level
698 mechanics, so are considered here. The new mid-level mechanics rely
699 on the sv_type of the body being allocated, so we just reserve one
700 of the unused body-slots for PTEs, then use it in those (2) PTE
701 contexts below (line ~10k)
704 /* get_arena(size): when ARENASETS is enabled, this creates
705 custom-sized arenas, otherwize it uses PERL_ARENA_SIZE, as
707 TBD: export properly for hv.c: S_more_he().
710 Perl_get_arena(pTHX_ int arena_size)
715 /* allocate and attach arena */
716 Newx(arp, PERL_ARENA_SIZE, char);
717 arp->next = PL_body_arenas;
718 PL_body_arenas = arp;
722 struct arena_desc* adesc;
723 struct arena_set *newroot, *aroot = (struct arena_set*) PL_body_arenas;
727 arena_size = PERL_ARENA_SIZE;
729 /* may need new arena-set to hold new arena */
730 if (!aroot || aroot->curr >= aroot->set_size) {
731 Newxz(newroot, 1, struct arena_set);
732 newroot->set_size = ARENAS_PER_SET;
733 newroot->next = aroot;
735 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", aroot));
738 /* ok, now have arena-set with at least 1 empty/available arena-desc */
739 curr = aroot->curr++;
740 adesc = &aroot->set[curr];
741 assert(!adesc->arena);
743 /* old fixed-size way
744 Newxz(adesc->arena, 1, union arena);
745 adesc->size = sizeof(union arena);
748 Newxz(adesc->arena, arena_size, char);
749 adesc->size = arena_size;
751 /* adesc->count = sizeof(struct arena)/size; */
753 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p\n", curr, aroot));
760 S_more_bodies (pTHX_ size_t size, svtype sv_type)
763 void ** const root = &PL_body_roots[sv_type];
766 const size_t count = PERL_ARENA_SIZE / size;
768 start = (char*) Perl_get_arena(aTHX_ PERL_ARENA_SIZE); /* get a raw arena */
770 end = start + (count-1) * size;
773 /* The initial slot is used to link the arenas together, so it isn't to be
774 linked into the list of ready-to-use bodies. */
778 *root = (void *)start;
780 while (start < end) {
781 char * const next = start + size;
782 *(void**) start = (void *)next;
790 /* grab a new thing from the free list, allocating more if necessary */
792 /* 1st, the inline version */
794 #define new_body_inline(xpv, size, sv_type) \
796 void ** const r3wt = &PL_body_roots[sv_type]; \
798 xpv = *((void **)(r3wt)) \
799 ? *((void **)(r3wt)) : S_more_bodies(aTHX_ size, sv_type); \
800 *(r3wt) = *(void**)(xpv); \
804 /* now use the inline version in the proper function */
808 /* This isn't being used with -DPURIFY, so don't declare it. Otherwise
809 compilers issue warnings. */
812 S_new_body(pTHX_ size_t size, svtype sv_type)
816 new_body_inline(xpv, size, sv_type);
822 /* return a thing to the free list */
824 #define del_body(thing, root) \
826 void ** const thing_copy = (void **)thing;\
828 *thing_copy = *root; \
829 *root = (void*)thing_copy; \
834 Revisiting type 3 arenas, there are 4 body-types which have some
835 members that are never accessed. They are XPV, XPVIV, XPVAV,
836 XPVHV, which have corresponding types: xpv_allocated,
837 xpviv_allocated, xpvav_allocated, xpvhv_allocated,
839 For these types, the arenas are carved up into *_allocated size
840 chunks, we thus avoid wasted memory for those unaccessed members.
841 When bodies are allocated, we adjust the pointer back in memory by
842 the size of the bit not allocated, so it's as if we allocated the
843 full structure. (But things will all go boom if you write to the
844 part that is "not there", because you'll be overwriting the last
845 members of the preceding structure in memory.)
847 We calculate the correction using the STRUCT_OFFSET macro. For example, if
848 xpv_allocated is the same structure as XPV then the two OFFSETs sum to zero,
849 and the pointer is unchanged. If the allocated structure is smaller (no
850 initial NV actually allocated) then the net effect is to subtract the size
851 of the NV from the pointer, to return a new pointer as if an initial NV were
854 This is the same trick as was used for NV and IV bodies. Ironically it
855 doesn't need to be used for NV bodies any more, because NV is now at the
856 start of the structure. IV bodies don't need it either, because they are
857 no longer allocated. */
859 /* The following 2 arrays hide the above details in a pair of
860 lookup-tables, allowing us to be body-type agnostic.
862 size maps svtype to its body's allocated size.
863 offset maps svtype to the body-pointer adjustment needed
865 NB: elements in latter are 0 or <0, and are added during
866 allocation, and subtracted during deallocation. It may be clearer
867 to invert the values, and call it shrinkage_by_svtype.
870 struct body_details {
871 size_t size; /* Size to allocate */
872 size_t copy; /* Size of structure to copy (may be shorter) */
874 bool cant_upgrade; /* Can upgrade this type */
875 bool zero_nv; /* zero the NV when upgrading from this */
876 bool arena; /* Allocated from an arena */
883 /* With -DPURFIY we allocate everything directly, and don't use arenas.
884 This seems a rather elegant way to simplify some of the code below. */
885 #define HASARENA FALSE
887 #define HASARENA TRUE
889 #define NOARENA FALSE
891 /* A macro to work out the offset needed to subtract from a pointer to (say)
898 to make its members accessible via a pointer to (say)
908 #define relative_STRUCT_OFFSET(longer, shorter, member) \
909 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
911 /* Calculate the length to copy. Specifically work out the length less any
912 final padding the compiler needed to add. See the comment in sv_upgrade
913 for why copying the padding proved to be a bug. */
915 #define copy_length(type, last_member) \
916 STRUCT_OFFSET(type, last_member) \
917 + sizeof (((type*)SvANY((SV*)0))->last_member)
919 static const struct body_details bodies_by_type[] = {
920 {0, 0, 0, FALSE, NONV, NOARENA},
921 /* IVs are in the head, so the allocation size is 0 */
922 {0, sizeof(IV), STRUCT_OFFSET(XPVIV, xiv_iv), FALSE, NONV, NOARENA},
923 /* 8 bytes on most ILP32 with IEEE doubles */
924 {sizeof(NV), sizeof(NV), 0, FALSE, HADNV, HASARENA},
925 /* RVs are in the head now */
926 /* However, this slot is overloaded and used by the pte */
927 {0, 0, 0, FALSE, NONV, NOARENA},
928 /* 8 bytes on most ILP32 with IEEE doubles */
929 {sizeof(xpv_allocated),
930 copy_length(XPV, xpv_len)
931 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
932 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
933 FALSE, NONV, HASARENA},
935 {sizeof(xpviv_allocated),
936 copy_length(XPVIV, xiv_u)
937 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
938 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
939 FALSE, NONV, HASARENA},
941 {sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, FALSE, HADNV, HASARENA},
943 {sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, FALSE, HADNV, HASARENA},
945 {sizeof(XPVBM), sizeof(XPVBM), 0, TRUE, HADNV, HASARENA},
947 {sizeof(XPVGV), sizeof(XPVGV), 0, TRUE, HADNV, HASARENA},
949 {sizeof(XPVLV), sizeof(XPVLV), 0, TRUE, HADNV, HASARENA},
951 {sizeof(xpvav_allocated),
952 copy_length(XPVAV, xmg_stash)
953 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
954 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
955 TRUE, HADNV, HASARENA},
957 {sizeof(xpvhv_allocated),
958 copy_length(XPVHV, xmg_stash)
959 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
960 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
961 TRUE, HADNV, HASARENA},
963 {sizeof(XPVCV), sizeof(XPVCV), 0, TRUE, HADNV, HASARENA},
965 {sizeof(XPVFM), sizeof(XPVFM), 0, TRUE, HADNV, NOARENA},
967 {sizeof(XPVIO), sizeof(XPVIO), 0, TRUE, HADNV, NOARENA}
970 #define new_body_type(sv_type) \
971 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
972 - bodies_by_type[sv_type].offset)
974 #define del_body_type(p, sv_type) \
975 del_body(p, &PL_body_roots[sv_type])
978 #define new_body_allocated(sv_type) \
979 (void *)((char *)S_new_body(aTHX_ bodies_by_type[sv_type].size, sv_type)\
980 - bodies_by_type[sv_type].offset)
982 #define del_body_allocated(p, sv_type) \
983 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
986 #define my_safemalloc(s) (void*)safemalloc(s)
987 #define my_safecalloc(s) (void*)safecalloc(s, 1)
988 #define my_safefree(p) safefree((char*)p)
992 #define new_XNV() my_safemalloc(sizeof(XPVNV))
993 #define del_XNV(p) my_safefree(p)
995 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XPVNV(p) my_safefree(p)
998 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
999 #define del_XPVAV(p) my_safefree(p)
1001 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1002 #define del_XPVHV(p) my_safefree(p)
1004 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1005 #define del_XPVMG(p) my_safefree(p)
1007 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1008 #define del_XPVGV(p) my_safefree(p)
1012 #define new_XNV() new_body_type(SVt_NV)
1013 #define del_XNV(p) del_body_type(p, SVt_NV)
1015 #define new_XPVNV() new_body_type(SVt_PVNV)
1016 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1018 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1019 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1021 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1022 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1024 #define new_XPVMG() new_body_type(SVt_PVMG)
1025 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1027 #define new_XPVGV() new_body_type(SVt_PVGV)
1028 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1032 /* no arena for you! */
1034 #define new_NOARENA(details) \
1035 my_safemalloc((details)->size + (details)->offset)
1036 #define new_NOARENAZ(details) \
1037 my_safecalloc((details)->size + (details)->offset)
1040 =for apidoc sv_upgrade
1042 Upgrade an SV to a more complex form. Generally adds a new body type to the
1043 SV, then copies across as much information as possible from the old body.
1044 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1050 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1055 const U32 old_type = SvTYPE(sv);
1056 const struct body_details *const old_type_details
1057 = bodies_by_type + old_type;
1058 const struct body_details *new_type_details = bodies_by_type + new_type;
1060 if (new_type != SVt_PV && SvIsCOW(sv)) {
1061 sv_force_normal_flags(sv, 0);
1064 if (old_type == new_type)
1067 if (old_type > new_type)
1068 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1069 (int)old_type, (int)new_type);
1072 old_body = SvANY(sv);
1074 /* Copying structures onto other structures that have been neatly zeroed
1075 has a subtle gotcha. Consider XPVMG
1077 +------+------+------+------+------+-------+-------+
1078 | NV | CUR | LEN | IV | MAGIC | STASH |
1079 +------+------+------+------+------+-------+-------+
1080 0 4 8 12 16 20 24 28
1082 where NVs are aligned to 8 bytes, so that sizeof that structure is
1083 actually 32 bytes long, with 4 bytes of padding at the end:
1085 +------+------+------+------+------+-------+-------+------+
1086 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1087 +------+------+------+------+------+-------+-------+------+
1088 0 4 8 12 16 20 24 28 32
1090 so what happens if you allocate memory for this structure:
1092 +------+------+------+------+------+-------+-------+------+------+...
1093 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1094 +------+------+------+------+------+-------+-------+------+------+...
1095 0 4 8 12 16 20 24 28 32 36
1097 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1098 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1099 started out as zero once, but it's quite possible that it isn't. So now,
1100 rather than a nicely zeroed GP, you have it pointing somewhere random.
1103 (In fact, GP ends up pointing at a previous GP structure, because the
1104 principle cause of the padding in XPVMG getting garbage is a copy of
1105 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1107 So we are careful and work out the size of used parts of all the
1114 if (new_type < SVt_PVIV) {
1115 new_type = (new_type == SVt_NV)
1116 ? SVt_PVNV : SVt_PVIV;
1117 new_type_details = bodies_by_type + new_type;
1121 if (new_type < SVt_PVNV) {
1122 new_type = SVt_PVNV;
1123 new_type_details = bodies_by_type + new_type;
1129 assert(new_type > SVt_PV);
1130 assert(SVt_IV < SVt_PV);
1131 assert(SVt_NV < SVt_PV);
1138 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1139 there's no way that it can be safely upgraded, because perl.c
1140 expects to Safefree(SvANY(PL_mess_sv)) */
1141 assert(sv != PL_mess_sv);
1142 /* This flag bit is used to mean other things in other scalar types.
1143 Given that it only has meaning inside the pad, it shouldn't be set
1144 on anything that can get upgraded. */
1145 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
1148 if (old_type_details->cant_upgrade)
1149 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1152 SvFLAGS(sv) &= ~SVTYPEMASK;
1153 SvFLAGS(sv) |= new_type;
1157 Perl_croak(aTHX_ "Can't upgrade to undef");
1159 assert(old_type == SVt_NULL);
1160 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1164 assert(old_type == SVt_NULL);
1165 SvANY(sv) = new_XNV();
1169 assert(old_type == SVt_NULL);
1170 SvANY(sv) = &sv->sv_u.svu_rv;
1174 SvANY(sv) = new_XPVHV();
1177 HvTOTALKEYS(sv) = 0;
1182 SvANY(sv) = new_XPVAV();
1189 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1190 The target created by newSVrv also is, and it can have magic.
1191 However, it never has SvPVX set.
1193 if (old_type >= SVt_RV) {
1194 assert(SvPVX_const(sv) == 0);
1197 /* Could put this in the else clause below, as PVMG must have SvPVX
1198 0 already (the assertion above) */
1201 if (old_type >= SVt_PVMG) {
1202 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_magic);
1203 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1205 SvMAGIC_set(sv, NULL);
1206 SvSTASH_set(sv, NULL);
1212 /* XXX Is this still needed? Was it ever needed? Surely as there is
1213 no route from NV to PVIV, NOK can never be true */
1214 assert(!SvNOKp(sv));
1226 assert(new_type_details->size);
1227 /* We always allocated the full length item with PURIFY. To do this
1228 we fake things so that arena is false for all 16 types.. */
1229 if(new_type_details->arena) {
1230 /* This points to the start of the allocated area. */
1231 new_body_inline(new_body, new_type_details->size, new_type);
1232 Zero(new_body, new_type_details->size, char);
1233 new_body = ((char *)new_body) - new_type_details->offset;
1235 new_body = new_NOARENAZ(new_type_details);
1237 SvANY(sv) = new_body;
1239 if (old_type_details->copy) {
1240 Copy((char *)old_body + old_type_details->offset,
1241 (char *)new_body + old_type_details->offset,
1242 old_type_details->copy, char);
1245 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1246 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1247 * correct 0.0 for us. Otherwise, if the old body didn't have an
1248 * NV slot, but the new one does, then we need to initialise the
1249 * freshly created NV slot with whatever the correct bit pattern is
1251 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1255 if (new_type == SVt_PVIO)
1256 IoPAGE_LEN(sv) = 60;
1257 if (old_type < SVt_RV)
1261 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1262 (unsigned long)new_type);
1265 if (old_type_details->size) {
1266 /* If the old body had an allocated size, then we need to free it. */
1268 my_safefree(old_body);
1270 del_body((void*)((char*)old_body + old_type_details->offset),
1271 &PL_body_roots[old_type]);
1277 =for apidoc sv_backoff
1279 Remove any string offset. You should normally use the C<SvOOK_off> macro
1286 Perl_sv_backoff(pTHX_ register SV *sv)
1289 assert(SvTYPE(sv) != SVt_PVHV);
1290 assert(SvTYPE(sv) != SVt_PVAV);
1292 const char * const s = SvPVX_const(sv);
1293 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1294 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1296 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1298 SvFLAGS(sv) &= ~SVf_OOK;
1305 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1306 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1307 Use the C<SvGROW> wrapper instead.
1313 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1317 #ifdef HAS_64K_LIMIT
1318 if (newlen >= 0x10000) {
1319 PerlIO_printf(Perl_debug_log,
1320 "Allocation too large: %"UVxf"\n", (UV)newlen);
1323 #endif /* HAS_64K_LIMIT */
1326 if (SvTYPE(sv) < SVt_PV) {
1327 sv_upgrade(sv, SVt_PV);
1328 s = SvPVX_mutable(sv);
1330 else if (SvOOK(sv)) { /* pv is offset? */
1332 s = SvPVX_mutable(sv);
1333 if (newlen > SvLEN(sv))
1334 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1335 #ifdef HAS_64K_LIMIT
1336 if (newlen >= 0x10000)
1341 s = SvPVX_mutable(sv);
1343 if (newlen > SvLEN(sv)) { /* need more room? */
1344 newlen = PERL_STRLEN_ROUNDUP(newlen);
1345 if (SvLEN(sv) && s) {
1347 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1353 s = saferealloc(s, newlen);
1356 s = safemalloc(newlen);
1357 if (SvPVX_const(sv) && SvCUR(sv)) {
1358 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1362 SvLEN_set(sv, newlen);
1368 =for apidoc sv_setiv
1370 Copies an integer into the given SV, upgrading first if necessary.
1371 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1377 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1380 SV_CHECK_THINKFIRST_COW_DROP(sv);
1381 switch (SvTYPE(sv)) {
1383 sv_upgrade(sv, SVt_IV);
1386 sv_upgrade(sv, SVt_PVNV);
1390 sv_upgrade(sv, SVt_PVIV);
1399 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1402 (void)SvIOK_only(sv); /* validate number */
1408 =for apidoc sv_setiv_mg
1410 Like C<sv_setiv>, but also handles 'set' magic.
1416 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1423 =for apidoc sv_setuv
1425 Copies an unsigned integer into the given SV, upgrading first if necessary.
1426 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1432 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1434 /* With these two if statements:
1435 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1438 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1440 If you wish to remove them, please benchmark to see what the effect is
1442 if (u <= (UV)IV_MAX) {
1443 sv_setiv(sv, (IV)u);
1452 =for apidoc sv_setuv_mg
1454 Like C<sv_setuv>, but also handles 'set' magic.
1460 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1469 =for apidoc sv_setnv
1471 Copies a double into the given SV, upgrading first if necessary.
1472 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1478 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1481 SV_CHECK_THINKFIRST_COW_DROP(sv);
1482 switch (SvTYPE(sv)) {
1485 sv_upgrade(sv, SVt_NV);
1490 sv_upgrade(sv, SVt_PVNV);
1499 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1503 (void)SvNOK_only(sv); /* validate number */
1508 =for apidoc sv_setnv_mg
1510 Like C<sv_setnv>, but also handles 'set' magic.
1516 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1522 /* Print an "isn't numeric" warning, using a cleaned-up,
1523 * printable version of the offending string
1527 S_not_a_number(pTHX_ SV *sv)
1535 dsv = sv_2mortal(newSVpvs(""));
1536 pv = sv_uni_display(dsv, sv, 10, 0);
1539 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1540 /* each *s can expand to 4 chars + "...\0",
1541 i.e. need room for 8 chars */
1543 const char *s = SvPVX_const(sv);
1544 const char * const end = s + SvCUR(sv);
1545 for ( ; s < end && d < limit; s++ ) {
1547 if (ch & 128 && !isPRINT_LC(ch)) {
1556 else if (ch == '\r') {
1560 else if (ch == '\f') {
1564 else if (ch == '\\') {
1568 else if (ch == '\0') {
1572 else if (isPRINT_LC(ch))
1589 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1590 "Argument \"%s\" isn't numeric in %s", pv,
1593 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1594 "Argument \"%s\" isn't numeric", pv);
1598 =for apidoc looks_like_number
1600 Test if the content of an SV looks like a number (or is a number).
1601 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1602 non-numeric warning), even if your atof() doesn't grok them.
1608 Perl_looks_like_number(pTHX_ SV *sv)
1610 register const char *sbegin;
1614 sbegin = SvPVX_const(sv);
1617 else if (SvPOKp(sv))
1618 sbegin = SvPV_const(sv, len);
1620 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1621 return grok_number(sbegin, len, NULL);
1624 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1625 until proven guilty, assume that things are not that bad... */
1630 As 64 bit platforms often have an NV that doesn't preserve all bits of
1631 an IV (an assumption perl has been based on to date) it becomes necessary
1632 to remove the assumption that the NV always carries enough precision to
1633 recreate the IV whenever needed, and that the NV is the canonical form.
1634 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1635 precision as a side effect of conversion (which would lead to insanity
1636 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1637 1) to distinguish between IV/UV/NV slots that have cached a valid
1638 conversion where precision was lost and IV/UV/NV slots that have a
1639 valid conversion which has lost no precision
1640 2) to ensure that if a numeric conversion to one form is requested that
1641 would lose precision, the precise conversion (or differently
1642 imprecise conversion) is also performed and cached, to prevent
1643 requests for different numeric formats on the same SV causing
1644 lossy conversion chains. (lossless conversion chains are perfectly
1649 SvIOKp is true if the IV slot contains a valid value
1650 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1651 SvNOKp is true if the NV slot contains a valid value
1652 SvNOK is true only if the NV value is accurate
1655 while converting from PV to NV, check to see if converting that NV to an
1656 IV(or UV) would lose accuracy over a direct conversion from PV to
1657 IV(or UV). If it would, cache both conversions, return NV, but mark
1658 SV as IOK NOKp (ie not NOK).
1660 While converting from PV to IV, check to see if converting that IV to an
1661 NV would lose accuracy over a direct conversion from PV to NV. If it
1662 would, cache both conversions, flag similarly.
1664 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1665 correctly because if IV & NV were set NV *always* overruled.
1666 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1667 changes - now IV and NV together means that the two are interchangeable:
1668 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1670 The benefit of this is that operations such as pp_add know that if
1671 SvIOK is true for both left and right operands, then integer addition
1672 can be used instead of floating point (for cases where the result won't
1673 overflow). Before, floating point was always used, which could lead to
1674 loss of precision compared with integer addition.
1676 * making IV and NV equal status should make maths accurate on 64 bit
1678 * may speed up maths somewhat if pp_add and friends start to use
1679 integers when possible instead of fp. (Hopefully the overhead in
1680 looking for SvIOK and checking for overflow will not outweigh the
1681 fp to integer speedup)
1682 * will slow down integer operations (callers of SvIV) on "inaccurate"
1683 values, as the change from SvIOK to SvIOKp will cause a call into
1684 sv_2iv each time rather than a macro access direct to the IV slot
1685 * should speed up number->string conversion on integers as IV is
1686 favoured when IV and NV are equally accurate
1688 ####################################################################
1689 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1690 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1691 On the other hand, SvUOK is true iff UV.
1692 ####################################################################
1694 Your mileage will vary depending your CPU's relative fp to integer
1698 #ifndef NV_PRESERVES_UV
1699 # define IS_NUMBER_UNDERFLOW_IV 1
1700 # define IS_NUMBER_UNDERFLOW_UV 2
1701 # define IS_NUMBER_IV_AND_UV 2
1702 # define IS_NUMBER_OVERFLOW_IV 4
1703 # define IS_NUMBER_OVERFLOW_UV 5
1705 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1707 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1709 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1712 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));
1713 if (SvNVX(sv) < (NV)IV_MIN) {
1714 (void)SvIOKp_on(sv);
1716 SvIV_set(sv, IV_MIN);
1717 return IS_NUMBER_UNDERFLOW_IV;
1719 if (SvNVX(sv) > (NV)UV_MAX) {
1720 (void)SvIOKp_on(sv);
1723 SvUV_set(sv, UV_MAX);
1724 return IS_NUMBER_OVERFLOW_UV;
1726 (void)SvIOKp_on(sv);
1728 /* Can't use strtol etc to convert this string. (See truth table in
1730 if (SvNVX(sv) <= (UV)IV_MAX) {
1731 SvIV_set(sv, I_V(SvNVX(sv)));
1732 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1733 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1735 /* Integer is imprecise. NOK, IOKp */
1737 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1740 SvUV_set(sv, U_V(SvNVX(sv)));
1741 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1742 if (SvUVX(sv) == UV_MAX) {
1743 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1744 possibly be preserved by NV. Hence, it must be overflow.
1746 return IS_NUMBER_OVERFLOW_UV;
1748 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1750 /* Integer is imprecise. NOK, IOKp */
1752 return IS_NUMBER_OVERFLOW_IV;
1754 #endif /* !NV_PRESERVES_UV*/
1757 S_sv_2iuv_common(pTHX_ SV *sv) {
1760 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1761 * without also getting a cached IV/UV from it at the same time
1762 * (ie PV->NV conversion should detect loss of accuracy and cache
1763 * IV or UV at same time to avoid this. */
1764 /* IV-over-UV optimisation - choose to cache IV if possible */
1766 if (SvTYPE(sv) == SVt_NV)
1767 sv_upgrade(sv, SVt_PVNV);
1769 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1770 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1771 certainly cast into the IV range at IV_MAX, whereas the correct
1772 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1774 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1775 SvIV_set(sv, I_V(SvNVX(sv)));
1776 if (SvNVX(sv) == (NV) SvIVX(sv)
1777 #ifndef NV_PRESERVES_UV
1778 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1779 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1780 /* Don't flag it as "accurately an integer" if the number
1781 came from a (by definition imprecise) NV operation, and
1782 we're outside the range of NV integer precision */
1785 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1786 DEBUG_c(PerlIO_printf(Perl_debug_log,
1787 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1793 /* IV not precise. No need to convert from PV, as NV
1794 conversion would already have cached IV if it detected
1795 that PV->IV would be better than PV->NV->IV
1796 flags already correct - don't set public IOK. */
1797 DEBUG_c(PerlIO_printf(Perl_debug_log,
1798 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1803 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1804 but the cast (NV)IV_MIN rounds to a the value less (more
1805 negative) than IV_MIN which happens to be equal to SvNVX ??
1806 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1807 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1808 (NV)UVX == NVX are both true, but the values differ. :-(
1809 Hopefully for 2s complement IV_MIN is something like
1810 0x8000000000000000 which will be exact. NWC */
1813 SvUV_set(sv, U_V(SvNVX(sv)));
1815 (SvNVX(sv) == (NV) SvUVX(sv))
1816 #ifndef NV_PRESERVES_UV
1817 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1818 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1819 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1820 /* Don't flag it as "accurately an integer" if the number
1821 came from a (by definition imprecise) NV operation, and
1822 we're outside the range of NV integer precision */
1827 DEBUG_c(PerlIO_printf(Perl_debug_log,
1828 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1834 else if (SvPOKp(sv) && SvLEN(sv)) {
1836 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1837 /* We want to avoid a possible problem when we cache an IV/ a UV which
1838 may be later translated to an NV, and the resulting NV is not
1839 the same as the direct translation of the initial string
1840 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1841 be careful to ensure that the value with the .456 is around if the
1842 NV value is requested in the future).
1844 This means that if we cache such an IV/a UV, we need to cache the
1845 NV as well. Moreover, we trade speed for space, and do not
1846 cache the NV if we are sure it's not needed.
1849 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1850 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1851 == IS_NUMBER_IN_UV) {
1852 /* It's definitely an integer, only upgrade to PVIV */
1853 if (SvTYPE(sv) < SVt_PVIV)
1854 sv_upgrade(sv, SVt_PVIV);
1856 } else if (SvTYPE(sv) < SVt_PVNV)
1857 sv_upgrade(sv, SVt_PVNV);
1859 /* If NVs preserve UVs then we only use the UV value if we know that
1860 we aren't going to call atof() below. If NVs don't preserve UVs
1861 then the value returned may have more precision than atof() will
1862 return, even though value isn't perfectly accurate. */
1863 if ((numtype & (IS_NUMBER_IN_UV
1864 #ifdef NV_PRESERVES_UV
1867 )) == IS_NUMBER_IN_UV) {
1868 /* This won't turn off the public IOK flag if it was set above */
1869 (void)SvIOKp_on(sv);
1871 if (!(numtype & IS_NUMBER_NEG)) {
1873 if (value <= (UV)IV_MAX) {
1874 SvIV_set(sv, (IV)value);
1876 /* it didn't overflow, and it was positive. */
1877 SvUV_set(sv, value);
1881 /* 2s complement assumption */
1882 if (value <= (UV)IV_MIN) {
1883 SvIV_set(sv, -(IV)value);
1885 /* Too negative for an IV. This is a double upgrade, but
1886 I'm assuming it will be rare. */
1887 if (SvTYPE(sv) < SVt_PVNV)
1888 sv_upgrade(sv, SVt_PVNV);
1892 SvNV_set(sv, -(NV)value);
1893 SvIV_set(sv, IV_MIN);
1897 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
1898 will be in the previous block to set the IV slot, and the next
1899 block to set the NV slot. So no else here. */
1901 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1902 != IS_NUMBER_IN_UV) {
1903 /* It wasn't an (integer that doesn't overflow the UV). */
1904 SvNV_set(sv, Atof(SvPVX_const(sv)));
1906 if (! numtype && ckWARN(WARN_NUMERIC))
1909 #if defined(USE_LONG_DOUBLE)
1910 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
1911 PTR2UV(sv), SvNVX(sv)));
1913 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
1914 PTR2UV(sv), SvNVX(sv)));
1917 #ifdef NV_PRESERVES_UV
1918 (void)SvIOKp_on(sv);
1920 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1921 SvIV_set(sv, I_V(SvNVX(sv)));
1922 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1925 /* Integer is imprecise. NOK, IOKp */
1927 /* UV will not work better than IV */
1929 if (SvNVX(sv) > (NV)UV_MAX) {
1931 /* Integer is inaccurate. NOK, IOKp, is UV */
1932 SvUV_set(sv, UV_MAX);
1934 SvUV_set(sv, U_V(SvNVX(sv)));
1935 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
1936 NV preservse UV so can do correct comparison. */
1937 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1940 /* Integer is imprecise. NOK, IOKp, is UV */
1945 #else /* NV_PRESERVES_UV */
1946 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1947 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
1948 /* The IV/UV slot will have been set from value returned by
1949 grok_number above. The NV slot has just been set using
1952 assert (SvIOKp(sv));
1954 if (((UV)1 << NV_PRESERVES_UV_BITS) >
1955 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
1956 /* Small enough to preserve all bits. */
1957 (void)SvIOKp_on(sv);
1959 SvIV_set(sv, I_V(SvNVX(sv)));
1960 if ((NV)(SvIVX(sv)) == SvNVX(sv))
1962 /* Assumption: first non-preserved integer is < IV_MAX,
1963 this NV is in the preserved range, therefore: */
1964 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
1966 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);
1970 0 0 already failed to read UV.
1971 0 1 already failed to read UV.
1972 1 0 you won't get here in this case. IV/UV
1973 slot set, public IOK, Atof() unneeded.
1974 1 1 already read UV.
1975 so there's no point in sv_2iuv_non_preserve() attempting
1976 to use atol, strtol, strtoul etc. */
1977 sv_2iuv_non_preserve (sv, numtype);
1980 #endif /* NV_PRESERVES_UV */
1984 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
1985 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
1988 if (SvTYPE(sv) < SVt_IV)
1989 /* Typically the caller expects that sv_any is not NULL now. */
1990 sv_upgrade(sv, SVt_IV);
1991 /* Return 0 from the caller. */
1998 =for apidoc sv_2iv_flags
2000 Return the integer value of an SV, doing any necessary string
2001 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2002 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2008 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2013 if (SvGMAGICAL(sv)) {
2014 if (flags & SV_GMAGIC)
2019 return I_V(SvNVX(sv));
2021 if (SvPOKp(sv) && SvLEN(sv)) {
2024 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2026 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2027 == IS_NUMBER_IN_UV) {
2028 /* It's definitely an integer */
2029 if (numtype & IS_NUMBER_NEG) {
2030 if (value < (UV)IV_MIN)
2033 if (value < (UV)IV_MAX)
2038 if (ckWARN(WARN_NUMERIC))
2041 return I_V(Atof(SvPVX_const(sv)));
2046 assert(SvTYPE(sv) >= SVt_PVMG);
2047 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2048 } else if (SvTHINKFIRST(sv)) {
2052 SV * const tmpstr=AMG_CALLun(sv,numer);
2053 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2054 return SvIV(tmpstr);
2057 return PTR2IV(SvRV(sv));
2060 sv_force_normal_flags(sv, 0);
2062 if (SvREADONLY(sv) && !SvOK(sv)) {
2063 if (ckWARN(WARN_UNINITIALIZED))
2069 if (S_sv_2iuv_common(aTHX_ sv))
2072 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2073 PTR2UV(sv),SvIVX(sv)));
2074 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2078 =for apidoc sv_2uv_flags
2080 Return the unsigned integer value of an SV, doing any necessary string
2081 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2082 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2088 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2093 if (SvGMAGICAL(sv)) {
2094 if (flags & SV_GMAGIC)
2099 return U_V(SvNVX(sv));
2100 if (SvPOKp(sv) && SvLEN(sv)) {
2103 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2105 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2106 == IS_NUMBER_IN_UV) {
2107 /* It's definitely an integer */
2108 if (!(numtype & IS_NUMBER_NEG))
2112 if (ckWARN(WARN_NUMERIC))
2115 return U_V(Atof(SvPVX_const(sv)));
2120 assert(SvTYPE(sv) >= SVt_PVMG);
2121 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2122 } else if (SvTHINKFIRST(sv)) {
2126 SV *const tmpstr = AMG_CALLun(sv,numer);
2127 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2128 return SvUV(tmpstr);
2131 return PTR2UV(SvRV(sv));
2134 sv_force_normal_flags(sv, 0);
2136 if (SvREADONLY(sv) && !SvOK(sv)) {
2137 if (ckWARN(WARN_UNINITIALIZED))
2143 if (S_sv_2iuv_common(aTHX_ sv))
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2148 PTR2UV(sv),SvUVX(sv)));
2149 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2155 Return the num value of an SV, doing any necessary string or integer
2156 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2163 Perl_sv_2nv(pTHX_ register SV *sv)
2168 if (SvGMAGICAL(sv)) {
2172 if (SvPOKp(sv) && SvLEN(sv)) {
2173 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2174 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2176 return Atof(SvPVX_const(sv));
2180 return (NV)SvUVX(sv);
2182 return (NV)SvIVX(sv);
2187 assert(SvTYPE(sv) >= SVt_PVMG);
2188 /* This falls through to the report_uninit near the end of the
2190 } else if (SvTHINKFIRST(sv)) {
2194 SV *const tmpstr = AMG_CALLun(sv,numer);
2195 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2196 return SvNV(tmpstr);
2199 return PTR2NV(SvRV(sv));
2202 sv_force_normal_flags(sv, 0);
2204 if (SvREADONLY(sv) && !SvOK(sv)) {
2205 if (ckWARN(WARN_UNINITIALIZED))
2210 if (SvTYPE(sv) < SVt_NV) {
2211 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2212 sv_upgrade(sv, SVt_NV);
2213 #ifdef USE_LONG_DOUBLE
2215 STORE_NUMERIC_LOCAL_SET_STANDARD();
2216 PerlIO_printf(Perl_debug_log,
2217 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2218 PTR2UV(sv), SvNVX(sv));
2219 RESTORE_NUMERIC_LOCAL();
2223 STORE_NUMERIC_LOCAL_SET_STANDARD();
2224 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2225 PTR2UV(sv), SvNVX(sv));
2226 RESTORE_NUMERIC_LOCAL();
2230 else if (SvTYPE(sv) < SVt_PVNV)
2231 sv_upgrade(sv, SVt_PVNV);
2236 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2237 #ifdef NV_PRESERVES_UV
2240 /* Only set the public NV OK flag if this NV preserves the IV */
2241 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2242 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2243 : (SvIVX(sv) == I_V(SvNVX(sv))))
2249 else if (SvPOKp(sv) && SvLEN(sv)) {
2251 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2252 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2254 #ifdef NV_PRESERVES_UV
2255 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2256 == IS_NUMBER_IN_UV) {
2257 /* It's definitely an integer */
2258 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2260 SvNV_set(sv, Atof(SvPVX_const(sv)));
2263 SvNV_set(sv, Atof(SvPVX_const(sv)));
2264 /* Only set the public NV OK flag if this NV preserves the value in
2265 the PV at least as well as an IV/UV would.
2266 Not sure how to do this 100% reliably. */
2267 /* if that shift count is out of range then Configure's test is
2268 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2270 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2271 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2272 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2273 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2274 /* Can't use strtol etc to convert this string, so don't try.
2275 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2278 /* value has been set. It may not be precise. */
2279 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2280 /* 2s complement assumption for (UV)IV_MIN */
2281 SvNOK_on(sv); /* Integer is too negative. */
2286 if (numtype & IS_NUMBER_NEG) {
2287 SvIV_set(sv, -(IV)value);
2288 } else if (value <= (UV)IV_MAX) {
2289 SvIV_set(sv, (IV)value);
2291 SvUV_set(sv, value);
2295 if (numtype & IS_NUMBER_NOT_INT) {
2296 /* I believe that even if the original PV had decimals,
2297 they are lost beyond the limit of the FP precision.
2298 However, neither is canonical, so both only get p
2299 flags. NWC, 2000/11/25 */
2300 /* Both already have p flags, so do nothing */
2302 const NV nv = SvNVX(sv);
2303 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2304 if (SvIVX(sv) == I_V(nv)) {
2307 /* It had no "." so it must be integer. */
2311 /* between IV_MAX and NV(UV_MAX).
2312 Could be slightly > UV_MAX */
2314 if (numtype & IS_NUMBER_NOT_INT) {
2315 /* UV and NV both imprecise. */
2317 const UV nv_as_uv = U_V(nv);
2319 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2328 #endif /* NV_PRESERVES_UV */
2331 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2333 assert (SvTYPE(sv) >= SVt_NV);
2334 /* Typically the caller expects that sv_any is not NULL now. */
2335 /* XXX Ilya implies that this is a bug in callers that assume this
2336 and ideally should be fixed. */
2339 #if defined(USE_LONG_DOUBLE)
2341 STORE_NUMERIC_LOCAL_SET_STANDARD();
2342 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2343 PTR2UV(sv), SvNVX(sv));
2344 RESTORE_NUMERIC_LOCAL();
2348 STORE_NUMERIC_LOCAL_SET_STANDARD();
2349 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2350 PTR2UV(sv), SvNVX(sv));
2351 RESTORE_NUMERIC_LOCAL();
2357 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2358 * UV as a string towards the end of buf, and return pointers to start and
2361 * We assume that buf is at least TYPE_CHARS(UV) long.
2365 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2367 char *ptr = buf + TYPE_CHARS(UV);
2368 char * const ebuf = ptr;
2381 *--ptr = '0' + (char)(uv % 10);
2389 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2390 * a regexp to its stringified form.
2394 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2396 const regexp * const re = (regexp *)mg->mg_obj;
2399 const char *fptr = "msix";
2404 bool need_newline = 0;
2405 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2407 while((ch = *fptr++)) {
2409 reflags[left++] = ch;
2412 reflags[right--] = ch;
2417 reflags[left] = '-';
2421 mg->mg_len = re->prelen + 4 + left;
2423 * If /x was used, we have to worry about a regex ending with a
2424 * comment later being embedded within another regex. If so, we don't
2425 * want this regex's "commentization" to leak out to the right part of
2426 * the enclosing regex, we must cap it with a newline.
2428 * So, if /x was used, we scan backwards from the end of the regex. If
2429 * we find a '#' before we find a newline, we need to add a newline
2430 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2431 * we don't need to add anything. -jfriedl
2433 if (PMf_EXTENDED & re->reganch) {
2434 const char *endptr = re->precomp + re->prelen;
2435 while (endptr >= re->precomp) {
2436 const char c = *(endptr--);
2438 break; /* don't need another */
2440 /* we end while in a comment, so we need a newline */
2441 mg->mg_len++; /* save space for it */
2442 need_newline = 1; /* note to add it */
2448 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2449 mg->mg_ptr[0] = '(';
2450 mg->mg_ptr[1] = '?';
2451 Copy(reflags, mg->mg_ptr+2, left, char);
2452 *(mg->mg_ptr+left+2) = ':';
2453 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2455 mg->mg_ptr[mg->mg_len - 2] = '\n';
2456 mg->mg_ptr[mg->mg_len - 1] = ')';
2457 mg->mg_ptr[mg->mg_len] = 0;
2459 PL_reginterp_cnt += re->program[0].next_off;
2461 if (re->reganch & ROPT_UTF8)
2471 =for apidoc sv_2pv_flags
2473 Returns a pointer to the string value of an SV, and sets *lp to its length.
2474 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2476 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2477 usually end up here too.
2483 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2493 if (SvGMAGICAL(sv)) {
2494 if (flags & SV_GMAGIC)
2499 if (flags & SV_MUTABLE_RETURN)
2500 return SvPVX_mutable(sv);
2501 if (flags & SV_CONST_RETURN)
2502 return (char *)SvPVX_const(sv);
2505 if (SvIOKp(sv) || SvNOKp(sv)) {
2506 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2510 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2511 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2513 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2516 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
2517 /* Sneaky stuff here */
2518 SV * const tsv = newSVpvn(tbuf, len);
2528 #ifdef FIXNEGATIVEZERO
2529 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2535 SvUPGRADE(sv, SVt_PV);
2538 s = SvGROW_mutable(sv, len + 1);
2541 return memcpy(s, tbuf, len + 1);
2547 assert(SvTYPE(sv) >= SVt_PVMG);
2548 /* This falls through to the report_uninit near the end of the
2550 } else if (SvTHINKFIRST(sv)) {
2554 SV *const tmpstr = AMG_CALLun(sv,string);
2555 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2557 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2561 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2562 if (flags & SV_CONST_RETURN) {
2563 pv = (char *) SvPVX_const(tmpstr);
2565 pv = (flags & SV_MUTABLE_RETURN)
2566 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2569 *lp = SvCUR(tmpstr);
2571 pv = sv_2pv_flags(tmpstr, lp, flags);
2583 const SV *const referent = (SV*)SvRV(sv);
2586 tsv = sv_2mortal(newSVpvs("NULLREF"));
2587 } else if (SvTYPE(referent) == SVt_PVMG
2588 && ((SvFLAGS(referent) &
2589 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2590 == (SVs_OBJECT|SVs_SMG))
2591 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2592 return stringify_regexp(sv, mg, lp);
2594 const char *const typestr = sv_reftype(referent, 0);
2596 tsv = sv_newmortal();
2597 if (SvOBJECT(referent)) {
2598 const char *const name = HvNAME_get(SvSTASH(referent));
2599 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2600 name ? name : "__ANON__" , typestr,
2604 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2612 if (SvREADONLY(sv) && !SvOK(sv)) {
2613 if (ckWARN(WARN_UNINITIALIZED))
2620 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2621 /* I'm assuming that if both IV and NV are equally valid then
2622 converting the IV is going to be more efficient */
2623 const U32 isIOK = SvIOK(sv);
2624 const U32 isUIOK = SvIsUV(sv);
2625 char buf[TYPE_CHARS(UV)];
2628 if (SvTYPE(sv) < SVt_PVIV)
2629 sv_upgrade(sv, SVt_PVIV);
2630 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2631 /* inlined from sv_setpvn */
2632 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2633 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2634 SvCUR_set(sv, ebuf - ptr);
2644 else if (SvNOKp(sv)) {
2645 const int olderrno = errno;
2646 if (SvTYPE(sv) < SVt_PVNV)
2647 sv_upgrade(sv, SVt_PVNV);
2648 /* The +20 is pure guesswork. Configure test needed. --jhi */
2649 s = SvGROW_mutable(sv, NV_DIG + 20);
2650 /* some Xenix systems wipe out errno here */
2652 if (SvNVX(sv) == 0.0)
2653 (void)strcpy(s,"0");
2657 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2660 #ifdef FIXNEGATIVEZERO
2661 if (*s == '-' && s[1] == '0' && !s[2])
2671 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2675 if (SvTYPE(sv) < SVt_PV)
2676 /* Typically the caller expects that sv_any is not NULL now. */
2677 sv_upgrade(sv, SVt_PV);
2681 const STRLEN len = s - SvPVX_const(sv);
2687 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2688 PTR2UV(sv),SvPVX_const(sv)));
2689 if (flags & SV_CONST_RETURN)
2690 return (char *)SvPVX_const(sv);
2691 if (flags & SV_MUTABLE_RETURN)
2692 return SvPVX_mutable(sv);
2697 =for apidoc sv_copypv
2699 Copies a stringified representation of the source SV into the
2700 destination SV. Automatically performs any necessary mg_get and
2701 coercion of numeric values into strings. Guaranteed to preserve
2702 UTF-8 flag even from overloaded objects. Similar in nature to
2703 sv_2pv[_flags] but operates directly on an SV instead of just the
2704 string. Mostly uses sv_2pv_flags to do its work, except when that
2705 would lose the UTF-8'ness of the PV.
2711 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2714 const char * const s = SvPV_const(ssv,len);
2715 sv_setpvn(dsv,s,len);
2723 =for apidoc sv_2pvbyte
2725 Return a pointer to the byte-encoded representation of the SV, and set *lp
2726 to its length. May cause the SV to be downgraded from UTF-8 as a
2729 Usually accessed via the C<SvPVbyte> macro.
2735 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2737 sv_utf8_downgrade(sv,0);
2738 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2742 =for apidoc sv_2pvutf8
2744 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2745 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2747 Usually accessed via the C<SvPVutf8> macro.
2753 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2755 sv_utf8_upgrade(sv);
2756 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2761 =for apidoc sv_2bool
2763 This function is only called on magical items, and is only used by
2764 sv_true() or its macro equivalent.
2770 Perl_sv_2bool(pTHX_ register SV *sv)
2779 SV * const tmpsv = AMG_CALLun(sv,bool_);
2780 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2781 return (bool)SvTRUE(tmpsv);
2783 return SvRV(sv) != 0;
2786 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2788 (*sv->sv_u.svu_pv > '0' ||
2789 Xpvtmp->xpv_cur > 1 ||
2790 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2797 return SvIVX(sv) != 0;
2800 return SvNVX(sv) != 0.0;
2808 =for apidoc sv_utf8_upgrade
2810 Converts the PV of an SV to its UTF-8-encoded form.
2811 Forces the SV to string form if it is not already.
2812 Always sets the SvUTF8 flag to avoid future validity checks even
2813 if all the bytes have hibit clear.
2815 This is not as a general purpose byte encoding to Unicode interface:
2816 use the Encode extension for that.
2818 =for apidoc sv_utf8_upgrade_flags
2820 Converts the PV of an SV to its UTF-8-encoded form.
2821 Forces the SV to string form if it is not already.
2822 Always sets the SvUTF8 flag to avoid future validity checks even
2823 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2824 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2825 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2827 This is not as a general purpose byte encoding to Unicode interface:
2828 use the Encode extension for that.
2834 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2837 if (sv == &PL_sv_undef)
2841 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2842 (void) sv_2pv_flags(sv,&len, flags);
2846 (void) SvPV_force(sv,len);
2855 sv_force_normal_flags(sv, 0);
2858 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2859 sv_recode_to_utf8(sv, PL_encoding);
2860 else { /* Assume Latin-1/EBCDIC */
2861 /* This function could be much more efficient if we
2862 * had a FLAG in SVs to signal if there are any hibit
2863 * chars in the PV. Given that there isn't such a flag
2864 * make the loop as fast as possible. */
2865 const U8 * const s = (U8 *) SvPVX_const(sv);
2866 const U8 * const e = (U8 *) SvEND(sv);
2871 /* Check for hi bit */
2872 if (!NATIVE_IS_INVARIANT(ch)) {
2873 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2874 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2876 SvPV_free(sv); /* No longer using what was there before. */
2877 SvPV_set(sv, (char*)recoded);
2878 SvCUR_set(sv, len - 1);
2879 SvLEN_set(sv, len); /* No longer know the real size. */
2883 /* Mark as UTF-8 even if no hibit - saves scanning loop */
2890 =for apidoc sv_utf8_downgrade
2892 Attempts to convert the PV of an SV from characters to bytes.
2893 If the PV contains a character beyond byte, this conversion will fail;
2894 in this case, either returns false or, if C<fail_ok> is not
2897 This is not as a general purpose Unicode to byte encoding interface:
2898 use the Encode extension for that.
2904 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
2907 if (SvPOKp(sv) && SvUTF8(sv)) {
2913 sv_force_normal_flags(sv, 0);
2915 s = (U8 *) SvPV(sv, len);
2916 if (!utf8_to_bytes(s, &len)) {
2921 Perl_croak(aTHX_ "Wide character in %s",
2924 Perl_croak(aTHX_ "Wide character");
2935 =for apidoc sv_utf8_encode
2937 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
2938 flag off so that it looks like octets again.
2944 Perl_sv_utf8_encode(pTHX_ register SV *sv)
2946 (void) sv_utf8_upgrade(sv);
2948 sv_force_normal_flags(sv, 0);
2950 if (SvREADONLY(sv)) {
2951 Perl_croak(aTHX_ PL_no_modify);
2957 =for apidoc sv_utf8_decode
2959 If the PV of the SV is an octet sequence in UTF-8
2960 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
2961 so that it looks like a character. If the PV contains only single-byte
2962 characters, the C<SvUTF8> flag stays being off.
2963 Scans PV for validity and returns false if the PV is invalid UTF-8.
2969 Perl_sv_utf8_decode(pTHX_ register SV *sv)
2975 /* The octets may have got themselves encoded - get them back as
2978 if (!sv_utf8_downgrade(sv, TRUE))
2981 /* it is actually just a matter of turning the utf8 flag on, but
2982 * we want to make sure everything inside is valid utf8 first.
2984 c = (const U8 *) SvPVX_const(sv);
2985 if (!is_utf8_string(c, SvCUR(sv)+1))
2987 e = (const U8 *) SvEND(sv);
2990 if (!UTF8_IS_INVARIANT(ch)) {
3000 =for apidoc sv_setsv
3002 Copies the contents of the source SV C<ssv> into the destination SV
3003 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3004 function if the source SV needs to be reused. Does not handle 'set' magic.
3005 Loosely speaking, it performs a copy-by-value, obliterating any previous
3006 content of the destination.
3008 You probably want to use one of the assortment of wrappers, such as
3009 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3010 C<SvSetMagicSV_nosteal>.
3012 =for apidoc sv_setsv_flags
3014 Copies the contents of the source SV C<ssv> into the destination SV
3015 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3016 function if the source SV needs to be reused. Does not handle 'set' magic.
3017 Loosely speaking, it performs a copy-by-value, obliterating any previous
3018 content of the destination.
3019 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3020 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3021 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3022 and C<sv_setsv_nomg> are implemented in terms of this function.
3024 You probably want to use one of the assortment of wrappers, such as
3025 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3026 C<SvSetMagicSV_nosteal>.
3028 This is the primary function for copying scalars, and most other
3029 copy-ish functions and macros use this underneath.
3035 S_glob_assign(pTHX_ SV *dstr, SV *sstr, const int dtype)
3037 if (dtype != SVt_PVGV) {
3038 const char * const name = GvNAME(sstr);
3039 const STRLEN len = GvNAMELEN(sstr);
3040 /* don't upgrade SVt_PVLV: it can hold a glob */
3041 if (dtype != SVt_PVLV)
3042 sv_upgrade(dstr, SVt_PVGV);
3043 sv_magic(dstr, dstr, PERL_MAGIC_glob, NULL, 0);
3044 GvSTASH(dstr) = GvSTASH(sstr);
3046 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3047 GvNAME(dstr) = savepvn(name, len);
3048 GvNAMELEN(dstr) = len;
3049 SvFAKE_on(dstr); /* can coerce to non-glob */
3052 #ifdef GV_UNIQUE_CHECK
3053 if (GvUNIQUE((GV*)dstr)) {
3054 Perl_croak(aTHX_ PL_no_modify);
3058 (void)SvOK_off(dstr);
3059 GvINTRO_off(dstr); /* one-shot flag */
3061 GvGP(dstr) = gp_ref(GvGP(sstr));
3062 if (SvTAINTED(sstr))
3064 if (GvIMPORTED(dstr) != GVf_IMPORTED
3065 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3067 GvIMPORTED_on(dstr);
3074 S_pvgv_assign(pTHX_ SV *dstr, SV *sstr) {
3075 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3077 const int intro = GvINTRO(dstr);
3079 #ifdef GV_UNIQUE_CHECK
3080 if (GvUNIQUE((GV*)dstr)) {
3081 Perl_croak(aTHX_ PL_no_modify);
3086 GvINTRO_off(dstr); /* one-shot flag */
3087 GvLINE(dstr) = CopLINE(PL_curcop);
3088 GvEGV(dstr) = (GV*)dstr;
3091 switch (SvTYPE(sref)) {
3094 SAVEGENERICSV(GvAV(dstr));
3096 dref = (SV*)GvAV(dstr);
3097 GvAV(dstr) = (AV*)sref;
3098 if (!GvIMPORTED_AV(dstr)
3099 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3101 GvIMPORTED_AV_on(dstr);
3106 SAVEGENERICSV(GvHV(dstr));
3108 dref = (SV*)GvHV(dstr);
3109 GvHV(dstr) = (HV*)sref;
3110 if (!GvIMPORTED_HV(dstr)
3111 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3113 GvIMPORTED_HV_on(dstr);
3118 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3119 SvREFCNT_dec(GvCV(dstr));
3121 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3122 PL_sub_generation++;
3124 SAVEGENERICSV(GvCV(dstr));
3127 dref = (SV*)GvCV(dstr);
3128 if (GvCV(dstr) != (CV*)sref) {
3129 CV* const cv = GvCV(dstr);
3131 if (!GvCVGEN((GV*)dstr) &&
3132 (CvROOT(cv) || CvXSUB(cv)))
3134 /* Redefining a sub - warning is mandatory if
3135 it was a const and its value changed. */
3136 if (CvCONST(cv) && CvCONST((CV*)sref)
3137 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3138 /* They are 2 constant subroutines generated from
3139 the same constant. This probably means that
3140 they are really the "same" proxy subroutine
3141 instantiated in 2 places. Most likely this is
3142 when a constant is exported twice. Don't warn.
3145 else if (ckWARN(WARN_REDEFINE)
3147 && (!CvCONST((CV*)sref)
3148 || sv_cmp(cv_const_sv(cv),
3149 cv_const_sv((CV*)sref))))) {
3150 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3152 ? "Constant subroutine %s::%s redefined"
3153 : "Subroutine %s::%s redefined",
3154 HvNAME_get(GvSTASH((GV*)dstr)),
3155 GvENAME((GV*)dstr));
3159 cv_ckproto(cv, (GV*)dstr,
3160 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3162 GvCV(dstr) = (CV*)sref;
3163 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3164 GvASSUMECV_on(dstr);
3165 PL_sub_generation++;
3167 if (!GvIMPORTED_CV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3168 GvIMPORTED_CV_on(dstr);
3173 SAVEGENERICSV(GvIOp(dstr));
3175 dref = (SV*)GvIOp(dstr);
3176 GvIOp(dstr) = (IO*)sref;
3180 SAVEGENERICSV(GvFORM(dstr));
3182 dref = (SV*)GvFORM(dstr);
3183 GvFORM(dstr) = (CV*)sref;
3187 SAVEGENERICSV(GvSV(dstr));
3189 dref = (SV*)GvSV(dstr);
3191 if (!GvIMPORTED_SV(dstr) && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3192 GvIMPORTED_SV_on(dstr);
3198 if (SvTAINTED(sstr))
3204 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3207 register U32 sflags;
3213 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3215 sstr = &PL_sv_undef;
3216 stype = SvTYPE(sstr);
3217 dtype = SvTYPE(dstr);
3222 /* need to nuke the magic */
3224 SvRMAGICAL_off(dstr);
3227 /* There's a lot of redundancy below but we're going for speed here */
3232 if (dtype != SVt_PVGV) {
3233 (void)SvOK_off(dstr);
3241 sv_upgrade(dstr, SVt_IV);
3244 sv_upgrade(dstr, SVt_PVNV);
3248 sv_upgrade(dstr, SVt_PVIV);
3251 (void)SvIOK_only(dstr);
3252 SvIV_set(dstr, SvIVX(sstr));
3255 /* SvTAINTED can only be true if the SV has taint magic, which in
3256 turn means that the SV type is PVMG (or greater). This is the
3257 case statement for SVt_IV, so this cannot be true (whatever gcov
3259 assert(!SvTAINTED(sstr));
3269 sv_upgrade(dstr, SVt_NV);
3274 sv_upgrade(dstr, SVt_PVNV);
3277 SvNV_set(dstr, SvNVX(sstr));
3278 (void)SvNOK_only(dstr);
3279 /* SvTAINTED can only be true if the SV has taint magic, which in
3280 turn means that the SV type is PVMG (or greater). This is the
3281 case statement for SVt_NV, so this cannot be true (whatever gcov
3283 assert(!SvTAINTED(sstr));
3290 sv_upgrade(dstr, SVt_RV);
3291 else if (dtype == SVt_PVGV &&
3292 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3295 if (GvIMPORTED(dstr) != GVf_IMPORTED
3296 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3298 GvIMPORTED_on(dstr);
3303 S_glob_assign(aTHX_ dstr, sstr, dtype);
3308 #ifdef PERL_OLD_COPY_ON_WRITE
3309 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3310 if (dtype < SVt_PVIV)
3311 sv_upgrade(dstr, SVt_PVIV);
3318 sv_upgrade(dstr, SVt_PV);
3321 if (dtype < SVt_PVIV)
3322 sv_upgrade(dstr, SVt_PVIV);
3325 if (dtype < SVt_PVNV)
3326 sv_upgrade(dstr, SVt_PVNV);
3333 const char * const type = sv_reftype(sstr,0);
3335 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3337 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3342 if (dtype <= SVt_PVGV) {
3343 S_glob_assign(aTHX_ dstr, sstr, dtype);
3349 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3351 if ((int)SvTYPE(sstr) != stype) {
3352 stype = SvTYPE(sstr);
3353 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3354 S_glob_assign(aTHX_ dstr, sstr, dtype);
3359 if (stype == SVt_PVLV)
3360 SvUPGRADE(dstr, SVt_PVNV);
3362 SvUPGRADE(dstr, (U32)stype);
3365 sflags = SvFLAGS(sstr);
3367 if (sflags & SVf_ROK) {
3368 if (dtype >= SVt_PV) {
3369 if (dtype == SVt_PVGV) {
3370 S_pvgv_assign(aTHX_ dstr, sstr);
3373 if (SvPVX_const(dstr)) {
3379 (void)SvOK_off(dstr);
3380 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3381 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3382 assert(!(sflags & SVp_NOK));
3383 assert(!(sflags & SVp_IOK));
3384 assert(!(sflags & SVf_NOK));
3385 assert(!(sflags & SVf_IOK));
3387 else if (sflags & SVp_POK) {
3391 * Check to see if we can just swipe the string. If so, it's a
3392 * possible small lose on short strings, but a big win on long ones.
3393 * It might even be a win on short strings if SvPVX_const(dstr)
3394 * has to be allocated and SvPVX_const(sstr) has to be freed.
3397 /* Whichever path we take through the next code, we want this true,
3398 and doing it now facilitates the COW check. */
3399 (void)SvPOK_only(dstr);
3402 /* We're not already COW */
3403 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3404 #ifndef PERL_OLD_COPY_ON_WRITE
3405 /* or we are, but dstr isn't a suitable target. */
3406 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3411 (sflags & SVs_TEMP) && /* slated for free anyway? */
3412 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3413 (!(flags & SV_NOSTEAL)) &&
3414 /* and we're allowed to steal temps */
3415 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3416 SvLEN(sstr) && /* and really is a string */
3417 /* and won't be needed again, potentially */
3418 !(PL_op && PL_op->op_type == OP_AASSIGN))
3419 #ifdef PERL_OLD_COPY_ON_WRITE
3420 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3421 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3422 && SvTYPE(sstr) >= SVt_PVIV)
3425 /* Failed the swipe test, and it's not a shared hash key either.
3426 Have to copy the string. */
3427 STRLEN len = SvCUR(sstr);
3428 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3429 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3430 SvCUR_set(dstr, len);
3431 *SvEND(dstr) = '\0';
3433 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3435 /* Either it's a shared hash key, or it's suitable for
3436 copy-on-write or we can swipe the string. */
3438 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3442 #ifdef PERL_OLD_COPY_ON_WRITE
3444 /* I believe I should acquire a global SV mutex if
3445 it's a COW sv (not a shared hash key) to stop
3446 it going un copy-on-write.
3447 If the source SV has gone un copy on write between up there
3448 and down here, then (assert() that) it is of the correct
3449 form to make it copy on write again */
3450 if ((sflags & (SVf_FAKE | SVf_READONLY))
3451 != (SVf_FAKE | SVf_READONLY)) {
3452 SvREADONLY_on(sstr);
3454 /* Make the source SV into a loop of 1.
3455 (about to become 2) */
3456 SV_COW_NEXT_SV_SET(sstr, sstr);
3460 /* Initial code is common. */
3461 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3466 /* making another shared SV. */
3467 STRLEN cur = SvCUR(sstr);
3468 STRLEN len = SvLEN(sstr);
3469 #ifdef PERL_OLD_COPY_ON_WRITE
3471 assert (SvTYPE(dstr) >= SVt_PVIV);
3472 /* SvIsCOW_normal */
3473 /* splice us in between source and next-after-source. */
3474 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3475 SV_COW_NEXT_SV_SET(sstr, dstr);
3476 SvPV_set(dstr, SvPVX_mutable(sstr));
3480 /* SvIsCOW_shared_hash */
3481 DEBUG_C(PerlIO_printf(Perl_debug_log,
3482 "Copy on write: Sharing hash\n"));
3484 assert (SvTYPE(dstr) >= SVt_PV);
3486 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3488 SvLEN_set(dstr, len);
3489 SvCUR_set(dstr, cur);
3490 SvREADONLY_on(dstr);
3492 /* Relesase a global SV mutex. */
3495 { /* Passes the swipe test. */
3496 SvPV_set(dstr, SvPVX_mutable(sstr));
3497 SvLEN_set(dstr, SvLEN(sstr));
3498 SvCUR_set(dstr, SvCUR(sstr));
3501 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3502 SvPV_set(sstr, NULL);
3508 if (sflags & SVp_NOK) {
3509 SvNV_set(dstr, SvNVX(sstr));
3511 if (sflags & SVp_IOK) {
3512 SvRELEASE_IVX(dstr);
3513 SvIV_set(dstr, SvIVX(sstr));
3514 /* Must do this otherwise some other overloaded use of 0x80000000
3515 gets confused. I guess SVpbm_VALID */
3516 if (sflags & SVf_IVisUV)
3519 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3521 const MAGIC * const smg = SvVOK(sstr);
3523 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3524 smg->mg_ptr, smg->mg_len);
3525 SvRMAGICAL_on(dstr);
3529 else if (sflags & (SVp_IOK|SVp_NOK)) {
3530 (void)SvOK_off(dstr);
3531 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3532 if (sflags & SVp_IOK) {
3533 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3534 SvIV_set(dstr, SvIVX(sstr));
3536 if (sflags & SVp_NOK) {
3537 SvFLAGS(dstr) |= sflags & (SVf_NOK|SVp_NOK);
3538 SvNV_set(dstr, SvNVX(sstr));
3542 if (dtype == SVt_PVGV) {
3543 if (ckWARN(WARN_MISC))
3544 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
3547 (void)SvOK_off(dstr);
3549 if (SvTAINTED(sstr))
3554 =for apidoc sv_setsv_mg
3556 Like C<sv_setsv>, but also handles 'set' magic.
3562 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3564 sv_setsv(dstr,sstr);
3568 #ifdef PERL_OLD_COPY_ON_WRITE
3570 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3572 STRLEN cur = SvCUR(sstr);
3573 STRLEN len = SvLEN(sstr);
3574 register char *new_pv;
3577 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3585 if (SvTHINKFIRST(dstr))
3586 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3587 else if (SvPVX_const(dstr))
3588 Safefree(SvPVX_const(dstr));
3592 SvUPGRADE(dstr, SVt_PVIV);
3594 assert (SvPOK(sstr));
3595 assert (SvPOKp(sstr));
3596 assert (!SvIOK(sstr));
3597 assert (!SvIOKp(sstr));
3598 assert (!SvNOK(sstr));
3599 assert (!SvNOKp(sstr));
3601 if (SvIsCOW(sstr)) {
3603 if (SvLEN(sstr) == 0) {
3604 /* source is a COW shared hash key. */
3605 DEBUG_C(PerlIO_printf(Perl_debug_log,
3606 "Fast copy on write: Sharing hash\n"));
3607 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3610 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3612 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3613 SvUPGRADE(sstr, SVt_PVIV);
3614 SvREADONLY_on(sstr);
3616 DEBUG_C(PerlIO_printf(Perl_debug_log,
3617 "Fast copy on write: Converting sstr to COW\n"));
3618 SV_COW_NEXT_SV_SET(dstr, sstr);
3620 SV_COW_NEXT_SV_SET(sstr, dstr);
3621 new_pv = SvPVX_mutable(sstr);
3624 SvPV_set(dstr, new_pv);
3625 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3628 SvLEN_set(dstr, len);
3629 SvCUR_set(dstr, cur);
3638 =for apidoc sv_setpvn
3640 Copies a string into an SV. The C<len> parameter indicates the number of
3641 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3642 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3648 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3651 register char *dptr;
3653 SV_CHECK_THINKFIRST_COW_DROP(sv);
3659 /* len is STRLEN which is unsigned, need to copy to signed */
3662 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3664 SvUPGRADE(sv, SVt_PV);
3666 dptr = SvGROW(sv, len + 1);
3667 Move(ptr,dptr,len,char);
3670 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3675 =for apidoc sv_setpvn_mg
3677 Like C<sv_setpvn>, but also handles 'set' magic.
3683 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3685 sv_setpvn(sv,ptr,len);
3690 =for apidoc sv_setpv
3692 Copies a string into an SV. The string must be null-terminated. Does not
3693 handle 'set' magic. See C<sv_setpv_mg>.
3699 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3702 register STRLEN len;
3704 SV_CHECK_THINKFIRST_COW_DROP(sv);
3710 SvUPGRADE(sv, SVt_PV);
3712 SvGROW(sv, len + 1);
3713 Move(ptr,SvPVX(sv),len+1,char);
3715 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3720 =for apidoc sv_setpv_mg
3722 Like C<sv_setpv>, but also handles 'set' magic.
3728 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3735 =for apidoc sv_usepvn
3737 Tells an SV to use C<ptr> to find its string value. Normally the string is
3738 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3739 The C<ptr> should point to memory that was allocated by C<malloc>. The
3740 string length, C<len>, must be supplied. This function will realloc the
3741 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3742 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3743 See C<sv_usepvn_mg>.
3749 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3753 SV_CHECK_THINKFIRST_COW_DROP(sv);
3754 SvUPGRADE(sv, SVt_PV);
3759 if (SvPVX_const(sv))
3762 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3763 ptr = saferealloc (ptr, allocate);
3766 SvLEN_set(sv, allocate);
3768 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3773 =for apidoc sv_usepvn_mg
3775 Like C<sv_usepvn>, but also handles 'set' magic.
3781 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3783 sv_usepvn(sv,ptr,len);
3787 #ifdef PERL_OLD_COPY_ON_WRITE
3788 /* Need to do this *after* making the SV normal, as we need the buffer
3789 pointer to remain valid until after we've copied it. If we let go too early,
3790 another thread could invalidate it by unsharing last of the same hash key
3791 (which it can do by means other than releasing copy-on-write Svs)
3792 or by changing the other copy-on-write SVs in the loop. */
3794 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3796 if (len) { /* this SV was SvIsCOW_normal(sv) */
3797 /* we need to find the SV pointing to us. */
3798 SV *current = SV_COW_NEXT_SV(after);
3800 if (current == sv) {
3801 /* The SV we point to points back to us (there were only two of us
3803 Hence other SV is no longer copy on write either. */
3805 SvREADONLY_off(after);
3807 /* We need to follow the pointers around the loop. */
3809 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3812 /* don't loop forever if the structure is bust, and we have
3813 a pointer into a closed loop. */
3814 assert (current != after);
3815 assert (SvPVX_const(current) == pvx);
3817 /* Make the SV before us point to the SV after us. */
3818 SV_COW_NEXT_SV_SET(current, after);
3821 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3826 Perl_sv_release_IVX(pTHX_ register SV *sv)
3829 sv_force_normal_flags(sv, 0);
3835 =for apidoc sv_force_normal_flags
3837 Undo various types of fakery on an SV: if the PV is a shared string, make
3838 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3839 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3840 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3841 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3842 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3843 set to some other value.) In addition, the C<flags> parameter gets passed to
3844 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3845 with flags set to 0.
3851 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
3854 #ifdef PERL_OLD_COPY_ON_WRITE
3855 if (SvREADONLY(sv)) {
3856 /* At this point I believe I should acquire a global SV mutex. */
3858 const char * const pvx = SvPVX_const(sv);
3859 const STRLEN len = SvLEN(sv);
3860 const STRLEN cur = SvCUR(sv);
3861 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
3863 PerlIO_printf(Perl_debug_log,
3864 "Copy on write: Force normal %ld\n",
3870 /* This SV doesn't own the buffer, so need to Newx() a new one: */
3873 if (flags & SV_COW_DROP_PV) {
3874 /* OK, so we don't need to copy our buffer. */
3877 SvGROW(sv, cur + 1);
3878 Move(pvx,SvPVX(sv),cur,char);
3882 sv_release_COW(sv, pvx, len, next);
3887 else if (IN_PERL_RUNTIME)
3888 Perl_croak(aTHX_ PL_no_modify);
3889 /* At this point I believe that I can drop the global SV mutex. */
3892 if (SvREADONLY(sv)) {
3894 const char * const pvx = SvPVX_const(sv);
3895 const STRLEN len = SvCUR(sv);
3900 SvGROW(sv, len + 1);
3901 Move(pvx,SvPVX(sv),len,char);
3903 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3905 else if (IN_PERL_RUNTIME)
3906 Perl_croak(aTHX_ PL_no_modify);
3910 sv_unref_flags(sv, flags);
3911 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
3918 Efficient removal of characters from the beginning of the string buffer.
3919 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3920 the string buffer. The C<ptr> becomes the first character of the adjusted
3921 string. Uses the "OOK hack".
3922 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
3923 refer to the same chunk of data.
3929 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
3931 register STRLEN delta;
3932 if (!ptr || !SvPOKp(sv))
3934 delta = ptr - SvPVX_const(sv);
3935 SV_CHECK_THINKFIRST(sv);
3936 if (SvTYPE(sv) < SVt_PVIV)
3937 sv_upgrade(sv,SVt_PVIV);
3940 if (!SvLEN(sv)) { /* make copy of shared string */
3941 const char *pvx = SvPVX_const(sv);
3942 const STRLEN len = SvCUR(sv);
3943 SvGROW(sv, len + 1);
3944 Move(pvx,SvPVX(sv),len,char);
3948 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
3949 and we do that anyway inside the SvNIOK_off
3951 SvFLAGS(sv) |= SVf_OOK;
3954 SvLEN_set(sv, SvLEN(sv) - delta);
3955 SvCUR_set(sv, SvCUR(sv) - delta);
3956 SvPV_set(sv, SvPVX(sv) + delta);
3957 SvIV_set(sv, SvIVX(sv) + delta);
3961 =for apidoc sv_catpvn
3963 Concatenates the string onto the end of the string which is in the SV. The
3964 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3965 status set, then the bytes appended should be valid UTF-8.
3966 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
3968 =for apidoc sv_catpvn_flags
3970 Concatenates the string onto the end of the string which is in the SV. The
3971 C<len> indicates number of bytes to copy. If the SV has the UTF-8
3972 status set, then the bytes appended should be valid UTF-8.
3973 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3974 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3975 in terms of this function.
3981 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
3985 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
3987 SvGROW(dsv, dlen + slen + 1);
3989 sstr = SvPVX_const(dsv);
3990 Move(sstr, SvPVX(dsv) + dlen, slen, char);
3991 SvCUR_set(dsv, SvCUR(dsv) + slen);
3993 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
3995 if (flags & SV_SMAGIC)
4000 =for apidoc sv_catsv
4002 Concatenates the string from SV C<ssv> onto the end of the string in
4003 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4004 not 'set' magic. See C<sv_catsv_mg>.
4006 =for apidoc sv_catsv_flags
4008 Concatenates the string from SV C<ssv> onto the end of the string in
4009 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4010 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4011 and C<sv_catsv_nomg> are implemented in terms of this function.
4016 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4021 const char *spv = SvPV_const(ssv, slen);
4023 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4024 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4025 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4026 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4027 dsv->sv_flags doesn't have that bit set.
4028 Andy Dougherty 12 Oct 2001
4030 const I32 sutf8 = DO_UTF8(ssv);
4033 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4035 dutf8 = DO_UTF8(dsv);
4037 if (dutf8 != sutf8) {
4039 /* Not modifying source SV, so taking a temporary copy. */
4040 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4042 sv_utf8_upgrade(csv);
4043 spv = SvPV_const(csv, slen);
4046 sv_utf8_upgrade_nomg(dsv);
4048 sv_catpvn_nomg(dsv, spv, slen);
4051 if (flags & SV_SMAGIC)
4056 =for apidoc sv_catpv
4058 Concatenates the string onto the end of the string which is in the SV.
4059 If the SV has the UTF-8 status set, then the bytes appended should be
4060 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4065 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4068 register STRLEN len;
4074 junk = SvPV_force(sv, tlen);
4076 SvGROW(sv, tlen + len + 1);
4078 ptr = SvPVX_const(sv);
4079 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4080 SvCUR_set(sv, SvCUR(sv) + len);
4081 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4086 =for apidoc sv_catpv_mg
4088 Like C<sv_catpv>, but also handles 'set' magic.
4094 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4103 Creates a new SV. A non-zero C<len> parameter indicates the number of
4104 bytes of preallocated string space the SV should have. An extra byte for a
4105 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4106 space is allocated.) The reference count for the new SV is set to 1.
4108 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4109 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4110 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4111 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4112 modules supporting older perls.
4118 Perl_newSV(pTHX_ STRLEN len)
4125 sv_upgrade(sv, SVt_PV);
4126 SvGROW(sv, len + 1);
4131 =for apidoc sv_magicext
4133 Adds magic to an SV, upgrading it if necessary. Applies the
4134 supplied vtable and returns a pointer to the magic added.
4136 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4137 In particular, you can add magic to SvREADONLY SVs, and add more than
4138 one instance of the same 'how'.
4140 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4141 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4142 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4143 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4145 (This is now used as a subroutine by C<sv_magic>.)
4150 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4151 const char* name, I32 namlen)
4156 if (SvTYPE(sv) < SVt_PVMG) {
4157 SvUPGRADE(sv, SVt_PVMG);
4159 Newxz(mg, 1, MAGIC);
4160 mg->mg_moremagic = SvMAGIC(sv);
4161 SvMAGIC_set(sv, mg);
4163 /* Sometimes a magic contains a reference loop, where the sv and
4164 object refer to each other. To prevent a reference loop that
4165 would prevent such objects being freed, we look for such loops
4166 and if we find one we avoid incrementing the object refcount.
4168 Note we cannot do this to avoid self-tie loops as intervening RV must
4169 have its REFCNT incremented to keep it in existence.
4172 if (!obj || obj == sv ||
4173 how == PERL_MAGIC_arylen ||
4174 how == PERL_MAGIC_qr ||
4175 how == PERL_MAGIC_symtab ||
4176 (SvTYPE(obj) == SVt_PVGV &&
4177 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4178 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4179 GvFORM(obj) == (CV*)sv)))
4184 mg->mg_obj = SvREFCNT_inc(obj);
4185 mg->mg_flags |= MGf_REFCOUNTED;
4188 /* Normal self-ties simply pass a null object, and instead of
4189 using mg_obj directly, use the SvTIED_obj macro to produce a
4190 new RV as needed. For glob "self-ties", we are tieing the PVIO
4191 with an RV obj pointing to the glob containing the PVIO. In
4192 this case, to avoid a reference loop, we need to weaken the
4196 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4197 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4203 mg->mg_len = namlen;
4206 mg->mg_ptr = savepvn(name, namlen);
4207 else if (namlen == HEf_SVKEY)
4208 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
4210 mg->mg_ptr = (char *) name;
4212 mg->mg_virtual = vtable;
4216 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4221 =for apidoc sv_magic
4223 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4224 then adds a new magic item of type C<how> to the head of the magic list.
4226 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4227 handling of the C<name> and C<namlen> arguments.
4229 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4230 to add more than one instance of the same 'how'.
4236 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4242 #ifdef PERL_OLD_COPY_ON_WRITE
4244 sv_force_normal_flags(sv, 0);
4246 if (SvREADONLY(sv)) {
4248 /* its okay to attach magic to shared strings; the subsequent
4249 * upgrade to PVMG will unshare the string */
4250 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4253 && how != PERL_MAGIC_regex_global
4254 && how != PERL_MAGIC_bm
4255 && how != PERL_MAGIC_fm
4256 && how != PERL_MAGIC_sv
4257 && how != PERL_MAGIC_backref
4260 Perl_croak(aTHX_ PL_no_modify);
4263 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4264 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4265 /* sv_magic() refuses to add a magic of the same 'how' as an
4268 if (how == PERL_MAGIC_taint)
4276 vtable = &PL_vtbl_sv;
4278 case PERL_MAGIC_overload:
4279 vtable = &PL_vtbl_amagic;
4281 case PERL_MAGIC_overload_elem:
4282 vtable = &PL_vtbl_amagicelem;
4284 case PERL_MAGIC_overload_table:
4285 vtable = &PL_vtbl_ovrld;
4288 vtable = &PL_vtbl_bm;
4290 case PERL_MAGIC_regdata:
4291 vtable = &PL_vtbl_regdata;
4293 case PERL_MAGIC_regdatum:
4294 vtable = &PL_vtbl_regdatum;
4296 case PERL_MAGIC_env:
4297 vtable = &PL_vtbl_env;
4300 vtable = &PL_vtbl_fm;
4302 case PERL_MAGIC_envelem:
4303 vtable = &PL_vtbl_envelem;
4305 case PERL_MAGIC_regex_global:
4306 vtable = &PL_vtbl_mglob;
4308 case PERL_MAGIC_isa:
4309 vtable = &PL_vtbl_isa;
4311 case PERL_MAGIC_isaelem:
4312 vtable = &PL_vtbl_isaelem;
4314 case PERL_MAGIC_nkeys:
4315 vtable = &PL_vtbl_nkeys;
4317 case PERL_MAGIC_dbfile:
4320 case PERL_MAGIC_dbline:
4321 vtable = &PL_vtbl_dbline;
4323 #ifdef USE_LOCALE_COLLATE
4324 case PERL_MAGIC_collxfrm:
4325 vtable = &PL_vtbl_collxfrm;
4327 #endif /* USE_LOCALE_COLLATE */
4328 case PERL_MAGIC_tied:
4329 vtable = &PL_vtbl_pack;
4331 case PERL_MAGIC_tiedelem:
4332 case PERL_MAGIC_tiedscalar:
4333 vtable = &PL_vtbl_packelem;
4336 vtable = &PL_vtbl_regexp;
4338 case PERL_MAGIC_sig:
4339 vtable = &PL_vtbl_sig;
4341 case PERL_MAGIC_sigelem:
4342 vtable = &PL_vtbl_sigelem;
4344 case PERL_MAGIC_taint:
4345 vtable = &PL_vtbl_taint;
4347 case PERL_MAGIC_uvar:
4348 vtable = &PL_vtbl_uvar;
4350 case PERL_MAGIC_vec:
4351 vtable = &PL_vtbl_vec;
4353 case PERL_MAGIC_arylen_p:
4354 case PERL_MAGIC_rhash:
4355 case PERL_MAGIC_symtab:
4356 case PERL_MAGIC_vstring:
4359 case PERL_MAGIC_utf8:
4360 vtable = &PL_vtbl_utf8;
4362 case PERL_MAGIC_substr:
4363 vtable = &PL_vtbl_substr;
4365 case PERL_MAGIC_defelem:
4366 vtable = &PL_vtbl_defelem;
4368 case PERL_MAGIC_glob:
4369 vtable = &PL_vtbl_glob;
4371 case PERL_MAGIC_arylen:
4372 vtable = &PL_vtbl_arylen;
4374 case PERL_MAGIC_pos:
4375 vtable = &PL_vtbl_pos;
4377 case PERL_MAGIC_backref:
4378 vtable = &PL_vtbl_backref;
4380 case PERL_MAGIC_ext:
4381 /* Reserved for use by extensions not perl internals. */
4382 /* Useful for attaching extension internal data to perl vars. */
4383 /* Note that multiple extensions may clash if magical scalars */
4384 /* etc holding private data from one are passed to another. */
4388 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4391 /* Rest of work is done else where */
4392 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4395 case PERL_MAGIC_taint:
4398 case PERL_MAGIC_ext:
4399 case PERL_MAGIC_dbfile:
4406 =for apidoc sv_unmagic
4408 Removes all magic of type C<type> from an SV.
4414 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4418 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4421 for (mg = *mgp; mg; mg = *mgp) {
4422 if (mg->mg_type == type) {
4423 const MGVTBL* const vtbl = mg->mg_virtual;
4424 *mgp = mg->mg_moremagic;
4425 if (vtbl && vtbl->svt_free)
4426 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4427 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4429 Safefree(mg->mg_ptr);
4430 else if (mg->mg_len == HEf_SVKEY)
4431 SvREFCNT_dec((SV*)mg->mg_ptr);
4432 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4433 Safefree(mg->mg_ptr);
4435 if (mg->mg_flags & MGf_REFCOUNTED)
4436 SvREFCNT_dec(mg->mg_obj);
4440 mgp = &mg->mg_moremagic;
4444 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4445 SvMAGIC_set(sv, NULL);
4452 =for apidoc sv_rvweaken
4454 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4455 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4456 push a back-reference to this RV onto the array of backreferences
4457 associated with that magic.
4463 Perl_sv_rvweaken(pTHX_ SV *sv)
4466 if (!SvOK(sv)) /* let undefs pass */
4469 Perl_croak(aTHX_ "Can't weaken a nonreference");
4470 else if (SvWEAKREF(sv)) {
4471 if (ckWARN(WARN_MISC))
4472 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4476 Perl_sv_add_backref(aTHX_ tsv, sv);
4482 /* Give tsv backref magic if it hasn't already got it, then push a
4483 * back-reference to sv onto the array associated with the backref magic.
4487 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4492 if (SvTYPE(tsv) == SVt_PVHV) {
4493 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4497 /* There is no AV in the offical place - try a fixup. */
4498 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4501 /* Aha. They've got it stowed in magic. Bring it back. */
4502 av = (AV*)mg->mg_obj;
4503 /* Stop mg_free decreasing the refernce count. */
4505 /* Stop mg_free even calling the destructor, given that
4506 there's no AV to free up. */
4508 sv_unmagic(tsv, PERL_MAGIC_backref);
4517 const MAGIC *const mg
4518 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4520 av = (AV*)mg->mg_obj;
4524 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4525 /* av now has a refcnt of 2, which avoids it getting freed
4526 * before us during global cleanup. The extra ref is removed
4527 * by magic_killbackrefs() when tsv is being freed */
4530 if (AvFILLp(av) >= AvMAX(av)) {
4531 av_extend(av, AvFILLp(av)+1);
4533 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4536 /* delete a back-reference to ourselves from the backref magic associated
4537 * with the SV we point to.
4541 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4548 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4549 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4550 /* We mustn't attempt to "fix up" the hash here by moving the
4551 backreference array back to the hv_aux structure, as that is stored
4552 in the main HvARRAY(), and hfreentries assumes that no-one
4553 reallocates HvARRAY() while it is running. */
4556 const MAGIC *const mg
4557 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4559 av = (AV *)mg->mg_obj;
4562 if (PL_in_clean_all)
4564 Perl_croak(aTHX_ "panic: del_backref");
4571 /* We shouldn't be in here more than once, but for paranoia reasons lets
4573 for (i = AvFILLp(av); i >= 0; i--) {
4575 const SSize_t fill = AvFILLp(av);
4577 /* We weren't the last entry.
4578 An unordered list has this property that you can take the
4579 last element off the end to fill the hole, and it's still
4580 an unordered list :-)
4585 AvFILLp(av) = fill - 1;
4591 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4593 SV **svp = AvARRAY(av);
4595 PERL_UNUSED_ARG(sv);
4597 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4598 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4599 if (svp && !SvIS_FREED(av)) {
4600 SV *const *const last = svp + AvFILLp(av);
4602 while (svp <= last) {
4604 SV *const referrer = *svp;
4605 if (SvWEAKREF(referrer)) {
4606 /* XXX Should we check that it hasn't changed? */
4607 SvRV_set(referrer, 0);
4609 SvWEAKREF_off(referrer);
4610 } else if (SvTYPE(referrer) == SVt_PVGV ||
4611 SvTYPE(referrer) == SVt_PVLV) {
4612 /* You lookin' at me? */
4613 assert(GvSTASH(referrer));
4614 assert(GvSTASH(referrer) == (HV*)sv);
4615 GvSTASH(referrer) = 0;
4618 "panic: magic_killbackrefs (flags=%"UVxf")",
4619 (UV)SvFLAGS(referrer));
4627 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4632 =for apidoc sv_insert
4634 Inserts a string at the specified offset/length within the SV. Similar to
4635 the Perl substr() function.
4641 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4646 register char *midend;
4647 register char *bigend;
4653 Perl_croak(aTHX_ "Can't modify non-existent substring");
4654 SvPV_force(bigstr, curlen);
4655 (void)SvPOK_only_UTF8(bigstr);
4656 if (offset + len > curlen) {
4657 SvGROW(bigstr, offset+len+1);
4658 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4659 SvCUR_set(bigstr, offset+len);
4663 i = littlelen - len;
4664 if (i > 0) { /* string might grow */
4665 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4666 mid = big + offset + len;
4667 midend = bigend = big + SvCUR(bigstr);
4670 while (midend > mid) /* shove everything down */
4671 *--bigend = *--midend;
4672 Move(little,big+offset,littlelen,char);
4673 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4678 Move(little,SvPVX(bigstr)+offset,len,char);
4683 big = SvPVX(bigstr);
4686 bigend = big + SvCUR(bigstr);
4688 if (midend > bigend)
4689 Perl_croak(aTHX_ "panic: sv_insert");
4691 if (mid - big > bigend - midend) { /* faster to shorten from end */
4693 Move(little, mid, littlelen,char);
4696 i = bigend - midend;
4698 Move(midend, mid, i,char);
4702 SvCUR_set(bigstr, mid - big);
4704 else if ((i = mid - big)) { /* faster from front */
4705 midend -= littlelen;
4707 sv_chop(bigstr,midend-i);
4712 Move(little, mid, littlelen,char);
4714 else if (littlelen) {
4715 midend -= littlelen;
4716 sv_chop(bigstr,midend);
4717 Move(little,midend,littlelen,char);
4720 sv_chop(bigstr,midend);
4726 =for apidoc sv_replace
4728 Make the first argument a copy of the second, then delete the original.
4729 The target SV physically takes over ownership of the body of the source SV
4730 and inherits its flags; however, the target keeps any magic it owns,
4731 and any magic in the source is discarded.
4732 Note that this is a rather specialist SV copying operation; most of the
4733 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4739 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4742 const U32 refcnt = SvREFCNT(sv);
4743 SV_CHECK_THINKFIRST_COW_DROP(sv);
4744 if (SvREFCNT(nsv) != 1) {
4745 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4746 UVuf " != 1)", (UV) SvREFCNT(nsv));
4748 if (SvMAGICAL(sv)) {
4752 sv_upgrade(nsv, SVt_PVMG);
4753 SvMAGIC_set(nsv, SvMAGIC(sv));
4754 SvFLAGS(nsv) |= SvMAGICAL(sv);
4756 SvMAGIC_set(sv, NULL);
4760 assert(!SvREFCNT(sv));
4761 #ifdef DEBUG_LEAKING_SCALARS
4762 sv->sv_flags = nsv->sv_flags;
4763 sv->sv_any = nsv->sv_any;
4764 sv->sv_refcnt = nsv->sv_refcnt;
4765 sv->sv_u = nsv->sv_u;
4767 StructCopy(nsv,sv,SV);
4769 /* Currently could join these into one piece of pointer arithmetic, but
4770 it would be unclear. */
4771 if(SvTYPE(sv) == SVt_IV)
4773 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4774 else if (SvTYPE(sv) == SVt_RV) {
4775 SvANY(sv) = &sv->sv_u.svu_rv;
4779 #ifdef PERL_OLD_COPY_ON_WRITE
4780 if (SvIsCOW_normal(nsv)) {
4781 /* We need to follow the pointers around the loop to make the
4782 previous SV point to sv, rather than nsv. */
4785 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4788 assert(SvPVX_const(current) == SvPVX_const(nsv));
4790 /* Make the SV before us point to the SV after us. */
4792 PerlIO_printf(Perl_debug_log, "previous is\n");
4794 PerlIO_printf(Perl_debug_log,
4795 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4796 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4798 SV_COW_NEXT_SV_SET(current, sv);
4801 SvREFCNT(sv) = refcnt;
4802 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4808 =for apidoc sv_clear
4810 Clear an SV: call any destructors, free up any memory used by the body,
4811 and free the body itself. The SV's head is I<not> freed, although
4812 its type is set to all 1's so that it won't inadvertently be assumed
4813 to be live during global destruction etc.
4814 This function should only be called when REFCNT is zero. Most of the time
4815 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4822 Perl_sv_clear(pTHX_ register SV *sv)
4825 const U32 type = SvTYPE(sv);
4826 const struct body_details *const sv_type_details
4827 = bodies_by_type + type;
4830 assert(SvREFCNT(sv) == 0);
4836 if (PL_defstash) { /* Still have a symbol table? */
4841 stash = SvSTASH(sv);
4842 destructor = StashHANDLER(stash,DESTROY);
4844 SV* const tmpref = newRV(sv);
4845 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4847 PUSHSTACKi(PERLSI_DESTROY);
4852 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4858 if(SvREFCNT(tmpref) < 2) {
4859 /* tmpref is not kept alive! */
4861 SvRV_set(tmpref, NULL);
4864 SvREFCNT_dec(tmpref);
4866 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
4870 if (PL_in_clean_objs)
4871 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
4873 /* DESTROY gave object new lease on life */
4879 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
4880 SvOBJECT_off(sv); /* Curse the object. */
4881 if (type != SVt_PVIO)
4882 --PL_sv_objcount; /* XXX Might want something more general */
4885 if (type >= SVt_PVMG) {
4888 if (type == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
4889 SvREFCNT_dec(SvSTASH(sv));
4894 IoIFP(sv) != PerlIO_stdin() &&
4895 IoIFP(sv) != PerlIO_stdout() &&
4896 IoIFP(sv) != PerlIO_stderr())
4898 io_close((IO*)sv, FALSE);
4900 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
4901 PerlDir_close(IoDIRP(sv));
4902 IoDIRP(sv) = (DIR*)NULL;
4903 Safefree(IoTOP_NAME(sv));
4904 Safefree(IoFMT_NAME(sv));
4905 Safefree(IoBOTTOM_NAME(sv));
4914 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
4921 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
4922 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
4923 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
4924 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
4926 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
4927 SvREFCNT_dec(LvTARG(sv));
4931 Safefree(GvNAME(sv));
4932 /* If we're in a stash, we don't own a reference to it. However it does
4933 have a back reference to us, which needs to be cleared. */
4935 sv_del_backref((SV*)GvSTASH(sv), sv);
4940 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
4942 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
4943 /* Don't even bother with turning off the OOK flag. */
4948 SV *target = SvRV(sv);
4950 sv_del_backref(target, sv);
4952 SvREFCNT_dec(target);
4954 #ifdef PERL_OLD_COPY_ON_WRITE
4955 else if (SvPVX_const(sv)) {
4957 /* I believe I need to grab the global SV mutex here and
4958 then recheck the COW status. */
4960 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
4963 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
4964 SV_COW_NEXT_SV(sv));
4965 /* And drop it here. */
4967 } else if (SvLEN(sv)) {
4968 Safefree(SvPVX_const(sv));
4972 else if (SvPVX_const(sv) && SvLEN(sv))
4973 Safefree(SvPVX_mutable(sv));
4974 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
4975 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
4984 SvFLAGS(sv) &= SVf_BREAK;
4985 SvFLAGS(sv) |= SVTYPEMASK;
4987 if (sv_type_details->arena) {
4988 del_body(((char *)SvANY(sv) + sv_type_details->offset),
4989 &PL_body_roots[type]);
4991 else if (sv_type_details->size) {
4992 my_safefree(SvANY(sv));
4997 =for apidoc sv_newref
4999 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5006 Perl_sv_newref(pTHX_ SV *sv)
5016 Decrement an SV's reference count, and if it drops to zero, call
5017 C<sv_clear> to invoke destructors and free up any memory used by
5018 the body; finally, deallocate the SV's head itself.
5019 Normally called via a wrapper macro C<SvREFCNT_dec>.
5025 Perl_sv_free(pTHX_ SV *sv)
5030 if (SvREFCNT(sv) == 0) {
5031 if (SvFLAGS(sv) & SVf_BREAK)
5032 /* this SV's refcnt has been artificially decremented to
5033 * trigger cleanup */
5035 if (PL_in_clean_all) /* All is fair */
5037 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5038 /* make sure SvREFCNT(sv)==0 happens very seldom */
5039 SvREFCNT(sv) = (~(U32)0)/2;
5042 if (ckWARN_d(WARN_INTERNAL)) {
5043 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5044 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5045 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5046 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5047 Perl_dump_sv_child(aTHX_ sv);
5052 if (--(SvREFCNT(sv)) > 0)
5054 Perl_sv_free2(aTHX_ sv);
5058 Perl_sv_free2(pTHX_ SV *sv)
5063 if (ckWARN_d(WARN_DEBUGGING))
5064 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5065 "Attempt to free temp prematurely: SV 0x%"UVxf
5066 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5070 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5071 /* make sure SvREFCNT(sv)==0 happens very seldom */
5072 SvREFCNT(sv) = (~(U32)0)/2;
5083 Returns the length of the string in the SV. Handles magic and type
5084 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5090 Perl_sv_len(pTHX_ register SV *sv)
5098 len = mg_length(sv);
5100 (void)SvPV_const(sv, len);
5105 =for apidoc sv_len_utf8
5107 Returns the number of characters in the string in an SV, counting wide
5108 UTF-8 bytes as a single character. Handles magic and type coercion.
5114 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5115 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5116 * (Note that the mg_len is not the length of the mg_ptr field.)
5121 Perl_sv_len_utf8(pTHX_ register SV *sv)
5127 return mg_length(sv);
5131 const U8 *s = (U8*)SvPV_const(sv, len);
5132 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5134 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
5136 #ifdef PERL_UTF8_CACHE_ASSERT
5137 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
5141 ulen = Perl_utf8_length(aTHX_ s, s + len);
5142 if (!mg && !SvREADONLY(sv)) {
5143 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5144 mg = mg_find(sv, PERL_MAGIC_utf8);
5154 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5155 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5156 * between UTF-8 and byte offsets. There are two (substr offset and substr
5157 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5158 * and byte offset) cache positions.
5160 * The mg_len field is used by sv_len_utf8(), see its comments.
5161 * Note that the mg_len is not the length of the mg_ptr field.
5165 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i,
5166 I32 offsetp, const U8 *s, const U8 *start)
5170 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5172 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
5176 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5178 Newxz(*cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5179 (*mgp)->mg_ptr = (char *) *cachep;
5183 (*cachep)[i] = offsetp;
5184 (*cachep)[i+1] = s - start;
5192 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5193 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5194 * between UTF-8 and byte offsets. See also the comments of
5195 * S_utf8_mg_pos_init().
5199 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)
5203 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5205 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5206 if (*mgp && (*mgp)->mg_ptr) {
5207 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5208 ASSERT_UTF8_CACHE(*cachep);
5209 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
5211 else { /* We will skip to the right spot. */
5216 /* The assumption is that going backward is half
5217 * the speed of going forward (that's where the
5218 * 2 * backw in the below comes from). (The real
5219 * figure of course depends on the UTF-8 data.) */
5221 if ((*cachep)[i] > (STRLEN)uoff) {
5223 backw = (*cachep)[i] - (STRLEN)uoff;
5225 if (forw < 2 * backw)
5228 p = start + (*cachep)[i+1];
5230 /* Try this only for the substr offset (i == 0),
5231 * not for the substr length (i == 2). */
5232 else if (i == 0) { /* (*cachep)[i] < uoff */
5233 const STRLEN ulen = sv_len_utf8(sv);
5235 if ((STRLEN)uoff < ulen) {
5236 forw = (STRLEN)uoff - (*cachep)[i];
5237 backw = ulen - (STRLEN)uoff;
5239 if (forw < 2 * backw)
5240 p = start + (*cachep)[i+1];
5245 /* If the string is not long enough for uoff,
5246 * we could extend it, but not at this low a level. */
5250 if (forw < 2 * backw) {
5257 while (UTF8_IS_CONTINUATION(*p))
5262 /* Update the cache. */
5263 (*cachep)[i] = (STRLEN)uoff;
5264 (*cachep)[i+1] = p - start;
5266 /* Drop the stale "length" cache */
5275 if (found) { /* Setup the return values. */
5276 *offsetp = (*cachep)[i+1];
5277 *sp = start + *offsetp;
5280 *offsetp = send - start;
5282 else if (*sp < start) {
5288 #ifdef PERL_UTF8_CACHE_ASSERT
5293 while (n-- && s < send)
5297 assert(*offsetp == s - start);
5298 assert((*cachep)[0] == (STRLEN)uoff);
5299 assert((*cachep)[1] == *offsetp);
5301 ASSERT_UTF8_CACHE(*cachep);
5310 =for apidoc sv_pos_u2b
5312 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5313 the start of the string, to a count of the equivalent number of bytes; if
5314 lenp is non-zero, it does the same to lenp, but this time starting from
5315 the offset, rather than from the start of the string. Handles magic and
5322 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5323 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5324 * byte offsets. See also the comments of S_utf8_mg_pos().
5329 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5337 start = (U8*)SvPV_const(sv, len);
5340 STRLEN *cache = NULL;
5341 const U8 *s = start;
5342 I32 uoffset = *offsetp;
5343 const U8 * const send = s + len;
5345 bool found = utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send);
5347 if (!found && uoffset > 0) {
5348 while (s < send && uoffset--)
5352 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
5354 *offsetp = s - start;
5359 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
5363 if (!found && *lenp > 0) {
5366 while (s < send && ulen--)
5370 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
5374 ASSERT_UTF8_CACHE(cache);
5386 =for apidoc sv_pos_b2u
5388 Converts the value pointed to by offsetp from a count of bytes from the
5389 start of the string, to a count of the equivalent number of UTF-8 chars.
5390 Handles magic and type coercion.
5396 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5397 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5398 * byte offsets. See also the comments of S_utf8_mg_pos().
5403 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5411 s = (const U8*)SvPV_const(sv, len);
5412 if ((I32)len < *offsetp)
5413 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5415 const U8* send = s + *offsetp;
5417 STRLEN *cache = NULL;
5421 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5422 mg = mg_find(sv, PERL_MAGIC_utf8);
5423 if (mg && mg->mg_ptr) {
5424 cache = (STRLEN *) mg->mg_ptr;
5425 if (cache[1] == (STRLEN)*offsetp) {
5426 /* An exact match. */
5427 *offsetp = cache[0];
5431 else if (cache[1] < (STRLEN)*offsetp) {
5432 /* We already know part of the way. */
5435 /* Let the below loop do the rest. */
5437 else { /* cache[1] > *offsetp */
5438 /* We already know all of the way, now we may
5439 * be able to walk back. The same assumption
5440 * is made as in S_utf8_mg_pos(), namely that
5441 * walking backward is twice slower than
5442 * walking forward. */
5443 const STRLEN forw = *offsetp;
5444 STRLEN backw = cache[1] - *offsetp;
5446 if (!(forw < 2 * backw)) {
5447 const U8 *p = s + cache[1];
5454 while (UTF8_IS_CONTINUATION(*p)) {
5462 *offsetp = cache[0];
5464 /* Drop the stale "length" cache */
5472 ASSERT_UTF8_CACHE(cache);
5478 /* Call utf8n_to_uvchr() to validate the sequence
5479 * (unless a simple non-UTF character) */
5480 if (!UTF8_IS_INVARIANT(*s))
5481 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5490 if (!SvREADONLY(sv)) {
5492 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5493 mg = mg_find(sv, PERL_MAGIC_utf8);
5498 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5499 mg->mg_ptr = (char *) cache;
5504 cache[1] = *offsetp;
5505 /* Drop the stale "length" cache */
5518 Returns a boolean indicating whether the strings in the two SVs are
5519 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5520 coerce its args to strings if necessary.
5526 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5535 SV* svrecode = NULL;
5542 pv1 = SvPV_const(sv1, cur1);
5549 pv2 = SvPV_const(sv2, cur2);
5551 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5552 /* Differing utf8ness.
5553 * Do not UTF8size the comparands as a side-effect. */
5556 svrecode = newSVpvn(pv2, cur2);
5557 sv_recode_to_utf8(svrecode, PL_encoding);
5558 pv2 = SvPV_const(svrecode, cur2);
5561 svrecode = newSVpvn(pv1, cur1);
5562 sv_recode_to_utf8(svrecode, PL_encoding);
5563 pv1 = SvPV_const(svrecode, cur1);
5565 /* Now both are in UTF-8. */
5567 SvREFCNT_dec(svrecode);
5572 bool is_utf8 = TRUE;
5575 /* sv1 is the UTF-8 one,
5576 * if is equal it must be downgrade-able */
5577 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5583 /* sv2 is the UTF-8 one,
5584 * if is equal it must be downgrade-able */
5585 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5591 /* Downgrade not possible - cannot be eq */
5599 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5602 SvREFCNT_dec(svrecode);
5613 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5614 string in C<sv1> is less than, equal to, or greater than the string in
5615 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5616 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5622 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5626 const char *pv1, *pv2;
5629 SV *svrecode = NULL;
5636 pv1 = SvPV_const(sv1, cur1);
5643 pv2 = SvPV_const(sv2, cur2);
5645 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5646 /* Differing utf8ness.
5647 * Do not UTF8size the comparands as a side-effect. */
5650 svrecode = newSVpvn(pv2, cur2);
5651 sv_recode_to_utf8(svrecode, PL_encoding);
5652 pv2 = SvPV_const(svrecode, cur2);
5655 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
5660 svrecode = newSVpvn(pv1, cur1);
5661 sv_recode_to_utf8(svrecode, PL_encoding);
5662 pv1 = SvPV_const(svrecode, cur1);
5665 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
5671 cmp = cur2 ? -1 : 0;
5675 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
5678 cmp = retval < 0 ? -1 : 1;
5679 } else if (cur1 == cur2) {
5682 cmp = cur1 < cur2 ? -1 : 1;
5687 SvREFCNT_dec(svrecode);
5696 =for apidoc sv_cmp_locale
5698 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
5699 'use bytes' aware, handles get magic, and will coerce its args to strings
5700 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
5706 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
5709 #ifdef USE_LOCALE_COLLATE
5715 if (PL_collation_standard)
5719 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
5721 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
5723 if (!pv1 || !len1) {
5734 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
5737 return retval < 0 ? -1 : 1;
5740 * When the result of collation is equality, that doesn't mean
5741 * that there are no differences -- some locales exclude some
5742 * characters from consideration. So to avoid false equalities,
5743 * we use the raw string as a tiebreaker.
5749 #endif /* USE_LOCALE_COLLATE */
5751 return sv_cmp(sv1, sv2);
5755 #ifdef USE_LOCALE_COLLATE
5758 =for apidoc sv_collxfrm
5760 Add Collate Transform magic to an SV if it doesn't already have it.
5762 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
5763 scalar data of the variable, but transformed to such a format that a normal
5764 memory comparison can be used to compare the data according to the locale
5771 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
5776 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
5777 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
5783 Safefree(mg->mg_ptr);
5784 s = SvPV_const(sv, len);
5785 if ((xf = mem_collxfrm(s, len, &xlen))) {
5786 if (SvREADONLY(sv)) {
5789 return xf + sizeof(PL_collation_ix);
5792 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
5793 mg = mg_find(sv, PERL_MAGIC_collxfrm);
5806 if (mg && mg->mg_ptr) {
5808 return mg->mg_ptr + sizeof(PL_collation_ix);
5816 #endif /* USE_LOCALE_COLLATE */
5821 Get a line from the filehandle and store it into the SV, optionally
5822 appending to the currently-stored string.
5828 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
5833 register STDCHAR rslast;
5834 register STDCHAR *bp;
5840 if (SvTHINKFIRST(sv))
5841 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
5842 /* XXX. If you make this PVIV, then copy on write can copy scalars read
5844 However, perlbench says it's slower, because the existing swipe code
5845 is faster than copy on write.
5846 Swings and roundabouts. */
5847 SvUPGRADE(sv, SVt_PV);
5852 if (PerlIO_isutf8(fp)) {
5854 sv_utf8_upgrade_nomg(sv);
5855 sv_pos_u2b(sv,&append,0);
5857 } else if (SvUTF8(sv)) {
5858 SV * const tsv = newSV(0);
5859 sv_gets(tsv, fp, 0);
5860 sv_utf8_upgrade_nomg(tsv);
5861 SvCUR_set(sv,append);
5864 goto return_string_or_null;
5869 if (PerlIO_isutf8(fp))
5872 if (IN_PERL_COMPILETIME) {
5873 /* we always read code in line mode */
5877 else if (RsSNARF(PL_rs)) {
5878 /* If it is a regular disk file use size from stat() as estimate
5879 of amount we are going to read - may result in malloc-ing
5880 more memory than we realy need if layers bellow reduce
5881 size we read (e.g. CRLF or a gzip layer)
5884 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
5885 const Off_t offset = PerlIO_tell(fp);
5886 if (offset != (Off_t) -1 && st.st_size + append > offset) {
5887 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
5893 else if (RsRECORD(PL_rs)) {
5897 /* Grab the size of the record we're getting */
5898 recsize = SvIV(SvRV(PL_rs));
5899 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5902 /* VMS wants read instead of fread, because fread doesn't respect */
5903 /* RMS record boundaries. This is not necessarily a good thing to be */
5904 /* doing, but we've got no other real choice - except avoid stdio
5905 as implementation - perhaps write a :vms layer ?
5907 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
5909 bytesread = PerlIO_read(fp, buffer, recsize);
5913 SvCUR_set(sv, bytesread += append);
5914 buffer[bytesread] = '\0';
5915 goto return_string_or_null;
5917 else if (RsPARA(PL_rs)) {
5923 /* Get $/ i.e. PL_rs into same encoding as stream wants */
5924 if (PerlIO_isutf8(fp)) {
5925 rsptr = SvPVutf8(PL_rs, rslen);
5928 if (SvUTF8(PL_rs)) {
5929 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
5930 Perl_croak(aTHX_ "Wide character in $/");
5933 rsptr = SvPV_const(PL_rs, rslen);
5937 rslast = rslen ? rsptr[rslen - 1] : '\0';
5939 if (rspara) { /* have to do this both before and after */
5940 do { /* to make sure file boundaries work right */
5943 i = PerlIO_getc(fp);
5947 PerlIO_ungetc(fp,i);
5953 /* See if we know enough about I/O mechanism to cheat it ! */
5955 /* This used to be #ifdef test - it is made run-time test for ease
5956 of abstracting out stdio interface. One call should be cheap
5957 enough here - and may even be a macro allowing compile
5961 if (PerlIO_fast_gets(fp)) {
5964 * We're going to steal some values from the stdio struct
5965 * and put EVERYTHING in the innermost loop into registers.
5967 register STDCHAR *ptr;
5971 #if defined(VMS) && defined(PERLIO_IS_STDIO)
5972 /* An ungetc()d char is handled separately from the regular
5973 * buffer, so we getc() it back out and stuff it in the buffer.
5975 i = PerlIO_getc(fp);
5976 if (i == EOF) return 0;
5977 *(--((*fp)->_ptr)) = (unsigned char) i;
5981 /* Here is some breathtakingly efficient cheating */
5983 cnt = PerlIO_get_cnt(fp); /* get count into register */
5984 /* make sure we have the room */
5985 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
5986 /* Not room for all of it
5987 if we are looking for a separator and room for some
5989 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
5990 /* just process what we have room for */
5991 shortbuffered = cnt - SvLEN(sv) + append + 1;
5992 cnt -= shortbuffered;
5996 /* remember that cnt can be negative */
5997 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6002 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6003 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6004 DEBUG_P(PerlIO_printf(Perl_debug_log,
6005 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6006 DEBUG_P(PerlIO_printf(Perl_debug_log,
6007 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6008 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6009 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6014 while (cnt > 0) { /* this | eat */
6016 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6017 goto thats_all_folks; /* screams | sed :-) */
6021 Copy(ptr, bp, cnt, char); /* this | eat */
6022 bp += cnt; /* screams | dust */
6023 ptr += cnt; /* louder | sed :-) */
6028 if (shortbuffered) { /* oh well, must extend */
6029 cnt = shortbuffered;
6031 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6033 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6034 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6038 DEBUG_P(PerlIO_printf(Perl_debug_log,
6039 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6040 PTR2UV(ptr),(long)cnt));
6041 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6043 DEBUG_P(PerlIO_printf(Perl_debug_log,
6044 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6045 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6046 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6048 /* This used to call 'filbuf' in stdio form, but as that behaves like
6049 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6050 another abstraction. */
6051 i = PerlIO_getc(fp); /* get more characters */
6053 DEBUG_P(PerlIO_printf(Perl_debug_log,
6054 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6055 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6056 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6058 cnt = PerlIO_get_cnt(fp);
6059 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6060 DEBUG_P(PerlIO_printf(Perl_debug_log,
6061 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6063 if (i == EOF) /* all done for ever? */
6064 goto thats_really_all_folks;
6066 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6068 SvGROW(sv, bpx + cnt + 2);
6069 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6071 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6073 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6074 goto thats_all_folks;
6078 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6079 memNE((char*)bp - rslen, rsptr, rslen))
6080 goto screamer; /* go back to the fray */
6081 thats_really_all_folks:
6083 cnt += shortbuffered;
6084 DEBUG_P(PerlIO_printf(Perl_debug_log,
6085 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6086 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6087 DEBUG_P(PerlIO_printf(Perl_debug_log,
6088 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6089 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6090 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6092 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6093 DEBUG_P(PerlIO_printf(Perl_debug_log,
6094 "Screamer: done, len=%ld, string=|%.*s|\n",
6095 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6099 /*The big, slow, and stupid way. */
6100 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6101 STDCHAR *buf = NULL;
6102 Newx(buf, 8192, STDCHAR);
6110 register const STDCHAR * const bpe = buf + sizeof(buf);
6112 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6113 ; /* keep reading */
6117 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6118 /* Accomodate broken VAXC compiler, which applies U8 cast to
6119 * both args of ?: operator, causing EOF to change into 255
6122 i = (U8)buf[cnt - 1];
6128 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6130 sv_catpvn(sv, (char *) buf, cnt);
6132 sv_setpvn(sv, (char *) buf, cnt);
6134 if (i != EOF && /* joy */
6136 SvCUR(sv) < rslen ||
6137 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6141 * If we're reading from a TTY and we get a short read,
6142 * indicating that the user hit his EOF character, we need
6143 * to notice it now, because if we try to read from the TTY
6144 * again, the EOF condition will disappear.
6146 * The comparison of cnt to sizeof(buf) is an optimization
6147 * that prevents unnecessary calls to feof().
6151 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6155 #ifdef USE_HEAP_INSTEAD_OF_STACK
6160 if (rspara) { /* have to do this both before and after */
6161 while (i != EOF) { /* to make sure file boundaries work right */
6162 i = PerlIO_getc(fp);
6164 PerlIO_ungetc(fp,i);
6170 return_string_or_null:
6171 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6177 Auto-increment of the value in the SV, doing string to numeric conversion
6178 if necessary. Handles 'get' magic.
6184 Perl_sv_inc(pTHX_ register SV *sv)
6193 if (SvTHINKFIRST(sv)) {
6195 sv_force_normal_flags(sv, 0);
6196 if (SvREADONLY(sv)) {
6197 if (IN_PERL_RUNTIME)
6198 Perl_croak(aTHX_ PL_no_modify);
6202 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6204 i = PTR2IV(SvRV(sv));
6209 flags = SvFLAGS(sv);
6210 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6211 /* It's (privately or publicly) a float, but not tested as an
6212 integer, so test it to see. */
6214 flags = SvFLAGS(sv);
6216 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6217 /* It's publicly an integer, or privately an integer-not-float */
6218 #ifdef PERL_PRESERVE_IVUV
6222 if (SvUVX(sv) == UV_MAX)
6223 sv_setnv(sv, UV_MAX_P1);
6225 (void)SvIOK_only_UV(sv);
6226 SvUV_set(sv, SvUVX(sv) + 1);
6228 if (SvIVX(sv) == IV_MAX)
6229 sv_setuv(sv, (UV)IV_MAX + 1);
6231 (void)SvIOK_only(sv);
6232 SvIV_set(sv, SvIVX(sv) + 1);
6237 if (flags & SVp_NOK) {
6238 (void)SvNOK_only(sv);
6239 SvNV_set(sv, SvNVX(sv) + 1.0);
6243 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6244 if ((flags & SVTYPEMASK) < SVt_PVIV)
6245 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6246 (void)SvIOK_only(sv);
6251 while (isALPHA(*d)) d++;
6252 while (isDIGIT(*d)) d++;
6254 #ifdef PERL_PRESERVE_IVUV
6255 /* Got to punt this as an integer if needs be, but we don't issue
6256 warnings. Probably ought to make the sv_iv_please() that does
6257 the conversion if possible, and silently. */
6258 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6259 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6260 /* Need to try really hard to see if it's an integer.
6261 9.22337203685478e+18 is an integer.
6262 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6263 so $a="9.22337203685478e+18"; $a+0; $a++
6264 needs to be the same as $a="9.22337203685478e+18"; $a++
6271 /* sv_2iv *should* have made this an NV */
6272 if (flags & SVp_NOK) {
6273 (void)SvNOK_only(sv);
6274 SvNV_set(sv, SvNVX(sv) + 1.0);
6277 /* I don't think we can get here. Maybe I should assert this
6278 And if we do get here I suspect that sv_setnv will croak. NWC
6280 #if defined(USE_LONG_DOUBLE)
6281 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",
6282 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6284 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6285 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6288 #endif /* PERL_PRESERVE_IVUV */
6289 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6293 while (d >= SvPVX_const(sv)) {
6301 /* MKS: The original code here died if letters weren't consecutive.
6302 * at least it didn't have to worry about non-C locales. The
6303 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6304 * arranged in order (although not consecutively) and that only
6305 * [A-Za-z] are accepted by isALPHA in the C locale.
6307 if (*d != 'z' && *d != 'Z') {
6308 do { ++*d; } while (!isALPHA(*d));
6311 *(d--) -= 'z' - 'a';
6316 *(d--) -= 'z' - 'a' + 1;
6320 /* oh,oh, the number grew */
6321 SvGROW(sv, SvCUR(sv) + 2);
6322 SvCUR_set(sv, SvCUR(sv) + 1);
6323 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6334 Auto-decrement of the value in the SV, doing string to numeric conversion
6335 if necessary. Handles 'get' magic.
6341 Perl_sv_dec(pTHX_ register SV *sv)
6349 if (SvTHINKFIRST(sv)) {
6351 sv_force_normal_flags(sv, 0);
6352 if (SvREADONLY(sv)) {
6353 if (IN_PERL_RUNTIME)
6354 Perl_croak(aTHX_ PL_no_modify);
6358 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6360 i = PTR2IV(SvRV(sv));
6365 /* Unlike sv_inc we don't have to worry about string-never-numbers
6366 and keeping them magic. But we mustn't warn on punting */
6367 flags = SvFLAGS(sv);
6368 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6369 /* It's publicly an integer, or privately an integer-not-float */
6370 #ifdef PERL_PRESERVE_IVUV
6374 if (SvUVX(sv) == 0) {
6375 (void)SvIOK_only(sv);
6379 (void)SvIOK_only_UV(sv);
6380 SvUV_set(sv, SvUVX(sv) - 1);
6383 if (SvIVX(sv) == IV_MIN)
6384 sv_setnv(sv, (NV)IV_MIN - 1.0);
6386 (void)SvIOK_only(sv);
6387 SvIV_set(sv, SvIVX(sv) - 1);
6392 if (flags & SVp_NOK) {
6393 SvNV_set(sv, SvNVX(sv) - 1.0);
6394 (void)SvNOK_only(sv);
6397 if (!(flags & SVp_POK)) {
6398 if ((flags & SVTYPEMASK) < SVt_PVIV)
6399 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6401 (void)SvIOK_only(sv);
6404 #ifdef PERL_PRESERVE_IVUV
6406 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6407 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6408 /* Need to try really hard to see if it's an integer.
6409 9.22337203685478e+18 is an integer.
6410 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6411 so $a="9.22337203685478e+18"; $a+0; $a--
6412 needs to be the same as $a="9.22337203685478e+18"; $a--
6419 /* sv_2iv *should* have made this an NV */
6420 if (flags & SVp_NOK) {
6421 (void)SvNOK_only(sv);
6422 SvNV_set(sv, SvNVX(sv) - 1.0);
6425 /* I don't think we can get here. Maybe I should assert this
6426 And if we do get here I suspect that sv_setnv will croak. NWC
6428 #if defined(USE_LONG_DOUBLE)
6429 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",
6430 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6432 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6433 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6437 #endif /* PERL_PRESERVE_IVUV */
6438 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6442 =for apidoc sv_mortalcopy
6444 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6445 The new SV is marked as mortal. It will be destroyed "soon", either by an
6446 explicit call to FREETMPS, or by an implicit call at places such as
6447 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6452 /* Make a string that will exist for the duration of the expression
6453 * evaluation. Actually, it may have to last longer than that, but
6454 * hopefully we won't free it until it has been assigned to a
6455 * permanent location. */
6458 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6464 sv_setsv(sv,oldstr);
6466 PL_tmps_stack[++PL_tmps_ix] = sv;
6472 =for apidoc sv_newmortal
6474 Creates a new null SV which is mortal. The reference count of the SV is
6475 set to 1. It will be destroyed "soon", either by an explicit call to
6476 FREETMPS, or by an implicit call at places such as statement boundaries.
6477 See also C<sv_mortalcopy> and C<sv_2mortal>.
6483 Perl_sv_newmortal(pTHX)
6489 SvFLAGS(sv) = SVs_TEMP;
6491 PL_tmps_stack[++PL_tmps_ix] = sv;
6496 =for apidoc sv_2mortal
6498 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6499 by an explicit call to FREETMPS, or by an implicit call at places such as
6500 statement boundaries. SvTEMP() is turned on which means that the SV's
6501 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6502 and C<sv_mortalcopy>.
6508 Perl_sv_2mortal(pTHX_ register SV *sv)
6513 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6516 PL_tmps_stack[++PL_tmps_ix] = sv;
6524 Creates a new SV and copies a string into it. The reference count for the
6525 SV is set to 1. If C<len> is zero, Perl will compute the length using
6526 strlen(). For efficiency, consider using C<newSVpvn> instead.
6532 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6538 sv_setpvn(sv,s,len ? len : strlen(s));
6543 =for apidoc newSVpvn
6545 Creates a new SV and copies a string into it. The reference count for the
6546 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6547 string. You are responsible for ensuring that the source string is at least
6548 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6554 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6560 sv_setpvn(sv,s,len);
6566 =for apidoc newSVhek
6568 Creates a new SV from the hash key structure. It will generate scalars that
6569 point to the shared string table where possible. Returns a new (undefined)
6570 SV if the hek is NULL.
6576 Perl_newSVhek(pTHX_ const HEK *hek)
6586 if (HEK_LEN(hek) == HEf_SVKEY) {
6587 return newSVsv(*(SV**)HEK_KEY(hek));
6589 const int flags = HEK_FLAGS(hek);
6590 if (flags & HVhek_WASUTF8) {
6592 Andreas would like keys he put in as utf8 to come back as utf8
6594 STRLEN utf8_len = HEK_LEN(hek);
6595 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6596 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6599 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6601 } else if (flags & HVhek_REHASH) {
6602 /* We don't have a pointer to the hv, so we have to replicate the
6603 flag into every HEK. This hv is using custom a hasing
6604 algorithm. Hence we can't return a shared string scalar, as
6605 that would contain the (wrong) hash value, and might get passed
6606 into an hv routine with a regular hash */
6608 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6613 /* This will be overwhelminly the most common case. */
6614 return newSVpvn_share(HEK_KEY(hek),
6615 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6621 =for apidoc newSVpvn_share
6623 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6624 table. If the string does not already exist in the table, it is created
6625 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6626 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6627 otherwise the hash is computed. The idea here is that as the string table
6628 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6629 hash lookup will avoid string compare.
6635 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6639 bool is_utf8 = FALSE;
6641 STRLEN tmplen = -len;
6643 /* See the note in hv.c:hv_fetch() --jhi */
6644 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
6648 PERL_HASH(hash, src, len);
6650 sv_upgrade(sv, SVt_PV);
6651 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
6663 #if defined(PERL_IMPLICIT_CONTEXT)
6665 /* pTHX_ magic can't cope with varargs, so this is a no-context
6666 * version of the main function, (which may itself be aliased to us).
6667 * Don't access this version directly.
6671 Perl_newSVpvf_nocontext(const char* pat, ...)
6676 va_start(args, pat);
6677 sv = vnewSVpvf(pat, &args);
6684 =for apidoc newSVpvf
6686 Creates a new SV and initializes it with the string formatted like
6693 Perl_newSVpvf(pTHX_ const char* pat, ...)
6697 va_start(args, pat);
6698 sv = vnewSVpvf(pat, &args);
6703 /* backend for newSVpvf() and newSVpvf_nocontext() */
6706 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6711 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6718 Creates a new SV and copies a floating point value into it.
6719 The reference count for the SV is set to 1.
6725 Perl_newSVnv(pTHX_ NV n)
6738 Creates a new SV and copies an integer into it. The reference count for the
6745 Perl_newSViv(pTHX_ IV i)
6758 Creates a new SV and copies an unsigned integer into it.
6759 The reference count for the SV is set to 1.
6765 Perl_newSVuv(pTHX_ UV u)
6776 =for apidoc newRV_noinc
6778 Creates an RV wrapper for an SV. The reference count for the original
6779 SV is B<not> incremented.
6785 Perl_newRV_noinc(pTHX_ SV *tmpRef)
6791 sv_upgrade(sv, SVt_RV);
6793 SvRV_set(sv, tmpRef);
6798 /* newRV_inc is the official function name to use now.
6799 * newRV_inc is in fact #defined to newRV in sv.h
6803 Perl_newRV(pTHX_ SV *tmpRef)
6806 return newRV_noinc(SvREFCNT_inc(tmpRef));
6812 Creates a new SV which is an exact duplicate of the original SV.
6819 Perl_newSVsv(pTHX_ register SV *old)
6826 if (SvTYPE(old) == SVTYPEMASK) {
6827 if (ckWARN_d(WARN_INTERNAL))
6828 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
6832 /* SV_GMAGIC is the default for sv_setv()
6833 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
6834 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
6835 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
6840 =for apidoc sv_reset
6842 Underlying implementation for the C<reset> Perl function.
6843 Note that the perl-level function is vaguely deprecated.
6849 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
6852 char todo[PERL_UCHAR_MAX+1];
6857 if (!*s) { /* reset ?? searches */
6858 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
6860 PMOP *pm = (PMOP *) mg->mg_obj;
6862 pm->op_pmdynflags &= ~PMdf_USED;
6869 /* reset variables */
6871 if (!HvARRAY(stash))
6874 Zero(todo, 256, char);
6877 I32 i = (unsigned char)*s;
6881 max = (unsigned char)*s++;
6882 for ( ; i <= max; i++) {
6885 for (i = 0; i <= (I32) HvMAX(stash); i++) {
6887 for (entry = HvARRAY(stash)[i];
6889 entry = HeNEXT(entry))
6894 if (!todo[(U8)*HeKEY(entry)])
6896 gv = (GV*)HeVAL(entry);
6899 if (SvTHINKFIRST(sv)) {
6900 if (!SvREADONLY(sv) && SvROK(sv))
6902 /* XXX Is this continue a bug? Why should THINKFIRST
6903 exempt us from resetting arrays and hashes? */
6907 if (SvTYPE(sv) >= SVt_PV) {
6909 if (SvPVX_const(sv) != NULL)
6917 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
6919 Perl_die(aTHX_ "Can't reset %%ENV on this system");
6922 # if defined(USE_ENVIRON_ARRAY)
6925 # endif /* USE_ENVIRON_ARRAY */
6936 Using various gambits, try to get an IO from an SV: the IO slot if its a
6937 GV; or the recursive result if we're an RV; or the IO slot of the symbol
6938 named after the PV if we're a string.
6944 Perl_sv_2io(pTHX_ SV *sv)
6949 switch (SvTYPE(sv)) {
6957 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
6961 Perl_croak(aTHX_ PL_no_usym, "filehandle");
6963 return sv_2io(SvRV(sv));
6964 gv = gv_fetchsv(sv, 0, SVt_PVIO);
6970 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
6979 Using various gambits, try to get a CV from an SV; in addition, try if
6980 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
6981 The flags in C<lref> are passed to sv_fetchsv.
6987 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
6994 return *st = NULL, *gvp = NULL, NULL;
6995 switch (SvTYPE(sv)) {
7014 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7015 tryAMAGICunDEREF(to_cv);
7018 if (SvTYPE(sv) == SVt_PVCV) {
7027 Perl_croak(aTHX_ "Not a subroutine reference");
7032 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7038 /* Some flags to gv_fetchsv mean don't really create the GV */
7039 if (SvTYPE(gv) != SVt_PVGV) {
7045 if (lref && !GvCVu(gv)) {
7049 gv_efullname3(tmpsv, gv, NULL);
7050 /* XXX this is probably not what they think they're getting.
7051 * It has the same effect as "sub name;", i.e. just a forward
7053 newSUB(start_subparse(FALSE, 0),
7054 newSVOP(OP_CONST, 0, tmpsv),
7059 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7069 Returns true if the SV has a true value by Perl's rules.
7070 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7071 instead use an in-line version.
7077 Perl_sv_true(pTHX_ register SV *sv)
7082 register const XPV* const tXpv = (XPV*)SvANY(sv);
7084 (tXpv->xpv_cur > 1 ||
7085 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7092 return SvIVX(sv) != 0;
7095 return SvNVX(sv) != 0.0;
7097 return sv_2bool(sv);
7103 =for apidoc sv_pvn_force
7105 Get a sensible string out of the SV somehow.
7106 A private implementation of the C<SvPV_force> macro for compilers which
7107 can't cope with complex macro expressions. Always use the macro instead.
7109 =for apidoc sv_pvn_force_flags
7111 Get a sensible string out of the SV somehow.
7112 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7113 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7114 implemented in terms of this function.
7115 You normally want to use the various wrapper macros instead: see
7116 C<SvPV_force> and C<SvPV_force_nomg>
7122 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7125 if (SvTHINKFIRST(sv) && !SvROK(sv))
7126 sv_force_normal_flags(sv, 0);
7136 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7137 const char * const ref = sv_reftype(sv,0);
7139 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7140 ref, OP_NAME(PL_op));
7142 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7144 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7145 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7147 s = sv_2pv_flags(sv, &len, flags);
7151 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7154 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7155 SvGROW(sv, len + 1);
7156 Move(s,SvPVX(sv),len,char);
7161 SvPOK_on(sv); /* validate pointer */
7163 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7164 PTR2UV(sv),SvPVX_const(sv)));
7167 return SvPVX_mutable(sv);
7171 =for apidoc sv_pvbyten_force
7173 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7179 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7181 sv_pvn_force(sv,lp);
7182 sv_utf8_downgrade(sv,0);
7188 =for apidoc sv_pvutf8n_force
7190 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7196 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7198 sv_pvn_force(sv,lp);
7199 sv_utf8_upgrade(sv);
7205 =for apidoc sv_reftype
7207 Returns a string describing what the SV is a reference to.
7213 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7215 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7216 inside return suggests a const propagation bug in g++. */
7217 if (ob && SvOBJECT(sv)) {
7218 char * const name = HvNAME_get(SvSTASH(sv));
7219 return name ? name : (char *) "__ANON__";
7222 switch (SvTYPE(sv)) {
7239 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7240 /* tied lvalues should appear to be
7241 * scalars for backwards compatitbility */
7242 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7243 ? "SCALAR" : "LVALUE");
7244 case SVt_PVAV: return "ARRAY";
7245 case SVt_PVHV: return "HASH";
7246 case SVt_PVCV: return "CODE";
7247 case SVt_PVGV: return "GLOB";
7248 case SVt_PVFM: return "FORMAT";
7249 case SVt_PVIO: return "IO";
7250 default: return "UNKNOWN";
7256 =for apidoc sv_isobject
7258 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7259 object. If the SV is not an RV, or if the object is not blessed, then this
7266 Perl_sv_isobject(pTHX_ SV *sv)
7282 Returns a boolean indicating whether the SV is blessed into the specified
7283 class. This does not check for subtypes; use C<sv_derived_from> to verify
7284 an inheritance relationship.
7290 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7301 hvname = HvNAME_get(SvSTASH(sv));
7305 return strEQ(hvname, name);
7311 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7312 it will be upgraded to one. If C<classname> is non-null then the new SV will
7313 be blessed in the specified package. The new SV is returned and its
7314 reference count is 1.
7320 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7327 SV_CHECK_THINKFIRST_COW_DROP(rv);
7330 if (SvTYPE(rv) >= SVt_PVMG) {
7331 const U32 refcnt = SvREFCNT(rv);
7335 SvREFCNT(rv) = refcnt;
7338 if (SvTYPE(rv) < SVt_RV)
7339 sv_upgrade(rv, SVt_RV);
7340 else if (SvTYPE(rv) > SVt_RV) {
7351 HV* const stash = gv_stashpv(classname, TRUE);
7352 (void)sv_bless(rv, stash);
7358 =for apidoc sv_setref_pv
7360 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7361 argument will be upgraded to an RV. That RV will be modified to point to
7362 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7363 into the SV. The C<classname> argument indicates the package for the
7364 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7365 will have a reference count of 1, and the RV will be returned.
7367 Do not use with other Perl types such as HV, AV, SV, CV, because those
7368 objects will become corrupted by the pointer copy process.
7370 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7376 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7380 sv_setsv(rv, &PL_sv_undef);
7384 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7389 =for apidoc sv_setref_iv
7391 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7392 argument will be upgraded to an RV. That RV will be modified to point to
7393 the new SV. The C<classname> argument indicates the package for the
7394 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7395 will have a reference count of 1, and the RV will be returned.
7401 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7403 sv_setiv(newSVrv(rv,classname), iv);
7408 =for apidoc sv_setref_uv
7410 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7411 argument will be upgraded to an RV. That RV will be modified to point to
7412 the new SV. The C<classname> argument indicates the package for the
7413 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7414 will have a reference count of 1, and the RV will be returned.
7420 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7422 sv_setuv(newSVrv(rv,classname), uv);
7427 =for apidoc sv_setref_nv
7429 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7430 argument will be upgraded to an RV. That RV will be modified to point to
7431 the new SV. The C<classname> argument indicates the package for the
7432 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7433 will have a reference count of 1, and the RV will be returned.
7439 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7441 sv_setnv(newSVrv(rv,classname), nv);
7446 =for apidoc sv_setref_pvn
7448 Copies a string into a new SV, optionally blessing the SV. The length of the
7449 string must be specified with C<n>. The C<rv> argument will be upgraded to
7450 an RV. That RV will be modified to point to the new SV. The C<classname>
7451 argument indicates the package for the blessing. Set C<classname> to
7452 C<NULL> to avoid the blessing. The new SV will have a reference count
7453 of 1, and the RV will be returned.
7455 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7461 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7463 sv_setpvn(newSVrv(rv,classname), pv, n);
7468 =for apidoc sv_bless
7470 Blesses an SV into a specified package. The SV must be an RV. The package
7471 must be designated by its stash (see C<gv_stashpv()>). The reference count
7472 of the SV is unaffected.
7478 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7483 Perl_croak(aTHX_ "Can't bless non-reference value");
7485 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7486 if (SvREADONLY(tmpRef))
7487 Perl_croak(aTHX_ PL_no_modify);
7488 if (SvOBJECT(tmpRef)) {
7489 if (SvTYPE(tmpRef) != SVt_PVIO)
7491 SvREFCNT_dec(SvSTASH(tmpRef));
7494 SvOBJECT_on(tmpRef);
7495 if (SvTYPE(tmpRef) != SVt_PVIO)
7497 SvUPGRADE(tmpRef, SVt_PVMG);
7498 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
7505 if(SvSMAGICAL(tmpRef))
7506 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7514 /* Downgrades a PVGV to a PVMG.
7518 S_sv_unglob(pTHX_ SV *sv)
7523 assert(SvTYPE(sv) == SVt_PVGV);
7528 sv_del_backref((SV*)GvSTASH(sv), sv);
7531 sv_unmagic(sv, PERL_MAGIC_glob);
7532 Safefree(GvNAME(sv));
7535 /* need to keep SvANY(sv) in the right arena */
7536 xpvmg = new_XPVMG();
7537 StructCopy(SvANY(sv), xpvmg, XPVMG);
7538 del_XPVGV(SvANY(sv));
7541 SvFLAGS(sv) &= ~SVTYPEMASK;
7542 SvFLAGS(sv) |= SVt_PVMG;
7546 =for apidoc sv_unref_flags
7548 Unsets the RV status of the SV, and decrements the reference count of
7549 whatever was being referenced by the RV. This can almost be thought of
7550 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7551 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7552 (otherwise the decrementing is conditional on the reference count being
7553 different from one or the reference being a readonly SV).
7560 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7562 SV* const target = SvRV(ref);
7564 if (SvWEAKREF(ref)) {
7565 sv_del_backref(target, ref);
7567 SvRV_set(ref, NULL);
7570 SvRV_set(ref, NULL);
7572 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7573 assigned to as BEGIN {$a = \"Foo"} will fail. */
7574 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7575 SvREFCNT_dec(target);
7576 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7577 sv_2mortal(target); /* Schedule for freeing later */
7581 =for apidoc sv_untaint
7583 Untaint an SV. Use C<SvTAINTED_off> instead.
7588 Perl_sv_untaint(pTHX_ SV *sv)
7590 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7591 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7598 =for apidoc sv_tainted
7600 Test an SV for taintedness. Use C<SvTAINTED> instead.
7605 Perl_sv_tainted(pTHX_ SV *sv)
7607 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7608 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7609 if (mg && (mg->mg_len & 1) )
7616 =for apidoc sv_setpviv
7618 Copies an integer into the given SV, also updating its string value.
7619 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7625 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7627 char buf[TYPE_CHARS(UV)];
7629 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7631 sv_setpvn(sv, ptr, ebuf - ptr);
7635 =for apidoc sv_setpviv_mg
7637 Like C<sv_setpviv>, but also handles 'set' magic.
7643 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
7649 #if defined(PERL_IMPLICIT_CONTEXT)
7651 /* pTHX_ magic can't cope with varargs, so this is a no-context
7652 * version of the main function, (which may itself be aliased to us).
7653 * Don't access this version directly.
7657 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7661 va_start(args, pat);
7662 sv_vsetpvf(sv, pat, &args);
7666 /* pTHX_ magic can't cope with varargs, so this is a no-context
7667 * version of the main function, (which may itself be aliased to us).
7668 * Don't access this version directly.
7672 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
7676 va_start(args, pat);
7677 sv_vsetpvf_mg(sv, pat, &args);
7683 =for apidoc sv_setpvf
7685 Works like C<sv_catpvf> but copies the text into the SV instead of
7686 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
7692 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
7695 va_start(args, pat);
7696 sv_vsetpvf(sv, pat, &args);
7701 =for apidoc sv_vsetpvf
7703 Works like C<sv_vcatpvf> but copies the text into the SV instead of
7704 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
7706 Usually used via its frontend C<sv_setpvf>.
7712 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7714 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7718 =for apidoc sv_setpvf_mg
7720 Like C<sv_setpvf>, but also handles 'set' magic.
7726 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7729 va_start(args, pat);
7730 sv_vsetpvf_mg(sv, pat, &args);
7735 =for apidoc sv_vsetpvf_mg
7737 Like C<sv_vsetpvf>, but also handles 'set' magic.
7739 Usually used via its frontend C<sv_setpvf_mg>.
7745 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7747 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7751 #if defined(PERL_IMPLICIT_CONTEXT)
7753 /* pTHX_ magic can't cope with varargs, so this is a no-context
7754 * version of the main function, (which may itself be aliased to us).
7755 * Don't access this version directly.
7759 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
7763 va_start(args, pat);
7764 sv_vcatpvf(sv, pat, &args);
7768 /* pTHX_ magic can't cope with varargs, so this is a no-context
7769 * version of the main function, (which may itself be aliased to us).
7770 * Don't access this version directly.
7774 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
7778 va_start(args, pat);
7779 sv_vcatpvf_mg(sv, pat, &args);
7785 =for apidoc sv_catpvf
7787 Processes its arguments like C<sprintf> and appends the formatted
7788 output to an SV. If the appended data contains "wide" characters
7789 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
7790 and characters >255 formatted with %c), the original SV might get
7791 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
7792 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
7793 valid UTF-8; if the original SV was bytes, the pattern should be too.
7798 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
7801 va_start(args, pat);
7802 sv_vcatpvf(sv, pat, &args);
7807 =for apidoc sv_vcatpvf
7809 Processes its arguments like C<vsprintf> and appends the formatted output
7810 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
7812 Usually used via its frontend C<sv_catpvf>.
7818 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
7820 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7824 =for apidoc sv_catpvf_mg
7826 Like C<sv_catpvf>, but also handles 'set' magic.
7832 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
7835 va_start(args, pat);
7836 sv_vcatpvf_mg(sv, pat, &args);
7841 =for apidoc sv_vcatpvf_mg
7843 Like C<sv_vcatpvf>, but also handles 'set' magic.
7845 Usually used via its frontend C<sv_catpvf_mg>.
7851 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
7853 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7858 =for apidoc sv_vsetpvfn
7860 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
7863 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
7869 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7871 sv_setpvn(sv, "", 0);
7872 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
7876 S_expect_number(pTHX_ char** pattern)
7880 switch (**pattern) {
7881 case '1': case '2': case '3':
7882 case '4': case '5': case '6':
7883 case '7': case '8': case '9':
7884 var = *(*pattern)++ - '0';
7885 while (isDIGIT(**pattern)) {
7886 I32 tmp = var * 10 + (*(*pattern)++ - '0');
7888 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
7896 S_F0convert(NV nv, char *endbuf, STRLEN *len)
7898 const int neg = nv < 0;
7907 if (uv & 1 && uv == nv)
7908 uv--; /* Round to even */
7910 const unsigned dig = uv % 10;
7923 =for apidoc sv_vcatpvfn
7925 Processes its arguments like C<vsprintf> and appends the formatted output
7926 to an SV. Uses an array of SVs if the C style variable argument list is
7927 missing (NULL). When running with taint checks enabled, indicates via
7928 C<maybe_tainted> if results are untrustworthy (often due to the use of
7931 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
7937 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
7938 vecstr = (U8*)SvPV_const(vecsv,veclen);\
7939 vec_utf8 = DO_UTF8(vecsv);
7941 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
7944 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
7952 static const char nullstr[] = "(null)";
7954 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
7955 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
7957 /* Times 4: a decimal digit takes more than 3 binary digits.
7958 * NV_DIG: mantissa takes than many decimal digits.
7959 * Plus 32: Playing safe. */
7960 char ebuf[IV_DIG * 4 + NV_DIG + 32];
7961 /* large enough for "%#.#f" --chip */
7962 /* what about long double NVs? --jhi */
7964 PERL_UNUSED_ARG(maybe_tainted);
7966 /* no matter what, this is a string now */
7967 (void)SvPV_force(sv, origlen);
7969 /* special-case "", "%s", and "%-p" (SVf - see below) */
7972 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
7974 const char * const s = va_arg(*args, char*);
7975 sv_catpv(sv, s ? s : nullstr);
7977 else if (svix < svmax) {
7978 sv_catsv(sv, *svargs);
7982 if (args && patlen == 3 && pat[0] == '%' &&
7983 pat[1] == '-' && pat[2] == 'p') {
7984 argsv = va_arg(*args, SV*);
7985 sv_catsv(sv, argsv);
7989 #ifndef USE_LONG_DOUBLE
7990 /* special-case "%.<number>[gf]" */
7991 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
7992 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
7993 unsigned digits = 0;
7997 while (*pp >= '0' && *pp <= '9')
7998 digits = 10 * digits + (*pp++ - '0');
7999 if (pp - pat == (int)patlen - 1) {
8007 /* Add check for digits != 0 because it seems that some
8008 gconverts are buggy in this case, and we don't yet have
8009 a Configure test for this. */
8010 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8011 /* 0, point, slack */
8012 Gconvert(nv, (int)digits, 0, ebuf);
8014 if (*ebuf) /* May return an empty string for digits==0 */
8017 } else if (!digits) {
8020 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8021 sv_catpvn(sv, p, l);
8027 #endif /* !USE_LONG_DOUBLE */
8029 if (!args && svix < svmax && DO_UTF8(*svargs))
8032 patend = (char*)pat + patlen;
8033 for (p = (char*)pat; p < patend; p = q) {
8036 bool vectorize = FALSE;
8037 bool vectorarg = FALSE;
8038 bool vec_utf8 = FALSE;
8044 bool has_precis = FALSE;
8046 const I32 osvix = svix;
8047 bool is_utf8 = FALSE; /* is this item utf8? */
8048 #ifdef HAS_LDBL_SPRINTF_BUG
8049 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8050 with sfio - Allen <allens@cpan.org> */
8051 bool fix_ldbl_sprintf_bug = FALSE;
8055 U8 utf8buf[UTF8_MAXBYTES+1];
8056 STRLEN esignlen = 0;
8058 const char *eptr = NULL;
8061 const U8 *vecstr = Null(U8*);
8068 /* we need a long double target in case HAS_LONG_DOUBLE but
8071 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8079 const char *dotstr = ".";
8080 STRLEN dotstrlen = 1;
8081 I32 efix = 0; /* explicit format parameter index */
8082 I32 ewix = 0; /* explicit width index */
8083 I32 epix = 0; /* explicit precision index */
8084 I32 evix = 0; /* explicit vector index */
8085 bool asterisk = FALSE;
8087 /* echo everything up to the next format specification */
8088 for (q = p; q < patend && *q != '%'; ++q) ;
8090 if (has_utf8 && !pat_utf8)
8091 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8093 sv_catpvn(sv, p, q - p);
8100 We allow format specification elements in this order:
8101 \d+\$ explicit format parameter index
8103 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8104 0 flag (as above): repeated to allow "v02"
8105 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8106 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8108 [%bcdefginopsuxDFOUX] format (mandatory)
8113 As of perl5.9.3, printf format checking is on by default.
8114 Internally, perl uses %p formats to provide an escape to
8115 some extended formatting. This block deals with those
8116 extensions: if it does not match, (char*)q is reset and
8117 the normal format processing code is used.
8119 Currently defined extensions are:
8120 %p include pointer address (standard)
8121 %-p (SVf) include an SV (previously %_)
8122 %-<num>p include an SV with precision <num>
8123 %1p (VDf) include a v-string (as %vd)
8124 %<num>p reserved for future extensions
8126 Robin Barker 2005-07-14
8133 n = expect_number(&q);
8140 argsv = va_arg(*args, SV*);
8141 eptr = SvPVx_const(argsv, elen);
8147 else if (n == vdNUMBER) { /* VDf */
8154 if (ckWARN_d(WARN_INTERNAL))
8155 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8156 "internal %%<num>p might conflict with future printf extensions");
8162 if ( (width = expect_number(&q)) ) {
8203 if ( (ewix = expect_number(&q)) )
8212 if ((vectorarg = asterisk)) {
8225 width = expect_number(&q);
8231 vecsv = va_arg(*args, SV*);
8233 vecsv = (evix > 0 && evix <= svmax)
8234 ? svargs[evix-1] : &PL_sv_undef;
8236 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8238 dotstr = SvPV_const(vecsv, dotstrlen);
8239 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8240 bad with tied or overloaded values that return UTF8. */
8243 else if (has_utf8) {
8244 vecsv = sv_mortalcopy(vecsv);
8245 sv_utf8_upgrade(vecsv);
8246 dotstr = SvPV_const(vecsv, dotstrlen);
8253 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8254 vecsv = svargs[efix ? efix-1 : svix++];
8255 vecstr = (U8*)SvPV_const(vecsv,veclen);
8256 vec_utf8 = DO_UTF8(vecsv);
8258 /* if this is a version object, we need to convert
8259 * back into v-string notation and then let the
8260 * vectorize happen normally
8262 if (sv_derived_from(vecsv, "version")) {
8263 char *version = savesvpv(vecsv);
8264 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8265 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8266 "vector argument not supported with alpha versions");
8269 vecsv = sv_newmortal();
8270 /* scan_vstring is expected to be called during
8271 * tokenization, so we need to fake up the end
8272 * of the buffer for it
8274 PL_bufend = version + veclen;
8275 scan_vstring(version, vecsv);
8276 vecstr = (U8*)SvPV_const(vecsv, veclen);
8277 vec_utf8 = DO_UTF8(vecsv);
8289 i = va_arg(*args, int);
8291 i = (ewix ? ewix <= svmax : svix < svmax) ?
8292 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8294 width = (i < 0) ? -i : i;
8304 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8306 /* XXX: todo, support specified precision parameter */
8310 i = va_arg(*args, int);
8312 i = (ewix ? ewix <= svmax : svix < svmax)
8313 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8314 precis = (i < 0) ? 0 : i;
8319 precis = precis * 10 + (*q++ - '0');
8328 case 'I': /* Ix, I32x, and I64x */
8330 if (q[1] == '6' && q[2] == '4') {
8336 if (q[1] == '3' && q[2] == '2') {
8346 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8357 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8358 if (*(q + 1) == 'l') { /* lld, llf */
8384 if (!vectorize && !args) {
8386 const I32 i = efix-1;
8387 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8389 argsv = (svix >= 0 && svix < svmax)
8390 ? svargs[svix++] : &PL_sv_undef;
8401 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8403 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8405 eptr = (char*)utf8buf;
8406 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8420 eptr = va_arg(*args, char*);
8422 #ifdef MACOS_TRADITIONAL
8423 /* On MacOS, %#s format is used for Pascal strings */
8428 elen = strlen(eptr);
8430 eptr = (char *)nullstr;
8431 elen = sizeof nullstr - 1;
8435 eptr = SvPVx_const(argsv, elen);
8436 if (DO_UTF8(argsv)) {
8437 if (has_precis && precis < elen) {
8439 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8442 if (width) { /* fudge width (can't fudge elen) */
8443 width += elen - sv_len_utf8(argsv);
8450 if (has_precis && elen > precis)
8457 if (alt || vectorize)
8459 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8480 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8489 esignbuf[esignlen++] = plus;
8493 case 'h': iv = (short)va_arg(*args, int); break;
8494 case 'l': iv = va_arg(*args, long); break;
8495 case 'V': iv = va_arg(*args, IV); break;
8496 default: iv = va_arg(*args, int); break;
8498 case 'q': iv = va_arg(*args, Quad_t); break;
8503 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8505 case 'h': iv = (short)tiv; break;
8506 case 'l': iv = (long)tiv; break;
8508 default: iv = tiv; break;
8510 case 'q': iv = (Quad_t)tiv; break;
8514 if ( !vectorize ) /* we already set uv above */
8519 esignbuf[esignlen++] = plus;
8523 esignbuf[esignlen++] = '-';
8566 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8577 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8578 case 'l': uv = va_arg(*args, unsigned long); break;
8579 case 'V': uv = va_arg(*args, UV); break;
8580 default: uv = va_arg(*args, unsigned); break;
8582 case 'q': uv = va_arg(*args, Uquad_t); break;
8587 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8589 case 'h': uv = (unsigned short)tuv; break;
8590 case 'l': uv = (unsigned long)tuv; break;
8592 default: uv = tuv; break;
8594 case 'q': uv = (Uquad_t)tuv; break;
8601 char *ptr = ebuf + sizeof ebuf;
8607 p = (char*)((c == 'X')
8608 ? "0123456789ABCDEF" : "0123456789abcdef");
8614 esignbuf[esignlen++] = '0';
8615 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8623 if (alt && *ptr != '0')
8634 esignbuf[esignlen++] = '0';
8635 esignbuf[esignlen++] = 'b';
8638 default: /* it had better be ten or less */
8642 } while (uv /= base);
8645 elen = (ebuf + sizeof ebuf) - ptr;
8649 zeros = precis - elen;
8650 else if (precis == 0 && elen == 1 && *eptr == '0')
8656 /* FLOATING POINT */
8659 c = 'f'; /* maybe %F isn't supported here */
8667 /* This is evil, but floating point is even more evil */
8669 /* for SV-style calling, we can only get NV
8670 for C-style calling, we assume %f is double;
8671 for simplicity we allow any of %Lf, %llf, %qf for long double
8675 #if defined(USE_LONG_DOUBLE)
8679 /* [perl #20339] - we should accept and ignore %lf rather than die */
8683 #if defined(USE_LONG_DOUBLE)
8684 intsize = args ? 0 : 'q';
8688 #if defined(HAS_LONG_DOUBLE)
8697 /* now we need (long double) if intsize == 'q', else (double) */
8699 #if LONG_DOUBLESIZE > DOUBLESIZE
8701 va_arg(*args, long double) :
8702 va_arg(*args, double)
8704 va_arg(*args, double)
8709 if (c != 'e' && c != 'E') {
8711 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8712 will cast our (long double) to (double) */
8713 (void)Perl_frexp(nv, &i);
8714 if (i == PERL_INT_MIN)
8715 Perl_die(aTHX_ "panic: frexp");
8717 need = BIT_DIGITS(i);
8719 need += has_precis ? precis : 6; /* known default */
8724 #ifdef HAS_LDBL_SPRINTF_BUG
8725 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8726 with sfio - Allen <allens@cpan.org> */
8729 # define MY_DBL_MAX DBL_MAX
8730 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8731 # if DOUBLESIZE >= 8
8732 # define MY_DBL_MAX 1.7976931348623157E+308L
8734 # define MY_DBL_MAX 3.40282347E+38L
8738 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8739 # define MY_DBL_MAX_BUG 1L
8741 # define MY_DBL_MAX_BUG MY_DBL_MAX
8745 # define MY_DBL_MIN DBL_MIN
8746 # else /* XXX guessing! -Allen */
8747 # if DOUBLESIZE >= 8
8748 # define MY_DBL_MIN 2.2250738585072014E-308L
8750 # define MY_DBL_MIN 1.17549435E-38L
8754 if ((intsize == 'q') && (c == 'f') &&
8755 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8757 /* it's going to be short enough that
8758 * long double precision is not needed */
8760 if ((nv <= 0L) && (nv >= -0L))
8761 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8763 /* would use Perl_fp_class as a double-check but not
8764 * functional on IRIX - see perl.h comments */
8766 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8767 /* It's within the range that a double can represent */
8768 #if defined(DBL_MAX) && !defined(DBL_MIN)
8769 if ((nv >= ((long double)1/DBL_MAX)) ||
8770 (nv <= (-(long double)1/DBL_MAX)))
8772 fix_ldbl_sprintf_bug = TRUE;
8775 if (fix_ldbl_sprintf_bug == TRUE) {
8785 # undef MY_DBL_MAX_BUG
8788 #endif /* HAS_LDBL_SPRINTF_BUG */
8790 need += 20; /* fudge factor */
8791 if (PL_efloatsize < need) {
8792 Safefree(PL_efloatbuf);
8793 PL_efloatsize = need + 20; /* more fudge */
8794 Newx(PL_efloatbuf, PL_efloatsize, char);
8795 PL_efloatbuf[0] = '\0';
8798 if ( !(width || left || plus || alt) && fill != '0'
8799 && has_precis && intsize != 'q' ) { /* Shortcuts */
8800 /* See earlier comment about buggy Gconvert when digits,
8802 if ( c == 'g' && precis) {
8803 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
8804 /* May return an empty string for digits==0 */
8805 if (*PL_efloatbuf) {
8806 elen = strlen(PL_efloatbuf);
8807 goto float_converted;
8809 } else if ( c == 'f' && !precis) {
8810 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
8815 char *ptr = ebuf + sizeof ebuf;
8818 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8819 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8820 if (intsize == 'q') {
8821 /* Copy the one or more characters in a long double
8822 * format before the 'base' ([efgEFG]) character to
8823 * the format string. */
8824 static char const prifldbl[] = PERL_PRIfldbl;
8825 char const *p = prifldbl + sizeof(prifldbl) - 3;
8826 while (p >= prifldbl) { *--ptr = *p--; }
8831 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8836 do { *--ptr = '0' + (base % 10); } while (base /= 10);
8848 /* No taint. Otherwise we are in the strange situation
8849 * where printf() taints but print($float) doesn't.
8851 #if defined(HAS_LONG_DOUBLE)
8852 elen = ((intsize == 'q')
8853 ? my_sprintf(PL_efloatbuf, ptr, nv)
8854 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
8856 elen = my_sprintf(PL_efloatbuf, ptr, nv);
8860 eptr = PL_efloatbuf;
8868 i = SvCUR(sv) - origlen;
8871 case 'h': *(va_arg(*args, short*)) = i; break;
8872 default: *(va_arg(*args, int*)) = i; break;
8873 case 'l': *(va_arg(*args, long*)) = i; break;
8874 case 'V': *(va_arg(*args, IV*)) = i; break;
8876 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8881 sv_setuv_mg(argsv, (UV)i);
8882 continue; /* not "break" */
8889 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
8890 && ckWARN(WARN_PRINTF))
8892 SV * const msg = sv_newmortal();
8893 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
8894 (PL_op->op_type == OP_PRTF) ? "" : "s");
8897 Perl_sv_catpvf(aTHX_ msg,
8898 "\"%%%c\"", c & 0xFF);
8900 Perl_sv_catpvf(aTHX_ msg,
8901 "\"%%\\%03"UVof"\"",
8904 sv_catpvs(msg, "end of string");
8905 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
8908 /* output mangled stuff ... */
8914 /* ... right here, because formatting flags should not apply */
8915 SvGROW(sv, SvCUR(sv) + elen + 1);
8917 Copy(eptr, p, elen, char);
8920 SvCUR_set(sv, p - SvPVX_const(sv));
8922 continue; /* not "break" */
8925 /* calculate width before utf8_upgrade changes it */
8926 have = esignlen + zeros + elen;
8928 Perl_croak_nocontext(PL_memory_wrap);
8930 if (is_utf8 != has_utf8) {
8933 sv_utf8_upgrade(sv);
8936 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
8937 sv_utf8_upgrade(nsv);
8938 eptr = SvPVX_const(nsv);
8941 SvGROW(sv, SvCUR(sv) + elen + 1);
8946 need = (have > width ? have : width);
8949 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
8950 Perl_croak_nocontext(PL_memory_wrap);
8951 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
8953 if (esignlen && fill == '0') {
8955 for (i = 0; i < (int)esignlen; i++)
8959 memset(p, fill, gap);
8962 if (esignlen && fill != '0') {
8964 for (i = 0; i < (int)esignlen; i++)
8969 for (i = zeros; i; i--)
8973 Copy(eptr, p, elen, char);
8977 memset(p, ' ', gap);
8982 Copy(dotstr, p, dotstrlen, char);
8986 vectorize = FALSE; /* done iterating over vecstr */
8993 SvCUR_set(sv, p - SvPVX_const(sv));
9001 /* =========================================================================
9003 =head1 Cloning an interpreter
9005 All the macros and functions in this section are for the private use of
9006 the main function, perl_clone().
9008 The foo_dup() functions make an exact copy of an existing foo thinngy.
9009 During the course of a cloning, a hash table is used to map old addresses
9010 to new addresses. The table is created and manipulated with the
9011 ptr_table_* functions.
9015 ============================================================================*/
9018 #if defined(USE_ITHREADS)
9020 #ifndef GpREFCNT_inc
9021 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9025 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9026 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9027 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9028 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9029 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9030 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9031 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9032 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9033 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9034 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9035 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9036 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9037 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9040 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9041 regcomp.c. AMS 20010712 */
9044 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9049 struct reg_substr_datum *s;
9052 return (REGEXP *)NULL;
9054 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9057 len = r->offsets[0];
9058 npar = r->nparens+1;
9060 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9061 Copy(r->program, ret->program, len+1, regnode);
9063 Newx(ret->startp, npar, I32);
9064 Copy(r->startp, ret->startp, npar, I32);
9065 Newx(ret->endp, npar, I32);
9066 Copy(r->startp, ret->startp, npar, I32);
9068 Newx(ret->substrs, 1, struct reg_substr_data);
9069 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9070 s->min_offset = r->substrs->data[i].min_offset;
9071 s->max_offset = r->substrs->data[i].max_offset;
9072 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9073 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9076 ret->regstclass = NULL;
9079 const int count = r->data->count;
9082 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9083 char, struct reg_data);
9084 Newx(d->what, count, U8);
9087 for (i = 0; i < count; i++) {
9088 d->what[i] = r->data->what[i];
9089 switch (d->what[i]) {
9090 /* legal options are one of: sfpont
9091 see also regcomp.h and pregfree() */
9093 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9096 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9099 /* This is cheating. */
9100 Newx(d->data[i], 1, struct regnode_charclass_class);
9101 StructCopy(r->data->data[i], d->data[i],
9102 struct regnode_charclass_class);
9103 ret->regstclass = (regnode*)d->data[i];
9106 /* Compiled op trees are readonly, and can thus be
9107 shared without duplication. */
9109 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9113 d->data[i] = r->data->data[i];
9116 d->data[i] = r->data->data[i];
9118 ((reg_trie_data*)d->data[i])->refcount++;
9122 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9131 Newx(ret->offsets, 2*len+1, U32);
9132 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9134 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9135 ret->refcnt = r->refcnt;
9136 ret->minlen = r->minlen;
9137 ret->prelen = r->prelen;
9138 ret->nparens = r->nparens;
9139 ret->lastparen = r->lastparen;
9140 ret->lastcloseparen = r->lastcloseparen;
9141 ret->reganch = r->reganch;
9143 ret->sublen = r->sublen;
9145 if (RX_MATCH_COPIED(ret))
9146 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9149 #ifdef PERL_OLD_COPY_ON_WRITE
9150 ret->saved_copy = NULL;
9153 ptr_table_store(PL_ptr_table, r, ret);
9157 /* duplicate a file handle */
9160 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9164 PERL_UNUSED_ARG(type);
9167 return (PerlIO*)NULL;
9169 /* look for it in the table first */
9170 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9174 /* create anew and remember what it is */
9175 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9176 ptr_table_store(PL_ptr_table, fp, ret);
9180 /* duplicate a directory handle */
9183 Perl_dirp_dup(pTHX_ DIR *dp)
9191 /* duplicate a typeglob */
9194 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9199 /* look for it in the table first */
9200 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9204 /* create anew and remember what it is */
9206 ptr_table_store(PL_ptr_table, gp, ret);
9209 ret->gp_refcnt = 0; /* must be before any other dups! */
9210 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9211 ret->gp_io = io_dup_inc(gp->gp_io, param);
9212 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9213 ret->gp_av = av_dup_inc(gp->gp_av, param);
9214 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9215 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9216 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9217 ret->gp_cvgen = gp->gp_cvgen;
9218 ret->gp_line = gp->gp_line;
9219 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9223 /* duplicate a chain of magic */
9226 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9228 MAGIC *mgprev = (MAGIC*)NULL;
9231 return (MAGIC*)NULL;
9232 /* look for it in the table first */
9233 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9237 for (; mg; mg = mg->mg_moremagic) {
9239 Newxz(nmg, 1, MAGIC);
9241 mgprev->mg_moremagic = nmg;
9244 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9245 nmg->mg_private = mg->mg_private;
9246 nmg->mg_type = mg->mg_type;
9247 nmg->mg_flags = mg->mg_flags;
9248 if (mg->mg_type == PERL_MAGIC_qr) {
9249 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9251 else if(mg->mg_type == PERL_MAGIC_backref) {
9252 /* The backref AV has its reference count deliberately bumped by
9254 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9256 else if (mg->mg_type == PERL_MAGIC_symtab) {
9257 nmg->mg_obj = mg->mg_obj;
9260 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9261 ? sv_dup_inc(mg->mg_obj, param)
9262 : sv_dup(mg->mg_obj, param);
9264 nmg->mg_len = mg->mg_len;
9265 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9266 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9267 if (mg->mg_len > 0) {
9268 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9269 if (mg->mg_type == PERL_MAGIC_overload_table &&
9270 AMT_AMAGIC((AMT*)mg->mg_ptr))
9272 const AMT * const amtp = (AMT*)mg->mg_ptr;
9273 AMT * const namtp = (AMT*)nmg->mg_ptr;
9275 for (i = 1; i < NofAMmeth; i++) {
9276 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9280 else if (mg->mg_len == HEf_SVKEY)
9281 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9283 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9284 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9291 /* create a new pointer-mapping table */
9294 Perl_ptr_table_new(pTHX)
9297 Newxz(tbl, 1, PTR_TBL_t);
9300 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9304 #define PTR_TABLE_HASH(ptr) \
9305 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9308 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9309 following define) and at call to new_body_inline made below in
9310 Perl_ptr_table_store()
9313 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9315 /* map an existing pointer using a table */
9317 STATIC PTR_TBL_ENT_t *
9318 S_ptr_table_find(pTHX_ PTR_TBL_t *tbl, const void *sv) {
9319 PTR_TBL_ENT_t *tblent;
9320 const UV hash = PTR_TABLE_HASH(sv);
9322 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9323 for (; tblent; tblent = tblent->next) {
9324 if (tblent->oldval == sv)
9331 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9333 PTR_TBL_ENT_t const *const tblent = S_ptr_table_find(aTHX_ tbl, sv);
9334 return tblent ? tblent->newval : (void *) 0;
9337 /* add a new entry to a pointer-mapping table */
9340 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9342 PTR_TBL_ENT_t *tblent = S_ptr_table_find(aTHX_ tbl, oldsv);
9345 tblent->newval = newsv;
9347 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9349 new_body_inline(tblent, sizeof(struct ptr_tbl_ent), PTE_SVSLOT);
9350 tblent->oldval = oldsv;
9351 tblent->newval = newsv;
9352 tblent->next = tbl->tbl_ary[entry];
9353 tbl->tbl_ary[entry] = tblent;
9355 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9356 ptr_table_split(tbl);
9360 /* double the hash bucket size of an existing ptr table */
9363 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9365 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9366 const UV oldsize = tbl->tbl_max + 1;
9367 UV newsize = oldsize * 2;
9370 Renew(ary, newsize, PTR_TBL_ENT_t*);
9371 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9372 tbl->tbl_max = --newsize;
9374 for (i=0; i < oldsize; i++, ary++) {
9375 PTR_TBL_ENT_t **curentp, **entp, *ent;
9378 curentp = ary + oldsize;
9379 for (entp = ary, ent = *ary; ent; ent = *entp) {
9380 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9382 ent->next = *curentp;
9392 /* remove all the entries from a ptr table */
9395 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9397 if (tbl && tbl->tbl_items) {
9398 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9399 UV riter = tbl->tbl_max;
9402 PTR_TBL_ENT_t *entry = array[riter];
9405 PTR_TBL_ENT_t * const oentry = entry;
9406 entry = entry->next;
9415 /* clear and free a ptr table */
9418 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9423 ptr_table_clear(tbl);
9424 Safefree(tbl->tbl_ary);
9430 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9433 SvRV_set(dstr, SvWEAKREF(sstr)
9434 ? sv_dup(SvRV(sstr), param)
9435 : sv_dup_inc(SvRV(sstr), param));
9438 else if (SvPVX_const(sstr)) {
9439 /* Has something there */
9441 /* Normal PV - clone whole allocated space */
9442 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9443 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9444 /* Not that normal - actually sstr is copy on write.
9445 But we are a true, independant SV, so: */
9446 SvREADONLY_off(dstr);
9451 /* Special case - not normally malloced for some reason */
9452 if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9453 /* A "shared" PV - clone it as "shared" PV */
9455 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9459 /* Some other special case - random pointer */
9460 SvPV_set(dstr, SvPVX(sstr));
9466 if (SvTYPE(dstr) == SVt_RV)
9467 SvRV_set(dstr, NULL);
9469 SvPV_set(dstr, NULL);
9473 /* duplicate an SV of any type (including AV, HV etc) */
9476 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9481 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9483 /* look for it in the table first */
9484 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9488 if(param->flags & CLONEf_JOIN_IN) {
9489 /** We are joining here so we don't want do clone
9490 something that is bad **/
9491 if (SvTYPE(sstr) == SVt_PVHV) {
9492 const char * const hvname = HvNAME_get(sstr);
9494 /** don't clone stashes if they already exist **/
9495 return (SV*)gv_stashpv(hvname,0);
9499 /* create anew and remember what it is */
9502 #ifdef DEBUG_LEAKING_SCALARS
9503 dstr->sv_debug_optype = sstr->sv_debug_optype;
9504 dstr->sv_debug_line = sstr->sv_debug_line;
9505 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9506 dstr->sv_debug_cloned = 1;
9507 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9510 ptr_table_store(PL_ptr_table, sstr, dstr);
9513 SvFLAGS(dstr) = SvFLAGS(sstr);
9514 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9515 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9518 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9519 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9520 PL_watch_pvx, SvPVX_const(sstr));
9523 /* don't clone objects whose class has asked us not to */
9524 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9525 SvFLAGS(dstr) &= ~SVTYPEMASK;
9530 switch (SvTYPE(sstr)) {
9535 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9536 SvIV_set(dstr, SvIVX(sstr));
9539 SvANY(dstr) = new_XNV();
9540 SvNV_set(dstr, SvNVX(sstr));
9543 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9544 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9548 /* These are all the types that need complex bodies allocating. */
9550 const svtype sv_type = SvTYPE(sstr);
9551 const struct body_details *const sv_type_details
9552 = bodies_by_type + sv_type;
9556 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]",
9561 if (GvUNIQUE((GV*)sstr)) {
9562 /* Do sharing here, and fall through */
9575 assert(sv_type_details->size);
9576 if (sv_type_details->arena) {
9577 new_body_inline(new_body, sv_type_details->size, sv_type);
9579 = (void*)((char*)new_body - sv_type_details->offset);
9581 new_body = new_NOARENA(sv_type_details);
9585 SvANY(dstr) = new_body;
9588 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9589 ((char*)SvANY(dstr)) + sv_type_details->offset,
9590 sv_type_details->copy, char);
9592 Copy(((char*)SvANY(sstr)),
9593 ((char*)SvANY(dstr)),
9594 sv_type_details->size + sv_type_details->offset, char);
9597 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV)
9598 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9600 /* The Copy above means that all the source (unduplicated) pointers
9601 are now in the destination. We can check the flags and the
9602 pointers in either, but it's possible that there's less cache
9603 missing by always going for the destination.
9604 FIXME - instrument and check that assumption */
9605 if (sv_type >= SVt_PVMG) {
9607 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9609 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9612 /* The cast silences a GCC warning about unhandled types. */
9613 switch ((int)sv_type) {
9625 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
9626 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
9627 LvTARG(dstr) = dstr;
9628 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
9629 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
9631 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
9634 GvNAME(dstr) = SAVEPVN(GvNAME(dstr), GvNAMELEN(dstr));
9635 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
9636 /* Don't call sv_add_backref here as it's going to be created
9637 as part of the magic cloning of the symbol table. */
9638 GvGP(dstr) = gp_dup(GvGP(dstr), param);
9639 (void)GpREFCNT_inc(GvGP(dstr));
9642 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
9643 if (IoOFP(dstr) == IoIFP(sstr))
9644 IoOFP(dstr) = IoIFP(dstr);
9646 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
9647 /* PL_rsfp_filters entries have fake IoDIRP() */
9648 if (IoDIRP(dstr) && !(IoFLAGS(dstr) & IOf_FAKE_DIRP))
9649 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
9650 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
9651 /* I have no idea why fake dirp (rsfps)
9652 should be treated differently but otherwise
9653 we end up with leaks -- sky*/
9654 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
9655 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
9656 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
9658 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
9659 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
9660 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
9662 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
9663 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
9664 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
9667 if (AvARRAY((AV*)sstr)) {
9668 SV **dst_ary, **src_ary;
9669 SSize_t items = AvFILLp((AV*)sstr) + 1;
9671 src_ary = AvARRAY((AV*)sstr);
9672 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
9673 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9674 SvPV_set(dstr, (char*)dst_ary);
9675 AvALLOC((AV*)dstr) = dst_ary;
9676 if (AvREAL((AV*)sstr)) {
9678 *dst_ary++ = sv_dup_inc(*src_ary++, param);
9682 *dst_ary++ = sv_dup(*src_ary++, param);
9684 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9685 while (items-- > 0) {
9686 *dst_ary++ = &PL_sv_undef;
9690 SvPV_set(dstr, NULL);
9691 AvALLOC((AV*)dstr) = (SV**)NULL;
9698 if (HvARRAY((HV*)sstr)) {
9700 const bool sharekeys = !!HvSHAREKEYS(sstr);
9701 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
9702 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
9704 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
9705 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
9707 HvARRAY(dstr) = (HE**)darray;
9708 while (i <= sxhv->xhv_max) {
9709 const HE *source = HvARRAY(sstr)[i];
9710 HvARRAY(dstr)[i] = source
9711 ? he_dup(source, sharekeys, param) : 0;
9715 struct xpvhv_aux * const saux = HvAUX(sstr);
9716 struct xpvhv_aux * const daux = HvAUX(dstr);
9717 /* This flag isn't copied. */
9718 /* SvOOK_on(hv) attacks the IV flags. */
9719 SvFLAGS(dstr) |= SVf_OOK;
9721 hvname = saux->xhv_name;
9723 = hvname ? hek_dup(hvname, param) : hvname;
9725 daux->xhv_riter = saux->xhv_riter;
9726 daux->xhv_eiter = saux->xhv_eiter
9727 ? he_dup(saux->xhv_eiter,
9728 (bool)!!HvSHAREKEYS(sstr), param) : 0;
9729 daux->xhv_backreferences = saux->xhv_backreferences
9730 ? (AV*) SvREFCNT_inc(
9738 SvPV_set(dstr, NULL);
9740 /* Record stashes for possible cloning in Perl_clone(). */
9742 av_push(param->stashes, dstr);
9747 /* NOTE: not refcounted */
9748 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
9750 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
9752 if (CvCONST(dstr)) {
9753 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
9754 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
9755 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
9757 /* don't dup if copying back - CvGV isn't refcounted, so the
9758 * duped GV may never be freed. A bit of a hack! DAPM */
9759 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
9760 NULL : gv_dup(CvGV(dstr), param) ;
9761 if (!(param->flags & CLONEf_COPY_STACKS)) {
9764 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
9767 ? cv_dup( CvOUTSIDE(dstr), param)
9768 : cv_dup_inc(CvOUTSIDE(dstr), param);
9770 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
9776 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9782 /* duplicate a context */
9785 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
9790 return (PERL_CONTEXT*)NULL;
9792 /* look for it in the table first */
9793 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9797 /* create anew and remember what it is */
9798 Newxz(ncxs, max + 1, PERL_CONTEXT);
9799 ptr_table_store(PL_ptr_table, cxs, ncxs);
9802 PERL_CONTEXT * const cx = &cxs[ix];
9803 PERL_CONTEXT * const ncx = &ncxs[ix];
9804 ncx->cx_type = cx->cx_type;
9805 if (CxTYPE(cx) == CXt_SUBST) {
9806 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9809 ncx->blk_oldsp = cx->blk_oldsp;
9810 ncx->blk_oldcop = cx->blk_oldcop;
9811 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9812 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9813 ncx->blk_oldpm = cx->blk_oldpm;
9814 ncx->blk_gimme = cx->blk_gimme;
9815 switch (CxTYPE(cx)) {
9817 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
9818 ? cv_dup_inc(cx->blk_sub.cv, param)
9819 : cv_dup(cx->blk_sub.cv,param));
9820 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
9821 ? av_dup_inc(cx->blk_sub.argarray, param)
9823 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
9824 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9825 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9826 ncx->blk_sub.lval = cx->blk_sub.lval;
9827 ncx->blk_sub.retop = cx->blk_sub.retop;
9830 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9831 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
9832 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
9833 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
9834 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
9835 ncx->blk_eval.retop = cx->blk_eval.retop;
9838 ncx->blk_loop.label = cx->blk_loop.label;
9839 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9840 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9841 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9842 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9843 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9844 ? cx->blk_loop.iterdata
9845 : gv_dup((GV*)cx->blk_loop.iterdata, param));
9846 ncx->blk_loop.oldcomppad
9847 = (PAD*)ptr_table_fetch(PL_ptr_table,
9848 cx->blk_loop.oldcomppad);
9849 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9850 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9851 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
9852 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9853 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9856 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9857 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9858 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
9859 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9860 ncx->blk_sub.retop = cx->blk_sub.retop;
9872 /* duplicate a stack info structure */
9875 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
9880 return (PERL_SI*)NULL;
9882 /* look for it in the table first */
9883 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
9887 /* create anew and remember what it is */
9888 Newxz(nsi, 1, PERL_SI);
9889 ptr_table_store(PL_ptr_table, si, nsi);
9891 nsi->si_stack = av_dup_inc(si->si_stack, param);
9892 nsi->si_cxix = si->si_cxix;
9893 nsi->si_cxmax = si->si_cxmax;
9894 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
9895 nsi->si_type = si->si_type;
9896 nsi->si_prev = si_dup(si->si_prev, param);
9897 nsi->si_next = si_dup(si->si_next, param);
9898 nsi->si_markoff = si->si_markoff;
9903 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
9904 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
9905 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
9906 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
9907 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
9908 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
9909 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
9910 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
9911 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
9912 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
9913 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
9914 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
9915 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
9916 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
9919 #define pv_dup_inc(p) SAVEPV(p)
9920 #define pv_dup(p) SAVEPV(p)
9921 #define svp_dup_inc(p,pp) any_dup(p,pp)
9923 /* map any object to the new equivent - either something in the
9924 * ptr table, or something in the interpreter structure
9928 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
9935 /* look for it in the table first */
9936 ret = ptr_table_fetch(PL_ptr_table, v);
9940 /* see if it is part of the interpreter structure */
9941 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
9942 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
9950 /* duplicate the save stack */
9953 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
9955 ANY * const ss = proto_perl->Tsavestack;
9956 const I32 max = proto_perl->Tsavestack_max;
9957 I32 ix = proto_perl->Tsavestack_ix;
9969 void (*dptr) (void*);
9970 void (*dxptr) (pTHX_ void*);
9972 Newxz(nss, max, ANY);
9975 I32 i = POPINT(ss,ix);
9978 case SAVEt_ITEM: /* normal string */
9979 sv = (SV*)POPPTR(ss,ix);
9980 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9981 sv = (SV*)POPPTR(ss,ix);
9982 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9984 case SAVEt_SV: /* scalar reference */
9985 sv = (SV*)POPPTR(ss,ix);
9986 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
9987 gv = (GV*)POPPTR(ss,ix);
9988 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
9990 case SAVEt_GENERIC_PVREF: /* generic char* */
9991 c = (char*)POPPTR(ss,ix);
9992 TOPPTR(nss,ix) = pv_dup(c);
9993 ptr = POPPTR(ss,ix);
9994 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
9996 case SAVEt_SHARED_PVREF: /* char* in shared space */
9997 c = (char*)POPPTR(ss,ix);
9998 TOPPTR(nss,ix) = savesharedpv(c);
9999 ptr = POPPTR(ss,ix);
10000 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10002 case SAVEt_GENERIC_SVREF: /* generic sv */
10003 case SAVEt_SVREF: /* scalar reference */
10004 sv = (SV*)POPPTR(ss,ix);
10005 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10006 ptr = POPPTR(ss,ix);
10007 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10009 case SAVEt_AV: /* array reference */
10010 av = (AV*)POPPTR(ss,ix);
10011 TOPPTR(nss,ix) = av_dup_inc(av, param);
10012 gv = (GV*)POPPTR(ss,ix);
10013 TOPPTR(nss,ix) = gv_dup(gv, param);
10015 case SAVEt_HV: /* hash reference */
10016 hv = (HV*)POPPTR(ss,ix);
10017 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10018 gv = (GV*)POPPTR(ss,ix);
10019 TOPPTR(nss,ix) = gv_dup(gv, param);
10021 case SAVEt_INT: /* int reference */
10022 ptr = POPPTR(ss,ix);
10023 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10024 intval = (int)POPINT(ss,ix);
10025 TOPINT(nss,ix) = intval;
10027 case SAVEt_LONG: /* long reference */
10028 ptr = POPPTR(ss,ix);
10029 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10030 longval = (long)POPLONG(ss,ix);
10031 TOPLONG(nss,ix) = longval;
10033 case SAVEt_I32: /* I32 reference */
10034 case SAVEt_I16: /* I16 reference */
10035 case SAVEt_I8: /* I8 reference */
10036 ptr = POPPTR(ss,ix);
10037 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10039 TOPINT(nss,ix) = i;
10041 case SAVEt_IV: /* IV reference */
10042 ptr = POPPTR(ss,ix);
10043 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10045 TOPIV(nss,ix) = iv;
10047 case SAVEt_SPTR: /* SV* reference */
10048 ptr = POPPTR(ss,ix);
10049 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10050 sv = (SV*)POPPTR(ss,ix);
10051 TOPPTR(nss,ix) = sv_dup(sv, param);
10053 case SAVEt_VPTR: /* random* reference */
10054 ptr = POPPTR(ss,ix);
10055 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10056 ptr = POPPTR(ss,ix);
10057 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10059 case SAVEt_PPTR: /* char* reference */
10060 ptr = POPPTR(ss,ix);
10061 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10062 c = (char*)POPPTR(ss,ix);
10063 TOPPTR(nss,ix) = pv_dup(c);
10065 case SAVEt_HPTR: /* HV* reference */
10066 ptr = POPPTR(ss,ix);
10067 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10068 hv = (HV*)POPPTR(ss,ix);
10069 TOPPTR(nss,ix) = hv_dup(hv, param);
10071 case SAVEt_APTR: /* AV* reference */
10072 ptr = POPPTR(ss,ix);
10073 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10074 av = (AV*)POPPTR(ss,ix);
10075 TOPPTR(nss,ix) = av_dup(av, param);
10078 gv = (GV*)POPPTR(ss,ix);
10079 TOPPTR(nss,ix) = gv_dup(gv, param);
10081 case SAVEt_GP: /* scalar reference */
10082 gp = (GP*)POPPTR(ss,ix);
10083 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10084 (void)GpREFCNT_inc(gp);
10085 gv = (GV*)POPPTR(ss,ix);
10086 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10087 c = (char*)POPPTR(ss,ix);
10088 TOPPTR(nss,ix) = pv_dup(c);
10090 TOPIV(nss,ix) = iv;
10092 TOPIV(nss,ix) = iv;
10095 case SAVEt_MORTALIZESV:
10096 sv = (SV*)POPPTR(ss,ix);
10097 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10100 ptr = POPPTR(ss,ix);
10101 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10102 /* these are assumed to be refcounted properly */
10104 switch (((OP*)ptr)->op_type) {
10106 case OP_LEAVESUBLV:
10110 case OP_LEAVEWRITE:
10111 TOPPTR(nss,ix) = ptr;
10116 TOPPTR(nss,ix) = Nullop;
10121 TOPPTR(nss,ix) = Nullop;
10124 c = (char*)POPPTR(ss,ix);
10125 TOPPTR(nss,ix) = pv_dup_inc(c);
10127 case SAVEt_CLEARSV:
10128 longval = POPLONG(ss,ix);
10129 TOPLONG(nss,ix) = longval;
10132 hv = (HV*)POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10134 c = (char*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = pv_dup_inc(c);
10137 TOPINT(nss,ix) = i;
10139 case SAVEt_DESTRUCTOR:
10140 ptr = POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10142 dptr = POPDPTR(ss,ix);
10143 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10144 any_dup(FPTR2DPTR(void *, dptr),
10147 case SAVEt_DESTRUCTOR_X:
10148 ptr = POPPTR(ss,ix);
10149 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10150 dxptr = POPDXPTR(ss,ix);
10151 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10152 any_dup(FPTR2DPTR(void *, dxptr),
10155 case SAVEt_REGCONTEXT:
10158 TOPINT(nss,ix) = i;
10161 case SAVEt_STACK_POS: /* Position on Perl stack */
10163 TOPINT(nss,ix) = i;
10165 case SAVEt_AELEM: /* array element */
10166 sv = (SV*)POPPTR(ss,ix);
10167 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10169 TOPINT(nss,ix) = i;
10170 av = (AV*)POPPTR(ss,ix);
10171 TOPPTR(nss,ix) = av_dup_inc(av, param);
10173 case SAVEt_HELEM: /* hash element */
10174 sv = (SV*)POPPTR(ss,ix);
10175 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10176 sv = (SV*)POPPTR(ss,ix);
10177 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10178 hv = (HV*)POPPTR(ss,ix);
10179 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10182 ptr = POPPTR(ss,ix);
10183 TOPPTR(nss,ix) = ptr;
10187 TOPINT(nss,ix) = i;
10189 case SAVEt_COMPPAD:
10190 av = (AV*)POPPTR(ss,ix);
10191 TOPPTR(nss,ix) = av_dup(av, param);
10194 longval = (long)POPLONG(ss,ix);
10195 TOPLONG(nss,ix) = longval;
10196 ptr = POPPTR(ss,ix);
10197 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10198 sv = (SV*)POPPTR(ss,ix);
10199 TOPPTR(nss,ix) = sv_dup(sv, param);
10202 ptr = POPPTR(ss,ix);
10203 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10204 longval = (long)POPBOOL(ss,ix);
10205 TOPBOOL(nss,ix) = (bool)longval;
10207 case SAVEt_SET_SVFLAGS:
10209 TOPINT(nss,ix) = i;
10211 TOPINT(nss,ix) = i;
10212 sv = (SV*)POPPTR(ss,ix);
10213 TOPPTR(nss,ix) = sv_dup(sv, param);
10216 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10224 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10225 * flag to the result. This is done for each stash before cloning starts,
10226 * so we know which stashes want their objects cloned */
10229 do_mark_cloneable_stash(pTHX_ SV *sv)
10231 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10233 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10234 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10235 if (cloner && GvCV(cloner)) {
10242 XPUSHs(sv_2mortal(newSVhek(hvname)));
10244 call_sv((SV*)GvCV(cloner), G_SCALAR);
10251 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10259 =for apidoc perl_clone
10261 Create and return a new interpreter by cloning the current one.
10263 perl_clone takes these flags as parameters:
10265 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10266 without it we only clone the data and zero the stacks,
10267 with it we copy the stacks and the new perl interpreter is
10268 ready to run at the exact same point as the previous one.
10269 The pseudo-fork code uses COPY_STACKS while the
10270 threads->new doesn't.
10272 CLONEf_KEEP_PTR_TABLE
10273 perl_clone keeps a ptr_table with the pointer of the old
10274 variable as a key and the new variable as a value,
10275 this allows it to check if something has been cloned and not
10276 clone it again but rather just use the value and increase the
10277 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10278 the ptr_table using the function
10279 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10280 reason to keep it around is if you want to dup some of your own
10281 variable who are outside the graph perl scans, example of this
10282 code is in threads.xs create
10285 This is a win32 thing, it is ignored on unix, it tells perls
10286 win32host code (which is c++) to clone itself, this is needed on
10287 win32 if you want to run two threads at the same time,
10288 if you just want to do some stuff in a separate perl interpreter
10289 and then throw it away and return to the original one,
10290 you don't need to do anything.
10295 /* XXX the above needs expanding by someone who actually understands it ! */
10296 EXTERN_C PerlInterpreter *
10297 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10300 perl_clone(PerlInterpreter *proto_perl, UV flags)
10303 #ifdef PERL_IMPLICIT_SYS
10305 /* perlhost.h so we need to call into it
10306 to clone the host, CPerlHost should have a c interface, sky */
10308 if (flags & CLONEf_CLONE_HOST) {
10309 return perl_clone_host(proto_perl,flags);
10311 return perl_clone_using(proto_perl, flags,
10313 proto_perl->IMemShared,
10314 proto_perl->IMemParse,
10316 proto_perl->IStdIO,
10320 proto_perl->IProc);
10324 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10325 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10326 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10327 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10328 struct IPerlDir* ipD, struct IPerlSock* ipS,
10329 struct IPerlProc* ipP)
10331 /* XXX many of the string copies here can be optimized if they're
10332 * constants; they need to be allocated as common memory and just
10333 * their pointers copied. */
10336 CLONE_PARAMS clone_params;
10337 CLONE_PARAMS* param = &clone_params;
10339 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10340 /* for each stash, determine whether its objects should be cloned */
10341 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10342 PERL_SET_THX(my_perl);
10345 Poison(my_perl, 1, PerlInterpreter);
10347 PL_curcop = (COP *)Nullop;
10351 PL_savestack_ix = 0;
10352 PL_savestack_max = -1;
10353 PL_sig_pending = 0;
10354 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10355 # else /* !DEBUGGING */
10356 Zero(my_perl, 1, PerlInterpreter);
10357 # endif /* DEBUGGING */
10359 /* host pointers */
10361 PL_MemShared = ipMS;
10362 PL_MemParse = ipMP;
10369 #else /* !PERL_IMPLICIT_SYS */
10371 CLONE_PARAMS clone_params;
10372 CLONE_PARAMS* param = &clone_params;
10373 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10374 /* for each stash, determine whether its objects should be cloned */
10375 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10376 PERL_SET_THX(my_perl);
10379 Poison(my_perl, 1, PerlInterpreter);
10381 PL_curcop = (COP *)Nullop;
10385 PL_savestack_ix = 0;
10386 PL_savestack_max = -1;
10387 PL_sig_pending = 0;
10388 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10389 # else /* !DEBUGGING */
10390 Zero(my_perl, 1, PerlInterpreter);
10391 # endif /* DEBUGGING */
10392 #endif /* PERL_IMPLICIT_SYS */
10393 param->flags = flags;
10394 param->proto_perl = proto_perl;
10396 PL_body_arenas = NULL;
10397 Zero(&PL_body_roots, 1, PL_body_roots);
10399 PL_nice_chunk = NULL;
10400 PL_nice_chunk_size = 0;
10402 PL_sv_objcount = 0;
10404 PL_sv_arenaroot = NULL;
10406 PL_debug = proto_perl->Idebug;
10408 PL_hash_seed = proto_perl->Ihash_seed;
10409 PL_rehash_seed = proto_perl->Irehash_seed;
10411 #ifdef USE_REENTRANT_API
10412 /* XXX: things like -Dm will segfault here in perlio, but doing
10413 * PERL_SET_CONTEXT(proto_perl);
10414 * breaks too many other things
10416 Perl_reentrant_init(aTHX);
10419 /* create SV map for pointer relocation */
10420 PL_ptr_table = ptr_table_new();
10422 /* initialize these special pointers as early as possible */
10423 SvANY(&PL_sv_undef) = NULL;
10424 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10425 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10426 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10428 SvANY(&PL_sv_no) = new_XPVNV();
10429 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10430 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10431 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10432 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10433 SvCUR_set(&PL_sv_no, 0);
10434 SvLEN_set(&PL_sv_no, 1);
10435 SvIV_set(&PL_sv_no, 0);
10436 SvNV_set(&PL_sv_no, 0);
10437 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10439 SvANY(&PL_sv_yes) = new_XPVNV();
10440 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10441 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10442 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10443 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10444 SvCUR_set(&PL_sv_yes, 1);
10445 SvLEN_set(&PL_sv_yes, 2);
10446 SvIV_set(&PL_sv_yes, 1);
10447 SvNV_set(&PL_sv_yes, 1);
10448 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10450 /* create (a non-shared!) shared string table */
10451 PL_strtab = newHV();
10452 HvSHAREKEYS_off(PL_strtab);
10453 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10454 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10456 PL_compiling = proto_perl->Icompiling;
10458 /* These two PVs will be free'd special way so must set them same way op.c does */
10459 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10460 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10462 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10463 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10465 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10466 if (!specialWARN(PL_compiling.cop_warnings))
10467 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10468 if (!specialCopIO(PL_compiling.cop_io))
10469 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10470 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10472 /* pseudo environmental stuff */
10473 PL_origargc = proto_perl->Iorigargc;
10474 PL_origargv = proto_perl->Iorigargv;
10476 param->stashes = newAV(); /* Setup array of objects to call clone on */
10478 /* Set tainting stuff before PerlIO_debug can possibly get called */
10479 PL_tainting = proto_perl->Itainting;
10480 PL_taint_warn = proto_perl->Itaint_warn;
10482 #ifdef PERLIO_LAYERS
10483 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10484 PerlIO_clone(aTHX_ proto_perl, param);
10487 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10488 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10489 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10490 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10491 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10492 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10495 PL_minus_c = proto_perl->Iminus_c;
10496 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10497 PL_localpatches = proto_perl->Ilocalpatches;
10498 PL_splitstr = proto_perl->Isplitstr;
10499 PL_preprocess = proto_perl->Ipreprocess;
10500 PL_minus_n = proto_perl->Iminus_n;
10501 PL_minus_p = proto_perl->Iminus_p;
10502 PL_minus_l = proto_perl->Iminus_l;
10503 PL_minus_a = proto_perl->Iminus_a;
10504 PL_minus_E = proto_perl->Iminus_E;
10505 PL_minus_F = proto_perl->Iminus_F;
10506 PL_doswitches = proto_perl->Idoswitches;
10507 PL_dowarn = proto_perl->Idowarn;
10508 PL_doextract = proto_perl->Idoextract;
10509 PL_sawampersand = proto_perl->Isawampersand;
10510 PL_unsafe = proto_perl->Iunsafe;
10511 PL_inplace = SAVEPV(proto_perl->Iinplace);
10512 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10513 PL_perldb = proto_perl->Iperldb;
10514 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10515 PL_exit_flags = proto_perl->Iexit_flags;
10517 /* magical thingies */
10518 /* XXX time(&PL_basetime) when asked for? */
10519 PL_basetime = proto_perl->Ibasetime;
10520 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10522 PL_maxsysfd = proto_perl->Imaxsysfd;
10523 PL_multiline = proto_perl->Imultiline;
10524 PL_statusvalue = proto_perl->Istatusvalue;
10526 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10528 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10530 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10532 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10533 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10534 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10536 /* Clone the regex array */
10537 PL_regex_padav = newAV();
10539 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10540 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10542 av_push(PL_regex_padav,
10543 sv_dup_inc(regexen[0],param));
10544 for(i = 1; i <= len; i++) {
10545 const SV * const regex = regexen[i];
10548 ? sv_dup_inc(regex, param)
10550 newSViv(PTR2IV(re_dup(
10551 INT2PTR(REGEXP *, SvIVX(regex)), param))))
10553 av_push(PL_regex_padav, sv);
10556 PL_regex_pad = AvARRAY(PL_regex_padav);
10558 /* shortcuts to various I/O objects */
10559 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10560 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10561 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10562 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10563 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10564 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
10566 /* shortcuts to regexp stuff */
10567 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
10569 /* shortcuts to misc objects */
10570 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
10572 /* shortcuts to debugging objects */
10573 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10574 PL_DBline = gv_dup(proto_perl->IDBline, param);
10575 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10576 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10577 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10578 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10579 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
10580 PL_lineary = av_dup(proto_perl->Ilineary, param);
10581 PL_dbargs = av_dup(proto_perl->Idbargs, param);
10583 /* symbol tables */
10584 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10585 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
10586 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10587 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10588 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10590 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
10591 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
10592 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
10593 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10594 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10595 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
10597 PL_sub_generation = proto_perl->Isub_generation;
10599 /* funky return mechanisms */
10600 PL_forkprocess = proto_perl->Iforkprocess;
10602 /* subprocess state */
10603 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
10605 /* internal state */
10606 PL_maxo = proto_perl->Imaxo;
10607 if (proto_perl->Iop_mask)
10608 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10611 /* PL_asserting = proto_perl->Iasserting; */
10613 /* current interpreter roots */
10614 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
10615 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10616 PL_main_start = proto_perl->Imain_start;
10617 PL_eval_root = proto_perl->Ieval_root;
10618 PL_eval_start = proto_perl->Ieval_start;
10620 /* runtime control stuff */
10621 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10622 PL_copline = proto_perl->Icopline;
10624 PL_filemode = proto_perl->Ifilemode;
10625 PL_lastfd = proto_perl->Ilastfd;
10626 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10629 PL_gensym = proto_perl->Igensym;
10630 PL_preambled = proto_perl->Ipreambled;
10631 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
10632 PL_laststatval = proto_perl->Ilaststatval;
10633 PL_laststype = proto_perl->Ilaststype;
10636 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
10638 /* interpreter atexit processing */
10639 PL_exitlistlen = proto_perl->Iexitlistlen;
10640 if (PL_exitlistlen) {
10641 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10642 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10645 PL_exitlist = (PerlExitListEntry*)NULL;
10647 PL_my_cxt_size = proto_perl->Imy_cxt_size;
10648 if (PL_my_cxt_size) {
10649 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
10650 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
10653 PL_my_cxt_list = (void**)NULL;
10654 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
10655 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10656 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
10658 PL_profiledata = NULL;
10659 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
10660 /* PL_rsfp_filters entries have fake IoDIRP() */
10661 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
10663 PL_compcv = cv_dup(proto_perl->Icompcv, param);
10665 PAD_CLONE_VARS(proto_perl, param);
10667 #ifdef HAVE_INTERP_INTERN
10668 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10671 /* more statics moved here */
10672 PL_generation = proto_perl->Igeneration;
10673 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
10675 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10676 PL_in_clean_all = proto_perl->Iin_clean_all;
10678 PL_uid = proto_perl->Iuid;
10679 PL_euid = proto_perl->Ieuid;
10680 PL_gid = proto_perl->Igid;
10681 PL_egid = proto_perl->Iegid;
10682 PL_nomemok = proto_perl->Inomemok;
10683 PL_an = proto_perl->Ian;
10684 PL_evalseq = proto_perl->Ievalseq;
10685 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10686 PL_origalen = proto_perl->Iorigalen;
10687 #ifdef PERL_USES_PL_PIDSTATUS
10688 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10690 PL_osname = SAVEPV(proto_perl->Iosname);
10691 PL_sighandlerp = proto_perl->Isighandlerp;
10693 PL_runops = proto_perl->Irunops;
10695 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10698 PL_cshlen = proto_perl->Icshlen;
10699 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
10702 PL_lex_state = proto_perl->Ilex_state;
10703 PL_lex_defer = proto_perl->Ilex_defer;
10704 PL_lex_expect = proto_perl->Ilex_expect;
10705 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10706 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10707 PL_lex_starts = proto_perl->Ilex_starts;
10708 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10709 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
10710 PL_lex_op = proto_perl->Ilex_op;
10711 PL_lex_inpat = proto_perl->Ilex_inpat;
10712 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10713 PL_lex_brackets = proto_perl->Ilex_brackets;
10714 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10715 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10716 PL_lex_casemods = proto_perl->Ilex_casemods;
10717 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10718 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10720 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10721 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10722 PL_nexttoke = proto_perl->Inexttoke;
10724 /* XXX This is probably masking the deeper issue of why
10725 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10726 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10727 * (A little debugging with a watchpoint on it may help.)
10729 if (SvANY(proto_perl->Ilinestr)) {
10730 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10731 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
10732 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10733 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
10734 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10735 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
10736 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10737 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
10738 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10741 PL_linestr = newSV(79);
10742 sv_upgrade(PL_linestr,SVt_PVIV);
10743 sv_setpvn(PL_linestr,"",0);
10744 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10746 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
10747 PL_pending_ident = proto_perl->Ipending_ident;
10748 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10750 PL_expect = proto_perl->Iexpect;
10752 PL_multi_start = proto_perl->Imulti_start;
10753 PL_multi_end = proto_perl->Imulti_end;
10754 PL_multi_open = proto_perl->Imulti_open;
10755 PL_multi_close = proto_perl->Imulti_close;
10757 PL_error_count = proto_perl->Ierror_count;
10758 PL_subline = proto_perl->Isubline;
10759 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
10761 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
10762 if (SvANY(proto_perl->Ilinestr)) {
10763 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
10764 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10765 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
10766 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10767 PL_last_lop_op = proto_perl->Ilast_lop_op;
10770 PL_last_uni = SvPVX(PL_linestr);
10771 PL_last_lop = SvPVX(PL_linestr);
10772 PL_last_lop_op = 0;
10774 PL_in_my = proto_perl->Iin_my;
10775 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
10777 PL_cryptseen = proto_perl->Icryptseen;
10780 PL_hints = proto_perl->Ihints;
10782 PL_amagic_generation = proto_perl->Iamagic_generation;
10784 #ifdef USE_LOCALE_COLLATE
10785 PL_collation_ix = proto_perl->Icollation_ix;
10786 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10787 PL_collation_standard = proto_perl->Icollation_standard;
10788 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10789 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10790 #endif /* USE_LOCALE_COLLATE */
10792 #ifdef USE_LOCALE_NUMERIC
10793 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10794 PL_numeric_standard = proto_perl->Inumeric_standard;
10795 PL_numeric_local = proto_perl->Inumeric_local;
10796 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
10797 #endif /* !USE_LOCALE_NUMERIC */
10799 /* utf8 character classes */
10800 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10801 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10802 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10803 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10804 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10805 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10806 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10807 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10808 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10809 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10810 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10811 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10812 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10813 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10814 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10815 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10816 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
10817 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
10818 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10819 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
10821 /* Did the locale setup indicate UTF-8? */
10822 PL_utf8locale = proto_perl->Iutf8locale;
10823 /* Unicode features (see perlrun/-C) */
10824 PL_unicode = proto_perl->Iunicode;
10826 /* Pre-5.8 signals control */
10827 PL_signals = proto_perl->Isignals;
10829 /* times() ticks per second */
10830 PL_clocktick = proto_perl->Iclocktick;
10832 /* Recursion stopper for PerlIO_find_layer */
10833 PL_in_load_module = proto_perl->Iin_load_module;
10835 /* sort() routine */
10836 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
10838 /* Not really needed/useful since the reenrant_retint is "volatile",
10839 * but do it for consistency's sake. */
10840 PL_reentrant_retint = proto_perl->Ireentrant_retint;
10842 /* Hooks to shared SVs and locks. */
10843 PL_sharehook = proto_perl->Isharehook;
10844 PL_lockhook = proto_perl->Ilockhook;
10845 PL_unlockhook = proto_perl->Iunlockhook;
10846 PL_threadhook = proto_perl->Ithreadhook;
10848 PL_runops_std = proto_perl->Irunops_std;
10849 PL_runops_dbg = proto_perl->Irunops_dbg;
10851 #ifdef THREADS_HAVE_PIDS
10852 PL_ppid = proto_perl->Ippid;
10856 PL_last_swash_hv = NULL; /* reinits on demand */
10857 PL_last_swash_klen = 0;
10858 PL_last_swash_key[0]= '\0';
10859 PL_last_swash_tmps = (U8*)NULL;
10860 PL_last_swash_slen = 0;
10862 PL_glob_index = proto_perl->Iglob_index;
10863 PL_srand_called = proto_perl->Isrand_called;
10864 PL_uudmap['M'] = 0; /* reinits on demand */
10865 PL_bitcount = NULL; /* reinits on demand */
10867 if (proto_perl->Ipsig_pend) {
10868 Newxz(PL_psig_pend, SIG_SIZE, int);
10871 PL_psig_pend = (int*)NULL;
10874 if (proto_perl->Ipsig_ptr) {
10875 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
10876 Newxz(PL_psig_name, SIG_SIZE, SV*);
10877 for (i = 1; i < SIG_SIZE; i++) {
10878 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10879 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
10883 PL_psig_ptr = (SV**)NULL;
10884 PL_psig_name = (SV**)NULL;
10887 /* thrdvar.h stuff */
10889 if (flags & CLONEf_COPY_STACKS) {
10890 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10891 PL_tmps_ix = proto_perl->Ttmps_ix;
10892 PL_tmps_max = proto_perl->Ttmps_max;
10893 PL_tmps_floor = proto_perl->Ttmps_floor;
10894 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
10896 while (i <= PL_tmps_ix) {
10897 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
10901 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10902 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10903 Newxz(PL_markstack, i, I32);
10904 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10905 - proto_perl->Tmarkstack);
10906 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10907 - proto_perl->Tmarkstack);
10908 Copy(proto_perl->Tmarkstack, PL_markstack,
10909 PL_markstack_ptr - PL_markstack + 1, I32);
10911 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10912 * NOTE: unlike the others! */
10913 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10914 PL_scopestack_max = proto_perl->Tscopestack_max;
10915 Newxz(PL_scopestack, PL_scopestack_max, I32);
10916 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10918 /* NOTE: si_dup() looks at PL_markstack */
10919 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
10921 /* PL_curstack = PL_curstackinfo->si_stack; */
10922 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10923 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
10925 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10926 PL_stack_base = AvARRAY(PL_curstack);
10927 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10928 - proto_perl->Tstack_base);
10929 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10931 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10932 * NOTE: unlike the others! */
10933 PL_savestack_ix = proto_perl->Tsavestack_ix;
10934 PL_savestack_max = proto_perl->Tsavestack_max;
10935 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
10936 PL_savestack = ss_dup(proto_perl, param);
10940 ENTER; /* perl_destruct() wants to LEAVE; */
10942 /* although we're not duplicating the tmps stack, we should still
10943 * add entries for any SVs on the tmps stack that got cloned by a
10944 * non-refcount means (eg a temp in @_); otherwise they will be
10947 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
10948 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
10949 proto_perl->Ttmps_stack[i]);
10950 if (nsv && !SvREFCNT(nsv)) {
10952 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc(nsv);
10957 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
10958 PL_top_env = &PL_start_env;
10960 PL_op = proto_perl->Top;
10963 PL_Xpv = (XPV*)NULL;
10964 PL_na = proto_perl->Tna;
10966 PL_statbuf = proto_perl->Tstatbuf;
10967 PL_statcache = proto_perl->Tstatcache;
10968 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
10969 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
10971 PL_timesbuf = proto_perl->Ttimesbuf;
10974 PL_tainted = proto_perl->Ttainted;
10975 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
10976 PL_rs = sv_dup_inc(proto_perl->Trs, param);
10977 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
10978 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
10979 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
10980 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
10981 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
10982 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
10983 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
10985 PL_restartop = proto_perl->Trestartop;
10986 PL_in_eval = proto_perl->Tin_eval;
10987 PL_delaymagic = proto_perl->Tdelaymagic;
10988 PL_dirty = proto_perl->Tdirty;
10989 PL_localizing = proto_perl->Tlocalizing;
10991 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
10992 PL_hv_fetch_ent_mh = Nullhe;
10993 PL_modcount = proto_perl->Tmodcount;
10994 PL_lastgotoprobe = Nullop;
10995 PL_dumpindent = proto_perl->Tdumpindent;
10997 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
10998 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
10999 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11000 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11001 PL_efloatbuf = NULL; /* reinits on demand */
11002 PL_efloatsize = 0; /* reinits on demand */
11006 PL_screamfirst = NULL;
11007 PL_screamnext = NULL;
11008 PL_maxscream = -1; /* reinits on demand */
11009 PL_lastscream = NULL;
11011 PL_watchaddr = NULL;
11014 PL_regdummy = proto_perl->Tregdummy;
11015 PL_regprecomp = NULL;
11018 PL_colorset = 0; /* reinits PL_colors[] */
11019 /*PL_colors[6] = {0,0,0,0,0,0};*/
11020 PL_reginput = NULL;
11023 PL_regstartp = (I32*)NULL;
11024 PL_regendp = (I32*)NULL;
11025 PL_reglastparen = (U32*)NULL;
11026 PL_reglastcloseparen = (U32*)NULL;
11028 PL_reg_start_tmp = (char**)NULL;
11029 PL_reg_start_tmpl = 0;
11030 PL_regdata = (struct reg_data*)NULL;
11033 PL_reg_eval_set = 0;
11035 PL_regprogram = (regnode*)NULL;
11037 PL_regcc = (CURCUR*)NULL;
11038 PL_reg_call_cc = (struct re_cc_state*)NULL;
11039 PL_reg_re = (regexp*)NULL;
11040 PL_reg_ganch = NULL;
11042 PL_reg_match_utf8 = FALSE;
11043 PL_reg_magic = (MAGIC*)NULL;
11045 PL_reg_oldcurpm = (PMOP*)NULL;
11046 PL_reg_curpm = (PMOP*)NULL;
11047 PL_reg_oldsaved = NULL;
11048 PL_reg_oldsavedlen = 0;
11049 #ifdef PERL_OLD_COPY_ON_WRITE
11052 PL_reg_maxiter = 0;
11053 PL_reg_leftiter = 0;
11054 PL_reg_poscache = NULL;
11055 PL_reg_poscache_size= 0;
11057 /* RE engine - function pointers */
11058 PL_regcompp = proto_perl->Tregcompp;
11059 PL_regexecp = proto_perl->Tregexecp;
11060 PL_regint_start = proto_perl->Tregint_start;
11061 PL_regint_string = proto_perl->Tregint_string;
11062 PL_regfree = proto_perl->Tregfree;
11064 PL_reginterp_cnt = 0;
11065 PL_reg_starttry = 0;
11067 /* Pluggable optimizer */
11068 PL_peepp = proto_perl->Tpeepp;
11070 PL_stashcache = newHV();
11072 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11073 ptr_table_free(PL_ptr_table);
11074 PL_ptr_table = NULL;
11077 /* Call the ->CLONE method, if it exists, for each of the stashes
11078 identified by sv_dup() above.
11080 while(av_len(param->stashes) != -1) {
11081 HV* const stash = (HV*) av_shift(param->stashes);
11082 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11083 if (cloner && GvCV(cloner)) {
11088 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11090 call_sv((SV*)GvCV(cloner), G_DISCARD);
11096 SvREFCNT_dec(param->stashes);
11098 /* orphaned? eg threads->new inside BEGIN or use */
11099 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11100 (void)SvREFCNT_inc(PL_compcv);
11101 SAVEFREESV(PL_compcv);
11107 #endif /* USE_ITHREADS */
11110 =head1 Unicode Support
11112 =for apidoc sv_recode_to_utf8
11114 The encoding is assumed to be an Encode object, on entry the PV
11115 of the sv is assumed to be octets in that encoding, and the sv
11116 will be converted into Unicode (and UTF-8).
11118 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11119 is not a reference, nothing is done to the sv. If the encoding is not
11120 an C<Encode::XS> Encoding object, bad things will happen.
11121 (See F<lib/encoding.pm> and L<Encode>).
11123 The PV of the sv is returned.
11128 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11131 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11145 Passing sv_yes is wrong - it needs to be or'ed set of constants
11146 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11147 remove converted chars from source.
11149 Both will default the value - let them.
11151 XPUSHs(&PL_sv_yes);
11154 call_method("decode", G_SCALAR);
11158 s = SvPV_const(uni, len);
11159 if (s != SvPVX_const(sv)) {
11160 SvGROW(sv, len + 1);
11161 Move(s, SvPVX(sv), len + 1, char);
11162 SvCUR_set(sv, len);
11169 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11173 =for apidoc sv_cat_decode
11175 The encoding is assumed to be an Encode object, the PV of the ssv is
11176 assumed to be octets in that encoding and decoding the input starts
11177 from the position which (PV + *offset) pointed to. The dsv will be
11178 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11179 when the string tstr appears in decoding output or the input ends on
11180 the PV of the ssv. The value which the offset points will be modified
11181 to the last input position on the ssv.
11183 Returns TRUE if the terminator was found, else returns FALSE.
11188 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11189 SV *ssv, int *offset, char *tstr, int tlen)
11193 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11204 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11205 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11207 call_method("cat_decode", G_SCALAR);
11209 ret = SvTRUE(TOPs);
11210 *offset = SvIV(offsv);
11216 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11221 /* ---------------------------------------------------------------------
11223 * support functions for report_uninit()
11226 /* the maxiumum size of array or hash where we will scan looking
11227 * for the undefined element that triggered the warning */
11229 #define FUV_MAX_SEARCH_SIZE 1000
11231 /* Look for an entry in the hash whose value has the same SV as val;
11232 * If so, return a mortal copy of the key. */
11235 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11238 register HE **array;
11241 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11242 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11245 array = HvARRAY(hv);
11247 for (i=HvMAX(hv); i>0; i--) {
11248 register HE *entry;
11249 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11250 if (HeVAL(entry) != val)
11252 if ( HeVAL(entry) == &PL_sv_undef ||
11253 HeVAL(entry) == &PL_sv_placeholder)
11257 if (HeKLEN(entry) == HEf_SVKEY)
11258 return sv_mortalcopy(HeKEY_sv(entry));
11259 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11265 /* Look for an entry in the array whose value has the same SV as val;
11266 * If so, return the index, otherwise return -1. */
11269 S_find_array_subscript(pTHX_ AV *av, SV* val)
11274 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11275 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11279 for (i=AvFILLp(av); i>=0; i--) {
11280 if (svp[i] == val && svp[i] != &PL_sv_undef)
11286 /* S_varname(): return the name of a variable, optionally with a subscript.
11287 * If gv is non-zero, use the name of that global, along with gvtype (one
11288 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11289 * targ. Depending on the value of the subscript_type flag, return:
11292 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11293 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11294 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11295 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11298 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11299 SV* keyname, I32 aindex, int subscript_type)
11302 SV * const name = sv_newmortal();
11305 buffer[0] = gvtype;
11308 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11310 gv_fullname4(name, gv, buffer, 0);
11312 if ((unsigned int)SvPVX(name)[1] <= 26) {
11314 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11316 /* Swap the 1 unprintable control character for the 2 byte pretty
11317 version - ie substr($name, 1, 1) = $buffer; */
11318 sv_insert(name, 1, 1, buffer, 2);
11323 CV * const cv = find_runcv(&unused);
11327 if (!cv || !CvPADLIST(cv))
11329 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11330 sv = *av_fetch(av, targ, FALSE);
11331 /* SvLEN in a pad name is not to be trusted */
11332 sv_setpv(name, SvPV_nolen_const(sv));
11335 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11336 SV * const sv = newSV(0);
11337 *SvPVX(name) = '$';
11338 Perl_sv_catpvf(aTHX_ name, "{%s}",
11339 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11342 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11343 *SvPVX(name) = '$';
11344 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11346 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11347 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11354 =for apidoc find_uninit_var
11356 Find the name of the undefined variable (if any) that caused the operator o
11357 to issue a "Use of uninitialized value" warning.
11358 If match is true, only return a name if it's value matches uninit_sv.
11359 So roughly speaking, if a unary operator (such as OP_COS) generates a
11360 warning, then following the direct child of the op may yield an
11361 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11362 other hand, with OP_ADD there are two branches to follow, so we only print
11363 the variable name if we get an exact match.
11365 The name is returned as a mortal SV.
11367 Assumes that PL_op is the op that originally triggered the error, and that
11368 PL_comppad/PL_curpad points to the currently executing pad.
11374 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11382 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11383 uninit_sv == &PL_sv_placeholder)))
11386 switch (obase->op_type) {
11393 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11394 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11397 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11399 if (pad) { /* @lex, %lex */
11400 sv = PAD_SVl(obase->op_targ);
11404 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11405 /* @global, %global */
11406 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11409 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11411 else /* @{expr}, %{expr} */
11412 return find_uninit_var(cUNOPx(obase)->op_first,
11416 /* attempt to find a match within the aggregate */
11418 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11420 subscript_type = FUV_SUBSCRIPT_HASH;
11423 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11425 subscript_type = FUV_SUBSCRIPT_ARRAY;
11428 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11431 return varname(gv, hash ? '%' : '@', obase->op_targ,
11432 keysv, index, subscript_type);
11436 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11438 return varname(NULL, '$', obase->op_targ,
11439 NULL, 0, FUV_SUBSCRIPT_NONE);
11442 gv = cGVOPx_gv(obase);
11443 if (!gv || (match && GvSV(gv) != uninit_sv))
11445 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11448 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11451 av = (AV*)PAD_SV(obase->op_targ);
11452 if (!av || SvRMAGICAL(av))
11454 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11455 if (!svp || *svp != uninit_sv)
11458 return varname(NULL, '$', obase->op_targ,
11459 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11462 gv = cGVOPx_gv(obase);
11468 if (!av || SvRMAGICAL(av))
11470 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11471 if (!svp || *svp != uninit_sv)
11474 return varname(gv, '$', 0,
11475 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11480 o = cUNOPx(obase)->op_first;
11481 if (!o || o->op_type != OP_NULL ||
11482 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11484 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11488 if (PL_op == obase)
11489 /* $a[uninit_expr] or $h{uninit_expr} */
11490 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11493 o = cBINOPx(obase)->op_first;
11494 kid = cBINOPx(obase)->op_last;
11496 /* get the av or hv, and optionally the gv */
11498 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11499 sv = PAD_SV(o->op_targ);
11501 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11502 && cUNOPo->op_first->op_type == OP_GV)
11504 gv = cGVOPx_gv(cUNOPo->op_first);
11507 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11512 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11513 /* index is constant */
11517 if (obase->op_type == OP_HELEM) {
11518 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11519 if (!he || HeVAL(he) != uninit_sv)
11523 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11524 if (!svp || *svp != uninit_sv)
11528 if (obase->op_type == OP_HELEM)
11529 return varname(gv, '%', o->op_targ,
11530 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11532 return varname(gv, '@', o->op_targ, NULL,
11533 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11536 /* index is an expression;
11537 * attempt to find a match within the aggregate */
11538 if (obase->op_type == OP_HELEM) {
11539 SV * const keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
11541 return varname(gv, '%', o->op_targ,
11542 keysv, 0, FUV_SUBSCRIPT_HASH);
11545 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11547 return varname(gv, '@', o->op_targ,
11548 NULL, index, FUV_SUBSCRIPT_ARRAY);
11553 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11555 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11561 /* only examine RHS */
11562 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11565 o = cUNOPx(obase)->op_first;
11566 if (o->op_type == OP_PUSHMARK)
11569 if (!o->op_sibling) {
11570 /* one-arg version of open is highly magical */
11572 if (o->op_type == OP_GV) { /* open FOO; */
11574 if (match && GvSV(gv) != uninit_sv)
11576 return varname(gv, '$', 0,
11577 NULL, 0, FUV_SUBSCRIPT_NONE);
11579 /* other possibilities not handled are:
11580 * open $x; or open my $x; should return '${*$x}'
11581 * open expr; should return '$'.expr ideally
11587 /* ops where $_ may be an implicit arg */
11591 if ( !(obase->op_flags & OPf_STACKED)) {
11592 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11593 ? PAD_SVl(obase->op_targ)
11596 sv = sv_newmortal();
11597 sv_setpvn(sv, "$_", 2);
11605 /* skip filehandle as it can't produce 'undef' warning */
11606 o = cUNOPx(obase)->op_first;
11607 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11608 o = o->op_sibling->op_sibling;
11615 match = 1; /* XS or custom code could trigger random warnings */
11620 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
11621 return sv_2mortal(newSVpvs("${$/}"));
11626 if (!(obase->op_flags & OPf_KIDS))
11628 o = cUNOPx(obase)->op_first;
11634 /* if all except one arg are constant, or have no side-effects,
11635 * or are optimized away, then it's unambiguous */
11637 for (kid=o; kid; kid = kid->op_sibling) {
11639 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
11640 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
11641 || (kid->op_type == OP_PUSHMARK)
11645 if (o2) { /* more than one found */
11652 return find_uninit_var(o2, uninit_sv, match);
11654 /* scan all args */
11656 sv = find_uninit_var(o, uninit_sv, 1);
11668 =for apidoc report_uninit
11670 Print appropriate "Use of uninitialized variable" warning
11676 Perl_report_uninit(pTHX_ SV* uninit_sv)
11680 SV* varname = NULL;
11682 varname = find_uninit_var(PL_op, uninit_sv,0);
11684 sv_insert(varname, 0, 0, " ", 1);
11686 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11687 varname ? SvPV_nolen_const(varname) : "",
11688 " in ", OP_DESC(PL_op));
11691 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
11697 * c-indentation-style: bsd
11698 * c-basic-offset: 4
11699 * indent-tabs-mode: t
11702 * ex: set ts=8 sts=4 sw=4 noet: