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_2number(pTHX_ GV * const gv)
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;
1732 /* We know that all GVs stringify to something that is not-a-number,
1733 so no need to test that. */
1734 if (ckWARN(WARN_NUMERIC))
1735 not_a_number(buffer);
1736 /* We just want something true to return, so that S_sv_2iuv_common
1737 can tail call us and return true. */
1742 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1744 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1745 SV *const buffer = sv_newmortal();
1747 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1750 gv_efullname3(buffer, gv, "*");
1751 SvFLAGS(gv) |= wasfake;
1753 assert(SvPOK(buffer));
1754 *len = SvCUR(buffer);
1755 return SvPVX(buffer);
1758 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1759 until proven guilty, assume that things are not that bad... */
1764 As 64 bit platforms often have an NV that doesn't preserve all bits of
1765 an IV (an assumption perl has been based on to date) it becomes necessary
1766 to remove the assumption that the NV always carries enough precision to
1767 recreate the IV whenever needed, and that the NV is the canonical form.
1768 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1769 precision as a side effect of conversion (which would lead to insanity
1770 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1771 1) to distinguish between IV/UV/NV slots that have cached a valid
1772 conversion where precision was lost and IV/UV/NV slots that have a
1773 valid conversion which has lost no precision
1774 2) to ensure that if a numeric conversion to one form is requested that
1775 would lose precision, the precise conversion (or differently
1776 imprecise conversion) is also performed and cached, to prevent
1777 requests for different numeric formats on the same SV causing
1778 lossy conversion chains. (lossless conversion chains are perfectly
1783 SvIOKp is true if the IV slot contains a valid value
1784 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1785 SvNOKp is true if the NV slot contains a valid value
1786 SvNOK is true only if the NV value is accurate
1789 while converting from PV to NV, check to see if converting that NV to an
1790 IV(or UV) would lose accuracy over a direct conversion from PV to
1791 IV(or UV). If it would, cache both conversions, return NV, but mark
1792 SV as IOK NOKp (ie not NOK).
1794 While converting from PV to IV, check to see if converting that IV to an
1795 NV would lose accuracy over a direct conversion from PV to NV. If it
1796 would, cache both conversions, flag similarly.
1798 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1799 correctly because if IV & NV were set NV *always* overruled.
1800 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1801 changes - now IV and NV together means that the two are interchangeable:
1802 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1804 The benefit of this is that operations such as pp_add know that if
1805 SvIOK is true for both left and right operands, then integer addition
1806 can be used instead of floating point (for cases where the result won't
1807 overflow). Before, floating point was always used, which could lead to
1808 loss of precision compared with integer addition.
1810 * making IV and NV equal status should make maths accurate on 64 bit
1812 * may speed up maths somewhat if pp_add and friends start to use
1813 integers when possible instead of fp. (Hopefully the overhead in
1814 looking for SvIOK and checking for overflow will not outweigh the
1815 fp to integer speedup)
1816 * will slow down integer operations (callers of SvIV) on "inaccurate"
1817 values, as the change from SvIOK to SvIOKp will cause a call into
1818 sv_2iv each time rather than a macro access direct to the IV slot
1819 * should speed up number->string conversion on integers as IV is
1820 favoured when IV and NV are equally accurate
1822 ####################################################################
1823 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1824 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1825 On the other hand, SvUOK is true iff UV.
1826 ####################################################################
1828 Your mileage will vary depending your CPU's relative fp to integer
1832 #ifndef NV_PRESERVES_UV
1833 # define IS_NUMBER_UNDERFLOW_IV 1
1834 # define IS_NUMBER_UNDERFLOW_UV 2
1835 # define IS_NUMBER_IV_AND_UV 2
1836 # define IS_NUMBER_OVERFLOW_IV 4
1837 # define IS_NUMBER_OVERFLOW_UV 5
1839 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1841 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1843 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1846 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));
1847 if (SvNVX(sv) < (NV)IV_MIN) {
1848 (void)SvIOKp_on(sv);
1850 SvIV_set(sv, IV_MIN);
1851 return IS_NUMBER_UNDERFLOW_IV;
1853 if (SvNVX(sv) > (NV)UV_MAX) {
1854 (void)SvIOKp_on(sv);
1857 SvUV_set(sv, UV_MAX);
1858 return IS_NUMBER_OVERFLOW_UV;
1860 (void)SvIOKp_on(sv);
1862 /* Can't use strtol etc to convert this string. (See truth table in
1864 if (SvNVX(sv) <= (UV)IV_MAX) {
1865 SvIV_set(sv, I_V(SvNVX(sv)));
1866 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1867 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1869 /* Integer is imprecise. NOK, IOKp */
1871 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1874 SvUV_set(sv, U_V(SvNVX(sv)));
1875 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1876 if (SvUVX(sv) == UV_MAX) {
1877 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1878 possibly be preserved by NV. Hence, it must be overflow.
1880 return IS_NUMBER_OVERFLOW_UV;
1882 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1884 /* Integer is imprecise. NOK, IOKp */
1886 return IS_NUMBER_OVERFLOW_IV;
1888 #endif /* !NV_PRESERVES_UV*/
1891 S_sv_2iuv_common(pTHX_ SV *sv) {
1894 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1895 * without also getting a cached IV/UV from it at the same time
1896 * (ie PV->NV conversion should detect loss of accuracy and cache
1897 * IV or UV at same time to avoid this. */
1898 /* IV-over-UV optimisation - choose to cache IV if possible */
1900 if (SvTYPE(sv) == SVt_NV)
1901 sv_upgrade(sv, SVt_PVNV);
1903 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1904 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1905 certainly cast into the IV range at IV_MAX, whereas the correct
1906 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1908 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1909 if (Perl_isnan(SvNVX(sv))) {
1915 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1916 SvIV_set(sv, I_V(SvNVX(sv)));
1917 if (SvNVX(sv) == (NV) SvIVX(sv)
1918 #ifndef NV_PRESERVES_UV
1919 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1920 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1921 /* Don't flag it as "accurately an integer" if the number
1922 came from a (by definition imprecise) NV operation, and
1923 we're outside the range of NV integer precision */
1926 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1927 DEBUG_c(PerlIO_printf(Perl_debug_log,
1928 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1934 /* IV not precise. No need to convert from PV, as NV
1935 conversion would already have cached IV if it detected
1936 that PV->IV would be better than PV->NV->IV
1937 flags already correct - don't set public IOK. */
1938 DEBUG_c(PerlIO_printf(Perl_debug_log,
1939 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1944 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1945 but the cast (NV)IV_MIN rounds to a the value less (more
1946 negative) than IV_MIN which happens to be equal to SvNVX ??
1947 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1948 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1949 (NV)UVX == NVX are both true, but the values differ. :-(
1950 Hopefully for 2s complement IV_MIN is something like
1951 0x8000000000000000 which will be exact. NWC */
1954 SvUV_set(sv, U_V(SvNVX(sv)));
1956 (SvNVX(sv) == (NV) SvUVX(sv))
1957 #ifndef NV_PRESERVES_UV
1958 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1959 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1960 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1961 /* Don't flag it as "accurately an integer" if the number
1962 came from a (by definition imprecise) NV operation, and
1963 we're outside the range of NV integer precision */
1968 DEBUG_c(PerlIO_printf(Perl_debug_log,
1969 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1975 else if (SvPOKp(sv) && SvLEN(sv)) {
1977 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1978 /* We want to avoid a possible problem when we cache an IV/ a UV which
1979 may be later translated to an NV, and the resulting NV is not
1980 the same as the direct translation of the initial string
1981 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1982 be careful to ensure that the value with the .456 is around if the
1983 NV value is requested in the future).
1985 This means that if we cache such an IV/a UV, we need to cache the
1986 NV as well. Moreover, we trade speed for space, and do not
1987 cache the NV if we are sure it's not needed.
1990 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1991 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1992 == IS_NUMBER_IN_UV) {
1993 /* It's definitely an integer, only upgrade to PVIV */
1994 if (SvTYPE(sv) < SVt_PVIV)
1995 sv_upgrade(sv, SVt_PVIV);
1997 } else if (SvTYPE(sv) < SVt_PVNV)
1998 sv_upgrade(sv, SVt_PVNV);
2000 /* If NVs preserve UVs then we only use the UV value if we know that
2001 we aren't going to call atof() below. If NVs don't preserve UVs
2002 then the value returned may have more precision than atof() will
2003 return, even though value isn't perfectly accurate. */
2004 if ((numtype & (IS_NUMBER_IN_UV
2005 #ifdef NV_PRESERVES_UV
2008 )) == IS_NUMBER_IN_UV) {
2009 /* This won't turn off the public IOK flag if it was set above */
2010 (void)SvIOKp_on(sv);
2012 if (!(numtype & IS_NUMBER_NEG)) {
2014 if (value <= (UV)IV_MAX) {
2015 SvIV_set(sv, (IV)value);
2017 /* it didn't overflow, and it was positive. */
2018 SvUV_set(sv, value);
2022 /* 2s complement assumption */
2023 if (value <= (UV)IV_MIN) {
2024 SvIV_set(sv, -(IV)value);
2026 /* Too negative for an IV. This is a double upgrade, but
2027 I'm assuming it will be rare. */
2028 if (SvTYPE(sv) < SVt_PVNV)
2029 sv_upgrade(sv, SVt_PVNV);
2033 SvNV_set(sv, -(NV)value);
2034 SvIV_set(sv, IV_MIN);
2038 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2039 will be in the previous block to set the IV slot, and the next
2040 block to set the NV slot. So no else here. */
2042 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2043 != IS_NUMBER_IN_UV) {
2044 /* It wasn't an (integer that doesn't overflow the UV). */
2045 SvNV_set(sv, Atof(SvPVX_const(sv)));
2047 if (! numtype && ckWARN(WARN_NUMERIC))
2050 #if defined(USE_LONG_DOUBLE)
2051 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2052 PTR2UV(sv), SvNVX(sv)));
2054 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2055 PTR2UV(sv), SvNVX(sv)));
2058 #ifdef NV_PRESERVES_UV
2059 (void)SvIOKp_on(sv);
2061 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2062 SvIV_set(sv, I_V(SvNVX(sv)));
2063 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2066 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2068 /* UV will not work better than IV */
2070 if (SvNVX(sv) > (NV)UV_MAX) {
2072 /* Integer is inaccurate. NOK, IOKp, is UV */
2073 SvUV_set(sv, UV_MAX);
2075 SvUV_set(sv, U_V(SvNVX(sv)));
2076 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2077 NV preservse UV so can do correct comparison. */
2078 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2081 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2086 #else /* NV_PRESERVES_UV */
2087 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2088 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2089 /* The IV/UV slot will have been set from value returned by
2090 grok_number above. The NV slot has just been set using
2093 assert (SvIOKp(sv));
2095 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2096 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2097 /* Small enough to preserve all bits. */
2098 (void)SvIOKp_on(sv);
2100 SvIV_set(sv, I_V(SvNVX(sv)));
2101 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2103 /* Assumption: first non-preserved integer is < IV_MAX,
2104 this NV is in the preserved range, therefore: */
2105 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2107 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);
2111 0 0 already failed to read UV.
2112 0 1 already failed to read UV.
2113 1 0 you won't get here in this case. IV/UV
2114 slot set, public IOK, Atof() unneeded.
2115 1 1 already read UV.
2116 so there's no point in sv_2iuv_non_preserve() attempting
2117 to use atol, strtol, strtoul etc. */
2118 sv_2iuv_non_preserve (sv, numtype);
2121 #endif /* NV_PRESERVES_UV */
2125 if (isGV_with_GP(sv))
2126 return glob_2number((GV *)sv);
2128 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2129 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2132 if (SvTYPE(sv) < SVt_IV)
2133 /* Typically the caller expects that sv_any is not NULL now. */
2134 sv_upgrade(sv, SVt_IV);
2135 /* Return 0 from the caller. */
2142 =for apidoc sv_2iv_flags
2144 Return the integer value of an SV, doing any necessary string
2145 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2146 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2152 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2157 if (SvGMAGICAL(sv)) {
2158 if (flags & SV_GMAGIC)
2163 return I_V(SvNVX(sv));
2165 if (SvPOKp(sv) && SvLEN(sv)) {
2168 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2170 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2171 == IS_NUMBER_IN_UV) {
2172 /* It's definitely an integer */
2173 if (numtype & IS_NUMBER_NEG) {
2174 if (value < (UV)IV_MIN)
2177 if (value < (UV)IV_MAX)
2182 if (ckWARN(WARN_NUMERIC))
2185 return I_V(Atof(SvPVX_const(sv)));
2190 assert(SvTYPE(sv) >= SVt_PVMG);
2191 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2192 } else if (SvTHINKFIRST(sv)) {
2196 SV * const tmpstr=AMG_CALLun(sv,numer);
2197 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2198 return SvIV(tmpstr);
2201 return PTR2IV(SvRV(sv));
2204 sv_force_normal_flags(sv, 0);
2206 if (SvREADONLY(sv) && !SvOK(sv)) {
2207 if (ckWARN(WARN_UNINITIALIZED))
2213 if (S_sv_2iuv_common(aTHX_ sv))
2216 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2217 PTR2UV(sv),SvIVX(sv)));
2218 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2222 =for apidoc sv_2uv_flags
2224 Return the unsigned integer value of an SV, doing any necessary string
2225 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2226 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2232 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2237 if (SvGMAGICAL(sv)) {
2238 if (flags & SV_GMAGIC)
2243 return U_V(SvNVX(sv));
2244 if (SvPOKp(sv) && SvLEN(sv)) {
2247 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2249 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2250 == IS_NUMBER_IN_UV) {
2251 /* It's definitely an integer */
2252 if (!(numtype & IS_NUMBER_NEG))
2256 if (ckWARN(WARN_NUMERIC))
2259 return U_V(Atof(SvPVX_const(sv)));
2264 assert(SvTYPE(sv) >= SVt_PVMG);
2265 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2266 } else if (SvTHINKFIRST(sv)) {
2270 SV *const tmpstr = AMG_CALLun(sv,numer);
2271 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2272 return SvUV(tmpstr);
2275 return PTR2UV(SvRV(sv));
2278 sv_force_normal_flags(sv, 0);
2280 if (SvREADONLY(sv) && !SvOK(sv)) {
2281 if (ckWARN(WARN_UNINITIALIZED))
2287 if (S_sv_2iuv_common(aTHX_ sv))
2291 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2292 PTR2UV(sv),SvUVX(sv)));
2293 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2299 Return the num value of an SV, doing any necessary string or integer
2300 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2307 Perl_sv_2nv(pTHX_ register SV *sv)
2312 if (SvGMAGICAL(sv)) {
2316 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2317 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2318 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2320 return Atof(SvPVX_const(sv));
2324 return (NV)SvUVX(sv);
2326 return (NV)SvIVX(sv);
2331 assert(SvTYPE(sv) >= SVt_PVMG);
2332 /* This falls through to the report_uninit near the end of the
2334 } else if (SvTHINKFIRST(sv)) {
2338 SV *const tmpstr = AMG_CALLun(sv,numer);
2339 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2340 return SvNV(tmpstr);
2343 return PTR2NV(SvRV(sv));
2346 sv_force_normal_flags(sv, 0);
2348 if (SvREADONLY(sv) && !SvOK(sv)) {
2349 if (ckWARN(WARN_UNINITIALIZED))
2354 if (SvTYPE(sv) < SVt_NV) {
2355 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2356 sv_upgrade(sv, SVt_NV);
2357 #ifdef USE_LONG_DOUBLE
2359 STORE_NUMERIC_LOCAL_SET_STANDARD();
2360 PerlIO_printf(Perl_debug_log,
2361 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2362 PTR2UV(sv), SvNVX(sv));
2363 RESTORE_NUMERIC_LOCAL();
2367 STORE_NUMERIC_LOCAL_SET_STANDARD();
2368 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2369 PTR2UV(sv), SvNVX(sv));
2370 RESTORE_NUMERIC_LOCAL();
2374 else if (SvTYPE(sv) < SVt_PVNV)
2375 sv_upgrade(sv, SVt_PVNV);
2380 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2381 #ifdef NV_PRESERVES_UV
2384 /* Only set the public NV OK flag if this NV preserves the IV */
2385 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2386 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2387 : (SvIVX(sv) == I_V(SvNVX(sv))))
2393 else if (SvPOKp(sv) && SvLEN(sv)) {
2395 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2396 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2398 #ifdef NV_PRESERVES_UV
2399 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2400 == IS_NUMBER_IN_UV) {
2401 /* It's definitely an integer */
2402 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2404 SvNV_set(sv, Atof(SvPVX_const(sv)));
2407 SvNV_set(sv, Atof(SvPVX_const(sv)));
2408 /* Only set the public NV OK flag if this NV preserves the value in
2409 the PV at least as well as an IV/UV would.
2410 Not sure how to do this 100% reliably. */
2411 /* if that shift count is out of range then Configure's test is
2412 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2414 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2415 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2416 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2417 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2418 /* Can't use strtol etc to convert this string, so don't try.
2419 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2422 /* value has been set. It may not be precise. */
2423 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2424 /* 2s complement assumption for (UV)IV_MIN */
2425 SvNOK_on(sv); /* Integer is too negative. */
2430 if (numtype & IS_NUMBER_NEG) {
2431 SvIV_set(sv, -(IV)value);
2432 } else if (value <= (UV)IV_MAX) {
2433 SvIV_set(sv, (IV)value);
2435 SvUV_set(sv, value);
2439 if (numtype & IS_NUMBER_NOT_INT) {
2440 /* I believe that even if the original PV had decimals,
2441 they are lost beyond the limit of the FP precision.
2442 However, neither is canonical, so both only get p
2443 flags. NWC, 2000/11/25 */
2444 /* Both already have p flags, so do nothing */
2446 const NV nv = SvNVX(sv);
2447 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2448 if (SvIVX(sv) == I_V(nv)) {
2451 /* It had no "." so it must be integer. */
2455 /* between IV_MAX and NV(UV_MAX).
2456 Could be slightly > UV_MAX */
2458 if (numtype & IS_NUMBER_NOT_INT) {
2459 /* UV and NV both imprecise. */
2461 const UV nv_as_uv = U_V(nv);
2463 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2472 #endif /* NV_PRESERVES_UV */
2475 if (isGV_with_GP(sv)) {
2476 glob_2number((GV *)sv);
2480 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2482 assert (SvTYPE(sv) >= SVt_NV);
2483 /* Typically the caller expects that sv_any is not NULL now. */
2484 /* XXX Ilya implies that this is a bug in callers that assume this
2485 and ideally should be fixed. */
2488 #if defined(USE_LONG_DOUBLE)
2490 STORE_NUMERIC_LOCAL_SET_STANDARD();
2491 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2492 PTR2UV(sv), SvNVX(sv));
2493 RESTORE_NUMERIC_LOCAL();
2497 STORE_NUMERIC_LOCAL_SET_STANDARD();
2498 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2499 PTR2UV(sv), SvNVX(sv));
2500 RESTORE_NUMERIC_LOCAL();
2506 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2507 * UV as a string towards the end of buf, and return pointers to start and
2510 * We assume that buf is at least TYPE_CHARS(UV) long.
2514 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2516 char *ptr = buf + TYPE_CHARS(UV);
2517 char * const ebuf = ptr;
2530 *--ptr = '0' + (char)(uv % 10);
2538 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2539 * a regexp to its stringified form.
2543 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2545 const regexp * const re = (regexp *)mg->mg_obj;
2548 const char *fptr = "msix";
2553 bool need_newline = 0;
2554 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2556 while((ch = *fptr++)) {
2558 reflags[left++] = ch;
2561 reflags[right--] = ch;
2566 reflags[left] = '-';
2570 mg->mg_len = re->prelen + 4 + left;
2572 * If /x was used, we have to worry about a regex ending with a
2573 * comment later being embedded within another regex. If so, we don't
2574 * want this regex's "commentization" to leak out to the right part of
2575 * the enclosing regex, we must cap it with a newline.
2577 * So, if /x was used, we scan backwards from the end of the regex. If
2578 * we find a '#' before we find a newline, we need to add a newline
2579 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2580 * we don't need to add anything. -jfriedl
2582 if (PMf_EXTENDED & re->reganch) {
2583 const char *endptr = re->precomp + re->prelen;
2584 while (endptr >= re->precomp) {
2585 const char c = *(endptr--);
2587 break; /* don't need another */
2589 /* we end while in a comment, so we need a newline */
2590 mg->mg_len++; /* save space for it */
2591 need_newline = 1; /* note to add it */
2597 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2598 mg->mg_ptr[0] = '(';
2599 mg->mg_ptr[1] = '?';
2600 Copy(reflags, mg->mg_ptr+2, left, char);
2601 *(mg->mg_ptr+left+2) = ':';
2602 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2604 mg->mg_ptr[mg->mg_len - 2] = '\n';
2605 mg->mg_ptr[mg->mg_len - 1] = ')';
2606 mg->mg_ptr[mg->mg_len] = 0;
2608 PL_reginterp_cnt += re->program[0].next_off;
2610 if (re->reganch & ROPT_UTF8)
2620 =for apidoc sv_2pv_flags
2622 Returns a pointer to the string value of an SV, and sets *lp to its length.
2623 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2625 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2626 usually end up here too.
2632 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2642 if (SvGMAGICAL(sv)) {
2643 if (flags & SV_GMAGIC)
2648 if (flags & SV_MUTABLE_RETURN)
2649 return SvPVX_mutable(sv);
2650 if (flags & SV_CONST_RETURN)
2651 return (char *)SvPVX_const(sv);
2654 if (SvIOKp(sv) || SvNOKp(sv)) {
2655 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2659 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2660 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2662 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2669 #ifdef FIXNEGATIVEZERO
2670 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2676 SvUPGRADE(sv, SVt_PV);
2679 s = SvGROW_mutable(sv, len + 1);
2682 return memcpy(s, tbuf, len + 1);
2688 assert(SvTYPE(sv) >= SVt_PVMG);
2689 /* This falls through to the report_uninit near the end of the
2691 } else if (SvTHINKFIRST(sv)) {
2695 SV *const tmpstr = AMG_CALLun(sv,string);
2696 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2698 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2702 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2703 if (flags & SV_CONST_RETURN) {
2704 pv = (char *) SvPVX_const(tmpstr);
2706 pv = (flags & SV_MUTABLE_RETURN)
2707 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2710 *lp = SvCUR(tmpstr);
2712 pv = sv_2pv_flags(tmpstr, lp, flags);
2724 const SV *const referent = (SV*)SvRV(sv);
2727 tsv = sv_2mortal(newSVpvs("NULLREF"));
2728 } else if (SvTYPE(referent) == SVt_PVMG
2729 && ((SvFLAGS(referent) &
2730 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2731 == (SVs_OBJECT|SVs_SMG))
2732 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2733 return stringify_regexp(sv, mg, lp);
2735 const char *const typestr = sv_reftype(referent, 0);
2737 tsv = sv_newmortal();
2738 if (SvOBJECT(referent)) {
2739 const char *const name = HvNAME_get(SvSTASH(referent));
2740 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2741 name ? name : "__ANON__" , typestr,
2745 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2753 if (SvREADONLY(sv) && !SvOK(sv)) {
2754 if (ckWARN(WARN_UNINITIALIZED))
2761 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2762 /* I'm assuming that if both IV and NV are equally valid then
2763 converting the IV is going to be more efficient */
2764 const U32 isIOK = SvIOK(sv);
2765 const U32 isUIOK = SvIsUV(sv);
2766 char buf[TYPE_CHARS(UV)];
2769 if (SvTYPE(sv) < SVt_PVIV)
2770 sv_upgrade(sv, SVt_PVIV);
2771 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2772 /* inlined from sv_setpvn */
2773 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2774 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2775 SvCUR_set(sv, ebuf - ptr);
2785 else if (SvNOKp(sv)) {
2786 const int olderrno = errno;
2787 if (SvTYPE(sv) < SVt_PVNV)
2788 sv_upgrade(sv, SVt_PVNV);
2789 /* The +20 is pure guesswork. Configure test needed. --jhi */
2790 s = SvGROW_mutable(sv, NV_DIG + 20);
2791 /* some Xenix systems wipe out errno here */
2793 if (SvNVX(sv) == 0.0)
2794 (void)strcpy(s,"0");
2798 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2801 #ifdef FIXNEGATIVEZERO
2802 if (*s == '-' && s[1] == '0' && !s[2])
2812 if (isGV_with_GP(sv))
2813 return glob_2pv((GV *)sv, lp);
2815 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2819 if (SvTYPE(sv) < SVt_PV)
2820 /* Typically the caller expects that sv_any is not NULL now. */
2821 sv_upgrade(sv, SVt_PV);
2825 const STRLEN len = s - SvPVX_const(sv);
2831 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2832 PTR2UV(sv),SvPVX_const(sv)));
2833 if (flags & SV_CONST_RETURN)
2834 return (char *)SvPVX_const(sv);
2835 if (flags & SV_MUTABLE_RETURN)
2836 return SvPVX_mutable(sv);
2841 =for apidoc sv_copypv
2843 Copies a stringified representation of the source SV into the
2844 destination SV. Automatically performs any necessary mg_get and
2845 coercion of numeric values into strings. Guaranteed to preserve
2846 UTF-8 flag even from overloaded objects. Similar in nature to
2847 sv_2pv[_flags] but operates directly on an SV instead of just the
2848 string. Mostly uses sv_2pv_flags to do its work, except when that
2849 would lose the UTF-8'ness of the PV.
2855 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2858 const char * const s = SvPV_const(ssv,len);
2859 sv_setpvn(dsv,s,len);
2867 =for apidoc sv_2pvbyte
2869 Return a pointer to the byte-encoded representation of the SV, and set *lp
2870 to its length. May cause the SV to be downgraded from UTF-8 as a
2873 Usually accessed via the C<SvPVbyte> macro.
2879 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2881 sv_utf8_downgrade(sv,0);
2882 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2886 =for apidoc sv_2pvutf8
2888 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2889 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2891 Usually accessed via the C<SvPVutf8> macro.
2897 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2899 sv_utf8_upgrade(sv);
2900 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2905 =for apidoc sv_2bool
2907 This function is only called on magical items, and is only used by
2908 sv_true() or its macro equivalent.
2914 Perl_sv_2bool(pTHX_ register SV *sv)
2923 SV * const tmpsv = AMG_CALLun(sv,bool_);
2924 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2925 return (bool)SvTRUE(tmpsv);
2927 return SvRV(sv) != 0;
2930 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2932 (*sv->sv_u.svu_pv > '0' ||
2933 Xpvtmp->xpv_cur > 1 ||
2934 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2941 return SvIVX(sv) != 0;
2944 return SvNVX(sv) != 0.0;
2946 if (isGV_with_GP(sv))
2956 =for apidoc sv_utf8_upgrade
2958 Converts the PV of an SV to its UTF-8-encoded form.
2959 Forces the SV to string form if it is not already.
2960 Always sets the SvUTF8 flag to avoid future validity checks even
2961 if all the bytes have hibit clear.
2963 This is not as a general purpose byte encoding to Unicode interface:
2964 use the Encode extension for that.
2966 =for apidoc sv_utf8_upgrade_flags
2968 Converts the PV of an SV to its UTF-8-encoded form.
2969 Forces the SV to string form if it is not already.
2970 Always sets the SvUTF8 flag to avoid future validity checks even
2971 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2972 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2973 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2975 This is not as a general purpose byte encoding to Unicode interface:
2976 use the Encode extension for that.
2982 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2985 if (sv == &PL_sv_undef)
2989 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2990 (void) sv_2pv_flags(sv,&len, flags);
2994 (void) SvPV_force(sv,len);
3003 sv_force_normal_flags(sv, 0);
3006 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3007 sv_recode_to_utf8(sv, PL_encoding);
3008 else { /* Assume Latin-1/EBCDIC */
3009 /* This function could be much more efficient if we
3010 * had a FLAG in SVs to signal if there are any hibit
3011 * chars in the PV. Given that there isn't such a flag
3012 * make the loop as fast as possible. */
3013 const U8 * const s = (U8 *) SvPVX_const(sv);
3014 const U8 * const e = (U8 *) SvEND(sv);
3019 /* Check for hi bit */
3020 if (!NATIVE_IS_INVARIANT(ch)) {
3021 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3022 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3024 SvPV_free(sv); /* No longer using what was there before. */
3025 SvPV_set(sv, (char*)recoded);
3026 SvCUR_set(sv, len - 1);
3027 SvLEN_set(sv, len); /* No longer know the real size. */
3031 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3038 =for apidoc sv_utf8_downgrade
3040 Attempts to convert the PV of an SV from characters to bytes.
3041 If the PV contains a character beyond byte, this conversion will fail;
3042 in this case, either returns false or, if C<fail_ok> is not
3045 This is not as a general purpose Unicode to byte encoding interface:
3046 use the Encode extension for that.
3052 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3055 if (SvPOKp(sv) && SvUTF8(sv)) {
3061 sv_force_normal_flags(sv, 0);
3063 s = (U8 *) SvPV(sv, len);
3064 if (!utf8_to_bytes(s, &len)) {
3069 Perl_croak(aTHX_ "Wide character in %s",
3072 Perl_croak(aTHX_ "Wide character");
3083 =for apidoc sv_utf8_encode
3085 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3086 flag off so that it looks like octets again.
3092 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3094 (void) sv_utf8_upgrade(sv);
3096 sv_force_normal_flags(sv, 0);
3098 if (SvREADONLY(sv)) {
3099 Perl_croak(aTHX_ PL_no_modify);
3105 =for apidoc sv_utf8_decode
3107 If the PV of the SV is an octet sequence in UTF-8
3108 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3109 so that it looks like a character. If the PV contains only single-byte
3110 characters, the C<SvUTF8> flag stays being off.
3111 Scans PV for validity and returns false if the PV is invalid UTF-8.
3117 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3123 /* The octets may have got themselves encoded - get them back as
3126 if (!sv_utf8_downgrade(sv, TRUE))
3129 /* it is actually just a matter of turning the utf8 flag on, but
3130 * we want to make sure everything inside is valid utf8 first.
3132 c = (const U8 *) SvPVX_const(sv);
3133 if (!is_utf8_string(c, SvCUR(sv)+1))
3135 e = (const U8 *) SvEND(sv);
3138 if (!UTF8_IS_INVARIANT(ch)) {
3148 =for apidoc sv_setsv
3150 Copies the contents of the source SV C<ssv> into the destination SV
3151 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3152 function if the source SV needs to be reused. Does not handle 'set' magic.
3153 Loosely speaking, it performs a copy-by-value, obliterating any previous
3154 content of the destination.
3156 You probably want to use one of the assortment of wrappers, such as
3157 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3158 C<SvSetMagicSV_nosteal>.
3160 =for apidoc sv_setsv_flags
3162 Copies the contents of the source SV C<ssv> into the destination SV
3163 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3164 function if the source SV needs to be reused. Does not handle 'set' magic.
3165 Loosely speaking, it performs a copy-by-value, obliterating any previous
3166 content of the destination.
3167 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3168 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3169 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3170 and C<sv_setsv_nomg> are implemented in terms of this function.
3172 You probably want to use one of the assortment of wrappers, such as
3173 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3174 C<SvSetMagicSV_nosteal>.
3176 This is the primary function for copying scalars, and most other
3177 copy-ish functions and macros use this underneath.
3183 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3185 if (dtype != SVt_PVGV) {
3186 const char * const name = GvNAME(sstr);
3187 const STRLEN len = GvNAMELEN(sstr);
3188 /* don't upgrade SVt_PVLV: it can hold a glob */
3189 if (dtype != SVt_PVLV) {
3190 if (dtype >= SVt_PV) {
3196 sv_upgrade(dstr, SVt_PVGV);
3197 (void)SvOK_off(dstr);
3200 GvSTASH(dstr) = GvSTASH(sstr);
3202 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3203 gv_name_set((GV *)dstr, name, len, GV_ADD);
3204 SvFAKE_on(dstr); /* can coerce to non-glob */
3207 #ifdef GV_UNIQUE_CHECK
3208 if (GvUNIQUE((GV*)dstr)) {
3209 Perl_croak(aTHX_ PL_no_modify);
3215 (void)SvOK_off(dstr);
3217 GvINTRO_off(dstr); /* one-shot flag */
3218 GvGP(dstr) = gp_ref(GvGP(sstr));
3219 if (SvTAINTED(sstr))
3221 if (GvIMPORTED(dstr) != GVf_IMPORTED
3222 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3224 GvIMPORTED_on(dstr);
3231 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3232 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3234 const int intro = GvINTRO(dstr);
3237 const U32 stype = SvTYPE(sref);
3240 #ifdef GV_UNIQUE_CHECK
3241 if (GvUNIQUE((GV*)dstr)) {
3242 Perl_croak(aTHX_ PL_no_modify);
3247 GvINTRO_off(dstr); /* one-shot flag */
3248 GvLINE(dstr) = CopLINE(PL_curcop);
3249 GvEGV(dstr) = (GV*)dstr;
3254 location = (SV **) &GvCV(dstr);
3255 import_flag = GVf_IMPORTED_CV;
3258 location = (SV **) &GvHV(dstr);
3259 import_flag = GVf_IMPORTED_HV;
3262 location = (SV **) &GvAV(dstr);
3263 import_flag = GVf_IMPORTED_AV;
3266 location = (SV **) &GvIOp(dstr);
3269 location = (SV **) &GvFORM(dstr);
3271 location = &GvSV(dstr);
3272 import_flag = GVf_IMPORTED_SV;
3275 if (stype == SVt_PVCV) {
3276 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3277 SvREFCNT_dec(GvCV(dstr));
3279 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280 PL_sub_generation++;
3283 SAVEGENERICSV(*location);
3287 if (stype == SVt_PVCV && *location != sref) {
3288 CV* const cv = (CV*)*location;
3290 if (!GvCVGEN((GV*)dstr) &&
3291 (CvROOT(cv) || CvXSUB(cv)))
3293 /* Redefining a sub - warning is mandatory if
3294 it was a const and its value changed. */
3295 if (CvCONST(cv) && CvCONST((CV*)sref)
3296 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3298 /* They are 2 constant subroutines generated from
3299 the same constant. This probably means that
3300 they are really the "same" proxy subroutine
3301 instantiated in 2 places. Most likely this is
3302 when a constant is exported twice. Don't warn.
3305 else if (ckWARN(WARN_REDEFINE)
3307 && (!CvCONST((CV*)sref)
3308 || sv_cmp(cv_const_sv(cv),
3309 cv_const_sv((CV*)sref))))) {
3310 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3312 ? "Constant subroutine %s::%s redefined"
3313 : "Subroutine %s::%s redefined",
3314 HvNAME_get(GvSTASH((GV*)dstr)),
3315 GvENAME((GV*)dstr));
3319 cv_ckproto_len(cv, (GV*)dstr,
3320 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3321 SvPOK(sref) ? SvCUR(sref) : 0);
3323 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3324 GvASSUMECV_on(dstr);
3325 PL_sub_generation++;
3328 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3329 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3330 GvFLAGS(dstr) |= import_flag;
3335 if (SvTAINTED(sstr))
3341 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3344 register U32 sflags;
3350 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3352 sstr = &PL_sv_undef;
3353 stype = SvTYPE(sstr);
3354 dtype = SvTYPE(dstr);
3359 /* need to nuke the magic */
3361 SvRMAGICAL_off(dstr);
3364 /* There's a lot of redundancy below but we're going for speed here */
3369 if (dtype != SVt_PVGV) {
3370 (void)SvOK_off(dstr);
3378 sv_upgrade(dstr, SVt_IV);
3383 sv_upgrade(dstr, SVt_PVIV);
3386 (void)SvIOK_only(dstr);
3387 SvIV_set(dstr, SvIVX(sstr));
3390 /* SvTAINTED can only be true if the SV has taint magic, which in
3391 turn means that the SV type is PVMG (or greater). This is the
3392 case statement for SVt_IV, so this cannot be true (whatever gcov
3394 assert(!SvTAINTED(sstr));
3404 sv_upgrade(dstr, SVt_NV);
3409 sv_upgrade(dstr, SVt_PVNV);
3412 SvNV_set(dstr, SvNVX(sstr));
3413 (void)SvNOK_only(dstr);
3414 /* SvTAINTED can only be true if the SV has taint magic, which in
3415 turn means that the SV type is PVMG (or greater). This is the
3416 case statement for SVt_NV, so this cannot be true (whatever gcov
3418 assert(!SvTAINTED(sstr));
3425 sv_upgrade(dstr, SVt_RV);
3428 #ifdef PERL_OLD_COPY_ON_WRITE
3429 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3430 if (dtype < SVt_PVIV)
3431 sv_upgrade(dstr, SVt_PVIV);
3438 sv_upgrade(dstr, SVt_PV);
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3445 if (dtype < SVt_PVNV)
3446 sv_upgrade(dstr, SVt_PVNV);
3450 const char * const type = sv_reftype(sstr,0);
3452 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3454 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3459 if (dtype <= SVt_PVGV) {
3460 glob_assign_glob(dstr, sstr, dtype);
3468 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3470 if ((int)SvTYPE(sstr) != stype) {
3471 stype = SvTYPE(sstr);
3472 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3473 glob_assign_glob(dstr, sstr, dtype);
3478 if (stype == SVt_PVLV)
3479 SvUPGRADE(dstr, SVt_PVNV);
3481 SvUPGRADE(dstr, (U32)stype);
3484 /* dstr may have been upgraded. */
3485 dtype = SvTYPE(dstr);
3486 sflags = SvFLAGS(sstr);
3488 if (sflags & SVf_ROK) {
3489 if (dtype == SVt_PVGV &&
3490 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3493 if (GvIMPORTED(dstr) != GVf_IMPORTED
3494 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3496 GvIMPORTED_on(dstr);
3501 glob_assign_glob(dstr, sstr, dtype);
3505 if (dtype >= SVt_PV) {
3506 if (dtype == SVt_PVGV) {
3507 glob_assign_ref(dstr, sstr);
3510 if (SvPVX_const(dstr)) {
3516 (void)SvOK_off(dstr);
3517 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3518 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3519 assert(!(sflags & SVp_NOK));
3520 assert(!(sflags & SVp_IOK));
3521 assert(!(sflags & SVf_NOK));
3522 assert(!(sflags & SVf_IOK));
3524 else if (dtype == SVt_PVGV) {
3525 if (!(sflags & SVf_OK)) {
3526 if (ckWARN(WARN_MISC))
3527 Perl_warner(aTHX_ packWARN(WARN_MISC),
3528 "Undefined value assigned to typeglob");
3531 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3532 if (dstr != (SV*)gv) {
3535 GvGP(dstr) = gp_ref(GvGP(gv));
3539 else if (sflags & SVp_POK) {
3543 * Check to see if we can just swipe the string. If so, it's a
3544 * possible small lose on short strings, but a big win on long ones.
3545 * It might even be a win on short strings if SvPVX_const(dstr)
3546 * has to be allocated and SvPVX_const(sstr) has to be freed.
3549 /* Whichever path we take through the next code, we want this true,
3550 and doing it now facilitates the COW check. */
3551 (void)SvPOK_only(dstr);
3554 /* We're not already COW */
3555 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3556 #ifndef PERL_OLD_COPY_ON_WRITE
3557 /* or we are, but dstr isn't a suitable target. */
3558 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3563 (sflags & SVs_TEMP) && /* slated for free anyway? */
3564 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3565 (!(flags & SV_NOSTEAL)) &&
3566 /* and we're allowed to steal temps */
3567 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3568 SvLEN(sstr) && /* and really is a string */
3569 /* and won't be needed again, potentially */
3570 !(PL_op && PL_op->op_type == OP_AASSIGN))
3571 #ifdef PERL_OLD_COPY_ON_WRITE
3572 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3573 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3574 && SvTYPE(sstr) >= SVt_PVIV)
3577 /* Failed the swipe test, and it's not a shared hash key either.
3578 Have to copy the string. */
3579 STRLEN len = SvCUR(sstr);
3580 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3581 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3582 SvCUR_set(dstr, len);
3583 *SvEND(dstr) = '\0';
3585 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3587 /* Either it's a shared hash key, or it's suitable for
3588 copy-on-write or we can swipe the string. */
3590 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3594 #ifdef PERL_OLD_COPY_ON_WRITE
3596 /* I believe I should acquire a global SV mutex if
3597 it's a COW sv (not a shared hash key) to stop
3598 it going un copy-on-write.
3599 If the source SV has gone un copy on write between up there
3600 and down here, then (assert() that) it is of the correct
3601 form to make it copy on write again */
3602 if ((sflags & (SVf_FAKE | SVf_READONLY))
3603 != (SVf_FAKE | SVf_READONLY)) {
3604 SvREADONLY_on(sstr);
3606 /* Make the source SV into a loop of 1.
3607 (about to become 2) */
3608 SV_COW_NEXT_SV_SET(sstr, sstr);
3612 /* Initial code is common. */
3613 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3618 /* making another shared SV. */
3619 STRLEN cur = SvCUR(sstr);
3620 STRLEN len = SvLEN(sstr);
3621 #ifdef PERL_OLD_COPY_ON_WRITE
3623 assert (SvTYPE(dstr) >= SVt_PVIV);
3624 /* SvIsCOW_normal */
3625 /* splice us in between source and next-after-source. */
3626 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3627 SV_COW_NEXT_SV_SET(sstr, dstr);
3628 SvPV_set(dstr, SvPVX_mutable(sstr));
3632 /* SvIsCOW_shared_hash */
3633 DEBUG_C(PerlIO_printf(Perl_debug_log,
3634 "Copy on write: Sharing hash\n"));
3636 assert (SvTYPE(dstr) >= SVt_PV);
3638 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3640 SvLEN_set(dstr, len);
3641 SvCUR_set(dstr, cur);
3642 SvREADONLY_on(dstr);
3644 /* Relesase a global SV mutex. */
3647 { /* Passes the swipe test. */
3648 SvPV_set(dstr, SvPVX_mutable(sstr));
3649 SvLEN_set(dstr, SvLEN(sstr));
3650 SvCUR_set(dstr, SvCUR(sstr));
3653 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3654 SvPV_set(sstr, NULL);
3660 if (sflags & SVp_NOK) {
3661 SvNV_set(dstr, SvNVX(sstr));
3663 if (sflags & SVp_IOK) {
3664 SvRELEASE_IVX(dstr);
3665 SvIV_set(dstr, SvIVX(sstr));
3666 /* Must do this otherwise some other overloaded use of 0x80000000
3667 gets confused. I guess SVpbm_VALID */
3668 if (sflags & SVf_IVisUV)
3671 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3674 const MAGIC * const smg = SvVOK(sstr);
3676 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3677 smg->mg_ptr, smg->mg_len);
3678 SvRMAGICAL_on(dstr);
3682 else if (sflags & (SVp_IOK|SVp_NOK)) {
3683 (void)SvOK_off(dstr);
3684 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3686 if (sflags & SVp_IOK) {
3687 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3688 SvIV_set(dstr, SvIVX(sstr));
3690 if (sflags & SVp_NOK) {
3691 SvNV_set(dstr, SvNVX(sstr));
3695 if (isGV_with_GP(sstr)) {
3696 /* This stringification rule for globs is spread in 3 places.
3697 This feels bad. FIXME. */
3698 const U32 wasfake = sflags & SVf_FAKE;
3700 /* FAKE globs can get coerced, so need to turn this off
3701 temporarily if it is on. */
3703 gv_efullname3(dstr, (GV *)sstr, "*");
3704 SvFLAGS(sstr) |= wasfake;
3705 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3708 (void)SvOK_off(dstr);
3710 if (SvTAINTED(sstr))
3715 =for apidoc sv_setsv_mg
3717 Like C<sv_setsv>, but also handles 'set' magic.
3723 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3725 sv_setsv(dstr,sstr);
3729 #ifdef PERL_OLD_COPY_ON_WRITE
3731 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3733 STRLEN cur = SvCUR(sstr);
3734 STRLEN len = SvLEN(sstr);
3735 register char *new_pv;
3738 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3746 if (SvTHINKFIRST(dstr))
3747 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3748 else if (SvPVX_const(dstr))
3749 Safefree(SvPVX_const(dstr));
3753 SvUPGRADE(dstr, SVt_PVIV);
3755 assert (SvPOK(sstr));
3756 assert (SvPOKp(sstr));
3757 assert (!SvIOK(sstr));
3758 assert (!SvIOKp(sstr));
3759 assert (!SvNOK(sstr));
3760 assert (!SvNOKp(sstr));
3762 if (SvIsCOW(sstr)) {
3764 if (SvLEN(sstr) == 0) {
3765 /* source is a COW shared hash key. */
3766 DEBUG_C(PerlIO_printf(Perl_debug_log,
3767 "Fast copy on write: Sharing hash\n"));
3768 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3771 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3773 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3774 SvUPGRADE(sstr, SVt_PVIV);
3775 SvREADONLY_on(sstr);
3777 DEBUG_C(PerlIO_printf(Perl_debug_log,
3778 "Fast copy on write: Converting sstr to COW\n"));
3779 SV_COW_NEXT_SV_SET(dstr, sstr);
3781 SV_COW_NEXT_SV_SET(sstr, dstr);
3782 new_pv = SvPVX_mutable(sstr);
3785 SvPV_set(dstr, new_pv);
3786 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3789 SvLEN_set(dstr, len);
3790 SvCUR_set(dstr, cur);
3799 =for apidoc sv_setpvn
3801 Copies a string into an SV. The C<len> parameter indicates the number of
3802 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3803 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3809 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3812 register char *dptr;
3814 SV_CHECK_THINKFIRST_COW_DROP(sv);
3820 /* len is STRLEN which is unsigned, need to copy to signed */
3823 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3825 SvUPGRADE(sv, SVt_PV);
3827 dptr = SvGROW(sv, len + 1);
3828 Move(ptr,dptr,len,char);
3831 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3836 =for apidoc sv_setpvn_mg
3838 Like C<sv_setpvn>, but also handles 'set' magic.
3844 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3846 sv_setpvn(sv,ptr,len);
3851 =for apidoc sv_setpv
3853 Copies a string into an SV. The string must be null-terminated. Does not
3854 handle 'set' magic. See C<sv_setpv_mg>.
3860 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3863 register STRLEN len;
3865 SV_CHECK_THINKFIRST_COW_DROP(sv);
3871 SvUPGRADE(sv, SVt_PV);
3873 SvGROW(sv, len + 1);
3874 Move(ptr,SvPVX(sv),len+1,char);
3876 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3881 =for apidoc sv_setpv_mg
3883 Like C<sv_setpv>, but also handles 'set' magic.
3889 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3896 =for apidoc sv_usepvn_flags
3898 Tells an SV to use C<ptr> to find its string value. Normally the
3899 string is stored inside the SV but sv_usepvn allows the SV to use an
3900 outside string. The C<ptr> should point to memory that was allocated
3901 by C<malloc>. The string length, C<len>, must be supplied. By default
3902 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3903 so that pointer should not be freed or used by the programmer after
3904 giving it to sv_usepvn, and neither should any pointers from "behind"
3905 that pointer (e.g. ptr + 1) be used.
3907 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3908 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3909 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3910 C<len>, and already meets the requirements for storing in C<SvPVX>)
3916 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3920 SV_CHECK_THINKFIRST_COW_DROP(sv);
3921 SvUPGRADE(sv, SVt_PV);
3924 if (flags & SV_SMAGIC)
3928 if (SvPVX_const(sv))
3931 if (flags & SV_HAS_TRAILING_NUL)
3932 assert(ptr[len] == '\0');
3934 allocate = (flags & SV_HAS_TRAILING_NUL)
3935 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3936 if (flags & SV_HAS_TRAILING_NUL) {
3937 /* It's long enough - do nothing.
3938 Specfically Perl_newCONSTSUB is relying on this. */
3941 /* Force a move to shake out bugs in callers. */
3942 char *new_ptr = safemalloc(allocate);
3943 Copy(ptr, new_ptr, len, char);
3944 PoisonFree(ptr,len,char);
3948 ptr = saferealloc (ptr, allocate);
3953 SvLEN_set(sv, allocate);
3954 if (!(flags & SV_HAS_TRAILING_NUL)) {
3957 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3959 if (flags & SV_SMAGIC)
3963 #ifdef PERL_OLD_COPY_ON_WRITE
3964 /* Need to do this *after* making the SV normal, as we need the buffer
3965 pointer to remain valid until after we've copied it. If we let go too early,
3966 another thread could invalidate it by unsharing last of the same hash key
3967 (which it can do by means other than releasing copy-on-write Svs)
3968 or by changing the other copy-on-write SVs in the loop. */
3970 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3972 if (len) { /* this SV was SvIsCOW_normal(sv) */
3973 /* we need to find the SV pointing to us. */
3974 SV *current = SV_COW_NEXT_SV(after);
3976 if (current == sv) {
3977 /* The SV we point to points back to us (there were only two of us
3979 Hence other SV is no longer copy on write either. */
3981 SvREADONLY_off(after);
3983 /* We need to follow the pointers around the loop. */
3985 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3988 /* don't loop forever if the structure is bust, and we have
3989 a pointer into a closed loop. */
3990 assert (current != after);
3991 assert (SvPVX_const(current) == pvx);
3993 /* Make the SV before us point to the SV after us. */
3994 SV_COW_NEXT_SV_SET(current, after);
3997 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4002 Perl_sv_release_IVX(pTHX_ register SV *sv)
4005 sv_force_normal_flags(sv, 0);
4011 =for apidoc sv_force_normal_flags
4013 Undo various types of fakery on an SV: if the PV is a shared string, make
4014 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4015 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4016 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4017 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4018 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4019 set to some other value.) In addition, the C<flags> parameter gets passed to
4020 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4021 with flags set to 0.
4027 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4030 #ifdef PERL_OLD_COPY_ON_WRITE
4031 if (SvREADONLY(sv)) {
4032 /* At this point I believe I should acquire a global SV mutex. */
4034 const char * const pvx = SvPVX_const(sv);
4035 const STRLEN len = SvLEN(sv);
4036 const STRLEN cur = SvCUR(sv);
4037 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4039 PerlIO_printf(Perl_debug_log,
4040 "Copy on write: Force normal %ld\n",
4046 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4049 if (flags & SV_COW_DROP_PV) {
4050 /* OK, so we don't need to copy our buffer. */
4053 SvGROW(sv, cur + 1);
4054 Move(pvx,SvPVX(sv),cur,char);
4058 sv_release_COW(sv, pvx, len, next);
4063 else if (IN_PERL_RUNTIME)
4064 Perl_croak(aTHX_ PL_no_modify);
4065 /* At this point I believe that I can drop the global SV mutex. */
4068 if (SvREADONLY(sv)) {
4070 const char * const pvx = SvPVX_const(sv);
4071 const STRLEN len = SvCUR(sv);
4076 SvGROW(sv, len + 1);
4077 Move(pvx,SvPVX(sv),len,char);
4079 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4081 else if (IN_PERL_RUNTIME)
4082 Perl_croak(aTHX_ PL_no_modify);
4086 sv_unref_flags(sv, flags);
4087 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4094 Efficient removal of characters from the beginning of the string buffer.
4095 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4096 the string buffer. The C<ptr> becomes the first character of the adjusted
4097 string. Uses the "OOK hack".
4098 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4099 refer to the same chunk of data.
4105 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4107 register STRLEN delta;
4108 if (!ptr || !SvPOKp(sv))
4110 delta = ptr - SvPVX_const(sv);
4111 SV_CHECK_THINKFIRST(sv);
4112 if (SvTYPE(sv) < SVt_PVIV)
4113 sv_upgrade(sv,SVt_PVIV);
4116 if (!SvLEN(sv)) { /* make copy of shared string */
4117 const char *pvx = SvPVX_const(sv);
4118 const STRLEN len = SvCUR(sv);
4119 SvGROW(sv, len + 1);
4120 Move(pvx,SvPVX(sv),len,char);
4124 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4125 and we do that anyway inside the SvNIOK_off
4127 SvFLAGS(sv) |= SVf_OOK;
4130 SvLEN_set(sv, SvLEN(sv) - delta);
4131 SvCUR_set(sv, SvCUR(sv) - delta);
4132 SvPV_set(sv, SvPVX(sv) + delta);
4133 SvIV_set(sv, SvIVX(sv) + delta);
4137 =for apidoc sv_catpvn
4139 Concatenates the string onto the end of the string which is in the SV. The
4140 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4141 status set, then the bytes appended should be valid UTF-8.
4142 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4144 =for apidoc sv_catpvn_flags
4146 Concatenates the string onto the end of the string which is in the SV. The
4147 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4148 status set, then the bytes appended should be valid UTF-8.
4149 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4150 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4151 in terms of this function.
4157 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4161 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4163 SvGROW(dsv, dlen + slen + 1);
4165 sstr = SvPVX_const(dsv);
4166 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4167 SvCUR_set(dsv, SvCUR(dsv) + slen);
4169 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4171 if (flags & SV_SMAGIC)
4176 =for apidoc sv_catsv
4178 Concatenates the string from SV C<ssv> onto the end of the string in
4179 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4180 not 'set' magic. See C<sv_catsv_mg>.
4182 =for apidoc sv_catsv_flags
4184 Concatenates the string from SV C<ssv> onto the end of the string in
4185 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4186 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4187 and C<sv_catsv_nomg> are implemented in terms of this function.
4192 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4197 const char *spv = SvPV_const(ssv, slen);
4199 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4200 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4201 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4202 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4203 dsv->sv_flags doesn't have that bit set.
4204 Andy Dougherty 12 Oct 2001
4206 const I32 sutf8 = DO_UTF8(ssv);
4209 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4211 dutf8 = DO_UTF8(dsv);
4213 if (dutf8 != sutf8) {
4215 /* Not modifying source SV, so taking a temporary copy. */
4216 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4218 sv_utf8_upgrade(csv);
4219 spv = SvPV_const(csv, slen);
4222 sv_utf8_upgrade_nomg(dsv);
4224 sv_catpvn_nomg(dsv, spv, slen);
4227 if (flags & SV_SMAGIC)
4232 =for apidoc sv_catpv
4234 Concatenates the string onto the end of the string which is in the SV.
4235 If the SV has the UTF-8 status set, then the bytes appended should be
4236 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4241 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4244 register STRLEN len;
4250 junk = SvPV_force(sv, tlen);
4252 SvGROW(sv, tlen + len + 1);
4254 ptr = SvPVX_const(sv);
4255 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4256 SvCUR_set(sv, SvCUR(sv) + len);
4257 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4262 =for apidoc sv_catpv_mg
4264 Like C<sv_catpv>, but also handles 'set' magic.
4270 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4279 Creates a new SV. A non-zero C<len> parameter indicates the number of
4280 bytes of preallocated string space the SV should have. An extra byte for a
4281 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4282 space is allocated.) The reference count for the new SV is set to 1.
4284 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4285 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4286 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4287 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4288 modules supporting older perls.
4294 Perl_newSV(pTHX_ STRLEN len)
4301 sv_upgrade(sv, SVt_PV);
4302 SvGROW(sv, len + 1);
4307 =for apidoc sv_magicext
4309 Adds magic to an SV, upgrading it if necessary. Applies the
4310 supplied vtable and returns a pointer to the magic added.
4312 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4313 In particular, you can add magic to SvREADONLY SVs, and add more than
4314 one instance of the same 'how'.
4316 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4317 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4318 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4319 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4321 (This is now used as a subroutine by C<sv_magic>.)
4326 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4327 const char* name, I32 namlen)
4332 if (SvTYPE(sv) < SVt_PVMG) {
4333 SvUPGRADE(sv, SVt_PVMG);
4335 Newxz(mg, 1, MAGIC);
4336 mg->mg_moremagic = SvMAGIC(sv);
4337 SvMAGIC_set(sv, mg);
4339 /* Sometimes a magic contains a reference loop, where the sv and
4340 object refer to each other. To prevent a reference loop that
4341 would prevent such objects being freed, we look for such loops
4342 and if we find one we avoid incrementing the object refcount.
4344 Note we cannot do this to avoid self-tie loops as intervening RV must
4345 have its REFCNT incremented to keep it in existence.
4348 if (!obj || obj == sv ||
4349 how == PERL_MAGIC_arylen ||
4350 how == PERL_MAGIC_qr ||
4351 how == PERL_MAGIC_symtab ||
4352 (SvTYPE(obj) == SVt_PVGV &&
4353 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4354 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4355 GvFORM(obj) == (CV*)sv)))
4360 mg->mg_obj = SvREFCNT_inc_simple(obj);
4361 mg->mg_flags |= MGf_REFCOUNTED;
4364 /* Normal self-ties simply pass a null object, and instead of
4365 using mg_obj directly, use the SvTIED_obj macro to produce a
4366 new RV as needed. For glob "self-ties", we are tieing the PVIO
4367 with an RV obj pointing to the glob containing the PVIO. In
4368 this case, to avoid a reference loop, we need to weaken the
4372 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4373 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4379 mg->mg_len = namlen;
4382 mg->mg_ptr = savepvn(name, namlen);
4383 else if (namlen == HEf_SVKEY)
4384 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4386 mg->mg_ptr = (char *) name;
4388 mg->mg_virtual = vtable;
4392 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4397 =for apidoc sv_magic
4399 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4400 then adds a new magic item of type C<how> to the head of the magic list.
4402 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4403 handling of the C<name> and C<namlen> arguments.
4405 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4406 to add more than one instance of the same 'how'.
4412 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4418 #ifdef PERL_OLD_COPY_ON_WRITE
4420 sv_force_normal_flags(sv, 0);
4422 if (SvREADONLY(sv)) {
4424 /* its okay to attach magic to shared strings; the subsequent
4425 * upgrade to PVMG will unshare the string */
4426 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4429 && how != PERL_MAGIC_regex_global
4430 && how != PERL_MAGIC_bm
4431 && how != PERL_MAGIC_fm
4432 && how != PERL_MAGIC_sv
4433 && how != PERL_MAGIC_backref
4436 Perl_croak(aTHX_ PL_no_modify);
4439 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4440 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4441 /* sv_magic() refuses to add a magic of the same 'how' as an
4444 if (how == PERL_MAGIC_taint) {
4446 /* Any scalar which already had taint magic on which someone
4447 (erroneously?) did SvIOK_on() or similar will now be
4448 incorrectly sporting public "OK" flags. */
4449 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4457 vtable = &PL_vtbl_sv;
4459 case PERL_MAGIC_overload:
4460 vtable = &PL_vtbl_amagic;
4462 case PERL_MAGIC_overload_elem:
4463 vtable = &PL_vtbl_amagicelem;
4465 case PERL_MAGIC_overload_table:
4466 vtable = &PL_vtbl_ovrld;
4469 vtable = &PL_vtbl_bm;
4471 case PERL_MAGIC_regdata:
4472 vtable = &PL_vtbl_regdata;
4474 case PERL_MAGIC_regdatum:
4475 vtable = &PL_vtbl_regdatum;
4477 case PERL_MAGIC_env:
4478 vtable = &PL_vtbl_env;
4481 vtable = &PL_vtbl_fm;
4483 case PERL_MAGIC_envelem:
4484 vtable = &PL_vtbl_envelem;
4486 case PERL_MAGIC_regex_global:
4487 vtable = &PL_vtbl_mglob;
4489 case PERL_MAGIC_isa:
4490 vtable = &PL_vtbl_isa;
4492 case PERL_MAGIC_isaelem:
4493 vtable = &PL_vtbl_isaelem;
4495 case PERL_MAGIC_nkeys:
4496 vtable = &PL_vtbl_nkeys;
4498 case PERL_MAGIC_dbfile:
4501 case PERL_MAGIC_dbline:
4502 vtable = &PL_vtbl_dbline;
4504 #ifdef USE_LOCALE_COLLATE
4505 case PERL_MAGIC_collxfrm:
4506 vtable = &PL_vtbl_collxfrm;
4508 #endif /* USE_LOCALE_COLLATE */
4509 case PERL_MAGIC_tied:
4510 vtable = &PL_vtbl_pack;
4512 case PERL_MAGIC_tiedelem:
4513 case PERL_MAGIC_tiedscalar:
4514 vtable = &PL_vtbl_packelem;
4517 vtable = &PL_vtbl_regexp;
4519 case PERL_MAGIC_hints:
4520 /* As this vtable is all NULL, we can reuse it. */
4521 case PERL_MAGIC_sig:
4522 vtable = &PL_vtbl_sig;
4524 case PERL_MAGIC_sigelem:
4525 vtable = &PL_vtbl_sigelem;
4527 case PERL_MAGIC_taint:
4528 vtable = &PL_vtbl_taint;
4530 case PERL_MAGIC_uvar:
4531 vtable = &PL_vtbl_uvar;
4533 case PERL_MAGIC_vec:
4534 vtable = &PL_vtbl_vec;
4536 case PERL_MAGIC_arylen_p:
4537 case PERL_MAGIC_rhash:
4538 case PERL_MAGIC_symtab:
4539 case PERL_MAGIC_vstring:
4542 case PERL_MAGIC_utf8:
4543 vtable = &PL_vtbl_utf8;
4545 case PERL_MAGIC_substr:
4546 vtable = &PL_vtbl_substr;
4548 case PERL_MAGIC_defelem:
4549 vtable = &PL_vtbl_defelem;
4551 case PERL_MAGIC_arylen:
4552 vtable = &PL_vtbl_arylen;
4554 case PERL_MAGIC_pos:
4555 vtable = &PL_vtbl_pos;
4557 case PERL_MAGIC_backref:
4558 vtable = &PL_vtbl_backref;
4560 case PERL_MAGIC_hintselem:
4561 vtable = &PL_vtbl_hintselem;
4563 case PERL_MAGIC_ext:
4564 /* Reserved for use by extensions not perl internals. */
4565 /* Useful for attaching extension internal data to perl vars. */
4566 /* Note that multiple extensions may clash if magical scalars */
4567 /* etc holding private data from one are passed to another. */
4571 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4574 /* Rest of work is done else where */
4575 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4578 case PERL_MAGIC_taint:
4581 case PERL_MAGIC_ext:
4582 case PERL_MAGIC_dbfile:
4589 =for apidoc sv_unmagic
4591 Removes all magic of type C<type> from an SV.
4597 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4601 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4603 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4604 for (mg = *mgp; mg; mg = *mgp) {
4605 if (mg->mg_type == type) {
4606 const MGVTBL* const vtbl = mg->mg_virtual;
4607 *mgp = mg->mg_moremagic;
4608 if (vtbl && vtbl->svt_free)
4609 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4610 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4612 Safefree(mg->mg_ptr);
4613 else if (mg->mg_len == HEf_SVKEY)
4614 SvREFCNT_dec((SV*)mg->mg_ptr);
4615 else if (mg->mg_type == PERL_MAGIC_utf8)
4616 Safefree(mg->mg_ptr);
4618 if (mg->mg_flags & MGf_REFCOUNTED)
4619 SvREFCNT_dec(mg->mg_obj);
4623 mgp = &mg->mg_moremagic;
4627 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4628 SvMAGIC_set(sv, NULL);
4635 =for apidoc sv_rvweaken
4637 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4638 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4639 push a back-reference to this RV onto the array of backreferences
4640 associated with that magic.
4646 Perl_sv_rvweaken(pTHX_ SV *sv)
4649 if (!SvOK(sv)) /* let undefs pass */
4652 Perl_croak(aTHX_ "Can't weaken a nonreference");
4653 else if (SvWEAKREF(sv)) {
4654 if (ckWARN(WARN_MISC))
4655 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4659 Perl_sv_add_backref(aTHX_ tsv, sv);
4665 /* Give tsv backref magic if it hasn't already got it, then push a
4666 * back-reference to sv onto the array associated with the backref magic.
4670 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4675 if (SvTYPE(tsv) == SVt_PVHV) {
4676 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4680 /* There is no AV in the offical place - try a fixup. */
4681 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4684 /* Aha. They've got it stowed in magic. Bring it back. */
4685 av = (AV*)mg->mg_obj;
4686 /* Stop mg_free decreasing the refernce count. */
4688 /* Stop mg_free even calling the destructor, given that
4689 there's no AV to free up. */
4691 sv_unmagic(tsv, PERL_MAGIC_backref);
4695 SvREFCNT_inc_simple_void(av);
4700 const MAGIC *const mg
4701 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4703 av = (AV*)mg->mg_obj;
4707 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4708 /* av now has a refcnt of 2, which avoids it getting freed
4709 * before us during global cleanup. The extra ref is removed
4710 * by magic_killbackrefs() when tsv is being freed */
4713 if (AvFILLp(av) >= AvMAX(av)) {
4714 av_extend(av, AvFILLp(av)+1);
4716 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4719 /* delete a back-reference to ourselves from the backref magic associated
4720 * with the SV we point to.
4724 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4731 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4732 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4733 /* We mustn't attempt to "fix up" the hash here by moving the
4734 backreference array back to the hv_aux structure, as that is stored
4735 in the main HvARRAY(), and hfreentries assumes that no-one
4736 reallocates HvARRAY() while it is running. */
4739 const MAGIC *const mg
4740 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4742 av = (AV *)mg->mg_obj;
4745 if (PL_in_clean_all)
4747 Perl_croak(aTHX_ "panic: del_backref");
4754 /* We shouldn't be in here more than once, but for paranoia reasons lets
4756 for (i = AvFILLp(av); i >= 0; i--) {
4758 const SSize_t fill = AvFILLp(av);
4760 /* We weren't the last entry.
4761 An unordered list has this property that you can take the
4762 last element off the end to fill the hole, and it's still
4763 an unordered list :-)
4768 AvFILLp(av) = fill - 1;
4774 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4776 SV **svp = AvARRAY(av);
4778 PERL_UNUSED_ARG(sv);
4780 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4781 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4782 if (svp && !SvIS_FREED(av)) {
4783 SV *const *const last = svp + AvFILLp(av);
4785 while (svp <= last) {
4787 SV *const referrer = *svp;
4788 if (SvWEAKREF(referrer)) {
4789 /* XXX Should we check that it hasn't changed? */
4790 SvRV_set(referrer, 0);
4792 SvWEAKREF_off(referrer);
4793 } else if (SvTYPE(referrer) == SVt_PVGV ||
4794 SvTYPE(referrer) == SVt_PVLV) {
4795 /* You lookin' at me? */
4796 assert(GvSTASH(referrer));
4797 assert(GvSTASH(referrer) == (HV*)sv);
4798 GvSTASH(referrer) = 0;
4801 "panic: magic_killbackrefs (flags=%"UVxf")",
4802 (UV)SvFLAGS(referrer));
4810 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4815 =for apidoc sv_insert
4817 Inserts a string at the specified offset/length within the SV. Similar to
4818 the Perl substr() function.
4824 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4829 register char *midend;
4830 register char *bigend;
4836 Perl_croak(aTHX_ "Can't modify non-existent substring");
4837 SvPV_force(bigstr, curlen);
4838 (void)SvPOK_only_UTF8(bigstr);
4839 if (offset + len > curlen) {
4840 SvGROW(bigstr, offset+len+1);
4841 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4842 SvCUR_set(bigstr, offset+len);
4846 i = littlelen - len;
4847 if (i > 0) { /* string might grow */
4848 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4849 mid = big + offset + len;
4850 midend = bigend = big + SvCUR(bigstr);
4853 while (midend > mid) /* shove everything down */
4854 *--bigend = *--midend;
4855 Move(little,big+offset,littlelen,char);
4856 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4861 Move(little,SvPVX(bigstr)+offset,len,char);
4866 big = SvPVX(bigstr);
4869 bigend = big + SvCUR(bigstr);
4871 if (midend > bigend)
4872 Perl_croak(aTHX_ "panic: sv_insert");
4874 if (mid - big > bigend - midend) { /* faster to shorten from end */
4876 Move(little, mid, littlelen,char);
4879 i = bigend - midend;
4881 Move(midend, mid, i,char);
4885 SvCUR_set(bigstr, mid - big);
4887 else if ((i = mid - big)) { /* faster from front */
4888 midend -= littlelen;
4890 sv_chop(bigstr,midend-i);
4895 Move(little, mid, littlelen,char);
4897 else if (littlelen) {
4898 midend -= littlelen;
4899 sv_chop(bigstr,midend);
4900 Move(little,midend,littlelen,char);
4903 sv_chop(bigstr,midend);
4909 =for apidoc sv_replace
4911 Make the first argument a copy of the second, then delete the original.
4912 The target SV physically takes over ownership of the body of the source SV
4913 and inherits its flags; however, the target keeps any magic it owns,
4914 and any magic in the source is discarded.
4915 Note that this is a rather specialist SV copying operation; most of the
4916 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4922 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4925 const U32 refcnt = SvREFCNT(sv);
4926 SV_CHECK_THINKFIRST_COW_DROP(sv);
4927 if (SvREFCNT(nsv) != 1) {
4928 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4929 UVuf " != 1)", (UV) SvREFCNT(nsv));
4931 if (SvMAGICAL(sv)) {
4935 sv_upgrade(nsv, SVt_PVMG);
4936 SvMAGIC_set(nsv, SvMAGIC(sv));
4937 SvFLAGS(nsv) |= SvMAGICAL(sv);
4939 SvMAGIC_set(sv, NULL);
4943 assert(!SvREFCNT(sv));
4944 #ifdef DEBUG_LEAKING_SCALARS
4945 sv->sv_flags = nsv->sv_flags;
4946 sv->sv_any = nsv->sv_any;
4947 sv->sv_refcnt = nsv->sv_refcnt;
4948 sv->sv_u = nsv->sv_u;
4950 StructCopy(nsv,sv,SV);
4952 /* Currently could join these into one piece of pointer arithmetic, but
4953 it would be unclear. */
4954 if(SvTYPE(sv) == SVt_IV)
4956 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4957 else if (SvTYPE(sv) == SVt_RV) {
4958 SvANY(sv) = &sv->sv_u.svu_rv;
4962 #ifdef PERL_OLD_COPY_ON_WRITE
4963 if (SvIsCOW_normal(nsv)) {
4964 /* We need to follow the pointers around the loop to make the
4965 previous SV point to sv, rather than nsv. */
4968 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4971 assert(SvPVX_const(current) == SvPVX_const(nsv));
4973 /* Make the SV before us point to the SV after us. */
4975 PerlIO_printf(Perl_debug_log, "previous is\n");
4977 PerlIO_printf(Perl_debug_log,
4978 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4979 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4981 SV_COW_NEXT_SV_SET(current, sv);
4984 SvREFCNT(sv) = refcnt;
4985 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4991 =for apidoc sv_clear
4993 Clear an SV: call any destructors, free up any memory used by the body,
4994 and free the body itself. The SV's head is I<not> freed, although
4995 its type is set to all 1's so that it won't inadvertently be assumed
4996 to be live during global destruction etc.
4997 This function should only be called when REFCNT is zero. Most of the time
4998 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5005 Perl_sv_clear(pTHX_ register SV *sv)
5008 const U32 type = SvTYPE(sv);
5009 const struct body_details *const sv_type_details
5010 = bodies_by_type + type;
5013 assert(SvREFCNT(sv) == 0);
5015 if (type <= SVt_IV) {
5016 /* See the comment in sv.h about the collusion between this early
5017 return and the overloading of the NULL and IV slots in the size
5023 if (PL_defstash) { /* Still have a symbol table? */
5028 stash = SvSTASH(sv);
5029 destructor = StashHANDLER(stash,DESTROY);
5031 SV* const tmpref = newRV(sv);
5032 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5034 PUSHSTACKi(PERLSI_DESTROY);
5039 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5045 if(SvREFCNT(tmpref) < 2) {
5046 /* tmpref is not kept alive! */
5048 SvRV_set(tmpref, NULL);
5051 SvREFCNT_dec(tmpref);
5053 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5057 if (PL_in_clean_objs)
5058 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5060 /* DESTROY gave object new lease on life */
5066 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5067 SvOBJECT_off(sv); /* Curse the object. */
5068 if (type != SVt_PVIO)
5069 --PL_sv_objcount; /* XXX Might want something more general */
5072 if (type >= SVt_PVMG) {
5074 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5075 (ourstash = OURSTASH(sv))) {
5076 SvREFCNT_dec(ourstash);
5077 } else if (SvMAGIC(sv))
5079 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5080 SvREFCNT_dec(SvSTASH(sv));
5085 IoIFP(sv) != PerlIO_stdin() &&
5086 IoIFP(sv) != PerlIO_stdout() &&
5087 IoIFP(sv) != PerlIO_stderr())
5089 io_close((IO*)sv, FALSE);
5091 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5092 PerlDir_close(IoDIRP(sv));
5093 IoDIRP(sv) = (DIR*)NULL;
5094 Safefree(IoTOP_NAME(sv));
5095 Safefree(IoFMT_NAME(sv));
5096 Safefree(IoBOTTOM_NAME(sv));
5105 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5112 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5113 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5114 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5115 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5117 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5118 SvREFCNT_dec(LvTARG(sv));
5122 if (GvNAME_HEK(sv)) {
5123 unshare_hek(GvNAME_HEK(sv));
5125 /* If we're in a stash, we don't own a reference to it. However it does
5126 have a back reference to us, which needs to be cleared. */
5128 sv_del_backref((SV*)GvSTASH(sv), sv);
5133 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5135 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5136 /* Don't even bother with turning off the OOK flag. */
5141 SV * const target = SvRV(sv);
5143 sv_del_backref(target, sv);
5145 SvREFCNT_dec(target);
5147 #ifdef PERL_OLD_COPY_ON_WRITE
5148 else if (SvPVX_const(sv)) {
5150 /* I believe I need to grab the global SV mutex here and
5151 then recheck the COW status. */
5153 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5156 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5157 SV_COW_NEXT_SV(sv));
5158 /* And drop it here. */
5160 } else if (SvLEN(sv)) {
5161 Safefree(SvPVX_const(sv));
5165 else if (SvPVX_const(sv) && SvLEN(sv))
5166 Safefree(SvPVX_mutable(sv));
5167 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5168 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5177 SvFLAGS(sv) &= SVf_BREAK;
5178 SvFLAGS(sv) |= SVTYPEMASK;
5180 if (sv_type_details->arena) {
5181 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5182 &PL_body_roots[type]);
5184 else if (sv_type_details->body_size) {
5185 my_safefree(SvANY(sv));
5190 =for apidoc sv_newref
5192 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5199 Perl_sv_newref(pTHX_ SV *sv)
5201 PERL_UNUSED_CONTEXT;
5210 Decrement an SV's reference count, and if it drops to zero, call
5211 C<sv_clear> to invoke destructors and free up any memory used by
5212 the body; finally, deallocate the SV's head itself.
5213 Normally called via a wrapper macro C<SvREFCNT_dec>.
5219 Perl_sv_free(pTHX_ SV *sv)
5224 if (SvREFCNT(sv) == 0) {
5225 if (SvFLAGS(sv) & SVf_BREAK)
5226 /* this SV's refcnt has been artificially decremented to
5227 * trigger cleanup */
5229 if (PL_in_clean_all) /* All is fair */
5231 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5232 /* make sure SvREFCNT(sv)==0 happens very seldom */
5233 SvREFCNT(sv) = (~(U32)0)/2;
5236 if (ckWARN_d(WARN_INTERNAL)) {
5237 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5238 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5239 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5240 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5241 Perl_dump_sv_child(aTHX_ sv);
5246 if (--(SvREFCNT(sv)) > 0)
5248 Perl_sv_free2(aTHX_ sv);
5252 Perl_sv_free2(pTHX_ SV *sv)
5257 if (ckWARN_d(WARN_DEBUGGING))
5258 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5259 "Attempt to free temp prematurely: SV 0x%"UVxf
5260 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5264 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5265 /* make sure SvREFCNT(sv)==0 happens very seldom */
5266 SvREFCNT(sv) = (~(U32)0)/2;
5277 Returns the length of the string in the SV. Handles magic and type
5278 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5284 Perl_sv_len(pTHX_ register SV *sv)
5292 len = mg_length(sv);
5294 (void)SvPV_const(sv, len);
5299 =for apidoc sv_len_utf8
5301 Returns the number of characters in the string in an SV, counting wide
5302 UTF-8 bytes as a single character. Handles magic and type coercion.
5308 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5309 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5310 * (Note that the mg_len is not the length of the mg_ptr field.
5311 * This allows the cache to store the character length of the string without
5312 * needing to malloc() extra storage to attach to the mg_ptr.)
5317 Perl_sv_len_utf8(pTHX_ register SV *sv)
5323 return mg_length(sv);
5327 const U8 *s = (U8*)SvPV_const(sv, len);
5331 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5333 if (mg && mg->mg_len != -1) {
5335 if (PL_utf8cache < 0) {
5336 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5338 /* Need to turn the assertions off otherwise we may
5339 recurse infinitely while printing error messages.
5341 SAVEI8(PL_utf8cache);
5343 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5344 " real %"UVf" for %"SVf,
5345 (UV) ulen, (UV) real, sv);
5350 ulen = Perl_utf8_length(aTHX_ s, s + len);
5351 if (!SvREADONLY(sv)) {
5353 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5354 &PL_vtbl_utf8, 0, 0);
5362 return Perl_utf8_length(aTHX_ s, s + len);
5366 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5369 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5372 const U8 *s = start;
5374 PERL_UNUSED_CONTEXT;
5376 while (s < send && uoffset--)
5379 /* This is the existing behaviour. Possibly it should be a croak, as
5380 it's actually a bounds error */
5386 /* Given the length of the string in both bytes and UTF-8 characters, decide
5387 whether to walk forwards or backwards to find the byte corresponding to
5388 the passed in UTF-8 offset. */
5390 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5391 STRLEN uoffset, STRLEN uend)
5393 STRLEN backw = uend - uoffset;
5394 if (uoffset < 2 * backw) {
5395 /* The assumption is that going forwards is twice the speed of going
5396 forward (that's where the 2 * backw comes from).
5397 (The real figure of course depends on the UTF-8 data.) */
5398 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5403 while (UTF8_IS_CONTINUATION(*send))
5406 return send - start;
5409 /* For the string representation of the given scalar, find the byte
5410 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5411 give another position in the string, *before* the sought offset, which
5412 (which is always true, as 0, 0 is a valid pair of positions), which should
5413 help reduce the amount of linear searching.
5414 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5415 will be used to reduce the amount of linear searching. The cache will be
5416 created if necessary, and the found value offered to it for update. */
5418 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5419 const U8 *const send, STRLEN uoffset,
5420 STRLEN uoffset0, STRLEN boffset0) {
5421 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5424 assert (uoffset >= uoffset0);
5426 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5427 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5428 if ((*mgp)->mg_ptr) {
5429 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5430 if (cache[0] == uoffset) {
5431 /* An exact match. */
5434 if (cache[2] == uoffset) {
5435 /* An exact match. */
5439 if (cache[0] < uoffset) {
5440 /* The cache already knows part of the way. */
5441 if (cache[0] > uoffset0) {
5442 /* The cache knows more than the passed in pair */
5443 uoffset0 = cache[0];
5444 boffset0 = cache[1];
5446 if ((*mgp)->mg_len != -1) {
5447 /* And we know the end too. */
5449 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5451 (*mgp)->mg_len - uoffset0);
5454 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5455 send, uoffset - uoffset0);
5458 else if (cache[2] < uoffset) {
5459 /* We're between the two cache entries. */
5460 if (cache[2] > uoffset0) {
5461 /* and the cache knows more than the passed in pair */
5462 uoffset0 = cache[2];
5463 boffset0 = cache[3];
5467 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5470 cache[0] - uoffset0);
5473 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5476 cache[2] - uoffset0);
5480 else if ((*mgp)->mg_len != -1) {
5481 /* If we can take advantage of a passed in offset, do so. */
5482 /* In fact, offset0 is either 0, or less than offset, so don't
5483 need to worry about the other possibility. */
5485 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5487 (*mgp)->mg_len - uoffset0);
5492 if (!found || PL_utf8cache < 0) {
5493 const STRLEN real_boffset
5494 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5495 send, uoffset - uoffset0);
5497 if (found && PL_utf8cache < 0) {
5498 if (real_boffset != boffset) {
5499 /* Need to turn the assertions off otherwise we may recurse
5500 infinitely while printing error messages. */
5501 SAVEI8(PL_utf8cache);
5503 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5504 " real %"UVf" for %"SVf,
5505 (UV) boffset, (UV) real_boffset, sv);
5508 boffset = real_boffset;
5511 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5517 =for apidoc sv_pos_u2b
5519 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5520 the start of the string, to a count of the equivalent number of bytes; if
5521 lenp is non-zero, it does the same to lenp, but this time starting from
5522 the offset, rather than from the start of the string. Handles magic and
5529 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5530 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5531 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5536 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5544 start = (U8*)SvPV_const(sv, len);
5546 STRLEN uoffset = (STRLEN) *offsetp;
5547 const U8 * const send = start + len;
5549 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5552 *offsetp = (I32) boffset;
5555 /* Convert the relative offset to absolute. */
5556 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5558 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5559 uoffset, boffset) - boffset;
5573 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5574 byte length pairing. The (byte) length of the total SV is passed in too,
5575 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5576 may not have updated SvCUR, so we can't rely on reading it directly.
5578 The proffered utf8/byte length pairing isn't used if the cache already has
5579 two pairs, and swapping either for the proffered pair would increase the
5580 RMS of the intervals between known byte offsets.
5582 The cache itself consists of 4 STRLEN values
5583 0: larger UTF-8 offset
5584 1: corresponding byte offset
5585 2: smaller UTF-8 offset
5586 3: corresponding byte offset
5588 Unused cache pairs have the value 0, 0.
5589 Keeping the cache "backwards" means that the invariant of
5590 cache[0] >= cache[2] is maintained even with empty slots, which means that
5591 the code that uses it doesn't need to worry if only 1 entry has actually
5592 been set to non-zero. It also makes the "position beyond the end of the
5593 cache" logic much simpler, as the first slot is always the one to start
5597 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5605 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5607 (*mgp)->mg_len = -1;
5611 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5612 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5613 (*mgp)->mg_ptr = (char *) cache;
5617 if (PL_utf8cache < 0) {
5618 const U8 *start = (const U8 *) SvPVX_const(sv);
5619 const U8 *const end = start + byte;
5620 STRLEN realutf8 = 0;
5622 while (start < end) {
5623 start += UTF8SKIP(start);
5627 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5628 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5629 doesn't? I don't know whether this difference was introduced with
5630 the caching code in 5.8.1. */
5632 if (realutf8 != utf8) {
5633 /* Need to turn the assertions off otherwise we may recurse
5634 infinitely while printing error messages. */
5635 SAVEI8(PL_utf8cache);
5637 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5638 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5642 /* Cache is held with the later position first, to simplify the code
5643 that deals with unbounded ends. */
5645 ASSERT_UTF8_CACHE(cache);
5646 if (cache[1] == 0) {
5647 /* Cache is totally empty */
5650 } else if (cache[3] == 0) {
5651 if (byte > cache[1]) {
5652 /* New one is larger, so goes first. */
5653 cache[2] = cache[0];
5654 cache[3] = cache[1];
5662 #define THREEWAY_SQUARE(a,b,c,d) \
5663 ((float)((d) - (c))) * ((float)((d) - (c))) \
5664 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5665 + ((float)((b) - (a))) * ((float)((b) - (a)))
5667 /* Cache has 2 slots in use, and we know three potential pairs.
5668 Keep the two that give the lowest RMS distance. Do the
5669 calcualation in bytes simply because we always know the byte
5670 length. squareroot has the same ordering as the positive value,
5671 so don't bother with the actual square root. */
5672 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5673 if (byte > cache[1]) {
5674 /* New position is after the existing pair of pairs. */
5675 const float keep_earlier
5676 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5677 const float keep_later
5678 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5680 if (keep_later < keep_earlier) {
5681 if (keep_later < existing) {
5682 cache[2] = cache[0];
5683 cache[3] = cache[1];
5689 if (keep_earlier < existing) {
5695 else if (byte > cache[3]) {
5696 /* New position is between the existing pair of pairs. */
5697 const float keep_earlier
5698 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5699 const float keep_later
5700 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5702 if (keep_later < keep_earlier) {
5703 if (keep_later < existing) {
5709 if (keep_earlier < existing) {
5716 /* New position is before the existing pair of pairs. */
5717 const float keep_earlier
5718 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5719 const float keep_later
5720 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5722 if (keep_later < keep_earlier) {
5723 if (keep_later < existing) {
5729 if (keep_earlier < existing) {
5730 cache[0] = cache[2];
5731 cache[1] = cache[3];
5738 ASSERT_UTF8_CACHE(cache);
5741 /* If we don't know the character offset of the end of a region, our only
5742 option is to walk forwards to the target byte offset. */
5744 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5747 while (s < target) {
5750 /* Call utf8n_to_uvchr() to validate the sequence
5751 * (unless a simple non-UTF character) */
5752 if (!UTF8_IS_INVARIANT(*s))
5753 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5764 /* We already know all of the way, now we may be able to walk back. The same
5765 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5766 backward is half the speed of walking forward. */
5768 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5771 const STRLEN forw = target - s;
5772 STRLEN backw = end - target;
5774 if (forw < 2 * backw) {
5775 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5778 while (end > target) {
5780 while (UTF8_IS_CONTINUATION(*end)) {
5789 =for apidoc sv_pos_b2u
5791 Converts the value pointed to by offsetp from a count of bytes from the
5792 start of the string, to a count of the equivalent number of UTF-8 chars.
5793 Handles magic and type coercion.
5799 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5800 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5805 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5808 const STRLEN byte = *offsetp;
5809 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5818 s = (const U8*)SvPV_const(sv, blen);
5821 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5825 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5826 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5828 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5829 if (cache[1] == byte) {
5830 /* An exact match. */
5831 *offsetp = cache[0];
5834 if (cache[3] == byte) {
5835 /* An exact match. */
5836 *offsetp = cache[2];
5840 if (cache[1] < byte) {
5841 /* We already know part of the way. */
5842 if (mg->mg_len != -1) {
5843 /* Actually, we know the end too. */
5845 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5846 s + blen, mg->mg_len - cache[0]);
5849 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5852 else if (cache[3] < byte) {
5853 /* We're between the two cached pairs, so we do the calculation
5854 offset by the byte/utf-8 positions for the earlier pair,
5855 then add the utf-8 characters from the string start to
5857 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5858 s + cache[1], cache[0] - cache[2])
5862 else { /* cache[3] > byte */
5863 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5867 ASSERT_UTF8_CACHE(cache);
5869 } else if (mg->mg_len != -1) {
5870 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5874 if (!found || PL_utf8cache < 0) {
5875 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5877 if (found && PL_utf8cache < 0) {
5878 if (len != real_len) {
5879 /* Need to turn the assertions off otherwise we may recurse
5880 infinitely while printing error messages. */
5881 SAVEI8(PL_utf8cache);
5883 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5884 " real %"UVf" for %"SVf,
5885 (UV) len, (UV) real_len, sv);
5892 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5898 Returns a boolean indicating whether the strings in the two SVs are
5899 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5900 coerce its args to strings if necessary.
5906 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5915 SV* svrecode = NULL;
5922 pv1 = SvPV_const(sv1, cur1);
5929 pv2 = SvPV_const(sv2, cur2);
5931 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5932 /* Differing utf8ness.
5933 * Do not UTF8size the comparands as a side-effect. */
5936 svrecode = newSVpvn(pv2, cur2);
5937 sv_recode_to_utf8(svrecode, PL_encoding);
5938 pv2 = SvPV_const(svrecode, cur2);
5941 svrecode = newSVpvn(pv1, cur1);
5942 sv_recode_to_utf8(svrecode, PL_encoding);
5943 pv1 = SvPV_const(svrecode, cur1);
5945 /* Now both are in UTF-8. */
5947 SvREFCNT_dec(svrecode);
5952 bool is_utf8 = TRUE;
5955 /* sv1 is the UTF-8 one,
5956 * if is equal it must be downgrade-able */
5957 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5963 /* sv2 is the UTF-8 one,
5964 * if is equal it must be downgrade-able */
5965 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5971 /* Downgrade not possible - cannot be eq */
5979 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5981 SvREFCNT_dec(svrecode);
5991 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5992 string in C<sv1> is less than, equal to, or greater than the string in
5993 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5994 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6000 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6004 const char *pv1, *pv2;
6007 SV *svrecode = NULL;
6014 pv1 = SvPV_const(sv1, cur1);
6021 pv2 = SvPV_const(sv2, cur2);
6023 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6024 /* Differing utf8ness.
6025 * Do not UTF8size the comparands as a side-effect. */
6028 svrecode = newSVpvn(pv2, cur2);
6029 sv_recode_to_utf8(svrecode, PL_encoding);
6030 pv2 = SvPV_const(svrecode, cur2);
6033 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6038 svrecode = newSVpvn(pv1, cur1);
6039 sv_recode_to_utf8(svrecode, PL_encoding);
6040 pv1 = SvPV_const(svrecode, cur1);
6043 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6049 cmp = cur2 ? -1 : 0;
6053 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6056 cmp = retval < 0 ? -1 : 1;
6057 } else if (cur1 == cur2) {
6060 cmp = cur1 < cur2 ? -1 : 1;
6064 SvREFCNT_dec(svrecode);
6072 =for apidoc sv_cmp_locale
6074 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6075 'use bytes' aware, handles get magic, and will coerce its args to strings
6076 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6082 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6085 #ifdef USE_LOCALE_COLLATE
6091 if (PL_collation_standard)
6095 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6097 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6099 if (!pv1 || !len1) {
6110 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6113 return retval < 0 ? -1 : 1;
6116 * When the result of collation is equality, that doesn't mean
6117 * that there are no differences -- some locales exclude some
6118 * characters from consideration. So to avoid false equalities,
6119 * we use the raw string as a tiebreaker.
6125 #endif /* USE_LOCALE_COLLATE */
6127 return sv_cmp(sv1, sv2);
6131 #ifdef USE_LOCALE_COLLATE
6134 =for apidoc sv_collxfrm
6136 Add Collate Transform magic to an SV if it doesn't already have it.
6138 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6139 scalar data of the variable, but transformed to such a format that a normal
6140 memory comparison can be used to compare the data according to the locale
6147 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6152 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6153 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6159 Safefree(mg->mg_ptr);
6160 s = SvPV_const(sv, len);
6161 if ((xf = mem_collxfrm(s, len, &xlen))) {
6162 if (SvREADONLY(sv)) {
6165 return xf + sizeof(PL_collation_ix);
6168 #ifdef PERL_OLD_COPY_ON_WRITE
6170 sv_force_normal_flags(sv, 0);
6172 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6186 if (mg && mg->mg_ptr) {
6188 return mg->mg_ptr + sizeof(PL_collation_ix);
6196 #endif /* USE_LOCALE_COLLATE */
6201 Get a line from the filehandle and store it into the SV, optionally
6202 appending to the currently-stored string.
6208 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6213 register STDCHAR rslast;
6214 register STDCHAR *bp;
6219 if (SvTHINKFIRST(sv))
6220 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6221 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6223 However, perlbench says it's slower, because the existing swipe code
6224 is faster than copy on write.
6225 Swings and roundabouts. */
6226 SvUPGRADE(sv, SVt_PV);
6231 if (PerlIO_isutf8(fp)) {
6233 sv_utf8_upgrade_nomg(sv);
6234 sv_pos_u2b(sv,&append,0);
6236 } else if (SvUTF8(sv)) {
6237 SV * const tsv = newSV(0);
6238 sv_gets(tsv, fp, 0);
6239 sv_utf8_upgrade_nomg(tsv);
6240 SvCUR_set(sv,append);
6243 goto return_string_or_null;
6248 if (PerlIO_isutf8(fp))
6251 if (IN_PERL_COMPILETIME) {
6252 /* we always read code in line mode */
6256 else if (RsSNARF(PL_rs)) {
6257 /* If it is a regular disk file use size from stat() as estimate
6258 of amount we are going to read -- may result in mallocing
6259 more memory than we really need if the layers below reduce
6260 the size we read (e.g. CRLF or a gzip layer).
6263 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6264 const Off_t offset = PerlIO_tell(fp);
6265 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6266 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6272 else if (RsRECORD(PL_rs)) {
6277 /* Grab the size of the record we're getting */
6278 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6279 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6282 /* VMS wants read instead of fread, because fread doesn't respect */
6283 /* RMS record boundaries. This is not necessarily a good thing to be */
6284 /* doing, but we've got no other real choice - except avoid stdio
6285 as implementation - perhaps write a :vms layer ?
6287 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6289 bytesread = PerlIO_read(fp, buffer, recsize);
6293 SvCUR_set(sv, bytesread += append);
6294 buffer[bytesread] = '\0';
6295 goto return_string_or_null;
6297 else if (RsPARA(PL_rs)) {
6303 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6304 if (PerlIO_isutf8(fp)) {
6305 rsptr = SvPVutf8(PL_rs, rslen);
6308 if (SvUTF8(PL_rs)) {
6309 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6310 Perl_croak(aTHX_ "Wide character in $/");
6313 rsptr = SvPV_const(PL_rs, rslen);
6317 rslast = rslen ? rsptr[rslen - 1] : '\0';
6319 if (rspara) { /* have to do this both before and after */
6320 do { /* to make sure file boundaries work right */
6323 i = PerlIO_getc(fp);
6327 PerlIO_ungetc(fp,i);
6333 /* See if we know enough about I/O mechanism to cheat it ! */
6335 /* This used to be #ifdef test - it is made run-time test for ease
6336 of abstracting out stdio interface. One call should be cheap
6337 enough here - and may even be a macro allowing compile
6341 if (PerlIO_fast_gets(fp)) {
6344 * We're going to steal some values from the stdio struct
6345 * and put EVERYTHING in the innermost loop into registers.
6347 register STDCHAR *ptr;
6351 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6352 /* An ungetc()d char is handled separately from the regular
6353 * buffer, so we getc() it back out and stuff it in the buffer.
6355 i = PerlIO_getc(fp);
6356 if (i == EOF) return 0;
6357 *(--((*fp)->_ptr)) = (unsigned char) i;
6361 /* Here is some breathtakingly efficient cheating */
6363 cnt = PerlIO_get_cnt(fp); /* get count into register */
6364 /* make sure we have the room */
6365 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6366 /* Not room for all of it
6367 if we are looking for a separator and room for some
6369 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6370 /* just process what we have room for */
6371 shortbuffered = cnt - SvLEN(sv) + append + 1;
6372 cnt -= shortbuffered;
6376 /* remember that cnt can be negative */
6377 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6382 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6383 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6384 DEBUG_P(PerlIO_printf(Perl_debug_log,
6385 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
6387 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6388 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6389 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6394 while (cnt > 0) { /* this | eat */
6396 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6397 goto thats_all_folks; /* screams | sed :-) */
6401 Copy(ptr, bp, cnt, char); /* this | eat */
6402 bp += cnt; /* screams | dust */
6403 ptr += cnt; /* louder | sed :-) */
6408 if (shortbuffered) { /* oh well, must extend */
6409 cnt = shortbuffered;
6411 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6413 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6414 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6418 DEBUG_P(PerlIO_printf(Perl_debug_log,
6419 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6420 PTR2UV(ptr),(long)cnt));
6421 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6423 DEBUG_P(PerlIO_printf(Perl_debug_log,
6424 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6425 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6426 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6428 /* This used to call 'filbuf' in stdio form, but as that behaves like
6429 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6430 another abstraction. */
6431 i = PerlIO_getc(fp); /* get more characters */
6433 DEBUG_P(PerlIO_printf(Perl_debug_log,
6434 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6435 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6436 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6438 cnt = PerlIO_get_cnt(fp);
6439 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6440 DEBUG_P(PerlIO_printf(Perl_debug_log,
6441 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6443 if (i == EOF) /* all done for ever? */
6444 goto thats_really_all_folks;
6446 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6448 SvGROW(sv, bpx + cnt + 2);
6449 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6451 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6453 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6454 goto thats_all_folks;
6458 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6459 memNE((char*)bp - rslen, rsptr, rslen))
6460 goto screamer; /* go back to the fray */
6461 thats_really_all_folks:
6463 cnt += shortbuffered;
6464 DEBUG_P(PerlIO_printf(Perl_debug_log,
6465 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6466 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6467 DEBUG_P(PerlIO_printf(Perl_debug_log,
6468 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6469 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6470 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6472 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: done, len=%ld, string=|%.*s|\n",
6475 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6479 /*The big, slow, and stupid way. */
6480 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6481 STDCHAR *buf = NULL;
6482 Newx(buf, 8192, STDCHAR);
6490 register const STDCHAR * const bpe = buf + sizeof(buf);
6492 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6493 ; /* keep reading */
6497 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6498 /* Accomodate broken VAXC compiler, which applies U8 cast to
6499 * both args of ?: operator, causing EOF to change into 255
6502 i = (U8)buf[cnt - 1];
6508 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6510 sv_catpvn(sv, (char *) buf, cnt);
6512 sv_setpvn(sv, (char *) buf, cnt);
6514 if (i != EOF && /* joy */
6516 SvCUR(sv) < rslen ||
6517 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6521 * If we're reading from a TTY and we get a short read,
6522 * indicating that the user hit his EOF character, we need
6523 * to notice it now, because if we try to read from the TTY
6524 * again, the EOF condition will disappear.
6526 * The comparison of cnt to sizeof(buf) is an optimization
6527 * that prevents unnecessary calls to feof().
6531 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6535 #ifdef USE_HEAP_INSTEAD_OF_STACK
6540 if (rspara) { /* have to do this both before and after */
6541 while (i != EOF) { /* to make sure file boundaries work right */
6542 i = PerlIO_getc(fp);
6544 PerlIO_ungetc(fp,i);
6550 return_string_or_null:
6551 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6557 Auto-increment of the value in the SV, doing string to numeric conversion
6558 if necessary. Handles 'get' magic.
6564 Perl_sv_inc(pTHX_ register SV *sv)
6573 if (SvTHINKFIRST(sv)) {
6575 sv_force_normal_flags(sv, 0);
6576 if (SvREADONLY(sv)) {
6577 if (IN_PERL_RUNTIME)
6578 Perl_croak(aTHX_ PL_no_modify);
6582 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6584 i = PTR2IV(SvRV(sv));
6589 flags = SvFLAGS(sv);
6590 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6591 /* It's (privately or publicly) a float, but not tested as an
6592 integer, so test it to see. */
6594 flags = SvFLAGS(sv);
6596 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6597 /* It's publicly an integer, or privately an integer-not-float */
6598 #ifdef PERL_PRESERVE_IVUV
6602 if (SvUVX(sv) == UV_MAX)
6603 sv_setnv(sv, UV_MAX_P1);
6605 (void)SvIOK_only_UV(sv);
6606 SvUV_set(sv, SvUVX(sv) + 1);
6608 if (SvIVX(sv) == IV_MAX)
6609 sv_setuv(sv, (UV)IV_MAX + 1);
6611 (void)SvIOK_only(sv);
6612 SvIV_set(sv, SvIVX(sv) + 1);
6617 if (flags & SVp_NOK) {
6618 (void)SvNOK_only(sv);
6619 SvNV_set(sv, SvNVX(sv) + 1.0);
6623 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6624 if ((flags & SVTYPEMASK) < SVt_PVIV)
6625 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6626 (void)SvIOK_only(sv);
6631 while (isALPHA(*d)) d++;
6632 while (isDIGIT(*d)) d++;
6634 #ifdef PERL_PRESERVE_IVUV
6635 /* Got to punt this as an integer if needs be, but we don't issue
6636 warnings. Probably ought to make the sv_iv_please() that does
6637 the conversion if possible, and silently. */
6638 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6639 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6640 /* Need to try really hard to see if it's an integer.
6641 9.22337203685478e+18 is an integer.
6642 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6643 so $a="9.22337203685478e+18"; $a+0; $a++
6644 needs to be the same as $a="9.22337203685478e+18"; $a++
6651 /* sv_2iv *should* have made this an NV */
6652 if (flags & SVp_NOK) {
6653 (void)SvNOK_only(sv);
6654 SvNV_set(sv, SvNVX(sv) + 1.0);
6657 /* I don't think we can get here. Maybe I should assert this
6658 And if we do get here I suspect that sv_setnv will croak. NWC
6660 #if defined(USE_LONG_DOUBLE)
6661 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",
6662 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6664 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6665 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6668 #endif /* PERL_PRESERVE_IVUV */
6669 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6673 while (d >= SvPVX_const(sv)) {
6681 /* MKS: The original code here died if letters weren't consecutive.
6682 * at least it didn't have to worry about non-C locales. The
6683 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6684 * arranged in order (although not consecutively) and that only
6685 * [A-Za-z] are accepted by isALPHA in the C locale.
6687 if (*d != 'z' && *d != 'Z') {
6688 do { ++*d; } while (!isALPHA(*d));
6691 *(d--) -= 'z' - 'a';
6696 *(d--) -= 'z' - 'a' + 1;
6700 /* oh,oh, the number grew */
6701 SvGROW(sv, SvCUR(sv) + 2);
6702 SvCUR_set(sv, SvCUR(sv) + 1);
6703 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6714 Auto-decrement of the value in the SV, doing string to numeric conversion
6715 if necessary. Handles 'get' magic.
6721 Perl_sv_dec(pTHX_ register SV *sv)
6729 if (SvTHINKFIRST(sv)) {
6731 sv_force_normal_flags(sv, 0);
6732 if (SvREADONLY(sv)) {
6733 if (IN_PERL_RUNTIME)
6734 Perl_croak(aTHX_ PL_no_modify);
6738 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6740 i = PTR2IV(SvRV(sv));
6745 /* Unlike sv_inc we don't have to worry about string-never-numbers
6746 and keeping them magic. But we mustn't warn on punting */
6747 flags = SvFLAGS(sv);
6748 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6749 /* It's publicly an integer, or privately an integer-not-float */
6750 #ifdef PERL_PRESERVE_IVUV
6754 if (SvUVX(sv) == 0) {
6755 (void)SvIOK_only(sv);
6759 (void)SvIOK_only_UV(sv);
6760 SvUV_set(sv, SvUVX(sv) - 1);
6763 if (SvIVX(sv) == IV_MIN)
6764 sv_setnv(sv, (NV)IV_MIN - 1.0);
6766 (void)SvIOK_only(sv);
6767 SvIV_set(sv, SvIVX(sv) - 1);
6772 if (flags & SVp_NOK) {
6773 SvNV_set(sv, SvNVX(sv) - 1.0);
6774 (void)SvNOK_only(sv);
6777 if (!(flags & SVp_POK)) {
6778 if ((flags & SVTYPEMASK) < SVt_PVIV)
6779 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6781 (void)SvIOK_only(sv);
6784 #ifdef PERL_PRESERVE_IVUV
6786 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6787 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6788 /* Need to try really hard to see if it's an integer.
6789 9.22337203685478e+18 is an integer.
6790 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6791 so $a="9.22337203685478e+18"; $a+0; $a--
6792 needs to be the same as $a="9.22337203685478e+18"; $a--
6799 /* sv_2iv *should* have made this an NV */
6800 if (flags & SVp_NOK) {
6801 (void)SvNOK_only(sv);
6802 SvNV_set(sv, SvNVX(sv) - 1.0);
6805 /* I don't think we can get here. Maybe I should assert this
6806 And if we do get here I suspect that sv_setnv will croak. NWC
6808 #if defined(USE_LONG_DOUBLE)
6809 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",
6810 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6812 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6813 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6817 #endif /* PERL_PRESERVE_IVUV */
6818 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6822 =for apidoc sv_mortalcopy
6824 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6825 The new SV is marked as mortal. It will be destroyed "soon", either by an
6826 explicit call to FREETMPS, or by an implicit call at places such as
6827 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6832 /* Make a string that will exist for the duration of the expression
6833 * evaluation. Actually, it may have to last longer than that, but
6834 * hopefully we won't free it until it has been assigned to a
6835 * permanent location. */
6838 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6844 sv_setsv(sv,oldstr);
6846 PL_tmps_stack[++PL_tmps_ix] = sv;
6852 =for apidoc sv_newmortal
6854 Creates a new null SV which is mortal. The reference count of the SV is
6855 set to 1. It will be destroyed "soon", either by an explicit call to
6856 FREETMPS, or by an implicit call at places such as statement boundaries.
6857 See also C<sv_mortalcopy> and C<sv_2mortal>.
6863 Perl_sv_newmortal(pTHX)
6869 SvFLAGS(sv) = SVs_TEMP;
6871 PL_tmps_stack[++PL_tmps_ix] = sv;
6876 =for apidoc sv_2mortal
6878 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6879 by an explicit call to FREETMPS, or by an implicit call at places such as
6880 statement boundaries. SvTEMP() is turned on which means that the SV's
6881 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6882 and C<sv_mortalcopy>.
6888 Perl_sv_2mortal(pTHX_ register SV *sv)
6893 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6896 PL_tmps_stack[++PL_tmps_ix] = sv;
6904 Creates a new SV and copies a string into it. The reference count for the
6905 SV is set to 1. If C<len> is zero, Perl will compute the length using
6906 strlen(). For efficiency, consider using C<newSVpvn> instead.
6912 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6918 sv_setpvn(sv,s,len ? len : strlen(s));
6923 =for apidoc newSVpvn
6925 Creates a new SV and copies a string into it. The reference count for the
6926 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6927 string. You are responsible for ensuring that the source string is at least
6928 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6934 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6940 sv_setpvn(sv,s,len);
6946 =for apidoc newSVhek
6948 Creates a new SV from the hash key structure. It will generate scalars that
6949 point to the shared string table where possible. Returns a new (undefined)
6950 SV if the hek is NULL.
6956 Perl_newSVhek(pTHX_ const HEK *hek)
6966 if (HEK_LEN(hek) == HEf_SVKEY) {
6967 return newSVsv(*(SV**)HEK_KEY(hek));
6969 const int flags = HEK_FLAGS(hek);
6970 if (flags & HVhek_WASUTF8) {
6972 Andreas would like keys he put in as utf8 to come back as utf8
6974 STRLEN utf8_len = HEK_LEN(hek);
6975 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6976 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6979 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6981 } else if (flags & HVhek_REHASH) {
6982 /* We don't have a pointer to the hv, so we have to replicate the
6983 flag into every HEK. This hv is using custom a hasing
6984 algorithm. Hence we can't return a shared string scalar, as
6985 that would contain the (wrong) hash value, and might get passed
6986 into an hv routine with a regular hash */
6988 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6993 /* This will be overwhelminly the most common case. */
6995 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6996 more efficient than sharepvn(). */
7000 sv_upgrade(sv, SVt_PV);
7001 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7002 SvCUR_set(sv, HEK_LEN(hek));
7015 =for apidoc newSVpvn_share
7017 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7018 table. If the string does not already exist in the table, it is created
7019 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7020 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7021 otherwise the hash is computed. The idea here is that as the string table
7022 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7023 hash lookup will avoid string compare.
7029 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7033 bool is_utf8 = FALSE;
7034 const char *const orig_src = src;
7037 STRLEN tmplen = -len;
7039 /* See the note in hv.c:hv_fetch() --jhi */
7040 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7044 PERL_HASH(hash, src, len);
7046 sv_upgrade(sv, SVt_PV);
7047 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7055 if (src != orig_src)
7061 #if defined(PERL_IMPLICIT_CONTEXT)
7063 /* pTHX_ magic can't cope with varargs, so this is a no-context
7064 * version of the main function, (which may itself be aliased to us).
7065 * Don't access this version directly.
7069 Perl_newSVpvf_nocontext(const char* pat, ...)
7074 va_start(args, pat);
7075 sv = vnewSVpvf(pat, &args);
7082 =for apidoc newSVpvf
7084 Creates a new SV and initializes it with the string formatted like
7091 Perl_newSVpvf(pTHX_ const char* pat, ...)
7095 va_start(args, pat);
7096 sv = vnewSVpvf(pat, &args);
7101 /* backend for newSVpvf() and newSVpvf_nocontext() */
7104 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7109 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7116 Creates a new SV and copies a floating point value into it.
7117 The reference count for the SV is set to 1.
7123 Perl_newSVnv(pTHX_ NV n)
7136 Creates a new SV and copies an integer into it. The reference count for the
7143 Perl_newSViv(pTHX_ IV i)
7156 Creates a new SV and copies an unsigned integer into it.
7157 The reference count for the SV is set to 1.
7163 Perl_newSVuv(pTHX_ UV u)
7174 =for apidoc newRV_noinc
7176 Creates an RV wrapper for an SV. The reference count for the original
7177 SV is B<not> incremented.
7183 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7189 sv_upgrade(sv, SVt_RV);
7191 SvRV_set(sv, tmpRef);
7196 /* newRV_inc is the official function name to use now.
7197 * newRV_inc is in fact #defined to newRV in sv.h
7201 Perl_newRV(pTHX_ SV *sv)
7204 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7210 Creates a new SV which is an exact duplicate of the original SV.
7217 Perl_newSVsv(pTHX_ register SV *old)
7224 if (SvTYPE(old) == SVTYPEMASK) {
7225 if (ckWARN_d(WARN_INTERNAL))
7226 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7230 /* SV_GMAGIC is the default for sv_setv()
7231 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7232 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7233 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7238 =for apidoc sv_reset
7240 Underlying implementation for the C<reset> Perl function.
7241 Note that the perl-level function is vaguely deprecated.
7247 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7250 char todo[PERL_UCHAR_MAX+1];
7255 if (!*s) { /* reset ?? searches */
7256 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7258 PMOP *pm = (PMOP *) mg->mg_obj;
7260 pm->op_pmdynflags &= ~PMdf_USED;
7267 /* reset variables */
7269 if (!HvARRAY(stash))
7272 Zero(todo, 256, char);
7275 I32 i = (unsigned char)*s;
7279 max = (unsigned char)*s++;
7280 for ( ; i <= max; i++) {
7283 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7285 for (entry = HvARRAY(stash)[i];
7287 entry = HeNEXT(entry))
7292 if (!todo[(U8)*HeKEY(entry)])
7294 gv = (GV*)HeVAL(entry);
7297 if (SvTHINKFIRST(sv)) {
7298 if (!SvREADONLY(sv) && SvROK(sv))
7300 /* XXX Is this continue a bug? Why should THINKFIRST
7301 exempt us from resetting arrays and hashes? */
7305 if (SvTYPE(sv) >= SVt_PV) {
7307 if (SvPVX_const(sv) != NULL)
7315 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7317 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7320 # if defined(USE_ENVIRON_ARRAY)
7323 # endif /* USE_ENVIRON_ARRAY */
7334 Using various gambits, try to get an IO from an SV: the IO slot if its a
7335 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7336 named after the PV if we're a string.
7342 Perl_sv_2io(pTHX_ SV *sv)
7347 switch (SvTYPE(sv)) {
7355 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7359 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7361 return sv_2io(SvRV(sv));
7362 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7368 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7377 Using various gambits, try to get a CV from an SV; in addition, try if
7378 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7379 The flags in C<lref> are passed to sv_fetchsv.
7385 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7396 switch (SvTYPE(sv)) {
7415 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7416 tryAMAGICunDEREF(to_cv);
7419 if (SvTYPE(sv) == SVt_PVCV) {
7428 Perl_croak(aTHX_ "Not a subroutine reference");
7433 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7439 /* Some flags to gv_fetchsv mean don't really create the GV */
7440 if (SvTYPE(gv) != SVt_PVGV) {
7446 if (lref && !GvCVu(gv)) {
7450 gv_efullname3(tmpsv, gv, NULL);
7451 /* XXX this is probably not what they think they're getting.
7452 * It has the same effect as "sub name;", i.e. just a forward
7454 newSUB(start_subparse(FALSE, 0),
7455 newSVOP(OP_CONST, 0, tmpsv),
7459 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7469 Returns true if the SV has a true value by Perl's rules.
7470 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7471 instead use an in-line version.
7477 Perl_sv_true(pTHX_ register SV *sv)
7482 register const XPV* const tXpv = (XPV*)SvANY(sv);
7484 (tXpv->xpv_cur > 1 ||
7485 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7492 return SvIVX(sv) != 0;
7495 return SvNVX(sv) != 0.0;
7497 return sv_2bool(sv);
7503 =for apidoc sv_pvn_force
7505 Get a sensible string out of the SV somehow.
7506 A private implementation of the C<SvPV_force> macro for compilers which
7507 can't cope with complex macro expressions. Always use the macro instead.
7509 =for apidoc sv_pvn_force_flags
7511 Get a sensible string out of the SV somehow.
7512 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7513 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7514 implemented in terms of this function.
7515 You normally want to use the various wrapper macros instead: see
7516 C<SvPV_force> and C<SvPV_force_nomg>
7522 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7525 if (SvTHINKFIRST(sv) && !SvROK(sv))
7526 sv_force_normal_flags(sv, 0);
7536 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7537 const char * const ref = sv_reftype(sv,0);
7539 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7540 ref, OP_NAME(PL_op));
7542 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7544 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7545 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7547 s = sv_2pv_flags(sv, &len, flags);
7551 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7554 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7555 SvGROW(sv, len + 1);
7556 Move(s,SvPVX(sv),len,char);
7561 SvPOK_on(sv); /* validate pointer */
7563 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7564 PTR2UV(sv),SvPVX_const(sv)));
7567 return SvPVX_mutable(sv);
7571 =for apidoc sv_pvbyten_force
7573 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7579 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7581 sv_pvn_force(sv,lp);
7582 sv_utf8_downgrade(sv,0);
7588 =for apidoc sv_pvutf8n_force
7590 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7596 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7598 sv_pvn_force(sv,lp);
7599 sv_utf8_upgrade(sv);
7605 =for apidoc sv_reftype
7607 Returns a string describing what the SV is a reference to.
7613 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7615 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7616 inside return suggests a const propagation bug in g++. */
7617 if (ob && SvOBJECT(sv)) {
7618 char * const name = HvNAME_get(SvSTASH(sv));
7619 return name ? name : (char *) "__ANON__";
7622 switch (SvTYPE(sv)) {
7639 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7640 /* tied lvalues should appear to be
7641 * scalars for backwards compatitbility */
7642 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7643 ? "SCALAR" : "LVALUE");
7644 case SVt_PVAV: return "ARRAY";
7645 case SVt_PVHV: return "HASH";
7646 case SVt_PVCV: return "CODE";
7647 case SVt_PVGV: return "GLOB";
7648 case SVt_PVFM: return "FORMAT";
7649 case SVt_PVIO: return "IO";
7650 default: return "UNKNOWN";
7656 =for apidoc sv_isobject
7658 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7659 object. If the SV is not an RV, or if the object is not blessed, then this
7666 Perl_sv_isobject(pTHX_ SV *sv)
7682 Returns a boolean indicating whether the SV is blessed into the specified
7683 class. This does not check for subtypes; use C<sv_derived_from> to verify
7684 an inheritance relationship.
7690 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7701 hvname = HvNAME_get(SvSTASH(sv));
7705 return strEQ(hvname, name);
7711 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7712 it will be upgraded to one. If C<classname> is non-null then the new SV will
7713 be blessed in the specified package. The new SV is returned and its
7714 reference count is 1.
7720 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7727 SV_CHECK_THINKFIRST_COW_DROP(rv);
7730 if (SvTYPE(rv) >= SVt_PVMG) {
7731 const U32 refcnt = SvREFCNT(rv);
7735 SvREFCNT(rv) = refcnt;
7737 sv_upgrade(rv, SVt_RV);
7738 } else if (SvROK(rv)) {
7739 SvREFCNT_dec(SvRV(rv));
7740 } else if (SvTYPE(rv) < SVt_RV)
7741 sv_upgrade(rv, SVt_RV);
7742 else if (SvTYPE(rv) > SVt_RV) {
7753 HV* const stash = gv_stashpv(classname, TRUE);
7754 (void)sv_bless(rv, stash);
7760 =for apidoc sv_setref_pv
7762 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7763 argument will be upgraded to an RV. That RV will be modified to point to
7764 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7765 into the SV. The C<classname> argument indicates the package for the
7766 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7767 will have a reference count of 1, and the RV will be returned.
7769 Do not use with other Perl types such as HV, AV, SV, CV, because those
7770 objects will become corrupted by the pointer copy process.
7772 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7778 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7782 sv_setsv(rv, &PL_sv_undef);
7786 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7791 =for apidoc sv_setref_iv
7793 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7794 argument will be upgraded to an RV. That RV will be modified to point to
7795 the new SV. The C<classname> argument indicates the package for the
7796 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7797 will have a reference count of 1, and the RV will be returned.
7803 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7805 sv_setiv(newSVrv(rv,classname), iv);
7810 =for apidoc sv_setref_uv
7812 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7813 argument will be upgraded to an RV. That RV will be modified to point to
7814 the new SV. The C<classname> argument indicates the package for the
7815 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7816 will have a reference count of 1, and the RV will be returned.
7822 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7824 sv_setuv(newSVrv(rv,classname), uv);
7829 =for apidoc sv_setref_nv
7831 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7832 argument will be upgraded to an RV. That RV will be modified to point to
7833 the new SV. The C<classname> argument indicates the package for the
7834 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7835 will have a reference count of 1, and the RV will be returned.
7841 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7843 sv_setnv(newSVrv(rv,classname), nv);
7848 =for apidoc sv_setref_pvn
7850 Copies a string into a new SV, optionally blessing the SV. The length of the
7851 string must be specified with C<n>. The C<rv> argument will be upgraded to
7852 an RV. That RV will be modified to point to the new SV. The C<classname>
7853 argument indicates the package for the blessing. Set C<classname> to
7854 C<NULL> to avoid the blessing. The new SV will have a reference count
7855 of 1, and the RV will be returned.
7857 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7863 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7865 sv_setpvn(newSVrv(rv,classname), pv, n);
7870 =for apidoc sv_bless
7872 Blesses an SV into a specified package. The SV must be an RV. The package
7873 must be designated by its stash (see C<gv_stashpv()>). The reference count
7874 of the SV is unaffected.
7880 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7885 Perl_croak(aTHX_ "Can't bless non-reference value");
7887 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7888 if (SvREADONLY(tmpRef))
7889 Perl_croak(aTHX_ PL_no_modify);
7890 if (SvOBJECT(tmpRef)) {
7891 if (SvTYPE(tmpRef) != SVt_PVIO)
7893 SvREFCNT_dec(SvSTASH(tmpRef));
7896 SvOBJECT_on(tmpRef);
7897 if (SvTYPE(tmpRef) != SVt_PVIO)
7899 SvUPGRADE(tmpRef, SVt_PVMG);
7900 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7907 if(SvSMAGICAL(tmpRef))
7908 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7916 /* Downgrades a PVGV to a PVMG.
7920 S_sv_unglob(pTHX_ SV *sv)
7924 SV * const temp = sv_newmortal();
7926 assert(SvTYPE(sv) == SVt_PVGV);
7928 gv_efullname3(temp, (GV *) sv, "*");
7934 sv_del_backref((SV*)GvSTASH(sv), sv);
7938 if (GvNAME_HEK(sv)) {
7939 unshare_hek(GvNAME_HEK(sv));
7943 /* need to keep SvANY(sv) in the right arena */
7944 xpvmg = new_XPVMG();
7945 StructCopy(SvANY(sv), xpvmg, XPVMG);
7946 del_XPVGV(SvANY(sv));
7949 SvFLAGS(sv) &= ~SVTYPEMASK;
7950 SvFLAGS(sv) |= SVt_PVMG;
7952 /* Intentionally not calling any local SET magic, as this isn't so much a
7953 set operation as merely an internal storage change. */
7954 sv_setsv_flags(sv, temp, 0);
7958 =for apidoc sv_unref_flags
7960 Unsets the RV status of the SV, and decrements the reference count of
7961 whatever was being referenced by the RV. This can almost be thought of
7962 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7963 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7964 (otherwise the decrementing is conditional on the reference count being
7965 different from one or the reference being a readonly SV).
7972 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7974 SV* const target = SvRV(ref);
7976 if (SvWEAKREF(ref)) {
7977 sv_del_backref(target, ref);
7979 SvRV_set(ref, NULL);
7982 SvRV_set(ref, NULL);
7984 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7985 assigned to as BEGIN {$a = \"Foo"} will fail. */
7986 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7987 SvREFCNT_dec(target);
7988 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7989 sv_2mortal(target); /* Schedule for freeing later */
7993 =for apidoc sv_untaint
7995 Untaint an SV. Use C<SvTAINTED_off> instead.
8000 Perl_sv_untaint(pTHX_ SV *sv)
8002 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8003 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8010 =for apidoc sv_tainted
8012 Test an SV for taintedness. Use C<SvTAINTED> instead.
8017 Perl_sv_tainted(pTHX_ SV *sv)
8019 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8020 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8021 if (mg && (mg->mg_len & 1) )
8028 =for apidoc sv_setpviv
8030 Copies an integer into the given SV, also updating its string value.
8031 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8037 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8039 char buf[TYPE_CHARS(UV)];
8041 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8043 sv_setpvn(sv, ptr, ebuf - ptr);
8047 =for apidoc sv_setpviv_mg
8049 Like C<sv_setpviv>, but also handles 'set' magic.
8055 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8061 #if defined(PERL_IMPLICIT_CONTEXT)
8063 /* pTHX_ magic can't cope with varargs, so this is a no-context
8064 * version of the main function, (which may itself be aliased to us).
8065 * Don't access this version directly.
8069 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8073 va_start(args, pat);
8074 sv_vsetpvf(sv, pat, &args);
8078 /* pTHX_ magic can't cope with varargs, so this is a no-context
8079 * version of the main function, (which may itself be aliased to us).
8080 * Don't access this version directly.
8084 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8088 va_start(args, pat);
8089 sv_vsetpvf_mg(sv, pat, &args);
8095 =for apidoc sv_setpvf
8097 Works like C<sv_catpvf> but copies the text into the SV instead of
8098 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8104 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8107 va_start(args, pat);
8108 sv_vsetpvf(sv, pat, &args);
8113 =for apidoc sv_vsetpvf
8115 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8116 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8118 Usually used via its frontend C<sv_setpvf>.
8124 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8126 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8130 =for apidoc sv_setpvf_mg
8132 Like C<sv_setpvf>, but also handles 'set' magic.
8138 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8141 va_start(args, pat);
8142 sv_vsetpvf_mg(sv, pat, &args);
8147 =for apidoc sv_vsetpvf_mg
8149 Like C<sv_vsetpvf>, but also handles 'set' magic.
8151 Usually used via its frontend C<sv_setpvf_mg>.
8157 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8159 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8163 #if defined(PERL_IMPLICIT_CONTEXT)
8165 /* pTHX_ magic can't cope with varargs, so this is a no-context
8166 * version of the main function, (which may itself be aliased to us).
8167 * Don't access this version directly.
8171 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8175 va_start(args, pat);
8176 sv_vcatpvf(sv, pat, &args);
8180 /* pTHX_ magic can't cope with varargs, so this is a no-context
8181 * version of the main function, (which may itself be aliased to us).
8182 * Don't access this version directly.
8186 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8190 va_start(args, pat);
8191 sv_vcatpvf_mg(sv, pat, &args);
8197 =for apidoc sv_catpvf
8199 Processes its arguments like C<sprintf> and appends the formatted
8200 output to an SV. If the appended data contains "wide" characters
8201 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8202 and characters >255 formatted with %c), the original SV might get
8203 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8204 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8205 valid UTF-8; if the original SV was bytes, the pattern should be too.
8210 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8213 va_start(args, pat);
8214 sv_vcatpvf(sv, pat, &args);
8219 =for apidoc sv_vcatpvf
8221 Processes its arguments like C<vsprintf> and appends the formatted output
8222 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8224 Usually used via its frontend C<sv_catpvf>.
8230 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8232 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8236 =for apidoc sv_catpvf_mg
8238 Like C<sv_catpvf>, but also handles 'set' magic.
8244 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8247 va_start(args, pat);
8248 sv_vcatpvf_mg(sv, pat, &args);
8253 =for apidoc sv_vcatpvf_mg
8255 Like C<sv_vcatpvf>, but also handles 'set' magic.
8257 Usually used via its frontend C<sv_catpvf_mg>.
8263 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8265 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8270 =for apidoc sv_vsetpvfn
8272 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8275 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8281 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8283 sv_setpvn(sv, "", 0);
8284 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8288 S_expect_number(pTHX_ char** pattern)
8292 switch (**pattern) {
8293 case '1': case '2': case '3':
8294 case '4': case '5': case '6':
8295 case '7': case '8': case '9':
8296 var = *(*pattern)++ - '0';
8297 while (isDIGIT(**pattern)) {
8298 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8300 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8308 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8310 const int neg = nv < 0;
8319 if (uv & 1 && uv == nv)
8320 uv--; /* Round to even */
8322 const unsigned dig = uv % 10;
8335 =for apidoc sv_vcatpvfn
8337 Processes its arguments like C<vsprintf> and appends the formatted output
8338 to an SV. Uses an array of SVs if the C style variable argument list is
8339 missing (NULL). When running with taint checks enabled, indicates via
8340 C<maybe_tainted> if results are untrustworthy (often due to the use of
8343 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8349 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8350 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8351 vec_utf8 = DO_UTF8(vecsv);
8353 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8356 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8364 static const char nullstr[] = "(null)";
8366 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8367 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8369 /* Times 4: a decimal digit takes more than 3 binary digits.
8370 * NV_DIG: mantissa takes than many decimal digits.
8371 * Plus 32: Playing safe. */
8372 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8373 /* large enough for "%#.#f" --chip */
8374 /* what about long double NVs? --jhi */
8376 PERL_UNUSED_ARG(maybe_tainted);
8378 /* no matter what, this is a string now */
8379 (void)SvPV_force(sv, origlen);
8381 /* special-case "", "%s", and "%-p" (SVf - see below) */
8384 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8386 const char * const s = va_arg(*args, char*);
8387 sv_catpv(sv, s ? s : nullstr);
8389 else if (svix < svmax) {
8390 sv_catsv(sv, *svargs);
8394 if (args && patlen == 3 && pat[0] == '%' &&
8395 pat[1] == '-' && pat[2] == 'p') {
8396 argsv = va_arg(*args, SV*);
8397 sv_catsv(sv, argsv);
8401 #ifndef USE_LONG_DOUBLE
8402 /* special-case "%.<number>[gf]" */
8403 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8404 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8405 unsigned digits = 0;
8409 while (*pp >= '0' && *pp <= '9')
8410 digits = 10 * digits + (*pp++ - '0');
8411 if (pp - pat == (int)patlen - 1) {
8419 /* Add check for digits != 0 because it seems that some
8420 gconverts are buggy in this case, and we don't yet have
8421 a Configure test for this. */
8422 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8423 /* 0, point, slack */
8424 Gconvert(nv, (int)digits, 0, ebuf);
8426 if (*ebuf) /* May return an empty string for digits==0 */
8429 } else if (!digits) {
8432 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8433 sv_catpvn(sv, p, l);
8439 #endif /* !USE_LONG_DOUBLE */
8441 if (!args && svix < svmax && DO_UTF8(*svargs))
8444 patend = (char*)pat + patlen;
8445 for (p = (char*)pat; p < patend; p = q) {
8448 bool vectorize = FALSE;
8449 bool vectorarg = FALSE;
8450 bool vec_utf8 = FALSE;
8456 bool has_precis = FALSE;
8458 const I32 osvix = svix;
8459 bool is_utf8 = FALSE; /* is this item utf8? */
8460 #ifdef HAS_LDBL_SPRINTF_BUG
8461 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8462 with sfio - Allen <allens@cpan.org> */
8463 bool fix_ldbl_sprintf_bug = FALSE;
8467 U8 utf8buf[UTF8_MAXBYTES+1];
8468 STRLEN esignlen = 0;
8470 const char *eptr = NULL;
8473 const U8 *vecstr = NULL;
8480 /* we need a long double target in case HAS_LONG_DOUBLE but
8483 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8491 const char *dotstr = ".";
8492 STRLEN dotstrlen = 1;
8493 I32 efix = 0; /* explicit format parameter index */
8494 I32 ewix = 0; /* explicit width index */
8495 I32 epix = 0; /* explicit precision index */
8496 I32 evix = 0; /* explicit vector index */
8497 bool asterisk = FALSE;
8499 /* echo everything up to the next format specification */
8500 for (q = p; q < patend && *q != '%'; ++q) ;
8502 if (has_utf8 && !pat_utf8)
8503 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8505 sv_catpvn(sv, p, q - p);
8512 We allow format specification elements in this order:
8513 \d+\$ explicit format parameter index
8515 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8516 0 flag (as above): repeated to allow "v02"
8517 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8518 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8520 [%bcdefginopsuxDFOUX] format (mandatory)
8525 As of perl5.9.3, printf format checking is on by default.
8526 Internally, perl uses %p formats to provide an escape to
8527 some extended formatting. This block deals with those
8528 extensions: if it does not match, (char*)q is reset and
8529 the normal format processing code is used.
8531 Currently defined extensions are:
8532 %p include pointer address (standard)
8533 %-p (SVf) include an SV (previously %_)
8534 %-<num>p include an SV with precision <num>
8535 %1p (VDf) include a v-string (as %vd)
8536 %<num>p reserved for future extensions
8538 Robin Barker 2005-07-14
8545 n = expect_number(&q);
8552 argsv = va_arg(*args, SV*);
8553 eptr = SvPVx_const(argsv, elen);
8559 else if (n == vdNUMBER) { /* VDf */
8566 if (ckWARN_d(WARN_INTERNAL))
8567 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8568 "internal %%<num>p might conflict with future printf extensions");
8574 if ( (width = expect_number(&q)) ) {
8615 if ( (ewix = expect_number(&q)) )
8624 if ((vectorarg = asterisk)) {
8637 width = expect_number(&q);
8643 vecsv = va_arg(*args, SV*);
8645 vecsv = (evix > 0 && evix <= svmax)
8646 ? svargs[evix-1] : &PL_sv_undef;
8648 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8650 dotstr = SvPV_const(vecsv, dotstrlen);
8651 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8652 bad with tied or overloaded values that return UTF8. */
8655 else if (has_utf8) {
8656 vecsv = sv_mortalcopy(vecsv);
8657 sv_utf8_upgrade(vecsv);
8658 dotstr = SvPV_const(vecsv, dotstrlen);
8665 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8666 vecsv = svargs[efix ? efix-1 : svix++];
8667 vecstr = (U8*)SvPV_const(vecsv,veclen);
8668 vec_utf8 = DO_UTF8(vecsv);
8670 /* if this is a version object, we need to convert
8671 * back into v-string notation and then let the
8672 * vectorize happen normally
8674 if (sv_derived_from(vecsv, "version")) {
8675 char *version = savesvpv(vecsv);
8676 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8677 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8678 "vector argument not supported with alpha versions");
8681 vecsv = sv_newmortal();
8682 /* scan_vstring is expected to be called during
8683 * tokenization, so we need to fake up the end
8684 * of the buffer for it
8686 PL_bufend = version + veclen;
8687 scan_vstring(version, vecsv);
8688 vecstr = (U8*)SvPV_const(vecsv, veclen);
8689 vec_utf8 = DO_UTF8(vecsv);
8701 i = va_arg(*args, int);
8703 i = (ewix ? ewix <= svmax : svix < svmax) ?
8704 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8706 width = (i < 0) ? -i : i;
8716 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8718 /* XXX: todo, support specified precision parameter */
8722 i = va_arg(*args, int);
8724 i = (ewix ? ewix <= svmax : svix < svmax)
8725 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8726 precis = (i < 0) ? 0 : i;
8731 precis = precis * 10 + (*q++ - '0');
8740 case 'I': /* Ix, I32x, and I64x */
8742 if (q[1] == '6' && q[2] == '4') {
8748 if (q[1] == '3' && q[2] == '2') {
8758 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8769 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8770 if (*(q + 1) == 'l') { /* lld, llf */
8796 if (!vectorize && !args) {
8798 const I32 i = efix-1;
8799 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8801 argsv = (svix >= 0 && svix < svmax)
8802 ? svargs[svix++] : &PL_sv_undef;
8813 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8815 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8817 eptr = (char*)utf8buf;
8818 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8832 eptr = va_arg(*args, char*);
8834 #ifdef MACOS_TRADITIONAL
8835 /* On MacOS, %#s format is used for Pascal strings */
8840 elen = strlen(eptr);
8842 eptr = (char *)nullstr;
8843 elen = sizeof nullstr - 1;
8847 eptr = SvPVx_const(argsv, elen);
8848 if (DO_UTF8(argsv)) {
8849 if (has_precis && precis < elen) {
8851 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8854 if (width) { /* fudge width (can't fudge elen) */
8855 width += elen - sv_len_utf8(argsv);
8862 if (has_precis && elen > precis)
8869 if (alt || vectorize)
8871 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8892 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8901 esignbuf[esignlen++] = plus;
8905 case 'h': iv = (short)va_arg(*args, int); break;
8906 case 'l': iv = va_arg(*args, long); break;
8907 case 'V': iv = va_arg(*args, IV); break;
8908 default: iv = va_arg(*args, int); break;
8910 case 'q': iv = va_arg(*args, Quad_t); break;
8915 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8917 case 'h': iv = (short)tiv; break;
8918 case 'l': iv = (long)tiv; break;
8920 default: iv = tiv; break;
8922 case 'q': iv = (Quad_t)tiv; break;
8926 if ( !vectorize ) /* we already set uv above */
8931 esignbuf[esignlen++] = plus;
8935 esignbuf[esignlen++] = '-';
8978 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8989 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8990 case 'l': uv = va_arg(*args, unsigned long); break;
8991 case 'V': uv = va_arg(*args, UV); break;
8992 default: uv = va_arg(*args, unsigned); break;
8994 case 'q': uv = va_arg(*args, Uquad_t); break;
8999 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9001 case 'h': uv = (unsigned short)tuv; break;
9002 case 'l': uv = (unsigned long)tuv; break;
9004 default: uv = tuv; break;
9006 case 'q': uv = (Uquad_t)tuv; break;
9013 char *ptr = ebuf + sizeof ebuf;
9019 p = (char*)((c == 'X')
9020 ? "0123456789ABCDEF" : "0123456789abcdef");
9026 esignbuf[esignlen++] = '0';
9027 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9035 if (alt && *ptr != '0')
9046 esignbuf[esignlen++] = '0';
9047 esignbuf[esignlen++] = 'b';
9050 default: /* it had better be ten or less */
9054 } while (uv /= base);
9057 elen = (ebuf + sizeof ebuf) - ptr;
9061 zeros = precis - elen;
9062 else if (precis == 0 && elen == 1 && *eptr == '0')
9068 /* FLOATING POINT */
9071 c = 'f'; /* maybe %F isn't supported here */
9079 /* This is evil, but floating point is even more evil */
9081 /* for SV-style calling, we can only get NV
9082 for C-style calling, we assume %f is double;
9083 for simplicity we allow any of %Lf, %llf, %qf for long double
9087 #if defined(USE_LONG_DOUBLE)
9091 /* [perl #20339] - we should accept and ignore %lf rather than die */
9095 #if defined(USE_LONG_DOUBLE)
9096 intsize = args ? 0 : 'q';
9100 #if defined(HAS_LONG_DOUBLE)
9109 /* now we need (long double) if intsize == 'q', else (double) */
9111 #if LONG_DOUBLESIZE > DOUBLESIZE
9113 va_arg(*args, long double) :
9114 va_arg(*args, double)
9116 va_arg(*args, double)
9121 if (c != 'e' && c != 'E') {
9123 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9124 will cast our (long double) to (double) */
9125 (void)Perl_frexp(nv, &i);
9126 if (i == PERL_INT_MIN)
9127 Perl_die(aTHX_ "panic: frexp");
9129 need = BIT_DIGITS(i);
9131 need += has_precis ? precis : 6; /* known default */
9136 #ifdef HAS_LDBL_SPRINTF_BUG
9137 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9138 with sfio - Allen <allens@cpan.org> */
9141 # define MY_DBL_MAX DBL_MAX
9142 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9143 # if DOUBLESIZE >= 8
9144 # define MY_DBL_MAX 1.7976931348623157E+308L
9146 # define MY_DBL_MAX 3.40282347E+38L
9150 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9151 # define MY_DBL_MAX_BUG 1L
9153 # define MY_DBL_MAX_BUG MY_DBL_MAX
9157 # define MY_DBL_MIN DBL_MIN
9158 # else /* XXX guessing! -Allen */
9159 # if DOUBLESIZE >= 8
9160 # define MY_DBL_MIN 2.2250738585072014E-308L
9162 # define MY_DBL_MIN 1.17549435E-38L
9166 if ((intsize == 'q') && (c == 'f') &&
9167 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9169 /* it's going to be short enough that
9170 * long double precision is not needed */
9172 if ((nv <= 0L) && (nv >= -0L))
9173 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9175 /* would use Perl_fp_class as a double-check but not
9176 * functional on IRIX - see perl.h comments */
9178 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9179 /* It's within the range that a double can represent */
9180 #if defined(DBL_MAX) && !defined(DBL_MIN)
9181 if ((nv >= ((long double)1/DBL_MAX)) ||
9182 (nv <= (-(long double)1/DBL_MAX)))
9184 fix_ldbl_sprintf_bug = TRUE;
9187 if (fix_ldbl_sprintf_bug == TRUE) {
9197 # undef MY_DBL_MAX_BUG
9200 #endif /* HAS_LDBL_SPRINTF_BUG */
9202 need += 20; /* fudge factor */
9203 if (PL_efloatsize < need) {
9204 Safefree(PL_efloatbuf);
9205 PL_efloatsize = need + 20; /* more fudge */
9206 Newx(PL_efloatbuf, PL_efloatsize, char);
9207 PL_efloatbuf[0] = '\0';
9210 if ( !(width || left || plus || alt) && fill != '0'
9211 && has_precis && intsize != 'q' ) { /* Shortcuts */
9212 /* See earlier comment about buggy Gconvert when digits,
9214 if ( c == 'g' && precis) {
9215 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9216 /* May return an empty string for digits==0 */
9217 if (*PL_efloatbuf) {
9218 elen = strlen(PL_efloatbuf);
9219 goto float_converted;
9221 } else if ( c == 'f' && !precis) {
9222 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9227 char *ptr = ebuf + sizeof ebuf;
9230 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9231 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9232 if (intsize == 'q') {
9233 /* Copy the one or more characters in a long double
9234 * format before the 'base' ([efgEFG]) character to
9235 * the format string. */
9236 static char const prifldbl[] = PERL_PRIfldbl;
9237 char const *p = prifldbl + sizeof(prifldbl) - 3;
9238 while (p >= prifldbl) { *--ptr = *p--; }
9243 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9248 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9260 /* No taint. Otherwise we are in the strange situation
9261 * where printf() taints but print($float) doesn't.
9263 #if defined(HAS_LONG_DOUBLE)
9264 elen = ((intsize == 'q')
9265 ? my_sprintf(PL_efloatbuf, ptr, nv)
9266 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9268 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9272 eptr = PL_efloatbuf;
9280 i = SvCUR(sv) - origlen;
9283 case 'h': *(va_arg(*args, short*)) = i; break;
9284 default: *(va_arg(*args, int*)) = i; break;
9285 case 'l': *(va_arg(*args, long*)) = i; break;
9286 case 'V': *(va_arg(*args, IV*)) = i; break;
9288 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9293 sv_setuv_mg(argsv, (UV)i);
9294 continue; /* not "break" */
9301 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9302 && ckWARN(WARN_PRINTF))
9304 SV * const msg = sv_newmortal();
9305 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9306 (PL_op->op_type == OP_PRTF) ? "" : "s");
9309 Perl_sv_catpvf(aTHX_ msg,
9310 "\"%%%c\"", c & 0xFF);
9312 Perl_sv_catpvf(aTHX_ msg,
9313 "\"%%\\%03"UVof"\"",
9316 sv_catpvs(msg, "end of string");
9317 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9320 /* output mangled stuff ... */
9326 /* ... right here, because formatting flags should not apply */
9327 SvGROW(sv, SvCUR(sv) + elen + 1);
9329 Copy(eptr, p, elen, char);
9332 SvCUR_set(sv, p - SvPVX_const(sv));
9334 continue; /* not "break" */
9337 /* calculate width before utf8_upgrade changes it */
9338 have = esignlen + zeros + elen;
9340 Perl_croak_nocontext(PL_memory_wrap);
9342 if (is_utf8 != has_utf8) {
9345 sv_utf8_upgrade(sv);
9348 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9349 sv_utf8_upgrade(nsv);
9350 eptr = SvPVX_const(nsv);
9353 SvGROW(sv, SvCUR(sv) + elen + 1);
9358 need = (have > width ? have : width);
9361 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9362 Perl_croak_nocontext(PL_memory_wrap);
9363 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9365 if (esignlen && fill == '0') {
9367 for (i = 0; i < (int)esignlen; i++)
9371 memset(p, fill, gap);
9374 if (esignlen && fill != '0') {
9376 for (i = 0; i < (int)esignlen; i++)
9381 for (i = zeros; i; i--)
9385 Copy(eptr, p, elen, char);
9389 memset(p, ' ', gap);
9394 Copy(dotstr, p, dotstrlen, char);
9398 vectorize = FALSE; /* done iterating over vecstr */
9405 SvCUR_set(sv, p - SvPVX_const(sv));
9413 /* =========================================================================
9415 =head1 Cloning an interpreter
9417 All the macros and functions in this section are for the private use of
9418 the main function, perl_clone().
9420 The foo_dup() functions make an exact copy of an existing foo thinngy.
9421 During the course of a cloning, a hash table is used to map old addresses
9422 to new addresses. The table is created and manipulated with the
9423 ptr_table_* functions.
9427 ============================================================================*/
9430 #if defined(USE_ITHREADS)
9432 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9433 #ifndef GpREFCNT_inc
9434 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9438 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9439 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9440 please unmerge ss_dup. */
9441 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9442 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9443 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9444 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9445 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9446 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9447 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9448 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9449 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9450 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9451 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9452 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9453 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9454 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9457 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9458 regcomp.c. AMS 20010712 */
9461 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9466 struct reg_substr_datum *s;
9469 return (REGEXP *)NULL;
9471 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9474 len = r->offsets[0];
9475 npar = r->nparens+1;
9477 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9478 Copy(r->program, ret->program, len+1, regnode);
9480 Newx(ret->startp, npar, I32);
9481 Copy(r->startp, ret->startp, npar, I32);
9482 Newx(ret->endp, npar, I32);
9483 Copy(r->startp, ret->startp, npar, I32);
9485 Newx(ret->substrs, 1, struct reg_substr_data);
9486 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9487 s->min_offset = r->substrs->data[i].min_offset;
9488 s->max_offset = r->substrs->data[i].max_offset;
9489 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9490 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9493 ret->regstclass = NULL;
9496 const int count = r->data->count;
9499 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9500 char, struct reg_data);
9501 Newx(d->what, count, U8);
9504 for (i = 0; i < count; i++) {
9505 d->what[i] = r->data->what[i];
9506 switch (d->what[i]) {
9507 /* legal options are one of: sfpont
9508 see also regcomp.h and pregfree() */
9510 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9513 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9516 /* This is cheating. */
9517 Newx(d->data[i], 1, struct regnode_charclass_class);
9518 StructCopy(r->data->data[i], d->data[i],
9519 struct regnode_charclass_class);
9520 ret->regstclass = (regnode*)d->data[i];
9523 /* Compiled op trees are readonly, and can thus be
9524 shared without duplication. */
9526 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9530 d->data[i] = r->data->data[i];
9533 d->data[i] = r->data->data[i];
9535 ((reg_trie_data*)d->data[i])->refcount++;
9539 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9548 Newx(ret->offsets, 2*len+1, U32);
9549 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9551 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9552 ret->refcnt = r->refcnt;
9553 ret->minlen = r->minlen;
9554 ret->prelen = r->prelen;
9555 ret->nparens = r->nparens;
9556 ret->lastparen = r->lastparen;
9557 ret->lastcloseparen = r->lastcloseparen;
9558 ret->reganch = r->reganch;
9560 ret->sublen = r->sublen;
9562 if (RX_MATCH_COPIED(ret))
9563 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9566 #ifdef PERL_OLD_COPY_ON_WRITE
9567 ret->saved_copy = NULL;
9570 ptr_table_store(PL_ptr_table, r, ret);
9574 /* duplicate a file handle */
9577 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9581 PERL_UNUSED_ARG(type);
9584 return (PerlIO*)NULL;
9586 /* look for it in the table first */
9587 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9591 /* create anew and remember what it is */
9592 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9593 ptr_table_store(PL_ptr_table, fp, ret);
9597 /* duplicate a directory handle */
9600 Perl_dirp_dup(pTHX_ DIR *dp)
9602 PERL_UNUSED_CONTEXT;
9609 /* duplicate a typeglob */
9612 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9618 /* look for it in the table first */
9619 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9623 /* create anew and remember what it is */
9625 ptr_table_store(PL_ptr_table, gp, ret);
9628 ret->gp_refcnt = 0; /* must be before any other dups! */
9629 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9630 ret->gp_io = io_dup_inc(gp->gp_io, param);
9631 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9632 ret->gp_av = av_dup_inc(gp->gp_av, param);
9633 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9634 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9635 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9636 ret->gp_cvgen = gp->gp_cvgen;
9637 ret->gp_line = gp->gp_line;
9638 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9642 /* duplicate a chain of magic */
9645 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9647 MAGIC *mgprev = (MAGIC*)NULL;
9650 return (MAGIC*)NULL;
9651 /* look for it in the table first */
9652 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9656 for (; mg; mg = mg->mg_moremagic) {
9658 Newxz(nmg, 1, MAGIC);
9660 mgprev->mg_moremagic = nmg;
9663 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9664 nmg->mg_private = mg->mg_private;
9665 nmg->mg_type = mg->mg_type;
9666 nmg->mg_flags = mg->mg_flags;
9667 if (mg->mg_type == PERL_MAGIC_qr) {
9668 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9670 else if(mg->mg_type == PERL_MAGIC_backref) {
9671 /* The backref AV has its reference count deliberately bumped by
9673 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9675 else if (mg->mg_type == PERL_MAGIC_symtab) {
9676 nmg->mg_obj = mg->mg_obj;
9679 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9680 ? sv_dup_inc(mg->mg_obj, param)
9681 : sv_dup(mg->mg_obj, param);
9683 nmg->mg_len = mg->mg_len;
9684 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9685 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9686 if (mg->mg_len > 0) {
9687 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9688 if (mg->mg_type == PERL_MAGIC_overload_table &&
9689 AMT_AMAGIC((AMT*)mg->mg_ptr))
9691 const AMT * const amtp = (AMT*)mg->mg_ptr;
9692 AMT * const namtp = (AMT*)nmg->mg_ptr;
9694 for (i = 1; i < NofAMmeth; i++) {
9695 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9699 else if (mg->mg_len == HEf_SVKEY)
9700 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9702 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9703 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9710 /* create a new pointer-mapping table */
9713 Perl_ptr_table_new(pTHX)
9716 PERL_UNUSED_CONTEXT;
9718 Newxz(tbl, 1, PTR_TBL_t);
9721 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9725 #define PTR_TABLE_HASH(ptr) \
9726 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9729 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9730 following define) and at call to new_body_inline made below in
9731 Perl_ptr_table_store()
9734 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9736 /* map an existing pointer using a table */
9738 STATIC PTR_TBL_ENT_t *
9739 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9740 PTR_TBL_ENT_t *tblent;
9741 const UV hash = PTR_TABLE_HASH(sv);
9743 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9744 for (; tblent; tblent = tblent->next) {
9745 if (tblent->oldval == sv)
9752 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9754 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9755 PERL_UNUSED_CONTEXT;
9756 return tblent ? tblent->newval : NULL;
9759 /* add a new entry to a pointer-mapping table */
9762 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9764 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9765 PERL_UNUSED_CONTEXT;
9768 tblent->newval = newsv;
9770 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9772 new_body_inline(tblent, PTE_SVSLOT);
9774 tblent->oldval = oldsv;
9775 tblent->newval = newsv;
9776 tblent->next = tbl->tbl_ary[entry];
9777 tbl->tbl_ary[entry] = tblent;
9779 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9780 ptr_table_split(tbl);
9784 /* double the hash bucket size of an existing ptr table */
9787 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9789 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9790 const UV oldsize = tbl->tbl_max + 1;
9791 UV newsize = oldsize * 2;
9793 PERL_UNUSED_CONTEXT;
9795 Renew(ary, newsize, PTR_TBL_ENT_t*);
9796 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9797 tbl->tbl_max = --newsize;
9799 for (i=0; i < oldsize; i++, ary++) {
9800 PTR_TBL_ENT_t **curentp, **entp, *ent;
9803 curentp = ary + oldsize;
9804 for (entp = ary, ent = *ary; ent; ent = *entp) {
9805 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9807 ent->next = *curentp;
9817 /* remove all the entries from a ptr table */
9820 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9822 if (tbl && tbl->tbl_items) {
9823 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9824 UV riter = tbl->tbl_max;
9827 PTR_TBL_ENT_t *entry = array[riter];
9830 PTR_TBL_ENT_t * const oentry = entry;
9831 entry = entry->next;
9840 /* clear and free a ptr table */
9843 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9848 ptr_table_clear(tbl);
9849 Safefree(tbl->tbl_ary);
9855 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9858 SvRV_set(dstr, SvWEAKREF(sstr)
9859 ? sv_dup(SvRV(sstr), param)
9860 : sv_dup_inc(SvRV(sstr), param));
9863 else if (SvPVX_const(sstr)) {
9864 /* Has something there */
9866 /* Normal PV - clone whole allocated space */
9867 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9868 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9869 /* Not that normal - actually sstr is copy on write.
9870 But we are a true, independant SV, so: */
9871 SvREADONLY_off(dstr);
9876 /* Special case - not normally malloced for some reason */
9877 if (isGV_with_GP(sstr)) {
9878 /* Don't need to do anything here. */
9880 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9881 /* A "shared" PV - clone it as "shared" PV */
9883 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9887 /* Some other special case - random pointer */
9888 SvPV_set(dstr, SvPVX(sstr));
9894 if (SvTYPE(dstr) == SVt_RV)
9895 SvRV_set(dstr, NULL);
9897 SvPV_set(dstr, NULL);
9901 /* duplicate an SV of any type (including AV, HV etc) */
9904 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9909 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9911 /* look for it in the table first */
9912 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9916 if(param->flags & CLONEf_JOIN_IN) {
9917 /** We are joining here so we don't want do clone
9918 something that is bad **/
9919 if (SvTYPE(sstr) == SVt_PVHV) {
9920 const char * const hvname = HvNAME_get(sstr);
9922 /** don't clone stashes if they already exist **/
9923 return (SV*)gv_stashpv(hvname,0);
9927 /* create anew and remember what it is */
9930 #ifdef DEBUG_LEAKING_SCALARS
9931 dstr->sv_debug_optype = sstr->sv_debug_optype;
9932 dstr->sv_debug_line = sstr->sv_debug_line;
9933 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9934 dstr->sv_debug_cloned = 1;
9935 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9938 ptr_table_store(PL_ptr_table, sstr, dstr);
9941 SvFLAGS(dstr) = SvFLAGS(sstr);
9942 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9943 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9946 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9947 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9948 PL_watch_pvx, SvPVX_const(sstr));
9951 /* don't clone objects whose class has asked us not to */
9952 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9953 SvFLAGS(dstr) &= ~SVTYPEMASK;
9958 switch (SvTYPE(sstr)) {
9963 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9964 SvIV_set(dstr, SvIVX(sstr));
9967 SvANY(dstr) = new_XNV();
9968 SvNV_set(dstr, SvNVX(sstr));
9971 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9972 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9976 /* These are all the types that need complex bodies allocating. */
9978 const svtype sv_type = SvTYPE(sstr);
9979 const struct body_details *const sv_type_details
9980 = bodies_by_type + sv_type;
9984 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9988 if (GvUNIQUE((GV*)sstr)) {
9989 /*EMPTY*/; /* Do sharing here, and fall through */
10002 assert(sv_type_details->body_size);
10003 if (sv_type_details->arena) {
10004 new_body_inline(new_body, sv_type);
10006 = (void*)((char*)new_body - sv_type_details->offset);
10008 new_body = new_NOARENA(sv_type_details);
10012 SvANY(dstr) = new_body;
10015 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10016 ((char*)SvANY(dstr)) + sv_type_details->offset,
10017 sv_type_details->copy, char);
10019 Copy(((char*)SvANY(sstr)),
10020 ((char*)SvANY(dstr)),
10021 sv_type_details->body_size + sv_type_details->offset, char);
10024 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10025 && !isGV_with_GP(dstr))
10026 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10028 /* The Copy above means that all the source (unduplicated) pointers
10029 are now in the destination. We can check the flags and the
10030 pointers in either, but it's possible that there's less cache
10031 missing by always going for the destination.
10032 FIXME - instrument and check that assumption */
10033 if (sv_type >= SVt_PVMG) {
10035 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
10036 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
10037 } else if (SvMAGIC(dstr))
10038 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10040 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10043 /* The cast silences a GCC warning about unhandled types. */
10044 switch ((int)sv_type) {
10056 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10057 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10058 LvTARG(dstr) = dstr;
10059 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10060 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10062 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10065 if (GvNAME_HEK(dstr))
10066 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10068 /* Don't call sv_add_backref here as it's going to be created
10069 as part of the magic cloning of the symbol table. */
10070 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10071 if(isGV_with_GP(sstr)) {
10072 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10073 at the point of this comment. */
10074 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10075 (void)GpREFCNT_inc(GvGP(dstr));
10077 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10080 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10081 if (IoOFP(dstr) == IoIFP(sstr))
10082 IoOFP(dstr) = IoIFP(dstr);
10084 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10085 /* PL_rsfp_filters entries have fake IoDIRP() */
10086 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10087 /* I have no idea why fake dirp (rsfps)
10088 should be treated differently but otherwise
10089 we end up with leaks -- sky*/
10090 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10091 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10092 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10094 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10095 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10096 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10097 if (IoDIRP(dstr)) {
10098 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10101 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10104 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10105 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10106 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10109 if (AvARRAY((AV*)sstr)) {
10110 SV **dst_ary, **src_ary;
10111 SSize_t items = AvFILLp((AV*)sstr) + 1;
10113 src_ary = AvARRAY((AV*)sstr);
10114 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10115 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10116 SvPV_set(dstr, (char*)dst_ary);
10117 AvALLOC((AV*)dstr) = dst_ary;
10118 if (AvREAL((AV*)sstr)) {
10119 while (items-- > 0)
10120 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10123 while (items-- > 0)
10124 *dst_ary++ = sv_dup(*src_ary++, param);
10126 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10127 while (items-- > 0) {
10128 *dst_ary++ = &PL_sv_undef;
10132 SvPV_set(dstr, NULL);
10133 AvALLOC((AV*)dstr) = (SV**)NULL;
10138 HEK *hvname = NULL;
10140 if (HvARRAY((HV*)sstr)) {
10142 const bool sharekeys = !!HvSHAREKEYS(sstr);
10143 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10144 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10146 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10147 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10149 HvARRAY(dstr) = (HE**)darray;
10150 while (i <= sxhv->xhv_max) {
10151 const HE *source = HvARRAY(sstr)[i];
10152 HvARRAY(dstr)[i] = source
10153 ? he_dup(source, sharekeys, param) : 0;
10157 struct xpvhv_aux * const saux = HvAUX(sstr);
10158 struct xpvhv_aux * const daux = HvAUX(dstr);
10159 /* This flag isn't copied. */
10160 /* SvOOK_on(hv) attacks the IV flags. */
10161 SvFLAGS(dstr) |= SVf_OOK;
10163 hvname = saux->xhv_name;
10165 = hvname ? hek_dup(hvname, param) : hvname;
10167 daux->xhv_riter = saux->xhv_riter;
10168 daux->xhv_eiter = saux->xhv_eiter
10169 ? he_dup(saux->xhv_eiter,
10170 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10171 daux->xhv_backreferences = saux->xhv_backreferences
10172 ? (AV*) SvREFCNT_inc(
10174 xhv_backreferences,
10180 SvPV_set(dstr, NULL);
10182 /* Record stashes for possible cloning in Perl_clone(). */
10184 av_push(param->stashes, dstr);
10188 if (!(param->flags & CLONEf_COPY_STACKS)) {
10192 /* NOTE: not refcounted */
10193 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10195 if (!CvISXSUB(dstr))
10196 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10198 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10199 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10200 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10201 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10203 /* don't dup if copying back - CvGV isn't refcounted, so the
10204 * duped GV may never be freed. A bit of a hack! DAPM */
10205 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10206 NULL : gv_dup(CvGV(dstr), param) ;
10207 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10209 CvWEAKOUTSIDE(sstr)
10210 ? cv_dup( CvOUTSIDE(dstr), param)
10211 : cv_dup_inc(CvOUTSIDE(dstr), param);
10212 if (!CvISXSUB(dstr))
10213 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10219 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10225 /* duplicate a context */
10228 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10230 PERL_CONTEXT *ncxs;
10233 return (PERL_CONTEXT*)NULL;
10235 /* look for it in the table first */
10236 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10240 /* create anew and remember what it is */
10241 Newxz(ncxs, max + 1, PERL_CONTEXT);
10242 ptr_table_store(PL_ptr_table, cxs, ncxs);
10245 PERL_CONTEXT * const cx = &cxs[ix];
10246 PERL_CONTEXT * const ncx = &ncxs[ix];
10247 ncx->cx_type = cx->cx_type;
10248 if (CxTYPE(cx) == CXt_SUBST) {
10249 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10252 ncx->blk_oldsp = cx->blk_oldsp;
10253 ncx->blk_oldcop = cx->blk_oldcop;
10254 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10255 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10256 ncx->blk_oldpm = cx->blk_oldpm;
10257 ncx->blk_gimme = cx->blk_gimme;
10258 switch (CxTYPE(cx)) {
10260 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10261 ? cv_dup_inc(cx->blk_sub.cv, param)
10262 : cv_dup(cx->blk_sub.cv,param));
10263 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10264 ? av_dup_inc(cx->blk_sub.argarray, param)
10266 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10267 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10268 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10269 ncx->blk_sub.lval = cx->blk_sub.lval;
10270 ncx->blk_sub.retop = cx->blk_sub.retop;
10273 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10274 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10275 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10276 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10277 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10278 ncx->blk_eval.retop = cx->blk_eval.retop;
10281 ncx->blk_loop.label = cx->blk_loop.label;
10282 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10283 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10284 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10285 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10286 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10287 ? cx->blk_loop.iterdata
10288 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10289 ncx->blk_loop.oldcomppad
10290 = (PAD*)ptr_table_fetch(PL_ptr_table,
10291 cx->blk_loop.oldcomppad);
10292 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10293 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10294 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10295 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10296 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10299 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10300 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10301 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10302 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10303 ncx->blk_sub.retop = cx->blk_sub.retop;
10315 /* duplicate a stack info structure */
10318 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10323 return (PERL_SI*)NULL;
10325 /* look for it in the table first */
10326 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10330 /* create anew and remember what it is */
10331 Newxz(nsi, 1, PERL_SI);
10332 ptr_table_store(PL_ptr_table, si, nsi);
10334 nsi->si_stack = av_dup_inc(si->si_stack, param);
10335 nsi->si_cxix = si->si_cxix;
10336 nsi->si_cxmax = si->si_cxmax;
10337 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10338 nsi->si_type = si->si_type;
10339 nsi->si_prev = si_dup(si->si_prev, param);
10340 nsi->si_next = si_dup(si->si_next, param);
10341 nsi->si_markoff = si->si_markoff;
10346 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10347 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10348 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10349 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10350 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10351 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10352 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10353 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10354 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10355 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10356 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10357 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10358 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10359 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10362 #define pv_dup_inc(p) SAVEPV(p)
10363 #define pv_dup(p) SAVEPV(p)
10364 #define svp_dup_inc(p,pp) any_dup(p,pp)
10366 /* map any object to the new equivent - either something in the
10367 * ptr table, or something in the interpreter structure
10371 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10376 return (void*)NULL;
10378 /* look for it in the table first */
10379 ret = ptr_table_fetch(PL_ptr_table, v);
10383 /* see if it is part of the interpreter structure */
10384 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10385 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10393 /* duplicate the save stack */
10396 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10398 ANY * const ss = proto_perl->Tsavestack;
10399 const I32 max = proto_perl->Tsavestack_max;
10400 I32 ix = proto_perl->Tsavestack_ix;
10412 void (*dptr) (void*);
10413 void (*dxptr) (pTHX_ void*);
10415 Newxz(nss, max, ANY);
10418 I32 i = POPINT(ss,ix);
10419 TOPINT(nss,ix) = i;
10421 case SAVEt_ITEM: /* normal string */
10422 case SAVEt_SV: /* scalar reference */
10423 sv = (SV*)POPPTR(ss,ix);
10424 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10425 sv = (SV*)POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10428 case SAVEt_SHARED_PVREF: /* char* in shared space */
10429 c = (char*)POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = savesharedpv(c);
10431 ptr = POPPTR(ss,ix);
10432 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10434 case SAVEt_GENERIC_SVREF: /* generic sv */
10435 case SAVEt_SVREF: /* scalar reference */
10436 sv = (SV*)POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10438 ptr = POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10441 case SAVEt_HV: /* hash reference */
10442 case SAVEt_AV: /* array reference */
10443 sv = POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10445 gv = (GV*)POPPTR(ss,ix);
10446 TOPPTR(nss,ix) = gv_dup(gv, param);
10448 case SAVEt_INT: /* int reference */
10449 ptr = POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10451 intval = (int)POPINT(ss,ix);
10452 TOPINT(nss,ix) = intval;
10454 case SAVEt_LONG: /* long reference */
10455 ptr = POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10457 longval = (long)POPLONG(ss,ix);
10458 TOPLONG(nss,ix) = longval;
10460 case SAVEt_I32: /* I32 reference */
10461 case SAVEt_I16: /* I16 reference */
10462 case SAVEt_I8: /* I8 reference */
10463 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10464 ptr = POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10467 TOPINT(nss,ix) = i;
10469 case SAVEt_IV: /* IV reference */
10470 ptr = POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10473 TOPIV(nss,ix) = iv;
10475 case SAVEt_HPTR: /* HV* reference */
10476 case SAVEt_APTR: /* AV* reference */
10477 case SAVEt_SPTR: /* SV* reference */
10478 ptr = POPPTR(ss,ix);
10479 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10480 sv = (SV*)POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = sv_dup(sv, param);
10483 case SAVEt_VPTR: /* random* reference */
10484 ptr = POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10486 ptr = POPPTR(ss,ix);
10487 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10489 case SAVEt_GENERIC_PVREF: /* generic char* */
10490 case SAVEt_PPTR: /* char* reference */
10491 ptr = POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10493 c = (char*)POPPTR(ss,ix);
10494 TOPPTR(nss,ix) = pv_dup(c);
10497 gv = (GV*)POPPTR(ss,ix);
10498 TOPPTR(nss,ix) = gv_dup(gv, param);
10500 case SAVEt_GP: /* scalar reference */
10501 gp = (GP*)POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10503 (void)GpREFCNT_inc(gp);
10504 gv = (GV*)POPPTR(ss,ix);
10505 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10506 c = (char*)POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = pv_dup(c);
10509 TOPIV(nss,ix) = iv;
10511 TOPIV(nss,ix) = iv;
10514 case SAVEt_MORTALIZESV:
10515 sv = (SV*)POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10519 ptr = POPPTR(ss,ix);
10520 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10521 /* these are assumed to be refcounted properly */
10523 switch (((OP*)ptr)->op_type) {
10525 case OP_LEAVESUBLV:
10529 case OP_LEAVEWRITE:
10530 TOPPTR(nss,ix) = ptr;
10535 TOPPTR(nss,ix) = NULL;
10540 TOPPTR(nss,ix) = NULL;
10543 c = (char*)POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = pv_dup_inc(c);
10546 case SAVEt_CLEARSV:
10547 longval = POPLONG(ss,ix);
10548 TOPLONG(nss,ix) = longval;
10551 hv = (HV*)POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10553 c = (char*)POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = pv_dup_inc(c);
10556 TOPINT(nss,ix) = i;
10558 case SAVEt_DESTRUCTOR:
10559 ptr = POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10561 dptr = POPDPTR(ss,ix);
10562 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10563 any_dup(FPTR2DPTR(void *, dptr),
10566 case SAVEt_DESTRUCTOR_X:
10567 ptr = POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10569 dxptr = POPDXPTR(ss,ix);
10570 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10571 any_dup(FPTR2DPTR(void *, dxptr),
10574 case SAVEt_REGCONTEXT:
10577 TOPINT(nss,ix) = i;
10580 case SAVEt_STACK_POS: /* Position on Perl stack */
10582 TOPINT(nss,ix) = i;
10584 case SAVEt_AELEM: /* array element */
10585 sv = (SV*)POPPTR(ss,ix);
10586 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10588 TOPINT(nss,ix) = i;
10589 av = (AV*)POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = av_dup_inc(av, param);
10592 case SAVEt_HELEM: /* hash element */
10593 sv = (SV*)POPPTR(ss,ix);
10594 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10595 sv = (SV*)POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10597 hv = (HV*)POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10601 ptr = POPPTR(ss,ix);
10602 TOPPTR(nss,ix) = ptr;
10606 TOPINT(nss,ix) = i;
10607 ptr = POPPTR(ss,ix);
10610 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10611 HINTS_REFCNT_UNLOCK;
10613 TOPPTR(nss,ix) = ptr;
10614 if (i & HINT_LOCALIZE_HH) {
10615 hv = (HV*)POPPTR(ss,ix);
10616 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10619 case SAVEt_COMPPAD:
10620 av = (AV*)POPPTR(ss,ix);
10621 TOPPTR(nss,ix) = av_dup(av, param);
10624 longval = (long)POPLONG(ss,ix);
10625 TOPLONG(nss,ix) = longval;
10626 ptr = POPPTR(ss,ix);
10627 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10628 sv = (SV*)POPPTR(ss,ix);
10629 TOPPTR(nss,ix) = sv_dup(sv, param);
10632 ptr = POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10634 longval = (long)POPBOOL(ss,ix);
10635 TOPBOOL(nss,ix) = (bool)longval;
10637 case SAVEt_SET_SVFLAGS:
10639 TOPINT(nss,ix) = i;
10641 TOPINT(nss,ix) = i;
10642 sv = (SV*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = sv_dup(sv, param);
10645 case SAVEt_RE_STATE:
10647 const struct re_save_state *const old_state
10648 = (struct re_save_state *)
10649 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10650 struct re_save_state *const new_state
10651 = (struct re_save_state *)
10652 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10654 Copy(old_state, new_state, 1, struct re_save_state);
10655 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10657 new_state->re_state_bostr
10658 = pv_dup(old_state->re_state_bostr);
10659 new_state->re_state_reginput
10660 = pv_dup(old_state->re_state_reginput);
10661 new_state->re_state_regeol
10662 = pv_dup(old_state->re_state_regeol);
10663 new_state->re_state_regstartp
10664 = any_dup(old_state->re_state_regstartp, proto_perl);
10665 new_state->re_state_regendp
10666 = any_dup(old_state->re_state_regendp, proto_perl);
10667 new_state->re_state_reglastparen
10668 = any_dup(old_state->re_state_reglastparen, proto_perl);
10669 new_state->re_state_reglastcloseparen
10670 = any_dup(old_state->re_state_reglastcloseparen,
10672 /* XXX This just has to be broken. The old save_re_context
10673 code did SAVEGENERICPV(PL_reg_start_tmp);
10674 PL_reg_start_tmp is char **.
10675 Look above to what the dup code does for
10676 SAVEt_GENERIC_PVREF
10677 It can never have worked.
10678 So this is merely a faithful copy of the exiting bug: */
10679 new_state->re_state_reg_start_tmp
10680 = (char **) pv_dup((char *)
10681 old_state->re_state_reg_start_tmp);
10682 /* I assume that it only ever "worked" because no-one called
10683 (pseudo)fork while the regexp engine had re-entered itself.
10685 #ifdef PERL_OLD_COPY_ON_WRITE
10686 new_state->re_state_nrs
10687 = sv_dup(old_state->re_state_nrs, param);
10689 new_state->re_state_reg_magic
10690 = any_dup(old_state->re_state_reg_magic, proto_perl);
10691 new_state->re_state_reg_oldcurpm
10692 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10693 new_state->re_state_reg_curpm
10694 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10695 new_state->re_state_reg_oldsaved
10696 = pv_dup(old_state->re_state_reg_oldsaved);
10697 new_state->re_state_reg_poscache
10698 = pv_dup(old_state->re_state_reg_poscache);
10699 new_state->re_state_reg_starttry
10700 = pv_dup(old_state->re_state_reg_starttry);
10703 case SAVEt_COMPILE_WARNINGS:
10704 ptr = POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10708 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10716 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10717 * flag to the result. This is done for each stash before cloning starts,
10718 * so we know which stashes want their objects cloned */
10721 do_mark_cloneable_stash(pTHX_ SV *sv)
10723 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10725 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10726 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10727 if (cloner && GvCV(cloner)) {
10734 XPUSHs(sv_2mortal(newSVhek(hvname)));
10736 call_sv((SV*)GvCV(cloner), G_SCALAR);
10743 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10751 =for apidoc perl_clone
10753 Create and return a new interpreter by cloning the current one.
10755 perl_clone takes these flags as parameters:
10757 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10758 without it we only clone the data and zero the stacks,
10759 with it we copy the stacks and the new perl interpreter is
10760 ready to run at the exact same point as the previous one.
10761 The pseudo-fork code uses COPY_STACKS while the
10762 threads->new doesn't.
10764 CLONEf_KEEP_PTR_TABLE
10765 perl_clone keeps a ptr_table with the pointer of the old
10766 variable as a key and the new variable as a value,
10767 this allows it to check if something has been cloned and not
10768 clone it again but rather just use the value and increase the
10769 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10770 the ptr_table using the function
10771 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10772 reason to keep it around is if you want to dup some of your own
10773 variable who are outside the graph perl scans, example of this
10774 code is in threads.xs create
10777 This is a win32 thing, it is ignored on unix, it tells perls
10778 win32host code (which is c++) to clone itself, this is needed on
10779 win32 if you want to run two threads at the same time,
10780 if you just want to do some stuff in a separate perl interpreter
10781 and then throw it away and return to the original one,
10782 you don't need to do anything.
10787 /* XXX the above needs expanding by someone who actually understands it ! */
10788 EXTERN_C PerlInterpreter *
10789 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10792 perl_clone(PerlInterpreter *proto_perl, UV flags)
10795 #ifdef PERL_IMPLICIT_SYS
10797 /* perlhost.h so we need to call into it
10798 to clone the host, CPerlHost should have a c interface, sky */
10800 if (flags & CLONEf_CLONE_HOST) {
10801 return perl_clone_host(proto_perl,flags);
10803 return perl_clone_using(proto_perl, flags,
10805 proto_perl->IMemShared,
10806 proto_perl->IMemParse,
10808 proto_perl->IStdIO,
10812 proto_perl->IProc);
10816 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10817 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10818 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10819 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10820 struct IPerlDir* ipD, struct IPerlSock* ipS,
10821 struct IPerlProc* ipP)
10823 /* XXX many of the string copies here can be optimized if they're
10824 * constants; they need to be allocated as common memory and just
10825 * their pointers copied. */
10828 CLONE_PARAMS clone_params;
10829 CLONE_PARAMS* const param = &clone_params;
10831 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10832 /* for each stash, determine whether its objects should be cloned */
10833 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10834 PERL_SET_THX(my_perl);
10837 PoisonNew(my_perl, 1, PerlInterpreter);
10843 PL_savestack_ix = 0;
10844 PL_savestack_max = -1;
10845 PL_sig_pending = 0;
10846 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10847 # else /* !DEBUGGING */
10848 Zero(my_perl, 1, PerlInterpreter);
10849 # endif /* DEBUGGING */
10851 /* host pointers */
10853 PL_MemShared = ipMS;
10854 PL_MemParse = ipMP;
10861 #else /* !PERL_IMPLICIT_SYS */
10863 CLONE_PARAMS clone_params;
10864 CLONE_PARAMS* param = &clone_params;
10865 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10866 /* for each stash, determine whether its objects should be cloned */
10867 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10868 PERL_SET_THX(my_perl);
10871 PoisonNew(my_perl, 1, PerlInterpreter);
10877 PL_savestack_ix = 0;
10878 PL_savestack_max = -1;
10879 PL_sig_pending = 0;
10880 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10881 # else /* !DEBUGGING */
10882 Zero(my_perl, 1, PerlInterpreter);
10883 # endif /* DEBUGGING */
10884 #endif /* PERL_IMPLICIT_SYS */
10885 param->flags = flags;
10886 param->proto_perl = proto_perl;
10888 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10890 PL_body_arenas = NULL;
10891 Zero(&PL_body_roots, 1, PL_body_roots);
10893 PL_nice_chunk = NULL;
10894 PL_nice_chunk_size = 0;
10896 PL_sv_objcount = 0;
10898 PL_sv_arenaroot = NULL;
10900 PL_debug = proto_perl->Idebug;
10902 PL_hash_seed = proto_perl->Ihash_seed;
10903 PL_rehash_seed = proto_perl->Irehash_seed;
10905 #ifdef USE_REENTRANT_API
10906 /* XXX: things like -Dm will segfault here in perlio, but doing
10907 * PERL_SET_CONTEXT(proto_perl);
10908 * breaks too many other things
10910 Perl_reentrant_init(aTHX);
10913 /* create SV map for pointer relocation */
10914 PL_ptr_table = ptr_table_new();
10916 /* initialize these special pointers as early as possible */
10917 SvANY(&PL_sv_undef) = NULL;
10918 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10919 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10920 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10922 SvANY(&PL_sv_no) = new_XPVNV();
10923 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10924 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10925 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10926 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10927 SvCUR_set(&PL_sv_no, 0);
10928 SvLEN_set(&PL_sv_no, 1);
10929 SvIV_set(&PL_sv_no, 0);
10930 SvNV_set(&PL_sv_no, 0);
10931 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10933 SvANY(&PL_sv_yes) = new_XPVNV();
10934 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10935 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10936 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10937 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10938 SvCUR_set(&PL_sv_yes, 1);
10939 SvLEN_set(&PL_sv_yes, 2);
10940 SvIV_set(&PL_sv_yes, 1);
10941 SvNV_set(&PL_sv_yes, 1);
10942 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10944 /* create (a non-shared!) shared string table */
10945 PL_strtab = newHV();
10946 HvSHAREKEYS_off(PL_strtab);
10947 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10948 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10950 PL_compiling = proto_perl->Icompiling;
10952 /* These two PVs will be free'd special way so must set them same way op.c does */
10953 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10954 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10956 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10957 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10959 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10960 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10961 if (!specialCopIO(PL_compiling.cop_io))
10962 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10963 if (PL_compiling.cop_hints) {
10965 PL_compiling.cop_hints->refcounted_he_refcnt++;
10966 HINTS_REFCNT_UNLOCK;
10968 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10970 /* pseudo environmental stuff */
10971 PL_origargc = proto_perl->Iorigargc;
10972 PL_origargv = proto_perl->Iorigargv;
10974 param->stashes = newAV(); /* Setup array of objects to call clone on */
10976 /* Set tainting stuff before PerlIO_debug can possibly get called */
10977 PL_tainting = proto_perl->Itainting;
10978 PL_taint_warn = proto_perl->Itaint_warn;
10980 #ifdef PERLIO_LAYERS
10981 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10982 PerlIO_clone(aTHX_ proto_perl, param);
10985 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10986 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10987 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10988 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10989 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10990 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10993 PL_minus_c = proto_perl->Iminus_c;
10994 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10995 PL_localpatches = proto_perl->Ilocalpatches;
10996 PL_splitstr = proto_perl->Isplitstr;
10997 PL_preprocess = proto_perl->Ipreprocess;
10998 PL_minus_n = proto_perl->Iminus_n;
10999 PL_minus_p = proto_perl->Iminus_p;
11000 PL_minus_l = proto_perl->Iminus_l;
11001 PL_minus_a = proto_perl->Iminus_a;
11002 PL_minus_E = proto_perl->Iminus_E;
11003 PL_minus_F = proto_perl->Iminus_F;
11004 PL_doswitches = proto_perl->Idoswitches;
11005 PL_dowarn = proto_perl->Idowarn;
11006 PL_doextract = proto_perl->Idoextract;
11007 PL_sawampersand = proto_perl->Isawampersand;
11008 PL_unsafe = proto_perl->Iunsafe;
11009 PL_inplace = SAVEPV(proto_perl->Iinplace);
11010 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11011 PL_perldb = proto_perl->Iperldb;
11012 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11013 PL_exit_flags = proto_perl->Iexit_flags;
11015 /* magical thingies */
11016 /* XXX time(&PL_basetime) when asked for? */
11017 PL_basetime = proto_perl->Ibasetime;
11018 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11020 PL_maxsysfd = proto_perl->Imaxsysfd;
11021 PL_statusvalue = proto_perl->Istatusvalue;
11023 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11025 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11027 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11029 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11030 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11031 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11033 /* Clone the regex array */
11034 PL_regex_padav = newAV();
11036 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11037 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11039 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11040 for(i = 1; i <= len; i++) {
11041 const SV * const regex = regexen[i];
11044 ? sv_dup_inc(regex, param)
11046 newSViv(PTR2IV(re_dup(
11047 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11049 av_push(PL_regex_padav, sv);
11052 PL_regex_pad = AvARRAY(PL_regex_padav);
11054 /* shortcuts to various I/O objects */
11055 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11056 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11057 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11058 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11059 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11060 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11062 /* shortcuts to regexp stuff */
11063 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11065 /* shortcuts to misc objects */
11066 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11068 /* shortcuts to debugging objects */
11069 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11070 PL_DBline = gv_dup(proto_perl->IDBline, param);
11071 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11072 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11073 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11074 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11075 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11076 PL_lineary = av_dup(proto_perl->Ilineary, param);
11077 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11079 /* symbol tables */
11080 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11081 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11082 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11083 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11084 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11086 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11087 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11088 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11089 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11090 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11091 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11093 PL_sub_generation = proto_perl->Isub_generation;
11095 /* funky return mechanisms */
11096 PL_forkprocess = proto_perl->Iforkprocess;
11098 /* subprocess state */
11099 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11101 /* internal state */
11102 PL_maxo = proto_perl->Imaxo;
11103 if (proto_perl->Iop_mask)
11104 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11107 /* PL_asserting = proto_perl->Iasserting; */
11109 /* current interpreter roots */
11110 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11111 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11112 PL_main_start = proto_perl->Imain_start;
11113 PL_eval_root = proto_perl->Ieval_root;
11114 PL_eval_start = proto_perl->Ieval_start;
11116 /* runtime control stuff */
11117 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11118 PL_copline = proto_perl->Icopline;
11120 PL_filemode = proto_perl->Ifilemode;
11121 PL_lastfd = proto_perl->Ilastfd;
11122 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11125 PL_gensym = proto_perl->Igensym;
11126 PL_preambled = proto_perl->Ipreambled;
11127 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11128 PL_laststatval = proto_perl->Ilaststatval;
11129 PL_laststype = proto_perl->Ilaststype;
11132 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11134 /* interpreter atexit processing */
11135 PL_exitlistlen = proto_perl->Iexitlistlen;
11136 if (PL_exitlistlen) {
11137 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11138 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11141 PL_exitlist = (PerlExitListEntry*)NULL;
11143 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11144 if (PL_my_cxt_size) {
11145 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11146 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11149 PL_my_cxt_list = (void**)NULL;
11150 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11151 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11152 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11154 PL_profiledata = NULL;
11155 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11156 /* PL_rsfp_filters entries have fake IoDIRP() */
11157 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11159 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11161 PAD_CLONE_VARS(proto_perl, param);
11163 #ifdef HAVE_INTERP_INTERN
11164 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11167 /* more statics moved here */
11168 PL_generation = proto_perl->Igeneration;
11169 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11171 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11172 PL_in_clean_all = proto_perl->Iin_clean_all;
11174 PL_uid = proto_perl->Iuid;
11175 PL_euid = proto_perl->Ieuid;
11176 PL_gid = proto_perl->Igid;
11177 PL_egid = proto_perl->Iegid;
11178 PL_nomemok = proto_perl->Inomemok;
11179 PL_an = proto_perl->Ian;
11180 PL_evalseq = proto_perl->Ievalseq;
11181 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11182 PL_origalen = proto_perl->Iorigalen;
11183 #ifdef PERL_USES_PL_PIDSTATUS
11184 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11186 PL_osname = SAVEPV(proto_perl->Iosname);
11187 PL_sighandlerp = proto_perl->Isighandlerp;
11189 PL_runops = proto_perl->Irunops;
11191 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11194 PL_cshlen = proto_perl->Icshlen;
11195 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11198 PL_lex_state = proto_perl->Ilex_state;
11199 PL_lex_defer = proto_perl->Ilex_defer;
11200 PL_lex_expect = proto_perl->Ilex_expect;
11201 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11202 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11203 PL_lex_starts = proto_perl->Ilex_starts;
11204 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11205 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11206 PL_lex_op = proto_perl->Ilex_op;
11207 PL_lex_inpat = proto_perl->Ilex_inpat;
11208 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11209 PL_lex_brackets = proto_perl->Ilex_brackets;
11210 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11211 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11212 PL_lex_casemods = proto_perl->Ilex_casemods;
11213 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11214 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11217 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11218 PL_lasttoke = proto_perl->Ilasttoke;
11219 PL_realtokenstart = proto_perl->Irealtokenstart;
11220 PL_faketokens = proto_perl->Ifaketokens;
11221 PL_thismad = proto_perl->Ithismad;
11222 PL_thistoken = proto_perl->Ithistoken;
11223 PL_thisopen = proto_perl->Ithisopen;
11224 PL_thisstuff = proto_perl->Ithisstuff;
11225 PL_thisclose = proto_perl->Ithisclose;
11226 PL_thiswhite = proto_perl->Ithiswhite;
11227 PL_nextwhite = proto_perl->Inextwhite;
11228 PL_skipwhite = proto_perl->Iskipwhite;
11229 PL_endwhite = proto_perl->Iendwhite;
11230 PL_curforce = proto_perl->Icurforce;
11232 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11233 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11234 PL_nexttoke = proto_perl->Inexttoke;
11237 /* XXX This is probably masking the deeper issue of why
11238 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11239 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11240 * (A little debugging with a watchpoint on it may help.)
11242 if (SvANY(proto_perl->Ilinestr)) {
11243 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11244 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11245 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11246 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11247 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11248 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11249 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11250 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11251 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11254 PL_linestr = newSV(79);
11255 sv_upgrade(PL_linestr,SVt_PVIV);
11256 sv_setpvn(PL_linestr,"",0);
11257 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11259 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11260 PL_pending_ident = proto_perl->Ipending_ident;
11261 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11263 PL_expect = proto_perl->Iexpect;
11265 PL_multi_start = proto_perl->Imulti_start;
11266 PL_multi_end = proto_perl->Imulti_end;
11267 PL_multi_open = proto_perl->Imulti_open;
11268 PL_multi_close = proto_perl->Imulti_close;
11270 PL_error_count = proto_perl->Ierror_count;
11271 PL_subline = proto_perl->Isubline;
11272 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11274 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11275 if (SvANY(proto_perl->Ilinestr)) {
11276 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11277 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11278 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11279 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11280 PL_last_lop_op = proto_perl->Ilast_lop_op;
11283 PL_last_uni = SvPVX(PL_linestr);
11284 PL_last_lop = SvPVX(PL_linestr);
11285 PL_last_lop_op = 0;
11287 PL_in_my = proto_perl->Iin_my;
11288 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11290 PL_cryptseen = proto_perl->Icryptseen;
11293 PL_hints = proto_perl->Ihints;
11295 PL_amagic_generation = proto_perl->Iamagic_generation;
11297 #ifdef USE_LOCALE_COLLATE
11298 PL_collation_ix = proto_perl->Icollation_ix;
11299 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11300 PL_collation_standard = proto_perl->Icollation_standard;
11301 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11302 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11303 #endif /* USE_LOCALE_COLLATE */
11305 #ifdef USE_LOCALE_NUMERIC
11306 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11307 PL_numeric_standard = proto_perl->Inumeric_standard;
11308 PL_numeric_local = proto_perl->Inumeric_local;
11309 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11310 #endif /* !USE_LOCALE_NUMERIC */
11312 /* utf8 character classes */
11313 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11314 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11315 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11316 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11317 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11318 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11319 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11320 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11321 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11322 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11323 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11324 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11325 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11326 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11327 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11328 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11329 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11330 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11331 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11332 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11334 /* Did the locale setup indicate UTF-8? */
11335 PL_utf8locale = proto_perl->Iutf8locale;
11336 /* Unicode features (see perlrun/-C) */
11337 PL_unicode = proto_perl->Iunicode;
11339 /* Pre-5.8 signals control */
11340 PL_signals = proto_perl->Isignals;
11342 /* times() ticks per second */
11343 PL_clocktick = proto_perl->Iclocktick;
11345 /* Recursion stopper for PerlIO_find_layer */
11346 PL_in_load_module = proto_perl->Iin_load_module;
11348 /* sort() routine */
11349 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11351 /* Not really needed/useful since the reenrant_retint is "volatile",
11352 * but do it for consistency's sake. */
11353 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11355 /* Hooks to shared SVs and locks. */
11356 PL_sharehook = proto_perl->Isharehook;
11357 PL_lockhook = proto_perl->Ilockhook;
11358 PL_unlockhook = proto_perl->Iunlockhook;
11359 PL_threadhook = proto_perl->Ithreadhook;
11361 PL_runops_std = proto_perl->Irunops_std;
11362 PL_runops_dbg = proto_perl->Irunops_dbg;
11364 #ifdef THREADS_HAVE_PIDS
11365 PL_ppid = proto_perl->Ippid;
11369 PL_last_swash_hv = NULL; /* reinits on demand */
11370 PL_last_swash_klen = 0;
11371 PL_last_swash_key[0]= '\0';
11372 PL_last_swash_tmps = (U8*)NULL;
11373 PL_last_swash_slen = 0;
11375 PL_glob_index = proto_perl->Iglob_index;
11376 PL_srand_called = proto_perl->Isrand_called;
11377 PL_uudmap['M'] = 0; /* reinits on demand */
11378 PL_bitcount = NULL; /* reinits on demand */
11380 if (proto_perl->Ipsig_pend) {
11381 Newxz(PL_psig_pend, SIG_SIZE, int);
11384 PL_psig_pend = (int*)NULL;
11387 if (proto_perl->Ipsig_ptr) {
11388 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11389 Newxz(PL_psig_name, SIG_SIZE, SV*);
11390 for (i = 1; i < SIG_SIZE; i++) {
11391 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11392 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11396 PL_psig_ptr = (SV**)NULL;
11397 PL_psig_name = (SV**)NULL;
11400 /* thrdvar.h stuff */
11402 if (flags & CLONEf_COPY_STACKS) {
11403 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11404 PL_tmps_ix = proto_perl->Ttmps_ix;
11405 PL_tmps_max = proto_perl->Ttmps_max;
11406 PL_tmps_floor = proto_perl->Ttmps_floor;
11407 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11409 while (i <= PL_tmps_ix) {
11410 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11414 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11415 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11416 Newxz(PL_markstack, i, I32);
11417 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11418 - proto_perl->Tmarkstack);
11419 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11420 - proto_perl->Tmarkstack);
11421 Copy(proto_perl->Tmarkstack, PL_markstack,
11422 PL_markstack_ptr - PL_markstack + 1, I32);
11424 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11425 * NOTE: unlike the others! */
11426 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11427 PL_scopestack_max = proto_perl->Tscopestack_max;
11428 Newxz(PL_scopestack, PL_scopestack_max, I32);
11429 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11431 /* NOTE: si_dup() looks at PL_markstack */
11432 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11434 /* PL_curstack = PL_curstackinfo->si_stack; */
11435 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11436 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11438 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11439 PL_stack_base = AvARRAY(PL_curstack);
11440 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11441 - proto_perl->Tstack_base);
11442 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11444 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11445 * NOTE: unlike the others! */
11446 PL_savestack_ix = proto_perl->Tsavestack_ix;
11447 PL_savestack_max = proto_perl->Tsavestack_max;
11448 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11449 PL_savestack = ss_dup(proto_perl, param);
11453 ENTER; /* perl_destruct() wants to LEAVE; */
11455 /* although we're not duplicating the tmps stack, we should still
11456 * add entries for any SVs on the tmps stack that got cloned by a
11457 * non-refcount means (eg a temp in @_); otherwise they will be
11460 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11461 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11462 proto_perl->Ttmps_stack[i]);
11463 if (nsv && !SvREFCNT(nsv)) {
11465 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11470 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11471 PL_top_env = &PL_start_env;
11473 PL_op = proto_perl->Top;
11476 PL_Xpv = (XPV*)NULL;
11477 PL_na = proto_perl->Tna;
11479 PL_statbuf = proto_perl->Tstatbuf;
11480 PL_statcache = proto_perl->Tstatcache;
11481 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11482 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11484 PL_timesbuf = proto_perl->Ttimesbuf;
11487 PL_tainted = proto_perl->Ttainted;
11488 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11489 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11490 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11491 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11492 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11493 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11494 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11495 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11496 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11498 PL_restartop = proto_perl->Trestartop;
11499 PL_in_eval = proto_perl->Tin_eval;
11500 PL_delaymagic = proto_perl->Tdelaymagic;
11501 PL_dirty = proto_perl->Tdirty;
11502 PL_localizing = proto_perl->Tlocalizing;
11504 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11505 PL_hv_fetch_ent_mh = NULL;
11506 PL_modcount = proto_perl->Tmodcount;
11507 PL_lastgotoprobe = NULL;
11508 PL_dumpindent = proto_perl->Tdumpindent;
11510 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11511 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11512 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11513 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11514 PL_efloatbuf = NULL; /* reinits on demand */
11515 PL_efloatsize = 0; /* reinits on demand */
11519 PL_screamfirst = NULL;
11520 PL_screamnext = NULL;
11521 PL_maxscream = -1; /* reinits on demand */
11522 PL_lastscream = NULL;
11524 PL_watchaddr = NULL;
11527 PL_regdummy = proto_perl->Tregdummy;
11528 PL_colorset = 0; /* reinits PL_colors[] */
11529 /*PL_colors[6] = {0,0,0,0,0,0};*/
11531 /* RE engine - function pointers */
11532 PL_regcompp = proto_perl->Tregcompp;
11533 PL_regexecp = proto_perl->Tregexecp;
11534 PL_regint_start = proto_perl->Tregint_start;
11535 PL_regint_string = proto_perl->Tregint_string;
11536 PL_regfree = proto_perl->Tregfree;
11537 Zero(&PL_reg_state, 1, struct re_save_state);
11538 PL_reginterp_cnt = 0;
11539 PL_regmatch_slab = NULL;
11541 /* Pluggable optimizer */
11542 PL_peepp = proto_perl->Tpeepp;
11544 PL_stashcache = newHV();
11546 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11547 ptr_table_free(PL_ptr_table);
11548 PL_ptr_table = NULL;
11551 /* Call the ->CLONE method, if it exists, for each of the stashes
11552 identified by sv_dup() above.
11554 while(av_len(param->stashes) != -1) {
11555 HV* const stash = (HV*) av_shift(param->stashes);
11556 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11557 if (cloner && GvCV(cloner)) {
11562 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11564 call_sv((SV*)GvCV(cloner), G_DISCARD);
11570 SvREFCNT_dec(param->stashes);
11572 /* orphaned? eg threads->new inside BEGIN or use */
11573 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11574 SvREFCNT_inc_simple_void(PL_compcv);
11575 SAVEFREESV(PL_compcv);
11581 #endif /* USE_ITHREADS */
11584 =head1 Unicode Support
11586 =for apidoc sv_recode_to_utf8
11588 The encoding is assumed to be an Encode object, on entry the PV
11589 of the sv is assumed to be octets in that encoding, and the sv
11590 will be converted into Unicode (and UTF-8).
11592 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11593 is not a reference, nothing is done to the sv. If the encoding is not
11594 an C<Encode::XS> Encoding object, bad things will happen.
11595 (See F<lib/encoding.pm> and L<Encode>).
11597 The PV of the sv is returned.
11602 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11605 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11619 Passing sv_yes is wrong - it needs to be or'ed set of constants
11620 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11621 remove converted chars from source.
11623 Both will default the value - let them.
11625 XPUSHs(&PL_sv_yes);
11628 call_method("decode", G_SCALAR);
11632 s = SvPV_const(uni, len);
11633 if (s != SvPVX_const(sv)) {
11634 SvGROW(sv, len + 1);
11635 Move(s, SvPVX(sv), len + 1, char);
11636 SvCUR_set(sv, len);
11643 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11647 =for apidoc sv_cat_decode
11649 The encoding is assumed to be an Encode object, the PV of the ssv is
11650 assumed to be octets in that encoding and decoding the input starts
11651 from the position which (PV + *offset) pointed to. The dsv will be
11652 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11653 when the string tstr appears in decoding output or the input ends on
11654 the PV of the ssv. The value which the offset points will be modified
11655 to the last input position on the ssv.
11657 Returns TRUE if the terminator was found, else returns FALSE.
11662 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11663 SV *ssv, int *offset, char *tstr, int tlen)
11667 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11678 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11679 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11681 call_method("cat_decode", G_SCALAR);
11683 ret = SvTRUE(TOPs);
11684 *offset = SvIV(offsv);
11690 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11695 /* ---------------------------------------------------------------------
11697 * support functions for report_uninit()
11700 /* the maxiumum size of array or hash where we will scan looking
11701 * for the undefined element that triggered the warning */
11703 #define FUV_MAX_SEARCH_SIZE 1000
11705 /* Look for an entry in the hash whose value has the same SV as val;
11706 * If so, return a mortal copy of the key. */
11709 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11712 register HE **array;
11715 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11716 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11719 array = HvARRAY(hv);
11721 for (i=HvMAX(hv); i>0; i--) {
11722 register HE *entry;
11723 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11724 if (HeVAL(entry) != val)
11726 if ( HeVAL(entry) == &PL_sv_undef ||
11727 HeVAL(entry) == &PL_sv_placeholder)
11731 if (HeKLEN(entry) == HEf_SVKEY)
11732 return sv_mortalcopy(HeKEY_sv(entry));
11733 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11739 /* Look for an entry in the array whose value has the same SV as val;
11740 * If so, return the index, otherwise return -1. */
11743 S_find_array_subscript(pTHX_ AV *av, SV* val)
11748 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11749 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11753 for (i=AvFILLp(av); i>=0; i--) {
11754 if (svp[i] == val && svp[i] != &PL_sv_undef)
11760 /* S_varname(): return the name of a variable, optionally with a subscript.
11761 * If gv is non-zero, use the name of that global, along with gvtype (one
11762 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11763 * targ. Depending on the value of the subscript_type flag, return:
11766 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11767 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11768 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11769 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11772 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11773 SV* keyname, I32 aindex, int subscript_type)
11776 SV * const name = sv_newmortal();
11779 buffer[0] = gvtype;
11782 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11784 gv_fullname4(name, gv, buffer, 0);
11786 if ((unsigned int)SvPVX(name)[1] <= 26) {
11788 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11790 /* Swap the 1 unprintable control character for the 2 byte pretty
11791 version - ie substr($name, 1, 1) = $buffer; */
11792 sv_insert(name, 1, 1, buffer, 2);
11797 CV * const cv = find_runcv(&unused);
11801 if (!cv || !CvPADLIST(cv))
11803 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11804 sv = *av_fetch(av, targ, FALSE);
11805 /* SvLEN in a pad name is not to be trusted */
11806 sv_setpv(name, SvPV_nolen_const(sv));
11809 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11810 SV * const sv = newSV(0);
11811 *SvPVX(name) = '$';
11812 Perl_sv_catpvf(aTHX_ name, "{%s}",
11813 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11816 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11817 *SvPVX(name) = '$';
11818 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11820 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11821 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11828 =for apidoc find_uninit_var
11830 Find the name of the undefined variable (if any) that caused the operator o
11831 to issue a "Use of uninitialized value" warning.
11832 If match is true, only return a name if it's value matches uninit_sv.
11833 So roughly speaking, if a unary operator (such as OP_COS) generates a
11834 warning, then following the direct child of the op may yield an
11835 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11836 other hand, with OP_ADD there are two branches to follow, so we only print
11837 the variable name if we get an exact match.
11839 The name is returned as a mortal SV.
11841 Assumes that PL_op is the op that originally triggered the error, and that
11842 PL_comppad/PL_curpad points to the currently executing pad.
11848 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11856 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11857 uninit_sv == &PL_sv_placeholder)))
11860 switch (obase->op_type) {
11867 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11868 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11871 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11873 if (pad) { /* @lex, %lex */
11874 sv = PAD_SVl(obase->op_targ);
11878 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11879 /* @global, %global */
11880 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11883 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11885 else /* @{expr}, %{expr} */
11886 return find_uninit_var(cUNOPx(obase)->op_first,
11890 /* attempt to find a match within the aggregate */
11892 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11894 subscript_type = FUV_SUBSCRIPT_HASH;
11897 index = find_array_subscript((AV*)sv, uninit_sv);
11899 subscript_type = FUV_SUBSCRIPT_ARRAY;
11902 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11905 return varname(gv, hash ? '%' : '@', obase->op_targ,
11906 keysv, index, subscript_type);
11910 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11912 return varname(NULL, '$', obase->op_targ,
11913 NULL, 0, FUV_SUBSCRIPT_NONE);
11916 gv = cGVOPx_gv(obase);
11917 if (!gv || (match && GvSV(gv) != uninit_sv))
11919 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11922 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11925 av = (AV*)PAD_SV(obase->op_targ);
11926 if (!av || SvRMAGICAL(av))
11928 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11929 if (!svp || *svp != uninit_sv)
11932 return varname(NULL, '$', obase->op_targ,
11933 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11936 gv = cGVOPx_gv(obase);
11942 if (!av || SvRMAGICAL(av))
11944 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11945 if (!svp || *svp != uninit_sv)
11948 return varname(gv, '$', 0,
11949 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11954 o = cUNOPx(obase)->op_first;
11955 if (!o || o->op_type != OP_NULL ||
11956 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11958 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11962 if (PL_op == obase)
11963 /* $a[uninit_expr] or $h{uninit_expr} */
11964 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11967 o = cBINOPx(obase)->op_first;
11968 kid = cBINOPx(obase)->op_last;
11970 /* get the av or hv, and optionally the gv */
11972 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11973 sv = PAD_SV(o->op_targ);
11975 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11976 && cUNOPo->op_first->op_type == OP_GV)
11978 gv = cGVOPx_gv(cUNOPo->op_first);
11981 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11986 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11987 /* index is constant */
11991 if (obase->op_type == OP_HELEM) {
11992 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11993 if (!he || HeVAL(he) != uninit_sv)
11997 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11998 if (!svp || *svp != uninit_sv)
12002 if (obase->op_type == OP_HELEM)
12003 return varname(gv, '%', o->op_targ,
12004 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12006 return varname(gv, '@', o->op_targ, NULL,
12007 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12010 /* index is an expression;
12011 * attempt to find a match within the aggregate */
12012 if (obase->op_type == OP_HELEM) {
12013 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12015 return varname(gv, '%', o->op_targ,
12016 keysv, 0, FUV_SUBSCRIPT_HASH);
12019 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12021 return varname(gv, '@', o->op_targ,
12022 NULL, index, FUV_SUBSCRIPT_ARRAY);
12027 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12029 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12034 /* only examine RHS */
12035 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12038 o = cUNOPx(obase)->op_first;
12039 if (o->op_type == OP_PUSHMARK)
12042 if (!o->op_sibling) {
12043 /* one-arg version of open is highly magical */
12045 if (o->op_type == OP_GV) { /* open FOO; */
12047 if (match && GvSV(gv) != uninit_sv)
12049 return varname(gv, '$', 0,
12050 NULL, 0, FUV_SUBSCRIPT_NONE);
12052 /* other possibilities not handled are:
12053 * open $x; or open my $x; should return '${*$x}'
12054 * open expr; should return '$'.expr ideally
12060 /* ops where $_ may be an implicit arg */
12064 if ( !(obase->op_flags & OPf_STACKED)) {
12065 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12066 ? PAD_SVl(obase->op_targ)
12069 sv = sv_newmortal();
12070 sv_setpvn(sv, "$_", 2);
12078 /* skip filehandle as it can't produce 'undef' warning */
12079 o = cUNOPx(obase)->op_first;
12080 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12081 o = o->op_sibling->op_sibling;
12088 match = 1; /* XS or custom code could trigger random warnings */
12093 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12094 return sv_2mortal(newSVpvs("${$/}"));
12099 if (!(obase->op_flags & OPf_KIDS))
12101 o = cUNOPx(obase)->op_first;
12107 /* if all except one arg are constant, or have no side-effects,
12108 * or are optimized away, then it's unambiguous */
12110 for (kid=o; kid; kid = kid->op_sibling) {
12112 const OPCODE type = kid->op_type;
12113 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12114 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12115 || (type == OP_PUSHMARK)
12119 if (o2) { /* more than one found */
12126 return find_uninit_var(o2, uninit_sv, match);
12128 /* scan all args */
12130 sv = find_uninit_var(o, uninit_sv, 1);
12142 =for apidoc report_uninit
12144 Print appropriate "Use of uninitialized variable" warning
12150 Perl_report_uninit(pTHX_ SV* uninit_sv)
12154 SV* varname = NULL;
12156 varname = find_uninit_var(PL_op, uninit_sv,0);
12158 sv_insert(varname, 0, 0, " ", 1);
12160 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12161 varname ? SvPV_nolen_const(varname) : "",
12162 " in ", OP_DESC(PL_op));
12165 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12171 * c-indentation-style: bsd
12172 * c-basic-offset: 4
12173 * indent-tabs-mode: t
12176 * ex: set ts=8 sts=4 sw=4 noet: