3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 #define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 #define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
681 struct arena_desc* adesc;
682 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
685 /* shouldnt need this
686 if (!arena_size) arena_size = PERL_ARENA_SIZE;
689 /* may need new arena-set to hold new arena */
690 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
691 Newxz(newroot, 1, struct arena_set);
692 newroot->set_size = ARENAS_PER_SET;
693 newroot->next = *aroot;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", *aroot));
698 /* ok, now have arena-set with at least 1 empty/available arena-desc */
699 curr = (*aroot)->curr++;
700 adesc = &((*aroot)->set[curr]);
701 assert(!adesc->arena);
703 Newxz(adesc->arena, arena_size, char);
704 adesc->size = arena_size;
705 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
706 curr, adesc->arena, arena_size));
712 /* return a thing to the free list */
714 #define del_body(thing, root) \
716 void ** const thing_copy = (void **)thing;\
718 *thing_copy = *root; \
719 *root = (void*)thing_copy; \
725 =head1 SV-Body Allocation
727 Allocation of SV-bodies is similar to SV-heads, differing as follows;
728 the allocation mechanism is used for many body types, so is somewhat
729 more complicated, it uses arena-sets, and has no need for still-live
732 At the outermost level, (new|del)_X*V macros return bodies of the
733 appropriate type. These macros call either (new|del)_body_type or
734 (new|del)_body_allocated macro pairs, depending on specifics of the
735 type. Most body types use the former pair, the latter pair is used to
736 allocate body types with "ghost fields".
738 "ghost fields" are fields that are unused in certain types, and
739 consequently dont need to actually exist. They are declared because
740 they're part of a "base type", which allows use of functions as
741 methods. The simplest examples are AVs and HVs, 2 aggregate types
742 which don't use the fields which support SCALAR semantics.
744 For these types, the arenas are carved up into *_allocated size
745 chunks, we thus avoid wasted memory for those unaccessed members.
746 When bodies are allocated, we adjust the pointer back in memory by the
747 size of the bit not allocated, so it's as if we allocated the full
748 structure. (But things will all go boom if you write to the part that
749 is "not there", because you'll be overwriting the last members of the
750 preceding structure in memory.)
752 We calculate the correction using the STRUCT_OFFSET macro. For
753 example, if xpv_allocated is the same structure as XPV then the two
754 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
755 structure is smaller (no initial NV actually allocated) then the net
756 effect is to subtract the size of the NV from the pointer, to return a
757 new pointer as if an initial NV were actually allocated.
759 This is the same trick as was used for NV and IV bodies. Ironically it
760 doesn't need to be used for NV bodies any more, because NV is now at
761 the start of the structure. IV bodies don't need it either, because
762 they are no longer allocated.
764 In turn, the new_body_* allocators call S_new_body(), which invokes
765 new_body_inline macro, which takes a lock, and takes a body off the
766 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
767 necessary to refresh an empty list. Then the lock is released, and
768 the body is returned.
770 S_more_bodies calls get_arena(), and carves it up into an array of N
771 bodies, which it strings into a linked list. It looks up arena-size
772 and body-size from the body_details table described below, thus
773 supporting the multiple body-types.
775 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
776 the (new|del)_X*V macros are mapped directly to malloc/free.
782 For each sv-type, struct body_details bodies_by_type[] carries
783 parameters which control these aspects of SV handling:
785 Arena_size determines whether arenas are used for this body type, and if
786 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
787 zero, forcing individual mallocs and frees.
789 Body_size determines how big a body is, and therefore how many fit into
790 each arena. Offset carries the body-pointer adjustment needed for
791 *_allocated body types, and is used in *_allocated macros.
793 But its main purpose is to parameterize info needed in
794 Perl_sv_upgrade(). The info here dramatically simplifies the function
795 vs the implementation in 5.8.7, making it table-driven. All fields
796 are used for this, except for arena_size.
798 For the sv-types that have no bodies, arenas are not used, so those
799 PL_body_roots[sv_type] are unused, and can be overloaded. In
800 something of a special case, SVt_NULL is borrowed for HE arenas;
801 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
802 bodies_by_type[SVt_NULL] slot is not used, as the table is not
805 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
806 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
807 they can just use the same allocation semantics. At first, PTEs were
808 also overloaded to a non-body sv-type, but this yielded hard-to-find
809 malloc bugs, so was simplified by claiming a new slot. This choice
810 has no consequence at this time.
814 struct body_details {
815 U8 body_size; /* Size to allocate */
816 U8 copy; /* Size of structure to copy (may be shorter) */
818 unsigned int type : 4; /* We have space for a sanity check. */
819 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
820 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
821 unsigned int arena : 1; /* Allocated from an arena */
822 size_t arena_size; /* Size of arena to allocate */
830 /* With -DPURFIY we allocate everything directly, and don't use arenas.
831 This seems a rather elegant way to simplify some of the code below. */
832 #define HASARENA FALSE
834 #define HASARENA TRUE
836 #define NOARENA FALSE
838 /* Size the arenas to exactly fit a given number of bodies. A count
839 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
840 simplifying the default. If count > 0, the arena is sized to fit
841 only that many bodies, allowing arenas to be used for large, rare
842 bodies (XPVFM, XPVIO) without undue waste. The arena size is
843 limited by PERL_ARENA_SIZE, so we can safely oversize the
846 #define FIT_ARENA0(body_size) \
847 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
848 #define FIT_ARENAn(count,body_size) \
849 ( count * body_size <= PERL_ARENA_SIZE) \
850 ? count * body_size \
851 : FIT_ARENA0 (body_size)
852 #define FIT_ARENA(count,body_size) \
854 ? FIT_ARENAn (count, body_size) \
855 : FIT_ARENA0 (body_size)
857 /* A macro to work out the offset needed to subtract from a pointer to (say)
864 to make its members accessible via a pointer to (say)
874 #define relative_STRUCT_OFFSET(longer, shorter, member) \
875 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
877 /* Calculate the length to copy. Specifically work out the length less any
878 final padding the compiler needed to add. See the comment in sv_upgrade
879 for why copying the padding proved to be a bug. */
881 #define copy_length(type, last_member) \
882 STRUCT_OFFSET(type, last_member) \
883 + sizeof (((type*)SvANY((SV*)0))->last_member)
885 static const struct body_details bodies_by_type[] = {
886 { sizeof(HE), 0, 0, SVt_NULL,
887 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
889 /* IVs are in the head, so the allocation size is 0.
890 However, the slot is overloaded for PTEs. */
891 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
892 sizeof(IV), /* This is used to copy out the IV body. */
893 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
894 NOARENA /* IVS don't need an arena */,
895 /* But PTEs need to know the size of their arena */
896 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
901 FIT_ARENA(0, sizeof(NV)) },
903 /* RVs are in the head now. */
904 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(xpv_allocated),
908 copy_length(XPV, xpv_len)
909 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
914 { sizeof(xpviv_allocated),
915 copy_length(XPVIV, xiv_u)
916 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
917 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
921 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
922 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
925 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
929 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
933 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
934 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
937 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
938 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
940 { sizeof(xpvav_allocated),
941 copy_length(XPVAV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
943 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
946 { sizeof(xpvhv_allocated),
947 copy_length(XPVHV, xmg_stash)
948 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
949 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
953 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
954 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
955 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
957 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
958 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
959 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
961 /* XPVIO is 84 bytes, fits 48x */
962 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
963 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
966 #define new_body_type(sv_type) \
967 (void *)((char *)S_new_body(aTHX_ sv_type))
969 #define del_body_type(p, sv_type) \
970 del_body(p, &PL_body_roots[sv_type])
973 #define new_body_allocated(sv_type) \
974 (void *)((char *)S_new_body(aTHX_ sv_type) \
975 - bodies_by_type[sv_type].offset)
977 #define del_body_allocated(p, sv_type) \
978 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
981 #define my_safemalloc(s) (void*)safemalloc(s)
982 #define my_safecalloc(s) (void*)safecalloc(s, 1)
983 #define my_safefree(p) safefree((char*)p)
987 #define new_XNV() my_safemalloc(sizeof(XPVNV))
988 #define del_XNV(p) my_safefree(p)
990 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
991 #define del_XPVNV(p) my_safefree(p)
993 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
994 #define del_XPVAV(p) my_safefree(p)
996 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
997 #define del_XPVHV(p) my_safefree(p)
999 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1000 #define del_XPVMG(p) my_safefree(p)
1002 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1003 #define del_XPVGV(p) my_safefree(p)
1007 #define new_XNV() new_body_type(SVt_NV)
1008 #define del_XNV(p) del_body_type(p, SVt_NV)
1010 #define new_XPVNV() new_body_type(SVt_PVNV)
1011 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1013 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1014 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1016 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1017 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1019 #define new_XPVMG() new_body_type(SVt_PVMG)
1020 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1022 #define new_XPVGV() new_body_type(SVt_PVGV)
1023 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1027 /* no arena for you! */
1029 #define new_NOARENA(details) \
1030 my_safemalloc((details)->body_size + (details)->offset)
1031 #define new_NOARENAZ(details) \
1032 my_safecalloc((details)->body_size + (details)->offset)
1035 static bool done_sanity_check;
1039 S_more_bodies (pTHX_ svtype sv_type)
1042 void ** const root = &PL_body_roots[sv_type];
1043 const struct body_details * const bdp = &bodies_by_type[sv_type];
1044 const size_t body_size = bdp->body_size;
1048 assert(bdp->arena_size);
1051 if (!done_sanity_check) {
1052 unsigned int i = SVt_LAST;
1054 done_sanity_check = TRUE;
1057 assert (bodies_by_type[i].type == i);
1061 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1063 end = start + bdp->arena_size - body_size;
1065 /* computed count doesnt reflect the 1st slot reservation */
1066 DEBUG_m(PerlIO_printf(Perl_debug_log,
1067 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1068 start, end, bdp->arena_size, sv_type, body_size,
1069 bdp->arena_size / body_size));
1071 *root = (void *)start;
1073 while (start < end) {
1074 char * const next = start + body_size;
1075 *(void**) start = (void *)next;
1078 *(void **)start = 0;
1083 /* grab a new thing from the free list, allocating more if necessary.
1084 The inline version is used for speed in hot routines, and the
1085 function using it serves the rest (unless PURIFY).
1087 #define new_body_inline(xpv, sv_type) \
1089 void ** const r3wt = &PL_body_roots[sv_type]; \
1091 xpv = *((void **)(r3wt)) \
1092 ? *((void **)(r3wt)) : more_bodies(sv_type); \
1093 *(r3wt) = *(void**)(xpv); \
1100 S_new_body(pTHX_ svtype sv_type)
1104 new_body_inline(xpv, sv_type);
1111 =for apidoc sv_upgrade
1113 Upgrade an SV to a more complex form. Generally adds a new body type to the
1114 SV, then copies across as much information as possible from the old body.
1115 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1121 Perl_sv_upgrade(pTHX_ register SV *sv, U32 new_type)
1126 const U32 old_type = SvTYPE(sv);
1127 const struct body_details *new_type_details;
1128 const struct body_details *const old_type_details
1129 = bodies_by_type + old_type;
1131 if (new_type != SVt_PV && SvIsCOW(sv)) {
1132 sv_force_normal_flags(sv, 0);
1135 if (old_type == new_type)
1138 if (old_type > new_type)
1139 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1140 (int)old_type, (int)new_type);
1143 old_body = SvANY(sv);
1145 /* Copying structures onto other structures that have been neatly zeroed
1146 has a subtle gotcha. Consider XPVMG
1148 +------+------+------+------+------+-------+-------+
1149 | NV | CUR | LEN | IV | MAGIC | STASH |
1150 +------+------+------+------+------+-------+-------+
1151 0 4 8 12 16 20 24 28
1153 where NVs are aligned to 8 bytes, so that sizeof that structure is
1154 actually 32 bytes long, with 4 bytes of padding at the end:
1156 +------+------+------+------+------+-------+-------+------+
1157 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1158 +------+------+------+------+------+-------+-------+------+
1159 0 4 8 12 16 20 24 28 32
1161 so what happens if you allocate memory for this structure:
1163 +------+------+------+------+------+-------+-------+------+------+...
1164 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1165 +------+------+------+------+------+-------+-------+------+------+...
1166 0 4 8 12 16 20 24 28 32 36
1168 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1169 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1170 started out as zero once, but it's quite possible that it isn't. So now,
1171 rather than a nicely zeroed GP, you have it pointing somewhere random.
1174 (In fact, GP ends up pointing at a previous GP structure, because the
1175 principle cause of the padding in XPVMG getting garbage is a copy of
1176 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1178 So we are careful and work out the size of used parts of all the
1185 if (new_type < SVt_PVIV) {
1186 new_type = (new_type == SVt_NV)
1187 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1198 assert(new_type > SVt_PV);
1199 assert(SVt_IV < SVt_PV);
1200 assert(SVt_NV < SVt_PV);
1207 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1208 there's no way that it can be safely upgraded, because perl.c
1209 expects to Safefree(SvANY(PL_mess_sv)) */
1210 assert(sv != PL_mess_sv);
1211 /* This flag bit is used to mean other things in other scalar types.
1212 Given that it only has meaning inside the pad, it shouldn't be set
1213 on anything that can get upgraded. */
1214 assert(!SvPAD_TYPED(sv));
1217 if (old_type_details->cant_upgrade)
1218 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1219 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1221 new_type_details = bodies_by_type + new_type;
1223 SvFLAGS(sv) &= ~SVTYPEMASK;
1224 SvFLAGS(sv) |= new_type;
1226 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1227 the return statements above will have triggered. */
1228 assert (new_type != SVt_NULL);
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1236 assert(old_type == SVt_NULL);
1237 SvANY(sv) = new_XNV();
1241 assert(old_type == SVt_NULL);
1242 SvANY(sv) = &sv->sv_u.svu_rv;
1247 assert(new_type_details->body_size);
1250 assert(new_type_details->arena);
1251 assert(new_type_details->arena_size);
1252 /* This points to the start of the allocated area. */
1253 new_body_inline(new_body, new_type);
1254 Zero(new_body, new_type_details->body_size, char);
1255 new_body = ((char *)new_body) - new_type_details->offset;
1257 /* We always allocated the full length item with PURIFY. To do this
1258 we fake things so that arena is false for all 16 types.. */
1259 new_body = new_NOARENAZ(new_type_details);
1261 SvANY(sv) = new_body;
1262 if (new_type == SVt_PVAV) {
1268 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1269 The target created by newSVrv also is, and it can have magic.
1270 However, it never has SvPVX set.
1272 if (old_type >= SVt_RV) {
1273 assert(SvPVX_const(sv) == 0);
1276 /* Could put this in the else clause below, as PVMG must have SvPVX
1277 0 already (the assertion above) */
1280 if (old_type >= SVt_PVMG) {
1281 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1282 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1288 /* XXX Is this still needed? Was it ever needed? Surely as there is
1289 no route from NV to PVIV, NOK can never be true */
1290 assert(!SvNOKp(sv));
1302 assert(new_type_details->body_size);
1303 /* We always allocated the full length item with PURIFY. To do this
1304 we fake things so that arena is false for all 16 types.. */
1305 if(new_type_details->arena) {
1306 /* This points to the start of the allocated area. */
1307 new_body_inline(new_body, new_type);
1308 Zero(new_body, new_type_details->body_size, char);
1309 new_body = ((char *)new_body) - new_type_details->offset;
1311 new_body = new_NOARENAZ(new_type_details);
1313 SvANY(sv) = new_body;
1315 if (old_type_details->copy) {
1316 /* There is now the potential for an upgrade from something without
1317 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1318 int offset = old_type_details->offset;
1319 int length = old_type_details->copy;
1321 if (new_type_details->offset > old_type_details->offset) {
1322 const int difference
1323 = new_type_details->offset - old_type_details->offset;
1324 offset += difference;
1325 length -= difference;
1327 assert (length >= 0);
1329 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1333 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1334 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1335 * correct 0.0 for us. Otherwise, if the old body didn't have an
1336 * NV slot, but the new one does, then we need to initialise the
1337 * freshly created NV slot with whatever the correct bit pattern is
1339 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1343 if (new_type == SVt_PVIO)
1344 IoPAGE_LEN(sv) = 60;
1345 if (old_type < SVt_RV)
1349 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1350 (unsigned long)new_type);
1353 if (old_type_details->arena) {
1354 /* If there was an old body, then we need to free it.
1355 Note that there is an assumption that all bodies of types that
1356 can be upgraded came from arenas. Only the more complex non-
1357 upgradable types are allowed to be directly malloc()ed. */
1359 my_safefree(old_body);
1361 del_body((void*)((char*)old_body + old_type_details->offset),
1362 &PL_body_roots[old_type]);
1368 =for apidoc sv_backoff
1370 Remove any string offset. You should normally use the C<SvOOK_off> macro
1377 Perl_sv_backoff(pTHX_ register SV *sv)
1379 PERL_UNUSED_CONTEXT;
1381 assert(SvTYPE(sv) != SVt_PVHV);
1382 assert(SvTYPE(sv) != SVt_PVAV);
1384 const char * const s = SvPVX_const(sv);
1385 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1386 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1388 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1390 SvFLAGS(sv) &= ~SVf_OOK;
1397 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1398 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1399 Use the C<SvGROW> wrapper instead.
1405 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1409 if (PL_madskills && newlen >= 0x100000) {
1410 PerlIO_printf(Perl_debug_log,
1411 "Allocation too large: %"UVxf"\n", (UV)newlen);
1413 #ifdef HAS_64K_LIMIT
1414 if (newlen >= 0x10000) {
1415 PerlIO_printf(Perl_debug_log,
1416 "Allocation too large: %"UVxf"\n", (UV)newlen);
1419 #endif /* HAS_64K_LIMIT */
1422 if (SvTYPE(sv) < SVt_PV) {
1423 sv_upgrade(sv, SVt_PV);
1424 s = SvPVX_mutable(sv);
1426 else if (SvOOK(sv)) { /* pv is offset? */
1428 s = SvPVX_mutable(sv);
1429 if (newlen > SvLEN(sv))
1430 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1431 #ifdef HAS_64K_LIMIT
1432 if (newlen >= 0x10000)
1437 s = SvPVX_mutable(sv);
1439 if (newlen > SvLEN(sv)) { /* need more room? */
1440 newlen = PERL_STRLEN_ROUNDUP(newlen);
1441 if (SvLEN(sv) && s) {
1443 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1449 s = saferealloc(s, newlen);
1452 s = safemalloc(newlen);
1453 if (SvPVX_const(sv) && SvCUR(sv)) {
1454 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1458 SvLEN_set(sv, newlen);
1464 =for apidoc sv_setiv
1466 Copies an integer into the given SV, upgrading first if necessary.
1467 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1473 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1476 SV_CHECK_THINKFIRST_COW_DROP(sv);
1477 switch (SvTYPE(sv)) {
1479 sv_upgrade(sv, SVt_IV);
1482 sv_upgrade(sv, SVt_PVNV);
1486 sv_upgrade(sv, SVt_PVIV);
1495 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1498 (void)SvIOK_only(sv); /* validate number */
1504 =for apidoc sv_setiv_mg
1506 Like C<sv_setiv>, but also handles 'set' magic.
1512 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1519 =for apidoc sv_setuv
1521 Copies an unsigned integer into the given SV, upgrading first if necessary.
1522 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1528 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1530 /* With these two if statements:
1531 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1534 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1536 If you wish to remove them, please benchmark to see what the effect is
1538 if (u <= (UV)IV_MAX) {
1539 sv_setiv(sv, (IV)u);
1548 =for apidoc sv_setuv_mg
1550 Like C<sv_setuv>, but also handles 'set' magic.
1556 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1565 =for apidoc sv_setnv
1567 Copies a double into the given SV, upgrading first if necessary.
1568 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1574 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1577 SV_CHECK_THINKFIRST_COW_DROP(sv);
1578 switch (SvTYPE(sv)) {
1581 sv_upgrade(sv, SVt_NV);
1586 sv_upgrade(sv, SVt_PVNV);
1595 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1599 (void)SvNOK_only(sv); /* validate number */
1604 =for apidoc sv_setnv_mg
1606 Like C<sv_setnv>, but also handles 'set' magic.
1612 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1618 /* Print an "isn't numeric" warning, using a cleaned-up,
1619 * printable version of the offending string
1623 S_not_a_number(pTHX_ SV *sv)
1631 dsv = sv_2mortal(newSVpvs(""));
1632 pv = sv_uni_display(dsv, sv, 10, 0);
1635 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1636 /* each *s can expand to 4 chars + "...\0",
1637 i.e. need room for 8 chars */
1639 const char *s = SvPVX_const(sv);
1640 const char * const end = s + SvCUR(sv);
1641 for ( ; s < end && d < limit; s++ ) {
1643 if (ch & 128 && !isPRINT_LC(ch)) {
1652 else if (ch == '\r') {
1656 else if (ch == '\f') {
1660 else if (ch == '\\') {
1664 else if (ch == '\0') {
1668 else if (isPRINT_LC(ch))
1685 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1686 "Argument \"%s\" isn't numeric in %s", pv,
1689 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1690 "Argument \"%s\" isn't numeric", pv);
1694 =for apidoc looks_like_number
1696 Test if the content of an SV looks like a number (or is a number).
1697 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1698 non-numeric warning), even if your atof() doesn't grok them.
1704 Perl_looks_like_number(pTHX_ SV *sv)
1706 register const char *sbegin;
1710 sbegin = SvPVX_const(sv);
1713 else if (SvPOKp(sv))
1714 sbegin = SvPV_const(sv, len);
1716 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1717 return grok_number(sbegin, len, NULL);
1721 S_glob_2inpuv(pTHX_ GV *gv, STRLEN *len, bool want_number)
1723 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1724 SV *const buffer = sv_newmortal();
1726 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1729 gv_efullname3(buffer, gv, "*");
1730 SvFLAGS(gv) |= wasfake;
1733 /* We know that all GVs stringify to something that is not-a-number,
1734 so no need to test that. */
1735 if (ckWARN(WARN_NUMERIC))
1736 not_a_number(buffer);
1737 /* We just want something true to return, so that S_sv_2iuv_common
1738 can tail call us and return true. */
1741 assert(SvPOK(buffer));
1743 *len = SvCUR(buffer);
1745 return SvPVX(buffer);
1749 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1750 until proven guilty, assume that things are not that bad... */
1755 As 64 bit platforms often have an NV that doesn't preserve all bits of
1756 an IV (an assumption perl has been based on to date) it becomes necessary
1757 to remove the assumption that the NV always carries enough precision to
1758 recreate the IV whenever needed, and that the NV is the canonical form.
1759 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1760 precision as a side effect of conversion (which would lead to insanity
1761 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1762 1) to distinguish between IV/UV/NV slots that have cached a valid
1763 conversion where precision was lost and IV/UV/NV slots that have a
1764 valid conversion which has lost no precision
1765 2) to ensure that if a numeric conversion to one form is requested that
1766 would lose precision, the precise conversion (or differently
1767 imprecise conversion) is also performed and cached, to prevent
1768 requests for different numeric formats on the same SV causing
1769 lossy conversion chains. (lossless conversion chains are perfectly
1774 SvIOKp is true if the IV slot contains a valid value
1775 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1776 SvNOKp is true if the NV slot contains a valid value
1777 SvNOK is true only if the NV value is accurate
1780 while converting from PV to NV, check to see if converting that NV to an
1781 IV(or UV) would lose accuracy over a direct conversion from PV to
1782 IV(or UV). If it would, cache both conversions, return NV, but mark
1783 SV as IOK NOKp (ie not NOK).
1785 While converting from PV to IV, check to see if converting that IV to an
1786 NV would lose accuracy over a direct conversion from PV to NV. If it
1787 would, cache both conversions, flag similarly.
1789 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1790 correctly because if IV & NV were set NV *always* overruled.
1791 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1792 changes - now IV and NV together means that the two are interchangeable:
1793 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1795 The benefit of this is that operations such as pp_add know that if
1796 SvIOK is true for both left and right operands, then integer addition
1797 can be used instead of floating point (for cases where the result won't
1798 overflow). Before, floating point was always used, which could lead to
1799 loss of precision compared with integer addition.
1801 * making IV and NV equal status should make maths accurate on 64 bit
1803 * may speed up maths somewhat if pp_add and friends start to use
1804 integers when possible instead of fp. (Hopefully the overhead in
1805 looking for SvIOK and checking for overflow will not outweigh the
1806 fp to integer speedup)
1807 * will slow down integer operations (callers of SvIV) on "inaccurate"
1808 values, as the change from SvIOK to SvIOKp will cause a call into
1809 sv_2iv each time rather than a macro access direct to the IV slot
1810 * should speed up number->string conversion on integers as IV is
1811 favoured when IV and NV are equally accurate
1813 ####################################################################
1814 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1815 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1816 On the other hand, SvUOK is true iff UV.
1817 ####################################################################
1819 Your mileage will vary depending your CPU's relative fp to integer
1823 #ifndef NV_PRESERVES_UV
1824 # define IS_NUMBER_UNDERFLOW_IV 1
1825 # define IS_NUMBER_UNDERFLOW_UV 2
1826 # define IS_NUMBER_IV_AND_UV 2
1827 # define IS_NUMBER_OVERFLOW_IV 4
1828 # define IS_NUMBER_OVERFLOW_UV 5
1830 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1832 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1834 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1837 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));
1838 if (SvNVX(sv) < (NV)IV_MIN) {
1839 (void)SvIOKp_on(sv);
1841 SvIV_set(sv, IV_MIN);
1842 return IS_NUMBER_UNDERFLOW_IV;
1844 if (SvNVX(sv) > (NV)UV_MAX) {
1845 (void)SvIOKp_on(sv);
1848 SvUV_set(sv, UV_MAX);
1849 return IS_NUMBER_OVERFLOW_UV;
1851 (void)SvIOKp_on(sv);
1853 /* Can't use strtol etc to convert this string. (See truth table in
1855 if (SvNVX(sv) <= (UV)IV_MAX) {
1856 SvIV_set(sv, I_V(SvNVX(sv)));
1857 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1858 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1860 /* Integer is imprecise. NOK, IOKp */
1862 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1865 SvUV_set(sv, U_V(SvNVX(sv)));
1866 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1867 if (SvUVX(sv) == UV_MAX) {
1868 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1869 possibly be preserved by NV. Hence, it must be overflow.
1871 return IS_NUMBER_OVERFLOW_UV;
1873 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1875 /* Integer is imprecise. NOK, IOKp */
1877 return IS_NUMBER_OVERFLOW_IV;
1879 #endif /* !NV_PRESERVES_UV*/
1882 S_sv_2iuv_common(pTHX_ SV *sv) {
1885 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1886 * without also getting a cached IV/UV from it at the same time
1887 * (ie PV->NV conversion should detect loss of accuracy and cache
1888 * IV or UV at same time to avoid this. */
1889 /* IV-over-UV optimisation - choose to cache IV if possible */
1891 if (SvTYPE(sv) == SVt_NV)
1892 sv_upgrade(sv, SVt_PVNV);
1894 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1895 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1896 certainly cast into the IV range at IV_MAX, whereas the correct
1897 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1899 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1900 if (Perl_isnan(SvNVX(sv))) {
1906 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1907 SvIV_set(sv, I_V(SvNVX(sv)));
1908 if (SvNVX(sv) == (NV) SvIVX(sv)
1909 #ifndef NV_PRESERVES_UV
1910 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1911 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1912 /* Don't flag it as "accurately an integer" if the number
1913 came from a (by definition imprecise) NV operation, and
1914 we're outside the range of NV integer precision */
1917 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1918 DEBUG_c(PerlIO_printf(Perl_debug_log,
1919 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1925 /* IV not precise. No need to convert from PV, as NV
1926 conversion would already have cached IV if it detected
1927 that PV->IV would be better than PV->NV->IV
1928 flags already correct - don't set public IOK. */
1929 DEBUG_c(PerlIO_printf(Perl_debug_log,
1930 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1935 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1936 but the cast (NV)IV_MIN rounds to a the value less (more
1937 negative) than IV_MIN which happens to be equal to SvNVX ??
1938 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1939 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1940 (NV)UVX == NVX are both true, but the values differ. :-(
1941 Hopefully for 2s complement IV_MIN is something like
1942 0x8000000000000000 which will be exact. NWC */
1945 SvUV_set(sv, U_V(SvNVX(sv)));
1947 (SvNVX(sv) == (NV) SvUVX(sv))
1948 #ifndef NV_PRESERVES_UV
1949 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1950 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1951 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1952 /* Don't flag it as "accurately an integer" if the number
1953 came from a (by definition imprecise) NV operation, and
1954 we're outside the range of NV integer precision */
1959 DEBUG_c(PerlIO_printf(Perl_debug_log,
1960 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1966 else if (SvPOKp(sv) && SvLEN(sv)) {
1968 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1969 /* We want to avoid a possible problem when we cache an IV/ a UV which
1970 may be later translated to an NV, and the resulting NV is not
1971 the same as the direct translation of the initial string
1972 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1973 be careful to ensure that the value with the .456 is around if the
1974 NV value is requested in the future).
1976 This means that if we cache such an IV/a UV, we need to cache the
1977 NV as well. Moreover, we trade speed for space, and do not
1978 cache the NV if we are sure it's not needed.
1981 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1982 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1983 == IS_NUMBER_IN_UV) {
1984 /* It's definitely an integer, only upgrade to PVIV */
1985 if (SvTYPE(sv) < SVt_PVIV)
1986 sv_upgrade(sv, SVt_PVIV);
1988 } else if (SvTYPE(sv) < SVt_PVNV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 /* If NVs preserve UVs then we only use the UV value if we know that
1992 we aren't going to call atof() below. If NVs don't preserve UVs
1993 then the value returned may have more precision than atof() will
1994 return, even though value isn't perfectly accurate. */
1995 if ((numtype & (IS_NUMBER_IN_UV
1996 #ifdef NV_PRESERVES_UV
1999 )) == IS_NUMBER_IN_UV) {
2000 /* This won't turn off the public IOK flag if it was set above */
2001 (void)SvIOKp_on(sv);
2003 if (!(numtype & IS_NUMBER_NEG)) {
2005 if (value <= (UV)IV_MAX) {
2006 SvIV_set(sv, (IV)value);
2008 /* it didn't overflow, and it was positive. */
2009 SvUV_set(sv, value);
2013 /* 2s complement assumption */
2014 if (value <= (UV)IV_MIN) {
2015 SvIV_set(sv, -(IV)value);
2017 /* Too negative for an IV. This is a double upgrade, but
2018 I'm assuming it will be rare. */
2019 if (SvTYPE(sv) < SVt_PVNV)
2020 sv_upgrade(sv, SVt_PVNV);
2024 SvNV_set(sv, -(NV)value);
2025 SvIV_set(sv, IV_MIN);
2029 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2030 will be in the previous block to set the IV slot, and the next
2031 block to set the NV slot. So no else here. */
2033 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2034 != IS_NUMBER_IN_UV) {
2035 /* It wasn't an (integer that doesn't overflow the UV). */
2036 SvNV_set(sv, Atof(SvPVX_const(sv)));
2038 if (! numtype && ckWARN(WARN_NUMERIC))
2041 #if defined(USE_LONG_DOUBLE)
2042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2043 PTR2UV(sv), SvNVX(sv)));
2045 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2046 PTR2UV(sv), SvNVX(sv)));
2049 #ifdef NV_PRESERVES_UV
2050 (void)SvIOKp_on(sv);
2052 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2053 SvIV_set(sv, I_V(SvNVX(sv)));
2054 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2057 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp */
2059 /* UV will not work better than IV */
2061 if (SvNVX(sv) > (NV)UV_MAX) {
2063 /* Integer is inaccurate. NOK, IOKp, is UV */
2064 SvUV_set(sv, UV_MAX);
2066 SvUV_set(sv, U_V(SvNVX(sv)));
2067 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2068 NV preservse UV so can do correct comparison. */
2069 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2072 /*EMPTY*/; /* Integer is imprecise. NOK, IOKp, is UV */
2077 #else /* NV_PRESERVES_UV */
2078 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2079 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2080 /* The IV/UV slot will have been set from value returned by
2081 grok_number above. The NV slot has just been set using
2084 assert (SvIOKp(sv));
2086 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2087 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2088 /* Small enough to preserve all bits. */
2089 (void)SvIOKp_on(sv);
2091 SvIV_set(sv, I_V(SvNVX(sv)));
2092 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2094 /* Assumption: first non-preserved integer is < IV_MAX,
2095 this NV is in the preserved range, therefore: */
2096 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2098 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);
2102 0 0 already failed to read UV.
2103 0 1 already failed to read UV.
2104 1 0 you won't get here in this case. IV/UV
2105 slot set, public IOK, Atof() unneeded.
2106 1 1 already read UV.
2107 so there's no point in sv_2iuv_non_preserve() attempting
2108 to use atol, strtol, strtoul etc. */
2109 sv_2iuv_non_preserve (sv, numtype);
2112 #endif /* NV_PRESERVES_UV */
2116 if (isGV_with_GP(sv)) {
2117 return (bool)PTR2IV(glob_2inpuv((GV *)sv, NULL, TRUE));
2120 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2121 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2124 if (SvTYPE(sv) < SVt_IV)
2125 /* Typically the caller expects that sv_any is not NULL now. */
2126 sv_upgrade(sv, SVt_IV);
2127 /* Return 0 from the caller. */
2134 =for apidoc sv_2iv_flags
2136 Return the integer value of an SV, doing any necessary string
2137 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2138 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2144 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2149 if (SvGMAGICAL(sv)) {
2150 if (flags & SV_GMAGIC)
2155 return I_V(SvNVX(sv));
2157 if (SvPOKp(sv) && SvLEN(sv)) {
2160 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2162 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2163 == IS_NUMBER_IN_UV) {
2164 /* It's definitely an integer */
2165 if (numtype & IS_NUMBER_NEG) {
2166 if (value < (UV)IV_MIN)
2169 if (value < (UV)IV_MAX)
2174 if (ckWARN(WARN_NUMERIC))
2177 return I_V(Atof(SvPVX_const(sv)));
2182 assert(SvTYPE(sv) >= SVt_PVMG);
2183 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2184 } else if (SvTHINKFIRST(sv)) {
2188 SV * const tmpstr=AMG_CALLun(sv,numer);
2189 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2190 return SvIV(tmpstr);
2193 return PTR2IV(SvRV(sv));
2196 sv_force_normal_flags(sv, 0);
2198 if (SvREADONLY(sv) && !SvOK(sv)) {
2199 if (ckWARN(WARN_UNINITIALIZED))
2205 if (S_sv_2iuv_common(aTHX_ sv))
2208 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2209 PTR2UV(sv),SvIVX(sv)));
2210 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2214 =for apidoc sv_2uv_flags
2216 Return the unsigned integer value of an SV, doing any necessary string
2217 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2218 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2224 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2229 if (SvGMAGICAL(sv)) {
2230 if (flags & SV_GMAGIC)
2235 return U_V(SvNVX(sv));
2236 if (SvPOKp(sv) && SvLEN(sv)) {
2239 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2241 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2242 == IS_NUMBER_IN_UV) {
2243 /* It's definitely an integer */
2244 if (!(numtype & IS_NUMBER_NEG))
2248 if (ckWARN(WARN_NUMERIC))
2251 return U_V(Atof(SvPVX_const(sv)));
2256 assert(SvTYPE(sv) >= SVt_PVMG);
2257 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2258 } else if (SvTHINKFIRST(sv)) {
2262 SV *const tmpstr = AMG_CALLun(sv,numer);
2263 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2264 return SvUV(tmpstr);
2267 return PTR2UV(SvRV(sv));
2270 sv_force_normal_flags(sv, 0);
2272 if (SvREADONLY(sv) && !SvOK(sv)) {
2273 if (ckWARN(WARN_UNINITIALIZED))
2279 if (S_sv_2iuv_common(aTHX_ sv))
2283 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2284 PTR2UV(sv),SvUVX(sv)));
2285 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2291 Return the num value of an SV, doing any necessary string or integer
2292 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2299 Perl_sv_2nv(pTHX_ register SV *sv)
2304 if (SvGMAGICAL(sv)) {
2308 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2309 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2310 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2312 return Atof(SvPVX_const(sv));
2316 return (NV)SvUVX(sv);
2318 return (NV)SvIVX(sv);
2323 assert(SvTYPE(sv) >= SVt_PVMG);
2324 /* This falls through to the report_uninit near the end of the
2326 } else if (SvTHINKFIRST(sv)) {
2330 SV *const tmpstr = AMG_CALLun(sv,numer);
2331 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2332 return SvNV(tmpstr);
2335 return PTR2NV(SvRV(sv));
2338 sv_force_normal_flags(sv, 0);
2340 if (SvREADONLY(sv) && !SvOK(sv)) {
2341 if (ckWARN(WARN_UNINITIALIZED))
2346 if (SvTYPE(sv) < SVt_NV) {
2347 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2348 sv_upgrade(sv, SVt_NV);
2349 #ifdef USE_LONG_DOUBLE
2351 STORE_NUMERIC_LOCAL_SET_STANDARD();
2352 PerlIO_printf(Perl_debug_log,
2353 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2354 PTR2UV(sv), SvNVX(sv));
2355 RESTORE_NUMERIC_LOCAL();
2359 STORE_NUMERIC_LOCAL_SET_STANDARD();
2360 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2361 PTR2UV(sv), SvNVX(sv));
2362 RESTORE_NUMERIC_LOCAL();
2366 else if (SvTYPE(sv) < SVt_PVNV)
2367 sv_upgrade(sv, SVt_PVNV);
2372 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2373 #ifdef NV_PRESERVES_UV
2376 /* Only set the public NV OK flag if this NV preserves the IV */
2377 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2378 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2379 : (SvIVX(sv) == I_V(SvNVX(sv))))
2385 else if (SvPOKp(sv) && SvLEN(sv)) {
2387 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2388 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2390 #ifdef NV_PRESERVES_UV
2391 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2392 == IS_NUMBER_IN_UV) {
2393 /* It's definitely an integer */
2394 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2396 SvNV_set(sv, Atof(SvPVX_const(sv)));
2399 SvNV_set(sv, Atof(SvPVX_const(sv)));
2400 /* Only set the public NV OK flag if this NV preserves the value in
2401 the PV at least as well as an IV/UV would.
2402 Not sure how to do this 100% reliably. */
2403 /* if that shift count is out of range then Configure's test is
2404 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2406 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2407 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2408 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2409 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2410 /* Can't use strtol etc to convert this string, so don't try.
2411 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2414 /* value has been set. It may not be precise. */
2415 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2416 /* 2s complement assumption for (UV)IV_MIN */
2417 SvNOK_on(sv); /* Integer is too negative. */
2422 if (numtype & IS_NUMBER_NEG) {
2423 SvIV_set(sv, -(IV)value);
2424 } else if (value <= (UV)IV_MAX) {
2425 SvIV_set(sv, (IV)value);
2427 SvUV_set(sv, value);
2431 if (numtype & IS_NUMBER_NOT_INT) {
2432 /* I believe that even if the original PV had decimals,
2433 they are lost beyond the limit of the FP precision.
2434 However, neither is canonical, so both only get p
2435 flags. NWC, 2000/11/25 */
2436 /* Both already have p flags, so do nothing */
2438 const NV nv = SvNVX(sv);
2439 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2440 if (SvIVX(sv) == I_V(nv)) {
2443 /* It had no "." so it must be integer. */
2447 /* between IV_MAX and NV(UV_MAX).
2448 Could be slightly > UV_MAX */
2450 if (numtype & IS_NUMBER_NOT_INT) {
2451 /* UV and NV both imprecise. */
2453 const UV nv_as_uv = U_V(nv);
2455 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2464 #endif /* NV_PRESERVES_UV */
2467 if (isGV_with_GP(sv)) {
2468 glob_2inpuv((GV *)sv, NULL, TRUE);
2472 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2474 assert (SvTYPE(sv) >= SVt_NV);
2475 /* Typically the caller expects that sv_any is not NULL now. */
2476 /* XXX Ilya implies that this is a bug in callers that assume this
2477 and ideally should be fixed. */
2480 #if defined(USE_LONG_DOUBLE)
2482 STORE_NUMERIC_LOCAL_SET_STANDARD();
2483 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2484 PTR2UV(sv), SvNVX(sv));
2485 RESTORE_NUMERIC_LOCAL();
2489 STORE_NUMERIC_LOCAL_SET_STANDARD();
2490 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2491 PTR2UV(sv), SvNVX(sv));
2492 RESTORE_NUMERIC_LOCAL();
2498 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2499 * UV as a string towards the end of buf, and return pointers to start and
2502 * We assume that buf is at least TYPE_CHARS(UV) long.
2506 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2508 char *ptr = buf + TYPE_CHARS(UV);
2509 char * const ebuf = ptr;
2522 *--ptr = '0' + (char)(uv % 10);
2530 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2531 * a regexp to its stringified form.
2535 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2537 const regexp * const re = (regexp *)mg->mg_obj;
2540 const char *fptr = "msix";
2545 bool need_newline = 0;
2546 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2548 while((ch = *fptr++)) {
2550 reflags[left++] = ch;
2553 reflags[right--] = ch;
2558 reflags[left] = '-';
2562 mg->mg_len = re->prelen + 4 + left;
2564 * If /x was used, we have to worry about a regex ending with a
2565 * comment later being embedded within another regex. If so, we don't
2566 * want this regex's "commentization" to leak out to the right part of
2567 * the enclosing regex, we must cap it with a newline.
2569 * So, if /x was used, we scan backwards from the end of the regex. If
2570 * we find a '#' before we find a newline, we need to add a newline
2571 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2572 * we don't need to add anything. -jfriedl
2574 if (PMf_EXTENDED & re->reganch) {
2575 const char *endptr = re->precomp + re->prelen;
2576 while (endptr >= re->precomp) {
2577 const char c = *(endptr--);
2579 break; /* don't need another */
2581 /* we end while in a comment, so we need a newline */
2582 mg->mg_len++; /* save space for it */
2583 need_newline = 1; /* note to add it */
2589 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2590 mg->mg_ptr[0] = '(';
2591 mg->mg_ptr[1] = '?';
2592 Copy(reflags, mg->mg_ptr+2, left, char);
2593 *(mg->mg_ptr+left+2) = ':';
2594 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2596 mg->mg_ptr[mg->mg_len - 2] = '\n';
2597 mg->mg_ptr[mg->mg_len - 1] = ')';
2598 mg->mg_ptr[mg->mg_len] = 0;
2600 PL_reginterp_cnt += re->program[0].next_off;
2602 if (re->reganch & ROPT_UTF8)
2612 =for apidoc sv_2pv_flags
2614 Returns a pointer to the string value of an SV, and sets *lp to its length.
2615 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2617 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2618 usually end up here too.
2624 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2634 if (SvGMAGICAL(sv)) {
2635 if (flags & SV_GMAGIC)
2640 if (flags & SV_MUTABLE_RETURN)
2641 return SvPVX_mutable(sv);
2642 if (flags & SV_CONST_RETURN)
2643 return (char *)SvPVX_const(sv);
2646 if (SvIOKp(sv) || SvNOKp(sv)) {
2647 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2651 len = SvIsUV(sv) ? my_sprintf(tbuf,"%"UVuf, (UV)SvUVX(sv))
2652 : my_sprintf(tbuf,"%"IVdf, (IV)SvIVX(sv));
2654 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2661 #ifdef FIXNEGATIVEZERO
2662 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2668 SvUPGRADE(sv, SVt_PV);
2671 s = SvGROW_mutable(sv, len + 1);
2674 return memcpy(s, tbuf, len + 1);
2680 assert(SvTYPE(sv) >= SVt_PVMG);
2681 /* This falls through to the report_uninit near the end of the
2683 } else if (SvTHINKFIRST(sv)) {
2687 SV *const tmpstr = AMG_CALLun(sv,string);
2688 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2690 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2694 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2695 if (flags & SV_CONST_RETURN) {
2696 pv = (char *) SvPVX_const(tmpstr);
2698 pv = (flags & SV_MUTABLE_RETURN)
2699 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2702 *lp = SvCUR(tmpstr);
2704 pv = sv_2pv_flags(tmpstr, lp, flags);
2716 const SV *const referent = (SV*)SvRV(sv);
2719 tsv = sv_2mortal(newSVpvs("NULLREF"));
2720 } else if (SvTYPE(referent) == SVt_PVMG
2721 && ((SvFLAGS(referent) &
2722 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2723 == (SVs_OBJECT|SVs_SMG))
2724 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2725 return stringify_regexp(sv, mg, lp);
2727 const char *const typestr = sv_reftype(referent, 0);
2729 tsv = sv_newmortal();
2730 if (SvOBJECT(referent)) {
2731 const char *const name = HvNAME_get(SvSTASH(referent));
2732 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
2733 name ? name : "__ANON__" , typestr,
2737 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr,
2745 if (SvREADONLY(sv) && !SvOK(sv)) {
2746 if (ckWARN(WARN_UNINITIALIZED))
2753 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2754 /* I'm assuming that if both IV and NV are equally valid then
2755 converting the IV is going to be more efficient */
2756 const U32 isIOK = SvIOK(sv);
2757 const U32 isUIOK = SvIsUV(sv);
2758 char buf[TYPE_CHARS(UV)];
2761 if (SvTYPE(sv) < SVt_PVIV)
2762 sv_upgrade(sv, SVt_PVIV);
2763 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2764 /* inlined from sv_setpvn */
2765 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2766 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2767 SvCUR_set(sv, ebuf - ptr);
2777 else if (SvNOKp(sv)) {
2778 const int olderrno = errno;
2779 if (SvTYPE(sv) < SVt_PVNV)
2780 sv_upgrade(sv, SVt_PVNV);
2781 /* The +20 is pure guesswork. Configure test needed. --jhi */
2782 s = SvGROW_mutable(sv, NV_DIG + 20);
2783 /* some Xenix systems wipe out errno here */
2785 if (SvNVX(sv) == 0.0)
2786 (void)strcpy(s,"0");
2790 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2793 #ifdef FIXNEGATIVEZERO
2794 if (*s == '-' && s[1] == '0' && !s[2])
2804 if (isGV_with_GP(sv)) {
2805 return glob_2inpuv((GV *)sv, lp, FALSE);
2808 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2812 if (SvTYPE(sv) < SVt_PV)
2813 /* Typically the caller expects that sv_any is not NULL now. */
2814 sv_upgrade(sv, SVt_PV);
2818 const STRLEN len = s - SvPVX_const(sv);
2824 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2825 PTR2UV(sv),SvPVX_const(sv)));
2826 if (flags & SV_CONST_RETURN)
2827 return (char *)SvPVX_const(sv);
2828 if (flags & SV_MUTABLE_RETURN)
2829 return SvPVX_mutable(sv);
2834 =for apidoc sv_copypv
2836 Copies a stringified representation of the source SV into the
2837 destination SV. Automatically performs any necessary mg_get and
2838 coercion of numeric values into strings. Guaranteed to preserve
2839 UTF-8 flag even from overloaded objects. Similar in nature to
2840 sv_2pv[_flags] but operates directly on an SV instead of just the
2841 string. Mostly uses sv_2pv_flags to do its work, except when that
2842 would lose the UTF-8'ness of the PV.
2848 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2851 const char * const s = SvPV_const(ssv,len);
2852 sv_setpvn(dsv,s,len);
2860 =for apidoc sv_2pvbyte
2862 Return a pointer to the byte-encoded representation of the SV, and set *lp
2863 to its length. May cause the SV to be downgraded from UTF-8 as a
2866 Usually accessed via the C<SvPVbyte> macro.
2872 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2874 sv_utf8_downgrade(sv,0);
2875 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2879 =for apidoc sv_2pvutf8
2881 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2882 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2884 Usually accessed via the C<SvPVutf8> macro.
2890 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2892 sv_utf8_upgrade(sv);
2893 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2898 =for apidoc sv_2bool
2900 This function is only called on magical items, and is only used by
2901 sv_true() or its macro equivalent.
2907 Perl_sv_2bool(pTHX_ register SV *sv)
2916 SV * const tmpsv = AMG_CALLun(sv,bool_);
2917 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2918 return (bool)SvTRUE(tmpsv);
2920 return SvRV(sv) != 0;
2923 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2925 (*sv->sv_u.svu_pv > '0' ||
2926 Xpvtmp->xpv_cur > 1 ||
2927 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2934 return SvIVX(sv) != 0;
2937 return SvNVX(sv) != 0.0;
2939 if (isGV_with_GP(sv))
2949 =for apidoc sv_utf8_upgrade
2951 Converts the PV of an SV to its UTF-8-encoded form.
2952 Forces the SV to string form if it is not already.
2953 Always sets the SvUTF8 flag to avoid future validity checks even
2954 if all the bytes have hibit clear.
2956 This is not as a general purpose byte encoding to Unicode interface:
2957 use the Encode extension for that.
2959 =for apidoc sv_utf8_upgrade_flags
2961 Converts the PV of an SV to its UTF-8-encoded form.
2962 Forces the SV to string form if it is not already.
2963 Always sets the SvUTF8 flag to avoid future validity checks even
2964 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2965 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2966 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2968 This is not as a general purpose byte encoding to Unicode interface:
2969 use the Encode extension for that.
2975 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2978 if (sv == &PL_sv_undef)
2982 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2983 (void) sv_2pv_flags(sv,&len, flags);
2987 (void) SvPV_force(sv,len);
2996 sv_force_normal_flags(sv, 0);
2999 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3000 sv_recode_to_utf8(sv, PL_encoding);
3001 else { /* Assume Latin-1/EBCDIC */
3002 /* This function could be much more efficient if we
3003 * had a FLAG in SVs to signal if there are any hibit
3004 * chars in the PV. Given that there isn't such a flag
3005 * make the loop as fast as possible. */
3006 const U8 * const s = (U8 *) SvPVX_const(sv);
3007 const U8 * const e = (U8 *) SvEND(sv);
3012 /* Check for hi bit */
3013 if (!NATIVE_IS_INVARIANT(ch)) {
3014 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3015 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3017 SvPV_free(sv); /* No longer using what was there before. */
3018 SvPV_set(sv, (char*)recoded);
3019 SvCUR_set(sv, len - 1);
3020 SvLEN_set(sv, len); /* No longer know the real size. */
3024 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3031 =for apidoc sv_utf8_downgrade
3033 Attempts to convert the PV of an SV from characters to bytes.
3034 If the PV contains a character beyond byte, this conversion will fail;
3035 in this case, either returns false or, if C<fail_ok> is not
3038 This is not as a general purpose Unicode to byte encoding interface:
3039 use the Encode extension for that.
3045 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3048 if (SvPOKp(sv) && SvUTF8(sv)) {
3054 sv_force_normal_flags(sv, 0);
3056 s = (U8 *) SvPV(sv, len);
3057 if (!utf8_to_bytes(s, &len)) {
3062 Perl_croak(aTHX_ "Wide character in %s",
3065 Perl_croak(aTHX_ "Wide character");
3076 =for apidoc sv_utf8_encode
3078 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3079 flag off so that it looks like octets again.
3085 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3087 (void) sv_utf8_upgrade(sv);
3089 sv_force_normal_flags(sv, 0);
3091 if (SvREADONLY(sv)) {
3092 Perl_croak(aTHX_ PL_no_modify);
3098 =for apidoc sv_utf8_decode
3100 If the PV of the SV is an octet sequence in UTF-8
3101 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3102 so that it looks like a character. If the PV contains only single-byte
3103 characters, the C<SvUTF8> flag stays being off.
3104 Scans PV for validity and returns false if the PV is invalid UTF-8.
3110 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3116 /* The octets may have got themselves encoded - get them back as
3119 if (!sv_utf8_downgrade(sv, TRUE))
3122 /* it is actually just a matter of turning the utf8 flag on, but
3123 * we want to make sure everything inside is valid utf8 first.
3125 c = (const U8 *) SvPVX_const(sv);
3126 if (!is_utf8_string(c, SvCUR(sv)+1))
3128 e = (const U8 *) SvEND(sv);
3131 if (!UTF8_IS_INVARIANT(ch)) {
3141 =for apidoc sv_setsv
3143 Copies the contents of the source SV C<ssv> into the destination SV
3144 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3145 function if the source SV needs to be reused. Does not handle 'set' magic.
3146 Loosely speaking, it performs a copy-by-value, obliterating any previous
3147 content of the destination.
3149 You probably want to use one of the assortment of wrappers, such as
3150 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3151 C<SvSetMagicSV_nosteal>.
3153 =for apidoc sv_setsv_flags
3155 Copies the contents of the source SV C<ssv> into the destination SV
3156 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3157 function if the source SV needs to be reused. Does not handle 'set' magic.
3158 Loosely speaking, it performs a copy-by-value, obliterating any previous
3159 content of the destination.
3160 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3161 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3162 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3163 and C<sv_setsv_nomg> are implemented in terms of this function.
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3169 This is the primary function for copying scalars, and most other
3170 copy-ish functions and macros use this underneath.
3176 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3178 if (dtype != SVt_PVGV) {
3179 const char * const name = GvNAME(sstr);
3180 const STRLEN len = GvNAMELEN(sstr);
3181 /* don't upgrade SVt_PVLV: it can hold a glob */
3182 if (dtype != SVt_PVLV) {
3183 if (dtype >= SVt_PV) {
3189 sv_upgrade(dstr, SVt_PVGV);
3190 (void)SvOK_off(dstr);
3193 GvSTASH(dstr) = GvSTASH(sstr);
3195 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3196 gv_name_set((GV *)dstr, name, len, GV_ADD);
3197 SvFAKE_on(dstr); /* can coerce to non-glob */
3200 #ifdef GV_UNIQUE_CHECK
3201 if (GvUNIQUE((GV*)dstr)) {
3202 Perl_croak(aTHX_ PL_no_modify);
3208 (void)SvOK_off(dstr);
3210 GvINTRO_off(dstr); /* one-shot flag */
3211 GvGP(dstr) = gp_ref(GvGP(sstr));
3212 if (SvTAINTED(sstr))
3214 if (GvIMPORTED(dstr) != GVf_IMPORTED
3215 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3217 GvIMPORTED_on(dstr);
3224 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3225 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3227 const int intro = GvINTRO(dstr);
3230 const U32 stype = SvTYPE(sref);
3233 #ifdef GV_UNIQUE_CHECK
3234 if (GvUNIQUE((GV*)dstr)) {
3235 Perl_croak(aTHX_ PL_no_modify);
3240 GvINTRO_off(dstr); /* one-shot flag */
3241 GvLINE(dstr) = CopLINE(PL_curcop);
3242 GvEGV(dstr) = (GV*)dstr;
3247 location = (SV **) &GvCV(dstr);
3248 import_flag = GVf_IMPORTED_CV;
3251 location = (SV **) &GvHV(dstr);
3252 import_flag = GVf_IMPORTED_HV;
3255 location = (SV **) &GvAV(dstr);
3256 import_flag = GVf_IMPORTED_AV;
3259 location = (SV **) &GvIOp(dstr);
3262 location = (SV **) &GvFORM(dstr);
3264 location = &GvSV(dstr);
3265 import_flag = GVf_IMPORTED_SV;
3268 if (stype == SVt_PVCV) {
3269 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3270 SvREFCNT_dec(GvCV(dstr));
3272 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3273 PL_sub_generation++;
3276 SAVEGENERICSV(*location);
3280 if (stype == SVt_PVCV && *location != sref) {
3281 CV* const cv = (CV*)*location;
3283 if (!GvCVGEN((GV*)dstr) &&
3284 (CvROOT(cv) || CvXSUB(cv)))
3286 /* Redefining a sub - warning is mandatory if
3287 it was a const and its value changed. */
3288 if (CvCONST(cv) && CvCONST((CV*)sref)
3289 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3291 /* They are 2 constant subroutines generated from
3292 the same constant. This probably means that
3293 they are really the "same" proxy subroutine
3294 instantiated in 2 places. Most likely this is
3295 when a constant is exported twice. Don't warn.
3298 else if (ckWARN(WARN_REDEFINE)
3300 && (!CvCONST((CV*)sref)
3301 || sv_cmp(cv_const_sv(cv),
3302 cv_const_sv((CV*)sref))))) {
3303 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3305 ? "Constant subroutine %s::%s redefined"
3306 : "Subroutine %s::%s redefined",
3307 HvNAME_get(GvSTASH((GV*)dstr)),
3308 GvENAME((GV*)dstr));
3312 cv_ckproto(cv, (GV*)dstr,
3313 SvPOK(sref) ? SvPVX_const(sref) : NULL);
3315 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3316 GvASSUMECV_on(dstr);
3317 PL_sub_generation++;
3320 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3321 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3322 GvFLAGS(dstr) |= import_flag;
3327 if (SvTAINTED(sstr))
3333 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3336 register U32 sflags;
3342 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3344 sstr = &PL_sv_undef;
3345 stype = SvTYPE(sstr);
3346 dtype = SvTYPE(dstr);
3351 /* need to nuke the magic */
3353 SvRMAGICAL_off(dstr);
3356 /* There's a lot of redundancy below but we're going for speed here */
3361 if (dtype != SVt_PVGV) {
3362 (void)SvOK_off(dstr);
3370 sv_upgrade(dstr, SVt_IV);
3375 sv_upgrade(dstr, SVt_PVIV);
3378 (void)SvIOK_only(dstr);
3379 SvIV_set(dstr, SvIVX(sstr));
3382 /* SvTAINTED can only be true if the SV has taint magic, which in
3383 turn means that the SV type is PVMG (or greater). This is the
3384 case statement for SVt_IV, so this cannot be true (whatever gcov
3386 assert(!SvTAINTED(sstr));
3396 sv_upgrade(dstr, SVt_NV);
3401 sv_upgrade(dstr, SVt_PVNV);
3404 SvNV_set(dstr, SvNVX(sstr));
3405 (void)SvNOK_only(dstr);
3406 /* SvTAINTED can only be true if the SV has taint magic, which in
3407 turn means that the SV type is PVMG (or greater). This is the
3408 case statement for SVt_NV, so this cannot be true (whatever gcov
3410 assert(!SvTAINTED(sstr));
3417 sv_upgrade(dstr, SVt_RV);
3420 #ifdef PERL_OLD_COPY_ON_WRITE
3421 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3422 if (dtype < SVt_PVIV)
3423 sv_upgrade(dstr, SVt_PVIV);
3430 sv_upgrade(dstr, SVt_PV);
3433 if (dtype < SVt_PVIV)
3434 sv_upgrade(dstr, SVt_PVIV);
3437 if (dtype < SVt_PVNV)
3438 sv_upgrade(dstr, SVt_PVNV);
3442 const char * const type = sv_reftype(sstr,0);
3444 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3446 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3451 if (dtype <= SVt_PVGV) {
3452 glob_assign_glob(dstr, sstr, dtype);
3460 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3462 if ((int)SvTYPE(sstr) != stype) {
3463 stype = SvTYPE(sstr);
3464 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3465 glob_assign_glob(dstr, sstr, dtype);
3470 if (stype == SVt_PVLV)
3471 SvUPGRADE(dstr, SVt_PVNV);
3473 SvUPGRADE(dstr, (U32)stype);
3476 /* dstr may have been upgraded. */
3477 dtype = SvTYPE(dstr);
3478 sflags = SvFLAGS(sstr);
3480 if (sflags & SVf_ROK) {
3481 if (dtype == SVt_PVGV &&
3482 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3485 if (GvIMPORTED(dstr) != GVf_IMPORTED
3486 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3488 GvIMPORTED_on(dstr);
3493 glob_assign_glob(dstr, sstr, dtype);
3497 if (dtype >= SVt_PV) {
3498 if (dtype == SVt_PVGV) {
3499 glob_assign_ref(dstr, sstr);
3502 if (SvPVX_const(dstr)) {
3508 (void)SvOK_off(dstr);
3509 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3510 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3511 assert(!(sflags & SVp_NOK));
3512 assert(!(sflags & SVp_IOK));
3513 assert(!(sflags & SVf_NOK));
3514 assert(!(sflags & SVf_IOK));
3516 else if (dtype == SVt_PVGV) {
3517 if (!(sflags & SVf_OK)) {
3518 if (ckWARN(WARN_MISC))
3519 Perl_warner(aTHX_ packWARN(WARN_MISC),
3520 "Undefined value assigned to typeglob");
3523 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3524 if (dstr != (SV*)gv) {
3527 GvGP(dstr) = gp_ref(GvGP(gv));
3531 else if (sflags & SVp_POK) {
3535 * Check to see if we can just swipe the string. If so, it's a
3536 * possible small lose on short strings, but a big win on long ones.
3537 * It might even be a win on short strings if SvPVX_const(dstr)
3538 * has to be allocated and SvPVX_const(sstr) has to be freed.
3541 /* Whichever path we take through the next code, we want this true,
3542 and doing it now facilitates the COW check. */
3543 (void)SvPOK_only(dstr);
3546 /* We're not already COW */
3547 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3548 #ifndef PERL_OLD_COPY_ON_WRITE
3549 /* or we are, but dstr isn't a suitable target. */
3550 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3555 (sflags & SVs_TEMP) && /* slated for free anyway? */
3556 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3557 (!(flags & SV_NOSTEAL)) &&
3558 /* and we're allowed to steal temps */
3559 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3560 SvLEN(sstr) && /* and really is a string */
3561 /* and won't be needed again, potentially */
3562 !(PL_op && PL_op->op_type == OP_AASSIGN))
3563 #ifdef PERL_OLD_COPY_ON_WRITE
3564 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3565 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3566 && SvTYPE(sstr) >= SVt_PVIV)
3569 /* Failed the swipe test, and it's not a shared hash key either.
3570 Have to copy the string. */
3571 STRLEN len = SvCUR(sstr);
3572 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3573 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3574 SvCUR_set(dstr, len);
3575 *SvEND(dstr) = '\0';
3577 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3579 /* Either it's a shared hash key, or it's suitable for
3580 copy-on-write or we can swipe the string. */
3582 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3586 #ifdef PERL_OLD_COPY_ON_WRITE
3588 /* I believe I should acquire a global SV mutex if
3589 it's a COW sv (not a shared hash key) to stop
3590 it going un copy-on-write.
3591 If the source SV has gone un copy on write between up there
3592 and down here, then (assert() that) it is of the correct
3593 form to make it copy on write again */
3594 if ((sflags & (SVf_FAKE | SVf_READONLY))
3595 != (SVf_FAKE | SVf_READONLY)) {
3596 SvREADONLY_on(sstr);
3598 /* Make the source SV into a loop of 1.
3599 (about to become 2) */
3600 SV_COW_NEXT_SV_SET(sstr, sstr);
3604 /* Initial code is common. */
3605 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3610 /* making another shared SV. */
3611 STRLEN cur = SvCUR(sstr);
3612 STRLEN len = SvLEN(sstr);
3613 #ifdef PERL_OLD_COPY_ON_WRITE
3615 assert (SvTYPE(dstr) >= SVt_PVIV);
3616 /* SvIsCOW_normal */
3617 /* splice us in between source and next-after-source. */
3618 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3619 SV_COW_NEXT_SV_SET(sstr, dstr);
3620 SvPV_set(dstr, SvPVX_mutable(sstr));
3624 /* SvIsCOW_shared_hash */
3625 DEBUG_C(PerlIO_printf(Perl_debug_log,
3626 "Copy on write: Sharing hash\n"));
3628 assert (SvTYPE(dstr) >= SVt_PV);
3630 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3632 SvLEN_set(dstr, len);
3633 SvCUR_set(dstr, cur);
3634 SvREADONLY_on(dstr);
3636 /* Relesase a global SV mutex. */
3639 { /* Passes the swipe test. */
3640 SvPV_set(dstr, SvPVX_mutable(sstr));
3641 SvLEN_set(dstr, SvLEN(sstr));
3642 SvCUR_set(dstr, SvCUR(sstr));
3645 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3646 SvPV_set(sstr, NULL);
3652 if (sflags & SVp_NOK) {
3653 SvNV_set(dstr, SvNVX(sstr));
3655 if (sflags & SVp_IOK) {
3656 SvRELEASE_IVX(dstr);
3657 SvIV_set(dstr, SvIVX(sstr));
3658 /* Must do this otherwise some other overloaded use of 0x80000000
3659 gets confused. I guess SVpbm_VALID */
3660 if (sflags & SVf_IVisUV)
3663 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3666 const MAGIC * const smg = SvVOK(sstr);
3668 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3669 smg->mg_ptr, smg->mg_len);
3670 SvRMAGICAL_on(dstr);
3674 else if (sflags & (SVp_IOK|SVp_NOK)) {
3675 (void)SvOK_off(dstr);
3676 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3678 if (sflags & SVp_IOK) {
3679 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3680 SvIV_set(dstr, SvIVX(sstr));
3682 if (sflags & SVp_NOK) {
3683 SvNV_set(dstr, SvNVX(sstr));
3687 if (isGV_with_GP(sstr)) {
3688 /* This stringification rule for globs is spread in 3 places.
3689 This feels bad. FIXME. */
3690 const U32 wasfake = sflags & SVf_FAKE;
3692 /* FAKE globs can get coerced, so need to turn this off
3693 temporarily if it is on. */
3695 gv_efullname3(dstr, (GV *)sstr, "*");
3696 SvFLAGS(sstr) |= wasfake;
3697 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3700 (void)SvOK_off(dstr);
3702 if (SvTAINTED(sstr))
3707 =for apidoc sv_setsv_mg
3709 Like C<sv_setsv>, but also handles 'set' magic.
3715 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3717 sv_setsv(dstr,sstr);
3721 #ifdef PERL_OLD_COPY_ON_WRITE
3723 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3725 STRLEN cur = SvCUR(sstr);
3726 STRLEN len = SvLEN(sstr);
3727 register char *new_pv;
3730 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3738 if (SvTHINKFIRST(dstr))
3739 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3740 else if (SvPVX_const(dstr))
3741 Safefree(SvPVX_const(dstr));
3745 SvUPGRADE(dstr, SVt_PVIV);
3747 assert (SvPOK(sstr));
3748 assert (SvPOKp(sstr));
3749 assert (!SvIOK(sstr));
3750 assert (!SvIOKp(sstr));
3751 assert (!SvNOK(sstr));
3752 assert (!SvNOKp(sstr));
3754 if (SvIsCOW(sstr)) {
3756 if (SvLEN(sstr) == 0) {
3757 /* source is a COW shared hash key. */
3758 DEBUG_C(PerlIO_printf(Perl_debug_log,
3759 "Fast copy on write: Sharing hash\n"));
3760 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3763 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3765 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3766 SvUPGRADE(sstr, SVt_PVIV);
3767 SvREADONLY_on(sstr);
3769 DEBUG_C(PerlIO_printf(Perl_debug_log,
3770 "Fast copy on write: Converting sstr to COW\n"));
3771 SV_COW_NEXT_SV_SET(dstr, sstr);
3773 SV_COW_NEXT_SV_SET(sstr, dstr);
3774 new_pv = SvPVX_mutable(sstr);
3777 SvPV_set(dstr, new_pv);
3778 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3781 SvLEN_set(dstr, len);
3782 SvCUR_set(dstr, cur);
3791 =for apidoc sv_setpvn
3793 Copies a string into an SV. The C<len> parameter indicates the number of
3794 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3795 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3801 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3804 register char *dptr;
3806 SV_CHECK_THINKFIRST_COW_DROP(sv);
3812 /* len is STRLEN which is unsigned, need to copy to signed */
3815 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3817 SvUPGRADE(sv, SVt_PV);
3819 dptr = SvGROW(sv, len + 1);
3820 Move(ptr,dptr,len,char);
3823 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3828 =for apidoc sv_setpvn_mg
3830 Like C<sv_setpvn>, but also handles 'set' magic.
3836 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3838 sv_setpvn(sv,ptr,len);
3843 =for apidoc sv_setpv
3845 Copies a string into an SV. The string must be null-terminated. Does not
3846 handle 'set' magic. See C<sv_setpv_mg>.
3852 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3855 register STRLEN len;
3857 SV_CHECK_THINKFIRST_COW_DROP(sv);
3863 SvUPGRADE(sv, SVt_PV);
3865 SvGROW(sv, len + 1);
3866 Move(ptr,SvPVX(sv),len+1,char);
3868 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3873 =for apidoc sv_setpv_mg
3875 Like C<sv_setpv>, but also handles 'set' magic.
3881 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3888 =for apidoc sv_usepvn
3890 Tells an SV to use C<ptr> to find its string value. Normally the
3891 string is stored inside the SV but sv_usepvn allows the SV to use an
3892 outside string. The C<ptr> should point to memory that was allocated
3893 by C<malloc>. The string length, C<len>, must be supplied. This
3894 function will realloc (i.e. move) the memory pointed to by C<ptr>,
3895 so that pointer should not be freed or used by the programmer after
3896 giving it to sv_usepvn, and neither should any pointers from "behind"
3897 that pointer (e.g. ptr + 1) be used. Does not handle 'set' magic.
3898 See C<sv_usepvn_mg>.
3904 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3908 SV_CHECK_THINKFIRST_COW_DROP(sv);
3909 SvUPGRADE(sv, SVt_PV);
3914 if (SvPVX_const(sv))
3917 allocate = PERL_STRLEN_ROUNDUP(len + 1);
3918 ptr = saferealloc (ptr, allocate);
3921 SvLEN_set(sv, allocate);
3923 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3928 =for apidoc sv_usepvn_mg
3930 Like C<sv_usepvn>, but also handles 'set' magic.
3936 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
3938 sv_usepvn(sv,ptr,len);
3942 #ifdef PERL_OLD_COPY_ON_WRITE
3943 /* Need to do this *after* making the SV normal, as we need the buffer
3944 pointer to remain valid until after we've copied it. If we let go too early,
3945 another thread could invalidate it by unsharing last of the same hash key
3946 (which it can do by means other than releasing copy-on-write Svs)
3947 or by changing the other copy-on-write SVs in the loop. */
3949 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
3951 if (len) { /* this SV was SvIsCOW_normal(sv) */
3952 /* we need to find the SV pointing to us. */
3953 SV *current = SV_COW_NEXT_SV(after);
3955 if (current == sv) {
3956 /* The SV we point to points back to us (there were only two of us
3958 Hence other SV is no longer copy on write either. */
3960 SvREADONLY_off(after);
3962 /* We need to follow the pointers around the loop. */
3964 while ((next = SV_COW_NEXT_SV(current)) != sv) {
3967 /* don't loop forever if the structure is bust, and we have
3968 a pointer into a closed loop. */
3969 assert (current != after);
3970 assert (SvPVX_const(current) == pvx);
3972 /* Make the SV before us point to the SV after us. */
3973 SV_COW_NEXT_SV_SET(current, after);
3976 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
3981 Perl_sv_release_IVX(pTHX_ register SV *sv)
3984 sv_force_normal_flags(sv, 0);
3990 =for apidoc sv_force_normal_flags
3992 Undo various types of fakery on an SV: if the PV is a shared string, make
3993 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3994 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3995 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3996 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3997 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3998 set to some other value.) In addition, the C<flags> parameter gets passed to
3999 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4000 with flags set to 0.
4006 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4009 #ifdef PERL_OLD_COPY_ON_WRITE
4010 if (SvREADONLY(sv)) {
4011 /* At this point I believe I should acquire a global SV mutex. */
4013 const char * const pvx = SvPVX_const(sv);
4014 const STRLEN len = SvLEN(sv);
4015 const STRLEN cur = SvCUR(sv);
4016 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4018 PerlIO_printf(Perl_debug_log,
4019 "Copy on write: Force normal %ld\n",
4025 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4028 if (flags & SV_COW_DROP_PV) {
4029 /* OK, so we don't need to copy our buffer. */
4032 SvGROW(sv, cur + 1);
4033 Move(pvx,SvPVX(sv),cur,char);
4037 sv_release_COW(sv, pvx, len, next);
4042 else if (IN_PERL_RUNTIME)
4043 Perl_croak(aTHX_ PL_no_modify);
4044 /* At this point I believe that I can drop the global SV mutex. */
4047 if (SvREADONLY(sv)) {
4049 const char * const pvx = SvPVX_const(sv);
4050 const STRLEN len = SvCUR(sv);
4055 SvGROW(sv, len + 1);
4056 Move(pvx,SvPVX(sv),len,char);
4058 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4060 else if (IN_PERL_RUNTIME)
4061 Perl_croak(aTHX_ PL_no_modify);
4065 sv_unref_flags(sv, flags);
4066 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4073 Efficient removal of characters from the beginning of the string buffer.
4074 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4075 the string buffer. The C<ptr> becomes the first character of the adjusted
4076 string. Uses the "OOK hack".
4077 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4078 refer to the same chunk of data.
4084 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4086 register STRLEN delta;
4087 if (!ptr || !SvPOKp(sv))
4089 delta = ptr - SvPVX_const(sv);
4090 SV_CHECK_THINKFIRST(sv);
4091 if (SvTYPE(sv) < SVt_PVIV)
4092 sv_upgrade(sv,SVt_PVIV);
4095 if (!SvLEN(sv)) { /* make copy of shared string */
4096 const char *pvx = SvPVX_const(sv);
4097 const STRLEN len = SvCUR(sv);
4098 SvGROW(sv, len + 1);
4099 Move(pvx,SvPVX(sv),len,char);
4103 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4104 and we do that anyway inside the SvNIOK_off
4106 SvFLAGS(sv) |= SVf_OOK;
4109 SvLEN_set(sv, SvLEN(sv) - delta);
4110 SvCUR_set(sv, SvCUR(sv) - delta);
4111 SvPV_set(sv, SvPVX(sv) + delta);
4112 SvIV_set(sv, SvIVX(sv) + delta);
4116 =for apidoc sv_catpvn
4118 Concatenates the string onto the end of the string which is in the SV. The
4119 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4120 status set, then the bytes appended should be valid UTF-8.
4121 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4123 =for apidoc sv_catpvn_flags
4125 Concatenates the string onto the end of the string which is in the SV. The
4126 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4127 status set, then the bytes appended should be valid UTF-8.
4128 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4129 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4130 in terms of this function.
4136 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4140 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4142 SvGROW(dsv, dlen + slen + 1);
4144 sstr = SvPVX_const(dsv);
4145 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4146 SvCUR_set(dsv, SvCUR(dsv) + slen);
4148 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4150 if (flags & SV_SMAGIC)
4155 =for apidoc sv_catsv
4157 Concatenates the string from SV C<ssv> onto the end of the string in
4158 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4159 not 'set' magic. See C<sv_catsv_mg>.
4161 =for apidoc sv_catsv_flags
4163 Concatenates the string from SV C<ssv> onto the end of the string in
4164 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4165 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4166 and C<sv_catsv_nomg> are implemented in terms of this function.
4171 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4176 const char *spv = SvPV_const(ssv, slen);
4178 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4179 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4180 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4181 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4182 dsv->sv_flags doesn't have that bit set.
4183 Andy Dougherty 12 Oct 2001
4185 const I32 sutf8 = DO_UTF8(ssv);
4188 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4190 dutf8 = DO_UTF8(dsv);
4192 if (dutf8 != sutf8) {
4194 /* Not modifying source SV, so taking a temporary copy. */
4195 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4197 sv_utf8_upgrade(csv);
4198 spv = SvPV_const(csv, slen);
4201 sv_utf8_upgrade_nomg(dsv);
4203 sv_catpvn_nomg(dsv, spv, slen);
4206 if (flags & SV_SMAGIC)
4211 =for apidoc sv_catpv
4213 Concatenates the string onto the end of the string which is in the SV.
4214 If the SV has the UTF-8 status set, then the bytes appended should be
4215 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4220 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4223 register STRLEN len;
4229 junk = SvPV_force(sv, tlen);
4231 SvGROW(sv, tlen + len + 1);
4233 ptr = SvPVX_const(sv);
4234 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4235 SvCUR_set(sv, SvCUR(sv) + len);
4236 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4241 =for apidoc sv_catpv_mg
4243 Like C<sv_catpv>, but also handles 'set' magic.
4249 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4258 Creates a new SV. A non-zero C<len> parameter indicates the number of
4259 bytes of preallocated string space the SV should have. An extra byte for a
4260 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4261 space is allocated.) The reference count for the new SV is set to 1.
4263 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4264 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4265 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4266 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4267 modules supporting older perls.
4273 Perl_newSV(pTHX_ STRLEN len)
4280 sv_upgrade(sv, SVt_PV);
4281 SvGROW(sv, len + 1);
4286 =for apidoc sv_magicext
4288 Adds magic to an SV, upgrading it if necessary. Applies the
4289 supplied vtable and returns a pointer to the magic added.
4291 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4292 In particular, you can add magic to SvREADONLY SVs, and add more than
4293 one instance of the same 'how'.
4295 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4296 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4297 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4298 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4300 (This is now used as a subroutine by C<sv_magic>.)
4305 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4306 const char* name, I32 namlen)
4311 if (SvTYPE(sv) < SVt_PVMG) {
4312 SvUPGRADE(sv, SVt_PVMG);
4314 Newxz(mg, 1, MAGIC);
4315 mg->mg_moremagic = SvMAGIC(sv);
4316 SvMAGIC_set(sv, mg);
4318 /* Sometimes a magic contains a reference loop, where the sv and
4319 object refer to each other. To prevent a reference loop that
4320 would prevent such objects being freed, we look for such loops
4321 and if we find one we avoid incrementing the object refcount.
4323 Note we cannot do this to avoid self-tie loops as intervening RV must
4324 have its REFCNT incremented to keep it in existence.
4327 if (!obj || obj == sv ||
4328 how == PERL_MAGIC_arylen ||
4329 how == PERL_MAGIC_qr ||
4330 how == PERL_MAGIC_symtab ||
4331 (SvTYPE(obj) == SVt_PVGV &&
4332 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4333 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4334 GvFORM(obj) == (CV*)sv)))
4339 mg->mg_obj = SvREFCNT_inc_simple(obj);
4340 mg->mg_flags |= MGf_REFCOUNTED;
4343 /* Normal self-ties simply pass a null object, and instead of
4344 using mg_obj directly, use the SvTIED_obj macro to produce a
4345 new RV as needed. For glob "self-ties", we are tieing the PVIO
4346 with an RV obj pointing to the glob containing the PVIO. In
4347 this case, to avoid a reference loop, we need to weaken the
4351 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4352 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4358 mg->mg_len = namlen;
4361 mg->mg_ptr = savepvn(name, namlen);
4362 else if (namlen == HEf_SVKEY)
4363 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4365 mg->mg_ptr = (char *) name;
4367 mg->mg_virtual = vtable;
4371 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4376 =for apidoc sv_magic
4378 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4379 then adds a new magic item of type C<how> to the head of the magic list.
4381 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4382 handling of the C<name> and C<namlen> arguments.
4384 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4385 to add more than one instance of the same 'how'.
4391 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4397 #ifdef PERL_OLD_COPY_ON_WRITE
4399 sv_force_normal_flags(sv, 0);
4401 if (SvREADONLY(sv)) {
4403 /* its okay to attach magic to shared strings; the subsequent
4404 * upgrade to PVMG will unshare the string */
4405 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4408 && how != PERL_MAGIC_regex_global
4409 && how != PERL_MAGIC_bm
4410 && how != PERL_MAGIC_fm
4411 && how != PERL_MAGIC_sv
4412 && how != PERL_MAGIC_backref
4415 Perl_croak(aTHX_ PL_no_modify);
4418 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4419 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4420 /* sv_magic() refuses to add a magic of the same 'how' as an
4423 if (how == PERL_MAGIC_taint) {
4425 /* Any scalar which already had taint magic on which someone
4426 (erroneously?) did SvIOK_on() or similar will now be
4427 incorrectly sporting public "OK" flags. */
4428 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4436 vtable = &PL_vtbl_sv;
4438 case PERL_MAGIC_overload:
4439 vtable = &PL_vtbl_amagic;
4441 case PERL_MAGIC_overload_elem:
4442 vtable = &PL_vtbl_amagicelem;
4444 case PERL_MAGIC_overload_table:
4445 vtable = &PL_vtbl_ovrld;
4448 vtable = &PL_vtbl_bm;
4450 case PERL_MAGIC_regdata:
4451 vtable = &PL_vtbl_regdata;
4453 case PERL_MAGIC_regdatum:
4454 vtable = &PL_vtbl_regdatum;
4456 case PERL_MAGIC_env:
4457 vtable = &PL_vtbl_env;
4460 vtable = &PL_vtbl_fm;
4462 case PERL_MAGIC_envelem:
4463 vtable = &PL_vtbl_envelem;
4465 case PERL_MAGIC_regex_global:
4466 vtable = &PL_vtbl_mglob;
4468 case PERL_MAGIC_isa:
4469 vtable = &PL_vtbl_isa;
4471 case PERL_MAGIC_isaelem:
4472 vtable = &PL_vtbl_isaelem;
4474 case PERL_MAGIC_nkeys:
4475 vtable = &PL_vtbl_nkeys;
4477 case PERL_MAGIC_dbfile:
4480 case PERL_MAGIC_dbline:
4481 vtable = &PL_vtbl_dbline;
4483 #ifdef USE_LOCALE_COLLATE
4484 case PERL_MAGIC_collxfrm:
4485 vtable = &PL_vtbl_collxfrm;
4487 #endif /* USE_LOCALE_COLLATE */
4488 case PERL_MAGIC_tied:
4489 vtable = &PL_vtbl_pack;
4491 case PERL_MAGIC_tiedelem:
4492 case PERL_MAGIC_tiedscalar:
4493 vtable = &PL_vtbl_packelem;
4496 vtable = &PL_vtbl_regexp;
4498 case PERL_MAGIC_hints:
4499 /* As this vtable is all NULL, we can reuse it. */
4500 case PERL_MAGIC_sig:
4501 vtable = &PL_vtbl_sig;
4503 case PERL_MAGIC_sigelem:
4504 vtable = &PL_vtbl_sigelem;
4506 case PERL_MAGIC_taint:
4507 vtable = &PL_vtbl_taint;
4509 case PERL_MAGIC_uvar:
4510 vtable = &PL_vtbl_uvar;
4512 case PERL_MAGIC_vec:
4513 vtable = &PL_vtbl_vec;
4515 case PERL_MAGIC_arylen_p:
4516 case PERL_MAGIC_rhash:
4517 case PERL_MAGIC_symtab:
4518 case PERL_MAGIC_vstring:
4521 case PERL_MAGIC_utf8:
4522 vtable = &PL_vtbl_utf8;
4524 case PERL_MAGIC_substr:
4525 vtable = &PL_vtbl_substr;
4527 case PERL_MAGIC_defelem:
4528 vtable = &PL_vtbl_defelem;
4530 case PERL_MAGIC_arylen:
4531 vtable = &PL_vtbl_arylen;
4533 case PERL_MAGIC_pos:
4534 vtable = &PL_vtbl_pos;
4536 case PERL_MAGIC_backref:
4537 vtable = &PL_vtbl_backref;
4539 case PERL_MAGIC_hintselem:
4540 vtable = &PL_vtbl_hintselem;
4542 case PERL_MAGIC_ext:
4543 /* Reserved for use by extensions not perl internals. */
4544 /* Useful for attaching extension internal data to perl vars. */
4545 /* Note that multiple extensions may clash if magical scalars */
4546 /* etc holding private data from one are passed to another. */
4550 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4553 /* Rest of work is done else where */
4554 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4557 case PERL_MAGIC_taint:
4560 case PERL_MAGIC_ext:
4561 case PERL_MAGIC_dbfile:
4568 =for apidoc sv_unmagic
4570 Removes all magic of type C<type> from an SV.
4576 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4580 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4582 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4583 for (mg = *mgp; mg; mg = *mgp) {
4584 if (mg->mg_type == type) {
4585 const MGVTBL* const vtbl = mg->mg_virtual;
4586 *mgp = mg->mg_moremagic;
4587 if (vtbl && vtbl->svt_free)
4588 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4589 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4591 Safefree(mg->mg_ptr);
4592 else if (mg->mg_len == HEf_SVKEY)
4593 SvREFCNT_dec((SV*)mg->mg_ptr);
4594 else if (mg->mg_type == PERL_MAGIC_utf8)
4595 Safefree(mg->mg_ptr);
4597 if (mg->mg_flags & MGf_REFCOUNTED)
4598 SvREFCNT_dec(mg->mg_obj);
4602 mgp = &mg->mg_moremagic;
4606 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4607 SvMAGIC_set(sv, NULL);
4614 =for apidoc sv_rvweaken
4616 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4617 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4618 push a back-reference to this RV onto the array of backreferences
4619 associated with that magic.
4625 Perl_sv_rvweaken(pTHX_ SV *sv)
4628 if (!SvOK(sv)) /* let undefs pass */
4631 Perl_croak(aTHX_ "Can't weaken a nonreference");
4632 else if (SvWEAKREF(sv)) {
4633 if (ckWARN(WARN_MISC))
4634 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4638 Perl_sv_add_backref(aTHX_ tsv, sv);
4644 /* Give tsv backref magic if it hasn't already got it, then push a
4645 * back-reference to sv onto the array associated with the backref magic.
4649 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4654 if (SvTYPE(tsv) == SVt_PVHV) {
4655 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4659 /* There is no AV in the offical place - try a fixup. */
4660 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4663 /* Aha. They've got it stowed in magic. Bring it back. */
4664 av = (AV*)mg->mg_obj;
4665 /* Stop mg_free decreasing the refernce count. */
4667 /* Stop mg_free even calling the destructor, given that
4668 there's no AV to free up. */
4670 sv_unmagic(tsv, PERL_MAGIC_backref);
4674 SvREFCNT_inc_simple_void(av);
4679 const MAGIC *const mg
4680 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4682 av = (AV*)mg->mg_obj;
4686 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4687 /* av now has a refcnt of 2, which avoids it getting freed
4688 * before us during global cleanup. The extra ref is removed
4689 * by magic_killbackrefs() when tsv is being freed */
4692 if (AvFILLp(av) >= AvMAX(av)) {
4693 av_extend(av, AvFILLp(av)+1);
4695 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4698 /* delete a back-reference to ourselves from the backref magic associated
4699 * with the SV we point to.
4703 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4710 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4711 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4712 /* We mustn't attempt to "fix up" the hash here by moving the
4713 backreference array back to the hv_aux structure, as that is stored
4714 in the main HvARRAY(), and hfreentries assumes that no-one
4715 reallocates HvARRAY() while it is running. */
4718 const MAGIC *const mg
4719 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4721 av = (AV *)mg->mg_obj;
4724 if (PL_in_clean_all)
4726 Perl_croak(aTHX_ "panic: del_backref");
4733 /* We shouldn't be in here more than once, but for paranoia reasons lets
4735 for (i = AvFILLp(av); i >= 0; i--) {
4737 const SSize_t fill = AvFILLp(av);
4739 /* We weren't the last entry.
4740 An unordered list has this property that you can take the
4741 last element off the end to fill the hole, and it's still
4742 an unordered list :-)
4747 AvFILLp(av) = fill - 1;
4753 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4755 SV **svp = AvARRAY(av);
4757 PERL_UNUSED_ARG(sv);
4759 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4760 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4761 if (svp && !SvIS_FREED(av)) {
4762 SV *const *const last = svp + AvFILLp(av);
4764 while (svp <= last) {
4766 SV *const referrer = *svp;
4767 if (SvWEAKREF(referrer)) {
4768 /* XXX Should we check that it hasn't changed? */
4769 SvRV_set(referrer, 0);
4771 SvWEAKREF_off(referrer);
4772 } else if (SvTYPE(referrer) == SVt_PVGV ||
4773 SvTYPE(referrer) == SVt_PVLV) {
4774 /* You lookin' at me? */
4775 assert(GvSTASH(referrer));
4776 assert(GvSTASH(referrer) == (HV*)sv);
4777 GvSTASH(referrer) = 0;
4780 "panic: magic_killbackrefs (flags=%"UVxf")",
4781 (UV)SvFLAGS(referrer));
4789 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4794 =for apidoc sv_insert
4796 Inserts a string at the specified offset/length within the SV. Similar to
4797 the Perl substr() function.
4803 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4808 register char *midend;
4809 register char *bigend;
4815 Perl_croak(aTHX_ "Can't modify non-existent substring");
4816 SvPV_force(bigstr, curlen);
4817 (void)SvPOK_only_UTF8(bigstr);
4818 if (offset + len > curlen) {
4819 SvGROW(bigstr, offset+len+1);
4820 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4821 SvCUR_set(bigstr, offset+len);
4825 i = littlelen - len;
4826 if (i > 0) { /* string might grow */
4827 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4828 mid = big + offset + len;
4829 midend = bigend = big + SvCUR(bigstr);
4832 while (midend > mid) /* shove everything down */
4833 *--bigend = *--midend;
4834 Move(little,big+offset,littlelen,char);
4835 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4840 Move(little,SvPVX(bigstr)+offset,len,char);
4845 big = SvPVX(bigstr);
4848 bigend = big + SvCUR(bigstr);
4850 if (midend > bigend)
4851 Perl_croak(aTHX_ "panic: sv_insert");
4853 if (mid - big > bigend - midend) { /* faster to shorten from end */
4855 Move(little, mid, littlelen,char);
4858 i = bigend - midend;
4860 Move(midend, mid, i,char);
4864 SvCUR_set(bigstr, mid - big);
4866 else if ((i = mid - big)) { /* faster from front */
4867 midend -= littlelen;
4869 sv_chop(bigstr,midend-i);
4874 Move(little, mid, littlelen,char);
4876 else if (littlelen) {
4877 midend -= littlelen;
4878 sv_chop(bigstr,midend);
4879 Move(little,midend,littlelen,char);
4882 sv_chop(bigstr,midend);
4888 =for apidoc sv_replace
4890 Make the first argument a copy of the second, then delete the original.
4891 The target SV physically takes over ownership of the body of the source SV
4892 and inherits its flags; however, the target keeps any magic it owns,
4893 and any magic in the source is discarded.
4894 Note that this is a rather specialist SV copying operation; most of the
4895 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4901 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4904 const U32 refcnt = SvREFCNT(sv);
4905 SV_CHECK_THINKFIRST_COW_DROP(sv);
4906 if (SvREFCNT(nsv) != 1) {
4907 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4908 UVuf " != 1)", (UV) SvREFCNT(nsv));
4910 if (SvMAGICAL(sv)) {
4914 sv_upgrade(nsv, SVt_PVMG);
4915 SvMAGIC_set(nsv, SvMAGIC(sv));
4916 SvFLAGS(nsv) |= SvMAGICAL(sv);
4918 SvMAGIC_set(sv, NULL);
4922 assert(!SvREFCNT(sv));
4923 #ifdef DEBUG_LEAKING_SCALARS
4924 sv->sv_flags = nsv->sv_flags;
4925 sv->sv_any = nsv->sv_any;
4926 sv->sv_refcnt = nsv->sv_refcnt;
4927 sv->sv_u = nsv->sv_u;
4929 StructCopy(nsv,sv,SV);
4931 /* Currently could join these into one piece of pointer arithmetic, but
4932 it would be unclear. */
4933 if(SvTYPE(sv) == SVt_IV)
4935 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4936 else if (SvTYPE(sv) == SVt_RV) {
4937 SvANY(sv) = &sv->sv_u.svu_rv;
4941 #ifdef PERL_OLD_COPY_ON_WRITE
4942 if (SvIsCOW_normal(nsv)) {
4943 /* We need to follow the pointers around the loop to make the
4944 previous SV point to sv, rather than nsv. */
4947 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4950 assert(SvPVX_const(current) == SvPVX_const(nsv));
4952 /* Make the SV before us point to the SV after us. */
4954 PerlIO_printf(Perl_debug_log, "previous is\n");
4956 PerlIO_printf(Perl_debug_log,
4957 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
4958 (UV) SV_COW_NEXT_SV(current), (UV) sv);
4960 SV_COW_NEXT_SV_SET(current, sv);
4963 SvREFCNT(sv) = refcnt;
4964 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
4970 =for apidoc sv_clear
4972 Clear an SV: call any destructors, free up any memory used by the body,
4973 and free the body itself. The SV's head is I<not> freed, although
4974 its type is set to all 1's so that it won't inadvertently be assumed
4975 to be live during global destruction etc.
4976 This function should only be called when REFCNT is zero. Most of the time
4977 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
4984 Perl_sv_clear(pTHX_ register SV *sv)
4987 const U32 type = SvTYPE(sv);
4988 const struct body_details *const sv_type_details
4989 = bodies_by_type + type;
4992 assert(SvREFCNT(sv) == 0);
4994 if (type <= SVt_IV) {
4995 /* See the comment in sv.h about the collusion between this early
4996 return and the overloading of the NULL and IV slots in the size
5002 if (PL_defstash) { /* Still have a symbol table? */
5007 stash = SvSTASH(sv);
5008 destructor = StashHANDLER(stash,DESTROY);
5010 SV* const tmpref = newRV(sv);
5011 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5013 PUSHSTACKi(PERLSI_DESTROY);
5018 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5024 if(SvREFCNT(tmpref) < 2) {
5025 /* tmpref is not kept alive! */
5027 SvRV_set(tmpref, NULL);
5030 SvREFCNT_dec(tmpref);
5032 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5036 if (PL_in_clean_objs)
5037 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5039 /* DESTROY gave object new lease on life */
5045 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5046 SvOBJECT_off(sv); /* Curse the object. */
5047 if (type != SVt_PVIO)
5048 --PL_sv_objcount; /* XXX Might want something more general */
5051 if (type >= SVt_PVMG) {
5053 if ((type == SVt_PVMG || type == SVt_PVGV) &&
5054 (ourstash = OURSTASH(sv))) {
5055 SvREFCNT_dec(ourstash);
5056 } else if (SvMAGIC(sv))
5058 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5059 SvREFCNT_dec(SvSTASH(sv));
5064 IoIFP(sv) != PerlIO_stdin() &&
5065 IoIFP(sv) != PerlIO_stdout() &&
5066 IoIFP(sv) != PerlIO_stderr())
5068 io_close((IO*)sv, FALSE);
5070 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5071 PerlDir_close(IoDIRP(sv));
5072 IoDIRP(sv) = (DIR*)NULL;
5073 Safefree(IoTOP_NAME(sv));
5074 Safefree(IoFMT_NAME(sv));
5075 Safefree(IoBOTTOM_NAME(sv));
5084 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5091 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5092 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5093 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5094 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5096 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5097 SvREFCNT_dec(LvTARG(sv));
5101 if (GvNAME_HEK(sv)) {
5102 unshare_hek(GvNAME_HEK(sv));
5104 /* If we're in a stash, we don't own a reference to it. However it does
5105 have a back reference to us, which needs to be cleared. */
5107 sv_del_backref((SV*)GvSTASH(sv), sv);
5112 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5114 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5115 /* Don't even bother with turning off the OOK flag. */
5120 SV * const target = SvRV(sv);
5122 sv_del_backref(target, sv);
5124 SvREFCNT_dec(target);
5126 #ifdef PERL_OLD_COPY_ON_WRITE
5127 else if (SvPVX_const(sv)) {
5129 /* I believe I need to grab the global SV mutex here and
5130 then recheck the COW status. */
5132 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5135 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5136 SV_COW_NEXT_SV(sv));
5137 /* And drop it here. */
5139 } else if (SvLEN(sv)) {
5140 Safefree(SvPVX_const(sv));
5144 else if (SvPVX_const(sv) && SvLEN(sv))
5145 Safefree(SvPVX_mutable(sv));
5146 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5147 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5156 SvFLAGS(sv) &= SVf_BREAK;
5157 SvFLAGS(sv) |= SVTYPEMASK;
5159 if (sv_type_details->arena) {
5160 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5161 &PL_body_roots[type]);
5163 else if (sv_type_details->body_size) {
5164 my_safefree(SvANY(sv));
5169 =for apidoc sv_newref
5171 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5178 Perl_sv_newref(pTHX_ SV *sv)
5180 PERL_UNUSED_CONTEXT;
5189 Decrement an SV's reference count, and if it drops to zero, call
5190 C<sv_clear> to invoke destructors and free up any memory used by
5191 the body; finally, deallocate the SV's head itself.
5192 Normally called via a wrapper macro C<SvREFCNT_dec>.
5198 Perl_sv_free(pTHX_ SV *sv)
5203 if (SvREFCNT(sv) == 0) {
5204 if (SvFLAGS(sv) & SVf_BREAK)
5205 /* this SV's refcnt has been artificially decremented to
5206 * trigger cleanup */
5208 if (PL_in_clean_all) /* All is fair */
5210 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5211 /* make sure SvREFCNT(sv)==0 happens very seldom */
5212 SvREFCNT(sv) = (~(U32)0)/2;
5215 if (ckWARN_d(WARN_INTERNAL)) {
5216 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5217 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5218 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5219 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5220 Perl_dump_sv_child(aTHX_ sv);
5225 if (--(SvREFCNT(sv)) > 0)
5227 Perl_sv_free2(aTHX_ sv);
5231 Perl_sv_free2(pTHX_ SV *sv)
5236 if (ckWARN_d(WARN_DEBUGGING))
5237 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5238 "Attempt to free temp prematurely: SV 0x%"UVxf
5239 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5243 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5244 /* make sure SvREFCNT(sv)==0 happens very seldom */
5245 SvREFCNT(sv) = (~(U32)0)/2;
5256 Returns the length of the string in the SV. Handles magic and type
5257 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5263 Perl_sv_len(pTHX_ register SV *sv)
5271 len = mg_length(sv);
5273 (void)SvPV_const(sv, len);
5278 =for apidoc sv_len_utf8
5280 Returns the number of characters in the string in an SV, counting wide
5281 UTF-8 bytes as a single character. Handles magic and type coercion.
5287 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5288 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5289 * (Note that the mg_len is not the length of the mg_ptr field.
5290 * This allows the cache to store the character length of the string without
5291 * needing to malloc() extra storage to attach to the mg_ptr.)
5296 Perl_sv_len_utf8(pTHX_ register SV *sv)
5302 return mg_length(sv);
5306 const U8 *s = (U8*)SvPV_const(sv, len);
5310 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5312 if (mg && mg->mg_len != -1) {
5314 if (PL_utf8cache < 0) {
5315 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5317 /* Need to turn the assertions off otherwise we may
5318 recurse infinitely while printing error messages.
5320 SAVEI8(PL_utf8cache);
5322 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVf
5323 " real %"UVf" for %"SVf,
5324 (UV) ulen, (UV) real, sv);
5329 ulen = Perl_utf8_length(aTHX_ s, s + len);
5330 if (!SvREADONLY(sv)) {
5332 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5333 &PL_vtbl_utf8, 0, 0);
5341 return Perl_utf8_length(aTHX_ s, s + len);
5345 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5348 S_sv_pos_u2b_forwards(pTHX_ const U8 *const start, const U8 *const send,
5351 const U8 *s = start;
5353 PERL_UNUSED_CONTEXT;
5355 while (s < send && uoffset--)
5358 /* This is the existing behaviour. Possibly it should be a croak, as
5359 it's actually a bounds error */
5365 /* Given the length of the string in both bytes and UTF-8 characters, decide
5366 whether to walk forwards or backwards to find the byte corresponding to
5367 the passed in UTF-8 offset. */
5369 S_sv_pos_u2b_midway(pTHX_ const U8 *const start, const U8 *send,
5370 STRLEN uoffset, STRLEN uend)
5372 STRLEN backw = uend - uoffset;
5373 if (uoffset < 2 * backw) {
5374 /* The assumption is that going forwards is twice the speed of going
5375 forward (that's where the 2 * backw comes from).
5376 (The real figure of course depends on the UTF-8 data.) */
5377 return S_sv_pos_u2b_forwards(aTHX_ start, send, uoffset);
5382 while (UTF8_IS_CONTINUATION(*send))
5385 return send - start;
5388 /* For the string representation of the given scalar, find the byte
5389 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5390 give another position in the string, *before* the sought offset, which
5391 (which is always true, as 0, 0 is a valid pair of positions), which should
5392 help reduce the amount of linear searching.
5393 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5394 will be used to reduce the amount of linear searching. The cache will be
5395 created if necessary, and the found value offered to it for update. */
5397 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5398 const U8 *const send, STRLEN uoffset,
5399 STRLEN uoffset0, STRLEN boffset0) {
5400 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5403 assert (uoffset >= uoffset0);
5405 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5406 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5407 if ((*mgp)->mg_ptr) {
5408 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5409 if (cache[0] == uoffset) {
5410 /* An exact match. */
5413 if (cache[2] == uoffset) {
5414 /* An exact match. */
5418 if (cache[0] < uoffset) {
5419 /* The cache already knows part of the way. */
5420 if (cache[0] > uoffset0) {
5421 /* The cache knows more than the passed in pair */
5422 uoffset0 = cache[0];
5423 boffset0 = cache[1];
5425 if ((*mgp)->mg_len != -1) {
5426 /* And we know the end too. */
5428 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5430 (*mgp)->mg_len - uoffset0);
5433 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5434 send, uoffset - uoffset0);
5437 else if (cache[2] < uoffset) {
5438 /* We're between the two cache entries. */
5439 if (cache[2] > uoffset0) {
5440 /* and the cache knows more than the passed in pair */
5441 uoffset0 = cache[2];
5442 boffset0 = cache[3];
5446 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5449 cache[0] - uoffset0);
5452 + S_sv_pos_u2b_midway(aTHX_ start + boffset0,
5455 cache[2] - uoffset0);
5459 else if ((*mgp)->mg_len != -1) {
5460 /* If we can take advantage of a passed in offset, do so. */
5461 /* In fact, offset0 is either 0, or less than offset, so don't
5462 need to worry about the other possibility. */
5464 + S_sv_pos_u2b_midway(aTHX_ start + boffset0, send,
5466 (*mgp)->mg_len - uoffset0);
5471 if (!found || PL_utf8cache < 0) {
5472 const STRLEN real_boffset
5473 = boffset0 + S_sv_pos_u2b_forwards(aTHX_ start + boffset0,
5474 send, uoffset - uoffset0);
5476 if (found && PL_utf8cache < 0) {
5477 if (real_boffset != boffset) {
5478 /* Need to turn the assertions off otherwise we may recurse
5479 infinitely while printing error messages. */
5480 SAVEI8(PL_utf8cache);
5482 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVf
5483 " real %"UVf" for %"SVf,
5484 (UV) boffset, (UV) real_boffset, sv);
5487 boffset = real_boffset;
5490 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5496 =for apidoc sv_pos_u2b
5498 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5499 the start of the string, to a count of the equivalent number of bytes; if
5500 lenp is non-zero, it does the same to lenp, but this time starting from
5501 the offset, rather than from the start of the string. Handles magic and
5508 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5509 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5510 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5515 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5523 start = (U8*)SvPV_const(sv, len);
5525 STRLEN uoffset = (STRLEN) *offsetp;
5526 const U8 * const send = start + len;
5528 STRLEN boffset = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send,
5531 *offsetp = (I32) boffset;
5534 /* Convert the relative offset to absolute. */
5535 STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5537 = S_sv_pos_u2b_cached(aTHX_ sv, &mg, start, send, uoffset2,
5538 uoffset, boffset) - boffset;
5552 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5553 byte length pairing. The (byte) length of the total SV is passed in too,
5554 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5555 may not have updated SvCUR, so we can't rely on reading it directly.
5557 The proffered utf8/byte length pairing isn't used if the cache already has
5558 two pairs, and swapping either for the proffered pair would increase the
5559 RMS of the intervals between known byte offsets.
5561 The cache itself consists of 4 STRLEN values
5562 0: larger UTF-8 offset
5563 1: corresponding byte offset
5564 2: smaller UTF-8 offset
5565 3: corresponding byte offset
5567 Unused cache pairs have the value 0, 0.
5568 Keeping the cache "backwards" means that the invariant of
5569 cache[0] >= cache[2] is maintained even with empty slots, which means that
5570 the code that uses it doesn't need to worry if only 1 entry has actually
5571 been set to non-zero. It also makes the "position beyond the end of the
5572 cache" logic much simpler, as the first slot is always the one to start
5576 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5584 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5586 (*mgp)->mg_len = -1;
5590 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5591 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5592 (*mgp)->mg_ptr = (char *) cache;
5596 if (PL_utf8cache < 0) {
5597 const U8 *start = (const U8 *) SvPVX_const(sv);
5598 const U8 *const end = start + byte;
5599 STRLEN realutf8 = 0;
5601 while (start < end) {
5602 start += UTF8SKIP(start);
5606 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5607 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5608 doesn't? I don't know whether this difference was introduced with
5609 the caching code in 5.8.1. */
5611 if (realutf8 != utf8) {
5612 /* Need to turn the assertions off otherwise we may recurse
5613 infinitely while printing error messages. */
5614 SAVEI8(PL_utf8cache);
5616 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVf
5617 " real %"UVf" for %"SVf, (UV) utf8, (UV) realutf8, sv);
5621 /* Cache is held with the later position first, to simplify the code
5622 that deals with unbounded ends. */
5624 ASSERT_UTF8_CACHE(cache);
5625 if (cache[1] == 0) {
5626 /* Cache is totally empty */
5629 } else if (cache[3] == 0) {
5630 if (byte > cache[1]) {
5631 /* New one is larger, so goes first. */
5632 cache[2] = cache[0];
5633 cache[3] = cache[1];
5641 #define THREEWAY_SQUARE(a,b,c,d) \
5642 ((float)((d) - (c))) * ((float)((d) - (c))) \
5643 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5644 + ((float)((b) - (a))) * ((float)((b) - (a)))
5646 /* Cache has 2 slots in use, and we know three potential pairs.
5647 Keep the two that give the lowest RMS distance. Do the
5648 calcualation in bytes simply because we always know the byte
5649 length. squareroot has the same ordering as the positive value,
5650 so don't bother with the actual square root. */
5651 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5652 if (byte > cache[1]) {
5653 /* New position is after the existing pair of pairs. */
5654 const float keep_earlier
5655 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5656 const float keep_later
5657 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5659 if (keep_later < keep_earlier) {
5660 if (keep_later < existing) {
5661 cache[2] = cache[0];
5662 cache[3] = cache[1];
5668 if (keep_earlier < existing) {
5674 else if (byte > cache[3]) {
5675 /* New position is between the existing pair of pairs. */
5676 const float keep_earlier
5677 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5678 const float keep_later
5679 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5681 if (keep_later < keep_earlier) {
5682 if (keep_later < existing) {
5688 if (keep_earlier < existing) {
5695 /* New position is before the existing pair of pairs. */
5696 const float keep_earlier
5697 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5698 const float keep_later
5699 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5701 if (keep_later < keep_earlier) {
5702 if (keep_later < existing) {
5708 if (keep_earlier < existing) {
5709 cache[0] = cache[2];
5710 cache[1] = cache[3];
5717 ASSERT_UTF8_CACHE(cache);
5720 /* If we don't know the character offset of the end of a region, our only
5721 option is to walk forwards to the target byte offset. */
5723 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5726 while (s < target) {
5729 /* Call utf8n_to_uvchr() to validate the sequence
5730 * (unless a simple non-UTF character) */
5731 if (!UTF8_IS_INVARIANT(*s))
5732 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5743 /* We already know all of the way, now we may be able to walk back. The same
5744 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5745 backward is half the speed of walking forward. */
5747 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5750 const STRLEN forw = target - s;
5751 STRLEN backw = end - target;
5753 if (forw < 2 * backw) {
5754 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5757 while (end > target) {
5759 while (UTF8_IS_CONTINUATION(*end)) {
5768 =for apidoc sv_pos_b2u
5770 Converts the value pointed to by offsetp from a count of bytes from the
5771 start of the string, to a count of the equivalent number of UTF-8 chars.
5772 Handles magic and type coercion.
5778 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5779 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5784 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5787 const STRLEN byte = *offsetp;
5788 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5797 s = (const U8*)SvPV_const(sv, blen);
5800 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5804 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5805 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5807 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5808 if (cache[1] == byte) {
5809 /* An exact match. */
5810 *offsetp = cache[0];
5813 if (cache[3] == byte) {
5814 /* An exact match. */
5815 *offsetp = cache[2];
5819 if (cache[1] < byte) {
5820 /* We already know part of the way. */
5821 if (mg->mg_len != -1) {
5822 /* Actually, we know the end too. */
5824 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5825 s + blen, mg->mg_len - cache[0]);
5828 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5831 else if (cache[3] < byte) {
5832 /* We're between the two cached pairs, so we do the calculation
5833 offset by the byte/utf-8 positions for the earlier pair,
5834 then add the utf-8 characters from the string start to
5836 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5837 s + cache[1], cache[0] - cache[2])
5841 else { /* cache[3] > byte */
5842 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5846 ASSERT_UTF8_CACHE(cache);
5848 } else if (mg->mg_len != -1) {
5849 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5853 if (!found || PL_utf8cache < 0) {
5854 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5856 if (found && PL_utf8cache < 0) {
5857 if (len != real_len) {
5858 /* Need to turn the assertions off otherwise we may recurse
5859 infinitely while printing error messages. */
5860 SAVEI8(PL_utf8cache);
5862 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVf
5863 " real %"UVf" for %"SVf,
5864 (UV) len, (UV) real_len, sv);
5871 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5877 Returns a boolean indicating whether the strings in the two SVs are
5878 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5879 coerce its args to strings if necessary.
5885 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5894 SV* svrecode = NULL;
5901 pv1 = SvPV_const(sv1, cur1);
5908 pv2 = SvPV_const(sv2, cur2);
5910 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5911 /* Differing utf8ness.
5912 * Do not UTF8size the comparands as a side-effect. */
5915 svrecode = newSVpvn(pv2, cur2);
5916 sv_recode_to_utf8(svrecode, PL_encoding);
5917 pv2 = SvPV_const(svrecode, cur2);
5920 svrecode = newSVpvn(pv1, cur1);
5921 sv_recode_to_utf8(svrecode, PL_encoding);
5922 pv1 = SvPV_const(svrecode, cur1);
5924 /* Now both are in UTF-8. */
5926 SvREFCNT_dec(svrecode);
5931 bool is_utf8 = TRUE;
5934 /* sv1 is the UTF-8 one,
5935 * if is equal it must be downgrade-able */
5936 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5942 /* sv2 is the UTF-8 one,
5943 * if is equal it must be downgrade-able */
5944 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5950 /* Downgrade not possible - cannot be eq */
5958 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5960 SvREFCNT_dec(svrecode);
5970 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5971 string in C<sv1> is less than, equal to, or greater than the string in
5972 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5973 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5979 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5983 const char *pv1, *pv2;
5986 SV *svrecode = NULL;
5993 pv1 = SvPV_const(sv1, cur1);
6000 pv2 = SvPV_const(sv2, cur2);
6002 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6003 /* Differing utf8ness.
6004 * Do not UTF8size the comparands as a side-effect. */
6007 svrecode = newSVpvn(pv2, cur2);
6008 sv_recode_to_utf8(svrecode, PL_encoding);
6009 pv2 = SvPV_const(svrecode, cur2);
6012 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6017 svrecode = newSVpvn(pv1, cur1);
6018 sv_recode_to_utf8(svrecode, PL_encoding);
6019 pv1 = SvPV_const(svrecode, cur1);
6022 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6028 cmp = cur2 ? -1 : 0;
6032 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6035 cmp = retval < 0 ? -1 : 1;
6036 } else if (cur1 == cur2) {
6039 cmp = cur1 < cur2 ? -1 : 1;
6043 SvREFCNT_dec(svrecode);
6051 =for apidoc sv_cmp_locale
6053 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6054 'use bytes' aware, handles get magic, and will coerce its args to strings
6055 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6061 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6064 #ifdef USE_LOCALE_COLLATE
6070 if (PL_collation_standard)
6074 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6076 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6078 if (!pv1 || !len1) {
6089 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6092 return retval < 0 ? -1 : 1;
6095 * When the result of collation is equality, that doesn't mean
6096 * that there are no differences -- some locales exclude some
6097 * characters from consideration. So to avoid false equalities,
6098 * we use the raw string as a tiebreaker.
6104 #endif /* USE_LOCALE_COLLATE */
6106 return sv_cmp(sv1, sv2);
6110 #ifdef USE_LOCALE_COLLATE
6113 =for apidoc sv_collxfrm
6115 Add Collate Transform magic to an SV if it doesn't already have it.
6117 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6118 scalar data of the variable, but transformed to such a format that a normal
6119 memory comparison can be used to compare the data according to the locale
6126 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6131 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6132 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6138 Safefree(mg->mg_ptr);
6139 s = SvPV_const(sv, len);
6140 if ((xf = mem_collxfrm(s, len, &xlen))) {
6141 if (SvREADONLY(sv)) {
6144 return xf + sizeof(PL_collation_ix);
6147 #ifdef PERL_OLD_COPY_ON_WRITE
6149 sv_force_normal_flags(sv, 0);
6151 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6165 if (mg && mg->mg_ptr) {
6167 return mg->mg_ptr + sizeof(PL_collation_ix);
6175 #endif /* USE_LOCALE_COLLATE */
6180 Get a line from the filehandle and store it into the SV, optionally
6181 appending to the currently-stored string.
6187 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6192 register STDCHAR rslast;
6193 register STDCHAR *bp;
6198 if (SvTHINKFIRST(sv))
6199 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6200 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6202 However, perlbench says it's slower, because the existing swipe code
6203 is faster than copy on write.
6204 Swings and roundabouts. */
6205 SvUPGRADE(sv, SVt_PV);
6210 if (PerlIO_isutf8(fp)) {
6212 sv_utf8_upgrade_nomg(sv);
6213 sv_pos_u2b(sv,&append,0);
6215 } else if (SvUTF8(sv)) {
6216 SV * const tsv = newSV(0);
6217 sv_gets(tsv, fp, 0);
6218 sv_utf8_upgrade_nomg(tsv);
6219 SvCUR_set(sv,append);
6222 goto return_string_or_null;
6227 if (PerlIO_isutf8(fp))
6230 if (IN_PERL_COMPILETIME) {
6231 /* we always read code in line mode */
6235 else if (RsSNARF(PL_rs)) {
6236 /* If it is a regular disk file use size from stat() as estimate
6237 of amount we are going to read -- may result in mallocing
6238 more memory than we really need if the layers below reduce
6239 the size we read (e.g. CRLF or a gzip layer).
6242 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6243 const Off_t offset = PerlIO_tell(fp);
6244 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6245 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6251 else if (RsRECORD(PL_rs)) {
6256 /* Grab the size of the record we're getting */
6257 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6258 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6261 /* VMS wants read instead of fread, because fread doesn't respect */
6262 /* RMS record boundaries. This is not necessarily a good thing to be */
6263 /* doing, but we've got no other real choice - except avoid stdio
6264 as implementation - perhaps write a :vms layer ?
6266 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6268 bytesread = PerlIO_read(fp, buffer, recsize);
6272 SvCUR_set(sv, bytesread += append);
6273 buffer[bytesread] = '\0';
6274 goto return_string_or_null;
6276 else if (RsPARA(PL_rs)) {
6282 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6283 if (PerlIO_isutf8(fp)) {
6284 rsptr = SvPVutf8(PL_rs, rslen);
6287 if (SvUTF8(PL_rs)) {
6288 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6289 Perl_croak(aTHX_ "Wide character in $/");
6292 rsptr = SvPV_const(PL_rs, rslen);
6296 rslast = rslen ? rsptr[rslen - 1] : '\0';
6298 if (rspara) { /* have to do this both before and after */
6299 do { /* to make sure file boundaries work right */
6302 i = PerlIO_getc(fp);
6306 PerlIO_ungetc(fp,i);
6312 /* See if we know enough about I/O mechanism to cheat it ! */
6314 /* This used to be #ifdef test - it is made run-time test for ease
6315 of abstracting out stdio interface. One call should be cheap
6316 enough here - and may even be a macro allowing compile
6320 if (PerlIO_fast_gets(fp)) {
6323 * We're going to steal some values from the stdio struct
6324 * and put EVERYTHING in the innermost loop into registers.
6326 register STDCHAR *ptr;
6330 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6331 /* An ungetc()d char is handled separately from the regular
6332 * buffer, so we getc() it back out and stuff it in the buffer.
6334 i = PerlIO_getc(fp);
6335 if (i == EOF) return 0;
6336 *(--((*fp)->_ptr)) = (unsigned char) i;
6340 /* Here is some breathtakingly efficient cheating */
6342 cnt = PerlIO_get_cnt(fp); /* get count into register */
6343 /* make sure we have the room */
6344 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6345 /* Not room for all of it
6346 if we are looking for a separator and room for some
6348 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6349 /* just process what we have room for */
6350 shortbuffered = cnt - SvLEN(sv) + append + 1;
6351 cnt -= shortbuffered;
6355 /* remember that cnt can be negative */
6356 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6361 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6362 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6363 DEBUG_P(PerlIO_printf(Perl_debug_log,
6364 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6365 DEBUG_P(PerlIO_printf(Perl_debug_log,
6366 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6367 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6368 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6373 while (cnt > 0) { /* this | eat */
6375 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6376 goto thats_all_folks; /* screams | sed :-) */
6380 Copy(ptr, bp, cnt, char); /* this | eat */
6381 bp += cnt; /* screams | dust */
6382 ptr += cnt; /* louder | sed :-) */
6387 if (shortbuffered) { /* oh well, must extend */
6388 cnt = shortbuffered;
6390 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6392 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6393 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6397 DEBUG_P(PerlIO_printf(Perl_debug_log,
6398 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6399 PTR2UV(ptr),(long)cnt));
6400 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6402 DEBUG_P(PerlIO_printf(Perl_debug_log,
6403 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6404 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6405 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6407 /* This used to call 'filbuf' in stdio form, but as that behaves like
6408 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6409 another abstraction. */
6410 i = PerlIO_getc(fp); /* get more characters */
6412 DEBUG_P(PerlIO_printf(Perl_debug_log,
6413 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6414 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6415 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6417 cnt = PerlIO_get_cnt(fp);
6418 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6419 DEBUG_P(PerlIO_printf(Perl_debug_log,
6420 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6422 if (i == EOF) /* all done for ever? */
6423 goto thats_really_all_folks;
6425 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6427 SvGROW(sv, bpx + cnt + 2);
6428 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6430 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6432 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6433 goto thats_all_folks;
6437 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6438 memNE((char*)bp - rslen, rsptr, rslen))
6439 goto screamer; /* go back to the fray */
6440 thats_really_all_folks:
6442 cnt += shortbuffered;
6443 DEBUG_P(PerlIO_printf(Perl_debug_log,
6444 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6445 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6446 DEBUG_P(PerlIO_printf(Perl_debug_log,
6447 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6448 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6449 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6451 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6452 DEBUG_P(PerlIO_printf(Perl_debug_log,
6453 "Screamer: done, len=%ld, string=|%.*s|\n",
6454 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6458 /*The big, slow, and stupid way. */
6459 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6460 STDCHAR *buf = NULL;
6461 Newx(buf, 8192, STDCHAR);
6469 register const STDCHAR * const bpe = buf + sizeof(buf);
6471 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6472 ; /* keep reading */
6476 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6477 /* Accomodate broken VAXC compiler, which applies U8 cast to
6478 * both args of ?: operator, causing EOF to change into 255
6481 i = (U8)buf[cnt - 1];
6487 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6489 sv_catpvn(sv, (char *) buf, cnt);
6491 sv_setpvn(sv, (char *) buf, cnt);
6493 if (i != EOF && /* joy */
6495 SvCUR(sv) < rslen ||
6496 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6500 * If we're reading from a TTY and we get a short read,
6501 * indicating that the user hit his EOF character, we need
6502 * to notice it now, because if we try to read from the TTY
6503 * again, the EOF condition will disappear.
6505 * The comparison of cnt to sizeof(buf) is an optimization
6506 * that prevents unnecessary calls to feof().
6510 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6514 #ifdef USE_HEAP_INSTEAD_OF_STACK
6519 if (rspara) { /* have to do this both before and after */
6520 while (i != EOF) { /* to make sure file boundaries work right */
6521 i = PerlIO_getc(fp);
6523 PerlIO_ungetc(fp,i);
6529 return_string_or_null:
6530 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6536 Auto-increment of the value in the SV, doing string to numeric conversion
6537 if necessary. Handles 'get' magic.
6543 Perl_sv_inc(pTHX_ register SV *sv)
6552 if (SvTHINKFIRST(sv)) {
6554 sv_force_normal_flags(sv, 0);
6555 if (SvREADONLY(sv)) {
6556 if (IN_PERL_RUNTIME)
6557 Perl_croak(aTHX_ PL_no_modify);
6561 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6563 i = PTR2IV(SvRV(sv));
6568 flags = SvFLAGS(sv);
6569 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6570 /* It's (privately or publicly) a float, but not tested as an
6571 integer, so test it to see. */
6573 flags = SvFLAGS(sv);
6575 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6576 /* It's publicly an integer, or privately an integer-not-float */
6577 #ifdef PERL_PRESERVE_IVUV
6581 if (SvUVX(sv) == UV_MAX)
6582 sv_setnv(sv, UV_MAX_P1);
6584 (void)SvIOK_only_UV(sv);
6585 SvUV_set(sv, SvUVX(sv) + 1);
6587 if (SvIVX(sv) == IV_MAX)
6588 sv_setuv(sv, (UV)IV_MAX + 1);
6590 (void)SvIOK_only(sv);
6591 SvIV_set(sv, SvIVX(sv) + 1);
6596 if (flags & SVp_NOK) {
6597 (void)SvNOK_only(sv);
6598 SvNV_set(sv, SvNVX(sv) + 1.0);
6602 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6603 if ((flags & SVTYPEMASK) < SVt_PVIV)
6604 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6605 (void)SvIOK_only(sv);
6610 while (isALPHA(*d)) d++;
6611 while (isDIGIT(*d)) d++;
6613 #ifdef PERL_PRESERVE_IVUV
6614 /* Got to punt this as an integer if needs be, but we don't issue
6615 warnings. Probably ought to make the sv_iv_please() that does
6616 the conversion if possible, and silently. */
6617 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6618 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6619 /* Need to try really hard to see if it's an integer.
6620 9.22337203685478e+18 is an integer.
6621 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6622 so $a="9.22337203685478e+18"; $a+0; $a++
6623 needs to be the same as $a="9.22337203685478e+18"; $a++
6630 /* sv_2iv *should* have made this an NV */
6631 if (flags & SVp_NOK) {
6632 (void)SvNOK_only(sv);
6633 SvNV_set(sv, SvNVX(sv) + 1.0);
6636 /* I don't think we can get here. Maybe I should assert this
6637 And if we do get here I suspect that sv_setnv will croak. NWC
6639 #if defined(USE_LONG_DOUBLE)
6640 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",
6641 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6643 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6644 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6647 #endif /* PERL_PRESERVE_IVUV */
6648 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6652 while (d >= SvPVX_const(sv)) {
6660 /* MKS: The original code here died if letters weren't consecutive.
6661 * at least it didn't have to worry about non-C locales. The
6662 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6663 * arranged in order (although not consecutively) and that only
6664 * [A-Za-z] are accepted by isALPHA in the C locale.
6666 if (*d != 'z' && *d != 'Z') {
6667 do { ++*d; } while (!isALPHA(*d));
6670 *(d--) -= 'z' - 'a';
6675 *(d--) -= 'z' - 'a' + 1;
6679 /* oh,oh, the number grew */
6680 SvGROW(sv, SvCUR(sv) + 2);
6681 SvCUR_set(sv, SvCUR(sv) + 1);
6682 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6693 Auto-decrement of the value in the SV, doing string to numeric conversion
6694 if necessary. Handles 'get' magic.
6700 Perl_sv_dec(pTHX_ register SV *sv)
6708 if (SvTHINKFIRST(sv)) {
6710 sv_force_normal_flags(sv, 0);
6711 if (SvREADONLY(sv)) {
6712 if (IN_PERL_RUNTIME)
6713 Perl_croak(aTHX_ PL_no_modify);
6717 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6719 i = PTR2IV(SvRV(sv));
6724 /* Unlike sv_inc we don't have to worry about string-never-numbers
6725 and keeping them magic. But we mustn't warn on punting */
6726 flags = SvFLAGS(sv);
6727 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6728 /* It's publicly an integer, or privately an integer-not-float */
6729 #ifdef PERL_PRESERVE_IVUV
6733 if (SvUVX(sv) == 0) {
6734 (void)SvIOK_only(sv);
6738 (void)SvIOK_only_UV(sv);
6739 SvUV_set(sv, SvUVX(sv) - 1);
6742 if (SvIVX(sv) == IV_MIN)
6743 sv_setnv(sv, (NV)IV_MIN - 1.0);
6745 (void)SvIOK_only(sv);
6746 SvIV_set(sv, SvIVX(sv) - 1);
6751 if (flags & SVp_NOK) {
6752 SvNV_set(sv, SvNVX(sv) - 1.0);
6753 (void)SvNOK_only(sv);
6756 if (!(flags & SVp_POK)) {
6757 if ((flags & SVTYPEMASK) < SVt_PVIV)
6758 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6760 (void)SvIOK_only(sv);
6763 #ifdef PERL_PRESERVE_IVUV
6765 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6766 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6767 /* Need to try really hard to see if it's an integer.
6768 9.22337203685478e+18 is an integer.
6769 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6770 so $a="9.22337203685478e+18"; $a+0; $a--
6771 needs to be the same as $a="9.22337203685478e+18"; $a--
6778 /* sv_2iv *should* have made this an NV */
6779 if (flags & SVp_NOK) {
6780 (void)SvNOK_only(sv);
6781 SvNV_set(sv, SvNVX(sv) - 1.0);
6784 /* I don't think we can get here. Maybe I should assert this
6785 And if we do get here I suspect that sv_setnv will croak. NWC
6787 #if defined(USE_LONG_DOUBLE)
6788 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",
6789 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6791 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6792 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6796 #endif /* PERL_PRESERVE_IVUV */
6797 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6801 =for apidoc sv_mortalcopy
6803 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6804 The new SV is marked as mortal. It will be destroyed "soon", either by an
6805 explicit call to FREETMPS, or by an implicit call at places such as
6806 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6811 /* Make a string that will exist for the duration of the expression
6812 * evaluation. Actually, it may have to last longer than that, but
6813 * hopefully we won't free it until it has been assigned to a
6814 * permanent location. */
6817 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6823 sv_setsv(sv,oldstr);
6825 PL_tmps_stack[++PL_tmps_ix] = sv;
6831 =for apidoc sv_newmortal
6833 Creates a new null SV which is mortal. The reference count of the SV is
6834 set to 1. It will be destroyed "soon", either by an explicit call to
6835 FREETMPS, or by an implicit call at places such as statement boundaries.
6836 See also C<sv_mortalcopy> and C<sv_2mortal>.
6842 Perl_sv_newmortal(pTHX)
6848 SvFLAGS(sv) = SVs_TEMP;
6850 PL_tmps_stack[++PL_tmps_ix] = sv;
6855 =for apidoc sv_2mortal
6857 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6858 by an explicit call to FREETMPS, or by an implicit call at places such as
6859 statement boundaries. SvTEMP() is turned on which means that the SV's
6860 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6861 and C<sv_mortalcopy>.
6867 Perl_sv_2mortal(pTHX_ register SV *sv)
6872 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6875 PL_tmps_stack[++PL_tmps_ix] = sv;
6883 Creates a new SV and copies a string into it. The reference count for the
6884 SV is set to 1. If C<len> is zero, Perl will compute the length using
6885 strlen(). For efficiency, consider using C<newSVpvn> instead.
6891 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6897 sv_setpvn(sv,s,len ? len : strlen(s));
6902 =for apidoc newSVpvn
6904 Creates a new SV and copies a string into it. The reference count for the
6905 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6906 string. You are responsible for ensuring that the source string is at least
6907 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6913 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6919 sv_setpvn(sv,s,len);
6925 =for apidoc newSVhek
6927 Creates a new SV from the hash key structure. It will generate scalars that
6928 point to the shared string table where possible. Returns a new (undefined)
6929 SV if the hek is NULL.
6935 Perl_newSVhek(pTHX_ const HEK *hek)
6945 if (HEK_LEN(hek) == HEf_SVKEY) {
6946 return newSVsv(*(SV**)HEK_KEY(hek));
6948 const int flags = HEK_FLAGS(hek);
6949 if (flags & HVhek_WASUTF8) {
6951 Andreas would like keys he put in as utf8 to come back as utf8
6953 STRLEN utf8_len = HEK_LEN(hek);
6954 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6955 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6958 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6960 } else if (flags & HVhek_REHASH) {
6961 /* We don't have a pointer to the hv, so we have to replicate the
6962 flag into every HEK. This hv is using custom a hasing
6963 algorithm. Hence we can't return a shared string scalar, as
6964 that would contain the (wrong) hash value, and might get passed
6965 into an hv routine with a regular hash */
6967 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6972 /* This will be overwhelminly the most common case. */
6974 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6975 more efficient than sharepvn(). */
6979 sv_upgrade(sv, SVt_PV);
6980 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
6981 SvCUR_set(sv, HEK_LEN(hek));
6994 =for apidoc newSVpvn_share
6996 Creates a new SV with its SvPVX_const pointing to a shared string in the string
6997 table. If the string does not already exist in the table, it is created
6998 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6999 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7000 otherwise the hash is computed. The idea here is that as the string table
7001 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7002 hash lookup will avoid string compare.
7008 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7012 bool is_utf8 = FALSE;
7013 const char *const orig_src = src;
7016 STRLEN tmplen = -len;
7018 /* See the note in hv.c:hv_fetch() --jhi */
7019 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7023 PERL_HASH(hash, src, len);
7025 sv_upgrade(sv, SVt_PV);
7026 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7034 if (src != orig_src)
7040 #if defined(PERL_IMPLICIT_CONTEXT)
7042 /* pTHX_ magic can't cope with varargs, so this is a no-context
7043 * version of the main function, (which may itself be aliased to us).
7044 * Don't access this version directly.
7048 Perl_newSVpvf_nocontext(const char* pat, ...)
7053 va_start(args, pat);
7054 sv = vnewSVpvf(pat, &args);
7061 =for apidoc newSVpvf
7063 Creates a new SV and initializes it with the string formatted like
7070 Perl_newSVpvf(pTHX_ const char* pat, ...)
7074 va_start(args, pat);
7075 sv = vnewSVpvf(pat, &args);
7080 /* backend for newSVpvf() and newSVpvf_nocontext() */
7083 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7088 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7095 Creates a new SV and copies a floating point value into it.
7096 The reference count for the SV is set to 1.
7102 Perl_newSVnv(pTHX_ NV n)
7115 Creates a new SV and copies an integer into it. The reference count for the
7122 Perl_newSViv(pTHX_ IV i)
7135 Creates a new SV and copies an unsigned integer into it.
7136 The reference count for the SV is set to 1.
7142 Perl_newSVuv(pTHX_ UV u)
7153 =for apidoc newRV_noinc
7155 Creates an RV wrapper for an SV. The reference count for the original
7156 SV is B<not> incremented.
7162 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7168 sv_upgrade(sv, SVt_RV);
7170 SvRV_set(sv, tmpRef);
7175 /* newRV_inc is the official function name to use now.
7176 * newRV_inc is in fact #defined to newRV in sv.h
7180 Perl_newRV(pTHX_ SV *sv)
7183 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7189 Creates a new SV which is an exact duplicate of the original SV.
7196 Perl_newSVsv(pTHX_ register SV *old)
7203 if (SvTYPE(old) == SVTYPEMASK) {
7204 if (ckWARN_d(WARN_INTERNAL))
7205 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7209 /* SV_GMAGIC is the default for sv_setv()
7210 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7211 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7212 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7217 =for apidoc sv_reset
7219 Underlying implementation for the C<reset> Perl function.
7220 Note that the perl-level function is vaguely deprecated.
7226 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7229 char todo[PERL_UCHAR_MAX+1];
7234 if (!*s) { /* reset ?? searches */
7235 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7237 PMOP *pm = (PMOP *) mg->mg_obj;
7239 pm->op_pmdynflags &= ~PMdf_USED;
7246 /* reset variables */
7248 if (!HvARRAY(stash))
7251 Zero(todo, 256, char);
7254 I32 i = (unsigned char)*s;
7258 max = (unsigned char)*s++;
7259 for ( ; i <= max; i++) {
7262 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7264 for (entry = HvARRAY(stash)[i];
7266 entry = HeNEXT(entry))
7271 if (!todo[(U8)*HeKEY(entry)])
7273 gv = (GV*)HeVAL(entry);
7276 if (SvTHINKFIRST(sv)) {
7277 if (!SvREADONLY(sv) && SvROK(sv))
7279 /* XXX Is this continue a bug? Why should THINKFIRST
7280 exempt us from resetting arrays and hashes? */
7284 if (SvTYPE(sv) >= SVt_PV) {
7286 if (SvPVX_const(sv) != NULL)
7294 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7296 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7299 # if defined(USE_ENVIRON_ARRAY)
7302 # endif /* USE_ENVIRON_ARRAY */
7313 Using various gambits, try to get an IO from an SV: the IO slot if its a
7314 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7315 named after the PV if we're a string.
7321 Perl_sv_2io(pTHX_ SV *sv)
7326 switch (SvTYPE(sv)) {
7334 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7338 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7340 return sv_2io(SvRV(sv));
7341 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7347 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7356 Using various gambits, try to get a CV from an SV; in addition, try if
7357 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7358 The flags in C<lref> are passed to sv_fetchsv.
7364 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7375 switch (SvTYPE(sv)) {
7394 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7395 tryAMAGICunDEREF(to_cv);
7398 if (SvTYPE(sv) == SVt_PVCV) {
7407 Perl_croak(aTHX_ "Not a subroutine reference");
7412 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7418 /* Some flags to gv_fetchsv mean don't really create the GV */
7419 if (SvTYPE(gv) != SVt_PVGV) {
7425 if (lref && !GvCVu(gv)) {
7429 gv_efullname3(tmpsv, gv, NULL);
7430 /* XXX this is probably not what they think they're getting.
7431 * It has the same effect as "sub name;", i.e. just a forward
7433 newSUB(start_subparse(FALSE, 0),
7434 newSVOP(OP_CONST, 0, tmpsv),
7438 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7448 Returns true if the SV has a true value by Perl's rules.
7449 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7450 instead use an in-line version.
7456 Perl_sv_true(pTHX_ register SV *sv)
7461 register const XPV* const tXpv = (XPV*)SvANY(sv);
7463 (tXpv->xpv_cur > 1 ||
7464 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7471 return SvIVX(sv) != 0;
7474 return SvNVX(sv) != 0.0;
7476 return sv_2bool(sv);
7482 =for apidoc sv_pvn_force
7484 Get a sensible string out of the SV somehow.
7485 A private implementation of the C<SvPV_force> macro for compilers which
7486 can't cope with complex macro expressions. Always use the macro instead.
7488 =for apidoc sv_pvn_force_flags
7490 Get a sensible string out of the SV somehow.
7491 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7492 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7493 implemented in terms of this function.
7494 You normally want to use the various wrapper macros instead: see
7495 C<SvPV_force> and C<SvPV_force_nomg>
7501 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7504 if (SvTHINKFIRST(sv) && !SvROK(sv))
7505 sv_force_normal_flags(sv, 0);
7515 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7516 const char * const ref = sv_reftype(sv,0);
7518 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7519 ref, OP_NAME(PL_op));
7521 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7523 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7524 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7526 s = sv_2pv_flags(sv, &len, flags);
7530 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7533 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7534 SvGROW(sv, len + 1);
7535 Move(s,SvPVX(sv),len,char);
7540 SvPOK_on(sv); /* validate pointer */
7542 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7543 PTR2UV(sv),SvPVX_const(sv)));
7546 return SvPVX_mutable(sv);
7550 =for apidoc sv_pvbyten_force
7552 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7558 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7560 sv_pvn_force(sv,lp);
7561 sv_utf8_downgrade(sv,0);
7567 =for apidoc sv_pvutf8n_force
7569 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7575 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7577 sv_pvn_force(sv,lp);
7578 sv_utf8_upgrade(sv);
7584 =for apidoc sv_reftype
7586 Returns a string describing what the SV is a reference to.
7592 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7594 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7595 inside return suggests a const propagation bug in g++. */
7596 if (ob && SvOBJECT(sv)) {
7597 char * const name = HvNAME_get(SvSTASH(sv));
7598 return name ? name : (char *) "__ANON__";
7601 switch (SvTYPE(sv)) {
7618 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7619 /* tied lvalues should appear to be
7620 * scalars for backwards compatitbility */
7621 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7622 ? "SCALAR" : "LVALUE");
7623 case SVt_PVAV: return "ARRAY";
7624 case SVt_PVHV: return "HASH";
7625 case SVt_PVCV: return "CODE";
7626 case SVt_PVGV: return "GLOB";
7627 case SVt_PVFM: return "FORMAT";
7628 case SVt_PVIO: return "IO";
7629 default: return "UNKNOWN";
7635 =for apidoc sv_isobject
7637 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7638 object. If the SV is not an RV, or if the object is not blessed, then this
7645 Perl_sv_isobject(pTHX_ SV *sv)
7661 Returns a boolean indicating whether the SV is blessed into the specified
7662 class. This does not check for subtypes; use C<sv_derived_from> to verify
7663 an inheritance relationship.
7669 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7680 hvname = HvNAME_get(SvSTASH(sv));
7684 return strEQ(hvname, name);
7690 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7691 it will be upgraded to one. If C<classname> is non-null then the new SV will
7692 be blessed in the specified package. The new SV is returned and its
7693 reference count is 1.
7699 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7706 SV_CHECK_THINKFIRST_COW_DROP(rv);
7709 if (SvTYPE(rv) >= SVt_PVMG) {
7710 const U32 refcnt = SvREFCNT(rv);
7714 SvREFCNT(rv) = refcnt;
7716 sv_upgrade(rv, SVt_RV);
7717 } else if (SvROK(rv)) {
7718 SvREFCNT_dec(SvRV(rv));
7719 } else if (SvTYPE(rv) < SVt_RV)
7720 sv_upgrade(rv, SVt_RV);
7721 else if (SvTYPE(rv) > SVt_RV) {
7732 HV* const stash = gv_stashpv(classname, TRUE);
7733 (void)sv_bless(rv, stash);
7739 =for apidoc sv_setref_pv
7741 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7742 argument will be upgraded to an RV. That RV will be modified to point to
7743 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7744 into the SV. The C<classname> argument indicates the package for the
7745 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7746 will have a reference count of 1, and the RV will be returned.
7748 Do not use with other Perl types such as HV, AV, SV, CV, because those
7749 objects will become corrupted by the pointer copy process.
7751 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7757 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7761 sv_setsv(rv, &PL_sv_undef);
7765 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7770 =for apidoc sv_setref_iv
7772 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7773 argument will be upgraded to an RV. That RV will be modified to point to
7774 the new SV. The C<classname> argument indicates the package for the
7775 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7776 will have a reference count of 1, and the RV will be returned.
7782 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7784 sv_setiv(newSVrv(rv,classname), iv);
7789 =for apidoc sv_setref_uv
7791 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7792 argument will be upgraded to an RV. That RV will be modified to point to
7793 the new SV. The C<classname> argument indicates the package for the
7794 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7795 will have a reference count of 1, and the RV will be returned.
7801 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7803 sv_setuv(newSVrv(rv,classname), uv);
7808 =for apidoc sv_setref_nv
7810 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7811 argument will be upgraded to an RV. That RV will be modified to point to
7812 the new SV. The C<classname> argument indicates the package for the
7813 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7814 will have a reference count of 1, and the RV will be returned.
7820 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7822 sv_setnv(newSVrv(rv,classname), nv);
7827 =for apidoc sv_setref_pvn
7829 Copies a string into a new SV, optionally blessing the SV. The length of the
7830 string must be specified with C<n>. The C<rv> argument will be upgraded to
7831 an RV. That RV will be modified to point to the new SV. The C<classname>
7832 argument indicates the package for the blessing. Set C<classname> to
7833 C<NULL> to avoid the blessing. The new SV will have a reference count
7834 of 1, and the RV will be returned.
7836 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7842 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7844 sv_setpvn(newSVrv(rv,classname), pv, n);
7849 =for apidoc sv_bless
7851 Blesses an SV into a specified package. The SV must be an RV. The package
7852 must be designated by its stash (see C<gv_stashpv()>). The reference count
7853 of the SV is unaffected.
7859 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7864 Perl_croak(aTHX_ "Can't bless non-reference value");
7866 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7867 if (SvREADONLY(tmpRef))
7868 Perl_croak(aTHX_ PL_no_modify);
7869 if (SvOBJECT(tmpRef)) {
7870 if (SvTYPE(tmpRef) != SVt_PVIO)
7872 SvREFCNT_dec(SvSTASH(tmpRef));
7875 SvOBJECT_on(tmpRef);
7876 if (SvTYPE(tmpRef) != SVt_PVIO)
7878 SvUPGRADE(tmpRef, SVt_PVMG);
7879 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7886 if(SvSMAGICAL(tmpRef))
7887 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7895 /* Downgrades a PVGV to a PVMG.
7899 S_sv_unglob(pTHX_ SV *sv)
7903 SV * const temp = sv_newmortal();
7905 assert(SvTYPE(sv) == SVt_PVGV);
7907 gv_efullname3(temp, (GV *) sv, "*");
7913 sv_del_backref((SV*)GvSTASH(sv), sv);
7917 if (GvNAME_HEK(sv)) {
7918 unshare_hek(GvNAME_HEK(sv));
7922 /* need to keep SvANY(sv) in the right arena */
7923 xpvmg = new_XPVMG();
7924 StructCopy(SvANY(sv), xpvmg, XPVMG);
7925 del_XPVGV(SvANY(sv));
7928 SvFLAGS(sv) &= ~SVTYPEMASK;
7929 SvFLAGS(sv) |= SVt_PVMG;
7931 /* Intentionally not calling any local SET magic, as this isn't so much a
7932 set operation as merely an internal storage change. */
7933 sv_setsv_flags(sv, temp, 0);
7937 =for apidoc sv_unref_flags
7939 Unsets the RV status of the SV, and decrements the reference count of
7940 whatever was being referenced by the RV. This can almost be thought of
7941 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7942 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7943 (otherwise the decrementing is conditional on the reference count being
7944 different from one or the reference being a readonly SV).
7951 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7953 SV* const target = SvRV(ref);
7955 if (SvWEAKREF(ref)) {
7956 sv_del_backref(target, ref);
7958 SvRV_set(ref, NULL);
7961 SvRV_set(ref, NULL);
7963 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7964 assigned to as BEGIN {$a = \"Foo"} will fail. */
7965 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7966 SvREFCNT_dec(target);
7967 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7968 sv_2mortal(target); /* Schedule for freeing later */
7972 =for apidoc sv_untaint
7974 Untaint an SV. Use C<SvTAINTED_off> instead.
7979 Perl_sv_untaint(pTHX_ SV *sv)
7981 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7982 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
7989 =for apidoc sv_tainted
7991 Test an SV for taintedness. Use C<SvTAINTED> instead.
7996 Perl_sv_tainted(pTHX_ SV *sv)
7998 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
7999 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8000 if (mg && (mg->mg_len & 1) )
8007 =for apidoc sv_setpviv
8009 Copies an integer into the given SV, also updating its string value.
8010 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8016 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8018 char buf[TYPE_CHARS(UV)];
8020 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8022 sv_setpvn(sv, ptr, ebuf - ptr);
8026 =for apidoc sv_setpviv_mg
8028 Like C<sv_setpviv>, but also handles 'set' magic.
8034 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8040 #if defined(PERL_IMPLICIT_CONTEXT)
8042 /* pTHX_ magic can't cope with varargs, so this is a no-context
8043 * version of the main function, (which may itself be aliased to us).
8044 * Don't access this version directly.
8048 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8052 va_start(args, pat);
8053 sv_vsetpvf(sv, pat, &args);
8057 /* pTHX_ magic can't cope with varargs, so this is a no-context
8058 * version of the main function, (which may itself be aliased to us).
8059 * Don't access this version directly.
8063 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8067 va_start(args, pat);
8068 sv_vsetpvf_mg(sv, pat, &args);
8074 =for apidoc sv_setpvf
8076 Works like C<sv_catpvf> but copies the text into the SV instead of
8077 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8083 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8086 va_start(args, pat);
8087 sv_vsetpvf(sv, pat, &args);
8092 =for apidoc sv_vsetpvf
8094 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8095 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8097 Usually used via its frontend C<sv_setpvf>.
8103 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8105 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8109 =for apidoc sv_setpvf_mg
8111 Like C<sv_setpvf>, but also handles 'set' magic.
8117 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8120 va_start(args, pat);
8121 sv_vsetpvf_mg(sv, pat, &args);
8126 =for apidoc sv_vsetpvf_mg
8128 Like C<sv_vsetpvf>, but also handles 'set' magic.
8130 Usually used via its frontend C<sv_setpvf_mg>.
8136 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8138 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8142 #if defined(PERL_IMPLICIT_CONTEXT)
8144 /* pTHX_ magic can't cope with varargs, so this is a no-context
8145 * version of the main function, (which may itself be aliased to us).
8146 * Don't access this version directly.
8150 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8154 va_start(args, pat);
8155 sv_vcatpvf(sv, pat, &args);
8159 /* pTHX_ magic can't cope with varargs, so this is a no-context
8160 * version of the main function, (which may itself be aliased to us).
8161 * Don't access this version directly.
8165 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8169 va_start(args, pat);
8170 sv_vcatpvf_mg(sv, pat, &args);
8176 =for apidoc sv_catpvf
8178 Processes its arguments like C<sprintf> and appends the formatted
8179 output to an SV. If the appended data contains "wide" characters
8180 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8181 and characters >255 formatted with %c), the original SV might get
8182 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8183 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8184 valid UTF-8; if the original SV was bytes, the pattern should be too.
8189 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8192 va_start(args, pat);
8193 sv_vcatpvf(sv, pat, &args);
8198 =for apidoc sv_vcatpvf
8200 Processes its arguments like C<vsprintf> and appends the formatted output
8201 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8203 Usually used via its frontend C<sv_catpvf>.
8209 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8211 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8215 =for apidoc sv_catpvf_mg
8217 Like C<sv_catpvf>, but also handles 'set' magic.
8223 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8226 va_start(args, pat);
8227 sv_vcatpvf_mg(sv, pat, &args);
8232 =for apidoc sv_vcatpvf_mg
8234 Like C<sv_vcatpvf>, but also handles 'set' magic.
8236 Usually used via its frontend C<sv_catpvf_mg>.
8242 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8244 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8249 =for apidoc sv_vsetpvfn
8251 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8254 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8260 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8262 sv_setpvn(sv, "", 0);
8263 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8267 S_expect_number(pTHX_ char** pattern)
8271 switch (**pattern) {
8272 case '1': case '2': case '3':
8273 case '4': case '5': case '6':
8274 case '7': case '8': case '9':
8275 var = *(*pattern)++ - '0';
8276 while (isDIGIT(**pattern)) {
8277 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8279 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8287 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8289 const int neg = nv < 0;
8298 if (uv & 1 && uv == nv)
8299 uv--; /* Round to even */
8301 const unsigned dig = uv % 10;
8314 =for apidoc sv_vcatpvfn
8316 Processes its arguments like C<vsprintf> and appends the formatted output
8317 to an SV. Uses an array of SVs if the C style variable argument list is
8318 missing (NULL). When running with taint checks enabled, indicates via
8319 C<maybe_tainted> if results are untrustworthy (often due to the use of
8322 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8328 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8329 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8330 vec_utf8 = DO_UTF8(vecsv);
8332 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8335 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8343 static const char nullstr[] = "(null)";
8345 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8346 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8348 /* Times 4: a decimal digit takes more than 3 binary digits.
8349 * NV_DIG: mantissa takes than many decimal digits.
8350 * Plus 32: Playing safe. */
8351 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8352 /* large enough for "%#.#f" --chip */
8353 /* what about long double NVs? --jhi */
8355 PERL_UNUSED_ARG(maybe_tainted);
8357 /* no matter what, this is a string now */
8358 (void)SvPV_force(sv, origlen);
8360 /* special-case "", "%s", and "%-p" (SVf - see below) */
8363 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8365 const char * const s = va_arg(*args, char*);
8366 sv_catpv(sv, s ? s : nullstr);
8368 else if (svix < svmax) {
8369 sv_catsv(sv, *svargs);
8373 if (args && patlen == 3 && pat[0] == '%' &&
8374 pat[1] == '-' && pat[2] == 'p') {
8375 argsv = va_arg(*args, SV*);
8376 sv_catsv(sv, argsv);
8380 #ifndef USE_LONG_DOUBLE
8381 /* special-case "%.<number>[gf]" */
8382 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8383 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8384 unsigned digits = 0;
8388 while (*pp >= '0' && *pp <= '9')
8389 digits = 10 * digits + (*pp++ - '0');
8390 if (pp - pat == (int)patlen - 1) {
8398 /* Add check for digits != 0 because it seems that some
8399 gconverts are buggy in this case, and we don't yet have
8400 a Configure test for this. */
8401 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8402 /* 0, point, slack */
8403 Gconvert(nv, (int)digits, 0, ebuf);
8405 if (*ebuf) /* May return an empty string for digits==0 */
8408 } else if (!digits) {
8411 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8412 sv_catpvn(sv, p, l);
8418 #endif /* !USE_LONG_DOUBLE */
8420 if (!args && svix < svmax && DO_UTF8(*svargs))
8423 patend = (char*)pat + patlen;
8424 for (p = (char*)pat; p < patend; p = q) {
8427 bool vectorize = FALSE;
8428 bool vectorarg = FALSE;
8429 bool vec_utf8 = FALSE;
8435 bool has_precis = FALSE;
8437 const I32 osvix = svix;
8438 bool is_utf8 = FALSE; /* is this item utf8? */
8439 #ifdef HAS_LDBL_SPRINTF_BUG
8440 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8441 with sfio - Allen <allens@cpan.org> */
8442 bool fix_ldbl_sprintf_bug = FALSE;
8446 U8 utf8buf[UTF8_MAXBYTES+1];
8447 STRLEN esignlen = 0;
8449 const char *eptr = NULL;
8452 const U8 *vecstr = NULL;
8459 /* we need a long double target in case HAS_LONG_DOUBLE but
8462 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8470 const char *dotstr = ".";
8471 STRLEN dotstrlen = 1;
8472 I32 efix = 0; /* explicit format parameter index */
8473 I32 ewix = 0; /* explicit width index */
8474 I32 epix = 0; /* explicit precision index */
8475 I32 evix = 0; /* explicit vector index */
8476 bool asterisk = FALSE;
8478 /* echo everything up to the next format specification */
8479 for (q = p; q < patend && *q != '%'; ++q) ;
8481 if (has_utf8 && !pat_utf8)
8482 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8484 sv_catpvn(sv, p, q - p);
8491 We allow format specification elements in this order:
8492 \d+\$ explicit format parameter index
8494 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8495 0 flag (as above): repeated to allow "v02"
8496 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8497 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8499 [%bcdefginopsuxDFOUX] format (mandatory)
8504 As of perl5.9.3, printf format checking is on by default.
8505 Internally, perl uses %p formats to provide an escape to
8506 some extended formatting. This block deals with those
8507 extensions: if it does not match, (char*)q is reset and
8508 the normal format processing code is used.
8510 Currently defined extensions are:
8511 %p include pointer address (standard)
8512 %-p (SVf) include an SV (previously %_)
8513 %-<num>p include an SV with precision <num>
8514 %1p (VDf) include a v-string (as %vd)
8515 %<num>p reserved for future extensions
8517 Robin Barker 2005-07-14
8524 n = expect_number(&q);
8531 argsv = va_arg(*args, SV*);
8532 eptr = SvPVx_const(argsv, elen);
8538 else if (n == vdNUMBER) { /* VDf */
8545 if (ckWARN_d(WARN_INTERNAL))
8546 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8547 "internal %%<num>p might conflict with future printf extensions");
8553 if ( (width = expect_number(&q)) ) {
8594 if ( (ewix = expect_number(&q)) )
8603 if ((vectorarg = asterisk)) {
8616 width = expect_number(&q);
8622 vecsv = va_arg(*args, SV*);
8624 vecsv = (evix > 0 && evix <= svmax)
8625 ? svargs[evix-1] : &PL_sv_undef;
8627 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8629 dotstr = SvPV_const(vecsv, dotstrlen);
8630 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8631 bad with tied or overloaded values that return UTF8. */
8634 else if (has_utf8) {
8635 vecsv = sv_mortalcopy(vecsv);
8636 sv_utf8_upgrade(vecsv);
8637 dotstr = SvPV_const(vecsv, dotstrlen);
8644 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8645 vecsv = svargs[efix ? efix-1 : svix++];
8646 vecstr = (U8*)SvPV_const(vecsv,veclen);
8647 vec_utf8 = DO_UTF8(vecsv);
8649 /* if this is a version object, we need to convert
8650 * back into v-string notation and then let the
8651 * vectorize happen normally
8653 if (sv_derived_from(vecsv, "version")) {
8654 char *version = savesvpv(vecsv);
8655 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8656 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8657 "vector argument not supported with alpha versions");
8660 vecsv = sv_newmortal();
8661 /* scan_vstring is expected to be called during
8662 * tokenization, so we need to fake up the end
8663 * of the buffer for it
8665 PL_bufend = version + veclen;
8666 scan_vstring(version, vecsv);
8667 vecstr = (U8*)SvPV_const(vecsv, veclen);
8668 vec_utf8 = DO_UTF8(vecsv);
8680 i = va_arg(*args, int);
8682 i = (ewix ? ewix <= svmax : svix < svmax) ?
8683 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8685 width = (i < 0) ? -i : i;
8695 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8697 /* XXX: todo, support specified precision parameter */
8701 i = va_arg(*args, int);
8703 i = (ewix ? ewix <= svmax : svix < svmax)
8704 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8705 precis = (i < 0) ? 0 : i;
8710 precis = precis * 10 + (*q++ - '0');
8719 case 'I': /* Ix, I32x, and I64x */
8721 if (q[1] == '6' && q[2] == '4') {
8727 if (q[1] == '3' && q[2] == '2') {
8737 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8748 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8749 if (*(q + 1) == 'l') { /* lld, llf */
8775 if (!vectorize && !args) {
8777 const I32 i = efix-1;
8778 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8780 argsv = (svix >= 0 && svix < svmax)
8781 ? svargs[svix++] : &PL_sv_undef;
8792 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8794 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8796 eptr = (char*)utf8buf;
8797 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8811 eptr = va_arg(*args, char*);
8813 #ifdef MACOS_TRADITIONAL
8814 /* On MacOS, %#s format is used for Pascal strings */
8819 elen = strlen(eptr);
8821 eptr = (char *)nullstr;
8822 elen = sizeof nullstr - 1;
8826 eptr = SvPVx_const(argsv, elen);
8827 if (DO_UTF8(argsv)) {
8828 if (has_precis && precis < elen) {
8830 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8833 if (width) { /* fudge width (can't fudge elen) */
8834 width += elen - sv_len_utf8(argsv);
8841 if (has_precis && elen > precis)
8848 if (alt || vectorize)
8850 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8871 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8880 esignbuf[esignlen++] = plus;
8884 case 'h': iv = (short)va_arg(*args, int); break;
8885 case 'l': iv = va_arg(*args, long); break;
8886 case 'V': iv = va_arg(*args, IV); break;
8887 default: iv = va_arg(*args, int); break;
8889 case 'q': iv = va_arg(*args, Quad_t); break;
8894 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8896 case 'h': iv = (short)tiv; break;
8897 case 'l': iv = (long)tiv; break;
8899 default: iv = tiv; break;
8901 case 'q': iv = (Quad_t)tiv; break;
8905 if ( !vectorize ) /* we already set uv above */
8910 esignbuf[esignlen++] = plus;
8914 esignbuf[esignlen++] = '-';
8957 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8968 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8969 case 'l': uv = va_arg(*args, unsigned long); break;
8970 case 'V': uv = va_arg(*args, UV); break;
8971 default: uv = va_arg(*args, unsigned); break;
8973 case 'q': uv = va_arg(*args, Uquad_t); break;
8978 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
8980 case 'h': uv = (unsigned short)tuv; break;
8981 case 'l': uv = (unsigned long)tuv; break;
8983 default: uv = tuv; break;
8985 case 'q': uv = (Uquad_t)tuv; break;
8992 char *ptr = ebuf + sizeof ebuf;
8998 p = (char*)((c == 'X')
8999 ? "0123456789ABCDEF" : "0123456789abcdef");
9005 esignbuf[esignlen++] = '0';
9006 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9014 if (alt && *ptr != '0')
9025 esignbuf[esignlen++] = '0';
9026 esignbuf[esignlen++] = 'b';
9029 default: /* it had better be ten or less */
9033 } while (uv /= base);
9036 elen = (ebuf + sizeof ebuf) - ptr;
9040 zeros = precis - elen;
9041 else if (precis == 0 && elen == 1 && *eptr == '0')
9047 /* FLOATING POINT */
9050 c = 'f'; /* maybe %F isn't supported here */
9058 /* This is evil, but floating point is even more evil */
9060 /* for SV-style calling, we can only get NV
9061 for C-style calling, we assume %f is double;
9062 for simplicity we allow any of %Lf, %llf, %qf for long double
9066 #if defined(USE_LONG_DOUBLE)
9070 /* [perl #20339] - we should accept and ignore %lf rather than die */
9074 #if defined(USE_LONG_DOUBLE)
9075 intsize = args ? 0 : 'q';
9079 #if defined(HAS_LONG_DOUBLE)
9088 /* now we need (long double) if intsize == 'q', else (double) */
9090 #if LONG_DOUBLESIZE > DOUBLESIZE
9092 va_arg(*args, long double) :
9093 va_arg(*args, double)
9095 va_arg(*args, double)
9100 if (c != 'e' && c != 'E') {
9102 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9103 will cast our (long double) to (double) */
9104 (void)Perl_frexp(nv, &i);
9105 if (i == PERL_INT_MIN)
9106 Perl_die(aTHX_ "panic: frexp");
9108 need = BIT_DIGITS(i);
9110 need += has_precis ? precis : 6; /* known default */
9115 #ifdef HAS_LDBL_SPRINTF_BUG
9116 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9117 with sfio - Allen <allens@cpan.org> */
9120 # define MY_DBL_MAX DBL_MAX
9121 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9122 # if DOUBLESIZE >= 8
9123 # define MY_DBL_MAX 1.7976931348623157E+308L
9125 # define MY_DBL_MAX 3.40282347E+38L
9129 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9130 # define MY_DBL_MAX_BUG 1L
9132 # define MY_DBL_MAX_BUG MY_DBL_MAX
9136 # define MY_DBL_MIN DBL_MIN
9137 # else /* XXX guessing! -Allen */
9138 # if DOUBLESIZE >= 8
9139 # define MY_DBL_MIN 2.2250738585072014E-308L
9141 # define MY_DBL_MIN 1.17549435E-38L
9145 if ((intsize == 'q') && (c == 'f') &&
9146 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9148 /* it's going to be short enough that
9149 * long double precision is not needed */
9151 if ((nv <= 0L) && (nv >= -0L))
9152 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9154 /* would use Perl_fp_class as a double-check but not
9155 * functional on IRIX - see perl.h comments */
9157 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9158 /* It's within the range that a double can represent */
9159 #if defined(DBL_MAX) && !defined(DBL_MIN)
9160 if ((nv >= ((long double)1/DBL_MAX)) ||
9161 (nv <= (-(long double)1/DBL_MAX)))
9163 fix_ldbl_sprintf_bug = TRUE;
9166 if (fix_ldbl_sprintf_bug == TRUE) {
9176 # undef MY_DBL_MAX_BUG
9179 #endif /* HAS_LDBL_SPRINTF_BUG */
9181 need += 20; /* fudge factor */
9182 if (PL_efloatsize < need) {
9183 Safefree(PL_efloatbuf);
9184 PL_efloatsize = need + 20; /* more fudge */
9185 Newx(PL_efloatbuf, PL_efloatsize, char);
9186 PL_efloatbuf[0] = '\0';
9189 if ( !(width || left || plus || alt) && fill != '0'
9190 && has_precis && intsize != 'q' ) { /* Shortcuts */
9191 /* See earlier comment about buggy Gconvert when digits,
9193 if ( c == 'g' && precis) {
9194 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9195 /* May return an empty string for digits==0 */
9196 if (*PL_efloatbuf) {
9197 elen = strlen(PL_efloatbuf);
9198 goto float_converted;
9200 } else if ( c == 'f' && !precis) {
9201 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9206 char *ptr = ebuf + sizeof ebuf;
9209 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9210 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9211 if (intsize == 'q') {
9212 /* Copy the one or more characters in a long double
9213 * format before the 'base' ([efgEFG]) character to
9214 * the format string. */
9215 static char const prifldbl[] = PERL_PRIfldbl;
9216 char const *p = prifldbl + sizeof(prifldbl) - 3;
9217 while (p >= prifldbl) { *--ptr = *p--; }
9222 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9227 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9239 /* No taint. Otherwise we are in the strange situation
9240 * where printf() taints but print($float) doesn't.
9242 #if defined(HAS_LONG_DOUBLE)
9243 elen = ((intsize == 'q')
9244 ? my_sprintf(PL_efloatbuf, ptr, nv)
9245 : my_sprintf(PL_efloatbuf, ptr, (double)nv));
9247 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9251 eptr = PL_efloatbuf;
9259 i = SvCUR(sv) - origlen;
9262 case 'h': *(va_arg(*args, short*)) = i; break;
9263 default: *(va_arg(*args, int*)) = i; break;
9264 case 'l': *(va_arg(*args, long*)) = i; break;
9265 case 'V': *(va_arg(*args, IV*)) = i; break;
9267 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9272 sv_setuv_mg(argsv, (UV)i);
9273 continue; /* not "break" */
9280 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9281 && ckWARN(WARN_PRINTF))
9283 SV * const msg = sv_newmortal();
9284 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9285 (PL_op->op_type == OP_PRTF) ? "" : "s");
9288 Perl_sv_catpvf(aTHX_ msg,
9289 "\"%%%c\"", c & 0xFF);
9291 Perl_sv_catpvf(aTHX_ msg,
9292 "\"%%\\%03"UVof"\"",
9295 sv_catpvs(msg, "end of string");
9296 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
9299 /* output mangled stuff ... */
9305 /* ... right here, because formatting flags should not apply */
9306 SvGROW(sv, SvCUR(sv) + elen + 1);
9308 Copy(eptr, p, elen, char);
9311 SvCUR_set(sv, p - SvPVX_const(sv));
9313 continue; /* not "break" */
9316 /* calculate width before utf8_upgrade changes it */
9317 have = esignlen + zeros + elen;
9319 Perl_croak_nocontext(PL_memory_wrap);
9321 if (is_utf8 != has_utf8) {
9324 sv_utf8_upgrade(sv);
9327 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9328 sv_utf8_upgrade(nsv);
9329 eptr = SvPVX_const(nsv);
9332 SvGROW(sv, SvCUR(sv) + elen + 1);
9337 need = (have > width ? have : width);
9340 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9341 Perl_croak_nocontext(PL_memory_wrap);
9342 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9344 if (esignlen && fill == '0') {
9346 for (i = 0; i < (int)esignlen; i++)
9350 memset(p, fill, gap);
9353 if (esignlen && fill != '0') {
9355 for (i = 0; i < (int)esignlen; i++)
9360 for (i = zeros; i; i--)
9364 Copy(eptr, p, elen, char);
9368 memset(p, ' ', gap);
9373 Copy(dotstr, p, dotstrlen, char);
9377 vectorize = FALSE; /* done iterating over vecstr */
9384 SvCUR_set(sv, p - SvPVX_const(sv));
9392 /* =========================================================================
9394 =head1 Cloning an interpreter
9396 All the macros and functions in this section are for the private use of
9397 the main function, perl_clone().
9399 The foo_dup() functions make an exact copy of an existing foo thinngy.
9400 During the course of a cloning, a hash table is used to map old addresses
9401 to new addresses. The table is created and manipulated with the
9402 ptr_table_* functions.
9406 ============================================================================*/
9409 #if defined(USE_ITHREADS)
9411 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9412 #ifndef GpREFCNT_inc
9413 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9417 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9418 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9419 please unmerge ss_dup. */
9420 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9421 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9422 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9423 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9424 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9425 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9426 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9427 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9428 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9429 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9430 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9431 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9432 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9433 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9436 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9437 regcomp.c. AMS 20010712 */
9440 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9445 struct reg_substr_datum *s;
9448 return (REGEXP *)NULL;
9450 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9453 len = r->offsets[0];
9454 npar = r->nparens+1;
9456 Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9457 Copy(r->program, ret->program, len+1, regnode);
9459 Newx(ret->startp, npar, I32);
9460 Copy(r->startp, ret->startp, npar, I32);
9461 Newx(ret->endp, npar, I32);
9462 Copy(r->startp, ret->startp, npar, I32);
9464 Newx(ret->substrs, 1, struct reg_substr_data);
9465 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9466 s->min_offset = r->substrs->data[i].min_offset;
9467 s->max_offset = r->substrs->data[i].max_offset;
9468 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
9469 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
9472 ret->regstclass = NULL;
9475 const int count = r->data->count;
9478 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9479 char, struct reg_data);
9480 Newx(d->what, count, U8);
9483 for (i = 0; i < count; i++) {
9484 d->what[i] = r->data->what[i];
9485 switch (d->what[i]) {
9486 /* legal options are one of: sfpont
9487 see also regcomp.h and pregfree() */
9489 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9492 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9495 /* This is cheating. */
9496 Newx(d->data[i], 1, struct regnode_charclass_class);
9497 StructCopy(r->data->data[i], d->data[i],
9498 struct regnode_charclass_class);
9499 ret->regstclass = (regnode*)d->data[i];
9502 /* Compiled op trees are readonly, and can thus be
9503 shared without duplication. */
9505 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9509 d->data[i] = r->data->data[i];
9512 d->data[i] = r->data->data[i];
9514 ((reg_trie_data*)d->data[i])->refcount++;
9518 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
9527 Newx(ret->offsets, 2*len+1, U32);
9528 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9530 ret->precomp = SAVEPVN(r->precomp, r->prelen);
9531 ret->refcnt = r->refcnt;
9532 ret->minlen = r->minlen;
9533 ret->prelen = r->prelen;
9534 ret->nparens = r->nparens;
9535 ret->lastparen = r->lastparen;
9536 ret->lastcloseparen = r->lastcloseparen;
9537 ret->reganch = r->reganch;
9539 ret->sublen = r->sublen;
9541 if (RX_MATCH_COPIED(ret))
9542 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
9545 #ifdef PERL_OLD_COPY_ON_WRITE
9546 ret->saved_copy = NULL;
9549 ptr_table_store(PL_ptr_table, r, ret);
9553 /* duplicate a file handle */
9556 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9560 PERL_UNUSED_ARG(type);
9563 return (PerlIO*)NULL;
9565 /* look for it in the table first */
9566 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9570 /* create anew and remember what it is */
9571 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9572 ptr_table_store(PL_ptr_table, fp, ret);
9576 /* duplicate a directory handle */
9579 Perl_dirp_dup(pTHX_ DIR *dp)
9581 PERL_UNUSED_CONTEXT;
9588 /* duplicate a typeglob */
9591 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9597 /* look for it in the table first */
9598 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9602 /* create anew and remember what it is */
9604 ptr_table_store(PL_ptr_table, gp, ret);
9607 ret->gp_refcnt = 0; /* must be before any other dups! */
9608 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9609 ret->gp_io = io_dup_inc(gp->gp_io, param);
9610 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9611 ret->gp_av = av_dup_inc(gp->gp_av, param);
9612 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9613 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9614 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9615 ret->gp_cvgen = gp->gp_cvgen;
9616 ret->gp_line = gp->gp_line;
9617 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9621 /* duplicate a chain of magic */
9624 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9626 MAGIC *mgprev = (MAGIC*)NULL;
9629 return (MAGIC*)NULL;
9630 /* look for it in the table first */
9631 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9635 for (; mg; mg = mg->mg_moremagic) {
9637 Newxz(nmg, 1, MAGIC);
9639 mgprev->mg_moremagic = nmg;
9642 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9643 nmg->mg_private = mg->mg_private;
9644 nmg->mg_type = mg->mg_type;
9645 nmg->mg_flags = mg->mg_flags;
9646 if (mg->mg_type == PERL_MAGIC_qr) {
9647 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9649 else if(mg->mg_type == PERL_MAGIC_backref) {
9650 /* The backref AV has its reference count deliberately bumped by
9652 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9654 else if (mg->mg_type == PERL_MAGIC_symtab) {
9655 nmg->mg_obj = mg->mg_obj;
9658 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9659 ? sv_dup_inc(mg->mg_obj, param)
9660 : sv_dup(mg->mg_obj, param);
9662 nmg->mg_len = mg->mg_len;
9663 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9664 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9665 if (mg->mg_len > 0) {
9666 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9667 if (mg->mg_type == PERL_MAGIC_overload_table &&
9668 AMT_AMAGIC((AMT*)mg->mg_ptr))
9670 const AMT * const amtp = (AMT*)mg->mg_ptr;
9671 AMT * const namtp = (AMT*)nmg->mg_ptr;
9673 for (i = 1; i < NofAMmeth; i++) {
9674 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9678 else if (mg->mg_len == HEf_SVKEY)
9679 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9681 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9682 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9689 /* create a new pointer-mapping table */
9692 Perl_ptr_table_new(pTHX)
9695 PERL_UNUSED_CONTEXT;
9697 Newxz(tbl, 1, PTR_TBL_t);
9700 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9704 #define PTR_TABLE_HASH(ptr) \
9705 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9708 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9709 following define) and at call to new_body_inline made below in
9710 Perl_ptr_table_store()
9713 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9715 /* map an existing pointer using a table */
9717 STATIC PTR_TBL_ENT_t *
9718 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9719 PTR_TBL_ENT_t *tblent;
9720 const UV hash = PTR_TABLE_HASH(sv);
9722 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9723 for (; tblent; tblent = tblent->next) {
9724 if (tblent->oldval == sv)
9731 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9733 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9734 PERL_UNUSED_CONTEXT;
9735 return tblent ? tblent->newval : NULL;
9738 /* add a new entry to a pointer-mapping table */
9741 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9743 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9744 PERL_UNUSED_CONTEXT;
9747 tblent->newval = newsv;
9749 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9751 new_body_inline(tblent, PTE_SVSLOT);
9753 tblent->oldval = oldsv;
9754 tblent->newval = newsv;
9755 tblent->next = tbl->tbl_ary[entry];
9756 tbl->tbl_ary[entry] = tblent;
9758 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9759 ptr_table_split(tbl);
9763 /* double the hash bucket size of an existing ptr table */
9766 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9768 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9769 const UV oldsize = tbl->tbl_max + 1;
9770 UV newsize = oldsize * 2;
9772 PERL_UNUSED_CONTEXT;
9774 Renew(ary, newsize, PTR_TBL_ENT_t*);
9775 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9776 tbl->tbl_max = --newsize;
9778 for (i=0; i < oldsize; i++, ary++) {
9779 PTR_TBL_ENT_t **curentp, **entp, *ent;
9782 curentp = ary + oldsize;
9783 for (entp = ary, ent = *ary; ent; ent = *entp) {
9784 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9786 ent->next = *curentp;
9796 /* remove all the entries from a ptr table */
9799 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9801 if (tbl && tbl->tbl_items) {
9802 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9803 UV riter = tbl->tbl_max;
9806 PTR_TBL_ENT_t *entry = array[riter];
9809 PTR_TBL_ENT_t * const oentry = entry;
9810 entry = entry->next;
9819 /* clear and free a ptr table */
9822 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9827 ptr_table_clear(tbl);
9828 Safefree(tbl->tbl_ary);
9834 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9837 SvRV_set(dstr, SvWEAKREF(sstr)
9838 ? sv_dup(SvRV(sstr), param)
9839 : sv_dup_inc(SvRV(sstr), param));
9842 else if (SvPVX_const(sstr)) {
9843 /* Has something there */
9845 /* Normal PV - clone whole allocated space */
9846 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9847 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9848 /* Not that normal - actually sstr is copy on write.
9849 But we are a true, independant SV, so: */
9850 SvREADONLY_off(dstr);
9855 /* Special case - not normally malloced for some reason */
9856 if (isGV_with_GP(sstr)) {
9857 /* Don't need to do anything here. */
9859 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9860 /* A "shared" PV - clone it as "shared" PV */
9862 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9866 /* Some other special case - random pointer */
9867 SvPV_set(dstr, SvPVX(sstr));
9873 if (SvTYPE(dstr) == SVt_RV)
9874 SvRV_set(dstr, NULL);
9876 SvPV_set(dstr, NULL);
9880 /* duplicate an SV of any type (including AV, HV etc) */
9883 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9888 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9890 /* look for it in the table first */
9891 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9895 if(param->flags & CLONEf_JOIN_IN) {
9896 /** We are joining here so we don't want do clone
9897 something that is bad **/
9898 if (SvTYPE(sstr) == SVt_PVHV) {
9899 const char * const hvname = HvNAME_get(sstr);
9901 /** don't clone stashes if they already exist **/
9902 return (SV*)gv_stashpv(hvname,0);
9906 /* create anew and remember what it is */
9909 #ifdef DEBUG_LEAKING_SCALARS
9910 dstr->sv_debug_optype = sstr->sv_debug_optype;
9911 dstr->sv_debug_line = sstr->sv_debug_line;
9912 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9913 dstr->sv_debug_cloned = 1;
9914 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9917 ptr_table_store(PL_ptr_table, sstr, dstr);
9920 SvFLAGS(dstr) = SvFLAGS(sstr);
9921 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9922 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9925 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9926 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9927 PL_watch_pvx, SvPVX_const(sstr));
9930 /* don't clone objects whose class has asked us not to */
9931 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9932 SvFLAGS(dstr) &= ~SVTYPEMASK;
9937 switch (SvTYPE(sstr)) {
9942 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9943 SvIV_set(dstr, SvIVX(sstr));
9946 SvANY(dstr) = new_XNV();
9947 SvNV_set(dstr, SvNVX(sstr));
9950 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9951 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9955 /* These are all the types that need complex bodies allocating. */
9957 const svtype sv_type = SvTYPE(sstr);
9958 const struct body_details *const sv_type_details
9959 = bodies_by_type + sv_type;
9963 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9967 if (GvUNIQUE((GV*)sstr)) {
9968 /*EMPTY*/; /* Do sharing here, and fall through */
9981 assert(sv_type_details->body_size);
9982 if (sv_type_details->arena) {
9983 new_body_inline(new_body, sv_type);
9985 = (void*)((char*)new_body - sv_type_details->offset);
9987 new_body = new_NOARENA(sv_type_details);
9991 SvANY(dstr) = new_body;
9994 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9995 ((char*)SvANY(dstr)) + sv_type_details->offset,
9996 sv_type_details->copy, char);
9998 Copy(((char*)SvANY(sstr)),
9999 ((char*)SvANY(dstr)),
10000 sv_type_details->body_size + sv_type_details->offset, char);
10003 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10004 && !isGV_with_GP(dstr))
10005 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10007 /* The Copy above means that all the source (unduplicated) pointers
10008 are now in the destination. We can check the flags and the
10009 pointers in either, but it's possible that there's less cache
10010 missing by always going for the destination.
10011 FIXME - instrument and check that assumption */
10012 if (sv_type >= SVt_PVMG) {
10014 if ((sv_type == SVt_PVMG) && (ourstash = OURSTASH(dstr))) {
10015 OURSTASH_set(dstr, hv_dup_inc(ourstash, param));
10016 } else if (SvMAGIC(dstr))
10017 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10019 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10022 /* The cast silences a GCC warning about unhandled types. */
10023 switch ((int)sv_type) {
10035 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10036 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10037 LvTARG(dstr) = dstr;
10038 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10039 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10041 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10044 if (GvNAME_HEK(dstr))
10045 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10047 /* Don't call sv_add_backref here as it's going to be created
10048 as part of the magic cloning of the symbol table. */
10049 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10050 if(isGV_with_GP(sstr)) {
10051 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10052 at the point of this comment. */
10053 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10054 (void)GpREFCNT_inc(GvGP(dstr));
10056 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10059 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10060 if (IoOFP(dstr) == IoIFP(sstr))
10061 IoOFP(dstr) = IoIFP(dstr);
10063 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10064 /* PL_rsfp_filters entries have fake IoDIRP() */
10065 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10066 /* I have no idea why fake dirp (rsfps)
10067 should be treated differently but otherwise
10068 we end up with leaks -- sky*/
10069 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10070 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10071 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10073 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10074 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10075 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10076 if (IoDIRP(dstr)) {
10077 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10080 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10083 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10084 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10085 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10088 if (AvARRAY((AV*)sstr)) {
10089 SV **dst_ary, **src_ary;
10090 SSize_t items = AvFILLp((AV*)sstr) + 1;
10092 src_ary = AvARRAY((AV*)sstr);
10093 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10094 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10095 SvPV_set(dstr, (char*)dst_ary);
10096 AvALLOC((AV*)dstr) = dst_ary;
10097 if (AvREAL((AV*)sstr)) {
10098 while (items-- > 0)
10099 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10102 while (items-- > 0)
10103 *dst_ary++ = sv_dup(*src_ary++, param);
10105 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10106 while (items-- > 0) {
10107 *dst_ary++ = &PL_sv_undef;
10111 SvPV_set(dstr, NULL);
10112 AvALLOC((AV*)dstr) = (SV**)NULL;
10117 HEK *hvname = NULL;
10119 if (HvARRAY((HV*)sstr)) {
10121 const bool sharekeys = !!HvSHAREKEYS(sstr);
10122 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10123 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10125 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10126 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10128 HvARRAY(dstr) = (HE**)darray;
10129 while (i <= sxhv->xhv_max) {
10130 const HE *source = HvARRAY(sstr)[i];
10131 HvARRAY(dstr)[i] = source
10132 ? he_dup(source, sharekeys, param) : 0;
10136 struct xpvhv_aux * const saux = HvAUX(sstr);
10137 struct xpvhv_aux * const daux = HvAUX(dstr);
10138 /* This flag isn't copied. */
10139 /* SvOOK_on(hv) attacks the IV flags. */
10140 SvFLAGS(dstr) |= SVf_OOK;
10142 hvname = saux->xhv_name;
10144 = hvname ? hek_dup(hvname, param) : hvname;
10146 daux->xhv_riter = saux->xhv_riter;
10147 daux->xhv_eiter = saux->xhv_eiter
10148 ? he_dup(saux->xhv_eiter,
10149 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10150 daux->xhv_backreferences = saux->xhv_backreferences
10151 ? (AV*) SvREFCNT_inc(
10153 xhv_backreferences,
10159 SvPV_set(dstr, NULL);
10161 /* Record stashes for possible cloning in Perl_clone(). */
10163 av_push(param->stashes, dstr);
10167 if (!(param->flags & CLONEf_COPY_STACKS)) {
10171 /* NOTE: not refcounted */
10172 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10174 if (!CvISXSUB(dstr))
10175 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10177 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10178 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10179 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10180 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10182 /* don't dup if copying back - CvGV isn't refcounted, so the
10183 * duped GV may never be freed. A bit of a hack! DAPM */
10184 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10185 NULL : gv_dup(CvGV(dstr), param) ;
10186 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10188 CvWEAKOUTSIDE(sstr)
10189 ? cv_dup( CvOUTSIDE(dstr), param)
10190 : cv_dup_inc(CvOUTSIDE(dstr), param);
10191 if (!CvISXSUB(dstr))
10192 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10198 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10204 /* duplicate a context */
10207 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10209 PERL_CONTEXT *ncxs;
10212 return (PERL_CONTEXT*)NULL;
10214 /* look for it in the table first */
10215 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10219 /* create anew and remember what it is */
10220 Newxz(ncxs, max + 1, PERL_CONTEXT);
10221 ptr_table_store(PL_ptr_table, cxs, ncxs);
10224 PERL_CONTEXT * const cx = &cxs[ix];
10225 PERL_CONTEXT * const ncx = &ncxs[ix];
10226 ncx->cx_type = cx->cx_type;
10227 if (CxTYPE(cx) == CXt_SUBST) {
10228 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10231 ncx->blk_oldsp = cx->blk_oldsp;
10232 ncx->blk_oldcop = cx->blk_oldcop;
10233 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10234 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10235 ncx->blk_oldpm = cx->blk_oldpm;
10236 ncx->blk_gimme = cx->blk_gimme;
10237 switch (CxTYPE(cx)) {
10239 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10240 ? cv_dup_inc(cx->blk_sub.cv, param)
10241 : cv_dup(cx->blk_sub.cv,param));
10242 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10243 ? av_dup_inc(cx->blk_sub.argarray, param)
10245 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10246 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10247 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10248 ncx->blk_sub.lval = cx->blk_sub.lval;
10249 ncx->blk_sub.retop = cx->blk_sub.retop;
10252 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10253 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10254 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10255 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10256 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10257 ncx->blk_eval.retop = cx->blk_eval.retop;
10260 ncx->blk_loop.label = cx->blk_loop.label;
10261 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10262 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
10263 ncx->blk_loop.next_op = cx->blk_loop.next_op;
10264 ncx->blk_loop.last_op = cx->blk_loop.last_op;
10265 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10266 ? cx->blk_loop.iterdata
10267 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10268 ncx->blk_loop.oldcomppad
10269 = (PAD*)ptr_table_fetch(PL_ptr_table,
10270 cx->blk_loop.oldcomppad);
10271 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10272 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10273 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10274 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10275 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10278 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10279 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10280 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10281 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10282 ncx->blk_sub.retop = cx->blk_sub.retop;
10294 /* duplicate a stack info structure */
10297 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10302 return (PERL_SI*)NULL;
10304 /* look for it in the table first */
10305 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10309 /* create anew and remember what it is */
10310 Newxz(nsi, 1, PERL_SI);
10311 ptr_table_store(PL_ptr_table, si, nsi);
10313 nsi->si_stack = av_dup_inc(si->si_stack, param);
10314 nsi->si_cxix = si->si_cxix;
10315 nsi->si_cxmax = si->si_cxmax;
10316 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10317 nsi->si_type = si->si_type;
10318 nsi->si_prev = si_dup(si->si_prev, param);
10319 nsi->si_next = si_dup(si->si_next, param);
10320 nsi->si_markoff = si->si_markoff;
10325 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10326 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10327 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10328 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10329 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10330 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10331 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10332 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10333 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10334 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10335 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10336 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10337 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10338 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10341 #define pv_dup_inc(p) SAVEPV(p)
10342 #define pv_dup(p) SAVEPV(p)
10343 #define svp_dup_inc(p,pp) any_dup(p,pp)
10345 /* map any object to the new equivent - either something in the
10346 * ptr table, or something in the interpreter structure
10350 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10355 return (void*)NULL;
10357 /* look for it in the table first */
10358 ret = ptr_table_fetch(PL_ptr_table, v);
10362 /* see if it is part of the interpreter structure */
10363 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10364 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10372 /* duplicate the save stack */
10375 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10377 ANY * const ss = proto_perl->Tsavestack;
10378 const I32 max = proto_perl->Tsavestack_max;
10379 I32 ix = proto_perl->Tsavestack_ix;
10391 void (*dptr) (void*);
10392 void (*dxptr) (pTHX_ void*);
10394 Newxz(nss, max, ANY);
10397 I32 i = POPINT(ss,ix);
10398 TOPINT(nss,ix) = i;
10400 case SAVEt_ITEM: /* normal string */
10401 case SAVEt_SV: /* scalar reference */
10402 sv = (SV*)POPPTR(ss,ix);
10403 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10404 sv = (SV*)POPPTR(ss,ix);
10405 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10407 case SAVEt_SHARED_PVREF: /* char* in shared space */
10408 c = (char*)POPPTR(ss,ix);
10409 TOPPTR(nss,ix) = savesharedpv(c);
10410 ptr = POPPTR(ss,ix);
10411 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10413 case SAVEt_GENERIC_SVREF: /* generic sv */
10414 case SAVEt_SVREF: /* scalar reference */
10415 sv = (SV*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10417 ptr = POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10420 case SAVEt_HV: /* hash reference */
10421 case SAVEt_AV: /* array reference */
10422 sv = POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10424 gv = (GV*)POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = gv_dup(gv, param);
10427 case SAVEt_INT: /* int reference */
10428 ptr = POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10430 intval = (int)POPINT(ss,ix);
10431 TOPINT(nss,ix) = intval;
10433 case SAVEt_LONG: /* long reference */
10434 ptr = POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10436 longval = (long)POPLONG(ss,ix);
10437 TOPLONG(nss,ix) = longval;
10439 case SAVEt_I32: /* I32 reference */
10440 case SAVEt_I16: /* I16 reference */
10441 case SAVEt_I8: /* I8 reference */
10442 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10443 ptr = POPPTR(ss,ix);
10444 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10446 TOPINT(nss,ix) = i;
10448 case SAVEt_IV: /* IV reference */
10449 ptr = POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10452 TOPIV(nss,ix) = iv;
10454 case SAVEt_HPTR: /* HV* reference */
10455 case SAVEt_APTR: /* AV* reference */
10456 case SAVEt_SPTR: /* SV* reference */
10457 ptr = POPPTR(ss,ix);
10458 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10459 sv = (SV*)POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = sv_dup(sv, param);
10462 case SAVEt_VPTR: /* random* reference */
10463 ptr = POPPTR(ss,ix);
10464 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10465 ptr = POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10468 case SAVEt_GENERIC_PVREF: /* generic char* */
10469 case SAVEt_PPTR: /* char* reference */
10470 ptr = POPPTR(ss,ix);
10471 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10472 c = (char*)POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = pv_dup(c);
10476 gv = (GV*)POPPTR(ss,ix);
10477 TOPPTR(nss,ix) = gv_dup(gv, param);
10479 case SAVEt_GP: /* scalar reference */
10480 gp = (GP*)POPPTR(ss,ix);
10481 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10482 (void)GpREFCNT_inc(gp);
10483 gv = (GV*)POPPTR(ss,ix);
10484 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10485 c = (char*)POPPTR(ss,ix);
10486 TOPPTR(nss,ix) = pv_dup(c);
10488 TOPIV(nss,ix) = iv;
10490 TOPIV(nss,ix) = iv;
10493 case SAVEt_MORTALIZESV:
10494 sv = (SV*)POPPTR(ss,ix);
10495 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10498 ptr = POPPTR(ss,ix);
10499 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10500 /* these are assumed to be refcounted properly */
10502 switch (((OP*)ptr)->op_type) {
10504 case OP_LEAVESUBLV:
10508 case OP_LEAVEWRITE:
10509 TOPPTR(nss,ix) = ptr;
10514 TOPPTR(nss,ix) = NULL;
10519 TOPPTR(nss,ix) = NULL;
10522 c = (char*)POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = pv_dup_inc(c);
10525 case SAVEt_CLEARSV:
10526 longval = POPLONG(ss,ix);
10527 TOPLONG(nss,ix) = longval;
10530 hv = (HV*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10532 c = (char*)POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = pv_dup_inc(c);
10535 TOPINT(nss,ix) = i;
10537 case SAVEt_DESTRUCTOR:
10538 ptr = POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10540 dptr = POPDPTR(ss,ix);
10541 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10542 any_dup(FPTR2DPTR(void *, dptr),
10545 case SAVEt_DESTRUCTOR_X:
10546 ptr = POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10548 dxptr = POPDXPTR(ss,ix);
10549 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10550 any_dup(FPTR2DPTR(void *, dxptr),
10553 case SAVEt_REGCONTEXT:
10556 TOPINT(nss,ix) = i;
10559 case SAVEt_STACK_POS: /* Position on Perl stack */
10561 TOPINT(nss,ix) = i;
10563 case SAVEt_AELEM: /* array element */
10564 sv = (SV*)POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10567 TOPINT(nss,ix) = i;
10568 av = (AV*)POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = av_dup_inc(av, param);
10571 case SAVEt_HELEM: /* hash element */
10572 sv = (SV*)POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10574 sv = (SV*)POPPTR(ss,ix);
10575 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10576 hv = (HV*)POPPTR(ss,ix);
10577 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10580 ptr = POPPTR(ss,ix);
10581 TOPPTR(nss,ix) = ptr;
10585 TOPINT(nss,ix) = i;
10586 ptr = POPPTR(ss,ix);
10589 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10590 HINTS_REFCNT_UNLOCK;
10592 TOPPTR(nss,ix) = ptr;
10593 if (i & HINT_LOCALIZE_HH) {
10594 hv = (HV*)POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10598 case SAVEt_COMPPAD:
10599 av = (AV*)POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = av_dup(av, param);
10603 longval = (long)POPLONG(ss,ix);
10604 TOPLONG(nss,ix) = longval;
10605 ptr = POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10607 sv = (SV*)POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = sv_dup(sv, param);
10611 ptr = POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10613 longval = (long)POPBOOL(ss,ix);
10614 TOPBOOL(nss,ix) = (bool)longval;
10616 case SAVEt_SET_SVFLAGS:
10618 TOPINT(nss,ix) = i;
10620 TOPINT(nss,ix) = i;
10621 sv = (SV*)POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = sv_dup(sv, param);
10624 case SAVEt_RE_STATE:
10626 const struct re_save_state *const old_state
10627 = (struct re_save_state *)
10628 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10629 struct re_save_state *const new_state
10630 = (struct re_save_state *)
10631 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10633 Copy(old_state, new_state, 1, struct re_save_state);
10634 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10636 new_state->re_state_bostr
10637 = pv_dup(old_state->re_state_bostr);
10638 new_state->re_state_reginput
10639 = pv_dup(old_state->re_state_reginput);
10640 new_state->re_state_regeol
10641 = pv_dup(old_state->re_state_regeol);
10642 new_state->re_state_regstartp
10643 = any_dup(old_state->re_state_regstartp, proto_perl);
10644 new_state->re_state_regendp
10645 = any_dup(old_state->re_state_regendp, proto_perl);
10646 new_state->re_state_reglastparen
10647 = any_dup(old_state->re_state_reglastparen, proto_perl);
10648 new_state->re_state_reglastcloseparen
10649 = any_dup(old_state->re_state_reglastcloseparen,
10651 /* XXX This just has to be broken. The old save_re_context
10652 code did SAVEGENERICPV(PL_reg_start_tmp);
10653 PL_reg_start_tmp is char **.
10654 Look above to what the dup code does for
10655 SAVEt_GENERIC_PVREF
10656 It can never have worked.
10657 So this is merely a faithful copy of the exiting bug: */
10658 new_state->re_state_reg_start_tmp
10659 = (char **) pv_dup((char *)
10660 old_state->re_state_reg_start_tmp);
10661 /* I assume that it only ever "worked" because no-one called
10662 (pseudo)fork while the regexp engine had re-entered itself.
10664 #ifdef PERL_OLD_COPY_ON_WRITE
10665 new_state->re_state_nrs
10666 = sv_dup(old_state->re_state_nrs, param);
10668 new_state->re_state_reg_magic
10669 = any_dup(old_state->re_state_reg_magic, proto_perl);
10670 new_state->re_state_reg_oldcurpm
10671 = any_dup(old_state->re_state_reg_oldcurpm, proto_perl);
10672 new_state->re_state_reg_curpm
10673 = any_dup(old_state->re_state_reg_curpm, proto_perl);
10674 new_state->re_state_reg_oldsaved
10675 = pv_dup(old_state->re_state_reg_oldsaved);
10676 new_state->re_state_reg_poscache
10677 = pv_dup(old_state->re_state_reg_poscache);
10679 new_state->re_state_reg_starttry
10680 = pv_dup(old_state->re_state_reg_starttry);
10684 case SAVEt_COMPILE_WARNINGS:
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10689 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10697 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10698 * flag to the result. This is done for each stash before cloning starts,
10699 * so we know which stashes want their objects cloned */
10702 do_mark_cloneable_stash(pTHX_ SV *sv)
10704 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10706 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10707 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10708 if (cloner && GvCV(cloner)) {
10715 XPUSHs(sv_2mortal(newSVhek(hvname)));
10717 call_sv((SV*)GvCV(cloner), G_SCALAR);
10724 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10732 =for apidoc perl_clone
10734 Create and return a new interpreter by cloning the current one.
10736 perl_clone takes these flags as parameters:
10738 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10739 without it we only clone the data and zero the stacks,
10740 with it we copy the stacks and the new perl interpreter is
10741 ready to run at the exact same point as the previous one.
10742 The pseudo-fork code uses COPY_STACKS while the
10743 threads->new doesn't.
10745 CLONEf_KEEP_PTR_TABLE
10746 perl_clone keeps a ptr_table with the pointer of the old
10747 variable as a key and the new variable as a value,
10748 this allows it to check if something has been cloned and not
10749 clone it again but rather just use the value and increase the
10750 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10751 the ptr_table using the function
10752 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10753 reason to keep it around is if you want to dup some of your own
10754 variable who are outside the graph perl scans, example of this
10755 code is in threads.xs create
10758 This is a win32 thing, it is ignored on unix, it tells perls
10759 win32host code (which is c++) to clone itself, this is needed on
10760 win32 if you want to run two threads at the same time,
10761 if you just want to do some stuff in a separate perl interpreter
10762 and then throw it away and return to the original one,
10763 you don't need to do anything.
10768 /* XXX the above needs expanding by someone who actually understands it ! */
10769 EXTERN_C PerlInterpreter *
10770 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10773 perl_clone(PerlInterpreter *proto_perl, UV flags)
10776 #ifdef PERL_IMPLICIT_SYS
10778 /* perlhost.h so we need to call into it
10779 to clone the host, CPerlHost should have a c interface, sky */
10781 if (flags & CLONEf_CLONE_HOST) {
10782 return perl_clone_host(proto_perl,flags);
10784 return perl_clone_using(proto_perl, flags,
10786 proto_perl->IMemShared,
10787 proto_perl->IMemParse,
10789 proto_perl->IStdIO,
10793 proto_perl->IProc);
10797 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10798 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10799 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10800 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10801 struct IPerlDir* ipD, struct IPerlSock* ipS,
10802 struct IPerlProc* ipP)
10804 /* XXX many of the string copies here can be optimized if they're
10805 * constants; they need to be allocated as common memory and just
10806 * their pointers copied. */
10809 CLONE_PARAMS clone_params;
10810 CLONE_PARAMS* const param = &clone_params;
10812 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10813 /* for each stash, determine whether its objects should be cloned */
10814 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10815 PERL_SET_THX(my_perl);
10818 PoisonNew(my_perl, 1, PerlInterpreter);
10824 PL_savestack_ix = 0;
10825 PL_savestack_max = -1;
10826 PL_sig_pending = 0;
10827 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10828 # else /* !DEBUGGING */
10829 Zero(my_perl, 1, PerlInterpreter);
10830 # endif /* DEBUGGING */
10832 /* host pointers */
10834 PL_MemShared = ipMS;
10835 PL_MemParse = ipMP;
10842 #else /* !PERL_IMPLICIT_SYS */
10844 CLONE_PARAMS clone_params;
10845 CLONE_PARAMS* param = &clone_params;
10846 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10847 /* for each stash, determine whether its objects should be cloned */
10848 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10849 PERL_SET_THX(my_perl);
10852 PoisonNew(my_perl, 1, PerlInterpreter);
10858 PL_savestack_ix = 0;
10859 PL_savestack_max = -1;
10860 PL_sig_pending = 0;
10861 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10862 # else /* !DEBUGGING */
10863 Zero(my_perl, 1, PerlInterpreter);
10864 # endif /* DEBUGGING */
10865 #endif /* PERL_IMPLICIT_SYS */
10866 param->flags = flags;
10867 param->proto_perl = proto_perl;
10869 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10871 PL_body_arenas = NULL;
10872 Zero(&PL_body_roots, 1, PL_body_roots);
10874 PL_nice_chunk = NULL;
10875 PL_nice_chunk_size = 0;
10877 PL_sv_objcount = 0;
10879 PL_sv_arenaroot = NULL;
10881 PL_debug = proto_perl->Idebug;
10883 PL_hash_seed = proto_perl->Ihash_seed;
10884 PL_rehash_seed = proto_perl->Irehash_seed;
10886 #ifdef USE_REENTRANT_API
10887 /* XXX: things like -Dm will segfault here in perlio, but doing
10888 * PERL_SET_CONTEXT(proto_perl);
10889 * breaks too many other things
10891 Perl_reentrant_init(aTHX);
10894 /* create SV map for pointer relocation */
10895 PL_ptr_table = ptr_table_new();
10897 /* initialize these special pointers as early as possible */
10898 SvANY(&PL_sv_undef) = NULL;
10899 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10900 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10901 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10903 SvANY(&PL_sv_no) = new_XPVNV();
10904 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10905 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10906 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10907 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
10908 SvCUR_set(&PL_sv_no, 0);
10909 SvLEN_set(&PL_sv_no, 1);
10910 SvIV_set(&PL_sv_no, 0);
10911 SvNV_set(&PL_sv_no, 0);
10912 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10914 SvANY(&PL_sv_yes) = new_XPVNV();
10915 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10916 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10917 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10918 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
10919 SvCUR_set(&PL_sv_yes, 1);
10920 SvLEN_set(&PL_sv_yes, 2);
10921 SvIV_set(&PL_sv_yes, 1);
10922 SvNV_set(&PL_sv_yes, 1);
10923 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10925 /* create (a non-shared!) shared string table */
10926 PL_strtab = newHV();
10927 HvSHAREKEYS_off(PL_strtab);
10928 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10929 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10931 PL_compiling = proto_perl->Icompiling;
10933 /* These two PVs will be free'd special way so must set them same way op.c does */
10934 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10935 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10937 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10938 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10940 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10941 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10942 if (!specialCopIO(PL_compiling.cop_io))
10943 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
10944 if (PL_compiling.cop_hints) {
10946 PL_compiling.cop_hints->refcounted_he_refcnt++;
10947 HINTS_REFCNT_UNLOCK;
10949 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10951 /* pseudo environmental stuff */
10952 PL_origargc = proto_perl->Iorigargc;
10953 PL_origargv = proto_perl->Iorigargv;
10955 param->stashes = newAV(); /* Setup array of objects to call clone on */
10957 /* Set tainting stuff before PerlIO_debug can possibly get called */
10958 PL_tainting = proto_perl->Itainting;
10959 PL_taint_warn = proto_perl->Itaint_warn;
10961 #ifdef PERLIO_LAYERS
10962 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10963 PerlIO_clone(aTHX_ proto_perl, param);
10966 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10967 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10968 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10969 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10970 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10971 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10974 PL_minus_c = proto_perl->Iminus_c;
10975 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10976 PL_localpatches = proto_perl->Ilocalpatches;
10977 PL_splitstr = proto_perl->Isplitstr;
10978 PL_preprocess = proto_perl->Ipreprocess;
10979 PL_minus_n = proto_perl->Iminus_n;
10980 PL_minus_p = proto_perl->Iminus_p;
10981 PL_minus_l = proto_perl->Iminus_l;
10982 PL_minus_a = proto_perl->Iminus_a;
10983 PL_minus_E = proto_perl->Iminus_E;
10984 PL_minus_F = proto_perl->Iminus_F;
10985 PL_doswitches = proto_perl->Idoswitches;
10986 PL_dowarn = proto_perl->Idowarn;
10987 PL_doextract = proto_perl->Idoextract;
10988 PL_sawampersand = proto_perl->Isawampersand;
10989 PL_unsafe = proto_perl->Iunsafe;
10990 PL_inplace = SAVEPV(proto_perl->Iinplace);
10991 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10992 PL_perldb = proto_perl->Iperldb;
10993 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10994 PL_exit_flags = proto_perl->Iexit_flags;
10996 /* magical thingies */
10997 /* XXX time(&PL_basetime) when asked for? */
10998 PL_basetime = proto_perl->Ibasetime;
10999 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11001 PL_maxsysfd = proto_perl->Imaxsysfd;
11002 PL_statusvalue = proto_perl->Istatusvalue;
11004 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11006 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11008 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11010 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11011 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11012 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11014 /* Clone the regex array */
11015 PL_regex_padav = newAV();
11017 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11018 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11020 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11021 for(i = 1; i <= len; i++) {
11022 const SV * const regex = regexen[i];
11025 ? sv_dup_inc(regex, param)
11027 newSViv(PTR2IV(re_dup(
11028 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11030 av_push(PL_regex_padav, sv);
11033 PL_regex_pad = AvARRAY(PL_regex_padav);
11035 /* shortcuts to various I/O objects */
11036 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11037 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11038 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11039 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11040 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11041 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11043 /* shortcuts to regexp stuff */
11044 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11046 /* shortcuts to misc objects */
11047 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11049 /* shortcuts to debugging objects */
11050 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11051 PL_DBline = gv_dup(proto_perl->IDBline, param);
11052 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11053 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11054 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11055 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11056 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11057 PL_lineary = av_dup(proto_perl->Ilineary, param);
11058 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11060 /* symbol tables */
11061 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11062 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11063 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11064 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11065 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11067 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11068 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11069 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11070 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11071 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11072 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11074 PL_sub_generation = proto_perl->Isub_generation;
11076 /* funky return mechanisms */
11077 PL_forkprocess = proto_perl->Iforkprocess;
11079 /* subprocess state */
11080 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11082 /* internal state */
11083 PL_maxo = proto_perl->Imaxo;
11084 if (proto_perl->Iop_mask)
11085 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11088 /* PL_asserting = proto_perl->Iasserting; */
11090 /* current interpreter roots */
11091 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11092 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11093 PL_main_start = proto_perl->Imain_start;
11094 PL_eval_root = proto_perl->Ieval_root;
11095 PL_eval_start = proto_perl->Ieval_start;
11097 /* runtime control stuff */
11098 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11099 PL_copline = proto_perl->Icopline;
11101 PL_filemode = proto_perl->Ifilemode;
11102 PL_lastfd = proto_perl->Ilastfd;
11103 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11106 PL_gensym = proto_perl->Igensym;
11107 PL_preambled = proto_perl->Ipreambled;
11108 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11109 PL_laststatval = proto_perl->Ilaststatval;
11110 PL_laststype = proto_perl->Ilaststype;
11113 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11115 /* interpreter atexit processing */
11116 PL_exitlistlen = proto_perl->Iexitlistlen;
11117 if (PL_exitlistlen) {
11118 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11119 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11122 PL_exitlist = (PerlExitListEntry*)NULL;
11124 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11125 if (PL_my_cxt_size) {
11126 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11127 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11130 PL_my_cxt_list = (void**)NULL;
11131 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11132 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11133 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11135 PL_profiledata = NULL;
11136 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11137 /* PL_rsfp_filters entries have fake IoDIRP() */
11138 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11140 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11142 PAD_CLONE_VARS(proto_perl, param);
11144 #ifdef HAVE_INTERP_INTERN
11145 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11148 /* more statics moved here */
11149 PL_generation = proto_perl->Igeneration;
11150 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11152 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11153 PL_in_clean_all = proto_perl->Iin_clean_all;
11155 PL_uid = proto_perl->Iuid;
11156 PL_euid = proto_perl->Ieuid;
11157 PL_gid = proto_perl->Igid;
11158 PL_egid = proto_perl->Iegid;
11159 PL_nomemok = proto_perl->Inomemok;
11160 PL_an = proto_perl->Ian;
11161 PL_evalseq = proto_perl->Ievalseq;
11162 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11163 PL_origalen = proto_perl->Iorigalen;
11164 #ifdef PERL_USES_PL_PIDSTATUS
11165 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11167 PL_osname = SAVEPV(proto_perl->Iosname);
11168 PL_sighandlerp = proto_perl->Isighandlerp;
11170 PL_runops = proto_perl->Irunops;
11172 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11175 PL_cshlen = proto_perl->Icshlen;
11176 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11179 PL_lex_state = proto_perl->Ilex_state;
11180 PL_lex_defer = proto_perl->Ilex_defer;
11181 PL_lex_expect = proto_perl->Ilex_expect;
11182 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11183 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11184 PL_lex_starts = proto_perl->Ilex_starts;
11185 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11186 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11187 PL_lex_op = proto_perl->Ilex_op;
11188 PL_lex_inpat = proto_perl->Ilex_inpat;
11189 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11190 PL_lex_brackets = proto_perl->Ilex_brackets;
11191 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11192 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11193 PL_lex_casemods = proto_perl->Ilex_casemods;
11194 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11195 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11198 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11199 PL_lasttoke = proto_perl->Ilasttoke;
11200 PL_realtokenstart = proto_perl->Irealtokenstart;
11201 PL_faketokens = proto_perl->Ifaketokens;
11202 PL_thismad = proto_perl->Ithismad;
11203 PL_thistoken = proto_perl->Ithistoken;
11204 PL_thisopen = proto_perl->Ithisopen;
11205 PL_thisstuff = proto_perl->Ithisstuff;
11206 PL_thisclose = proto_perl->Ithisclose;
11207 PL_thiswhite = proto_perl->Ithiswhite;
11208 PL_nextwhite = proto_perl->Inextwhite;
11209 PL_skipwhite = proto_perl->Iskipwhite;
11210 PL_endwhite = proto_perl->Iendwhite;
11211 PL_curforce = proto_perl->Icurforce;
11213 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11214 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11215 PL_nexttoke = proto_perl->Inexttoke;
11218 /* XXX This is probably masking the deeper issue of why
11219 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11220 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11221 * (A little debugging with a watchpoint on it may help.)
11223 if (SvANY(proto_perl->Ilinestr)) {
11224 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11225 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11226 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11227 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11228 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11229 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11230 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11231 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11232 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11235 PL_linestr = newSV(79);
11236 sv_upgrade(PL_linestr,SVt_PVIV);
11237 sv_setpvn(PL_linestr,"",0);
11238 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11240 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11241 PL_pending_ident = proto_perl->Ipending_ident;
11242 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11244 PL_expect = proto_perl->Iexpect;
11246 PL_multi_start = proto_perl->Imulti_start;
11247 PL_multi_end = proto_perl->Imulti_end;
11248 PL_multi_open = proto_perl->Imulti_open;
11249 PL_multi_close = proto_perl->Imulti_close;
11251 PL_error_count = proto_perl->Ierror_count;
11252 PL_subline = proto_perl->Isubline;
11253 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11255 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11256 if (SvANY(proto_perl->Ilinestr)) {
11257 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11258 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11259 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11260 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11261 PL_last_lop_op = proto_perl->Ilast_lop_op;
11264 PL_last_uni = SvPVX(PL_linestr);
11265 PL_last_lop = SvPVX(PL_linestr);
11266 PL_last_lop_op = 0;
11268 PL_in_my = proto_perl->Iin_my;
11269 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11271 PL_cryptseen = proto_perl->Icryptseen;
11274 PL_hints = proto_perl->Ihints;
11276 PL_amagic_generation = proto_perl->Iamagic_generation;
11278 #ifdef USE_LOCALE_COLLATE
11279 PL_collation_ix = proto_perl->Icollation_ix;
11280 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11281 PL_collation_standard = proto_perl->Icollation_standard;
11282 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11283 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11284 #endif /* USE_LOCALE_COLLATE */
11286 #ifdef USE_LOCALE_NUMERIC
11287 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11288 PL_numeric_standard = proto_perl->Inumeric_standard;
11289 PL_numeric_local = proto_perl->Inumeric_local;
11290 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11291 #endif /* !USE_LOCALE_NUMERIC */
11293 /* utf8 character classes */
11294 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11295 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11296 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11297 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11298 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11299 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11300 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11301 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11302 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11303 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11304 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11305 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11306 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11307 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11308 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11309 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11310 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11311 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11312 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11313 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11315 /* Did the locale setup indicate UTF-8? */
11316 PL_utf8locale = proto_perl->Iutf8locale;
11317 /* Unicode features (see perlrun/-C) */
11318 PL_unicode = proto_perl->Iunicode;
11320 /* Pre-5.8 signals control */
11321 PL_signals = proto_perl->Isignals;
11323 /* times() ticks per second */
11324 PL_clocktick = proto_perl->Iclocktick;
11326 /* Recursion stopper for PerlIO_find_layer */
11327 PL_in_load_module = proto_perl->Iin_load_module;
11329 /* sort() routine */
11330 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11332 /* Not really needed/useful since the reenrant_retint is "volatile",
11333 * but do it for consistency's sake. */
11334 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11336 /* Hooks to shared SVs and locks. */
11337 PL_sharehook = proto_perl->Isharehook;
11338 PL_lockhook = proto_perl->Ilockhook;
11339 PL_unlockhook = proto_perl->Iunlockhook;
11340 PL_threadhook = proto_perl->Ithreadhook;
11342 PL_runops_std = proto_perl->Irunops_std;
11343 PL_runops_dbg = proto_perl->Irunops_dbg;
11345 #ifdef THREADS_HAVE_PIDS
11346 PL_ppid = proto_perl->Ippid;
11350 PL_last_swash_hv = NULL; /* reinits on demand */
11351 PL_last_swash_klen = 0;
11352 PL_last_swash_key[0]= '\0';
11353 PL_last_swash_tmps = (U8*)NULL;
11354 PL_last_swash_slen = 0;
11356 PL_glob_index = proto_perl->Iglob_index;
11357 PL_srand_called = proto_perl->Isrand_called;
11358 PL_uudmap['M'] = 0; /* reinits on demand */
11359 PL_bitcount = NULL; /* reinits on demand */
11361 if (proto_perl->Ipsig_pend) {
11362 Newxz(PL_psig_pend, SIG_SIZE, int);
11365 PL_psig_pend = (int*)NULL;
11368 if (proto_perl->Ipsig_ptr) {
11369 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11370 Newxz(PL_psig_name, SIG_SIZE, SV*);
11371 for (i = 1; i < SIG_SIZE; i++) {
11372 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11373 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11377 PL_psig_ptr = (SV**)NULL;
11378 PL_psig_name = (SV**)NULL;
11381 /* thrdvar.h stuff */
11383 if (flags & CLONEf_COPY_STACKS) {
11384 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11385 PL_tmps_ix = proto_perl->Ttmps_ix;
11386 PL_tmps_max = proto_perl->Ttmps_max;
11387 PL_tmps_floor = proto_perl->Ttmps_floor;
11388 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11390 while (i <= PL_tmps_ix) {
11391 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11395 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11396 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11397 Newxz(PL_markstack, i, I32);
11398 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11399 - proto_perl->Tmarkstack);
11400 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11401 - proto_perl->Tmarkstack);
11402 Copy(proto_perl->Tmarkstack, PL_markstack,
11403 PL_markstack_ptr - PL_markstack + 1, I32);
11405 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11406 * NOTE: unlike the others! */
11407 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11408 PL_scopestack_max = proto_perl->Tscopestack_max;
11409 Newxz(PL_scopestack, PL_scopestack_max, I32);
11410 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11412 /* NOTE: si_dup() looks at PL_markstack */
11413 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11415 /* PL_curstack = PL_curstackinfo->si_stack; */
11416 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11417 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11419 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11420 PL_stack_base = AvARRAY(PL_curstack);
11421 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11422 - proto_perl->Tstack_base);
11423 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11425 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11426 * NOTE: unlike the others! */
11427 PL_savestack_ix = proto_perl->Tsavestack_ix;
11428 PL_savestack_max = proto_perl->Tsavestack_max;
11429 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11430 PL_savestack = ss_dup(proto_perl, param);
11434 ENTER; /* perl_destruct() wants to LEAVE; */
11436 /* although we're not duplicating the tmps stack, we should still
11437 * add entries for any SVs on the tmps stack that got cloned by a
11438 * non-refcount means (eg a temp in @_); otherwise they will be
11441 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11442 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11443 proto_perl->Ttmps_stack[i]);
11444 if (nsv && !SvREFCNT(nsv)) {
11446 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11451 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11452 PL_top_env = &PL_start_env;
11454 PL_op = proto_perl->Top;
11457 PL_Xpv = (XPV*)NULL;
11458 PL_na = proto_perl->Tna;
11460 PL_statbuf = proto_perl->Tstatbuf;
11461 PL_statcache = proto_perl->Tstatcache;
11462 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11463 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11465 PL_timesbuf = proto_perl->Ttimesbuf;
11468 PL_tainted = proto_perl->Ttainted;
11469 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11470 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11471 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11472 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11473 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11474 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11475 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11476 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11477 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11479 PL_restartop = proto_perl->Trestartop;
11480 PL_in_eval = proto_perl->Tin_eval;
11481 PL_delaymagic = proto_perl->Tdelaymagic;
11482 PL_dirty = proto_perl->Tdirty;
11483 PL_localizing = proto_perl->Tlocalizing;
11485 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11486 PL_hv_fetch_ent_mh = NULL;
11487 PL_modcount = proto_perl->Tmodcount;
11488 PL_lastgotoprobe = NULL;
11489 PL_dumpindent = proto_perl->Tdumpindent;
11491 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11492 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11493 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11494 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11495 PL_efloatbuf = NULL; /* reinits on demand */
11496 PL_efloatsize = 0; /* reinits on demand */
11500 PL_screamfirst = NULL;
11501 PL_screamnext = NULL;
11502 PL_maxscream = -1; /* reinits on demand */
11503 PL_lastscream = NULL;
11505 PL_watchaddr = NULL;
11508 PL_regdummy = proto_perl->Tregdummy;
11509 PL_colorset = 0; /* reinits PL_colors[] */
11510 /*PL_colors[6] = {0,0,0,0,0,0};*/
11512 /* RE engine - function pointers */
11513 PL_regcompp = proto_perl->Tregcompp;
11514 PL_regexecp = proto_perl->Tregexecp;
11515 PL_regint_start = proto_perl->Tregint_start;
11516 PL_regint_string = proto_perl->Tregint_string;
11517 PL_regfree = proto_perl->Tregfree;
11518 Zero(&PL_reg_state, 1, struct re_save_state);
11519 PL_reginterp_cnt = 0;
11520 PL_regmatch_slab = NULL;
11522 /* Pluggable optimizer */
11523 PL_peepp = proto_perl->Tpeepp;
11525 PL_stashcache = newHV();
11527 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11528 ptr_table_free(PL_ptr_table);
11529 PL_ptr_table = NULL;
11532 /* Call the ->CLONE method, if it exists, for each of the stashes
11533 identified by sv_dup() above.
11535 while(av_len(param->stashes) != -1) {
11536 HV* const stash = (HV*) av_shift(param->stashes);
11537 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11538 if (cloner && GvCV(cloner)) {
11543 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11545 call_sv((SV*)GvCV(cloner), G_DISCARD);
11551 SvREFCNT_dec(param->stashes);
11553 /* orphaned? eg threads->new inside BEGIN or use */
11554 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11555 SvREFCNT_inc_simple_void(PL_compcv);
11556 SAVEFREESV(PL_compcv);
11562 #endif /* USE_ITHREADS */
11565 =head1 Unicode Support
11567 =for apidoc sv_recode_to_utf8
11569 The encoding is assumed to be an Encode object, on entry the PV
11570 of the sv is assumed to be octets in that encoding, and the sv
11571 will be converted into Unicode (and UTF-8).
11573 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11574 is not a reference, nothing is done to the sv. If the encoding is not
11575 an C<Encode::XS> Encoding object, bad things will happen.
11576 (See F<lib/encoding.pm> and L<Encode>).
11578 The PV of the sv is returned.
11583 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11586 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11600 Passing sv_yes is wrong - it needs to be or'ed set of constants
11601 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11602 remove converted chars from source.
11604 Both will default the value - let them.
11606 XPUSHs(&PL_sv_yes);
11609 call_method("decode", G_SCALAR);
11613 s = SvPV_const(uni, len);
11614 if (s != SvPVX_const(sv)) {
11615 SvGROW(sv, len + 1);
11616 Move(s, SvPVX(sv), len + 1, char);
11617 SvCUR_set(sv, len);
11624 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11628 =for apidoc sv_cat_decode
11630 The encoding is assumed to be an Encode object, the PV of the ssv is
11631 assumed to be octets in that encoding and decoding the input starts
11632 from the position which (PV + *offset) pointed to. The dsv will be
11633 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11634 when the string tstr appears in decoding output or the input ends on
11635 the PV of the ssv. The value which the offset points will be modified
11636 to the last input position on the ssv.
11638 Returns TRUE if the terminator was found, else returns FALSE.
11643 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11644 SV *ssv, int *offset, char *tstr, int tlen)
11648 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11659 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11660 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11662 call_method("cat_decode", G_SCALAR);
11664 ret = SvTRUE(TOPs);
11665 *offset = SvIV(offsv);
11671 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11676 /* ---------------------------------------------------------------------
11678 * support functions for report_uninit()
11681 /* the maxiumum size of array or hash where we will scan looking
11682 * for the undefined element that triggered the warning */
11684 #define FUV_MAX_SEARCH_SIZE 1000
11686 /* Look for an entry in the hash whose value has the same SV as val;
11687 * If so, return a mortal copy of the key. */
11690 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11693 register HE **array;
11696 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11697 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11700 array = HvARRAY(hv);
11702 for (i=HvMAX(hv); i>0; i--) {
11703 register HE *entry;
11704 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11705 if (HeVAL(entry) != val)
11707 if ( HeVAL(entry) == &PL_sv_undef ||
11708 HeVAL(entry) == &PL_sv_placeholder)
11712 if (HeKLEN(entry) == HEf_SVKEY)
11713 return sv_mortalcopy(HeKEY_sv(entry));
11714 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11720 /* Look for an entry in the array whose value has the same SV as val;
11721 * If so, return the index, otherwise return -1. */
11724 S_find_array_subscript(pTHX_ AV *av, SV* val)
11729 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11730 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11734 for (i=AvFILLp(av); i>=0; i--) {
11735 if (svp[i] == val && svp[i] != &PL_sv_undef)
11741 /* S_varname(): return the name of a variable, optionally with a subscript.
11742 * If gv is non-zero, use the name of that global, along with gvtype (one
11743 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11744 * targ. Depending on the value of the subscript_type flag, return:
11747 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11748 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11749 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11750 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11753 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11754 SV* keyname, I32 aindex, int subscript_type)
11757 SV * const name = sv_newmortal();
11760 buffer[0] = gvtype;
11763 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11765 gv_fullname4(name, gv, buffer, 0);
11767 if ((unsigned int)SvPVX(name)[1] <= 26) {
11769 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11771 /* Swap the 1 unprintable control character for the 2 byte pretty
11772 version - ie substr($name, 1, 1) = $buffer; */
11773 sv_insert(name, 1, 1, buffer, 2);
11778 CV * const cv = find_runcv(&unused);
11782 if (!cv || !CvPADLIST(cv))
11784 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11785 sv = *av_fetch(av, targ, FALSE);
11786 /* SvLEN in a pad name is not to be trusted */
11787 sv_setpv(name, SvPV_nolen_const(sv));
11790 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11791 SV * const sv = newSV(0);
11792 *SvPVX(name) = '$';
11793 Perl_sv_catpvf(aTHX_ name, "{%s}",
11794 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11797 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11798 *SvPVX(name) = '$';
11799 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11801 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11802 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11809 =for apidoc find_uninit_var
11811 Find the name of the undefined variable (if any) that caused the operator o
11812 to issue a "Use of uninitialized value" warning.
11813 If match is true, only return a name if it's value matches uninit_sv.
11814 So roughly speaking, if a unary operator (such as OP_COS) generates a
11815 warning, then following the direct child of the op may yield an
11816 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11817 other hand, with OP_ADD there are two branches to follow, so we only print
11818 the variable name if we get an exact match.
11820 The name is returned as a mortal SV.
11822 Assumes that PL_op is the op that originally triggered the error, and that
11823 PL_comppad/PL_curpad points to the currently executing pad.
11829 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11837 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11838 uninit_sv == &PL_sv_placeholder)))
11841 switch (obase->op_type) {
11848 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11849 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11852 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11854 if (pad) { /* @lex, %lex */
11855 sv = PAD_SVl(obase->op_targ);
11859 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11860 /* @global, %global */
11861 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11864 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11866 else /* @{expr}, %{expr} */
11867 return find_uninit_var(cUNOPx(obase)->op_first,
11871 /* attempt to find a match within the aggregate */
11873 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11875 subscript_type = FUV_SUBSCRIPT_HASH;
11878 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
11880 subscript_type = FUV_SUBSCRIPT_ARRAY;
11883 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11886 return varname(gv, hash ? '%' : '@', obase->op_targ,
11887 keysv, index, subscript_type);
11891 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11893 return varname(NULL, '$', obase->op_targ,
11894 NULL, 0, FUV_SUBSCRIPT_NONE);
11897 gv = cGVOPx_gv(obase);
11898 if (!gv || (match && GvSV(gv) != uninit_sv))
11900 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11903 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11906 av = (AV*)PAD_SV(obase->op_targ);
11907 if (!av || SvRMAGICAL(av))
11909 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11910 if (!svp || *svp != uninit_sv)
11913 return varname(NULL, '$', obase->op_targ,
11914 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11917 gv = cGVOPx_gv(obase);
11923 if (!av || SvRMAGICAL(av))
11925 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11926 if (!svp || *svp != uninit_sv)
11929 return varname(gv, '$', 0,
11930 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11935 o = cUNOPx(obase)->op_first;
11936 if (!o || o->op_type != OP_NULL ||
11937 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11939 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11943 if (PL_op == obase)
11944 /* $a[uninit_expr] or $h{uninit_expr} */
11945 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11948 o = cBINOPx(obase)->op_first;
11949 kid = cBINOPx(obase)->op_last;
11951 /* get the av or hv, and optionally the gv */
11953 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11954 sv = PAD_SV(o->op_targ);
11956 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11957 && cUNOPo->op_first->op_type == OP_GV)
11959 gv = cGVOPx_gv(cUNOPo->op_first);
11962 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11967 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11968 /* index is constant */
11972 if (obase->op_type == OP_HELEM) {
11973 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11974 if (!he || HeVAL(he) != uninit_sv)
11978 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11979 if (!svp || *svp != uninit_sv)
11983 if (obase->op_type == OP_HELEM)
11984 return varname(gv, '%', o->op_targ,
11985 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11987 return varname(gv, '@', o->op_targ, NULL,
11988 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11991 /* index is an expression;
11992 * attempt to find a match within the aggregate */
11993 if (obase->op_type == OP_HELEM) {
11994 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11996 return varname(gv, '%', o->op_targ,
11997 keysv, 0, FUV_SUBSCRIPT_HASH);
12000 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12002 return varname(gv, '@', o->op_targ,
12003 NULL, index, FUV_SUBSCRIPT_ARRAY);
12008 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12010 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12015 /* only examine RHS */
12016 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12019 o = cUNOPx(obase)->op_first;
12020 if (o->op_type == OP_PUSHMARK)
12023 if (!o->op_sibling) {
12024 /* one-arg version of open is highly magical */
12026 if (o->op_type == OP_GV) { /* open FOO; */
12028 if (match && GvSV(gv) != uninit_sv)
12030 return varname(gv, '$', 0,
12031 NULL, 0, FUV_SUBSCRIPT_NONE);
12033 /* other possibilities not handled are:
12034 * open $x; or open my $x; should return '${*$x}'
12035 * open expr; should return '$'.expr ideally
12041 /* ops where $_ may be an implicit arg */
12045 if ( !(obase->op_flags & OPf_STACKED)) {
12046 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12047 ? PAD_SVl(obase->op_targ)
12050 sv = sv_newmortal();
12051 sv_setpvn(sv, "$_", 2);
12059 /* skip filehandle as it can't produce 'undef' warning */
12060 o = cUNOPx(obase)->op_first;
12061 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12062 o = o->op_sibling->op_sibling;
12069 match = 1; /* XS or custom code could trigger random warnings */
12074 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12075 return sv_2mortal(newSVpvs("${$/}"));
12080 if (!(obase->op_flags & OPf_KIDS))
12082 o = cUNOPx(obase)->op_first;
12088 /* if all except one arg are constant, or have no side-effects,
12089 * or are optimized away, then it's unambiguous */
12091 for (kid=o; kid; kid = kid->op_sibling) {
12094 ( (kid->op_type == OP_CONST && (sv = cSVOPx_sv(kid))
12096 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12097 || (kid->op_type == OP_PUSHMARK)
12101 if (o2) { /* more than one found */
12108 return find_uninit_var(o2, uninit_sv, match);
12110 /* scan all args */
12112 sv = find_uninit_var(o, uninit_sv, 1);
12124 =for apidoc report_uninit
12126 Print appropriate "Use of uninitialized variable" warning
12132 Perl_report_uninit(pTHX_ SV* uninit_sv)
12136 SV* varname = NULL;
12138 varname = find_uninit_var(PL_op, uninit_sv,0);
12140 sv_insert(varname, 0, 0, " ", 1);
12142 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12143 varname ? SvPV_nolen_const(varname) : "",
12144 " in ", OP_DESC(PL_op));
12147 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12153 * c-indentation-style: bsd
12154 * c-basic-offset: 4
12155 * indent-tabs-mode: t
12158 * ex: set ts=8 sts=4 sw=4 noet: