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 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 #define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 #define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
681 struct arena_desc* adesc;
682 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
685 /* shouldnt need this
686 if (!arena_size) arena_size = PERL_ARENA_SIZE;
689 /* may need new arena-set to hold new arena */
690 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
691 Newxz(newroot, 1, struct arena_set);
692 newroot->set_size = ARENAS_PER_SET;
693 newroot->next = *aroot;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
698 /* ok, now have arena-set with at least 1 empty/available arena-desc */
699 curr = (*aroot)->curr++;
700 adesc = &((*aroot)->set[curr]);
701 assert(!adesc->arena);
703 Newxz(adesc->arena, arena_size, char);
704 adesc->size = arena_size;
705 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
706 curr, adesc->arena, arena_size));
712 /* return a thing to the free list */
714 #define del_body(thing, root) \
716 void ** const thing_copy = (void **)thing;\
718 *thing_copy = *root; \
719 *root = (void*)thing_copy; \
725 =head1 SV-Body Allocation
727 Allocation of SV-bodies is similar to SV-heads, differing as follows;
728 the allocation mechanism is used for many body types, so is somewhat
729 more complicated, it uses arena-sets, and has no need for still-live
732 At the outermost level, (new|del)_X*V macros return bodies of the
733 appropriate type. These macros call either (new|del)_body_type or
734 (new|del)_body_allocated macro pairs, depending on specifics of the
735 type. Most body types use the former pair, the latter pair is used to
736 allocate body types with "ghost fields".
738 "ghost fields" are fields that are unused in certain types, and
739 consequently dont need to actually exist. They are declared because
740 they're part of a "base type", which allows use of functions as
741 methods. The simplest examples are AVs and HVs, 2 aggregate types
742 which don't use the fields which support SCALAR semantics.
744 For these types, the arenas are carved up into *_allocated size
745 chunks, we thus avoid wasted memory for those unaccessed members.
746 When bodies are allocated, we adjust the pointer back in memory by the
747 size of the bit not allocated, so it's as if we allocated the full
748 structure. (But things will all go boom if you write to the part that
749 is "not there", because you'll be overwriting the last members of the
750 preceding structure in memory.)
752 We calculate the correction using the STRUCT_OFFSET macro. For
753 example, if xpv_allocated is the same structure as XPV then the two
754 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
755 structure is smaller (no initial NV actually allocated) then the net
756 effect is to subtract the size of the NV from the pointer, to return a
757 new pointer as if an initial NV were actually allocated.
759 This is the same trick as was used for NV and IV bodies. Ironically it
760 doesn't need to be used for NV bodies any more, because NV is now at
761 the start of the structure. IV bodies don't need it either, because
762 they are no longer allocated.
764 In turn, the new_body_* allocators call S_new_body(), which invokes
765 new_body_inline macro, which takes a lock, and takes a body off the
766 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
767 necessary to refresh an empty list. Then the lock is released, and
768 the body is returned.
770 S_more_bodies calls get_arena(), and carves it up into an array of N
771 bodies, which it strings into a linked list. It looks up arena-size
772 and body-size from the body_details table described below, thus
773 supporting the multiple body-types.
775 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
776 the (new|del)_X*V macros are mapped directly to malloc/free.
782 For each sv-type, struct body_details bodies_by_type[] carries
783 parameters which control these aspects of SV handling:
785 Arena_size determines whether arenas are used for this body type, and if
786 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
787 zero, forcing individual mallocs and frees.
789 Body_size determines how big a body is, and therefore how many fit into
790 each arena. Offset carries the body-pointer adjustment needed for
791 *_allocated body types, and is used in *_allocated macros.
793 But its main purpose is to parameterize info needed in
794 Perl_sv_upgrade(). The info here dramatically simplifies the function
795 vs the implementation in 5.8.7, making it table-driven. All fields
796 are used for this, except for arena_size.
798 For the sv-types that have no bodies, arenas are not used, so those
799 PL_body_roots[sv_type] are unused, and can be overloaded. In
800 something of a special case, SVt_NULL is borrowed for HE arenas;
801 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
802 bodies_by_type[SVt_NULL] slot is not used, as the table is not
805 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
806 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
807 they can just use the same allocation semantics. At first, PTEs were
808 also overloaded to a non-body sv-type, but this yielded hard-to-find
809 malloc bugs, so was simplified by claiming a new slot. This choice
810 has no consequence at this time.
814 struct body_details {
815 U8 body_size; /* Size to allocate */
816 U8 copy; /* Size of structure to copy (may be shorter) */
818 unsigned int type : 4; /* We have space for a sanity check. */
819 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
820 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
821 unsigned int arena : 1; /* Allocated from an arena */
822 size_t arena_size; /* Size of arena to allocate */
830 /* With -DPURFIY we allocate everything directly, and don't use arenas.
831 This seems a rather elegant way to simplify some of the code below. */
832 #define HASARENA FALSE
834 #define HASARENA TRUE
836 #define NOARENA FALSE
838 /* Size the arenas to exactly fit a given number of bodies. A count
839 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
840 simplifying the default. If count > 0, the arena is sized to fit
841 only that many bodies, allowing arenas to be used for large, rare
842 bodies (XPVFM, XPVIO) without undue waste. The arena size is
843 limited by PERL_ARENA_SIZE, so we can safely oversize the
846 #define FIT_ARENA0(body_size) \
847 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
848 #define FIT_ARENAn(count,body_size) \
849 ( count * body_size <= PERL_ARENA_SIZE) \
850 ? count * body_size \
851 : FIT_ARENA0 (body_size)
852 #define FIT_ARENA(count,body_size) \
854 ? FIT_ARENAn (count, body_size) \
855 : FIT_ARENA0 (body_size)
857 /* A macro to work out the offset needed to subtract from a pointer to (say)
864 to make its members accessible via a pointer to (say)
874 #define relative_STRUCT_OFFSET(longer, shorter, member) \
875 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
877 /* Calculate the length to copy. Specifically work out the length less any
878 final padding the compiler needed to add. See the comment in sv_upgrade
879 for why copying the padding proved to be a bug. */
881 #define copy_length(type, last_member) \
882 STRUCT_OFFSET(type, last_member) \
883 + sizeof (((type*)SvANY((SV*)0))->last_member)
885 static const struct body_details bodies_by_type[] = {
886 { sizeof(HE), 0, 0, SVt_NULL,
887 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
889 /* IVs are in the head, so the allocation size is 0.
890 However, the slot is overloaded for PTEs. */
891 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
892 sizeof(IV), /* This is used to copy out the IV body. */
893 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
894 NOARENA /* IVS don't need an arena */,
895 /* But PTEs need to know the size of their arena */
896 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
901 FIT_ARENA(0, sizeof(NV)) },
903 /* RVs are in the head now. */
904 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(xpv_allocated),
908 copy_length(XPV, xpv_len)
909 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
914 { sizeof(xpviv_allocated),
915 copy_length(XPVIV, xiv_u)
916 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
917 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
921 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
922 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
925 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
929 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
933 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
934 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
937 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
938 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
940 { sizeof(xpvav_allocated),
941 copy_length(XPVAV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
943 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
946 { sizeof(xpvhv_allocated),
947 copy_length(XPVHV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
949 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
953 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
954 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
955 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
957 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
958 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
959 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
961 /* XPVIO is 84 bytes, fits 48x */
962 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
963 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
966 #define new_body_type(sv_type) \
967 (void *)((char *)S_new_body(aTHX_ sv_type))
969 #define del_body_type(p, sv_type) \
970 del_body(p, &PL_body_roots[sv_type])
973 #define new_body_allocated(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ sv_type) \
975 - bodies_by_type[sv_type].offset)
977 #define del_body_allocated(p, sv_type) \
978 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
981 #define my_safemalloc(s) (void*)safemalloc(s)
982 #define my_safecalloc(s) (void*)safecalloc(s, 1)
983 #define my_safefree(p) safefree((char*)p)
987 #define new_XNV() my_safemalloc(sizeof(XPVNV))
988 #define del_XNV(p) my_safefree(p)
990 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XPVNV(p) my_safefree(p)
993 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
994 #define del_XPVAV(p) my_safefree(p)
996 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
997 #define del_XPVHV(p) my_safefree(p)
999 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1000 #define del_XPVMG(p) my_safefree(p)
1002 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1003 #define del_XPVGV(p) my_safefree(p)
1007 #define new_XNV() new_body_type(SVt_NV)
1008 #define del_XNV(p) del_body_type(p, SVt_NV)
1010 #define new_XPVNV() new_body_type(SVt_PVNV)
1011 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1013 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1014 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1016 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1017 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1019 #define new_XPVMG() new_body_type(SVt_PVMG)
1020 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1022 #define new_XPVGV() new_body_type(SVt_PVGV)
1023 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1027 /* no arena for you! */
1029 #define new_NOARENA(details) \
1030 my_safemalloc((details)->body_size + (details)->offset)
1031 #define new_NOARENAZ(details) \
1032 my_safecalloc((details)->body_size + (details)->offset)
1035 static bool done_sanity_check;
1039 S_more_bodies (pTHX_ svtype sv_type)
1042 void ** const root = &PL_body_roots[sv_type];
1043 const struct body_details * const bdp = &bodies_by_type[sv_type];
1044 const size_t body_size = bdp->body_size;
1048 assert(bdp->arena_size);
1051 if (!done_sanity_check) {
1052 unsigned int i = SVt_LAST;
1054 done_sanity_check = TRUE;
1057 assert (bodies_by_type[i].type == i);
1061 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1063 end = start + bdp->arena_size - body_size;
1065 /* computed count doesnt reflect the 1st slot reservation */
1066 DEBUG_m(PerlIO_printf(Perl_debug_log,
1067 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1068 start, end, bdp->arena_size, sv_type, body_size,
1069 bdp->arena_size / body_size));
1071 *root = (void *)start;
1073 while (start < end) {
1074 char * const next = start + body_size;
1075 *(void**) start = (void *)next;
1078 *(void **)start = 0;
1083 /* grab a new thing from the free list, allocating more if necessary.
1084 The inline version is used for speed in hot routines, and the
1085 function using it serves the rest (unless PURIFY).
1087 #define new_body_inline(xpv, sv_type) \
1089 void ** const r3wt = &PL_body_roots[sv_type]; \
1091 xpv = *((void **)(r3wt)) \
1092 ? *((void **)(r3wt)) : more_bodies(sv_type); \
1093 *(r3wt) = *(void**)(xpv); \
1100 S_new_body(pTHX_ svtype sv_type)
1104 new_body_inline(xpv, sv_type);
1111 =for apidoc sv_upgrade
1113 Upgrade an SV to a more complex form. Generally adds a new body type to the
1114 SV, then copies across as much information as possible from the old body.
1115 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1121 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1126 const U32 old_type = SvTYPE(sv);
1127 const struct body_details *new_type_details;
1128 const struct body_details *const old_type_details
1129 = bodies_by_type + old_type;
1131 if (new_type != SVt_PV && SvIsCOW(sv)) {
1132 sv_force_normal_flags(sv, 0);
1135 if (old_type == new_type)
1138 if (old_type > new_type)
1139 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1140 (int)old_type, (int)new_type);
1143 old_body = SvANY(sv);
1145 /* Copying structures onto other structures that have been neatly zeroed
1146 has a subtle gotcha. Consider XPVMG
1148 +------+------+------+------+------+-------+-------+
1149 | NV | CUR | LEN | IV | MAGIC | STASH |
1150 +------+------+------+------+------+-------+-------+
1151 0 4 8 12 16 20 24 28
1153 where NVs are aligned to 8 bytes, so that sizeof that structure is
1154 actually 32 bytes long, with 4 bytes of padding at the end:
1156 +------+------+------+------+------+-------+-------+------+
1157 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1158 +------+------+------+------+------+-------+-------+------+
1159 0 4 8 12 16 20 24 28 32
1161 so what happens if you allocate memory for this structure:
1163 +------+------+------+------+------+-------+-------+------+------+...
1164 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1165 +------+------+------+------+------+-------+-------+------+------+...
1166 0 4 8 12 16 20 24 28 32 36
1168 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1169 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1170 started out as zero once, but it's quite possible that it isn't. So now,
1171 rather than a nicely zeroed GP, you have it pointing somewhere random.
1174 (In fact, GP ends up pointing at a previous GP structure, because the
1175 principle cause of the padding in XPVMG getting garbage is a copy of
1176 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1178 So we are careful and work out the size of used parts of all the
1185 if (new_type < SVt_PVIV) {
1186 new_type = (new_type == SVt_NV)
1187 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1198 assert(new_type > SVt_PV);
1199 assert(SVt_IV < SVt_PV);
1200 assert(SVt_NV < SVt_PV);
1207 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1208 there's no way that it can be safely upgraded, because perl.c
1209 expects to Safefree(SvANY(PL_mess_sv)) */
1210 assert(sv != PL_mess_sv);
1211 /* This flag bit is used to mean other things in other scalar types.
1212 Given that it only has meaning inside the pad, it shouldn't be set
1213 on anything that can get upgraded. */
1214 assert(!SvPAD_TYPED(sv));
1217 if (old_type_details->cant_upgrade)
1218 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1219 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1221 new_type_details = bodies_by_type + new_type;
1223 SvFLAGS(sv) &= ~SVTYPEMASK;
1224 SvFLAGS(sv) |= new_type;
1226 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1227 the return statements above will have triggered. */
1228 assert (new_type != SVt_NULL);
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1236 assert(old_type == SVt_NULL);
1237 SvANY(sv) = new_XNV();
1241 assert(old_type == SVt_NULL);
1242 SvANY(sv) = &sv->sv_u.svu_rv;
1247 assert(new_type_details->body_size);
1250 assert(new_type_details->arena);
1251 assert(new_type_details->arena_size);
1252 /* This points to the start of the allocated area. */
1253 new_body_inline(new_body, new_type);
1254 Zero(new_body, new_type_details->body_size, char);
1255 new_body = ((char *)new_body) - new_type_details->offset;
1257 /* We always allocated the full length item with PURIFY. To do this
1258 we fake things so that arena is false for all 16 types.. */
1259 new_body = new_NOARENAZ(new_type_details);
1261 SvANY(sv) = new_body;
1262 if (new_type == SVt_PVAV) {
1268 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1269 The target created by newSVrv also is, and it can have magic.
1270 However, it never has SvPVX set.
1272 if (old_type >= SVt_RV) {
1273 assert(SvPVX_const(sv) == 0);
1276 /* Could put this in the else clause below, as PVMG must have SvPVX
1277 0 already (the assertion above) */
1280 if (old_type >= SVt_PVMG) {
1281 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1288 /* XXX Is this still needed? Was it ever needed? Surely as there is
1289 no route from NV to PVIV, NOK can never be true */
1290 assert(!SvNOKp(sv));
1302 assert(new_type_details->body_size);
1303 /* We always allocated the full length item with PURIFY. To do this
1304 we fake things so that arena is false for all 16 types.. */
1305 if(new_type_details->arena) {
1306 /* This points to the start of the allocated area. */
1307 new_body_inline(new_body, new_type);
1308 Zero(new_body, new_type_details->body_size, char);
1309 new_body = ((char *)new_body) - new_type_details->offset;
1311 new_body = new_NOARENAZ(new_type_details);
1313 SvANY(sv) = new_body;
1315 if (old_type_details->copy) {
1316 /* There is now the potential for an upgrade from something without
1317 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1318 int offset = old_type_details->offset;
1319 int length = old_type_details->copy;
1321 if (new_type_details->offset > old_type_details->offset) {
1322 const int difference
1323 = new_type_details->offset - old_type_details->offset;
1324 offset += difference;
1325 length -= difference;
1327 assert (length >= 0);
1329 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1333 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1334 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1335 * correct 0.0 for us. Otherwise, if the old body didn't have an
1336 * NV slot, but the new one does, then we need to initialise the
1337 * freshly created NV slot with whatever the correct bit pattern is
1339 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1343 if (new_type == SVt_PVIO)
1344 IoPAGE_LEN(sv) = 60;
1345 if (old_type < SVt_RV)
1349 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1350 (unsigned long)new_type);
1353 if (old_type_details->arena) {
1354 /* If there was an old body, then we need to free it.
1355 Note that there is an assumption that all bodies of types that
1356 can be upgraded came from arenas. Only the more complex non-
1357 upgradable types are allowed to be directly malloc()ed. */
1359 my_safefree(old_body);
1361 del_body((void*)((char*)old_body + old_type_details->offset),
1362 &PL_body_roots[old_type]);
1368 =for apidoc sv_backoff
1370 Remove any string offset. You should normally use the C<SvOOK_off> macro
1377 Perl_sv_backoff(pTHX_ register SV *sv)
1379 PERL_UNUSED_CONTEXT;
1381 assert(SvTYPE(sv) != SVt_PVHV);
1382 assert(SvTYPE(sv) != SVt_PVAV);
1384 const char * const s = SvPVX_const(sv);
1385 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1386 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1388 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1390 SvFLAGS(sv) &= ~SVf_OOK;
1397 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1398 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1399 Use the C<SvGROW> wrapper instead.
1405 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1409 if (PL_madskills && newlen >= 0x100000) {
1410 PerlIO_printf(Perl_debug_log,
1411 "Allocation too large: %"UVxf"\n", (UV)newlen);
1413 #ifdef HAS_64K_LIMIT
1414 if (newlen >= 0x10000) {
1415 PerlIO_printf(Perl_debug_log,
1416 "Allocation too large: %"UVxf"\n", (UV)newlen);
1419 #endif /* HAS_64K_LIMIT */
1422 if (SvTYPE(sv) < SVt_PV) {
1423 sv_upgrade(sv, SVt_PV);
1424 s = SvPVX_mutable(sv);
1426 else if (SvOOK(sv)) { /* pv is offset? */
1428 s = SvPVX_mutable(sv);
1429 if (newlen > SvLEN(sv))
1430 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1431 #ifdef HAS_64K_LIMIT
1432 if (newlen >= 0x10000)
1437 s = SvPVX_mutable(sv);
1439 if (newlen > SvLEN(sv)) { /* need more room? */
1440 newlen = PERL_STRLEN_ROUNDUP(newlen);
1441 if (SvLEN(sv) && s) {
1443 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1449 s = saferealloc(s, newlen);
1452 s = safemalloc(newlen);
1453 if (SvPVX_const(sv) && SvCUR(sv)) {
1454 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1458 SvLEN_set(sv, newlen);
1464 =for apidoc sv_setiv
1466 Copies an integer into the given SV, upgrading first if necessary.
1467 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1473 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1476 SV_CHECK_THINKFIRST_COW_DROP(sv);
1477 switch (SvTYPE(sv)) {
1479 sv_upgrade(sv, SVt_IV);
1482 sv_upgrade(sv, SVt_PVNV);
1486 sv_upgrade(sv, SVt_PVIV);
1495 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1498 (void)SvIOK_only(sv); /* validate number */
1504 =for apidoc sv_setiv_mg
1506 Like C<sv_setiv>, but also handles 'set' magic.
1512 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1519 =for apidoc sv_setuv
1521 Copies an unsigned integer into the given SV, upgrading first if necessary.
1522 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1528 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1530 /* With these two if statements:
1531 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1534 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1536 If you wish to remove them, please benchmark to see what the effect is
1538 if (u <= (UV)IV_MAX) {
1539 sv_setiv(sv, (IV)u);
1548 =for apidoc sv_setuv_mg
1550 Like C<sv_setuv>, but also handles 'set' magic.
1556 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1565 =for apidoc sv_setnv
1567 Copies a double into the given SV, upgrading first if necessary.
1568 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1574 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1577 SV_CHECK_THINKFIRST_COW_DROP(sv);
1578 switch (SvTYPE(sv)) {
1581 sv_upgrade(sv, SVt_NV);
1586 sv_upgrade(sv, SVt_PVNV);
1595 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1599 (void)SvNOK_only(sv); /* validate number */
1604 =for apidoc sv_setnv_mg
1606 Like C<sv_setnv>, but also handles 'set' magic.
1612 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1618 /* Print an "isn't numeric" warning, using a cleaned-up,
1619 * printable version of the offending string
1623 S_not_a_number(pTHX_ SV *sv)
1631 dsv = sv_2mortal(newSVpvs(""));
1632 pv = sv_uni_display(dsv, sv, 10, 0);
1635 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1636 /* each *s can expand to 4 chars + "...\0",
1637 i.e. need room for 8 chars */
1639 const char *s = SvPVX_const(sv);
1640 const char * const end = s + SvCUR(sv);
1641 for ( ; s < end && d < limit; s++ ) {
1643 if (ch & 128 && !isPRINT_LC(ch)) {
1652 else if (ch == '\r') {
1656 else if (ch == '\f') {
1660 else if (ch == '\\') {
1664 else if (ch == '\0') {
1668 else if (isPRINT_LC(ch))
1685 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1686 "Argument \"%s\" isn't numeric in %s", pv,
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric", pv);
1694 =for apidoc looks_like_number
1696 Test if the content of an SV looks like a number (or is a number).
1697 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1698 non-numeric warning), even if your atof() doesn't grok them.
1704 Perl_looks_like_number(pTHX_ SV *sv)
1706 register const char *sbegin;
1710 sbegin = SvPVX_const(sv);
1713 else if (SvPOKp(sv))
1714 sbegin = SvPV_const(sv, len);
1716 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1717 return grok_number(sbegin, len, NULL);
1721 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1723 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1724 SV *const buffer = sv_newmortal();
1726 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1729 gv_efullname3(buffer, gv, "*");
1730 SvFLAGS(gv) |= wasfake;
1733 /* We know that all GVs stringify to something that is not-a-number,
1734 so no need to test that. */
1735 if (ckWARN(WARN_NUMERIC))
1736 not_a_number(buffer);
1737 /* We just want something true to return, so that S_sv_2iuv_common
1738 can tail call us and return true. */
1741 return SvPV(buffer, *len);
1745 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1746 until proven guilty, assume that things are not that bad... */
1751 As 64 bit platforms often have an NV that doesn't preserve all bits of
1752 an IV (an assumption perl has been based on to date) it becomes necessary
1753 to remove the assumption that the NV always carries enough precision to
1754 recreate the IV whenever needed, and that the NV is the canonical form.
1755 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1756 precision as a side effect of conversion (which would lead to insanity
1757 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1758 1) to distinguish between IV/UV/NV slots that have cached a valid
1759 conversion where precision was lost and IV/UV/NV slots that have a
1760 valid conversion which has lost no precision
1761 2) to ensure that if a numeric conversion to one form is requested that
1762 would lose precision, the precise conversion (or differently
1763 imprecise conversion) is also performed and cached, to prevent
1764 requests for different numeric formats on the same SV causing
1765 lossy conversion chains. (lossless conversion chains are perfectly
1770 SvIOKp is true if the IV slot contains a valid value
1771 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1772 SvNOKp is true if the NV slot contains a valid value
1773 SvNOK is true only if the NV value is accurate
1776 while converting from PV to NV, check to see if converting that NV to an
1777 IV(or UV) would lose accuracy over a direct conversion from PV to
1778 IV(or UV). If it would, cache both conversions, return NV, but mark
1779 SV as IOK NOKp (ie not NOK).
1781 While converting from PV to IV, check to see if converting that IV to an
1782 NV would lose accuracy over a direct conversion from PV to NV. If it
1783 would, cache both conversions, flag similarly.
1785 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1786 correctly because if IV & NV were set NV *always* overruled.
1787 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1788 changes - now IV and NV together means that the two are interchangeable:
1789 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1791 The benefit of this is that operations such as pp_add know that if
1792 SvIOK is true for both left and right operands, then integer addition
1793 can be used instead of floating point (for cases where the result won't
1794 overflow). Before, floating point was always used, which could lead to
1795 loss of precision compared with integer addition.
1797 * making IV and NV equal status should make maths accurate on 64 bit
1799 * may speed up maths somewhat if pp_add and friends start to use
1800 integers when possible instead of fp. (Hopefully the overhead in
1801 looking for SvIOK and checking for overflow will not outweigh the
1802 fp to integer speedup)
1803 * will slow down integer operations (callers of SvIV) on "inaccurate"
1804 values, as the change from SvIOK to SvIOKp will cause a call into
1805 sv_2iv each time rather than a macro access direct to the IV slot
1806 * should speed up number->string conversion on integers as IV is
1807 favoured when IV and NV are equally accurate
1809 ####################################################################
1810 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1811 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1812 On the other hand, SvUOK is true iff UV.
1813 ####################################################################
1815 Your mileage will vary depending your CPU's relative fp to integer
1819 #ifndef NV_PRESERVES_UV
1820 # define IS_NUMBER_UNDERFLOW_IV 1
1821 # define IS_NUMBER_UNDERFLOW_UV 2
1822 # define IS_NUMBER_IV_AND_UV 2
1823 # define IS_NUMBER_OVERFLOW_IV 4
1824 # define IS_NUMBER_OVERFLOW_UV 5
1826 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1828 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1830 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1833 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));
1834 if (SvNVX(sv) < (NV)IV_MIN) {
1835 (void)SvIOKp_on(sv);
1837 SvIV_set(sv, IV_MIN);
1838 return IS_NUMBER_UNDERFLOW_IV;
1840 if (SvNVX(sv) > (NV)UV_MAX) {
1841 (void)SvIOKp_on(sv);
1844 SvUV_set(sv, UV_MAX);
1845 return IS_NUMBER_OVERFLOW_UV;
1847 (void)SvIOKp_on(sv);
1849 /* Can't use strtol etc to convert this string. (See truth table in
1851 if (SvNVX(sv) <= (UV)IV_MAX) {
1852 SvIV_set(sv, I_V(SvNVX(sv)));
1853 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1854 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1856 /* Integer is imprecise. NOK, IOKp */
1858 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1861 SvUV_set(sv, U_V(SvNVX(sv)));
1862 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1863 if (SvUVX(sv) == UV_MAX) {
1864 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1865 possibly be preserved by NV. Hence, it must be overflow.
1867 return IS_NUMBER_OVERFLOW_UV;
1869 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1871 /* Integer is imprecise. NOK, IOKp */
1873 return IS_NUMBER_OVERFLOW_IV;
1875 #endif /* !NV_PRESERVES_UV*/
1878 S_sv_2iuv_common(pTHX_ SV *sv) {
1881 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1882 * without also getting a cached IV/UV from it at the same time
1883 * (ie PV->NV conversion should detect loss of accuracy and cache
1884 * IV or UV at same time to avoid this. */
1885 /* IV-over-UV optimisation - choose to cache IV if possible */
1887 if (SvTYPE(sv) == SVt_NV)
1888 sv_upgrade(sv, SVt_PVNV);
1890 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1891 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1892 certainly cast into the IV range at IV_MAX, whereas the correct
1893 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1895 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1896 if (Perl_isnan(SvNVX(sv))) {
1902 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1903 SvIV_set(sv, I_V(SvNVX(sv)));
1904 if (SvNVX(sv) == (NV) SvIVX(sv)
1905 #ifndef NV_PRESERVES_UV
1906 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1907 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1908 /* Don't flag it as "accurately an integer" if the number
1909 came from a (by definition imprecise) NV operation, and
1910 we're outside the range of NV integer precision */
1913 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1914 DEBUG_c(PerlIO_printf(Perl_debug_log,
1915 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1921 /* IV not precise. No need to convert from PV, as NV
1922 conversion would already have cached IV if it detected
1923 that PV->IV would be better than PV->NV->IV
1924 flags already correct - don't set public IOK. */
1925 DEBUG_c(PerlIO_printf(Perl_debug_log,
1926 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1931 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1932 but the cast (NV)IV_MIN rounds to a the value less (more
1933 negative) than IV_MIN which happens to be equal to SvNVX ??
1934 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1935 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1936 (NV)UVX == NVX are both true, but the values differ. :-(
1937 Hopefully for 2s complement IV_MIN is something like
1938 0x8000000000000000 which will be exact. NWC */
1941 SvUV_set(sv, U_V(SvNVX(sv)));
1943 (SvNVX(sv) == (NV) SvUVX(sv))
1944 #ifndef NV_PRESERVES_UV
1945 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1946 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1947 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1948 /* Don't flag it as "accurately an integer" if the number
1949 came from a (by definition imprecise) NV operation, and
1950 we're outside the range of NV integer precision */
1955 DEBUG_c(PerlIO_printf(Perl_debug_log,
1956 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1962 else if (SvPOKp(sv) && SvLEN(sv)) {
1964 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1965 /* We want to avoid a possible problem when we cache an IV/ a UV which
1966 may be later translated to an NV, and the resulting NV is not
1967 the same as the direct translation of the initial string
1968 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1969 be careful to ensure that the value with the .456 is around if the
1970 NV value is requested in the future).
1972 This means that if we cache such an IV/a UV, we need to cache the
1973 NV as well. Moreover, we trade speed for space, and do not
1974 cache the NV if we are sure it's not needed.
1977 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1978 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1979 == IS_NUMBER_IN_UV) {
1980 /* It's definitely an integer, only upgrade to PVIV */
1981 if (SvTYPE(sv) < SVt_PVIV)
1982 sv_upgrade(sv, SVt_PVIV);
1984 } else if (SvTYPE(sv) < SVt_PVNV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 /* If NVs preserve UVs then we only use the UV value if we know that
1988 we aren't going to call atof() below. If NVs don't preserve UVs
1989 then the value returned may have more precision than atof() will
1990 return, even though value isn't perfectly accurate. */
1991 if ((numtype & (IS_NUMBER_IN_UV
1992 #ifdef NV_PRESERVES_UV
1995 )) == IS_NUMBER_IN_UV) {
1996 /* This won't turn off the public IOK flag if it was set above */
1997 (void)SvIOKp_on(sv);
1999 if (!(numtype & IS_NUMBER_NEG)) {
2001 if (value <= (UV)IV_MAX) {
2002 SvIV_set(sv, (IV)value);
2004 /* it didn't overflow, and it was positive. */
2005 SvUV_set(sv, value);
2009 /* 2s complement assumption */
2010 if (value <= (UV)IV_MIN) {
2011 SvIV_set(sv, -(IV)value);
2013 /* Too negative for an IV. This is a double upgrade, but
2014 I'm assuming it will be rare. */
2015 if (SvTYPE(sv) < SVt_PVNV)
2016 sv_upgrade(sv, SVt_PVNV);
2020 SvNV_set(sv, -(NV)value);
2021 SvIV_set(sv, IV_MIN);
2025 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2026 will be in the previous block to set the IV slot, and the next
2027 block to set the NV slot. So no else here. */
2029 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2030 != IS_NUMBER_IN_UV) {
2031 /* It wasn't an (integer that doesn't overflow the UV). */
2032 SvNV_set(sv, Atof(SvPVX_const(sv)));
2034 if (! numtype && ckWARN(WARN_NUMERIC))
2037 #if defined(USE_LONG_DOUBLE)
2038 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2039 PTR2UV(sv), SvNVX(sv)));
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2045 #ifdef NV_PRESERVES_UV
2046 (void)SvIOKp_on(sv);
2048 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2049 SvIV_set(sv, I_V(SvNVX(sv)));
2050 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2053 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2055 /* UV will not work better than IV */
2057 if (SvNVX(sv) > (NV)UV_MAX) {
2059 /* Integer is inaccurate. NOK, IOKp, is UV */
2060 SvUV_set(sv, UV_MAX);
2062 SvUV_set(sv, U_V(SvNVX(sv)));
2063 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2064 NV preservse UV so can do correct comparison. */
2065 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2068 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2073 #else /* NV_PRESERVES_UV */
2074 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2075 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2076 /* The IV/UV slot will have been set from value returned by
2077 grok_number above. The NV slot has just been set using
2080 assert (SvIOKp(sv));
2082 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2083 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2084 /* Small enough to preserve all bits. */
2085 (void)SvIOKp_on(sv);
2087 SvIV_set(sv, I_V(SvNVX(sv)));
2088 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2090 /* Assumption: first non-preserved integer is < IV_MAX,
2091 this NV is in the preserved range, therefore: */
2092 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2094 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);
2098 0 0 already failed to read UV.
2099 0 1 already failed to read UV.
2100 1 0 you won't get here in this case. IV/UV
2101 slot set, public IOK, Atof() unneeded.
2102 1 1 already read UV.
2103 so there's no point in sv_2iuv_non_preserve() attempting
2104 to use atol, strtol, strtoul etc. */
2105 sv_2iuv_non_preserve (sv, numtype);
2108 #endif /* NV_PRESERVES_UV */
2112 if (isGV_with_GP(sv)) {
2113 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2116 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2117 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2120 if (SvTYPE(sv) < SVt_IV)
2121 /* Typically the caller expects that sv_any is not NULL now. */
2122 sv_upgrade(sv, SVt_IV);
2123 /* Return 0 from the caller. */
2130 =for apidoc sv_2iv_flags
2132 Return the integer value of an SV, doing any necessary string
2133 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2134 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2140 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2145 if (SvGMAGICAL(sv)) {
2146 if (flags & SV_GMAGIC)
2151 return I_V(SvNVX(sv));
2153 if (SvPOKp(sv) && SvLEN(sv)) {
2156 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2158 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2159 == IS_NUMBER_IN_UV) {
2160 /* It's definitely an integer */
2161 if (numtype & IS_NUMBER_NEG) {
2162 if (value < (UV)IV_MIN)
2165 if (value < (UV)IV_MAX)
2170 if (ckWARN(WARN_NUMERIC))
2173 return I_V(Atof(SvPVX_const(sv)));
2178 assert(SvTYPE(sv) >= SVt_PVMG);
2179 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2180 } else if (SvTHINKFIRST(sv)) {
2184 SV * const tmpstr=AMG_CALLun(sv,numer);
2185 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2186 return SvIV(tmpstr);
2189 return PTR2IV(SvRV(sv));
2192 sv_force_normal_flags(sv, 0);
2194 if (SvREADONLY(sv) && !SvOK(sv)) {
2195 if (ckWARN(WARN_UNINITIALIZED))
2201 if (S_sv_2iuv_common(aTHX_ sv))
2204 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2205 PTR2UV(sv),SvIVX(sv)));
2206 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2210 =for apidoc sv_2uv_flags
2212 Return the unsigned integer value of an SV, doing any necessary string
2213 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2214 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2220 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2225 if (SvGMAGICAL(sv)) {
2226 if (flags & SV_GMAGIC)
2231 return U_V(SvNVX(sv));
2232 if (SvPOKp(sv) && SvLEN(sv)) {
2235 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2237 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2238 == IS_NUMBER_IN_UV) {
2239 /* It's definitely an integer */
2240 if (!(numtype & IS_NUMBER_NEG))
2244 if (ckWARN(WARN_NUMERIC))
2247 return U_V(Atof(SvPVX_const(sv)));
2252 assert(SvTYPE(sv) >= SVt_PVMG);
2253 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2254 } else if (SvTHINKFIRST(sv)) {
2258 SV *const tmpstr = AMG_CALLun(sv,numer);
2259 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2260 return SvUV(tmpstr);
2263 return PTR2UV(SvRV(sv));
2266 sv_force_normal_flags(sv, 0);
2268 if (SvREADONLY(sv) && !SvOK(sv)) {
2269 if (ckWARN(WARN_UNINITIALIZED))
2275 if (S_sv_2iuv_common(aTHX_ sv))
2279 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2280 PTR2UV(sv),SvUVX(sv)));
2281 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2287 Return the num value of an SV, doing any necessary string or integer
2288 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2295 Perl_sv_2nv(pTHX_ register SV *sv)
2300 if (SvGMAGICAL(sv)) {
2304 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2305 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2306 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2308 return Atof(SvPVX_const(sv));
2312 return (NV)SvUVX(sv);
2314 return (NV)SvIVX(sv);
2319 assert(SvTYPE(sv) >= SVt_PVMG);
2320 /* This falls through to the report_uninit near the end of the
2322 } else if (SvTHINKFIRST(sv)) {
2326 SV *const tmpstr = AMG_CALLun(sv,numer);
2327 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2328 return SvNV(tmpstr);
2331 return PTR2NV(SvRV(sv));
2334 sv_force_normal_flags(sv, 0);
2336 if (SvREADONLY(sv) && !SvOK(sv)) {
2337 if (ckWARN(WARN_UNINITIALIZED))
2342 if (SvTYPE(sv) < SVt_NV) {
2343 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2344 sv_upgrade(sv, SVt_NV);
2345 #ifdef USE_LONG_DOUBLE
2347 STORE_NUMERIC_LOCAL_SET_STANDARD();
2348 PerlIO_printf(Perl_debug_log,
2349 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2350 PTR2UV(sv), SvNVX(sv));
2351 RESTORE_NUMERIC_LOCAL();
2355 STORE_NUMERIC_LOCAL_SET_STANDARD();
2356 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2357 PTR2UV(sv), SvNVX(sv));
2358 RESTORE_NUMERIC_LOCAL();
2362 else if (SvTYPE(sv) < SVt_PVNV)
2363 sv_upgrade(sv, SVt_PVNV);
2368 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2369 #ifdef NV_PRESERVES_UV
2372 /* Only set the public NV OK flag if this NV preserves the IV */
2373 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2374 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2375 : (SvIVX(sv) == I_V(SvNVX(sv))))
2381 else if (SvPOKp(sv) && SvLEN(sv)) {
2383 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2384 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2386 #ifdef NV_PRESERVES_UV
2387 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2388 == IS_NUMBER_IN_UV) {
2389 /* It's definitely an integer */
2390 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2392 SvNV_set(sv, Atof(SvPVX_const(sv)));
2395 SvNV_set(sv, Atof(SvPVX_const(sv)));
2396 /* Only set the public NV OK flag if this NV preserves the value in
2397 the PV at least as well as an IV/UV would.
2398 Not sure how to do this 100% reliably. */
2399 /* if that shift count is out of range then Configure's test is
2400 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2402 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2403 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2404 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2405 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2406 /* Can't use strtol etc to convert this string, so don't try.
2407 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2410 /* value has been set. It may not be precise. */
2411 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2412 /* 2s complement assumption for (UV)IV_MIN */
2413 SvNOK_on(sv); /* Integer is too negative. */
2418 if (numtype & IS_NUMBER_NEG) {
2419 SvIV_set(sv, -(IV)value);
2420 } else if (value <= (UV)IV_MAX) {
2421 SvIV_set(sv, (IV)value);
2423 SvUV_set(sv, value);
2427 if (numtype & IS_NUMBER_NOT_INT) {
2428 /* I believe that even if the original PV had decimals,
2429 they are lost beyond the limit of the FP precision.
2430 However, neither is canonical, so both only get p
2431 flags. NWC, 2000/11/25 */
2432 /* Both already have p flags, so do nothing */
2434 const NV nv = SvNVX(sv);
2435 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2436 if (SvIVX(sv) == I_V(nv)) {
2439 /* It had no "." so it must be integer. */
2443 /* between IV_MAX and NV(UV_MAX).
2444 Could be slightly > UV_MAX */
2446 if (numtype & IS_NUMBER_NOT_INT) {
2447 /* UV and NV both imprecise. */
2449 const UV nv_as_uv = U_V(nv);
2451 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2460 #endif /* NV_PRESERVES_UV */
2463 if (isGV_with_GP(sv)) {
2464 glob_2inpuv((GV *)sv, NULL, TRUE);
2468 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2470 assert (SvTYPE(sv) >= SVt_NV);
2471 /* Typically the caller expects that sv_any is not NULL now. */
2472 /* XXX Ilya implies that this is a bug in callers that assume this
2473 and ideally should be fixed. */
2476 #if defined(USE_LONG_DOUBLE)
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2480 PTR2UV(sv), SvNVX(sv));
2481 RESTORE_NUMERIC_LOCAL();
2485 STORE_NUMERIC_LOCAL_SET_STANDARD();
2486 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2487 PTR2UV(sv), SvNVX(sv));
2488 RESTORE_NUMERIC_LOCAL();
2494 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2495 * UV as a string towards the end of buf, and return pointers to start and
2498 * We assume that buf is at least TYPE_CHARS(UV) long.
2502 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2504 char *ptr = buf + TYPE_CHARS(UV);
2505 char * const ebuf = ptr;
2518 *--ptr = '0' + (char)(uv % 10);
2526 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2527 * a regexp to its stringified form.
2531 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2533 const regexp * const re = (regexp *)mg->mg_obj;
2536 const char *fptr = "msix";
2541 bool need_newline = 0;
2542 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2544 while((ch = *fptr++)) {
2546 reflags[left++] = ch;
2549 reflags[right--] = ch;
2554 reflags[left] = '-';
2558 mg->mg_len = re->prelen + 4 + left;
2560 * If /x was used, we have to worry about a regex ending with a
2561 * comment later being embedded within another regex. If so, we don't
2562 * want this regex's "commentization" to leak out to the right part of
2563 * the enclosing regex, we must cap it with a newline.
2565 * So, if /x was used, we scan backwards from the end of the regex. If
2566 * we find a '#' before we find a newline, we need to add a newline
2567 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2568 * we don't need to add anything. -jfriedl
2570 if (PMf_EXTENDED & re->reganch) {
2571 const char *endptr = re->precomp + re->prelen;
2572 while (endptr >= re->precomp) {
2573 const char c = *(endptr--);
2575 break; /* don't need another */
2577 /* we end while in a comment, so we need a newline */
2578 mg->mg_len++; /* save space for it */
2579 need_newline = 1; /* note to add it */
2585 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2586 mg->mg_ptr[0] = '(';
2587 mg->mg_ptr[1] = '?';
2588 Copy(reflags, mg->mg_ptr+2, left, char);
2589 *(mg->mg_ptr+left+2) = ':';
2590 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2592 mg->mg_ptr[mg->mg_len - 2] = '\n';
2593 mg->mg_ptr[mg->mg_len - 1] = ')';
2594 mg->mg_ptr[mg->mg_len] = 0;
2596 PL_reginterp_cnt += re->program[0].next_off;
2598 if (re->reganch & ROPT_UTF8)
2608 =for apidoc sv_2pv_flags
2610 Returns a pointer to the string value of an SV, and sets *lp to its length.
2611 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2613 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2614 usually end up here too.
2620 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2630 if (SvGMAGICAL(sv)) {
2631 if (flags & SV_GMAGIC)
2636 if (flags & SV_MUTABLE_RETURN)
2637 return SvPVX_mutable(sv);
2638 if (flags & SV_CONST_RETURN)
2639 return (char *)SvPVX_const(sv);
2642 if (SvIOKp(sv) || SvNOKp(sv)) {
2643 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2647 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2648 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2650 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2657 #ifdef FIXNEGATIVEZERO
2658 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2664 SvUPGRADE(sv, SVt_PV);
2667 s = SvGROW_mutable(sv, len + 1);
2670 return memcpy(s, tbuf, len + 1);
2676 assert(SvTYPE(sv) >= SVt_PVMG);
2677 /* This falls through to the report_uninit near the end of the
2679 } else if (SvTHINKFIRST(sv)) {
2683 SV *const tmpstr = AMG_CALLun(sv,string);
2684 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2686 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2690 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2691 if (flags & SV_CONST_RETURN) {
2692 pv = (char *) SvPVX_const(tmpstr);
2694 pv = (flags & SV_MUTABLE_RETURN)
2695 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2698 *lp = SvCUR(tmpstr);
2700 pv = sv_2pv_flags(tmpstr, lp, flags);
2712 const SV *const referent = (SV*)SvRV(sv);
2715 tsv = sv_2mortal(newSVpvs("NULLREF"));
2716 } else if (SvTYPE(referent) == SVt_PVMG
2717 && ((SvFLAGS(referent) &
2718 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2719 == (SVs_OBJECT|SVs_SMG))
2720 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2721 return stringify_regexp(sv, mg, lp);
2723 const char *const typestr = sv_reftype(referent, 0);
2725 tsv = sv_newmortal();
2726 if (SvOBJECT(referent)) {
2727 const char *const name = HvNAME_get(SvSTASH(referent));
2728 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2729 name ? name : "__ANON__" , typestr,
2733 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2741 if (SvREADONLY(sv) && !SvOK(sv)) {
2742 if (ckWARN(WARN_UNINITIALIZED))
2749 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2750 /* I'm assuming that if both IV and NV are equally valid then
2751 converting the IV is going to be more efficient */
2752 const U32 isIOK = SvIOK(sv);
2753 const U32 isUIOK = SvIsUV(sv);
2754 char buf[TYPE_CHARS(UV)];
2757 if (SvTYPE(sv) < SVt_PVIV)
2758 sv_upgrade(sv, SVt_PVIV);
2759 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2760 /* inlined from sv_setpvn */
2761 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2762 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2763 SvCUR_set(sv, ebuf - ptr);
2773 else if (SvNOKp(sv)) {
2774 const int olderrno = errno;
2775 if (SvTYPE(sv) < SVt_PVNV)
2776 sv_upgrade(sv, SVt_PVNV);
2777 /* The +20 is pure guesswork. Configure test needed. --jhi */
2778 s = SvGROW_mutable(sv, NV_DIG + 20);
2779 /* some Xenix systems wipe out errno here */
2781 if (SvNVX(sv) == 0.0)
2782 (void)strcpy(s,"0");
2786 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2789 #ifdef FIXNEGATIVEZERO
2790 if (*s == '-' && s[1] == '0' && !s[2])
2800 if (isGV_with_GP(sv)) {
2801 return glob_2inpuv((GV *)sv, lp, FALSE);
2804 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2808 if (SvTYPE(sv) < SVt_PV)
2809 /* Typically the caller expects that sv_any is not NULL now. */
2810 sv_upgrade(sv, SVt_PV);
2814 const STRLEN len = s - SvPVX_const(sv);
2820 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2821 PTR2UV(sv),SvPVX_const(sv)));
2822 if (flags & SV_CONST_RETURN)
2823 return (char *)SvPVX_const(sv);
2824 if (flags & SV_MUTABLE_RETURN)
2825 return SvPVX_mutable(sv);
2830 =for apidoc sv_copypv
2832 Copies a stringified representation of the source SV into the
2833 destination SV. Automatically performs any necessary mg_get and
2834 coercion of numeric values into strings. Guaranteed to preserve
2835 UTF-8 flag even from overloaded objects. Similar in nature to
2836 sv_2pv[_flags] but operates directly on an SV instead of just the
2837 string. Mostly uses sv_2pv_flags to do its work, except when that
2838 would lose the UTF-8'ness of the PV.
2844 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2847 const char * const s = SvPV_const(ssv,len);
2848 sv_setpvn(dsv,s,len);
2856 =for apidoc sv_2pvbyte
2858 Return a pointer to the byte-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be downgraded from UTF-8 as a
2862 Usually accessed via the C<SvPVbyte> macro.
2868 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2870 sv_utf8_downgrade(sv,0);
2871 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2pvutf8
2877 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2878 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2880 Usually accessed via the C<SvPVutf8> macro.
2886 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2888 sv_utf8_upgrade(sv);
2889 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2894 =for apidoc sv_2bool
2896 This function is only called on magical items, and is only used by
2897 sv_true() or its macro equivalent.
2903 Perl_sv_2bool(pTHX_ register SV *sv)
2912 SV * const tmpsv = AMG_CALLun(sv,bool_);
2913 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2914 return (bool)SvTRUE(tmpsv);
2916 return SvRV(sv) != 0;
2919 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2921 (*sv->sv_u.svu_pv > '0' ||
2922 Xpvtmp->xpv_cur > 1 ||
2923 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2930 return SvIVX(sv) != 0;
2933 return SvNVX(sv) != 0.0;
2935 if (isGV_with_GP(sv))
2945 =for apidoc sv_utf8_upgrade
2947 Converts the PV of an SV to its UTF-8-encoded form.
2948 Forces the SV to string form if it is not already.
2949 Always sets the SvUTF8 flag to avoid future validity checks even
2950 if all the bytes have hibit clear.
2952 This is not as a general purpose byte encoding to Unicode interface:
2953 use the Encode extension for that.
2955 =for apidoc sv_utf8_upgrade_flags
2957 Converts the PV of an SV to its UTF-8-encoded form.
2958 Forces the SV to string form if it is not already.
2959 Always sets the SvUTF8 flag to avoid future validity checks even
2960 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2961 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2962 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2964 This is not as a general purpose byte encoding to Unicode interface:
2965 use the Encode extension for that.
2971 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2974 if (sv == &PL_sv_undef)
2978 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2979 (void) sv_2pv_flags(sv,&len, flags);
2983 (void) SvPV_force(sv,len);
2992 sv_force_normal_flags(sv, 0);
2995 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2996 sv_recode_to_utf8(sv, PL_encoding);
2997 else { /* Assume Latin-1/EBCDIC */
2998 /* This function could be much more efficient if we
2999 * had a FLAG in SVs to signal if there are any hibit
3000 * chars in the PV. Given that there isn't such a flag
3001 * make the loop as fast as possible. */
3002 const U8 * const s = (U8 *) SvPVX_const(sv);
3003 const U8 * const e = (U8 *) SvEND(sv);
3008 /* Check for hi bit */
3009 if (!NATIVE_IS_INVARIANT(ch)) {
3010 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3011 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3013 SvPV_free(sv); /* No longer using what was there before. */
3014 SvPV_set(sv, (char*)recoded);
3015 SvCUR_set(sv, len - 1);
3016 SvLEN_set(sv, len); /* No longer know the real size. */
3020 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3027 =for apidoc sv_utf8_downgrade
3029 Attempts to convert the PV of an SV from characters to bytes.
3030 If the PV contains a character beyond byte, this conversion will fail;
3031 in this case, either returns false or, if C<fail_ok> is not
3034 This is not as a general purpose Unicode to byte encoding interface:
3035 use the Encode extension for that.
3041 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3044 if (SvPOKp(sv) && SvUTF8(sv)) {
3050 sv_force_normal_flags(sv, 0);
3052 s = (U8 *) SvPV(sv, len);
3053 if (!utf8_to_bytes(s, &len)) {
3058 Perl_croak(aTHX_ "Wide character in %s",
3061 Perl_croak(aTHX_ "Wide character");
3072 =for apidoc sv_utf8_encode
3074 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3075 flag off so that it looks like octets again.
3081 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3083 (void) sv_utf8_upgrade(sv);
3085 sv_force_normal_flags(sv, 0);
3087 if (SvREADONLY(sv)) {
3088 Perl_croak(aTHX_ PL_no_modify);
3094 =for apidoc sv_utf8_decode
3096 If the PV of the SV is an octet sequence in UTF-8
3097 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3098 so that it looks like a character. If the PV contains only single-byte
3099 characters, the C<SvUTF8> flag stays being off.
3100 Scans PV for validity and returns false if the PV is invalid UTF-8.
3106 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3112 /* The octets may have got themselves encoded - get them back as
3115 if (!sv_utf8_downgrade(sv, TRUE))
3118 /* it is actually just a matter of turning the utf8 flag on, but
3119 * we want to make sure everything inside is valid utf8 first.
3121 c = (const U8 *) SvPVX_const(sv);
3122 if (!is_utf8_string(c, SvCUR(sv)+1))
3124 e = (const U8 *) SvEND(sv);
3127 if (!UTF8_IS_INVARIANT(ch)) {
3137 =for apidoc sv_setsv
3139 Copies the contents of the source SV C<ssv> into the destination SV
3140 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3141 function if the source SV needs to be reused. Does not handle 'set' magic.
3142 Loosely speaking, it performs a copy-by-value, obliterating any previous
3143 content of the destination.
3145 You probably want to use one of the assortment of wrappers, such as
3146 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3147 C<SvSetMagicSV_nosteal>.
3149 =for apidoc sv_setsv_flags
3151 Copies the contents of the source SV C<ssv> into the destination SV
3152 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3153 function if the source SV needs to be reused. Does not handle 'set' magic.
3154 Loosely speaking, it performs a copy-by-value, obliterating any previous
3155 content of the destination.
3156 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3157 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3158 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3159 and C<sv_setsv_nomg> are implemented in terms of this function.
3161 You probably want to use one of the assortment of wrappers, such as
3162 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3163 C<SvSetMagicSV_nosteal>.
3165 This is the primary function for copying scalars, and most other
3166 copy-ish functions and macros use this underneath.
3172 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3174 if (dtype != SVt_PVGV) {
3175 const char * const name = GvNAME(sstr);
3176 const STRLEN len = GvNAMELEN(sstr);
3177 /* don't upgrade SVt_PVLV: it can hold a glob */
3178 if (dtype != SVt_PVLV) {
3179 if (dtype >= SVt_PV) {
3185 sv_upgrade(dstr, SVt_PVGV);
3186 (void)SvOK_off(dstr);
3189 GvSTASH(dstr) = GvSTASH(sstr);
3191 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3192 gv_name_set((GV *)dstr, name, len, GV_ADD);
3193 SvFAKE_on(dstr); /* can coerce to non-glob */
3196 #ifdef GV_UNIQUE_CHECK
3197 if (GvUNIQUE((GV*)dstr)) {
3198 Perl_croak(aTHX_ PL_no_modify);
3204 (void)SvOK_off(dstr);
3206 GvINTRO_off(dstr); /* one-shot flag */
3207 GvGP(dstr) = gp_ref(GvGP(sstr));
3208 if (SvTAINTED(sstr))
3210 if (GvIMPORTED(dstr) != GVf_IMPORTED
3211 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3213 GvIMPORTED_on(dstr);
3220 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3221 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3223 const int intro = GvINTRO(dstr);
3226 const U32 stype = SvTYPE(sref);
3229 #ifdef GV_UNIQUE_CHECK
3230 if (GvUNIQUE((GV*)dstr)) {
3231 Perl_croak(aTHX_ PL_no_modify);
3236 GvINTRO_off(dstr); /* one-shot flag */
3237 GvLINE(dstr) = CopLINE(PL_curcop);
3238 GvEGV(dstr) = (GV*)dstr;
3243 location = (SV **) &GvCV(dstr);
3244 import_flag = GVf_IMPORTED_CV;
3247 location = (SV **) &GvHV(dstr);
3248 import_flag = GVf_IMPORTED_HV;
3251 location = (SV **) &GvAV(dstr);
3252 import_flag = GVf_IMPORTED_AV;
3255 location = (SV **) &GvIOp(dstr);
3258 location = (SV **) &GvFORM(dstr);
3260 location = &GvSV(dstr);
3261 import_flag = GVf_IMPORTED_SV;
3264 if (stype == SVt_PVCV) {
3265 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3266 SvREFCNT_dec(GvCV(dstr));
3268 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3269 PL_sub_generation++;
3272 SAVEGENERICSV(*location);
3276 if (stype == SVt_PVCV && *location != sref) {
3277 CV* const cv = (CV*)*location;
3279 if (!GvCVGEN((GV*)dstr) &&
3280 (CvROOT(cv) || CvXSUB(cv)))
3282 /* Redefining a sub - warning is mandatory if
3283 it was a const and its value changed. */
3284 if (CvCONST(cv) && CvCONST((CV*)sref)
3285 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3287 /* They are 2 constant subroutines generated from
3288 the same constant. This probably means that
3289 they are really the "same" proxy subroutine
3290 instantiated in 2 places. Most likely this is
3291 when a constant is exported twice. Don't warn.
3294 else if (ckWARN(WARN_REDEFINE)
3296 && (!CvCONST((CV*)sref)
3297 || sv_cmp(cv_const_sv(cv),
3298 cv_const_sv((CV*)sref))))) {
3299 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3301 ? "Constant subroutine %s::%s redefined"
3302 : "Subroutine %s::%s redefined",
3303 HvNAME_get(GvSTASH((GV*)dstr)),
3304 GvENAME((GV*)dstr));
3308 cv_ckproto(cv, (GV*)dstr,
3309 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3311 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3312 GvASSUMECV_on(dstr);
3313 PL_sub_generation++;
3316 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3317 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3318 GvFLAGS(dstr) |= import_flag;
3323 if (SvTAINTED(sstr))
3329 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3332 register U32 sflags;
3338 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3340 sstr = &PL_sv_undef;
3341 stype = SvTYPE(sstr);
3342 dtype = SvTYPE(dstr);
3347 /* need to nuke the magic */
3349 SvRMAGICAL_off(dstr);
3352 /* There's a lot of redundancy below but we're going for speed here */
3357 if (dtype != SVt_PVGV) {
3358 (void)SvOK_off(dstr);
3366 sv_upgrade(dstr, SVt_IV);
3371 sv_upgrade(dstr, SVt_PVIV);
3374 (void)SvIOK_only(dstr);
3375 SvIV_set(dstr, SvIVX(sstr));
3378 /* SvTAINTED can only be true if the SV has taint magic, which in
3379 turn means that the SV type is PVMG (or greater). This is the
3380 case statement for SVt_IV, so this cannot be true (whatever gcov
3382 assert(!SvTAINTED(sstr));
3392 sv_upgrade(dstr, SVt_NV);
3397 sv_upgrade(dstr, SVt_PVNV);
3400 SvNV_set(dstr, SvNVX(sstr));
3401 (void)SvNOK_only(dstr);
3402 /* SvTAINTED can only be true if the SV has taint magic, which in
3403 turn means that the SV type is PVMG (or greater). This is the
3404 case statement for SVt_NV, so this cannot be true (whatever gcov
3406 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_RV);
3416 #ifdef PERL_OLD_COPY_ON_WRITE
3417 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3418 if (dtype < SVt_PVIV)
3419 sv_upgrade(dstr, SVt_PVIV);
3426 sv_upgrade(dstr, SVt_PV);
3429 if (dtype < SVt_PVIV)
3430 sv_upgrade(dstr, SVt_PVIV);
3433 if (dtype < SVt_PVNV)
3434 sv_upgrade(dstr, SVt_PVNV);
3438 const char * const type = sv_reftype(sstr,0);
3440 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3442 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3447 if (dtype <= SVt_PVGV) {
3448 glob_assign_glob(dstr, sstr, dtype);
3456 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3458 if ((int)SvTYPE(sstr) != stype) {
3459 stype = SvTYPE(sstr);
3460 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3461 glob_assign_glob(dstr, sstr, dtype);
3466 if (stype == SVt_PVLV)
3467 SvUPGRADE(dstr, SVt_PVNV);
3469 SvUPGRADE(dstr, (U32)stype);
3472 /* dstr may have been upgraded. */
3473 dtype = SvTYPE(dstr);
3474 sflags = SvFLAGS(sstr);
3476 if (sflags & SVf_ROK) {
3477 if (dtype == SVt_PVGV &&
3478 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3481 if (GvIMPORTED(dstr) != GVf_IMPORTED
3482 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3484 GvIMPORTED_on(dstr);
3489 glob_assign_glob(dstr, sstr, dtype);
3493 if (dtype >= SVt_PV) {
3494 if (dtype == SVt_PVGV) {
3495 glob_assign_ref(dstr, sstr);
3498 if (SvPVX_const(dstr)) {
3504 (void)SvOK_off(dstr);
3505 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3506 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3507 assert(!(sflags & SVp_NOK));
3508 assert(!(sflags & SVp_IOK));
3509 assert(!(sflags & SVf_NOK));
3510 assert(!(sflags & SVf_IOK));
3512 else if (dtype == SVt_PVGV) {
3513 if (!(sflags & SVf_OK)) {
3514 if (ckWARN(WARN_MISC))
3515 Perl_warner(aTHX_ packWARN(WARN_MISC),
3516 "Undefined value assigned to typeglob");
3519 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3520 if (dstr != (SV*)gv) {
3523 GvGP(dstr) = gp_ref(GvGP(gv));
3527 else if (sflags & SVp_POK) {
3531 * Check to see if we can just swipe the string. If so, it's a
3532 * possible small lose on short strings, but a big win on long ones.
3533 * It might even be a win on short strings if SvPVX_const(dstr)
3534 * has to be allocated and SvPVX_const(sstr) has to be freed.
3537 /* Whichever path we take through the next code, we want this true,
3538 and doing it now facilitates the COW check. */
3539 (void)SvPOK_only(dstr);
3542 /* We're not already COW */
3543 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3544 #ifndef PERL_OLD_COPY_ON_WRITE
3545 /* or we are, but dstr isn't a suitable target. */
3546 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3551 (sflags & SVs_TEMP) && /* slated for free anyway? */
3552 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3553 (!(flags & SV_NOSTEAL)) &&
3554 /* and we're allowed to steal temps */
3555 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3556 SvLEN(sstr) && /* and really is a string */
3557 /* and won't be needed again, potentially */
3558 !(PL_op && PL_op->op_type == OP_AASSIGN))
3559 #ifdef PERL_OLD_COPY_ON_WRITE
3560 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3561 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3562 && SvTYPE(sstr) >= SVt_PVIV)
3565 /* Failed the swipe test, and it's not a shared hash key either.
3566 Have to copy the string. */
3567 STRLEN len = SvCUR(sstr);
3568 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3569 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3570 SvCUR_set(dstr, len);
3571 *SvEND(dstr) = '\0';
3573 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3575 /* Either it's a shared hash key, or it's suitable for
3576 copy-on-write or we can swipe the string. */
3578 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3582 #ifdef PERL_OLD_COPY_ON_WRITE
3584 /* I believe I should acquire a global SV mutex if
3585 it's a COW sv (not a shared hash key) to stop
3586 it going un copy-on-write.
3587 If the source SV has gone un copy on write between up there
3588 and down here, then (assert() that) it is of the correct
3589 form to make it copy on write again */
3590 if ((sflags & (SVf_FAKE | SVf_READONLY))
3591 != (SVf_FAKE | SVf_READONLY)) {
3592 SvREADONLY_on(sstr);
3594 /* Make the source SV into a loop of 1.
3595 (about to become 2) */
3596 SV_COW_NEXT_SV_SET(sstr, sstr);
3600 /* Initial code is common. */
3601 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3606 /* making another shared SV. */
3607 STRLEN cur = SvCUR(sstr);
3608 STRLEN len = SvLEN(sstr);
3609 #ifdef PERL_OLD_COPY_ON_WRITE
3611 assert (SvTYPE(dstr) >= SVt_PVIV);
3612 /* SvIsCOW_normal */
3613 /* splice us in between source and next-after-source. */
3614 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3615 SV_COW_NEXT_SV_SET(sstr, dstr);
3616 SvPV_set(dstr, SvPVX_mutable(sstr));
3620 /* SvIsCOW_shared_hash */
3621 DEBUG_C(PerlIO_printf(Perl_debug_log,
3622 "Copy on write: Sharing hash\n"));
3624 assert (SvTYPE(dstr) >= SVt_PV);
3626 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3628 SvLEN_set(dstr, len);
3629 SvCUR_set(dstr, cur);
3630 SvREADONLY_on(dstr);
3632 /* Relesase a global SV mutex. */
3635 { /* Passes the swipe test. */
3636 SvPV_set(dstr, SvPVX_mutable(sstr));
3637 SvLEN_set(dstr, SvLEN(sstr));
3638 SvCUR_set(dstr, SvCUR(sstr));
3641 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3642 SvPV_set(sstr, NULL);
3648 if (sflags & SVp_NOK) {
3649 SvNV_set(dstr, SvNVX(sstr));
3651 if (sflags & SVp_IOK) {
3652 SvRELEASE_IVX(dstr);
3653 SvIV_set(dstr, SvIVX(sstr));
3654 /* Must do this otherwise some other overloaded use of 0x80000000
3655 gets confused. I guess SVpbm_VALID */
3656 if (sflags & SVf_IVisUV)
3659 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3662 const MAGIC * const smg = SvVOK(sstr);
3664 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3665 smg->mg_ptr, smg->mg_len);
3666 SvRMAGICAL_on(dstr);
3670 else if (sflags & (SVp_IOK|SVp_NOK)) {
3671 (void)SvOK_off(dstr);
3672 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3674 if (sflags & SVp_IOK) {
3675 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3676 SvIV_set(dstr, SvIVX(sstr));
3678 if (sflags & SVp_NOK) {
3679 SvNV_set(dstr, SvNVX(sstr));
3683 if (isGV_with_GP(sstr)) {
3684 /* This stringification rule for globs is spread in 3 places.
3685 This feels bad. FIXME. */
3686 const U32 wasfake = sflags & SVf_FAKE;
3688 /* FAKE globs can get coerced, so need to turn this off
3689 temporarily if it is on. */
3691 gv_efullname3(dstr, (GV *)sstr, "*");
3692 SvFLAGS(sstr) |= wasfake;
3693 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3696 (void)SvOK_off(dstr);
3698 if (SvTAINTED(sstr))
3703 =for apidoc sv_setsv_mg
3705 Like C<sv_setsv>, but also handles 'set' magic.
3711 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3713 sv_setsv(dstr,sstr);
3717 #ifdef PERL_OLD_COPY_ON_WRITE
3719 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3721 STRLEN cur = SvCUR(sstr);
3722 STRLEN len = SvLEN(sstr);
3723 register char *new_pv;
3726 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3734 if (SvTHINKFIRST(dstr))
3735 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3736 else if (SvPVX_const(dstr))
3737 Safefree(SvPVX_const(dstr));
3741 SvUPGRADE(dstr, SVt_PVIV);
3743 assert (SvPOK(sstr));
3744 assert (SvPOKp(sstr));
3745 assert (!SvIOK(sstr));
3746 assert (!SvIOKp(sstr));
3747 assert (!SvNOK(sstr));
3748 assert (!SvNOKp(sstr));
3750 if (SvIsCOW(sstr)) {
3752 if (SvLEN(sstr) == 0) {
3753 /* source is a COW shared hash key. */
3754 DEBUG_C(PerlIO_printf(Perl_debug_log,
3755 "Fast copy on write: Sharing hash\n"));
3756 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3759 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3761 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3762 SvUPGRADE(sstr, SVt_PVIV);
3763 SvREADONLY_on(sstr);
3765 DEBUG_C(PerlIO_printf(Perl_debug_log,
3766 "Fast copy on write: Converting sstr to COW\n"));
3767 SV_COW_NEXT_SV_SET(dstr, sstr);
3769 SV_COW_NEXT_SV_SET(sstr, dstr);
3770 new_pv = SvPVX_mutable(sstr);
3773 SvPV_set(dstr, new_pv);
3774 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3777 SvLEN_set(dstr, len);
3778 SvCUR_set(dstr, cur);
3787 =for apidoc sv_setpvn
3789 Copies a string into an SV. The C<len> parameter indicates the number of
3790 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3791 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3797 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3800 register char *dptr;
3802 SV_CHECK_THINKFIRST_COW_DROP(sv);
3808 /* len is STRLEN which is unsigned, need to copy to signed */
3811 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3813 SvUPGRADE(sv, SVt_PV);
3815 dptr = SvGROW(sv, len + 1);
3816 Move(ptr,dptr,len,char);
3819 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3824 =for apidoc sv_setpvn_mg
3826 Like C<sv_setpvn>, but also handles 'set' magic.
3832 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3834 sv_setpvn(sv,ptr,len);
3839 =for apidoc sv_setpv
3841 Copies a string into an SV. The string must be null-terminated. Does not
3842 handle 'set' magic. See C<sv_setpv_mg>.
3848 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3851 register STRLEN len;
3853 SV_CHECK_THINKFIRST_COW_DROP(sv);
3859 SvUPGRADE(sv, SVt_PV);
3861 SvGROW(sv, len + 1);
3862 Move(ptr,SvPVX(sv),len+1,char);
3864 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3869 =for apidoc sv_setpv_mg
3871 Like C<sv_setpv>, but also handles 'set' magic.
3877 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3884 =for apidoc sv_usepvn
3886 Tells an SV to use C<ptr> to find its string value. Normally the string is
3887 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3888 The C<ptr> should point to memory that was allocated by C<malloc>. The
3889 string length, C<len>, must be supplied. This function will realloc the
3890 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3891 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
3892 See C<sv_usepvn_mg>.
3898 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3902 SV_CHECK_THINKFIRST_COW_DROP(sv);
3903 SvUPGRADE(sv, SVt_PV);
3908 if (SvPVX_const(sv))
3911 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3912 ptr = saferealloc (ptr, allocate);
3915 SvLEN_set(sv, allocate);
3917 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3922 =for apidoc sv_usepvn_mg
3924 Like C<sv_usepvn>, but also handles 'set' magic.
3930 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3932 sv_usepvn(sv,ptr,len);
3936 #ifdef PERL_OLD_COPY_ON_WRITE
3937 /* Need to do this *after* making the SV normal, as we need the buffer
3938 pointer to remain valid until after we've copied it. If we let go too early,
3939 another thread could invalidate it by unsharing last of the same hash key
3940 (which it can do by means other than releasing copy-on-write Svs)
3941 or by changing the other copy-on-write SVs in the loop. */
3943 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3945 if (len) { /* this SV was SvIsCOW_normal(sv) */
3946 /* we need to find the SV pointing to us. */
3947 SV *current = SV_COW_NEXT_SV(after);
3949 if (current == sv) {
3950 /* The SV we point to points back to us (there were only two of us
3952 Hence other SV is no longer copy on write either. */
3954 SvREADONLY_off(after);
3956 /* We need to follow the pointers around the loop. */
3958 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3961 /* don't loop forever if the structure is bust, and we have
3962 a pointer into a closed loop. */
3963 assert (current != after);
3964 assert (SvPVX_const(current) == pvx);
3966 /* Make the SV before us point to the SV after us. */
3967 SV_COW_NEXT_SV_SET(current, after);
3970 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3975 Perl_sv_release_IVX(pTHX_ register SV *sv)
3978 sv_force_normal_flags(sv, 0);
3984 =for apidoc sv_force_normal_flags
3986 Undo various types of fakery on an SV: if the PV is a shared string, make
3987 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3988 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3989 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3990 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3991 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3992 set to some other value.) In addition, the C<flags> parameter gets passed to
3993 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3994 with flags set to 0.
4000 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4003 #ifdef PERL_OLD_COPY_ON_WRITE
4004 if (SvREADONLY(sv)) {
4005 /* At this point I believe I should acquire a global SV mutex. */
4007 const char * const pvx = SvPVX_const(sv);
4008 const STRLEN len = SvLEN(sv);
4009 const STRLEN cur = SvCUR(sv);
4010 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4012 PerlIO_printf(Perl_debug_log,
4013 "Copy on write: Force normal %ld\n",
4019 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4022 if (flags & SV_COW_DROP_PV) {
4023 /* OK, so we don't need to copy our buffer. */
4026 SvGROW(sv, cur + 1);
4027 Move(pvx,SvPVX(sv),cur,char);
4031 sv_release_COW(sv, pvx, len, next);
4036 else if (IN_PERL_RUNTIME)
4037 Perl_croak(aTHX_ PL_no_modify);
4038 /* At this point I believe that I can drop the global SV mutex. */
4041 if (SvREADONLY(sv)) {
4043 const char * const pvx = SvPVX_const(sv);
4044 const STRLEN len = SvCUR(sv);
4049 SvGROW(sv, len + 1);
4050 Move(pvx,SvPVX(sv),len,char);
4052 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4054 else if (IN_PERL_RUNTIME)
4055 Perl_croak(aTHX_ PL_no_modify);
4059 sv_unref_flags(sv, flags);
4060 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4067 Efficient removal of characters from the beginning of the string buffer.
4068 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4069 the string buffer. The C<ptr> becomes the first character of the adjusted
4070 string. Uses the "OOK hack".
4071 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4072 refer to the same chunk of data.
4078 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4080 register STRLEN delta;
4081 if (!ptr || !SvPOKp(sv))
4083 delta = ptr - SvPVX_const(sv);
4084 SV_CHECK_THINKFIRST(sv);
4085 if (SvTYPE(sv) < SVt_PVIV)
4086 sv_upgrade(sv,SVt_PVIV);
4089 if (!SvLEN(sv)) { /* make copy of shared string */
4090 const char *pvx = SvPVX_const(sv);
4091 const STRLEN len = SvCUR(sv);
4092 SvGROW(sv, len + 1);
4093 Move(pvx,SvPVX(sv),len,char);
4097 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4098 and we do that anyway inside the SvNIOK_off
4100 SvFLAGS(sv) |= SVf_OOK;
4103 SvLEN_set(sv, SvLEN(sv) - delta);
4104 SvCUR_set(sv, SvCUR(sv) - delta);
4105 SvPV_set(sv, SvPVX(sv) + delta);
4106 SvIV_set(sv, SvIVX(sv) + delta);
4110 =for apidoc sv_catpvn
4112 Concatenates the string onto the end of the string which is in the SV. The
4113 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4114 status set, then the bytes appended should be valid UTF-8.
4115 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4117 =for apidoc sv_catpvn_flags
4119 Concatenates the string onto the end of the string which is in the SV. The
4120 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4121 status set, then the bytes appended should be valid UTF-8.
4122 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4123 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4124 in terms of this function.
4130 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4134 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4136 SvGROW(dsv, dlen + slen + 1);
4138 sstr = SvPVX_const(dsv);
4139 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4140 SvCUR_set(dsv, SvCUR(dsv) + slen);
4142 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4144 if (flags & SV_SMAGIC)
4149 =for apidoc sv_catsv
4151 Concatenates the string from SV C<ssv> onto the end of the string in
4152 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4153 not 'set' magic. See C<sv_catsv_mg>.
4155 =for apidoc sv_catsv_flags
4157 Concatenates the string from SV C<ssv> onto the end of the string in
4158 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4159 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4160 and C<sv_catsv_nomg> are implemented in terms of this function.
4165 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4170 const char *spv = SvPV_const(ssv, slen);
4172 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4173 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4174 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4175 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4176 dsv->sv_flags doesn't have that bit set.
4177 Andy Dougherty 12 Oct 2001
4179 const I32 sutf8 = DO_UTF8(ssv);
4182 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4184 dutf8 = DO_UTF8(dsv);
4186 if (dutf8 != sutf8) {
4188 /* Not modifying source SV, so taking a temporary copy. */
4189 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4191 sv_utf8_upgrade(csv);
4192 spv = SvPV_const(csv, slen);
4195 sv_utf8_upgrade_nomg(dsv);
4197 sv_catpvn_nomg(dsv, spv, slen);
4200 if (flags & SV_SMAGIC)
4205 =for apidoc sv_catpv
4207 Concatenates the string onto the end of the string which is in the SV.
4208 If the SV has the UTF-8 status set, then the bytes appended should be
4209 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4214 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4217 register STRLEN len;
4223 junk = SvPV_force(sv, tlen);
4225 SvGROW(sv, tlen + len + 1);
4227 ptr = SvPVX_const(sv);
4228 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4229 SvCUR_set(sv, SvCUR(sv) + len);
4230 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4235 =for apidoc sv_catpv_mg
4237 Like C<sv_catpv>, but also handles 'set' magic.
4243 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4252 Creates a new SV. A non-zero C<len> parameter indicates the number of
4253 bytes of preallocated string space the SV should have. An extra byte for a
4254 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4255 space is allocated.) The reference count for the new SV is set to 1.
4257 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4258 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4259 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4260 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4261 modules supporting older perls.
4267 Perl_newSV(pTHX_ STRLEN len)
4274 sv_upgrade(sv, SVt_PV);
4275 SvGROW(sv, len + 1);
4280 =for apidoc sv_magicext
4282 Adds magic to an SV, upgrading it if necessary. Applies the
4283 supplied vtable and returns a pointer to the magic added.
4285 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4286 In particular, you can add magic to SvREADONLY SVs, and add more than
4287 one instance of the same 'how'.
4289 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4290 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4291 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4292 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4294 (This is now used as a subroutine by C<sv_magic>.)
4299 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4300 const char* name, I32 namlen)
4305 if (SvTYPE(sv) < SVt_PVMG) {
4306 SvUPGRADE(sv, SVt_PVMG);
4308 Newxz(mg, 1, MAGIC);
4309 mg->mg_moremagic = SvMAGIC(sv);
4310 SvMAGIC_set(sv, mg);
4312 /* Sometimes a magic contains a reference loop, where the sv and
4313 object refer to each other. To prevent a reference loop that
4314 would prevent such objects being freed, we look for such loops
4315 and if we find one we avoid incrementing the object refcount.
4317 Note we cannot do this to avoid self-tie loops as intervening RV must
4318 have its REFCNT incremented to keep it in existence.
4321 if (!obj || obj == sv ||
4322 how == PERL_MAGIC_arylen ||
4323 how == PERL_MAGIC_qr ||
4324 how == PERL_MAGIC_symtab ||
4325 (SvTYPE(obj) == SVt_PVGV &&
4326 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4327 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4328 GvFORM(obj) == (CV*)sv)))
4333 mg->mg_obj = SvREFCNT_inc_simple(obj);
4334 mg->mg_flags |= MGf_REFCOUNTED;
4337 /* Normal self-ties simply pass a null object, and instead of
4338 using mg_obj directly, use the SvTIED_obj macro to produce a
4339 new RV as needed. For glob "self-ties", we are tieing the PVIO
4340 with an RV obj pointing to the glob containing the PVIO. In
4341 this case, to avoid a reference loop, we need to weaken the
4345 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4346 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4352 mg->mg_len = namlen;
4355 mg->mg_ptr = savepvn(name, namlen);
4356 else if (namlen == HEf_SVKEY)
4357 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4359 mg->mg_ptr = (char *) name;
4361 mg->mg_virtual = vtable;
4365 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4370 =for apidoc sv_magic
4372 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4373 then adds a new magic item of type C<how> to the head of the magic list.
4375 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4376 handling of the C<name> and C<namlen> arguments.
4378 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4379 to add more than one instance of the same 'how'.
4385 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4391 #ifdef PERL_OLD_COPY_ON_WRITE
4393 sv_force_normal_flags(sv, 0);
4395 if (SvREADONLY(sv)) {
4397 /* its okay to attach magic to shared strings; the subsequent
4398 * upgrade to PVMG will unshare the string */
4399 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4402 && how != PERL_MAGIC_regex_global
4403 && how != PERL_MAGIC_bm
4404 && how != PERL_MAGIC_fm
4405 && how != PERL_MAGIC_sv
4406 && how != PERL_MAGIC_backref
4409 Perl_croak(aTHX_ PL_no_modify);
4412 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4413 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4414 /* sv_magic() refuses to add a magic of the same 'how' as an
4417 if (how == PERL_MAGIC_taint) {
4419 /* Any scalar which already had taint magic on which someone
4420 (erroneously?) did SvIOK_on() or similar will now be
4421 incorrectly sporting public "OK" flags. */
4422 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4430 vtable = &PL_vtbl_sv;
4432 case PERL_MAGIC_overload:
4433 vtable = &PL_vtbl_amagic;
4435 case PERL_MAGIC_overload_elem:
4436 vtable = &PL_vtbl_amagicelem;
4438 case PERL_MAGIC_overload_table:
4439 vtable = &PL_vtbl_ovrld;
4442 vtable = &PL_vtbl_bm;
4444 case PERL_MAGIC_regdata:
4445 vtable = &PL_vtbl_regdata;
4447 case PERL_MAGIC_regdatum:
4448 vtable = &PL_vtbl_regdatum;
4450 case PERL_MAGIC_env:
4451 vtable = &PL_vtbl_env;
4454 vtable = &PL_vtbl_fm;
4456 case PERL_MAGIC_envelem:
4457 vtable = &PL_vtbl_envelem;
4459 case PERL_MAGIC_regex_global:
4460 vtable = &PL_vtbl_mglob;
4462 case PERL_MAGIC_isa:
4463 vtable = &PL_vtbl_isa;
4465 case PERL_MAGIC_isaelem:
4466 vtable = &PL_vtbl_isaelem;
4468 case PERL_MAGIC_nkeys:
4469 vtable = &PL_vtbl_nkeys;
4471 case PERL_MAGIC_dbfile:
4474 case PERL_MAGIC_dbline:
4475 vtable = &PL_vtbl_dbline;
4477 #ifdef USE_LOCALE_COLLATE
4478 case PERL_MAGIC_collxfrm:
4479 vtable = &PL_vtbl_collxfrm;
4481 #endif /* USE_LOCALE_COLLATE */
4482 case PERL_MAGIC_tied:
4483 vtable = &PL_vtbl_pack;
4485 case PERL_MAGIC_tiedelem:
4486 case PERL_MAGIC_tiedscalar:
4487 vtable = &PL_vtbl_packelem;
4490 vtable = &PL_vtbl_regexp;
4492 case PERL_MAGIC_hints:
4493 /* As this vtable is all NULL, we can reuse it. */
4494 case PERL_MAGIC_sig:
4495 vtable = &PL_vtbl_sig;
4497 case PERL_MAGIC_sigelem:
4498 vtable = &PL_vtbl_sigelem;
4500 case PERL_MAGIC_taint:
4501 vtable = &PL_vtbl_taint;
4503 case PERL_MAGIC_uvar:
4504 vtable = &PL_vtbl_uvar;
4506 case PERL_MAGIC_vec:
4507 vtable = &PL_vtbl_vec;
4509 case PERL_MAGIC_arylen_p:
4510 case PERL_MAGIC_rhash:
4511 case PERL_MAGIC_symtab:
4512 case PERL_MAGIC_vstring:
4515 case PERL_MAGIC_utf8:
4516 vtable = &PL_vtbl_utf8;
4518 case PERL_MAGIC_substr:
4519 vtable = &PL_vtbl_substr;
4521 case PERL_MAGIC_defelem:
4522 vtable = &PL_vtbl_defelem;
4524 case PERL_MAGIC_arylen:
4525 vtable = &PL_vtbl_arylen;
4527 case PERL_MAGIC_pos:
4528 vtable = &PL_vtbl_pos;
4530 case PERL_MAGIC_backref:
4531 vtable = &PL_vtbl_backref;
4533 case PERL_MAGIC_hintselem:
4534 vtable = &PL_vtbl_hintselem;
4536 case PERL_MAGIC_ext:
4537 /* Reserved for use by extensions not perl internals. */
4538 /* Useful for attaching extension internal data to perl vars. */
4539 /* Note that multiple extensions may clash if magical scalars */
4540 /* etc holding private data from one are passed to another. */
4544 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4547 /* Rest of work is done else where */
4548 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4551 case PERL_MAGIC_taint:
4554 case PERL_MAGIC_ext:
4555 case PERL_MAGIC_dbfile:
4562 =for apidoc sv_unmagic
4564 Removes all magic of type C<type> from an SV.
4570 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4574 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4576 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4577 for (mg = *mgp; mg; mg = *mgp) {
4578 if (mg->mg_type == type) {
4579 const MGVTBL* const vtbl = mg->mg_virtual;
4580 *mgp = mg->mg_moremagic;
4581 if (vtbl && vtbl->svt_free)
4582 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4583 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4585 Safefree(mg->mg_ptr);
4586 else if (mg->mg_len == HEf_SVKEY)
4587 SvREFCNT_dec((SV*)mg->mg_ptr);
4588 else if (mg->mg_type == PERL_MAGIC_utf8)
4589 Safefree(mg->mg_ptr);
4591 if (mg->mg_flags & MGf_REFCOUNTED)
4592 SvREFCNT_dec(mg->mg_obj);
4596 mgp = &mg->mg_moremagic;
4600 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4601 SvMAGIC_set(sv, NULL);
4608 =for apidoc sv_rvweaken
4610 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4611 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4612 push a back-reference to this RV onto the array of backreferences
4613 associated with that magic.
4619 Perl_sv_rvweaken(pTHX_ SV *sv)
4622 if (!SvOK(sv)) /* let undefs pass */
4625 Perl_croak(aTHX_ "Can't weaken a nonreference");
4626 else if (SvWEAKREF(sv)) {
4627 if (ckWARN(WARN_MISC))
4628 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4632 Perl_sv_add_backref(aTHX_ tsv, sv);
4638 /* Give tsv backref magic if it hasn't already got it, then push a
4639 * back-reference to sv onto the array associated with the backref magic.
4643 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4648 if (SvTYPE(tsv) == SVt_PVHV) {
4649 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4653 /* There is no AV in the offical place - try a fixup. */
4654 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4657 /* Aha. They've got it stowed in magic. Bring it back. */
4658 av = (AV*)mg->mg_obj;
4659 /* Stop mg_free decreasing the refernce count. */
4661 /* Stop mg_free even calling the destructor, given that
4662 there's no AV to free up. */
4664 sv_unmagic(tsv, PERL_MAGIC_backref);
4668 SvREFCNT_inc_simple_void(av);
4673 const MAGIC *const mg
4674 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4676 av = (AV*)mg->mg_obj;
4680 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4681 /* av now has a refcnt of 2, which avoids it getting freed
4682 * before us during global cleanup. The extra ref is removed
4683 * by magic_killbackrefs() when tsv is being freed */
4686 if (AvFILLp(av) >= AvMAX(av)) {
4687 av_extend(av, AvFILLp(av)+1);
4689 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4692 /* delete a back-reference to ourselves from the backref magic associated
4693 * with the SV we point to.
4697 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4704 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4705 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4706 /* We mustn't attempt to "fix up" the hash here by moving the
4707 backreference array back to the hv_aux structure, as that is stored
4708 in the main HvARRAY(), and hfreentries assumes that no-one
4709 reallocates HvARRAY() while it is running. */
4712 const MAGIC *const mg
4713 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4715 av = (AV *)mg->mg_obj;
4718 if (PL_in_clean_all)
4720 Perl_croak(aTHX_ "panic: del_backref");
4727 /* We shouldn't be in here more than once, but for paranoia reasons lets
4729 for (i = AvFILLp(av); i >= 0; i--) {
4731 const SSize_t fill = AvFILLp(av);
4733 /* We weren't the last entry.
4734 An unordered list has this property that you can take the
4735 last element off the end to fill the hole, and it's still
4736 an unordered list :-)
4741 AvFILLp(av) = fill - 1;
4747 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4749 SV **svp = AvARRAY(av);
4751 PERL_UNUSED_ARG(sv);
4753 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4754 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4755 if (svp && !SvIS_FREED(av)) {
4756 SV *const *const last = svp + AvFILLp(av);
4758 while (svp <= last) {
4760 SV *const referrer = *svp;
4761 if (SvWEAKREF(referrer)) {
4762 /* XXX Should we check that it hasn't changed? */
4763 SvRV_set(referrer, 0);
4765 SvWEAKREF_off(referrer);
4766 } else if (SvTYPE(referrer) == SVt_PVGV ||
4767 SvTYPE(referrer) == SVt_PVLV) {
4768 /* You lookin' at me? */
4769 assert(GvSTASH(referrer));
4770 assert(GvSTASH(referrer) == (HV*)sv);
4771 GvSTASH(referrer) = 0;
4774 "panic: magic_killbackrefs (flags=%"UVxf")",
4775 (UV)SvFLAGS(referrer));
4783 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4788 =for apidoc sv_insert
4790 Inserts a string at the specified offset/length within the SV. Similar to
4791 the Perl substr() function.
4797 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4802 register char *midend;
4803 register char *bigend;
4809 Perl_croak(aTHX_ "Can't modify non-existent substring");
4810 SvPV_force(bigstr, curlen);
4811 (void)SvPOK_only_UTF8(bigstr);
4812 if (offset + len > curlen) {
4813 SvGROW(bigstr, offset+len+1);
4814 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4815 SvCUR_set(bigstr, offset+len);
4819 i = littlelen - len;
4820 if (i > 0) { /* string might grow */
4821 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4822 mid = big + offset + len;
4823 midend = bigend = big + SvCUR(bigstr);
4826 while (midend > mid) /* shove everything down */
4827 *--bigend = *--midend;
4828 Move(little,big+offset,littlelen,char);
4829 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4834 Move(little,SvPVX(bigstr)+offset,len,char);
4839 big = SvPVX(bigstr);
4842 bigend = big + SvCUR(bigstr);
4844 if (midend > bigend)
4845 Perl_croak(aTHX_ "panic: sv_insert");
4847 if (mid - big > bigend - midend) { /* faster to shorten from end */
4849 Move(little, mid, littlelen,char);
4852 i = bigend - midend;
4854 Move(midend, mid, i,char);
4858 SvCUR_set(bigstr, mid - big);
4860 else if ((i = mid - big)) { /* faster from front */
4861 midend -= littlelen;
4863 sv_chop(bigstr,midend-i);
4868 Move(little, mid, littlelen,char);
4870 else if (littlelen) {
4871 midend -= littlelen;
4872 sv_chop(bigstr,midend);
4873 Move(little,midend,littlelen,char);
4876 sv_chop(bigstr,midend);
4882 =for apidoc sv_replace
4884 Make the first argument a copy of the second, then delete the original.
4885 The target SV physically takes over ownership of the body of the source SV
4886 and inherits its flags; however, the target keeps any magic it owns,
4887 and any magic in the source is discarded.
4888 Note that this is a rather specialist SV copying operation; most of the
4889 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4895 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4898 const U32 refcnt = SvREFCNT(sv);
4899 SV_CHECK_THINKFIRST_COW_DROP(sv);
4900 if (SvREFCNT(nsv) != 1) {
4901 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4902 UVuf " != 1)", (UV) SvREFCNT(nsv));
4904 if (SvMAGICAL(sv)) {
4908 sv_upgrade(nsv, SVt_PVMG);
4909 SvMAGIC_set(nsv, SvMAGIC(sv));
4910 SvFLAGS(nsv) |= SvMAGICAL(sv);
4912 SvMAGIC_set(sv, NULL);
4916 assert(!SvREFCNT(sv));
4917 #ifdef DEBUG_LEAKING_SCALARS
4918 sv->sv_flags = nsv->sv_flags;
4919 sv->sv_any = nsv->sv_any;
4920 sv->sv_refcnt = nsv->sv_refcnt;
4921 sv->sv_u = nsv->sv_u;
4923 StructCopy(nsv,sv,SV);
4925 /* Currently could join these into one piece of pointer arithmetic, but
4926 it would be unclear. */
4927 if(SvTYPE(sv) == SVt_IV)
4929 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4930 else if (SvTYPE(sv) == SVt_RV) {
4931 SvANY(sv) = &sv->sv_u.svu_rv;
4935 #ifdef PERL_OLD_COPY_ON_WRITE
4936 if (SvIsCOW_normal(nsv)) {
4937 /* We need to follow the pointers around the loop to make the
4938 previous SV point to sv, rather than nsv. */
4941 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4944 assert(SvPVX_const(current) == SvPVX_const(nsv));
4946 /* Make the SV before us point to the SV after us. */
4948 PerlIO_printf(Perl_debug_log, "previous is\n");
4950 PerlIO_printf(Perl_debug_log,
4951 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4952 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4954 SV_COW_NEXT_SV_SET(current, sv);
4957 SvREFCNT(sv) = refcnt;
4958 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4964 =for apidoc sv_clear
4966 Clear an SV: call any destructors, free up any memory used by the body,
4967 and free the body itself. The SV's head is I<not> freed, although
4968 its type is set to all 1's so that it won't inadvertently be assumed
4969 to be live during global destruction etc.
4970 This function should only be called when REFCNT is zero. Most of the time
4971 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4978 Perl_sv_clear(pTHX_ register SV *sv)
4981 const U32 type = SvTYPE(sv);
4982 const struct body_details *const sv_type_details
4983 = bodies_by_type + type;
4986 assert(SvREFCNT(sv) == 0);
4988 if (type <= SVt_IV) {
4989 /* See the comment in sv.h about the collusion between this early
4990 return and the overloading of the NULL and IV slots in the size
4996 if (PL_defstash) { /* Still have a symbol table? */
5001 stash = SvSTASH(sv);
5002 destructor = StashHANDLER(stash,DESTROY);
5004 SV* const tmpref = newRV(sv);
5005 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5007 PUSHSTACKi(PERLSI_DESTROY);
5012 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5018 if(SvREFCNT(tmpref) < 2) {
5019 /* tmpref is not kept alive! */
5021 SvRV_set(tmpref, NULL);
5024 SvREFCNT_dec(tmpref);
5026 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5030 if (PL_in_clean_objs)
5031 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5033 /* DESTROY gave object new lease on life */
5039 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5040 SvOBJECT_off(sv); /* Curse the object. */
5041 if (type != SVt_PVIO)
5042 --PL_sv_objcount; /* XXX Might want something more general */
5045 if (type >= SVt_PVMG) {
5047 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5048 (ourstash = OURSTASH(sv))) {
5049 SvREFCNT_dec(ourstash);
5050 } else if (SvMAGIC(sv))
5052 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5053 SvREFCNT_dec(SvSTASH(sv));
5058 IoIFP(sv) != PerlIO_stdin() &&
5059 IoIFP(sv) != PerlIO_stdout() &&
5060 IoIFP(sv) != PerlIO_stderr())
5062 io_close((IO*)sv, FALSE);
5064 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5065 PerlDir_close(IoDIRP(sv));
5066 IoDIRP(sv) = (DIR*)NULL;
5067 Safefree(IoTOP_NAME(sv));
5068 Safefree(IoFMT_NAME(sv));
5069 Safefree(IoBOTTOM_NAME(sv));
5078 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5085 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5086 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5087 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5088 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5090 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5091 SvREFCNT_dec(LvTARG(sv));
5095 if (GvNAME_HEK(sv)) {
5096 unshare_hek(GvNAME_HEK(sv));
5098 /* If we're in a stash, we don't own a reference to it. However it does
5099 have a back reference to us, which needs to be cleared. */
5101 sv_del_backref((SV*)GvSTASH(sv), sv);
5106 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5108 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5109 /* Don't even bother with turning off the OOK flag. */
5114 SV * const target = SvRV(sv);
5116 sv_del_backref(target, sv);
5118 SvREFCNT_dec(target);
5120 #ifdef PERL_OLD_COPY_ON_WRITE
5121 else if (SvPVX_const(sv)) {
5123 /* I believe I need to grab the global SV mutex here and
5124 then recheck the COW status. */
5126 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5129 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5130 SV_COW_NEXT_SV(sv));
5131 /* And drop it here. */
5133 } else if (SvLEN(sv)) {
5134 Safefree(SvPVX_const(sv));
5138 else if (SvPVX_const(sv) && SvLEN(sv))
5139 Safefree(SvPVX_mutable(sv));
5140 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5141 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5150 SvFLAGS(sv) &= SVf_BREAK;
5151 SvFLAGS(sv) |= SVTYPEMASK;
5153 if (sv_type_details->arena) {
5154 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5155 &PL_body_roots[type]);
5157 else if (sv_type_details->body_size) {
5158 my_safefree(SvANY(sv));
5163 =for apidoc sv_newref
5165 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5172 Perl_sv_newref(pTHX_ SV *sv)
5174 PERL_UNUSED_CONTEXT;
5183 Decrement an SV's reference count, and if it drops to zero, call
5184 C<sv_clear> to invoke destructors and free up any memory used by
5185 the body; finally, deallocate the SV's head itself.
5186 Normally called via a wrapper macro C<SvREFCNT_dec>.
5192 Perl_sv_free(pTHX_ SV *sv)
5197 if (SvREFCNT(sv) == 0) {
5198 if (SvFLAGS(sv) & SVf_BREAK)
5199 /* this SV's refcnt has been artificially decremented to
5200 * trigger cleanup */
5202 if (PL_in_clean_all) /* All is fair */
5204 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5205 /* make sure SvREFCNT(sv)==0 happens very seldom */
5206 SvREFCNT(sv) = (~(U32)0)/2;
5209 if (ckWARN_d(WARN_INTERNAL)) {
5210 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5211 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5212 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5213 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5214 Perl_dump_sv_child(aTHX_ sv);
5219 if (--(SvREFCNT(sv)) > 0)
5221 Perl_sv_free2(aTHX_ sv);
5225 Perl_sv_free2(pTHX_ SV *sv)
5230 if (ckWARN_d(WARN_DEBUGGING))
5231 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5232 "Attempt to free temp prematurely: SV 0x%"UVxf
5233 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5237 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5238 /* make sure SvREFCNT(sv)==0 happens very seldom */
5239 SvREFCNT(sv) = (~(U32)0)/2;
5250 Returns the length of the string in the SV. Handles magic and type
5251 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5257 Perl_sv_len(pTHX_ register SV *sv)
5265 len = mg_length(sv);
5267 (void)SvPV_const(sv, len);
5272 =for apidoc sv_len_utf8
5274 Returns the number of characters in the string in an SV, counting wide
5275 UTF-8 bytes as a single character. Handles magic and type coercion.
5281 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5282 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5283 * (Note that the mg_len is not the length of the mg_ptr field.
5284 * This allows the cache to store the character length of the string without
5285 * needing to malloc() extra storage to attach to the mg_ptr.)
5290 Perl_sv_len_utf8(pTHX_ register SV *sv)
5296 return mg_length(sv);
5300 const U8 *s = (U8*)SvPV_const(sv, len);
5304 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5306 if (mg && mg->mg_len != -1) {
5308 if (PL_utf8cache < 0) {
5309 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5311 /* Need to turn the assertions off otherwise we may
5312 recurse infinitely while printing error messages.
5314 SAVEI8(PL_utf8cache);
5316 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5317 " real %"UVf" for %"SVf,
5318 (UV) ulen, (UV) real, sv);
5323 ulen = Perl_utf8_length(aTHX_ s, s + len);
5324 if (!SvREADONLY(sv)) {
5326 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5327 &PL_vtbl_utf8, 0, 0);
5335 return Perl_utf8_length(aTHX_ s, s + len);
5339 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5342 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5345 const U8 *s = start;
5347 PERL_UNUSED_CONTEXT;
5349 while (s < send && uoffset--)
5352 /* This is the existing behaviour. Possibly it should be a croak, as
5353 it's actually a bounds error */
5359 /* Given the length of the string in both bytes and UTF-8 characters, decide
5360 whether to walk forwards or backwards to find the byte corresponding to
5361 the passed in UTF-8 offset. */
5363 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5364 STRLEN uoffset, STRLEN uend)
5366 STRLEN backw = uend - uoffset;
5367 if (uoffset < 2 * backw) {
5368 /* The assumption is that going forwards is twice the speed of going
5369 forward (that's where the 2 * backw comes from).
5370 (The real figure of course depends on the UTF-8 data.) */
5371 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5376 while (UTF8_IS_CONTINUATION(*send))
5379 return send - start;
5382 /* For the string representation of the given scalar, find the byte
5383 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5384 give another position in the string, *before* the sought offset, which
5385 (which is always true, as 0, 0 is a valid pair of positions), which should
5386 help reduce the amount of linear searching.
5387 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5388 will be used to reduce the amount of linear searching. The cache will be
5389 created if necessary, and the found value offered to it for update. */
5391 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5392 const U8 *const send, STRLEN uoffset,
5393 STRLEN uoffset0, STRLEN boffset0) {
5394 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5397 assert (uoffset >= uoffset0);
5399 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5400 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5401 if ((*mgp)->mg_ptr) {
5402 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5403 if (cache[0] == uoffset) {
5404 /* An exact match. */
5407 if (cache[2] == uoffset) {
5408 /* An exact match. */
5412 if (cache[0] < uoffset) {
5413 /* The cache already knows part of the way. */
5414 if (cache[0] > uoffset0) {
5415 /* The cache knows more than the passed in pair */
5416 uoffset0 = cache[0];
5417 boffset0 = cache[1];
5419 if ((*mgp)->mg_len != -1) {
5420 /* And we know the end too. */
5422 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5424 (*mgp)->mg_len - uoffset0);
5427 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5428 send, uoffset - uoffset0);
5431 else if (cache[2] < uoffset) {
5432 /* We're between the two cache entries. */
5433 if (cache[2] > uoffset0) {
5434 /* and the cache knows more than the passed in pair */
5435 uoffset0 = cache[2];
5436 boffset0 = cache[3];
5440 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5443 cache[0] - uoffset0);
5446 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5449 cache[2] - uoffset0);
5453 else if ((*mgp)->mg_len != -1) {
5454 /* If we can take advantage of a passed in offset, do so. */
5455 /* In fact, offset0 is either 0, or less than offset, so don't
5456 need to worry about the other possibility. */
5458 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5460 (*mgp)->mg_len - uoffset0);
5465 if (!found || PL_utf8cache < 0) {
5466 const STRLEN real_boffset
5467 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5468 send, uoffset - uoffset0);
5470 if (found && PL_utf8cache < 0) {
5471 if (real_boffset != boffset) {
5472 /* Need to turn the assertions off otherwise we may recurse
5473 infinitely while printing error messages. */
5474 SAVEI8(PL_utf8cache);
5476 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5477 " real %"UVf" for %"SVf,
5478 (UV) boffset, (UV) real_boffset, sv);
5481 boffset = real_boffset;
5484 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5490 =for apidoc sv_pos_u2b
5492 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5493 the start of the string, to a count of the equivalent number of bytes; if
5494 lenp is non-zero, it does the same to lenp, but this time starting from
5495 the offset, rather than from the start of the string. Handles magic and
5502 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5503 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5504 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5509 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5517 start = (U8*)SvPV_const(sv, len);
5519 STRLEN uoffset = (STRLEN) *offsetp;
5520 const U8 * const send = start + len;
5522 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5525 *offsetp = (I32) boffset;
5528 /* Convert the relative offset to absolute. */
5529 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5531 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5532 uoffset, boffset) - boffset;
5546 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5547 byte length pairing. The (byte) length of the total SV is passed in too,
5548 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5549 may not have updated SvCUR, so we can't rely on reading it directly.
5551 The proffered utf8/byte length pairing isn't used if the cache already has
5552 two pairs, and swapping either for the proffered pair would increase the
5553 RMS of the intervals between known byte offsets.
5555 The cache itself consists of 4 STRLEN values
5556 0: larger UTF-8 offset
5557 1: corresponding byte offset
5558 2: smaller UTF-8 offset
5559 3: corresponding byte offset
5561 Unused cache pairs have the value 0, 0.
5562 Keeping the cache "backwards" means that the invariant of
5563 cache[0] >= cache[2] is maintained even with empty slots, which means that
5564 the code that uses it doesn't need to worry if only 1 entry has actually
5565 been set to non-zero. It also makes the "position beyond the end of the
5566 cache" logic much simpler, as the first slot is always the one to start
5570 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5578 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5580 (*mgp)->mg_len = -1;
5584 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5585 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5586 (*mgp)->mg_ptr = (char *) cache;
5590 if (PL_utf8cache < 0) {
5591 const U8 *start = (const U8 *) SvPVX_const(sv);
5592 const U8 *const end = start + byte;
5593 STRLEN realutf8 = 0;
5595 while (start < end) {
5596 start += UTF8SKIP(start);
5600 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5601 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5602 doesn't? I don't know whether this difference was introduced with
5603 the caching code in 5.8.1. */
5605 if (realutf8 != utf8) {
5606 /* Need to turn the assertions off otherwise we may recurse
5607 infinitely while printing error messages. */
5608 SAVEI8(PL_utf8cache);
5610 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5611 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5615 /* Cache is held with the later position first, to simplify the code
5616 that deals with unbounded ends. */
5618 ASSERT_UTF8_CACHE(cache);
5619 if (cache[1] == 0) {
5620 /* Cache is totally empty */
5623 } else if (cache[3] == 0) {
5624 if (byte > cache[1]) {
5625 /* New one is larger, so goes first. */
5626 cache[2] = cache[0];
5627 cache[3] = cache[1];
5635 #define THREEWAY_SQUARE(a,b,c,d) \
5636 ((float)((d) - (c))) * ((float)((d) - (c))) \
5637 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5638 + ((float)((b) - (a))) * ((float)((b) - (a)))
5640 /* Cache has 2 slots in use, and we know three potential pairs.
5641 Keep the two that give the lowest RMS distance. Do the
5642 calcualation in bytes simply because we always know the byte
5643 length. squareroot has the same ordering as the positive value,
5644 so don't bother with the actual square root. */
5645 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5646 if (byte > cache[1]) {
5647 /* New position is after the existing pair of pairs. */
5648 const float keep_earlier
5649 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5650 const float keep_later
5651 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5653 if (keep_later < keep_earlier) {
5654 if (keep_later < existing) {
5655 cache[2] = cache[0];
5656 cache[3] = cache[1];
5662 if (keep_earlier < existing) {
5668 else if (byte > cache[3]) {
5669 /* New position is between the existing pair of pairs. */
5670 const float keep_earlier
5671 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5672 const float keep_later
5673 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5675 if (keep_later < keep_earlier) {
5676 if (keep_later < existing) {
5682 if (keep_earlier < existing) {
5689 /* New position is before the existing pair of pairs. */
5690 const float keep_earlier
5691 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5692 const float keep_later
5693 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5695 if (keep_later < keep_earlier) {
5696 if (keep_later < existing) {
5702 if (keep_earlier < existing) {
5703 cache[0] = cache[2];
5704 cache[1] = cache[3];
5711 ASSERT_UTF8_CACHE(cache);
5714 /* If we don't know the character offset of the end of a region, our only
5715 option is to walk forwards to the target byte offset. */
5717 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5720 while (s < target) {
5723 /* Call utf8n_to_uvchr() to validate the sequence
5724 * (unless a simple non-UTF character) */
5725 if (!UTF8_IS_INVARIANT(*s))
5726 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5737 /* We already know all of the way, now we may be able to walk back. The same
5738 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5739 backward is half the speed of walking forward. */
5741 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5744 const STRLEN forw = target - s;
5745 STRLEN backw = end - target;
5747 if (forw < 2 * backw) {
5748 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5751 while (end > target) {
5753 while (UTF8_IS_CONTINUATION(*end)) {
5762 =for apidoc sv_pos_b2u
5764 Converts the value pointed to by offsetp from a count of bytes from the
5765 start of the string, to a count of the equivalent number of UTF-8 chars.
5766 Handles magic and type coercion.
5772 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5773 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5778 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5781 const STRLEN byte = *offsetp;
5782 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5791 s = (const U8*)SvPV_const(sv, blen);
5794 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5798 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5799 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5801 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5802 if (cache[1] == byte) {
5803 /* An exact match. */
5804 *offsetp = cache[0];
5807 if (cache[3] == byte) {
5808 /* An exact match. */
5809 *offsetp = cache[2];
5813 if (cache[1] < byte) {
5814 /* We already know part of the way. */
5815 if (mg->mg_len != -1) {
5816 /* Actually, we know the end too. */
5818 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5819 s + blen, mg->mg_len - cache[0]);
5822 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5825 else if (cache[3] < byte) {
5826 /* We're between the two cached pairs, so we do the calculation
5827 offset by the byte/utf-8 positions for the earlier pair,
5828 then add the utf-8 characters from the string start to
5830 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5831 s + cache[1], cache[0] - cache[2])
5835 else { /* cache[3] > byte */
5836 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5840 ASSERT_UTF8_CACHE(cache);
5842 } else if (mg->mg_len != -1) {
5843 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5847 if (!found || PL_utf8cache < 0) {
5848 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5850 if (found && PL_utf8cache < 0) {
5851 if (len != real_len) {
5852 /* Need to turn the assertions off otherwise we may recurse
5853 infinitely while printing error messages. */
5854 SAVEI8(PL_utf8cache);
5856 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5857 " real %"UVf" for %"SVf,
5858 (UV) len, (UV) real_len, sv);
5865 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5871 Returns a boolean indicating whether the strings in the two SVs are
5872 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5873 coerce its args to strings if necessary.
5879 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5888 SV* svrecode = NULL;
5895 pv1 = SvPV_const(sv1, cur1);
5902 pv2 = SvPV_const(sv2, cur2);
5904 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5905 /* Differing utf8ness.
5906 * Do not UTF8size the comparands as a side-effect. */
5909 svrecode = newSVpvn(pv2, cur2);
5910 sv_recode_to_utf8(svrecode, PL_encoding);
5911 pv2 = SvPV_const(svrecode, cur2);
5914 svrecode = newSVpvn(pv1, cur1);
5915 sv_recode_to_utf8(svrecode, PL_encoding);
5916 pv1 = SvPV_const(svrecode, cur1);
5918 /* Now both are in UTF-8. */
5920 SvREFCNT_dec(svrecode);
5925 bool is_utf8 = TRUE;
5928 /* sv1 is the UTF-8 one,
5929 * if is equal it must be downgrade-able */
5930 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5936 /* sv2 is the UTF-8 one,
5937 * if is equal it must be downgrade-able */
5938 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5944 /* Downgrade not possible - cannot be eq */
5952 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5954 SvREFCNT_dec(svrecode);
5964 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5965 string in C<sv1> is less than, equal to, or greater than the string in
5966 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5967 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5973 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5977 const char *pv1, *pv2;
5980 SV *svrecode = NULL;
5987 pv1 = SvPV_const(sv1, cur1);
5994 pv2 = SvPV_const(sv2, cur2);
5996 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5997 /* Differing utf8ness.
5998 * Do not UTF8size the comparands as a side-effect. */
6001 svrecode = newSVpvn(pv2, cur2);
6002 sv_recode_to_utf8(svrecode, PL_encoding);
6003 pv2 = SvPV_const(svrecode, cur2);
6006 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6011 svrecode = newSVpvn(pv1, cur1);
6012 sv_recode_to_utf8(svrecode, PL_encoding);
6013 pv1 = SvPV_const(svrecode, cur1);
6016 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6022 cmp = cur2 ? -1 : 0;
6026 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6029 cmp = retval < 0 ? -1 : 1;
6030 } else if (cur1 == cur2) {
6033 cmp = cur1 < cur2 ? -1 : 1;
6037 SvREFCNT_dec(svrecode);
6045 =for apidoc sv_cmp_locale
6047 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6048 'use bytes' aware, handles get magic, and will coerce its args to strings
6049 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6055 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6058 #ifdef USE_LOCALE_COLLATE
6064 if (PL_collation_standard)
6068 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6070 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6072 if (!pv1 || !len1) {
6083 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6086 return retval < 0 ? -1 : 1;
6089 * When the result of collation is equality, that doesn't mean
6090 * that there are no differences -- some locales exclude some
6091 * characters from consideration. So to avoid false equalities,
6092 * we use the raw string as a tiebreaker.
6098 #endif /* USE_LOCALE_COLLATE */
6100 return sv_cmp(sv1, sv2);
6104 #ifdef USE_LOCALE_COLLATE
6107 =for apidoc sv_collxfrm
6109 Add Collate Transform magic to an SV if it doesn't already have it.
6111 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6112 scalar data of the variable, but transformed to such a format that a normal
6113 memory comparison can be used to compare the data according to the locale
6120 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6125 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6126 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6132 Safefree(mg->mg_ptr);
6133 s = SvPV_const(sv, len);
6134 if ((xf = mem_collxfrm(s, len, &xlen))) {
6135 if (SvREADONLY(sv)) {
6138 return xf + sizeof(PL_collation_ix);
6141 #ifdef PERL_OLD_COPY_ON_WRITE
6143 sv_force_normal_flags(sv, 0);
6145 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6159 if (mg && mg->mg_ptr) {
6161 return mg->mg_ptr + sizeof(PL_collation_ix);
6169 #endif /* USE_LOCALE_COLLATE */
6174 Get a line from the filehandle and store it into the SV, optionally
6175 appending to the currently-stored string.
6181 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6186 register STDCHAR rslast;
6187 register STDCHAR *bp;
6193 if (SvTHINKFIRST(sv))
6194 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6195 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6197 However, perlbench says it's slower, because the existing swipe code
6198 is faster than copy on write.
6199 Swings and roundabouts. */
6200 SvUPGRADE(sv, SVt_PV);
6205 if (PerlIO_isutf8(fp)) {
6207 sv_utf8_upgrade_nomg(sv);
6208 sv_pos_u2b(sv,&append,0);
6210 } else if (SvUTF8(sv)) {
6211 SV * const tsv = newSV(0);
6212 sv_gets(tsv, fp, 0);
6213 sv_utf8_upgrade_nomg(tsv);
6214 SvCUR_set(sv,append);
6217 goto return_string_or_null;
6222 if (PerlIO_isutf8(fp))
6225 if (IN_PERL_COMPILETIME) {
6226 /* we always read code in line mode */
6230 else if (RsSNARF(PL_rs)) {
6231 /* If it is a regular disk file use size from stat() as estimate
6232 of amount we are going to read - may result in malloc-ing
6233 more memory than we realy need if layers bellow reduce
6234 size we read (e.g. CRLF or a gzip layer)
6237 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6238 const Off_t offset = PerlIO_tell(fp);
6239 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6240 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6246 else if (RsRECORD(PL_rs)) {
6250 /* Grab the size of the record we're getting */
6251 recsize = SvIV(SvRV(PL_rs));
6252 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6255 /* VMS wants read instead of fread, because fread doesn't respect */
6256 /* RMS record boundaries. This is not necessarily a good thing to be */
6257 /* doing, but we've got no other real choice - except avoid stdio
6258 as implementation - perhaps write a :vms layer ?
6260 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6262 bytesread = PerlIO_read(fp, buffer, recsize);
6266 SvCUR_set(sv, bytesread += append);
6267 buffer[bytesread] = '\0';
6268 goto return_string_or_null;
6270 else if (RsPARA(PL_rs)) {
6276 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6277 if (PerlIO_isutf8(fp)) {
6278 rsptr = SvPVutf8(PL_rs, rslen);
6281 if (SvUTF8(PL_rs)) {
6282 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6283 Perl_croak(aTHX_ "Wide character in $/");
6286 rsptr = SvPV_const(PL_rs, rslen);
6290 rslast = rslen ? rsptr[rslen - 1] : '\0';
6292 if (rspara) { /* have to do this both before and after */
6293 do { /* to make sure file boundaries work right */
6296 i = PerlIO_getc(fp);
6300 PerlIO_ungetc(fp,i);
6306 /* See if we know enough about I/O mechanism to cheat it ! */
6308 /* This used to be #ifdef test - it is made run-time test for ease
6309 of abstracting out stdio interface. One call should be cheap
6310 enough here - and may even be a macro allowing compile
6314 if (PerlIO_fast_gets(fp)) {
6317 * We're going to steal some values from the stdio struct
6318 * and put EVERYTHING in the innermost loop into registers.
6320 register STDCHAR *ptr;
6324 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6325 /* An ungetc()d char is handled separately from the regular
6326 * buffer, so we getc() it back out and stuff it in the buffer.
6328 i = PerlIO_getc(fp);
6329 if (i == EOF) return 0;
6330 *(--((*fp)->_ptr)) = (unsigned char) i;
6334 /* Here is some breathtakingly efficient cheating */
6336 cnt = PerlIO_get_cnt(fp); /* get count into register */
6337 /* make sure we have the room */
6338 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6339 /* Not room for all of it
6340 if we are looking for a separator and room for some
6342 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6343 /* just process what we have room for */
6344 shortbuffered = cnt - SvLEN(sv) + append + 1;
6345 cnt -= shortbuffered;
6349 /* remember that cnt can be negative */
6350 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6355 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6356 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6357 DEBUG_P(PerlIO_printf(Perl_debug_log,
6358 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6359 DEBUG_P(PerlIO_printf(Perl_debug_log,
6360 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6361 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6362 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6367 while (cnt > 0) { /* this | eat */
6369 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6370 goto thats_all_folks; /* screams | sed :-) */
6374 Copy(ptr, bp, cnt, char); /* this | eat */
6375 bp += cnt; /* screams | dust */
6376 ptr += cnt; /* louder | sed :-) */
6381 if (shortbuffered) { /* oh well, must extend */
6382 cnt = shortbuffered;
6384 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6386 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6387 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6391 DEBUG_P(PerlIO_printf(Perl_debug_log,
6392 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6393 PTR2UV(ptr),(long)cnt));
6394 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6396 DEBUG_P(PerlIO_printf(Perl_debug_log,
6397 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6398 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6399 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6401 /* This used to call 'filbuf' in stdio form, but as that behaves like
6402 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6403 another abstraction. */
6404 i = PerlIO_getc(fp); /* get more characters */
6406 DEBUG_P(PerlIO_printf(Perl_debug_log,
6407 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6408 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6409 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6411 cnt = PerlIO_get_cnt(fp);
6412 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6413 DEBUG_P(PerlIO_printf(Perl_debug_log,
6414 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6416 if (i == EOF) /* all done for ever? */
6417 goto thats_really_all_folks;
6419 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6421 SvGROW(sv, bpx + cnt + 2);
6422 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6424 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6426 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6427 goto thats_all_folks;
6431 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6432 memNE((char*)bp - rslen, rsptr, rslen))
6433 goto screamer; /* go back to the fray */
6434 thats_really_all_folks:
6436 cnt += shortbuffered;
6437 DEBUG_P(PerlIO_printf(Perl_debug_log,
6438 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6439 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6440 DEBUG_P(PerlIO_printf(Perl_debug_log,
6441 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6442 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6443 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6445 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6446 DEBUG_P(PerlIO_printf(Perl_debug_log,
6447 "Screamer: done, len=%ld, string=|%.*s|\n",
6448 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6452 /*The big, slow, and stupid way. */
6453 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6454 STDCHAR *buf = NULL;
6455 Newx(buf, 8192, STDCHAR);
6463 register const STDCHAR * const bpe = buf + sizeof(buf);
6465 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6466 ; /* keep reading */
6470 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6471 /* Accomodate broken VAXC compiler, which applies U8 cast to
6472 * both args of ?: operator, causing EOF to change into 255
6475 i = (U8)buf[cnt - 1];
6481 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6483 sv_catpvn(sv, (char *) buf, cnt);
6485 sv_setpvn(sv, (char *) buf, cnt);
6487 if (i != EOF && /* joy */
6489 SvCUR(sv) < rslen ||
6490 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6494 * If we're reading from a TTY and we get a short read,
6495 * indicating that the user hit his EOF character, we need
6496 * to notice it now, because if we try to read from the TTY
6497 * again, the EOF condition will disappear.
6499 * The comparison of cnt to sizeof(buf) is an optimization
6500 * that prevents unnecessary calls to feof().
6504 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6508 #ifdef USE_HEAP_INSTEAD_OF_STACK
6513 if (rspara) { /* have to do this both before and after */
6514 while (i != EOF) { /* to make sure file boundaries work right */
6515 i = PerlIO_getc(fp);
6517 PerlIO_ungetc(fp,i);
6523 return_string_or_null:
6524 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6530 Auto-increment of the value in the SV, doing string to numeric conversion
6531 if necessary. Handles 'get' magic.
6537 Perl_sv_inc(pTHX_ register SV *sv)
6546 if (SvTHINKFIRST(sv)) {
6548 sv_force_normal_flags(sv, 0);
6549 if (SvREADONLY(sv)) {
6550 if (IN_PERL_RUNTIME)
6551 Perl_croak(aTHX_ PL_no_modify);
6555 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6557 i = PTR2IV(SvRV(sv));
6562 flags = SvFLAGS(sv);
6563 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6564 /* It's (privately or publicly) a float, but not tested as an
6565 integer, so test it to see. */
6567 flags = SvFLAGS(sv);
6569 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6570 /* It's publicly an integer, or privately an integer-not-float */
6571 #ifdef PERL_PRESERVE_IVUV
6575 if (SvUVX(sv) == UV_MAX)
6576 sv_setnv(sv, UV_MAX_P1);
6578 (void)SvIOK_only_UV(sv);
6579 SvUV_set(sv, SvUVX(sv) + 1);
6581 if (SvIVX(sv) == IV_MAX)
6582 sv_setuv(sv, (UV)IV_MAX + 1);
6584 (void)SvIOK_only(sv);
6585 SvIV_set(sv, SvIVX(sv) + 1);
6590 if (flags & SVp_NOK) {
6591 (void)SvNOK_only(sv);
6592 SvNV_set(sv, SvNVX(sv) + 1.0);
6596 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6597 if ((flags & SVTYPEMASK) < SVt_PVIV)
6598 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6599 (void)SvIOK_only(sv);
6604 while (isALPHA(*d)) d++;
6605 while (isDIGIT(*d)) d++;
6607 #ifdef PERL_PRESERVE_IVUV
6608 /* Got to punt this as an integer if needs be, but we don't issue
6609 warnings. Probably ought to make the sv_iv_please() that does
6610 the conversion if possible, and silently. */
6611 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6612 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6613 /* Need to try really hard to see if it's an integer.
6614 9.22337203685478e+18 is an integer.
6615 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6616 so $a="9.22337203685478e+18"; $a+0; $a++
6617 needs to be the same as $a="9.22337203685478e+18"; $a++
6624 /* sv_2iv *should* have made this an NV */
6625 if (flags & SVp_NOK) {
6626 (void)SvNOK_only(sv);
6627 SvNV_set(sv, SvNVX(sv) + 1.0);
6630 /* I don't think we can get here. Maybe I should assert this
6631 And if we do get here I suspect that sv_setnv will croak. NWC
6633 #if defined(USE_LONG_DOUBLE)
6634 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",
6635 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6637 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6638 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6641 #endif /* PERL_PRESERVE_IVUV */
6642 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6646 while (d >= SvPVX_const(sv)) {
6654 /* MKS: The original code here died if letters weren't consecutive.
6655 * at least it didn't have to worry about non-C locales. The
6656 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6657 * arranged in order (although not consecutively) and that only
6658 * [A-Za-z] are accepted by isALPHA in the C locale.
6660 if (*d != 'z' && *d != 'Z') {
6661 do { ++*d; } while (!isALPHA(*d));
6664 *(d--) -= 'z' - 'a';
6669 *(d--) -= 'z' - 'a' + 1;
6673 /* oh,oh, the number grew */
6674 SvGROW(sv, SvCUR(sv) + 2);
6675 SvCUR_set(sv, SvCUR(sv) + 1);
6676 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6687 Auto-decrement of the value in the SV, doing string to numeric conversion
6688 if necessary. Handles 'get' magic.
6694 Perl_sv_dec(pTHX_ register SV *sv)
6702 if (SvTHINKFIRST(sv)) {
6704 sv_force_normal_flags(sv, 0);
6705 if (SvREADONLY(sv)) {
6706 if (IN_PERL_RUNTIME)
6707 Perl_croak(aTHX_ PL_no_modify);
6711 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6713 i = PTR2IV(SvRV(sv));
6718 /* Unlike sv_inc we don't have to worry about string-never-numbers
6719 and keeping them magic. But we mustn't warn on punting */
6720 flags = SvFLAGS(sv);
6721 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6722 /* It's publicly an integer, or privately an integer-not-float */
6723 #ifdef PERL_PRESERVE_IVUV
6727 if (SvUVX(sv) == 0) {
6728 (void)SvIOK_only(sv);
6732 (void)SvIOK_only_UV(sv);
6733 SvUV_set(sv, SvUVX(sv) - 1);
6736 if (SvIVX(sv) == IV_MIN)
6737 sv_setnv(sv, (NV)IV_MIN - 1.0);
6739 (void)SvIOK_only(sv);
6740 SvIV_set(sv, SvIVX(sv) - 1);
6745 if (flags & SVp_NOK) {
6746 SvNV_set(sv, SvNVX(sv) - 1.0);
6747 (void)SvNOK_only(sv);
6750 if (!(flags & SVp_POK)) {
6751 if ((flags & SVTYPEMASK) < SVt_PVIV)
6752 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6754 (void)SvIOK_only(sv);
6757 #ifdef PERL_PRESERVE_IVUV
6759 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6760 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6761 /* Need to try really hard to see if it's an integer.
6762 9.22337203685478e+18 is an integer.
6763 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6764 so $a="9.22337203685478e+18"; $a+0; $a--
6765 needs to be the same as $a="9.22337203685478e+18"; $a--
6772 /* sv_2iv *should* have made this an NV */
6773 if (flags & SVp_NOK) {
6774 (void)SvNOK_only(sv);
6775 SvNV_set(sv, SvNVX(sv) - 1.0);
6778 /* I don't think we can get here. Maybe I should assert this
6779 And if we do get here I suspect that sv_setnv will croak. NWC
6781 #if defined(USE_LONG_DOUBLE)
6782 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",
6783 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6785 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6786 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6790 #endif /* PERL_PRESERVE_IVUV */
6791 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6795 =for apidoc sv_mortalcopy
6797 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6798 The new SV is marked as mortal. It will be destroyed "soon", either by an
6799 explicit call to FREETMPS, or by an implicit call at places such as
6800 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6805 /* Make a string that will exist for the duration of the expression
6806 * evaluation. Actually, it may have to last longer than that, but
6807 * hopefully we won't free it until it has been assigned to a
6808 * permanent location. */
6811 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6817 sv_setsv(sv,oldstr);
6819 PL_tmps_stack[++PL_tmps_ix] = sv;
6825 =for apidoc sv_newmortal
6827 Creates a new null SV which is mortal. The reference count of the SV is
6828 set to 1. It will be destroyed "soon", either by an explicit call to
6829 FREETMPS, or by an implicit call at places such as statement boundaries.
6830 See also C<sv_mortalcopy> and C<sv_2mortal>.
6836 Perl_sv_newmortal(pTHX)
6842 SvFLAGS(sv) = SVs_TEMP;
6844 PL_tmps_stack[++PL_tmps_ix] = sv;
6849 =for apidoc sv_2mortal
6851 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6852 by an explicit call to FREETMPS, or by an implicit call at places such as
6853 statement boundaries. SvTEMP() is turned on which means that the SV's
6854 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6855 and C<sv_mortalcopy>.
6861 Perl_sv_2mortal(pTHX_ register SV *sv)
6866 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6869 PL_tmps_stack[++PL_tmps_ix] = sv;
6877 Creates a new SV and copies a string into it. The reference count for the
6878 SV is set to 1. If C<len> is zero, Perl will compute the length using
6879 strlen(). For efficiency, consider using C<newSVpvn> instead.
6885 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6891 sv_setpvn(sv,s,len ? len : strlen(s));
6896 =for apidoc newSVpvn
6898 Creates a new SV and copies a string into it. The reference count for the
6899 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6900 string. You are responsible for ensuring that the source string is at least
6901 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6907 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6913 sv_setpvn(sv,s,len);
6919 =for apidoc newSVhek
6921 Creates a new SV from the hash key structure. It will generate scalars that
6922 point to the shared string table where possible. Returns a new (undefined)
6923 SV if the hek is NULL.
6929 Perl_newSVhek(pTHX_ const HEK *hek)
6939 if (HEK_LEN(hek) == HEf_SVKEY) {
6940 return newSVsv(*(SV**)HEK_KEY(hek));
6942 const int flags = HEK_FLAGS(hek);
6943 if (flags & HVhek_WASUTF8) {
6945 Andreas would like keys he put in as utf8 to come back as utf8
6947 STRLEN utf8_len = HEK_LEN(hek);
6948 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6949 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6952 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6954 } else if (flags & HVhek_REHASH) {
6955 /* We don't have a pointer to the hv, so we have to replicate the
6956 flag into every HEK. This hv is using custom a hasing
6957 algorithm. Hence we can't return a shared string scalar, as
6958 that would contain the (wrong) hash value, and might get passed
6959 into an hv routine with a regular hash */
6961 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6966 /* This will be overwhelminly the most common case. */
6967 return newSVpvn_share(HEK_KEY(hek),
6968 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
6974 =for apidoc newSVpvn_share
6976 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6977 table. If the string does not already exist in the table, it is created
6978 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6979 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6980 otherwise the hash is computed. The idea here is that as the string table
6981 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
6982 hash lookup will avoid string compare.
6988 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
6992 bool is_utf8 = FALSE;
6994 STRLEN tmplen = -len;
6996 /* See the note in hv.c:hv_fetch() --jhi */
6997 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7001 PERL_HASH(hash, src, len);
7003 sv_upgrade(sv, SVt_PV);
7004 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7016 #if defined(PERL_IMPLICIT_CONTEXT)
7018 /* pTHX_ magic can't cope with varargs, so this is a no-context
7019 * version of the main function, (which may itself be aliased to us).
7020 * Don't access this version directly.
7024 Perl_newSVpvf_nocontext(const char* pat, ...)
7029 va_start(args, pat);
7030 sv = vnewSVpvf(pat, &args);
7037 =for apidoc newSVpvf
7039 Creates a new SV and initializes it with the string formatted like
7046 Perl_newSVpvf(pTHX_ const char* pat, ...)
7050 va_start(args, pat);
7051 sv = vnewSVpvf(pat, &args);
7056 /* backend for newSVpvf() and newSVpvf_nocontext() */
7059 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7064 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7071 Creates a new SV and copies a floating point value into it.
7072 The reference count for the SV is set to 1.
7078 Perl_newSVnv(pTHX_ NV n)
7091 Creates a new SV and copies an integer into it. The reference count for the
7098 Perl_newSViv(pTHX_ IV i)
7111 Creates a new SV and copies an unsigned integer into it.
7112 The reference count for the SV is set to 1.
7118 Perl_newSVuv(pTHX_ UV u)
7129 =for apidoc newRV_noinc
7131 Creates an RV wrapper for an SV. The reference count for the original
7132 SV is B<not> incremented.
7138 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7144 sv_upgrade(sv, SVt_RV);
7146 SvRV_set(sv, tmpRef);
7151 /* newRV_inc is the official function name to use now.
7152 * newRV_inc is in fact #defined to newRV in sv.h
7156 Perl_newRV(pTHX_ SV *sv)
7159 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7165 Creates a new SV which is an exact duplicate of the original SV.
7172 Perl_newSVsv(pTHX_ register SV *old)
7179 if (SvTYPE(old) == SVTYPEMASK) {
7180 if (ckWARN_d(WARN_INTERNAL))
7181 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7185 /* SV_GMAGIC is the default for sv_setv()
7186 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7187 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7188 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7193 =for apidoc sv_reset
7195 Underlying implementation for the C<reset> Perl function.
7196 Note that the perl-level function is vaguely deprecated.
7202 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7205 char todo[PERL_UCHAR_MAX+1];
7210 if (!*s) { /* reset ?? searches */
7211 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7213 PMOP *pm = (PMOP *) mg->mg_obj;
7215 pm->op_pmdynflags &= ~PMdf_USED;
7222 /* reset variables */
7224 if (!HvARRAY(stash))
7227 Zero(todo, 256, char);
7230 I32 i = (unsigned char)*s;
7234 max = (unsigned char)*s++;
7235 for ( ; i <= max; i++) {
7238 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7240 for (entry = HvARRAY(stash)[i];
7242 entry = HeNEXT(entry))
7247 if (!todo[(U8)*HeKEY(entry)])
7249 gv = (GV*)HeVAL(entry);
7252 if (SvTHINKFIRST(sv)) {
7253 if (!SvREADONLY(sv) && SvROK(sv))
7255 /* XXX Is this continue a bug? Why should THINKFIRST
7256 exempt us from resetting arrays and hashes? */
7260 if (SvTYPE(sv) >= SVt_PV) {
7262 if (SvPVX_const(sv) != NULL)
7270 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7272 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7275 # if defined(USE_ENVIRON_ARRAY)
7278 # endif /* USE_ENVIRON_ARRAY */
7289 Using various gambits, try to get an IO from an SV: the IO slot if its a
7290 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7291 named after the PV if we're a string.
7297 Perl_sv_2io(pTHX_ SV *sv)
7302 switch (SvTYPE(sv)) {
7310 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7314 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7316 return sv_2io(SvRV(sv));
7317 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7323 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7332 Using various gambits, try to get a CV from an SV; in addition, try if
7333 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7334 The flags in C<lref> are passed to sv_fetchsv.
7340 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7351 switch (SvTYPE(sv)) {
7370 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7371 tryAMAGICunDEREF(to_cv);
7374 if (SvTYPE(sv) == SVt_PVCV) {
7383 Perl_croak(aTHX_ "Not a subroutine reference");
7388 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7394 /* Some flags to gv_fetchsv mean don't really create the GV */
7395 if (SvTYPE(gv) != SVt_PVGV) {
7401 if (lref && !GvCVu(gv)) {
7405 gv_efullname3(tmpsv, gv, NULL);
7406 /* XXX this is probably not what they think they're getting.
7407 * It has the same effect as "sub name;", i.e. just a forward
7409 newSUB(start_subparse(FALSE, 0),
7410 newSVOP(OP_CONST, 0, tmpsv),
7414 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7424 Returns true if the SV has a true value by Perl's rules.
7425 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7426 instead use an in-line version.
7432 Perl_sv_true(pTHX_ register SV *sv)
7437 register const XPV* const tXpv = (XPV*)SvANY(sv);
7439 (tXpv->xpv_cur > 1 ||
7440 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7447 return SvIVX(sv) != 0;
7450 return SvNVX(sv) != 0.0;
7452 return sv_2bool(sv);
7458 =for apidoc sv_pvn_force
7460 Get a sensible string out of the SV somehow.
7461 A private implementation of the C<SvPV_force> macro for compilers which
7462 can't cope with complex macro expressions. Always use the macro instead.
7464 =for apidoc sv_pvn_force_flags
7466 Get a sensible string out of the SV somehow.
7467 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7468 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7469 implemented in terms of this function.
7470 You normally want to use the various wrapper macros instead: see
7471 C<SvPV_force> and C<SvPV_force_nomg>
7477 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7480 if (SvTHINKFIRST(sv) && !SvROK(sv))
7481 sv_force_normal_flags(sv, 0);
7491 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7492 const char * const ref = sv_reftype(sv,0);
7494 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7495 ref, OP_NAME(PL_op));
7497 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7499 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7500 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7502 s = sv_2pv_flags(sv, &len, flags);
7506 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7509 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7510 SvGROW(sv, len + 1);
7511 Move(s,SvPVX(sv),len,char);
7516 SvPOK_on(sv); /* validate pointer */
7518 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7519 PTR2UV(sv),SvPVX_const(sv)));
7522 return SvPVX_mutable(sv);
7526 =for apidoc sv_pvbyten_force
7528 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7534 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7536 sv_pvn_force(sv,lp);
7537 sv_utf8_downgrade(sv,0);
7543 =for apidoc sv_pvutf8n_force
7545 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7551 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7553 sv_pvn_force(sv,lp);
7554 sv_utf8_upgrade(sv);
7560 =for apidoc sv_reftype
7562 Returns a string describing what the SV is a reference to.
7568 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7570 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7571 inside return suggests a const propagation bug in g++. */
7572 if (ob && SvOBJECT(sv)) {
7573 char * const name = HvNAME_get(SvSTASH(sv));
7574 return name ? name : (char *) "__ANON__";
7577 switch (SvTYPE(sv)) {
7594 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7595 /* tied lvalues should appear to be
7596 * scalars for backwards compatitbility */
7597 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7598 ? "SCALAR" : "LVALUE");
7599 case SVt_PVAV: return "ARRAY";
7600 case SVt_PVHV: return "HASH";
7601 case SVt_PVCV: return "CODE";
7602 case SVt_PVGV: return "GLOB";
7603 case SVt_PVFM: return "FORMAT";
7604 case SVt_PVIO: return "IO";
7605 default: return "UNKNOWN";
7611 =for apidoc sv_isobject
7613 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7614 object. If the SV is not an RV, or if the object is not blessed, then this
7621 Perl_sv_isobject(pTHX_ SV *sv)
7637 Returns a boolean indicating whether the SV is blessed into the specified
7638 class. This does not check for subtypes; use C<sv_derived_from> to verify
7639 an inheritance relationship.
7645 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7656 hvname = HvNAME_get(SvSTASH(sv));
7660 return strEQ(hvname, name);
7666 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7667 it will be upgraded to one. If C<classname> is non-null then the new SV will
7668 be blessed in the specified package. The new SV is returned and its
7669 reference count is 1.
7675 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7682 SV_CHECK_THINKFIRST_COW_DROP(rv);
7685 if (SvTYPE(rv) >= SVt_PVMG) {
7686 const U32 refcnt = SvREFCNT(rv);
7690 SvREFCNT(rv) = refcnt;
7692 sv_upgrade(rv, SVt_RV);
7693 } else if (SvROK(rv)) {
7694 SvREFCNT_dec(SvRV(rv));
7695 } else if (SvTYPE(rv) < SVt_RV)
7696 sv_upgrade(rv, SVt_RV);
7697 else if (SvTYPE(rv) > SVt_RV) {
7708 HV* const stash = gv_stashpv(classname, TRUE);
7709 (void)sv_bless(rv, stash);
7715 =for apidoc sv_setref_pv
7717 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7718 argument will be upgraded to an RV. That RV will be modified to point to
7719 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7720 into the SV. The C<classname> argument indicates the package for the
7721 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7722 will have a reference count of 1, and the RV will be returned.
7724 Do not use with other Perl types such as HV, AV, SV, CV, because those
7725 objects will become corrupted by the pointer copy process.
7727 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7733 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7737 sv_setsv(rv, &PL_sv_undef);
7741 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7746 =for apidoc sv_setref_iv
7748 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7749 argument will be upgraded to an RV. That RV will be modified to point to
7750 the new SV. The C<classname> argument indicates the package for the
7751 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7752 will have a reference count of 1, and the RV will be returned.
7758 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7760 sv_setiv(newSVrv(rv,classname), iv);
7765 =for apidoc sv_setref_uv
7767 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7768 argument will be upgraded to an RV. That RV will be modified to point to
7769 the new SV. The C<classname> argument indicates the package for the
7770 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7771 will have a reference count of 1, and the RV will be returned.
7777 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7779 sv_setuv(newSVrv(rv,classname), uv);
7784 =for apidoc sv_setref_nv
7786 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7787 argument will be upgraded to an RV. That RV will be modified to point to
7788 the new SV. The C<classname> argument indicates the package for the
7789 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7790 will have a reference count of 1, and the RV will be returned.
7796 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7798 sv_setnv(newSVrv(rv,classname), nv);
7803 =for apidoc sv_setref_pvn
7805 Copies a string into a new SV, optionally blessing the SV. The length of the
7806 string must be specified with C<n>. The C<rv> argument will be upgraded to
7807 an RV. That RV will be modified to point to the new SV. The C<classname>
7808 argument indicates the package for the blessing. Set C<classname> to
7809 C<NULL> to avoid the blessing. The new SV will have a reference count
7810 of 1, and the RV will be returned.
7812 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7818 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7820 sv_setpvn(newSVrv(rv,classname), pv, n);
7825 =for apidoc sv_bless
7827 Blesses an SV into a specified package. The SV must be an RV. The package
7828 must be designated by its stash (see C<gv_stashpv()>). The reference count
7829 of the SV is unaffected.
7835 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7840 Perl_croak(aTHX_ "Can't bless non-reference value");
7842 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7843 if (SvREADONLY(tmpRef))
7844 Perl_croak(aTHX_ PL_no_modify);
7845 if (SvOBJECT(tmpRef)) {
7846 if (SvTYPE(tmpRef) != SVt_PVIO)
7848 SvREFCNT_dec(SvSTASH(tmpRef));
7851 SvOBJECT_on(tmpRef);
7852 if (SvTYPE(tmpRef) != SVt_PVIO)
7854 SvUPGRADE(tmpRef, SVt_PVMG);
7855 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7862 if(SvSMAGICAL(tmpRef))
7863 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7871 /* Downgrades a PVGV to a PVMG.
7875 S_sv_unglob(pTHX_ SV *sv)
7879 SV * const temp = sv_newmortal();
7881 assert(SvTYPE(sv) == SVt_PVGV);
7883 gv_efullname3(temp, (GV *) sv, "*");
7889 sv_del_backref((SV*)GvSTASH(sv), sv);
7893 if (GvNAME_HEK(sv)) {
7894 unshare_hek(GvNAME_HEK(sv));
7898 /* need to keep SvANY(sv) in the right arena */
7899 xpvmg = new_XPVMG();
7900 StructCopy(SvANY(sv), xpvmg, XPVMG);
7901 del_XPVGV(SvANY(sv));
7904 SvFLAGS(sv) &= ~SVTYPEMASK;
7905 SvFLAGS(sv) |= SVt_PVMG;
7907 /* Intentionally not calling any local SET magic, as this isn't so much a
7908 set operation as merely an internal storage change. */
7909 sv_setsv_flags(sv, temp, 0);
7913 =for apidoc sv_unref_flags
7915 Unsets the RV status of the SV, and decrements the reference count of
7916 whatever was being referenced by the RV. This can almost be thought of
7917 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7918 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7919 (otherwise the decrementing is conditional on the reference count being
7920 different from one or the reference being a readonly SV).
7927 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7929 SV* const target = SvRV(ref);
7931 if (SvWEAKREF(ref)) {
7932 sv_del_backref(target, ref);
7934 SvRV_set(ref, NULL);
7937 SvRV_set(ref, NULL);
7939 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7940 assigned to as BEGIN {$a = \"Foo"} will fail. */
7941 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7942 SvREFCNT_dec(target);
7943 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7944 sv_2mortal(target); /* Schedule for freeing later */
7948 =for apidoc sv_untaint
7950 Untaint an SV. Use C<SvTAINTED_off> instead.
7955 Perl_sv_untaint(pTHX_ SV *sv)
7957 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7958 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7965 =for apidoc sv_tainted
7967 Test an SV for taintedness. Use C<SvTAINTED> instead.
7972 Perl_sv_tainted(pTHX_ SV *sv)
7974 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7975 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7976 if (mg && (mg->mg_len & 1) )
7983 =for apidoc sv_setpviv
7985 Copies an integer into the given SV, also updating its string value.
7986 Does not handle 'set' magic. See C<sv_setpviv_mg>.
7992 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
7994 char buf[TYPE_CHARS(UV)];
7996 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
7998 sv_setpvn(sv, ptr, ebuf - ptr);
8002 =for apidoc sv_setpviv_mg
8004 Like C<sv_setpviv>, but also handles 'set' magic.
8010 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8016 #if defined(PERL_IMPLICIT_CONTEXT)
8018 /* pTHX_ magic can't cope with varargs, so this is a no-context
8019 * version of the main function, (which may itself be aliased to us).
8020 * Don't access this version directly.
8024 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8028 va_start(args, pat);
8029 sv_vsetpvf(sv, pat, &args);
8033 /* pTHX_ magic can't cope with varargs, so this is a no-context
8034 * version of the main function, (which may itself be aliased to us).
8035 * Don't access this version directly.
8039 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8043 va_start(args, pat);
8044 sv_vsetpvf_mg(sv, pat, &args);
8050 =for apidoc sv_setpvf
8052 Works like C<sv_catpvf> but copies the text into the SV instead of
8053 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8059 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8062 va_start(args, pat);
8063 sv_vsetpvf(sv, pat, &args);
8068 =for apidoc sv_vsetpvf
8070 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8071 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8073 Usually used via its frontend C<sv_setpvf>.
8079 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8081 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8085 =for apidoc sv_setpvf_mg
8087 Like C<sv_setpvf>, but also handles 'set' magic.
8093 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8096 va_start(args, pat);
8097 sv_vsetpvf_mg(sv, pat, &args);
8102 =for apidoc sv_vsetpvf_mg
8104 Like C<sv_vsetpvf>, but also handles 'set' magic.
8106 Usually used via its frontend C<sv_setpvf_mg>.
8112 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8114 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8118 #if defined(PERL_IMPLICIT_CONTEXT)
8120 /* pTHX_ magic can't cope with varargs, so this is a no-context
8121 * version of the main function, (which may itself be aliased to us).
8122 * Don't access this version directly.
8126 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8130 va_start(args, pat);
8131 sv_vcatpvf(sv, pat, &args);
8135 /* pTHX_ magic can't cope with varargs, so this is a no-context
8136 * version of the main function, (which may itself be aliased to us).
8137 * Don't access this version directly.
8141 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8145 va_start(args, pat);
8146 sv_vcatpvf_mg(sv, pat, &args);
8152 =for apidoc sv_catpvf
8154 Processes its arguments like C<sprintf> and appends the formatted
8155 output to an SV. If the appended data contains "wide" characters
8156 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8157 and characters >255 formatted with %c), the original SV might get
8158 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8159 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8160 valid UTF-8; if the original SV was bytes, the pattern should be too.
8165 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8168 va_start(args, pat);
8169 sv_vcatpvf(sv, pat, &args);
8174 =for apidoc sv_vcatpvf
8176 Processes its arguments like C<vsprintf> and appends the formatted output
8177 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8179 Usually used via its frontend C<sv_catpvf>.
8185 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8187 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8191 =for apidoc sv_catpvf_mg
8193 Like C<sv_catpvf>, but also handles 'set' magic.
8199 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8202 va_start(args, pat);
8203 sv_vcatpvf_mg(sv, pat, &args);
8208 =for apidoc sv_vcatpvf_mg
8210 Like C<sv_vcatpvf>, but also handles 'set' magic.
8212 Usually used via its frontend C<sv_catpvf_mg>.
8218 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8220 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8225 =for apidoc sv_vsetpvfn
8227 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8230 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8236 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8238 sv_setpvn(sv, "", 0);
8239 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8243 S_expect_number(pTHX_ char** pattern)
8247 switch (**pattern) {
8248 case '1': case '2': case '3':
8249 case '4': case '5': case '6':
8250 case '7': case '8': case '9':
8251 var = *(*pattern)++ - '0';
8252 while (isDIGIT(**pattern)) {
8253 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8255 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8263 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8265 const int neg = nv < 0;
8274 if (uv & 1 && uv == nv)
8275 uv--; /* Round to even */
8277 const unsigned dig = uv % 10;
8290 =for apidoc sv_vcatpvfn
8292 Processes its arguments like C<vsprintf> and appends the formatted output
8293 to an SV. Uses an array of SVs if the C style variable argument list is
8294 missing (NULL). When running with taint checks enabled, indicates via
8295 C<maybe_tainted> if results are untrustworthy (often due to the use of
8298 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8304 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8305 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8306 vec_utf8 = DO_UTF8(vecsv);
8308 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8311 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8319 static const char nullstr[] = "(null)";
8321 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8322 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8324 /* Times 4: a decimal digit takes more than 3 binary digits.
8325 * NV_DIG: mantissa takes than many decimal digits.
8326 * Plus 32: Playing safe. */
8327 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8328 /* large enough for "%#.#f" --chip */
8329 /* what about long double NVs? --jhi */
8331 PERL_UNUSED_ARG(maybe_tainted);
8333 /* no matter what, this is a string now */
8334 (void)SvPV_force(sv, origlen);
8336 /* special-case "", "%s", and "%-p" (SVf - see below) */
8339 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8341 const char * const s = va_arg(*args, char*);
8342 sv_catpv(sv, s ? s : nullstr);
8344 else if (svix < svmax) {
8345 sv_catsv(sv, *svargs);
8349 if (args && patlen == 3 && pat[0] == '%' &&
8350 pat[1] == '-' && pat[2] == 'p') {
8351 argsv = va_arg(*args, SV*);
8352 sv_catsv(sv, argsv);
8356 #ifndef USE_LONG_DOUBLE
8357 /* special-case "%.<number>[gf]" */
8358 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8359 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8360 unsigned digits = 0;
8364 while (*pp >= '0' && *pp <= '9')
8365 digits = 10 * digits + (*pp++ - '0');
8366 if (pp - pat == (int)patlen - 1) {
8374 /* Add check for digits != 0 because it seems that some
8375 gconverts are buggy in this case, and we don't yet have
8376 a Configure test for this. */
8377 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8378 /* 0, point, slack */
8379 Gconvert(nv, (int)digits, 0, ebuf);
8381 if (*ebuf) /* May return an empty string for digits==0 */
8384 } else if (!digits) {
8387 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8388 sv_catpvn(sv, p, l);
8394 #endif /* !USE_LONG_DOUBLE */
8396 if (!args && svix < svmax && DO_UTF8(*svargs))
8399 patend = (char*)pat + patlen;
8400 for (p = (char*)pat; p < patend; p = q) {
8403 bool vectorize = FALSE;
8404 bool vectorarg = FALSE;
8405 bool vec_utf8 = FALSE;
8411 bool has_precis = FALSE;
8413 const I32 osvix = svix;
8414 bool is_utf8 = FALSE; /* is this item utf8? */
8415 #ifdef HAS_LDBL_SPRINTF_BUG
8416 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8417 with sfio - Allen <allens@cpan.org> */
8418 bool fix_ldbl_sprintf_bug = FALSE;
8422 U8 utf8buf[UTF8_MAXBYTES+1];
8423 STRLEN esignlen = 0;
8425 const char *eptr = NULL;
8428 const U8 *vecstr = NULL;
8435 /* we need a long double target in case HAS_LONG_DOUBLE but
8438 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8446 const char *dotstr = ".";
8447 STRLEN dotstrlen = 1;
8448 I32 efix = 0; /* explicit format parameter index */
8449 I32 ewix = 0; /* explicit width index */
8450 I32 epix = 0; /* explicit precision index */
8451 I32 evix = 0; /* explicit vector index */
8452 bool asterisk = FALSE;
8454 /* echo everything up to the next format specification */
8455 for (q = p; q < patend && *q != '%'; ++q) ;
8457 if (has_utf8 && !pat_utf8)
8458 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8460 sv_catpvn(sv, p, q - p);
8467 We allow format specification elements in this order:
8468 \d+\$ explicit format parameter index
8470 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8471 0 flag (as above): repeated to allow "v02"
8472 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8473 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8475 [%bcdefginopsuxDFOUX] format (mandatory)
8480 As of perl5.9.3, printf format checking is on by default.
8481 Internally, perl uses %p formats to provide an escape to
8482 some extended formatting. This block deals with those
8483 extensions: if it does not match, (char*)q is reset and
8484 the normal format processing code is used.
8486 Currently defined extensions are:
8487 %p include pointer address (standard)
8488 %-p (SVf) include an SV (previously %_)
8489 %-<num>p include an SV with precision <num>
8490 %1p (VDf) include a v-string (as %vd)
8491 %<num>p reserved for future extensions
8493 Robin Barker 2005-07-14
8500 n = expect_number(&q);
8507 argsv = va_arg(*args, SV*);
8508 eptr = SvPVx_const(argsv, elen);
8514 else if (n == vdNUMBER) { /* VDf */
8521 if (ckWARN_d(WARN_INTERNAL))
8522 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8523 "internal %%<num>p might conflict with future printf extensions");
8529 if ( (width = expect_number(&q)) ) {
8570 if ( (ewix = expect_number(&q)) )
8579 if ((vectorarg = asterisk)) {
8592 width = expect_number(&q);
8598 vecsv = va_arg(*args, SV*);
8600 vecsv = (evix > 0 && evix <= svmax)
8601 ? svargs[evix-1] : &PL_sv_undef;
8603 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8605 dotstr = SvPV_const(vecsv, dotstrlen);
8606 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8607 bad with tied or overloaded values that return UTF8. */
8610 else if (has_utf8) {
8611 vecsv = sv_mortalcopy(vecsv);
8612 sv_utf8_upgrade(vecsv);
8613 dotstr = SvPV_const(vecsv, dotstrlen);
8620 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8621 vecsv = svargs[efix ? efix-1 : svix++];
8622 vecstr = (U8*)SvPV_const(vecsv,veclen);
8623 vec_utf8 = DO_UTF8(vecsv);
8625 /* if this is a version object, we need to convert
8626 * back into v-string notation and then let the
8627 * vectorize happen normally
8629 if (sv_derived_from(vecsv, "version")) {
8630 char *version = savesvpv(vecsv);
8631 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8632 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8633 "vector argument not supported with alpha versions");
8636 vecsv = sv_newmortal();
8637 /* scan_vstring is expected to be called during
8638 * tokenization, so we need to fake up the end
8639 * of the buffer for it
8641 PL_bufend = version + veclen;
8642 scan_vstring(version, vecsv);
8643 vecstr = (U8*)SvPV_const(vecsv, veclen);
8644 vec_utf8 = DO_UTF8(vecsv);
8656 i = va_arg(*args, int);
8658 i = (ewix ? ewix <= svmax : svix < svmax) ?
8659 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8661 width = (i < 0) ? -i : i;
8671 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8673 /* XXX: todo, support specified precision parameter */
8677 i = va_arg(*args, int);
8679 i = (ewix ? ewix <= svmax : svix < svmax)
8680 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8681 precis = (i < 0) ? 0 : i;
8686 precis = precis * 10 + (*q++ - '0');
8695 case 'I': /* Ix, I32x, and I64x */
8697 if (q[1] == '6' && q[2] == '4') {
8703 if (q[1] == '3' && q[2] == '2') {
8713 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8724 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8725 if (*(q + 1) == 'l') { /* lld, llf */
8751 if (!vectorize && !args) {
8753 const I32 i = efix-1;
8754 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8756 argsv = (svix >= 0 && svix < svmax)
8757 ? svargs[svix++] : &PL_sv_undef;
8768 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8770 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8772 eptr = (char*)utf8buf;
8773 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8787 eptr = va_arg(*args, char*);
8789 #ifdef MACOS_TRADITIONAL
8790 /* On MacOS, %#s format is used for Pascal strings */
8795 elen = strlen(eptr);
8797 eptr = (char *)nullstr;
8798 elen = sizeof nullstr - 1;
8802 eptr = SvPVx_const(argsv, elen);
8803 if (DO_UTF8(argsv)) {
8804 if (has_precis && precis < elen) {
8806 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8809 if (width) { /* fudge width (can't fudge elen) */
8810 width += elen - sv_len_utf8(argsv);
8817 if (has_precis && elen > precis)
8824 if (alt || vectorize)
8826 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8847 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8856 esignbuf[esignlen++] = plus;
8860 case 'h': iv = (short)va_arg(*args, int); break;
8861 case 'l': iv = va_arg(*args, long); break;
8862 case 'V': iv = va_arg(*args, IV); break;
8863 default: iv = va_arg(*args, int); break;
8865 case 'q': iv = va_arg(*args, Quad_t); break;
8870 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8872 case 'h': iv = (short)tiv; break;
8873 case 'l': iv = (long)tiv; break;
8875 default: iv = tiv; break;
8877 case 'q': iv = (Quad_t)tiv; break;
8881 if ( !vectorize ) /* we already set uv above */
8886 esignbuf[esignlen++] = plus;
8890 esignbuf[esignlen++] = '-';
8933 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8944 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8945 case 'l': uv = va_arg(*args, unsigned long); break;
8946 case 'V': uv = va_arg(*args, UV); break;
8947 default: uv = va_arg(*args, unsigned); break;
8949 case 'q': uv = va_arg(*args, Uquad_t); break;
8954 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8956 case 'h': uv = (unsigned short)tuv; break;
8957 case 'l': uv = (unsigned long)tuv; break;
8959 default: uv = tuv; break;
8961 case 'q': uv = (Uquad_t)tuv; break;
8968 char *ptr = ebuf + sizeof ebuf;
8974 p = (char*)((c == 'X')
8975 ? "0123456789ABCDEF" : "0123456789abcdef");
8981 esignbuf[esignlen++] = '0';
8982 esignbuf[esignlen++] = c; /* 'x' or 'X' */
8990 if (alt && *ptr != '0')
9001 esignbuf[esignlen++] = '0';
9002 esignbuf[esignlen++] = 'b';
9005 default: /* it had better be ten or less */
9009 } while (uv /= base);
9012 elen = (ebuf + sizeof ebuf) - ptr;
9016 zeros = precis - elen;
9017 else if (precis == 0 && elen == 1 && *eptr == '0')
9023 /* FLOATING POINT */
9026 c = 'f'; /* maybe %F isn't supported here */
9034 /* This is evil, but floating point is even more evil */
9036 /* for SV-style calling, we can only get NV
9037 for C-style calling, we assume %f is double;
9038 for simplicity we allow any of %Lf, %llf, %qf for long double
9042 #if defined(USE_LONG_DOUBLE)
9046 /* [perl #20339] - we should accept and ignore %lf rather than die */
9050 #if defined(USE_LONG_DOUBLE)
9051 intsize = args ? 0 : 'q';
9055 #if defined(HAS_LONG_DOUBLE)
9064 /* now we need (long double) if intsize == 'q', else (double) */
9066 #if LONG_DOUBLESIZE > DOUBLESIZE
9068 va_arg(*args, long double) :
9069 va_arg(*args, double)
9071 va_arg(*args, double)
9076 if (c != 'e' && c != 'E') {
9078 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9079 will cast our (long double) to (double) */
9080 (void)Perl_frexp(nv, &i);
9081 if (i == PERL_INT_MIN)
9082 Perl_die(aTHX_ "panic: frexp");
9084 need = BIT_DIGITS(i);
9086 need += has_precis ? precis : 6; /* known default */
9091 #ifdef HAS_LDBL_SPRINTF_BUG
9092 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9093 with sfio - Allen <allens@cpan.org> */
9096 # define MY_DBL_MAX DBL_MAX
9097 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9098 # if DOUBLESIZE >= 8
9099 # define MY_DBL_MAX 1.7976931348623157E+308L
9101 # define MY_DBL_MAX 3.40282347E+38L
9105 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9106 # define MY_DBL_MAX_BUG 1L
9108 # define MY_DBL_MAX_BUG MY_DBL_MAX
9112 # define MY_DBL_MIN DBL_MIN
9113 # else /* XXX guessing! -Allen */
9114 # if DOUBLESIZE >= 8
9115 # define MY_DBL_MIN 2.2250738585072014E-308L
9117 # define MY_DBL_MIN 1.17549435E-38L
9121 if ((intsize == 'q') && (c == 'f') &&
9122 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9124 /* it's going to be short enough that
9125 * long double precision is not needed */
9127 if ((nv <= 0L) && (nv >= -0L))
9128 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9130 /* would use Perl_fp_class as a double-check but not
9131 * functional on IRIX - see perl.h comments */
9133 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9134 /* It's within the range that a double can represent */
9135 #if defined(DBL_MAX) && !defined(DBL_MIN)
9136 if ((nv >= ((long double)1/DBL_MAX)) ||
9137 (nv <= (-(long double)1/DBL_MAX)))
9139 fix_ldbl_sprintf_bug = TRUE;
9142 if (fix_ldbl_sprintf_bug == TRUE) {
9152 # undef MY_DBL_MAX_BUG
9155 #endif /* HAS_LDBL_SPRINTF_BUG */
9157 need += 20; /* fudge factor */
9158 if (PL_efloatsize < need) {
9159 Safefree(PL_efloatbuf);
9160 PL_efloatsize = need + 20; /* more fudge */
9161 Newx(PL_efloatbuf, PL_efloatsize, char);
9162 PL_efloatbuf[0] = '\0';
9165 if ( !(width || left || plus || alt) && fill != '0'
9166 && has_precis && intsize != 'q' ) { /* Shortcuts */
9167 /* See earlier comment about buggy Gconvert when digits,
9169 if ( c == 'g' && precis) {
9170 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9171 /* May return an empty string for digits==0 */
9172 if (*PL_efloatbuf) {
9173 elen = strlen(PL_efloatbuf);
9174 goto float_converted;
9176 } else if ( c == 'f' && !precis) {
9177 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9182 char *ptr = ebuf + sizeof ebuf;
9185 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9186 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9187 if (intsize == 'q') {
9188 /* Copy the one or more characters in a long double
9189 * format before the 'base' ([efgEFG]) character to
9190 * the format string. */
9191 static char const prifldbl[] = PERL_PRIfldbl;
9192 char const *p = prifldbl + sizeof(prifldbl) - 3;
9193 while (p >= prifldbl) { *--ptr = *p--; }
9198 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9203 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9215 /* No taint. Otherwise we are in the strange situation
9216 * where printf() taints but print($float) doesn't.
9218 #if defined(HAS_LONG_DOUBLE)
9219 elen = ((intsize == 'q')
9220 ? my_sprintf(PL_efloatbuf, ptr, nv)
9221 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9223 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9227 eptr = PL_efloatbuf;
9235 i = SvCUR(sv) - origlen;
9238 case 'h': *(va_arg(*args, short*)) = i; break;
9239 default: *(va_arg(*args, int*)) = i; break;
9240 case 'l': *(va_arg(*args, long*)) = i; break;
9241 case 'V': *(va_arg(*args, IV*)) = i; break;
9243 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9248 sv_setuv_mg(argsv, (UV)i);
9249 continue; /* not "break" */
9256 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9257 && ckWARN(WARN_PRINTF))
9259 SV * const msg = sv_newmortal();
9260 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9261 (PL_op->op_type == OP_PRTF) ? "" : "s");
9264 Perl_sv_catpvf(aTHX_ msg,
9265 "\"%%%c\"", c & 0xFF);
9267 Perl_sv_catpvf(aTHX_ msg,
9268 "\"%%\\%03"UVof"\"",
9271 sv_catpvs(msg, "end of string");
9272 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9275 /* output mangled stuff ... */
9281 /* ... right here, because formatting flags should not apply */
9282 SvGROW(sv, SvCUR(sv) + elen + 1);
9284 Copy(eptr, p, elen, char);
9287 SvCUR_set(sv, p - SvPVX_const(sv));
9289 continue; /* not "break" */
9292 /* calculate width before utf8_upgrade changes it */
9293 have = esignlen + zeros + elen;
9295 Perl_croak_nocontext(PL_memory_wrap);
9297 if (is_utf8 != has_utf8) {
9300 sv_utf8_upgrade(sv);
9303 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9304 sv_utf8_upgrade(nsv);
9305 eptr = SvPVX_const(nsv);
9308 SvGROW(sv, SvCUR(sv) + elen + 1);
9313 need = (have > width ? have : width);
9316 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9317 Perl_croak_nocontext(PL_memory_wrap);
9318 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9320 if (esignlen && fill == '0') {
9322 for (i = 0; i < (int)esignlen; i++)
9326 memset(p, fill, gap);
9329 if (esignlen && fill != '0') {
9331 for (i = 0; i < (int)esignlen; i++)
9336 for (i = zeros; i; i--)
9340 Copy(eptr, p, elen, char);
9344 memset(p, ' ', gap);
9349 Copy(dotstr, p, dotstrlen, char);
9353 vectorize = FALSE; /* done iterating over vecstr */
9360 SvCUR_set(sv, p - SvPVX_const(sv));
9368 /* =========================================================================
9370 =head1 Cloning an interpreter
9372 All the macros and functions in this section are for the private use of
9373 the main function, perl_clone().
9375 The foo_dup() functions make an exact copy of an existing foo thinngy.
9376 During the course of a cloning, a hash table is used to map old addresses
9377 to new addresses. The table is created and manipulated with the
9378 ptr_table_* functions.
9382 ============================================================================*/
9385 #if defined(USE_ITHREADS)
9387 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9388 #ifndef GpREFCNT_inc
9389 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9393 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9394 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9395 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9396 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9397 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9398 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9399 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9400 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9401 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9402 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9403 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9404 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9405 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9406 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9409 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9410 regcomp.c. AMS 20010712 */
9413 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9418 struct reg_substr_datum *s;
9421 return (REGEXP *)NULL;
9423 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9426 len = r->offsets[0];
9427 npar = r->nparens+1;
9429 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9430 Copy(r->program, ret->program, len+1, regnode);
9432 Newx(ret->startp, npar, I32);
9433 Copy(r->startp, ret->startp, npar, I32);
9434 Newx(ret->endp, npar, I32);
9435 Copy(r->startp, ret->startp, npar, I32);
9437 Newx(ret->substrs, 1, struct reg_substr_data);
9438 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9439 s->min_offset = r->substrs->data[i].min_offset;
9440 s->max_offset = r->substrs->data[i].max_offset;
9441 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9442 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9445 ret->regstclass = NULL;
9448 const int count = r->data->count;
9451 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9452 char, struct reg_data);
9453 Newx(d->what, count, U8);
9456 for (i = 0; i < count; i++) {
9457 d->what[i] = r->data->what[i];
9458 switch (d->what[i]) {
9459 /* legal options are one of: sfpont
9460 see also regcomp.h and pregfree() */
9462 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9465 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9468 /* This is cheating. */
9469 Newx(d->data[i], 1, struct regnode_charclass_class);
9470 StructCopy(r->data->data[i], d->data[i],
9471 struct regnode_charclass_class);
9472 ret->regstclass = (regnode*)d->data[i];
9475 /* Compiled op trees are readonly, and can thus be
9476 shared without duplication. */
9478 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9482 d->data[i] = r->data->data[i];
9485 d->data[i] = r->data->data[i];
9487 ((reg_trie_data*)d->data[i])->refcount++;
9491 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9500 Newx(ret->offsets, 2*len+1, U32);
9501 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9503 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9504 ret->refcnt = r->refcnt;
9505 ret->minlen = r->minlen;
9506 ret->prelen = r->prelen;
9507 ret->nparens = r->nparens;
9508 ret->lastparen = r->lastparen;
9509 ret->lastcloseparen = r->lastcloseparen;
9510 ret->reganch = r->reganch;
9512 ret->sublen = r->sublen;
9514 if (RX_MATCH_COPIED(ret))
9515 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9518 #ifdef PERL_OLD_COPY_ON_WRITE
9519 ret->saved_copy = NULL;
9522 ptr_table_store(PL_ptr_table, r, ret);
9526 /* duplicate a file handle */
9529 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9533 PERL_UNUSED_ARG(type);
9536 return (PerlIO*)NULL;
9538 /* look for it in the table first */
9539 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9543 /* create anew and remember what it is */
9544 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9545 ptr_table_store(PL_ptr_table, fp, ret);
9549 /* duplicate a directory handle */
9552 Perl_dirp_dup(pTHX_ DIR *dp)
9554 PERL_UNUSED_CONTEXT;
9561 /* duplicate a typeglob */
9564 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9570 /* look for it in the table first */
9571 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9575 /* create anew and remember what it is */
9577 ptr_table_store(PL_ptr_table, gp, ret);
9580 ret->gp_refcnt = 0; /* must be before any other dups! */
9581 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9582 ret->gp_io = io_dup_inc(gp->gp_io, param);
9583 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9584 ret->gp_av = av_dup_inc(gp->gp_av, param);
9585 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9586 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9587 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9588 ret->gp_cvgen = gp->gp_cvgen;
9589 ret->gp_line = gp->gp_line;
9590 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9594 /* duplicate a chain of magic */
9597 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9599 MAGIC *mgprev = (MAGIC*)NULL;
9602 return (MAGIC*)NULL;
9603 /* look for it in the table first */
9604 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9608 for (; mg; mg = mg->mg_moremagic) {
9610 Newxz(nmg, 1, MAGIC);
9612 mgprev->mg_moremagic = nmg;
9615 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9616 nmg->mg_private = mg->mg_private;
9617 nmg->mg_type = mg->mg_type;
9618 nmg->mg_flags = mg->mg_flags;
9619 if (mg->mg_type == PERL_MAGIC_qr) {
9620 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9622 else if(mg->mg_type == PERL_MAGIC_backref) {
9623 /* The backref AV has its reference count deliberately bumped by
9625 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9627 else if (mg->mg_type == PERL_MAGIC_symtab) {
9628 nmg->mg_obj = mg->mg_obj;
9631 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9632 ? sv_dup_inc(mg->mg_obj, param)
9633 : sv_dup(mg->mg_obj, param);
9635 nmg->mg_len = mg->mg_len;
9636 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9637 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9638 if (mg->mg_len > 0) {
9639 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9640 if (mg->mg_type == PERL_MAGIC_overload_table &&
9641 AMT_AMAGIC((AMT*)mg->mg_ptr))
9643 const AMT * const amtp = (AMT*)mg->mg_ptr;
9644 AMT * const namtp = (AMT*)nmg->mg_ptr;
9646 for (i = 1; i < NofAMmeth; i++) {
9647 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9651 else if (mg->mg_len == HEf_SVKEY)
9652 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9654 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9655 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9662 /* create a new pointer-mapping table */
9665 Perl_ptr_table_new(pTHX)
9668 PERL_UNUSED_CONTEXT;
9670 Newxz(tbl, 1, PTR_TBL_t);
9673 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9677 #define PTR_TABLE_HASH(ptr) \
9678 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9681 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9682 following define) and at call to new_body_inline made below in
9683 Perl_ptr_table_store()
9686 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9688 /* map an existing pointer using a table */
9690 STATIC PTR_TBL_ENT_t *
9691 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9692 PTR_TBL_ENT_t *tblent;
9693 const UV hash = PTR_TABLE_HASH(sv);
9695 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9696 for (; tblent; tblent = tblent->next) {
9697 if (tblent->oldval == sv)
9704 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9706 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9707 PERL_UNUSED_CONTEXT;
9708 return tblent ? tblent->newval : NULL;
9711 /* add a new entry to a pointer-mapping table */
9714 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9716 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9717 PERL_UNUSED_CONTEXT;
9720 tblent->newval = newsv;
9722 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9724 new_body_inline(tblent, PTE_SVSLOT);
9726 tblent->oldval = oldsv;
9727 tblent->newval = newsv;
9728 tblent->next = tbl->tbl_ary[entry];
9729 tbl->tbl_ary[entry] = tblent;
9731 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9732 ptr_table_split(tbl);
9736 /* double the hash bucket size of an existing ptr table */
9739 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9741 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9742 const UV oldsize = tbl->tbl_max + 1;
9743 UV newsize = oldsize * 2;
9745 PERL_UNUSED_CONTEXT;
9747 Renew(ary, newsize, PTR_TBL_ENT_t*);
9748 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9749 tbl->tbl_max = --newsize;
9751 for (i=0; i < oldsize; i++, ary++) {
9752 PTR_TBL_ENT_t **curentp, **entp, *ent;
9755 curentp = ary + oldsize;
9756 for (entp = ary, ent = *ary; ent; ent = *entp) {
9757 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9759 ent->next = *curentp;
9769 /* remove all the entries from a ptr table */
9772 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9774 if (tbl && tbl->tbl_items) {
9775 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9776 UV riter = tbl->tbl_max;
9779 PTR_TBL_ENT_t *entry = array[riter];
9782 PTR_TBL_ENT_t * const oentry = entry;
9783 entry = entry->next;
9792 /* clear and free a ptr table */
9795 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9800 ptr_table_clear(tbl);
9801 Safefree(tbl->tbl_ary);
9807 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9810 SvRV_set(dstr, SvWEAKREF(sstr)
9811 ? sv_dup(SvRV(sstr), param)
9812 : sv_dup_inc(SvRV(sstr), param));
9815 else if (SvPVX_const(sstr)) {
9816 /* Has something there */
9818 /* Normal PV - clone whole allocated space */
9819 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9820 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9821 /* Not that normal - actually sstr is copy on write.
9822 But we are a true, independant SV, so: */
9823 SvREADONLY_off(dstr);
9828 /* Special case - not normally malloced for some reason */
9829 if (isGV_with_GP(sstr)) {
9830 /* Don't need to do anything here. */
9832 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9833 /* A "shared" PV - clone it as "shared" PV */
9835 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9839 /* Some other special case - random pointer */
9840 SvPV_set(dstr, SvPVX(sstr));
9846 if (SvTYPE(dstr) == SVt_RV)
9847 SvRV_set(dstr, NULL);
9849 SvPV_set(dstr, NULL);
9853 /* duplicate an SV of any type (including AV, HV etc) */
9856 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9861 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9863 /* look for it in the table first */
9864 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9868 if(param->flags & CLONEf_JOIN_IN) {
9869 /** We are joining here so we don't want do clone
9870 something that is bad **/
9871 if (SvTYPE(sstr) == SVt_PVHV) {
9872 const char * const hvname = HvNAME_get(sstr);
9874 /** don't clone stashes if they already exist **/
9875 return (SV*)gv_stashpv(hvname,0);
9879 /* create anew and remember what it is */
9882 #ifdef DEBUG_LEAKING_SCALARS
9883 dstr->sv_debug_optype = sstr->sv_debug_optype;
9884 dstr->sv_debug_line = sstr->sv_debug_line;
9885 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9886 dstr->sv_debug_cloned = 1;
9887 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9890 ptr_table_store(PL_ptr_table, sstr, dstr);
9893 SvFLAGS(dstr) = SvFLAGS(sstr);
9894 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9895 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9898 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9899 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9900 PL_watch_pvx, SvPVX_const(sstr));
9903 /* don't clone objects whose class has asked us not to */
9904 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9905 SvFLAGS(dstr) &= ~SVTYPEMASK;
9910 switch (SvTYPE(sstr)) {
9915 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9916 SvIV_set(dstr, SvIVX(sstr));
9919 SvANY(dstr) = new_XNV();
9920 SvNV_set(dstr, SvNVX(sstr));
9923 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9924 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9928 /* These are all the types that need complex bodies allocating. */
9930 const svtype sv_type = SvTYPE(sstr);
9931 const struct body_details *const sv_type_details
9932 = bodies_by_type + sv_type;
9936 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9940 if (GvUNIQUE((GV*)sstr)) {
9941 /*EMPTY*/; /* Do sharing here, and fall through */
9954 assert(sv_type_details->body_size);
9955 if (sv_type_details->arena) {
9956 new_body_inline(new_body, sv_type);
9958 = (void*)((char*)new_body - sv_type_details->offset);
9960 new_body = new_NOARENA(sv_type_details);
9964 SvANY(dstr) = new_body;
9967 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9968 ((char*)SvANY(dstr)) + sv_type_details->offset,
9969 sv_type_details->copy, char);
9971 Copy(((char*)SvANY(sstr)),
9972 ((char*)SvANY(dstr)),
9973 sv_type_details->body_size + sv_type_details->offset, char);
9976 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9977 && !isGV_with_GP(dstr))
9978 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9980 /* The Copy above means that all the source (unduplicated) pointers
9981 are now in the destination. We can check the flags and the
9982 pointers in either, but it's possible that there's less cache
9983 missing by always going for the destination.
9984 FIXME - instrument and check that assumption */
9985 if (sv_type >= SVt_PVMG) {
9987 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
9988 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
9989 } else if (SvMAGIC(dstr))
9990 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
9992 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
9995 /* The cast silences a GCC warning about unhandled types. */
9996 switch ((int)sv_type) {
10008 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10009 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10010 LvTARG(dstr) = dstr;
10011 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10012 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10014 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10017 if (GvNAME_HEK(dstr))
10018 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10020 /* Don't call sv_add_backref here as it's going to be created
10021 as part of the magic cloning of the symbol table. */
10022 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10023 if(isGV_with_GP(sstr)) {
10024 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10025 at the point of this comment. */
10026 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10027 (void)GpREFCNT_inc(GvGP(dstr));
10029 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10032 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10033 if (IoOFP(dstr) == IoIFP(sstr))
10034 IoOFP(dstr) = IoIFP(dstr);
10036 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10037 /* PL_rsfp_filters entries have fake IoDIRP() */
10038 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10039 /* I have no idea why fake dirp (rsfps)
10040 should be treated differently but otherwise
10041 we end up with leaks -- sky*/
10042 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10043 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10044 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10046 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10047 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10048 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10049 if (IoDIRP(dstr)) {
10050 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10053 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10056 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10057 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10058 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10061 if (AvARRAY((AV*)sstr)) {
10062 SV **dst_ary, **src_ary;
10063 SSize_t items = AvFILLp((AV*)sstr) + 1;
10065 src_ary = AvARRAY((AV*)sstr);
10066 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10067 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10068 SvPV_set(dstr, (char*)dst_ary);
10069 AvALLOC((AV*)dstr) = dst_ary;
10070 if (AvREAL((AV*)sstr)) {
10071 while (items-- > 0)
10072 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10075 while (items-- > 0)
10076 *dst_ary++ = sv_dup(*src_ary++, param);
10078 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10079 while (items-- > 0) {
10080 *dst_ary++ = &PL_sv_undef;
10084 SvPV_set(dstr, NULL);
10085 AvALLOC((AV*)dstr) = (SV**)NULL;
10090 HEK *hvname = NULL;
10092 if (HvARRAY((HV*)sstr)) {
10094 const bool sharekeys = !!HvSHAREKEYS(sstr);
10095 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10096 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10098 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10099 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10101 HvARRAY(dstr) = (HE**)darray;
10102 while (i <= sxhv->xhv_max) {
10103 const HE *source = HvARRAY(sstr)[i];
10104 HvARRAY(dstr)[i] = source
10105 ? he_dup(source, sharekeys, param) : 0;
10109 struct xpvhv_aux * const saux = HvAUX(sstr);
10110 struct xpvhv_aux * const daux = HvAUX(dstr);
10111 /* This flag isn't copied. */
10112 /* SvOOK_on(hv) attacks the IV flags. */
10113 SvFLAGS(dstr) |= SVf_OOK;
10115 hvname = saux->xhv_name;
10117 = hvname ? hek_dup(hvname, param) : hvname;
10119 daux->xhv_riter = saux->xhv_riter;
10120 daux->xhv_eiter = saux->xhv_eiter
10121 ? he_dup(saux->xhv_eiter,
10122 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10123 daux->xhv_backreferences = saux->xhv_backreferences
10124 ? (AV*) SvREFCNT_inc(
10126 xhv_backreferences,
10132 SvPV_set(dstr, NULL);
10134 /* Record stashes for possible cloning in Perl_clone(). */
10136 av_push(param->stashes, dstr);
10140 if (!(param->flags & CLONEf_COPY_STACKS)) {
10144 /* NOTE: not refcounted */
10145 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10147 if (!CvISXSUB(dstr))
10148 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10150 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10151 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10152 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10153 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10155 /* don't dup if copying back - CvGV isn't refcounted, so the
10156 * duped GV may never be freed. A bit of a hack! DAPM */
10157 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10158 NULL : gv_dup(CvGV(dstr), param) ;
10159 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10161 CvWEAKOUTSIDE(sstr)
10162 ? cv_dup( CvOUTSIDE(dstr), param)
10163 : cv_dup_inc(CvOUTSIDE(dstr), param);
10164 if (!CvISXSUB(dstr))
10165 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10171 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10177 /* duplicate a context */
10180 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10182 PERL_CONTEXT *ncxs;
10185 return (PERL_CONTEXT*)NULL;
10187 /* look for it in the table first */
10188 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10192 /* create anew and remember what it is */
10193 Newxz(ncxs, max + 1, PERL_CONTEXT);
10194 ptr_table_store(PL_ptr_table, cxs, ncxs);
10197 PERL_CONTEXT * const cx = &cxs[ix];
10198 PERL_CONTEXT * const ncx = &ncxs[ix];
10199 ncx->cx_type = cx->cx_type;
10200 if (CxTYPE(cx) == CXt_SUBST) {
10201 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10204 ncx->blk_oldsp = cx->blk_oldsp;
10205 ncx->blk_oldcop = cx->blk_oldcop;
10206 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10207 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10208 ncx->blk_oldpm = cx->blk_oldpm;
10209 ncx->blk_gimme = cx->blk_gimme;
10210 switch (CxTYPE(cx)) {
10212 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10213 ? cv_dup_inc(cx->blk_sub.cv, param)
10214 : cv_dup(cx->blk_sub.cv,param));
10215 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10216 ? av_dup_inc(cx->blk_sub.argarray, param)
10218 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10219 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10220 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10221 ncx->blk_sub.lval = cx->blk_sub.lval;
10222 ncx->blk_sub.retop = cx->blk_sub.retop;
10225 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10226 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10227 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10228 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10229 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10230 ncx->blk_eval.retop = cx->blk_eval.retop;
10233 ncx->blk_loop.label = cx->blk_loop.label;
10234 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10235 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10236 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10237 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10238 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10239 ? cx->blk_loop.iterdata
10240 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10241 ncx->blk_loop.oldcomppad
10242 = (PAD*)ptr_table_fetch(PL_ptr_table,
10243 cx->blk_loop.oldcomppad);
10244 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10245 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10246 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10247 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10248 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10251 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10252 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10253 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10254 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10255 ncx->blk_sub.retop = cx->blk_sub.retop;
10267 /* duplicate a stack info structure */
10270 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10275 return (PERL_SI*)NULL;
10277 /* look for it in the table first */
10278 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10282 /* create anew and remember what it is */
10283 Newxz(nsi, 1, PERL_SI);
10284 ptr_table_store(PL_ptr_table, si, nsi);
10286 nsi->si_stack = av_dup_inc(si->si_stack, param);
10287 nsi->si_cxix = si->si_cxix;
10288 nsi->si_cxmax = si->si_cxmax;
10289 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10290 nsi->si_type = si->si_type;
10291 nsi->si_prev = si_dup(si->si_prev, param);
10292 nsi->si_next = si_dup(si->si_next, param);
10293 nsi->si_markoff = si->si_markoff;
10298 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10299 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10300 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10301 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10302 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10303 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10304 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10305 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10306 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10307 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10308 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10309 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10310 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10311 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10314 #define pv_dup_inc(p) SAVEPV(p)
10315 #define pv_dup(p) SAVEPV(p)
10316 #define svp_dup_inc(p,pp) any_dup(p,pp)
10318 /* map any object to the new equivent - either something in the
10319 * ptr table, or something in the interpreter structure
10323 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10328 return (void*)NULL;
10330 /* look for it in the table first */
10331 ret = ptr_table_fetch(PL_ptr_table, v);
10335 /* see if it is part of the interpreter structure */
10336 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10337 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10345 /* duplicate the save stack */
10348 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10350 ANY * const ss = proto_perl->Tsavestack;
10351 const I32 max = proto_perl->Tsavestack_max;
10352 I32 ix = proto_perl->Tsavestack_ix;
10364 void (*dptr) (void*);
10365 void (*dxptr) (pTHX_ void*);
10367 Newxz(nss, max, ANY);
10370 I32 i = POPINT(ss,ix);
10371 TOPINT(nss,ix) = i;
10373 case SAVEt_ITEM: /* normal string */
10374 sv = (SV*)POPPTR(ss,ix);
10375 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10376 sv = (SV*)POPPTR(ss,ix);
10377 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10379 case SAVEt_SV: /* scalar reference */
10380 sv = (SV*)POPPTR(ss,ix);
10381 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10382 gv = (GV*)POPPTR(ss,ix);
10383 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10385 case SAVEt_GENERIC_PVREF: /* generic char* */
10386 c = (char*)POPPTR(ss,ix);
10387 TOPPTR(nss,ix) = pv_dup(c);
10388 ptr = POPPTR(ss,ix);
10389 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10391 case SAVEt_SHARED_PVREF: /* char* in shared space */
10392 c = (char*)POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = savesharedpv(c);
10394 ptr = POPPTR(ss,ix);
10395 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10397 case SAVEt_GENERIC_SVREF: /* generic sv */
10398 case SAVEt_SVREF: /* scalar reference */
10399 sv = (SV*)POPPTR(ss,ix);
10400 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10401 ptr = POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10404 case SAVEt_AV: /* array reference */
10405 av = (AV*)POPPTR(ss,ix);
10406 TOPPTR(nss,ix) = av_dup_inc(av, param);
10407 gv = (GV*)POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = gv_dup(gv, param);
10410 case SAVEt_HV: /* hash reference */
10411 hv = (HV*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10413 gv = (GV*)POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = gv_dup(gv, param);
10416 case SAVEt_INT: /* int reference */
10417 ptr = POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10419 intval = (int)POPINT(ss,ix);
10420 TOPINT(nss,ix) = intval;
10422 case SAVEt_LONG: /* long reference */
10423 ptr = POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10425 longval = (long)POPLONG(ss,ix);
10426 TOPLONG(nss,ix) = longval;
10428 case SAVEt_I32: /* I32 reference */
10429 case SAVEt_I16: /* I16 reference */
10430 case SAVEt_I8: /* I8 reference */
10431 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10432 ptr = POPPTR(ss,ix);
10433 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10435 TOPINT(nss,ix) = i;
10437 case SAVEt_IV: /* IV reference */
10438 ptr = POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10441 TOPIV(nss,ix) = iv;
10443 case SAVEt_SPTR: /* SV* reference */
10444 ptr = POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 sv = (SV*)POPPTR(ss,ix);
10447 TOPPTR(nss,ix) = sv_dup(sv, param);
10449 case SAVEt_VPTR: /* random* reference */
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10452 ptr = POPPTR(ss,ix);
10453 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10455 case SAVEt_PPTR: /* char* reference */
10456 ptr = POPPTR(ss,ix);
10457 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10458 c = (char*)POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = pv_dup(c);
10461 case SAVEt_HPTR: /* HV* reference */
10462 ptr = POPPTR(ss,ix);
10463 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 hv = (HV*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = hv_dup(hv, param);
10467 case SAVEt_APTR: /* AV* reference */
10468 ptr = POPPTR(ss,ix);
10469 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10470 av = (AV*)POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = av_dup(av, param);
10474 gv = (GV*)POPPTR(ss,ix);
10475 TOPPTR(nss,ix) = gv_dup(gv, param);
10477 case SAVEt_GP: /* scalar reference */
10478 gp = (GP*)POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10480 (void)GpREFCNT_inc(gp);
10481 gv = (GV*)POPPTR(ss,ix);
10482 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10483 c = (char*)POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = pv_dup(c);
10486 TOPIV(nss,ix) = iv;
10488 TOPIV(nss,ix) = iv;
10491 case SAVEt_MORTALIZESV:
10492 sv = (SV*)POPPTR(ss,ix);
10493 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10496 ptr = POPPTR(ss,ix);
10497 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10498 /* these are assumed to be refcounted properly */
10500 switch (((OP*)ptr)->op_type) {
10502 case OP_LEAVESUBLV:
10506 case OP_LEAVEWRITE:
10507 TOPPTR(nss,ix) = ptr;
10512 TOPPTR(nss,ix) = NULL;
10517 TOPPTR(nss,ix) = NULL;
10520 c = (char*)POPPTR(ss,ix);
10521 TOPPTR(nss,ix) = pv_dup_inc(c);
10523 case SAVEt_CLEARSV:
10524 longval = POPLONG(ss,ix);
10525 TOPLONG(nss,ix) = longval;
10528 hv = (HV*)POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10530 c = (char*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = pv_dup_inc(c);
10533 TOPINT(nss,ix) = i;
10535 case SAVEt_DESTRUCTOR:
10536 ptr = POPPTR(ss,ix);
10537 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10538 dptr = POPDPTR(ss,ix);
10539 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10540 any_dup(FPTR2DPTR(void *, dptr),
10543 case SAVEt_DESTRUCTOR_X:
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10546 dxptr = POPDXPTR(ss,ix);
10547 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10548 any_dup(FPTR2DPTR(void *, dxptr),
10551 case SAVEt_REGCONTEXT:
10554 TOPINT(nss,ix) = i;
10557 case SAVEt_STACK_POS: /* Position on Perl stack */
10559 TOPINT(nss,ix) = i;
10561 case SAVEt_AELEM: /* array element */
10562 sv = (SV*)POPPTR(ss,ix);
10563 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10565 TOPINT(nss,ix) = i;
10566 av = (AV*)POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = av_dup_inc(av, param);
10569 case SAVEt_HELEM: /* hash element */
10570 sv = (SV*)POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10572 sv = (SV*)POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10574 hv = (HV*)POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10578 ptr = POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = ptr;
10583 TOPINT(nss,ix) = i;
10584 ptr = POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = Perl_refcounted_he_dup(aTHX_ ptr, param);
10586 if (i & HINT_LOCALIZE_HH) {
10587 hv = (HV*)POPPTR(ss,ix);
10588 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10591 case SAVEt_COMPPAD:
10592 av = (AV*)POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = av_dup(av, param);
10596 longval = (long)POPLONG(ss,ix);
10597 TOPLONG(nss,ix) = longval;
10598 ptr = POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600 sv = (SV*)POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = sv_dup(sv, param);
10604 ptr = POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10606 longval = (long)POPBOOL(ss,ix);
10607 TOPBOOL(nss,ix) = (bool)longval;
10609 case SAVEt_SET_SVFLAGS:
10611 TOPINT(nss,ix) = i;
10613 TOPINT(nss,ix) = i;
10614 sv = (SV*)POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = sv_dup(sv, param);
10617 case SAVEt_RE_STATE:
10619 const struct re_save_state *const old_state
10620 = (struct re_save_state *)
10621 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10622 struct re_save_state *const new_state
10623 = (struct re_save_state *)
10624 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10626 Copy(old_state, new_state, 1, struct re_save_state);
10627 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10629 new_state->re_state_bostr
10630 = pv_dup(old_state->re_state_bostr);
10631 new_state->re_state_reginput
10632 = pv_dup(old_state->re_state_reginput);
10633 new_state->re_state_regbol
10634 = pv_dup(old_state->re_state_regbol);
10635 new_state->re_state_regeol
10636 = pv_dup(old_state->re_state_regeol);
10637 new_state->re_state_regstartp
10638 = any_dup(old_state->re_state_regstartp, proto_perl);
10639 new_state->re_state_regendp
10640 = any_dup(old_state->re_state_regendp, proto_perl);
10641 new_state->re_state_reglastparen
10642 = any_dup(old_state->re_state_reglastparen, proto_perl);
10643 new_state->re_state_reglastcloseparen
10644 = any_dup(old_state->re_state_reglastcloseparen,
10646 new_state->re_state_regtill
10647 = pv_dup(old_state->re_state_regtill);
10648 /* XXX This just has to be broken. The old save_re_context
10649 code did SAVEGENERICPV(PL_reg_start_tmp);
10650 PL_reg_start_tmp is char **.
10651 Look above to what the dup code does for
10652 SAVEt_GENERIC_PVREF
10653 It can never have worked.
10654 So this is merely a faithful copy of the exiting bug: */
10655 new_state->re_state_reg_start_tmp
10656 = (char **) pv_dup((char *)
10657 old_state->re_state_reg_start_tmp);
10658 /* I assume that it only ever "worked" because no-one called
10659 (pseudo)fork while the regexp engine had re-entered itself.
10661 new_state->re_state_reg_call_cc
10662 = any_dup(old_state->re_state_reg_call_cc, proto_perl);
10663 new_state->re_state_reg_re
10664 = any_dup(old_state->re_state_reg_re, proto_perl);
10665 new_state->re_state_reg_ganch
10666 = pv_dup(old_state->re_state_reg_ganch);
10667 new_state->re_state_reg_sv
10668 = sv_dup(old_state->re_state_reg_sv, param);
10669 #ifdef PERL_OLD_COPY_ON_WRITE
10670 new_state->re_state_nrs
10671 = sv_dup(old_state->re_state_nrs, param);
10673 new_state->re_state_reg_magic
10674 = any_dup(old_state->re_state_reg_magic, proto_perl);
10675 new_state->re_state_reg_oldcurpm
10676 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10677 new_state->re_state_reg_curpm
10678 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10679 new_state->re_state_reg_oldsaved
10680 = pv_dup(old_state->re_state_reg_oldsaved);
10681 new_state->re_state_reg_poscache
10682 = pv_dup(old_state->re_state_reg_poscache);
10684 new_state->re_state_reg_starttry
10685 = pv_dup(old_state->re_state_reg_starttry);
10690 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10698 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10699 * flag to the result. This is done for each stash before cloning starts,
10700 * so we know which stashes want their objects cloned */
10703 do_mark_cloneable_stash(pTHX_ SV *sv)
10705 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10707 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10708 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10709 if (cloner && GvCV(cloner)) {
10716 XPUSHs(sv_2mortal(newSVhek(hvname)));
10718 call_sv((SV*)GvCV(cloner), G_SCALAR);
10725 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10733 =for apidoc perl_clone
10735 Create and return a new interpreter by cloning the current one.
10737 perl_clone takes these flags as parameters:
10739 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10740 without it we only clone the data and zero the stacks,
10741 with it we copy the stacks and the new perl interpreter is
10742 ready to run at the exact same point as the previous one.
10743 The pseudo-fork code uses COPY_STACKS while the
10744 threads->new doesn't.
10746 CLONEf_KEEP_PTR_TABLE
10747 perl_clone keeps a ptr_table with the pointer of the old
10748 variable as a key and the new variable as a value,
10749 this allows it to check if something has been cloned and not
10750 clone it again but rather just use the value and increase the
10751 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10752 the ptr_table using the function
10753 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10754 reason to keep it around is if you want to dup some of your own
10755 variable who are outside the graph perl scans, example of this
10756 code is in threads.xs create
10759 This is a win32 thing, it is ignored on unix, it tells perls
10760 win32host code (which is c++) to clone itself, this is needed on
10761 win32 if you want to run two threads at the same time,
10762 if you just want to do some stuff in a separate perl interpreter
10763 and then throw it away and return to the original one,
10764 you don't need to do anything.
10769 /* XXX the above needs expanding by someone who actually understands it ! */
10770 EXTERN_C PerlInterpreter *
10771 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10774 perl_clone(PerlInterpreter *proto_perl, UV flags)
10777 #ifdef PERL_IMPLICIT_SYS
10779 /* perlhost.h so we need to call into it
10780 to clone the host, CPerlHost should have a c interface, sky */
10782 if (flags & CLONEf_CLONE_HOST) {
10783 return perl_clone_host(proto_perl,flags);
10785 return perl_clone_using(proto_perl, flags,
10787 proto_perl->IMemShared,
10788 proto_perl->IMemParse,
10790 proto_perl->IStdIO,
10794 proto_perl->IProc);
10798 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10799 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10800 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10801 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10802 struct IPerlDir* ipD, struct IPerlSock* ipS,
10803 struct IPerlProc* ipP)
10805 /* XXX many of the string copies here can be optimized if they're
10806 * constants; they need to be allocated as common memory and just
10807 * their pointers copied. */
10810 CLONE_PARAMS clone_params;
10811 CLONE_PARAMS* const param = &clone_params;
10813 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10814 /* for each stash, determine whether its objects should be cloned */
10815 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10816 PERL_SET_THX(my_perl);
10819 PoisonNew(my_perl, 1, PerlInterpreter);
10825 PL_savestack_ix = 0;
10826 PL_savestack_max = -1;
10827 PL_sig_pending = 0;
10828 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10829 # else /* !DEBUGGING */
10830 Zero(my_perl, 1, PerlInterpreter);
10831 # endif /* DEBUGGING */
10833 /* host pointers */
10835 PL_MemShared = ipMS;
10836 PL_MemParse = ipMP;
10843 #else /* !PERL_IMPLICIT_SYS */
10845 CLONE_PARAMS clone_params;
10846 CLONE_PARAMS* param = &clone_params;
10847 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10848 /* for each stash, determine whether its objects should be cloned */
10849 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10850 PERL_SET_THX(my_perl);
10853 PoisonNew(my_perl, 1, PerlInterpreter);
10859 PL_savestack_ix = 0;
10860 PL_savestack_max = -1;
10861 PL_sig_pending = 0;
10862 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10863 # else /* !DEBUGGING */
10864 Zero(my_perl, 1, PerlInterpreter);
10865 # endif /* DEBUGGING */
10866 #endif /* PERL_IMPLICIT_SYS */
10867 param->flags = flags;
10868 param->proto_perl = proto_perl;
10870 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10872 PL_body_arenas = NULL;
10873 Zero(&PL_body_roots, 1, PL_body_roots);
10875 PL_nice_chunk = NULL;
10876 PL_nice_chunk_size = 0;
10878 PL_sv_objcount = 0;
10880 PL_sv_arenaroot = NULL;
10882 PL_debug = proto_perl->Idebug;
10884 PL_hash_seed = proto_perl->Ihash_seed;
10885 PL_rehash_seed = proto_perl->Irehash_seed;
10887 #ifdef USE_REENTRANT_API
10888 /* XXX: things like -Dm will segfault here in perlio, but doing
10889 * PERL_SET_CONTEXT(proto_perl);
10890 * breaks too many other things
10892 Perl_reentrant_init(aTHX);
10895 /* create SV map for pointer relocation */
10896 PL_ptr_table = ptr_table_new();
10898 /* initialize these special pointers as early as possible */
10899 SvANY(&PL_sv_undef) = NULL;
10900 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10901 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10902 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10904 SvANY(&PL_sv_no) = new_XPVNV();
10905 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10906 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10907 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10908 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10909 SvCUR_set(&PL_sv_no, 0);
10910 SvLEN_set(&PL_sv_no, 1);
10911 SvIV_set(&PL_sv_no, 0);
10912 SvNV_set(&PL_sv_no, 0);
10913 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10915 SvANY(&PL_sv_yes) = new_XPVNV();
10916 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10917 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10918 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10919 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10920 SvCUR_set(&PL_sv_yes, 1);
10921 SvLEN_set(&PL_sv_yes, 2);
10922 SvIV_set(&PL_sv_yes, 1);
10923 SvNV_set(&PL_sv_yes, 1);
10924 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10926 /* create (a non-shared!) shared string table */
10927 PL_strtab = newHV();
10928 HvSHAREKEYS_off(PL_strtab);
10929 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10930 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10932 PL_compiling = proto_perl->Icompiling;
10934 /* These two PVs will be free'd special way so must set them same way op.c does */
10935 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10936 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10938 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10939 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10941 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10942 if (!specialWARN(PL_compiling.cop_warnings))
10943 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
10944 if (!specialCopIO(PL_compiling.cop_io))
10945 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10946 PL_compiling.cop_hints
10947 = Perl_refcounted_he_dup(aTHX_ PL_compiling.cop_hints, param);
10948 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10950 /* pseudo environmental stuff */
10951 PL_origargc = proto_perl->Iorigargc;
10952 PL_origargv = proto_perl->Iorigargv;
10954 param->stashes = newAV(); /* Setup array of objects to call clone on */
10956 /* Set tainting stuff before PerlIO_debug can possibly get called */
10957 PL_tainting = proto_perl->Itainting;
10958 PL_taint_warn = proto_perl->Itaint_warn;
10960 #ifdef PERLIO_LAYERS
10961 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10962 PerlIO_clone(aTHX_ proto_perl, param);
10965 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10966 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10967 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10968 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10969 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10970 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10973 PL_minus_c = proto_perl->Iminus_c;
10974 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10975 PL_localpatches = proto_perl->Ilocalpatches;
10976 PL_splitstr = proto_perl->Isplitstr;
10977 PL_preprocess = proto_perl->Ipreprocess;
10978 PL_minus_n = proto_perl->Iminus_n;
10979 PL_minus_p = proto_perl->Iminus_p;
10980 PL_minus_l = proto_perl->Iminus_l;
10981 PL_minus_a = proto_perl->Iminus_a;
10982 PL_minus_E = proto_perl->Iminus_E;
10983 PL_minus_F = proto_perl->Iminus_F;
10984 PL_doswitches = proto_perl->Idoswitches;
10985 PL_dowarn = proto_perl->Idowarn;
10986 PL_doextract = proto_perl->Idoextract;
10987 PL_sawampersand = proto_perl->Isawampersand;
10988 PL_unsafe = proto_perl->Iunsafe;
10989 PL_inplace = SAVEPV(proto_perl->Iinplace);
10990 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10991 PL_perldb = proto_perl->Iperldb;
10992 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10993 PL_exit_flags = proto_perl->Iexit_flags;
10995 /* magical thingies */
10996 /* XXX time(&PL_basetime) when asked for? */
10997 PL_basetime = proto_perl->Ibasetime;
10998 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11000 PL_maxsysfd = proto_perl->Imaxsysfd;
11001 PL_statusvalue = proto_perl->Istatusvalue;
11003 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11005 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11007 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11009 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11010 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11011 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11013 /* Clone the regex array */
11014 PL_regex_padav = newAV();
11016 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11017 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11019 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11020 for(i = 1; i <= len; i++) {
11021 const SV * const regex = regexen[i];
11024 ? sv_dup_inc(regex, param)
11026 newSViv(PTR2IV(re_dup(
11027 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11029 av_push(PL_regex_padav, sv);
11032 PL_regex_pad = AvARRAY(PL_regex_padav);
11034 /* shortcuts to various I/O objects */
11035 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11036 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11037 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11038 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11039 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11040 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11042 /* shortcuts to regexp stuff */
11043 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11045 /* shortcuts to misc objects */
11046 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11048 /* shortcuts to debugging objects */
11049 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11050 PL_DBline = gv_dup(proto_perl->IDBline, param);
11051 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11052 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11053 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11054 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11055 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11056 PL_lineary = av_dup(proto_perl->Ilineary, param);
11057 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11059 /* symbol tables */
11060 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11061 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11062 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11063 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11064 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11066 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11067 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11068 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11069 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11070 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11071 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11073 PL_sub_generation = proto_perl->Isub_generation;
11075 /* funky return mechanisms */
11076 PL_forkprocess = proto_perl->Iforkprocess;
11078 /* subprocess state */
11079 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11081 /* internal state */
11082 PL_maxo = proto_perl->Imaxo;
11083 if (proto_perl->Iop_mask)
11084 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11087 /* PL_asserting = proto_perl->Iasserting; */
11089 /* current interpreter roots */
11090 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11091 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11092 PL_main_start = proto_perl->Imain_start;
11093 PL_eval_root = proto_perl->Ieval_root;
11094 PL_eval_start = proto_perl->Ieval_start;
11096 /* runtime control stuff */
11097 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11098 PL_copline = proto_perl->Icopline;
11100 PL_filemode = proto_perl->Ifilemode;
11101 PL_lastfd = proto_perl->Ilastfd;
11102 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11105 PL_gensym = proto_perl->Igensym;
11106 PL_preambled = proto_perl->Ipreambled;
11107 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11108 PL_laststatval = proto_perl->Ilaststatval;
11109 PL_laststype = proto_perl->Ilaststype;
11112 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11114 /* interpreter atexit processing */
11115 PL_exitlistlen = proto_perl->Iexitlistlen;
11116 if (PL_exitlistlen) {
11117 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11118 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11121 PL_exitlist = (PerlExitListEntry*)NULL;
11123 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11124 if (PL_my_cxt_size) {
11125 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11126 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11129 PL_my_cxt_list = (void**)NULL;
11130 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11131 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11132 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11134 PL_profiledata = NULL;
11135 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11136 /* PL_rsfp_filters entries have fake IoDIRP() */
11137 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11139 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11141 PAD_CLONE_VARS(proto_perl, param);
11143 #ifdef HAVE_INTERP_INTERN
11144 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11147 /* more statics moved here */
11148 PL_generation = proto_perl->Igeneration;
11149 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11151 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11152 PL_in_clean_all = proto_perl->Iin_clean_all;
11154 PL_uid = proto_perl->Iuid;
11155 PL_euid = proto_perl->Ieuid;
11156 PL_gid = proto_perl->Igid;
11157 PL_egid = proto_perl->Iegid;
11158 PL_nomemok = proto_perl->Inomemok;
11159 PL_an = proto_perl->Ian;
11160 PL_evalseq = proto_perl->Ievalseq;
11161 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11162 PL_origalen = proto_perl->Iorigalen;
11163 #ifdef PERL_USES_PL_PIDSTATUS
11164 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11166 PL_osname = SAVEPV(proto_perl->Iosname);
11167 PL_sighandlerp = proto_perl->Isighandlerp;
11169 PL_runops = proto_perl->Irunops;
11171 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11174 PL_cshlen = proto_perl->Icshlen;
11175 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11178 PL_lex_state = proto_perl->Ilex_state;
11179 PL_lex_defer = proto_perl->Ilex_defer;
11180 PL_lex_expect = proto_perl->Ilex_expect;
11181 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11182 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11183 PL_lex_starts = proto_perl->Ilex_starts;
11184 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11185 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11186 PL_lex_op = proto_perl->Ilex_op;
11187 PL_lex_inpat = proto_perl->Ilex_inpat;
11188 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11189 PL_lex_brackets = proto_perl->Ilex_brackets;
11190 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11191 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11192 PL_lex_casemods = proto_perl->Ilex_casemods;
11193 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11194 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11197 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11198 PL_lasttoke = proto_perl->Ilasttoke;
11199 PL_realtokenstart = proto_perl->Irealtokenstart;
11200 PL_faketokens = proto_perl->Ifaketokens;
11201 PL_thismad = proto_perl->Ithismad;
11202 PL_thistoken = proto_perl->Ithistoken;
11203 PL_thisopen = proto_perl->Ithisopen;
11204 PL_thisstuff = proto_perl->Ithisstuff;
11205 PL_thisclose = proto_perl->Ithisclose;
11206 PL_thiswhite = proto_perl->Ithiswhite;
11207 PL_nextwhite = proto_perl->Inextwhite;
11208 PL_skipwhite = proto_perl->Iskipwhite;
11209 PL_endwhite = proto_perl->Iendwhite;
11210 PL_curforce = proto_perl->Icurforce;
11212 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11213 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11214 PL_nexttoke = proto_perl->Inexttoke;
11217 /* XXX This is probably masking the deeper issue of why
11218 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11219 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11220 * (A little debugging with a watchpoint on it may help.)
11222 if (SvANY(proto_perl->Ilinestr)) {
11223 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11224 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11225 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11226 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11227 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11228 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11229 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11230 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11231 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11234 PL_linestr = newSV(79);
11235 sv_upgrade(PL_linestr,SVt_PVIV);
11236 sv_setpvn(PL_linestr,"",0);
11237 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11239 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11240 PL_pending_ident = proto_perl->Ipending_ident;
11241 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11243 PL_expect = proto_perl->Iexpect;
11245 PL_multi_start = proto_perl->Imulti_start;
11246 PL_multi_end = proto_perl->Imulti_end;
11247 PL_multi_open = proto_perl->Imulti_open;
11248 PL_multi_close = proto_perl->Imulti_close;
11250 PL_error_count = proto_perl->Ierror_count;
11251 PL_subline = proto_perl->Isubline;
11252 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11254 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11255 if (SvANY(proto_perl->Ilinestr)) {
11256 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11257 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11258 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11259 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11260 PL_last_lop_op = proto_perl->Ilast_lop_op;
11263 PL_last_uni = SvPVX(PL_linestr);
11264 PL_last_lop = SvPVX(PL_linestr);
11265 PL_last_lop_op = 0;
11267 PL_in_my = proto_perl->Iin_my;
11268 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11270 PL_cryptseen = proto_perl->Icryptseen;
11273 PL_hints = proto_perl->Ihints;
11275 PL_amagic_generation = proto_perl->Iamagic_generation;
11277 #ifdef USE_LOCALE_COLLATE
11278 PL_collation_ix = proto_perl->Icollation_ix;
11279 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11280 PL_collation_standard = proto_perl->Icollation_standard;
11281 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11282 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11283 #endif /* USE_LOCALE_COLLATE */
11285 #ifdef USE_LOCALE_NUMERIC
11286 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11287 PL_numeric_standard = proto_perl->Inumeric_standard;
11288 PL_numeric_local = proto_perl->Inumeric_local;
11289 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11290 #endif /* !USE_LOCALE_NUMERIC */
11292 /* utf8 character classes */
11293 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11294 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11295 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11296 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11297 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11298 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11299 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11300 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11301 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11302 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11303 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11304 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11305 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11306 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11307 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11308 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11309 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11310 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11311 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11312 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11314 /* Did the locale setup indicate UTF-8? */
11315 PL_utf8locale = proto_perl->Iutf8locale;
11316 /* Unicode features (see perlrun/-C) */
11317 PL_unicode = proto_perl->Iunicode;
11319 /* Pre-5.8 signals control */
11320 PL_signals = proto_perl->Isignals;
11322 /* times() ticks per second */
11323 PL_clocktick = proto_perl->Iclocktick;
11325 /* Recursion stopper for PerlIO_find_layer */
11326 PL_in_load_module = proto_perl->Iin_load_module;
11328 /* sort() routine */
11329 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11331 /* Not really needed/useful since the reenrant_retint is "volatile",
11332 * but do it for consistency's sake. */
11333 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11335 /* Hooks to shared SVs and locks. */
11336 PL_sharehook = proto_perl->Isharehook;
11337 PL_lockhook = proto_perl->Ilockhook;
11338 PL_unlockhook = proto_perl->Iunlockhook;
11339 PL_threadhook = proto_perl->Ithreadhook;
11341 PL_runops_std = proto_perl->Irunops_std;
11342 PL_runops_dbg = proto_perl->Irunops_dbg;
11344 #ifdef THREADS_HAVE_PIDS
11345 PL_ppid = proto_perl->Ippid;
11349 PL_last_swash_hv = NULL; /* reinits on demand */
11350 PL_last_swash_klen = 0;
11351 PL_last_swash_key[0]= '\0';
11352 PL_last_swash_tmps = (U8*)NULL;
11353 PL_last_swash_slen = 0;
11355 PL_glob_index = proto_perl->Iglob_index;
11356 PL_srand_called = proto_perl->Isrand_called;
11357 PL_uudmap['M'] = 0; /* reinits on demand */
11358 PL_bitcount = NULL; /* reinits on demand */
11360 if (proto_perl->Ipsig_pend) {
11361 Newxz(PL_psig_pend, SIG_SIZE, int);
11364 PL_psig_pend = (int*)NULL;
11367 if (proto_perl->Ipsig_ptr) {
11368 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11369 Newxz(PL_psig_name, SIG_SIZE, SV*);
11370 for (i = 1; i < SIG_SIZE; i++) {
11371 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11372 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11376 PL_psig_ptr = (SV**)NULL;
11377 PL_psig_name = (SV**)NULL;
11380 /* thrdvar.h stuff */
11382 if (flags & CLONEf_COPY_STACKS) {
11383 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11384 PL_tmps_ix = proto_perl->Ttmps_ix;
11385 PL_tmps_max = proto_perl->Ttmps_max;
11386 PL_tmps_floor = proto_perl->Ttmps_floor;
11387 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11389 while (i <= PL_tmps_ix) {
11390 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11394 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11395 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11396 Newxz(PL_markstack, i, I32);
11397 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11398 - proto_perl->Tmarkstack);
11399 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11400 - proto_perl->Tmarkstack);
11401 Copy(proto_perl->Tmarkstack, PL_markstack,
11402 PL_markstack_ptr - PL_markstack + 1, I32);
11404 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11405 * NOTE: unlike the others! */
11406 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11407 PL_scopestack_max = proto_perl->Tscopestack_max;
11408 Newxz(PL_scopestack, PL_scopestack_max, I32);
11409 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11411 /* NOTE: si_dup() looks at PL_markstack */
11412 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11414 /* PL_curstack = PL_curstackinfo->si_stack; */
11415 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11416 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11418 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11419 PL_stack_base = AvARRAY(PL_curstack);
11420 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11421 - proto_perl->Tstack_base);
11422 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11424 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11425 * NOTE: unlike the others! */
11426 PL_savestack_ix = proto_perl->Tsavestack_ix;
11427 PL_savestack_max = proto_perl->Tsavestack_max;
11428 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11429 PL_savestack = ss_dup(proto_perl, param);
11433 ENTER; /* perl_destruct() wants to LEAVE; */
11435 /* although we're not duplicating the tmps stack, we should still
11436 * add entries for any SVs on the tmps stack that got cloned by a
11437 * non-refcount means (eg a temp in @_); otherwise they will be
11440 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11441 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11442 proto_perl->Ttmps_stack[i]);
11443 if (nsv && !SvREFCNT(nsv)) {
11445 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11450 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11451 PL_top_env = &PL_start_env;
11453 PL_op = proto_perl->Top;
11456 PL_Xpv = (XPV*)NULL;
11457 PL_na = proto_perl->Tna;
11459 PL_statbuf = proto_perl->Tstatbuf;
11460 PL_statcache = proto_perl->Tstatcache;
11461 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11462 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11464 PL_timesbuf = proto_perl->Ttimesbuf;
11467 PL_tainted = proto_perl->Ttainted;
11468 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11469 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11470 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11471 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11472 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11473 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11474 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11475 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11476 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11478 PL_restartop = proto_perl->Trestartop;
11479 PL_in_eval = proto_perl->Tin_eval;
11480 PL_delaymagic = proto_perl->Tdelaymagic;
11481 PL_dirty = proto_perl->Tdirty;
11482 PL_localizing = proto_perl->Tlocalizing;
11484 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11485 PL_hv_fetch_ent_mh = NULL;
11486 PL_modcount = proto_perl->Tmodcount;
11487 PL_lastgotoprobe = NULL;
11488 PL_dumpindent = proto_perl->Tdumpindent;
11490 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11491 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11492 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11493 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11494 PL_efloatbuf = NULL; /* reinits on demand */
11495 PL_efloatsize = 0; /* reinits on demand */
11499 PL_screamfirst = NULL;
11500 PL_screamnext = NULL;
11501 PL_maxscream = -1; /* reinits on demand */
11502 PL_lastscream = NULL;
11504 PL_watchaddr = NULL;
11507 PL_regdummy = proto_perl->Tregdummy;
11508 PL_colorset = 0; /* reinits PL_colors[] */
11509 /*PL_colors[6] = {0,0,0,0,0,0};*/
11511 /* RE engine - function pointers */
11512 PL_regcompp = proto_perl->Tregcompp;
11513 PL_regexecp = proto_perl->Tregexecp;
11514 PL_regint_start = proto_perl->Tregint_start;
11515 PL_regint_string = proto_perl->Tregint_string;
11516 PL_regfree = proto_perl->Tregfree;
11517 Zero(&PL_reg_state, 1, struct re_save_state);
11518 PL_reginterp_cnt = 0;
11519 PL_regmatch_slab = NULL;
11521 /* Pluggable optimizer */
11522 PL_peepp = proto_perl->Tpeepp;
11524 PL_stashcache = newHV();
11526 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11527 ptr_table_free(PL_ptr_table);
11528 PL_ptr_table = NULL;
11531 /* Call the ->CLONE method, if it exists, for each of the stashes
11532 identified by sv_dup() above.
11534 while(av_len(param->stashes) != -1) {
11535 HV* const stash = (HV*) av_shift(param->stashes);
11536 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11537 if (cloner && GvCV(cloner)) {
11542 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11544 call_sv((SV*)GvCV(cloner), G_DISCARD);
11550 SvREFCNT_dec(param->stashes);
11552 /* orphaned? eg threads->new inside BEGIN or use */
11553 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11554 SvREFCNT_inc_simple_void(PL_compcv);
11555 SAVEFREESV(PL_compcv);
11561 #endif /* USE_ITHREADS */
11564 =head1 Unicode Support
11566 =for apidoc sv_recode_to_utf8
11568 The encoding is assumed to be an Encode object, on entry the PV
11569 of the sv is assumed to be octets in that encoding, and the sv
11570 will be converted into Unicode (and UTF-8).
11572 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11573 is not a reference, nothing is done to the sv. If the encoding is not
11574 an C<Encode::XS> Encoding object, bad things will happen.
11575 (See F<lib/encoding.pm> and L<Encode>).
11577 The PV of the sv is returned.
11582 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11585 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11599 Passing sv_yes is wrong - it needs to be or'ed set of constants
11600 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11601 remove converted chars from source.
11603 Both will default the value - let them.
11605 XPUSHs(&PL_sv_yes);
11608 call_method("decode", G_SCALAR);
11612 s = SvPV_const(uni, len);
11613 if (s != SvPVX_const(sv)) {
11614 SvGROW(sv, len + 1);
11615 Move(s, SvPVX(sv), len + 1, char);
11616 SvCUR_set(sv, len);
11623 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11627 =for apidoc sv_cat_decode
11629 The encoding is assumed to be an Encode object, the PV of the ssv is
11630 assumed to be octets in that encoding and decoding the input starts
11631 from the position which (PV + *offset) pointed to. The dsv will be
11632 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11633 when the string tstr appears in decoding output or the input ends on
11634 the PV of the ssv. The value which the offset points will be modified
11635 to the last input position on the ssv.
11637 Returns TRUE if the terminator was found, else returns FALSE.
11642 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11643 SV *ssv, int *offset, char *tstr, int tlen)
11647 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11658 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11659 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11661 call_method("cat_decode", G_SCALAR);
11663 ret = SvTRUE(TOPs);
11664 *offset = SvIV(offsv);
11670 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11675 /* ---------------------------------------------------------------------
11677 * support functions for report_uninit()
11680 /* the maxiumum size of array or hash where we will scan looking
11681 * for the undefined element that triggered the warning */
11683 #define FUV_MAX_SEARCH_SIZE 1000
11685 /* Look for an entry in the hash whose value has the same SV as val;
11686 * If so, return a mortal copy of the key. */
11689 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11692 register HE **array;
11695 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11696 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11699 array = HvARRAY(hv);
11701 for (i=HvMAX(hv); i>0; i--) {
11702 register HE *entry;
11703 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11704 if (HeVAL(entry) != val)
11706 if ( HeVAL(entry) == &PL_sv_undef ||
11707 HeVAL(entry) == &PL_sv_placeholder)
11711 if (HeKLEN(entry) == HEf_SVKEY)
11712 return sv_mortalcopy(HeKEY_sv(entry));
11713 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11719 /* Look for an entry in the array whose value has the same SV as val;
11720 * If so, return the index, otherwise return -1. */
11723 S_find_array_subscript(pTHX_ AV *av, SV* val)
11728 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11729 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11733 for (i=AvFILLp(av); i>=0; i--) {
11734 if (svp[i] == val && svp[i] != &PL_sv_undef)
11740 /* S_varname(): return the name of a variable, optionally with a subscript.
11741 * If gv is non-zero, use the name of that global, along with gvtype (one
11742 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11743 * targ. Depending on the value of the subscript_type flag, return:
11746 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11747 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11748 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11749 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11752 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11753 SV* keyname, I32 aindex, int subscript_type)
11756 SV * const name = sv_newmortal();
11759 buffer[0] = gvtype;
11762 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11764 gv_fullname4(name, gv, buffer, 0);
11766 if ((unsigned int)SvPVX(name)[1] <= 26) {
11768 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11770 /* Swap the 1 unprintable control character for the 2 byte pretty
11771 version - ie substr($name, 1, 1) = $buffer; */
11772 sv_insert(name, 1, 1, buffer, 2);
11777 CV * const cv = find_runcv(&unused);
11781 if (!cv || !CvPADLIST(cv))
11783 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11784 sv = *av_fetch(av, targ, FALSE);
11785 /* SvLEN in a pad name is not to be trusted */
11786 sv_setpv(name, SvPV_nolen_const(sv));
11789 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11790 SV * const sv = newSV(0);
11791 *SvPVX(name) = '$';
11792 Perl_sv_catpvf(aTHX_ name, "{%s}",
11793 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11796 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11797 *SvPVX(name) = '$';
11798 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11800 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11801 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11808 =for apidoc find_uninit_var
11810 Find the name of the undefined variable (if any) that caused the operator o
11811 to issue a "Use of uninitialized value" warning.
11812 If match is true, only return a name if it's value matches uninit_sv.
11813 So roughly speaking, if a unary operator (such as OP_COS) generates a
11814 warning, then following the direct child of the op may yield an
11815 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11816 other hand, with OP_ADD there are two branches to follow, so we only print
11817 the variable name if we get an exact match.
11819 The name is returned as a mortal SV.
11821 Assumes that PL_op is the op that originally triggered the error, and that
11822 PL_comppad/PL_curpad points to the currently executing pad.
11828 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11836 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11837 uninit_sv == &PL_sv_placeholder)))
11840 switch (obase->op_type) {
11847 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11848 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11851 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11853 if (pad) { /* @lex, %lex */
11854 sv = PAD_SVl(obase->op_targ);
11858 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11859 /* @global, %global */
11860 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11863 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11865 else /* @{expr}, %{expr} */
11866 return find_uninit_var(cUNOPx(obase)->op_first,
11870 /* attempt to find a match within the aggregate */
11872 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11874 subscript_type = FUV_SUBSCRIPT_HASH;
11877 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11879 subscript_type = FUV_SUBSCRIPT_ARRAY;
11882 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11885 return varname(gv, hash ? '%' : '@', obase->op_targ,
11886 keysv, index, subscript_type);
11890 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11892 return varname(NULL, '$', obase->op_targ,
11893 NULL, 0, FUV_SUBSCRIPT_NONE);
11896 gv = cGVOPx_gv(obase);
11897 if (!gv || (match && GvSV(gv) != uninit_sv))
11899 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11902 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11905 av = (AV*)PAD_SV(obase->op_targ);
11906 if (!av || SvRMAGICAL(av))
11908 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11909 if (!svp || *svp != uninit_sv)
11912 return varname(NULL, '$', obase->op_targ,
11913 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11916 gv = cGVOPx_gv(obase);
11922 if (!av || SvRMAGICAL(av))
11924 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11925 if (!svp || *svp != uninit_sv)
11928 return varname(gv, '$', 0,
11929 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11934 o = cUNOPx(obase)->op_first;
11935 if (!o || o->op_type != OP_NULL ||
11936 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11938 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11942 if (PL_op == obase)
11943 /* $a[uninit_expr] or $h{uninit_expr} */
11944 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11947 o = cBINOPx(obase)->op_first;
11948 kid = cBINOPx(obase)->op_last;
11950 /* get the av or hv, and optionally the gv */
11952 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11953 sv = PAD_SV(o->op_targ);
11955 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11956 && cUNOPo->op_first->op_type == OP_GV)
11958 gv = cGVOPx_gv(cUNOPo->op_first);
11961 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11966 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11967 /* index is constant */
11971 if (obase->op_type == OP_HELEM) {
11972 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11973 if (!he || HeVAL(he) != uninit_sv)
11977 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11978 if (!svp || *svp != uninit_sv)
11982 if (obase->op_type == OP_HELEM)
11983 return varname(gv, '%', o->op_targ,
11984 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11986 return varname(gv, '@', o->op_targ, NULL,
11987 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11990 /* index is an expression;
11991 * attempt to find a match within the aggregate */
11992 if (obase->op_type == OP_HELEM) {
11993 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11995 return varname(gv, '%', o->op_targ,
11996 keysv, 0, FUV_SUBSCRIPT_HASH);
11999 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12001 return varname(gv, '@', o->op_targ,
12002 NULL, index, FUV_SUBSCRIPT_ARRAY);
12007 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12009 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12014 /* only examine RHS */
12015 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12018 o = cUNOPx(obase)->op_first;
12019 if (o->op_type == OP_PUSHMARK)
12022 if (!o->op_sibling) {
12023 /* one-arg version of open is highly magical */
12025 if (o->op_type == OP_GV) { /* open FOO; */
12027 if (match && GvSV(gv) != uninit_sv)
12029 return varname(gv, '$', 0,
12030 NULL, 0, FUV_SUBSCRIPT_NONE);
12032 /* other possibilities not handled are:
12033 * open $x; or open my $x; should return '${*$x}'
12034 * open expr; should return '$'.expr ideally
12040 /* ops where $_ may be an implicit arg */
12044 if ( !(obase->op_flags & OPf_STACKED)) {
12045 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12046 ? PAD_SVl(obase->op_targ)
12049 sv = sv_newmortal();
12050 sv_setpvn(sv, "$_", 2);
12058 /* skip filehandle as it can't produce 'undef' warning */
12059 o = cUNOPx(obase)->op_first;
12060 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12061 o = o->op_sibling->op_sibling;
12068 match = 1; /* XS or custom code could trigger random warnings */
12073 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12074 return sv_2mortal(newSVpvs("${$/}"));
12079 if (!(obase->op_flags & OPf_KIDS))
12081 o = cUNOPx(obase)->op_first;
12087 /* if all except one arg are constant, or have no side-effects,
12088 * or are optimized away, then it's unambiguous */
12090 for (kid=o; kid; kid = kid->op_sibling) {
12092 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12093 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12094 || (kid->op_type == OP_PUSHMARK)
12098 if (o2) { /* more than one found */
12105 return find_uninit_var(o2, uninit_sv, match);
12107 /* scan all args */
12109 sv = find_uninit_var(o, uninit_sv, 1);
12121 =for apidoc report_uninit
12123 Print appropriate "Use of uninitialized variable" warning
12129 Perl_report_uninit(pTHX_ SV* uninit_sv)
12133 SV* varname = NULL;
12135 varname = find_uninit_var(PL_op, uninit_sv,0);
12137 sv_insert(varname, 0, 0, " ", 1);
12139 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12140 varname ? SvPV_nolen_const(varname) : "",
12141 " in ", OP_DESC(PL_op));
12144 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12150 * c-indentation-style: bsd
12151 * c-basic-offset: 4
12152 * indent-tabs-mode: t
12155 * ex: set ts=8 sts=4 sw=4 noet: